feat(api): add listing workspaces

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

@@ -2,4 +2,5 @@ export enum WorkspaceApiOperations {
   Creating,
   Inviting,
   Accepting,
+  ListingWorkspaces,
 }

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

@@ -1,7 +1,9 @@
 import { 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 { WorkspaceServerInterface } from '../../Server/Workspace/WorkspaceServerInterface'
 
 import { WorkspaceApiOperations } from './WorkspaceApiOperations'
@@ -23,6 +25,10 @@ describe('WorkspaceApiService', () => {
     workspaceServer.acceptInvite = jest.fn().mockReturnValue({
       data: { success: true },
     } as jest.Mocked<WorkspaceInvitationAcceptingResponse>)
+    workspaceServer.listWorkspaces = jest.fn().mockReturnValue({
+      status: HttpStatusCode.Success,
+      data: { ownedWorkspaces: [], joinedWorkspaces: [] },
+    } as jest.Mocked<WorkspaceListResponse>)
   })
 
   it('should create a workspace', async () => {
@@ -202,4 +208,48 @@ describe('WorkspaceApiService', () => {
 
     expect(error).not.toBeNull()
   })
+
+  it('should list workspaces', async () => {
+    const response = await createService().listWorkspaces()
+
+    expect(response).toEqual({
+      status: 200,
+      data: {
+        ownedWorkspaces: [],
+        joinedWorkspaces: [],
+      },
+    })
+    expect(workspaceServer.listWorkspaces).toHaveBeenCalled()
+  })
+
+  it('should not list workspaces if it is already listing them', async () => {
+    const service = createService()
+    Object.defineProperty(service, 'operationsInProgress', {
+      get: () => new Map([[WorkspaceApiOperations.ListingWorkspaces, true]]),
+    })
+
+    let error = null
+    try {
+      await service.listWorkspaces()
+    } catch (caughtError) {
+      error = caughtError
+    }
+
+    expect(error).not.toBeNull()
+  })
+
+  it('should not list workspaces if the server fails', async () => {
+    workspaceServer.listWorkspaces = jest.fn().mockImplementation(() => {
+      throw new Error('Oops')
+    })
+
+    let error = null
+    try {
+      await createService().listWorkspaces()
+    } catch (caughtError) {
+      error = caughtError
+    }
+
+    expect(error).not.toBeNull()
+  })
 })

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

@@ -6,6 +6,7 @@ import { WorkspaceCreationResponse } from '../../Response/Workspace/WorkspaceCre
 import { WorkspaceInvitationAcceptingResponse } from '../../Response/Workspace/WorkspaceInvitationAcceptingResponse'
 import { WorkspaceInvitationResponse } from '../../Response/Workspace/WorkspaceInvitationResponse'
 import { WorkspaceServerInterface } from '../../Server/Workspace/WorkspaceServerInterface'
+import { WorkspaceListResponse } from '../../Response/Workspace/WorkspaceListResponse'
 
 import { WorkspaceApiServiceInterface } from './WorkspaceApiServiceInterface'
 import { WorkspaceApiOperations } from './WorkspaceApiOperations'
@@ -17,6 +18,20 @@ export class WorkspaceApiService implements WorkspaceApiServiceInterface {
     this.operationsInProgress = new Map()
   }
 
+  async listWorkspaces(): Promise<WorkspaceListResponse> {
+    this.lockOperation(WorkspaceApiOperations.ListingWorkspaces)
+
+    try {
+      const response = await this.workspaceServer.listWorkspaces({})
+
+      this.unlockOperation(WorkspaceApiOperations.ListingWorkspaces)
+
+      return response
+    } catch (error) {
+      throw new ApiCallError(ErrorMessage.GenericFail)
+    }
+  }
+
   async acceptInvite(dto: {
     inviteUuid: string
     userUuid: string

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

@@ -3,6 +3,7 @@ import { Uuid, 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'
 
 export interface WorkspaceApiServiceInterface {
   createWorkspace(dto: {
@@ -19,4 +20,5 @@ export interface WorkspaceApiServiceInterface {
     publicKey: string
     encryptedPrivateKey: string
   }): Promise<WorkspaceInvitationAcceptingResponse>
+  listWorkspaces(): Promise<WorkspaceListResponse>
 }