@esri/solution-common 3.0.0 → 3.1.0

package/dist/node/restHelpers.js

@@ -1,1887 +0,0 @@
-"use strict";
-/** @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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports._getContingentValuesUpdates = exports._getRelationshipUpdates = exports._getFallbackExtent = exports._getCreateServiceOptions = exports._countRelationships = exports._addItemMetadataFile = exports._addItemDataFile = exports.updateItemURL = exports.updateItemTemplateFromDictionary = exports.updateItemExtended = exports.updateGroup = exports.updateItem = exports.shareItem = exports.removeUsers = exports.reassignGroup = exports.searchGroupContents = exports.searchGroupAllContents = exports.searchAllGroups = exports.searchGroups = exports.searchAllItems = exports.searchItems = exports.removeItemOrGroup = exports.removeItem = exports.removeGroup = exports.removeFolder = exports.hasInvalidGroupDesignations = exports._parseAdminServiceData = exports.getFeatureServiceProperties = exports.getServiceLayersAndTables = exports.getRequest = exports._sortRelationships = exports.getLayerUpdates = exports.getLayers = exports.extractDependencies = exports.createUniqueGroup = exports.createUniqueFolder = exports.createItemWithData = exports.createFullItem = exports.createFeatureService = exports.convertExtent = exports.convertExtentWithFallback = exports._validateExtent = exports.convertToISearchOptions = exports.checkRequestStatus = exports.addToServiceDefinition = exports.addTokenToUrl = exports.addForwardItemRelationships = exports.addForwardItemRelationship = exports.getUserSession = exports.rest_request = void 0;
-exports._updateItemURL = exports._updateIndexesForRelationshipKeyFields = exports._setItemProperties = exports._reportVariablesInItem = exports._lowercaseDomain = exports._getUpdate = void 0;
-/**
- * Provides common functions involving the arcgis-rest-js library.
- *
- * @module restHelpers
- */
-const featureServiceHelpers_1 = require("./featureServiceHelpers");
-const generalHelpers_1 = require("./generalHelpers");
-const interfaces_1 = require("./interfaces");
-const libConnectors_1 = require("./libConnectors");
-const restHelpersGet_1 = require("./restHelpersGet");
-const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
-const arcgis_rest_request_1 = require("@esri/arcgis-rest-request");
-const arcgis_rest_service_admin_1 = require("@esri/arcgis-rest-service-admin");
-const workforceHelpers_1 = require("./workforceHelpers");
-const templatization_1 = require("./templatization");
-const trackingHelpers_1 = require("./trackingHelpers");
-// ------------------------------------------------------------------------------------------------------------------ //
-var arcgis_rest_request_2 = require("@esri/arcgis-rest-request");
-Object.defineProperty(exports, "rest_request", { enumerable: true, get: function () { return arcgis_rest_request_2.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/
- * @returns UserSession
- */
-function getUserSession(options = {}) {
-    return new interfaces_1.UserSession(options);
-}
-exports.getUserSession = getUserSession;
-/**
- * Adds a forward relationship between two items.
- *
- * @param originItemId Origin of relationship
- * @param destinationItemId Destination of relationship
- * @param relationshipType Type of relationship
- * @param authentication Credentials for the request
- * @returns A Promise to add item resources.
- */
-function addForwardItemRelationship(originItemId, destinationItemId, relationshipType, authentication) {
-    return new Promise(resolve => {
-        const requestOptions = {
-            originItemId,
-            destinationItemId,
-            relationshipType,
-            authentication
-        };
-        (0, arcgis_rest_portal_1.addItemRelationship)(requestOptions).then(response => {
-            resolve({
-                success: response.success,
-                itemId: originItemId
-            });
-        }, () => {
-            resolve({
-                success: false,
-                itemId: originItemId
-            });
-        });
-    });
-}
-exports.addForwardItemRelationship = addForwardItemRelationship;
-/**
- * Adds forward relationships for an item.
- *
- * @param originItemId Origin of relationship
- * @param destinationRelationships Destinations
- * @param authentication Credentials for the request
- * @returns A Promise to add item resources.
- */
-function addForwardItemRelationships(originItemId, destinationRelationships, authentication) {
-    return new Promise(resolve => {
-        // Set up relationships using updated relationship information
-        const relationshipPromises = new Array();
-        destinationRelationships.forEach(relationship => {
-            relationship.relatedItemIds.forEach(relatedItemId => {
-                relationshipPromises.push(addForwardItemRelationship(originItemId, relatedItemId, relationship.relationshipType, authentication));
-            });
-        });
-        // eslint-disable-next-line @typescript-eslint/no-floating-promises
-        Promise.all(relationshipPromises).then((responses) => resolve(responses));
-    });
-}
-exports.addForwardItemRelationships = addForwardItemRelationships;
-/**
- * Adds a token to the query parameters of a URL.
- *
- * @param url URL to use as base
- * @param authentication Credentials to be used to generate token for URL
- * @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) {
-    return new Promise(resolve => {
-        if (!url || !authentication) {
-            resolve(url);
-        }
-        else {
-            authentication.getToken(url).then(token => {
-                /* istanbul ignore else */
-                if (token) {
-                    url = (0, generalHelpers_1.appendQueryParam)(url, "token=" + token);
-                }
-                resolve(url);
-            }, () => resolve(url));
-        }
-    });
-}
-exports.addTokenToUrl = addTokenToUrl;
-/**
- * Calls addToDefinition for the service.
- *
- * Added retry due to some solutions failing to deploy in specific orgs/hives due to timeouts.
- * On the first pass we will use the quicker sync request to add.
- * If it fails we will use an async request that will avoid the timeout errors.
- *
- * @param url URL to use as base
- * @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
- * @returns A promise that will resolve when the request has completed
- */
-function addToServiceDefinition(url, options, skipRetry = false, useAsync = false) {
-    /* istanbul ignore else */
-    if (useAsync) {
-        options.params = { ...options.params, async: true };
-    }
-    return new Promise((resolve, reject) => {
-        (0, arcgis_rest_service_admin_1.addToServiceDefinition)(url, options).then((result) => {
-            checkRequestStatus(result, options.authentication).then(() => resolve(null), e => reject((0, generalHelpers_1.fail)(e)));
-        }, e => {
-            if (!skipRetry) {
-                addToServiceDefinition(url, options, true, true).then(() => resolve(null), e => reject(e));
-            }
-            else {
-                reject((0, generalHelpers_1.fail)(e));
-            }
-        });
-    });
-}
-exports.addToServiceDefinition = addToServiceDefinition;
-/**
- * When using an async request we need to poll the status url to know when the request has completed or failed.
- *
- * @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
- * @returns A promise that will resolve when the request has completed
- */
-function checkRequestStatus(result, authentication) {
-    return new Promise((resolve, reject) => {
-        if (result.statusURL) {
-            const checkStatus = setInterval(() => {
-                (0, arcgis_rest_request_1.request)(result.statusURL, { authentication }).then(r => {
-                    /* istanbul ignore else */
-                    if (r.status === "Completed") {
-                        clearInterval(checkStatus);
-                        resolve();
-                    }
-                    else if (r.status === "Failed") {
-                        clearInterval(checkStatus);
-                        reject(r);
-                    }
-                }, e => {
-                    clearInterval(checkStatus);
-                    reject(e);
-                });
-            }, 2000);
-        }
-        else {
-            resolve();
-        }
-    });
-}
-exports.checkRequestStatus = checkRequestStatus;
-/**
- * Converts a general search into an ISearchOptions structure.
- *
- * @param search Search specified in one of three ways
- * @returns Recast search
- */
-function convertToISearchOptions(search) {
-    // Convert the search into an ISearchOptions
-    let searchOptions = {
-        q: "",
-        start: 1,
-        num: 100
-    };
-    if (typeof search === "string") {
-        // Insert query into defaults
-        searchOptions.q = search;
-    }
-    else if (search instanceof arcgis_rest_portal_1.SearchQueryBuilder) {
-        // Insert query into defaults
-        searchOptions.q = search.toParam();
-    }
-    else { // search is ISearchOptions
-        searchOptions = {
-            ...searchOptions,
-            ...search // request
-        };
-    }
-    return searchOptions;
-}
-exports.convertToISearchOptions = convertToISearchOptions;
-/**
- * Simple validate function to ensure all coordinates are numbers
- * In some cases orgs can have null or undefined coordinate values associated with the org extent
- *
- * @param extent the extent to validate
- * @returns the provided extent or a default global extent if some coordinates are not numbers
- * @private
- */
-function _validateExtent(extent) {
-    // in some cases orgs can have invalid extents defined
-    // this is a simple validate function that will ensure coordiantes are numbers
-    // using -179,-89,179,89 because the project call is returning "NaN" when using -180,-90,180,90
-    const hasInvalid = typeof extent.xmin !== "number" ||
-        typeof extent.xmax !== "number" ||
-        typeof extent.ymax !== "number" ||
-        typeof extent.ymin !== "number";
-    if (hasInvalid) {
-        extent.xmin = -179;
-        extent.xmax = 179;
-        extent.ymax = 89;
-        extent.ymin = -89;
-        extent.spatialReference = { wkid: 4326 };
-    }
-    return extent;
-}
-exports._validateExtent = _validateExtent;
-/**
- * If the request to convert the extent fails it has commonly been due to an invalid extent.
- * This function will first attempt to use the provided extent. If it fails it will default to
- * the source items extent and if that fails it will then use a default global extent.
- *
- * @param extent the extent to convert
- * @param fallbackExtent the extent to convert if the main extent does not project to the outSR
- * @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
- * @returns the extent projected to the provided spatial reference
- * or the world extent projected to the provided spatial reference
- * @private
- */
-function convertExtentWithFallback(extent, fallbackExtent, outSR, geometryServiceUrl, authentication) {
-    return new Promise((resolve, reject) => {
-        const defaultExtent = {
-            xmin: -179,
-            xmax: 179,
-            ymin: -89,
-            ymax: 89,
-            spatialReference: { wkid: 4326 }
-        };
-        convertExtent(_validateExtent(extent), outSR, geometryServiceUrl, authentication).then(extentResponse => {
-            // in some cases project will complete successfully but return "NaN" values
-            // check for this and call convert again if it does
-            const extentResponseString = JSON.stringify(extentResponse);
-            const validatedExtent = JSON.stringify(_validateExtent(extentResponse));
-            if (extentResponseString === validatedExtent) {
-                resolve(extentResponse);
-            }
-            else {
-                convertExtent(fallbackExtent || defaultExtent, outSR, geometryServiceUrl, authentication).then(resolve, e => reject((0, generalHelpers_1.fail)(e)));
-            }
-        }, 
-        // if convert fails try again with default global extent
-        () => {
-            convertExtent(defaultExtent, outSR, geometryServiceUrl, authentication).then(resolve, e => reject((0, generalHelpers_1.fail)(e)));
-        });
-    });
-}
-exports.convertExtentWithFallback = convertExtentWithFallback;
-/**
- * Converts an extent to a specified spatial reference.
- *
- * @param extent Extent object to check and (possibly) to project
- * @param outSR Desired spatial reference
- * @param geometryServiceUrl Path to geometry service providing `findTransformations` and `project` services
- * @param authentication Credentials for the request
- * @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 };
-    return new Promise((resolve, reject) => {
-        // tslint:disable-next-line:no-unnecessary-type-assertion
-        if (extent.spatialReference.wkid === outSR?.wkid || !outSR) {
-            resolve(extent);
-        }
-        else {
-            _requestOptions.params = {
-                f: "json",
-                // tslint:disable-next-line:no-unnecessary-type-assertion
-                inSR: extent.spatialReference.wkid,
-                outSR: outSR.wkid,
-                extentOfInterest: JSON.stringify(extent)
-            };
-            (0, arcgis_rest_request_1.request)((0, generalHelpers_1.checkUrlPathTermination)(geometryServiceUrl) + "findTransformations", _requestOptions).then(response => {
-                const transformations = response && response.transformations
-                    ? response.transformations
-                    : undefined;
-                let transformation;
-                if (transformations && transformations.length > 0) {
-                    // if a forward single transformation is found use that...otherwise check for and use composite
-                    transformation = transformations[0].wkid
-                        ? transformations[0].wkid
-                        : transformations[0].geoTransforms
-                            ? transformations[0]
-                            : undefined;
-                }
-                _requestOptions.params = {
-                    f: "json",
-                    outSR: outSR.wkid,
-                    // tslint:disable-next-line:no-unnecessary-type-assertion
-                    inSR: extent.spatialReference.wkid,
-                    geometries: {
-                        geometryType: "esriGeometryPoint",
-                        geometries: [
-                            { x: extent.xmin, y: extent.ymin },
-                            { x: extent.xmax, y: extent.ymax }
-                        ]
-                    },
-                    transformation: transformation
-                };
-                (0, arcgis_rest_request_1.request)((0, generalHelpers_1.checkUrlPathTermination)(geometryServiceUrl) + "project", _requestOptions).then(projectResponse => {
-                    const projectGeom = projectResponse.geometries.length === 2
-                        ? projectResponse.geometries
-                        : undefined;
-                    if (projectGeom) {
-                        resolve({
-                            xmin: projectGeom[0].x,
-                            ymin: projectGeom[0].y,
-                            xmax: projectGeom[1].x,
-                            ymax: projectGeom[1].y,
-                            spatialReference: outSR
-                        });
-                    }
-                    else {
-                        resolve(undefined);
-                    }
-                }, e => reject((0, generalHelpers_1.fail)(e)));
-            }, e => reject((0, generalHelpers_1.fail)(e)));
-        }
-    });
-}
-exports.convertExtent = convertExtent;
-/**
- * Publishes a feature service as an AGOL item; it does not include its layers and tables
- *
- * @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
- * @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) => {
-        // Create item
-        _getCreateServiceOptions(newItemTemplate, authentication, templateDictionary).then(createOptions => {
-            (0, arcgis_rest_service_admin_1.createFeatureService)(createOptions).then(createResponse => {
-                // Federated servers may have inconsistent casing, so lowerCase it
-                createResponse.encodedServiceURL = _lowercaseDomain(createResponse.encodedServiceURL);
-                createResponse.serviceurl = _lowercaseDomain(createResponse.serviceurl);
-                resolve(createResponse);
-            }, e => reject((0, generalHelpers_1.fail)(e)));
-        }, e => reject((0, generalHelpers_1.fail)(e)));
-    });
-}
-exports.createFeatureService = createFeatureService;
-/**
- * Publishes an item and its data, metadata, and resources as an AGOL item.
- *
- * @param itemInfo Item's `item` section
- * @param folderId Id of folder to receive item; null indicates that the item goes into the root
- *                 folder; ignored for Group item type
- * @param destinationAuthentication Credentials for for requests to where the item is to be created
- * @param itemThumbnailUrl URL to image to use for item thumbnail
- * @param itemThumbnailAuthentication Credentials for requests to the thumbnail source
- * @param dataFile Item's `data` section
- * @param metadataFile Item's metadata file
- * @param resourcesFiles Item's resources
- * @param access Access to set for item: "public", "org", "private"
- * @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) => {
-        // Create item
-        const createOptions = {
-            item: {
-                ...itemInfo
-            },
-            folderId,
-            authentication: destinationAuthentication
-        };
-        // eslint-disable-next-line @typescript-eslint/no-floating-promises
-        addTokenToUrl(itemThumbnailUrl, itemThumbnailAuthentication).then(updatedThumbnailUrl => {
-            /* istanbul ignore else */
-            if (updatedThumbnailUrl) {
-                createOptions.item.thumbnailurl = (0, generalHelpers_1.appendQueryParam)(updatedThumbnailUrl, "w=400");
-            }
-            (0, arcgis_rest_portal_1.createItemInFolder)(createOptions).then(createResponse => {
-                if (createResponse.success) {
-                    let accessDef;
-                    // Set access if it is not AGOL default
-                    // Set the access manually since the access value in createItem appears to be ignored
-                    // Need to run serially; will not work reliably if done in parallel with adding the data section
-                    if (access !== "private") {
-                        const accessOptions = {
-                            id: createResponse.id,
-                            access: access === "public" ? "public" : "org",
-                            authentication: destinationAuthentication
-                        };
-                        accessDef = (0, arcgis_rest_portal_1.setItemAccess)(accessOptions);
-                    }
-                    else {
-                        accessDef = Promise.resolve({
-                            itemId: createResponse.id
-                        });
-                    }
-                    // Now add attached items
-                    accessDef.then(() => {
-                        const updateDefs = [];
-                        // Add the data section
-                        if (dataFile) {
-                            updateDefs.push(_addItemDataFile(createResponse.id, dataFile, destinationAuthentication));
-                        }
-                        // Add the resources via a zip because AGO sometimes loses resources if many are added at the
-                        // same time to the same item
-                        if (Array.isArray(resourcesFiles) &&
-                            resourcesFiles.length > 0) {
-                            updateDefs.push(new Promise((rsrcResolve, rsrcReject) => {
-                                (0, libConnectors_1.createZip)("resources.zip", resourcesFiles).then((zipfile) => {
-                                    const addResourceOptions = {
-                                        id: createResponse.id,
-                                        resource: zipfile,
-                                        authentication: destinationAuthentication,
-                                        params: {
-                                            archive: true
-                                        }
-                                    };
-                                    (0, arcgis_rest_portal_1.addItemResource)(addResourceOptions).then(rsrcResolve, rsrcReject);
-                                }, rsrcReject);
-                            }));
-                        }
-                        // Add the metadata section
-                        if (metadataFile) {
-                            updateDefs.push(_addItemMetadataFile(createResponse.id, metadataFile, destinationAuthentication));
-                        }
-                        // Wait until all adds are done
-                        Promise.all(updateDefs).then(() => resolve(createResponse), e => reject((0, generalHelpers_1.fail)(e)));
-                    }, e => reject((0, generalHelpers_1.fail)(e)));
-                }
-                else {
-                    reject((0, generalHelpers_1.fail)());
-                }
-            }, e => reject((0, generalHelpers_1.fail)(e)));
-        });
-    });
-}
-exports.createFullItem = createFullItem;
-/**
- * Publishes an item and its data as an AGOL item.
- *
- * @param itemInfo Item's `item` section
- * @param dataInfo Item's `data` section
- * @param authentication Credentials for the request
- * @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"
- * @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) => {
-        // Create item
-        const createOptions = {
-            item: {
-                title: "_",
-                ...itemInfo,
-                data: dataInfo
-            },
-            folderId,
-            authentication: authentication
-        };
-        if (itemInfo.thumbnail) {
-            createOptions.params = {
-                // Pass thumbnail file in via params because item property is serialized, which discards a blob
-                thumbnail: itemInfo.thumbnail
-            };
-            delete createOptions.item.thumbnail;
-        }
-        (0, arcgis_rest_portal_1.createItemInFolder)(createOptions).then(createResponse => {
-            if (createResponse.success) {
-                if (access !== "private") {
-                    // Set access if it is not AGOL default
-                    // Set the access manually since the access value in createItem appears to be ignored
-                    const accessOptions = {
-                        id: createResponse.id,
-                        access: access === "public" ? "public" : "org",
-                        authentication: authentication
-                    };
-                    (0, arcgis_rest_portal_1.setItemAccess)(accessOptions).then(() => {
-                        resolve({
-                            folder: createResponse.folder,
-                            id: createResponse.id,
-                            success: true
-                        });
-                    }, e => reject((0, generalHelpers_1.fail)(e)));
-                }
-                else {
-                    resolve({
-                        folder: createResponse.folder,
-                        id: createResponse.id,
-                        success: true
-                    });
-                }
-            }
-            else {
-                reject((0, generalHelpers_1.fail)());
-            }
-        }, e => reject((0, generalHelpers_1.fail)(e)));
-    });
-}
-exports.createItemWithData = createItemWithData;
-/**
- * Creates a folder using a numeric suffix to ensure uniqueness if necessary.
- *
- * @param title Folder title, used as-is if possible and with suffix otherwise
- * @param templateDictionary Hash of facts: org URL, adlib replacements, user; .user.folders property contains a list
- * 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
- * @returns Id of created folder
- */
-function createUniqueFolder(title, templateDictionary, authentication) {
-    return new Promise((resolve, reject) => {
-        // Get a title that is not already in use
-        const folderTitle = (0, generalHelpers_1.getUniqueTitle)(title, templateDictionary, "user.folders");
-        const folderCreationParam = {
-            title: folderTitle,
-            authentication: authentication
-        };
-        (0, arcgis_rest_portal_1.createFolder)(folderCreationParam).then(ok => resolve(ok), err => {
-            // If the name already exists, we'll try again
-            const errorDetails = (0, generalHelpers_1.getProp)(err, "response.error.details");
-            if (Array.isArray(errorDetails) && errorDetails.length > 0) {
-                const nameNotAvailMsg = "Folder title '" + folderTitle + "' not available.";
-                if (errorDetails.indexOf(nameNotAvailMsg) >= 0) {
-                    // Create the user.folders property if it doesn't exist
-                    /* istanbul ignore else */
-                    if (!(0, generalHelpers_1.getProp)(templateDictionary, "user.folders")) {
-                        (0, generalHelpers_1.setCreateProp)(templateDictionary, "user.folders", []);
-                    }
-                    templateDictionary.user.folders.push({
-                        title: folderTitle
-                    });
-                    createUniqueFolder(title, templateDictionary, authentication).then(resolve, reject);
-                }
-                else {
-                    reject(err);
-                }
-            }
-            else {
-                // Otherwise, error out
-                reject(err);
-            }
-        });
-    });
-}
-exports.createUniqueFolder = createUniqueFolder;
-/**
- * Creates a group using numeric suffix to ensure uniqueness.
- *
- * @param title Group title, used as-is if possible and with suffix otherwise
- * @param templateDictionary Hash of facts: org URL, adlib replacements, user
- * @param authentication Credentials for creating group
- * @param owner Optional arg for the Tracking owner
- *              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.
- * @returns Information about created group
- */
-function createUniqueGroup(title, groupItem, templateDictionary, authentication, owner) {
-    return new Promise((resolve, reject) => {
-        let groupsPromise;
-        // when working with tracker we need to consider the groups of the deploying user as well as the groups
-        // of the tracking user...must be unique for both
-        if (owner && owner !== authentication.username) {
-            groupsPromise = searchAllGroups(`(owner:${owner}) orgid:${templateDictionary.organization.id}`, authentication);
-        }
-        else {
-            groupsPromise = Promise.resolve([]);
-        }
-        // first get the tracker owner groups
-        groupsPromise.then(groups => {
-            templateDictionary["allGroups"] =
-                groups.concat((0, generalHelpers_1.getProp)(templateDictionary, "user.groups"));
-            // Get a title that is not already in use
-            groupItem.title = (0, generalHelpers_1.getUniqueTitle)(title, templateDictionary, "allGroups");
-            const groupCreationParam = {
-                group: groupItem,
-                authentication: authentication
-            };
-            (0, arcgis_rest_portal_1.createGroup)(groupCreationParam).then(resolve, err => {
-                // If the name already exists, we'll try again
-                const errorDetails = (0, generalHelpers_1.getProp)(err, "response.error.details");
-                if (Array.isArray(errorDetails) && errorDetails.length > 0) {
-                    const nameNotAvailMsg = "You already have a group named '" +
-                        groupItem.title +
-                        "'. Try a different name.";
-                    if (errorDetails.indexOf(nameNotAvailMsg) >= 0) {
-                        templateDictionary.user.groups.push({
-                            title: groupItem.title
-                        });
-                        createUniqueGroup(title, groupItem, templateDictionary, authentication).then(resolve, reject);
-                    }
-                    else {
-                        reject(err);
-                    }
-                }
-                else {
-                    // Otherwise, error out
-                    reject(err);
-                }
-            });
-        }, e => reject(e));
-    });
-}
-exports.createUniqueGroup = createUniqueGroup;
-/**
- * Gets the ids of the dependencies of an AGOL feature service item.
- * Dependencies will only exist when the service is a view.
- *
- * @param itemTemplate Template of item to be created
- * @param authentication Credentials for the request
- * @returns A promise that will resolve a list of dependencies
- */
-function extractDependencies(itemTemplate, authentication) {
-    const dependencies = [];
-    return new Promise((resolve, reject) => {
-        // Get service dependencies when the item is a view
-        // This step is skipped for tracker views as they will already have a source service in the org
-        if (itemTemplate.properties.service.isView && itemTemplate.item.url && !(0, trackingHelpers_1.isTrackingViewTemplate)(itemTemplate)) {
-            (0, arcgis_rest_request_1.request)((0, generalHelpers_1.checkUrlPathTermination)(itemTemplate.item.url) + "sources?f=json", {
-                authentication: authentication
-            }).then(response => {
-                /* istanbul ignore else */
-                if (response && response.services) {
-                    response.services.forEach((layer) => {
-                        dependencies.push({
-                            id: layer.serviceItemId,
-                            name: layer.name
-                        });
-                    });
-                }
-                resolve(dependencies);
-            }, e => reject((0, generalHelpers_1.fail)(e)));
-        }
-        else if ((0, workforceHelpers_1.isWorkforceProject)(itemTemplate)) {
-            resolve((0, workforceHelpers_1.getWorkforceDependencies)(itemTemplate, dependencies));
-        }
-        else {
-            resolve(dependencies);
-        }
-    });
-}
-exports.extractDependencies = extractDependencies;
-/**
- * Get json info for the services layers
- *
- * @param serviceUrl the url for the service
- * @param layerList list of base layer info
- * @param authentication Credentials for the request
- * @returns A promise that will resolve a list of dependencies
- */
-function getLayers(serviceUrl, layerList, authentication) {
-    return new Promise((resolve, reject) => {
-        if (layerList.length === 0) {
-            resolve([]);
-        }
-        // get the admin URL
-        serviceUrl = serviceUrl.replace("/rest/services", "/rest/admin/services");
-        const requestsDfd = [];
-        layerList.forEach(layer => {
-            const requestOptions = {
-                authentication: authentication
-            };
-            requestsDfd.push((0, arcgis_rest_request_1.request)((0, generalHelpers_1.checkUrlPathTermination)(serviceUrl) + layer["id"] + "?f=json", requestOptions));
-        });
-        // Wait until all layers are heard from
-        Promise.all(requestsDfd).then(layers => resolve(layers), e => reject((0, generalHelpers_1.fail)(e)));
-    });
-}
-exports.getLayers = getLayers;
-/**
- * Add additional options to a layers definition.
- *
- * @param args The IPostProcessArgs for the request(s)
- * @param isPortal boolean to indicate if we are deploying to portal
- *
- * @returns An array of update instructions
- * @private
- */
-function getLayerUpdates(args, isPortal) {
-    const adminUrl = args.itemTemplate.item.url.replace("rest/services", "rest/admin/services");
-    const updates = [];
-    const refresh = _getUpdate(adminUrl, null, null, args, "refresh");
-    updates.push(refresh);
-    Object.keys(args.objects).forEach(id => {
-        const obj = Object.assign({}, args.objects[id]);
-        // These properties cannot be set in the update definition when working with portal
-        if (isPortal) {
-            (0, generalHelpers_1.deleteProps)(obj, ["type", "id", "relationships", "sourceServiceFields"]);
-        }
-        // handle definition deletes
-        // removes previous editFieldsInfo fields if their names were changed
-        if (obj.hasOwnProperty("deleteFields")) {
-            updates.push(_getUpdate(adminUrl, id, obj, args, "delete"));
-            (0, generalHelpers_1.deleteProp)(obj, "deleteFields");
-            updates.push(_getUpdate(adminUrl, null, null, args, "refresh"));
-        }
-    });
-    // issue: #706
-    // Add source service relationships
-    // views will now always add all layers in a single call and will inherit the relationships from the source service
-    if (!args.itemTemplate.properties.service.isView) {
-        const relUpdates = _getRelationshipUpdates({
-            message: "updated layer relationships",
-            objects: args.objects,
-            itemTemplate: args.itemTemplate,
-            authentication: args.authentication
-        });
-        // issue: #724
-        // In portal the order the relationships are added needs to follow the layer order
-        // otherwise the relationship IDs will be reset
-        relUpdates.layers = _sortRelationships(args.itemTemplate.properties.layers, args.itemTemplate.properties.tables, relUpdates);
-        /* istanbul ignore else */
-        if (relUpdates.layers.length > 0) {
-            updates.push(_getUpdate(adminUrl, null, relUpdates, args, "add"));
-            updates.push(refresh);
-        }
-        // handle contingent values
-        const contingentValuesUpdates = _getContingentValuesUpdates({
-            message: "add layer contingent values",
-            objects: args.objects,
-            itemTemplate: args.itemTemplate,
-            authentication: args.authentication
-        });
-        /* istanbul ignore else */
-        if (contingentValuesUpdates.length > 0) {
-            contingentValuesUpdates.forEach(conUpdate => {
-                updates.push(_getUpdate(adminUrl + conUpdate.id, null, conUpdate.contingentValues, args, "add"));
-            });
-        }
-    }
-    return updates.length === 1 ? [] : updates;
-}
-exports.getLayerUpdates = getLayerUpdates;
-/**
- * Sorts relationships based on order of supporting layers and tables in the service definition
- *
- * @param layers the layers from the service
- * @param tables the tables from the service
- * @param relUpdates the relationships to add for the service
- *
- * @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));
-    // In portal the order the relationships are added needs to follow the layer order
-    // otherwise the relationship IDs will be reset
-    const _relUpdateLayers = [];
-    ids.forEach(id => {
-        relUpdates.layers.some((relUpdate) => {
-            if (id === relUpdate.id) {
-                _relUpdateLayers.push(relUpdate);
-                return true;
-            }
-            else {
-                return false;
-            }
-        });
-    });
-    return _relUpdateLayers;
-}
-exports._sortRelationships = _sortRelationships;
-/**
- * Add additional options to a layers definition
- *
- * Added retry due to some solutions failing to deploy in specific orgs/hives
- *
- *
- * @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
- * @returns A promise that will resolve when service definition call has completed
- * @private
- */
-/* istanbul ignore else */
-function getRequest(update, skipRetry = false, useAsync = false) {
-    return new Promise((resolve, reject) => {
-        const options = {
-            params: update.params,
-            authentication: update.args.authentication
-        };
-        /* istanbul ignore else */
-        if ((useAsync && update.url.indexOf("addToDefinition") > -1) ||
-            update.url.indexOf("updateDefinition") > -1 ||
-            update.url.indexOf("deleteFromDefinition") > -1) {
-            options.params = { ...options.params, async: true };
-        }
-        (0, arcgis_rest_request_1.request)(update.url, options).then(result => {
-            checkRequestStatus(result, options.authentication).then(() => resolve(null), e => reject((0, generalHelpers_1.fail)(e)));
-        }, (e) => {
-            if (!skipRetry) {
-                getRequest(update, true, true).then(() => resolve(), e => reject(e));
-            }
-            else {
-                reject(e);
-            }
-        });
-    });
-}
-exports.getRequest = getRequest;
-/**
- * Fills in missing data, including full layer and table definitions, in a feature services' definition.
- *
- * @param itemTemplate Feature service item, data, dependencies definition to be modified
- * @param authentication Credentials for the request to AGOL
- * @returns A promise that will resolve when fullItem has been updated
- * @private
- */
-function getServiceLayersAndTables(itemTemplate, authentication) {
-    return new Promise((resolve, reject) => {
-        // To have enough information for reconstructing the service, we'll supplement
-        // the item and data sections with sections for the service, full layers, and
-        // full tables
-        // Extra steps must be taken for workforce version 2
-        const isWorkforceService = (0, workforceHelpers_1.isWorkforceProject)(itemTemplate);
-        // Get the service description
-        if (itemTemplate.item.url) {
-            getFeatureServiceProperties(itemTemplate.item.url, authentication, isWorkforceService).then(properties => {
-                itemTemplate.properties = properties;
-                resolve(itemTemplate);
-            }, e => reject((0, generalHelpers_1.fail)(e)));
-        }
-        else {
-            resolve(itemTemplate);
-        }
-    });
-}
-exports.getServiceLayersAndTables = getServiceLayersAndTables;
-/**
- * Get service properties for the given url and update key props
- *
- * @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
- * @returns A promise that will resolve with the service properties
- * @private
- */
-function getFeatureServiceProperties(serviceUrl, authentication, workforceService = false) {
-    return new Promise((resolve, reject) => {
-        const properties = {
-            service: {},
-            layers: [],
-            tables: []
-        };
-        // get the admin URL
-        serviceUrl = serviceUrl.replace("/rest/services", "/rest/admin/services");
-        // Get the service description
-        (0, arcgis_rest_request_1.request)(serviceUrl + "?f=json", {
-            authentication: authentication
-        }).then(serviceData => {
-            properties.service = _parseAdminServiceData(serviceData);
-            // Copy cacheMaxAge to top level so that AGO sees it when deploying the service
-            // serviceData may have set it if there isn't an adminServiceInfo
-            /* istanbul ignore else */
-            if (serviceData.adminServiceInfo?.cacheMaxAge) {
-                properties.service.cacheMaxAge =
-                    serviceData.adminServiceInfo.cacheMaxAge;
-            }
-            // Move the layers and tables out of the service's data section
-            /* istanbul ignore else */
-            if (serviceData.layers) {
-                properties.layers = serviceData.layers;
-                // Fill in properties that the service layer doesn't provide
-                // and remove properties that should not exist in the template
-                properties.layers.forEach(layer => {
-                    layer.serviceItemId = properties.service.serviceItemId;
-                    layer.extent = null;
-                    (0, featureServiceHelpers_1.removeLayerOptimization)(layer);
-                });
-            }
-            delete serviceData.layers;
-            /* istanbul ignore else */
-            if (serviceData.tables) {
-                properties.tables = serviceData.tables;
-                // Fill in properties that the service layer doesn't provide
-                properties.tables.forEach(table => {
-                    table.serviceItemId = properties.service.serviceItemId;
-                    table.extent = null;
-                });
-            }
-            delete serviceData.tables;
-            // Ensure solution items have unique indexes on relationship key fields
-            _updateIndexesForRelationshipKeyFields(properties);
-            (0, featureServiceHelpers_1.processContingentValues)(properties, serviceUrl, authentication).then(() => {
-                if (workforceService) {
-                    (0, workforceHelpers_1.getWorkforceServiceInfo)(properties, serviceUrl, authentication).then(resolve, reject);
-                }
-                else {
-                    resolve(properties);
-                }
-            }, (e) => reject((0, generalHelpers_1.fail)(e)));
-        }, (e) => reject((0, generalHelpers_1.fail)(e)));
-    });
-}
-exports.getFeatureServiceProperties = getFeatureServiceProperties;
-/**
- * Parses the layers array and will filter subsets of Layers and Tables
- * 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
- * @returns A mutated version of the provided adminData
- * @private
- */
-function _parseAdminServiceData(adminData) {
-    const layers = adminData.layers || [];
-    const tables = adminData.tables || [];
-    (0, generalHelpers_1.setCreateProp)(adminData, "layers", layers.filter(l => l.type === "Feature Layer"));
-    // TODO understand if the concat is necessary.
-    // Not sure if the admin api will ever actually return a tables collection here.
-    (0, generalHelpers_1.setCreateProp)(adminData, "tables", tables.concat(layers.filter(l => l.type === "Table")));
-    return adminData;
-}
-exports._parseAdminServiceData = _parseAdminServiceData;
-/**
- * livingatlas designation test.
- * These layers should not be templatized or depolyed
- *
- * @param groupDesignations the items group designations to evaluate
- * @returns A boolean indicating if the invalid designation is found in the item info
- */
-function hasInvalidGroupDesignations(groupDesignations) {
-    const invalidGroupDesignations = ["livingatlas"];
-    return groupDesignations
-        ? invalidGroupDesignations.indexOf(groupDesignations) > -1
-        : false;
-}
-exports.hasInvalidGroupDesignations = hasInvalidGroupDesignations;
-/**
- * Removes a folder from AGO.
- *
- * @param folderId Id of a folder to delete
- * @param authentication Credentials for the request to AGO
- * @returns A promise that will resolve with the result of the request
- */
-function removeFolder(folderId, authentication) {
-    return new Promise((resolve, reject) => {
-        const requestOptions = {
-            folderId: folderId,
-            authentication: authentication
-        };
-        (0, arcgis_rest_portal_1.removeFolder)(requestOptions).then(result => (result.success ? resolve(result) : reject(result)), reject);
-    });
-}
-exports.removeFolder = removeFolder;
-/**
- * Removes a group from AGO.
- *
- * @param groupId Id of a group to delete
- * @param authentication Credentials for the request to AGO
- * @returns A promise that will resolve with the result of the request
- */
-function removeGroup(groupId, authentication) {
-    return new Promise((resolve, reject) => {
-        const requestOptions = {
-            id: groupId,
-            authentication: authentication
-        };
-        (0, arcgis_rest_portal_1.removeGroup)(requestOptions).then(result => (result.success ? resolve(result) : reject(result)), reject);
-    });
-}
-exports.removeGroup = removeGroup;
-/**
- * Removes an item from AGO.
- *
- * @param itemId Id of an item to delete
- * @param authentication Credentials for the request to AGO
- * @returns A promise that will resolve with the result of the request
- */
-function removeItem(itemId, authentication) {
-    return new Promise((resolve, reject) => {
-        const requestOptions = {
-            id: itemId,
-            authentication: authentication
-        };
-        (0, arcgis_rest_portal_1.removeItem)(requestOptions).then(result => (result.success ? resolve(result) : reject(result)), reject);
-    });
-}
-exports.removeItem = removeItem;
-/**
- * Removes an item or group from AGO.
- *
- * @param itemId Id of an item or group to delete
- * @param authentication Credentials for the request to AGO
- * @returns A promise that will resolve with the result of the request
- */
-function removeItemOrGroup(itemId, authentication) {
-    return new Promise((resolve, reject) => {
-        removeItem(itemId, authentication).then(resolve, error => {
-            removeGroup(itemId, authentication).then(resolve, () => reject(error));
-        });
-    });
-}
-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
- * @returns Promise resolving with search results
- * @see https://developers.arcgis.com/rest/users-groups-and-items/search.htm
- */
-function searchItems(search) {
-    return (0, arcgis_rest_portal_1.searchItems)(search);
-}
-exports.searchItems = searchItems;
-/**
- * Searches for items matching a query and that the caller has access to, continuing recursively until done.
- *
- * @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
- * @returns Promise resolving with search results
- * @see https://developers.arcgis.com/rest/users-groups-and-items/search.htm
- */
-function searchAllItems(search, accumulatedResponse) {
-    // Convert the search into an ISearchOptions
-    const searchOptions = convertToISearchOptions(search);
-    // Provide a base into which results can be concatenated
-    const completeResponse = accumulatedResponse ? accumulatedResponse : {
-        query: searchOptions.q,
-        start: 1,
-        num: 100,
-        nextStart: -1,
-        total: 0,
-        results: []
-    };
-    return new Promise((resolve, reject) => {
-        searchItems(search).then(response => {
-            completeResponse.results = completeResponse.results.concat(response.results);
-            completeResponse.num = completeResponse.total = completeResponse.results.length;
-            if (response.nextStart > 0) {
-                // Insert nextStart into next query
-                searchOptions.start = response.nextStart;
-                resolve(searchAllItems(searchOptions, completeResponse));
-            }
-            else {
-                resolve(completeResponse);
-            }
-        }, e => reject(e));
-    });
-}
-exports.searchAllItems = searchAllItems;
-/**
- * Searches for groups matching criteria.
- *
- * @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
- * @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
- */
-function searchGroups(searchString, authentication, additionalSearchOptions) {
-    const searchOptions = {
-        q: searchString,
-        params: {
-            ...additionalSearchOptions
-        },
-        authentication: authentication
-    };
-    return (0, arcgis_rest_portal_1.searchGroups)(searchOptions);
-}
-exports.searchGroups = searchGroups;
-/**
- * Searches for groups matching criteria recurusively.
- *
- * @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 groups List of groups that have been found from previous requests
- * @param inPagingParams The paging params for the recurisve searching
- *
- * @returns A promise that will resolve with all groups that meet the search criteria
- */
-function searchAllGroups(searchString, authentication, groups, inPagingParams) {
-    const pagingParams = inPagingParams ? inPagingParams : {
-        start: 1,
-        num: 24
-    };
-    const additionalSearchOptions = {
-        sortField: "title",
-        sortOrder: "asc",
-        ...pagingParams
-    };
-    // Provide a base onto which results can be concatenated
-    let finalResults = groups ? groups : [];
-    return new Promise((resolve, reject) => {
-        searchGroups(searchString, authentication, additionalSearchOptions).then(response => {
-            finalResults = finalResults.concat(response.results);
-            if (response.nextStart > 0) {
-                pagingParams.start = response.nextStart;
-                resolve(searchAllGroups(searchString, authentication, finalResults, pagingParams));
-            }
-            else {
-                resolve(finalResults);
-            }
-        }, e => reject(e));
-    });
-}
-exports.searchAllGroups = searchAllGroups;
-/**
- * Searches for group contents matching criteria recursively.
- *
- * @param groupId Group whose contents are to be searched
- * @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 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
- * @param accumulatedResponse Response built from previous requests
- * @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
- */
-function searchGroupAllContents(groupId, searchString, authentication, additionalSearchOptions, portalUrl, accumulatedResponse) {
-    additionalSearchOptions = additionalSearchOptions ? additionalSearchOptions : {};
-    // Provide a base into which results can be concatenated
-    const completeResponse = accumulatedResponse ? accumulatedResponse : {
-        query: searchString,
-        start: 1,
-        num: 100,
-        nextStart: -1,
-        total: 0,
-        results: []
-    };
-    return new Promise((resolve, reject) => {
-        searchGroupContents(groupId, searchString, authentication, additionalSearchOptions, portalUrl).then(response => {
-            completeResponse.results = completeResponse.results.concat(response.results);
-            completeResponse.num = completeResponse.total = completeResponse.results.length;
-            if (response.nextStart > 0) {
-                additionalSearchOptions.start = response.nextStart;
-                resolve(searchGroupAllContents(groupId, searchString, authentication, additionalSearchOptions, portalUrl, completeResponse));
-            }
-            else {
-                resolve(completeResponse);
-            }
-        }, e => reject(e));
-    });
-}
-exports.searchGroupAllContents = searchGroupAllContents;
-/**
- * Searches for group contents matching criteria.
- *
- * @param groupId Group whose contents are to be searched
- * @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 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
- * @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
- */
-function searchGroupContents(groupId, searchString, authentication, additionalSearchOptions, portalUrl) {
-    const searchOptions = {
-        groupId,
-        q: searchString,
-        params: Object.assign({
-            num: 100
-        }, additionalSearchOptions),
-        authentication: authentication,
-        portal: portalUrl
-    };
-    // If search options include `categories`, switch to new arcgis-rest-js format
-    /* istanbul ignore else */
-    if (Array.isArray(searchOptions.params.categories)) {
-        searchOptions.params.categories = searchOptions.params.categories.map(andGroup => andGroup.split(","));
-    }
-    return (0, arcgis_rest_portal_1.searchGroupContent)(searchOptions);
-}
-exports.searchGroupContents = searchGroupContents;
-/**
- * Reassign ownership of a group
- *
- * @param groupId Group to remove users from
- * @param userName The new owner for the group
- * @param authentication Credentials for the request to
- *
- * @returns A promise that will resolve after the group ownership has been assigned
- *
- */
-function reassignGroup(groupId, userName, authentication) {
-    const requestOptions = {
-        authentication: authentication,
-        params: {
-            targetUsername: userName
-        }
-    };
-    return (0, arcgis_rest_request_1.request)(`${authentication.portal}/community/groups/${groupId}/reassign`, requestOptions);
-}
-exports.reassignGroup = reassignGroup;
-/**
- * Remove users from a group
- *
- * @param groupId Group to remove users from
- * @param users List of users to remove from the group
- * @param authentication Credentials for the request to
- *
- * @returns A promise that will resolve after the users have been removed
- *
- */
-function removeUsers(groupId, users, authentication) {
-    return (0, arcgis_rest_portal_1.removeGroupUsers)({
-        id: groupId,
-        users,
-        authentication
-    });
-}
-exports.removeUsers = removeUsers;
-/**
- * Shares an item to the defined group
- *
- * @param groupId Group to share with
- * @param id the item id to share with the group
- * @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)
- *
- * @returns A promise that will resolve after the item has been shared
- *
- */
-function shareItem(groupId, id, destinationAuthentication, owner) {
-    return new Promise((resolve, reject) => {
-        const shareOptions = {
-            groupId,
-            id,
-            authentication: destinationAuthentication
-        };
-        /* istanbul ignore else */
-        if (owner) {
-            shareOptions.owner = owner;
-        }
-        (0, arcgis_rest_portal_1.shareItemWithGroup)(shareOptions).then(() => resolve(null), (e) => reject((0, generalHelpers_1.fail)(e)));
-    });
-}
-exports.shareItem = shareItem;
-/**
- * Updates an item.
- *
- * @param itemInfo The base info of an item; note that this content will be serialized, which doesn't work
- * for binary content
- * @param authentication Credentials for request
- * @param folderId Item's folder
- * @param additionalParams Updates that are put under the `params` property, which is not serialized
- * @return
- */
-function updateItem(itemInfo, authentication, folderId, additionalParams) {
-    return new Promise((resolve, reject) => {
-        const updateOptions = {
-            item: itemInfo,
-            folderId: folderId,
-            authentication: authentication,
-            params: {
-                ...(additionalParams ?? {})
-            }
-        };
-        (0, arcgis_rest_portal_1.updateItem)(updateOptions).then(response => (response.success ? resolve(response) : reject(response)), err => reject(err));
-    });
-}
-exports.updateItem = updateItem;
-/**
- * Updates a group.
- *
- * @param groupInfo The base info of a group; note that this content will be serialized, which doesn't work
- * for binary content
- * @param authentication Credentials for request
- * @param additionalParams Updates that are put under the `params` property, which is not serialized
- * @returns A Promise that will resolve with the success/failure status of the request
- */
-function updateGroup(groupInfo, authentication, additionalParams) {
-    return new Promise((resolve, reject) => {
-        const updateOptions = {
-            group: groupInfo,
-            authentication,
-            params: {
-                ...(additionalParams ?? {})
-            }
-        };
-        (0, arcgis_rest_portal_1.updateGroup)(updateOptions).then(response => (response.success ? resolve(response) : reject(response)), err => reject(err));
-    });
-}
-exports.updateGroup = updateGroup;
-/**
- * Updates an item.
- *
- * @param itemInfo The base info of an item
- * @param data The items data section
- * @param authentication Credentials for requests
- * @param thumbnail optional thumbnail to update
- * @param access "public" or "org"
- * @return
- */
-function updateItemExtended(itemInfo, data, authentication, thumbnail, access, templateDictionary) {
-    return new Promise((resolve, reject) => {
-        const updateOptions = {
-            item: itemInfo,
-            params: {
-                text: data || {} // AGO ignores update if `data` is empty
-            },
-            authentication: authentication
-        };
-        if (thumbnail) {
-            updateOptions.params.thumbnail = thumbnail;
-        }
-        if ((0, trackingHelpers_1.isTrackingViewTemplate)(undefined, itemInfo) && templateDictionary) {
-            updateOptions.owner = templateDictionary.locationTracking.owner;
-        }
-        (0, arcgis_rest_portal_1.updateItem)(updateOptions).then(result => {
-            if (access && access !== "private") {
-                // Set access if it is not AGOL default
-                // Set the access manually since the access value in createItem appears to be ignored
-                const accessOptions = {
-                    id: itemInfo.id,
-                    access: access === "public" ? "public" : "org",
-                    authentication: authentication
-                };
-                (0, arcgis_rest_portal_1.setItemAccess)(accessOptions).then(() => resolve(result), e => reject((0, generalHelpers_1.fail)(e)));
-            }
-            else {
-                resolve(result);
-            }
-        }, e => reject((0, generalHelpers_1.fail)(e)));
-    });
-}
-exports.updateItemExtended = updateItemExtended;
-/**
- * Update an item's base and data using a dictionary.
- *
- * @param {string} itemId The item ID
- * @param {any} templateDictionary The template dictionary
- * @param {UserSession} authentication The destination session info
- * @returns Promise resolving to successfulness of update
- */
-function updateItemTemplateFromDictionary(itemId, templateDictionary, authentication) {
-    return new Promise((resolve, reject) => {
-        // Fetch the items as stored in AGO
-        Promise.all([
-            (0, restHelpersGet_1.getItemBase)(itemId, authentication),
-            (0, restHelpersGet_1.getItemDataAsJson)(itemId, authentication)
-        ])
-            .then(([item, data]) => {
-            // Do they have any variables?
-            if ((0, templatization_1.hasUnresolvedVariables)(item) || (0, templatization_1.hasUnresolvedVariables)(data)) {
-                // Update if so
-                const { item: updatedItem, data: updatedData } = (0, templatization_1.replaceInTemplate)({ item, data }, templateDictionary);
-                _reportVariablesInItem(itemId, item.type, updatedItem, updatedData);
-                return updateItemExtended(updatedItem, updatedData, authentication);
-            }
-            else {
-                // Shortcut out if not
-                return Promise.resolve({
-                    success: true,
-                    id: itemId
-                });
-            }
-        })
-            .then(result => resolve(result))
-            .catch(error => reject(error));
-    });
-}
-exports.updateItemTemplateFromDictionary = updateItemTemplateFromDictionary;
-/**
- * Updates the URL of an item.
- *
- * @param id AGOL id of item to update
- * @param url URL to assign to item's base section
- * @param authentication Credentials for the request
- * @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) {
-    const numAttempts = 3;
-    return _updateItemURL(id, url, authentication, numAttempts);
-}
-exports.updateItemURL = updateItemURL;
-// ------------------------------------------------------------------------------------------------------------------ //
-/**
- * Adds a data section to an item.
- *
- * @param itemId Id of item to receive data file
- * @param dataFile Data to be added
- * @param authentication Credentials for the request
- * @returns Promise reporting success or failure
- * @private
- */
-function _addItemDataFile(itemId, dataFile, authentication) {
-    return new Promise((resolve, reject) => {
-        const addItemData = (data) => {
-            const addDataOptions = {
-                id: itemId,
-                data: data,
-                authentication: authentication
-            };
-            (0, arcgis_rest_portal_1.addItemData)(addDataOptions).then(resolve, reject);
-        };
-        // Item data has to be submitted as text or JSON for those file types
-        if (dataFile.type.startsWith("text/plain")) {
-            (0, generalHelpers_1.blobToText)(dataFile).then(addItemData, reject);
-        }
-        else if (dataFile.type === "application/json") {
-            (0, generalHelpers_1.blobToJson)(dataFile).then(addItemData, reject);
-        }
-        else {
-            addItemData(dataFile);
-        }
-    });
-}
-exports._addItemDataFile = _addItemDataFile;
-/**
- * Adds a metadata file to an item.
- *
- * @param itemId Id of item to receive data file
- * @param metadataFile Metadata to be added
- * @param authentication Credentials for the request
- * @returns Promise reporting success or failure
- * @private
- */
-function _addItemMetadataFile(itemId, metadataFile, authentication) {
-    return new Promise((resolve, reject) => {
-        const addMetadataOptions = {
-            item: {
-                id: itemId
-            },
-            params: {
-                // Pass metadata in via params because item property is serialized, which discards a blob
-                metadata: metadataFile
-            },
-            authentication: authentication
-        };
-        (0, arcgis_rest_portal_1.updateItem)(addMetadataOptions).then(resolve, reject);
-    });
-}
-exports._addItemMetadataFile = _addItemMetadataFile;
-/**
- * Accumulates the number of relationships in a collection of layers.
- *
- * @param List of layers to examine
- * @returns The number of relationships
- * @private
- */
-function _countRelationships(layers) {
-    const reducer = (accumulator, currentLayer) => accumulator +
-        (currentLayer.relationships ? currentLayer.relationships.length : 0);
-    return layers.reduce(reducer, 0);
-}
-exports._countRelationships = _countRelationships;
-/**
- * Gets the full definitions of the layers affiliated with a hosted service.
- *
- * @param serviceUrl URL to hosted service
- * @param layerList List of layers at that service...must contain id
- * @param authentication Credentials for the request
- * @returns A promise that will resolve with a list of the layers from the admin api
- * @private
- */
-function _getCreateServiceOptions(newItemTemplate, authentication, templateDictionary) {
-    return new Promise((resolve, reject) => {
-        const serviceInfo = newItemTemplate.properties;
-        const folderId = templateDictionary.folderId;
-        const isPortal = templateDictionary.isPortal;
-        const itemId = newItemTemplate.itemId;
-        (0, featureServiceHelpers_1.validateSpatialReferenceAndExtent)(serviceInfo, newItemTemplate, templateDictionary);
-        const fallbackExtent = _getFallbackExtent(serviceInfo, templateDictionary);
-        const params = {};
-        const itemInfo = {
-            title: newItemTemplate.item.title,
-            name: newItemTemplate.item.name
-        };
-        const _item = {
-            ...itemInfo,
-            preserveLayerIds: true
-        };
-        const createOptions = {
-            item: _item,
-            folderId,
-            params,
-            authentication: authentication
-        };
-        createOptions.item = !(0, trackingHelpers_1.isTrackingViewTemplate)(newItemTemplate) ?
-            _setItemProperties(createOptions.item, newItemTemplate, serviceInfo, params, isPortal) :
-            (0, trackingHelpers_1.setTrackingOptions)(newItemTemplate, createOptions, templateDictionary);
-        // project the portals extent to match that of the service
-        convertExtentWithFallback(templateDictionary.organization.defaultExtent, fallbackExtent, serviceInfo.service.spatialReference, templateDictionary.organization.helperServices.geometry.url, authentication).then(extent => {
-            templateDictionary[itemId].solutionExtent = extent;
-            (0, featureServiceHelpers_1.setDefaultSpatialReference)(templateDictionary, itemId, extent.spatialReference);
-            createOptions.item = (0, templatization_1.replaceInTemplate)(createOptions.item, templateDictionary);
-            createOptions.params = (0, templatization_1.replaceInTemplate)(createOptions.params, templateDictionary);
-            if (newItemTemplate.item.thumbnail) {
-                // Pass thumbnail file in via params because item property is serialized, which discards a blob
-                createOptions.params.thumbnail = newItemTemplate.item.thumbnail;
-            }
-            resolve(createOptions);
-        }, e => reject((0, generalHelpers_1.fail)(e)));
-    });
-}
-exports._getCreateServiceOptions = _getCreateServiceOptions;
-/**
- * When the services spatial reference does not match that of it's default extent
- * use the out SRs default extent if it exists in the templateDictionary
- * this should be set when adding a custom out wkid to the params before calling deploy
- * this will help avoid situations where the orgs default extent and default world extent
- * will not project successfully to the out SR
- *
- * @param serviceInfo the object that contains the spatial reference to evaluate
- * @param templateDictionary the template dictionary
- * @returns the extent to use as the fallback
- * @private
- */
-function _getFallbackExtent(serviceInfo, templateDictionary) {
-    const serviceSR = serviceInfo.service.spatialReference;
-    const serviceInfoWkid = (0, generalHelpers_1.getProp)(serviceInfo, "defaultExtent.spatialReference.wkid");
-    const customDefaultExtent = (0, generalHelpers_1.getProp)(templateDictionary, "params.defaultExtent");
-    return serviceInfoWkid && serviceInfoWkid === serviceSR.wkid
-        ? serviceInfo.defaultExtent
-        : customDefaultExtent
-            ? customDefaultExtent
-            : serviceInfo.defaultExtent;
-}
-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)
- * @returns Any relationships that should be updated for the service
- * @private
- */
-function _getRelationshipUpdates(args) {
-    const rels = {
-        layers: []
-    };
-    Object.keys(args.objects).forEach((k) => {
-        const obj = args.objects[k];
-        /* istanbul ignore else */
-        if (obj.relationships && obj.relationships.length > 0) {
-            rels.layers.push({
-                id: obj.id,
-                relationships: obj.relationships
-            });
-        }
-        (0, generalHelpers_1.deleteProp)(obj, "relationships");
-    });
-    return rels;
-}
-exports._getRelationshipUpdates = _getRelationshipUpdates;
-/**
- * Get the stored contingent values and structure them to be added to the services layers.
- *
- * @param args The IPostProcessArgs for the request(s)
- * @returns Any contingent values that should be added to the service.
- * @private
- */
-function _getContingentValuesUpdates(args) {
-    const contingentValues = [];
-    Object.keys(args.objects).forEach((k) => {
-        const obj = args.objects[k];
-        /* istanbul ignore else */
-        if (obj.contingentValues) {
-            contingentValues.push({
-                id: obj.id,
-                contingentValues: obj.contingentValues
-            });
-        }
-        (0, generalHelpers_1.deleteProp)(obj, "contingentValues");
-    });
-    return contingentValues;
-}
-exports._getContingentValuesUpdates = _getContingentValuesUpdates;
-/**
- * Get refresh, add, update, or delete definition info
- *
- * @param url the base admin url for the service
- * @param id the id of the layer
- * @param obj parameters for the request
- * @param args various arguments to help support the request
- * @param type type of update the request will handle
- * @returns IUpdate that has the request url and arguments
- * @private
- */
-function _getUpdate(url, id, obj, args, type) {
-    const ops = {
-        delete: {
-            url: (0, generalHelpers_1.checkUrlPathTermination)(url) + id + "/deleteFromDefinition",
-            params: {
-                deleteFromDefinition: {
-                    fields: obj && obj.hasOwnProperty("deleteFields") ? obj.deleteFields : []
-                }
-            }
-        },
-        update: {
-            url: (0, generalHelpers_1.checkUrlPathTermination)(url) +
-                (id ? `${id}/updateDefinition` : "updateDefinition"),
-            params: {
-                updateDefinition: obj
-            }
-        },
-        add: {
-            url: (0, generalHelpers_1.checkUrlPathTermination)(url) + "addToDefinition",
-            params: {
-                addToDefinition: obj
-            }
-        },
-        refresh: {
-            url: (0, generalHelpers_1.checkUrlPathTermination)(url) + "refresh",
-            params: {
-                f: "json"
-            }
-        }
-    };
-    return {
-        url: ops[type].url,
-        params: ops[type].params,
-        args: args
-    };
-}
-exports._getUpdate = _getUpdate;
-/**
- * Changes just the domain part of a URL to lowercase.
- *
- * @param url URL to modify
- * @return Adjusted URL
- * @see From `getServerRootUrl` in arcgis-rest-js' ArcGISIdentityManager.ts
- * @private
- */
-function _lowercaseDomain(url) {
-    if (!url) {
-        return url;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const [_, protocol, domainAndPath] = url.match(/(https?:\/\/)(.+)/);
-    const [domain, ...path] = domainAndPath.split("/");
-    // Only the domain is lowercased because in some cases an org id might be
-    // in the path which cannot be lowercased.
-    return `${protocol}${domain.toLowerCase()}/${path.join("/")}`;
-}
-exports._lowercaseDomain = _lowercaseDomain;
-/**
- * Checks the two main parts of an item for unresolved variables and reports any found.
- *
- * @param base Item's base section
- * @param data Item's data section
- * @private
- */
-function _reportVariablesInItem(itemId, itemType, base, data) {
-    const getUnresolved = (v) => {
-        return JSON.stringify(v).match(/{{.+?}}/gim);
-    };
-    // Provide feedback about any remaining unresolved variables
-    /* istanbul ignore else */
-    if (base && (0, templatization_1.hasUnresolvedVariables)(base)) {
-        console.log(itemId +
-            " (" +
-            itemType +
-            ") contains variables in base: " +
-            JSON.stringify(getUnresolved(base)));
-    }
-    /* istanbul ignore else */
-    if (data && (0, templatization_1.hasUnresolvedVariables)(data)) {
-        console.log(itemId +
-            " (" +
-            itemType +
-            ") contains variables in data: " +
-            JSON.stringify(getUnresolved(data)));
-    }
-}
-exports._reportVariablesInItem = _reportVariablesInItem;
-/**
- * Updates a feature service item.
- *
- * @param item Item to update
- * @param itemTemplate item template for the new item
- * @param serviceInfo Service information
- * @param params arcgis-rest-js params to update
- * @param isPortal Is the service hosted in a portal?
- * @returns Updated item
- * @private
- */
-function _setItemProperties(item, itemTemplate, serviceInfo, params, isPortal) {
-    // Set the capabilities
-    const portalCapabilities = [
-        "Create",
-        "Query",
-        "Editing",
-        "Update",
-        "Delete",
-        "Uploads",
-        "Sync",
-        "Extract"
-    ];
-    const capabilities = (0, generalHelpers_1.getProp)(serviceInfo, "service.capabilities") || (isPortal ? "" : []);
-    item.capabilities = isPortal
-        ? capabilities
-            .split(",")
-            .filter((c) => portalCapabilities.indexOf(c) > -1)
-            .join(",")
-        : capabilities;
-    if (serviceInfo.service.capabilities) {
-        serviceInfo.service.capabilities = item.capabilities;
-    }
-    // Handle index update for any pre-published solution items that
-    // have non-unique indexes on relationship key fields
-    _updateIndexesForRelationshipKeyFields(serviceInfo);
-    // set create options item properties
-    const keyProperties = [
-        "isView",
-        "sourceSchemaChangesAllowed",
-        "isUpdatableView",
-        "capabilities",
-        "isMultiServicesView"
-    ];
-    const deleteKeys = ["layers", "tables"];
-    /* istanbul ignore else */
-    if (isPortal) {
-        // removed for issue #423 causing FS to fail to create
-        deleteKeys.push("adminServiceInfo");
-    }
-    const itemKeys = Object.keys(item);
-    const serviceKeys = Object.keys(serviceInfo.service);
-    serviceKeys.forEach(k => {
-        /* istanbul ignore else */
-        if (itemKeys.indexOf(k) === -1 && deleteKeys.indexOf(k) < 0) {
-            item[k] = serviceInfo.service[k];
-            // These need to be included via params otherwise...
-            // addToDef calls fail when adding adminLayerInfo
-            /* istanbul ignore else */
-            if (serviceInfo.service.isView && keyProperties.indexOf(k) > -1) {
-                params[k] = serviceInfo.service[k];
-            }
-        }
-    });
-    // Enable editor tracking on layer with related tables is not supported.
-    /* istanbul ignore else */
-    if (item.isMultiServicesView &&
-        (0, generalHelpers_1.getProp)(item, "editorTrackingInfo.enableEditorTracking")) {
-        item.editorTrackingInfo.enableEditorTracking = false;
-        params["editorTrackingInfo"] = item.editorTrackingInfo;
-    }
-    /* istanbul ignore else */
-    if (isPortal) {
-        // portal will fail when initialExtent is defined but null
-        // removed for issue #449 causing FS to fail to create on portal
-        /* istanbul ignore else */
-        if (Object.keys(item).indexOf("initialExtent") > -1 &&
-            !item.initialExtent) {
-            (0, generalHelpers_1.deleteProp)(item, "initialExtent");
-        }
-    }
-    return item;
-}
-exports._setItemProperties = _setItemProperties;
-/**
- * Set isUnique as true for indexes that reference origin relationship keyFields.
- *
- * @param serviceInfo Service information
- * @private
- */
-function _updateIndexesForRelationshipKeyFields(serviceInfo) {
-    const layersAndTables = (serviceInfo.layers || []).concat(serviceInfo.tables || []);
-    layersAndTables.forEach(item => {
-        const relationships = item.relationships;
-        const indexes = item.indexes;
-        /* istanbul ignore else */
-        if (relationships &&
-            relationships.length > 0 &&
-            indexes &&
-            indexes.length > 0) {
-            const keyFields = relationships.reduce((acc, v) => {
-                /* istanbul ignore else */
-                if (v.role === "esriRelRoleOrigin" &&
-                    v.keyField &&
-                    acc.indexOf(v.keyField) < 0) {
-                    acc.push(v.keyField);
-                }
-                return acc;
-            }, []);
-            indexes.map(i => {
-                /* istanbul ignore else */
-                if (keyFields.some(k => {
-                    const regEx = new RegExp(`\\b${k}\\b`);
-                    return regEx.test(i.fields);
-                })) {
-                    i.isUnique = true;
-                }
-                return i;
-            });
-        }
-    });
-}
-exports._updateIndexesForRelationshipKeyFields = _updateIndexesForRelationshipKeyFields;
-/**
- * Updates the URL of an item.
- *
- * @param id AGOL id of item to update
- * @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
- * @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
-    const msLag = 1000;
-    return new Promise((resolve, reject) => {
-        // Update the item's URL
-        const options = { item: { id, url }, authentication: authentication };
-        (0, arcgis_rest_portal_1.updateItem)(options).then(result => {
-            if (!result.success) {
-                reject((0, generalHelpers_1.fail)(result));
-            }
-            else {
-                // Get the item to see if the URL really changed; we'll delay a bit before testing because AGO
-                // has a timing problem with URL updates
-                setTimeout(() => {
-                    (0, arcgis_rest_portal_1.getItem)(id, { authentication: authentication }).then(item => {
-                        const iBrace = item.url.indexOf("{");
-                        if (iBrace > -1) {
-                            console.warn(id + " has template variable: " + item.url.substr(iBrace));
-                        }
-                        if (url === item.url) {
-                            resolve(id);
-                        }
-                        else {
-                            // If it fails, try again if we have sufficient attempts remaining
-                            const errorMsg = "URL not updated for " +
-                                item.type +
-                                " " +
-                                item.id +
-                                ": " +
-                                item.url +
-                                " (" +
-                                numAttempts +
-                                ")";
-                            if (--numAttempts > 0) {
-                                _updateItemURL(id, url, authentication, numAttempts).then(resolve, reject);
-                            }
-                            else {
-                                console.error(id + ": " + errorMsg + "; FAILED");
-                                reject(errorMsg);
-                            }
-                        }
-                    }, e => reject((0, generalHelpers_1.fail)(e)));
-                }, msLag);
-            }
-        }, e => reject((0, generalHelpers_1.fail)(e)));
-    });
-}
-exports._updateItemURL = _updateItemURL;
-//# sourceMappingURL=restHelpers.js.map