Type updates for plan changed event

packages/backend-core/src/events/publishers/license.ts

@@ -3,30 +3,28 @@ import {
   Event,
   LicenseActivatedEvent,
   LicensePlanChangedEvent,
-  LicenseTierChangedEvent,
   PlanType,
   Account,
   LicensePortalOpenedEvent,
   LicenseCheckoutSuccessEvent,
   LicenseCheckoutOpenedEvent,
   LicensePaymentFailedEvent,
-  LicensePaymentRecoveredEvent,
+  LicensePaymentRecoveredEvent, PriceDuration,
 } from "@budibase/types"
 
-async function tierChanged(account: Account, from: number, to: number) {
+async function planChanged(
-  const properties: LicenseTierChangedEvent = {
+  account: Account,
-    accountId: account.accountId,
+  from: PlanType,
-    to,
+  to: PlanType,
-    from,
+  quantity: number | undefined,
-  }
+  duration: PriceDuration | undefined
-  await publishEvent(Event.LICENSE_TIER_CHANGED, properties)
+) {
-}
-
-async function planChanged(account: Account, from: PlanType, to: PlanType) {
   const properties: LicensePlanChangedEvent = {
     accountId: account.accountId,
     to,
     from,
+    quantity,
+    duration
   }
   await publishEvent(Event.LICENSE_PLAN_CHANGED, properties)
 }
@@ -74,7 +72,6 @@ async function paymentRecovered(account: Account) {
 }
 
 export default {
-  tierChanged,
   planChanged,
   activated,
   checkoutOpened,

packages/backend-core/tests/core/utilities/mocks/events.ts

@@ -123,7 +123,6 @@ beforeAll(async () => {
   jest.spyOn(events.plugin, "imported")
   jest.spyOn(events.plugin, "deleted")
 
-  jest.spyOn(events.license, "tierChanged")
   jest.spyOn(events.license, "planChanged")
   jest.spyOn(events.license, "activated")
   jest.spyOn(events.license, "checkoutOpened")

packages/types/src/documents/account/account.ts

@@ -39,6 +39,7 @@ export interface Account extends CreateAccount {
   // licensing
   tier: string // deprecated
   planType?: PlanType
+  /** @deprecated */
   planTier?: number
   license?: License
   installId?: string

packages/types/src/sdk/events/event.ts

@@ -138,7 +138,6 @@ export enum Event {
 
   // LICENSE
   LICENSE_PLAN_CHANGED = "license:plan:changed",
-  LICENSE_TIER_CHANGED = "license:tier:changed",
   LICENSE_ACTIVATED = "license:activated",
   LICENSE_PAYMENT_FAILED = "license:payment:failed",
   LICENSE_PAYMENT_RECOVERED = "license:payment:recovered",
@@ -328,7 +327,6 @@ export const AuditedEventFriendlyName: Record<Event, string | undefined> = {
 
   // LICENSE - NOT AUDITED
   [Event.LICENSE_PLAN_CHANGED]: undefined,
-  [Event.LICENSE_TIER_CHANGED]: undefined,
   [Event.LICENSE_ACTIVATED]: undefined,
   [Event.LICENSE_PAYMENT_FAILED]: undefined,
   [Event.LICENSE_PAYMENT_RECOVERED]: undefined,

packages/types/src/sdk/events/license.ts

@@ -1,15 +1,15 @@
-import { PlanType } from "../licensing"
+import { PlanType, PriceDuration } from "../licensing"
-
-export interface LicenseTierChangedEvent {
-  accountId: string
-  from: number
-  to: number
-}
 
 export interface LicensePlanChangedEvent {
   accountId: string
   from: PlanType
   to: PlanType
+  // may not be on historical events
+  // free plans won't have a duration
+  duration: PriceDuration | undefined
+  // may not be on historical events
+  // free plans won't have a quantity
+  quantity: number | undefined
 }
 
 export interface LicenseActivatedEvent {