sqlstack 3.0.0 → 3.2.0

package/dist/esm/testing/sqlite/database.js

@@ -0,0 +1,85 @@
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
+import { createSqliteDb } from '../../adapters/sqlite.js';
+import { SqlStackError } from '../../core/errors.js';
+export class TestSqliteError extends SqlStackError {
+    constructor(message) {
+        super(message);
+        this.name = 'TestSqliteError';
+    }
+}
+/**
+ * Temp directories for file-backed handles that were never disposed. Tests are
+ * expected to call `dispose()`, but a failed assertion can skip it; this keeps
+ * an abandoned directory from outliving the worker process.
+ */
+const abandonedDirectories = new Set();
+let exitCleanupRegistered = false;
+function trackDirectory(directory) {
+    abandonedDirectories.add(directory);
+    if (exitCleanupRegistered)
+        return;
+    exitCleanupRegistered = true;
+    process.once('exit', () => {
+        for (const dir of abandonedDirectories) {
+            try {
+                fs.rmSync(dir, { recursive: true, force: true });
+            }
+            catch {
+                /* best-effort cleanup */
+            }
+        }
+    });
+}
+export async function createDatabaseHandle(fileBacked) {
+    let directory;
+    let filename = ':memory:';
+    if (fileBacked) {
+        directory = fs.mkdtempSync(path.join(os.tmpdir(), 'sqlstack-test-'));
+        filename = path.join(directory, 'database.sqlite');
+        trackDirectory(directory);
+    }
+    let db;
+    try {
+        db = await createSqliteDb(filename);
+    }
+    catch (err) {
+        if (directory) {
+            fs.rmSync(directory, { recursive: true, force: true });
+            abandonedDirectories.delete(directory);
+        }
+        const message = err.message;
+        if (message.includes('No SQLite driver available')) {
+            throw new TestSqliteError('testSqlite requires the optional peer "better-sqlite3".');
+        }
+        throw new TestSqliteError(`Failed to create SQLite test database: ${message}`);
+    }
+    let disposed = false;
+    return {
+        db,
+        conn: db.conn,
+        path: fileBacked ? filename : undefined,
+        async query(sql, params = []) {
+            if (disposed)
+                throw new TestSqliteError('Test SQLite database has been disposed.');
+            return db.query(sql, [...params]);
+        },
+        async dispose() {
+            if (disposed)
+                return;
+            disposed = true;
+            try {
+                await db.close();
+            }
+            catch {
+                /* connection may already be closed */
+            }
+            if (directory) {
+                fs.rmSync(directory, { recursive: true, force: true });
+                abandonedDirectories.delete(directory);
+            }
+        },
+    };
+}
+//# sourceMappingURL=database.js.map

package/dist/esm/testing/sqlite/database.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"database.js","sourceRoot":"","sources":["../../../../src/testing/sqlite/database.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAGlD,MAAM,OAAO,eAAgB,SAAQ,aAAa;IAChD,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAChC,CAAC;CACF;AAcD;;;;GAIG;AACH,MAAM,oBAAoB,GAAG,IAAI,GAAG,EAAU,CAAC;AAC/C,IAAI,qBAAqB,GAAG,KAAK,CAAC;AAElC,SAAS,cAAc,CAAC,SAAiB;IACvC,oBAAoB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACpC,IAAI,qBAAqB;QAAE,OAAO;IAClC,qBAAqB,GAAG,IAAI,CAAC;IAC7B,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE;QACxB,KAAK,MAAM,GAAG,IAAI,oBAAoB,EAAE,CAAC;YACvC,IAAI,CAAC;gBACH,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACnD,CAAC;YAAC,MAAM,CAAC;gBACP,yBAAyB;YAC3B,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,UAAmB;IAEnB,IAAI,SAA6B,CAAC;IAClC,IAAI,QAAQ,GAAG,UAAU,CAAC;IAC1B,IAAI,UAAU,EAAE,CAAC;QACf,SAAS,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,gBAAgB,CAAC,CAAC,CAAC;QACrE,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;QACnD,cAAc,CAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;IAED,IAAI,EAAY,CAAC;IACjB,IAAI,CAAC;QACH,EAAE,GAAG,MAAM,cAAc,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,SAAS,EAAE,CAAC;YACd,EAAE,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACvD,oBAAoB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACzC,CAAC;QACD,MAAM,OAAO,GAAI,GAAa,CAAC,OAAO,CAAC;QACvC,IAAI,OAAO,CAAC,QAAQ,CAAC,4BAA4B,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,eAAe,CAAC,yDAAyD,CAAC,CAAC;QACvF,CAAC;QACD,MAAM,IAAI,eAAe,CAAC,0CAA0C,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,OAAO;QACL,EAAE;QACF,IAAI,EAAE,EAAE,CAAC,IAAI;QACb,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;QACvC,KAAK,CAAC,KAAK,CAAC,GAAW,EAAE,SAA6B,EAAE;YACtD,IAAI,QAAQ;gBAAE,MAAM,IAAI,eAAe,CAAC,yCAAyC,CAAC,CAAC;YACnF,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;QACpC,CAAC;QACD,KAAK,CAAC,OAAO;YACX,IAAI,QAAQ;gBAAE,OAAO;YACrB,QAAQ,GAAG,IAAI,CAAC;YAChB,IAAI,CAAC;gBACH,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC;YACnB,CAAC;YAAC,MAAM,CAAC;gBACP,sCAAsC;YACxC,CAAC;YACD,IAAI,SAAS,EAAE,CAAC;gBACd,EAAE,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;gBACvD,oBAAoB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import * as fs from 'node:fs';\nimport * as os from 'node:os';\nimport * as path from 'node:path';\nimport { createSqliteDb } from '../../adapters/sqlite';\nimport { SqlStackError } from '../../core/errors';\nimport type { Database } from '../../registry';\n\nexport class TestSqliteError extends SqlStackError {\n  constructor(message: string) {\n    super(message);\n    this.name = 'TestSqliteError';\n  }\n}\n\nexport interface TestSqliteDatabase {\n  /** The live sqlstack SQLite adapter, suitable for direct injection. */\n  readonly db: Database;\n  /** The underlying better-sqlite3 (or sqlite3) connection. */\n  readonly conn: unknown;\n  /** Absolute database path in file mode; undefined for :memory:. */\n  readonly path?: string;\n  query(sql: string, params?: readonly unknown[]): Promise<unknown>;\n  /** Close the connection and remove owned temporary files. Idempotent. */\n  dispose(): Promise<void>;\n}\n\n/**\n * Temp directories for file-backed handles that were never disposed. Tests are\n * expected to call `dispose()`, but a failed assertion can skip it; this keeps\n * an abandoned directory from outliving the worker process.\n */\nconst abandonedDirectories = new Set<string>();\nlet exitCleanupRegistered = false;\n\nfunction trackDirectory(directory: string): void {\n  abandonedDirectories.add(directory);\n  if (exitCleanupRegistered) return;\n  exitCleanupRegistered = true;\n  process.once('exit', () => {\n    for (const dir of abandonedDirectories) {\n      try {\n        fs.rmSync(dir, { recursive: true, force: true });\n      } catch {\n        /* best-effort cleanup */\n      }\n    }\n  });\n}\n\nexport async function createDatabaseHandle(\n  fileBacked: boolean\n): Promise<TestSqliteDatabase> {\n  let directory: string | undefined;\n  let filename = ':memory:';\n  if (fileBacked) {\n    directory = fs.mkdtempSync(path.join(os.tmpdir(), 'sqlstack-test-'));\n    filename = path.join(directory, 'database.sqlite');\n    trackDirectory(directory);\n  }\n\n  let db: Database;\n  try {\n    db = await createSqliteDb(filename);\n  } catch (err) {\n    if (directory) {\n      fs.rmSync(directory, { recursive: true, force: true });\n      abandonedDirectories.delete(directory);\n    }\n    const message = (err as Error).message;\n    if (message.includes('No SQLite driver available')) {\n      throw new TestSqliteError('testSqlite requires the optional peer \"better-sqlite3\".');\n    }\n    throw new TestSqliteError(`Failed to create SQLite test database: ${message}`);\n  }\n\n  let disposed = false;\n  return {\n    db,\n    conn: db.conn,\n    path: fileBacked ? filename : undefined,\n    async query(sql: string, params: readonly unknown[] = []) {\n      if (disposed) throw new TestSqliteError('Test SQLite database has been disposed.');\n      return db.query(sql, [...params]);\n    },\n    async dispose() {\n      if (disposed) return;\n      disposed = true;\n      try {\n        await db.close();\n      } catch {\n        /* connection may already be closed */\n      }\n      if (directory) {\n        fs.rmSync(directory, { recursive: true, force: true });\n        abandonedDirectories.delete(directory);\n      }\n    },\n  };\n}\n"]}

package/dist/esm/testing/sqlite/loadData.js

@@ -0,0 +1,48 @@
+import { quoteIdent } from '../schema/ddl.js';
+import { TestDataError, composeRows, planInsertOrder, toOperations, } from '../postgres/loadData.js';
+export { TestDataError, composeRows, planInsertOrder, toOperations };
+export async function insertRows(query, schema, effective) {
+    const order = planInsertOrder(schema, [...effective.keys()]);
+    const declared = new Map(schema.tables.map((table) => [
+        table.name,
+        table.columns.map((column) => column.name),
+    ]));
+    for (const tableName of order) {
+        const rows = effective.get(tableName);
+        const columnOrder = declared.get(tableName);
+        const batches = new Map();
+        for (const row of rows) {
+            const columns = columnOrder.filter((column) => row[column] !== undefined);
+            const signature = columns.join(',');
+            const batch = batches.get(signature) ?? { columns, rows: [] };
+            batch.rows.push(row);
+            batches.set(signature, batch);
+        }
+        for (const { columns, rows: batchRows } of batches.values()) {
+            if (columns.length === 0) {
+                for (let i = 0; i < batchRows.length; i++) {
+                    await run(query, tableName, `INSERT INTO ${quoteIdent(tableName)} DEFAULT VALUES`, []);
+                }
+                continue;
+            }
+            const params = [];
+            const tuples = batchRows.map((row) => {
+                const placeholders = columns.map((column) => {
+                    params.push(row[column]);
+                    return '?';
+                });
+                return `(${placeholders.join(', ')})`;
+            });
+            await run(query, tableName, `INSERT INTO ${quoteIdent(tableName)} (${columns.map(quoteIdent).join(', ')}) VALUES ${tuples.join(', ')}`, params);
+        }
+    }
+}
+async function run(query, tableName, sql, params) {
+    try {
+        await query(sql, params);
+    }
+    catch (err) {
+        throw new TestDataError(`Failed to insert scenario rows into table "${tableName}": ${err.message}`);
+    }
+}
+//# sourceMappingURL=loadData.js.map

package/dist/esm/testing/sqlite/loadData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadData.js","sourceRoot":"","sources":["../../../../src/testing/sqlite/loadData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,OAAO,EACL,aAAa,EACb,WAAW,EACX,eAAe,EACf,YAAY,GACb,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE,YAAY,EAAE,CAAC;AAGrE,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,KAA2D,EAC3D,MAA4B,EAC5B,SAA6B;IAE7B,MAAM,KAAK,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC7D,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;QACpD,KAAK,CAAC,IAAI;QACV,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;KAC3C,CAAC,CAAC,CAAC;IACJ,KAAK,MAAM,SAAS,IAAI,KAAK,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC,SAAS,CAAE,CAAC;QACvC,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAE,CAAC;QAC7C,MAAM,OAAO,GAAG,IAAI,GAAG,EAA8C,CAAC;QACtE,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC;YAC1E,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACpC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;YAC9D,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACrB,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAChC,CAAC;QACD,KAAK,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;YAC5D,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC1C,MAAM,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,eAAe,UAAU,CAAC,SAAS,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;gBACzF,CAAC;gBACD,SAAS;YACX,CAAC;YACD,MAAM,MAAM,GAAc,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBACnC,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;oBAC1C,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;oBACzB,OAAO,GAAG,CAAC;gBACb,CAAC,CAAC,CAAC;gBACH,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;YACxC,CAAC,CAAC,CAAC;YACH,MAAM,GAAG,CACP,KAAK,EACL,SAAS,EACT,eAAe,UAAU,CAAC,SAAS,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAC1G,MAAM,CACP,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,KAA2D,EAC3D,SAAiB,EACjB,GAAW,EACX,MAAiB;IAEjB,IAAI,CAAC;QACH,MAAM,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC3B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,IAAI,aAAa,CACrB,8CAA8C,SAAS,MAAO,GAAa,CAAC,OAAO,EAAE,CACtF,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["import { quoteIdent } from '../schema/ddl';\nimport type { NormalizedTestSchema } from '../schema/types';\nimport {\n  TestDataError,\n  composeRows,\n  planInsertOrder,\n  toOperations,\n} from '../postgres/loadData';\nimport type { DataOperation, Row } from '../postgres/loadData';\n\nexport { TestDataError, composeRows, planInsertOrder, toOperations };\nexport type { DataOperation, Row };\n\nexport async function insertRows(\n  query: (sql: string, params: unknown[]) => Promise<unknown>,\n  schema: NormalizedTestSchema,\n  effective: Map<string, Row[]>\n): Promise<void> {\n  const order = planInsertOrder(schema, [...effective.keys()]);\n  const declared = new Map(schema.tables.map((table) => [\n    table.name,\n    table.columns.map((column) => column.name),\n  ]));\n  for (const tableName of order) {\n    const rows = effective.get(tableName)!;\n    const columnOrder = declared.get(tableName)!;\n    const batches = new Map<string, { columns: string[]; rows: Row[] }>();\n    for (const row of rows) {\n      const columns = columnOrder.filter((column) => row[column] !== undefined);\n      const signature = columns.join(',');\n      const batch = batches.get(signature) ?? { columns, rows: [] };\n      batch.rows.push(row);\n      batches.set(signature, batch);\n    }\n    for (const { columns, rows: batchRows } of batches.values()) {\n      if (columns.length === 0) {\n        for (let i = 0; i < batchRows.length; i++) {\n          await run(query, tableName, `INSERT INTO ${quoteIdent(tableName)} DEFAULT VALUES`, []);\n        }\n        continue;\n      }\n      const params: unknown[] = [];\n      const tuples = batchRows.map((row) => {\n        const placeholders = columns.map((column) => {\n          params.push(row[column]);\n          return '?';\n        });\n        return `(${placeholders.join(', ')})`;\n      });\n      await run(\n        query,\n        tableName,\n        `INSERT INTO ${quoteIdent(tableName)} (${columns.map(quoteIdent).join(', ')}) VALUES ${tuples.join(', ')}`,\n        params\n      );\n    }\n  }\n}\n\nasync function run(\n  query: (sql: string, params: unknown[]) => Promise<unknown>,\n  tableName: string,\n  sql: string,\n  params: unknown[]\n): Promise<void> {\n  try {\n    await query(sql, params);\n  } catch (err) {\n    throw new TestDataError(\n      `Failed to insert scenario rows into table \"${tableName}\": ${(err as Error).message}`\n    );\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqlstack",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "",
   "license": "ISC",
   "author": "",
@@ -56,6 +56,7 @@
     "build:cjs": "tsc -p tsconfig.json",
     "build:esm": "tsc -p tsconfig.esm.json && node scripts/fix-esm-extensions.js && node scripts/create-esm-package.cjs",
     "test": "jest",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
     "test:watch": "jest --watch",
     "clean": "rimraf dist",
     "test:integration": "jest -c jest.integration.config.ts",
@@ -70,7 +71,7 @@
     "db:logs:mysql": "docker logs -f sqlstack-mysql"
   },
   "devDependencies": {
-    "@noego/ioc": "file:../ioc",
+    "@noego/ioc": "^0.6.1",
     "@types/jest": "^29.5.13",
     "better-sqlite3": "^12.3.0",
     "jest": "^29.7.0",
@@ -88,7 +89,7 @@
     "yaml": "^2.9.0"
   },
   "peerDependencies": {
-    "@noego/ioc": "*",
+    "@noego/ioc": ">=0.6.1",
     "better-sqlite3": "*",
     "mysql2": "*",
     "pg": "*",

package/readme.md

@@ -828,16 +828,14 @@ const result: WriteResult = await db.query(
 console.log(result.rowsAffected); // number
 ```
 
-**Postgres with RETURNING:**
+**With RETURNING (Postgres, SQLite ≥ 3.35):** the statement produces a result set, so it returns rows exactly like a `SELECT` — and `@Single` / `@Only` / `@Exist` / `@None` apply to it. The affected count is `rows.length`.
 
 ```ts
-const pgResult = await db.query(
+const rows = await db.query(
   'INSERT INTO users(id, email) VALUES($1, $2) RETURNING id',
   ['u9', 'nine@example.com']
 );
-if (pgResult.returning) {
-  console.log(pgResult.returning[0].id); // 'u9'
-}
+console.log(rows[0].id); // 'u9'
 ```
 
 Type definition:
@@ -847,11 +845,11 @@ type WriteResult = {
   lastInsertId?: unknown;
 };
 
-type PostgresWriteResult = WriteResult & {
-  returning?: Row[];
-};
+type QueryResult = Row[] | WriteResult;
 ```
 
+A result-shape decorator on a method whose statement produces no result set (e.g. `@Single` on a plain `UPDATE`) throws `ExpectedRowsError` rather than returning the write result.
+
 ### Evolving Queries Without Breaking Callers
 
 Your method signature is the contract; the SQL is an implementation detail.