@esri/solution-common 1.3.10 → 1.3.13

package/dist/esm/restHelpers.js

@@ -36,7 +36,7 @@ export { request as rest_request } from "@esri/arcgis-rest-request";
  * Creates a UserSession via a function so that the global arcgisSolution variable can access authentication.
  *
  * @param options See https://esri.github.io/arcgis-rest-js/api/auth/IUserSessionOptions/
- * @return UserSession
+ * @returns UserSession
  */
 export function getUserSession(options = {}) {
     return new UserSession(options);
@@ -48,7 +48,7 @@ export function getUserSession(options = {}) {
  * @param destinationItemId Destination of relationship
  * @param relationshipType Type of relationship
  * @param authentication Credentials for the request
- * @return A Promise to add item resources.
+ * @returns A Promise to add item resources.
  */
 export function addForwardItemRelationship(originItemId, destinationItemId, relationshipType, authentication) {
     return new Promise(resolve => {
@@ -77,7 +77,7 @@ export function addForwardItemRelationship(originItemId, destinationItemId, rela
  * @param originItemId Origin of relationship
  * @param destinationRelationships Destinations
  * @param authentication Credentials for the request
- * @return A Promise to add item resources.
+ * @returns A Promise to add item resources.
  */
 export function addForwardItemRelationships(originItemId, destinationRelationships, authentication) {
     return new Promise(resolve => {
@@ -97,7 +97,7 @@ export function addForwardItemRelationships(originItemId, destinationRelationshi
  *
  * @param url URL to use as base
  * @param authentication Credentials to be used to generate token for URL
- * @return A promise that will resolve with the supplied URL with `token=<token>` added to its query params
+ * @returns A promise that will resolve with the supplied URL with `token=<token>` added to its query params
  * unless either the URL doesn't exist or the token can't be generated
  */
 export function addTokenToUrl(url, authentication) {
@@ -127,7 +127,7 @@ export function addTokenToUrl(url, authentication) {
  * @param options the info to add to the services definition
  * @param skipRetry a boolean to control if retry logic will be used. Defaults to false.
  * @param useAsync a boolean to control if we will use an async request
- * @return A promise that will resolve when the request has completed
+ * @returns A promise that will resolve when the request has completed
  */
 export function addToServiceDefinition(url, options, skipRetry = false, useAsync = false) {
     /* istanbul ignore else */
@@ -153,7 +153,7 @@ export function addToServiceDefinition(url, options, skipRetry = false, useAsync
  * @param result the result returned from the addToDefinition request.
  * This will contain a status url or the standard sync result.
  * @param authentication Credentials to be used to generate token for URL
- * @return A promise that will resolve when the request has completed
+ * @returns A promise that will resolve when the request has completed
  */
 export function checkRequestStatus(result, authentication) {
     return new Promise((resolve, reject) => {
@@ -184,7 +184,7 @@ export function checkRequestStatus(result, authentication) {
  * Converts a general search into an ISearchOptions structure.
  *
  * @param search Search specified in one of three ways
- * @return Recast search
+ * @returns Recast search
  */
 export function convertToISearchOptions(search) {
     // Convert the search into an ISearchOptions
@@ -214,7 +214,7 @@ export function convertToISearchOptions(search) {
  * In some cases orgs can have null or undefined coordinate values associated with the org extent
  *
  * @param extent the extent to validate
- * @return the provided extent or a default global extent if some coordinates are not numbers
+ * @returns the provided extent or a default global extent if some coordinates are not numbers
  * @private
  */
 export function _validateExtent(extent) {
@@ -244,7 +244,7 @@ export function _validateExtent(extent) {
  * @param outSR the spatial reference to project to
  * @param geometryServiceUrl the service url for the geometry service to use
  * @param authentication the credentials for the requests
- * @return the extent projected to the provided spatial reference
+ * @returns the extent projected to the provided spatial reference
  * or the world extent projected to the provided spatial reference
  * @private
  */
@@ -282,7 +282,7 @@ export function convertExtentWithFallback(extent, fallbackExtent, outSR, geometr
  * @param outSR Desired spatial reference
  * @param geometryServiceUrl Path to geometry service providing `findTransformations` and `project` services
  * @param authentication Credentials for the request
- * @return Original extent if it's already using outSR or the extents projected into the outSR
+ * @returns Original extent if it's already using outSR or the extents projected into the outSR
  */
 export function convertExtent(extent, outSR, geometryServiceUrl, authentication) {
     const _requestOptions = { authentication };
@@ -353,7 +353,7 @@ export function convertExtent(extent, outSR, geometryServiceUrl, authentication)
  * @param newItemTemplate Template of item to be created
  * @param authentication Credentials for the request
  * @param templateDictionary Hash of facts: org URL, adlib replacements, user; .user.folders property contains a list
- * @return A promise that will resolve with an object reporting success and the Solution id
+ * @returns A promise that will resolve with an object reporting success and the Solution id
  */
 export function createFeatureService(newItemTemplate, authentication, templateDictionary) {
     return new Promise((resolve, reject) => {
@@ -378,7 +378,7 @@ export function createFeatureService(newItemTemplate, authentication, templateDi
  * @param metadataFile Item's metadata file
  * @param resourcesFiles Item's resources
  * @param access Access to set for item: "public", "org", "private"
- * @return A promise that will resolve with an object reporting success or failure and the Solution id
+ * @returns A promise that will resolve with an object reporting success or failure and the Solution id
  */
 export function createFullItem(itemInfo, folderId, destinationAuthentication, itemThumbnailUrl, itemThumbnailAuthentication, dataFile, metadataFile, resourcesFiles, access = "private") {
     return new Promise((resolve, reject) => {
@@ -464,7 +464,7 @@ export function createFullItem(itemInfo, folderId, destinationAuthentication, it
  * @param folderId Id of folder to receive item; null indicates that the item goes into the root
  *                 folder; ignored for Group item type
  * @param access Access to set for item: "public", "org", "private"
- * @return A promise that will resolve with an object reporting success and the Solution id
+ * @returns A promise that will resolve with an object reporting success and the Solution id
  */
 export function createItemWithData(itemInfo, dataInfo, authentication, folderId, access = "private") {
     return new Promise((resolve, reject) => {
@@ -525,7 +525,7 @@ export function createItemWithData(itemInfo, dataInfo, authentication, folderId,
  * of known folder names; function updates list with existing names not yet known, and creates .user.folders if it
  * doesn't exist in the dictionary
  * @param authentication Credentials for creating folder
- * @return Id of created folder
+ * @returns Id of created folder
  */
 export function createUniqueFolder(title, templateDictionary, authentication) {
     return new Promise((resolve, reject) => {
@@ -572,7 +572,7 @@ export function createUniqueFolder(title, templateDictionary, authentication) {
  *              If the tracking owner is not the one deploying the solution
  *              tracker groups will be created under the deployment user but
  *              will be reassigned to the tracking owner.
- * @return Information about created group
+ * @returns Information about created group
  */
 export function createUniqueGroup(title, groupItem, templateDictionary, authentication, owner) {
     return new Promise((resolve, reject) => {
@@ -626,7 +626,7 @@ export function createUniqueGroup(title, groupItem, templateDictionary, authenti
  *
  * @param itemTemplate Template of item to be created
  * @param authentication Credentials for the request
- * @return A promise that will resolve a list of dependencies
+ * @returns A promise that will resolve a list of dependencies
  */
 export function extractDependencies(itemTemplate, authentication) {
     const dependencies = [];
@@ -663,7 +663,7 @@ export function extractDependencies(itemTemplate, authentication) {
  * @param serviceUrl the url for the service
  * @param layerList list of base layer info
  * @param authentication Credentials for the request
- * @return A promise that will resolve a list of dependencies
+ * @returns A promise that will resolve a list of dependencies
  */
 export function getLayers(serviceUrl, layerList, authentication) {
     return new Promise((resolve, reject) => {
@@ -689,7 +689,7 @@ export function getLayers(serviceUrl, layerList, authentication) {
  * @param args The IPostProcessArgs for the request(s)
  * @param isPortal boolean to indicate if we are deploying to portal
  *
- * @return An array of update instructions
+ * @returns An array of update instructions
  * @private
  */
 export function getLayerUpdates(args, isPortal) {
@@ -746,7 +746,8 @@ export function getLayerUpdates(args, isPortal) {
  * @param tables the tables from the service
  * @param relUpdates the relationships to add for the service
  *
- * @return An array with relationships that have been sorted
+ * @returns An array with relationships that have been sorted
+ * @private
  */
 export function _sortRelationships(layers, tables, relUpdates) {
     const ids = [].concat(layers.map((l) => l.id), tables.map((t) => t.id));
@@ -775,7 +776,7 @@ export function _sortRelationships(layers, tables, relUpdates) {
  * @param itemTemplate Template of item being deployed
  * @param authentication Credentials for the request
  * @param updates An array of update instructions
- * @return An array of update instructions
+ * @returns An array of update instructions
  */
 export function getFinalServiceUpdates(itemTemplate, authentication, updates) {
     const sourceSchemaChangesAllowed = getProp(itemTemplate, "properties.service.sourceSchemaChangesAllowed");
@@ -800,7 +801,7 @@ export function getFinalServiceUpdates(itemTemplate, authentication, updates) {
  *
  * @param Update will contain either add, update, or delete from service definition call
  * @param skipRetry defaults to false. when true the retry logic will be ignored
- * @return A promise that will resolve when service definition call has completed
+ * @returns A promise that will resolve when service definition call has completed
  * @private
  */
 /* istanbul ignore else */
@@ -833,7 +834,7 @@ export function getRequest(update, skipRetry = false, useAsync = false) {
  *
  * @param itemTemplate Feature service item, data, dependencies definition to be modified
  * @param authentication Credentials for the request to AGOL
- * @return A promise that will resolve when fullItem has been updated
+ * @returns A promise that will resolve when fullItem has been updated
  * @private
  */
 export function getServiceLayersAndTables(itemTemplate, authentication) {
@@ -861,7 +862,7 @@ export function getServiceLayersAndTables(itemTemplate, authentication) {
  * @param serviceUrl the feature service url
  * @param authentication Credentials for the request to AGOL
  * @param workforceService boolean to indicate if extra workforce service steps should be handled
- * @return A promise that will resolve with the service properties
+ * @returns A promise that will resolve with the service properties
  * @private
  */
 export function getFeatureServiceProperties(serviceUrl, authentication, workforceService = false) {
@@ -924,7 +925,8 @@ export function getFeatureServiceProperties(serviceUrl, authentication, workforc
  * Layers and Tables are both returned in the layers array when we access a feature service from the admin api.
  *
  * @param adminData The data of the feature service
- * @return A mutated version of the provided adminData
+ * @returns A mutated version of the provided adminData
+ * @private
  */
 export function _parseAdminServiceData(adminData) {
     const layers = adminData.layers || [];
@@ -940,7 +942,7 @@ export function _parseAdminServiceData(adminData) {
  * These layers should not be templatized or depolyed
  *
  * @param groupDesignations the items group designations to evaluate
- * @return A boolean indicating if the invalid designation is found in the item info
+ * @returns A boolean indicating if the invalid designation is found in the item info
  */
 export function hasInvalidGroupDesignations(groupDesignations) {
     const invalidGroupDesignations = ["livingatlas"];
@@ -953,7 +955,7 @@ export function hasInvalidGroupDesignations(groupDesignations) {
  *
  * @param folderId Id of a folder to delete
  * @param authentication Credentials for the request to AGO
- * @return A promise that will resolve with the result of the request
+ * @returns A promise that will resolve with the result of the request
  */
 export function removeFolder(folderId, authentication) {
     return new Promise((resolve, reject) => {
@@ -969,7 +971,7 @@ export function removeFolder(folderId, authentication) {
  *
  * @param groupId Id of a group to delete
  * @param authentication Credentials for the request to AGO
- * @return A promise that will resolve with the result of the request
+ * @returns A promise that will resolve with the result of the request
  */
 export function removeGroup(groupId, authentication) {
     return new Promise((resolve, reject) => {
@@ -985,7 +987,7 @@ export function removeGroup(groupId, authentication) {
  *
  * @param itemId Id of an item to delete
  * @param authentication Credentials for the request to AGO
- * @return A promise that will resolve with the result of the request
+ * @returns A promise that will resolve with the result of the request
  */
 export function removeItem(itemId, authentication) {
     return new Promise((resolve, reject) => {
@@ -1001,7 +1003,7 @@ export function removeItem(itemId, authentication) {
  *
  * @param itemId Id of an item or group to delete
  * @param authentication Credentials for the request to AGO
- * @return A promise that will resolve with the result of the request
+ * @returns A promise that will resolve with the result of the request
  */
 export function removeItemOrGroup(itemId, authentication) {
     return new Promise((resolve, reject) => {
@@ -1014,7 +1016,7 @@ export function removeItemOrGroup(itemId, authentication) {
  * Searches for items matching a query and that the caller has access to.
  *
  * @param search Search string (e.g., "q=redlands+map") or a more detailed structure that can include authentication
- * @return Promise resolving with search results
+ * @returns Promise resolving with search results
  * @see https://developers.arcgis.com/rest/users-groups-and-items/search.htm
  */
 export function searchItems(search) {
@@ -1025,7 +1027,7 @@ export function searchItems(search) {
  *
  * @param search Search string (e.g., "q=redlands+map") or a more detailed structure that can include authentication
  * @param accumulatedResponse Response built from previous requests
- * @return Promise resolving with search results
+ * @returns Promise resolving with search results
  * @see https://developers.arcgis.com/rest/users-groups-and-items/search.htm
  */
 export function searchAllItems(search, accumulatedResponse) {
@@ -1061,7 +1063,7 @@ export function searchAllItems(search, accumulatedResponse) {
  * @param searchString Text for which to search, e.g., 'redlands+map', 'type:"Web Map" -type:"Web Mapping Application"'
  * @param authentication Credentials for the request to AGO
  * @param additionalSearchOptions Adjustments to search, such as tranche size
- * @return A promise that will resolve with a structure with a tranche of results and
+ * @returns A promise that will resolve with a structure with a tranche of results and
  * describing how many items are available
  * @see https://developers.arcgis.com/rest/users-groups-and-items/group-search.htm
  * @see https://developers.arcgis.com/rest/users-groups-and-items/search-reference.htm
@@ -1084,7 +1086,7 @@ export function searchGroups(searchString, authentication, additionalSearchOptio
  * @param groups List of groups that have been found from previous requests
  * @param inPagingParams The paging params for the recurisve searching
  *
- * @return A promise that will resolve with all groups that meet the search criteria
+ * @returns A promise that will resolve with all groups that meet the search criteria
  */
 export function searchAllGroups(searchString, authentication, groups, inPagingParams) {
     const pagingParams = inPagingParams ? inPagingParams : {
@@ -1121,7 +1123,7 @@ export function searchAllGroups(searchString, authentication, groups, inPagingPa
  * are supplied as an array: each array element consists of one or more categories to be ORed; array elements are ANDed
  * @param portalUrl Rest Url of the portal to perform the search
  * @param accumulatedResponse Response built from previous requests
- * @return A promise that will resolve with a structure with a tranche of results and
+ * @returns A promise that will resolve with a structure with a tranche of results and
  * describing how many items are available
  * @see https://developers.arcgis.com/rest/users-groups-and-items/group-content-search.htm
  * @see https://developers.arcgis.com/rest/users-groups-and-items/search-reference.htm
@@ -1160,7 +1162,7 @@ export function searchGroupAllContents(groupId, searchString, authentication, ad
  * @param additionalSearchOptions Adjustments to search, such as tranche size and categories of interest; categories
  * are supplied as an array: each array element consists of one or more categories to be ORed; array elements are ANDed
  * @param portalUrl Rest Url of the portal to perform the search
- * @return A promise that will resolve with a structure with a tranche of results and
+ * @returns A promise that will resolve with a structure with a tranche of results and
  * describing how many items are available
  * @see https://developers.arcgis.com/rest/users-groups-and-items/group-content-search.htm
  * @see https://developers.arcgis.com/rest/users-groups-and-items/search-reference.htm
@@ -1189,7 +1191,7 @@ export function searchGroupContents(groupId, searchString, authentication, addit
  * @param userName The new owner for the group
  * @param authentication Credentials for the request to
  *
- * @return A promise that will resolve after the group ownership has been assigned
+ * @returns A promise that will resolve after the group ownership has been assigned
  *
  */
 export function reassignGroup(groupId, userName, authentication) {
@@ -1208,7 +1210,7 @@ export function reassignGroup(groupId, userName, authentication) {
  * @param users List of users to remove from the group
  * @param authentication Credentials for the request to
  *
- * @return A promise that will resolve after the users have been removed
+ * @returns A promise that will resolve after the users have been removed
  *
  */
 export function removeUsers(groupId, users, authentication) {
@@ -1226,7 +1228,7 @@ export function removeUsers(groupId, users, authentication) {
  * @param destinationAuthentication Credentials for the request to AGO
  * @param owner owner of the group when sharing tracking items (can be different from the deploying user)
  *
- * @return A promise that will resolve after the item has been shared
+ * @returns A promise that will resolve after the item has been shared
  *
  */
 export function shareItem(groupId, id, destinationAuthentication, owner) {
@@ -1273,7 +1275,7 @@ export function updateItem(itemInfo, authentication, folderId, additionalParams)
  * for binary content
  * @param authentication Credentials for request
  * @param additionalParams Updates that are put under the `params` property, which is not serialized
- * @return A Promise that will resolve with the success/failure status of the request
+ * @returns A Promise that will resolve with the success/failure status of the request
  */
 export function updateGroup(groupInfo, authentication, additionalParams) {
     return new Promise((resolve, reject) => {
@@ -1370,7 +1372,7 @@ export function updateItemTemplateFromDictionary(itemId, templateDictionary, aut
  * @param id AGOL id of item to update
  * @param url URL to assign to item's base section
  * @param authentication Credentials for the request
- * @return A promise that will resolve with the item id when the item has been updated or an AGO-style JSON failure
+ * @returns A promise that will resolve with the item id when the item has been updated or an AGO-style JSON failure
  *         response
  */
 export function updateItemURL(id, url, authentication) {
@@ -1384,7 +1386,7 @@ export function updateItemURL(id, url, authentication) {
  * @param itemId Id of item to receive data file
  * @param dataFile Data to be added
  * @param authentication Credentials for the request
- * @return Promise reporting success or failure
+ * @returns Promise reporting success or failure
  * @private
  */
 export function _addItemDataFile(itemId, dataFile, authentication) {
@@ -1415,7 +1417,7 @@ export function _addItemDataFile(itemId, dataFile, authentication) {
  * @param itemId Id of item to receive data file
  * @param metadataFile Metadata to be added
  * @param authentication Credentials for the request
- * @return Promise reporting success or failure
+ * @returns Promise reporting success or failure
  * @private
  */
 export function _addItemMetadataFile(itemId, metadataFile, authentication) {
@@ -1437,7 +1439,7 @@ export function _addItemMetadataFile(itemId, metadataFile, authentication) {
  * Accumulates the number of relationships in a collection of layers.
  *
  * @param List of layers to examine
- * @return The number of relationships
+ * @returns The number of relationships
  * @private
  */
 export function _countRelationships(layers) {
@@ -1451,7 +1453,7 @@ export function _countRelationships(layers) {
  * @param serviceUrl URL to hosted service
  * @param layerList List of layers at that service...must contain id
  * @param authentication Credentials for the request
- * @return A promise that will resolve with a list of the layers from the admin api
+ * @returns A promise that will resolve with a list of the layers from the admin api
  * @private
  */
 export function _getCreateServiceOptions(newItemTemplate, authentication, templateDictionary) {
@@ -1503,7 +1505,7 @@ export function _getCreateServiceOptions(newItemTemplate, authentication, templa
  *
  * @param serviceInfo the object that contains the spatial reference to evaluate
  * @param templateDictionary the template dictionary
- * @return the extent to use as the fallback
+ * @returns the extent to use as the fallback
  * @private
  */
 export function _getFallbackExtent(serviceInfo, templateDictionary) {
@@ -1520,7 +1522,7 @@ export function _getFallbackExtent(serviceInfo, templateDictionary) {
  * Add relationships to all layers in one call to retain fully functioning composite relationships
  *
  * @param args The IPostProcessArgs for the request(s)
- * @return Any relationships that should be updated for the service
+ * @returns Any relationships that should be updated for the service
  * @private
  */
 export function _getRelationshipUpdates(args) {
@@ -1548,7 +1550,7 @@ export function _getRelationshipUpdates(args) {
  * @param obj parameters for the request
  * @param args various arguments to help support the request
  * @param type type of update the request will handle
- * @return IUpdate that has the request url and arguments
+ * @returns IUpdate that has the request url and arguments
  * @private
  */
 export function _getUpdate(url, id, obj, args, type) {
@@ -1592,6 +1594,7 @@ export function _getUpdate(url, id, obj, args, type) {
  *
  * @param base Item's base section
  * @param data Item's data section
+ * @private
  */
 export function _reportVariablesInItem(itemId, itemType, base, data) {
     const getUnresolved = (v) => {
@@ -1623,7 +1626,8 @@ export function _reportVariablesInItem(itemId, itemType, base, data) {
  * @param serviceInfo Service information
  * @param params arcgis-rest-js params to update
  * @param isPortal Is the service hosted in a portal?
- * @return Updated item
+ * @returns Updated item
+ * @private
  */
 export function _setItemProperties(item, itemTemplate, serviceInfo, params, isPortal) {
     // Set the capabilities
@@ -1701,7 +1705,7 @@ export function _setItemProperties(item, itemTemplate, serviceInfo, params, isPo
  * Set isUnique as true for indexes that reference origin relationship keyFields.
  *
  * @param serviceInfo Service information
- * @protected
+ * @private
  */
 export function _updateIndexesForRelationshipKeyFields(serviceInfo) {
     const layersAndTables = (serviceInfo.layers || []).concat(serviceInfo.tables || []);
@@ -1742,8 +1746,9 @@ export function _updateIndexesForRelationshipKeyFields(serviceInfo) {
  * @param url URL to assign to item's base section
  * @param authentication Credentials for the request
  * @param numAttempts Number of times to try to set the URL if AGO says that it updated the URL, but really didn't
- * @return A promise that will resolve with the item id when the item has been updated or an AGO-style JSON failure
+ * @returns A promise that will resolve with the item id when the item has been updated or an AGO-style JSON failure
  *         response
+ * @private
  */
 export function _updateItemURL(id, url, authentication, numAttempts = 1) {
     // Introduce a lag because AGO update appears to choke with rapid subsequent calls