@esri/solution-common 6.1.3 → 6.1.4

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

@@ -0,0 +1,39 @@
+/** @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 { UserSession } from "../arcgisRestJS";
+import { IDeleteSolutionOptions, ISolutionPrecis } from "../interfaces";
+/**
+ * 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 solutionSummary List of items in the solution that would be deleted
+ * @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 deleteSolutionContents(solutionItemId: string, solutionSummary: ISolutionPrecis, authentication: UserSession, options?: IDeleteSolutionOptions): Promise<ISolutionPrecis[]>;

package/dist/cjs/deleteHelpers/deleteSolutionContents.js

@@ -0,0 +1,127 @@
+"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.deleteSolutionContents = void 0;
+const tslib_1 = require("tslib");
+const interfaces_1 = require("../interfaces");
+const deleteEmptyGroups = tslib_1.__importStar(require("./deleteEmptyGroups"));
+const deleteSolutionFolder = tslib_1.__importStar(require("./deleteSolutionFolder"));
+const deleteSolutionItem = tslib_1.__importStar(require("./deleteSolutionItem"));
+const removeItems = tslib_1.__importStar(require("./removeItems"));
+const reportProgress = tslib_1.__importStar(require("./reportProgress"));
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * 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 solutionSummary List of items in the solution that would be deleted
+ * @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 deleteSolutionContents(solutionItemId, solutionSummary, authentication, options) {
+    const deleteOptions = options || {};
+    let progressPercentStep = 0;
+    let percentDone = 0;
+    let solutionDeletedSummary;
+    let solutionFailureSummary;
+    let solutionIds = [];
+    return new Promise((resolve) => {
+        let removalPromise = Promise.resolve([
+            {
+                id: solutionSummary.id,
+                title: solutionSummary.title,
+                folder: solutionSummary.folder,
+                items: [],
+                groups: [],
+            },
+            {
+                id: solutionSummary.id,
+                title: solutionSummary.title,
+                folder: solutionSummary.folder,
+                items: [],
+                groups: [],
+            },
+        ]);
+        if (solutionSummary.items.length > 0) {
+            // Save a copy of the Solution item ids for the deleteSolutionFolder call because removeItems
+            // destroys the solutionSummary.items list
+            if (solutionItemId) {
+                solutionIds = solutionSummary.items.map((item) => item.id).concat([solutionItemId]);
+            }
+            const hubSiteItemIds = solutionSummary.items
+                .filter((item) => item.type === "Hub Site Application")
+                .map((item) => item.id);
+            // Delete the items
+            progressPercentStep = 100 / (solutionSummary.items.length + 2); // one extra for starting plus one extra for solution itself
+            reportProgress.reportProgress((percentDone += progressPercentStep), deleteOptions); // let the caller know that we've started
+            // Proceed with the deletion
+            removalPromise = removeItems.removeItems(solutionSummary, hubSiteItemIds, authentication, percentDone, progressPercentStep, deleteOptions);
+        }
+        removalPromise
+            .then((results) => {
+            [solutionDeletedSummary, solutionFailureSummary] = results;
+            // Attempt to delete groups; we won't be checking success
+            return new Promise((resolve2) => {
+                // eslint-disable-next-line @typescript-eslint/no-floating-promises
+                deleteEmptyGroups.deleteEmptyGroups(solutionSummary.groups, authentication).then(() => {
+                    resolve2(results);
+                });
+            });
+        })
+            .then(() => {
+            if (solutionItemId) {
+                // If there were no failed deletes, it's OK to delete Solution item
+                if (solutionFailureSummary.items.length === 0) {
+                    return deleteSolutionItem.deleteSolutionItem(solutionItemId, authentication);
+                }
+                else {
+                    // Not all items were deleted, so don't delete solution
+                    return Promise.resolve({ success: false, itemId: solutionItemId });
+                }
+            }
+            else {
+                return Promise.resolve({ success: true, itemId: "" });
+            }
+        })
+            .then((solutionItemDeleteStatus) => {
+            // If all deletes succeeded, see if we can delete the folder that contained them
+            if (solutionItemDeleteStatus.success) {
+                reportProgress.reportProgress(99, deleteOptions, solutionItemId, interfaces_1.EItemProgressStatus.Finished);
+                // Can't delete if folder contains non-solution items
+                return deleteSolutionFolder.deleteSolutionFolder(solutionIds, solutionSummary.folder, authentication);
+            }
+            else {
+                return Promise.resolve(false);
+            }
+        })
+            .then(() => {
+            resolve([solutionDeletedSummary, solutionFailureSummary]);
+        })
+            .catch(() => {
+            resolve([solutionDeletedSummary, solutionFailureSummary]);
+        });
+    });
+}
+exports.deleteSolutionContents = deleteSolutionContents;
+//# sourceMappingURL=deleteSolutionContents.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deleteSolutionContents.js","sourceRoot":"","sources":["../../../src/deleteHelpers/deleteSolutionContents.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AASH,8CAA8G;AAC9G,+EAAyD;AACzD,qFAA+D;AAC/D,iFAA2D;AAC3D,mEAA6C;AAC7C,yEAAmD;AAEnD,wHAAwH;AAExH;;;;;;;;;;;;;;GAcG;AACH,SAAgB,sBAAsB,CACpC,cAAsB,EACtB,eAAgC,EAChC,cAA2B,EAC3B,OAAgC;IAEhC,MAAM,aAAa,GAA2B,OAAO,IAAI,EAAE,CAAC;IAC5D,IAAI,mBAAmB,GAAG,CAAC,CAAC;IAC5B,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,IAAI,sBAAuC,CAAC;IAC5C,IAAI,sBAAuC,CAAC;IAC5C,IAAI,WAAW,GAAG,EAAc,CAAC;IAEjC,OAAO,IAAI,OAAO,CAAoB,CAAC,OAAO,EAAE,EAAE;QAChD,IAAI,cAAc,GAA+B,OAAO,CAAC,OAAO,CAAC;YAC/D;gBACE,EAAE,EAAE,eAAe,CAAC,EAAE;gBACtB,KAAK,EAAE,eAAe,CAAC,KAAK;gBAC5B,MAAM,EAAE,eAAe,CAAC,MAAM;gBAC9B,KAAK,EAAE,EAAE;gBACT,MAAM,EAAE,EAAE;aACX;YACD;gBACE,EAAE,EAAE,eAAe,CAAC,EAAE;gBACtB,KAAK,EAAE,eAAe,CAAC,KAAK;gBAC5B,MAAM,EAAE,eAAe,CAAC,MAAM;gBAC9B,KAAK,EAAE,EAAE;gBACT,MAAM,EAAE,EAAE;aACX;SACmB,CAAC,CAAC;QAExB,IAAI,eAAe,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YACpC,6FAA6F;YAC7F,0CAA0C;YAC1C,IAAI,cAAc,EAAE;gBAClB,WAAW,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;aACrF;YAED,MAAM,cAAc,GAAa,eAAe,CAAC,KAAK;iBACnD,MAAM,CAAC,CAAC,IAAS,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,sBAAsB,CAAC;iBAC3D,GAAG,CAAC,CAAC,IAAS,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAE/B,mBAAmB;YACnB,mBAAmB,GAAG,GAAG,GAAG,CAAC,eAAe,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,4DAA4D;YAC5H,cAAc,CAAC,cAAc,CAAC,CAAC,WAAW,IAAI,mBAAmB,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,yCAAyC;YAE7H,4BAA4B;YAC5B,cAAc,GAAG,WAAW,CAAC,WAAW,CACtC,eAAe,EACf,cAAc,EACd,cAAc,EACd,WAAW,EACX,mBAAmB,EACnB,aAAa,CACd,CAAC;SACH;QAED,cAAc;aACX,IAAI,CAAC,CAAC,OAA0B,EAAE,EAAE;YACnC,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,GAAG,OAAO,CAAC;YAE3D,yDAAyD;YACzD,OAAO,IAAI,OAAO,CAAoB,CAAC,QAAQ,EAAE,EAAE;gBACjD,mEAAmE;gBACnE,iBAAiB,CAAC,iBAAiB,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;oBACpF,QAAQ,CAAC,OAAO,CAAC,CAAC;gBACpB,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;aACD,IAAI,CAAC,GAAG,EAAE;YACT,IAAI,cAAc,EAAE;gBAClB,mEAAmE;gBACnE,IAAI,sBAAsB,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;oBAC7C,OAAO,kBAAkB,CAAC,kBAAkB,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;iBAC9E;qBAAM;oBACL,uDAAuD;oBACvD,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC;iBACpE;aACF;iBAAM;gBACL,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;aACvD;QACH,CAAC,CAAC;aACD,IAAI,CAAC,CAAC,wBAAyC,EAAE,EAAE;YAClD,gFAAgF;YAChF,IAAI,wBAAwB,CAAC,OAAO,EAAE;gBACpC,cAAc,CAAC,cAAc,CAAC,EAAE,EAAE,aAAa,EAAE,cAAc,EAAE,gCAAmB,CAAC,QAAQ,CAAC,CAAC;gBAE/F,qDAAqD;gBACrD,OAAO,oBAAoB,CAAC,oBAAoB,CAAC,WAAW,EAAE,eAAe,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;aACvG;iBAAM;gBACL,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;aAC/B;QACH,CAAC,CAAC;aACD,IAAI,CAAC,GAAG,EAAE;YACT,OAAO,CAAC,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,CAAC,CAAC;QAC5D,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,EAAE;YACV,OAAO,CAAC,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC;AApGD,wDAoGC"}

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

@@ -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.
+ */
+/**
+ * @module deleteSolutionFolder
+ */
+import { UserSession } from "../arcgisRestJS";
+/**
+ * Deletes a deployed Solution's folder if the folder is empty.
+ *
+ * @param solutionFolderId Id of the folder of a deployed Solution
+ * @param deletedItemIds Ids in the Solution, including the Solution item; used to deal with lagging folder deletion
+ * @param authentication Credentials for the request
+ * @returns Promise that will resolve if deletion was successful and fail if any part of it failed;
+ * if the folder has a non-Solution item, it will not be deleted, but the function will return true
+ */
+export declare function deleteSolutionFolder(solutionIds: string[], folderId: string, authentication: UserSession): Promise<boolean>;

package/dist/cjs/deleteHelpers/deleteSolutionFolder.js

@@ -0,0 +1,81 @@
+"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.deleteSolutionFolder = void 0;
+/**
+ * @module deleteSolutionFolder
+ */
+const arcgisRestJS_1 = require("../arcgisRestJS");
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Deletes a deployed Solution's folder if the folder is empty.
+ *
+ * @param solutionFolderId Id of the folder of a deployed Solution
+ * @param deletedItemIds Ids in the Solution, including the Solution item; used to deal with lagging folder deletion
+ * @param authentication Credentials for the request
+ * @returns Promise that will resolve if deletion was successful and fail if any part of it failed;
+ * if the folder has a non-Solution item, it will not be deleted, but the function will return true
+ */
+function deleteSolutionFolder(solutionIds, folderId, authentication) {
+    // See if the deployment folder is empty and can be deleted; first, we need info about user
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    return authentication
+        .getUser({ authentication })
+        .then((user) => {
+        // And then we need to be sure that the folder is empty
+        const query = new arcgisRestJS_1.SearchQueryBuilder()
+            .match(authentication.username)
+            .in("owner")
+            .and()
+            .match(user.orgId)
+            .in("orgid")
+            .and()
+            .match(folderId)
+            .in("ownerfolder");
+        return (0, arcgisRestJS_1.restSearchItems)({
+            q: query,
+            authentication,
+        });
+    })
+        .then((searchResult) => {
+        // If the search results are all in the deletedItemIds list, then we're dealing with AGO lagging:
+        // successfully reporting a deletion and yet still returning the item in search results.
+        // Filter the Solution items out of the search results.
+        const nonSolutionItems = searchResult.results
+            .map((foundItem) => foundItem.id)
+            .filter((foundItemId) => !solutionIds.includes(foundItemId)); // only save non-solution items
+        // If the list is empty, then there are no non-solution items
+        if (nonSolutionItems.length === 0) {
+            // OK to delete the folder
+            return (0, arcgisRestJS_1.restRemoveFolder)({
+                folderId: folderId,
+                owner: authentication.username,
+                authentication,
+            });
+        }
+        else {
+            // A non-deployment item is in the folder, so leave it alone
+            return Promise.resolve({ success: true });
+        }
+    })
+        .then((deleteFolderResponse) => {
+        // Extract the success property
+        return deleteFolderResponse.success;
+    });
+}
+exports.deleteSolutionFolder = deleteSolutionFolder;
+//# sourceMappingURL=deleteSolutionFolder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deleteSolutionFolder.js","sourceRoot":"","sources":["../../../src/deleteHelpers/deleteSolutionFolder.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;GAEG;AAEH,kDAOyB;AAEzB,wHAAwH;AAExH;;;;;;;;GAQG;AACH,SAAgB,oBAAoB,CAClC,WAAqB,EACrB,QAAgB,EAChB,cAA2B;IAE3B,2FAA2F;IAC3F,mEAAmE;IACnE,OAAO,cAAc;SAClB,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;SAC3B,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QACb,uDAAuD;QACvD,MAAM,KAAK,GAAG,IAAI,iCAAkB,EAAE;aACnC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC;aAC9B,EAAE,CAAC,OAAO,CAAC;aACX,GAAG,EAAE;aACL,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;aACjB,EAAE,CAAC,OAAO,CAAC;aACX,GAAG,EAAE;aACL,KAAK,CAAC,QAAQ,CAAC;aACf,EAAE,CAAC,aAAa,CAAC,CAAC;QAErB,OAAO,IAAA,8BAAe,EAAC;YACrB,CAAC,EAAE,KAAK;YACR,cAAc;SACf,CAAC,CAAC;IACL,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,YAAkC,EAAE,EAAE;QAC3C,iGAAiG;QACjG,wFAAwF;QACxF,uDAAuD;QACvD,MAAM,gBAAgB,GAAG,YAAY,CAAC,OAAO;aAC1C,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;aAChC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,+BAA+B;QAE/F,6DAA6D;QAC7D,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE;YACjC,0BAA0B;YAC1B,OAAO,IAAA,+BAAgB,EAAC;gBACtB,QAAQ,EAAE,QAAQ;gBAClB,KAAK,EAAE,cAAc,CAAC,QAAQ;gBAC9B,cAAc;aACf,CAAC,CAAC;SACJ;aAAM;YACL,4DAA4D;YAC5D,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;SAC3C;IACH,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,oBAAoB,EAAE,EAAE;QAC7B,+BAA+B;QAC/B,OAAO,oBAAoB,CAAC,OAAO,CAAC;IACtC,CAAC,CAAC,CAAC;AACP,CAAC;AAnDD,oDAmDC"}

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

@@ -0,0 +1,31 @@
+/** @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.
+ *
+ * @module deleteSolutionItem
+ */
+import { IStatusResponse } 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
+ * @returns Promise that will resolve with the status of deleting the item
+ */
+export declare function deleteSolutionItem(solutionItemId: string, authentication: UserSession): Promise<IStatusResponse>;

package/dist/cjs/deleteHelpers/deleteSolutionItem.js

@@ -0,0 +1,52 @@
+"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.deleteSolutionItem = void 0;
+const arcgisRestJS_1 = require("../arcgisRestJS");
+const restHelpers_1 = require("../restHelpers");
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * 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
+ * @returns Promise that will resolve with the status of deleting the item
+ */
+function deleteSolutionItem(solutionItemId, authentication) {
+    const protectOptions = {
+        id: solutionItemId,
+        authentication,
+    };
+    return (0, arcgisRestJS_1.unprotectItem)(protectOptions)
+        .then((result) => {
+        if (result.success) {
+            return (0, restHelpers_1.removeItem)(solutionItemId, authentication);
+        }
+        else {
+            return Promise.resolve(result);
+        }
+    })
+        .then((result) => {
+        return Promise.resolve({
+            success: result.success,
+            itemId: solutionItemId,
+        });
+    });
+}
+exports.deleteSolutionItem = deleteSolutionItem;
+//# sourceMappingURL=deleteSolutionItem.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deleteSolutionItem.js","sourceRoot":"","sources":["../../../src/deleteHelpers/deleteSolutionItem.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AASH,kDAA+E;AAC/E,gDAA4C;AAE5C,wHAAwH;AAExH;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAAC,cAAsB,EAAE,cAA2B;IACpF,MAAM,cAAc,GAAqB;QACvC,EAAE,EAAE,cAAc;QAClB,cAAc;KACf,CAAC;IACF,OAAO,IAAA,4BAAa,EAAC,cAAc,CAAC;SACjC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;QACf,IAAI,MAAM,CAAC,OAAO,EAAE;YAClB,OAAO,IAAA,wBAAU,EAAC,cAAc,EAAE,cAAc,CAAC,CAAC;SACnD;aAAM;YACL,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;SAChC;IACH,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;QACf,OAAO,OAAO,CAAC,OAAO,CAAC;YACrB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,MAAM,EAAE,cAAc;SACvB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAnBD,gDAmBC"}

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

@@ -0,0 +1,22 @@
+/** @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";

package/dist/cjs/deleteHelpers/index.js

@@ -0,0 +1,26 @@
+"use strict";
+/** @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./deleteEmptyGroups"), exports);
+tslib_1.__exportStar(require("./deleteGroupIfEmpty"), exports);
+tslib_1.__exportStar(require("./deleteSolutionFolder"), exports);
+tslib_1.__exportStar(require("./deleteSolutionItem"), exports);
+tslib_1.__exportStar(require("./reconstructBuildOrderIds"), exports);
+tslib_1.__exportStar(require("./removeItems"), exports);
+tslib_1.__exportStar(require("./reportProgress"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/deleteHelpers/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,8DAAoC;AACpC,+DAAqC;AACrC,iEAAuC;AACvC,+DAAqC;AACrC,qEAA2C;AAC3C,wDAA8B;AAC9B,2DAAiC"}

package/dist/cjs/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/cjs/deleteHelpers/reconstructBuildOrderIds.js

@@ -0,0 +1,34 @@
+"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.reconstructBuildOrderIds = void 0;
+const tslib_1 = require("tslib");
+const dependencies = tslib_1.__importStar(require("../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
+ */
+function reconstructBuildOrderIds(templates) {
+    const buildOrdering = dependencies.topologicallySortItems(templates);
+    return buildOrdering.buildOrder;
+}
+exports.reconstructBuildOrderIds = reconstructBuildOrderIds;
+//# sourceMappingURL=reconstructBuildOrderIds.js.map

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

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

package/dist/cjs/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/cjs/deleteHelpers/removeItems.js

@@ -0,0 +1,116 @@
+"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.removeItems = void 0;
+const tslib_1 = require("tslib");
+/**
+ * @module removeItems
+ */
+const interfaces_1 = require("../interfaces");
+const reportProgress = tslib_1.__importStar(require("./reportProgress"));
+const hubSites = tslib_1.__importStar(require("@esri/hub-sites"));
+const arcgisRestJS_1 = require("../arcgisRestJS");
+const restHelpers_1 = require("../restHelpers");
+const workflowHelpers = tslib_1.__importStar(require("../workflowHelpers"));
+const create_hub_request_options_1 = require("../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.
+ */
+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 (0, arcgisRestJS_1.unprotectItem)({
+                id: itemToDelete.id,
+                authentication: authentication,
+            });
+        })
+            .then(async () => {
+            // Delete the item
+            if (hubSiteItemIds.includes(itemToDelete.id)) {
+                const options = await (0, create_hub_request_options_1.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 (0, restHelpers_1.removeItem)(itemToDelete.id, authentication);
+            }
+        })
+            .then(() => {
+            // Successful deletion
+            solutionDeletedSummary.items.push(itemToDelete);
+            reportProgress.reportProgress(percentDoneReport, deleteOptions, itemToDelete.id, interfaces_1.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, interfaces_1.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, interfaces_1.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]);
+    }
+}
+exports.removeItems = removeItems;
+//# sourceMappingURL=removeItems.js.map