@esri/solution-deployer 4.1.2 → 5.0.0

package/dist/esm/deploySolutionFromTemplate.js

@@ -1,318 +1,318 @@
-/** @license
- * Copyright 2018 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import * as common from "@esri/solution-common";
-import * as deployItems from "./deploySolutionItems";
-import { getWithDefault } from "@esri/hub-common";
-import * as portal from "@esri/arcgis-rest-portal";
-import { postProcess } from "./helpers/post-process";
-import { sortTemplates } from "./helpers/sortTemplates";
-import { setCreateProp } from "@esri/solution-common";
-// NOTE: Moved to separate file to allow stubbing in main deploySolution tests
-export function deploySolutionFromTemplate(templateSolutionId, solutionTemplateBase, solutionTemplateData, authentication, options) {
-    options.storageVersion = common.extractSolutionVersion(solutionTemplateData);
-    return new Promise((resolve, reject) => {
-        // It is possible to provide a separate authentication for the source
-        const storageAuthentication = options.storageAuthentication
-            ? options.storageAuthentication
-            : authentication;
-        // Replacement dictionary and high-level deployment ids for cleanup
-        // TODO: Extract all templateDictionary prep into a separate function
-        const templateDictionary = options.templateDictionary ?? {};
-        let deployedFolderId;
-        let deployedSolutionId;
-        _applySourceToDeployOptions(options, solutionTemplateBase, templateDictionary, authentication);
-        if (options.additionalTypeKeywords) {
-            solutionTemplateBase.typeKeywords = [].concat(solutionTemplateBase.typeKeywords, options.additionalTypeKeywords);
-        }
-        // Get the thumbnail file
-        let thumbFilename = "thumbnail";
-        let thumbDef = Promise.resolve(null);
-        if (!options.thumbnail && options.thumbnailurl) {
-            // Figure out the thumbnail's filename
-            thumbFilename =
-                common.getFilenameFromUrl(options.thumbnailurl) || thumbFilename;
-            const thumbnailurl = common.appendQueryParam(options.thumbnailurl, "w=400");
-            delete options.thumbnailurl;
-            // Fetch the thumbnail
-            thumbDef = common.getBlobAsFile(thumbnailurl, thumbFilename, storageAuthentication, [400]);
-        }
-        _replaceParamVariables(solutionTemplateData, templateDictionary);
-        // Get information about deployment environment
-        Promise.all([
-            common.getPortal("", authentication),
-            common.getUser(authentication),
-            common.getFoldersAndGroups(authentication),
-            thumbDef
-        ])
-            .then(responses => {
-            const [portalResponse, userResponse, foldersAndGroupsResponse, thumbnailFile] = responses;
-            if (!options.thumbnail && thumbnailFile) {
-                options.thumbnail = thumbnailFile;
-            }
-            // update template items with source-itemId type keyword
-            solutionTemplateData.templates = _addSourceId(solutionTemplateData.templates);
-            templateDictionary.isPortal = portalResponse.isPortal;
-            templateDictionary.organization = Object.assign(templateDictionary.organization || {}, portalResponse);
-            // TODO: Add more computed properties here
-            // portal: portalResponse
-            // orgextent as bbox for assignment onto items
-            // more info in #266 https://github.com/Esri/solution.js/issues/266
-            templateDictionary.portalBaseUrl = _getPortalBaseUrl(portalResponse, authentication);
-            templateDictionary.user = userResponse;
-            templateDictionary.user.folders = foldersAndGroupsResponse.folders;
-            templateDictionary.user.groups = foldersAndGroupsResponse.groups.filter((group) => group.owner === templateDictionary.user.username);
-            // if we have tracking views and the user is not admin or the org doesn't support tracking an error is thrown
-            common.setLocationTrackingEnabled(portalResponse, userResponse, templateDictionary, solutionTemplateData.templates);
-            const trackingOwnerPromise = common.getTackingServiceOwner(templateDictionary, authentication);
-            // Create a folder to hold the deployed solution. We use the solution name, appending a sequential
-            // suffix if the folder exists, e.g.,
-            //  * Manage Right of Way Activities
-            //  * Manage Right of Way Activities 1
-            //  * Manage Right of Way Activities 2
-            const folderPromise = common.createUniqueFolder(solutionTemplateBase.title, templateDictionary, authentication);
-            // Apply the portal extents to the solution
-            const portalExtent = portalResponse.defaultExtent;
-            const extentsPromise = common.convertExtentWithFallback(portalExtent, undefined, { wkid: 4326 }, portalResponse.helperServices.geometry.url, authentication);
-            // Await completion of async actions: folder creation & extents conversion
-            return Promise.all([folderPromise, extentsPromise, trackingOwnerPromise]);
-        })
-            .then(responses => {
-            const [folderResponse, wgs84Extent, trackingOwnerResponse] = responses;
-            deployedFolderId = folderResponse.folder.id;
-            templateDictionary.folderId = deployedFolderId;
-            templateDictionary.solutionItemExtent =
-                wgs84Extent.xmin +
-                    "," +
-                    wgs84Extent.ymin +
-                    "," +
-                    wgs84Extent.xmax +
-                    "," +
-                    wgs84Extent.ymax;
-            // Hub Solutions depend on organization defaultExtentBBox as a nested array not a string
-            templateDictionary.organization.defaultExtentBBox = [
-                [wgs84Extent.xmin, wgs84Extent.ymin],
-                [wgs84Extent.xmax, wgs84Extent.ymax]
-            ];
-            // update templateDictionary to indicate if the user owns the tracking service
-            // this will affect how we handle group sharing
-            /* istanbul ignore else */
-            if (templateDictionary.locationTrackingEnabled) {
-                setCreateProp(templateDictionary, "locationTracking.userIsOwner", trackingOwnerResponse);
-            }
-            // Create a deployed Solution item
-            const createSolutionItemBase = {
-                ...common.sanitizeJSON(solutionTemplateBase),
-                type: "Solution",
-                typeKeywords: ["Solution"]
-            };
-            if (options.additionalTypeKeywords) {
-                createSolutionItemBase.typeKeywords = ["Solution"].concat(options.additionalTypeKeywords);
-            }
-            // Create deployed solution item
-            createSolutionItemBase.thumbnail = options.thumbnail;
-            return common.createItemWithData(createSolutionItemBase, {}, authentication, deployedFolderId);
-        })
-            .then(createSolutionResponse => {
-            deployedSolutionId = createSolutionResponse.id;
-            // Protect the solution item
-            const protectOptions = {
-                id: deployedSolutionId,
-                authentication
-            };
-            return portal.protectItem(protectOptions);
-        })
-            .then(() => {
-            // TODO: Attach the whole solution model so we can
-            // have stuff like `{{solution.item.title}}
-            templateDictionary.solutionItemId = deployedSolutionId;
-            solutionTemplateBase.id = deployedSolutionId;
-            solutionTemplateBase.tryitUrl = _checkedReplaceAll(solutionTemplateBase.tryitUrl, templateSolutionId, deployedSolutionId);
-            solutionTemplateBase.url = _checkedReplaceAll(solutionTemplateBase.url, templateSolutionId, deployedSolutionId);
-            // Handle the contained item templates
-            return deployItems.deploySolutionItems(storageAuthentication.portal, templateSolutionId, solutionTemplateData.templates, storageAuthentication, templateDictionary, deployedSolutionId, authentication, options);
-        })
-            .then((clonedSolutionsResponse) => {
-            solutionTemplateData.templates = solutionTemplateData.templates.map((itemTemplate) => {
-                // Update ids present in template dictionary
-                itemTemplate.itemId = common.getProp(templateDictionary, `${itemTemplate.itemId}.itemId`);
-                // Update the dependencies hash to point to the new item ids
-                itemTemplate.dependencies = itemTemplate.dependencies.map((id) => getWithDefault(templateDictionary, `${id}.itemId`, id));
-                return itemTemplate;
-            });
-            // Sort the templates into build order, which is provided by clonedSolutionsResponse
-            sortTemplates(solutionTemplateData.templates, clonedSolutionsResponse.map(response => response.id));
-            // Wrap up with post-processing, in which we deal with groups and cycle remnants
-            return postProcess(deployedSolutionId, solutionTemplateData.templates, clonedSolutionsResponse, authentication, templateDictionary);
-        })
-            .then(() => {
-            // Update solution item using internal representation & and the updated data JSON
-            solutionTemplateBase.typeKeywords = [].concat(solutionTemplateBase.typeKeywords, ["Deployed"]);
-            const iTemplateKeyword = solutionTemplateBase.typeKeywords.indexOf("Template");
-            /* istanbul ignore else */
-            if (iTemplateKeyword >= 0) {
-                solutionTemplateBase.typeKeywords.splice(iTemplateKeyword, 1);
-            }
-            solutionTemplateData.templates = solutionTemplateData.templates.map((itemTemplate) => _purgeTemplateProperties(itemTemplate));
-            solutionTemplateData.templates = _updateGroupReferences(solutionTemplateData.templates, templateDictionary);
-            // Update solution items data using template dictionary, and then update the
-            // itemId & dependencies in each item template
-            solutionTemplateBase.data = common.replaceInTemplate(solutionTemplateData, templateDictionary);
-            // Write any user defined params to the solution
-            /* istanbul ignore else */
-            if (templateDictionary.params) {
-                solutionTemplateBase.data.params = templateDictionary.params;
-            }
-            return common.updateItem(solutionTemplateBase, authentication, deployedFolderId);
-        })
-            .then(() => resolve(solutionTemplateBase.id), reject);
-    });
-}
-/**
- * Add source-id to items/groups typeKeywords
- *
- * @param template the array of solution data templates
- * @private
- */
-export function _addSourceId(templates) {
-    return templates.map((template) => {
-        /* istanbul ignore else */
-        if (template.item) {
-            const typeKeywords = template.item.typeKeywords || [];
-            typeKeywords.push("source-" + template.itemId);
-            template.item.typeKeywords = typeKeywords;
-        }
-        return template;
-    });
-}
-/**
- * Update the deployOptions with the group properties
- *
- * @param deployOptions
- * @param sourceInfo
- * @param authentication
- * @param isGroup Boolean to indicate if the files are associated with a group or item
- * @private
- */
-export function _applySourceToDeployOptions(deployOptions, solutionTemplateBase, templateDictionary, authentication) {
-    // Deploy a solution from the template's contents,
-    // using the template's information as defaults for the deployed solution item
-    ["title", "snippet", "description", "tags"].forEach(prop => {
-        deployOptions[prop] = deployOptions[prop] ?? solutionTemplateBase[prop];
-        if (deployOptions[prop]) {
-            solutionTemplateBase[prop] = deployOptions[prop];
-            // carry these options forward on the templateDict
-            templateDictionary[prop] = deployOptions[prop];
-        }
-    });
-    if (!deployOptions.thumbnailurl && solutionTemplateBase.thumbnail) {
-        // Get the full path to the thumbnail
-        deployOptions.thumbnailurl = common.generateSourceThumbnailUrl(authentication.portal, solutionTemplateBase.id, solutionTemplateBase.thumbnail);
-        delete solutionTemplateBase.thumbnail;
-    }
-    return deployOptions;
-}
-//???
-export function _replaceParamVariables(solutionTemplateData, templateDictionary) {
-    // a custom params object can be passed in with the options to deploy a solution
-    // in most cases we can defer to the item type handlers to use these values
-    // for variable replacement
-    // for spatial reference specifically we need to replace up front so the default extent
-    // logic can execute as expected
-    solutionTemplateData.templates = solutionTemplateData.templates.map((template) => {
-        // can't do this as it causes other values that don't exist in the dict yet to revert to defaults they may have defined
-        // return common.replaceInTemplate(template, templateDictionary);
-        /* istanbul ignore else */
-        if (template.type === "Feature Service") {
-            const paramsLookup = "params.";
-            const wkidItemPath = "item.spatialReference.wkid";
-            template = _updateProp(template, wkidItemPath, paramsLookup, templateDictionary);
-            const wkidServicePath = "properties.service.spatialReference.wkid";
-            template = _updateProp(template, wkidServicePath, paramsLookup, templateDictionary);
-        }
-        return template;
-    });
-}
-//???
-export function _updateProp(template, path, lookup, templateDictionary) {
-    const wkid = common.getProp(template, path);
-    /* istanbul ignore else */
-    if (wkid && typeof wkid === "string" && wkid.indexOf(lookup) > -1) {
-        common.setProp(template, path, common.replaceInTemplate(wkid, templateDictionary));
-    }
-    return template;
-}
-//???
-export function _checkedReplaceAll(template, oldValue, newValue) {
-    let newTemplate;
-    if (template && template.indexOf(oldValue) > -1) {
-        const re = new RegExp(oldValue, "g");
-        newTemplate = template.replace(re, newValue);
-    }
-    else {
-        newTemplate = template;
-    }
-    return newTemplate;
-}
-//???
-export function _getPortalBaseUrl(portalResponse, authentication) {
-    // As of Spring 2020, only HTTPS (see
-    // https://www.esri.com/arcgis-blog/products/product/administration/2019-arcgis-transport-security-improvements/)
-    const scheme = "https"; // portalResponse.allSSL ? "https" : "http";
-    const urlKey = common.getProp(portalResponse, "urlKey");
-    const customBaseUrl = common.getProp(portalResponse, "customBaseUrl");
-    const enterpriseBaseUrl = common.getProp(portalResponse, "portalHostname");
-    return urlKey && customBaseUrl
-        ? `${scheme}://${urlKey}.${customBaseUrl}`
-        : enterpriseBaseUrl
-            ? `${scheme}://${enterpriseBaseUrl}`
-            : authentication.portal.replace("/sharing/rest", "");
-}
-//???
-export function _updateGroupReferences(itemTemplates, templateDictionary) {
-    const groupIds = itemTemplates.reduce((result, t) => {
-        if (t.type === "Group") {
-            result.push(t.itemId);
-        }
-        return result;
-    }, []);
-    Object.keys(templateDictionary).forEach(k => {
-        const newId = templateDictionary[k].itemId;
-        if (groupIds.indexOf(newId) > -1) {
-            itemTemplates.forEach(t => {
-                t.groups = t.groups.map((id) => (id === k ? newId : id));
-            });
-        }
-    });
-    return itemTemplates;
-}
-//???
-export function _purgeTemplateProperties(itemTemplate) {
-    const retainProps = ["itemId", "type", "dependencies", "groups"];
-    const deleteProps = Object.keys(itemTemplate).filter(k => retainProps.indexOf(k) < 0);
-    common.deleteProps(itemTemplate, deleteProps);
-    return itemTemplate;
-}
-/**
- * Returns a match of a supplied id with the suffix ".itemId" in the template dictionary.
- *
- * @param id Id to look for
- * @param templateDictionary Hash mapping property names to replacement values
- * @returns Match in template dictionary or original id
- */
-export function _getNewItemId(id, templateDictionary) {
-    return common.getProp(templateDictionary, id + ".itemId") ?? id;
-}
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import * as common from "@esri/solution-common";
+import * as deployItems from "./deploySolutionItems";
+import { getWithDefault } from "@esri/hub-common";
+import * as portal from "@esri/arcgis-rest-portal";
+import { postProcess } from "./helpers/post-process";
+import { sortTemplates } from "./helpers/sortTemplates";
+import { setCreateProp } from "@esri/solution-common";
+// NOTE: Moved to separate file to allow stubbing in main deploySolution tests
+export function deploySolutionFromTemplate(templateSolutionId, solutionTemplateBase, solutionTemplateData, authentication, options) {
+    options.storageVersion = common.extractSolutionVersion(solutionTemplateData);
+    return new Promise((resolve, reject) => {
+        // It is possible to provide a separate authentication for the source
+        const storageAuthentication = options.storageAuthentication
+            ? options.storageAuthentication
+            : authentication;
+        // Replacement dictionary and high-level deployment ids for cleanup
+        // TODO: Extract all templateDictionary prep into a separate function
+        const templateDictionary = options.templateDictionary ?? {};
+        let deployedFolderId;
+        let deployedSolutionId;
+        _applySourceToDeployOptions(options, solutionTemplateBase, templateDictionary, authentication);
+        if (options.additionalTypeKeywords) {
+            solutionTemplateBase.typeKeywords = [].concat(solutionTemplateBase.typeKeywords, options.additionalTypeKeywords);
+        }
+        // Get the thumbnail file
+        let thumbFilename = "thumbnail";
+        let thumbDef = Promise.resolve(null);
+        if (!options.thumbnail && options.thumbnailurl) {
+            // Figure out the thumbnail's filename
+            thumbFilename =
+                common.getFilenameFromUrl(options.thumbnailurl) || thumbFilename;
+            const thumbnailurl = common.appendQueryParam(options.thumbnailurl, "w=400");
+            delete options.thumbnailurl;
+            // Fetch the thumbnail
+            thumbDef = common.getBlobAsFile(thumbnailurl, thumbFilename, storageAuthentication, [400]);
+        }
+        _replaceParamVariables(solutionTemplateData, templateDictionary);
+        // Get information about deployment environment
+        Promise.all([
+            common.getPortal("", authentication),
+            common.getUser(authentication),
+            common.getFoldersAndGroups(authentication),
+            thumbDef
+        ])
+            .then(responses => {
+            const [portalResponse, userResponse, foldersAndGroupsResponse, thumbnailFile] = responses;
+            if (!options.thumbnail && thumbnailFile) {
+                options.thumbnail = thumbnailFile;
+            }
+            // update template items with source-itemId type keyword
+            solutionTemplateData.templates = _addSourceId(solutionTemplateData.templates);
+            templateDictionary.isPortal = portalResponse.isPortal;
+            templateDictionary.organization = Object.assign(templateDictionary.organization || {}, portalResponse);
+            // TODO: Add more computed properties here
+            // portal: portalResponse
+            // orgextent as bbox for assignment onto items
+            // more info in #266 https://github.com/Esri/solution.js/issues/266
+            templateDictionary.portalBaseUrl = _getPortalBaseUrl(portalResponse, authentication);
+            templateDictionary.user = userResponse;
+            templateDictionary.user.folders = foldersAndGroupsResponse.folders;
+            templateDictionary.user.groups = foldersAndGroupsResponse.groups.filter((group) => group.owner === templateDictionary.user.username);
+            // if we have tracking views and the user is not admin or the org doesn't support tracking an error is thrown
+            common.setLocationTrackingEnabled(portalResponse, userResponse, templateDictionary, solutionTemplateData.templates);
+            const trackingOwnerPromise = common.getTackingServiceOwner(templateDictionary, authentication);
+            // Create a folder to hold the deployed solution. We use the solution name, appending a sequential
+            // suffix if the folder exists, e.g.,
+            //  * Manage Right of Way Activities
+            //  * Manage Right of Way Activities 1
+            //  * Manage Right of Way Activities 2
+            const folderPromise = common.createUniqueFolder(solutionTemplateBase.title, templateDictionary, authentication);
+            // Apply the portal extents to the solution
+            const portalExtent = portalResponse.defaultExtent;
+            const extentsPromise = common.convertExtentWithFallback(portalExtent, undefined, { wkid: 4326 }, portalResponse.helperServices.geometry.url, authentication);
+            // Await completion of async actions: folder creation & extents conversion
+            return Promise.all([folderPromise, extentsPromise, trackingOwnerPromise]);
+        })
+            .then(responses => {
+            const [folderResponse, wgs84Extent, trackingOwnerResponse] = responses;
+            deployedFolderId = folderResponse.folder.id;
+            templateDictionary.folderId = deployedFolderId;
+            templateDictionary.solutionItemExtent =
+                wgs84Extent.xmin +
+                    "," +
+                    wgs84Extent.ymin +
+                    "," +
+                    wgs84Extent.xmax +
+                    "," +
+                    wgs84Extent.ymax;
+            // Hub Solutions depend on organization defaultExtentBBox as a nested array not a string
+            templateDictionary.organization.defaultExtentBBox = [
+                [wgs84Extent.xmin, wgs84Extent.ymin],
+                [wgs84Extent.xmax, wgs84Extent.ymax]
+            ];
+            // update templateDictionary to indicate if the user owns the tracking service
+            // this will affect how we handle group sharing
+            /* istanbul ignore else */
+            if (templateDictionary.locationTrackingEnabled) {
+                setCreateProp(templateDictionary, "locationTracking.userIsOwner", trackingOwnerResponse);
+            }
+            // Create a deployed Solution item
+            const createSolutionItemBase = {
+                ...common.sanitizeJSON(solutionTemplateBase),
+                type: "Solution",
+                typeKeywords: ["Solution"]
+            };
+            if (options.additionalTypeKeywords) {
+                createSolutionItemBase.typeKeywords = ["Solution"].concat(options.additionalTypeKeywords);
+            }
+            // Create deployed solution item
+            createSolutionItemBase.thumbnail = options.thumbnail;
+            return common.createItemWithData(createSolutionItemBase, {}, authentication, deployedFolderId);
+        })
+            .then(createSolutionResponse => {
+            deployedSolutionId = createSolutionResponse.id;
+            // Protect the solution item
+            const protectOptions = {
+                id: deployedSolutionId,
+                authentication
+            };
+            return portal.protectItem(protectOptions);
+        })
+            .then(() => {
+            // TODO: Attach the whole solution model so we can
+            // have stuff like `{{solution.item.title}}
+            templateDictionary.solutionItemId = deployedSolutionId;
+            solutionTemplateBase.id = deployedSolutionId;
+            solutionTemplateBase.tryitUrl = _checkedReplaceAll(solutionTemplateBase.tryitUrl, templateSolutionId, deployedSolutionId);
+            solutionTemplateBase.url = _checkedReplaceAll(solutionTemplateBase.url, templateSolutionId, deployedSolutionId);
+            // Handle the contained item templates
+            return deployItems.deploySolutionItems(storageAuthentication.portal, templateSolutionId, solutionTemplateData.templates, storageAuthentication, templateDictionary, deployedSolutionId, authentication, options);
+        })
+            .then((clonedSolutionsResponse) => {
+            solutionTemplateData.templates = solutionTemplateData.templates.map((itemTemplate) => {
+                // Update ids present in template dictionary
+                itemTemplate.itemId = common.getProp(templateDictionary, `${itemTemplate.itemId}.itemId`);
+                // Update the dependencies hash to point to the new item ids
+                itemTemplate.dependencies = itemTemplate.dependencies.map((id) => getWithDefault(templateDictionary, `${id}.itemId`, id));
+                return itemTemplate;
+            });
+            // Sort the templates into build order, which is provided by clonedSolutionsResponse
+            sortTemplates(solutionTemplateData.templates, clonedSolutionsResponse.map(response => response.id));
+            // Wrap up with post-processing, in which we deal with groups and cycle remnants
+            return postProcess(deployedSolutionId, solutionTemplateData.templates, clonedSolutionsResponse, authentication, templateDictionary);
+        })
+            .then(() => {
+            // Update solution item using internal representation & and the updated data JSON
+            solutionTemplateBase.typeKeywords = [].concat(solutionTemplateBase.typeKeywords, ["Deployed"]);
+            const iTemplateKeyword = solutionTemplateBase.typeKeywords.indexOf("Template");
+            /* istanbul ignore else */
+            if (iTemplateKeyword >= 0) {
+                solutionTemplateBase.typeKeywords.splice(iTemplateKeyword, 1);
+            }
+            solutionTemplateData.templates = solutionTemplateData.templates.map((itemTemplate) => _purgeTemplateProperties(itemTemplate));
+            solutionTemplateData.templates = _updateGroupReferences(solutionTemplateData.templates, templateDictionary);
+            // Update solution items data using template dictionary, and then update the
+            // itemId & dependencies in each item template
+            solutionTemplateBase.data = common.replaceInTemplate(solutionTemplateData, templateDictionary);
+            // Write any user defined params to the solution
+            /* istanbul ignore else */
+            if (templateDictionary.params) {
+                solutionTemplateBase.data.params = templateDictionary.params;
+            }
+            return common.updateItem(solutionTemplateBase, authentication, deployedFolderId);
+        })
+            .then(() => resolve(solutionTemplateBase.id), reject);
+    });
+}
+/**
+ * Add source-id to items/groups typeKeywords
+ *
+ * @param template the array of solution data templates
+ * @private
+ */
+export function _addSourceId(templates) {
+    return templates.map((template) => {
+        /* istanbul ignore else */
+        if (template.item) {
+            const typeKeywords = template.item.typeKeywords || [];
+            typeKeywords.push("source-" + template.itemId);
+            template.item.typeKeywords = typeKeywords;
+        }
+        return template;
+    });
+}
+/**
+ * Update the deployOptions with the group properties
+ *
+ * @param deployOptions
+ * @param sourceInfo
+ * @param authentication
+ * @param isGroup Boolean to indicate if the files are associated with a group or item
+ * @private
+ */
+export function _applySourceToDeployOptions(deployOptions, solutionTemplateBase, templateDictionary, authentication) {
+    // Deploy a solution from the template's contents,
+    // using the template's information as defaults for the deployed solution item
+    ["title", "snippet", "description", "tags"].forEach(prop => {
+        deployOptions[prop] = deployOptions[prop] ?? solutionTemplateBase[prop];
+        if (deployOptions[prop]) {
+            solutionTemplateBase[prop] = deployOptions[prop];
+            // carry these options forward on the templateDict
+            templateDictionary[prop] = deployOptions[prop];
+        }
+    });
+    if (!deployOptions.thumbnailurl && solutionTemplateBase.thumbnail) {
+        // Get the full path to the thumbnail
+        deployOptions.thumbnailurl = common.generateSourceThumbnailUrl(authentication.portal, solutionTemplateBase.id, solutionTemplateBase.thumbnail);
+        delete solutionTemplateBase.thumbnail;
+    }
+    return deployOptions;
+}
+//TODO: function doc
+export function _replaceParamVariables(solutionTemplateData, templateDictionary) {
+    // a custom params object can be passed in with the options to deploy a solution
+    // in most cases we can defer to the item type handlers to use these values
+    // for variable replacement
+    // for spatial reference specifically we need to replace up front so the default extent
+    // logic can execute as expected
+    solutionTemplateData.templates = solutionTemplateData.templates.map((template) => {
+        // can't do this as it causes other values that don't exist in the dict yet to revert to defaults they may have defined
+        // return common.replaceInTemplate(template, templateDictionary);
+        /* istanbul ignore else */
+        if (template.type === "Feature Service") {
+            const paramsLookup = "params.";
+            const wkidItemPath = "item.spatialReference.wkid";
+            template = _updateProp(template, wkidItemPath, paramsLookup, templateDictionary);
+            const wkidServicePath = "properties.service.spatialReference.wkid";
+            template = _updateProp(template, wkidServicePath, paramsLookup, templateDictionary);
+        }
+        return template;
+    });
+}
+//TODO: function doc
+export function _updateProp(template, path, lookup, templateDictionary) {
+    const wkid = common.getProp(template, path);
+    /* istanbul ignore else */
+    if (wkid && typeof wkid === "string" && wkid.indexOf(lookup) > -1) {
+        common.setProp(template, path, common.replaceInTemplate(wkid, templateDictionary));
+    }
+    return template;
+}
+//TODO: function doc
+export function _checkedReplaceAll(template, oldValue, newValue) {
+    let newTemplate;
+    if (template && template.indexOf(oldValue) > -1) {
+        const re = new RegExp(oldValue, "g");
+        newTemplate = template.replace(re, newValue);
+    }
+    else {
+        newTemplate = template;
+    }
+    return newTemplate;
+}
+//TODO: function doc
+export function _getPortalBaseUrl(portalResponse, authentication) {
+    // As of Spring 2020, only HTTPS (see
+    // https://www.esri.com/arcgis-blog/products/product/administration/2019-arcgis-transport-security-improvements/)
+    const scheme = "https"; // portalResponse.allSSL ? "https" : "http";
+    const urlKey = common.getProp(portalResponse, "urlKey");
+    const customBaseUrl = common.getProp(portalResponse, "customBaseUrl");
+    const enterpriseBaseUrl = common.getProp(portalResponse, "portalHostname");
+    return urlKey && customBaseUrl
+        ? `${scheme}://${urlKey}.${customBaseUrl}`
+        : enterpriseBaseUrl
+            ? `${scheme}://${enterpriseBaseUrl}`
+            : authentication.portal.replace("/sharing/rest", "");
+}
+//TODO: function doc
+export function _updateGroupReferences(itemTemplates, templateDictionary) {
+    const groupIds = itemTemplates.reduce((result, t) => {
+        if (t.type === "Group") {
+            result.push(t.itemId);
+        }
+        return result;
+    }, []);
+    Object.keys(templateDictionary).forEach(k => {
+        const newId = templateDictionary[k].itemId;
+        if (groupIds.indexOf(newId) > -1) {
+            itemTemplates.forEach(t => {
+                t.groups = t.groups.map((id) => (id === k ? newId : id));
+            });
+        }
+    });
+    return itemTemplates;
+}
+//TODO: function doc
+export function _purgeTemplateProperties(itemTemplate) {
+    const retainProps = ["itemId", "type", "dependencies", "groups"];
+    const deleteProps = Object.keys(itemTemplate).filter(k => retainProps.indexOf(k) < 0);
+    common.deleteProps(itemTemplate, deleteProps);
+    return itemTemplate;
+}
+/**
+ * Returns a match of a supplied id with the suffix ".itemId" in the template dictionary.
+ *
+ * @param id Id to look for
+ * @param templateDictionary Hash mapping property names to replacement values
+ * @returns Match in template dictionary or original id
+ */
+export function _getNewItemId(id, templateDictionary) {
+    return common.getProp(templateDictionary, id + ".itemId") ?? id;
+}
 //# sourceMappingURL=deploySolutionFromTemplate.js.map