@bsv/overlay-express 2.7.4 → 2.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (209) hide show
  1. package/README.md +146 -0
  2. package/dist/cjs/mod.d.ts +2 -1
  3. package/dist/cjs/mod.d.ts.map +1 -1
  4. package/dist/cjs/mod.js.map +1 -1
  5. package/dist/cjs/package.json +34 -8
  6. package/dist/cjs/src/OutputLookupHTTPPolicy.d.ts +10 -0
  7. package/dist/cjs/src/OutputLookupHTTPPolicy.d.ts.map +1 -0
  8. package/dist/cjs/src/OutputLookupHTTPPolicy.js +125 -0
  9. package/dist/cjs/src/OutputLookupHTTPPolicy.js.map +1 -0
  10. package/dist/cjs/src/OutputLookupResponseGuard.d.ts +31 -0
  11. package/dist/cjs/src/OutputLookupResponseGuard.d.ts.map +1 -0
  12. package/dist/cjs/src/OutputLookupResponseGuard.js +91 -0
  13. package/dist/cjs/src/OutputLookupResponseGuard.js.map +1 -0
  14. package/dist/cjs/src/OutputLookupRoutes.d.ts +53 -0
  15. package/dist/cjs/src/OutputLookupRoutes.d.ts.map +1 -0
  16. package/dist/cjs/src/OutputLookupRoutes.js +274 -0
  17. package/dist/cjs/src/OutputLookupRoutes.js.map +1 -0
  18. package/dist/cjs/src/OverlayExpress.d.ts +63 -0
  19. package/dist/cjs/src/OverlayExpress.d.ts.map +1 -1
  20. package/dist/cjs/src/OverlayExpress.js +263 -6
  21. package/dist/cjs/src/OverlayExpress.js.map +1 -1
  22. package/dist/cjs/src/PrivateAcquisitionHTTPPolicy.d.ts +19 -0
  23. package/dist/cjs/src/PrivateAcquisitionHTTPPolicy.d.ts.map +1 -0
  24. package/dist/cjs/src/PrivateAcquisitionHTTPPolicy.js +90 -0
  25. package/dist/cjs/src/PrivateAcquisitionHTTPPolicy.js.map +1 -0
  26. package/dist/cjs/src/PrivateAcquisitionHTTPPorts.d.ts +43 -0
  27. package/dist/cjs/src/PrivateAcquisitionHTTPPorts.d.ts.map +1 -0
  28. package/dist/cjs/src/PrivateAcquisitionHTTPPorts.js +3 -0
  29. package/dist/cjs/src/PrivateAcquisitionHTTPPorts.js.map +1 -0
  30. package/dist/cjs/src/PrivateAcquisitionResponseGuard.d.ts +14 -0
  31. package/dist/cjs/src/PrivateAcquisitionResponseGuard.d.ts.map +1 -0
  32. package/dist/cjs/src/PrivateAcquisitionResponseGuard.js +108 -0
  33. package/dist/cjs/src/PrivateAcquisitionResponseGuard.js.map +1 -0
  34. package/dist/cjs/src/PrivateAcquisitionRoutes.d.ts +7 -0
  35. package/dist/cjs/src/PrivateAcquisitionRoutes.d.ts.map +1 -0
  36. package/dist/cjs/src/PrivateAcquisitionRoutes.js +269 -0
  37. package/dist/cjs/src/PrivateAcquisitionRoutes.js.map +1 -0
  38. package/dist/cjs/src/PrivateOverlayHost.d.ts +31 -0
  39. package/dist/cjs/src/PrivateOverlayHost.d.ts.map +1 -0
  40. package/dist/cjs/src/PrivateOverlayHost.js +64 -0
  41. package/dist/cjs/src/PrivateOverlayHost.js.map +1 -0
  42. package/dist/cjs/src/PrivatePublicationHTTPPolicy.d.ts +17 -0
  43. package/dist/cjs/src/PrivatePublicationHTTPPolicy.d.ts.map +1 -0
  44. package/dist/cjs/src/PrivatePublicationHTTPPolicy.js +38 -0
  45. package/dist/cjs/src/PrivatePublicationHTTPPolicy.js.map +1 -0
  46. package/dist/cjs/src/PrivatePublicationHTTPPorts.d.ts +40 -0
  47. package/dist/cjs/src/PrivatePublicationHTTPPorts.d.ts.map +1 -0
  48. package/dist/cjs/src/PrivatePublicationHTTPPorts.js +3 -0
  49. package/dist/cjs/src/PrivatePublicationHTTPPorts.js.map +1 -0
  50. package/dist/cjs/src/PrivatePublicationResponseGuard.d.ts +14 -0
  51. package/dist/cjs/src/PrivatePublicationResponseGuard.d.ts.map +1 -0
  52. package/dist/cjs/src/PrivatePublicationResponseGuard.js +82 -0
  53. package/dist/cjs/src/PrivatePublicationResponseGuard.js.map +1 -0
  54. package/dist/cjs/src/PrivatePublicationRoutes.d.ts +6 -0
  55. package/dist/cjs/src/PrivatePublicationRoutes.d.ts.map +1 -0
  56. package/dist/cjs/src/PrivatePublicationRoutes.js +249 -0
  57. package/dist/cjs/src/PrivatePublicationRoutes.js.map +1 -0
  58. package/dist/cjs/src/PrivatePurchaseHTTPPolicy.d.ts +19 -0
  59. package/dist/cjs/src/PrivatePurchaseHTTPPolicy.d.ts.map +1 -0
  60. package/dist/cjs/src/PrivatePurchaseHTTPPolicy.js +82 -0
  61. package/dist/cjs/src/PrivatePurchaseHTTPPolicy.js.map +1 -0
  62. package/dist/cjs/src/PrivatePurchaseHTTPPorts.d.ts +48 -0
  63. package/dist/cjs/src/PrivatePurchaseHTTPPorts.d.ts.map +1 -0
  64. package/dist/cjs/src/PrivatePurchaseHTTPPorts.js +3 -0
  65. package/dist/cjs/src/PrivatePurchaseHTTPPorts.js.map +1 -0
  66. package/dist/cjs/src/PrivatePurchaseResponseGuard.d.ts +15 -0
  67. package/dist/cjs/src/PrivatePurchaseResponseGuard.d.ts.map +1 -0
  68. package/dist/cjs/src/PrivatePurchaseResponseGuard.js +85 -0
  69. package/dist/cjs/src/PrivatePurchaseResponseGuard.js.map +1 -0
  70. package/dist/cjs/src/PrivatePurchaseRoutes.d.ts +7 -0
  71. package/dist/cjs/src/PrivatePurchaseRoutes.d.ts.map +1 -0
  72. package/dist/cjs/src/PrivatePurchaseRoutes.js +276 -0
  73. package/dist/cjs/src/PrivatePurchaseRoutes.js.map +1 -0
  74. package/dist/cjs/src/ProposalHTTPPolicy.d.ts +11 -0
  75. package/dist/cjs/src/ProposalHTTPPolicy.d.ts.map +1 -0
  76. package/dist/cjs/src/ProposalHTTPPolicy.js +38 -0
  77. package/dist/cjs/src/ProposalHTTPPolicy.js.map +1 -0
  78. package/dist/cjs/src/ProposalHTTPPorts.d.ts +59 -0
  79. package/dist/cjs/src/ProposalHTTPPorts.d.ts.map +1 -0
  80. package/dist/cjs/src/ProposalHTTPPorts.js +3 -0
  81. package/dist/cjs/src/ProposalHTTPPorts.js.map +1 -0
  82. package/dist/cjs/src/ProposalResponseGuard.d.ts +18 -0
  83. package/dist/cjs/src/ProposalResponseGuard.d.ts.map +1 -0
  84. package/dist/cjs/src/ProposalResponseGuard.js +61 -0
  85. package/dist/cjs/src/ProposalResponseGuard.js.map +1 -0
  86. package/dist/cjs/src/ProposalRoutes.d.ts +10 -0
  87. package/dist/cjs/src/ProposalRoutes.d.ts.map +1 -0
  88. package/dist/cjs/src/ProposalRoutes.js +239 -0
  89. package/dist/cjs/src/ProposalRoutes.js.map +1 -0
  90. package/dist/cjs/src/RootEvictionHTTPPolicy.d.ts +8 -0
  91. package/dist/cjs/src/RootEvictionHTTPPolicy.d.ts.map +1 -0
  92. package/dist/cjs/src/RootEvictionHTTPPolicy.js +77 -0
  93. package/dist/cjs/src/RootEvictionHTTPPolicy.js.map +1 -0
  94. package/dist/cjs/src/RootEvictionHTTPPorts.d.ts +73 -0
  95. package/dist/cjs/src/RootEvictionHTTPPorts.d.ts.map +1 -0
  96. package/dist/cjs/src/RootEvictionHTTPPorts.js +3 -0
  97. package/dist/cjs/src/RootEvictionHTTPPorts.js.map +1 -0
  98. package/dist/cjs/src/RootEvictionResponseGuard.d.ts +38 -0
  99. package/dist/cjs/src/RootEvictionResponseGuard.d.ts.map +1 -0
  100. package/dist/cjs/src/RootEvictionResponseGuard.js +83 -0
  101. package/dist/cjs/src/RootEvictionResponseGuard.js.map +1 -0
  102. package/dist/cjs/src/RootEvictionRoutes.d.ts +11 -0
  103. package/dist/cjs/src/RootEvictionRoutes.d.ts.map +1 -0
  104. package/dist/cjs/src/RootEvictionRoutes.js +198 -0
  105. package/dist/cjs/src/RootEvictionRoutes.js.map +1 -0
  106. package/dist/esm/mod.js.map +1 -1
  107. package/dist/esm/src/OutputLookupHTTPPolicy.js +117 -0
  108. package/dist/esm/src/OutputLookupHTTPPolicy.js.map +1 -0
  109. package/dist/esm/src/OutputLookupResponseGuard.js +85 -0
  110. package/dist/esm/src/OutputLookupResponseGuard.js.map +1 -0
  111. package/dist/esm/src/OutputLookupRoutes.js +275 -0
  112. package/dist/esm/src/OutputLookupRoutes.js.map +1 -0
  113. package/dist/esm/src/OverlayExpress.js +239 -11
  114. package/dist/esm/src/OverlayExpress.js.map +1 -1
  115. package/dist/esm/src/PrivateAcquisitionHTTPPolicy.js +82 -0
  116. package/dist/esm/src/PrivateAcquisitionHTTPPolicy.js.map +1 -0
  117. package/dist/esm/src/PrivateAcquisitionHTTPPorts.js +2 -0
  118. package/dist/esm/src/PrivateAcquisitionHTTPPorts.js.map +1 -0
  119. package/dist/esm/src/PrivateAcquisitionResponseGuard.js +105 -0
  120. package/dist/esm/src/PrivateAcquisitionResponseGuard.js.map +1 -0
  121. package/dist/esm/src/PrivateAcquisitionRoutes.js +267 -0
  122. package/dist/esm/src/PrivateAcquisitionRoutes.js.map +1 -0
  123. package/dist/esm/src/PrivateOverlayHost.js +62 -0
  124. package/dist/esm/src/PrivateOverlayHost.js.map +1 -0
  125. package/dist/esm/src/PrivatePublicationHTTPPolicy.js +30 -0
  126. package/dist/esm/src/PrivatePublicationHTTPPolicy.js.map +1 -0
  127. package/dist/esm/src/PrivatePublicationHTTPPorts.js +2 -0
  128. package/dist/esm/src/PrivatePublicationHTTPPorts.js.map +1 -0
  129. package/dist/esm/src/PrivatePublicationResponseGuard.js +79 -0
  130. package/dist/esm/src/PrivatePublicationResponseGuard.js.map +1 -0
  131. package/dist/esm/src/PrivatePublicationRoutes.js +247 -0
  132. package/dist/esm/src/PrivatePublicationRoutes.js.map +1 -0
  133. package/dist/esm/src/PrivatePurchaseHTTPPolicy.js +74 -0
  134. package/dist/esm/src/PrivatePurchaseHTTPPolicy.js.map +1 -0
  135. package/dist/esm/src/PrivatePurchaseHTTPPorts.js +2 -0
  136. package/dist/esm/src/PrivatePurchaseHTTPPorts.js.map +1 -0
  137. package/dist/esm/src/PrivatePurchaseResponseGuard.js +82 -0
  138. package/dist/esm/src/PrivatePurchaseResponseGuard.js.map +1 -0
  139. package/dist/esm/src/PrivatePurchaseRoutes.js +275 -0
  140. package/dist/esm/src/PrivatePurchaseRoutes.js.map +1 -0
  141. package/dist/esm/src/ProposalHTTPPolicy.js +30 -0
  142. package/dist/esm/src/ProposalHTTPPolicy.js.map +1 -0
  143. package/dist/esm/src/ProposalHTTPPorts.js +2 -0
  144. package/dist/esm/src/ProposalHTTPPorts.js.map +1 -0
  145. package/dist/esm/src/ProposalResponseGuard.js +58 -0
  146. package/dist/esm/src/ProposalResponseGuard.js.map +1 -0
  147. package/dist/esm/src/ProposalRoutes.js +237 -0
  148. package/dist/esm/src/ProposalRoutes.js.map +1 -0
  149. package/dist/esm/src/RootEvictionHTTPPolicy.js +71 -0
  150. package/dist/esm/src/RootEvictionHTTPPolicy.js.map +1 -0
  151. package/dist/esm/src/RootEvictionHTTPPorts.js +2 -0
  152. package/dist/esm/src/RootEvictionHTTPPorts.js.map +1 -0
  153. package/dist/esm/src/RootEvictionResponseGuard.js +80 -0
  154. package/dist/esm/src/RootEvictionResponseGuard.js.map +1 -0
  155. package/dist/esm/src/RootEvictionRoutes.js +196 -0
  156. package/dist/esm/src/RootEvictionRoutes.js.map +1 -0
  157. package/dist/types/mod.d.ts +2 -1
  158. package/dist/types/mod.d.ts.map +1 -1
  159. package/dist/types/src/OutputLookupHTTPPolicy.d.ts +10 -0
  160. package/dist/types/src/OutputLookupHTTPPolicy.d.ts.map +1 -0
  161. package/dist/types/src/OutputLookupResponseGuard.d.ts +31 -0
  162. package/dist/types/src/OutputLookupResponseGuard.d.ts.map +1 -0
  163. package/dist/types/src/OutputLookupRoutes.d.ts +53 -0
  164. package/dist/types/src/OutputLookupRoutes.d.ts.map +1 -0
  165. package/dist/types/src/OverlayExpress.d.ts +63 -0
  166. package/dist/types/src/OverlayExpress.d.ts.map +1 -1
  167. package/dist/types/src/PrivateAcquisitionHTTPPolicy.d.ts +19 -0
  168. package/dist/types/src/PrivateAcquisitionHTTPPolicy.d.ts.map +1 -0
  169. package/dist/types/src/PrivateAcquisitionHTTPPorts.d.ts +43 -0
  170. package/dist/types/src/PrivateAcquisitionHTTPPorts.d.ts.map +1 -0
  171. package/dist/types/src/PrivateAcquisitionResponseGuard.d.ts +14 -0
  172. package/dist/types/src/PrivateAcquisitionResponseGuard.d.ts.map +1 -0
  173. package/dist/types/src/PrivateAcquisitionRoutes.d.ts +7 -0
  174. package/dist/types/src/PrivateAcquisitionRoutes.d.ts.map +1 -0
  175. package/dist/types/src/PrivateOverlayHost.d.ts +31 -0
  176. package/dist/types/src/PrivateOverlayHost.d.ts.map +1 -0
  177. package/dist/types/src/PrivatePublicationHTTPPolicy.d.ts +17 -0
  178. package/dist/types/src/PrivatePublicationHTTPPolicy.d.ts.map +1 -0
  179. package/dist/types/src/PrivatePublicationHTTPPorts.d.ts +40 -0
  180. package/dist/types/src/PrivatePublicationHTTPPorts.d.ts.map +1 -0
  181. package/dist/types/src/PrivatePublicationResponseGuard.d.ts +14 -0
  182. package/dist/types/src/PrivatePublicationResponseGuard.d.ts.map +1 -0
  183. package/dist/types/src/PrivatePublicationRoutes.d.ts +6 -0
  184. package/dist/types/src/PrivatePublicationRoutes.d.ts.map +1 -0
  185. package/dist/types/src/PrivatePurchaseHTTPPolicy.d.ts +19 -0
  186. package/dist/types/src/PrivatePurchaseHTTPPolicy.d.ts.map +1 -0
  187. package/dist/types/src/PrivatePurchaseHTTPPorts.d.ts +48 -0
  188. package/dist/types/src/PrivatePurchaseHTTPPorts.d.ts.map +1 -0
  189. package/dist/types/src/PrivatePurchaseResponseGuard.d.ts +15 -0
  190. package/dist/types/src/PrivatePurchaseResponseGuard.d.ts.map +1 -0
  191. package/dist/types/src/PrivatePurchaseRoutes.d.ts +7 -0
  192. package/dist/types/src/PrivatePurchaseRoutes.d.ts.map +1 -0
  193. package/dist/types/src/ProposalHTTPPolicy.d.ts +11 -0
  194. package/dist/types/src/ProposalHTTPPolicy.d.ts.map +1 -0
  195. package/dist/types/src/ProposalHTTPPorts.d.ts +59 -0
  196. package/dist/types/src/ProposalHTTPPorts.d.ts.map +1 -0
  197. package/dist/types/src/ProposalResponseGuard.d.ts +18 -0
  198. package/dist/types/src/ProposalResponseGuard.d.ts.map +1 -0
  199. package/dist/types/src/ProposalRoutes.d.ts +10 -0
  200. package/dist/types/src/ProposalRoutes.d.ts.map +1 -0
  201. package/dist/types/src/RootEvictionHTTPPolicy.d.ts +8 -0
  202. package/dist/types/src/RootEvictionHTTPPolicy.d.ts.map +1 -0
  203. package/dist/types/src/RootEvictionHTTPPorts.d.ts +73 -0
  204. package/dist/types/src/RootEvictionHTTPPorts.d.ts.map +1 -0
  205. package/dist/types/src/RootEvictionResponseGuard.d.ts +38 -0
  206. package/dist/types/src/RootEvictionResponseGuard.d.ts.map +1 -0
  207. package/dist/types/src/RootEvictionRoutes.d.ts +11 -0
  208. package/dist/types/src/RootEvictionRoutes.d.ts.map +1 -0
  209. package/package.json +109 -13
@@ -1,8 +1,42 @@
1
1
  "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
2
35
  var __importDefault = (this && this.__importDefault) || function (mod) {
3
36
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
37
  };
5
38
  Object.defineProperty(exports, "__esModule", { value: true });
39
+ const node_http_1 = require("node:http");
6
40
  const utils_1 = require("@bsv/sdk/primitives/utils");
7
41
  const express_1 = __importDefault(require("express"));
8
42
  const body_parser_1 = __importDefault(require("body-parser"));
@@ -285,6 +319,7 @@ class OverlayExpress {
285
319
  batchSize: undefined,
286
320
  maxReportResults: undefined
287
321
  };
322
+ this.privateOverlayOptions = {};
288
323
  // Health endpoint configuration
289
324
  this.healthConfig = {
290
325
  includeDetails: false,
@@ -310,6 +345,10 @@ class OverlayExpress {
310
345
  contentSecurityPolicy: "default-src 'none'; script-src 'none'; style-src 'self' 'unsafe-inline' https://cdn.jsdelivr.net; img-src 'self' data: https:; connect-src 'self' https:; font-src 'self' https://cdn.jsdelivr.net; base-uri 'none'; form-action 'none'; frame-ancestors 'none'"
311
346
  }
312
347
  };
348
+ // Application routers mounted by start(), in registration order
349
+ this.registeredRouters = [];
350
+ // Set once start() begins wiring routes; later registrations could never be reached
351
+ this.startInvoked = false;
313
352
  if (adminToken !== undefined)
314
353
  assertSharedSecret(adminToken, 'The administrative Bearer token');
315
354
  this.advertisableFQDN = normalizeAdvertisableFQDN(advertisableFQDN);
@@ -558,6 +597,26 @@ class OverlayExpress {
558
597
  });
559
598
  this.logger.log(chalk_1.default.blue(`Registered health check ${definition.name}`));
560
599
  }
600
+ /**
601
+ * Registers an application router. Its factory runs during `start()`, after the BRC-103
602
+ * authentication middleware is mounted and before the admin routes and the 404 handler, so
603
+ * the router inherits CORS, body parsing, response limits, and `req.auth`.
604
+ *
605
+ * @param path - Mount path, beginning with "/"
606
+ * @param factory - Receives the engine and server wallet and returns the router
607
+ */
608
+ registerRouter(path, factory) {
609
+ if (this.startInvoked)
610
+ throw new Error('registerRouter must be called before start()');
611
+ if (typeof path !== 'string' || !path.startsWith('/')) {
612
+ throw new TypeError('Router path must begin with "/"');
613
+ }
614
+ if (typeof factory !== 'function')
615
+ throw new TypeError('Router factory must be a function');
616
+ this.registeredRouters.push({ path, factory });
617
+ this.logger.log(chalk_1.default.blue(`Registered router at ${path}`));
618
+ return this;
619
+ }
561
620
  /**
562
621
  * Configures the admin identity key for wallet-based admin detection.
563
622
  * When set, the frontend can compare the user's wallet identity key against this
@@ -581,6 +640,111 @@ class OverlayExpress {
581
640
  this.authSessionManager = sessionManager;
582
641
  this.logger.log(chalk_1.default.blue('BSV authentication session manager has been configured.'));
583
642
  }
643
+ /**
644
+ * Opt in to a durable BRC-193 companion at its signed concrete base path.
645
+ * This never upgrades an existing finite LookupService or changes /lookup.
646
+ * Configure before start; the host retains ownership of provider storage.
647
+ */
648
+ configureOutputLookup(options) {
649
+ if (this.isListening)
650
+ throw new Error('Configure the live lookup companion before start');
651
+ this.outputLookup = {
652
+ ...options,
653
+ chain: { ...options.chain },
654
+ allowedOrigins: [...options.allowedOrigins]
655
+ };
656
+ }
657
+ /**
658
+ * Explicit root coordination routes sharing this host's authentication wallet.
659
+ * Configure before start. The caller retains database and worker ownership;
660
+ * this does not publish capabilities or retrofit existing serving paths.
661
+ */
662
+ configureRootEviction(options) {
663
+ if (this.isListening)
664
+ throw new Error('Configure root coordination before start');
665
+ assertSingleLineString(options.identity, 'Root coordination identity', 66, false);
666
+ if (options.allowedOrigins !== undefined && !Array.isArray(options.allowedOrigins))
667
+ throw new TypeError('Root origins must be an array');
668
+ this.rootEviction = {
669
+ ...options,
670
+ ...(options.allowedOrigins === undefined
671
+ ? {}
672
+ : { allowedOrigins: [...options.allowedOrigins] })
673
+ };
674
+ }
675
+ /**
676
+ * Opt-in non-final proposal routes; storage, policy and admission remain caller-owned.
677
+ * The closure retains the journal's record type without adding SDK types to legacy
678
+ * host declarations. No proposal enters ordinary admission except explicit finalize.
679
+ */
680
+ configureProposals(options) {
681
+ if (this.isListening)
682
+ throw new Error('Configure proposals before start');
683
+ assertSingleLineString(options.identity, 'Proposal identity', 66, false);
684
+ if (options.allowedOrigins !== undefined && !Array.isArray(options.allowedOrigins))
685
+ throw new TypeError('Proposal origins must be an array');
686
+ const owned = {
687
+ ...options,
688
+ ...(options.allowedOrigins === undefined
689
+ ? {}
690
+ : { allowedOrigins: [...options.allowedOrigins] })
691
+ };
692
+ this.proposalIdentity = options.identity;
693
+ this.proposalRoutes = async (authenticate, handleHandshake, limits) => {
694
+ var _a, _b, _c;
695
+ const { createProposalRouter } = await Promise.resolve().then(() => __importStar(require('./ProposalRoutes.js')));
696
+ const origins = (_a = owned.allowedOrigins) !== null && _a !== void 0 ? _a : limits.origins;
697
+ return createProposalRouter({
698
+ ...owned,
699
+ authenticate,
700
+ handleHandshake,
701
+ allowedOrigins: origins === '*' ? undefined : origins,
702
+ maximumRequestBytes: Math.min((_b = owned.maximumRequestBytes) !== null && _b !== void 0 ? _b : 1048576, limits.request),
703
+ maximumResponseBytes: Math.min((_c = owned.maximumResponseBytes) !== null && _c !== void 0 ? _c : 4194304, limits.response)
704
+ });
705
+ };
706
+ }
707
+ /** Optional private acquisition; the application owns durable storage and workers. */
708
+ configurePrivateAcquisition(options) {
709
+ if (this.isListening)
710
+ throw new Error('Configure private acquisition before start');
711
+ if (options.allowedOrigins !== undefined && !Array.isArray(options.allowedOrigins))
712
+ throw new TypeError('Private overlay origins must be an array');
713
+ this.privateOverlayOptions.acquisition = {
714
+ ...options,
715
+ ...(options.allowedOrigins === undefined
716
+ ? {}
717
+ : { allowedOrigins: [...options.allowedOrigins] })
718
+ };
719
+ }
720
+ /** Optional private publication using the same authentication and native response gate. */
721
+ configurePrivatePublication(options) {
722
+ if (this.isListening)
723
+ throw new Error('Configure private publication before start');
724
+ if (options.allowedOrigins !== undefined && !Array.isArray(options.allowedOrigins))
725
+ throw new TypeError('Private overlay origins must be an array');
726
+ this.privateOverlayOptions.publication = {
727
+ ...options,
728
+ ...(options.allowedOrigins === undefined
729
+ ? {}
730
+ : { allowedOrigins: [...options.allowedOrigins] })
731
+ };
732
+ }
733
+ /** Optional selected-host covenant purchases. The application owns durable
734
+ * preparation, exact transaction validation, release and physical disclosure.
735
+ */
736
+ configurePrivatePurchase(options) {
737
+ if (this.isListening)
738
+ throw new Error('Configure private purchase before start');
739
+ if (options.allowedOrigins !== undefined && !Array.isArray(options.allowedOrigins))
740
+ throw new TypeError('Private overlay origins must be an array');
741
+ this.privateOverlayOptions.purchase = {
742
+ ...options,
743
+ ...(options.allowedOrigins === undefined
744
+ ? {}
745
+ : { allowedOrigins: [...options.allowedOrigins] })
746
+ };
747
+ }
584
748
  /**
585
749
  * Configures the logger to be used by the server.
586
750
  * @param logger - A logger object (e.g., console)
@@ -1678,8 +1842,45 @@ class OverlayExpress {
1678
1842
  * Sets up routes and begins listening on the configured port.
1679
1843
  */
1680
1844
  async start() {
1845
+ var _a;
1846
+ var _b, _c, _d, _e, _f, _g, _h, _j;
1681
1847
  const engine = this.ensureEngine();
1682
1848
  const knex = this.ensureKnex();
1849
+ const rootEviction = this.rootEviction;
1850
+ const proposalRoutes = this.proposalRoutes;
1851
+ let privateOverlay;
1852
+ if (this.privateOverlayOptions.acquisition ||
1853
+ this.privateOverlayOptions.publication ||
1854
+ this.privateOverlayOptions.purchase) {
1855
+ const { PrivateOverlayHost } = await Promise.resolve().then(() => __importStar(require('./PrivateOverlayHost.js')));
1856
+ privateOverlay = new PrivateOverlayHost(this.privateOverlayOptions);
1857
+ }
1858
+ const authenticatedLookup = ((_a = this.outputLookup) === null || _a === void 0 ? void 0 : _a.authentication) === 'brc103';
1859
+ let companionAuth;
1860
+ if (authenticatedLookup || rootEviction || proposalRoutes || privateOverlay) {
1861
+ if (!this.serverWallet) {
1862
+ if (authenticatedLookup)
1863
+ throw new Error('Authenticated live lookup requires a server wallet');
1864
+ if (rootEviction)
1865
+ throw new Error('Root coordination requires a server wallet');
1866
+ if (privateOverlay)
1867
+ throw new Error('Private overlays require a server wallet');
1868
+ throw new Error('Proposals require a server wallet');
1869
+ }
1870
+ const { publicKey } = await this.serverWallet.getPublicKey({ identityKey: true });
1871
+ if (authenticatedLookup && publicKey !== this.outputLookup.identity)
1872
+ throw new Error('Live lookup identity must match the server authentication wallet');
1873
+ if (rootEviction && publicKey !== rootEviction.identity)
1874
+ throw new Error('Root coordination identity must match the server authentication wallet');
1875
+ if (proposalRoutes && publicKey !== this.proposalIdentity)
1876
+ throw new Error('Proposal identity must match the server authentication wallet');
1877
+ privateOverlay === null || privateOverlay === void 0 ? void 0 : privateOverlay.requireIdentity(publicKey);
1878
+ companionAuth = (0, auth_express_middleware_1.createAuthMiddleware)({
1879
+ wallet: this.serverWallet,
1880
+ sessionManager: this.authSessionManager,
1881
+ allowUnauthenticated: true
1882
+ });
1883
+ }
1683
1884
  const hasConfiguredArcProvider = (typeof this.arcApiKey === 'string' && this.arcApiKey.length > 0) ||
1684
1885
  (typeof this.arcadeUrl === 'string' && this.arcadeUrl.length > 0);
1685
1886
  if (hasConfiguredArcProvider &&
@@ -1687,6 +1888,7 @@ class OverlayExpress {
1687
1888
  throw new Error('ARC/Arcade is configured without an ARC callback token; configureArcCallbackToken is required');
1688
1889
  }
1689
1890
  this.startTime = new Date();
1891
+ this.startInvoked = true;
1690
1892
  const edgePolicy = this.edgePolicyConfig;
1691
1893
  const resourceProfile = (0, edgePolicy_js_1.readResourceProfile)(edgePolicy.environmentPrefix);
1692
1894
  const maxResponseBytes = (0, edgePolicy_js_1.readResourceLimit)(edgePolicy.environmentPrefix, 'MAX_RESPONSE_BYTES', (0, edgePolicy_js_1.profileValue)(resourceProfile, {
@@ -1766,14 +1968,58 @@ class OverlayExpress {
1766
1968
  ...edgePolicy.securityHeaders,
1767
1969
  environmentPrefix: edgePolicy.environmentPrefix
1768
1970
  }));
1971
+ const requestCapacity = (0, edgePolicy_js_1.concurrencyLimit)(edgePolicy.environmentPrefix, edgePolicy.maxConcurrentRequests === 200
1972
+ ? (0, edgePolicy_js_1.profileValue)(resourceProfile, { small: 8, standard: 24, highThroughput: 96 })
1973
+ : edgePolicy.maxConcurrentRequests);
1974
+ if (this.outputLookup || rootEviction || proposalRoutes || privateOverlay) {
1975
+ // All companions share host capacity, including long polls. Raw signed
1976
+ // requests stay before legacy parsers, transformations and payload logging.
1977
+ this.app.use(requestCapacity);
1978
+ const jsonBytes = (0, edgePolicy_js_1.readBodyLimitBytes)(`${edgePolicy.environmentPrefix}_JSON`, edgePolicy.jsonBodyLimitBytes);
1979
+ if (this.outputLookup) {
1980
+ const { createOutputLookupRouter } = await Promise.resolve().then(() => __importStar(require('./OutputLookupRoutes.js')));
1981
+ this.app.use(createOutputLookupRouter({
1982
+ ...this.outputLookup,
1983
+ authenticate: companionAuth,
1984
+ maximumRequestBytes: Math.min((_b = this.outputLookup.maximumRequestBytes) !== null && _b !== void 0 ? _b : 1048576, jsonBytes),
1985
+ maximumResponseBytes: Math.min((_c = this.outputLookup.maximumResponseBytes) !== null && _c !== void 0 ? _c : 4194304, maxResponseBytes === -1 ? 4194304 : maxResponseBytes)
1986
+ }));
1987
+ }
1988
+ if (rootEviction) {
1989
+ const { createRootEvictionRouter } = await Promise.resolve().then(() => __importStar(require('./RootEvictionRoutes.js')));
1990
+ const originSetting = (_e = (_d = rootEviction.allowedOrigins) !== null && _d !== void 0 ? _d : edgePolicy.allowedOrigins) !== null && _e !== void 0 ? _e : (0, edgePolicy_js_1.readCorsOriginSetting)(edgePolicy.environmentPrefix);
1991
+ this.app.use(createRootEvictionRouter({
1992
+ ...rootEviction,
1993
+ authenticate: companionAuth,
1994
+ handleHandshake: !authenticatedLookup,
1995
+ allowedOrigins: originSetting === '*' ? undefined : originSetting,
1996
+ maximumRequestBytes: Math.min((_f = rootEviction.maximumRequestBytes) !== null && _f !== void 0 ? _f : 1048576, jsonBytes),
1997
+ maximumResponseBytes: Math.min((_g = rootEviction.maximumResponseBytes) !== null && _g !== void 0 ? _g : 1048576, maxResponseBytes === -1 ? 1048576 : maxResponseBytes)
1998
+ }));
1999
+ }
2000
+ if (proposalRoutes) {
2001
+ this.app.use(await proposalRoutes(companionAuth, !authenticatedLookup && !rootEviction, {
2002
+ request: jsonBytes,
2003
+ response: maxResponseBytes === -1 ? 4194304 : maxResponseBytes,
2004
+ origins: (_h = edgePolicy.allowedOrigins) !== null && _h !== void 0 ? _h : (0, edgePolicy_js_1.readCorsOriginSetting)(edgePolicy.environmentPrefix)
2005
+ }));
2006
+ }
2007
+ if (privateOverlay) {
2008
+ for (const router of privateOverlay.routes(companionAuth, !authenticatedLookup && !rootEviction && !proposalRoutes, {
2009
+ request: jsonBytes,
2010
+ response: maxResponseBytes === -1 ? 4194304 : maxResponseBytes,
2011
+ origins: (_j = edgePolicy.allowedOrigins) !== null && _j !== void 0 ? _j : (0, edgePolicy_js_1.readCorsOriginSetting)(edgePolicy.environmentPrefix)
2012
+ }))
2013
+ this.app.use(router);
2014
+ }
2015
+ }
1769
2016
  this.app.use((0, edgePolicy_js_1.corsPolicy)({
1770
2017
  environmentPrefix: edgePolicy.environmentPrefix,
1771
2018
  allowedOrigins: edgePolicy.allowedOrigins,
1772
2019
  methods: ['GET', 'POST', 'OPTIONS']
1773
2020
  }));
1774
- this.app.use((0, edgePolicy_js_1.concurrencyLimit)(edgePolicy.environmentPrefix, edgePolicy.maxConcurrentRequests === 200
1775
- ? (0, edgePolicy_js_1.profileValue)(resourceProfile, { small: 8, standard: 24, highThroughput: 96 })
1776
- : edgePolicy.maxConcurrentRequests));
2021
+ if (!this.outputLookup && !rootEviction && !proposalRoutes && !privateOverlay)
2022
+ this.app.use(requestCapacity);
1777
2023
  this.app.use(body_parser_1.default.json({
1778
2024
  limit: (0, edgePolicy_js_1.readBodyLimitBytes)(`${edgePolicy.environmentPrefix}_JSON`, edgePolicy.jsonBodyLimitBytes),
1779
2025
  type: 'application/json'
@@ -2275,7 +2521,7 @@ class OverlayExpress {
2275
2521
  * are present, allowing Bearer token fallback.
2276
2522
  */
2277
2523
  if (this.serverWallet !== undefined) {
2278
- const bsvAuth = (0, auth_express_middleware_1.createAuthMiddleware)({
2524
+ const bsvAuth = companionAuth !== null && companionAuth !== void 0 ? companionAuth : (0, auth_express_middleware_1.createAuthMiddleware)({
2279
2525
  wallet: this.serverWallet,
2280
2526
  sessionManager: this.authSessionManager,
2281
2527
  allowUnauthenticated: true
@@ -2283,6 +2529,13 @@ class OverlayExpress {
2283
2529
  this.app.use(bsvAuth);
2284
2530
  this.logger.log(chalk_1.default.blue('BSV mutual authentication middleware enabled.'));
2285
2531
  }
2532
+ // Routers mount strictly in registration order: each factory starts after the previous one
2533
+ // was mounted. reduce invokes every callback up front, so nothing may run before the await.
2534
+ await this.registeredRouters.reduce(async (previous, { path, factory }) => {
2535
+ await previous;
2536
+ this.app.use(path, await factory({ engine, wallet: this.serverWallet }));
2537
+ this.logger.log(chalk_1.default.blue(`Mounted registered router at ${path}`));
2538
+ }, Promise.resolve());
2286
2539
  /**
2287
2540
  * Middleware for checking admin authentication.
2288
2541
  * Supports two authentication methods:
@@ -2840,10 +3093,14 @@ class OverlayExpress {
2840
3093
  });
2841
3094
  await this.runStartupSync();
2842
3095
  // Start listening on the configured port
2843
- this.server = this.app.listen(this.port, () => {
3096
+ const listening = () => {
2844
3097
  this.isListening = true;
2845
3098
  this.logger.log(chalk_1.default.green.bold(`${this.name} is ready and listening on local port ${this.port}`));
2846
- });
3099
+ };
3100
+ this.server =
3101
+ (privateOverlay === null || privateOverlay === void 0 ? void 0 : privateOverlay.maximumHeaderBytes) === undefined
3102
+ ? this.app.listen(this.port, listening)
3103
+ : (0, node_http_1.createServer)({ maxHeaderSize: privateOverlay.maximumHeaderBytes }, this.app).listen(this.port, listening);
2847
3104
  (0, edgePolicy_js_1.configureHttpServer)(this.server, edgePolicy.environmentPrefix, edgePolicy.http);
2848
3105
  }
2849
3106
  /**