-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: user workspace pane permissions & add content config (#1667)
- Loading branch information
Showing
11 changed files
with
318 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
44 changes: 44 additions & 0 deletions
44
packages/common/src/search/_internal/getUserGroupsByMembership.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| import { IUser } from "@esri/arcgis-rest-types"; | ||
| import { IGroupsByMembership } from "../types/IGroupsByMembership"; | ||
|
|
||
| /** | ||
| * Retrieves the user's groups categorized by their membership type. | ||
| * | ||
| * @param user - The user object containing group information. | ||
| * @returns An object categorizing the user's groups into `owner`, `admin`, and `member`. | ||
| * | ||
| * The function processes the user's groups and classifies them based on the membership type: | ||
| * - `owner`: Groups where the user is an owner. | ||
| * - `admin`: Groups where the user is an admin. | ||
| * - `member`: Groups where the user is a member and the group is not view-only. | ||
| * | ||
| * Note: The `none` membership type is not considered as it is not expected to be present in the user's groups. | ||
| */ | ||
|
|
||
| export function getUserGroupsByMembership(user: IUser): IGroupsByMembership { | ||
| const response: IGroupsByMembership = { | ||
| owner: [], | ||
| member: [], | ||
| admin: [], | ||
| }; | ||
| // get the user's groups | ||
| const userGroups = user.groups || []; | ||
| // loop through the groups and determine if the user is an admin or normal member | ||
| // and add into the response | ||
| userGroups.forEach((group) => { | ||
| if (group.userMembership?.memberType === "owner") { | ||
| response.owner.push(group.id); | ||
| } | ||
| if (group.userMembership?.memberType === "admin") { | ||
| response.admin.push(group.id); | ||
| } | ||
| // If user is just a member and the group is not view only | ||
| if (group.userMembership?.memberType === "member" && !group.isViewOnly) { | ||
| response.member.push(group.id); | ||
| } | ||
| // there is a `none` option in the userMembership but | ||
| // that would never be returned in the user's groups | ||
| // so we don't need to check for it | ||
| }); | ||
| return response; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
71 changes: 71 additions & 0 deletions
71
packages/common/test/search/_internal/getUserGroupsFromQuery.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| import { IQuery } from "../../../src"; | ||
| import { IUser } from "../../../src/events/api"; | ||
| import { getUserGroupsFromQuery } from "../../../src/search/_internal/getUserGroupsFromQuery"; | ||
| import * as GetUserGroupsByMembershipModule from "../../../src/search/_internal/getUserGroupsByMembership"; | ||
|
|
||
| describe("getUserGroupsFromQuery:", () => { | ||
| it("returns all user groups by membership if query lacks group predicate", async () => { | ||
| const query: IQuery = { | ||
| targetEntity: "item", | ||
| filters: [], | ||
| }; | ||
| const user: IUser = { | ||
| username: "user1", | ||
| } as unknown as IUser; | ||
|
|
||
| const getUserGroupsByMembershipSpy = spyOn( | ||
| GetUserGroupsByMembershipModule, | ||
| "getUserGroupsByMembership" | ||
| ).and.callFake(() => { | ||
| return { | ||
| owner: ["o00"], | ||
| member: ["m00"], | ||
| admin: ["a00"], | ||
| }; | ||
| }); | ||
|
|
||
| const result = await getUserGroupsFromQuery(query, user); | ||
| expect(result).toEqual({ | ||
| owner: ["o00"], | ||
| member: ["m00"], | ||
| admin: ["a00"], | ||
| }); | ||
| expect(getUserGroupsByMembershipSpy).toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it("returns only groups user is a member of, from groups in query", async () => { | ||
| const query: IQuery = { | ||
| targetEntity: "item", | ||
| filters: [ | ||
| { | ||
| predicates: [ | ||
| { | ||
| group: "m00", | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| }; | ||
| const user: IUser = { | ||
| username: "user1", | ||
| } as unknown as IUser; | ||
|
|
||
| const getUserGroupsByMembershipSpy = spyOn( | ||
| GetUserGroupsByMembershipModule, | ||
| "getUserGroupsByMembership" | ||
| ).and.callFake(() => { | ||
| return { | ||
| owner: ["o00"], | ||
| member: ["m00"], | ||
| admin: ["a00"], | ||
| }; | ||
| }); | ||
| const result = await getUserGroupsFromQuery(query, user); | ||
| expect(result).toEqual({ | ||
| owner: [], | ||
| member: ["m00"], | ||
| admin: [], | ||
| }); | ||
| expect(getUserGroupsByMembershipSpy).toHaveBeenCalled(); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.