@budibase/types 0.0.1 → 0.0.999-alpha.30

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/system/environment.ts

@@ -0,0 +1,8 @@
+export interface GetEnvironmentResponse {
+  multiTenancy: boolean
+  cloud: boolean
+  accountPortalUrl: string
+  baseUrl: string
+  disableAccountPortal: boolean
+  isDev: boolean
+}

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

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

package/src/api/web/user.ts

@@ -0,0 +1,83 @@
+import { User } from "../../documents"
+
+export interface SaveUserResponse {
+  _id: string
+  _rev: string
+  email: string
+}
+
+export interface UserDetails {
+  _id: string
+  email: string
+}
+
+export interface BulkUserRequest {
+  delete?: {
+    userIds: string[]
+  }
+  create?: {
+    roles?: any[]
+    users: User[]
+    groups: any[]
+  }
+}
+
+export interface BulkUserResponse {
+  created?: {
+    successful: UserDetails[]
+    unsuccessful: { email: string; reason: string }[]
+  }
+  deleted?: {
+    successful: UserDetails[]
+    unsuccessful: { _id: string; email: string; reason: string }[]
+  }
+  message?: string
+}
+
+export interface InviteUserRequest {
+  email: string
+  userInfo: any
+}
+
+export type InviteUsersRequest = InviteUserRequest[]
+
+export interface InviteUsersResponse {
+  successful: { email: string }[]
+  unsuccessful: { email: string; reason: string }[]
+}
+
+export interface SearchUsersRequest {
+  page?: string
+  email?: string
+  appId?: string
+  paginated?: boolean
+}
+
+export interface CreateAdminUserRequest {
+  email: string
+  password: string
+  tenantId: string
+}
+
+export interface CreateAdminUserResponse {
+  _id: string
+  _rev: string
+  email: string
+}
+
+export interface AcceptUserInviteRequest {
+  inviteCode: string
+  password: string
+  firstName: string
+  lastName: string
+}
+
+export interface AcceptUserInviteResponse {
+  _id: string
+  _rev: string
+  email: string
+}
+
+export interface SyncUserRequest {
+  previousUser?: User
+}

package/src/documents/account/account.ts

@@ -1,4 +1,14 @@
-import { Hosting } from "../../sdk"
+import {
+  Feature,
+  Hosting,
+  License,
+  MonthlyQuotaName,
+  PlanType,
+  PriceDuration,
+  Quotas,
+  StaticQuotaName,
+} from "../../sdk"
+import { MonthlyUsage, QuotaUsage, StaticUsage } from "../global"
 
 export interface CreateAccount {
   email: string
@@ -22,9 +32,9 @@ export const isCreatePasswordAccount = (
   account: CreateAccount
 ): account is CreatePassswordAccount => account.authType === AuthType.PASSWORD
 
-export interface UpdateAccount {
-  stripeCustomerId?: string
-  licenseKey?: string
+export interface LicenseOverrides {
+  features?: Feature[]
+  quotas?: Quotas
 }
 
 export interface Account extends CreateAccount {
@@ -36,8 +46,14 @@ export interface Account extends CreateAccount {
   verificationSent: boolean
   // licensing
   tier: string // deprecated
+  planType?: PlanType
+  planTier?: number
+  license?: License
   stripeCustomerId?: string
   licenseKey?: string
+  licenseKeyActivatedAt?: number
+  licenseOverrides?: LicenseOverrides
+  quotaUsage?: QuotaUsage
 }
 
 export interface PasswordAccount extends Account {
@@ -63,14 +79,26 @@ export const isSelfHostAccount = (account: Account) =>
 export const isSSOAccount = (account: Account): account is SSOAccount =>
   account.authType === AuthType.SSO
 
-export interface SSOAccount extends Account {
-  pictureUrl?: string
-  provider?: string
-  providerType?: string
+export enum AccountSSOProviderType {
+  GOOGLE = "google",
+  MICROSOFT = "microsoft",
+}
+
+export enum AccountSSOProvider {
+  GOOGLE = "google",
+  MICROSOFT = "microsoft",
+}
+
+export interface AccountSSO {
+  provider: AccountSSOProvider
+  providerType: AccountSSOProviderType
   oauth2?: OAuthTokens
+  pictureUrl?: string
   thirdPartyProfile: any // TODO: define what the google profile looks like
 }
 
+export type SSOAccount = (Account | CloudAccount) & AccountSSO
+
 export enum AuthType {
   SSO = "sso",
   PASSWORD = "password",

package/src/documents/account/index.ts

@@ -1 +1,2 @@
 export * from "./account"
+export * from "./user"

package/src/documents/account/user.ts

@@ -0,0 +1,10 @@
+export interface CreateAccountUserActivity {
+  accountId: string
+  userId: string
+  timestamp: number
+}
+
+export interface AccountUserActivity extends CreateAccountUserActivity {
+  PK: string
+  SK: string
+}

package/src/documents/app/app.ts

@@ -1,4 +1,6 @@
-import { Document } from "../document"
+import { User, Document } from "../"
+
+export type AppMetadataErrors = { [key: string]: string[] }
 
 export interface App extends Document {
   appId: string
@@ -11,9 +13,50 @@ export interface App extends Document {
   instance: AppInstance
   tenantId: string
   status: string
+  theme?: string
+  customTheme?: AppCustomTheme
   revertableVersion?: string
+  lockedBy?: User
+  navigation?: AppNavigation
+  automationErrors?: AppMetadataErrors
+  icon?: AppIcon
 }
 
 export interface AppInstance {
   _id: string
 }
+
+export interface AppNavigation {
+  navigation: string
+  title: string
+  navWidth: string
+  sticky?: boolean
+  hideLogo?: boolean
+  logoUrl?: string
+  hideTitle?: boolean
+  navBackground?: string
+  navTextColor?: string
+  links?: AppNavigationLink[]
+}
+
+export interface AppNavigationLink {
+  text: string
+  url: string
+  id?: string
+  roleId?: string
+}
+
+export interface AppCustomTheme {
+  buttonBorderRadius?: string
+  primaryColor?: string
+  primaryColorHover?: string
+
+  // Used to exist before new design UI
+  navTextColor?: string
+  navBackground?: string
+}
+
+export interface AppIcon {
+  name: string
+  color: string
+}

package/src/documents/app/automation.ts

@@ -1,19 +1,178 @@
 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",
+  ROW_DELETED = "ROW_DELETED",
+  WEBHOOK = "WEBHOOK",
+  APP = "APP",
+  CRON = "CRON",
+}
+
+export enum AutomationStepType {
+  LOGIC = "LOGIC",
+  ACTION = "ACTION",
+  TRIGGER = "TRIGGER",
+}
+
+export enum AutomationActionStepId {
+  SEND_EMAIL_SMTP = "SEND_EMAIL_SMTP",
+  CREATE_ROW = "CREATE_ROW",
+  UPDATE_ROW = "UPDATE_ROW",
+  DELETE_ROW = "DELETE_ROW",
+  EXECUTE_BASH = "EXECUTE_BASH",
+  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 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 AutomationStep {
+export interface AutomationStepSchema {
+  name: string
+  tagline: string
+  icon: string
+  description: string
+  type: AutomationStepType
+  internal?: boolean
+  deprecated?: boolean
+  stepId: AutomationTriggerStepId | AutomationActionStepId
+  blockToLoop?: string
+  inputs: {
+    [key: string]: any
+  }
+  schema: {
+    inputs: InputOutputBlock
+    outputs: InputOutputBlock
+  }
+  custom?: boolean
+}
+
+export interface AutomationStep extends AutomationStepSchema {
   id: string
-  stepId: string
 }
 
-export interface AutomationTrigger {
+export interface AutomationTriggerSchema extends AutomationStepSchema {
+  event?: string
+  cronJobId?: string
+}
+
+export interface AutomationTrigger extends AutomationTriggerSchema {
   id: string
-  stepId: string
+}
+
+export enum AutomationStatus {
+  SUCCESS = "success",
+  ERROR = "error",
+  STOPPED = "stopped",
+  STOPPED_ERROR = "stopped_error",
+  NO_ITERATIONS = "no_iterations",
+}
+
+export interface AutomationResults {
+  automationId?: string
+  status?: AutomationStatus
+  trigger?: any
+  steps: {
+    stepId: AutomationTriggerStepId | AutomationActionStepId
+    inputs: {
+      [key: string]: any
+    }
+    outputs: {
+      [key: string]: any
+    }
+  }[]
+}
+
+export interface AutomationLog extends AutomationResults, Document {
+  automationName: string
+  _rev?: string
+}
+
+export interface AutomationLogPage {
+  data: AutomationLog[]
+  hasNextPage: boolean
+  nextPage?: string
+}
+
+export type AutomationStepInput = {
+  inputs: Record<string, any>
+  context: Record<string, any>
+  emitter: EventEmitter
+  appId: string
+  apiKey?: string
 }

package/src/documents/app/backup.ts

@@ -0,0 +1,71 @@
+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 {
+  _id: string
+  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/component.ts

@@ -0,0 +1,9 @@
+import { Document } from "../document"
+
+export interface Component extends Document {
+  _instanceName: string
+  _styles: { [key: string]: any }
+  _component: string
+  _children?: Component[]
+  [key: string]: any
+}

package/src/documents/app/datasource.ts

@@ -1,5 +1,58 @@
 import { Document } from "../document"
+import { SourceName } from "../../sdk"
+import { Table } from "./table"
 
 export interface Datasource extends Document {
-  source: string
+  type: string
+  name?: string
+  source: SourceName
+  // the config is defined by the schema
+  config?: {
+    [key: string]: string | number | boolean | any[]
+  }
+  plus?: boolean
+  entities?: {
+    [key: string]: Table
+  }
+}
+
+export enum RestAuthType {
+  BASIC = "basic",
+  BEARER = "bearer",
+}
+
+export interface RestBasicAuthConfig {
+  username: string
+  password: string
+}
+
+export interface RestBearerAuthConfig {
+  token: string
+}
+
+export interface RestAuthConfig {
+  _id: string
+  name: string
+  type: RestAuthType
+  config: RestBasicAuthConfig | RestBearerAuthConfig
+}
+
+export interface RestConfig {
+  url: string
+  rejectUnauthorized: boolean
+  defaultHeaders: {
+    [key: string]: any
+  }
+  legacyHttpParser: boolean
+  authConfigs: RestAuthConfig[]
+  staticVariables: {
+    [key: string]: string
+  }
+  dynamicVariables: [
+    {
+      name: string
+      queryId: string
+      value: string
+    }
+  ]
 }

package/src/documents/app/index.ts

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

package/src/documents/app/layout.ts

@@ -1,3 +1,5 @@
 import { Document } from "../document"
 
-export interface Layout extends Document {}
+export interface Layout extends Document {
+  props: any
+}

package/src/documents/app/links.ts

@@ -0,0 +1,21 @@
+import { Document } from "../document"
+
+export interface LinkDocument extends Document {
+  type: string
+  doc1: {
+    rowId: string
+    fieldName: string
+    tableId: string
+  }
+  doc2: {
+    rowId: string
+    fieldName: string
+    tableId: string
+  }
+}
+
+export interface LinkDocumentValue {
+  id: string
+  thisId: string
+  fieldName: string
+}

package/src/documents/app/role.ts

@@ -2,5 +2,6 @@ import { Document } from "../document"
 
 export interface Role extends Document {
   permissionId: string
-  inherits: string
+  inherits?: string
+  permissions: { [key: string]: string[] }
 }

package/src/documents/app/row.ts

@@ -1,3 +1,33 @@
 import { Document } from "../document"
 
-export interface Row extends Document {}
+export enum FieldType {
+  STRING = "string",
+  LONGFORM = "longform",
+  OPTIONS = "options",
+  NUMBER = "number",
+  BOOLEAN = "boolean",
+  ARRAY = "array",
+  DATETIME = "datetime",
+  ATTACHMENT = "attachment",
+  LINK = "link",
+  FORMULA = "formula",
+  AUTO = "auto",
+  JSON = "json",
+  INTERNAL = "internal",
+  BARCODEQR = "barcodeqr",
+}
+
+export interface RowAttachment {
+  size: number
+  name: string
+  extension: string
+  key: string
+  // Populated on read
+  url?: string
+}
+
+export interface Row extends Document {
+  type?: string
+  tableId?: string
+  [key: string]: any
+}

package/src/documents/app/screen.ts

@@ -1,9 +1,24 @@
 import { Document } from "../document"
+import { Component } from "./component"
+
+export interface ScreenProps extends Component {
+  size?: string
+  gap?: string
+  direction?: string
+  vAlign?: string
+  hAlign?: string
+}
+
+export interface ScreenRouting {
+  route: string
+  roleId: string
+  homeScreen?: boolean
+}
 
 export interface Screen extends Document {
-  layoutId: string
-  routing: {
-    route: string
-    roleId: string
-  }
+  layoutId?: string
+  showNavigation?: boolean
+  width?: string
+  routing: ScreenRouting
+  props: ScreenProps
 }