@esri/hub-common 9.45.5 → 9.45.6

package/dist/node/search/{ifilter-utils.js → serializeQueryForPortal.js}

@@ -2,24 +2,41 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serializeQueryForPortal = void 0;
 const ipredicate_utils_1 = require("./_internal/ipredicate-utils");
+/**
+ * Serialize IQuery into ISearchOptions for ArcGIS Portal
+ * @param query
+ * @returns
+ */
 function serializeQueryForPortal(query) {
     const filterSearchOptions = query.filters.map(serializeFilter);
-    const result = mergeSearchOptions(filterSearchOptions, "AND");
+    // remove any empty entries
+    const nonEmptyOptions = filterSearchOptions.filter(removeEmptyEntries);
+    const result = mergeSearchOptions(nonEmptyOptions, "AND");
     return result;
 }
 exports.serializeQueryForPortal = serializeQueryForPortal;
+/**
+ * Predicate to remove things from array
+ * @param e
+ * @returns
+ */
+function removeEmptyEntries(e) {
+    return !(typeof e === "undefined" || e === null || e === "");
+}
 function mergeSearchOptions(options, operation) {
     const result = options.reduce((acc, entry) => {
         // walk the props
         Object.entries(entry).forEach(([key, value]) => {
-            // if prop exists
-            if (acc[key]) {
+            // if prop exists and is not empty string
+            if (acc[key] && value !== "") {
                 // combine via operation
                 acc[key] = `${acc[key]} ${operation} ${value}`;
             }
             else {
-                // just copy the value
-                acc[key] = value;
+                // just copy the value if it's not empty string
+                if (value !== "") {
+                    acc[key] = value;
+                }
             }
         });
         return acc;
@@ -34,7 +51,9 @@ function mergeSearchOptions(options, operation) {
 function serializeFilter(filter) {
     const operation = filter.operation || "AND";
     const predicates = filter.predicates.map(ipredicate_utils_1.expandPredicate);
-    const predicateSearchOptions = predicates.map(serializePredicate);
+    const predicateSearchOptions = predicates
+        .map(serializePredicate)
+        .filter((e) => e !== undefined && e !== null);
     // combine these searchOptions
     const searchOptions = mergeSearchOptions(predicateSearchOptions, operation);
     // wrap in parens if we have more than one predicate
@@ -104,7 +123,7 @@ function serializePredicate(predicate) {
         // not attempt to ensure the properties are used in the correct combinations
         if (portalAllowList.includes(key)) {
             const so = { q: "" };
-            if (!specialProps.includes(key)) {
+            if (!specialProps.includes(key) && key !== "term") {
                 qCount++;
                 so.q = serializeMatchOptions(key, value);
             }
@@ -126,13 +145,18 @@ function serializePredicate(predicate) {
             return so;
         }
     })
-        .filter((e) => e !== undefined);
+        .filter(removeEmptyEntries);
     // merge up all the searchOptions
-    const searchOptions = mergeSearchOptions(opts, "AND");
-    if (qCount > 1) {
-        searchOptions.q = `(${searchOptions.q})`;
+    if (opts.length) {
+        const searchOptions = mergeSearchOptions(opts, "AND");
+        if (qCount > 1) {
+            searchOptions.q = `(${searchOptions.q})`;
+        }
+        return searchOptions;
+    }
+    else {
+        return null;
     }
-    return searchOptions;
 }
 /**
  * Serialize MatchOptions into portal syntax
@@ -187,4 +211,4 @@ function serializeStringOrArray(join, key, value) {
     }
     return q;
 }
-//# sourceMappingURL=ifilter-utils.js.map
+//# sourceMappingURL=serializeQueryForPortal.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"serializeQueryForPortal.js","sourceRoot":"","sources":["../../../src/search/serializeQueryForPortal.ts"],"names":[],"mappings":";;;AAQA,mEAA+D;AAE/D;;;;GAIG;AACH,SAAgB,uBAAuB,CAAC,KAAa;IACnD,MAAM,mBAAmB,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAC/D,2BAA2B;IAC3B,MAAM,eAAe,GAAG,mBAAmB,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;IACvE,MAAM,MAAM,GAAG,kBAAkB,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;IAE1D,OAAO,MAAM,CAAC;AAChB,CAAC;AAPD,0DAOC;AAED;;;;GAIG;AACH,SAAS,kBAAkB,CAAC,CAAM;IAChC,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,WAAW,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,kBAAkB,CACzB,OAAyB,EACzB,SAAuB;IAEvB,MAAM,MAAM,GAAmB,OAAO,CAAC,MAAM,CAC3C,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;QACb,iBAAiB;QACjB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC7C,yCAAyC;YACzC,IAAI,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,EAAE,EAAE;gBAC5B,wBAAwB;gBACxB,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,IAAI,SAAS,IAAI,KAAK,EAAE,CAAC;aAChD;iBAAM;gBACL,+CAA+C;gBAC/C,IAAI,KAAK,KAAK,EAAE,EAAE;oBAChB,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;iBAClB;aACF;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAE,CAAC,EAAE,EAAE,EAAE,CACV,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,MAAe;IACtC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,KAAK,CAAC;IAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,kCAAe,CAAC,CAAC;IAE1D,MAAM,sBAAsB,GAAG,UAAU;SACtC,GAAG,CAAC,kBAAkB,CAAC;SACvB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC;IAEhD,8BAA8B;IAC9B,MAAM,aAAa,GAAG,kBAAkB,CAAC,sBAAsB,EAAE,SAAS,CAAC,CAAC;IAC5E,oDAAoD;IACpD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;QACzB,aAAa,CAAC,CAAC,GAAG,IAAI,aAAa,CAAC,CAAC,GAAG,CAAC;KAC1C;IACD,OAAO,aAAa,CAAC;AACvB,CAAC;AACD;;;;GAIG;AACH,SAAS,kBAAkB,CAAC,SAAqB;IAC/C,MAAM,SAAS,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAC1C,MAAM,SAAS,GAAG,CAAC,YAAY,CAAC,CAAC;IACjC,MAAM,gBAAgB,GAAG,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC;IAChE,MAAM,YAAY,GAAG;QACnB,YAAY;QACZ,MAAM;QACN,GAAG,SAAS;QACZ,GAAG,SAAS;QACZ,GAAG,gBAAgB;KACpB,CAAC;IACF,MAAM,eAAe,GAAG;QACtB,QAAQ;QACR,YAAY;QACZ,SAAS;QACT,aAAa;QACb,UAAU;QACV,OAAO;QACP,aAAa;QACb,WAAW;QACX,UAAU;QACV,OAAO;QACP,IAAI;QACJ,kBAAkB;QAClB,YAAY;QACZ,QAAQ;QACR,WAAW;QACX,UAAU;QACV,YAAY;QACZ,UAAU;QACV,MAAM;QACN,OAAO;QACP,QAAQ;QACR,OAAO;QACP,UAAU;QACV,MAAM;QACN,kBAAkB;QAClB,gBAAgB;QAChB,SAAS;QACT,MAAM;QACN,MAAM;QACN,OAAO;QACP,MAAM;QACN,cAAc;QACd,iBAAiB;QACjB,UAAU;KACX,CAAC;IACF,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,8DAA8D;IAC9D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;SACnC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACpB,+DAA+D;QAC/D,oEAAoE;QACpE,4EAA4E;QAC5E,IAAI,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACjC,MAAM,EAAE,GAAmB,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;YACrC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,MAAM,EAAE;gBACjD,MAAM,EAAE,CAAC;gBACT,EAAE,CAAC,CAAC,GAAG,qBAAqB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;aAC1C;YACD,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBAC3B,MAAM,EAAE,CAAC;gBACT,EAAE,CAAC,CAAC,GAAG,kBAAkB,CACvB,GAAG,EACH,KAAsC,CACvC,CAAC;aACH;YACD,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBAC3B,MAAM,EAAE,CAAC;gBACT,EAAE,CAAC,CAAC,GAAG,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;aAC1B;YACD,IAAI,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBAClC,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;aACjB;YACD,IAAI,GAAG,KAAK,MAAM,EAAE;gBAClB,MAAM,EAAE,CAAC;gBACT,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC;aACd;YACD,OAAO,EAAE,CAAC;SACX;IACH,CAAC,CAAC;SACD,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAE9B,iCAAiC;IACjC,IAAI,IAAI,CAAC,MAAM,EAAE;QACf,MAAM,aAAa,GAAG,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACtD,IAAI,MAAM,GAAG,CAAC,EAAE;YACd,aAAa,CAAC,CAAC,GAAG,IAAI,aAAa,CAAC,CAAC,GAAG,CAAC;SAC1C;QACD,OAAO,aAAa,CAAC;KACtB;SAAM;QACL,OAAO,IAAI,CAAC;KACb;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,qBAAqB,CAAC,GAAW,EAAE,KAAoB;IAC9D,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,KAAK,CAAC,GAAG,EAAE;QACb,MAAM,GAAG,GAAG,sBAAsB,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;KAC5D;IACD,IAAI,KAAK,CAAC,GAAG,EAAE;QACb,MAAM;YACJ,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChC,GAAG,sBAAsB,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;KACtD;IACD,IAAI,KAAK,CAAC,GAAG,EAAE;QACb,qCAAqC;QACrC,MAAM;YACJ,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChC,GAAG,sBAAsB,CAAC,IAAI,EAAE,IAAI,GAAG,EAAE,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;KAC3D;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,GAAW,EAAE,KAAyB;IAChE,OAAO,GAAG,GAAG,KAAK,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,EAAE,GAAG,CAAC;AACjD,CAAC;AAED;;;;;;GAMG;AACH,SAAS,sBAAsB,CAC7B,IAAkB,EAClB,GAAW,EACX,KAAwB;IAExB,IAAI,CAAC,GAAG,EAAE,CAAC;IACX,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACxB,CAAC,GAAG,GAAG,GAAG,KAAK,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC;QACnD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YACpB,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;SACd;KACF;SAAM;QACL,CAAC,GAAG,GAAG,GAAG,KAAK,KAAK,GAAG,CAAC;KACzB;IACD,OAAO,CAAC,CAAC;AACX,CAAC"}

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

@@ -10,5 +10,5 @@ export * from "./types";
 export * from "./collectionState";
 export * from "./convertCatalog";
 export * from "./filter-utils";
-export * from "./ifilter-utils";
+export * from "./serializeQueryForPortal";
 export * from "./hubSearch";

package/dist/types/search/{ifilter-utils.d.ts → serializeQueryForPortal.d.ts}

@@ -1,3 +1,8 @@
 import { ISearchOptions } from "@esri/arcgis-rest-portal";
 import { IQuery } from "./types";
+/**
+ * Serialize IQuery into ISearchOptions for ArcGIS Portal
+ * @param query
+ * @returns
+ */
 export declare function serializeQueryForPortal(query: IQuery): ISearchOptions;

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

@@ -2,8 +2,17 @@
  * Structure for Search Aggregations in ArcGIS Hub
  */
 export interface IHubAggregation {
+    /**
+     * What type of aggregation is returned
+     */
     mode: string;
+    /**
+     * Field the aggregation was creatd for
+     */
     field: string;
+    /**
+     * Array of the field values and counts
+     */
     values: Array<{
         value: any;
         count: number;

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

@@ -16,11 +16,11 @@ export interface IHubSearchOptions {
      */
     aggLimit?: number;
     /**
-     * Deprecate in favor of context
+     * Specify API to call. Defaults to ArcGIS Online Portal API
      */
     api?: NamedApis | IApiDefinition;
     /**
-     * TODO: Deprecate in requestOptions
+     * DEPRECATE in favor of requestOptions
      */
     authentication?: UserSession;
     /**
@@ -30,15 +30,16 @@ export interface IHubSearchOptions {
      * hubSearch
      */
     requestOptions?: IHubRequestOptions;
+    /**
+     * Bounding box for the search (NOT IMPLEMENTED)
+     */
     bbox?: string;
     /**
-     * Objects or fields to include
-     * e.g. `server.layers AS serverLayers`
+     * Objects or fields to include e.g. `server.layers AS serverLayers`
      */
     include?: string[];
     /**
-     * Enrichments
-     * Deprecated in favor of `include`
+     * DEPRECATED: Use `include` instead
      */
     enrichments?: Enrichments[];
     /**
@@ -46,7 +47,7 @@ export interface IHubSearchOptions {
      */
     num?: number;
     /**
-     * What page of results to return
+     * LEGACY. Use `start` and `num` instead
      */
     page?: string;
     /**
@@ -58,10 +59,19 @@ export interface IHubSearchOptions {
      */
     sortOrder?: "desc" | "asc";
     /**
-     * TODO: Determine if this is used or can be removed
+     * The result number of the first entry in the result set response. The start parameter, along with the num parameter, can be used to paginate the search results.
      */
     start?: number;
+    /**
+     * DEPRECATED
+     */
     aggregations?: string[];
+    /**
+     * DEPRECATED
+     */
     site?: IModel;
+    /**
+     * DEPRECATED
+     */
     fields?: string;
 }

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

@@ -10,10 +10,28 @@ import { IHubAggregation } from "./IHubAggregation";
  * next - invokable function for obtaining next page of results
  */
 export interface IHubSearchResponse<T> {
+    /**
+     * Total number of matches for the query
+     */
     total: number;
+    /**
+     * Array if results
+     */
     results: T[];
+    /**
+     * Can more results be fetched?
+     */
     hasNext: boolean;
+    /**
+     * Function that fetches the next page of results
+     */
     next: (params?: any) => Promise<IHubSearchResponse<T>>;
+    /**
+     * Array of requested aggregations
+     */
     aggregations?: IHubAggregation[];
+    /**
+     * DEPRECATED - hub.js no longer computes facets; consumers need to construct them from aggregations
+     */
     facets?: IFacet[];
 }

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.45.4 - Fri Jul 01 2022 18:05:06 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.45.5 - Thu Jul 07 2022 20:50:46 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -15042,24 +15042,41 @@
         return result;
     }
 
+    /**
+     * Serialize IQuery into ISearchOptions for ArcGIS Portal
+     * @param query
+     * @returns
+     */
     function serializeQueryForPortal(query) {
         var filterSearchOptions = query.filters.map(serializeFilter);
-        var result = mergeSearchOptions(filterSearchOptions, "AND");
+        // remove any empty entries
+        var nonEmptyOptions = filterSearchOptions.filter(removeEmptyEntries);
+        var result = mergeSearchOptions(nonEmptyOptions, "AND");
         return result;
     }
+    /**
+     * Predicate to remove things from array
+     * @param e
+     * @returns
+     */
+    function removeEmptyEntries(e) {
+        return !(typeof e === "undefined" || e === null || e === "");
+    }
     function mergeSearchOptions(options, operation) {
         var result = options.reduce(function (acc, entry) {
             // walk the props
             Object.entries(entry).forEach(function (_a) {
                 var key = _a[0], value = _a[1];
-                // if prop exists
-                if (acc[key]) {
+                // if prop exists and is not empty string
+                if (acc[key] && value !== "") {
                     // combine via operation
                     acc[key] = acc[key] + " " + operation + " " + value;
                 }
                 else {
-                    // just copy the value
-                    acc[key] = value;
+                    // just copy the value if it's not empty string
+                    if (value !== "") {
+                        acc[key] = value;
+                    }
                 }
             });
             return acc;
@@ -15074,7 +15091,9 @@
     function serializeFilter(filter) {
         var operation = filter.operation || "AND";
         var predicates = filter.predicates.map(expandPredicate);
-        var predicateSearchOptions = predicates.map(serializePredicate);
+        var predicateSearchOptions = predicates
+            .map(serializePredicate)
+            .filter(function (e) { return e !== undefined && e !== null; });
         // combine these searchOptions
         var searchOptions = mergeSearchOptions(predicateSearchOptions, operation);
         // wrap in parens if we have more than one predicate
@@ -15142,7 +15161,7 @@
             // not attempt to ensure the properties are used in the correct combinations
             if (portalAllowList.includes(key)) {
                 var so = { q: "" };
-                if (!specialProps.includes(key)) {
+                if (!specialProps.includes(key) && key !== "term") {
                     qCount++;
                     so.q = serializeMatchOptions(key, value);
                 }
@@ -15164,13 +15183,18 @@
                 return so;
             }
         })
-            .filter(function (e) { return e !== undefined; });
+            .filter(removeEmptyEntries);
         // merge up all the searchOptions
-        var searchOptions = mergeSearchOptions(opts, "AND");
-        if (qCount > 1) {
-            searchOptions.q = "(" + searchOptions.q + ")";
+        if (opts.length) {
+            var searchOptions = mergeSearchOptions(opts, "AND");
+            if (qCount > 1) {
+                searchOptions.q = "(" + searchOptions.q + ")";
+            }
+            return searchOptions;
+        }
+        else {
+            return null;
         }
-        return searchOptions;
     }
     /**
      * Serialize MatchOptions into portal syntax