@esri/hub-common 9.7.3 → 9.10.0

package/dist/types/content/_internal.d.ts

@@ -0,0 +1,91 @@
+/**
+ * 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.
+ */
+import { BBox, IHubContent, IHubGeography, GeographyProvenance } from "../types";
+/**
+ * Create a new content with updated boundary properties
+ * @param content original content
+ * @param boundary boundary provenance
+ * @returns
+ */
+export declare const setContentBoundary: (content: IHubContent, boundary: GeographyProvenance) => {
+    boundary: IHubGeography;
+    item: any;
+    hubId?: string;
+    permissions: {
+        visibility: "private" | "public" | "org";
+        control?: import("../types").AccessControl;
+        groups?: import("@esri/arcgis-rest-types").IGroup[];
+    };
+    family?: import("../types").HubFamily;
+    itemCategories?: string[];
+    normalizedType?: string;
+    publishedDate: Date;
+    publishedDateSource?: string;
+    updateFrequency?: string;
+    actionLinks?: import("../types").IActionLink[];
+    hubActions?: object;
+    metrics?: {
+        visibility: "private" | "public" | "org" | "updateGroups";
+    };
+    slug?: string;
+    portalDataUrl?: string;
+    groupIds?: string[];
+    errors?: import("../types").IEnrichmentErrorInfo[];
+    data?: {
+        [propName: string]: any;
+    };
+    server?: Partial<import("@esri/arcgis-rest-types").IFeatureServiceDefinition>;
+    layers?: Partial<import("@esri/arcgis-rest-types").ILayerDefinition>[];
+    layer?: Partial<import("@esri/arcgis-rest-types").ILayerDefinition>;
+    recordCount?: number;
+    orgId?: string;
+    org?: Partial<import("@esri/arcgis-rest-portal").IPortal>;
+    isDownloadable: boolean;
+    structuredLicense?: import("..").IStructuredLicense;
+    name: string;
+    summary?: string;
+    hubType: import("../types").HubType;
+    createdDate: Date;
+    createdDateSource?: string;
+    updatedDate: Date;
+    updatedDateSource?: string;
+    portalHomeUrl?: string;
+    portalApiUrl?: string;
+    thumbnailUrl?: string;
+    metadata?: any;
+    id: string;
+    owner: string;
+    tags: string[];
+    created: number;
+    modified: number;
+    numViews: number;
+    size: number;
+    protected?: boolean;
+    title: string;
+    type: string;
+    typeKeywords?: string[];
+    description?: string;
+    snippet?: string;
+    documentation?: string;
+    extent?: number[][];
+    categories?: string[];
+    spatialReference?: import("@esri/arcgis-rest-types").ISpatialReference;
+    culture?: string;
+    properties?: any;
+    url?: string;
+};
+/**
+ * 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
+ */
+export declare const setContentExtent: (content: IHubContent, extent: BBox) => IHubContent;

package/dist/types/{content.d.ts → content/index.d.ts}

@@ -1,7 +1,7 @@
 import { ResourceObject } from "jsonapi-typescript";
 import { IItem } from "@esri/arcgis-rest-portal";
-import { HubType, HubFamily } from "./types";
-import { IHubContent, IModel } from "./types";
+import { HubType, HubFamily } from "../types";
+import { IHubContent, IModel } from "../types";
 /**
  * JSONAPI dataset resource returned by the Hub API
  */
@@ -203,7 +203,7 @@ export declare function datasetToContent(dataset: DatasetResource): IHubContent;
  */
 export declare function datasetToItem(dataset: DatasetResource): IItem;
 /**
- * retunrs a new content that has the specified type and
+ * returns a new content that has the specified type and
  * and updated related properties like normalizedType, family, etc
  * @param content orignal content
  * @param type new type
@@ -211,12 +211,23 @@ export declare function datasetToItem(dataset: DatasetResource): IItem;
  */
 export declare const setContentType: (content: IHubContent, type: string) => IHubContent;
 /**
- * retunrs a new content that has the specified hubId and updated identifier
+ * returns a new content that has the specified hubId and updated identifier
  * @param content orignal content
  * @param hubId new hubId
  * @returns new content
  */
 export declare const setContentHubId: (content: IHubContent, hubId: string) => IHubContent;
+/**
+ * Calculates the relative and absolute urls for a given content on a specific site
+ *
+ * @param content
+ * @param siteModel
+ * @returns relative and absolute urls
+ */
+export declare const getContentSiteUrls: (content: IHubContent, siteModel: IModel) => {
+    relative: string;
+    absolute: string;
+};
 /**
  * append the absolute URL to the content on the site
  * also updates the relative URL in case the

package/dist/types/extent.d.ts

@@ -1,11 +1,11 @@
-import { IExtent } from "@esri/arcgis-rest-types";
-import { IHubRequestOptions, IBBox } from "./types";
+import { IExtent, IPolygon } from "@esri/arcgis-rest-types";
+import { IHubRequestOptions, BBox } from "./types";
 export declare function createExtent(xmin: number, ymin: number, xmax: number, ymax: number, wkid?: number): IExtent;
 /**
  * Turns an extent into a bbox
  * @param envelope extent
  */
-export declare function extentToBBox(envelope: IExtent): IBBox;
+export declare function extentToBBox(envelope: IExtent): BBox;
 export declare const GLOBAL_EXTENT: IExtent;
 /**
  * Gets the geographic extent for an org
@@ -16,7 +16,13 @@ export declare function getGeographicOrgExtent(hubRequestOptions: IHubRequestOpt
  * Get the default org extent as a bbox for use on item.extent
  * @param {IHubRequestOptions} hubRequestOptions
  */
-export declare function getOrgExtentAsBBox(hubRequestOptions: IHubRequestOptions): Promise<IBBox>;
+export declare function getOrgExtentAsBBox(hubRequestOptions: IHubRequestOptions): Promise<BBox>;
+/**
+ * checks if the extent is a valid BBox (2 element array of coordinate pair arrays)
+ * @param extent
+ * @returns
+ */
+export declare const isBBox: (extent: unknown) => boolean;
 export declare function isExtentCoordinateArray(extent: object): boolean;
 /**
  * Check if the given extent is in a known format
@@ -24,3 +30,4 @@ export declare function isExtentCoordinateArray(extent: object): boolean;
  * @return {Boolean}       indicator
  */
 export declare function isValidExtent(extent: object): boolean;
+export declare const bBoxToPolygon: (bBox: BBox) => IPolygon;

package/dist/types/types.d.ts

@@ -102,6 +102,7 @@ export interface IItemResource {
     url: string;
     name: string;
 }
+export declare type BBox = number[][];
 export declare type IBBox = number[][];
 export declare type IBatch = any[];
 export declare type IBatchTransform = (value: any) => any;
@@ -139,6 +140,7 @@ export declare type Visibility = "private" | "org" | "public";
  * User's access level to a Hub resource
  */
 export declare type AccessControl = "view" | "edit" | "admin";
+export declare type GeographyProvenance = "item" | "none" | "automatic";
 /**
  * Location of a Hub resource
  *
@@ -148,6 +150,7 @@ export declare type AccessControl = "view" | "edit" | "admin";
 export interface IHubGeography {
     center?: [number, number];
     geometry?: IGeometry;
+    provenance?: GeographyProvenance;
 }
 export declare type SearchableType = IItem | IGroup | IUser;
 export declare type SearchFunction = (...args: any[]) => Promise<ISearchResult<SearchableType>>;
@@ -295,7 +298,7 @@ export interface IHubContent extends IHubResource, IItem {
     /** The content's structured license info */
     structuredLicense?: IStructuredLicense;
 }
-interface IActionLink {
+export interface IActionLink {
     /** Link title */
     title: string;
     /** Link URL */

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.7.2 - Thu Nov 18 2021 10:35:41 GMT-0700 (Mountain 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
@@ -6179,7 +6252,7 @@
         };
     }
     /**
-     * retunrs a new content that has the specified type and
+     * returns a new content that has the specified type and
      * and updated related properties like normalizedType, family, etc
      * @param content orignal content
      * @param type new type
@@ -6187,8 +6260,9 @@
      */
     var setContentType = function (content, type) {
         // get family and normalized type based on new type
-        var family = getFamily(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
@@ -6197,7 +6271,7 @@
         });
     };
     /**
-     * retunrs a new content that has the specified hubId and updated identifier
+     * returns a new content that has the specified hubId and updated identifier
      * @param content orignal content
      * @param hubId new hubId
      * @returns new content
@@ -6214,19 +6288,30 @@
         });
     };
     /**
-     * append the absolute URL to the content on the site
-     * also updates the relative URL in case the
+     * Calculates the relative and absolute urls for a given content on a specific site
+     *
      * @param content
      * @param siteModel
-     * @returns
+     * @returns relative and absolute urls
      */
-    var setContentSiteUrls = function (content, siteModel) {
-        // recompute relative URL using a site specific identifier
+    var getContentSiteUrls = function (content, siteModel) {
+        // compute relative URL using a site specific identifier
         var siteIdentifier = getContentIdentifier(content, siteModel);
         var relative = getContentRelativeUrl(content, siteIdentifier);
         // get the absolute URL to this content on the site
         var siteUrl = getProp(siteModel, "item.url").replace(/\/$/, "");
-        var site = "" + siteUrl + relative;
+        var absolute = "" + siteUrl + relative;
+        return { relative: relative, absolute: absolute };
+    };
+    /**
+     * append the absolute URL to the content on the site
+     * also updates the relative URL in case the
+     * @param content
+     * @param siteModel
+     * @returns
+     */
+    var setContentSiteUrls = function (content, siteModel) {
+        var _a = getContentSiteUrls(content, siteModel), relative = _a.relative, site = _a.absolute;
         // append the updated URLs to a new content
         return appendContentUrls(content, {
             relative: relative,
@@ -10073,6 +10158,9 @@
             model = _purgeNonGuidsFromCatalog(model);
             model = _ensureTelemetry(model);
             model = _migrateFeedConfig(model);
+            // WARNING - If you are writing a site schema migration,
+            // you probably need to apply it to site drafts as well!
+            // See https://github.com/Esri/hub.js/issues/498 for more details.
             return model;
         }
     }
@@ -10721,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;
@@ -10782,6 +10871,7 @@
     exports.getCategory = getCategory;
     exports.getCollection = getCollection;
     exports.getContentIdentifier = getContentIdentifier;
+    exports.getContentSiteUrls = getContentSiteUrls;
     exports.getCulture = getCulture;
     exports.getDomainsForSite = getDomainsForSite;
     exports.getExportItemTypeKeyword = getExportItemTypeKeyword;
@@ -10835,6 +10925,7 @@
     exports.interpolate = interpolate;
     exports.interpolateItemId = interpolateItemId;
     exports.inviteUsers = inviteUsers;
+    exports.isBBox = isBBox;
     exports.isDomainForLegacySite = isDomainForLegacySite;
     exports.isDomainUsedElsewhere = isDomainUsedElsewhere;
     exports.isDownloadable = isDownloadable;