@k-msg/webhook 0.19.0 → 0.20.0

package/dist/runtime/endpoint-validation.d.ts

@@ -0,0 +1,8 @@
+import type { WebhookRuntimeSecurityOptions } from "./types";
+export interface EndpointValidationOptions {
+    allowPrivateHosts: boolean;
+    allowHttpForLocalhost: boolean;
+}
+export declare const DEFAULT_ENDPOINT_VALIDATION_OPTIONS: EndpointValidationOptions;
+export declare function resolveEndpointValidationOptions(security: WebhookRuntimeSecurityOptions | undefined): EndpointValidationOptions;
+export declare function validateEndpointUrl(rawUrl: string, options?: EndpointValidationOptions): URL;

package/dist/runtime/event-matcher.d.ts

@@ -0,0 +1,2 @@
+import type { WebhookEndpoint, WebhookEvent } from "../types/webhook.types";
+export declare function endpointMatchesEvent(endpoint: WebhookEndpoint, event: WebhookEvent): boolean;

package/dist/runtime/persistence.d.ts

@@ -0,0 +1,16 @@
+import type { WebhookDelivery, WebhookEndpoint } from "../types/webhook.types";
+import type { WebhookDeliveryListOptions, WebhookDeliveryStore, WebhookEndpointStore, WebhookPersistence } from "./types";
+export declare class InMemoryWebhookEndpointStore implements WebhookEndpointStore {
+    private readonly endpoints;
+    add(endpoint: WebhookEndpoint): Promise<void>;
+    update(endpointId: string, endpoint: WebhookEndpoint): Promise<void>;
+    remove(endpointId: string): Promise<void>;
+    get(endpointId: string): Promise<WebhookEndpoint | null>;
+    list(): Promise<WebhookEndpoint[]>;
+}
+export declare class InMemoryWebhookDeliveryStore implements WebhookDeliveryStore {
+    private readonly deliveries;
+    add(delivery: WebhookDelivery): Promise<void>;
+    list(options?: WebhookDeliveryListOptions): Promise<WebhookDelivery[]>;
+}
+export declare function createInMemoryWebhookPersistence(): WebhookPersistence;

package/dist/runtime/types.d.ts

@@ -0,0 +1,60 @@
+import type { HttpClient } from "../services/webhook.dispatcher";
+import type { WebhookConfig, WebhookDelivery, WebhookEndpoint, WebhookEvent, WebhookTestResult } from "../types/webhook.types";
+export interface WebhookDeliveryListOptions {
+    endpointId?: string;
+    eventType?: WebhookEvent["type"];
+    status?: WebhookDelivery["status"];
+    limit?: number;
+}
+export interface WebhookEndpointStore {
+    add(endpoint: WebhookEndpoint): Promise<void>;
+    update(endpointId: string, endpoint: WebhookEndpoint): Promise<void>;
+    remove(endpointId: string): Promise<void>;
+    get(endpointId: string): Promise<WebhookEndpoint | null>;
+    list(): Promise<WebhookEndpoint[]>;
+}
+export interface WebhookDeliveryStore {
+    add(delivery: WebhookDelivery): Promise<void>;
+    list(options?: WebhookDeliveryListOptions): Promise<WebhookDelivery[]>;
+}
+export interface WebhookPersistence {
+    endpointStore: WebhookEndpointStore;
+    deliveryStore: WebhookDeliveryStore;
+    init?(): Promise<void>;
+    close?(): Promise<void>;
+}
+export interface WebhookRuntimeSecurityOptions {
+    allowPrivateHosts?: boolean;
+    allowHttpForLocalhost?: boolean;
+}
+export type WebhookEndpointInput = Omit<WebhookEndpoint, "id" | "createdAt" | "updatedAt" | "status"> & {
+    id?: string;
+    status?: WebhookEndpoint["status"];
+};
+export interface WebhookRuntimeConfig {
+    delivery: WebhookConfig;
+    persistence?: WebhookPersistence;
+    endpointStore?: WebhookEndpointStore;
+    deliveryStore?: WebhookDeliveryStore;
+    httpClient?: HttpClient;
+    security?: WebhookRuntimeSecurityOptions;
+    autoStart?: boolean;
+}
+export interface WebhookRuntimeTestPayload {
+    endpointId: string;
+    event?: Partial<WebhookEvent>;
+}
+export interface WebhookRuntime {
+    addEndpoint(input: WebhookEndpointInput): Promise<WebhookEndpoint>;
+    addEndpoints(inputs: readonly WebhookEndpointInput[]): Promise<WebhookEndpoint[]>;
+    updateEndpoint(endpointId: string, updates: Partial<WebhookEndpointInput>): Promise<WebhookEndpoint>;
+    removeEndpoint(endpointId: string): Promise<void>;
+    getEndpoint(endpointId: string): Promise<WebhookEndpoint | null>;
+    listEndpoints(): Promise<WebhookEndpoint[]>;
+    probeEndpoint(input: string | WebhookRuntimeTestPayload): Promise<WebhookTestResult>;
+    emit(event: WebhookEvent): Promise<void>;
+    emitSync(event: WebhookEvent): Promise<WebhookDelivery[]>;
+    flush(): Promise<void>;
+    listDeliveries(options?: WebhookDeliveryListOptions): Promise<WebhookDelivery[]>;
+    shutdown(): Promise<void>;
+}

package/dist/runtime/webhook-runtime.service.d.ts

@@ -0,0 +1,41 @@
+import { type HttpClient } from "../services/webhook.dispatcher";
+import { type WebhookDelivery, type WebhookEndpoint, type WebhookEvent, type WebhookTestResult } from "../types/webhook.types";
+import { resolveEndpointValidationOptions } from "./endpoint-validation";
+import type { WebhookDeliveryListOptions, WebhookEndpointInput, WebhookRuntime, WebhookRuntimeConfig, WebhookRuntimeSecurityOptions, WebhookRuntimeTestPayload } from "./types";
+export declare class WebhookRuntimeService implements WebhookRuntime {
+    private readonly config;
+    private readonly dispatcher;
+    private readonly endpointStore;
+    private readonly deliveryStore;
+    private readonly securityOptions;
+    private readonly persistence;
+    private readonly eventQueue;
+    private batchProcessor;
+    private initPromise;
+    private processing;
+    constructor(config: WebhookRuntimeConfig);
+    addEndpoint(input: WebhookEndpointInput): Promise<WebhookEndpoint>;
+    addEndpoints(inputs: readonly WebhookEndpointInput[]): Promise<WebhookEndpoint[]>;
+    updateEndpoint(endpointId: string, updates: Partial<WebhookEndpointInput>): Promise<WebhookEndpoint>;
+    removeEndpoint(endpointId: string): Promise<void>;
+    getEndpoint(endpointId: string): Promise<WebhookEndpoint | null>;
+    listEndpoints(): Promise<WebhookEndpoint[]>;
+    probeEndpoint(input: string | WebhookRuntimeTestPayload): Promise<WebhookTestResult>;
+    emit(event: WebhookEvent): Promise<void>;
+    emitSync(event: WebhookEvent): Promise<WebhookDelivery[]>;
+    flush(): Promise<void>;
+    listDeliveries(options?: WebhookDeliveryListOptions): Promise<WebhookDelivery[]>;
+    shutdown(): Promise<void>;
+    private resolvePersistence;
+    private ensureInitialized;
+    private validateEvent;
+    private processBatch;
+    private getMatchingEndpoints;
+    private createProbeEvent;
+    private generateEndpointId;
+    private startBatchProcessor;
+}
+export declare function probeEndpoint(runtime: WebhookRuntimeService, input: string | WebhookRuntimeTestPayload): Promise<WebhookTestResult>;
+export declare function addEndpoints(runtime: WebhookRuntimeService, inputs: readonly WebhookEndpointInput[]): Promise<WebhookEndpoint[]>;
+export declare function resolveWebhookSecurityOptions(security: WebhookRuntimeSecurityOptions | undefined): ReturnType<typeof resolveEndpointValidationOptions>;
+export type { HttpClient };

package/dist/services/webhook.dispatcher.d.ts

@@ -3,12 +3,14 @@ export interface HttpClient {
     fetch(url: string, options: RequestInit): Promise<Response>;
 }
 export declare class DefaultHttpClient implements HttpClient {
-    fetch(url: string, options: RequestInit): Promise<Response>;
+    fetch(url: string, _options: RequestInit): Promise<Response>;
 }
 export declare class MockHttpClient implements HttpClient {
     private responses;
+    private defaultResponse;
     setMockResponse(url: string, response: Response): void;
-    fetch(url: string, options: RequestInit): Promise<Response>;
+    setDefaultResponse(response: Response): void;
+    fetch(url: string, _options: RequestInit): Promise<Response>;
 }
 export declare class WebhookDispatcher {
     private config;

package/dist/toolkit/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Toolkit APIs (advanced building blocks)
+ */
+export { BatchDispatcher } from "../dispatcher/batch.dispatcher";
+export { LoadBalancer } from "../dispatcher/load-balancer";
+export { QueueManager } from "../dispatcher/queue.manager";
+export type { BatchConfig, CircuitBreakerState, DispatchConfig, DispatchJob, LoadBalancerConfig, QueueConfig, } from "../dispatcher/types";
+export { DeliveryStore } from "../registry/delivery.store";
+export { EndpointManager } from "../registry/endpoint.manager";
+export { EventStore } from "../registry/event.store";
+export type { DeliveryFilter, EndpointFilter, EventFilter, PaginationOptions, SearchResult, StorageConfig, } from "../registry/types";
+export { RetryManager } from "../retry/retry.manager";
+export { SecurityManager } from "../security/security.manager";
+export { DefaultHttpClient, type HttpClient, MockHttpClient, WebhookDispatcher, } from "../services/webhook.dispatcher";
+export { WebhookRegistry } from "../services/webhook.registry";
+export type { FileStorageAdapter } from "../shared/file-storage";