@esri/solution-velocity 4.1.2-alpha.0 → 5.0.0

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

@@ -1,71 +1,71 @@
-/** @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 } from "@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
- *
- */
-export declare function templatizeVelocity(template: IItemTemplate): void;
-/**
- * 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
- */
-export declare function _templatize(template: IItemTemplate, prop: string, fn: (arg: any) => void): void;
-/**
- * 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
- */
-export declare function _templatizeFeeds(feeds: any[]): any;
-/**
- * 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
- */
-export declare function _templatizeFeed(feed: any): any;
-/**
- * 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
- */
-export declare function _templatizeDatasources(dataSources: any[]): any;
+/** @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 } from "@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
+ *
+ */
+export declare function templatizeVelocity(template: IItemTemplate): void;
+/**
+ * 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
+ */
+export declare function _templatize(template: IItemTemplate, prop: string, fn: (arg: any) => void): void;
+/**
+ * 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
+ */
+export declare function _templatizeFeeds(feeds: any[]): any;
+/**
+ * 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
+ */
+export declare function _templatizeFeed(feed: any): any;
+/**
+ * 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
+ */
+export declare function _templatizeDatasources(dataSources: any[]): any;

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

@@ -1,106 +1,106 @@
-/** @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, setProp } from "@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
- *
- */
-export function templatizeVelocity(template) {
-    _templatize(template, "data.sources", _templatizeDatasources);
-    _templatize(template, "data.feeds", _templatizeFeeds);
-    _templatize(template, "data.feed", _templatizeFeed);
-}
-/**
- * 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
- */
-export function _templatize(template, prop, fn) {
-    const obj = getProp(template, prop);
-    /* istanbul ignore else */
-    if (obj) {
-        setProp(template, prop, fn(obj));
-    }
-}
-/**
- * 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
- */
-export 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;
-    });
-}
-/**
- * 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
- */
-export function _templatizeFeed(feed) {
-    let id = 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;
-}
-/**
- * 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
- */
-export function _templatizeDatasources(dataSources) {
-    return dataSources.map((ds) => _templatizeFeed(ds));
-}
+/** @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, setProp } from "@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
+ *
+ */
+export function templatizeVelocity(template) {
+    _templatize(template, "data.sources", _templatizeDatasources);
+    _templatize(template, "data.feeds", _templatizeFeeds);
+    _templatize(template, "data.feed", _templatizeFeed);
+}
+/**
+ * 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
+ */
+export function _templatize(template, prop, fn) {
+    const obj = getProp(template, prop);
+    /* istanbul ignore else */
+    if (obj) {
+        setProp(template, prop, fn(obj));
+    }
+}
+/**
+ * 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
+ */
+export 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;
+    });
+}
+/**
+ * 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
+ */
+export function _templatizeFeed(feed) {
+    let id = 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;
+}
+/**
+ * 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
+ */
+export function _templatizeDatasources(dataSources) {
+    return dataSources.map((ds) => _templatizeFeed(ds));
+}
 //# sourceMappingURL=velocity-templatize.js.map

package/dist/esm/index.d.ts

@@ -1,17 +1,17 @@
-/** @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 };
+/** @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/esm/index.js

@@ -1,18 +1,18 @@
-/** @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 };
+/** @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 };
 //# sourceMappingURL=index.js.map

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

@@ -1,61 +1,61 @@
-/** @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>;
+/** @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>;