@esri/solution-simple-types 1.3.10 → 1.3.13

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

@@ -1,7 +1,7 @@
 /* @preserve
-* @esri/solution-simple-types - v1.3.10 - Apache-2.0
+* @esri/solution-simple-types - v1.3.13 - Apache-2.0
 * Copyright (c) 2018-2022 Esri, Inc.
-* Tue Mar 29 2022 11:38:03 GMT-0700 (Pacific Daylight Time)
+* Tue Apr 26 2022 15:04:36 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,7 +60,7 @@
    * Converts a dashboard item to a template.
    *
    * @param itemTemplate Template for the dashboard item
-   * @return templatized itemTemplate
+   * @returns templatized itemTemplate
    */
   function convertItemToTemplate$8(itemTemplate) {
       return _extractDependencies$3(itemTemplate);
@@ -69,8 +69,9 @@
    * Templatizes all itemIds and updates the dependency array
    *
    * @param itemTemplate Template for the dashboard item
-   * @return The updated itemTemplate
-   * @protected
+   * @returns The updated itemTemplate
+   * @private
+   * @private
    */
   function _extractDependencies$3(itemTemplate) {
       // get dependencies from any
@@ -106,6 +107,7 @@
    *
    * @param obj A widget, selector, or urlParameter that contains a datasets collection
    * @param itemTemplate Template for the dashboard item
+   * @private
    */
   function _getDatasourceDependencies(obj, itemTemplate) {
       obj.datasets.forEach((dataset) => {
@@ -155,7 +157,7 @@
    *
    * @param objs Thes can be widgets, selectors, or urlParameters
    * @param datasourceInfos A list of objects that contain key details about the datasources from the application
-   * @protected
+   * @private
    */
   function _updateDatasourceReferences(objs, datasourceInfos) {
       // objects can be events or widgets
@@ -206,7 +208,7 @@
    * @param itemTemplate Template for the dashboard item
    * @param path A property path to an array of objects that could contain datasets or events
    * @param datasourceInfos A list of objects that contain key details about the datasources from the application
-   * @protected
+   * @private
    */
   function _templatize$1(itemTemplate, path, datasourceInfos) {
       const obj = common__namespace.getProp(itemTemplate, path);
@@ -220,8 +222,8 @@
    *
    * @param objs A list of objects that can contain field references
    * @param datasourceInfos A list of objects that contain key details about the datasources from the application
-   * @return An updated list of objects with templatized field references
-   * @protected
+   * @returns An updated list of objects with templatized field references
+   * @private
    */
   function _templatizeByDatasource(objs, datasourceInfos) {
       if (Array.isArray(objs)) {
@@ -294,8 +296,8 @@
    *
    * @param obj Can be a Dataset or an event
    * @param datasourceInfos A list of objects that contain key details about the datasources from the application
-   * @return The supporting datasource info for the given object
-   * @protected
+   * @returns The supporting datasource info for the given object
+   * @private
    */
   function _getDatasourceInfo$1(obj, datasourceInfos) {
       let info;
@@ -339,7 +341,7 @@
    *
    * @param ds The datasource info to add the reference to
    * @param id The id from dashboard object, commonly another widget
-   * @protected
+   * @private
    */
   function _updateReferences(ds, id) {
       ds.references = Array.isArray(ds.references) ? ds.references : [];
@@ -370,7 +372,7 @@
    * @param itemInfo Info about the item
    * @param destAuthentication Credentials for requests to the destination organization
    * @param srcAuthentication Credentials for requests to source items
-   * @return A promise that will resolve when the template has been created
+   * @returns A promise that will resolve when the template has been created
    */
   function convertItemToTemplate$7(itemTemplate, destAuthentication, srcAuthentication) {
       return new Promise((resolve, reject) => {
@@ -639,8 +641,8 @@
    * Gets the ids of the dependencies of an AGOL webapp item.
    *
    * @param fullItem A webapp item whose dependencies are sought
-   * @return A promise that will resolve with list of dependent ids
-   * @protected
+   * @returns A promise that will resolve with list of dependent ids
+   * @private
    */
   function _extractDependencies$2(model) {
       let processor = _getGenericWebAppDependencies;
@@ -656,11 +658,14 @@
   }
   /**
    * Generic Web App Dependencies
+   *
+   * @private
    */
   function _getGenericWebAppDependencies(model) {
       const props = ["data.values.webmap", "data.values.group"];
       return common__namespace.getProps(model, props);
   }
+  //???
   function _getWABDependencies(model) {
       const deps = [];
       const v = common__namespace.getProp(model, "data.map.itemId");
@@ -683,7 +688,7 @@
    *
    * @param itemTemplate The solution item template
    * @param paths A list of property paths that contain ids
-   * @protected
+   * @private
    */
   function _templatizeIdPaths(itemTemplate, paths) {
       paths.forEach(path => {
@@ -697,7 +702,7 @@
    * @param itemTemplate The solution item template
    * @param path A path to an id property
    * @param id The base id to use when templatizing
-   * @protected
+   * @private
    */
   function _templatizeIdPath(itemTemplate, path, id) {
       common__namespace.setProp(itemTemplate, path, common__namespace.templatizeTerm(id, id, ".itemId"));
@@ -743,6 +748,7 @@
    * @param obj The dataSource or widget object from the web application.
    * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
    * @returns The dataSource with templatized field references
+   * @private
    */
   function _templatizeObject(obj, datasourceInfos, templatizeKeys = false) {
       obj = _prioritizedTests(obj, datasourceInfos, templatizeKeys);
@@ -758,6 +764,7 @@
    * @param objects A list of widgets or objects from the web application that may contain field references.
    * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
    * @returns The widgets with templatized field references
+   * @private
    */
   function _templatizeObjectArray(objects, datasourceInfos) {
       const updateKeyObjects = ["SmartEditor", "Screening"];
@@ -778,6 +785,7 @@
    * @param obj The dataSource or widget object from the web application.
    * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
    * @returns A list of datasourceInfo objects sorted based on the presence of a layers url or id
+   * @private
    */
   function _getReplaceOrder(obj, datasourceInfos) {
       const objString = JSON.stringify(obj);
@@ -794,6 +802,7 @@
    * @param datasourceInfo The datasource object with key properties about the service.
    * @param testString A stringified version of a widget or dataSource
    * @returns The prioritized order for testing
+   * @private
    */
   function _getSortOrder(datasourceInfo, testString) {
       const url = datasourceInfo.url;
@@ -842,6 +851,7 @@
    * @param obj The dataSource or widget object from the application
    * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
    * @returns An updated instance of the dataSource or widget with as many field references templatized as possible.
+   * @private
    */
   function _prioritizedTests(obj, datasourceInfos, templatizeKeys) {
       const objString = JSON.stringify(obj);
@@ -883,6 +893,7 @@
    * @param obj The dataSource or widget object from the application
    * @param ds A datasourceInfo object to use for testing against the current dataSource or widget
    * @returns The updated instance of the object with as many field references templatized as possible
+   * @private
    */
   function _templatizeParentByURL(obj, ds, templatizeKeys) {
       let clone = {};
@@ -924,6 +935,7 @@
    * @param ds A datasourceInfo object to use for testing against the current dataSource or widget
    * @param id A webmap layer id to test with.
    * @returns The updated instance of the object with as many field references templatized as possible
+   * @private
    */
   function _templatizeParentByWebMapLayerId(obj, ds, id, templatizeKeys) {
       let clone = {};
@@ -996,7 +1008,7 @@
    * @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
-   * @return templatized itemTemplate
+   * @returns templatized itemTemplate
    */
   function convertItemToTemplate$6(itemTemplate, destAuthentication, srcAuthentication) {
       return common__namespace.convertWorkforceItemToTemplate(itemTemplate, srcAuthentication);
@@ -1006,7 +1018,7 @@
    *
    * @param newlyCreatedItem Item to be created; n.b.: this item is modified
    * @param destinationAuthentication The session used to create the new item(s)
-   * @return A promise that will resolve with { "success" === true || false }
+   * @returns A promise that will resolve with { "success" === true || false }
    */
   function fineTuneCreatedItem$1(newlyCreatedItem, destinationAuthentication, templateDictionary) {
       return common__namespace.fineTuneCreatedWorkforceItem(newlyCreatedItem, destinationAuthentication, "", templateDictionary);
@@ -1210,7 +1222,7 @@
    * @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
-   * @return A promise that will resolve when the template has been created
+   * @returns A promise that will resolve when the template has been created
    */
   function convertItemToTemplate$5(solutionItemId, itemInfo, destAuthentication, srcAuthentication, templateDictionary) {
       // Delegate back to simple-types, which will in-turn delegate
@@ -1227,7 +1239,7 @@
    * Converts a Python Notebook item to a template.
    *
    * @param itemTemplate template for the Python Notebook
-   * @return templatized itemTemplate
+   * @returns templatized itemTemplate
    */
   function convertNotebookToTemplate(itemTemplate) {
       // The templates data to process
@@ -1280,7 +1292,7 @@
    * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
    * @param authentication Credentials for the requests to the destination
    *
-   * @return A promise that will resolve once any updates have been made
+   * @returns A promise that will resolve once any updates have been made
    */
   function fineTuneCreatedItem(originalTemplate, newlyCreatedItem, templateDictionary, authentication) {
       return new Promise((resolve, reject) => {
@@ -1340,7 +1352,7 @@
    * @param itemTemplate Template for the OIC (Oriented Imagery Catalog) item
    * @param destAuthentication Credentials for requests to the destination organization
    * @param srcAuthentication Credentials for requests to source items
-   * @return Template for the solution item that contains key details for item reconstruction
+   * @returns Template for the solution item that contains key details for item reconstruction
    */
   function convertItemToTemplate$4(itemTemplate, destAuthentication, srcAuthentication) {
       return new Promise((resolve, reject) => {
@@ -1362,8 +1374,8 @@
    *
    * @param itemTemplate A OIC (Oriented Imagery Catalog) item whose dependencies are sought
    * @param authentication Credentials for any requests
-   * @return List of dependencies ids and url/itemId hash
-   * @protected
+   * @returns List of dependencies ids and url/itemId hash
+   * @private
    */
   function _extractDependencies$1(itemTemplate, authentication) {
       return new Promise((resolve, reject) => {
@@ -1398,8 +1410,8 @@
    * @param layerURLs List of OIC layer URLs
    * @param dependencies Current list of dependencies
    * @param authentication Credentials for any requests
-   * @return List of dependencies ids and url/itemId hash
-   * @protected
+   * @returns List of dependencies ids and url/itemId hash
+   * @private
    */
   function _getLayerIds$1(layerURLs, dependencies, authentication) {
       return new Promise((resolve, reject) => {
@@ -1463,8 +1475,8 @@
    *
    * @param layerURL OIC layer URL
    * @param urlHash Lookup object for analysis layers
-   * @return Templatized URL if layerURL is in the urlHash
-   * @protected
+   * @returns Templatized URL if layerURL is in the urlHash
+   * @private
    */
   function _templatizeOicLayerUrl(layerURL, urlHash) {
       let templatizedURL = layerURL;
@@ -1526,7 +1538,7 @@
    * @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
-   * @return A promise that will resolve when the template has been created
+   * @returns A promise that will resolve when the template has been created
    */
   function convertItemToTemplate$3(solutionItemId, itemInfo, destAuthentication, srcAuthentication, templateDictionary) {
       // Delegate back to simple-types, which will in-turn delegate
@@ -1538,7 +1550,7 @@
    * Converts an quick capture item to a template.
    *
    * @param itemTemplate template for the quick capture project item
-   * @return templatized itemTemplate
+   * @returns templatized itemTemplate
    */
   function convertQuickCaptureToTemplate(itemTemplate) {
       return new Promise((resolve, reject) => {
@@ -1575,7 +1587,8 @@
    *
    * @param data the projects json
    * @param itemTemplate template for the quick capture project item
-   * @return templatized itemTemplate
+   * @returns templatized itemTemplate
+   * @private
    */
   function _templatizeApplication(data, itemTemplate) {
       // Quick Project item id
@@ -1600,6 +1613,7 @@
    * Templatize the email property
    *
    * @param data the quick capture application
+   * @private
    */
   function _templatizeAdminEmail(data) {
       if (common__namespace.getProp(data, "preferences.adminEmail")) {
@@ -1611,7 +1625,7 @@
    *
    * @param id the item id of the dependency
    * @param itemTemplate template for the quick capture project item
-   * @return templatized itemTemplate
+   * @returns templatized itemTemplate
    */
   function _updateDependencies(id, itemTemplate) {
       if (itemTemplate.dependencies.indexOf(id) === -1) {
@@ -1624,6 +1638,7 @@
    * @param obj the datasource object
    * @param idPath the path to the id property
    * @param urlPath the path to the url property
+   * @private
    */
   function _templatizeUrl(obj, idPath, urlPath) {
       const id = common__namespace.getProp(obj, idPath);
@@ -1638,6 +1653,7 @@
    *
    * @param obj the datasource or object that contains the item id property
    * @param path the path to the id property
+   * @private
    */
   function _templatizeId(obj, path) {
       const id = common__namespace.getProp(obj, path);
@@ -1707,7 +1723,7 @@
   /**
    * The portion of a Webmap URL between the server and the map id.
    *
-   * @protected
+   * @private
    */
   const WEBMAP_APP_URL_PART = "home/webmap/viewer.html?webmap=";
   // ------------------------------------------------------------------------------------------------------------------ //
@@ -1717,7 +1733,7 @@
    * @param itemTemplate Template for the webmap item
    * @param destAuthentication Credentials for requests to the destination organization
    * @param srcAuthentication Credentials for requests to source items
-   * @return Template for the solution item that contains key details for item reconstruction
+   * @returns Template for the solution item that contains key details for item reconstruction
    */
   function convertItemToTemplate$2(itemTemplate, destAuthentication, srcAuthentication) {
       return new Promise((resolve, reject) => {
@@ -1745,8 +1761,8 @@
    *
    * @param itemTemplate A webmap item whose dependencies are sought
    * @param authentication Credentials for any requests
-   * @return List of dependencies ids and url/itemId hash
-   * @protected
+   * @returns List of dependencies ids and url/itemId hash
+   * @private
    */
   function _extractDependencies(itemTemplate, authentication) {
       return new Promise((resolve, reject) => {
@@ -1774,8 +1790,8 @@
    * Added for issue #662
    *
    * @param data the data for the web maps item template
-   * @return void
-   * @protected
+   * @returns void
+   * @private
    */
   function _excludeInitialState(data) {
       common__namespace.deleteProp(data, "initialState");
@@ -1786,8 +1802,8 @@
    * @param layerList List of map layers or tables
    * @param dependencies Current list of dependencies
    * @param authentication Credentials for any requests
-   * @return List of dependencies ids and url/itemId hash
-   * @protected
+   * @returns List of dependencies ids and url/itemId hash
+   * @private
    */
   function _getLayerIds(layerList, dependencies, authentication) {
       return new Promise((resolve, reject) => {
@@ -1848,8 +1864,8 @@
    *
    * @param layerList List of map layers or tables
    * @param urlHash Lookup object for analysis layers
-   * @return void
-   * @protected
+   * @returns void
+   * @private
    */
   function _templatizeWebmapLayerIdsAndUrls(layerList = [], urlHash) {
       layerList.forEach((layer) => {
@@ -1887,6 +1903,7 @@
    * @param solutionTemplate The solution item template
    * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
    * @param path A string path to the object property to templatize
+   * @private
    */
   function _templatizeProperty(solutionTemplate, datasourceInfos, path) {
       const objs = common__namespace.getProp(solutionTemplate, path);
@@ -1900,6 +1917,7 @@
    * @param objs Can be operationalLayers or tables or appProperties search layers
    * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
    * @returns updated instances of the objects
+   * @private
    */
   function _templatize(objs, datasourceInfos) {
       objs.forEach(obj => {
@@ -1927,6 +1945,7 @@
    * @param obj Can be operationalLayer or table or appProperties search layer
    * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
    * @returns datasourceInfo for the given object id
+   * @private
    */
   function _getDatasourceInfo(obj, datasourceInfos) {
       let datasourceInfo;
@@ -1966,7 +1985,7 @@
    * @param srcAuthentication Credentials for requests to source items
    * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
    *
-   * @return A promise that will resolve when the template has been created
+   * @returns A promise that will resolve when the template has been created
    */
   function convertItemToTemplate$1(solutionItemId, itemInfo, destAuthentication, srcAuthentication, templateDictionary) {
       return new Promise((resolve, reject) => {
@@ -2130,7 +2149,7 @@
    * @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
-   * @return A promise that will resolve when the template has been created
+   * @returns A promise that will resolve when the template has been created
    */
   function convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication, templateDictionary) {
       return convertItemToTemplate$1(solutionItemId, itemInfo, destAuthentication, srcAuthentication, templateDictionary);
@@ -2153,7 +2172,7 @@
    * @param template A solution template
    * @param datasourceInfos A list of objects that store key datasource info used to templatizing field references
    * @param type The item type
-   * @return The updated solution template
+   * @returns The updated solution template
    */
   function postProcessFieldReferences(solutionTemplate, datasourceInfos, type) {
       switch (type) {