@rikishi/watermelondb/Schema/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/Schema' {
  import { Model } from '@rikishi/watermelondb'

  export type SchemaVersion = number

  export type TableName<T extends Model | void> = string
  export type ColumnName = string

  export function tableName<T extends Model>(name: string): TableName<T>

  export function columnName(name: string): ColumnName

  export type ColumnType = 'string' | 'number' | 'boolean'

  export interface ColumnSchema {
    name: ColumnName
    type: ColumnType
    isOptional?: boolean
    isIndexed?: boolean
  }

  interface ColumnMap {
    [name: string]: ColumnSchema
  }

  export type TableSchemaSpec = { name: TableName<any>; columns: ColumnSchema[] }

  export interface TableSchema {
    name: TableName<any>
    columns: ColumnMap
  }

  interface TableMap {
    [name: string]: TableSchema
  }

  export interface AppSchema {
    version: number
    tables: TableMap
  }

  export function appSchema(options: { version: number; tables: TableSchema[] }): AppSchema

  export function tableSchema(options: TableSchemaSpec): TableSchema
}