@budibase/types 0.0.1

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@budibase/types",
+  "version": "0.0.1",
+  "description": "Budibase types",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "Budibase",
+  "license": "GPL-3.0",
+  "scripts": {
+    "prebuild": "rimraf dist/",
+    "build": "tsc -p tsconfig.build.json",
+    "build:dev": "yarn prebuild && tsc --build --watch --preserveWatchOutput"
+  },
+  "jest": {},
+  "devDependencies": {
+    "@types/node": "14.18.20",
+    "rimraf": "3.0.2",
+    "typescript": "4.7.3"
+  }
+}

package/src/documents/account/account.ts

@@ -0,0 +1,82 @@
+import { Hosting } from "../../sdk"
+
+export interface CreateAccount {
+  email: string
+  tenantId: string
+  hosting: Hosting
+  authType: AuthType
+  // optional fields - for sso based sign ups
+  registrationStep?: string
+  // profile
+  tenantName?: string
+  name?: string
+  size?: string
+  profession?: string
+}
+
+export interface CreatePassswordAccount extends CreateAccount {
+  password: string
+}
+
+export const isCreatePasswordAccount = (
+  account: CreateAccount
+): account is CreatePassswordAccount => account.authType === AuthType.PASSWORD
+
+export interface UpdateAccount {
+  stripeCustomerId?: string
+  licenseKey?: string
+}
+
+export interface Account extends CreateAccount {
+  // generated
+  accountId: string
+  createdAt: number
+  // registration
+  verified: boolean
+  verificationSent: boolean
+  // licensing
+  tier: string // deprecated
+  stripeCustomerId?: string
+  licenseKey?: string
+}
+
+export interface PasswordAccount extends Account {
+  password: string
+}
+
+export const isPasswordAccount = (
+  account: Account
+): account is PasswordAccount =>
+  account.authType === AuthType.PASSWORD && account.hosting === Hosting.SELF
+
+export interface CloudAccount extends Account {
+  password?: string
+  budibaseUserId: string
+}
+
+export const isCloudAccount = (account: Account): account is CloudAccount =>
+  account.hosting === Hosting.CLOUD
+
+export const isSelfHostAccount = (account: Account) =>
+  account.hosting === Hosting.SELF
+
+export const isSSOAccount = (account: Account): account is SSOAccount =>
+  account.authType === AuthType.SSO
+
+export interface SSOAccount extends Account {
+  pictureUrl?: string
+  provider?: string
+  providerType?: string
+  oauth2?: OAuthTokens
+  thirdPartyProfile: any // TODO: define what the google profile looks like
+}
+
+export enum AuthType {
+  SSO = "sso",
+  PASSWORD = "password",
+}
+
+export interface OAuthTokens {
+  accessToken: string
+  refreshToken: string
+}

package/src/documents/account/index.ts

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

package/src/documents/app/app.ts

@@ -0,0 +1,19 @@
+import { Document } from "../document"
+
+export interface App extends Document {
+  appId: string
+  type: string
+  version: string
+  componentLibraries: string[]
+  name: string
+  url: string | undefined
+  template: string | undefined
+  instance: AppInstance
+  tenantId: string
+  status: string
+  revertableVersion?: string
+}
+
+export interface AppInstance {
+  _id: string
+}

package/src/documents/app/automation.ts

@@ -0,0 +1,19 @@
+import { Document } from "../document"
+
+export interface Automation extends Document {
+  definition: {
+    steps: AutomationStep[]
+    trigger: AutomationTrigger
+  }
+  appId: string
+}
+
+export interface AutomationStep {
+  id: string
+  stepId: string
+}
+
+export interface AutomationTrigger {
+  id: string
+  stepId: string
+}

package/src/documents/app/datasource.ts

@@ -0,0 +1,5 @@
+import { Document } from "../document"
+
+export interface Datasource extends Document {
+  source: string
+}

package/src/documents/app/index.ts

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

package/src/documents/app/layout.ts

@@ -0,0 +1,3 @@
+import { Document } from "../document"
+
+export interface Layout extends Document {}

package/src/documents/app/query.ts

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

package/src/documents/app/role.ts

@@ -0,0 +1,6 @@
+import { Document } from "../document"
+
+export interface Role extends Document {
+  permissionId: string
+  inherits: string
+}

package/src/documents/app/row.ts

@@ -0,0 +1,3 @@
+import { Document } from "../document"
+
+export interface Row extends Document {}

package/src/documents/app/screen.ts

@@ -0,0 +1,9 @@
+import { Document } from "../document"
+
+export interface Screen extends Document {
+  layoutId: string
+  routing: {
+    route: string
+    roleId: string
+  }
+}

package/src/documents/app/table.ts

@@ -0,0 +1,6 @@
+import { Document } from "../document"
+import { View } from "./view"
+
+export interface Table extends Document {
+  views: { [key: string]: View }
+}

package/src/documents/app/user.ts

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

package/src/documents/app/view.ts

@@ -0,0 +1,43 @@
+export interface View {
+  name: string
+  tableId: string
+  field?: string
+  filters: ViewFilter[]
+  schema: ViewSchema
+  calculation?: ViewCalculation
+}
+
+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/document.ts

@@ -0,0 +1,6 @@
+export interface Document {
+  _id?: string
+  _rev?: string
+  createdAt?: string | number
+  updatedAt?: string
+}

package/src/documents/global/config.ts

@@ -0,0 +1,68 @@
+import { Document } from "../document"
+
+export interface Config extends Document {
+  type: ConfigType
+}
+
+export interface SMTPConfig extends Config {
+  config: {
+    port: number
+    host: string
+    from: string
+    subject: string
+    secure: boolean
+  }
+}
+
+export interface SettingsConfig extends Config {
+  config: {
+    company: string
+    logoUrl: string
+    platformUrl: string
+    uniqueTenantId?: string
+  }
+}
+
+export interface GoogleConfig extends Config {
+  config: {
+    clientID: string
+    clientSecret: string
+    activated: boolean
+  }
+}
+
+export interface OIDCConfig extends Config {
+  config: {
+    configs: {
+      configUrl: string
+      clientID: string
+      clientSecret: string
+      logo: string
+      name: string
+      uuid: string
+      activated: boolean
+    }[]
+  }
+}
+
+export type NestedConfig =
+  | SMTPConfig
+  | SettingsConfig
+  | GoogleConfig
+  | OIDCConfig
+
+export const isSettingsConfig = (config: Config): config is SettingsConfig =>
+  config.type === ConfigType.SETTINGS
+export const isSMTPConfig = (config: Config): config is SMTPConfig =>
+  config.type === ConfigType.SMTP
+export const isGoogleConfig = (config: Config): config is GoogleConfig =>
+  config.type === ConfigType.GOOGLE
+export const isOIDCConfig = (config: Config): config is OIDCConfig =>
+  config.type === ConfigType.OIDC
+
+export enum ConfigType {
+  SETTINGS = "settings",
+  SMTP = "smtp",
+  GOOGLE = "google",
+  OIDC = "oidc",
+}

package/src/documents/global/index.ts

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

package/src/documents/global/user.ts

@@ -0,0 +1,21 @@
+import { Document } from "../document"
+
+export interface User extends Document {
+  tenantId: string
+  email: string
+  roles: UserRoles
+  builder?: {
+    global: boolean
+  }
+  admin?: {
+    global: boolean
+  }
+  providerType?: string
+  password?: string
+  status?: string
+  createdAt?: number // override the default createdAt behaviour - users sdk historically set this to Date.now()
+}
+
+export interface UserRoles {
+  [key: string]: string
+}

package/src/documents/index.ts

@@ -0,0 +1,4 @@
+export * from "./account"
+export * from "./app"
+export * from "./global"
+export * from "./platform"

package/src/documents/platform/index.ts

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

package/src/documents/platform/info.ts

@@ -0,0 +1,9 @@
+import { Document } from "../document"
+
+export interface GlobalInfo {}
+
+export interface Installation extends Document {
+  _id: string
+  installId: string
+  version: string
+}

package/src/index.ts

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

package/src/sdk/context.ts

@@ -0,0 +1,19 @@
+import { User, Account } from "../documents"
+import { IdentityType } from "./events/identification"
+
+export interface BaseContext {
+  _id: string
+  type: IdentityType
+}
+
+export interface AccountUserContext extends BaseContext {
+  tenantId: string
+  account: Account
+}
+
+export interface UserContext extends BaseContext, User {
+  _id: string
+  account?: Account
+}
+
+export type IdentityContext = BaseContext | AccountUserContext | UserContext

package/src/sdk/events/account.ts

@@ -0,0 +1,15 @@
+import { BaseEvent } from "./event"
+
+export interface AccountCreatedEvent extends BaseEvent {
+  tenantId: string
+  registrationStep?: string
+}
+
+export interface AccountDeletedEvent extends BaseEvent {
+  tenantId: string
+  registrationStep?: string
+}
+
+export interface AccountVerifiedEvent extends BaseEvent {
+  tenantId: string
+}

package/src/sdk/events/app.ts

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

package/src/sdk/events/auth.ts

@@ -0,0 +1,29 @@
+import { BaseEvent } from "./event"
+
+export type LoginSource = "local" | "google" | "oidc" | "google-internal"
+export type SSOType = "oidc" | "google"
+
+export interface LoginEvent extends BaseEvent {
+  userId: string
+  source: LoginSource
+}
+
+export interface LogoutEvent extends BaseEvent {
+  userId: 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

@@ -0,0 +1,51 @@
+import { BaseEvent } from "./event"
+
+export interface AutomationCreatedEvent extends BaseEvent {
+  appId: string
+  automationId: string
+  triggerId: string
+  triggerType: 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
+}
+
+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
+}
+
+export interface AutomationStepDeletedEvent extends BaseEvent {
+  appId: string
+  automationId: string
+  triggerId: string
+  triggerType: string
+  stepId: string
+  stepType: string
+}
+
+export interface AutomationsRunEvent extends BaseEvent {
+  count: number
+}

package/src/sdk/events/backfill.ts

@@ -0,0 +1,46 @@
+import { BaseEvent, Event } from "./event"
+
+export interface AppBackfillSucceededEvent extends BaseEvent {
+  appId: string
+  automations: number
+  datasources: number
+  layouts: number
+  queries: number
+  roles: number
+  tables: number
+  screens: number
+  errors?: string[]
+  errorCount?: number
+}
+
+export interface AppBackfillFailedEvent extends BaseEvent {
+  error: string
+}
+
+export interface TenantBackfillSucceededEvent extends BaseEvent {
+  apps: number
+  users: number
+
+  usage: any
+  errors?: [string]
+  errorCount?: number
+}
+
+export interface TenantBackfillFailedEvent extends BaseEvent {
+  error: string
+}
+
+export interface InstallationBackfillSucceededEvent extends BaseEvent {}
+
+export interface InstallationBackfillFailedEvent extends BaseEvent {
+  error: string
+}
+
+export interface BackfillMetadata extends BaseEvent {
+  eventWhitelist: Event[]
+}
+
+export interface CachedEvent extends BaseEvent {
+  event: Event
+  properties: any
+}

package/src/sdk/events/datasource.ts

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

package/src/sdk/events/email.ts

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