@esri/arcgis-rest-portal 4.4.0 → 4.5.0

package/README.md

@@ -1,13 +1,10 @@
 [![npm version][npm-img]][npm-url]
-[![build status][travis-img]][travis-url]
 [![gzip bundle size][gzip-image]][npm-url]
 [![Coverage Status][coverage-img]][coverage-url]
 [![apache licensed](https://img.shields.io/badge/license-Apache-green.svg?style=flat-square)](https://raw.githubusercontent.com/Esri/arcgis-rest-js/master/LICENSE)
 
 [npm-img]: https://img.shields.io/npm/v/@esri/arcgis-rest-portal.svg?style=flat-square
 [npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-portal
-[travis-img]: https://img.shields.io/travis/Esri/arcgis-rest-js/master.svg?style=flat-square
-[travis-url]: https://travis-ci.org/Esri/arcgis-rest-js
 [gzip-image]: https://img.badgesize.io/https://unpkg.com/@esri/arcgis-rest-portal/dist/bundled/portal.umd.min.js?compression=gzip
 [coverage-img]: https://codecov.io/gh/Esri/arcgis-rest-js/branch/master/graph/badge.svg
 [coverage-url]: https://codecov.io/gh/Esri/arcgis-rest-js
@@ -33,7 +30,7 @@ getItem(itemId).then((response) => {
 });
 ```
 
-### [API Reference](https://esri.github.io/arcgis-rest-js/api/portal/)
+### [API Reference](https://developers.arcgis.com/arcgis-rest-js/api-reference/arcgis-rest-portal/)
 
 ### Issues
 

package/dist/bundled/portal.esm.js

@@ -1,7 +1,7 @@
 /* @preserve
-* @esri/arcgis-rest-portal - v4.3.0 - Apache-2.0
-* Copyright (c) 2017-2023 Esri, Inc.
-* Wed Sep 06 2023 15:33:48 GMT+0000 (Coordinated Universal Time)
+* @esri/arcgis-rest-portal - v4.4.1 - Apache-2.0
+* Copyright (c) 2017-2025 Esri, Inc.
+* Thu Jan 23 2025 20:04:52 GMT+0000 (Coordinated Universal Time)
 */
 import { cleanUrl, request, appendCustomParams, warn } from '@esri/arcgis-rest-request';
 
@@ -866,15 +866,15 @@ function searchGroupUsers(id, searchOptions) {
 
 /* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
-function getSharingUrl(requestOptions) {
-    const username = requestOptions.authentication.username;
-    const owner = requestOptions.owner || username;
+function getSharingUrl(requestOptions, username) {
+    const providedUsername = username || requestOptions.authentication.username; // as any workaround for backward compatibility for discovering username from provided auth method
+    const owner = requestOptions.owner || providedUsername;
     return `${getPortalUrl(requestOptions)}/content/users/${encodeURIComponent(owner)}/items/${requestOptions.id}/share`;
 }
-function isItemOwner(requestOptions) {
-    const username = requestOptions.authentication.username;
-    const owner = requestOptions.owner || username;
-    return owner === username;
+function isItemOwner(requestOptions, username) {
+    const providedUsername = username || requestOptions.authentication.username; // as any workaround for backward compatibility for discovering username from provided auth method
+    const owner = requestOptions.owner || providedUsername;
+    return owner === providedUsername;
 }
 /**
  * Check it the user is a full org_admin
@@ -882,8 +882,7 @@ function isItemOwner(requestOptions) {
  * @returns Promise resolving in a boolean indicating if the user is an ArcGIS Organization administrator
  */
 function isOrgAdmin(requestOptions) {
-    const session = requestOptions.authentication;
-    return session.getUser(requestOptions).then((user) => {
+    return requestOptions.authentication.getUser().then((user) => {
         return user && user.role === "org_admin" && !user.roleId;
     });
 }
@@ -1937,6 +1936,7 @@ function updateGroup(requestOptions) {
  * updateUserMemberships({
  *   id: groupId,
  *   admins: ["username3"],
+ *   newMemberType: "admin",
  *   authentication
  * })
  * .then(response);
@@ -2074,6 +2074,30 @@ function _combineResults(responses) {
     return combined;
 }
 
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+/**
+ * Used to determine the username to use in a request. Will use the `username` passed in the
+ * `requestOptions` if present, otherwise will use the username from the `authentication` option.
+ * This method is used internally to determine the username to use in a request and is async to
+ * support the case where the username is not immediately available.
+ *
+ * @param requestOptions the requests options
+ * @returns the authentecated users username encoded for use in a URL.
+ */
+async function determineUsername(requestOptions) {
+    var _a;
+    if (requestOptions.username) {
+        return encodeURIComponent(requestOptions.username);
+    }
+    if ((_a = requestOptions.authentication) === null || _a === void 0 ? void 0 : _a.username) {
+        return encodeURIComponent(requestOptions.authentication.username);
+    }
+    if (requestOptions.authentication) {
+        return requestOptions.authentication.getUsername().then(encodeURIComponent);
+    }
+}
+
 /* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 /**
@@ -2090,7 +2114,7 @@ function _combineResults(responses) {
  * @param requestOptions - options to pass through in the request
  * @returns A Promise that will resolve with metadata about the user
  */
-function getUser(requestOptions) {
+async function getUser(requestOptions) {
     let url;
     let options = { httpMethod: "GET" };
     // if a username is passed, assume ArcGIS Online
@@ -2099,8 +2123,8 @@ function getUser(requestOptions) {
     }
     else {
         // if an authenticated session is passed, default to that user/portal unless another username is provided manually
-        const username = requestOptions.username || requestOptions.authentication.username;
-        url = `${getPortalUrl(requestOptions)}/community/users/${encodeURIComponent(username)}`;
+        const username = await determineUsername(requestOptions);
+        url = `${getPortalUrl(requestOptions)}/community/users/${username}`;
         options = Object.assign(Object.assign({}, requestOptions), options);
     }
     // send the request
@@ -2125,9 +2149,9 @@ function getUser(requestOptions) {
  * @param IGetUserOptions - options to pass through in the request
  * @returns A Promise that will resolve with the user tag array
  */
-function getUserTags(requestOptions) {
-    const username = requestOptions.username || requestOptions.authentication.username;
-    const url = `${getPortalUrl(requestOptions)}/community/users/${encodeURIComponent(username)}/tags`;
+async function getUserTags(requestOptions) {
+    const username = await determineUsername(requestOptions);
+    const url = `${getPortalUrl(requestOptions)}/community/users/${username}/tags`;
     // send the request
     return request(url, requestOptions);
 }
@@ -2139,6 +2163,7 @@ function getUserTags(requestOptions) {
  *
  * @param session
  * @returns User url to be used in API requests.
+ * @deprecated This function requires a synchronous  `username` on the session object which is not guaranteed. Use `getUser` instead. This function will be removed in the next release.
  */
 function getUserUrl(session) {
     return `${getPortalUrl(session)}/community/users/${encodeURIComponent(session.username)}`;
@@ -2159,9 +2184,9 @@ function getUserUrl(session) {
  * @param requestOptions - options to pass through in the request
  * @returns A Promise that will resolve with the user's invitations
  */
-function getUserInvitations(requestOptions) {
+async function getUserInvitations(requestOptions) {
     let options = { httpMethod: "GET" };
-    const username = encodeURIComponent(requestOptions.authentication.username);
+    const username = await determineUsername(requestOptions);
     const portalUrl = getPortalUrl(requestOptions);
     const url = `${portalUrl}/community/users/${username}/invitations`;
     options = Object.assign(Object.assign({}, requestOptions), options);
@@ -2184,8 +2209,8 @@ function getUserInvitations(requestOptions) {
  * @param requestOptions - options to pass through in the request
  * @returns A Promise that will resolve with the invitation
  */
-function getUserInvitation(requestOptions) {
-    const username = encodeURIComponent(requestOptions.authentication.username);
+async function getUserInvitation(requestOptions) {
+    const username = await determineUsername(requestOptions);
     const portalUrl = getPortalUrl(requestOptions);
     const url = `${portalUrl}/community/users/${username}/invitations/${requestOptions.invitationId}`;
     let options = { httpMethod: "GET" };
@@ -2209,8 +2234,8 @@ function getUserInvitation(requestOptions) {
  * @param requestOptions - Options for the request
  * @returns A Promise that will resolve with the success/failure status of the request
  */
-function acceptInvitation(requestOptions) {
-    const username = encodeURIComponent(requestOptions.authentication.username);
+async function acceptInvitation(requestOptions) {
+    const username = await determineUsername(requestOptions);
     const portalUrl = getPortalUrl(requestOptions);
     const url = `${portalUrl}/community/users/${username}/invitations/${requestOptions.invitationId}/accept`;
     const options = Object.assign({}, requestOptions);
@@ -2232,8 +2257,8 @@ function acceptInvitation(requestOptions) {
  * @param requestOptions - Options for the request
  * @returns A Promise that will resolve with the success/failure status of the request
  */
-function declineInvitation(requestOptions) {
-    const username = encodeURIComponent(requestOptions.authentication.username);
+async function declineInvitation(requestOptions) {
+    const username = await determineUsername(requestOptions);
     const portalUrl = getPortalUrl(requestOptions);
     const url = `${portalUrl}/community/users/${username}/invitations/${requestOptions.invitationId}/decline`;
     const options = Object.assign({}, requestOptions);
@@ -2256,9 +2281,9 @@ function declineInvitation(requestOptions) {
  * @param requestOptions - options to pass through in the request
  * @returns A Promise that will resolve with the user's notifications
  */
-function getUserNotifications(requestOptions) {
+async function getUserNotifications(requestOptions) {
     let options = { httpMethod: "GET" };
-    const username = encodeURIComponent(requestOptions.authentication.username);
+    const username = await determineUsername(requestOptions);
     const portalUrl = getPortalUrl(requestOptions);
     const url = `${portalUrl}/community/users/${username}/notifications`;
     options = Object.assign(Object.assign({}, requestOptions), options);
@@ -2271,8 +2296,8 @@ function getUserNotifications(requestOptions) {
  * @param requestOptions - Options for the request
  * @returns A Promise that will resolve with the success/failure status of the request
  */
-function removeNotification(requestOptions) {
-    const username = encodeURIComponent(requestOptions.authentication.username);
+async function removeNotification(requestOptions) {
+    const username = await determineUsername(requestOptions);
     const portalUrl = getPortalUrl(requestOptions);
     const url = `${portalUrl}/community/users/${username}/notifications/${requestOptions.id}/delete`;
     return request(url, requestOptions);
@@ -2337,9 +2362,10 @@ function searchCommunityUsers(search) {
  * @param requestOptions - options to pass through in the request
  * @returns A Promise that will resolve with metadata about the user
  */
-function updateUser(requestOptions) {
+async function updateUser(requestOptions) {
     // default to the authenticated username unless another username is provided manually
-    const username = requestOptions.user.username || requestOptions.authentication.username;
+    const username = requestOptions.user.username ||
+        (await requestOptions.authentication.getUsername());
     const updateUrl = `${getPortalUrl(requestOptions)}/community/users/${encodeURIComponent(username)}/update`;
     // mixin custom params and the user information, then drop the user info
     requestOptions.params = Object.assign(Object.assign({}, requestOptions.user), requestOptions.params);
@@ -2408,9 +2434,10 @@ async function setUserProperties(username, properties, requestOptions) {
  * @param requestOptions - Options for the request.
  * @returns A Promise that will resolve with the data from the response.
  */
-function setItemAccess(requestOptions) {
-    const url = getSharingUrl(requestOptions);
-    if (isItemOwner(requestOptions)) {
+async function setItemAccess(requestOptions) {
+    const username = await requestOptions.authentication.getUsername();
+    const url = getSharingUrl(requestOptions, username);
+    if (isItemOwner(requestOptions, username)) {
         // if the user owns the item, proceed
         return updateItemAccess(url, requestOptions);
     }
@@ -2422,7 +2449,7 @@ function setItemAccess(requestOptions) {
             }
             else {
                 // if neither, updating the sharing isnt possible
-                throw Error(`This item can not be shared by ${requestOptions.authentication.username}. They are neither the item owner nor an organization admin.`);
+                throw Error(`This item can not be shared by ${username}. They are neither the item owner nor an organization admin.`);
             }
         });
     }
@@ -2503,9 +2530,9 @@ function isItemSharedWithGroup(requestOptions) {
  * @param requestOptions - Options for the request.
  * @returns A Promise that will resolve with the data from the response.
  */
-function shareItemWithGroup(requestOptions) {
+async function shareItemWithGroup(requestOptions) {
     return isItemSharedWithGroup(requestOptions)
-        .then((isShared) => {
+        .then(async (isShared) => {
         if (isShared) {
             // already shared, exit early with success response
             return {
@@ -2514,7 +2541,8 @@ function shareItemWithGroup(requestOptions) {
                 notSharedWith: []
             };
         }
-        const { authentication: { username }, owner, confirmItemControl } = requestOptions;
+        const { owner, confirmItemControl } = requestOptions;
+        const username = await requestOptions.authentication.getUsername();
         const itemOwner = owner || username;
         // non-item owner
         if (itemOwner !== username) {
@@ -2603,8 +2631,8 @@ function getMembershipAdjustments(currentUser, isSharedEditingGroup, membership,
     }
     return membershipGuarantees;
 }
-function shareToGroup(requestOptions, isAdmin = false, isCrossOrgSharing = false) {
-    const username = requestOptions.authentication.username;
+async function shareToGroup(requestOptions, isAdmin = false, isCrossOrgSharing = false) {
+    const username = await requestOptions.authentication.getUsername();
     const itemOwner = requestOptions.owner || username;
     // decide what url to use
     // default to the non-owner url...
@@ -2741,7 +2769,7 @@ function ensureMembership(currentUser, ownerUser, shouldPromote, errorMessage, r
  * @returns A Promise that will resolve with the data from the response.
  */
 function unshareItemWithGroup(requestOptions) {
-    return isItemSharedWithGroup(requestOptions).then((isShared) => {
+    return isItemSharedWithGroup(requestOptions).then(async (isShared) => {
         // not shared
         if (!isShared) {
             // exit early with success response
@@ -2751,7 +2779,8 @@ function unshareItemWithGroup(requestOptions) {
                 notUnsharedFrom: []
             });
         }
-        const { authentication: { username }, owner } = requestOptions;
+        const { owner } = requestOptions;
+        const username = await requestOptions.authentication.getUsername();
         // next check if the user is a member of the group
         return Promise.all([
             getUserMembership(requestOptions),
@@ -2784,8 +2813,8 @@ function unshareItemWithGroup(requestOptions) {
         });
     });
 }
-function unshareFromGroup(requestOptions) {
-    const username = requestOptions.authentication.username;
+async function unshareFromGroup(requestOptions) {
+    const username = await requestOptions.authentication.getUsername();
     const itemOwner = requestOptions.owner || username;
     // decide what url to use
     // default to the non-owner url...
@@ -2913,5 +2942,5 @@ function getPortalSettings(id, requestOptions) {
     return request(url, options);
 }
 
-export { SearchQueryBuilder, acceptInvitation, addGroupUsers, addItemData, addItemPart, addItemRelationship, addItemResource, bboxToString, cancelItemUpload, commitItemUpload, createFolder, createGroup, createGroupNotification, createItem, createItemInFolder, createOrgNotification, declineInvitation, determineOwner, ensureMembership, exportItem, getGroup, getGroupCategorySchema, getGroupContent, getGroupUsers, getItem, getItemBaseUrl, getItemData, getItemGroups, getItemInfo, getItemMetadata, getItemParts, getItemResource, getItemResources, getItemStatus, getPortal, getPortalSettings, getPortalUrl, getRelatedItems, getSelf, getSharingUrl, getUniqueServiceName, getUser, getUserContent, getUserInvitation, getUserInvitations, getUserMembership, getUserNotifications, getUserProperties, getUserTags, getUserUrl, inviteGroupUsers, isBBox, isItemOwner, isItemSharedWithGroup, isOrgAdmin, isServiceNameAvailable, joinGroup, leaveGroup, moveItem, protectGroup, protectItem, reassignItem, removeFolder, removeGroup, removeGroupUsers, removeItem, removeItemRelationship, removeItemResource, removeNotification, scrubControlChars, searchCommunityUsers, searchGroupContent, searchGroupUsers, searchGroups, searchItems, searchUsers, setItemAccess, setUserProperties, shareItemWithGroup, unprotectGroup, unprotectItem, unshareItemWithGroup, updateGroup, updateItem, updateItemInfo, updateItemResource, updateUser, updateUserMemberships };
+export { SearchQueryBuilder, acceptInvitation, addGroupUsers, addItemData, addItemPart, addItemRelationship, addItemResource, bboxToString, cancelItemUpload, commitItemUpload, createFolder, createGroup, createGroupNotification, createItem, createItemInFolder, createOrgNotification, declineInvitation, determineOwner, determineUsername, ensureMembership, exportItem, getGroup, getGroupCategorySchema, getGroupContent, getGroupUsers, getItem, getItemBaseUrl, getItemData, getItemGroups, getItemInfo, getItemMetadata, getItemParts, getItemResource, getItemResources, getItemStatus, getPortal, getPortalSettings, getPortalUrl, getRelatedItems, getSelf, getSharingUrl, getUniqueServiceName, getUser, getUserContent, getUserInvitation, getUserInvitations, getUserMembership, getUserNotifications, getUserProperties, getUserTags, getUserUrl, inviteGroupUsers, isBBox, isItemOwner, isItemSharedWithGroup, isOrgAdmin, isServiceNameAvailable, joinGroup, leaveGroup, moveItem, protectGroup, protectItem, reassignItem, removeFolder, removeGroup, removeGroupUsers, removeItem, removeItemRelationship, removeItemResource, removeNotification, scrubControlChars, searchCommunityUsers, searchGroupContent, searchGroupUsers, searchGroups, searchItems, searchUsers, setItemAccess, setUserProperties, shareItemWithGroup, unprotectGroup, unprotectItem, unshareItemWithGroup, updateGroup, updateItem, updateItemInfo, updateItemResource, updateUser, updateUserMemberships };
 //# sourceMappingURL=portal.esm.js.map