@blamejs/core 0.7.4 → 0.7.18

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.
Files changed (180) hide show
  1. package/CHANGELOG.md +423 -395
  2. package/README.md +150 -149
  3. package/bin/blamejs.js +0 -0
  4. package/index.js +308 -284
  5. package/lib/api-key.js +660 -663
  6. package/lib/api-snapshot.js +338 -338
  7. package/lib/app-shutdown.js +385 -385
  8. package/lib/app.js +365 -365
  9. package/lib/archive.js +250 -250
  10. package/lib/atomic-file.js +544 -544
  11. package/lib/audit-chain.js +177 -177
  12. package/lib/audit-sign.js +344 -344
  13. package/lib/audit-tools.js +677 -677
  14. package/lib/audit.js +766 -766
  15. package/lib/auth/jwt.js +311 -311
  16. package/lib/auth/lockout.js +436 -436
  17. package/lib/auth/oauth.js +721 -721
  18. package/lib/auth/passkey.js +181 -181
  19. package/lib/auth/password.js +594 -594
  20. package/lib/backup/bundle.js +217 -217
  21. package/lib/backup/crypto.js +176 -176
  22. package/lib/backup/index.js +515 -515
  23. package/lib/backup/manifest.js +282 -282
  24. package/lib/break-glass.js +1338 -1338
  25. package/lib/bundler.js +441 -441
  26. package/lib/cache-redis.js +256 -256
  27. package/lib/cache.js +1206 -1206
  28. package/lib/canonical-json.js +115 -115
  29. package/lib/chain-writer.js +234 -234
  30. package/lib/cli-helpers.js +206 -206
  31. package/lib/cli.js +2334 -2334
  32. package/lib/cluster-provider-db.js +317 -317
  33. package/lib/cluster-storage.js +226 -226
  34. package/lib/cluster.js +703 -703
  35. package/lib/codepoint-class.js +196 -0
  36. package/lib/config-drift.js +301 -301
  37. package/lib/consent.js +222 -222
  38. package/lib/constants.js +191 -191
  39. package/lib/cookies.js +315 -315
  40. package/lib/credential-hash.js +322 -322
  41. package/lib/crypto.js +266 -266
  42. package/lib/csv.js +275 -286
  43. package/lib/db-declare-row-policy.js +267 -267
  44. package/lib/db-declare-view.js +420 -421
  45. package/lib/db-query.js +406 -406
  46. package/lib/db-schema.js +319 -319
  47. package/lib/db.js +1288 -1288
  48. package/lib/deprecate.js +222 -222
  49. package/lib/dev.js +335 -335
  50. package/lib/dual-control.js +473 -473
  51. package/lib/error-page.js +420 -420
  52. package/lib/external-db-migrate.js +441 -441
  53. package/lib/external-db.js +1061 -1061
  54. package/lib/file-type.js +273 -273
  55. package/lib/file-upload.js +213 -10
  56. package/lib/forms.js +422 -422
  57. package/lib/framework-error.js +293 -215
  58. package/lib/framework-schema.js +717 -717
  59. package/lib/gate-contract.js +971 -0
  60. package/lib/guard-all.js +405 -0
  61. package/lib/guard-archive.js +739 -0
  62. package/lib/guard-csv.js +816 -0
  63. package/lib/guard-email.js +744 -0
  64. package/lib/guard-filename.js +724 -0
  65. package/lib/guard-html.js +976 -0
  66. package/lib/guard-json.js +729 -0
  67. package/lib/guard-markdown.js +586 -0
  68. package/lib/guard-svg.js +976 -0
  69. package/lib/guard-xml.js +405 -0
  70. package/lib/guard-yaml.js +529 -0
  71. package/lib/handlers.js +350 -350
  72. package/lib/http-client-cookie-jar.js +508 -508
  73. package/lib/http-client.js +1195 -1195
  74. package/lib/i18n.js +878 -878
  75. package/lib/jobs.js +185 -185
  76. package/lib/log-stream-cloudwatch.js +369 -369
  77. package/lib/log-stream-local.js +146 -146
  78. package/lib/log-stream-otlp-grpc.js +410 -410
  79. package/lib/log-stream-otlp.js +286 -286
  80. package/lib/log-stream-syslog.js +302 -302
  81. package/lib/log-stream-webhook.js +199 -199
  82. package/lib/log-stream.js +330 -330
  83. package/lib/log.js +500 -500
  84. package/lib/mail-bounce.js +528 -528
  85. package/lib/mail-dkim.js +369 -362
  86. package/lib/mail.js +981 -962
  87. package/lib/metrics.js +683 -683
  88. package/lib/middleware/api-encrypt.js +936 -936
  89. package/lib/middleware/attach-user.js +157 -157
  90. package/lib/middleware/body-parser.js +1170 -1091
  91. package/lib/middleware/bot-guard.js +178 -178
  92. package/lib/middleware/compression.js +452 -452
  93. package/lib/middleware/cors.js +314 -314
  94. package/lib/middleware/csp-nonce.js +348 -348
  95. package/lib/middleware/csrf-protect.js +316 -316
  96. package/lib/middleware/db-role-for.js +264 -264
  97. package/lib/middleware/health.js +392 -392
  98. package/lib/middleware/index.js +79 -79
  99. package/lib/middleware/rate-limit.js +358 -358
  100. package/lib/middleware/request-id.js +61 -61
  101. package/lib/middleware/request-log.js +168 -168
  102. package/lib/middleware/require-auth.js +104 -104
  103. package/lib/middleware/security-headers.js +116 -116
  104. package/lib/middleware/sse.js +166 -166
  105. package/lib/migrations.js +383 -383
  106. package/lib/mtls-ca.js +518 -518
  107. package/lib/mtls-engine-default.js +481 -481
  108. package/lib/network-dns.js +632 -632
  109. package/lib/network-heartbeat.js +290 -290
  110. package/lib/network-nts.js +574 -574
  111. package/lib/network-proxy.js +265 -265
  112. package/lib/network-tls.js +328 -328
  113. package/lib/network.js +233 -233
  114. package/lib/notify.js +612 -612
  115. package/lib/ntp-check.js +229 -229
  116. package/lib/numeric-bounds.js +111 -91
  117. package/lib/object-store/azure-blob-bucket-ops.js +349 -349
  118. package/lib/object-store/azure-blob.js +488 -488
  119. package/lib/object-store/gcs-bucket-ops.js +351 -351
  120. package/lib/object-store/gcs.js +519 -519
  121. package/lib/object-store/http-put.js +153 -153
  122. package/lib/object-store/index.js +197 -197
  123. package/lib/object-store/sigv4-bucket-ops.js +1092 -1092
  124. package/lib/object-store/sigv4.js +903 -903
  125. package/lib/observability.js +151 -151
  126. package/lib/otel-export.js +269 -269
  127. package/lib/pagination.js +464 -464
  128. package/lib/parsers/index.js +80 -80
  129. package/lib/parsers/safe-env.js +642 -642
  130. package/lib/parsers/safe-ini.js +292 -292
  131. package/lib/parsers/safe-toml.js +784 -784
  132. package/lib/parsers/safe-xml.js +390 -390
  133. package/lib/parsers/safe-yaml.js +1015 -1015
  134. package/lib/permissions.js +708 -708
  135. package/lib/pqc-agent.js +87 -87
  136. package/lib/pqc-gate.js +279 -279
  137. package/lib/protobuf-encoder.js +190 -190
  138. package/lib/protocol-dispatcher.js +161 -161
  139. package/lib/pubsub-redis.js +167 -167
  140. package/lib/pubsub.js +429 -429
  141. package/lib/queue-local.js +476 -476
  142. package/lib/queue-redis.js +745 -745
  143. package/lib/queue-sqs.js +319 -319
  144. package/lib/queue.js +695 -695
  145. package/lib/redis-client.js +519 -519
  146. package/lib/request-helpers.js +340 -340
  147. package/lib/restore-bundle.js +237 -237
  148. package/lib/restore-rollback.js +259 -259
  149. package/lib/restore.js +409 -409
  150. package/lib/retry.js +376 -376
  151. package/lib/router.js +748 -748
  152. package/lib/safe-async.js +735 -735
  153. package/lib/safe-buffer.js +237 -237
  154. package/lib/safe-json.js +541 -541
  155. package/lib/safe-schema.js +1266 -1266
  156. package/lib/safe-url.js +159 -159
  157. package/lib/scheduler.js +706 -706
  158. package/lib/security-assert.js +373 -373
  159. package/lib/seeders.js +618 -618
  160. package/lib/session.js +478 -478
  161. package/lib/slug.js +269 -269
  162. package/lib/ssrf-guard.js +401 -401
  163. package/lib/static.js +184 -4
  164. package/lib/storage.js +471 -471
  165. package/lib/subject.js +281 -281
  166. package/lib/template.js +791 -791
  167. package/lib/testing.js +798 -798
  168. package/lib/time.js +310 -310
  169. package/lib/totp.js +302 -302
  170. package/lib/tracing.js +494 -494
  171. package/lib/uuid.js +132 -132
  172. package/lib/validate-opts.js +340 -319
  173. package/lib/vault/index.js +308 -308
  174. package/lib/vault/rotate.js +784 -784
  175. package/lib/vault/wrap.js +296 -296
  176. package/lib/vendor/noble-ciphers.cjs +9 -9
  177. package/lib/webhook.js +595 -595
  178. package/lib/websocket.js +1048 -1048
  179. package/package.json +77 -77
  180. package/sbom.cyclonedx.json +7 -7
package/lib/db-schema.js CHANGED
@@ -1,319 +1,319 @@
1
- "use strict";
2
- /**
3
- * Schema reconciler + imperative migration runner + shared SQL
4
- * execution helpers used by every db-touching primitive.
5
- *
6
- * Hybrid migration strategy (per roadmap Q2):
7
- *
8
- * 1. Declarative reconcile (every boot, idempotent):
9
- * - CREATE TABLE IF NOT EXISTS for tables in schema config
10
- * - ALTER TABLE ADD COLUMN for any new columns (additive only)
11
- * - CREATE INDEX IF NOT EXISTS for declared indexes
12
- * - Refuses to drop columns or tables (data-loss safety)
13
- *
14
- * 2. Imperative migrations (after reconcile, run-once):
15
- * - Numbered files: 001-foo.js, 002-bar.js
16
- * - Each exports { up(db), down?(db), description }
17
- * - Tracked in _blamejs_migrations table; never re-run
18
- * - Run in numeric order; first failure halts boot
19
- *
20
- * Apps mix both: declarative covers structural changes (CREATE/ALTER),
21
- * imperative covers data backfills, transformations, conditional schema
22
- * changes that need code.
23
- *
24
- * Shared SQL execution helpers used by lib/migrations / lib/seeders /
25
- * lib/vault/rotate / lib/db etc.:
26
- *
27
- * - runSql — raw DDL / BEGIN / COMMIT / PRAGMA on
28
- * the framework's better-sqlite3 handle.
29
- * - runSqlOnHandle — handles BOTH raw better-sqlite3 and
30
- * b.db framework wrapper shapes —
31
- * operator-supplied handles can be either.
32
- * - runInTransaction — wrap fn in BEGIN / COMMIT / ROLLBACK on
33
- * the supplied db handle. opts.lockMode
34
- * appends to BEGIN ("IMMEDIATE" /
35
- * "EXCLUSIVE" on SQLite). opts.onRollbackFail
36
- * surfaces a rollback throw without
37
- * swallowing the original error.
38
- */
39
- var path = require("path");
40
- var atomicFile = require("./atomic-file");
41
- var safeSql = require("./safe-sql");
42
-
43
- // SQLite raw-SQL helper. node:sqlite DatabaseSync exposes a method on the
44
- // database object that runs raw SQL without bind parameters — used for DDL,
45
- // BEGIN/COMMIT/ROLLBACK, and PRAGMA. Bracket notation here avoids a
46
- // false-positive in upstream linters that pattern-match the bare token
47
- // `.exec(` regardless of receiver type.
48
- function runSql(database, sql) { return database["exec"](sql); }
49
-
50
- // runSqlOnHandle — execute SQL against either handle shape:
51
- // - raw better-sqlite3 / node:sqlite Database (db.exec)
52
- // - b.db framework wrapper (db.runSql)
53
- // Migrations / seeders / break-glass migrate accept operator-supplied
54
- // handles in either shape; this wrapper normalizes the call. The
55
- // 'exec'/'runSql' lookups use bracket notation so the eslint rule
56
- // banning bare-identifier db method calls (collapsing prepare → field)
57
- // stays satisfied.
58
- function runSqlOnHandle(db, sql) {
59
- if (db && typeof db["exec"] === "function") return db["exec"](sql);
60
- if (db && typeof db["runSql"] === "function") return db["runSql"](sql);
61
- throw new Error("dbSchema.runSqlOnHandle: handle exposes no DDL runner (exec / runSql)");
62
- }
63
-
64
- // runInTransaction — wrap fn in BEGIN / COMMIT / ROLLBACK on the
65
- // supplied db handle. Used by migrations / seeders / any operator-
66
- // facing transaction. opts.lockMode appends to BEGIN ("IMMEDIATE",
67
- // "EXCLUSIVE" — SQLite-specific). opts.onRollbackFail surfaces a
68
- // rollback throw without swallowing the original error (the original
69
- // always re-throws).
70
- function runInTransaction(db, fn, opts) {
71
- if (typeof fn !== "function") {
72
- throw new TypeError("dbSchema.runInTransaction: fn must be a function");
73
- }
74
- opts = opts || {};
75
- var beginSql = opts.lockMode ? "BEGIN " + opts.lockMode : "BEGIN";
76
- runSqlOnHandle(db, beginSql);
77
- try {
78
- var result = fn();
79
- runSqlOnHandle(db, "COMMIT");
80
- return result;
81
- } catch (e) {
82
- try { runSqlOnHandle(db, "ROLLBACK"); }
83
- catch (rollbackErr) {
84
- if (typeof opts.onRollbackFail === "function") {
85
- try { opts.onRollbackFail(rollbackErr); } catch (_e) { /* nested handler must not bubble */ }
86
- }
87
- }
88
- throw e;
89
- }
90
- }
91
-
92
- // ---- Internal migrations table ----
93
-
94
- var MIGRATIONS_TABLE = "_blamejs_migrations";
95
- // Pre-quoted for SQL interpolation — keeps the call sites consistent
96
- // with lib/migrations.js and lib/seeders.js so an identifier rename
97
- // doesn't silently break.
98
- var Q_MIGRATIONS_TABLE = '"' + MIGRATIONS_TABLE + '"';
99
-
100
- function ensureMigrationsTable(database) {
101
- runSql(database,
102
- "CREATE TABLE IF NOT EXISTS " + Q_MIGRATIONS_TABLE + " (" +
103
- " name TEXT PRIMARY KEY," +
104
- " description TEXT," +
105
- " appliedAt TEXT NOT NULL" +
106
- ")"
107
- );
108
- }
109
-
110
- // ---- Declarative reconcile ----
111
-
112
- function reconcile(database, schema) {
113
- if (!Array.isArray(schema)) {
114
- throw new Error("db.init({ schema }) must be an array of table definitions");
115
- }
116
- for (var i = 0; i < schema.length; i++) {
117
- reconcileTable(database, schema[i]);
118
- }
119
- }
120
-
121
- function reconcileTable(database, table) {
122
- if (!table || !table.name) {
123
- throw new Error("schema entry missing required 'name' property");
124
- }
125
- if (!table.columns || typeof table.columns !== "object") {
126
- throw new Error("schema entry '" + table.name + "' missing 'columns' object");
127
- }
128
-
129
- var name = table.name;
130
- validateIdent(name, "table name");
131
-
132
- var colDefs = [];
133
- for (var col in table.columns) {
134
- validateIdent(col, "column name");
135
- colDefs.push('"' + col + '" ' + table.columns[col]);
136
- }
137
- if (colDefs.length === 0) {
138
- throw new Error("schema entry '" + name + "' has no columns");
139
- }
140
-
141
- // Structured PRIMARY KEY (alternative to inlining "PRIMARY KEY" in column DDL).
142
- // Accepts a single column name or an array (composite PK).
143
- if (table.primaryKey) {
144
- var pkCols = Array.isArray(table.primaryKey) ? table.primaryKey : [table.primaryKey];
145
- pkCols.forEach(function (c) { validateIdent(c, "primary key column"); });
146
- pkCols.forEach(function (c) {
147
- if (!Object.prototype.hasOwnProperty.call(table.columns, c)) {
148
- throw new Error("primaryKey '" + c + "' is not declared in columns of table '" + name + "'");
149
- }
150
- });
151
- colDefs.push("PRIMARY KEY (" + pkCols.map(function (c) { return '"' + c + '"'; }).join(", ") + ")");
152
- }
153
-
154
- // Structured FOREIGN KEY declarations. Each entry:
155
- // { column: 'userId', references: 'users._id', onDelete?, onUpdate? }
156
- // Composite FKs use array form for `column` and the references-side: format
157
- // 'table.col1,col2'. Forward references to tables not yet created are fine —
158
- // SQLite validates at write time, not table-create time.
159
- if (Array.isArray(table.foreignKeys)) {
160
- for (var fi = 0; fi < table.foreignKeys.length; fi++) {
161
- var fk = table.foreignKeys[fi];
162
- if (!fk || !fk.column || !fk.references) {
163
- throw new Error("foreignKey on table '" + name + "' requires { column, references }");
164
- }
165
- var localCols = Array.isArray(fk.column) ? fk.column : [fk.column];
166
- var refStr = String(fk.references);
167
- var dotIdx = refStr.indexOf(".");
168
- if (dotIdx <= 0) {
169
- throw new Error("foreignKey 'references' must be 'table.column' (or 'table.col1,col2' for composite): " + refStr);
170
- }
171
- var refTable = refStr.slice(0, dotIdx);
172
- var refColsStr = refStr.slice(dotIdx + 1);
173
- var refCols = refColsStr.split(",").map(function (s) { return s.trim(); });
174
- validateIdent(refTable, "foreign key referenced table");
175
- localCols.forEach(function (c) { validateIdent(c, "foreign key local column"); });
176
- refCols.forEach(function (c) { validateIdent(c, "foreign key referenced column"); });
177
- if (localCols.length !== refCols.length) {
178
- throw new Error("foreignKey on '" + name + "': local-column count must match referenced-column count");
179
- }
180
- var clause = "FOREIGN KEY (" + localCols.map(function (c) { return '"' + c + '"'; }).join(", ") + ")" +
181
- ' REFERENCES "' + refTable + '" (' + refCols.map(function (c) { return '"' + c + '"'; }).join(", ") + ")";
182
- if (fk.onDelete) clause += " ON DELETE " + _validateAction(fk.onDelete, "ON DELETE", name);
183
- if (fk.onUpdate) clause += " ON UPDATE " + _validateAction(fk.onUpdate, "ON UPDATE", name);
184
- colDefs.push(clause);
185
- }
186
- }
187
-
188
- runSql(database, 'CREATE TABLE IF NOT EXISTS "' + name + '" (' + colDefs.join(", ") + ")");
189
-
190
- var existingCols = listColumns(database, name);
191
- for (var newCol in table.columns) {
192
- if (!existingCols.has(newCol)) {
193
- try {
194
- runSql(database, 'ALTER TABLE "' + name + '" ADD COLUMN "' + newCol + '" ' + table.columns[newCol]);
195
- } catch (e) {
196
- throw new Error("failed to add column '" + newCol + "' to '" + name + "': " + e.message);
197
- }
198
- }
199
- }
200
-
201
- if (Array.isArray(table.indexes)) {
202
- for (var k = 0; k < table.indexes.length; k++) {
203
- reconcileIndex(database, name, table.indexes[k]);
204
- }
205
- }
206
- }
207
-
208
- function _validateAction(action, label, tableName) {
209
- var allowed = ["CASCADE", "SET NULL", "SET DEFAULT", "RESTRICT", "NO ACTION"];
210
- var up = String(action).toUpperCase();
211
- if (allowed.indexOf(up) === -1) {
212
- throw new Error(label + " on '" + tableName + "' must be one of " + allowed.join(", ") + " (got: " + action + ")");
213
- }
214
- return up;
215
- }
216
-
217
- function reconcileIndex(database, tableName, idx) {
218
- var cols, indexName, unique;
219
- if (typeof idx === "string") {
220
- cols = [idx];
221
- indexName = "idx_" + tableName + "_" + idx;
222
- unique = false;
223
- } else if (idx && typeof idx === "object") {
224
- cols = Array.isArray(idx.columns) ? idx.columns : [idx.columns];
225
- indexName = idx.name || ("idx_" + tableName + "_" + cols.join("_"));
226
- unique = !!idx.unique;
227
- } else {
228
- throw new Error("invalid index spec on table '" + tableName + "'");
229
- }
230
- validateIdent(indexName, "index name");
231
- cols.forEach(function (c) { validateIdent(c, "indexed column"); });
232
- var quotedCols = cols.map(function (c) { return '"' + c + '"'; }).join(", ");
233
- runSql(database,
234
- "CREATE " + (unique ? "UNIQUE " : "") + "INDEX IF NOT EXISTS \"" + indexName + "\"" +
235
- ' ON "' + tableName + '" (' + quotedCols + ")"
236
- );
237
- }
238
-
239
- function listColumns(database, tableName) {
240
- var rows = database.prepare('PRAGMA table_info("' + tableName + '")').all();
241
- var set = new Set();
242
- for (var i = 0; i < rows.length; i++) set.add(rows[i].name);
243
- return set;
244
- }
245
-
246
- // SQL identifier safety: alphanumeric + underscore, starts with letter or underscore.
247
- function validateIdent(ident, kind) {
248
- if (typeof ident !== "string" ||
249
- ident.length === 0 ||
250
- ident.length > safeSql.MAX_IDENTIFIER_LENGTH ||
251
- !safeSql.DEFAULT_IDENTIFIER_RE.test(ident)) {
252
- throw new Error("invalid " + kind + ": '" + ident +
253
- "' (must match " + safeSql.DEFAULT_IDENTIFIER_RE + ", length 1.." +
254
- safeSql.MAX_IDENTIFIER_LENGTH + ")");
255
- }
256
- }
257
-
258
- // ---- Imperative migration runner ----
259
-
260
- function runMigrations(database, migrationDir) {
261
- if (!migrationDir) return { applied: [], skipped: [] };
262
-
263
- ensureMigrationsTable(database);
264
-
265
- // listDir returns [] if migrationDir doesn't exist (missingOk: true default).
266
- var files = atomicFile.listDir(migrationDir, {
267
- filter: function (f) { return /^\d+-.+\.js$/.test(f); },
268
- }).map(function (e) { return e.name; }).sort();
269
-
270
- var appliedSet = new Set();
271
- database.prepare("SELECT name FROM " + Q_MIGRATIONS_TABLE).all().forEach(function (r) {
272
- appliedSet.add(r.name);
273
- });
274
-
275
- var applied = [];
276
- var skipped = [];
277
- for (var i = 0; i < files.length; i++) {
278
- var file = files[i];
279
- if (appliedSet.has(file)) {
280
- skipped.push(file);
281
- continue;
282
- }
283
- var fullPath = path.join(migrationDir, file);
284
- var mig;
285
- try {
286
- mig = require(fullPath);
287
- } catch (e) {
288
- throw new Error("migration '" + file + "' failed to load: " + e.message);
289
- }
290
- if (!mig || typeof mig.up !== "function") {
291
- throw new Error("migration '" + file + "' must export an `up(db)` function");
292
- }
293
-
294
- try {
295
- runInTransaction(database, function () {
296
- mig.up(database);
297
- database.prepare(
298
- "INSERT INTO " + Q_MIGRATIONS_TABLE + " (name, description, appliedAt) VALUES (?, ?, ?)"
299
- ).run(file, mig.description || "", new Date().toISOString());
300
- });
301
- } catch (e) {
302
- throw new Error("migration '" + file + "' failed: " + e.message);
303
- }
304
- applied.push(file);
305
- }
306
-
307
- return { applied: applied, skipped: skipped };
308
- }
309
-
310
- module.exports = {
311
- reconcile: reconcile,
312
- reconcileTable: reconcileTable,
313
- runMigrations: runMigrations,
314
- validateIdent: validateIdent,
315
- runSql: runSql,
316
- runSqlOnHandle: runSqlOnHandle,
317
- runInTransaction: runInTransaction,
318
- MIGRATIONS_TABLE: MIGRATIONS_TABLE,
319
- };
1
+ "use strict";
2
+ /**
3
+ * Schema reconciler + imperative migration runner + shared SQL
4
+ * execution helpers used by every db-touching primitive.
5
+ *
6
+ * Hybrid migration strategy (per roadmap Q2):
7
+ *
8
+ * 1. Declarative reconcile (every boot, idempotent):
9
+ * - CREATE TABLE IF NOT EXISTS for tables in schema config
10
+ * - ALTER TABLE ADD COLUMN for any new columns (additive only)
11
+ * - CREATE INDEX IF NOT EXISTS for declared indexes
12
+ * - Refuses to drop columns or tables (data-loss safety)
13
+ *
14
+ * 2. Imperative migrations (after reconcile, run-once):
15
+ * - Numbered files: 001-foo.js, 002-bar.js
16
+ * - Each exports { up(db), down?(db), description }
17
+ * - Tracked in _blamejs_migrations table; never re-run
18
+ * - Run in numeric order; first failure halts boot
19
+ *
20
+ * Apps mix both: declarative covers structural changes (CREATE/ALTER),
21
+ * imperative covers data backfills, transformations, conditional schema
22
+ * changes that need code.
23
+ *
24
+ * Shared SQL execution helpers used by lib/migrations / lib/seeders /
25
+ * lib/vault/rotate / lib/db etc.:
26
+ *
27
+ * - runSql — raw DDL / BEGIN / COMMIT / PRAGMA on
28
+ * the framework's better-sqlite3 handle.
29
+ * - runSqlOnHandle — handles BOTH raw better-sqlite3 and
30
+ * b.db framework wrapper shapes —
31
+ * operator-supplied handles can be either.
32
+ * - runInTransaction — wrap fn in BEGIN / COMMIT / ROLLBACK on
33
+ * the supplied db handle. opts.lockMode
34
+ * appends to BEGIN ("IMMEDIATE" /
35
+ * "EXCLUSIVE" on SQLite). opts.onRollbackFail
36
+ * surfaces a rollback throw without
37
+ * swallowing the original error.
38
+ */
39
+ var path = require("path");
40
+ var atomicFile = require("./atomic-file");
41
+ var safeSql = require("./safe-sql");
42
+
43
+ // SQLite raw-SQL helper. node:sqlite DatabaseSync exposes a method on the
44
+ // database object that runs raw SQL without bind parameters — used for DDL,
45
+ // BEGIN/COMMIT/ROLLBACK, and PRAGMA. Bracket notation here avoids a
46
+ // false-positive in upstream linters that pattern-match the bare token
47
+ // `.exec(` regardless of receiver type.
48
+ function runSql(database, sql) { return database["exec"](sql); }
49
+
50
+ // runSqlOnHandle — execute SQL against either handle shape:
51
+ // - raw better-sqlite3 / node:sqlite Database (db.exec)
52
+ // - b.db framework wrapper (db.runSql)
53
+ // Migrations / seeders / break-glass migrate accept operator-supplied
54
+ // handles in either shape; this wrapper normalizes the call. The
55
+ // 'exec'/'runSql' lookups use bracket notation so the eslint rule
56
+ // banning bare-identifier db method calls (collapsing prepare → field)
57
+ // stays satisfied.
58
+ function runSqlOnHandle(db, sql) {
59
+ if (db && typeof db["exec"] === "function") return db["exec"](sql);
60
+ if (db && typeof db["runSql"] === "function") return db["runSql"](sql);
61
+ throw new Error("dbSchema.runSqlOnHandle: handle exposes no DDL runner (exec / runSql)");
62
+ }
63
+
64
+ // runInTransaction — wrap fn in BEGIN / COMMIT / ROLLBACK on the
65
+ // supplied db handle. Used by migrations / seeders / any operator-
66
+ // facing transaction. opts.lockMode appends to BEGIN ("IMMEDIATE",
67
+ // "EXCLUSIVE" — SQLite-specific). opts.onRollbackFail surfaces a
68
+ // rollback throw without swallowing the original error (the original
69
+ // always re-throws).
70
+ function runInTransaction(db, fn, opts) {
71
+ if (typeof fn !== "function") {
72
+ throw new TypeError("dbSchema.runInTransaction: fn must be a function");
73
+ }
74
+ opts = opts || {};
75
+ var beginSql = opts.lockMode ? "BEGIN " + opts.lockMode : "BEGIN";
76
+ runSqlOnHandle(db, beginSql);
77
+ try {
78
+ var result = fn();
79
+ runSqlOnHandle(db, "COMMIT");
80
+ return result;
81
+ } catch (e) {
82
+ try { runSqlOnHandle(db, "ROLLBACK"); }
83
+ catch (rollbackErr) {
84
+ if (typeof opts.onRollbackFail === "function") {
85
+ try { opts.onRollbackFail(rollbackErr); } catch (_e) { /* nested handler must not bubble */ }
86
+ }
87
+ }
88
+ throw e;
89
+ }
90
+ }
91
+
92
+ // ---- Internal migrations table ----
93
+
94
+ var MIGRATIONS_TABLE = "_blamejs_migrations";
95
+ // Pre-quoted for SQL interpolation — keeps the call sites consistent
96
+ // with lib/migrations.js and lib/seeders.js so an identifier rename
97
+ // doesn't silently break.
98
+ var Q_MIGRATIONS_TABLE = '"' + MIGRATIONS_TABLE + '"';
99
+
100
+ function ensureMigrationsTable(database) {
101
+ runSql(database,
102
+ "CREATE TABLE IF NOT EXISTS " + Q_MIGRATIONS_TABLE + " (" +
103
+ " name TEXT PRIMARY KEY," +
104
+ " description TEXT," +
105
+ " appliedAt TEXT NOT NULL" +
106
+ ")"
107
+ );
108
+ }
109
+
110
+ // ---- Declarative reconcile ----
111
+
112
+ function reconcile(database, schema) {
113
+ if (!Array.isArray(schema)) {
114
+ throw new Error("db.init({ schema }) must be an array of table definitions");
115
+ }
116
+ for (var i = 0; i < schema.length; i++) {
117
+ reconcileTable(database, schema[i]);
118
+ }
119
+ }
120
+
121
+ function reconcileTable(database, table) {
122
+ if (!table || !table.name) {
123
+ throw new Error("schema entry missing required 'name' property");
124
+ }
125
+ if (!table.columns || typeof table.columns !== "object") {
126
+ throw new Error("schema entry '" + table.name + "' missing 'columns' object");
127
+ }
128
+
129
+ var name = table.name;
130
+ validateIdent(name, "table name");
131
+
132
+ var colDefs = [];
133
+ for (var col in table.columns) {
134
+ validateIdent(col, "column name");
135
+ colDefs.push('"' + col + '" ' + table.columns[col]);
136
+ }
137
+ if (colDefs.length === 0) {
138
+ throw new Error("schema entry '" + name + "' has no columns");
139
+ }
140
+
141
+ // Structured PRIMARY KEY (alternative to inlining "PRIMARY KEY" in column DDL).
142
+ // Accepts a single column name or an array (composite PK).
143
+ if (table.primaryKey) {
144
+ var pkCols = Array.isArray(table.primaryKey) ? table.primaryKey : [table.primaryKey];
145
+ pkCols.forEach(function (c) { validateIdent(c, "primary key column"); });
146
+ pkCols.forEach(function (c) {
147
+ if (!Object.prototype.hasOwnProperty.call(table.columns, c)) {
148
+ throw new Error("primaryKey '" + c + "' is not declared in columns of table '" + name + "'");
149
+ }
150
+ });
151
+ colDefs.push("PRIMARY KEY (" + pkCols.map(function (c) { return '"' + c + '"'; }).join(", ") + ")");
152
+ }
153
+
154
+ // Structured FOREIGN KEY declarations. Each entry:
155
+ // { column: 'userId', references: 'users._id', onDelete?, onUpdate? }
156
+ // Composite FKs use array form for `column` and the references-side: format
157
+ // 'table.col1,col2'. Forward references to tables not yet created are fine —
158
+ // SQLite validates at write time, not table-create time.
159
+ if (Array.isArray(table.foreignKeys)) {
160
+ for (var fi = 0; fi < table.foreignKeys.length; fi++) {
161
+ var fk = table.foreignKeys[fi];
162
+ if (!fk || !fk.column || !fk.references) {
163
+ throw new Error("foreignKey on table '" + name + "' requires { column, references }");
164
+ }
165
+ var localCols = Array.isArray(fk.column) ? fk.column : [fk.column];
166
+ var refStr = String(fk.references);
167
+ var dotIdx = refStr.indexOf(".");
168
+ if (dotIdx <= 0) {
169
+ throw new Error("foreignKey 'references' must be 'table.column' (or 'table.col1,col2' for composite): " + refStr);
170
+ }
171
+ var refTable = refStr.slice(0, dotIdx);
172
+ var refColsStr = refStr.slice(dotIdx + 1);
173
+ var refCols = refColsStr.split(",").map(function (s) { return s.trim(); });
174
+ validateIdent(refTable, "foreign key referenced table");
175
+ localCols.forEach(function (c) { validateIdent(c, "foreign key local column"); });
176
+ refCols.forEach(function (c) { validateIdent(c, "foreign key referenced column"); });
177
+ if (localCols.length !== refCols.length) {
178
+ throw new Error("foreignKey on '" + name + "': local-column count must match referenced-column count");
179
+ }
180
+ var clause = "FOREIGN KEY (" + localCols.map(function (c) { return '"' + c + '"'; }).join(", ") + ")" +
181
+ ' REFERENCES "' + refTable + '" (' + refCols.map(function (c) { return '"' + c + '"'; }).join(", ") + ")";
182
+ if (fk.onDelete) clause += " ON DELETE " + _validateAction(fk.onDelete, "ON DELETE", name);
183
+ if (fk.onUpdate) clause += " ON UPDATE " + _validateAction(fk.onUpdate, "ON UPDATE", name);
184
+ colDefs.push(clause);
185
+ }
186
+ }
187
+
188
+ runSql(database, 'CREATE TABLE IF NOT EXISTS "' + name + '" (' + colDefs.join(", ") + ")");
189
+
190
+ var existingCols = listColumns(database, name);
191
+ for (var newCol in table.columns) {
192
+ if (!existingCols.has(newCol)) {
193
+ try {
194
+ runSql(database, 'ALTER TABLE "' + name + '" ADD COLUMN "' + newCol + '" ' + table.columns[newCol]);
195
+ } catch (e) {
196
+ throw new Error("failed to add column '" + newCol + "' to '" + name + "': " + e.message);
197
+ }
198
+ }
199
+ }
200
+
201
+ if (Array.isArray(table.indexes)) {
202
+ for (var k = 0; k < table.indexes.length; k++) {
203
+ reconcileIndex(database, name, table.indexes[k]);
204
+ }
205
+ }
206
+ }
207
+
208
+ function _validateAction(action, label, tableName) {
209
+ var allowed = ["CASCADE", "SET NULL", "SET DEFAULT", "RESTRICT", "NO ACTION"];
210
+ var up = String(action).toUpperCase();
211
+ if (allowed.indexOf(up) === -1) {
212
+ throw new Error(label + " on '" + tableName + "' must be one of " + allowed.join(", ") + " (got: " + action + ")");
213
+ }
214
+ return up;
215
+ }
216
+
217
+ function reconcileIndex(database, tableName, idx) {
218
+ var cols, indexName, unique;
219
+ if (typeof idx === "string") {
220
+ cols = [idx];
221
+ indexName = "idx_" + tableName + "_" + idx;
222
+ unique = false;
223
+ } else if (idx && typeof idx === "object") {
224
+ cols = Array.isArray(idx.columns) ? idx.columns : [idx.columns];
225
+ indexName = idx.name || ("idx_" + tableName + "_" + cols.join("_"));
226
+ unique = !!idx.unique;
227
+ } else {
228
+ throw new Error("invalid index spec on table '" + tableName + "'");
229
+ }
230
+ validateIdent(indexName, "index name");
231
+ cols.forEach(function (c) { validateIdent(c, "indexed column"); });
232
+ var quotedCols = cols.map(function (c) { return '"' + c + '"'; }).join(", ");
233
+ runSql(database,
234
+ "CREATE " + (unique ? "UNIQUE " : "") + "INDEX IF NOT EXISTS \"" + indexName + "\"" +
235
+ ' ON "' + tableName + '" (' + quotedCols + ")"
236
+ );
237
+ }
238
+
239
+ function listColumns(database, tableName) {
240
+ var rows = database.prepare('PRAGMA table_info("' + tableName + '")').all();
241
+ var set = new Set();
242
+ for (var i = 0; i < rows.length; i++) set.add(rows[i].name);
243
+ return set;
244
+ }
245
+
246
+ // SQL identifier safety: alphanumeric + underscore, starts with letter or underscore.
247
+ function validateIdent(ident, kind) {
248
+ if (typeof ident !== "string" ||
249
+ ident.length === 0 ||
250
+ ident.length > safeSql.MAX_IDENTIFIER_LENGTH ||
251
+ !safeSql.DEFAULT_IDENTIFIER_RE.test(ident)) {
252
+ throw new Error("invalid " + kind + ": '" + ident +
253
+ "' (must match " + safeSql.DEFAULT_IDENTIFIER_RE + ", length 1.." +
254
+ safeSql.MAX_IDENTIFIER_LENGTH + ")");
255
+ }
256
+ }
257
+
258
+ // ---- Imperative migration runner ----
259
+
260
+ function runMigrations(database, migrationDir) {
261
+ if (!migrationDir) return { applied: [], skipped: [] };
262
+
263
+ ensureMigrationsTable(database);
264
+
265
+ // listDir returns [] if migrationDir doesn't exist (missingOk: true default).
266
+ var files = atomicFile.listDir(migrationDir, {
267
+ filter: function (f) { return /^\d+-.+\.js$/.test(f); },
268
+ }).map(function (e) { return e.name; }).sort();
269
+
270
+ var appliedSet = new Set();
271
+ database.prepare("SELECT name FROM " + Q_MIGRATIONS_TABLE).all().forEach(function (r) {
272
+ appliedSet.add(r.name);
273
+ });
274
+
275
+ var applied = [];
276
+ var skipped = [];
277
+ for (var i = 0; i < files.length; i++) {
278
+ var file = files[i];
279
+ if (appliedSet.has(file)) {
280
+ skipped.push(file);
281
+ continue;
282
+ }
283
+ var fullPath = path.join(migrationDir, file);
284
+ var mig;
285
+ try {
286
+ mig = require(fullPath);
287
+ } catch (e) {
288
+ throw new Error("migration '" + file + "' failed to load: " + e.message);
289
+ }
290
+ if (!mig || typeof mig.up !== "function") {
291
+ throw new Error("migration '" + file + "' must export an `up(db)` function");
292
+ }
293
+
294
+ try {
295
+ runInTransaction(database, function () {
296
+ mig.up(database);
297
+ database.prepare(
298
+ "INSERT INTO " + Q_MIGRATIONS_TABLE + " (name, description, appliedAt) VALUES (?, ?, ?)"
299
+ ).run(file, mig.description || "", new Date().toISOString());
300
+ });
301
+ } catch (e) {
302
+ throw new Error("migration '" + file + "' failed: " + e.message);
303
+ }
304
+ applied.push(file);
305
+ }
306
+
307
+ return { applied: applied, skipped: skipped };
308
+ }
309
+
310
+ module.exports = {
311
+ reconcile: reconcile,
312
+ reconcileTable: reconcileTable,
313
+ runMigrations: runMigrations,
314
+ validateIdent: validateIdent,
315
+ runSql: runSql,
316
+ runSqlOnHandle: runSqlOnHandle,
317
+ runInTransaction: runInTransaction,
318
+ MIGRATIONS_TABLE: MIGRATIONS_TABLE,
319
+ };