@esri/hub-common 9.48.0 → 10.0.0-next.2

package/dist/esm/search/Catalog.js

@@ -0,0 +1,404 @@
+import { __awaiter, __generator, __spreadArrays } from "tslib";
+import { ArcGISContextManager } from "../ArcGISContextManager";
+import HubError from "../HubError";
+import { cloneObject } from "../util";
+import { mapBy } from "../utils";
+import { Collection } from "./Collection";
+import { fetchCatalog } from "./fetchCatalog";
+import { hubSearch } from "./hubSearch";
+import { upgradeCatalogSchema } from "./upgradeCatalogSchema";
+/**
+ * Catalog Class
+ *
+ * Abstracts working with Catalogs and fetching collections with
+ * the correct scope applied.
+ *
+ * For more information, check out the [Catalog & Collection Guide](/hub.js/guides/concepts/catalog-collection/)
+ */
+var Catalog = /** @class */ (function () {
+    // internal - use static factory methods
+    function Catalog(catalog, context) {
+        this._catalog = catalog;
+        this._context = context;
+    }
+    /**
+     * Create a Collection instance from a Catalog json object, a site url or itemId
+     * '''js
+     * const catalog = await Catalog.create('https://site-org.hub.arcgis.com', context);
+     * '''
+     *
+     * @param identifier
+     * @param context
+     * @returns
+     */
+    Catalog.init = function (identifier, context) {
+        return __awaiter(this, void 0, void 0, function () {
+            var mgr, fetched;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!!context) return [3 /*break*/, 2];
+                        return [4 /*yield*/, ArcGISContextManager.create()];
+                    case 1:
+                        mgr = _a.sent();
+                        context = mgr.context;
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, fetchCatalog(identifier, context.hubRequestOptions)];
+                    case 3:
+                        fetched = _a.sent();
+                        // return an instance
+                        return [2 /*return*/, new Catalog(fetched, context)];
+                }
+            });
+        });
+    };
+    /**
+     * Create a Catalog instance from a Catalog Json object
+     * @param json
+     * @param context
+     * @returns
+     */
+    Catalog.fromJson = function (json, context) {
+        // ensure it's in the latest structure
+        var catalog = upgradeCatalogSchema(json);
+        return new Catalog(catalog, context);
+    };
+    /**
+     * Return the JSON object backing the instance
+     * @returns
+     */
+    Catalog.prototype.toJson = function () {
+        return cloneObject(this._catalog);
+    };
+    Object.defineProperty(Catalog.prototype, "schemaVersion", {
+        /**
+         * Return the schema version
+         */
+        get: function () {
+            return this._catalog.schemaVersion;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Catalog.prototype, "title", {
+        /**
+         * Title getter
+         */
+        get: function () {
+            return this._catalog.title;
+        },
+        /**
+         * Title setter
+         */
+        set: function (v) {
+            this._catalog.title = v;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Catalog.prototype, "scopes", {
+        /**
+         * Return the existing scopes hash
+         */
+        get: function () {
+            return this._catalog.scopes;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Catalog.prototype, "availableScopes", {
+        /**
+         * Return an array of the entity types available in this Catalog
+         */
+        get: function () {
+            return Object.keys(this.scopes);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Get the scope's query for a particular entity type
+     * @param type
+     * @returns
+     */
+    Catalog.prototype.getScope = function (type) {
+        return this._catalog.scopes[type];
+    };
+    /**
+     * Set the scope for a specific entity type
+     * @param type
+     * @param query
+     */
+    Catalog.prototype.setScope = function (type, query) {
+        this._catalog.scopes[type] = query;
+    };
+    Object.defineProperty(Catalog.prototype, "collections", {
+        /**
+         * Get the collections array. Returns simple objects not Collection instances
+         */
+        get: function () {
+            return this._catalog.collections || [];
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Catalog.prototype, "collectionNames", {
+        /**
+         * Get the names of the collections
+         */
+        get: function () {
+            return mapBy("key", this.collections);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Get a Collection instance by name
+     * @param name
+     * @returns
+     */
+    Catalog.prototype.getCollection = function (name) {
+        var json = this.collections.find(function (entry) { return entry.key === name; });
+        if (json) {
+            // clone it then merge in the associated scope filter
+            var clone = cloneObject(json);
+            var catalogScope = this.getScope(clone.scope.targetEntity);
+            if (catalogScope === null || catalogScope === void 0 ? void 0 : catalogScope.filters) {
+                clone.scope.filters = __spreadArrays(clone.scope.filters, catalogScope.filters);
+            }
+            return Collection.fromJson(clone, this._context);
+        }
+        else {
+            throw new HubError("getCollection", "Collection \"" + name + "\" is not present in the Catalog");
+        }
+    };
+    /**
+     * Search for Items
+     * Will throw if the Catalog does not have a scope defined for items
+     * @param query
+     * @param options
+     * @returns
+     */
+    Catalog.prototype.searchItems = function (query, options) {
+        if (options === void 0) { options = {}; }
+        if (!this.getScope("item")) {
+            var result = this.getEmptyResult();
+            result.messages = [
+                {
+                    code: "missingScope",
+                    message: "Catalog does not have a scope for items",
+                    data: {
+                        scope: "item",
+                    },
+                },
+            ];
+            return Promise.resolve(result);
+        }
+        else {
+            // ensure it's an item search
+            options.targetEntity = "item";
+            return this.search(query, options);
+        }
+    };
+    /**
+     * Search for Groups
+     * Will throw if the Catalog does not have a scope defined for groups
+     * @param query
+     * @param options
+     * @returns
+     */
+    Catalog.prototype.searchGroups = function (query, options) {
+        if (options === void 0) { options = {}; }
+        if (!this.getScope("group")) {
+            var result = this.getEmptyResult();
+            result.messages = [
+                {
+                    code: "missingScope",
+                    message: "Catalog does not have a scope for groups",
+                    data: {
+                        scope: "group",
+                    },
+                },
+            ];
+            return Promise.resolve(result);
+        }
+        else {
+            // ensure it's an group search
+            options.targetEntity = "group";
+            return this.search(query, options);
+        }
+    };
+    /**
+     * Search for Users
+     * Will throw if the Catalog does not have a scope defined for users
+     * @param query
+     * @param options
+     * @returns
+     */
+    Catalog.prototype.searchUsers = function (query, options) {
+        if (options === void 0) { options = {}; }
+        if (!this.getScope("user")) {
+            var result = this.getEmptyResult();
+            result.messages = [
+                {
+                    code: "missingScope",
+                    message: "Catalog does not have a scope for user",
+                    data: {
+                        scope: "user",
+                    },
+                },
+            ];
+            return Promise.resolve(result);
+        }
+        else {
+            // ensure it's an group search
+            options.targetEntity = "user";
+            return this.search(query, options);
+        }
+    };
+    /**
+     * Execute a search against all the collections in the Catalog
+     * @param query
+     * @param options
+     * @returns
+     */
+    Catalog.prototype.searchCollections = function (query, options) {
+        if (options === void 0) { options = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            var qry, promiseKeys, promises, responses, hash, i;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        qry = {
+                            targetEntity: "item",
+                            filters: [
+                                {
+                                    predicates: [
+                                        {
+                                            term: query,
+                                        },
+                                    ],
+                                },
+                            ],
+                        };
+                        promiseKeys = [];
+                        promises = this.collectionNames.map(function (name) {
+                            var col = _this.getCollection(name);
+                            promiseKeys.push(name);
+                            qry.targetEntity = col.targetEntity;
+                            return col.search(qry, options);
+                        });
+                        return [4 /*yield*/, Promise.all(promises)];
+                    case 1:
+                        responses = _a.sent();
+                        hash = {};
+                        for (i = 0; i < promiseKeys.length; i++) {
+                            hash[promiseKeys[i]] = responses[i];
+                        }
+                        return [2 /*return*/, hash];
+                }
+            });
+        });
+    };
+    /**
+     * Execute a search against all the scopes in the Catalog
+     * @param query
+     * @param options
+     * @returns
+     */
+    Catalog.prototype.searchScopes = function (query, options) {
+        if (options === void 0) { options = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            var qry, promiseKeys, promises, responses, hash, i;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        qry = {
+                            targetEntity: "item",
+                            filters: [
+                                {
+                                    predicates: [
+                                        {
+                                            term: query,
+                                        },
+                                    ],
+                                },
+                            ],
+                        };
+                        promiseKeys = [];
+                        promises = this.availableScopes.map(function (name) {
+                            promiseKeys.push(name);
+                            // make clones
+                            var qryClone = cloneObject(qry);
+                            var optsClone = cloneObject(options);
+                            // set the target entity
+                            qryClone.targetEntity = name;
+                            optsClone.targetEntity = name;
+                            // return the search promise
+                            return _this.search(qryClone, optsClone);
+                        });
+                        return [4 /*yield*/, Promise.all(promises)];
+                    case 1:
+                        responses = _a.sent();
+                        hash = {};
+                        for (i = 0; i < promiseKeys.length; i++) {
+                            hash[promiseKeys[i]] = responses[i];
+                        }
+                        return [2 /*return*/, hash];
+                }
+            });
+        });
+    };
+    /**
+     * Execute a search against the Catalog as a whole
+     * @param query
+     * @param targetEntity
+     * @returns
+     */
+    Catalog.prototype.search = function (query, options) {
+        var targetEntity = options.targetEntity;
+        var qry;
+        if (typeof query === "string") {
+            qry = {
+                targetEntity: targetEntity,
+                filters: [
+                    {
+                        predicates: [
+                            {
+                                term: query,
+                            },
+                        ],
+                    },
+                ],
+            };
+        }
+        else {
+            qry = cloneObject(query);
+        }
+        // Now merge in catalog scope level filters
+        qry.filters = __spreadArrays(qry.filters, this.getScope(targetEntity).filters);
+        var opts = cloneObject(options);
+        // An Catalog instance always uses the context so we remove/replace any passed in auth
+        delete opts.authentication;
+        opts.requestOptions = this._context.hubRequestOptions;
+        return hubSearch(qry, opts);
+    };
+    /**
+     * Construct an empty result. Returned when a search is performed against an entity type that
+     * does not have a scope defined.
+     * @returns
+     */
+    Catalog.prototype.getEmptyResult = function () {
+        return {
+            results: [],
+            total: 0,
+            hasNext: false,
+            next: null,
+        };
+    };
+    return Catalog;
+}());
+export { Catalog };
+//# sourceMappingURL=Catalog.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Catalog.js","sourceRoot":"","sources":["../../../src/search/Catalog.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,QAAQ,MAAM,aAAa,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAYxC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAS9D;;;;;;;GAOG;AACH;IAIE,wCAAwC;IACxC,iBAAoB,OAAoB,EAAE,OAAuB;QAC/D,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;;;;;;;;OASG;IACiB,YAAI,GAAxB,UACE,UAAkB,EAClB,OAAwB;;;;;;6BAGpB,CAAC,OAAO,EAAR,wBAAQ;wBACE,qBAAM,oBAAoB,CAAC,MAAM,EAAE,EAAA;;wBAAzC,GAAG,GAAG,SAAmC;wBAC/C,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;;4BAGR,qBAAM,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,EAAA;;wBAAnE,OAAO,GAAG,SAAyD;wBACzE,qBAAqB;wBACrB,sBAAO,IAAI,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,EAAC;;;;KACtC;IAED;;;;;OAKG;IACI,gBAAQ,GAAf,UAAgB,IAAS,EAAE,OAAwB;QACjD,sCAAsC;QACtC,IAAM,OAAO,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAC3C,OAAO,IAAI,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,wBAAM,GAAN;QACE,OAAO,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAKD,sBAAI,kCAAa;QAHjB;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;QACrC,CAAC;;;OAAA;IAKD,sBAAI,0BAAK;QAHT;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC7B,CAAC;QAED;;WAEG;aACH,UAAU,CAAS;YACjB,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,CAAC;QAC1B,CAAC;;;OAPA;IAYD,sBAAI,2BAAM;QAHV;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC9B,CAAC;;;OAAA;IAID,sBAAI,oCAAe;QAHnB;;WAEG;aACH;YACE,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAA4B,CAAC;QAC7D,CAAC;;;OAAA;IAED;;;;OAIG;IACH,0BAAQ,GAAR,UAAS,IAAgB;QACvB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,0BAAQ,GAAR,UAAS,IAAgB,EAAE,KAAa;QACtC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IACrC,CAAC;IAKD,sBAAI,gCAAW;QAHf;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,IAAI,EAAE,CAAC;QACzC,CAAC;;;OAAA;IAKD,sBAAI,oCAAe;QAHnB;;WAEG;aACH;YACE,OAAO,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACxC,CAAC;;;OAAA;IAED;;;;OAIG;IACH,+BAAa,GAAb,UAAc,IAAY;QACxB,IAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAC,KAAK,IAAK,OAAA,KAAK,CAAC,GAAG,KAAK,IAAI,EAAlB,CAAkB,CAAC,CAAC;QAClE,IAAI,IAAI,EAAE;YACR,qDAAqD;YACrD,IAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;YAChC,IAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAC7D,IAAI,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,OAAO,EAAE;gBACzB,KAAK,CAAC,KAAK,CAAC,OAAO,kBAAO,KAAK,CAAC,KAAK,CAAC,OAAO,EAAK,YAAY,CAAC,OAAO,CAAC,CAAC;aACzE;YACD,OAAO,UAAU,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;SAClD;aAAM;YACL,MAAM,IAAI,QAAQ,CAChB,eAAe,EACf,kBAAe,IAAI,qCAAiC,CACrD,CAAC;SACH;IACH,CAAC;IAED;;;;;;OAMG;IACH,6BAAW,GAAX,UACE,KAAsB,EACtB,OAA+B;QAA/B,wBAAA,EAAA,YAA+B;QAE/B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YAC1B,IAAM,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;YACrC,MAAM,CAAC,QAAQ,GAAG;gBAChB;oBACE,IAAI,EAAE,cAAc;oBACpB,OAAO,EAAE,yCAAyC;oBAClD,IAAI,EAAE;wBACJ,KAAK,EAAE,MAAM;qBACd;iBACF;aACF,CAAC;YACF,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;SAChC;aAAM;YACL,6BAA6B;YAC7B,OAAO,CAAC,YAAY,GAAG,MAAM,CAAC;YAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;SACpC;IACH,CAAC;IAED;;;;;;OAMG;IACH,8BAAY,GAAZ,UACE,KAAsB,EACtB,OAA+B;QAA/B,wBAAA,EAAA,YAA+B;QAE/B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC3B,IAAM,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;YACrC,MAAM,CAAC,QAAQ,GAAG;gBAChB;oBACE,IAAI,EAAE,cAAc;oBACpB,OAAO,EAAE,0CAA0C;oBACnD,IAAI,EAAE;wBACJ,KAAK,EAAE,OAAO;qBACf;iBACF;aACF,CAAC;YACF,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;SAChC;aAAM;YACL,8BAA8B;YAC9B,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC;YAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;SACpC;IACH,CAAC;IAED;;;;;;OAMG;IACH,6BAAW,GAAX,UACE,KAAsB,EACtB,OAA+B;QAA/B,wBAAA,EAAA,YAA+B;QAE/B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YAC1B,IAAM,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;YACrC,MAAM,CAAC,QAAQ,GAAG;gBAChB;oBACE,IAAI,EAAE,cAAc;oBACpB,OAAO,EAAE,wCAAwC;oBACjD,IAAI,EAAE;wBACJ,KAAK,EAAE,MAAM;qBACd;iBACF;aACF,CAAC;YACF,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;SAChC;aAAM;YACL,8BAA8B;YAC9B,OAAO,CAAC,YAAY,GAAG,MAAM,CAAC;YAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;SACpC;IACH,CAAC;IAED;;;;;OAKG;IACG,mCAAiB,GAAvB,UACE,KAAa,EACb,OAA+B;QAA/B,wBAAA,EAAA,YAA+B;;;;;;;wBAGzB,GAAG,GAAW;4BAClB,YAAY,EAAE,MAAM;4BACpB,OAAO,EAAE;gCACP;oCACE,UAAU,EAAE;wCACV;4CACE,IAAI,EAAE,KAAK;yCACZ;qCACF;iCACF;6BACF;yBACF,CAAC;wBAEI,WAAW,GAAa,EAAE,CAAC;wBAC3B,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAC,IAAI;4BAC7C,IAAM,GAAG,GAAG,KAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;4BACrC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;4BACvB,GAAG,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC;4BACpC,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;wBAClC,CAAC,CAAC,CAAC;wBAEe,qBAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAA;;wBAAvC,SAAS,GAAG,SAA2B;wBAGvC,IAAI,GAAwB,EAAE,CAAC;wBACrC,KAAS,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;4BAC3C,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;yBACrC;wBACD,sBAAO,IAAI,EAAC;;;;KACb;IAED;;;;;OAKG;IACG,8BAAY,GAAlB,UACE,KAAa,EACb,OAA+B;QAA/B,wBAAA,EAAA,YAA+B;;;;;;;wBAEzB,GAAG,GAAW;4BAClB,YAAY,EAAE,MAAM;4BACpB,OAAO,EAAE;gCACP;oCACE,UAAU,EAAE;wCACV;4CACE,IAAI,EAAE,KAAK;yCACZ;qCACF;iCACF;6BACF;yBACF,CAAC;wBAGI,WAAW,GAAa,EAAE,CAAC;wBAC3B,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAC,IAAI;4BAC7C,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;4BACvB,cAAc;4BACd,IAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;4BAClC,IAAM,SAAS,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;4BACvC,wBAAwB;4BACxB,QAAQ,CAAC,YAAY,GAAG,IAAI,CAAC;4BAC7B,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC;4BAC9B,4BAA4B;4BAC5B,OAAO,KAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;wBAC1C,CAAC,CAAC,CAAC;wBAGe,qBAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAA;;wBAAvC,SAAS,GAAG,SAA2B;wBAGvC,IAAI,GAAwB,EAAE,CAAC;wBACrC,KAAS,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;4BAC3C,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;yBACrC;wBACD,sBAAO,IAAI,EAAC;;;;KACb;IAED;;;;;OAKG;IACK,wBAAM,GAAd,UACE,KAAsB,EACtB,OAA0B;QAE1B,IAAM,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC1C,IAAI,GAAW,CAAC;QAChB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,GAAG,GAAG;gBACJ,YAAY,cAAA;gBACZ,OAAO,EAAE;oBACP;wBACE,UAAU,EAAE;4BACV;gCACE,IAAI,EAAE,KAAK;6BACZ;yBACF;qBACF;iBACF;aACQ,CAAC;SACb;aAAM;YACL,GAAG,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;SAC1B;QAED,2CAA2C;QAC3C,GAAG,CAAC,OAAO,kBAAO,GAAG,CAAC,OAAO,EAAK,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC;QAEvE,IAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;QAClC,sFAAsF;QACtF,OAAO,IAAI,CAAC,cAAc,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC;QAEtD,OAAO,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACK,gCAAc,GAAtB;QACE,OAAO;YACL,OAAO,EAAE,EAAE;YACX,KAAK,EAAE,CAAC;YACR,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,IAAI;SACX,CAAC;IACJ,CAAC;IACH,cAAC;AAAD,CAAC,AAzXD,IAyXC"}

package/dist/esm/search/Collection.js

@@ -1,24 +1,33 @@
 import { __awaiter, __generator, __spreadArrays } from "tslib";
-import { hubSearchQuery } from "..";
+import { cloneObject } from "..";
+import { hubSearch } from "./hubSearch";
 /**
- * Implements Collection behavior
+ * Collection Class
+ *
+ * Abstracts searching a Collection
+ *
+ * For more information, check out the [Catalog & Collection Guide](/hub.js/guides/concepts/catalog-collection/)
  */
-/* istanbul ignore next */
 var Collection = /** @class */ (function () {
     function Collection(collection, context) {
         this._collection = collection;
-        if (context) {
-            this._context = context;
-        }
+        this._context = context;
     }
-    Collection.create = function (collection, context) {
-        return __awaiter(this, void 0, void 0, function () {
-            var col;
-            return __generator(this, function (_a) {
-                col = new Collection(collection, context);
-                return [2 /*return*/, Promise.resolve(col)];
-            });
-        });
+    /**
+     * Create an instance of a Collection from a JSON object
+     * @param collection
+     * @param context
+     * @returns
+     */
+    Collection.fromJson = function (collection, context) {
+        return new Collection(collection, context);
+    };
+    /**
+     * Return the JSON object backing the instance
+     * @returns
+     */
+    Collection.prototype.toJson = function () {
+        return cloneObject(this._collection);
     };
     Object.defineProperty(Collection.prototype, "label", {
         // Getters
@@ -37,7 +46,7 @@ var Collection = /** @class */ (function () {
     });
     Object.defineProperty(Collection.prototype, "include", {
         get: function () {
-            return this._collection.include;
+            return this._collection.include || [];
         },
         enumerable: false,
         configurable: true
@@ -70,16 +79,21 @@ var Collection = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    /**
+     * Search the collection using a string or IQuery
+     * @param query
+     * @param options
+     * @returns
+     */
     Collection.prototype.search = function (query, options) {
-        var _a;
         if (options === void 0) { options = {}; }
         return __awaiter(this, void 0, void 0, function () {
-            var qry;
-            return __generator(this, function (_b) {
+            var qry, opts;
+            return __generator(this, function (_a) {
                 if (typeof query === "string") {
                     // construct a query from that...
                     qry = {
-                        targetEntity: ((_a = this._collection.scope) === null || _a === void 0 ? void 0 : _a.targetEntity) || "item",
+                        targetEntity: this._collection.targetEntity,
                         filters: [
                             {
                                 predicates: [
@@ -94,16 +108,18 @@ var Collection = /** @class */ (function () {
                 else {
                     qry = query;
                 }
+                // TODO: What should happen when a Query is passed in that has a targetEntity that doesn't match the collection's targetEntity?
                 // merge the passed in query w/ the scope
                 qry.filters = __spreadArrays(qry.filters, this.scope.filters);
-                options.requestOptions = this._context.hubRequestOptions;
+                opts = cloneObject(options);
+                opts.requestOptions = this._context.hubRequestOptions;
                 // inject default sort info if not specified
-                options.sortField = options.sortField || this.sortField;
-                options.sortOrder = options.sortOrder || this.sortDirection;
+                opts.sortField = options.sortField || this.sortField;
+                opts.sortOrder = options.sortOrder || this.sortDirection;
                 // inject default includes if not specified
-                options.include = options.include || this.include;
+                opts.include = options.include || this.include;
                 // execute the search and return results
-                return [2 /*return*/, hubSearchQuery(qry, options)];
+                return [2 /*return*/, hubSearch(qry, opts)];
             });
         });
     };

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

@@ -1 +1 @@
-{"version":3,"file":"Collection.js","sourceRoot":"","sources":["../../../src/search/Collection.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAkB,MAAM,IAAI,CAAC;AAWpD;;GAEG;AACH,0BAA0B;AAC1B;IAGE,oBAAoB,UAA0B,EAAE,OAAwB;QACtE,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;SACzB;IACH,CAAC;IAEmB,iBAAM,GAA1B,UACE,UAA0B,EAC1B,OAAwB;;;;gBAIlB,GAAG,GAAG,IAAI,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;gBAChD,sBAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAC;;;KAC7B;IAID,sBAAW,6BAAK;QAFhB,UAAU;aAEV;YACE,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;QAChC,CAAC;;;OAAA;IACD,sBAAW,2BAAG;aAAd;YACE,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;QAC9B,CAAC;;;OAAA;IACD,sBAAW,+BAAO;aAAlB;YACE,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;QAClC,CAAC;;;OAAA;IACD,sBAAW,6BAAK;aAAhB;YACE,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;QAChC,CAAC;;;OAAA;IACD,sBAAW,iCAAS;aAApB;YACE,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,IAAI,OAAO,CAAC;QAC/C,CAAC;;;OAAA;IACD,sBAAW,qCAAa;aAAxB;YACE,OAAO,IAAI,CAAC,WAAW,CAAC,aAAa,IAAI,KAAK,CAAC;QACjD,CAAC;;;OAAA;IACD,sBAAW,oCAAY;aAAvB;YACE,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC;QACvC,CAAC;;;OAAA;IAEY,2BAAM,GAAnB,UACE,KAAsB,EACtB,OAA+B;;QAA/B,wBAAA,EAAA,YAA+B;;;;gBAG/B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;oBAC7B,iCAAiC;oBACjC,GAAG,GAAG;wBACJ,YAAY,EAAE,OAAA,IAAI,CAAC,WAAW,CAAC,KAAK,0CAAE,YAAY,KAAI,MAAM;wBAC5D,OAAO,EAAE;4BACP;gCACE,UAAU,EAAE;oCACV;wCACE,IAAI,EAAE,KAAK;qCACZ;iCACF;6BACF;yBACF;qBACF,CAAC;iBACH;qBAAM;oBACL,GAAG,GAAG,KAAK,CAAC;iBACb;gBAED,yCAAyC;gBACzC,GAAG,CAAC,OAAO,kBAAO,GAAG,CAAC,OAAO,EAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAEtD,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC;gBACzD,4CAA4C;gBAC5C,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC;gBACxD,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,aAAa,CAAC;gBAC5D,2CAA2C;gBAC3C,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;gBAElD,wCAAwC;gBACxC,sBAAO,cAAc,CAAC,GAAG,EAAE,OAAO,CAAC,EAAC;;;KACrC;IACH,iBAAC;AAAD,CAAC,AAhFD,IAgFC"}
+{"version":3,"file":"Collection.js","sourceRoot":"","sources":["../../../src/search/Collection.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAkB,MAAM,IAAI,CAAC;AASjD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC;;;;;;GAMG;AACH;IAGE,oBAAoB,UAA0B,EAAE,OAAuB;QACrE,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACW,mBAAQ,GAAtB,UACE,UAA0B,EAC1B,OAAuB;QAEvB,OAAO,IAAI,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,2BAAM,GAAN;QACE,OAAO,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC;IAID,sBAAW,6BAAK;QAFhB,UAAU;aAEV;YACE,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;QAChC,CAAC;;;OAAA;IACD,sBAAW,2BAAG;aAAd;YACE,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;QAC9B,CAAC;;;OAAA;IACD,sBAAW,+BAAO;aAAlB;YACE,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC;QACxC,CAAC;;;OAAA;IACD,sBAAW,6BAAK;aAAhB;YACE,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;QAChC,CAAC;;;OAAA;IACD,sBAAW,iCAAS;aAApB;YACE,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,IAAI,OAAO,CAAC;QAC/C,CAAC;;;OAAA;IACD,sBAAW,qCAAa;aAAxB;YACE,OAAO,IAAI,CAAC,WAAW,CAAC,aAAa,IAAI,KAAK,CAAC;QACjD,CAAC;;;OAAA;IACD,sBAAW,oCAAY;aAAvB;YACE,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC;QACvC,CAAC;;;OAAA;IAED;;;;;OAKG;IACU,2BAAM,GAAnB,UACE,KAAsB,EACtB,OAA+B;QAA/B,wBAAA,EAAA,YAA+B;;;;gBAG/B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;oBAC7B,iCAAiC;oBACjC,GAAG,GAAG;wBACJ,YAAY,EAAE,IAAI,CAAC,WAAW,CAAC,YAAY;wBAC3C,OAAO,EAAE;4BACP;gCACE,UAAU,EAAE;oCACV;wCACE,IAAI,EAAE,KAAK;qCACZ;iCACF;6BACF;yBACF;qBACF,CAAC;iBACH;qBAAM;oBACL,GAAG,GAAG,KAAK,CAAC;iBACb;gBAED,+HAA+H;gBAE/H,yCAAyC;gBACzC,GAAG,CAAC,OAAO,kBAAO,GAAG,CAAC,OAAO,EAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAChD,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;gBAClC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC;gBACtD,4CAA4C;gBAC5C,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC;gBACrD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,aAAa,CAAC;gBACzD,2CAA2C;gBAC3C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;gBAE/C,wCAAwC;gBACxC,sBAAO,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,EAAC;;;KAC7B;IACH,iBAAC;AAAD,CAAC,AAjGD,IAiGC"}

package/dist/esm/search/_internal/{ipredicate-utils.js → expandPredicate.js}

@@ -43,4 +43,4 @@ export function expandPredicate(predicate) {
     });
     return result;
 }
-//# sourceMappingURL=ipredicate-utils.js.map
+//# sourceMappingURL=expandPredicate.js.map

package/dist/esm/search/_internal/expandPredicate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"expandPredicate.js","sourceRoot":"","sources":["../../../../src/search/_internal/expandPredicate.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAExE;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,SAAqB;IACnD,IAAM,MAAM,GAAe,EAAE,CAAC;IAC9B,IAAM,SAAS,GAAG,CAAC,SAAS,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IACvD,IAAM,SAAS,GAAG;QAChB,YAAY;QACZ,MAAM;QACN,kBAAkB;QAClB,YAAY;QACZ,gBAAgB;KACjB,CAAC;IACF,IAAM,qBAAqB,kBAAO,SAAS,EAAK,SAAS,CAAC,CAAC;IAC3D,oBAAoB;IACpB,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAC,EAAY;YAAX,GAAG,QAAA,EAAE,KAAK,QAAA;QAC5C,6BAA6B;QAC7B,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACxC,OAAO,CAAC,GAAG,EAAE,mBAAmB,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;SAClD;QACD,qBAAqB;QACrB,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC3B,IAAM,cAAc,GAAG,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;YAC5D,IAAI,OAAO,CAAC,SAAS,EAAK,GAAG,UAAO,CAAC,KAAK,eAAe,EAAE;gBACzD,OAAO,CAAC,GAAG,EAAE,uBAAuB,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC;aAC/D;iBAAM;gBACL,OAAO,CAAC,GAAG,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC;aACtC;SACF;QACD,6CAA6C;QAC7C,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;YAC5D,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;SAC7B;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC"}