@budibase/types 2.9.19-alpha.0 → 2.9.20

package/src/documents/global/config.ts

@@ -1,137 +0,0 @@
-import { Document } from "../document"
-
-export interface Config<T = any> extends Document {
-  type: ConfigType
-  config: T
-}
-
-export interface SMTPInnerConfig {
-  port: number
-  host: string
-  from: string
-  subject?: string
-  secure: boolean
-  auth?: {
-    user: string
-    pass: string
-  }
-  connectionTimeout?: any
-}
-
-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 SettingsInnerConfig {
-  platformUrl?: string
-  company?: string
-  logoUrl?: string // Populated on read
-  logoUrlEtag?: string
-  uniqueTenantId?: string
-  analyticsEnabled?: boolean
-  isSSOEnforced?: 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 OIDCLogosInnerConfig {
-  [key: string]: string
-}
-
-export interface OIDCLogosConfig extends Config<OIDCLogosInnerConfig> {}
-
-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 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

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

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

@@ -1,81 +0,0 @@
-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.USERS]: 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

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

@@ -1,9 +0,0 @@
-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,95 +0,0 @@
-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
-    apps?: string[]
-  }
-  admin?: {
-    global: boolean
-  }
-  password?: 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
-    apps?: string[]
-  }
-}
-
-export interface AdminUser extends User {
-  admin: {
-    global: boolean
-  }
-  builder: {
-    global: boolean
-  }
-}
-
-export interface AdminOnlyUser extends User {
-  admin: {
-    global: boolean
-  }
-}
-
-export function isUser(user: object): user is User {
-  return !!(user as User).roles
-}

package/src/documents/global/userGroup.ts

@@ -1,36 +0,0 @@
-import { PaginationResponse } from "../../api"
-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
-}
-
-export interface SearchGroupRequest {}
-export interface SearchGroupResponse {
-  data: UserGroup[]
-}
-
-export interface SearchUserGroupResponse extends PaginationResponse {
-  users: {
-    _id: any
-    email: any
-  }[]
-}

package/src/documents/index.ts

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

package/src/documents/platform/accounts.ts

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

package/src/documents/platform/index.ts

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

package/src/documents/platform/info.ts

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

package/src/documents/platform/tenants.ts

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

package/src/documents/platform/users.ts

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

package/src/documents/pouch.ts

@@ -1,32 +0,0 @@
-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,5 +0,0 @@
-export * from "./documents"
-export * from "./sdk"
-export * from "./api"
-export * from "./core"
-export * from "./shared"

package/src/sdk/auditLogs.ts

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

@@ -1,37 +0,0 @@
-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/automations/index.ts

@@ -1,16 +0,0 @@
-import { Automation, AutomationMetadata } from "../../documents"
-import { Job } from "bull"
-
-export interface AutomationDataEvent {
-  appId?: string
-  metadata?: AutomationMetadata
-  automation?: Automation
-  timeout?: number
-}
-
-export interface AutomationData {
-  event: AutomationDataEvent
-  automation: Automation
-}
-
-export type AutomationJob = Job<AutomationData>

package/src/sdk/cli/constants.ts

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

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

package/src/sdk/context.ts

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