@esri/solution-common 1.2.0 → 1.3.0

package/dist/umd/common.umd.js

@@ -1,7 +1,7 @@
 /* @preserve
-* @esri/solution-common - v1.2.0 - Apache-2.0
-* Copyright (c) 2018-2021 Esri, Inc.
-* Thu Dec 09 2021 16:01:08 GMT-0800 (Pacific Standard Time)
+* @esri/solution-common - v1.3.0 - Apache-2.0
+* Copyright (c) 2018-2022 Esri, Inc.
+* Thu Feb 17 2022 09:40:12 GMT-0800 (Pacific Standard Time)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -4834,6 +4834,28 @@
                     return a;
                 }, []);
             }
+            /**
+             * Get a property out of a deeply nested object
+             * Does not handle anything but nested object graph
+             *
+             * @param obj Object to retrieve value from
+             * @param path Path into an object, e.g., "data.values.webmap", where "data" is a top-level property
+             *             in obj
+             * @param defaultV Optional value to use if any part of path--including final value--is undefined
+             * @return Value at end of path
+             */
+            function getPropWithDefault(obj, path, defaultV) {
+                const value = path.split(".").reduce(function (prev, curr) {
+                    /* istanbul ignore next no need to test undefined scenario */
+                    return prev ? prev[curr] : undefined;
+                }, obj);
+                if (typeof value === "undefined") {
+                    return defaultV;
+                }
+                else {
+                    return value;
+                }
+            }
             /**
              * Updates a list of the items dependencies if more are found in the
              * provided value.
@@ -5691,6 +5713,7 @@
                     description: itemInfo.description,
                     snippet: itemInfo.snippet,
                     tags: itemInfo.tags,
+                    typeKeywords: itemInfo.typeKeywords,
                     title: itemInfo.title,
                     thumbnail: itemInfo.thumbnail
                 };
@@ -9949,16 +9972,6 @@
             function getUserSession(options = {}) {
                 return new arcgisRestAuth.UserSession(options);
             }
-            /**
-             * Searches for items matching a query and that the caller has access to.
-             *
-             * @param search Search string (e.g., "q=redlands+map")
-             * @return Promise resolving with search results
-             * @see https://developers.arcgis.com/rest/users-groups-and-items/search.htm
-             */
-            function searchItems(search) {
-                return portal.searchItems(search);
-            }
             /**
              * Adds a forward relationship between two items.
              *
@@ -10098,6 +10111,35 @@
                     }
                 });
             }
+            /**
+             * Converts a general search into an ISearchOptions structure.
+             *
+             * @param search Search specified in one of three ways
+             * @return 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 portal.SearchQueryBuilder) {
+                    // Insert query into defaults
+                    searchOptions.q = search.toParam();
+                }
+                else { // search is ISearchOptions
+                    searchOptions = {
+                        ...searchOptions,
+                        ...search // request
+                    };
+                }
+                return searchOptions;
+            }
             /**
              * 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
@@ -10174,7 +10216,7 @@
              * @return Original extent if it's already using outSR or the extents projected into the outSR
              */
             function convertExtent(extent, outSR, geometryServiceUrl, authentication) {
-                const _requestOptions = Object.assign({}, authentication);
+                const _requestOptions = { authentication };
                 return new Promise((resolve, reject) => {
                     // tslint:disable-next-line:no-unnecessary-type-assertion
                     if (extent.spatialReference.wkid === outSR?.wkid || !outSR) {
@@ -10899,6 +10941,51 @@
                     });
                 });
             }
+            /**
+             * 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
+             * @see https://developers.arcgis.com/rest/users-groups-and-items/search.htm
+             */
+            function searchItems(search) {
+                return portal.searchItems(search);
+            }
+            /**
+             * 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
+             * @return 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));
+                });
+            }
             /**
              * Searches for groups matching criteria.
              *
@@ -10932,7 +11019,7 @@
              */
             function searchAllGroups(searchString, authentication, groups, inPagingParams) {
                 const pagingParams = inPagingParams ? inPagingParams : {
-                    start: 0,
+                    start: 1,
                     num: 24
                 };
                 const additionalSearchOptions = {
@@ -10940,6 +11027,7 @@
                     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 => {
@@ -10954,6 +11042,46 @@
                     }, e => reject(e));
                 });
             }
+            /**
+             * 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
+             * @return 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));
+                });
+            }
             /**
              * Searches for group contents matching criteria.
              *
@@ -11069,6 +11197,27 @@
                     portal.updateItem(updateOptions).then(response => (response.success ? resolve(response) : reject(response)), err => reject(err));
                 });
             }
+            /**
+             * 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
+             * @return 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 ?? {})
+                        }
+                    };
+                    portal.updateGroup(updateOptions).then(response => (response.success ? resolve(response) : reject(response)), err => reject(err));
+                });
+            }
             /**
              * Updates an item.
              *
@@ -14849,6 +14998,7 @@
             exports.convertExtentWithFallback = convertExtentWithFallback;
             exports.convertItemResourceToStorageResource = convertItemResourceToStorageResource;
             exports.convertStorageResourceToItemResource = convertStorageResourceToItemResource;
+            exports.convertToISearchOptions = convertToISearchOptions;
             exports.convertWorkforceItemToTemplate = convertWorkforceItemToTemplate;
             exports.copyAssociatedFilesByType = copyAssociatedFilesByType;
             exports.copyDataIntoItem = copyDataIntoItem;
@@ -14950,6 +15100,7 @@
             exports.getPortalSharingUrlFromAuth = getPortalSharingUrlFromAuth;
             exports.getPortalUrlFromAuth = getPortalUrlFromAuth;
             exports.getProp = getProp;
+            exports.getPropWithDefault = getPropWithDefault;
             exports.getProps = getProps;
             exports.getReplaceValue = getReplaceValue;
             exports.getRequest = getRequest;
@@ -15008,6 +15159,8 @@
             exports.sanitizeURLProtocol = sanitizeURLProtocol;
             exports.saveBlobAsFile = saveBlobAsFile;
             exports.searchAllGroups = searchAllGroups;
+            exports.searchAllItems = searchAllItems;
+            exports.searchGroupAllContents = searchGroupAllContents;
             exports.searchGroupContents = searchGroupContents;
             exports.searchGroups = searchGroups;
             exports.searchItems = searchItems;
@@ -15028,6 +15181,7 @@
             exports.templatizeTracker = templatizeTracker;
             exports.templatizeWorkforce = templatizeWorkforce;
             exports.topologicallySortItems = topologicallySortItems;
+            exports.updateGroup = updateGroup;
             exports.updateItem = updateItem;
             exports.updateItemExtended = updateItemExtended;
             exports.updateItemResourceText = updateItemResourceText;