@esri/solution-common 4.1.2 → 5.0.0

package/dist/esm/deleteHelpers/deleteSolutionFolder.js

@@ -1,74 +1,74 @@
-/** @license
- * Copyright 2018 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import * as portal from "@esri/arcgis-rest-portal";
-// ------------------------------------------------------------------------------------------------------------------ //
-/**
- * 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 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 portal.SearchQueryBuilder()
-            .match(authentication.username)
-            .in("owner")
-            .and()
-            .match(user.orgId)
-            .in("orgid")
-            .and()
-            .match(folderId)
-            .in("ownerfolder");
-        return portal.searchItems({
-            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 portal.removeFolder({
-                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;
-    });
-}
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import * as portal from "@esri/arcgis-rest-portal";
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * 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 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 portal.SearchQueryBuilder()
+            .match(authentication.username)
+            .in("owner")
+            .and()
+            .match(user.orgId)
+            .in("orgid")
+            .and()
+            .match(folderId)
+            .in("ownerfolder");
+        return portal.searchItems({
+            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 portal.removeFolder({
+                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;
+    });
+}
 //# sourceMappingURL=deleteSolutionFolder.js.map

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

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

package/dist/esm/deleteHelpers/deleteSolutionItem.js

@@ -1,49 +1,49 @@
-/** @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";
-import * as restHelpers from "../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
- */
-export function deleteSolutionItem(solutionItemId, authentication) {
-    const protectOptions = {
-        id: solutionItemId,
-        authentication
-    };
-    return portal
-        .unprotectItem(protectOptions)
-        .then(result => {
-        if (result.success) {
-            return restHelpers.removeItem(solutionItemId, authentication);
-        }
-        else {
-            return Promise.resolve(result);
-        }
-    })
-        .then(result => {
-        return Promise.resolve({
-            success: result.success,
-            itemId: solutionItemId
-        });
-    });
-}
+/** @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";
+import * as restHelpers from "../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
+ */
+export function deleteSolutionItem(solutionItemId, authentication) {
+    const protectOptions = {
+        id: solutionItemId,
+        authentication
+    };
+    return portal
+        .unprotectItem(protectOptions)
+        .then(result => {
+        if (result.success) {
+            return restHelpers.removeItem(solutionItemId, authentication);
+        }
+        else {
+            return Promise.resolve(result);
+        }
+    })
+        .then(result => {
+        return Promise.resolve({
+            success: result.success,
+            itemId: solutionItemId
+        });
+    });
+}
 //# sourceMappingURL=deleteSolutionItem.js.map

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

@@ -1,22 +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";
+/** @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/esm/deleteHelpers/index.js

@@ -1,23 +1,23 @@
-/** @license
- * Copyright 2020 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-export * from "./deleteEmptyGroups";
-export * from "./deleteGroupIfEmpty";
-export * from "./deleteSolutionFolder";
-export * from "./deleteSolutionItem";
-export * from "./reconstructBuildOrderIds";
-export * from "./removeItems";
-export * from "./reportProgress";
+/** @license
+ * Copyright 2020 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from "./deleteEmptyGroups";
+export * from "./deleteGroupIfEmpty";
+export * from "./deleteSolutionFolder";
+export * from "./deleteSolutionItem";
+export * from "./reconstructBuildOrderIds";
+export * from "./removeItems";
+export * from "./reportProgress";
 //# sourceMappingURL=index.js.map

package/dist/esm/deleteHelpers/reconstructBuildOrderIds.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 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[];
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * @module reconstructBuildOrderIds
+ */
+import { IItemTemplate } from "../interfaces";
+/**
+ * Reconstructs the build order of a set of templates.
+ *
+ * @param templates A collection of AGO item templates
+ * @returns The ids of the source templates in build order, which is not necessarily the same
+ * as the build order used to create the template Solution
+ */
+export declare function reconstructBuildOrderIds(templates: IItemTemplate[]): string[];

package/dist/esm/deleteHelpers/reconstructBuildOrderIds.js

@@ -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.
- */
-import * as dependencies from "../dependencies";
-// ------------------------------------------------------------------------------------------------------------------ //
-/**
- * Reconstructs the build order of a set of templates.
- *
- * @param templates A collection of AGO item templates
- * @returns The ids of the source templates in build order, which is not necessarily the same
- * as the build order used to create the template Solution
- */
-export function reconstructBuildOrderIds(templates) {
-    const buildOrdering = dependencies.topologicallySortItems(templates);
-    return buildOrdering.buildOrder;
-}
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import * as dependencies from "../dependencies";
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Reconstructs the build order of a set of templates.
+ *
+ * @param templates A collection of AGO item templates
+ * @returns The ids of the source templates in build order, which is not necessarily the same
+ * as the build order used to create the template Solution
+ */
+export function reconstructBuildOrderIds(templates) {
+    const buildOrdering = dependencies.topologicallySortItems(templates);
+    return buildOrdering.buildOrder;
+}
 //# sourceMappingURL=reconstructBuildOrderIds.js.map

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

@@ -1,34 +1,34 @@
-/** @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, UserSession } from "../interfaces";
-/**
- * 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[]>;
+/** @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, UserSession } from "../interfaces";
+/**
+ * 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[]>;