@esri/hub-common 9.36.0 → 9.37.0

package/dist/types/types.d.ts

@@ -1,4 +1,4 @@
-import { IItem, IUser, IGroup, IGeometry } from "@esri/arcgis-rest-types";
+import { IItem, IUser, IGroup, IPolygon, ISpatialReference, IGeometry } from "@esri/arcgis-rest-types";
 import { IPortal, ISearchResult } from "@esri/arcgis-rest-portal";
 import { UserSession } from "@esri/arcgis-rest-auth";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
@@ -144,6 +144,15 @@ export declare type Visibility = "private" | "org" | "public";
  */
 export declare type AccessControl = "view" | "edit" | "admin";
 export declare type GeographyProvenance = "item" | "none" | "automatic";
+/**
+ * properties to be used with the ArcGIS API geometry class constructors
+ */
+export interface IGeometryProperties extends IGeometry {
+    type: string;
+}
+export interface IPolygonProperties extends IPolygon, IGeometryProperties {
+    type: "polygon";
+}
 /**
  * Location of a Hub resource
  *
@@ -152,8 +161,9 @@ export declare type GeographyProvenance = "item" | "none" | "automatic";
  */
 export interface IHubGeography {
     center?: [number, number];
-    geometry?: IGeometry;
+    geometry?: IPolygonProperties;
     provenance?: GeographyProvenance;
+    spatialReference?: ISpatialReference;
 }
 export declare type SearchableType = IItem | IGroup | IUser;
 export declare type SearchFunction = (...args: any[]) => Promise<ISearchResult<SearchableType>>;

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.35.0 - Tue May 24 2022 13:04:14 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.36.0 - Thu May 26 2022 14:42:32 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -6388,6 +6388,15 @@
         return request(cleanUrl(options.url), options);
     }
 
+    /**
+     * Turns an bounding box coordinate array into an extent object
+     * @param bBox bounding box coordinate array
+     * @returns extent object
+     */
+    var bBoxToExtent = function (bBox) {
+        var _a = bBox[0], xmin = _a[0], ymin = _a[1], _b = bBox[1], xmax = _b[0], ymax = _b[1];
+        return createExtent(xmin, ymin, xmax, ymax);
+    };
     function createExtent(xmin, ymin, xmax, ymax, wkid) {
         if (wkid === void 0) { wkid = 4326; }
         return {
@@ -6402,13 +6411,13 @@
         };
     }
     /**
-     * Turns an extent into a bbox
-     * @param envelope extent
+     * Turns an extent object into a bounding box coordinate array
+     * @param extent extent
      */
-    function extentToBBox(envelope) {
+    function extentToBBox(extent) {
         return [
-            [envelope.xmin, envelope.ymin],
-            [envelope.xmax, envelope.ymax],
+            [extent.xmin, extent.ymin],
+            [extent.xmax, extent.ymax],
         ];
     }
     var GLOBAL_EXTENT = {
@@ -6510,25 +6519,44 @@
         return (!!extent &&
             [isExtentCoordinateArray, isExtentJSON].some(function (test) { return test(extent); }));
     }
+    /* istanbul ignore next DEPRECATED, remove at next breaking change */
     var bBoxToPolygon = function (bBox) {
-        var _a = bBox[0], xmin = _a[0], ymin = _a[1], _b = bBox[1], xmax = _b[0], ymax = _b[1];
+        /* tslint:disable no-console */
+        console.warn("DEPRECATED: use extentToPolygon(bBoxToExtent(bBox)) instead");
+        return extentToPolygon(bBoxToExtent(bBox));
+    };
+    /**
+     * Convert an extent object into a polygon object
+     * @param extent
+     * @returns
+     */
+    var extentToPolygon = function (extent) {
+        var xmin = extent.xmin, ymin = extent.ymin, xmax = extent.xmax, ymax = extent.ymax, spatialReference = extent.spatialReference;
         var rings = [
             [
-                [xmin, ymin],
-                [xmax, ymin],
-                [xmax, ymax],
                 [xmin, ymax],
+                [xmax, ymax],
+                [xmax, ymin],
                 [xmin, ymin],
+                [xmin, ymax],
             ],
         ];
-        var wkid = 4326;
         return {
             rings: rings,
-            spatialReference: {
-                wkid: wkid,
-            },
+            spatialReference: spatialReference,
         };
     };
+    /**
+     * Get the center of an extent as a point
+     * @param extent
+     * @returns
+     */
+    var getExtentCenter = function (extent) {
+        var xmin = extent.xmin, ymin = extent.ymin, xmax = extent.xmax, ymax = extent.ymax, spatialReference = extent.spatialReference;
+        var x = (xmax - xmin) / 2 + xmin;
+        var y = (ymax - ymin) / 2 + ymin;
+        return { x: x, y: y, spatialReference: spatialReference };
+    };
 
     // private helper functions
     function collectionToFamily(collection) {
@@ -6582,30 +6610,26 @@
      * @returns
      * @private
      */
-    // TODO: this needs to be able to handle "automatic"
     var getContentBoundary = function (item) {
         var _a;
-        var extent = item.extent;
-        var isValidItemExtent = isBBox(extent);
+        var bBox = item.extent;
+        var isValidItemExtent = isBBox(bBox);
         // 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 {
+        var boundary = {
+            geometry: null,
             provenance: provenance,
-            geometry: geometry,
         };
+        if (provenance === "item" && isValidItemExtent) {
+            var extent = bBoxToExtent(bBox);
+            var center = getExtentCenter(extent);
+            boundary.center = [center.x, center.y];
+            boundary.geometry = __assign(__assign({}, extentToPolygon(extent)), { type: "polygon" });
+            boundary.spatialReference = boundary.geometry.spatialReference;
+        }
+        return boundary;
     };
     /**
      * Determine if we are in an enterprise environment
@@ -7785,14 +7809,14 @@
             },
             get extent() {
                 return determineExtent(item, extent, layer);
-            },
+            }, 
             // would require us to do client-side projection of server/layer extent
             get boundary() {
-                // TODO: need to be able to handle automatic w/ additional enrichment
-                // that could for example fetch the concave hull from the Hub API or resources
-                return boundary || getContentBoundary(item);
-            },
-            get summary() {
+                // NOTE: the boundary from the Hub API will be undefined if item.properties.boundary === 'none'
+                return (boundary === null || boundary === void 0 ? void 0 : boundary.provenance) === "automatic"
+                    ? boundary
+                    : getContentBoundary(item);
+            }, get summary() {
                 return (searchDescription ||
                     // TODO: this should use the logic for the Hub API's searchDescription
                     // see: https://github.com/ArcGIS/hub-indexer/blob/b352cfded8221a967ac80447879d493db6476d7a/packages/duke/compose/dataset.js#L238-L250
@@ -18592,6 +18616,7 @@
     exports.arrayToObject = arrayToObject;
     exports.atob = abab.atob;
     exports.autoAddUsers = autoAddUsers;
+    exports.bBoxToExtent = bBoxToExtent;
     exports.bBoxToPolygon = bBoxToPolygon;
     exports.batch = batch;
     exports.btoa = abab.btoa;
@@ -18656,6 +18681,7 @@
     exports.expandUserFilter = expandUserFilter;
     exports.extend = extend;
     exports.extentToBBox = extentToBBox;
+    exports.extentToPolygon = extentToPolygon;
     exports.failSafe = failSafe;
     exports.failSafeUpdate = failSafeUpdate;
     exports.fetchAllPages = fetchAllPages;
@@ -18682,6 +18708,7 @@
     exports.getDomainsForSite = getDomainsForSite;
     exports.getExportItemTypeKeyword = getExportItemTypeKeyword;
     exports.getExportLayerTypeKeyword = getExportLayerTypeKeyword;
+    exports.getExtentCenter = getExtentCenter;
     exports.getFamily = getFamily;
     exports.getGeographicOrgExtent = getGeographicOrgExtent;
     exports.getGroupThumbnailUrl = getGroupThumbnailUrl;