feat(api): add listing workspace users

packages/api/src/Domain/Client/Workspace/WorkspaceApiOperations.ts

@@ -3,4 +3,5 @@ export enum WorkspaceApiOperations {
   Inviting,
   Accepting,
   ListingWorkspaces,
+  ListingWorkspaceUsers,
 }

packages/api/src/Domain/Client/Workspace/WorkspaceApiService.spec.ts

@@ -1,9 +1,10 @@
-import { WorkspaceType } from '@standardnotes/common'
+import { WorkspaceAccessLevel, WorkspaceType } from '@standardnotes/common'
 import { HttpStatusCode } from '../../Http'
 import { WorkspaceCreationResponse } from '../../Response/Workspace/WorkspaceCreationResponse'
 import { WorkspaceInvitationAcceptingResponse } from '../../Response/Workspace/WorkspaceInvitationAcceptingResponse'
 import { WorkspaceInvitationResponse } from '../../Response/Workspace/WorkspaceInvitationResponse'
 import { WorkspaceListResponse } from '../../Response/Workspace/WorkspaceListResponse'
+import { WorkspaceUserListResponse } from '../../Response/Workspace/WorkspaceUserListResponse'
 import { WorkspaceServerInterface } from '../../Server/Workspace/WorkspaceServerInterface'
 
 import { WorkspaceApiOperations } from './WorkspaceApiOperations'
@@ -29,6 +30,10 @@ describe('WorkspaceApiService', () => {
       status: HttpStatusCode.Success,
       data: { ownedWorkspaces: [], joinedWorkspaces: [] },
     } as jest.Mocked<WorkspaceListResponse>)
+    workspaceServer.listWorkspaceUsers = jest.fn().mockReturnValue({
+      status: HttpStatusCode.Success,
+      data: { users: [] },
+    } as jest.Mocked<WorkspaceUserListResponse>)
   })
 
   it('should create a workspace', async () => {
@@ -97,7 +102,7 @@ describe('WorkspaceApiService', () => {
     const response = await createService().inviteToWorkspace({
       workspaceUuid: 'w-1-2-3',
       inviteeEmail: 'test@test.te',
-      accessLevel: 'write-and-read',
+      accessLevel: WorkspaceAccessLevel.WriteAndRead,
     })
 
     expect(response).toEqual({
@@ -123,7 +128,7 @@ describe('WorkspaceApiService', () => {
       await service.inviteToWorkspace({
         workspaceUuid: 'w-1-2-3',
         inviteeEmail: 'test@test.te',
-        accessLevel: 'write-and-read',
+        accessLevel: WorkspaceAccessLevel.WriteAndRead,
       })
     } catch (caughtError) {
       error = caughtError
@@ -142,7 +147,7 @@ describe('WorkspaceApiService', () => {
       await createService().inviteToWorkspace({
         workspaceUuid: 'w-1-2-3',
         inviteeEmail: 'test@test.te',
-        accessLevel: 'write-and-read',
+        accessLevel: WorkspaceAccessLevel.WriteAndRead,
       })
     } catch (caughtError) {
       error = caughtError
@@ -256,4 +261,47 @@ describe('WorkspaceApiService', () => {
 
     expect(error).not.toBeNull()
   })
+
+  it('should list workspace users', async () => {
+    const response = await createService().listWorkspaceUsers({ workspaceUuid: 'w-1-2-3' })
+
+    expect(response).toEqual({
+      status: 200,
+      data: {
+        users: [],
+      },
+    })
+    expect(workspaceServer.listWorkspaceUsers).toHaveBeenCalledWith({ workspaceUuid: 'w-1-2-3' })
+  })
+
+  it('should not list workspace users if it is already listing them', async () => {
+    const service = createService()
+    Object.defineProperty(service, 'operationsInProgress', {
+      get: () => new Map([[WorkspaceApiOperations.ListingWorkspaceUsers, true]]),
+    })
+
+    let error = null
+    try {
+      await service.listWorkspaceUsers({ workspaceUuid: 'w-1-2-3' })
+    } catch (caughtError) {
+      error = caughtError
+    }
+
+    expect(error).not.toBeNull()
+  })
+
+  it('should not list workspace users if the server fails', async () => {
+    workspaceServer.listWorkspaceUsers = jest.fn().mockImplementation(() => {
+      throw new Error('Oops')
+    })
+
+    let error = null
+    try {
+      await createService().listWorkspaceUsers({ workspaceUuid: 'w-1-2-3' })
+    } catch (caughtError) {
+      error = caughtError
+    }
+
+    expect(error).not.toBeNull()
+  })
 })

packages/api/src/Domain/Client/Workspace/WorkspaceApiService.ts

@@ -1,4 +1,4 @@
-import { Uuid, WorkspaceType } from '@standardnotes/common'
+import { Uuid, WorkspaceAccessLevel, WorkspaceType } from '@standardnotes/common'
 
 import { ErrorMessage } from '../../Error/ErrorMessage'
 import { ApiCallError } from '../../Error/ApiCallError'
@@ -7,6 +7,7 @@ import { WorkspaceInvitationAcceptingResponse } from '../../Response/Workspace/W
 import { WorkspaceInvitationResponse } from '../../Response/Workspace/WorkspaceInvitationResponse'
 import { WorkspaceServerInterface } from '../../Server/Workspace/WorkspaceServerInterface'
 import { WorkspaceListResponse } from '../../Response/Workspace/WorkspaceListResponse'
+import { WorkspaceUserListResponse } from '../../Response/Workspace/WorkspaceUserListResponse'
 
 import { WorkspaceApiServiceInterface } from './WorkspaceApiServiceInterface'
 import { WorkspaceApiOperations } from './WorkspaceApiOperations'
@@ -18,6 +19,20 @@ export class WorkspaceApiService implements WorkspaceApiServiceInterface {
     this.operationsInProgress = new Map()
   }
 
+  async listWorkspaceUsers(dto: { workspaceUuid: string }): Promise<WorkspaceUserListResponse> {
+    this.lockOperation(WorkspaceApiOperations.ListingWorkspaceUsers)
+
+    try {
+      const response = await this.workspaceServer.listWorkspaceUsers({ workspaceUuid: dto.workspaceUuid })
+
+      this.unlockOperation(WorkspaceApiOperations.ListingWorkspaceUsers)
+
+      return response
+    } catch (error) {
+      throw new ApiCallError(ErrorMessage.GenericFail)
+    }
+  }
+
   async listWorkspaces(): Promise<WorkspaceListResponse> {
     this.lockOperation(WorkspaceApiOperations.ListingWorkspaces)
 
@@ -59,7 +74,7 @@ export class WorkspaceApiService implements WorkspaceApiServiceInterface {
   async inviteToWorkspace(dto: {
     inviteeEmail: string
     workspaceUuid: Uuid
-    accessLevel: string
+    accessLevel: WorkspaceAccessLevel
   }): Promise<WorkspaceInvitationResponse> {
     this.lockOperation(WorkspaceApiOperations.Inviting)
 

packages/api/src/Domain/Client/Workspace/WorkspaceApiServiceInterface.ts

@@ -1,9 +1,10 @@
-import { Uuid, WorkspaceType } from '@standardnotes/common'
+import { Uuid, WorkspaceAccessLevel, WorkspaceType } from '@standardnotes/common'
 
 import { WorkspaceCreationResponse } from '../../Response/Workspace/WorkspaceCreationResponse'
 import { WorkspaceInvitationAcceptingResponse } from '../../Response/Workspace/WorkspaceInvitationAcceptingResponse'
 import { WorkspaceInvitationResponse } from '../../Response/Workspace/WorkspaceInvitationResponse'
 import { WorkspaceListResponse } from '../../Response/Workspace/WorkspaceListResponse'
+import { WorkspaceUserListResponse } from '../../Response/Workspace/WorkspaceUserListResponse'
 
 export interface WorkspaceApiServiceInterface {
   createWorkspace(dto: {
@@ -16,7 +17,7 @@ export interface WorkspaceApiServiceInterface {
   inviteToWorkspace(dto: {
     inviteeEmail: string
     workspaceUuid: Uuid
-    accessLevel: string
+    accessLevel: WorkspaceAccessLevel
   }): Promise<WorkspaceInvitationResponse>
   acceptInvite(dto: {
     inviteUuid: Uuid
@@ -25,4 +26,5 @@ export interface WorkspaceApiServiceInterface {
     encryptedPrivateKey: string
   }): Promise<WorkspaceInvitationAcceptingResponse>
   listWorkspaces(): Promise<WorkspaceListResponse>
+  listWorkspaceUsers(dto: { workspaceUuid: Uuid }): Promise<WorkspaceUserListResponse>
 }

packages/api/src/Domain/Request/Workspace/WorkspaceInvitationRequestParams.ts

@@ -1,8 +1,8 @@
-import { Uuid } from '@standardnotes/common'
+import { Uuid, WorkspaceAccessLevel } from '@standardnotes/common'
 
 export type WorkspaceInvitationRequestParams = {
   workspaceUuid: Uuid
   inviteeEmail: string
-  accessLevel: string
+  accessLevel: WorkspaceAccessLevel
   [additionalParam: string]: unknown
 }

packages/api/src/Domain/Request/Workspace/WorkspaceUserListRequestParams.ts

@@ -0,0 +1,6 @@
+import { Uuid } from '@standardnotes/common'
+
+export type WorkspaceUserListRequestParams = {
+  workspaceUuid: Uuid
+  [additionalParam: string]: unknown
+}

packages/api/src/Domain/Request/index.ts

@@ -10,3 +10,4 @@ export * from './Workspace/WorkspaceCreationRequestParams'
 export * from './Workspace/WorkspaceInvitationAcceptingRequestParams'
 export * from './Workspace/WorkspaceInvitationRequestParams'
 export * from './Workspace/WorkspaceListRequestParams'
+export * from './Workspace/WorkspaceUserListRequestParams'

packages/api/src/Domain/Response/Workspace/WorkspaceUserListResponse.ts

@@ -0,0 +1,9 @@
+import { Either } from '@standardnotes/common'
+
+import { HttpErrorResponseBody } from '../../Http/HttpErrorResponseBody'
+import { HttpResponse } from '../../Http/HttpResponse'
+import { WorkspaceUserListResponseBody } from './WorkspaceUserListResponseBody'
+
+export interface WorkspaceUserListResponse extends HttpResponse {
+  data: Either<WorkspaceUserListResponseBody, HttpErrorResponseBody>
+}

packages/api/src/Domain/Response/Workspace/WorkspaceUserListResponseBody.ts

@@ -0,0 +1,5 @@
+import { WorkspaceUser } from '@standardnotes/models'
+
+export type WorkspaceUserListResponseBody = {
+  users: Array<WorkspaceUser>
+}

packages/api/src/Domain/Server/Workspace/Paths.ts

@@ -3,6 +3,7 @@ import { Uuid } from '@standardnotes/common'
 const WorkspacePaths = {
   createWorkspace: '/v1/workspaces',
   listWorkspaces: '/v1/workspaces',
+  listWorkspaceUsers: (uuid: Uuid) => `/v1/workspaces/${uuid}/users`,
   inviteToWorkspace: (uuid: Uuid) => `/v1/workspaces/${uuid}/invites`,
   acceptInvite: (uuid: Uuid) => `/v1/invites/${uuid}/accept`,
 }

packages/api/src/Domain/Server/Workspace/WorkspaceServer.spec.ts

@@ -1,9 +1,10 @@
-import { WorkspaceType } from '@standardnotes/common'
+import { WorkspaceAccessLevel, WorkspaceType } from '@standardnotes/common'
 import { HttpServiceInterface, HttpStatusCode } from '../../Http'
 import { WorkspaceCreationResponse } from '../../Response/Workspace/WorkspaceCreationResponse'
 import { WorkspaceInvitationAcceptingResponse } from '../../Response/Workspace/WorkspaceInvitationAcceptingResponse'
 import { WorkspaceInvitationResponse } from '../../Response/Workspace/WorkspaceInvitationResponse'
 import { WorkspaceListResponse } from '../../Response/Workspace/WorkspaceListResponse'
+import { WorkspaceUserListResponse } from '../../Response/Workspace/WorkspaceUserListResponse'
 
 import { WorkspaceServer } from './WorkspaceServer'
 
@@ -42,7 +43,7 @@ describe('WorkspaceServer', () => {
     const response = await createServer().inviteToWorkspace({
       inviteeEmail: 'test@test.te',
       workspaceUuid: 'w-1-2-3',
-      accessLevel: 'write-and-read',
+      accessLevel: WorkspaceAccessLevel.WriteAndRead,
     })
 
     expect(response).toEqual({
@@ -84,4 +85,18 @@ describe('WorkspaceServer', () => {
       data: { ownedWorkspaces: [], joinedWorkspaces: [] },
     })
   })
+
+  it('should list workspace users', async () => {
+    httpService.get = jest.fn().mockReturnValue({
+      status: HttpStatusCode.Success,
+      data: { users: [] },
+    } as jest.Mocked<WorkspaceUserListResponse>)
+
+    const response = await createServer().listWorkspaceUsers({ workspaceUuid: 'w-1-2-3' })
+
+    expect(response).toEqual({
+      status: 200,
+      data: { users: [] },
+    })
+  })
 })

packages/api/src/Domain/Server/Workspace/WorkspaceServer.ts

@@ -7,6 +7,8 @@ import { WorkspaceInvitationAcceptingRequestParams } from '../../Request/Workspa
 import { WorkspaceInvitationAcceptingResponse } from '../../Response/Workspace/WorkspaceInvitationAcceptingResponse'
 import { WorkspaceListRequestParams } from '../../Request/Workspace/WorkspaceListRequestParams'
 import { WorkspaceListResponse } from '../../Response/Workspace/WorkspaceListResponse'
+import { WorkspaceUserListRequestParams } from '../../Request/Workspace/WorkspaceUserListRequestParams'
+import { WorkspaceUserListResponse } from '../../Response/Workspace/WorkspaceUserListResponse'
 
 import { Paths } from './Paths'
 import { WorkspaceServerInterface } from './WorkspaceServerInterface'
@@ -14,6 +16,12 @@ import { WorkspaceServerInterface } from './WorkspaceServerInterface'
 export class WorkspaceServer implements WorkspaceServerInterface {
   constructor(private httpService: HttpServiceInterface) {}
 
+  async listWorkspaceUsers(params: WorkspaceUserListRequestParams): Promise<WorkspaceUserListResponse> {
+    const response = await this.httpService.get(Paths.v1.listWorkspaceUsers(params.workspaceUuid), params)
+
+    return response as WorkspaceUserListResponse
+  }
+
   async listWorkspaces(params: WorkspaceListRequestParams): Promise<WorkspaceListResponse> {
     const response = await this.httpService.get(Paths.v1.listWorkspaces, params)
 

packages/api/src/Domain/Server/Workspace/WorkspaceServerInterface.ts

@@ -6,10 +6,13 @@ import { WorkspaceInvitationAcceptingRequestParams } from '../../Request/Workspa
 import { WorkspaceInvitationAcceptingResponse } from '../../Response/Workspace/WorkspaceInvitationAcceptingResponse'
 import { WorkspaceListRequestParams } from '../../Request/Workspace/WorkspaceListRequestParams'
 import { WorkspaceListResponse } from '../../Response/Workspace/WorkspaceListResponse'
+import { WorkspaceUserListRequestParams } from '../../Request/Workspace/WorkspaceUserListRequestParams'
+import { WorkspaceUserListResponse } from '../../Response/Workspace/WorkspaceUserListResponse'
 
 export interface WorkspaceServerInterface {
   createWorkspace(params: WorkspaceCreationRequestParams): Promise<WorkspaceCreationResponse>
   listWorkspaces(params: WorkspaceListRequestParams): Promise<WorkspaceListResponse>
+  listWorkspaceUsers(params: WorkspaceUserListRequestParams): Promise<WorkspaceUserListResponse>
   inviteToWorkspace(params: WorkspaceInvitationRequestParams): Promise<WorkspaceInvitationResponse>
   acceptInvite(params: WorkspaceInvitationAcceptingRequestParams): Promise<WorkspaceInvitationAcceptingResponse>
 }