@esri/solution-common 6.1.3 → 6.1.5

package/dist/cjs/deleteHelpers/removeItems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"removeItems.js","sourceRoot":"","sources":["../../../src/deleteHelpers/removeItems.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AAEH;;GAEG;AAEH,8CAA6F;AAC7F,yEAAmD;AACnD,kEAA4C;AAC5C,kDAA6D;AAC7D,gDAA4C;AAC5C,4EAAsD;AACtD,8EAAwE;AAExE,wHAAwH;AAExH;;;;;;;;;;;;;GAaG;AACH,SAAgB,WAAW,CACzB,eAAgC,EAChC,cAAwB,EACxB,cAA2B,EAC3B,WAAmB,EACnB,mBAA2B,EAC3B,gBAAwC,EAAE;IAE1C,IAAI,sBAAuC,CAAC;IAC5C,IAAI,sBAAuC,CAAC;IAC5C,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACnD,MAAM,iBAAiB,GAAG,WAAW,GAAG,mBAAmB,GAAG,CAAC,eAAe,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAEjG,IAAI,YAAY,EAAE;QAChB,0BAA0B;QAC1B,OAAO,WAAW,CAAC,eAAe,EAAE,cAAc,EAAE,cAAc,EAAE,WAAW,EAAE,mBAAmB,EAAE,aAAa,CAAC;aACjH,IAAI,CAAC,CAAC,OAA0B,EAAE,EAAE;YACnC,kEAAkE;YAClE,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,GAAG,OAAO,CAAC;YAE3D,uCAAuC;YACvC,OAAO,IAAA,4BAAa,EAAC;gBACnB,EAAE,EAAE,YAAY,CAAC,EAAE;gBACnB,cAAc,EAAE,cAAc;aAC/B,CAAC,CAAC;QACL,CAAC,CAAC;aACD,IAAI,CAAC,KAAK,IAAI,EAAE;YACf,kBAAkB;YAClB,IAAI,cAAc,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE;gBAC5C,MAAM,OAAO,GAAG,MAAM,IAAA,oDAAuB,EAAC,cAAc,CAAC,CAAC;gBAC9D,OAAO,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;aACtD;iBAAM,IAAI,YAAY,CAAC,IAAI,KAAK,UAAU,EAAE;gBAC3C,MAAM,eAAe,GAAG,MAAM,eAAe,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;gBACjF,OAAO,eAAe,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE,EAAE,eAAe,EAAE,cAAc,CAAC,CAAC;aAC7F;iBAAM;gBACL,OAAO,IAAA,wBAAU,EAAC,YAAY,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;aACpD;QACH,CAAC,CAAC;aACD,IAAI,CAAC,GAAG,EAAE;YACT,sBAAsB;YACtB,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAChD,cAAc,CAAC,cAAc,CAAC,iBAAiB,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,EAAE,gCAAmB,CAAC,QAAQ,CAAC,CAAC;YAC/G,OAAO,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,CAAC;QAC1D,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,EAAE,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC;YAC3D,IAAI,YAAY,IAAI,YAAY,CAAC,QAAQ,CAAC,wCAAwC,CAAC,EAAE;gBACnF,yFAAyF;gBACzF,cAAc,CAAC,cAAc,CAAC,iBAAiB,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,EAAE,gCAAmB,CAAC,OAAO,CAAC,CAAC;aAC/G;iBAAM;gBACL,8FAA8F;gBAC9F,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAChD,cAAc,CAAC,cAAc,CAAC,iBAAiB,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,EAAE,gCAAmB,CAAC,MAAM,CAAC,CAAC;aAC9G;YACD,OAAO,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;KACN;SAAM;QACL,4EAA4E;QAC5E,sBAAsB,GAAG;YACvB,EAAE,EAAE,eAAe,CAAC,EAAE;YACtB,KAAK,EAAE,eAAe,CAAC,KAAK;YAC5B,MAAM,EAAE,eAAe,CAAC,MAAM;YAC9B,KAAK,EAAE,EAAE;YACT,MAAM,EAAE,EAAE;SACX,CAAC;QACF,sBAAsB,GAAG;YACvB,EAAE,EAAE,eAAe,CAAC,EAAE;YACtB,KAAK,EAAE,eAAe,CAAC,KAAK;YAC5B,MAAM,EAAE,eAAe,CAAC,MAAM;YAC9B,KAAK,EAAE,EAAE;YACT,MAAM,EAAE,EAAE;SACX,CAAC;QACF,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,CAAC,CAAC;KAC1E;AACH,CAAC;AA1ED,kCA0EC"}

package/dist/cjs/deleteHelpers/reportProgress.d.ts

@@ -0,0 +1,27 @@
+/** @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.
+ */
+/**
+ * @module reportProgress
+ */
+import { EItemProgressStatus, IDeleteSolutionOptions } from "../interfaces";
+/**
+ * Reports progress as specified via options.
+ *
+ * @param percentDone Percent done in range 0 to 100
+ * @param deleteOptions Reporting options
+ * @param deletedItemId Id of item deleted
+ */
+export declare function reportProgress(percentDone: number, deleteOptions: IDeleteSolutionOptions, deletedItemId?: string, status?: EItemProgressStatus): void;

package/dist/cjs/deleteHelpers/reportProgress.js

@@ -0,0 +1,46 @@
+"use strict";
+/** @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reportProgress = void 0;
+/**
+ * @module reportProgress
+ */
+const interfaces_1 = require("../interfaces");
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Reports progress as specified via options.
+ *
+ * @param percentDone Percent done in range 0 to 100
+ * @param deleteOptions Reporting options
+ * @param deletedItemId Id of item deleted
+ */
+function reportProgress(percentDone, deleteOptions, deletedItemId = "", status = interfaces_1.EItemProgressStatus.Started) {
+    const iPercentDone = Math.round(percentDone);
+    /* istanbul ignore else */
+    if (deleteOptions.progressCallback) {
+        deleteOptions.progressCallback(iPercentDone, deleteOptions.jobId, {
+            event: "",
+            data: deletedItemId,
+        });
+    }
+    /* istanbul ignore else */
+    if (deleteOptions.consoleProgress) {
+        console.log(Date.now(), deletedItemId, deleteOptions.jobId ?? "", interfaces_1.SItemProgressStatus[status], iPercentDone + "%");
+    }
+}
+exports.reportProgress = reportProgress;
+//# sourceMappingURL=reportProgress.js.map

package/dist/cjs/deleteHelpers/reportProgress.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reportProgress.js","sourceRoot":"","sources":["../../../src/deleteHelpers/reportProgress.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;GAEG;AAEH,8CAAiG;AAEjG,wHAAwH;AAExH;;;;;;GAMG;AACH,SAAgB,cAAc,CAC5B,WAAmB,EACnB,aAAqC,EACrC,aAAa,GAAG,EAAE,EAClB,MAAM,GAAG,gCAAmB,CAAC,OAAO;IAEpC,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAE7C,0BAA0B;IAC1B,IAAI,aAAa,CAAC,gBAAgB,EAAE;QAClC,aAAa,CAAC,gBAAgB,CAAC,YAAY,EAAE,aAAa,CAAC,KAAK,EAAE;YAChE,KAAK,EAAE,EAAE;YACT,IAAI,EAAE,aAAa;SACpB,CAAC,CAAC;KACJ;IAED,0BAA0B;IAC1B,IAAI,aAAa,CAAC,eAAe,EAAE;QACjC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,IAAI,EAAE,EAAE,gCAAmB,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,GAAG,CAAC,CAAC;KACpH;AACH,CAAC;AApBD,wCAoBC"}

package/dist/cjs/deleteSolution.d.ts

@@ -0,0 +1,56 @@
+/** @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.
+ */
+/**
+ * Provides a function for deleting a deployed Solution item and all of the items that were created
+ * as part of that deployment.
+ *
+ * @module deleteSolution
+ */
+import { IDeleteSolutionOptions, IItemTemplate, ISolutionPrecis } from "./interfaces";
+import { UserSession } from "./arcgisRestJS";
+/**
+ * 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 declare function deleteSolution(solutionItemId: string, authentication: UserSession, options?: IDeleteSolutionOptions): Promise<ISolutionPrecis[]>;
+/**
+ * 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 declare function deleteSolutionByComponents(solutionItemId: string, itemIds: string[], templates: IItemTemplate[], templateDictionary: any, authentication: UserSession, options?: IDeleteSolutionOptions): Promise<ISolutionPrecis[]>;

package/dist/cjs/deleteSolution.js

@@ -0,0 +1,107 @@
+"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.deleteSolutionByComponents = exports.deleteSolution = void 0;
+const tslib_1 = require("tslib");
+const deleteSolutionContents = tslib_1.__importStar(require("./deleteHelpers/deleteSolutionContents"));
+const getDeletableSolutionInfo = tslib_1.__importStar(require("./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.
+ */
+function deleteSolution(solutionItemId, authentication, options) {
+    return getDeletableSolutionInfo
+        .getDeletableSolutionInfo(solutionItemId, authentication)
+        .then((solutionSummary) => {
+        return deleteSolutionContents.deleteSolutionContents(solutionItemId, solutionSummary, authentication, options);
+    })
+        .catch(() => {
+        return [undefined, undefined];
+    });
+}
+exports.deleteSolution = deleteSolution;
+/**
+ * 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.
+ */
+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);
+}
+exports.deleteSolutionByComponents = deleteSolutionByComponents;
+//# sourceMappingURL=deleteSolution.js.map

package/dist/cjs/deleteSolution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteSolution.js","sourceRoot":"","sources":["../../src/deleteSolution.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AAWH,uGAAiF;AACjF,6FAAuE;AAEvE,wHAAwH;AAExH;;;;;;;;;;;;;GAaG;AACH,SAAgB,cAAc,CAC5B,cAAsB,EACtB,cAA2B,EAC3B,OAAgC;IAEhC,OAAO,wBAAwB;SAC5B,wBAAwB,CAAC,cAAc,EAAE,cAAc,CAAC;SACxD,IAAI,CAAC,CAAC,eAAgC,EAAE,EAAE;QACzC,OAAO,sBAAsB,CAAC,sBAAsB,CAAC,cAAc,EAAE,eAAe,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC;IACjH,CAAC,CAAC;SACD,KAAK,CAAC,GAAG,EAAE;QACV,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;AACP,CAAC;AAbD,wCAaC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,0BAA0B,CACxC,cAAsB,EACtB,OAAiB,EACjB,SAA0B,EAC1B,kBAAuB,EACvB,cAA2B,EAC3B,OAAgC;IAEhC,sHAAsH;IACtH,MAAM,eAAe,GAAoB;QACvC,EAAE,EAAE,cAAc;QAClB,KAAK,EAAE,EAAE;QACT,MAAM,EAAE,kBAAkB,CAAC,QAAQ;QACnC,KAAK,EAAE,EAA2B;QAClC,MAAM,EAAE,EAAc;KACvB,CAAC;IAEF,uEAAuE;IACvE,IAAI,SAAS,GAAG,SAAS;SACtB,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChB,OAAO;YACL,EAAE,EAAE,QAAQ,CAAC,MAAM;YACnB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK;YAC1B,QAAQ,EAAE,CAAC;YACX,KAAK,EAAE,EAAE;SACa,CAAC;IAC3B,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QACf,OAAO,CAAC,EAAE,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC;QACnD,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAErC,0CAA0C;IAC1C,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAExE,iEAAiE;IACjE,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;IAEpG,kCAAkC;IAClC,SAAS,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC5B,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,EAAE;YAC5B,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;SACzC;aAAM;YACL,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACrC;IACH,CAAC,CAAC,CAAC;IAEH,sBAAsB;IACtB,OAAO,sBAAsB,CAAC,sBAAsB,CAAC,cAAc,EAAE,eAAe,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC;AACjH,CAAC;AAnDD,gEAmDC"}

package/dist/cjs/dependencies.d.ts

@@ -0,0 +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;

package/dist/cjs/dependencies.js

@@ -0,0 +1,171 @@
+"use strict";
+/** @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.topologicallySortItems = void 0;
+/**
+ * Provides common functions for organizing dependencies among items.
+ *
+ * @module dependencies
+ */
+const generalHelpers_1 = require("./generalHelpers");
+const templatization_1 = require("./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.
+ */
+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 = (0, templatization_1.findTemplateInList)(templates, vertexId);
+        // There are two sources of dependencies
+        const dependencies = (template.dependencies || []).concat((0, generalHelpers_1.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;
+}
+exports.topologicallySortItems = topologicallySortItems;
+/**
+ * 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";
+})(ESortVisitState || (ESortVisitState = {}));
+//# sourceMappingURL=dependencies.js.map

package/dist/cjs/dependencies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dependencies.js","sourceRoot":"","sources":["../../src/dependencies.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;;;GAIG;AAEH,qDAA2C;AAE3C,qDAAsD;AAEtD,wHAAwH;AAExH;;;;;;;;GAQG;AACH,SAAgB,sBAAsB,CAAC,SAA0B;IAC/D,sFAAsF;IACtF,4EAA4E;IAC5E,8EAA8E;IAC9E,EAAE;IACF,SAAS;IACT,4BAA4B;IAC5B,2CAA2C;IAC3C,kBAAkB;IAClB,aAAa;IACb,4BAA4B;IAC5B,4BAA4B;IAC5B,2BAA2B;IAC3B,EAAE;IACF,iBAAiB;IACjB,+DAA+D;IAC/D,eAAe;IACf,2CAA2C;IAC3C,gDAAgD;IAChD,4BAA4B;IAC5B,oBAAoB;IACpB,2BAA2B;IAC3B,iDAAiD;IACjD,oBAAoB;IACpB,gBAAgB;IAChB,EAAE;IACF,sBAAsB;IACtB,iEAAiE;IACjE,sEAAsE;IACtE,uCAAuC;IAEvC,IAAI,UAAU,GAAa,EAAE,CAAC,CAAC,2DAA2D;IAC1F,iCAAiC;IACjC,MAAM,mBAAmB,GAAa,EAAE,CAAC;IACzC,MAAM,gBAAgB,GAAyB,EAAE,CAAC;IAElD,MAAM,eAAe,GAAgB,EAAE,CAAC;IACxC,MAAM,UAAU,GAAgB,EAAE,CAAC;IACnC,SAAS,CAAC,OAAO,CAAC,UAAU,QAAQ;QAClC,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC,aAAa,CAAC;QACjE,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC;YACzB,QAAQ,CAAC,IAAI,EAAE,YAAY,IAAI,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,cAAc,CAAC;gBAChF,CAAC,CAAC,cAAc;gBAChB,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC;oBAC7E,CAAC,CAAC,yBAAyB;oBAC3B,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,oGAAoG;IACpG,SAAS,CAAC,OAAO,CAAC,UAAU,QAAQ;QAClC,IAAI,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,eAAe,CAAC,aAAa,EAAE;YACtE,qBAAqB;YACrB,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SACxB;IACH,CAAC,CAAC,CAAC;IAEH,eAAe;IACf,SAAS,KAAK,CAAC,QAAgB;QAC7B,eAAe,CAAC,QAAQ,CAAC,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC,uBAAuB;QAE/E,yGAAyG;QACzG,iFAAiF;QACjF,MAAM,QAAQ,GAAG,IAAA,mCAAkB,EAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAEzD,wCAAwC;QACxC,MAAM,YAAY,GAAa,CAAC,QAAQ,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,MAAM,CACjE,IAAA,wBAAO,EAAC,QAAQ,EAAE,sBAAsB,CAAC,IAAI,EAAE,CAChD,CAAC;QAEF,YAAY,CAAC,OAAO,CAAC,UAAU,YAAY;YACzC,IAAI,eAAe,CAAC,YAAY,CAAC,KAAK,eAAe,CAAC,aAAa,EAAE;gBACnE,qBAAqB;gBACrB,KAAK,CAAC,YAAY,CAAC,CAAC;aACrB;iBAAM,IAAI,eAAe,CAAC,YAAY,CAAC,KAAK,eAAe,CAAC,UAAU,EAAE;gBACvE,0CAA0C;gBAC1C,+CAA+C;gBAC/C,IAAI,gBAAgB,CAAC,QAAQ,CAAC,EAAE;oBAC9B,gBAAgB,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;iBAC/C;qBAAM;oBACL,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;iBAC7C;aACF;iBAAM,IAAI,eAAe,CAAC,YAAY,CAAC,KAAK,eAAe,CAAC,QAAQ,EAAE;gBACrE,0BAA0B;gBAC1B,IAAI,mBAAmB,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;oBACjD,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;iBACxC;aACF;QACH,CAAC,CAAC,CAAC;QAEH,eAAe,CAAC,QAAQ,CAAC,GAAG,eAAe,CAAC,QAAQ,CAAC;QACrD,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,0EAA0E;IACvG,CAAC;IAED,yCAAyC;IACzC,yHAAyH;IACzH,qDAAqD;IACrD,wEAAwE;IACxE,sHAAsH;IACtH,2EAA2E;IAC3E,MAAM,eAAe,GAAa,EAAE,CAAC;IACrC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,GAAG;QACD,MAAM,EAAE,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC;QAC9B,IAAI,EAAE,EAAE;YACN,IAAI,UAAU,CAAC,EAAE,CAAC,KAAK,yBAAyB,EAAE;gBAChD,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aAC1B;iBAAM,IAAI,UAAU,CAAC,EAAE,CAAC,KAAK,iBAAiB,EAAE;gBAC/C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aAChB;iBAAM,IAAI,UAAU,CAAC,EAAE,CAAC,KAAK,cAAc,EAAE;gBAC5C,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aACpB;iBAAM;gBACL,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aACnB;SACF;KACF,QAAQ,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;IAChC,UAAU,GAAG,eAAe,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAEhE,MAAM,eAAe,GAAmB;QACtC,UAAU,EAAE,UAAU;QACtB,mBAAmB,EAAE,mBAAmB;QACxC,gBAAgB,EAAE,gBAAgB;KACnC,CAAC;IACF,OAAO,eAAe,CAAC;AACzB,CAAC;AA7HD,wDA6HC;AA4BD;;;;GAIG;AACH,IAAK,eAOJ;AAPD,WAAK,eAAe;IAClB,sBAAsB;IACtB,uEAAa,CAAA;IACb,2BAA2B;IAC3B,iEAAU,CAAA;IACV,eAAe;IACf,6DAAQ,CAAA;AACV,CAAC,EAPI,eAAe,KAAf,eAAe,QAOnB"}