@budibase/types 2.5.6-alpha.3 → 2.5.6-alpha.31

package/src/documents/app/automation.ts

@@ -1,6 +1,32 @@
 import { Document } from "../document"
 import { EventEmitter } from "events"
 
+export enum AutomationIOType {
+  OBJECT = "object",
+  STRING = "string",
+  BOOLEAN = "boolean",
+  NUMBER = "number",
+  ARRAY = "array",
+}
+
+export enum AutomationCustomIOType {
+  TABLE = "table",
+  ROW = "row",
+  ROWS = "rows",
+  WIDE = "wide",
+  QUERY = "query",
+  QUERY_PARAMS = "queryParams",
+  QUERY_LIMIT = "queryLimit",
+  LOOP_OPTION = "loopOption",
+  ITEM = "item",
+  CODE = "code",
+  FILTERS = "filters",
+  COLUMN = "column",
+  TRIGGER_SCHEMA = "triggerSchema",
+  CRON = "cron",
+  WEBHOOK_URL = "webhookUrl",
+}
+
 export enum AutomationTriggerStepId {
   ROW_SAVED = "ROW_SAVED",
   ROW_UPDATED = "ROW_UPDATED",
@@ -10,6 +36,12 @@ export enum AutomationTriggerStepId {
   CRON = "CRON",
 }
 
+export enum AutomationStepType {
+  LOGIC = "LOGIC",
+  ACTION = "ACTION",
+  TRIGGER = "TRIGGER",
+}
+
 export enum AutomationActionStepId {
   SEND_EMAIL_SMTP = "SEND_EMAIL_SMTP",
   CREATE_ROW = "CREATE_ROW",
@@ -31,14 +63,43 @@ export enum AutomationActionStepId {
   integromat = "integromat",
 }
 
+export const AutomationStepIdArray = [
+  ...Object.values(AutomationActionStepId),
+  ...Object.values(AutomationTriggerStepId),
+]
+
 export interface Automation extends Document {
   definition: {
     steps: AutomationStep[]
     trigger: AutomationTrigger
   }
+  screenId?: string
+  uiTree?: any
   appId: string
   live?: boolean
   name: string
+  internal?: boolean
+  type?: string
+}
+
+interface BaseIOStructure {
+  type?: AutomationIOType
+  customType?: AutomationCustomIOType
+  title?: string
+  description?: string
+  enum?: string[]
+  pretty?: string[]
+  properties?: {
+    [key: string]: BaseIOStructure
+  }
+  required?: string[]
+}
+
+interface InputOutputBlock {
+  properties: {
+    [key: string]: BaseIOStructure
+  }
+  required?: string[]
 }
 
 export interface AutomationStepSchema {
@@ -46,7 +107,7 @@ export interface AutomationStepSchema {
   tagline: string
   icon: string
   description: string
-  type: string
+  type: AutomationStepType
   internal?: boolean
   deprecated?: boolean
   stepId: AutomationTriggerStepId | AutomationActionStepId
@@ -55,14 +116,10 @@ export interface AutomationStepSchema {
     [key: string]: any
   }
   schema: {
-    inputs: {
-      [key: string]: any
-    }
-    outputs: {
-      [key: string]: any
-    }
-    required?: string[]
+    inputs: InputOutputBlock
+    outputs: InputOutputBlock
   }
+  custom?: boolean
 }
 
 export interface AutomationStep extends AutomationStepSchema {

package/src/documents/app/table.ts

@@ -31,6 +31,8 @@ export interface FieldSchema {
   timeOnly?: boolean
   lastID?: number
   useRichText?: boolean | null
+  order?: number
+  width?: number
   meta?: {
     toTable: string
     toKey: string
@@ -77,6 +79,7 @@ export interface Table extends Document {
   indexes?: { [key: string]: any }
   rows?: { [key: string]: any }
   created?: boolean
+  rowHeight?: number
 }
 
 export interface TableRequest extends Table {

package/src/documents/global/plugin.ts

@@ -3,6 +3,7 @@ import { Document } from "../document"
 export enum PluginType {
   DATASOURCE = "datasource",
   COMPONENT = "component",
+  AUTOMATION = "automation",
 }
 
 export enum PluginSource {

package/src/documents/global/quotas.ts

@@ -31,6 +31,7 @@ export type QuotaTriggers = {
 export interface StaticUsage {
   [StaticQuotaName.APPS]: number
   [StaticQuotaName.PLUGINS]: number
+  [StaticQuotaName.USERS]: number
   [StaticQuotaName.USER_GROUPS]: number
   [StaticQuotaName.ROWS]: number
   triggers: {

package/src/sdk/licensing/billing.ts

@@ -7,6 +7,7 @@ export interface Customer {
 
 export interface Subscription {
   amount: number
+  currency: string
   quantity: number
   duration: PriceDuration
   cancelAt: number | null | undefined

package/src/sdk/licensing/feature.ts

@@ -1,3 +1,5 @@
+import { PlanType } from "./plan"
+
 export enum Feature {
   USER_GROUPS = "userGroups",
   APP_BACKUPS = "appBackups",
@@ -7,3 +9,5 @@ export enum Feature {
   BRANDING = "branding",
   SCIM = "scim",
 }
+
+export type PlanFeatures = { [key in PlanType]: Feature[] | undefined }

package/src/sdk/licensing/license.ts

@@ -1,8 +1,9 @@
-import { AccountPlan, Quotas, Feature, Billing } from "."
+import { PurchasedPlan, Quotas, Feature, Billing } from "."
 
 export interface License {
   features: Feature[]
   quotas: Quotas
-  plan: AccountPlan
+  plan: PurchasedPlan
   billing?: Billing
+  testClockId?: string
 }

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
    */

package/src/shared/index.ts

@@ -0,0 +1 @@
+export * from "./typeUtils"

package/src/shared/typeUtils.ts

@@ -0,0 +1,3 @@
+export type DeepPartial<T> = {
+  [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P]
+}