@esri/hub-common 9.19.0 → 9.21.1

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

@@ -13,6 +13,7 @@ import { IItem } from "@esri/arcgis-rest-portal";
 import { ISpatialReference } from "@esri/arcgis-rest-types";
 import { IHubContent } from "../core";
 import { IHubGeography, GeographyProvenance, IHubRequestOptions } from "../types";
+import { IHubAdditionalResource } from "../core/types/IHubAdditionalResource";
 /**
  * Create a new content with updated boundary properties
  * @param content original content
@@ -65,6 +66,7 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
     hubActions?: object;
     layer?: Partial<ILayerDefinition>;
     isProxied?: boolean;
+    additionalResources?: IHubAdditionalResource[];
     itemCategories?: string[];
     normalizedType?: string;
     orgId?: string;
@@ -152,3 +154,45 @@ export declare function parseISODateString(isoString: string): {
 };
 export declare const getServerSpatialReference: (server: Partial<IFeatureServiceDefinition>, layer?: ILayerDefinition) => ISpatialReference;
 export declare const getItemSpatialReference: (item: IItem) => ISpatialReference;
+/**
+ * Data model for additional resources that are extracted
+ * directly from formal item metadata (with no transformation)
+ */
+interface IAGOAdditionalResource {
+    orName?: string;
+    linkage: string;
+}
+/**
+ * Extracts additional resources from the provided metadata
+ * and transforms them into a hub-friendly format.
+ *
+ * Returns null if no resources are available
+ *
+ * @param item
+ * @param metadata formal metadata
+ * @returns
+ */
+export declare const getAdditionalResources: (item: IItem, metadata?: any, requestOptions?: IHubRequestOptions) => IHubAdditionalResource[];
+/**
+ * Determines whether a raw additional resource (i.e. extracted out of formal
+ * metadata with no transformation) references the underlying service that backs
+ * the item.
+ *
+ * @param resource raw additional resource of an item
+ * @param item
+ * @returns
+ */
+export declare const isDataSourceOfItem: (resource: IAGOAdditionalResource, item: IItem) => boolean;
+/**
+ * Returns the url for an additional resource.
+ *
+ * Automatically appends auth token if token is available
+ * and resource points to the backing service of an item.
+ *
+ * @param resource raw additional resource of an item
+ * @param item
+ * @param requestOptions IHubRequestOptions, including authentication
+ * @returns
+ */
+export declare const getAdditionalResourceUrl: (resource: IAGOAdditionalResource, item: IItem, requestOptions?: IHubRequestOptions) => string;
+export {};

package/dist/types/core/types/IHubAdditionalResource.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Data model for additional resources that are pulled from formal item metadata
+ * and transformed into a hub-friendly interface
+ */
+export interface IHubAdditionalResource {
+    name?: string;
+    url: string;
+    /** whether the url points to the service of the related item */
+    isDataSource: boolean;
+}

package/dist/types/core/types/IHubContent.d.ts

@@ -1,8 +1,10 @@
 import { IItem, IGroup } from "@esri/arcgis-rest-portal";
 import { ILayerDefinition } from "@esri/arcgis-rest-feature-layer";
-import { Visibility, AccessControl, HubFamily, IActionLink, IStructuredLicense } from "../..";
+import { AccessControl, HubFamily, IActionLink, Visibility } from "../../types";
+import { IStructuredLicense } from "../../items/get-structured-license";
 import { IHubItemEntity } from ".";
 import { IHubContentEnrichments } from "./IHubContentEnrichments";
+import { IHubAdditionalResource } from "./IHubAdditionalResource";
 /**
  * Data model for content
  */
@@ -73,6 +75,8 @@ export interface IHubContent extends IHubItemEntity, IHubContentEnrichments, IIt
     layer?: Partial<ILayerDefinition>;
     /** Whether or not the layer or table is actually a proxied CSV */
     isProxied?: boolean;
+    /** links to additional resources specified in the formal item metadata */
+    additionalResources?: IHubAdditionalResource[];
     itemCategories?: string[];
     normalizedType?: string;
     orgId?: string;

package/dist/types/projects/HubProjects.d.ts

@@ -2,7 +2,7 @@ import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
 import { Filter, IHubSearchOptions, ISearchResponse } from "..";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubProject } from "../core/types";
-export declare const HUB_PROJECT_ITEM_TYPE = "Web Mapping Application";
+export declare const HUB_PROJECT_ITEM_TYPE = "Hub Project";
 /**
  * Create a new Hub Project item
  *

package/dist/types/sites/domains/index.d.ts

@@ -13,6 +13,7 @@ export * from "./is-domain-used-elsewhere";
 export * from "./is-valid-domain";
 export * from "./lookup-domain";
 export * from "./remove-domain";
+export * from "./remove-domains-by-site-id";
 export * from "./update-domain";
 export * from "./_ensure-safe-domain-length";
 export * from "./ensure-unique-domain-name";

package/dist/types/sites/domains/remove-domains-by-site-id.d.ts

@@ -0,0 +1,8 @@
+import { IHubRequestOptions } from "../../types";
+/**
+ * Remove all domain entries by site id.
+ * User must be a member of the org that owns the domain entry.
+ * @param {int} domainSiteId of the domain entries to remove
+ * @param {IHubRequestOptions} hubRequestOptions`dom
+ */
+export declare function removeDomainsBySiteId(domainSiteId: string, hubRequestOptions: IHubRequestOptions): Promise<any>;

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.18.0 - Tue Feb 22 2022 17:58:02 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.21.0 - Mon Feb 28 2022 17:38:36 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -5963,6 +5963,26 @@
                 })));
     }
 
+    /* Copyright (c) 2017-2019 Environmental Systems Research Institute, Inc.
+     * Apache-2.0 */
+    var serviceRegex = new RegExp(/.+(?:map|feature|image)server/i);
+    /**
+     * Return the service url. If not matched, returns what was passed in
+     */
+    function parseServiceUrl(url) {
+        var match = url.match(serviceRegex);
+        if (match) {
+            return match[0];
+        }
+        else {
+            return stripQueryString(url);
+        }
+    }
+    function stripQueryString(url) {
+        var stripped = url.split('?')[0];
+        return cleanUrl(stripped);
+    }
+
     function createExtent(xmin, ymin, xmax, ymax, wkid) {
         if (wkid === void 0) { wkid = 4326; }
         return {
@@ -6330,26 +6350,65 @@
             : //
                 { wkid: wkid };
     };
-
-    /* Copyright (c) 2017-2019 Environmental Systems Research Institute, Inc.
-     * Apache-2.0 */
-    var serviceRegex = new RegExp(/.+(?:map|feature|image)server/i);
     /**
-     * Return the service url. If not matched, returns what was passed in
+     * Extracts additional resources from the provided metadata
+     * and transforms them into a hub-friendly format.
+     *
+     * Returns null if no resources are available
+     *
+     * @param item
+     * @param metadata formal metadata
+     * @returns
      */
-    function parseServiceUrl(url) {
-        var match = url.match(serviceRegex);
-        if (match) {
-            return match[0];
+    var getAdditionalResources = function (item, metadata, requestOptions) {
+        var rawResources = getProp(metadata, "metadata.distInfo.distTranOps.onLineSrc") || null;
+        if (rawResources === null) {
+            return null;
         }
-        else {
-            return stripQueryString(url);
+        // Coerce to array since rawResources will be an object if only 1 resource is available
+        rawResources = Array.isArray(rawResources) ? rawResources : [rawResources];
+        return rawResources.map(function (resource) { return ({
+            name: resource.orName,
+            url: getAdditionalResourceUrl(resource, item, requestOptions),
+            isDataSource: isDataSourceOfItem(resource, item),
+        }); });
+    };
+    /**
+     * Determines whether a raw additional resource (i.e. extracted out of formal
+     * metadata with no transformation) references the underlying service that backs
+     * the item.
+     *
+     * @param resource raw additional resource of an item
+     * @param item
+     * @returns
+     */
+    var isDataSourceOfItem = function (resource, item) {
+        var serviceUrl = item.url && parseServiceUrl(item.url);
+        return serviceUrl && resource.linkage.includes(serviceUrl);
+    };
+    /**
+     * Returns the url for an additional resource.
+     *
+     * Automatically appends auth token if token is available
+     * and resource points to the backing service of an item.
+     *
+     * @param resource raw additional resource of an item
+     * @param item
+     * @param requestOptions IHubRequestOptions, including authentication
+     * @returns
+     */
+    var getAdditionalResourceUrl = function (resource, item, requestOptions) {
+        var result = resource.linkage;
+        var token = getProp(requestOptions, "authentication.token");
+        if (token && isDataSourceOfItem(resource, item)) {
+            var resUrl = new URL(resource.linkage);
+            var params = new URLSearchParams(resUrl.search);
+            params.set("token", token);
+            resUrl.search = params.toString();
+            result = resUrl.toString();
         }
-    }
-    function stripQueryString(url) {
-        var stripped = url.split('?')[0];
-        return cleanUrl(stripped);
-    }
+        return result;
+    };
 
     var STANDARD_LICENSES = [
         {
@@ -7259,6 +7318,9 @@
                 console.warn("DEPRECATED: use family instead");
                 /* tslint:enable no-console */
                 return getFamily(type);
+            },
+            get additionalResources() {
+                return getAdditionalResources(item, metadata);
             } });
     };
 
@@ -9710,14 +9772,14 @@
         return clone;
     }
 
-    var HUB_PROJECT_ITEM_TYPE = "Web Mapping Application";
+    var HUB_PROJECT_ITEM_TYPE = "Hub Project";
     /**
      * Default values of a IHubProject
      */
     var DEFAULT_PROJECT = {
         name: "No title provided",
         tags: [],
-        typeKeywords: ["IHubProject", "HubProject"],
+        typeKeywords: ["Hub Project"],
         status: "inactive",
     };
     /**
@@ -9927,7 +9989,7 @@
     function searchProjects(filter, options) {
         var _a;
         return __awaiter(this, void 0, void 0, function () {
-            var scopingFilter, projectFilter, expanded, so;
+            var scopingFilter, projectFilter, expanded, so, props;
             return __generator(this, function (_b) {
                 scopingFilter = {
                     filterType: "content",
@@ -9943,22 +10005,19 @@
                     so.countFields = options.aggregations.join(",");
                     so.countSize = 200;
                 }
-                // copy over various options
-                if (options.num) {
-                    so.num = options.num;
-                }
-                if (options.sortField) {
-                    so.sortField = options.sortField;
-                }
-                if (options.sortOrder) {
-                    so.sortOrder = options.sortOrder;
-                }
-                if (options.site) {
-                    so.site = cloneObject$1(options.site);
-                }
-                if (options.authentication) {
-                    so.authentication = options.authentication;
-                }
+                props = [
+                    "authentication",
+                    "num",
+                    "sortField",
+                    "sortOrder",
+                    "site",
+                ];
+                // copy the props over
+                props.forEach(function (prop) {
+                    if (options.hasOwnProperty(prop)) {
+                        so[prop] = options[prop];
+                    }
+                });
                 return [2 /*return*/, searchPortalProjects(so)];
             });
         });
@@ -11603,40 +11662,36 @@
     function _searchContent(filter, options) {
         var _a;
         return __awaiter(this, void 0, void 0, function () {
-            var expanded, api, searchPromise, so;
+            var expanded, api, searchPromise, so_1, props;
             return __generator(this, function (_b) {
                 expanded = expandContentFilter(filter);
                 api = expandApi(options.api || "arcgis");
                 // Portal Search
                 if (api.type === "arcgis") {
-                    so = serializeContentFilterForPortal(expanded);
-                    // if we have auth, pass it forward
-                    // otherwise set the portal property
-                    if (options.authentication) {
-                        so.authentication = options.authentication;
-                    }
-                    else {
-                        so.portal = api.url + "/sharing/rest";
+                    so_1 = serializeContentFilterForPortal(expanded);
+                    props = [
+                        "authentication",
+                        "num",
+                        "sortField",
+                        "sortOrder",
+                        "site",
+                    ];
+                    // copy the props over
+                    props.forEach(function (prop) {
+                        if (options.hasOwnProperty(prop)) {
+                            so_1[prop] = options[prop];
+                        }
+                    });
+                    // If we don't have auth, ensure we have .portal
+                    if (!so_1.authentication) {
+                        so_1.portal = api.url + "/sharing/rest";
                     }
                     // Aggregations
                     if ((_a = options.aggregations) === null || _a === void 0 ? void 0 : _a.length) {
-                        so.countFields = options.aggregations.join(",");
-                        so.countSize = 200;
-                    }
-                    // copy over various options
-                    if (options.num) {
-                        so.num = options.num;
-                    }
-                    if (options.sortField) {
-                        so.sortField = options.sortField;
+                        so_1.countFields = options.aggregations.join(",");
+                        so_1.countSize = 200;
                     }
-                    if (options.sortOrder) {
-                        so.sortOrder = options.sortOrder;
-                    }
-                    if (options.site) {
-                        so.site = cloneObject$1(options.site);
-                    }
-                    searchPromise = searchPortal(so);
+                    searchPromise = searchPortal(so_1);
                 }
                 else {
                     // Hub API Search
@@ -11708,33 +11763,30 @@
      */
     function _searchGroups(filter, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var expanded, api, so;
+            var expanded, api, so_1, props;
             return __generator(this, function (_a) {
                 expanded = expandGroupFilter(filter);
                 api = expandApi(options.api || "arcgis");
                 if (api.type === "arcgis") {
-                    so = serializeGroupFilterForPortal(expanded);
-                    // if we have auth, pass it forward
-                    // otherwise set the portal property
-                    if (options.authentication) {
-                        so.authentication = options.authentication;
-                    }
-                    else {
-                        so.portal = api.url + "/sharing/rest";
-                    }
-                    if (options.num) {
-                        so.num = options.num;
-                    }
-                    if (options.sortField) {
-                        so.sortField = options.sortField;
-                    }
-                    if (options.sortOrder) {
-                        so.sortOrder = options.sortOrder;
-                    }
-                    if (options.site) {
-                        so.site = cloneObject$1(options.site);
+                    so_1 = serializeGroupFilterForPortal(expanded);
+                    props = [
+                        "authentication",
+                        "num",
+                        "sortField",
+                        "sortOrder",
+                        "site",
+                    ];
+                    // copy the props over
+                    props.forEach(function (prop) {
+                        if (options.hasOwnProperty(prop)) {
+                            so_1[prop] = options[prop];
+                        }
+                    });
+                    // If we don't have auth, ensure we have .portal
+                    if (!so_1.authentication) {
+                        so_1.portal = api.url + "/sharing/rest";
                     }
-                    return [2 /*return*/, searchPortalGroups(so)];
+                    return [2 /*return*/, searchPortalGroups(so_1)];
                 }
                 else {
                     throw new Error("_searchGroups is not implemented for non-arcgis apis");
@@ -11795,7 +11847,7 @@
      */
     function _searchUsers(filter, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var expanded, api, searchOptions;
+            var expanded, api, searchOptions_1, props;
             return __generator(this, function (_a) {
                 // JS Clients may not pass in authentication
                 if (!options.authentication) {
@@ -11804,23 +11856,21 @@
                 expanded = expandUserFilter(filter);
                 api = expandApi(options.api || "arcgis");
                 if (api.type === "arcgis") {
-                    searchOptions = serializeUserFilterForPortal(expanded);
-                    // carry the auth forward
-                    searchOptions.authentication = options.authentication;
-                    // TODO: Dry this up - typscript makes this... inconvenient
-                    if (options.num) {
-                        searchOptions.num = options.num;
-                    }
-                    if (options.sortField) {
-                        searchOptions.sortField = options.sortField;
-                    }
-                    if (options.sortOrder) {
-                        searchOptions.sortOrder = options.sortOrder;
-                    }
-                    if (options.site) {
-                        searchOptions.site = cloneObject$1(options.site);
-                    }
-                    return [2 /*return*/, searchPortalUsers(searchOptions)];
+                    searchOptions_1 = serializeUserFilterForPortal(expanded);
+                    props = [
+                        "authentication",
+                        "num",
+                        "sortField",
+                        "sortOrder",
+                        "site",
+                    ];
+                    // copy the props over
+                    props.forEach(function (prop) {
+                        if (options.hasOwnProperty(prop)) {
+                            searchOptions_1[prop] = options[prop];
+                        }
+                    });
+                    return [2 /*return*/, searchPortalUsers(searchOptions_1)];
                 }
                 else {
                     throw new Error("_searchUsers is not implemented for non-arcgis apis");
@@ -12176,6 +12226,23 @@
         return fetch(url, { method: "DELETE", headers: headers, mode: "cors" }).then(_checkStatusAndParseJson);
     }
 
+    /**
+     * Remove all domain entries by site id.
+     * User must be a member of the org that owns the domain entry.
+     * @param {int} domainSiteId of the domain entries to remove
+     * @param {IHubRequestOptions} hubRequestOptions`dom
+     */
+    function removeDomainsBySiteId(domainSiteId, hubRequestOptions) {
+        // TODO: Can remove this if no longer required
+        if (hubRequestOptions.isPortal) {
+            throw new Error("removeDomainsBySiteId is not available in ArcGIS Enterprise. Instead, edit the hubdomain typekeyword on the item");
+        }
+        var headers = _getAuthHeader(hubRequestOptions);
+        headers["Content-Type"] = "application/json";
+        var url = _getDomainServiceUrl(hubRequestOptions.hubApiUrl) + "/?siteId=" + domainSiteId;
+        return fetch(url, { method: "DELETE", headers: headers, mode: "cors" }).then(_checkStatusAndParseJson);
+    }
+
     /**
      * Update an entry in the domain system
      * @param {IHubDomain} domainEntry  Doman object to be updated
@@ -13250,6 +13317,7 @@
     exports.relativeDateToDateRange = relativeDateToDateRange;
     exports.removeContextFromSlug = removeContextFromSlug;
     exports.removeDomain = removeDomain;
+    exports.removeDomainsBySiteId = removeDomainsBySiteId;
     exports.removeEmptyProps = removeEmptyProps;
     exports.replaceItemId = replaceItemId;
     exports.runRevertableTask = runRevertableTask;