@esri/hub-common 9.45.2 → 9.45.3

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.45.1 - Tue Jun 28 2022 21:02:08 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.45.2 - Thu Jun 30 2022 13:33:18 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -13548,7 +13548,7 @@
      * @param join
      * @returns
      */
-    function mergeSearchOptions$2(so1, so2, join) {
+    function mergeSearchOptions$1(so1, so2, join) {
         // TODO: Remove with _searchContent
         Logger.warn("DEPRECATION: mergeSearchOptions will be removed. Work with IFilterGroups<\"group\"> and hubSearch() instead");
         var result = cloneObject$1(so1);
@@ -13569,7 +13569,7 @@
      * @param opts
      * @returns
      */
-    function serializeMatchOptions$2(key, opts) {
+    function serializeMatchOptions$1(key, opts) {
         var result = {
             q: "",
             filter: "",
@@ -13594,7 +13594,7 @@
             var groupFilterableFields = ["title", "typekeywords", "owner"];
             var filterableFields = __spreadArrays(userFilterableFields, itemFilterableFields, groupFilterableFields);
             if (filterableFields.includes(key)) {
-                result.filter = serializeStringOrArray$2("AND", key, opts.exact);
+                result.filter = serializeStringOrArray$1("AND", key, opts.exact);
             }
             else {
                 // Treat it the same as .all
@@ -13620,18 +13620,18 @@
         }
         // Handle the other props
         if (opts.any) {
-            result.q = serializeStringOrArray$2("OR", key, opts.any);
+            result.q = serializeStringOrArray$1("OR", key, opts.any);
         }
         if (opts.all) {
             result.q =
                 (result.q ? result.q + " AND " : "") +
-                    serializeStringOrArray$2("AND", key, opts.all);
+                    serializeStringOrArray$1("AND", key, opts.all);
         }
         if (opts.not) {
             // negate the entries if they are not
             result.q =
                 (result.q ? result.q + " AND " : "") +
-                    serializeStringOrArray$2("OR", "-" + key, opts.not);
+                    serializeStringOrArray$1("OR", "-" + key, opts.not);
         }
         return result;
     }
@@ -13642,7 +13642,7 @@
      * @param range
      * @returns
      */
-    function serializeDateRange$2(key, range) {
+    function serializeDateRange$1(key, range) {
         return {
             q: key + ":[" + range.from + " TO " + range.to + "]",
             filter: "",
@@ -13656,7 +13656,7 @@
      * @param value
      * @returns
      */
-    function serializeStringOrArray$2(join, key, value) {
+    function serializeStringOrArray$1(join, key, value) {
         var q = "";
         if (Array.isArray(value)) {
             q = key + ":\"" + value.join("\" " + join + " " + key + ":\"") + "\"";
@@ -14043,7 +14043,7 @@
                     if (isWellKnownType(entry)) {
                         // working with dynamic objects in typescript requires some assertions
                         var key = entry;
-                        clone.subFilters = clone.subFilters.concat(lookupTypeFilters$1(key));
+                        clone.subFilters = clone.subFilters.concat(lookupTypeFilters(key));
                     }
                     else {
                         acc.push(entry);
@@ -14053,7 +14053,7 @@
             }
             else if (isWellKnownType(clone.type)) {
                 var key = clone.type;
-                clone.subFilters = clone.subFilters.concat(lookupTypeFilters$1(key));
+                clone.subFilters = clone.subFilters.concat(lookupTypeFilters(key));
                 delete clone.type;
             }
             else ;
@@ -14076,7 +14076,7 @@
         }
         return result;
     }
-    function lookupTypeFilters$1(key) {
+    function lookupTypeFilters(key) {
         return ContentFilterExpansions[key];
     }
     /**
@@ -14144,12 +14144,12 @@
                 // from hitting the else
                 /* istanbul ignore else */
                 if (typeof entry === "object") {
-                    acc = mergeSearchOptions$2(acc, convertContentFilterToSearchOptions(entry), "OR");
+                    acc = mergeSearchOptions$1(acc, convertContentFilterToSearchOptions(entry), "OR");
                 }
                 return acc;
             }, { q: "", filter: "" });
             // merge with searchOptions using AND
-            searchOptions = mergeSearchOptions$2(searchOptions, subFilterOptions, "AND");
+            searchOptions = mergeSearchOptions$1(searchOptions, subFilterOptions, "AND");
         }
         // term is always last, and pre-pended on searchOptions.q
         if (filter.term) {
@@ -14177,11 +14177,11 @@
             var key = _a[0], value = _a[1];
             // MatchOptions may go into either q or filter
             if (!specialProps.includes(key)) {
-                result = mergeSearchOptions$2(result, serializeMatchOptions$2(key, value), "AND");
+                result = mergeSearchOptions$1(result, serializeMatchOptions$1(key, value), "AND");
             }
             // Dates only go into q
             if (dateProps.includes(key)) {
-                result = mergeSearchOptions$2(result, serializeDateRange$2(key, value), "AND");
+                result = mergeSearchOptions$1(result, serializeDateRange$1(key, value), "AND");
             }
         });
         return result;
@@ -14312,11 +14312,11 @@
             var key = _a[0], value = _a[1];
             // MatchOptions fields
             if (!specialProps.includes(key)) {
-                result = mergeSearchOptions$2(result, serializeMatchOptions$2(key, value), "AND");
+                result = mergeSearchOptions$1(result, serializeMatchOptions$1(key, value), "AND");
             }
             // Dates only go into q
             if (dateProps.includes(key)) {
-                result = mergeSearchOptions$2(result, serializeDateRange$2(key, value), "AND");
+                result = mergeSearchOptions$1(result, serializeDateRange$1(key, value), "AND");
             }
         });
         // searchUserAccess is also a top-level property
@@ -14452,11 +14452,11 @@
             var key = _a[0], value = _a[1];
             // MatchOptions fields
             if (!specialProps.includes(key)) {
-                result = mergeSearchOptions$2(result, serializeMatchOptions$2(key, value), "AND");
+                result = mergeSearchOptions$1(result, serializeMatchOptions$1(key, value), "AND");
             }
             // Dates only go into q
             if (dateProps.includes(key)) {
-                result = mergeSearchOptions$2(result, serializeDateRange$2(key, value), "AND");
+                result = mergeSearchOptions$1(result, serializeDateRange$1(key, value), "AND");
             }
         });
         // disabled is also a top-level property
@@ -14975,200 +14975,6 @@
         return catalog;
     }
 
-    // DEPRECATED - REMOVE THIS FILE
-    /**
-     * Expand a Filter into it's more expressive structure so it can be
-     * serialized deterministically.
-     *
-     * Props with type `string | string[] | MatchOptions` expand into `IMatchOptions`
-     * Props relative-dates are expanded into formal date-ranges
-     * @param filter
-     * @returns
-     */
-    function expandFilter(filter) {
-        var result = {};
-        var dateProps = ["created", "modified", "lastlogin"];
-        var copyProps = [
-            "filterType",
-            "term",
-            "searchUserAccess",
-            "isopendata",
-            "searchUserName",
-        ];
-        var nonMatchOptionsFields = __spreadArrays(dateProps, copyProps);
-        // Do the conversion
-        Object.entries(filter).forEach(function (_a) {
-            var key = _a[0], value = _a[1];
-            // Handle MatchOptions fields
-            if (!nonMatchOptionsFields.includes(key)) {
-                // setProp side-steps typescript complaining
-                setProp(key, valueToMatchOptions(value), result);
-            }
-            // Handle Date fields
-            if (dateProps.includes(key)) {
-                var dateFieldValue = cloneObject$1(getProp(filter, key));
-                if (getProp(filter, key + ".type") === "relative-date") {
-                    setProp(key, relativeDateToDateRange(dateFieldValue), result);
-                }
-                else {
-                    setProp(key, dateFieldValue, result);
-                }
-            }
-            // Handle fields that are just copied forward
-            if (copyProps.includes(key) && filter.hasOwnProperty(key)) {
-                setProp(key, value, result);
-            }
-        });
-        return result;
-    }
-    /**
-     * Serialize a FilterGroup of any type for Portal
-     * @param filterGroups
-     * @returns
-     */
-    function serializeFilterGroupsForPortal(filterGroups) {
-        var groupSearchOptions = filterGroups.map(serializeGroup);
-        var result = mergeSearchOptions$1(groupSearchOptions, "AND");
-        return result;
-    }
-    /**
-     * Serialize the filters in a FitlerGroup into a Portal Query
-     * @param filterGroup
-     * @returns
-     */
-    function serializeGroup(filterGroup) {
-        var operation = filterGroup.operation || "AND";
-        var filters = filterGroup.filters.map(expandFilter);
-        var filterSearchOptions = filters.map(serializeFilter$1);
-        // combine these searchOptions
-        var groupSearchOptions = mergeSearchOptions$1(filterSearchOptions, operation);
-        //
-        if (filters.length > 1) {
-            groupSearchOptions.q = "(" + groupSearchOptions.q + ")";
-        }
-        return groupSearchOptions;
-    }
-    /**
-     * Serialize a Filter into a Portal Query
-     * @param filter
-     * @returns
-     */
-    function serializeFilter$1(filter) {
-        var dateProps = ["created", "modified"];
-        var boolProps = ["isopendata"];
-        var passThroughProps = ["searchUserAccess", "searchUserName"];
-        var specialProps = __spreadArrays([
-            "filterType",
-            "term"
-        ], dateProps, boolProps, passThroughProps);
-        var qCount = 0;
-        // TODO: Look at using reduce vs .map and remove the `.filter`
-        var opts = Object.entries(filter)
-            .map(function (_a) {
-            var key = _a[0], value = _a[1];
-            var so = { q: "" };
-            if (!specialProps.includes(key)) {
-                qCount++;
-                so.q = serializeMatchOptions$1(key, value);
-            }
-            if (dateProps.includes(key)) {
-                qCount++;
-                so.q = serializeDateRange$1(key, value);
-            }
-            if (boolProps.includes(key)) {
-                qCount++;
-                so.q = key + ":" + value;
-            }
-            if (passThroughProps.includes(key)) {
-                so[key] = value;
-            }
-            if (key === "term") {
-                qCount++;
-                so.q = value;
-            }
-            return so;
-        })
-            .filter(function (e) { return e !== undefined; });
-        // merge up all the searchOptions
-        var searchOptions = mergeSearchOptions$1(opts, "AND");
-        if (qCount > 1) {
-            searchOptions.q = "(" + searchOptions.q + ")";
-        }
-        return searchOptions;
-    }
-    function mergeSearchOptions$1(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]) {
-                    // combine via operation
-                    acc[key] = acc[key] + " " + operation + " " + value;
-                }
-                else {
-                    // just copy the value
-                    acc[key] = value;
-                }
-            });
-            return acc;
-        }, { q: "" });
-        return result;
-    }
-    /**
-     * Serialize MatchOptions into portal syntax
-     * @param key
-     * @param value
-     * @returns
-     */
-    function serializeMatchOptions$1(key, value) {
-        var result = "";
-        if (value.any) {
-            result = "" + serializeStringOrArray$1("OR", key, value.any);
-        }
-        if (value.all) {
-            result =
-                (result ? result + " AND " : "") +
-                    ("" + serializeStringOrArray$1("AND", key, value.all));
-        }
-        if (value.not) {
-            // negate the entries if they are not
-            result =
-                (result ? result + " AND " : "") +
-                    ("" + serializeStringOrArray$1("OR", "-" + key, value.not));
-        }
-        // TODO HANDLE EXACT
-        return result;
-    }
-    /**
-     * Serialize a date-range into Portal syntax
-     * @param key
-     * @param range
-     * @returns
-     */
-    function serializeDateRange$1(key, range) {
-        return key + ":[" + range.from + " TO " + range.to + "]";
-    }
-    /**
-     * Serialize a `string` or `string[]` into a string
-     * @param join
-     * @param key
-     * @param value
-     * @returns
-     */
-    function serializeStringOrArray$1(join, key, value) {
-        var q = "";
-        if (Array.isArray(value)) {
-            q = key + ":\"" + value.join("\" " + join + " " + key + ":\"") + "\"";
-            if (value.length > 1) {
-                q = "(" + q + ")";
-            }
-        }
-        else {
-            q = key + ":\"" + value + "\"";
-        }
-        return q;
-    }
     /**
      * Determine if a Filter is "empty"
      * @param filter
@@ -18089,56 +17895,6 @@
         }
     }
 
-    /**
-     * @private
-     * DEPRECATED
-     * @param filterGroups
-     * @param options
-     * @returns
-     */
-    function portalSearchItemsFilterGroups(filterGroups, options) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function () {
-            var replaced, expandedGroups, so, props;
-            return __generator(this, function (_b) {
-                if (!options.requestOptions) {
-                    throw new HubError$1("hubSearch", "requestOptions: IHubRequestOptions is required.");
-                }
-                replaced = applyWellKnownItemFilterGroups(filterGroups);
-                expandedGroups = replaced.map(function (fg) {
-                    fg.filters = fg.filters.map(expandFilter);
-                    return fg;
-                });
-                so = serializeFilterGroupsForPortal(expandedGroups);
-                props = [
-                    "num",
-                    "sortField",
-                    "sortOrder",
-                    "include",
-                    "start",
-                    "requestOptions",
-                ];
-                // copy the props over
-                props.forEach(function (prop) {
-                    if (options.hasOwnProperty(prop)) {
-                        so[prop] = options[prop];
-                    }
-                });
-                if (options.requestOptions.authentication) {
-                    so.authentication = options.requestOptions.authentication;
-                }
-                else {
-                    so.portal = options.requestOptions.portal;
-                }
-                // Aggregations
-                if ((_a = options.aggFields) === null || _a === void 0 ? void 0 : _a.length) {
-                    so.countFields = options.aggFields.join(",");
-                    so.countSize = options.aggLimit || 10;
-                }
-                return [2 /*return*/, searchPortal$2(so)];
-            });
-        });
-    }
     /**
      * @private
      * Portal Search Implementation for Items
@@ -18456,39 +18212,6 @@
         });
         return queryClone;
     }
-    /**
-     * DEPRECATED
-     * @param filterGroups
-     * @returns
-     */
-    function applyWellKnownItemFilterGroups(filterGroups) {
-        var clone = cloneObject$1(filterGroups);
-        // iterate the filterGroups
-        var result = clone.map(function (filterGroup) {
-            filterGroup.filters = filterGroup.filters.reduce(function (updated, filter) {
-                // check if the filter.type is a well-known type
-                if (isWellKnownTypeFilter(filter.type)) {
-                    // get the set of filters to replace the current filter with
-                    var typeFilters = lookupTypeFilters(filter.type);
-                    // Note: At this point we could try to "merge" in the other
-                    // props on the filter, into all the filters returned from
-                    // the well-known hash. The problem with this is that the
-                    // combination may yield unexpected results; For now, if a filter
-                    // includes `.type is keyof WellKnownItemFilters` we simply
-                    // replace the entire filter with the array of filters returne
-                    // from the hash
-                    updated = __spreadArrays(updated, typeFilters);
-                }
-                else {
-                    // filter does not have a well-known type entry so keep it
-                    updated.push(filter);
-                }
-                return updated;
-            }, []);
-            return filterGroup;
-        });
-        return result;
-    }
     /**
      * Is the argument a well-known type "key"
      *
@@ -18506,13 +18229,10 @@
         return result;
     }
     /**
-     * Fetch the array of fitlers from the well-known hash
+     * Return the predicates for a well-known type
      * @param key
      * @returns
      */
-    function lookupTypeFilters(key) {
-        return WellKnownItemFilters[key];
-    }
     function lookupTypePredicates(key) {
         var rawPredicates = WellKnownItemFilters[key];
         // Remove the filterType property as it's not needed in an IPredicate
@@ -18724,61 +18444,6 @@
         return result;
     }
 
-    /**
-     * @private
-     * DEPRECATED: Use `portalSerchGroups`
-     * Portal Search Implementation for Groups
-     * @param filterGroups
-     * @param options
-     * @returns
-     */
-    function portalSearchGroupsFilterGroups(filterGroups, options) {
-        return __awaiter(this, void 0, void 0, function () {
-            var api, expandedGroups, so, props;
-            return __generator(this, function (_a) {
-                api = expandApi(options.api || "arcgis");
-                if (!options.requestOptions) {
-                    if (options.authentication) {
-                        // create minimal requestOptions
-                        options.requestOptions = {
-                            authentication: options.authentication,
-                            portal: options.authentication.portal,
-                        };
-                    }
-                    else {
-                        options.requestOptions = {
-                            portal: api.url + "/sharing/rest",
-                        };
-                    }
-                }
-                expandedGroups = filterGroups.map(function (fg) {
-                    fg.filters = fg.filters.map(expandFilter);
-                    return fg;
-                });
-                so = serializeFilterGroupsForPortal(expandedGroups);
-                props = [
-                    "authentication",
-                    "num",
-                    "sortField",
-                    "sortOrder",
-                    "include",
-                    "start",
-                    "requestOptions",
-                ];
-                // copy the props over
-                props.forEach(function (prop) {
-                    if (options.hasOwnProperty(prop)) {
-                        so[prop] = options[prop];
-                    }
-                });
-                // If we don't have auth, ensure we have .portal
-                if (!so.authentication) {
-                    so.portal = so.requestOptions.portal || api.url + "/sharing/rest";
-                }
-                return [2 /*return*/, searchPortal$1(so)];
-            });
-        });
-    }
     /**
      * @private
      * Portal Search Implementation for Groups
@@ -18879,50 +18544,6 @@
         });
     }
 
-    /**
-     * @private
-     * DEPRECATED: Use `portalSearchUsers`
-     * Portal Search implementation for Users
-     * @param filterGroups
-     * @param options
-     */
-    function portalSearchUsersFilterGroups(filterGroups, options) {
-        return __awaiter(this, void 0, void 0, function () {
-            var expandedGroups, so, props;
-            return __generator(this, function (_a) {
-                // requestOptions is always required and user must be authd
-                if (!options.requestOptions) {
-                    throw new HubError$1("portalSearchUsers", "requestOptions: IHubRequestOptions is required.");
-                }
-                if (!options.requestOptions.authentication) {
-                    throw new HubError$1("portalSearchUsers", "requestOptions must pass authentication.");
-                }
-                expandedGroups = filterGroups.map(function (fg) {
-                    fg.filters = fg.filters.map(expandFilter);
-                    return fg;
-                });
-                so = serializeFilterGroupsForPortal(expandedGroups);
-                props = [
-                    "num",
-                    "sortField",
-                    "sortOrder",
-                    "include",
-                    "start",
-                    "requestOptions",
-                ];
-                // copy the props over
-                props.forEach(function (prop) {
-                    if (options.hasOwnProperty(prop)) {
-                        so[prop] = options[prop];
-                    }
-                });
-                // Ensure authentication gets sent
-                so.authentication = options.requestOptions.authentication;
-                // Execute search
-                return [2 /*return*/, searchPortal(so)];
-            });
-        });
-    }
     /**
      * @private
      * Portal Search Implementation for Users
@@ -19025,7 +18646,10 @@
     }
 
     /**
-     * Main Search function for ArcGIS Hub
+     * @private
+     * TEMPORARY - this function only exists to allow incremental
+     * changes and should be removed as soon as arcgis-hub-gallery
+     * is changed to call `hubSearch(...)` directly
      *
      * Default's to search ArcGIS Portal but can delegate
      * to Hub API when it's available.
@@ -19033,41 +18657,11 @@
      * @param options
      * @returns
      */
-    function hubSearch(filterGroups, options) {
+    function hubSearchQuery(query, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var filterType, apiType, fnHash, fn;
             return __generator(this, function (_a) {
-                // Validate inputs
-                if (!filterGroups || !Array.isArray(filterGroups)) {
-                    throw new HubError$1("hubSearch", "FilterGroups are required and must be an array.");
-                }
-                if (!filterGroups.length) {
-                    throw new HubError$1("hubSearch", "FilterGrous array must contain at least one entry.");
-                }
-                if (!options.requestOptions) {
-                    throw new HubError$1("hubSearch", "requestOptions: IHubRequestOptions is required.");
-                }
-                // Ensure includes is an array
-                if (!options.include) {
-                    options.include = [];
-                }
-                filterType = filterGroups[0].filterType;
-                apiType = expandApi(options.api || "arcgis").type;
-                fnHash = {
-                    arcgis: {
-                        item: portalSearchItemsFilterGroups,
-                        group: portalSearchGroupsFilterGroups,
-                        user: portalSearchUsersFilterGroups,
-                    },
-                    "arcgis-hub": {
-                        item: hubSearchItems,
-                    },
-                };
-                fn = getProp(fnHash, apiType + "." + filterType);
-                if (!fn) {
-                    throw new HubError$1("hubSearch", "Search via \"" + filterType + "\" filter against \"" + apiType + "\" api is not implemented");
-                }
-                return [2 /*return*/, fn(cloneObject$1(filterGroups), options)];
+                // delegate
+                return [2 /*return*/, hubSearch(query, options)];
             });
         });
     }
@@ -19080,7 +18674,7 @@
      * @param options
      * @returns
      */
-    function hubSearchQuery(query, options) {
+    function hubSearch(query, options) {
         return __awaiter(this, void 0, void 0, function () {
             var filterType, apiType, fnHash, fn;
             return __generator(this, function (_a) {
@@ -20861,7 +20455,6 @@
     exports.expandApi = expandApi;
     exports.expandApis = expandApis;
     exports.expandContentFilter = expandContentFilter;
-    exports.expandFilter = expandFilter;
     exports.expandGroupFilter = expandGroupFilter;
     exports.expandTypeField = expandTypeField;
     exports.expandUserFilter = expandUserFilter;
@@ -20988,7 +20581,7 @@
     exports.mergeGroupFilters = mergeGroupFilters;
     exports.mergeMatchOptions = mergeMatchOptions;
     exports.mergeObjects = mergeObjects;
-    exports.mergeSearchOptions = mergeSearchOptions$2;
+    exports.mergeSearchOptions = mergeSearchOptions$1;
     exports.mergeUserFilters = mergeUserFilters;
     exports.normalizeItemType = normalizeItemType;
     exports.normalizeSolutionTemplateItem = normalizeSolutionTemplateItem;
@@ -21013,13 +20606,12 @@
     exports.searchSites = searchSites;
     exports.serializeCollectionState = serializeCollectionState;
     exports.serializeContentFilterForPortal = serializeContentFilterForPortal;
-    exports.serializeDateRange = serializeDateRange$2;
-    exports.serializeFilterGroupsForPortal = serializeFilterGroupsForPortal;
+    exports.serializeDateRange = serializeDateRange$1;
     exports.serializeGroupFilterForPortal = serializeGroupFilterForPortal;
-    exports.serializeMatchOptions = serializeMatchOptions$2;
+    exports.serializeMatchOptions = serializeMatchOptions$1;
     exports.serializeModel = serializeModel;
     exports.serializeSpatialReference = serializeSpatialReference;
-    exports.serializeStringOrArray = serializeStringOrArray$2;
+    exports.serializeStringOrArray = serializeStringOrArray$1;
     exports.serializeUserFilterForPortal = serializeUserFilterForPortal;
     exports.setContentHubId = setContentHubId;
     exports.setContentSiteUrls = setContentSiteUrls;