@budibase/types 2.9.19 → 2.9.20

package/src/api/web/global/scim/users.ts

@@ -1,53 +0,0 @@
-import { ScimResource, ScimMeta } from "scim-patch"
-import { ScimListResponse } from "./shared"
-
-type BooleanString = boolean | "True" | "true" | "False" | "false"
-
-type Emails =
-  | {
-      value: string
-      type: "work"
-      primary: boolean
-    }[]
-
-export interface ScimUserResponse extends ScimResource {
-  schemas: ["urn:ietf:params:scim:schemas:core:2.0:User"]
-  id: string
-  externalId: string
-  meta: ScimMeta & {
-    resourceType: "User"
-  }
-  userName: string
-  displayName?: string
-  name?: {
-    formatted?: string
-    familyName?: string
-    givenName?: string
-  }
-  active: BooleanString
-  emails?: Emails
-}
-
-export interface ScimCreateUserRequest {
-  schemas: [
-    "urn:ietf:params:scim:schemas:core:2.0:User",
-    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
-  ]
-  externalId: string
-  userName: string
-  active: BooleanString
-  emails?: Emails
-  meta: {
-    resourceType: "User"
-  }
-  displayName?: string
-  name?: {
-    formatted: string
-    familyName: string
-    givenName: string
-  }
-  roles: []
-}
-
-export interface ScimUserListResponse
-  extends ScimListResponse<ScimUserResponse> {}

package/src/api/web/index.ts

@@ -1,10 +0,0 @@
-export * from "./analytics"
-export * from "./auth"
-export * from "./user"
-export * from "./errors"
-export * from "./debug"
-export * from "./schedule"
-export * from "./system"
-export * from "./app"
-export * from "./global"
-export * from "./pagination"

package/src/api/web/pagination.ts

@@ -1,27 +0,0 @@
-export enum SortOrder {
-  ASCENDING = "ascending",
-  DESCENDING = "descending",
-}
-
-export enum SortType {
-  STRING = "string",
-  number = "number",
-}
-
-export interface BasicPaginationRequest {
-  bookmark?: string
-}
-
-export interface PaginationRequest extends BasicPaginationRequest {
-  limit?: number
-  sort?: {
-    order: SortOrder
-    column: string
-    type: SortType
-  }
-}
-
-export interface PaginationResponse {
-  bookmark: string | undefined
-  hasNextPage: boolean
-}

package/src/api/web/schedule.ts

@@ -1,15 +0,0 @@
-import {
-  ScheduleMetadata,
-  ScheduleRepeatPeriod,
-  ScheduleType,
-} from "../../documents"
-
-export interface CreateScheduleRequest {
-  type: ScheduleType
-  name: string
-  startDate: string
-  repeat: ScheduleRepeatPeriod
-  metadata: ScheduleMetadata
-}
-
-export interface UpdateScheduleRequest extends CreateScheduleRequest {}

package/src/api/web/system/environment.ts

@@ -1,8 +0,0 @@
-export interface GetEnvironmentResponse {
-  multiTenancy: boolean
-  cloud: boolean
-  accountPortalUrl: string
-  baseUrl: string
-  disableAccountPortal: boolean
-  isDev: boolean
-}

package/src/api/web/system/index.ts

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

package/src/api/web/user.ts

@@ -1,87 +0,0 @@
-import { User } from "../../documents"
-
-export interface SaveUserResponse {
-  _id: string
-  _rev: string
-  email: string
-}
-
-export interface UserDetails {
-  _id: string
-  email: string
-}
-
-export interface BulkUserRequest {
-  delete?: {
-    userIds: string[]
-  }
-  create?: {
-    roles?: any[]
-    users: User[]
-    groups: any[]
-  }
-}
-
-export interface BulkUserCreated {
-  successful: UserDetails[]
-  unsuccessful: { email: string; reason: string }[]
-}
-
-export interface BulkUserDeleted {
-  successful: UserDetails[]
-  unsuccessful: { _id: string; email: string; reason: string }[]
-}
-
-export interface BulkUserResponse {
-  created?: BulkUserCreated
-  deleted?: BulkUserDeleted
-  message?: string
-}
-
-export interface InviteUserRequest {
-  email: string
-  userInfo: any
-}
-
-export type InviteUsersRequest = InviteUserRequest[]
-
-export interface InviteUsersResponse {
-  successful: { email: string }[]
-  unsuccessful: { email: string; reason: string }[]
-}
-
-export interface SearchUsersRequest {
-  page?: string
-  email?: string
-  appId?: string
-  paginated?: boolean
-}
-
-export interface CreateAdminUserRequest {
-  email: string
-  password: string
-  tenantId: string
-}
-
-export interface CreateAdminUserResponse {
-  _id: string
-  _rev: string
-  email: string
-}
-
-export interface AcceptUserInviteRequest {
-  inviteCode: string
-  password: string
-  firstName: string
-  lastName: string
-}
-
-export interface AcceptUserInviteResponse {
-  _id: string
-  _rev: string
-  email: string
-}
-
-export interface SyncUserRequest {
-  previousUser?: User
-}

package/src/core/index.ts

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

package/src/core/installation.ts

@@ -1,4 +0,0 @@
-export enum ServiceType {
-  WORKER = "worker",
-  APPS = "apps",
-}

package/src/documents/account/account.ts

@@ -1,108 +0,0 @@
-import { Feature, Hosting, License, PlanType, Quotas } from "../../sdk"
-import { DeepPartial } from "../../shared"
-import { QuotaUsage } from "../global"
-
-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 LicenseOverrides {
-  features?: Feature[]
-  quotas?: DeepPartial<Quotas>
-}
-
-export interface Account extends CreateAccount {
-  // generated
-  accountId: string
-  createdAt: number
-  // registration
-  verified: boolean
-  verificationSent: boolean
-  // licensing
-  tier: string // deprecated
-  planType?: PlanType
-  /** @deprecated */
-  planTier?: number
-  license?: License
-  installId?: string
-  installTenantId?: string
-  installVersion?: string
-  stripeCustomerId?: string
-  licenseKey?: string
-  licenseKeyActivatedAt?: number
-  licenseRequestedAt?: number
-  licenseOverrides?: LicenseOverrides
-  quotaUsage?: QuotaUsage
-  offlineLicenseToken?: 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 enum AccountSSOProviderType {
-  GOOGLE = "google",
-  MICROSOFT = "microsoft",
-}
-
-export enum AccountSSOProvider {
-  GOOGLE = "google",
-  MICROSOFT = "microsoft",
-}
-
-export interface AccountSSO {
-  provider: AccountSSOProvider
-  providerType: AccountSSOProviderType
-  oauth2?: OAuthTokens
-  pictureUrl?: string
-  thirdPartyProfile: any // TODO: define what the google profile looks like
-}
-
-export type SSOAccount = (Account | CloudAccount) & AccountSSO
-
-export enum AuthType {
-  SSO = "sso",
-  PASSWORD = "password",
-}
-
-export interface OAuthTokens {
-  accessToken: string
-  refreshToken: string
-}

package/src/documents/account/index.ts

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

package/src/documents/app/app.ts

@@ -1,69 +0,0 @@
-import { User, Document } from "../"
-import { SocketSession } from "../../sdk"
-
-export type AppMetadataErrors = { [key: string]: string[] }
-
-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
-  theme?: string
-  customTheme?: AppCustomTheme
-  revertableVersion?: string
-  lockedBy?: User
-  sessions?: SocketSession[]
-  navigation?: AppNavigation
-  automationErrors?: AppMetadataErrors
-  icon?: AppIcon
-  features?: AppFeatures
-}
-
-export interface AppInstance {
-  _id: string
-}
-
-export interface AppNavigation {
-  navigation: string
-  title: string
-  navWidth: string
-  sticky?: boolean
-  hideLogo?: boolean
-  logoUrl?: string
-  hideTitle?: boolean
-  navBackground?: string
-  navTextColor?: string
-  links?: AppNavigationLink[]
-}
-
-export interface AppNavigationLink {
-  text: string
-  url: string
-  id?: string
-  roleId?: string
-}
-
-export interface AppCustomTheme {
-  buttonBorderRadius?: string
-  primaryColor?: string
-  primaryColorHover?: string
-
-  // Used to exist before new design UI
-  navTextColor?: string
-  navBackground?: string
-}
-
-export interface AppIcon {
-  name: string
-  color: string
-}
-
-export interface AppFeatures {
-  componentValidation?: boolean
-}

package/src/documents/app/automation.ts

@@ -1,222 +0,0 @@
-import { Document } from "../document"
-import { EventEmitter } from "events"
-import { User } from "../global"
-
-export enum AutomationIOType {
-  OBJECT = "object",
-  STRING = "string",
-  BOOLEAN = "boolean",
-  NUMBER = "number",
-  ARRAY = "array",
-  JSON = "json",
-  DATE = "date",
-}
-
-export enum AutomationCustomIOType {
-  TABLE = "table",
-  ROW = "row",
-  ROWS = "rows",
-  WIDE = "wide",
-  QUERY = "query",
-  QUERY_PARAMS = "queryParams",
-  QUERY_LIMIT = "queryLimit",
-  LOOP_OPTION = "loopOption",
-  ITEM = "item",
-  CODE = "code",
-  FILTERS = "filters",
-  COLUMN = "column",
-  TRIGGER_SCHEMA = "triggerSchema",
-  CRON = "cron",
-  WEBHOOK_URL = "webhookUrl",
-}
-
-export enum AutomationTriggerStepId {
-  ROW_SAVED = "ROW_SAVED",
-  ROW_UPDATED = "ROW_UPDATED",
-  ROW_DELETED = "ROW_DELETED",
-  WEBHOOK = "WEBHOOK",
-  APP = "APP",
-  CRON = "CRON",
-}
-
-export enum AutomationStepType {
-  LOGIC = "LOGIC",
-  ACTION = "ACTION",
-  TRIGGER = "TRIGGER",
-}
-
-export enum AutomationActionStepId {
-  SEND_EMAIL_SMTP = "SEND_EMAIL_SMTP",
-  CREATE_ROW = "CREATE_ROW",
-  UPDATE_ROW = "UPDATE_ROW",
-  DELETE_ROW = "DELETE_ROW",
-  EXECUTE_BASH = "EXECUTE_BASH",
-  OUTGOING_WEBHOOK = "OUTGOING_WEBHOOK",
-  EXECUTE_SCRIPT = "EXECUTE_SCRIPT",
-  EXECUTE_QUERY = "EXECUTE_QUERY",
-  SERVER_LOG = "SERVER_LOG",
-  DELAY = "DELAY",
-  FILTER = "FILTER",
-  QUERY_ROWS = "QUERY_ROWS",
-  LOOP = "LOOP",
-  COLLECT = "COLLECT",
-  OPENAI = "OPENAI",
-  // these used to be lowercase step IDs, maintain for backwards compat
-  discord = "discord",
-  slack = "slack",
-  zapier = "zapier",
-  integromat = "integromat",
-}
-
-export interface EmailInvite {
-  startTime: Date
-  endTime: Date
-  summary: string
-  location?: string
-  url?: string
-}
-
-export interface SendEmailOpts {
-  // workspaceId If finer grain controls being used then this will lookup config for workspace.
-  workspaceId?: string
-  // user If sending to an existing user the object can be provided, this is used in the context.
-  user: User
-  // from If sending from an address that is not what is configured in the SMTP config.
-  from?: string
-  // contents If sending a custom email then can supply contents which will be added to it.
-  contents?: string
-  // subject A custom subject can be specified if the config one is not desired.
-  subject?: string
-  // info Pass in a structure of information to be stored alongside the invitation.
-  info?: any
-  cc?: boolean
-  bcc?: boolean
-  automation?: boolean
-  invite?: EmailInvite
-}
-
-export const AutomationStepIdArray = [
-  ...Object.values(AutomationActionStepId),
-  ...Object.values(AutomationTriggerStepId),
-]
-
-export interface Automation extends Document {
-  definition: {
-    steps: AutomationStep[]
-    trigger: AutomationTrigger
-  }
-  screenId?: string
-  uiTree?: any
-  appId: string
-  live?: boolean
-  name: string
-  internal?: boolean
-  type?: string
-}
-
-interface BaseIOStructure {
-  type?: AutomationIOType
-  customType?: AutomationCustomIOType
-  title?: string
-  description?: string
-  dependsOn?: string
-  enum?: string[]
-  pretty?: string[]
-  properties?: {
-    [key: string]: BaseIOStructure
-  }
-  required?: string[]
-}
-
-interface InputOutputBlock {
-  properties: {
-    [key: string]: BaseIOStructure
-  }
-  required?: string[]
-}
-
-export interface AutomationStepSchema {
-  name: string
-  stepTitle?: string
-  tagline: string
-  icon: string
-  description: string
-  type: AutomationStepType
-  internal?: boolean
-  deprecated?: boolean
-  stepId: AutomationTriggerStepId | AutomationActionStepId
-  blockToLoop?: string
-  inputs: {
-    [key: string]: any
-  }
-  schema: {
-    inputs: InputOutputBlock
-    outputs: InputOutputBlock
-  }
-  custom?: boolean
-  features?: Partial<Record<AutomationFeature, boolean>>
-}
-
-export enum AutomationFeature {
-  LOOPING = "LOOPING",
-}
-
-export interface AutomationStep extends AutomationStepSchema {
-  id: string
-}
-
-export interface AutomationTriggerSchema extends AutomationStepSchema {
-  event?: string
-  cronJobId?: string
-}
-
-export interface AutomationTrigger extends AutomationTriggerSchema {
-  id: string
-}
-
-export enum AutomationStatus {
-  SUCCESS = "success",
-  ERROR = "error",
-  STOPPED = "stopped",
-  STOPPED_ERROR = "stopped_error",
-  NO_ITERATIONS = "no_iterations",
-}
-
-export interface AutomationResults {
-  automationId?: string
-  status?: AutomationStatus
-  trigger?: any
-  steps: {
-    stepId: AutomationTriggerStepId | AutomationActionStepId
-    inputs: {
-      [key: string]: any
-    }
-    outputs: {
-      [key: string]: any
-    }
-  }[]
-}
-
-export interface AutomationLog extends AutomationResults, Document {
-  automationName: string
-  _rev?: string
-}
-
-export interface AutomationLogPage {
-  data: AutomationLog[]
-  hasNextPage: boolean
-  nextPage?: string
-}
-
-export type AutomationStepInput = {
-  inputs: Record<string, any>
-  context: Record<string, any>
-  emitter: EventEmitter
-  appId: string
-  apiKey?: string
-}
-
-export interface AutomationMetadata extends Document {
-  errorCount?: number
-  automationChainCount?: number
-}

package/src/documents/app/backup.ts

@@ -1,71 +0,0 @@
-import { Document } from "../document"
-import { User } from "../../"
-
-export enum AppBackupType {
-  BACKUP = "backup",
-  RESTORE = "restore",
-}
-
-export enum AppBackupStatus {
-  STARTED = "started",
-  PENDING = "pending",
-  COMPLETE = "complete",
-  FAILED = "failed",
-}
-
-export enum AppBackupTrigger {
-  PUBLISH = "publish",
-  MANUAL = "manual",
-  SCHEDULED = "scheduled",
-  RESTORING = "restoring",
-}
-
-export interface AppBackupContents {
-  datasources: string[]
-  screens: string[]
-  automations: string[]
-}
-
-export interface AppBackupMetadata {
-  appId: string
-  trigger?: AppBackupTrigger
-  type: AppBackupType
-  status: AppBackupStatus
-  name?: string
-  createdBy?: string | User
-  timestamp: string
-  finishedAt?: string
-  startedAt?: string
-  contents?: AppBackupContents
-}
-
-export interface AppBackup extends Document, AppBackupMetadata {
-  _id: string
-  filename?: string
-}
-
-export type AppBackupFetchOpts = {
-  trigger?: AppBackupTrigger
-  type?: AppBackupType
-  limit?: number
-  page?: string
-  paginate?: boolean
-  startDate?: string
-  endDate?: string
-}
-
-export interface AppBackupQueueData {
-  appId: string
-  docId: string
-  docRev: string
-  export?: {
-    trigger: AppBackupTrigger
-    name?: string
-    createdBy?: string
-  }
-  import?: {
-    backupId: string
-    nameForBackup: string
-    createdBy?: string
-  }
-}

package/src/documents/app/component.ts

@@ -1,9 +0,0 @@
-import { Document } from "../document"
-
-export interface Component extends Document {
-  _instanceName: string
-  _styles: { [key: string]: any }
-  _component: string
-  _children?: Component[]
-  [key: string]: any
-}