@livestore/common 0.3.0-dev.5 → 0.3.0-dev.51

package/src/query-builder/impl.test.ts

@@ -1,239 +0,0 @@
-import { Schema } from '@livestore/utils/effect'
-import { describe, expect, it } from 'vitest'
-
-import { DbSchema } from '../schema/mod.js'
-import { getResultSchema } from './impl.js'
-
-const todos = DbSchema.table(
-  'todos',
-  {
-    id: DbSchema.text({ primaryKey: true }),
-    text: DbSchema.text({ default: '', nullable: false }),
-    completed: DbSchema.boolean({ default: false, nullable: false }),
-    status: DbSchema.text({ schema: Schema.Literal('active', 'completed') }),
-    deletedAt: DbSchema.datetime({ nullable: true }),
-    // TODO consider leaning more into Effect schema
-    // other: Schema.Number.pipe(DbSchema.asInteger),
-  },
-  { deriveMutations: true },
-)
-
-const comments = DbSchema.table('comments', {
-  id: DbSchema.text({ primaryKey: true }),
-  text: DbSchema.text({ default: '', nullable: false }),
-  todoId: DbSchema.text({}),
-})
-
-const db = { todos: todos.query, comments: comments.query }
-
-describe('query builder', () => {
-  describe('result schema', () => {
-    it('should print the schema', () => {
-      expect(String(getResultSchema(db.todos))).toMatchInlineSnapshot(`"ReadonlyArray<todos>"`)
-    })
-  })
-
-  describe('basic queries', () => {
-    it('should handle simple SELECT queries', () => {
-      expect(db.todos.asSql()).toMatchInlineSnapshot(`
-        {
-          "bindValues": [],
-          "query": "SELECT * FROM 'todos'",
-        }
-      `)
-
-      expect(db.todos.select('id', 'text').asSql()).toMatchInlineSnapshot(`
-        {
-          "bindValues": [],
-          "query": "SELECT id, text FROM 'todos'",
-        }
-      `)
-    })
-
-    it('should handle WHERE clauses', () => {
-      expect(db.todos.select('id', 'text').where('completed', true).asSql()).toMatchInlineSnapshot(`
-        {
-          "bindValues": [
-            1,
-          ],
-          "query": "SELECT id, text FROM 'todos' WHERE completed = ?",
-        }
-      `)
-      expect(db.todos.select('id', 'text').where('completed', '!=', true).asSql()).toMatchInlineSnapshot(`
-        {
-          "bindValues": [
-            1,
-          ],
-          "query": "SELECT id, text FROM 'todos' WHERE completed != ?",
-        }
-      `)
-      expect(db.todos.select('id', 'text').where({ completed: true }).asSql()).toMatchInlineSnapshot(`
-        {
-          "bindValues": [
-            1,
-          ],
-          "query": "SELECT id, text FROM 'todos' WHERE completed = ?",
-        }
-      `)
-      expect(db.todos.select('id', 'text').where({ completed: undefined }).asSql()).toMatchInlineSnapshot(`
-        {
-          "bindValues": [],
-          "query": "SELECT id, text FROM 'todos'",
-        }
-      `)
-      expect(
-        db.todos
-          .select('id', 'text')
-          .where({ deletedAt: { op: '<=', value: new Date('2024-01-01') } })
-          .asSql(),
-      ).toMatchInlineSnapshot(`
-        {
-          "bindValues": [
-            "2024-01-01T00:00:00.000Z",
-          ],
-          "query": "SELECT id, text FROM 'todos' WHERE deletedAt <= ?",
-        }
-      `)
-      expect(
-        db.todos
-          .select('id', 'text')
-          .where({ status: { op: 'IN', value: ['active'] } })
-          .asSql(),
-      ).toMatchInlineSnapshot(`
-        {
-          "bindValues": [
-            "active",
-          ],
-          "query": "SELECT id, text FROM 'todos' WHERE status IN (?)",
-        }
-      `)
-      expect(
-        db.todos
-          .select('id', 'text')
-          .where({ status: { op: 'NOT IN', value: ['active', 'completed'] } })
-          .asSql(),
-      ).toMatchInlineSnapshot(`
-        {
-          "bindValues": [
-            "active",
-            "completed",
-          ],
-          "query": "SELECT id, text FROM 'todos' WHERE status NOT IN (?, ?)",
-        }
-      `)
-    })
-
-    it('should handle OFFSET and LIMIT clauses', () => {
-      expect(db.todos.select('id', 'text').where('completed', true).offset(10).limit(10).asSql())
-        .toMatchInlineSnapshot(`
-          {
-            "bindValues": [
-              1,
-              10,
-              10,
-            ],
-            "query": "SELECT id, text FROM 'todos' WHERE completed = ? OFFSET ? LIMIT ?",
-          }
-        `)
-    })
-
-    it('should handle COUNT queries', () => {
-      expect(db.todos.count().asSql()).toMatchInlineSnapshot(`
-        {
-          "bindValues": [],
-          "query": "SELECT COUNT(*) as count FROM 'todos'",
-        }
-      `)
-      expect(db.todos.count().where('completed', true).asSql()).toMatchInlineSnapshot(`
-        {
-          "bindValues": [
-            1,
-          ],
-          "query": "SELECT COUNT(*) as count FROM 'todos' WHERE completed = ?",
-        }
-      `)
-    })
-
-    it('should handle NULL comparisons', () => {
-      expect(db.todos.select('id', 'text').where('deletedAt', '=', null).asSql()).toMatchInlineSnapshot(`
-        {
-          "bindValues": [],
-          "query": "SELECT id, text FROM 'todos' WHERE deletedAt IS NULL",
-        }
-      `)
-      expect(db.todos.select('id', 'text').where('deletedAt', '!=', null).asSql()).toMatchInlineSnapshot(`
-        {
-          "bindValues": [],
-          "query": "SELECT id, text FROM 'todos' WHERE deletedAt IS NOT NULL",
-        }
-      `)
-    })
-
-    it('should handle orderBy', () => {
-      expect(db.todos.orderBy('completed', 'desc').asSql()).toMatchInlineSnapshot(`
-        {
-          "bindValues": [],
-          "query": "SELECT * FROM 'todos' ORDER BY completed desc",
-        }
-      `)
-
-      expect(db.todos.orderBy([{ col: 'completed', direction: 'desc' }]).asSql()).toMatchInlineSnapshot(`
-        {
-          "bindValues": [],
-          "query": "SELECT * FROM 'todos' ORDER BY completed desc",
-        }
-      `)
-
-      expect(db.todos.orderBy([]).asSql()).toMatchInlineSnapshot(`
-        {
-          "bindValues": [],
-          "query": "SELECT * FROM 'todos'",
-        }
-      `)
-    })
-  })
-
-  describe('row queries', () => {
-    it('should handle row queries', () => {
-      expect(db.todos.row('123', { insertValues: { status: 'completed' } }).asSql()).toMatchInlineSnapshot(`
-        {
-          "bindValues": [
-            "123",
-          ],
-          "query": "SELECT * FROM 'todos' WHERE id = ?",
-        }
-      `)
-    })
-  })
-})
-
-// TODO nested queries
-// const rawSql = <A, I>(sql: string, params: { [key: string]: any }, schema: Schema.Schema<A, I>) =>
-//   ({
-//     sql,
-//     params,
-//     schema,
-//   }) as any as QueryBuilder<A, any>
-
-// Translates to
-// SELECT todos.*, (SELECT COUNT(*) FROM comments WHERE comments.todoId = todos.id) AS commentsCount
-// FROM todos WHERE todos.completed = true
-// const q4CommentsCountSchema = Schema.Struct({ count: Schema.Number }).pipe(
-//   Schema.pluck('count'),
-//   Schema.Array,
-//   Schema.headOrElse(),
-// )
-// const _q4$ = db.todos
-//   .select({
-//     commentsCount: (ref) =>
-//       rawSql(
-//         sql`SELECT COUNT(*) as count FROM comments WHERE comments.todoId = $todoId`,
-//         { todoId: ref },
-//         q4CommentsCountSchema,
-//       ),
-//   })
-//   .where({ completed: true })
-
-// const _q5$ = db.todos
-//   .select({ commentsCount: (todoId: TODO) => comments.query.where({ todoId }).count() })
-//   .where({ completed: true })

package/src/query-builder/impl.ts

@@ -1,285 +0,0 @@
-import { Option, Predicate, Schema } from '@livestore/utils/effect'
-
-import type { QueryInfo } from '../query-info.js'
-import type { DbSchema } from '../schema/mod.js'
-import type { QueryBuilder, QueryBuilderAst } from './api.js'
-import { QueryBuilderAstSymbol, TypeId } from './api.js'
-
-export const makeQueryBuilder = <TResult, TTableDef extends DbSchema.TableDefBase>(
-  tableDef: TTableDef,
-  ast: QueryBuilderAst = emptyAst(tableDef),
-): QueryBuilder<TResult, TTableDef, never, QueryInfo.None> => {
-  const api = {
-    // eslint-disable-next-line prefer-arrow/prefer-arrow-functions
-    select() {
-      assertQueryBuilderAst(ast)
-
-      // eslint-disable-next-line prefer-rest-params
-      const params = [...arguments]
-
-      if (params.length === 2 && typeof params[0] === 'string' && typeof params[1] === 'object') {
-        const [col, options] = params as any as [string, { pluck: boolean }]
-        return makeQueryBuilder(tableDef, {
-          ...ast,
-          resultSchemaSingle: options.pluck ? ast.resultSchemaSingle.pipe(Schema.pluck(col)) : ast.resultSchemaSingle,
-          select: { columns: [col] },
-        })
-      }
-
-      const columns = params as unknown as ReadonlyArray<string>
-
-      return makeQueryBuilder(tableDef, {
-        ...ast,
-        resultSchemaSingle:
-          columns.length === 0 ? ast.resultSchemaSingle : ast.resultSchemaSingle.pipe(Schema.pick(...columns)),
-        select: { columns },
-      }) as any
-    },
-    // eslint-disable-next-line prefer-arrow/prefer-arrow-functions
-    where() {
-      if (isRowQuery(ast)) return invalidQueryBuilder()
-
-      if (arguments.length === 1) {
-        // eslint-disable-next-line prefer-rest-params
-        const params = arguments[0]
-        const newOps = Object.entries(params)
-          .filter(([, value]) => value !== undefined)
-          .map<QueryBuilderAst.Where>(([col, value]) =>
-            Predicate.hasProperty(value, 'op') && Predicate.hasProperty(value, 'value')
-              ? ({ col, op: value.op, value: value.value } as any)
-              : { col, op: '=', value },
-          )
-
-        return makeQueryBuilder(tableDef, {
-          ...ast,
-          where: [...ast.where, ...newOps],
-        }) as any
-      }
-
-      // eslint-disable-next-line prefer-rest-params
-      const [col, opOrValue, valueOrUndefined] = arguments
-      const op = valueOrUndefined === undefined ? '=' : opOrValue
-      const value = valueOrUndefined === undefined ? opOrValue : valueOrUndefined
-      return makeQueryBuilder(tableDef, {
-        ...ast,
-        where: [...ast.where, { col, op, value }],
-      })
-    },
-    // eslint-disable-next-line prefer-arrow/prefer-arrow-functions
-    orderBy() {
-      assertQueryBuilderAst(ast)
-
-      if (arguments.length === 0 || arguments.length > 2) return invalidQueryBuilder()
-
-      if (arguments.length === 1) {
-        // eslint-disable-next-line prefer-rest-params
-        const params = arguments[0] as QueryBuilder.OrderByParams<TTableDef>
-        return makeQueryBuilder(tableDef, {
-          ...ast,
-          orderBy: [...ast.orderBy, ...params],
-        })
-      }
-
-      // eslint-disable-next-line prefer-rest-params
-      const [col, direction] = arguments as any as [keyof TTableDef['sqliteDef']['columns'] & string, 'asc' | 'desc']
-
-      return makeQueryBuilder(tableDef, {
-        ...ast,
-        orderBy: [...ast.orderBy, { col, direction }],
-      }) as any
-    },
-    limit: (limit) => {
-      assertQueryBuilderAst(ast)
-
-      return makeQueryBuilder(tableDef, { ...ast, limit: Option.some(limit) })
-    },
-    offset: (offset) => {
-      assertQueryBuilderAst(ast)
-
-      return makeQueryBuilder(tableDef, { ...ast, offset: Option.some(offset) })
-    },
-    count: () => {
-      if (isRowQuery(ast)) return invalidQueryBuilder()
-
-      return makeQueryBuilder(tableDef, {
-        ...ast,
-        resultSchema: Schema.Struct({ count: Schema.Number }).pipe(
-          Schema.pluck('count'),
-          Schema.Array,
-          Schema.headOrElse(),
-        ),
-        _tag: 'CountQuery',
-      })
-    },
-    first: (options) => {
-      assertQueryBuilderAst(ast)
-
-      if (ast.limit._tag === 'Some') return invalidQueryBuilder(`.first() can't be called after .limit()`)
-
-      return makeQueryBuilder(tableDef, {
-        ...ast,
-        limit: Option.some(1),
-        // TODO improve
-        pickFirst: options?.fallback ? { fallback: options.fallback } : { fallback: () => undefined },
-      })
-    },
-    // eslint-disable-next-line prefer-arrow/prefer-arrow-functions
-    row() {
-      // eslint-disable-next-line prefer-rest-params
-      const params = [...arguments]
-
-      let id: string
-
-      if (tableDef.options.isSingleton) {
-        id = tableDef.sqliteDef.columns.id!.default.pipe(Option.getOrThrow)
-      } else {
-        id = params[0] as string
-        if (id === undefined) {
-          invalidQueryBuilder(`Id missing for row query on non-singleton table ${tableDef.sqliteDef.name}`)
-        }
-      }
-
-      // TODO validate all required columns are present and values are matching the schema
-      const insertValues: Record<string, unknown> = params[1]?.insertValues ?? {}
-
-      return makeQueryBuilder(tableDef, {
-        _tag: 'RowQuery',
-        id,
-        tableDef,
-        insertValues,
-      }) as any
-    },
-  } satisfies QueryBuilder.ApiFull<TResult, TTableDef, never, QueryInfo.None>
-
-  return {
-    [TypeId]: TypeId,
-    [QueryBuilderAstSymbol]: ast,
-    asSql: () => astToSql(ast),
-    toString: () => {
-      try {
-        return astToSql(ast).query
-      } catch (cause) {
-        console.debug(`QueryBuilder.toString(): Error converting query builder to string`, cause, ast)
-        return `Error converting query builder to string`
-      }
-    },
-    ...api,
-  } satisfies QueryBuilder<TResult, TTableDef>
-}
-
-const emptyAst = (tableDef: DbSchema.TableDefBase) =>
-  ({
-    _tag: 'SelectQuery',
-    columns: [],
-    pickFirst: false,
-    select: { columns: [] },
-    orderBy: [],
-    offset: Option.none(),
-    limit: Option.none(),
-    tableDef,
-    where: [],
-    resultSchemaSingle: tableDef.schema,
-  }) satisfies QueryBuilderAst
-
-const astToSql = (ast: QueryBuilderAst) => {
-  if (isRowQuery(ast)) {
-    // TODO
-    return { query: `SELECT * FROM '${ast.tableDef.sqliteDef.name}' WHERE id = ?`, bindValues: [ast.id as TODO] }
-  }
-
-  const bindValues: unknown[] = []
-
-  // TODO bind values
-  const whereStmt =
-    ast.where.length > 0
-      ? `WHERE ${ast.where
-          .map(({ col, op, value }) => {
-            if (value === null) {
-              if (op !== '=' && op !== '!=') {
-                throw new Error(`Unsupported operator for NULL value: ${op}`)
-              }
-              const opStmt = op === '=' ? 'IS' : 'IS NOT'
-              return `${col} ${opStmt} NULL`
-            } else {
-              const colDef = ast.tableDef.sqliteDef.columns[col]
-              if (colDef === undefined) {
-                throw new Error(`Column ${col} not found`)
-              }
-              const isArray = op === 'IN' || op === 'NOT IN'
-              const colSchema = isArray ? Schema.Array(colDef.schema) : colDef.schema
-              const encodedValue = Schema.encodeSync(colSchema)(value)
-
-              if (isArray) {
-                bindValues.push(...encodedValue)
-                const placeholders = Array.from({ length: encodedValue.length }, () => '?').join(', ')
-                return `${col} ${op} (${placeholders})`
-              } else {
-                bindValues.push(encodedValue)
-                return `${col} ${op} ?`
-              }
-            }
-          })
-          .join(' AND ')}`
-      : ''
-
-  if (ast._tag === 'CountQuery') {
-    const selectFromStmt = `SELECT COUNT(*) as count FROM '${ast.tableDef.sqliteDef.name}'`
-    const query = [selectFromStmt, whereStmt].filter((_) => _.length > 0).join(' ')
-    return { query, bindValues }
-  }
-  const columnsStmt = ast.select.columns.length === 0 ? '*' : ast.select.columns.join(', ')
-  const selectStmt = `SELECT ${columnsStmt}`
-  const fromStmt = `FROM '${ast.tableDef.sqliteDef.name}'`
-
-  const orderByStmt =
-    ast.orderBy.length > 0
-      ? `ORDER BY ${ast.orderBy.map(({ col, direction }) => `${col} ${direction}`).join(', ')}`
-      : ''
-
-  const limitStmt = ast.limit._tag === 'Some' ? `LIMIT ?` : ''
-  if (ast.limit._tag === 'Some') bindValues.push(ast.limit.value)
-
-  const offsetStmt = ast.offset._tag === 'Some' ? `OFFSET ?` : ''
-  if (ast.offset._tag === 'Some') bindValues.push(ast.offset.value)
-
-  const query = [selectStmt, fromStmt, whereStmt, orderByStmt, offsetStmt, limitStmt]
-    .map((_) => _.trim())
-    .filter((_) => _.length > 0)
-    .join(' ')
-
-  // TODO bind values
-  return { query, bindValues }
-}
-
-// eslint-disable-next-line prefer-arrow/prefer-arrow-functions
-function assertQueryBuilderAst(ast: QueryBuilderAst): asserts ast is QueryBuilderAst.SelectQuery {
-  if (ast._tag !== 'SelectQuery') {
-    throw new Error('Expected SelectQuery but got ' + ast._tag)
-  }
-}
-
-const isRowQuery = (ast: QueryBuilderAst): ast is QueryBuilderAst.RowQuery => ast._tag === 'RowQuery'
-
-export const invalidQueryBuilder = (msg?: string) => {
-  throw new Error('Invalid query builder' + (msg ? `: ${msg}` : ''))
-}
-
-export const getResultSchema = (qb: QueryBuilder<any, any, any>) => {
-  const queryAst = qb[QueryBuilderAstSymbol]
-  if (queryAst._tag === 'SelectQuery') {
-    const arraySchema = Schema.Array(queryAst.resultSchemaSingle)
-    if (queryAst.pickFirst !== false) {
-      return arraySchema.pipe(Schema.headOrElse(queryAst.pickFirst.fallback))
-    }
-
-    return arraySchema
-  } else if (queryAst._tag === 'CountQuery') {
-    return Schema.Struct({ count: Schema.Number }).pipe(Schema.pluck('count'), Schema.Array, Schema.headOrElse())
-  } else {
-    if (queryAst.tableDef.options.isSingleColumn) {
-      return queryAst.tableDef.schema.pipe(Schema.pluck('value'), Schema.Array, Schema.headOrElse())
-    } else {
-      return queryAst.tableDef.schema.pipe(Schema.Array, Schema.headOrElse())
-    }
-  }
-}

package/src/query-info.ts

@@ -1,78 +0,0 @@
-import type { SessionIdSymbol } from './adapter-types.js'
-import type { DbSchema } from './schema/mod.js'
-
-/**
- * Semantic information about a query with supported cases being:
- * - a whole row
- * - a single column value
- * - a sub value in a JSON column
- *
- * This information is currently only used for derived mutations.
- */
-export type QueryInfo = QueryInfo.None | QueryInfo.Row | QueryInfo.Col | QueryInfo.ColJsonValue
-// export type QueryInfo<TTableDef extends DbSchema.TableDefBase = DbSchema.TableDefBase> =
-// | QueryInfo.None
-// | QueryInfo.Row<TTableDef>
-// | QueryInfo.ColJsonValue<TTableDef, GetJsonColumn<TTableDef>>
-// | QueryInfo.Col<TTableDef, keyof TTableDef['sqliteDef']['columns']>
-
-export namespace QueryInfo {
-  export type None = {
-    _tag: 'None'
-  }
-
-  export type Row = {
-    _tag: 'Row'
-    table: DbSchema.TableDefBase
-    id: string | SessionIdSymbol
-  }
-
-  export type Col = {
-    _tag: 'Col'
-    table: DbSchema.TableDefBase
-    id: string | SessionIdSymbol
-    column: string
-  }
-
-  export type ColJsonValue = {
-    _tag: 'ColJsonValue'
-    table: DbSchema.TableDefBase
-    id: string | SessionIdSymbol
-    column: string
-    /**
-     * example: `$.tabs[3].items[2]` (`$` referring to the column value)
-     */
-    jsonPath: string
-  }
-
-  // NOTE maybe we want to bring back type-params back like below
-  // export type Row<TTableDef extends DbSchema.TableDefBase> = {
-  //   _tag: 'Row'
-  //   table: TTableDef
-  //   id: string | SessionIdSymbol
-  // }
-
-  // export type Col<TTableDef extends DbSchema.TableDefBase, TColName extends keyof TTableDef['sqliteDef']['columns']> = {
-  //   _tag: 'Col'
-  //   table: TTableDef
-  //   id: string | SessionIdSymbol
-  //   column: TColName
-  // }
-
-  // export type ColJsonValue<TTableDef extends DbSchema.TableDefBase, TColName extends GetJsonColumn<TTableDef>> = {
-  //   _tag: 'ColJsonValue'
-  //   table: TTableDef
-  //   id: string | SessionIdSymbol
-  //   column: TColName
-  //   /**
-  //    * example: `$.tabs[3].items[2]` (`$` referring to the column value)
-  //    */
-  //   jsonPath: string
-  // }
-}
-
-// type GetJsonColumn<TTableDef extends DbSchema.TableDefBase> = keyof {
-//   [ColName in keyof TTableDef['sqliteDef']['columns'] as TTableDef['sqliteDef']['columns'][ColName]['columnType'] extends 'text'
-//     ? ColName
-//     : never]: {}
-// }