@rikishi/watermelondb/QueryDescription/index.d.ts

Build powerful React Native and React web apps that scale from hundreds to tens of thousands of records and remain fast

declare module '@rikishi/watermelondb/QueryDescription' {
  import { ColumnName, TableName } from '@rikishi/watermelondb'

  export type NonNullValue = number | string | boolean
  export type Value = NonNullValue | null
  export type CompoundValue = Value | Value[]

  export type Operator =
    | 'eq'
    | 'notEq'
    | 'gt'
    | 'gte'
    | 'weakGt' // TODO: Do we still even need `gt`?
    | 'lt'
    | 'lte'
    | 'oneOf'
    | 'notIn'
    | 'between'

  export interface ColumnDescription {
    column: ColumnName
  }

  export type ComparisonRight = { value: Value } | { values: NonNullValue[] } | ColumnDescription

  export interface Comparison {
    operator: Operator
    right: ComparisonRight
  }

  export interface WhereDescription {
    type: 'where'
    left: ColumnName
    comparison: Comparison
  }

  export type Where = WhereDescription | And | Or
  export interface And {
    type: 'and'
    conditions: Where[]
  }
  export interface Or {
    type: 'or'
    conditions: Where[]
  }
  export interface On {
    type: 'on'
    table: TableName<any>
    left: ColumnName
    comparison: Comparison
  }
  export interface SortBy {
    type: 'sortBy'
    sortColumn: ColumnName
    sortOrder: SortOrder
  }
  export type SortOrder = 'asc' | 'desc'
  export const asc: SortOrder
  export const desc: SortOrder
  export interface Take {
    type: 'take'
    count: number
  }
  export interface Skip {
    type: 'skip'
    count: number
  }
  export interface Join {
    type: 'joinTables'
    tables: TableName<any>[]
  }
  export interface NestedJoin {
    type: 'nestedJoinTable'
    from: TableName<any>
    to: TableName<any>
  }
  export interface Sql {
    type: 'sql'
    expr: string
  }
  export interface SqlQuery{
    type: 'sqlQuery',
    sql: string,
    values: Value[]
  }


  export type Clause = Where | On | SortBy | Take | Skip | Join | NestedJoin | Sql | SqlQuery
  export interface QueryDescription {
    where: Where[]
    join: On[]
    sortBy: SortBy[]
    take?: Take
    skip?: Skip
    joinTables?: Join
    nestedJoinTables?: NestedJoin
  }
  export type Condition = Where | On

  export function eq(valueOrColumn: Value | ColumnDescription): Comparison
  export function notEq(valueOrColumn: Value | ColumnDescription): Comparison
  export function gt(valueOrColumn: NonNullValue | ColumnDescription): Comparison
  export function gte(valueOrColumn: NonNullValue | ColumnDescription): Comparison
  export function weakGt(valueOrColumn: NonNullValue | ColumnDescription): Comparison
  export function lt(valueOrColumn: NonNullValue | ColumnDescription): Comparison
  export function lte(valueOrColumn: NonNullValue | ColumnDescription): Comparison
  export function oneOf(values: NonNullValue[]): Comparison
  export function notIn(values: NonNullValue[]): Comparison
  export function between(left: number, right: number): Comparison
  export function column(name: ColumnName): ColumnDescription
  export function where(left: ColumnName, valueOrComparison: Value | Comparison): WhereDescription
  export function and(...conditions: Condition[]): And
  export function or(...conditions: Condition[]): Or
  export function like(value: string): Comparison
  export function notLike(value: string): Comparison
  export function sortBy(sortColumn: ColumnName, sortOrder?: SortOrder): SortBy
  export function take(count: number): Take
  export function skip(count: number): Skip
  export function experimentalJoinTables(tables: TableName<any>[]): Join
  export function experimentalNestedJoin(from: TableName<any>, to: TableName<any>): NestedJoin
  export function sanitizeLikeString(value: string): string
  export function unsafeSqlExpr(sql: string): Sql
  export function unsafeSqlQuery(sql: string): SqlQuery
  export function unsafeLokiTransform(fn: LokiTransformFunction): LokiTransform

  type _OnFunctionColumnValue = (table: TableName<any>, column: ColumnName, value: Value) => On
  type _OnFunctionColumnComparison = (
    table: TableName<any>,
    column: ColumnName,
    comparison: Comparison,
  ) => On
  type _OnFunctionWhereDescription = (table: TableName<any>, where: Where) => On
  type _OnFunctionNested = (table: TableName<any>, on: On) => On

  type OnFunction = _OnFunctionColumnValue &
    _OnFunctionColumnComparison &
    _OnFunctionWhereDescription &
    _OnFunctionNested

  export const on: OnFunction

  export function buildQueryDescription(conditions: Clause[]): QueryDescription
  export function queryWithoutDeleted(query: QueryDescription): QueryDescription
}