@adminiumjs/add-on-contracts 0.3.30 → 0.3.32

package/dist/payment-provider.d.ts

@@ -0,0 +1,605 @@
+/**
+ * `payment-provider@1` — one payment service, online payments only.
+ *
+ * ─── WHAT IT IS FOR ────────────────────────────────────────────────────────
+ *
+ * A shop's customer pays on the provider's own hosted page; Adminium never
+ * sees a card. The provider half answers a small set of questions about money
+ * that moves at the provider: start a checkout, say how one ended, end one,
+ * refund, prove a webhook came from the provider, list the events whose webhook
+ * went missing, and say which ways to pay the account has switched on.
+ * In-person terminals will be a contract of their own when they are built.
+ *
+ * ─── THE SHAPE ─────────────────────────────────────────────────────────────
+ *
+ * The server half exports a FACTORY, `createPaymentProvider({ http, credentials,
+ * mode })`. The engine calls it for every operation with an egress-bound HTTP
+ * client (the add-on's `network.allow` only, redirects refused) and the
+ * credential decrypted at that moment, so no key is held longer than one call
+ * and a replaced key is used at once.
+ *
+ * Every answer is DATA. A refusal is `{ ok: false, code, providerMessage,
+ * retryable }`, never a thrown class: a class does not cross the add-on seam
+ * (each bundle carries its own copy, so `instanceof` is false engine-side).
+ * The engine parses every answer with the schemas below before it believes it.
+ *
+ * ─── RULES EVERY PROVIDER FOLLOWS (the conformance suite checks them) ──────
+ *
+ * - Amounts cross as decimal strings. `toMinor` converts with the provider's
+ *   OWN exponent table; an amount the provider cannot represent exactly is
+ *   refused (`AMOUNT_UNREPRESENTABLE`), never rounded.
+ * - Every call that moves money carries an idempotency key Adminium mints and
+ *   stores. The key is the second line of defence: Adminium's own state
+ *   decides whether money may move.
+ * - A webhook proves only that the provider sent it. `verifyWebhook` returns
+ *   the event's identity, never a status to trust: the engine re-reads the
+ *   status with `status()`.
+ * - No secret appears in an answer, a `providerMessage` or a log line.
+ * - The provider half never reads or writes a database. In-process this is a
+ *   review rule, not something the runtime can enforce.
+ */
+import { z } from 'zod';
+export declare const PAYMENT_PROVIDER_CONTRACT = "payment-provider";
+export declare const PAYMENT_PROVIDER_VERSION = 1;
+/** The name of the factory a server half must export. */
+export declare const PAYMENT_PROVIDER_FACTORY = "createPaymentProvider";
+/**
+ * The name of an OPTIONAL second export of the server half: the event types
+ * the admin ticks when making the webhook at the provider, in the provider's
+ * own spelling (`checkout.session.completed`, `PAYMENT.CAPTURE.COMPLETED`).
+ * Studio lists them beside the webhook address with a copy button each, so
+ * the admin ticks exactly what the provider half listens for. A server half
+ * without it gets a webhook card with no list.
+ */
+export declare const PAYMENT_WEBHOOK_EVENTS_EXPORT = "webhookEvents";
+/**
+ * The name of an OPTIONAL export of the server half for a provider whose key is
+ * made by an app the shop uploads to its own account (Stripe's private app):
+ * `(input: { shopName: string; installId: string }) => { appId: string;
+ * appName: string; files: Record<string, string> }`. Studio's "Download the
+ * app template" calls it with a per-install id and zips the files it answers.
+ */
+export declare const PAYMENT_KEY_APP_EXPORT = "keyAppTemplate";
+/** A key belongs to one mode; so does every checkout, event and refund made with it. */
+export declare const PAYMENT_MODES: readonly ["test", "live"];
+export type PaymentMode = (typeof PAYMENT_MODES)[number];
+/**
+ * How a checkout stands at the provider.
+ *
+ * `processing`: the money is on its way but not there (SEPA, a voucher, a
+ * pending capture). `requires_action`: the customer still has a step to take.
+ */
+export declare const CHECKOUT_STATUSES: readonly ["pending", "processing", "succeeded", "failed", "cancelled", "expired", "requires_action"];
+export type CheckoutStatus = (typeof CHECKOUT_STATUSES)[number];
+/** How a refund stands. `requires_action`: the customer must give bank details. */
+export declare const REFUND_STATUSES: readonly ["pending", "succeeded", "failed", "cancelled", "requires_action"];
+export type RefundStatus = (typeof REFUND_STATUSES)[number];
+/** What a verified event is about, so the engine knows which record to look up. */
+export declare const PAYMENT_EVENT_KINDS: readonly ["checkout", "refund", "dispute", "other"];
+export type PaymentEventKind = (typeof PAYMENT_EVENT_KINDS)[number];
+/** Why a refund is made, in the words the provider's own list uses. */
+export declare const REFUND_REASONS: readonly ["requested_by_customer", "duplicate", "fraudulent", "other"];
+export type RefundReason = (typeof REFUND_REASONS)[number];
+/**
+ * Every refusal code. Closed: an engine branch on a code the contract never
+ * named would be a guess.
+ */
+export declare const PROVIDER_ERROR_CODES: readonly ["CREDENTIALS_REFUSED", "PERMISSION_MISSING", "MODE_MISMATCH", "NOT_FOUND", "AMOUNT_UNREPRESENTABLE", "CURRENCY_UNSUPPORTED", "SIGNATURE_INVALID", "REFUND_REFUSED", "ALREADY_COMPLETED", "INVALID_REQUEST", "RATE_LIMITED", "UNAVAILABLE"];
+export type ProviderErrorCode = (typeof PROVIDER_ERROR_CODES)[number];
+/** A refusal, returned as data. */
+export interface ProviderError {
+    readonly ok: false;
+    readonly code: ProviderErrorCode;
+    /** The provider's own words, shown quoted to staff. Never a secret. */
+    readonly providerMessage: string;
+    readonly retryable: boolean;
+}
+export declare const providerErrorSchema: z.ZodObject<{
+    ok: z.ZodLiteral<false>;
+    code: z.ZodEnum<{
+        CREDENTIALS_REFUSED: "CREDENTIALS_REFUSED";
+        PERMISSION_MISSING: "PERMISSION_MISSING";
+        MODE_MISMATCH: "MODE_MISMATCH";
+        NOT_FOUND: "NOT_FOUND";
+        AMOUNT_UNREPRESENTABLE: "AMOUNT_UNREPRESENTABLE";
+        CURRENCY_UNSUPPORTED: "CURRENCY_UNSUPPORTED";
+        SIGNATURE_INVALID: "SIGNATURE_INVALID";
+        REFUND_REFUSED: "REFUND_REFUSED";
+        ALREADY_COMPLETED: "ALREADY_COMPLETED";
+        INVALID_REQUEST: "INVALID_REQUEST";
+        RATE_LIMITED: "RATE_LIMITED";
+        UNAVAILABLE: "UNAVAILABLE";
+    }>;
+    providerMessage: z.ZodString;
+    retryable: z.ZodBoolean;
+}, z.core.$strict>;
+/** True for a refusal. Checks the shape, never a class. */
+export declare function isProviderError(value: unknown): value is ProviderError;
+/** Builds a refusal. */
+export declare function providerError(code: ProviderErrorCode, providerMessage: string, retryable?: boolean): ProviderError;
+/** A non-negative decimal amount as text: "120.00", "12000", "45.250". */
+export declare const decimalAmountSchema: z.ZodString;
+/** An ISO 4217 code in capitals. */
+export declare const currencyCodeSchema: z.ZodString;
+/** An amount in the provider's smallest unit, as integer text (no float ever holds money). */
+export declare const minorAmountSchema: z.ZodString;
+export interface MinorAmount {
+    readonly minor: string;
+    readonly currency: string;
+}
+export declare const minorAmountAnswerSchema: z.ZodObject<{
+    minor: z.ZodString;
+    currency: z.ZodString;
+}, z.core.$strict>;
+/** The fields of an HTTP response a transport reads. A real `Response` has them all. */
+export interface PaymentHttpResponse {
+    readonly status: number;
+    readonly headers: {
+        get(name: string): string | null;
+    };
+    text(): Promise<string>;
+}
+/**
+ * The egress-bound client. Only hosts in the add-on's `network.allow` are
+ * reachable, and a redirect is refused rather than followed.
+ */
+export type PaymentHttpClient = (url: string, init?: {
+    method?: string;
+    headers?: Record<string, string>;
+    body?: string;
+}) => Promise<PaymentHttpResponse>;
+/**
+ * One mode's credential fields, decrypted for one call. The field names are
+ * the provider's own (a Stripe key; a PayPal client id, secret and webhook id),
+ * plus `webhookSecret` where the provider signs webhooks with a shared secret.
+ */
+export type PaymentCredentials = Readonly<Record<string, string>>;
+export interface PaymentProviderContext {
+    readonly http: PaymentHttpClient;
+    readonly credentials: PaymentCredentials;
+    readonly mode: PaymentMode;
+}
+/** What `checkCredentials` learns: whose account, which mode, what is missing. */
+export interface CredentialCheck {
+    readonly ok: true;
+    /** The provider's account id (`acct_…`, a PayPal merchant id). Shown everywhere. */
+    readonly accountId: string;
+    readonly livemode: boolean;
+    /** Each missing permission, named in the provider's own dashboard words. Empty when the key is complete. */
+    readonly missing: readonly string[];
+}
+export declare const credentialCheckSchema: z.ZodObject<{
+    ok: z.ZodLiteral<true>;
+    accountId: z.ZodString;
+    livemode: z.ZodBoolean;
+    missing: z.ZodArray<z.ZodString>;
+}, z.core.$strict>;
+/** The thing being paid, as the provider needs to show it. Never carries a secret. */
+export interface CheckoutPayable {
+    /** The invoice or record number the customer recognises ("INV-0042"). */
+    readonly reference: string;
+    /** One line describing it, shown on the provider's page. */
+    readonly description: string;
+    readonly amount: string;
+    readonly currency: string;
+    /** Prefills the provider's email field; never required. */
+    readonly customerEmail: string | null;
+    /** One of Adminium's locales (`en-US`, `ar-EG`, …); the provider maps it to its own. */
+    readonly locale: string | null;
+}
+export interface CheckoutInput {
+    readonly payable: CheckoutPayable;
+    /** The ways to pay the shop's rules allow for this customer, by the ids `methodsFor` returned. */
+    readonly methods: readonly string[];
+    /** Where the provider sends the customer back. Adminium's own URLs, never the customer's. */
+    readonly successUrl: string;
+    readonly cancelUrl: string;
+    /** Adminium's attempt id: the provider's client reference and metadata. */
+    readonly attemptId: string;
+    readonly idempotencyKey: string;
+}
+export interface CheckoutCreated {
+    readonly ok: true;
+    /** The provider's id for the checkout (a session id, an order id). */
+    readonly ref: string;
+    /** The hosted page. The engine checks its host before sending anyone there. */
+    readonly url: string;
+    /** When the provider will end it (epoch ms), if it says. */
+    readonly expiresAt: number | null;
+}
+export declare const checkoutCreatedSchema: z.ZodObject<{
+    ok: z.ZodLiteral<true>;
+    ref: z.ZodString;
+    url: z.ZodString;
+    expiresAt: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strict>;
+/** How the customer paid, as staff will read it. */
+export interface PaidWith {
+    /** The provider's method id (`card`, `sepa_debit`, `paypal`). */
+    readonly method: string;
+    /** "Visa ••4242" or the method's name. Never a full number. */
+    readonly label: string;
+    /** True for a method whose money arrives later (SEPA, vouchers). */
+    readonly delayed: boolean;
+}
+export declare const paidWithSchema: z.ZodObject<{
+    method: z.ZodString;
+    label: z.ZodString;
+    delayed: z.ZodBoolean;
+}, z.core.$strict>;
+/** How a checkout stands, re-read from the provider (never from a webhook body). */
+export interface CheckoutState {
+    readonly ok: true;
+    readonly ref: string;
+    readonly status: CheckoutStatus;
+    /** The client reference the checkout was made with: Adminium's attempt id. */
+    readonly attemptId: string | null;
+    /** What the provider TOOK. Null until money moved. May differ from what was asked. */
+    readonly amount: string | null;
+    readonly currency: string | null;
+    readonly livemode: boolean;
+    /** The provider's id for the money itself (a PaymentIntent, a capture), once there is one. */
+    readonly paymentRef: string | null;
+    readonly paidWith: PaidWith | null;
+    /** When the provider says it succeeded (epoch ms). */
+    readonly settledAt: number | null;
+    /** The provider's words for a failure, if any. */
+    readonly failureMessage: string | null;
+}
+export declare const checkoutStateSchema: z.ZodObject<{
+    ok: z.ZodLiteral<true>;
+    ref: z.ZodString;
+    status: z.ZodEnum<{
+        expired: "expired";
+        pending: "pending";
+        processing: "processing";
+        succeeded: "succeeded";
+        failed: "failed";
+        cancelled: "cancelled";
+        requires_action: "requires_action";
+    }>;
+    attemptId: z.ZodNullable<z.ZodString>;
+    amount: z.ZodNullable<z.ZodString>;
+    currency: z.ZodNullable<z.ZodString>;
+    livemode: z.ZodBoolean;
+    paymentRef: z.ZodNullable<z.ZodString>;
+    paidWith: z.ZodNullable<z.ZodObject<{
+        method: z.ZodString;
+        label: z.ZodString;
+        delayed: z.ZodBoolean;
+    }, z.core.$strict>>;
+    settledAt: z.ZodNullable<z.ZodNumber>;
+    failureMessage: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export interface ExpireResult {
+    readonly ok: true;
+    readonly ref: string;
+    /** The checkout's state after the call: `expired`, or what it already was. */
+    readonly status: CheckoutStatus;
+}
+export declare const expireResultSchema: z.ZodObject<{
+    ok: z.ZodLiteral<true>;
+    ref: z.ZodString;
+    status: z.ZodEnum<{
+        expired: "expired";
+        pending: "pending";
+        processing: "processing";
+        succeeded: "succeeded";
+        failed: "failed";
+        cancelled: "cancelled";
+        requires_action: "requires_action";
+    }>;
+}, z.core.$strict>;
+export interface RefundInput {
+    /** The provider's id for the money (`CheckoutState.paymentRef`). */
+    readonly paymentRef: string;
+    readonly amount: string;
+    readonly currency: string;
+    readonly reason: RefundReason;
+    /** Minted at the confirm step, bound to (payment, amount), reused on every retry. */
+    readonly idempotencyKey: string;
+}
+export interface RefundState {
+    readonly ok: true;
+    /** The provider's id for the refund. */
+    readonly ref: string;
+    readonly paymentRef: string;
+    readonly status: RefundStatus;
+    readonly amount: string;
+    readonly currency: string;
+    readonly failureMessage: string | null;
+}
+export declare const refundStateSchema: z.ZodObject<{
+    ok: z.ZodLiteral<true>;
+    ref: z.ZodString;
+    paymentRef: z.ZodString;
+    status: z.ZodEnum<{
+        pending: "pending";
+        succeeded: "succeeded";
+        failed: "failed";
+        cancelled: "cancelled";
+        requires_action: "requires_action";
+    }>;
+    amount: z.ZodString;
+    currency: z.ZodString;
+    failureMessage: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+/** A webhook's identity, after its signature verified. Never a status to trust. */
+export interface PaymentEvent {
+    readonly ok: true;
+    /** The provider's event id: unique per provider and mode. */
+    readonly eventId: string;
+    /** The provider's own type (`checkout.session.completed`). */
+    readonly type: string;
+    readonly kind: PaymentEventKind;
+    /** The checkout the event is about (a session or order id), when it says. */
+    readonly checkoutRef: string | null;
+    /** The money it is about (a PaymentIntent or capture), when it says. */
+    readonly paymentRef: string | null;
+    /** The refund it is about, when it says. */
+    readonly refundRef: string | null;
+    readonly livemode: boolean;
+    /** When the provider made the event (epoch ms). */
+    readonly occurredAt: number;
+}
+export declare const paymentEventSchema: z.ZodObject<{
+    ok: z.ZodLiteral<true>;
+    eventId: z.ZodString;
+    type: z.ZodString;
+    kind: z.ZodEnum<{
+        refund: "refund";
+        checkout: "checkout";
+        dispute: "dispute";
+        other: "other";
+    }>;
+    checkoutRef: z.ZodNullable<z.ZodString>;
+    paymentRef: z.ZodNullable<z.ZodString>;
+    refundRef: z.ZodNullable<z.ZodString>;
+    livemode: z.ZodBoolean;
+    occurredAt: z.ZodNumber;
+}, z.core.$strict>;
+export interface MissedEvents {
+    readonly ok: true;
+    readonly events: readonly PaymentEvent[];
+    /** Pass back next time. Null when the provider keeps no cursor. */
+    readonly cursor: string | null;
+    /** More events wait past this page. */
+    readonly more: boolean;
+}
+export declare const missedEventsSchema: z.ZodObject<{
+    ok: z.ZodLiteral<true>;
+    events: z.ZodArray<z.ZodObject<{
+        ok: z.ZodLiteral<true>;
+        eventId: z.ZodString;
+        type: z.ZodString;
+        kind: z.ZodEnum<{
+            refund: "refund";
+            checkout: "checkout";
+            dispute: "dispute";
+            other: "other";
+        }>;
+        checkoutRef: z.ZodNullable<z.ZodString>;
+        paymentRef: z.ZodNullable<z.ZodString>;
+        refundRef: z.ZodNullable<z.ZodString>;
+        livemode: z.ZodBoolean;
+        occurredAt: z.ZodNumber;
+    }, z.core.$strict>>;
+    cursor: z.ZodNullable<z.ZodString>;
+    more: z.ZodBoolean;
+}, z.core.$strict>;
+/** A way to pay the account has switched on. */
+export interface PaymentMethodInfo {
+    /** The provider's id, passed back in `CheckoutInput.methods`. */
+    readonly id: string;
+    /** Its name, as staff see it ("Cards", "Link (Stripe)", "SEPA Direct Debit"). */
+    readonly label: string;
+    readonly delayed: boolean;
+}
+export interface MethodList {
+    readonly ok: true;
+    readonly methods: readonly PaymentMethodInfo[];
+}
+export declare const methodListSchema: z.ZodObject<{
+    ok: z.ZodLiteral<true>;
+    methods: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+        delayed: z.ZodBoolean;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export interface MethodQuery {
+    /** ISO 3166-1 alpha-2, the customer's country, or null when unknown. */
+    readonly country: string | null;
+    readonly currency: string;
+    readonly amount: string;
+}
+/** A webhook as received: the exact bytes (as UTF-8 text) and the headers, names in lower case. */
+export interface WebhookDelivery {
+    readonly rawBody: string;
+    readonly headers: Readonly<Record<string, string | undefined>>;
+}
+/**
+ * One payment service. Every method may return a `ProviderError` instead of
+ * its answer; none throws for an ordinary refusal.
+ */
+export interface PaymentProvider {
+    /** The add-on's key. */
+    readonly key: string;
+    readonly mode: PaymentMode;
+    checkCredentials(): Promise<CredentialCheck | ProviderError>;
+    createCheckout(input: CheckoutInput): Promise<CheckoutCreated | ProviderError>;
+    /** An unknown ref is `NOT_FOUND`, never a throw. */
+    status(ref: string): Promise<CheckoutState | ProviderError>;
+    /** Finishes a two-step payment (a PayPal capture). A one-step provider returns `status(ref)`. */
+    complete(ref: string, idempotencyKey: string): Promise<CheckoutState | ProviderError>;
+    /** Ends an open checkout. One that already completed is `ALREADY_COMPLETED`. */
+    expire(ref: string): Promise<ExpireResult | ProviderError>;
+    refund(input: RefundInput): Promise<RefundState | ProviderError>;
+    refundStatus(ref: string): Promise<RefundState | ProviderError>;
+    verifyWebhook(delivery: WebhookDelivery): Promise<PaymentEvent | ProviderError>;
+    listMissedEvents(cursor: string | null): Promise<MissedEvents | ProviderError>;
+    methodsFor(query: MethodQuery): Promise<MethodList | ProviderError>;
+    /** The provider's own exponent table. Refuses an amount it cannot hold exactly. */
+    toMinor(amount: string, currency: string): MinorAmount | ProviderError;
+    fromMinor(minor: string, currency: string): string | ProviderError;
+}
+/** The server half's export. Called once per operation. */
+export type CreatePaymentProvider = (context: PaymentProviderContext) => PaymentProvider;
+/**
+ * The schema each answer must pass, by call. The engine parses every answer
+ * with these; a provider whose answer fails is treated as unavailable.
+ */
+export declare const PAYMENT_ANSWER_SCHEMAS: {
+    readonly checkCredentials: z.ZodObject<{
+        ok: z.ZodLiteral<true>;
+        accountId: z.ZodString;
+        livemode: z.ZodBoolean;
+        missing: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>;
+    readonly createCheckout: z.ZodObject<{
+        ok: z.ZodLiteral<true>;
+        ref: z.ZodString;
+        url: z.ZodString;
+        expiresAt: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strict>;
+    readonly status: z.ZodObject<{
+        ok: z.ZodLiteral<true>;
+        ref: z.ZodString;
+        status: z.ZodEnum<{
+            expired: "expired";
+            pending: "pending";
+            processing: "processing";
+            succeeded: "succeeded";
+            failed: "failed";
+            cancelled: "cancelled";
+            requires_action: "requires_action";
+        }>;
+        attemptId: z.ZodNullable<z.ZodString>;
+        amount: z.ZodNullable<z.ZodString>;
+        currency: z.ZodNullable<z.ZodString>;
+        livemode: z.ZodBoolean;
+        paymentRef: z.ZodNullable<z.ZodString>;
+        paidWith: z.ZodNullable<z.ZodObject<{
+            method: z.ZodString;
+            label: z.ZodString;
+            delayed: z.ZodBoolean;
+        }, z.core.$strict>>;
+        settledAt: z.ZodNullable<z.ZodNumber>;
+        failureMessage: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>;
+    readonly complete: z.ZodObject<{
+        ok: z.ZodLiteral<true>;
+        ref: z.ZodString;
+        status: z.ZodEnum<{
+            expired: "expired";
+            pending: "pending";
+            processing: "processing";
+            succeeded: "succeeded";
+            failed: "failed";
+            cancelled: "cancelled";
+            requires_action: "requires_action";
+        }>;
+        attemptId: z.ZodNullable<z.ZodString>;
+        amount: z.ZodNullable<z.ZodString>;
+        currency: z.ZodNullable<z.ZodString>;
+        livemode: z.ZodBoolean;
+        paymentRef: z.ZodNullable<z.ZodString>;
+        paidWith: z.ZodNullable<z.ZodObject<{
+            method: z.ZodString;
+            label: z.ZodString;
+            delayed: z.ZodBoolean;
+        }, z.core.$strict>>;
+        settledAt: z.ZodNullable<z.ZodNumber>;
+        failureMessage: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>;
+    readonly expire: z.ZodObject<{
+        ok: z.ZodLiteral<true>;
+        ref: z.ZodString;
+        status: z.ZodEnum<{
+            expired: "expired";
+            pending: "pending";
+            processing: "processing";
+            succeeded: "succeeded";
+            failed: "failed";
+            cancelled: "cancelled";
+            requires_action: "requires_action";
+        }>;
+    }, z.core.$strict>;
+    readonly refund: z.ZodObject<{
+        ok: z.ZodLiteral<true>;
+        ref: z.ZodString;
+        paymentRef: z.ZodString;
+        status: z.ZodEnum<{
+            pending: "pending";
+            succeeded: "succeeded";
+            failed: "failed";
+            cancelled: "cancelled";
+            requires_action: "requires_action";
+        }>;
+        amount: z.ZodString;
+        currency: z.ZodString;
+        failureMessage: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>;
+    readonly refundStatus: z.ZodObject<{
+        ok: z.ZodLiteral<true>;
+        ref: z.ZodString;
+        paymentRef: z.ZodString;
+        status: z.ZodEnum<{
+            pending: "pending";
+            succeeded: "succeeded";
+            failed: "failed";
+            cancelled: "cancelled";
+            requires_action: "requires_action";
+        }>;
+        amount: z.ZodString;
+        currency: z.ZodString;
+        failureMessage: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>;
+    readonly verifyWebhook: z.ZodObject<{
+        ok: z.ZodLiteral<true>;
+        eventId: z.ZodString;
+        type: z.ZodString;
+        kind: z.ZodEnum<{
+            refund: "refund";
+            checkout: "checkout";
+            dispute: "dispute";
+            other: "other";
+        }>;
+        checkoutRef: z.ZodNullable<z.ZodString>;
+        paymentRef: z.ZodNullable<z.ZodString>;
+        refundRef: z.ZodNullable<z.ZodString>;
+        livemode: z.ZodBoolean;
+        occurredAt: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly listMissedEvents: z.ZodObject<{
+        ok: z.ZodLiteral<true>;
+        events: z.ZodArray<z.ZodObject<{
+            ok: z.ZodLiteral<true>;
+            eventId: z.ZodString;
+            type: z.ZodString;
+            kind: z.ZodEnum<{
+                refund: "refund";
+                checkout: "checkout";
+                dispute: "dispute";
+                other: "other";
+            }>;
+            checkoutRef: z.ZodNullable<z.ZodString>;
+            paymentRef: z.ZodNullable<z.ZodString>;
+            refundRef: z.ZodNullable<z.ZodString>;
+            livemode: z.ZodBoolean;
+            occurredAt: z.ZodNumber;
+        }, z.core.$strict>>;
+        cursor: z.ZodNullable<z.ZodString>;
+        more: z.ZodBoolean;
+    }, z.core.$strict>;
+    readonly methodsFor: z.ZodObject<{
+        ok: z.ZodLiteral<true>;
+        methods: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            label: z.ZodString;
+            delayed: z.ZodBoolean;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+};
+export type PaymentCall = keyof typeof PAYMENT_ANSWER_SCHEMAS;
+//# sourceMappingURL=payment-provider.d.ts.map

package/dist/payment-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment-provider.d.ts","sourceRoot":"","sources":["../src/payment-provider.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,yBAAyB,qBAAqB,CAAC;AAC5D,eAAO,MAAM,wBAAwB,IAAI,CAAC;AAE1C,yDAAyD;AACzD,eAAO,MAAM,wBAAwB,0BAA0B,CAAC;AAEhE;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B,kBAAkB,CAAC;AAE7D;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,mBAAmB,CAAC;AAEvD,wFAAwF;AACxF,eAAO,MAAM,aAAa,2BAA4B,CAAC;AACvD,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzD;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,sGAQpB,CAAC;AACX,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEhE,mFAAmF;AACnF,eAAO,MAAM,eAAe,6EAA8E,CAAC;AAC3G,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE5D,mFAAmF;AACnF,eAAO,MAAM,mBAAmB,qDAAsD,CAAC;AACvF,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEpE,uEAAuE;AACvE,eAAO,MAAM,cAAc,wEAAyE,CAAC;AACrG,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3D;;;GAGG;AACH,eAAO,MAAM,oBAAoB,sPAyBvB,CAAC;AACX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtE,mCAAmC;AACnC,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IACnB,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,uEAAuE;IACvE,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;CAC7B;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;kBAOrB,CAAC;AAEZ,2DAA2D;AAC3D,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAOtE;AAED,wBAAwB;AACxB,wBAAgB,aAAa,CAAC,IAAI,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,EAAE,SAAS,UAAQ,GAAG,aAAa,CAEhH;AAID,0EAA0E;AAC1E,eAAO,MAAM,mBAAmB,aAAyF,CAAC;AAE1H,oCAAoC;AACpC,eAAO,MAAM,kBAAkB,aAAiE,CAAC;AAEjG,8FAA8F;AAC9F,eAAO,MAAM,iBAAiB,aAAoF,CAAC;AAEnH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED,eAAO,MAAM,uBAAuB;;;kBAAgF,CAAC;AAIrH,wFAAwF;AACxF,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE;QAAE,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IACvD,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAC9B,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,KACxE,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAElC;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAElE,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC;IACzC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;CAC5B;AAID,kFAAkF;AAClF,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAClB,oFAAoF;IACpF,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,4GAA4G;IAC5G,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC;AAED,eAAO,MAAM,qBAAqB;;;;;kBAOvB,CAAC;AAEZ,sFAAsF;AACtF,MAAM,WAAW,eAAe;IAC9B,yEAAyE;IACzE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,4DAA4D;IAC5D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,2DAA2D;IAC3D,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,wFAAwF;IACxF,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,kGAAkG;IAClG,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,6FAA6F;IAC7F,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,2EAA2E;IAC3E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAClB,sEAAsE;IACtE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,+EAA+E;IAC/E,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,eAAO,MAAM,qBAAqB;;;;;kBAOvB,CAAC;AAEZ,oDAAoD;AACpD,MAAM,WAAW,QAAQ;IACvB,iEAAiE;IACjE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,oEAAoE;IACpE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED,eAAO,MAAM,cAAc;;;;kBAUhB,CAAC;AAEZ,oFAAoF;AACpF,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAClB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC,8EAA8E;IAC9E,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,sFAAsF;IACtF,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,8FAA8F;IAC9F,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IACnC,sDAAsD;IACtD,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,kDAAkD;IAClD,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;kBAgB4E,CAAC;AAE7G,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAClB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,8EAA8E;IAC9E,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;CACjC;AAED,eAAO,MAAM,kBAAkB;;;;;;;;;;;;kBAEpB,CAAC;AAEZ,MAAM,WAAW,WAAW;IAC1B,oEAAoE;IACpE,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,qFAAqF;IACrF,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAClB,wCAAwC;IACxC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAED,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;kBAUnB,CAAC;AAEZ,mFAAmF;AACnF,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAClB,6DAA6D;IAC7D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,8DAA8D;IAC9D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,6EAA6E;IAC7E,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,wEAAwE;IACxE,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,4CAA4C;IAC5C,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,mDAAmD;IACnD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;kBAYpB,CAAC;AAEZ,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAClB,QAAQ,CAAC,MAAM,EAAE,SAAS,YAAY,EAAE,CAAC;IACzC,mEAAmE;IACnE,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,uCAAuC;IACvC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;CACxB;AAED,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;kBAOpB,CAAC;AAEZ,gDAAgD;AAChD,MAAM,WAAW,iBAAiB;IAChC,iEAAiE;IACjE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,iFAAiF;IACjF,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAClB,QAAQ,CAAC,OAAO,EAAE,SAAS,iBAAiB,EAAE,CAAC;CAChD;AAED,eAAO,MAAM,gBAAgB;;;;;;;kBAWlB,CAAC;AAEZ,MAAM,WAAW,WAAW;IAC1B,wEAAwE;IACxE,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,mGAAmG;AACnG,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;CAChE;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,wBAAwB;IACxB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,gBAAgB,IAAI,OAAO,CAAC,eAAe,GAAG,aAAa,CAAC,CAAC;IAC7D,cAAc,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,GAAG,aAAa,CAAC,CAAC;IAC/E,oDAAoD;IACpD,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,aAAa,CAAC,CAAC;IAC5D,iGAAiG;IACjG,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,aAAa,CAAC,CAAC;IACtF,gFAAgF;IAChF,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,aAAa,CAAC,CAAC;IAC3D,MAAM,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,GAAG,aAAa,CAAC,CAAC;IACjE,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,aAAa,CAAC,CAAC;IAChE,aAAa,CAAC,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,GAAG,aAAa,CAAC,CAAC;IAChF,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,YAAY,GAAG,aAAa,CAAC,CAAC;IAC/E,UAAU,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,GAAG,aAAa,CAAC,CAAC;IACpE,mFAAmF;IACnF,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,WAAW,GAAG,aAAa,CAAC;IACvE,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,CAAC;CACpE;AAED,2DAA2D;AAC3D,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,EAAE,sBAAsB,KAAK,eAAe,CAAC;AAEzF;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAWzB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,MAAM,OAAO,sBAAsB,CAAC"}