feat(api): add inviting to workspace

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

@@ -1,3 +1,4 @@
 export enum WorkspaceApiOperations {
   Creating,
+  Inviting,
 }

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

@@ -1,4 +1,5 @@
 import { WorkspaceType } from '@standardnotes/common'
+import { WorkspaceInvitationResponse } from '../../Response'
 import { WorkspaceCreationResponse } from '../../Response/Workspace/WorkspaceCreationResponse'
 import { WorkspaceServerInterface } from '../../Server/Workspace/WorkspaceServerInterface'
 
@@ -15,6 +16,9 @@ describe('WorkspaceApiService', () => {
     workspaceServer.createWorkspace = jest.fn().mockReturnValue({
       data: { uuid: '1-2-3' },
     } as jest.Mocked<WorkspaceCreationResponse>)
+    workspaceServer.inviteToWorkspace = jest.fn().mockReturnValue({
+      data: { uuid: 'i-1-2-3' },
+    } as jest.Mocked<WorkspaceInvitationResponse>)
   })
 
   it('should create a workspace', async () => {
@@ -77,4 +81,58 @@ describe('WorkspaceApiService', () => {
 
     expect(error).not.toBeNull()
   })
+
+  it('should invite to a workspace', async () => {
+    const response = await createService().inviteToWorkspace({
+      workspaceUuid: 'w-1-2-3',
+      inviteeEmail: 'test@test.te'
+    })
+
+    expect(response).toEqual({
+      data: {
+        uuid: 'i-1-2-3',
+      },
+    })
+    expect(workspaceServer.inviteToWorkspace).toHaveBeenCalledWith({
+      workspaceUuid: 'w-1-2-3',
+      inviteeEmail: 'test@test.te'
+    })
+  })
+
+  it('should not invite to a workspace if it is already inviting', async () => {
+    const service = createService()
+    Object.defineProperty(service, 'operationsInProgress', {
+      get: () => new Map([[WorkspaceApiOperations.Inviting, true]]),
+    })
+
+    let error = null
+    try {
+      await service.inviteToWorkspace({
+        workspaceUuid: 'w-1-2-3',
+        inviteeEmail: 'test@test.te'
+      })
+    } catch (caughtError) {
+      error = caughtError
+    }
+
+    expect(error).not.toBeNull()
+  })
+
+  it('should not invite to a workspace if the server fails', async () => {
+    workspaceServer.inviteToWorkspace = jest.fn().mockImplementation(() => {
+      throw new Error('Oops')
+    })
+
+    let error = null
+    try {
+      await createService().inviteToWorkspace({
+        workspaceUuid: 'w-1-2-3',
+        inviteeEmail: 'test@test.te'
+      })
+    } catch (caughtError) {
+      error = caughtError
+    }
+
+    expect(error).not.toBeNull()
+  })
 })

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

@@ -1,3 +1,5 @@
+import { Uuid, WorkspaceType } from '@standardnotes/common'
+
 import { ErrorMessage } from '../../Error/ErrorMessage'
 import { ApiCallError } from '../../Error/ApiCallError'
 import { WorkspaceCreationResponse } from '../../Response/Workspace/WorkspaceCreationResponse'
@@ -6,7 +8,7 @@ import { WorkspaceServerInterface } from '../../Server/Workspace/WorkspaceServer
 import { WorkspaceApiServiceInterface } from './WorkspaceApiServiceInterface'
 import { WorkspaceApiOperations } from './WorkspaceApiOperations'
 
-import { WorkspaceType } from '@standardnotes/common'
+import { WorkspaceInvitationResponse } from '../../Response'
 
 export class WorkspaceApiService implements WorkspaceApiServiceInterface {
   private operationsInProgress: Map<WorkspaceApiOperations, boolean>
@@ -15,6 +17,27 @@ export class WorkspaceApiService implements WorkspaceApiServiceInterface {
     this.operationsInProgress = new Map()
   }
 
+  async inviteToWorkspace(dto: { inviteeEmail: string; workspaceUuid: Uuid }): Promise<WorkspaceInvitationResponse> {
+    if (this.operationsInProgress.get(WorkspaceApiOperations.Inviting)) {
+      throw new ApiCallError(ErrorMessage.GenericInProgress)
+    }
+
+    this.operationsInProgress.set(WorkspaceApiOperations.Inviting, true)
+
+    try {
+      const response = await this.workspaceServer.inviteToWorkspace({
+        inviteeEmail: dto.inviteeEmail,
+        workspaceUuid: dto.workspaceUuid,
+      })
+
+      this.operationsInProgress.set(WorkspaceApiOperations.Inviting, false)
+
+      return response
+    } catch (error) {
+      throw new ApiCallError(ErrorMessage.GenericFail)
+    }
+  }
+
   async createWorkspace(dto: {
     workspaceType: WorkspaceType,
     encryptedWorkspaceKey?: string

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

@@ -1,6 +1,6 @@
-import { WorkspaceType } from '@standardnotes/common'
+import { Uuid, WorkspaceType } from '@standardnotes/common'
 
-import { WorkspaceCreationResponse } from '../../Response'
+import { WorkspaceCreationResponse, WorkspaceInvitationResponse } from '../../Response'
 
 export interface WorkspaceApiServiceInterface {
   createWorkspace(dto: {
@@ -10,4 +10,8 @@ export interface WorkspaceApiServiceInterface {
     publicKey?: string
     workspaceName?: string
   }): Promise<WorkspaceCreationResponse>
+  inviteToWorkspace(dto: {
+    inviteeEmail: string
+    workspaceUuid: Uuid
+  }): Promise<WorkspaceInvitationResponse>
 }

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

@@ -0,0 +1,7 @@
+import { Uuid } from "@standardnotes/common"
+
+export type WorkspaceInvitationRequestParams = {
+  workspaceUuid: Uuid
+  inviteeEmail: string
+  [additionalParam: string]: unknown
+}

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

@@ -7,3 +7,4 @@ export * from './Subscription/SubscriptionInviteRequestParams'
 export * from './User/UserRegistrationRequestParams'
 export * from './WebSocket/WebSocketConnectionTokenRequestParams'
 export * from './Workspace/WorkspaceCreationRequestParams'
+export * from './Workspace/WorkspaceInvitationRequestParams'

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

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

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

@@ -0,0 +1,3 @@
+export type WorkspaceInvitationResponseBody = {
+  uuid: string
+}

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

@@ -14,3 +14,5 @@ export * from './WebSocket/WebSocketConnectionTokenResponse'
 export * from './WebSocket/WebSocketConnectionTokenResponseBody'
 export * from './Workspace/WorkspaceCreationResponse'
 export * from './Workspace/WorkspaceCreationResponseBody'
+export * from './Workspace/WorkspaceInvitationResponse'
+export * from './Workspace/WorkspaceInvitationResponseBody'

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

@@ -1,5 +1,8 @@
+import { Uuid } from '@standardnotes/common'
+
 const WorkspacePaths = {
   createWorkspace: '/v1/workspaces',
+  inviteToWorkspace: (uuid: Uuid) => `/v1/workspaces/${uuid}/invites`,
 }
 
 export const Paths = {

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

@@ -1,5 +1,7 @@
+import { WorkspaceType } from '@standardnotes/common'
 import { HttpServiceInterface } from '../../Http'
 import { WorkspaceCreationResponse } from '../../Response/Workspace/WorkspaceCreationResponse'
+import { WorkspaceInvitationResponse } from '../../Response/Workspace/WorkspaceInvitationResponse'
 
 import { WorkspaceServer } from './WorkspaceServer'
 
@@ -17,6 +19,7 @@ describe('WorkspaceServer', () => {
 
   it('should create a workspace', async () => {
     const response = await createServer().createWorkspace({
+      workspaceType: WorkspaceType.Private,
       encryptedPrivateKey: 'foo',
       encryptedWorkspaceKey: 'bar',
       publicKey: 'buzz',
@@ -28,4 +31,21 @@ describe('WorkspaceServer', () => {
       },
     })
   })
+
+  it('should inivte to a workspace', async () => {
+    httpService.post = jest.fn().mockReturnValue({
+      data: { uuid: 'i-1-2-3' },
+    } as jest.Mocked<WorkspaceInvitationResponse>)
+
+    const response = await createServer().inviteToWorkspace({
+      inviteeEmail: 'test@test.te',
+      workspaceUuid: 'w-1-2-3',
+    })
+
+    expect(response).toEqual({
+      data: {
+        uuid: 'i-1-2-3',
+      },
+    })
+  })
 })

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

@@ -1,5 +1,7 @@
 import { HttpServiceInterface } from '../../Http/HttpServiceInterface'
+import { WorkspaceInvitationRequestParams } from '../../Request/Workspace/WorkspaceInvitationRequestParams'
 import { WorkspaceCreationRequestParams } from '../../Request/Workspace/WorkspaceCreationRequestParams'
+import { WorkspaceInvitationResponse } from '../../Response/Workspace/WorkspaceInvitationResponse'
 import { WorkspaceCreationResponse } from '../../Response/Workspace/WorkspaceCreationResponse'
 
 import { Paths } from './Paths'
@@ -8,6 +10,12 @@ import { WorkspaceServerInterface } from './WorkspaceServerInterface'
 export class WorkspaceServer implements WorkspaceServerInterface {
   constructor(private httpService: HttpServiceInterface) {}
 
+  async inviteToWorkspace(params: WorkspaceInvitationRequestParams): Promise<WorkspaceInvitationResponse> {
+    const response = await this.httpService.post(Paths.v1.inviteToWorkspace(params.workspaceUuid), params)
+
+    return response as WorkspaceInvitationResponse
+  }
+
   async createWorkspace(params: WorkspaceCreationRequestParams): Promise<WorkspaceCreationResponse> {
     const response = await this.httpService.post(Paths.v1.createWorkspace, params)
 

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

@@ -1,6 +1,9 @@
+import { WorkspaceInvitationRequestParams } from '../../Request/Workspace/WorkspaceInvitationRequestParams'
 import { WorkspaceCreationRequestParams } from '../../Request/Workspace/WorkspaceCreationRequestParams'
+import { WorkspaceInvitationResponse } from '../../Response/Workspace/WorkspaceInvitationResponse'
 import { WorkspaceCreationResponse } from '../../Response/Workspace/WorkspaceCreationResponse'
 
 export interface WorkspaceServerInterface {
   createWorkspace(params: WorkspaceCreationRequestParams): Promise<WorkspaceCreationResponse>
+  inviteToWorkspace(params: WorkspaceInvitationRequestParams): Promise<WorkspaceInvitationResponse>
 }