@capxul/sdk-react 0.2.0-alpha.4 → 1.0.0-alpha.10

package/dist/index.d.mts

@@ -0,0 +1,658 @@
+import { ReactNode } from "react";
+import { QueryClient, UseMutationResult, UseQueryResult } from "@tanstack/react-query";
+import { Account, AccountLifecycle, AccountRequirement, ActorRequest, ActorRequestIssueInput, AddressBookAddInput, AddressBookEntry, AddressBookLabelInput, AssignRoleInput, CapxulClient, CapxulSigner, CompleteOrganizationOnboardingInput, CompleteOrganizationOnboardingResult, CompletePersonalOnboardingInput, CompletePersonalOnboardingResult, CreateOrgInput, Destination, DestinationAddInput, DestinationListInput, DestinationRemoveInput, InboxApproveInput, InboxItem, InsightsSummary as InsightsSummary$1, InviteMemberInput, MemberView, OrgId, OrgView, Payment, PaymentsPayInput, PaymentsPayoutInput, PaymentsWithdrawInput, PayrollRosterAddInput, PayrollRosterLine, PayrollRunInput, Profile, ReconciliationEntry, RemoveMemberInput, RoleView, Session, TransferInput, TransferResult } from "@capxul/sdk";
+
+//#region src/provider.d.ts
+type CapxulProviderSharedProps = {
+  /** Bring your own QueryClient; otherwise the provider creates one. */readonly queryClient?: QueryClient;
+  readonly children: ReactNode;
+};
+/** Browser / app path — the provider bootstraps the client from a publishable key. */
+type CapxulProviderPublishableKeyProps = CapxulProviderSharedProps & {
+  readonly publishableKey: string;
+  readonly client?: never; /** Init-time account readiness target. Default `"none"`. */
+  readonly requirement?: AccountRequirement;
+  /**
+   * Optional consumer-held signer for the deploy lane. Omitted in browser apps
+   * with `requirement: "deployed"` — the SDK wires Openfort from bootstrap.
+   */
+  readonly signer?: CapxulSigner;
+};
+/**
+ * Node / server / test path — a pre-built client is supplied; lifecycle stays
+ * with the caller. Mutually exclusive with `publishableKey`.
+ */
+type CapxulProviderInjectedClientProps = CapxulProviderSharedProps & {
+  readonly client: CapxulClient;
+  readonly publishableKey?: never;
+  readonly requirement?: never;
+  readonly signer?: never;
+};
+type CapxulProviderProps = CapxulProviderPublishableKeyProps | CapxulProviderInjectedClientProps;
+declare function CapxulProvider(props: CapxulProviderProps): import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region ../errors/src/errors.d.ts
+declare const CAPXUL_ERROR_CODES: readonly ["NOT_AUTHENTICATED", "EMAIL_DELIVERY_FAILED", "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", "ROLE_PERMISSION_DENIED", "TRANSACTION_FAILED", "RATE_LIMITED", "NETWORK_ERROR", "UNKNOWN", "OTP_EXPIRED", "SIGNER_REJECTED", "CANCELLED", "WRONG_STATE"];
+type CapxulErrorCode = (typeof CAPXUL_ERROR_CODES)[number];
+/**
+ * Why an auth/provider call failed — a flat CAUSE enum. The *where* (which
+ * OpenFort operation) stays in the separate `operation` detail field; this
+ * names the root cause so a single `$exception` can be triaged without
+ * parsing the message. Five members, no free strings:
+ *
+ * - `auth-origin-mismatch`: OTP cookies live on `localhost:PORT` but OpenFort
+ *   hits the Convex host → no session reaches the provider.
+ * - `stale-openfort-cache`: an old `userId` in scoped storage makes the SDK
+ *   skip re-auth → 401 on `v2/accounts`.
+ * - `app-env-allowlist`: missing `VITE_CAPXUL_CONVEX_SITE_URL` / the origin is
+ *   not allowlisted → 401.
+ * - `no-secure-context`: sandboxed/headless browser with no Web Crypto, so
+ *   `getAddress`/`configure` can never produce an address. Previously vanished
+ *   into `unknown`; the signer's secure-context probe now names it.
+ * - `unknown`: catch-all when no cause could be determined.
+ */
+type FailureMode = "auth-origin-mismatch" | "stale-openfort-cache" | "app-env-allowlist" | "no-secure-context" | "unknown";
+type CapxulErrorDetails = Record<string, unknown>;
+type CapxulErrorOptions = {
+  readonly cause?: unknown;
+  readonly details?: CapxulErrorDetails;
+  readonly correlationId?: string;
+  readonly layer?: string;
+};
+declare class CapxulError extends Error {
+  readonly code: CapxulErrorCode;
+  readonly details?: CapxulErrorDetails;
+  readonly correlationId?: string;
+  readonly layer?: string;
+  constructor(code: CapxulErrorCode, message: string, options?: CapxulErrorOptions);
+}
+//#endregion
+//#region src/internal/capxul-bootstrap-context.d.ts
+type CapxulBootstrapStatus = "bootstrapping" | "ready" | "error";
+interface CapxulBootstrapState {
+  readonly status: CapxulBootstrapStatus;
+  readonly error: CapxulError | null;
+  readonly retry: () => void;
+}
+declare function useCapxul(): CapxulBootstrapState;
+//#endregion
+//#region src/internal/capxul-client-context.d.ts
+/**
+ * Returns the client, or `null` while `<CapxulProvider>` is still bootstrapping.
+ * Data hooks use this so they can sit in `isPending` (disabled query) until the
+ * client resolves, rather than throwing during bootstrap.
+ */
+declare function useCapxulClientOrNull(): CapxulClient | null;
+//#endregion
+//#region src/hooks/use-capxul-session.d.ts
+type UseCapxulSessionReturn = UseQueryResult<Session | null, CapxulError>;
+declare function useCapxulSession(): UseCapxulSessionReturn;
+//#endregion
+//#region src/hooks/use-capxul-profile.d.ts
+type UseCapxulProfileReturn = UseQueryResult<Profile | null, CapxulError>;
+declare function useCapxulProfile(): UseCapxulProfileReturn;
+//#endregion
+//#region src/hooks/use-capxul-account-lifecycle.d.ts
+interface UseCapxulAccountLifecycleReturn {
+  readonly lifecycle: AccountLifecycle;
+  readonly isSettingUp: boolean;
+  readonly error: CapxulError | null;
+  readonly isLoading: boolean;
+  readonly isFetching: boolean;
+  readonly isError: boolean;
+  readonly retry: UseMutationResult<AccountLifecycle, CapxulError, void>["mutateAsync"];
+  readonly isRetrying: boolean;
+}
+declare function useCapxulAccountLifecycle(): UseCapxulAccountLifecycleReturn;
+//#endregion
+//#region src/hooks/use-capxul-account-balance.d.ts
+type UseCapxulAccountBalanceReturn = UseQueryResult<Account, CapxulError>;
+type UseCapxulAccountBalanceOptions = {
+  /** When false, skips the Convex readBalance action until the account ladder is ready. */readonly enabled?: boolean;
+};
+declare function useCapxulAccountBalance(options?: UseCapxulAccountBalanceOptions): UseCapxulAccountBalanceReturn;
+//#endregion
+//#region ../types/src/brand.d.ts
+/**
+ * Nominal type helper. `Brand<T, B>` is structurally a `T` at runtime but
+ * distinct at compile time, preventing accidental swaps between primitives.
+ *
+ * @internal
+ */
+declare const brand: unique symbol;
+type Brand<T, B extends string> = T & {
+  readonly [brand]: B;
+};
+//#endregion
+//#region ../types/src/index.d.ts
+type Money = {
+  readonly currency: CurrencyCode;
+  readonly value: string;
+  readonly decimals: number;
+};
+type Account$1 = {
+  readonly id: AccountId;
+  readonly balance: Money;
+  readonly available: Money;
+};
+/** Named bucket partitioning a logical Account (canon §9). */
+type SubAccount = {
+  readonly id: SubAccountId;
+  readonly accountId: AccountId;
+  readonly name: string;
+  readonly balance: Money;
+  readonly createdAt: EpochMs;
+};
+type AccountId = Brand<string, "AccountId">;
+type SubAccountId = Brand<string, "SubAccountId">;
+type OrgId$1 = Brand<string, "OrgId">;
+type EpochMs = Brand<number, "EpochMs">;
+type CurrencyCode = Brand<SupportedCurrencyCode, "CurrencyCode">;
+declare const SUPPORTED_CURRENCIES: readonly [{
+  readonly code: "USD";
+  readonly symbol: "$";
+  readonly name: "US Dollar";
+}, {
+  readonly code: "NGN";
+  readonly symbol: "NGN";
+  readonly name: "Nigerian Naira";
+}, {
+  readonly code: "GHS";
+  readonly symbol: "GHS";
+  readonly name: "Ghanaian Cedi";
+}, {
+  readonly code: "KES";
+  readonly symbol: "KSh";
+  readonly name: "Kenyan Shilling";
+}, {
+  readonly code: "UGX";
+  readonly symbol: "USh";
+  readonly name: "Ugandan Shilling";
+}];
+type SupportedCurrencyCode = (typeof SUPPORTED_CURRENCIES)[number]["code"];
+//#endregion
+//#region src/hooks/use-capxul-account-fund.d.ts
+type UseCapxulAccountFundReturn = UseMutationResult<{
+  readonly txHash: string;
+}, CapxulError, Money>;
+declare function useCapxulAccountFund(): UseCapxulAccountFundReturn;
+//#endregion
+//#region src/hooks/use-capxul-sign-in.d.ts
+interface SignInInput {
+  readonly email: string;
+}
+interface SignInSuccess {
+  readonly sessionId: string;
+  readonly expiresAt: number;
+}
+type UseCapxulSignInReturn = UseMutationResult<SignInSuccess, CapxulError, SignInInput>;
+declare function useCapxulSignIn(): UseCapxulSignInReturn;
+//#endregion
+//#region src/hooks/use-capxul-verify-otp.d.ts
+interface VerifyOtpInput {
+  readonly email: string;
+  readonly code: string;
+}
+type UseCapxulVerifyOtpReturn = UseMutationResult<Session, CapxulError, VerifyOtpInput>;
+declare function useCapxulVerifyOtp(): UseCapxulVerifyOtpReturn;
+//#endregion
+//#region src/hooks/use-capxul-sign-out.d.ts
+type UseCapxulSignOutReturn = UseMutationResult<void, CapxulError, void>;
+declare function useCapxulSignOut(): UseCapxulSignOutReturn;
+//#endregion
+//#region src/hooks/use-capxul-sub-accounts.d.ts
+type UseCapxulSubAccountsListOptions = {
+  readonly enabled?: boolean;
+};
+type UseCapxulSubAccountsListReturn = UseQueryResult<readonly SubAccount[], CapxulError>;
+declare function useCapxulSubAccountsList(accountId: AccountId | undefined, options?: UseCapxulSubAccountsListOptions): UseCapxulSubAccountsListReturn;
+type UseCapxulSubAccountCreateReturn = UseMutationResult<SubAccount, CapxulError, {
+  readonly accountId: AccountId;
+  readonly name: string;
+}>;
+declare function useCapxulSubAccountCreate(): UseCapxulSubAccountCreateReturn;
+type UseCapxulSubAccountRenameReturn = UseMutationResult<SubAccount, CapxulError, {
+  readonly accountId: AccountId;
+  readonly subAccountId: SubAccountId;
+  readonly name: string;
+}>;
+declare function useCapxulSubAccountRename(): UseCapxulSubAccountRenameReturn;
+type UseCapxulSubAccountDeleteReturn = UseMutationResult<void, CapxulError, {
+  readonly accountId: AccountId;
+  readonly subAccountId: SubAccountId;
+}>;
+declare function useCapxulSubAccountDelete(): UseCapxulSubAccountDeleteReturn;
+/**
+ * Move money between two of the SAME Account's balances (canon §5/§12). The
+ * consumer-facing labels are "Add money" (main → sub) and "Move money out"
+ * (sub → main), both calling `transfer`. `accountId` is carried only to
+ * invalidate the right cache keys; the SDK input itself is `{ from, to, amount }`.
+ */
+type UseCapxulTransferReturn = UseMutationResult<TransferResult, CapxulError, {
+  readonly accountId: AccountId;
+} & TransferInput>;
+declare function useCapxulTransfer(): UseCapxulTransferReturn;
+//#endregion
+//#region src/hooks/use-capxul-money.d.ts
+type UseCapxulPayReturn = UseMutationResult<Payment, CapxulError, PaymentsPayInput>;
+declare function useCapxulPay(): UseCapxulPayReturn;
+type UseCapxulPayoutReturn = UseMutationResult<Payment, CapxulError, PaymentsPayoutInput>;
+declare function useCapxulPayout(): UseCapxulPayoutReturn;
+type UseCapxulWithdrawReturn = UseMutationResult<Payment, CapxulError, PaymentsWithdrawInput>;
+declare function useCapxulWithdraw(): UseCapxulWithdrawReturn;
+type UseCapxulPaymentsReturn = UseQueryResult<readonly Payment[], CapxulError>;
+declare function useCapxulPayments(options?: {
+  readonly enabled?: boolean;
+}): UseCapxulPaymentsReturn;
+type UseCapxulPaymentReturn = UseQueryResult<Payment | null, CapxulError>;
+declare function useCapxulPayment(paymentId: string | undefined, options?: {
+  readonly enabled?: boolean;
+}): UseCapxulPaymentReturn;
+//#endregion
+//#region src/internal/reactivity-keys.d.ts
+type ReactActorScope = {
+  readonly kind: "account";
+} | {
+  readonly kind: "org";
+  readonly orgId: string;
+};
+//#endregion
+//#region src/hooks/use-capxul-actor-scope.d.ts
+type CapxulActorScope = ReactActorScope;
+declare const capxulAccountScope: {
+  readonly kind: "account";
+};
+declare function capxulOrgScope(orgId: OrgId$1 | undefined): CapxulActorScope | undefined;
+type UseCapxulAddressBookReturn = UseQueryResult<readonly AddressBookEntry[], CapxulError>;
+declare function useCapxulAddressBook(actor: CapxulActorScope | undefined, options?: {
+  readonly enabled?: boolean;
+}): UseCapxulAddressBookReturn;
+type UseCapxulAddressBookEntryReturn = UseQueryResult<AddressBookEntry | null, CapxulError>;
+declare function useCapxulAddressBookEntry(actor: CapxulActorScope | undefined, entryId: string | undefined, options?: {
+  readonly enabled?: boolean;
+}): UseCapxulAddressBookEntryReturn;
+type AddressBookMutation<TData, TVariables> = UseMutationResult<TData, CapxulError, TVariables>;
+type UseCapxulAddAddressBookEntryReturn = AddressBookMutation<AddressBookEntry, AddressBookAddInput>;
+declare const useCapxulAddAddressBookEntry: (actor?: CapxulActorScope | undefined) => AddressBookMutation<AddressBookEntry, AddressBookAddInput>;
+type UseCapxulHideAddressBookEntryReturn = AddressBookMutation<AddressBookEntry, string>;
+declare const useCapxulHideAddressBookEntry: (actor?: CapxulActorScope | undefined) => AddressBookMutation<AddressBookEntry, string>;
+type UseCapxulUnhideAddressBookEntryReturn = AddressBookMutation<AddressBookEntry, string>;
+declare const useCapxulUnhideAddressBookEntry: (actor?: CapxulActorScope | undefined) => AddressBookMutation<AddressBookEntry, string>;
+type UseCapxulLabelAddressBookEntryReturn = AddressBookMutation<AddressBookEntry, AddressBookLabelInput>;
+declare const useCapxulLabelAddressBookEntry: (actor?: CapxulActorScope | undefined) => AddressBookMutation<AddressBookEntry, AddressBookLabelInput>;
+type UseCapxulRequestsReturn = UseQueryResult<readonly ActorRequest[], CapxulError>;
+declare function useCapxulRequests(actor: CapxulActorScope | undefined, options?: {
+  readonly enabled?: boolean;
+}): UseCapxulRequestsReturn;
+type UseCapxulRequestReturn = UseQueryResult<ActorRequest | null, CapxulError>;
+declare function useCapxulRequest(actor: CapxulActorScope | undefined, requestId: string | undefined, options?: {
+  readonly enabled?: boolean;
+}): UseCapxulRequestReturn;
+type UseCapxulIssueRequestReturn = UseMutationResult<ActorRequest, CapxulError, ActorRequestIssueInput>;
+declare const useCapxulIssueRequest: (actor?: CapxulActorScope | undefined) => UseMutationResult<ActorRequest, CapxulError, ActorRequestIssueInput>;
+type UseCapxulCancelRequestReturn = UseMutationResult<ActorRequest, CapxulError, string>;
+declare const useCapxulCancelRequest: (actor?: CapxulActorScope | undefined) => UseMutationResult<ActorRequest, CapxulError, string>;
+type UseCapxulReconcileRequestsReturn = UseMutationResult<readonly ReconciliationEntry[], CapxulError, void>;
+declare const useCapxulReconcileRequests: (actor?: CapxulActorScope | undefined) => UseMutationResult<readonly ReconciliationEntry[], CapxulError, unknown>;
+type UseCapxulInboxReturn = UseQueryResult<readonly InboxItem[], CapxulError>;
+declare function useCapxulInbox(actor: CapxulActorScope | undefined, options?: {
+  readonly enabled?: boolean;
+}): UseCapxulInboxReturn;
+type UseCapxulApproveInboxRequestReturn = UseMutationResult<Payment, CapxulError, InboxApproveInput>;
+declare const useCapxulApproveInboxRequest: (actor?: CapxulActorScope | undefined) => UseMutationResult<Payment, CapxulError, InboxApproveInput>;
+type UseCapxulDeclineInboxRequestReturn = UseMutationResult<InboxItem, CapxulError, string>;
+declare const useCapxulDeclineInboxRequest: (actor?: CapxulActorScope | undefined) => UseMutationResult<InboxItem, CapxulError, string>;
+type UseCapxulInsightsSummaryReturn = UseQueryResult<InsightsSummary$1, CapxulError>;
+declare function useCapxulInsightsSummary(actor: CapxulActorScope | undefined, options?: {
+  readonly enabled?: boolean;
+}): UseCapxulInsightsSummaryReturn;
+type UseCapxulInsightsHistoryReturn = UseQueryResult<readonly Payment[], CapxulError>;
+declare function useCapxulInsightsHistory(actor: CapxulActorScope | undefined, options?: {
+  readonly enabled?: boolean;
+}): UseCapxulInsightsHistoryReturn;
+//#endregion
+//#region src/hooks/use-capxul-destinations.d.ts
+type UseCapxulDestinationsReturn = UseQueryResult<readonly Destination[], CapxulError>;
+declare function useCapxulDestinations(input: DestinationListInput | undefined, options?: {
+  readonly enabled?: boolean;
+}): UseCapxulDestinationsReturn;
+type UseCapxulAddDestinationReturn = UseMutationResult<Destination, CapxulError, DestinationAddInput>;
+declare function useCapxulAddDestination(): UseCapxulAddDestinationReturn;
+type UseCapxulRemoveDestinationReturn = UseMutationResult<{
+  readonly id: string;
+}, CapxulError, DestinationRemoveInput>;
+declare function useCapxulRemoveDestination(): UseCapxulRemoveDestinationReturn;
+//#endregion
+//#region src/hooks/use-capxul-payroll.d.ts
+type UseCapxulPayrollRosterReturn = UseQueryResult<readonly PayrollRosterLine[], CapxulError>;
+declare function useCapxulPayrollRoster(orgId: OrgId$1 | undefined, options?: {
+  readonly enabled?: boolean;
+}): UseCapxulPayrollRosterReturn;
+type UseCapxulAddPayrollRosterLineReturn = UseMutationResult<PayrollRosterLine, CapxulError, PayrollRosterAddInput>;
+declare const useCapxulAddPayrollRosterLine: (orgId: OrgId$1 | undefined) => UseMutationResult<PayrollRosterLine, CapxulError, PayrollRosterAddInput>;
+type UseCapxulUpdatePayrollRosterLineInput = {
+  readonly rosterLineId: string;
+  readonly input: Partial<PayrollRosterAddInput>;
+};
+type UseCapxulUpdatePayrollRosterLineReturn = UseMutationResult<PayrollRosterLine, CapxulError, UseCapxulUpdatePayrollRosterLineInput>;
+declare const useCapxulUpdatePayrollRosterLine: (orgId: OrgId$1 | undefined) => UseMutationResult<PayrollRosterLine, CapxulError, UseCapxulUpdatePayrollRosterLineInput>;
+type UseCapxulRemovePayrollRosterLineReturn = UseMutationResult<PayrollRosterLine, CapxulError, string>;
+declare const useCapxulRemovePayrollRosterLine: (orgId: OrgId$1 | undefined) => UseMutationResult<PayrollRosterLine, CapxulError, string>;
+type UseCapxulRunPayrollReturn = UseMutationResult<readonly Payment[], CapxulError, PayrollRunInput>;
+declare const useCapxulRunPayroll: (orgId: OrgId$1 | undefined) => UseMutationResult<readonly Payment[], CapxulError, PayrollRunInput>;
+//#endregion
+//#region src/hooks/use-capxul-orgs.d.ts
+/**
+ * List the Orgs you belong to (canon §C1 "Org list" / §C3). Binds directly to
+ * the locked `capxul.orgs()` SDK method.
+ */
+type UseCapxulOrgsReturn = UseQueryResult<readonly OrgView[], CapxulError>;
+type UseCapxulOrgsOptions = {
+  /**
+   * Gate the query on auth readiness. `client.orgs()` is a session-scoped
+   * authenticated read; firing it before the session token settles surfaces a
+   * spurious `NOT_AUTHENTICATED`. Consumers pass `enabled: <auth-ready>` (e.g.
+   * "the Organization surface is active") — mirrors `useCapxulSubAccountsList`.
+   * Defaults to `true` to preserve the bare `useCapxulOrgs()` call shape.
+   */
+  readonly enabled?: boolean;
+};
+declare function useCapxulOrgs(options?: UseCapxulOrgsOptions): UseCapxulOrgsReturn;
+//#endregion
+//#region src/hooks/use-capxul-org.d.ts
+type UseCapxulOrgOptions = {
+  readonly enabled?: boolean;
+};
+/**
+ * A single Org you belong to, resolved from `capxul.orgs()` and narrowed to the
+ * requested `orgId` (canon §C3). Returns `null` when the Org is not in your list.
+ * Gated by `orgId !== undefined`. RED until S1.
+ */
+type UseCapxulOrgReturn = UseQueryResult<OrgView | null, CapxulError>;
+declare function useCapxulOrg(orgId: OrgId | undefined, options?: UseCapxulOrgOptions): UseCapxulOrgReturn;
+//#endregion
+//#region src/hooks/use-capxul-org-members.d.ts
+type UseCapxulOrgMembersOptions = {
+  readonly enabled?: boolean;
+};
+/**
+ * The members of an Org (canon §C1 "Members" / §C3, D8/D9). Binds directly to
+ * the entity-scoped `capxul.org(orgId).members()` (D13). Gated by
+ * `orgId !== undefined`. RED until S3.
+ */
+type UseCapxulOrgMembersReturn = UseQueryResult<readonly MemberView[], CapxulError>;
+declare function useCapxulOrgMembers(orgId: OrgId | undefined, options?: UseCapxulOrgMembersOptions): UseCapxulOrgMembersReturn;
+//#endregion
+//#region src/hooks/use-capxul-org-roles.d.ts
+type UseCapxulOrgRolesOptions = {
+  readonly enabled?: boolean;
+};
+/**
+ * The roles seeded on an Org (canon §C1 "Roles" / §C3, D4/D6). Binds directly
+ * to the entity-scoped `capxul.org(orgId).roles()` (D13). Gated by
+ * `orgId !== undefined`. RED until S2.
+ */
+type UseCapxulOrgRolesReturn = UseQueryResult<readonly RoleView[], CapxulError>;
+declare function useCapxulOrgRoles(orgId: OrgId | undefined, options?: UseCapxulOrgRolesOptions): UseCapxulOrgRolesReturn;
+//#endregion
+//#region src/hooks/use-capxul-org-deploy-roles.d.ts
+type UseCapxulOrgDeployRolesReturn = UseMutationResult<readonly RoleView[], CapxulError, OrgId>;
+declare function useCapxulOrgDeployRoles(): UseCapxulOrgDeployRolesReturn;
+//#endregion
+//#region src/hooks/use-capxul-org-treasury.d.ts
+type UseCapxulOrgTreasuryOptions = {
+  readonly enabled?: boolean;
+};
+/**
+ * The Org treasury — the real M2 `Account` over the Org Safe (canon §C3, D3).
+ * NEVER `AccountStatus` (the deploy-readiness ladder, no balance). Binds
+ * directly to the entity-scoped `capxul.org(orgId).treasury()` (D13). Gated by
+ * `orgId !== undefined`. RED until S1.
+ */
+type UseCapxulOrgTreasuryReturn = UseQueryResult<Account$1, CapxulError>;
+declare function useCapxulOrgTreasury(orgId: OrgId | undefined, options?: UseCapxulOrgTreasuryOptions): UseCapxulOrgTreasuryReturn;
+//#endregion
+//#region src/hooks/use-capxul-create-org.d.ts
+/**
+ * Create an Org (canon §C2 J1 / §C3, S1). Binds directly to the locked
+ * `capxul.createOrg(input)` SDK method. On success, invalidates the org list.
+ * RED until S1 — `mutate` rejects with `Errors.notImplemented("org","createOrg")`.
+ */
+type UseCapxulCreateOrgReturn = UseMutationResult<OrgView, CapxulError, CreateOrgInput>;
+declare function useCapxulCreateOrg(): UseCapxulCreateOrgReturn;
+//#endregion
+//#region src/hooks/use-capxul-complete-personal-onboarding.d.ts
+/**
+ * Complete personal onboarding (D-ONBOARD · #669). Binds to
+ * `capxul.onboarding.completePersonal(input)`: persist the user's first identity
+ * profile + trigger provisioning, then return the leak-safe `{ lifecycle }`. A
+ * mutation, NOT an effect — call `mutateAsync` from a submit handler and route
+ * on `lifecycle.status` (see `docs/onboarding.md`). On success it invalidates the
+ * identity + account-lifecycle queries so the dashboard/provisioning screen
+ * reactively reflects the new state. No effect hooks — a handler + a query.
+ */
+type UseCapxulCompletePersonalOnboardingReturn = UseMutationResult<CompletePersonalOnboardingResult, CapxulError, CompletePersonalOnboardingInput>;
+declare function useCapxulCompletePersonalOnboarding(): UseCapxulCompletePersonalOnboardingReturn;
+//#endregion
+//#region src/hooks/use-capxul-complete-organization-onboarding.d.ts
+/**
+ * Complete organization onboarding (D-ONBOARD · #669). Binds to
+ * `capxul.onboarding.completeOrganization(input)`: persist the founder's identity
+ * profile, create the Org (reusing `createOrg`), trigger provisioning, and return
+ * `{ org, lifecycle }`. Scope every later org call via `capxul.org(org.id).*`. A
+ * mutation, NOT an effect. On success it invalidates the identity, account-
+ * lifecycle, and org-list queries. No effect hooks — a handler + a query.
+ */
+type UseCapxulCompleteOrganizationOnboardingReturn = UseMutationResult<CompleteOrganizationOnboardingResult, CapxulError, CompleteOrganizationOnboardingInput>;
+declare function useCapxulCompleteOrganizationOnboarding(): UseCapxulCompleteOrganizationOnboardingReturn;
+//#endregion
+//#region src/hooks/use-capxul-invite-member.d.ts
+/**
+ * Invite a member to an Org by email (canon §C2 J2 virality loop / §C3, S3, D8).
+ * Entity-scoped via the closed-over `orgId` (D13). Binds directly to
+ * `capxul.org(orgId).invite(input)`. On success, invalidates the member list.
+ * RED until S3 — `mutate` rejects with `Errors.notImplemented("org","invite")`.
+ */
+type UseCapxulInviteMemberReturn = UseMutationResult<MemberView, CapxulError, InviteMemberInput>;
+declare function useCapxulInviteMember(orgId: OrgId | undefined): UseCapxulInviteMemberReturn;
+//#endregion
+//#region src/hooks/use-capxul-remove-member.d.ts
+/**
+ * Remove a member from an Org (canon §C2 J2 / §C3, S3, D7/D8) — drives the
+ * on-chain REVOKE + Convex mirror. Keyed on the member's personal Safe address
+ * (D7). Entity-scoped via the closed-over `orgId` (D13). Binds directly to
+ * `capxul.org(orgId).removeMember(input)`. On success, invalidates the member
+ * list. RED until S3 — `mutate` rejects with
+ * `Errors.notImplemented("org","removeMember")`.
+ */
+type UseCapxulRemoveMemberReturn = UseMutationResult<void, CapxulError, RemoveMemberInput>;
+declare function useCapxulRemoveMember(orgId: OrgId | undefined): UseCapxulRemoveMemberReturn;
+//#endregion
+//#region src/hooks/use-capxul-assign-role.d.ts
+/**
+ * Assign a role to a member (canon §C2 J2 / §C3, S3, D7/D9) — drives the
+ * on-chain GRANT + Convex mirror. Keyed on the member's personal Safe address
+ * (D7); the `role` label maps deterministically to the on-chain `roleKey` (D9).
+ * Entity-scoped via the closed-over `orgId` (D13). Binds directly to
+ * `capxul.org(orgId).assignRole(input)`. On success, invalidates the member
+ * list. RED until S3 — `mutate` rejects with
+ * `Errors.notImplemented("org","assignRole")`.
+ */
+type UseCapxulAssignRoleReturn = UseMutationResult<MemberView, CapxulError, AssignRoleInput>;
+declare function useCapxulAssignRole(orgId: OrgId | undefined): UseCapxulAssignRoleReturn;
+//#endregion
+//#region src/hooks/use-capxul-switch-acting-entity.d.ts
+type SwitchActingEntityInput = {
+  readonly orgId?: OrgId;
+};
+/**
+ * Switch the acting entity (personal Account ↔ Organization).
+ *
+ * Per canon D13 the acting entity is NOT shared mutable SDK state — scoping is
+ * explicit per `capxul.org(orgId)` call — so this mutation carries no SDK side
+ * effect. It exists as the stable mutation seam the headless
+ * `CapxulEntitySwitcher` drives; the actual context switch is the consumer's
+ * own local state, applied through the component's `onSwitchPersonal` /
+ * `onSwitchOrg` callbacks.
+ *
+ * The legacy `org_entity_switched` telemetry emission was removed when master's
+ * unified telemetry pipeline (#402) dropped that event from the Layer 0 spine.
+ */
+type UseCapxulSwitchActingEntityReturn = UseMutationResult<void, Error, SwitchActingEntityInput | undefined>;
+declare function useCapxulSwitchActingEntity(): UseCapxulSwitchActingEntityReturn;
+//#endregion
+//#region src/headless/shared/headless-error-view.d.ts
+type HeadlessSuggestedAction = "retry" | "sign_out_and_in" | "check_configuration" | "contact_support";
+type HeadlessErrorView = {
+  readonly code: CapxulErrorCode;
+  readonly failureMode: FailureMode | undefined;
+  readonly userMessage: string;
+  readonly suggestedAction: HeadlessSuggestedAction;
+  readonly recoverable: boolean;
+  readonly diagnostics: string;
+  readonly correlationId: string | undefined;
+};
+//#endregion
+//#region src/headless/shared/types.d.ts
+type Slot<TProps> = (props: TProps) => ReactNode;
+type QuerySlotState<T> = {
+  readonly data: T | undefined;
+  readonly isLoading: boolean;
+  readonly isFetching: boolean;
+  readonly isError: boolean;
+  readonly error: HeadlessErrorView | null;
+};
+//#endregion
+//#region src/headless/money/SendMoney.d.ts
+type SendMoneySlots = {
+  readonly root?: Slot<{
+    readonly children: React.ReactNode;
+  }>;
+  readonly form?: Slot<{
+    readonly value: PaymentsPayInput | null;
+    readonly setValue: (value: PaymentsPayInput | null) => void;
+    readonly submit: () => void;
+    readonly pending: boolean;
+    readonly disabled: boolean;
+    readonly succeeded: boolean;
+    readonly error: HeadlessErrorView | null;
+  }>;
+  readonly error?: Slot<HeadlessErrorView>;
+};
+interface SendMoneyProps {
+  readonly initialValue?: PaymentsPayInput | null;
+  readonly slots: SendMoneySlots;
+  readonly onSent?: () => void;
+}
+declare function SendMoney({
+  initialValue,
+  slots,
+  onSent
+}: SendMoneyProps): string | number | bigint | boolean | import("react/jsx-runtime").JSX.Element | Iterable<import("react").ReactNode> | Promise<string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<import("react").ReactNode> | null | undefined>;
+//#endregion
+//#region src/headless/relationship/AddressBook.d.ts
+type AddressBookSlots = {
+  readonly root?: Slot<{
+    readonly children: React.ReactNode;
+  }>;
+  readonly entries?: Slot<QuerySlotState<readonly AddressBookEntry[]>>;
+  readonly actions?: Slot<{
+    readonly add: (input: AddressBookAddInput) => Promise<AddressBookEntry>;
+    readonly hide: (entryId: string) => Promise<AddressBookEntry>;
+    readonly unhide: (entryId: string) => Promise<AddressBookEntry>;
+    readonly label: (input: AddressBookLabelInput) => Promise<AddressBookEntry>;
+    readonly pending: boolean;
+    readonly disabled: boolean;
+  }>;
+};
+interface AddressBookProps {
+  readonly actor?: CapxulActorScope | undefined;
+  readonly slots: AddressBookSlots;
+}
+declare function AddressBook(props: AddressBookProps): string | number | bigint | boolean | import("react/jsx-runtime").JSX.Element | Iterable<import("react").ReactNode> | Promise<string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<import("react").ReactNode> | null | undefined>;
+//#endregion
+//#region src/headless/relationship/RequestInbox.d.ts
+type RequestInboxSlots = {
+  readonly root?: Slot<{
+    readonly children: React.ReactNode;
+  }>;
+  readonly requests?: Slot<QuerySlotState<readonly ActorRequest[]>>;
+  readonly inbox?: Slot<QuerySlotState<readonly InboxItem[]>>;
+  readonly actions?: Slot<{
+    readonly issue: (input: ActorRequestIssueInput) => Promise<ActorRequest>;
+    readonly cancel: (requestId: string) => Promise<ActorRequest>;
+    readonly approve: (input: InboxApproveInput) => Promise<Payment>;
+    readonly decline: (requestId: string) => Promise<InboxItem>;
+    readonly pending: boolean;
+    readonly disabled: boolean;
+  }>;
+};
+interface RequestInboxProps {
+  readonly actor?: CapxulActorScope | undefined;
+  readonly slots: RequestInboxSlots;
+}
+declare function RequestInbox(props: RequestInboxProps): string | number | bigint | boolean | import("react/jsx-runtime").JSX.Element | Iterable<import("react").ReactNode> | Promise<string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<import("react").ReactNode> | null | undefined>;
+//#endregion
+//#region src/headless/relationship/InsightsSummary.d.ts
+type InsightsSummarySlots = {
+  readonly root?: Slot<{
+    readonly children: React.ReactNode;
+  }>;
+  readonly summary?: Slot<QuerySlotState<InsightsSummary$1>>;
+};
+interface InsightsSummaryProps {
+  readonly actor?: CapxulActorScope | undefined;
+  readonly slots: InsightsSummarySlots;
+}
+declare function InsightsSummary(props: InsightsSummaryProps): import("react").ReactNode;
+//#endregion
+//#region src/headless/relationship/PayrollRoster.d.ts
+type PayrollRosterSlots = {
+  readonly root?: Slot<{
+    readonly children: React.ReactNode;
+  }>;
+  readonly roster?: Slot<QuerySlotState<readonly PayrollRosterLine[]>>;
+  readonly actions?: Slot<{
+    readonly add: (input: PayrollRosterAddInput) => Promise<PayrollRosterLine>;
+    readonly update: (input: UseCapxulUpdatePayrollRosterLineInput) => Promise<PayrollRosterLine>;
+    readonly remove: (rosterLineId: string) => Promise<PayrollRosterLine>;
+    readonly run: (input: PayrollRunInput) => Promise<readonly Payment[]>;
+    readonly pending: boolean;
+    readonly disabled: boolean;
+  }>;
+};
+interface PayrollRosterProps {
+  readonly orgId: OrgId$1;
+  readonly slots: PayrollRosterSlots;
+}
+declare function PayrollRoster({
+  orgId,
+  slots
+}: PayrollRosterProps): string | number | bigint | boolean | import("react/jsx-runtime").JSX.Element | Iterable<import("react").ReactNode> | Promise<string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<import("react").ReactNode> | null | undefined>;
+//#endregion
+//#region src/headless/relationship/Destinations.d.ts
+type DestinationsSlots = {
+  readonly root?: Slot<{
+    readonly children: React.ReactNode;
+  }>;
+  readonly destinations?: Slot<QuerySlotState<readonly Destination[]>>;
+  readonly actions?: Slot<{
+    readonly add: (input: DestinationAddInput) => Promise<Destination>;
+    readonly remove: (input: DestinationRemoveInput) => Promise<{
+      readonly id: string;
+    }>;
+    readonly pending: boolean;
+    readonly disabled: boolean;
+  }>;
+};
+interface DestinationsProps {
+  readonly input: DestinationListInput;
+  readonly slots: DestinationsSlots;
+}
+declare function Destinations({
+  input,
+  slots
+}: DestinationsProps): string | number | bigint | boolean | import("react/jsx-runtime").JSX.Element | Iterable<import("react").ReactNode> | Promise<string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<import("react").ReactNode> | null | undefined>;
+//#endregion
+export { AddressBook, type AddressBookProps, type AddressBookSlots, type CapxulActorScope, type CapxulBootstrapState, type CapxulBootstrapStatus, CapxulProvider, type CapxulProviderProps, Destinations, type DestinationsProps, type DestinationsSlots, InsightsSummary, type InsightsSummaryProps, type InsightsSummarySlots, PayrollRoster, type PayrollRosterProps, type PayrollRosterSlots, RequestInbox, type RequestInboxProps, type RequestInboxSlots, SendMoney, type SendMoneyProps, type SendMoneySlots, type SignInInput, type SignInSuccess, type SwitchActingEntityInput, type UseCapxulAccountBalanceOptions, type UseCapxulAccountBalanceReturn, type UseCapxulAccountFundReturn, type UseCapxulAccountLifecycleReturn, type UseCapxulAddAddressBookEntryReturn, type UseCapxulAddDestinationReturn, type UseCapxulAddPayrollRosterLineReturn, type UseCapxulAddressBookEntryReturn, type UseCapxulAddressBookReturn, type UseCapxulApproveInboxRequestReturn, type UseCapxulAssignRoleReturn, type UseCapxulCancelRequestReturn, type UseCapxulCompleteOrganizationOnboardingReturn, type UseCapxulCompletePersonalOnboardingReturn, type UseCapxulCreateOrgReturn, type UseCapxulDeclineInboxRequestReturn, type UseCapxulDestinationsReturn, type UseCapxulHideAddressBookEntryReturn, type UseCapxulInboxReturn, type UseCapxulInsightsHistoryReturn, type UseCapxulInsightsSummaryReturn, type UseCapxulInviteMemberReturn, type UseCapxulIssueRequestReturn, type UseCapxulLabelAddressBookEntryReturn, type UseCapxulOrgDeployRolesReturn, type UseCapxulOrgMembersOptions, type UseCapxulOrgMembersReturn, type UseCapxulOrgOptions, type UseCapxulOrgReturn, type UseCapxulOrgRolesOptions, type UseCapxulOrgRolesReturn, type UseCapxulOrgTreasuryOptions, type UseCapxulOrgTreasuryReturn, type UseCapxulOrgsReturn, type UseCapxulPayReturn, type UseCapxulPaymentReturn, type UseCapxulPaymentsReturn, type UseCapxulPayoutReturn, type UseCapxulPayrollRosterReturn, type UseCapxulProfileReturn, type UseCapxulReconcileRequestsReturn, type UseCapxulRemoveDestinationReturn, type UseCapxulRemoveMemberReturn, type UseCapxulRemovePayrollRosterLineReturn, type UseCapxulRequestReturn, type UseCapxulRequestsReturn, type UseCapxulRunPayrollReturn, type UseCapxulSessionReturn, type UseCapxulSignInReturn, type UseCapxulSignOutReturn, type UseCapxulSubAccountCreateReturn, type UseCapxulSubAccountDeleteReturn, type UseCapxulSubAccountRenameReturn, type UseCapxulSubAccountsListOptions, type UseCapxulSubAccountsListReturn, type UseCapxulSwitchActingEntityReturn, type UseCapxulTransferReturn, type UseCapxulUnhideAddressBookEntryReturn, type UseCapxulUpdatePayrollRosterLineInput, type UseCapxulUpdatePayrollRosterLineReturn, type UseCapxulVerifyOtpReturn, type UseCapxulWithdrawReturn, type VerifyOtpInput, capxulAccountScope, capxulOrgScope, useCapxul, useCapxulAccountBalance, useCapxulAccountFund, useCapxulAccountLifecycle, useCapxulAddAddressBookEntry, useCapxulAddDestination, useCapxulAddPayrollRosterLine, useCapxulAddressBook, useCapxulAddressBookEntry, useCapxulApproveInboxRequest, useCapxulAssignRole, useCapxulCancelRequest, useCapxulClientOrNull, useCapxulCompleteOrganizationOnboarding, useCapxulCompletePersonalOnboarding, useCapxulCreateOrg, useCapxulDeclineInboxRequest, useCapxulDestinations, useCapxulHideAddressBookEntry, useCapxulInbox, useCapxulInsightsHistory, useCapxulInsightsSummary, useCapxulInviteMember, useCapxulIssueRequest, useCapxulLabelAddressBookEntry, useCapxulOrg, useCapxulOrgDeployRoles, useCapxulOrgMembers, useCapxulOrgRoles, useCapxulOrgTreasury, useCapxulOrgs, useCapxulPay, useCapxulPayment, useCapxulPayments, useCapxulPayout, useCapxulPayrollRoster, useCapxulProfile, useCapxulReconcileRequests, useCapxulRemoveDestination, useCapxulRemoveMember, useCapxulRemovePayrollRosterLine, useCapxulRequest, useCapxulRequests, useCapxulRunPayroll, useCapxulSession, useCapxulSignIn, useCapxulSignOut, useCapxulSubAccountCreate, useCapxulSubAccountDelete, useCapxulSubAccountRename, useCapxulSubAccountsList, useCapxulSwitchActingEntity, useCapxulTransfer, useCapxulUnhideAddressBookEntry, useCapxulUpdatePayrollRosterLine, useCapxulVerifyOtp, useCapxulWithdraw };
+//# sourceMappingURL=index.d.mts.map