@esri/hub-common 9.32.0 → 9.34.0

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.31.3 - Tue May 17 2022 15:35:53 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.33.0 - Fri May 20 2022 15:01:18 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -6566,6 +6566,9 @@
             case "report template":
                 family = "content";
                 break;
+            case "hub project":
+                family = "project";
+                break;
             default:
                 // by default derive from collection
                 family = collectionToFamily(getCollection(type));
@@ -6660,6 +6663,7 @@
                 "document",
                 "map",
                 "template",
+                "project",
             ];
             // default to the catchall content route
             var path = "/content";
@@ -6885,7 +6889,7 @@
      */
     var isDataSourceOfItem = function (resource, item) {
         var serviceUrl = item.url && parseServiceUrl(item.url);
-        return serviceUrl && resource.linkage.includes(serviceUrl);
+        return (serviceUrl && resource.linkage && resource.linkage.includes(serviceUrl));
     };
     /**
      * Returns the url for an additional resource.
@@ -7374,7 +7378,7 @@
     };
     // public API
     /**
-     * DEPRECATED: Compute the content type icon based on the content type
+     * Compute the content type calcite-icon based on the content type
      * @param content type
      * @returns content type icon
      */
@@ -7418,6 +7422,7 @@
             hubInitiative: "initiative",
             hubInitiativeTemplate: "initiative-template",
             hubPage: "browser",
+            hubProject: "briefcase",
             hubSiteApplication: "web",
             image: "file-image",
             imageService: "data",
@@ -7874,17 +7879,13 @@
             get orgId() {
                 // NOTE: it's undocumented, but the portal API will return orgId for items... sometimes
                 return org ? org.id : item.orgId || (ownerUser === null || ownerUser === void 0 ? void 0 : ownerUser.orgId);
-            }, 
+            }, get contentTypeIcon() {
+                /* Note: only returns calcite-icons */
+                return getContentTypeIcon(type);
+            },
             // deprecated properties
             // TODO: should we add these in legacy wrappers
             // like itemToContent or datasetToContent instead?
-            get contentTypeIcon() {
-                /* tslint:disable no-console */
-                console.warn(
-                /* tslint:enable no-console */
-                "DEPRECATED: it is now the responsibility of the consuming package to determine the icon");
-                return getContentTypeIcon(type);
-            },
             get license() {
                 /* tslint:disable no-console */
                 console.warn("DEPRECATED: use structuredLicense instead");
@@ -13141,11 +13142,12 @@
     /**
      * @private
      * Serialize a `MatchOptions` into `q` or `filter` on an `ISearchOptions`
+     * DEPRECATED: Serialization should be handled in filter-utils.ts
      * @param key
      * @param opts
      * @returns
      */
-    function serializeMatchOptions(key, opts) {
+    function serializeMatchOptions$1(key, opts) {
         var result = {
             q: "",
             filter: "",
@@ -13170,7 +13172,7 @@
             var groupFilterableFields = ["title", "typekeywords", "owner"];
             var filterableFields = __spreadArrays(userFilterableFields, itemFilterableFields, groupFilterableFields);
             if (filterableFields.includes(key)) {
-                result.filter = serializeStringOrArray("AND", key, opts.exact);
+                result.filter = serializeStringOrArray$1("AND", key, opts.exact);
             }
             else {
                 // Treat it the same as .all
@@ -13196,18 +13198,18 @@
         }
         // Handle the other props
         if (opts.any) {
-            result.q = serializeStringOrArray("OR", key, opts.any);
+            result.q = serializeStringOrArray$1("OR", key, opts.any);
         }
         if (opts.all) {
             result.q =
                 (result.q ? result.q + " AND " : "") +
-                    serializeStringOrArray("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("OR", "-" + key, opts.not);
+                    serializeStringOrArray$1("OR", "-" + key, opts.not);
         }
         return result;
     }
@@ -13218,7 +13220,7 @@
      * @param range
      * @returns
      */
-    function serializeDateRange(key, range) {
+    function serializeDateRange$1(key, range) {
         return {
             q: key + ":[" + range.from + " TO " + range.to + "]",
             filter: "",
@@ -13232,10 +13234,13 @@
      * @param value
      * @returns
      */
-    function serializeStringOrArray(join, key, value) {
+    function serializeStringOrArray$1(join, key, value) {
         var q = "";
         if (Array.isArray(value)) {
-            q = "(" + key + ":\"" + value.join("\" " + join + " " + key + ":\"") + "\")";
+            q = key + ":\"" + value.join("\" " + join + " " + key + ":\"") + "\"";
+            if (value.length > 1) {
+                q = "(" + q + ")";
+            }
         }
         else {
             q = key + ":\"" + value + "\"";
@@ -13716,11 +13721,11 @@
             var key = _a[0], value = _a[1];
             // MatchOptions may go into either q or filter
             if (!specialProps.includes(key)) {
-                result = mergeSearchOptions(result, serializeMatchOptions(key, value), "AND");
+                result = mergeSearchOptions(result, serializeMatchOptions$1(key, value), "AND");
             }
             // Dates only go into q
             if (dateProps.includes(key)) {
-                result = mergeSearchOptions(result, serializeDateRange(key, value), "AND");
+                result = mergeSearchOptions(result, serializeDateRange$1(key, value), "AND");
             }
         });
         return result;
@@ -15966,11 +15971,11 @@
             var key = _a[0], value = _a[1];
             // MatchOptions fields
             if (!specialProps.includes(key)) {
-                result = mergeSearchOptions(result, serializeMatchOptions(key, value), "AND");
+                result = mergeSearchOptions(result, serializeMatchOptions$1(key, value), "AND");
             }
             // Dates only go into q
             if (dateProps.includes(key)) {
-                result = mergeSearchOptions(result, serializeDateRange(key, value), "AND");
+                result = mergeSearchOptions(result, serializeDateRange$1(key, value), "AND");
             }
         });
         // searchUserAccess is also a top-level property
@@ -16099,11 +16104,11 @@
             var key = _a[0], value = _a[1];
             // MatchOptions fields
             if (!specialProps.includes(key)) {
-                result = mergeSearchOptions(result, serializeMatchOptions(key, value), "AND");
+                result = mergeSearchOptions(result, serializeMatchOptions$1(key, value), "AND");
             }
             // Dates only go into q
             if (dateProps.includes(key)) {
-                result = mergeSearchOptions(result, serializeDateRange(key, value), "AND");
+                result = mergeSearchOptions(result, serializeDateRange$1(key, value), "AND");
             }
         });
         // disabled is also a top-level property
@@ -16604,6 +16609,154 @@
         return catalog;
     }
 
+    /**
+     * 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"];
+        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 result = {
+            q: "",
+            filter: "",
+        };
+        result.q = filterGroups.map(serializeGroup).join(" AND ");
+        return result;
+    }
+    /**
+     * Serialize the filters in a FitlerGroup into a Portal Query
+     * @param group
+     * @returns
+     */
+    function serializeGroup(group) {
+        var operation = group.operation || "AND";
+        var filters = group.filters.map(expandFilter);
+        return filters.map(serializeFilter).join(" " + operation + " ");
+    }
+    /**
+     * Serialize a Filter into a Portal Query
+     * @param filter
+     * @returns
+     */
+    function serializeFilter(filter) {
+        var dateProps = ["created", "modified"];
+        var specialProps = __spreadArrays(["filterType", "searchUserAccess", "term"], dateProps);
+        // TODO: Look at using reduce vs .map and remove the `.filter`
+        var stringFilters = Object.entries(filter)
+            .map(function (_a) {
+            var key = _a[0], value = _a[1];
+            if (!specialProps.includes(key)) {
+                return serializeMatchOptions(key, value);
+            }
+            if (dateProps.includes(key)) {
+                return serializeDateRange(key, value);
+            }
+            if (key === "term") {
+                return value;
+            }
+        })
+            .filter(function (e) { return e !== undefined; });
+        // eslint-disable-next-line unicorn/prefer-ternary
+        if (stringFilters.length > 1) {
+            return "(" + stringFilters.join(" AND ") + ")";
+        }
+        else {
+            return stringFilters[0];
+        }
+    }
+    /**
+     * Serialize MatchOptions into portal syntax
+     * @param key
+     * @param value
+     * @returns
+     */
+    function serializeMatchOptions(key, value) {
+        var result = "";
+        if (value.any) {
+            result = "" + serializeStringOrArray("OR", key, value.any);
+        }
+        if (value.all) {
+            result =
+                (result ? result + " AND " : "") +
+                    ("" + serializeStringOrArray("AND", key, value.all));
+        }
+        if (value.not) {
+            // negate the entries if they are not
+            result =
+                (result ? result + " AND " : "") +
+                    ("" + serializeStringOrArray("OR", "-" + key, value.not));
+        }
+        // TODO HANDLE EXACT
+        return result;
+    }
+    /**
+     * Serialize a date-range into Portal syntax
+     * @param key
+     * @param range
+     * @returns
+     */
+    function serializeDateRange(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(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;
+    }
+
     /**
      * Add telemetry config object
      * @private
@@ -18487,6 +18640,7 @@
     exports.expandApi = expandApi;
     exports.expandApis = expandApis;
     exports.expandContentFilter = expandContentFilter;
+    exports.expandFilter = expandFilter;
     exports.expandGroupFilter = expandGroupFilter;
     exports.expandTypeField = expandTypeField;
     exports.expandUserFilter = expandUserFilter;
@@ -18629,12 +18783,13 @@
     exports.searchSites = searchSites;
     exports.serializeCollectionState = serializeCollectionState;
     exports.serializeContentFilterForPortal = serializeContentFilterForPortal;
-    exports.serializeDateRange = serializeDateRange;
+    exports.serializeDateRange = serializeDateRange$1;
+    exports.serializeFilterGroupsForPortal = serializeFilterGroupsForPortal;
     exports.serializeGroupFilterForPortal = serializeGroupFilterForPortal;
-    exports.serializeMatchOptions = serializeMatchOptions;
+    exports.serializeMatchOptions = serializeMatchOptions$1;
     exports.serializeModel = serializeModel;
     exports.serializeSpatialReference = serializeSpatialReference;
-    exports.serializeStringOrArray = serializeStringOrArray;
+    exports.serializeStringOrArray = serializeStringOrArray$1;
     exports.serializeUserFilterForPortal = serializeUserFilterForPortal;
     exports.setContentHubId = setContentHubId;
     exports.setContentSiteUrls = setContentSiteUrls;