@esri/solution-creator 4.1.2 → 5.0.0

package/dist/cjs/createItemTemplate.d.ts

@@ -1,108 +1,108 @@
-/** @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.
- */
-/**
- * Manages creation of the template of a Solution item via the REST API.
- *
- * @module createItemTemplate
- */
-import { IDatasourceInfo, IItemProgressCallback, IItemTemplate, ISourceFile, UserSession } from "@esri/solution-common";
-/**
- * Creates template for an AGO item and its dependencies
- *
- * @param solutionItemId The solution to contain the item
- * @param itemId AGO id string
- * @param templateDictionary Hash of facts
- * @param srcAuthentication Credentials for requests to source items
- * @param destAuthentication Authentication for requesting information from AGO about items to be included in solution item
- * @param existingTemplates A collection of AGO item templates that can be referenced by newly-created templates
- * @returns A promise which resolves with an array of resources for the item and its dependencies
- * @private
- */
-export declare function createItemTemplate(solutionItemId: string, itemId: string, templateDictionary: any, srcAuthentication: UserSession, destAuthentication: UserSession, existingTemplates: IItemTemplate[], itemProgressCallback: IItemProgressCallback): Promise<ISourceFile[]>;
-/**
- * Templatizes field references within specific template types.
- * Currently only handles web applications
- *
- * @param templates List of solution templates
- * @returns A list of templates that have templatized field references
- */
-export declare function postProcessFieldReferences(templates: IItemTemplate[]): IItemTemplate[];
-/**
- * Get common properties that will support the templatization of field references
- *
- * @param templates List of solution templates
- * @returns A list of IDataSourceInfo objects with key properties
- * @private
- */
-export declare function _getDatasourceInfos(templates: IItemTemplate[]): IDatasourceInfo[];
-/**
- * Creates a simple lookup object to quickly understand an items type and dependencies
- * and associated web map layer ids based on itemId
- *
- * @param templates List of solution templates
- * @returns The lookup object with type, dependencies, and webmap layer info
- * @private
- */
-export declare function _getTemplateTypeHash(templates: IItemTemplate[]): any;
-/**
- * Updates the lookup object with webmap layer info
- * so we can know the id used within a map for a given feature service
- *
- * @param template A webmap solution template
- * @returns The lookup object with webmap layer info added
- * @private
- */
-export declare function _updateWebMapHashInfo(template: IItemTemplate, hashItem: any): void;
-/**
- * Updates a templatized datasource URL with a layer id.
- *
- * @param dataSourceUrl Templatized datasource URL
- * @param layerId Layer id
- * @returns string Amended datasource URL
- * @private
- */
-export declare function _addLayerIdToDatasourceUrl(datasourceUrl?: string, layerId?: any): string;
-/**
- * Updates the datasource info objects by passing the webmap layer IDs from the lookup hash
- * to the underlying feature service datasource infos
- *
- * @param datasourceInfos A webmap solution template
- * @param templateTypeHash A simple lookup object populated with key item info
- * @returns The updated datasource infos
- * @private
- */
-export declare function _addMapLayerIds(datasourceInfos: IDatasourceInfo[], templateTypeHash: any): IDatasourceInfo[];
-/**
- * Get feature service item IDs from applications webmaps
- * As they are not explict dependencies of the application but are needed for field references
- *
- * @param template A webmap solution template
- * @param templateTypeHash A simple lookup object populated with key item info
- * @returns A list of feature service item IDs
- * @private
- */
-export declare function _getWebMapFSDependencies(template: IItemTemplate, templateTypeHash: any): string[];
-/**
- * Perform templatizations needed in an item's resources
- *
- * @param itemTemplate Item being templatized
- * @param resourceItemFiles Resources for the item; these resources are modified as needed
- * by the templatization
- * @param srcAuthentication Credentials for requests to source items
- *
- * @returns A promise that resolves when all templatization has completed
- */
-export declare function _templatizeResources(itemTemplate: IItemTemplate, resourceItemFiles: ISourceFile[], srcAuthentication: UserSession): Promise<void[]>;
+/** @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.
+ */
+/**
+ * Manages creation of the template of a Solution item via the REST API.
+ *
+ * @module createItemTemplate
+ */
+import { IDatasourceInfo, IItemProgressCallback, IItemTemplate, ISourceFile, UserSession } from "@esri/solution-common";
+/**
+ * Creates template for an AGO item and its dependencies
+ *
+ * @param solutionItemId The solution to contain the item
+ * @param itemId AGO id string
+ * @param templateDictionary Hash of facts
+ * @param srcAuthentication Credentials for requests to source items
+ * @param destAuthentication Authentication for requesting information from AGO about items to be included in solution item
+ * @param existingTemplates A collection of AGO item templates that can be referenced by newly-created templates
+ * @returns A promise which resolves with an array of resources for the item and its dependencies
+ * @private
+ */
+export declare function createItemTemplate(solutionItemId: string, itemId: string, templateDictionary: any, srcAuthentication: UserSession, destAuthentication: UserSession, existingTemplates: IItemTemplate[], itemProgressCallback: IItemProgressCallback): Promise<ISourceFile[]>;
+/**
+ * Templatizes field references within specific template types.
+ * Currently only handles web applications
+ *
+ * @param templates List of solution templates
+ * @returns A list of templates that have templatized field references
+ */
+export declare function postProcessFieldReferences(templates: IItemTemplate[]): IItemTemplate[];
+/**
+ * Get common properties that will support the templatization of field references
+ *
+ * @param templates List of solution templates
+ * @returns A list of IDataSourceInfo objects with key properties
+ * @private
+ */
+export declare function _getDatasourceInfos(templates: IItemTemplate[]): IDatasourceInfo[];
+/**
+ * Creates a simple lookup object to quickly understand an items type and dependencies
+ * and associated web map layer ids based on itemId
+ *
+ * @param templates List of solution templates
+ * @returns The lookup object with type, dependencies, and webmap layer info
+ * @private
+ */
+export declare function _getTemplateTypeHash(templates: IItemTemplate[]): any;
+/**
+ * Updates the lookup object with webmap layer info
+ * so we can know the id used within a map for a given feature service
+ *
+ * @param template A webmap solution template
+ * @returns The lookup object with webmap layer info added
+ * @private
+ */
+export declare function _updateWebMapHashInfo(template: IItemTemplate, hashItem: any): void;
+/**
+ * Updates a templatized datasource URL with a layer id.
+ *
+ * @param dataSourceUrl Templatized datasource URL
+ * @param layerId Layer id
+ * @returns string Amended datasource URL
+ * @private
+ */
+export declare function _addLayerIdToDatasourceUrl(datasourceUrl?: string, layerId?: any): string;
+/**
+ * Updates the datasource info objects by passing the webmap layer IDs from the lookup hash
+ * to the underlying feature service datasource infos
+ *
+ * @param datasourceInfos A webmap solution template
+ * @param templateTypeHash A simple lookup object populated with key item info
+ * @returns The updated datasource infos
+ * @private
+ */
+export declare function _addMapLayerIds(datasourceInfos: IDatasourceInfo[], templateTypeHash: any): IDatasourceInfo[];
+/**
+ * Get feature service item IDs from applications webmaps
+ * As they are not explict dependencies of the application but are needed for field references
+ *
+ * @param template A webmap solution template
+ * @param templateTypeHash A simple lookup object populated with key item info
+ * @returns A list of feature service item IDs
+ * @private
+ */
+export declare function _getWebMapFSDependencies(template: IItemTemplate, templateTypeHash: any): string[];
+/**
+ * Perform templatizations needed in an item's resources
+ *
+ * @param itemTemplate Item being templatized
+ * @param resourceItemFiles Resources for the item; these resources are modified as needed
+ * by the templatization
+ * @param srcAuthentication Credentials for requests to source items
+ *
+ * @returns A promise that resolves when all templatization has completed
+ */
+export declare function _templatizeResources(itemTemplate: IItemTemplate, resourceItemFiles: ISourceFile[], srcAuthentication: UserSession): Promise<void[]>;