@terreno/api 57.1.0 → 57.3.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 (283) hide show
  1. package/README.md +17 -7
  2. package/dist/actions.js +19 -7
  3. package/dist/adminTypes.d.ts +26 -0
  4. package/dist/api.d.ts +4 -0
  5. package/dist/api.js +12 -24
  6. package/dist/auth.d.ts +23 -10
  7. package/dist/auth.js +97 -32
  8. package/dist/authRecovery.d.ts +5 -0
  9. package/dist/authRecovery.js +350 -0
  10. package/dist/authTokens.d.ts +8 -0
  11. package/dist/authTokens.js +162 -0
  12. package/dist/betterAuth.d.ts +33 -0
  13. package/dist/betterAuthApp.d.ts +4 -0
  14. package/dist/betterAuthApp.js +26 -8
  15. package/dist/betterAuthSetup.d.ts +44 -2
  16. package/dist/betterAuthSetup.js +288 -18
  17. package/dist/collectionRegistry.d.ts +38 -0
  18. package/dist/collectionRegistry.js +72 -0
  19. package/dist/configurationApp.d.ts +11 -2
  20. package/dist/configurationApp.js +2 -4
  21. package/dist/docLoader.js +35 -6
  22. package/dist/expressServer.d.ts +26 -3
  23. package/dist/expressServer.js +79 -11
  24. package/dist/index.d.ts +16 -0
  25. package/dist/index.js +38 -2
  26. package/dist/mcp/auth.d.ts +1 -0
  27. package/dist/mcp/auth.js +47 -25
  28. package/dist/mcp/handlers.d.ts +1 -1
  29. package/dist/mcp/handlers.js +67 -233
  30. package/dist/mcp/query.d.ts +2 -2
  31. package/dist/mcp/registry.d.ts +1 -5
  32. package/dist/mcp/registry.js +31 -20
  33. package/dist/mcp/schemaGenerator.d.ts +2 -7
  34. package/dist/mcp/schemaGenerator.js +41 -116
  35. package/dist/mcp/server.d.ts +1 -0
  36. package/dist/mcp/server.js +1 -0
  37. package/dist/mcp/serviceTokens.d.ts +16 -0
  38. package/dist/mcp/serviceTokens.js +345 -0
  39. package/dist/mcp/types.d.ts +2 -2
  40. package/dist/models/mcpServiceToken.d.ts +3 -0
  41. package/dist/models/mcpServiceToken.js +208 -0
  42. package/dist/openApiBuilder.d.ts +5 -4
  43. package/dist/openApiBuilder.js +61 -8
  44. package/dist/openApiCompat.js +1 -1
  45. package/dist/openApiValidator.js +0 -2
  46. package/dist/plugins.d.ts +14 -1
  47. package/dist/plugins.js +17 -6
  48. package/dist/populate.d.ts +2 -2
  49. package/dist/populate.js +47 -42
  50. package/dist/rateLimit/applyTrustProxy.d.ts +3 -0
  51. package/dist/rateLimit/applyTrustProxy.js +17 -0
  52. package/dist/rateLimit/createStore.d.ts +2 -0
  53. package/dist/rateLimit/createStore.js +28 -0
  54. package/dist/rateLimit/memoryStore.d.ts +2 -0
  55. package/dist/rateLimit/memoryStore.js +108 -0
  56. package/dist/rateLimit/middleware.d.ts +11 -0
  57. package/dist/rateLimit/middleware.js +110 -0
  58. package/dist/rateLimit/mongoStore.d.ts +3 -0
  59. package/dist/rateLimit/mongoStore.js +122 -0
  60. package/dist/rateLimit/policies.d.ts +14 -0
  61. package/dist/rateLimit/policies.js +151 -0
  62. package/dist/rateLimit/redisStore.d.ts +3 -0
  63. package/dist/rateLimit/redisStore.js +155 -0
  64. package/dist/rateLimit/types.d.ts +54 -0
  65. package/dist/rateLimit/types.js +9 -0
  66. package/dist/rbac/access.js +5 -1
  67. package/dist/rbac/assertAllowed.d.ts +9 -0
  68. package/dist/rbac/assertAllowed.js +182 -0
  69. package/dist/rbac/modelRouterAccess.d.ts +1 -0
  70. package/dist/rbac/modelRouterAccess.js +8 -4
  71. package/dist/rbac/permissionUtils.js +3 -2
  72. package/dist/rbac/resolve.js +5 -4
  73. package/dist/rbac/routes.js +15 -6
  74. package/dist/rbac/statements.d.ts +10 -0
  75. package/dist/rbac/statements.js +13 -2
  76. package/dist/realtime/deprecation.d.ts +12 -0
  77. package/dist/realtime/deprecation.js +32 -0
  78. package/dist/realtime/realtimeApp.d.ts +1 -1
  79. package/dist/realtime/realtimeApp.js +10 -11
  80. package/dist/realtime/registry.d.ts +0 -31
  81. package/dist/realtime/registry.js +44 -31
  82. package/dist/realtime/socketAuth.d.ts +5 -5
  83. package/dist/realtime/socketAuth.js +11 -1
  84. package/dist/realtime/socketUser.d.ts +5 -1
  85. package/dist/realtime/types.d.ts +14 -4
  86. package/dist/schemaMetadata.d.ts +56 -0
  87. package/dist/schemaMetadata.js +513 -0
  88. package/dist/seedRunner.d.ts +88 -0
  89. package/dist/seedRunner.js +627 -0
  90. package/dist/sync/executors.d.ts +12 -2
  91. package/dist/sync/executors.js +8 -10
  92. package/dist/sync/loadHarness.js +28 -19
  93. package/dist/sync/models.js +26 -24
  94. package/dist/sync/mutationHandler.d.ts +9 -0
  95. package/dist/sync/mutationHandler.js +11 -6
  96. package/dist/sync/registrationSideEffects.d.ts +35 -0
  97. package/dist/sync/registrationSideEffects.js +151 -0
  98. package/dist/sync/registry.d.ts +2 -52
  99. package/dist/sync/registry.js +38 -187
  100. package/dist/sync/routes.js +3 -2
  101. package/dist/sync/scripts/compactTombstones.js +0 -2
  102. package/dist/sync/syncApp.d.ts +3 -3
  103. package/dist/sync/syncApp.js +4 -4
  104. package/dist/sync/syncBatch.js +3 -2
  105. package/dist/sync/syncSeqPlugin.d.ts +1 -1
  106. package/dist/sync/syncSeqPlugin.js +20 -16
  107. package/dist/terrenoApp.d.ts +19 -5
  108. package/dist/terrenoApp.js +66 -18
  109. package/dist/tests/models.d.ts +2 -0
  110. package/dist/tests/models.js +6 -0
  111. package/dist/types/authToken.d.ts +33 -0
  112. package/dist/types/authToken.js +2 -0
  113. package/dist/types/mcpServiceToken.d.ts +41 -0
  114. package/dist/types/mcpServiceToken.js +2 -0
  115. package/dist/webhooks/headerValue.d.ts +2 -0
  116. package/dist/webhooks/headerValue.js +14 -0
  117. package/dist/webhooks/idempotency/memoryStore.d.ts +10 -0
  118. package/dist/webhooks/idempotency/memoryStore.js +65 -0
  119. package/dist/webhooks/idempotency/mongoStore.d.ts +4 -0
  120. package/dist/webhooks/idempotency/mongoStore.js +150 -0
  121. package/dist/webhooks/idempotency/webhookReceipt.d.ts +62 -0
  122. package/dist/webhooks/idempotency/webhookReceipt.js +39 -0
  123. package/dist/webhooks/rawBody.d.ts +14 -0
  124. package/dist/webhooks/rawBody.js +22 -0
  125. package/dist/webhooks/timingSafeEqual.d.ts +4 -0
  126. package/dist/webhooks/timingSafeEqual.js +17 -0
  127. package/dist/webhooks/verifiers/hmac.d.ts +15 -0
  128. package/dist/webhooks/verifiers/hmac.js +49 -0
  129. package/dist/webhooks/verifiers/sendgrid.d.ts +10 -0
  130. package/dist/webhooks/verifiers/sendgrid.js +56 -0
  131. package/dist/webhooks/verifiers/stripe.d.ts +9 -0
  132. package/dist/webhooks/verifiers/stripe.js +99 -0
  133. package/dist/webhooks/verifiers/twilio.d.ts +9 -0
  134. package/dist/webhooks/verifiers/twilio.js +112 -0
  135. package/dist/webhooks/webhooksApp.d.ts +33 -0
  136. package/dist/webhooks/webhooksApp.js +195 -0
  137. package/package.json +5 -6
  138. package/src/__snapshots__/openApi.test.ts.snap +270 -0
  139. package/src/__snapshots__/openApiBuilder.test.ts.snap +30 -12
  140. package/src/__snapshots__/schemaMetadata.test.ts.snap +197 -0
  141. package/src/actions.ts +20 -13
  142. package/src/adminModelRouter.test.ts +133 -0
  143. package/src/adminTypes.ts +23 -0
  144. package/src/api.arrayOperations.test.ts +43 -31
  145. package/src/api.hooks.test.ts +38 -29
  146. package/src/api.query.test.ts +31 -31
  147. package/src/api.test.ts +95 -96
  148. package/src/api.ts +16 -27
  149. package/src/auth.test.ts +107 -51
  150. package/src/auth.ts +98 -29
  151. package/src/authRecovery.test.ts +281 -0
  152. package/src/authRecovery.ts +279 -0
  153. package/src/authTokens.test.ts +94 -0
  154. package/src/authTokens.ts +118 -0
  155. package/src/authVerification.test.ts +293 -0
  156. package/src/betterAuth.ts +24 -0
  157. package/src/betterAuthApp.test.ts +1 -0
  158. package/src/betterAuthApp.ts +27 -9
  159. package/src/betterAuthSetup.test.ts +568 -38
  160. package/src/betterAuthSetup.ts +260 -5
  161. package/src/collectionRegistry.test.ts +165 -0
  162. package/src/collectionRegistry.ts +115 -0
  163. package/src/configurationApp.ts +13 -7
  164. package/src/docLoader.test.ts +45 -1
  165. package/src/docLoader.ts +37 -6
  166. package/src/express.d.ts +1 -0
  167. package/src/expressServer.test.ts +130 -66
  168. package/src/expressServer.ts +75 -19
  169. package/src/githubAuth.test.ts +60 -55
  170. package/src/index.ts +58 -0
  171. package/src/mcp/auth.test.ts +47 -0
  172. package/src/mcp/auth.ts +32 -11
  173. package/src/mcp/handlers.ts +45 -172
  174. package/src/mcp/integration.test.ts +59 -9
  175. package/src/mcp/query.ts +2 -4
  176. package/src/mcp/registry.ts +29 -20
  177. package/src/mcp/schemaGenerator.test.ts +8 -0
  178. package/src/mcp/schemaGenerator.ts +49 -131
  179. package/src/mcp/server.ts +2 -0
  180. package/src/mcp/serviceTokens.test.ts +330 -0
  181. package/src/mcp/serviceTokens.ts +307 -0
  182. package/src/mcp/toolGenerator.test.ts +1 -1
  183. package/src/mcp/types.ts +2 -6
  184. package/src/models/mcpServiceToken.test.ts +129 -0
  185. package/src/models/mcpServiceToken.ts +158 -0
  186. package/src/openApi.test.ts +80 -64
  187. package/src/openApiBuilder.test.ts +95 -7
  188. package/src/openApiBuilder.ts +46 -9
  189. package/src/openApiCompat.ts +1 -1
  190. package/src/openApiValidator.test.ts +49 -54
  191. package/src/openApiValidator.ts +1 -3
  192. package/src/plugins.test.ts +14 -0
  193. package/src/plugins.ts +34 -9
  194. package/src/populate.test.ts +34 -0
  195. package/src/populate.ts +40 -29
  196. package/src/rateLimit/applyTrustProxy.ts +17 -0
  197. package/src/rateLimit/createStore.ts +25 -0
  198. package/src/rateLimit/memoryStore.ts +40 -0
  199. package/src/rateLimit/middleware.ts +79 -0
  200. package/src/rateLimit/mongoStore.test.ts +80 -0
  201. package/src/rateLimit/mongoStore.ts +76 -0
  202. package/src/rateLimit/policies.ts +130 -0
  203. package/src/rateLimit/rateLimit.test.ts +328 -0
  204. package/src/rateLimit/redisStore.ioredis.test.ts +29 -0
  205. package/src/rateLimit/redisStore.test.ts +114 -0
  206. package/src/rateLimit/redisStore.ts +85 -0
  207. package/src/rateLimit/types.ts +64 -0
  208. package/src/rbac/access.ts +5 -1
  209. package/src/rbac/assertAllowed.test.ts +325 -0
  210. package/src/rbac/assertAllowed.ts +157 -0
  211. package/src/rbac/backfillAdmins.test.ts +124 -0
  212. package/src/rbac/fieldViews.test.ts +89 -0
  213. package/src/rbac/modelRouterAccess.test.ts +126 -0
  214. package/src/rbac/modelRouterAccess.ts +5 -2
  215. package/src/rbac/permissionUtils.ts +3 -2
  216. package/src/rbac/realtimeAccess.test.ts +109 -1
  217. package/src/rbac/resolve.ts +5 -4
  218. package/src/rbac/roleManager.test.ts +169 -0
  219. package/src/rbac/routes.test.ts +233 -0
  220. package/src/rbac/routes.ts +16 -6
  221. package/src/rbac/statements.test.ts +2 -0
  222. package/src/rbac/statements.ts +12 -1
  223. package/src/realtime/deprecation.test.ts +60 -0
  224. package/src/realtime/deprecation.ts +32 -0
  225. package/src/realtime/realtime.test.ts +8 -4
  226. package/src/realtime/realtimeApp.ts +10 -11
  227. package/src/realtime/realtimeAppSetup.test.ts +32 -5
  228. package/src/realtime/registry.ts +48 -42
  229. package/src/realtime/sessionRevalidation.test.ts +57 -44
  230. package/src/realtime/socketAuth.test.ts +75 -23
  231. package/src/realtime/socketAuth.ts +17 -6
  232. package/src/realtime/socketUser.ts +5 -3
  233. package/src/realtime/types.ts +14 -4
  234. package/src/schemaMetadata.test.ts +405 -0
  235. package/src/schemaMetadata.ts +593 -0
  236. package/src/scrubAdminFields.test.ts +105 -0
  237. package/src/seedRunner.test.ts +591 -0
  238. package/src/seedRunner.ts +464 -0
  239. package/src/sync/docMatchesMutationData.test.ts +16 -0
  240. package/src/sync/ensureSyncIndexes.test.ts +54 -15
  241. package/src/sync/executors.test.ts +40 -0
  242. package/src/sync/executors.ts +24 -12
  243. package/src/sync/integration.test.ts +15 -7
  244. package/src/sync/loadHarness.ts +28 -19
  245. package/src/sync/models.ts +32 -18
  246. package/src/sync/mutationHandler.test.ts +16 -16
  247. package/src/sync/mutationHandler.ts +9 -7
  248. package/src/sync/registrationSideEffects.test.ts +126 -0
  249. package/src/sync/registrationSideEffects.ts +131 -0
  250. package/src/sync/registry.ts +45 -171
  251. package/src/sync/routes.ts +3 -2
  252. package/src/sync/scripts/compactTombstones.ts +0 -2
  253. package/src/sync/sessionRevalidationIntegration.test.ts +12 -11
  254. package/src/sync/sync.test.ts +25 -23
  255. package/src/sync/syncApp.ts +4 -4
  256. package/src/sync/syncBatch.ts +3 -2
  257. package/src/sync/syncFrontier.test.ts +17 -15
  258. package/src/sync/syncPhaseC.test.ts +54 -43
  259. package/src/sync/syncRoutes.test.ts +51 -36
  260. package/src/sync/syncSeqPlugin.ts +66 -44
  261. package/src/sync/syncSocket.test.ts +112 -81
  262. package/src/terrenoApp.mcpServiceTokens.test.ts +173 -0
  263. package/src/terrenoApp.ts +87 -15
  264. package/src/tests/models.ts +14 -1
  265. package/src/types/authToken.ts +43 -0
  266. package/src/types/mcpServiceToken.ts +54 -0
  267. package/src/webhooks/headerValue.test.ts +22 -0
  268. package/src/webhooks/headerValue.ts +12 -0
  269. package/src/webhooks/idempotency/memoryStore.ts +34 -0
  270. package/src/webhooks/idempotency/mongoStore.test.ts +274 -0
  271. package/src/webhooks/idempotency/mongoStore.ts +83 -0
  272. package/src/webhooks/idempotency/webhookReceipt.ts +70 -0
  273. package/src/webhooks/rawBody.test.ts +74 -0
  274. package/src/webhooks/rawBody.ts +23 -0
  275. package/src/webhooks/timingSafeEqual.ts +16 -0
  276. package/src/webhooks/verifiers/hmac.test.ts +110 -0
  277. package/src/webhooks/verifiers/hmac.ts +54 -0
  278. package/src/webhooks/verifiers/providerVerifiers.test.ts +388 -0
  279. package/src/webhooks/verifiers/sendgrid.ts +59 -0
  280. package/src/webhooks/verifiers/stripe.ts +67 -0
  281. package/src/webhooks/verifiers/twilio.ts +69 -0
  282. package/src/webhooks/webhooksApp.test.ts +221 -0
  283. package/src/webhooks/webhooksApp.ts +144 -0
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.urlencodedBodyParserOptions = exports.jsonBodyParserOptions = exports.captureRawBody = void 0;
4
+ /**
5
+ * Copies the parsed request buffer onto `req.rawBody`.
6
+ * Express may reuse `buf`; webhook signatures need the original bytes.
7
+ */
8
+ var captureRawBody = function (req, _res, buf) {
9
+ if (!Buffer.isBuffer(buf)) {
10
+ return;
11
+ }
12
+ req.rawBody = Buffer.from(buf);
13
+ };
14
+ exports.captureRawBody = captureRawBody;
15
+ exports.jsonBodyParserOptions = {
16
+ limit: "50mb",
17
+ verify: exports.captureRawBody,
18
+ };
19
+ exports.urlencodedBodyParserOptions = {
20
+ extended: false,
21
+ verify: exports.captureRawBody,
22
+ };
@@ -0,0 +1,4 @@
1
+ export declare const timingSafeEqualUtf8: ({ expected, provided, }: {
2
+ expected: string;
3
+ provided: string;
4
+ }) => boolean;
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.timingSafeEqualUtf8 = void 0;
7
+ var node_crypto_1 = __importDefault(require("node:crypto"));
8
+ var timingSafeEqualUtf8 = function (_a) {
9
+ var expected = _a.expected, provided = _a.provided;
10
+ var expectedBuf = Buffer.from(expected, "utf8");
11
+ var providedBuf = Buffer.from(provided, "utf8");
12
+ if (expectedBuf.length !== providedBuf.length) {
13
+ return false;
14
+ }
15
+ return node_crypto_1.default.timingSafeEqual(expectedBuf, providedBuf);
16
+ };
17
+ exports.timingSafeEqualUtf8 = timingSafeEqualUtf8;
@@ -0,0 +1,15 @@
1
+ import type { Request } from "express";
2
+ export interface HmacSignatureOptions {
3
+ algorithm?: "sha256" | "sha1" | "sha512";
4
+ encoding?: "hex" | "base64";
5
+ header: string;
6
+ secret: string;
7
+ timestampHeader?: string;
8
+ toleranceSec?: number;
9
+ }
10
+ /**
11
+ * Verifies `header` against HMAC of `req.rawBody`.
12
+ * When `timestampHeader` is set, the MAC is HMAC(`${timestamp}.${rawBody}`) and
13
+ * timestamps outside `toleranceSec` (default 300) are rejected.
14
+ */
15
+ export declare const hmacSignature: (options: HmacSignatureOptions) => ((req: Request) => boolean);
@@ -0,0 +1,49 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.hmacSignature = void 0;
7
+ var node_crypto_1 = __importDefault(require("node:crypto"));
8
+ var luxon_1 = require("luxon");
9
+ var headerValue_1 = require("../headerValue");
10
+ var timingSafeEqual_1 = require("../timingSafeEqual");
11
+ /**
12
+ * Verifies `header` against HMAC of `req.rawBody`.
13
+ * When `timestampHeader` is set, the MAC is HMAC(`${timestamp}.${rawBody}`) and
14
+ * timestamps outside `toleranceSec` (default 300) are rejected.
15
+ */
16
+ var hmacSignature = function (options) {
17
+ var _a, _b, _c;
18
+ var algorithm = (_a = options.algorithm) !== null && _a !== void 0 ? _a : "sha256";
19
+ var encoding = (_b = options.encoding) !== null && _b !== void 0 ? _b : "hex";
20
+ var toleranceSec = (_c = options.toleranceSec) !== null && _c !== void 0 ? _c : 300;
21
+ return function (req) {
22
+ var provided = (0, headerValue_1.headerValue)(req, options.header);
23
+ if (!provided) {
24
+ return false;
25
+ }
26
+ if (!req.rawBody) {
27
+ return false;
28
+ }
29
+ var mac = node_crypto_1.default.createHmac(algorithm, options.secret);
30
+ if (options.timestampHeader) {
31
+ var timestampRaw = (0, headerValue_1.headerValue)(req, options.timestampHeader);
32
+ if (!timestampRaw) {
33
+ return false;
34
+ }
35
+ var timestamp = Number(timestampRaw);
36
+ if (!Number.isFinite(timestamp)) {
37
+ return false;
38
+ }
39
+ var nowSec = luxon_1.DateTime.utc().toUnixInteger();
40
+ if (Math.abs(nowSec - timestamp) > toleranceSec) {
41
+ return false;
42
+ }
43
+ mac.update("".concat(timestampRaw, "."));
44
+ }
45
+ var expected = mac.update(req.rawBody).digest(encoding);
46
+ return (0, timingSafeEqual_1.timingSafeEqualUtf8)({ expected: expected, provided: provided });
47
+ };
48
+ };
49
+ exports.hmacSignature = hmacSignature;
@@ -0,0 +1,10 @@
1
+ import type { Request } from "express";
2
+ export interface SendgridEventSignatureOptions {
3
+ publicKey: string;
4
+ toleranceSec?: number;
5
+ }
6
+ /**
7
+ * Verifies SendGrid Event Webhook ECDSA P-256 over `${timestamp}${rawBody}`.
8
+ * Timestamps outside `toleranceSec` (default 300) are rejected.
9
+ */
10
+ export declare const sendgridEventSignature: (options: SendgridEventSignatureOptions) => ((req: Request) => boolean);
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.sendgridEventSignature = void 0;
7
+ var node_crypto_1 = __importDefault(require("node:crypto"));
8
+ var luxon_1 = require("luxon");
9
+ var headerValue_1 = require("../headerValue");
10
+ var PEM_HEADER = "-----BEGIN PUBLIC KEY-----";
11
+ var PEM_FOOTER = "-----END PUBLIC KEY-----";
12
+ var toPem = function (publicKey) {
13
+ var _a, _b;
14
+ var trimmed = publicKey.trim();
15
+ if (trimmed.includes(PEM_HEADER)) {
16
+ return trimmed;
17
+ }
18
+ var body = trimmed.replace(/\s+/g, "");
19
+ var wrapped = (_b = (_a = body.match(/.{1,64}/g)) === null || _a === void 0 ? void 0 : _a.join("\n")) !== null && _b !== void 0 ? _b : body;
20
+ return "".concat(PEM_HEADER, "\n").concat(wrapped, "\n").concat(PEM_FOOTER);
21
+ };
22
+ /**
23
+ * Verifies SendGrid Event Webhook ECDSA P-256 over `${timestamp}${rawBody}`.
24
+ * Timestamps outside `toleranceSec` (default 300) are rejected.
25
+ */
26
+ var sendgridEventSignature = function (options) {
27
+ var _a;
28
+ var pem = toPem(options.publicKey);
29
+ var toleranceSec = (_a = options.toleranceSec) !== null && _a !== void 0 ? _a : 300;
30
+ return function (req) {
31
+ var signature = (0, headerValue_1.headerValue)(req, "X-Twilio-Email-Event-Webhook-Signature");
32
+ var timestampRaw = (0, headerValue_1.headerValue)(req, "X-Twilio-Email-Event-Webhook-Timestamp");
33
+ if (!signature || !timestampRaw || !req.rawBody) {
34
+ return false;
35
+ }
36
+ var timestamp = Number(timestampRaw);
37
+ if (!Number.isFinite(timestamp)) {
38
+ return false;
39
+ }
40
+ var nowSec = luxon_1.DateTime.utc().toUnixInteger();
41
+ if (Math.abs(nowSec - timestamp) > toleranceSec) {
42
+ return false;
43
+ }
44
+ try {
45
+ var verifier = node_crypto_1.default.createVerify("SHA256");
46
+ verifier.update(timestampRaw);
47
+ verifier.update(req.rawBody);
48
+ verifier.end();
49
+ return verifier.verify(pem, signature, "base64");
50
+ }
51
+ catch (_a) {
52
+ return false;
53
+ }
54
+ };
55
+ };
56
+ exports.sendgridEventSignature = sendgridEventSignature;
@@ -0,0 +1,9 @@
1
+ import type { Request } from "express";
2
+ export interface StripeSignatureOptions {
3
+ secret: string;
4
+ toleranceSec?: number;
5
+ }
6
+ /**
7
+ * Verifies Stripe `Stripe-Signature` (`t=` / `v1=`) against HMAC-SHA256 of `${t}.${rawBody}`.
8
+ */
9
+ export declare const stripeSignature: (options: StripeSignatureOptions) => ((req: Request) => boolean);
@@ -0,0 +1,99 @@
1
+ "use strict";
2
+ var __values = (this && this.__values) || function(o) {
3
+ var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
4
+ if (m) return m.call(o);
5
+ if (o && typeof o.length === "number") return {
6
+ next: function () {
7
+ if (o && i >= o.length) o = void 0;
8
+ return { value: o && o[i++], done: !o };
9
+ }
10
+ };
11
+ throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
12
+ };
13
+ var __importDefault = (this && this.__importDefault) || function (mod) {
14
+ return (mod && mod.__esModule) ? mod : { "default": mod };
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ exports.stripeSignature = void 0;
18
+ var node_crypto_1 = __importDefault(require("node:crypto"));
19
+ var luxon_1 = require("luxon");
20
+ var headerValue_1 = require("../headerValue");
21
+ var timingSafeEqual_1 = require("../timingSafeEqual");
22
+ var parseStripeSignature = function (header) {
23
+ var e_1, _a;
24
+ var timestamp;
25
+ var v1 = [];
26
+ try {
27
+ for (var _b = __values(header.split(",")), _c = _b.next(); !_c.done; _c = _b.next()) {
28
+ var part = _c.value;
29
+ var separator = part.indexOf("=");
30
+ if (separator <= 0) {
31
+ continue;
32
+ }
33
+ var key = part.slice(0, separator).trim();
34
+ var value = part.slice(separator + 1).trim();
35
+ if (key === "t") {
36
+ timestamp = value;
37
+ }
38
+ else if (key === "v1") {
39
+ v1.push(value);
40
+ }
41
+ }
42
+ }
43
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
44
+ finally {
45
+ try {
46
+ if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
47
+ }
48
+ finally { if (e_1) throw e_1.error; }
49
+ }
50
+ return { timestamp: timestamp, v1: v1 };
51
+ };
52
+ /**
53
+ * Verifies Stripe `Stripe-Signature` (`t=` / `v1=`) against HMAC-SHA256 of `${t}.${rawBody}`.
54
+ */
55
+ var stripeSignature = function (options) {
56
+ var _a;
57
+ var toleranceSec = (_a = options.toleranceSec) !== null && _a !== void 0 ? _a : 300;
58
+ return function (req) {
59
+ var e_2, _a;
60
+ var header = (0, headerValue_1.headerValue)(req, "Stripe-Signature");
61
+ if (!header || !req.rawBody) {
62
+ return false;
63
+ }
64
+ var parsed = parseStripeSignature(header);
65
+ if (!parsed.timestamp || parsed.v1.length === 0) {
66
+ return false;
67
+ }
68
+ var timestamp = Number(parsed.timestamp);
69
+ if (!Number.isFinite(timestamp)) {
70
+ return false;
71
+ }
72
+ var nowSec = luxon_1.DateTime.utc().toUnixInteger();
73
+ if (Math.abs(nowSec - timestamp) > toleranceSec) {
74
+ return false;
75
+ }
76
+ var expected = node_crypto_1.default
77
+ .createHmac("sha256", options.secret)
78
+ .update("".concat(parsed.timestamp, "."))
79
+ .update(req.rawBody)
80
+ .digest("hex");
81
+ try {
82
+ for (var _b = __values(parsed.v1), _c = _b.next(); !_c.done; _c = _b.next()) {
83
+ var provided = _c.value;
84
+ if ((0, timingSafeEqual_1.timingSafeEqualUtf8)({ expected: expected, provided: provided })) {
85
+ return true;
86
+ }
87
+ }
88
+ }
89
+ catch (e_2_1) { e_2 = { error: e_2_1 }; }
90
+ finally {
91
+ try {
92
+ if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
93
+ }
94
+ finally { if (e_2) throw e_2.error; }
95
+ }
96
+ return false;
97
+ };
98
+ };
99
+ exports.stripeSignature = stripeSignature;
@@ -0,0 +1,9 @@
1
+ import type { Request } from "express";
2
+ export interface TwilioSignatureOptions {
3
+ authToken: string;
4
+ url?: string | ((req: Request) => string);
5
+ }
6
+ /**
7
+ * Verifies Twilio `X-Twilio-Signature` (HMAC-SHA1 of callback URL + sorted POST fields).
8
+ */
9
+ export declare const twilioSignature: (options: TwilioSignatureOptions) => ((req: Request) => boolean);
@@ -0,0 +1,112 @@
1
+ "use strict";
2
+ var __values = (this && this.__values) || function(o) {
3
+ var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
4
+ if (m) return m.call(o);
5
+ if (o && typeof o.length === "number") return {
6
+ next: function () {
7
+ if (o && i >= o.length) o = void 0;
8
+ return { value: o && o[i++], done: !o };
9
+ }
10
+ };
11
+ throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
12
+ };
13
+ var __read = (this && this.__read) || function (o, n) {
14
+ var m = typeof Symbol === "function" && o[Symbol.iterator];
15
+ if (!m) return o;
16
+ var i = m.call(o), r, ar = [], e;
17
+ try {
18
+ while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
19
+ }
20
+ catch (error) { e = { error: error }; }
21
+ finally {
22
+ try {
23
+ if (r && !r.done && (m = i["return"])) m.call(i);
24
+ }
25
+ finally { if (e) throw e.error; }
26
+ }
27
+ return ar;
28
+ };
29
+ var __importDefault = (this && this.__importDefault) || function (mod) {
30
+ return (mod && mod.__esModule) ? mod : { "default": mod };
31
+ };
32
+ Object.defineProperty(exports, "__esModule", { value: true });
33
+ exports.twilioSignature = void 0;
34
+ var node_crypto_1 = __importDefault(require("node:crypto"));
35
+ var headerValue_1 = require("../headerValue");
36
+ var timingSafeEqual_1 = require("../timingSafeEqual");
37
+ var isUrlencoded = function (req) {
38
+ var _a;
39
+ var contentType = (_a = (0, headerValue_1.headerValue)(req, "content-type")) !== null && _a !== void 0 ? _a : "";
40
+ return contentType.toLowerCase().includes("application/x-www-form-urlencoded");
41
+ };
42
+ var resolveUrl = function (req, url) {
43
+ if (typeof url === "function") {
44
+ return url(req);
45
+ }
46
+ if (typeof url === "string" && url.length > 0) {
47
+ return url;
48
+ }
49
+ return undefined;
50
+ };
51
+ var formParams = function (body) {
52
+ var e_1, _a;
53
+ if (!body || typeof body !== "object" || Array.isArray(body)) {
54
+ return undefined;
55
+ }
56
+ var params = {};
57
+ try {
58
+ for (var _b = __values(Object.entries(body)), _c = _b.next(); !_c.done; _c = _b.next()) {
59
+ var _d = __read(_c.value, 2), key = _d[0], value = _d[1];
60
+ if (typeof value !== "string") {
61
+ return undefined;
62
+ }
63
+ params[key] = value;
64
+ }
65
+ }
66
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
67
+ finally {
68
+ try {
69
+ if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
70
+ }
71
+ finally { if (e_1) throw e_1.error; }
72
+ }
73
+ return params;
74
+ };
75
+ /**
76
+ * Verifies Twilio `X-Twilio-Signature` (HMAC-SHA1 of callback URL + sorted POST fields).
77
+ */
78
+ var twilioSignature = function (options) {
79
+ return function (req) {
80
+ var e_2, _a;
81
+ if (!isUrlencoded(req) || !req.rawBody) {
82
+ return false;
83
+ }
84
+ var provided = (0, headerValue_1.headerValue)(req, "X-Twilio-Signature");
85
+ var callbackUrl = resolveUrl(req, options.url);
86
+ var params = formParams(req.body);
87
+ if (!provided || !callbackUrl || !params) {
88
+ return false;
89
+ }
90
+ var keys = Object.keys(params).sort();
91
+ var data = callbackUrl;
92
+ try {
93
+ for (var keys_1 = __values(keys), keys_1_1 = keys_1.next(); !keys_1_1.done; keys_1_1 = keys_1.next()) {
94
+ var key = keys_1_1.value;
95
+ data += key + params[key];
96
+ }
97
+ }
98
+ catch (e_2_1) { e_2 = { error: e_2_1 }; }
99
+ finally {
100
+ try {
101
+ if (keys_1_1 && !keys_1_1.done && (_a = keys_1.return)) _a.call(keys_1);
102
+ }
103
+ finally { if (e_2) throw e_2.error; }
104
+ }
105
+ var expected = node_crypto_1.default
106
+ .createHmac("sha1", options.authToken)
107
+ .update(data, "utf8")
108
+ .digest("base64");
109
+ return (0, timingSafeEqual_1.timingSafeEqualUtf8)({ expected: expected, provided: provided });
110
+ };
111
+ };
112
+ exports.twilioSignature = twilioSignature;
@@ -0,0 +1,33 @@
1
+ import type { IncomingHttpHeaders } from "node:http";
2
+ import type { Application, Request } from "express";
3
+ import type { TerrenoPlugin } from "../terrenoPlugin";
4
+ import { type WebhookClaimArgs, type WebhookClaimResult } from "./idempotency/memoryStore";
5
+ export interface WebhookHandlerContext {
6
+ body: unknown;
7
+ eventId: string;
8
+ headers: IncomingHttpHeaders;
9
+ rawBody: Buffer;
10
+ }
11
+ export interface WebhookRouteOptions {
12
+ eventId?: (req: Request) => string;
13
+ handler: (context: WebhookHandlerContext) => Promise<void> | void;
14
+ path: string;
15
+ source: string;
16
+ verify: (req: Request) => boolean | Promise<boolean>;
17
+ }
18
+ export interface WebhooksAppOptions {
19
+ idempotency?: {
20
+ store?: "memory" | "mongo";
21
+ ttlDays?: number;
22
+ };
23
+ }
24
+ export declare class WebhooksApp implements TerrenoPlugin {
25
+ private readonly routes;
26
+ private readonly store;
27
+ constructor(options?: WebhooksAppOptions);
28
+ route(options: WebhookRouteOptions): this;
29
+ claim: (args: WebhookClaimArgs) => Promise<WebhookClaimResult>;
30
+ release: (args: WebhookClaimArgs) => Promise<void>;
31
+ register(app: Application): void;
32
+ private dispatch;
33
+ }
@@ -0,0 +1,195 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __generator = (this && this.__generator) || function (thisArg, body) {
12
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
13
+ return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
14
+ function verb(n) { return function (v) { return step([n, v]); }; }
15
+ function step(op) {
16
+ if (f) throw new TypeError("Generator is already executing.");
17
+ while (g && (g = 0, op[0] && (_ = 0)), _) try {
18
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
19
+ if (y = 0, t) op = [op[0] & 2, t.value];
20
+ switch (op[0]) {
21
+ case 0: case 1: t = op; break;
22
+ case 4: _.label++; return { value: op[1], done: false };
23
+ case 5: _.label++; y = op[1]; op = [0]; continue;
24
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
25
+ default:
26
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
27
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
28
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
29
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
30
+ if (t[2]) _.ops.pop();
31
+ _.trys.pop(); continue;
32
+ }
33
+ op = body.call(thisArg, _);
34
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
35
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
36
+ }
37
+ };
38
+ var __values = (this && this.__values) || function(o) {
39
+ var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
40
+ if (m) return m.call(o);
41
+ if (o && typeof o.length === "number") return {
42
+ next: function () {
43
+ if (o && i >= o.length) o = void 0;
44
+ return { value: o && o[i++], done: !o };
45
+ }
46
+ };
47
+ throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
48
+ };
49
+ Object.defineProperty(exports, "__esModule", { value: true });
50
+ exports.WebhooksApp = void 0;
51
+ var api_1 = require("../api");
52
+ var errors_1 = require("../errors");
53
+ var logger_1 = require("../logger");
54
+ var memoryStore_1 = require("./idempotency/memoryStore");
55
+ var mongoStore_1 = require("./idempotency/mongoStore");
56
+ var WebhooksApp = /** @class */ (function () {
57
+ function WebhooksApp(options) {
58
+ if (options === void 0) { options = {}; }
59
+ var _this = this;
60
+ var _a, _b, _c;
61
+ this.routes = [];
62
+ this.claim = function (args) { return __awaiter(_this, void 0, void 0, function () {
63
+ return __generator(this, function (_a) {
64
+ return [2 /*return*/, this.store.claim(args)];
65
+ });
66
+ }); };
67
+ this.release = function (args) { return __awaiter(_this, void 0, void 0, function () {
68
+ return __generator(this, function (_a) {
69
+ switch (_a.label) {
70
+ case 0: return [4 /*yield*/, this.store.release(args)];
71
+ case 1:
72
+ _a.sent();
73
+ return [2 /*return*/];
74
+ }
75
+ });
76
+ }); };
77
+ this.dispatch = function (_a) { return __awaiter(_this, [_a], void 0, function (_b) {
78
+ var isValid, eventId, log, claimResult, error_1;
79
+ var req = _b.req, res = _b.res, route = _b.route;
80
+ return __generator(this, function (_c) {
81
+ switch (_c.label) {
82
+ case 0:
83
+ if (!req.rawBody) {
84
+ throw new errors_1.APIError({
85
+ code: "webhook-body-missing",
86
+ disableExternalErrorTracking: true,
87
+ status: 400,
88
+ title: "Missing webhook body",
89
+ });
90
+ }
91
+ return [4 /*yield*/, route.verify(req)];
92
+ case 1:
93
+ isValid = _c.sent();
94
+ if (!isValid) {
95
+ throw new errors_1.APIError({
96
+ code: "webhook-signature-invalid",
97
+ disableExternalErrorTracking: true,
98
+ status: 401,
99
+ title: "Invalid webhook signature",
100
+ });
101
+ }
102
+ eventId = route.eventId ? route.eventId(req) : "";
103
+ log = (0, logger_1.createScopedLogger)({
104
+ labels: { eventId: eventId || "none", source: route.source },
105
+ prefix: "[Webhook]",
106
+ });
107
+ if (!!eventId) return [3 /*break*/, 2];
108
+ log.warn("Empty eventId; skipping idempotency claim");
109
+ return [3 /*break*/, 4];
110
+ case 2: return [4 /*yield*/, this.claim({ eventId: eventId, source: route.source })];
111
+ case 3:
112
+ claimResult = _c.sent();
113
+ if (claimResult === "duplicate") {
114
+ log.info("Duplicate webhook event");
115
+ res.status(200).json({ duplicate: true, received: true });
116
+ return [2 /*return*/];
117
+ }
118
+ _c.label = 4;
119
+ case 4:
120
+ _c.trys.push([4, 6, , 9]);
121
+ return [4 /*yield*/, route.handler({
122
+ body: req.body,
123
+ eventId: eventId,
124
+ headers: req.headers,
125
+ rawBody: req.rawBody,
126
+ })];
127
+ case 5:
128
+ _c.sent();
129
+ return [3 /*break*/, 9];
130
+ case 6:
131
+ error_1 = _c.sent();
132
+ if (!eventId) return [3 /*break*/, 8];
133
+ return [4 /*yield*/, this.release({ eventId: eventId, source: route.source })];
134
+ case 7:
135
+ _c.sent();
136
+ _c.label = 8;
137
+ case 8:
138
+ if ((0, errors_1.isAPIError)(error_1)) {
139
+ throw error_1;
140
+ }
141
+ throw new errors_1.APIError({
142
+ cause: error_1,
143
+ status: 500,
144
+ title: "Webhook handler failed",
145
+ });
146
+ case 9:
147
+ res.status(200).json({ received: true });
148
+ return [2 /*return*/];
149
+ }
150
+ });
151
+ }); };
152
+ var storeKind = (_b = (_a = options.idempotency) === null || _a === void 0 ? void 0 : _a.store) !== null && _b !== void 0 ? _b : "memory";
153
+ if (storeKind === "mongo") {
154
+ this.store = (0, mongoStore_1.createMongoIdempotencyStore)({ ttlDays: (_c = options.idempotency) === null || _c === void 0 ? void 0 : _c.ttlDays });
155
+ }
156
+ else {
157
+ this.store = (0, memoryStore_1.createMemoryIdempotencyStore)();
158
+ }
159
+ }
160
+ WebhooksApp.prototype.route = function (options) {
161
+ this.routes.push(options);
162
+ return this;
163
+ };
164
+ WebhooksApp.prototype.register = function (app) {
165
+ var e_1, _a;
166
+ var _this = this;
167
+ var _loop_1 = function (route) {
168
+ app.post(route.path, (0, api_1.asyncHandler)(function (req, res) { return __awaiter(_this, void 0, void 0, function () {
169
+ return __generator(this, function (_a) {
170
+ switch (_a.label) {
171
+ case 0: return [4 /*yield*/, this.dispatch({ req: req, res: res, route: route })];
172
+ case 1:
173
+ _a.sent();
174
+ return [2 /*return*/];
175
+ }
176
+ });
177
+ }); }));
178
+ };
179
+ try {
180
+ for (var _b = __values(this.routes), _c = _b.next(); !_c.done; _c = _b.next()) {
181
+ var route = _c.value;
182
+ _loop_1(route);
183
+ }
184
+ }
185
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
186
+ finally {
187
+ try {
188
+ if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
189
+ }
190
+ finally { if (e_1) throw e_1.error; }
191
+ }
192
+ };
193
+ return WebhooksApp;
194
+ }());
195
+ exports.WebhooksApp = WebhooksApp;