@esri/solution-simple-types 1.5.1 → 1.5.2

package/dist/umd/simple-types/src/webmap.d.ts

@@ -20,9 +20,10 @@ import * as common from "@esri/solution-common";
  * @param itemTemplate Template for the webmap item
  * @param destAuthentication Credentials for requests to the destination organization
  * @param srcAuthentication Credentials for requests to source items
+ * @param templateDictionary Hash of key details used for variable replacement
  * @returns Template for the solution item that contains key details for item reconstruction
  */
-export declare function convertItemToTemplate(itemTemplate: common.IItemTemplate, destAuthentication: common.UserSession, srcAuthentication: common.UserSession): Promise<common.IItemTemplate>;
+export declare function convertItemToTemplate(itemTemplate: common.IItemTemplate, destAuthentication: common.UserSession, srcAuthentication: common.UserSession, templateDictionary: any): Promise<common.IItemTemplate>;
 /**
  * Gets the ids of the dependencies of an AGOL webmap item.
  *
@@ -58,10 +59,11 @@ export declare function _getLayerIds(layerList: any[], dependencies: string[], a
  *
  * @param layerList List of map layers or tables
  * @param urlHash Lookup object for analysis layers
+ * @param templateDictionary Hash of key details used for variable replacement
  * @returns void
  * @private
  */
-export declare function _templatizeWebmapLayerIdsAndUrls(layerList: any[], urlHash: any): void;
+export declare function _templatizeWebmapLayerIdsAndUrls(layerList: any[], urlHash: any, templateDictionary: any): void;
 /**
  * Templatize field references.
  *

package/dist/umd/simple-types/src/webmappingapplication.d.ts

@@ -20,10 +20,20 @@ import * as common from "@esri/solution-common";
  * @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 key details used for variable replacement
  * @returns A promise that will resolve when the template has been created
  */
-export declare function convertItemToTemplate(itemTemplate: common.IItemTemplate, destAuthentication: common.UserSession, srcAuthentication: common.UserSession): Promise<common.IItemTemplate>;
-export declare function templatizeDatasources(itemTemplate: common.IItemTemplate, authentication: common.UserSession, portalUrl: string): Promise<common.IItemTemplate>;
+export declare function convertItemToTemplate(itemTemplate: common.IItemTemplate, destAuthentication: common.UserSession, srcAuthentication: common.UserSession, templateDictionary: any): Promise<common.IItemTemplate>;
+/**
+ * Converts web mapping application datasources to variables for deployment
+ *
+ * @param itemTemplate The solution item template
+ * @param authentication Credentials for requests
+ * @param portalUrl Rest Url of the portal to perform the search
+ * @param templateDictionary Hash of key details used for variable replacement
+ * @returns A promise that will resolve with the created template
+ */
+export declare function templatizeDatasources(itemTemplate: common.IItemTemplate, authentication: common.UserSession, portalUrl: string, templateDictionary: any): Promise<common.IItemTemplate>;
 export declare function templatizeWidgets(itemTemplate: common.IItemTemplate, authentication: common.UserSession, portalUrl: string, widgetPath: string, isOnScreen?: boolean): Promise<common.IItemTemplate>;
 export declare function templatizeValues(itemTemplate: common.IItemTemplate, authentication: common.UserSession, portalUrl: string, widgetPath: string): Promise<common.IItemTemplate>;
 export declare function handleServiceRequests(serviceRequests: any[], requestUrls: string[], objString: string): Promise<string>;

package/dist/umd/simple-types/src/workforce.d.ts

@@ -20,9 +20,10 @@ import * as common from "@esri/solution-common";
  * @param itemTemplate template for the workforce project item
  * @param destAuthentication Credentials for requests to the destination organization
  * @param srcAuthentication Credentials for requests to source items
+ * @param templateDictionary Hash of key details used for variable replacement
  * @returns templatized itemTemplate
  */
-export declare function convertItemToTemplate(itemTemplate: common.IItemTemplate, destAuthentication: common.UserSession, srcAuthentication: common.UserSession): Promise<common.IItemTemplate>;
+export declare function convertItemToTemplate(itemTemplate: common.IItemTemplate, destAuthentication: common.UserSession, srcAuthentication: common.UserSession, templateDictionary: any): Promise<common.IItemTemplate>;
 /**
  * Gets the current user and updates the dispatchers service
  *

package/dist/umd/simple-types.umd.js

@@ -1,7 +1,7 @@
 /* @preserve
-* @esri/solution-simple-types - v1.5.1 - Apache-2.0
+* @esri/solution-simple-types - v1.5.2 - Apache-2.0
 * Copyright (c) 2018-2022 Esri, Inc.
-* Fri Sep 30 2022 15:13:54 GMT-0700 (Pacific Daylight Time)
+* Wed Oct 19 2022 09:18:29 GMT-0700 (Pacific Daylight Time)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -60,20 +60,21 @@
    * Converts a dashboard item to a template.
    *
    * @param itemTemplate Template for the dashboard item
+   * @param templateDictionary Hash of key details used for variable replacement
    * @returns templatized itemTemplate
    */
-  function convertItemToTemplate$8(itemTemplate) {
-      return _extractDependencies$3(itemTemplate);
+  function convertItemToTemplate$8(itemTemplate, templateDictionary) {
+      return _extractDependencies$3(itemTemplate, templateDictionary);
   }
   /**
    * Templatizes all itemIds and updates the dependency array
    *
    * @param itemTemplate Template for the dashboard item
+   * @param templateDictionary Hash of key details used for variable replacement
    * @returns The updated itemTemplate
    * @private
-   * @private
    */
-  function _extractDependencies$3(itemTemplate) {
+  function _extractDependencies$3(itemTemplate, templateDictionary) {
       // get dependencies from any
       const updatePaths = [
           "data.widgets",
@@ -95,7 +96,7 @@
                   }
                   /* istanbul ignore else */
                   if (Array.isArray(obj.datasets)) {
-                      _getDatasourceDependencies(obj, itemTemplate);
+                      _getDatasourceDependencies(obj, itemTemplate, templateDictionary);
                   }
               });
           }
@@ -107,9 +108,10 @@
    *
    * @param obj A widget, selector, or urlParameter that contains a datasets collection
    * @param itemTemplate Template for the dashboard item
+   * @param templateDictionary Hash of key details used for variable replacement
    * @private
    */
-  function _getDatasourceDependencies(obj, itemTemplate) {
+  function _getDatasourceDependencies(obj, itemTemplate, templateDictionary) {
       obj.datasets.forEach((dataset) => {
           // when the datasource has an itemId is an external datasource
           const itemId = common__namespace.getProp(dataset, "dataSource.itemId");
@@ -118,6 +120,7 @@
                   itemTemplate.dependencies.push(itemId);
               }
               const layerId = common__namespace.getProp(dataset, "dataSource.layerId");
+              common__namespace.cacheLayerInfo(layerId?.toString(), itemId, "", templateDictionary);
               dataset.dataSource.itemId = common__namespace.templatizeTerm(itemId, itemId, layerId !== undefined ? ".layer" + layerId + ".itemId" : ".itemId");
               /* istanbul ignore else */
               if (layerId !== undefined) {
@@ -372,9 +375,10 @@
    * @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 key details used for variable replacement
    * @returns A promise that will resolve when the template has been created
    */
-  function convertItemToTemplate$7(itemTemplate, destAuthentication, srcAuthentication) {
+  function convertItemToTemplate$7(itemTemplate, destAuthentication, srcAuthentication, templateDictionary) {
       return new Promise((resolve, reject) => {
           // Remove org base URL and app id, e.g.,
           //   http://anOrg.maps.arcgis.com/apps/CrowdsourcePolling/index.html?appid=6fc5992522d34a6b5ce80d17835eea21
@@ -412,7 +416,7 @@
               "data.httpProxy.url"
           ], common__namespace.placeholder(common__namespace.SERVER_NAME));
           common__namespace.setProp(itemTemplate, "data.geometryService", common__namespace.placeholder(common__namespace.GEOMETRY_SERVER_NAME));
-          templatizeDatasources(itemTemplate, srcAuthentication, portalUrl).then(() => {
+          templatizeDatasources(itemTemplate, srcAuthentication, portalUrl, templateDictionary).then(() => {
               templatizeWidgets(itemTemplate, srcAuthentication, portalUrl, "data.widgetPool.widgets").then(_itemTemplate => {
                   templatizeWidgets(_itemTemplate, srcAuthentication, portalUrl, "data.widgetOnScreen.widgets", true).then(updatedItemTemplate => {
                       templatizeValues(updatedItemTemplate, srcAuthentication, portalUrl, "data.values").then(_updatedItemTemplate => {
@@ -423,7 +427,16 @@
           }, e => reject(common__namespace.fail(e)));
       });
   }
-  function templatizeDatasources(itemTemplate, authentication, portalUrl) {
+  /**
+   * Converts web mapping application datasources to variables for deployment
+   *
+   * @param itemTemplate The solution item template
+   * @param authentication Credentials for requests
+   * @param portalUrl Rest Url of the portal to perform the search
+   * @param templateDictionary Hash of key details used for variable replacement
+   * @returns A promise that will resolve with the created template
+   */
+  function templatizeDatasources(itemTemplate, authentication, portalUrl, templateDictionary) {
       return new Promise((resolve, reject) => {
           const dataSources = common__namespace.getProp(itemTemplate, "data.dataSource.dataSources");
           if (dataSources && Object.keys(dataSources).length > 0) {
@@ -435,6 +448,7 @@
                   if (common__namespace.getProp(ds, "url")) {
                       if (itemId) {
                           const layerId = ds.url.substr(ds.url.lastIndexOf("/") + 1);
+                          common__namespace.cacheLayerInfo(layerId.toString(), itemId, ds.url, templateDictionary);
                           ds.itemId = common__namespace.templatizeTerm(itemId, itemId, ".layer" + layerId + ".itemId");
                       }
                       const urlResults = findUrls(ds.url, portalUrl, [], [], authentication);
@@ -1008,10 +1022,11 @@
    * @param itemTemplate template for the workforce project item
    * @param destAuthentication Credentials for requests to the destination organization
    * @param srcAuthentication Credentials for requests to source items
+   * @param templateDictionary Hash of key details used for variable replacement
    * @returns templatized itemTemplate
    */
-  function convertItemToTemplate$6(itemTemplate, destAuthentication, srcAuthentication) {
-      return common__namespace.convertWorkforceItemToTemplate(itemTemplate, srcAuthentication);
+  function convertItemToTemplate$6(itemTemplate, destAuthentication, srcAuthentication, templateDictionary) {
+      return common__namespace.convertWorkforceItemToTemplate(itemTemplate, srcAuthentication, templateDictionary);
   }
   /**
    * Gets the current user and updates the dispatchers service
@@ -1733,9 +1748,10 @@
    * @param itemTemplate Template for the webmap item
    * @param destAuthentication Credentials for requests to the destination organization
    * @param srcAuthentication Credentials for requests to source items
+   * @param templateDictionary Hash of key details used for variable replacement
    * @returns Template for the solution item that contains key details for item reconstruction
    */
-  function convertItemToTemplate$2(itemTemplate, destAuthentication, srcAuthentication) {
+  function convertItemToTemplate$2(itemTemplate, destAuthentication, srcAuthentication, templateDictionary) {
       return new Promise((resolve, reject) => {
           // Templatize the app URL
           itemTemplate.item.url = itemTemplate.item.url ?
@@ -1747,8 +1763,8 @@
               itemTemplate.dependencies = results.dependencies;
               // Templatize the map layer ids after we've extracted them as dependencies
               if (itemTemplate.data) {
-                  _templatizeWebmapLayerIdsAndUrls(itemTemplate.data.operationalLayers, results.urlHash);
-                  _templatizeWebmapLayerIdsAndUrls(itemTemplate.data.tables, results.urlHash);
+                  _templatizeWebmapLayerIdsAndUrls(itemTemplate.data.operationalLayers, results.urlHash, templateDictionary);
+                  _templatizeWebmapLayerIdsAndUrls(itemTemplate.data.tables, results.urlHash, templateDictionary);
                   // Exclude intialState
                   _excludeInitialState(itemTemplate.data);
               }
@@ -1864,10 +1880,11 @@
    *
    * @param layerList List of map layers or tables
    * @param urlHash Lookup object for analysis layers
+   * @param templateDictionary Hash of key details used for variable replacement
    * @returns void
    * @private
    */
-  function _templatizeWebmapLayerIdsAndUrls(layerList = [], urlHash) {
+  function _templatizeWebmapLayerIdsAndUrls(layerList = [], urlHash, templateDictionary) {
       layerList.forEach((layer) => {
           if (layer.url) {
               const layerId = layer.url.substr(layer.url.lastIndexOf("/") + 1);
@@ -1875,6 +1892,7 @@
                   ? urlHash[layer.url]
                   : undefined;
               if (id) {
+                  common__namespace.cacheLayerInfo(layerId, id, layer.url, templateDictionary);
                   layer.url = common__namespace.templatizeTerm(id, id, ".layer" + layerId + ".url");
                   layer.itemId = common__namespace.templatizeTerm(id, id, ".layer" + layerId + ".itemId");
               }
@@ -2047,32 +2065,28 @@
                       });
                   }
               });
-              let wrapupPromise = Promise.resolve(null);
               let templateModifyingPromise = Promise.resolve(itemTemplate);
               switch (itemInfo.type) {
                   case "Dashboard":
-                      convertItemToTemplate$8(itemTemplate);
+                      convertItemToTemplate$8(itemTemplate, templateDictionary);
                       break;
                   case "Form":
                       // Store the form's data in the solution resources, not in template
                       itemTemplate.data = null;
-                      // Store form data
+                      // Add the form data to the template for a post-process resource upload
                       if (itemDataResponse) {
-                          const originalFilename = itemTemplate.item.name || itemDataResponse.name;
-                          const filename = originalFilename && originalFilename !== "undefined"
-                              ? originalFilename
-                              : `${itemTemplate.itemId}.zip`;
-                          itemTemplate.item.name = filename;
-                          const storageName = common__namespace.convertItemResourceToStorageResource(itemTemplate.itemId, filename, common__namespace.SolutionTemplateFormatVersion, common__namespace.SolutionResourceType.data);
-                          wrapupPromise = new Promise((resolveDataStorage, rejectDataStorage) => {
-                              common__namespace
-                                  .addResourceFromBlob(itemDataResponse, solutionItemId, storageName.folder, filename, destAuthentication)
-                                  .then(() => {
-                                  // Update the template's resources
-                                  itemTemplate.resources.push(storageName.folder + "/" + storageName.filename);
-                                  resolveDataStorage();
-                              }, rejectDataStorage);
-                          });
+                          itemTemplate.item.name = _getFormDataFilename(itemTemplate.item.name, itemDataResponse.name, `${itemTemplate.itemId}.zip`);
+                          const storageName = common__namespace.convertItemResourceToStorageResource(itemTemplate.itemId, itemTemplate.item.name, common__namespace.SolutionTemplateFormatVersion, common__namespace.SolutionResourceType.data);
+                          // Add the data file to the template so that it can be uploaded with the other resources in the solution
+                          const dataFile = {
+                              itemId: itemTemplate.itemId,
+                              file: itemDataResponse,
+                              folder: storageName.folder,
+                              filename: itemTemplate.item.name
+                          };
+                          itemTemplate.dataFile = dataFile;
+                          // Update the template's resources
+                          itemTemplate.resources.push(storageName.folder + "/" + storageName.filename);
                       }
                       break;
                   case "Notebook":
@@ -2083,25 +2097,40 @@
                       break;
                   case "Web Map":
                   case "Web Scene":
-                      templateModifyingPromise = convertItemToTemplate$2(itemTemplate, destAuthentication, srcAuthentication);
+                      templateModifyingPromise = convertItemToTemplate$2(itemTemplate, destAuthentication, srcAuthentication, templateDictionary);
                       break;
                   case "Web Mapping Application":
                       if (itemDataResponse) {
-                          templateModifyingPromise = convertItemToTemplate$7(itemTemplate, destAuthentication, srcAuthentication);
+                          templateModifyingPromise = convertItemToTemplate$7(itemTemplate, destAuthentication, srcAuthentication, templateDictionary);
                       }
                       break;
                   case "Workforce Project":
-                      templateModifyingPromise = convertItemToTemplate$6(itemTemplate, destAuthentication, srcAuthentication);
+                      templateModifyingPromise = convertItemToTemplate$6(itemTemplate, destAuthentication, srcAuthentication, templateDictionary);
                       break;
                   case "QuickCapture Project":
                       templateModifyingPromise = convertQuickCaptureToTemplate(itemTemplate);
                       break;
               }
-              wrapupPromise.then(() => {
-                  templateModifyingPromise.then(resolve, err => reject(common__namespace.fail(err)));
-              }, err => reject(common__namespace.fail(err)));
+              templateModifyingPromise.then(resolve, err => reject(common__namespace.fail(err)));
           });
       });
+  }
+  /**
+   * 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;
   }
 
   /** @license