@zerotal/orm 1.7.0 → 1.7.3

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.
package/CHANGELOG.md CHANGED
@@ -6,6 +6,66 @@ follows the Zerotal monorepo's unified versioning.
6
6
 
7
7
  **Maturity: `stable`**
8
8
 
9
+ ## [Unreleased]
10
+
11
+ ### Fixed
12
+
13
+ - **A boolean column could not hold a boolean on PostgreSQL.** `table.boolean()` compiled to
14
+ `INTEGER` on every engine — correct on SQLite, which has no boolean type, and rejected outright
15
+ by PostgreSQL: `column "…" is of type integer but expression is of type boolean` (42804) on the
16
+ first insert, and again on any `where(column, true)`. `DEFAULT` clauses failed the same way, a
17
+ boolean default having been serialised to `1`. The storage type now comes from the dialect, as
18
+ the auto-increment column already did. SQLite and MySQL are unchanged; existing PostgreSQL
19
+ tables keep their integer columns until a migration alters them. Found by the new smoke suite
20
+ that runs the ORM against a real PostgreSQL in CI.
21
+
22
+ - **A seeder that failed partway left its rows behind.** `Seeder.call()` has always wrapped
23
+ _composed_ seeders in a transaction, so a `DatabaseSeeder` that delegates was atomic and one that
24
+ does its work inline — which is most of them — was not. A failure on the fourth table committed
25
+ the first three, so the obvious next move, running it again, died on a unique constraint, and the
26
+ only way out was `migrate:fresh`. Migrations became transactional in 1.7.0; this closes the
27
+ asymmetry.
28
+
29
+ `db:seed` now wraps the whole run. Nesting is safe — `DB.transaction` opens a `SAVEPOINT` when one
30
+ is already open, so an inner `call()` still rolls back independently. The wrapper is skipped when
31
+ no connection is bound, because a seeder is not obliged to touch the database and an app that has
32
+ not configured one should not fail to seed over a transaction it never needed.
33
+
34
+ ### Fixed
35
+
36
+ - **`DatabaseProvider` now runs in `worker`, so `zt queue:work` can boot.** It did not, and the
37
+ consequence was total rather than partial: `QueueProvider` _does_ run in `worker`, the
38
+ queue's own default driver is `sqlite`, and so the worker asked for a connection this
39
+ provider had not made and died on startup —
40
+
41
+ ```
42
+ error: [Zerotal ORM] No database connection. Is DatabaseProvider registered?
43
+ ```
44
+
45
+ — while it plainly was registered.
46
+
47
+ It was never only the queue. Nine providers run in `worker` — notifications, audit, media,
48
+ tenancy, scheduler among them — and a job exists to do work with models. `AuthProvider` and
49
+ `SessionProvider` are absent from `worker` correctly, having neither a request nor a
50
+ session; the ORM being absent was an oversight, dating to 1.0.2.
51
+
52
+ Found building the first cookbook app, whose first queued job could not run.
53
+
54
+ - **Relation keys now accept the JS spelling, like every other identifier.** The convention is
55
+ camelCase in the application and snake_case in the database, converted on the way through —
56
+ and relation keys were the one place it did not happen. `@hasMany(() => Issue, { foreignKey:
57
+ "projectId" })` type-checked and then emitted `no such column: issues.projectId`, with the
58
+ error naming a column rather than the relation that produced it.
59
+
60
+ `_relationSubquery()` builds its subquery with a plain `QueryBuilder`, and the `_column()`
61
+ hook that converts is an override on `ModelQueryBuilder`, so nothing was converting these.
62
+ The keys are now converted where they are qualified, which covers `withCount`, `withSum`,
63
+ `has`/`whereHas` and `withExists` for `hasMany`, `belongsTo`, `manyToMany` and the morph
64
+ relations. Both spellings resolve to the column, so apps already passing `project_id` are
65
+ unaffected.
66
+
67
+ Found building the first cookbook app, where a project list would not count its issues.
68
+
9
69
  ## [1.7.0] — 2026-08-16
10
70
 
11
71
  ### Fixed
package/api-surface.md CHANGED
@@ -182,7 +182,7 @@ class Cast = {
182
182
  }
183
183
 
184
184
  class ColumnBuilder = {
185
- new <Locked extends string = never>(name: string, _sqlType: string, isPrimary?: boolean, isAutoIncrement?: boolean): ColumnBuilder<Locked>
185
+ new <Locked extends string = never>(name: string, _sqlType: string, isPrimary?: boolean, isAutoIncrement?: boolean, _isBoolean?: boolean): ColumnBuilder<Locked>
186
186
  after: (_column: string) => ColumnBuilder<Locked>
187
187
  alter: () => ColumnBuilder<Locked>
188
188
  before: (_column: string) => ColumnBuilder<Locked>
@@ -566,9 +566,11 @@ class MysqlDialect = {
566
566
  advisoryLockSql: (key: number) => DialectQuery
567
567
  advisoryUnlockSql: (key: number) => DialectQuery
568
568
  autoIncrementColumn: (column: string) => string
569
+ booleanLiteral: (value: boolean) => string
569
570
  dateExpr: (part: DatePart, column: string) => string
570
571
  hasColumnSql: (table: string, column: string) => DialectQuery
571
572
  hasTableSql: (table: string) => DialectQuery
573
+ readonly booleanType: 'INTEGER'
572
574
  readonly name: 'mysql'
573
575
  readonly supportsAdvisoryLocks: true
574
576
  readonly supportsTransactionalDdl: false
@@ -605,9 +607,11 @@ class PostgresDialect = {
605
607
  advisoryLockSql: (key: number) => DialectQuery
606
608
  advisoryUnlockSql: (key: number) => DialectQuery
607
609
  autoIncrementColumn: (column: string) => string
610
+ booleanLiteral: (value: boolean) => string
608
611
  dateExpr: (part: DatePart, column: string) => string
609
612
  hasColumnSql: (table: string, column: string) => DialectQuery
610
613
  hasTableSql: (table: string) => DialectQuery
614
+ readonly booleanType: 'BOOLEAN'
611
615
  readonly name: 'postgres'
612
616
  readonly supportsAdvisoryLocks: true
613
617
  readonly supportsTransactionalDdl: true
@@ -742,9 +746,11 @@ class SqliteDialect = {
742
746
  advisoryLockSql: () => DialectQuery | null
743
747
  advisoryUnlockSql: () => DialectQuery | null
744
748
  autoIncrementColumn: (column: string) => string
749
+ booleanLiteral: (value: boolean) => string
745
750
  dateExpr: (part: DatePart, column: string) => string
746
751
  hasColumnSql: (table: string, column: string) => DialectQuery
747
752
  hasTableSql: (table: string) => DialectQuery
753
+ readonly booleanType: 'INTEGER'
748
754
  readonly name: 'sqlite'
749
755
  readonly supportsAdvisoryLocks: false
750
756
  readonly supportsTransactionalDdl: true
@@ -1260,9 +1266,11 @@ interface SqlDialect = {
1260
1266
  advisoryLockSql: (key: number) => DialectQuery | null
1261
1267
  advisoryUnlockSql: (key: number) => DialectQuery | null
1262
1268
  autoIncrementColumn: (column: string) => string
1269
+ booleanLiteral: (value: boolean) => string
1263
1270
  dateExpr: (part: DatePart, column: string) => string
1264
1271
  hasColumnSql: (table: string, column: string) => DialectQuery
1265
1272
  hasTableSql: (table: string) => DialectQuery
1273
+ readonly booleanType: string
1266
1274
  readonly name: DialectName
1267
1275
  readonly supportsAdvisoryLocks: boolean
1268
1276
  readonly supportsTransactionalDdl: boolean
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zerotal/orm",
3
- "version": "1.7.0",
3
+ "version": "1.7.3",
4
4
  "license": "MIT",
5
5
  "maturity": "stable",
6
6
  "private": false,
@@ -31,8 +31,8 @@
31
31
  "typecheck": "tsc --noEmit"
32
32
  },
33
33
  "dependencies": {
34
- "@zerotal/core": "1.7.0",
35
- "@zerotal/validator": "1.7.0"
34
+ "@zerotal/core": "1.7.3",
35
+ "@zerotal/validator": "1.7.3"
36
36
  },
37
37
  "devDependencies": {
38
38
  "typescript": "^5.8.0"
@@ -1,4 +1,5 @@
1
1
  import type { Seeder } from "../seeding/Seeder.ts";
2
+ import { DB, _getDbConnectionOverride } from "../db/DB.ts";
2
3
 
3
4
  /**
4
5
  * What running the app's seeders came to.
@@ -27,6 +28,30 @@ export type SeedOutcome =
27
28
  *
28
29
  * @internal
29
30
  */
31
+ /**
32
+ * Run `body` inside a transaction when there is a database to have one on.
33
+ *
34
+ * A seeder is not obliged to touch the database — it may write fixtures to disk,
35
+ * prime a cache, or call an API — and an app that has not bound a connection
36
+ * should not fail to seed because of a transaction it never needed. So the
37
+ * wrapper is conditional: with a connection, the whole seed is atomic; without,
38
+ * `body` runs exactly as it used to.
39
+ */
40
+ async function _inTransaction(body: () => Promise<void>): Promise<void> {
41
+ let connected = _getDbConnectionOverride() !== null;
42
+ if (!connected) {
43
+ // No override — ask the container, which throws when nothing is bound.
44
+ try {
45
+ const { _getConnection } = await import("../db/DB.ts");
46
+ connected = _getConnection() !== undefined;
47
+ } catch {
48
+ connected = false;
49
+ }
50
+ }
51
+ if (!connected) return body();
52
+ await DB.transaction(body);
53
+ }
54
+
30
55
  export async function runSeeders(cwd: string = process.cwd()): Promise<SeedOutcome> {
31
56
  const seederPath = `${cwd}/database/seeders/DatabaseSeeder.ts`;
32
57
 
@@ -42,7 +67,9 @@ export async function runSeeders(cwd: string = process.cwd()): Promise<SeedOutco
42
67
  if (!seed) {
43
68
  return { status: "invalid", message: "Seeder index must export a default async function." };
44
69
  }
45
- await seed();
70
+ await _inTransaction(async () => {
71
+ await seed();
72
+ });
46
73
  return { status: "seeded" };
47
74
  } catch (error) {
48
75
  return { status: "failed", message: error instanceof Error ? error.message : String(error) };
@@ -63,7 +90,20 @@ export async function runSeeders(cwd: string = process.cwd()): Promise<SeedOutco
63
90
  };
64
91
  }
65
92
 
66
- await new SeederClass().run();
93
+ // One transaction around the whole seed.
94
+ //
95
+ // `Seeder.call()` has always wrapped *composed* seeders, so a DatabaseSeeder
96
+ // that delegates was atomic and one that does its work inline — which is
97
+ // most of them — was not. A failure halfway left its rows committed, so the
98
+ // obvious next move, running it again, died on a unique constraint and the
99
+ // only way out was `migrate:fresh`. Migrations became transactional in
100
+ // 1.7.0; this closes the asymmetry.
101
+ //
102
+ // Nesting is safe: `DB.transaction` opens a SAVEPOINT when one is already
103
+ // open, so an inner `call()` still rolls back independently.
104
+ await _inTransaction(async () => {
105
+ await new SeederClass().run();
106
+ });
67
107
  return { status: "seeded" };
68
108
  } catch (error) {
69
109
  return { status: "failed", message: error instanceof Error ? error.message : String(error) };
@@ -51,6 +51,13 @@ export class MysqlDialect implements SqlDialect {
51
51
  return `${column} INT AUTO_INCREMENT PRIMARY KEY`;
52
52
  }
53
53
 
54
+ // MySQL BOOLEAN is a synonym for TINYINT(1) and INTEGER accepts 0/1 all the same.
55
+ readonly booleanType = "INTEGER";
56
+
57
+ booleanLiteral(value: boolean): string {
58
+ return value ? "1" : "0";
59
+ }
60
+
54
61
  advisoryLockSql(key: number): DialectQuery {
55
62
  return { sql: `SELECT GET_LOCK(?, -1)`, params: [`zerotal_lock_${key}`] };
56
63
  }
@@ -48,6 +48,12 @@ export class PostgresDialect implements SqlDialect {
48
48
  return `${column} INTEGER GENERATED ALWAYS AS IDENTITY PRIMARY KEY`;
49
49
  }
50
50
 
51
+ readonly booleanType = "BOOLEAN";
52
+
53
+ booleanLiteral(value: boolean): string {
54
+ return value ? "TRUE" : "FALSE";
55
+ }
56
+
51
57
  advisoryLockSql(key: number): DialectQuery {
52
58
  return { sql: `SELECT pg_advisory_lock(?)`, params: [key] };
53
59
  }
@@ -48,6 +48,13 @@ export class SqliteDialect implements SqlDialect {
48
48
  return `${column} INTEGER PRIMARY KEY AUTOINCREMENT`;
49
49
  }
50
50
 
51
+ // SQLite has no boolean type — 0/1 in an INTEGER is the storage class it uses.
52
+ readonly booleanType = "INTEGER";
53
+
54
+ booleanLiteral(value: boolean): string {
55
+ return value ? "1" : "0";
56
+ }
57
+
51
58
  advisoryLockSql(): DialectQuery | null {
52
59
  return null;
53
60
  }
@@ -56,6 +56,26 @@ export interface SqlDialect {
56
56
  */
57
57
  autoIncrementColumn(column: string): string;
58
58
 
59
+ /**
60
+ * The column type a portable `table.boolean()` compiles to.
61
+ *
62
+ * SQLite has no boolean type and stores 0/1 in an `INTEGER`, which is why the
63
+ * Blueprint emitted `INTEGER` for every engine. PostgreSQL has a real `boolean`
64
+ * and refuses to compare or assign one against an integer column, so a table
65
+ * built that way rejected its own booleans — `column "active" is of type integer
66
+ * but expression is of type boolean` (SQLSTATE 42804) on the first insert, and
67
+ * again on any `where("active", true)`. Nothing caught it because no test
68
+ * executed the DDL against a server; `postgres.smoke.test.ts` now does.
69
+ *
70
+ * MySQL keeps `INTEGER`: its `BOOLEAN` is a synonym for `TINYINT(1)` and it
71
+ * accepts 0/1 either way, so there is no defect there to fix and no reason to
72
+ * churn the DDL of an engine no CI job covers.
73
+ */
74
+ readonly booleanType: string;
75
+
76
+ /** A boolean as this engine spells it in a `DEFAULT` clause. */
77
+ booleanLiteral(value: boolean): string;
78
+
59
79
  /** Whether the engine supports application-level advisory locks. */
60
80
  readonly supportsAdvisoryLocks: boolean;
61
81
 
@@ -813,26 +813,36 @@ export class ModelQueryBuilder<M extends BaseModel> extends QueryBuilder {
813
813
  );
814
814
  }
815
815
 
816
+ // Relation keys carry the *JS* spelling — `@hasMany(Issue, { foreignKey:
817
+ // "projectId" })` — because that is the convention everywhere else: camelCase
818
+ // in the application, snake_case in the database, converted on the way
819
+ // through. `_column()` does that conversion, but it is an override on
820
+ // *this* class and the subquery below is a plain `QueryBuilder`, so nothing
821
+ // was converting these. The result was a correct-looking decorator emitting
822
+ // `no such column: issues.projectId`, with the error naming a column rather
823
+ // than the relation that produced it.
824
+ const col = (table: string, key: string): string => `${table}.${_toSnakeColumn(key)}`;
825
+
816
826
  if (meta.type === "manyToMany") {
817
827
  const relTable = Related.table;
818
828
  sub = new QueryBuilder(meta.pivotTable!, this._sql)
819
829
  .join(
820
830
  relTable,
821
- `${relTable}.${Related.primaryKey}`,
831
+ col(relTable, Related.primaryKey),
822
832
  "=",
823
- `${meta.pivotTable}.${meta.pivotRelatedKey}`,
833
+ col(meta.pivotTable!, meta.pivotRelatedKey!),
824
834
  )
825
- .whereColumn(`${meta.pivotTable}.${meta.pivotForeignKey}`, `${main}.${meta.localKey}`);
835
+ .whereColumn(col(meta.pivotTable!, meta.pivotForeignKey!), col(main, meta.localKey!));
826
836
  if (Related.softDeletes) sub.whereNull(`${relTable}.deleted_at`);
827
837
  } else {
828
838
  const relTable = Related.table;
829
839
  sub = new QueryBuilder(relTable, this._sql);
830
840
  if (meta.type === "belongsTo") {
831
- sub.whereColumn(`${relTable}.${meta.localKey}`, `${main}.${meta.foreignKey}`);
841
+ sub.whereColumn(col(relTable, meta.localKey!), col(main, meta.foreignKey!));
832
842
  } else {
833
- sub.whereColumn(`${relTable}.${meta.foreignKey}`, `${main}.${meta.localKey}`);
843
+ sub.whereColumn(col(relTable, meta.foreignKey!), col(main, meta.localKey!));
834
844
  if (meta.type === "morphMany" || meta.type === "morphOne") {
835
- sub.where(`${relTable}.${meta.morphTypeColumn}`, this._ModelClass.name);
845
+ sub.where(col(relTable, meta.morphTypeColumn!), this._ModelClass.name);
836
846
  }
837
847
  }
838
848
  if (Related.softDeletes) sub.whereNull(`${relTable}.deleted_at`);
@@ -51,8 +51,22 @@ declare module "@zerotal/core" {
51
51
  */
52
52
  export class DatabaseProvider extends ServiceProvider {
53
53
  static override provides = ["db"] as const;
54
+ /**
55
+ * Every mode, `worker` included.
56
+ *
57
+ * `worker` was missing until 1.7.1, which meant `bun zt queue:work` could not
58
+ * boot at all: the queue's own default driver is `sqlite`, `QueueProvider`
59
+ * does run in `worker`, and it asks for a connection this provider had not
60
+ * made — so the worker died on startup with "No database connection. Is
61
+ * DatabaseProvider registered?" while it plainly was.
62
+ *
63
+ * It was never only the queue. Nine providers run in `worker` — notifications,
64
+ * audit, media, tenancy, scheduler among them — and a job exists to do work
65
+ * with models. A worker without a database is a worker that cannot do the
66
+ * thing workers are for.
67
+ */
54
68
  // Use an explicit mutable array type to satisfy ServiceProvider's static property constraint.
55
- static override environments: AppEnvironment[] = ["web", "console", "test", "repl"];
69
+ static override environments: AppEnvironment[] = ["web", "console", "worker", "test", "repl"];
56
70
 
57
71
  private _disposeObservability: (() => void) | undefined = undefined;
58
72
 
@@ -314,12 +314,15 @@ export class Blueprint {
314
314
  // ── Boolean ───────────────────────────────────────────────────────────────
315
315
 
316
316
  /**
317
- * Boolean column. Stored as `INTEGER` (0 / 1); JS booleans passed to
318
- * {@link ColumnBuilder.default} serialise to `1` / `0`.
317
+ * Boolean column. The storage type is the engine's: `INTEGER` holding 0 / 1 on
318
+ * SQLite and MySQL, a real `BOOLEAN` on PostgreSQL — which rejects the integer
319
+ * form for both assignment and comparison, so emitting `INTEGER` everywhere
320
+ * built a column that would not take its own booleans. JS booleans passed to
321
+ * {@link ColumnBuilder.default} follow the same engine's spelling.
319
322
  * @category Column types
320
323
  */
321
324
  boolean(name: string): ColumnBuilder {
322
- return this._add(new ColumnBuilder(name, "INTEGER"));
325
+ return this._add(new ColumnBuilder(name, "INTEGER", false, false, true));
323
326
  }
324
327
 
325
328
  // ── Date / time columns ───────────────────────────────────────────────────
@@ -64,6 +64,11 @@ export class ColumnBuilder<Locked extends string = never> {
64
64
  private _sqlType: string,
65
65
  isPrimary = false,
66
66
  isAutoIncrement = false,
67
+ /**
68
+ * Logically a boolean, whatever `_sqlType` says. The engine decides the
69
+ * storage type at compile time — see {@link SqlDialect.booleanType}.
70
+ */
71
+ private _isBoolean = false,
67
72
  ) {
68
73
  this._isPrimary = isPrimary;
69
74
  this._isAutoIncr = isAutoIncrement;
@@ -324,13 +329,16 @@ export class ColumnBuilder<Locked extends string = never> {
324
329
  // PostgreSQL a syntax error and against MySQL a 1064.
325
330
  if (this._isAutoIncr) return getDialect(dialect).autoIncrementColumn(this.name);
326
331
 
327
- const parts: string[] = [`${this.name} ${this._sqlType}`];
332
+ // A boolean's storage type is the engine's to choose: SQLite stores 0/1 in an
333
+ // INTEGER, PostgreSQL has a real one and rejects the integer form outright.
334
+ const sqlType = this._isBoolean ? getDialect(dialect).booleanType : this._sqlType;
335
+ const parts: string[] = [`${this.name} ${sqlType}`];
328
336
 
329
337
  if (this._isPrimary) parts.push("PRIMARY KEY");
330
338
  if (!this._isNullable && !this._isPrimary) parts.push("NOT NULL");
331
339
 
332
340
  if (this._useCurrent) parts.push("DEFAULT CURRENT_TIMESTAMP");
333
- else if (this._hasDefault) parts.push(`DEFAULT ${this._serializeDefault()}`);
341
+ else if (this._hasDefault) parts.push(`DEFAULT ${this._serializeDefault(dialect)}`);
334
342
 
335
343
  if (this._isUnique) parts.push("UNIQUE");
336
344
  if (this._check) parts.push(`CHECK (${this._check})`);
@@ -340,10 +348,11 @@ export class ColumnBuilder<Locked extends string = never> {
340
348
  return parts.join(" ");
341
349
  }
342
350
 
343
- private _serializeDefault(): string {
351
+ private _serializeDefault(dialect: DialectName = "sqlite"): string {
344
352
  const v = this._default;
345
353
  if (v === null) return "NULL";
346
- if (typeof v === "boolean") return v ? "1" : "0";
354
+ // `DEFAULT 1` on a PostgreSQL boolean column is the same 42804 the value itself hit.
355
+ if (typeof v === "boolean") return getDialect(dialect).booleanLiteral(v);
347
356
  if (typeof v === "string") return `'${v.replace(/'/g, "''")}'`;
348
357
  return String(v);
349
358
  }