@esri/hub-common 9.29.0 → 9.30.0

package/dist/node/items/create-item-from-file.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createItemFromFile = void 0;
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+const util_1 = require("../util");
+const utils_1 = require("../utils");
+const _prepare_upload_requests_1 = require("./_internal/_prepare-upload-requests");
+/**
+ * Creates an item in online from a local file/item.
+ * Upload is multithreaded as the item is chunked up.
+ *
+ * @export
+ * @param {IItemAdd} item Item to be uploaded into online.
+ * @param {IUserRequestOptions} requestOptions
+ * @return {*}  {Promise<string>} Newly created item id
+ */
+async function createItemFromFile(item, requestOptions) {
+    // Make a copy of the file
+    const file = util_1.cloneObject(item.file);
+    //  and remove the file object so
+    // that it won't trigger the direct upload at the createContent request
+    delete item.file;
+    // Create the item in online so we have an id
+    const createResult = await arcgis_rest_portal_1.createItem(Object.assign({ item, filename: file.name, async: true, multipart: true, overwrite: true }, requestOptions));
+    // get the items id
+    const itemId = createResult.id;
+    try {
+        // AGOL recommends at least 5mb for each file part
+        // to upload so we use 6mb to slice the file.
+        // see https://developers.arcgis.com/rest/users-groups-and-items/add-item-part.htm
+        const sizeLimit = 6 * 1000 * 1000;
+        // Create queue of upload requests.
+        const uploadQueue = _prepare_upload_requests_1._prepareUploadRequests(file, item.owner, itemId, sizeLimit, requestOptions);
+        // execute up to 5 concurrent requests
+        await utils_1.batch(uploadQueue, 
+        // We are doing this to catch individual response failures
+        // and throwing them to stop further xhr's
+        async (opts) => {
+            const resp = await arcgis_rest_portal_1.addItemPart(opts);
+            // If the response did not return with success then throw an error
+            if (!resp.success) {
+                throw new Error("addItemPart failed");
+            }
+        }, 5);
+        // Commit is called once all parts are uploaded during a multipart add item or update item operation.
+        await arcgis_rest_portal_1.commitItemUpload(Object.assign({ id: itemId, item, owner: item.owner }, requestOptions));
+    }
+    catch (e) {
+        // If an error is thrown then cancel item upload
+        await arcgis_rest_portal_1.cancelItemUpload(Object.assign({ id: itemId, owner: item.owner }, requestOptions));
+        throw e;
+    }
+    return createResult;
+}
+exports.createItemFromFile = createItemFromFile;
+//# sourceMappingURL=create-item-from-file.js.map

package/dist/node/items/create-item-from-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-item-from-file.js","sourceRoot":"","sources":["../../../src/items/create-item-from-file.ts"],"names":[],"mappings":";;;AACA,iEAMkC;AAElC,kCAAsC;AACtC,oCAAiC;AACjC,mFAA8E;AAE9E;;;;;;;;GAQG;AACI,KAAK,UAAU,kBAAkB,CACtC,IAAc,EACd,cAAmC;IAEnC,0BAA0B;IAC1B,MAAM,IAAI,GAAQ,kBAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,iCAAiC;IACjC,uEAAuE;IACvE,OAAO,IAAI,CAAC,IAAI,CAAC;IAEjB,6CAA6C;IAC7C,MAAM,YAAY,GAAwB,MAAM,+BAAU,iBACxD,IAAI,EACJ,QAAQ,EAAE,IAAI,CAAC,IAAI,EACnB,KAAK,EAAE,IAAI,EACX,SAAS,EAAE,IAAI,EACf,SAAS,EAAE,IAAI,IACZ,cAAc,EACjB,CAAC;IACH,mBAAmB;IACnB,MAAM,MAAM,GAAG,YAAY,CAAC,EAAE,CAAC;IAE/B,IAAI;QACF,kDAAkD;QAClD,6CAA6C;QAC7C,kFAAkF;QAClF,MAAM,SAAS,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;QAClC,mCAAmC;QACnC,MAAM,WAAW,GAAG,iDAAsB,CACxC,IAAI,EACJ,IAAI,CAAC,KAAK,EACV,MAAM,EACN,SAAS,EACT,cAAc,CACf,CAAC;QACF,sCAAsC;QACtC,MAAM,aAAK,CACT,WAAW;QACX,0DAA0D;QAC1D,0CAA0C;QAC1C,KAAK,EAAE,IAAI,EAAE,EAAE;YACb,MAAM,IAAI,GAAG,MAAM,gCAAW,CAAC,IAAI,CAAC,CAAC;YACrC,kEAAkE;YAClE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;gBACjB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;aACvC;QACH,CAAC,EACD,CAAC,CACF,CAAC;QAEF,qGAAqG;QACrG,MAAM,qCAAgB,iBACpB,EAAE,EAAE,MAAM,EACV,IAAI,EACJ,KAAK,EAAE,IAAI,CAAC,KAAK,IACd,cAAc,EACjB,CAAC;KACJ;IAAC,OAAO,CAAC,EAAE;QACV,gDAAgD;QAChD,MAAM,qCAAgB,iBACpB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,IAAI,CAAC,KAAK,IACd,cAAc,EACjB,CAAC;QAEH,MAAM,CAAC,CAAC;KACT;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AArED,gDAqEC"}

package/dist/node/items/create-item-from-url-or-file.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createItemFromUrlOrFile = void 0;
+const tslib_1 = require("tslib");
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+const utils_1 = require("../utils");
+const create_item_from_file_1 = require("./create-item-from-file");
+const create_item_from_url_1 = require("./create-item-from-url");
+const _wait_for_item_ready_1 = require("./_internal/_wait-for-item-ready");
+/**
+ * Creates an item in online from either url or file.
+ * Once created we wait for the item to be ready (or throw an error if creation failed)
+ * If access is not private then we make a call to update that.
+ *
+ * @export
+ * @param {ICreateItemFromUrlOrFileOptions} createItemFromUrlOrFileOptions Input params (item, groups?, requestoptions)
+ * @return {*}  {Promise<string>} AGO item id
+ */
+async function createItemFromUrlOrFile(createItemFromUrlOrFileOptions) {
+    const { item, groups } = createItemFromUrlOrFileOptions, userRequestOptions = tslib_1.__rest(createItemFromUrlOrFileOptions, ["item", "groups"]);
+    // Is there a file or data url?
+    const shouldWaitForItemReady = item.dataUrl || item.file;
+    let createdItem;
+    // If there is a file then we create the item and chunk the file
+    // while multithread uploading it
+    if (item.file) {
+        createdItem = await create_item_from_file_1.createItemFromFile(item, userRequestOptions);
+        // Otherwise it's being created from a url.
+    }
+    else {
+        createdItem = await create_item_from_url_1.createItemFromUrl(item, userRequestOptions);
+    }
+    // If there is a file or data url we want to check to see if / when the item is ready.
+    if (shouldWaitForItemReady) {
+        await _wait_for_item_ready_1._waitForItemReady(createdItem.id, userRequestOptions);
+    }
+    // If the item access is NOT private (which is the sharing access level by default)
+    // We subsequently update the items access level.
+    if (item.access !== "private") {
+        await arcgis_rest_portal_1.setItemAccess(Object.assign({ id: createdItem.id, owner: item.owner, access: item.access }, userRequestOptions));
+    }
+    // If group ids were passedd in then make share calls to each.
+    if (groups === null || groups === void 0 ? void 0 : groups.length) {
+        const failSafeShare = utils_1.failSafe(arcgis_rest_portal_1.shareItemWithGroup);
+        await Promise.all(groups.map((group) => failSafeShare(Object.assign({ id: createdItem.id, owner: item.owner, groupId: group.id, confirmItemControl: utils_1.isUpdateGroup(group) }, userRequestOptions))));
+    }
+    return createdItem;
+}
+exports.createItemFromUrlOrFile = createItemFromUrlOrFile;
+//# sourceMappingURL=create-item-from-url-or-file.js.map

package/dist/node/items/create-item-from-url-or-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-item-from-url-or-file.js","sourceRoot":"","sources":["../../../src/items/create-item-from-url-or-file.ts"],"names":[],"mappings":";;;;AACA,iEAIkC;AAElC,oCAAmD;AACnD,mEAA6D;AAC7D,iEAA2D;AAC3D,2EAAqE;AAOrE;;;;;;;;GAQG;AACI,KAAK,UAAU,uBAAuB,CAC3C,8BAA+D;IAE/D,MAAM,EAAE,IAAI,EAAE,MAAM,KAClB,8BAA8B,EADP,kBAAkB,kBACzC,8BAA8B,EAD1B,kBAAuC,CACb,CAAC;IACjC,+BAA+B;IAC/B,MAAM,sBAAsB,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC;IACzD,IAAI,WAAgC,CAAC;IAErC,gEAAgE;IAChE,iCAAiC;IACjC,IAAI,IAAI,CAAC,IAAI,EAAE;QACb,WAAW,GAAG,MAAM,0CAAkB,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;QACjE,2CAA2C;KAC5C;SAAM;QACL,WAAW,GAAG,MAAM,wCAAiB,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;KACjE;IAED,sFAAsF;IACtF,IAAI,sBAAsB,EAAE;QAC1B,MAAM,wCAAiB,CAAC,WAAW,CAAC,EAAE,EAAE,kBAAkB,CAAC,CAAC;KAC7D;IAED,mFAAmF;IACnF,iDAAiD;IACjD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;QAC7B,MAAM,kCAAa,iBACjB,EAAE,EAAE,WAAW,CAAC,EAAE,EAClB,KAAK,EAAE,IAAI,CAAC,KAAK,EACjB,MAAM,EAAE,IAAI,CAAC,MAAM,IAChB,kBAAkB,EACrB,CAAC;KACJ;IAED,8DAA8D;IAC9D,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,EAAE;QAClB,MAAM,aAAa,GAAG,gBAAQ,CAAC,uCAAkB,CAAC,CAAC;QACnD,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,GAAG,CAAC,CAAC,KAAa,EAAE,EAAE,CAC3B,aAAa,iBACX,EAAE,EAAE,WAAW,CAAC,EAAE,EAClB,KAAK,EAAE,IAAI,CAAC,KAAK,EACjB,OAAO,EAAE,KAAK,CAAC,EAAE,EACjB,kBAAkB,EAAE,qBAAa,CAAC,KAAK,CAAC,IACrC,kBAAkB,EACrB,CACH,CACF,CAAC;KACH;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAnDD,0DAmDC"}

package/dist/node/items/create-item-from-url.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createItemFromUrl = void 0;
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+/**
+ * Create AGO item from a URL
+ *
+ * @export
+ * @param {IItemAdd} item Item to be uploaded into online.
+ * @param {IUserRequestOptions} requestOptions
+ * @return {*}  {Promise<string>} Newly created item ID
+ */
+async function createItemFromUrl(item, requestOptions) {
+    // Fire off createItem call
+    const createResult = await arcgis_rest_portal_1.createItem(Object.assign({ item, owner: item.owner, file: item.file, dataUrl: item.dataUrl, text: item.text, multipart: item.multipart, async: item.async }, requestOptions));
+    // return the newly created item id
+    return createResult;
+}
+exports.createItemFromUrl = createItemFromUrl;
+//# sourceMappingURL=create-item-from-url.js.map

package/dist/node/items/create-item-from-url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-item-from-url.js","sourceRoot":"","sources":["../../../src/items/create-item-from-url.ts"],"names":[],"mappings":";;;AACA,iEAA2E;AAG3E;;;;;;;GAOG;AACI,KAAK,UAAU,iBAAiB,CACrC,IAAc,EACd,cAAmC;IAEnC,2BAA2B;IAC3B,MAAM,YAAY,GAAwB,MAAM,+BAAU,iBACxD,IAAI,EACJ,KAAK,EAAE,IAAI,CAAC,KAAK,EACjB,IAAI,EAAE,IAAI,CAAC,IAAI,EACf,OAAO,EAAE,IAAI,CAAC,OAAO,EACrB,IAAI,EAAE,IAAI,CAAC,IAAI,EACf,SAAS,EAAE,IAAI,CAAC,SAAS,EACzB,KAAK,EAAE,IAAI,CAAC,KAAK,IACd,cAAc,EACjB,CAAC;IACH,mCAAmC;IACnC,OAAO,YAAY,CAAC;AACtB,CAAC;AAjBD,8CAiBC"}

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

@@ -114,14 +114,14 @@ export declare const setContentType: (content: IHubContent, type: string) => IHu
  */
 export declare const getContentTypeLabel: (contentType: string, isProxied: boolean) => string;
 /**
- * returns a new content that has the specified hubId and updated identifier
+ * DEPRECATED 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
+ * DEPRECATED: Calculates the relative and absolute urls for a given content on a specific site
  *
  * @param content
  * @param siteModel

package/dist/types/items/_internal/_prepare-upload-requests.d.ts

@@ -0,0 +1,16 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { IBatch } from "../..";
+/**
+ * Takes a file, file owner, and file AGO item id along with a size limit
+ * Then chunks the file up based on that file limit.
+ * The chunks are added to addItemPart calls and added to a queue array.
+ *
+ * @export
+ * @param {*} file File to be uploaded
+ * @param {string} owner file owner
+ * @param {string} id file ID from AGO
+ * @param {number} sizeLimit How large should the chunks be?
+ * @param {IUserRequestOptions} requestOptions
+ * @return {*}  {IBatch}
+ */
+export declare function _prepareUploadRequests(file: any, owner: string, id: string, sizeLimit: number, requestOptions: IUserRequestOptions): IBatch;

package/dist/types/items/_internal/_wait-for-item-ready.d.ts

@@ -0,0 +1,10 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+/**
+ * Helper function which takes an itemId and checks the status
+ * of the item every 2 seconds until it is either complete or failed.
+ *
+ * @export
+ * @param {string} itemId AGO item id
+ * @param {IUserRequestOptions} requestOptions
+ */
+export declare function _waitForItemReady(itemId: string, requestOptions: IUserRequestOptions): Promise<void>;

package/dist/types/items/create-item-from-file.d.ts

@@ -0,0 +1,13 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { ICreateItemResponse } from "@esri/arcgis-rest-portal";
+import { IItemAdd } from "@esri/arcgis-rest-types";
+/**
+ * Creates an item in online from a local file/item.
+ * Upload is multithreaded as the item is chunked up.
+ *
+ * @export
+ * @param {IItemAdd} item Item to be uploaded into online.
+ * @param {IUserRequestOptions} requestOptions
+ * @return {*}  {Promise<string>} Newly created item id
+ */
+export declare function createItemFromFile(item: IItemAdd, requestOptions: IUserRequestOptions): Promise<ICreateItemResponse>;

package/dist/types/items/create-item-from-url-or-file.d.ts

@@ -0,0 +1,18 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { ICreateItemResponse } from "@esri/arcgis-rest-portal";
+import { IGroup, IItemAdd } from "@esri/arcgis-rest-types";
+interface ICreateItemFromUrlOrFileOptions extends IUserRequestOptions {
+    item: IItemAdd;
+    groups?: IGroup[];
+}
+/**
+ * Creates an item in online from either url or file.
+ * Once created we wait for the item to be ready (or throw an error if creation failed)
+ * If access is not private then we make a call to update that.
+ *
+ * @export
+ * @param {ICreateItemFromUrlOrFileOptions} createItemFromUrlOrFileOptions Input params (item, groups?, requestoptions)
+ * @return {*}  {Promise<string>} AGO item id
+ */
+export declare function createItemFromUrlOrFile(createItemFromUrlOrFileOptions: ICreateItemFromUrlOrFileOptions): Promise<ICreateItemResponse>;
+export {};

package/dist/types/items/create-item-from-url.d.ts

@@ -0,0 +1,12 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { ICreateItemResponse } from "@esri/arcgis-rest-portal";
+import { IItemAdd } from "@esri/arcgis-rest-types";
+/**
+ * Create AGO item from a URL
+ *
+ * @export
+ * @param {IItemAdd} item Item to be uploaded into online.
+ * @param {IUserRequestOptions} requestOptions
+ * @return {*}  {Promise<string>} Newly created item ID
+ */
+export declare function createItemFromUrl(item: IItemAdd, requestOptions: IUserRequestOptions): Promise<ICreateItemResponse>;

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.28.0 - Thu Apr 21 2022 15:27:55 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.29.0 - Mon May 09 2022 16:03:22 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -6371,7 +6371,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
-        switch ((type || "").toLowerCase()) {
+        switch (type.toLowerCase()) {
             case "image service":
                 family = "dataset";
                 break;
@@ -6522,6 +6522,8 @@
                 // deployed solutions go to the generic content route
                 hubUrl = "/content/" + identifier;
             }
+            // TODO: I think this is a bug. The line below should be w/in else
+            // in order to avoid overwriting the above for deployed solutions, right?
             // others go to the solution about route
             hubUrl = "/templates/" + identifier + "/about";
         }
@@ -7200,7 +7202,7 @@
      */
     var getContentTypeIcon = function (contentType) {
         var _a;
-        var type = camelize(contentType || "");
+        var type = camelize(contentType);
         var iconMap = {
             appbuilderExtension: "file",
             appbuilderWidgetPackage: "widgets-source",
@@ -9603,11 +9605,12 @@
         return isProxied ? "CSV" : camelize(contentType || "");
     };
     /**
-     * returns a new content that has the specified hubId and updated identifier
+     * 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
@@ -9620,7 +9623,7 @@
         });
     };
     /**
-     * Calculates the relative and absolute urls for a given content on a specific site
+     * DEPRECATED: Calculates the relative and absolute urls for a given content on a specific site
      *
      * @param content
      * @param siteModel
@@ -9665,6 +9668,10 @@
      * instead of throwing INVALID_CHARACTER_ERR we return null.
      */
     function atob(data) {
+      if (arguments.length === 0) {
+        throw new TypeError("1 argument required, but only 0 present.");
+      }
+
       // Web IDL requires DOMStrings to just be converted using ECMAScript
       // ToString, which in our case amounts to using a template literal.
       data = `${data}`;
@@ -9761,6 +9768,10 @@
      * RFC 4648.
      */
     function btoa(s) {
+      if (arguments.length === 0) {
+        throw new TypeError("1 argument required, but only 0 present.");
+      }
+
       let i;
       // String conversion as required by Web IDL.
       s = `${s}`;