@budibase/types 2.5.6-alpha.16 → 2.5.6-alpha.18

package/src/sdk/licensing/plan.ts

@@ -1,12 +1,10 @@
-export interface AccountPlan {
-  type: PlanType
-  price?: Price
-}
-
 export enum PlanType {
   FREE = "free",
+  /** @deprecated */
   PRO = "pro",
+  /** @deprecated */
   TEAM = "team",
+  PREMIUM = "premium",
   BUSINESS = "business",
   ENTERPRISE = "enterprise",
 }
@@ -16,12 +14,36 @@ export enum PriceDuration {
   YEARLY = "yearly",
 }
 
-export interface Price {
+export interface AvailablePlan {
+  type: PlanType
+  maxUsers: number
+  minUsers: number
+  prices: AvailablePrice[]
+}
+
+export interface AvailablePrice {
   amount: number
   amountMonthly: number
   currency: string
   duration: PriceDuration
   priceId: string
-  dayPasses: number
+}
+
+export enum PlanModel {
+  PER_USER = "perUser",
+  DAY_PASS = "dayPass",
+}
+
+export interface PurchasedPlan {
+  type: PlanType
+  model: PlanModel
+  usesInvoicing: boolean
+  minUsers: number
+  price?: PurchasedPrice
+}
+
+export interface PurchasedPrice extends AvailablePrice {
+  dayPasses: number | undefined
+  /** @deprecated - now at the plan level via model */
   isPerUser: boolean
 }

package/src/sdk/licensing/quota.ts

@@ -13,6 +13,7 @@ export enum QuotaType {
 export enum StaticQuotaName {
   ROWS = "rows",
   APPS = "apps",
+  USERS = "users",
   USER_GROUPS = "userGroups",
   PLUGINS = "plugins",
 }
@@ -54,14 +55,14 @@ export const isConstantQuota = (
   return quotaType === QuotaType.CONSTANT
 }
 
-export type PlanQuotas = {
-  [PlanType.FREE]: Quotas
-  [PlanType.PRO]: Quotas
-  [PlanType.TEAM]: Quotas
-  [PlanType.BUSINESS]: Quotas
-  [PlanType.ENTERPRISE]: Quotas
+export interface Minimums {
+  users: number
 }
 
+export type PlanMinimums = { [key in PlanType]: Minimums }
+
+export type PlanQuotas = { [key in PlanType]: Quotas | undefined }
+
 export type MonthlyQuotas = {
   [MonthlyQuotaName.QUERIES]: Quota
   [MonthlyQuotaName.AUTOMATIONS]: Quota
@@ -71,6 +72,7 @@ export type MonthlyQuotas = {
 export type StaticQuotas = {
   [StaticQuotaName.ROWS]: Quota
   [StaticQuotaName.APPS]: Quota
+  [StaticQuotaName.USERS]: Quota
   [StaticQuotaName.USER_GROUPS]: Quota
   [StaticQuotaName.PLUGINS]: Quota
 }
@@ -99,4 +101,5 @@ export interface Quota {
    * which can have subsequent effects such as sending emails to users.
    */
   triggers: number[]
+  startDate?: number
 }

package/src/sdk/locks.ts

@@ -1,3 +1,5 @@
+import Redlock from "redlock"
+
 export enum LockType {
   /**
    * If this lock is already held the attempted operation will not be performed.
@@ -6,6 +8,7 @@ export enum LockType {
   TRY_ONCE = "try_once",
   DEFAULT = "default",
   DELAY_500 = "delay_500",
+  CUSTOM = "custom",
 }
 
 export enum LockName {
@@ -14,6 +17,7 @@ export enum LockName {
   SYNC_ACCOUNT_LICENSE = "sync_account_license",
   UPDATE_TENANTS_DOC = "update_tenants_doc",
   PERSIST_WRITETHROUGH = "persist_writethrough",
+  QUOTA_USAGE_EVENT = "quota_usage_event",
 }
 
 export interface LockOptions {
@@ -21,6 +25,11 @@ export interface LockOptions {
    * The lock type determines which client to use
    */
   type: LockType
+  /**
+   * The custom options to use when creating the redlock instance
+   * type must be set to custom for the options to be applied
+   */
+  customOptions?: Redlock.Options
   /**
    * The name for the lock
    */