@esri/solution-deployer 6.0.2-alpha.24 → 6.0.2-alpha.250423

package/dist/cjs/deploySolutionItems.d.ts

@@ -1,224 +0,0 @@
-/** @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 deployment of items via the REST API.
- *
- * @module deployItems
- */
-import * as common from "@esri/solution-common";
-/**
- * Deploys a set of items defined by templates.
- *
- * @param portalSharingUrl Server/sharing
- * @param storageItemId Id of storage item
- * @param templates A collection of AGO item templates
- * @param storageAuthentication Credentials for the organization with the source items
- * @param templateDictionary Hash of facts: org URL, adlib replacements
- * @param deployedSolutionId Id of deployed Solution item
- * @param destinationAuthentication Credentials for the destination organization
- * @param options Options to tune deployment
- * @returns A promise that will resolve with the list of information about the created items
- */
-export declare function deploySolutionItems(portalSharingUrl: string, storageItemId: string, templates: common.IItemTemplate[], storageAuthentication: common.UserSession, templateDictionary: any, deployedSolutionId: string, destinationAuthentication: common.UserSession, options: common.IDeploySolutionOptions): Promise<common.ICreateItemFromTemplateResponse[]>;
-/**
- * For each item to be patched, convert it to its cloned id and mark the item as needing post processing.
- *
- * @param itemsToBePatched List of items that need to have their dependencies patched
- * @param templateDictionary Hash of facts: org URL, adlib replacements
- * @param templates A collection of AGO item templates
- * @private
- */
-export declare function _flagPatchItemsForPostProcessing(itemsToBePatched: common.IKeyedListsOfStrings, templateDictionary: any, templates: common.ICreateItemFromTemplateResponse[]): void;
-/**
- * Portal does not allow views of a single source to be created at the same time.
- *
- * Update view templates with an array of other view template ids that it should wait on.
- *
- * @param templates a collection of AGO item templates
- *
- * @returns An updated array of item templates
- * @private
- */
-export declare function _evaluateSharedViewSources(templates: common.IItemTemplate[]): common.IItemTemplate[];
-/**
- * Add a syncViews array to each template that will hold all other view ids that
- * have the same FS dependency.
- * These arrays will be processed later to only contain ids that each view will need to wait on.
- *
- * @param templates a collection of AGO item templates
- * @param views an array of view template details
- *
- * @returns An updated array of item templates
- * @private
- */
-export declare function _updateViewTemplates(templates: common.IItemTemplate[], views: any[]): common.IItemTemplate[];
-/**
- * Get all view templates from the source templates collection
- *
- * @param views A collection of view ID and dependencies
- *
- * @returns an array of objects with the source FS id as the key and a list of views that are
- * dependant upon it
- *
- * @private
- */
-export declare function _getViewHash(views: any[]): any;
-/**
- * Get all view templates from the source templates collection
- *
- * @param templates A collection of AGO item templates
- *
- * @returns an array with the view id and its dependencies
- *
- * @private
- */
-export declare function _getViews(templates: common.IItemTemplate[]): any[];
-/**
- * Search for existing items and update the templateDictionary with key details
- *
- * @param templates A collection of AGO item templates
- * @param reuseItems Option to search for existing items
- * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
- * @param authentication Credentials for the requests
- *
- * @returns A Promise that will resolve once existing items have been evaluated
- *
- * @private
- */
-export declare function _reuseDeployedItems(templates: common.IItemTemplate[], reuseItems: boolean, templateDictionary: any, authentication: common.UserSession): Promise<any>;
-/**
- * Search for existing items and update the templateDictionary with key details
- *
- * Subtle difference between _reuseDeployedItems and _useExistingItems
- * _reuseDeployedItems: will search all existing items based on specific type keywords
- *   that would have been added by a previous deployment
- * _useExistingItems: will search for an existing item that the user provided
- *   the item id for while configuring in the deployment app.
- *   This type of item would not necessarily have been laid down by a previous deployment and
- *   can thus not expect that it will have the type keywords
- *
- * @param templates A collection of AGO item templates
- * @param useExisting Option to search for existing items
- * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
- * @param authentication Credentials for the requests
- *
- * @returns A Promise that will resolve once existing items have been evaluated
- *
- * @private
- */
-export declare function _useExistingItems(templates: common.IItemTemplate[], useExisting: boolean, templateDictionary: any, authentication: common.UserSession): Promise<any>;
-/**
- * Verify if the existing item has the source-<itemId> typeKeyword and set it if not
- * This allows items that did not come from deployment to be found for reuse after they
- * have been used once via a custom itemId param
- *
- * @param itemDefs
- * @param sourceIdHash key value pairs..actual itemId is the key and the source itemId is the value
- * @param authentication credentials for the requests
- *
- * @returns a promise to indicate when the requests are complete
- * @private
- */
-export declare function _setTypekeywordForExisting(itemDefs: Array<Promise<any>>, sourceIdHash: any, authentication: common.UserSession): Promise<any>;
-/**
- * Update the templateDictionary with key details by item type
- *
- * @param templates A collection of AGO item templates
- * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
- *
- * @private
- */
-export declare function _updateTemplateDictionary(templates: common.IItemTemplate[], templateDictionary: any, authentication: common.UserSession): Promise<any>;
-/**
- * Add the fields from the source layer to the template dictionary for any required replacements
- *
- * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
- * @param itemId the id for the item
- * @param layerId the id for the layer
- * @param fields the fields to transfer
- *
- * @private
- */
-export declare function _setFields(templateDictionary: any, itemId: string, layerId: string, fields: any[]): void;
-/**
- * In some cases an item id search will return a stale item reference
- * it will subsequently fail when we try to fetch the underlying service.
- *
- * We need to remove the item info that has been added to the template dictionary
- * and treat the item as we do other items that don't already exist on deployment.
- *
- * @param result the service request result
- * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
- *
- * @private
- */
-export declare function _updateTemplateDictionaryForError(templateDictionary: any, itemId: string): any;
-/**
- * Optionally search by tags and then update the templateDictionary based on the search results
- *
- * @param existingItemsResponse response object from search by typeKeyword and type
- * @param existingItemIds list of the template ids we have queried
- * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
- * @param authentication Credentials for the request
- * @param addTagQuery Boolean to indicate if a search by tag should happen
- * @returns IFindExistingItemsResponse object with  promise that will resolve with an array of results
- * and an array of item ids
- * @private
- */
-export declare function _handleExistingItems(existingItemsResponse: any[], existingItemInfos: common.IFindExistingItemInfos[], templateDictionary: any, authentication: common.UserSession, addTagQuery: boolean): common.IFindExistingItemsResponse;
-export declare function _updateTemplateDictionaryById(templateDictionary: any, sourceId: string, itemId: string, v: any): void;
-/**
- * Search items based on user query
- *
- * @param templates Templates to examine
- * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
- * @param authentication Credentials for the request
- * @returns IFindExistingItemsResponse object with  promise that will resolve with an array of results
- * and an array of item ids
- * @private
- */
-export declare function _findExistingItemByKeyword(templates: common.IItemTemplate[], templateDictionary: any, authentication: common.UserSession): common.IFindExistingItemsResponse;
-/**
- * Search items based on user query
- *
- * @param query Query string to use
- * @param authentication Credentials for the request
- * @returns A promise that will resolve with an array of results
- * @private
- */
-export declare function _findExistingItem(query: string, authentication: common.UserSession): Promise<any>;
-/**
- * Creates an item from a template once the item's dependencies have been created.
- *
- * @param template Template of item to deploy
- * @param resourceFilePaths URL, folder, and filename for each item resource/metadata/thumbnail
- * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
- * @param userSession Options for the request
- * @param itemProgressCallback Function for reporting progress updates from type-specific template handlers
- * @returns A promise that will resolve with the id of the deployed item (which is simply returned if it's
- *         already in the templates list
- * @private
- */
-export declare function _createItemFromTemplateWhenReady(template: common.IItemTemplate, resourceFilePaths: common.IDeployFileCopyPath[], storageAuthentication: common.UserSession, templateDictionary: any, destinationAuthentication: common.UserSession, itemProgressCallback: common.IItemProgressCallback): Promise<common.ICreateItemFromTemplateResponse>;
-/**
- * Accumulates the estimated deployment cost of a set of templates.
- *
- * @param templates Templates to examine
- * @returns Sum of estimated deployment costs
- * @private
- */
-export declare function _estimateDeploymentCost(templates: common.IItemTemplate[]): number;
-export declare function _getGroupUpdates(template: common.IItemTemplate, authentication: common.UserSession, templateDictionary: any): Array<Promise<any>>;