@budibase/server/src/threads/definitions.ts

Budibase Web Server

import { Datasource, Row, Query, ContextUser, SSOUser } from "@budibase/types"

export type WorkerCallback = (error: any, response?: any) => void

export interface QueryEventCtx {
  user?: Omit<ContextUser, "account" | "license"> | SSOUser
  auth?: {
    configId?: string
    sessionId?: string
  }
}

export interface QueryEvent
  extends Omit<
    Query,
    "datasourceId" | "name" | "parameters" | "readable" | "nestedSchemaFields"
  > {
  appId?: string
  datasource: Datasource
  pagination?: any
  queryId?: string
  environmentVariables?: Record<string, string>
  parameters: QueryEventParameters
  ctx?: QueryEventCtx
}

export type QueryEventParameters = Record<string, string | number | null>

export interface QueryResponse {
  rows: Row[]
  keys: string[]
  info: any
  extra: any
  pagination: any
}

export interface QueryVariable {
  queryId: string
  name: string
}