@esri/solution-common 6.1.1 → 6.1.3

package/dist/esm/trackingHelpers.d.ts

@@ -1,115 +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 { ICreateServiceParams, UserSession } from "./arcgisRestJS";
-import { IItemTemplate, IItemUpdate } from "./interfaces";
-/**
- * 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/esm/trackingHelpers.js

@@ -1,200 +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 { getProp, setCreateProp, setProp } from "./generalHelpers";
-import { getItemBase } from "./restHelpersGet";
-import { templatizeTerm } from "./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
- */
-export function setLocationTrackingEnabled(portalResponse, userResponse, templateDictionary, templates) {
-    // set locationTracking...contains service url and id
-    const locationTracking = 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 && getProp(userResponse, "role") === "org_admin" ? true : false;
-    if (templates) {
-        _validateTrackingTemplates(templates, templateDictionary);
-    }
-}
-/**
- * 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 function _validateTrackingTemplates(templates, templateDictionary) {
-    /* istanbul ignore else */
-    if (!templateDictionary.locationTrackingEnabled &&
-        templates.some((template) => {
-            const typeKeywords = 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.");
-    }
-}
-/**
- * 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 function getTackingServiceOwner(templateDictionary, authentication) {
-    if (templateDictionary.locationTrackingEnabled) {
-        const locationTrackingId = templateDictionary.locationTracking.id;
-        return 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);
-    }
-}
-/**
- * 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 function isTrackingViewTemplate(itemTemplate, itemUpdate) {
-    const typeKeywords = getProp(itemTemplate, "item.typeKeywords") || getProp(itemUpdate, "typeKeywords");
-    const trackViewGroup = getProp(itemTemplate, "item.properties.trackViewGroup") || getProp(itemUpdate, "properties.trackViewGroup");
-    return typeKeywords && typeKeywords.indexOf("Location Tracking View") > -1 && trackViewGroup ? true : false;
-}
-/**
- * Check key properties to understand if we are dealing with a tracking group template
- *
- * @param itemTemplate the template to evaluate
- *
- * @private
- */
-export function isTrackingViewGroup(itemTemplate) {
-    const typeKeywords = getProp(itemTemplate, "item.tags");
-    return typeKeywords && typeKeywords.indexOf("Location Tracking Group") > -1 ? true : false;
-}
-/**
- * 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 function templatizeTracker(itemTemplate) {
-    /* istanbul ignore else */
-    if (isTrackingViewTemplate(itemTemplate)) {
-        const trackViewGroup = getProp(itemTemplate, "item.properties.trackViewGroup");
-        itemTemplate.groups.push(trackViewGroup);
-        itemTemplate.dependencies.push(trackViewGroup);
-        const groupIdVar = templatizeTerm(trackViewGroup, trackViewGroup, ".itemId");
-        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");
-        });
-    }
-}
-/**
- * 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 function _setName(itemTemplate, path, groupId, groupIdVar) {
-    const name = getProp(itemTemplate, path);
-    /* istanbul ignore else */
-    if (name) {
-        setProp(itemTemplate, path, name.replace(groupId, groupIdVar));
-    }
-}
-/**
- * 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 function templatizeServiceItemId(obj, path) {
-    const serviceItemId = getProp(obj, path);
-    /* istanbul ignore else */
-    if (serviceItemId) {
-        setProp(obj, path, templatizeTerm(serviceItemId, serviceItemId, ".itemId"));
-    }
-}
-/**
- * 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 function setTrackingOptions(itemTemplate, options, templateDictionary) {
-    /* istanbul ignore else */
-    if (isTrackingViewTemplate(itemTemplate)) {
-        setCreateProp(options, "owner", templateDictionary.locationTracking.owner);
-        setCreateProp(options.item, "name", itemTemplate.item.name);
-        setCreateProp(options.item, "isView", true);
-        setCreateProp(options.item, "owner", templateDictionary.locationTracking.owner);
-        setCreateProp(options.params, "isView", true);
-        setCreateProp(options.params, "outputType", "locationTrackingService");
-        delete options.folderId;
-    }
-    return options.item;
-}
-//# sourceMappingURL=trackingHelpers.js.map

package/dist/esm/trackingHelpers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"trackingHelpers.js","sourceRoot":"","sources":["../../src/trackingHelpers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAMH,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,0BAA0B,CACxC,cAAmB,EACnB,YAAiB,EACjB,kBAAuB,EACvB,SAA2B;IAE3B,qDAAqD;IACrD,MAAM,gBAAgB,GAAG,OAAO,CAAC,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,IAAI,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IAEtG,IAAI,SAAS,EAAE;QACb,0BAA0B,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;KAC3D;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,0BAA0B,CAAC,SAA0B,EAAE,kBAAuB;IAC5F,0BAA0B;IAC1B,IACE,CAAC,kBAAkB,CAAC,uBAAuB;QAC3C,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC1B,MAAM,YAAY,GAAa,OAAO,CAAC,QAAQ,EAAE,mBAAmB,CAAC,IAAI,EAAE,CAAC;YAC5E,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;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,sBAAsB,CAAC,kBAAuB,EAAE,cAA2B;IACzF,IAAI,kBAAkB,CAAC,uBAAuB,EAAE;QAC9C,MAAM,kBAAkB,GAAW,kBAAkB,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAC1E,OAAO,WAAW,CAAC,kBAAkB,EAAE,cAAc,CAAC,CAAC,IAAI,CACzD,CAAC,QAAQ,EAAE,EAAE;YACX,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,EACD,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAC7B,CAAC;KACH;SAAM;QACL,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;KAC/B;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,sBAAsB,CAAC,YAA4B,EAAE,UAAwB;IAC3F,MAAM,YAAY,GAAQ,OAAO,CAAC,YAAY,EAAE,mBAAmB,CAAC,IAAI,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IAC5G,MAAM,cAAc,GAClB,OAAO,CAAC,YAAY,EAAE,gCAAgC,CAAC,IAAI,OAAO,CAAC,UAAU,EAAE,2BAA2B,CAAC,CAAC;IAC9G,OAAO,YAAY,IAAI,YAAY,CAAC,OAAO,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;AAC9G,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,YAA2B;IAC7D,MAAM,YAAY,GAAQ,OAAO,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IAC7D,OAAO,YAAY,IAAI,YAAY,CAAC,OAAO,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;AAC7F,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAAC,YAA2B;IAC3D,0BAA0B;IAC1B,IAAI,sBAAsB,CAAC,YAAY,CAAC,EAAE;QACxC,MAAM,cAAc,GAAQ,OAAO,CAAC,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,cAAc,CAAC,cAAc,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC;QACrF,OAAO,CAAC,YAAY,EAAE,gCAAgC,EAAE,UAAU,CAAC,CAAC;QACpE,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,EAAE;YAC5B,uBAAuB,CAAC,CAAC,EAAE,wDAAwD,CAAC,CAAC;QACvF,CAAC,CAAC,CAAC;KACJ;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,QAAQ,CAAC,YAA2B,EAAE,IAAY,EAAE,OAAe,EAAE,UAAkB;IACrG,MAAM,IAAI,GAAW,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IACjD,0BAA0B;IAC1B,IAAI,IAAI,EAAE;QACR,OAAO,CAAC,YAAY,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;KAChE;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,uBAAuB,CAAC,GAAQ,EAAE,IAAY;IAC5D,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACzC,0BAA0B;IAC1B,IAAI,aAAa,EAAE;QACjB,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,cAAc,CAAC,aAAa,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC,CAAC;KAC7E;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAChC,YAA2B,EAC3B,OAAY,EACZ,kBAAuB;IAEvB,0BAA0B;IAC1B,IAAI,sBAAsB,CAAC,YAAY,CAAC,EAAE;QACxC,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAE3E,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5D,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC5C,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAEhF,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC9C,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,YAAY,EAAE,yBAAyB,CAAC,CAAC;QAEvE,OAAO,OAAO,CAAC,QAAQ,CAAC;KACzB;IACD,OAAO,OAAO,CAAC,IAAI,CAAC;AACtB,CAAC"}

package/dist/esm/velocityHelpers.d.ts

@@ -1,68 +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 { UserSession } from "./arcgisRestJS";
-import { IVelocityInfo } 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>;
-/**
- * Get the baser velocity url from the current ogs subscription info and verify that we have a valid
- * id for velocity
- *
- * @param authentication Credentials for the requests
- *
- * @returns a promise that will resolve with a hasVelocity boolean flag and the velocity url or an empty string when the org does not support velocity
- *
- */
-export declare function getVelocityInfo(authentication: UserSession): Promise<IVelocityInfo>;
-/**
- * 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/esm/velocityHelpers.js

@@ -1,144 +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 { getSubscriptionInfo } from "./get-subscription-info";
-import { getProp } from "./generalHelpers";
-// Known base names if output, source, or feed name is missing
-export const BASE_NAMES = ["feat-lyr-new", "feat-lyr-existing", "stream-lyr-new"];
-// Known prop paths that can contain item Ids
-export const 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
- *
- */
-export 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 {
-        return getVelocityInfo(authentication).then((velocityInfo) => {
-            // add the base url to the templateDictionary for reuse
-            templateDictionary.velocityUrl = velocityInfo.velocityUrl;
-            return Promise.resolve(velocityInfo.velocityUrl);
-        });
-    }
-}
-/**
- * Get the baser velocity url from the current ogs subscription info and verify that we have a valid
- * id for velocity
- *
- * @param authentication Credentials for the requests
- *
- * @returns a promise that will resolve with a hasVelocity boolean flag and the velocity url or an empty string when the org does not support velocity
- *
- */
-export function getVelocityInfo(authentication) {
-    // get the url from the orgs subscription info
-    return getSubscriptionInfo({ authentication }).then((subscriptionInfo) => {
-        let velocityUrl = "";
-        let hasVelocity = false;
-        const orgCapabilities = getProp(subscriptionInfo, "orgCapabilities");
-        /* istanbul ignore else */
-        if (Array.isArray(orgCapabilities)) {
-            orgCapabilities.some((c) => {
-                hasVelocity = c.id === "velocity" ? true : hasVelocity;
-                /* istanbul ignore else */
-                if (hasVelocity && c.status === "active" && c.velocityUrl) {
-                    velocityUrl = c.velocityUrl;
-                }
-                return velocityUrl;
-            });
-        }
-        return Promise.resolve({
-            velocityUrl,
-            hasVelocity,
-        });
-    });
-}
-/**
- * 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 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;
-}
-/**
- * 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 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;
-    }
-}
-//# sourceMappingURL=velocityHelpers.js.map

package/dist/esm/velocityHelpers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"velocityHelpers.js","sourceRoot":"","sources":["../../src/velocityHelpers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH,OAAO,EAAE,mBAAmB,EAAqB,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,8DAA8D;AAC9D,MAAM,CAAC,MAAM,UAAU,GAAa,CAAC,cAAc,EAAE,mBAAmB,EAAE,gBAAgB,CAAC,CAAC;AAE5F,6CAA6C;AAC7C,MAAM,CAAC,MAAM,UAAU,GAAa;IAClC,gCAAgC;IAChC,oCAAoC;IACpC,mCAAmC;IACnC,eAAe;CAChB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,kBAAkB,CAAC,cAA2B,EAAE,kBAAuB;IACrF,0EAA0E;IAC1E,IAAI,kBAAkB,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE;QACpD,OAAO,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;KACxD;SAAM;QACL,OAAO,eAAe,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE;YAC3D,uDAAuD;YACvD,kBAAkB,CAAC,WAAW,GAAG,YAAY,CAAC,WAAW,CAAC;YAC1D,OAAO,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;KACJ;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAAC,cAA2B;IACzD,8CAA8C;IAC9C,OAAO,mBAAmB,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,gBAAmC,EAAE,EAAE;QAC1F,IAAI,WAAW,GAAG,EAAE,CAAC;QACrB,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;QACrE,0BAA0B;QAC1B,IAAI,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;YAClC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;gBACzB,WAAW,GAAG,CAAC,CAAC,EAAE,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC;gBACvD,0BAA0B;gBAC1B,IAAI,WAAW,IAAI,CAAC,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,CAAC,WAAW,EAAE;oBACzD,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC;iBAC7B;gBACD,OAAO,WAAW,CAAC;YACrB,CAAC,CAAC,CAAC;SACJ;QACD,OAAO,OAAO,CAAC,OAAO,CAAC;YACrB,WAAW;YACX,WAAW;SACZ,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAAS,EAAE,IAAY,EAAE,kBAAuB;IACvF,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,eAAe,CAAC,OAAO,CAAC,CAAC,CAAM,EAAE,EAAE;YACjC,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;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,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,CAAC,IAAI,MAAM,CAAC,GAAG,WAAW,EAAE,EAAE,IAAI,CAAC,EAAE,iBAAiB,CAAC,CAAC;QAEvF,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,CAAC,MAAM,EAAE,EAAE;gBAC/B,wDAAwD;gBACxD,qDAAqD;gBACrD,mEAAmE;gBACnE,UAAU,GAAI,UAAkB,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,MAAM,qBAAqB,CAAC,CAAC;YACtF,CAAC,CAAC,CAAC;SACJ;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;KAC/B;SAAM;QACL,OAAO,IAAI,CAAC;KACb;AACH,CAAC"}

package/dist/esm/webtoolHelpers.d.ts

@@ -1,57 +0,0 @@
-/** @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.
- */
-import { IItemTemplate } from "./interfaces";
-/**
- * Store any web tool urls in the templateDictionary so we can use them to search other items
- * after they have been converted to templates
- *
- * @param template the current template
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
- *
- */
-export declare function preProcessWebTool(template: IItemTemplate, templateDictionary: any): void;
-/**
- * Use any stored GPServer urls to search all other templates for potential references
- * This will allow us to replace the base server name as will as the itemId
- *
- * @param templates the list of all the templates in the solution
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
- *
- * @returns potentially updated list of all the templates in the solution
- */
-export declare function postProcessWebToolReferences(templates: IItemTemplate[], templateDictionary: any): IItemTemplate[];
-/**
- * Use any stored GPServer urls to search all other templates for potential references
- * This will allow us to replace the base server name as will as the itemId
- *
- * @param templates the list of all the templates in the solution
- * @param orgUrl the item url of the GPServer
- * @param templatizedUrl the templatized GPServer Url
- * @param orgItemId the item id of the GPServer
- *
- * @returns potentially updated list of all the templates in the solution
- */
-export declare function _globalTemplatize(templates: IItemTemplate[], orgUrl: string, templatizedUrl: string, orgItemId: string): IItemTemplate[];
-/**
- * Update the templates dependencies if we can detect differences after we try and replace a GPServer url
- *
- * @param template the current template
- * @param itemString stringified version of the the templates item before we replaced anything
- * @param dataString stringified version of the the templates data before we replaced anything
- * @param id the current item Id of the GPServer
- *
- */
-export declare function _updateDependencies(template: IItemTemplate, itemString: string, dataString: string, id: string): void;