@budibase/types 2.5.8 → 2.5.10-alpha.0

package/src/api/web/user.ts

@@ -22,15 +22,19 @@ export interface BulkUserRequest {
   }
 }
 
+export interface BulkUserCreated {
+  successful: UserDetails[]
+  unsuccessful: { email: string; reason: string }[]
+}
+
+export interface BulkUserDeleted {
+  successful: UserDetails[]
+  unsuccessful: { _id: string; email: string; reason: string }[]
+}
+
 export interface BulkUserResponse {
-  created?: {
-    successful: UserDetails[]
-    unsuccessful: { email: string; reason: string }[]
-  }
-  deleted?: {
-    successful: UserDetails[]
-    unsuccessful: { _id: string; email: string; reason: string }[]
-  }
+  created?: BulkUserCreated
+  deleted?: BulkUserDeleted
   message?: string
 }
 

package/src/documents/account/account.ts

@@ -1,14 +1,6 @@
-import {
-  Feature,
-  Hosting,
-  License,
-  MonthlyQuotaName,
-  PlanType,
-  PriceDuration,
-  Quotas,
-  StaticQuotaName,
-} from "../../sdk"
-import { MonthlyUsage, QuotaUsage, StaticUsage } from "../global"
+import { Feature, Hosting, License, PlanType, Quotas } from "../../sdk"
+import { DeepPartial } from "../../shared"
+import { QuotaUsage } from "../global"
 
 export interface CreateAccount {
   email: string
@@ -34,7 +26,7 @@ export const isCreatePasswordAccount = (
 
 export interface LicenseOverrides {
   features?: Feature[]
-  quotas?: Quotas
+  quotas?: DeepPartial<Quotas>
 }
 
 export interface Account extends CreateAccount {
@@ -47,11 +39,16 @@ export interface Account extends CreateAccount {
   // licensing
   tier: string // deprecated
   planType?: PlanType
+  /** @deprecated */
   planTier?: number
   license?: License
+  installId?: string
+  installTenantId?: string
+  installVersion?: string
   stripeCustomerId?: string
   licenseKey?: string
   licenseKeyActivatedAt?: number
+  licenseRequestedAt?: number
   licenseOverrides?: LicenseOverrides
   quotaUsage?: QuotaUsage
 }

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 {
@@ -83,6 +140,7 @@ export enum AutomationStatus {
   ERROR = "error",
   STOPPED = "stopped",
   STOPPED_ERROR = "stopped_error",
+  NO_ITERATIONS = "no_iterations",
 }
 
 export interface AutomationResults {

package/src/documents/app/query.ts

@@ -42,3 +42,10 @@ export interface PaginationValues {
   page: string | number | null
   limit: number | null
 }
+
+export interface PreviewQueryRequest extends Omit<Query, "parameters"> {
+  parameters: {}
+  flags?: {
+    urlName?: boolean
+  }
+}

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/app/user.ts

@@ -2,4 +2,5 @@ import { Document } from "../document"
 
 export interface UserMetadata extends Document {
   roleId: string
+  email?: string
 }

package/src/documents/global/config.ts

@@ -1,8 +1,8 @@
 import { Document } from "../document"
 
-export interface Config extends Document {
+export interface Config<T = any> extends Document {
   type: ConfigType
-  config: any
+  config: T
 }
 
 export interface SMTPInnerConfig {
@@ -18,9 +18,7 @@ export interface SMTPInnerConfig {
   connectionTimeout?: any
 }
 
-export interface SMTPConfig extends Config {
-  config: SMTPInnerConfig
-}
+export interface SMTPConfig extends Config<SMTPInnerConfig> {}
 
 /**
  * Accessible only via pro.
@@ -50,9 +48,7 @@ export interface SettingsInnerConfig {
   isSSOEnforced?: boolean
 }
 
-export interface SettingsConfig extends Config {
-  config: SettingsInnerConfig
-}
+export interface SettingsConfig extends Config<SettingsInnerConfig> {}
 
 export type SSOConfigType = ConfigType.GOOGLE | ConfigType.OIDC
 export type SSOConfig = GoogleInnerConfig | OIDCInnerConfig
@@ -67,9 +63,7 @@ export interface GoogleInnerConfig {
   callbackURL?: string
 }
 
-export interface GoogleConfig extends Config {
-  config: GoogleInnerConfig
-}
+export interface GoogleConfig extends Config<GoogleInnerConfig> {}
 
 export interface OIDCStrategyConfiguration {
   issuer: string
@@ -96,9 +90,7 @@ export interface OIDCInnerConfig {
   scopes: string[]
 }
 
-export interface OIDCConfig extends Config {
-  config: OIDCConfigs
-}
+export interface OIDCConfig extends Config<OIDCConfigs> {}
 
 export interface OIDCWellKnownConfig {
   issuer: string
@@ -107,6 +99,12 @@ export interface OIDCWellKnownConfig {
   userinfo_endpoint: string
 }
 
+export interface SCIMInnerConfig {
+  enabled: boolean
+}
+
+export interface SCIMConfig extends Config<SCIMInnerConfig> {}
+
 export const isSettingsConfig = (config: Config): config is SettingsConfig =>
   config.type === ConfigType.SETTINGS
 
@@ -119,6 +117,9 @@ export const isGoogleConfig = (config: Config): config is GoogleConfig =>
 export const isOIDCConfig = (config: Config): config is OIDCConfig =>
   config.type === ConfigType.OIDC
 
+export const isSCIMConfig = (config: Config): config is SCIMConfig =>
+  config.type === ConfigType.SCIM
+
 export enum ConfigType {
   SETTINGS = "settings",
   ACCOUNT = "account",
@@ -126,4 +127,5 @@ export enum ConfigType {
   GOOGLE = "google",
   OIDC = "oidc",
   OIDC_LOGOS = "logos_oidc",
+  SCIM = "scim",
 }

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/documents/global/user.ts

@@ -53,6 +53,7 @@ export interface User extends Document {
   dayPassRecordedAt?: string
   userGroups?: string[]
   onboardedAt?: string
+  scimInfo?: { isSync: true } & Record<string, any>
 }
 
 export enum UserStatus {

package/src/documents/global/userGroup.ts

@@ -7,6 +7,10 @@ export interface UserGroup extends Document {
   users?: GroupUser[]
   roles?: UserGroupRoles
   createdAt?: number
+  scimInfo?: {
+    externalId: string
+    isSync: boolean
+  }
 }
 
 export interface GroupUser {

package/src/sdk/db.ts

@@ -1,10 +1,12 @@
 import Nano from "@budibase/nano"
 import { AllDocsResponse, AnyDocument, Document } from "../"
 import { Writable } from "stream"
+import PouchDB from "pouchdb"
 
 export enum SearchIndex {
   ROWS = "rows",
   AUDIT = "audit",
+  USER = "user",
 }
 
 export type PouchOptions = {

package/src/sdk/events/event.ts

@@ -1,4 +1,5 @@
 import { Hosting } from "../hosting"
+import { Group, Identity } from "./identification"
 
 export enum Event {
   // USER
@@ -137,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",
@@ -186,6 +186,24 @@ export enum Event {
   AUDIT_LOGS_DOWNLOADED = "audit_log:downloaded",
 }
 
+export const UserGroupSyncEvents: Event[] = [
+  Event.USER_CREATED,
+  Event.USER_UPDATED,
+  Event.USER_DELETED,
+  Event.USER_PERMISSION_ADMIN_ASSIGNED,
+  Event.USER_PERMISSION_ADMIN_REMOVED,
+  Event.USER_PERMISSION_BUILDER_ASSIGNED,
+  Event.USER_PERMISSION_BUILDER_REMOVED,
+  Event.USER_GROUP_CREATED,
+  Event.USER_GROUP_UPDATED,
+  Event.USER_GROUP_DELETED,
+  Event.USER_GROUP_USERS_ADDED,
+  Event.USER_GROUP_USERS_REMOVED,
+  Event.USER_GROUP_PERMISSIONS_EDITED,
+]
+
+export const AsyncEvents: Event[] = [...UserGroupSyncEvents]
+
 // all events that are not audited have been added to this record as undefined, this means
 // that Typescript can protect us against new events being added and auditing of those
 // events not being considered. This might be a little ugly, but provides a level of
@@ -194,9 +212,9 @@ export enum Event {
 // a user facing event or not.
 export const AuditedEventFriendlyName: Record<Event, string | undefined> = {
   // USER
-  [Event.USER_CREATED]: `User "{{ email }}" created`,
-  [Event.USER_UPDATED]: `User "{{ email }}" updated`,
-  [Event.USER_DELETED]: `User "{{ email }}" deleted`,
+  [Event.USER_CREATED]: `User "{{ email }}" created{{#if viaScim}} via SCIM{{/if}}`,
+  [Event.USER_UPDATED]: `User "{{ email }}" updated{{#if viaScim}} via SCIM{{/if}}`,
+  [Event.USER_DELETED]: `User "{{ email }}" deleted{{#if viaScim}} via SCIM{{/if}}`,
   [Event.USER_PERMISSION_ADMIN_ASSIGNED]: `User "{{ email }}" admin role assigned`,
   [Event.USER_PERMISSION_ADMIN_REMOVED]: `User "{{ email }}" admin role removed`,
   [Event.USER_PERMISSION_BUILDER_ASSIGNED]: `User "{{ email }}" builder role assigned`,
@@ -206,11 +224,11 @@ export const AuditedEventFriendlyName: Record<Event, string | undefined> = {
   [Event.USER_PASSWORD_UPDATED]: `User "{{ email }}" password updated`,
   [Event.USER_PASSWORD_RESET_REQUESTED]: `User "{{ email }}" password reset requested`,
   [Event.USER_PASSWORD_RESET]: `User "{{ email }}" password reset`,
-  [Event.USER_GROUP_CREATED]: `User group "{{ name }}" created`,
-  [Event.USER_GROUP_UPDATED]: `User group "{{ name }}" updated`,
-  [Event.USER_GROUP_DELETED]: `User group "{{ name }}" deleted`,
-  [Event.USER_GROUP_USERS_ADDED]: `User group "{{ name }}" {{ count }} users added`,
-  [Event.USER_GROUP_USERS_REMOVED]: `User group "{{ name }}" {{ count }} users removed`,
+  [Event.USER_GROUP_CREATED]: `User group "{{ name }}" created{{#if viaScim}} via SCIM{{/if}}`,
+  [Event.USER_GROUP_UPDATED]: `User group "{{ name }}" updated{{#if viaScim}} via SCIM{{/if}}`,
+  [Event.USER_GROUP_DELETED]: `User group "{{ name }}" deleted{{#if viaScim}} via SCIM{{/if}}`,
+  [Event.USER_GROUP_USERS_ADDED]: `User group "{{ name }}" {{ count }} users added{{#if viaScim}} via SCIM{{/if}}`,
+  [Event.USER_GROUP_USERS_REMOVED]: `User group "{{ name }}" {{ count }} users removed{{#if viaScim}} via SCIM{{/if}}`,
   [Event.USER_GROUP_PERMISSIONS_EDITED]: `User group "{{ name }}" permissions edited`,
   [Event.USER_PASSWORD_FORCE_RESET]: undefined,
   [Event.USER_GROUP_ONBOARDING]: undefined,
@@ -309,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,
@@ -383,3 +400,21 @@ export interface BaseEvent {
 }
 
 export type TableExportFormat = "json" | "csv"
+
+export type DocUpdateEvent = {
+  id: string
+  tenantId: string
+  appId?: string
+}
+
+export interface EventProcessor {
+  processEvent(
+    event: Event,
+    identity: Identity,
+    properties: any,
+    timestamp?: string | number
+  ): Promise<void>
+  identify?(identity: Identity, timestamp?: string | number): Promise<void>
+  identifyGroup?(group: Group, timestamp?: string | number): Promise<void>
+  shutdown?(): void
+}

package/src/sdk/events/identification.ts

@@ -46,6 +46,8 @@ export interface Identity {
   environment: string
   installationId?: string
   tenantId?: string
+  // usable - no unique format
+  realTenantId?: string
   hostInfo?: HostInfo
 }
 

package/src/sdk/events/license.ts

@@ -1,15 +1,14 @@
-import { PlanType } from "../licensing"
-
-export interface LicenseTierChangedEvent {
-  accountId: string
-  from: number
-  to: number
-}
+import { PlanType, PriceDuration } from "../licensing"
 
 export interface LicensePlanChangedEvent {
   accountId: string
   from: PlanType
   to: PlanType
+  // may not be on historical events
+  fromDuration: PriceDuration | undefined
+  toDuration: PriceDuration | undefined
+  fromQuantity: number | undefined
+  toQuantity: number | undefined
 }
 
 export interface LicenseActivatedEvent {

package/src/sdk/events/user.ts

@@ -2,6 +2,7 @@ import { BaseEvent } from "./event"
 
 export interface UserCreatedEvent extends BaseEvent {
   userId: string
+  viaScim?: boolean
   audited: {
     email: string
   }
@@ -9,6 +10,7 @@ export interface UserCreatedEvent extends BaseEvent {
 
 export interface UserUpdatedEvent extends BaseEvent {
   userId: string
+  viaScim?: boolean
   audited: {
     email: string
   }
@@ -16,6 +18,7 @@ export interface UserUpdatedEvent extends BaseEvent {
 
 export interface UserDeletedEvent extends BaseEvent {
   userId: string
+  viaScim?: boolean
   audited: {
     email: string
   }

package/src/sdk/events/userGroup.ts

@@ -2,6 +2,7 @@ import { BaseEvent } from "./event"
 
 export interface GroupCreatedEvent extends BaseEvent {
   groupId: string
+  viaScim?: boolean
   audited: {
     name: string
   }
@@ -9,6 +10,7 @@ export interface GroupCreatedEvent extends BaseEvent {
 
 export interface GroupUpdatedEvent extends BaseEvent {
   groupId: string
+  viaScim?: boolean
   audited: {
     name: string
   }
@@ -16,6 +18,7 @@ export interface GroupUpdatedEvent extends BaseEvent {
 
 export interface GroupDeletedEvent extends BaseEvent {
   groupId: string
+  viaScim?: boolean
   audited: {
     name: string
   }
@@ -24,6 +27,7 @@ export interface GroupDeletedEvent extends BaseEvent {
 export interface GroupUsersAddedEvent extends BaseEvent {
   count: number
   groupId: string
+  viaScim?: boolean
   audited: {
     name: string
   }
@@ -32,6 +36,7 @@ export interface GroupUsersAddedEvent extends BaseEvent {
 export interface GroupUsersDeletedEvent extends BaseEvent {
   count: number
   groupId: string
+  viaScim?: boolean
   audited: {
     name: string
   }

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",
@@ -5,4 +7,7 @@ export enum Feature {
   AUDIT_LOGS = "auditLogs",
   ENFORCEABLE_SSO = "enforceableSSO",
   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,34 @@ export enum PriceDuration {
   YEARLY = "yearly",
 }
 
-export interface Price {
+export interface AvailablePlan {
+  type: PlanType
+  maxUsers: 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
+  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,13 +55,7 @@ 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 type PlanQuotas = { [key in PlanType]: Quotas | undefined }
 
 export type MonthlyQuotas = {
   [MonthlyQuotaName.QUERIES]: Quota
@@ -71,6 +66,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 +95,5 @@ export interface Quota {
    * which can have subsequent effects such as sending emails to users.
    */
   triggers: number[]
+  startDate?: number
 }