@esri/hub-common 9.9.0 → 9.10.0

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.8.1 - Tue Dec 14 2021 12:30:36 GMT-0500 (Eastern Standard Time)
+ * @esri/hub-common - v9.9.0 - Wed Dec 22 2021 11:46:07 GMT-0800 (Pacific Standard Time)
  * Copyright (c) 2021 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -528,7 +528,7 @@
         var worker = target;
         var lastIdx = parts.length - 1;
         parts.forEach(function (p, idx) {
-            if (!worker.hasOwnProperty(p) || worker[p] === null) {
+            if (!worker.hasOwnProperty(p) || worker[p] == null) {
                 if (idx === lastIdx) {
                     worker[p] = value;
                 }
@@ -5169,8 +5169,8 @@
             ymax: ymax,
             // type: 'extent',
             spatialReference: {
-                wkid: wkid
-            }
+                wkid: wkid,
+            },
         };
     }
     /**
@@ -5178,7 +5178,10 @@
      * @param envelope extent
      */
     function extentToBBox(envelope) {
-        return [[envelope.xmin, envelope.ymin], [envelope.xmax, envelope.ymax]];
+        return [
+            [envelope.xmin, envelope.ymin],
+            [envelope.xmax, envelope.ymax],
+        ];
     }
     var GLOBAL_EXTENT = {
         xmin: -180,
@@ -5186,8 +5189,8 @@
         xmax: 180,
         ymax: 90,
         spatialReference: {
-            wkid: 4326
-        }
+            wkid: 4326,
+        },
     };
     /**
      * Gets the geographic extent for an org
@@ -5208,7 +5211,7 @@
         // geometry params...
         var geometryParam = {
             geometryType: "esriGeometryEnvelope",
-            geometries: [orgExtent]
+            geometries: [orgExtent],
         };
         var options = {
             httpMethod: "POST",
@@ -5218,8 +5221,8 @@
                 transformation: "",
                 inSR: orgExtent.spatialReference.wkid,
                 outSR: 4326,
-                f: "json"
-            }
+                f: "json",
+            },
         };
         // add in auth if it's passed
         if (hubRequestOptions.authentication) {
@@ -5234,8 +5237,8 @@
                 xmax: geom.xmax,
                 ymax: geom.ymax,
                 spatialReference: {
-                    wkid: 4326
-                }
+                    wkid: 4326,
+                },
             };
         })
             .catch(function (ex) {
@@ -5251,10 +5254,21 @@
             return extentToBBox(extent);
         });
     }
-    function isExtentCoordinateArray(extent) {
+    /**
+     * checks if the extent is a valid BBox (2 element array of coordinate pair arrays)
+     * @param extent
+     * @returns
+     */
+    var isBBox = function (extent) {
         return (Array.isArray(extent) &&
             Array.isArray(extent[0]) &&
             Array.isArray(extent[1]));
+    };
+    function isExtentCoordinateArray(extent) {
+        /* tslint:disable no-console */
+        console.warn("DEPRECATED: use isBBox() instead");
+        /* tslint:enable no-console */
+        return isBBox(extent);
     }
     function isExtentJSON(extent) {
         return ["xmin", "ymin", "xmax", "ymax"].every(function (key) { return typeof extent[key] === "number"; });
@@ -5268,6 +5282,25 @@
         return (!!extent &&
             [isExtentCoordinateArray, isExtentJSON].some(function (test) { return test(extent); }));
     }
+    var bBoxToPolygon = function (bBox) {
+        var _a = bBox[0], xmin = _a[0], ymin = _a[1], _b = bBox[1], xmax = _b[0], ymax = _b[1];
+        var rings = [
+            [
+                [xmin, ymin],
+                [xmax, ymin],
+                [xmax, ymax],
+                [xmin, ymax],
+                [xmin, ymin],
+            ],
+        ];
+        var wkid = 4326;
+        return {
+            rings: rings,
+            spatialReference: {
+                wkid: wkid,
+            },
+        };
+    };
 
     var STANDARD_LICENSES = [
         {
@@ -5564,6 +5597,56 @@
         return isSingleAnchorTagRegex.test(rawLicense);
     }
 
+    /**
+     * Use this module for functions that do not need to be used by consumers (yet),
+     * but may be shared between hub.js modules, and/or need to be tested
+     * to get 100% coverage w/o writing cumbersome tests of higher level functions.
+     *
+     * Consuming will not be able to import these functions.
+     *
+     * It's probably a good pattern to add functions here first and then
+     * move them to index.ts only when they are needed by a consumer.
+     */
+    /**
+     * Create a new content with updated extent and derived properties like boundary
+     * @param content original content
+     * @param extent new extent
+     * @returns a new content with the updated extent and boundary
+     */
+    var setContentExtent = function (content, extent) {
+        // update content's item and extent
+        var item = __assign(__assign({}, content.item), { extent: extent });
+        var updated = __assign(__assign({}, content), { item: item, extent: extent });
+        // derive boundary from content properties
+        var boundary = getContentBoundary(updated);
+        return __assign(__assign({}, updated), { boundary: boundary });
+    };
+    var getContentBoundary = function (content) {
+        var _a;
+        var item = content.item;
+        var extent = item.extent;
+        var isValidItemExtent = isBBox(extent);
+        // user specified provenance is stored in item.properties
+        var provenance = ((_a = item.properties) === null || _a === void 0 ? void 0 : _a.boundary) ||
+            // but we default to item if the item has an extent
+            (isValidItemExtent ? "item" : undefined);
+        var geometry;
+        switch (provenance) {
+            case "item":
+                geometry = isValidItemExtent ? bBoxToPolygon(extent) : null;
+                break;
+            case "none":
+                geometry = null;
+                break;
+            // TODO: handle other provenances
+        }
+        // TODO: derive and return center
+        return {
+            provenance: provenance,
+            geometry: geometry,
+        };
+    };
+
     function collectionToFamily(collection) {
         var overrides = {
             other: "content",
@@ -5571,13 +5654,6 @@
         };
         return overrides[collection] || collection;
     }
-    function itemExtentToBoundary(extent) {
-        return (extent &&
-            extent.length && {
-            // TODO: center?
-            geometry: createExtent(extent[0][0], extent[0][1], extent[1][0], extent[1][1]),
-        });
-    }
     var cache = {};
     // TODO: remove this at next breaking version
     /**
@@ -5977,7 +6053,6 @@
             metrics: properties && properties.metrics,
             isDownloadable: isDownloadable(item),
             // default boundary from item.extent
-            boundary: itemExtentToBoundary(item.extent),
             license: { name: "Custom License", description: item.accessInformation },
             // dates and sources we will enrich these later...
             createdDate: createdDate,
@@ -5988,7 +6063,7 @@
             updatedDateSource: "item.modified",
             structuredLicense: getStructuredLicense(item.licenseInfo),
         });
-        return setContentType(content, item.type);
+        return setContentExtent(setContentType(content, item.type), item.extent);
     }
     /**
      * Convert a Hub API dataset resource to Hub Content
@@ -6031,9 +6106,7 @@
         content.errors = errors;
         // common enrichments
         content.boundary = boundary;
-        if (!isExtentCoordinateArray(item.extent) &&
-            extent &&
-            isExtentCoordinateArray(extent.coordinates)) {
+        if (!isBBox(item.extent) && extent && isBBox(extent.coordinates)) {
             // we fall back to the extent derived by the API
             // which prefers layer or service extents and ultimately
             // falls back to the org's extent
@@ -6189,6 +6262,7 @@
         // get family and normalized type based on new type
         var normalizedType = normalizeItemType(__assign(__assign({}, content.item), { type: type }));
         var family = getFamily(normalizedType);
+        // TODO: don't we need to update content.item.type too?
         var updated = __assign(__assign({}, content), { type: type, family: family, normalizedType: normalizedType });
         // update the relative URL to the content
         // which is based on type and family
@@ -10735,6 +10809,7 @@
     exports.arrayToObject = arrayToObject;
     exports.atob = abab.atob;
     exports.autoAddUsers = autoAddUsers;
+    exports.bBoxToPolygon = bBoxToPolygon;
     exports.batch = batch;
     exports.btoa = abab.btoa;
     exports.buildDraft = buildDraft;
@@ -10850,6 +10925,7 @@
     exports.interpolate = interpolate;
     exports.interpolateItemId = interpolateItemId;
     exports.inviteUsers = inviteUsers;
+    exports.isBBox = isBBox;
     exports.isDomainForLegacySite = isDomainForLegacySite;
     exports.isDomainUsedElsewhere = isDomainUsedElsewhere;
     exports.isDownloadable = isDownloadable;