@esri/solution-common 1.3.10 → 1.3.13

package/dist/esm/completeItem.d.ts

@@ -24,6 +24,6 @@ import { ICompleteItem, UserSession } from "./interfaces";
  *
  * @param itemId Id of an item whose information is sought
  * @param authentication Credentials for the request
- * @return Promise that will resolve with everything known about the item
+ * @returns Promise that will resolve with everything known about the item
  */
 export declare function getCompleteItem(itemId: string, authentication: UserSession): Promise<ICompleteItem>;

package/dist/esm/completeItem.js

@@ -21,7 +21,7 @@ import * as restHelpersGet from "./restHelpersGet";
  *
  * @param itemId Id of an item whose information is sought
  * @param authentication Credentials for the request
- * @return Promise that will resolve with everything known about the item
+ * @returns Promise that will resolve with everything known about the item
  */
 export function getCompleteItem(itemId, authentication) {
     let itemBase;

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

@@ -19,6 +19,6 @@ import { UserSession } from "../interfaces";
  *
  * @param groups Ids of the groups to be deleted
  * @param authentication Credentials for the request
- * @return Promise that will resolve with the list of successfully deleted groups
+ * @returns Promise that will resolve with the list of successfully deleted groups
  */
 export declare function deleteEmptyGroups(groups: string[], authentication: UserSession): Promise<string[]>;

package/dist/esm/deleteHelpers/deleteEmptyGroups.js

@@ -23,7 +23,7 @@ import { deleteGroupIfEmpty } from "./deleteGroupIfEmpty";
  *
  * @param groups Ids of the groups to be deleted
  * @param authentication Credentials for the request
- * @return Promise that will resolve with the list of successfully deleted groups
+ * @returns Promise that will resolve with the list of successfully deleted groups
  */
 export function deleteEmptyGroups(groups, authentication) {
     if (groups.length === 0) {

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

@@ -22,6 +22,6 @@ import { UserSession } from "../interfaces";
  *
  * @param groupId Id of the group to be deleted
  * @param authentication Credentials for the request
- * @return Promise indicating if group was deleted
+ * @returns Promise indicating if group was deleted
  */
 export declare function deleteGroupIfEmpty(groupId: string, authentication: UserSession): Promise<boolean>;

package/dist/esm/deleteHelpers/deleteGroupIfEmpty.js

@@ -20,7 +20,7 @@ import * as portal from "@esri/arcgis-rest-portal";
  *
  * @param groupId Id of the group to be deleted
  * @param authentication Credentials for the request
- * @return Promise indicating if group was deleted
+ * @returns Promise indicating if group was deleted
  */
 export function deleteGroupIfEmpty(groupId, authentication) {
     let username;

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

@@ -28,7 +28,7 @@ import { IDeleteSolutionOptions, ISolutionPrecis, UserSession } from "../interfa
  * @param solutionSummary List of items in the solution that would be deleted
  * @param authentication Credentials for the request
  * @param options Progress reporting options
- * @return Promise that will resolve with a list of two solution summaries: successful deletions
+ * @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

package/dist/esm/deleteHelpers/deleteSolutionContents.js

@@ -34,7 +34,7 @@ import * as reportProgress from "./reportProgress";
  * @param solutionSummary List of items in the solution that would be deleted
  * @param authentication Credentials for the request
  * @param options Progress reporting options
- * @return Promise that will resolve with a list of two solution summaries: successful deletions
+ * @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

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

@@ -23,7 +23,7 @@ import { UserSession } from "../interfaces";
  * @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
- * @return Promise that will resolve if deletion was successful and fail if any part of it failed;
+ * @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/esm/deleteHelpers/deleteSolutionFolder.js

@@ -21,7 +21,7 @@ import * as portal from "@esri/arcgis-rest-portal";
  * @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
- * @return Promise that will resolve if deletion was successful and fail if any part of it failed;
+ * @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) {

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

@@ -25,6 +25,6 @@ import { IStatusResponse, UserSession } from "../interfaces";
  *
  * @param solutionItemId Id of a deployed Solution
  * @param authentication Credentials for the request
- * @return Promise that will resolve with the status of deleting the item
+ * @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

@@ -22,7 +22,7 @@ import * as restHelpers from "../restHelpers";
  *
  * @param solutionItemId Id of a deployed Solution
  * @param authentication Credentials for the request
- * @return Promise that will resolve with the status of deleting the item
+ * @returns Promise that will resolve with the status of deleting the item
  */
 export function deleteSolutionItem(solutionItemId, authentication) {
     const protectOptions = {

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

@@ -21,7 +21,7 @@ import { IItemTemplate } from "../interfaces";
  * Reconstructs the build order of a set of templates.
  *
  * @param templates A collection of AGO item templates
- * @return The ids of the source templates in build order, which is not necessarily the same
+ * @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

@@ -19,7 +19,7 @@ import * as dependencies from "../dependencies";
  * Reconstructs the build order of a set of templates.
  *
  * @param templates A collection of AGO item templates
- * @return The ids of the source templates in build order, which is not necessarily the same
+ * @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) {

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

@@ -28,7 +28,7 @@ import { IDeleteSolutionOptions, ISolutionPrecis, UserSession } from "../interfa
  * @param solutionDeletedSummary Solution summary containing items successfully deleted
  * @param solutionFailureSummary Solution summary containing items that could not be deleted
  * @param deleteOptions Reporting options
- * @return Promise that will resolve with a list of two solution summaries: successful deletions
+ * @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/esm/deleteHelpers/removeItems.js

@@ -34,7 +34,7 @@ import { createHubRequestOptions } from "../create-hub-request-options";
  * @param solutionDeletedSummary Solution summary containing items successfully deleted
  * @param solutionFailureSummary Solution summary containing items that could not be deleted
  * @param deleteOptions Reporting options
- * @return Promise that will resolve with a list of two solution summaries: successful deletions
+ * @returns Promise that will resolve with a list of two solution summaries: successful deletions
  * and failed deletions. Ignored items (e.g., already deleted) will not be in either list.
  */
 export function removeItems(solutionSummary, hubSiteItemIds, authentication, percentDone, progressPercentStep, deleteOptions = {}) {

package/dist/esm/deleteSolution.d.ts

@@ -27,7 +27,7 @@ import { IDeleteSolutionOptions, IItemTemplate, ISolutionPrecis, UserSession } f
  * @param solutionItemId Id of a deployed Solution
  * @param authentication Credentials for the request
  * @param options Progress reporting options
- * @return Promise that will resolve with a list of two solution summaries: successful deletions
+ * @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
@@ -45,7 +45,7 @@ export declare function deleteSolution(solutionItemId: string, authentication: U
  * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
  * @param authentication Credentials for the request
  * @param options Progress reporting options
- * @return Promise that will resolve with a list of two solution summaries: successful deletions
+ * @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

package/dist/esm/deleteSolution.js

@@ -23,7 +23,7 @@ import * as getDeletableSolutionInfo from "./getDeletableSolutionInfo";
  * @param solutionItemId Id of a deployed Solution
  * @param authentication Credentials for the request
  * @param options Progress reporting options
- * @return Promise that will resolve with a list of two solution summaries: successful deletions
+ * @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
@@ -50,7 +50,7 @@ export function deleteSolution(solutionItemId, authentication, options) {
  * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
  * @param authentication Credentials for the request
  * @param options Progress reporting options
- * @return Promise that will resolve with a list of two solution summaries: successful deletions
+ * @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

package/dist/esm/dependencies.d.ts

@@ -18,7 +18,7 @@ import { IBuildOrdering, IItemTemplate } from "./interfaces";
  * Topologically sorts a list of items into a build list.
  *
  * @param templates A collection of AGO item templates
- * @return An object containing three parts: a list of ids of items in the order in which they need to be built
+ * @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.

package/dist/esm/dependencies.js

@@ -25,7 +25,7 @@ import { findTemplateInList } from "./templatization";
  * Topologically sorts a list of items into a build list.
  *
  * @param templates A collection of AGO item templates
- * @return An object containing three parts: a list of ids of items in the order in which they need to be built
+ * @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.
@@ -153,7 +153,7 @@ export function topologicallySortItems(templates) {
 /**
  * A visit flag used in the topological sort algorithm.
  *
- * @protected
+ * @private
  */
 var ESortVisitState;
 (function (ESortVisitState) {