@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/app.js CHANGED
@@ -1,365 +1,365 @@
1
- "use strict";
2
- /**
3
- * createApp — factory that wires the framework's primitives into a
4
- * runnable application.
5
- *
6
- * Without this factory an operator boots the framework manually:
7
- *
8
- * await b.vault.init({...});
9
- * if (cluster mode) b.externalDb.init({...});
10
- * if (cluster mode) await b.cluster.init({...});
11
- * if (cluster mode) await b.frameworkSchema.ensureSchema({...});
12
- * await b.db.init({...});
13
- * var r = new b.router.Router();
14
- * r.use(b.middleware.requestId());
15
- * r.use(b.middleware.securityHeaders());
16
- * r.use(b.middleware.botGuard());
17
- * yourRoutes(r);
18
- * r.onError(b.middleware.errorHandler());
19
- * var server = r.listen(port, ...);
20
- *
21
- * createApp collapses that into:
22
- *
23
- * var app = await createApp({
24
- * dataDir: "./data",
25
- * schema: [...],
26
- * routes: function (r) { r.get("/", ...); },
27
- * });
28
- * await app.listen({ port: 3000 });
29
- *
30
- * Each underlying module remains accessible (b.vault, b.db, b.cluster,
31
- * etc.) — createApp doesn't hide them, it just orchestrates the
32
- * dependency-ordered boot.
33
- *
34
- * Boot order is fixed because the dependency graph is fixed:
35
- *
36
- * vault.init — derives encryption keys
37
- * ↓
38
- * externalDb.init — connection pool (cluster mode only)
39
- * ↓
40
- * cluster.init — leader election, fencing token (opt-in)
41
- * ↓
42
- * frameworkSchema — audit/consent/sessions/queue tables
43
- * .ensureSchema in external-db when cluster mode (opt-in;
44
- * skip when operator wants gates-only)
45
- * ↓
46
- * db.init — local SQLite + audit chain verify + audit
47
- * checkpoint verify + audit-tip rollback check
48
- * (single-node) or cluster boot checks (cluster)
49
- * ↓
50
- * router.Router()
51
- * middleware stack mounted in canonical order
52
- * operator routes registered
53
- * error handler attached via router.onError()
54
- *
55
- * Default middleware: requestId + securityHeaders + botGuard +
56
- * errorHandler (mounted as the route-error catcher). cors and
57
- * rateLimit are opt-in only — both require explicit configuration
58
- * (origins, thresholds) that the framework can't sensibly default.
59
- *
60
- * Operators disable any default middleware by passing
61
- * `middleware: { requestId: false, securityHeaders: false, ... }`.
62
- *
63
- * Public API:
64
- *
65
- * await createApp(opts) → app
66
- *
67
- * app.router — the b.router.Router instance (operator
68
- * adds late routes / inspects state)
69
- * app.db, app.vault — re-exports for convenience; nothing app-
70
- * specific lives on these
71
- *
72
- * await app.listen(opts2?)
73
- * opts2.port (default opts.port, then 0 = ephemeral)
74
- * opts2.host (default opts.host, then unspecified)
75
- * opts2.tls (TLS options forwarded to router.listen — h2 + h1)
76
- * → { port, host, server } the bound port + the underlying
77
- * http(s).Server instance for ops use
78
- *
79
- * app.address()
80
- * → { port, host } | null bound socket info post-listen
81
- *
82
- * await app.shutdown()
83
- * Closes WebSockets gracefully (timeoutMs default 5s), closes
84
- * the http server, then unwinds cluster / db / externalDb.
85
- * Idempotent — safe to call repeatedly.
86
- *
87
- * Validation: opts.dataDir is required. Other config is optional with
88
- * documented defaults. Schema is optional too — apps with no app-
89
- * level tables still get the framework tables (sessions, queue jobs,
90
- * audit_log, consent_log).
91
- */
92
- var fs = require("fs");
93
- var path = require("path");
94
- var appShutdown = require("./app-shutdown");
95
- var C = require("./constants");
96
- var cluster = require("./cluster");
97
- var db = require("./db");
98
- var externalDb = require("./external-db");
99
- var frameworkSchema = require("./framework-schema");
100
- var jobsMod = require("./jobs");
101
- var middleware = require("./middleware");
102
- var queue = require("./queue");
103
- var routerMod = require("./router");
104
- var vault = require("./vault");
105
-
106
- function _resolveMiddlewareOpt(value, allowDefault) {
107
- // value can be:
108
- // false — operator opted out
109
- // undefined — fall back to allowDefault (mount with empty opts)
110
- // true — explicit opt-in with default opts
111
- // object — explicit opts
112
- if (value === false) return null;
113
- if (value === undefined) return allowDefault ? {} : null;
114
- if (value === true) return {};
115
- if (value && typeof value === "object") return value;
116
- return null;
117
- }
118
-
119
- async function createApp(opts) {
120
- if (!opts || typeof opts !== "object") {
121
- throw new Error("createApp: opts object is required");
122
- }
123
- if (!opts.dataDir || typeof opts.dataDir !== "string") {
124
- throw new Error("createApp: opts.dataDir is required");
125
- }
126
- var dataDir = path.resolve(opts.dataDir);
127
- if (!fs.existsSync(dataDir)) {
128
- fs.mkdirSync(dataDir, { recursive: true });
129
- }
130
-
131
- // ---- 1. Vault ----
132
- var vaultOpts = Object.assign({ dataDir: dataDir }, opts.vault || {});
133
- if (!vaultOpts.mode) vaultOpts.mode = "wrapped";
134
- await vault.init(vaultOpts);
135
-
136
- // ---- 2. External DB (cluster mode) ----
137
- if (opts.externalDb) {
138
- externalDb.init(opts.externalDb);
139
- }
140
-
141
- // ---- 3. Cluster (opt-in) ----
142
- if (opts.cluster) {
143
- // Schema needs to exist before cluster.init's boot-time rollback
144
- // check tries to read _blamejs_audit_tip — if cluster has an
145
- // externalDbBackend AND the operator hasn't disabled the schema
146
- // step, ensure schemas first.
147
- if (opts.cluster.externalDbBackend && opts.frameworkSchema !== false) {
148
- await frameworkSchema.ensureSchema({
149
- externalDbBackend: opts.cluster.externalDbBackend,
150
- dialect: opts.cluster.dialect || "postgres",
151
- });
152
- }
153
- await cluster.init(opts.cluster);
154
- }
155
-
156
- // ---- 4. Local DB ----
157
- var dbOpts = Object.assign({
158
- dataDir: dataDir,
159
- schema: opts.schema || [],
160
- }, opts.db || {});
161
- await db.init(dbOpts);
162
-
163
- // ---- 5. Jobs (opt-in) ----
164
- // Operator-supplied callback that defines named handlers. We boot
165
- // queue with a default 'local' backend (the framework's built-in
166
- // SQLite-backed protocol) before invoking the callback. Operators
167
- // who want a different backend pass opts.queue: { backends: { … } }
168
- // and skip opts.jobs, then wire jobs themselves.
169
- var jobsInstance = null;
170
- if (typeof opts.jobs === "function") {
171
- var queueConfig = opts.queue || { backends: { primary: { protocol: "local" } } };
172
- queue.init(queueConfig);
173
- jobsInstance = jobsMod.create(opts.jobsOptions || {});
174
- opts.jobs(jobsInstance);
175
- await jobsInstance.start();
176
- } else if (opts.queue) {
177
- // Operator wants queue without the jobs sugar (rare, but legitimate
178
- // — they'll call queue.consume themselves).
179
- queue.init(opts.queue);
180
- }
181
-
182
- // ---- 6. Router + middleware ----
183
- var router = new routerMod.Router();
184
- var mwConfig = opts.middleware || {};
185
-
186
- // Shutdown orchestrator. Created early so its drain-guard middleware
187
- // mounts as the first middleware in the chain — once shutdown begins,
188
- // every new request gets 503 immediately. Standard phases are wired
189
- // below once we know which components exist; the operator's
190
- // beforeStop / afterDrain hooks slot in around drain-in-flight.
191
- var shutdownOpts = opts.shutdown || {};
192
- var orchestrator = appShutdown.create({
193
- graceMs: shutdownOpts.graceMs,
194
- installSignalHandlers: !!shutdownOpts.installSignalHandlers,
195
- phases: [],
196
- });
197
- router.use(orchestrator.middleware());
198
-
199
- var requestIdOpts = _resolveMiddlewareOpt(mwConfig.requestId, true);
200
- if (requestIdOpts) router.use(middleware.requestId(requestIdOpts));
201
-
202
- var securityHeadersOpts = _resolveMiddlewareOpt(mwConfig.securityHeaders, true);
203
- if (securityHeadersOpts) router.use(middleware.securityHeaders(securityHeadersOpts));
204
-
205
- var corsOpts = _resolveMiddlewareOpt(mwConfig.cors, false);
206
- if (corsOpts) router.use(middleware.cors(corsOpts));
207
-
208
- var botGuardOpts = _resolveMiddlewareOpt(mwConfig.botGuard, true);
209
- if (botGuardOpts) router.use(middleware.botGuard(botGuardOpts));
210
-
211
- var rateLimitOpts = _resolveMiddlewareOpt(mwConfig.rateLimit, false);
212
- if (rateLimitOpts) router.use(middleware.rateLimit(rateLimitOpts));
213
-
214
- // ---- 6. Operator routes ----
215
- if (typeof opts.routes === "function") {
216
- opts.routes(router);
217
- }
218
-
219
- // ---- 7. Error handler — last so it catches everything ----
220
- var errorHandlerOpts = _resolveMiddlewareOpt(mwConfig.errorHandler, true);
221
- if (errorHandlerOpts) {
222
- router.onError(middleware.errorHandler(errorHandlerOpts));
223
- }
224
-
225
- // ---- App handle ----
226
- var server = null;
227
- var listenPort = null;
228
- var listenHost = null;
229
-
230
- function listen(listenOpts) {
231
- listenOpts = listenOpts || {};
232
- var port = (listenOpts.port !== undefined) ? listenOpts.port
233
- : (opts.port !== undefined) ? opts.port
234
- : 0;
235
- var host = listenOpts.host || opts.host;
236
- var tls = listenOpts.tls || opts.tls;
237
- return new Promise(function (resolve, reject) {
238
- try {
239
- server = router.listen(port, function () {
240
- var addr = server.address();
241
- if (addr && typeof addr === "object") {
242
- listenPort = addr.port;
243
- listenHost = addr.address;
244
- }
245
- // Now that we know the server, finalize shutdown phases.
246
- _wireShutdownPhases();
247
- resolve({ port: listenPort, host: listenHost, server: server });
248
- }, tls, host);
249
- } catch (e) { reject(e); }
250
- });
251
- }
252
-
253
- function address() {
254
- if (!server) return null;
255
- return { port: listenPort, host: listenHost };
256
- }
257
-
258
- // Wire the standard shutdown phases. Called from listen() so the
259
- // server reference is live; idempotent so listen() can be called
260
- // multiple times without duplicating phases.
261
- var phasesWired = false;
262
- function _wireShutdownPhases() {
263
- if (phasesWired) return;
264
- phasesWired = true;
265
-
266
- // Operator beforeStop hook (runs before anything else, including
267
- // mark-draining — useful for snapshotting state, posting a
268
- // "going down" event to a metrics pipeline, etc.)
269
- if (typeof shutdownOpts.beforeStop === "function") {
270
- orchestrator.addPhase({
271
- name: "beforeStop",
272
- run: shutdownOpts.beforeStop,
273
- timeoutMs: shutdownOpts.beforeStopTimeoutMs || C.TIME.seconds(5),
274
- });
275
- }
276
-
277
- // Drain in-flight requests phase. Mount FIRST among framework
278
- // phases so we drain before stopping subsystems jobs depend on.
279
- orchestrator.addPhase({
280
- name: "drain-in-flight",
281
- run: orchestrator.waitInFlight,
282
- timeoutMs: shutdownOpts.drainTimeoutMs || C.TIME.seconds(10),
283
- });
284
-
285
- if (typeof shutdownOpts.afterDrain === "function") {
286
- orchestrator.addPhase({
287
- name: "afterDrain",
288
- run: shutdownOpts.afterDrain,
289
- timeoutMs: shutdownOpts.afterDrainTimeoutMs || C.TIME.seconds(5),
290
- });
291
- }
292
-
293
- // Standard component phases (scheduler, jobs, websocket, server,
294
- // cluster, db, external-db) in canonical order. The http-server
295
- // phase is built manually below so we can null the local `server`
296
- // ref after close — operators expect address() to return null
297
- // after shutdown.
298
- var standard = appShutdown.standardPhases({
299
- health: shutdownOpts.health || null,
300
- scheduler: shutdownOpts.scheduler || null,
301
- jobs: jobsInstance,
302
- queue: jobsInstance ? null : (opts.queue ? queue : null),
303
- router: router,
304
- // Omit server here; we add a custom phase below that also
305
- // clears the local server reference.
306
- server: null,
307
- cluster: opts.cluster ? cluster : null,
308
- db: db,
309
- externalDb: opts.externalDb ? externalDb : null,
310
- });
311
- // Insert the http-server phase right after websockets (mirrors
312
- // standardPhases ordering: websockets → http-server → cluster → db).
313
- if (server) {
314
- var httpServerPhase = {
315
- name: "http-server",
316
- run: function () {
317
- return new Promise(function (resolve) {
318
- if (!server) { resolve(); return; }
319
- server.close(function () {
320
- server = null; // address() now returns null
321
- listenPort = null;
322
- listenHost = null;
323
- resolve();
324
- });
325
- });
326
- },
327
- timeoutMs: C.TIME.seconds(10),
328
- };
329
- // Find the index right after the "websockets" phase if present;
330
- // otherwise prepend before "cluster" (or just push to end if
331
- // those phases aren't there either).
332
- var insertAt = standard.findIndex(function (p) { return p.name === "websockets"; });
333
- if (insertAt === -1) insertAt = standard.findIndex(function (p) { return p.name === "cluster"; });
334
- if (insertAt === -1) insertAt = standard.length;
335
- else insertAt += (standard[insertAt].name === "websockets") ? 1 : 0;
336
- standard.splice(insertAt, 0, httpServerPhase);
337
- }
338
- for (var i = 0; i < standard.length; i++) {
339
- orchestrator.addPhase(standard[i]);
340
- }
341
- }
342
-
343
- async function shutdown() {
344
- // If listen() was never called, wire phases now so a server-less
345
- // app (e.g. a worker process that uses the framework's primitives
346
- // without HTTP) still gets cluster/db/jobs cleanup.
347
- _wireShutdownPhases();
348
- return await orchestrator.shutdown();
349
- }
350
-
351
- return {
352
- router: router,
353
- db: db,
354
- vault: vault,
355
- jobs: jobsInstance,
356
- listen: listen,
357
- address: address,
358
- shutdown: shutdown,
359
- // Expose the orchestrator for power users / observability — they
360
- // can read draining(), inFlight(), or addPhase before listen().
361
- shutdownOrchestrator: orchestrator,
362
- };
363
- }
364
-
365
- module.exports = { createApp: createApp };
1
+ "use strict";
2
+ /**
3
+ * createApp — factory that wires the framework's primitives into a
4
+ * runnable application.
5
+ *
6
+ * Without this factory an operator boots the framework manually:
7
+ *
8
+ * await b.vault.init({...});
9
+ * if (cluster mode) b.externalDb.init({...});
10
+ * if (cluster mode) await b.cluster.init({...});
11
+ * if (cluster mode) await b.frameworkSchema.ensureSchema({...});
12
+ * await b.db.init({...});
13
+ * var r = new b.router.Router();
14
+ * r.use(b.middleware.requestId());
15
+ * r.use(b.middleware.securityHeaders());
16
+ * r.use(b.middleware.botGuard());
17
+ * yourRoutes(r);
18
+ * r.onError(b.middleware.errorHandler());
19
+ * var server = r.listen(port, ...);
20
+ *
21
+ * createApp collapses that into:
22
+ *
23
+ * var app = await createApp({
24
+ * dataDir: "./data",
25
+ * schema: [...],
26
+ * routes: function (r) { r.get("/", ...); },
27
+ * });
28
+ * await app.listen({ port: 3000 });
29
+ *
30
+ * Each underlying module remains accessible (b.vault, b.db, b.cluster,
31
+ * etc.) — createApp doesn't hide them, it just orchestrates the
32
+ * dependency-ordered boot.
33
+ *
34
+ * Boot order is fixed because the dependency graph is fixed:
35
+ *
36
+ * vault.init — derives encryption keys
37
+ * ↓
38
+ * externalDb.init — connection pool (cluster mode only)
39
+ * ↓
40
+ * cluster.init — leader election, fencing token (opt-in)
41
+ * ↓
42
+ * frameworkSchema — audit/consent/sessions/queue tables
43
+ * .ensureSchema in external-db when cluster mode (opt-in;
44
+ * skip when operator wants gates-only)
45
+ * ↓
46
+ * db.init — local SQLite + audit chain verify + audit
47
+ * checkpoint verify + audit-tip rollback check
48
+ * (single-node) or cluster boot checks (cluster)
49
+ * ↓
50
+ * router.Router()
51
+ * middleware stack mounted in canonical order
52
+ * operator routes registered
53
+ * error handler attached via router.onError()
54
+ *
55
+ * Default middleware: requestId + securityHeaders + botGuard +
56
+ * errorHandler (mounted as the route-error catcher). cors and
57
+ * rateLimit are opt-in only — both require explicit configuration
58
+ * (origins, thresholds) that the framework can't sensibly default.
59
+ *
60
+ * Operators disable any default middleware by passing
61
+ * `middleware: { requestId: false, securityHeaders: false, ... }`.
62
+ *
63
+ * Public API:
64
+ *
65
+ * await createApp(opts) → app
66
+ *
67
+ * app.router — the b.router.Router instance (operator
68
+ * adds late routes / inspects state)
69
+ * app.db, app.vault — re-exports for convenience; nothing app-
70
+ * specific lives on these
71
+ *
72
+ * await app.listen(opts2?)
73
+ * opts2.port (default opts.port, then 0 = ephemeral)
74
+ * opts2.host (default opts.host, then unspecified)
75
+ * opts2.tls (TLS options forwarded to router.listen — h2 + h1)
76
+ * → { port, host, server } the bound port + the underlying
77
+ * http(s).Server instance for ops use
78
+ *
79
+ * app.address()
80
+ * → { port, host } | null bound socket info post-listen
81
+ *
82
+ * await app.shutdown()
83
+ * Closes WebSockets gracefully (timeoutMs default 5s), closes
84
+ * the http server, then unwinds cluster / db / externalDb.
85
+ * Idempotent — safe to call repeatedly.
86
+ *
87
+ * Validation: opts.dataDir is required. Other config is optional with
88
+ * documented defaults. Schema is optional too — apps with no app-
89
+ * level tables still get the framework tables (sessions, queue jobs,
90
+ * audit_log, consent_log).
91
+ */
92
+ var fs = require("fs");
93
+ var path = require("path");
94
+ var appShutdown = require("./app-shutdown");
95
+ var C = require("./constants");
96
+ var cluster = require("./cluster");
97
+ var db = require("./db");
98
+ var externalDb = require("./external-db");
99
+ var frameworkSchema = require("./framework-schema");
100
+ var jobsMod = require("./jobs");
101
+ var middleware = require("./middleware");
102
+ var queue = require("./queue");
103
+ var routerMod = require("./router");
104
+ var vault = require("./vault");
105
+
106
+ function _resolveMiddlewareOpt(value, allowDefault) {
107
+ // value can be:
108
+ // false — operator opted out
109
+ // undefined — fall back to allowDefault (mount with empty opts)
110
+ // true — explicit opt-in with default opts
111
+ // object — explicit opts
112
+ if (value === false) return null;
113
+ if (value === undefined) return allowDefault ? {} : null;
114
+ if (value === true) return {};
115
+ if (value && typeof value === "object") return value;
116
+ return null;
117
+ }
118
+
119
+ async function createApp(opts) {
120
+ if (!opts || typeof opts !== "object") {
121
+ throw new Error("createApp: opts object is required");
122
+ }
123
+ if (!opts.dataDir || typeof opts.dataDir !== "string") {
124
+ throw new Error("createApp: opts.dataDir is required");
125
+ }
126
+ var dataDir = path.resolve(opts.dataDir);
127
+ if (!fs.existsSync(dataDir)) {
128
+ fs.mkdirSync(dataDir, { recursive: true });
129
+ }
130
+
131
+ // ---- 1. Vault ----
132
+ var vaultOpts = Object.assign({ dataDir: dataDir }, opts.vault || {});
133
+ if (!vaultOpts.mode) vaultOpts.mode = "wrapped";
134
+ await vault.init(vaultOpts);
135
+
136
+ // ---- 2. External DB (cluster mode) ----
137
+ if (opts.externalDb) {
138
+ externalDb.init(opts.externalDb);
139
+ }
140
+
141
+ // ---- 3. Cluster (opt-in) ----
142
+ if (opts.cluster) {
143
+ // Schema needs to exist before cluster.init's boot-time rollback
144
+ // check tries to read _blamejs_audit_tip — if cluster has an
145
+ // externalDbBackend AND the operator hasn't disabled the schema
146
+ // step, ensure schemas first.
147
+ if (opts.cluster.externalDbBackend && opts.frameworkSchema !== false) {
148
+ await frameworkSchema.ensureSchema({
149
+ externalDbBackend: opts.cluster.externalDbBackend,
150
+ dialect: opts.cluster.dialect || "postgres",
151
+ });
152
+ }
153
+ await cluster.init(opts.cluster);
154
+ }
155
+
156
+ // ---- 4. Local DB ----
157
+ var dbOpts = Object.assign({
158
+ dataDir: dataDir,
159
+ schema: opts.schema || [],
160
+ }, opts.db || {});
161
+ await db.init(dbOpts);
162
+
163
+ // ---- 5. Jobs (opt-in) ----
164
+ // Operator-supplied callback that defines named handlers. We boot
165
+ // queue with a default 'local' backend (the framework's built-in
166
+ // SQLite-backed protocol) before invoking the callback. Operators
167
+ // who want a different backend pass opts.queue: { backends: { … } }
168
+ // and skip opts.jobs, then wire jobs themselves.
169
+ var jobsInstance = null;
170
+ if (typeof opts.jobs === "function") {
171
+ var queueConfig = opts.queue || { backends: { primary: { protocol: "local" } } };
172
+ queue.init(queueConfig);
173
+ jobsInstance = jobsMod.create(opts.jobsOptions || {});
174
+ opts.jobs(jobsInstance);
175
+ await jobsInstance.start();
176
+ } else if (opts.queue) {
177
+ // Operator wants queue without the jobs sugar (rare, but legitimate
178
+ // — they'll call queue.consume themselves).
179
+ queue.init(opts.queue);
180
+ }
181
+
182
+ // ---- 6. Router + middleware ----
183
+ var router = new routerMod.Router();
184
+ var mwConfig = opts.middleware || {};
185
+
186
+ // Shutdown orchestrator. Created early so its drain-guard middleware
187
+ // mounts as the first middleware in the chain — once shutdown begins,
188
+ // every new request gets 503 immediately. Standard phases are wired
189
+ // below once we know which components exist; the operator's
190
+ // beforeStop / afterDrain hooks slot in around drain-in-flight.
191
+ var shutdownOpts = opts.shutdown || {};
192
+ var orchestrator = appShutdown.create({
193
+ graceMs: shutdownOpts.graceMs,
194
+ installSignalHandlers: !!shutdownOpts.installSignalHandlers,
195
+ phases: [],
196
+ });
197
+ router.use(orchestrator.middleware());
198
+
199
+ var requestIdOpts = _resolveMiddlewareOpt(mwConfig.requestId, true);
200
+ if (requestIdOpts) router.use(middleware.requestId(requestIdOpts));
201
+
202
+ var securityHeadersOpts = _resolveMiddlewareOpt(mwConfig.securityHeaders, true);
203
+ if (securityHeadersOpts) router.use(middleware.securityHeaders(securityHeadersOpts));
204
+
205
+ var corsOpts = _resolveMiddlewareOpt(mwConfig.cors, false);
206
+ if (corsOpts) router.use(middleware.cors(corsOpts));
207
+
208
+ var botGuardOpts = _resolveMiddlewareOpt(mwConfig.botGuard, true);
209
+ if (botGuardOpts) router.use(middleware.botGuard(botGuardOpts));
210
+
211
+ var rateLimitOpts = _resolveMiddlewareOpt(mwConfig.rateLimit, false);
212
+ if (rateLimitOpts) router.use(middleware.rateLimit(rateLimitOpts));
213
+
214
+ // ---- 6. Operator routes ----
215
+ if (typeof opts.routes === "function") {
216
+ opts.routes(router);
217
+ }
218
+
219
+ // ---- 7. Error handler — last so it catches everything ----
220
+ var errorHandlerOpts = _resolveMiddlewareOpt(mwConfig.errorHandler, true);
221
+ if (errorHandlerOpts) {
222
+ router.onError(middleware.errorHandler(errorHandlerOpts));
223
+ }
224
+
225
+ // ---- App handle ----
226
+ var server = null;
227
+ var listenPort = null;
228
+ var listenHost = null;
229
+
230
+ function listen(listenOpts) {
231
+ listenOpts = listenOpts || {};
232
+ var port = (listenOpts.port !== undefined) ? listenOpts.port
233
+ : (opts.port !== undefined) ? opts.port
234
+ : 0;
235
+ var host = listenOpts.host || opts.host;
236
+ var tls = listenOpts.tls || opts.tls;
237
+ return new Promise(function (resolve, reject) {
238
+ try {
239
+ server = router.listen(port, function () {
240
+ var addr = server.address();
241
+ if (addr && typeof addr === "object") {
242
+ listenPort = addr.port;
243
+ listenHost = addr.address;
244
+ }
245
+ // Now that we know the server, finalize shutdown phases.
246
+ _wireShutdownPhases();
247
+ resolve({ port: listenPort, host: listenHost, server: server });
248
+ }, tls, host);
249
+ } catch (e) { reject(e); }
250
+ });
251
+ }
252
+
253
+ function address() {
254
+ if (!server) return null;
255
+ return { port: listenPort, host: listenHost };
256
+ }
257
+
258
+ // Wire the standard shutdown phases. Called from listen() so the
259
+ // server reference is live; idempotent so listen() can be called
260
+ // multiple times without duplicating phases.
261
+ var phasesWired = false;
262
+ function _wireShutdownPhases() {
263
+ if (phasesWired) return;
264
+ phasesWired = true;
265
+
266
+ // Operator beforeStop hook (runs before anything else, including
267
+ // mark-draining — useful for snapshotting state, posting a
268
+ // "going down" event to a metrics pipeline, etc.)
269
+ if (typeof shutdownOpts.beforeStop === "function") {
270
+ orchestrator.addPhase({
271
+ name: "beforeStop",
272
+ run: shutdownOpts.beforeStop,
273
+ timeoutMs: shutdownOpts.beforeStopTimeoutMs || C.TIME.seconds(5),
274
+ });
275
+ }
276
+
277
+ // Drain in-flight requests phase. Mount FIRST among framework
278
+ // phases so we drain before stopping subsystems jobs depend on.
279
+ orchestrator.addPhase({
280
+ name: "drain-in-flight",
281
+ run: orchestrator.waitInFlight,
282
+ timeoutMs: shutdownOpts.drainTimeoutMs || C.TIME.seconds(10),
283
+ });
284
+
285
+ if (typeof shutdownOpts.afterDrain === "function") {
286
+ orchestrator.addPhase({
287
+ name: "afterDrain",
288
+ run: shutdownOpts.afterDrain,
289
+ timeoutMs: shutdownOpts.afterDrainTimeoutMs || C.TIME.seconds(5),
290
+ });
291
+ }
292
+
293
+ // Standard component phases (scheduler, jobs, websocket, server,
294
+ // cluster, db, external-db) in canonical order. The http-server
295
+ // phase is built manually below so we can null the local `server`
296
+ // ref after close — operators expect address() to return null
297
+ // after shutdown.
298
+ var standard = appShutdown.standardPhases({
299
+ health: shutdownOpts.health || null,
300
+ scheduler: shutdownOpts.scheduler || null,
301
+ jobs: jobsInstance,
302
+ queue: jobsInstance ? null : (opts.queue ? queue : null),
303
+ router: router,
304
+ // Omit server here; we add a custom phase below that also
305
+ // clears the local server reference.
306
+ server: null,
307
+ cluster: opts.cluster ? cluster : null,
308
+ db: db,
309
+ externalDb: opts.externalDb ? externalDb : null,
310
+ });
311
+ // Insert the http-server phase right after websockets (mirrors
312
+ // standardPhases ordering: websockets → http-server → cluster → db).
313
+ if (server) {
314
+ var httpServerPhase = {
315
+ name: "http-server",
316
+ run: function () {
317
+ return new Promise(function (resolve) {
318
+ if (!server) { resolve(); return; }
319
+ server.close(function () {
320
+ server = null; // address() now returns null
321
+ listenPort = null;
322
+ listenHost = null;
323
+ resolve();
324
+ });
325
+ });
326
+ },
327
+ timeoutMs: C.TIME.seconds(10),
328
+ };
329
+ // Find the index right after the "websockets" phase if present;
330
+ // otherwise prepend before "cluster" (or just push to end if
331
+ // those phases aren't there either).
332
+ var insertAt = standard.findIndex(function (p) { return p.name === "websockets"; });
333
+ if (insertAt === -1) insertAt = standard.findIndex(function (p) { return p.name === "cluster"; });
334
+ if (insertAt === -1) insertAt = standard.length;
335
+ else insertAt += (standard[insertAt].name === "websockets") ? 1 : 0;
336
+ standard.splice(insertAt, 0, httpServerPhase);
337
+ }
338
+ for (var i = 0; i < standard.length; i++) {
339
+ orchestrator.addPhase(standard[i]);
340
+ }
341
+ }
342
+
343
+ async function shutdown() {
344
+ // If listen() was never called, wire phases now so a server-less
345
+ // app (e.g. a worker process that uses the framework's primitives
346
+ // without HTTP) still gets cluster/db/jobs cleanup.
347
+ _wireShutdownPhases();
348
+ return await orchestrator.shutdown();
349
+ }
350
+
351
+ return {
352
+ router: router,
353
+ db: db,
354
+ vault: vault,
355
+ jobs: jobsInstance,
356
+ listen: listen,
357
+ address: address,
358
+ shutdown: shutdown,
359
+ // Expose the orchestrator for power users / observability — they
360
+ // can read draining(), inFlight(), or addPhase before listen().
361
+ shutdownOrchestrator: orchestrator,
362
+ };
363
+ }
364
+
365
+ module.exports = { createApp: createApp };