@esri/solution-file 4.1.2 → 5.0.1

package/dist/cjs/file.d.ts

@@ -1,32 +1,32 @@
-/** @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.
- */
-/**
- * Manages the creation and deployment of item types that contain files.
- *
- * @module file
- */
-import * as common from "@esri/solution-common";
-/**
- * Converts a file item into a template.
- *
- * @param solutionItemId The solution to contain the template
- * @param itemInfo Info about the item
- * @param destAuthentication Credentials for requests to the destination organization
- * @param srcAuthentication Credentials for requests to source items
- * @returns A promise that will resolve when the template has been created
- */
-export declare function convertItemToTemplate(solutionItemId: string, itemInfo: any, destAuthentication: common.UserSession, srcAuthentication: common.UserSession): Promise<common.IItemTemplate>;
-export declare function createItemFromTemplate(template: common.IItemTemplate, templateDictionary: any, destinationAuthentication: common.UserSession, itemProgressCallback: common.IItemProgressCallback): Promise<common.ICreateItemFromTemplateResponse>;
+/** @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.
+ */
+/**
+ * Manages the creation and deployment of item types that contain files.
+ *
+ * @module file
+ */
+import * as common from "@esri/solution-common";
+/**
+ * Converts a file item into a template.
+ *
+ * @param solutionItemId The solution to contain the template
+ * @param itemInfo Info about the item
+ * @param destAuthentication Credentials for requests to the destination organization
+ * @param srcAuthentication Credentials for requests to source items
+ * @returns A promise that will resolve when the template has been created
+ */
+export declare function convertItemToTemplate(solutionItemId: string, itemInfo: any, destAuthentication: common.UserSession, srcAuthentication: common.UserSession): Promise<common.IItemTemplate>;
+export declare function createItemFromTemplate(template: common.IItemTemplate, templateDictionary: any, destinationAuthentication: common.UserSession, itemProgressCallback: common.IItemProgressCallback): Promise<common.ICreateItemFromTemplateResponse>;

package/dist/cjs/file.js

@@ -1,134 +1,134 @@
-"use strict";
-/** @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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createItemFromTemplate = exports.convertItemToTemplate = void 0;
-const tslib_1 = require("tslib");
-/**
- * Manages the creation and deployment of item types that contain files.
- *
- * @module file
- */
-const common = tslib_1.__importStar(require("@esri/solution-common"));
-// ------------------------------------------------------------------------------------------------------------------ //
-/**
- * Converts a file item into a template.
- *
- * @param solutionItemId The solution to contain the template
- * @param itemInfo Info about the item
- * @param destAuthentication Credentials for requests to the destination organization
- * @param srcAuthentication Credentials for requests to source items
- * @returns A promise that will resolve when the template has been created
- */
-function convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication) {
-    return new Promise(resolve => {
-        // Init template
-        const itemTemplate = common.createInitializedItemTemplate(itemInfo);
-        // Templatize item info property values
-        itemTemplate.item.id = common.templatizeTerm(itemTemplate.item.id, itemTemplate.item.id, ".itemId");
-        // Request file
-        const dataPromise = new Promise(dataResolve => {
-            // eslint-disable-next-line @typescript-eslint/no-floating-promises
-            common
-                .getItemDataAsFile(itemTemplate.itemId, itemTemplate.item.name, srcAuthentication)
-                .then(response => {
-                if (!response || response.size === 0) {
-                    dataResolve(null);
-                }
-                else {
-                    dataResolve(response);
-                }
-            });
-        });
-        // Request related items
-        const relatedPromise = Promise.resolve({});
-        // Errors are handled as resolved empty values; this means that there's no `reject` clause to handle, hence:
-        // eslint-disable-next-line @typescript-eslint/no-floating-promises
-        Promise.all([dataPromise, relatedPromise]).then(responses => {
-            const [itemDataResponse] = responses;
-            if (itemDataResponse) {
-                const resource = common.convertBlobToSupportableResource(itemDataResponse, itemTemplate.item.name);
-                itemTemplate.properties[resource.filename] = resource.mimeType;
-                const storageName = common.convertItemResourceToStorageResource(itemTemplate.itemId, resource.blob.name, common.SolutionTemplateFormatVersion, (resource.blob.name === resource.filename
-                    ? common.SolutionResourceType.data
-                    : common.SolutionResourceType.fakezip));
-                // Add the data file to the template so that it can be uploaded with the other resources in the solution
-                const dataFile = {
-                    itemId: itemTemplate.itemId,
-                    file: resource.blob,
-                    folder: storageName.folder,
-                    filename: storageName.filename
-                };
-                itemTemplate.dataFile = dataFile;
-                // Update the template's resources
-                itemTemplate.resources.push(storageName.folder + "/" + storageName.filename);
-                resolve(itemTemplate);
-            }
-            else {
-                resolve(itemTemplate);
-            }
-        });
-    });
-}
-exports.convertItemToTemplate = convertItemToTemplate;
-function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
-    return new Promise(resolve => {
-        // Interrupt process if progress callback returns `false`
-        if (!itemProgressCallback(template.itemId, common.EItemProgressStatus.Started, 0)) {
-            itemProgressCallback(template.itemId, common.EItemProgressStatus.Ignored, 0);
-            resolve(common.generateEmptyCreationResponse(template.type));
-            return;
-        }
-        // Replace the templatized symbols in a copy of the template
-        let newItemTemplate = common.cloneObject(template);
-        newItemTemplate = common.replaceInTemplate(newItemTemplate, templateDictionary);
-        /* istanbul ignore else */
-        if (template.item.thumbnail) {
-            newItemTemplate.item.thumbnail = template.item.thumbnail;
-        }
-        // Create the item, then update its URL with its new id
-        common
-            .createItemWithData(newItemTemplate.item, newItemTemplate.data, destinationAuthentication, templateDictionary.folderId)
-            .then(createResponse => {
-            // Interrupt process if progress callback returns `false`
-            if (!itemProgressCallback(template.itemId, common.EItemProgressStatus.Created, template.estimatedDeploymentCostFactor / 2, createResponse.id)) {
-                itemProgressCallback(template.itemId, common.EItemProgressStatus.Cancelled, 0);
-                common
-                    .removeItem(createResponse.id, destinationAuthentication)
-                    .then(() => resolve(common.generateEmptyCreationResponse(template.type)), () => resolve(common.generateEmptyCreationResponse(template.type)));
-            }
-            else {
-                // Add the new item to the settings
-                newItemTemplate.itemId = createResponse.id;
-                templateDictionary[template.itemId] = {
-                    itemId: createResponse.id
-                };
-                itemProgressCallback(template.itemId, common.EItemProgressStatus.Finished, template.estimatedDeploymentCostFactor / 2, createResponse.id);
-                resolve({
-                    item: newItemTemplate,
-                    id: createResponse.id,
-                    type: newItemTemplate.type,
-                    postProcess: false
-                });
-            }
-        }, () => {
-            itemProgressCallback(template.itemId, common.EItemProgressStatus.Failed, 0);
-            resolve(common.generateEmptyCreationResponse(template.type)); // fails to create item
-        });
-    });
-}
-exports.createItemFromTemplate = createItemFromTemplate;
+"use strict";
+/** @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createItemFromTemplate = exports.convertItemToTemplate = void 0;
+const tslib_1 = require("tslib");
+/**
+ * Manages the creation and deployment of item types that contain files.
+ *
+ * @module file
+ */
+const common = tslib_1.__importStar(require("@esri/solution-common"));
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Converts a file item into a template.
+ *
+ * @param solutionItemId The solution to contain the template
+ * @param itemInfo Info about the item
+ * @param destAuthentication Credentials for requests to the destination organization
+ * @param srcAuthentication Credentials for requests to source items
+ * @returns A promise that will resolve when the template has been created
+ */
+function convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication) {
+    return new Promise(resolve => {
+        // Init template
+        const itemTemplate = common.createInitializedItemTemplate(itemInfo);
+        // Templatize item info property values
+        itemTemplate.item.id = common.templatizeTerm(itemTemplate.item.id, itemTemplate.item.id, ".itemId");
+        // Request file
+        const dataPromise = new Promise(dataResolve => {
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises
+            common
+                .getItemDataAsFile(itemTemplate.itemId, itemTemplate.item.name, srcAuthentication)
+                .then(response => {
+                if (!response || response.size === 0) {
+                    dataResolve(null);
+                }
+                else {
+                    dataResolve(response);
+                }
+            });
+        });
+        // Request related items
+        const relatedPromise = Promise.resolve({});
+        // Errors are handled as resolved empty values; this means that there's no `reject` clause to handle, hence:
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        Promise.all([dataPromise, relatedPromise]).then(responses => {
+            const [itemDataResponse] = responses;
+            if (itemDataResponse) {
+                const resource = common.convertBlobToSupportableResource(itemDataResponse, itemTemplate.item.name);
+                itemTemplate.properties[resource.filename] = resource.mimeType;
+                const storageName = common.convertItemResourceToStorageResource(itemTemplate.itemId, resource.blob.name, common.SolutionTemplateFormatVersion, (resource.blob.name === resource.filename
+                    ? common.SolutionResourceType.data
+                    : common.SolutionResourceType.fakezip));
+                // Add the data file to the template so that it can be uploaded with the other resources in the solution
+                const dataFile = {
+                    itemId: itemTemplate.itemId,
+                    file: resource.blob,
+                    folder: storageName.folder,
+                    filename: storageName.filename
+                };
+                itemTemplate.dataFile = dataFile;
+                // Update the template's resources
+                itemTemplate.resources.push(storageName.folder + "/" + storageName.filename);
+                resolve(itemTemplate);
+            }
+            else {
+                resolve(itemTemplate);
+            }
+        });
+    });
+}
+exports.convertItemToTemplate = convertItemToTemplate;
+function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
+    return new Promise(resolve => {
+        // Interrupt process if progress callback returns `false`
+        if (!itemProgressCallback(template.itemId, common.EItemProgressStatus.Started, 0)) {
+            itemProgressCallback(template.itemId, common.EItemProgressStatus.Ignored, 0);
+            resolve(common.generateEmptyCreationResponse(template.type));
+            return;
+        }
+        // Replace the templatized symbols in a copy of the template
+        let newItemTemplate = common.cloneObject(template);
+        newItemTemplate = common.replaceInTemplate(newItemTemplate, templateDictionary);
+        /* istanbul ignore else */
+        if (template.item.thumbnail) {
+            newItemTemplate.item.thumbnail = template.item.thumbnail;
+        }
+        // Create the item, then update its URL with its new id
+        common
+            .createItemWithData(newItemTemplate.item, newItemTemplate.data, destinationAuthentication, templateDictionary.folderId)
+            .then(createResponse => {
+            // Interrupt process if progress callback returns `false`
+            if (!itemProgressCallback(template.itemId, common.EItemProgressStatus.Created, template.estimatedDeploymentCostFactor / 2, createResponse.id)) {
+                itemProgressCallback(template.itemId, common.EItemProgressStatus.Cancelled, 0);
+                common
+                    .removeItem(createResponse.id, destinationAuthentication)
+                    .then(() => resolve(common.generateEmptyCreationResponse(template.type)), () => resolve(common.generateEmptyCreationResponse(template.type)));
+            }
+            else {
+                // Add the new item to the settings
+                newItemTemplate.itemId = createResponse.id;
+                templateDictionary[template.itemId] = {
+                    itemId: createResponse.id
+                };
+                itemProgressCallback(template.itemId, common.EItemProgressStatus.Finished, template.estimatedDeploymentCostFactor / 2, createResponse.id);
+                resolve({
+                    item: newItemTemplate,
+                    id: createResponse.id,
+                    type: newItemTemplate.type,
+                    postProcess: false
+                });
+            }
+        }, () => {
+            itemProgressCallback(template.itemId, common.EItemProgressStatus.Failed, 0);
+            resolve(common.generateEmptyCreationResponse(template.type)); // fails to create item
+        });
+    });
+}
+exports.createItemFromTemplate = createItemFromTemplate;
 //# sourceMappingURL=file.js.map

package/dist/cjs/index.d.ts

@@ -1,21 +1,21 @@
-/** @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.
- */
-/**
- * Manages the creation and deployment of item types that contain files.
- *
- * @module file
- */
-export * from "./file";
+/** @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.
+ */
+/**
+ * Manages the creation and deployment of item types that contain files.
+ *
+ * @module file
+ */
+export * from "./file";

package/dist/cjs/index.js

@@ -1,25 +1,25 @@
-"use strict";
-/** @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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-/**
- * Manages the creation and deployment of item types that contain files.
- *
- * @module file
- */
-tslib_1.__exportStar(require("./file"), exports);
+"use strict";
+/** @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/**
+ * Manages the creation and deployment of item types that contain files.
+ *
+ * @module file
+ */
+tslib_1.__exportStar(require("./file"), exports);
 //# sourceMappingURL=index.js.map

package/dist/esm/file.d.ts

@@ -1,32 +1,32 @@
-/** @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.
- */
-/**
- * Manages the creation and deployment of item types that contain files.
- *
- * @module file
- */
-import * as common from "@esri/solution-common";
-/**
- * Converts a file item into a template.
- *
- * @param solutionItemId The solution to contain the template
- * @param itemInfo Info about the item
- * @param destAuthentication Credentials for requests to the destination organization
- * @param srcAuthentication Credentials for requests to source items
- * @returns A promise that will resolve when the template has been created
- */
-export declare function convertItemToTemplate(solutionItemId: string, itemInfo: any, destAuthentication: common.UserSession, srcAuthentication: common.UserSession): Promise<common.IItemTemplate>;
-export declare function createItemFromTemplate(template: common.IItemTemplate, templateDictionary: any, destinationAuthentication: common.UserSession, itemProgressCallback: common.IItemProgressCallback): Promise<common.ICreateItemFromTemplateResponse>;
+/** @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.
+ */
+/**
+ * Manages the creation and deployment of item types that contain files.
+ *
+ * @module file
+ */
+import * as common from "@esri/solution-common";
+/**
+ * Converts a file item into a template.
+ *
+ * @param solutionItemId The solution to contain the template
+ * @param itemInfo Info about the item
+ * @param destAuthentication Credentials for requests to the destination organization
+ * @param srcAuthentication Credentials for requests to source items
+ * @returns A promise that will resolve when the template has been created
+ */
+export declare function convertItemToTemplate(solutionItemId: string, itemInfo: any, destAuthentication: common.UserSession, srcAuthentication: common.UserSession): Promise<common.IItemTemplate>;
+export declare function createItemFromTemplate(template: common.IItemTemplate, templateDictionary: any, destinationAuthentication: common.UserSession, itemProgressCallback: common.IItemProgressCallback): Promise<common.ICreateItemFromTemplateResponse>;

package/dist/esm/file.js

@@ -1,128 +1,128 @@
-/** @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.
- */
-/**
- * Manages the creation and deployment of item types that contain files.
- *
- * @module file
- */
-import * as common from "@esri/solution-common";
-// ------------------------------------------------------------------------------------------------------------------ //
-/**
- * Converts a file item into a template.
- *
- * @param solutionItemId The solution to contain the template
- * @param itemInfo Info about the item
- * @param destAuthentication Credentials for requests to the destination organization
- * @param srcAuthentication Credentials for requests to source items
- * @returns A promise that will resolve when the template has been created
- */
-export function convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication) {
-    return new Promise(resolve => {
-        // Init template
-        const itemTemplate = common.createInitializedItemTemplate(itemInfo);
-        // Templatize item info property values
-        itemTemplate.item.id = common.templatizeTerm(itemTemplate.item.id, itemTemplate.item.id, ".itemId");
-        // Request file
-        const dataPromise = new Promise(dataResolve => {
-            // eslint-disable-next-line @typescript-eslint/no-floating-promises
-            common
-                .getItemDataAsFile(itemTemplate.itemId, itemTemplate.item.name, srcAuthentication)
-                .then(response => {
-                if (!response || response.size === 0) {
-                    dataResolve(null);
-                }
-                else {
-                    dataResolve(response);
-                }
-            });
-        });
-        // Request related items
-        const relatedPromise = Promise.resolve({});
-        // Errors are handled as resolved empty values; this means that there's no `reject` clause to handle, hence:
-        // eslint-disable-next-line @typescript-eslint/no-floating-promises
-        Promise.all([dataPromise, relatedPromise]).then(responses => {
-            const [itemDataResponse] = responses;
-            if (itemDataResponse) {
-                const resource = common.convertBlobToSupportableResource(itemDataResponse, itemTemplate.item.name);
-                itemTemplate.properties[resource.filename] = resource.mimeType;
-                const storageName = common.convertItemResourceToStorageResource(itemTemplate.itemId, resource.blob.name, common.SolutionTemplateFormatVersion, (resource.blob.name === resource.filename
-                    ? common.SolutionResourceType.data
-                    : common.SolutionResourceType.fakezip));
-                // Add the data file to the template so that it can be uploaded with the other resources in the solution
-                const dataFile = {
-                    itemId: itemTemplate.itemId,
-                    file: resource.blob,
-                    folder: storageName.folder,
-                    filename: storageName.filename
-                };
-                itemTemplate.dataFile = dataFile;
-                // Update the template's resources
-                itemTemplate.resources.push(storageName.folder + "/" + storageName.filename);
-                resolve(itemTemplate);
-            }
-            else {
-                resolve(itemTemplate);
-            }
-        });
-    });
-}
-export function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
-    return new Promise(resolve => {
-        // Interrupt process if progress callback returns `false`
-        if (!itemProgressCallback(template.itemId, common.EItemProgressStatus.Started, 0)) {
-            itemProgressCallback(template.itemId, common.EItemProgressStatus.Ignored, 0);
-            resolve(common.generateEmptyCreationResponse(template.type));
-            return;
-        }
-        // Replace the templatized symbols in a copy of the template
-        let newItemTemplate = common.cloneObject(template);
-        newItemTemplate = common.replaceInTemplate(newItemTemplate, templateDictionary);
-        /* istanbul ignore else */
-        if (template.item.thumbnail) {
-            newItemTemplate.item.thumbnail = template.item.thumbnail;
-        }
-        // Create the item, then update its URL with its new id
-        common
-            .createItemWithData(newItemTemplate.item, newItemTemplate.data, destinationAuthentication, templateDictionary.folderId)
-            .then(createResponse => {
-            // Interrupt process if progress callback returns `false`
-            if (!itemProgressCallback(template.itemId, common.EItemProgressStatus.Created, template.estimatedDeploymentCostFactor / 2, createResponse.id)) {
-                itemProgressCallback(template.itemId, common.EItemProgressStatus.Cancelled, 0);
-                common
-                    .removeItem(createResponse.id, destinationAuthentication)
-                    .then(() => resolve(common.generateEmptyCreationResponse(template.type)), () => resolve(common.generateEmptyCreationResponse(template.type)));
-            }
-            else {
-                // Add the new item to the settings
-                newItemTemplate.itemId = createResponse.id;
-                templateDictionary[template.itemId] = {
-                    itemId: createResponse.id
-                };
-                itemProgressCallback(template.itemId, common.EItemProgressStatus.Finished, template.estimatedDeploymentCostFactor / 2, createResponse.id);
-                resolve({
-                    item: newItemTemplate,
-                    id: createResponse.id,
-                    type: newItemTemplate.type,
-                    postProcess: false
-                });
-            }
-        }, () => {
-            itemProgressCallback(template.itemId, common.EItemProgressStatus.Failed, 0);
-            resolve(common.generateEmptyCreationResponse(template.type)); // fails to create item
-        });
-    });
-}
+/** @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.
+ */
+/**
+ * Manages the creation and deployment of item types that contain files.
+ *
+ * @module file
+ */
+import * as common from "@esri/solution-common";
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Converts a file item into a template.
+ *
+ * @param solutionItemId The solution to contain the template
+ * @param itemInfo Info about the item
+ * @param destAuthentication Credentials for requests to the destination organization
+ * @param srcAuthentication Credentials for requests to source items
+ * @returns A promise that will resolve when the template has been created
+ */
+export function convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication) {
+    return new Promise(resolve => {
+        // Init template
+        const itemTemplate = common.createInitializedItemTemplate(itemInfo);
+        // Templatize item info property values
+        itemTemplate.item.id = common.templatizeTerm(itemTemplate.item.id, itemTemplate.item.id, ".itemId");
+        // Request file
+        const dataPromise = new Promise(dataResolve => {
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises
+            common
+                .getItemDataAsFile(itemTemplate.itemId, itemTemplate.item.name, srcAuthentication)
+                .then(response => {
+                if (!response || response.size === 0) {
+                    dataResolve(null);
+                }
+                else {
+                    dataResolve(response);
+                }
+            });
+        });
+        // Request related items
+        const relatedPromise = Promise.resolve({});
+        // Errors are handled as resolved empty values; this means that there's no `reject` clause to handle, hence:
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        Promise.all([dataPromise, relatedPromise]).then(responses => {
+            const [itemDataResponse] = responses;
+            if (itemDataResponse) {
+                const resource = common.convertBlobToSupportableResource(itemDataResponse, itemTemplate.item.name);
+                itemTemplate.properties[resource.filename] = resource.mimeType;
+                const storageName = common.convertItemResourceToStorageResource(itemTemplate.itemId, resource.blob.name, common.SolutionTemplateFormatVersion, (resource.blob.name === resource.filename
+                    ? common.SolutionResourceType.data
+                    : common.SolutionResourceType.fakezip));
+                // Add the data file to the template so that it can be uploaded with the other resources in the solution
+                const dataFile = {
+                    itemId: itemTemplate.itemId,
+                    file: resource.blob,
+                    folder: storageName.folder,
+                    filename: storageName.filename
+                };
+                itemTemplate.dataFile = dataFile;
+                // Update the template's resources
+                itemTemplate.resources.push(storageName.folder + "/" + storageName.filename);
+                resolve(itemTemplate);
+            }
+            else {
+                resolve(itemTemplate);
+            }
+        });
+    });
+}
+export function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
+    return new Promise(resolve => {
+        // Interrupt process if progress callback returns `false`
+        if (!itemProgressCallback(template.itemId, common.EItemProgressStatus.Started, 0)) {
+            itemProgressCallback(template.itemId, common.EItemProgressStatus.Ignored, 0);
+            resolve(common.generateEmptyCreationResponse(template.type));
+            return;
+        }
+        // Replace the templatized symbols in a copy of the template
+        let newItemTemplate = common.cloneObject(template);
+        newItemTemplate = common.replaceInTemplate(newItemTemplate, templateDictionary);
+        /* istanbul ignore else */
+        if (template.item.thumbnail) {
+            newItemTemplate.item.thumbnail = template.item.thumbnail;
+        }
+        // Create the item, then update its URL with its new id
+        common
+            .createItemWithData(newItemTemplate.item, newItemTemplate.data, destinationAuthentication, templateDictionary.folderId)
+            .then(createResponse => {
+            // Interrupt process if progress callback returns `false`
+            if (!itemProgressCallback(template.itemId, common.EItemProgressStatus.Created, template.estimatedDeploymentCostFactor / 2, createResponse.id)) {
+                itemProgressCallback(template.itemId, common.EItemProgressStatus.Cancelled, 0);
+                common
+                    .removeItem(createResponse.id, destinationAuthentication)
+                    .then(() => resolve(common.generateEmptyCreationResponse(template.type)), () => resolve(common.generateEmptyCreationResponse(template.type)));
+            }
+            else {
+                // Add the new item to the settings
+                newItemTemplate.itemId = createResponse.id;
+                templateDictionary[template.itemId] = {
+                    itemId: createResponse.id
+                };
+                itemProgressCallback(template.itemId, common.EItemProgressStatus.Finished, template.estimatedDeploymentCostFactor / 2, createResponse.id);
+                resolve({
+                    item: newItemTemplate,
+                    id: createResponse.id,
+                    type: newItemTemplate.type,
+                    postProcess: false
+                });
+            }
+        }, () => {
+            itemProgressCallback(template.itemId, common.EItemProgressStatus.Failed, 0);
+            resolve(common.generateEmptyCreationResponse(template.type)); // fails to create item
+        });
+    });
+}
 //# sourceMappingURL=file.js.map

package/dist/esm/index.d.ts

@@ -1,21 +1,21 @@
-/** @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.
- */
-/**
- * Manages the creation and deployment of item types that contain files.
- *
- * @module file
- */
-export * from "./file";
+/** @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.
+ */
+/**
+ * Manages the creation and deployment of item types that contain files.
+ *
+ * @module file
+ */
+export * from "./file";

package/dist/esm/index.js

@@ -1,22 +1,22 @@
-/** @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.
- */
-/**
- * Manages the creation and deployment of item types that contain files.
- *
- * @module file
- */
-export * from "./file";
+/** @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.
+ */
+/**
+ * Manages the creation and deployment of item types that contain files.
+ *
+ * @module file
+ */
+export * from "./file";
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/solution-file",
-  "version": "4.1.2",
+  "version": "5.0.1",
   "description": "Manages the creation and deployment of item types that contain files for @esri/solution.js.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -23,11 +23,11 @@
     "@esri/arcgis-rest-portal": "^3.6.0",
     "@esri/arcgis-rest-request": "^3.6.0",
     "@esri/arcgis-rest-service-admin": "^3.6.0",
-    "@esri/hub-common": "^13.4.1",
+    "@esri/hub-common": "^13.46.2",
     "@esri/hub-initiatives": "^13.0.0",
     "@esri/hub-sites": "^13.0.1",
     "@esri/hub-teams": "^13.0.0",
-    "@esri/solution-common": "^4.1.2",
+    "@esri/solution-common": "^5.0.1",
     "rollup": "2.79.1"
   },
   "dependencies": {
@@ -85,5 +85,5 @@
     "esri",
     "ES6"
   ],
-  "gitHead": "13ea49fdd2fc75cabe55a19c3620580c4c47643d"
+  "gitHead": "8c6c036b8e0c40a4b909ba69fa57869b0701e87c"
 }