@checkstack/integration-webhook-backend 0.0.34 → 0.1.0

package/src/provider.ts

@@ -1,347 +0,0 @@
-import { z } from "zod";
-import {
-  Versioned,
-  configNumber,
-  configString,
-  requestTimeoutMs,
-} from "@checkstack/backend-api";
-import type {
-  IntegrationProvider,
-  IntegrationDeliveryContext,
-  IntegrationDeliveryResult,
-} from "@checkstack/integration-backend";
-import { extractErrorMessage } from "@checkstack/common";
-
-// =============================================================================
-// Template Expansion Helper
-// =============================================================================
-
-/**
- * Expand mustache-style templates with context values.
- * Supports {{path.to.value}} syntax with nested object access.
- */
-function expandTemplate(
-  template: string,
-  context: Record<string, unknown>,
-): string {
-  return template.replaceAll(/\{\{([^}]+)\}\}/g, (_match, path: string) => {
-    const trimmedPath = path.trim();
-    const parts = trimmedPath.split(".");
-
-    let value: unknown = context;
-    for (const part of parts) {
-      if (value === null || value === undefined) {
-        return "";
-      }
-      value = (value as Record<string, unknown>)[part];
-    }
-
-    // Return JSON stringified for objects/arrays, raw string for primitives
-    if (value === null || value === undefined) {
-      return "";
-    }
-    if (typeof value === "object") {
-      return JSON.stringify(value);
-    }
-    return String(value);
-  });
-}
-
-// =============================================================================
-// Webhook Configuration Schema
-// =============================================================================
-
-/**
- * Header configuration for custom HTTP headers.
- */
-const webhookHeaderSchema = z.object({
-  name: z.string().min(1).describe("Header name"),
-  value: z.string().describe("Header value"),
-});
-
-/**
- * Webhook provider configuration schema.
- * Supports various authentication methods and customization options.
- */
-export const webhookConfigSchemaV1 = z.object({
-  url: configString({})
-    .url()
-    .describe("The webhook endpoint URL to send events to"),
-  method: z
-    .enum(["POST", "PUT", "PATCH"])
-    .default("POST")
-    .describe("HTTP method to use"),
-  contentType: z
-    .enum(["application/json", "application/x-www-form-urlencoded"])
-    .default("application/json")
-    .describe("Content-Type header for the request"),
-
-  // Authentication
-  authType: z
-    .enum(["none", "bearer", "basic", "header"])
-    .default("none")
-    .describe("Authentication method"),
-  bearerToken: configString({ "x-secret": true })
-    .describe("Bearer token for authentication")
-    .optional(),
-  basicUsername: configString({})
-    .optional()
-    .describe("Username for Basic auth"),
-  basicPassword: configString({ "x-secret": true })
-    .describe("Password for Basic auth")
-    .optional(),
-  authHeaderName: configString({})
-    .optional()
-    .describe("Custom header name for token auth (e.g., X-API-Key)"),
-  authHeaderValue: configString({ "x-secret": true })
-    .describe("Custom header value")
-    .optional(),
-
-  // Additional options
-  customHeaders: z
-    .array(webhookHeaderSchema)
-    .optional()
-    .describe("Additional custom headers to include"),
-
-  /** Custom body template. Use {{payload.field}} syntax for templating. */
-  bodyTemplate: configString({
-    "x-editor-types": ["raw", "json", "yaml", "xml", "formdata"],
-  })
-    .optional()
-    .describe(
-      "Custom request body template. Use {{payload.field}} syntax to include event data. Leave empty for default JSON payload.",
-    ),
-
-  timeout: requestTimeoutMs().describe("Request timeout in milliseconds"),
-  retryOnStatus: z
-    .array(configNumber({}))
-    .optional()
-    .describe("HTTP status codes that should trigger a retry (e.g., 429, 503)"),
-});
-
-export type WebhookConfig = z.infer<typeof webhookConfigSchemaV1>;
-
-// =============================================================================
-// Webhook Provider Implementation
-// =============================================================================
-
-/**
- * Webhook integration provider.
- * Delivers events as HTTP POST requests to configured endpoints.
- */
-export const webhookProvider: IntegrationProvider<WebhookConfig> = {
-  id: "webhook",
-  displayName: "Webhook",
-  description: "Deliver events via HTTP POST to external endpoints",
-  icon: "Webhook",
-
-  config: new Versioned({
-    version: 1,
-    schema: webhookConfigSchemaV1,
-  }),
-
-  documentation: {
-    setupGuide: `Your endpoint will receive HTTP POST requests with JSON payloads.
-
-Configure your server to:
-1. Accept POST requests at your configured URL
-2. Return a 2xx status code on success
-3. Optionally return a JSON response with an \`id\` field for tracking`,
-    examplePayload: JSON.stringify(
-      {
-        id: "del_abc123",
-        eventType: "incident.created",
-        timestamp: "2024-01-15T10:30:00.000Z",
-        subscription: {
-          id: "sub_xyz",
-          name: "My Webhook",
-        },
-        data: {
-          incidentId: "inc_123",
-          title: "API degraded performance",
-          severity: "warning",
-        },
-      },
-       
-      null,
-      2,
-    ),
-    headers: [
-      {
-        name: "Content-Type",
-        description: "application/json (or application/x-www-form-urlencoded)",
-      },
-      {
-        name: "X-Delivery-Id",
-        description: "Unique ID for this delivery attempt",
-      },
-      {
-        name: "X-Event-Type",
-        description: "The event type (e.g., incident.created)",
-      },
-      { name: "User-Agent", description: "Checkstack-Integration/1.0" },
-    ],
-  },
-
-  async deliver(
-    context: IntegrationDeliveryContext<WebhookConfig>,
-  ): Promise<IntegrationDeliveryResult> {
-    const { event, subscription, providerConfig, logger } = context;
-
-    // Validate config
-    const config = webhookConfigSchemaV1.parse(providerConfig);
-
-    // Build template context for all template-able fields
-    const templateContext = {
-      deliveryId: event.deliveryId,
-      eventType: event.eventId,
-      eventId: event.eventId,
-      timestamp: event.timestamp,
-      subscriptionId: subscription.id,
-      subscriptionName: subscription.name,
-      payload: event.payload,
-    };
-
-    // Expand URL template if it contains template syntax
-    const url = expandTemplate(config.url, templateContext);
-
-    // Build headers
-    const headers: Record<string, string> = {
-      "Content-Type": config.contentType,
-      "User-Agent": "Checkstack-Integration/1.0",
-      "X-Delivery-Id": event.deliveryId,
-      "X-Event-Type": event.eventId,
-    };
-
-    // Add authentication headers
-    switch (config.authType) {
-      case "bearer": {
-        if (config.bearerToken) {
-          headers["Authorization"] = `Bearer ${config.bearerToken}`;
-        }
-        break;
-      }
-      case "basic": {
-        if (config.basicUsername && config.basicPassword) {
-          const credentials = Buffer.from(
-            `${config.basicUsername}:${config.basicPassword}`,
-          ).toString("base64");
-          headers["Authorization"] = `Basic ${credentials}`;
-        }
-        break;
-      }
-      case "header": {
-        if (config.authHeaderName && config.authHeaderValue) {
-          headers[config.authHeaderName] = config.authHeaderValue;
-        }
-        break;
-      }
-    }
-
-    // Add custom headers (with template expansion)
-    if (config.customHeaders) {
-      for (const header of config.customHeaders) {
-        headers[header.name] = expandTemplate(header.value, templateContext);
-      }
-    }
-
-    // Build request body
-    let body: string;
-
-    if (config.bodyTemplate) {
-      // Use custom template with context
-      body = expandTemplate(config.bodyTemplate, templateContext);
-    } else {
-      // Default payload format
-      const payload = {
-        id: event.deliveryId,
-        eventType: event.eventId,
-        timestamp: event.timestamp,
-        subscription: {
-          id: subscription.id,
-          name: subscription.name,
-        },
-        data: event.payload,
-      };
-
-      body =
-        config.contentType === "application/json"
-          ? JSON.stringify(payload)
-          : new URLSearchParams({
-              payload: JSON.stringify(payload),
-            }).toString();
-    }
-
-    logger.debug(`Delivering webhook to ${url} for event ${event.eventId}`);
-
-    try {
-      const response = await fetch(url, {
-        method: config.method,
-        headers,
-        body,
-        signal: AbortSignal.timeout(config.timeout),
-      });
-
-      const responseText = await response.text();
-
-      // Check if we should retry based on status code
-      if (config.retryOnStatus?.includes(response.status)) {
-        // Check for Retry-After header
-        const retryAfter = response.headers.get("Retry-After");
-        const retryAfterMs = retryAfter
-          ? Number.parseInt(retryAfter, 10) * 1000
-          : 30_000;
-
-        return {
-          success: false,
-          error: `Received status ${response.status} (retryable)`,
-          retryAfterMs,
-        };
-      }
-
-      if (!response.ok) {
-        return {
-          success: false,
-          error: `HTTP ${response.status}: ${responseText.slice(0, 200)}`,
-        };
-      }
-
-      logger.debug(`Webhook delivered successfully: ${response.status}`);
-
-      // Try to extract external ID from response
-      let externalId: string | undefined;
-      try {
-        const json = JSON.parse(responseText);
-        externalId = json.id ?? json.externalId ?? json.messageId;
-      } catch {
-        // Response wasn't JSON, that's fine
-      }
-
-      return {
-        success: true,
-        externalId,
-      };
-    } catch (error) {
-      const message = extractErrorMessage(error);
-      logger.error(`Webhook delivery failed: ${message}`);
-
-      // Network errors should trigger retry
-      if (
-        message.includes("timeout") ||
-        message.includes("ECONNREFUSED") ||
-        message.includes("ENOTFOUND")
-      ) {
-        return {
-          success: false,
-          error: message,
-          retryAfterMs: 30_000,
-        };
-      }
-
-      return {
-        success: false,
-        error: message,
-      };
-    }
-  },
-};