@esri/hub-common 20.0.1 → 20.1.0

package/dist/esm/search/index.js

@@ -8,4 +8,5 @@ export * from "./utils";
 export * from "./wellKnownCatalog";
 export * from "./searchAssociatedContent";
 export * from "./combineQueries";
+export * from "./serializeCatalogScopeQuery";
 //# sourceMappingURL=index.js.map

package/dist/esm/search/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/search/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,SAAS,CAAC;AACxB,cAAc,wBAAwB,CAAC;AACvC,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/search/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,SAAS,CAAC;AACxB,cAAc,wBAAwB,CAAC;AACvC,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kBAAkB,CAAC;AACjC,cAAc,8BAA8B,CAAC"}

package/dist/esm/search/serializeCatalogScopeQuery.js

@@ -0,0 +1,25 @@
+import { upgradeCatalogSchema } from "./upgradeCatalogSchema";
+import { expandPortalQuery } from "./utils";
+import { serializeQueryForPortal } from "./serializeQueryForPortal";
+/**
+ * Serialize the catalog scope into search options.
+ * This is explicitly exported for other ArcGIS platform
+ * applications that need to work with Hub Catalogs.
+ * @param catalog The catalog to serialize
+ * @param scope The scope to serialize
+ * @returns The serialized search options
+ */
+export function serializeCatalogScope(catalog, scope) {
+    // apply any catalog schema migrations
+    const upgraded = upgradeCatalogSchema(catalog);
+    // get the scope
+    const scopeQuery = upgraded.scopes[scope];
+    if (!scopeQuery) {
+        throw new Error(`No query found for scope: ${scope}`);
+    }
+    // apply any expansions
+    const updatedQuery = expandPortalQuery(scopeQuery);
+    // Serialize into a structure compatible with the portal search
+    return serializeQueryForPortal(updatedQuery);
+}
+//# sourceMappingURL=serializeCatalogScopeQuery.js.map

package/dist/esm/search/serializeCatalogScopeQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializeCatalogScopeQuery.js","sourceRoot":"","sources":["../../../src/search/serializeCatalogScopeQuery.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CACnC,OAAoB,EACpB,KAAiB;IAEjB,sCAAsC;IACtC,MAAM,QAAQ,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAC/C,gBAAgB;IAChB,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1C,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,6BAA6B,KAAK,EAAE,CAAC,CAAC;KACvD;IACD,uBAAuB;IACvB,MAAM,YAAY,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACnD,+DAA+D;IAC/D,OAAO,uBAAuB,CAAC,YAAY,CAAC,CAAC;AAC/C,CAAC"}

package/dist/node/search/index.js

@@ -11,4 +11,5 @@ tslib_1.__exportStar(require("./utils"), exports);
 tslib_1.__exportStar(require("./wellKnownCatalog"), exports);
 tslib_1.__exportStar(require("./searchAssociatedContent"), exports);
 tslib_1.__exportStar(require("./combineQueries"), exports);
+tslib_1.__exportStar(require("./serializeCatalogScopeQuery"), exports);
 //# sourceMappingURL=index.js.map

package/dist/node/search/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/search/index.ts"],"names":[],"mappings":";;;AAAA,oDAA0B;AAC1B,uDAA6B;AAC7B,sDAA4B;AAC5B,oEAA0C;AAC1C,kDAAwB;AACxB,iEAAuC;AACvC,kDAAwB;AACxB,6DAAmC;AACnC,oEAA0C;AAC1C,2DAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/search/index.ts"],"names":[],"mappings":";;;AAAA,oDAA0B;AAC1B,uDAA6B;AAC7B,sDAA4B;AAC5B,oEAA0C;AAC1C,kDAAwB;AACxB,iEAAuC;AACvC,kDAAwB;AACxB,6DAAmC;AACnC,oEAA0C;AAC1C,2DAAiC;AACjC,uEAA6C"}

package/dist/node/search/serializeCatalogScopeQuery.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeCatalogScope = void 0;
+const upgradeCatalogSchema_1 = require("./upgradeCatalogSchema");
+const utils_1 = require("./utils");
+const serializeQueryForPortal_1 = require("./serializeQueryForPortal");
+/**
+ * Serialize the catalog scope into search options.
+ * This is explicitly exported for other ArcGIS platform
+ * applications that need to work with Hub Catalogs.
+ * @param catalog The catalog to serialize
+ * @param scope The scope to serialize
+ * @returns The serialized search options
+ */
+function serializeCatalogScope(catalog, scope) {
+    // apply any catalog schema migrations
+    const upgraded = upgradeCatalogSchema_1.upgradeCatalogSchema(catalog);
+    // get the scope
+    const scopeQuery = upgraded.scopes[scope];
+    if (!scopeQuery) {
+        throw new Error(`No query found for scope: ${scope}`);
+    }
+    // apply any expansions
+    const updatedQuery = utils_1.expandPortalQuery(scopeQuery);
+    // Serialize into a structure compatible with the portal search
+    return serializeQueryForPortal_1.serializeQueryForPortal(updatedQuery);
+}
+exports.serializeCatalogScope = serializeCatalogScope;
+//# sourceMappingURL=serializeCatalogScopeQuery.js.map

package/dist/node/search/serializeCatalogScopeQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializeCatalogScopeQuery.js","sourceRoot":"","sources":["../../../src/search/serializeCatalogScopeQuery.ts"],"names":[],"mappings":";;;AAEA,iEAA8D;AAC9D,mCAA4C;AAC5C,uEAAoE;AAEpE;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACnC,OAAoB,EACpB,KAAiB;IAEjB,sCAAsC;IACtC,MAAM,QAAQ,GAAG,2CAAoB,CAAC,OAAO,CAAC,CAAC;IAC/C,gBAAgB;IAChB,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1C,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,6BAA6B,KAAK,EAAE,CAAC,CAAC;KACvD;IACD,uBAAuB;IACvB,MAAM,YAAY,GAAG,yBAAiB,CAAC,UAAU,CAAC,CAAC;IACnD,+DAA+D;IAC/D,OAAO,iDAAuB,CAAC,YAAY,CAAC,CAAC;AAC/C,CAAC;AAfD,sDAeC"}

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

@@ -8,3 +8,4 @@ export * from "./utils";
 export * from "./wellKnownCatalog";
 export * from "./searchAssociatedContent";
 export * from "./combineQueries";
+export * from "./serializeCatalogScopeQuery";

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

@@ -0,0 +1,11 @@
+import { ISearchOptions } from "@esri/arcgis-rest-portal";
+import { EntityType, IHubCatalog } from "./types/IHubCatalog";
+/**
+ * Serialize the catalog scope into search options.
+ * This is explicitly exported for other ArcGIS platform
+ * applications that need to work with Hub Catalogs.
+ * @param catalog The catalog to serialize
+ * @param scope The scope to serialize
+ * @returns The serialized search options
+ */
+export declare function serializeCatalogScope(catalog: IHubCatalog, scope: EntityType): ISearchOptions;

package/package.json

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