@budibase/types 2.9.19-alpha.0 → 2.9.20

package/src/sdk/datasources.ts

@@ -1,181 +0,0 @@
-import { Table } from "../documents"
-
-export const PASSWORD_REPLACEMENT = "--secret-value--"
-
-export enum Operation {
-  CREATE = "CREATE",
-  READ = "READ",
-  UPDATE = "UPDATE",
-  DELETE = "DELETE",
-  BULK_CREATE = "BULK_CREATE",
-  CREATE_TABLE = "CREATE_TABLE",
-  UPDATE_TABLE = "UPDATE_TABLE",
-  DELETE_TABLE = "DELETE_TABLE",
-}
-
-export enum SortDirection {
-  ASCENDING = "ASCENDING",
-  DESCENDING = "DESCENDING",
-}
-
-export enum QueryType {
-  SQL = "sql",
-  JSON = "json",
-  FIELDS = "fields",
-}
-
-export enum DatasourceFieldType {
-  STRING = "string",
-  CODE = "code",
-  LONGFORM = "longForm",
-  BOOLEAN = "boolean",
-  NUMBER = "number",
-  PASSWORD = "password",
-  LIST = "list",
-  OBJECT = "object",
-  JSON = "json",
-  FILE = "file",
-  FIELD_GROUP = "fieldGroup",
-  SELECT = "select",
-}
-
-export enum SourceName {
-  POSTGRES = "POSTGRES",
-  DYNAMODB = "DYNAMODB",
-  MONGODB = "MONGODB",
-  ELASTICSEARCH = "ELASTICSEARCH",
-  COUCHDB = "COUCHDB",
-  SQL_SERVER = "SQL_SERVER",
-  S3 = "S3",
-  AIRTABLE = "AIRTABLE",
-  MYSQL = "MYSQL",
-  ARANGODB = "ARANGODB",
-  REST = "REST",
-  ORACLE = "ORACLE",
-  GOOGLE_SHEETS = "GOOGLE_SHEETS",
-  FIRESTORE = "FIRESTORE",
-  REDIS = "REDIS",
-  SNOWFLAKE = "SNOWFLAKE",
-}
-
-export enum IncludeRelationship {
-  INCLUDE = 1,
-  EXCLUDE = 0,
-}
-
-export enum FilterType {
-  STRING = "string",
-  FUZZY = "fuzzy",
-  RANGE = "range",
-  EQUAL = "equal",
-  NOT_EQUAL = "notEqual",
-  EMPTY = "empty",
-  NOT_EMPTY = "notEmpty",
-  ONE_OF = "oneOf",
-}
-
-export enum DatasourceFeature {
-  CONNECTION_CHECKING = "connection",
-  FETCH_TABLE_NAMES = "fetch_table_names",
-  EXPORT_SCHEMA = "export_schema",
-}
-
-export interface StepDefinition {
-  key: string
-  template: string
-}
-
-export interface QueryDefinition {
-  type: QueryType
-  displayName?: string
-  readable?: boolean
-  customisable?: boolean
-  fields?: object
-  urlDisplay?: boolean
-  steps?: Array<StepDefinition>
-}
-
-export interface ExtraQueryConfig {
-  [key: string]: {
-    displayName: string
-    type: string
-    required: boolean
-    data?: object
-  }
-}
-
-interface DatasourceBasicFieldConfig {
-  type: DatasourceFieldType
-  display?: string
-  required?: boolean
-  default?: any
-  deprecated?: boolean
-  hidden?: string
-}
-
-interface DatasourceSelectFieldConfig extends DatasourceBasicFieldConfig {
-  type: DatasourceFieldType.SELECT
-  config: { options: string[] }
-}
-
-interface DatasourceFieldGroupConfig extends DatasourceBasicFieldConfig {
-  type: DatasourceFieldType.FIELD_GROUP
-  config: {
-    openByDefault?: boolean
-    nestedFields?: boolean
-  }
-}
-
-type DatasourceFieldConfig =
-  | DatasourceSelectFieldConfig
-  | DatasourceFieldGroupConfig
-  | DatasourceBasicFieldConfig
-
-export interface DatasourceConfig {
-  [key: string]: DatasourceFieldConfig & {
-    fields?: DatasourceConfig
-  }
-}
-
-export interface Integration {
-  docs: string
-  plus?: boolean
-  auth?: { type: string }
-  features?: Partial<Record<DatasourceFeature, boolean>>
-  relationships?: boolean
-  description: string
-  friendlyName: string
-  type?: string
-  iconUrl?: string
-  datasource: DatasourceConfig
-  query: {
-    [key: string]: QueryDefinition
-  }
-  extra?: ExtraQueryConfig
-}
-
-export type ConnectionInfo = {
-  connected: boolean
-  error?: string
-}
-
-export interface IntegrationBase {
-  create?(query: any): Promise<any[] | any>
-  read?(query: any): Promise<any[] | any>
-  update?(query: any): Promise<any[] | any>
-  delete?(query: any): Promise<any[] | any>
-  testConnection?(): Promise<ConnectionInfo>
-  getExternalSchema?(): Promise<string>
-}
-
-export interface DatasourcePlus extends IntegrationBase {
-  tables: Record<string, Table>
-  schemaErrors: Record<string, string>
-
-  // if the datasource supports the use of bindings directly (to protect against SQL injection)
-  // this returns the format of the identifier
-  getBindingIdentifier(): string
-  getStringConcat(parts: string[]): string
-  buildSchema(datasourceId: string, entities: Record<string, Table>): any
-  getTableNames(): Promise<string[]>
-}

package/src/sdk/db.ts

@@ -1,116 +0,0 @@
-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 = {
-  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
-}
-
-export type DatabaseOpts = {
-  skip_setup?: boolean
-}
-
-export type DatabasePutOpts = {
-  force?: boolean
-}
-
-export type DatabaseCreateIndexOpts = {
-  index: {
-    fields: string[]
-    name?: string | undefined
-    ddoc?: string | undefined
-    type?: string | undefined
-  }
-}
-
-export type DatabaseDeleteIndexOpts = {
-  name: string
-  ddoc: string
-  type?: string | undefined
-}
-
-export type DatabaseQueryOpts = {
-  include_docs?: boolean
-  startkey?: string
-  endkey?: string
-  limit?: number
-  skip?: number
-  descending?: boolean
-  key?: string
-  keys?: string[]
-  group?: boolean
-  startkey_docid?: string
-}
-
-export const isDocument = (doc: any): doc is Document => {
-  return typeof doc === "object" && doc._id && doc._rev
-}
-
-export interface DatabaseDumpOpts {
-  filter?: (doc: AnyDocument) => boolean
-  batch_size?: number
-  batch_limit?: number
-  style?: "main_only" | "all_docs"
-  timeout?: number
-  doc_ids?: string[]
-  query_params?: any
-  view?: string
-  selector?: any
-}
-
-export interface Database {
-  name: string
-
-  exists(): Promise<boolean>
-  checkSetup(): Promise<Nano.DocumentScope<any>>
-  get<T>(id?: string): Promise<T>
-  remove(
-    id: string | Document,
-    rev?: string
-  ): Promise<Nano.DocumentDestroyResponse>
-  put(
-    document: AnyDocument,
-    opts?: DatabasePutOpts
-  ): Promise<Nano.DocumentInsertResponse>
-  bulkDocs(documents: AnyDocument[]): Promise<Nano.DocumentBulkResponse[]>
-  allDocs<T>(params: DatabaseQueryOpts): Promise<AllDocsResponse<T>>
-  query<T>(
-    viewName: string,
-    params: DatabaseQueryOpts
-  ): Promise<AllDocsResponse<T>>
-  destroy(): Promise<Nano.OkResponse | void>
-  compact(): Promise<Nano.OkResponse | void>
-  // these are all PouchDB related functions that are rarely used - in future
-  // should be replaced by better typed/non-pouch implemented methods
-  dump(stream: Writable, opts?: DatabaseDumpOpts): Promise<any>
-  load(...args: any[]): Promise<any>
-  createIndex(...args: any[]): Promise<any>
-  deleteIndex(...args: any[]): Promise<any>
-  getIndexes(...args: any[]): Promise<any>
-}

package/src/sdk/environmentVariables.ts

@@ -1,4 +0,0 @@
-export enum AppEnvironment {
-  PRODUCTION = "production",
-  DEVELOPMENT = "development",
-}

package/src/sdk/events/app.ts

@@ -1,85 +0,0 @@
-import { BaseEvent } from "./event"
-
-export interface AppCreatedEvent extends BaseEvent {
-  appId: string
-  version: string
-  audited: {
-    name: string
-  }
-}
-
-export interface AppUpdatedEvent extends BaseEvent {
-  appId: string
-  version: string
-  audited: {
-    name: string
-  }
-}
-
-export interface AppDeletedEvent extends BaseEvent {
-  appId: string
-  audited: {
-    name: string
-  }
-}
-
-export interface AppPublishedEvent extends BaseEvent {
-  appId: string
-  audited: {
-    name: string
-  }
-}
-
-export interface AppUnpublishedEvent extends BaseEvent {
-  appId: string
-  audited: {
-    name: string
-  }
-}
-
-export interface AppFileImportedEvent extends BaseEvent {
-  appId: string
-  audited: {
-    name: string
-  }
-}
-
-export interface AppTemplateImportedEvent extends BaseEvent {
-  appId: string
-  templateKey: string
-  audited: {
-    name: string
-  }
-}
-
-export interface AppVersionUpdatedEvent extends BaseEvent {
-  appId: string
-  currentVersion: string
-  updatedToVersion: string
-  audited: {
-    name: string
-  }
-}
-
-export interface AppVersionRevertedEvent extends BaseEvent {
-  appId: string
-  currentVersion: string
-  revertedToVersion: string
-  audited: {
-    name: string
-  }
-}
-
-export interface AppRevertedEvent extends BaseEvent {
-  appId: string
-  audited: {
-    name: string
-  }
-}
-
-export interface AppExportedEvent extends BaseEvent {
-  appId: string
-  audited: {
-    name: string
-  }
-}

package/src/sdk/events/auditLog.ts

@@ -1,10 +0,0 @@
-import { BaseEvent } from "./event"
-import { AuditLogSearchParams } from "../../api"
-
-export interface AuditLogFilteredEvent extends BaseEvent {
-  filters: AuditLogSearchParams
-}
-
-export interface AuditLogDownloadedEvent extends BaseEvent {
-  filters: AuditLogSearchParams
-}

package/src/sdk/events/auth.ts

@@ -1,36 +0,0 @@
-import { BaseEvent } from "./event"
-import { ConfigType } from "../../documents"
-
-export type LoginSource = "local" | "google" | "oidc" | "google-internal"
-export type SSOType = ConfigType.OIDC | ConfigType.GOOGLE
-
-export interface LoginEvent extends BaseEvent {
-  userId: string
-  source: LoginSource
-  audited: {
-    email: string
-  }
-}
-
-export interface LogoutEvent extends BaseEvent {
-  userId: string
-  audited: {
-    email?: string
-  }
-}
-
-export interface SSOCreatedEvent extends BaseEvent {
-  type: SSOType
-}
-
-export interface SSOUpdatedEvent extends BaseEvent {
-  type: SSOType
-}
-
-export interface SSOActivatedEvent extends BaseEvent {
-  type: SSOType
-}
-
-export interface SSODeactivatedEvent extends BaseEvent {
-  type: SSOType
-}

package/src/sdk/events/automation.ts

@@ -1,63 +0,0 @@
-import { BaseEvent } from "./event"
-
-export interface AutomationCreatedEvent extends BaseEvent {
-  appId: string
-  automationId: string
-  triggerId: string
-  triggerType: string
-  audited: {
-    name: string
-  }
-}
-
-export interface AutomationTriggerUpdatedEvent extends BaseEvent {
-  appId: string
-  automationId: string
-  triggerId: string
-  triggerType: string
-}
-
-export interface AutomationDeletedEvent extends BaseEvent {
-  appId: string
-  automationId: string
-  triggerId: string
-  triggerType: string
-  audited: {
-    name: string
-  }
-}
-
-export interface AutomationTestedEvent extends BaseEvent {
-  appId: string
-  automationId: string
-  triggerId: string
-  triggerType: string
-}
-
-export interface AutomationStepCreatedEvent extends BaseEvent {
-  appId: string
-  automationId: string
-  triggerId: string
-  triggerType: string
-  stepId: string
-  stepType: string
-  audited: {
-    name: string
-  }
-}
-
-export interface AutomationStepDeletedEvent extends BaseEvent {
-  appId: string
-  automationId: string
-  triggerId: string
-  triggerType: string
-  stepId: string
-  stepType: string
-  audited: {
-    name: string
-  }
-}
-
-export interface AutomationsRunEvent extends BaseEvent {
-  count: number
-}

package/src/sdk/events/backup.ts

@@ -1,17 +0,0 @@
-import { BaseEvent } from "./event"
-import { AppBackupTrigger, AppBackupType } from "../../documents"
-
-export interface AppBackupRestoreEvent extends BaseEvent {
-  appId: string
-  restoreId: string
-  backupCreatedAt: string
-  name: string
-}
-
-export interface AppBackupTriggeredEvent extends BaseEvent {
-  backupId: string
-  appId: string
-  trigger: AppBackupTrigger
-  type: AppBackupType
-  name: string
-}

package/src/sdk/events/datasource.ts

@@ -1,19 +0,0 @@
-import { BaseEvent } from "./event"
-
-export interface DatasourceCreatedEvent extends BaseEvent {
-  datasourceId: string
-  source: string
-  custom: boolean
-}
-
-export interface DatasourceUpdatedEvent extends BaseEvent {
-  datasourceId: string
-  source: string
-  custom: boolean
-}
-
-export interface DatasourceDeletedEvent extends BaseEvent {
-  datasourceId: string
-  source: string
-  custom: boolean
-}

package/src/sdk/events/email.ts

@@ -1,5 +0,0 @@
-import { BaseEvent } from "./event"
-
-export interface SMTPCreatedEvent extends BaseEvent {}
-
-export interface SMTPUpdatedEvent extends BaseEvent {}