feat(api): add client methods for listing and canceling subscription invites (#1471)

* feat(api): add subscription server and client services and interfaces

* feat(api): add subscriptions invitation operations on server side

* fix(api): linter issues

* feat(api): add client methods for listing and canceling subscription invites

* fix(api): imports

packages/api/src/Domain/Client/Subscription/SubscriptionApiOperations.ts

@@ -0,0 +1,5 @@
+export enum SubscriptionApiOperations {
+  Inviting,
+  CancelingInvite,
+  ListingInvites,
+}

packages/api/src/Domain/Client/Subscription/SubscriptionApiService.spec.ts

@@ -1,6 +1,11 @@
+import { Invitation } from '@standardnotes/models'
+
+import { SubscriptionInviteCancelResponse } from '../../Response/Subscription/SubscriptionInviteCancelResponse'
+import { SubscriptionInviteListResponse } from '../../Response/Subscription/SubscriptionInviteListResponse'
 import { SubscriptionInviteResponse } from '../../Response/Subscription/SubscriptionInviteResponse'
 import { SubscriptionServerInterface } from '../../Server/Subscription/SubscriptionServerInterface'
 
+import { SubscriptionApiOperations } from './SubscriptionApiOperations'
 import { SubscriptionApiService } from './SubscriptionApiService'
 
 describe('SubscriptionApiService', () => {
@@ -13,6 +18,12 @@ describe('SubscriptionApiService', () => {
     subscriptionServer.invite = jest.fn().mockReturnValue({
       data: { success: true, sharedSubscriptionInvitationUuid: '1-2-3' },
     } as jest.Mocked<SubscriptionInviteResponse>)
+    subscriptionServer.cancelInvite = jest.fn().mockReturnValue({
+      data: { success: true },
+    } as jest.Mocked<SubscriptionInviteCancelResponse>)
+    subscriptionServer.listInvites = jest.fn().mockReturnValue({
+      data: { invitations: [{} as jest.Mocked<Invitation>] },
+    } as jest.Mocked<SubscriptionInviteListResponse>)
   })
 
   it('should invite a user', async () => {
@@ -32,8 +43,8 @@ describe('SubscriptionApiService', () => {
 
   it('should not invite a user if it is already inviting', async () => {
     const service = createService()
-    Object.defineProperty(service, 'inviting', {
-      get: () => true,
+    Object.defineProperty(service, 'operationsInProgress', {
+      get: () => new Map([[SubscriptionApiOperations.Inviting, true]]),
     })
 
     let error = null
@@ -60,4 +71,93 @@ describe('SubscriptionApiService', () => {
 
     expect(error).not.toBeNull()
   })
+
+  it('should cancel an invite', async () => {
+    const response = await createService().cancelInvite('1-2-3')
+
+    expect(response).toEqual({
+      data: {
+        success: true,
+      },
+    })
+    expect(subscriptionServer.cancelInvite).toHaveBeenCalledWith({
+      api: '20200115',
+      inviteUuid: '1-2-3',
+    })
+  })
+
+  it('should not cancel an invite if it is already canceling', async () => {
+    const service = createService()
+    Object.defineProperty(service, 'operationsInProgress', {
+      get: () => new Map([[SubscriptionApiOperations.CancelingInvite, true]]),
+    })
+
+    let error = null
+    try {
+      await service.cancelInvite('1-2-3')
+    } catch (caughtError) {
+      error = caughtError
+    }
+
+    expect(error).not.toBeNull()
+  })
+
+  it('should not cancel an invite if the server fails', async () => {
+    subscriptionServer.cancelInvite = jest.fn().mockImplementation(() => {
+      throw new Error('Oops')
+    })
+
+    let error = null
+    try {
+      await createService().cancelInvite('1-2-3')
+    } catch (caughtError) {
+      error = caughtError
+    }
+
+    expect(error).not.toBeNull()
+  })
+
+  it('should list invites', async () => {
+    const response = await createService().listInvites()
+
+    expect(response).toEqual({
+      data: {
+        invitations: [{} as jest.Mocked<Invitation>],
+      },
+    })
+    expect(subscriptionServer.listInvites).toHaveBeenCalledWith({
+      api: '20200115',
+    })
+  })
+
+  it('should not list invitations if it is already listing', async () => {
+    const service = createService()
+    Object.defineProperty(service, 'operationsInProgress', {
+      get: () => new Map([[SubscriptionApiOperations.ListingInvites, true]]),
+    })
+
+    let error = null
+    try {
+      await service.listInvites()
+    } catch (caughtError) {
+      error = caughtError
+    }
+
+    expect(error).not.toBeNull()
+  })
+
+  it('should not list invites if the server fails', async () => {
+    subscriptionServer.listInvites = jest.fn().mockImplementation(() => {
+      throw new Error('Oops')
+    })
+
+    let error = null
+    try {
+      await createService().listInvites()
+    } catch (caughtError) {
+      error = caughtError
+    }
+
+    expect(error).not.toBeNull()
+  })
 })

packages/api/src/Domain/Client/Subscription/SubscriptionApiService.ts

@@ -2,22 +2,68 @@ import { ErrorMessage } from '../../Error/ErrorMessage'
 import { ApiCallError } from '../../Error/ApiCallError'
 import { ApiVersion } from '../../Api/ApiVersion'
 import { ApiEndpointParam } from '../../Request/ApiEndpointParam'
-import { SubscriptionApiServiceInterface } from './SubscriptionApiServiceInterface'
 import { SubscriptionServerInterface } from '../../Server/Subscription/SubscriptionServerInterface'
 import { SubscriptionInviteResponse } from '../../Response/Subscription/SubscriptionInviteResponse'
+import { SubscriptionInviteListResponse } from '../../Response/Subscription/SubscriptionInviteListResponse'
+import { SubscriptionInviteCancelResponse } from '../../Response/Subscription/SubscriptionInviteCancelResponse'
+
+import { SubscriptionApiServiceInterface } from './SubscriptionApiServiceInterface'
+import { SubscriptionApiOperations } from './SubscriptionApiOperations'
 
 export class SubscriptionApiService implements SubscriptionApiServiceInterface {
-  private inviting: boolean
+  private operationsInProgress: Map<SubscriptionApiOperations, boolean>
 
   constructor(private subscriptionServer: SubscriptionServerInterface) {
-    this.inviting = false
+    this.operationsInProgress = new Map()
+  }
+
+  async listInvites(): Promise<SubscriptionInviteListResponse> {
+    if (this.operationsInProgress.get(SubscriptionApiOperations.ListingInvites)) {
+      throw new ApiCallError(ErrorMessage.GenericInProgress)
+    }
+
+    this.operationsInProgress.set(SubscriptionApiOperations.ListingInvites, true)
+
+    try {
+      const response = await this.subscriptionServer.listInvites({
+        [ApiEndpointParam.ApiVersion]: ApiVersion.v0,
+      })
+
+      this.operationsInProgress.set(SubscriptionApiOperations.ListingInvites, false)
+
+      return response
+    } catch (error) {
+      throw new ApiCallError(ErrorMessage.GenericFail)
+    }
+  }
+
+  async cancelInvite(inviteUuid: string): Promise<SubscriptionInviteCancelResponse> {
+    if (this.operationsInProgress.get(SubscriptionApiOperations.CancelingInvite)) {
+      throw new ApiCallError(ErrorMessage.GenericInProgress)
+    }
+
+    this.operationsInProgress.set(SubscriptionApiOperations.CancelingInvite, true)
+
+    try {
+      const response = await this.subscriptionServer.cancelInvite({
+        [ApiEndpointParam.ApiVersion]: ApiVersion.v0,
+        inviteUuid,
+      })
+
+      this.operationsInProgress.set(SubscriptionApiOperations.CancelingInvite, false)
+
+      return response
+    } catch (error) {
+      throw new ApiCallError(ErrorMessage.GenericFail)
+    }
   }
 
   async invite(inviteeEmail: string): Promise<SubscriptionInviteResponse> {
-    if (this.inviting) {
-      throw new ApiCallError(ErrorMessage.InvitingInProgress)
+    if (this.operationsInProgress.get(SubscriptionApiOperations.Inviting)) {
+      throw new ApiCallError(ErrorMessage.GenericInProgress)
     }
-    this.inviting = true
+
+    this.operationsInProgress.set(SubscriptionApiOperations.Inviting, true)
 
     try {
       const response = await this.subscriptionServer.invite({
@@ -25,7 +71,7 @@ export class SubscriptionApiService implements SubscriptionApiServiceInterface {
         identifier: inviteeEmail,
       })
 
-      this.inviting = false
+      this.operationsInProgress.set(SubscriptionApiOperations.Inviting, false)
 
       return response
     } catch (error) {

packages/api/src/Domain/Client/Subscription/SubscriptionApiServiceInterface.ts

@@ -1,5 +1,11 @@
+import { Uuid } from '@standardnotes/common'
+
+import { SubscriptionInviteCancelResponse } from '../../Response/Subscription/SubscriptionInviteCancelResponse'
+import { SubscriptionInviteListResponse } from '../../Response/Subscription/SubscriptionInviteListResponse'
 import { SubscriptionInviteResponse } from '../../Response/Subscription/SubscriptionInviteResponse'
 
 export interface SubscriptionApiServiceInterface {
   invite(inviteeEmail: string): Promise<SubscriptionInviteResponse>
+  listInvites(): Promise<SubscriptionInviteListResponse>
+  cancelInvite(inviteUuid: Uuid): Promise<SubscriptionInviteCancelResponse>
 }

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

@@ -1,3 +1,4 @@
+export * from './Subscription/SubscriptionApiOperations'
 export * from './Subscription/SubscriptionApiService'
 export * from './Subscription/SubscriptionApiServiceInterface'
 export * from './User/UserApiService'

packages/api/src/Domain/Error/ErrorMessage.ts

@@ -1,9 +1,9 @@
 export enum ErrorMessage {
-  InvitingInProgress = 'An existing invitation request is already in progress.',
   RegistrationInProgress = 'An existing registration request is already in progress.',
   GenericRegistrationFail = 'A server error occurred while trying to register. Please try again.',
   RateLimited = 'Too many successive server requests. Please wait a few minutes and try again.',
   InsufficientPasswordMessage = 'Your password must be at least %LENGTH% characters in length. For your security, please choose a longer password or, ideally, a passphrase, and try again.',
   PasscodeRequired = 'Your passcode is required in order to register for an account.',
+  GenericInProgress = 'An existing request is already in progress.',
   GenericFail = 'A server error occurred. Please try again.',
 }

packages/api/src/Domain/Server/Subscription/SubscriptionServer.spec.ts

@@ -7,6 +7,7 @@ import { SubscriptionInviteAcceptResponse } from '../../Response/Subscription/Su
 import { SubscriptionInviteCancelResponse } from '../../Response/Subscription/SubscriptionInviteCancelResponse'
 import { SubscriptionInviteDeclineResponse } from '../../Response/Subscription/SubscriptionInviteDeclineResponse'
 import { SubscriptionInviteListResponse } from '../../Response/Subscription/SubscriptionInviteListResponse'
+
 import { SubscriptionServer } from './SubscriptionServer'
 
 describe('SubscriptionServer', () => {