vesant-sdk 1.6.6 → 2.0.0-dev.40d1c39

package/dist/index-CItMPmLL.d.ts

@@ -1,320 +0,0 @@
-import { T as Timestamp, U as UUID, R as RiskLevel } from './types-B4Ezqo7V.js';
-
-/**
- * Webhook signature verification utilities.
- *
- * Supports both Web Crypto API (browsers, Deno, Cloudflare Workers)
- * and Node.js crypto module with automatic runtime detection.
- * Uses constant-time comparison to prevent timing attacks.
- */
-/**
- * Verify an HMAC-SHA256 webhook signature.
- *
- * @param payload - The raw request body string
- * @param signature - The signature from the webhook header
- * @param secret - The webhook signing secret
- * @returns true if the signature is valid
- */
-declare function verifyWebhookSignature(payload: string, signature: string, secret: string): Promise<boolean>;
-
-/**
- * TypeScript types for the Transaction Monitoring (TM) Service
- *
- * These definitions mirror the Go structs used in
- * services/transaction-monitoring-service/internal/domain/
- *
- * Only a subset of fields is included; additional helpers may be
- * added as the SDK grows.
- */
-
-/**
- * Supported transaction types.
- * See domain/transaction.go TransactionType constants.
- */
-type TransactionType = "deposit" | "withdrawal" | "transfer" | "bet" | "payout";
-/**
- * Modes or channels by which the transaction was carried out.
- * See domain/transaction.go TransactionMode constants.
- */
-type TransactionMode = "wire_transfer" | "crypto" | "swift" | "ach" | "card";
-/**
- * Current status of the transaction record.
- * See domain/transaction.go TransactionStatus constants.
- */
-type TransactionStatus = "pending" | "completed" | "failed" | "blocked" | "flagged" | "hold";
-/**
- * Payload sent when creating a new transaction via the TM API.
- *
- * Numeric decimal types in Go are represented as strings in the SDK to avoid
- * precision loss in JavaScript.  Dates are ISO strings.
- */
-interface TransactionCreateDTO {
-    tx_id: string;
-    reference: string;
-    tenant_id: string;
-    customer_id: string;
-    transaction_type: TransactionType;
-    transaction_mode: TransactionMode;
-    amount: string;
-    amount_usd?: number;
-    currency: string;
-    source_account?: string;
-    destination_account?: string;
-    country?: string;
-    ip_address?: string;
-    metadata?: Record<string, any>;
-    benificiary_comment?: string;
-    transaction_date: Timestamp;
-}
-/**
- * Representation of a transaction record returned from the TM service.
- */
-type WithholdingType = "none" | "backup_us" | "backup_non_us" | "treaty";
-type WithholdingReason = "customer_tax_form_not_verified" | "tin_not_verified" | "b_notice_backup_withholding";
-type JSONB = Record<string, any>;
-type Transaction = {
-    id: string;
-    tx_id: string;
-    reference: string;
-    tenant_id: string;
-    customer_id: string;
-    transaction_type: TransactionType;
-    transaction_mode: TransactionMode;
-    amount: string;
-    withheld_amount: string;
-    released_amount: string;
-    withholding_rate: number;
-    withholding_reason?: WithholdingReason;
-    withholding_type?: WithholdingType;
-    amount_usd: number;
-    withheld_usd: number;
-    released_usd: number;
-    tax_year: number;
-    currency: string;
-    status: TransactionStatus;
-    source_account?: string;
-    destination_account?: string;
-    country?: string;
-    ip_address?: string;
-    is_first_withdrawal: boolean;
-    risk_score: number;
-    metadata?: JSONB;
-    benificiary_comment?: string;
-    transaction_date: string;
-    created_at: string;
-    updated_at: string;
-    deleted_at?: string | null;
-};
-/**
- * Configuration object consumed by {@link TransactionClient}.
- * Currently identical to {@link import('../core/types').BaseClientConfig},
- * exported here for future extensibility.
- */
-interface TransactionClientConfig {
-    baseURL: string;
-    tenantId: string;
-    apiKey?: string;
-    headers?: Record<string, string>;
-    timeout?: number;
-    retries?: number;
-    debug?: boolean;
-    environment?: 'production' | 'sandbox';
-}
-type TransactionCreateResponse = {
-    transaction: Transaction;
-    message: string;
-};
-
-/**
- * Webhook event types and payload definitions.
- */
-
-type WebhookEventType = 'risk.score.changed' | 'risk.category.changed' | 'profile.created' | 'profile.updated' | 'geolocation.verified' | 'geolocation.blocked' | 'kyc.status.changed' | 'kyc.approved' | 'kyc.declined' | 'decision.recorded' | 'label.applied' | 'location_request.completed' | 'compliance.check.failed' | 'tax.reminder.sent' | 'transaction.callback';
-interface BaseWebhookEvent<T extends WebhookEventType = WebhookEventType, P = unknown> {
-    id: UUID;
-    type: T;
-    tenant_id: string;
-    environment: 'production' | 'sandbox';
-    customer_id: string;
-    payload: P;
-    timestamp: Timestamp;
-}
-interface RiskScoreChangedPayload {
-    previous_score: number;
-    new_score: number;
-    risk_level: RiskLevel;
-    factors: string[];
-}
-interface RiskCategoryChangedPayload {
-    previous_category: string;
-    new_category: string;
-    risk_level: RiskLevel;
-}
-interface ProfileCreatedPayload {
-    customer_id: string;
-    entity_type: string;
-    source: string;
-}
-interface ProfileUpdatedPayload {
-    customer_id: string;
-    updated_fields: string[];
-}
-interface GeolocationVerifiedPayload {
-    latitude: number;
-    longitude: number;
-    country: string;
-    region?: string;
-    is_compliant: boolean;
-}
-interface GeolocationBlockedPayload {
-    latitude: number;
-    longitude: number;
-    country: string;
-    region?: string;
-    reasons: string[];
-}
-interface KycStatusChangedPayload {
-    previous_status: string;
-    new_status: string;
-    provider?: string;
-}
-interface DecisionRecordedPayload {
-    decision_id: string;
-    decision_type: string;
-    category: string;
-    source: string;
-    risk_score?: number;
-}
-interface LabelAppliedPayload {
-    label_type: string;
-    reasons?: string[];
-}
-interface LocationRequestCompletedPayload {
-    request_id: string;
-    status: string;
-    latitude?: number;
-    longitude?: number;
-}
-interface ComplianceCheckFailedPayload {
-    check_type: string;
-    reasons: string[];
-    severity: string;
-}
-type TaxReminderType = 'w9_request' | 'w8ben_expiry' | 're_request';
-type TaxFormType = 'W9' | 'W8BEN' | 'W8BENE';
-interface TaxReminderSentPayload {
-    customer_id: string;
-    profile_id: string;
-    form_type: TaxFormType;
-    reminder_type: TaxReminderType;
-    reminder_number: number;
-    message: string;
-}
-/**
- * Fired after every transaction is created. Carries the final transaction
- * state so the client can mirror status, withholding, and amount details.
- * status === "hold" means the client should freeze the transaction.
- */
-interface TransactionCallbackPayload {
-    tx_id: string;
-    reference: string;
-    customer_id: string;
-    transaction_type: TransactionType;
-    transaction_mode: TransactionMode;
-    status: TransactionStatus;
-    amount: string;
-    currency: string;
-    withheld_amount: string;
-    released_amount: string;
-    withholding_rate: number;
-    withholding_type: WithholdingType;
-    withholding_reason?: WithholdingReason;
-    amount_usd: number;
-    withheld_usd: number;
-    released_usd: number;
-    is_first_withdrawal: boolean;
-    transaction_date: Timestamp;
-}
-type WebhookEvent = BaseWebhookEvent<'risk.score.changed', RiskScoreChangedPayload> | BaseWebhookEvent<'risk.category.changed', RiskCategoryChangedPayload> | BaseWebhookEvent<'profile.created', ProfileCreatedPayload> | BaseWebhookEvent<'profile.updated', ProfileUpdatedPayload> | BaseWebhookEvent<'geolocation.verified', GeolocationVerifiedPayload> | BaseWebhookEvent<'geolocation.blocked', GeolocationBlockedPayload> | BaseWebhookEvent<'kyc.status.changed', KycStatusChangedPayload> | BaseWebhookEvent<'kyc.approved', KycStatusChangedPayload> | BaseWebhookEvent<'kyc.declined', KycStatusChangedPayload> | BaseWebhookEvent<'decision.recorded', DecisionRecordedPayload> | BaseWebhookEvent<'label.applied', LabelAppliedPayload> | BaseWebhookEvent<'location_request.completed', LocationRequestCompletedPayload> | BaseWebhookEvent<'compliance.check.failed', ComplianceCheckFailedPayload> | BaseWebhookEvent<'tax.reminder.sent', TaxReminderSentPayload> | BaseWebhookEvent<'transaction.callback', TransactionCallbackPayload>;
-interface WebhookHandlerConfig {
-    /** Webhook signing secret for signature verification */
-    secret: string;
-    /** Header name containing the signature (default: 'x-webhook-signature') */
-    signatureHeader?: string;
-    /** Maximum age of webhook event in ms (default: 300000 = 5 minutes) */
-    tolerance?: number;
-}
-type WebhookEventHandler<T extends WebhookEventType = WebhookEventType> = (event: Extract<WebhookEvent, {
-    type: T;
-}>) => void | Promise<void>;
-type WebhookAnyHandler = (event: WebhookEvent) => void | Promise<void>;
-
-/**
- * Webhook event handler with signature verification and typed dispatch.
- */
-
-declare class WebhookHandler {
-    private handlers;
-    private anyHandlers;
-    private readonly secret;
-    private readonly tolerance;
-    constructor(config: WebhookHandlerConfig);
-    /**
-     * Register a handler for a specific event type.
-     */
-    on<T extends WebhookEventType>(eventType: T, handler: WebhookEventHandler<T>): this;
-    /**
-     * Register a catch-all handler for all event types.
-     */
-    onAny(handler: WebhookAnyHandler): this;
-    /**
-     * Verify signature and parse the webhook body.
-     */
-    verifyAndParse(body: string, signature: string): Promise<WebhookEvent>;
-    /**
-     * Verify signature, parse, and dispatch to registered handlers.
-     */
-    handle(body: string, signature: string): Promise<void>;
-    /**
-     * Parse an event without signature verification (for testing).
-     */
-    parseEvent(body: string): WebhookEvent;
-    private parseAndValidate;
-    private dispatch;
-}
-
-/**
- * Framework middleware helpers for webhook handling.
- *
- * Provides pre-built integrations for Express/Connect and Next.js App Router.
- */
-
-interface WebhookMiddlewareOptions extends WebhookHandlerConfig {
-    /** Event handlers to register */
-    handlers?: Partial<Record<WebhookEventType, WebhookEventHandler>>;
-    /** Catch-all handler */
-    onAny?: WebhookAnyHandler;
-}
-/**
- * Create an Express/Connect-compatible middleware for webhook handling.
- *
- * Expects the raw body to be available as `req.body` (string).
- * Use `express.raw({ type: 'application/json' })` or similar middleware upstream.
- */
-declare function createWebhookMiddleware(options: WebhookMiddlewareOptions): (req: {
-    body: string | Buffer;
-    headers: Record<string, string | string[] | undefined>;
-}, res: {
-    status(code: number): {
-        json(body: unknown): void;
-    };
-    json?(body: unknown): void;
-}, next?: (err?: unknown) => void) => Promise<void>;
-/**
- * Create a Next.js App Router-compatible webhook handler.
- *
- * Returns an async function `(request: Request) => Promise<Response>`.
- */
-declare function createNextWebhookHandler(options: WebhookMiddlewareOptions): (request: Request) => Promise<Response>;
-
-export { type BaseWebhookEvent as B, type ComplianceCheckFailedPayload as C, type DecisionRecordedPayload as D, type GeolocationVerifiedPayload as G, type JSONB as J, type KycStatusChangedPayload as K, type LabelAppliedPayload as L, type ProfileCreatedPayload as P, type RiskScoreChangedPayload as R, type TransactionCreateDTO as T, WebhookHandler as W, type TransactionCreateResponse as a, type TransactionType as b, type TransactionMode as c, type TransactionStatus as d, type WithholdingType as e, type WithholdingReason as f, type Transaction as g, type TransactionClientConfig as h, type WebhookMiddlewareOptions as i, createWebhookMiddleware as j, createNextWebhookHandler as k, type WebhookEventType as l, type RiskCategoryChangedPayload as m, type ProfileUpdatedPayload as n, type GeolocationBlockedPayload as o, type LocationRequestCompletedPayload as p, type TaxReminderType as q, type TaxFormType as r, type TaxReminderSentPayload as s, type TransactionCallbackPayload as t, type WebhookEvent as u, verifyWebhookSignature as v, type WebhookHandlerConfig as w, type WebhookEventHandler as x, type WebhookAnyHandler as y };