@esri/solution-common 6.1.3 → 6.1.5

package/dist/cjs/webtoolHelpers.js

@@ -0,0 +1,102 @@
+"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._updateDependencies = exports._globalTemplatize = exports.postProcessWebToolReferences = exports.preProcessWebTool = void 0;
+const generalHelpers_1 = require("./generalHelpers");
+/**
+ * Store any web tool urls in the templateDictionary so we can use them to search other items
+ * after they have been converted to templates
+ *
+ * @param template the current template
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ *
+ */
+function preProcessWebTool(template, templateDictionary) {
+    if (template.type === "Geoprocessing Service") {
+        const url = template.item.origUrl;
+        const urlVar = `{{${template.itemId}.url}}`;
+        templateDictionary[url] = urlVar;
+    }
+}
+exports.preProcessWebTool = preProcessWebTool;
+/**
+ * Use any stored GPServer urls to search all other templates for potential references
+ * This will allow us to replace the base server name as will as the itemId
+ *
+ * @param templates the list of all the templates in the solution
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ *
+ * @returns potentially updated list of all the templates in the solution
+ */
+function postProcessWebToolReferences(templates, templateDictionary) {
+    const gpServerUrls = Object.keys(templateDictionary).filter((k) => k.indexOf("GPServer") > -1);
+    if (gpServerUrls.length > 0) {
+        gpServerUrls.forEach((url) => {
+            const itemId = templateDictionary[url].replace("{{", "").replace(".url}}", "");
+            _globalTemplatize(templates, url, templateDictionary[url], itemId);
+            // handle items that already have a templatized itemId in the url
+            const idTest = /[0-9A-F]{32}/gim;
+            const templatizedUrl = url.replace(idTest, `{{${itemId}.itemId}}`);
+            _globalTemplatize(templates, templatizedUrl, templateDictionary[url], itemId);
+        });
+    }
+    return templates;
+}
+exports.postProcessWebToolReferences = postProcessWebToolReferences;
+/**
+ * Use any stored GPServer urls to search all other templates for potential references
+ * This will allow us to replace the base server name as will as the itemId
+ *
+ * @param templates the list of all the templates in the solution
+ * @param orgUrl the item url of the GPServer
+ * @param templatizedUrl the templatized GPServer Url
+ * @param orgItemId the item id of the GPServer
+ *
+ * @returns potentially updated list of all the templates in the solution
+ */
+function _globalTemplatize(templates, orgUrl, templatizedUrl, orgItemId) {
+    // Cycle through each of the items in the template and scan the `item` and `data` sections of each for replacements
+    templates.forEach((template) => {
+        const itemString = JSON.stringify(template.item);
+        const dataString = JSON.stringify(template.data);
+        (0, generalHelpers_1.globalStringReplace)(template.item, new RegExp(orgUrl, "gi"), templatizedUrl);
+        (0, generalHelpers_1.globalStringReplace)(template.data, new RegExp(orgUrl, "gi"), templatizedUrl);
+        _updateDependencies(template, itemString, dataString, orgItemId);
+    });
+    return templates;
+}
+exports._globalTemplatize = _globalTemplatize;
+/**
+ * Update the templates dependencies if we can detect differences after we try and replace a GPServer url
+ *
+ * @param template the current template
+ * @param itemString stringified version of the the templates item before we replaced anything
+ * @param dataString stringified version of the the templates data before we replaced anything
+ * @param id the current item Id of the GPServer
+ *
+ */
+function _updateDependencies(template, itemString, dataString, id) {
+    const hasItemDepdendency = template.dependencies.indexOf(id) > -1;
+    if (itemString && itemString !== JSON.stringify(template.item) && !hasItemDepdendency) {
+        template.dependencies.push(id);
+    }
+    if (dataString && dataString !== JSON.stringify(template.data) && !hasItemDepdendency) {
+        template.dependencies.push(id);
+    }
+}
+exports._updateDependencies = _updateDependencies;
+//# sourceMappingURL=webtoolHelpers.js.map

package/dist/cjs/webtoolHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webtoolHelpers.js","sourceRoot":"","sources":["../../src/webtoolHelpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAGH,qDAAuD;AAEvD;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAAC,QAAuB,EAAE,kBAAuB;IAChF,IAAI,QAAQ,CAAC,IAAI,KAAK,uBAAuB,EAAE;QAC7C,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;QAClC,MAAM,MAAM,GAAG,KAAK,QAAQ,CAAC,MAAM,QAAQ,CAAC;QAC5C,kBAAkB,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;KAClC;AACH,CAAC;AAND,8CAMC;AAED;;;;;;;;GAQG;AACH,SAAgB,4BAA4B,CAAC,SAA0B,EAAE,kBAAuB;IAC9F,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAE/F,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;QAC3B,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAC3B,MAAM,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAE/E,iBAAiB,CAAC,SAAS,EAAE,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;YAEnE,iEAAiE;YACjE,MAAM,MAAM,GAAW,iBAAiB,CAAC;YACzC,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,MAAM,WAAW,CAAC,CAAC;YACnE,iBAAiB,CAAC,SAAS,EAAE,cAAc,EAAE,kBAAkB,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;QAChF,CAAC,CAAC,CAAC;KACJ;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAhBD,oEAgBC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,iBAAiB,CAC/B,SAA0B,EAC1B,MAAc,EACd,cAAsB,EACtB,SAAiB;IAEjB,mHAAmH;IACnH,SAAS,CAAC,OAAO,CAAC,CAAC,QAAuB,EAAE,EAAE;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACjD,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEjD,IAAA,oCAAmB,EAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,CAAC;QAC7E,IAAA,oCAAmB,EAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,CAAC;QAE7E,mBAAmB,CAAC,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC;AAjBD,8CAiBC;AAED;;;;;;;;GAQG;AACH,SAAgB,mBAAmB,CAAC,QAAuB,EAAE,UAAkB,EAAE,UAAkB,EAAE,EAAU;IAC7G,MAAM,kBAAkB,GAAG,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAElE,IAAI,UAAU,IAAI,UAAU,KAAK,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE;QACrF,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;KAChC;IAED,IAAI,UAAU,IAAI,UAAU,KAAK,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE;QACrF,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;KAChC;AACH,CAAC;AAVD,kDAUC"}

package/dist/cjs/workflowHelpers.d.ts

@@ -0,0 +1,112 @@
+/** @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.
+ */
+/**
+ * Provides common functions compressing and decompressing workflow configurations.
+ *
+ * @module workflowHelpers
+ */
+import { IItemTemplate, IPreProcessWorkflowTemplatesResponse } from "./interfaces";
+import { IPortal, UserSession } from "./arcgisRestJS";
+/**
+ * Compresses a workflow configuration into a zip file.
+ *
+ * @param workflowConfig Workflow configuration
+ * @returns Promise resolving with a zip file
+ */
+export declare function compressWorkflowIntoZipFile(workflowConfig: any): Promise<File>;
+/**
+ * Deletes a workflow.
+ *
+ * @param itemId Id of the workflow item
+ * @param workflowBaseUrl URL of the workflow manager, e.g., "https://workflow.arcgis.com/orgId"
+ * @param authentication Credentials for the request to AGOL
+ * @returns Promise resolving with success or faliure of the request
+ */
+export declare function deleteWorkflowItem(itemId: string, workflowBaseUrl: string, authentication: UserSession): Promise<boolean>;
+/**
+ * Extracts a workflow configuration from a zip file into a JSON object.
+ *
+ * @param zipFile Zip file containing a workflow configuration
+ * @returns Promise resolving with a workflow configuration as JSON object, with each file being a key
+ */
+export declare function extractWorkflowFromZipFile(zipFile: File): Promise<any>;
+/**
+ * Check the license capability of Workflow Manager Server.
+ *
+ * @param workflowBaseUrl URL of the workflow manager, e.g., "https://workflow.arcgis.com/orgId"
+ * @param authentication Credentials for the request to AGO
+ * @returns Promise resolving with a boolean indicating whether the organization has the license
+ * @throws {WorkflowJsonExceptionDTO} if request to workflow manager fails
+ */
+export declare function getWorkflowManagerAuthorized(workflowBaseUrl: string, authentication: UserSession): Promise<boolean>;
+/**
+ * Determines the URL to the Workflow Manager.
+ *
+ * @param authentication Authenticated user session
+ * @param portalResponse Response from portal "self" call; will be fetched if not supplied
+ * @param orgId Id of organization whose license is to be checked; if truthy, the URL will be for AGO;
+ * if falsy, the URL will be for Workflow Manager Enterprise
+ * @returns A URL based on ArcGIS Online or Enterprise, e.g., "https://abc123.esri.com:6443/arcgis"
+ */
+export declare function getWorkflowBaseURL(authentication: UserSession, portalResponse?: IPortal, orgId?: string): Promise<string>;
+/**
+ * Get the URL for the Workflow Manager Enterprise application.
+ *
+ * @param portalRestUrl URL of the portal REST endpoint, e.g., "https://gisserver.domain.com/server/rest/services"
+ * @param authentication Credentials for the request to AGO
+ * @returns URL for the Workflow Manager Enterprise application (e.g., "https://abc123.esri.com:6443/arcgis"),
+ * or an empty string if Workflow Manager is not enabled
+ */
+export declare function getWorkflowEnterpriseServerRootURL(portalRestUrl: string, authentication: UserSession): Promise<string>;
+/**
+ * Remove feature service templates that will be auto-generated by Workflow when
+ * creating the Workflow item.
+ *
+ * Also store key values from any Workflow items so we can update variables in other items.
+ *
+ * @param templates The list of all templates from the Solutions
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ *
+ * @returns An object that contains the items that should use standard deployment and
+ * templates that will be deployed by Wokflow deployment.
+ */
+export declare function preprocessWorkflowTemplates(templates: IItemTemplate[], templateDictionary: any): IPreProcessWorkflowTemplatesResponse;
+/**
+ * Store key values from any Workflow items so we can update variables in other items.
+ *
+ * @param key property from a workflow item that will contain an item id that we will need for variable replacement
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ * @param template Workflow template
+ * @param ids list of ids that will be auto generated by Workflow
+ *
+ */
+export declare function storeKeyWorkflowServiceId(key: string, templateDictionary: any, template: IItemTemplate, ids: string[]): void;
+/**
+ * Replace various IDs in the templates based on items that were created by Workflow
+ *
+ * @param templates The list of all templates from the Solutions
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ *
+ * @returns The updated collection of templates
+ */
+export declare function updateWorkflowTemplateIds(templates: IItemTemplate[], templateDictionary: any): IItemTemplate[];
+/**
+ * Get the various dependencies from the workflow item and add them to the current templates dependency list
+ *
+ * @param template The IItemTemplate of the workflow item
+ *
+ */
+export declare function getWorkflowDependencies(template: IItemTemplate): void;

package/dist/cjs/workflowHelpers.js

@@ -0,0 +1,284 @@
+"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.getWorkflowDependencies = exports.updateWorkflowTemplateIds = exports.storeKeyWorkflowServiceId = exports.preprocessWorkflowTemplates = exports.getWorkflowEnterpriseServerRootURL = exports.getWorkflowBaseURL = exports.getWorkflowManagerAuthorized = exports.extractWorkflowFromZipFile = exports.deleteWorkflowItem = exports.compressWorkflowIntoZipFile = void 0;
+const tslib_1 = require("tslib");
+const restHelpersGet = tslib_1.__importStar(require("./restHelpersGet"));
+const zipUtils = tslib_1.__importStar(require("./zip-utils"));
+const arcgisRestJS_1 = require("./arcgisRestJS");
+const restHelpers_1 = require("./restHelpers");
+const restHelpersGet_1 = require("./restHelpersGet");
+const copyDataIntoItem_1 = require("./resources/copyDataIntoItem");
+const generalHelpers_1 = require("./generalHelpers");
+const jszip_1 = tslib_1.__importDefault(require("jszip"));
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Compresses a workflow configuration into a zip file.
+ *
+ * @param workflowConfig Workflow configuration
+ * @returns Promise resolving with a zip file
+ */
+async function compressWorkflowIntoZipFile(workflowConfig) {
+    const zip = new jszip_1.default();
+    Object.keys(workflowConfig).forEach((key) => {
+        zip.file(key, workflowConfig[key]);
+    });
+    const zipFile = (0, copyDataIntoItem_1.createMimeTypedFile)({
+        blob: await zip.generateAsync({ type: "blob" }),
+        filename: `workflow_configuration.zip`,
+        mimeType: "application/zip",
+    });
+    return Promise.resolve(zipFile);
+}
+exports.compressWorkflowIntoZipFile = compressWorkflowIntoZipFile;
+/**
+ * Deletes a workflow.
+ *
+ * @param itemId Id of the workflow item
+ * @param workflowBaseUrl URL of the workflow manager, e.g., "https://workflow.arcgis.com/orgId"
+ * @param authentication Credentials for the request to AGOL
+ * @returns Promise resolving with success or faliure of the request
+ */
+async function deleteWorkflowItem(itemId, workflowBaseUrl, authentication) {
+    // Get the id of the Workflow Manager Admin group because the group has to be deleted separately
+    const data = await (0, restHelpersGet_1.getItemDataAsJson)(itemId, authentication);
+    const adminGroupId = data?.groupId;
+    // Delete the item
+    const url = `${workflowBaseUrl}/admin/${itemId}`;
+    const options = {
+        authentication,
+        headers: {
+            "Accept": "application/json",
+            "Authorization": `Bearer ${authentication.token}`,
+            "X-Esri-Authorization": `Bearer ${authentication.token}`,
+        },
+        httpMethod: "DELETE",
+        params: {
+            f: "json",
+        },
+    };
+    const response = await (0, arcgisRestJS_1.request)(url, options);
+    // Delete the admin group
+    if (adminGroupId) {
+        await (0, restHelpers_1.removeGroup)(adminGroupId, authentication);
+    }
+    return Promise.resolve(response.success);
+}
+exports.deleteWorkflowItem = deleteWorkflowItem;
+/**
+ * Extracts a workflow configuration from a zip file into a JSON object.
+ *
+ * @param zipFile Zip file containing a workflow configuration
+ * @returns Promise resolving with a workflow configuration as JSON object, with each file being a key
+ */
+async function extractWorkflowFromZipFile(zipFile) {
+    const zippedFiles = await zipUtils.getZipObjectContents(await zipUtils.blobToZipObject(zipFile));
+    const workflowConfig = {};
+    zippedFiles.forEach((zippedFile) => {
+        workflowConfig[zippedFile.file] = zippedFile.content;
+    });
+    return Promise.resolve(workflowConfig);
+}
+exports.extractWorkflowFromZipFile = extractWorkflowFromZipFile;
+/**
+ * Check the license capability of Workflow Manager Server.
+ *
+ * @param workflowBaseUrl URL of the workflow manager, e.g., "https://workflow.arcgis.com/orgId"
+ * @param authentication Credentials for the request to AGO
+ * @returns Promise resolving with a boolean indicating whether the organization has the license
+ * @throws {WorkflowJsonExceptionDTO} if request to workflow manager fails
+ */
+async function getWorkflowManagerAuthorized(workflowBaseUrl, authentication) {
+    try {
+        const url = `${workflowBaseUrl}/checkStatus`;
+        const options = {
+            authentication,
+            httpMethod: "GET",
+            params: {
+                f: "json",
+            },
+        };
+        const response = await (0, arcgisRestJS_1.request)(url, options);
+        const isAuthorized = response?.hasAdvancedLicense || false;
+        return Promise.resolve(isAuthorized);
+    }
+    catch (err) {
+        // User is not authorized for Workflow Manager
+        return Promise.resolve(false);
+    }
+}
+exports.getWorkflowManagerAuthorized = getWorkflowManagerAuthorized;
+/**
+ * Determines the URL to the Workflow Manager.
+ *
+ * @param authentication Authenticated user session
+ * @param portalResponse Response from portal "self" call; will be fetched if not supplied
+ * @param orgId Id of organization whose license is to be checked; if truthy, the URL will be for AGO;
+ * if falsy, the URL will be for Workflow Manager Enterprise
+ * @returns A URL based on ArcGIS Online or Enterprise, e.g., "https://abc123.esri.com:6443/arcgis"
+ */
+async function getWorkflowBaseURL(authentication, portalResponse, orgId) {
+    let workflowServerUrl;
+    if (!portalResponse) {
+        const user = await restHelpersGet.getUser(authentication);
+        orgId = orgId ?? user.orgId;
+        portalResponse = await restHelpersGet.getPortal("", authentication);
+    }
+    const portalURL = `https://${portalResponse.portalHostname}`;
+    const portalRestURL = `${portalURL}/sharing/rest`;
+    if (portalResponse.isPortal) {
+        // Enterprise
+        workflowServerUrl = await getWorkflowEnterpriseServerRootURL(portalRestURL, authentication);
+    }
+    else {
+        // ArcGIS Online
+        workflowServerUrl = portalResponse.helperServices?.workflowManager?.url ?? portalURL;
+    }
+    return Promise.resolve(orgId ? `${workflowServerUrl}/${orgId}` : `${workflowServerUrl}/workflow`);
+}
+exports.getWorkflowBaseURL = getWorkflowBaseURL;
+/**
+ * Get the URL for the Workflow Manager Enterprise application.
+ *
+ * @param portalRestUrl URL of the portal REST endpoint, e.g., "https://gisserver.domain.com/server/rest/services"
+ * @param authentication Credentials for the request to AGO
+ * @returns URL for the Workflow Manager Enterprise application (e.g., "https://abc123.esri.com:6443/arcgis"),
+ * or an empty string if Workflow Manager is not enabled
+ */
+async function getWorkflowEnterpriseServerRootURL(portalRestUrl, authentication) {
+    // Get the servers
+    const servers = await (0, restHelpersGet_1.getEnterpriseServers)(portalRestUrl, authentication);
+    // Find the Workflow Manager server
+    const workflowServer = servers.find((server) => server.serverFunction === "WorkflowManager");
+    if (!workflowServer) {
+        return "";
+    }
+    return workflowServer.url;
+}
+exports.getWorkflowEnterpriseServerRootURL = getWorkflowEnterpriseServerRootURL;
+/**
+ * Remove feature service templates that will be auto-generated by Workflow when
+ * creating the Workflow item.
+ *
+ * Also store key values from any Workflow items so we can update variables in other items.
+ *
+ * @param templates The list of all templates from the Solutions
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ *
+ * @returns An object that contains the items that should use standard deployment and
+ * templates that will be deployed by Wokflow deployment.
+ */
+function preprocessWorkflowTemplates(templates, templateDictionary) {
+    const workflowItems = templates.filter((t) => t.type === "Workflow");
+    const serviceIds = workflowItems.reduce((prev, cur) => {
+        templateDictionary.workflows = { ...templateDictionary.workflows };
+        templateDictionary.workflows[cur.itemId] = {};
+        storeKeyWorkflowServiceId("viewSchema", templateDictionary, cur, prev);
+        storeKeyWorkflowServiceId("workflowLocations", templateDictionary, cur, prev);
+        storeKeyWorkflowServiceId("workflowSchema", templateDictionary, cur, prev);
+        return prev;
+    }, []);
+    const workflowManagedTemplates = [];
+    const deployTemplates = templates.filter((t) => {
+        if (serviceIds.indexOf(t.itemId) < 0) {
+            return true;
+        }
+        else {
+            workflowManagedTemplates.push(t);
+        }
+    });
+    return {
+        deployTemplates,
+        workflowManagedTemplates,
+    };
+}
+exports.preprocessWorkflowTemplates = preprocessWorkflowTemplates;
+/**
+ * Store key values from any Workflow items so we can update variables in other items.
+ *
+ * @param key property from a workflow item that will contain an item id that we will need for variable replacement
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ * @param template Workflow template
+ * @param ids list of ids that will be auto generated by Workflow
+ *
+ */
+function storeKeyWorkflowServiceId(key, templateDictionary, template, ids) {
+    const id = (0, generalHelpers_1.getProp)(template, `data.${key}.itemId`).replace("{{", "").replace(".itemId}}", "");
+    if (id && ids.indexOf(id) < 0) {
+        ids.push(id);
+    }
+    templateDictionary.workflows[template.itemId][key] = id;
+    templateDictionary[id] = {};
+}
+exports.storeKeyWorkflowServiceId = storeKeyWorkflowServiceId;
+/**
+ * Replace various IDs in the templates based on items that were created by Workflow
+ *
+ * @param templates The list of all templates from the Solutions
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ *
+ * @returns The updated collection of templates
+ */
+function updateWorkflowTemplateIds(templates, templateDictionary) {
+    if (templateDictionary.workflows) {
+        Object.keys(templateDictionary.workflows).forEach((k) => {
+            // the ids retained here are that of the source items
+            // we justr need to swap them out in the templates arrey
+            const workflowHash = templateDictionary.workflows[k];
+            const viewSchemaId = workflowHash.viewSchema;
+            const workflowLocationsId = workflowHash.workflowLocations;
+            const workflowSchemaId = workflowHash.workflowSchema;
+            const workflowIds = [viewSchemaId, workflowLocationsId, workflowSchemaId];
+            templates = templates.map((t) => {
+                if (workflowIds.indexOf(t.itemId) > -1) {
+                    t.dependencies = t.dependencies.map((d) => {
+                        if (workflowIds.indexOf(d) > -1) {
+                            d = templateDictionary[d].itemId;
+                        }
+                        return d;
+                    });
+                    t.itemId = templateDictionary[t.itemId].itemId;
+                }
+                return t;
+            });
+        });
+    }
+    return templates;
+}
+exports.updateWorkflowTemplateIds = updateWorkflowTemplateIds;
+/**
+ * Get the various dependencies from the workflow item and add them to the current templates dependency list
+ *
+ * @param template The IItemTemplate of the workflow item
+ *
+ */
+function getWorkflowDependencies(template) {
+    const data = template.data;
+    if (data) {
+        const keys = ["viewSchema", "workflowLocations", "workflowSchema"];
+        keys.forEach((k) => {
+            if (Object.keys(data).indexOf(k) > -1) {
+                const id = data[k].itemId;
+                if (id && template.dependencies.indexOf(id) < 0) {
+                    template.dependencies.push(id);
+                }
+            }
+        });
+    }
+}
+exports.getWorkflowDependencies = getWorkflowDependencies;
+//# sourceMappingURL=workflowHelpers.js.map

package/dist/cjs/workflowHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflowHelpers.js","sourceRoot":"","sources":["../../src/workflowHelpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AASH,yEAAmD;AACnD,8DAAwC;AACxC,iDAAgF;AAChF,+CAA4C;AAC5C,qDAA2E;AAC3E,mEAAmE;AACnE,qDAA2C;AAC3C,0DAA0B;AAE1B,wHAAwH;AAExH;;;;;GAKG;AACI,KAAK,UAAU,2BAA2B,CAAC,cAAmB;IACnE,MAAM,GAAG,GAAG,IAAI,eAAK,EAAE,CAAC;IACxB,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;QAClD,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAA,sCAAmB,EAAC;QAClC,IAAI,EAAE,MAAM,GAAG,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAC/C,QAAQ,EAAE,4BAA4B;QACtC,QAAQ,EAAE,iBAAiB;KAC5B,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC;AAbD,kEAaC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,kBAAkB,CACtC,MAAc,EACd,eAAuB,EACvB,cAA2B;IAE3B,gGAAgG;IAChG,MAAM,IAAI,GAAG,MAAM,IAAA,kCAAiB,EAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC7D,MAAM,YAAY,GAAG,IAAI,EAAE,OAAO,CAAC;IAEnC,kBAAkB;IAClB,MAAM,GAAG,GAAG,GAAG,eAAe,UAAU,MAAM,EAAE,CAAC;IAEjD,MAAM,OAAO,GAAoB;QAC/B,cAAc;QACd,OAAO,EAAE;YACP,QAAQ,EAAE,kBAAkB;YAC5B,eAAe,EAAE,UAAU,cAAc,CAAC,KAAK,EAAE;YACjD,sBAAsB,EAAE,UAAU,cAAc,CAAC,KAAK,EAAE;SACzD;QACD,UAAU,EAAE,QAAe;QAC3B,MAAM,EAAE;YACN,CAAC,EAAE,MAAM;SACV;KACF,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,sBAAO,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAE7C,yBAAyB;IACzB,IAAI,YAAY,EAAE;QAChB,MAAM,IAAA,yBAAW,EAAC,YAAY,EAAE,cAAc,CAAC,CAAC;KACjD;IAED,OAAO,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC3C,CAAC;AAjCD,gDAiCC;AAED;;;;;GAKG;AACI,KAAK,UAAU,0BAA0B,CAAC,OAAa;IAC5D,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,oBAAoB,CAAC,MAAM,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;IAEjG,MAAM,cAAc,GAAQ,EAAE,CAAC;IAC/B,WAAW,CAAC,OAAO,CAAC,CAAC,UAAiC,EAAE,EAAE;QACxD,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;AACzC,CAAC;AATD,gEASC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,4BAA4B,CAChD,eAAuB,EACvB,cAA2B;IAE3B,IAAI;QACF,MAAM,GAAG,GAAG,GAAG,eAAe,cAAc,CAAC;QAE7C,MAAM,OAAO,GAAoB;YAC/B,cAAc;YACd,UAAU,EAAE,KAAK;YACjB,MAAM,EAAE;gBACN,CAAC,EAAE,MAAM;aACV;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,sBAAO,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC7C,MAAM,YAAY,GAAG,QAAQ,EAAE,kBAAkB,IAAI,KAAK,CAAC;QAC3D,OAAO,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;KACtC;IAAC,OAAO,GAAG,EAAE;QACZ,8CAA8C;QAC9C,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;KAC/B;AACH,CAAC;AAtBD,oEAsBC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,kBAAkB,CACtC,cAA2B,EAC3B,cAAwB,EACxB,KAAc;IAEd,IAAI,iBAAyB,CAAC;IAE9B,IAAI,CAAC,cAAc,EAAE;QACnB,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1D,KAAK,GAAG,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC;QAE5B,cAAc,GAAG,MAAM,cAAc,CAAC,SAAS,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;KACrE;IAED,MAAM,SAAS,GAAG,WAAW,cAAc,CAAC,cAAc,EAAE,CAAC;IAC7D,MAAM,aAAa,GAAG,GAAG,SAAS,eAAe,CAAC;IAElD,IAAI,cAAc,CAAC,QAAQ,EAAE;QAC3B,aAAa;QACb,iBAAiB,GAAG,MAAM,kCAAkC,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;KAC7F;SAAM;QACL,gBAAgB;QAChB,iBAAiB,GAAG,cAAc,CAAC,cAAc,EAAE,eAAe,EAAE,GAAG,IAAI,SAAS,CAAC;KACtF;IAED,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,iBAAiB,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,iBAAiB,WAAW,CAAC,CAAC;AACpG,CAAC;AA1BD,gDA0BC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,kCAAkC,CACtD,aAAqB,EACrB,cAA2B;IAE3B,kBAAkB;IAClB,MAAM,OAAO,GAAG,MAAM,IAAA,qCAAoB,EAAC,aAAa,EAAE,cAAc,CAAC,CAAC;IAE1E,mCAAmC;IACnC,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAW,EAAE,EAAE,CAAC,MAAM,CAAC,cAAc,KAAK,iBAAiB,CAAC,CAAC;IAClG,IAAI,CAAC,cAAc,EAAE;QACnB,OAAO,EAAE,CAAC;KACX;IACD,OAAO,cAAc,CAAC,GAAa,CAAC;AACtC,CAAC;AAbD,gFAaC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,2BAA2B,CACzC,SAA0B,EAC1B,kBAAuB;IAEvB,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IAErE,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QACpD,kBAAkB,CAAC,SAAS,GAAG,EAAE,GAAG,kBAAkB,CAAC,SAAS,EAAE,CAAC;QACnE,kBAAkB,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;QAE9C,yBAAyB,CAAC,YAAY,EAAE,kBAAkB,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACvE,yBAAyB,CAAC,mBAAmB,EAAE,kBAAkB,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QAC9E,yBAAyB,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QAE3E,OAAO,IAAI,CAAC;IACd,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,MAAM,wBAAwB,GAAG,EAAE,CAAC;IACpC,MAAM,eAAe,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;QAC7C,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE;YACpC,OAAO,IAAI,CAAC;SACb;aAAM;YACL,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SAClC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,eAAe;QACf,wBAAwB;KACzB,CAAC;AACJ,CAAC;AA7BD,kEA6BC;AAED;;;;;;;;GAQG;AACH,SAAgB,yBAAyB,CACvC,GAAW,EACX,kBAAuB,EACvB,QAAuB,EACvB,GAAa;IAEb,MAAM,EAAE,GAAG,IAAA,wBAAO,EAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IAC9F,IAAI,EAAE,IAAI,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE;QAC7B,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;KACd;IACD,kBAAkB,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;IACxD,kBAAkB,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC;AAC9B,CAAC;AAZD,8DAYC;AAED;;;;;;;GAOG;AACH,SAAgB,yBAAyB,CAAC,SAA0B,EAAE,kBAAuB;IAC3F,IAAI,kBAAkB,CAAC,SAAS,EAAE;QAChC,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACtD,qDAAqD;YACrD,wDAAwD;YACxD,MAAM,YAAY,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACrD,MAAM,YAAY,GAAG,YAAY,CAAC,UAAU,CAAC;YAC7C,MAAM,mBAAmB,GAAG,YAAY,CAAC,iBAAiB,CAAC;YAC3D,MAAM,gBAAgB,GAAG,YAAY,CAAC,cAAc,CAAC;YAErD,MAAM,WAAW,GAAG,CAAC,YAAY,EAAE,mBAAmB,EAAE,gBAAgB,CAAC,CAAC;YAE1E,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBAC9B,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;oBACtC,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;wBACxC,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE;4BAC/B,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;yBAClC;wBACD,OAAO,CAAC,CAAC;oBACX,CAAC,CAAC,CAAC;oBACH,CAAC,CAAC,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;iBAChD;gBACD,OAAO,CAAC,CAAC;YACX,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;KACJ;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AA3BD,8DA2BC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAC,QAAuB;IAC7D,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;IAC3B,IAAI,IAAI,EAAE;QACR,MAAM,IAAI,GAAG,CAAC,YAAY,EAAE,mBAAmB,EAAE,gBAAgB,CAAC,CAAC;QACnE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACjB,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE;gBACrC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;gBAC1B,IAAI,EAAE,IAAI,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE;oBAC/C,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;iBAChC;aACF;QACH,CAAC,CAAC,CAAC;KACJ;AACH,CAAC;AAbD,0DAaC"}

package/dist/cjs/workforceHelpers.d.ts

@@ -0,0 +1,121 @@
+/** @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.
+ */
+/**
+ * Provides general helper functions.
+ *
+ * @module workforceHelpers
+ */
+import { UserSession } from "./arcgisRestJS";
+import { IItemTemplate, IFeatureServiceProperties } from "./interfaces";
+/**
+ * Converts an workforce item to a template.
+ *
+ * @param itemTemplate template for the workforce project item
+ * @param authentication credentials for any requests
+ * @param templateDictionary Hash of key details used for variable replacement
+ * @returns templatized itemTemplate
+ */
+export declare function convertWorkforceItemToTemplate(itemTemplate: IItemTemplate, authentication: UserSession, templateDictionary: any): Promise<IItemTemplate>;
+/**
+ * Gets the ids of the dependencies of the workforce project.
+ *
+ * @param data itemTemplate data
+ * @param keyProperties workforce project properties that contain references to dependencies
+ * @param authentication credentials for any requests
+ * @returns List of dependencies ids
+ */
+export declare function extractWorkforceDependencies(data: any, keyProperties: string[], authentication: UserSession): Promise<any>;
+/**
+ * Templatizes key item properties.
+ *
+ * @param data itemTemplate data
+ * @param keyProperties workforce project properties that should be templatized
+ * @param urlHash a key value pair of url and itemId
+ * @param templateDictionary Hash of key details used for variable replacement
+ * @returns an updated data object to be stored in the template
+ */
+export declare function templatizeWorkforce(data: any, keyProperties: string[], urlHash: any, templateDictionary: any): any;
+/**
+ * Evaluate key properties in the workforce service of additional items that are needed
+ *
+ * @param itemTemplate template for the workforce project item
+ * @param dependencies list of the items dependencies
+ * @returns an array of objects with dependency ids
+ */
+export declare function getWorkforceDependencies(itemTemplate: IItemTemplate, dependencies: any[]): any;
+export declare function getWorkforceServiceInfo(properties: IFeatureServiceProperties, url: string, authentication: UserSession): Promise<IFeatureServiceProperties>;
+/**
+ * Wrap global id and assignmenttype values in curly braces
+ *
+ * Added for issue #734
+ *
+ * This function will update the provided workforceInfos object
+ *
+ * @param workforceInfos the object that stores the integration and type info with global ids
+ * @private
+ */
+export declare function _updateGlobalIdAndAssignmentType(workforceInfos: any): void;
+export declare function _getAssignmentTypeInfos(assignmentTypes: any): any[];
+export declare function _getAssignmentIntegrationInfos(assignmentIntegrations: any, authentication: UserSession): Promise<any>;
+export declare function getUrlDependencies(requests: Array<Promise<any>>, urls: string[]): Promise<any>;
+/**
+ * Templatizes values from a urlTemplate
+ *
+ * @param item the object that may contain a urlTemplate
+ * @param urlHash a key value pair of url and itemId
+ * @private
+ */
+export declare function _templatizeUrlTemplate(item: any, urlHash: any): void;
+export declare function getLayerId(url: string): any;
+export declare function getReplaceValue(layerId: any, suffix: string): string;
+export declare function postProcessWorkforceTemplates(templates: IItemTemplate[]): IItemTemplate[];
+export declare function _templatizeWorkforceProject(t: IItemTemplate, groupUpdates: any): any;
+export declare function _templatizeWorkforceDispatcherOrWorker(t: IItemTemplate, type: string): IItemTemplate;
+export declare function isWorkforceProject(itemTemplate: IItemTemplate): boolean;
+export declare function getKeyWorkforceProperties(version: number): string[];
+/**
+ * Test the provided value for any urls and submit a request to obtain the service item id for the url
+ *
+ * @param v a string value to test for urls
+ * @param authentication credentials for the requests
+ * @returns an object with any pending requests and the urls that requests were made to
+ */
+export declare function urlTest(v: any, authentication: UserSession): any;
+export declare function _getURLs(v: string): string[];
+/**
+ * Gets the current user and updates the dispatchers service
+ *
+ * @param newlyCreatedItem Item to be created; n.b.: this item is modified
+ * @param destinationAuthentication The session used to create the new item(s)
+ * @returns A promise that will resolve with \{ "success" === true || false \}
+ */
+export declare function fineTuneCreatedWorkforceItem(newlyCreatedItem: IItemTemplate, destinationAuthentication: UserSession, url: string, templateDictionary: any): Promise<any>;
+export declare function _getFields(url: string, ids: number[], authentication: UserSession): Promise<any>;
+export declare function _updateUrl(url: string): string;
+export declare function _getAddFeatures(updateInfos: any, fields: any[]): any;
+export declare function _getField(name: string, fields: string[]): string;
+/**
+ * Updates the dispatchers service to include the current user as a dispatcher
+ *
+ * @param dispatchers The dispatchers object from the workforce items data
+ * @param name Current users name
+ * @param fullName Current users full name
+ * @param destinationAuthentication The session used to create the new item(s)
+ * @returns A promise that will resolve with true || false
+ * @private
+ */
+export declare function _updateDispatchers(url: any, name: string, fullName: string, authentication: UserSession, isPortal: boolean): Promise<boolean>;
+export declare function _applyEdits(url: string, adds: any[], authentication: UserSession, useGlobalIds?: boolean): any;