@esri/hub-common 9.26.2 → 9.27.0

package/dist/types/search/{types.d.ts → types/types.d.ts}

@@ -1,5 +1,6 @@
 import { UserSession } from "@esri/arcgis-rest-auth";
-import { IHubContent, IModel } from "..";
+import { IHubContent, IModel } from "../..";
+import { IFacet } from "./IFacet";
 /**
  * Generic filter used with various search functions.
  *
@@ -139,82 +140,6 @@ export interface IEventFilterDefinition {
     orgid?: string | string[] | IMatchOptions;
     title?: string | string[] | IMatchOptions;
 }
-export interface IFacet {
-    label: string;
-    attribute?: string;
-    type: "single-select" | "multi-select" | "date-range" | "histogram";
-    options?: IFacetOption[];
-    accordionClosed?: boolean;
-    pageSize?: number;
-}
-export interface IFacetOption {
-    label: string;
-    value: string;
-    count?: number;
-    selected: boolean;
-    filter: Filter<FilterType>;
-}
-/**
- * Catalog is the definition which powers what options
- * are available in a Gallery. It controls not only
- * the scoping of the search, but also the options
- * available to the UX.
- *
- * Thus the lower-level `searchContent`, `searchUser`, `searchGroup` functions
- * do not take Catalogs, rather they accept [Filters](../Filter)
- *
- * ```ts
- * const simpleCatalog:Catalog = {
- *   title: "Select Map",
- *   filter: {
- *     filterType: "content",
- *     type: "Web Map",
- *     owner: "jsmith"
- *   }
- * }
- * ```
- *
- * ## Collections
- * The key feature of a Catalog is the ability to defined [Collections](../Collection).
- * These are essentially sub-sets of content, typically organized around
- * generalized content types, i.e. "Datasets", vs "Maps", vs "Documents"
- *
- *
- * ```ts
- * const complex:Catalog = {
- *   filter: {
- *    type: "content",
- *    groups: ["3ef", "bc4"]
- *   },
- *   collections: [
- *     {
- *       label: "Documents",
- *       filter: {
- *         filterType: "content",
- *         type: ["Microsoft Word", "PDF", "Microsoft Excel"]
- *       }
- *     },
- *     {
- *       label: "Datasets",
- *       filter: {
- *         filterType: "content",
- *         type: ["Feature Layer", "Feature Service", "Map Service", "CSV"]
- *       }
- *     }
- *   ]
- * }
- * ```
- */
-export interface ICatalog {
-    /**
-     * Title for the Gallery
-     */
-    title?: string;
-    filter: Filter<FilterType>;
-    sort?: ISortOption[];
-    collections?: ICollection[];
-    facets?: IFacet[];
-}
 /**
  * Sort Option to be displayed in a UI
  */
@@ -224,14 +149,6 @@ export interface ISortOption {
     defaultOrder: string;
     order: string;
 }
-/**
- * A Filter that defines a subset of a Catalog, aka a Collection
- */
-export interface ICollection {
-    label: string;
-    filter: Filter<FilterType>;
-    facets?: IFacet[];
-}
 /**
  * Defines a span of time by specifying a `from` and `to` Date
  * as either a number or a ISO string
@@ -288,10 +205,12 @@ export interface IHubSearchOptions {
     page?: string;
     start?: number;
     num?: number;
-    aggregations?: string[];
+    aggFields?: string[];
+    aggLimit?: number;
     bbox?: string;
     fields?: string;
     api?: NamedApis | IApiDefinition;
+    aggregations?: string[];
 }
 /**
  * searchContent return
@@ -318,3 +237,21 @@ export interface IApiDefinition {
     type: "arcgis" | "arcgis-hub";
     authentication?: UserSession;
 }
+export interface IFacetState {
+    [key: string]: string;
+}
+export interface ICollectionState {
+    query?: string;
+    sort?: string;
+    [key: string]: string;
+}
+export interface ICatalogState {
+    collection: string;
+    collectionState?: ICollectionState;
+}
+/**
+ * Generic key/value type for storing component state
+ */
+export interface IComponentState {
+    [key: string]: string;
+}

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

@@ -1,7 +1,7 @@
 import { IUser } from "@esri/arcgis-rest-auth";
 import { IGroup, ISearchOptions } from "@esri/arcgis-rest-portal";
 import { ISearchResponse } from "../types";
-import { IMatchOptions, IDateRange, IRelativeDate, IWellKnownApis, IApiDefinition, NamedApis } from "./types";
+import { IMatchOptions, IDateRange, IRelativeDate, IWellKnownApis, IApiDefinition, NamedApis } from "./types/types";
 /**
  * Well known APIs
  * Short-forms for specifying common APIs

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.26.1 - Fri Apr 08 2022 17:54:59 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.26.2 - Mon Apr 11 2022 15:58:14 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,
@@ -14781,10 +14789,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
@@ -14808,10 +14816,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);
                 }
@@ -15042,6 +15057,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
@@ -16862,6 +17067,7 @@
     exports.addSiteDomains = addSiteDomains;
     exports.addSolutionResourceUrlToAssets = addSolutionResourceUrlToAssets;
     exports.addUsersToGroup = addUsersToGroup;
+    exports.applyCollectionState = applyCollectionState;
     exports.applyPropertiesToItems = applyPropertiesToItems;
     exports.arrayToObject = arrayToObject;
     exports.atob = abab.atob;
@@ -17060,6 +17266,7 @@
     exports.saveSession = saveSession;
     exports.searchProjects = searchProjects;
     exports.searchSites = searchSites;
+    exports.serializeCollectionState = serializeCollectionState;
     exports.serializeContentFilterForPortal = serializeContentFilterForPortal;
     exports.serializeDateRange = serializeDateRange;
     exports.serializeGroupFilterForPortal = serializeGroupFilterForPortal;