@railhook/node 2.12.0

package/dist/types.d.ts

@@ -0,0 +1,293 @@
+export interface RailhookConfig {
+    apiKey: string;
+    baseUrl?: string;
+    timeout?: number;
+}
+export interface Event {
+    type: string;
+    data: Record<string, unknown>;
+}
+export interface EventResponse {
+    eventId: string;
+    type: string;
+    createdAt: string;
+    deliveriesCreated: number;
+    /**
+     * Schema-validation errors this event was accepted despite, when the project has schema
+     * validation on with the WARN policy. Absent when the payload matched or validation is off.
+     */
+    schemaWarnings?: string[];
+}
+export interface Endpoint {
+    id: string;
+    projectId: string;
+    url: string;
+    description?: string;
+    secret?: string;
+    enabled: boolean;
+    rateLimitPerSecond?: number;
+    allowedSourceIps?: string;
+    mtlsEnabled?: boolean;
+    verificationStatus?: string;
+    verificationAttemptedAt?: string;
+    verificationCompletedAt?: string;
+    verificationSkipReason?: string;
+    createdAt: string;
+    updatedAt?: string;
+}
+export interface EndpointCreateParams {
+    url: string;
+    description?: string;
+    /** Supply your own signing secret. Omit to have the API generate one. */
+    secret?: string;
+    enabled?: boolean;
+    rateLimitPerSecond?: number;
+    /** Comma-separated CIDRs the endpoint is allowed to be reached from. */
+    allowedSourceIps?: string;
+}
+export interface EndpointUpdateParams {
+    url?: string;
+    description?: string;
+    secret?: string;
+    enabled?: boolean;
+    rateLimitPerSecond?: number;
+    allowedSourceIps?: string;
+}
+export interface Subscription {
+    id: string;
+    projectId: string;
+    endpointId: string;
+    eventType: string;
+    enabled: boolean;
+    orderingEnabled: boolean;
+    maxAttempts: number;
+    timeoutSeconds: number;
+    retryDelays?: string;
+    payloadTemplate?: string;
+    customHeaders?: string;
+    transformationId?: string;
+    transformationName?: string;
+    createdAt: string;
+    updatedAt?: string;
+}
+export interface SubscriptionCreateParams {
+    endpointId: string;
+    eventType: string;
+    enabled?: boolean;
+    orderingEnabled?: boolean;
+    maxAttempts?: number;
+    timeoutSeconds?: number;
+    retryDelays?: string;
+    payloadTemplate?: string;
+    customHeaders?: string;
+    transformationId?: string;
+}
+export interface Delivery {
+    id: string;
+    eventId: string;
+    endpointId: string;
+    subscriptionId: string;
+    status: DeliveryStatus;
+    attemptCount: number;
+    maxAttempts: number;
+    nextRetryAt?: string;
+    lastAttemptAt?: string;
+    succeededAt?: string;
+    failedAt?: string;
+    createdAt: string;
+}
+export type DeliveryStatus = 'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILED' | 'DLQ';
+export interface DeliveryAttempt {
+    id: string;
+    deliveryId: string;
+    attemptNumber: number;
+    /** JSON object, serialized as a string, of the headers that were sent. */
+    requestHeaders?: string;
+    requestBody?: string;
+    httpStatusCode?: number;
+    /** JSON object, serialized as a string, of the headers that came back. */
+    responseHeaders?: string;
+    responseBody?: string;
+    errorMessage?: string;
+    /** Wall-clock duration of the HTTP request, in milliseconds. */
+    durationMs?: number;
+    /** When the attempt was recorded. */
+    createdAt: string;
+}
+export interface PaginatedResponse<T> {
+    content: T[];
+    totalElements: number;
+    totalPages: number;
+    /** Page size requested. */
+    size: number;
+    /** Zero-based index of this page. */
+    number: number;
+    numberOfElements?: number;
+    first?: boolean;
+    last?: boolean;
+    empty?: boolean;
+}
+export interface EndpointListParams {
+    page?: number;
+    size?: number;
+}
+export interface DeliveryListParams {
+    status?: DeliveryStatus;
+    endpointId?: string;
+    fromDate?: string;
+    toDate?: string;
+    page?: number;
+    size?: number;
+}
+export interface EndpointTestResult {
+    success: boolean;
+    httpStatusCode?: number;
+    responseBody?: string;
+    errorMessage?: string;
+    latencyMs: number;
+    /** Human-readable summary, e.g. "Endpoint returned non-2xx status". */
+    message?: string;
+}
+export interface RateLimitInfo {
+    limit: number;
+    remaining: number;
+    /**
+     * Unix timestamp in **seconds** at which the window resets — the raw value
+     * of the `X-RateLimit-Reset` header, which the API sends in seconds, not
+     * milliseconds.
+     */
+    reset: number;
+}
+export interface WebhookEvent {
+    eventId: string;
+    deliveryId: string;
+    timestamp: number;
+    type: string;
+    data: Record<string, unknown>;
+}
+export type ProviderType = 'GENERIC' | 'GITHUB' | 'GITLAB' | 'STRIPE' | 'SHOPIFY' | 'SLACK' | 'TWILIO';
+export type VerificationMode = 'NONE' | 'HMAC_GENERIC';
+export type IncomingSourceStatus = 'ACTIVE' | 'DISABLED';
+export type IncomingAuthType = 'NONE' | 'BEARER' | 'BASIC' | 'CUSTOM_HEADER';
+export interface IncomingSource {
+    id: string;
+    projectId: string;
+    name: string;
+    slug: string;
+    providerType: ProviderType;
+    status: IncomingSourceStatus;
+    ingressPathToken: string;
+    ingressUrl: string;
+    verificationMode: VerificationMode;
+    hmacHeaderName?: string;
+    hmacSignaturePrefix?: string;
+    hmacSecretConfigured: boolean;
+    rateLimitPerSecond?: number;
+    createdAt: string;
+    updatedAt?: string;
+}
+export interface IncomingSourceCreateParams {
+    name: string;
+    slug?: string;
+    providerType?: ProviderType;
+    verificationMode?: VerificationMode;
+    hmacSecret?: string;
+    hmacHeaderName?: string;
+    hmacSignaturePrefix?: string;
+    rateLimitPerSecond?: number;
+}
+export interface IncomingSourceUpdateParams {
+    name?: string;
+    slug?: string;
+    providerType?: ProviderType;
+    status?: IncomingSourceStatus;
+    verificationMode?: VerificationMode;
+    hmacSecret?: string;
+    hmacHeaderName?: string;
+    hmacSignaturePrefix?: string;
+    rateLimitPerSecond?: number;
+}
+export interface IncomingDestination {
+    id: string;
+    incomingSourceId: string;
+    url: string;
+    authType: IncomingAuthType;
+    authConfigured: boolean;
+    customHeadersJson?: string;
+    enabled: boolean;
+    maxAttempts: number;
+    timeoutSeconds: number;
+    retryDelays?: string;
+    payloadTransform?: string;
+    transformationId?: string;
+    transformationName?: string;
+    createdAt: string;
+    updatedAt?: string;
+}
+export interface IncomingDestinationCreateParams {
+    url: string;
+    authType?: IncomingAuthType;
+    authConfig?: string;
+    customHeadersJson?: string;
+    enabled?: boolean;
+    maxAttempts?: number;
+    timeoutSeconds?: number;
+    retryDelays?: string;
+    payloadTransform?: string;
+}
+export interface IncomingDestinationUpdateParams {
+    url?: string;
+    authType?: IncomingAuthType;
+    authConfig?: string;
+    customHeadersJson?: string;
+    enabled?: boolean;
+    maxAttempts?: number;
+    timeoutSeconds?: number;
+    retryDelays?: string;
+    payloadTransform?: string;
+}
+export interface IncomingEvent {
+    id: string;
+    incomingSourceId: string;
+    sourceName: string;
+    requestId: string;
+    method: string;
+    path: string;
+    queryParams?: string;
+    headersJson?: string;
+    bodyRaw?: string;
+    bodySha256?: string;
+    contentType?: string;
+    clientIp?: string;
+    userAgent?: string;
+    verified?: boolean;
+    verificationError?: string;
+    receivedAt: string;
+}
+export interface IncomingEventListParams {
+    sourceId?: string;
+    page?: number;
+    size?: number;
+}
+export type ForwardAttemptStatus = 'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILED' | 'DLQ';
+export interface IncomingForwardAttempt {
+    id: string;
+    incomingEventId: string;
+    destinationId: string;
+    destinationUrl: string;
+    attemptNumber: number;
+    status: ForwardAttemptStatus;
+    startedAt?: string;
+    finishedAt?: string;
+    responseCode?: number;
+    responseHeadersJson?: string;
+    responseBodySnippet?: string;
+    errorMessage?: string;
+    nextRetryAt?: string;
+    createdAt: string;
+}
+export interface ReplayEventResponse {
+    status: string;
+    eventId: string;
+    destinationsCount: number;
+}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["export interface RailhookConfig {\n  apiKey: string;\n  baseUrl?: string;\n  timeout?: number;\n}\n\nexport interface Event {\n  type: string;\n  data: Record<string, unknown>;\n}\n\nexport interface EventResponse {\n  eventId: string;\n  type: string;\n  createdAt: string;\n  deliveriesCreated: number;\n  /**\n   * Schema-validation errors this event was accepted despite, when the project has schema\n   * validation on with the WARN policy. Absent when the payload matched or validation is off.\n   */\n  schemaWarnings?: string[];\n}\n\nexport interface Endpoint {\n  id: string;\n  projectId: string;\n  url: string;\n  description?: string;\n  secret?: string;\n  enabled: boolean;\n  rateLimitPerSecond?: number;\n  allowedSourceIps?: string;\n  mtlsEnabled?: boolean;\n  verificationStatus?: string;\n  verificationAttemptedAt?: string;\n  verificationCompletedAt?: string;\n  verificationSkipReason?: string;\n  createdAt: string;\n  updatedAt?: string;\n}\n\nexport interface EndpointCreateParams {\n  url: string;\n  description?: string;\n  /** Supply your own signing secret. Omit to have the API generate one. */\n  secret?: string;\n  enabled?: boolean;\n  rateLimitPerSecond?: number;\n  /** Comma-separated CIDRs the endpoint is allowed to be reached from. */\n  allowedSourceIps?: string;\n}\n\nexport interface EndpointUpdateParams {\n  url?: string;\n  description?: string;\n  secret?: string;\n  enabled?: boolean;\n  rateLimitPerSecond?: number;\n  allowedSourceIps?: string;\n}\n\nexport interface Subscription {\n  id: string;\n  projectId: string;\n  endpointId: string;\n  eventType: string;\n  enabled: boolean;\n  orderingEnabled: boolean;\n  maxAttempts: number;\n  timeoutSeconds: number;\n  retryDelays?: string;\n  payloadTemplate?: string;\n  customHeaders?: string;\n  transformationId?: string;\n  transformationName?: string;\n  createdAt: string;\n  updatedAt?: string;\n}\n\nexport interface SubscriptionCreateParams {\n  endpointId: string;\n  eventType: string;\n  enabled?: boolean;\n  orderingEnabled?: boolean;\n  maxAttempts?: number;\n  timeoutSeconds?: number;\n  retryDelays?: string;\n  payloadTemplate?: string;\n  customHeaders?: string;\n  transformationId?: string;\n}\n\nexport interface Delivery {\n  id: string;\n  eventId: string;\n  endpointId: string;\n  subscriptionId: string;\n  status: DeliveryStatus;\n  attemptCount: number;\n  maxAttempts: number;\n  nextRetryAt?: string;\n  lastAttemptAt?: string;\n  succeededAt?: string;\n  failedAt?: string;\n  createdAt: string;\n}\n\nexport type DeliveryStatus = 'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILED' | 'DLQ';\n\nexport interface DeliveryAttempt {\n  id: string;\n  deliveryId: string;\n  attemptNumber: number;\n  /** JSON object, serialized as a string, of the headers that were sent. */\n  requestHeaders?: string;\n  requestBody?: string;\n  httpStatusCode?: number;\n  /** JSON object, serialized as a string, of the headers that came back. */\n  responseHeaders?: string;\n  responseBody?: string;\n  errorMessage?: string;\n  /** Wall-clock duration of the HTTP request, in milliseconds. */\n  durationMs?: number;\n  /** When the attempt was recorded. */\n  createdAt: string;\n}\n\nexport interface PaginatedResponse<T> {\n  content: T[];\n  totalElements: number;\n  totalPages: number;\n  /** Page size requested. */\n  size: number;\n  /** Zero-based index of this page. */\n  number: number;\n  numberOfElements?: number;\n  first?: boolean;\n  last?: boolean;\n  empty?: boolean;\n}\n\nexport interface EndpointListParams {\n  page?: number;\n  size?: number;\n}\n\nexport interface DeliveryListParams {\n  status?: DeliveryStatus;\n  endpointId?: string;\n  fromDate?: string;\n  toDate?: string;\n  page?: number;\n  size?: number;\n}\n\nexport interface EndpointTestResult {\n  success: boolean;\n  httpStatusCode?: number;\n  responseBody?: string;\n  errorMessage?: string;\n  latencyMs: number;\n  /** Human-readable summary, e.g. \"Endpoint returned non-2xx status\". */\n  message?: string;\n}\n\nexport interface RateLimitInfo {\n  limit: number;\n  remaining: number;\n  /**\n   * Unix timestamp in **seconds** at which the window resets — the raw value\n   * of the `X-RateLimit-Reset` header, which the API sends in seconds, not\n   * milliseconds.\n   */\n  reset: number;\n}\n\nexport interface WebhookEvent {\n  eventId: string;\n  deliveryId: string;\n  timestamp: number;\n  type: string;\n  data: Record<string, unknown>;\n}\n\n// ── Incoming Webhooks ──\n\nexport type ProviderType = 'GENERIC' | 'GITHUB' | 'GITLAB' | 'STRIPE' | 'SHOPIFY' | 'SLACK' | 'TWILIO';\nexport type VerificationMode = 'NONE' | 'HMAC_GENERIC';\nexport type IncomingSourceStatus = 'ACTIVE' | 'DISABLED';\nexport type IncomingAuthType = 'NONE' | 'BEARER' | 'BASIC' | 'CUSTOM_HEADER';\n\nexport interface IncomingSource {\n  id: string;\n  projectId: string;\n  name: string;\n  slug: string;\n  providerType: ProviderType;\n  status: IncomingSourceStatus;\n  ingressPathToken: string;\n  ingressUrl: string;\n  verificationMode: VerificationMode;\n  hmacHeaderName?: string;\n  hmacSignaturePrefix?: string;\n  hmacSecretConfigured: boolean;\n  rateLimitPerSecond?: number;\n  createdAt: string;\n  updatedAt?: string;\n}\n\nexport interface IncomingSourceCreateParams {\n  name: string;\n  slug?: string;\n  providerType?: ProviderType;\n  verificationMode?: VerificationMode;\n  hmacSecret?: string;\n  hmacHeaderName?: string;\n  hmacSignaturePrefix?: string;\n  rateLimitPerSecond?: number;\n}\n\nexport interface IncomingSourceUpdateParams {\n  name?: string;\n  slug?: string;\n  providerType?: ProviderType;\n  status?: IncomingSourceStatus;\n  verificationMode?: VerificationMode;\n  hmacSecret?: string;\n  hmacHeaderName?: string;\n  hmacSignaturePrefix?: string;\n  rateLimitPerSecond?: number;\n}\n\nexport interface IncomingDestination {\n  id: string;\n  incomingSourceId: string;\n  url: string;\n  authType: IncomingAuthType;\n  authConfigured: boolean;\n  customHeadersJson?: string;\n  enabled: boolean;\n  maxAttempts: number;\n  timeoutSeconds: number;\n  retryDelays?: string;\n  payloadTransform?: string;\n  transformationId?: string;\n  transformationName?: string;\n  createdAt: string;\n  updatedAt?: string;\n}\n\nexport interface IncomingDestinationCreateParams {\n  url: string;\n  authType?: IncomingAuthType;\n  authConfig?: string;\n  customHeadersJson?: string;\n  enabled?: boolean;\n  maxAttempts?: number;\n  timeoutSeconds?: number;\n  retryDelays?: string;\n  payloadTransform?: string;\n}\n\nexport interface IncomingDestinationUpdateParams {\n  url?: string;\n  authType?: IncomingAuthType;\n  authConfig?: string;\n  customHeadersJson?: string;\n  enabled?: boolean;\n  maxAttempts?: number;\n  timeoutSeconds?: number;\n  retryDelays?: string;\n  payloadTransform?: string;\n}\n\nexport interface IncomingEvent {\n  id: string;\n  incomingSourceId: string;\n  sourceName: string;\n  requestId: string;\n  method: string;\n  path: string;\n  queryParams?: string;\n  headersJson?: string;\n  bodyRaw?: string;\n  bodySha256?: string;\n  contentType?: string;\n  clientIp?: string;\n  userAgent?: string;\n  verified?: boolean;\n  verificationError?: string;\n  receivedAt: string;\n}\n\nexport interface IncomingEventListParams {\n  sourceId?: string;\n  page?: number;\n  size?: number;\n}\n\nexport type ForwardAttemptStatus = 'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILED' | 'DLQ';\n\nexport interface IncomingForwardAttempt {\n  id: string;\n  incomingEventId: string;\n  destinationId: string;\n  destinationUrl: string;\n  attemptNumber: number;\n  status: ForwardAttemptStatus;\n  startedAt?: string;\n  finishedAt?: string;\n  responseCode?: number;\n  responseHeadersJson?: string;\n  responseBodySnippet?: string;\n  errorMessage?: string;\n  nextRetryAt?: string;\n  createdAt: string;\n}\n\nexport interface ReplayEventResponse {\n  status: string;\n  eventId: string;\n  destinationsCount: number;\n}\n"]}

package/dist/webhooks.d.ts

@@ -0,0 +1,83 @@
+import { WebhookEvent } from './types';
+export interface WebhookHeaders {
+    'x-signature'?: string;
+    'x-timestamp'?: string;
+    'x-event-id'?: string;
+    'x-delivery-id'?: string;
+    [key: string]: string | undefined;
+}
+export interface VerifyOptions {
+    tolerance?: number;
+}
+/**
+ * Verifies the webhook signature using HMAC-SHA256.
+ *
+ * The header is `t=<unix-ms>,v1=<hex>`, and it may carry **more than one** `v1`.
+ * After you rotate an endpoint's secret, Railhook signs each delivery with both
+ * the new secret and the retired one for the endpoint's grace window (24 hours
+ * by default), so you can deploy the new secret whenever you like instead of at
+ * the instant you press rotate. The delivery is authentic if *any* `v1` matches,
+ * which is what this checks.
+ *
+ * @param payload - Raw request body as string
+ * @param signature - X-Signature header value (format: t=timestamp,v1=signature[,v1=...])
+ * @param secret - Endpoint webhook secret
+ * @param options - Verification options
+ * @returns true if signature is valid
+ * @throws RailhookError if signature is invalid
+ */
+export declare function verifySignature(payload: string, signature: string, secret: string, options?: VerifyOptions): boolean;
+/**
+ * Verifies the [Standard Webhooks](https://www.standardwebhooks.com) headers.
+ *
+ * Endpoints receive both header sets by default (`signatureScheme: 'BOTH'`), so use
+ * whichever you prefer — this one if you would rather your verification match what other
+ * providers send, `verifySignature` if you are already verifying `X-Signature`.
+ *
+ * Two things differ from Railhook's own scheme beyond the header names: the message id is
+ * part of what is signed, and the digest is base64 rather than hex. Rotation works the same
+ * way — during the grace window the header carries a space-separated signature per valid
+ * secret, and any one matching is enough.
+ *
+ * @param payload - Raw request body as string
+ * @param headers - Request headers, including the three `webhook-*` ones
+ * @param secret - The endpoint's `standardWebhooksSecret` (`whsec_…`), not the raw secret.
+ *                 A plain secret is accepted too and used as-is.
+ * @returns true if the signature is valid
+ * @throws RailhookError if it is not
+ */
+export declare function verifyStandardWebhook(payload: string, headers: WebhookHeaders, secret: string, options?: {
+    toleranceSeconds?: number;
+}): boolean;
+/**
+ * Constructs a webhook event from the request.
+ *
+ * What Railhook actually PUTs on the wire is the event's **payload**, not an
+ * envelope: a `client.events.send({ type: 'order.completed', data: {...} })`
+ * arrives at your endpoint as the `data` object alone, with the identifiers
+ * carried in headers (`X-Event-Id`, `X-Delivery-Id`, `X-Timestamp`,
+ * `X-Sequence-Number`). So:
+ *
+ * - `eventId` / `deliveryId` / `timestamp` come from the headers and are
+ *   always populated for a real delivery.
+ * - `data` is the parsed body.
+ * - `type` is only populated when the body happens to carry a `type` key —
+ *   which for a default subscription it does not. Route on the payload, or
+ *   configure the subscription's `payloadTemplate` to wrap the event so that
+ *   `type` is part of the body.
+ *
+ * @param payload - Raw request body as string
+ * @param headers - Request headers
+ * @param secret - Endpoint webhook secret
+ * @param options - Verification options
+ * @returns Parsed and verified webhook event
+ */
+export declare function constructEvent(payload: string, headers: WebhookHeaders, secret: string, options?: VerifyOptions): WebhookEvent;
+/**
+ * Generates a signature for testing purposes
+ * @param payload - Request body as string
+ * @param secret - Webhook secret
+ * @param timestamp - Optional timestamp (defaults to now)
+ * @returns Signature string in format t=timestamp,v1=signature
+ */
+export declare function generateSignature(payload: string, secret: string, timestamp?: number): string;