@webhooks-cc/sdk 1.0.0 → 1.1.0

package/dist/{diff-Dn4j4B_n.d.mts → diff-C6vrhcEq.d.mts}

@@ -26,6 +26,8 @@ interface MockResponse {
     body: string;
     /** Response headers */
     headers: Record<string, string>;
+    /** Response delay in milliseconds (0-30000). The receiver caps at 30s. */
+    delay?: number;
 }
 /**
  * A captured webhook request with full HTTP details.
@@ -129,7 +131,7 @@ interface SendOptions {
     /** Request body (will be JSON-serialized if not a string) */
     body?: unknown;
 }
-type TemplateProvider = "stripe" | "github" | "shopify" | "twilio" | "slack" | "paddle" | "linear" | "standard-webhooks";
+type TemplateProvider = "stripe" | "github" | "shopify" | "twilio" | "slack" | "paddle" | "linear" | "sendgrid" | "clerk" | "discord" | "vercel" | "gitlab" | "standard-webhooks";
 /** Static metadata describing a supported template provider. */
 interface TemplateProviderInfo {
     /** Provider identifier used by sendTemplate()/sendTo() */
@@ -340,7 +342,7 @@ interface SignatureVerificationResult {
     valid: boolean;
 }
 /** Providers supported by verifySignature(). */
-type VerifyProvider = TemplateProvider | "discord";
+type VerifyProvider = TemplateProvider;
 /**
  * Options for verifying a captured webhook signature.
  * For Twilio, `url` is required because the signature covers the full webhook URL.

package/dist/{diff-Dn4j4B_n.d.ts → diff-C6vrhcEq.d.ts}

@@ -26,6 +26,8 @@ interface MockResponse {
     body: string;
     /** Response headers */
     headers: Record<string, string>;
+    /** Response delay in milliseconds (0-30000). The receiver caps at 30s. */
+    delay?: number;
 }
 /**
  * A captured webhook request with full HTTP details.
@@ -129,7 +131,7 @@ interface SendOptions {
     /** Request body (will be JSON-serialized if not a string) */
     body?: unknown;
 }
-type TemplateProvider = "stripe" | "github" | "shopify" | "twilio" | "slack" | "paddle" | "linear" | "standard-webhooks";
+type TemplateProvider = "stripe" | "github" | "shopify" | "twilio" | "slack" | "paddle" | "linear" | "sendgrid" | "clerk" | "discord" | "vercel" | "gitlab" | "standard-webhooks";
 /** Static metadata describing a supported template provider. */
 interface TemplateProviderInfo {
     /** Provider identifier used by sendTemplate()/sendTo() */
@@ -340,7 +342,7 @@ interface SignatureVerificationResult {
     valid: boolean;
 }
 /** Providers supported by verifySignature(). */
-type VerifyProvider = TemplateProvider | "discord";
+type VerifyProvider = TemplateProvider;
 /**
  * Options for verifying a captured webhook signature.
  * For Twilio, `url` is required because the signature covers the full webhook URL.

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { R as Request, P as ParsedBody, a as ParsedFormBody, S as SearchResult, V as VerifySignatureOptions, b as SignatureVerificationResult } from './diff-Dn4j4B_n.mjs';
-export { A as ApiError, B as BodyDiff, C as ClearRequestsOptions, c as ClientHooks, d as ClientOptions, e as CreateEndpointOptions, f as CurlExport, D as DiffRequestsOptions, g as DiffResult, E as Endpoint, h as ErrorHookInfo, i as ExportRequestsOptions, F as FormBodyValue, H as HarExport, j as HeaderDiff, J as JsonBodyDiff, L as ListPaginatedRequestsOptions, k as ListRequestsOptions, M as MockResponse, N as NotFoundError, O as OperationDescription, l as PaginatedResult, m as RateLimitError, n as RequestDifferences, o as RequestHookInfo, p as RequestsExport, q as ResponseHookInfo, r as RetryOptions, s as SDKDescription, t as SearchFilters, u as SendOptions, v as SendTemplateOptions, w as SendToOptions, x as SubscribeOptions, T as TemplateProvider, y as TemplateProviderInfo, z as TextBodyDiff, G as TimeoutError, U as UnauthorizedError, I as UpdateEndpointOptions, K as UsageInfo, Q as ValueDifference, W as VerifyProvider, X as WaitForAllOptions, Y as WaitForOptions, Z as WebhookFlowBuilder, _ as WebhookFlowResult, $ as WebhookFlowVerifyOptions, a0 as WebhooksCC, a1 as WebhooksCCError, a2 as diffRequests } from './diff-Dn4j4B_n.mjs';
+import { R as Request, P as ParsedBody, a as ParsedFormBody, S as SearchResult, V as VerifySignatureOptions, b as SignatureVerificationResult } from './diff-C6vrhcEq.mjs';
+export { A as ApiError, B as BodyDiff, C as ClearRequestsOptions, c as ClientHooks, d as ClientOptions, e as CreateEndpointOptions, f as CurlExport, D as DiffRequestsOptions, g as DiffResult, E as Endpoint, h as ErrorHookInfo, i as ExportRequestsOptions, F as FormBodyValue, H as HarExport, j as HeaderDiff, J as JsonBodyDiff, L as ListPaginatedRequestsOptions, k as ListRequestsOptions, M as MockResponse, N as NotFoundError, O as OperationDescription, l as PaginatedResult, m as RateLimitError, n as RequestDifferences, o as RequestHookInfo, p as RequestsExport, q as ResponseHookInfo, r as RetryOptions, s as SDKDescription, t as SearchFilters, u as SendOptions, v as SendTemplateOptions, w as SendToOptions, x as SubscribeOptions, T as TemplateProvider, y as TemplateProviderInfo, z as TextBodyDiff, G as TimeoutError, U as UnauthorizedError, I as UpdateEndpointOptions, K as UsageInfo, Q as ValueDifference, W as VerifyProvider, X as WaitForAllOptions, Y as WaitForOptions, Z as WebhookFlowBuilder, _ as WebhookFlowResult, $ as WebhookFlowVerifyOptions, a0 as WebhooksCC, a1 as WebhooksCCError, a2 as diffRequests } from './diff-C6vrhcEq.mjs';
 
 /**
  * Safely parse a JSON request body.
@@ -55,6 +55,26 @@ declare function isPaddleWebhook(request: Request): boolean;
 declare function isLinearWebhook(request: Request): boolean;
 /** Check if a request looks like a Discord interaction webhook. */
 declare function isDiscordWebhook(request: Request): boolean;
+/**
+ * Check if a request looks like a SendGrid event webhook.
+ * Matches on the body being a JSON array with an sg_event_id field.
+ */
+declare function isSendGridWebhook(request: Request): boolean;
+/**
+ * Check if a request looks like a Clerk webhook.
+ * Matches on the `svix-id` header being present.
+ */
+declare function isClerkWebhook(request: Request): boolean;
+/**
+ * Check if a request looks like a Vercel webhook.
+ * Matches on the `x-vercel-signature` header being present.
+ */
+declare function isVercelWebhook(request: Request): boolean;
+/**
+ * Check if a request looks like a GitLab webhook.
+ * Matches on the `x-gitlab-event` or `x-gitlab-token` header being present.
+ */
+declare function isGitLabWebhook(request: Request): boolean;
 /**
  * Check if a request looks like a Standard Webhooks request.
  * Matches on the presence of all three Standard Webhooks headers:
@@ -177,6 +197,42 @@ declare const TEMPLATE_METADATA: Readonly<{
         signatureHeader: "linear-signature";
         signatureAlgorithm: "hmac-sha256";
     }>;
+    sendgrid: Readonly<{
+        provider: "sendgrid";
+        templates: readonly ("delivered" | "open" | "bounce" | "spam_report")[];
+        defaultTemplate: "delivered";
+        secretRequired: false;
+    }>;
+    clerk: Readonly<{
+        provider: "clerk";
+        templates: readonly ("user.created" | "user.updated" | "user.deleted" | "session.created")[];
+        defaultTemplate: "user.created";
+        secretRequired: true;
+        signatureHeader: "webhook-signature";
+        signatureAlgorithm: "hmac-sha256";
+    }>;
+    discord: Readonly<{
+        provider: "discord";
+        templates: readonly ("interaction_create" | "ping" | "message_component")[];
+        defaultTemplate: "interaction_create";
+        secretRequired: false;
+    }>;
+    vercel: Readonly<{
+        provider: "vercel";
+        templates: readonly ("deployment.created" | "deployment.succeeded" | "deployment.error")[];
+        defaultTemplate: "deployment.created";
+        secretRequired: true;
+        signatureHeader: "x-vercel-signature";
+        signatureAlgorithm: "hmac-sha1";
+    }>;
+    gitlab: Readonly<{
+        provider: "gitlab";
+        templates: readonly ("push" | "merge_request")[];
+        defaultTemplate: "push";
+        secretRequired: true;
+        signatureHeader: "x-gitlab-token";
+        signatureAlgorithm: "token";
+    }>;
     "standard-webhooks": Readonly<{
         provider: "standard-webhooks";
         templates: readonly never[];
@@ -215,6 +271,21 @@ declare function verifyPaddleSignature(body: string | undefined, signatureHeader
  * Verify a Linear webhook signature against the raw request body.
  */
 declare function verifyLinearSignature(body: string | undefined, signatureHeader: string | null | undefined, secret: string): Promise<boolean>;
+/**
+ * Verify a Vercel webhook signature against the raw request body.
+ * Vercel signs with HMAC-SHA1 and sends the hex-encoded signature in x-vercel-signature.
+ */
+declare function verifyVercelSignature(body: string | undefined, signatureHeader: string | null | undefined, secret: string): Promise<boolean>;
+/**
+ * Verify a GitLab webhook token against the x-gitlab-token header.
+ * GitLab sends the raw secret in the header — no HMAC involved.
+ */
+declare function verifyGitLabSignature(_body: string | undefined, tokenHeader: string | null | undefined, secret: string): Promise<boolean>;
+/**
+ * Verify a Clerk webhook signature using Standard Webhooks (Svix) signing.
+ * Delegates to verifyStandardWebhookSignature.
+ */
+declare function verifyClerkSignature(body: string | undefined, headers: Record<string, string>, secret: string): Promise<boolean>;
 /**
  * Verify a Discord interaction signature using the application's Ed25519 public key.
  */
@@ -228,4 +299,4 @@ declare function verifyStandardWebhookSignature(body: string | undefined, header
  */
 declare function verifySignature(request: VerifyableRequest, options: VerifySignatureOptions): Promise<SignatureVerificationResult>;
 
-export { ParsedBody, ParsedFormBody, Request, type SSEFrame, SearchResult, SignatureVerificationResult, TEMPLATE_METADATA, VerifySignatureOptions, extractJsonField, isDiscordWebhook, isGitHubWebhook, isLinearWebhook, isPaddleWebhook, isShopifyWebhook, isSlackWebhook, isStandardWebhook, isStripeWebhook, isTwilioWebhook, matchAll, matchAny, matchBodyPath, matchBodySubset, matchContentType, matchHeader, matchJsonField, matchMethod, matchPath, matchQueryParam, parseBody, parseDuration, parseFormBody, parseJsonBody, parseSSE, verifyDiscordSignature, verifyGitHubSignature, verifyLinearSignature, verifyPaddleSignature, verifyShopifySignature, verifySignature, verifySlackSignature, verifyStandardWebhookSignature, verifyStripeSignature, verifyTwilioSignature };
+export { ParsedBody, ParsedFormBody, Request, type SSEFrame, SearchResult, SignatureVerificationResult, TEMPLATE_METADATA, VerifySignatureOptions, extractJsonField, isClerkWebhook, isDiscordWebhook, isGitHubWebhook, isGitLabWebhook, isLinearWebhook, isPaddleWebhook, isSendGridWebhook, isShopifyWebhook, isSlackWebhook, isStandardWebhook, isStripeWebhook, isTwilioWebhook, isVercelWebhook, matchAll, matchAny, matchBodyPath, matchBodySubset, matchContentType, matchHeader, matchJsonField, matchMethod, matchPath, matchQueryParam, parseBody, parseDuration, parseFormBody, parseJsonBody, parseSSE, verifyClerkSignature, verifyDiscordSignature, verifyGitHubSignature, verifyGitLabSignature, verifyLinearSignature, verifyPaddleSignature, verifyShopifySignature, verifySignature, verifySlackSignature, verifyStandardWebhookSignature, verifyStripeSignature, verifyTwilioSignature, verifyVercelSignature };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { R as Request, P as ParsedBody, a as ParsedFormBody, S as SearchResult, V as VerifySignatureOptions, b as SignatureVerificationResult } from './diff-Dn4j4B_n.js';
-export { A as ApiError, B as BodyDiff, C as ClearRequestsOptions, c as ClientHooks, d as ClientOptions, e as CreateEndpointOptions, f as CurlExport, D as DiffRequestsOptions, g as DiffResult, E as Endpoint, h as ErrorHookInfo, i as ExportRequestsOptions, F as FormBodyValue, H as HarExport, j as HeaderDiff, J as JsonBodyDiff, L as ListPaginatedRequestsOptions, k as ListRequestsOptions, M as MockResponse, N as NotFoundError, O as OperationDescription, l as PaginatedResult, m as RateLimitError, n as RequestDifferences, o as RequestHookInfo, p as RequestsExport, q as ResponseHookInfo, r as RetryOptions, s as SDKDescription, t as SearchFilters, u as SendOptions, v as SendTemplateOptions, w as SendToOptions, x as SubscribeOptions, T as TemplateProvider, y as TemplateProviderInfo, z as TextBodyDiff, G as TimeoutError, U as UnauthorizedError, I as UpdateEndpointOptions, K as UsageInfo, Q as ValueDifference, W as VerifyProvider, X as WaitForAllOptions, Y as WaitForOptions, Z as WebhookFlowBuilder, _ as WebhookFlowResult, $ as WebhookFlowVerifyOptions, a0 as WebhooksCC, a1 as WebhooksCCError, a2 as diffRequests } from './diff-Dn4j4B_n.js';
+import { R as Request, P as ParsedBody, a as ParsedFormBody, S as SearchResult, V as VerifySignatureOptions, b as SignatureVerificationResult } from './diff-C6vrhcEq.js';
+export { A as ApiError, B as BodyDiff, C as ClearRequestsOptions, c as ClientHooks, d as ClientOptions, e as CreateEndpointOptions, f as CurlExport, D as DiffRequestsOptions, g as DiffResult, E as Endpoint, h as ErrorHookInfo, i as ExportRequestsOptions, F as FormBodyValue, H as HarExport, j as HeaderDiff, J as JsonBodyDiff, L as ListPaginatedRequestsOptions, k as ListRequestsOptions, M as MockResponse, N as NotFoundError, O as OperationDescription, l as PaginatedResult, m as RateLimitError, n as RequestDifferences, o as RequestHookInfo, p as RequestsExport, q as ResponseHookInfo, r as RetryOptions, s as SDKDescription, t as SearchFilters, u as SendOptions, v as SendTemplateOptions, w as SendToOptions, x as SubscribeOptions, T as TemplateProvider, y as TemplateProviderInfo, z as TextBodyDiff, G as TimeoutError, U as UnauthorizedError, I as UpdateEndpointOptions, K as UsageInfo, Q as ValueDifference, W as VerifyProvider, X as WaitForAllOptions, Y as WaitForOptions, Z as WebhookFlowBuilder, _ as WebhookFlowResult, $ as WebhookFlowVerifyOptions, a0 as WebhooksCC, a1 as WebhooksCCError, a2 as diffRequests } from './diff-C6vrhcEq.js';
 
 /**
  * Safely parse a JSON request body.
@@ -55,6 +55,26 @@ declare function isPaddleWebhook(request: Request): boolean;
 declare function isLinearWebhook(request: Request): boolean;
 /** Check if a request looks like a Discord interaction webhook. */
 declare function isDiscordWebhook(request: Request): boolean;
+/**
+ * Check if a request looks like a SendGrid event webhook.
+ * Matches on the body being a JSON array with an sg_event_id field.
+ */
+declare function isSendGridWebhook(request: Request): boolean;
+/**
+ * Check if a request looks like a Clerk webhook.
+ * Matches on the `svix-id` header being present.
+ */
+declare function isClerkWebhook(request: Request): boolean;
+/**
+ * Check if a request looks like a Vercel webhook.
+ * Matches on the `x-vercel-signature` header being present.
+ */
+declare function isVercelWebhook(request: Request): boolean;
+/**
+ * Check if a request looks like a GitLab webhook.
+ * Matches on the `x-gitlab-event` or `x-gitlab-token` header being present.
+ */
+declare function isGitLabWebhook(request: Request): boolean;
 /**
  * Check if a request looks like a Standard Webhooks request.
  * Matches on the presence of all three Standard Webhooks headers:
@@ -177,6 +197,42 @@ declare const TEMPLATE_METADATA: Readonly<{
         signatureHeader: "linear-signature";
         signatureAlgorithm: "hmac-sha256";
     }>;
+    sendgrid: Readonly<{
+        provider: "sendgrid";
+        templates: readonly ("delivered" | "open" | "bounce" | "spam_report")[];
+        defaultTemplate: "delivered";
+        secretRequired: false;
+    }>;
+    clerk: Readonly<{
+        provider: "clerk";
+        templates: readonly ("user.created" | "user.updated" | "user.deleted" | "session.created")[];
+        defaultTemplate: "user.created";
+        secretRequired: true;
+        signatureHeader: "webhook-signature";
+        signatureAlgorithm: "hmac-sha256";
+    }>;
+    discord: Readonly<{
+        provider: "discord";
+        templates: readonly ("interaction_create" | "ping" | "message_component")[];
+        defaultTemplate: "interaction_create";
+        secretRequired: false;
+    }>;
+    vercel: Readonly<{
+        provider: "vercel";
+        templates: readonly ("deployment.created" | "deployment.succeeded" | "deployment.error")[];
+        defaultTemplate: "deployment.created";
+        secretRequired: true;
+        signatureHeader: "x-vercel-signature";
+        signatureAlgorithm: "hmac-sha1";
+    }>;
+    gitlab: Readonly<{
+        provider: "gitlab";
+        templates: readonly ("push" | "merge_request")[];
+        defaultTemplate: "push";
+        secretRequired: true;
+        signatureHeader: "x-gitlab-token";
+        signatureAlgorithm: "token";
+    }>;
     "standard-webhooks": Readonly<{
         provider: "standard-webhooks";
         templates: readonly never[];
@@ -215,6 +271,21 @@ declare function verifyPaddleSignature(body: string | undefined, signatureHeader
  * Verify a Linear webhook signature against the raw request body.
  */
 declare function verifyLinearSignature(body: string | undefined, signatureHeader: string | null | undefined, secret: string): Promise<boolean>;
+/**
+ * Verify a Vercel webhook signature against the raw request body.
+ * Vercel signs with HMAC-SHA1 and sends the hex-encoded signature in x-vercel-signature.
+ */
+declare function verifyVercelSignature(body: string | undefined, signatureHeader: string | null | undefined, secret: string): Promise<boolean>;
+/**
+ * Verify a GitLab webhook token against the x-gitlab-token header.
+ * GitLab sends the raw secret in the header — no HMAC involved.
+ */
+declare function verifyGitLabSignature(_body: string | undefined, tokenHeader: string | null | undefined, secret: string): Promise<boolean>;
+/**
+ * Verify a Clerk webhook signature using Standard Webhooks (Svix) signing.
+ * Delegates to verifyStandardWebhookSignature.
+ */
+declare function verifyClerkSignature(body: string | undefined, headers: Record<string, string>, secret: string): Promise<boolean>;
 /**
  * Verify a Discord interaction signature using the application's Ed25519 public key.
  */
@@ -228,4 +299,4 @@ declare function verifyStandardWebhookSignature(body: string | undefined, header
  */
 declare function verifySignature(request: VerifyableRequest, options: VerifySignatureOptions): Promise<SignatureVerificationResult>;
 
-export { ParsedBody, ParsedFormBody, Request, type SSEFrame, SearchResult, SignatureVerificationResult, TEMPLATE_METADATA, VerifySignatureOptions, extractJsonField, isDiscordWebhook, isGitHubWebhook, isLinearWebhook, isPaddleWebhook, isShopifyWebhook, isSlackWebhook, isStandardWebhook, isStripeWebhook, isTwilioWebhook, matchAll, matchAny, matchBodyPath, matchBodySubset, matchContentType, matchHeader, matchJsonField, matchMethod, matchPath, matchQueryParam, parseBody, parseDuration, parseFormBody, parseJsonBody, parseSSE, verifyDiscordSignature, verifyGitHubSignature, verifyLinearSignature, verifyPaddleSignature, verifyShopifySignature, verifySignature, verifySlackSignature, verifyStandardWebhookSignature, verifyStripeSignature, verifyTwilioSignature };
+export { ParsedBody, ParsedFormBody, Request, type SSEFrame, SearchResult, SignatureVerificationResult, TEMPLATE_METADATA, VerifySignatureOptions, extractJsonField, isClerkWebhook, isDiscordWebhook, isGitHubWebhook, isGitLabWebhook, isLinearWebhook, isPaddleWebhook, isSendGridWebhook, isShopifyWebhook, isSlackWebhook, isStandardWebhook, isStripeWebhook, isTwilioWebhook, isVercelWebhook, matchAll, matchAny, matchBodyPath, matchBodySubset, matchContentType, matchHeader, matchJsonField, matchMethod, matchPath, matchQueryParam, parseBody, parseDuration, parseFormBody, parseJsonBody, parseSSE, verifyClerkSignature, verifyDiscordSignature, verifyGitHubSignature, verifyGitLabSignature, verifyLinearSignature, verifyPaddleSignature, verifyShopifySignature, verifySignature, verifySlackSignature, verifyStandardWebhookSignature, verifyStripeSignature, verifyTwilioSignature, verifyVercelSignature };