@esri/solution-common 4.1.2 → 5.0.0

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

@@ -1,27 +1,27 @@
-/** @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.
- */
-/**
- * @module deleteGroupIfEmpty
- */
-import { UserSession } from "../interfaces";
-/**
- * Deletes a group if it's empty and belongs to the specified user.
- *
- * @param groupId Id of the group to be deleted
- * @param authentication Credentials for the request
- * @returns Promise indicating if group was deleted
- */
-export declare function deleteGroupIfEmpty(groupId: string, authentication: UserSession): Promise<boolean>;
+/** @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.
+ */
+/**
+ * @module deleteGroupIfEmpty
+ */
+import { UserSession } from "../interfaces";
+/**
+ * Deletes a group if it's empty and belongs to the specified user.
+ *
+ * @param groupId Id of the group to be deleted
+ * @param authentication Credentials for the request
+ * @returns Promise indicating if group was deleted
+ */
+export declare function deleteGroupIfEmpty(groupId: string, authentication: UserSession): Promise<boolean>;

package/dist/esm/deleteHelpers/deleteGroupIfEmpty.js

@@ -1,92 +1,92 @@
-/** @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 portal from "@esri/arcgis-rest-portal";
-// ------------------------------------------------------------------------------------------------------------------ //
-/**
- * Deletes a group if it's empty and belongs to the specified user.
- *
- * @param groupId Id of the group to be deleted
- * @param authentication Credentials for the request
- * @returns Promise indicating if group was deleted
- */
-export function deleteGroupIfEmpty(groupId, authentication) {
-    let username;
-    let isGroupProtected;
-    // Get the owner tied to the authentication
-    // eslint-disable-next-line @typescript-eslint/no-floating-promises
-    return authentication
-        .getUsername()
-        .then(response => {
-        username = response;
-        // We need to know the owner and protection status of the group
-        return portal.getGroup(groupId, { authentication });
-    })
-        .then((group) => {
-        if (group.owner !== username) {
-            return Promise.resolve(null); // don't delete a group we don't own
-        }
-        isGroupProtected = group.protected; // do we need to unprotect before deleting?
-        // Get the number of items in the group
-        const groupContentOptions = {
-            paging: {
-                num: 1 // only need 1 item to show that group is not empty
-            },
-            authentication
-        };
-        return portal.getGroupContent(groupId, groupContentOptions);
-    })
-        .then((groupContent) => {
-        // should be IGroupContentResult; see https://github.com/Esri/arcgis-rest-js/pull/858/files
-        // If groupContent is null, then we don't own the group; if the group is not empty, then we can't delete it
-        if (!groupContent || groupContent.total > 0) {
-            return Promise.resolve({ success: false }); // don't delete a group that's not empty
-        }
-        // We're going ahead with deletion; first unprotect it if necessary
-        if (isGroupProtected) {
-            const groupOptions = {
-                id: groupId,
-                authentication
-            };
-            return portal.unprotectGroup(groupOptions);
-        }
-        else {
-            return Promise.resolve({ success: true });
-        }
-    })
-        .then(response => {
-        if (response.success) {
-            // All is good so far: we own the group, it's empty, and it's unprotected; proceed with deletion
-            const groupOptions = {
-                id: groupId,
-                authentication
-            };
-            return portal.removeGroup(groupOptions);
-        }
-        else {
-            // We should not delete the group
-            return Promise.resolve({ success: false });
-        }
-    })
-        .then((response) => {
-        // Return a simple response
-        return Promise.resolve(response.success);
-    })
-        .catch(() => {
-        // In case getGroup or getGroupContent fails
-        return Promise.resolve(false);
-    });
-}
+/** @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 portal from "@esri/arcgis-rest-portal";
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Deletes a group if it's empty and belongs to the specified user.
+ *
+ * @param groupId Id of the group to be deleted
+ * @param authentication Credentials for the request
+ * @returns Promise indicating if group was deleted
+ */
+export function deleteGroupIfEmpty(groupId, authentication) {
+    let username;
+    let isGroupProtected;
+    // Get the owner tied to the authentication
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    return authentication
+        .getUsername()
+        .then(response => {
+        username = response;
+        // We need to know the owner and protection status of the group
+        return portal.getGroup(groupId, { authentication });
+    })
+        .then((group) => {
+        if (group.owner !== username) {
+            return Promise.resolve(null); // don't delete a group we don't own
+        }
+        isGroupProtected = group.protected; // do we need to unprotect before deleting?
+        // Get the number of items in the group
+        const groupContentOptions = {
+            paging: {
+                num: 1 // only need 1 item to show that group is not empty
+            },
+            authentication
+        };
+        return portal.getGroupContent(groupId, groupContentOptions);
+    })
+        .then((groupContent) => {
+        // should be IGroupContentResult; see https://github.com/Esri/arcgis-rest-js/pull/858/files
+        // If groupContent is null, then we don't own the group; if the group is not empty, then we can't delete it
+        if (!groupContent || groupContent.total > 0) {
+            return Promise.resolve({ success: false }); // don't delete a group that's not empty
+        }
+        // We're going ahead with deletion; first unprotect it if necessary
+        if (isGroupProtected) {
+            const groupOptions = {
+                id: groupId,
+                authentication
+            };
+            return portal.unprotectGroup(groupOptions);
+        }
+        else {
+            return Promise.resolve({ success: true });
+        }
+    })
+        .then(response => {
+        if (response.success) {
+            // All is good so far: we own the group, it's empty, and it's unprotected; proceed with deletion
+            const groupOptions = {
+                id: groupId,
+                authentication
+            };
+            return portal.removeGroup(groupOptions);
+        }
+        else {
+            // We should not delete the group
+            return Promise.resolve({ success: false });
+        }
+    })
+        .then((response) => {
+        // Return a simple response
+        return Promise.resolve(response.success);
+    })
+        .catch(() => {
+        // In case getGroup or getGroupContent fails
+        return Promise.resolve(false);
+    });
+}
 //# sourceMappingURL=deleteGroupIfEmpty.js.map

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

@@ -1,38 +1,38 @@
-/** @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, 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 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[]>;
+/** @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, 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 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/esm/deleteHelpers/deleteSolutionContents.js

@@ -1,125 +1,125 @@
-/** @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 { EItemProgressStatus } from "../interfaces";
-import * as deleteEmptyGroups from "./deleteEmptyGroups";
-import * as deleteSolutionFolder from "./deleteSolutionFolder";
-import * as deleteSolutionItem from "./deleteSolutionItem";
-import * as removeItems from "./removeItems";
-import * as reportProgress from "./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.
- */
-export 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
-            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 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 });
-            }
-        })
-            .then((solutionItemDeleteStatus) => {
-            // If all deletes succeeded, see if we can delete the folder that contained them
-            if (solutionItemDeleteStatus.success) {
-                reportProgress.reportProgress(99, deleteOptions, solutionItemId, 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]);
-        });
-    });
-}
+/** @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 { EItemProgressStatus } from "../interfaces";
+import * as deleteEmptyGroups from "./deleteEmptyGroups";
+import * as deleteSolutionFolder from "./deleteSolutionFolder";
+import * as deleteSolutionItem from "./deleteSolutionItem";
+import * as removeItems from "./removeItems";
+import * as reportProgress from "./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.
+ */
+export 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
+            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 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 });
+            }
+        })
+            .then((solutionItemDeleteStatus) => {
+            // If all deletes succeeded, see if we can delete the folder that contained them
+            if (solutionItemDeleteStatus.success) {
+                reportProgress.reportProgress(99, deleteOptions, solutionItemId, 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]);
+        });
+    });
+}
 //# sourceMappingURL=deleteSolutionContents.js.map

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

@@ -1,29 +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 "../interfaces";
-/**
- * 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>;
+/** @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 "../interfaces";
+/**
+ * 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>;