@tuwaio/nova-connect 0.1.1 → 0.1.2

package/dist/useWalletNativeBalance-D8Ehciju.d.cts

@@ -0,0 +1,312 @@
+import * as React$1 from 'react';
+import { OrbitAdapter } from '@tuwaio/orbit-core';
+import { N as NovaConnectLabels } from './types-D4Vti05g.cjs';
+
+type ButtonTxStatus = 'idle' | 'loading' | 'succeed' | 'failed' | 'replaced';
+type ConnectContentType = 'network' | 'connectors' | 'about' | 'getWallet' | 'connecting' | 'impersonate';
+type ConnectedContentType = 'main' | 'transactions' | 'chains';
+interface NovaConnectProviderProps {
+    children: React.ReactNode;
+    labels?: Partial<NovaConnectLabels>;
+}
+interface WalletBalance {
+    value: string;
+    symbol: string;
+}
+interface NovaConnectProviderType {
+    isConnectModalOpen: boolean;
+    setIsConnectModalOpen: (value: boolean) => void;
+    isConnectedModalOpen: boolean;
+    setIsConnectedModalOpen: (value: boolean) => void;
+    isChainsListOpen: boolean;
+    setIsChainsListOpen: (value: boolean) => void;
+    isChainsListOpenMobile: boolean;
+    setIsChainsListOpenMobile: (value: boolean) => void;
+    connectedButtonStatus: ButtonTxStatus;
+    setConnectedButtonStatus: (value: ButtonTxStatus) => void;
+    isConnected: boolean;
+    setIsConnected: (value: boolean) => void;
+    connectedModalContentType: ConnectedContentType;
+    setConnectedModalContentType: (value: ConnectedContentType) => void;
+    connectModalContentType: ConnectContentType;
+    setConnectModalContentType: (value: ConnectContentType) => void;
+    selectedAdapter: OrbitAdapter | undefined;
+    setSelectedAdapter: (value: OrbitAdapter | undefined) => void;
+    activeConnector: string | undefined;
+    setActiveConnector: (value: string | undefined) => void;
+    impersonatedAddress: string;
+    setImpersonatedAddress: (value: string) => void;
+}
+declare class NovaConnectProviderError extends Error {
+    constructor(message?: string);
+}
+declare const NovaConnectProviderContext: React$1.Context<NovaConnectProviderType | undefined>;
+/**
+ * Hook to access NovaConnect context
+ *
+ * @throws {NovaConnectProviderError} When used outside of NovaConnectProvider
+ * @returns {NovaConnectProviderType} The NovaConnect context value
+ *
+ * @example
+ * ```typescript
+ * function MyComponent() {
+ *   const { isConnected, handleConnectButtonClick } = useNovaConnect();
+ *
+ *   return (
+ *     <button onClick={handleConnectButtonClick}>
+ *       {isConnected ? 'Connected' : 'Connect Wallet'}
+ *     </button>
+ *   );
+ * }
+ * ```
+ */
+declare const useNovaConnect: () => NovaConnectProviderType;
+/**
+ * Hook to check if NovaConnect context is available
+ *
+ * @returns {boolean} True if context is available, false otherwise
+ *
+ * @example
+ * ```typescript
+ * function ConditionalComponent() {
+ *   const hasContext = useHasNovaConnectContext();
+ *
+ *   if (!hasContext) {
+ *     return <div>NovaConnect provider not found</div>;
+ *   }
+ *
+ *   return <ConnectedComponent />;
+ * }
+ * ```
+ */
+declare const useHasNovaConnectContext: () => boolean;
+/**
+ * Optional hook that returns null if provider is not available
+ *
+ * @returns {NovaConnectProviderType | null} Context value or null if not available
+ *
+ * @example
+ * ```typescript
+ * function OptionalComponent() {
+ *   const context = useNovaConnectOptional();
+ *
+ *   if (!context) {
+ *     return <div>No wallet provider available</div>;
+ *   }
+ *
+ *   return <div>Connected: {context.isConnected}</div>;
+ * }
+ * ```
+ */
+declare const useNovaConnectOptional: () => NovaConnectProviderType | null;
+
+/**
+ * React Context for storing and providing the UI labels.
+ * It is initialized with the default English labels, ensuring that components
+ * work even without an explicit provider.
+ */
+declare const NovaConnectLabelsContext: React$1.Context<NovaConnectLabels>;
+/**
+ * A custom hook to easily access the i18n labels from any component
+ * within the `NovaConnectLabelsProvider` tree.
+ *
+ * This hook provides type-safe access to all UI labels and automatically
+ * falls back to default English labels if no provider is found.
+ *
+ * @returns {NovaConnectLabels} The complete object of UI labels for the current locale.
+ *
+ * @example
+ * ```typescript
+ * import { useNovaConnectLabels } from './hooks/useNovaConnectLabels';
+ *
+ * function MyComponent() {
+ *   const labels = useNovaConnectLabels();
+ *
+ *   return (
+ *     <div>
+ *       <h1>{labels.connectWallet}</h1>
+ *       <button>{labels.connect}</button>
+ *       <p aria-label={labels.walletBalance}>{formattedBalance}</p>
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Destructuring specific labels for better performance
+ * function ConnectButton() {
+ *   const { connectWallet, connecting, connected } = useNovaConnectLabels();
+ *
+ *   return (
+ *     <button>
+ *       {isConnecting ? connecting : isConnected ? connected : connectWallet}
+ *     </button>
+ *   );
+ * }
+ * ```
+ */
+declare const useNovaConnectLabels: () => NovaConnectLabels;
+/**
+ * Hook to get a specific label by key path with type safety
+ *
+ * @param key The label key to retrieve
+ * @returns The specific label value
+ *
+ * @example
+ * ```typescript
+ * function MyComponent() {
+ *   const connectLabel = useNovaConnectLabel('connectWallet');
+ *   const errorLabel = useNovaConnectLabel('connectionError');
+ *
+ *   return <button>{connectLabel}</button>;
+ * }
+ * ```
+ */
+declare const useNovaConnectLabel: <K extends keyof NovaConnectLabels>(key: K) => NovaConnectLabels[K];
+/**
+ * Hook to get multiple specific labels for better performance
+ *
+ * @param keys Array of label keys to retrieve
+ * @returns Object with only the requested labels
+ *
+ * @example
+ * ```typescript
+ * function ConnectModal() {
+ *   const { connectWallet, connecting, disconnect } = useNovaConnectLabelsSubset(['connectWallet', 'connecting', 'disconnect']);
+ *
+ *   return (
+ *     <div>
+ *       <h2>{connectWallet}</h2>
+ *       <span>{connecting}</span>
+ *       <button>{disconnect}</button>
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare const useNovaConnectLabelsSubset: <K extends keyof NovaConnectLabels>(keys: K[]) => Pick<NovaConnectLabels, K>;
+/**
+ * Type-safe helper to check if a label exists
+ *
+ * @param labels The labels object
+ * @param key The key to check
+ * @returns Whether the key exists and has a non-empty value
+ */
+declare const hasLabel: (labels: NovaConnectLabels, key: keyof NovaConnectLabels) => boolean;
+/**
+ * Utility type for extracting label keys by category
+ */
+type LabelCategory = {
+    actions: Extract<keyof NovaConnectLabels, 'connectWallet' | 'disconnect' | 'connecting' | 'connected' | 'tryAgain' | 'back' | 'connect' | 'close'>;
+    states: Extract<keyof NovaConnectLabels, 'success' | 'error' | 'replaced' | 'loading' | 'idle'>;
+    accessibility: Extract<keyof NovaConnectLabels, 'chainSelector' | 'closeModal' | 'selectChain' | 'walletControls' | 'openWalletModal'>;
+    transactions: Extract<keyof NovaConnectLabels, 'transactionLoading' | 'transactionSuccess' | 'transactionError' | 'transactionReplaced' | 'recent'>;
+};
+/**
+ * Hook to get labels by category for better organization
+ *
+ * @param category The category of labels to retrieve
+ * @returns Object with labels from the specified category
+ */
+declare const useLabelsByCategory: <T extends keyof LabelCategory>(category: T) => Pick<NovaConnectLabels, LabelCategory[T]>;
+/**
+ * Utility function to check if labels are default ones (for external use)
+ * This is a regular function, not a hook, so it can be used anywhere
+ *
+ * @param labels The labels to check
+ * @returns Whether the labels are the default English labels
+ *
+ * @example
+ * ```typescript
+ * function SomeUtilityFunction(labels: NovaConnectLabels) {
+ *   if (isDefaultLabels(labels)) {
+ *     console.log('Using default English labels');
+ *   }
+ * }
+ * ```
+ */
+declare const isDefaultLabels: (labels: NovaConnectLabels) => boolean;
+/**
+ * Utility function to get a formatted label with fallback
+ *
+ * @param labels The labels object
+ * @param key The label key
+ * @param fallback Optional fallback text
+ * @returns The label value or fallback
+ *
+ * @example
+ * ```typescript
+ * const buttonText = getLabelWithFallback(labels, 'connectWallet', 'Connect');
+ * ```
+ */
+declare const getLabelWithFallback: (labels: NovaConnectLabels, key: keyof NovaConnectLabels, fallback?: string) => string;
+/**
+ * Utility function to create a labels subset (for use outside of React components)
+ *
+ * @param labels The source labels object
+ * @param keys Array of keys to extract
+ * @returns Object with only the requested labels
+ *
+ * @example
+ * ```typescript
+ * const actionLabels = createLabelsSubset(labels, ['connect', 'disconnect', 'tryAgain']);
+ * ```
+ */
+declare const createLabelsSubset: <K extends keyof NovaConnectLabels>(labels: NovaConnectLabels, keys: K[]) => Pick<NovaConnectLabels, K>;
+
+/**
+ * @interface NativeBalanceResult
+ * Represents the native token balance returned by the adapter.
+ * The value is already formatted for human readability.
+ * @property {string} value The native token balance formatted to standard decimals (e.g., "1.5").
+ * @property {string} symbol The symbol of the native token (e.g., "ETH").
+ */
+interface NativeBalanceResult {
+    value: string;
+    symbol: string;
+}
+type NativeBalanceState = NativeBalanceResult | null;
+/**
+ * @interface NativeBalanceData
+ * The object returned by the useWalletNativeBalance hook.
+ * @property {NativeBalanceState} balance The native token balance and symbol, or null.
+ * @property {boolean} isLoading True while the balance is being fetched for the current wallet/chain combination.
+ * @property {() => void} refetch Function to manually trigger a balance refresh.
+ */
+interface NativeBalanceData {
+    balance: NativeBalanceState;
+    isLoading: boolean;
+    refetch: () => void;
+}
+/**
+ * Custom hook to fetch the native token balance for the currently connected wallet
+ * on the active chain. It includes a local cache layer to prevent redundant network calls
+ * when switching between components or on re-renders for the same wallet/chain.
+ *
+ * @returns {NativeBalanceData} An object containing the balance data and loading state.
+ *
+ * @example
+ * ```typescript
+ * import { useWalletNativeBalance } from './useWalletNativeBalance';
+ *
+ * function NativeTokenDisplay() {
+ *   const { balance, isLoading, refetch } = useWalletNativeBalance();
+ *
+ *   if (isLoading) {
+ *     return <p>Loading balance...</p>;
+ *   }
+ *
+ *   // Display the formatted balance and symbol
+ *   return (
+ *     <div>
+ *       <p>Balance: {balance ? `${balance.value} ${balance.symbol}` : '0.00'}</p>
+ *       <button onClick={refetch}>Refresh</button>
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useWalletNativeBalance(): NativeBalanceData;
+
+export { type ButtonTxStatus as B, type ConnectContentType as C, type LabelCategory as L, type NovaConnectProviderType as N, type WalletBalance as W, type ConnectedContentType as a, type NovaConnectProviderProps as b, NovaConnectProviderError as c, NovaConnectProviderContext as d, useHasNovaConnectContext as e, useNovaConnectOptional as f, NovaConnectLabelsContext as g, useNovaConnectLabels as h, useNovaConnectLabel as i, useNovaConnectLabelsSubset as j, hasLabel as k, useLabelsByCategory as l, isDefaultLabels as m, getLabelWithFallback as n, createLabelsSubset as o, type NativeBalanceResult as p, useWalletNativeBalance as q, useNovaConnect as u };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tuwaio/nova-connect",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "private": false,
   "author": "Oleksandr Tkach",
   "license": "Apache-2.0",
@@ -15,6 +15,26 @@
       "import": "./dist/index.cjs",
       "default": "./dist/index.js"
     },
+    "./components": {
+      "types": "./dist/components/index.d.ts",
+      "import": "./dist/components/index.cjs",
+      "default": "./dist/components/index.js"
+    },
+    "./hooks": {
+      "types": "./dist/hooks/index.d.ts",
+      "import": "./dist/hooks/index.cjs",
+      "default": "./dist/hooks/index.js"
+    },
+    "./i18n": {
+      "types": "./dist/i18n/index.d.ts",
+      "import": "./dist/i18n/index.cjs",
+      "default": "./dist/i18n/index.js"
+    },
+    "./satellite": {
+      "types": "./dist/satellite/index.d.ts",
+      "import": "./dist/satellite/index.cjs",
+      "default": "./dist/satellite/index.js"
+    },
     "./evm": {
       "types": "./dist/evm/index.d.ts",
       "import": "./dist/evm/index.cjs",

package/dist/getChainsListByWalletType-ZU7OPWTP.cjs

@@ -1,2 +0,0 @@
-'use strict';var chunk6S5OTERL_cjs=require('./chunk-6S5OTERL.cjs');Object.defineProperty(exports,"getAdapterStatus",{enumerable:true,get:function(){return chunk6S5OTERL_cjs.k}});Object.defineProperty(exports,"getAllAdaptersStatus",{enumerable:true,get:function(){return chunk6S5OTERL_cjs.l}});Object.defineProperty(exports,"getAvailableSolanaClusters",{enumerable:true,get:function(){return chunk6S5OTERL_cjs.g}});Object.defineProperty(exports,"getChainsListByWalletType",{enumerable:true,get:function(){return chunk6S5OTERL_cjs.a}});Object.defineProperty(exports,"getChainsListByWalletTypeSync",{enumerable:true,get:function(){return chunk6S5OTERL_cjs.b}});Object.defineProperty(exports,"getWalletChains",{enumerable:true,get:function(){return chunk6S5OTERL_cjs.i}});Object.defineProperty(exports,"isEvmChainList",{enumerable:true,get:function(){return chunk6S5OTERL_cjs.c}});Object.defineProperty(exports,"isEvmChainListSync",{enumerable:true,get:function(){return chunk6S5OTERL_cjs.e}});Object.defineProperty(exports,"isSolanaChainList",{enumerable:true,get:function(){return chunk6S5OTERL_cjs.d}});Object.defineProperty(exports,"isSolanaChainListSync",{enumerable:true,get:function(){return chunk6S5OTERL_cjs.f}});Object.defineProperty(exports,"isValidSolanaCluster",{enumerable:true,get:function(){return chunk6S5OTERL_cjs.h}});Object.defineProperty(exports,"preloadChainAdapters",{enumerable:true,get:function(){return chunk6S5OTERL_cjs.j}});//# sourceMappingURL=getChainsListByWalletType-ZU7OPWTP.cjs.map
-//# sourceMappingURL=getChainsListByWalletType-ZU7OPWTP.cjs.map