@esri/solution-common 3.0.0 → 3.1.0

package/dist/umd/src/completeItem.d.ts

@@ -1,29 +0,0 @@
-/** @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/umd/src/create-hub-request-options.d.ts

@@ -1,29 +0,0 @@
-/** @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/umd/src/deleteHelpers/deleteEmptyGroups.d.ts

@@ -1,24 +0,0 @@
-/** @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/umd/src/deleteHelpers/deleteGroupIfEmpty.d.ts

@@ -1,27 +0,0 @@
-/** @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/umd/src/deleteHelpers/deleteSolutionContents.d.ts

@@ -1,38 +0,0 @@
-/** @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/umd/src/deleteHelpers/deleteSolutionFolder.d.ts

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

package/dist/umd/src/deleteHelpers/deleteSolutionItem.d.ts

@@ -1,30 +0,0 @@
-/** @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/umd/src/deleteHelpers/index.d.ts

@@ -1,22 +0,0 @@
-/** @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/umd/src/deleteHelpers/reconstructBuildOrderIds.d.ts

@@ -1,27 +0,0 @@
-/** @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/umd/src/deleteHelpers/removeItems.d.ts

@@ -1,34 +0,0 @@
-/** @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[]>;

package/dist/umd/src/deleteHelpers/reportProgress.d.ts

@@ -1,27 +0,0 @@
-/** @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/umd/src/deleteSolution.d.ts

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

package/dist/umd/src/dependencies.d.ts

@@ -1,26 +0,0 @@
-/** @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 { IBuildOrdering, IItemTemplate } from "./interfaces";
-/**
- * Topologically sorts a list of items into a build list.
- *
- * @param templates A collection of AGO item templates
- * @returns An object containing three parts: a list of ids of items in the order in which they need to be built
- * so that dependencies are built before items that require those dependencies, a list of item ids found in a
- * template's dependencies but not present in the supplied list of templates, and a dictionary containing items
- * that need to be post-processed due to dependency cycles.
- */
-export declare function topologicallySortItems(templates: IItemTemplate[]): IBuildOrdering;