@esri/solution-common 1.3.10 → 1.3.13

package/dist/node/restHelpers.js

@@ -41,7 +41,7 @@ Object.defineProperty(exports, "rest_request", { enumerable: true, get: function
  * 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
  */
 function getUserSession(options = {}) {
     return new interfaces_1.UserSession(options);
@@ -54,7 +54,7 @@ exports.getUserSession = getUserSession;
  * @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.
  */
 function addForwardItemRelationship(originItemId, destinationItemId, relationshipType, authentication) {
     return new Promise(resolve => {
@@ -84,7 +84,7 @@ exports.addForwardItemRelationship = addForwardItemRelationship;
  * @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.
  */
 function addForwardItemRelationships(originItemId, destinationRelationships, authentication) {
     return new Promise(resolve => {
@@ -105,7 +105,7 @@ exports.addForwardItemRelationships = addForwardItemRelationships;
  *
  * @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
  */
 function addTokenToUrl(url, authentication) {
@@ -136,7 +136,7 @@ exports.addTokenToUrl = addTokenToUrl;
  * @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
  */
 function addToServiceDefinition(url, options, skipRetry = false, useAsync = false) {
     /* istanbul ignore else */
@@ -163,7 +163,7 @@ exports.addToServiceDefinition = addToServiceDefinition;
  * @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
  */
 function checkRequestStatus(result, authentication) {
     return new Promise((resolve, reject) => {
@@ -195,7 +195,7 @@ exports.checkRequestStatus = checkRequestStatus;
  * Converts a general search into an ISearchOptions structure.
  *
  * @param search Search specified in one of three ways
- * @return Recast search
+ * @returns Recast search
  */
 function convertToISearchOptions(search) {
     // Convert the search into an ISearchOptions
@@ -226,7 +226,7 @@ exports.convertToISearchOptions = convertToISearchOptions;
  * 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
  */
 function _validateExtent(extent) {
@@ -257,7 +257,7 @@ exports._validateExtent = _validateExtent;
  * @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
  */
@@ -296,7 +296,7 @@ exports.convertExtentWithFallback = convertExtentWithFallback;
  * @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
  */
 function convertExtent(extent, outSR, geometryServiceUrl, authentication) {
     const _requestOptions = { authentication };
@@ -368,7 +368,7 @@ exports.convertExtent = convertExtent;
  * @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
  */
 function createFeatureService(newItemTemplate, authentication, templateDictionary) {
     return new Promise((resolve, reject) => {
@@ -394,7 +394,7 @@ exports.createFeatureService = createFeatureService;
  * @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
  */
 function createFullItem(itemInfo, folderId, destinationAuthentication, itemThumbnailUrl, itemThumbnailAuthentication, dataFile, metadataFile, resourcesFiles, access = "private") {
     return new Promise((resolve, reject) => {
@@ -481,7 +481,7 @@ exports.createFullItem = createFullItem;
  * @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
  */
 function createItemWithData(itemInfo, dataInfo, authentication, folderId, access = "private") {
     return new Promise((resolve, reject) => {
@@ -543,7 +543,7 @@ exports.createItemWithData = createItemWithData;
  * 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
  */
 function createUniqueFolder(title, templateDictionary, authentication) {
     return new Promise((resolve, reject) => {
@@ -591,7 +591,7 @@ exports.createUniqueFolder = createUniqueFolder;
  *              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
  */
 function createUniqueGroup(title, groupItem, templateDictionary, authentication, owner) {
     return new Promise((resolve, reject) => {
@@ -646,7 +646,7 @@ exports.createUniqueGroup = createUniqueGroup;
  *
  * @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
  */
 function extractDependencies(itemTemplate, authentication) {
     const dependencies = [];
@@ -684,7 +684,7 @@ exports.extractDependencies = extractDependencies;
  * @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
  */
 function getLayers(serviceUrl, layerList, authentication) {
     return new Promise((resolve, reject) => {
@@ -711,7 +711,7 @@ exports.getLayers = getLayers;
  * @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
  */
 function getLayerUpdates(args, isPortal) {
@@ -769,7 +769,8 @@ exports.getLayerUpdates = getLayerUpdates;
  * @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
  */
 function _sortRelationships(layers, tables, relUpdates) {
     const ids = [].concat(layers.map((l) => l.id), tables.map((t) => t.id));
@@ -799,7 +800,7 @@ exports._sortRelationships = _sortRelationships;
  * @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
  */
 function getFinalServiceUpdates(itemTemplate, authentication, updates) {
     const sourceSchemaChangesAllowed = (0, generalHelpers_1.getProp)(itemTemplate, "properties.service.sourceSchemaChangesAllowed");
@@ -825,7 +826,7 @@ exports.getFinalServiceUpdates = getFinalServiceUpdates;
  *
  * @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 */
@@ -859,7 +860,7 @@ exports.getRequest = getRequest;
  *
  * @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
  */
 function getServiceLayersAndTables(itemTemplate, authentication) {
@@ -888,7 +889,7 @@ exports.getServiceLayersAndTables = getServiceLayersAndTables;
  * @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
  */
 function getFeatureServiceProperties(serviceUrl, authentication, workforceService = false) {
@@ -952,7 +953,8 @@ exports.getFeatureServiceProperties = getFeatureServiceProperties;
  * 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
  */
 function _parseAdminServiceData(adminData) {
     const layers = adminData.layers || [];
@@ -969,7 +971,7 @@ exports._parseAdminServiceData = _parseAdminServiceData;
  * 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
  */
 function hasInvalidGroupDesignations(groupDesignations) {
     const invalidGroupDesignations = ["livingatlas"];
@@ -983,7 +985,7 @@ exports.hasInvalidGroupDesignations = hasInvalidGroupDesignations;
  *
  * @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
  */
 function removeFolder(folderId, authentication) {
     return new Promise((resolve, reject) => {
@@ -1000,7 +1002,7 @@ exports.removeFolder = removeFolder;
  *
  * @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
  */
 function removeGroup(groupId, authentication) {
     return new Promise((resolve, reject) => {
@@ -1017,7 +1019,7 @@ exports.removeGroup = removeGroup;
  *
  * @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
  */
 function removeItem(itemId, authentication) {
     return new Promise((resolve, reject) => {
@@ -1034,7 +1036,7 @@ exports.removeItem = removeItem;
  *
  * @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
  */
 function removeItemOrGroup(itemId, authentication) {
     return new Promise((resolve, reject) => {
@@ -1048,7 +1050,7 @@ exports.removeItemOrGroup = removeItemOrGroup;
  * 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
  */
 function searchItems(search) {
@@ -1060,7 +1062,7 @@ exports.searchItems = searchItems;
  *
  * @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
  */
 function searchAllItems(search, accumulatedResponse) {
@@ -1097,7 +1099,7 @@ exports.searchAllItems = searchAllItems;
  * @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
@@ -1121,7 +1123,7 @@ exports.searchGroups = searchGroups;
  * @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
  */
 function searchAllGroups(searchString, authentication, groups, inPagingParams) {
     const pagingParams = inPagingParams ? inPagingParams : {
@@ -1159,7 +1161,7 @@ exports.searchAllGroups = searchAllGroups;
  * 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
@@ -1199,7 +1201,7 @@ exports.searchGroupAllContents = searchGroupAllContents;
  * @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
@@ -1229,7 +1231,7 @@ exports.searchGroupContents = searchGroupContents;
  * @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
  *
  */
 function reassignGroup(groupId, userName, authentication) {
@@ -1249,7 +1251,7 @@ exports.reassignGroup = reassignGroup;
  * @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
  *
  */
 function removeUsers(groupId, users, authentication) {
@@ -1268,7 +1270,7 @@ exports.removeUsers = removeUsers;
  * @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
  *
  */
 function shareItem(groupId, id, destinationAuthentication, owner) {
@@ -1317,7 +1319,7 @@ exports.updateItem = updateItem;
  * 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
  */
 function updateGroup(groupInfo, authentication, additionalParams) {
     return new Promise((resolve, reject) => {
@@ -1417,7 +1419,7 @@ exports.updateItemTemplateFromDictionary = updateItemTemplateFromDictionary;
  * @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
  */
 function updateItemURL(id, url, authentication) {
@@ -1432,7 +1434,7 @@ exports.updateItemURL = updateItemURL;
  * @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
  */
 function _addItemDataFile(itemId, dataFile, authentication) {
@@ -1464,7 +1466,7 @@ exports._addItemDataFile = _addItemDataFile;
  * @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
  */
 function _addItemMetadataFile(itemId, metadataFile, authentication) {
@@ -1487,7 +1489,7 @@ exports._addItemMetadataFile = _addItemMetadataFile;
  * 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
  */
 function _countRelationships(layers) {
@@ -1502,7 +1504,7 @@ exports._countRelationships = _countRelationships;
  * @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
  */
 function _getCreateServiceOptions(newItemTemplate, authentication, templateDictionary) {
@@ -1555,7 +1557,7 @@ exports._getCreateServiceOptions = _getCreateServiceOptions;
  *
  * @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
  */
 function _getFallbackExtent(serviceInfo, templateDictionary) {
@@ -1573,7 +1575,7 @@ exports._getFallbackExtent = _getFallbackExtent;
  * 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
  */
 function _getRelationshipUpdates(args) {
@@ -1602,7 +1604,7 @@ exports._getRelationshipUpdates = _getRelationshipUpdates;
  * @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
  */
 function _getUpdate(url, id, obj, args, type) {
@@ -1647,6 +1649,7 @@ exports._getUpdate = _getUpdate;
  *
  * @param base Item's base section
  * @param data Item's data section
+ * @private
  */
 function _reportVariablesInItem(itemId, itemType, base, data) {
     const getUnresolved = (v) => {
@@ -1679,7 +1682,8 @@ exports._reportVariablesInItem = _reportVariablesInItem;
  * @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
  */
 function _setItemProperties(item, itemTemplate, serviceInfo, params, isPortal) {
     // Set the capabilities
@@ -1758,7 +1762,7 @@ exports._setItemProperties = _setItemProperties;
  * Set isUnique as true for indexes that reference origin relationship keyFields.
  *
  * @param serviceInfo Service information
- * @protected
+ * @private
  */
 function _updateIndexesForRelationshipKeyFields(serviceInfo) {
     const layersAndTables = (serviceInfo.layers || []).concat(serviceInfo.tables || []);
@@ -1800,8 +1804,9 @@ exports._updateIndexesForRelationshipKeyFields = _updateIndexesForRelationshipKe
  * @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
  */
 function _updateItemURL(id, url, authentication, numAttempts = 1) {
     // Introduce a lag because AGO update appears to choke with rapid subsequent calls