@esri/solution-simple-types 4.1.2 → 5.0.0

package/dist/cjs/simple-types.js

@@ -1,95 +1,95 @@
-"use strict";
-/** @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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.postProcess = exports.postProcessFieldReferences = exports.createItemFromTemplate = exports.convertItemToTemplate = void 0;
-const tslib_1 = require("tslib");
-/**
- * Manages the creation and deployment of simple item types.
- *
- * @module simple-types
- */
-const dashboard = tslib_1.__importStar(require("./dashboard"));
-const webmap = tslib_1.__importStar(require("./webmap"));
-const webmappingapplication = tslib_1.__importStar(require("./webmappingapplication"));
-const solution_common_1 = require("@esri/solution-common");
-// Need to import collectively to enable spying
-const simpleTypeHelpers = tslib_1.__importStar(require("./helpers/simple-type-helpers"));
-/**
- * Converts an item into a template.
- *
- * @param solutionItemId The solution to contain the 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(solutionItemId, itemInfo, destAuthentication, srcAuthentication, templateDictionary) {
-    return simpleTypeHelpers.convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication, templateDictionary);
-}
-exports.convertItemToTemplate = convertItemToTemplate;
-/**
- * Delegate to simpleType creator
- *
- * @param template
- * @param templateDictionary
- * @param destinationAuthentication
- * @param itemProgressCallback
- */
-function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
-    return simpleTypeHelpers.createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback);
-}
-exports.createItemFromTemplate = createItemFromTemplate;
-/**
- * Templatizes field references within specific template types.
- * Currently only handles web mapping applications
- *
- * @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
- * @returns The updated solution template
- */
-function postProcessFieldReferences(solutionTemplate, datasourceInfos, type) {
-    switch (type) {
-        case "Web Mapping Application":
-            webmappingapplication.postProcessFieldReferences(solutionTemplate, datasourceInfos);
-            break;
-        case "Dashboard":
-            dashboard.postProcessFieldReferences(solutionTemplate, datasourceInfos);
-            break;
-        case "Web Map":
-            webmap.postProcessFieldReferences(solutionTemplate, datasourceInfos);
-            break;
-    }
-    return solutionTemplate;
-}
-exports.postProcessFieldReferences = postProcessFieldReferences;
-/**
- * Simple Type post-processing actions
- *
- * @param {string} itemId The item ID
- * @param {string} type The template type
- * @param {any[]} itemInfos Array of \{id: 'ef3', type: 'Web Map'\} objects
- * @param {any} templateDictionary The template dictionary
- * @param {UserSession} authentication The destination session info
- * @returns Promise resolving to successfulness of update
- */
-function postProcess(itemId, type, itemInfos, template, templates, templateDictionary, authentication) {
-    return (0, solution_common_1.updateItemTemplateFromDictionary)(itemId, templateDictionary, authentication);
-}
-exports.postProcess = postProcess;
+"use strict";
+/** @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.postProcess = exports.postProcessFieldReferences = exports.createItemFromTemplate = exports.convertItemToTemplate = void 0;
+const tslib_1 = require("tslib");
+/**
+ * Manages the creation and deployment of simple item types.
+ *
+ * @module simple-types
+ */
+const dashboard = tslib_1.__importStar(require("./dashboard"));
+const webmap = tslib_1.__importStar(require("./webmap"));
+const webmappingapplication = tslib_1.__importStar(require("./webmappingapplication"));
+const solution_common_1 = require("@esri/solution-common");
+// Need to import collectively to enable spying
+const simpleTypeHelpers = tslib_1.__importStar(require("./helpers/simple-type-helpers"));
+/**
+ * Converts an item into a template.
+ *
+ * @param solutionItemId The solution to contain the 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(solutionItemId, itemInfo, destAuthentication, srcAuthentication, templateDictionary) {
+    return simpleTypeHelpers.convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication, templateDictionary);
+}
+exports.convertItemToTemplate = convertItemToTemplate;
+/**
+ * Delegate to simpleType creator
+ *
+ * @param template
+ * @param templateDictionary
+ * @param destinationAuthentication
+ * @param itemProgressCallback
+ */
+function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
+    return simpleTypeHelpers.createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback);
+}
+exports.createItemFromTemplate = createItemFromTemplate;
+/**
+ * Templatizes field references within specific template types.
+ * Currently only handles web mapping applications
+ *
+ * @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
+ * @returns The updated solution template
+ */
+function postProcessFieldReferences(solutionTemplate, datasourceInfos, type) {
+    switch (type) {
+        case "Web Mapping Application":
+            webmappingapplication.postProcessFieldReferences(solutionTemplate, datasourceInfos);
+            break;
+        case "Dashboard":
+            dashboard.postProcessFieldReferences(solutionTemplate, datasourceInfos);
+            break;
+        case "Web Map":
+            webmap.postProcessFieldReferences(solutionTemplate, datasourceInfos);
+            break;
+    }
+    return solutionTemplate;
+}
+exports.postProcessFieldReferences = postProcessFieldReferences;
+/**
+ * Simple Type post-processing actions
+ *
+ * @param {string} itemId The item ID
+ * @param {string} type The template type
+ * @param {any[]} itemInfos Array of \{id: 'ef3', type: 'Web Map'\} objects
+ * @param {any} templateDictionary The template dictionary
+ * @param {UserSession} authentication The destination session info
+ * @returns Promise resolving to successfulness of update
+ */
+function postProcess(itemId, type, itemInfos, template, templates, templateDictionary, authentication) {
+    return (0, solution_common_1.updateItemTemplateFromDictionary)(itemId, templateDictionary, authentication);
+}
+exports.postProcess = postProcess;
 //# sourceMappingURL=simple-types.js.map

package/dist/cjs/webmap.d.ts

@@ -1,102 +1,102 @@
-/** @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";
-/**
- * Converts an AGOL webmap item to a template.
- *
- * @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, templateDictionary: any): Promise<common.IItemTemplate>;
-/**
- * Gets the ids of the dependencies of an AGOL webmap item.
- *
- * @param itemTemplate A webmap item whose dependencies are sought
- * @param authentication Credentials for any requests
- * @returns List of dependencies ids and url/itemId hash
- * @private
- */
-export declare function _extractDependencies(itemTemplate: common.IItemTemplate, authentication: common.UserSession): Promise<common.IWebmapDependencies>;
-/**
- * Remove the initialState prop from webmaps saved from the new map viewer.
- * This allows the map to use the item extent property that we templatize.
- *
- * Added for issue #662
- *
- * @param data the data for the web maps item template
- * @returns void
- * @private
- */
-export declare function _excludeInitialState(data: any): void;
-/**
- * Extracts the AGOL itemId for each layer or table object in a list using the url.
- *
- * @param layerList List of map layers or tables; supported vector tile layers have their styleUrls templatized
- * @param dependencies Current list of dependencies
- * @param authentication Credentials for any requests
- * @returns Updated list of dependencies ids, url/itemId hash (for feature layers),
- * and id/styleUrl hash (for vector tile layers)
- * @private
- */
-export declare function _getLayerIds(layerList: any[], dependencies: string[], authentication: common.UserSession): Promise<common.IWebmapDependencies>;
-/**
- * Templatizes the url and item id for layers or tables within the webmap.
- *
- * @param layerList List of map layers or tables
- * @param urlHash Lookup object for analysis layers; hash from URL to AGO item id
- * @param templateDictionary Hash of key details used for variable replacement
- * @returns void
- * @private
- */
-export declare function _templatizeWebmapLayerIdsAndUrls(layerList: any[], urlHash: common.IKeyedStrings, templateDictionary: any): void;
-/**
- * Templatize field references.
- *
- * @param solutionTemplate The solution item template
- * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
- * @returns The solutionTemplate with templatized field references
- */
-export declare function postProcessFieldReferences(solutionTemplate: common.IItemTemplate, datasourceInfos: common.IDatasourceInfo[]): common.IItemTemplate;
-/**
- * Templatize field references.
- *
- * @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
- */
-export declare function _templatizeProperty(solutionTemplate: common.IItemTemplate, datasourceInfos: common.IDatasourceInfo[], path: string): void;
-/**
- * Templatize field references.
- *
- * @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
- */
-export declare function _templatize(objs: any[], datasourceInfos: common.IDatasourceInfo[]): any[];
-/**
- * Get datasourceInfo by map layer id
- *
- * @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
- */
-export declare function _getDatasourceInfo(obj: any, datasourceInfos: common.IDatasourceInfo[]): any;
+/** @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";
+/**
+ * Converts an AGOL webmap item to a template.
+ *
+ * @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, templateDictionary: any): Promise<common.IItemTemplate>;
+/**
+ * Gets the ids of the dependencies of an AGOL webmap item.
+ *
+ * @param itemTemplate A webmap item whose dependencies are sought
+ * @param authentication Credentials for any requests
+ * @returns List of dependencies ids and url/itemId hash
+ * @private
+ */
+export declare function _extractDependencies(itemTemplate: common.IItemTemplate, authentication: common.UserSession): Promise<common.IWebmapDependencies>;
+/**
+ * Remove the initialState prop from webmaps saved from the new map viewer.
+ * This allows the map to use the item extent property that we templatize.
+ *
+ * Added for issue #662
+ *
+ * @param data the data for the web maps item template
+ * @returns void
+ * @private
+ */
+export declare function _excludeInitialState(data: any): void;
+/**
+ * Extracts the AGOL itemId for each layer or table object in a list using the url.
+ *
+ * @param layerList List of map layers or tables; supported vector tile layers have their styleUrls templatized
+ * @param dependencies Current list of dependencies
+ * @param authentication Credentials for any requests
+ * @returns Updated list of dependencies ids, url/itemId hash (for feature layers),
+ * and id/styleUrl hash (for vector tile layers)
+ * @private
+ */
+export declare function _getLayerIds(layerList: any[], dependencies: string[], authentication: common.UserSession): Promise<common.IWebmapDependencies>;
+/**
+ * Templatizes the url and item id for layers or tables within the webmap.
+ *
+ * @param layerList List of map layers or tables
+ * @param urlHash Lookup object for analysis layers; hash from URL to AGO item id
+ * @param templateDictionary Hash of key details used for variable replacement
+ * @returns void
+ * @private
+ */
+export declare function _templatizeWebmapLayerIdsAndUrls(layerList: any[], urlHash: common.IKeyedStrings, templateDictionary: any): void;
+/**
+ * Templatize field references.
+ *
+ * @param solutionTemplate The solution item template
+ * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
+ * @returns The solutionTemplate with templatized field references
+ */
+export declare function postProcessFieldReferences(solutionTemplate: common.IItemTemplate, datasourceInfos: common.IDatasourceInfo[]): common.IItemTemplate;
+/**
+ * Templatize field references.
+ *
+ * @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
+ */
+export declare function _templatizeProperty(solutionTemplate: common.IItemTemplate, datasourceInfos: common.IDatasourceInfo[], path: string): void;
+/**
+ * Templatize field references.
+ *
+ * @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
+ */
+export declare function _templatize(objs: any[], datasourceInfos: common.IDatasourceInfo[]): any[];
+/**
+ * Get datasourceInfo by map layer id
+ *
+ * @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
+ */
+export declare function _getDatasourceInfo(obj: any, datasourceInfos: common.IDatasourceInfo[]): any;