@esri/arcgis-rest-portal 4.0.6 → 4.2.0

package/dist/bundled/portal.esm.js

@@ -1,7 +1,7 @@
 /* @preserve
-* @esri/arcgis-rest-portal - v4.0.5 - Apache-2.0
-* Copyright (c) 2017-2022 Esri, Inc.
-* Thu Sep 22 2022 19:48:13 GMT+0000 (Coordinated Universal Time)
+* @esri/arcgis-rest-portal - v4.1.0 - Apache-2.0
+* Copyright (c) 2017-2023 Esri, Inc.
+* Thu Mar 02 2023 01:32:35 GMT+0000 (Coordinated Universal Time)
 */
 import { cleanUrl, request, appendCustomParams, warn } from '@esri/arcgis-rest-request';
 
@@ -2330,6 +2330,48 @@ function updateUser(requestOptions) {
     return request(updateUrl, requestOptions);
 }
 
+/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+/**
+ * Fetches the properties for a user
+ * @param username The user whose properties to fetch
+ * @param requestOptions An IUserRequestOptions object
+ * @returns a promise that resolves an IUserProperties object
+ */
+async function getUserProperties(username, requestOptions) {
+    const url = `${getPortalUrl(requestOptions)}/community/users/${encodeURIComponent(username)}/properties`;
+    const response = await request(url, Object.assign({ httpMethod: "GET" }, requestOptions));
+    if (!response.properties.mapViewer) {
+        response.properties.mapViewer = "modern";
+    }
+    return response.properties;
+}
+
+/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+/**
+ * Updates the properties for a user
+ * @param username The user whose properties to update
+ * @param properties IUserProperties object with properties to update
+ * @param requestOptions An IUserRequestOptions object
+ * @returns a promise that resolves to { success: boolean }
+ */
+async function setUserProperties(username, properties, requestOptions) {
+    const url = `${getPortalUrl(requestOptions)}/community/users/${encodeURIComponent(username)}/setProperties`;
+    const options = Object.assign({ httpMethod: "POST", params: { properties } }, requestOptions);
+    try {
+        const response = await request(url, options);
+        if (!response.success) {
+            throw new Error("Success was false");
+        }
+        return response;
+    }
+    catch (e) {
+        const error = e;
+        throw new Error(`Failed to set user properties: ${error.message}`);
+    }
+}
+
 /* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 /**
@@ -2853,5 +2895,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, getUserTags, getUserUrl, inviteGroupUsers, isBBox, isItemOwner, isItemSharedWithGroup, isOrgAdmin, isServiceNameAvailable, joinGroup, leaveGroup, moveItem, protectGroup, protectItem, reassignItem, removeFolder, removeGroup, removeGroupUsers, removeItem, removeItemRelationship, removeItemResource, removeNotification, scrubControlChars, searchGroupContent, searchGroupUsers, searchGroups, searchItems, searchUsers, setItemAccess, 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, 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, searchGroupContent, searchGroupUsers, searchGroups, searchItems, searchUsers, setItemAccess, setUserProperties, shareItemWithGroup, unprotectGroup, unprotectItem, unshareItemWithGroup, updateGroup, updateItem, updateItemInfo, updateItemResource, updateUser, updateUserMemberships };
 //# sourceMappingURL=portal.esm.js.map