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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/solution-velocity",
-  "version": "6.0.5-alpha.0",
+  "version": "6.1.0-alpha.0",
   "description": "Manages the creation and deployment of Velocity item types for @esri/solution.js.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -22,7 +22,7 @@
     "npm-check-updates": "^17.1.0"
   },
   "dependencies": {
-    "@esri/solution-common": "^6.0.5-alpha.0",
+    "@esri/solution-common": "^6.1.0-alpha.0",
     "tslib": "1.14.1"
   },
   "scripts": {
@@ -69,5 +69,5 @@
     "esri",
     "ES6"
   ],
-  "gitHead": "fbecb9f8977e44ba6254f9b68b43292b3ab525ae"
+  "gitHead": "19cbc20f4da03baa4676b3fad82abcea533432c3"
 }

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

@@ -1,57 +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, UserSession } from "@esri/solution-common";
-/**
- * Get the dependencies from the velocity data sources, feeds, and outputs.
- * Only dependencies that do NOT have the typeKeyword "IoTFeatureLayer" are returned.
- *
- * @param template The template that for the velocity item
- * @param authentication The credentials for any requests
- *
- * @returns a list of dependency ids
- */
-export declare function getVelocityDependencies(template: IItemTemplate, authentication: UserSession): Promise<string[]>;
-/**
- * Any feature services with the typeKeyword "IoTFeatureLayer" should not be templatized or
- * listed as a dependency.
- * We can’t create Velocity feature layers in their spatiotemporal datastore as we have no api.
- *
- * @param dependencies Any dependencies that have been found for this item
- * @param authentication The credentials for any requests
- *
- * @returns a list of dependency ids
- * @private
- */
-export declare function _validateDependencies(dependencies: string[], authentication: UserSession): Promise<string[]>;
-/**
- * Get the dependencies from the velocity feeds
- * This function will update the input dependencies argument
- *
- * @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;
-/**
- * Get the dependencies from the velocity outputs or dataSources.
- * This function will update the input dependencies argument
- *
- * @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/cjs/helpers/get-velocity-dependencies.js

@@ -1,120 +0,0 @@
-"use strict";
-/** @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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports._getDependencies = exports._getFeedDependencies = exports._validateDependencies = exports.getVelocityDependencies = void 0;
-const solution_common_1 = require("@esri/solution-common");
-/**
- * Get the dependencies from the velocity data sources, feeds, and outputs.
- * Only dependencies that do NOT have the typeKeyword "IoTFeatureLayer" are returned.
- *
- * @param template The template that for the velocity item
- * @param authentication The credentials for any requests
- *
- * @returns a list of dependency ids
- */
-function getVelocityDependencies(template, authentication) {
-    const dependencies = [];
-    [
-        (0, solution_common_1.getProp)(template, "data.feeds") ? template.data.feeds : [],
-        (0, solution_common_1.getProp)(template, "data.feed") ? [template.data.feed] : [],
-    ].forEach((f) => _getFeedDependencies(f, dependencies));
-    [
-        (0, solution_common_1.getProp)(template, "data.sources") ? template.data.sources : [],
-        (0, solution_common_1.getProp)(template, "data.source") ? [template.data.source] : [],
-        (0, solution_common_1.getProp)(template, "data.outputs") ? template.data.outputs : [],
-        (0, solution_common_1.getProp)(template, "data.output") ? [template.data.output] : [],
-    ].forEach((d) => _getDependencies(d, dependencies));
-    return _validateDependencies(dependencies, authentication);
-}
-exports.getVelocityDependencies = getVelocityDependencies;
-/**
- * Any feature services with the typeKeyword "IoTFeatureLayer" should not be templatized or
- * listed as a dependency.
- * We can’t create Velocity feature layers in their spatiotemporal datastore as we have no api.
- *
- * @param dependencies Any dependencies that have been found for this item
- * @param authentication The credentials for any requests
- *
- * @returns a list of dependency ids
- * @private
- */
-function _validateDependencies(dependencies, authentication) {
-    const defs = dependencies.map((d) => {
-        return (0, solution_common_1.getItemBase)(d, authentication);
-    });
-    return Promise.all(defs).then((itemInfos) => {
-        return Promise.resolve(itemInfos.reduce((prev, cur) => {
-            if (cur.typeKeywords.indexOf("IoTFeatureLayer") < 0) {
-                prev.push(cur.id);
-            }
-            return prev;
-        }, []));
-    });
-}
-exports._validateDependencies = _validateDependencies;
-/**
- * Get the dependencies from the velocity feeds
- * This function will update the input dependencies argument
- *
- * @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) => {
-        const id = cur.id || undefined;
-        /* istanbul ignore else */
-        if (id && prev.indexOf(id) < 0) {
-            prev.push(id);
-        }
-        return prev;
-    }, dependencies);
-    // run through standard dependency check as well
-    // in some cases the feed does not have the id property but will have
-    // a portalItemId value in the properties
-    _getDependencies(feeds, dependencies);
-}
-exports._getFeedDependencies = _getFeedDependencies;
-/**
- * Get the dependencies from the velocity outputs or dataSources.
- * This function will update the input dependencies argument
- *
- * @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) => {
-        const names = (0, solution_common_1.getProp)(cur, "name") ? [cur.name] : solution_common_1.BASE_NAMES;
-        names.forEach((n) => {
-            solution_common_1.PROP_NAMES.forEach((p) => {
-                // skip map service and stream service ids
-                /* istanbul ignore else */
-                if (p.indexOf("mapServicePortalItemID") < 0 && p.indexOf("streamServicePortalItemID") < 0) {
-                    const id = cur.properties ? cur.properties[n + p] : undefined;
-                    if (id && prev.indexOf(id) < 0) {
-                        prev.push(id);
-                    }
-                }
-            });
-        });
-        return prev;
-    }, dependencies);
-}
-exports._getDependencies = _getDependencies;
-//# sourceMappingURL=get-velocity-dependencies.js.map

package/dist/cjs/helpers/get-velocity-dependencies.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-velocity-dependencies.js","sourceRoot":"","sources":["../../../src/helpers/get-velocity-dependencies.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,2DAAiH;AAEjH;;;;;;;;GAQG;AACH,SAAgB,uBAAuB,CAAC,QAAuB,EAAE,cAA2B;IAC1F,MAAM,YAAY,GAAa,EAAE,CAAC;IAElC;QACE,IAAA,yBAAO,EAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;QAC1D,IAAA,yBAAO,EAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;KAC3D,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,oBAAoB,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;IAExD;QACE,IAAA,yBAAO,EAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;QAC9D,IAAA,yBAAO,EAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE;QAC9D,IAAA,yBAAO,EAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;QAC9D,IAAA,yBAAO,EAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE;KAC/D,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;IAEpD,OAAO,qBAAqB,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;AAC7D,CAAC;AAhBD,0DAgBC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,qBAAqB,CAAC,YAAsB,EAAE,cAA2B;IACvF,MAAM,IAAI,GAAwB,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACvD,OAAO,IAAA,6BAAW,EAAC,CAAC,EAAE,cAAc,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IACH,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;QAC1C,OAAO,OAAO,CAAC,OAAO,CACpB,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YAC7B,IAAI,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE;gBACnD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;aACnB;YACD,OAAO,IAAI,CAAC;QACd,CAAC,EAAE,EAAE,CAAC,CACP,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAdD,sDAcC;AAED;;;;;;;GAOG;AACH,SAAgB,oBAAoB,CAAC,KAAY,EAAE,YAAsB;IACvE,KAAK,CAAC,MAAM,CAAC,CAAC,IAAS,EAAE,GAAQ,EAAE,EAAE;QACnC,MAAM,EAAE,GAAW,GAAG,CAAC,EAAE,IAAI,SAAS,CAAC;QACvC,0BAA0B;QAC1B,IAAI,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE;YAC9B,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACf;QACD,OAAO,IAAI,CAAC;IACd,CAAC,EAAE,YAAY,CAAC,CAAC;IACjB,gDAAgD;IAChD,qEAAqE;IACrE,yCAAyC;IACzC,gBAAgB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;AACxC,CAAC;AAbD,oDAaC;AAED;;;;;;;;GAQG;AACH,SAAgB,gBAAgB,CAAC,OAAc,EAAE,YAAsB;IACrE,OAAO,CAAC,MAAM,CAAC,CAAC,IAAS,EAAE,GAAQ,EAAE,EAAE;QACrC,MAAM,KAAK,GAAa,IAAA,yBAAO,EAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,4BAAU,CAAC;QACvE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YAClB,4BAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;gBACvB,0CAA0C;gBAC1C,0BAA0B;gBAC1B,IAAI,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,2BAA2B,CAAC,GAAG,CAAC,EAAE;oBACzF,MAAM,EAAE,GAAW,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;oBACtE,IAAI,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE;wBAC9B,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;qBACf;iBACF;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC,EAAE,YAAY,CAAC,CAAC;AACnB,CAAC;AAjBD,4CAiBC"}

package/dist/cjs/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;