@routedock/routedock 0.1.2 → 0.2.0

package/dist/react.d.cts

@@ -0,0 +1,107 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { SupabaseClient } from '@supabase/supabase-js';
+import { j as RouteDockClient, k as RouteDockClientConfig, M as ModeSelectOptions } from './RouteDockClient-B1roCa8h.cjs';
+import { c as PaymentResult, j as SessionHandle, g as SessionCloseResult } from './types-DmhmfLzP.cjs';
+import '@stellar/stellar-sdk';
+import '@x402/stellar';
+import '@stellar/stellar-sdk/contract';
+import '@routedock/nulth-sdk';
+import 'mppx';
+
+interface RouteDockContextValue {
+    client: RouteDockClient;
+    supabase?: SupabaseClient;
+}
+interface RouteDockProviderProps extends RouteDockContextValue {
+    children: ReactNode;
+}
+/**
+ * Wraps an app with RouteDock client + optional Supabase instance.
+ * Child hooks (`usePay`, `useSession`, `useTxLog`) read from this context.
+ *
+ * @example
+ * const client = useRouteDockClient({ wallet: secret, network: 'testnet' })
+ * return <RouteDockProvider client={client} supabase={supabase}>{children}</RouteDockProvider>
+ */
+declare function RouteDockProvider(props: RouteDockProviderProps): react_jsx_runtime.JSX.Element;
+declare function useRouteDockContext(): RouteDockContextValue;
+
+/**
+ * Returns a memoized RouteDockClient. Re-creates only when wallet / network /
+ * spendCap / commitmentSecret / retryPolicy identity changes.
+ *
+ * The client runs in the browser, so the wallet secret is visible to anyone who
+ * loads the page. Never source it from a public environment variable or use a
+ * funded key.
+ *
+ * @example
+ * const THROWAWAY_TESTNET_SECRET = 'S...'
+ * const client = useRouteDockClient({
+ *   wallet: THROWAWAY_TESTNET_SECRET,
+ *   network: 'testnet',
+ *   spendCap: { daily: '1.00', asset: 'USDC' },
+ * })
+ */
+declare function useRouteDockClient(config: RouteDockClientConfig): RouteDockClient;
+
+interface UsePayResult {
+    pay: () => Promise<PaymentResult | null>;
+    result: PaymentResult | null;
+    loading: boolean;
+    error: Error | null;
+}
+/**
+ * Calls `client.pay(url, options)` on demand. Aborts state updates after unmount.
+ *
+ * @example
+ * const { pay, result, loading, error } = usePay('https://provider.example.com/price')
+ * return <button onClick={pay} disabled={loading}>Pay</button>
+ */
+declare function usePay(url: string, options?: ModeSelectOptions): UsePayResult;
+
+type SessionStatus = 'idle' | 'opening' | 'open' | 'closing' | 'closed' | 'error';
+interface UseSessionResult {
+    session: SessionHandle | null;
+    status: SessionStatus;
+    vouchers: number;
+    cumulative: string;
+    error: Error | null;
+    open: () => Promise<SessionHandle | null>;
+    close: () => Promise<SessionCloseResult | null>;
+}
+/**
+ * Manages MPP session lifecycle. On unmount, fires session.close() in the
+ * background if status === 'open' (best-effort settlement).
+ *
+ * @example
+ * const { session, open, close, vouchers, cumulative, status } = useSession(streamUrl)
+ * useEffect(() => { open() }, [])
+ */
+declare function useSession(url: string): UseSessionResult;
+
+interface TxLogRow {
+    id: string;
+    tx_hash: string;
+    mode: string;
+    amount: string;
+    channel_id: string | null;
+    created_at: string;
+    [key: string]: unknown;
+}
+interface UseTxLogFilter {
+    channelId?: string;
+    mode?: 'x402' | 'mpp-charge' | 'mpp-session';
+    limit?: number;
+}
+/**
+ * Subscribes to Supabase Realtime on the `tx_log` table. Returns a live array
+ * of rows ordered newest-first. Requires <RouteDockProvider supabase={...}>.
+ *
+ * @example
+ * const txLog = useTxLog({ channelId, limit: 50 })
+ * return <ul>{txLog.map(r => <li key={r.id}>{r.tx_hash}</li>)}</ul>
+ */
+declare function useTxLog(filter?: UseTxLogFilter): TxLogRow[];
+
+export { type RouteDockContextValue, RouteDockProvider, type RouteDockProviderProps, type SessionStatus, type TxLogRow, type UsePayResult, type UseSessionResult, type UseTxLogFilter, usePay, useRouteDockClient, useRouteDockContext, useSession, useTxLog };

package/dist/react.d.ts

@@ -0,0 +1,107 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { SupabaseClient } from '@supabase/supabase-js';
+import { j as RouteDockClient, k as RouteDockClientConfig, M as ModeSelectOptions } from './RouteDockClient-BbkqjhMG.js';
+import { c as PaymentResult, j as SessionHandle, g as SessionCloseResult } from './types-DmhmfLzP.js';
+import '@stellar/stellar-sdk';
+import '@x402/stellar';
+import '@stellar/stellar-sdk/contract';
+import '@routedock/nulth-sdk';
+import 'mppx';
+
+interface RouteDockContextValue {
+    client: RouteDockClient;
+    supabase?: SupabaseClient;
+}
+interface RouteDockProviderProps extends RouteDockContextValue {
+    children: ReactNode;
+}
+/**
+ * Wraps an app with RouteDock client + optional Supabase instance.
+ * Child hooks (`usePay`, `useSession`, `useTxLog`) read from this context.
+ *
+ * @example
+ * const client = useRouteDockClient({ wallet: secret, network: 'testnet' })
+ * return <RouteDockProvider client={client} supabase={supabase}>{children}</RouteDockProvider>
+ */
+declare function RouteDockProvider(props: RouteDockProviderProps): react_jsx_runtime.JSX.Element;
+declare function useRouteDockContext(): RouteDockContextValue;
+
+/**
+ * Returns a memoized RouteDockClient. Re-creates only when wallet / network /
+ * spendCap / commitmentSecret / retryPolicy identity changes.
+ *
+ * The client runs in the browser, so the wallet secret is visible to anyone who
+ * loads the page. Never source it from a public environment variable or use a
+ * funded key.
+ *
+ * @example
+ * const THROWAWAY_TESTNET_SECRET = 'S...'
+ * const client = useRouteDockClient({
+ *   wallet: THROWAWAY_TESTNET_SECRET,
+ *   network: 'testnet',
+ *   spendCap: { daily: '1.00', asset: 'USDC' },
+ * })
+ */
+declare function useRouteDockClient(config: RouteDockClientConfig): RouteDockClient;
+
+interface UsePayResult {
+    pay: () => Promise<PaymentResult | null>;
+    result: PaymentResult | null;
+    loading: boolean;
+    error: Error | null;
+}
+/**
+ * Calls `client.pay(url, options)` on demand. Aborts state updates after unmount.
+ *
+ * @example
+ * const { pay, result, loading, error } = usePay('https://provider.example.com/price')
+ * return <button onClick={pay} disabled={loading}>Pay</button>
+ */
+declare function usePay(url: string, options?: ModeSelectOptions): UsePayResult;
+
+type SessionStatus = 'idle' | 'opening' | 'open' | 'closing' | 'closed' | 'error';
+interface UseSessionResult {
+    session: SessionHandle | null;
+    status: SessionStatus;
+    vouchers: number;
+    cumulative: string;
+    error: Error | null;
+    open: () => Promise<SessionHandle | null>;
+    close: () => Promise<SessionCloseResult | null>;
+}
+/**
+ * Manages MPP session lifecycle. On unmount, fires session.close() in the
+ * background if status === 'open' (best-effort settlement).
+ *
+ * @example
+ * const { session, open, close, vouchers, cumulative, status } = useSession(streamUrl)
+ * useEffect(() => { open() }, [])
+ */
+declare function useSession(url: string): UseSessionResult;
+
+interface TxLogRow {
+    id: string;
+    tx_hash: string;
+    mode: string;
+    amount: string;
+    channel_id: string | null;
+    created_at: string;
+    [key: string]: unknown;
+}
+interface UseTxLogFilter {
+    channelId?: string;
+    mode?: 'x402' | 'mpp-charge' | 'mpp-session';
+    limit?: number;
+}
+/**
+ * Subscribes to Supabase Realtime on the `tx_log` table. Returns a live array
+ * of rows ordered newest-first. Requires <RouteDockProvider supabase={...}>.
+ *
+ * @example
+ * const txLog = useTxLog({ channelId, limit: 50 })
+ * return <ul>{txLog.map(r => <li key={r.id}>{r.tx_hash}</li>)}</ul>
+ */
+declare function useTxLog(filter?: UseTxLogFilter): TxLogRow[];
+
+export { type RouteDockContextValue, RouteDockProvider, type RouteDockProviderProps, type SessionStatus, type TxLogRow, type UsePayResult, type UseSessionResult, type UseTxLogFilter, usePay, useRouteDockClient, useRouteDockContext, useSession, useTxLog };