@better-webhook/cli 3.3.0 → 3.4.1

package/dist/types/index.d.ts

@@ -0,0 +1,299 @@
+import { z } from "zod";
+export declare const HttpMethodSchema: z.ZodEnum<["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]>;
+export type HttpMethod = z.infer<typeof HttpMethodSchema>;
+export declare const HeaderEntrySchema: z.ZodObject<{
+    key: z.ZodString;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    key: string;
+}, {
+    value: string;
+    key: string;
+}>;
+export type HeaderEntry = z.infer<typeof HeaderEntrySchema>;
+export declare const WebhookProviderSchema: z.ZodEnum<["stripe", "github", "shopify", "twilio", "ragie", "sendgrid", "slack", "discord", "linear", "clerk", "custom"]>;
+export type WebhookProvider = z.infer<typeof WebhookProviderSchema>;
+export declare const TemplateMetadataSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    provider: z.ZodEnum<["stripe", "github", "shopify", "twilio", "ragie", "sendgrid", "slack", "discord", "linear", "clerk", "custom"]>;
+    event: z.ZodString;
+    file: z.ZodString;
+    version: z.ZodOptional<z.ZodString>;
+    docsUrl: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    name: string;
+    provider: "stripe" | "github" | "shopify" | "twilio" | "ragie" | "sendgrid" | "slack" | "discord" | "linear" | "clerk" | "custom";
+    event: string;
+    file: string;
+    description?: string | undefined;
+    version?: string | undefined;
+    docsUrl?: string | undefined;
+}, {
+    id: string;
+    name: string;
+    provider: "stripe" | "github" | "shopify" | "twilio" | "ragie" | "sendgrid" | "slack" | "discord" | "linear" | "clerk" | "custom";
+    event: string;
+    file: string;
+    description?: string | undefined;
+    version?: string | undefined;
+    docsUrl?: string | undefined;
+}>;
+export type TemplateMetadata = z.infer<typeof TemplateMetadataSchema>;
+export declare const TemplatesIndexSchema: z.ZodObject<{
+    version: z.ZodString;
+    templates: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        provider: z.ZodEnum<["stripe", "github", "shopify", "twilio", "ragie", "sendgrid", "slack", "discord", "linear", "clerk", "custom"]>;
+        event: z.ZodString;
+        file: z.ZodString;
+        version: z.ZodOptional<z.ZodString>;
+        docsUrl: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        name: string;
+        provider: "stripe" | "github" | "shopify" | "twilio" | "ragie" | "sendgrid" | "slack" | "discord" | "linear" | "clerk" | "custom";
+        event: string;
+        file: string;
+        description?: string | undefined;
+        version?: string | undefined;
+        docsUrl?: string | undefined;
+    }, {
+        id: string;
+        name: string;
+        provider: "stripe" | "github" | "shopify" | "twilio" | "ragie" | "sendgrid" | "slack" | "discord" | "linear" | "clerk" | "custom";
+        event: string;
+        file: string;
+        description?: string | undefined;
+        version?: string | undefined;
+        docsUrl?: string | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    version: string;
+    templates: {
+        id: string;
+        name: string;
+        provider: "stripe" | "github" | "shopify" | "twilio" | "ragie" | "sendgrid" | "slack" | "discord" | "linear" | "clerk" | "custom";
+        event: string;
+        file: string;
+        description?: string | undefined;
+        version?: string | undefined;
+        docsUrl?: string | undefined;
+    }[];
+}, {
+    version: string;
+    templates: {
+        id: string;
+        name: string;
+        provider: "stripe" | "github" | "shopify" | "twilio" | "ragie" | "sendgrid" | "slack" | "discord" | "linear" | "clerk" | "custom";
+        event: string;
+        file: string;
+        description?: string | undefined;
+        version?: string | undefined;
+        docsUrl?: string | undefined;
+    }[];
+}>;
+export type TemplatesIndex = z.infer<typeof TemplatesIndexSchema>;
+export declare const WebhookTemplateSchema: z.ZodObject<{
+    url: z.ZodOptional<z.ZodString>;
+    method: z.ZodDefault<z.ZodEnum<["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]>>;
+    headers: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        key: string;
+    }, {
+        value: string;
+        key: string;
+    }>, "many">>;
+    body: z.ZodOptional<z.ZodAny>;
+    provider: z.ZodOptional<z.ZodEnum<["stripe", "github", "shopify", "twilio", "ragie", "sendgrid", "slack", "discord", "linear", "clerk", "custom"]>>;
+    event: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
+    headers: {
+        value: string;
+        key: string;
+    }[];
+    description?: string | undefined;
+    provider?: "stripe" | "github" | "shopify" | "twilio" | "ragie" | "sendgrid" | "slack" | "discord" | "linear" | "clerk" | "custom" | undefined;
+    event?: string | undefined;
+    url?: string | undefined;
+    body?: any;
+}, {
+    description?: string | undefined;
+    provider?: "stripe" | "github" | "shopify" | "twilio" | "ragie" | "sendgrid" | "slack" | "discord" | "linear" | "clerk" | "custom" | undefined;
+    event?: string | undefined;
+    url?: string | undefined;
+    method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS" | undefined;
+    headers?: {
+        value: string;
+        key: string;
+    }[] | undefined;
+    body?: any;
+}>;
+export type WebhookTemplate = z.infer<typeof WebhookTemplateSchema>;
+export interface LocalTemplate {
+    id: string;
+    metadata: TemplateMetadata;
+    template: WebhookTemplate;
+    downloadedAt: string;
+    filePath: string;
+}
+export interface RemoteTemplate {
+    metadata: TemplateMetadata;
+    isDownloaded: boolean;
+}
+export declare const CapturedWebhookSchema: z.ZodObject<{
+    id: z.ZodString;
+    timestamp: z.ZodString;
+    method: z.ZodEnum<["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]>;
+    url: z.ZodString;
+    path: z.ZodString;
+    headers: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
+    body: z.ZodOptional<z.ZodAny>;
+    rawBody: z.ZodString;
+    query: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
+    provider: z.ZodOptional<z.ZodEnum<["stripe", "github", "shopify", "twilio", "ragie", "sendgrid", "slack", "discord", "linear", "clerk", "custom"]>>;
+    contentType: z.ZodOptional<z.ZodString>;
+    contentLength: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    path: string;
+    id: string;
+    url: string;
+    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
+    headers: Record<string, string | string[]>;
+    timestamp: string;
+    rawBody: string;
+    query: Record<string, string | string[]>;
+    provider?: "stripe" | "github" | "shopify" | "twilio" | "ragie" | "sendgrid" | "slack" | "discord" | "linear" | "clerk" | "custom" | undefined;
+    body?: any;
+    contentType?: string | undefined;
+    contentLength?: number | undefined;
+}, {
+    path: string;
+    id: string;
+    url: string;
+    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
+    headers: Record<string, string | string[]>;
+    timestamp: string;
+    rawBody: string;
+    query: Record<string, string | string[]>;
+    provider?: "stripe" | "github" | "shopify" | "twilio" | "ragie" | "sendgrid" | "slack" | "discord" | "linear" | "clerk" | "custom" | undefined;
+    body?: any;
+    contentType?: string | undefined;
+    contentLength?: number | undefined;
+}>;
+export type CapturedWebhook = z.infer<typeof CapturedWebhookSchema>;
+export interface CaptureFile {
+    file: string;
+    capture: CapturedWebhook;
+}
+export interface WebhookExecutionOptions {
+    url: string;
+    method?: HttpMethod;
+    headers?: HeaderEntry[];
+    body?: unknown;
+    secret?: string;
+    provider?: WebhookProvider;
+    timeout?: number;
+}
+export interface WebhookExecutionResult {
+    status: number;
+    statusText: string;
+    headers: Record<string, string | string[]>;
+    body: unknown;
+    bodyText: string;
+    json?: unknown;
+    duration: number;
+}
+export interface ReplayOptions {
+    targetUrl: string;
+    method?: HttpMethod;
+    headers?: HeaderEntry[];
+}
+export declare const ConfigSchema: z.ZodObject<{
+    version: z.ZodDefault<z.ZodString>;
+    templatesDir: z.ZodOptional<z.ZodString>;
+    capturesDir: z.ZodOptional<z.ZodString>;
+    defaultTargetUrl: z.ZodOptional<z.ZodString>;
+    secrets: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    dashboard: z.ZodOptional<z.ZodObject<{
+        port: z.ZodDefault<z.ZodNumber>;
+        host: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        port: number;
+        host: string;
+    }, {
+        port?: number | undefined;
+        host?: string | undefined;
+    }>>;
+    capture: z.ZodOptional<z.ZodObject<{
+        port: z.ZodDefault<z.ZodNumber>;
+        host: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        port: number;
+        host: string;
+    }, {
+        port?: number | undefined;
+        host?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    version: string;
+    templatesDir?: string | undefined;
+    capturesDir?: string | undefined;
+    defaultTargetUrl?: string | undefined;
+    secrets?: Record<string, string> | undefined;
+    dashboard?: {
+        port: number;
+        host: string;
+    } | undefined;
+    capture?: {
+        port: number;
+        host: string;
+    } | undefined;
+}, {
+    version?: string | undefined;
+    templatesDir?: string | undefined;
+    capturesDir?: string | undefined;
+    defaultTargetUrl?: string | undefined;
+    secrets?: Record<string, string> | undefined;
+    dashboard?: {
+        port?: number | undefined;
+        host?: string | undefined;
+    } | undefined;
+    capture?: {
+        port?: number | undefined;
+        host?: string | undefined;
+    } | undefined;
+}>;
+export type Config = z.infer<typeof ConfigSchema>;
+export interface DashboardState {
+    templates: {
+        remote: RemoteTemplate[];
+        local: LocalTemplate[];
+    };
+    captures: CaptureFile[];
+    config: Config;
+}
+export interface WebSocketMessage {
+    type: "capture" | "templates_updated" | "captures_updated" | "replay_result" | "error";
+    payload: unknown;
+}
+export interface SignatureOptions {
+    provider: WebhookProvider;
+    payload: string;
+    secret: string;
+    timestamp?: number;
+}
+export interface GeneratedSignature {
+    header: string;
+    value: string;
+}

package/dist/types/index.js

@@ -0,0 +1,86 @@
+import { z } from "zod";
+export const HttpMethodSchema = z.enum([
+    "GET",
+    "POST",
+    "PUT",
+    "PATCH",
+    "DELETE",
+    "HEAD",
+    "OPTIONS",
+]);
+export const HeaderEntrySchema = z.object({
+    key: z.string().min(1),
+    value: z.string(),
+});
+export const WebhookProviderSchema = z.enum([
+    "stripe",
+    "github",
+    "shopify",
+    "twilio",
+    "ragie",
+    "sendgrid",
+    "slack",
+    "discord",
+    "linear",
+    "clerk",
+    "custom",
+]);
+export const TemplateMetadataSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    description: z.string().optional(),
+    provider: WebhookProviderSchema,
+    event: z.string(),
+    file: z.string(),
+    version: z.string().optional(),
+    docsUrl: z.string().url().optional(),
+});
+export const TemplatesIndexSchema = z.object({
+    version: z.string(),
+    templates: z.array(TemplateMetadataSchema),
+});
+export const WebhookTemplateSchema = z.object({
+    url: z.string().url().optional(),
+    method: HttpMethodSchema.default("POST"),
+    headers: z.array(HeaderEntrySchema).default([]),
+    body: z.any().optional(),
+    provider: WebhookProviderSchema.optional(),
+    event: z.string().optional(),
+    description: z.string().optional(),
+});
+export const CapturedWebhookSchema = z.object({
+    id: z.string(),
+    timestamp: z.string(),
+    method: HttpMethodSchema,
+    url: z.string(),
+    path: z.string(),
+    headers: z.record(z.union([z.string(), z.array(z.string())])),
+    body: z.any().optional(),
+    rawBody: z.string(),
+    query: z.record(z.union([z.string(), z.array(z.string())])),
+    provider: WebhookProviderSchema.optional(),
+    contentType: z.string().optional(),
+    contentLength: z.number().optional(),
+});
+export const ConfigSchema = z.object({
+    version: z.string().default("2.0.0"),
+    templatesDir: z.string().optional(),
+    capturesDir: z.string().optional(),
+    defaultTargetUrl: z.string().url().optional(),
+    secrets: z
+        .record(z.string())
+        .optional()
+        .describe("Provider secrets for signature generation"),
+    dashboard: z
+        .object({
+        port: z.number().default(4000),
+        host: z.string().default("localhost"),
+    })
+        .optional(),
+    capture: z
+        .object({
+        port: z.number().default(3001),
+        host: z.string().default("0.0.0.0"),
+    })
+        .optional(),
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-webhook/cli",
-  "version": "3.3.0",
+  "version": "3.4.1",
   "description": "Modern CLI for developing, capturing, and replaying webhooks locally with dashboard UI.",
   "type": "module",
   "bin": {