@esri/solution-common 4.1.2 → 5.0.0

package/dist/esm/deleteHelpers/removeItems.js

@@ -1,107 +1,107 @@
-/** @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 * as portal from "@esri/arcgis-rest-portal";
-import * as restHelpers from "../restHelpers";
-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 portal.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 {
-                return restHelpers.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]);
-    }
-}
+/** @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 * as portal from "@esri/arcgis-rest-portal";
+import * as restHelpers from "../restHelpers";
+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 portal.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 {
+                return restHelpers.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/reportProgress.d.ts

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

@@ -1,42 +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 + "%");
-    }
-}
+/** @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/deleteSolution.d.ts

@@ -1,55 +1,55 @@
-/** @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, UserSession } 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 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[]>;
+/** @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, UserSession } 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 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[]>;