@esri/arcgis-rest-portal 4.3.0 → 4.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,13 +1,10 @@
1
1
  [![npm version][npm-img]][npm-url]
2
- [![build status][travis-img]][travis-url]
3
2
  [![gzip bundle size][gzip-image]][npm-url]
4
3
  [![Coverage Status][coverage-img]][coverage-url]
5
4
  [![apache licensed](https://img.shields.io/badge/license-Apache-green.svg?style=flat-square)](https://raw.githubusercontent.com/Esri/arcgis-rest-js/master/LICENSE)
6
5
 
7
6
  [npm-img]: https://img.shields.io/npm/v/@esri/arcgis-rest-portal.svg?style=flat-square
8
7
  [npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-portal
9
- [travis-img]: https://img.shields.io/travis/Esri/arcgis-rest-js/master.svg?style=flat-square
10
- [travis-url]: https://travis-ci.org/Esri/arcgis-rest-js
11
8
  [gzip-image]: https://img.badgesize.io/https://unpkg.com/@esri/arcgis-rest-portal/dist/bundled/portal.umd.min.js?compression=gzip
12
9
  [coverage-img]: https://codecov.io/gh/Esri/arcgis-rest-js/branch/master/graph/badge.svg
13
10
  [coverage-url]: https://codecov.io/gh/Esri/arcgis-rest-js
@@ -33,7 +30,7 @@ getItem(itemId).then((response) => {
33
30
  });
34
31
  ```
35
32
 
36
- ### [API Reference](https://esri.github.io/arcgis-rest-js/api/portal/)
33
+ ### [API Reference](https://developers.arcgis.com/arcgis-rest-js/api-reference/arcgis-rest-portal/)
37
34
 
38
35
  ### Issues
39
36
 
@@ -1,7 +1,7 @@
1
1
  /* @preserve
2
- * @esri/arcgis-rest-portal - v4.2.0 - Apache-2.0
3
- * Copyright (c) 2017-2023 Esri, Inc.
4
- * Fri Jul 28 2023 20:20:07 GMT+0000 (Coordinated Universal Time)
2
+ * @esri/arcgis-rest-portal - v4.4.0 - Apache-2.0
3
+ * Copyright (c) 2017-2024 Esri, Inc.
4
+ * Sat Jun 15 2024 00:37:50 GMT+0000 (Coordinated Universal Time)
5
5
  */
6
6
  import { cleanUrl, request, appendCustomParams, warn } from '@esri/arcgis-rest-request';
7
7
 
@@ -1422,6 +1422,9 @@ function genericSearch(search, searchType) {
1422
1422
  return Promise.reject(new Error("you must pass a `groupId` option to `searchGroupContent`"));
1423
1423
  }
1424
1424
  break;
1425
+ case "communityUser":
1426
+ path = "/community/users";
1427
+ break;
1425
1428
  default:
1426
1429
  // "users"
1427
1430
  path = "/portals/self/users/search";
@@ -1934,6 +1937,7 @@ function updateGroup(requestOptions) {
1934
1937
  * updateUserMemberships({
1935
1938
  * id: groupId,
1936
1939
  * admins: ["username3"],
1940
+ * newMemberType: "admin",
1937
1941
  * authentication
1938
1942
  * })
1939
1943
  * .then(response);
@@ -2279,7 +2283,7 @@ function removeNotification(requestOptions) {
2279
2283
  * Search a portal for users.
2280
2284
  *
2281
2285
  * ```js
2282
- * import { searchItems } from "@esri/arcgis-rest-portal";
2286
+ * import { searchUsers } from "@esri/arcgis-rest-portal";
2283
2287
  * //
2284
2288
  * searchUsers({ q: 'tommy', authentication })
2285
2289
  * .then(response) // response.total => 355
@@ -2291,6 +2295,21 @@ function removeNotification(requestOptions) {
2291
2295
  function searchUsers(search) {
2292
2296
  return genericSearch(search, "user");
2293
2297
  }
2298
+ /**
2299
+ * ```js
2300
+ * import { searchCommunityUsers } from "@esri/arcgis-rest-portal";
2301
+ * //
2302
+ * searchCommunityUsers({ q: 'tommy', authentication })
2303
+ * .then(response) // response.total => 355
2304
+ * ```
2305
+ * Search all portals for users.
2306
+ *
2307
+ * @param search - A RequestOptions object to pass through to the endpoint.
2308
+ * @returns A Promise that will resolve with the data from the response.
2309
+ */
2310
+ function searchCommunityUsers(search) {
2311
+ return genericSearch(search, "communityUser");
2312
+ }
2294
2313
 
2295
2314
  /* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
2296
2315
  * Apache-2.0 */
@@ -2895,5 +2914,5 @@ function getPortalSettings(id, requestOptions) {
2895
2914
  return request(url, options);
2896
2915
  }
2897
2916
 
2898
- 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 };
2917
+ 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 };
2899
2918
  //# sourceMappingURL=portal.esm.js.map