@samva/webhooks 0.13.0 → 0.15.0

package/dist/protocol.d.ts

@@ -1,3 +1,6 @@
+import type { WebhookEvent } from "./types.gen.js";
+export { isKnownEvent } from "./decoder.gen.js";
+export type { SamvaWebhookEvent, WebhookEvent, UnknownWebhookEvent } from "./types.gen.js";
 /**
  * Header carrying the delivery's unique message ID. Retries of the same delivery reuse it, so it
  * is the key for deduplicating deliveries you have already handled.
@@ -17,15 +20,6 @@ export declare const WEBHOOK_SIGNATURE_HEADER = "webhook-signature";
  * rejected with {@link WebhookTimestampError}.
  */
 export declare const DEFAULT_TOLERANCE_SECONDS = 300;
-/** The event envelope carried in a verified delivery's body. */
-export interface SamvaWebhookEvent {
-    /** Event type, such as `message.delivered`. Branch on it before reading `data`. */
-    readonly type: string;
-    /** When the event occurred, as an ISO 8601 string. Distinct from the delivery's signing time. */
-    readonly timestamp: string;
-    /** Event-specific payload. Its shape depends on `type`; validate it before use. */
-    readonly data: unknown;
-}
 /** A delivery whose signature, timestamp, and envelope all checked out. */
 export interface VerifiedWebhook {
     /**
@@ -34,7 +28,7 @@ export interface VerifiedWebhook {
      * replay tolerance.
      */
     readonly id: string;
-    readonly event: SamvaWebhookEvent;
+    readonly event: WebhookEvent;
 }
 /** The three signing headers of a delivery, each present and non-empty, read verbatim. */
 export interface WebhookHeaders {
@@ -117,7 +111,8 @@ export declare const signWebhook: (input: {
  *
  * Checks, in order: all three headers are present and non-empty; the timestamp is integer Unix seconds within
  * `toleranceSeconds` of `nowMilliseconds`; some `v1` entry in the signature header matches, using
- * a constant-time comparison; the body is a Samva event envelope. The replay window rejects stale
+ * a constant-time comparison; the body has a valid envelope and known event payloads match their schema. Unknown event types pass
+ * through with untyped data. The replay window rejects stale
  * deliveries but does not detect a repeat inside it; deduplicate on the returned `id`.
  *
  * Rejects with {@link InvalidWebhookHeadersError}, {@link WebhookTimestampError},

package/dist/protocol.js

@@ -1,2 +1,2 @@
-import { _ as WebhookTimestampError, a as encodeWebhookSignature, c as signWebhook, d as webhookSignedContent, f as InvalidWebhookHeadersError, g as WebhookSignatureError, h as WebhookCryptoError, i as WEBHOOK_TIMESTAMP_HEADER, l as verifyWebhookAt, m as MalformedWebhookPayloadError, n as WEBHOOK_ID_HEADER, o as generateWebhookSecret, p as InvalidWebhookSecretError, r as WEBHOOK_SIGNATURE_HEADER, s as readWebhookHeaders, t as DEFAULT_TOLERANCE_SECONDS, u as verifyWebhookAtWithPublicKeys, v as WebhookVerificationError } from "./protocol-BGKUmvlI.js";
-export { DEFAULT_TOLERANCE_SECONDS, InvalidWebhookHeadersError, InvalidWebhookSecretError, MalformedWebhookPayloadError, WEBHOOK_ID_HEADER, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER, WebhookCryptoError, WebhookSignatureError, WebhookTimestampError, WebhookVerificationError, encodeWebhookSignature, generateWebhookSecret, readWebhookHeaders, signWebhook, verifyWebhookAt, verifyWebhookAtWithPublicKeys, webhookSignedContent };
+import { _ as WebhookTimestampError, a as encodeWebhookSignature, c as signWebhook, d as webhookSignedContent, f as InvalidWebhookHeadersError, g as WebhookSignatureError, h as WebhookCryptoError, i as WEBHOOK_TIMESTAMP_HEADER, l as verifyWebhookAt, m as MalformedWebhookPayloadError, n as WEBHOOK_ID_HEADER, o as generateWebhookSecret, p as InvalidWebhookSecretError, r as WEBHOOK_SIGNATURE_HEADER, s as readWebhookHeaders, t as DEFAULT_TOLERANCE_SECONDS, u as verifyWebhookAtWithPublicKeys, v as WebhookVerificationError, y as isKnownEvent } from "./protocol-CLrYczjc.js";
+export { DEFAULT_TOLERANCE_SECONDS, InvalidWebhookHeadersError, InvalidWebhookSecretError, MalformedWebhookPayloadError, WEBHOOK_ID_HEADER, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER, WebhookCryptoError, WebhookSignatureError, WebhookTimestampError, WebhookVerificationError, encodeWebhookSignature, generateWebhookSecret, isKnownEvent, readWebhookHeaders, signWebhook, verifyWebhookAt, verifyWebhookAtWithPublicKeys, webhookSignedContent };