@frontmcp/testing 1.11.3 → 1.12.0-rc.1

package/webhook/webhook-receiver.d.ts

@@ -0,0 +1,85 @@
+import { type EventWebhookReceiver } from '@frontmcp/sdk';
+import type { WebhookSignatureCheck } from '@frontmcp/utils';
+export interface WebhookReceiverOptions {
+    /**
+     * The secrets deliveries of any subscription are signed with. A request none of them signed is answered 401. Without
+     * any, and without a secret an events client registered, nothing is checked.
+     */
+    secrets?: string[];
+    /** The path prefixes the well-known document declares. Without any, the document is a 404 and the challenge is used. */
+    receivers?: string[];
+    /** The path deliveries are sent to. @default '/hooks/mcp' */
+    path?: string;
+    /** @default an ephemeral port */
+    port?: number;
+}
+export interface WebhookReceiverInfo {
+    /** The callback URL to subscribe with. */
+    url: string;
+    origin: string;
+    port: number;
+}
+export type ReceivedWebhookKind = 'verification' | 'gap' | 'terminated' | 'event';
+export interface ReceivedWebhook {
+    kind: ReceivedWebhookKind;
+    path: string;
+    /** The body exactly as it arrived: the bytes the signature covers. */
+    body: string;
+    /** The body as JSON, or undefined when it is not JSON. */
+    json: Record<string, unknown> | undefined;
+    webhookId?: string;
+    webhookTimestamp?: string;
+    webhookSignature?: string;
+    subscriptionId?: string;
+    /** `unchecked` when the receiver has no secret for the request's subscription. */
+    signatureCheck: WebhookSignatureCheck | 'unchecked';
+    /** The status the receiver answered with. */
+    answeredStatus: number;
+    receivedAt: number;
+}
+/** An HTTP server on 127.0.0.1 that stands in for the callback of a webhook subscription. */
+export declare class WebhookReceiver {
+    private readonly options;
+    private readonly events;
+    private readonly received;
+    private server;
+    private info;
+    private failuresLeft;
+    private failureStatus;
+    private echoesChallenges;
+    /** A receiver that is not listening yet. */
+    constructor(options?: WebhookReceiverOptions);
+    /** The SDK receiver behind it, for `withEvents({ webhook: { url, receiver } })` of an events client. */
+    get eventReceiver(): EventWebhookReceiver;
+    /** Listen on 127.0.0.1 and answer with the callback URL. */
+    start(): Promise<WebhookReceiverInfo>;
+    /** Stop listening. */
+    stop(): Promise<void>;
+    /** The callback URL; the receiver must be started. */
+    get url(): string;
+    /** Every request received, oldest first. */
+    get requests(): readonly ReceivedWebhook[];
+    /** The verification challenges received. */
+    verifications(): ReceivedWebhook[];
+    /** The event deliveries received, retries included. */
+    deliveries(): ReceivedWebhook[];
+    /** Forget the requests received so far. */
+    clear(): void;
+    /** Accept deliveries signed with one more secret, as after a rotation. */
+    addSecret(secret: string): void;
+    /** Answer the next `count` deliveries with `status` instead of 200. Verification challenges are not affected. */
+    failNext(count: number, status?: number): void;
+    /** Whether a verification challenge is echoed (the default) or answered with an empty object. */
+    echoChallenges(echo: boolean): void;
+    /** Resolve once `count` event deliveries arrived, retries included; reject after `timeoutMs`. */
+    waitForDeliveries(count: number, timeoutMs?: number): Promise<ReceivedWebhook[]>;
+    /** Answer one request: the well-known document, or a webhook that is checked, recorded and answered. */
+    private handle;
+    /** The answer to a webhook: unchecked without secrets, a pending failure for a signed delivery, else the SDK's. */
+    private answer;
+    /** Serve the well-known document when the receiver declares path prefixes. */
+    private answerWellKnown;
+    /** The status of the next delivery: a pending failure, else 200. */
+    private nextDeliveryStatus;
+}
+//# sourceMappingURL=webhook-receiver.d.ts.map

package/webhook/webhook-receiver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-receiver.d.ts","sourceRoot":"","sources":["../../src/webhook/webhook-receiver.ts"],"names":[],"mappings":"AAiBA,OAAO,EAA8B,KAAK,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACtF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAM7D,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,wHAAwH;IACxH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,0CAA0C;IAC1C,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG,KAAK,GAAG,YAAY,GAAG,OAAO,CAAC;AAElF,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,mBAAmB,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,sEAAsE;IACtE,IAAI,EAAE,MAAM,CAAC;IACb,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,kFAAkF;IAClF,cAAc,EAAE,qBAAqB,GAAG,WAAW,CAAC;IACpD,6CAA6C;IAC7C,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;CACpB;AAkCD,6FAA6F;AAC7F,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IACjD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAuB;IAC9C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAyB;IAClD,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,IAAI,CAAkC;IAC9C,OAAO,CAAC,YAAY,CAAK;IACzB,OAAO,CAAC,aAAa,CAAO;IAC5B,OAAO,CAAC,gBAAgB,CAAQ;IAEhC,4CAA4C;gBAChC,OAAO,GAAE,sBAA2B;IAKhD,wGAAwG;IACxG,IAAI,aAAa,IAAI,oBAAoB,CAExC;IAED,4DAA4D;IACtD,KAAK,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAY3C,sBAAsB;IAChB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAO3B,sDAAsD;IACtD,IAAI,GAAG,IAAI,MAAM,CAGhB;IAED,4CAA4C;IAC5C,IAAI,QAAQ,IAAI,SAAS,eAAe,EAAE,CAEzC;IAED,4CAA4C;IAC5C,aAAa,IAAI,eAAe,EAAE;IAIlC,uDAAuD;IACvD,UAAU,IAAI,eAAe,EAAE;IAI/B,2CAA2C;IAC3C,KAAK,IAAI,IAAI;IAIb,0EAA0E;IAC1E,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAI/B,iHAAiH;IACjH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,SAAM,GAAG,IAAI;IAK3C,iGAAiG;IACjG,cAAc,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI;IAInC,iGAAiG;IAC3F,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,SAAO,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAapF,wGAAwG;YAC1F,MAAM;IAgCpB,mHAAmH;YACrG,MAAM;IAqBpB,8EAA8E;IAC9E,OAAO,CAAC,eAAe;IAUvB,oEAAoE;IACpE,OAAO,CAAC,kBAAkB;CAK3B"}