npm - @better-webhook/cli - Versions diffs - 3.4.3 → 3.5.0 - Mend

@better-webhook/cli 3.4.3 → 3.5.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.

Files changed (41) hide show

package/README.md +35 -0
package/dist/dashboard/assets/index-CxrRCNTh.css +1 -0
package/dist/dashboard/assets/index-Dlqdzwyc.js +23 -0
package/dist/dashboard/index.html +2 -2
package/dist/index.cjs +341 -24
package/dist/index.js +341 -24
package/package.json +5 -4
package/dist/commands/capture.d.ts +0 -2
package/dist/commands/capture.js +0 -30
package/dist/commands/captures.d.ts +0 -2
package/dist/commands/captures.js +0 -217
package/dist/commands/dashboard.d.ts +0 -2
package/dist/commands/dashboard.js +0 -65
package/dist/commands/index.d.ts +0 -6
package/dist/commands/index.js +0 -6
package/dist/commands/replay.d.ts +0 -2
package/dist/commands/replay.js +0 -140
package/dist/commands/run.d.ts +0 -2
package/dist/commands/run.js +0 -181
package/dist/commands/templates.d.ts +0 -2
package/dist/commands/templates.js +0 -285
package/dist/core/capture-server.d.ts +0 -31
package/dist/core/capture-server.js +0 -298
package/dist/core/dashboard-api.d.ts +0 -8
package/dist/core/dashboard-api.js +0 -271
package/dist/core/dashboard-server.d.ts +0 -20
package/dist/core/dashboard-server.js +0 -124
package/dist/core/executor.d.ts +0 -11
package/dist/core/executor.js +0 -130
package/dist/core/index.d.ts +0 -5
package/dist/core/index.js +0 -5
package/dist/core/replay-engine.d.ts +0 -18
package/dist/core/replay-engine.js +0 -208
package/dist/core/signature.d.ts +0 -24
package/dist/core/signature.js +0 -199
package/dist/core/template-manager.d.ts +0 -24
package/dist/core/template-manager.js +0 -246
package/dist/dashboard/assets/index-BSfTbn4Y.js +0 -23
package/dist/dashboard/assets/index-zDTVdss_.css +0 -1
package/dist/types/index.d.ts +0 -299
package/dist/types/index.js +0 -86

package/dist/dashboard/index.html CHANGED Viewed

@@ -5,8 +5,8 @@
     <link rel="icon" type="image/svg+xml" href="/vite.svg" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>better-webhook dashboard</title>
-    <script type="module" crossorigin src="/assets/index-BSfTbn4Y.js"></script>
-    <link rel="stylesheet" crossorigin href="/assets/index-zDTVdss_.css">
+    <script type="module" crossorigin src="/assets/index-Dlqdzwyc.js"></script>
+    <link rel="stylesheet" crossorigin href="/assets/index-CxrRCNTh.css">
   </head>
   <body>
     <div id="root"></div>

package/dist/index.cjs CHANGED Viewed

@@ -25,7 +25,8 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 // src/index.ts
 var import_commander7 = require("commander");
-var import_node_module = require("module");
+var import_node_fs = require("fs");
+var import_node_url = require("url");
 // src/commands/templates.ts
 var import_commander = require("commander");
@@ -123,6 +124,12 @@ var ConfigSchema = import_zod.z.object({
 // src/core/template-manager.ts
 var GITHUB_RAW_BASE = "https://raw.githubusercontent.com/endalk200/better-webhook/main";
 var TEMPLATES_INDEX_URL = `${GITHUB_RAW_BASE}/templates/templates.json`;
+var TEMPLATE_ID_PATTERN = /^[a-z0-9][a-z0-9._-]*$/i;
+function isValidTemplateId(id) {
+  if (!id || id.length > 128) return false;
+  if (id.includes("/") || id.includes("\\") || id.includes("..")) return false;
+  return TEMPLATE_ID_PATTERN.test(id);
+}
 var TemplateManager = class {
   baseDir;
   templatesDir;
@@ -376,6 +383,76 @@ var TemplateManager = class {
     }
     return deleted;
   }
+  /**
+   * Check if a template with the given ID already exists locally
+   */
+  templateExists(templateId) {
+    return this.getLocalTemplate(templateId) !== null;
+  }
+  /**
+   * Generate a unique template ID from provider and event
+   */
+  generateTemplateId(provider, event) {
+    const providerPart = provider || "custom";
+    const eventPart = event || "webhook";
+    const baseId = `${providerPart}-${eventPart}`.toLowerCase().replace(/\s+/g, "-");
+    if (!this.templateExists(baseId)) {
+      return baseId;
+    }
+    let counter = 1;
+    while (this.templateExists(`${baseId}-${counter}`)) {
+      counter++;
+    }
+    return `${baseId}-${counter}`;
+  }
+  /**
+   * Save a user-created template from a captured webhook
+   */
+  saveUserTemplate(template, options = {}) {
+    const provider = template.provider || "custom";
+    const event = options.event || template.event || "webhook";
+    const templateId = options.id || this.generateTemplateId(provider, event);
+    const name = options.name || templateId;
+    const description = options.description || template.description;
+    if (!isValidTemplateId(templateId)) {
+      throw new Error(
+        `Invalid template ID "${templateId}". IDs must start with alphanumeric, contain only letters, numbers, dots, underscores, and hyphens.`
+      );
+    }
+    if (!options.overwrite && this.templateExists(templateId)) {
+      throw new Error(
+        `Template with ID "${templateId}" already exists. Use --overwrite to replace it.`
+      );
+    }
+    const providerDir = (0, import_path.join)(this.templatesDir, provider);
+    if (!(0, import_fs.existsSync)(providerDir)) {
+      (0, import_fs.mkdirSync)(providerDir, { recursive: true });
+    }
+    const metadata = {
+      id: templateId,
+      name,
+      provider,
+      event,
+      file: `${provider}/${templateId}.json`,
+      description,
+      source: "capture",
+      createdAt: (/* @__PURE__ */ new Date()).toISOString()
+    };
+    const saveData = {
+      ...template,
+      provider,
+      event,
+      description,
+      _metadata: metadata
+    };
+    const filePath = (0, import_path.join)(providerDir, `${templateId}.json`);
+    (0, import_fs.writeFileSync)(filePath, JSON.stringify(saveData, null, 2));
+    return {
+      id: templateId,
+      filePath,
+      template: saveData
+    };
+  }
 };
 var instance = null;
 function getTemplateManager(baseDir) {
@@ -1543,6 +1620,7 @@ var capture = new import_commander3.Command().name("capture").description("Start
 var import_commander4 = require("commander");
 var import_chalk4 = __toESM(require("chalk"), 1);
 var import_prompts3 = __toESM(require("prompts"), 1);
+var import_os4 = require("os");
 // src/core/replay-engine.ts
 var import_fs3 = require("fs");
@@ -1676,15 +1754,93 @@ var ReplayEngine = class {
         body = capture2.rawBody;
       }
     }
+    const event = options?.event || this.detectEvent(capture2);
     return {
       url: options?.url || `http://localhost:3000${capture2.path}`,
       method: capture2.method,
       headers,
       body,
       provider: capture2.provider,
+      event,
       description: `Captured ${capture2.provider || "webhook"} at ${capture2.timestamp}`
     };
   }
+  /**
+   * Detect event type from captured webhook headers/body
+   */
+  detectEvent(capture2) {
+    const headers = capture2.headers;
+    const githubEvent = headers["x-github-event"];
+    if (githubEvent) {
+      return Array.isArray(githubEvent) ? githubEvent[0] : githubEvent;
+    }
+    if (capture2.provider === "stripe" && capture2.body) {
+      const body = capture2.body;
+      if (typeof body.type === "string") {
+        return body.type;
+      }
+    }
+    if (capture2.provider === "slack" && capture2.body) {
+      const body = capture2.body;
+      if (typeof body.type === "string") {
+        return body.type;
+      }
+      const event = body.event;
+      if (event && typeof event.type === "string") {
+        return event.type;
+      }
+    }
+    if (capture2.provider === "linear" && capture2.body) {
+      const body = capture2.body;
+      if (typeof body.type === "string") {
+        return body.type;
+      }
+    }
+    if (capture2.provider === "clerk" && capture2.body) {
+      const body = capture2.body;
+      if (typeof body.type === "string") {
+        return body.type;
+      }
+    }
+    if (capture2.provider === "ragie" && capture2.body) {
+      const body = capture2.body;
+      if (typeof body.event_type === "string") {
+        return body.event_type;
+      }
+    }
+    const shopifyTopic = headers["x-shopify-topic"];
+    if (shopifyTopic) {
+      return Array.isArray(shopifyTopic) ? shopifyTopic[0] : shopifyTopic;
+    }
+    if (capture2.provider === "sendgrid" && Array.isArray(capture2.body)) {
+      const firstEvent = capture2.body[0];
+      if (firstEvent && typeof firstEvent.event === "string") {
+        return firstEvent.event;
+      }
+    }
+    if (capture2.provider === "discord" && capture2.body) {
+      const body = capture2.body;
+      if (typeof body.type === "number") {
+        return `type_${body.type}`;
+      }
+    }
+    if (capture2.body && typeof capture2.body === "object") {
+      const body = capture2.body;
+      if (typeof body.type === "string") {
+        return body.type;
+      }
+      if (typeof body.event_type === "string") {
+        return body.event_type;
+      }
+      if (typeof body.event === "string") {
+        return body.event;
+      }
+      if (typeof body.action === "string") {
+        return body.action;
+      }
+    }
+    return void 0;
+  }
   /**
    * Get a summary of a capture
    */
@@ -1773,6 +1929,13 @@ function getReplayEngine(capturesDir) {
 }
 // src/commands/captures.ts
+function toRelativePath(absolutePath) {
+  const home = (0, import_os4.homedir)();
+  if (absolutePath.startsWith(home)) {
+    return "~" + absolutePath.slice(home.length);
+  }
+  return absolutePath;
+}
 var listCommand2 = new import_commander4.Command().name("list").alias("ls").description("List captured webhooks").option("-l, --limit <limit>", "Maximum number of captures to show", "20").option("-p, --provider <provider>", "Filter by provider").action((options) => {
   const limit = parseInt(options.limit, 10);
   if (isNaN(limit) || limit <= 0) {
@@ -1981,7 +2144,92 @@ var cleanCommand2 = new import_commander4.Command().name("clean").alias("remove-
   console.log(import_chalk4.default.gray(`  Storage: ${engine.getCapturesDir()}
 `));
 });
-var captures = new import_commander4.Command().name("captures").alias("c").description("Manage captured webhooks").addCommand(listCommand2).addCommand(showCommand).addCommand(searchCommand2).addCommand(deleteCommand).addCommand(cleanCommand2);
+var saveAsTemplateCommand = new import_commander4.Command().name("save-as-template").alias("sat").argument("<captureId>", "Capture ID or partial ID").description("Save a captured webhook as a reusable template").option("--id <id>", "Template ID (auto-generated if not provided)").option("--name <name>", "Template display name").option("--event <event>", "Event type (auto-detected if not provided)").option("--description <description>", "Template description").option("--url <url>", "Default target URL for the template").option("--overwrite", "Overwrite existing template with same ID").action(
+  async (captureId, options) => {
+    const engine = getReplayEngine();
+    const templateManager = getTemplateManager();
+    const captureFile = engine.getCapture(captureId);
+    if (!captureFile) {
+      console.log(import_chalk4.default.red(`
+\u274C Capture not found: ${captureId}
+`));
+      process.exitCode = 1;
+      return;
+    }
+    const { capture: capture2 } = captureFile;
+    console.log(import_chalk4.default.bold("\n\u{1F4CB} Capture to save as template:\n"));
+    console.log(`    ${import_chalk4.default.white(capture2.id.slice(0, 8))}`);
+    console.log(import_chalk4.default.gray(`    ${capture2.method} ${capture2.path}`));
+    if (capture2.provider) {
+      console.log(import_chalk4.default.gray(`    Provider: ${capture2.provider}`));
+    }
+    console.log();
+    const template = engine.captureToTemplate(captureId, {
+      url: options.url,
+      event: options.event
+    });
+    let templateId = options.id;
+    if (!templateId) {
+      const suggestedId = `${capture2.provider || "custom"}-${template.event || "webhook"}`.toLowerCase().replace(/\s+/g, "-");
+      const response = await (0, import_prompts3.default)({
+        type: "text",
+        name: "templateId",
+        message: "Template ID:",
+        initial: suggestedId,
+        validate: (value) => value.trim().length > 0 || "Template ID is required"
+      });
+      if (!response.templateId) {
+        console.log(import_chalk4.default.yellow("Cancelled"));
+        return;
+      }
+      templateId = response.templateId;
+    }
+    if (!options.overwrite && templateId && templateManager.templateExists(templateId)) {
+      const response = await (0, import_prompts3.default)({
+        type: "confirm",
+        name: "overwrite",
+        message: `Template "${templateId}" already exists. Overwrite?`,
+        initial: false
+      });
+      if (!response.overwrite) {
+        console.log(import_chalk4.default.yellow("Cancelled"));
+        return;
+      }
+      options.overwrite = true;
+    }
+    try {
+      const result = templateManager.saveUserTemplate(template, {
+        id: templateId,
+        name: options.name,
+        event: options.event || template.event,
+        description: options.description,
+        overwrite: options.overwrite
+      });
+      console.log(import_chalk4.default.green(`
+\u2713 Saved template: ${result.id}`));
+      console.log(import_chalk4.default.gray(`  File: ${toRelativePath(result.filePath)}`));
+      console.log(import_chalk4.default.gray(`  Provider: ${template.provider || "custom"}`));
+      if (template.event) {
+        console.log(import_chalk4.default.gray(`  Event: ${template.event}`));
+      }
+      console.log();
+      console.log(import_chalk4.default.gray("  Run it with:"));
+      console.log(
+        import_chalk4.default.cyan(
+          `    better-webhook run ${result.id} --url http://localhost:3000/webhooks
+`
+        )
+      );
+    } catch (error) {
+      const message = error instanceof Error ? error.message : "Failed to save template";
+      console.log(import_chalk4.default.red(`
+\u274C ${message}
+`));
+      process.exitCode = 1;
+    }
+  }
+);
+var captures = new import_commander4.Command().name("captures").alias("c").description("Manage captured webhooks").addCommand(listCommand2).addCommand(showCommand).addCommand(searchCommand2).addCommand(deleteCommand).addCommand(cleanCommand2).addCommand(saveAsTemplateCommand);
 // src/commands/replay.ts
 var import_commander5 = require("commander");
@@ -2168,12 +2416,28 @@ var ReplayBodySchema = import_zod2.z.object({
 var TemplateDownloadBodySchema = import_zod2.z.object({
   id: import_zod2.z.string().min(1)
 });
+var TemplateIdSchema = import_zod2.z.string().regex(
+  /^[a-z0-9][a-z0-9._-]*$/i,
+  "ID must start with alphanumeric and contain only letters, numbers, dots, underscores, and hyphens"
+).max(128, "ID must be 128 characters or less").refine(
+  (val) => !val.includes("/") && !val.includes("\\") && !val.includes(".."),
+  "ID cannot contain path separators or parent directory references"
+);
 var RunTemplateBodySchema = import_zod2.z.object({
   templateId: import_zod2.z.string().min(1),
   url: import_zod2.z.string().min(1),
   secret: import_zod2.z.string().optional(),
   headers: import_zod2.z.array(HeaderEntrySchema).optional()
 });
+var SaveAsTemplateBodySchema = import_zod2.z.object({
+  captureId: import_zod2.z.string().min(1),
+  id: TemplateIdSchema.optional(),
+  name: import_zod2.z.string().optional(),
+  event: import_zod2.z.string().optional(),
+  description: import_zod2.z.string().optional(),
+  url: import_zod2.z.string().optional(),
+  overwrite: import_zod2.z.boolean().optional()
+});
 function createDashboardApiRouter(options = {}) {
   const router = import_express.default.Router();
   const replayEngine = new ReplayEngine(options.capturesDir);
@@ -2189,22 +2453,26 @@ function createDashboardApiRouter(options = {}) {
   };
   const broadcastTemplates = async () => {
     if (!broadcast) return;
-    const local = templateManager.listLocalTemplates();
-    let remote = [];
     try {
-      const index = await templateManager.fetchRemoteIndex(false);
-      const localIds = new Set(local.map((t) => t.id));
-      remote = index.templates.map((metadata) => ({
-        metadata,
-        isDownloaded: localIds.has(metadata.id)
-      }));
-    } catch {
-      remote = [];
+      const local = templateManager.listLocalTemplates();
+      let remote = [];
+      try {
+        const index = await templateManager.fetchRemoteIndex(false);
+        const localIds = new Set(local.map((t) => t.id));
+        remote = index.templates.map((metadata) => ({
+          metadata,
+          isDownloaded: localIds.has(metadata.id)
+        }));
+      } catch {
+        remote = [];
+      }
+      broadcast({
+        type: "templates_updated",
+        payload: { local, remote }
+      });
+    } catch (error) {
+      console.error("[dashboard-api] Failed to broadcast templates:", error);
     }
-    broadcast({
-      type: "templates_updated",
-      payload: { local, remote }
-    });
   };
   router.get("/captures", (req, res) => {
     const limitRaw = typeof req.query.limit === "string" ? req.query.limit : "";
@@ -2417,6 +2685,54 @@ function createDashboardApiRouter(options = {}) {
       return jsonError(res, 400, error?.message || "Run failed");
     }
   });
+  router.post(
+    "/templates/from-capture",
+    import_express.default.json({ limit: "5mb" }),
+    async (req, res) => {
+      const parsed = SaveAsTemplateBodySchema.safeParse(req.body);
+      if (!parsed.success) {
+        return jsonError(
+          res,
+          400,
+          parsed.error.issues[0]?.message || "Invalid body"
+        );
+      }
+      const { captureId, id, name, event, description, url, overwrite } = parsed.data;
+      if (url !== void 0) {
+        try {
+          new URL(url);
+        } catch {
+          return jsonError(res, 400, "Invalid url");
+        }
+      }
+      const captureFile = replayEngine.getCapture(captureId);
+      if (!captureFile) {
+        return jsonError(res, 404, "Capture not found");
+      }
+      const template = replayEngine.captureToTemplate(captureId, {
+        url,
+        event
+      });
+      try {
+        const result = templateManager.saveUserTemplate(template, {
+          id,
+          name,
+          event: event || template.event,
+          description,
+          overwrite
+        });
+        void broadcastTemplates();
+        return res.json({
+          success: true,
+          id: result.id,
+          filePath: result.filePath,
+          template: result.template
+        });
+      } catch (error) {
+        return jsonError(res, 400, error?.message || "Failed to save template");
+      }
+    }
+  );
   return router;
 }
@@ -2475,13 +2791,10 @@ async function startDashboardServer(options = {}) {
   );
   const host = options.host || "localhost";
   const port = options.port ?? 4e3;
-  const runtimeDir = (
+  const runtimeDir = typeof __dirname !== "undefined" ? (
     // eslint-disable-next-line no-undef
-    typeof __dirname !== "undefined" ? (
-      // eslint-disable-next-line no-undef
-      __dirname
-    ) : import_path4.default.dirname((0, import_url.fileURLToPath)(import_meta.url))
-  );
+    __dirname
+  ) : import_path4.default.dirname((0, import_url.fileURLToPath)(import_meta.url));
   const { distDir: dashboardDistDir, indexHtml: dashboardIndexHtml } = resolveDashboardDistDir(runtimeDir);
   app.use(import_express2.default.static(dashboardDistDir));
   app.get("*", (req, res, next) => {
@@ -2616,8 +2929,12 @@ var dashboard = new import_commander6.Command().name("dashboard").description("S
 // src/index.ts
 var import_meta2 = {};
-var require2 = (0, import_node_module.createRequire)(import_meta2.url);
-var packageJson = require2("../package.json");
+var packageJsonPath = (0, import_node_url.fileURLToPath)(
+  new URL("../package.json", import_meta2.url)
+);
+var packageJson = JSON.parse(
+  (0, import_node_fs.readFileSync)(packageJsonPath, { encoding: "utf8" })
+);
 var program = new import_commander7.Command().name("better-webhook").description(
   "Modern CLI for developing, capturing, and replaying webhooks locally"
 ).version(packageJson.version);