@esri/solution-common 4.1.2 → 5.0.0

package/dist/esm/deleteSolution.js

@@ -1,101 +1,101 @@
-/** @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 deleteSolutionContents from "./deleteHelpers/deleteSolutionContents";
-import * as getDeletableSolutionInfo from "./getDeletableSolutionInfo";
-// ------------------------------------------------------------------------------------------------------------------ //
-/**
- * Deletes a deployed Solution item and and all of the items that were created
- * as part of that deployment.
- *
- * @param solutionItemId Id of a deployed Solution
- * @param authentication Credentials for the request
- * @param options Progress reporting options
- * @returns Promise that will resolve with a list of two solution summaries: successful deletions
- * and failed deletions. Ignored items (e.g., already deleted) and items shared with more than
- * one Solution will not be in either list.
- * Note that Solution item and its deployment folder will only be deleted if all of its deployed
- * items were deleted (the failure list is empty). This makes it possible to re-attempted
- * deletion using the solutionItemId.
- */
-export function deleteSolution(solutionItemId, authentication, options) {
-    return getDeletableSolutionInfo
-        .getDeletableSolutionInfo(solutionItemId, authentication)
-        .then((solutionSummary) => {
-        return deleteSolutionContents.deleteSolutionContents(solutionItemId, solutionSummary, authentication, options);
-    })
-        .catch(() => {
-        return [undefined, undefined];
-    });
-}
-/**
- * Deletes a deployed Solution item and and all of the items that were created
- * as part of that deployment.
- *
- * @param solutionItemId Id of a deployed Solution
- * @param itemIds Item ids to delete; this list is reversed in this function
- * @param templates List of Solution's templates
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
- * @param authentication Credentials for the request
- * @param options Progress reporting options
- * @returns Promise that will resolve with a list of two solution summaries: successful deletions
- * and failed deletions. Ignored items (e.g., already deleted) and items shared with more than
- * one Solution will not be in either list.
- * Note that Solution item and its deployment folder will only be deleted if all of its deployed
- * items were deleted (the failure list is empty). This makes it possible to re-attempted
- * deletion using the solutionItemId.
- */
-export function deleteSolutionByComponents(solutionItemId, itemIds, templates, templateDictionary, authentication, options) {
-    // Construct a description of the solution from its id and the itemIds using the templateDictionary to fill in details
-    const solutionSummary = {
-        id: solutionItemId,
-        title: "",
-        folder: templateDictionary.folderId,
-        items: [],
-        groups: []
-    };
-    // Combine the templates and templateDictionary to create summary items
-    let summaries = templates
-        .map(template => {
-        return {
-            id: template.itemId,
-            type: template.type,
-            title: template.item.title,
-            modified: 0,
-            owner: ""
-        };
-    })
-        .map(summary => {
-        summary.id = templateDictionary[summary.id].itemId;
-        return summary;
-    })
-        .filter(summary => !!summary.id);
-    // Filter to only include items in itemIds
-    summaries = summaries.filter(summary => itemIds.includes(summary.id));
-    // Sort into the order of itemIds (last created is first deleted)
-    summaries.sort((summary1, summary2) => itemIds.indexOf(summary1.id) - itemIds.indexOf(summary2.id));
-    // Partition into items and groups
-    summaries.forEach(summary => {
-        if (summary.type === "Group") {
-            solutionSummary.groups.push(summary.id);
-        }
-        else {
-            solutionSummary.items.push(summary);
-        }
-    });
-    // Delete the solution
-    return deleteSolutionContents.deleteSolutionContents(solutionItemId, solutionSummary, authentication, options);
-}
+/** @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 deleteSolutionContents from "./deleteHelpers/deleteSolutionContents";
+import * as getDeletableSolutionInfo from "./getDeletableSolutionInfo";
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Deletes a deployed Solution item and and all of the items that were created
+ * as part of that deployment.
+ *
+ * @param solutionItemId Id of a deployed Solution
+ * @param authentication Credentials for the request
+ * @param options Progress reporting options
+ * @returns Promise that will resolve with a list of two solution summaries: successful deletions
+ * and failed deletions. Ignored items (e.g., already deleted) and items shared with more than
+ * one Solution will not be in either list.
+ * Note that Solution item and its deployment folder will only be deleted if all of its deployed
+ * items were deleted (the failure list is empty). This makes it possible to re-attempted
+ * deletion using the solutionItemId.
+ */
+export function deleteSolution(solutionItemId, authentication, options) {
+    return getDeletableSolutionInfo
+        .getDeletableSolutionInfo(solutionItemId, authentication)
+        .then((solutionSummary) => {
+        return deleteSolutionContents.deleteSolutionContents(solutionItemId, solutionSummary, authentication, options);
+    })
+        .catch(() => {
+        return [undefined, undefined];
+    });
+}
+/**
+ * Deletes a deployed Solution item and and all of the items that were created
+ * as part of that deployment.
+ *
+ * @param solutionItemId Id of a deployed Solution
+ * @param itemIds Item ids to delete; this list is reversed in this function
+ * @param templates List of Solution's templates
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ * @param authentication Credentials for the request
+ * @param options Progress reporting options
+ * @returns Promise that will resolve with a list of two solution summaries: successful deletions
+ * and failed deletions. Ignored items (e.g., already deleted) and items shared with more than
+ * one Solution will not be in either list.
+ * Note that Solution item and its deployment folder will only be deleted if all of its deployed
+ * items were deleted (the failure list is empty). This makes it possible to re-attempted
+ * deletion using the solutionItemId.
+ */
+export function deleteSolutionByComponents(solutionItemId, itemIds, templates, templateDictionary, authentication, options) {
+    // Construct a description of the solution from its id and the itemIds using the templateDictionary to fill in details
+    const solutionSummary = {
+        id: solutionItemId,
+        title: "",
+        folder: templateDictionary.folderId,
+        items: [],
+        groups: []
+    };
+    // Combine the templates and templateDictionary to create summary items
+    let summaries = templates
+        .map(template => {
+        return {
+            id: template.itemId,
+            type: template.type,
+            title: template.item.title,
+            modified: 0,
+            owner: ""
+        };
+    })
+        .map(summary => {
+        summary.id = templateDictionary[summary.id].itemId;
+        return summary;
+    })
+        .filter(summary => !!summary.id);
+    // Filter to only include items in itemIds
+    summaries = summaries.filter(summary => itemIds.includes(summary.id));
+    // Sort into the order of itemIds (last created is first deleted)
+    summaries.sort((summary1, summary2) => itemIds.indexOf(summary1.id) - itemIds.indexOf(summary2.id));
+    // Partition into items and groups
+    summaries.forEach(summary => {
+        if (summary.type === "Group") {
+            solutionSummary.groups.push(summary.id);
+        }
+        else {
+            solutionSummary.items.push(summary);
+        }
+    });
+    // Delete the solution
+    return deleteSolutionContents.deleteSolutionContents(solutionItemId, solutionSummary, authentication, options);
+}
 //# sourceMappingURL=deleteSolution.js.map

package/dist/esm/dependencies.d.ts

@@ -1,26 +1,26 @@
-/** @license
- * Copyright 2018 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 { IBuildOrdering, IItemTemplate } from "./interfaces";
-/**
- * Topologically sorts a list of items into a build list.
- *
- * @param templates A collection of AGO item templates
- * @returns An object containing three parts: a list of ids of items in the order in which they need to be built
- * so that dependencies are built before items that require those dependencies, a list of item ids found in a
- * template's dependencies but not present in the supplied list of templates, and a dictionary containing items
- * that need to be post-processed due to dependency cycles.
- */
-export declare function topologicallySortItems(templates: IItemTemplate[]): IBuildOrdering;
+/** @license
+ * Copyright 2018 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 { IBuildOrdering, IItemTemplate } from "./interfaces";
+/**
+ * Topologically sorts a list of items into a build list.
+ *
+ * @param templates A collection of AGO item templates
+ * @returns An object containing three parts: a list of ids of items in the order in which they need to be built
+ * so that dependencies are built before items that require those dependencies, a list of item ids found in a
+ * template's dependencies but not present in the supplied list of templates, and a dictionary containing items
+ * that need to be post-processed due to dependency cycles.
+ */
+export declare function topologicallySortItems(templates: IItemTemplate[]): IBuildOrdering;

package/dist/esm/dependencies.js

@@ -1,167 +1,167 @@
-/** @license
- * Copyright 2018 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.
- */
-/**
- * Provides common functions for organizing dependencies among items.
- *
- * @module dependencies
- */
-import { getProp } from "./generalHelpers";
-import { findTemplateInList } from "./templatization";
-// ------------------------------------------------------------------------------------------------------------------ //
-/**
- * Topologically sorts a list of items into a build list.
- *
- * @param templates A collection of AGO item templates
- * @returns An object containing three parts: a list of ids of items in the order in which they need to be built
- * so that dependencies are built before items that require those dependencies, a list of item ids found in a
- * template's dependencies but not present in the supplied list of templates, and a dictionary containing items
- * that need to be post-processed due to dependency cycles.
- */
-export function topologicallySortItems(templates) {
-    // Cormen, Thomas H.; Leiserson, Charles E.; Rivest, Ronald L.; Stein, Clifford (2009)
-    // Sections 22.3 (Depth-first search) & 22.4 (Topological sort), pp. 603-615
-    // Introduction to Algorithms (3rd ed.), The MIT Press, ISBN 978-0-262-03384-8
-    //
-    // DFS(G)
-    // 1 for each vertex u ∈ G,V
-    // 2     u.color = WHITE  (not yet visited)
-    // 3     u.π = NIL
-    // 4 time = 0
-    // 5 for each vertex u ∈ G,V
-    // 6     if u.color == WHITE
-    // 7         DFS-VISIT(G,u)
-    //
-    // DFS-VISIT(G,u)
-    // 1 time = time + 1  (white vertex u has just been discovered)
-    // 2 u.d = time
-    // 3 u.color = GRAY  (visited, in progress)
-    // 4 for each v ∈ G.Adj[u]  (explore edge (u,v))
-    // 5     if v.color == WHITE
-    // 6         v.π = u
-    // 7         DFS-VISIT(G,v)
-    // 8 u.color = BLACK  (blacken u; it is finished)
-    // 9 time = time + 1
-    // 10 u.f = time
-    //
-    // TOPOLOGICAL-SORT(G)
-    // 1 call DFS(G) to compute finishing times v.f for each vertex v
-    // 2 as each vertex is finished, insert it onto front of a linked list
-    // 3 return the linked list of vertices
-    let buildOrder = []; // list of ordered vertices--don't need linked list because
-    // we just want relative ordering
-    const missingDependencies = [];
-    const itemsToBePatched = {};
-    const verticesToVisit = {};
-    const vertexType = {};
-    templates.forEach(function (template) {
-        verticesToVisit[template.itemId] = ESortVisitState.NotYetVisited;
-        vertexType[template.itemId] =
-            template.item?.typeKeywords &&
-                template.item.typeKeywords.includes("View Service")
-                ? "View Service"
-                : template.item?.tags && template.item.tags.includes("Location Tracking Group")
-                    ? "Location Tracking Group" : template.type;
-    });
-    // Algorithm visits each vertex once. Don't need to record times or "from' nodes ("π" in pseudocode)
-    templates.forEach(function (template) {
-        if (verticesToVisit[template.itemId] === ESortVisitState.NotYetVisited) {
-            // if not yet visited
-            visit(template.itemId);
-        }
-    });
-    // Visit vertex
-    function visit(vertexId) {
-        verticesToVisit[vertexId] = ESortVisitState.InProgress; // visited, in progress
-        // Visit dependents if not already visited; template has to be in templates list because calls to visit()
-        // are based on verticiesToVisit[], which is initialized using the templates list
-        const template = findTemplateInList(templates, vertexId);
-        // There are two sources of dependencies
-        const dependencies = (template.dependencies || []).concat(getProp(template, "properties.syncViews") || []);
-        dependencies.forEach(function (dependencyId) {
-            if (verticesToVisit[dependencyId] === ESortVisitState.NotYetVisited) {
-                // if not yet visited
-                visit(dependencyId);
-            }
-            else if (verticesToVisit[dependencyId] === ESortVisitState.InProgress) {
-                // visited, in progress, therefore a cycle
-                // save the dependency that needs to be patched
-                if (itemsToBePatched[vertexId]) {
-                    itemsToBePatched[vertexId].push(dependencyId);
-                }
-                else {
-                    itemsToBePatched[vertexId] = [dependencyId];
-                }
-            }
-            else if (verticesToVisit[dependencyId] !== ESortVisitState.Finished) {
-                /* istanbul ignore else */
-                if (missingDependencies.indexOf(dependencyId) < 0) {
-                    missingDependencies.push(dependencyId);
-                }
-            }
-        });
-        verticesToVisit[vertexId] = ESortVisitState.Finished;
-        buildOrder.push(vertexId); // add to end of list of ordered vertices because we want dependents first
-    }
-    // Two special circumstances to deal with
-    // 1) Location Tracking Group needs to be created before its associated view because the groupId is used in the view name
-    //    - Move tracking groups to the front of the list
-    // 2) Feature Services need to be created before views that rely on them
-    //    - Move all of the feature services to the beginning of the build order while maintaining their relative ordering
-    //    - Distinguish between base feature services and view feature services
-    const trackerGroupIds = [];
-    const fsIds = [];
-    const fsViewIds = [];
-    const otherIds = [];
-    do {
-        const id = buildOrder.shift();
-        if (id) {
-            if (vertexType[id] === "Location Tracking Group") {
-                trackerGroupIds.push(id);
-            }
-            else if (vertexType[id] === "Feature Service") {
-                fsIds.push(id);
-            }
-            else if (vertexType[id] === "View Service") {
-                fsViewIds.push(id);
-            }
-            else {
-                otherIds.push(id);
-            }
-        }
-    } while (buildOrder.length > 0);
-    buildOrder = trackerGroupIds.concat(fsIds, fsViewIds, otherIds);
-    const orderingResults = {
-        buildOrder: buildOrder,
-        missingDependencies: missingDependencies,
-        itemsToBePatched: itemsToBePatched
-    };
-    return orderingResults;
-}
-/**
- * A visit flag used in the topological sort algorithm.
- *
- * @private
- */
-var ESortVisitState;
-(function (ESortVisitState) {
-    /** not yet visited */
-    ESortVisitState[ESortVisitState["NotYetVisited"] = 0] = "NotYetVisited";
-    /** visited, in progress */
-    ESortVisitState[ESortVisitState["InProgress"] = 1] = "InProgress";
-    /** finished */
-    ESortVisitState[ESortVisitState["Finished"] = 2] = "Finished"; // BLACK
-})(ESortVisitState || (ESortVisitState = {}));
+/** @license
+ * Copyright 2018 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.
+ */
+/**
+ * Provides common functions for organizing dependencies among items.
+ *
+ * @module dependencies
+ */
+import { getProp } from "./generalHelpers";
+import { findTemplateInList } from "./templatization";
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Topologically sorts a list of items into a build list.
+ *
+ * @param templates A collection of AGO item templates
+ * @returns An object containing three parts: a list of ids of items in the order in which they need to be built
+ * so that dependencies are built before items that require those dependencies, a list of item ids found in a
+ * template's dependencies but not present in the supplied list of templates, and a dictionary containing items
+ * that need to be post-processed due to dependency cycles.
+ */
+export function topologicallySortItems(templates) {
+    // Cormen, Thomas H.; Leiserson, Charles E.; Rivest, Ronald L.; Stein, Clifford (2009)
+    // Sections 22.3 (Depth-first search) & 22.4 (Topological sort), pp. 603-615
+    // Introduction to Algorithms (3rd ed.), The MIT Press, ISBN 978-0-262-03384-8
+    //
+    // DFS(G)
+    // 1 for each vertex u ∈ G,V
+    // 2     u.color = WHITE  (not yet visited)
+    // 3     u.π = NIL
+    // 4 time = 0
+    // 5 for each vertex u ∈ G,V
+    // 6     if u.color == WHITE
+    // 7         DFS-VISIT(G,u)
+    //
+    // DFS-VISIT(G,u)
+    // 1 time = time + 1  (white vertex u has just been discovered)
+    // 2 u.d = time
+    // 3 u.color = GRAY  (visited, in progress)
+    // 4 for each v ∈ G.Adj[u]  (explore edge (u,v))
+    // 5     if v.color == WHITE
+    // 6         v.π = u
+    // 7         DFS-VISIT(G,v)
+    // 8 u.color = BLACK  (blacken u; it is finished)
+    // 9 time = time + 1
+    // 10 u.f = time
+    //
+    // TOPOLOGICAL-SORT(G)
+    // 1 call DFS(G) to compute finishing times v.f for each vertex v
+    // 2 as each vertex is finished, insert it onto front of a linked list
+    // 3 return the linked list of vertices
+    let buildOrder = []; // list of ordered vertices--don't need linked list because
+    // we just want relative ordering
+    const missingDependencies = [];
+    const itemsToBePatched = {};
+    const verticesToVisit = {};
+    const vertexType = {};
+    templates.forEach(function (template) {
+        verticesToVisit[template.itemId] = ESortVisitState.NotYetVisited;
+        vertexType[template.itemId] =
+            template.item?.typeKeywords &&
+                template.item.typeKeywords.includes("View Service")
+                ? "View Service"
+                : template.item?.tags && template.item.tags.includes("Location Tracking Group")
+                    ? "Location Tracking Group" : template.type;
+    });
+    // Algorithm visits each vertex once. Don't need to record times or "from' nodes ("π" in pseudocode)
+    templates.forEach(function (template) {
+        if (verticesToVisit[template.itemId] === ESortVisitState.NotYetVisited) {
+            // if not yet visited
+            visit(template.itemId);
+        }
+    });
+    // Visit vertex
+    function visit(vertexId) {
+        verticesToVisit[vertexId] = ESortVisitState.InProgress; // visited, in progress
+        // Visit dependents if not already visited; template has to be in templates list because calls to visit()
+        // are based on verticiesToVisit[], which is initialized using the templates list
+        const template = findTemplateInList(templates, vertexId);
+        // There are two sources of dependencies
+        const dependencies = (template.dependencies || []).concat(getProp(template, "properties.syncViews") || []);
+        dependencies.forEach(function (dependencyId) {
+            if (verticesToVisit[dependencyId] === ESortVisitState.NotYetVisited) {
+                // if not yet visited
+                visit(dependencyId);
+            }
+            else if (verticesToVisit[dependencyId] === ESortVisitState.InProgress) {
+                // visited, in progress, therefore a cycle
+                // save the dependency that needs to be patched
+                if (itemsToBePatched[vertexId]) {
+                    itemsToBePatched[vertexId].push(dependencyId);
+                }
+                else {
+                    itemsToBePatched[vertexId] = [dependencyId];
+                }
+            }
+            else if (verticesToVisit[dependencyId] !== ESortVisitState.Finished) {
+                /* istanbul ignore else */
+                if (missingDependencies.indexOf(dependencyId) < 0) {
+                    missingDependencies.push(dependencyId);
+                }
+            }
+        });
+        verticesToVisit[vertexId] = ESortVisitState.Finished;
+        buildOrder.push(vertexId); // add to end of list of ordered vertices because we want dependents first
+    }
+    // Two special circumstances to deal with
+    // 1) Location Tracking Group needs to be created before its associated view because the groupId is used in the view name
+    //    - Move tracking groups to the front of the list
+    // 2) Feature Services need to be created before views that rely on them
+    //    - Move all of the feature services to the beginning of the build order while maintaining their relative ordering
+    //    - Distinguish between base feature services and view feature services
+    const trackerGroupIds = [];
+    const fsIds = [];
+    const fsViewIds = [];
+    const otherIds = [];
+    do {
+        const id = buildOrder.shift();
+        if (id) {
+            if (vertexType[id] === "Location Tracking Group") {
+                trackerGroupIds.push(id);
+            }
+            else if (vertexType[id] === "Feature Service") {
+                fsIds.push(id);
+            }
+            else if (vertexType[id] === "View Service") {
+                fsViewIds.push(id);
+            }
+            else {
+                otherIds.push(id);
+            }
+        }
+    } while (buildOrder.length > 0);
+    buildOrder = trackerGroupIds.concat(fsIds, fsViewIds, otherIds);
+    const orderingResults = {
+        buildOrder: buildOrder,
+        missingDependencies: missingDependencies,
+        itemsToBePatched: itemsToBePatched
+    };
+    return orderingResults;
+}
+/**
+ * A visit flag used in the topological sort algorithm.
+ *
+ * @private
+ */
+var ESortVisitState;
+(function (ESortVisitState) {
+    /** not yet visited */
+    ESortVisitState[ESortVisitState["NotYetVisited"] = 0] = "NotYetVisited";
+    /** visited, in progress */
+    ESortVisitState[ESortVisitState["InProgress"] = 1] = "InProgress";
+    /** finished */
+    ESortVisitState[ESortVisitState["Finished"] = 2] = "Finished"; // BLACK
+})(ESortVisitState || (ESortVisitState = {}));
 //# sourceMappingURL=dependencies.js.map