@tuwaio/satellite-react 0.4.10 → 0.6.0

package/dist/index.d.cts

@@ -3,136 +3,166 @@ import { ISatelliteConnectStore, SatelliteConnectStoreInitialParameters } from '
 import { StoreApi } from 'zustand';
 
 /**
- * @description
- * This interface is intentionally left empty.
- * Other packages (@tuwaio/satellite-*) will use module
- * augmentation to add their specific connection types here.
+ * Connection types by chain family, filled by module augmentation. Importing `@tuwaio/satellite-react/evm` adds
+ * `EVMConnection` from `@tuwaio/satellite-evm`, and importing `@tuwaio/satellite-react/solana` adds `SolanaConnection`
+ * from `@tuwaio/satellite-solana`. It is empty until one of them is imported.
  */
 interface AllConnections {
 }
 /**
- * @description
- * This interface is intentionally left empty.
- * It will be augmented by satellite packages.
+ * Wallet connector types by chain family, filled by module augmentation like {@link AllConnections}: the wagmi
+ * `Connector` for EVM and the Wallet Standard `UiWallet` for Solana.
  */
 interface AllConnectors {
 }
 /**
- * Union type for all supported connection types.
- * It's created from the values of the AllConnections interface.
- * e.g., { evm: EVMConnection, solana: SolanaConnection } -> EVMConnection | SolanaConnection
+ * Union of the connection types in {@link AllConnections}, for example `EVMConnection | SolanaConnection`. The store of
+ * `SatelliteConnectProvider` uses it for `activeConnection` and `connections`.
  */
 type Connection = AllConnections[keyof AllConnections];
 /**
- * Union type for all supported connector types.
+ * Union of the wallet connector types in {@link AllConnectors}, returned by the store's `getConnectors`.
  */
 type Connector = AllConnectors[keyof AllConnectors];
 
+/**
+ * Value of {@link SatelliteStoreContext}: the store created by {@link SatelliteConnectProvider}, or `null` outside the
+ * provider.
+ */
 type SatelliteContextType = StoreApi<ISatelliteConnectStore<Connector, Connection>> | null;
-declare const SatelliteStoreContext: react.Context<SatelliteContextType>;
 /**
- * Custom hook for accessing the Satellite Connect store state
- *
- * @remarks
- * This hook provides type-safe access to the Satellite store state and must be used
- * within a component that is wrapped by SatelliteConnectProvider.
+ * React context that holds the store of {@link SatelliteConnectProvider}. Use {@link useSatelliteConnectStore} to read
+ * it in components; read the context directly to call `getState()` or `subscribe` without re-rendering.
  *
- * @typeParam T - The type of the selected state slice
- * @param selector - Function that selects a slice of the store state
- * @returns Selected state slice
+ * The context object is created once and saved on `globalThis` (`Symbol.for('tuwaio.satellite.context')`), so
+ * packages that bundle their own copy of `@tuwaio/satellite-react` share the same context.
+ */
+declare const SatelliteStoreContext: react.Context<SatelliteContextType>;
+/**
+ * Reads a value from the store of {@link SatelliteConnectProvider} and re-renders the component when it changes
+ * (compared with `Object.is`, through `useStore` from `zustand`). Return stable values from the selector: a new
+ * object or array on every call causes endless re-renders (use `useShallow` from `zustand/react/shallow`).
  *
- * @throws Error if used outside of SatelliteConnectProvider
+ * @typeParam T - Type of the selected value.
+ * @param selector - Selects a value from the store state (`ISatelliteConnectStore` from `@tuwaio/satellite-core`).
+ * @returns The selected value.
+ * @throws {Error} `useSatelliteConnectStore must be used within a SatelliteConnectProvider` outside the provider.
  *
  * @example
  * ```tsx
- * // Get the active connection
- * const activeConnection = useSatelliteConnectStore((state) => state.activeConnection);
+ * import { useSatelliteConnectStore } from '@tuwaio/satellite-react';
+ *
+ * export function ActiveAddress() {
+ *   const activeConnection = useSatelliteConnectStore((state) => state.activeConnection);
+ *   return <span>{activeConnection?.address ?? 'Not connected'}</span>;
+ * }
  * ```
  */
 declare const useSatelliteConnectStore: <T>(selector: (state: ISatelliteConnectStore<Connector, Connection>) => T) => T;
 
 /**
- * Props for the useInitializeAutoConnect hook.
+ * Parameters of {@link useInitializeAutoConnect}.
  */
 interface InitializeAutoConnectProps {
-    /** Function to initialize auto connect logic */
+    /**
+     * Restores the connection, for example `() => store.getState().initializeAutoConnect(true)`.
+     *
+     * @returns Resolves when done.
+     */
     initializeAutoConnect: () => Promise<void>;
-    /** Optional error handler callback */
+    /**
+     * Called when `initializeAutoConnect` rejects; the function of the latest render is used. Defaults to
+     * `console.error`.
+     *
+     * @param error - The rejection reason.
+     */
     onError?: (error: Error) => void;
 }
 /**
- * Custom hook for initializing connector auto-connection with error handling.
+ * Calls `initializeAutoConnect` once, in an effect after the component mounts (so only in the browser).
+ * {@link SatelliteConnectProvider} already uses it; call it yourself only with a store you create with
+ * `createSatelliteConnectStore` from `@tuwaio/satellite-core`.
  *
- * @remarks
- * This hook handles the initial connection logic (e.g., checking for a previously
- * connected connector) when a component mounts.
- * It provides default error handling with console.error if no custom handler is provided.
- * The initialization runs only once when the component mounts.
+ * It runs once: later renders do not call `initializeAutoConnect` again. If it rejects, the error goes to the `onError`
+ * of the latest render, so an inline `onError` needs no memoization. In development, React Strict Mode runs the
+ * effect twice.
  *
- * @param props - Hook configuration
- * @param props.initializeAutoConnect - Async function that executes the auto-connect logic
- * @param props.onError - Optional custom error handler
+ * @param props - The initializer and the optional error handler. See {@link InitializeAutoConnectProps}.
  *
  * @example
  * ```tsx
- * // Basic usage with default error handling
- * useInitializeAutoConnect({
- *  initializeAutoConnect: store.initializeAutoConnect
+ * import { createSatelliteConnectStore } from '@tuwaio/satellite-core';
+ * import { useInitializeAutoConnect } from '@tuwaio/satellite-react';
+ * import { satelliteSolanaAdapter } from '@tuwaio/satellite-solana';
+ *
+ * const store = createSatelliteConnectStore({
+ *   adapter: satelliteSolanaAdapter({ rpcUrls: { devnet: 'https://api.devnet.solana.com' } }),
  * });
  *
- * // With custom error handling
- * useInitializeAutoConnect({
- *  initializeAutoConnect: store.initializeAutoConnect,
- *  onError: (error) => {
- *    toast.error(`Failed to auto-connect: ${error.message}`);
+ * export function AutoConnect() {
+ *   useInitializeAutoConnect({
+ *     initializeAutoConnect: () => store.getState().initializeAutoConnect(true),
+ *     onError: (error) => console.warn('Auto-connect failed:', error.message),
+ *   });
+ *   return null;
  * }
- * });
  * ```
  */
 declare const useInitializeAutoConnect: ({ initializeAutoConnect, onError }: InitializeAutoConnectProps) => void;
 
 /**
- * Props for SatelliteConnectProvider component
+ * Props of {@link SatelliteConnectProvider}: the store parameters (`adapter`, one adapter or an array, and the optional
+ * `callbackAfterConnected`, see `SatelliteConnectStoreInitialParameters` from `@tuwaio/satellite-core`) plus the
+ * fields below.
  */
 interface SatelliteConnectProviderProps extends SatelliteConnectStoreInitialParameters<Connector, Connection> {
-    /** React child components */
+    /** Components that can read the store. */
     children: React.ReactNode;
-    /** Whether to automatically connect to last used connector */
+    /**
+     * Whether to reconnect the last connected wallet after a page load (read on the first render only). Defaults to
+     * `false`. See `initializeAutoConnect` of the store.
+     */
     autoConnect?: boolean;
 }
 /**
- * Provider component that manages connector connections and state
+ * Creates the Satellite Connect store (`createSatelliteConnectStore` from `@tuwaio/satellite-core`) and provides it to
+ * its children through {@link SatelliteStoreContext}. Read it with {@link useSatelliteConnectStore}.
  *
- * @remarks
- * This component creates and provides the Satellite Connect store context to its children.
- * It handles connector connections, state management, and automatic reconnection functionality.
- * The store is memoized to ensure stable reference across renders.
+ * The store is created once, on the first render. When `adapter` or `callbackAfterConnected` changes, the new value
+ * is passed to the store's `updateParameters`; the state is kept. Define adapters outside the component (or memoize
+ * them), so a render does not create new adapter objects. After mount the provider
+ * calls the store's `initializeAutoConnect(autoConnect ?? false)` once, which disconnects the wallets of every adapter,
+ * cleans the recently connected list in `localStorage` and, with `autoConnect`, reconnects the last connected wallet.
+ * Inside Safe{Wallet} it connects the Safe connector instead, with or without `autoConnect`.
+ * Render the chain watchers (`EVMConnectorsWatcher` from `@tuwaio/satellite-react/evm`, `SolanaConnectorsWatcher`
+ * from `@tuwaio/satellite-react/solana`) inside it to follow wallet changes.
  *
- * @param props - Component properties including store parameters and children
- * @param props.children - Child components that will have access to the store
- * @param props.autoConnect - Optional flag to enable automatic connector reconnection
- * @param props.adapter - Blockchain adapter(s) for connector interactions
- * @param props.callbackAfterConnected - Optional callback for successful connections
+ * @param props - The store parameters, `autoConnect` and `children`. See {@link SatelliteConnectProviderProps}.
+ * @returns The context provider.
  *
  * @example
  * ```tsx
- * // Basic usage with single adapter
- * <SatelliteConnectProvider adapter={solanaAdapter}>
- *   <App />
- * </SatelliteConnectProvider>
+ * 'use client';
  *
- * // With auto-connect and multiple adapters
- * <SatelliteConnectProvider
- *   adapter={[solanaAdapter, evmAdapter]}
- *   autoConnect={true}
- *   callbackAfterConnected={(wallet) => {
- *     console.log('Wallet connected:', wallet.address);
- *   }}
- * >
- *   <App />
- * </SatelliteConnectProvider>
+ * import { SatelliteConnectProvider } from '@tuwaio/satellite-react';
+ * import { satelliteSolanaAdapter } from '@tuwaio/satellite-solana';
+ * import type { ReactNode } from 'react';
+ *
+ * const solanaAdapter = satelliteSolanaAdapter({ rpcUrls: { devnet: 'https://api.devnet.solana.com' } });
+ *
+ * export function Providers({ children }: { children: ReactNode }) {
+ *   return (
+ *     <SatelliteConnectProvider
+ *       adapter={solanaAdapter}
+ *       autoConnect
+ *       callbackAfterConnected={(connection) => console.log('Connected:', connection.address)}
+ *     >
+ *       {children}
+ *     </SatelliteConnectProvider>
+ *   );
+ * }
  * ```
  */
-declare function SatelliteConnectProvider({ children, autoConnect, ...parameters }: SatelliteConnectProviderProps): react.JSX.Element;
+declare function SatelliteConnectProvider({ children, autoConnect, adapter, callbackAfterConnected, }: SatelliteConnectProviderProps): react.JSX.Element;
 
-export { type AllConnections, type AllConnectors, type Connection, type Connector, SatelliteConnectProvider, type SatelliteConnectProviderProps, SatelliteStoreContext, useInitializeAutoConnect, useSatelliteConnectStore };
+export { type AllConnections, type AllConnectors, type Connection, type Connector, type InitializeAutoConnectProps, SatelliteConnectProvider, type SatelliteConnectProviderProps, type SatelliteContextType, SatelliteStoreContext, useInitializeAutoConnect, useSatelliteConnectStore };

package/dist/index.d.ts

@@ -3,136 +3,166 @@ import { ISatelliteConnectStore, SatelliteConnectStoreInitialParameters } from '
 import { StoreApi } from 'zustand';
 
 /**
- * @description
- * This interface is intentionally left empty.
- * Other packages (@tuwaio/satellite-*) will use module
- * augmentation to add their specific connection types here.
+ * Connection types by chain family, filled by module augmentation. Importing `@tuwaio/satellite-react/evm` adds
+ * `EVMConnection` from `@tuwaio/satellite-evm`, and importing `@tuwaio/satellite-react/solana` adds `SolanaConnection`
+ * from `@tuwaio/satellite-solana`. It is empty until one of them is imported.
  */
 interface AllConnections {
 }
 /**
- * @description
- * This interface is intentionally left empty.
- * It will be augmented by satellite packages.
+ * Wallet connector types by chain family, filled by module augmentation like {@link AllConnections}: the wagmi
+ * `Connector` for EVM and the Wallet Standard `UiWallet` for Solana.
  */
 interface AllConnectors {
 }
 /**
- * Union type for all supported connection types.
- * It's created from the values of the AllConnections interface.
- * e.g., { evm: EVMConnection, solana: SolanaConnection } -> EVMConnection | SolanaConnection
+ * Union of the connection types in {@link AllConnections}, for example `EVMConnection | SolanaConnection`. The store of
+ * `SatelliteConnectProvider` uses it for `activeConnection` and `connections`.
  */
 type Connection = AllConnections[keyof AllConnections];
 /**
- * Union type for all supported connector types.
+ * Union of the wallet connector types in {@link AllConnectors}, returned by the store's `getConnectors`.
  */
 type Connector = AllConnectors[keyof AllConnectors];
 
+/**
+ * Value of {@link SatelliteStoreContext}: the store created by {@link SatelliteConnectProvider}, or `null` outside the
+ * provider.
+ */
 type SatelliteContextType = StoreApi<ISatelliteConnectStore<Connector, Connection>> | null;
-declare const SatelliteStoreContext: react.Context<SatelliteContextType>;
 /**
- * Custom hook for accessing the Satellite Connect store state
- *
- * @remarks
- * This hook provides type-safe access to the Satellite store state and must be used
- * within a component that is wrapped by SatelliteConnectProvider.
+ * React context that holds the store of {@link SatelliteConnectProvider}. Use {@link useSatelliteConnectStore} to read
+ * it in components; read the context directly to call `getState()` or `subscribe` without re-rendering.
  *
- * @typeParam T - The type of the selected state slice
- * @param selector - Function that selects a slice of the store state
- * @returns Selected state slice
+ * The context object is created once and saved on `globalThis` (`Symbol.for('tuwaio.satellite.context')`), so
+ * packages that bundle their own copy of `@tuwaio/satellite-react` share the same context.
+ */
+declare const SatelliteStoreContext: react.Context<SatelliteContextType>;
+/**
+ * Reads a value from the store of {@link SatelliteConnectProvider} and re-renders the component when it changes
+ * (compared with `Object.is`, through `useStore` from `zustand`). Return stable values from the selector: a new
+ * object or array on every call causes endless re-renders (use `useShallow` from `zustand/react/shallow`).
  *
- * @throws Error if used outside of SatelliteConnectProvider
+ * @typeParam T - Type of the selected value.
+ * @param selector - Selects a value from the store state (`ISatelliteConnectStore` from `@tuwaio/satellite-core`).
+ * @returns The selected value.
+ * @throws {Error} `useSatelliteConnectStore must be used within a SatelliteConnectProvider` outside the provider.
  *
  * @example
  * ```tsx
- * // Get the active connection
- * const activeConnection = useSatelliteConnectStore((state) => state.activeConnection);
+ * import { useSatelliteConnectStore } from '@tuwaio/satellite-react';
+ *
+ * export function ActiveAddress() {
+ *   const activeConnection = useSatelliteConnectStore((state) => state.activeConnection);
+ *   return <span>{activeConnection?.address ?? 'Not connected'}</span>;
+ * }
  * ```
  */
 declare const useSatelliteConnectStore: <T>(selector: (state: ISatelliteConnectStore<Connector, Connection>) => T) => T;
 
 /**
- * Props for the useInitializeAutoConnect hook.
+ * Parameters of {@link useInitializeAutoConnect}.
  */
 interface InitializeAutoConnectProps {
-    /** Function to initialize auto connect logic */
+    /**
+     * Restores the connection, for example `() => store.getState().initializeAutoConnect(true)`.
+     *
+     * @returns Resolves when done.
+     */
     initializeAutoConnect: () => Promise<void>;
-    /** Optional error handler callback */
+    /**
+     * Called when `initializeAutoConnect` rejects; the function of the latest render is used. Defaults to
+     * `console.error`.
+     *
+     * @param error - The rejection reason.
+     */
     onError?: (error: Error) => void;
 }
 /**
- * Custom hook for initializing connector auto-connection with error handling.
+ * Calls `initializeAutoConnect` once, in an effect after the component mounts (so only in the browser).
+ * {@link SatelliteConnectProvider} already uses it; call it yourself only with a store you create with
+ * `createSatelliteConnectStore` from `@tuwaio/satellite-core`.
  *
- * @remarks
- * This hook handles the initial connection logic (e.g., checking for a previously
- * connected connector) when a component mounts.
- * It provides default error handling with console.error if no custom handler is provided.
- * The initialization runs only once when the component mounts.
+ * It runs once: later renders do not call `initializeAutoConnect` again. If it rejects, the error goes to the `onError`
+ * of the latest render, so an inline `onError` needs no memoization. In development, React Strict Mode runs the
+ * effect twice.
  *
- * @param props - Hook configuration
- * @param props.initializeAutoConnect - Async function that executes the auto-connect logic
- * @param props.onError - Optional custom error handler
+ * @param props - The initializer and the optional error handler. See {@link InitializeAutoConnectProps}.
  *
  * @example
  * ```tsx
- * // Basic usage with default error handling
- * useInitializeAutoConnect({
- *  initializeAutoConnect: store.initializeAutoConnect
+ * import { createSatelliteConnectStore } from '@tuwaio/satellite-core';
+ * import { useInitializeAutoConnect } from '@tuwaio/satellite-react';
+ * import { satelliteSolanaAdapter } from '@tuwaio/satellite-solana';
+ *
+ * const store = createSatelliteConnectStore({
+ *   adapter: satelliteSolanaAdapter({ rpcUrls: { devnet: 'https://api.devnet.solana.com' } }),
  * });
  *
- * // With custom error handling
- * useInitializeAutoConnect({
- *  initializeAutoConnect: store.initializeAutoConnect,
- *  onError: (error) => {
- *    toast.error(`Failed to auto-connect: ${error.message}`);
+ * export function AutoConnect() {
+ *   useInitializeAutoConnect({
+ *     initializeAutoConnect: () => store.getState().initializeAutoConnect(true),
+ *     onError: (error) => console.warn('Auto-connect failed:', error.message),
+ *   });
+ *   return null;
  * }
- * });
  * ```
  */
 declare const useInitializeAutoConnect: ({ initializeAutoConnect, onError }: InitializeAutoConnectProps) => void;
 
 /**
- * Props for SatelliteConnectProvider component
+ * Props of {@link SatelliteConnectProvider}: the store parameters (`adapter`, one adapter or an array, and the optional
+ * `callbackAfterConnected`, see `SatelliteConnectStoreInitialParameters` from `@tuwaio/satellite-core`) plus the
+ * fields below.
  */
 interface SatelliteConnectProviderProps extends SatelliteConnectStoreInitialParameters<Connector, Connection> {
-    /** React child components */
+    /** Components that can read the store. */
     children: React.ReactNode;
-    /** Whether to automatically connect to last used connector */
+    /**
+     * Whether to reconnect the last connected wallet after a page load (read on the first render only). Defaults to
+     * `false`. See `initializeAutoConnect` of the store.
+     */
     autoConnect?: boolean;
 }
 /**
- * Provider component that manages connector connections and state
+ * Creates the Satellite Connect store (`createSatelliteConnectStore` from `@tuwaio/satellite-core`) and provides it to
+ * its children through {@link SatelliteStoreContext}. Read it with {@link useSatelliteConnectStore}.
  *
- * @remarks
- * This component creates and provides the Satellite Connect store context to its children.
- * It handles connector connections, state management, and automatic reconnection functionality.
- * The store is memoized to ensure stable reference across renders.
+ * The store is created once, on the first render. When `adapter` or `callbackAfterConnected` changes, the new value
+ * is passed to the store's `updateParameters`; the state is kept. Define adapters outside the component (or memoize
+ * them), so a render does not create new adapter objects. After mount the provider
+ * calls the store's `initializeAutoConnect(autoConnect ?? false)` once, which disconnects the wallets of every adapter,
+ * cleans the recently connected list in `localStorage` and, with `autoConnect`, reconnects the last connected wallet.
+ * Inside Safe{Wallet} it connects the Safe connector instead, with or without `autoConnect`.
+ * Render the chain watchers (`EVMConnectorsWatcher` from `@tuwaio/satellite-react/evm`, `SolanaConnectorsWatcher`
+ * from `@tuwaio/satellite-react/solana`) inside it to follow wallet changes.
  *
- * @param props - Component properties including store parameters and children
- * @param props.children - Child components that will have access to the store
- * @param props.autoConnect - Optional flag to enable automatic connector reconnection
- * @param props.adapter - Blockchain adapter(s) for connector interactions
- * @param props.callbackAfterConnected - Optional callback for successful connections
+ * @param props - The store parameters, `autoConnect` and `children`. See {@link SatelliteConnectProviderProps}.
+ * @returns The context provider.
  *
  * @example
  * ```tsx
- * // Basic usage with single adapter
- * <SatelliteConnectProvider adapter={solanaAdapter}>
- *   <App />
- * </SatelliteConnectProvider>
+ * 'use client';
  *
- * // With auto-connect and multiple adapters
- * <SatelliteConnectProvider
- *   adapter={[solanaAdapter, evmAdapter]}
- *   autoConnect={true}
- *   callbackAfterConnected={(wallet) => {
- *     console.log('Wallet connected:', wallet.address);
- *   }}
- * >
- *   <App />
- * </SatelliteConnectProvider>
+ * import { SatelliteConnectProvider } from '@tuwaio/satellite-react';
+ * import { satelliteSolanaAdapter } from '@tuwaio/satellite-solana';
+ * import type { ReactNode } from 'react';
+ *
+ * const solanaAdapter = satelliteSolanaAdapter({ rpcUrls: { devnet: 'https://api.devnet.solana.com' } });
+ *
+ * export function Providers({ children }: { children: ReactNode }) {
+ *   return (
+ *     <SatelliteConnectProvider
+ *       adapter={solanaAdapter}
+ *       autoConnect
+ *       callbackAfterConnected={(connection) => console.log('Connected:', connection.address)}
+ *     >
+ *       {children}
+ *     </SatelliteConnectProvider>
+ *   );
+ * }
  * ```
  */
-declare function SatelliteConnectProvider({ children, autoConnect, ...parameters }: SatelliteConnectProviderProps): react.JSX.Element;
+declare function SatelliteConnectProvider({ children, autoConnect, adapter, callbackAfterConnected, }: SatelliteConnectProviderProps): react.JSX.Element;
 
-export { type AllConnections, type AllConnectors, type Connection, type Connector, SatelliteConnectProvider, type SatelliteConnectProviderProps, SatelliteStoreContext, useInitializeAutoConnect, useSatelliteConnectStore };
+export { type AllConnections, type AllConnectors, type Connection, type Connector, type InitializeAutoConnectProps, SatelliteConnectProvider, type SatelliteConnectProviderProps, type SatelliteContextType, SatelliteStoreContext, useInitializeAutoConnect, useSatelliteConnectStore };

package/dist/index.js

@@ -1 +1 @@
-export{b as SatelliteConnectProvider,a as useInitializeAutoConnect}from'./chunk-UDS7MUYZ.js';export{a as SatelliteStoreContext,b as useSatelliteConnectStore}from'./chunk-EYVLQZ24.js';
+import {a}from'./chunk-4A4PSLAK.js';export{a as SatelliteStoreContext,b as useSatelliteConnectStore}from'./chunk-4A4PSLAK.js';import {useEffectEvent,useEffect,useMemo}from'react';import {createSatelliteConnectStore}from'@tuwaio/satellite-core';import {jsx}from'react/jsx-runtime';var s=({initializeAutoConnect:n,onError:r})=>{let e=useEffectEvent(async()=>n()),t=useEffectEvent(o=>{(r??(C=>console.error("Failed to initialize auto connect:",C)))(o);});useEffect(()=>{e().catch(o=>t(o));},[]);};function h({children:n,autoConnect:r,adapter:e,callbackAfterConnected:t}){let o=useMemo(()=>createSatelliteConnectStore({adapter:e,callbackAfterConnected:t}),[]);return useEffect(()=>{o.getState().updateParameters({adapter:e,callbackAfterConnected:t});},[o,e,t]),s({initializeAutoConnect:()=>o.getState().initializeAutoConnect(r??false)}),jsx(a.Provider,{value:o,children:n})}export{h as SatelliteConnectProvider,s as useInitializeAutoConnect};

package/dist/solana/index.cjs

@@ -1 +1 @@
-'use strict';var chunkG2YC6JBO_cjs=require('../chunk-G2YC6JBO.cjs'),react=require('react'),jsxRuntime=require('react/jsx-runtime');function x(o={}){let[c,m]=react.useState(null);return react.useEffect(()=>{(async()=>{try{let e=!1,l=null,i=null;try{let[r,a]=await Promise.all([import('@tuwaio/satellite-solana'),import('@wallet-standard/react')]);l=r.createSolanaConnectionsWatcher,i=a.useWallets,e=!0;}catch{e=!1;}if(e){let r=()=>{let a=i(),s=chunkG2YC6JBO_cjs.b(t=>t.activeConnection),p=chunkG2YC6JBO_cjs.b(t=>t.updateActiveConnection),u=chunkG2YC6JBO_cjs.b(t=>t.connectionError),S=chunkG2YC6JBO_cjs.b(t=>t.disconnect);return react.useEffect(()=>l({wallets:a,siwx:o.siwx},{activeConnection:s,disconnect:S,connectionError:u,updateActiveConnection:p}),[s?.connectorType,a,o.siwx,u,p,S]),null};m(()=>r);}}catch(e){console.warn("Failed to load Solana watcher:",e);}})();},[o.siwx]),c?jsxRuntime.jsx(c,{...o}):null}exports.SolanaConnectorsWatcher=x;
+'use strict';var chunkLSWAATDN_cjs=require('../chunk-LSWAATDN.cjs'),chunkHEG6FP5Z_cjs=require('../chunk-HEG6FP5Z.cjs'),react=require('react'),jsxRuntime=require('react/jsx-runtime');function h({modules:a,siwx:r}){let l=a.useWallets(),o=chunkHEG6FP5Z_cjs.b(t=>t.activeConnection),e=chunkHEG6FP5Z_cjs.b(t=>t.updateActiveConnection),c=chunkHEG6FP5Z_cjs.b(t=>t.connectionError),s=chunkHEG6FP5Z_cjs.b(t=>t.disconnect),i=react.useContext(chunkHEG6FP5Z_cjs.a),S=chunkLSWAATDN_cjs.a(r),{createWatcher:p}=a;return react.useEffect(()=>p({wallets:l,siwx:S},{disconnect:s,updateActiveConnection:e,getState:()=>i?.getState()??{activeConnection:o,connectionError:c}}),[p,i,l,S,o?.connectorType,c,e,s]),null}function b(a={}){let[r,l]=react.useState(null);return react.useEffect(()=>{let o=true;return Promise.all([import('@tuwaio/satellite-solana'),import('@wallet-standard/react')]).then(([e,c])=>{o&&l({createWatcher:e.createSolanaConnectionsWatcher,useWallets:c.useWallets});}).catch(e=>console.warn("Failed to load Solana watcher:",e)),()=>{o=false;}},[]),r?jsxRuntime.jsx(h,{modules:r,...a}):null}exports.SolanaConnectorsWatcher=b;

package/dist/solana/index.d.cts

@@ -8,41 +8,52 @@ import { SatelliteSiwxState } from '@tuwaio/satellite-core';
  */
 interface SolanaConnectorsWatcherProps {
     /**
-     * Optional Sign-In With X (SIWX) session state.
-     * If provided, the watcher will manage updates and disconnections based on SIWX status.
-     * Directly compatible with `useSiwxSession()` from `@tuwaio/siwx-react`.
+     * Optional Sign-In With X (SIWX) session state, for example the result of `useSiwxSession()` from
+     * `@tuwaio/siwx-react`. The watcher runs again when one of its fields changes.
      */
     siwx?: SatelliteSiwxState;
 }
 /**
- * A dynamic version of the SolanaConnectorsWatcher component that avoids static imports.
- * This component dynamically imports the dependencies only when they are available.
+ * Headless component that keeps the Satellite Connect store in sync with the Solana wallets of the Wallet Standard.
+ * Render it once inside `SatelliteConnectProvider`, next to a Solana adapter.
  *
- * @param props - Component props containing optional SIWX session state.
- * @returns null - This is a headless component
+ * After mount it loads `@tuwaio/satellite-solana` and `@wallet-standard/react` with dynamic imports. Whenever the list
+ * of registered wallets (from `useWallets`) changes, it runs `createSolanaConnectionsWatcher`: an account change in
+ * the connected wallet updates the active connection and a wallet without accounts is disconnected. With `siwx`, the
+ * connection is disconnected when the SIWX sign-in is rejected or fails, or when the account no longer matches the
+ * signed-in session. It also runs when a field of `siwx`, the active connector or the connection error changes. If an
+ * import fails, a warning is logged and nothing is watched.
+ *
+ * @param props - The component props. See {@link SolanaConnectorsWatcherProps}.
+ * @returns `null`; the component renders nothing.
  *
  * @example
  * ```tsx
- * import { useSiwxSession } from '@tuwaio/siwx-react';
  * import { SolanaConnectorsWatcher } from '@tuwaio/satellite-react/solana';
+ * import { useSiwxSession } from '@tuwaio/siwx-react';
  *
- * function WatcherContainer() {
+ * export function WatcherContainer() {
  *   const siwxSession = useSiwxSession();
  *   return <SolanaConnectorsWatcher siwx={siwxSession} />;
  * }
  * ```
- *
- * @remarks
- * Monitors Wallet Standard account changes. Automatically disconnects wallet state if SIWX
- * session validation fails or is rejected.
  */
 declare function SolanaConnectorsWatcher(props?: SolanaConnectorsWatcherProps): react.JSX.Element | null;
 
+/**
+ * The Solana watcher component, imported from `@tuwaio/satellite-react/solana`. Importing this entry point also adds
+ * `SolanaConnection` and `ConnectorSolana` from `@tuwaio/satellite-solana` to `AllConnections` and `AllConnectors`.
+ *
+ * @module solana
+ */
+
 declare module '@tuwaio/satellite-react' {
     interface AllConnections {
+        /** Solana connections (`SolanaConnection` from `@tuwaio/satellite-solana`), added by `@tuwaio/satellite-react/solana`. */
         [OrbitAdapter.SOLANA]: SolanaConnection;
     }
     interface AllConnectors {
+        /** Wallet Standard wallets (`ConnectorSolana` from `@tuwaio/satellite-solana`), added by `@tuwaio/satellite-react/solana`. */
         [OrbitAdapter.SOLANA]: ConnectorSolana;
     }
 }