@esri/solution-velocity 1.3.10 → 1.3.13

package/dist/umd/helpers/get-velocity-dependencies.d.ts

@@ -21,7 +21,7 @@ import { IItemTemplate, UserSession } from "@esri/solution-common";
  * @param template The template that for the velocity item
  * @param authentication The credentials for any requests
  *
- * @return a list of dependency ids
+ * @returns a list of dependency ids
  */
 export declare function getVelocityDependencies(template: IItemTemplate, authentication: UserSession): Promise<string[]>;
 /**
@@ -32,7 +32,8 @@ export declare function getVelocityDependencies(template: IItemTemplate, authent
  * @param dependencies Any dependencies that have been found for this item
  * @param authentication The credentials for any requests
  *
- * @return a list of dependency ids
+ * @returns a list of dependency ids
+ * @private
  */
 export declare function _validateDependencies(dependencies: string[], authentication: UserSession): Promise<string[]>;
 /**
@@ -41,6 +42,7 @@ export declare function _validateDependencies(dependencies: string[], authentica
  *
  * @param feeds The list of feeds from the velocity template
  * @param dependencies The current list of dependencies
+ * @private
  */
 export declare function _getFeedDependencies(feeds: any[], dependencies: string[]): void;
 /**
@@ -50,5 +52,6 @@ export declare function _getFeedDependencies(feeds: any[], dependencies: string[
  * @param outputs The list of outputs from the velocity item
  * @param dependencies The current list of dependencies
  * @param prop The individual prop to evaluate
+ * @private
  */
 export declare function _getDependencies(outputs: any[], dependencies: string[]): void;

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

@@ -26,7 +26,7 @@ import { IItemTemplate, IVelocityTitle, UserSession } from "@esri/solution-commo
  * @param urlPrefix Optional prefix args necessary for some url construction
  * @param urlSuffix Optional suffix args necessary for some url construction
  *
- * @return a promise that will resolve the constructed url
+ * @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>;
@@ -39,7 +39,7 @@ export declare function getVelocityUrl(authentication: UserSession, templateDict
  * @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.
  *
- * @return a promise that will resolve an object containing the item, id, type, and post process flag
+ * @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>;
@@ -51,7 +51,7 @@ export declare function postVelocityData(authentication: UserSession, template:
  * @param label The current label of the item from the solution template
  * @param url The base velocity url for checking status
  *
- * @return a promise that will resolve a unique title
+ * @returns a promise that will resolve a unique title
  *
  */
 export declare function getTitle(authentication: UserSession, label: string, url: string): Promise<IVelocityTitle>;
@@ -69,8 +69,9 @@ export declare function getTitle(authentication: UserSession, label: string, url
  * @param dataOutputs The velocity items output objects
  * @param feeds The velocity items feed objects
  *
- * @return a promise that will resolve the data object passed in with any necessary changes.
+ * @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>;
 /**
@@ -78,8 +79,9 @@ export declare function _validateOutputs(authentication: UserSession, templateDi
  *
  * @param validateResults The results object to check for name conflict errors
  *
- * @return a list of names that already exist in the org
+ * @returns a list of names that already exist in the org
  *
+ * @private
  */
 export declare function _validateMessages(validateResults: any): string[];
 /**
@@ -89,6 +91,7 @@ export declare function _validateMessages(validateResults: any): string[];
  * @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;
 /**
@@ -98,7 +101,7 @@ export declare function _updateFeed(feeds: any[], data: any, names: string[]): v
  * @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;
 /**
@@ -107,9 +110,10 @@ export declare function _updateDataOutput(dataOutputs: any[], data: any, names:
  * @param names The names that failed due to duplicate error in validation.
  * @param dataOutput The current data output that is being evaluated.
  *
- * @return an object with a unique label and the outputs id when a name
+ * @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;
 /**
@@ -124,7 +128,7 @@ export declare function _getOutputLabel(names: any[], dataOutput: any): any;
  * @param templateDictionary Hash of the facts
  * @param path to the objects to evaluate for potantial name clashes
  *
- * @return string The unique title to use
+ * @returns string The unique title to use
  *
  */
 export declare function getUniqueTitle(title: string, templateDictionary: any, path: string): string;
@@ -136,9 +140,10 @@ export declare function getUniqueTitle(title: string, templateDictionary: any, p
  * @param template the item template that has the details for deployment
  * @param id the new id for the velocity item that was deployed
  *
- * @return a promise that will resolve with the validation results
+ * @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>;
 /**
@@ -151,7 +156,7 @@ export declare function _validateAndStart(authentication: UserSession, templateD
  * @param id? Optional The id of the velocity item we are constructing a url for
  * @param body? Optional the request body to validate.
  *
- * @return a promise that will resolve with an object containing messages
+ * @returns a promise that will resolve with an object containing messages
  * indicating any issues found when validating such as name conflict errors
  *
  */
@@ -164,7 +169,7 @@ export declare function validate(authentication: UserSession, templateDictionary
  * @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
  *
- * @return a promise that will resolve with the result of the start call
+ * @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>;
@@ -174,8 +179,9 @@ export declare function start(authentication: UserSession, templateDictionary: a
  * @param authentication Credentials for the requests
  * @param method Indicate if "GET" or "POST"
  *
- * @return generic request options used for various calls to velocity api
+ * @returns generic request options used for various calls to velocity api
  *
+ * @private
  */
 export declare function _getRequestOpts(authentication: UserSession, method: string): RequestInit;
 /**
@@ -186,8 +192,9 @@ export declare function _getRequestOpts(authentication: UserSession, method: str
  * @param method The method for the request "GET" or "POST"
  * @param body The body for POST requests
  *
- * @return a promise that will resolve with the result of the fetch call
+ * @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>;
@@ -205,6 +212,7 @@ export declare function cleanDataSourcesAndFeeds(template: IItemTemplate, veloci
  * @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;
 /**
@@ -213,6 +221,7 @@ export declare function _removeIdProps(sourcesOrFeeds: any[], dependencies: stri
  * @param outputs The list of outputs
  * @param dependencies The list of dependencies
  *
+ * @private
  */
 export declare function _removeIdPropsAndSetName(outputs: any[], dependencies: string[]): void;
 /**
@@ -222,6 +231,7 @@ export declare function _removeIdPropsAndSetName(outputs: any[], dependencies: s
  * @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;
 /**
@@ -229,5 +239,6 @@ export declare function _removeProp(props: any, prop: string, dependencies: stri
  *
  * @param props the list of props to update
  *
+ * @private
  */
 export declare function _updateName(props: any): void;

package/dist/umd/helpers/velocity-templatize.d.ts

@@ -20,7 +20,7 @@ import { IItemTemplate } from "@esri/solution-common";
  *
  * @param template velocity item info that should be templatized
  *
- * @return void
+ * @returns void
  *
  */
 export declare function templatizeVelocity(template: IItemTemplate): void;
@@ -32,8 +32,9 @@ export declare function templatizeVelocity(template: IItemTemplate): void;
  * @param prop the prop path to evaluate and set with a templatized variable
  * @param fn the templatize function that should be called for this prop
  *
- * @return void
+ * @returns void
  *
+ * @private
  */
 export declare function _templatize(template: IItemTemplate, prop: string, fn: (arg: any) => void): void;
 /**
@@ -42,8 +43,9 @@ export declare function _templatize(template: IItemTemplate, prop: string, fn: (
  *
  * @param feeds array of velocity feeds that should be templatized
  *
- * @return The updated list of feed objects with templatized id and label
+ * @returns The updated list of feed objects with templatized id and label
  *
+ * @private
  */
 export declare function _templatizeFeeds(feeds: any[]): any;
 /**
@@ -51,8 +53,9 @@ export declare function _templatizeFeeds(feeds: any[]): any;
  *
  * @param feed the feed object from the item
  *
- * @return the updated feed object with templatized portalItemId and layer id
+ * @returns the updated feed object with templatized portalItemId and layer id
  *
+ * @private
  */
 export declare function _templatizeFeed(feed: any): any;
 /**
@@ -61,7 +64,8 @@ export declare function _templatizeFeed(feed: any): any;
  *
  * @param dataSources array of data sources from the item
  *
- * @return the updated dataSources object with templatized ids and labels
+ * @returns the updated dataSources object with templatized ids and labels
  *
+ * @private
  */
 export declare function _templatizeDatasources(dataSources: any[]): any;

package/dist/umd/velocity-processor.d.ts

@@ -28,7 +28,7 @@ import { UserSession, IItemProgressCallback, IItemTemplate, ICreateItemFromTempl
  * @param srcAuthentication Credentials for requests to source items
  * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
  *
- * @return a promise that will resolve the constructed IItemTemplate from the input itemInfo
+ * @returns a promise that will resolve the constructed IItemTemplate from the input itemInfo
  *
  */
 export declare function convertItemToTemplate(solutionItemId: string, itemInfo: any, destAuthentication: UserSession, srcAuthentication: UserSession, templateDictionary: any): Promise<IItemTemplate>;
@@ -40,7 +40,7 @@ export declare function convertItemToTemplate(solutionItemId: string, itemInfo:
  * @param destinationAuthentication Credentials for the deployment requests
  * @param itemProgressCallback Function for reporting progress updates from type-specific template handlers
  *
- * @return a promise that will resolve with the new item info, id, type, and postProcess flag
+ * @returns a promise that will resolve with the new item info, id, type, and postProcess flag
  *
  */
 export declare function createItemFromTemplate(template: IItemTemplate, templateDictionary: any, destinationAuthentication: UserSession, itemProgressCallback: IItemProgressCallback): Promise<ICreateItemFromTemplateResponse>;

package/dist/umd/velocity.umd.js

@@ -1,7 +1,7 @@
 /* @preserve
-* @esri/solution-velocity - v1.3.10 - Apache-2.0
+* @esri/solution-velocity - v1.3.13 - Apache-2.0
 * Copyright (c) 2018-2022 Esri, Inc.
-* Tue Mar 29 2022 11:38:54 GMT-0700 (Pacific Daylight Time)
+* Tue Apr 26 2022 15:05:07 GMT-0700 (Pacific Daylight Time)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -42,7 +42,7 @@
    *
    * @param template velocity item info that should be templatized
    *
-   * @return void
+   * @returns void
    *
    */
   function templatizeVelocity(template) {
@@ -58,8 +58,9 @@
    * @param prop the prop path to evaluate and set with a templatized variable
    * @param fn the templatize function that should be called for this prop
    *
-   * @return void
+   * @returns void
    *
+   * @private
    */
   function _templatize(template, prop, fn) {
       const obj = solutionCommon.getProp(template, prop);
@@ -74,8 +75,9 @@
    *
    * @param feeds array of velocity feeds that should be templatized
    *
-   * @return The updated list of feed objects with templatized id and label
+   * @returns The updated list of feed objects with templatized id and label
    *
+   * @private
    */
   function _templatizeFeeds(feeds) {
       return feeds.map((feed) => {
@@ -89,8 +91,9 @@
    *
    * @param feed the feed object from the item
    *
-   * @return the updated feed object with templatized portalItemId and layer id
+   * @returns the updated feed object with templatized portalItemId and layer id
    *
+   * @private
    */
   function _templatizeFeed(feed) {
       let id = solutionCommon.getProp(feed, "properties.feature-layer.portalItemId");
@@ -115,8 +118,9 @@
    *
    * @param dataSources array of data sources from the item
    *
-   * @return the updated dataSources object with templatized ids and labels
+   * @returns the updated dataSources object with templatized ids and labels
    *
+   * @private
    */
   function _templatizeDatasources(dataSources) {
       return dataSources.map((ds) => _templatizeFeed(ds));
@@ -144,7 +148,7 @@
    * @param template The template that for the velocity item
    * @param authentication The credentials for any requests
    *
-   * @return a list of dependency ids
+   * @returns a list of dependency ids
    */
   function getVelocityDependencies(template, authentication) {
       const dependencies = [];
@@ -168,7 +172,8 @@
    * @param dependencies Any dependencies that have been found for this item
    * @param authentication The credentials for any requests
    *
-   * @return a list of dependency ids
+   * @returns a list of dependency ids
+   * @private
    */
   function _validateDependencies(dependencies, authentication) {
       const defs = dependencies.map(d => {
@@ -189,6 +194,7 @@
    *
    * @param feeds The list of feeds from the velocity template
    * @param dependencies The current list of dependencies
+   * @private
    */
   function _getFeedDependencies(feeds, dependencies) {
       feeds.reduce((prev, cur) => {
@@ -211,6 +217,7 @@
    * @param outputs The list of outputs from the velocity item
    * @param dependencies The current list of dependencies
    * @param prop The individual prop to evaluate
+   * @private
    */
   function _getDependencies(outputs, dependencies) {
       outputs.reduce((prev, cur) => {
@@ -258,7 +265,7 @@
    * @param urlPrefix Optional prefix args necessary for some url construction
    * @param urlSuffix Optional suffix args necessary for some url construction
    *
-   * @return a promise that will resolve the constructed url
+   * @returns a promise that will resolve the constructed url
    *
    */
   function getVelocityUrl(authentication, templateDictionary, type, id = "", isDeploy = false, urlPrefix = "", urlSuffix = "") {
@@ -291,7 +298,7 @@
    * @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.
    *
-   * @return a promise that will resolve an object containing the item, id, type, and post process flag
+   * @returns a promise that will resolve an object containing the item, id, type, and post process flag
    *
    */
   function postVelocityData(authentication, template, data, templateDictionary, autoStart = false) {
@@ -353,7 +360,7 @@
    * @param label The current label of the item from the solution template
    * @param url The base velocity url for checking status
    *
-   * @return a promise that will resolve a unique title
+   * @returns a promise that will resolve a unique title
    *
    */
   function getTitle(authentication, label, url) {
@@ -380,8 +387,9 @@
    * @param dataOutputs The velocity items output objects
    * @param feeds The velocity items feed objects
    *
-   * @return a promise that will resolve the data object passed in with any necessary changes.
+   * @returns a promise that will resolve the data object passed in with any necessary changes.
    *
+   * @private
    */
   function _validateOutputs(authentication, templateDictionary, type, data, titles, dataOutputs = [], feeds = []) {
       if (dataOutputs.length > 0 || feeds.length > 0) {
@@ -412,8 +420,9 @@
    *
    * @param validateResults The results object to check for name conflict errors
    *
-   * @return a list of names that already exist in the org
+   * @returns a list of names that already exist in the org
    *
+   * @private
    */
   function _validateMessages(validateResults) {
       let messages = solutionCommon.getProp(validateResults, "validation.messages");
@@ -454,6 +463,7 @@
    * @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
    */
   function _updateFeed(feeds, data, names) {
       feeds.forEach(f => {
@@ -472,7 +482,7 @@
    * @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
    */
   function _updateDataOutput(dataOutputs, data, names) {
       dataOutputs.forEach(dataOutput => {
@@ -510,9 +520,10 @@
    * @param names The names that failed due to duplicate error in validation.
    * @param dataOutput The current data output that is being evaluated.
    *
-   * @return an object with a unique label and the outputs id when a name
+   * @returns an object with a unique label and the outputs id when a name
    * conflict is found...otherwise returns undefined
    *
+   * @private
    */
   function _getOutputLabel(names, dataOutput) {
       const titles = names.map((name) => {
@@ -538,7 +549,7 @@
    * @param templateDictionary Hash of the facts
    * @param path to the objects to evaluate for potantial name clashes
    *
-   * @return string The unique title to use
+   * @returns string The unique title to use
    *
    */
   function getUniqueTitle(title, templateDictionary, path) {
@@ -566,9 +577,10 @@
    * @param template the item template that has the details for deployment
    * @param id the new id for the velocity item that was deployed
    *
-   * @return a promise that will resolve with the validation results
+   * @returns a promise that will resolve with the validation results
    * or the start results when validation indicates the item is executable
    *
+   * @private
    */
   function _validateAndStart(authentication, templateDictionary, template, id) {
       return validate(authentication, templateDictionary, template.type, id).then(validateResult => {
@@ -590,7 +602,7 @@
    * @param id? Optional The id of the velocity item we are constructing a url for
    * @param body? Optional the request body to validate.
    *
-   * @return a promise that will resolve with an object containing messages
+   * @returns a promise that will resolve with an object containing messages
    * indicating any issues found when validating such as name conflict errors
    *
    */
@@ -611,7 +623,7 @@
    * @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
    *
-   * @return a promise that will resolve with the result of the start call
+   * @returns a promise that will resolve with the result of the start call
    *
    */
   function start(authentication, templateDictionary, type, id) {
@@ -629,8 +641,9 @@
    * @param authentication Credentials for the requests
    * @param method Indicate if "GET" or "POST"
    *
-   * @return generic request options used for various calls to velocity api
+   * @returns generic request options used for various calls to velocity api
    *
+   * @private
    */
   function _getRequestOpts(authentication, method) {
       return {
@@ -650,8 +663,9 @@
    * @param method The method for the request "GET" or "POST"
    * @param body The body for POST requests
    *
-   * @return a promise that will resolve with the result of the fetch call
+   * @returns a promise that will resolve with the result of the fetch call
    *
+   * @private
    */
   function _fetch(authentication, url, method, // GET or POST
   body) {
@@ -688,6 +702,7 @@
    * @param sourcesOrFeeds The list of dataSources or feeds
    * @param dependencies The list of dependencies
    *
+   * @private
    */
   function _removeIdProps(sourcesOrFeeds, dependencies, velocityUrl) {
       sourcesOrFeeds.forEach(dataSource => {
@@ -721,6 +736,7 @@
    * @param outputs The list of outputs
    * @param dependencies The list of dependencies
    *
+   * @private
    */
   function _removeIdPropsAndSetName(outputs, dependencies) {
       outputs.forEach(output => {
@@ -741,6 +757,7 @@
    * @param prop the individual prop to remove
    * @param dependencies The list of dependencies
    *
+   * @private
    */
   function _removeProp(props, prop, dependencies) {
       const id = props[prop];
@@ -754,6 +771,7 @@
    *
    * @param props the list of props to update
    *
+   * @private
    */
   function _updateName(props) {
       [
@@ -793,7 +811,7 @@
    * @param srcAuthentication Credentials for requests to source items
    * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
    *
-   * @return a promise that will resolve the constructed IItemTemplate from the input itemInfo
+   * @returns a promise that will resolve the constructed IItemTemplate from the input itemInfo
    *
    */
   function convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication, templateDictionary) {
@@ -828,7 +846,7 @@
    * @param destinationAuthentication Credentials for the deployment requests
    * @param itemProgressCallback Function for reporting progress updates from type-specific template handlers
    *
-   * @return a promise that will resolve with the new item info, id, type, and postProcess flag
+   * @returns a promise that will resolve with the new item info, id, type, and postProcess flag
    *
    */
   function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {