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

package/dist/next-action-CTGl8wpy.d.cts

@@ -1,177 +0,0 @@
-/**
- * Branded ID types for every public Capxul resource.
- *
- * Every branded value MUST be created via the `to*()` constructor
- * exported alongside its type — direct casts (`raw as AccountId`) are
- * forbidden by `.claude/rules/typescript-style.md`. Constructors
- * validate the prefix pattern and throw on mismatch.
- *
- * Brand regime per `CANON.md` §A1+A2 lock (2026-04-19): the kernel
- * keeps its own `IdBrand<Name>` + `PrefixedId<Prefix, Name>` pattern
- * (independent of `@repo/types`, which was designed around earlier
- * Convex-typed SDK IDs) so the restart stack stays the brand canon.
- */
-type IdBrand<Name extends string> = string & {
-    readonly __capxulIdBrand: Name;
-};
-type PrefixedId<Prefix extends string, Name extends string> = `${Prefix}_${string}` & IdBrand<Name>;
-type AccountId = PrefixedId<"acct", "AccountId">;
-declare const toAccountId: (raw: string) => PrefixedId<"acct", "AccountId">;
-type OrganizationId = PrefixedId<"org", "OrganizationId">;
-declare const toOrganizationId: (raw: string) => PrefixedId<"org", "OrganizationId">;
-type MemberId = PrefixedId<"mb", "MemberId">;
-declare const toMemberId: (raw: string) => PrefixedId<"mb", "MemberId">;
-type SafeId = PrefixedId<"safe", "SafeId">;
-declare const toSafeId: (raw: string) => PrefixedId<"safe", "SafeId">;
-type TreasuryId = PrefixedId<"try", "TreasuryId">;
-declare const toTreasuryId: (raw: string) => PrefixedId<"try", "TreasuryId">;
-type ApiKeyId = PrefixedId<"ak", "ApiKeyId">;
-declare const toApiKeyId: (raw: string) => PrefixedId<"ak", "ApiKeyId">;
-type ServiceAccountId = PrefixedId<"svc", "ServiceAccountId">;
-type OperationId = PrefixedId<"op", "OperationId">;
-declare const toOperationId: (raw: string) => PrefixedId<"op", "OperationId">;
-type CorrelationId = PrefixedId<"ctx", "CorrelationId">;
-type KycProfileId = PrefixedId<"kyc", "KycProfileId">;
-declare const toKycProfileId: (raw: string) => PrefixedId<"kyc", "KycProfileId">;
-type KybProfileId = PrefixedId<"kyb", "KybProfileId">;
-declare const toKybProfileId: (raw: string) => PrefixedId<"kyb", "KybProfileId">;
-type PayrollEntryId = PrefixedId<"pe", "PayrollEntryId">;
-type ExternalAccountId = PrefixedId<"ext", "ExternalAccountId">;
-declare const toExternalAccountId: (raw: string) => PrefixedId<"ext", "ExternalAccountId">;
-type PaymentId = PrefixedId<"pay", "PaymentId">;
-declare const toPaymentId: (raw: string) => PrefixedId<"pay", "PaymentId">;
-type InvoiceId = PrefixedId<"inv", "InvoiceId">;
-type WithdrawalId = PrefixedId<"wd", "WithdrawalId">;
-declare const toWithdrawalId: (raw: string) => PrefixedId<"wd", "WithdrawalId">;
-type WebhookEndpointId = PrefixedId<"we", "WebhookEndpointId">;
-declare const toWebhookEndpointId: (raw: string) => PrefixedId<"we", "WebhookEndpointId">;
-type WebhookEventId = PrefixedId<"evt", "WebhookEventId">;
-declare const toWebhookEventId: (raw: string) => PrefixedId<"evt", "WebhookEventId">;
-type OutboxMessageId = PrefixedId<"out", "OutboxMessageId">;
-type Cursor = PrefixedId<"cur", "Cursor">;
-type TransactionIntentId = PrefixedId<"ti", "TransactionIntentId">;
-type SubAccountId = PrefixedId<"sub", "SubAccountId">;
-declare const toSubAccountId: (raw: string) => PrefixedId<"sub", "SubAccountId">;
-type VirtualAccountId = PrefixedId<"va", "VirtualAccountId">;
-declare const toVirtualAccountId: (raw: string) => PrefixedId<"va", "VirtualAccountId">;
-type VirtualCardId = PrefixedId<"vc", "VirtualCardId">;
-declare const toVirtualCardId: (raw: string) => PrefixedId<"vc", "VirtualCardId">;
-type TransferId = PrefixedId<"txfr", "TransferId">;
-declare const toTransferId: (raw: string) => PrefixedId<"txfr", "TransferId">;
-type DocumentId = PrefixedId<"doc", "DocumentId">;
-declare const toDocumentId: (raw: string) => PrefixedId<"doc", "DocumentId">;
-type BalanceLedgerEntryId = PrefixedId<"bal", "BalanceLedgerEntryId">;
-declare const toBalanceLedgerEntryId: (raw: string) => PrefixedId<"bal", "BalanceLedgerEntryId">;
-type PublicId = AccountId | OrganizationId | MemberId | SafeId | TreasuryId | ApiKeyId | ServiceAccountId | OperationId | CorrelationId | KycProfileId | KybProfileId | PayrollEntryId | ExternalAccountId | PaymentId | InvoiceId | WithdrawalId | WebhookEndpointId | WebhookEventId | OutboxMessageId | Cursor | TransactionIntentId | SubAccountId | VirtualAccountId | VirtualCardId | TransferId | DocumentId | BalanceLedgerEntryId;
-
-type Money = {
-    value: string;
-    currency: string;
-};
-type WalletFundingDestination = {
-    kind: "wallet_address";
-    address: string;
-    chain?: string;
-};
-type LinkedInstrumentFundingDestination = {
-    kind: "linked_instrument";
-    instrumentId: ExternalAccountId;
-};
-type ProviderInstructionFundingDestination = {
-    kind: "provider_instruction";
-    instructionId: string;
-};
-type FundingDestination = WalletFundingDestination | LinkedInstrumentFundingDestination | ProviderInstructionFundingDestination;
-type TimestampIso = string;
-/**
- * E.164-validated international phone number. Brand prevents swapping
- * with `email`, `username`, or other string identifiers (per `CANON.md`
- * §4.54 and `sdk-surface.md` §5h).
- */
-type PhoneNumber = string & {
-    readonly __capxulPhoneBrand: "PhoneNumber";
-};
-/** Validate and brand an E.164 phone number. Throws on invalid input. */
-declare function toPhoneNumber(raw: string): PhoneNumber;
-/**
- * Lowercased, shape-validated email address. Brand prevents swapping
- * with `phoneNumber`, `username`, or other string identifiers (per
- * `CANON.md` §4.54 and `sdk-surface.md` §5h).
- */
-type Email = string & {
-    readonly __capxulEmailBrand: "Email";
-};
-/** Validate, lowercase, and brand an email. Throws on invalid input. */
-declare function toEmail(raw: string): Email;
-/**
- * Public Capxul username. 3–30 chars, letter-first, lowercased,
- * remaining chars from `[a-z0-9_-]` (per `CANON.md` §4.54 and
- * `sdk-surface.md` §5h). Constructor lowercases before validating so
- * mixed-case input canonicalizes cleanly when the first char is a
- * letter; purely invalid shapes (too short, illegal chars, digit-first)
- * still throw.
- */
-type Username = string & {
-    readonly __capxulUsernameBrand: "Username";
-};
-/** Validate, lowercase, and brand a username. Throws on invalid input. */
-declare function toUsername(raw: string): Username;
-
-/**
- * Discriminated union of action-required pauses. See
- * `/docs/internal/reset/conventions` §6 for the variant
- * catalog and the "Inline vs thrown" rule (Rule D).
- *
- * §4.54 refined the `fix_destination` payload with a reason enum and
- * optional recipient metadata. §4.58 added the 9th variant
- * `confirm_fx_quote` for the cross-custody transfer FX-commit flow.
- */
-type NextAction = {
-    kind: "complete_kyc";
-    url?: string;
-    expiresAt?: TimestampIso;
-} | {
-    kind: "complete_kyb";
-    url?: string;
-    embedToken?: string;
-    expiresAt?: TimestampIso;
-} | {
-    kind: "approve_transaction";
-    intentId: TransactionIntentId;
-    url?: string;
-} | {
-    kind: "send_funds";
-    amount: Money;
-    destination: FundingDestination;
-} | {
-    kind: "follow_redirect";
-    url: string;
-    expiresAt?: TimestampIso;
-} | {
-    kind: "provide_otp";
-    channel?: "email" | "sms" | "provider";
-} | {
-    kind: "fix_destination";
-    reason: "recipient_not_yet_capxul_user" | "recipient_unreachable_email" | "destination_kyc_blocked" | "invalid_format";
-    recipient?: {
-        email?: Email;
-        phone?: PhoneNumber;
-        username?: Username;
-        invitationSentAt?: TimestampIso;
-        invitationExpiresAt?: TimestampIso;
-        signupUrl?: string;
-    };
-} | {
-    kind: "contact_support";
-    reason: string;
-} | {
-    kind: "confirm_fx_quote";
-    quoteId: string;
-    rate: string;
-    sourceAmount: Money;
-    creditAmount: Money;
-    fees?: Money;
-    expiresAt: TimestampIso;
-};
-
-export { type AccountId as A, type BalanceLedgerEntryId as B, type CorrelationId as C, type DocumentId as D, type Email as E, toTransferId as F, toTreasuryId as G, toUsername as H, toVirtualAccountId as I, toVirtualCardId as J, type KybProfileId as K, toWebhookEndpointId as L, type MemberId as M, type NextAction as N, type OperationId as O, type PaymentId as P, toWebhookEventId as Q, toWithdrawalId as R, type SafeId as S, type TransactionIntentId as T, type Username as U, type VirtualAccountId as V, type WebhookEndpointId as W, type TimestampIso as X, type PublicId as Y, type ApiKeyId as a, type ExternalAccountId as b, type KycProfileId as c, type OrganizationId as d, type PhoneNumber as e, type SubAccountId as f, type TransferId as g, type TreasuryId as h, type VirtualCardId as i, type WebhookEventId as j, type WithdrawalId as k, toApiKeyId as l, toBalanceLedgerEntryId as m, toDocumentId as n, toEmail as o, toExternalAccountId as p, toKybProfileId as q, toKycProfileId as r, toMemberId as s, toAccountId as t, toOperationId as u, toOrganizationId as v, toPaymentId as w, toPhoneNumber as x, toSafeId as y, toSubAccountId as z };

package/dist/next-action-CTGl8wpy.d.ts

@@ -1,177 +0,0 @@
-/**
- * Branded ID types for every public Capxul resource.
- *
- * Every branded value MUST be created via the `to*()` constructor
- * exported alongside its type — direct casts (`raw as AccountId`) are
- * forbidden by `.claude/rules/typescript-style.md`. Constructors
- * validate the prefix pattern and throw on mismatch.
- *
- * Brand regime per `CANON.md` §A1+A2 lock (2026-04-19): the kernel
- * keeps its own `IdBrand<Name>` + `PrefixedId<Prefix, Name>` pattern
- * (independent of `@repo/types`, which was designed around earlier
- * Convex-typed SDK IDs) so the restart stack stays the brand canon.
- */
-type IdBrand<Name extends string> = string & {
-    readonly __capxulIdBrand: Name;
-};
-type PrefixedId<Prefix extends string, Name extends string> = `${Prefix}_${string}` & IdBrand<Name>;
-type AccountId = PrefixedId<"acct", "AccountId">;
-declare const toAccountId: (raw: string) => PrefixedId<"acct", "AccountId">;
-type OrganizationId = PrefixedId<"org", "OrganizationId">;
-declare const toOrganizationId: (raw: string) => PrefixedId<"org", "OrganizationId">;
-type MemberId = PrefixedId<"mb", "MemberId">;
-declare const toMemberId: (raw: string) => PrefixedId<"mb", "MemberId">;
-type SafeId = PrefixedId<"safe", "SafeId">;
-declare const toSafeId: (raw: string) => PrefixedId<"safe", "SafeId">;
-type TreasuryId = PrefixedId<"try", "TreasuryId">;
-declare const toTreasuryId: (raw: string) => PrefixedId<"try", "TreasuryId">;
-type ApiKeyId = PrefixedId<"ak", "ApiKeyId">;
-declare const toApiKeyId: (raw: string) => PrefixedId<"ak", "ApiKeyId">;
-type ServiceAccountId = PrefixedId<"svc", "ServiceAccountId">;
-type OperationId = PrefixedId<"op", "OperationId">;
-declare const toOperationId: (raw: string) => PrefixedId<"op", "OperationId">;
-type CorrelationId = PrefixedId<"ctx", "CorrelationId">;
-type KycProfileId = PrefixedId<"kyc", "KycProfileId">;
-declare const toKycProfileId: (raw: string) => PrefixedId<"kyc", "KycProfileId">;
-type KybProfileId = PrefixedId<"kyb", "KybProfileId">;
-declare const toKybProfileId: (raw: string) => PrefixedId<"kyb", "KybProfileId">;
-type PayrollEntryId = PrefixedId<"pe", "PayrollEntryId">;
-type ExternalAccountId = PrefixedId<"ext", "ExternalAccountId">;
-declare const toExternalAccountId: (raw: string) => PrefixedId<"ext", "ExternalAccountId">;
-type PaymentId = PrefixedId<"pay", "PaymentId">;
-declare const toPaymentId: (raw: string) => PrefixedId<"pay", "PaymentId">;
-type InvoiceId = PrefixedId<"inv", "InvoiceId">;
-type WithdrawalId = PrefixedId<"wd", "WithdrawalId">;
-declare const toWithdrawalId: (raw: string) => PrefixedId<"wd", "WithdrawalId">;
-type WebhookEndpointId = PrefixedId<"we", "WebhookEndpointId">;
-declare const toWebhookEndpointId: (raw: string) => PrefixedId<"we", "WebhookEndpointId">;
-type WebhookEventId = PrefixedId<"evt", "WebhookEventId">;
-declare const toWebhookEventId: (raw: string) => PrefixedId<"evt", "WebhookEventId">;
-type OutboxMessageId = PrefixedId<"out", "OutboxMessageId">;
-type Cursor = PrefixedId<"cur", "Cursor">;
-type TransactionIntentId = PrefixedId<"ti", "TransactionIntentId">;
-type SubAccountId = PrefixedId<"sub", "SubAccountId">;
-declare const toSubAccountId: (raw: string) => PrefixedId<"sub", "SubAccountId">;
-type VirtualAccountId = PrefixedId<"va", "VirtualAccountId">;
-declare const toVirtualAccountId: (raw: string) => PrefixedId<"va", "VirtualAccountId">;
-type VirtualCardId = PrefixedId<"vc", "VirtualCardId">;
-declare const toVirtualCardId: (raw: string) => PrefixedId<"vc", "VirtualCardId">;
-type TransferId = PrefixedId<"txfr", "TransferId">;
-declare const toTransferId: (raw: string) => PrefixedId<"txfr", "TransferId">;
-type DocumentId = PrefixedId<"doc", "DocumentId">;
-declare const toDocumentId: (raw: string) => PrefixedId<"doc", "DocumentId">;
-type BalanceLedgerEntryId = PrefixedId<"bal", "BalanceLedgerEntryId">;
-declare const toBalanceLedgerEntryId: (raw: string) => PrefixedId<"bal", "BalanceLedgerEntryId">;
-type PublicId = AccountId | OrganizationId | MemberId | SafeId | TreasuryId | ApiKeyId | ServiceAccountId | OperationId | CorrelationId | KycProfileId | KybProfileId | PayrollEntryId | ExternalAccountId | PaymentId | InvoiceId | WithdrawalId | WebhookEndpointId | WebhookEventId | OutboxMessageId | Cursor | TransactionIntentId | SubAccountId | VirtualAccountId | VirtualCardId | TransferId | DocumentId | BalanceLedgerEntryId;
-
-type Money = {
-    value: string;
-    currency: string;
-};
-type WalletFundingDestination = {
-    kind: "wallet_address";
-    address: string;
-    chain?: string;
-};
-type LinkedInstrumentFundingDestination = {
-    kind: "linked_instrument";
-    instrumentId: ExternalAccountId;
-};
-type ProviderInstructionFundingDestination = {
-    kind: "provider_instruction";
-    instructionId: string;
-};
-type FundingDestination = WalletFundingDestination | LinkedInstrumentFundingDestination | ProviderInstructionFundingDestination;
-type TimestampIso = string;
-/**
- * E.164-validated international phone number. Brand prevents swapping
- * with `email`, `username`, or other string identifiers (per `CANON.md`
- * §4.54 and `sdk-surface.md` §5h).
- */
-type PhoneNumber = string & {
-    readonly __capxulPhoneBrand: "PhoneNumber";
-};
-/** Validate and brand an E.164 phone number. Throws on invalid input. */
-declare function toPhoneNumber(raw: string): PhoneNumber;
-/**
- * Lowercased, shape-validated email address. Brand prevents swapping
- * with `phoneNumber`, `username`, or other string identifiers (per
- * `CANON.md` §4.54 and `sdk-surface.md` §5h).
- */
-type Email = string & {
-    readonly __capxulEmailBrand: "Email";
-};
-/** Validate, lowercase, and brand an email. Throws on invalid input. */
-declare function toEmail(raw: string): Email;
-/**
- * Public Capxul username. 3–30 chars, letter-first, lowercased,
- * remaining chars from `[a-z0-9_-]` (per `CANON.md` §4.54 and
- * `sdk-surface.md` §5h). Constructor lowercases before validating so
- * mixed-case input canonicalizes cleanly when the first char is a
- * letter; purely invalid shapes (too short, illegal chars, digit-first)
- * still throw.
- */
-type Username = string & {
-    readonly __capxulUsernameBrand: "Username";
-};
-/** Validate, lowercase, and brand a username. Throws on invalid input. */
-declare function toUsername(raw: string): Username;
-
-/**
- * Discriminated union of action-required pauses. See
- * `/docs/internal/reset/conventions` §6 for the variant
- * catalog and the "Inline vs thrown" rule (Rule D).
- *
- * §4.54 refined the `fix_destination` payload with a reason enum and
- * optional recipient metadata. §4.58 added the 9th variant
- * `confirm_fx_quote` for the cross-custody transfer FX-commit flow.
- */
-type NextAction = {
-    kind: "complete_kyc";
-    url?: string;
-    expiresAt?: TimestampIso;
-} | {
-    kind: "complete_kyb";
-    url?: string;
-    embedToken?: string;
-    expiresAt?: TimestampIso;
-} | {
-    kind: "approve_transaction";
-    intentId: TransactionIntentId;
-    url?: string;
-} | {
-    kind: "send_funds";
-    amount: Money;
-    destination: FundingDestination;
-} | {
-    kind: "follow_redirect";
-    url: string;
-    expiresAt?: TimestampIso;
-} | {
-    kind: "provide_otp";
-    channel?: "email" | "sms" | "provider";
-} | {
-    kind: "fix_destination";
-    reason: "recipient_not_yet_capxul_user" | "recipient_unreachable_email" | "destination_kyc_blocked" | "invalid_format";
-    recipient?: {
-        email?: Email;
-        phone?: PhoneNumber;
-        username?: Username;
-        invitationSentAt?: TimestampIso;
-        invitationExpiresAt?: TimestampIso;
-        signupUrl?: string;
-    };
-} | {
-    kind: "contact_support";
-    reason: string;
-} | {
-    kind: "confirm_fx_quote";
-    quoteId: string;
-    rate: string;
-    sourceAmount: Money;
-    creditAmount: Money;
-    fees?: Money;
-    expiresAt: TimestampIso;
-};
-
-export { type AccountId as A, type BalanceLedgerEntryId as B, type CorrelationId as C, type DocumentId as D, type Email as E, toTransferId as F, toTreasuryId as G, toUsername as H, toVirtualAccountId as I, toVirtualCardId as J, type KybProfileId as K, toWebhookEndpointId as L, type MemberId as M, type NextAction as N, type OperationId as O, type PaymentId as P, toWebhookEventId as Q, toWithdrawalId as R, type SafeId as S, type TransactionIntentId as T, type Username as U, type VirtualAccountId as V, type WebhookEndpointId as W, type TimestampIso as X, type PublicId as Y, type ApiKeyId as a, type ExternalAccountId as b, type KycProfileId as c, type OrganizationId as d, type PhoneNumber as e, type SubAccountId as f, type TransferId as g, type TreasuryId as h, type VirtualCardId as i, type WebhookEventId as j, type WithdrawalId as k, toApiKeyId as l, toBalanceLedgerEntryId as m, toDocumentId as n, toEmail as o, toExternalAccountId as p, toKybProfileId as q, toKycProfileId as r, toMemberId as s, toAccountId as t, toOperationId as u, toOrganizationId as v, toPaymentId as w, toPhoneNumber as x, toSafeId as y, toSubAccountId as z };