@esri/solution-workflow 5.2.3 → 5.2.4

package/dist/cjs/index.d.ts

@@ -0,0 +1,21 @@
+/** @license
+ * Copyright 2024 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 workflow item types.
+ *
+ * @module workflow
+ */
+export * from "./workflow";

package/dist/cjs/index.js

@@ -0,0 +1,25 @@
+"use strict";
+/** @license
+ * Copyright 2024 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 workflow item types.
+ *
+ * @module workflow
+ */
+tslib_1.__exportStar(require("./workflow"), 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,qDAA2B"}

package/dist/cjs/package.json

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

package/dist/cjs/workflow.d.ts

@@ -0,0 +1,41 @@
+/** @license
+ * Copyright 2024 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 workflow item types.
+ *
+ * @module workflow
+ */
+import * as common from "@esri/solution-common";
+/**
+ * Converts a workflow 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>;
+/**
+ * Converts a workflow template into a new item.
+ *
+ * @param template Workflow template
+ * @param templateDictionary Dictionary of terms to replace in the template
+ * @param destAuthentication Credentials for requests to the destination organization
+ * @param itemProgressCallback Callback function to report the progress of the item creation
+ * @returns Promise resolving with the detemplatized item template, the new item's id, and a boolean
+ * indicating if post-processing is needed
+ */
+export declare function createItemFromTemplate(template: common.IItemTemplate, templateDictionary: any, destinationAuthentication: common.UserSession, itemProgressCallback: common.IItemProgressCallback): Promise<common.ICreateItemFromTemplateResponse>;

package/dist/cjs/workflow.js

@@ -0,0 +1,118 @@
+"use strict";
+/** @license
+ * Copyright 2024 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 workflow item types.
+ *
+ * @module workflow
+ */
+const common = tslib_1.__importStar(require("@esri/solution-common"));
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Converts a workflow 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
+ */
+async function convertItemToTemplate(itemInfo, destAuthentication, srcAuthentication) {
+    // 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 related items
+    const relatedPromise = common.getItemRelatedItemsInSameDirection(itemTemplate.itemId, "forward", srcAuthentication);
+    // Request its configuration
+    const configPromise = common.getWorkflowConfigurationZip(itemInfo.id, srcAuthentication);
+    const [relatedItems, configZip] = await Promise.all([relatedPromise, configPromise]);
+    // Save the mappings to related items & add those items to the dependencies, but not WMA Code Attachments
+    itemTemplate.dependencies = [];
+    itemTemplate.relatedItems = [];
+    relatedItems.forEach(relatedItem => {
+        /* istanbul ignore else */
+        if (relatedItem.relationshipType !== "WMA2Code") {
+            itemTemplate.relatedItems.push(relatedItem);
+            relatedItem.relatedItemIds.forEach(relatedItemId => {
+                if (itemTemplate.dependencies.indexOf(relatedItemId) < 0) {
+                    itemTemplate.dependencies.push(relatedItemId);
+                }
+            });
+        }
+    });
+    // Add the templatized configuration to the template
+    itemTemplate.properties.configuration = await common.extractAndTemplatizeWorkflowFromZipFile(configZip);
+    return Promise.resolve(itemTemplate);
+}
+exports.convertItemToTemplate = convertItemToTemplate;
+/**
+ * Converts a workflow template into a new item.
+ *
+ * @param template Workflow template
+ * @param templateDictionary Dictionary of terms to replace in the template
+ * @param destAuthentication Credentials for requests to the destination organization
+ * @param itemProgressCallback Callback function to report the progress of the item creation
+ * @returns Promise resolving with the detemplatized item template, the new item's id, and a boolean
+ * indicating if post-processing is needed
+ */
+async function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
+    // Interrupt process if progress callback returns `false`
+    if (!itemProgressCallback(template.itemId, common.EItemProgressStatus.Started, 0)) {
+        itemProgressCallback(template.itemId, common.EItemProgressStatus.Ignored, 0);
+        return Promise.resolve(common.generateEmptyCreationResponse(template.type));
+    }
+    // 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;
+    }
+    try {
+        // Create the item, then update its URL with its new id
+        const createResponse = await common.createItemWithData(newItemTemplate.item, newItemTemplate.data, destinationAuthentication, templateDictionary.folderId);
+        // 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);
+            void common.removeItem(createResponse.id, destinationAuthentication);
+            return Promise.resolve(common.generateEmptyCreationResponse(template.type));
+        }
+        // Add the new item to the settings
+        newItemTemplate.itemId = newItemTemplate.item.id = createResponse.id;
+        templateDictionary[template.itemId] = {
+            itemId: createResponse.id
+        };
+        // Add the item's configuration properties
+        const configZipFile = await common.compressWorkflowIntoZipFile(newItemTemplate.properties.configuration);
+        await common.setWorkflowConfigurationZip(configZipFile, createResponse.id, destinationAuthentication);
+        itemProgressCallback(template.itemId, common.EItemProgressStatus.Finished, template.estimatedDeploymentCostFactor / 2, createResponse.id);
+        return Promise.resolve({
+            item: newItemTemplate,
+            id: createResponse.id,
+            type: newItemTemplate.type,
+            postProcess: false
+        });
+    }
+    catch (err) {
+        itemProgressCallback(template.itemId, common.EItemProgressStatus.Failed, 0);
+        return Promise.resolve(common.generateEmptyCreationResponse(template.type));
+    }
+}
+exports.createItemFromTemplate = createItemFromTemplate;
+//# sourceMappingURL=workflow.js.map

package/dist/cjs/workflow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.js","sourceRoot":"","sources":["../../src/workflow.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AAEH;;;;GAIG;AAEH,sEAAgD;AAEhD,wHAAwH;AAExH;;;;;;;GAOG;AACI,KAAK,UAAU,qBAAqB,CACzC,QAAa,EACb,kBAAsC,EACtC,iBAAqC;IAErC,gBAAgB;IAChB,MAAM,YAAY,GAAyB,MAAM,CAAC,6BAA6B,CAC7E,QAAQ,CACT,CAAC;IAEF,uCAAuC;IACvC,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;IAEF,wBAAwB;IACxB,MAAM,cAAc,GAAG,MAAM,CAAC,kCAAkC,CAC9D,YAAY,CAAC,MAAM,EACnB,SAAS,EACT,iBAAiB,CAClB,CAAC;IAEF,4BAA4B;IAC5B,MAAM,aAAa,GAAG,MAAM,CAAC,2BAA2B,CACtD,QAAQ,CAAC,EAAE,EACX,iBAAiB,CAClB,CAAC;IAEF,MAAM,CAAC,YAAY,EAAE,SAAS,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC;IAErF,yGAAyG;IACzG,YAAY,CAAC,YAAY,GAAG,EAAc,CAAC;IAC3C,YAAY,CAAC,YAAY,GAAG,EAA4B,CAAC;IAEzD,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QACjC,0BAA0B;QAC1B,IAAI,WAAW,CAAC,gBAAgB,KAAK,UAAU,EAAE;YAC/C,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC5C,WAAW,CAAC,cAAc,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;gBACjD,IAAI,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;oBACxD,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;iBAC/C;YACH,CAAC,CAAC,CAAC;SACJ;IACH,CAAC,CAAC,CAAC;IAEH,oDAAoD;IACpD,YAAY,CAAC,UAAU,CAAC,aAAa,GAAG,MAAM,MAAM,CAAC,uCAAuC,CAAC,SAAS,CAAC,CAAC;IAExG,OAAO,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;AACvC,CAAC;AApDD,sDAoDC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,sBAAsB,CAC1C,QAA8B,EAC9B,kBAAuB,EACvB,yBAA6C,EAC7C,oBAAkD;IAElD,yDAAyD;IACzD,IACE,CAAC,oBAAoB,CACnB,QAAQ,CAAC,MAAM,EACf,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAClC,CAAC,CACF,EACD;QACA,oBAAoB,CAClB,QAAQ,CAAC,MAAM,EACf,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAClC,CAAC,CACF,CAAC;QACF,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;KAC7E;IAED,4DAA4D;IAC5D,IAAI,eAAe,GAAyB,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACzE,eAAe,GAAG,MAAM,CAAC,iBAAiB,CACxC,eAAe,EACf,kBAAkB,CACnB,CAAC;IACF,0BAA0B;IAC1B,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE;QAC3B,eAAe,CAAC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;KAC1D;IAED,IAAI;QACF,uDAAuD;QACvD,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,kBAAkB,CACpD,eAAe,CAAC,IAAI,EACpB,eAAe,CAAC,IAAI,EACpB,yBAAyB,EACzB,kBAAkB,CAAC,QAAQ,CAC5B,CAAC;QAEF,yDAAyD;QACzD,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;YACA,oBAAoB,CAClB,QAAQ,CAAC,MAAM,EACf,MAAM,CAAC,mBAAmB,CAAC,SAAS,EACpC,CAAC,CACF,CAAC;YAEF,KAAK,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,EAAE,yBAAyB,CAAC,CAAC;YACrE,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;SAC7E;QAED,mCAAmC;QACnC,eAAe,CAAC,MAAM,GAAG,eAAe,CAAC,IAAI,CAAC,EAAE,GAAG,cAAc,CAAC,EAAE,CAAC;QACrE,kBAAkB,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG;YACpC,MAAM,EAAE,cAAc,CAAC,EAAE;SAC1B,CAAC;QAEF,0CAA0C;QAC1C,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,2BAA2B,CAAC,eAAe,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QACzG,MAAM,MAAM,CAAC,2BAA2B,CACtC,aAAa,EACb,cAAc,CAAC,EAAE,EACjB,yBAAyB,CAC1B,CAAC;QAEF,oBAAoB,CAClB,QAAQ,CAAC,MAAM,EACf,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EACnC,QAAQ,CAAC,6BAA6B,GAAG,CAAC,EAC1C,cAAc,CAAC,EAAE,CAClB,CAAC;QAEF,OAAO,OAAO,CAAC,OAAO,CAAC;YACrB,IAAI,EAAE,eAAe;YACrB,EAAE,EAAE,cAAc,CAAC,EAAE;YACrB,IAAI,EAAE,eAAe,CAAC,IAAI;YAC1B,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC;KACJ;IAAC,OAAO,GAAG,EAAE;QACZ,oBAAoB,CAClB,QAAQ,CAAC,MAAM,EACf,MAAM,CAAC,mBAAmB,CAAC,MAAM,EACjC,CAAC,CACF,CAAC;QACF,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;KAC7E;AACH,CAAC;AAhGD,wDAgGC"}

package/dist/esm/package.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/solution-workflow",
-  "version": "5.2.3",
+  "version": "5.2.4",
   "description": "Manages the creation and deployment of Workflow item types for @esri/solution.js.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -19,7 +19,7 @@
   ],
   "devDependencies": {
     "@esri/arcgis-rest-auth": "^3.7.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",
@@ -66,5 +66,5 @@
     "esri",
     "ES6"
   ],
-  "gitHead": "bcf0907f47cf8a2970f8da38f8e1e2a4ac7beccb"
+  "gitHead": "c3329c6814c1d7b898eb130bf3a7feeda12f074f"
 }