@budibase/types 0.0.1 → 0.0.999-alpha.30

package/src/documents/app/table.ts

@@ -1,6 +1,88 @@
 import { Document } from "../document"
 import { View } from "./view"
+import { RenameColumn } from "../../sdk"
+import { FieldType } from "./row"
+
+export enum RelationshipTypes {
+  ONE_TO_MANY = "one-to-many",
+  MANY_TO_ONE = "many-to-one",
+  MANY_TO_MANY = "many-to-many",
+}
+
+export interface FieldSchema {
+  type: FieldType
+  externalType?: string
+  fieldName?: string
+  name: string
+  sortable?: boolean
+  tableId?: string
+  relationshipType?: RelationshipTypes
+  through?: string
+  foreignKey?: string
+  icon?: string
+  autocolumn?: boolean
+  subtype?: string
+  throughFrom?: string
+  throughTo?: string
+  formula?: string
+  formulaType?: string
+  main?: boolean
+  ignoreTimezones?: boolean
+  timeOnly?: boolean
+  lastID?: number
+  useRichText?: boolean | null
+  order?: number
+  width?: number
+  meta?: {
+    toTable: string
+    toKey: string
+  }
+  constraints?: {
+    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 TableSchema {
+  [key: string]: FieldSchema
+}
 
 export interface Table extends Document {
-  views: { [key: string]: View }
+  type?: string
+  views?: { [key: string]: View }
+  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 TableRequest extends Table {
+  _rename?: RenameColumn
+  created?: boolean
 }

package/src/documents/app/user.ts

@@ -2,4 +2,5 @@ import { Document } from "../document"
 
 export interface UserMetadata extends Document {
   roleId: string
+  email?: string
 }

package/src/documents/app/view.ts

@@ -5,6 +5,9 @@ export interface View {
   filters: ViewFilter[]
   schema: ViewSchema
   calculation?: ViewCalculation
+  map?: string
+  reduce?: any
+  meta?: Record<string, any>
 }
 
 export type ViewSchema = ViewCountOrSumSchema | ViewStatisticsSchema
@@ -30,7 +33,7 @@ export interface ViewStatisticsSchema {
 }
 
 export interface ViewFilter {
-  value: any
+  value?: any
   condition: string
   key: string
   conjunction?: string

package/src/documents/app/webhook.ts

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

@@ -4,3 +4,7 @@ export interface Document {
   createdAt?: string | number
   updatedAt?: string
 }
+
+export interface AnyDocument extends Document {
+  [key: string]: any
+}

package/src/documents/global/auditLogs.ts

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

package/src/documents/global/config.ts

@@ -1,68 +1,131 @@
 import { Document } from "../document"
 
-export interface Config extends Document {
+export interface Config<T = any> extends Document {
   type: ConfigType
+  config: T
 }
 
-export interface SMTPConfig extends Config {
-  config: {
-    port: number
-    host: string
-    from: string
-    subject: string
-    secure: boolean
+export interface SMTPInnerConfig {
+  port: number
+  host: string
+  from: string
+  subject?: string
+  secure: boolean
+  auth?: {
+    user: string
+    pass: string
   }
+  connectionTimeout?: any
 }
 
-export interface SettingsConfig extends Config {
-  config: {
-    company: string
-    logoUrl: string
-    platformUrl: string
-    uniqueTenantId?: string
-  }
+export interface SMTPConfig extends Config<SMTPInnerConfig> {}
+
+/**
+ * Accessible only via pro.
+ */
+export interface SettingsBrandingConfig {
+  faviconUrl?: string
+  faviconUrlEtag?: string
+
+  emailBrandingEnabled?: boolean
+  testimonialsEnabled?: boolean
+  platformTitle?: string
+  loginHeading?: string
+  loginButton?: string
+
+  metaDescription?: string
+  metaImageUrl?: string
+  metaTitle?: string
 }
 
-export interface GoogleConfig extends Config {
-  config: {
-    clientID: string
-    clientSecret: string
-    activated: boolean
-  }
+export interface SettingsInnerConfig {
+  platformUrl?: string
+  company?: string
+  logoUrl?: string // Populated on read
+  logoUrlEtag?: string
+  uniqueTenantId?: string
+  analyticsEnabled?: boolean
+  isSSOEnforced?: boolean
 }
 
-export interface OIDCConfig extends Config {
-  config: {
-    configs: {
-      configUrl: string
-      clientID: string
-      clientSecret: string
-      logo: string
-      name: string
-      uuid: string
-      activated: boolean
-    }[]
-  }
+export interface SettingsConfig extends Config<SettingsInnerConfig> {}
+
+export type SSOConfigType = ConfigType.GOOGLE | ConfigType.OIDC
+export type SSOConfig = GoogleInnerConfig | OIDCInnerConfig
+
+export interface GoogleInnerConfig {
+  clientID: string
+  clientSecret: string
+  activated: boolean
+  /**
+   * @deprecated read only
+   */
+  callbackURL?: string
+}
+
+export interface GoogleConfig extends Config<GoogleInnerConfig> {}
+
+export interface OIDCStrategyConfiguration {
+  issuer: string
+  authorizationURL: string
+  tokenURL: string
+  userInfoURL: string
+  clientID: string
+  clientSecret: string
+  callbackURL: string
+}
+
+export interface OIDCConfigs {
+  configs: OIDCInnerConfig[]
+}
+
+export interface OIDCInnerConfig {
+  configUrl: string
+  clientID: string
+  clientSecret: string
+  logo: string
+  name: string
+  uuid: string
+  activated: boolean
+  scopes: string[]
+}
+
+export interface OIDCConfig extends Config<OIDCConfigs> {}
+
+export interface OIDCWellKnownConfig {
+  issuer: string
+  authorization_endpoint: string
+  token_endpoint: string
+  userinfo_endpoint: string
 }
 
-export type NestedConfig =
-  | SMTPConfig
-  | SettingsConfig
-  | GoogleConfig
-  | OIDCConfig
+export interface SCIMInnerConfig {
+  enabled: boolean
+}
+
+export interface SCIMConfig extends Config<SCIMInnerConfig> {}
 
 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 const isSCIMConfig = (config: Config): config is SCIMConfig =>
+  config.type === ConfigType.SCIM
+
 export enum ConfigType {
   SETTINGS = "settings",
+  ACCOUNT = "account",
   SMTP = "smtp",
   GOOGLE = "google",
   OIDC = "oidc",
+  OIDC_LOGOS = "logos_oidc",
+  SCIM = "scim",
 }

package/src/documents/global/environmentVariables.ts

@@ -0,0 +1,20 @@
+import { Document } from "../document"
+
+export interface EnvironmentVariablesDoc extends Document {
+  variables: string
+}
+
+export type EnvironmentVariableValue = {
+  production: string
+  development: string
+}
+
+// what comes out of the "variables" when it is decrypted
+export type EnvironmentVariablesDecrypted = Record<
+  string,
+  EnvironmentVariableValue
+>
+
+export interface EnvironmentVariablesDocDecrypted extends Document {
+  variables: EnvironmentVariablesDecrypted
+}

package/src/documents/global/index.ts

@@ -1,2 +1,9 @@
 export * from "./config"
 export * from "./user"
+export * from "./userGroup"
+export * from "./plugin"
+export * from "./quotas"
+export * from "./schedule"
+export * from "./templates"
+export * from "./environmentVariables"
+export * from "./auditLogs"

package/src/documents/global/plugin.ts

@@ -0,0 +1,38 @@
+import { Document } from "../document"
+
+export enum PluginType {
+  DATASOURCE = "datasource",
+  COMPONENT = "component",
+  AUTOMATION = "automation",
+}
+
+export enum PluginSource {
+  NPM = "NPM",
+  GITHUB = "Github",
+  URL = "URL",
+  FILE = "File Upload",
+}
+export interface FileType {
+  path: string
+  name: string
+}
+
+export interface Plugin extends Document {
+  description: string
+  name: string
+  version: string
+  source: PluginSource
+  package: { [key: string]: any }
+  hash: string
+  schema: {
+    type: PluginType
+    [key: string]: any
+  }
+  iconFileName?: string
+  // Populated on read
+  jsUrl?: string
+  // Populated on read
+  iconUrl?: string
+}
+
+export const PLUGIN_TYPE_ARR = Object.values(PluginType)

package/src/documents/global/quotas.ts

@@ -0,0 +1,80 @@
+import { MonthlyQuotaName, StaticQuotaName } from "../../sdk"
+
+export enum BreakdownQuotaName {
+  ROW_QUERIES = "rowQueries",
+  DATASOURCE_QUERIES = "datasourceQueries",
+  AUTOMATIONS = "automations",
+}
+
+export const APP_QUOTA_NAMES = [
+  StaticQuotaName.ROWS,
+  MonthlyQuotaName.QUERIES,
+  MonthlyQuotaName.AUTOMATIONS,
+]
+
+export const BREAKDOWN_QUOTA_NAMES = [
+  MonthlyQuotaName.QUERIES,
+  MonthlyQuotaName.AUTOMATIONS,
+]
+
+export interface UsageBreakdown {
+  parent: MonthlyQuotaName
+  values: {
+    [key: string]: number
+  }
+}
+
+export type QuotaTriggers = {
+  [key: string]: string | undefined
+}
+
+export interface StaticUsage {
+  [StaticQuotaName.APPS]: number
+  [StaticQuotaName.PLUGINS]: number
+  [StaticQuotaName.USER_GROUPS]: number
+  [StaticQuotaName.ROWS]: number
+  triggers: {
+    [key in StaticQuotaName]?: QuotaTriggers
+  }
+}
+
+export interface MonthlyUsage {
+  [MonthlyQuotaName.QUERIES]: number
+  [MonthlyQuotaName.AUTOMATIONS]: number
+  [MonthlyQuotaName.DAY_PASSES]: number
+  triggers: {
+    [key in MonthlyQuotaName]?: QuotaTriggers
+  }
+  breakdown?: {
+    [key in BreakdownQuotaName]?: UsageBreakdown
+  }
+}
+
+export interface BaseQuotaUsage {
+  usageQuota: StaticUsage
+  monthly: {
+    [key: string]: MonthlyUsage
+  }
+}
+
+export interface QuotaUsage extends BaseQuotaUsage {
+  _id: string
+  _rev?: string
+  quotaReset: string
+  apps?: {
+    [key: string]: BaseQuotaUsage
+  }
+}
+
+export type SetUsageValues = {
+  total: number
+  app?: number
+  breakdown?: number
+  triggers?: QuotaTriggers
+}
+
+export type UsageValues = {
+  total: number
+  app?: number
+  breakdown?: number
+}

package/src/documents/global/schedule.ts

@@ -0,0 +1,32 @@
+import { Document } from "../document"
+
+export enum ScheduleType {
+  APP_BACKUP = "app_backup",
+}
+
+export enum ScheduleRepeatPeriod {
+  DAILY = "daily",
+  WEEKLY = "weekly",
+  MONTHLY = "monthly",
+}
+
+export interface Schedule extends Document {
+  type: ScheduleType
+  name: string
+  startDate: string
+  repeat: ScheduleRepeatPeriod
+  metadata: ScheduleMetadata
+}
+
+export type ScheduleMetadata = AppBackupScheduleMetadata
+
+export const isAppBackupMetadata = (
+  type: ScheduleType,
+  metadata: ScheduleMetadata
+): metadata is AppBackupScheduleMetadata => {
+  return type === ScheduleType.APP_BACKUP
+}
+
+export interface AppBackupScheduleMetadata {
+  apps: string[]
+}

package/src/documents/global/templates.ts

@@ -0,0 +1,9 @@
+import { Document } from "../document"
+
+export interface Template extends Document {
+  ownerId?: string
+  name?: string
+  contents: string
+  purpose: string
+  type?: string
+}

package/src/documents/global/user.ts

@@ -1,8 +1,45 @@
 import { Document } from "../document"
 
+// SSO
+
+export interface SSOProfileJson {
+  email?: string
+  picture?: string
+}
+
+export interface OAuth2 {
+  accessToken: string
+  refreshToken?: string
+}
+
+export enum SSOProviderType {
+  OIDC = "oidc",
+  GOOGLE = "google",
+}
+
+export interface UserSSO {
+  provider: string // the individual provider e.g. Okta, Auth0, Google
+  providerType: SSOProviderType
+  oauth2?: OAuth2
+  thirdPartyProfile?: SSOProfileJson
+}
+
+export type SSOUser = User & UserSSO
+
+export function isSSOUser(user: User): user is SSOUser {
+  return !!(user as SSOUser).providerType
+}
+
+// USER
+
 export interface User extends Document {
   tenantId: string
   email: string
+  userId?: string
+  firstName?: string
+  lastName?: string
+  pictureUrl?: string
+  forceResetPassword?: boolean
   roles: UserRoles
   builder?: {
     global: boolean
@@ -10,12 +47,41 @@ export interface User extends Document {
   admin?: {
     global: boolean
   }
-  providerType?: string
   password?: string
-  status?: string
+  status?: UserStatus
   createdAt?: number // override the default createdAt behaviour - users sdk historically set this to Date.now()
+  dayPassRecordedAt?: string
+  userGroups?: string[]
+  onboardedAt?: string
+  scimInfo?: { isSync: true } & Record<string, any>
+}
+
+export enum UserStatus {
+  ACTIVE = "active",
+  INACTIVE = "inactive",
 }
 
 export interface UserRoles {
   [key: string]: string
 }
+
+// UTILITY TYPES
+
+export interface BuilderUser extends User {
+  builder: {
+    global: boolean
+  }
+}
+
+export interface AdminUser extends User {
+  admin: {
+    global: boolean
+  }
+  builder: {
+    global: boolean
+  }
+}
+
+export function isUser(user: object): user is User {
+  return !!(user as User).roles
+}

package/src/documents/global/userGroup.ts

@@ -0,0 +1,23 @@
+import { Document } from "../document"
+
+export interface UserGroup extends Document {
+  name: string
+  icon: string
+  color: string
+  users?: GroupUser[]
+  roles?: UserGroupRoles
+  createdAt?: number
+  scimInfo?: {
+    externalId: string
+    isSync: boolean
+  }
+}
+
+export interface GroupUser {
+  _id: string
+  email: string
+}
+
+export interface UserGroupRoles {
+  [key: string]: string
+}

package/src/documents/index.ts

@@ -2,3 +2,5 @@ export * from "./account"
 export * from "./app"
 export * from "./global"
 export * from "./platform"
+export * from "./document"
+export * from "./pouch"

package/src/documents/platform/accounts.ts

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

package/src/documents/platform/index.ts

@@ -1 +1,4 @@
 export * from "./info"
+export * from "./users"
+export * from "./accounts"
+export * from "./tenants"

package/src/documents/platform/tenants.ts

@@ -0,0 +1,5 @@
+import { Document } from "../document"
+
+export interface Tenants extends Document {
+  tenantIds: string[]
+}

package/src/documents/platform/users.ts

@@ -0,0 +1,18 @@
+import { Document } from "../document"
+
+/**
+ * doc id is user email
+ */
+export interface PlatformUserByEmail extends Document {
+  tenantId: string
+  userId: string
+}
+
+/**
+ * doc id is userId
+ */
+export interface PlatformUserById extends Document {
+  tenantId: string
+}
+
+export type PlatformUser = PlatformUserByEmail | PlatformUserById