@esri/solution-common 6.1.3 → 6.1.4

package/dist/esm/resourceHelpers.js

@@ -0,0 +1,361 @@
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Provides common functions involving the management of item and group resources.
+ *
+ * @module resourceHelpers
+ *
+ * How it works
+ *
+ * An item may have resources that are listed as a set of filenames and/or folder/filename combinations. It may have
+ * a thumbnail, listed in its item info as a filename or folder/filename combination. It may have metadata, which is
+ * not listed, but has a distinct URL. A group may have a thumbnail, but not the others.
+ *
+ * For storing these files in a common storage item, a new folder and filename combination is created for each. The
+ * filename is kept as-is. The folder consists of the source item's id and an optional suffix. For thumbnails, the
+ * suffix is "_info_thumbnail"; for metadata, the suffix is "_info_metadata"; for resources, the suffix is "_" plus
+ * the resource's folder's name; if the resource doesn't have a folder, there is no suffix.
+ *
+ * Note that "thumbnail" is included in an item's thumbnail property like a folder (e.g., "thumbnail/thumbnail.png"),
+ * and the item's thumbnail is accessed using a path such as "%lt;itemId>/info/thumbnail/thumbnail.png". Groups,
+ * on the other hand, have a property with a simple name (e.g., "thumbnail.png") and it is accessed using a path
+ * such as "%lt;groupId>/info/thumbnail.png".
+ *
+ * For copying these files from the common storage item to another item, one converts the unique names back into the
+ * original names (or the special cases for thumbnails and metadata).
+ *
+ * Routines are provided to
+ *   1. create full URLs to resources, thumbnails, and metadata.
+ *   2. create a folder and filename combination that uniquely identifies these files for
+ *      storing them in a single, shared storage item
+ *   3. copy a set of resources, thumbnails, and metadata for an item to a storage item
+ *   4. copy a file by URL to an item using specified folder and filename
+ *   5. undo the unique folder and filename into the original folder and filename
+ */
+import { EFileType, } from "./interfaces";
+import { removeItemResource, restUpdateGroup, restUpdateItem, updateItemResource, } from "./arcgisRestJS";
+import { appendQueryParam, checkUrlPathTermination } from "./generalHelpers";
+import { convertItemResourceToStorageResource } from "./resources/convert-item-resource-to-storage-resource";
+import { convertStorageResourceToItemResource } from "./resources/convert-storage-resource-to-item-resource";
+import { getThumbnailFile } from "./restHelpersGet";
+import { copyAssociatedFilesByType, copyFilesAsResources } from "./resources/copyAssociatedFiles";
+// ------------------------------------------------------------------------------------------------------------------ //
+export function addThumbnailFromBlob(blob, itemId, authentication, isGroup = false) {
+    const updateOptions = {
+        params: {
+            // Pass image in directly because item object is serialized, which discards a blob
+            thumbnail: blob,
+        },
+        authentication: authentication,
+    };
+    updateOptions[isGroup ? "group" : "item"] = {
+        id: itemId,
+    };
+    return isGroup ? restUpdateGroup(updateOptions) : restUpdateItem(updateOptions);
+}
+export function convertBlobToSupportableResource(blob, filename = "") {
+    const originalFilename = blob.name || filename;
+    let filenameToUse = originalFilename;
+    if (filenameToUse && !isSupportedFileType(filenameToUse)) {
+        filenameToUse = filenameToUse + ".zip";
+    }
+    return {
+        blob: new File([blob], filenameToUse, { type: blob.type }),
+        filename: originalFilename,
+        mimeType: blob.type,
+    };
+}
+/**
+ * Copies the files described by a list of full URLs and folder/filename combinations for
+ * the resources and metadata of an item or group to an item.
+ *
+ * @param storageAuthentication Credentials for the request to the storage
+ * @param filePaths List of item files' URLs and folder/filenames for storing the files
+ * @param sourceItemId Id of item supplying resource/metadata
+ * @param destinationFolderId Id of folder
+ * @param destinationItemId Id of item to receive copy of resource/metadata
+ * @param destinationAuthentication Credentials for the request to the destination
+ * @param template Description of item that will receive files
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
+ * @returns A promise which resolves to a boolean indicating if the copies were successful
+ */
+export function copyFilesFromStorageItem(storageAuthentication, filePaths, sourceItemId, destinationFolderId, destinationItemId, destinationAuthentication, template = {}, templateDictionary = {}) {
+    // TODO: This is only used in deployer, so move there
+    // changed to allow the template to be passed in
+    // because Hub templates need to swap out the templateId
+    // in the resource filename
+    const mimeTypes = template.properties || null;
+    // remove the template.itemId from the fileName in the filePaths
+    /* istanbul ignore else */
+    if (template.itemId) {
+        filePaths = filePaths.map((fp) => {
+            /* istanbul ignore else */
+            if (fp.filename.indexOf(template.itemId) === 0 && fp.folder === "") {
+                fp.filename = fp.filename.replace(`${template.itemId}-`, "");
+            }
+            return fp;
+        });
+    }
+    return new Promise((resolve, reject) => {
+        const fileInfos = filePaths.map((path) => {
+            return {
+                folder: path.type === EFileType.Data ? destinationFolderId : path.folder,
+                filename: path.filename,
+                type: path.type,
+                mimeType: mimeTypes ? mimeTypes[path.filename] : "",
+                url: path.url,
+            };
+        });
+        void copyAssociatedFilesByType(fileInfos, storageAuthentication, sourceItemId, destinationItemId, destinationAuthentication, template, templateDictionary).then((results) => {
+            const allOK = results
+                // Filter out metadata
+                .filter((result) => result.filename !== "metadata.xml")
+                // Extract success
+                .map((result) => result.fetchedFromSource && result.copiedToDestination)
+                // Boil it down to a single result
+                .reduce((success, currentValue) => success && currentValue, true);
+            if (allOK) {
+                resolve(true);
+            }
+            else {
+                reject();
+            }
+        });
+    });
+}
+/**
+ * Copies the files for storing the resources, metadata, and thumbnail of an item or group to a storage item
+ * with a specified path.
+ *
+ * @param files List of item files and paths for storing the files
+ * @param storageItemId Id of item to receive copy of resource/metadata
+ * @param storageAuthentication Credentials for the request to the storage
+ * @returns A promise which resolves to a list of the filenames under which the resource/metadata are stored
+ */
+export function copyFilesToStorageItem(files, storageItemId, storageAuthentication) {
+    return new Promise((resolve) => {
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        void copyFilesAsResources(files, storageItemId, storageAuthentication).then((results) => {
+            resolve(results
+                // Filter out failures
+                .filter((result) => result.fetchedFromSource && result.copiedToDestination)
+                // Return folder and filename in storage item's resources
+                .map((result) => result.folder + "/" + result.filename));
+        });
+    });
+}
+/**
+ * Generates a folder and filename for storing a copy of an item's metadata in a storage item.
+ *
+ * @param itemId Id of item
+ * @returns Folder and filename for storage; folder is the itemID suffixed with "_info_metadata"
+ * @see convertStorageResourceToItemResource
+ */
+export function generateMetadataStorageFilename(itemId) {
+    return {
+        folder: itemId + "_info_metadata",
+        filename: "metadata.xml",
+    };
+}
+/**
+ * Generates a list of full URLs and storage folder/filename combinations for storing the resources, metadata,
+ * and thumbnail of an item.
+ *
+ * @param portalSharingUrl Server/sharing
+ * @param itemId Id of item
+ * @param thumbnailUrlPart Partial path to the thumbnail held in an item's JSON
+ * @param resourceFilenames List of resource filenames for an item, e.g., ["file1", "myFolder/file2"]
+ * @param isGroup Boolean to indicate if the files are associated with a group or item
+ * @param storageVersion Version of the Solution template
+ * @returns List of item files' URLs and folder/filenames for storing the files
+ */
+export function generateSourceFilePaths(portalSharingUrl, itemId, thumbnailUrlPart, resourceFilenames, isGroup = false, storageVersion = 0) {
+    const filePaths = resourceFilenames.map((resourceFilename) => {
+        return {
+            itemId,
+            url: generateSourceResourceUrl(portalSharingUrl, itemId, resourceFilename),
+            ...convertItemResourceToStorageResource(itemId, resourceFilename, storageVersion),
+        };
+    });
+    filePaths.push({
+        itemId,
+        url: generateSourceMetadataUrl(portalSharingUrl, itemId, isGroup),
+        ...generateMetadataStorageFilename(itemId),
+    });
+    /* istanbul ignore else */
+    if (thumbnailUrlPart) {
+        filePaths.push(generateSourceThumbnailPath(portalSharingUrl, itemId, thumbnailUrlPart, isGroup));
+    }
+    return filePaths;
+}
+/**
+ * Generates the full URL and storage folder/filename for storing an item's thumbnail.
+ *
+ * @param portalSharingUrl Server/sharing
+ * @param itemId Id of item
+ * @param thumbnailUrlPart Partial path to the thumbnail held in an item's JSON
+ * @param isGroup Boolean to indicate if the files are associated with a group or item
+ * @returns URL and folder/filename for storing the thumbnail
+ */
+export function generateSourceThumbnailPath(portalSharingUrl, itemId, thumbnailUrlPart, isGroup = false) {
+    return {
+        itemId,
+        url: appendQueryParam(generateSourceThumbnailUrl(portalSharingUrl, itemId, thumbnailUrlPart, isGroup), "w=400"),
+        ...generateThumbnailStorageFilename(itemId, thumbnailUrlPart),
+    };
+}
+/**
+ * Generates the URL for reading an item's metadata.
+ *
+ * @param sourcePortalSharingUrl Server/sharing
+ * @param itemId Id of item
+ * @param isGroup Boolean to indicate if the files are associated with a group or item
+ * @returns URL string
+ */
+export function generateSourceMetadataUrl(sourcePortalSharingUrl, itemId, isGroup = false) {
+    return (checkUrlPathTermination(sourcePortalSharingUrl) +
+        (isGroup ? "community/groups/" : "content/items/") +
+        itemId +
+        "/info/metadata/metadata.xml");
+}
+/**
+ * Generates the URL for reading an item's resource given the filename of the resource.
+ *
+ * @param sourcePortalSharingUrl Server/sharing
+ * @param itemId Id of item
+ * @param sourceResourceFilename Either filename or folder/filename to resource
+ * @returns URL string
+ */
+export function generateSourceResourceUrl(sourcePortalSharingUrl, itemId, sourceResourceFilename) {
+    return (checkUrlPathTermination(sourcePortalSharingUrl) + "content/items/" + itemId + "/resources/" + sourceResourceFilename);
+}
+/**
+ * Generates the URL for reading an item's thumbnail.
+ *
+ * @param sourcePortalSharingUrl Server/sharing
+ * @param itemId Id of item
+ * @param thumbnailUrlPart Partial path to the thumbnail held in an item's JSON
+ * @param isGroup Boolean to indicate if the files are associated with a group or item
+ * @returns URL string
+ */
+export function generateSourceThumbnailUrl(sourcePortalSharingUrl, itemId, thumbnailUrlPart, isGroup = false) {
+    return (checkUrlPathTermination(sourcePortalSharingUrl) +
+        (isGroup ? "community/groups/" : "content/items/") +
+        itemId +
+        "/info/" +
+        thumbnailUrlPart);
+}
+/**
+ * Generates a list of full URLs and folder/filename combinations used to store the resources, metadata,
+ * and thumbnail of an item.
+ *
+ * @param portalSharingUrl Server/sharing
+ * @param storageItemId Id of storage item
+ * @param resourceFilenames List of resource filenames for an item, e.g., ["file1", "myFolder/file2"]
+ * @param storageVersion Version of the Solution template
+ * @returns List of item files' URLs and folder/filenames for storing the files
+ */
+export function generateStorageFilePaths(portalSharingUrl, storageItemId, resourceFilenames = [], storageVersion = 0) {
+    return resourceFilenames.map((resourceFilename) => {
+        return {
+            url: generateSourceResourceUrl(portalSharingUrl, storageItemId, resourceFilename),
+            ...convertStorageResourceToItemResource(resourceFilename, storageVersion),
+        };
+    });
+}
+/**
+ * Generates a folder and filename for storing a copy of an item's thumbnail in a storage item.
+ *
+ * @param itemId Id of item
+ * @param thumbnailUrlPart Partial path to the thumbnail held in an item's JSON; can also be a filename
+ * @returns Folder and filename for storage; folder is the itemID suffixed with "_info_thumbnail";
+ * file is URI-encoded thumbnailUrlPart
+ * @see convertStorageResourceToItemResource
+ */
+export function generateThumbnailStorageFilename(itemId, thumbnailurl) {
+    const folder = itemId + "_info_thumbnail";
+    const thumbnailUrlParts = thumbnailurl.split("/");
+    const filename = thumbnailUrlParts.length === 1 ? thumbnailUrlParts[0] : thumbnailUrlParts[1];
+    return { folder, filename };
+}
+export function isSupportedFileType(filename) {
+    // Supported file formats are: .json, .xml, .txt, .png, .pbf, .zip, .jpeg, .jpg, .gif, .bmp, .gz, .svg,
+    // .svgz, .geodatabase (https://developers.arcgis.com/rest/users-groups-and-items/add-resources.htm)
+    const filenameExtension = filename.match(/\.([a-z]+)$/i);
+    const supportedExtensions = "|.json|.xml|.txt|.png|.pbf|.zip|.jpeg|.jpg|.gif|.bmp|.gz|.svg|.svgz|.geodatabase|";
+    return !!filenameExtension && supportedExtensions.indexOf("|" + filenameExtension[0] + "|") >= 0;
+}
+/**
+ * Gets the thumbnail of an item or group.
+ *
+ * @param authentication Credentials for the request to the storage
+ * @param filePaths List of item files' URLs and folder/filenames for storing the files
+ * @returns A promise which resolves to a boolean indicating if the copies were successful
+ */
+export function getThumbnailFromStorageItem(authentication, filePaths) {
+    let thumbnailUrl;
+    let thumbnailFilename;
+    filePaths.forEach((path) => {
+        if (path.type === EFileType.Thumbnail) {
+            thumbnailUrl = path.url;
+            thumbnailFilename = path.filename;
+        }
+    });
+    if (!thumbnailUrl) {
+        return Promise.resolve(null);
+    }
+    return getThumbnailFile(thumbnailUrl, thumbnailFilename, authentication);
+}
+/**
+ * Removes the item's resource that matches the filename with new content
+ *
+ * @param itemId Id of the item to remove
+ * @param filename Name of the resource file to remove
+ * @param authentication Credentials for the request to the storage
+ * @returns A promise which resolves with a success true/false response
+ */
+export function removeItemResourceFile(itemId, filename, authentication) {
+    return removeItemResource({
+        id: itemId,
+        resource: filename,
+        authentication: authentication,
+    });
+}
+/**
+ * Updates the item's resource that matches the filename with new content
+ *
+ * @param itemId Id of the item to update
+ * @param filename Name of the resource file to update; prefix optional (e.g., a/b/file.txt)
+ * @param resource The new content to update the resource with
+ * @param authentication Credentials for the request to the storage
+ * @returns A promise which resolves with a success true/false response
+ */
+export function updateItemResourceFile(itemId, filename, resource, authentication) {
+    // Prefix has to be specified separately
+    const prefixedFilenameParts = filename.split("/");
+    const prefix = prefixedFilenameParts.length > 1
+        ? prefixedFilenameParts.slice(0, prefixedFilenameParts.length - 1).join("/")
+        : undefined;
+    const suffix = prefixedFilenameParts[prefixedFilenameParts.length - 1];
+    return updateItemResource({
+        id: itemId,
+        prefix: prefix,
+        name: suffix,
+        resource,
+        authentication: authentication,
+    });
+}
+//# sourceMappingURL=resourceHelpers.js.map

package/dist/esm/resourceHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resourceHelpers.js","sourceRoot":"","sources":["../../src/resourceHelpers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,OAAO,EACL,SAAS,GAOV,MAAM,cAAc,CAAC;AACtB,OAAO,EAIL,kBAAkB,EAClB,eAAe,EACf,cAAc,EACd,kBAAkB,GAEnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAC7E,OAAO,EAAE,oCAAoC,EAAE,MAAM,uDAAuD,CAAC;AAC7G,OAAO,EAAE,oCAAoC,EAAE,MAAM,uDAAuD,CAAC;AAC7G,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAElG,wHAAwH;AAExH,MAAM,UAAU,oBAAoB,CAClC,IAAS,EACT,MAAc,EACd,cAA2B,EAC3B,UAAmB,KAAK;IAExB,MAAM,aAAa,GAAQ;QACzB,MAAM,EAAE;YACN,kFAAkF;YAClF,SAAS,EAAE,IAAI;SAChB;QACD,cAAc,EAAE,cAAc;KAC/B,CAAC;IACF,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG;QAC1C,EAAE,EAAE,MAAM;KACX,CAAC;IAEF,OAAO,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;AAClF,CAAC;AAED,MAAM,UAAU,gCAAgC,CAAC,IAAU,EAAE,WAAmB,EAAE;IAChF,MAAM,gBAAgB,GAAI,IAAa,CAAC,IAAI,IAAI,QAAQ,CAAC;IACzD,IAAI,aAAa,GAAG,gBAAgB,CAAC;IACrC,IAAI,aAAa,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE;QACxD,aAAa,GAAG,aAAa,GAAG,MAAM,CAAC;KACxC;IAED,OAAO;QACL,IAAI,EAAE,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,aAAa,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;QAC1D,QAAQ,EAAE,gBAAgB;QAC1B,QAAQ,EAAE,IAAI,CAAC,IAAI;KACpB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,wBAAwB,CACtC,qBAAkC,EAClC,SAAgC,EAChC,YAAoB,EACpB,mBAA2B,EAC3B,iBAAyB,EACzB,yBAAsC,EACtC,WAAgB,EAAE,EAClB,qBAA0B,EAAE;IAE5B,qDAAqD;IACrD,gDAAgD;IAChD,wDAAwD;IACxD,2BAA2B;IAC3B,MAAM,SAAS,GAAG,QAAQ,CAAC,UAAU,IAAI,IAAI,CAAC;IAE9C,gEAAgE;IAChE,0BAA0B;IAC1B,IAAI,QAAQ,CAAC,MAAM,EAAE;QACnB,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;YAC/B,0BAA0B;YAC1B,IAAI,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,EAAE,EAAE;gBAClE,EAAE,CAAC,QAAQ,GAAG,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC,CAAC;aAC9D;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;KACJ;IAED,OAAO,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC9C,MAAM,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACvC,OAAO;gBACL,MAAM,EAAE,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM;gBACxE,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;gBACnD,GAAG,EAAE,IAAI,CAAC,GAAG;aACS,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,KAAK,yBAAyB,CAC5B,SAAS,EACT,qBAAqB,EACrB,YAAY,EACZ,iBAAiB,EACjB,yBAAyB,EACzB,QAAQ,EACR,kBAAkB,CACnB,CAAC,IAAI,CAAC,CAAC,OAAqC,EAAE,EAAE;YAC/C,MAAM,KAAK,GAAY,OAAO;gBAC5B,sBAAsB;iBACrB,MAAM,CAAC,CAAC,MAAkC,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,KAAK,cAAc,CAAC;gBACnF,kBAAkB;iBACjB,GAAG,CAAC,CAAC,MAAkC,EAAE,EAAE,CAAC,MAAM,CAAC,iBAAiB,IAAI,MAAM,CAAC,mBAAmB,CAAC;gBACpG,kCAAkC;iBACjC,MAAM,CAAC,CAAC,OAAgB,EAAE,YAAqB,EAAE,EAAE,CAAC,OAAO,IAAI,YAAY,EAAE,IAAI,CAAC,CAAC;YACtF,IAAI,KAAK,EAAE;gBACT,OAAO,CAAC,IAAI,CAAC,CAAC;aACf;iBAAM;gBACL,MAAM,EAAE,CAAC;aACV;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB,CACpC,KAAoB,EACpB,aAAqB,EACrB,qBAAkC;IAElC,OAAO,IAAI,OAAO,CAAW,CAAC,OAAO,EAAE,EAAE;QACvC,mEAAmE;QACnE,KAAK,oBAAoB,CAAC,KAAK,EAAE,aAAa,EAAE,qBAAqB,CAAC,CAAC,IAAI,CACzE,CAAC,OAAqC,EAAE,EAAE;YACxC,OAAO,CACL,OAAO;gBACL,sBAAsB;iBACrB,MAAM,CAAC,CAAC,MAAkC,EAAE,EAAE,CAAC,MAAM,CAAC,iBAAiB,IAAI,MAAM,CAAC,mBAAmB,CAAC;gBACvG,yDAAyD;iBACxD,GAAG,CAAC,CAAC,MAAkC,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,CACtF,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,+BAA+B,CAAC,MAAc;IAI5D,OAAO;QACL,MAAM,EAAE,MAAM,GAAG,gBAAgB;QACjC,QAAQ,EAAE,cAAc;KACzB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,uBAAuB,CACrC,gBAAwB,EACxB,MAAc,EACd,gBAAwB,EACxB,iBAA2B,EAC3B,UAAmB,KAAK,EACxB,cAAc,GAAG,CAAC;IAElB,MAAM,SAAS,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,EAAE;QAC3D,OAAO;YACL,MAAM;YACN,GAAG,EAAE,yBAAyB,CAAC,gBAAgB,EAAE,MAAM,EAAE,gBAAgB,CAAC;YAC1E,GAAG,oCAAoC,CAAC,MAAM,EAAE,gBAAgB,EAAE,cAAc,CAAC;SAClF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,IAAI,CAAC;QACb,MAAM;QACN,GAAG,EAAE,yBAAyB,CAAC,gBAAgB,EAAE,MAAM,EAAE,OAAO,CAAC;QACjE,GAAG,+BAA+B,CAAC,MAAM,CAAC;KAC3C,CAAC,CAAC;IAEH,0BAA0B;IAC1B,IAAI,gBAAgB,EAAE;QACpB,SAAS,CAAC,IAAI,CAAC,2BAA2B,CAAC,gBAAgB,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC;KAClG;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,2BAA2B,CACzC,gBAAwB,EACxB,MAAc,EACd,gBAAwB,EACxB,UAAmB,KAAK;IAExB,OAAO;QACL,MAAM;QACN,GAAG,EAAE,gBAAgB,CAAC,0BAA0B,CAAC,gBAAgB,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAC/G,GAAG,gCAAgC,CAAC,MAAM,EAAE,gBAAgB,CAAC;KAC9D,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,yBAAyB,CAAC,sBAA8B,EAAE,MAAc,EAAE,OAAO,GAAG,KAAK;IACvG,OAAO,CACL,uBAAuB,CAAC,sBAAsB,CAAC;QAC/C,CAAC,OAAO,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,gBAAgB,CAAC;QAClD,MAAM;QACN,6BAA6B,CAC9B,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,yBAAyB,CACvC,sBAA8B,EAC9B,MAAc,EACd,sBAA8B;IAE9B,OAAO,CACL,uBAAuB,CAAC,sBAAsB,CAAC,GAAG,gBAAgB,GAAG,MAAM,GAAG,aAAa,GAAG,sBAAsB,CACrH,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,0BAA0B,CACxC,sBAA8B,EAC9B,MAAc,EACd,gBAAwB,EACxB,OAAO,GAAG,KAAK;IAEf,OAAO,CACL,uBAAuB,CAAC,sBAAsB,CAAC;QAC/C,CAAC,OAAO,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,gBAAgB,CAAC;QAClD,MAAM;QACN,QAAQ;QACR,gBAAgB,CACjB,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,wBAAwB,CACtC,gBAAwB,EACxB,aAAqB,EACrB,oBAA8B,EAAE,EAChC,cAAc,GAAG,CAAC;IAElB,OAAO,iBAAiB,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,EAAE;QAChD,OAAO;YACL,GAAG,EAAE,yBAAyB,CAAC,gBAAgB,EAAE,aAAa,EAAE,gBAAgB,CAAC;YACjF,GAAG,oCAAoC,CAAC,gBAAgB,EAAE,cAAc,CAAC;SAC1E,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,gCAAgC,CAC9C,MAAc,EACd,YAAoB;IAKpB,MAAM,MAAM,GAAG,MAAM,GAAG,iBAAiB,CAAC;IAC1C,MAAM,iBAAiB,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAClD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAC9F,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,QAAgB;IAClD,uGAAuG;IACvG,oGAAoG;IACpG,MAAM,iBAAiB,GAAG,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IACzD,MAAM,mBAAmB,GAAG,mFAAmF,CAAC;IAChH,OAAO,CAAC,CAAC,iBAAiB,IAAI,mBAAmB,CAAC,OAAO,CAAC,GAAG,GAAG,iBAAiB,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;AACnG,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,2BAA2B,CACzC,cAA2B,EAC3B,SAAgC;IAEhC,IAAI,YAAoB,CAAC;IACzB,IAAI,iBAAyB,CAAC;IAC9B,SAAS,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACzB,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,SAAS,EAAE;YACrC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC;YACxB,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC;SACnC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KAC9B;IAED,OAAO,gBAAgB,CAAC,YAAY,EAAE,iBAAiB,EAAE,cAAc,CAAC,CAAC;AAC3E,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,sBAAsB,CACpC,MAAc,EACd,QAAgB,EAChB,cAA2B;IAE3B,OAAO,kBAAkB,CAAC;QACxB,EAAE,EAAE,MAAM;QACV,QAAQ,EAAE,QAAQ;QAClB,cAAc,EAAE,cAAc;KACD,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB,CACpC,MAAc,EACd,QAAgB,EAChB,QAAc,EACd,cAA2B;IAE3B,wCAAwC;IACxC,MAAM,qBAAqB,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAClD,MAAM,MAAM,GACV,qBAAqB,CAAC,MAAM,GAAG,CAAC;QAC9B,CAAC,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,EAAE,qBAAqB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QAC5E,CAAC,CAAC,SAAS,CAAC;IAChB,MAAM,MAAM,GAAG,qBAAqB,CAAC,qBAAqB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAEvE,OAAO,kBAAkB,CAAC;QACxB,EAAE,EAAE,MAAM;QACV,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,MAAM;QACZ,QAAQ;QACR,cAAc,EAAE,cAAc;KACP,CAAC,CAAC;AAC7B,CAAC"}

package/dist/esm/resources/add-resource.d.ts

@@ -0,0 +1,38 @@
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { UserSession } from "../arcgisRestJS";
+/**
+ * Adds a blob resource.
+ *
+ * @param blob Blob containing the resource to add
+ * @param itemId Id of the item to add the resource to
+ * @param folder A prefix string added to the filename in the storage; use null or undefined for no folder
+ * @param filename File name used to rename an existing file resource uploaded.
+ * File name must have the file resource extension.
+ * @param authentication Credentials for the request
+ */
+export declare function addBlobResource(blob: any, itemId: string, folder: string, filename: string, authentication: UserSession): Promise<any>;
+/**
+ * Adds a text resource.
+ *
+ * @param content Text to add as a resource
+ * @param itemId Id of the item to add the resource to
+ * @param folder A prefix string added to the filename in the storage; use null or undefined for no folder
+ * @param filename File name used to rename an existing file resource uploaded, or to be used together with
+ * text as file name for it. File name must have the file resource extension.
+ * @param authentication Credentials for the request
+ */
+export declare function addTextResource(content: string, itemId: string, folder: string, filename: string, authentication: UserSession): Promise<any>;

package/dist/esm/resources/add-resource.js

@@ -0,0 +1,79 @@
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ArcGISAuthError, addItemResource } from "../arcgisRestJS";
+/**
+ * Adds a blob resource.
+ *
+ * @param blob Blob containing the resource to add
+ * @param itemId Id of the item to add the resource to
+ * @param folder A prefix string added to the filename in the storage; use null or undefined for no folder
+ * @param filename File name used to rename an existing file resource uploaded.
+ * File name must have the file resource extension.
+ * @param authentication Credentials for the request
+ */
+export function addBlobResource(blob, itemId, folder, filename, authentication) {
+    // Check that the filename has an extension because it is required by the addResources call
+    if (filename && filename.indexOf(".") < 0) {
+        return new Promise((resolve, reject) => {
+            reject(new ArcGISAuthError("Filename must have an extension indicating its type"));
+        });
+    }
+    const requestOptions = {
+        id: itemId,
+        resource: blob,
+        name: filename,
+        authentication: authentication,
+        params: {},
+    };
+    if (folder) {
+        requestOptions.params = {
+            resourcesPrefix: folder,
+        };
+    }
+    return addItemResource(requestOptions);
+}
+/**
+ * Adds a text resource.
+ *
+ * @param content Text to add as a resource
+ * @param itemId Id of the item to add the resource to
+ * @param folder A prefix string added to the filename in the storage; use null or undefined for no folder
+ * @param filename File name used to rename an existing file resource uploaded, or to be used together with
+ * text as file name for it. File name must have the file resource extension.
+ * @param authentication Credentials for the request
+ */
+export function addTextResource(content, itemId, folder, filename, authentication) {
+    // Check that the filename has an extension because it is required by the addResources call
+    if (filename && filename.indexOf(".") < 0) {
+        return new Promise((resolve, reject) => {
+            reject(new ArcGISAuthError("Filename must have an extension indicating its type"));
+        });
+    }
+    const requestOptions = {
+        id: itemId,
+        content,
+        name: filename,
+        authentication: authentication,
+        params: {},
+    };
+    if (folder) {
+        requestOptions.params = {
+            resourcesPrefix: folder,
+        };
+    }
+    return addItemResource(requestOptions);
+}
+//# sourceMappingURL=add-resource.js.map

package/dist/esm/resources/add-resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-resource.js","sourceRoot":"","sources":["../../../src/resources/add-resource.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAwB,eAAe,EAAE,eAAe,EAAe,MAAM,iBAAiB,CAAC;AAEtG;;;;;;;;;GASG;AACH,MAAM,UAAU,eAAe,CAC7B,IAAS,EACT,MAAc,EACd,MAAc,EACd,QAAgB,EAChB,cAA2B;IAE3B,2FAA2F;IAC3F,IAAI,QAAQ,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QACzC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,CAAC,IAAI,eAAe,CAAC,qDAAqD,CAAC,CAAC,CAAC;QACrF,CAAC,CAAC,CAAC;KACJ;IAED,MAAM,cAAc,GAAyB;QAC3C,EAAE,EAAE,MAAM;QACV,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,QAAQ;QACd,cAAc,EAAE,cAAc;QAC9B,MAAM,EAAE,EAAE;KACX,CAAC;IACF,IAAI,MAAM,EAAE;QACV,cAAc,CAAC,MAAM,GAAG;YACtB,eAAe,EAAE,MAAM;SACxB,CAAC;KACH;IACD,OAAO,eAAe,CAAC,cAAc,CAAC,CAAC;AACzC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,eAAe,CAC7B,OAAe,EACf,MAAc,EACd,MAAc,EACd,QAAgB,EAChB,cAA2B;IAE3B,2FAA2F;IAC3F,IAAI,QAAQ,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QACzC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,CAAC,IAAI,eAAe,CAAC,qDAAqD,CAAC,CAAC,CAAC;QACrF,CAAC,CAAC,CAAC;KACJ;IAED,MAAM,cAAc,GAAyB;QAC3C,EAAE,EAAE,MAAM;QACV,OAAO;QACP,IAAI,EAAE,QAAQ;QACd,cAAc,EAAE,cAAc;QAC9B,MAAM,EAAE,EAAE;KACX,CAAC;IACF,IAAI,MAAM,EAAE;QACV,cAAc,CAAC,MAAM,GAAG;YACtB,eAAe,EAAE,MAAM;SACxB,CAAC;KACH;IACD,OAAO,eAAe,CAAC,cAAc,CAAC,CAAC;AACzC,CAAC"}

package/dist/esm/resources/addMetadataFromBlob.d.ts

@@ -0,0 +1,25 @@
+/** @license
+ * Copyright 2021 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { UserSession } from "../arcgisRestJS";
+/**
+ * Adds metadata to an AGO item.
+ *
+ * @param blob Blob containing metadata
+ * @param itemId Item to receive metadata
+ * @param authentication Credentials for the request
+ * @returns Promise resolving to JSON containing success boolean
+ */
+export declare function addMetadataFromBlob(blob: Blob, itemId: string, authentication: UserSession): Promise<any>;

package/dist/esm/resources/addMetadataFromBlob.js

@@ -0,0 +1,39 @@
+/** @license
+ * Copyright 2021 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { restUpdateItem } from "../arcgisRestJS";
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Adds metadata to an AGO item.
+ *
+ * @param blob Blob containing metadata
+ * @param itemId Item to receive metadata
+ * @param authentication Credentials for the request
+ * @returns Promise resolving to JSON containing success boolean
+ */
+export function addMetadataFromBlob(blob, itemId, authentication) {
+    const updateOptions = {
+        item: {
+            id: itemId,
+        },
+        params: {
+            // Pass metadata in via params because item property is serialized, which discards a blob
+            metadata: blob,
+        },
+        authentication: authentication,
+    };
+    return restUpdateItem(updateOptions);
+}
+//# sourceMappingURL=addMetadataFromBlob.js.map

package/dist/esm/resources/addMetadataFromBlob.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addMetadataFromBlob.js","sourceRoot":"","sources":["../../../src/resources/addMetadataFromBlob.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,cAAc,EAAe,MAAM,iBAAiB,CAAC;AAE9D,wHAAwH;AAExH;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAU,EAAE,MAAc,EAAE,cAA2B;IACzF,MAAM,aAAa,GAAQ;QACzB,IAAI,EAAE;YACJ,EAAE,EAAE,MAAM;SACX;QACD,MAAM,EAAE;YACN,yFAAyF;YACzF,QAAQ,EAAE,IAAI;SACf;QACD,cAAc,EAAE,cAAc;KAC/B,CAAC;IACF,OAAO,cAAc,CAAC,aAAa,CAAC,CAAC;AACvC,CAAC"}

package/dist/esm/resources/convert-item-resource-to-storage-resource.d.ts

@@ -0,0 +1,32 @@
+/** @license
+ * Copyright 2020 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { SolutionResourceType } from "./solution-resource";
+/**
+ * Generates a folder and filename for storing a copy of an item's resource in a storage item.
+ *
+ * @param prefix Base prefix for resource
+ * @param sourceResourceFilename Either filename or folder/filename to resource
+ * @param storageVersion Version of the Solution template
+ * @param storageFileType Optional argument that when supplied will control the how the prefix is created
+ * @returns Folder and filename for storage; folder is the itemID plus ("_" + storageFolder) if storageFolder
+ * exists plus ("_" + part of sourceResourceFilename before "/" if that separator exists);
+ * file is sourceResourceFilename
+ * @see convertStorageResourceToItemResource
+ */
+export declare function convertItemResourceToStorageResource(prefix: string, sourceResourceFilename: string, storageVersion?: number, storageFileType?: SolutionResourceType): {
+    folder: string;
+    filename: string;
+};

package/dist/esm/resources/convert-item-resource-to-storage-resource.js

@@ -0,0 +1,66 @@
+/** @license
+ * Copyright 2020 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { SolutionResourceType } from "./solution-resource";
+/**
+ * Generates a folder and filename for storing a copy of an item's resource in a storage item.
+ *
+ * @param prefix Base prefix for resource
+ * @param sourceResourceFilename Either filename or folder/filename to resource
+ * @param storageVersion Version of the Solution template
+ * @param storageFileType Optional argument that when supplied will control the how the prefix is created
+ * @returns Folder and filename for storage; folder is the itemID plus ("_" + storageFolder) if storageFolder
+ * exists plus ("_" + part of sourceResourceFilename before "/" if that separator exists);
+ * file is sourceResourceFilename
+ * @see convertStorageResourceToItemResource
+ */
+export function convertItemResourceToStorageResource(prefix, sourceResourceFilename, storageVersion = 0, storageFileType) {
+    /* istanbul ignore else */
+    if (storageFileType !== undefined) {
+        switch (storageFileType) {
+            case SolutionResourceType.data:
+                prefix = `${prefix}_info_data`;
+                break;
+            case SolutionResourceType.fakezip:
+                prefix = `${prefix}_info_dataz`;
+                break;
+            case SolutionResourceType.info:
+                prefix = `${prefix}_info`;
+                break;
+            case SolutionResourceType.metadata:
+                prefix = `${prefix}_info_metadata`;
+                break;
+            case SolutionResourceType.thumbnail:
+                prefix = `${prefix}_info_thumbnail`;
+                break;
+        }
+    }
+    let folder = prefix;
+    let filename = sourceResourceFilename;
+    const iLastSlash = filename.lastIndexOf("/");
+    if (iLastSlash >= 0) {
+        let subpath = filename.substr(0, iLastSlash);
+        if (storageVersion === 0) {
+            subpath = subpath.replace("/", "_");
+            folder += "_" + subpath;
+        }
+        else {
+            folder += "/" + subpath;
+        }
+        filename = filename.substr(iLastSlash + 1);
+    }
+    return { folder, filename };
+}
+//# sourceMappingURL=convert-item-resource-to-storage-resource.js.map