@esri/hub-common 15.2.0 → 15.3.0

package/dist/esm/core/schemas/shared/CatalogSchema.js

@@ -64,4 +64,36 @@ export const CatalogSchema = {
         },
     },
 };
+/**
+ * JSON schema for the appearance of a gallery display
+ * This can be for a catalog, a collection, a gallery card, etc
+ */
+export const GalleryDisplayConfigSchema = {
+    type: "object",
+    properties: {
+        hidden: { type: "boolean", default: false },
+    },
+};
+/**
+ * JSON schema for the appearance of an IHubCollection
+ */
+export const CollectionAppearanceSchema = {
+    type: "object",
+    properties: {
+        displayConfig: GalleryDisplayConfigSchema,
+    },
+};
+/**
+ * JSON schema for the appearance of a catalog
+ */
+export const CatalogAppearanceSchema = {
+    type: "object",
+    properties: {
+        displayConfig: GalleryDisplayConfigSchema,
+        collections: {
+            type: "array",
+            items: CollectionAppearanceSchema,
+        },
+    },
+};
 //# sourceMappingURL=CatalogSchema.js.map

package/dist/esm/core/schemas/shared/CatalogSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"CatalogSchema.js","sourceRoot":"","sources":["../../../../../src/core/schemas/shared/CatalogSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,cAAc,EAAE,MAAM,mCAAmC,CAAC;AAG/E,oCAAoC;AACpC,MAAM,CAAC,MAAM,eAAe,GAAyB;IACnD,IAAI,EAAE,QAAQ;CACf,CAAC;AAEF,iCAAiC;AACjC,MAAM,CAAC,MAAM,YAAY,GAAyB;IAChD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC;SACpB;QACD,UAAU,EAAE;YACV,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC;YACX,KAAK,EAAE,eAAe;SACvB;KACF;CACF,CAAC;AAEF,gCAAgC;AAChC,MAAM,CAAC,MAAM,WAAW,GAAyB;IAC/C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,cAAc,CAAC;IAC1B,UAAU,EAAE;QACV,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,GAAG,cAAc,CAAC;SAC1B;QACD,OAAO,EAAE;YACP,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,YAAY;SACpB;KACF;CACF,CAAC;AAEF,wCAAwC;AACxC,MAAM,CAAC,MAAM,gBAAgB,GAAyB;IACpD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,OAAO,CAAC;IACnB,UAAU,EAAE;QACV,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;SACf;QACD,KAAK,EAAE,WAAW;KACnB;CACF,CAAC;AAEF,qCAAqC;AACrC,MAAM,CAAC,MAAM,aAAa,GAAyB;IACjD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;SACf;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,cAAc,CAAC,MAAM,CAC/B,CAAC,GAA4B,EAAE,YAAwB,EAAE,EAAE;gBACzD,GAAG,CAAC,YAAY,CAAC,GAAG,WAAW,CAAC;gBAChC,OAAO,GAAG,CAAC;YACb,CAAC,EACD,EAA6B,CAC9B;SACF;QACD,WAAW,EAAE;YACX,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,gBAAgB;SACxB;KACF;CACF,CAAC"}
+{"version":3,"file":"CatalogSchema.js","sourceRoot":"","sources":["../../../../../src/core/schemas/shared/CatalogSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,cAAc,EAAE,MAAM,mCAAmC,CAAC;AAG/E,oCAAoC;AACpC,MAAM,CAAC,MAAM,eAAe,GAAyB;IACnD,IAAI,EAAE,QAAQ;CACf,CAAC;AAEF,iCAAiC;AACjC,MAAM,CAAC,MAAM,YAAY,GAAyB;IAChD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC;SACpB;QACD,UAAU,EAAE;YACV,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC;YACX,KAAK,EAAE,eAAe;SACvB;KACF;CACF,CAAC;AAEF,gCAAgC;AAChC,MAAM,CAAC,MAAM,WAAW,GAAyB;IAC/C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,cAAc,CAAC;IAC1B,UAAU,EAAE;QACV,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,GAAG,cAAc,CAAC;SAC1B;QACD,OAAO,EAAE;YACP,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,YAAY;SACpB;KACF;CACF,CAAC;AAEF,wCAAwC;AACxC,MAAM,CAAC,MAAM,gBAAgB,GAAyB;IACpD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,OAAO,CAAC;IACnB,UAAU,EAAE;QACV,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;SACf;QACD,KAAK,EAAE,WAAW;KACnB;CACF,CAAC;AAEF,qCAAqC;AACrC,MAAM,CAAC,MAAM,aAAa,GAAyB;IACjD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;SACf;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,cAAc,CAAC,MAAM,CAC/B,CAAC,GAA4B,EAAE,YAAwB,EAAE,EAAE;gBACzD,GAAG,CAAC,YAAY,CAAC,GAAG,WAAW,CAAC;gBAChC,OAAO,GAAG,CAAC;YACb,CAAC,EACD,EAA6B,CAC9B;SACF;QACD,WAAW,EAAE;YACX,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,gBAAgB;SACxB;KACF;CACF,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAyB;IAC9D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;KAE5C;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAyB;IAC9D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,aAAa,EAAE,0BAA0B;KAC1C;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAyB;IAC3D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,aAAa,EAAE,0BAA0B;QACzC,WAAW,EAAE;YACX,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,0BAA0B;SAClC;KACF;CACF,CAAC"}

package/dist/esm/search/types/IHubCatalog.js.map

@@ -1 +1 @@
-{"version":3,"file":"IHubCatalog.js","sourceRoot":"","sources":["../../../../src/search/types/IHubCatalog.ts"],"names":[],"mappings":"AAyEA,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,MAAM;IACN,OAAO;IACP,MAAM;IACN,YAAY;IACZ,eAAe;IACf,aAAa;IACb,OAAO;IACP,SAAS;IACT,gBAAgB;IAChB,eAAe;CACP,CAAC"}
+{"version":3,"file":"IHubCatalog.js","sourceRoot":"","sources":["../../../../src/search/types/IHubCatalog.ts"],"names":[],"mappings":"AA8EA,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,MAAM;IACN,OAAO;IACP,MAAM;IACN,YAAY;IACZ,eAAe;IACf,aAAa;IACb,OAAO;IACP,SAAS;IACT,gBAAgB;IAChB,eAAe;CACP,CAAC"}

package/dist/node/core/schemas/shared/CatalogSchema.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CatalogSchema = exports.CollectionSchema = exports.QuerySchema = exports.FilterSchema = exports.PredicateSchema = void 0;
+exports.CatalogAppearanceSchema = exports.CollectionAppearanceSchema = exports.GalleryDisplayConfigSchema = exports.CatalogSchema = exports.CollectionSchema = exports.QuerySchema = exports.FilterSchema = exports.PredicateSchema = void 0;
 const IHubCatalog_1 = require("../../../search/types/IHubCatalog");
 /** JSON schema for an IPredicate */
 exports.PredicateSchema = {
@@ -67,4 +67,36 @@ exports.CatalogSchema = {
         },
     },
 };
+/**
+ * JSON schema for the appearance of a gallery display
+ * This can be for a catalog, a collection, a gallery card, etc
+ */
+exports.GalleryDisplayConfigSchema = {
+    type: "object",
+    properties: {
+        hidden: { type: "boolean", default: false },
+    },
+};
+/**
+ * JSON schema for the appearance of an IHubCollection
+ */
+exports.CollectionAppearanceSchema = {
+    type: "object",
+    properties: {
+        displayConfig: exports.GalleryDisplayConfigSchema,
+    },
+};
+/**
+ * JSON schema for the appearance of a catalog
+ */
+exports.CatalogAppearanceSchema = {
+    type: "object",
+    properties: {
+        displayConfig: exports.GalleryDisplayConfigSchema,
+        collections: {
+            type: "array",
+            items: exports.CollectionAppearanceSchema,
+        },
+    },
+};
 //# sourceMappingURL=CatalogSchema.js.map

package/dist/node/core/schemas/shared/CatalogSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"CatalogSchema.js","sourceRoot":"","sources":["../../../../../src/core/schemas/shared/CatalogSchema.ts"],"names":[],"mappings":";;;AAAA,mEAA+E;AAG/E,oCAAoC;AACvB,QAAA,eAAe,GAAyB;IACnD,IAAI,EAAE,QAAQ;CACf,CAAC;AAEF,iCAAiC;AACpB,QAAA,YAAY,GAAyB;IAChD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC;SACpB;QACD,UAAU,EAAE;YACV,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC;YACX,KAAK,EAAE,uBAAe;SACvB;KACF;CACF,CAAC;AAEF,gCAAgC;AACnB,QAAA,WAAW,GAAyB;IAC/C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,cAAc,CAAC;IAC1B,UAAU,EAAE;QACV,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,GAAG,4BAAc,CAAC;SAC1B;QACD,OAAO,EAAE;YACP,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,oBAAY;SACpB;KACF;CACF,CAAC;AAEF,wCAAwC;AAC3B,QAAA,gBAAgB,GAAyB;IACpD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,OAAO,CAAC;IACnB,UAAU,EAAE;QACV,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;SACf;QACD,KAAK,EAAE,mBAAW;KACnB;CACF,CAAC;AAEF,qCAAqC;AACxB,QAAA,aAAa,GAAyB;IACjD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;SACf;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,4BAAc,CAAC,MAAM,CAC/B,CAAC,GAA4B,EAAE,YAAwB,EAAE,EAAE;gBACzD,GAAG,CAAC,YAAY,CAAC,GAAG,mBAAW,CAAC;gBAChC,OAAO,GAAG,CAAC;YACb,CAAC,EACD,EAA6B,CAC9B;SACF;QACD,WAAW,EAAE;YACX,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,wBAAgB;SACxB;KACF;CACF,CAAC"}
+{"version":3,"file":"CatalogSchema.js","sourceRoot":"","sources":["../../../../../src/core/schemas/shared/CatalogSchema.ts"],"names":[],"mappings":";;;AAAA,mEAA+E;AAG/E,oCAAoC;AACvB,QAAA,eAAe,GAAyB;IACnD,IAAI,EAAE,QAAQ;CACf,CAAC;AAEF,iCAAiC;AACpB,QAAA,YAAY,GAAyB;IAChD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC;SACpB;QACD,UAAU,EAAE;YACV,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC;YACX,KAAK,EAAE,uBAAe;SACvB;KACF;CACF,CAAC;AAEF,gCAAgC;AACnB,QAAA,WAAW,GAAyB;IAC/C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,cAAc,CAAC;IAC1B,UAAU,EAAE;QACV,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,GAAG,4BAAc,CAAC;SAC1B;QACD,OAAO,EAAE;YACP,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,oBAAY;SACpB;KACF;CACF,CAAC;AAEF,wCAAwC;AAC3B,QAAA,gBAAgB,GAAyB;IACpD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,OAAO,CAAC;IACnB,UAAU,EAAE;QACV,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;SACf;QACD,KAAK,EAAE,mBAAW;KACnB;CACF,CAAC;AAEF,qCAAqC;AACxB,QAAA,aAAa,GAAyB;IACjD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;SACf;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,4BAAc,CAAC,MAAM,CAC/B,CAAC,GAA4B,EAAE,YAAwB,EAAE,EAAE;gBACzD,GAAG,CAAC,YAAY,CAAC,GAAG,mBAAW,CAAC;gBAChC,OAAO,GAAG,CAAC;YACb,CAAC,EACD,EAA6B,CAC9B;SACF;QACD,WAAW,EAAE;YACX,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,wBAAgB;SACxB;KACF;CACF,CAAC;AAEF;;;GAGG;AACU,QAAA,0BAA0B,GAAyB;IAC9D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;KAE5C;CACF,CAAC;AAEF;;GAEG;AACU,QAAA,0BAA0B,GAAyB;IAC9D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,aAAa,EAAE,kCAA0B;KAC1C;CACF,CAAC;AAEF;;GAEG;AACU,QAAA,uBAAuB,GAAyB;IAC3D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,aAAa,EAAE,kCAA0B;QACzC,WAAW,EAAE;YACX,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,kCAA0B;SAClC;KACF;CACF,CAAC"}

package/dist/node/search/types/IHubCatalog.js.map

@@ -1 +1 @@
-{"version":3,"file":"IHubCatalog.js","sourceRoot":"","sources":["../../../../src/search/types/IHubCatalog.ts"],"names":[],"mappings":";;;AAyEa,QAAA,cAAc,GAAG;IAC5B,MAAM;IACN,OAAO;IACP,MAAM;IACN,YAAY;IACZ,eAAe;IACf,aAAa;IACb,OAAO;IACP,SAAS;IACT,gBAAgB;IAChB,eAAe;CACP,CAAC"}
+{"version":3,"file":"IHubCatalog.js","sourceRoot":"","sources":["../../../../src/search/types/IHubCatalog.ts"],"names":[],"mappings":";;;AA8Ea,QAAA,cAAc,GAAG;IAC5B,MAAM;IACN,OAAO;IACP,MAAM;IACN,YAAY;IACZ,eAAe;IACf,aAAa;IACb,OAAO;IACP,SAAS;IACT,gBAAgB;IAChB,eAAe;CACP,CAAC"}

package/dist/types/core/schemas/shared/CatalogSchema.d.ts

@@ -9,3 +9,16 @@ export declare const QuerySchema: IConfigurationSchema;
 export declare const CollectionSchema: IConfigurationSchema;
 /** JSON schema for an IHubCatalog */
 export declare const CatalogSchema: IConfigurationSchema;
+/**
+ * JSON schema for the appearance of a gallery display
+ * This can be for a catalog, a collection, a gallery card, etc
+ */
+export declare const GalleryDisplayConfigSchema: IConfigurationSchema;
+/**
+ * JSON schema for the appearance of an IHubCollection
+ */
+export declare const CollectionAppearanceSchema: IConfigurationSchema;
+/**
+ * JSON schema for the appearance of a catalog
+ */
+export declare const CatalogAppearanceSchema: IConfigurationSchema;

package/dist/types/search/types/IHubCatalog.d.ts

@@ -65,6 +65,10 @@ export interface IHubCollection {
      * ensure we query the correct API
      */
     targetEntity: EntityType;
+    /**
+     * Optional display configuration to control a collection's appearance in the UI
+     */
+    displayConfig?: IGalleryDisplayConfig;
 }
 export declare const targetEntities: readonly ["item", "group", "user", "portalUser", "communityUser", "groupMember", "event", "channel", "discussionPost", "eventAttendee"];
 export declare type EntityType = (typeof targetEntities)[number];
@@ -149,3 +153,14 @@ export interface IPredicate {
      */
     [key: string]: any;
 }
+/**
+ * Configuration for how to display a gallery. This can apply to a catalog's display,
+ * a collection's display, the gallery-card's display, etc.
+ */
+export interface IGalleryDisplayConfig {
+    /**s
+     * Used for collections to determine if the collection should be hidden in the gallery.
+     * If this is true on a collection's display config, that collection will not be shown in the gallery.
+     */
+    hidden?: boolean;
+}

package/package.json

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