@esri/solution-simple-types 5.2.3 → 5.2.4

package/dist/cjs/helpers/convert-item-to-template.js

@@ -0,0 +1,246 @@
+"use strict";
+/** @license
+ * Copyright 2020 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._getFormDataFilename = exports._getDataPipelineSourcesAndSinks = exports.convertItemToTemplate = void 0;
+const tslib_1 = require("tslib");
+const common = tslib_1.__importStar(require("@esri/solution-common"));
+const dashboard = tslib_1.__importStar(require("../dashboard"));
+const notebook = tslib_1.__importStar(require("../notebook"));
+const oic = tslib_1.__importStar(require("../oic"));
+const quickcapture = tslib_1.__importStar(require("../quickcapture"));
+const webmap = tslib_1.__importStar(require("../webmap"));
+const webmappingapplication = tslib_1.__importStar(require("../webmappingapplication"));
+const workforce = tslib_1.__importStar(require("../workforce"));
+const formHelpers = tslib_1.__importStar(require("./formHelpers"));
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Converts an 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
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ *
+ * @returns A promise that will resolve when the template has been created
+ */
+function convertItemToTemplate(itemInfo, destAuthentication, srcAuthentication, templateDictionary) {
+    return new Promise((resolve, reject) => {
+        // 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);
+        // Perform type-specific handling
+        let dataPromise = Promise.resolve({});
+        let resourcesPromise = Promise.resolve([]);
+        switch (itemInfo.type) {
+            case "Dashboard":
+            case "Data Pipeline":
+            case "Feature Collection":
+            case "Feature Service":
+            case "Hub Initiative":
+            case "Hub Page":
+            case "Hub Site Application":
+            case "Insights Model":
+            case "Oriented Imagery Catalog":
+            case "Project Package":
+            case "Workforce Project":
+            case "Web Map":
+            case "Web Mapping Application":
+            case "Web Scene":
+            case "Notebook":
+                dataPromise = new Promise(resolveJSON => {
+                    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+                    common
+                        .getItemDataAsJson(itemTemplate.itemId, srcAuthentication)
+                        .then(json => resolveJSON(json));
+                });
+                break;
+            case "Form":
+                dataPromise = common.getItemDataAsFile(itemTemplate.itemId, itemTemplate.item.name, srcAuthentication);
+                break;
+            case "QuickCapture Project":
+                // Fetch all of the resources to get the config
+                resourcesPromise = common.getItemResourcesFiles(itemTemplate.itemId, srcAuthentication);
+                break;
+        }
+        // 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, resourcesPromise]).then(responses => {
+            const [itemDataResponse, relatedItemsResponse, resourcesResponse] = responses;
+            // need to pre-process for velocity urls before they could be templatized by other processors
+            itemTemplate.data = common.updateVelocityReferences(itemDataResponse, itemInfo.type, templateDictionary);
+            const relationships = relatedItemsResponse;
+            // Save the mappings to related items & add those items to the dependencies, but not WMA Code Attachments
+            itemTemplate.dependencies = [];
+            itemTemplate.relatedItems = [];
+            relationships.forEach(relationship => {
+                /* istanbul ignore else */
+                if (relationship.relationshipType !== "WMA2Code") {
+                    itemTemplate.relatedItems.push(relationship);
+                    relationship.relatedItemIds.forEach(relatedItemId => {
+                        if (itemTemplate.dependencies.indexOf(relatedItemId) < 0) {
+                            itemTemplate.dependencies.push(relatedItemId);
+                        }
+                    });
+                }
+            });
+            // Add Data Pipeline source and sink feature layers to dependencies
+            if (itemInfo.type === "Data Pipeline") {
+                itemTemplate.dependencies = itemTemplate.dependencies.concat(_getDataPipelineSourcesAndSinks(itemDataResponse));
+            }
+            // Create the template
+            let templateModifyingPromise = Promise.resolve(itemTemplate);
+            switch (itemInfo.type) {
+                case "Dashboard":
+                    dashboard.convertItemToTemplate(itemTemplate, templateDictionary);
+                    break;
+                case "Form":
+                    // Store the form's data in the solution resources, not in template
+                    itemTemplate.data = null;
+                    // Add the form data to the template for a post-process resource upload
+                    if (itemDataResponse) {
+                        templateModifyingPromise = new Promise(
+                        // eslint-disable-next-line @typescript-eslint/no-misused-promises, no-async-promise-executor
+                        async (resolve) => {
+                            let zipObject = await common.blobToZipObject(itemDataResponse);
+                            // Templatize the form's webhooks,
+                            zipObject = await formHelpers.templatizeFormWebHooks(zipObject, itemTemplate.item.isOrgItem);
+                            itemTemplate.item.name = _getFormDataFilename(itemTemplate.item.name, itemDataResponse.name, `${itemTemplate.itemId}.zip`);
+                            const templatizedFormData = await common.zipObjectToZipFile(zipObject, itemTemplate.item.name);
+                            // Add the data file to the template so that it can be uploaded with the other resources in the solution
+                            const storageName = common.convertItemResourceToStorageResource(itemTemplate.itemId, itemTemplate.item.name, common.SolutionTemplateFormatVersion, common.SolutionResourceType.data);
+                            const dataFile = {
+                                itemId: itemTemplate.itemId,
+                                file: templatizedFormData,
+                                folder: storageName.folder,
+                                filename: itemTemplate.item.name
+                            };
+                            itemTemplate.dataFile = dataFile;
+                            // Update the template's resources
+                            itemTemplate.resources.push(storageName.folder + "/" + storageName.filename);
+                            resolve(itemTemplate);
+                        });
+                    }
+                    break;
+                case "Notebook":
+                    notebook.convertNotebookToTemplate(itemTemplate);
+                    break;
+                case "Oriented Imagery Catalog":
+                    templateModifyingPromise = oic.convertItemToTemplate(itemTemplate, destAuthentication, srcAuthentication);
+                    break;
+                case "QuickCapture Project":
+                    // Save all of the resources that we've fetched so as to not fetch them again
+                    itemTemplate.resources = resourcesResponse;
+                    // Get the QC config
+                    templateModifyingPromise = new Promise(
+                    // eslint-disable-next-line @typescript-eslint/no-misused-promises, no-async-promise-executor
+                    async (qcResolve) => {
+                        // Remove the qc.project.json file from the list of resources
+                        let qcProjectFile = null;
+                        let iQcProjectFile = -1;
+                        if (resourcesResponse) {
+                            resourcesResponse.some((file, i) => {
+                                const haveConfigFile = file.name === "qc.project.json";
+                                if (haveConfigFile) {
+                                    qcProjectFile = file;
+                                    iQcProjectFile = i;
+                                }
+                                return haveConfigFile;
+                            });
+                            // Discard the qc.project.json file
+                            if (iQcProjectFile >= 0) {
+                                resourcesResponse.splice(iQcProjectFile, 1);
+                            }
+                        }
+                        // Copy the qc.project.json file into the data section
+                        if (qcProjectFile) {
+                            itemTemplate.data = {
+                                application: {
+                                    ...await common.blobToJson(qcProjectFile),
+                                },
+                                name: "qc.project.json"
+                            };
+                        }
+                        // Save the basemap dependency
+                        if (itemTemplate.data.application?.basemap?.type === "Web Map") {
+                            itemTemplate.dependencies.push(itemTemplate.data.application.basemap.itemId);
+                        }
+                        // Create the template
+                        const updatedTemplate = quickcapture.convertQuickCaptureToTemplate(itemTemplate);
+                        qcResolve(updatedTemplate);
+                    });
+                    break;
+                case "Vector Tile Service":
+                case "Web Map":
+                case "Web Scene":
+                    templateModifyingPromise = webmap.convertItemToTemplate(itemTemplate, destAuthentication, srcAuthentication, templateDictionary);
+                    break;
+                case "Web Mapping Application":
+                    if (itemDataResponse) {
+                        templateModifyingPromise = webmappingapplication.convertItemToTemplate(itemTemplate, destAuthentication, srcAuthentication, templateDictionary);
+                    }
+                    break;
+                case "Workforce Project":
+                    templateModifyingPromise = workforce.convertItemToTemplate(itemTemplate, destAuthentication, srcAuthentication, templateDictionary);
+                    break;
+            }
+            templateModifyingPromise.then(resolve, err => reject(common.fail(err)));
+        });
+    });
+}
+exports.convertItemToTemplate = convertItemToTemplate;
+/**
+ * Extracts the feature layer ids for a Data Pipeline's sources and sinks.
+ *
+ * @param itemData Data Pipeline's data section
+ * @return List of feature layer ids or an empty list if there are no sources or sinks in the pipeline
+ */
+function _getDataPipelineSourcesAndSinks(itemData) {
+    const dependencies = [];
+    const sourcesAndSinks = (itemData?.inputs ?? []).concat(itemData?.outputs ?? []);
+    sourcesAndSinks.forEach(sourceOrSink => {
+        if (sourceOrSink.type === "FeatureServiceSource" || sourceOrSink.type === "FeatureServiceSink") {
+            const featureServiceId = common.getProp(sourceOrSink, "parameters.layer.value.itemId");
+            if (featureServiceId) {
+                dependencies.push(featureServiceId);
+            }
+        }
+    });
+    return dependencies;
+}
+exports._getDataPipelineSourcesAndSinks = _getDataPipelineSourcesAndSinks;
+/**
+ * Encapsulates the rules for naming a form's data file.
+ * Chooses the first parameter that's defined and is not the string "undefined".
+ *
+ * @param itemName Template's item name
+ * @param dataFilename The data file name
+ * @param itemIdAsName A name constructed from the template's id suffixed with ".zip"
+ *
+ * @return A name for the data file
+ */
+function _getFormDataFilename(itemName, dataFilename, itemIdAsName) {
+    const originalFilename = itemName || dataFilename;
+    const filename = originalFilename && originalFilename !== "undefined"
+        ? originalFilename
+        : itemIdAsName;
+    return filename;
+}
+exports._getFormDataFilename = _getFormDataFilename;
+//# sourceMappingURL=convert-item-to-template.js.map

package/dist/cjs/helpers/convert-item-to-template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert-item-to-template.js","sourceRoot":"","sources":["../../../src/helpers/convert-item-to-template.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AAEH,sEAAgD;AAChD,gEAA0C;AAC1C,8DAAwC;AACxC,oDAA8B;AAC9B,sEAAgD;AAChD,0DAAoC;AACpC,wFAAkE;AAClE,gEAA0C;AAC1C,mEAA6C;AAG7C,wHAAwH;AAExH;;;;;;;;;GASG;AACH,SAAgB,qBAAqB,CACnC,QAAa,EACb,kBAAsC,EACtC,iBAAqC,EACrC,kBAAuB;IAEvB,OAAO,IAAI,OAAO,CAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3D,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,wBAAwB;QACxB,MAAM,cAAc,GAAG,MAAM,CAAC,kCAAkC,CAC9D,YAAY,CAAC,MAAM,EACnB,SAAS,EACT,iBAAiB,CAClB,CAAC;QAEF,iCAAiC;QACjC,IAAI,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACtC,IAAI,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC3C,QAAQ,QAAQ,CAAC,IAAI,EAAE;YACrB,KAAK,WAAW,CAAC;YACjB,KAAK,eAAe,CAAC;YACrB,KAAK,oBAAoB,CAAC;YAC1B,KAAK,iBAAiB,CAAC;YACvB,KAAK,gBAAgB,CAAC;YACtB,KAAK,UAAU,CAAC;YAChB,KAAK,sBAAsB,CAAC;YAC5B,KAAK,gBAAgB,CAAC;YACtB,KAAK,0BAA0B,CAAC;YAChC,KAAK,iBAAiB,CAAC;YACvB,KAAK,mBAAmB,CAAC;YACzB,KAAK,SAAS,CAAC;YACf,KAAK,yBAAyB,CAAC;YAC/B,KAAK,WAAW,CAAC;YACjB,KAAK,UAAU;gBACb,WAAW,GAAG,IAAI,OAAO,CAAC,WAAW,CAAC,EAAE;oBACtC,mEAAmE;oBACnE,MAAM;yBACH,iBAAiB,CAAC,YAAY,CAAC,MAAM,EAAE,iBAAiB,CAAC;yBACzD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;gBACrC,CAAC,CAAC,CAAC;gBACH,MAAM;YACR,KAAK,MAAM;gBACT,WAAW,GAAG,MAAM,CAAC,iBAAiB,CACpC,YAAY,CAAC,MAAM,EACnB,YAAY,CAAC,IAAI,CAAC,IAAI,EACtB,iBAAiB,CAClB,CAAC;gBACF,MAAM;YACR,KAAK,sBAAsB;gBACzB,+CAA+C;gBAC/C,gBAAgB,GAAG,MAAM,CAAC,qBAAqB,CAC7C,YAAY,CAAC,MAAM,EACnB,iBAAiB,CAClB,CAAC;gBACF,MAAM;SACT;QAED,4GAA4G;QAC5G,mEAAmE;QACnE,OAAO,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,cAAc,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC5E,MAAM,CAAC,gBAAgB,EAAE,oBAAoB,EAAE,iBAAiB,CAAC,GAAG,SAAS,CAAC;YAE9E,6FAA6F;YAC7F,YAAY,CAAC,IAAI,GAAG,MAAM,CAAC,wBAAwB,CACjD,gBAAgB,EAChB,QAAQ,CAAC,IAAI,EACb,kBAAkB,CACnB,CAAC;YACF,MAAM,aAAa,GAAG,oBAAoB,CAAC;YAE3C,yGAAyG;YACzG,YAAY,CAAC,YAAY,GAAG,EAAc,CAAC;YAC3C,YAAY,CAAC,YAAY,GAAG,EAA4B,CAAC;YAEzD,aAAa,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;gBACnC,0BAA0B;gBAC1B,IAAI,YAAY,CAAC,gBAAgB,KAAK,UAAU,EAAE;oBAChD,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;oBAC7C,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;wBAClD,IAAI,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;4BACxD,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;yBAC/C;oBACH,CAAC,CAAC,CAAC;iBACJ;YACH,CAAC,CAAC,CAAC;YAEH,mEAAmE;YACnE,IAAI,QAAQ,CAAC,IAAI,KAAK,eAAe,EAAE;gBACrC,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC,MAAM,CAAC,+BAA+B,CAAC,gBAAgB,CAAC,CAAC,CAAC;aACjH;YAED,sBAAsB;YACtB,IAAI,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YAC7D,QAAQ,QAAQ,CAAC,IAAI,EAAE;gBACrB,KAAK,WAAW;oBACd,SAAS,CAAC,qBAAqB,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;oBAClE,MAAM;gBACR,KAAK,MAAM;oBACT,mEAAmE;oBACnE,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC;oBAEzB,uEAAuE;oBACvE,IAAI,gBAAgB,EAAE;wBACpB,wBAAwB,GAAG,IAAI,OAAO;wBACpC,6FAA6F;wBAC7F,KAAK,EAAE,OAAO,EAAE,EAAE;4BAChB,IAAI,SAAS,GAAU,MAAM,MAAM,CAAC,eAAe,CAAC,gBAAwB,CAAC,CAAC;4BAE9E,kCAAkC;4BAClC,SAAS,GAAG,MAAM,WAAW,CAAC,sBAAsB,CAAC,SAAS,EAAE,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;4BAE7F,YAAY,CAAC,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAC3C,YAAY,CAAC,IAAI,CAAC,IAAI,EAAG,gBAAyB,CAAC,IAAI,EAAE,GAAG,YAAY,CAAC,MAAM,MAAM,CACtF,CAAC;4BACF,MAAM,mBAAmB,GAAS,MAAM,MAAM,CAAC,kBAAkB,CAAC,SAAS,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;4BAErG,wGAAwG;4BACxG,MAAM,WAAW,GAAG,MAAM,CAAC,oCAAoC,CAC7D,YAAY,CAAC,MAAM,EACnB,YAAY,CAAC,IAAI,CAAC,IAAI,EACtB,MAAM,CAAC,6BAA6B,EACpC,MAAM,CAAC,oBAAoB,CAAC,IAAI,CACjC,CAAC;4BAEF,MAAM,QAAQ,GAAuB;gCACnC,MAAM,EAAE,YAAY,CAAC,MAAM;gCAC3B,IAAI,EAAE,mBAAmB;gCACzB,MAAM,EAAE,WAAW,CAAC,MAAM;gCAC1B,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI;6BACjC,CAAA;4BACD,YAAY,CAAC,QAAQ,GAAG,QAAQ,CAAC;4BAEjC,kCAAkC;4BAClC,YAAY,CAAC,SAAS,CAAC,IAAI,CACzB,WAAW,CAAC,MAAM,GAAG,GAAG,GAAG,WAAW,CAAC,QAAQ,CAChD,CAAC;4BAEF,OAAO,CAAC,YAAY,CAAC,CAAC;wBACxB,CAAC,CACF,CAAC;qBACH;oBACD,MAAM;gBACR,KAAK,UAAU;oBACb,QAAQ,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC;oBACjD,MAAM;gBACR,KAAK,0BAA0B;oBAC7B,wBAAwB,GAAG,GAAG,CAAC,qBAAqB,CAClD,YAAY,EACZ,kBAAkB,EAClB,iBAAiB,CAClB,CAAC;oBACF,MAAM;gBACR,KAAK,sBAAsB;oBACzB,6EAA6E;oBAC7E,YAAY,CAAC,SAAS,GAAG,iBAAiB,CAAC;oBAE3C,oBAAoB;oBACpB,wBAAwB,GAAG,IAAI,OAAO;oBACpC,6FAA6F;oBAC7F,KAAK,EAAE,SAAS,EAAE,EAAE;wBAClB,6DAA6D;wBAC7D,IAAI,aAAa,GAAS,IAAI,CAAC;wBAC/B,IAAI,cAAc,GAAW,CAAC,CAAC,CAAC;wBAChC,IAAI,iBAAiB,EAAE;4BACrB,iBAAiB,CAAC,IAAI,CACpB,CAAC,IAAU,EAAE,CAAS,EAAE,EAAE;gCACxB,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,KAAK,iBAAiB,CAAC;gCACvD,IAAI,cAAc,EAAE;oCAClB,aAAa,GAAG,IAAI,CAAC;oCACrB,cAAc,GAAG,CAAC,CAAC;iCACpB;gCACD,OAAO,cAAc,CAAC;4BACxB,CAAC,CACF,CAAC;4BAEF,mCAAmC;4BACnC,IAAI,cAAc,IAAI,CAAC,EAAE;gCACvB,iBAAiB,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;6BAC7C;yBACF;wBAED,sDAAsD;wBACtD,IAAI,aAAa,EAAE;4BACjB,YAAY,CAAC,IAAI,GAAG;gCAClB,WAAW,EAAE;oCACX,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC;iCAC1C;gCACD,IAAI,EAAE,iBAAiB;6BACxB,CAAA;yBACF;wBAED,8BAA8B;wBAC9B,IAAI,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE,IAAI,KAAK,SAAS,EAAE;4BAC9D,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;yBAC9E;wBAED,sBAAsB;wBACtB,MAAM,eAAe,GAAG,YAAY,CAAC,6BAA6B,CAAC,YAAY,CAAC,CAAC;wBACjF,SAAS,CAAC,eAAe,CAAC,CAAC;oBAC7B,CAAC,CACF,CAAC;oBACF,MAAM;gBACR,KAAK,qBAAqB,CAAC;gBAC3B,KAAK,SAAS,CAAC;gBACf,KAAK,WAAW;oBACd,wBAAwB,GAAG,MAAM,CAAC,qBAAqB,CACrD,YAAY,EACZ,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,CACnB,CAAC;oBACF,MAAM;gBACR,KAAK,yBAAyB;oBAC5B,IAAI,gBAAgB,EAAE;wBACpB,wBAAwB,GAAG,qBAAqB,CAAC,qBAAqB,CACpE,YAAY,EACZ,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,CACnB,CAAC;qBACH;oBACD,MAAM;gBACR,KAAK,mBAAmB;oBACtB,wBAAwB,GAAG,SAAS,CAAC,qBAAqB,CACxD,YAAY,EACZ,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,CACnB,CAAC;oBACF,MAAM;aACT;YAED,wBAAwB,CAAC,IAAI,CAC3B,OAAO,EACP,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAChC,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAzPD,sDAyPC;AAED;;;;;GAKG;AACH,SAAgB,+BAA+B,CAC7C,QAAa;IAEb,MAAM,YAAY,GAAG,EAAc,CAAC;IACpC,MAAM,eAAe,GAAG,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC;IAEjF,eAAe,CAAC,OAAO,CACrB,YAAY,CAAC,EAAE;QACb,IAAI,YAAY,CAAC,IAAI,KAAK,sBAAsB,IAAI,YAAY,CAAC,IAAI,KAAK,oBAAoB,EAAE;YAC9F,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE,+BAA+B,CAAC,CAAA;YACtF,IAAI,gBAAgB,EAAE;gBACpB,YAAY,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACrC;SACF;IACH,CAAC,CACF,CAAC;IAEF,OAAO,YAAY,CAAC;AACtB,CAAC;AAlBD,0EAkBC;AAED;;;;;;;;;GASG;AACH,SAAgB,oBAAoB,CAClC,QAAgB,EAChB,YAAoB,EACpB,YAAoB;IAEpB,MAAM,gBAAgB,GAAG,QAAQ,IAAI,YAAY,CAAC;IAClD,MAAM,QAAQ,GACZ,gBAAgB,IAAI,gBAAgB,KAAK,WAAW;QAClD,CAAC,CAAC,gBAAgB;QAClB,CAAC,CAAC,YAAY,CAAC;IACnB,OAAO,QAAQ,CAAC;AAClB,CAAC;AAXD,oDAWC"}

package/dist/cjs/helpers/create-item-from-template.d.ts

@@ -0,0 +1,17 @@
+/** @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.
+ */
+import * as common from "@esri/solution-common";
+export declare function createItemFromTemplate(template: common.IItemTemplate, templateDictionary: any, destinationAuthentication: common.UserSession, itemProgressCallback: common.IItemProgressCallback): Promise<common.ICreateItemFromTemplateResponse>;

package/dist/cjs/helpers/create-item-from-template.js

@@ -0,0 +1,154 @@
+"use strict";
+/** @license
+ * Copyright 2020 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createItemFromTemplate = void 0;
+const tslib_1 = require("tslib");
+const common = tslib_1.__importStar(require("@esri/solution-common"));
+const notebook = tslib_1.__importStar(require("../notebook"));
+const webmappingapplication = tslib_1.__importStar(require("../webmappingapplication"));
+const workforce = tslib_1.__importStar(require("../workforce"));
+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));
+        }
+        else {
+            // Replace the templatized symbols in a copy of the template
+            let newItemTemplate = common.cloneObject(template);
+            newItemTemplate = common.replaceInTemplate(newItemTemplate, templateDictionary);
+            let qcProjectFileContents;
+            // Create the item, then update its URL with its new id
+            // some fieldnames are used as keys for objects
+            // when we templatize field references for web applications we first stringify the components of the
+            // web application that could contain field references and then search for them with a regular expression.
+            // We also need to stringify the web application when de-templatizing so it will find all of these occurrences as well.
+            if (template.type === "Web Mapping Application" && template.data) {
+                newItemTemplate = JSON.parse(common.replaceInTemplate(JSON.stringify(newItemTemplate), templateDictionary));
+            }
+            else if (template.type === "QuickCapture Project" && template.data) {
+                // Save the data section for creating the qc.project.json later
+                qcProjectFileContents = JSON.stringify(newItemTemplate.data.application);
+                // Delete the data section
+                delete newItemTemplate.data;
+            }
+            if (template.item.thumbnail) {
+                newItemTemplate.item.thumbnail = template.item.thumbnail; // make sure that our File is still there
+            }
+            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
+                    templateDictionary[template.itemId] = {
+                        itemId: createResponse.id,
+                        itemUrl: templateDictionary["portalBaseUrl"] + "/sharing/rest/content/items/" + createResponse.id
+                    };
+                    newItemTemplate.itemId = createResponse.id;
+                    // Set the appItemId manually to get around cases where the path was incorrectly set
+                    // in legacy deployments
+                    if (newItemTemplate.type === "Web Mapping Application" &&
+                        template.data) {
+                        common.setProp(newItemTemplate, "data.appItemId", createResponse.id);
+                    }
+                    const postProcess = common.hasUnresolvedVariables(newItemTemplate.data);
+                    // Update the template again now that we have the new item id
+                    const originalURL = newItemTemplate.item.url;
+                    newItemTemplate = common.replaceInTemplate(newItemTemplate, templateDictionary);
+                    // Update relationships
+                    let relationshipsDef = Promise.resolve([]);
+                    if (newItemTemplate.relatedItems) {
+                        // Templatize references in relationships obj
+                        const updatedRelatedItems = common.replaceInTemplate(common.templatizeIds(newItemTemplate.relatedItems), templateDictionary);
+                        // Add the relationships
+                        relationshipsDef = common.addForwardItemRelationships(newItemTemplate.itemId, updatedRelatedItems, destinationAuthentication);
+                    }
+                    // Check for extra processing for web mapping application et al.
+                    let customProcDef;
+                    if (template.type === "Web Mapping Application" &&
+                        template.data &&
+                        common.hasAnyKeyword(template, [
+                            "WAB2D",
+                            "WAB3D",
+                            "Web AppBuilder"
+                        ])) {
+                        // If this is a Web AppBuilder application, we will create a Code Attachment for downloading
+                        customProcDef = webmappingapplication.fineTuneCreatedItem(template, newItemTemplate, templateDictionary, destinationAuthentication);
+                    }
+                    else if (template.type === "Workforce Project") {
+                        customProcDef = workforce.fineTuneCreatedItem(newItemTemplate, destinationAuthentication, templateDictionary);
+                    }
+                    else if (template.type === "QuickCapture Project") {
+                        if (qcProjectFileContents) {
+                            // Generate the qc.project.json file resource from the data section after handling templatized variables
+                            const qcProjectFile = common.jsonToFile(common.replaceInTemplate(JSON.parse(qcProjectFileContents), templateDictionary), "qc.project.json");
+                            // Send the created qc.project.json file to the item
+                            customProcDef = common.addResourceFromBlob(qcProjectFile, newItemTemplate.itemId, "", qcProjectFile.name, destinationAuthentication);
+                        }
+                    }
+                    else if (template.type === "Notebook") {
+                        customProcDef = notebook.fineTuneCreatedItem(template, newItemTemplate, templateDictionary, destinationAuthentication);
+                    }
+                    else if (originalURL !== newItemTemplate.item.url) {
+                        // For web mapping applications that are not Web AppBuilder apps
+                        customProcDef = new Promise((resolve2, reject2) => {
+                            common
+                                .updateItemURL(createResponse.id, newItemTemplate.item.url, destinationAuthentication)
+                                .then(() => resolve2(), reject2);
+                        });
+                    }
+                    else {
+                        customProcDef = Promise.resolve(null);
+                    }
+                    Promise.all([relationshipsDef, customProcDef]).then(() => {
+                        // Interrupt process if progress callback returns `false`
+                        if (!itemProgressCallback(template.itemId, common.EItemProgressStatus.Finished, 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 {
+                            resolve({
+                                item: newItemTemplate,
+                                id: createResponse.id,
+                                type: newItemTemplate.type,
+                                postProcess: postProcess
+                            });
+                        }
+                    }, () => {
+                        itemProgressCallback(template.itemId, common.EItemProgressStatus.Failed, 0);
+                        resolve(common.generateEmptyCreationResponse(template.type)); // fails to deploy all resources to the item
+                    });
+                }
+            }, () => {
+                itemProgressCallback(template.itemId, common.EItemProgressStatus.Failed, 0);
+                resolve(common.generateEmptyCreationResponse(template.type)); // fails to create item
+            });
+        }
+    });
+}
+exports.createItemFromTemplate = createItemFromTemplate;
+//# sourceMappingURL=create-item-from-template.js.map

package/dist/cjs/helpers/create-item-from-template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-item-from-template.js","sourceRoot":"","sources":["../../../src/helpers/create-item-from-template.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AAEH,sEAAgD;AAChD,8DAAwC;AACxC,wFAAkE;AAClE,gEAA0C;AAE1C,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;SAC9D;aAAM;YACL,4DAA4D;YAC5D,IAAI,eAAe,GAAyB,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YACzE,eAAe,GAAG,MAAM,CAAC,iBAAiB,CACxC,eAAe,EACf,kBAAkB,CACnB,CAAC;YAEF,IAAI,qBAA6B,CAAC;YAElC,uDAAuD;YAEvD,+CAA+C;YAC/C,oGAAoG;YACpG,0GAA0G;YAC1G,uHAAuH;YACvH,IAAI,QAAQ,CAAC,IAAI,KAAK,yBAAyB,IAAI,QAAQ,CAAC,IAAI,EAAE;gBAChE,eAAe,GAAG,IAAI,CAAC,KAAK,CAC1B,MAAM,CAAC,iBAAiB,CACtB,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,EAC/B,kBAAkB,CACnB,CACF,CAAC;aAGH;iBAAM,IAAI,QAAQ,CAAC,IAAI,KAAK,sBAAsB,IAAI,QAAQ,CAAC,IAAI,EAAE;gBACpE,+DAA+D;gBAC/D,qBAAqB,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAEzE,0BAA0B;gBAC1B,OAAO,eAAe,CAAC,IAAI,CAAC;aAC7B;YAED,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE;gBAC3B,eAAe,CAAC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,yCAAyC;aACpG;YAED,MAAM;iBACH,kBAAkB,CACjB,eAAe,CAAC,IAAI,EACpB,eAAe,CAAC,IAAI,EACpB,yBAAyB,EACzB,kBAAkB,CAAC,QAAQ,CAC5B;iBACA,IAAI,CACH,cAAc,CAAC,EAAE;gBACf,yDAAyD;gBACzD,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;oBACA,oBAAoB,CAClB,QAAQ,CAAC,MAAM,EACf,MAAM,CAAC,mBAAmB,CAAC,SAAS,EACpC,CAAC,CACF,CAAC;oBACF,MAAM;yBACH,UAAU,CAAC,cAAc,CAAC,EAAE,EAAE,yBAAyB,CAAC;yBACxD,IAAI,CACH,GAAG,EAAE,CACH,OAAO,CACL,MAAM,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CACpD,EACH,GAAG,EAAE,CACH,OAAO,CAAC,MAAM,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAC/D,CAAC;iBACL;qBAAM;oBACL,mCAAmC;oBACnC,kBAAkB,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG;wBACpC,MAAM,EAAE,cAAc,CAAC,EAAE;wBACzB,OAAO,EAAG,kBAAkB,CAAC,eAAe,CAAY,GAAG,8BAA8B,GAAG,cAAc,CAAC,EAAE;qBAC9G,CAAA;oBACD,eAAe,CAAC,MAAM,GAAG,cAAc,CAAC,EAAE,CAAC;oBAE3C,oFAAoF;oBACpF,wBAAwB;oBACxB,IACE,eAAe,CAAC,IAAI,KAAK,yBAAyB;wBAClD,QAAQ,CAAC,IAAI,EACb;wBACA,MAAM,CAAC,OAAO,CACZ,eAAe,EACf,gBAAgB,EAChB,cAAc,CAAC,EAAE,CAClB,CAAC;qBACH;oBACD,MAAM,WAAW,GAAY,MAAM,CAAC,sBAAsB,CACxD,eAAe,CAAC,IAAI,CACrB,CAAC;oBAEF,6DAA6D;oBAC7D,MAAM,WAAW,GAAG,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC;oBAC7C,eAAe,GAAG,MAAM,CAAC,iBAAiB,CACxC,eAAe,EACf,kBAAkB,CACnB,CAAC;oBAEF,uBAAuB;oBACvB,IAAI,gBAAgB,GAAG,OAAO,CAAC,OAAO,CACpC,EAA8B,CAC/B,CAAC;oBACF,IAAI,eAAe,CAAC,YAAY,EAAE;wBAChC,6CAA6C;wBAC7C,MAAM,mBAAmB,GAAG,MAAM,CAAC,iBAAiB,CAClD,MAAM,CAAC,aAAa,CAAC,eAAe,CAAC,YAAY,CAAC,EAClD,kBAAkB,CACO,CAAC;wBAE5B,wBAAwB;wBACxB,gBAAgB,GAAG,MAAM,CAAC,2BAA2B,CACnD,eAAe,CAAC,MAAM,EACtB,mBAAmB,EACnB,yBAAyB,CAC1B,CAAC;qBACH;oBAED,gEAAgE;oBAChE,IAAI,aAA4B,CAAC;oBACjC,IACE,QAAQ,CAAC,IAAI,KAAK,yBAAyB;wBAC3C,QAAQ,CAAC,IAAI;wBACb,MAAM,CAAC,aAAa,CAAC,QAAQ,EAAE;4BAC7B,OAAO;4BACP,OAAO;4BACP,gBAAgB;yBACjB,CAAC,EACF;wBACA,4FAA4F;wBAC5F,aAAa,GAAG,qBAAqB,CAAC,mBAAmB,CACvD,QAAQ,EACR,eAAe,EACf,kBAAkB,EAClB,yBAAyB,CAC1B,CAAC;qBACH;yBAAM,IAAI,QAAQ,CAAC,IAAI,KAAK,mBAAmB,EAAE;wBAChD,aAAa,GAAG,SAAS,CAAC,mBAAmB,CAC3C,eAAe,EACf,yBAAyB,EACzB,kBAAkB,CACnB,CAAC;qBACH;yBAAM,IAAI,QAAQ,CAAC,IAAI,KAAK,sBAAsB,EAAE;wBACnD,IAAI,qBAAqB,EAAE;4BACzB,wGAAwG;4BACxG,MAAM,aAAa,GAAG,MAAM,CAAC,UAAU,CACrC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,EAAE,kBAAkB,CAAC,EAC/E,iBAAiB,CAClB,CAAC;4BAEF,oDAAoD;4BACpD,aAAa,GAAG,MAAM,CAAC,mBAAmB,CACxC,aAAa,EAAE,eAAe,CAAC,MAAM,EAAE,EAAE,EAAE,aAAa,CAAC,IAAI,EAAE,yBAAyB,CAAC,CAAC;yBAC7F;qBAEF;yBAAM,IAAI,QAAQ,CAAC,IAAI,KAAK,UAAU,EAAE;wBACvC,aAAa,GAAG,QAAQ,CAAC,mBAAmB,CAC1C,QAAQ,EACR,eAAe,EACf,kBAAkB,EAClB,yBAAyB,CAC1B,CAAC;qBACH;yBAAM,IAAI,WAAW,KAAK,eAAe,CAAC,IAAI,CAAC,GAAG,EAAE;wBACnD,gEAAgE;wBAChE,aAAa,GAAG,IAAI,OAAO,CAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE;4BACtD,MAAM;iCACH,aAAa,CACZ,cAAc,CAAC,EAAE,EACjB,eAAe,CAAC,IAAI,CAAC,GAAG,EACxB,yBAAyB,CAC1B;iCACA,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;wBACrC,CAAC,CAAC,CAAC;qBACJ;yBAAM;wBACL,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;qBACvC;oBAED,OAAO,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC,CAAC,IAAI,CACjD,GAAG,EAAE;wBACH,yDAAyD;wBACzD,IACE,CAAC,oBAAoB,CACnB,QAAQ,CAAC,MAAM,EACf,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EACnC,QAAQ,CAAC,6BAA6B,GAAG,CAAC,EAC1C,cAAc,CAAC,EAAE,CAClB,EACD;4BACA,oBAAoB,CAClB,QAAQ,CAAC,MAAM,EACf,MAAM,CAAC,mBAAmB,CAAC,SAAS,EACpC,CAAC,CACF,CAAC;4BACF,MAAM;iCACH,UAAU,CAAC,cAAc,CAAC,EAAE,EAAE,yBAAyB,CAAC;iCACxD,IAAI,CACH,GAAG,EAAE,CACH,OAAO,CACL,MAAM,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CACpD,EACH,GAAG,EAAE,CACH,OAAO,CACL,MAAM,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CACpD,CACJ,CAAC;yBACL;6BAAM;4BACL,OAAO,CAAC;gCACN,IAAI,EAAE,eAAe;gCACrB,EAAE,EAAE,cAAc,CAAC,EAAE;gCACrB,IAAI,EAAE,eAAe,CAAC,IAAI;gCAC1B,WAAW,EAAE,WAAW;6BACzB,CAAC,CAAC;yBACJ;oBACH,CAAC,EACD,GAAG,EAAE;wBACH,oBAAoB,CAClB,QAAQ,CAAC,MAAM,EACf,MAAM,CAAC,mBAAmB,CAAC,MAAM,EACjC,CAAC,CACF,CAAC;wBACF,OAAO,CAAC,MAAM,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,4CAA4C;oBAC5G,CAAC,CACF,CAAC;iBACH;YACH,CAAC,EACD,GAAG,EAAE;gBACH,oBAAoB,CAClB,QAAQ,CAAC,MAAM,EACf,MAAM,CAAC,mBAAmB,CAAC,MAAM,EACjC,CAAC,CACF,CAAC;gBACF,OAAO,CAAC,MAAM,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,uBAAuB;YACvF,CAAC,CACF,CAAC;SACL;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAnQD,wDAmQC"}

package/dist/cjs/helpers/formHelpers.d.ts

@@ -0,0 +1,25 @@
+/** @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.
+ */
+import JSZip from "jszip";
+/**
+ * Templatizes the URLs in webhooks in a form's zip object.
+ *
+ * @param zipObject Form zip object to templatize; it is modified in place
+ * @param isOrgItem Indicates whether this item and the user whose credential was used to fetch this item belong
+ * to the same ArcGIS Enterprise Portal or ArcGIS Online Organization
+ * @returns Promise that resolves to the modified zip object
+ */
+export declare function templatizeFormWebHooks(zipObject: JSZip, isOrgItem: boolean): Promise<JSZip>;

package/dist/cjs/helpers/formHelpers.js

@@ -0,0 +1,58 @@
+"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.templatizeFormWebHooks = void 0;
+const tslib_1 = require("tslib");
+const common = tslib_1.__importStar(require("@esri/solution-common"));
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Templatizes the URLs in webhooks in a form's zip object.
+ *
+ * @param zipObject Form zip object to templatize; it is modified in place
+ * @param isOrgItem Indicates whether this item and the user whose credential was used to fetch this item belong
+ * to the same ArcGIS Enterprise Portal or ArcGIS Online Organization
+ * @returns Promise that resolves to the modified zip object
+ */
+async function templatizeFormWebHooks(zipObject, isOrgItem) {
+    const webhooks = await common.getWebHooksFromZipObject(zipObject);
+    if (webhooks.length > 0) {
+        webhooks.forEach((webhook) => {
+            // Templatize the webhook URL
+            let url = webhook.url;
+            const urlObj = new URL(url);
+            const server = `${urlObj.protocol}//${urlObj.host}`;
+            const workflowServer = "https://workflow.arcgis.com";
+            if (server === workflowServer) {
+                // Templatize organization
+                const partialPath = url.substring(workflowServer.length);
+                const partialPathParts = partialPath.split("/");
+                const orgId = partialPathParts[1];
+                url = url.replace(orgId, "{{user.orgId}}");
+            }
+            else if (isOrgItem) {
+                // Templatize server
+                url = url.replace(server, "{{portalBaseUrl}}");
+            }
+            webhook.url = url;
+        });
+        zipObject = await common.setWebHooksInZipObject(zipObject, webhooks);
+    }
+    // Return the modified zip object
+    return Promise.resolve(zipObject);
+}
+exports.templatizeFormWebHooks = templatizeFormWebHooks;
+//# sourceMappingURL=formHelpers.js.map

package/dist/cjs/helpers/formHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formHelpers.js","sourceRoot":"","sources":["../../../src/helpers/formHelpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AAEH,sEAAgD;AAGhD,wHAAwH;AAExH;;;;;;;GAOG;AACI,KAAK,UAAU,sBAAsB,CAC1C,SAAgB,EAChB,SAAkB;IAElB,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAClE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;QACvB,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAY,EAAE,EAAE;YAChC,6BAA6B;YAC7B,IAAI,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;YACtB,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;YAE5B,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;YACpD,MAAM,cAAc,GAAG,6BAA6B,CAAC;YAErD,IAAI,MAAM,KAAK,cAAc,EAAE;gBAC7B,0BAA0B;gBAC1B,MAAM,WAAW,GAAG,GAAG,CAAC,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;gBACzD,MAAM,gBAAgB,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAChD,MAAM,KAAK,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;gBAClC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;aAE5C;iBAAM,IAAI,SAAS,EAAE;gBACpB,oBAAoB;gBACpB,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;aAChD;YAED,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;QACpB,CAAC,CAAC,CAAC;QACH,SAAS,GAAG,MAAM,MAAM,CAAC,sBAAsB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;KACtE;IAED,iCAAiC;IACjC,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;AACpC,CAAC;AAjCD,wDAiCC"}

package/dist/cjs/helpers/notebook-helpers.d.ts

@@ -0,0 +1,19 @@
+/** @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.
+ */
+import { convertItemToTemplate } from "./convert-item-to-template";
+import { createItemFromTemplate } from "./create-item-from-template";
+import { updateNotebookData } from "./update-notebook-data";
+export { createItemFromTemplate, convertItemToTemplate, updateNotebookData };

package/dist/cjs/helpers/notebook-helpers.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateNotebookData = exports.convertItemToTemplate = exports.createItemFromTemplate = void 0;
+/** @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.
+ */
+const convert_item_to_template_1 = require("./convert-item-to-template");
+Object.defineProperty(exports, "convertItemToTemplate", { enumerable: true, get: function () { return convert_item_to_template_1.convertItemToTemplate; } });
+const create_item_from_template_1 = require("./create-item-from-template");
+Object.defineProperty(exports, "createItemFromTemplate", { enumerable: true, get: function () { return create_item_from_template_1.createItemFromTemplate; } });
+const update_notebook_data_1 = require("./update-notebook-data");
+Object.defineProperty(exports, "updateNotebookData", { enumerable: true, get: function () { return update_notebook_data_1.updateNotebookData; } });
+//# sourceMappingURL=notebook-helpers.js.map

package/dist/cjs/helpers/notebook-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notebook-helpers.js","sourceRoot":"","sources":["../../../src/helpers/notebook-helpers.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;GAcG;AACH,yEAAmE;AAKlC,sGALxB,gDAAqB,OAKwB;AAJtD,2EAAqE;AAI5D,uGAJA,kDAAsB,OAIA;AAH/B,iEAA4D;AAGJ,mGAH/C,yCAAkB,OAG+C"}

package/dist/cjs/helpers/quickcapture-helpers.d.ts

@@ -0,0 +1,18 @@
+/** @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.
+ */
+import { convertItemToTemplate } from "./convert-item-to-template";
+import { createItemFromTemplate } from "./create-item-from-template";
+export { createItemFromTemplate, convertItemToTemplate };

package/dist/cjs/helpers/quickcapture-helpers.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertItemToTemplate = exports.createItemFromTemplate = void 0;
+/** @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.
+ */
+const convert_item_to_template_1 = require("./convert-item-to-template");
+Object.defineProperty(exports, "convertItemToTemplate", { enumerable: true, get: function () { return convert_item_to_template_1.convertItemToTemplate; } });
+const create_item_from_template_1 = require("./create-item-from-template");
+Object.defineProperty(exports, "createItemFromTemplate", { enumerable: true, get: function () { return create_item_from_template_1.createItemFromTemplate; } });
+//# sourceMappingURL=quickcapture-helpers.js.map

package/dist/cjs/helpers/quickcapture-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"quickcapture-helpers.js","sourceRoot":"","sources":["../../../src/helpers/quickcapture-helpers.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;GAcG;AACH,yEAAmE;AAIlC,sGAJxB,gDAAqB,OAIwB;AAHtD,2EAAqE;AAG5D,uGAHA,kDAAsB,OAGA"}