@esri/solution-common 5.2.3 → 5.2.4

package/dist/cjs/completeItem.d.ts

@@ -0,0 +1,29 @@
+/** @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 functions for accessing a complete item.
+ *
+ * @module completeItem
+ */
+import { ICompleteItem, UserSession } from "./interfaces";
+/**
+ * Gets everything about an item.
+ *
+ * @param itemId Id of an item whose information is sought
+ * @param authentication Credentials for the request
+ * @returns Promise that will resolve with everything known about the item
+ */
+export declare function getCompleteItem(itemId: string, authentication: UserSession): Promise<ICompleteItem>;

package/dist/cjs/completeItem.js

@@ -0,0 +1,92 @@
+"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.getCompleteItem = void 0;
+const tslib_1 = require("tslib");
+const restHelpers = tslib_1.__importStar(require("./restHelpers"));
+const restHelpersGet = tslib_1.__importStar(require("./restHelpersGet"));
+const workflowHelpers = tslib_1.__importStar(require("./workflowHelpers"));
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Gets everything about an item.
+ *
+ * @param itemId Id of an item whose information is sought
+ * @param authentication Credentials for the request
+ * @returns Promise that will resolve with everything known about the item
+ */
+function getCompleteItem(itemId, authentication) {
+    let itemBase;
+    let completeItem;
+    return restHelpersGet
+        .getItemBase(itemId, authentication)
+        .then((response) => {
+        itemBase = response;
+        return Promise.all([
+            restHelpersGet.getItemDataAsFile(itemId, itemBase.name, authentication),
+            restHelpersGet.getItemThumbnailAsFile(itemId, itemBase.thumbnail, false, authentication),
+            restHelpersGet.getItemMetadataAsFile(itemId, authentication),
+            restHelpersGet.getItemResourcesFiles(itemId, authentication),
+            restHelpersGet.getItemRelatedItemsInSameDirection(itemId, "forward", authentication),
+            restHelpersGet.getItemRelatedItemsInSameDirection(itemId, "reverse", authentication)
+        ]);
+    })
+        .then(responses => {
+        const [itemData, itemThumbnail, itemMetadata, itemResources, itemFwdRelatedItems, itemRevRelatedItems] = responses;
+        // Summarize what we have
+        // ----------------------
+        // (itemBase: IItem)  text/plain JSON
+        // (itemData: File)  */*
+        // (itemThumbnail: File)  image/*
+        // (itemMetadata: File)  application/xml
+        // (itemResources: File[])  list of */*
+        // (itemFwdRelatedItems: IRelatedItems[])  list of forward relationshipType/relatedItems[] pairs
+        // (itemRevRelatedItems: IRelatedItems[])  list of reverse relationshipType/relatedItems[] pairs
+        completeItem = {
+            base: itemBase,
+            data: itemData,
+            thumbnail: itemThumbnail,
+            metadata: itemMetadata,
+            resources: itemResources,
+            fwdRelatedItems: itemFwdRelatedItems,
+            revRelatedItems: itemRevRelatedItems
+        };
+        if (itemBase.type === "Feature Service") {
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises
+            return restHelpers.getFeatureServiceProperties(itemBase.url, authentication);
+        }
+        else if (itemBase.type === "Workflow") {
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises
+            return restHelpers.getWorkflowConfigurationZip(itemBase.id, authentication);
+        }
+        else {
+            return Promise.resolve(null);
+        }
+    })
+        .then(async (properties) => {
+        if (properties) {
+            if (completeItem.base.type === "Feature Service") {
+                completeItem.featureServiceProperties = properties;
+            }
+            else if (completeItem.base.type === "Workflow") {
+                completeItem.workflowConfiguration = await workflowHelpers.extractWorkflowFromZipFile(properties);
+            }
+        }
+        return Promise.resolve(completeItem);
+    });
+}
+exports.getCompleteItem = getCompleteItem;
+//# sourceMappingURL=completeItem.js.map

package/dist/cjs/completeItem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"completeItem.js","sourceRoot":"","sources":["../../src/completeItem.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AAaH,mEAA6C;AAC7C,yEAAmD;AACnD,2EAAqD;AAErD,wHAAwH;AAExH;;;;;;GAMG;AACH,SAAgB,eAAe,CAC7B,MAAc,EACd,cAA2B;IAE3B,IAAI,QAAa,CAAC;IAClB,IAAI,YAAiB,CAAC;IAEtB,OAAO,cAAc;SAClB,WAAW,CAAC,MAAM,EAAE,cAAc,CAAC;SACnC,IAAI,CAAC,CAAC,QAAa,EAAE,EAAE;QACtB,QAAQ,GAAG,QAAQ,CAAC;QAEpB,OAAO,OAAO,CAAC,GAAG,CAAC;YACjB,cAAc,CAAC,iBAAiB,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;YACvE,cAAc,CAAC,sBAAsB,CACnC,MAAM,EACN,QAAQ,CAAC,SAAS,EAClB,KAAK,EACL,cAAc,CACf;YACD,cAAc,CAAC,qBAAqB,CAAC,MAAM,EAAE,cAAc,CAAC;YAC5D,cAAc,CAAC,qBAAqB,CAAC,MAAM,EAAE,cAAc,CAAC;YAC5D,cAAc,CAAC,kCAAkC,CAC/C,MAAM,EACN,SAAS,EACT,cAAc,CACf;YACD,cAAc,CAAC,kCAAkC,CAC/C,MAAM,EACN,SAAS,EACT,cAAc,CACf;SACF,CAAC,CAAC;IACL,CAAC,CAAC;SACD,IAAI,CAAC,SAAS,CAAC,EAAE;QAChB,MAAM,CACJ,QAAQ,EACR,aAAa,EACb,YAAY,EACZ,aAAa,EACb,mBAAmB,EACnB,mBAAmB,CACpB,GAAG,SAAS,CAAC;QACd,yBAAyB;QACzB,yBAAyB;QACzB,qCAAqC;QACrC,wBAAwB;QACxB,iCAAiC;QACjC,wCAAwC;QACxC,uCAAuC;QACvC,gGAAgG;QAChG,gGAAgG;QAChG,YAAY,GAAG;YACb,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,aAAa;YACxB,QAAQ,EAAE,YAAY;YACtB,SAAS,EAAE,aAAa;YACxB,eAAe,EAAE,mBAAmB;YACpC,eAAe,EAAE,mBAAmB;SACrC,CAAC;QAEF,IAAI,QAAQ,CAAC,IAAI,KAAK,iBAAiB,EAAE;YACvC,mEAAmE;YACnE,OAAO,WAAW,CAAC,2BAA2B,CAC5C,QAAQ,CAAC,GAAG,EACZ,cAAc,CACf,CAAC;SAEH;aAAM,IAAI,QAAQ,CAAC,IAAI,KAAK,UAAU,EAAE;YACvC,mEAAmE;YACnE,OAAO,WAAW,CAAC,2BAA2B,CAC5C,QAAQ,CAAC,EAAE,EACX,cAAc,CACf,CAAC;SAEH;aAAM;YACL,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAC9B;IACH,CAAC,CAAC;SACD,IAAI,CAAC,KAAK,EAAE,UAA4C,EAAE,EAAE;QAC3D,IAAI,UAAU,EAAE;YACd,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,KAAK,iBAAiB,EAAE;gBAChD,YAAY,CAAC,wBAAwB,GAAG,UAAU,CAAC;aACpD;iBAAM,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE;gBAChD,YAAY,CAAC,qBAAqB,GAAG,MAAM,eAAe,CAAC,0BAA0B,CAAC,UAAkB,CAAC,CAAC;aAC3G;SACF;QACD,OAAO,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACP,CAAC;AA1FD,0CA0FC"}

package/dist/cjs/create-hub-request-options.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.
+ */
+import { UserSession } from "./interfaces";
+import { IHubUserRequestOptions } from "@esri/hub-common";
+/**
+ * Create a IHubUserRequestOptions object from
+ * the UserSession
+ * If passed, it will use `templateDictionary`
+ * values instead of making additional requests
+ *
+ * @export
+ * @param {UserSession} authentication
+ * @param {*} templateDictionary
+ * @returns {IHubUserRequestOptions}
+ */
+export declare function createHubRequestOptions(authentication: UserSession, templateDictionary?: any): Promise<IHubUserRequestOptions>;

package/dist/cjs/create-hub-request-options.js

@@ -0,0 +1,64 @@
+"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.createHubRequestOptions = void 0;
+const hub_common_1 = require("@esri/hub-common");
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+/**
+ * Create a IHubUserRequestOptions object from
+ * the UserSession
+ * If passed, it will use `templateDictionary`
+ * values instead of making additional requests
+ *
+ * @export
+ * @param {UserSession} authentication
+ * @param {*} templateDictionary
+ * @returns {IHubUserRequestOptions}
+ */
+function createHubRequestOptions(authentication, templateDictionary = {}) {
+    // We used to pull the user
+    // the template dictionary, but ran into issues
+    // with the user.groups being filtered to groups
+    // the user owns, vs all groups the user belongs to
+    // this was problematic as we need to check if the user
+    // can add more groups, based on how close they are to
+    // the max 512 group limit.
+    // At this time we are simply fetching the user directly
+    const promises = [];
+    if (templateDictionary.organization) {
+        promises.push(Promise.resolve(templateDictionary.organization));
+    }
+    else {
+        promises.push((0, arcgis_rest_portal_1.getSelf)({ authentication }));
+    }
+    // always get the user
+    promises.push((0, arcgis_rest_portal_1.getUser)({ authentication }));
+    return Promise.all(promises).then(([pSelf, user]) => {
+        pSelf.user = user;
+        const ro = {
+            authentication,
+            portalSelf: pSelf,
+            isPortal: pSelf.isPortal
+        };
+        if (!pSelf.isPortal) {
+            ro.hubApiUrl = (0, hub_common_1.getHubUrlFromPortal)(pSelf);
+        }
+        return ro;
+    });
+}
+exports.createHubRequestOptions = createHubRequestOptions;
+//# sourceMappingURL=create-hub-request-options.js.map

package/dist/cjs/create-hub-request-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-hub-request-options.js","sourceRoot":"","sources":["../../src/create-hub-request-options.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAIH,iDAA+E;AAE/E,iEAA4D;AAE5D;;;;;;;;;;GAUG;AACH,SAAgB,uBAAuB,CACrC,cAA2B,EAC3B,qBAA0B,EAAE;IAE5B,2BAA2B;IAC3B,+CAA+C;IAC/C,gDAAgD;IAChD,mDAAmD;IACnD,uDAAuD;IACvD,sDAAsD;IACtD,2BAA2B;IAE3B,wDAAwD;IACxD,MAAM,QAAQ,GAAG,EAAE,CAAC;IACpB,IAAI,kBAAkB,CAAC,YAAY,EAAE;QACnC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC,CAAC;KACjE;SAAM;QACL,QAAQ,CAAC,IAAI,CAAC,IAAA,4BAAO,EAAC,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;KAC5C;IACD,sBAAsB;IACtB,QAAQ,CAAC,IAAI,CAAC,IAAA,4BAAO,EAAC,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;IAE3C,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE;QAClD,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QAClB,MAAM,EAAE,GAAG;YACT,cAAc;YACd,UAAU,EAAE,KAAK;YACjB,QAAQ,EAAE,KAAK,CAAC,QAAQ;SACC,CAAC;QAE5B,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;YACnB,EAAE,CAAC,SAAS,GAAG,IAAA,gCAAmB,EAAC,KAAK,CAAC,CAAC;SAC3C;QAED,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC;AACL,CAAC;AApCD,0DAoCC"}

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

@@ -0,0 +1,24 @@
+/** @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 { UserSession } from "../interfaces";
+/**
+ * Deletes a set of empty groups if they're empty and belong to the user in the authentication.
+ *
+ * @param groups Ids of the groups to be deleted
+ * @param authentication Credentials for the request
+ * @returns Promise that will resolve with the list of successfully deleted groups
+ */
+export declare function deleteEmptyGroups(groups: string[], authentication: UserSession): Promise<string[]>;

package/dist/cjs/deleteHelpers/deleteEmptyGroups.js

@@ -0,0 +1,42 @@
+"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.deleteEmptyGroups = void 0;
+/**
+ * @module deleteEmptyGroups
+ */
+const deleteGroupIfEmpty_1 = require("./deleteGroupIfEmpty");
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Deletes a set of empty groups if they're empty and belong to the user in the authentication.
+ *
+ * @param groups Ids of the groups to be deleted
+ * @param authentication Credentials for the request
+ * @returns Promise that will resolve with the list of successfully deleted groups
+ */
+function deleteEmptyGroups(groups, authentication) {
+    if (groups.length === 0) {
+        return Promise.resolve([]);
+    }
+    // Attempt to delete each group
+    return Promise.all(groups.map(groupId => (0, deleteGroupIfEmpty_1.deleteGroupIfEmpty)(groupId, authentication))).then((responses) => {
+        // Return just the group ids that succeeded
+        return groups.filter((groupId, index) => responses[index]);
+    });
+}
+exports.deleteEmptyGroups = deleteEmptyGroups;
+//# sourceMappingURL=deleteEmptyGroups.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deleteEmptyGroups.js","sourceRoot":"","sources":["../../../src/deleteHelpers/deleteEmptyGroups.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;GAEG;AAEH,6DAA0D;AAG1D,wHAAwH;AAExH;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAC/B,MAAgB,EAChB,cAA2B;IAE3B,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QACvB,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;KAC5B;IAED,+BAA+B;IAC/B,OAAO,OAAO,CAAC,GAAG,CAChB,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAA,uCAAkB,EAAC,OAAO,EAAE,cAAc,CAAC,CAAC,CACnE,CAAC,IAAI,CAAC,CAAC,SAAoB,EAAE,EAAE;QAC9B,2CAA2C;QAC3C,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,OAAe,EAAE,KAAa,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;AACL,CAAC;AAfD,8CAeC"}

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

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

package/dist/cjs/deleteHelpers/deleteGroupIfEmpty.js

@@ -0,0 +1,97 @@
+"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.deleteGroupIfEmpty = void 0;
+const tslib_1 = require("tslib");
+const portal = tslib_1.__importStar(require("@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
+ */
+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);
+    });
+}
+exports.deleteGroupIfEmpty = deleteGroupIfEmpty;
+//# sourceMappingURL=deleteGroupIfEmpty.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deleteGroupIfEmpty.js","sourceRoot":"","sources":["../../../src/deleteHelpers/deleteGroupIfEmpty.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AAOH,yEAAmD;AAEnD,wHAAwH;AAExH;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAChC,OAAe,EACf,cAA2B;IAE3B,IAAI,QAAgB,CAAC;IACrB,IAAI,gBAAyB,CAAC;IAE9B,2CAA2C;IAC3C,mEAAmE;IACnE,OAAO,cAAc;SAClB,WAAW,EAAE;SACb,IAAI,CAAC,QAAQ,CAAC,EAAE;QACf,QAAQ,GAAG,QAAQ,CAAC;QAEpB,+DAA+D;QAC/D,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;IACtD,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,KAAoB,EAAE,EAAE;QAC7B,IAAI,KAAK,CAAC,KAAK,KAAK,QAAQ,EAAE;YAC5B,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,oCAAoC;SACnE;QACD,gBAAgB,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,2CAA2C;QAE/E,uCAAuC;QACvC,MAAM,mBAAmB,GAAmC;YAC1D,MAAM,EAAE;gBACN,GAAG,EAAE,CAAC,CAAC,mDAAmD;aAC3D;YACD,cAAc;SACf,CAAC;QACF,OAAO,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;IAC9D,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,YAAiB,EAAE,EAAE;QAC1B,2FAA2F;QAC3F,2GAA2G;QAC3G,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,KAAK,GAAG,CAAC,EAAE;YAC3C,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,wCAAwC;SACrF;QAED,mEAAmE;QACnE,IAAI,gBAAgB,EAAE;YACpB,MAAM,YAAY,GAA6B;gBAC7C,EAAE,EAAE,OAAO;gBACX,cAAc;aACf,CAAC;YACF,OAAO,MAAM,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;SAC5C;aAAM;YACL,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;SAC3C;IACH,CAAC,CAAC;SACD,IAAI,CAAC,QAAQ,CAAC,EAAE;QACf,IAAI,QAAQ,CAAC,OAAO,EAAE;YACpB,gGAAgG;YAChG,MAAM,YAAY,GAA6B;gBAC7C,EAAE,EAAE,OAAO;gBACX,cAAc;aACf,CAAC;YACF,OAAO,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;SACzC;aAAM;YACL,iCAAiC;YACjC,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;SAC5C;IACH,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,QAA8B,EAAE,EAAE;QACvC,2BAA2B;QAC3B,OAAO,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC,CAAC;SACD,KAAK,CAAC,GAAG,EAAE;QACV,4CAA4C;QAC5C,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;AACP,CAAC;AAvED,gDAuEC"}

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

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

package/dist/cjs/deleteHelpers/deleteSolutionContents.js

@@ -0,0 +1,130 @@
+"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");
+/**
+ * Provides a function for deleting a deployed Solution item and all of the items that were created
+ * as part of that deployment.
+ *
+ * @module deleteSolution
+ */
+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
+            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, 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;;;;AAEH;;;;;GAKG;AAEH,8CAMuB;AACvB,+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,OAAO,CAAC,EAAE;QAC9C,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,WAAW,GAAG,eAAe,CAAC,KAAK;iBAChC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;iBACpB,MAAM,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;YAE5B,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,CAC3B,CAAC,WAAW,IAAI,mBAAmB,CAAC,EACpC,aAAa,CACd,CAAC,CAAC,yCAAyC;YAE5C,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,QAAQ,CAAC,EAAE;gBAC/C,mEAAmE;gBACnE,iBAAiB;qBACd,iBAAiB,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,CAAC;qBACzD,IAAI,CAAC,GAAG,EAAE;oBACT,QAAQ,CAAC,OAAO,CAAC,CAAC;gBACpB,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;aACD,IAAI,CAAC,GAAG,EAAE;YACT,mEAAmE;YACnE,IAAI,sBAAsB,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC7C,OAAO,kBAAkB,CAAC,kBAAkB,CAC1C,cAAc,EACd,cAAc,CACf,CAAC;aACH;iBAAM;gBACL,uDAAuD;gBACvD,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC;aACpE;QACH,CAAC,CAAC;aACD,IAAI,CAAC,CAAC,wBAAyC,EAAE,EAAE;YAClD,gFAAgF;YAChF,IAAI,wBAAwB,CAAC,OAAO,EAAE;gBACpC,cAAc,CAAC,cAAc,CAC3B,EAAE,EACF,aAAa,EACb,cAAc,EACd,gCAAmB,CAAC,QAAQ,CAC7B,CAAC;gBAEF,qDAAqD;gBACrD,OAAO,oBAAoB,CAAC,oBAAoB,CAC9C,WAAW,EACX,eAAe,CAAC,MAAM,EACtB,cAAc,CACf,CAAC;aACH;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;AAjHD,wDAiHC"}

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 "../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>;