@esri/solution-creator 4.1.2 → 5.0.0

package/dist/cjs/helpers/add-content-to-solution.d.ts

@@ -1,126 +1,126 @@
-/** @license
- * Copyright 2020 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 { ICreateSolutionOptions, IItemTemplate, UserSession } from "@esri/solution-common";
-/**
- * Adds a list of AGO item ids to a solution item.
- *
- * @param solutionItemId AGO id of solution to receive items
- * @param options Customizations for creating the solution
- * @param srcAuthentication Credentials for requests to source items
- * @param destAuthentication Credentials for the requests to destination solution
- * @returns A promise that resolves with the AGO id of the updated solution
- * @internal
- */
-export declare function addContentToSolution(solutionItemId: string, options: ICreateSolutionOptions, srcAuthentication: UserSession, destAuthentication: UserSession): Promise<string>;
-/**
- * Gets the dependencies of an item by merging its dependencies list with item references in template variables.
- *
- * @param template Template to examine
- * @returns List of dependency ids
- * @private
- */
-export declare function _getDependencies(template: IItemTemplate): string[];
-/**
- * Extracts AGO ids out of template variables.
- *
- * @param variables List of template variables to examine
- * @returns List of AGO ids referenced in `variables`
- * @private
- */
-export declare function _getIdsOutOfTemplateVariables(variables: string[]): string[];
-/**
- * Creates a list of item URLs.
- *
- * @param templates Templates to check for URLs
- * @returns List of URLs
- * @private
- */
-export declare function _getSolutionItemUrls(templates: IItemTemplate[]): string[][];
-/**
- * Extracts template variables out of a string.
- *
- * @param text String to examine
- * @returns List of template variables found in string
- * @private
- */
-export declare function _getTemplateVariables(text: string): string[];
-/**
- * Update the items dependencies and groups arrays
- *
- * @param templates The array of templates to evaluate
- * @returns Updated version of the templates
- * @private
- */
-export declare function _postProcessGroupDependencies(templates: IItemTemplate[]): IItemTemplate[];
-/**
- * Check for feature service items that have been flagged for invalid designations.
- * Remove templates that have invalid designations from the solution item and other item dependencies.
- * Clean up any references to items with invalid designations in the other templates.
- *
- * @param templates The array of templates to evaluate
- * @param templateDictionary Hash of key details used for variable replacement
- * @returns Updated version of the templates
- * @private
- */
-export declare function _postProcessIgnoredItems(templates: IItemTemplate[], templateDictionary: any): IItemTemplate[];
-/**
- * Recursively runs through an object to find and replace any strings found in a dictionary.
- *
- * @param templateDictionary Hash of things to be replaced
- * @param obj Object to be examined
- * @private
- */
-export declare function _replaceDictionaryItemsInObject(hash: any, obj: any): any;
-/**
- * Recursively runs through an object to find and templatize any remaining references to solution's items.
- *
- * @param ids Ids to be replaced in strings found in object
- * @param obj Object to be examined
- * @private
- */
-export declare function _replaceRemainingIdsInObject(ids: string[], obj: any): any;
-/**
- * Templatizes ids from a list in a string if they're not already templatized.
- *
- * @param ids Ids to be replaced in source string
- * @param str Source string to be examined
- * @returns A copy of the source string with any templatization changes
- * @private
- */
-export declare function _replaceRemainingIdsInString(ids: string[], str: string): string;
-/**
- * Finds and templatizes any URLs in solution items' descriptions.
- *
- * @param templates The array of templates to evaluate, modified in place
- * @private
- */
-export declare function _simplifyUrlsInItemDescriptions(templates: IItemTemplate[]): void;
-/**
- * Templatizes occurrences of the URL to the user's organization in the `item` and `data` template sections.
- *
- * @param templates The array of templates to evaluate; templates is modified in place
- * @param destAuthentication Credentials for request organization info
- * @returns Promise resolving with `templates`
- * @private
- */
-export declare function _templatizeOrgUrl(templates: IItemTemplate[], destAuthentication: UserSession): Promise<IItemTemplate[]>;
-/**
- * Finds and templatizes any references to solution's items.
- *
- * @param templates The array of templates to evaluate, modified in place
- * @private
- */
-export declare function _templatizeSolutionIds(templates: IItemTemplate[]): void;
+/** @license
+ * Copyright 2020 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 { ICreateSolutionOptions, IItemTemplate, UserSession } from "@esri/solution-common";
+/**
+ * Adds a list of AGO item ids to a solution item.
+ *
+ * @param solutionItemId AGO id of solution to receive items
+ * @param options Customizations for creating the solution
+ * @param srcAuthentication Credentials for requests to source items
+ * @param destAuthentication Credentials for the requests to destination solution
+ * @returns A promise that resolves with the AGO id of the updated solution
+ * @internal
+ */
+export declare function addContentToSolution(solutionItemId: string, options: ICreateSolutionOptions, srcAuthentication: UserSession, destAuthentication: UserSession): Promise<string>;
+/**
+ * Gets the dependencies of an item by merging its dependencies list with item references in template variables.
+ *
+ * @param template Template to examine
+ * @returns List of dependency ids
+ * @private
+ */
+export declare function _getDependencies(template: IItemTemplate): string[];
+/**
+ * Extracts AGO ids out of template variables.
+ *
+ * @param variables List of template variables to examine
+ * @returns List of AGO ids referenced in `variables`
+ * @private
+ */
+export declare function _getIdsOutOfTemplateVariables(variables: string[]): string[];
+/**
+ * Creates a list of item URLs.
+ *
+ * @param templates Templates to check for URLs
+ * @returns List of URLs
+ * @private
+ */
+export declare function _getSolutionItemUrls(templates: IItemTemplate[]): string[][];
+/**
+ * Extracts template variables out of a string.
+ *
+ * @param text String to examine
+ * @returns List of template variables found in string
+ * @private
+ */
+export declare function _getTemplateVariables(text: string): string[];
+/**
+ * Update the items dependencies and groups arrays
+ *
+ * @param templates The array of templates to evaluate
+ * @returns Updated version of the templates
+ * @private
+ */
+export declare function _postProcessGroupDependencies(templates: IItemTemplate[]): IItemTemplate[];
+/**
+ * Check for feature service items that have been flagged for invalid designations.
+ * Remove templates that have invalid designations from the solution item and other item dependencies.
+ * Clean up any references to items with invalid designations in the other templates.
+ *
+ * @param templates The array of templates to evaluate
+ * @param templateDictionary Hash of key details used for variable replacement
+ * @returns Updated version of the templates
+ * @private
+ */
+export declare function _postProcessIgnoredItems(templates: IItemTemplate[], templateDictionary: any): IItemTemplate[];
+/**
+ * Recursively runs through an object to find and replace any strings found in a dictionary.
+ *
+ * @param templateDictionary Hash of things to be replaced
+ * @param obj Object to be examined
+ * @private
+ */
+export declare function _replaceDictionaryItemsInObject(hash: any, obj: any): any;
+/**
+ * Recursively runs through an object to find and templatize any remaining references to solution's items.
+ *
+ * @param ids Ids to be replaced in strings found in object
+ * @param obj Object to be examined
+ * @private
+ */
+export declare function _replaceRemainingIdsInObject(ids: string[], obj: any): any;
+/**
+ * Templatizes ids from a list in a string if they're not already templatized.
+ *
+ * @param ids Ids to be replaced in source string
+ * @param str Source string to be examined
+ * @returns A copy of the source string with any templatization changes
+ * @private
+ */
+export declare function _replaceRemainingIdsInString(ids: string[], str: string): string;
+/**
+ * Finds and templatizes any URLs in solution items' descriptions.
+ *
+ * @param templates The array of templates to evaluate, modified in place
+ * @private
+ */
+export declare function _simplifyUrlsInItemDescriptions(templates: IItemTemplate[]): void;
+/**
+ * Templatizes occurrences of the URL to the user's organization in the `item` and `data` template sections.
+ *
+ * @param templates The array of templates to evaluate; templates is modified in place
+ * @param destAuthentication Credentials for request organization info
+ * @returns Promise resolving with `templates`
+ * @private
+ */
+export declare function _templatizeOrgUrl(templates: IItemTemplate[], destAuthentication: UserSession): Promise<IItemTemplate[]>;
+/**
+ * Finds and templatizes any references to solution's items.
+ *
+ * @param templates The array of templates to evaluate, modified in place
+ * @private
+ */
+export declare function _templatizeSolutionIds(templates: IItemTemplate[]): void;