@esri/solution-common 4.1.2 → 5.0.0

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

@@ -1,70 +1,70 @@
-"use strict";
-/** @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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertStorageResourceToItemResource = void 0;
-const interfaces_1 = require("../interfaces");
-/**
- * Extracts an item's resource folder and filename from the filename used to store a copy in a storage item.
- *
- * @param storageResourceFilename Filename used to store the resource, metadata, or thumbnail of an item
- * @param storageVersion Version of the Solution template
- * @returns Folder and filename for storing information in an item, as well as the type (resource, metadata,
- * or thumbnail) of the information; the folder property is only meaningful for the resource type
- * @see generateResourceStorageFilename
- * @see generateMetadataStorageFilename
- * @see generateThumbnailStorageFilename
- * @see convertItemResourceToStorageResource
- */
-function convertStorageResourceToItemResource(storageResourceFilename, storageVersion = 0) {
-    const nameParts = storageResourceFilename.split("/");
-    let filename = nameParts.pop();
-    let folder = "";
-    const firstPrefixPart = nameParts.shift(); // undefined if there's no folder
-    // Handle special "folders"
-    let type = interfaces_1.EFileType.Resource;
-    if (firstPrefixPart) {
-        if (firstPrefixPart.endsWith("_info_thumbnail")) {
-            type = interfaces_1.EFileType.Thumbnail;
-        }
-        else if (firstPrefixPart.endsWith("_info_metadata")) {
-            type = interfaces_1.EFileType.Metadata;
-            filename = "metadata.xml";
-        }
-        else if (firstPrefixPart.endsWith("_info_data")) {
-            type = interfaces_1.EFileType.Data;
-        }
-        else if (firstPrefixPart.endsWith("_info_dataz")) {
-            filename = filename.replace(/\.zip$/, "");
-            type = interfaces_1.EFileType.Data;
-            // Otherwise, strip off item id
-        }
-        else if (storageVersion < 1) {
-            // Version 0
-            const folderStart = firstPrefixPart.indexOf("_");
-            if (folderStart > 0) {
-                folder = firstPrefixPart.substr(folderStart + 1);
-            }
-        }
-        else {
-            // Version ≥ 1
-            folder = nameParts.join("/"); // folder is optional, in which case this will be ""
-        }
-    }
-    return { type, folder, filename };
-}
-exports.convertStorageResourceToItemResource = convertStorageResourceToItemResource;
+"use strict";
+/** @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertStorageResourceToItemResource = void 0;
+const interfaces_1 = require("../interfaces");
+/**
+ * Extracts an item's resource folder and filename from the filename used to store a copy in a storage item.
+ *
+ * @param storageResourceFilename Filename used to store the resource, metadata, or thumbnail of an item
+ * @param storageVersion Version of the Solution template
+ * @returns Folder and filename for storing information in an item, as well as the type (resource, metadata,
+ * or thumbnail) of the information; the folder property is only meaningful for the resource type
+ * @see generateResourceStorageFilename
+ * @see generateMetadataStorageFilename
+ * @see generateThumbnailStorageFilename
+ * @see convertItemResourceToStorageResource
+ */
+function convertStorageResourceToItemResource(storageResourceFilename, storageVersion = 0) {
+    const nameParts = storageResourceFilename.split("/");
+    let filename = nameParts.pop();
+    let folder = "";
+    const firstPrefixPart = nameParts.shift(); // undefined if there's no folder
+    // Handle special "folders"
+    let type = interfaces_1.EFileType.Resource;
+    if (firstPrefixPart) {
+        if (firstPrefixPart.endsWith("_info_thumbnail")) {
+            type = interfaces_1.EFileType.Thumbnail;
+        }
+        else if (firstPrefixPart.endsWith("_info_metadata")) {
+            type = interfaces_1.EFileType.Metadata;
+            filename = "metadata.xml";
+        }
+        else if (firstPrefixPart.endsWith("_info_data")) {
+            type = interfaces_1.EFileType.Data;
+        }
+        else if (firstPrefixPart.endsWith("_info_dataz")) {
+            filename = filename.replace(/\.zip$/, "");
+            type = interfaces_1.EFileType.Data;
+            // Otherwise, strip off item id
+        }
+        else if (storageVersion < 1) {
+            // Version 0
+            const folderStart = firstPrefixPart.indexOf("_");
+            if (folderStart > 0) {
+                folder = firstPrefixPart.substr(folderStart + 1);
+            }
+        }
+        else {
+            // Version ≥ 1
+            folder = nameParts.join("/"); // folder is optional, in which case this will be ""
+        }
+    }
+    return { type, folder, filename };
+}
+exports.convertStorageResourceToItemResource = convertStorageResourceToItemResource;
 //# sourceMappingURL=convert-storage-resource-to-item-resource.js.map

package/dist/cjs/resources/copyAssociatedFiles.d.ts

@@ -1,67 +1,67 @@
-/** @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.
- */
-/**
- * Provides functions for sending resources to AGO.
- */
-import { IAssociatedFileCopyResults, IAssociatedFileInfo, IItemTemplate, ISourceFile, IZipInfo, UserSession } from "../interfaces";
-/**
- * Copies the files for storing the resources, metadata, and thumbnail of an item or group to a storage item
- * with a specified path by collecting files into zip files.
- *
- * @param files List of item files' URLs and folder/filenames for storing the files
- * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
- * @param destinationAuthentication Credentials for the request to the storage
- * @param filesPerZip Number of files to include per zip file; AGO limits zips to 50 files
- * @returns A promise which resolves to a list of the result of the copies
- */
-export declare function copyFilesAsResources(files: ISourceFile[], destinationItemId: string, destinationAuthentication: UserSession, filesPerZip?: number): Promise<IAssociatedFileCopyResults[]>;
-/**
- * Copies the files described by a list of full URLs and storage folder/filename combinations for storing
- * the resources, metadata, and thumbnail of an item or group to a storage item with different
- * handling based on the type of file.
- *
- * @param fileInfos List of item files' URLs and folder/filenames for storing the files
- * @param sourceAuthentication Credentials for the request to the source
- * @param sourceItemId Id of item supplying resource/metadata
- * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
- * @param destinationAuthentication Credentials for the request to the storage
- * @param template Description of item that will receive files
- * @returns A promise which resolves to a list of the result of the copies
- */
-export declare function copyAssociatedFilesByType(fileInfos: IAssociatedFileInfo[], sourceAuthentication: UserSession, sourceItemId: string, destinationItemId: string, destinationAuthentication: UserSession, template?: any): Promise<IAssociatedFileCopyResults[]>;
-/**
- * Copies one or more zipfiles to a storage item.
- *
- * @param zipInfos List of zip files containing files to store
- * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
- * @param destinationAuthentication Credentials for the request to the storage
- * @returns A promise which resolves to a list of the result of the copies
- * @private
- */
-export declare function _copyAssociatedFileZips(zipInfos: IZipInfo[], destinationItemId: string, destinationAuthentication: UserSession): Promise<IAssociatedFileCopyResults[]>;
-/**
- * Replace templatizations in an item's resources
- *
- * @param sourceAuthentication Credentials for the request to the source
- * @param sourceItemId Id of item supplying resource/metadata
- * @param itemTemplate Item being created
- * @param fileInfos Resources for the item; these resources are modified as needed
- * by removing the templatization: the `url` property is replaced by the `file` property
- * @param destinationAuthentication Credentials for the request to the storage
- *
- * @returns A promise that resolves when all de-templatization has completed
- */
-export declare function _detemplatizeResources(sourceAuthentication: UserSession, sourceItemId: string, itemTemplate: IItemTemplate, fileInfos: IAssociatedFileInfo[], destinationAuthentication: UserSession): Promise<void[]>;
+/** @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.
+ */
+/**
+ * Provides functions for sending resources to AGO.
+ */
+import { IAssociatedFileCopyResults, IAssociatedFileInfo, IItemTemplate, ISourceFile, IZipInfo, UserSession } from "../interfaces";
+/**
+ * Copies the files for storing the resources, metadata, and thumbnail of an item or group to a storage item
+ * with a specified path by collecting files into zip files.
+ *
+ * @param files List of item files' URLs and folder/filenames for storing the files
+ * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
+ * @param destinationAuthentication Credentials for the request to the storage
+ * @param filesPerZip Number of files to include per zip file; AGO limits zips to 50 files
+ * @returns A promise which resolves to a list of the result of the copies
+ */
+export declare function copyFilesAsResources(files: ISourceFile[], destinationItemId: string, destinationAuthentication: UserSession, filesPerZip?: number): Promise<IAssociatedFileCopyResults[]>;
+/**
+ * Copies the files described by a list of full URLs and storage folder/filename combinations for storing
+ * the resources, metadata, and thumbnail of an item or group to a storage item with different
+ * handling based on the type of file.
+ *
+ * @param fileInfos List of item files' URLs and folder/filenames for storing the files
+ * @param sourceAuthentication Credentials for the request to the source
+ * @param sourceItemId Id of item supplying resource/metadata
+ * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
+ * @param destinationAuthentication Credentials for the request to the storage
+ * @param template Description of item that will receive files
+ * @returns A promise which resolves to a list of the result of the copies
+ */
+export declare function copyAssociatedFilesByType(fileInfos: IAssociatedFileInfo[], sourceAuthentication: UserSession, sourceItemId: string, destinationItemId: string, destinationAuthentication: UserSession, template?: any): Promise<IAssociatedFileCopyResults[]>;
+/**
+ * Copies one or more zipfiles to a storage item.
+ *
+ * @param zipInfos List of zip files containing files to store
+ * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
+ * @param destinationAuthentication Credentials for the request to the storage
+ * @returns A promise which resolves to a list of the result of the copies
+ * @private
+ */
+export declare function _copyAssociatedFileZips(zipInfos: IZipInfo[], destinationItemId: string, destinationAuthentication: UserSession): Promise<IAssociatedFileCopyResults[]>;
+/**
+ * Replace templatizations in an item's resources
+ *
+ * @param sourceAuthentication Credentials for the request to the source
+ * @param sourceItemId Id of item supplying resource/metadata
+ * @param itemTemplate Item being created
+ * @param fileInfos Resources for the item; these resources are modified as needed
+ * by removing the templatization: the `url` property is replaced by the `file` property
+ * @param destinationAuthentication Credentials for the request to the storage
+ *
+ * @returns A promise that resolves when all de-templatization has completed
+ */
+export declare function _detemplatizeResources(sourceAuthentication: UserSession, sourceItemId: string, itemTemplate: IItemTemplate, fileInfos: IAssociatedFileInfo[], destinationAuthentication: UserSession): Promise<void[]>;