@esri/solution-simple-types 4.1.2 → 5.0.1

package/dist/esm/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;