@budibase/types 0.0.1 → 0.0.999-alpha.31

package/src/documents/pouch.ts

@@ -0,0 +1,32 @@
+export interface RowValue {
+  rev: string
+  deleted: boolean
+}
+
+export interface RowResponse<T> {
+  id: string
+  key: string
+  error: string
+  value: T | RowValue
+  doc?: T | any
+}
+
+export interface AllDocsResponse<T> {
+  offset: number
+  total_rows: number
+  rows: RowResponse<T>[]
+}
+
+export type BulkDocsResponse = BulkDocResponse[]
+
+interface BulkDocResponse {
+  ok: boolean
+  id: string
+  rev: string
+}
+
+export interface PutResponse {
+  ok: boolean
+  id: string
+  rev: string
+}

package/src/index.ts

@@ -1,4 +1,3 @@
 export * from "./documents"
-export * from "./sdk/events"
-export * from "./sdk/licensing"
 export * from "./sdk"
+export * from "./api"

package/src/sdk/auditLogs.ts

@@ -0,0 +1,22 @@
+import { Event, HostInfo } from "./events"
+import { AuditLogDoc } from "../documents"
+
+export type AuditWriteOpts = {
+  appId?: string
+  timestamp?: string | number
+  userId?: string
+  hostInfo?: HostInfo
+}
+
+export type AuditLogFn = (
+  event: Event,
+  metadata: any,
+  opts: AuditWriteOpts
+) => Promise<AuditLogDoc | undefined>
+
+export type AuditLogQueueEvent = {
+  event: Event
+  properties: any
+  opts: AuditWriteOpts
+  tenantId: string
+}

package/src/sdk/auth.ts

@@ -0,0 +1,37 @@
+import { BBContext } from "./koa"
+import { Hosting } from "./hosting"
+
+export interface AuthToken {
+  userId: string
+  tenantId: string
+  sessionId: string
+}
+
+export interface CreateSession {
+  sessionId: string
+  tenantId: string
+  csrfToken?: string
+  hosting?: Hosting
+}
+
+export interface Session extends CreateSession {
+  userId: string
+  lastAccessedAt: string
+  createdAt: string
+  // make optional attributes required
+  csrfToken: string
+}
+
+export interface SessionKey {
+  key: string
+}
+
+export interface ScannedSession {
+  value: Session
+}
+
+export interface PlatformLogoutOpts {
+  ctx: BBContext
+  userId: string
+  keepActiveSession?: boolean
+}

package/src/sdk/cli/constants.ts

@@ -0,0 +1,21 @@
+import { Event } from "../events"
+
+export enum CommandWord {
+  BACKUPS = "backups",
+  HOSTING = "hosting",
+  ANALYTICS = "analytics",
+  HELP = "help",
+  PLUGIN = "plugins",
+}
+
+export enum InitType {
+  QUICK = "quick",
+  DIGITAL_OCEAN = "do",
+}
+
+export const AnalyticsEvent = {
+  OptOut: "analytics:opt:out",
+  OptIn: "analytics:opt:in",
+  SelfHostInit: "hosting:init",
+  PluginInit: Event.PLUGIN_INIT,
+}

package/src/sdk/cli/index.ts

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

package/src/sdk/context.ts

@@ -1,9 +1,10 @@
 import { User, Account } from "../documents"
-import { IdentityType } from "./events/identification"
+import { IdentityType, HostInfo } from "./events"
 
 export interface BaseContext {
   _id: string
   type: IdentityType
+  tenantId?: string
 }
 
 export interface AccountUserContext extends BaseContext {
@@ -13,7 +14,9 @@ export interface AccountUserContext extends BaseContext {
 
 export interface UserContext extends BaseContext, User {
   _id: string
+  tenantId: string
   account?: Account
+  hostInfo: HostInfo
 }
 
 export type IdentityContext = BaseContext | AccountUserContext | UserContext

package/src/sdk/datasources.ts

@@ -0,0 +1,143 @@
+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",
+}
+
+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",
+  UNKNOWN = "unknown",
+}
+
+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 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
+  }
+}
+
+export interface DatasourceConfig {
+  [key: string]: {
+    type: string
+    display?: string
+    required?: boolean
+    default?: any
+    deprecated?: boolean
+  }
+}
+
+export interface Integration {
+  docs: string
+  plus?: boolean
+  auth?: { type: string }
+  relationships?: boolean
+  description: string
+  friendlyName: string
+  type?: string
+  iconUrl?: string
+  datasource: DatasourceConfig
+  query: {
+    [key: string]: QueryDefinition
+  }
+  extra?: ExtraQueryConfig
+}
+
+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>
+}
+
+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
+}

package/src/sdk/db.ts

@@ -0,0 +1,115 @@
+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
+}
+
+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 | any>
+  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

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

package/src/sdk/events/app.ts

@@ -3,50 +3,83 @@ 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

@@ -0,0 +1,10 @@
+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,15 +1,22 @@
 import { BaseEvent } from "./event"
+import { ConfigType } from "../../documents"
 
 export type LoginSource = "local" | "google" | "oidc" | "google-internal"
-export type SSOType = "oidc" | "google"
+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 {

package/src/sdk/events/automation.ts

@@ -5,6 +5,9 @@ export interface AutomationCreatedEvent extends BaseEvent {
   automationId: string
   triggerId: string
   triggerType: string
+  audited: {
+    name: string
+  }
 }
 
 export interface AutomationTriggerUpdatedEvent extends BaseEvent {
@@ -19,6 +22,9 @@ export interface AutomationDeletedEvent extends BaseEvent {
   automationId: string
   triggerId: string
   triggerType: string
+  audited: {
+    name: string
+  }
 }
 
 export interface AutomationTestedEvent extends BaseEvent {
@@ -35,6 +41,9 @@ export interface AutomationStepCreatedEvent extends BaseEvent {
   triggerType: string
   stepId: string
   stepType: string
+  audited: {
+    name: string
+  }
 }
 
 export interface AutomationStepDeletedEvent extends BaseEvent {
@@ -44,6 +53,9 @@ export interface AutomationStepDeletedEvent extends BaseEvent {
   triggerType: string
   stepId: string
   stepType: string
+  audited: {
+    name: string
+  }
 }
 
 export interface AutomationsRunEvent extends BaseEvent {

package/src/sdk/events/backup.ts

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

@@ -3,14 +3,17 @@ 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/environmentVariable.ts

@@ -0,0 +1,14 @@
+import { BaseEvent } from "./event"
+
+export interface EnvironmentVariableCreatedEvent extends BaseEvent {
+  name: string
+  environments: string[]
+}
+
+export interface EnvironmentVariableDeletedEvent extends BaseEvent {
+  name: string
+}
+
+export interface EnvironmentVariableUpgradePanelOpenedEvent extends BaseEvent {
+  userId: string
+}