@esri/solution-velocity 6.0.5-alpha.0 → 6.1.0-alpha.0

package/dist/esm/helpers/velocity-helpers.d.ts

@@ -1,244 +0,0 @@
-/** @license
- * Copyright 2021 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 { IItemTemplate, IVelocityTitle, UserSession } from "@esri/solution-common";
-/**
- * Common function to build urls for reading and interacting with the velocity api
- *
- *
- * @param authentication Credentials for the requests
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
- * @param type The type of velocity item we are constructing a url for
- * @param id Optional The id of the velocity item we are constructing a url for
- * @param isDeploy Optional Is this being constructed as a part of deployment
- * @param urlPrefix Optional prefix args necessary for some url construction
- * @param urlSuffix Optional suffix args necessary for some url construction
- *
- * @returns a promise that will resolve the constructed url
- *
- */
-export declare function getVelocityUrl(authentication: UserSession, templateDictionary: any, type: string, id?: string, isDeploy?: boolean, urlPrefix?: string, urlSuffix?: string): Promise<string>;
-/**
- * Handles the creation of velocity items.
- *
- * @param authentication Credentials for the requests
- * @param template The current itemTemplate that is being used for deployment
- * @param data The velocity item data used to create the items.
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
- * @param autoStart This can be leveraged to start certain velocity items after they are created.
- *
- * @returns a promise that will resolve an object containing the item, id, type, and post process flag
- *
- */
-export declare function postVelocityData(authentication: UserSession, template: IItemTemplate, data: any, templateDictionary: any, autoStart?: boolean): Promise<any>;
-/**
- * Velocity item titles must be unique across the organization.
- * Check and ensure we set a unique title
- *
- * @param authentication Credentials for the requests
- * @param label The current label of the item from the solution template
- * @param url The base velocity url for checking status
- *
- * @returns a promise that will resolve a unique title
- *
- */
-export declare function getTitle(authentication: UserSession, label: string, url: string): Promise<IVelocityTitle>;
-/**
- * Validate the data that will be used and handle any reported issues with the outputs.
- * The output names must be unique across the organization.
- *
- * This function will update the data arg that is passed in with a unique name.
- *
- * @param authentication Credentials for the requests
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
- * @param type The type of velocity item
- * @param data The data used to construct the velocity item
- * @param titles The list of know titles that exist in the org
- * @param dataOutputs The velocity items output objects
- * @param feeds The velocity items feed objects
- *
- * @returns a promise that will resolve the data object passed in with any necessary changes.
- *
- * @private
- */
-export declare function _validateOutputs(authentication: UserSession, templateDictionary: any, type: string, data: any, titles: any[], dataOutputs?: any[], feeds?: any[]): Promise<any>;
-/**
- * Check the validate results for any name conflicts and store the conflicting names.
- *
- * @param validateResults The results object to check for name conflict errors
- *
- * @returns a list of names that already exist in the org
- *
- * @private
- */
-export declare function _validateMessages(validateResults: any): string[];
-/**
- * Updates the feed object with a new name when validation fails.
- *
- * @param feeds The feed objects from the velocity item.
- * @param data The full data object used for deploying the velocity item.
- * @param names The names that failed due to duplicate error in validation.
- *
- * @private
- */
-export declare function _updateFeed(feeds: any[], data: any, names: string[]): void;
-/**
- * Updates the data object with a new name when validation fails.
- *
- * @param dataOutputs The data output objects from the velocity item.
- * @param data The full data object used for deploying the velocity item.
- * @param names The names that failed due to duplicate error in validation.
- *
- * @private
- */
-export declare function _updateDataOutput(dataOutputs: any[], data: any, names: string[]): void;
-/**
- * Get a unique label for the item.
- *
- * @param names The names that failed due to duplicate error in validation.
- * @param dataOutput The current data output that is being evaluated.
- *
- * @returns an object with a unique label and the outputs id when a name
- * conflict is found...otherwise returns undefined
- *
- * @private
- */
-export declare function _getOutputLabel(names: any[], dataOutput: any): any;
-/**
- * Will return the provided title if it does not exist as a property
- * in one of the objects at the defined path. Otherwise the title will
- * have a numerical value attached.
- *
- * This is based on "getUniqueTitle" from common but adds the "_" replacement check for velocity names.
- * Could switch to using common if Velocity has a way to get a list of all names that are already used.
- *
- * @param title The root title to test
- * @param templateDictionary Hash of the facts
- * @param path to the objects to evaluate for potantial name clashes
- *
- * @returns string The unique title to use
- *
- */
-export declare function getUniqueTitle(title: string, templateDictionary: any, path: string): string;
-/**
- * Start the item if validation passes and the item is executable.
- *
- * @param authentication Credentials for the requests
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
- * @param template the item template that has the details for deployment
- * @param id the new id for the velocity item that was deployed
- *
- * @returns a promise that will resolve with the validation results
- * or the start results when validation indicates the item is executable
- *
- * @private
- */
-export declare function _validateAndStart(authentication: UserSession, templateDictionary: any, template: IItemTemplate, id: string): Promise<any>;
-/**
- * Validate the velocity item.
- * Used to help find and handle duplicate name errors.
- *
- * @param authentication Credentials for the requests
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
- * @param type The type of velocity item we are constructing a url for
- * @param id? Optional The id of the velocity item we are constructing a url for
- * @param body? Optional the request body to validate.
- *
- * @returns a promise that will resolve with an object containing messages
- * indicating any issues found when validating such as name conflict errors
- *
- */
-export declare function validate(authentication: UserSession, templateDictionary: any, type: string, id?: string, body?: any): Promise<any>;
-/**
- * Start the given velocity item that has been deployed.
- *
- * @param authentication Credentials for the requests
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
- * @param type The type of velocity item we are constructing a url for
- * @param id? Optional The id of the velocity item we are constructing a url for
- *
- * @returns a promise that will resolve with the result of the start call
- *
- */
-export declare function start(authentication: UserSession, templateDictionary: any, type: string, id?: string): Promise<any>;
-/**
- * Gets the required request options for requests to the velocity API.
- *
- * @param authentication Credentials for the requests
- * @param method Indicate if "GET" or "POST"
- *
- * @returns generic request options used for various calls to velocity api
- *
- * @private
- */
-export declare function _getRequestOpts(authentication: UserSession, method: string): RequestInit;
-/**
- * Generic fetch function for making calls to the velocity API.
- *
- * @param authentication Credentials for the requests
- * @param url The url from the velocity API to handle reading and writing
- * @param method The method for the request "GET" or "POST"
- * @param body The body for POST requests
- *
- * @returns a promise that will resolve with the result of the fetch call
- *
- * @private
- */
-export declare function _fetch(authentication: UserSession, url: string, method: string, // GET or POST
-body?: any): Promise<any>;
-/**
- * Remove key properties if the dependency was removed due to having the "IoTFeatureLayer" typeKeyword
- * This function will update the input template.
- *
- * @param template The template that for the velocity item
- *
- */
-export declare function cleanDataSourcesAndFeeds(template: IItemTemplate, velocityUrl: string): void;
-/**
- * Remove key properties from the input source or feed
- *
- * @param sourcesOrFeeds The list of dataSources or feeds
- * @param dependencies The list of dependencies
- *
- * @private
- */
-export declare function _removeIdProps(sourcesOrFeeds: any[], dependencies: string[], velocityUrl: string): void;
-/**
- * Remove key properties from the outputs.
- *
- * @param outputs The list of outputs
- * @param dependencies The list of dependencies
- *
- * @private
- */
-export declare function _removeIdPropsAndSetName(outputs: any[], dependencies: string[]): void;
-/**
- * Generic helper function to remove key properties .
- *
- * @param props the list of props to update
- * @param prop the individual prop to remove
- * @param dependencies The list of dependencies
- *
- * @private
- */
-export declare function _removeProp(props: any, prop: string, dependencies: string[]): void;
-/**
- * Update the feature layer name to include the solution item id.
- *
- * @param props the list of props to update
- *
- * @private
- */
-export declare function _updateName(props: any): void;