@esri/hub-common 10.0.0-next.2 → 10.0.0-next.3

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v10.0.0-next.1 - Fri Jul 22 2022 18:15:55 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v10.0.0-next.2 - Thu Jul 28 2022 19:50:35 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -6188,15 +6188,10 @@
     ];
     var site$1 = ["Hub Site Application", "Site Application"];
     /**
-     * ```js
-     * import { getCollection } from "@esri/hub-common";
-     * //
-     * getCollection('Feature Layer')
-     * > 'dataset'
-     * ```
      * Get the Hub collection for a given item type
      * @param itemType The ArcGIS [item type](https://developers.arcgis.com/rest/users-groups-and-items/items-and-item-types.htm).
      * @returns the Hub collection of a given item type.
+     * @private
      */
     var getCollection = function (type) {
         if (!type) {
@@ -6208,8 +6203,8 @@
             return collectionTypes.some(function (t) { return t.toLocaleLowerCase() === lowerCaseType; });
         });
     };
-    // TODO: remove this at the next breaking change
-    // it's only here to support deprecated categories
+    // TODO: remove this when we remove the deprecated categories
+    // and then move the above arrays and getCollection() logic to get-family
     var collections = {
         app: app$1,
         dataset: dataset$1,
@@ -6272,8 +6267,10 @@
     ];
     var downloadableTypeKeywords = ["Data"];
     var apiTypes = ["Feature Service", "Map Service", "Image Service"];
-    // TODO: remove this at next breaking version
-    // we're just keeping this for backwards compatibility
+    // DEPRECATED: remove this at next breaking version
+    // this is currently used by hub-search and opendata-ui
+    // (in the dataset-display and content-library-engine)
+    // TODO: remove this once it is no longer used in those places
     var categories = {
         app: app.concat(feedback),
         dataset: dataset,
@@ -6567,12 +6564,6 @@
             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"; });
     }
@@ -6582,15 +6573,8 @@
      * @return {Boolean}       indicator
      */
     function isValidExtent(extent) {
-        return (!!extent &&
-            [isExtentCoordinateArray, isExtentJSON].some(function (test) { return test(extent); }));
+        return !!extent && [isBBox, isExtentJSON].some(function (test) { return test(extent); });
     }
-    /* istanbul ignore next DEPRECATED, remove at next breaking change */
-    var bBoxToPolygon = function (bBox) {
-        /* 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
@@ -6641,9 +6625,7 @@
         var family;
         // override default behavior for the rows that are highlighted in yellow here:
         // https://esriis.sharepoint.com/:x:/r/sites/ArcGISHub/_layouts/15/Doc.aspx?sourcedoc=%7BADA1C9DC-4F6C-4DE4-92C6-693EF9571CFA%7D&file=Hub%20Routes.xlsx&nav=MTBfe0VENEREQzI4LUZFMDctNEI0Ri04NjcyLThCQUE2MTA0MEZGRn1fezIwMTIwMEJFLTA4MEQtNEExRC05QzA4LTE5MTAzOUQwMEE1RH0&action=default&mobileredirect=true&cid=df1c874b-c367-4cea-bc13-7bebfad3f2ac
-        // DEPRECATED: we should make type a required parameter
-        // and just do type.toLowerCase() at the next breaking change
-        switch ((type || "").toLowerCase()) {
+        switch (type.toLowerCase()) {
             case "image service":
                 family = "dataset";
                 break;
@@ -8044,9 +8026,7 @@
                 return item.properties && item.properties.metrics;
             }, get spatialReference() {
                 var _a;
-                // NOTE: I had to add || null just so packages/content/test/portal.test.ts would pass
-                // we can remove that when that package is deprecated
-                return (((_a = layer === null || layer === void 0 ? void 0 : layer.extent) === null || _a === void 0 ? void 0 : _a.spatialReference) || getItemSpatialReference(item) || null);
+                return ((_a = layer === null || layer === void 0 ? void 0 : layer.extent) === null || _a === void 0 ? void 0 : _a.spatialReference) || getItemSpatialReference(item);
             },
             get viewDefinition() {
                 // if this is a layer view and we have the item data
@@ -8064,21 +8044,6 @@
                 /* Note: only returns calcite-icons */
                 return getContentTypeIcon(type);
             },
-            // deprecated properties
-            // TODO: should we add these in legacy wrappers
-            // like itemToContent or datasetToContent instead?
-            get license() {
-                /* tslint:disable no-console */
-                console.warn("DEPRECATED: use structuredLicense instead");
-                /* tslint:enable no-console */
-                return { name: "Custom License", description: item.accessInformation };
-            },
-            get hubType() {
-                /* tslint:disable no-console */
-                console.warn("DEPRECATED: use family instead");
-                /* tslint:enable no-console */
-                return getFamily(type);
-            },
             get additionalResources() {
                 return getAdditionalResources(item, metadata);
             } });
@@ -12200,15 +12165,16 @@
      * getCategory('Feature Layer')
      * > 'dataset'
      * ```
-     * **DEPRECATED: Use getCollection() instead**
+     * **DEPRECATED: Use getFamily() instead**
      * returns the Hub category for a given item type
      * @param itemType The ArcGIS [item type](https://developers.arcgis.com/rest/users-groups-and-items/items-and-item-types.htm).
      * @returns the category of a given item type.
      */
+    /* istanbul ignore next deprecated */
     function getCategory(itemType) {
         if (itemType === void 0) { itemType = ""; }
         /* tslint:disable no-console */
-        console.warn("DEPRECATED: Use getCollection() instead. getCategory will be removed at v10.0.0");
+        console.warn("DEPRECATED: Use getFamily() instead. getCategory will be removed at the next breaking version");
         /* tslint:enable no-console */
         var collection = getCollection(itemType);
         // for backwards compatibility
@@ -12237,12 +12203,17 @@
      * getTypeCategories(item)
      * > [ 'Hub Site Application' ]
      * ```
+     * **DEPRECATED: getTypeCategories will be removed at the next breaking version**
      * @param item Item object.
      * @returns typeCategory of the input item.
      *
      */
+    /* istanbul ignore next deprecated */
     function getTypeCategories(item) {
         if (item === void 0) { item = {}; }
+        /* tslint:disable no-console */
+        console.warn("DEPRECATED: getTypeCategories will be removed at the next breaking version");
+        /* tslint:enable no-console */
         var type = normalizeItemType(item);
         var category = getCategory(type);
         if (category) {
@@ -12307,24 +12278,6 @@
         }
         return content.hubId || content.id;
     }
-    /**
-     * DEPRECATED: Use getFamily() instead.
-     *
-     * get the HubType for a given item or item type
-     *
-     * @param itemOrType an item or item.type
-     */
-    function getItemHubType(itemOrType) {
-        /* tslint:disable no-console */
-        console.warn("DEPRECATED: Use getFamily() instead. getItemHubType() will be removed at v10.0.0");
-        /* tslint:enable no-console */
-        if (typeof itemOrType === "string") {
-            itemOrType = { type: itemOrType };
-        }
-        var itemType = normalizeItemType(itemOrType);
-        // TODO: not all categories are Hub types, may need to validate
-        return getCollection(itemType);
-    }
     /**
      * Convert a Portal item to Hub content
      *
@@ -12498,8 +12451,6 @@
         var contentTypeIcon = getContentTypeIcon(normalizedType);
         var contentTypeLabel = getContentTypeLabel(normalizedType, content.isProxied);
         var updated = __assign(__assign({}, content), { type: normalizedType, family: family,
-            // TODO: remove this at next breaking change now that it has been deprecated
-            normalizedType: normalizedType,
             contentTypeIcon: contentTypeIcon,
             contentTypeLabel: contentTypeLabel });
         // update the relative URL to the content
@@ -12517,55 +12468,6 @@
     var getContentTypeLabel = function (contentType, isProxied) {
         return isProxied ? "CSV" : camelize(contentType || "");
     };
-    /**
-     * DEPRECATED returns a new content that has the specified hubId and updated identifier
-     * @param content orignal content
-     * @param hubId new hubId
-     * @returns new content
-     */
-    /* istanbul ignore next DEPRECATED and no longer in use */
-    var setContentHubId = function (content, hubId) {
-        var id = content.id, slug = content.slug;
-        // get the identifier which is based on hubId
-        var identifier = slug || hubId || id;
-        var updated = __assign(__assign({}, content), { hubId: hubId, identifier: identifier });
-        // update the relative URL to the content
-        // which is based on identifier
-        return appendContentUrls(updated, {
-            relative: getContentRelativeUrl(updated),
-        });
-    };
-    /**
-     * DEPRECATED: Calculates the relative and absolute urls for a given content on a specific site
-     *
-     * @param content
-     * @param siteModel
-     * @returns relative and absolute urls
-     */
-    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 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,
-            site: site,
-        });
-    };
     // URL helpers
     var appendContentUrls = function (content, newUrls) {
         // merge new urls into existing ones and return a new content
@@ -13350,24 +13252,6 @@
         });
     }
 
-    /**
-     * Search the Hub API
-     *
-     * @param requestOptions
-     * @returns JSONAPI response
-     */
-    function hubApiSearch(requestOptions) {
-        // derive default headers if authentication
-        var authentication = requestOptions.authentication;
-        var headers = authentication &&
-            authentication.serialize && { authentication: authentication.serialize() };
-        var defaults = {
-            headers: headers,
-            httpMethod: "POST",
-        };
-        return hubApiRequest("/search", __assign(__assign({}, defaults), requestOptions));
-    }
-
     /* Copyright (c) 2018-2021 Environmental Systems Research Institute, Inc.
      * Apache-2.0 */
     /**
@@ -13618,14 +13502,6 @@
             return catalog;
         }
     }
-    /**
-     * DEPRECATED: Use upgradeCatalogSchema(...)
-     * @param original
-     */
-    /* istanbul ignore next */
-    function convertCatalog(original) {
-        return upgradeCatalogSchema(original);
-    }
 
     /**
      * @private
@@ -14883,18 +14759,6 @@
                 });
             });
         };
-        // DEPRECATED IN FAVOR OF .fetch()
-        // TODO: REMOVE AT NEXT MAJOR
-        /* istanbul ignore next */
-        HubProjectManager.prototype.get = function (identifier, requestOptions) {
-            return __awaiter(this, void 0, void 0, function () {
-                return __generator(this, function (_a) {
-                    // tslint:disable-next-line
-                    console.warn("HubProjectManager.get is deprecated and will be removed. Use .fetch() instead.");
-                    return [2 /*return*/, this.fetch(identifier, requestOptions)];
-                });
-            });
-        };
         /**
          * Fetch a Project via id or it's slug
          *
@@ -15507,15 +15371,6 @@
         }
         return prms;
     }
-    /**
-     * @private // keep out of docs
-     */
-    /* istanbul ignore next */
-    function fetchSite(identifier, hubRequestOptions) {
-        // tslint:disable-next-line
-        console.warn("@esri/hub-common::fetchSite is deprecated. Please use @esri/hub-common::fetchSiteModel instead");
-        return fetchSiteModel(identifier, hubRequestOptions);
-    }
 
     /**
      * Get a Site Model by it's Item Id, and apply schema upgrades
@@ -17129,26 +16984,6 @@
         });
     }
 
-    /**
-     * @private
-     * TEMPORARY - this function only exists to allow incremental
-     * changes and should be removed as soon as arcgis-hub-gallery
-     * is changed to call `hubSearch(...)` directly
-     *
-     * Default's to search ArcGIS Portal but can delegate
-     * to Hub API when it's available.
-     * @param filterGroups
-     * @param options
-     * @returns
-     */
-    function hubSearchQuery(query, options) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                // delegate
-                return [2 /*return*/, hubSearch(query, options)];
-            });
-        });
-    }
     /**
      * Main entrypoint for searching via Hub
      *
@@ -19443,7 +19278,6 @@
     exports.atob = abab.atob;
     exports.autoAddUsers = autoAddUsers;
     exports.bBoxToExtent = bBoxToExtent;
-    exports.bBoxToPolygon = bBoxToPolygon;
     exports.batch = batch;
     exports.btoa = abab.btoa;
     exports.buildDraft = buildDraft;
@@ -19463,7 +19297,6 @@
     exports.compose = compose;
     exports.composeContent = composeContent;
     exports.constructSlug = constructSlug;
-    exports.convertCatalog = convertCatalog;
     exports.convertItemToProject = convertItemToProject;
     exports.convertItemToSite = convertItemToSite;
     exports.convertSolutionTemplateResourcesToAssets = convertSolutionTemplateResourcesToAssets;
@@ -19519,7 +19352,6 @@
     exports.fetchOrg = fetchOrg;
     exports.fetchOrgLimits = fetchOrgLimits;
     exports.fetchProject = fetchProject;
-    exports.fetchSite = fetchSite;
     exports.fetchSiteModel = fetchSiteModel;
     exports.filterBy = filterBy;
     exports.findBy = findBy;
@@ -19528,7 +19360,6 @@
     exports.generateRandomString = generateRandomString;
     exports.getCategory = getCategory;
     exports.getContentIdentifier = getContentIdentifier;
-    exports.getContentSiteUrls = getContentSiteUrls;
     exports.getContentTypeIcon = getContentTypeIcon;
     exports.getContentTypeLabel = getContentTypeLabel;
     exports.getCulture = getCulture;
@@ -19553,7 +19384,6 @@
     exports.getItemDataUrl = getItemDataUrl;
     exports.getItemHomeUrl = getItemHomeUrl;
     exports.getItemHubId = getItemHubId;
-    exports.getItemHubType = getItemHubType;
     exports.getItemLayer = getItemLayer;
     exports.getItemLayerId = getItemLayerId;
     exports.getItemThumbnailUrl = getItemThumbnailUrl;
@@ -19591,9 +19421,7 @@
     exports.getWithDefault = getWithDefault$1;
     exports.hasBasePriv = hasBasePriv;
     exports.hubApiRequest = hubApiRequest;
-    exports.hubApiSearch = hubApiSearch;
     exports.hubSearch = hubSearch;
-    exports.hubSearchQuery = hubSearchQuery;
     exports.includes = includes;
     exports.incrementString = incrementString;
     exports.interpolate = interpolate;
@@ -19603,7 +19431,6 @@
     exports.isDomainForLegacySite = isDomainForLegacySite;
     exports.isDomainUsedElsewhere = isDomainUsedElsewhere;
     exports.isDownloadable = isDownloadable;
-    exports.isExtentCoordinateArray = isExtentCoordinateArray;
     exports.isFeatureService = isFeatureService$1;
     exports.isFieldworkerView = isFieldworkerView;
     exports.isGuid = isGuid;
@@ -19646,8 +19473,6 @@
     exports.serializeModel = serializeModel;
     exports.serializeQueryForPortal = serializeQueryForPortal;
     exports.serializeSpatialReference = serializeSpatialReference;
-    exports.setContentHubId = setContentHubId;
-    exports.setContentSiteUrls = setContentSiteUrls;
     exports.setContentType = setContentType;
     exports.setItemThumbnail = setItemThumbnail;
     exports.setProp = setProp;