@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
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ProposalResponseGuard.d.ts","sourceRoot":"","sources":["../../../src/ProposalResponseGuard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAGvC,OAAO,KAAK,EACV,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,wBAAwB,CAAA;AAG/B,MAAM,WAAW,4BAA4B,CAAC,KAAK,GAAG,OAAO;IAC3D,OAAO,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAA;IACnC,MAAM,EAAE,kBAAkB,CAAA;IAC1B,oEAAoE;IACpE,OAAO,EAAE;QAAE,OAAO,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,OAAO,CAAA;KAAE,CAAA;IACrE,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAA;IAC3C,wFAAwF;IACxF,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;CACjD;AAED,qFAAqF;AACrF,wBAAgB,qBAAqB,CAAC,KAAK,EACzC,GAAG,EAAE,QAAQ,EACb,OAAO,EAAE,4BAA4B,CAAC,KAAK,CAAC,GAC3C,IAAI,CA2DN"}
@@ -0,0 +1,10 @@
1
+ import { type Router } from 'express';
2
+ import type { ProposalRouteOptions } from './ProposalHTTPPorts.js';
3
+ export type * from './ProposalHTTPPorts.js';
4
+ /**
5
+ * Optional BRC-194 endpoints; mount before parsers, compression, caches or body logs.
6
+ * Hosts own TLS, pre-authentication rate limits, bounded authentication/signing,
7
+ * capability publication and expiry workers. Recording never invokes a wallet.
8
+ */
9
+ export declare function createProposalRouter<Entry>(options: ProposalRouteOptions<Entry>): Router;
10
+ //# sourceMappingURL=ProposalRoutes.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ProposalRoutes.d.ts","sourceRoot":"","sources":["../../../src/ProposalRoutes.ts"],"names":[],"mappings":"AAAA,OAAgB,EAAoD,KAAK,MAAM,EAAE,MAAM,SAAS,CAAA;AAiBhG,OAAO,KAAK,EAGV,oBAAoB,EACrB,MAAM,wBAAwB,CAAA;AAC/B,mBAAmB,wBAAwB,CAAA;AAkP3C;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,EAAE,oBAAoB,CAAC,KAAK,CAAC,GAAG,MAAM,CAExF"}
@@ -0,0 +1,8 @@
1
+ import type { Request, Response } from 'express';
2
+ /** Default public, credential-free access; an explicit array opts into exact origins. */
3
+ export declare function rootHTTPOrigins(input?: readonly string[]): ReadonlySet<string> | undefined;
4
+ export declare function rootHTTPCORS(req: Request, res: Response, origins?: ReadonlySet<string>): boolean;
5
+ /** Allow only locally constructed CORS/profile fields onto a replacement response. */
6
+ export declare function rootHTTPControlHeaders(res: Response): Record<string, string>;
7
+ export declare function sendRootHTTPError(res: Response, error: unknown): void;
8
+ //# sourceMappingURL=RootEvictionHTTPPolicy.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RootEvictionHTTPPolicy.d.ts","sourceRoot":"","sources":["../../../src/RootEvictionHTTPPolicy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AA4BhD,yFAAyF;AACzF,wBAAgB,eAAe,CAAC,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS,CAE1F;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,OAAO,CAiBhG;AAED,sFAAsF;AACtF,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAc5E;AAED,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAQrE"}
@@ -0,0 +1,73 @@
1
+ import type { RequestHandler } from 'express';
2
+ /** Structural journal port: main host declarations do not require optional SDK types. */
3
+ export interface RootEvictionHTTPJournal {
4
+ head(): Promise<{
5
+ revision: string;
6
+ }>;
7
+ enqueue(candidate: {
8
+ revision: string;
9
+ targets: {
10
+ service: 'ls_ship' | 'ls_slap';
11
+ outpoint: {
12
+ chain: {
13
+ network: string;
14
+ genesisHash: string;
15
+ };
16
+ txid: string;
17
+ outputIndex: number;
18
+ };
19
+ advertisementDigest: string;
20
+ }[];
21
+ bytes: Uint8Array;
22
+ }, authorize: () => boolean, enqueue: (bytes: Uint8Array) => undefined): Promise<void>;
23
+ }
24
+ export interface RootEvictionHTTPAccess {
25
+ operation: 'submit' | 'status';
26
+ principal: string;
27
+ requester: string;
28
+ requestId: string;
29
+ }
30
+ export interface RootEvictionHTTPResponse {
31
+ body: string;
32
+ headers: Record<string, string>;
33
+ head: {
34
+ revision: string;
35
+ };
36
+ access: RootEvictionHTTPAccess;
37
+ }
38
+ /** Structural port preserves this package's ESM and CommonJS support. */
39
+ export interface RootEvictionHTTPCompanion {
40
+ submit(text: string, caller: {
41
+ principal: string;
42
+ capabilityDigest: string;
43
+ }, manifest: unknown, signal?: AbortSignal): Promise<RootEvictionHTTPResponse>;
44
+ status(text: string, caller: {
45
+ principal: string;
46
+ capabilityDigest: string;
47
+ }, signal?: AbortSignal): Promise<RootEvictionHTTPResponse>;
48
+ }
49
+ export interface RootEvictionRouteOptions {
50
+ /** Share one bounded service instance across requests. */
51
+ companion: RootEvictionHTTPCompanion;
52
+ /** The same durable journal and gate used by the companion and all serving paths. */
53
+ journal: RootEvictionHTTPJournal;
54
+ baseURL: string;
55
+ /** Must be the same BRC-103/104 middleware instance used for this origin's handshake. */
56
+ authenticate: RequestHandler;
57
+ /** Defaults to true; mount the origin's handshake exactly once. */
58
+ handleHandshake?: boolean;
59
+ /** Synchronous local snapshot only. Return undefined during discovery unavailability. */
60
+ manifest(): unknown;
61
+ /**
62
+ * Synchronous current authority at native enqueue, including current policy/context.
63
+ * Undefined access requests permission for a sanitized control error only.
64
+ * Coordinate authorization changes with the journal's decision/send gate.
65
+ */
66
+ authorize(identity: string, access: Readonly<RootEvictionHTTPAccess> | undefined): boolean;
67
+ /** Omit for public credential-free CORS. An explicit list opts into exact origins. */
68
+ allowedOrigins?: readonly string[];
69
+ maximumRequests?: number;
70
+ maximumRequestBytes?: number;
71
+ maximumResponseBytes?: number;
72
+ }
73
+ //# sourceMappingURL=RootEvictionHTTPPorts.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RootEvictionHTTPPorts.d.ts","sourceRoot":"","sources":["../../../src/RootEvictionHTTPPorts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE7C,yFAAyF;AACzF,MAAM,WAAW,uBAAuB;IACtC,IAAI,IAAI,OAAO,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACrC,OAAO,CACL,SAAS,EAAE;QACT,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE;YACP,OAAO,EAAE,SAAS,GAAG,SAAS,CAAA;YAC9B,QAAQ,EAAE;gBACR,KAAK,EAAE;oBAAE,OAAO,EAAE,MAAM,CAAC;oBAAC,WAAW,EAAE,MAAM,CAAA;iBAAE,CAAA;gBAC/C,IAAI,EAAE,MAAM,CAAA;gBACZ,WAAW,EAAE,MAAM,CAAA;aACpB,CAAA;YACD,mBAAmB,EAAE,MAAM,CAAA;SAC5B,EAAE,CAAA;QACH,KAAK,EAAE,UAAU,CAAA;KAClB,EACD,SAAS,EAAE,MAAM,OAAO,EACxB,OAAO,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,SAAS,GACxC,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,QAAQ,GAAG,QAAQ,CAAA;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AACD,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,IAAI,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAA;IAC1B,MAAM,EAAE,sBAAsB,CAAA;CAC/B;AACD,yEAAyE;AACzE,MAAM,WAAW,yBAAyB;IACxC,MAAM,CACJ,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAE,EACvD,QAAQ,EAAE,OAAO,EACjB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,wBAAwB,CAAC,CAAA;IACpC,MAAM,CACJ,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAE,EACvD,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,wBAAwB,CAAC,CAAA;CACrC;AACD,MAAM,WAAW,wBAAwB;IACvC,0DAA0D;IAC1D,SAAS,EAAE,yBAAyB,CAAA;IACpC,qFAAqF;IACrF,OAAO,EAAE,uBAAuB,CAAA;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,yFAAyF;IACzF,YAAY,EAAE,cAAc,CAAA;IAC5B,mEAAmE;IACnE,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,yFAAyF;IACzF,QAAQ,IAAI,OAAO,CAAA;IACnB;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,sBAAsB,CAAC,GAAG,SAAS,GAAG,OAAO,CAAA;IAC1F,sFAAsF;IACtF,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAClC,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAC9B"}
@@ -0,0 +1,38 @@
1
+ import type { Response } from 'express';
2
+ import { type OutputRootEvictionTarget } from '@bsv/sdk';
3
+ type ServingTarget = Pick<OutputRootEvictionTarget, 'service' | 'outpoint' | 'advertisementDigest'>;
4
+ /** Structural companion port; the transport does not import a particular database. */
5
+ export interface RootAdvertisementSendJournal {
6
+ head(): Promise<{
7
+ revision: string;
8
+ }>;
9
+ enqueue(candidate: {
10
+ revision: string;
11
+ targets: ServingTarget[];
12
+ bytes: Uint8Array;
13
+ }, authorize: () => boolean, enqueue: (bytes: Uint8Array) => undefined): Promise<void>;
14
+ }
15
+ export interface RootAdvertisementResponseGuard {
16
+ journal: RootAdvertisementSendJournal;
17
+ /** Capture before reading or hydrating the complete response. */
18
+ revision: string;
19
+ /** Every disclosed advertisement, including references disclosed in headers. */
20
+ targets: readonly ServingTarget[];
21
+ /**
22
+ * Runs synchronously under the journal's shared decision/send gate. Access
23
+ * writers must use that same gate or an explicitly coherent local policy port.
24
+ * Control permission authorizes only the sanitized, empty-target error.
25
+ */
26
+ authorize(identityKey: string, kind: 'data' | 'control'): boolean;
27
+ /** Complete safe CORS/profile headers for an error; candidate headers are never copied. */
28
+ controlHeaders: Readonly<Record<string, string>>;
29
+ }
30
+ /**
31
+ * Install after authentication and before sending. Hydration and signing finish
32
+ * outside the root lock; actual native enqueue and current access/target checks
33
+ * happen together inside it. A stale snapshot/live replay is reset in full.
34
+ * This companion does not infer the response's target inventory or mount routes.
35
+ */
36
+ export declare function guardRootAdvertisementResponse(res: Response, options: RootAdvertisementResponseGuard): void;
37
+ export {};
38
+ //# sourceMappingURL=RootEvictionResponseGuard.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RootEvictionResponseGuard.d.ts","sourceRoot":"","sources":["../../../src/RootEvictionResponseGuard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAEvC,OAAO,EAIL,KAAK,wBAAwB,EAE9B,MAAM,UAAU,CAAA;AAEjB,KAAK,aAAa,GAAG,IAAI,CAAC,wBAAwB,EAAE,SAAS,GAAG,UAAU,GAAG,qBAAqB,CAAC,CAAA;AAEnG,sFAAsF;AACtF,MAAM,WAAW,4BAA4B;IAC3C,IAAI,IAAI,OAAO,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACrC,OAAO,CACL,SAAS,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,aAAa,EAAE,CAAC;QAAC,KAAK,EAAE,UAAU,CAAA;KAAE,EAC5E,SAAS,EAAE,MAAM,OAAO,EACxB,OAAO,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,SAAS,GACxC,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB;AAED,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,4BAA4B,CAAA;IACrC,iEAAiE;IACjE,QAAQ,EAAE,MAAM,CAAA;IAChB,gFAAgF;IAChF,OAAO,EAAE,SAAS,aAAa,EAAE,CAAA;IACjC;;;;OAIG;IACH,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAA;IACjE,2FAA2F;IAC3F,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;CACjD;AAsBD;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAC5C,GAAG,EAAE,QAAQ,EACb,OAAO,EAAE,8BAA8B,GACtC,IAAI,CAkDN"}
@@ -0,0 +1,11 @@
1
+ import { type Router } from 'express';
2
+ import type { RootEvictionRouteOptions } from './RootEvictionHTTPPorts.js';
3
+ export type { RootEvictionHTTPAccess, RootEvictionHTTPCompanion, RootEvictionHTTPJournal, RootEvictionHTTPResponse, RootEvictionRouteOptions } from './RootEvictionHTTPPorts.js';
4
+ /**
5
+ * Mount at the app root before body parsers, compression, caches and payload logs.
6
+ * Provides exact request/status paths and optionally the shared handshake only.
7
+ * Capability publication, TLS, pre-auth rate limits and server deadlines belong
8
+ * to the host. Installing these routes alone does not enable the complete profile.
9
+ */
10
+ export declare function createRootEvictionRouter(options: RootEvictionRouteOptions): Router;
11
+ //# sourceMappingURL=RootEvictionRoutes.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RootEvictionRoutes.d.ts","sourceRoot":"","sources":["../../../src/RootEvictionRoutes.ts"],"names":[],"mappings":"AAAA,OAAgB,EAAoD,KAAK,MAAM,EAAE,MAAM,SAAS,CAAA;AAiBhG,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAC1E,YAAY,EACV,sBAAsB,EACtB,yBAAyB,EACzB,uBAAuB,EACvB,wBAAwB,EACxB,wBAAwB,EACzB,MAAM,4BAA4B,CAAA;AA2MnC;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,wBAAwB,GAAG,MAAM,CAElF"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bsv/overlay-express",
3
- "version": "2.7.4",
3
+ "version": "2.8.0",
4
4
  "sideEffects": false,
5
5
  "engines": {
6
6
  "node": ">=22"
@@ -41,6 +41,76 @@
41
41
  "types": "./dist/cjs/src/*.d.ts",
42
42
  "default": "./dist/cjs/src/*.js"
43
43
  }
44
+ },
45
+ "./output-lookup": {
46
+ "import": {
47
+ "types": "./dist/types/src/OutputLookupRoutes.d.ts",
48
+ "default": "./dist/esm/src/OutputLookupRoutes.js"
49
+ },
50
+ "require": {
51
+ "types": "./dist/cjs/src/OutputLookupRoutes.d.ts",
52
+ "default": "./dist/cjs/src/OutputLookupRoutes.js"
53
+ }
54
+ },
55
+ "./root-eviction-response": {
56
+ "import": {
57
+ "types": "./dist/types/src/RootEvictionResponseGuard.d.ts",
58
+ "default": "./dist/esm/src/RootEvictionResponseGuard.js"
59
+ },
60
+ "require": {
61
+ "types": "./dist/cjs/src/RootEvictionResponseGuard.d.ts",
62
+ "default": "./dist/cjs/src/RootEvictionResponseGuard.js"
63
+ }
64
+ },
65
+ "./root-eviction": {
66
+ "import": {
67
+ "types": "./dist/types/src/RootEvictionRoutes.d.ts",
68
+ "default": "./dist/esm/src/RootEvictionRoutes.js"
69
+ },
70
+ "require": {
71
+ "types": "./dist/cjs/src/RootEvictionRoutes.d.ts",
72
+ "default": "./dist/cjs/src/RootEvictionRoutes.js"
73
+ }
74
+ },
75
+ "./proposals": {
76
+ "import": {
77
+ "types": "./dist/types/src/ProposalRoutes.d.ts",
78
+ "default": "./dist/esm/src/ProposalRoutes.js"
79
+ },
80
+ "require": {
81
+ "types": "./dist/cjs/src/ProposalRoutes.d.ts",
82
+ "default": "./dist/cjs/src/ProposalRoutes.js"
83
+ }
84
+ },
85
+ "./private-publication": {
86
+ "import": {
87
+ "types": "./dist/types/src/PrivatePublicationRoutes.d.ts",
88
+ "default": "./dist/esm/src/PrivatePublicationRoutes.js"
89
+ },
90
+ "require": {
91
+ "types": "./dist/cjs/src/PrivatePublicationRoutes.d.ts",
92
+ "default": "./dist/cjs/src/PrivatePublicationRoutes.js"
93
+ }
94
+ },
95
+ "./private-acquisition": {
96
+ "import": {
97
+ "types": "./dist/types/src/PrivateAcquisitionRoutes.d.ts",
98
+ "default": "./dist/esm/src/PrivateAcquisitionRoutes.js"
99
+ },
100
+ "require": {
101
+ "types": "./dist/cjs/src/PrivateAcquisitionRoutes.d.ts",
102
+ "default": "./dist/cjs/src/PrivateAcquisitionRoutes.js"
103
+ }
104
+ },
105
+ "./private-purchase": {
106
+ "import": {
107
+ "types": "./dist/types/src/PrivatePurchaseRoutes.d.ts",
108
+ "default": "./dist/esm/src/PrivatePurchaseRoutes.js"
109
+ },
110
+ "require": {
111
+ "types": "./dist/cjs/src/PrivatePurchaseRoutes.d.ts",
112
+ "default": "./dist/cjs/src/PrivatePurchaseRoutes.js"
113
+ }
44
114
  }
45
115
  },
46
116
  "repository": {
@@ -62,12 +132,13 @@
62
132
  },
63
133
  "homepage": "https://github.com/bsv-blockchain/ts-stack/tree/main/packages/overlays/overlay-express#readme",
64
134
  "devDependencies": {
65
- "@bsv/sdk": "^3.0.0",
135
+ "@bsv/sdk": "^4.0.1",
66
136
  "@jest/globals": "^30.5.1",
67
137
  "@types/body-parser": "^1.19.6",
68
138
  "@types/jest": "^30.0.0",
69
139
  "@types/node": "^26.6.1",
70
140
  "@typescript/native": "npm:typescript@7.0.2",
141
+ "express-rate-limit": "^8.6.1",
71
142
  "fast-check": "^4.9.0",
72
143
  "jest": "^30.5.1",
73
144
  "oxlint": "^1.83.0",
@@ -77,10 +148,10 @@
77
148
  "typescript": "npm:@typescript/typescript6@6.0.2"
78
149
  },
79
150
  "dependencies": {
80
- "@bsv/auth-express-middleware": "^2.2.9",
81
- "@bsv/overlay": "^2.6.3",
82
- "@bsv/overlay-discovery-services": "^2.2.7",
83
- "@bsv/wallet-toolbox-client": "^2.14.5",
151
+ "@bsv/auth-express-middleware": "^2.3.0",
152
+ "@bsv/overlay": "^2.7.0",
153
+ "@bsv/overlay-discovery-services": "^2.2.9",
154
+ "@bsv/wallet-toolbox-client": "^2.15.1",
84
155
  "@types/express": "^5.0.6",
85
156
  "body-parser": "^2.3.0",
86
157
  "chalk": "^6.0.0",
@@ -90,24 +161,49 @@
90
161
  "uuid": "^14.0.2"
91
162
  },
92
163
  "peerDependencies": {
93
- "@bsv/sdk": "^2.4.0 || ^3.0.0"
164
+ "@bsv/sdk": "^2.4.0 || ^3.0.0 || ^4.0.1"
94
165
  },
95
166
  "peerDependenciesMeta": {
96
167
  "@bsv/sdk": {
97
168
  "optional": false
98
169
  }
99
170
  },
171
+ "typesVersions": {
172
+ "*": {
173
+ "output-lookup": [
174
+ "dist/types/src/OutputLookupRoutes.d.ts"
175
+ ],
176
+ "root-eviction-response": [
177
+ "dist/types/src/RootEvictionResponseGuard.d.ts"
178
+ ],
179
+ "root-eviction": [
180
+ "dist/types/src/RootEvictionRoutes.d.ts"
181
+ ],
182
+ "proposals": [
183
+ "dist/types/src/ProposalRoutes.d.ts"
184
+ ],
185
+ "private-publication": [
186
+ "dist/types/src/PrivatePublicationRoutes.d.ts"
187
+ ],
188
+ "private-acquisition": [
189
+ "dist/types/src/PrivateAcquisitionRoutes.d.ts"
190
+ ],
191
+ "private-purchase": [
192
+ "dist/types/src/PrivatePurchaseRoutes.d.ts"
193
+ ]
194
+ }
195
+ },
100
196
  "scripts": {
101
- "test": "jest --watchman=false",
102
- "test:watch": "jest --watch",
103
- "test:coverage": "jest --coverage --watchman=false",
104
- "test:property": "jest --runInBand --watchman=false --runTestsByPath src/__tests/ReorgStream.property.test.ts",
197
+ "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watchman=false",
198
+ "test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch",
199
+ "test:coverage": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage --runInBand --watchman=false",
200
+ "test:property": "node --experimental-vm-modules node_modules/jest/bin/jest.js --runInBand --watchman=false --runTestsByPath src/__tests/ReorgStream.property.test.ts src/__tests__/OutputLookupRoutes.property.test.ts src/__tests__/RootEvictionResponseGuard.property.test.ts src/__tests__/RootEvictionRoutes.property.test.ts src/__tests__/ProposalRoutes.property.test.ts src/__tests__/PrivatePublicationRoutes.property.test.ts src/__tests__/PrivateAcquisitionRoutes.property.test.ts src/__tests__/PrivatePurchaseRoutes.property.test.ts",
105
201
  "test:live": "pnpm build && node ../../../scripts/run-governed-test.mjs live src/__tests__/OverlayProviders.live.test.ts",
106
202
  "format:check": "pnpm --workspace-root exec prettier --check \"packages/overlays/overlay-express/{README.md,jest.config.js,mod.ts,package.json,tsconfig*.json}\"",
107
203
  "lint": "oxlint mod.ts src jest.config.js --deny-warnings",
108
204
  "lint:ci": "pnpm lint",
109
- "pack:check": "pnpm --filter @bsv/overlay build && pnpm --filter @bsv/overlay-discovery-services build && pnpm build && node ../../../scripts/check-package-artifact.mjs . --exports ArcadeProvider,BanAwareLookupWrapper,BanAwareSHIPStorage,BanAwareSLAPStorage,BanAwareTopicManager,BanService,ChaintracksProvider,JanitorService,OverlayMonitor,ProviderChainBroadcaster,analyzeOverlayAnchorTip,analyzeOverlayLookupResponse,default,isTerminalArcStatus",
110
- "typecheck": "tsc --project tsconfig.base.json --noEmit --incremental false",
205
+ "pack:check": "pnpm --filter @bsv/overlay build && pnpm --filter @bsv/overlay-discovery-services build && pnpm build && node ../../../scripts/check-package-artifact.mjs . --exports ArcadeProvider,BanAwareLookupWrapper,BanAwareSHIPStorage,BanAwareSLAPStorage,BanAwareTopicManager,BanService,ChaintracksProvider,JanitorService,OverlayMonitor,ProviderChainBroadcaster,analyzeOverlayAnchorTip,analyzeOverlayLookupResponse,default,isTerminalArcStatus --entry-exports \"./output-lookup=createOutputLookupRouter;./root-eviction-response=guardRootAdvertisementResponse;./root-eviction=createRootEvictionRouter;./proposals=createProposalRouter;./private-publication=createPrivatePublicationRouter;./private-acquisition=createPrivateAcquisitionRouter;./private-purchase=createPrivatePurchaseRouter\" && node ../../../scripts/check-legacy-overlay-sdk.mjs",
206
+ "typecheck": "tsc --project tsconfig.base.json --noEmit --incremental false && tsc --project tsconfig.proposal-tests.json",
111
207
  "build": "tsc -b && tsconfig-to-dual-package tsconfig.cjs.json",
112
208
  "dev": "tsc -b -w",
113
209
  "doc": "ts2md --inputFilename=mod.ts --outputFilename=API.md --filenameSubstring=API --firstHeadingLevel=1",