@esri/hub-common 9.26.1 → 9.28.0

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.26.0 - Wed Apr 06 2022 16:02:42 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.27.0 - Tue Apr 12 2022 05:32:00 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -12110,29 +12110,37 @@
     };
     /**
      * @private
-     * Convert portal search response to items
+     * Convert portal search response to facets
+     * Note: Only applicable to a "content" search
      * @param response
      * @returns
      */
-    function convertPortalResponseToFacets(response) {
+    function convertPortalResponseToFacets(response, operation) {
         var _a;
+        if (operation === void 0) { operation = "OR"; }
         var result = [];
         if ((_a = response.aggregations) === null || _a === void 0 ? void 0 : _a.counts) {
             response.aggregations.counts.forEach(function (entry) {
                 var facet = {
                     label: entry.fieldName,
-                    attribute: entry.fieldName,
-                    type: "multi-select",
+                    key: entry.fieldName,
+                    aggField: entry.fieldName,
+                    display: "multi-select",
                 };
                 var options = [];
                 entry.fieldValues.forEach(function (fv) {
                     var filter = {
                         filterType: "content",
                     };
-                    filter[entry.fieldName] = fv.value;
+                    // construct the filter based on the operation
+                    var matchKey = operation === "OR" ? "any" : "all";
+                    var filterMatchOption = {};
+                    filterMatchOption[matchKey] = [fv.value];
+                    filter[entry.fieldName] = filterMatchOption;
+                    // construct the FacetOption
                     var fo = {
-                        label: fv.value,
-                        value: fv.value,
+                        label: fv.value + " (" + fv.count + ")",
+                        key: fv.value,
                         count: fv.count,
                         selected: false,
                         filter: filter,
@@ -12406,14 +12414,22 @@
      * @returns
      */
     function searchContentEntities(filter, convertFn, options) {
-        var _a;
+        var _a, _b;
         // expand filter so we can serialize to either api
         var expanded = expandContentFilter(filter);
         var searchOptions = serializeContentFilterForPortal(expanded);
-        // Aggregations
+        // DEPRECATION
+        /* istanbul ignore next */
         if ((_a = options.aggregations) === null || _a === void 0 ? void 0 : _a.length) {
+            // tslint:disable-next-line:no-console
+            console.warn("IHubSearchOptions.aggregations is deprecated. Please use .aggFields instead.");
             searchOptions.countFields = options.aggregations.join(",");
-            searchOptions.countSize = 200;
+            searchOptions.countSize = options.aggLimit || 10;
+        }
+        // Aggregations
+        if ((_b = options.aggFields) === null || _b === void 0 ? void 0 : _b.length) {
+            searchOptions.countFields = options.aggFields.join(",");
+            searchOptions.countSize = options.aggLimit || 10;
         }
         // properties to copy from IHubSearchOptions to the ISearchOptions
         var props = [
@@ -12422,7 +12438,9 @@
             "sortField",
             "sortOrder",
             "site",
+            "start",
         ];
+        // Include "start" here
         // copy the props over
         props.forEach(function (prop) {
             if (options.hasOwnProperty(prop)) {
@@ -12453,7 +12471,7 @@
         // referenced in the `next` section below
         return function searchEntities(searchOptions) {
             return __awaiter(this, void 0, void 0, function () {
-                var response, entities;
+                var response, entities, facets;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0: return [4 /*yield*/, searchItems(searchOptions)];
@@ -12464,10 +12482,11 @@
                                 }))];
                         case 2:
                             entities = _a.sent();
+                            facets = convertPortalResponseToFacets(response);
                             return [2 /*return*/, {
                                     total: response.total,
                                     results: entities,
-                                    facets: [],
+                                    facets: facets,
                                     hasNext: response.nextStart > -1,
                                     next: getNextFunction(searchOptions, response.nextStart, response.total, searchEntities),
                                 }];
@@ -14779,10 +14798,10 @@
      * @param options
      */
     function _searchContent(filter, options) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function () {
             var expanded, api, searchPromise, so_1, props;
-            return __generator(this, function (_b) {
+            return __generator(this, function (_c) {
                 expanded = expandContentFilter(filter);
                 api = expandApi(options.api || "arcgis");
                 // Portal Search
@@ -14794,6 +14813,7 @@
                         "sortField",
                         "sortOrder",
                         "site",
+                        "start",
                     ];
                     // copy the props over
                     props.forEach(function (prop) {
@@ -14805,10 +14825,17 @@
                     if (!so_1.authentication) {
                         so_1.portal = api.url + "/sharing/rest";
                     }
-                    // Aggregations
+                    // DEPRECATION
                     if ((_a = options.aggregations) === null || _a === void 0 ? void 0 : _a.length) {
+                        // tslint:disable-next-line:no-console
+                        console.warn("IHubSearchOptions.aggregations is deprecated. Please use .aggFields instead.");
                         so_1.countFields = options.aggregations.join(",");
-                        so_1.countSize = 200;
+                        so_1.countSize = options.aggLimit || 10;
+                    }
+                    // Aggregations
+                    if ((_b = options.aggFields) === null || _b === void 0 ? void 0 : _b.length) {
+                        so_1.countFields = options.aggFields.join(",");
+                        so_1.countSize = options.aggLimit || 10;
                     }
                     searchPromise = searchPortal(so_1);
                 }
@@ -14896,6 +14923,7 @@
                         "sortField",
                         "sortOrder",
                         "site",
+                        "start",
                     ];
                     // copy the props over
                     props.forEach(function (prop) {
@@ -14984,6 +15012,7 @@
                         "sortField",
                         "sortOrder",
                         "site",
+                        "start",
                     ];
                     // copy the props over
                     props.forEach(function (prop) {
@@ -15037,6 +15066,196 @@
         });
     }
 
+    /**
+     * Apply the sortState to SortOptions
+     *
+     * @param sortOptions
+     * @param sortState
+     * @returns
+     */
+    function applySortState(sortOptions, sortState) {
+        var updated = cloneObject$1(sortOptions);
+        if (sortState) {
+            var _a = sortState.split("|"), label = _a[0], attribute = _a[1], order = _a[2];
+            updated.label = label;
+            updated.attribute = attribute;
+            updated.order = order;
+        }
+        return updated;
+    }
+    /**
+     * Apply FacetState to a Facet
+     * @param facet
+     * @param state
+     * @returns
+     */
+    function applyFacetState(facet, state) {
+        var updated = cloneObject$1(facet);
+        switch (facet.display) {
+            case "single-select":
+                updated = applySingleSelectFacetState(facet, state);
+                break;
+            case "multi-select":
+                updated = applyMultiSelectFacetState(facet, state);
+                break;
+        }
+        return updated;
+    }
+    /**
+     * Apply the Facet State onto a single-select facet
+     *
+     * Intentionally mutates the facet.
+     * @param facet
+     * @param state
+     * @returns
+     */
+    function applySingleSelectFacetState(facet, state) {
+        var updated = cloneObject$1(facet);
+        updated.options = updated.options.map(function (o) {
+            o.selected = o.key === state[facet.key];
+            return o;
+        });
+        return updated;
+    }
+    /**
+     * Serialize single-select facet into IFacetState
+     * @param facet
+     * @returns
+     */
+    function serializeSingleSelectFacetState(facet) {
+        var state = {};
+        var selected = facet.options.find(function (o) { return o.selected; });
+        if (selected) {
+            state[facet.key] = selected.key;
+        }
+        else {
+            state[facet.key] = null;
+        }
+        return state;
+    }
+    /**
+     * Apply the Facet State onto a multi-select Facet
+     *
+     * Intentionally mutates the facet.
+     * @param facet
+     * @param state
+     * @returns
+     */
+    function applyMultiSelectFacetState(facet, state) {
+        var _a;
+        var updated = cloneObject$1(facet);
+        var selectedKeys = ((_a = state[facet.key]) === null || _a === void 0 ? void 0 : _a.split(",")) || [];
+        updated.options = updated.options.map(function (o) {
+            o.selected = selectedKeys.includes(o.key);
+            return o;
+        });
+        return updated;
+    }
+    /**
+     * Serialize multi-select facet into IFacetState
+     * @param facet
+     * @returns
+     */
+    function serializeMultiSelectFacetState(facet) {
+        var state = {};
+        var selected = facet.options.filter(function (o) { return o.selected; });
+        var value = selected.map(function (o) { return o.key; }).join(",");
+        if (value.length) {
+            state[facet.key] = value;
+        }
+        else {
+            state[facet.key] = null;
+        }
+        return state;
+    }
+    /**
+     * Serialize the state of the SortOption into a key/value pair
+     *
+     * Called from the Sort component
+     * @param sort
+     * @returns
+     */
+    function serializeSortState(sort) {
+        return sort.label + "|" + sort.attribute + "|" + sort.order;
+    }
+    /**
+     * Serialize the state of a facet into a key/value pair
+     *
+     * Called from the various facet components
+     * @param facet
+     * @returns
+     */
+    function serializeFacetState(facet) {
+        var state = {};
+        switch (facet.display) {
+            case "single-select":
+                state = serializeSingleSelectFacetState(facet);
+                break;
+            case "multi-select":
+                state = serializeMultiSelectFacetState(facet);
+                break;
+        }
+        return state;
+    }
+
+    /**
+     * Apply ICollectionState to an ICollection
+     *
+     * Typically used in a Gallery or Catalog component to
+     * set the inital state, based on values deserialized
+     * from a query string
+     * @param collection
+     * @param state
+     * @returns
+     */
+    function applyCollectionState(collection, state) {
+        var updated = cloneObject$1(collection);
+        // Apply default query
+        if (state.query) {
+            updated.defaultQuery = state.query;
+        }
+        // Apply Sort State
+        updated.sortOption = applySortState(updated.sortOption, state.sort);
+        // Look for state props for the facets and apply them
+        updated.facets = updated.facets.map(function (facet) {
+            // see if there is a key for this facet on the state
+            if (Object.keys(state).includes(facet.key)) {
+                var facetState = {};
+                facetState[facet.key] = state[facet.key];
+                return applyFacetState(facet, facetState);
+            }
+            else {
+                // Ensure all options are not selected
+                // because they were not included in the state
+                facet.options.forEach(function (opt) {
+                    opt.selected = false;
+                });
+                return facet;
+            }
+        });
+        //
+        return updated;
+    }
+    /**
+     * Serialize the current state of a collection into a hash that
+     * can be converted into a query string
+     * @param collection
+     * @returns
+     */
+    function serializeCollectionState(collection) {
+        var state = {};
+        if (collection.defaultQuery) {
+            state.query = collection.defaultQuery;
+        }
+        if (collection.sortOption) {
+            state.sort = serializeSortState(collection.sortOption);
+        }
+        var facetState = collection.facets.reduce(function (s, facet) {
+            return __assign(__assign({}, s), serializeFacetState(facet));
+        }, {});
+        return __assign(__assign({}, state), facetState);
+    }
+
     /**
      * Add telemetry config object
      * @private
@@ -16857,6 +17076,7 @@
     exports.addSiteDomains = addSiteDomains;
     exports.addSolutionResourceUrlToAssets = addSolutionResourceUrlToAssets;
     exports.addUsersToGroup = addUsersToGroup;
+    exports.applyCollectionState = applyCollectionState;
     exports.applyPropertiesToItems = applyPropertiesToItems;
     exports.arrayToObject = arrayToObject;
     exports.atob = abab.atob;
@@ -17055,6 +17275,7 @@
     exports.saveSession = saveSession;
     exports.searchProjects = searchProjects;
     exports.searchSites = searchSites;
+    exports.serializeCollectionState = serializeCollectionState;
     exports.serializeContentFilterForPortal = serializeContentFilterForPortal;
     exports.serializeDateRange = serializeDateRange;
     exports.serializeGroupFilterForPortal = serializeGroupFilterForPortal;