@zap-studio/webhooks 0.3.0 → 1.0.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.
- package/CHANGELOG.md +55 -24
- package/README.md +89 -154
- package/dist/{errors.d.mts → errors.d.ts} +17 -1
- package/dist/errors.d.ts.map +1 -0
- package/dist/{errors.mjs → errors.js} +17 -1
- package/dist/errors.js.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.js +4 -0
- package/dist/router.d.ts +137 -0
- package/dist/router.d.ts.map +1 -0
- package/dist/router.js +203 -0
- package/dist/router.js.map +1 -0
- package/dist/types.d.ts +217 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +0 -0
- package/dist/{verify.d.mts → verify.d.ts} +8 -4
- package/dist/verify.d.ts.map +1 -0
- package/dist/{verify.mjs → verify.js} +32 -11
- package/dist/verify.js.map +1 -0
- package/package.json +10 -14
- package/dist/adapters/base.d.mts +0 -59
- package/dist/adapters/base.d.mts.map +0 -1
- package/dist/adapters/base.mjs +0 -24
- package/dist/adapters/base.mjs.map +0 -1
- package/dist/errors.d.mts.map +0 -1
- package/dist/errors.mjs.map +0 -1
- package/dist/index.d.mts +0 -75
- package/dist/index.d.mts.map +0 -1
- package/dist/index.mjs +0 -175
- package/dist/index.mjs.map +0 -1
- package/dist/types/index.d.mts +0 -92
- package/dist/types/index.d.mts.map +0 -1
- package/dist/types/index.mjs +0 -1
- package/dist/utils/index.d.mts +0 -18
- package/dist/utils/index.d.mts.map +0 -1
- package/dist/utils/index.mjs +0 -24
- package/dist/utils/index.mjs.map +0 -1
- package/dist/verify.d.mts.map +0 -1
- package/dist/verify.mjs.map +0 -1
package/dist/router.js
ADDED
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
import { standardValidate } from "@zap-studio/validation";
|
|
2
|
+
//#region src/router.ts
|
|
3
|
+
/**
|
|
4
|
+
* Schema-first webhook router with path dispatching, validation, and optional verification.
|
|
5
|
+
*
|
|
6
|
+
* @template TMap - Internal route payload map built incrementally via `register`.
|
|
7
|
+
*/
|
|
8
|
+
const toArray = (value) => {
|
|
9
|
+
if (value === void 0) return [];
|
|
10
|
+
return Array.isArray(value) ? value : [value];
|
|
11
|
+
};
|
|
12
|
+
const notFoundResponse = () => Response.json({ error: "not found" }, { status: 404 });
|
|
13
|
+
const bodyDecoder = new TextDecoder();
|
|
14
|
+
/**
|
|
15
|
+
* Normalizes a path to its canonical form: leading slash, no trailing slash,
|
|
16
|
+
* duplicate slashes collapsed. The root path is `"/"`.
|
|
17
|
+
*/
|
|
18
|
+
const normalizePath = (path) => {
|
|
19
|
+
const withLeadingSlash = path.startsWith("/") ? path : `/${path}`;
|
|
20
|
+
const collapsed = withLeadingSlash.includes("//") ? withLeadingSlash.replaceAll(/\/{2,}/gu, "/") : withLeadingSlash;
|
|
21
|
+
return collapsed.length > 1 && collapsed.endsWith("/") ? collapsed.slice(0, -1) : collapsed;
|
|
22
|
+
};
|
|
23
|
+
/** Runs the given before-hooks in order against the request context. */
|
|
24
|
+
const runBeforeHooks = async (ctx, hooks) => {
|
|
25
|
+
if (!hooks || hooks.length === 0) return;
|
|
26
|
+
for (const hook of hooks) await hook(ctx);
|
|
27
|
+
};
|
|
28
|
+
/** Runs the given after-hooks in order against the request context and response. */
|
|
29
|
+
const runAfterHooks = async (ctx, response, hooks) => {
|
|
30
|
+
if (!hooks || hooks.length === 0) return;
|
|
31
|
+
for (const hook of hooks) await hook(ctx, response);
|
|
32
|
+
};
|
|
33
|
+
/** Builds an internal handler entry from route registration options. */
|
|
34
|
+
const createHandlerEntry = (options) => {
|
|
35
|
+
const entry = { handler: options.handler };
|
|
36
|
+
if (options.schema !== void 0) entry.schema = options.schema;
|
|
37
|
+
if (options.before !== void 0) entry.before = toArray(options.before);
|
|
38
|
+
if (options.after !== void 0) entry.after = toArray(options.after);
|
|
39
|
+
return entry;
|
|
40
|
+
};
|
|
41
|
+
/** Parses the request's raw body bytes as JSON, returning `undefined` on invalid JSON. */
|
|
42
|
+
const parseRequestBody = (ctx) => {
|
|
43
|
+
try {
|
|
44
|
+
return JSON.parse(bodyDecoder.decode(ctx.rawBody));
|
|
45
|
+
} catch {
|
|
46
|
+
return;
|
|
47
|
+
}
|
|
48
|
+
};
|
|
49
|
+
/** Validates the parsed payload against the route schema, returning either the validated value or a `400` response. */
|
|
50
|
+
const validatePayload = async (parsedJson, schema) => {
|
|
51
|
+
if (!schema) return parsedJson;
|
|
52
|
+
const result = await standardValidate(parsedJson, schema, { throwOnError: false });
|
|
53
|
+
if (result.issues) return Response.json({
|
|
54
|
+
error: "validation failed",
|
|
55
|
+
issues: result.issues.map((issue) => ({
|
|
56
|
+
message: issue.message,
|
|
57
|
+
path: issue.path?.map((p) => typeof p === "object" && "key" in p ? String(p.key) : String(p))
|
|
58
|
+
}))
|
|
59
|
+
}, { status: 400 });
|
|
60
|
+
return result.value;
|
|
61
|
+
};
|
|
62
|
+
/** Invokes the route handler with the validated payload, defaulting to a `200 "ok"` response. */
|
|
63
|
+
const executeHandler = async (handler, ctx, validatedPayload) => {
|
|
64
|
+
return await handler({
|
|
65
|
+
...ctx,
|
|
66
|
+
payload: validatedPayload
|
|
67
|
+
}) ?? Response.json("ok");
|
|
68
|
+
};
|
|
69
|
+
/**
|
|
70
|
+
* Main webhook router class.
|
|
71
|
+
*
|
|
72
|
+
* Register routes with typed schemas and call `handle` with a Web API `Request`.
|
|
73
|
+
*
|
|
74
|
+
* @example
|
|
75
|
+
* ```ts
|
|
76
|
+
* import { WebhookRouter } from "@zap-studio/webhooks";
|
|
77
|
+
*
|
|
78
|
+
* const router = new WebhookRouter({ prefix: "/webhooks" });
|
|
79
|
+
*
|
|
80
|
+
* router.register("/stripe", {
|
|
81
|
+
* schema: stripeEventSchema,
|
|
82
|
+
* handler: async ({ payload }) => {
|
|
83
|
+
* console.log("Stripe event:", payload.type);
|
|
84
|
+
* },
|
|
85
|
+
* });
|
|
86
|
+
*
|
|
87
|
+
* export default { fetch: (request: Request) => router.handle(request) };
|
|
88
|
+
* ```
|
|
89
|
+
*/
|
|
90
|
+
var WebhookRouter = class {
|
|
91
|
+
handlers = /* @__PURE__ */ new Map();
|
|
92
|
+
verify;
|
|
93
|
+
globalBeforeHooks = [];
|
|
94
|
+
globalAfterHooks = [];
|
|
95
|
+
globalErrorHook;
|
|
96
|
+
prefix;
|
|
97
|
+
prefixWithSlash;
|
|
98
|
+
/**
|
|
99
|
+
* Creates a webhook router with optional global hooks and verification behavior.
|
|
100
|
+
*
|
|
101
|
+
* @param opts - Router-level options.
|
|
102
|
+
*
|
|
103
|
+
* @example
|
|
104
|
+
* ```ts
|
|
105
|
+
* const router = new WebhookRouter({
|
|
106
|
+
* prefix: "/webhooks",
|
|
107
|
+
* verify: createHmacVerifier({ headerName: "x-signature", secret }),
|
|
108
|
+
* onError: (error) => Response.json({ error: error.message }, { status: 500 }),
|
|
109
|
+
* });
|
|
110
|
+
* ```
|
|
111
|
+
*/
|
|
112
|
+
constructor(opts = {}) {
|
|
113
|
+
this.prefix = normalizePath(opts.prefix ?? "/webhooks");
|
|
114
|
+
this.prefixWithSlash = `${this.prefix}/`;
|
|
115
|
+
this.verify = opts.verify;
|
|
116
|
+
this.globalBeforeHooks = toArray(opts.before);
|
|
117
|
+
this.globalAfterHooks = toArray(opts.after);
|
|
118
|
+
this.globalErrorHook = opts.onError;
|
|
119
|
+
}
|
|
120
|
+
register(path, handlerOrOptions) {
|
|
121
|
+
this.handlers.set(normalizePath(path), typeof handlerOrOptions === "function" ? { handler: handlerOrOptions } : createHandlerEntry(handlerOrOptions));
|
|
122
|
+
return this;
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Handles an incoming webhook request.
|
|
126
|
+
*
|
|
127
|
+
* The request body is read exactly once; hooks and handlers receive the raw
|
|
128
|
+
* bytes through the webhook context instead of the request stream.
|
|
129
|
+
*
|
|
130
|
+
* @param request - Incoming Web API request.
|
|
131
|
+
* @returns Web API response for the runtime to send back.
|
|
132
|
+
*
|
|
133
|
+
* @example
|
|
134
|
+
* ```ts
|
|
135
|
+
* // Framework-agnostic: works with any Web API Request/Response runtime.
|
|
136
|
+
* export async function POST(request: Request): Promise<Response> {
|
|
137
|
+
* return router.handle(request);
|
|
138
|
+
* }
|
|
139
|
+
* ```
|
|
140
|
+
*/
|
|
141
|
+
async handle(request) {
|
|
142
|
+
const path = this.matchPath(request);
|
|
143
|
+
if (path === null) return notFoundResponse();
|
|
144
|
+
const handlerEntry = this.handlers.get(path);
|
|
145
|
+
if (!handlerEntry) return notFoundResponse();
|
|
146
|
+
const ctx = {
|
|
147
|
+
path,
|
|
148
|
+
rawBody: /* @__PURE__ */ new Uint8Array(0),
|
|
149
|
+
request
|
|
150
|
+
};
|
|
151
|
+
try {
|
|
152
|
+
ctx.rawBody = new Uint8Array(await request.arrayBuffer());
|
|
153
|
+
await runBeforeHooks(ctx, this.globalBeforeHooks);
|
|
154
|
+
await runBeforeHooks(ctx, handlerEntry.before);
|
|
155
|
+
if (this.verify) await this.verify(ctx);
|
|
156
|
+
const parsedJson = parseRequestBody(ctx);
|
|
157
|
+
const validationResult = await validatePayload(parsedJson, handlerEntry.schema);
|
|
158
|
+
if (validationResult instanceof Response) return validationResult;
|
|
159
|
+
const response = await executeHandler(handlerEntry.handler, ctx, validationResult);
|
|
160
|
+
await runAfterHooks(ctx, response, handlerEntry.after);
|
|
161
|
+
await runAfterHooks(ctx, response, this.globalAfterHooks);
|
|
162
|
+
return response;
|
|
163
|
+
} catch (error) {
|
|
164
|
+
return await this.handleError(error, ctx);
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
/** Resolves the incoming request's URL to a registered route key, or `null` if it doesn't match the configured prefix. */
|
|
168
|
+
matchPath(request) {
|
|
169
|
+
const pathname = normalizePath(new URL(request.url).pathname);
|
|
170
|
+
if (this.prefix === "/") return pathname;
|
|
171
|
+
if (pathname === this.prefix) return "/";
|
|
172
|
+
if (!pathname.startsWith(this.prefixWithSlash)) return null;
|
|
173
|
+
return pathname.slice(this.prefix.length);
|
|
174
|
+
}
|
|
175
|
+
/** Builds the error response for a failed request, deferring to the global error hook when set. */
|
|
176
|
+
async handleError(error, ctx) {
|
|
177
|
+
if (this.globalErrorHook) {
|
|
178
|
+
const normalizedError = error instanceof Error ? error : /* @__PURE__ */ new Error("Internal server error");
|
|
179
|
+
const errorResponse = await this.globalErrorHook(normalizedError, ctx);
|
|
180
|
+
if (errorResponse) return errorResponse;
|
|
181
|
+
}
|
|
182
|
+
return Response.json({ error: error instanceof Error ? error.message : "Internal server error" }, { status: 500 });
|
|
183
|
+
}
|
|
184
|
+
};
|
|
185
|
+
/**
|
|
186
|
+
* Factory helper for creating a webhook router instance.
|
|
187
|
+
*
|
|
188
|
+
* @param opts - Optional global router options.
|
|
189
|
+
* @returns A new webhook router.
|
|
190
|
+
*
|
|
191
|
+
* @example
|
|
192
|
+
* ```ts
|
|
193
|
+
* import { createWebhookRouter } from "@zap-studio/webhooks";
|
|
194
|
+
*
|
|
195
|
+
* const router = createWebhookRouter({ prefix: "/webhooks" });
|
|
196
|
+
* router.register("/stripe", { schema: stripeEventSchema, handler });
|
|
197
|
+
* ```
|
|
198
|
+
*/
|
|
199
|
+
const createWebhookRouter = (opts) => new WebhookRouter(opts);
|
|
200
|
+
//#endregion
|
|
201
|
+
export { WebhookRouter, createWebhookRouter };
|
|
202
|
+
|
|
203
|
+
//# sourceMappingURL=router.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"router.js","names":[],"sources":["../src/router.ts"],"sourcesContent":["/**\n * Schema-first webhook router primitives.\n *\n * @module @zap-studio/webhooks/router\n */\n\nimport type { StandardSchemaV1 } from \"@zap-studio/validation\";\nimport { standardValidate } from \"@zap-studio/validation\";\n\nimport type {\n AfterHook,\n BeforeHook,\n ErrorHook,\n HandlerEntry,\n InferSchemaOutput,\n RegisterOptions,\n SchemaRouteOptions,\n VerifyFn,\n WebhookContext,\n WebhookHandler,\n WebhookRouterOptions,\n} from \"./types.js\";\n\n/**\n * Schema-first webhook router with path dispatching, validation, and optional verification.\n *\n * @template TMap - Internal route payload map built incrementally via `register`.\n */\n\nconst toArray = <T>(value: T | T[] | undefined): T[] => {\n if (value === undefined) {\n return [];\n }\n\n return Array.isArray(value) ? value : [value];\n};\n\nconst notFoundResponse = (): Response =>\n Response.json({ error: \"not found\" }, { status: 404 });\n\nconst bodyDecoder = new TextDecoder();\n\n/**\n * Normalizes a path to its canonical form: leading slash, no trailing slash,\n * duplicate slashes collapsed. The root path is `\"/\"`.\n */\nconst normalizePath = (path: string): string => {\n const withLeadingSlash = path.startsWith(\"/\") ? path : `/${path}`;\n const collapsed = withLeadingSlash.includes(\"//\")\n ? withLeadingSlash.replaceAll(/\\/{2,}/gu, \"/\")\n : withLeadingSlash;\n\n return collapsed.length > 1 && collapsed.endsWith(\"/\")\n ? collapsed.slice(0, -1)\n : collapsed;\n};\n\n/** Runs the given before-hooks in order against the request context. */\nconst runBeforeHooks = async (\n ctx: WebhookContext,\n hooks?: BeforeHook[]\n): Promise<void> => {\n if (!hooks || hooks.length === 0) {\n return;\n }\n\n for (const hook of hooks) {\n // oxlint-disable-next-line no-await-in-loop -- hooks run sequentially; order + short-circuit matter.\n await hook(ctx);\n }\n};\n\n/** Runs the given after-hooks in order against the request context and response. */\nconst runAfterHooks = async (\n ctx: WebhookContext,\n response: Response,\n hooks?: AfterHook[]\n): Promise<void> => {\n if (!hooks || hooks.length === 0) {\n return;\n }\n\n for (const hook of hooks) {\n // oxlint-disable-next-line no-await-in-loop -- hooks run sequentially; order + short-circuit matter.\n await hook(ctx, response);\n }\n};\n\n/** Builds an internal handler entry from route registration options. */\nconst createHandlerEntry = (\n options: RegisterOptions<unknown>\n): HandlerEntry => {\n const entry: HandlerEntry = {\n handler: options.handler,\n };\n\n if (options.schema !== undefined) {\n entry.schema = options.schema;\n }\n\n if (options.before !== undefined) {\n entry.before = toArray(options.before);\n }\n\n if (options.after !== undefined) {\n entry.after = toArray(options.after);\n }\n\n return entry;\n};\n\n/** Parses the request's raw body bytes as JSON, returning `undefined` on invalid JSON. */\nconst parseRequestBody = (ctx: WebhookContext): unknown => {\n try {\n return JSON.parse(bodyDecoder.decode(ctx.rawBody));\n } catch {\n return undefined;\n }\n};\n\n/** Validates the parsed payload against the route schema, returning either the validated value or a `400` response. */\nconst validatePayload = async <TPayload>(\n parsedJson: unknown,\n schema?: StandardSchemaV1<unknown, TPayload>\n): Promise<TPayload | Response> => {\n if (!schema) {\n // oxlint-disable-next-line typescript/no-unsafe-type-assertion -- Without a schema, caller-declared payload type is the route contract.\n return parsedJson as TPayload;\n }\n\n const result = await standardValidate(parsedJson, schema, {\n throwOnError: false,\n });\n\n if (result.issues) {\n return Response.json(\n {\n error: \"validation failed\",\n issues: result.issues.map((issue) => ({\n message: issue.message,\n path: issue.path?.map((p) =>\n typeof p === \"object\" && \"key\" in p ? String(p.key) : String(p)\n ),\n })),\n },\n { status: 400 }\n );\n }\n\n return result.value;\n};\n\n/** Invokes the route handler with the validated payload, defaulting to a `200 \"ok\"` response. */\nconst executeHandler = async <TPayload = unknown>(\n handler: WebhookHandler<TPayload>,\n ctx: WebhookContext,\n validatedPayload: TPayload\n): Promise<Response> => {\n const responded = await handler({\n ...ctx,\n payload: validatedPayload,\n });\n\n return responded ?? Response.json(\"ok\");\n};\n\n/**\n * Main webhook router class.\n *\n * Register routes with typed schemas and call `handle` with a Web API `Request`.\n *\n * @example\n * ```ts\n * import { WebhookRouter } from \"@zap-studio/webhooks\";\n *\n * const router = new WebhookRouter({ prefix: \"/webhooks\" });\n *\n * router.register(\"/stripe\", {\n * schema: stripeEventSchema,\n * handler: async ({ payload }) => {\n * console.log(\"Stripe event:\", payload.type);\n * },\n * });\n *\n * export default { fetch: (request: Request) => router.handle(request) };\n * ```\n */\nexport class WebhookRouter<TMap = unknown> {\n private readonly handlers = new Map<string, HandlerEntry>();\n private readonly verify: VerifyFn | undefined;\n private readonly globalBeforeHooks: BeforeHook[] = [];\n private readonly globalAfterHooks: AfterHook[] = [];\n private readonly globalErrorHook: ErrorHook | undefined;\n private readonly prefix: string;\n private readonly prefixWithSlash: string;\n\n /**\n * Creates a webhook router with optional global hooks and verification behavior.\n *\n * @param opts - Router-level options.\n *\n * @example\n * ```ts\n * const router = new WebhookRouter({\n * prefix: \"/webhooks\",\n * verify: createHmacVerifier({ headerName: \"x-signature\", secret }),\n * onError: (error) => Response.json({ error: error.message }, { status: 500 }),\n * });\n * ```\n */\n constructor(opts: WebhookRouterOptions = {}) {\n this.prefix = normalizePath(opts.prefix ?? \"/webhooks\");\n this.prefixWithSlash = `${this.prefix}/`;\n this.verify = opts.verify;\n this.globalBeforeHooks = toArray(opts.before);\n this.globalAfterHooks = toArray(opts.after);\n this.globalErrorHook = opts.onError;\n }\n\n /**\n * Register a webhook handler for a specific path.\n *\n * When a schema is provided, `payload` is inferred from the schema output type.\n *\n * @param path - Route path relative to configured prefix, starting with `/` (e.g. `\"/stripe\"`).\n * @param handlerOrOptions - Handler function or schema-based registration options.\n * @returns The same router instance with an updated internal route type map.\n *\n * @example\n * ```ts\n * router.register(\"/stripe\", {\n * schema: stripeEventSchema,\n * handler: async ({ payload }) => {\n * console.log(payload.type); // typed from stripeEventSchema\n * },\n * });\n * ```\n */\n register<\n Path extends `/${string}`,\n TSchema extends StandardSchemaV1<unknown, unknown>,\n >(\n path: Path,\n handlerOrOptions: SchemaRouteOptions<TSchema>\n ): WebhookRouter<TMap & Record<Path, InferSchemaOutput<TSchema>>>;\n /**\n * Register a webhook handler for a specific path, with schema-less registration options.\n *\n * @param path - Route path relative to configured prefix, starting with `/` (e.g. `\"/stripe\"`).\n * @param handlerOrOptions - Registration options without a schema.\n * @returns The same router instance with an updated internal route type map.\n *\n * @example\n * ```ts\n * router.register(\"/ping\", {\n * before: (ctx) => console.log(\"received\", ctx.path),\n * handler: () => Response.json({ ok: true }),\n * });\n * ```\n */\n register<Path extends `/${string}`, TPayload>(\n path: Path,\n handlerOrOptions: RegisterOptions<TPayload>\n ): WebhookRouter<TMap & Record<Path, TPayload>>;\n /**\n * Register a webhook handler for a specific path, using a plain handler function.\n *\n * @param path - Route path relative to configured prefix, starting with `/` (e.g. `\"/stripe\"`).\n * @param handlerOrOptions - Handler function to process the webhook.\n * @returns The same router instance with an updated internal route type map.\n *\n * @example\n * ```ts\n * router.register(\"/health\", () => Response.json({ status: \"ok\" }));\n * ```\n */\n register<Path extends `/${string}`>(\n path: Path,\n handlerOrOptions: WebhookHandler\n ): WebhookRouter<TMap & Record<Path, unknown>>;\n register(\n path: string,\n handlerOrOptions: WebhookHandler | RegisterOptions<unknown>\n ): this {\n this.handlers.set(\n normalizePath(path),\n typeof handlerOrOptions === \"function\"\n ? { handler: handlerOrOptions }\n : createHandlerEntry(handlerOrOptions)\n );\n\n return this;\n }\n\n /**\n * Handles an incoming webhook request.\n *\n * The request body is read exactly once; hooks and handlers receive the raw\n * bytes through the webhook context instead of the request stream.\n *\n * @param request - Incoming Web API request.\n * @returns Web API response for the runtime to send back.\n *\n * @example\n * ```ts\n * // Framework-agnostic: works with any Web API Request/Response runtime.\n * export async function POST(request: Request): Promise<Response> {\n * return router.handle(request);\n * }\n * ```\n */\n async handle(request: Request): Promise<Response> {\n const path = this.matchPath(request);\n if (path === null) {\n return notFoundResponse();\n }\n\n const handlerEntry = this.handlers.get(path);\n if (!handlerEntry) {\n return notFoundResponse();\n }\n\n const ctx: WebhookContext = {\n path,\n rawBody: new Uint8Array(0),\n request,\n };\n\n try {\n ctx.rawBody = new Uint8Array(await request.arrayBuffer());\n\n await runBeforeHooks(ctx, this.globalBeforeHooks);\n await runBeforeHooks(ctx, handlerEntry.before);\n\n if (this.verify) {\n await this.verify(ctx);\n }\n\n const parsedJson = parseRequestBody(ctx);\n const validationResult = await validatePayload(\n parsedJson,\n handlerEntry.schema\n );\n\n if (validationResult instanceof Response) {\n return validationResult;\n }\n\n const response = await executeHandler(\n handlerEntry.handler,\n ctx,\n validationResult\n );\n\n await runAfterHooks(ctx, response, handlerEntry.after);\n await runAfterHooks(ctx, response, this.globalAfterHooks);\n\n return response;\n } catch (error) {\n return await this.handleError(error, ctx);\n }\n }\n\n /** Resolves the incoming request's URL to a registered route key, or `null` if it doesn't match the configured prefix. */\n private matchPath(request: Request): string | null {\n const pathname = normalizePath(new URL(request.url).pathname);\n\n // Root mount: the whole pathname is the route path.\n if (this.prefix === \"/\") {\n return pathname;\n }\n\n if (pathname === this.prefix) {\n return \"/\";\n }\n\n // Require prefix followed by a segment boundary, then match handlers on\n // the remainder (e.g. /webhooks/stripe -> /stripe).\n if (!pathname.startsWith(this.prefixWithSlash)) {\n return null;\n }\n\n return pathname.slice(this.prefix.length);\n }\n\n /** Builds the error response for a failed request, deferring to the global error hook when set. */\n private async handleError(\n error: unknown,\n ctx: WebhookContext\n ): Promise<Response> {\n if (this.globalErrorHook) {\n const normalizedError =\n error instanceof Error ? error : new Error(\"Internal server error\");\n const errorResponse = await this.globalErrorHook(normalizedError, ctx);\n if (errorResponse) {\n return errorResponse;\n }\n }\n\n return Response.json(\n {\n error: error instanceof Error ? error.message : \"Internal server error\",\n },\n { status: 500 }\n );\n }\n}\n\n/**\n * Factory helper for creating a webhook router instance.\n *\n * @param opts - Optional global router options.\n * @returns A new webhook router.\n *\n * @example\n * ```ts\n * import { createWebhookRouter } from \"@zap-studio/webhooks\";\n *\n * const router = createWebhookRouter({ prefix: \"/webhooks\" });\n * router.register(\"/stripe\", { schema: stripeEventSchema, handler });\n * ```\n */\nexport const createWebhookRouter = (\n opts?: WebhookRouterOptions\n): WebhookRouter => new WebhookRouter(opts);\n"],"mappings":";;;;;;;AA6BA,MAAM,WAAc,UAAoC;CACtD,IAAI,UAAU,KAAA,GACZ,OAAO,CAAC;CAGV,OAAO,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK;AAC9C;AAEA,MAAM,yBACJ,SAAS,KAAK,EAAE,OAAO,YAAY,GAAG,EAAE,QAAQ,IAAI,CAAC;AAEvD,MAAM,cAAc,IAAI,YAAY;;;;;AAMpC,MAAM,iBAAiB,SAAyB;CAC9C,MAAM,mBAAmB,KAAK,WAAW,GAAG,IAAI,OAAO,IAAI;CAC3D,MAAM,YAAY,iBAAiB,SAAS,IAAI,IAC5C,iBAAiB,WAAW,YAAY,GAAG,IAC3C;CAEJ,OAAO,UAAU,SAAS,KAAK,UAAU,SAAS,GAAG,IACjD,UAAU,MAAM,GAAG,EAAE,IACrB;AACN;;AAGA,MAAM,iBAAiB,OACrB,KACA,UACkB;CAClB,IAAI,CAAC,SAAS,MAAM,WAAW,GAC7B;CAGF,KAAK,MAAM,QAAQ,OAEjB,MAAM,KAAK,GAAG;AAElB;;AAGA,MAAM,gBAAgB,OACpB,KACA,UACA,UACkB;CAClB,IAAI,CAAC,SAAS,MAAM,WAAW,GAC7B;CAGF,KAAK,MAAM,QAAQ,OAEjB,MAAM,KAAK,KAAK,QAAQ;AAE5B;;AAGA,MAAM,sBACJ,YACiB;CACjB,MAAM,QAAsB,EAC1B,SAAS,QAAQ,QACnB;CAEA,IAAI,QAAQ,WAAW,KAAA,GACrB,MAAM,SAAS,QAAQ;CAGzB,IAAI,QAAQ,WAAW,KAAA,GACrB,MAAM,SAAS,QAAQ,QAAQ,MAAM;CAGvC,IAAI,QAAQ,UAAU,KAAA,GACpB,MAAM,QAAQ,QAAQ,QAAQ,KAAK;CAGrC,OAAO;AACT;;AAGA,MAAM,oBAAoB,QAAiC;CACzD,IAAI;EACF,OAAO,KAAK,MAAM,YAAY,OAAO,IAAI,OAAO,CAAC;CACnD,QAAQ;EACN;CACF;AACF;;AAGA,MAAM,kBAAkB,OACtB,YACA,WACiC;CACjC,IAAI,CAAC,QAEH,OAAO;CAGT,MAAM,SAAS,MAAM,iBAAiB,YAAY,QAAQ,EACxD,cAAc,MAChB,CAAC;CAED,IAAI,OAAO,QACT,OAAO,SAAS,KACd;EACE,OAAO;EACP,QAAQ,OAAO,OAAO,KAAK,WAAW;GACpC,SAAS,MAAM;GACf,MAAM,MAAM,MAAM,KAAK,MACrB,OAAO,MAAM,YAAY,SAAS,IAAI,OAAO,EAAE,GAAG,IAAI,OAAO,CAAC,CAChE;EACF,EAAE;CACJ,GACA,EAAE,QAAQ,IAAI,CAChB;CAGF,OAAO,OAAO;AAChB;;AAGA,MAAM,iBAAiB,OACrB,SACA,KACA,qBACsB;CAMtB,OAAO,MALiB,QAAQ;EAC9B,GAAG;EACH,SAAS;CACX,CAAC,KAEmB,SAAS,KAAK,IAAI;AACxC;;;;;;;;;;;;;;;;;;;;;;AAuBA,IAAa,gBAAb,MAA2C;CACzC,2BAA4B,IAAI,IAA0B;CAC1D;CACA,oBAAmD,CAAC;CACpD,mBAAiD,CAAC;CAClD;CACA;CACA;;;;;;;;;;;;;;;CAgBA,YAAY,OAA6B,CAAC,GAAG;EAC3C,KAAK,SAAS,cAAc,KAAK,UAAU,WAAW;EACtD,KAAK,kBAAkB,GAAG,KAAK,OAAO;EACtC,KAAK,SAAS,KAAK;EACnB,KAAK,oBAAoB,QAAQ,KAAK,MAAM;EAC5C,KAAK,mBAAmB,QAAQ,KAAK,KAAK;EAC1C,KAAK,kBAAkB,KAAK;CAC9B;CA+DA,SACE,MACA,kBACM;EACN,KAAK,SAAS,IACZ,cAAc,IAAI,GAClB,OAAO,qBAAqB,aACxB,EAAE,SAAS,iBAAiB,IAC5B,mBAAmB,gBAAgB,CACzC;EAEA,OAAO;CACT;;;;;;;;;;;;;;;;;;CAmBA,MAAM,OAAO,SAAqC;EAChD,MAAM,OAAO,KAAK,UAAU,OAAO;EACnC,IAAI,SAAS,MACX,OAAO,iBAAiB;EAG1B,MAAM,eAAe,KAAK,SAAS,IAAI,IAAI;EAC3C,IAAI,CAAC,cACH,OAAO,iBAAiB;EAG1B,MAAM,MAAsB;GAC1B;GACA,yBAAS,IAAI,WAAW,CAAC;GACzB;EACF;EAEA,IAAI;GACF,IAAI,UAAU,IAAI,WAAW,MAAM,QAAQ,YAAY,CAAC;GAExD,MAAM,eAAe,KAAK,KAAK,iBAAiB;GAChD,MAAM,eAAe,KAAK,aAAa,MAAM;GAE7C,IAAI,KAAK,QACP,MAAM,KAAK,OAAO,GAAG;GAGvB,MAAM,aAAa,iBAAiB,GAAG;GACvC,MAAM,mBAAmB,MAAM,gBAC7B,YACA,aAAa,MACf;GAEA,IAAI,4BAA4B,UAC9B,OAAO;GAGT,MAAM,WAAW,MAAM,eACrB,aAAa,SACb,KACA,gBACF;GAEA,MAAM,cAAc,KAAK,UAAU,aAAa,KAAK;GACrD,MAAM,cAAc,KAAK,UAAU,KAAK,gBAAgB;GAExD,OAAO;EACT,SAAS,OAAO;GACd,OAAO,MAAM,KAAK,YAAY,OAAO,GAAG;EAC1C;CACF;;CAGA,UAAkB,SAAiC;EACjD,MAAM,WAAW,cAAc,IAAI,IAAI,QAAQ,GAAG,CAAC,CAAC,QAAQ;EAG5D,IAAI,KAAK,WAAW,KAClB,OAAO;EAGT,IAAI,aAAa,KAAK,QACpB,OAAO;EAKT,IAAI,CAAC,SAAS,WAAW,KAAK,eAAe,GAC3C,OAAO;EAGT,OAAO,SAAS,MAAM,KAAK,OAAO,MAAM;CAC1C;;CAGA,MAAc,YACZ,OACA,KACmB;EACnB,IAAI,KAAK,iBAAiB;GACxB,MAAM,kBACJ,iBAAiB,QAAQ,wBAAQ,IAAI,MAAM,uBAAuB;GACpE,MAAM,gBAAgB,MAAM,KAAK,gBAAgB,iBAAiB,GAAG;GACrE,IAAI,eACF,OAAO;EAEX;EAEA,OAAO,SAAS,KACd,EACE,OAAO,iBAAiB,QAAQ,MAAM,UAAU,wBAClD,GACA,EAAE,QAAQ,IAAI,CAChB;CACF;AACF;;;;;;;;;;;;;;;AAgBA,MAAa,uBACX,SACkB,IAAI,cAAc,IAAI"}
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
import { StandardSchemaV1 } from "@zap-studio/validation";
|
|
2
|
+
//#region src/types.d.ts
|
|
3
|
+
/**
|
|
4
|
+
* Context shared by hooks, verifiers, and handlers for a single webhook request.
|
|
5
|
+
*
|
|
6
|
+
* The router consumes the request body exactly once, so `request.body` is
|
|
7
|
+
* already used by the time hooks or handlers run — read `rawBody` instead.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const before: BeforeHook = (ctx: WebhookContext) => {
|
|
12
|
+
* console.log("received", ctx.path);
|
|
13
|
+
* };
|
|
14
|
+
* ```
|
|
15
|
+
*/
|
|
16
|
+
interface WebhookContext {
|
|
17
|
+
/** The matched route key registered on the router (e.g. "stripe") */
|
|
18
|
+
path: string;
|
|
19
|
+
/** The exact request body bytes (for signature verification) */
|
|
20
|
+
rawBody: Uint8Array;
|
|
21
|
+
/** The incoming Web API request (body already consumed by the router) */
|
|
22
|
+
request: Request;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Handler context extending the shared webhook context with the validated payload.
|
|
26
|
+
*
|
|
27
|
+
* @template TPayload - Validated payload type for the matched route.
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* const handler: WebhookHandler<{ type: string }> = ({ payload }: HandlerContext<{ type: string }>) => {
|
|
32
|
+
* console.log(payload.type);
|
|
33
|
+
* };
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
interface HandlerContext<TPayload = unknown> extends WebhookContext {
|
|
37
|
+
/** The validated webhook payload */
|
|
38
|
+
payload: TPayload;
|
|
39
|
+
}
|
|
40
|
+
/** Internal handler entry stored per registered route. */
|
|
41
|
+
interface HandlerEntry<TPayload = unknown> {
|
|
42
|
+
after?: AfterHook[];
|
|
43
|
+
before?: BeforeHook[];
|
|
44
|
+
handler: WebhookHandler<TPayload>;
|
|
45
|
+
schema?: StandardSchemaV1<unknown, TPayload>;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Configuration options for creating a `WebhookRouter`.
|
|
49
|
+
*
|
|
50
|
+
* @example
|
|
51
|
+
* ```ts
|
|
52
|
+
* const options: WebhookRouterOptions = {
|
|
53
|
+
* prefix: "/webhooks",
|
|
54
|
+
* verify: createHmacVerifier({ headerName: "x-signature", secret }),
|
|
55
|
+
* };
|
|
56
|
+
* ```
|
|
57
|
+
*/
|
|
58
|
+
interface WebhookRouterOptions {
|
|
59
|
+
/** Global hooks executed after successful route handler completion. */
|
|
60
|
+
after?: AfterHook | AfterHook[];
|
|
61
|
+
/** Global hooks executed before route-level hooks and verification. */
|
|
62
|
+
before?: BeforeHook | BeforeHook[];
|
|
63
|
+
/** Global error hook used to override the default `500` response. */
|
|
64
|
+
onError?: ErrorHook;
|
|
65
|
+
/**
|
|
66
|
+
* Required path prefix for all webhook routes. Defaults to `"/webhooks"`.
|
|
67
|
+
*
|
|
68
|
+
* Normalized internally: leading slash added, trailing slash stripped,
|
|
69
|
+
* duplicate slashes collapsed. Use `""` or `"/"` to mount at the root.
|
|
70
|
+
*/
|
|
71
|
+
prefix?: string;
|
|
72
|
+
/** Optional request verification function (for signature checks, auth, etc.). */
|
|
73
|
+
verify?: VerifyFn;
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Route registration options for a webhook handler.
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* ```ts
|
|
80
|
+
* const options: RegisterOptions<{ type: string }> = {
|
|
81
|
+
* schema: stripeEventSchema,
|
|
82
|
+
* handler: ({ payload }) => console.log(payload.type),
|
|
83
|
+
* };
|
|
84
|
+
* ```
|
|
85
|
+
*/
|
|
86
|
+
interface RegisterOptions<T> {
|
|
87
|
+
/** Hooks that run after successful processing (before global after hooks) */
|
|
88
|
+
after?: AfterHook | AfterHook[];
|
|
89
|
+
/** Hooks that run before request processing (after global before hooks) */
|
|
90
|
+
before?: BeforeHook | BeforeHook[];
|
|
91
|
+
/** The handler function to process the webhook */
|
|
92
|
+
handler: WebhookHandler<T>;
|
|
93
|
+
/** Optional Standard Schema validator to validate the webhook payload */
|
|
94
|
+
schema?: StandardSchemaV1<unknown, T>;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* Infers the output type from a Standard Schema instance.
|
|
98
|
+
*
|
|
99
|
+
* @template TSchema - A Standard Schema type.
|
|
100
|
+
*/
|
|
101
|
+
type InferSchemaOutput<TSchema> = TSchema extends StandardSchemaV1<unknown, infer TOutput> ? TOutput : never;
|
|
102
|
+
/**
|
|
103
|
+
* Route options where schema is required and handler payload is inferred.
|
|
104
|
+
*
|
|
105
|
+
* @template TSchema - Schema used to infer handler payload type.
|
|
106
|
+
*
|
|
107
|
+
* @example
|
|
108
|
+
* ```ts
|
|
109
|
+
* const stripeRoute: SchemaRouteOptions<typeof stripeEventSchema> = {
|
|
110
|
+
* schema: stripeEventSchema,
|
|
111
|
+
* handler: ({ payload }) => console.log(payload.type),
|
|
112
|
+
* };
|
|
113
|
+
* ```
|
|
114
|
+
*/
|
|
115
|
+
type SchemaRouteOptions<TSchema extends StandardSchemaV1<unknown, unknown>> = Omit<RegisterOptions<InferSchemaOutput<TSchema>>, "schema"> & {
|
|
116
|
+
schema: TSchema;
|
|
117
|
+
};
|
|
118
|
+
/** A single route's registration shape, as used by schema-driven route dictionaries. */
|
|
119
|
+
interface RouteLike {
|
|
120
|
+
after?: AfterHook | AfterHook[];
|
|
121
|
+
before?: BeforeHook | BeforeHook[];
|
|
122
|
+
handler: WebhookHandler;
|
|
123
|
+
schema: StandardSchemaV1<unknown, unknown>;
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* Applies schema-driven payload inference to each route entry.
|
|
127
|
+
*
|
|
128
|
+
* @template TRoutes - Route dictionary keyed by webhook path.
|
|
129
|
+
*
|
|
130
|
+
* @example
|
|
131
|
+
* ```ts
|
|
132
|
+
* const routes: SchemaRoutes<{ "/stripe": { handler: WebhookHandler; schema: typeof stripeEventSchema } }> = {
|
|
133
|
+
* "/stripe": { schema: stripeEventSchema, handler: ({ payload }) => console.log(payload.type) },
|
|
134
|
+
* };
|
|
135
|
+
* ```
|
|
136
|
+
*/
|
|
137
|
+
type SchemaRoutes<TRoutes extends Record<string, RouteLike>> = { [P in keyof TRoutes]: SchemaRouteOptions<TRoutes[P]["schema"]>; };
|
|
138
|
+
/**
|
|
139
|
+
* The webhook handler function, responsible for processing incoming webhook events.
|
|
140
|
+
*
|
|
141
|
+
* Return a `Response` to control the reply, or `undefined` to let the router
|
|
142
|
+
* respond with its default `200` acknowledgement.
|
|
143
|
+
*
|
|
144
|
+
* @example
|
|
145
|
+
* ```ts
|
|
146
|
+
* const handler: WebhookHandler<{ type: string }> = ({ payload }) => {
|
|
147
|
+
* console.log(payload.type);
|
|
148
|
+
* };
|
|
149
|
+
* ```
|
|
150
|
+
*/
|
|
151
|
+
type WebhookHandler<TPayload = unknown> = (ctx: HandlerContext<TPayload>) => Promise<Response | undefined> | Response | undefined;
|
|
152
|
+
/**
|
|
153
|
+
* Maps route keys to their payload-specific webhook handlers.
|
|
154
|
+
*
|
|
155
|
+
* @example
|
|
156
|
+
* ```ts
|
|
157
|
+
* const handlers: HandlerMap<{ "/stripe": { type: string } }> = {
|
|
158
|
+
* "/stripe": ({ payload }) => console.log(payload.type),
|
|
159
|
+
* };
|
|
160
|
+
* ```
|
|
161
|
+
*/
|
|
162
|
+
type HandlerMap<TMap extends Record<string, unknown>> = { [P in keyof TMap]: WebhookHandler<TMap[P]>; };
|
|
163
|
+
/**
|
|
164
|
+
* Builds a webhook payload map from a schema-based route dictionary.
|
|
165
|
+
*
|
|
166
|
+
* @template TRoutes - Route dictionary keyed by webhook path.
|
|
167
|
+
*
|
|
168
|
+
* @example
|
|
169
|
+
* ```ts
|
|
170
|
+
* type Payloads = InferWebhookMapFromRoutes<{
|
|
171
|
+
* "/stripe": { handler: WebhookHandler; schema: typeof stripeEventSchema };
|
|
172
|
+
* }>;
|
|
173
|
+
* ```
|
|
174
|
+
*/
|
|
175
|
+
type InferWebhookMapFromRoutes<TRoutes extends Record<string, RouteLike>> = { [P in keyof TRoutes]: InferSchemaOutput<TRoutes[P]["schema"]>; };
|
|
176
|
+
/**
|
|
177
|
+
* Verification function for incoming requests. Throws to reject the request.
|
|
178
|
+
*
|
|
179
|
+
* @example
|
|
180
|
+
* ```ts
|
|
181
|
+
* const verify: VerifyFn = createHmacVerifier({ headerName: "x-signature", secret });
|
|
182
|
+
* ```
|
|
183
|
+
*/
|
|
184
|
+
type VerifyFn = (ctx: WebhookContext) => Promise<void> | void;
|
|
185
|
+
/**
|
|
186
|
+
* Hook function that runs before request processing
|
|
187
|
+
*
|
|
188
|
+
* @example
|
|
189
|
+
* ```ts
|
|
190
|
+
* const before: BeforeHook = (ctx) => console.log("received", ctx.path);
|
|
191
|
+
* ```
|
|
192
|
+
*/
|
|
193
|
+
type BeforeHook = (ctx: WebhookContext) => Promise<void> | void;
|
|
194
|
+
/**
|
|
195
|
+
* Hook function that runs after successful request processing.
|
|
196
|
+
*
|
|
197
|
+
* The hook receives the outgoing response as-is; call `response.clone()`
|
|
198
|
+
* before reading its body to avoid consuming the stream sent to the client.
|
|
199
|
+
*
|
|
200
|
+
* @example
|
|
201
|
+
* ```ts
|
|
202
|
+
* const after: AfterHook = (ctx, response) => console.log(response.status);
|
|
203
|
+
* ```
|
|
204
|
+
*/
|
|
205
|
+
type AfterHook = (ctx: WebhookContext, response: Response) => Promise<void> | void;
|
|
206
|
+
/**
|
|
207
|
+
* Hook function that runs when an error occurs
|
|
208
|
+
*
|
|
209
|
+
* @example
|
|
210
|
+
* ```ts
|
|
211
|
+
* const onError: ErrorHook = (error) => Response.json({ error: error.message }, { status: 500 });
|
|
212
|
+
* ```
|
|
213
|
+
*/
|
|
214
|
+
type ErrorHook = (error: Error, ctx: WebhookContext) => Promise<Response | undefined> | Response | undefined;
|
|
215
|
+
//#endregion
|
|
216
|
+
export { AfterHook, BeforeHook, ErrorHook, HandlerContext, HandlerEntry, HandlerMap, InferSchemaOutput, InferWebhookMapFromRoutes, RegisterOptions, RouteLike, SchemaRouteOptions, SchemaRoutes, VerifyFn, WebhookContext, WebhookHandler, WebhookRouterOptions };
|
|
217
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","names":[],"sources":["../src/types.ts"],"mappings":";;;;;;;;;;;;;;;UAqBiB;;EAEf;;EAEA,SAAS;;EAET,SAAS;;;;;;;;;;;;;;UAeM,eAAe,4BAA4B;;EAE1D,SAAS;;;UAIM,aAAa;EAC5B,QAAQ;EACR,SAAS;EACT,SAAS,eAAe;EACxB,SAAS,0BAA0B;;;;;;;;;;;;;UAcpB;;EAEf,QAAQ,YAAY;;EAEpB,SAAS,aAAa;;EAEtB,UAAU;;;;;;;EAOV;;EAEA,SAAS;;;;;;;;;;;;;UAcM,gBAAgB;;EAE/B,QAAQ,YAAY;;EAEpB,SAAS,aAAa;;EAEtB,SAAS,eAAe;;EAExB,SAAS,0BAA0B;;;;;;;KAQzB,kBAAkB,WAC5B,gBAAgB,gCAAgC,WAAW;;;;;;;;;;;;;;KAejD,mBACV,gBAAgB,sCACd,KAAK,gBAAgB,kBAAkB;EACzC,QAAQ;;;UAIO;EACf,QAAQ,YAAY;EACpB,SAAS,aAAa;EACtB,SAAS;EACT,QAAQ;;;;;;;;;;;;;;KAeE,aAAa,gBAAgB,eAAe,iBACrD,WAAW,UAAU,mBAAmB,QAAQ;;;;;;;;;;;;;;KAgBvC,eAAe,uBACzB,KAAK,eAAe,cACjB,QAAQ,wBAAwB;;;;;;;;;;;KAYzB,WAAW,aAAa,8BACjC,WAAW,OAAO,eAAe,KAAK;;;;;;;;;;;;;KAe7B,0BACV,gBAAgB,eAAe,iBAE9B,WAAW,UAAU,kBAAkB,QAAQ;;;;;;;;;KAWtC,YAAY,KAAK,mBAAmB;;;;;;;;;KAUpC,cAAc,KAAK,mBAAmB;;;;;;;;;;;;KAatC,aACV,KAAK,gBACL,UAAU,aACP;;;;;;;;;KAUO,aACV,OAAO,OACP,KAAK,mBACF,QAAQ,wBAAwB"}
|
package/dist/types.js
ADDED
|
File without changes
|
|
@@ -1,5 +1,9 @@
|
|
|
1
|
-
import { VerifyFn } from "./types
|
|
1
|
+
import { VerifyFn } from "./types.js";
|
|
2
2
|
//#region src/verify.d.ts
|
|
3
|
+
/**
|
|
4
|
+
* Compares two byte arrays in constant time to prevent timing attacks.
|
|
5
|
+
*/
|
|
6
|
+
declare const constantTimeEquals: (a: Uint8Array, b: Uint8Array) => boolean;
|
|
3
7
|
declare const HMAC_HASH: {
|
|
4
8
|
readonly sha1: "SHA-1";
|
|
5
9
|
readonly sha256: "SHA-256";
|
|
@@ -11,7 +15,7 @@ type HmacAlgorithm = keyof typeof HMAC_HASH;
|
|
|
11
15
|
* Creates a webhook verifier that validates an HMAC signature from a request header.
|
|
12
16
|
*
|
|
13
17
|
* The verifier imports the provided string secret once, computes an HMAC from
|
|
14
|
-
* `
|
|
18
|
+
* `ctx.rawBody`, normalizes the incoming header value, and compares both
|
|
15
19
|
* signatures in constant time.
|
|
16
20
|
*
|
|
17
21
|
* Header values like `sha256=<hex>` are supported so common provider formats
|
|
@@ -45,5 +49,5 @@ declare const createHmacVerifier: ({ headerName, secret, algo }: {
|
|
|
45
49
|
algo?: HmacAlgorithm;
|
|
46
50
|
}) => VerifyFn;
|
|
47
51
|
//#endregion
|
|
48
|
-
export { createHmacVerifier };
|
|
49
|
-
//# sourceMappingURL=verify.d.
|
|
52
|
+
export { constantTimeEquals, createHmacVerifier };
|
|
53
|
+
//# sourceMappingURL=verify.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"verify.d.ts","names":[],"sources":["../src/verify.ts"],"mappings":";;;;;cAYa,qBAAsB,GAAG,YAAY,GAAG;cAc/C;WACJ;WACA;WACA;WACA;;KAGG,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAuDrB,uBACX,YACA,QACA;EAEA;EACA;EACA,OAAO;MACL"}
|
|
@@ -1,24 +1,43 @@
|
|
|
1
|
-
import { VerificationError } from "./errors.
|
|
2
|
-
import { constantTimeEquals } from "./utils/index.mjs";
|
|
1
|
+
import { VerificationError } from "./errors.js";
|
|
3
2
|
//#region src/verify.ts
|
|
4
3
|
/**
|
|
5
4
|
* Signature verification helpers for webhook requests.
|
|
6
5
|
*
|
|
7
6
|
* @module @zap-studio/webhooks/verify
|
|
8
7
|
*/
|
|
8
|
+
/**
|
|
9
|
+
* Compares two byte arrays in constant time to prevent timing attacks.
|
|
10
|
+
*/
|
|
11
|
+
const constantTimeEquals = (a, b) => {
|
|
12
|
+
if (a.length !== b.length) return false;
|
|
13
|
+
let result = 0;
|
|
14
|
+
for (let i = 0; i < a.length; i += 1)
|
|
15
|
+
// v8 ignore next -- `?? 0` fallback is unreachable: a Uint8Array never holds `undefined` at an in-bounds index, this exists only to satisfy noUncheckedIndexedAccess.
|
|
16
|
+
result |= (a[i] ?? 0) ^ (b[i] ?? 0);
|
|
17
|
+
return result === 0;
|
|
18
|
+
};
|
|
9
19
|
const HMAC_HASH = {
|
|
10
20
|
sha1: "SHA-1",
|
|
11
21
|
sha256: "SHA-256",
|
|
12
22
|
sha384: "SHA-384",
|
|
13
23
|
sha512: "SHA-512"
|
|
14
24
|
};
|
|
15
|
-
const
|
|
16
|
-
|
|
25
|
+
const HEX_PATTERN = /^[0-9a-f]*$/iu;
|
|
26
|
+
/**
|
|
27
|
+
* Decodes a hex string into bytes, or `undefined` when it is not valid hex.
|
|
28
|
+
*/
|
|
29
|
+
const hexToBytes = (hex) => {
|
|
30
|
+
if (hex.length % 2 !== 0 || !HEX_PATTERN.test(hex)) return;
|
|
31
|
+
const bytes = new Uint8Array(hex.length / 2);
|
|
32
|
+
for (let i = 0; i < bytes.length; i += 1) bytes[i] = Number.parseInt(hex.slice(i * 2, i * 2 + 2), 16);
|
|
33
|
+
return bytes;
|
|
34
|
+
};
|
|
35
|
+
const normalizeSignature = (signature) => signature.replace(/^[a-z0-9-]+=/iu, "").trim();
|
|
17
36
|
/**
|
|
18
37
|
* Creates a webhook verifier that validates an HMAC signature from a request header.
|
|
19
38
|
*
|
|
20
39
|
* The verifier imports the provided string secret once, computes an HMAC from
|
|
21
|
-
* `
|
|
40
|
+
* `ctx.rawBody`, normalizes the incoming header value, and compares both
|
|
22
41
|
* signatures in constant time.
|
|
23
42
|
*
|
|
24
43
|
* Header values like `sha256=<hex>` are supported so common provider formats
|
|
@@ -55,15 +74,17 @@ const createHmacVerifier = ({ headerName, secret, algo = "sha256" }) => {
|
|
|
55
74
|
hash,
|
|
56
75
|
name: "HMAC"
|
|
57
76
|
}, false, ["sign"]);
|
|
58
|
-
return async (
|
|
59
|
-
const actual =
|
|
77
|
+
return async (ctx) => {
|
|
78
|
+
const actual = ctx.request.headers.get(headerName);
|
|
60
79
|
if (actual === null || actual.length === 0) throw new VerificationError(`Missing signature header: ${headerName}`);
|
|
61
80
|
const key = await keyPromise;
|
|
62
|
-
const signature = await subtle.sign("HMAC", key, new Uint8Array(
|
|
63
|
-
|
|
81
|
+
const signature = await subtle.sign("HMAC", key, new Uint8Array(ctx.rawBody));
|
|
82
|
+
const expected = new Uint8Array(signature);
|
|
83
|
+
const provided = hexToBytes(normalizeSignature(actual));
|
|
84
|
+
if (provided === void 0 || !constantTimeEquals(expected, provided)) throw new VerificationError(`Invalid signature for header: ${headerName}`);
|
|
64
85
|
};
|
|
65
86
|
};
|
|
66
87
|
//#endregion
|
|
67
|
-
export { createHmacVerifier };
|
|
88
|
+
export { constantTimeEquals, createHmacVerifier };
|
|
68
89
|
|
|
69
|
-
//# sourceMappingURL=verify.
|
|
90
|
+
//# sourceMappingURL=verify.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"verify.js","names":[],"sources":["../src/verify.ts"],"sourcesContent":["/**\n * Signature verification helpers for webhook requests.\n *\n * @module @zap-studio/webhooks/verify\n */\n\nimport { VerificationError } from \"./errors.js\";\nimport type { VerifyFn } from \"./types.js\";\n\n/**\n * Compares two byte arrays in constant time to prevent timing attacks.\n */\nexport const constantTimeEquals = (a: Uint8Array, b: Uint8Array): boolean => {\n if (a.length !== b.length) {\n return false;\n }\n\n let result = 0;\n for (let i = 0; i < a.length; i += 1) {\n // v8 ignore next -- `?? 0` fallback is unreachable: a Uint8Array never holds `undefined` at an in-bounds index, this exists only to satisfy noUncheckedIndexedAccess.\n result |= (a[i] ?? 0) ^ (b[i] ?? 0); // oxlint-disable-line no-bitwise -- XOR is the constant-time compare trick.\n }\n\n return result === 0;\n};\n\nconst HMAC_HASH = {\n sha1: \"SHA-1\",\n sha256: \"SHA-256\",\n sha384: \"SHA-384\",\n sha512: \"SHA-512\",\n} as const;\n\ntype HmacAlgorithm = keyof typeof HMAC_HASH;\n\nconst HEX_PATTERN = /^[0-9a-f]*$/iu;\n\n/**\n * Decodes a hex string into bytes, or `undefined` when it is not valid hex.\n */\nconst hexToBytes = (hex: string): Uint8Array | undefined => {\n if (hex.length % 2 !== 0 || !HEX_PATTERN.test(hex)) {\n return undefined;\n }\n\n const bytes = new Uint8Array(hex.length / 2);\n for (let i = 0; i < bytes.length; i += 1) {\n bytes[i] = Number.parseInt(hex.slice(i * 2, i * 2 + 2), 16);\n }\n\n return bytes;\n};\n\nconst normalizeSignature = (signature: string): string =>\n signature.replace(/^[a-z0-9-]+=/iu, \"\").trim();\n\n/**\n * Creates a webhook verifier that validates an HMAC signature from a request header.\n *\n * The verifier imports the provided string secret once, computes an HMAC from\n * `ctx.rawBody`, normalizes the incoming header value, and compares both\n * signatures in constant time.\n *\n * Header values like `sha256=<hex>` are supported so common provider formats\n * such as GitHub work without extra parsing.\n *\n * @example\n * ```ts\n * import { createWebhookRouter } from \"@zap-studio/webhooks\";\n * import { createHmacVerifier } from \"@zap-studio/webhooks/verify\";\n *\n * const router = createWebhookRouter({\n * verify: createHmacVerifier({\n * headerName: \"x-hub-signature-256\",\n * secret: process.env.GITHUB_WEBHOOK_SECRET!,\n * }),\n * });\n * ```\n *\n * @param options - Verifier configuration.\n * @param options.headerName - Header containing the provider signature.\n * @param options.secret - Shared HMAC secret as a string.\n * @param options.algo - HMAC hash algorithm. Defaults to `\"sha256\"`.\n * @returns A router-compatible request verifier.\n *\n * @throws {VerificationError}\n * Thrown when verifier setup fails or request verification does not pass.\n */\nexport const createHmacVerifier = ({\n headerName,\n secret,\n algo = \"sha256\",\n}: {\n headerName: string;\n secret: string;\n algo?: HmacAlgorithm;\n}): VerifyFn => {\n if (globalThis.crypto?.subtle === undefined) {\n throw new VerificationError(\n \"Web Crypto API is unavailable in this runtime\"\n );\n }\n\n const { subtle } = globalThis.crypto;\n\n const hash = HMAC_HASH[algo];\n if (!hash) {\n throw new VerificationError(`Unsupported HMAC algorithm: ${algo}`);\n }\n\n const keyPromise = subtle.importKey(\n \"raw\",\n new TextEncoder().encode(secret),\n { hash, name: \"HMAC\" },\n false,\n [\"sign\"]\n );\n\n return async (ctx) => {\n const actual = ctx.request.headers.get(headerName);\n if (actual === null || actual.length === 0) {\n throw new VerificationError(`Missing signature header: ${headerName}`);\n }\n\n const key = await keyPromise;\n const signature = await subtle.sign(\n \"HMAC\",\n key,\n new Uint8Array(ctx.rawBody)\n );\n const expected = new Uint8Array(signature);\n const provided = hexToBytes(normalizeSignature(actual));\n\n if (provided === undefined || !constantTimeEquals(expected, provided)) {\n throw new VerificationError(\n `Invalid signature for header: ${headerName}`\n );\n }\n };\n};\n"],"mappings":";;;;;;;;;;AAYA,MAAa,sBAAsB,GAAe,MAA2B;CAC3E,IAAI,EAAE,WAAW,EAAE,QACjB,OAAO;CAGT,IAAI,SAAS;CACb,KAAK,IAAI,IAAI,GAAG,IAAI,EAAE,QAAQ,KAAK;;CAEjC,WAAW,EAAE,MAAM,MAAM,EAAE,MAAM;CAGnC,OAAO,WAAW;AACpB;AAEA,MAAM,YAAY;CAChB,MAAM;CACN,QAAQ;CACR,QAAQ;CACR,QAAQ;AACV;AAIA,MAAM,cAAc;;;;AAKpB,MAAM,cAAc,QAAwC;CAC1D,IAAI,IAAI,SAAS,MAAM,KAAK,CAAC,YAAY,KAAK,GAAG,GAC/C;CAGF,MAAM,QAAQ,IAAI,WAAW,IAAI,SAAS,CAAC;CAC3C,KAAK,IAAI,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK,GACrC,MAAM,KAAK,OAAO,SAAS,IAAI,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE;CAG5D,OAAO;AACT;AAEA,MAAM,sBAAsB,cAC1B,UAAU,QAAQ,kBAAkB,EAAE,CAAC,CAAC,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkC/C,MAAa,sBAAsB,EACjC,YACA,QACA,OAAO,eAKO;CACd,IAAI,WAAW,QAAQ,WAAW,KAAA,GAChC,MAAM,IAAI,kBACR,+CACF;CAGF,MAAM,EAAE,WAAW,WAAW;CAE9B,MAAM,OAAO,UAAU;CACvB,IAAI,CAAC,MACH,MAAM,IAAI,kBAAkB,+BAA+B,MAAM;CAGnE,MAAM,aAAa,OAAO,UACxB,OACA,IAAI,YAAY,CAAC,CAAC,OAAO,MAAM,GAC/B;EAAE;EAAM,MAAM;CAAO,GACrB,OACA,CAAC,MAAM,CACT;CAEA,OAAO,OAAO,QAAQ;EACpB,MAAM,SAAS,IAAI,QAAQ,QAAQ,IAAI,UAAU;EACjD,IAAI,WAAW,QAAQ,OAAO,WAAW,GACvC,MAAM,IAAI,kBAAkB,6BAA6B,YAAY;EAGvE,MAAM,MAAM,MAAM;EAClB,MAAM,YAAY,MAAM,OAAO,KAC7B,QACA,KACA,IAAI,WAAW,IAAI,OAAO,CAC5B;EACA,MAAM,WAAW,IAAI,WAAW,SAAS;EACzC,MAAM,WAAW,WAAW,mBAAmB,MAAM,CAAC;EAEtD,IAAI,aAAa,KAAA,KAAa,CAAC,mBAAmB,UAAU,QAAQ,GAClE,MAAM,IAAI,kBACR,iCAAiC,YACnC;CAEJ;AACF"}
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zap-studio/webhooks",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"private": false,
|
|
5
|
-
"description": "A lightweight, type-safe webhook router with Standard Schema validation, signature verification, and lifecycle hooks.",
|
|
5
|
+
"description": "A lightweight, type-safe, tree-shakeable webhook router with Standard Schema validation, signature verification, and lifecycle hooks.",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"arktype",
|
|
8
8
|
"lifecycle hooks",
|
|
@@ -33,24 +33,23 @@
|
|
|
33
33
|
],
|
|
34
34
|
"type": "module",
|
|
35
35
|
"sideEffects": false,
|
|
36
|
-
"types": "./dist/index.d.
|
|
36
|
+
"types": "./dist/index.d.ts",
|
|
37
37
|
"exports": {
|
|
38
|
-
".": "./dist/index.
|
|
39
|
-
"./
|
|
40
|
-
"./
|
|
41
|
-
"./types": "./dist/types
|
|
42
|
-
"./
|
|
43
|
-
"./verify": "./dist/verify.mjs",
|
|
38
|
+
".": "./dist/index.js",
|
|
39
|
+
"./errors": "./dist/errors.js",
|
|
40
|
+
"./router": "./dist/router.js",
|
|
41
|
+
"./types": "./dist/types.js",
|
|
42
|
+
"./verify": "./dist/verify.js",
|
|
44
43
|
"./package.json": "./package.json"
|
|
45
44
|
},
|
|
46
45
|
"publishConfig": {
|
|
47
46
|
"access": "public"
|
|
48
47
|
},
|
|
49
48
|
"dependencies": {
|
|
50
|
-
"@zap-studio/validation": "0.
|
|
49
|
+
"@zap-studio/validation": "1.0.0"
|
|
51
50
|
},
|
|
52
51
|
"devDependencies": {
|
|
53
|
-
"tsdown": "^0.22.
|
|
52
|
+
"tsdown": "^0.22.14",
|
|
54
53
|
"typescript": "^7.0.2",
|
|
55
54
|
"vitest": "^4.1.10",
|
|
56
55
|
"zod": "^4.4.3",
|
|
@@ -58,8 +57,5 @@
|
|
|
58
57
|
},
|
|
59
58
|
"engines": {
|
|
60
59
|
"node": ">=18.0.0"
|
|
61
|
-
},
|
|
62
|
-
"scripts": {
|
|
63
|
-
"build": "tsdown --config ./tsdown.config.ts"
|
|
64
60
|
}
|
|
65
61
|
}
|