@brimdata/zealot/src/client/types.ts

The Javascript Client for Zed Lakes

export type ClientOpts = {
  auth: string | null
}

export type ResponseFormat =
  | "arrows"
  | "csv"
  | "json"
  | "ndjson"
  | "vng"
  | "zeek"
  | "zjson"
  | "zng"
  | "zson"

export type QueryOpts = {
  format: ResponseFormat
  controlMessages: boolean
  signal?: AbortSignal
  timeout?: number
}

export type CreatePoolOpts = {
  key: string | string[]
  order: "asc" | "desc"
}

export type Pool = {
  id: string
  name: string
  threshold: bigint
  ts: Date
  layout: {
    order: "desc" | "asc"
    keys: string[][]
  }
}

export type Branch = {
  ts: Date
  name: string
  commit: string
}

export type CreatePoolResp = {
  pool: Pool
  branch: Branch
}

export interface IdObj {
  id: string
}

export type LoadOpts = {
  pool: string | IdObj
  branch: string
  message: {
    author: string
    body: string
  }
  signal?: AbortSignal
  format?: LoadFormat
}
export type LoadFormat =
  | "auto"
  | "arrows"
  | "csv"
  | "json"
  | "line"
  | "parquet"
  | "vng"
  | "zeek"
  | "zjson"
  | "zng"
  | "zson"

export type LoadContentType =
  | "*/*"
  | "application/vnd.apache.arrow.stream"
  | "text/csv"
  | "application/json"
  | "application/x-line"
  | "application/x-parquet"
  | "application/x-vng"
  | "application/x-zeek"
  | "application/x-zjson"
  | "application/x-zng"
  | "application/x-zson"

export type WebFetch = typeof window.fetch