@budibase/types 2.9.19-alpha.0 → 2.9.20

package/src/documents/app/backup.ts

@@ -1,71 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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,56 +0,0 @@
-import { Document } from "../document"
-import { SourceName } from "../../sdk"
-import { Table } from "./table"
-
-export interface Datasource extends Document {
-  type: string
-  name?: string
-  source: SourceName
-  // the config is defined by the schema
-  config?: Record<string, 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

@@ -1,16 +0,0 @@
-export * from "./app"
-export * from "./automation"
-export * from "./datasource"
-export * from "./layout"
-export * from "./query"
-export * from "./role"
-export * from "./table"
-export * from "./screen"
-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,5 +0,0 @@
-import { Document } from "../document"
-
-export interface Layout extends Document {
-  props: any
-}

package/src/documents/app/links.ts

@@ -1,21 +0,0 @@
-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/query.ts

@@ -1,51 +0,0 @@
-import { Document } from "../document"
-
-export interface Query extends Document {
-  datasourceId: string
-  name: string
-  parameters: QueryParameter[]
-  fields: RestQueryFields | any
-  transformer: string | null
-  schema: any
-  readable: boolean
-  queryVerb: string
-}
-
-export interface QueryParameter {
-  name: string
-  default: string
-}
-
-export interface RestQueryFields {
-  path: string
-  queryString?: string
-  headers: { [key: string]: any }
-  disabledHeaders: { [key: string]: any }
-  requestBody: any
-  bodyType: string
-  json: object
-  method: string
-  authConfigId: string
-  pagination: PaginationConfig | null
-  paginationValues: PaginationValues | null
-}
-
-export interface PaginationConfig {
-  type: string
-  location: string
-  pageParam: string
-  sizeParam: string | null
-  responseParam: string | null
-}
-
-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/role.ts

@@ -1,8 +0,0 @@
-import { Document } from "../document"
-
-export interface Role extends Document {
-  permissionId: string
-  inherits?: string
-  permissions: { [key: string]: string[] }
-  version?: string
-}

package/src/documents/app/row.ts

@@ -1,35 +0,0 @@
-import { Document } from "../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",
-  BIGINT = "bigint",
-}
-
-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
-  _viewId?: string
-  [key: string]: any
-}

package/src/documents/app/screen.ts

@@ -1,25 +0,0 @@
-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
-  showNavigation?: boolean
-  width?: string
-  routing: ScreenRouting
-  props: ScreenProps
-  name?: string
-}

package/src/documents/app/table/constants.ts

@@ -1,9 +0,0 @@
-export enum RelationshipType {
-  ONE_TO_MANY = "one-to-many",
-  MANY_TO_ONE = "many-to-one",
-  MANY_TO_MANY = "many-to-many",
-}
-
-export enum AutoReason {
-  FOREIGN_KEY = "foreign_key",
-}

package/src/documents/app/table/index.ts

@@ -1,3 +0,0 @@
-export * from "./table"
-export * from "./schema"
-export * from "./constants"

package/src/documents/app/table/schema.ts

@@ -1,98 +0,0 @@
-// all added by grid/table when defining the
-// column size, position and whether it can be viewed
-import { FieldType } from "../row"
-import { AutoReason, RelationshipType } from "./constants"
-
-export interface UIFieldMetadata {
-  order?: number
-  width?: number
-  visible?: boolean
-  icon?: string
-}
-
-export interface RelationshipFieldMetadata {
-  main?: boolean
-  fieldName?: string
-  tableId?: string
-  // below is used for SQL relationships, needed to define the foreign keys
-  // or the tables used for many-to-many relationships (through)
-  relationshipType?: RelationshipType
-  through?: string
-  foreignKey?: string
-  throughFrom?: string
-  throughTo?: string
-}
-
-export interface AutoColumnFieldMetadata {
-  autocolumn?: boolean
-  subtype?: string
-  lastID?: number
-  // if the column was turned to an auto-column for SQL, explains why (primary, foreign etc)
-  autoReason?: AutoReason
-}
-
-export interface NumberFieldMetadata {
-  // used specifically when Budibase generates external tables, this denotes if a number field
-  // is a foreign key used for a many-to-many relationship
-  meta?: {
-    toTable: string
-    toKey: string
-  }
-}
-
-export interface DateFieldMetadata {
-  ignoreTimezones?: boolean
-  timeOnly?: boolean
-}
-
-export interface StringFieldMetadata {
-  useRichText?: boolean | null
-}
-
-export interface FormulaFieldMetadata {
-  formula?: string
-  formulaType?: string
-}
-
-export interface FieldConstraints {
-  type?: string
-  email?: boolean
-  inclusion?: string[]
-  length?: {
-    minimum?: string | number | null
-    maximum?: string | number | null
-  }
-  numericality?: {
-    greaterThanOrEqualTo: string | null
-    lessThanOrEqualTo: string | null
-  }
-  presence?:
-    | boolean
-    | {
-        allowEmpty?: boolean
-      }
-  datetime?: {
-    latest: string
-    earliest: string
-  }
-}
-
-export interface FieldSchema
-  extends UIFieldMetadata,
-    DateFieldMetadata,
-    RelationshipFieldMetadata,
-    AutoColumnFieldMetadata,
-    StringFieldMetadata,
-    FormulaFieldMetadata,
-    NumberFieldMetadata {
-  type: FieldType
-  name: string
-  sortable?: boolean
-  // only used by external databases, to denote the real type
-  externalType?: string
-  constraints?: FieldConstraints
-}
-
-export interface TableSchema {
-  [key: string]: FieldSchema
-}

package/src/documents/app/table/table.ts

@@ -1,30 +0,0 @@
-import { Document } from "../../document"
-import { View, ViewV2 } from "../view"
-import { RenameColumn } from "../../../sdk"
-import { TableSchema } from "./schema"
-
-export interface Table extends Document {
-  type?: string
-  views?: { [key: string]: View | ViewV2 }
-  name: string
-  primary?: string[]
-  schema: TableSchema
-  primaryDisplay?: string
-  sourceId?: string
-  relatedFormula?: string[]
-  constrained?: string[]
-  sql?: boolean
-  indexes?: { [key: string]: any }
-  rows?: { [key: string]: any }
-  created?: boolean
-  rowHeight?: number
-}
-
-export interface ExternalTable extends Table {
-  sourceId: string
-}
-
-export interface TableRequest extends Table {
-  _rename?: RenameColumn
-  created?: boolean
-}

package/src/documents/app/user.ts

@@ -1,6 +0,0 @@
-import { Document } from "../document"
-
-export interface UserMetadata extends Document {
-  roleId: string
-  email?: string
-}

package/src/documents/app/view.ts

@@ -1,65 +0,0 @@
-import { SearchFilter, SortOrder, SortType } from "../../api"
-import { UIFieldMetadata } from "./table"
-
-export interface View {
-  name: string
-  tableId: string
-  field?: string
-  filters: ViewFilter[]
-  schema: ViewSchema
-  calculation?: ViewCalculation
-  map?: string
-  reduce?: any
-  meta?: Record<string, any>
-}
-
-export interface ViewV2 {
-  version: 2
-  id: string
-  name: string
-  primaryDisplay?: string
-  tableId: string
-  query?: SearchFilter[]
-  sort?: {
-    field: string
-    order?: SortOrder
-    type?: SortType
-  }
-  columns?: string[]
-  schemaUI?: Record<string, UIFieldMetadata>
-}
-
-export type ViewSchema = ViewCountOrSumSchema | ViewStatisticsSchema
-
-export interface ViewCountOrSumSchema {
-  field: string
-  value: string
-}
-
-/**
- e.g:
-  "min": {
-    "type": "number"
-  },
-  "max": {
-    "type": "number"
-  }
- */
-export interface ViewStatisticsSchema {
-  [key: string]: {
-    type: string
-  }
-}
-
-export interface ViewFilter {
-  value?: any
-  condition: string
-  key: string
-  conjunction?: string
-}
-
-export enum ViewCalculation {
-  SUM = "sum",
-  COUNT = "count",
-  STATISTICS = "stats",
-}

package/src/documents/app/webhook.ts

@@ -1,15 +0,0 @@
-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/document.ts

@@ -1,51 +0,0 @@
-export const SEPARATOR = "_"
-export const UNICODE_MAX = "\ufff0"
-
-export const prefixed = (type: DocumentType) => `${type}${SEPARATOR}`
-
-export enum DocumentType {
-  USER = "us",
-  GROUP = "gr",
-  WORKSPACE = "workspace",
-  CONFIG = "config",
-  TEMPLATE = "template",
-  APP = "app",
-  DEV = "dev",
-  APP_DEV = "app_dev",
-  APP_METADATA = "app_metadata",
-  ROLE = "role",
-  MIGRATIONS = "migrations",
-  DEV_INFO = "devinfo",
-  AUTOMATION_LOG = "log_au",
-  ACCOUNT_METADATA = "acc_metadata",
-  PLUGIN = "plg",
-  DATASOURCE = "datasource",
-  DATASOURCE_PLUS = "datasource_plus",
-  APP_BACKUP = "backup",
-  TABLE = "ta",
-  ROW = "ro",
-  AUTOMATION = "au",
-  LINK = "li",
-  WEBHOOK = "wh",
-  INSTANCE = "inst",
-  LAYOUT = "layout",
-  SCREEN = "screen",
-  QUERY = "query",
-  DEPLOYMENTS = "deployments",
-  METADATA = "metadata",
-  MEM_VIEW = "view",
-  USER_FLAG = "flag",
-  AUTOMATION_METADATA = "meta_au",
-  AUDIT_LOG = "al",
-}
-
-export interface Document {
-  _id?: string
-  _rev?: string
-  createdAt?: string | number
-  updatedAt?: string
-}
-
-export interface AnyDocument extends Document {
-  [key: string]: any
-}

package/src/documents/global/auditLogs.ts

@@ -1,19 +0,0 @@
-import { Document } from "../document"
-import { Event } from "../../sdk"
-
-export const AuditLogSystemUser = "SYSTEM"
-
-export type FallbackInfo = {
-  appName?: string
-  email?: string
-}
-
-export interface AuditLogDoc extends Document {
-  appId?: string
-  event: Event
-  userId: string
-  timestamp: string
-  metadata: any
-  name: string
-  fallback?: FallbackInfo
-}