Merge branch 'master' into b/12610-respect-hidden-site-collections

Author: abp6318

packages/common/CHANGELOG.md

@@ -1,3 +1,10 @@
+## @esri/hub-common [15.41.1](https://github.com/Esri/hub.js/compare/@esri/[email protected]...@esri/[email protected]) (2025-03-10)
+
+
+### Bug Fixes
+
+* add displayConfig to CollectionSchema ([#1823](https://github.com/Esri/hub.js/issues/1823)) ([a42f3bd](https://github.com/Esri/hub.js/commit/a42f3bd5f5fda5de4591493bb1bc3839e0bac59c))
+
 # @esri/hub-common [15.41.0](https://github.com/Esri/hub.js/compare/@esri/[email protected]...@esri/[email protected]) (2025-03-06)
 
 

packages/common/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "15.41.0",
+  "version": "15.41.1",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",

packages/common/package.json

@@ -2,6 +2,93 @@ import { EntityType, targetEntities } from "../../../search/types/IHubCatalog";
 import { IConfigurationSchema } from "../types";
 import { CARD_TITLE_TAGS, CORNERS, DROP_SHADOWS } from "./enums";
 
+/**
+ * JSON schema for the appearance of a gallery display
+ * This can be for a catalog, a collection, a gallery card, etc
+ */
+export const GalleryDisplayConfigSchema: IConfigurationSchema = {
+  type: "object",
+  properties: {
+    hidden: { type: "boolean", default: false },
+    layout: {
+      type: "string",
+      enum: [
+        "list",
+        "grid",
+        "grid-filled",
+        "table",
+        "map",
+        "compact",
+        "calendar",
+      ],
+      default: "list",
+    },
+    cardTitleTag: {
+      type: "string",
+      enum: Object.keys(CARD_TITLE_TAGS),
+      default: CARD_TITLE_TAGS.h3,
+    },
+    showThumbnail: {
+      type: "string",
+      enum: ["show", "hide", "grid"],
+      default: "show",
+    },
+    corners: {
+      type: "string",
+      enum: Object.keys(CORNERS),
+      default: CORNERS.square,
+    },
+    shadow: {
+      type: "string",
+      enum: Object.keys(DROP_SHADOWS),
+      default: DROP_SHADOWS.none,
+    },
+    showLinkButton: { type: "boolean", default: false },
+    linkButtonStyle: {
+      type: "string",
+      enum: ["outline", "outline-filled"],
+      default: "outline-filled",
+    },
+    linkButtonText: { type: "string", default: "Explore" },
+    sort: {
+      type: "string",
+      enum: ["relevance", "title", "created", "modified"],
+      default: "relevance",
+    },
+    filters: {
+      type: "array",
+      items: {
+        type: "object",
+        properties: {
+          key: {
+            type: "string",
+            enum: [
+              "location",
+              "type",
+              "source",
+              "event-occurrence",
+              "event-from",
+              "event-attendance",
+              "tags",
+              "categories",
+              "license",
+              "modified",
+              "access",
+              "group-role",
+              "group-type",
+              "group-access",
+              "event-access",
+              "event-date",
+            ],
+          },
+          hidden: { type: "boolean" },
+          label: { type: "string" },
+        },
+      },
+    },
+  },
+};
+
 /** JSON schema for an IPredicate */
 export const PredicateSchema: IConfigurationSchema = {
   type: "object",
@@ -53,49 +140,7 @@ export const CollectionSchema: IConfigurationSchema = {
       type: "string",
     },
     scope: QuerySchema,
-  },
-};
-
-/**
- * JSON schema for the appearance of a gallery display
- * This can be for a catalog, a collection, a gallery card, etc
- */
-export const GalleryDisplayConfigSchema: IConfigurationSchema = {
-  type: "object",
-  properties: {
-    hidden: { type: "boolean", default: false },
-    layout: {
-      type: "string",
-      enum: ["list", "grid", "table", "map", "compact"],
-      default: "list",
-    },
-    cardTitleTag: {
-      type: "string",
-      enum: Object.keys(CARD_TITLE_TAGS),
-      default: CARD_TITLE_TAGS.h3,
-    },
-    showThumbnail: {
-      type: "string",
-      enum: ["show", "hide", "grid"],
-      default: "show",
-    },
-    corners: {
-      type: "string",
-      enum: Object.keys(CORNERS),
-      default: CORNERS.square,
-    },
-    shadow: {
-      type: "string",
-      enum: Object.keys(DROP_SHADOWS),
-      default: DROP_SHADOWS.none,
-    },
-    showLinkButton: { type: "boolean", default: false },
-    linkButtonStyle: {
-      type: "string",
-      enum: ["outline", "outline-filled"],
-      default: "outline-filled",
-    },
-    linkButtonText: { type: "string", default: "Explore" },
+    displayConfig: GalleryDisplayConfigSchema,
   },
 };
 
@@ -120,16 +165,15 @@ export const CatalogSchema: IConfigurationSchema = {
       type: "array",
       items: CollectionSchema,
     },
-    displayConfig: GalleryDisplayConfigSchema,
-  },
-};
-
-/**
- * JSON schema for the appearance of an IHubCollection
- */
-export const CollectionAppearanceSchema: IConfigurationSchema = {
-  type: "object",
-  properties: {
-    displayConfig: GalleryDisplayConfigSchema,
+    displayConfig: {
+      type: "object",
+      properties: targetEntities.reduce(
+        (acc: Record<EntityType, any>, targetEntity: EntityType) => {
+          acc[targetEntity] = GalleryDisplayConfigSchema;
+          return acc;
+        },
+        {} as Record<EntityType, any>
+      ),
+    },
   },
 };

packages/common/src/core/schemas/shared/CatalogSchema.ts

@@ -22,7 +22,7 @@ import {
   IQuery,
   IFilter,
   IHubCollection,
-  IGalleryDisplayConfig,
+  ICatalogDisplayConfig,
 } from "./types";
 import { upgradeCatalogSchema } from "./upgradeCatalogSchema";
 
@@ -132,7 +132,7 @@ export class Catalog implements IHubCatalog {
   /**
    * Return the display configuration for the gallery
    */
-  get displayConfig(): IGalleryDisplayConfig {
+  get displayConfig(): ICatalogDisplayConfig {
     return this._catalog.displayConfig;
   }
 

packages/common/src/search/Catalog.ts

@@ -44,11 +44,13 @@ export interface IHubCatalog {
   /**
    * Optional display configuration to control a catalog's appearance in the UI
    */
-  displayConfig?: IGalleryDisplayConfig;
+  displayConfig?: ICatalogDisplayConfig;
 }
 
 export interface ICatalogScope extends Partial<Record<EntityType, IQuery>> {}
 
+export interface ICatalogDisplayConfig
+  extends Partial<Record<EntityType, IGalleryDisplayConfig>> {}
 export interface IHubCollection {
   /**
    * String to show in the UI. translated.

packages/common/src/search/types/IHubCatalog.ts

@@ -97,14 +97,16 @@ const catalogJson: IHubCatalog = {
     },
   ],
   displayConfig: {
-    hidden: false,
-    showThumbnail: "show",
-    showLinkButton: true,
-    linkButtonStyle: "outline",
-    linkButtonText: "Explore",
-    corners: CORNERS.square,
-    shadow: DROP_SHADOWS.none,
-    layout: "list",
+    item: {
+      hidden: false,
+      showThumbnail: "show",
+      showLinkButton: true,
+      linkButtonStyle: "outline",
+      linkButtonText: "Explore",
+      corners: CORNERS.square,
+      shadow: DROP_SHADOWS.none,
+      layout: "list",
+    },
   },
 };
 
@@ -168,9 +170,7 @@ describe("Catalog Class:", () => {
       instance.title = "Changed Title";
       expect(instance.title).toBe("Changed Title");
       expect(instance.availableScopes).toEqual(["item", "group", "user"]);
-      expect(instance.displayConfig).toEqual(
-        catalogJson.displayConfig as IGalleryDisplayConfig
-      );
+      expect(instance.displayConfig).toEqual(catalogJson.displayConfig);
     });
     it("allows null scopes", () => {
       const instance = Catalog.fromJson(cloneObject(noScopeCatalog), context);