chore(release): publish

- @standardnotes/[email protected]
 - @standardnotes/[email protected]
 - @standardnotes/[email protected].6
 - @standardnotes/[email protected].6
 - @standardnotes/[email protected].6
 - @standardnotes/[email protected].3
 - @standardnotes/[email protected]
 - @standardnotes/[email protected].1
 - @standardnotes/[email protected].0
 - @standardnotes/[email protected].0
 - @standardnotes/[email protected].1
 - @standardnotes/[email protected]
 - @standardnotes/[email protected].3

.eslintignore

@@ -1,2 +1,19 @@
 node_modules
-scripts
+scripts
+actions
+.yarn
+.vscode
+.sass-cache
+.husky
+.github
+.git
+**/dist
+**/coverage
+**/node_modules
+packages/components
+packages/docs
+packages/mobile/android
+packages/mobile/ios
+packages/mobile/html
+packages/snjs/mocha
+*.d.ts

.eslintrc.json

@@ -1,4 +1,4 @@
 {
   "extends": ["./node_modules/@standardnotes/config/src/.eslintrc"],
-  "ignorePatterns": [".eslintrc.js", "*.webpack.*.js", "webpack-defaults.js", "jest.config.js", "__mocks__"]
+  "ignorePatterns": [".eslintrc.js", "*.webpack.*.js", "webpack-defaults.js", "jest.config.js", "__mocks__", "**/**/coverage"]
 }

package.json

@@ -29,6 +29,7 @@
     "build:mobile": "yarn workspaces foreach -pt --verbose -R --from @standardnotes/mobile --exclude @standardnotes/components-meta run build",
     "build:snjs": "yarn workspaces foreach -pt --verbose -R --from @standardnotes/snjs --exclude @standardnotes/components-meta run build",
     "build:services": "yarn workspaces foreach -pt --verbose -R --from @standardnotes/services --exclude @standardnotes/components-meta run build",
+    "build:api": "yarn workspaces foreach -pt --verbose -R --from @standardnotes/api --exclude @standardnotes/components-meta run build",
     "start:server:web": "lerna run start --scope=@standardnotes/web",
     "start:server:e2e": "lerna run start:test-server --scope=@standardnotes/snjs",
     "prepare": "husky install",

packages/api/.eslintignore

@@ -1,2 +1,3 @@
 node_modules
 dist
+coverage

packages/api/CHANGELOG.md

@@ -3,6 +3,44 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.8.4](https://github.com/standardnotes/app/compare/@standardnotes/[email protected]...@standardnotes/[email protected]) (2022-09-28)
+
+**Note:** Version bump only for package @standardnotes/api
+
+## [1.8.3](https://github.com/standardnotes/app/compare/@standardnotes/[email protected]...@standardnotes/[email protected]) (2022-09-24)
+
+**Note:** Version bump only for package @standardnotes/api
+
+## [1.8.2](https://github.com/standardnotes/app/compare/@standardnotes/[email protected]...@standardnotes/[email protected]) (2022-09-23)
+
+**Note:** Version bump only for package @standardnotes/api
+
+## [1.8.1](https://github.com/standardnotes/app/compare/@standardnotes/[email protected]...@standardnotes/[email protected]) (2022-09-20)
+
+### Bug Fixes
+
+* move wrapped storage to unwrapped if not encrypted ([#1603](https://github.com/standardnotes/app/issues/1603)) ([c5e225d](https://github.com/standardnotes/app/commit/c5e225d335537257f44168b8ad05222afccb508a))
+
+# [1.8.0](https://github.com/standardnotes/app/compare/@standardnotes/[email protected]...@standardnotes/[email protected]) (2022-09-20)
+
+### Features
+
+* **api:** add websocket api definitions ([4a773fa](https://github.com/standardnotes/app/commit/4a773fa53796e17ce5df325ed7d40ba2cb686476))
+
+## [1.7.2](https://github.com/standardnotes/app/compare/@standardnotes/[email protected]...@standardnotes/[email protected]) (2022-09-15)
+
+**Note:** Version bump only for package @standardnotes/api
+
+## [1.7.1](https://github.com/standardnotes/app/compare/@standardnotes/[email protected]...@standardnotes/[email protected]) (2022-09-13)
+
+**Note:** Version bump only for package @standardnotes/api
+
+# [1.7.0](https://github.com/standardnotes/app/compare/@standardnotes/[email protected]...@standardnotes/[email protected]) (2022-09-13)
+
+### Features
+
+* add subscription manager to handle subscription sharing ([#1517](https://github.com/standardnotes/app/issues/1517)) ([55b1409](https://github.com/standardnotes/app/commit/55b1409a805c21ada70bf482a02cfe718a4c6576))
+
 ## [1.6.2](https://github.com/standardnotes/app/compare/@standardnotes/[email protected]...@standardnotes/[email protected]) (2022-09-09)
 
 **Note:** Version bump only for package @standardnotes/api

packages/api/jest.config.js

@@ -10,10 +10,10 @@ module.exports = {
   },
   coverageThreshold: {
     global: {
-      branches: 17,
-      functions: 43,
-      lines: 46,
-      statements: 46
+      branches: 20,
+      functions: 66,
+      lines: 63,
+      statements: 63
     }
   }
 };

packages/api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/api",
-  "version": "1.6.2",
+  "version": "1.8.4",
   "engines": {
     "node": ">=16.0.0 <17.0.0"
   },
@@ -32,15 +32,15 @@
     "eslint": "^8.23.0",
     "eslint-plugin-prettier": "*",
     "jest": "^28.1.2",
-    "ts-jest": "^28.0.5"
+    "ts-jest": "^28.0.5",
+    "typescript": "*"
   },
   "dependencies": {
-    "@standardnotes/common": "^1.23.1",
+    "@standardnotes/common": "^1.32.0",
     "@standardnotes/encryption": "workspace:*",
     "@standardnotes/models": "workspace:*",
     "@standardnotes/responses": "workspace:*",
     "@standardnotes/security": "^1.1.0",
-    "@standardnotes/services": "workspace:*",
     "@standardnotes/utils": "workspace:*",
     "reflect-metadata": "^0.1.13"
   }

packages/api/src/Domain/Client/WebSocket/WebSocketApiOperations.ts

@@ -0,0 +1,3 @@
+export enum WebSocketApiOperations {
+  CreatingConnectionToken,
+}

packages/api/src/Domain/Client/WebSocket/WebSocketApiService.spec.ts

@@ -0,0 +1,61 @@
+import { WebSocketConnectionTokenResponse } from '../../Response'
+
+import { WebSocketServerInterface } from '../../Server/WebSocket/WebSocketServerInterface'
+import { WebSocketApiOperations } from './WebSocketApiOperations'
+
+import { WebSocketApiService } from './WebSocketApiService'
+
+describe('WebSocketApiService', () => {
+  let webSocketServer: WebSocketServerInterface
+
+  const createService = () => new WebSocketApiService(webSocketServer)
+
+  beforeEach(() => {
+    webSocketServer = {} as jest.Mocked<WebSocketServerInterface>
+    webSocketServer.createConnectionToken = jest.fn().mockReturnValue({
+      data: { token: 'foobar' },
+    } as jest.Mocked<WebSocketConnectionTokenResponse>)
+  })
+
+  it('should create a websocket connection token', async () => {
+    const response = await createService().createConnectionToken()
+
+    expect(response).toEqual({
+      data: {
+        token: 'foobar',
+      },
+    })
+    expect(webSocketServer.createConnectionToken).toHaveBeenCalledWith({})
+  })
+
+  it('should not create a token if it is already creating', async () => {
+    const service = createService()
+    Object.defineProperty(service, 'operationsInProgress', {
+      get: () => new Map([[WebSocketApiOperations.CreatingConnectionToken, true]]),
+    })
+
+    let error = null
+    try {
+      await service.createConnectionToken()
+    } catch (caughtError) {
+      error = caughtError
+    }
+
+    expect(error).not.toBeNull()
+  })
+
+  it('should not create a token if the server fails', async () => {
+    webSocketServer.createConnectionToken = jest.fn().mockImplementation(() => {
+      throw new Error('Oops')
+    })
+
+    let error = null
+    try {
+      await createService().createConnectionToken()
+    } catch (caughtError) {
+      error = caughtError
+    }
+
+    expect(error).not.toBeNull()
+  })
+})

packages/api/src/Domain/Client/WebSocket/WebSocketApiService.ts

@@ -0,0 +1,33 @@
+import { ErrorMessage } from '../../Error/ErrorMessage'
+import { ApiCallError } from '../../Error/ApiCallError'
+
+import { WebSocketApiServiceInterface } from './WebSocketApiServiceInterface'
+import { WebSocketApiOperations } from './WebSocketApiOperations'
+import { WebSocketServerInterface } from '../../Server'
+import { WebSocketConnectionTokenResponse } from '../../Response'
+
+export class WebSocketApiService implements WebSocketApiServiceInterface {
+  private operationsInProgress: Map<WebSocketApiOperations, boolean>
+
+  constructor(private webSocketServer: WebSocketServerInterface) {
+    this.operationsInProgress = new Map()
+  }
+
+  async createConnectionToken(): Promise<WebSocketConnectionTokenResponse> {
+    if (this.operationsInProgress.get(WebSocketApiOperations.CreatingConnectionToken)) {
+      throw new ApiCallError(ErrorMessage.GenericInProgress)
+    }
+
+    this.operationsInProgress.set(WebSocketApiOperations.CreatingConnectionToken, true)
+
+    try {
+      const response = await this.webSocketServer.createConnectionToken({})
+
+      this.operationsInProgress.set(WebSocketApiOperations.CreatingConnectionToken, false)
+
+      return response
+    } catch (error) {
+      throw new ApiCallError(ErrorMessage.GenericFail)
+    }
+  }
+}

packages/api/src/Domain/Client/WebSocket/WebSocketApiServiceInterface.ts

@@ -0,0 +1,5 @@
+import { WebSocketConnectionTokenResponse } from '../../Response'
+
+export interface WebSocketApiServiceInterface {
+  createConnectionToken(): Promise<WebSocketConnectionTokenResponse>
+}

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

@@ -3,3 +3,5 @@ export * from './Subscription/SubscriptionApiService'
 export * from './Subscription/SubscriptionApiServiceInterface'
 export * from './User/UserApiService'
 export * from './User/UserApiServiceInterface'
+export * from './WebSocket/WebSocketApiService'
+export * from './WebSocket/WebSocketApiServiceInterface'

packages/api/src/Domain/Http/HttpService.spec.ts

@@ -1,4 +1,5 @@
-import { Environment } from '@standardnotes/services'
+import { Environment } from '@standardnotes/models'
+
 import { HttpResponseMeta } from './HttpResponseMeta'
 import { HttpService } from './HttpService'
 
@@ -24,4 +25,14 @@ describe('HttpService', () => {
 
     expect(service['host']).toEqual('http://foo')
   })
+
+  it('should set and use the authorization token', () => {
+    const service = createService()
+
+    expect(service['authorizationToken']).toBeUndefined()
+
+    service.setAuthorizationToken('foo-bar')
+
+    expect(service['authorizationToken']).toEqual('foo-bar')
+  })
 })

packages/api/src/Domain/Http/HttpService.ts

@@ -1,5 +1,5 @@
 import { isString, joinPaths } from '@standardnotes/utils'
-import { Environment } from '@standardnotes/services'
+import { Environment } from '@standardnotes/models'
 import { HttpRequestParams } from './HttpRequestParams'
 import { HttpVerb } from './HttpVerb'
 import { HttpRequest } from './HttpRequest'
@@ -12,6 +12,8 @@ import { HttpResponseMeta } from './HttpResponseMeta'
 import { HttpErrorResponseBody } from './HttpErrorResponseBody'
 
 export class HttpService implements HttpServiceInterface {
+  private authorizationToken?: string
+
   constructor(
     private environment: Environment,
     private appVersion: string,
@@ -20,28 +22,57 @@ export class HttpService implements HttpServiceInterface {
     private updateMetaCallback: (meta: HttpResponseMeta) => void,
   ) {}
 
+  setAuthorizationToken(authorizationToken: string): void {
+    this.authorizationToken = authorizationToken
+  }
+
   setHost(host: string): void {
     this.host = host
   }
 
   async get(path: string, params?: HttpRequestParams, authentication?: string): Promise<HttpResponse> {
-    return this.runHttp({ url: joinPaths(this.host, path), params, verb: HttpVerb.Get, authentication })
+    return this.runHttp({
+      url: joinPaths(this.host, path),
+      params,
+      verb: HttpVerb.Get,
+      authentication: authentication ?? this.authorizationToken,
+    })
   }
 
   async post(path: string, params?: HttpRequestParams, authentication?: string): Promise<HttpResponse> {
-    return this.runHttp({ url: joinPaths(this.host, path), params, verb: HttpVerb.Post, authentication })
+    return this.runHttp({
+      url: joinPaths(this.host, path),
+      params,
+      verb: HttpVerb.Post,
+      authentication: authentication ?? this.authorizationToken,
+    })
   }
 
   async put(path: string, params?: HttpRequestParams, authentication?: string): Promise<HttpResponse> {
-    return this.runHttp({ url: joinPaths(this.host, path), params, verb: HttpVerb.Put, authentication })
+    return this.runHttp({
+      url: joinPaths(this.host, path),
+      params,
+      verb: HttpVerb.Put,
+      authentication: authentication ?? this.authorizationToken,
+    })
   }
 
   async patch(path: string, params: HttpRequestParams, authentication?: string): Promise<HttpResponse> {
-    return this.runHttp({ url: joinPaths(this.host, path), params, verb: HttpVerb.Patch, authentication })
+    return this.runHttp({
+      url: joinPaths(this.host, path),
+      params,
+      verb: HttpVerb.Patch,
+      authentication: authentication ?? this.authorizationToken,
+    })
   }
 
   async delete(path: string, params?: HttpRequestParams, authentication?: string): Promise<HttpResponse> {
-    return this.runHttp({ url: joinPaths(this.host, path), params, verb: HttpVerb.Delete, authentication })
+    return this.runHttp({
+      url: joinPaths(this.host, path),
+      params,
+      verb: HttpVerb.Delete,
+      authentication: authentication ?? this.authorizationToken,
+    })
   }
 
   private async runHttp(httpRequest: HttpRequest): Promise<HttpResponse> {

packages/api/src/Domain/Http/HttpServiceInterface.ts

@@ -3,6 +3,7 @@ import { HttpResponse } from './HttpResponse'
 
 export interface HttpServiceInterface {
   setHost(host: string): void
+  setAuthorizationToken(authorizationToken: string): void
   get(path: string, params?: HttpRequestParams, authentication?: string): Promise<HttpResponse>
   post(path: string, params?: HttpRequestParams, authentication?: string): Promise<HttpResponse>
   put(path: string, params?: HttpRequestParams, authentication?: string): Promise<HttpResponse>

packages/api/src/Domain/Request/WebSocket/WebSocketConnectionTokenRequestParams.ts

@@ -0,0 +1,3 @@
+export type WebSocketConnectionTokenRequestParams = {
+  [additionalParam: string]: unknown
+}

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

@@ -5,3 +5,4 @@ export * from './Subscription/SubscriptionInviteDeclineRequestParams'
 export * from './Subscription/SubscriptionInviteListRequestParams'
 export * from './Subscription/SubscriptionInviteRequestParams'
 export * from './User/UserRegistrationRequestParams'
+export * from './WebSocket/WebSocketConnectionTokenRequestParams'

packages/api/src/Domain/Response/Subscription/SubscriptionInviteAcceptResponse.ts

@@ -1,7 +1,9 @@
+import { Either } from '@standardnotes/common'
+
 import { HttpErrorResponseBody } from '../../Http/HttpErrorResponseBody'
 import { HttpResponse } from '../../Http/HttpResponse'
 import { SubscriptionInviteAcceptResponseBody } from './SubscriptionInviteAcceptResponseBody'
 
 export interface SubscriptionInviteAcceptResponse extends HttpResponse {
-  data: SubscriptionInviteAcceptResponseBody | HttpErrorResponseBody
+  data: Either<SubscriptionInviteAcceptResponseBody, HttpErrorResponseBody>
 }

packages/api/src/Domain/Response/Subscription/SubscriptionInviteCancelResponse.ts

@@ -1,7 +1,9 @@
+import { Either } from '@standardnotes/common'
+
 import { HttpErrorResponseBody } from '../../Http/HttpErrorResponseBody'
 import { HttpResponse } from '../../Http/HttpResponse'
 import { SubscriptionInviteCancelResponseBody } from './SubscriptionInviteCancelResponseBody'
 
 export interface SubscriptionInviteCancelResponse extends HttpResponse {
-  data: SubscriptionInviteCancelResponseBody | HttpErrorResponseBody
+  data: Either<SubscriptionInviteCancelResponseBody, HttpErrorResponseBody>
 }

packages/api/src/Domain/Response/Subscription/SubscriptionInviteDeclineResponse.ts

@@ -1,7 +1,9 @@
+import { Either } from '@standardnotes/common'
+
 import { HttpErrorResponseBody } from '../../Http/HttpErrorResponseBody'
 import { HttpResponse } from '../../Http/HttpResponse'
 import { SubscriptionInviteDeclineResponseBody } from './SubscriptionInviteDeclineResponseBody'
 
 export interface SubscriptionInviteDeclineResponse extends HttpResponse {
-  data: SubscriptionInviteDeclineResponseBody | HttpErrorResponseBody
+  data: Either<SubscriptionInviteDeclineResponseBody, HttpErrorResponseBody>
 }

packages/api/src/Domain/Response/Subscription/SubscriptionInviteListResponse.ts

@@ -1,7 +1,9 @@
+import { Either } from '@standardnotes/common'
+
 import { HttpErrorResponseBody } from '../../Http/HttpErrorResponseBody'
 import { HttpResponse } from '../../Http/HttpResponse'
 import { SubscriptionInviteListResponseBody } from './SubscriptionInviteListResponseBody'
 
 export interface SubscriptionInviteListResponse extends HttpResponse {
-  data: SubscriptionInviteListResponseBody | HttpErrorResponseBody
+  data: Either<SubscriptionInviteListResponseBody, HttpErrorResponseBody>
 }

packages/api/src/Domain/Response/Subscription/SubscriptionInviteResponse.ts

@@ -1,7 +1,9 @@
+import { Either } from '@standardnotes/common'
+
 import { HttpErrorResponseBody } from '../../Http/HttpErrorResponseBody'
 import { HttpResponse } from '../../Http/HttpResponse'
 import { SubscriptionInviteResponseBody } from './SubscriptionInviteResponseBody'
 
 export interface SubscriptionInviteResponse extends HttpResponse {
-  data: SubscriptionInviteResponseBody | HttpErrorResponseBody
+  data: Either<SubscriptionInviteResponseBody, HttpErrorResponseBody>
 }

packages/api/src/Domain/Response/WebSocket/WebSocketConnectionTokenResponse.ts

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

packages/api/src/Domain/Response/WebSocket/WebSocketConnectionTokenResponseBody.ts

@@ -0,0 +1,3 @@
+export type WebSocketConnectionTokenResponseBody = {
+  token: string
+}

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

@@ -10,3 +10,5 @@ export * from './Subscription/SubscriptionInviteResponse'
 export * from './Subscription/SubscriptionInviteResponseBody'
 export * from './User/UserRegistrationResponse'
 export * from './User/UserRegistrationResponseBody'
+export * from './WebSocket/WebSocketConnectionTokenResponse'
+export * from './WebSocket/WebSocketConnectionTokenResponseBody'

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

@@ -0,0 +1,9 @@
+const TokenPaths = {
+  createConnectionToken: '/v1/sockets/tokens',
+}
+
+export const Paths = {
+  v1: {
+    ...TokenPaths,
+  },
+}

packages/api/src/Domain/Server/WebSocket/WebSocketServer.spec.ts

@@ -0,0 +1,27 @@
+import { HttpServiceInterface } from '../../Http'
+import { WebSocketConnectionTokenResponse } from '../../Response'
+
+import { WebSocketServer } from './WebSocketServer'
+
+describe('WebSocketServer', () => {
+  let httpService: HttpServiceInterface
+
+  const createServer = () => new WebSocketServer(httpService)
+
+  beforeEach(() => {
+    httpService = {} as jest.Mocked<HttpServiceInterface>
+    httpService.post = jest.fn().mockReturnValue({
+      data: { token: 'foobar' },
+    } as jest.Mocked<WebSocketConnectionTokenResponse>)
+  })
+
+  it('should create a websocket connection token', async () => {
+    const response = await createServer().createConnectionToken({})
+
+    expect(response).toEqual({
+      data: {
+        token: 'foobar',
+      },
+    })
+  })
+})

packages/api/src/Domain/Server/WebSocket/WebSocketServer.ts

@@ -0,0 +1,17 @@
+import { HttpServiceInterface } from '../../Http/HttpServiceInterface'
+import { WebSocketConnectionTokenRequestParams } from '../../Request/WebSocket/WebSocketConnectionTokenRequestParams'
+import { WebSocketConnectionTokenResponse } from '../../Response/WebSocket/WebSocketConnectionTokenResponse'
+import { Paths } from './Paths'
+import { WebSocketServerInterface } from './WebSocketServerInterface'
+
+export class WebSocketServer implements WebSocketServerInterface {
+  constructor(private httpService: HttpServiceInterface) {}
+
+  async createConnectionToken(
+    params: WebSocketConnectionTokenRequestParams,
+  ): Promise<WebSocketConnectionTokenResponse> {
+    const response = await this.httpService.post(Paths.v1.createConnectionToken, params)
+
+    return response as WebSocketConnectionTokenResponse
+  }
+}

packages/api/src/Domain/Server/WebSocket/WebSocketServerInterface.ts

@@ -0,0 +1,6 @@
+import { WebSocketConnectionTokenRequestParams } from '../../Request/WebSocket/WebSocketConnectionTokenRequestParams'
+import { WebSocketConnectionTokenResponse } from '../../Response/WebSocket/WebSocketConnectionTokenResponse'
+
+export interface WebSocketServerInterface {
+  createConnectionToken(params: WebSocketConnectionTokenRequestParams): Promise<WebSocketConnectionTokenResponse>
+}

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

@@ -1,3 +1,6 @@
-export * from './User/Paths'
+export * from './Subscription/SubscriptionServer'
+export * from './Subscription/SubscriptionServerInterface'
 export * from './User/UserServer'
 export * from './User/UserServerInterface'
+export * from './WebSocket/WebSocketServer'
+export * from './WebSocket/WebSocketServerInterface'