@capxul/sdk 0.2.0-alpha.4 → 0.2.0-alpha.5

package/dist/index.d.ts

@@ -1,461 +0,0 @@
-import { A as AccountProvisionPersonalInput, C as CapxulClient } from './client-CbUeJoM9.js';
-export { a as AccountsClient, b as ApiKeyCreateResult, c as ApiKeysClient, d as AuthBootstrapReason, e as AuthBootstrapToken, f as AuthService, g as AuthSessionStore, B as BrowserCapxulConfig, h as CapxulAuthConfig, i as CapxulConfig, j as CapxulDataClient, k as CapxulFlowFactories, l as CapxulSigningConfig, m as CompleteBootstrapInput, n as CompleteBootstrapResult, D as DocumentsClient, E as ExternalAccountsClient, H as HttpTransport, L as LocalPrivateKeySignerProvider, M as MeClient, O as OperationsClient, o as OrgDocumentsClient, p as OrgMembersClient, q as OrgPaymentsClient, r as OrgSafesClient, s as OrgTransfersClient, t as OrgTreasuryClient, u as OrgWithdrawalsClient, v as OrganizationsClient, P as PaymentsClient, S as Session, w as SubAccountsClient, T as TokenTransfer, x as TokenTransferId, y as TokenTransfersClient, z as TokenTransfersListInput, F as TokenTransfersListPage, G as TokenTransfersRetrieveInput, I as TransfersClient, J as TransportRuntime, K as TransportState, V as VerifyOtpResult, N as VirtualAccountsClient, Q as VirtualCardsClient, W as WebhookEndpointCreateResult, R as WebhookEndpointsClient, U as WebhookEventsClient, X as WithdrawalsClient, Y as createCapxulClient, Z as makeHttpTransport, _ as toTokenTransferId } from './client-CbUeJoM9.js';
-import * as xstate from 'xstate';
-import { C as CapxulError$1, a as CapxulErrorCode$1 } from './errors-CwhCWGxm.js';
-export { b as CapxulErrorDetails, c as CapxulErrorEnvelope, d as CapxulResult } from './errors-CwhCWGxm.js';
-import { A as Account } from './types-BD4VAQb5.js';
-export { a as AccountLookupResult, b as ApiKey, c as ApiKeyEnvironment, d as ApiKeyType, B as BalanceLedgerEntry, e as BankStatementDocument, C as CreatePaymentResult, f as CreateTransferResult, g as CreateWithdrawalResult, D as Document, E as ExternalAccount, h as ExternalAccountKind, I as IdentityProfileBase, i as InvoiceDocument, K as KybProfile, j as KybStatus, k as KycProfile, l as KycStatus, m as KycUploadDocument, L as List, M as Member, n as MemberInviteResponse, o as MembershipStatus, p as Money, O as Operation, q as OperationStatus, r as OperationSummary, s as Organization, P as PageInfo, t as Payment, u as PaymentParty, v as PaymentStatus, w as PayrollRunDocument, x as PayrollScheduleDocument, R as ReceiptDocument, S as Safe, y as Scope, z as Settlement, F as SubAccount, G as SubAccountOwnerKind, T as TaxFormDocument, H as TimestampIso, J as Transfer, N as TransferCustody, Q as TransferEndpoint, U as TransferFx, V as TransferStatus, W as Treasury, X as UserIdentifier, Y as VirtualAccount, Z as VirtualAccountOwnerKind, _ as VirtualCard, $ as VirtualCardLimits, a0 as VirtualCardOwnerKind, a1 as WebhookEndpoint, a2 as WebhookEvent, a3 as Withdrawal, a4 as WithdrawalStatus } from './types-BD4VAQb5.js';
-import { U as Username, O as OperationId, N as NextAction } from './next-action-CTGl8wpy.js';
-export { A as AccountId, a as ApiKeyId, B as BalanceLedgerEntryId, C as CorrelationId, D as DocumentId, E as Email, b as ExternalAccountId, K as KybProfileId, c as KycProfileId, M as MemberId, d as OrganizationId, P as PaymentId, e as PhoneNumber, S as SafeId, f as SubAccountId, T as TransactionIntentId, g as TransferId, h as TreasuryId, V as VirtualAccountId, i as VirtualCardId, W as WebhookEndpointId, j as WebhookEventId, k as WithdrawalId, t as toAccountId, l as toApiKeyId, m as toBalanceLedgerEntryId, n as toDocumentId, o as toEmail, p as toExternalAccountId, q as toKybProfileId, r as toKycProfileId, s as toMemberId, u as toOperationId, v as toOrganizationId, w as toPaymentId, x as toPhoneNumber, y as toSafeId, z as toSubAccountId, F as toTransferId, G as toTreasuryId, H as toUsername, I as toVirtualAccountId, J as toVirtualCardId, L as toWebhookEndpointId, Q as toWebhookEventId, R as toWithdrawalId } from './next-action-CTGl8wpy.js';
-import { Account as Account$1 } from 'viem';
-export { WebhookVerificationOptions, WebhookVerificationResult, verifyWebhook } from './webhooks.js';
-
-/**
- * Unified error type used across the entire stack: backend, SDK, and frontend.
- * One class, one set of codes, one language.
- *
- * Backend throws CapxulError → withErrorBoundary serializes to ConvexError →
- * SDK deserializes back to CapxulError → frontend routes on err.code.
- */
-type CapxulErrorCode = "NOT_AUTHENTICATED" | "EMAIL_DELIVERY_FAILED" | "API_KEY_INVALID" | "API_KEY_EXPIRED" | "PROFILE_NOT_FOUND" | "SMART_ACCOUNT_MISSING" | "PLAYER_NOT_FOUND" | "ACCOUNT_NOT_FOUND" | "PROVIDER_ERROR" | "INVALID_INPUT" | "ENV_MISSING" | "NOT_IMPLEMENTED" | "VERIFICATION_REQUIRED" | "INSUFFICIENT_BALANCE" | "INVALID_RECIPIENT" | "TRANSACTION_FAILED" | "RATE_LIMITED" | "NETWORK_ERROR" | "PERMISSION_DENIED" | "IDEMPOTENCY_CONFLICT" | "NOT_FOUND" | "OPERATION_CANCELED" | "OPERATION_TIMEOUT" | "ACTION_REQUIRED" | "KYC_REQUIRED" | "POLICY_DENIED" | "SAFE_NOT_READY" | "PROVIDER_UNAVAILABLE" | "PROVIDER_REJECTED" | "RECONCILIATION_FAILED" | "INTERNAL_ERROR" | "QUOTE_EXPIRED" | "QUOTE_NOT_FOUND" | "INDEXER_DELIVERY_TIMEOUT" | "UNKNOWN";
-declare class CapxulError extends Error {
-    readonly code: CapxulErrorCode;
-    readonly details?: Record<string, unknown>;
-    readonly correlationId?: string;
-    readonly layer?: string;
-    constructor(code: CapxulErrorCode, message: string, options?: {
-        cause?: unknown;
-        details?: Record<string, unknown>;
-        correlationId?: string;
-        layer?: string;
-    });
-}
-
-/**
- * Provisioning flow errors may originate from two CapxulError surfaces:
- *  - the SDK-local generic `CapxulError<Codes>` returned by
- *    `client.accounts.provisionPersonal`
- *  - the `@repo/config` `CapxulError` produced by the `Errors.xxx()`
- *    factory family (per `error-handling.md`) used for non-CapxulError
- *    cause wrapping and the timeout error
- *
- * Both share `.code`, `.message`, `.details`, and extend `Error`.
- */
-type ProvisioningFlowError = CapxulError$1 | CapxulError;
-type ProvisioningFlowContext = {
-    readonly input: AccountProvisionPersonalInput | null;
-    readonly account: Account | null;
-    readonly error: ProvisioningFlowError | null;
-};
-type ProvisioningFlowEvent = {
-    readonly type: "START";
-    readonly input: AccountProvisionPersonalInput;
-};
-/**
- * Input accepted at machine startup. Optional — when present the
- * machine seeds context from it and skips `idle`. When absent the
- * machine sits in `idle` and waits for a `START` event.
- *
- * The `| undefined` half of this union is what lets standalone
- * callers write `createActor(machine, { input: undefined })` (or pass
- * no input via `{}`), because XState v5's `RequiredActorOptionsKeys`
- * computes `undefined extends InputFrom<TLogic> ? never : 'input'`
- * and standalone callers need that to resolve to `never`. Invoked-by-
- * parent callsites pass the populated `{ input }` shape via
- * `invoke.input` and the `context` factory below narrows it.
- */
-type ProvisioningFlowInput = {
-    readonly input: AccountProvisionPersonalInput;
-} | undefined;
-/**
- * Output emitted when the machine reaches a top-level final state
- * (`done` or `error`). Parents that invoke this machine (e.g.
- * onboarding) read this via `event.output` on their `onDone`
- * transition and branch with a guard on `event.output.error`.
- */
-type ProvisioningFlowOutput = {
-    readonly account: Account;
-    readonly error?: undefined;
-} | {
-    readonly account?: undefined;
-    readonly error: ProvisioningFlowError;
-};
-/**
- * Build the provisioning state machine bound to a `CapxulClient`
- * instance.
- *
- * States: `starting -> idle | running -> done | error`. `starting` is
- * a transient routing state: if the machine was created with input,
- * it goes straight to `running`; otherwise it falls back to `idle`
- * and waits for a `START` event. Both `done` and `error` are
- * top-level XState v5 `final` states; the machine's root-level
- * `output` mapper inspects `context` to produce
- * `{ account } | { error }` for the parent's `onDone` event.
- *
- * Per-state-node `output` is not supported in XState v5 — only the
- * machine root has an `output` mapper, which is why this file derives
- * the discriminated payload from `context.error` vs `context.account`.
- */
-declare function createProvisioningMachine(client: CapxulClient): xstate.StateMachine<ProvisioningFlowContext, {
-    readonly type: "START";
-    readonly input: AccountProvisionPersonalInput;
-}, {
-    [x: string]: xstate.ActorRefFromLogic<xstate.PromiseActorLogic<Account, {
-        input: AccountProvisionPersonalInput;
-    }, xstate.EventObject>> | undefined;
-}, {
-    src: "provisionPersonal";
-    logic: xstate.PromiseActorLogic<Account, {
-        input: AccountProvisionPersonalInput;
-    }, xstate.EventObject>;
-    id: string | undefined;
-}, {
-    type: "trackWalletCreated";
-    params: unknown;
-} | {
-    type: "trackSafeCreated";
-    params: unknown;
-}, {
-    type: "hasInput";
-    params: unknown;
-}, never, "done" | "error" | "idle" | "starting" | "running", string, {
-    readonly input: AccountProvisionPersonalInput;
-}, {
-    readonly account: Account;
-    readonly error?: undefined;
-} | {
-    readonly account?: undefined;
-    readonly error: ProvisioningFlowError;
-}, xstate.EventObject, xstate.MetaObject, {
-    id: "provisioning";
-    states: {
-        readonly starting: {};
-        readonly idle: {};
-        readonly running: {};
-        readonly done: {};
-        readonly error: {};
-    };
-}>;
-
-/**
- * Onboarding flow errors may originate from two CapxulError surfaces:
- *  - the SDK-local generic `CapxulError<Codes>` returned by
- *    `client.accounts.provisionPersonal` and constructed for synchronous
- *    pre-actor rejections (NOT_IMPLEMENTED, INVALID_INPUT)
- *  - the `@repo/config` `CapxulError` produced by the `Errors.xxx()`
- *    factory family (per `error-handling.md`) used for non-CapxulError
- *    cause wrapping and the timeout error
- *
- * Both share `.code`, `.message`, `.details`, and extend `Error`.
- */
-type OnboardingFlowError = CapxulError$1 | CapxulError;
-/** Subjects supported by the onboarding flow. */
-type OnboardingSubjectKind = "account" | "organization";
-/**
- * Input captured by the "profile" step before Safe provisioning.
- *
- * For `kind: "organization"`, `organizationName` is required (this lift
- * does not implement the org branch — see `error.code = "NOT_IMPLEMENTED"`).
- */
-type OnboardingProfileInput = {
-    readonly kind: OnboardingSubjectKind;
-    readonly username?: Username;
-    readonly displayName?: string;
-    readonly country?: string;
-    readonly organizationName?: string;
-    readonly signerProvider?: AccountProvisionPersonalInput["signerProvider"];
-};
-type OnboardingFlowContext = {
-    readonly input: OnboardingProfileInput | null;
-    readonly operationId: OperationId | null;
-    readonly account: Account | null;
-    readonly error: OnboardingFlowError | null;
-};
-type OnboardingFlowEvent = {
-    readonly type: "START_PROVISIONING";
-    readonly input: OnboardingProfileInput;
-} | {
-    readonly type: "PROCEED";
-} | {
-    readonly type: "RESET";
-};
-/**
- * Build the onboarding state machine bound to a `CapxulClient`
- * instance.
- *
- * States: `profile -> provisioning -> complete` on the happy path,
- * with `error` reachable from `profile` (validation rejections) or
- * `provisioning` (spawned-machine reported error / outer timeout /
- * unhandled child throw). `action_required` is declared for parity
- * with the public `OnboardingFlowState` type but is unreachable in
- * this lift.
- *
- * The `provisioning` state invokes a spawned `provisioningMachine`
- * (built from `createProvisioningMachine(client)`) rather than the
- * `provisionPersonal` actor directly. The child machine reports its
- * outcome via its root-level `output` (`{ account } | { error }`),
- * which the parent observes on `onDone` and branches on via guards.
- */
-declare function createOnboardingFlowMachine(client: CapxulClient): xstate.StateMachine<OnboardingFlowContext, {
-    readonly type: "START_PROVISIONING";
-    readonly input: OnboardingProfileInput;
-} | {
-    readonly type: "PROCEED";
-} | {
-    readonly type: "RESET";
-}, {
-    [x: string]: xstate.ActorRefFromLogic<xstate.StateMachine<ProvisioningFlowContext, {
-        readonly type: "START";
-        readonly input: AccountProvisionPersonalInput;
-    }, {
-        [x: string]: xstate.ActorRefFromLogic<xstate.PromiseActorLogic<Account, {
-            input: AccountProvisionPersonalInput;
-        }, xstate.EventObject>> | undefined;
-    }, {
-        src: "provisionPersonal";
-        logic: xstate.PromiseActorLogic<Account, {
-            input: AccountProvisionPersonalInput;
-        }, xstate.EventObject>;
-        id: string | undefined;
-    }, {
-        type: "trackWalletCreated";
-        params: unknown;
-    } | {
-        type: "trackSafeCreated";
-        params: unknown;
-    }, {
-        type: "hasInput";
-        params: unknown;
-    }, never, "done" | "error" | "idle" | "starting" | "running", string, {
-        readonly input: AccountProvisionPersonalInput;
-    }, {
-        readonly account: Account;
-        readonly error?: undefined;
-    } | {
-        readonly account?: undefined;
-        readonly error: ProvisioningFlowError;
-    }, xstate.EventObject, xstate.MetaObject, {
-        id: "provisioning";
-        states: {
-            readonly starting: {};
-            readonly idle: {};
-            readonly running: {};
-            readonly done: {};
-            readonly error: {};
-        };
-    }>> | undefined;
-}, {
-    src: "provisioningMachine";
-    logic: xstate.StateMachine<ProvisioningFlowContext, {
-        readonly type: "START";
-        readonly input: AccountProvisionPersonalInput;
-    }, {
-        [x: string]: xstate.ActorRefFromLogic<xstate.PromiseActorLogic<Account, {
-            input: AccountProvisionPersonalInput;
-        }, xstate.EventObject>> | undefined;
-    }, {
-        src: "provisionPersonal";
-        logic: xstate.PromiseActorLogic<Account, {
-            input: AccountProvisionPersonalInput;
-        }, xstate.EventObject>;
-        id: string | undefined;
-    }, {
-        type: "trackWalletCreated";
-        params: unknown;
-    } | {
-        type: "trackSafeCreated";
-        params: unknown;
-    }, {
-        type: "hasInput";
-        params: unknown;
-    }, never, "done" | "error" | "idle" | "starting" | "running", string, {
-        readonly input: AccountProvisionPersonalInput;
-    }, {
-        readonly account: Account;
-        readonly error?: undefined;
-    } | {
-        readonly account?: undefined;
-        readonly error: ProvisioningFlowError;
-    }, xstate.EventObject, xstate.MetaObject, {
-        id: "provisioning";
-        states: {
-            readonly starting: {};
-            readonly idle: {};
-            readonly running: {};
-            readonly done: {};
-            readonly error: {};
-        };
-    }>;
-    id: string | undefined;
-}, {
-    type: "assignOperationIdAndInput";
-    params: unknown;
-} | {
-    type: "assignOrgNotImplemented";
-    params: unknown;
-} | {
-    type: "assignMissingSigner";
-    params: unknown;
-} | {
-    type: "trackOrgSubmitted";
-    params: unknown;
-} | {
-    type: "trackPersonalSubmitted";
-    params: unknown;
-} | {
-    type: "trackOrgNotImplementedError";
-    params: unknown;
-} | {
-    type: "trackMissingSignerError";
-    params: unknown;
-} | {
-    type: "trackWalletCreating";
-    params: unknown;
-} | {
-    type: "trackOnboardingCompleted";
-    params: unknown;
-} | {
-    type: "trackProvisioningFailed";
-    params: unknown;
-} | {
-    type: "assignChildReportedError";
-    params: unknown;
-} | {
-    type: "assignChildThrown";
-    params: unknown;
-} | {
-    type: "assignAccountFromChild";
-    params: unknown;
-} | {
-    type: "resetContext";
-    params: unknown;
-}, {
-    type: "isOrg";
-    params: unknown;
-} | {
-    type: "missingSigner";
-    params: unknown;
-} | {
-    type: "childReportedError";
-    params: unknown;
-}, never, "action_required" | "provisioning" | "error" | "profile" | "complete", string, xstate.NonReducibleUnknown, xstate.NonReducibleUnknown, xstate.EventObject, xstate.MetaObject, {
-    id: "onboarding";
-    states: {
-        readonly profile: {};
-        readonly provisioning: {};
-        readonly action_required: {};
-        readonly complete: {};
-        readonly error: {};
-    };
-}>;
-
-/**
- * Exhaustive error-code dispatch per CANON.md §4.44.
- *
- * Given a `CapxulError<Codes>` and a handlers object keyed by `Codes`,
- * routes to the matching arm. TypeScript enforces exhaustiveness via
- * the mapped-key union: missing a code the method can produce is a
- * compile error, and handling a code the method CANNOT produce is a
- * compile error (the handler key isn't assignable to `Codes`).
- *
- * No `default:` arm needed — the compile-time exhaustiveness check is
- * the contract.
- */
-declare function matchError<Codes extends CapxulErrorCode$1, R>(err: CapxulError$1<Codes>, handlers: {
-    [K in Codes]: (err: CapxulError$1<K>) => R;
-}): R;
-/**
- * Exhaustive resource-status dispatch per CANON.md §4.44.
- *
- * The generic `T extends { status: string }` lets downstream callers
- * pass any discriminated-union resource (Payment, Safe, Transfer,
- * Operation, etc.). Handlers are keyed on the literal `status` values
- * declared by `T`, so passing a status not in `T["status"]` is a
- * compile error.
- */
-declare function matchStatus<T extends {
-    status: string;
-}, R>(value: T, handlers: {
-    [K in T["status"]]: (value: Extract<T, {
-        status: K;
-    }>) => R;
-}): R;
-/**
- * Exhaustive NextAction.kind dispatch per CANON.md §4.44.
- *
- * Handlers must cover every `kind` in the union `A`. `A` defaults to
- * `NextAction` from `@repo/platform-kernel` — the 8-variant canonical
- * union. CANON.md §4.58 adds a 9th variant (`confirm_fx_quote`); once
- * the kernel's `NextAction` grows, this helper automatically picks it
- * up via the generic default.
- *
- * Pass `A extends NextAction` explicitly when you need a narrower
- * variant subset (e.g. a per-method narrowing that excludes
- * `contact_support`).
- */
-declare function matchAction<A extends NextAction, R>(action: A, handlers: {
-    [K in A["kind"]]: (action: Extract<A, {
-        kind: K;
-    }>) => R;
-}): R;
-
-/**
- * Go-style error handling for async calls.
- * Returns [error, null] on failure, [null, value] on success.
- * Pure utility — no side effects, no reporter.
- */
-declare function tryCatch<T>(promise: Promise<T>): Promise<[Error, null] | [null, T]>;
-
-/**
- * Convenience constructor for a viem `Account` backed by a raw private
- * key — the CLI / server-side signer per CANON.md §4.28.
- *
- * The SDK accepts `viem.Account` directly; this helper just saves the
- * caller an import. For Openfort / MetaMask / other browser signers,
- * use `@capxul/sdk-react` (follow-up slice).
- *
- * @param privateKey `0x`-prefixed 32-byte hex string (64 hex chars).
- */
-declare function createLocalSigner(privateKey: `0x${string}`): Account$1;
-
-type SignerProvisionResult = {
-    readonly signer: Account$1;
-    readonly safeAddress: `0x${string}`;
-};
-/**
- * Headless signer auto-provisioner.
- *
- * Generates a fresh viem private-key account and deterministically derives
- * the corresponding Safe v1.4.1 address.
- *
- * No consumer computes `safeAddress` — it is derived internally and
- * returned alongside the signer so `AuthService.completeBootstrap`
- * can supply it to the backend.
- *
- * **Key persistence note:** Every call to `provision()` mints a fresh
- * private key. The caller MUST persist the returned `signer` (or its
- * private key) if the derived `safeAddress` must be recoverable in
- * future sessions. The bootstrap flow persists the signer via the
- * backend (`signerProvider` row), but direct API consumers are
- * responsible for their own key storage.
- */
-declare class SignerProvisioner {
-    provision(): SignerProvisionResult;
-}
-
-type PaymentToken = {
-    readonly address: `0x${string}`;
-    readonly decimals: number;
-    readonly symbol: string;
-};
-/**
- * Resolve a currency code to its on-chain payment token metadata.
- *
- * Currently supports USDC only (USD and USDC codes map to the same
- * token). Non-USDC codes return a `NOT_IMPLEMENTED` stub so callers
- * can scaffold multi-currency flows before the registry is fully
- * populated.
- */
-declare function resolvePaymentToken(currency: string): PaymentToken;
-
-export { Account, AccountProvisionPersonalInput, CapxulClient, CapxulError$1 as CapxulError, CapxulErrorCode$1 as CapxulErrorCode, NextAction, type OnboardingFlowContext, type OnboardingFlowError, type OnboardingFlowEvent, type OnboardingProfileInput, type OnboardingSubjectKind, OperationId, type PaymentToken, type ProvisioningFlowContext, type ProvisioningFlowError, type ProvisioningFlowEvent, type ProvisioningFlowInput, type ProvisioningFlowOutput, type SignerProvisionResult, SignerProvisioner, Username, createLocalSigner, createOnboardingFlowMachine, createProvisioningMachine as createProvisioningFlowMachine, matchAction, matchError, matchStatus, resolvePaymentToken, tryCatch };