@esri/hub-common 9.45.6 → 9.47.0

package/dist/types/search/_internal/state.d.ts

@@ -1,5 +1,6 @@
 import { IFacet, IFacetState, ISortOption } from "../types";
 /**
+ * @private
  * Apply the sortState to SortOptions
  *
  * @param sortOptions
@@ -8,6 +9,7 @@ import { IFacet, IFacetState, ISortOption } from "../types";
  */
 export declare function applySortState(sortOptions: ISortOption, sortState: string): ISortOption;
 /**
+ * @private
  * Apply FacetState to a Facet
  * @param facet
  * @param state
@@ -15,6 +17,7 @@ export declare function applySortState(sortOptions: ISortOption, sortState: stri
  */
 export declare function applyFacetState(facet: IFacet, state: IFacetState): IFacet;
 /**
+ * @private
  * Apply the Facet State onto a single-select facet
  *
  * Intentionally mutates the facet.
@@ -24,12 +27,14 @@ export declare function applyFacetState(facet: IFacet, state: IFacetState): IFac
  */
 export declare function applySingleSelectFacetState(facet: IFacet, state: IFacetState): IFacet;
 /**
+ * @private
  * Serialize single-select facet into IFacetState
  * @param facet
  * @returns
  */
 export declare function serializeSingleSelectFacetState(facet: IFacet): IFacetState;
 /**
+ * @private
  * Apply the Facet State onto a multi-select Facet
  *
  * Intentionally mutates the facet.
@@ -39,12 +44,14 @@ export declare function serializeSingleSelectFacetState(facet: IFacet): IFacetSt
  */
 export declare function applyMultiSelectFacetState(facet: IFacet, state: IFacetState): IFacet;
 /**
+ * @private
  * Serialize multi-select facet into IFacetState
  * @param facet
  * @returns
  */
 export declare function serializeMultiSelectFacetState(facet: IFacet): IFacetState;
 /**
+ * @private
  * Serialize the state of the SortOption into a key/value pair
  *
  * Called from the Sort component
@@ -53,6 +60,7 @@ export declare function serializeMultiSelectFacetState(facet: IFacet): IFacetSta
  */
 export declare function serializeSortState(sort: ISortOption): string;
 /**
+ * @private
  * Serialize the state of a facet into a key/value pair
  *
  * Called from the various facet components

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

@@ -1,6 +1,7 @@
 import { Filter, IHubSearchOptions } from "./types";
 import { IHubContent, ISearchResponse } from "..";
 /**
+ * @private
  * Search for content via the Portal or Hub API
  * @param filter
  * @param options

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

@@ -6,6 +6,7 @@ export interface IGroupSearchResult {
     facets: IFacet[];
 }
 /**
+ * @private
  * Search Groups using Filter<"group">
  *
  * Currently just returns ISearchResult<IGroup>

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

@@ -15,6 +15,7 @@ export interface IHubUser extends IUser {
     thumbnailUrl?: string;
 }
 /**
+ * @private
  * Search for Users via the Portal API.
  *
  * **Note** Authentication is required

package/dist/types/sites/HubSiteManager.d.ts

@@ -2,7 +2,7 @@ import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
 import { IArcGISContext } from "../ArcGISContext";
 import { IHubEntityManager, IHubItemEntityManager, IHubSite } from "../core/types";
 import { ArcGISContextManager } from "../ArcGISContextManager";
-import { Filter, IHubSearchOptions } from "../search";
+import { IHubSearchOptions, IQuery } from "../search";
 import { IHubRequestOptions, ISearchResponse } from "../types";
 import { IItem } from "@esri/arcgis-rest-types";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
@@ -84,7 +84,7 @@ export declare class HubSiteManager implements IHubEntityManager<IHubSite>, IHub
      * @param filter
      * @param opts
      */
-    search(filter: Filter<"content">, options: IHubSearchOptions): Promise<ISearchResponse<IHubSite>>;
+    search(query: string | IQuery, options: IHubSearchOptions): Promise<ISearchResponse<IHubSite>>;
     /**
      * Set the thumbnail for the Site
      * @param id

package/dist/types/sites/HubSites.d.ts

@@ -1,5 +1,5 @@
 import { IItem } from "@esri/arcgis-rest-portal";
-import { Filter, IHubRequestOptions, IHubSearchOptions, IHubSearchResult, IHubSite, ISearchResponse } from "..";
+import { IHubRequestOptions, IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IHubSite, IQuery } from "../index";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 export declare const HUB_SITE_ITEM_TYPE = "Hub Site Application";
 export declare const ENTERPRISE_SITE_ITEM_TYPE = "Site Application";
@@ -53,7 +53,7 @@ export declare function convertItemToSite(item: IItem, requestOptions: IRequestO
  * @param options
  * @returns
  */
-export declare function searchSites(filter: Filter<"content">, options: IHubSearchOptions): Promise<ISearchResponse<IHubSite>>;
+export declare function searchSites(query: string | IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSite>>;
 /**
  * Fetch Site specific enrichments
  * @param item

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.45.5 - Thu Jul 07 2022 20:50:46 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.46.1 - Tue Jul 19 2022 15:08:51 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -14473,6 +14473,7 @@
 
     // TODO: Remove with _searchContent
     /**
+     * @private
      * Search for content via the Portal or Hub API
      * @param filter
      * @param options
@@ -14584,6 +14585,7 @@
 
     // TODO: Remove with _searchContent
     /**
+     * @private
      * Search Groups using Filter<"group">
      *
      * Currently just returns ISearchResult<IGroup>
@@ -14668,6 +14670,7 @@
 
     // TODO: Remove with _searchContent
     /**
+     * @private
      * Search for Users via the Portal API.
      *
      * **Note** Authentication is required
@@ -14754,6 +14757,7 @@
     }
 
     /**
+     * @private
      * Apply the sortState to SortOptions
      *
      * @param sortOptions
@@ -14771,6 +14775,7 @@
         return updated;
     }
     /**
+     * @private
      * Apply FacetState to a Facet
      * @param facet
      * @param state
@@ -14789,6 +14794,7 @@
         return updated;
     }
     /**
+     * @private
      * Apply the Facet State onto a single-select facet
      *
      * Intentionally mutates the facet.
@@ -14805,6 +14811,7 @@
         return updated;
     }
     /**
+     * @private
      * Serialize single-select facet into IFacetState
      * @param facet
      * @returns
@@ -14821,6 +14828,7 @@
         return state;
     }
     /**
+     * @private
      * Apply the Facet State onto a multi-select Facet
      *
      * Intentionally mutates the facet.
@@ -14839,6 +14847,7 @@
         return updated;
     }
     /**
+     * @private
      * Serialize multi-select facet into IFacetState
      * @param facet
      * @returns
@@ -14856,6 +14865,7 @@
         return state;
     }
     /**
+     * @private
      * Serialize the state of the SortOption into a key/value pair
      *
      * Called from the Sort component
@@ -14866,6 +14876,7 @@
         return sort.label + "|" + sort.attribute + "|" + sort.order;
     }
     /**
+     * @private
      * Serialize the state of a facet into a key/value pair
      *
      * Called from the various facet components
@@ -15006,6 +15017,12 @@
         }
     }
 
+    /**
+     * @private
+     * Expand a predicate
+     * @param predicate
+     * @returns
+     */
     function expandPredicate(predicate) {
         var result = {};
         var dateProps = ["created", "modified", "lastlogin"];
@@ -15289,44 +15306,51 @@
     var HubError$1 = HubError;
 
     /**
-     * Generic search that returns Hub Entity types converted from items
-     * by the passed in `ItemToEntityFunction`
-     *
-     * This abstraction is used to ensure that searching from any of the
-     * entity managers / modules is consistent, and returns the entity
-     * types, instead of `IItem` or `IHubContent`
-     *
-     * @param filter
+     * @private
+     * Convert a portal aggregation structure into the HubAggregations structure
+     * @param searchResults
+     * @returns
+     */
+    function convertPortalAggregations(searchResults) {
+        var _a;
+        if ((_a = searchResults.aggregations) === null || _a === void 0 ? void 0 : _a.counts) {
+            return searchResults.aggregations.counts.map(function (entry) {
+                return {
+                    mode: "terms",
+                    field: entry.fieldName,
+                    values: entry.fieldValues,
+                };
+            });
+        }
+        else {
+            return [];
+        }
+    }
+
+    /**
+     * @private
+     * Execute a search and convert to a specific entity
+     * @param query
      * @param convertFn
      * @param options
      * @returns
      */
-    function searchContentEntities(filter, convertFn, options) {
-        var _a, _b;
-        // expand filter so we can serialize to either api
-        var expanded = expandContentFilter(filter);
-        var searchOptions = serializeContentFilterForPortal(expanded);
-        // 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 = options.aggLimit || 10;
-        }
+    function searchEntities(query, convertFn, options) {
+        var _a;
+        // serialize query to searchOptions
+        var searchOptions = serializeQueryForPortal(query);
         // Aggregations
-        if ((_b = options.aggFields) === null || _b === void 0 ? void 0 : _b.length) {
+        if ((_a = options.aggFields) === null || _a === void 0 ? void 0 : _a.length) {
             searchOptions.countFields = options.aggFields.join(",");
             searchOptions.countSize = options.aggLimit || 10;
         }
         // properties to copy from IHubSearchOptions to the ISearchOptions
         var props = [
-            "authentication",
             "num",
             "sortField",
             "sortOrder",
-            "site",
             "start",
+            "requestOptions",
         ];
         // Include "start" here
         // copy the props over
@@ -15336,8 +15360,7 @@
             }
         });
         // create the entitySearchFn
-        var searchFn = createContentEntitySearchFn(convertFn);
-        // execute the search
+        var searchFn = createEntitySearchFn(convertFn);
         // Add ArcGIS API
         if (options.api && !options.authentication) {
             var expandedApi = expandApi(options.api);
@@ -15346,20 +15369,17 @@
         return searchFn(searchOptions);
     }
     /**
-     * Return a function that holds a closure containing
-     * a hub entity specific conversion function. This
-     * allows the `.next()` function to use the function on
-     * subsequent calls
+     * @private
      * @param convertFn
      * @returns
      */
-    function createContentEntitySearchFn(convertFn) {
+    function createEntitySearchFn(convertFn) {
         // Return a function that does the search, with a closure over the
         // conversion function. Naming this function is important as it's
         // referenced in the `next` section below
-        return function searchEntities(searchOptions) {
+        return function executeSearch(searchOptions) {
             return __awaiter(this, void 0, void 0, function () {
-                var response, entities, facets;
+                var response, entities, aggregations;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0: return [4 /*yield*/, searchItems(searchOptions)];
@@ -15370,13 +15390,13 @@
                                 }))];
                         case 2:
                             entities = _a.sent();
-                            facets = convertPortalResponseToFacets(response);
+                            aggregations = convertPortalAggregations(response);
                             return [2 /*return*/, {
                                     total: response.total,
                                     results: entities,
-                                    facets: facets,
+                                    aggregations: aggregations,
                                     hasNext: response.nextStart > -1,
-                                    next: getNextFunction(searchOptions, response.nextStart, response.total, searchEntities),
+                                    next: getNextFunction(searchOptions, response.nextStart, response.total, executeSearch),
                                 }];
                     }
                 });
@@ -15987,24 +16007,34 @@
     /**
      * Search for Projects, and get IHubProject results
      *
-     * Different from `searchContent` in that this returns the specific entity type
+     * Different from `hubSearch` in that this returns the IHubProjects
      *
      * @param filter
      * @param options
      * @returns
      */
-    function searchProjects(filter, options) {
+    function searchProjects(query, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var scopingFilter, projectFilter;
+            var qry, scopingFilters;
             return __generator(this, function (_a) {
-                scopingFilter = {
-                    filterType: "content",
-                    type: {
-                        exact: ["Hub Project"],
+                if (typeof query === "string") {
+                    qry = createQueryFromString(query, "term", "item");
+                }
+                else {
+                    qry = cloneObject$1(query);
+                }
+                scopingFilters = [
+                    {
+                        predicates: [
+                            {
+                                type: "Hub Project",
+                            },
+                        ],
                     },
-                };
-                projectFilter = mergeContentFilter([scopingFilter, filter]);
-                return [2 /*return*/, searchContentEntities(projectFilter, convertItemToProject, options)];
+                ];
+                // add filters from the passed in query
+                qry.filters = __spreadArrays(scopingFilters, qry.filters);
+                return [2 /*return*/, searchEntities(qry, convertItemToProject, options)];
             });
         });
     }
@@ -16280,17 +16310,17 @@
         /**
          * Search for Projects
          *
-         * @param filter
+         * @param query
          * @param options
          */
-        HubProjectManager.prototype.search = function (filter, options) {
+        HubProjectManager.prototype.search = function (query, options) {
             return __awaiter(this, void 0, void 0, function () {
                 return __generator(this, function (_a) {
                     // if we were not passed auth, and we have a session, use it
                     if (!options.authentication && this.context.session) {
                         options.authentication = this.context.session;
                     }
-                    return [2 /*return*/, searchProjects(filter, options)];
+                    return [2 /*return*/, searchProjects(query, options)];
                 });
             });
         };
@@ -16933,6 +16963,28 @@
         });
     }
 
+    /**
+     * @private
+     * Construct a query from a string
+     * @param value
+     * @param predicateKey
+     * @param targetEntity
+     * @returns
+     */
+    function createQueryFromString(value, predicateKey, targetEntity) {
+        var predicate = {};
+        predicate[predicateKey] = value;
+        var qry = {
+            targetEntity: targetEntity,
+            filters: [
+                {
+                    predicates: [predicate],
+                },
+            ],
+        };
+        return qry;
+    }
+
     var HUB_SITE_ITEM_TYPE = "Hub Site Application";
     var ENTERPRISE_SITE_ITEM_TYPE = "Site Application";
     /**
@@ -17360,17 +17412,28 @@
      * @param options
      * @returns
      */
-    function searchSites(filter, options) {
+    function searchSites(query, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var scopingFilter, sitesFilter;
+            var qry, scopingFilters;
             return __generator(this, function (_a) {
-                scopingFilter = {
-                    filterType: "content",
-                    type: "$site",
-                };
-                sitesFilter = mergeContentFilter([scopingFilter, filter]);
-                // delegate
-                return [2 /*return*/, searchContentEntities(sitesFilter, convertItemToSite, options)];
+                if (typeof query === "string") {
+                    qry = createQueryFromString(query, "term", "item");
+                }
+                else {
+                    qry = cloneObject$1(query);
+                }
+                scopingFilters = [
+                    {
+                        predicates: [
+                            {
+                                type: "Hub Project",
+                            },
+                        ],
+                    },
+                ];
+                // add filters from the passed in query
+                qry.filters = __spreadArrays(scopingFilters, qry.filters);
+                return [2 /*return*/, searchEntities(qry, convertItemToSite, options)];
             });
         });
     }
@@ -17570,14 +17633,14 @@
          * @param filter
          * @param opts
          */
-        HubSiteManager.prototype.search = function (filter, options) {
+        HubSiteManager.prototype.search = function (query, options) {
             return __awaiter(this, void 0, void 0, function () {
                 return __generator(this, function (_a) {
                     // if we were not passed auth, and we have a session, use it
                     if (!options.authentication && this.context.session) {
                         options.authentication = this.context.session;
                     }
-                    return [2 /*return*/, searchSites(filter, options)];
+                    return [2 /*return*/, searchSites(query, options)];
                 });
             });
         };
@@ -17899,28 +17962,6 @@
         }
     }
 
-    /**
-     * @private
-     * Convert a portal aggregation structure into the HubAggregations structure
-     * @param searchResults
-     * @returns
-     */
-    function convertPortalAggregations(searchResults) {
-        var _a;
-        if ((_a = searchResults.aggregations) === null || _a === void 0 ? void 0 : _a.counts) {
-            return searchResults.aggregations.counts.map(function (entry) {
-                return {
-                    mode: "terms",
-                    field: entry.fieldName,
-                    values: entry.fieldValues,
-                };
-            });
-        }
-        else {
-            return [];
-        }
-    }
-
     /**
      * @private
      * Portal Search Implementation for Items
@@ -18219,6 +18260,7 @@
         // iterate the filters
         queryClone.filters = queryClone.filters.map(function (filter) {
             // replace predicates with well-known types
+            var replacedPredicates = false;
             filter.predicates = filter.predicates.reduce(function (acc, predicate) {
                 // if the predicate has a well-known type
                 // we replace it with the set of predicates defined
@@ -18226,6 +18268,7 @@
                 if (isWellKnownTypeFilter(predicate.type)) {
                     var replacements = lookupTypePredicates(predicate.type);
                     acc = __spreadArrays(acc, replacements);
+                    replacedPredicates = true;
                 }
                 else {
                     // this predicate does not have a well-known type
@@ -18234,6 +18277,12 @@
                 }
                 return acc;
             }, []);
+            if (replacedPredicates) {
+                // Any filter who's predicates were replaced with
+                // well-known predicates, needs to use "OR" to ensure
+                // correct query logic
+                filter.operation = "OR";
+            }
             return filter;
         });
         return queryClone;
@@ -18280,6 +18329,7 @@
     //
     // Since Hub API is still in flux, there is no code coverage for this file
     /**
+     * @private
      * Execute item search against the Hub API
      * @param filter
      * @param options