feat(portal): add updateGroupMembership, isItemSharedWithGroup

Add two new functions and make shareItemWithGroup smarter AFFECTS PACKAGES: @esri/arcgis-rest-feature-layer @esri/arcgis-rest-portal @esri/arcgis-rest-service-admin
Esri · Feb 28, 2020 · 14848db · 14848db
1 parent 2fe62ae
commit 14848db
Show file tree

Hide file tree

Showing 13 changed files with 575 additions and 150 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/arcgis-rest-feature-layer/test/attachments.test.ts b/packages/arcgis-rest-feature-layer/test/attachments.test.ts
@@ -53,9 +53,7 @@ describe("attachment methods", () => {
         expect(fetchMock.called()).toBeTruthy();
         const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
         expect(url).toEqual(
-          `${requestOptions.url}/${
-            requestOptions.featureId
-          }/attachments?f=json&gdbVersion=SDE.DEFAULT`
+          `${requestOptions.url}/${requestOptions.featureId}/attachments?f=json&gdbVersion=SDE.DEFAULT`
         );
         expect(options.method).toBe("GET");
         expect(getAttachmentsResponse.attachmentInfos.length).toEqual(2);

diff --git a/packages/arcgis-rest-feature-layer/test/query.test.ts b/packages/arcgis-rest-feature-layer/test/query.test.ts
@@ -106,9 +106,7 @@ describe("getFeature() and queryFeatures()", () => {
         expect(fetchMock.called()).toBeTruthy();
         const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
         expect(url).toEqual(
-          `${
-            requestOptions.url
-          }/query?f=json&where=Condition%3D'Poor'&outFields=FID%2CTree_ID%2CCmn_Name%2CCondition&geometry=%7B%7D&geometryType=esriGeometryPolygon&orderByFields=test`
+          `${requestOptions.url}/query?f=json&where=Condition%3D'Poor'&outFields=FID%2CTree_ID%2CCmn_Name%2CCondition&geometry=%7B%7D&geometryType=esriGeometryPolygon&orderByFields=test`
         );
         expect(options.method).toBe("GET");
         // expect(response.attributes.FID).toEqual(42);
@@ -129,9 +127,7 @@ describe("getFeature() and queryFeatures()", () => {
         expect(fetchMock.called()).toBeTruthy();
         const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
         expect(url).toEqual(
-          `${
-            requestOptions.url
-          }/queryRelatedRecords?f=json&definitionExpression=1%3D1&outFields=*&relationshipId=0`
+          `${requestOptions.url}/queryRelatedRecords?f=json&definitionExpression=1%3D1&outFields=*&relationshipId=0`
         );
         expect(options.method).toBe("GET");
         done();

diff --git a/packages/arcgis-rest-portal/src/groups/add-users.ts b/packages/arcgis-rest-portal/src/groups/add-users.ts
@@ -9,6 +9,7 @@ import {
 
 import { getPortalUrl } from "../util/get-portal-url";
 import { chunk } from "../util/array";
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
 
 export interface IAddGroupUsersOptions extends IRequestOptions {
   /**

diff --git a/packages/arcgis-rest-portal/src/groups/update-user-membership.ts b/packages/arcgis-rest-portal/src/groups/update-user-membership.ts
@@ -0,0 +1,63 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { getPortalUrl } from "../util/get-portal-url";
+import { request } from "@esri/arcgis-rest-request";
+
+export interface IUpdateGroupUsersResult {
+  /**
+   * Array of results
+   */
+  results: any[];
+}
+
+export interface IUpdateGroupUsersOptions extends IUserRequestOptions {
+  /**
+   * Group ID
+   */
+  id: string;
+  /**
+   * An array of usernames to be updated
+   */
+  users: string[];
+  /**
+   * Membership Type to update to
+   */
+  newMemberType: "member" | "admin";
+}
+
+/**
+ * ```js
+ * import { updateUserMemberships } from "@esri/arcgis-rest-portal";
+ * //
+ * updateUserMemberships({
+ *   id: groupId,
+ *   admins: ["username3"],
+ *   authentication
+ * })
+ * .then(response);
+ * ```
+ * Change the user membership levels of existing users in a group
+ *
+ * @param requestOptions  - Options for the request
+ * @returns A Promise
+ */
+export function updateUserMemberships(
+  requestOptions: IUpdateGroupUsersOptions
+): Promise<IUpdateGroupUsersResult> {
+  const url = `${getPortalUrl(requestOptions)}/community/groups/${
+    requestOptions.id
+  }/updateUsers`;
+  const opts: any = {
+    authentication: requestOptions.authentication,
+    params: {}
+  };
+  // add the correct params depending on the type of membership we are changing to
+  if (requestOptions.newMemberType === "admin") {
+    opts.params.admins = requestOptions.users;
+  } else {
+    opts.params.users = requestOptions.users;
+  }
+  // make the request
+  return request(url, opts);
+}
diff --git a/packages/arcgis-rest-portal/src/index.ts b/packages/arcgis-rest-portal/src/index.ts
@@ -21,6 +21,7 @@ export * from "./groups/protect";
 export * from "./groups/remove";
 export * from "./groups/search";
 export * from "./groups/update";
+export * from "./groups/update-user-membership";
 export * from "./groups/join";
 
 export * from "./users/get-user";

diff --git a/packages/arcgis-rest-portal/src/sharing/access.ts b/packages/arcgis-rest-portal/src/sharing/access.ts
@@ -49,9 +49,7 @@ export function setItemAccess(
       } 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.`
+          `This item can not be shared by ${requestOptions.authentication.username}. They are neither the item owner nor an organization admin.`
         );
       }
     });