@esri/solution-common 5.2.3 → 5.2.4

package/dist/cjs/trackingHelpers.d.ts

@@ -0,0 +1,116 @@
+/** @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 "./interfaces";
+import { IItemUpdate } from "@esri/arcgis-rest-types";
+import { ICreateServiceParams } from "@esri/arcgis-rest-service-admin";
+/**
+ * Used by deploy to evaluate if we have everything we need to deploy tracking views.
+ *
+ * This function will update the input templateDictionary with a boolean
+ * indicating if tracking is enabled on the org and the user is an admin.
+ *
+ * @param portalResponse portal self response
+ * @param userResponse portal user response
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
+ * @param templates the list of IItemTemplates from the solution
+ *
+ * @private
+ */
+export declare function setLocationTrackingEnabled(portalResponse: any, userResponse: any, templateDictionary: any, templates?: IItemTemplate[]): void;
+/**
+ * Used by deploy to evaluate if we have everything we need to deploy tracking views.
+ *
+ * An error is thrown to prevent additional deployment work if we have Tracking items and tracking is
+ * not enabled or the deployment user is not an admin in the organization.
+ *
+ * @param templates the list of IItemTemplates from the solution
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
+ *
+ * @private
+ */
+export declare function _validateTrackingTemplates(templates: IItemTemplate[], templateDictionary: any): void;
+/**
+ * Used by deploy to determine the owner of the tracking service.
+ * Only one tracking service per org and all tracking views and tracking groups must be owned by the tracking service owner.
+ *
+ * This function will update the input templateDictionary with the owner as well as
+ *  the item id for the source tracking service.
+ *
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
+ * @param authentication Credentials for the requests
+ *
+ * @private
+ */
+export declare function getTackingServiceOwner(templateDictionary: any, authentication: UserSession): Promise<boolean>;
+/**
+ * Check key properties to understand if we are dealing with a tracking template
+ *
+ * @param itemTemplate the template to evaluate
+ * @param itemUpdate the item update to evaluate
+ *
+ * @private
+ */
+export declare function isTrackingViewTemplate(itemTemplate?: IItemTemplate, itemUpdate?: IItemUpdate): boolean;
+/**
+ * Check key properties to understand if we are dealing with a tracking group template
+ *
+ * @param itemTemplate the template to evaluate
+ *
+ * @private
+ */
+export declare function isTrackingViewGroup(itemTemplate: IItemTemplate): boolean;
+/**
+ * Templatize the tracker view group id and view name for location tracking views.
+ * This function will update the itemTemplate that is passed in when it's a tracking view.
+ *
+ * @param itemTemplate Template for feature service item
+ *
+ * @private
+ */
+export declare function templatizeTracker(itemTemplate: IItemTemplate): void;
+/**
+ * Templatize the tracker view group id and view name for location tracking views.
+ * This function will update the itemTemplate that is passed in when it's a tracking view.
+ *
+ * @param itemTemplate Template for the tracker view
+ * @param path the path to the property that stores the current name
+ * @param groupId the id of the associated tracker group
+ * @param groupIdVar the variable to replace the existing name with
+ *
+ * @private
+ */
+export declare function _setName(itemTemplate: IItemTemplate, path: string, groupId: string, groupIdVar: string): void;
+/**
+ * Templatize the tracker view serviceItemId
+ *
+ * This function will update the input obj with the templatized variable
+ *
+ * @param obj the object that stores the serviceItemId
+ * @param path the path to the property that stores the serviceItemId
+ *
+ * @private
+ */
+export declare function templatizeServiceItemId(obj: any, path: string): void;
+/**
+ * Used by deploy to update the request options with key details for deploying tracker views
+ *
+ * @param itemTemplate Template for feature service item
+ * @param options the current request options to update
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
+ *
+ * @private
+ */
+export declare function setTrackingOptions(itemTemplate: IItemTemplate, options: any, templateDictionary: any): ICreateServiceParams;

package/dist/cjs/trackingHelpers.js

@@ -0,0 +1,217 @@
+"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.setTrackingOptions = exports.templatizeServiceItemId = exports._setName = exports.templatizeTracker = exports.isTrackingViewGroup = exports.isTrackingViewTemplate = exports.getTackingServiceOwner = exports._validateTrackingTemplates = exports.setLocationTrackingEnabled = void 0;
+const generalHelpers_1 = require("./generalHelpers");
+const restHelpersGet_1 = require("./restHelpersGet");
+const templatization_1 = require("./templatization");
+/**
+ * Used by deploy to evaluate if we have everything we need to deploy tracking views.
+ *
+ * This function will update the input templateDictionary with a boolean
+ * indicating if tracking is enabled on the org and the user is an admin.
+ *
+ * @param portalResponse portal self response
+ * @param userResponse portal user response
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
+ * @param templates the list of IItemTemplates from the solution
+ *
+ * @private
+ */
+function setLocationTrackingEnabled(portalResponse, userResponse, templateDictionary, templates) {
+    // set locationTracking...contains service url and id
+    const locationTracking = (0, generalHelpers_1.getProp)(portalResponse, "helperServices.locationTracking");
+    /* istanbul ignore else */
+    if (locationTracking) {
+        templateDictionary.locationTracking = locationTracking;
+    }
+    // verify we have location tracking service and the user is an admin
+    templateDictionary.locationTrackingEnabled =
+        templateDictionary.locationTracking &&
+            (0, generalHelpers_1.getProp)(userResponse, "role") === "org_admin"
+            ? true
+            : false;
+    if (templates) {
+        _validateTrackingTemplates(templates, templateDictionary);
+    }
+}
+exports.setLocationTrackingEnabled = setLocationTrackingEnabled;
+/**
+ * Used by deploy to evaluate if we have everything we need to deploy tracking views.
+ *
+ * An error is thrown to prevent additional deployment work if we have Tracking items and tracking is
+ * not enabled or the deployment user is not an admin in the organization.
+ *
+ * @param templates the list of IItemTemplates from the solution
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
+ *
+ * @private
+ */
+function _validateTrackingTemplates(templates, templateDictionary) {
+    /* istanbul ignore else */
+    if (!templateDictionary.locationTrackingEnabled &&
+        templates.some(template => {
+            const typeKeywords = (0, generalHelpers_1.getProp)(template, "item.typeKeywords") || [];
+            return typeKeywords.indexOf("Location Tracking View") > -1;
+        })) {
+        console.error("Location tracking not enabled or user is not admin.");
+        throw new Error("Location tracking not enabled or user is not admin.");
+    }
+}
+exports._validateTrackingTemplates = _validateTrackingTemplates;
+/**
+ * Used by deploy to determine the owner of the tracking service.
+ * Only one tracking service per org and all tracking views and tracking groups must be owned by the tracking service owner.
+ *
+ * This function will update the input templateDictionary with the owner as well as
+ *  the item id for the source tracking service.
+ *
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
+ * @param authentication Credentials for the requests
+ *
+ * @private
+ */
+function getTackingServiceOwner(templateDictionary, authentication) {
+    if (templateDictionary.locationTrackingEnabled) {
+        const locationTrackingId = templateDictionary.locationTracking.id;
+        return (0, restHelpersGet_1.getItemBase)(locationTrackingId, authentication).then(itemBase => {
+            templateDictionary.locationTracking.owner = itemBase.owner;
+            templateDictionary[itemBase.id] = {
+                itemId: itemBase.id
+            };
+            return Promise.resolve(itemBase && itemBase.owner === authentication.username);
+        }, () => Promise.resolve(false));
+    }
+    else {
+        return Promise.resolve(false);
+    }
+}
+exports.getTackingServiceOwner = getTackingServiceOwner;
+/**
+ * Check key properties to understand if we are dealing with a tracking template
+ *
+ * @param itemTemplate the template to evaluate
+ * @param itemUpdate the item update to evaluate
+ *
+ * @private
+ */
+function isTrackingViewTemplate(itemTemplate, itemUpdate) {
+    const typeKeywords = (0, generalHelpers_1.getProp)(itemTemplate, "item.typeKeywords") ||
+        (0, generalHelpers_1.getProp)(itemUpdate, "typeKeywords");
+    const trackViewGroup = (0, generalHelpers_1.getProp)(itemTemplate, "item.properties.trackViewGroup") ||
+        (0, generalHelpers_1.getProp)(itemUpdate, "properties.trackViewGroup");
+    return (typeKeywords && typeKeywords.indexOf("Location Tracking View") > -1 && trackViewGroup) ? true : false;
+}
+exports.isTrackingViewTemplate = isTrackingViewTemplate;
+/**
+ * Check key properties to understand if we are dealing with a tracking group template
+ *
+ * @param itemTemplate the template to evaluate
+ *
+ * @private
+ */
+function isTrackingViewGroup(itemTemplate) {
+    const typeKeywords = (0, generalHelpers_1.getProp)(itemTemplate, "item.tags");
+    return (typeKeywords && typeKeywords.indexOf("Location Tracking Group") > -1) ? true : false;
+}
+exports.isTrackingViewGroup = isTrackingViewGroup;
+/**
+ * Templatize the tracker view group id and view name for location tracking views.
+ * This function will update the itemTemplate that is passed in when it's a tracking view.
+ *
+ * @param itemTemplate Template for feature service item
+ *
+ * @private
+ */
+function templatizeTracker(itemTemplate) {
+    /* istanbul ignore else */
+    if (isTrackingViewTemplate(itemTemplate)) {
+        const trackViewGroup = (0, generalHelpers_1.getProp)(itemTemplate, "item.properties.trackViewGroup");
+        itemTemplate.groups.push(trackViewGroup);
+        itemTemplate.dependencies.push(trackViewGroup);
+        const groupIdVar = (0, templatization_1.templatizeTerm)(trackViewGroup, trackViewGroup, ".itemId");
+        (0, generalHelpers_1.setProp)(itemTemplate, "item.properties.trackViewGroup", groupIdVar);
+        _setName(itemTemplate, "item.name", trackViewGroup, groupIdVar);
+        _setName(itemTemplate, "properties.service.adminServiceInfo.name", trackViewGroup, groupIdVar);
+        const layersAndTables = (itemTemplate.properties.layers || []).concat(itemTemplate.properties.tables || []);
+        layersAndTables.forEach(l => {
+            templatizeServiceItemId(l, "adminLayerInfo.viewLayerDefinition.sourceServiceItemId");
+        });
+    }
+}
+exports.templatizeTracker = templatizeTracker;
+/**
+ * Templatize the tracker view group id and view name for location tracking views.
+ * This function will update the itemTemplate that is passed in when it's a tracking view.
+ *
+ * @param itemTemplate Template for the tracker view
+ * @param path the path to the property that stores the current name
+ * @param groupId the id of the associated tracker group
+ * @param groupIdVar the variable to replace the existing name with
+ *
+ * @private
+ */
+function _setName(itemTemplate, path, groupId, groupIdVar) {
+    const name = (0, generalHelpers_1.getProp)(itemTemplate, path);
+    /* istanbul ignore else */
+    if (name) {
+        (0, generalHelpers_1.setProp)(itemTemplate, path, name.replace(groupId, groupIdVar));
+    }
+}
+exports._setName = _setName;
+/**
+ * Templatize the tracker view serviceItemId
+ *
+ * This function will update the input obj with the templatized variable
+ *
+ * @param obj the object that stores the serviceItemId
+ * @param path the path to the property that stores the serviceItemId
+ *
+ * @private
+ */
+function templatizeServiceItemId(obj, path) {
+    const serviceItemId = (0, generalHelpers_1.getProp)(obj, path);
+    /* istanbul ignore else */
+    if (serviceItemId) {
+        (0, generalHelpers_1.setProp)(obj, path, (0, templatization_1.templatizeTerm)(serviceItemId, serviceItemId, ".itemId"));
+    }
+}
+exports.templatizeServiceItemId = templatizeServiceItemId;
+/**
+ * Used by deploy to update the request options with key details for deploying tracker views
+ *
+ * @param itemTemplate Template for feature service item
+ * @param options the current request options to update
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
+ *
+ * @private
+ */
+function setTrackingOptions(itemTemplate, options, templateDictionary) {
+    /* istanbul ignore else */
+    if (isTrackingViewTemplate(itemTemplate)) {
+        (0, generalHelpers_1.setCreateProp)(options, "owner", templateDictionary.locationTracking.owner);
+        (0, generalHelpers_1.setCreateProp)(options.item, "name", itemTemplate.item.name);
+        (0, generalHelpers_1.setCreateProp)(options.item, "isView", true);
+        (0, generalHelpers_1.setCreateProp)(options.item, "owner", templateDictionary.locationTracking.owner);
+        (0, generalHelpers_1.setCreateProp)(options.params, "isView", true);
+        (0, generalHelpers_1.setCreateProp)(options.params, "outputType", "locationTrackingService");
+        delete (options.folderId);
+    }
+    return options.item;
+}
+exports.setTrackingOptions = setTrackingOptions;
+//# sourceMappingURL=trackingHelpers.js.map

package/dist/cjs/trackingHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trackingHelpers.js","sourceRoot":"","sources":["../../src/trackingHelpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAKH,qDAAmE;AACnE,qDAA+C;AAC/C,qDAAkD;AAIlD;;;;;;;;;;;;GAYG;AACH,SAAgB,0BAA0B,CACxC,cAAmB,EACnB,YAAiB,EACjB,kBAAuB,EACvB,SAA2B;IAE3B,qDAAqD;IACrD,MAAM,gBAAgB,GAAG,IAAA,wBAAO,EAAC,cAAc,EAAE,iCAAiC,CAAC,CAAC;IACpF,0BAA0B;IAC1B,IAAI,gBAAgB,EAAE;QACpB,kBAAkB,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;KACxD;IAED,oEAAoE;IACpE,kBAAkB,CAAC,uBAAuB;QACxC,kBAAkB,CAAC,gBAAgB;YACnC,IAAA,wBAAO,EAAC,YAAY,EAAE,MAAM,CAAC,KAAK,WAAW;YAC3C,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,KAAK,CAAC;IAEV,IAAI,SAAS,EAAE;QACb,0BAA0B,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;KAC3D;AACL,CAAC;AAvBD,gEAuBC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,0BAA0B,CACxC,SAA0B,EAC1B,kBAAuB;IAEvB,0BAA0B;IAC1B,IACE,CAAC,kBAAkB,CAAC,uBAAuB;QAC3C,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YACxB,MAAM,YAAY,GAChB,IAAA,wBAAO,EAAC,QAAQ,EAAE,mBAAmB,CAAC,IAAI,EAAE,CAAC;YAC/C,OAAO,YAAY,CAAC,OAAO,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7D,CAAC,CAAC,EACF;QACA,OAAO,CAAC,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACrE,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;KACxE;AACH,CAAC;AAhBD,gEAgBC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,sBAAsB,CACpC,kBAAuB,EACvB,cAA2B;IAE3B,IAAI,kBAAkB,CAAC,uBAAuB,EAAE;QAC9C,MAAM,kBAAkB,GAAW,kBAAkB,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAC1E,OAAO,IAAA,4BAAW,EAAC,kBAAkB,EAAE,cAAc,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YACrE,kBAAkB,CAAC,gBAAgB,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;YAC3D,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG;gBAChC,MAAM,EAAE,QAAQ,CAAC,EAAE;aACpB,CAAC;YACF,OAAO,OAAO,CAAC,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC,KAAK,KAAK,cAAc,CAAC,QAAQ,CAAC,CAAC;QACjF,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;KAClC;SAAM;QACL,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;KAC/B;AACH,CAAC;AAhBD,wDAgBC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CACpC,YAA4B,EAC5B,UAAwB;IAExB,MAAM,YAAY,GAChB,IAAA,wBAAO,EAAC,YAAY,EAAE,mBAAmB,CAAC;QACxC,IAAA,wBAAO,EAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACxC,MAAM,cAAc,GAClB,IAAA,wBAAO,EAAC,YAAY,EAAE,gCAAgC,CAAC;QACrD,IAAA,wBAAO,EAAC,UAAU,EAAE,2BAA2B,CAAC,CAAC;IACrD,OAAO,CAAC,YAAY,IAAI,YAAY,CAAC,OAAO,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;AAChH,CAAC;AAXD,wDAWC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,YAA2B;IAE3B,MAAM,YAAY,GAAQ,IAAA,wBAAO,EAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IAC7D,OAAO,CAAC,YAAY,IAAI,YAAY,CAAC,OAAO,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAA;AAC9F,CAAC;AALD,kDAKC;AAED;;;;;;;GAOG;AACF,SAAgB,iBAAiB,CAChC,YAA2B;IAE3B,0BAA0B;IAC1B,IAAI,sBAAsB,CAAC,YAAY,CAAC,EAAE;QACxC,MAAM,cAAc,GAAQ,IAAA,wBAAO,EAAC,YAAY,EAAE,gCAAgC,CAAC,CAAC;QACpF,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACzC,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAW,IAAA,+BAAc,EAAC,cAAc,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC;QACrF,IAAA,wBAAO,EACL,YAAY,EACZ,gCAAgC,EAChC,UAAU,CACX,CAAC;QACF,QAAQ,CAAC,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;QAChE,QAAQ,CAAC,YAAY,EAAE,0CAA0C,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;QAE/F,MAAM,eAAe,GAAU,CAAC,YAAY,CAAC,UAAU,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;QACnH,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YAC1B,uBAAuB,CAAC,CAAC,EAAE,wDAAwD,CAAC,CAAA;QACtF,CAAC,CAAC,CAAC;KACJ;AACH,CAAC;AAtBA,8CAsBA;AAED;;;;;;;;;;GAUG;AACH,SAAgB,QAAQ,CACtB,YAA2B,EAC3B,IAAY,EACZ,OAAe,EACf,UAAkB;IAElB,MAAM,IAAI,GAAW,IAAA,wBAAO,EAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IACjD,0BAA0B;IAC1B,IAAI,IAAI,EAAE;QACR,IAAA,wBAAO,EACL,YAAY,EACZ,IAAI,EACJ,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,CAClC,CAAC;KACH;AACH,CAAC;AAfD,4BAeC;AAED;;;;;;;;;GASG;AACH,SAAgB,uBAAuB,CACrC,GAAQ,EACR,IAAY;IAEZ,MAAM,aAAa,GAAG,IAAA,wBAAO,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACzC,0BAA0B;IAC1B,IAAI,aAAa,EAAE;QACjB,IAAA,wBAAO,EACL,GAAG,EACH,IAAI,EACJ,IAAA,+BAAc,EAAC,aAAa,EAAE,aAAa,EAAE,SAAS,CAAC,CACxD,CAAC;KACH;AACH,CAAC;AAbD,0DAaC;AAED;;;;;;;;GAQG;AACH,SAAgB,kBAAkB,CAChC,YAA2B,EAC3B,OAAY,EACZ,kBAAuB;IAEvB,0BAA0B;IAC1B,IAAI,sBAAsB,CAAC,YAAY,CAAC,EAAE;QACxC,IAAA,8BAAa,EAAC,OAAO,EAAE,OAAO,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAE3E,IAAA,8BAAa,EAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5D,IAAA,8BAAa,EAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC5C,IAAA,8BAAa,EAAC,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAEhF,IAAA,8BAAa,EAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC9C,IAAA,8BAAa,EAAC,OAAO,CAAC,MAAM,EAAE,YAAY,EAAE,yBAAyB,CAAC,CAAC;QAEvE,OAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;KAC1B;IACD,OAAO,OAAO,CAAC,IAAI,CAAC;AACtB,CAAC;AAnBD,gDAmBC"}

package/dist/cjs/velocityHelpers.d.ts

@@ -0,0 +1,57 @@
+/** @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 { UserSession } from "./interfaces";
+export declare const BASE_NAMES: string[];
+export declare const PROP_NAMES: string[];
+/**
+ * Get the base velocity url from the current orgs subscription info
+ *
+ * This function will update the input templateDictionary arg with the velocity url
+ * so we can reuse it without pinging the org again for subsequent requests to the
+ * velocity api.
+ *
+ * @param authentication Credentials for the requests
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ *
+ * @returns a promise that will resolve with the velocity url or an empty string when the org does not support velocity
+ *
+ */
+export declare function getVelocityUrlBase(authentication: UserSession, templateDictionary: any): Promise<string>;
+/**
+ * Update any velocity urls found in the data
+ *
+ * This function can be extended to support any item type specific functions such as
+ * removing the itemId from operational layers in a webmap
+ *
+ * @param data The data object of the item
+ * @param type The item type
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ *
+ * @returns an updated instance of the data object that was supplied.
+ *
+ */
+export declare function updateVelocityReferences(data: any, type: string, templateDictionary: any): any;
+/**
+ * Helper function to update velocity urls found in the data
+ *
+ *
+ * @param data The data object of the item
+ * @param velocityUrl The velocity url from the current organization
+ *
+ * @returns an updated instance of the data object that was supplied.
+ * @private
+ */
+export declare function _replaceVelocityUrls(data: any, velocityUrl: string): any;

package/dist/cjs/velocityHelpers.js

@@ -0,0 +1,135 @@
+"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._replaceVelocityUrls = exports.updateVelocityReferences = exports.getVelocityUrlBase = exports.PROP_NAMES = exports.BASE_NAMES = void 0;
+const get_subscription_info_1 = require("./get-subscription-info");
+const generalHelpers_1 = require("./generalHelpers");
+// Known base names if output, source, or feed name is missing
+exports.BASE_NAMES = [
+    "feat-lyr-new",
+    "feat-lyr-existing",
+    "stream-lyr-new"
+];
+// Known prop paths that can contain item Ids
+exports.PROP_NAMES = [
+    ".portal.mapServicePortalItemID",
+    ".portal.featureServicePortalItemID",
+    ".portal.streamServicePortalItemID",
+    ".portalItemId"
+];
+/**
+ * Get the base velocity url from the current orgs subscription info
+ *
+ * This function will update the input templateDictionary arg with the velocity url
+ * so we can reuse it without pinging the org again for subsequent requests to the
+ * velocity api.
+ *
+ * @param authentication Credentials for the requests
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ *
+ * @returns a promise that will resolve with the velocity url or an empty string when the org does not support velocity
+ *
+ */
+function getVelocityUrlBase(authentication, templateDictionary) {
+    // if we already have the base url no need to make any additional requests
+    if (templateDictionary.hasOwnProperty("velocityUrl")) {
+        return Promise.resolve(templateDictionary.velocityUrl);
+    }
+    else {
+        // get the url from the orgs subscription info
+        return (0, get_subscription_info_1.getSubscriptionInfo)({ authentication }).then((subscriptionInfo) => {
+            let velocityUrl = "";
+            const orgCapabilities = (0, generalHelpers_1.getProp)(subscriptionInfo, "orgCapabilities");
+            /* istanbul ignore else */
+            if (Array.isArray(orgCapabilities)) {
+                orgCapabilities.some(c => {
+                    /* istanbul ignore else */
+                    if (c.id === "velocity" && c.status === "active" && c.velocityUrl) {
+                        velocityUrl = c.velocityUrl;
+                    }
+                    return velocityUrl;
+                });
+            }
+            // add the base url to the templateDictionary for reuse
+            templateDictionary.velocityUrl = velocityUrl;
+            return Promise.resolve(velocityUrl);
+        });
+    }
+}
+exports.getVelocityUrlBase = getVelocityUrlBase;
+/**
+ * Update any velocity urls found in the data
+ *
+ * This function can be extended to support any item type specific functions such as
+ * removing the itemId from operational layers in a webmap
+ *
+ * @param data The data object of the item
+ * @param type The item type
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ *
+ * @returns an updated instance of the data object that was supplied.
+ *
+ */
+function updateVelocityReferences(data, type, templateDictionary) {
+    const velocityUrl = templateDictionary.velocityUrl;
+    if (data && type === "Web Map" && velocityUrl) {
+        const layersAndTables = (data.operationalLayers || []).concat(data.tables || []);
+        (layersAndTables).forEach((l) => {
+            if (l.url && l.url.indexOf(velocityUrl) > -1 && l.itemId) {
+                delete l.itemId;
+            }
+        });
+    }
+    return velocityUrl && data ? _replaceVelocityUrls(data, velocityUrl) : data;
+}
+exports.updateVelocityReferences = updateVelocityReferences;
+/**
+ * Helper function to update velocity urls found in the data
+ *
+ *
+ * @param data The data object of the item
+ * @param velocityUrl The velocity url from the current organization
+ *
+ * @returns an updated instance of the data object that was supplied.
+ * @private
+ */
+function _replaceVelocityUrls(data, velocityUrl) {
+    let dataString = JSON.stringify(data);
+    if (dataString.indexOf(velocityUrl) > -1) {
+        // replace any instance of the velocity base url
+        dataString = dataString.replace(new RegExp(`${velocityUrl}`, "gi"), "{{velocityUrl}}");
+        // add solutionItemId to any velocity service names
+        const regex = new RegExp("{{velocityUrl}}.+?(?=/[A-Za-z]+Server)", "gi");
+        const results = dataString.match(regex);
+        /* istanbul ignore else */
+        if (results) {
+            const uniqueResults = results.filter((v, i, self) => self.indexOf(v) === i);
+            uniqueResults.forEach(result => {
+                // these names can contain reserved characters for regex
+                // for example: http://something/name(something else)
+                // TypeScript for es2015 doesn't have a definition for `replaceAll`
+                dataString = dataString.replaceAll(result, `${result}_{{solutionItemId}}`);
+            });
+        }
+        return JSON.parse(dataString);
+    }
+    else {
+        return data;
+    }
+}
+exports._replaceVelocityUrls = _replaceVelocityUrls;
+//# sourceMappingURL=velocityHelpers.js.map

package/dist/cjs/velocityHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"velocityHelpers.js","sourceRoot":"","sources":["../../src/velocityHelpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAGH,mEAGiC;AACjC,qDAA2C;AAE3C,8DAA8D;AACjD,QAAA,UAAU,GAAa;IAClC,cAAc;IACd,mBAAmB;IACnB,gBAAgB;CACjB,CAAC;AAEF,6CAA6C;AAChC,QAAA,UAAU,GAAc;IACnC,gCAAgC;IAChC,oCAAoC;IACpC,mCAAmC;IACnC,eAAe;CAChB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,SAAgB,kBAAkB,CAChC,cAA2B,EAC3B,kBAAuB;IAEvB,0EAA0E;IAC1E,IAAI,kBAAkB,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE;QACpD,OAAO,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;KACxD;SAAM;QACL,8CAA8C;QAC9C,OAAO,IAAA,2CAAmB,EAAC,EAAE,cAAc,EAAE,CAAC,CAAC,IAAI,CACjD,CAAC,gBAAmC,EAAE,EAAE;YACtC,IAAI,WAAW,GAAG,EAAE,CAAC;YACrB,MAAM,eAAe,GAAG,IAAA,wBAAO,EAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;YACrE,0BAA0B;YAC1B,IAAI,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;gBAClC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;oBACvB,0BAA0B;oBAC1B,IAAI,CAAC,CAAC,EAAE,KAAK,UAAU,IAAI,CAAC,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,CAAC,WAAW,EAAE;wBACjE,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC;qBAC7B;oBACD,OAAO,WAAW,CAAC;gBACrB,CAAC,CAAC,CAAC;aACJ;YACD,uDAAuD;YACvD,kBAAkB,CAAC,WAAW,GAAG,WAAW,CAAC;YAE7C,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACtC,CAAC,CACF,CAAC;KACH;AACH,CAAC;AA9BD,gDA8BC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,wBAAwB,CACtC,IAAS,EACT,IAAY,EACZ,kBAAuB;IAEvB,MAAM,WAAW,GAAQ,kBAAkB,CAAC,WAAW,CAAC;IACxD,IAAI,IAAI,IAAI,IAAI,KAAK,SAAS,IAAI,WAAW,EAAE;QAC7C,MAAM,eAAe,GAAU,CAAC,IAAI,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;QACxF,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,CAAC,CAAM,EAAE,EAAE;YACnC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE;gBACxD,OAAO,CAAC,CAAC,MAAM,CAAC;aACjB;QACH,CAAC,CAAC,CAAC;KACJ;IACD,OAAO,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC9E,CAAC;AAfD,4DAeC;AAED;;;;;;;;;GASG;AACH,SAAgB,oBAAoB,CAAC,IAAS,EAAE,WAAmB;IACjE,IAAI,UAAU,GAAW,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC9C,IAAI,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE;QACxC,gDAAgD;QAChD,UAAU,GAAG,UAAU,CAAC,OAAO,CAC7B,IAAI,MAAM,CAAC,GAAG,WAAW,EAAE,EAAE,IAAI,CAAC,EAClC,iBAAiB,CAClB,CAAC;QAEF,mDAAmD;QACnD,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,wCAAwC,EAAE,IAAI,CAAC,CAAC;QACzE,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACxC,0BAA0B;QAC1B,IAAI,OAAO,EAAE;YACX,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YAC5E,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBAC7B,wDAAwD;gBACxD,qDAAqD;gBACrD,mEAAmE;gBACnE,UAAU,GAAI,UAAkB,CAAC,UAAU,CACzC,MAAM,EACN,GAAG,MAAM,qBAAqB,CAC/B,CAAC;YACJ,CAAC,CAAC,CAAC;SACJ;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;KAC/B;SAAM;QACL,OAAO,IAAI,CAAC;KACb;AACH,CAAC;AA7BD,oDA6BC"}

package/dist/cjs/workflowHelpers.d.ts

@@ -0,0 +1,37 @@
+/** @license
+ * Copyright 2024 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.
+ */
+/**
+ * Compresses a workflow configuration into a zip file.
+ *
+ * @param workflowConfig Workflow configuration
+ * @returns Promise resolving with a zip file
+ */
+export declare function compressWorkflowIntoZipFile(workflowConfig: any): Promise<File>;
+/**
+ * Extracts a workflow configuration from a zip file into a JSON object.
+ *
+ * @param zipFile Zip file containing a workflow configuration
+ * @returns Promise resolving with a workflow configuration as JSON object, with each file being a key
+ */
+export declare function extractWorkflowFromZipFile(zipFile: File): Promise<any>;
+/**
+ * Extracts a workflow configuration from a zip file into a JSON object, with all AGO ids in the
+ * configuration templatized.
+ *
+ * @param zipFile Zip file containing a workflow configuration
+ * @returns Promise resolving with a workflow configuration as JSON object, with each file being a key
+ */
+export declare function extractAndTemplatizeWorkflowFromZipFile(zipFile: File): Promise<any>;

package/dist/cjs/workflowHelpers.js

@@ -0,0 +1,77 @@
+"use strict";
+/** @license
+ * Copyright 2024 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.extractAndTemplatizeWorkflowFromZipFile = exports.extractWorkflowFromZipFile = exports.compressWorkflowIntoZipFile = void 0;
+const tslib_1 = require("tslib");
+const zipUtils = tslib_1.__importStar(require("./zip-utils"));
+const copyDataIntoItem_1 = require("./resources/copyDataIntoItem");
+const generalHelpers_1 = require("./generalHelpers");
+const jszip_1 = tslib_1.__importDefault(require("jszip"));
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Compresses a workflow configuration into a zip file.
+ *
+ * @param workflowConfig Workflow configuration
+ * @returns Promise resolving with a zip file
+ */
+async function compressWorkflowIntoZipFile(workflowConfig) {
+    const zip = new jszip_1.default();
+    Object.keys(workflowConfig).forEach((key) => {
+        zip.file(key, JSON.stringify(workflowConfig[key]));
+    });
+    const zipFile = (0, copyDataIntoItem_1.createMimeTypedFile)({
+        blob: await zip.generateAsync({ type: "blob" }),
+        filename: `workflow_configuration.zip`,
+        mimeType: "application/zip"
+    });
+    return Promise.resolve(zipFile);
+}
+exports.compressWorkflowIntoZipFile = compressWorkflowIntoZipFile;
+/**
+ * Extracts a workflow configuration from a zip file into a JSON object.
+ *
+ * @param zipFile Zip file containing a workflow configuration
+ * @returns Promise resolving with a workflow configuration as JSON object, with each file being a key
+ */
+async function extractWorkflowFromZipFile(zipFile) {
+    const zippedFiles = await zipUtils.getZipObjectContents(await zipUtils.blobToZipObject(zipFile));
+    const workflowConfig = {};
+    zippedFiles.forEach((zippedFile) => {
+        workflowConfig[zippedFile.file] = zippedFile.content;
+    });
+    return Promise.resolve(workflowConfig);
+}
+exports.extractWorkflowFromZipFile = extractWorkflowFromZipFile;
+/**
+ * Extracts a workflow configuration from a zip file into a JSON object, with all AGO ids in the
+ * configuration templatized.
+ *
+ * @param zipFile Zip file containing a workflow configuration
+ * @returns Promise resolving with a workflow configuration as JSON object, with each file being a key
+ */
+async function extractAndTemplatizeWorkflowFromZipFile(zipFile) {
+    const workflowConfig = await extractWorkflowFromZipFile(zipFile);
+    // Replace AGO ids with templatized versions
+    let workflowConfigStr = JSON.stringify(workflowConfig);
+    const matches = workflowConfigStr.match((0, generalHelpers_1.getAgoIdRegEx)()) || [];
+    matches.forEach((match) => {
+        workflowConfigStr = workflowConfigStr.replace(new RegExp(match, "g"), `{{${match}}}`);
+    });
+    return Promise.resolve(JSON.parse(workflowConfigStr));
+}
+exports.extractAndTemplatizeWorkflowFromZipFile = extractAndTemplatizeWorkflowFromZipFile;
+//# sourceMappingURL=workflowHelpers.js.map

package/dist/cjs/workflowHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflowHelpers.js","sourceRoot":"","sources":["../../src/workflowHelpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AASH,8DAAwC;AACxC,mEAAmE;AACnE,qDAAiD;AACjD,0DAA0B;AAE1B,wHAAwH;AAExH;;;;;GAKG;AACI,KAAK,UAAU,2BAA2B,CAC/C,cAAmB;IAEnB,MAAM,GAAG,GAAG,IAAI,eAAK,EAAE,CAAC;IACxB,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;QAClD,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAA,sCAAmB,EAAC;QAClC,IAAI,EAAE,MAAM,GAAG,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAC/C,QAAQ,EAAE,4BAA4B;QACtC,QAAQ,EAAE,iBAAiB;KAC5B,CAAC,CAAA;IAEF,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC;AAfD,kEAeC;AAED;;;;;GAKG;AACI,KAAK,UAAU,0BAA0B,CAC9C,OAAa;IAEb,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,oBAAoB,CAAC,MAAM,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;IAEjG,MAAM,cAAc,GAAQ,EAAE,CAAC;IAC/B,WAAW,CAAC,OAAO,CAAC,CAAC,UAA4C,EAAE,EAAE;QACnE,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;AACzC,CAAC;AAXD,gEAWC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,uCAAuC,CAC3D,OAAa;IAEb,MAAM,cAAc,GAAG,MAAM,0BAA0B,CAAC,OAAO,CAAC,CAAC;IAEjE,4CAA4C;IAC5C,IAAI,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,iBAAiB,CAAC,KAAK,CAAC,IAAA,8BAAa,GAAE,CAAC,IAAI,EAAE,CAAC;IAC/D,OAAO,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,EAAE;QAChC,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC,CAAC;IACxF,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;AACxD,CAAC;AAbD,0FAaC"}