feat(api): add workspaces api (#1765)

* feat(api): add workspaces api

* fix(api): lint issues

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

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

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

@@ -0,0 +1,76 @@
+import { WorkspaceCreationResponse } from '../../Response/Workspace/WorkspaceCreationResponse'
+import { WorkspaceServerInterface } from '../../Server/Workspace/WorkspaceServerInterface'
+
+import { WorkspaceApiOperations } from './WorkspaceApiOperations'
+import { WorkspaceApiService } from './WorkspaceApiService'
+
+describe('WorkspaceApiService', () => {
+  let workspaceServer: WorkspaceServerInterface
+
+  const createService = () => new WorkspaceApiService(workspaceServer)
+
+  beforeEach(() => {
+    workspaceServer = {} as jest.Mocked<WorkspaceServerInterface>
+    workspaceServer.createWorkspace = jest.fn().mockReturnValue({
+      data: { uuid: '1-2-3' },
+    } as jest.Mocked<WorkspaceCreationResponse>)
+  })
+
+  it('should create a workspace', async () => {
+    const response = await createService().createWorkspace({
+      encryptedPrivateKey: 'foo',
+      encryptedWorkspaceKey: 'bar',
+      publicKey: 'buzz',
+    })
+
+    expect(response).toEqual({
+      data: {
+        uuid: '1-2-3',
+      },
+    })
+    expect(workspaceServer.createWorkspace).toHaveBeenCalledWith({
+      encryptedPrivateKey: 'foo',
+      encryptedWorkspaceKey: 'bar',
+      publicKey: 'buzz',
+    })
+  })
+
+  it('should not create a workspace if it is already creating', async () => {
+    const service = createService()
+    Object.defineProperty(service, 'operationsInProgress', {
+      get: () => new Map([[WorkspaceApiOperations.Creating, true]]),
+    })
+
+    let error = null
+    try {
+      await service.createWorkspace({
+        encryptedPrivateKey: 'foo',
+        encryptedWorkspaceKey: 'bar',
+        publicKey: 'buzz',
+      })
+    } catch (caughtError) {
+      error = caughtError
+    }
+
+    expect(error).not.toBeNull()
+  })
+
+  it('should not create a workspace if the server fails', async () => {
+    workspaceServer.createWorkspace = jest.fn().mockImplementation(() => {
+      throw new Error('Oops')
+    })
+
+    let error = null
+    try {
+      await createService().createWorkspace({
+        encryptedPrivateKey: 'foo',
+        encryptedWorkspaceKey: 'bar',
+        publicKey: 'buzz',
+      })
+    } catch (caughtError) {
+      error = caughtError
+    }
+
+    expect(error).not.toBeNull()
+  })
+})

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

@@ -0,0 +1,43 @@
+import { ErrorMessage } from '../../Error/ErrorMessage'
+import { ApiCallError } from '../../Error/ApiCallError'
+import { WorkspaceCreationResponse } from '../../Response/Workspace/WorkspaceCreationResponse'
+import { WorkspaceServerInterface } from '../../Server/Workspace/WorkspaceServerInterface'
+
+import { WorkspaceApiServiceInterface } from './WorkspaceApiServiceInterface'
+import { WorkspaceApiOperations } from './WorkspaceApiOperations'
+
+export class WorkspaceApiService implements WorkspaceApiServiceInterface {
+  private operationsInProgress: Map<WorkspaceApiOperations, boolean>
+
+  constructor(private workspaceServer: WorkspaceServerInterface) {
+    this.operationsInProgress = new Map()
+  }
+
+  async createWorkspace(dto: {
+    encryptedWorkspaceKey: string
+    encryptedPrivateKey: string
+    publicKey: string
+    workspaceName?: string
+  }): Promise<WorkspaceCreationResponse> {
+    if (this.operationsInProgress.get(WorkspaceApiOperations.Creating)) {
+      throw new ApiCallError(ErrorMessage.GenericInProgress)
+    }
+
+    this.operationsInProgress.set(WorkspaceApiOperations.Creating, true)
+
+    try {
+      const response = await this.workspaceServer.createWorkspace({
+        encryptedPrivateKey: dto.encryptedPrivateKey,
+        encryptedWorkspaceKey: dto.encryptedWorkspaceKey,
+        publicKey: dto.publicKey,
+        workspaceName: dto.workspaceName,
+      })
+
+      this.operationsInProgress.set(WorkspaceApiOperations.Creating, false)
+
+      return response
+    } catch (error) {
+      throw new ApiCallError(ErrorMessage.GenericFail)
+    }
+  }
+}

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

@@ -0,0 +1,10 @@
+import { WorkspaceCreationResponse } from '../../Response'
+
+export interface WorkspaceApiServiceInterface {
+  createWorkspace(dto: {
+    encryptedWorkspaceKey: string
+    encryptedPrivateKey: string
+    publicKey: string
+    workspaceName?: string
+  }): Promise<WorkspaceCreationResponse>
+}

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

@@ -5,3 +5,5 @@ export * from './User/UserApiService'
 export * from './User/UserApiServiceInterface'
 export * from './WebSocket/WebSocketApiService'
 export * from './WebSocket/WebSocketApiServiceInterface'
+export * from './Workspace/WorkspaceApiService'
+export * from './Workspace/WorkspaceApiServiceInterface'

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

@@ -0,0 +1,7 @@
+export type WorkspaceCreationRequestParams = {
+  encryptedWorkspaceKey: string
+  encryptedPrivateKey: string
+  publicKey: string
+  workspaceName?: string
+  [additionalParam: string]: unknown
+}

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

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

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

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

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

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

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

@@ -12,3 +12,5 @@ export * from './User/UserRegistrationResponse'
 export * from './User/UserRegistrationResponseBody'
 export * from './WebSocket/WebSocketConnectionTokenResponse'
 export * from './WebSocket/WebSocketConnectionTokenResponseBody'
+export * from './Workspace/WorkspaceCreationResponse'
+export * from './Workspace/WorkspaceCreationResponseBody'

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

@@ -0,0 +1,9 @@
+const WorkspacePaths = {
+  createWorkspace: '/v1/workspaces',
+}
+
+export const Paths = {
+  v1: {
+    ...WorkspacePaths,
+  },
+}

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

@@ -0,0 +1,31 @@
+import { HttpServiceInterface } from '../../Http'
+import { WorkspaceCreationResponse } from '../../Response/Workspace/WorkspaceCreationResponse'
+
+import { WorkspaceServer } from './WorkspaceServer'
+
+describe('WorkspaceServer', () => {
+  let httpService: HttpServiceInterface
+
+  const createServer = () => new WorkspaceServer(httpService)
+
+  beforeEach(() => {
+    httpService = {} as jest.Mocked<HttpServiceInterface>
+    httpService.post = jest.fn().mockReturnValue({
+      data: { uuid: '1-2-3' },
+    } as jest.Mocked<WorkspaceCreationResponse>)
+  })
+
+  it('should create a workspace', async () => {
+    const response = await createServer().createWorkspace({
+      encryptedPrivateKey: 'foo',
+      encryptedWorkspaceKey: 'bar',
+      publicKey: 'buzz',
+    })
+
+    expect(response).toEqual({
+      data: {
+        uuid: '1-2-3',
+      },
+    })
+  })
+})

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

@@ -0,0 +1,16 @@
+import { HttpServiceInterface } from '../../Http/HttpServiceInterface'
+import { WorkspaceCreationRequestParams } from '../../Request/Workspace/WorkspaceCreationRequestParams'
+import { WorkspaceCreationResponse } from '../../Response/Workspace/WorkspaceCreationResponse'
+
+import { Paths } from './Paths'
+import { WorkspaceServerInterface } from './WorkspaceServerInterface'
+
+export class WorkspaceServer implements WorkspaceServerInterface {
+  constructor(private httpService: HttpServiceInterface) {}
+
+  async createWorkspace(params: WorkspaceCreationRequestParams): Promise<WorkspaceCreationResponse> {
+    const response = await this.httpService.post(Paths.v1.createWorkspace, params)
+
+    return response as WorkspaceCreationResponse
+  }
+}

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

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

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

@@ -4,3 +4,5 @@ export * from './User/UserServer'
 export * from './User/UserServerInterface'
 export * from './WebSocket/WebSocketServer'
 export * from './WebSocket/WebSocketServerInterface'
+export * from './Workspace/WorkspaceServer'
+export * from './Workspace/WorkspaceServerInterface'