@esri/solution-velocity 3.0.1 → 4.0.0-alpha.0

package/dist/node/helpers/velocity-templatize.js

@@ -1,114 +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._templatizeDatasources = exports._templatizeFeed = exports._templatizeFeeds = exports._templatize = exports.templatizeVelocity = void 0;
-const solution_common_1 = require("@esri/solution-common");
-/**
- * Updates the template by adding variables for key properties that will
- * need to be swapped when deploying
- *
- * @param template velocity item info that should be templatized
- *
- * @returns void
- *
- */
-function templatizeVelocity(template) {
-    _templatize(template, "data.sources", _templatizeDatasources);
-    _templatize(template, "data.feeds", _templatizeFeeds);
-    _templatize(template, "data.feed", _templatizeFeed);
-}
-exports.templatizeVelocity = templatizeVelocity;
-/**
- * Generic wrapper for the templatize functions that
- * will get and set the key properties
- *
- * @param template velocity item info that should be templatized
- * @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
- *
- * @returns void
- *
- * @private
- */
-function _templatize(template, prop, fn) {
-    const obj = (0, solution_common_1.getProp)(template, prop);
-    /* istanbul ignore else */
-    if (obj) {
-        (0, solution_common_1.setProp)(template, prop, fn(obj));
-    }
-}
-exports._templatize = _templatize;
-/**
- * Updates the template by adding variables for the itemId and the label
- * The label controls the name and must be unique for the org.
- *
- * @param feeds array of velocity feeds that should be templatized
- *
- * @returns The updated list of feed objects with templatized id and label
- *
- * @private
- */
-function _templatizeFeeds(feeds) {
-    return feeds.map((feed) => {
-        feed.label = feed.label && feed.id ? `{{${feed.id}.label}}` : feed.label;
-        feed.id = feed.id ? `{{${feed.id}.itemId}}` : feed.id;
-        return feed;
-    });
-}
-exports._templatizeFeeds = _templatizeFeeds;
-/**
- * Updates the portal item id and feature layer id variables for the feed properties.
- *
- * @param feed the feed object from the item
- *
- * @returns the updated feed object with templatized portalItemId and layer id
- *
- * @private
- */
-function _templatizeFeed(feed) {
-    let id = (0, solution_common_1.getProp)(feed, "properties.feature-layer.portalItemId");
-    /* istanbul ignore else */
-    if (feed.properties) {
-        /* istanbul ignore else */
-        if (feed.properties["feature-layer.portalItemId"]) {
-            id = feed.properties["feature-layer.portalItemId"];
-            feed.properties["feature-layer.portalItemId"] = `{{${id}.itemId}}`;
-        }
-        /* istanbul ignore else */
-        if (id && feed.properties.hasOwnProperty("feature-layer.layerId")) {
-            const flId = feed.properties["feature-layer.layerId"];
-            feed.properties["feature-layer.layerId"] = `{{${id}.layer${flId}.layerId}}`;
-        }
-    }
-    return feed;
-}
-exports._templatizeFeed = _templatizeFeed;
-/**
- * Velocity datasources share the same props as feeds so they can leverage
- * the same templatize function
- *
- * @param dataSources array of data sources from the item
- *
- * @returns the updated dataSources object with templatized ids and labels
- *
- * @private
- */
-function _templatizeDatasources(dataSources) {
-    return dataSources.map((ds) => _templatizeFeed(ds));
-}
-exports._templatizeDatasources = _templatizeDatasources;
-//# sourceMappingURL=velocity-templatize.js.map

package/dist/node/helpers/velocity-templatize.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"velocity-templatize.js","sourceRoot":"","sources":["../../../src/helpers/velocity-templatize.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,2DAAwE;AAExE;;;;;;;;GAQG;AACH,SAAgB,kBAAkB,CAAC,QAAuB;IACxD,WAAW,CAAC,QAAQ,EAAE,cAAc,EAAE,sBAAsB,CAAC,CAAC;IAC9D,WAAW,CAAC,QAAQ,EAAE,YAAY,EAAE,gBAAgB,CAAC,CAAC;IACtD,WAAW,CAAC,QAAQ,EAAE,WAAW,EAAE,eAAe,CAAC,CAAC;AACtD,CAAC;AAJD,gDAIC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,WAAW,CACzB,QAAuB,EACvB,IAAY,EACZ,EAAsB;IAEtB,MAAM,GAAG,GAAQ,IAAA,yBAAO,EAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACzC,0BAA0B;IAC1B,IAAI,GAAG,EAAE;QACP,IAAA,yBAAO,EAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;KAClC;AACH,CAAC;AAVD,kCAUC;AAED;;;;;;;;;GASG;AACH,SAAgB,gBAAgB,CAAC,KAAY;IAC3C,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAS,EAAE,EAAE;QAC7B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;QACzE,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAND,4CAMC;AAED;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAAC,IAAS;IACvC,IAAI,EAAE,GAAG,IAAA,yBAAO,EAAC,IAAI,EAAE,uCAAuC,CAAC,CAAC;IAChE,0BAA0B;IAC1B,IAAI,IAAI,CAAC,UAAU,EAAE;QACnB,0BAA0B;QAC1B,IAAI,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC,EAAE;YACjD,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC,CAAC;YACnD,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC;SACpE;QACD,0BAA0B;QAC1B,IAAI,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,uBAAuB,CAAC,EAAE;YACjE,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC;YACtD,IAAI,CAAC,UAAU,CACb,uBAAuB,CACxB,GAAG,KAAK,EAAE,SAAS,IAAI,YAAY,CAAC;SACtC;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAlBD,0CAkBC;AAED;;;;;;;;;GASG;AACH,SAAgB,sBAAsB,CAAC,WAAkB;IACvD,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,EAAO,EAAE,EAAE,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC;AAFD,wDAEC"}

package/dist/node/index.d.ts

@@ -1,17 +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 * as VelocityProcessor from "./velocity-processor";
-export { VelocityProcessor };

package/dist/node/index.js

@@ -1,22 +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.VelocityProcessor = void 0;
-const tslib_1 = require("tslib");
-const VelocityProcessor = tslib_1.__importStar(require("./velocity-processor"));
-exports.VelocityProcessor = VelocityProcessor;
-//# sourceMappingURL=index.js.map

package/dist/node/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AAEH,gFAA0D;AAEjD,8CAAiB"}

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

@@ -1,61 +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.
- */
-/**
- * Manages the creation and deployment of velocity item types.
- *
- * @module velocity
- */
-import { UserSession, IItemProgressCallback, IItemTemplate, ICreateItemFromTemplateResponse } from "@esri/solution-common";
-/**
- * Convert a Velocity item into a Template
- *
- * @param solutionItemId The solution to contain the item
- * @param itemInfo The basic item info
- * @param destAuthentication Credentials for requests to the destination organization
- * @param srcAuthentication Credentials for requests to source items
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
- *
- * @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>;
-/**
- * Create Velocity analytics and feeds from a Template
- *
- * @param template The template for the volocity items
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
- * @param destinationAuthentication Credentials for the deployment requests
- * @param itemProgressCallback Function for reporting progress updates from type-specific template handlers
- *
- * @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>;
-/**
- * Velocity post-processing actions
- *
- * Move all velocity items to the deployment folder.
- *
- * @param {string} itemId The item ID
- * @param {string} type The template type
- * @param {any[]} itemInfos Array of \{id: 'ef3', type: 'Web Map'\} objects
- * @param {IItemTemplate} template The item template
- * @param {IItemTemplate[]} templates The full collection of item templates
- * @param {any} templateDictionary Hash of facts such as the folder id for the deployment
- * @param {UserSession} authentication The destination session info
- * @returns Promise resolving to successfulness of update
- */
-export declare function postProcess(itemId: string, type: string, itemInfos: any[], template: IItemTemplate, templates: IItemTemplate[], templateDictionary: any, authentication: UserSession): Promise<any>;

package/dist/node/velocity-processor.js

@@ -1,136 +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.postProcess = exports.createItemFromTemplate = exports.convertItemToTemplate = void 0;
-/**
- * Manages the creation and deployment of velocity item types.
- *
- * @module velocity
- */
-const solution_common_1 = require("@esri/solution-common");
-const velocity_templatize_1 = require("./helpers/velocity-templatize");
-const get_velocity_dependencies_1 = require("./helpers/get-velocity-dependencies");
-const velocity_helpers_1 = require("./helpers/velocity-helpers");
-const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
-/**
- * Convert a Velocity item into a Template
- *
- * @param solutionItemId The solution to contain the item
- * @param itemInfo The basic item info
- * @param destAuthentication Credentials for requests to the destination organization
- * @param srcAuthentication Credentials for requests to source items
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
- *
- * @returns a promise that will resolve the constructed IItemTemplate from the input itemInfo
- *
- */
-function convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication, templateDictionary) {
-    const template = (0, solution_common_1.createInitializedItemTemplate)(itemInfo);
-    return (0, velocity_helpers_1.getVelocityUrl)(srcAuthentication, templateDictionary, itemInfo.type, itemInfo.id).then((url) => {
-        if (url) {
-            return fetch(url)
-                .then(data => data.json())
-                .then(data_json => {
-                template.item.title = data_json.label;
-                template.data = data_json;
-                return (0, get_velocity_dependencies_1.getVelocityDependencies)(template, srcAuthentication).then(deps => {
-                    template.dependencies = deps;
-                    (0, velocity_helpers_1.cleanDataSourcesAndFeeds)(template, templateDictionary.velocityUrl);
-                    (0, velocity_templatize_1.templatizeVelocity)(template);
-                    template.item = (0, solution_common_1.updateVelocityReferences)(template.item, template.type, templateDictionary);
-                    return Promise.resolve(template);
-                });
-            });
-        }
-        else {
-            // In case the org used to have velocity and they still have items
-            return Promise.reject("Velocity NOT Supported by Organization");
-        }
-    }, e => Promise.reject((0, solution_common_1.fail)(e)));
-}
-exports.convertItemToTemplate = convertItemToTemplate;
-/**
- * Create Velocity analytics and feeds from a Template
- *
- * @param template The template for the volocity items
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
- * @param destinationAuthentication Credentials for the deployment requests
- * @param itemProgressCallback Function for reporting progress updates from type-specific template handlers
- *
- * @returns a promise that will resolve with the new item info, id, type, and postProcess flag
- *
- */
-function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
-    // let the progress system know we've started...
-    const startStatus = itemProgressCallback(template.itemId, solution_common_1.EItemProgressStatus.Started, 0);
-    // and if it returned false, just resolve out
-    /* istanbul ignore else */
-    if (!startStatus) {
-        return Promise.resolve((0, solution_common_1.generateEmptyCreationResponse)(template.type));
-    }
-    const orgId = template.itemId;
-    return (0, velocity_helpers_1.postVelocityData)(destinationAuthentication, template, template.data, templateDictionary).then(result => {
-        const finalStatus = itemProgressCallback(orgId, solution_common_1.EItemProgressStatus.Finished, template.estimatedDeploymentCostFactor || 2, result.id);
-        if (!finalStatus) {
-            return (0, solution_common_1.removeItem)(result.id, destinationAuthentication).then(() => Promise.resolve((0, solution_common_1.generateEmptyCreationResponse)(template.type)), () => Promise.resolve((0, solution_common_1.generateEmptyCreationResponse)(template.type)));
-        }
-        else {
-            const response = {
-                item: {
-                    ...template,
-                    ...result
-                },
-                id: result.item.id,
-                type: template.type,
-                postProcess: true
-            };
-            response.item.itemId = result.item.id;
-            return response;
-        }
-    });
-}
-exports.createItemFromTemplate = createItemFromTemplate;
-/**
- * Velocity post-processing actions
- *
- * Move all velocity items to the deployment folder.
- *
- * @param {string} itemId The item ID
- * @param {string} type The template type
- * @param {any[]} itemInfos Array of \{id: 'ef3', type: 'Web Map'\} objects
- * @param {IItemTemplate} template The item template
- * @param {IItemTemplate[]} templates The full collection of item templates
- * @param {any} templateDictionary Hash of facts such as the folder id for the deployment
- * @param {UserSession} authentication The destination session info
- * @returns Promise resolving to successfulness of update
- */
-function postProcess(itemId, type, itemInfos, template, templates, templateDictionary, authentication) {
-    const itemUpdate = itemInfos.filter(ii => ii.id === itemId);
-    const item = itemUpdate[0].item.item;
-    delete item.url;
-    delete item.origUrl;
-    return (0, solution_common_1.updateItem)(item, authentication).then(() => {
-        return (0, arcgis_rest_portal_1.moveItem)({
-            owner: authentication.username,
-            itemId,
-            folderId: templateDictionary.folderId,
-            authentication
-        });
-    });
-}
-exports.postProcess = postProcess;
-//# sourceMappingURL=velocity-processor.js.map

package/dist/node/velocity-processor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"velocity-processor.js","sourceRoot":"","sources":["../../src/velocity-processor.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;;;GAIG;AAEH,2DAY+B;AAC/B,uEAAmE;AACnE,mFAA8E;AAC9E,iEAIoC;AACpC,iEAEkC;AAElC;;;;;;;;;;;GAWG;AACH,SAAgB,qBAAqB,CACnC,cAAsB,EACtB,QAAa,EACb,kBAA+B,EAC/B,iBAA8B,EAC9B,kBAAuB;IAEvB,MAAM,QAAQ,GAAG,IAAA,+CAA6B,EAAC,QAAQ,CAAC,CAAC;IACzD,OAAO,IAAA,iCAAc,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,QAAQ,CAAC,IAAI,EACb,QAAQ,CAAC,EAAE,CACZ,CAAC,IAAI,CACJ,CAAC,GAAW,EAAE,EAAE;QACd,IAAI,GAAG,EAAE;YACP,OAAO,KAAK,CAAC,GAAG,CAAC;iBACd,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;iBACzB,IAAI,CAAC,SAAS,CAAC,EAAE;gBAChB,QAAQ,CAAC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC;gBACtC,QAAQ,CAAC,IAAI,GAAG,SAAS,CAAC;gBAC1B,OAAO,IAAA,mDAAuB,EAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,IAAI,CAC9D,IAAI,CAAC,EAAE;oBACL,QAAQ,CAAC,YAAY,GAAG,IAAI,CAAC;oBAC7B,IAAA,2CAAwB,EAAC,QAAQ,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;oBACnE,IAAA,wCAAkB,EAAC,QAAQ,CAAC,CAAC;oBAC7B,QAAQ,CAAC,IAAI,GAAG,IAAA,0CAAwB,EAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;oBAC3F,OAAO,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACnC,CAAC,CACF,CAAC;YACJ,CAAC,CAAC,CAAC;SACN;aAAM;YACL,kEAAkE;YAClE,OAAO,OAAO,CAAC,MAAM,CAAC,wCAAwC,CAAC,CAAC;SACjE;IACH,CAAC,EACD,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,sBAAI,EAAC,CAAC,CAAC,CAAC,CAC7B,CAAC;AACJ,CAAC;AAtCD,sDAsCC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,sBAAsB,CACpC,QAAuB,EACvB,kBAAuB,EACvB,yBAAsC,EACtC,oBAA2C;IAE3C,gDAAgD;IAChD,MAAM,WAAW,GAAG,oBAAoB,CACtC,QAAQ,CAAC,MAAM,EACf,qCAAmB,CAAC,OAAO,EAC3B,CAAC,CACF,CAAC;IAEF,6CAA6C;IAC7C,0BAA0B;IAC1B,IAAI,CAAC,WAAW,EAAE;QAChB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAA,+CAA6B,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;KACtE;IAED,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC;IAE9B,OAAO,IAAA,mCAAgB,EACrB,yBAAyB,EACzB,QAAQ,EACR,QAAQ,CAAC,IAAI,EACb,kBAAkB,CACnB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;QACd,MAAM,WAAW,GAAG,oBAAoB,CACtC,KAAK,EACL,qCAAmB,CAAC,QAAQ,EAC5B,QAAQ,CAAC,6BAA6B,IAAI,CAAC,EAC3C,MAAM,CAAC,EAAE,CACV,CAAC;QAEF,IAAI,CAAC,WAAW,EAAE;YAChB,OAAO,IAAA,4BAAU,EAAC,MAAM,CAAC,EAAE,EAAE,yBAAyB,CAAC,CAAC,IAAI,CAC1D,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAA,+CAA6B,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EACnE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAA,+CAA6B,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CACpE,CAAC;SACH;aAAM;YACL,MAAM,QAAQ,GAAoC;gBAChD,IAAI,EAAE;oBACJ,GAAG,QAAQ;oBACX,GAAG,MAAM;iBACV;gBACD,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE;gBAClB,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,WAAW,EAAE,IAAI;aAClB,CAAC;YACF,QAAQ,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACtC,OAAO,QAAQ,CAAC;SACjB;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AArDD,wDAqDC;AAGD;;;;;;;;;;;;;GAaG;AACF,SAAgB,WAAW,CAC1B,MAAc,EACd,IAAY,EACZ,SAAgB,EAChB,QAAuB,EACvB,SAA0B,EAC1B,kBAAuB,EACvB,cAA2B;IAE3B,MAAM,UAAU,GAAG,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC;IAC5D,MAAM,IAAI,GAAQ,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;IAC1C,OAAO,IAAI,CAAC,GAAG,CAAC;IAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACnB,OAAO,IAAA,4BAAU,EAAC,IAAI,EAAE,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QAChD,OAAO,IAAA,6BAAQ,EAAC;YACd,KAAK,EAAE,cAAc,CAAC,QAAQ;YAC9B,MAAM;YACN,QAAQ,EAAE,kBAAkB,CAAC,QAAQ;YACrC,cAAc;SACf,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACN,CAAC;AArBA,kCAqBA"}

package/dist/umd/velocity/src/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/umd/velocity/src/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;