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

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

* fix(api): linter issues

* feat(models): add subscription invitations

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

* fix(api): linter issues

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

@@ -0,0 +1,15 @@
+import { Uuid } from '@standardnotes/common'
+
+const SharingPaths = {
+  invite: '/v1/subscription-invites',
+  acceptInvite: (inviteUuid: Uuid) => `/v1/subscription-invites/${inviteUuid}/accept`,
+  declineInvite: (inviteUuid: Uuid) => `/v1/subscription-invites/${inviteUuid}/decline`,
+  cancelInvite: (inviteUuid: Uuid) => `/v1/subscription-invites/${inviteUuid}`,
+  listInvites: '/v1/subscription-invites',
+}
+
+export const Paths = {
+  v1: {
+    ...SharingPaths,
+  },
+}

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

@@ -0,0 +1,105 @@
+import { Invitation } from '@standardnotes/models'
+
+import { ApiVersion } from '../../Api'
+import { HttpServiceInterface } from '../../Http'
+import { SubscriptionInviteResponse } from '../../Response'
+import { SubscriptionInviteAcceptResponse } from '../../Response/Subscription/SubscriptionInviteAcceptResponse'
+import { SubscriptionInviteCancelResponse } from '../../Response/Subscription/SubscriptionInviteCancelResponse'
+import { SubscriptionInviteDeclineResponse } from '../../Response/Subscription/SubscriptionInviteDeclineResponse'
+import { SubscriptionInviteListResponse } from '../../Response/Subscription/SubscriptionInviteListResponse'
+import { SubscriptionServer } from './SubscriptionServer'
+
+describe('SubscriptionServer', () => {
+  let httpService: HttpServiceInterface
+
+  const createServer = () => new SubscriptionServer(httpService)
+
+  beforeEach(() => {
+    httpService = {} as jest.Mocked<HttpServiceInterface>
+  })
+
+  it('should invite a user to a shared subscription', async () => {
+    httpService.post = jest.fn().mockReturnValue({
+      data: { success: true, sharedSubscriptionInvitationUuid: '1-2-3' },
+    } as jest.Mocked<SubscriptionInviteResponse>)
+
+    const response = await createServer().invite({
+      api: ApiVersion.v0,
+      identifier: 'test@test.te',
+    })
+
+    expect(response).toEqual({
+      data: {
+        success: true,
+        sharedSubscriptionInvitationUuid: '1-2-3',
+      },
+    })
+  })
+
+  it('should accept an invite to a shared subscription', async () => {
+    httpService.get = jest.fn().mockReturnValue({
+      data: { success: true },
+    } as jest.Mocked<SubscriptionInviteAcceptResponse>)
+
+    const response = await createServer().acceptInvite({
+      api: ApiVersion.v0,
+      inviteUuid: '1-2-3',
+    })
+
+    expect(response).toEqual({
+      data: {
+        success: true,
+      },
+    })
+  })
+
+  it('should decline an invite to a shared subscription', async () => {
+    httpService.get = jest.fn().mockReturnValue({
+      data: { success: true },
+    } as jest.Mocked<SubscriptionInviteDeclineResponse>)
+
+    const response = await createServer().declineInvite({
+      api: ApiVersion.v0,
+      inviteUuid: '1-2-3',
+    })
+
+    expect(response).toEqual({
+      data: {
+        success: true,
+      },
+    })
+  })
+
+  it('should cancel an invite to a shared subscription', async () => {
+    httpService.delete = jest.fn().mockReturnValue({
+      data: { success: true },
+    } as jest.Mocked<SubscriptionInviteCancelResponse>)
+
+    const response = await createServer().cancelInvite({
+      api: ApiVersion.v0,
+      inviteUuid: '1-2-3',
+    })
+
+    expect(response).toEqual({
+      data: {
+        success: true,
+      },
+    })
+  })
+
+  it('should list invitations to a shared subscription', async () => {
+    httpService.get = jest.fn().mockReturnValue({
+      data: { invitations: [{} as jest.Mocked<Invitation>] },
+    } as jest.Mocked<SubscriptionInviteListResponse>)
+
+    const response = await createServer().listInvites({
+      api: ApiVersion.v0,
+    })
+
+    expect(response).toEqual({
+      data: {
+        invitations: [{} as jest.Mocked<Invitation>],
+      },
+    })
+  })
+})

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

@@ -0,0 +1,48 @@
+import { HttpServiceInterface } from '../../Http/HttpServiceInterface'
+import { SubscriptionInviteAcceptRequestParams } from '../../Request/Subscription/SubscriptionInviteAcceptRequestParams'
+import { SubscriptionInviteCancelRequestParams } from '../../Request/Subscription/SubscriptionInviteCancelRequestParams'
+import { SubscriptionInviteDeclineRequestParams } from '../../Request/Subscription/SubscriptionInviteDeclineRequestParams'
+import { SubscriptionInviteListRequestParams } from '../../Request/Subscription/SubscriptionInviteListRequestParams'
+import { SubscriptionInviteRequestParams } from '../../Request/Subscription/SubscriptionInviteRequestParams'
+import { SubscriptionInviteAcceptResponse } from '../../Response/Subscription/SubscriptionInviteAcceptResponse'
+import { SubscriptionInviteCancelResponse } from '../../Response/Subscription/SubscriptionInviteCancelResponse'
+import { SubscriptionInviteDeclineResponse } from '../../Response/Subscription/SubscriptionInviteDeclineResponse'
+import { SubscriptionInviteListResponse } from '../../Response/Subscription/SubscriptionInviteListResponse'
+import { SubscriptionInviteResponse } from '../../Response/Subscription/SubscriptionInviteResponse'
+
+import { Paths } from './Paths'
+import { SubscriptionServerInterface } from './SubscriptionServerInterface'
+
+export class SubscriptionServer implements SubscriptionServerInterface {
+  constructor(private httpService: HttpServiceInterface) {}
+
+  async acceptInvite(params: SubscriptionInviteAcceptRequestParams): Promise<SubscriptionInviteAcceptResponse> {
+    const response = await this.httpService.get(Paths.v1.acceptInvite(params.inviteUuid), params)
+
+    return response as SubscriptionInviteAcceptResponse
+  }
+
+  async declineInvite(params: SubscriptionInviteDeclineRequestParams): Promise<SubscriptionInviteDeclineResponse> {
+    const response = await this.httpService.get(Paths.v1.declineInvite(params.inviteUuid), params)
+
+    return response as SubscriptionInviteDeclineResponse
+  }
+
+  async cancelInvite(params: SubscriptionInviteCancelRequestParams): Promise<SubscriptionInviteCancelResponse> {
+    const response = await this.httpService.delete(Paths.v1.cancelInvite(params.inviteUuid), params)
+
+    return response as SubscriptionInviteCancelResponse
+  }
+
+  async listInvites(params: SubscriptionInviteListRequestParams): Promise<SubscriptionInviteListResponse> {
+    const response = await this.httpService.get(Paths.v1.listInvites, params)
+
+    return response as SubscriptionInviteListResponse
+  }
+
+  async invite(params: SubscriptionInviteRequestParams): Promise<SubscriptionInviteResponse> {
+    const response = await this.httpService.post(Paths.v1.invite, params)
+
+    return response as SubscriptionInviteResponse
+  }
+}

packages/api/src/Domain/Server/Subscription/SubscriptionServerInterface.ts

@@ -0,0 +1,18 @@
+import { SubscriptionInviteAcceptRequestParams } from '../../Request/Subscription/SubscriptionInviteAcceptRequestParams'
+import { SubscriptionInviteCancelRequestParams } from '../../Request/Subscription/SubscriptionInviteCancelRequestParams'
+import { SubscriptionInviteDeclineRequestParams } from '../../Request/Subscription/SubscriptionInviteDeclineRequestParams'
+import { SubscriptionInviteListRequestParams } from '../../Request/Subscription/SubscriptionInviteListRequestParams'
+import { SubscriptionInviteRequestParams } from '../../Request/Subscription/SubscriptionInviteRequestParams'
+import { SubscriptionInviteAcceptResponse } from '../../Response/Subscription/SubscriptionInviteAcceptResponse'
+import { SubscriptionInviteCancelResponse } from '../../Response/Subscription/SubscriptionInviteCancelResponse'
+import { SubscriptionInviteDeclineResponse } from '../../Response/Subscription/SubscriptionInviteDeclineResponse'
+import { SubscriptionInviteListResponse } from '../../Response/Subscription/SubscriptionInviteListResponse'
+import { SubscriptionInviteResponse } from '../../Response/Subscription/SubscriptionInviteResponse'
+
+export interface SubscriptionServerInterface {
+  invite(params: SubscriptionInviteRequestParams): Promise<SubscriptionInviteResponse>
+  acceptInvite(params: SubscriptionInviteAcceptRequestParams): Promise<SubscriptionInviteAcceptResponse>
+  declineInvite(params: SubscriptionInviteDeclineRequestParams): Promise<SubscriptionInviteDeclineResponse>
+  cancelInvite(params: SubscriptionInviteCancelRequestParams): Promise<SubscriptionInviteCancelResponse>
+  listInvites(params: SubscriptionInviteListRequestParams): Promise<SubscriptionInviteListResponse>
+}