@expressive/sql 0.11.0 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1 @@
1
- {"version":3,"file":"engine.js","names":[],"sources":["../../src/sqlite/engine.ts"],"sourcesContent":["import { missing, optional } from './load';\n\n/**\n * A SQLite host - what `SQLiteConnection` runs statements on.\n *\n * Pass one in place of a filename for a SQLite the built-in loader cannot open.\n * It is used as given - foreign keys are not switched on, and the connection's `close()` leaves it open.\n */\nexport interface Engine extends Engine.Statements {\n /** Release the database. Called only on an engine the connection opened. */\n close(): Promise<void>;\n /**\n * Open a transaction on its own session.\n *\n * Without it the connection issues `BEGIN`, `COMMIT` and `ROLLBACK` through `exec`.\n */\n transaction?(): Promise<Engine.Session>;\n /**\n * Run statements atomically.\n *\n * `sync` applies through it when present; a table rebuild then needs foreign keys off.\n */\n batch?(sql: string[]): Promise<void>;\n}\n\nexport declare namespace Engine {\n /** Statement methods an engine and a session share. Parameters are positional. */\n interface Statements {\n /** Run a statement, resolving every row. */\n all(sql: string, params?: any[]): Promise<any[]>;\n /** Run a statement, resolving the first row. */\n get(sql: string, params?: any[]): Promise<any>;\n /** Run a statement, resolving how many rows changed. */\n run(sql: string, params?: any[]): Promise<{ changes: number }>;\n /** Run one or more statements without parameters. */\n exec(sql: string): Promise<void>;\n }\n\n /** A transaction's own handle - statements inside `db.transaction(fn)` run on it. */\n interface Session extends Statements {\n commit(): Promise<void>;\n rollback(): Promise<void>;\n }\n}\n\nconst DRIVERS = [bunSqlite, nodeSqlite, betterSqlite3, sqlite3, libsql];\n\nconst REMOTE = /^(libsql|https?|wss?):\\/\\//;\n\nexport async function createEngine(filename: string): Promise<Engine> {\n if (REMOTE.test(filename))\n return libsql(filename, filename);\n\n for (const load of DRIVERS) {\n const engine = await load(filename).catch(() => null);\n\n if (engine) {\n await engine.exec(\"PRAGMA foreign_keys = ON\");\n return engine;\n }\n }\n\n throw new Error(missing);\n}\n\nasync function bunSqlite(file: string): Promise<Engine | null> {\n if (typeof (globalThis as any).Bun === \"undefined\")\n return null;\n\n const { Database } = await optional(\"bun:sqlite\");\n\n return syncEngine(new Database(file));\n}\n\nasync function nodeSqlite(file: string): Promise<Engine | null> {\n const { DatabaseSync } = await optional(\"node:sqlite\");\n\n return syncEngine(new DatabaseSync(file));\n}\n\nasync function betterSqlite3(file: string): Promise<Engine | null> {\n const { default: Database } = await optional(\"better-sqlite3\");\n\n return syncEngine(new Database(file));\n}\n\nasync function sqlite3(file: string): Promise<Engine | null> {\n const { default: { Database } } = await optional(\"sqlite3\");\n\n return asyncEngine(new Database(file));\n}\n\nasync function libsql(file: string, url = file === \":memory:\" ? file : `file:${file}`): Promise<Engine> {\n const { createClient } = await optional(\"@libsql/client\");\n\n return libsqlEngine(createClient({ url }));\n}\n\nfunction syncEngine(db: any): Engine {\n return {\n async all(sql, params = []) {\n return db.prepare(sql).all(...params);\n },\n async get(sql, params = []) {\n return db.prepare(sql).get(...params);\n },\n async run(sql, params = []) {\n return { changes: db.prepare(sql).run(...params).changes };\n },\n async exec(sql) {\n db.exec(sql);\n },\n async close() {\n db.close();\n }\n };\n}\n\nfunction asyncEngine(db: any): Engine {\n const call = (method: string, sql: string, params: any[]) =>\n new Promise<any>((resolve, reject) => {\n db[method](sql, params, function (this: any, err: any, rows: any) {\n if (err) reject(err);\n else resolve(method === \"run\" ? this : rows);\n });\n });\n\n const done = (resolve: () => void, reject: (err: any) => void) =>\n (err: any) => err ? reject(err) : resolve();\n\n return {\n all: (sql, params = []) => call(\"all\", sql, params),\n get: (sql, params = []) => call(\"get\", sql, params),\n run: (sql, params = []) => call(\"run\", sql, params).then(ctx => ({ changes: ctx.changes })),\n exec: sql => new Promise((resolve, reject) => db.exec(sql, done(resolve, reject))),\n close: () => new Promise((resolve, reject) => db.close(done(resolve, reject)))\n };\n}\n\nexport function host(source: Engine | D1Database | LibSQLClient): Engine {\n const has = (key: string) => source && typeof source == \"object\" && key in source;\n\n if (has(\"all\"))\n return source as Engine;\n\n if (has(\"execute\"))\n return libsqlEngine(source as LibSQLClient);\n\n if (has(\"prepare\") && has(\"batch\"))\n return d1Engine(source as D1Database);\n\n throw new TypeError(\"Unknown SQLite source. Pass a filename, a libSQL address, a D1 binding, a libSQL client or an Engine.\");\n}\n\nexport const migrations = new WeakMap<Engine, (sql: string[]) => Promise<unknown>>();\n\n/** A libSQL client from `@libsql/client` 0.18 or later - local, Turso or any libSQL server. */\nexport interface LibSQLClient extends LibSQLStatements {\n batch(sql: string[], mode: \"write\"): Promise<unknown>;\n migrate(sql: string[]): Promise<unknown>;\n transaction(mode: \"write\"): Promise<LibSQLStatements & { commit(): Promise<void>; rollback(): Promise<void> }>;\n close(): void;\n}\n\ninterface LibSQLStatements {\n execute(statement: { sql: string, args: any[] }): Promise<{ rows: any[], rowsAffected: number }>;\n executeMultiple(sql: string): Promise<void>;\n}\n\nfunction libsqlEngine(client: LibSQLClient): Engine {\n const engine: Engine = {\n ...libsqlStatements(client),\n async batch(sql) {\n await client.batch(sql, \"write\");\n },\n async transaction() {\n const tx = await client.transaction(\"write\");\n\n return {\n ...libsqlStatements(tx),\n commit: () => tx.commit(),\n rollback: () => tx.rollback()\n };\n },\n async close() {\n client.close();\n }\n };\n\n migrations.set(engine, sql => client.migrate(sql));\n\n return engine;\n}\n\nfunction libsqlStatements(client: LibSQLStatements): Engine.Statements {\n const execute = (sql: string, args: any[]) => client.execute({ sql, args });\n\n return {\n async all(sql, params = []) {\n return (await execute(sql, params)).rows;\n },\n async get(sql, params = []) {\n return (await execute(sql, params)).rows[0];\n },\n async run(sql, params = []) {\n return { changes: Number((await execute(sql, params)).rowsAffected) };\n },\n async exec(sql) {\n await client.executeMultiple(sql);\n }\n };\n}\n\n/** A Cloudflare D1 binding, such as a Worker's `env.DB`. */\nexport interface D1Database {\n prepare(sql: string): D1Statement;\n batch(statements: D1Statement[]): Promise<unknown>;\n}\n\ninterface D1Statement {\n bind(...values: any[]): D1Statement;\n all(): Promise<{ results: any[] }>;\n first(): Promise<any>;\n run(): Promise<{ meta: { changes: number } }>;\n}\n\nfunction d1Engine(db: D1Database): Engine {\n const statement = (sql: string, params: any[] = []) => db.prepare(sql).bind(...params);\n\n return {\n async all(sql, params) {\n return (await statement(sql, params).all()).results;\n },\n async get(sql, params) {\n return await statement(sql, params).first() ?? undefined;\n },\n async run(sql, params) {\n return { changes: (await statement(sql, params).run()).meta.changes };\n },\n async exec(sql) {\n await db.prepare(sql).run();\n },\n async batch(sql) {\n await db.batch(sql.map(sql => db.prepare(sql)));\n },\n async transaction(): Promise<never> {\n throw new Error(\"D1 has no interactive transactions.\");\n },\n async close() {}\n };\n}\n"],"mappings":";;;AA6CA,MAAM,UAAU;CAAC;CAAW;CAAY;CAAe;CAAS;CAAO;AAEvE,MAAM,SAAS;AAEf,eAAsB,aAAa,UAAmC;AACpE,KAAI,OAAO,KAAK,SAAS,CACvB,QAAO,OAAO,UAAU,SAAS;AAEnC,MAAK,MAAM,QAAQ,SAAS;EAC1B,MAAM,SAAS,MAAM,KAAK,SAAS,CAAC,YAAY,KAAK;AAErD,MAAI,QAAQ;AACV,SAAM,OAAO,KAAK,2BAA2B;AAC7C,UAAO;;;AAIX,OAAM,IAAI,MAAM,QAAQ;;AAG1B,eAAe,UAAU,MAAsC;AAC7D,KAAI,OAAQ,WAAmB,QAAQ,YACrC,QAAO;CAET,MAAM,EAAE,aAAa,MAAM,SAAS,aAAa;AAEjD,QAAO,WAAW,IAAI,SAAS,KAAK,CAAC;;AAGvC,eAAe,WAAW,MAAsC;CAC9D,MAAM,EAAE,iBAAiB,MAAM,SAAS,cAAc;AAEtD,QAAO,WAAW,IAAI,aAAa,KAAK,CAAC;;AAG3C,eAAe,cAAc,MAAsC;CACjE,MAAM,EAAE,SAAS,aAAa,MAAM,SAAS,iBAAiB;AAE9D,QAAO,WAAW,IAAI,SAAS,KAAK,CAAC;;AAGvC,eAAe,QAAQ,MAAsC;CAC3D,MAAM,EAAE,SAAS,EAAE,eAAe,MAAM,SAAS,UAAU;AAE3D,QAAO,YAAY,IAAI,SAAS,KAAK,CAAC;;AAGxC,eAAe,OAAO,MAAc,MAAM,SAAS,aAAa,OAAO,QAAQ,QAAyB;CACtG,MAAM,EAAE,iBAAiB,MAAM,SAAS,iBAAiB;AAEzD,QAAO,aAAa,aAAa,EAAE,KAAK,CAAC,CAAC;;AAG5C,SAAS,WAAW,IAAiB;AACnC,QAAO;EACL,MAAM,IAAI,KAAK,SAAS,EAAE,EAAE;AAC1B,UAAO,GAAG,QAAQ,IAAI,CAAC,IAAI,GAAG,OAAO;;EAEvC,MAAM,IAAI,KAAK,SAAS,EAAE,EAAE;AAC1B,UAAO,GAAG,QAAQ,IAAI,CAAC,IAAI,GAAG,OAAO;;EAEvC,MAAM,IAAI,KAAK,SAAS,EAAE,EAAE;AAC1B,UAAO,EAAE,SAAS,GAAG,QAAQ,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,SAAS;;EAE5D,MAAM,KAAK,KAAK;AACd,MAAG,KAAK,IAAI;;EAEd,MAAM,QAAQ;AACZ,MAAG,OAAO;;EAEb;;AAGH,SAAS,YAAY,IAAiB;CACpC,MAAM,QAAQ,QAAgB,KAAa,WACzC,IAAI,SAAc,SAAS,WAAW;AACpC,KAAG,QAAQ,KAAK,QAAQ,SAAqB,KAAU,MAAW;AAChE,OAAI,IAAK,QAAO,IAAI;OACf,SAAQ,WAAW,QAAQ,OAAO,KAAK;IAC5C;GACF;CAEJ,MAAM,QAAQ,SAAqB,YAChC,QAAa,MAAM,OAAO,IAAI,GAAG,SAAS;AAE7C,QAAO;EACL,MAAM,KAAK,SAAS,EAAE,KAAK,KAAK,OAAO,KAAK,OAAO;EACnD,MAAM,KAAK,SAAS,EAAE,KAAK,KAAK,OAAO,KAAK,OAAO;EACnD,MAAM,KAAK,SAAS,EAAE,KAAK,KAAK,OAAO,KAAK,OAAO,CAAC,MAAK,SAAQ,EAAE,SAAS,IAAI,SAAS,EAAE;EAC3F,OAAM,QAAO,IAAI,SAAS,SAAS,WAAW,GAAG,KAAK,KAAK,KAAK,SAAS,OAAO,CAAC,CAAC;EAClF,aAAa,IAAI,SAAS,SAAS,WAAW,GAAG,MAAM,KAAK,SAAS,OAAO,CAAC,CAAC;EAC/E;;AAGH,SAAgB,KAAK,QAAoD;CACvE,MAAM,OAAO,QAAgB,UAAU,OAAO,UAAU,YAAY,OAAO;AAE3E,KAAI,IAAI,MAAM,CACZ,QAAO;AAET,KAAI,IAAI,UAAU,CAChB,QAAO,aAAa,OAAuB;AAE7C,KAAI,IAAI,UAAU,IAAI,IAAI,QAAQ,CAChC,QAAO,SAAS,OAAqB;AAEvC,OAAM,IAAI,UAAU,wGAAwG;;AAG9H,MAAa,6BAAa,IAAI,SAAsD;AAepF,SAAS,aAAa,QAA8B;CAClD,MAAM,SAAiB;EACrB,GAAG,iBAAiB,OAAO;EAC3B,MAAM,MAAM,KAAK;AACf,SAAM,OAAO,MAAM,KAAK,QAAQ;;EAElC,MAAM,cAAc;GAClB,MAAM,KAAK,MAAM,OAAO,YAAY,QAAQ;AAE5C,UAAO;IACL,GAAG,iBAAiB,GAAG;IACvB,cAAc,GAAG,QAAQ;IACzB,gBAAgB,GAAG,UAAU;IAC9B;;EAEH,MAAM,QAAQ;AACZ,UAAO,OAAO;;EAEjB;AAED,YAAW,IAAI,SAAQ,QAAO,OAAO,QAAQ,IAAI,CAAC;AAElD,QAAO;;AAGT,SAAS,iBAAiB,QAA6C;CACrE,MAAM,WAAW,KAAa,SAAgB,OAAO,QAAQ;EAAE;EAAK;EAAM,CAAC;AAE3E,QAAO;EACL,MAAM,IAAI,KAAK,SAAS,EAAE,EAAE;AAC1B,WAAQ,MAAM,QAAQ,KAAK,OAAO,EAAE;;EAEtC,MAAM,IAAI,KAAK,SAAS,EAAE,EAAE;AAC1B,WAAQ,MAAM,QAAQ,KAAK,OAAO,EAAE,KAAK;;EAE3C,MAAM,IAAI,KAAK,SAAS,EAAE,EAAE;AAC1B,UAAO,EAAE,SAAS,QAAQ,MAAM,QAAQ,KAAK,OAAO,EAAE,aAAa,EAAE;;EAEvE,MAAM,KAAK,KAAK;AACd,SAAM,OAAO,gBAAgB,IAAI;;EAEpC;;AAgBH,SAAS,SAAS,IAAwB;CACxC,MAAM,aAAa,KAAa,SAAgB,EAAE,KAAK,GAAG,QAAQ,IAAI,CAAC,KAAK,GAAG,OAAO;AAEtF,QAAO;EACL,MAAM,IAAI,KAAK,QAAQ;AACrB,WAAQ,MAAM,UAAU,KAAK,OAAO,CAAC,KAAK,EAAE;;EAE9C,MAAM,IAAI,KAAK,QAAQ;AACrB,UAAO,MAAM,UAAU,KAAK,OAAO,CAAC,OAAO,IAAI;;EAEjD,MAAM,IAAI,KAAK,QAAQ;AACrB,UAAO,EAAE,UAAU,MAAM,UAAU,KAAK,OAAO,CAAC,KAAK,EAAE,KAAK,SAAS;;EAEvE,MAAM,KAAK,KAAK;AACd,SAAM,GAAG,QAAQ,IAAI,CAAC,KAAK;;EAE7B,MAAM,MAAM,KAAK;AACf,SAAM,GAAG,MAAM,IAAI,KAAI,QAAO,GAAG,QAAQ,IAAI,CAAC,CAAC;;EAEjD,MAAM,cAA8B;AAClC,SAAM,IAAI,MAAM,sCAAsC;;EAExD,MAAM,QAAQ;EACf"}
1
+ {"version":3,"file":"engine.js","names":[],"sources":["../../src/sqlite/engine.ts"],"sourcesContent":["import { missing, optional } from './load';\n\n/**\n * A SQLite host - what `SQLiteConnection` runs statements on.\n *\n * Pass one as `{ source }` for a SQLite the built-in loader cannot open, or as a session's client.\n * It is used as given - foreign keys are not switched on, and the connection's `close()` leaves it open.\n */\nexport interface Engine extends Engine.Statements {\n /** Release the database. Called only on an engine the connection opened. */\n close(): Promise<void>;\n /**\n * Open a transaction on its own session.\n *\n * Without it the connection issues `BEGIN`, `COMMIT` and `ROLLBACK` through `exec`.\n */\n transaction?(): Promise<Engine.Session>;\n /**\n * Run statements atomically.\n *\n * `sync` applies through it when present; a table rebuild then needs foreign keys off.\n */\n batch?(sql: string[]): Promise<void>;\n}\n\nexport declare namespace Engine {\n /** Statement methods an engine and a session share. Parameters are positional. */\n interface Statements {\n /** Run a statement, resolving every row. */\n all(sql: string, params?: any[]): Promise<any[]>;\n /** Run a statement, resolving the first row. */\n get(sql: string, params?: any[]): Promise<any>;\n /** Run a statement, resolving how many rows changed. */\n run(sql: string, params?: any[]): Promise<{ changes: number }>;\n /** Run one or more statements without parameters. */\n exec(sql: string): Promise<void>;\n }\n\n /** A transaction's own handle - statements inside `db.transaction(fn)` run on it. */\n interface Session extends Statements {\n commit(): Promise<void>;\n rollback(): Promise<void>;\n }\n}\n\nconst DRIVERS = [bunSqlite, nodeSqlite, betterSqlite3, sqlite3, libsql];\n\nconst REMOTE = /^(libsql|https?|wss?):\\/\\//;\n\nexport async function createEngine(filename: string): Promise<Engine> {\n if (REMOTE.test(filename))\n return libsql(filename, filename);\n\n for (const load of DRIVERS) {\n const engine = await load(filename).catch(() => null);\n\n if (engine) {\n await engine.exec(\"PRAGMA foreign_keys = ON\");\n return engine;\n }\n }\n\n throw new Error(missing);\n}\n\nasync function bunSqlite(file: string): Promise<Engine | null> {\n if (typeof (globalThis as any).Bun === \"undefined\")\n return null;\n\n const { Database } = await optional(\"bun:sqlite\");\n\n return syncEngine(new Database(file));\n}\n\nasync function nodeSqlite(file: string): Promise<Engine | null> {\n const { DatabaseSync } = await optional(\"node:sqlite\");\n\n return syncEngine(new DatabaseSync(file));\n}\n\nasync function betterSqlite3(file: string): Promise<Engine | null> {\n const { default: Database } = await optional(\"better-sqlite3\");\n\n return syncEngine(new Database(file));\n}\n\nasync function sqlite3(file: string): Promise<Engine | null> {\n const { default: { Database } } = await optional(\"sqlite3\");\n\n return asyncEngine(new Database(file));\n}\n\nasync function libsql(file: string, url = file === \":memory:\" ? file : `file:${file}`): Promise<Engine> {\n const { createClient } = await optional(\"@libsql/client\");\n\n return libsqlEngine(createClient({ url }));\n}\n\nfunction syncEngine(db: any): Engine {\n return {\n async all(sql, params = []) {\n return db.prepare(sql).all(...params);\n },\n async get(sql, params = []) {\n return db.prepare(sql).get(...params);\n },\n async run(sql, params = []) {\n return { changes: db.prepare(sql).run(...params).changes };\n },\n async exec(sql) {\n db.exec(sql);\n },\n async close() {\n db.close();\n }\n };\n}\n\nfunction asyncEngine(db: any): Engine {\n const call = (method: string, sql: string, params: any[]) =>\n new Promise<any>((resolve, reject) => {\n db[method](sql, params, function (this: any, err: any, rows: any) {\n if (err) reject(err);\n else resolve(method === \"run\" ? this : rows);\n });\n });\n\n const done = (resolve: () => void, reject: (err: any) => void) =>\n (err: any) => err ? reject(err) : resolve();\n\n return {\n all: (sql, params = []) => call(\"all\", sql, params),\n get: (sql, params = []) => call(\"get\", sql, params),\n run: (sql, params = []) => call(\"run\", sql, params).then(ctx => ({ changes: ctx.changes })),\n exec: sql => new Promise((resolve, reject) => db.exec(sql, done(resolve, reject))),\n close: () => new Promise((resolve, reject) => db.close(done(resolve, reject)))\n };\n}\n\nexport function host(source: Engine | D1Database | LibSQLClient): Engine {\n const has = (key: string) => source && typeof source == \"object\" && key in source;\n\n if (has(\"all\"))\n return source as Engine;\n\n if (has(\"execute\"))\n return libsqlEngine(source as LibSQLClient);\n\n if (has(\"prepare\") && has(\"batch\"))\n return d1Engine(source as D1Database);\n\n throw new TypeError(\"Unknown SQLite source - expected a D1 binding, a libSQL client or an Engine.\");\n}\n\nexport const migrations = new WeakMap<Engine, (sql: string[]) => Promise<unknown>>();\n\n/** A libSQL client from `@libsql/client` 0.18 or later - local, Turso or any libSQL server. */\nexport interface LibSQLClient extends LibSQLStatements {\n batch(sql: string[], mode: \"write\"): Promise<unknown>;\n migrate(sql: string[]): Promise<unknown>;\n transaction(mode: \"write\"): Promise<LibSQLStatements & { commit(): Promise<void>; rollback(): Promise<void> }>;\n close(): void;\n}\n\ninterface LibSQLStatements {\n execute(statement: { sql: string, args: any[] }): Promise<{ rows: any[], rowsAffected: number }>;\n executeMultiple(sql: string): Promise<void>;\n}\n\nfunction libsqlEngine(client: LibSQLClient): Engine {\n const engine: Engine = {\n ...libsqlStatements(client),\n async batch(sql) {\n await client.batch(sql, \"write\");\n },\n async transaction() {\n const tx = await client.transaction(\"write\");\n\n return {\n ...libsqlStatements(tx),\n commit: () => tx.commit(),\n rollback: () => tx.rollback()\n };\n },\n async close() {\n client.close();\n }\n };\n\n migrations.set(engine, sql => client.migrate(sql));\n\n return engine;\n}\n\nfunction libsqlStatements(client: LibSQLStatements): Engine.Statements {\n const execute = (sql: string, args: any[]) => client.execute({ sql, args });\n\n return {\n async all(sql, params = []) {\n return (await execute(sql, params)).rows;\n },\n async get(sql, params = []) {\n return (await execute(sql, params)).rows[0];\n },\n async run(sql, params = []) {\n return { changes: Number((await execute(sql, params)).rowsAffected) };\n },\n async exec(sql) {\n await client.executeMultiple(sql);\n }\n };\n}\n\n/** A Cloudflare D1 binding, such as a Worker's `env.DB`. */\nexport interface D1Database {\n prepare(sql: string): D1Statement;\n batch(statements: D1Statement[]): Promise<unknown>;\n}\n\ninterface D1Statement {\n bind(...values: any[]): D1Statement;\n all(): Promise<{ results: any[] }>;\n first(): Promise<any>;\n run(): Promise<{ meta: { changes: number } }>;\n}\n\nfunction d1Engine(db: D1Database): Engine {\n const statement = (sql: string, params: any[] = []) => db.prepare(sql).bind(...params);\n\n return {\n async all(sql, params) {\n return (await statement(sql, params).all()).results;\n },\n async get(sql, params) {\n return await statement(sql, params).first() ?? undefined;\n },\n async run(sql, params) {\n return { changes: (await statement(sql, params).run()).meta.changes };\n },\n async exec(sql) {\n await db.prepare(sql).run();\n },\n async batch(sql) {\n await db.batch(sql.map(sql => db.prepare(sql)));\n },\n async transaction(): Promise<never> {\n throw new Error(\"D1 has no interactive transactions.\");\n },\n async close() {}\n };\n}\n"],"mappings":";;;AA6CA,MAAM,UAAU;CAAC;CAAW;CAAY;CAAe;CAAS;CAAO;AAEvE,MAAM,SAAS;AAEf,eAAsB,aAAa,UAAmC;AACpE,KAAI,OAAO,KAAK,SAAS,CACvB,QAAO,OAAO,UAAU,SAAS;AAEnC,MAAK,MAAM,QAAQ,SAAS;EAC1B,MAAM,SAAS,MAAM,KAAK,SAAS,CAAC,YAAY,KAAK;AAErD,MAAI,QAAQ;AACV,SAAM,OAAO,KAAK,2BAA2B;AAC7C,UAAO;;;AAIX,OAAM,IAAI,MAAM,QAAQ;;AAG1B,eAAe,UAAU,MAAsC;AAC7D,KAAI,OAAQ,WAAmB,QAAQ,YACrC,QAAO;CAET,MAAM,EAAE,aAAa,MAAM,SAAS,aAAa;AAEjD,QAAO,WAAW,IAAI,SAAS,KAAK,CAAC;;AAGvC,eAAe,WAAW,MAAsC;CAC9D,MAAM,EAAE,iBAAiB,MAAM,SAAS,cAAc;AAEtD,QAAO,WAAW,IAAI,aAAa,KAAK,CAAC;;AAG3C,eAAe,cAAc,MAAsC;CACjE,MAAM,EAAE,SAAS,aAAa,MAAM,SAAS,iBAAiB;AAE9D,QAAO,WAAW,IAAI,SAAS,KAAK,CAAC;;AAGvC,eAAe,QAAQ,MAAsC;CAC3D,MAAM,EAAE,SAAS,EAAE,eAAe,MAAM,SAAS,UAAU;AAE3D,QAAO,YAAY,IAAI,SAAS,KAAK,CAAC;;AAGxC,eAAe,OAAO,MAAc,MAAM,SAAS,aAAa,OAAO,QAAQ,QAAyB;CACtG,MAAM,EAAE,iBAAiB,MAAM,SAAS,iBAAiB;AAEzD,QAAO,aAAa,aAAa,EAAE,KAAK,CAAC,CAAC;;AAG5C,SAAS,WAAW,IAAiB;AACnC,QAAO;EACL,MAAM,IAAI,KAAK,SAAS,EAAE,EAAE;AAC1B,UAAO,GAAG,QAAQ,IAAI,CAAC,IAAI,GAAG,OAAO;;EAEvC,MAAM,IAAI,KAAK,SAAS,EAAE,EAAE;AAC1B,UAAO,GAAG,QAAQ,IAAI,CAAC,IAAI,GAAG,OAAO;;EAEvC,MAAM,IAAI,KAAK,SAAS,EAAE,EAAE;AAC1B,UAAO,EAAE,SAAS,GAAG,QAAQ,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,SAAS;;EAE5D,MAAM,KAAK,KAAK;AACd,MAAG,KAAK,IAAI;;EAEd,MAAM,QAAQ;AACZ,MAAG,OAAO;;EAEb;;AAGH,SAAS,YAAY,IAAiB;CACpC,MAAM,QAAQ,QAAgB,KAAa,WACzC,IAAI,SAAc,SAAS,WAAW;AACpC,KAAG,QAAQ,KAAK,QAAQ,SAAqB,KAAU,MAAW;AAChE,OAAI,IAAK,QAAO,IAAI;OACf,SAAQ,WAAW,QAAQ,OAAO,KAAK;IAC5C;GACF;CAEJ,MAAM,QAAQ,SAAqB,YAChC,QAAa,MAAM,OAAO,IAAI,GAAG,SAAS;AAE7C,QAAO;EACL,MAAM,KAAK,SAAS,EAAE,KAAK,KAAK,OAAO,KAAK,OAAO;EACnD,MAAM,KAAK,SAAS,EAAE,KAAK,KAAK,OAAO,KAAK,OAAO;EACnD,MAAM,KAAK,SAAS,EAAE,KAAK,KAAK,OAAO,KAAK,OAAO,CAAC,MAAK,SAAQ,EAAE,SAAS,IAAI,SAAS,EAAE;EAC3F,OAAM,QAAO,IAAI,SAAS,SAAS,WAAW,GAAG,KAAK,KAAK,KAAK,SAAS,OAAO,CAAC,CAAC;EAClF,aAAa,IAAI,SAAS,SAAS,WAAW,GAAG,MAAM,KAAK,SAAS,OAAO,CAAC,CAAC;EAC/E;;AAGH,SAAgB,KAAK,QAAoD;CACvE,MAAM,OAAO,QAAgB,UAAU,OAAO,UAAU,YAAY,OAAO;AAE3E,KAAI,IAAI,MAAM,CACZ,QAAO;AAET,KAAI,IAAI,UAAU,CAChB,QAAO,aAAa,OAAuB;AAE7C,KAAI,IAAI,UAAU,IAAI,IAAI,QAAQ,CAChC,QAAO,SAAS,OAAqB;AAEvC,OAAM,IAAI,UAAU,+EAA+E;;AAGrG,MAAa,6BAAa,IAAI,SAAsD;AAepF,SAAS,aAAa,QAA8B;CAClD,MAAM,SAAiB;EACrB,GAAG,iBAAiB,OAAO;EAC3B,MAAM,MAAM,KAAK;AACf,SAAM,OAAO,MAAM,KAAK,QAAQ;;EAElC,MAAM,cAAc;GAClB,MAAM,KAAK,MAAM,OAAO,YAAY,QAAQ;AAE5C,UAAO;IACL,GAAG,iBAAiB,GAAG;IACvB,cAAc,GAAG,QAAQ;IACzB,gBAAgB,GAAG,UAAU;IAC9B;;EAEH,MAAM,QAAQ;AACZ,UAAO,OAAO;;EAEjB;AAED,YAAW,IAAI,SAAQ,QAAO,OAAO,QAAQ,IAAI,CAAC;AAElD,QAAO;;AAGT,SAAS,iBAAiB,QAA6C;CACrE,MAAM,WAAW,KAAa,SAAgB,OAAO,QAAQ;EAAE;EAAK;EAAM,CAAC;AAE3E,QAAO;EACL,MAAM,IAAI,KAAK,SAAS,EAAE,EAAE;AAC1B,WAAQ,MAAM,QAAQ,KAAK,OAAO,EAAE;;EAEtC,MAAM,IAAI,KAAK,SAAS,EAAE,EAAE;AAC1B,WAAQ,MAAM,QAAQ,KAAK,OAAO,EAAE,KAAK;;EAE3C,MAAM,IAAI,KAAK,SAAS,EAAE,EAAE;AAC1B,UAAO,EAAE,SAAS,QAAQ,MAAM,QAAQ,KAAK,OAAO,EAAE,aAAa,EAAE;;EAEvE,MAAM,KAAK,KAAK;AACd,SAAM,OAAO,gBAAgB,IAAI;;EAEpC;;AAgBH,SAAS,SAAS,IAAwB;CACxC,MAAM,aAAa,KAAa,SAAgB,EAAE,KAAK,GAAG,QAAQ,IAAI,CAAC,KAAK,GAAG,OAAO;AAEtF,QAAO;EACL,MAAM,IAAI,KAAK,QAAQ;AACrB,WAAQ,MAAM,UAAU,KAAK,OAAO,CAAC,KAAK,EAAE;;EAE9C,MAAM,IAAI,KAAK,QAAQ;AACrB,UAAO,MAAM,UAAU,KAAK,OAAO,CAAC,OAAO,IAAI;;EAEjD,MAAM,IAAI,KAAK,QAAQ;AACrB,UAAO,EAAE,UAAU,MAAM,UAAU,KAAK,OAAO,CAAC,KAAK,EAAE,KAAK,SAAS;;EAEvE,MAAM,KAAK,KAAK;AACd,SAAM,GAAG,QAAQ,IAAI,CAAC,KAAK;;EAE7B,MAAM,MAAM,KAAK;AACf,SAAM,GAAG,MAAM,IAAI,KAAI,QAAO,GAAG,QAAQ,IAAI,CAAC,CAAC;;EAEjD,MAAM,cAA8B;AAClC,SAAM,IAAI,MAAM,sCAAsC;;EAExD,MAAM,QAAQ;EACf"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@expressive/sql",
3
- "version": "0.11.0",
3
+ "version": "0.13.0",
4
4
  "description": "Expressive ORM on SQL: entities, Query and an embedded SQLite store from one import.",
5
5
  "keywords": [
6
6
  "orm",
@@ -23,6 +23,9 @@
23
23
  "url": "https://github.com/gabeklein/expressive-orm/issues"
24
24
  },
25
25
  "type": "module",
26
+ "sideEffects": [
27
+ "./dist/bin.js"
28
+ ],
26
29
  "publishConfig": {
27
30
  "access": "public"
28
31
  },
@@ -45,12 +48,10 @@
45
48
  "bin": {
46
49
  "expressive": "./dist/bin.js"
47
50
  },
48
- "expressive": {
49
- "bin": "./dist/cli.js"
50
- },
51
51
  "files": [
52
52
  "dist",
53
- "skills"
53
+ "skills",
54
+ "CHANGELOG.md"
54
55
  ],
55
56
  "scripts": {
56
57
  "build": "tsdown",
@@ -59,7 +60,8 @@
59
60
  "test": "bun run typecheck && bun run coverage"
60
61
  },
61
62
  "dependencies": {
62
- "@expressive/orm": "^0.21.0",
63
+ "@expressive/cli": "^0.2.0",
64
+ "@expressive/orm": "^0.22.0",
63
65
  "sql-formatter": "^10.7.2"
64
66
  },
65
67
  "devDependencies": {
@@ -5,7 +5,7 @@ description: Expressive ORM on SQL (@expressive/sql) - SQLiteConnection with a b
5
5
 
6
6
  # @expressive/sql
7
7
 
8
- Expressive ORM on SQL, with embedded SQLite. Re-exports `@expressive/orm` - entities, fields, relations, `Query`, transactions and `Memory` are in `expressive-orm`. Apps import everything from `@expressive/sql`.
8
+ Expressive ORM on SQL, with embedded SQLite. Re-exports `@expressive/orm` - entities, fields, relations, `Query`, transactions and `Memory` are in `expressive-orm`. Apps import everything from `@expressive/sql`. The package has no side effects - a browser bundle importing only entities and `Remote` from it carries no SQLite code or `sql-formatter`.
9
9
 
10
10
  ```bash
11
11
  npm install @expressive/sql @expressive/mvc
@@ -31,7 +31,7 @@ A filename or in-memory connection enforces foreign keys. `sync` covers the clas
31
31
 
32
32
  ### Engine
33
33
 
34
- In place of the filename, pass an `Engine` for a SQLite the built-in loader can't open - any object with these, each async:
34
+ As `{ source }`, pass an `Engine` for a SQLite the built-in loader can't open - any object with these, each async:
35
35
 
36
36
  ```ts
37
37
  import type { Engine } from '@expressive/sql';
@@ -44,7 +44,7 @@ const engine: Engine = {
44
44
  close: () => ...,
45
45
  };
46
46
 
47
- const db = await SQLiteConnection.new([User], engine);
47
+ const db = await SQLiteConnection.new([User], { source: engine });
48
48
  ```
49
49
 
50
50
  A given engine, binding or client is used as is - turn on foreign keys yourself where the host doesn't - and `close()` leaves it open.
@@ -58,7 +58,7 @@ Two optional members, for hosts without `BEGIN` and `COMMIT` on one connection:
58
58
 
59
59
  ### Hosts
60
60
 
61
- In place of the filename, `new` also takes a D1 binding, a libSQL `Client` or a libSQL address, told apart by shape.
61
+ As `source`, `new` also takes a D1 binding, a libSQL `Client` or a libSQL address, told apart by shape. The second argument is a filename or address string, or `{ source, timestamps }` - any other object there throws, so an object source always goes in `{ source }`.
62
62
 
63
63
  On Workers, open once from the first request's binding, and drop it when `sync` fails - a second `new` while entities hold a connection throws:
64
64
 
@@ -66,7 +66,7 @@ On Workers, open once from the first request's binding, and drop it when `sync`
66
66
  let ready: Promise<unknown> | undefined;
67
67
 
68
68
  function open(DB: D1Database){
69
- const db = SQLiteConnection.new([User], DB);
69
+ const db = SQLiteConnection.new([User], { source: DB });
70
70
 
71
71
  return Promise.resolve(db).catch(async error => {
72
72
  ready = undefined;
@@ -83,6 +83,7 @@ export default {
83
83
  };
84
84
  ```
85
85
 
86
+ - Per request - `db.session(() => handle(request), env.DB)` runs the request on that binding with its own identity map (`expressive-orm/SKILL.md#sessions`), so `get` never serves a row another isolate changed. A session takes a D1 binding, libSQL client or `Engine`, used as given and left open; it replaces swapping a connection's engine. In workerd, build the connection with no source (`SQLiteConnection.new(types)`) and never await it or run anything outside a session - a statement outside one rejects with `SQLiteConnection has no source, and no SQLite loads in this runtime`. `session` rejects an unknown source (say `env` for `env.DB`) before `fn` runs. `sync`, or awaiting the connection, inside a session on a source other than the connection's own rejects - sync from a deploy step.
86
87
  - D1 - `sync` applies as one batch, a few round trips per table each cold start. `transaction` throws. Foreign keys stay on, so `sync(true, true)` refuses a rebuild.
87
88
  - libSQL address - `libsql:`, `https:`, `http:`, `ws:` or `wss:` opens `@libsql/client` 0.18+; token as `?authToken=`. Loaded at runtime, so under a bundler (Workers) pass a `createClient` client instead. An `undefined` or empty source opens in memory - check an address from the environment first.
88
89
  - Every libSQL client - each `transaction` is a libSQL write transaction (`BEGIN IMMEDIATE`) holding the connection's lock, so transactions run one at a time app-wide. `sync` is one batch; a rebuild runs through `client.migrate`, foreign keys off for it alone. Local libSQL enforces foreign keys by default; remote gets the server's setting.
@@ -95,6 +96,7 @@ Awaiting a connection runs `sync`:
95
96
  - Missing tables are created, missing columns and indexes added, existing ones checked against the classes.
96
97
  - A new column reads `undefined` or its `fallback` on old rows. One that cannot fill existing rows - primary, `UNIQUE`, `NOT NULL` without a `fallback` or defaulting to now - is reported and nothing changes. A nullable column defaulting to now is added without the default; inserts fill it.
97
98
  - Type and nullability drift is reported. `sync(true, true)` rebuilds the table, refusing while a row would not fit or a value would not convert. A rebuild keeps columns not on the class, indexes and triggers, but not UNIQUE or REFERENCES on columns the class doesn't declare, and refuses while any row references a missing one.
99
+ - A timestamp column declared INTEGER under `"iso"`, or TEXT under `"ms"` or `"seconds"`, is reported with the `timestamps` option that keeps it. `sync(true, true)` does not convert it - converting would guess the unit.
98
100
  - `static schema` is reported - SQLite has none.
99
101
  - A relation column missing while `<table>_id` exists is reported, not added - set `{ column: "<table>_id" }` to keep the old one.
100
102
  - `sync(false)` only verifies. `plan(force?)` returns `{ steps, problems }` - each step with `action`, `reason` and `sql` - without doing it. A sync applies in one transaction.
@@ -105,7 +107,9 @@ Awaiting a connection runs `sync`:
105
107
  ```sh
106
108
  expressive sql check src/db.ts # list what sync would change; exit 1 if anything would
107
109
  expressive sql sync src/db.ts # create missing tables, columns and indexes
108
- expressive sql sync --force src/db.ts # also rebuild drifted columns
110
+ expressive sql sync --force src/db.ts # also rebuild drifted columns (-f)
111
+ expressive sql sync --help # inputs for any command
112
+ expressive # list commands - sql, dev (@expressive/dev) if installed
109
113
  ```
110
114
 
111
115
  The entry is the module that creates the connections - imported with `sync` held back, so `await Connection.new()` resolves without touching the database; the command plans and syncs each connection awaited while it loads. The entry must not query at load - the tables may not exist yet. A TypeScript entry needs Bun (`bunx --bun expressive ...`) or Node 22.18+.
@@ -119,7 +123,7 @@ Datatypes are orm's (`expressive-orm/SKILL.md#entities`); `sql.*` is shorthand f
119
123
  | `str` | TEXT |
120
124
  | `num` | INTEGER; `real`, `double` REAL; `numeric`, `decimal` NUMERIC |
121
125
  | `bool` | INTEGER, 1 or 0 |
122
- | `date` | TEXT - ISO 8601 UTC to the ms; `date` the local day `YYYY-MM-DD`; `time` UTC `HH:MM:SS` |
126
+ | `date` | INTEGER epoch ms by default - see `timestamps` below; `date` the local day `YYYY-MM-DD`; `time` UTC `HH:MM:SS` |
123
127
  | `json` | TEXT |
124
128
  | `one` | the related key's |
125
129
 
@@ -136,6 +140,7 @@ class Product extends Type {
136
140
  ```
137
141
 
138
142
  - `num()` is a 32-bit integer - a fraction or a value outside 32-bit range throws on write. `sql.bigint` for large integers, `sql.real` or `sql.numeric(p, s)` for fractions.
143
+ - A `timestamp`'s storage is the connection's: `SQLiteConnection.new(types, { source: "app.db", timestamps: "seconds" })`. `"ms"` (default) and `"seconds"` are INTEGER epoch values; `"iso"` is ISO 8601 UTC text, for reading in a DB browser or D1 console. Every connection to one file must agree. A database written by 0.6-0.11 holds ISO text - open it with `{ timestamps: "iso" }`.
139
144
  - Options a factory doesn't take go in an object - `date({ type: "timestamp", precision: 3 })`.
140
145
  - `sql.now` is the database's current time in the column's storage - as a `fallback`, in a statics write or comparison (`lessThan(sql.now)`), or in a `Query`. Statics read it from the app's clock.
141
146
  - The SQL floor checks values again before storing, so rows forwarded from a client meet the same rules.
@@ -1,6 +0,0 @@
1
- //#region src/dispatch.d.ts
2
- type Output = Pick<Console, "log" | "error">;
3
- declare function dispatch(args: string[], cwd: string, out: Output): Promise<number>;
4
- //#endregion
5
- export { dispatch };
6
- //# sourceMappingURL=dispatch.d.ts.map
package/dist/dispatch.js DELETED
@@ -1,44 +0,0 @@
1
- import { existsSync, readFileSync, readdirSync } from "node:fs";
2
- import { dirname, join } from "node:path";
3
- import { pathToFileURL } from "node:url";
4
-
5
- //#region src/dispatch.ts
6
- function scopes(cwd) {
7
- const found = [];
8
- for (let dir = cwd;; dir = dirname(dir)) {
9
- const scope = join(dir, "node_modules", "@expressive");
10
- if (existsSync(scope)) found.push(scope);
11
- if (dirname(dir) == dir) return found;
12
- }
13
- }
14
- function manifest(dir) {
15
- try {
16
- return JSON.parse(readFileSync(join(dir, "package.json"), "utf8")).expressive;
17
- } catch {
18
- return;
19
- }
20
- }
21
- function commands(cwd) {
22
- const found = /* @__PURE__ */ new Map();
23
- for (const scope of scopes(cwd)) for (const name of readdirSync(scope)) {
24
- const bin = manifest(join(scope, name))?.bin;
25
- if (bin && !found.has(name)) found.set(name, join(scope, name, bin));
26
- }
27
- return found;
28
- }
29
- async function dispatch(args, cwd, out) {
30
- const [name, ...rest] = args;
31
- const available = commands(cwd);
32
- const bin = name && available.get(name);
33
- if (!bin) {
34
- const list = Array.from(available.keys()).join(", ") || "none installed";
35
- out.error(`${name ? `No expressive command "${name}".` : "Usage: expressive <command> ..."} Available: ${list}.`);
36
- return 2;
37
- }
38
- const { default: run } = await import(pathToFileURL(bin).href);
39
- return run(rest, out);
40
- }
41
-
42
- //#endregion
43
- export { dispatch };
44
- //# sourceMappingURL=dispatch.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"dispatch.js","names":[],"sources":["../src/dispatch.ts"],"sourcesContent":["import { existsSync, readdirSync, readFileSync } from 'node:fs';\nimport { dirname, join } from 'node:path';\nimport { pathToFileURL } from 'node:url';\n\ntype Output = Pick<Console, \"log\" | \"error\">;\n\ntype Command = (args: string[], out: Output) => Promise<number>;\n\nfunction scopes(cwd: string){\n const found: string[] = [];\n\n for (let dir = cwd; ; dir = dirname(dir)) {\n const scope = join(dir, \"node_modules\", \"@expressive\");\n\n if (existsSync(scope))\n found.push(scope);\n\n if (dirname(dir) == dir)\n return found;\n }\n}\n\nfunction manifest(dir: string): { bin?: string } | undefined {\n try {\n return JSON.parse(readFileSync(join(dir, \"package.json\"), \"utf8\")).expressive;\n }\n catch {\n return;\n }\n}\n\nfunction commands(cwd: string){\n const found = new Map<string, string>();\n\n for (const scope of scopes(cwd))\n for (const name of readdirSync(scope)) {\n const bin = manifest(join(scope, name))?.bin;\n\n if (bin && !found.has(name))\n found.set(name, join(scope, name, bin));\n }\n\n return found;\n}\n\nexport async function dispatch(args: string[], cwd: string, out: Output): Promise<number> {\n const [name, ...rest] = args;\n const available = commands(cwd);\n const bin = name && available.get(name);\n\n if (!bin) {\n const list = Array.from(available.keys()).join(\", \") || \"none installed\";\n\n out.error(`${name ? `No expressive command \"${name}\".` : \"Usage: expressive <command> ...\"} Available: ${list}.`);\n return 2;\n }\n\n const { default: run } = await import(pathToFileURL(bin).href) as { default: Command };\n\n return run(rest, out);\n}\n"],"mappings":";;;;;AAQA,SAAS,OAAO,KAAY;CAC1B,MAAM,QAAkB,EAAE;AAE1B,MAAK,IAAI,MAAM,MAAO,MAAM,QAAQ,IAAI,EAAE;EACxC,MAAM,QAAQ,KAAK,KAAK,gBAAgB,cAAc;AAEtD,MAAI,WAAW,MAAM,CACnB,OAAM,KAAK,MAAM;AAEnB,MAAI,QAAQ,IAAI,IAAI,IAClB,QAAO;;;AAIb,SAAS,SAAS,KAA2C;AAC3D,KAAI;AACF,SAAO,KAAK,MAAM,aAAa,KAAK,KAAK,eAAe,EAAE,OAAO,CAAC,CAAC;SAE/D;AACJ;;;AAIJ,SAAS,SAAS,KAAY;CAC5B,MAAM,wBAAQ,IAAI,KAAqB;AAEvC,MAAK,MAAM,SAAS,OAAO,IAAI,CAC7B,MAAK,MAAM,QAAQ,YAAY,MAAM,EAAE;EACrC,MAAM,MAAM,SAAS,KAAK,OAAO,KAAK,CAAC,EAAE;AAEzC,MAAI,OAAO,CAAC,MAAM,IAAI,KAAK,CACzB,OAAM,IAAI,MAAM,KAAK,OAAO,MAAM,IAAI,CAAC;;AAG7C,QAAO;;AAGT,eAAsB,SAAS,MAAgB,KAAa,KAA8B;CACxF,MAAM,CAAC,MAAM,GAAG,QAAQ;CACxB,MAAM,YAAY,SAAS,IAAI;CAC/B,MAAM,MAAM,QAAQ,UAAU,IAAI,KAAK;AAEvC,KAAI,CAAC,KAAK;EACR,MAAM,OAAO,MAAM,KAAK,UAAU,MAAM,CAAC,CAAC,KAAK,KAAK,IAAI;AAExD,MAAI,MAAM,GAAG,OAAO,0BAA0B,KAAK,MAAM,kCAAkC,cAAc,KAAK,GAAG;AACjH,SAAO;;CAGT,MAAM,EAAE,SAAS,QAAQ,MAAM,OAAO,cAAc,IAAI,CAAC;AAEzD,QAAO,IAAI,MAAM,IAAI"}