@zap-studio/webhooks 0.4.0 → 1.1.0

package/dist/types.d.ts

@@ -1,10 +1,18 @@
 import { StandardSchemaV1 } from "@zap-studio/validation";
+import { Logger } from "@zap-studio/logger";
 //#region src/types.d.ts
 /**
  * Context shared by hooks, verifiers, and handlers for a single webhook request.
  *
  * The router consumes the request body exactly once, so `request.body` is
  * already used by the time hooks or handlers run — read `rawBody` instead.
+ *
+ * @example
+ * ```ts
+ * const before: BeforeHook = (ctx: WebhookContext) => {
+ *   console.log("received", ctx.path);
+ * };
+ * ```
  */
 interface WebhookContext {
   /** The matched route key registered on the router (e.g. "stripe") */
@@ -18,12 +26,75 @@ interface WebhookContext {
  * Handler context extending the shared webhook context with the validated payload.
  *
  * @template TPayload - Validated payload type for the matched route.
+ *
+ * @example
+ * ```ts
+ * const handler: WebhookHandler<{ type: string }> = ({ payload }: HandlerContext<{ type: string }>) => {
+ *   console.log(payload.type);
+ * };
+ * ```
  */
 interface HandlerContext<TPayload = unknown> extends WebhookContext {
   /** The validated webhook payload */
   payload: TPayload;
 }
-/** Route registration options for a webhook handler. */
+/** Internal handler entry stored per registered route. */
+interface HandlerEntry<TPayload = unknown> {
+  /** Route-level hooks that run after successful processing. */
+  after?: AfterHook[];
+  /** Route-level hooks that run before request processing. */
+  before?: BeforeHook[];
+  /** The handler function to process the webhook. */
+  handler: WebhookHandler<TPayload>;
+  /** Optional Standard Schema validator to validate the webhook payload. */
+  schema?: StandardSchemaV1<unknown, TPayload>;
+}
+/**
+ * Configuration options for creating a `WebhookRouter`.
+ *
+ * @example
+ * ```ts
+ * const options: WebhookRouterOptions = {
+ *   prefix: "/webhooks",
+ *   verify: createHmacVerifier({ headerName: "x-signature", secret }),
+ * };
+ * ```
+ */
+interface WebhookRouterOptions {
+  /** Global hooks executed after successful route handler completion. */
+  after?: AfterHook | AfterHook[];
+  /** Global hooks executed before route-level hooks and verification. */
+  before?: BeforeHook | BeforeHook[];
+  /** Global error hook used to override the default `500` response. */
+  onError?: ErrorHook;
+  /**
+   * Optional logger for router internals. When omitted, nothing is logged.
+   *
+   * Logs each delivery attempt and handler dispatch at `debug`, and
+   * verification failures and unmatched routes at `warn`.
+   */
+  logger?: Logger;
+  /**
+   * Required path prefix for all webhook routes. Defaults to `"/webhooks"`.
+   *
+   * Normalized internally: leading slash added, trailing slash stripped,
+   * duplicate slashes collapsed. Use `""` or `"/"` to mount at the root.
+   */
+  prefix?: string;
+  /** Optional request verification function (for signature checks, auth, etc.). */
+  verify?: VerifyFn;
+}
+/**
+ * Route registration options for a webhook handler.
+ *
+ * @example
+ * ```ts
+ * const options: RegisterOptions<{ type: string }> = {
+ *   schema: stripeEventSchema,
+ *   handler: ({ payload }) => console.log(payload.type),
+ * };
+ * ```
+ */
 interface RegisterOptions<T> {
   /** Hooks that run after successful processing (before global after hooks) */
   after?: AfterHook | AfterHook[];
@@ -44,20 +115,40 @@ type InferSchemaOutput<TSchema> = TSchema extends StandardSchemaV1<unknown, infe
  * Route options where schema is required and handler payload is inferred.
  *
  * @template TSchema - Schema used to infer handler payload type.
+ *
+ * @example
+ * ```ts
+ * const stripeRoute: SchemaRouteOptions<typeof stripeEventSchema> = {
+ *   schema: stripeEventSchema,
+ *   handler: ({ payload }) => console.log(payload.type),
+ * };
+ * ```
  */
 type SchemaRouteOptions<TSchema extends StandardSchemaV1<unknown, unknown>> = Omit<RegisterOptions<InferSchemaOutput<TSchema>>, "schema"> & {
   schema: TSchema;
 };
+/** A single route's registration shape, as used by schema-driven route dictionaries. */
 interface RouteLike {
+  /** Hooks that run after successful processing. */
   after?: AfterHook | AfterHook[];
+  /** Hooks that run before request processing. */
   before?: BeforeHook | BeforeHook[];
+  /** The handler function to process the webhook. */
   handler: WebhookHandler;
+  /** Standard Schema validator the route's payload type is inferred from. */
   schema: StandardSchemaV1<unknown, unknown>;
 }
 /**
  * Applies schema-driven payload inference to each route entry.
  *
  * @template TRoutes - Route dictionary keyed by webhook path.
+ *
+ * @example
+ * ```ts
+ * const routes: SchemaRoutes<{ "/stripe": { handler: WebhookHandler; schema: typeof stripeEventSchema } }> = {
+ *   "/stripe": { schema: stripeEventSchema, handler: ({ payload }) => console.log(payload.type) },
+ * };
+ * ```
  */
 type SchemaRoutes<TRoutes extends Record<string, RouteLike>> = { [P in keyof TRoutes]: SchemaRouteOptions<TRoutes[P]["schema"]>; };
 /**
@@ -65,29 +156,78 @@ type SchemaRoutes<TRoutes extends Record<string, RouteLike>> = { [P in keyof TRo
  *
  * Return a `Response` to control the reply, or `undefined` to let the router
  * respond with its default `200` acknowledgement.
+ *
+ * @example
+ * ```ts
+ * const handler: WebhookHandler<{ type: string }> = ({ payload }) => {
+ *   console.log(payload.type);
+ * };
+ * ```
  */
 type WebhookHandler<TPayload = unknown> = (ctx: HandlerContext<TPayload>) => Promise<Response | undefined> | Response | undefined;
-/** Maps route keys to their payload-specific webhook handlers. */
+/**
+ * Maps route keys to their payload-specific webhook handlers.
+ *
+ * @example
+ * ```ts
+ * const handlers: HandlerMap<{ "/stripe": { type: string } }> = {
+ *   "/stripe": ({ payload }) => console.log(payload.type),
+ * };
+ * ```
+ */
 type HandlerMap<TMap extends Record<string, unknown>> = { [P in keyof TMap]: WebhookHandler<TMap[P]>; };
 /**
  * Builds a webhook payload map from a schema-based route dictionary.
  *
  * @template TRoutes - Route dictionary keyed by webhook path.
+ *
+ * @example
+ * ```ts
+ * type Payloads = InferWebhookMapFromRoutes<{
+ *   "/stripe": { handler: WebhookHandler; schema: typeof stripeEventSchema };
+ * }>;
+ * ```
  */
 type InferWebhookMapFromRoutes<TRoutes extends Record<string, RouteLike>> = { [P in keyof TRoutes]: InferSchemaOutput<TRoutes[P]["schema"]>; };
-/** Verification function for incoming requests. Throws to reject the request. */
+/**
+ * Verification function for incoming requests. Throws to reject the request.
+ *
+ * @example
+ * ```ts
+ * const verify: VerifyFn = createHmacVerifier({ headerName: "x-signature", secret });
+ * ```
+ */
 type VerifyFn = (ctx: WebhookContext) => Promise<void> | void;
-/** Hook function that runs before request processing */
+/**
+ * Hook function that runs before request processing
+ *
+ * @example
+ * ```ts
+ * const before: BeforeHook = (ctx) => console.log("received", ctx.path);
+ * ```
+ */
 type BeforeHook = (ctx: WebhookContext) => Promise<void> | void;
 /**
  * Hook function that runs after successful request processing.
  *
  * The hook receives the outgoing response as-is; call `response.clone()`
  * before reading its body to avoid consuming the stream sent to the client.
+ *
+ * @example
+ * ```ts
+ * const after: AfterHook = (ctx, response) => console.log(response.status);
+ * ```
  */
 type AfterHook = (ctx: WebhookContext, response: Response) => Promise<void> | void;
-/** Hook function that runs when an error occurs */
+/**
+ * Hook function that runs when an error occurs
+ *
+ * @example
+ * ```ts
+ * const onError: ErrorHook = (error) => Response.json({ error: error.message }, { status: 500 });
+ * ```
+ */
 type ErrorHook = (error: Error, ctx: WebhookContext) => Promise<Response | undefined> | Response | undefined;
 //#endregion
-export { AfterHook, BeforeHook, ErrorHook, HandlerContext, HandlerMap, InferSchemaOutput, InferWebhookMapFromRoutes, RegisterOptions, SchemaRouteOptions, SchemaRoutes, VerifyFn, WebhookContext, WebhookHandler };
+export { AfterHook, BeforeHook, ErrorHook, HandlerContext, HandlerEntry, HandlerMap, InferSchemaOutput, InferWebhookMapFromRoutes, RegisterOptions, RouteLike, SchemaRouteOptions, SchemaRoutes, VerifyFn, WebhookContext, WebhookHandler, WebhookRouterOptions };
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","names":[],"sources":["../src/types.ts"],"mappings":";;;;;;;;UAciB;;EAEf;;EAEA,SAAS;;EAET,SAAS;;;;;;;UAQM,eAAe,4BAA4B;;EAE1D,SAAS;;;UAIM,gBAAgB;;EAE/B,QAAQ,YAAY;;EAEpB,SAAS,aAAa;;EAEtB,SAAS,eAAe;;EAExB,SAAS,0BAA0B;;;;;;;KAQzB,kBAAkB,WAC5B,gBAAgB,gCAAgC,WAAW;;;;;;KAOjD,mBACV,gBAAgB,sCACd,KAAK,gBAAgB,kBAAkB;EACzC,QAAQ;;UAGA;EACR,QAAQ,YAAY;EACpB,SAAS,aAAa;EACtB,SAAS;EACT,QAAQ;;;;;;;KAQE,aAAa,gBAAgB,eAAe,iBACrD,WAAW,UAAU,mBAAmB,QAAQ;;;;;;;KASvC,eAAe,uBACzB,KAAK,eAAe,cACjB,QAAQ,wBAAwB;;KAGzB,WAAW,aAAa,8BACjC,WAAW,OAAO,eAAe,KAAK;;;;;;KAQ7B,0BACV,gBAAgB,eAAe,iBAE9B,WAAW,UAAU,kBAAkB,QAAQ;;KAItC,YAAY,KAAK,mBAAmB;;KAGpC,cAAc,KAAK,mBAAmB;;;;;;;KAQtC,aACV,KAAK,gBACL,UAAU,aACP;;KAGO,aACV,OAAO,OACP,KAAK,mBACF,QAAQ,wBAAwB"}
+{"version":3,"file":"types.d.ts","names":[],"sources":["../src/types.ts"],"mappings":";;;;;;;;;;;;;;;;UAsBiB;;EAEf;;EAEA,SAAS;;EAET,SAAS;;;;;;;;;;;;;;UAeM,eAAe,4BAA4B;;EAE1D,SAAS;;;UAIM,aAAa;;EAE5B,QAAQ;;EAER,SAAS;;EAET,SAAS,eAAe;;EAExB,SAAS,0BAA0B;;;;;;;;;;;;;UAcpB;;EAEf,QAAQ,YAAY;;EAEpB,SAAS,aAAa;;EAEtB,UAAU;;;;;;;EAOV,SAAS;;;;;;;EAOT;;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;;EAEf,QAAQ,YAAY;;EAEpB,SAAS,aAAa;;EAEtB,SAAS;;EAET,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/verify.d.ts

@@ -1,5 +1,9 @@
 import { VerifyFn } from "./types.js";
 //#region src/verify.d.ts
+/**
+ * Compares two byte arrays in constant time to prevent timing attacks.
+ */
+declare const constantTimeEquals: (a: Uint8Array, b: Uint8Array) => boolean;
 declare const HMAC_HASH: {
   readonly sha1: "SHA-1";
   readonly sha256: "SHA-256";
@@ -45,5 +49,5 @@ declare const createHmacVerifier: ({ headerName, secret, algo }: {
   algo?: HmacAlgorithm;
 }) => VerifyFn;
 //#endregion
-export { createHmacVerifier };
+export { constantTimeEquals, createHmacVerifier };
 //# sourceMappingURL=verify.d.ts.map

package/dist/verify.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"verify.d.ts","names":[],"sources":["../src/verify.ts"],"mappings":";;cAUM;WACJ;WACA;WACA;WACA;;KAGG,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cA2CrB,uBACX,YACA,QACA;EAEA;EACA;EACA,OAAO;MACL"}
+{"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"}

package/dist/verify.js

@@ -1,19 +1,38 @@
 import { VerificationError } from "./errors.js";
-import { constantTimeEquals } from "./utils.js";
 //#region src/verify.ts
 /**
 * Signature verification helpers for webhook requests.
 *
 * @module @zap-studio/webhooks/verify
 */
+/**
+* Compares two byte arrays in constant time to prevent timing attacks.
+*/
+const constantTimeEquals = (a, b) => {
+	if (a.length !== b.length) return false;
+	let result = 0;
+	for (let i = 0; i < a.length; i += 1)
+ // v8 ignore next -- `?? 0` fallback is unreachable: a Uint8Array never holds `undefined` at an in-bounds index, this exists only to satisfy noUncheckedIndexedAccess.
+	result |= (a[i] ?? 0) ^ (b[i] ?? 0);
+	return result === 0;
+};
 const HMAC_HASH = {
 	sha1: "SHA-1",
 	sha256: "SHA-256",
 	sha384: "SHA-384",
 	sha512: "SHA-512"
 };
-const toHex = (bytes) => Array.from(bytes, (byte) => byte.toString(16).padStart(2, "0")).join("");
-const normalizeSignature = (signature) => signature.replace(/^[a-z0-9-]+=/iu, "").trim().toLowerCase();
+const HEX_PATTERN = /^[0-9a-f]*$/iu;
+/**
+* Decodes a hex string into bytes, or `undefined` when it is not valid hex.
+*/
+const hexToBytes = (hex) => {
+	if (hex.length % 2 !== 0 || !HEX_PATTERN.test(hex)) return;
+	const bytes = new Uint8Array(hex.length / 2);
+	for (let i = 0; i < bytes.length; i += 1) bytes[i] = Number.parseInt(hex.slice(i * 2, i * 2 + 2), 16);
+	return bytes;
+};
+const normalizeSignature = (signature) => signature.replace(/^[a-z0-9-]+=/iu, "").trim();
 /**
 * Creates a webhook verifier that validates an HMAC signature from a request header.
 *
@@ -60,11 +79,12 @@ const createHmacVerifier = ({ headerName, secret, algo = "sha256" }) => {
 		if (actual === null || actual.length === 0) throw new VerificationError(`Missing signature header: ${headerName}`);
 		const key = await keyPromise;
 		const signature = await subtle.sign("HMAC", key, new Uint8Array(ctx.rawBody));
-		const expected = toHex(new Uint8Array(signature));
-		if (!constantTimeEquals(expected, normalizeSignature(actual))) throw new VerificationError(`Invalid signature for header: ${headerName}`);
+		const expected = new Uint8Array(signature);
+		const provided = hexToBytes(normalizeSignature(actual));
+		if (provided === void 0 || !constantTimeEquals(expected, provided)) throw new VerificationError(`Invalid signature for header: ${headerName}`);
 	};
 };
 //#endregion
-export { createHmacVerifier };
+export { constantTimeEquals, createHmacVerifier };
 
 //# sourceMappingURL=verify.js.map

package/dist/verify.js.map

@@ -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\";\nimport { constantTimeEquals } from \"./utils.js\";\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 toHex = (bytes: Uint8Array): string =>\n  Array.from(bytes, (byte) => byte.toString(16).padStart(2, \"0\")).join(\"\");\n\nconst normalizeSignature = (signature: string): string =>\n  signature\n    .replace(/^[a-z0-9-]+=/iu, \"\")\n    .trim()\n    .toLowerCase();\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 = toHex(new Uint8Array(signature));\n\n    if (!constantTimeEquals(expected, normalizeSignature(actual))) {\n      throw new VerificationError(\n        `Invalid signature for header: ${headerName}`\n      );\n    }\n  };\n};\n"],"mappings":";;;;;;;;AAUA,MAAM,YAAY;CAChB,MAAM;CACN,QAAQ;CACR,QAAQ;CACR,QAAQ;AACV;AAIA,MAAM,SAAS,UACb,MAAM,KAAK,QAAQ,SAAS,KAAK,SAAS,EAAE,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE;AAEzE,MAAM,sBAAsB,cAC1B,UACG,QAAQ,kBAAkB,EAAE,CAAC,CAC7B,KAAK,CAAC,CACN,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCjB,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,MAAM,IAAI,WAAW,SAAS,CAAC;EAEhD,IAAI,CAAC,mBAAmB,UAAU,mBAAmB,MAAM,CAAC,GAC1D,MAAM,IAAI,kBACR,iCAAiC,YACnC;CAEJ;AACF"}
+{"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

@@ -1,8 +1,8 @@
 {
   "name": "@zap-studio/webhooks",
-  "version": "0.4.0",
+  "version": "1.1.0",
   "private": false,
-  "description": "A lightweight, type-safe webhook router with Standard Schema validation, signature verification, and lifecycle hooks.",
+  "description": "A lightweight, type-safe, tree-shakeable webhook router with Standard Schema validation, signature verification, and lifecycle hooks.",
   "keywords": [
     "arktype",
     "lifecycle hooks",
@@ -39,7 +39,6 @@
     "./errors": "./dist/errors.js",
     "./router": "./dist/router.js",
     "./types": "./dist/types.js",
-    "./utils": "./dist/utils.js",
     "./verify": "./dist/verify.js",
     "./package.json": "./package.json"
   },
@@ -47,16 +46,17 @@
     "access": "public"
   },
   "dependencies": {
-    "@zap-studio/validation": "workspace:*"
+    "@zap-studio/logger": "1.0.0",
+    "@zap-studio/validation": "1.0.0"
   },
   "devDependencies": {
-    "@zap-studio/typescript": "workspace:*",
-    "tsdown": "catalog:",
-    "typescript": "catalog:",
-    "vitest": "catalog:",
-    "zod": "catalog:"
+    "tsdown": "^0.22.14",
+    "typescript": "^7.0.2",
+    "vitest": "^4.1.10",
+    "zod": "^4.4.3",
+    "@zap-studio/typescript": "0.0.0"
   },
   "engines": {
     "node": ">=18.0.0"
   }
-}
+}

package/dist/utils.d.ts

@@ -1,18 +0,0 @@
-//#region src/utils.d.ts
-/**
- * Utility helpers for webhook internals.
- *
- * @module @zap-studio/webhooks/utils
- */
-/**
- * Compares two strings in constant time to prevent timing attacks.
- *
- * @example
- * ```ts
- * const isEqual = constantTimeEquals("string1", "string2"); // returns false
- * ```
- */
-declare const constantTimeEquals: (a: string, b: string) => boolean;
-//#endregion
-export { constantTimeEquals };
-//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","names":[],"sources":["../src/utils.ts"],"mappings":";;;;;;;;;;;;;;cAca,qBAAsB,WAAW"}

package/dist/utils.js

@@ -1,24 +0,0 @@
-//#region src/utils.ts
-/**
-* Utility helpers for webhook internals.
-*
-* @module @zap-studio/webhooks/utils
-*/
-/**
-* Compares two strings in constant time to prevent timing attacks.
-*
-* @example
-* ```ts
-* const isEqual = constantTimeEquals("string1", "string2"); // returns false
-* ```
-*/
-const constantTimeEquals = (a, b) => {
-	if (a.length !== b.length) return false;
-	let result = 0;
-	for (let i = 0; i < a.length; i += 1) result |= a.charCodeAt(i) ^ b.charCodeAt(i);
-	return result === 0;
-};
-//#endregion
-export { constantTimeEquals };
-
-//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","names":[],"sources":["../src/utils.ts"],"sourcesContent":["/**\n * Utility helpers for webhook internals.\n *\n * @module @zap-studio/webhooks/utils\n */\n\n/**\n * Compares two strings in constant time to prevent timing attacks.\n *\n * @example\n * ```ts\n * const isEqual = constantTimeEquals(\"string1\", \"string2\"); // returns false\n * ```\n */\nexport const constantTimeEquals = (a: string, b: string): 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    // oxlint-disable-next-line no-bitwise, unicorn/prefer-code-point -- XOR is the constant-time compare trick; charCodeAt reads each char with the same cost, and inputs are plain ASCII hex.\n    result |= a.charCodeAt(i) ^ b.charCodeAt(i);\n  }\n\n  return result === 0;\n};\n"],"mappings":";;;;;;;;;;;;;;AAcA,MAAa,sBAAsB,GAAW,MAAuB;CACnE,IAAI,EAAE,WAAW,EAAE,QACjB,OAAO;CAGT,IAAI,SAAS;CACb,KAAK,IAAI,IAAI,GAAG,IAAI,EAAE,QAAQ,KAAK,GAEjC,UAAU,EAAE,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC;CAG5C,OAAO,WAAW;AACpB"}