@esri/solution-file 5.2.3 → 5.2.4

package/dist/cjs/file.d.ts

@@ -0,0 +1,31 @@
+/** @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 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(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

@@ -0,0 +1,133 @@
+"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 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(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/file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.js","sourceRoot":"","sources":["../../src/file.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AAEH;;;;GAIG;AAEH,sEAAgD;AAEhD,wHAAwH;AAExH;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACnC,QAAa,EACb,kBAAsC,EACtC,iBAAqC;IAErC,OAAO,IAAI,OAAO,CAAuB,OAAO,CAAC,EAAE;QACjD,gBAAgB;QAChB,MAAM,YAAY,GAAyB,MAAM,CAAC,6BAA6B,CAC7E,QAAQ,CACT,CAAC;QAEF,uCAAuC;QACvC,YAAY,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,cAAc,CAC1C,YAAY,CAAC,IAAI,CAAC,EAAE,EACpB,YAAY,CAAC,IAAI,CAAC,EAAE,EACpB,SAAS,CACV,CAAC;QAEF,eAAe;QACf,MAAM,WAAW,GAAG,IAAI,OAAO,CAAO,WAAW,CAAC,EAAE;YAClD,mEAAmE;YACnE,MAAM;iBACH,iBAAiB,CAChB,YAAY,CAAC,MAAM,EACnB,YAAY,CAAC,IAAI,CAAC,IAAI,EACtB,iBAAiB,CAClB;iBACA,IAAI,CAAC,QAAQ,CAAC,EAAE;gBACf,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC,EAAE;oBACpC,WAAW,CAAC,IAAI,CAAC,CAAC;iBACnB;qBAAM;oBACL,WAAW,CAAC,QAAQ,CAAC,CAAC;iBACvB;YACH,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,wBAAwB;QACxB,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,CACpC,EAAqC,CACtC,CAAC;QAEF,4GAA4G;QAC5G,mEAAmE;QACnE,OAAO,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC1D,MAAM,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC;YAErC,IAAI,gBAAgB,EAAE;gBACpB,MAAM,QAAQ,GAA0B,MAAM,CAAC,gCAAgC,CAC7E,gBAAgB,EAChB,YAAY,CAAC,IAAI,CAAC,IAAI,CACvB,CAAC;gBACF,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC;gBAE/D,MAAM,WAAW,GAAG,MAAM,CAAC,oCAAoC,CAC7D,YAAY,CAAC,MAAM,EAClB,QAAQ,CAAC,IAAa,CAAC,IAAI,EAC5B,MAAM,CAAC,6BAA6B,EACpC,CAAE,QAAQ,CAAC,IAAa,CAAC,IAAI,KAAK,QAAQ,CAAC,QAAQ;oBAC/C,CAAC,CAAC,MAAM,CAAC,oBAAoB,CAAC,IAAI;oBAClC,CAAC,CAAC,MAAM,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAC3C,CAAC;gBAEF,wGAAwG;gBACxG,MAAM,QAAQ,GAAuB;oBACnC,MAAM,EAAE,YAAY,CAAC,MAAM;oBAC3B,IAAI,EAAE,QAAQ,CAAC,IAAY;oBAC3B,MAAM,EAAE,WAAW,CAAC,MAAM;oBAC1B,QAAQ,EAAE,WAAW,CAAC,QAAQ;iBAC/B,CAAA;gBACD,YAAY,CAAC,QAAQ,GAAG,QAAQ,CAAC;gBAEjC,kCAAkC;gBAClC,YAAY,CAAC,SAAS,CAAC,IAAI,CACzB,WAAW,CAAC,MAAM,GAAG,GAAG,GAAG,WAAW,CAAC,QAAQ,CAChD,CAAC;gBAEF,OAAO,CAAC,YAAY,CAAC,CAAC;aACvB;iBAAM;gBACL,OAAO,CAAC,YAAY,CAAC,CAAC;aACvB;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAlFD,sDAkFC;AAED,SAAgB,sBAAsB,CACpC,QAA8B,EAC9B,kBAAuB,EACvB,yBAA6C,EAC7C,oBAAkD;IAElD,OAAO,IAAI,OAAO,CAAyC,OAAO,CAAC,EAAE;QACnE,yDAAyD;QACzD,IACE,CAAC,oBAAoB,CACnB,QAAQ,CAAC,MAAM,EACf,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAClC,CAAC,CACF,EACD;YACA,oBAAoB,CAClB,QAAQ,CAAC,MAAM,EACf,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAClC,CAAC,CACF,CAAC;YACF,OAAO,CAAC,MAAM,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;YAC7D,OAAO;SACR;QAED,4DAA4D;QAC5D,IAAI,eAAe,GAAyB,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACzE,eAAe,GAAG,MAAM,CAAC,iBAAiB,CACxC,eAAe,EACf,kBAAkB,CACnB,CAAC;QACF,0BAA0B;QAC1B,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE;YAC3B,eAAe,CAAC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;SAC1D;QAED,uDAAuD;QACvD,MAAM;aACH,kBAAkB,CACjB,eAAe,CAAC,IAAI,EACpB,eAAe,CAAC,IAAI,EACpB,yBAAyB,EACzB,kBAAkB,CAAC,QAAQ,CAC5B;aACA,IAAI,CACH,cAAc,CAAC,EAAE;YACf,yDAAyD;YACzD,IACE,CAAC,oBAAoB,CACnB,QAAQ,CAAC,MAAM,EACf,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAClC,QAAQ,CAAC,6BAA6B,GAAG,CAAC,EAC1C,cAAc,CAAC,EAAE,CAClB,EACD;gBACA,oBAAoB,CAClB,QAAQ,CAAC,MAAM,EACf,MAAM,CAAC,mBAAmB,CAAC,SAAS,EACpC,CAAC,CACF,CAAC;gBACF,MAAM;qBACH,UAAU,CAAC,cAAc,CAAC,EAAE,EAAE,yBAAyB,CAAC;qBACxD,IAAI,CACH,GAAG,EAAE,CACH,OAAO,CAAC,MAAM,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAC9D,GAAG,EAAE,CACH,OAAO,CAAC,MAAM,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAC/D,CAAC;aACL;iBAAM;gBACL,mCAAmC;gBACnC,eAAe,CAAC,MAAM,GAAG,cAAc,CAAC,EAAE,CAAC;gBAC3C,kBAAkB,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG;oBACpC,MAAM,EAAE,cAAc,CAAC,EAAE;iBAC1B,CAAC;gBAEF,oBAAoB,CAClB,QAAQ,CAAC,MAAM,EACf,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EACnC,QAAQ,CAAC,6BAA6B,GAAG,CAAC,EAC1C,cAAc,CAAC,EAAE,CAClB,CAAC;gBAEF,OAAO,CAAC;oBACN,IAAI,EAAE,eAAe;oBACrB,EAAE,EAAE,cAAc,CAAC,EAAE;oBACrB,IAAI,EAAE,eAAe,CAAC,IAAI;oBAC1B,WAAW,EAAE,KAAK;iBACnB,CAAC,CAAC;aACJ;QACH,CAAC,EACD,GAAG,EAAE;YACH,oBAAoB,CAClB,QAAQ,CAAC,MAAM,EACf,MAAM,CAAC,mBAAmB,CAAC,MAAM,EACjC,CAAC,CACF,CAAC;YACF,OAAO,CAAC,MAAM,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,uBAAuB;QACvF,CAAC,CACF,CAAC;IACN,CAAC,CAAC,CAAC;AACL,CAAC;AAnGD,wDAmGC"}

package/dist/cjs/index.d.ts

@@ -0,0 +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";

package/dist/cjs/index.js

@@ -0,0 +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);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;;;GAIG;AAEH,iDAAuB"}

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/solution-file",
-  "version": "5.2.3",
+  "version": "5.2.4",
   "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",
@@ -27,7 +27,7 @@
     "@esri/hub-initiatives": "^14.0.0",
     "@esri/hub-sites": "^14.2.2",
     "@esri/hub-teams": "^14.1.0",
-    "@esri/solution-common": "^5.2.3",
+    "@esri/solution-common": "^5.2.4",
     "@types/jasmine": "^5.1.4",
     "fetch-mock": "^7.7.3",
     "jasmine": "^5.1.0",
@@ -88,5 +88,5 @@
     "esri",
     "ES6"
   ],
-  "gitHead": "bcf0907f47cf8a2970f8da38f8e1e2a4ac7beccb"
+  "gitHead": "c3329c6814c1d7b898eb130bf3a7feeda12f074f"
 }