chore(release): publish new version

- @standardnotes/api-gateway@1.24.5
 - @standardnotes/auth-server@1.37.0
 - @standardnotes/common@1.35.0
 - @standardnotes/domain-events-infra@1.8.16
 - @standardnotes/domain-events@2.62.0
 - @standardnotes/event-store@1.3.21
 - @standardnotes/files-server@1.6.7
 - @standardnotes/predicates@1.4.4
 - @standardnotes/scheduler-server@1.10.35
 - @standardnotes/security@1.4.2
 - @standardnotes/syncing-server@1.8.19

.pnp.cjs

@@ -2484,16 +2484,17 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
         }]\
       ]],\
       ["@standardnotes/api", [\
-        ["npm:1.1.19", {\
-          "packageLocation": "./.yarn/cache/@standardnotes-api-npm-1.1.19-6a6d650ec9-cca168245a.zip/node_modules/@standardnotes/api/",\
+        ["npm:1.9.0", {\
+          "packageLocation": "./.yarn/cache/@standardnotes-api-npm-1.9.0-507434ff00-cc3feac393.zip/node_modules/@standardnotes/api/",\
           "packageDependencies": [\
-            ["@standardnotes/api", "npm:1.1.19"],\
-            ["@standardnotes/auth", "npm:3.19.4"],\
+            ["@standardnotes/api", "npm:1.9.0"],\
             ["@standardnotes/common", "workspace:packages/common"],\
-            ["@standardnotes/encryption", "npm:1.12.0"],\
-            ["@standardnotes/responses", "npm:1.6.39"],\
-            ["@standardnotes/services", "npm:1.15.0"],\
-            ["@standardnotes/utils", "npm:1.6.12"]\
+            ["@standardnotes/encryption", "npm:1.15.9"],\
+            ["@standardnotes/models", "npm:1.22.0"],\
+            ["@standardnotes/responses", "npm:1.10.3"],\
+            ["@standardnotes/security", "workspace:packages/security"],\
+            ["@standardnotes/utils", "npm:1.9.0"],\
+            ["reflect-metadata", "npm:0.1.13"]\
           ],\
           "linkType": "HARD"\
         }]\
@@ -2506,6 +2507,7 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
             ["@newrelic/winston-enricher", "virtual:04783e12400851b8a3d76e71495851cc94959db6e62f04cb0a31190080629440b182d8c8eb4d7f2b04e281912f2783a5fd4d2c3c6ab68d38b7097246c93f4c19#npm:4.0.0"],\
             ["@sentry/node", "npm:7.5.0"],\
             ["@standardnotes/analytics", "workspace:packages/analytics"],\
+            ["@standardnotes/common", "workspace:packages/common"],\
             ["@standardnotes/domain-events", "workspace:packages/domain-events"],\
             ["@standardnotes/domain-events-infra", "workspace:packages/domain-events-infra"],\
             ["@standardnotes/security", "workspace:packages/security"],\
@@ -2561,11 +2563,11 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
             ["@newrelic/winston-enricher", "virtual:04783e12400851b8a3d76e71495851cc94959db6e62f04cb0a31190080629440b182d8c8eb4d7f2b04e281912f2783a5fd4d2c3c6ab68d38b7097246c93f4c19#npm:4.0.0"],\
             ["@sentry/node", "npm:7.5.0"],\
             ["@standardnotes/analytics", "workspace:packages/analytics"],\
-            ["@standardnotes/api", "npm:1.1.19"],\
+            ["@standardnotes/api", "npm:1.9.0"],\
             ["@standardnotes/common", "workspace:packages/common"],\
             ["@standardnotes/domain-events", "workspace:packages/domain-events"],\
             ["@standardnotes/domain-events-infra", "workspace:packages/domain-events-infra"],\
-            ["@standardnotes/features", "npm:1.50.0"],\
+            ["@standardnotes/features", "npm:1.52.1"],\
             ["@standardnotes/predicates", "workspace:packages/predicates"],\
             ["@standardnotes/responses", "npm:1.6.39"],\
             ["@standardnotes/security", "workspace:packages/security"],\
@@ -2649,7 +2651,7 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
           "packageDependencies": [\
             ["@standardnotes/domain-events", "workspace:packages/domain-events"],\
             ["@standardnotes/common", "workspace:packages/common"],\
-            ["@standardnotes/features", "npm:1.50.0"],\
+            ["@standardnotes/features", "npm:1.52.1"],\
             ["@standardnotes/predicates", "workspace:packages/predicates"],\
             ["@standardnotes/security", "workspace:packages/security"],\
             ["@types/jest", "npm:28.1.4"],\
@@ -2686,16 +2688,15 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
         }]\
       ]],\
       ["@standardnotes/encryption", [\
-        ["npm:1.12.0", {\
-          "packageLocation": "./.yarn/cache/@standardnotes-encryption-npm-1.12.0-eb2342c675-1a28653b1e.zip/node_modules/@standardnotes/encryption/",\
+        ["npm:1.15.9", {\
+          "packageLocation": "./.yarn/cache/@standardnotes-encryption-npm-1.15.9-00c7fac9f6-7595ac08ce.zip/node_modules/@standardnotes/encryption/",\
           "packageDependencies": [\
-            ["@standardnotes/encryption", "npm:1.12.0"],\
+            ["@standardnotes/encryption", "npm:1.15.9"],\
             ["@standardnotes/common", "workspace:packages/common"],\
-            ["@standardnotes/models", "npm:1.14.0"],\
-            ["@standardnotes/responses", "npm:1.6.39"],\
-            ["@standardnotes/services", "npm:1.15.0"],\
-            ["@standardnotes/sncrypto-common", "npm:1.9.0"],\
-            ["@standardnotes/utils", "npm:1.6.12"],\
+            ["@standardnotes/models", "npm:1.22.0"],\
+            ["@standardnotes/responses", "npm:1.10.3"],\
+            ["@standardnotes/sncrypto-common", "npm:1.12.0"],\
+            ["@standardnotes/utils", "npm:1.9.0"],\
             ["reflect-metadata", "npm:0.1.13"]\
           ],\
           "linkType": "HARD"\
@@ -2741,6 +2742,17 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
             ["reflect-metadata", "npm:0.1.13"]\
           ],\
           "linkType": "HARD"\
+        }],\
+        ["npm:1.52.1", {\
+          "packageLocation": "./.yarn/cache/@standardnotes-features-npm-1.52.1-1fee85cf4e-ff3684399e.zip/node_modules/@standardnotes/features/",\
+          "packageDependencies": [\
+            ["@standardnotes/features", "npm:1.52.1"],\
+            ["@standardnotes/auth", "npm:3.19.4"],\
+            ["@standardnotes/common", "workspace:packages/common"],\
+            ["@standardnotes/security", "workspace:packages/security"],\
+            ["reflect-metadata", "npm:0.1.13"]\
+          ],\
+          "linkType": "HARD"\
         }]\
       ]],\
       ["@standardnotes/files-server", [\
@@ -2796,14 +2808,14 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
         }]\
       ]],\
       ["@standardnotes/models", [\
-        ["npm:1.14.0", {\
-          "packageLocation": "./.yarn/cache/@standardnotes-models-npm-1.14.0-6f064d99e7-bfb9d517b6.zip/node_modules/@standardnotes/models/",\
+        ["npm:1.22.0", {\
+          "packageLocation": "./.yarn/cache/@standardnotes-models-npm-1.22.0-2cc72f987b-9928246368.zip/node_modules/@standardnotes/models/",\
           "packageDependencies": [\
-            ["@standardnotes/models", "npm:1.14.0"],\
+            ["@standardnotes/models", "npm:1.22.0"],\
             ["@standardnotes/common", "workspace:packages/common"],\
-            ["@standardnotes/features", "npm:1.50.0"],\
-            ["@standardnotes/responses", "npm:1.6.39"],\
-            ["@standardnotes/utils", "npm:1.6.12"],\
+            ["@standardnotes/features", "npm:1.52.1"],\
+            ["@standardnotes/responses", "npm:1.10.3"],\
+            ["@standardnotes/utils", "npm:1.9.0"],\
             ["lodash", "npm:4.17.21"],\
             ["reflect-metadata", "npm:0.1.13"]\
           ],\
@@ -2839,6 +2851,17 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
         }]\
       ]],\
       ["@standardnotes/responses", [\
+        ["npm:1.10.3", {\
+          "packageLocation": "./.yarn/cache/@standardnotes-responses-npm-1.10.3-7cdb15f83a-4a1e31eb89.zip/node_modules/@standardnotes/responses/",\
+          "packageDependencies": [\
+            ["@standardnotes/responses", "npm:1.10.3"],\
+            ["@standardnotes/common", "workspace:packages/common"],\
+            ["@standardnotes/features", "npm:1.52.1"],\
+            ["@standardnotes/security", "workspace:packages/security"],\
+            ["reflect-metadata", "npm:0.1.13"]\
+          ],\
+          "linkType": "HARD"\
+        }],\
         ["npm:1.6.39", {\
           "packageLocation": "./.yarn/cache/@standardnotes-responses-npm-1.6.39-395f4c2d65-0ea1d4d5b8.zip/node_modules/@standardnotes/responses/",\
           "packageDependencies": [\
@@ -2931,21 +2954,6 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
           "linkType": "SOFT"\
         }]\
       ]],\
-      ["@standardnotes/services", [\
-        ["npm:1.15.0", {\
-          "packageLocation": "./.yarn/cache/@standardnotes-services-npm-1.15.0-acab3bc6a3-1028a5b4c1.zip/node_modules/@standardnotes/services/",\
-          "packageDependencies": [\
-            ["@standardnotes/services", "npm:1.15.0"],\
-            ["@standardnotes/auth", "npm:3.19.4"],\
-            ["@standardnotes/common", "workspace:packages/common"],\
-            ["@standardnotes/models", "npm:1.14.0"],\
-            ["@standardnotes/responses", "npm:1.6.39"],\
-            ["@standardnotes/utils", "npm:1.6.12"],\
-            ["reflect-metadata", "npm:0.1.13"]\
-          ],\
-          "linkType": "HARD"\
-        }]\
-      ]],\
       ["@standardnotes/settings", [\
         ["workspace:packages/settings", {\
           "packageLocation": "./packages/settings/",\
@@ -2959,6 +2967,14 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
         }]\
       ]],\
       ["@standardnotes/sncrypto-common", [\
+        ["npm:1.12.0", {\
+          "packageLocation": "./.yarn/cache/@standardnotes-sncrypto-common-npm-1.12.0-1a093ff006-b89a14bd23.zip/node_modules/@standardnotes/sncrypto-common/",\
+          "packageDependencies": [\
+            ["@standardnotes/sncrypto-common", "npm:1.12.0"],\
+            ["reflect-metadata", "npm:0.1.13"]\
+          ],\
+          "linkType": "HARD"\
+        }],\
         ["npm:1.9.0", {\
           "packageLocation": "./.yarn/cache/@standardnotes-sncrypto-common-npm-1.9.0-48773f745a-42252d7198.zip/node_modules/@standardnotes/sncrypto-common/",\
           "packageDependencies": [\
@@ -3070,6 +3086,17 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
             ["lodash", "npm:4.17.21"]\
           ],\
           "linkType": "HARD"\
+        }],\
+        ["npm:1.9.0", {\
+          "packageLocation": "./.yarn/cache/@standardnotes-utils-npm-1.9.0-da939553f6-4591aff48d.zip/node_modules/@standardnotes/utils/",\
+          "packageDependencies": [\
+            ["@standardnotes/utils", "npm:1.9.0"],\
+            ["@standardnotes/common", "workspace:packages/common"],\
+            ["dompurify", "npm:2.4.0"],\
+            ["lodash", "npm:4.17.21"],\
+            ["reflect-metadata", "npm:0.1.13"]\
+          ],\
+          "linkType": "HARD"\
         }]\
       ]],\
       ["@szmarczak/http-timer", [\
@@ -5843,6 +5870,13 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
             ["dompurify", "npm:2.3.8"]\
           ],\
           "linkType": "HARD"\
+        }],\
+        ["npm:2.4.0", {\
+          "packageLocation": "./.yarn/cache/dompurify-npm-2.4.0-0ffecf22ef-c93ea73cf8.zip/node_modules/dompurify/",\
+          "packageDependencies": [\
+            ["dompurify", "npm:2.4.0"]\
+          ],\
+          "linkType": "HARD"\
         }]\
       ]],\
       ["dot-prop", [\

packages/analytics/CHANGELOG.md

@@ -3,6 +3,90 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.34.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@1.33.0...@standardnotes/analytics@1.34.0) (2022-10-04)
+
+### Features
+
+* **analytics:** add new statistics measures for income ([19455ba](https://github.com/standardnotes/server/commit/19455ba6a7d84a389830c728c3dfea550b156985))
+
+# [1.33.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@1.32.0...@standardnotes/analytics@1.33.0) (2022-10-03)
+
+### Features
+
+* add calculating monthly churn rate ([f075cd8](https://github.com/standardnotes/server/commit/f075cd8c4dfc411ba513dfec21bb84c03b238254))
+
+# [1.32.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@1.31.1...@standardnotes/analytics@1.32.0) (2022-09-30)
+
+### Features
+
+* **auth:** add tracking total customers count ([8a98f74](https://github.com/standardnotes/server/commit/8a98f746eb13c25f7940286aca594e2304232bdf))
+
+## [1.31.1](https://github.com/standardnotes/server/compare/@standardnotes/analytics@1.31.0...@standardnotes/analytics@1.31.1) (2022-09-30)
+
+### Bug Fixes
+
+* **auth:** fix calculating new and existing customers churn ([82bb851](https://github.com/standardnotes/server/commit/82bb85174d94a5e03f364604a1c07a9b1633920d))
+
+# [1.31.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@1.30.0...@standardnotes/analytics@1.31.0) (2022-09-30)
+
+### Features
+
+* **auth:** add measuring new customers ([b6118c1](https://github.com/standardnotes/server/commit/b6118c17e176ba0acc93b95a38e32748ac851410))
+
+# [1.30.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@1.29.1...@standardnotes/analytics@1.30.0) (2022-09-30)
+
+### Features
+
+* **auth:** add tracking churn activity ([39337c1](https://github.com/standardnotes/server/commit/39337c1c4f799f39672eeb8c9d050e7cbb19878a))
+
+## [1.29.1](https://github.com/standardnotes/server/compare/@standardnotes/analytics@1.29.0...@standardnotes/analytics@1.29.1) (2022-09-16)
+
+### Bug Fixes
+
+* **auth:** change remaining subscription time stats to percentage ([5eb957c](https://github.com/standardnotes/server/commit/5eb957c82a8cc5fdcb6815e2cd30e49cd2b1e8ac))
+
+# [1.29.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@1.28.0...@standardnotes/analytics@1.29.0) (2022-09-15)
+
+### Features
+
+* **auth:** add remaining subscription time stats ([a59ba08](https://github.com/standardnotes/server/commit/a59ba083397c75960af0e8a102b617bf5baa287f))
+
+# [1.28.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@1.27.0...@standardnotes/analytics@1.28.0) (2022-09-09)
+
+### Features
+
+* **syncing-server:** add tracking files count in stats ([52cc646](https://github.com/standardnotes/server/commit/52cc6462a66dae3bd6c05f551d4ba661c8a9b8c8))
+
+# [1.27.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@1.26.0...@standardnotes/analytics@1.27.0) (2022-09-09)
+
+### Features
+
+* **api-gateway:** add tracking general activity for free and paid users breakdown ([0afd3de](https://github.com/standardnotes/server/commit/0afd3de9779e2abe10deede24626a3cbe6b15e6c))
+
+# [1.26.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@1.25.0...@standardnotes/analytics@1.26.0) (2022-09-09)
+
+### Features
+
+* **syncing-server:** add statistics for notes count for free and paid users ([c9ec7b4](https://github.com/standardnotes/server/commit/c9ec7b492aea1911e441ed8ad9a155f871be2ef7))
+
+# [1.25.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@1.24.0...@standardnotes/analytics@1.25.0) (2022-09-07)
+
+### Features
+
+* **analytics:** add discrete period key generation for last 7 days ([f872c7d](https://github.com/standardnotes/server/commit/f872c7dfe9f120f40dd0c28a9e0f5749eb251643))
+
+# [1.24.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@1.23.0...@standardnotes/analytics@1.24.0) (2022-09-07)
+
+### Features
+
+* **analytics:** add calculation retention for two activities ([7132dc3](https://github.com/standardnotes/server/commit/7132dc3ac0cf878d2c326243747343e8a6746e2f))
+
+# [1.23.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@1.22.0...@standardnotes/analytics@1.23.0) (2022-09-07)
+
+### Features
+
+* **auth:** add measuring registration to subscription time statistics ([b618252](https://github.com/standardnotes/server/commit/b61825235eebaf5eddb55cbda173176ca43c0099))
+
 # [1.22.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@1.21.1...@standardnotes/analytics@1.22.0) (2022-09-06)
 
 ### Features

packages/analytics/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/analytics",
-  "version": "1.22.0",
+  "version": "1.34.0",
   "engines": {
     "node": ">=14.0.0 <17.0.0"
   },

packages/analytics/src/Domain/Analytics/AnalyticsActivity.ts

@@ -1,6 +1,9 @@
 export enum AnalyticsActivity {
   GeneralActivity = 'general-activity',
+  GeneralActivityFreeUsers = 'general-activity-free-users',
+  GeneralActivityPaidUsers = 'general-activity-paid-users',
   EditingItems = 'editing-items',
+  CheckingIntegrity = 'checking-integrity',
   Login = 'login',
   Register = 'register',
   DeleteAccount = 'DeleteAccount',
@@ -8,9 +11,12 @@ export enum AnalyticsActivity {
   SubscriptionRenewed = 'subscription-renewed',
   SubscriptionRefunded = 'subscription-refunded',
   SubscriptionCancelled = 'subscription-cancelled',
+  SubscriptionExpired = 'subscription-expired',
   EmailUnbackedUpData = 'email-unbacked-up-data',
   EmailBackup = 'email-backup',
   LimitedDiscountOfferPurchased = 'limited-discount-offer-purchased',
   PaymentFailed = 'payment-failed',
   PaymentSuccess = 'payment-success',
+  NewCustomersChurn = 'new-customers-churn',
+  ExistingCustomersChurn = 'existing-customers-churn',
 }

packages/analytics/src/Domain/Analytics/AnalyticsStoreInterface.ts

@@ -6,7 +6,13 @@ export interface AnalyticsStoreInterface {
   markActivity(activities: AnalyticsActivity[], analyticsId: number, periods: Period[]): Promise<void>
   wasActivityDone(activity: AnalyticsActivity, analyticsId: number, period: Period): Promise<boolean>
   calculateActivityRetention(activity: AnalyticsActivity, firstPeriod: Period, secondPeriod: Period): Promise<number>
-  calculateActivityTotalCount(activity: AnalyticsActivity, period: Period): Promise<number>
+  calculateActivitiesRetention(parameters: {
+    firstActivity: AnalyticsActivity
+    firstActivityPeriodKey: string
+    secondActivity: AnalyticsActivity
+    secondActivityPeriodKey: string
+  }): Promise<number>
+  calculateActivityTotalCount(activity: AnalyticsActivity, periodOrPeriodKey: Period | string): Promise<number>
   calculateActivityChangesTotalCount(
     activity: AnalyticsActivity,
     period: Period,

packages/analytics/src/Domain/Statistics/StatisticsMeasure.ts

@@ -1,6 +1,21 @@
 export enum StatisticsMeasure {
   Income = 'income',
+  PlusSubscriptionInitialMonthlyPaymentsIncome = 'plus-subscription-initial-monthly-payments-income',
+  ProSubscriptionInitialMonthlyPaymentsIncome = 'pro-subscription-initial-monthly-payments-income',
+  PlusSubscriptionInitialAnnualPaymentsIncome = 'plus-subscription-initial-annual-payments-income',
+  ProSubscriptionInitialAnnualPaymentsIncome = 'pro-subscription-initial-annual-payments-income',
+  PlusSubscriptionRenewingMonthlyPaymentsIncome = 'plus-subscription-renewing-monthly-payments-income',
+  ProSubscriptionRenewingMonthlyPaymentsIncome = 'pro-subscription-renewing-monthly-payments-income',
+  PlusSubscriptionRenewingAnnualPaymentsIncome = 'plus-subscription-renewing-annual-payments-income',
+  ProSubscriptionRenewingAnnualPaymentsIncome = 'pro-subscription-renewing-annual-payments-income',
   SubscriptionLength = 'subscription-length',
   RegistrationLength = 'registration-length',
+  RegistrationToSubscriptionTime = 'registration-to-subscription-time',
+  RemainingSubscriptionTimePercentage = 'remaining-subscription-time-percentage',
   Refunds = 'refunds',
+  NotesCountFreeUsers = 'notes-count-free-users',
+  NotesCountPaidUsers = 'notes-count-paid-users',
+  FilesCount = 'files-count',
+  NewCustomers = 'new-customers',
+  TotalCustomers = 'total-customers',
 }

packages/analytics/src/Domain/Statistics/StatisticsStoreInterface.ts

@@ -9,6 +9,7 @@ export interface StatisticsStoreInterface {
   getYesterdayApplicationUsage(): Promise<Array<{ version: string; count: number }>>
   getYesterdayOutOfSyncIncidents(): Promise<number>
   incrementMeasure(measure: StatisticsMeasure, value: number, periods: Period[]): Promise<void>
+  setMeasure(measure: StatisticsMeasure, value: number, periods: Period[]): Promise<void>
   getMeasureAverage(measure: StatisticsMeasure, period: Period): Promise<number>
-  getMeasureTotal(measure: StatisticsMeasure, period: Period): Promise<number>
+  getMeasureTotal(measure: StatisticsMeasure, periodOrPeriodKey: Period | string): Promise<number>
 }

packages/analytics/src/Domain/Time/Period.ts

@@ -7,9 +7,23 @@ export enum Period {
   WeekBeforeLastWeek,
   ThisMonth,
   LastMonth,
+  ThisYear,
   Last30Days,
+  Last7Days,
   Q1ThisYear,
   Q2ThisYear,
   Q3ThisYear,
   Q4ThisYear,
+  JanuaryThisYear,
+  FebruaryThisYear,
+  MarchThisYear,
+  AprilThisYear,
+  MayThisYear,
+  JuneThisYear,
+  JulyThisYear,
+  AugustThisYear,
+  SeptemberThisYear,
+  OctoberThisYear,
+  NovemberThisYear,
+  DecemberThisYear,
 }

packages/analytics/src/Domain/Time/PeriodKeyGenerator.spec.ts

@@ -3,6 +3,20 @@ import { PeriodKeyGenerator } from './PeriodKeyGenerator'
 
 describe('PeriodKeyGenerator', () => {
   const createGenerator = () => new PeriodKeyGenerator()
+  const months = [
+    Period.JanuaryThisYear,
+    Period.FebruaryThisYear,
+    Period.MarchThisYear,
+    Period.AprilThisYear,
+    Period.MayThisYear,
+    Period.JuneThisYear,
+    Period.JulyThisYear,
+    Period.AugustThisYear,
+    Period.SeptemberThisYear,
+    Period.OctoberThisYear,
+    Period.NovemberThisYear,
+    Period.DecemberThisYear,
+  ]
 
   beforeEach(() => {
     jest.useFakeTimers()
@@ -48,6 +62,110 @@ describe('PeriodKeyGenerator', () => {
     ])
   })
 
+  it('should generate period keys for this year', () => {
+    expect(createGenerator().getDiscretePeriodKeys(Period.ThisYear)).toEqual([
+      '2022-1',
+      '2022-2',
+      '2022-3',
+      '2022-4',
+      '2022-5',
+      '2022-6',
+      '2022-7',
+      '2022-8',
+      '2022-9',
+      '2022-10',
+      '2022-11',
+      '2022-12',
+    ])
+  })
+
+  it('should generate period keys for last 7 days', () => {
+    expect(createGenerator().getDiscretePeriodKeys(Period.Last7Days)).toEqual([
+      '2022-5-17',
+      '2022-5-18',
+      '2022-5-19',
+      '2022-5-20',
+      '2022-5-21',
+      '2022-5-22',
+      '2022-5-23',
+    ])
+  })
+
+  it('should generate period keys for this month', () => {
+    expect(createGenerator().getDiscretePeriodKeys(Period.ThisMonth)).toEqual([
+      '2022-5-1',
+      '2022-5-2',
+      '2022-5-3',
+      '2022-5-4',
+      '2022-5-5',
+      '2022-5-6',
+      '2022-5-7',
+      '2022-5-8',
+      '2022-5-9',
+      '2022-5-10',
+      '2022-5-11',
+      '2022-5-12',
+      '2022-5-13',
+      '2022-5-14',
+      '2022-5-15',
+      '2022-5-16',
+      '2022-5-17',
+      '2022-5-18',
+      '2022-5-19',
+      '2022-5-20',
+      '2022-5-21',
+      '2022-5-22',
+      '2022-5-23',
+      '2022-5-24',
+      '2022-5-25',
+      '2022-5-26',
+      '2022-5-27',
+      '2022-5-28',
+      '2022-5-29',
+      '2022-5-30',
+      '2022-5-31',
+    ])
+  })
+
+  it('should generate period keys for specific month', () => {
+    expect(createGenerator().getDiscretePeriodKeys(Period.FebruaryThisYear)).toEqual([
+      '2022-2-1',
+      '2022-2-2',
+      '2022-2-3',
+      '2022-2-4',
+      '2022-2-5',
+      '2022-2-6',
+      '2022-2-7',
+      '2022-2-8',
+      '2022-2-9',
+      '2022-2-10',
+      '2022-2-11',
+      '2022-2-12',
+      '2022-2-13',
+      '2022-2-14',
+      '2022-2-15',
+      '2022-2-16',
+      '2022-2-17',
+      '2022-2-18',
+      '2022-2-19',
+      '2022-2-20',
+      '2022-2-21',
+      '2022-2-22',
+      '2022-2-23',
+      '2022-2-24',
+      '2022-2-25',
+      '2022-2-26',
+      '2022-2-27',
+      '2022-2-28',
+    ])
+  })
+
+  it('should generate period keys for specific months', () => {
+    for (const month of months) {
+      expect(createGenerator().getDiscretePeriodKeys(month).length >= 28).toBeTruthy()
+    }
+  })
+
   it('should generate period keys for Q1', () => {
     expect(createGenerator().getDiscretePeriodKeys(Period.Q1ThisYear)).toEqual(['2022-1', '2022-2', '2022-3'])
   })
@@ -64,6 +182,10 @@ describe('PeriodKeyGenerator', () => {
     expect(createGenerator().getDiscretePeriodKeys(Period.Q4ThisYear)).toEqual(['2022-10', '2022-11', '2022-12'])
   })
 
+  it('should generate a period key for this year', () => {
+    expect(createGenerator().getPeriodKey(Period.ThisYear)).toEqual('2022')
+  })
+
   it('should generate a period key for today', () => {
     expect(createGenerator().getPeriodKey(Period.Today)).toEqual('2022-5-24')
   })
@@ -92,6 +214,12 @@ describe('PeriodKeyGenerator', () => {
     expect(createGenerator().getPeriodKey(Period.ThisMonth)).toEqual('2022-5')
   })
 
+  it('should generate a period key for each month', () => {
+    for (let i = 0; i < months.length; i++) {
+      expect(createGenerator().getPeriodKey(months[i])).toEqual(`2022-${i + 1}`)
+    }
+  })
+
   it('should generate a period key for last month', () => {
     expect(createGenerator().getPeriodKey(Period.LastMonth)).toEqual('2022-4')
   })
@@ -117,4 +245,19 @@ describe('PeriodKeyGenerator', () => {
 
     expect(error).not.toBeNull()
   })
+
+  it('should convert period key to period', () => {
+    expect(createGenerator().convertPeriodKeyToPeriod('2022-1')).toEqual(Period.JanuaryThisYear)
+    expect(createGenerator().convertPeriodKeyToPeriod('2022-2')).toEqual(Period.FebruaryThisYear)
+    expect(createGenerator().convertPeriodKeyToPeriod('2022-3')).toEqual(Period.MarchThisYear)
+    expect(createGenerator().convertPeriodKeyToPeriod('2022-4')).toEqual(Period.AprilThisYear)
+    expect(createGenerator().convertPeriodKeyToPeriod('2022-5')).toEqual(Period.MayThisYear)
+    expect(createGenerator().convertPeriodKeyToPeriod('2022-6')).toEqual(Period.JuneThisYear)
+    expect(createGenerator().convertPeriodKeyToPeriod('2022-7')).toEqual(Period.JulyThisYear)
+    expect(createGenerator().convertPeriodKeyToPeriod('2022-8')).toEqual(Period.AugustThisYear)
+    expect(createGenerator().convertPeriodKeyToPeriod('2022-9')).toEqual(Period.SeptemberThisYear)
+    expect(createGenerator().convertPeriodKeyToPeriod('2022-10')).toEqual(Period.OctoberThisYear)
+    expect(createGenerator().convertPeriodKeyToPeriod('2022-11')).toEqual(Period.NovemberThisYear)
+    expect(createGenerator().convertPeriodKeyToPeriod('2022-12')).toEqual(Period.DecemberThisYear)
+  })
 })

packages/analytics/src/Domain/Time/PeriodKeyGenerator.ts

@@ -2,6 +2,28 @@ import { Period } from './Period'
 import { PeriodKeyGeneratorInterface } from './PeriodKeyGeneratorInterface'
 
 export class PeriodKeyGenerator implements PeriodKeyGeneratorInterface {
+  private readonly MONTHS = [
+    Period.JanuaryThisYear,
+    Period.FebruaryThisYear,
+    Period.MarchThisYear,
+    Period.AprilThisYear,
+    Period.MayThisYear,
+    Period.JuneThisYear,
+    Period.JulyThisYear,
+    Period.AugustThisYear,
+    Period.SeptemberThisYear,
+    Period.OctoberThisYear,
+    Period.NovemberThisYear,
+    Period.DecemberThisYear,
+  ]
+
+  convertPeriodKeyToPeriod(periodKey: string): Period {
+    const date = new Date(periodKey)
+    const month = this.getMonth(date)
+
+    return this.MONTHS[+month - 1]
+  }
+
   getDiscretePeriodKeys(period: Period): string[] {
     const periodKeys = []
 
@@ -11,6 +33,12 @@ export class PeriodKeyGenerator implements PeriodKeyGeneratorInterface {
           periodKeys.unshift(this.getDailyKey(this.getDateNDaysBefore(i)))
         }
 
+        return periodKeys
+      case Period.Last7Days:
+        for (let i = 1; i <= 7; i++) {
+          periodKeys.unshift(this.getDailyKey(this.getDateNDaysBefore(i)))
+        }
+
         return periodKeys
       case Period.Q1ThisYear:
         return this.generateMonthlyKeysRange(0, 3)
@@ -20,6 +48,23 @@ export class PeriodKeyGenerator implements PeriodKeyGeneratorInterface {
         return this.generateMonthlyKeysRange(6, 9)
       case Period.Q4ThisYear:
         return this.generateMonthlyKeysRange(9, 12)
+      case Period.ThisYear:
+        return this.generateMonthlyKeysRange(0, 12)
+      case Period.ThisMonth:
+        return this.generateDailyKeysRange()
+      case Period.JanuaryThisYear:
+      case Period.FebruaryThisYear:
+      case Period.MarchThisYear:
+      case Period.AprilThisYear:
+      case Period.MayThisYear:
+      case Period.JuneThisYear:
+      case Period.JulyThisYear:
+      case Period.AugustThisYear:
+      case Period.SeptemberThisYear:
+      case Period.OctoberThisYear:
+      case Period.NovemberThisYear:
+      case Period.DecemberThisYear:
+        return this.generateDailyKeysRange(period - 15)
       default:
         throw new Error(`Unsuporrted period: ${period}`)
     }
@@ -43,11 +88,43 @@ export class PeriodKeyGenerator implements PeriodKeyGeneratorInterface {
         return this.getMonthlyKey()
       case Period.LastMonth:
         return this.getMonthlyKey(this.getLastMonthDate())
+      case Period.ThisYear:
+        return this.getYearlyKey()
+      case Period.JanuaryThisYear:
+        return this.generateMonthlyKeysRange(0, 1)[0]
+      case Period.FebruaryThisYear:
+        return this.generateMonthlyKeysRange(1, 2)[0]
+      case Period.MarchThisYear:
+        return this.generateMonthlyKeysRange(2, 3)[0]
+      case Period.AprilThisYear:
+        return this.generateMonthlyKeysRange(3, 4)[0]
+      case Period.MayThisYear:
+        return this.generateMonthlyKeysRange(4, 5)[0]
+      case Period.JuneThisYear:
+        return this.generateMonthlyKeysRange(5, 6)[0]
+      case Period.JulyThisYear:
+        return this.generateMonthlyKeysRange(6, 7)[0]
+      case Period.AugustThisYear:
+        return this.generateMonthlyKeysRange(7, 8)[0]
+      case Period.SeptemberThisYear:
+        return this.generateMonthlyKeysRange(8, 9)[0]
+      case Period.OctoberThisYear:
+        return this.generateMonthlyKeysRange(9, 10)[0]
+      case Period.NovemberThisYear:
+        return this.generateMonthlyKeysRange(10, 11)[0]
+      case Period.DecemberThisYear:
+        return this.generateMonthlyKeysRange(11, 12)[0]
       default:
         throw new Error(`Unsuporrted period: ${period}`)
     }
   }
 
+  private getYearlyKey(date?: Date): string {
+    date = date ?? new Date()
+
+    return this.getYear(date)
+  }
+
   private getMonthlyKey(date?: Date): string {
     date = date ?? new Date()
 
@@ -135,4 +212,22 @@ export class PeriodKeyGenerator implements PeriodKeyGeneratorInterface {
 
     return keys
   }
+
+  private generateDailyKeysRange(month?: number): string[] {
+    const today = new Date()
+    if (month) {
+      today.setMonth(month)
+    }
+    const numberOfDays = new Date(today.getFullYear(), today.getMonth() + 1, 0).getDate()
+
+    const keys = []
+    for (let i = 1; i <= numberOfDays; i++) {
+      const date = new Date()
+      date.setMonth(today.getMonth())
+      date.setDate(i)
+      keys.push(this.getDailyKey(date))
+    }
+
+    return keys
+  }
 }

packages/analytics/src/Domain/Time/PeriodKeyGeneratorInterface.ts

@@ -2,5 +2,6 @@ import { Period } from './Period'
 
 export interface PeriodKeyGeneratorInterface {
   getPeriodKey(period: Period): string
+  convertPeriodKeyToPeriod(periodKey: string): Period
   getDiscretePeriodKeys(period: Period): string[]
 }

packages/analytics/src/Infra/Redis/RedisAnalyticsStore.spec.ts

@@ -102,7 +102,7 @@ describe('RedisAnalyticsStore', () => {
     expect(caughtError).not.toBeNull()
   })
 
-  it('should calculate total count of activities', async () => {
+  it('should calculate total count of activities by period', async () => {
     redisClient.bitcount = jest.fn().mockReturnValue(70)
 
     expect(await createStore().calculateActivityTotalCount(AnalyticsActivity.EditingItems, Period.Yesterday)).toEqual(
@@ -112,6 +112,14 @@ describe('RedisAnalyticsStore', () => {
     expect(redisClient.bitcount).toHaveBeenCalledWith('bitmap:action:editing-items:timespan:period-key')
   })
 
+  it('should calculate total count of activities by period key', async () => {
+    redisClient.bitcount = jest.fn().mockReturnValue(70)
+
+    expect(await createStore().calculateActivityTotalCount(AnalyticsActivity.EditingItems, '2022-10-03')).toEqual(70)
+
+    expect(redisClient.bitcount).toHaveBeenCalledWith('bitmap:action:editing-items:timespan:2022-10-03')
+  })
+
   it('should calculate activity retention', async () => {
     redisClient.bitcount = jest.fn().mockReturnValueOnce(7).mockReturnValueOnce(10)
 
@@ -125,7 +133,7 @@ describe('RedisAnalyticsStore', () => {
 
     expect(redisClient.bitop).toHaveBeenCalledWith(
       'AND',
-      'bitmap:action:editing-items:timespan:period-key-period-key',
+      'bitmap:action:editing-items-editing-items:timespan:period-key',
       'bitmap:action:editing-items:timespan:period-key',
       'bitmap:action:editing-items:timespan:period-key',
     )

packages/analytics/src/Infra/Redis/RedisAnalyticsStore.ts

@@ -95,21 +95,19 @@ export class RedisAnalyticsStore implements AnalyticsStoreInterface {
     return bitValue === 1
   }
 
-  async calculateActivityRetention(
-    activity: AnalyticsActivity,
-    firstPeriod: Period,
-    secondPeriod: Period,
-  ): Promise<number> {
-    const initialPeriodKey = this.periodKeyGenerator.getPeriodKey(firstPeriod)
-    const subsequentPeriodKey = this.periodKeyGenerator.getPeriodKey(secondPeriod)
-
-    const diffKey = `bitmap:action:${activity}:timespan:${initialPeriodKey}-${subsequentPeriodKey}`
+  async calculateActivitiesRetention(parameters: {
+    firstActivity: AnalyticsActivity
+    firstActivityPeriodKey: string
+    secondActivity: AnalyticsActivity
+    secondActivityPeriodKey: string
+  }): Promise<number> {
+    const diffKey = `bitmap:action:${parameters.firstActivity}-${parameters.secondActivity}:timespan:${parameters.secondActivityPeriodKey}`
 
     await this.redisClient.bitop(
       'AND',
       diffKey,
-      `bitmap:action:${activity}:timespan:${initialPeriodKey}`,
-      `bitmap:action:${activity}:timespan:${subsequentPeriodKey}`,
+      `bitmap:action:${parameters.firstActivity}:timespan:${parameters.firstActivityPeriodKey}`,
+      `bitmap:action:${parameters.secondActivity}:timespan:${parameters.secondActivityPeriodKey}`,
     )
 
     await this.redisClient.expire(diffKey, 3600)
@@ -117,15 +115,31 @@ export class RedisAnalyticsStore implements AnalyticsStoreInterface {
     const retainedTotalInActivity = await this.redisClient.bitcount(diffKey)
 
     const initialTotalInActivity = await this.redisClient.bitcount(
-      `bitmap:action:${activity}:timespan:${initialPeriodKey}`,
+      `bitmap:action:${parameters.firstActivity}:timespan:${parameters.firstActivityPeriodKey}`,
     )
 
     return Math.ceil((retainedTotalInActivity * 100) / initialTotalInActivity)
   }
 
-  async calculateActivityTotalCount(activity: AnalyticsActivity, period: Period): Promise<number> {
-    return this.redisClient.bitcount(
-      `bitmap:action:${activity}:timespan:${this.periodKeyGenerator.getPeriodKey(period)}`,
-    )
+  async calculateActivityRetention(
+    activity: AnalyticsActivity,
+    firstPeriod: Period,
+    secondPeriod: Period,
+  ): Promise<number> {
+    return this.calculateActivitiesRetention({
+      firstActivity: activity,
+      firstActivityPeriodKey: this.periodKeyGenerator.getPeriodKey(firstPeriod),
+      secondActivity: activity,
+      secondActivityPeriodKey: this.periodKeyGenerator.getPeriodKey(secondPeriod),
+    })
+  }
+
+  async calculateActivityTotalCount(activity: AnalyticsActivity, periodOrPeriodKey: Period | string): Promise<number> {
+    let periodKey = periodOrPeriodKey
+    if (!isNaN(+periodOrPeriodKey)) {
+      periodKey = this.periodKeyGenerator.getPeriodKey(periodOrPeriodKey as Period)
+    }
+
+    return this.redisClient.bitcount(`bitmap:action:${activity}:timespan:${periodKey}`)
   }
 }

packages/analytics/src/Infra/Redis/RedisStatisticsStore.spec.ts

@@ -16,6 +16,7 @@ describe('RedisStatisticsStore', () => {
     pipeline = {} as jest.Mocked<IORedis.Pipeline>
     pipeline.incr = jest.fn()
     pipeline.incrbyfloat = jest.fn()
+    pipeline.set = jest.fn()
     pipeline.setbit = jest.fn()
     pipeline.exec = jest.fn()
 
@@ -92,8 +93,15 @@ describe('RedisStatisticsStore', () => {
     expect(pipeline.exec).toHaveBeenCalled()
   })
 
+  it('should set a value to a measure', async () => {
+    await createStore().setMeasure(StatisticsMeasure.Income, 2, [Period.Today, Period.ThisMonth])
+
+    expect(pipeline.set).toHaveBeenCalledTimes(2)
+    expect(pipeline.exec).toHaveBeenCalled()
+  })
+
   it('should increment measure by a value', async () => {
-    await createStore().incrementMeasure(StatisticsMeasure.PaymentSuccess, 2, [Period.Today, Period.ThisMonth])
+    await createStore().incrementMeasure(StatisticsMeasure.Income, 2, [Period.Today, Period.ThisMonth])
 
     expect(pipeline.incr).toHaveBeenCalledTimes(2)
     expect(pipeline.incrbyfloat).toHaveBeenCalledTimes(2)
@@ -103,18 +111,34 @@ describe('RedisStatisticsStore', () => {
   it('should count a measurement average', async () => {
     redisClient.get = jest.fn().mockReturnValueOnce('5').mockReturnValueOnce('2')
 
-    expect(await createStore().getMeasureAverage(StatisticsMeasure.PaymentSuccess, Period.Today)).toEqual(2 / 5)
+    expect(await createStore().getMeasureAverage(StatisticsMeasure.Income, Period.Today)).toEqual(2 / 5)
   })
 
   it('should count a measurement average - 0 increments', async () => {
     redisClient.get = jest.fn().mockReturnValueOnce(null).mockReturnValueOnce(null)
 
-    expect(await createStore().getMeasureAverage(StatisticsMeasure.PaymentSuccess, Period.Today)).toEqual(0)
+    expect(await createStore().getMeasureAverage(StatisticsMeasure.Income, Period.Today)).toEqual(0)
   })
 
   it('should count a measurement average - 0 total value', async () => {
     redisClient.get = jest.fn().mockReturnValueOnce(5).mockReturnValueOnce(null)
 
-    expect(await createStore().getMeasureAverage(StatisticsMeasure.PaymentSuccess, Period.Today)).toEqual(0)
+    expect(await createStore().getMeasureAverage(StatisticsMeasure.Income, Period.Today)).toEqual(0)
+  })
+
+  it('should retrieve a measurement total for period', async () => {
+    redisClient.get = jest.fn().mockReturnValueOnce(5)
+
+    expect(await createStore().getMeasureTotal(StatisticsMeasure.Income, Period.Today)).toEqual(5)
+
+    expect(redisClient.get).toHaveBeenCalledWith('count:measure:income:timespan:period-key')
+  })
+
+  it('should retrieve a measurement total for period key', async () => {
+    redisClient.get = jest.fn().mockReturnValueOnce(5)
+
+    expect(await createStore().getMeasureTotal(StatisticsMeasure.Income, '2022-10-03')).toEqual(5)
+
+    expect(redisClient.get).toHaveBeenCalledWith('count:measure:income:timespan:2022-10-03')
   })
 })

packages/analytics/src/Infra/Redis/RedisStatisticsStore.ts

@@ -8,10 +8,23 @@ import { StatisticsStoreInterface } from '../../Domain/Statistics/StatisticsStor
 export class RedisStatisticsStore implements StatisticsStoreInterface {
   constructor(private periodKeyGenerator: PeriodKeyGeneratorInterface, private redisClient: IORedis.Redis) {}
 
-  async getMeasureTotal(measure: StatisticsMeasure, period: Period): Promise<number> {
-    const totalValue = await this.redisClient.get(
-      `count:measure:${measure}:timespan:${this.periodKeyGenerator.getPeriodKey(period)}`,
-    )
+  async setMeasure(measure: StatisticsMeasure, value: number, periods: Period[]): Promise<void> {
+    const pipeline = this.redisClient.pipeline()
+
+    for (const period of periods) {
+      pipeline.set(`count:measure:${measure}:timespan:${this.periodKeyGenerator.getPeriodKey(period)}`, value)
+    }
+
+    await pipeline.exec()
+  }
+
+  async getMeasureTotal(measure: StatisticsMeasure, periodOrPeriodKey: Period | string): Promise<number> {
+    let periodKey = periodOrPeriodKey
+    if (!isNaN(+periodOrPeriodKey)) {
+      periodKey = this.periodKeyGenerator.getPeriodKey(periodOrPeriodKey as Period)
+    }
+
+    const totalValue = await this.redisClient.get(`count:measure:${measure}:timespan:${periodKey}`)
 
     if (totalValue === null) {
       return 0

packages/api-gateway/CHANGELOG.md

@@ -3,6 +3,201 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.24.5](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.24.4...@standardnotes/api-gateway@1.24.5) (2022-10-04)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.24.4](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.24.3...@standardnotes/api-gateway@1.24.4) (2022-10-04)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.24.3](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.24.2...@standardnotes/api-gateway@1.24.3) (2022-10-04)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.24.2](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.24.1...@standardnotes/api-gateway@1.24.2) (2022-10-03)
+
+### Bug Fixes
+
+* **api-gateway:** report churn values for empty months ([f43fbf1](https://github.com/standardnotes/api-gateway/commit/f43fbf15844be05add905134dfb3e8ca90f78458))
+
+## [1.24.1](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.24.0...@standardnotes/api-gateway@1.24.1) (2022-10-03)
+
+### Bug Fixes
+
+* add debug logs for churn calculation ([2236cc3](https://github.com/standardnotes/api-gateway/commit/2236cc3828167e4b94defbde2691bba38458bd1c))
+
+# [1.24.0](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.23.0...@standardnotes/api-gateway@1.24.0) (2022-10-03)
+
+### Features
+
+* add calculating monthly churn rate ([f075cd8](https://github.com/standardnotes/api-gateway/commit/f075cd8c4dfc411ba513dfec21bb84c03b238254))
+
+# [1.23.0](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.22.6...@standardnotes/api-gateway@1.23.0) (2022-09-30)
+
+### Features
+
+* **api-gateway:** add churn metrics to the report ([dfab849](https://github.com/standardnotes/api-gateway/commit/dfab849f48ab782c3cd2e97f52fdb72b7143002f))
+
+## [1.22.6](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.22.5...@standardnotes/api-gateway@1.22.6) (2022-09-30)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.22.5](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.22.4...@standardnotes/api-gateway@1.22.5) (2022-09-30)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.22.4](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.22.3...@standardnotes/api-gateway@1.22.4) (2022-09-30)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.22.3](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.22.2...@standardnotes/api-gateway@1.22.3) (2022-09-30)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.22.2](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.22.1...@standardnotes/api-gateway@1.22.2) (2022-09-28)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.22.1](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.22.0...@standardnotes/api-gateway@1.22.1) (2022-09-27)
+
+### Bug Fixes
+
+* **api-gateway:** remove admin graphql endpoint from being publicly available ([0a90d98](https://github.com/standardnotes/api-gateway/commit/0a90d98c71c6023b700f852c91aedfe1ad23af55))
+
+# [1.22.0](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.21.1...@standardnotes/api-gateway@1.22.0) (2022-09-22)
+
+### Features
+
+* **auth:** remove muting emails by use case in favor of updating user settings ([d3f36c0](https://github.com/standardnotes/api-gateway/commit/d3f36c05dfc114098a6c231d81149ebd1a959b74))
+
+## [1.21.1](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.21.0...@standardnotes/api-gateway@1.21.1) (2022-09-21)
+
+### Bug Fixes
+
+* **api-gateway:** web socket connection routing ([d35de38](https://github.com/standardnotes/api-gateway/commit/d35de38289e70d707d57a859b8bf39833fa825dd))
+
+# [1.21.0](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.20.0...@standardnotes/api-gateway@1.21.0) (2022-09-21)
+
+### Features
+
+* **auth:** add creating cross service token in exchange for web socket connection token ([965ae79](https://github.com/standardnotes/api-gateway/commit/965ae79414e25d0959f67e16dcbb054229013e1c))
+
+# [1.20.0](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.19.6...@standardnotes/api-gateway@1.20.0) (2022-09-21)
+
+### Features
+
+* **auth:** add creating web socket connection tokens ([8033177](https://github.com/standardnotes/api-gateway/commit/8033177f48dc961194f24fb7daa1073b8b697b74))
+
+## [1.19.6](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.19.5...@standardnotes/api-gateway@1.19.6) (2022-09-19)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.19.5](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.19.4...@standardnotes/api-gateway@1.19.5) (2022-09-16)
+
+### Bug Fixes
+
+* **auth:** change remaining subscription time stats to percentage ([5eb957c](https://github.com/standardnotes/api-gateway/commit/5eb957c82a8cc5fdcb6815e2cd30e49cd2b1e8ac))
+
+## [1.19.4](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.19.3...@standardnotes/api-gateway@1.19.4) (2022-09-16)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.19.3](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.19.2...@standardnotes/api-gateway@1.19.3) (2022-09-15)
+
+### Bug Fixes
+
+* **api-gateway:** add remaining subscription time to stats ([89334c9](https://github.com/standardnotes/api-gateway/commit/89334c90221045308d83fce9e97c146185d21389))
+
+## [1.19.2](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.19.1...@standardnotes/api-gateway@1.19.2) (2022-09-15)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.19.1](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.19.0...@standardnotes/api-gateway@1.19.1) (2022-09-09)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+# [1.19.0](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.18.0...@standardnotes/api-gateway@1.19.0) (2022-09-09)
+
+### Features
+
+* **syncing-server:** add tracking files count in stats ([52cc646](https://github.com/standardnotes/api-gateway/commit/52cc6462a66dae3bd6c05f551d4ba661c8a9b8c8))
+
+# [1.18.0](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.17.4...@standardnotes/api-gateway@1.18.0) (2022-09-09)
+
+### Bug Fixes
+
+* **api-gateway:** add general activity breakdown to yesterdays report stats ([339c86f](https://github.com/standardnotes/api-gateway/commit/339c86fca073b02054260417b7519c08874e1e4e))
+
+### Features
+
+* **api-gateway:** add tracking general activity for free and paid users breakdown ([0afd3de](https://github.com/standardnotes/api-gateway/commit/0afd3de9779e2abe10deede24626a3cbe6b15e6c))
+
+## [1.17.4](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.17.3...@standardnotes/api-gateway@1.17.4) (2022-09-09)
+
+### Bug Fixes
+
+* **api-gateway:** add notes count statistics to report ([ced852d](https://github.com/standardnotes/api-gateway/commit/ced852d9dbf8cab4c235b94a834968a5fc5e7d36))
+
+## [1.17.3](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.17.2...@standardnotes/api-gateway@1.17.3) (2022-09-09)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.17.2](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.17.1...@standardnotes/api-gateway@1.17.2) (2022-09-08)
+
+### Bug Fixes
+
+* **api-gateway:** retention data structure to include both period keys ([50ddb91](https://github.com/standardnotes/api-gateway/commit/50ddb918ccc52bee4caad82504cb899bc5936150))
+
+## [1.17.1](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.17.0...@standardnotes/api-gateway@1.17.1) (2022-09-08)
+
+### Bug Fixes
+
+* **api-gateway:** retention data structure ([47be084](https://github.com/standardnotes/api-gateway/commit/47be0841fc6d5fa00892e775bb3a40f404a6382b))
+
+# [1.17.0](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.16.8...@standardnotes/api-gateway@1.17.0) (2022-09-08)
+
+### Features
+
+* **api-gateway:** add registration-to-activity retention analytics to report ([f139bb0](https://github.com/standardnotes/api-gateway/commit/f139bb003669bb41f98ad4bb59a036c489f43606))
+
+## [1.16.8](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.16.7...@standardnotes/api-gateway@1.16.8) (2022-09-08)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.16.7](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.16.6...@standardnotes/api-gateway@1.16.7) (2022-09-08)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.16.6](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.16.5...@standardnotes/api-gateway@1.16.6) (2022-09-07)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.16.5](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.16.4...@standardnotes/api-gateway@1.16.5) (2022-09-07)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.16.4](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.16.3...@standardnotes/api-gateway@1.16.4) (2022-09-07)
+
+### Bug Fixes
+
+* **api-gateway:** add registration-to-subscription time to analytics report ([936591d](https://github.com/standardnotes/api-gateway/commit/936591d40b5f5beb5c0a824c92cdfa20fff51c97))
+
+## [1.16.3](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.16.2...@standardnotes/api-gateway@1.16.3) (2022-09-07)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.16.2](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.16.1...@standardnotes/api-gateway@1.16.2) (2022-09-06)
+
+### Bug Fixes
+
+* **api-gateway:** include period key in statistics measures ([d149f46](https://github.com/standardnotes/api-gateway/commit/d149f46cf6456201dd8690977f64ed32a75f3459))
+* **api-gateway:** period types on analytics report ([f94c8fc](https://github.com/standardnotes/api-gateway/commit/f94c8fc26e684a07101cc5282ebb9cda3c8c6961))
+
+## [1.16.1](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.16.0...@standardnotes/api-gateway@1.16.1) (2022-09-06)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
 # [1.16.0](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.15.12...@standardnotes/api-gateway@1.16.0) (2022-09-06)
 
 ### Features

packages/api-gateway/bin/report.ts

@@ -16,6 +16,7 @@ import {
   AnalyticsActivity,
   AnalyticsStoreInterface,
   Period,
+  PeriodKeyGeneratorInterface,
   StatisticsMeasure,
   StatisticsStoreInterface,
 } from '@standardnotes/analytics'
@@ -24,6 +25,7 @@ const requestReport = async (
   analyticsStore: AnalyticsStoreInterface,
   statisticsStore: StatisticsStoreInterface,
   domainEventPublisher: DomainEventPublisherInterface,
+  periodKeyGenerator: PeriodKeyGeneratorInterface,
 ): Promise<void> => {
   const analyticsOverTime = []
 
@@ -36,6 +38,8 @@ const requestReport = async (
     AnalyticsActivity.DeleteAccount,
     AnalyticsActivity.SubscriptionCancelled,
     AnalyticsActivity.SubscriptionRefunded,
+    AnalyticsActivity.ExistingCustomersChurn,
+    AnalyticsActivity.NewCustomersChurn,
   ]
 
   for (const analyticsName of thirtyDaysAnalyticsNames) {
@@ -68,8 +72,12 @@ const requestReport = async (
   const yesterdayActivityNames = [
     AnalyticsActivity.LimitedDiscountOfferPurchased,
     AnalyticsActivity.GeneralActivity,
+    AnalyticsActivity.GeneralActivityFreeUsers,
+    AnalyticsActivity.GeneralActivityPaidUsers,
     AnalyticsActivity.PaymentFailed,
     AnalyticsActivity.PaymentSuccess,
+    AnalyticsActivity.NewCustomersChurn,
+    AnalyticsActivity.ExistingCustomersChurn,
   ]
 
   for (const activityName of yesterdayActivityNames) {
@@ -89,18 +97,78 @@ const requestReport = async (
     StatisticsMeasure.Refunds,
     StatisticsMeasure.RegistrationLength,
     StatisticsMeasure.SubscriptionLength,
+    StatisticsMeasure.RegistrationToSubscriptionTime,
+    StatisticsMeasure.RemainingSubscriptionTimePercentage,
+    StatisticsMeasure.NotesCountFreeUsers,
+    StatisticsMeasure.NotesCountPaidUsers,
+    StatisticsMeasure.FilesCount,
+    StatisticsMeasure.NewCustomers,
+    StatisticsMeasure.TotalCustomers,
   ]
   const statisticMeasures = []
   for (const statisticMeasureName of statisticMeasureNames) {
     for (const period of [Period.Yesterday, Period.ThisMonth]) {
       statisticMeasures.push({
         name: statisticMeasureName,
+        period,
         totalValue: await statisticsStore.getMeasureTotal(statisticMeasureName, period),
         average: await statisticsStore.getMeasureAverage(statisticMeasureName, period),
       })
     }
   }
 
+  const periodKeys = periodKeyGenerator.getDiscretePeriodKeys(Period.Last7Days)
+  const retentionOverDays = []
+  for (let i = 0; i < periodKeys.length; i++) {
+    for (let j = 0; j < periodKeys.length - i; j++) {
+      const dailyRetention = await analyticsStore.calculateActivitiesRetention({
+        firstActivity: AnalyticsActivity.Register,
+        firstActivityPeriodKey: periodKeys[i],
+        secondActivity: AnalyticsActivity.GeneralActivity,
+        secondActivityPeriodKey: periodKeys[i + j],
+      })
+
+      retentionOverDays.push({
+        firstPeriodKey: periodKeys[i],
+        secondPeriodKey: periodKeys[i + j],
+        value: dailyRetention,
+      })
+    }
+  }
+
+  const monthlyPeriodKeys = periodKeyGenerator.getDiscretePeriodKeys(Period.ThisYear)
+  const churnRates = []
+  for (const monthPeriodKey of monthlyPeriodKeys) {
+    const monthPeriod = periodKeyGenerator.convertPeriodKeyToPeriod(monthPeriodKey)
+    const dailyPeriodKeys = periodKeyGenerator.getDiscretePeriodKeys(monthPeriod)
+
+    const totalCustomerCounts: Array<number> = []
+    for (const dailyPeriodKey of dailyPeriodKeys) {
+      const customersCount = await statisticsStore.getMeasureTotal(StatisticsMeasure.TotalCustomers, dailyPeriodKey)
+      totalCustomerCounts.push(customersCount)
+    }
+    const filteredTotalCustomerCounts = totalCustomerCounts.filter((count) => !!count)
+    const averageCustomersCount = filteredTotalCustomerCounts.length
+      ? filteredTotalCustomerCounts.reduce((total, current) => total + current, 0) / filteredTotalCustomerCounts.length
+      : 0
+
+    const existingCustomersChurn = await analyticsStore.calculateActivityTotalCount(
+      AnalyticsActivity.ExistingCustomersChurn,
+      monthPeriodKey,
+    )
+    const newCustomersChurn = await analyticsStore.calculateActivityTotalCount(
+      AnalyticsActivity.NewCustomersChurn,
+      monthPeriodKey,
+    )
+
+    const totalChurn = existingCustomersChurn + newCustomersChurn
+
+    churnRates.push({
+      periodKey: monthPeriodKey,
+      rate: averageCustomersCount ? (totalChurn / averageCustomersCount) * 100 : 0,
+    })
+  }
+
   const event: DailyAnalyticsReportGeneratedEvent = {
     type: 'DAILY_ANALYTICS_REPORT_GENERATED',
     createdAt: new Date(),
@@ -118,6 +186,20 @@ const requestReport = async (
       activityStatistics: yesterdayActivityStatistics,
       activityStatisticsOverTime: analyticsOverTime,
       statisticMeasures,
+      retentionStatistics: [
+        {
+          firstActivity: AnalyticsActivity.Register,
+          secondActivity: AnalyticsActivity.GeneralActivity,
+          retention: {
+            periodKeys,
+            values: retentionOverDays,
+          },
+        },
+      ],
+      churn: {
+        periodKeys: monthlyPeriodKeys,
+        values: churnRates,
+      },
     },
   }
 
@@ -136,8 +218,9 @@ void container.load().then((container) => {
   const analyticsStore: AnalyticsStoreInterface = container.get(TYPES.AnalyticsStore)
   const statisticsStore: StatisticsStoreInterface = container.get(TYPES.StatisticsStore)
   const domainEventPublisher: DomainEventPublisherInterface = container.get(TYPES.DomainEventPublisher)
+  const periodKeyGenerator: PeriodKeyGeneratorInterface = container.get(TYPES.PeriodKeyGenerator)
 
-  Promise.resolve(requestReport(analyticsStore, statisticsStore, domainEventPublisher))
+  Promise.resolve(requestReport(analyticsStore, statisticsStore, domainEventPublisher, periodKeyGenerator))
     .then(() => {
       logger.info('Usage report generation complete')
 

packages/api-gateway/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/api-gateway",
-  "version": "1.16.0",
+  "version": "1.24.5",
   "engines": {
     "node": ">=16.0.0 <17.0.0"
   },
@@ -25,6 +25,7 @@
     "@newrelic/winston-enricher": "^4.0.0",
     "@sentry/node": "^7.3.0",
     "@standardnotes/analytics": "workspace:*",
+    "@standardnotes/common": "workspace:^",
     "@standardnotes/domain-events": "workspace:*",
     "@standardnotes/domain-events-infra": "workspace:*",
     "@standardnotes/security": "workspace:*",

packages/api-gateway/src/Bootstrap/Container.ts

@@ -6,6 +6,7 @@ import * as AWS from 'aws-sdk'
 import {
   AnalyticsStoreInterface,
   PeriodKeyGenerator,
+  PeriodKeyGeneratorInterface,
   RedisAnalyticsStore,
   RedisStatisticsStore,
   StatisticsStoreInterface,
@@ -22,6 +23,7 @@ import { SubscriptionTokenAuthMiddleware } from '../Controller/SubscriptionToken
 import { StatisticsMiddleware } from '../Controller/StatisticsMiddleware'
 import { CrossServiceTokenCacheInterface } from '../Service/Cache/CrossServiceTokenCacheInterface'
 import { RedisCrossServiceTokenCache } from '../Infra/Redis/RedisCrossServiceTokenCache'
+import { WebSocketAuthMiddleware } from '../Controller/WebSocketAuthMiddleware'
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const newrelicFormatter = require('@newrelic/winston-enricher')
@@ -84,6 +86,7 @@ export class ContainerConfigLoader {
 
     // Middleware
     container.bind<AuthMiddleware>(TYPES.AuthMiddleware).to(AuthMiddleware)
+    container.bind<WebSocketAuthMiddleware>(TYPES.WebSocketAuthMiddleware).to(WebSocketAuthMiddleware)
     container
       .bind<SubscriptionTokenAuthMiddleware>(TYPES.SubscriptionTokenAuthMiddleware)
       .to(SubscriptionTokenAuthMiddleware)
@@ -91,13 +94,13 @@ export class ContainerConfigLoader {
 
     // Services
     container.bind<HttpServiceInterface>(TYPES.HTTPService).to(HttpService)
-    const periodKeyGenerator = new PeriodKeyGenerator()
+    container.bind<PeriodKeyGeneratorInterface>(TYPES.PeriodKeyGenerator).toConstantValue(new PeriodKeyGenerator())
     container
       .bind<AnalyticsStoreInterface>(TYPES.AnalyticsStore)
-      .toConstantValue(new RedisAnalyticsStore(periodKeyGenerator, container.get(TYPES.Redis)))
+      .toConstantValue(new RedisAnalyticsStore(container.get(TYPES.PeriodKeyGenerator), container.get(TYPES.Redis)))
     container
       .bind<StatisticsStoreInterface>(TYPES.StatisticsStore)
-      .toConstantValue(new RedisStatisticsStore(periodKeyGenerator, container.get(TYPES.Redis)))
+      .toConstantValue(new RedisStatisticsStore(container.get(TYPES.PeriodKeyGenerator), container.get(TYPES.Redis)))
     container.bind<CrossServiceTokenCacheInterface>(TYPES.CrossServiceTokenCache).to(RedisCrossServiceTokenCache)
     container.bind<TimerInterface>(TYPES.Timer).toConstantValue(new Timer())
 

packages/api-gateway/src/Bootstrap/Types.ts

@@ -18,6 +18,7 @@ const TYPES = {
   // Middleware
   StatisticsMiddleware: Symbol.for('StatisticsMiddleware'),
   AuthMiddleware: Symbol.for('AuthMiddleware'),
+  WebSocketAuthMiddleware: Symbol.for('WebSocketAuthMiddleware'),
   SubscriptionTokenAuthMiddleware: Symbol.for('SubscriptionTokenAuthMiddleware'),
   // Services
   HTTPService: Symbol.for('HTTPService'),
@@ -26,6 +27,7 @@ const TYPES = {
   StatisticsStore: Symbol.for('StatisticsStore'),
   DomainEventPublisher: Symbol.for('DomainEventPublisher'),
   Timer: Symbol.for('Timer'),
+  PeriodKeyGenerator: Symbol.for('PeriodKeyGenerator'),
 }
 
 export default TYPES

packages/api-gateway/src/Controller/AuthMiddleware.ts

@@ -1,4 +1,5 @@
 import { CrossServiceTokenData } from '@standardnotes/security'
+import { RoleName } from '@standardnotes/common'
 import { AnalyticsActivity, AnalyticsStoreInterface, Period } from '@standardnotes/analytics'
 import { TimerInterface } from '@standardnotes/time'
 import { NextFunction, Request, Response } from 'express'
@@ -75,9 +76,20 @@ export class AuthMiddleware extends BaseMiddleware {
 
       const decodedToken = <CrossServiceTokenData>verify(crossServiceToken, this.jwtSecret, { algorithms: ['HS256'] })
 
-      await this.analyticsStore.markActivity([AnalyticsActivity.GeneralActivity], decodedToken.analyticsId as number, [
-        Period.Today,
-      ])
+      response.locals.freeUser =
+        decodedToken.roles.length === 1 &&
+        decodedToken.roles.find((role) => role.name === RoleName.CoreUser) !== undefined
+
+      await this.analyticsStore.markActivity(
+        [
+          AnalyticsActivity.GeneralActivity,
+          response.locals.freeUser
+            ? AnalyticsActivity.GeneralActivityFreeUsers
+            : AnalyticsActivity.GeneralActivityPaidUsers,
+        ],
+        decodedToken.analyticsId as number,
+        [Period.Today],
+      )
 
       if (this.crossServiceTokenCacheTTL && !crossServiceTokenFetchedFromCache) {
         await this.crossServiceTokenCache.set({

packages/api-gateway/src/Controller/WebSocketAuthMiddleware.ts

@@ -0,0 +1,95 @@
+import { CrossServiceTokenData } from '@standardnotes/security'
+import { RoleName } from '@standardnotes/common'
+import { NextFunction, Request, Response } from 'express'
+import { inject, injectable } from 'inversify'
+import { BaseMiddleware } from 'inversify-express-utils'
+import { verify } from 'jsonwebtoken'
+import { AxiosError, AxiosInstance } from 'axios'
+import { Logger } from 'winston'
+
+import TYPES from '../Bootstrap/Types'
+
+@injectable()
+export class WebSocketAuthMiddleware extends BaseMiddleware {
+  constructor(
+    @inject(TYPES.HTTPClient) private httpClient: AxiosInstance,
+    @inject(TYPES.AUTH_SERVER_URL) private authServerUrl: string,
+    @inject(TYPES.AUTH_JWT_SECRET) private jwtSecret: string,
+    @inject(TYPES.Logger) private logger: Logger,
+  ) {
+    super()
+  }
+
+  async handler(request: Request, response: Response, next: NextFunction): Promise<void> {
+    const authHeaderValue = request.headers.authorization as string
+
+    if (!authHeaderValue) {
+      response.status(401).send({
+        error: {
+          tag: 'invalid-auth',
+          message: 'Invalid login credentials.',
+        },
+      })
+
+      return
+    }
+
+    try {
+      const authResponse = await this.httpClient.request({
+        method: 'POST',
+        headers: {
+          Authorization: authHeaderValue,
+          Accept: 'application/json',
+        },
+        validateStatus: (status: number) => {
+          return status >= 200 && status < 500
+        },
+        url: `${this.authServerUrl}/sockets/tokens/validate`,
+      })
+
+      if (authResponse.status > 200) {
+        response.setHeader('content-type', authResponse.headers['content-type'])
+        response.status(authResponse.status).send(authResponse.data)
+
+        return
+      }
+
+      const crossServiceToken = authResponse.data.authToken
+
+      response.locals.authToken = crossServiceToken
+
+      const decodedToken = <CrossServiceTokenData>verify(crossServiceToken, this.jwtSecret, { algorithms: ['HS256'] })
+
+      response.locals.freeUser =
+        decodedToken.roles.length === 1 &&
+        decodedToken.roles.find((role) => role.name === RoleName.CoreUser) !== undefined
+      response.locals.userUuid = decodedToken.user.uuid
+      response.locals.roles = decodedToken.roles
+    } catch (error) {
+      const errorMessage = (error as AxiosError).isAxiosError
+        ? JSON.stringify((error as AxiosError).response?.data)
+        : (error as Error).message
+
+      this.logger.error(
+        `Could not pass the request to ${this.authServerUrl}/sockets/tokens/validate on underlying service: ${errorMessage}`,
+      )
+
+      this.logger.debug('Response error: %O', (error as AxiosError).response ?? error)
+
+      if ((error as AxiosError).response?.headers['content-type']) {
+        response.setHeader('content-type', (error as AxiosError).response?.headers['content-type'] as string)
+      }
+
+      const errorCode =
+        (error as AxiosError).isAxiosError && !isNaN(+((error as AxiosError).code as string))
+          ? +((error as AxiosError).code as string)
+          : 500
+
+      response.status(errorCode).send(errorMessage)
+
+      return
+    }
+
+    return next()
+  }
+}

packages/api-gateway/src/Controller/v1/ActionsController.ts

@@ -29,34 +29,4 @@ export class ActionsController extends BaseHttpController {
   async methods(request: Request, response: Response): Promise<void> {
     await this.httpService.callAuthServer(request, response, 'auth/methods', request.body)
   }
-
-  @httpGet('/failed-backups-emails/mute/:settingUuid')
-  async muteFailedBackupsEmails(request: Request, response: Response): Promise<void> {
-    await this.httpService.callAuthServer(
-      request,
-      response,
-      `internal/settings/email_backup/${request.params.settingUuid}/mute`,
-      request.body,
-    )
-  }
-
-  @httpGet('/sign-in-emails/mute/:settingUuid')
-  async muteSignInEmails(request: Request, response: Response): Promise<void> {
-    await this.httpService.callAuthServer(
-      request,
-      response,
-      `internal/settings/sign_in/${request.params.settingUuid}/mute`,
-      request.body,
-    )
-  }
-
-  @httpGet('/marketing-emails/mute/:settingUuid')
-  async muteMarketingEmails(request: Request, response: Response): Promise<void> {
-    await this.httpService.callAuthServer(
-      request,
-      response,
-      `internal/settings/marketing-emails/${request.params.settingUuid}/mute`,
-      request.body,
-    )
-  }
 }

packages/api-gateway/src/Controller/v1/PaymentsController.ts

@@ -70,11 +70,6 @@ export class PaymentsController extends BaseHttpController {
     await this.httpService.callPaymentsServer(request, response, 'admin/events/registration', request.body)
   }
 
-  @httpPost('/admin/graphql')
-  async adminGraphql(request: Request, response: Response): Promise<void> {
-    await this.httpService.callPaymentsServer(request, response, 'admin/graphql', request.body)
-  }
-
   @httpPost('/admin/auth/login')
   async adminLogin(request: Request, response: Response): Promise<void> {
     await this.httpService.callPaymentsServer(request, response, 'admin/auth/login', request.body)

packages/api-gateway/src/Controller/v1/WebSocketsController.ts

@@ -15,7 +15,12 @@ export class WebSocketsController extends BaseHttpController {
     super()
   }
 
-  @httpPost('/', TYPES.AuthMiddleware)
+  @httpPost('/tokens', TYPES.AuthMiddleware)
+  async createWebSocketConnectionToken(request: Request, response: Response): Promise<void> {
+    await this.httpService.callAuthServer(request, response, 'sockets/tokens', request.body)
+  }
+
+  @httpPost('/connections', TYPES.WebSocketAuthMiddleware)
   async createWebSocketConnection(request: Request, response: Response): Promise<void> {
     if (!request.headers.connectionid) {
       this.logger.error('Could not create a websocket connection. Missing connection id header.')
@@ -25,10 +30,15 @@ export class WebSocketsController extends BaseHttpController {
       return
     }
 
-    await this.httpService.callAuthServer(request, response, `sockets/${request.headers.connectionid}`, request.body)
+    await this.httpService.callAuthServer(
+      request,
+      response,
+      `sockets/connections/${request.headers.connectionid}`,
+      request.body,
+    )
   }
 
-  @httpDelete('/')
+  @httpDelete('/connections')
   async deleteWebSocketConnection(request: Request, response: Response): Promise<void> {
     if (!request.headers.connectionid) {
       this.logger.error('Could not delete a websocket connection. Missing connection id header.')
@@ -38,6 +48,11 @@ export class WebSocketsController extends BaseHttpController {
       return
     }
 
-    await this.httpService.callAuthServer(request, response, `sockets/${request.headers.connectionid}`, request.body)
+    await this.httpService.callAuthServer(
+      request,
+      response,
+      `sockets/connections/${request.headers.connectionid}`,
+      request.body,
+    )
   }
 }

packages/auth/.env.sample

@@ -66,5 +66,8 @@ SENTRY_ENVIRONMENT=
 VALET_TOKEN_SECRET=
 VALET_TOKEN_TTL=
 
+WEB_SOCKET_CONNECTION_TOKEN_SECRET=
+WEB_SOCKET_CONNECTION_TOKEN_TTL=
+
 # (Optional) Analytics
 ANALYTICS_ENABLED=false

packages/auth/CHANGELOG.md

@@ -3,6 +3,310 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.37.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.36.4...@standardnotes/auth-server@1.37.0) (2022-10-04)
+
+### Features
+
+* **auth:** add detailed income stats ([8668fec](https://github.com/standardnotes/server/commit/8668fec33dac1598bdc4d6ca869c296ed6eaa617))
+
+## [1.36.4](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.36.3...@standardnotes/auth-server@1.36.4) (2022-10-04)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.36.3](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.36.2...@standardnotes/auth-server@1.36.3) (2022-10-04)
+
+### Bug Fixes
+
+* **auth:** turn down severity of logs for predicate verification ([09b3f9a](https://github.com/standardnotes/server/commit/09b3f9a0d787d2a329f84e2d625ec8a63b4bd847))
+
+## [1.36.2](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.36.1...@standardnotes/auth-server@1.36.2) (2022-10-03)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.36.1](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.36.0...@standardnotes/auth-server@1.36.1) (2022-10-03)
+
+### Bug Fixes
+
+* **auth:** counting active subscriptions ([e7736bb](https://github.com/standardnotes/server/commit/e7736bba250782a3967fd08c82dbf32884b5b892))
+
+# [1.36.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.35.0...@standardnotes/auth-server@1.36.0) (2022-10-03)
+
+### Features
+
+* **auth:** disallow v1 sign in for users with 004 protocol version ([6a9d479](https://github.com/standardnotes/server/commit/6a9d479f7173268bc0c79b1c7583021989be783a))
+
+# [1.35.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.34.1...@standardnotes/auth-server@1.35.0) (2022-09-30)
+
+### Features
+
+* **auth:** add tracking total customers count ([8a98f74](https://github.com/standardnotes/server/commit/8a98f746eb13c25f7940286aca594e2304232bdf))
+
+## [1.34.1](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.34.0...@standardnotes/auth-server@1.34.1) (2022-09-30)
+
+### Bug Fixes
+
+* **auth:** fix calculating new and existing customers churn ([82bb851](https://github.com/standardnotes/server/commit/82bb85174d94a5e03f364604a1c07a9b1633920d))
+
+# [1.34.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.33.0...@standardnotes/auth-server@1.34.0) (2022-09-30)
+
+### Features
+
+* **auth:** add measuring new customers ([b6118c1](https://github.com/standardnotes/server/commit/b6118c17e176ba0acc93b95a38e32748ac851410))
+
+# [1.33.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.32.13...@standardnotes/auth-server@1.33.0) (2022-09-30)
+
+### Features
+
+* **auth:** add tracking churn activity ([39337c1](https://github.com/standardnotes/server/commit/39337c1c4f799f39672eeb8c9d050e7cbb19878a))
+
+## [1.32.13](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.32.12...@standardnotes/auth-server@1.32.13) (2022-09-29)
+
+### Bug Fixes
+
+* **auth:** finding previous subscription setting for irreplacable subscription settings ([0a5b7e1](https://github.com/standardnotes/server/commit/0a5b7e13cd51ddbad40f67d629b0daf50b176fac))
+
+## [1.32.12](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.32.11...@standardnotes/auth-server@1.32.12) (2022-09-29)
+
+### Bug Fixes
+
+* **auth:** reassign not replaceable subscription settings ([477f146](https://github.com/standardnotes/server/commit/477f146725c8e83b86a8224708046d0fd86bfa0b))
+
+## [1.32.11](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.32.10...@standardnotes/auth-server@1.32.11) (2022-09-28)
+
+### Bug Fixes
+
+* **auth:** prevent replacing files bytes used subscription setting upon renewal ([40e6733](https://github.com/standardnotes/server/commit/40e673379bb84bd21bcc8dbcb1aa36caaa2adbf8))
+
+## [1.32.10](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.32.9...@standardnotes/auth-server@1.32.10) (2022-09-28)
+
+### Bug Fixes
+
+* **auth:** exclude legacy 5 year plans from subscription length statistics ([c5a07a8](https://github.com/standardnotes/server/commit/c5a07a888aadc22f62a92a236977c266f8d8e1c0))
+
+## [1.32.9](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.32.8...@standardnotes/auth-server@1.32.9) (2022-09-28)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.32.8](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.32.7...@standardnotes/auth-server@1.32.8) (2022-09-27)
+
+### Bug Fixes
+
+* **auth:** ttl for lock counter on login lockout ([54da5de](https://github.com/standardnotes/server/commit/54da5def4bbfbb4f74cbf02ae23e45103d250dd9))
+
+## [1.32.7](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.32.6...@standardnotes/auth-server@1.32.7) (2022-09-27)
+
+### Bug Fixes
+
+* **auth:** allow resending canceled subscription invites ([b190931](https://github.com/standardnotes/server/commit/b19093179baaa1fb8cdf3f9d9bee20e625ed0b9b))
+
+## [1.32.6](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.32.5...@standardnotes/auth-server@1.32.6) (2022-09-22)
+
+### Reverts
+
+* Revert "fix(auth): subscription token ttl" ([644c52a](https://github.com/standardnotes/server/commit/644c52ae36d3720dee0712e2cb826c7e617ab7b7))
+* Revert "fix(auth): increase subscription token ttl" ([2554273](https://github.com/standardnotes/server/commit/2554273a3f85a968fed4286d109bed5413ef9908))
+* Revert "tmp(auth): disable expiring of subscription tokens" ([a8ee149](https://github.com/standardnotes/server/commit/a8ee149d7ac78775bf447ab924458b116414a15e))
+
+## [1.32.5](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.32.4...@standardnotes/auth-server@1.32.5) (2022-09-22)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.32.4](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.32.3...@standardnotes/auth-server@1.32.4) (2022-09-22)
+
+### Bug Fixes
+
+* **auth:** increase subscription token ttl ([07def20](https://github.com/standardnotes/server/commit/07def20f6b47f9d1c678cfe5206b924dd5e6014a))
+
+## [1.32.3](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.32.2...@standardnotes/auth-server@1.32.3) (2022-09-22)
+
+### Bug Fixes
+
+* **auth:** subscription token ttl ([6efd336](https://github.com/standardnotes/server/commit/6efd336f3407e7204a0c5d385ea9df5c02c7e5f5))
+
+## [1.32.2](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.32.1...@standardnotes/auth-server@1.32.2) (2022-09-22)
+
+### Bug Fixes
+
+* **auth:** add throwing an error if the subscription token was not persisted ([76cee6d](https://github.com/standardnotes/server/commit/76cee6dbad9bff041d8d5a1d4435046509c14f71))
+
+## [1.32.1](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.32.0...@standardnotes/auth-server@1.32.1) (2022-09-22)
+
+### Bug Fixes
+
+* **auth:** settings and subscription settings projection ([d6cf8d4](https://github.com/standardnotes/server/commit/d6cf8d400a0177ee9030a171cf2ca47ade293fd9))
+
+# [1.32.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.31.2...@standardnotes/auth-server@1.32.0) (2022-09-22)
+
+### Features
+
+* **auth:** remove muting emails by use case in favor of updating user settings ([d3f36c0](https://github.com/standardnotes/server/commit/d3f36c05dfc114098a6c231d81149ebd1a959b74))
+
+## [1.31.2](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.31.1...@standardnotes/auth-server@1.31.2) (2022-09-21)
+
+### Bug Fixes
+
+* **auth:** response wrapping on web socket connection token creation ([413a276](https://github.com/standardnotes/server/commit/413a276d205d53c316f7d0af8aed422001a6c1ab))
+
+## [1.31.1](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.31.0...@standardnotes/auth-server@1.31.1) (2022-09-21)
+
+### Bug Fixes
+
+* **auth:** web sockets routes ([875edce](https://github.com/standardnotes/server/commit/875edce5b1dc134b4e22702354b29303fab3c910))
+
+# [1.31.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.30.1...@standardnotes/auth-server@1.31.0) (2022-09-21)
+
+### Features
+
+* **auth:** add creating cross service token in exchange for web socket connection token ([965ae79](https://github.com/standardnotes/server/commit/965ae79414e25d0959f67e16dcbb054229013e1c))
+
+## [1.30.1](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.30.0...@standardnotes/auth-server@1.30.1) (2022-09-21)
+
+### Bug Fixes
+
+* **auth:** missing injectable annotation ([d935157](https://github.com/standardnotes/server/commit/d935157ee8425d427fa52465e766d18e29332b5b))
+
+# [1.30.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.29.1...@standardnotes/auth-server@1.30.0) (2022-09-21)
+
+### Features
+
+* **auth:** add creating web socket connection tokens ([8033177](https://github.com/standardnotes/server/commit/8033177f48dc961194f24fb7daa1073b8b697b74))
+
+## [1.29.1](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.29.0...@standardnotes/auth-server@1.29.1) (2022-09-19)
+
+### Bug Fixes
+
+* **auth:** uuid validator binding ([db6f966](https://github.com/standardnotes/server/commit/db6f966045d51e59555740c9e009bf66b629673c))
+
+# [1.29.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.28.4...@standardnotes/auth-server@1.29.0) (2022-09-19)
+
+### Features
+
+* **files:** add validating remote identifiers ([db15457](https://github.com/standardnotes/server/commit/db15457ce4eb533ec822cf93c3ed83eafe9e64d5))
+
+## [1.28.4](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.28.3...@standardnotes/auth-server@1.28.4) (2022-09-16)
+
+### Bug Fixes
+
+* **auth:** feature service spec ([c207c3f](https://github.com/standardnotes/server/commit/c207c3fc8442eec9b8c3150f09ecccfdd6a5ed50))
+
+## [1.28.3](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.28.2...@standardnotes/auth-server@1.28.3) (2022-09-16)
+
+### Bug Fixes
+
+* **auth:** change remaining subscription time stats to percentage ([5eb957c](https://github.com/standardnotes/server/commit/5eb957c82a8cc5fdcb6815e2cd30e49cd2b1e8ac))
+
+## [1.28.2](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.28.1...@standardnotes/auth-server@1.28.2) (2022-09-16)
+
+### Bug Fixes
+
+* **files:** add verifying permitted operation on valet token ([377d32c](https://github.com/standardnotes/server/commit/377d32c4498305f0f59ff59e7357f0d2f10ce3a2))
+
+## [1.28.1](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.28.0...@standardnotes/auth-server@1.28.1) (2022-09-15)
+
+### Bug Fixes
+
+* **auth:** missing injectable annotation ([d851524](https://github.com/standardnotes/server/commit/d85152429ca379d3d0314a9864cc46ebee541958))
+
+# [1.28.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.27.0...@standardnotes/auth-server@1.28.0) (2022-09-15)
+
+### Features
+
+* **auth:** add remaining subscription time stats ([a59ba08](https://github.com/standardnotes/server/commit/a59ba083397c75960af0e8a102b617bf5baa287f))
+
+# [1.27.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.26.1...@standardnotes/auth-server@1.27.0) (2022-09-15)
+
+### Features
+
+* **auth:** implement subscription server interface on server side ([5d812be](https://github.com/standardnotes/server/commit/5d812befc4733954919eef0d3718ae6f8eb81654))
+
+## [1.26.1](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.26.0...@standardnotes/auth-server@1.26.1) (2022-09-15)
+
+### Bug Fixes
+
+* **auth:** disallow duplicating subscription invites ([531f13f](https://github.com/standardnotes/server/commit/531f13fe1f4bdfb8d27f5e3c07ec0b15d36ad413))
+
+# [1.26.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.25.13...@standardnotes/auth-server@1.26.0) (2022-09-13)
+
+### Features
+
+* **auth:** add subscription sharing permission ([f45320e](https://github.com/standardnotes/server/commit/f45320e5ed8948a432029586c05284f4d640de5b))
+
+## [1.25.13](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.25.12...@standardnotes/auth-server@1.25.13) (2022-09-12)
+
+### Bug Fixes
+
+* **auth:** add debug logs for canceling shared subscription invitations ([dd13e2e](https://github.com/standardnotes/server/commit/dd13e2eaf74de56a3c8c30c236c32c6dc0c560f2))
+
+## [1.25.12](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.25.11...@standardnotes/auth-server@1.25.12) (2022-09-12)
+
+### Bug Fixes
+
+* **auth:** allow canceling shared subscription invitation before it was accepted ([0dab31f](https://github.com/standardnotes/server/commit/0dab31f9936bfd5081a87eef9701a268b8dec88c))
+
+## [1.25.11](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.25.10...@standardnotes/auth-server@1.25.11) (2022-09-09)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.25.10](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.25.9...@standardnotes/auth-server@1.25.10) (2022-09-09)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.25.9](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.25.8...@standardnotes/auth-server@1.25.9) (2022-09-09)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.25.8](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.25.7...@standardnotes/auth-server@1.25.8) (2022-09-09)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.25.7](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.25.6...@standardnotes/auth-server@1.25.7) (2022-09-08)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.25.6](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.25.5...@standardnotes/auth-server@1.25.6) (2022-09-08)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.25.5](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.25.4...@standardnotes/auth-server@1.25.5) (2022-09-08)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.25.4](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.25.3...@standardnotes/auth-server@1.25.4) (2022-09-08)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.25.3](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.25.2...@standardnotes/auth-server@1.25.3) (2022-09-08)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.25.2](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.25.1...@standardnotes/auth-server@1.25.2) (2022-09-07)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.25.1](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.25.0...@standardnotes/auth-server@1.25.1) (2022-09-07)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+# [1.25.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.24.4...@standardnotes/auth-server@1.25.0) (2022-09-07)
+
+### Features
+
+* **auth:** add measuring registration to subscription time statistics ([b618252](https://github.com/standardnotes/server/commit/b61825235eebaf5eddb55cbda173176ca43c0099))
+
+## [1.24.4](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.24.3...@standardnotes/auth-server@1.24.4) (2022-09-07)
+
+### Bug Fixes
+
+* **auth:** forbid users on shared subscription to send out invitations ([132b617](https://github.com/standardnotes/server/commit/132b617aaa8a703877fd7e8d23711fb1ec234524))
+
+## [1.24.3](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.24.2...@standardnotes/auth-server@1.24.3) (2022-09-06)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.24.2](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.24.1...@standardnotes/auth-server@1.24.2) (2022-09-06)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
 ## [1.24.1](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.24.0...@standardnotes/auth-server@1.24.1) (2022-09-06)
 
 **Note:** Version bump only for package @standardnotes/auth-server

packages/auth/bin/server.ts

@@ -10,17 +10,17 @@ import '../src/Controller/SessionsController'
 import '../src/Controller/UsersController'
 import '../src/Controller/SettingsController'
 import '../src/Controller/FeaturesController'
-import '../src/Controller/WebSocketsController'
 import '../src/Controller/AdminController'
 import '../src/Controller/InternalController'
 import '../src/Controller/SubscriptionTokensController'
 import '../src/Controller/OfflineController'
 import '../src/Controller/ValetTokenController'
 import '../src/Controller/ListedController'
-import '../src/Controller/SubscriptionInvitesController'
 import '../src/Controller/SubscriptionSettingsController'
 
 import '../src/Infra/InversifyExpressUtils/InversifyExpressAuthController'
+import '../src/Infra/InversifyExpressUtils/InversifyExpressSubscriptionInvitesController'
+import '../src/Infra/InversifyExpressUtils/InversifyExpressWebSocketsController'
 
 import * as cors from 'cors'
 import { urlencoded, json, Request, Response, NextFunction, RequestHandler, ErrorRequestHandler } from 'express'

packages/auth/migrations/1663073954000-add_subcription_sharing_permission.ts

@@ -0,0 +1,22 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class addSubscriptionSharingPermission1663073954000 implements MigrationInterface {
+  name = 'addSubscriptionSharingPermission1663073954000'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      'INSERT INTO `permissions` (uuid, name) VALUES ("3aeaf12e-380f-4f21-97b9-d862d63874f6", "server:subscription-sharing")',
+    )
+
+    // Pro User Permissions
+    await queryRunner.query(
+      'INSERT INTO `role_permissions` (role_uuid, permission_uuid) VALUES \
+    ("8047edbb-a10a-4ff8-8d53-c2cae600a8e8", "3aeaf12e-380f-4f21-97b9-d862d63874f6") \
+    ',
+    )
+  }
+
+  public async down(): Promise<void> {
+    return
+  }
+}

packages/auth/migrations/1663321030000-add_renewed_at_column.ts

@@ -0,0 +1,13 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class addRenewedAtColumn1663321030000 implements MigrationInterface {
+  name = 'addRenewedAtColumn1663321030000'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query('ALTER TABLE `user_subscriptions` ADD `renewed_at` bigint NULL')
+  }
+
+  public async down(): Promise<void> {
+    return
+  }
+}

packages/auth/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/auth-server",
-  "version": "1.24.1",
+  "version": "1.37.0",
   "engines": {
     "node": ">=16.0.0 <17.0.0"
   },
@@ -34,11 +34,11 @@
     "@newrelic/winston-enricher": "^4.0.0",
     "@sentry/node": "^7.3.0",
     "@standardnotes/analytics": "workspace:*",
-    "@standardnotes/api": "^1.1.19",
+    "@standardnotes/api": "^1.9.0",
     "@standardnotes/common": "workspace:*",
     "@standardnotes/domain-events": "workspace:*",
     "@standardnotes/domain-events-infra": "workspace:*",
-    "@standardnotes/features": "^1.47.0",
+    "@standardnotes/features": "^1.52.1",
     "@standardnotes/predicates": "workspace:*",
     "@standardnotes/responses": "^1.6.39",
     "@standardnotes/security": "workspace:*",

packages/auth/src/Bootstrap/Container.ts

@@ -130,13 +130,19 @@ import { RedisOfflineSubscriptionTokenRepository } from '../Infra/Redis/RedisOff
 import { CreateOfflineSubscriptionToken } from '../Domain/UseCase/CreateOfflineSubscriptionToken/CreateOfflineSubscriptionToken'
 import { AuthenticateOfflineSubscriptionToken } from '../Domain/UseCase/AuthenticateOfflineSubscriptionToken/AuthenticateOfflineSubscriptionToken'
 import { SubscriptionCancelledEventHandler } from '../Domain/Handler/SubscriptionCancelledEventHandler'
-import { ContentDecoder, ContentDecoderInterface, ProtocolVersion } from '@standardnotes/common'
+import {
+  ContentDecoder,
+  ContentDecoderInterface,
+  ProtocolVersion,
+  Uuid,
+  UuidValidator,
+  ValidatorInterface,
+} from '@standardnotes/common'
 import { GetUserOfflineSubscription } from '../Domain/UseCase/GetUserOfflineSubscription/GetUserOfflineSubscription'
 import { ApiGatewayOfflineAuthMiddleware } from '../Controller/ApiGatewayOfflineAuthMiddleware'
 import { UserEmailChangedEventHandler } from '../Domain/Handler/UserEmailChangedEventHandler'
 import { SettingsAssociationServiceInterface } from '../Domain/Setting/SettingsAssociationServiceInterface'
 import { SettingsAssociationService } from '../Domain/Setting/SettingsAssociationService'
-import { MuteFailedBackupsEmails } from '../Domain/UseCase/MuteFailedBackupsEmails/MuteFailedBackupsEmails'
 import { SubscriptionSyncRequestedEventHandler } from '../Domain/Handler/SubscriptionSyncRequestedEventHandler'
 import {
   CrossServiceTokenData,
@@ -149,13 +155,13 @@ import {
   TokenEncoder,
   TokenEncoderInterface,
   ValetTokenData,
+  WebSocketConnectionTokenData,
 } from '@standardnotes/security'
 import { FileUploadedEventHandler } from '../Domain/Handler/FileUploadedEventHandler'
 import { CreateValetToken } from '../Domain/UseCase/CreateValetToken/CreateValetToken'
 import { CreateListedAccount } from '../Domain/UseCase/CreateListedAccount/CreateListedAccount'
 import { ListedAccountCreatedEventHandler } from '../Domain/Handler/ListedAccountCreatedEventHandler'
 import { ListedAccountDeletedEventHandler } from '../Domain/Handler/ListedAccountDeletedEventHandler'
-import { MuteSignInEmails } from '../Domain/UseCase/MuteSignInEmails/MuteSignInEmails'
 import { FileRemovedEventHandler } from '../Domain/Handler/FileRemovedEventHandler'
 import { UserDisabledSessionUserAgentLoggingEventHandler } from '../Domain/Handler/UserDisabledSessionUserAgentLoggingEventHandler'
 import { SettingInterpreterInterface } from '../Domain/Setting/SettingInterpreterInterface'
@@ -196,10 +202,14 @@ import { GetUserAnalyticsId } from '../Domain/UseCase/GetUserAnalyticsId/GetUser
 import { AuthController } from '../Controller/AuthController'
 import { VerifyPredicate } from '../Domain/UseCase/VerifyPredicate/VerifyPredicate'
 import { PredicateVerificationRequestedEventHandler } from '../Domain/Handler/PredicateVerificationRequestedEventHandler'
-import { MuteMarketingEmails } from '../Domain/UseCase/MuteMarketingEmails/MuteMarketingEmails'
 import { PaymentFailedEventHandler } from '../Domain/Handler/PaymentFailedEventHandler'
 import { PaymentSuccessEventHandler } from '../Domain/Handler/PaymentSuccessEventHandler'
 import { RefundProcessedEventHandler } from '../Domain/Handler/RefundProcessedEventHandler'
+import { SubscriptionInvitesController } from '../Controller/SubscriptionInvitesController'
+import { CreateWebSocketConnectionToken } from '../Domain/UseCase/CreateWebSocketConnectionToken/CreateWebSocketConnectionToken'
+import { WebSocketsController } from '../Controller/WebSocketsController'
+import { WebSocketServerInterface } from '@standardnotes/api'
+import { CreateCrossServiceToken } from '../Domain/UseCase/CreateCrossServiceToken/CreateCrossServiceToken'
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const newrelicFormatter = require('@newrelic/winston-enricher')
@@ -262,6 +272,8 @@ export class ContainerConfigLoader {
 
     // Controller
     container.bind<AuthController>(TYPES.AuthController).to(AuthController)
+    container.bind<SubscriptionInvitesController>(TYPES.SubscriptionInvitesController).to(SubscriptionInvitesController)
+    container.bind<WebSocketServerInterface>(TYPES.WebSocketsController).to(WebSocketsController)
 
     // Repositories
     container.bind<SessionRepositoryInterface>(TYPES.SessionRepository).to(MySQLSessionRepository)
@@ -360,6 +372,12 @@ export class ContainerConfigLoader {
     container.bind(TYPES.AUTH_JWT_TTL).toConstantValue(+env.get('AUTH_JWT_TTL'))
     container.bind(TYPES.VALET_TOKEN_SECRET).toConstantValue(env.get('VALET_TOKEN_SECRET', true))
     container.bind(TYPES.VALET_TOKEN_TTL).toConstantValue(+env.get('VALET_TOKEN_TTL', true))
+    container
+      .bind(TYPES.WEB_SOCKET_CONNECTION_TOKEN_SECRET)
+      .toConstantValue(env.get('WEB_SOCKET_CONNECTION_TOKEN_SECRET', true))
+    container
+      .bind(TYPES.WEB_SOCKET_CONNECTION_TOKEN_TTL)
+      .toConstantValue(+env.get('WEB_SOCKET_CONNECTION_TOKEN_TTL', true))
     container.bind(TYPES.ENCRYPTION_SERVER_KEY).toConstantValue(env.get('ENCRYPTION_SERVER_KEY'))
     container.bind(TYPES.ACCESS_TOKEN_AGE).toConstantValue(env.get('ACCESS_TOKEN_AGE'))
     container.bind(TYPES.REFRESH_TOKEN_AGE).toConstantValue(env.get('REFRESH_TOKEN_AGE'))
@@ -418,9 +436,6 @@ export class ContainerConfigLoader {
     container
       .bind<CreateOfflineSubscriptionToken>(TYPES.CreateOfflineSubscriptionToken)
       .to(CreateOfflineSubscriptionToken)
-    container.bind<MuteFailedBackupsEmails>(TYPES.MuteFailedBackupsEmails).to(MuteFailedBackupsEmails)
-    container.bind<MuteSignInEmails>(TYPES.MuteSignInEmails).to(MuteSignInEmails)
-    container.bind<MuteMarketingEmails>(TYPES.MuteMarketingEmails).to(MuteMarketingEmails)
     container.bind<CreateValetToken>(TYPES.CreateValetToken).to(CreateValetToken)
     container.bind<CreateListedAccount>(TYPES.CreateListedAccount).to(CreateListedAccount)
     container.bind<InviteToSharedSubscription>(TYPES.InviteToSharedSubscription).to(InviteToSharedSubscription)
@@ -439,6 +454,10 @@ export class ContainerConfigLoader {
     container.bind<GetSubscriptionSetting>(TYPES.GetSubscriptionSetting).to(GetSubscriptionSetting)
     container.bind<GetUserAnalyticsId>(TYPES.GetUserAnalyticsId).to(GetUserAnalyticsId)
     container.bind<VerifyPredicate>(TYPES.VerifyPredicate).to(VerifyPredicate)
+    container
+      .bind<CreateWebSocketConnectionToken>(TYPES.CreateWebSocketConnectionToken)
+      .to(CreateWebSocketConnectionToken)
+    container.bind<CreateCrossServiceToken>(TYPES.CreateCrossServiceToken).to(CreateCrossServiceToken)
 
     // Handlers
     container.bind<UserRegisteredEventHandler>(TYPES.UserRegisteredEventHandler).to(UserRegisteredEventHandler)
@@ -511,6 +530,11 @@ export class ContainerConfigLoader {
     container
       .bind<TokenDecoderInterface<OfflineUserTokenData>>(TYPES.OfflineUserTokenDecoder)
       .toConstantValue(new TokenDecoder<OfflineUserTokenData>(container.get(TYPES.AUTH_JWT_SECRET)))
+    container
+      .bind<TokenDecoderInterface<WebSocketConnectionTokenData>>(TYPES.WebSocketConnectionTokenDecoder)
+      .toConstantValue(
+        new TokenDecoder<WebSocketConnectionTokenData>(container.get(TYPES.WEB_SOCKET_CONNECTION_TOKEN_SECRET)),
+      )
     container
       .bind<TokenEncoderInterface<OfflineUserTokenData>>(TYPES.OfflineUserTokenEncoder)
       .toConstantValue(new TokenEncoder<OfflineUserTokenData>(container.get(TYPES.AUTH_JWT_SECRET)))
@@ -523,6 +547,11 @@ export class ContainerConfigLoader {
     container
       .bind<TokenEncoderInterface<ValetTokenData>>(TYPES.ValetTokenEncoder)
       .toConstantValue(new TokenEncoder<ValetTokenData>(container.get(TYPES.VALET_TOKEN_SECRET)))
+    container
+      .bind<TokenEncoderInterface<WebSocketConnectionTokenData>>(TYPES.WebSocketConnectionTokenEncoder)
+      .toConstantValue(
+        new TokenEncoder<WebSocketConnectionTokenData>(container.get(TYPES.WEB_SOCKET_CONNECTION_TOKEN_SECRET)),
+      )
     container.bind<AuthenticationMethodResolver>(TYPES.AuthenticationMethodResolver).to(AuthenticationMethodResolver)
     container.bind<DomainEventFactory>(TYPES.DomainEventFactory).to(DomainEventFactory)
     container.bind<AxiosInstance>(TYPES.HTTPClient).toConstantValue(axios.create())
@@ -557,6 +586,7 @@ export class ContainerConfigLoader {
     container
       .bind<StatisticsStoreInterface>(TYPES.StatisticsStore)
       .toConstantValue(new RedisStatisticsStore(periodKeyGenerator, container.get(TYPES.Redis)))
+    container.bind<ValidatorInterface<Uuid>>(TYPES.UuidValidator).toConstantValue(new UuidValidator())
 
     if (env.get('SNS_TOPIC_ARN', true)) {
       container

packages/auth/src/Bootstrap/Types.ts

@@ -5,6 +5,8 @@ const TYPES = {
   SQS: Symbol.for('SQS'),
   // Controller
   AuthController: Symbol.for('AuthController'),
+  SubscriptionInvitesController: Symbol.for('SubscriptionInvitesController'),
+  WebSocketsController: Symbol.for('WebSocketsController'),
   // Repositories
   UserRepository: Symbol.for('UserRepository'),
   SessionRepository: Symbol.for('SessionRepository'),
@@ -59,6 +61,8 @@ const TYPES = {
   AUTH_JWT_TTL: Symbol.for('AUTH_JWT_TTL'),
   VALET_TOKEN_SECRET: Symbol.for('VALET_TOKEN_SECRET'),
   VALET_TOKEN_TTL: Symbol.for('VALET_TOKEN_TTL'),
+  WEB_SOCKET_CONNECTION_TOKEN_SECRET: Symbol.for('WEB_SOCKET_CONNECTION_TOKEN_SECRET'),
+  WEB_SOCKET_CONNECTION_TOKEN_TTL: Symbol.for('WEB_SOCKET_CONNECTION_TOKEN_TTL'),
   ENCRYPTION_SERVER_KEY: Symbol.for('ENCRYPTION_SERVER_KEY'),
   ACCESS_TOKEN_AGE: Symbol.for('ACCESS_TOKEN_AGE'),
   REFRESH_TOKEN_AGE: Symbol.for('REFRESH_TOKEN_AGE'),
@@ -111,9 +115,6 @@ const TYPES = {
   AuthenticateSubscriptionToken: Symbol.for('AuthenticateSubscriptionToken'),
   CreateOfflineSubscriptionToken: Symbol.for('CreateOfflineSubscriptionToken'),
   AuthenticateOfflineSubscriptionToken: Symbol.for('AuthenticateOfflineSubscriptionToken'),
-  MuteFailedBackupsEmails: Symbol.for('MuteFailedBackupsEmails'),
-  MuteSignInEmails: Symbol.for('MuteSignInEmails'),
-  MuteMarketingEmails: Symbol.for('MuteMarketingEmails'),
   CreateValetToken: Symbol.for('CreateValetToken'),
   CreateListedAccount: Symbol.for('CreateListedAccount'),
   InviteToSharedSubscription: Symbol.for('InviteToSharedSubscription'),
@@ -124,6 +125,8 @@ const TYPES = {
   GetSubscriptionSetting: Symbol.for('GetSubscriptionSetting'),
   GetUserAnalyticsId: Symbol.for('GetUserAnalyticsId'),
   VerifyPredicate: Symbol.for('VerifyPredicate'),
+  CreateWebSocketConnectionToken: Symbol.for('CreateWebSocketConnectionToken'),
+  CreateCrossServiceToken: Symbol.for('CreateCrossServiceToken'),
   // Handlers
   UserRegisteredEventHandler: Symbol.for('UserRegisteredEventHandler'),
   AccountDeletionRequestedEventHandler: Symbol.for('AccountDeletionRequestedEventHandler'),
@@ -165,6 +168,8 @@ const TYPES = {
   CrossServiceTokenEncoder: Symbol.for('CrossServiceTokenEncoder'),
   SessionTokenEncoder: Symbol.for('SessionTokenEncoder'),
   ValetTokenEncoder: Symbol.for('ValetTokenEncoder'),
+  WebSocketConnectionTokenEncoder: Symbol.for('WebSocketConnectionTokenEncoder'),
+  WebSocketConnectionTokenDecoder: Symbol.for('WebSocketConnectionTokenDecoder'),
   AuthenticationMethodResolver: Symbol.for('AuthenticationMethodResolver'),
   DomainEventPublisher: Symbol.for('DomainEventPublisher'),
   DomainEventSubscriberFactory: Symbol.for('DomainEventSubscriberFactory'),
@@ -188,6 +193,7 @@ const TYPES = {
   UserSubscriptionService: Symbol.for('UserSubscriptionService'),
   AnalyticsStore: Symbol.for('AnalyticsStore'),
   StatisticsStore: Symbol.for('StatisticsStore'),
+  UuidValidator: Symbol.for('UuidValidator'),
 }
 
 export default TYPES

packages/auth/src/Controller/InternalController.spec.ts

@@ -7,23 +7,16 @@ import { results } from 'inversify-express-utils'
 import { User } from '../Domain/User/User'
 import { GetUserFeatures } from '../Domain/UseCase/GetUserFeatures/GetUserFeatures'
 import { GetSetting } from '../Domain/UseCase/GetSetting/GetSetting'
-import { MuteFailedBackupsEmails } from '../Domain/UseCase/MuteFailedBackupsEmails/MuteFailedBackupsEmails'
-import { MuteSignInEmails } from '../Domain/UseCase/MuteSignInEmails/MuteSignInEmails'
-import { MuteMarketingEmails } from '../Domain/UseCase/MuteMarketingEmails/MuteMarketingEmails'
 
 describe('InternalController', () => {
   let getUserFeatures: GetUserFeatures
   let getSetting: GetSetting
-  let muteFailedBackupsEmails: MuteFailedBackupsEmails
-  let muteSignInEmails: MuteSignInEmails
-  let muteMarketingEmails: MuteMarketingEmails
 
   let request: express.Request
   let response: express.Response
   let user: User
 
-  const createController = () =>
-    new InternalController(getUserFeatures, getSetting, muteFailedBackupsEmails, muteSignInEmails, muteMarketingEmails)
+  const createController = () => new InternalController(getUserFeatures, getSetting)
 
   beforeEach(() => {
     user = {} as jest.Mocked<User>
@@ -35,15 +28,6 @@ describe('InternalController', () => {
     getSetting = {} as jest.Mocked<GetSetting>
     getSetting.execute = jest.fn()
 
-    muteFailedBackupsEmails = {} as jest.Mocked<MuteFailedBackupsEmails>
-    muteFailedBackupsEmails.execute = jest.fn()
-
-    muteSignInEmails = {} as jest.Mocked<MuteSignInEmails>
-    muteSignInEmails.execute = jest.fn()
-
-    muteMarketingEmails = {} as jest.Mocked<MuteMarketingEmails>
-    muteMarketingEmails.execute = jest.fn()
-
     request = {
       headers: {},
       body: {},
@@ -120,83 +104,4 @@ describe('InternalController', () => {
 
     expect(result.statusCode).toEqual(400)
   })
-
-  it('should mute failed backup emails user setting', async () => {
-    request.params.settingUuid = '1-2-3'
-
-    muteFailedBackupsEmails.execute = jest.fn().mockReturnValue({ success: true })
-
-    const httpResponse = <results.JsonResult>await createController().muteFailedBackupsEmails(request)
-    const result = await httpResponse.executeAsync()
-
-    expect(muteFailedBackupsEmails.execute).toHaveBeenCalledWith({ settingUuid: '1-2-3' })
-
-    expect(result.statusCode).toEqual(200)
-  })
-
-  it('should not mute failed backup emails user setting if it does not exist', async () => {
-    request.params.settingUuid = '1-2-3'
-
-    muteFailedBackupsEmails.execute = jest.fn().mockReturnValue({ success: false })
-
-    const httpResponse = <results.JsonResult>await createController().muteFailedBackupsEmails(request)
-    const result = await httpResponse.executeAsync()
-
-    expect(muteFailedBackupsEmails.execute).toHaveBeenCalledWith({ settingUuid: '1-2-3' })
-
-    expect(result.statusCode).toEqual(404)
-  })
-
-  it('should mute sign in emails user setting', async () => {
-    request.params.settingUuid = '1-2-3'
-
-    muteSignInEmails.execute = jest.fn().mockReturnValue({ success: true })
-
-    const httpResponse = <results.JsonResult>await createController().muteSignInEmails(request)
-    const result = await httpResponse.executeAsync()
-
-    expect(muteSignInEmails.execute).toHaveBeenCalledWith({ settingUuid: '1-2-3' })
-
-    expect(result.statusCode).toEqual(200)
-  })
-
-  it('should not mute sign in emails user setting if it does not exist', async () => {
-    request.params.settingUuid = '1-2-3'
-
-    muteSignInEmails.execute = jest.fn().mockReturnValue({ success: false })
-
-    const httpResponse = <results.JsonResult>await createController().muteSignInEmails(request)
-    const result = await httpResponse.executeAsync()
-
-    expect(muteSignInEmails.execute).toHaveBeenCalledWith({ settingUuid: '1-2-3' })
-
-    expect(result.statusCode).toEqual(404)
-  })
-
-  it('should mute marketing emails user setting', async () => {
-    request.params.settingUuid = '1-2-3'
-
-    muteMarketingEmails.execute = jest.fn().mockReturnValue({ success: true, message: 'foobar' })
-
-    await createController().muteMarketingEmails(request, response)
-
-    expect(muteMarketingEmails.execute).toHaveBeenCalledWith({ settingUuid: '1-2-3' })
-
-    expect(response.setHeader).toHaveBeenCalledWith('content-type', 'text/html')
-    expect(response.send).toHaveBeenCalledWith('foobar')
-  })
-
-  it('should not mute marketing emails user setting if it does not exist', async () => {
-    request.params.settingUuid = '1-2-3'
-
-    muteMarketingEmails.execute = jest.fn().mockReturnValue({ success: false, message: 'foobar' })
-
-    await createController().muteMarketingEmails(request, response)
-
-    expect(muteMarketingEmails.execute).toHaveBeenCalledWith({ settingUuid: '1-2-3' })
-
-    expect(response.setHeader).toHaveBeenCalledWith('content-type', 'text/html')
-    expect(response.status).toHaveBeenCalledWith(404)
-    expect(response.send).toHaveBeenCalledWith('foobar')
-  })
 })

packages/auth/src/Controller/InternalController.ts

@@ -1,4 +1,4 @@
-import { Request, Response } from 'express'
+import { Request } from 'express'
 import { inject } from 'inversify'
 import {
   BaseHttpController,
@@ -10,18 +10,12 @@ import {
 import TYPES from '../Bootstrap/Types'
 import { GetSetting } from '../Domain/UseCase/GetSetting/GetSetting'
 import { GetUserFeatures } from '../Domain/UseCase/GetUserFeatures/GetUserFeatures'
-import { MuteFailedBackupsEmails } from '../Domain/UseCase/MuteFailedBackupsEmails/MuteFailedBackupsEmails'
-import { MuteMarketingEmails } from '../Domain/UseCase/MuteMarketingEmails/MuteMarketingEmails'
-import { MuteSignInEmails } from '../Domain/UseCase/MuteSignInEmails/MuteSignInEmails'
 
 @controller('/internal')
 export class InternalController extends BaseHttpController {
   constructor(
     @inject(TYPES.GetUserFeatures) private doGetUserFeatures: GetUserFeatures,
     @inject(TYPES.GetSetting) private doGetSetting: GetSetting,
-    @inject(TYPES.MuteFailedBackupsEmails) private doMuteFailedBackupsEmails: MuteFailedBackupsEmails,
-    @inject(TYPES.MuteSignInEmails) private doMuteSignInEmails: MuteSignInEmails,
-    @inject(TYPES.MuteMarketingEmails) private doMuteMarketingEmails: MuteMarketingEmails,
   ) {
     super()
   }
@@ -54,50 +48,4 @@ export class InternalController extends BaseHttpController {
 
     return this.json(result, 400)
   }
-
-  @httpGet('/settings/email_backup/:settingUuid/mute')
-  async muteFailedBackupsEmails(request: Request): Promise<results.JsonResult> {
-    const { settingUuid } = request.params
-    const result = await this.doMuteFailedBackupsEmails.execute({
-      settingUuid,
-    })
-
-    if (result.success) {
-      return this.json({ message: result.message })
-    }
-
-    return this.json({ message: result.message }, 404)
-  }
-
-  @httpGet('/settings/sign_in/:settingUuid/mute')
-  async muteSignInEmails(request: Request): Promise<results.JsonResult> {
-    const { settingUuid } = request.params
-    const result = await this.doMuteSignInEmails.execute({
-      settingUuid,
-    })
-
-    if (result.success) {
-      return this.json({ message: result.message })
-    }
-
-    return this.json({ message: result.message }, 404)
-  }
-
-  @httpGet('/settings/marketing-emails/:settingUuid/mute')
-  async muteMarketingEmails(request: Request, response: Response): Promise<void> {
-    const { settingUuid } = request.params
-    const result = await this.doMuteMarketingEmails.execute({
-      settingUuid,
-    })
-
-    response.setHeader('content-type', 'text/html')
-
-    if (result.success) {
-      response.send(result.message)
-
-      return
-    }
-
-    response.status(404).send(result.message)
-  }
 }

packages/auth/src/Controller/SessionsController.spec.ts

@@ -9,43 +9,25 @@ import { ProjectorInterface } from '../Projection/ProjectorInterface'
 import { GetActiveSessionsForUser } from '../Domain/UseCase/GetActiveSessionsForUser'
 import { AuthenticateRequest } from '../Domain/UseCase/AuthenticateRequest'
 import { User } from '../Domain/User/User'
-import { Role } from '../Domain/Role/Role'
-import { CrossServiceTokenData, TokenEncoderInterface } from '@standardnotes/security'
-import { GetUserAnalyticsId } from '../Domain/UseCase/GetUserAnalyticsId/GetUserAnalyticsId'
+import { CreateCrossServiceToken } from '../Domain/UseCase/CreateCrossServiceToken/CreateCrossServiceToken'
 
 describe('SessionsController', () => {
   let getActiveSessionsForUser: GetActiveSessionsForUser
   let authenticateRequest: AuthenticateRequest
-  let userProjector: ProjectorInterface<User>
-  let tokenEncoder: TokenEncoderInterface<CrossServiceTokenData>
-  const jwtTTL = 60
   let sessionProjector: ProjectorInterface<Session>
-  let roleProjector: ProjectorInterface<Role>
   let session: Session
   let request: express.Request
   let response: express.Response
   let user: User
-  let role: Role
-  let getUserAnalyticsId: GetUserAnalyticsId
+  let createCrossServiceToken: CreateCrossServiceToken
 
   const createController = () =>
-    new SessionsController(
-      getActiveSessionsForUser,
-      authenticateRequest,
-      userProjector,
-      sessionProjector,
-      roleProjector,
-      tokenEncoder,
-      getUserAnalyticsId,
-      true,
-      jwtTTL,
-    )
+    new SessionsController(getActiveSessionsForUser, authenticateRequest, sessionProjector, createCrossServiceToken)
 
   beforeEach(() => {
     session = {} as jest.Mocked<Session>
 
     user = {} as jest.Mocked<User>
-    user.roles = Promise.resolve([role])
 
     getActiveSessionsForUser = {} as jest.Mocked<GetActiveSessionsForUser>
     getActiveSessionsForUser.execute = jest.fn().mockReturnValue({ sessions: [session] })
@@ -53,21 +35,11 @@ describe('SessionsController', () => {
     authenticateRequest = {} as jest.Mocked<AuthenticateRequest>
     authenticateRequest.execute = jest.fn()
 
-    userProjector = {} as jest.Mocked<ProjectorInterface<User>>
-    userProjector.projectSimple = jest.fn().mockReturnValue({ bar: 'baz' })
-
-    roleProjector = {} as jest.Mocked<ProjectorInterface<Role>>
-    roleProjector.projectSimple = jest.fn().mockReturnValue({ name: 'role1', uuid: '1-3-4' })
-
     sessionProjector = {} as jest.Mocked<ProjectorInterface<Session>>
     sessionProjector.projectCustom = jest.fn().mockReturnValue({ foo: 'bar' })
-    sessionProjector.projectSimple = jest.fn().mockReturnValue({ test: 'test' })
 
-    tokenEncoder = {} as jest.Mocked<TokenEncoderInterface<CrossServiceTokenData>>
-    tokenEncoder.encodeExpirableToken = jest.fn().mockReturnValue('foobar')
-
-    getUserAnalyticsId = {} as jest.Mocked<GetUserAnalyticsId>
-    getUserAnalyticsId.execute = jest.fn().mockReturnValue({ analyticsId: 123 })
+    createCrossServiceToken = {} as jest.Mocked<CreateCrossServiceToken>
+    createCrossServiceToken.execute = jest.fn().mockReturnValue({ token: 'foobar' })
 
     request = {
       params: {},
@@ -114,75 +86,6 @@ describe('SessionsController', () => {
     const httpResponseContent = await result.content.readAsStringAsync()
     const httpResponseJSON = JSON.parse(httpResponseContent)
 
-    expect(tokenEncoder.encodeExpirableToken).toHaveBeenCalledWith(
-      {
-        analyticsId: 123,
-        roles: [
-          {
-            name: 'role1',
-            uuid: '1-3-4',
-          },
-        ],
-        session: {
-          test: 'test',
-        },
-        user: {
-          bar: 'baz',
-        },
-      },
-      60,
-    )
-
-    expect(httpResponseJSON.authToken).toEqual('foobar')
-  })
-
-  it('should validate a session from an incoming request - disabled analytics', async () => {
-    authenticateRequest.execute = jest.fn().mockReturnValue({
-      success: true,
-      user,
-      session,
-    })
-
-    request.headers.authorization = 'test'
-
-    const controller = new SessionsController(
-      getActiveSessionsForUser,
-      authenticateRequest,
-      userProjector,
-      sessionProjector,
-      roleProjector,
-      tokenEncoder,
-      getUserAnalyticsId,
-      false,
-      jwtTTL,
-    )
-
-    const httpResponse = await controller.validate(request)
-
-    expect(httpResponse).toBeInstanceOf(results.JsonResult)
-
-    const result = await httpResponse.executeAsync()
-    const httpResponseContent = await result.content.readAsStringAsync()
-    const httpResponseJSON = JSON.parse(httpResponseContent)
-
-    expect(tokenEncoder.encodeExpirableToken).toHaveBeenCalledWith(
-      {
-        roles: [
-          {
-            name: 'role1',
-            uuid: '1-3-4',
-          },
-        ],
-        session: {
-          test: 'test',
-        },
-        user: {
-          bar: 'baz',
-        },
-      },
-      60,
-    )
-
     expect(httpResponseJSON.authToken).toEqual('foobar')
   })
 

packages/auth/src/Controller/SessionsController.ts

@@ -12,26 +12,18 @@ import TYPES from '../Bootstrap/Types'
 import { Session } from '../Domain/Session/Session'
 import { AuthenticateRequest } from '../Domain/UseCase/AuthenticateRequest'
 import { GetActiveSessionsForUser } from '../Domain/UseCase/GetActiveSessionsForUser'
-import { Role } from '../Domain/Role/Role'
 import { User } from '../Domain/User/User'
 import { ProjectorInterface } from '../Projection/ProjectorInterface'
 import { SessionProjector } from '../Projection/SessionProjector'
-import { CrossServiceTokenData, TokenEncoderInterface } from '@standardnotes/security'
-import { RoleName } from '@standardnotes/common'
-import { GetUserAnalyticsId } from '../Domain/UseCase/GetUserAnalyticsId/GetUserAnalyticsId'
+import { CreateCrossServiceToken } from '../Domain/UseCase/CreateCrossServiceToken/CreateCrossServiceToken'
 
 @controller('/sessions')
 export class SessionsController extends BaseHttpController {
   constructor(
     @inject(TYPES.GetActiveSessionsForUser) private getActiveSessionsForUser: GetActiveSessionsForUser,
     @inject(TYPES.AuthenticateRequest) private authenticateRequest: AuthenticateRequest,
-    @inject(TYPES.UserProjector) private userProjector: ProjectorInterface<User>,
     @inject(TYPES.SessionProjector) private sessionProjector: ProjectorInterface<Session>,
-    @inject(TYPES.RoleProjector) private roleProjector: ProjectorInterface<Role>,
-    @inject(TYPES.CrossServiceTokenEncoder) private tokenEncoder: TokenEncoderInterface<CrossServiceTokenData>,
-    @inject(TYPES.GetUserAnalyticsId) private getUserAnalyticsId: GetUserAnalyticsId,
-    @inject(TYPES.ANALYTICS_ENABLED) private analyticsEnabled: boolean,
-    @inject(TYPES.AUTH_JWT_TTL) private jwtTTL: number,
+    @inject(TYPES.CreateCrossServiceToken) private createCrossServiceToken: CreateCrossServiceToken,
   ) {
     super()
   }
@@ -56,25 +48,12 @@ export class SessionsController extends BaseHttpController {
 
     const user = authenticateRequestResponse.user as User
 
-    const roles = await user.roles
+    const result = await this.createCrossServiceToken.execute({
+      user,
+      session: authenticateRequestResponse.session,
+    })
 
-    const authTokenData: CrossServiceTokenData = {
-      user: this.projectUser(user),
-      roles: this.projectRoles(roles),
-    }
-
-    if (this.analyticsEnabled) {
-      const { analyticsId } = await this.getUserAnalyticsId.execute({ userUuid: user.uuid })
-      authTokenData.analyticsId = analyticsId
-    }
-
-    if (authenticateRequestResponse.session !== undefined) {
-      authTokenData.session = this.projectSession(authenticateRequestResponse.session)
-    }
-
-    const authToken = this.tokenEncoder.encodeExpirableToken(authTokenData, this.jwtTTL)
-
-    return this.json({ authToken })
+    return this.json({ authToken: result.token })
   }
 
   @httpGet('/', TYPES.AuthMiddleware, TYPES.SessionMiddleware)
@@ -93,36 +72,4 @@ export class SessionsController extends BaseHttpController {
       ),
     )
   }
-
-  private projectUser(user: User): { uuid: string; email: string } {
-    return <{ uuid: string; email: string }>this.userProjector.projectSimple(user)
-  }
-
-  private projectSession(session: Session): {
-    uuid: string
-    api_version: string
-    created_at: string
-    updated_at: string
-    device_info: string
-    readonly_access: boolean
-    access_expiration: string
-    refresh_expiration: string
-  } {
-    return <
-      {
-        uuid: string
-        api_version: string
-        created_at: string
-        updated_at: string
-        device_info: string
-        readonly_access: boolean
-        access_expiration: string
-        refresh_expiration: string
-      }
-    >this.sessionProjector.projectSimple(session)
-  }
-
-  private projectRoles(roles: Array<Role>): Array<{ uuid: string; name: RoleName }> {
-    return roles.map((role) => <{ uuid: string; name: RoleName }>this.roleProjector.projectSimple(role))
-  }
 }

packages/auth/src/Controller/SubscriptionInvitesController.spec.ts

@@ -1,16 +1,13 @@
 import 'reflect-metadata'
 
-import * as express from 'express'
-
 import { SubscriptionInvitesController } from './SubscriptionInvitesController'
-import { results } from 'inversify-express-utils'
 import { User } from '../Domain/User/User'
 import { InviteToSharedSubscription } from '../Domain/UseCase/InviteToSharedSubscription/InviteToSharedSubscription'
 import { AcceptSharedSubscriptionInvitation } from '../Domain/UseCase/AcceptSharedSubscriptionInvitation/AcceptSharedSubscriptionInvitation'
 import { DeclineSharedSubscriptionInvitation } from '../Domain/UseCase/DeclineSharedSubscriptionInvitation/DeclineSharedSubscriptionInvitation'
 import { CancelSharedSubscriptionInvitation } from '../Domain/UseCase/CancelSharedSubscriptionInvitation/CancelSharedSubscriptionInvitation'
-import { RoleName } from '@standardnotes/common'
 import { ListSharedSubscriptionInvitations } from '../Domain/UseCase/ListSharedSubscriptionInvitations/ListSharedSubscriptionInvitations'
+import { ApiVersion } from '@standardnotes/api'
 
 describe('SubscriptionInvitesController', () => {
   let inviteToSharedSubscription: InviteToSharedSubscription
@@ -19,8 +16,6 @@ describe('SubscriptionInvitesController', () => {
   let cancelSharedSubscriptionInvitation: CancelSharedSubscriptionInvitation
   let listSharedSubscriptionInvitations: ListSharedSubscriptionInvitations
 
-  let request: express.Request
-  let response: express.Response
   let user: User
 
   const createController = () =>
@@ -51,25 +46,6 @@ describe('SubscriptionInvitesController', () => {
 
     listSharedSubscriptionInvitations = {} as jest.Mocked<ListSharedSubscriptionInvitations>
     listSharedSubscriptionInvitations.execute = jest.fn()
-
-    request = {
-      headers: {},
-      body: {},
-      params: {},
-    } as jest.Mocked<express.Request>
-
-    response = {
-      locals: {},
-    } as jest.Mocked<express.Response>
-    response.locals.user = {
-      email: 'test@test.te',
-    }
-    response.locals.roles = [
-      {
-        uuid: '1-2-3',
-        name: RoleName.CoreUser,
-      },
-    ]
   })
 
   it('should get invitations to subscription sharing', async () => {
@@ -77,128 +53,127 @@ describe('SubscriptionInvitesController', () => {
       invitations: [],
     })
 
-    const httpResponse = <results.JsonResult>await createController().listInvites(request, response)
-    const result = await httpResponse.executeAsync()
+    const result = await createController().listInvites({ api: ApiVersion.v0, inviterEmail: 'test@test.te' })
 
     expect(listSharedSubscriptionInvitations.execute).toHaveBeenCalledWith({
       inviterEmail: 'test@test.te',
     })
 
-    expect(result.statusCode).toEqual(200)
+    expect(result.status).toEqual(200)
   })
 
   it('should cancel invitation to subscription sharing', async () => {
-    request.params.inviteUuid = '1-2-3'
-
     cancelSharedSubscriptionInvitation.execute = jest.fn().mockReturnValue({
       success: true,
     })
 
-    const httpResponse = <results.JsonResult>await createController().cancelSubscriptionSharing(request, response)
-    const result = await httpResponse.executeAsync()
+    const result = await createController().cancelInvite({
+      api: ApiVersion.v0,
+      inviteUuid: '1-2-3',
+      inviterEmail: 'test@test.te',
+    })
 
     expect(cancelSharedSubscriptionInvitation.execute).toHaveBeenCalledWith({
       sharedSubscriptionInvitationUuid: '1-2-3',
       inviterEmail: 'test@test.te',
     })
 
-    expect(result.statusCode).toEqual(200)
+    expect(result.status).toEqual(200)
   })
 
   it('should not cancel invitation to subscription sharing if the workflow fails', async () => {
-    request.params.inviteUuid = '1-2-3'
-
     cancelSharedSubscriptionInvitation.execute = jest.fn().mockReturnValue({
       success: false,
     })
 
-    const httpResponse = <results.JsonResult>await createController().cancelSubscriptionSharing(request, response)
-    const result = await httpResponse.executeAsync()
+    const result = await createController().cancelInvite({
+      api: ApiVersion.v0,
+      inviteUuid: '1-2-3',
+    })
 
-    expect(result.statusCode).toEqual(400)
+    expect(result.status).toEqual(400)
   })
 
   it('should decline invitation to subscription sharing', async () => {
-    request.params.inviteUuid = '1-2-3'
-
     declineSharedSubscriptionInvitation.execute = jest.fn().mockReturnValue({
       success: true,
     })
 
-    const httpResponse = <results.JsonResult>await createController().declineInvite(request)
-    const result = await httpResponse.executeAsync()
+    const result = await createController().declineInvite({
+      api: ApiVersion.v0,
+      inviteUuid: '1-2-3',
+    })
 
     expect(declineSharedSubscriptionInvitation.execute).toHaveBeenCalledWith({
       sharedSubscriptionInvitationUuid: '1-2-3',
     })
 
-    expect(result.statusCode).toEqual(200)
+    expect(result.status).toEqual(200)
   })
 
   it('should not decline invitation to subscription sharing if the workflow fails', async () => {
-    request.params.inviteUuid = '1-2-3'
-
     declineSharedSubscriptionInvitation.execute = jest.fn().mockReturnValue({
       success: false,
     })
 
-    const httpResponse = <results.JsonResult>await createController().declineInvite(request)
-    const result = await httpResponse.executeAsync()
+    const result = await createController().declineInvite({
+      api: ApiVersion.v0,
+      inviteUuid: '1-2-3',
+    })
 
     expect(declineSharedSubscriptionInvitation.execute).toHaveBeenCalledWith({
       sharedSubscriptionInvitationUuid: '1-2-3',
     })
 
-    expect(result.statusCode).toEqual(400)
+    expect(result.status).toEqual(400)
   })
 
   it('should accept invitation to subscription sharing', async () => {
-    request.params.inviteUuid = '1-2-3'
-
     acceptSharedSubscriptionInvitation.execute = jest.fn().mockReturnValue({
       success: true,
     })
 
-    const httpResponse = <results.JsonResult>await createController().acceptInvite(request)
-    const result = await httpResponse.executeAsync()
+    const result = await createController().acceptInvite({
+      api: ApiVersion.v0,
+      inviteUuid: '1-2-3',
+    })
 
     expect(acceptSharedSubscriptionInvitation.execute).toHaveBeenCalledWith({
       sharedSubscriptionInvitationUuid: '1-2-3',
     })
 
-    expect(result.statusCode).toEqual(200)
+    expect(result.status).toEqual(200)
   })
 
   it('should not accept invitation to subscription sharing if the workflow fails', async () => {
-    request.params.inviteUuid = '1-2-3'
-
     acceptSharedSubscriptionInvitation.execute = jest.fn().mockReturnValue({
       success: false,
     })
 
-    const httpResponse = <results.JsonResult>await createController().acceptInvite(request)
-    const result = await httpResponse.executeAsync()
+    const result = await createController().acceptInvite({
+      api: ApiVersion.v0,
+      inviteUuid: '1-2-3',
+    })
 
     expect(acceptSharedSubscriptionInvitation.execute).toHaveBeenCalledWith({
       sharedSubscriptionInvitationUuid: '1-2-3',
     })
 
-    expect(result.statusCode).toEqual(400)
+    expect(result.status).toEqual(400)
   })
 
   it('should invite to user subscription', async () => {
-    request.body.identifier = 'invitee@test.te'
-    response.locals.user = {
-      uuid: '1-2-3',
-      email: 'test@test.te',
-    }
-
     inviteToSharedSubscription.execute = jest.fn().mockReturnValue({
       success: true,
     })
 
-    const httpResponse = <results.JsonResult>await createController().inviteToSubscriptionSharing(request, response)
-    const result = await httpResponse.executeAsync()
+    const result = await createController().invite({
+      api: ApiVersion.v0,
+      identifier: 'invitee@test.te',
+      inviterUuid: '1-2-3',
+      inviterEmail: 'test@test.te',
+      inviterRoles: ['CORE_USER'],
+    })
 
     expect(inviteToSharedSubscription.execute).toHaveBeenCalledWith({
       inviterEmail: 'test@test.te',
@@ -207,37 +182,36 @@ describe('SubscriptionInvitesController', () => {
       inviterRoles: ['CORE_USER'],
     })
 
-    expect(result.statusCode).toEqual(200)
+    expect(result.status).toEqual(200)
   })
 
   it('should not invite to user subscription if the identifier is missing in request', async () => {
-    response.locals.user = {
-      uuid: '1-2-3',
-      email: 'test@test.te',
-    }
-
-    const httpResponse = <results.JsonResult>await createController().inviteToSubscriptionSharing(request, response)
-    const result = await httpResponse.executeAsync()
+    const result = await createController().invite({
+      api: ApiVersion.v0,
+      identifier: '',
+      inviterUuid: '1-2-3',
+      inviterEmail: 'test@test.te',
+      inviterRoles: ['CORE_USER'],
+    })
 
     expect(inviteToSharedSubscription.execute).not.toHaveBeenCalled()
 
-    expect(result.statusCode).toEqual(400)
+    expect(result.status).toEqual(400)
   })
 
   it('should not invite to user subscription if the workflow does not run', async () => {
-    request.body.identifier = 'invitee@test.te'
-    response.locals.user = {
-      uuid: '1-2-3',
-      email: 'test@test.te',
-    }
-
     inviteToSharedSubscription.execute = jest.fn().mockReturnValue({
       success: false,
     })
 
-    const httpResponse = <results.JsonResult>await createController().inviteToSubscriptionSharing(request, response)
-    const result = await httpResponse.executeAsync()
+    const result = await createController().invite({
+      api: ApiVersion.v0,
+      identifier: 'invitee@test.te',
+      inviterUuid: '1-2-3',
+      inviterEmail: 'test@test.te',
+      inviterRoles: ['CORE_USER'],
+    })
 
-    expect(result.statusCode).toEqual(400)
+    expect(result.status).toEqual(400)
   })
 })

packages/auth/src/Controller/SubscriptionInvitesController.ts

@@ -1,15 +1,19 @@
-import { Role } from '@standardnotes/security'
-import { Request, Response } from 'express'
-import { inject } from 'inversify'
 import {
-  BaseHttpController,
-  controller,
-  httpDelete,
-  httpGet,
-  httpPost,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  results,
-} from 'inversify-express-utils'
+  HttpStatusCode,
+  SubscriptionInviteAcceptRequestParams,
+  SubscriptionInviteAcceptResponse,
+  SubscriptionInviteCancelRequestParams,
+  SubscriptionInviteCancelResponse,
+  SubscriptionInviteDeclineRequestParams,
+  SubscriptionInviteDeclineResponse,
+  SubscriptionInviteListRequestParams,
+  SubscriptionInviteListResponse,
+  SubscriptionInviteRequestParams,
+  SubscriptionInviteResponse,
+  SubscriptionServerInterface,
+} from '@standardnotes/api'
+import { RoleName } from '@standardnotes/common'
+import { inject, injectable } from 'inversify'
 
 import TYPES from '../Bootstrap/Types'
 import { AcceptSharedSubscriptionInvitation } from '../Domain/UseCase/AcceptSharedSubscriptionInvitation/AcceptSharedSubscriptionInvitation'
@@ -18,8 +22,8 @@ import { DeclineSharedSubscriptionInvitation } from '../Domain/UseCase/DeclineSh
 import { InviteToSharedSubscription } from '../Domain/UseCase/InviteToSharedSubscription/InviteToSharedSubscription'
 import { ListSharedSubscriptionInvitations } from '../Domain/UseCase/ListSharedSubscriptionInvitations/ListSharedSubscriptionInvitations'
 
-@controller('/subscription-invites')
-export class SubscriptionInvitesController extends BaseHttpController {
+@injectable()
+export class SubscriptionInvitesController implements SubscriptionServerInterface {
   constructor(
     @inject(TYPES.InviteToSharedSubscription) private inviteToSharedSubscription: InviteToSharedSubscription,
     @inject(TYPES.AcceptSharedSubscriptionInvitation)
@@ -30,75 +34,103 @@ export class SubscriptionInvitesController extends BaseHttpController {
     private cancelSharedSubscriptionInvitation: CancelSharedSubscriptionInvitation,
     @inject(TYPES.ListSharedSubscriptionInvitations)
     private listSharedSubscriptionInvitations: ListSharedSubscriptionInvitations,
-  ) {
-    super()
-  }
+  ) {}
 
-  @httpGet('/:inviteUuid/accept')
-  async acceptInvite(request: Request): Promise<results.JsonResult> {
+  async acceptInvite(params: SubscriptionInviteAcceptRequestParams): Promise<SubscriptionInviteAcceptResponse> {
     const result = await this.acceptSharedSubscriptionInvitation.execute({
-      sharedSubscriptionInvitationUuid: request.params.inviteUuid,
+      sharedSubscriptionInvitationUuid: params.inviteUuid,
     })
 
     if (result.success) {
-      return this.json(result)
+      return {
+        status: HttpStatusCode.Success,
+        data: result,
+      }
     }
 
-    return this.json(result, 400)
+    return {
+      status: HttpStatusCode.BadRequest,
+      data: result,
+    }
   }
 
-  @httpGet('/:inviteUuid/decline')
-  async declineInvite(request: Request): Promise<results.JsonResult> {
+  async declineInvite(params: SubscriptionInviteDeclineRequestParams): Promise<SubscriptionInviteDeclineResponse> {
     const result = await this.declineSharedSubscriptionInvitation.execute({
-      sharedSubscriptionInvitationUuid: request.params.inviteUuid,
+      sharedSubscriptionInvitationUuid: params.inviteUuid,
     })
 
     if (result.success) {
-      return this.json(result)
+      return {
+        status: HttpStatusCode.Success,
+        data: result,
+      }
     }
 
-    return this.json(result, 400)
+    return {
+      status: HttpStatusCode.BadRequest,
+      data: result,
+    }
   }
 
-  @httpPost('/', TYPES.ApiGatewayAuthMiddleware)
-  async inviteToSubscriptionSharing(request: Request, response: Response): Promise<results.JsonResult> {
-    if (!request.body.identifier) {
-      return this.json({ error: { message: 'Missing invitee identifier' } }, 400)
+  async invite(params: SubscriptionInviteRequestParams): Promise<SubscriptionInviteResponse> {
+    if (!params.identifier) {
+      return {
+        status: HttpStatusCode.BadRequest,
+        data: {
+          error: {
+            message: 'Missing invitee identifier',
+          },
+        },
+      }
     }
+
     const result = await this.inviteToSharedSubscription.execute({
-      inviterEmail: response.locals.user.email,
-      inviterUuid: response.locals.user.uuid,
-      inviteeIdentifier: request.body.identifier,
-      inviterRoles: response.locals.roles.map((role: Role) => role.name),
+      inviterEmail: params.inviterEmail as string,
+      inviterUuid: params.inviterUuid as string,
+      inviteeIdentifier: params.identifier,
+      inviterRoles: params.inviterRoles as RoleName[],
     })
 
     if (result.success) {
-      return this.json(result)
+      return {
+        status: HttpStatusCode.Success,
+        data: result,
+      }
     }
 
-    return this.json(result, 400)
+    return {
+      status: HttpStatusCode.BadRequest,
+      data: result,
+    }
   }
 
-  @httpDelete('/:inviteUuid', TYPES.ApiGatewayAuthMiddleware)
-  async cancelSubscriptionSharing(request: Request, response: Response): Promise<results.JsonResult> {
+  async cancelInvite(params: SubscriptionInviteCancelRequestParams): Promise<SubscriptionInviteCancelResponse> {
     const result = await this.cancelSharedSubscriptionInvitation.execute({
-      sharedSubscriptionInvitationUuid: request.params.inviteUuid,
-      inviterEmail: response.locals.user.email,
+      sharedSubscriptionInvitationUuid: params.inviteUuid,
+      inviterEmail: params.inviterEmail as string,
     })
 
     if (result.success) {
-      return this.json(result)
+      return {
+        status: HttpStatusCode.Success,
+        data: result,
+      }
     }
 
-    return this.json(result, 400)
+    return {
+      status: HttpStatusCode.BadRequest,
+      data: result,
+    }
   }
 
-  @httpGet('/', TYPES.ApiGatewayAuthMiddleware)
-  async listInvites(_request: Request, response: Response): Promise<results.JsonResult> {
+  async listInvites(params: SubscriptionInviteListRequestParams): Promise<SubscriptionInviteListResponse> {
     const result = await this.listSharedSubscriptionInvitations.execute({
-      inviterEmail: response.locals.user.email,
+      inviterEmail: params.inviterEmail as string,
     })
 
-    return this.json(result)
+    return {
+      status: HttpStatusCode.Success,
+      data: result,
+    }
   }
 }

packages/auth/src/Controller/ValetTokenController.spec.ts

@@ -4,18 +4,23 @@ import { Request, Response } from 'express'
 import { results } from 'inversify-express-utils'
 import { ValetTokenController } from './ValetTokenController'
 import { CreateValetToken } from '../Domain/UseCase/CreateValetToken/CreateValetToken'
+import { Uuid, ValidatorInterface } from '@standardnotes/common'
 
 describe('ValetTokenController', () => {
   let createValetToken: CreateValetToken
+  let uuidValidator: ValidatorInterface<Uuid>
   let request: Request
   let response: Response
 
-  const createController = () => new ValetTokenController(createValetToken)
+  const createController = () => new ValetTokenController(createValetToken, uuidValidator)
 
   beforeEach(() => {
     createValetToken = {} as jest.Mocked<CreateValetToken>
     createValetToken.execute = jest.fn().mockReturnValue({ success: true, valetToken: 'foobar' })
 
+    uuidValidator = {} as jest.Mocked<ValidatorInterface<Uuid>>
+    uuidValidator.validate = jest.fn().mockReturnValue(true)
+
     request = {
       body: {
         operation: 'write',
@@ -42,6 +47,17 @@ describe('ValetTokenController', () => {
     expect(await result.content.readAsStringAsync()).toEqual('{"success":true,"valetToken":"foobar"}')
   })
 
+  it('should not create a valet token if the remote resource identifier is not a valid uuid', async () => {
+    uuidValidator.validate = jest.fn().mockReturnValue(false)
+
+    const httpResponse = <results.JsonResult>await createController().create(request, response)
+    const result = await httpResponse.executeAsync()
+
+    expect(createValetToken.execute).not.toHaveBeenCalled()
+
+    expect(result.statusCode).toEqual(400)
+  })
+
   it('should create a read valet token for read only access session', async () => {
     response.locals.readOnlyAccess = true
     request.body.operation = 'read'

packages/auth/src/Controller/ValetTokenController.ts

@@ -11,11 +11,15 @@ import { CreateValetTokenPayload } from '@standardnotes/responses'
 
 import TYPES from '../Bootstrap/Types'
 import { CreateValetToken } from '../Domain/UseCase/CreateValetToken/CreateValetToken'
-import { ErrorTag } from '@standardnotes/common'
+import { ErrorTag, Uuid, ValidatorInterface } from '@standardnotes/common'
+import { ValetTokenOperation } from '@standardnotes/security'
 
 @controller('/valet-tokens', TYPES.ApiGatewayAuthMiddleware)
 export class ValetTokenController extends BaseHttpController {
-  constructor(@inject(TYPES.CreateValetToken) private createValetKey: CreateValetToken) {
+  constructor(
+    @inject(TYPES.CreateValetToken) private createValetKey: CreateValetToken,
+    @inject(TYPES.UuidValidator) private uuidValitor: ValidatorInterface<Uuid>,
+  ) {
     super()
   }
 
@@ -35,9 +39,23 @@ export class ValetTokenController extends BaseHttpController {
       )
     }
 
+    for (const resource of payload.resources) {
+      if (!this.uuidValitor.validate(resource.remoteIdentifier)) {
+        return this.json(
+          {
+            error: {
+              tag: ErrorTag.ParametersInvalid,
+              message: 'Invalid remote resource identifier.',
+            },
+          },
+          400,
+        )
+      }
+    }
+
     const createValetKeyResponse = await this.createValetKey.execute({
       userUuid: response.locals.user.uuid,
-      operation: payload.operation,
+      operation: payload.operation as ValetTokenOperation,
       resources: payload.resources,
     })
 

packages/auth/src/Controller/WebSocketsController.spec.ts

@@ -1,65 +1,28 @@
 import 'reflect-metadata'
 
-import * as express from 'express'
-import { results } from 'inversify-express-utils'
-
-import { AddWebSocketsConnection } from '../Domain/UseCase/AddWebSocketsConnection/AddWebSocketsConnection'
-
 import { WebSocketsController } from './WebSocketsController'
-import { RemoveWebSocketsConnection } from '../Domain/UseCase/RemoveWebSocketsConnection/RemoveWebSocketsConnection'
+import { CreateWebSocketConnectionToken } from '../Domain/UseCase/CreateWebSocketConnectionToken/CreateWebSocketConnectionToken'
 
 describe('WebSocketsController', () => {
-  let addWebSocketsConnection: AddWebSocketsConnection
-  let removeWebSocketsConnection: RemoveWebSocketsConnection
-  let request: express.Request
-  let response: express.Response
+  let createWebSocketConnectionToken: CreateWebSocketConnectionToken
 
-  const createController = () => new WebSocketsController(addWebSocketsConnection, removeWebSocketsConnection)
+  const createController = () => new WebSocketsController(createWebSocketConnectionToken)
 
   beforeEach(() => {
-    addWebSocketsConnection = {} as jest.Mocked<AddWebSocketsConnection>
-    addWebSocketsConnection.execute = jest.fn()
-
-    removeWebSocketsConnection = {} as jest.Mocked<RemoveWebSocketsConnection>
-    removeWebSocketsConnection.execute = jest.fn()
-
-    request = {
-      body: {
-        userUuid: '1-2-3',
-      },
-      params: {},
-      headers: {},
-    } as jest.Mocked<express.Request>
-    request.params.connectionId = '2-3-4'
-
-    response = {
-      locals: {},
-    } as jest.Mocked<express.Response>
-    response.locals.user = {
-      uuid: '1-2-3',
-    }
+    createWebSocketConnectionToken = {} as jest.Mocked<CreateWebSocketConnectionToken>
+    createWebSocketConnectionToken.execute = jest.fn().mockReturnValue({ token: 'foobar' })
   })
 
-  it('should persist an established web sockets connection', async () => {
-    const httpResponse = await createController().storeWebSocketsConnection(request, response)
+  it('should create a web sockets connection token', async () => {
+    const response = await createController().createConnectionToken({ userUuid: '1-2-3' })
 
-    expect(httpResponse).toBeInstanceOf(results.JsonResult)
-    expect((<results.JsonResult>httpResponse).statusCode).toEqual(200)
-
-    expect(addWebSocketsConnection.execute).toHaveBeenCalledWith({
-      userUuid: '1-2-3',
-      connectionId: '2-3-4',
+    expect(response).toEqual({
+      status: 200,
+      data: { token: 'foobar' },
     })
-  })
 
-  it('should remove a disconnected web sockets connection', async () => {
-    const httpResponse = await createController().deleteWebSocketsConnection(request)
-
-    expect(httpResponse).toBeInstanceOf(results.JsonResult)
-    expect((<results.JsonResult>httpResponse).statusCode).toEqual(200)
-
-    expect(removeWebSocketsConnection.execute).toHaveBeenCalledWith({
-      connectionId: '2-3-4',
+    expect(createWebSocketConnectionToken.execute).toHaveBeenCalledWith({
+      userUuid: '1-2-3',
     })
   })
 })

packages/auth/src/Controller/WebSocketsController.ts

@@ -1,45 +1,29 @@
-import { Request, Response } from 'express'
-import { inject } from 'inversify'
 import {
-  BaseHttpController,
-  controller,
-  httpDelete,
-  httpPost,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  results,
-} from 'inversify-express-utils'
+  HttpStatusCode,
+  WebSocketConnectionTokenRequestParams,
+  WebSocketConnectionTokenResponse,
+  WebSocketServerInterface,
+} from '@standardnotes/api'
+import { inject, injectable } from 'inversify'
+
 import TYPES from '../Bootstrap/Types'
-import { AddWebSocketsConnection } from '../Domain/UseCase/AddWebSocketsConnection/AddWebSocketsConnection'
-import { RemoveWebSocketsConnection } from '../Domain/UseCase/RemoveWebSocketsConnection/RemoveWebSocketsConnection'
+import { CreateWebSocketConnectionToken } from '../Domain/UseCase/CreateWebSocketConnectionToken/CreateWebSocketConnectionToken'
 
-@controller('/sockets')
-export class WebSocketsController extends BaseHttpController {
+@injectable()
+export class WebSocketsController implements WebSocketServerInterface {
   constructor(
-    @inject(TYPES.AddWebSocketsConnection) private addWebSocketsConnection: AddWebSocketsConnection,
-    @inject(TYPES.RemoveWebSocketsConnection) private removeWebSocketsConnection: RemoveWebSocketsConnection,
-  ) {
-    super()
-  }
+    @inject(TYPES.CreateWebSocketConnectionToken)
+    private createWebSocketConnectionToken: CreateWebSocketConnectionToken,
+  ) {}
 
-  @httpPost('/:connectionId', TYPES.ApiGatewayAuthMiddleware)
-  async storeWebSocketsConnection(
-    request: Request,
-    response: Response,
-  ): Promise<results.JsonResult | results.BadRequestErrorMessageResult> {
-    await this.addWebSocketsConnection.execute({
-      userUuid: response.locals.user.uuid,
-      connectionId: request.params.connectionId,
-    })
+  async createConnectionToken(
+    params: WebSocketConnectionTokenRequestParams,
+  ): Promise<WebSocketConnectionTokenResponse> {
+    const result = await this.createWebSocketConnectionToken.execute({ userUuid: params.userUuid as string })
 
-    return this.json({ success: true })
-  }
-
-  @httpDelete('/:connectionId')
-  async deleteWebSocketsConnection(
-    request: Request,
-  ): Promise<results.JsonResult | results.BadRequestErrorMessageResult> {
-    await this.removeWebSocketsConnection.execute({ connectionId: request.params.connectionId })
-
-    return this.json({ success: true })
+    return {
+      status: HttpStatusCode.Success,
+      data: result,
+    }
   }
 }

packages/auth/src/Domain/Feature/FeatureService.spec.ts

@@ -82,6 +82,7 @@ describe('FeatureService', () => {
       uuid: 'subscription-1-1-1',
       createdAt: 111,
       updatedAt: 222,
+      renewedAt: null,
       planName: SubscriptionName.PlusPlan,
       endsAt: 555,
       user: Promise.resolve(user),
@@ -95,6 +96,7 @@ describe('FeatureService', () => {
       uuid: 'subscription-2-2-2',
       createdAt: 222,
       updatedAt: 333,
+      renewedAt: null,
       planName: SubscriptionName.ProPlan,
       endsAt: 777,
       user: Promise.resolve(user),
@@ -108,6 +110,7 @@ describe('FeatureService', () => {
       uuid: 'subscription-3-3-3-canceled',
       createdAt: 111,
       updatedAt: 222,
+      renewedAt: null,
       planName: SubscriptionName.PlusPlan,
       endsAt: 333,
       user: Promise.resolve(user),
@@ -121,6 +124,7 @@ describe('FeatureService', () => {
       uuid: 'subscription-4-4-4-canceled',
       createdAt: 111,
       updatedAt: 222,
+      renewedAt: null,
       planName: SubscriptionName.PlusPlan,
       endsAt: 333,
       user: Promise.resolve(user),
@@ -240,6 +244,7 @@ describe('FeatureService', () => {
         uuid: 'subscription-1-1-1',
         createdAt: 111,
         updatedAt: 222,
+        renewedAt: null,
         planName: 'non existing plan name' as SubscriptionName,
         endsAt: 555,
         user: Promise.resolve(user),

packages/auth/src/Domain/Handler/PaymentSuccessEventHandler.spec.ts

@@ -1,7 +1,7 @@
 import 'reflect-metadata'
 
 import { PaymentSuccessEvent } from '@standardnotes/domain-events'
-import { AnalyticsStoreInterface, StatisticsStoreInterface } from '@standardnotes/analytics'
+import { AnalyticsStoreInterface, Period, StatisticsStoreInterface } from '@standardnotes/analytics'
 
 import { PaymentSuccessEventHandler } from './PaymentSuccessEventHandler'
 import { UserRepositoryInterface } from '../User/UserRepositoryInterface'
@@ -38,14 +38,41 @@ describe('PaymentSuccessEventHandler', () => {
     event.payload = {
       userEmail: 'test@test.com',
       amount: 12.45,
+      billingFrequency: 12,
+      paymentType: 'initial',
+      subscriptionName: 'PRO_PLAN',
     }
   })
 
-  it('should mark payment failed for analytics', async () => {
+  it('should mark payment success for analytics', async () => {
     await createHandler().handle(event)
 
     expect(analyticsStore.markActivity).toHaveBeenCalled()
-    expect(statisticsStore.incrementMeasure).toHaveBeenCalled()
+    expect(statisticsStore.incrementMeasure).toHaveBeenNthCalledWith(
+      2,
+      'pro-subscription-initial-annual-payments-income',
+      12.45,
+      [Period.Today, Period.ThisWeek, Period.ThisMonth],
+    )
+  })
+
+  it('should mark non-detailed payment success statistics for analytics', async () => {
+    event.payload = {
+      userEmail: 'test@test.com',
+      amount: 12.45,
+      billingFrequency: 13,
+      paymentType: 'initial',
+      subscriptionName: 'PRO_PLAN',
+    }
+
+    await createHandler().handle(event)
+
+    expect(statisticsStore.incrementMeasure).toBeCalledTimes(1)
+    expect(statisticsStore.incrementMeasure).toHaveBeenNthCalledWith(1, 'income', 12.45, [
+      Period.Today,
+      Period.ThisWeek,
+      Period.ThisMonth,
+    ])
   })
 
   it('should not mark payment failed for analytics if user is not found', async () => {

packages/auth/src/Domain/Handler/PaymentSuccessEventHandler.ts

@@ -5,6 +5,7 @@ import {
   StatisticsMeasure,
   StatisticsStoreInterface,
 } from '@standardnotes/analytics'
+import { PaymentType, SubscriptionBillingFrequency, SubscriptionName } from '@standardnotes/common'
 import { DomainEventHandlerInterface, PaymentSuccessEvent } from '@standardnotes/domain-events'
 import { inject, injectable } from 'inversify'
 
@@ -14,6 +15,47 @@ import { UserRepositoryInterface } from '../User/UserRepositoryInterface'
 
 @injectable()
 export class PaymentSuccessEventHandler implements DomainEventHandlerInterface {
+  private readonly DETAILED_MEASURES = new Map([
+    [
+      SubscriptionName.PlusPlan,
+      new Map([
+        [
+          PaymentType.Initial,
+          new Map([
+            [SubscriptionBillingFrequency.Monthly, StatisticsMeasure.PlusSubscriptionInitialMonthlyPaymentsIncome],
+            [SubscriptionBillingFrequency.Annual, StatisticsMeasure.PlusSubscriptionInitialAnnualPaymentsIncome],
+          ]),
+        ],
+        [
+          PaymentType.Renewal,
+          new Map([
+            [SubscriptionBillingFrequency.Monthly, StatisticsMeasure.PlusSubscriptionRenewingMonthlyPaymentsIncome],
+            [SubscriptionBillingFrequency.Annual, StatisticsMeasure.PlusSubscriptionRenewingAnnualPaymentsIncome],
+          ]),
+        ],
+      ]),
+    ],
+    [
+      SubscriptionName.ProPlan,
+      new Map([
+        [
+          PaymentType.Initial,
+          new Map([
+            [SubscriptionBillingFrequency.Monthly, StatisticsMeasure.ProSubscriptionInitialMonthlyPaymentsIncome],
+            [SubscriptionBillingFrequency.Annual, StatisticsMeasure.ProSubscriptionInitialAnnualPaymentsIncome],
+          ]),
+        ],
+        [
+          PaymentType.Renewal,
+          new Map([
+            [SubscriptionBillingFrequency.Monthly, StatisticsMeasure.ProSubscriptionRenewingMonthlyPaymentsIncome],
+            [SubscriptionBillingFrequency.Annual, StatisticsMeasure.ProSubscriptionRenewingAnnualPaymentsIncome],
+          ]),
+        ],
+      ]),
+    ],
+  ])
+
   constructor(
     @inject(TYPES.UserRepository) private userRepository: UserRepositoryInterface,
     @inject(TYPES.GetUserAnalyticsId) private getUserAnalyticsId: GetUserAnalyticsId,
@@ -34,10 +76,21 @@ export class PaymentSuccessEventHandler implements DomainEventHandlerInterface {
       Period.ThisMonth,
     ])
 
-    await this.statisticsStore.incrementMeasure(StatisticsMeasure.Income, event.payload.amount, [
-      Period.Today,
-      Period.ThisWeek,
-      Period.ThisMonth,
-    ])
+    const statisticMeasures = [StatisticsMeasure.Income]
+
+    const detailedMeasure = this.DETAILED_MEASURES.get(event.payload.subscriptionName as SubscriptionName)
+      ?.get(event.payload.paymentType as PaymentType)
+      ?.get(event.payload.billingFrequency as SubscriptionBillingFrequency)
+    if (detailedMeasure !== undefined) {
+      statisticMeasures.push(detailedMeasure)
+    }
+
+    for (const measure of statisticMeasures) {
+      await this.statisticsStore.incrementMeasure(measure, event.payload.amount, [
+        Period.Today,
+        Period.ThisWeek,
+        Period.ThisMonth,
+      ])
+    }
   }
 }

packages/auth/src/Domain/Handler/PredicateVerificationRequestedEventHandler.spec.ts

@@ -54,6 +54,7 @@ describe('PredicateVerificationRequestedEventHandler', () => {
     logger = {} as jest.Mocked<Logger>
     logger.warn = jest.fn()
     logger.info = jest.fn()
+    logger.debug = jest.fn()
 
     event = {} as jest.Mocked<PredicateVerificationRequestedEvent>
     event.meta = {

packages/auth/src/Domain/Handler/PredicateVerificationRequestedEventHandler.ts

@@ -23,7 +23,7 @@ export class PredicateVerificationRequestedEventHandler implements DomainEventHa
   ) {}
 
   async handle(event: PredicateVerificationRequestedEvent): Promise<void> {
-    this.logger.info(`Received verification request of predicate: ${event.payload.predicate.name}`)
+    this.logger.debug(`Received verification request of predicate: ${event.payload.predicate.name}`)
 
     let userUuid = event.meta.correlation.userIdentifier
     if (event.meta.correlation.userIdentifierType === 'email') {
@@ -55,7 +55,7 @@ export class PredicateVerificationRequestedEventHandler implements DomainEventHa
       }),
     )
 
-    this.logger.info(
+    this.logger.debug(
       `Published predicate verification (${predicateVerificationResult}) result for: ${event.payload.predicate.name}`,
     )
   }

packages/auth/src/Domain/Handler/SubscriptionCancelledEventHandler.spec.ts

@@ -13,7 +13,6 @@ import { GetUserAnalyticsId } from '../UseCase/GetUserAnalyticsId/GetUserAnalyti
 import { UserRepositoryInterface } from '../User/UserRepositoryInterface'
 import { User } from '../User/User'
 import { UserSubscription } from '../Subscription/UserSubscription'
-import { Logger } from 'winston'
 
 describe('SubscriptionCancelledEventHandler', () => {
   let userSubscriptionRepository: UserSubscriptionRepositoryInterface
@@ -24,7 +23,6 @@ describe('SubscriptionCancelledEventHandler', () => {
   let analyticsStore: AnalyticsStoreInterface
   let statisticsStore: StatisticsStoreInterface
   let timestamp: number
-  let logger: Logger
 
   const createHandler = () =>
     new SubscriptionCancelledEventHandler(
@@ -34,7 +32,6 @@ describe('SubscriptionCancelledEventHandler', () => {
       getUserAnalyticsId,
       analyticsStore,
       statisticsStore,
-      logger,
     )
 
   beforeEach(() => {
@@ -75,9 +72,6 @@ describe('SubscriptionCancelledEventHandler', () => {
       offline: false,
       replaced: false,
     }
-
-    logger = {} as jest.Mocked<Logger>
-    logger.info = jest.fn()
   })
 
   it('should update subscription cancelled', async () => {
@@ -93,6 +87,20 @@ describe('SubscriptionCancelledEventHandler', () => {
     ])
   })
 
+  it('should not track statistics for subscriptions that are in a legacy 5 year plan', async () => {
+    event.payload.timestamp = 1642395451516000
+
+    const userSubscription = {
+      createdAt: 1642395451515000,
+      endsAt: 1642395451515000 + 126_230_400_000_001,
+    } as jest.Mocked<UserSubscription>
+    userSubscriptionRepository.findBySubscriptionId = jest.fn().mockReturnValue([userSubscription])
+
+    await createHandler().handle(event)
+
+    expect(statisticsStore.incrementMeasure).not.toHaveBeenCalled()
+  })
+
   it('should update subscription cancelled - user not found', async () => {
     userRepository.findOneByEmail = jest.fn().mockReturnValue(null)
 

packages/auth/src/Domain/Handler/SubscriptionCancelledEventHandler.ts

@@ -14,7 +14,6 @@ import { OfflineUserSubscriptionRepositoryInterface } from '../Subscription/Offl
 import { UserRepositoryInterface } from '../User/UserRepositoryInterface'
 import { GetUserAnalyticsId } from '../UseCase/GetUserAnalyticsId/GetUserAnalyticsId'
 import { UserSubscription } from '../Subscription/UserSubscription'
-import { Logger } from 'winston'
 
 @injectable()
 export class SubscriptionCancelledEventHandler implements DomainEventHandlerInterface {
@@ -26,17 +25,8 @@ export class SubscriptionCancelledEventHandler implements DomainEventHandlerInte
     @inject(TYPES.GetUserAnalyticsId) private getUserAnalyticsId: GetUserAnalyticsId,
     @inject(TYPES.AnalyticsStore) private analyticsStore: AnalyticsStoreInterface,
     @inject(TYPES.StatisticsStore) private statisticsStore: StatisticsStoreInterface,
-    @inject(TYPES.Logger) private logger: Logger,
   ) {}
   async handle(event: SubscriptionCancelledEvent): Promise<void> {
-    if (event.payload.offline) {
-      await this.updateOfflineSubscriptionCancelled(event.payload.subscriptionId, event.payload.timestamp)
-
-      return
-    }
-
-    await this.updateSubscriptionCancelled(event.payload.subscriptionId, event.payload.timestamp)
-
     const user = await this.userRepository.findOneByEmail(event.payload.userEmail)
     if (user !== null) {
       const { analyticsId } = await this.getUserAnalyticsId.execute({ userUuid: user.uuid })
@@ -45,21 +35,17 @@ export class SubscriptionCancelledEventHandler implements DomainEventHandlerInte
         Period.ThisWeek,
         Period.ThisMonth,
       ])
-
-      const subscriptions = await this.userSubscriptionRepository.findBySubscriptionId(event.payload.subscriptionId)
-      if (subscriptions.length !== 0) {
-        const lastSubscription = subscriptions.shift() as UserSubscription
-        const subscriptionLength = event.payload.timestamp - lastSubscription.createdAt
-        this.logger.info(
-          `Canceling subscription ${lastSubscription.uuid} - lasted for ${subscriptionLength} microseconds`,
-        )
-        await this.statisticsStore.incrementMeasure(StatisticsMeasure.SubscriptionLength, subscriptionLength, [
-          Period.Today,
-          Period.ThisWeek,
-          Period.ThisMonth,
-        ])
-      }
     }
+
+    await this.trackSubscriptionStatistics(event)
+
+    if (event.payload.offline) {
+      await this.updateOfflineSubscriptionCancelled(event.payload.subscriptionId, event.payload.timestamp)
+
+      return
+    }
+
+    await this.updateSubscriptionCancelled(event.payload.subscriptionId, event.payload.timestamp)
   }
 
   private async updateSubscriptionCancelled(subscriptionId: number, timestamp: number): Promise<void> {
@@ -69,4 +55,39 @@ export class SubscriptionCancelledEventHandler implements DomainEventHandlerInte
   private async updateOfflineSubscriptionCancelled(subscriptionId: number, timestamp: number): Promise<void> {
     await this.offlineUserSubscriptionRepository.updateCancelled(subscriptionId, true, timestamp)
   }
+
+  private async trackSubscriptionStatistics(event: SubscriptionCancelledEvent) {
+    const subscriptions = await this.userSubscriptionRepository.findBySubscriptionId(event.payload.subscriptionId)
+    if (subscriptions.length !== 0) {
+      const lastSubscription = subscriptions.shift() as UserSubscription
+      if (this.isLegacy5yearSubscriptionPlan(lastSubscription)) {
+        return
+      }
+
+      const subscriptionLength = event.payload.timestamp - lastSubscription.createdAt
+      await this.statisticsStore.incrementMeasure(StatisticsMeasure.SubscriptionLength, subscriptionLength, [
+        Period.Today,
+        Period.ThisWeek,
+        Period.ThisMonth,
+      ])
+
+      const lastPurchaseTime = lastSubscription.renewedAt ?? lastSubscription.updatedAt
+      const remainingSubscriptionTime = lastSubscription.endsAt - event.payload.timestamp
+      const totalSubscriptionTime = lastSubscription.endsAt - lastPurchaseTime
+
+      const remainingSubscriptionPercentage = Math.floor((remainingSubscriptionTime / totalSubscriptionTime) * 100)
+
+      await this.statisticsStore.incrementMeasure(
+        StatisticsMeasure.RemainingSubscriptionTimePercentage,
+        remainingSubscriptionPercentage,
+        [Period.Today, Period.ThisWeek, Period.ThisMonth],
+      )
+    }
+  }
+
+  private isLegacy5yearSubscriptionPlan(subscription: UserSubscription) {
+    const fourYearsInMicroseconds = 126_230_400_000_000
+
+    return subscription.endsAt - subscription.createdAt > fourYearsInMicroseconds
+  }
 }

packages/auth/src/Domain/Handler/SubscriptionExpiredEventHandler.spec.ts

@@ -13,6 +13,8 @@ import { UserSubscriptionRepositoryInterface } from '../Subscription/UserSubscri
 import { RoleServiceInterface } from '../Role/RoleServiceInterface'
 import { OfflineUserSubscriptionRepositoryInterface } from '../Subscription/OfflineUserSubscriptionRepositoryInterface'
 import { UserSubscription } from '../Subscription/UserSubscription'
+import { AnalyticsStoreInterface, StatisticsStoreInterface } from '@standardnotes/analytics'
+import { GetUserAnalyticsId } from '../UseCase/GetUserAnalyticsId/GetUserAnalyticsId'
 
 describe('SubscriptionExpiredEventHandler', () => {
   let userRepository: UserRepositoryInterface
@@ -23,6 +25,9 @@ describe('SubscriptionExpiredEventHandler', () => {
   let user: User
   let event: SubscriptionExpiredEvent
   let timestamp: number
+  let getUserAnalyticsId: GetUserAnalyticsId
+  let analyticsStore: AnalyticsStoreInterface
+  let statisticsStore: StatisticsStoreInterface
 
   const createHandler = () =>
     new SubscriptionExpiredEventHandler(
@@ -30,6 +35,9 @@ describe('SubscriptionExpiredEventHandler', () => {
       userSubscriptionRepository,
       offlineUserSubscriptionRepository,
       roleService,
+      getUserAnalyticsId,
+      analyticsStore,
+      statisticsStore,
       logger,
     )
 
@@ -50,6 +58,7 @@ describe('SubscriptionExpiredEventHandler', () => {
 
     userSubscriptionRepository = {} as jest.Mocked<UserSubscriptionRepositoryInterface>
     userSubscriptionRepository.updateEndsAt = jest.fn()
+    userSubscriptionRepository.countActiveSubscriptions = jest.fn().mockReturnValue(13)
     userSubscriptionRepository.findBySubscriptionId = jest
       .fn()
       .mockReturnValue([{ user: Promise.resolve(user) } as jest.Mocked<UserSubscription>])
@@ -72,6 +81,15 @@ describe('SubscriptionExpiredEventHandler', () => {
       offline: false,
     }
 
+    getUserAnalyticsId = {} as jest.Mocked<GetUserAnalyticsId>
+    getUserAnalyticsId.execute = jest.fn().mockReturnValue({ analyticsId: 3 })
+
+    analyticsStore = {} as jest.Mocked<AnalyticsStoreInterface>
+    analyticsStore.markActivity = jest.fn()
+
+    statisticsStore = {} as jest.Mocked<StatisticsStoreInterface>
+    statisticsStore.setMeasure = jest.fn()
+
     logger = {} as jest.Mocked<Logger>
     logger.info = jest.fn()
     logger.warn = jest.fn()

packages/auth/src/Domain/Handler/SubscriptionExpiredEventHandler.ts

@@ -8,6 +8,14 @@ import { RoleServiceInterface } from '../Role/RoleServiceInterface'
 import { UserRepositoryInterface } from '../User/UserRepositoryInterface'
 import { UserSubscriptionRepositoryInterface } from '../Subscription/UserSubscriptionRepositoryInterface'
 import { OfflineUserSubscriptionRepositoryInterface } from '../Subscription/OfflineUserSubscriptionRepositoryInterface'
+import {
+  AnalyticsStoreInterface,
+  AnalyticsActivity,
+  Period,
+  StatisticsMeasure,
+  StatisticsStoreInterface,
+} from '@standardnotes/analytics'
+import { GetUserAnalyticsId } from '../UseCase/GetUserAnalyticsId/GetUserAnalyticsId'
 
 @injectable()
 export class SubscriptionExpiredEventHandler implements DomainEventHandlerInterface {
@@ -17,6 +25,9 @@ export class SubscriptionExpiredEventHandler implements DomainEventHandlerInterf
     @inject(TYPES.OfflineUserSubscriptionRepository)
     private offlineUserSubscriptionRepository: OfflineUserSubscriptionRepositoryInterface,
     @inject(TYPES.RoleService) private roleService: RoleServiceInterface,
+    @inject(TYPES.GetUserAnalyticsId) private getUserAnalyticsId: GetUserAnalyticsId,
+    @inject(TYPES.AnalyticsStore) private analyticsStore: AnalyticsStoreInterface,
+    @inject(TYPES.StatisticsStore) private statisticsStore: StatisticsStoreInterface,
     @inject(TYPES.Logger) private logger: Logger,
   ) {}
 
@@ -36,6 +47,21 @@ export class SubscriptionExpiredEventHandler implements DomainEventHandlerInterf
 
     await this.updateSubscriptionEndsAt(event.payload.subscriptionId, event.payload.timestamp)
     await this.removeRoleFromSubscriptionUsers(event.payload.subscriptionId, event.payload.subscriptionName)
+
+    const { analyticsId } = await this.getUserAnalyticsId.execute({ userUuid: user.uuid })
+    await this.analyticsStore.markActivity(
+      [AnalyticsActivity.SubscriptionExpired, AnalyticsActivity.ExistingCustomersChurn],
+      analyticsId,
+      [Period.Today, Period.ThisWeek, Period.ThisMonth],
+    )
+
+    const activeSubscriptions = await this.userSubscriptionRepository.countActiveSubscriptions()
+    await this.statisticsStore.setMeasure(StatisticsMeasure.TotalCustomers, activeSubscriptions, [
+      Period.Today,
+      Period.ThisWeek,
+      Period.ThisMonth,
+      Period.ThisYear,
+    ])
   }
 
   private async removeRoleFromSubscriptionUsers(

packages/auth/src/Domain/Handler/SubscriptionPurchasedEventHandler.spec.ts

@@ -16,9 +16,10 @@ import { OfflineUserSubscriptionRepositoryInterface } from '../Subscription/Offl
 import { OfflineUserSubscription } from '../Subscription/OfflineUserSubscription'
 import { SubscriptionSettingServiceInterface } from '../Setting/SubscriptionSettingServiceInterface'
 import { UserSubscriptionType } from '../Subscription/UserSubscriptionType'
-import { AnalyticsStoreInterface, Period } from '@standardnotes/analytics'
+import { AnalyticsStoreInterface, Period, StatisticsStoreInterface } from '@standardnotes/analytics'
 import { AnalyticsEntity } from '../Analytics/AnalyticsEntity'
 import { GetUserAnalyticsId } from '../UseCase/GetUserAnalyticsId/GetUserAnalyticsId'
+import { TimerInterface } from '@standardnotes/time'
 
 describe('SubscriptionPurchasedEventHandler', () => {
   let userRepository: UserRepositoryInterface
@@ -35,6 +36,8 @@ describe('SubscriptionPurchasedEventHandler', () => {
   let getUserAnalyticsId: GetUserAnalyticsId
   let analyticsStore: AnalyticsStoreInterface
   let timestamp: number
+  let statisticsStore: StatisticsStoreInterface
+  let timer: TimerInterface
 
   const createHandler = () =>
     new SubscriptionPurchasedEventHandler(
@@ -45,6 +48,8 @@ describe('SubscriptionPurchasedEventHandler', () => {
       subscriptionSettingService,
       getUserAnalyticsId,
       analyticsStore,
+      statisticsStore,
+      timer,
       logger,
     )
 
@@ -66,7 +71,16 @@ describe('SubscriptionPurchasedEventHandler', () => {
     userRepository.findOneByEmail = jest.fn().mockReturnValue(user)
     userRepository.save = jest.fn().mockReturnValue(user)
 
+    statisticsStore = {} as jest.Mocked<StatisticsStoreInterface>
+    statisticsStore.incrementMeasure = jest.fn()
+    statisticsStore.setMeasure = jest.fn()
+
+    timer = {} as jest.Mocked<TimerInterface>
+    timer.convertDateToMicroseconds = jest.fn().mockReturnValue(1)
+
     userSubscriptionRepository = {} as jest.Mocked<UserSubscriptionRepositoryInterface>
+    userSubscriptionRepository.countByUserUuid = jest.fn().mockReturnValue(0)
+    userSubscriptionRepository.countActiveSubscriptions = jest.fn().mockReturnValue(13)
     userSubscriptionRepository.save = jest.fn().mockReturnValue(subscription)
 
     offlineUserSubscription = {} as jest.Mocked<OfflineUserSubscription>
@@ -101,6 +115,7 @@ describe('SubscriptionPurchasedEventHandler', () => {
 
     analyticsStore = {} as jest.Mocked<AnalyticsStoreInterface>
     analyticsStore.markActivity = jest.fn()
+    analyticsStore.unmarkActivity = jest.fn()
 
     logger = {} as jest.Mocked<Logger>
     logger.info = jest.fn()
@@ -120,6 +135,7 @@ describe('SubscriptionPurchasedEventHandler', () => {
     expect(subscriptionSettingService.applyDefaultSubscriptionSettingsForSubscription).toHaveBeenCalledWith(
       subscription,
       SubscriptionName.ProPlan,
+      '123',
     )
   })
 
@@ -146,6 +162,15 @@ describe('SubscriptionPurchasedEventHandler', () => {
       updatedAt: expect.any(Number),
       cancelled: false,
     })
+    expect(statisticsStore.incrementMeasure).toHaveBeenCalled()
+  })
+
+  it("should not measure registration to subscription time if this is not user's first subscription", async () => {
+    userSubscriptionRepository.countByUserUuid = jest.fn().mockReturnValue(1)
+
+    await createHandler().handle(event)
+
+    expect(statisticsStore.incrementMeasure).not.toHaveBeenCalled()
   })
 
   it('should update analytics on limited discount offer purchasing', async () => {

packages/auth/src/Domain/Handler/SubscriptionPurchasedEventHandler.ts

@@ -13,8 +13,15 @@ import { OfflineUserSubscription } from '../Subscription/OfflineUserSubscription
 import { OfflineUserSubscriptionRepositoryInterface } from '../Subscription/OfflineUserSubscriptionRepositoryInterface'
 import { UserSubscriptionType } from '../Subscription/UserSubscriptionType'
 import { SubscriptionSettingServiceInterface } from '../Setting/SubscriptionSettingServiceInterface'
-import { AnalyticsActivity, AnalyticsStoreInterface, Period } from '@standardnotes/analytics'
+import {
+  AnalyticsActivity,
+  AnalyticsStoreInterface,
+  Period,
+  StatisticsMeasure,
+  StatisticsStoreInterface,
+} from '@standardnotes/analytics'
 import { GetUserAnalyticsId } from '../UseCase/GetUserAnalyticsId/GetUserAnalyticsId'
+import { TimerInterface } from '@standardnotes/time'
 
 @injectable()
 export class SubscriptionPurchasedEventHandler implements DomainEventHandlerInterface {
@@ -27,6 +34,8 @@ export class SubscriptionPurchasedEventHandler implements DomainEventHandlerInte
     @inject(TYPES.SubscriptionSettingService) private subscriptionSettingService: SubscriptionSettingServiceInterface,
     @inject(TYPES.GetUserAnalyticsId) private getUserAnalyticsId: GetUserAnalyticsId,
     @inject(TYPES.AnalyticsStore) private analyticsStore: AnalyticsStoreInterface,
+    @inject(TYPES.StatisticsStore) private statisticsStore: StatisticsStoreInterface,
+    @inject(TYPES.Timer) private timer: TimerInterface,
     @inject(TYPES.Logger) private logger: Logger,
   ) {}
 
@@ -52,6 +61,8 @@ export class SubscriptionPurchasedEventHandler implements DomainEventHandlerInte
       return
     }
 
+    const previousSubscriptionCount = await this.userSubscriptionRepository.countByUserUuid(user.uuid)
+
     const userSubscription = await this.createSubscription(
       event.payload.subscriptionId,
       event.payload.subscriptionName,
@@ -65,6 +76,7 @@ export class SubscriptionPurchasedEventHandler implements DomainEventHandlerInte
     await this.subscriptionSettingService.applyDefaultSubscriptionSettingsForSubscription(
       userSubscription,
       event.payload.subscriptionName,
+      user.uuid,
     )
 
     const { analyticsId } = await this.getUserAnalyticsId.execute({ userUuid: user.uuid })
@@ -73,6 +85,11 @@ export class SubscriptionPurchasedEventHandler implements DomainEventHandlerInte
       Period.ThisWeek,
       Period.ThisMonth,
     ])
+    await this.analyticsStore.unmarkActivity(
+      [AnalyticsActivity.ExistingCustomersChurn, AnalyticsActivity.NewCustomersChurn],
+      analyticsId,
+      [Period.Today, Period.ThisWeek, Period.ThisMonth],
+    )
 
     const limitedDiscountPurchased = ['limited-10', 'limited-20'].includes(event.payload.discountCode as string)
     if (limitedDiscountPurchased) {
@@ -80,6 +97,27 @@ export class SubscriptionPurchasedEventHandler implements DomainEventHandlerInte
         Period.Today,
       ])
     }
+
+    if (previousSubscriptionCount === 0) {
+      await this.statisticsStore.incrementMeasure(
+        StatisticsMeasure.RegistrationToSubscriptionTime,
+        event.payload.timestamp - this.timer.convertDateToMicroseconds(user.createdAt),
+        [Period.Today, Period.ThisWeek, Period.ThisMonth],
+      )
+      await this.statisticsStore.incrementMeasure(StatisticsMeasure.NewCustomers, 1, [
+        Period.Today,
+        Period.ThisWeek,
+        Period.ThisMonth,
+        Period.ThisYear,
+      ])
+      const activeSubscriptions = await this.userSubscriptionRepository.countActiveSubscriptions()
+      await this.statisticsStore.setMeasure(StatisticsMeasure.TotalCustomers, activeSubscriptions, [
+        Period.Today,
+        Period.ThisWeek,
+        Period.ThisMonth,
+        Period.ThisYear,
+      ])
+    }
   }
 
   private async addUserRole(user: User, subscriptionName: SubscriptionName): Promise<void> {

packages/auth/src/Domain/Handler/SubscriptionReassignedEventHandler.spec.ts

@@ -94,6 +94,7 @@ describe('SubscriptionReassignedEventHandler', () => {
     expect(subscriptionSettingService.applyDefaultSubscriptionSettingsForSubscription).toHaveBeenCalledWith(
       subscription,
       SubscriptionName.ProPlan,
+      '123',
     )
   })
 

packages/auth/src/Domain/Handler/SubscriptionReassignedEventHandler.ts

@@ -58,6 +58,7 @@ export class SubscriptionReassignedEventHandler implements DomainEventHandlerInt
     await this.subscriptionSettingService.applyDefaultSubscriptionSettingsForSubscription(
       userSubscription,
       event.payload.subscriptionName,
+      user.uuid,
     )
   }
 

packages/auth/src/Domain/Handler/SubscriptionRefundedEventHandler.spec.ts

@@ -14,7 +14,7 @@ import { RoleServiceInterface } from '../Role/RoleServiceInterface'
 import { OfflineUserSubscriptionRepositoryInterface } from '../Subscription/OfflineUserSubscriptionRepositoryInterface'
 import { UserSubscription } from '../Subscription/UserSubscription'
 import { GetUserAnalyticsId } from '../UseCase/GetUserAnalyticsId/GetUserAnalyticsId'
-import { AnalyticsStoreInterface } from '@standardnotes/analytics'
+import { AnalyticsActivity, AnalyticsStoreInterface, Period, StatisticsStoreInterface } from '@standardnotes/analytics'
 
 describe('SubscriptionRefundedEventHandler', () => {
   let userRepository: UserRepositoryInterface
@@ -27,6 +27,7 @@ describe('SubscriptionRefundedEventHandler', () => {
   let timestamp: number
   let getUserAnalyticsId: GetUserAnalyticsId
   let analyticsStore: AnalyticsStoreInterface
+  let statisticsStore: StatisticsStoreInterface
 
   const createHandler = () =>
     new SubscriptionRefundedEventHandler(
@@ -36,6 +37,7 @@ describe('SubscriptionRefundedEventHandler', () => {
       roleService,
       getUserAnalyticsId,
       analyticsStore,
+      statisticsStore,
       logger,
     )
 
@@ -56,6 +58,8 @@ describe('SubscriptionRefundedEventHandler', () => {
 
     userSubscriptionRepository = {} as jest.Mocked<UserSubscriptionRepositoryInterface>
     userSubscriptionRepository.updateEndsAt = jest.fn()
+    userSubscriptionRepository.countByUserUuid = jest.fn().mockReturnValue(1)
+    userSubscriptionRepository.countActiveSubscriptions = jest.fn().mockReturnValue(13)
     userSubscriptionRepository.findBySubscriptionId = jest
       .fn()
       .mockReturnValue([{ user: Promise.resolve(user) } as jest.Mocked<UserSubscription>])
@@ -83,6 +87,10 @@ describe('SubscriptionRefundedEventHandler', () => {
 
     analyticsStore = {} as jest.Mocked<AnalyticsStoreInterface>
     analyticsStore.markActivity = jest.fn()
+    analyticsStore.wasActivityDone = jest.fn().mockReturnValue(true)
+
+    statisticsStore = {} as jest.Mocked<StatisticsStoreInterface>
+    statisticsStore.setMeasure = jest.fn()
 
     logger = {} as jest.Mocked<Logger>
     logger.info = jest.fn()
@@ -119,4 +127,33 @@ describe('SubscriptionRefundedEventHandler', () => {
     expect(roleService.removeUserRole).not.toHaveBeenCalled()
     expect(userSubscriptionRepository.updateEndsAt).not.toHaveBeenCalled()
   })
+
+  it('should mark churn for new customer', async () => {
+    await createHandler().handle(event)
+
+    expect(analyticsStore.markActivity).toHaveBeenCalledWith([AnalyticsActivity.NewCustomersChurn], 3, [
+      Period.ThisMonth,
+    ])
+  })
+
+  it('should mark churn for existing customer', async () => {
+    userSubscriptionRepository.countByUserUuid = jest.fn().mockReturnValue(3)
+
+    await createHandler().handle(event)
+
+    expect(analyticsStore.markActivity).toHaveBeenCalledWith([AnalyticsActivity.ExistingCustomersChurn], 3, [
+      Period.ThisMonth,
+    ])
+  })
+
+  it('should not mark churn if customer did not purchase subscription in defined analytic periods', async () => {
+    userSubscriptionRepository.countByUserUuid = jest.fn().mockReturnValue(3)
+    analyticsStore.wasActivityDone = jest.fn().mockReturnValue(false)
+
+    await createHandler().handle(event)
+
+    expect(analyticsStore.markActivity).not.toHaveBeenCalledWith([AnalyticsActivity.ExistingCustomersChurn], 3, [
+      Period.ThisMonth,
+    ])
+  })
 })

packages/auth/src/Domain/Handler/SubscriptionRefundedEventHandler.ts

@@ -1,4 +1,4 @@
-import { SubscriptionName } from '@standardnotes/common'
+import { SubscriptionName, Uuid } from '@standardnotes/common'
 import { DomainEventHandlerInterface, SubscriptionRefundedEvent } from '@standardnotes/domain-events'
 import { inject, injectable } from 'inversify'
 import { Logger } from 'winston'
@@ -8,7 +8,13 @@ import { RoleServiceInterface } from '../Role/RoleServiceInterface'
 import { UserRepositoryInterface } from '../User/UserRepositoryInterface'
 import { UserSubscriptionRepositoryInterface } from '../Subscription/UserSubscriptionRepositoryInterface'
 import { OfflineUserSubscriptionRepositoryInterface } from '../Subscription/OfflineUserSubscriptionRepositoryInterface'
-import { AnalyticsActivity, AnalyticsStoreInterface, Period } from '@standardnotes/analytics'
+import {
+  AnalyticsActivity,
+  AnalyticsStoreInterface,
+  Period,
+  StatisticsMeasure,
+  StatisticsStoreInterface,
+} from '@standardnotes/analytics'
 import { GetUserAnalyticsId } from '../UseCase/GetUserAnalyticsId/GetUserAnalyticsId'
 
 @injectable()
@@ -21,6 +27,7 @@ export class SubscriptionRefundedEventHandler implements DomainEventHandlerInter
     @inject(TYPES.RoleService) private roleService: RoleServiceInterface,
     @inject(TYPES.GetUserAnalyticsId) private getUserAnalyticsId: GetUserAnalyticsId,
     @inject(TYPES.AnalyticsStore) private analyticsStore: AnalyticsStoreInterface,
+    @inject(TYPES.StatisticsStore) private statisticsStore: StatisticsStoreInterface,
     @inject(TYPES.Logger) private logger: Logger,
   ) {}
 
@@ -47,6 +54,8 @@ export class SubscriptionRefundedEventHandler implements DomainEventHandlerInter
       Period.ThisWeek,
       Period.ThisMonth,
     ])
+
+    await this.markChurnActivity(analyticsId, user.uuid)
   }
 
   private async removeRoleFromSubscriptionUsers(
@@ -66,4 +75,30 @@ export class SubscriptionRefundedEventHandler implements DomainEventHandlerInter
   private async updateOfflineSubscriptionEndsAt(subscriptionId: number, timestamp: number): Promise<void> {
     await this.offlineUserSubscriptionRepository.updateEndsAt(subscriptionId, timestamp, timestamp)
   }
+
+  private async markChurnActivity(analyticsId: number, userUuid: Uuid): Promise<void> {
+    const existingSubscriptionsCount = await this.userSubscriptionRepository.countByUserUuid(userUuid)
+
+    const churnActivity =
+      existingSubscriptionsCount > 1 ? AnalyticsActivity.ExistingCustomersChurn : AnalyticsActivity.NewCustomersChurn
+
+    for (const period of [Period.ThisMonth, Period.ThisWeek, Period.Today]) {
+      const customerPurchasedInPeriod = await this.analyticsStore.wasActivityDone(
+        AnalyticsActivity.SubscriptionPurchased,
+        analyticsId,
+        period,
+      )
+      if (customerPurchasedInPeriod) {
+        await this.analyticsStore.markActivity([churnActivity], analyticsId, [period])
+      }
+    }
+
+    const activeSubscriptions = await this.userSubscriptionRepository.countActiveSubscriptions()
+    await this.statisticsStore.setMeasure(StatisticsMeasure.TotalCustomers, activeSubscriptions, [
+      Period.Today,
+      Period.ThisWeek,
+      Period.ThisMonth,
+      Period.ThisYear,
+    ])
+  }
 }

packages/auth/src/Domain/Handler/SubscriptionRenewedEventHandler.spec.ts

@@ -94,6 +94,7 @@ describe('SubscriptionRenewedEventHandler', () => {
 
     analyticsStore = {} as jest.Mocked<AnalyticsStoreInterface>
     analyticsStore.markActivity = jest.fn()
+    analyticsStore.unmarkActivity = jest.fn()
 
     logger = {} as jest.Mocked<Logger>
     logger.warn = jest.fn()

packages/auth/src/Domain/Handler/SubscriptionRenewedEventHandler.ts

@@ -66,6 +66,11 @@ export class SubscriptionRenewedEventHandler implements DomainEventHandlerInterf
       Period.ThisWeek,
       Period.ThisMonth,
     ])
+    await this.analyticsStore.unmarkActivity(
+      [AnalyticsActivity.ExistingCustomersChurn, AnalyticsActivity.NewCustomersChurn],
+      analyticsId,
+      [Period.Today, Period.ThisWeek, Period.ThisMonth],
+    )
   }
 
   private async addRoleToSubscriptionUsers(subscriptionId: number, subscriptionName: SubscriptionName): Promise<void> {

packages/auth/src/Domain/Handler/SubscriptionSyncRequestedEventHandler.spec.ts

@@ -130,6 +130,7 @@ describe('SubscriptionSyncRequestedEventHandler', () => {
     expect(subscriptionSettingService.applyDefaultSubscriptionSettingsForSubscription).toHaveBeenCalledWith(
       subscription,
       SubscriptionName.ProPlan,
+      '123',
     )
 
     expect(settingService.createOrReplace).toHaveBeenCalledWith({

packages/auth/src/Domain/Handler/SubscriptionSyncRequestedEventHandler.ts

@@ -89,6 +89,7 @@ export class SubscriptionSyncRequestedEventHandler implements DomainEventHandler
     await this.subscriptionSettingService.applyDefaultSubscriptionSettingsForSubscription(
       userSubscription,
       event.payload.subscriptionName,
+      user.uuid,
     )
 
     await this.settingService.createOrReplace({

packages/auth/src/Domain/Setting/SettingDescription.ts

@@ -4,4 +4,5 @@ export type SettingDescription = {
   value: string
   sensitive: boolean
   serverEncryptionVersion: EncryptionVersion
+  replaceable: boolean
 }

packages/auth/src/Domain/Setting/SettingsAssociationService.ts

@@ -52,6 +52,7 @@ export class SettingsAssociationService implements SettingsAssociationServiceInt
         sensitive: false,
         serverEncryptionVersion: EncryptionVersion.Unencrypted,
         value: MuteSignInEmailsOption.NotMuted,
+        replaceable: false,
       },
     ],
     [
@@ -60,6 +61,7 @@ export class SettingsAssociationService implements SettingsAssociationServiceInt
         sensitive: false,
         serverEncryptionVersion: EncryptionVersion.Unencrypted,
         value: MuteMarketingEmailsOption.NotMuted,
+        replaceable: false,
       },
     ],
     [
@@ -68,6 +70,7 @@ export class SettingsAssociationService implements SettingsAssociationServiceInt
         sensitive: false,
         serverEncryptionVersion: EncryptionVersion.Unencrypted,
         value: LogSessionUserAgentOption.Enabled,
+        replaceable: false,
       },
     ],
   ])
@@ -79,6 +82,7 @@ export class SettingsAssociationService implements SettingsAssociationServiceInt
         sensitive: false,
         serverEncryptionVersion: EncryptionVersion.Unencrypted,
         value: LogSessionUserAgentOption.Disabled,
+        replaceable: false,
       },
     ],
   ])

packages/auth/src/Domain/Setting/SubscriptionSettingService.spec.ts

@@ -13,6 +13,7 @@ import { SubscriptionName } from '@standardnotes/common'
 import { User } from '../User/User'
 import { SettingFactoryInterface } from './SettingFactoryInterface'
 import { SubscriptionSettingsAssociationServiceInterface } from './SubscriptionSettingsAssociationServiceInterface'
+import { UserSubscriptionRepositoryInterface } from '../Subscription/UserSubscriptionRepositoryInterface'
 
 describe('SubscriptionSettingService', () => {
   let setting: SubscriptionSetting
@@ -22,6 +23,7 @@ describe('SubscriptionSettingService', () => {
   let subscriptionSettingRepository: SubscriptionSettingRepositoryInterface
   let subscriptionSettingsAssociationService: SubscriptionSettingsAssociationServiceInterface
   let settingDecrypter: SettingDecrypterInterface
+  let userSubscriptionRepository: UserSubscriptionRepositoryInterface
   let logger: Logger
 
   const createService = () =>
@@ -30,6 +32,7 @@ describe('SubscriptionSettingService', () => {
       subscriptionSettingRepository,
       subscriptionSettingsAssociationService,
       settingDecrypter,
+      userSubscriptionRepository,
       logger,
     )
 
@@ -51,6 +54,16 @@ describe('SubscriptionSettingService', () => {
     subscriptionSettingRepository.findLastByNameAndUserSubscriptionUuid = jest.fn().mockReturnValue(null)
     subscriptionSettingRepository.save = jest.fn().mockImplementation((setting) => setting)
 
+    userSubscriptionRepository = {} as jest.Mocked<UserSubscriptionRepositoryInterface>
+    userSubscriptionRepository.findByUserUuid = jest.fn().mockReturnValue([
+      {
+        uuid: 's-1-2-3',
+      } as jest.Mocked<UserSubscription>,
+      {
+        uuid: 's-2-3-4',
+      } as jest.Mocked<UserSubscription>,
+    ])
+
     subscriptionSettingsAssociationService = {} as jest.Mocked<SubscriptionSettingsAssociationServiceInterface>
     subscriptionSettingsAssociationService.getDefaultSettingsAndValuesForSubscriptionName = jest.fn().mockReturnValue(
       new Map([
@@ -60,6 +73,7 @@ describe('SubscriptionSettingService', () => {
             value: '0',
             sensitive: 0,
             serverEncryptionVersion: EncryptionVersion.Unencrypted,
+            replaceable: true,
           },
         ],
       ]),
@@ -75,7 +89,91 @@ describe('SubscriptionSettingService', () => {
   })
 
   it('should create default settings for a subscription', async () => {
-    await createService().applyDefaultSubscriptionSettingsForSubscription(userSubscription, SubscriptionName.PlusPlan)
+    await createService().applyDefaultSubscriptionSettingsForSubscription(
+      userSubscription,
+      SubscriptionName.PlusPlan,
+      '1-2-3',
+    )
+
+    expect(subscriptionSettingRepository.save).toHaveBeenCalledWith(setting)
+  })
+
+  it('should reassign existing default settings for a subscription if it is not replaceable', async () => {
+    subscriptionSettingsAssociationService.getDefaultSettingsAndValuesForSubscriptionName = jest.fn().mockReturnValue(
+      new Map([
+        [
+          SubscriptionSettingName.FileUploadBytesUsed,
+          {
+            value: '0',
+            sensitive: 0,
+            serverEncryptionVersion: EncryptionVersion.Unencrypted,
+            replaceable: false,
+          },
+        ],
+      ]),
+    )
+    subscriptionSettingRepository.findLastByNameAndUserSubscriptionUuid = jest.fn().mockReturnValue(setting)
+
+    await createService().applyDefaultSubscriptionSettingsForSubscription(
+      userSubscription,
+      SubscriptionName.PlusPlan,
+      '1-2-3',
+    )
+
+    expect(subscriptionSettingRepository.save).toHaveBeenCalled()
+  })
+
+  it('should create default settings for a subscription if it is not replaceable and not existing', async () => {
+    subscriptionSettingsAssociationService.getDefaultSettingsAndValuesForSubscriptionName = jest.fn().mockReturnValue(
+      new Map([
+        [
+          SubscriptionSettingName.FileUploadBytesUsed,
+          {
+            value: '0',
+            sensitive: 0,
+            serverEncryptionVersion: EncryptionVersion.Unencrypted,
+            replaceable: false,
+          },
+        ],
+      ]),
+    )
+    subscriptionSettingRepository.findLastByNameAndUserSubscriptionUuid = jest.fn().mockReturnValue(null)
+
+    await createService().applyDefaultSubscriptionSettingsForSubscription(
+      userSubscription,
+      SubscriptionName.PlusPlan,
+      '1-2-3',
+    )
+
+    expect(subscriptionSettingRepository.save).toHaveBeenCalledWith(setting)
+  })
+
+  it('should create default settings for a subscription if it is not replaceable and no previous subscription existed', async () => {
+    subscriptionSettingsAssociationService.getDefaultSettingsAndValuesForSubscriptionName = jest.fn().mockReturnValue(
+      new Map([
+        [
+          SubscriptionSettingName.FileUploadBytesUsed,
+          {
+            value: '0',
+            sensitive: 0,
+            serverEncryptionVersion: EncryptionVersion.Unencrypted,
+            replaceable: false,
+          },
+        ],
+      ]),
+    )
+    subscriptionSettingRepository.findLastByNameAndUserSubscriptionUuid = jest.fn().mockReturnValue(null)
+    userSubscriptionRepository.findByUserUuid = jest.fn().mockReturnValue([
+      {
+        uuid: '1-2-3',
+      } as jest.Mocked<UserSubscription>,
+    ])
+
+    await createService().applyDefaultSubscriptionSettingsForSubscription(
+      userSubscription,
+      SubscriptionName.PlusPlan,
+      '1-2-3',
+    )
 
     expect(subscriptionSettingRepository.save).toHaveBeenCalledWith(setting)
   })
@@ -85,7 +183,11 @@ describe('SubscriptionSettingService', () => {
       .fn()
       .mockReturnValue(undefined)
 
-    await createService().applyDefaultSubscriptionSettingsForSubscription(userSubscription, SubscriptionName.PlusPlan)
+    await createService().applyDefaultSubscriptionSettingsForSubscription(
+      userSubscription,
+      SubscriptionName.PlusPlan,
+      '1-2-3',
+    )
 
     expect(subscriptionSettingRepository.save).not.toHaveBeenCalled()
   })

packages/auth/src/Domain/Setting/SubscriptionSettingService.ts

@@ -1,4 +1,4 @@
-import { SubscriptionName } from '@standardnotes/common'
+import { SubscriptionName, Uuid } from '@standardnotes/common'
 import { SubscriptionSettingName } from '@standardnotes/settings'
 import { inject, injectable } from 'inversify'
 import { Logger } from 'winston'
@@ -16,6 +16,7 @@ import { FindSubscriptionSettingDTO } from './FindSubscriptionSettingDTO'
 import { SubscriptionSettingRepositoryInterface } from './SubscriptionSettingRepositoryInterface'
 import { SettingFactoryInterface } from './SettingFactoryInterface'
 import { SubscriptionSettingsAssociationServiceInterface } from './SubscriptionSettingsAssociationServiceInterface'
+import { UserSubscriptionRepositoryInterface } from '../Subscription/UserSubscriptionRepositoryInterface'
 
 @injectable()
 export class SubscriptionSettingService implements SubscriptionSettingServiceInterface {
@@ -26,12 +27,14 @@ export class SubscriptionSettingService implements SubscriptionSettingServiceInt
     @inject(TYPES.SubscriptionSettingsAssociationService)
     private subscriptionSettingAssociationService: SubscriptionSettingsAssociationServiceInterface,
     @inject(TYPES.SettingDecrypter) private settingDecrypter: SettingDecrypterInterface,
+    @inject(TYPES.UserSubscriptionRepository) private userSubscriptionRepository: UserSubscriptionRepositoryInterface,
     @inject(TYPES.Logger) private logger: Logger,
   ) {}
 
   async applyDefaultSubscriptionSettingsForSubscription(
     userSubscription: UserSubscription,
     subscriptionName: SubscriptionName,
+    userUuid: Uuid,
   ): Promise<void> {
     const defaultSettingsWithValues =
       await this.subscriptionSettingAssociationService.getDefaultSettingsAndValuesForSubscriptionName(subscriptionName)
@@ -43,6 +46,15 @@ export class SubscriptionSettingService implements SubscriptionSettingServiceInt
 
     for (const settingName of defaultSettingsWithValues.keys()) {
       const setting = defaultSettingsWithValues.get(settingName) as SettingDescription
+      if (!setting.replaceable) {
+        const existingSetting = await this.findPreviousSubscriptionSetting(settingName, userSubscription.uuid, userUuid)
+        if (existingSetting !== null) {
+          existingSetting.userSubscription = Promise.resolve(userSubscription)
+          await this.subscriptionSettingRepository.save(existingSetting)
+
+          continue
+        }
+      }
 
       await this.createOrReplace({
         userSubscription,
@@ -114,4 +126,22 @@ export class SubscriptionSettingService implements SubscriptionSettingServiceInt
       subscriptionSetting,
     }
   }
+
+  private async findPreviousSubscriptionSetting(
+    settingName: SubscriptionSettingName,
+    currentUserSubscriptionUuid: Uuid,
+    userUuid: Uuid,
+  ): Promise<SubscriptionSetting | null> {
+    const userSubscriptions = await this.userSubscriptionRepository.findByUserUuid(userUuid)
+    const previousSubscriptions = userSubscriptions.filter(
+      (subscription) => subscription.uuid !== currentUserSubscriptionUuid,
+    )
+    const lastSubscription = previousSubscriptions.shift()
+
+    if (!lastSubscription) {
+      return null
+    }
+
+    return this.subscriptionSettingRepository.findLastByNameAndUserSubscriptionUuid(settingName, lastSubscription.uuid)
+  }
 }

packages/auth/src/Domain/Setting/SubscriptionSettingServiceInterface.ts

@@ -1,4 +1,4 @@
-import { SubscriptionName } from '@standardnotes/common'
+import { SubscriptionName, Uuid } from '@standardnotes/common'
 import { UserSubscription } from '../Subscription/UserSubscription'
 
 import { CreateOrReplaceSubscriptionSettingDTO } from './CreateOrReplaceSubscriptionSettingDTO'
@@ -10,6 +10,7 @@ export interface SubscriptionSettingServiceInterface {
   applyDefaultSubscriptionSettingsForSubscription(
     userSubscription: UserSubscription,
     subscriptionName: SubscriptionName,
+    userUuid: Uuid,
   ): Promise<void>
   createOrReplace(dto: CreateOrReplaceSubscriptionSettingDTO): Promise<CreateOrReplaceSubscriptionSettingResponse>
   findSubscriptionSettingWithDecryptedValue(dto: FindSubscriptionSettingDTO): Promise<SubscriptionSetting | null>

packages/auth/src/Domain/Setting/SubscriptionSettingsAssociationService.spec.ts

@@ -61,6 +61,7 @@ describe('SubscriptionSettingsAssociationService', () => {
       sensitive: false,
       serverEncryptionVersion: 0,
       value: '107374182400',
+      replaceable: true,
     })
   })
 
@@ -88,6 +89,7 @@ describe('SubscriptionSettingsAssociationService', () => {
       sensitive: false,
       serverEncryptionVersion: 0,
       value: '104857600',
+      replaceable: true,
     })
   })
 

packages/auth/src/Domain/Setting/SubscriptionSettingsAssociationService.ts

@@ -28,7 +28,7 @@ export class SubscriptionSettingsAssociationService implements SubscriptionSetti
       new Map([
         [
           SubscriptionSettingName.FileUploadBytesUsed,
-          { sensitive: false, serverEncryptionVersion: EncryptionVersion.Unencrypted, value: '0' },
+          { sensitive: false, serverEncryptionVersion: EncryptionVersion.Unencrypted, value: '0', replaceable: false },
         ],
       ]),
     ],
@@ -37,7 +37,7 @@ export class SubscriptionSettingsAssociationService implements SubscriptionSetti
       new Map([
         [
           SubscriptionSettingName.FileUploadBytesUsed,
-          { sensitive: false, serverEncryptionVersion: EncryptionVersion.Unencrypted, value: '0' },
+          { sensitive: false, serverEncryptionVersion: EncryptionVersion.Unencrypted, value: '0', replaceable: false },
         ],
       ]),
     ],
@@ -56,6 +56,7 @@ export class SubscriptionSettingsAssociationService implements SubscriptionSetti
       sensitive: false,
       serverEncryptionVersion: EncryptionVersion.Unencrypted,
       value: (await this.getFileUploadLimit(subscriptionName)).toString(),
+      replaceable: true,
     })
 
     return defaultSettings

packages/auth/src/Domain/SharedSubscription/SharedSubscriptionInvitationRepositoryInterface.ts

@@ -7,5 +7,9 @@ export interface SharedSubscriptionInvitationRepositoryInterface {
   findOneByUuidAndStatus(uuid: Uuid, status: InvitationStatus): Promise<SharedSubscriptionInvitation | null>
   findOneByUuid(uuid: Uuid): Promise<SharedSubscriptionInvitation | null>
   findByInviterEmail(inviterEmail: string): Promise<SharedSubscriptionInvitation[]>
+  findOneByInviteeAndInviterEmail(
+    inviteeEmail: string,
+    inviterEmail: string,
+  ): Promise<SharedSubscriptionInvitation | null>
   countByInviterEmailAndStatus(inviterEmail: Uuid, statuses: InvitationStatus[]): Promise<number>
 }

packages/auth/src/Domain/Subscription/SubscriptionTokenRepositoryInterface.ts

@@ -3,6 +3,6 @@ import { Uuid } from '@standardnotes/common'
 import { SubscriptionToken } from './SubscriptionToken'
 
 export interface SubscriptionTokenRepositoryInterface {
-  save(subscriptionToken: SubscriptionToken): Promise<void>
+  save(subscriptionToken: SubscriptionToken): Promise<boolean>
   getUserUuidByToken(token: string): Promise<Uuid | undefined>
 }

packages/auth/src/Domain/Subscription/UserSubscription.ts

@@ -34,6 +34,13 @@ export class UserSubscription {
   @Index('updated_at')
   declare updatedAt: number
 
+  @Column({
+    name: 'renewed_at',
+    type: 'bigint',
+    nullable: true,
+  })
+  declare renewedAt: number | null
+
   @Column({
     type: 'tinyint',
     width: 1,

packages/auth/src/Domain/Subscription/UserSubscriptionRepositoryInterface.ts

@@ -4,11 +4,14 @@ import { UserSubscriptionType } from './UserSubscriptionType'
 
 export interface UserSubscriptionRepositoryInterface {
   findOneByUuid(uuid: Uuid): Promise<UserSubscription | null>
+  countByUserUuid(userUuid: Uuid): Promise<number>
   findOneByUserUuid(userUuid: Uuid): Promise<UserSubscription | null>
+  findByUserUuid(userUuid: Uuid): Promise<UserSubscription[]>
   findOneByUserUuidAndSubscriptionId(userUuid: Uuid, subscriptionId: number): Promise<UserSubscription | null>
   findBySubscriptionIdAndType(subscriptionId: number, type: UserSubscriptionType): Promise<UserSubscription[]>
   findBySubscriptionId(subscriptionId: number): Promise<UserSubscription[]>
   updateEndsAt(subscriptionId: number, endsAt: number, updatedAt: number): Promise<void>
   updateCancelled(subscriptionId: number, cancelled: boolean, updatedAt: number): Promise<void>
+  countActiveSubscriptions(): Promise<number>
   save(subscription: UserSubscription): Promise<UserSubscription>
 }

packages/auth/src/Domain/UseCase/AcceptSharedSubscriptionInvitation/AcceptSharedSubscriptionInvitation.spec.ts

@@ -104,6 +104,7 @@ describe('AcceptSharedSubscriptionInvitation', () => {
     expect(subscriptionSettingService.applyDefaultSubscriptionSettingsForSubscription).toHaveBeenCalledWith(
       inviteeSubscription,
       'PLUS_PLAN',
+      '123',
     )
   })
 

packages/auth/src/Domain/UseCase/AcceptSharedSubscriptionInvitation/AcceptSharedSubscriptionInvitation.ts

@@ -75,6 +75,7 @@ export class AcceptSharedSubscriptionInvitation implements UseCaseInterface {
     await this.subscriptionSettingService.applyDefaultSubscriptionSettingsForSubscription(
       inviteeSubscription,
       inviteeSubscription.planName as SubscriptionName,
+      invitee.uuid,
     )
 
     return {

packages/auth/src/Domain/UseCase/CancelSharedSubscriptionInvitation/CancelSharedSubscriptionInvitation.spec.ts

@@ -16,6 +16,7 @@ import { DomainEventPublisherInterface, SharedSubscriptionInvitationCanceledEven
 import { DomainEventFactoryInterface } from '../../Event/DomainEventFactoryInterface'
 import { InviterIdentifierType } from '../../SharedSubscription/InviterIdentifierType'
 import { InviteeIdentifierType } from '../../SharedSubscription/InviteeIdentifierType'
+import { Logger } from 'winston'
 
 describe('CancelSharedSubscriptionInvitation', () => {
   let sharedSubscriptionInvitationRepository: SharedSubscriptionInvitationRepositoryInterface
@@ -28,6 +29,7 @@ describe('CancelSharedSubscriptionInvitation', () => {
   let invitation: SharedSubscriptionInvitation
   let domainEventPublisher: DomainEventPublisherInterface
   let domainEventFactory: DomainEventFactoryInterface
+  let logger: Logger
 
   const createUseCase = () =>
     new CancelSharedSubscriptionInvitation(
@@ -38,6 +40,7 @@ describe('CancelSharedSubscriptionInvitation', () => {
       domainEventPublisher,
       domainEventFactory,
       timer,
+      logger,
     )
 
   beforeEach(() => {
@@ -60,6 +63,9 @@ describe('CancelSharedSubscriptionInvitation', () => {
       inviteeIdentifierType: InviteeIdentifierType.Email,
     } as jest.Mocked<SharedSubscriptionInvitation>
 
+    logger = {} as jest.Mocked<Logger>
+    logger.debug = jest.fn()
+
     sharedSubscriptionInvitationRepository = {} as jest.Mocked<SharedSubscriptionInvitationRepositoryInterface>
     sharedSubscriptionInvitationRepository.findOneByUuid = jest.fn().mockReturnValue(invitation)
     sharedSubscriptionInvitationRepository.save = jest.fn()
@@ -126,7 +132,7 @@ describe('CancelSharedSubscriptionInvitation', () => {
     })
   })
 
-  it('should cancel a shared subscription invitation without subscription removal is subscription is not found', async () => {
+  it('should cancel a shared subscription invitation without subscription removal if subscription is not found', async () => {
     userSubscriptionRepository.findOneByUserUuidAndSubscriptionId = jest.fn().mockReturnValue(null)
 
     expect(
@@ -175,7 +181,7 @@ describe('CancelSharedSubscriptionInvitation', () => {
     })
   })
 
-  it('should not cancel a shared subscription invitation if invitee is not found', async () => {
+  it('should cancel a shared subscription invitation without subscription removal if invitee is not found', async () => {
     userRepository.findOneByEmail = jest.fn().mockReturnValue(null)
     expect(
       await createUseCase().execute({
@@ -183,20 +189,21 @@ describe('CancelSharedSubscriptionInvitation', () => {
         inviterEmail: 'test@test.te',
       }),
     ).toEqual({
-      success: false,
+      success: true,
     })
-  })
 
-  it('should not cancel a shared subscription invitation if invitee is not found', async () => {
-    userRepository.findOneByEmail = jest.fn().mockReturnValue(null)
-    expect(
-      await createUseCase().execute({
-        sharedSubscriptionInvitationUuid: '1-2-3',
-        inviterEmail: 'test@test.te',
-      }),
-    ).toEqual({
-      success: false,
+    expect(sharedSubscriptionInvitationRepository.save).toHaveBeenCalledWith({
+      status: 'canceled',
+      subscriptionId: 3,
+      updatedAt: 1,
+      inviterIdentifier: 'test@test.te',
+      uuid: '1-2-3',
+      inviterIdentifierType: 'email',
+      inviteeIdentifier: 'invitee@test.te',
+      inviteeIdentifierType: 'email',
     })
+    expect(userSubscriptionRepository.save).not.toHaveBeenCalled()
+    expect(roleService.removeUserRole).not.toHaveBeenCalled()
   })
 
   it('should not cancel a shared subscription invitation if inviter subscription is not found', async () => {

packages/auth/src/Domain/UseCase/CancelSharedSubscriptionInvitation/CancelSharedSubscriptionInvitation.ts

@@ -2,6 +2,7 @@ import { SubscriptionName } from '@standardnotes/common'
 import { DomainEventPublisherInterface } from '@standardnotes/domain-events'
 import { TimerInterface } from '@standardnotes/time'
 import { inject, injectable } from 'inversify'
+import { Logger } from 'winston'
 
 import TYPES from '../../../Bootstrap/Types'
 import { DomainEventFactoryInterface } from '../../Event/DomainEventFactoryInterface'
@@ -29,6 +30,7 @@ export class CancelSharedSubscriptionInvitation implements UseCaseInterface {
     @inject(TYPES.DomainEventPublisher) private domainEventPublisher: DomainEventPublisherInterface,
     @inject(TYPES.DomainEventFactory) private domainEventFactory: DomainEventFactoryInterface,
     @inject(TYPES.Timer) private timer: TimerInterface,
+    @inject(TYPES.Logger) private logger: Logger,
   ) {}
 
   async execute(dto: CancelSharedSubscriptionInvitationDTO): Promise<CancelSharedSubscriptionInvitationResponse> {
@@ -36,29 +38,34 @@ export class CancelSharedSubscriptionInvitation implements UseCaseInterface {
       dto.sharedSubscriptionInvitationUuid,
     )
     if (sharedSubscriptionInvitation === null) {
+      this.logger.debug(
+        `Could not find a shared subscription invitation with uuid ${dto.sharedSubscriptionInvitationUuid}`,
+      )
+
       return {
         success: false,
       }
     }
 
     if (dto.inviterEmail !== sharedSubscriptionInvitation.inviterIdentifier) {
+      this.logger.debug(
+        `Subscription belongs to a different inviter (${sharedSubscriptionInvitation.inviterIdentifier}). Modifier: ${dto.inviterEmail}`,
+      )
+
       return {
         success: false,
       }
     }
 
     const invitee = await this.userRepository.findOneByEmail(sharedSubscriptionInvitation.inviteeIdentifier)
-    if (invitee === null) {
-      return {
-        success: false,
-      }
-    }
 
     const inviterUserSubscriptions = await this.userSubscriptionRepository.findBySubscriptionIdAndType(
       sharedSubscriptionInvitation.subscriptionId,
       UserSubscriptionType.Regular,
     )
-    if (inviterUserSubscriptions.length !== 1) {
+    if (inviterUserSubscriptions.length === 0) {
+      this.logger.debug(`Could not find a regular subscription with id ${sharedSubscriptionInvitation.subscriptionId}`)
+
       return {
         success: false,
       }
@@ -70,20 +77,22 @@ export class CancelSharedSubscriptionInvitation implements UseCaseInterface {
 
     await this.sharedSubscriptionInvitationRepository.save(sharedSubscriptionInvitation)
 
-    await this.removeSharedSubscription(sharedSubscriptionInvitation.subscriptionId, invitee)
+    if (invitee !== null) {
+      await this.removeSharedSubscription(sharedSubscriptionInvitation.subscriptionId, invitee)
 
-    await this.roleService.removeUserRole(invitee, inviterUserSubscription.planName as SubscriptionName)
+      await this.roleService.removeUserRole(invitee, inviterUserSubscription.planName as SubscriptionName)
 
-    await this.domainEventPublisher.publish(
-      this.domainEventFactory.createSharedSubscriptionInvitationCanceledEvent({
-        inviteeIdentifier: invitee.uuid,
-        inviteeIdentifierType: InviteeIdentifierType.Uuid,
-        inviterEmail: sharedSubscriptionInvitation.inviterIdentifier,
-        inviterSubscriptionId: sharedSubscriptionInvitation.subscriptionId,
-        inviterSubscriptionUuid: inviterUserSubscription.uuid,
-        sharedSubscriptionInvitationUuid: sharedSubscriptionInvitation.uuid,
-      }),
-    )
+      await this.domainEventPublisher.publish(
+        this.domainEventFactory.createSharedSubscriptionInvitationCanceledEvent({
+          inviteeIdentifier: invitee.uuid,
+          inviteeIdentifierType: InviteeIdentifierType.Uuid,
+          inviterEmail: sharedSubscriptionInvitation.inviterIdentifier,
+          inviterSubscriptionId: sharedSubscriptionInvitation.subscriptionId,
+          inviterSubscriptionUuid: inviterUserSubscription.uuid,
+          sharedSubscriptionInvitationUuid: sharedSubscriptionInvitation.uuid,
+        }),
+      )
+    }
 
     return {
       success: true,

packages/auth/src/Domain/UseCase/CreateCrossServiceToken/CreateCrossServiceToken.spec.ts

@@ -0,0 +1,173 @@
+import 'reflect-metadata'
+
+import { TokenEncoderInterface, CrossServiceTokenData } from '@standardnotes/security'
+import { ProjectorInterface } from '../../../Projection/ProjectorInterface'
+import { Session } from '../../Session/Session'
+import { User } from '../../User/User'
+import { Role } from '../../Role/Role'
+import { UserRepositoryInterface } from '../../User/UserRepositoryInterface'
+import { GetUserAnalyticsId } from '../GetUserAnalyticsId/GetUserAnalyticsId'
+
+import { CreateCrossServiceToken } from './CreateCrossServiceToken'
+
+describe('CreateCrossServiceToken', () => {
+  let userProjector: ProjectorInterface<User>
+  let sessionProjector: ProjectorInterface<Session>
+  let roleProjector: ProjectorInterface<Role>
+  let tokenEncoder: TokenEncoderInterface<CrossServiceTokenData>
+  let getUserAnalyticsId: GetUserAnalyticsId
+  let userRepository: UserRepositoryInterface
+  const jwtTTL = 60
+
+  let session: Session
+  let user: User
+  let role: Role
+
+  const createUseCase = (analyticsEnabled = true) =>
+    new CreateCrossServiceToken(
+      userProjector,
+      sessionProjector,
+      roleProjector,
+      tokenEncoder,
+      getUserAnalyticsId,
+      userRepository,
+      analyticsEnabled,
+      jwtTTL,
+    )
+
+  beforeEach(() => {
+    session = {} as jest.Mocked<Session>
+
+    user = {} as jest.Mocked<User>
+    user.roles = Promise.resolve([role])
+
+    userProjector = {} as jest.Mocked<ProjectorInterface<User>>
+    userProjector.projectSimple = jest.fn().mockReturnValue({ bar: 'baz' })
+
+    roleProjector = {} as jest.Mocked<ProjectorInterface<Role>>
+    roleProjector.projectSimple = jest.fn().mockReturnValue({ name: 'role1', uuid: '1-3-4' })
+
+    sessionProjector = {} as jest.Mocked<ProjectorInterface<Session>>
+    sessionProjector.projectCustom = jest.fn().mockReturnValue({ foo: 'bar' })
+    sessionProjector.projectSimple = jest.fn().mockReturnValue({ test: 'test' })
+
+    tokenEncoder = {} as jest.Mocked<TokenEncoderInterface<CrossServiceTokenData>>
+    tokenEncoder.encodeExpirableToken = jest.fn().mockReturnValue('foobar')
+
+    getUserAnalyticsId = {} as jest.Mocked<GetUserAnalyticsId>
+    getUserAnalyticsId.execute = jest.fn().mockReturnValue({ analyticsId: 123 })
+
+    userRepository = {} as jest.Mocked<UserRepositoryInterface>
+    userRepository.findOneByUuid = jest.fn().mockReturnValue(user)
+  })
+
+  it('should create a cross service token for user', async () => {
+    await createUseCase().execute({
+      user,
+      session,
+    })
+
+    expect(tokenEncoder.encodeExpirableToken).toHaveBeenCalledWith(
+      {
+        analyticsId: 123,
+        roles: [
+          {
+            name: 'role1',
+            uuid: '1-3-4',
+          },
+        ],
+        session: {
+          test: 'test',
+        },
+        user: {
+          bar: 'baz',
+        },
+      },
+      60,
+    )
+  })
+
+  it('should create a cross service token for user - analytics disabled', async () => {
+    await createUseCase(false).execute({
+      user,
+      session,
+    })
+
+    expect(tokenEncoder.encodeExpirableToken).toHaveBeenCalledWith(
+      {
+        roles: [
+          {
+            name: 'role1',
+            uuid: '1-3-4',
+          },
+        ],
+        session: {
+          test: 'test',
+        },
+        user: {
+          bar: 'baz',
+        },
+      },
+      60,
+    )
+  })
+
+  it('should create a cross service token for user without a session', async () => {
+    await createUseCase().execute({
+      user,
+    })
+
+    expect(tokenEncoder.encodeExpirableToken).toHaveBeenCalledWith(
+      {
+        analyticsId: 123,
+        roles: [
+          {
+            name: 'role1',
+            uuid: '1-3-4',
+          },
+        ],
+        user: {
+          bar: 'baz',
+        },
+      },
+      60,
+    )
+  })
+
+  it('should create a cross service token for user by user uuid', async () => {
+    await createUseCase().execute({
+      userUuid: '1-2-3',
+    })
+
+    expect(tokenEncoder.encodeExpirableToken).toHaveBeenCalledWith(
+      {
+        analyticsId: 123,
+        roles: [
+          {
+            name: 'role1',
+            uuid: '1-3-4',
+          },
+        ],
+        user: {
+          bar: 'baz',
+        },
+      },
+      60,
+    )
+  })
+
+  it('should throw an error if user does not exist', async () => {
+    userRepository.findOneByUuid = jest.fn().mockReturnValue(null)
+
+    let caughtError = null
+    try {
+      await createUseCase().execute({
+        userUuid: '1-2-3',
+      })
+    } catch (error) {
+      caughtError = error
+    }
+
+    expect(caughtError).not.toBeNull()
+  })
+})

packages/auth/src/Domain/UseCase/CreateCrossServiceToken/CreateCrossServiceToken.ts

@@ -0,0 +1,91 @@
+import { RoleName } from '@standardnotes/common'
+import { TokenEncoderInterface, CrossServiceTokenData } from '@standardnotes/security'
+
+import { inject, injectable } from 'inversify'
+import TYPES from '../../../Bootstrap/Types'
+import { ProjectorInterface } from '../../../Projection/ProjectorInterface'
+import { Role } from '../../Role/Role'
+import { Session } from '../../Session/Session'
+import { User } from '../../User/User'
+import { UserRepositoryInterface } from '../../User/UserRepositoryInterface'
+import { GetUserAnalyticsId } from '../GetUserAnalyticsId/GetUserAnalyticsId'
+import { UseCaseInterface } from '../UseCaseInterface'
+import { CreateCrossServiceTokenDTO } from './CreateCrossServiceTokenDTO'
+import { CreateCrossServiceTokenResponse } from './CreateCrossServiceTokenResponse'
+
+@injectable()
+export class CreateCrossServiceToken implements UseCaseInterface {
+  constructor(
+    @inject(TYPES.UserProjector) private userProjector: ProjectorInterface<User>,
+    @inject(TYPES.SessionProjector) private sessionProjector: ProjectorInterface<Session>,
+    @inject(TYPES.RoleProjector) private roleProjector: ProjectorInterface<Role>,
+    @inject(TYPES.CrossServiceTokenEncoder) private tokenEncoder: TokenEncoderInterface<CrossServiceTokenData>,
+    @inject(TYPES.GetUserAnalyticsId) private getUserAnalyticsId: GetUserAnalyticsId,
+    @inject(TYPES.UserRepository) private userRepository: UserRepositoryInterface,
+    @inject(TYPES.ANALYTICS_ENABLED) private analyticsEnabled: boolean,
+    @inject(TYPES.AUTH_JWT_TTL) private jwtTTL: number,
+  ) {}
+
+  async execute(dto: CreateCrossServiceTokenDTO): Promise<CreateCrossServiceTokenResponse> {
+    let user: User | undefined | null = dto.user
+    if (user === undefined && dto.userUuid !== undefined) {
+      user = await this.userRepository.findOneByUuid(dto.userUuid)
+    }
+
+    if (!user) {
+      throw new Error(`Could not find user with uuid ${dto.userUuid}`)
+    }
+
+    const roles = await user.roles
+
+    const authTokenData: CrossServiceTokenData = {
+      user: this.projectUser(user),
+      roles: this.projectRoles(roles),
+    }
+
+    if (this.analyticsEnabled) {
+      const { analyticsId } = await this.getUserAnalyticsId.execute({ userUuid: user.uuid })
+      authTokenData.analyticsId = analyticsId
+    }
+
+    if (dto.session !== undefined) {
+      authTokenData.session = this.projectSession(dto.session)
+    }
+
+    return {
+      token: this.tokenEncoder.encodeExpirableToken(authTokenData, this.jwtTTL),
+    }
+  }
+
+  private projectUser(user: User): { uuid: string; email: string } {
+    return <{ uuid: string; email: string }>this.userProjector.projectSimple(user)
+  }
+
+  private projectSession(session: Session): {
+    uuid: string
+    api_version: string
+    created_at: string
+    updated_at: string
+    device_info: string
+    readonly_access: boolean
+    access_expiration: string
+    refresh_expiration: string
+  } {
+    return <
+      {
+        uuid: string
+        api_version: string
+        created_at: string
+        updated_at: string
+        device_info: string
+        readonly_access: boolean
+        access_expiration: string
+        refresh_expiration: string
+      }
+    >this.sessionProjector.projectSimple(session)
+  }
+
+  private projectRoles(roles: Array<Role>): Array<{ uuid: string; name: RoleName }> {
+    return roles.map((role) => <{ uuid: string; name: RoleName }>this.roleProjector.projectSimple(role))
+  }
+}

packages/auth/src/Domain/UseCase/CreateCrossServiceToken/CreateCrossServiceTokenDTO.ts

@@ -0,0 +1,13 @@
+import { Either, Uuid } from '@standardnotes/common'
+import { Session } from '../../Session/Session'
+import { User } from '../../User/User'
+
+export type CreateCrossServiceTokenDTO = Either<
+  {
+    user: User
+    session?: Session
+  },
+  {
+    userUuid: Uuid
+  }
+>

packages/auth/src/Domain/UseCase/CreateCrossServiceToken/CreateCrossServiceTokenResponse.ts

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

packages/auth/src/Domain/UseCase/CreateSubscriptionToken/CreateSubscriptionToken.spec.ts

@@ -5,17 +5,19 @@ import { TimerInterface } from '@standardnotes/time'
 import { SubscriptionTokenRepositoryInterface } from '../../Subscription/SubscriptionTokenRepositoryInterface'
 
 import { CreateSubscriptionToken } from './CreateSubscriptionToken'
+import { Logger } from 'winston'
 
 describe('CreateSubscriptionToken', () => {
   let subscriptionTokenRepository: SubscriptionTokenRepositoryInterface
   let cryptoNode: CryptoNode
   let timer: TimerInterface
+  let logger: Logger
 
-  const createUseCase = () => new CreateSubscriptionToken(subscriptionTokenRepository, cryptoNode, timer)
+  const createUseCase = () => new CreateSubscriptionToken(subscriptionTokenRepository, cryptoNode, timer, logger)
 
   beforeEach(() => {
     subscriptionTokenRepository = {} as jest.Mocked<SubscriptionTokenRepositoryInterface>
-    subscriptionTokenRepository.save = jest.fn()
+    subscriptionTokenRepository.save = jest.fn().mockReturnValue(true)
 
     cryptoNode = {} as jest.Mocked<CryptoNode>
     cryptoNode.generateRandomKey = jest.fn().mockReturnValueOnce('random-string')
@@ -23,6 +25,9 @@ describe('CreateSubscriptionToken', () => {
     timer = {} as jest.Mocked<TimerInterface>
     timer.convertStringDateToMicroseconds = jest.fn().mockReturnValue(1)
     timer.getUTCDateNHoursAhead = jest.fn().mockReturnValue(new Date(1))
+
+    logger = {} as jest.Mocked<Logger>
+    logger.error = jest.fn()
   })
 
   it('should create an subscription token and persist it', async () => {
@@ -36,4 +41,19 @@ describe('CreateSubscriptionToken', () => {
       expiresAt: 1,
     })
   })
+
+  it('should throw an error if the subscription token was not created', async () => {
+    subscriptionTokenRepository.save = jest.fn().mockReturnValue(false)
+
+    let caughtError = null
+    try {
+      await createUseCase().execute({
+        userUuid: '1-2-3',
+      })
+    } catch (error) {
+      caughtError = error
+    }
+
+    expect(caughtError).not.toBeNull()
+  })
 })

packages/auth/src/Domain/UseCase/CreateSubscriptionToken/CreateSubscriptionToken.ts

@@ -1,6 +1,7 @@
 import { CryptoNode } from '@standardnotes/sncrypto-node'
 import { TimerInterface } from '@standardnotes/time'
 import { inject, injectable } from 'inversify'
+import { Logger } from 'winston'
 
 import TYPES from '../../../Bootstrap/Types'
 import { SubscriptionTokenRepositoryInterface } from '../../Subscription/SubscriptionTokenRepositoryInterface'
@@ -15,6 +16,7 @@ export class CreateSubscriptionToken implements UseCaseInterface {
     private subscriptionTokenRepository: SubscriptionTokenRepositoryInterface,
     @inject(TYPES.CryptoNode) private cryptoNode: CryptoNode,
     @inject(TYPES.Timer) private timer: TimerInterface,
+    @inject(TYPES.Logger) private logger: Logger,
   ) {}
 
   async execute(dto: CreateSubscriptionTokenDTO): Promise<CreateSubscriptionTokenResponse> {
@@ -26,7 +28,13 @@ export class CreateSubscriptionToken implements UseCaseInterface {
       expiresAt: this.timer.convertStringDateToMicroseconds(this.timer.getUTCDateNHoursAhead(3).toString()),
     }
 
-    await this.subscriptionTokenRepository.save(subscriptionToken)
+    const subscriptionTokenWasSaved = await this.subscriptionTokenRepository.save(subscriptionToken)
+
+    if (!subscriptionTokenWasSaved) {
+      this.logger.error(`Could not create subscription token for user ${dto.userUuid}`)
+
+      throw new Error('Could not create subscription token')
+    }
 
     return {
       subscriptionToken,

packages/auth/src/Domain/UseCase/CreateValetToken/CreateValetToken.spec.ts

@@ -1,6 +1,6 @@
 import 'reflect-metadata'
 
-import { TokenEncoderInterface, ValetTokenData } from '@standardnotes/security'
+import { TokenEncoderInterface, ValetTokenData, ValetTokenOperation } from '@standardnotes/security'
 import { CreateValetToken } from './CreateValetToken'
 import { TimerInterface } from '@standardnotes/time'
 import { UserSubscription } from '../../Subscription/UserSubscription'
@@ -70,7 +70,7 @@ describe('CreateValetToken', () => {
 
   it('should create a read valet token', async () => {
     const response = await createUseCase().execute({
-      operation: 'read',
+      operation: ValetTokenOperation.Read,
       userUuid: '1-2-3',
       resources: [
         {
@@ -92,7 +92,7 @@ describe('CreateValetToken', () => {
       .mockReturnValue({ regularSubscription: null, sharedSubscription: null })
 
     const response = await createUseCase().execute({
-      operation: 'read',
+      operation: ValetTokenOperation.Read,
       userUuid: '1-2-3',
       resources: [
         {
@@ -117,7 +117,7 @@ describe('CreateValetToken', () => {
     timer.getTimestampInMicroseconds = jest.fn().mockReturnValue(150)
 
     const response = await createUseCase().execute({
-      operation: 'read',
+      operation: ValetTokenOperation.Read,
       userUuid: '1-2-3',
       resources: [
         {
@@ -135,7 +135,7 @@ describe('CreateValetToken', () => {
 
   it('should not create a write valet token if unencrypted file size has not been provided for a resource', async () => {
     const response = await createUseCase().execute({
-      operation: 'write',
+      operation: ValetTokenOperation.Write,
       resources: [
         {
           remoteIdentifier: '2-3-4',
@@ -152,7 +152,7 @@ describe('CreateValetToken', () => {
 
   it('should create a write valet token', async () => {
     const response = await createUseCase().execute({
-      operation: 'write',
+      operation: ValetTokenOperation.Write,
       resources: [
         {
           remoteIdentifier: '2-3-4',
@@ -192,7 +192,7 @@ describe('CreateValetToken', () => {
       .mockReturnValue({ regularSubscription, sharedSubscription })
 
     const response = await createUseCase().execute({
-      operation: 'write',
+      operation: ValetTokenOperation.Write,
       resources: [
         {
           remoteIdentifier: '2-3-4',
@@ -232,7 +232,7 @@ describe('CreateValetToken', () => {
       .mockReturnValue({ regularSubscription: null, sharedSubscription })
 
     const response = await createUseCase().execute({
-      operation: 'write',
+      operation: ValetTokenOperation.Write,
       resources: [
         {
           remoteIdentifier: '2-3-4',
@@ -252,7 +252,7 @@ describe('CreateValetToken', () => {
     subscriptionSettingService.findSubscriptionSettingWithDecryptedValue = jest.fn().mockReturnValue(null)
 
     const response = await createUseCase().execute({
-      operation: 'write',
+      operation: ValetTokenOperation.Write,
       userUuid: '1-2-3',
       resources: [
         {

packages/auth/src/Domain/UseCase/CreateValetToken/CreateValetTokenDTO.ts

@@ -1,5 +1,10 @@
-import { CreateValetTokenPayload } from '@standardnotes/responses'
+import { ValetTokenOperation } from '@standardnotes/security'
 
-export type CreateValetTokenDTO = CreateValetTokenPayload & {
+export type CreateValetTokenDTO = {
+  operation: ValetTokenOperation
+  resources: Array<{
+    remoteIdentifier: string
+    unencryptedFileSize?: number
+  }>
   userUuid: string
 }

packages/auth/src/Domain/UseCase/CreateWebSocketConnectionToken/CreateWebSocketConnection.spec.ts

@@ -0,0 +1,25 @@
+import 'reflect-metadata'
+
+import { TokenEncoderInterface, WebSocketConnectionTokenData } from '@standardnotes/security'
+
+import { CreateWebSocketConnectionToken } from './CreateWebSocketConnectionToken'
+
+describe('CreateWebSocketConnection', () => {
+  let tokenEncoder: TokenEncoderInterface<WebSocketConnectionTokenData>
+  const tokenTTL = 30
+
+  const createUseCase = () => new CreateWebSocketConnectionToken(tokenEncoder, tokenTTL)
+
+  beforeEach(() => {
+    tokenEncoder = {} as jest.Mocked<TokenEncoderInterface<WebSocketConnectionTokenData>>
+    tokenEncoder.encodeExpirableToken = jest.fn().mockReturnValue('foobar')
+  })
+
+  it('should create a web socket connection token', async () => {
+    const result = await createUseCase().execute({ userUuid: '1-2-3' })
+
+    expect(result.token).toEqual('foobar')
+
+    expect(tokenEncoder.encodeExpirableToken).toHaveBeenCalledWith({ userUuid: '1-2-3' }, 30)
+  })
+})

packages/auth/src/Domain/UseCase/CreateWebSocketConnectionToken/CreateWebSocketConnectionDTO.ts

@@ -0,0 +1,3 @@
+export type CreateWebSocketConnectionDTO = {
+  userUuid: string
+}

packages/auth/src/Domain/UseCase/CreateWebSocketConnectionToken/CreateWebSocketConnectionResponse.ts

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

packages/auth/src/Domain/UseCase/CreateWebSocketConnectionToken/CreateWebSocketConnectionToken.ts

@@ -0,0 +1,26 @@
+import { TokenEncoderInterface, WebSocketConnectionTokenData } from '@standardnotes/security'
+import { inject, injectable } from 'inversify'
+
+import TYPES from '../../../Bootstrap/Types'
+import { UseCaseInterface } from '../UseCaseInterface'
+import { CreateWebSocketConnectionDTO } from './CreateWebSocketConnectionDTO'
+import { CreateWebSocketConnectionResponse } from './CreateWebSocketConnectionResponse'
+
+@injectable()
+export class CreateWebSocketConnectionToken implements UseCaseInterface {
+  constructor(
+    @inject(TYPES.WebSocketConnectionTokenEncoder)
+    private tokenEncoder: TokenEncoderInterface<WebSocketConnectionTokenData>,
+    @inject(TYPES.WEB_SOCKET_CONNECTION_TOKEN_TTL) private tokenTTL: number,
+  ) {}
+
+  async execute(dto: CreateWebSocketConnectionDTO): Promise<CreateWebSocketConnectionResponse> {
+    const data: WebSocketConnectionTokenData = {
+      userUuid: dto.userUuid,
+    }
+
+    return {
+      token: this.tokenEncoder.encodeExpirableToken(data, this.tokenTTL),
+    }
+  }
+}