@budibase/types 2.0.39 → 2.0.40-alpha.0

package/src/api/web/app/backup.ts

@@ -0,0 +1,17 @@
+import { AppBackupTrigger, AppBackupType } from "../../../documents"
+
+export interface SearchAppBackupsRequest {
+  trigger: AppBackupTrigger
+  type: AppBackupType
+  startDate: string
+  endDate: string
+  page?: string
+}
+
+export interface CreateAppBackupRequest {
+  name: string
+}
+
+export interface UpdateAppBackupRequest {
+  name: string
+}

package/src/api/web/app/index.ts

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

package/src/api/web/index.ts

@@ -1,3 +1,5 @@
 export * from "./analytics"
 export * from "./user"
 export * from "./errors"
+export * from "./schedule"
+export * from "./app"

package/src/api/web/schedule.ts

@@ -0,0 +1,15 @@
+import {
+  ScheduleMetadata,
+  ScheduleRepeatPeriod,
+  ScheduleType,
+} from "../../documents"
+
+export interface CreateScheduleRequest {
+  type: ScheduleType
+  name: string
+  startDate: string
+  repeat: ScheduleRepeatPeriod
+  metadata: ScheduleMetadata
+}
+
+export interface UpdateScheduleRequest extends CreateScheduleRequest {}

package/src/api/web/user.ts

@@ -44,3 +44,10 @@ export interface InviteUsersResponse {
   successful: { email: string }[]
   unsuccessful: { email: string; reason: string }[]
 }
+
+export interface SearchUsersRequest {
+  page?: string
+  email?: string
+  appId?: string
+  userIds?: string[]
+}

package/src/documents/account/account.ts

@@ -1,4 +1,12 @@
-import { Feature, Hosting, PlanType, Quotas } from "../../sdk"
+import {
+  Feature,
+  Hosting,
+  MonthlyQuotaName,
+  PlanType,
+  Quotas,
+  StaticQuotaName,
+} from "../../sdk"
+import { MonthlyUsage, QuotaUsage, StaticUsage } from "../global"
 
 export interface CreateAccount {
   email: string
@@ -42,6 +50,7 @@ export interface Account extends CreateAccount {
   licenseKey?: string
   licenseKeyActivatedAt?: number
   licenseOverrides?: LicenseOverrides
+  quotaUsage?: QuotaUsage
 }
 
 export interface PasswordAccount extends Account {

package/src/documents/app/automation.ts

@@ -1,5 +1,34 @@
 import { Document } from "../document"
 
+export enum AutomationTriggerStepId {
+  ROW_SAVED = "ROW_SAVED",
+  ROW_UPDATED = "ROW_UPDATED",
+  ROW_DELETED = "ROW_DELETED",
+  WEBHOOK = "WEBHOOK",
+  APP = "APP",
+  CRON = "CRON",
+}
+
+export enum AutomationActionStepId {
+  SEND_EMAIL_SMTP = "SEND_EMAIL_SMTP",
+  CREATE_ROW = "CREATE_ROW",
+  UPDATE_ROW = "UPDATE_ROW",
+  DELETE_ROW = "DELETE_ROW",
+  OUTGOING_WEBHOOK = "OUTGOING_WEBHOOK",
+  EXECUTE_SCRIPT = "EXECUTE_SCRIPT",
+  EXECUTE_QUERY = "EXECUTE_QUERY",
+  SERVER_LOG = "SERVER_LOG",
+  DELAY = "DELAY",
+  FILTER = "FILTER",
+  QUERY_ROWS = "QUERY_ROWS",
+  LOOP = "LOOP",
+  // these used to be lowercase step IDs, maintain for backwards compat
+  discord = "discord",
+  slack = "slack",
+  zapier = "zapier",
+  integromat = "integromat",
+}
+
 export interface Automation extends Document {
   definition: {
     steps: AutomationStep[]
@@ -11,7 +40,7 @@ export interface Automation extends Document {
 
 export interface AutomationStep {
   id: string
-  stepId: string
+  stepId: AutomationTriggerStepId | AutomationActionStepId
   inputs: {
     [key: string]: any
   }
@@ -19,15 +48,13 @@ export interface AutomationStep {
     inputs: {
       [key: string]: any
     }
+    outputs: {
+      [key: string]: any
+    }
   }
 }
 
-export interface AutomationTrigger {
-  id: string
-  stepId: string
-  inputs: {
-    [key: string]: any
-  }
+export interface AutomationTrigger extends AutomationStep {
   cronJobId?: string
 }
 
@@ -43,7 +70,7 @@ export interface AutomationResults {
   status?: AutomationStatus
   trigger?: any
   steps: {
-    stepId: string
+    stepId: AutomationTriggerStepId | AutomationActionStepId
     inputs: {
       [key: string]: any
     }

package/src/documents/app/backup.ts

@@ -0,0 +1,70 @@
+import { Document } from "../document"
+import { User } from "../../"
+
+export enum AppBackupType {
+  BACKUP = "backup",
+  RESTORE = "restore",
+}
+
+export enum AppBackupStatus {
+  STARTED = "started",
+  PENDING = "pending",
+  COMPLETE = "complete",
+  FAILED = "failed",
+}
+
+export enum AppBackupTrigger {
+  PUBLISH = "publish",
+  MANUAL = "manual",
+  SCHEDULED = "scheduled",
+  RESTORING = "restoring",
+}
+
+export interface AppBackupContents {
+  datasources: string[]
+  screens: string[]
+  automations: string[]
+}
+
+export interface AppBackupMetadata {
+  appId: string
+  trigger?: AppBackupTrigger
+  type: AppBackupType
+  status: AppBackupStatus
+  name?: string
+  createdBy?: string | User
+  timestamp: string
+  finishedAt?: string
+  startedAt?: string
+  contents?: AppBackupContents
+}
+
+export interface AppBackup extends Document, AppBackupMetadata {
+  filename?: string
+}
+
+export type AppBackupFetchOpts = {
+  trigger?: AppBackupTrigger
+  type?: AppBackupType
+  limit?: number
+  page?: string
+  paginate?: boolean
+  startDate?: string
+  endDate?: string
+}
+
+export interface AppBackupQueueData {
+  appId: string
+  docId: string
+  docRev: string
+  export?: {
+    trigger: AppBackupTrigger
+    name?: string
+    createdBy?: string
+  }
+  import?: {
+    backupId: string
+    nameForBackup: string
+    createdBy?: string
+  }
+}

package/src/documents/app/index.ts

@@ -10,3 +10,5 @@ export * from "./view"
 export * from "../document"
 export * from "./row"
 export * from "./user"
+export * from "./backup"
+export * from "./webhook"

package/src/documents/app/row.ts

@@ -16,6 +16,14 @@ export enum FieldType {
   INTERNAL = "internal",
 }
 
+export interface RowAttachment {
+  size: number
+  name: string
+  url: string
+  extension: string
+  key: string
+}
+
 export interface Row extends Document {
   type?: string
   tableId?: string

package/src/documents/app/table.ts

@@ -49,4 +49,7 @@ export interface Table extends Document {
   sourceId?: string
   relatedFormula?: string[]
   constrained?: string[]
+  sql?: boolean
+  indexes?: { [key: string]: any }
+  dataImport?: { [key: string]: any }
 }

package/src/documents/app/webhook.ts

@@ -0,0 +1,15 @@
+import { Document } from "../document"
+
+export enum WebhookActionType {
+  AUTOMATION = "automation",
+}
+
+export interface Webhook extends Document {
+  live: boolean
+  name: string
+  action: {
+    type: WebhookActionType
+    target: string
+  }
+  bodySchema?: any
+}

package/src/documents/global/index.ts

@@ -3,3 +3,4 @@ export * from "./user"
 export * from "./userGroup"
 export * from "./plugin"
 export * from "./quotas"
+export * from "./schedule"

package/src/documents/global/quotas.ts

@@ -1,15 +1,80 @@
 import { MonthlyQuotaName, StaticQuotaName } from "../../sdk"
 
-export interface QuotaUsage {
+export enum BreakdownQuotaName {
+  ROW_QUERIES = "rowQueries",
+  DATASOURCE_QUERIES = "datasourceQueries",
+  AUTOMATIONS = "automations",
+}
+
+export const APP_QUOTA_NAMES = [
+  StaticQuotaName.ROWS,
+  MonthlyQuotaName.QUERIES,
+  MonthlyQuotaName.AUTOMATIONS,
+]
+
+export const BREAKDOWN_QUOTA_NAMES = [
+  MonthlyQuotaName.QUERIES,
+  MonthlyQuotaName.AUTOMATIONS,
+]
+
+export interface UsageBreakdown {
+  parent: MonthlyQuotaName
+  values: {
+    [key: string]: number
+  }
+}
+
+export type QuotaTriggers = {
+  [key: string]: string | undefined
+}
+
+export interface StaticUsage {
+  [StaticQuotaName.APPS]: number
+  [StaticQuotaName.PLUGINS]: number
+  [StaticQuotaName.USER_GROUPS]: number
+  [StaticQuotaName.ROWS]: number
+  triggers: {
+    [key in StaticQuotaName]?: QuotaTriggers
+  }
+}
+
+export interface MonthlyUsage {
+  [MonthlyQuotaName.QUERIES]: number
+  [MonthlyQuotaName.AUTOMATIONS]: number
+  [MonthlyQuotaName.DAY_PASSES]: number
+  triggers: {
+    [key in MonthlyQuotaName]?: QuotaTriggers
+  }
+  breakdown?: {
+    [key in BreakdownQuotaName]?: UsageBreakdown
+  }
+}
+
+export interface BaseQuotaUsage {
+  usageQuota: StaticUsage
+  monthly: {
+    [key: string]: MonthlyUsage
+  }
+}
+
+export interface QuotaUsage extends BaseQuotaUsage {
   _id: string
   _rev?: string
   quotaReset: string
-  usageQuota: {
-    [key in StaticQuotaName]: number
-  }
-  monthly: {
-    [key: string]: {
-      [key in MonthlyQuotaName]: number
-    }
+  apps?: {
+    [key: string]: BaseQuotaUsage
   }
 }
+
+export type SetUsageValues = {
+  total: number
+  app?: number
+  breakdown?: number
+  triggers?: QuotaTriggers
+}
+
+export type UsageValues = {
+  total: number
+  app?: number
+  breakdown?: number
+}

package/src/documents/global/schedule.ts

@@ -0,0 +1,32 @@
+import { Document } from "../document"
+
+export enum ScheduleType {
+  APP_BACKUP = "app_backup",
+}
+
+export enum ScheduleRepeatPeriod {
+  DAILY = "daily",
+  WEEKLY = "weekly",
+  MONTHLY = "monthly",
+}
+
+export interface Schedule extends Document {
+  type: ScheduleType
+  name: string
+  startDate: string
+  repeat: ScheduleRepeatPeriod
+  metadata: ScheduleMetadata
+}
+
+export type ScheduleMetadata = AppBackupScheduleMetadata
+
+export const isAppBackupMetadata = (
+  type: ScheduleType,
+  metadata: ScheduleMetadata
+): metadata is AppBackupScheduleMetadata => {
+  return type === ScheduleType.APP_BACKUP
+}
+
+export interface AppBackupScheduleMetadata {
+  apps: string[]
+}

package/src/sdk/datasources.ts

@@ -24,6 +24,7 @@ export enum QueryType {
 
 export enum DatasourceFieldType {
   STRING = "string",
+  CODE = "code",
   LONGFORM = "longForm",
   BOOLEAN = "boolean",
   NUMBER = "number",
@@ -70,6 +71,11 @@ export enum FilterType {
   ONE_OF = "oneOf",
 }
 
+export interface StepDefinition {
+  key: string
+  template: string
+}
+
 export interface QueryDefinition {
   type: QueryType
   displayName?: string
@@ -77,6 +83,7 @@ export interface QueryDefinition {
   customisable?: boolean
   fields?: object
   urlDisplay?: boolean
+  steps?: Array<StepDefinition>
 }
 
 export interface ExtraQueryConfig {

package/src/sdk/db.ts

@@ -0,0 +1,24 @@
+import PouchDB from "pouchdb"
+
+export type PouchOptions = {
+  inMemory: boolean
+  replication: boolean
+  onDisk: boolean
+  find: boolean
+}
+
+export enum SortOption {
+  ASCENDING = "asc",
+  DESCENDING = "desc",
+}
+
+export type CouchFindOptions = {
+  selector: PouchDB.Find.Selector
+  fields?: string[]
+  sort?: {
+    [key: string]: SortOption
+  }[]
+  limit?: number
+  skip?: number
+  bookmark?: string
+}

package/src/sdk/events/backup.ts

@@ -0,0 +1,7 @@
+import { BaseEvent } from "./event"
+
+export interface AppBackupRestoreEvent extends BaseEvent {
+  appId: string
+  backupName: string
+  backupCreatedAt: string
+}

package/src/sdk/events/event.ts

@@ -168,6 +168,9 @@ export enum Event {
   PLUGIN_INIT = "plugin:init",
   PLUGIN_IMPORTED = "plugin:imported",
   PLUGIN_DELETED = "plugin:deleted",
+
+  // BACKUP
+  APP_BACKUP_RESTORED = "app:backup:restored",
 }
 
 // properties added at the final stage of the event pipeline

package/src/sdk/events/index.ts

@@ -20,3 +20,4 @@ export * from "./backfill"
 export * from "./identification"
 export * from "./userGroup"
 export * from "./plugin"
+export * from "./backup"

package/src/sdk/index.ts

@@ -7,3 +7,5 @@ export * from "./datasources"
 export * from "./search"
 export * from "./koa"
 export * from "./auth"
+export * from "./locks"
+export * from "./db"

package/src/sdk/koa.ts

@@ -1,4 +1,4 @@
-import { Context } from "koa"
+import { Context, Request } from "koa"
 import { User } from "../documents"
 import { License } from "../sdk"
 
@@ -7,7 +7,11 @@ export interface ContextUser extends User {
   license: License
 }
 
+export interface BBRequest extends Request {
+  body: any
+}
+
 export interface BBContext extends Context {
+  request: BBRequest
   user?: ContextUser
-  body: any
 }

package/src/sdk/licensing/feature.ts

@@ -1,3 +1,4 @@
 export enum Feature {
   USER_GROUPS = "userGroups",
+  APP_BACKUPS = "appBackups",
 }

package/src/sdk/licensing/quota.ts

@@ -25,8 +25,10 @@ export enum MonthlyQuotaName {
 
 export enum ConstantQuotaName {
   AUTOMATION_LOG_RETENTION_DAYS = "automationLogRetentionDays",
+  APP_BACKUPS_RETENTION_DAYS = "appBackupRetentionDays",
 }
 
+export type MeteredQuotaName = StaticQuotaName | MonthlyQuotaName
 export type QuotaName = StaticQuotaName | MonthlyQuotaName | ConstantQuotaName
 
 export const isStaticQuota = (
@@ -60,26 +62,41 @@ export type PlanQuotas = {
   [PlanType.ENTERPRISE]: Quotas
 }
 
+export type MonthlyQuotas = {
+  [MonthlyQuotaName.QUERIES]: Quota
+  [MonthlyQuotaName.AUTOMATIONS]: Quota
+  [MonthlyQuotaName.DAY_PASSES]: Quota
+}
+
+export type StaticQuotas = {
+  [StaticQuotaName.ROWS]: Quota
+  [StaticQuotaName.APPS]: Quota
+  [StaticQuotaName.USER_GROUPS]: Quota
+  [StaticQuotaName.PLUGINS]: Quota
+}
+
+export type ConstantQuotas = {
+  [ConstantQuotaName.AUTOMATION_LOG_RETENTION_DAYS]: Quota
+  [ConstantQuotaName.APP_BACKUPS_RETENTION_DAYS]: Quota
+}
+
 export type Quotas = {
   [QuotaType.USAGE]: {
-    [QuotaUsageType.MONTHLY]: {
-      [MonthlyQuotaName.QUERIES]: Quota
-      [MonthlyQuotaName.AUTOMATIONS]: Quota
-      [MonthlyQuotaName.DAY_PASSES]: Quota
-    }
-    [QuotaUsageType.STATIC]: {
-      [StaticQuotaName.ROWS]: Quota
-      [StaticQuotaName.APPS]: Quota
-      [StaticQuotaName.USER_GROUPS]: Quota
-      [StaticQuotaName.PLUGINS]: Quota
-    }
-  }
-  [QuotaType.CONSTANT]: {
-    [ConstantQuotaName.AUTOMATION_LOG_RETENTION_DAYS]: Quota
+    [QuotaUsageType.MONTHLY]: MonthlyQuotas
+    [QuotaUsageType.STATIC]: StaticQuotas
   }
+  [QuotaType.CONSTANT]: ConstantQuotas
 }
 
 export interface Quota {
   name: string
   value: number
+  /**
+   * Array of whole numbers (1-100) that dictate the percentage that this quota should trigger
+   * at in relation to the corresponding usage inside budibase.
+   *
+   * Triggering results in a budibase installation sending a request to account-portal,
+   * which can have subsequent effects such as sending emails to users.
+   */
+  triggers: number[]
 }

package/src/sdk/locks.ts

@@ -0,0 +1,35 @@
+export enum LockType {
+  /**
+   * If this lock is already held the attempted operation will not be performed.
+   * No retries will take place and no error will be thrown.
+   */
+  TRY_ONCE = "try_once",
+}
+
+export enum LockName {
+  MIGRATIONS = "migrations",
+  TRIGGER_QUOTA = "trigger_quota",
+}
+
+export interface LockOptions {
+  /**
+   * The lock type determines which client to use
+   */
+  type: LockType
+  /**
+   * The name for the lock
+   */
+  name: LockName
+  /**
+   * The ttl to auto-expire the lock if not unlocked manually
+   */
+  ttl: number
+  /**
+   * The suffix to add to the lock name for additional uniqueness
+   */
+  nameSuffix?: string
+  /**
+   * This is a system-wide lock - don't use tenancy in lock key
+   */
+  systemLock?: boolean
+}

package/src/sdk/migrations.ts

@@ -39,14 +39,13 @@ export interface MigrationOptions {
 
 export enum MigrationName {
   USER_EMAIL_VIEW_CASING = "user_email_view_casing",
-  QUOTAS_1 = "quotas_1",
   APP_URLS = "app_urls",
   EVENT_APP_BACKFILL = "event_app_backfill",
   EVENT_GLOBAL_BACKFILL = "event_global_backfill",
   EVENT_INSTALLATION_BACKFILL = "event_installation_backfill",
   GLOBAL_INFO_SYNC_USERS = "global_info_sync_users",
-  PLATFORM_USERS_EMAIL_CASING = "platform_users_email_casing",
-  PLUGIN_COUNT = "plugin_count",
+  // increment this number to re-activate this migration
+  SYNC_QUOTAS = "sync_quotas_1",
 }
 
 export interface MigrationDefinition {