@esri/solution-common 6.1.3 → 6.1.5

package/dist/esm/deleteHelpers/index.js

@@ -0,0 +1,23 @@
+/** @license
+ * Copyright 2020 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.
+ */
+export * from "./deleteEmptyGroups";
+export * from "./deleteGroupIfEmpty";
+export * from "./deleteSolutionFolder";
+export * from "./deleteSolutionItem";
+export * from "./reconstructBuildOrderIds";
+export * from "./removeItems";
+export * from "./reportProgress";
+//# sourceMappingURL=index.js.map

package/dist/esm/deleteHelpers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/deleteHelpers/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC"}

package/dist/esm/deleteHelpers/reconstructBuildOrderIds.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 reconstructBuildOrderIds
+ */
+import { IItemTemplate } from "../interfaces";
+/**
+ * Reconstructs the build order of a set of templates.
+ *
+ * @param templates A collection of AGO item templates
+ * @returns The ids of the source templates in build order, which is not necessarily the same
+ * as the build order used to create the template Solution
+ */
+export declare function reconstructBuildOrderIds(templates: IItemTemplate[]): string[];

package/dist/esm/deleteHelpers/reconstructBuildOrderIds.js

@@ -0,0 +1,29 @@
+/** @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 * as dependencies from "../dependencies";
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Reconstructs the build order of a set of templates.
+ *
+ * @param templates A collection of AGO item templates
+ * @returns The ids of the source templates in build order, which is not necessarily the same
+ * as the build order used to create the template Solution
+ */
+export function reconstructBuildOrderIds(templates) {
+    const buildOrdering = dependencies.topologicallySortItems(templates);
+    return buildOrdering.buildOrder;
+}
+//# sourceMappingURL=reconstructBuildOrderIds.js.map

package/dist/esm/deleteHelpers/reconstructBuildOrderIds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reconstructBuildOrderIds.js","sourceRoot":"","sources":["../../../src/deleteHelpers/reconstructBuildOrderIds.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAMH,OAAO,KAAK,YAAY,MAAM,iBAAiB,CAAC;AAEhD,wHAAwH;AAExH;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB,CAAC,SAA0B;IACjE,MAAM,aAAa,GAAmB,YAAY,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;IACrF,OAAO,aAAa,CAAC,UAAU,CAAC;AAClC,CAAC"}

package/dist/esm/deleteHelpers/removeItems.d.ts

@@ -0,0 +1,35 @@
+/** @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 removeItems
+ */
+import { IDeleteSolutionOptions, ISolutionPrecis } from "../interfaces";
+import { UserSession } from "../arcgisRestJS";
+/**
+ * Removes a list of items starting from the end.
+ *
+ * @param itemIds List of ids of items to remove
+ * @param hubSiteItemIds List of ids in itemIds that are for Hub Sites
+ * @param authentication Credentials for the request
+ * @param percentDone Percent done in range 0 to 100
+ * @param progressPercentStep Amount that percentDone changes for each item deleted
+ * @param solutionDeletedSummary Solution summary containing items successfully deleted
+ * @param solutionFailureSummary Solution summary containing items that could not be deleted
+ * @param deleteOptions 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) will not be in either list.
+ */
+export declare function removeItems(solutionSummary: ISolutionPrecis, hubSiteItemIds: string[], authentication: UserSession, percentDone: number, progressPercentStep: number, deleteOptions?: IDeleteSolutionOptions): Promise<ISolutionPrecis[]>;

package/dist/esm/deleteHelpers/removeItems.js

@@ -0,0 +1,111 @@
+/** @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 removeItems
+ */
+import { EItemProgressStatus } from "../interfaces";
+import * as reportProgress from "./reportProgress";
+import * as hubSites from "@esri/hub-sites";
+import { unprotectItem } from "../arcgisRestJS";
+import { removeItem } from "../restHelpers";
+import * as workflowHelpers from "../workflowHelpers";
+import { createHubRequestOptions } from "../create-hub-request-options";
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Removes a list of items starting from the end.
+ *
+ * @param itemIds List of ids of items to remove
+ * @param hubSiteItemIds List of ids in itemIds that are for Hub Sites
+ * @param authentication Credentials for the request
+ * @param percentDone Percent done in range 0 to 100
+ * @param progressPercentStep Amount that percentDone changes for each item deleted
+ * @param solutionDeletedSummary Solution summary containing items successfully deleted
+ * @param solutionFailureSummary Solution summary containing items that could not be deleted
+ * @param deleteOptions 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) will not be in either list.
+ */
+export function removeItems(solutionSummary, hubSiteItemIds, authentication, percentDone, progressPercentStep, deleteOptions = {}) {
+    let solutionDeletedSummary;
+    let solutionFailureSummary;
+    const itemToDelete = solutionSummary.items.shift();
+    const percentDoneReport = percentDone + progressPercentStep * (solutionSummary.items.length + 1);
+    if (itemToDelete) {
+        // On to next item in list
+        return removeItems(solutionSummary, hubSiteItemIds, authentication, percentDone, progressPercentStep, deleteOptions)
+            .then((results) => {
+            // Done with subsequent items in list; now delete the current item
+            [solutionDeletedSummary, solutionFailureSummary] = results;
+            // Remove any delete protection on item
+            return unprotectItem({
+                id: itemToDelete.id,
+                authentication: authentication,
+            });
+        })
+            .then(async () => {
+            // Delete the item
+            if (hubSiteItemIds.includes(itemToDelete.id)) {
+                const options = await createHubRequestOptions(authentication);
+                return hubSites.removeSite(itemToDelete.id, options);
+            }
+            else if (itemToDelete.type === "Workflow") {
+                const workflowBaseUrl = await workflowHelpers.getWorkflowBaseURL(authentication);
+                return workflowHelpers.deleteWorkflowItem(itemToDelete.id, workflowBaseUrl, authentication);
+            }
+            else {
+                return removeItem(itemToDelete.id, authentication);
+            }
+        })
+            .then(() => {
+            // Successful deletion
+            solutionDeletedSummary.items.push(itemToDelete);
+            reportProgress.reportProgress(percentDoneReport, deleteOptions, itemToDelete.id, EItemProgressStatus.Finished);
+            return [solutionDeletedSummary, solutionFailureSummary];
+        })
+            .catch((error) => {
+            const errorMessage = error.error?.message || error.message;
+            if (errorMessage && errorMessage.includes("Item does not exist or is inaccessible")) {
+                // Filter out errors where the item doesn't exist, such as from a previous delete attempt
+                reportProgress.reportProgress(percentDoneReport, deleteOptions, itemToDelete.id, EItemProgressStatus.Ignored);
+            }
+            else {
+                // Otherwise, we have a real delete error, including where AGO simply returns "success: false"
+                solutionFailureSummary.items.push(itemToDelete);
+                reportProgress.reportProgress(percentDoneReport, deleteOptions, itemToDelete.id, EItemProgressStatus.Failed);
+            }
+            return [solutionDeletedSummary, solutionFailureSummary];
+        });
+    }
+    else {
+        // We've exhausted our list of items; start building up the lists of results
+        solutionDeletedSummary = {
+            id: solutionSummary.id,
+            title: solutionSummary.title,
+            folder: solutionSummary.folder,
+            items: [],
+            groups: [],
+        };
+        solutionFailureSummary = {
+            id: solutionSummary.id,
+            title: solutionSummary.title,
+            folder: solutionSummary.folder,
+            items: [],
+            groups: [],
+        };
+        return Promise.resolve([solutionDeletedSummary, solutionFailureSummary]);
+    }
+}
+//# sourceMappingURL=removeItems.js.map

package/dist/esm/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,OAAO,EAAE,mBAAmB,EAA2C,MAAM,eAAe,CAAC;AAC7F,OAAO,KAAK,cAAc,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAe,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,eAAe,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAExE,wHAAwH;AAExH;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,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,aAAa,CAAC;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,uBAAuB,CAAC,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,UAAU,CAAC,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,mBAAmB,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,mBAAmB,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,mBAAmB,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"}

package/dist/esm/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/esm/deleteHelpers/reportProgress.js

@@ -0,0 +1,42 @@
+/** @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, SItemProgressStatus } 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 function reportProgress(percentDone, deleteOptions, deletedItemId = "", status = 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 ?? "", SItemProgressStatus[status], iPercentDone + "%");
+    }
+}
+//# sourceMappingURL=reportProgress.js.map

package/dist/esm/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,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAA0B,MAAM,eAAe,CAAC;AAEjG,wHAAwH;AAExH;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAC5B,WAAmB,EACnB,aAAqC,EACrC,aAAa,GAAG,EAAE,EAClB,MAAM,GAAG,mBAAmB,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,mBAAmB,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,GAAG,CAAC,CAAC;KACpH;AACH,CAAC"}

package/dist/esm/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/esm/deleteSolution.js

@@ -0,0 +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);
+}
+//# sourceMappingURL=deleteSolution.js.map

package/dist/esm/deleteSolution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteSolution.js","sourceRoot":"","sources":["../../src/deleteSolution.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAWH,OAAO,KAAK,sBAAsB,MAAM,wCAAwC,CAAC;AACjF,OAAO,KAAK,wBAAwB,MAAM,4BAA4B,CAAC;AAEvE,wHAAwH;AAExH;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,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;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,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"}

package/dist/esm/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;