@lydianpay/lydianconnect 1.0.0 → 1.1.0

package/dist/index.d.ts

@@ -1,8 +1,14 @@
-import { SignClientTypes } from '@walletconnect/types';
-import { MetaMaskSDKOptions } from '@metamask/sdk';
+/** Shared app identity passed to every connector; mapped to each SDK's own shape internally. */
+interface AppConfig {
+    /** Display name shown in the wallet's connect prompt. */
+    appName: string;
+    /** Optional icon shown in the wallet's connect prompt. */
+    icon?: string;
+    /** Optional description; defaults to appName. */
+    description?: string;
+}
 
-type ConnectorType = 'walletconnect' | 'sdk' | 'injected';
-/** A CAIP namespace request — pay already models this per-network today. */
+/** A CAIP namespace request — the host app already models this per-network. */
 interface CaipNamespace {
     /** Namespace identifier, e.g. "eip155", "solana". */
     name: string;
@@ -28,8 +34,30 @@ interface Connection {
         method: string;
         params?: unknown;
     }): Promise<T>;
+    /**
+     * Bring the wallet app to the foreground (mobile) — call right before a request
+     * the user must approve. No-op for native-SDK wallets (their SDK foregrounds the
+     * wallet itself) and on desktop.
+     */
+    openWallet(): void;
     disconnect(): Promise<void>;
 }
+/**
+ * The single config object the host app passes to `LydianConnect`.
+ * Extends {@link AppConfig} so the shared identity fields (appName/icon/description)
+ * are defined once and can't drift between the two shapes.
+ */
+interface LydianConnectConfig extends AppConfig {
+    /** WalletConnect Cloud project id — powers the fallback. */
+    walletConnectProjectId: string;
+}
+interface ConnectInput {
+    walletId: string;
+    /** Chain to connect on — a number (EVM, e.g. 137) or a CAIP-2 id ('eip155:137'). */
+    chainId: number | string;
+    /** Cancel a pending connection. */
+    signal?: AbortSignal;
+}
 type LydianConnectEvent = 
 /** WalletConnect only — the wc: URI. Deep-linking is fired internally; emitted for QR display. */
 {
@@ -60,174 +88,21 @@ type LydianConnectEvent =
 };
 type LydianConnectEventHandler = (event: LydianConnectEvent) => void;
 
-interface ConnectRequest {
-    walletId: string;
-    namespace: CaipNamespace;
-    /** Cancel a pending connection (replaces the host app's manual cancel plumbing). */
-    signal?: AbortSignal;
-}
 /**
- * Internal contract every connector implements. The host app never sees this —
- * it only ever touches {@link LydianConnect} and the {@link Connection} handle.
- */
-interface Connector {
-    readonly type: ConnectorType;
-    /**
-     * Wallet ids this connector natively serves. The WalletConnect fallback
-     * returns an empty list and claims any wallet not served by another connector.
-     */
-    readonly walletIds: readonly string[];
-    isAvailable(walletId: string): boolean | Promise<boolean>;
-    connect(req: ConnectRequest): Promise<Connection>;
-    /** Rebuild Connections for still-live sessions — the reconnect-on-reload case. */
-    restore(): Promise<Connection[]>;
-    /** Tear down everything this connector owns. */
-    reset(): Promise<void>;
-    on(handler: LydianConnectEventHandler): () => void;
-}
-declare abstract class BaseConnector implements Connector {
-    abstract readonly type: ConnectorType;
-    readonly walletIds: readonly string[];
-    private handlers;
-    abstract isAvailable(walletId: string): boolean | Promise<boolean>;
-    abstract connect(req: ConnectRequest): Promise<Connection>;
-    restore(): Promise<Connection[]>;
-    reset(): Promise<void>;
-    on(handler: LydianConnectEventHandler): () => void;
-    protected emit(event: LydianConnectEvent): void;
-}
-
-interface LydianConnectConfig {
-    /** SDK/injected connectors, each serving specific walletIds (MetaMask, Coinbase…). */
-    connectors?: Connector[];
-    /** Fallback for any wallet not served above — the WalletConnect connector. */
-    fallback: Connector;
-}
-interface ConnectInput {
-    walletId: string;
-    namespace: CaipNamespace;
-    signal?: AbortSignal;
-}
-/**
- * The single surface the host app touches. Routes each wallet to its native
- * SDK connector when one is registered, otherwise to the WalletConnect
- * fallback — and hands back a uniform {@link Connection} either way.
+ * The single surface the host app touches. Hand it a flat config; it owns the
+ * connectors and routes each wallet to its native SDK (or the WalletConnect
+ * fallback), returning a uniform {@link Connection} either way.
  */
 declare class LydianConnect {
-    private byWallet;
-    private fallback;
-    private all;
-    private connections;
-    private handlers;
-    private unsubs;
-    private started;
+    private manager;
     constructor(config: LydianConnectConfig);
-    /** Wire connector event forwarding, once. Safe to call repeatedly. */
     init(): Promise<void>;
-    /** SDK connector if one claims this walletId, else the WC fallback. The host app is oblivious. */
-    private resolve;
     connect(input: ConnectInput): Promise<Connection>;
-    /** Resume any live sessions across all connectors (e.g. after a page reload). */
     restore(): Promise<Connection[]>;
-    get(walletId: string): Connection | undefined;
     disconnect(walletId?: string): Promise<void>;
-    /** Disconnect everything and clear all connector-held state. */
     reset(): Promise<void>;
+    get(walletId: string): Connection | undefined;
     on(handler: LydianConnectEventHandler): () => void;
-    private handle;
-    private emit;
-}
-
-interface WalletLink {
-    /** Custom scheme deep link incl. the `wc` path; we append `?uri=`. e.g. "metamask://wc". */
-    scheme?: string;
-    /** Universal/applink incl. the `wc` path, preferred on mobile (OS falls back to the store). */
-    universal?: string;
-    /** App store links — used for the "wallet not installed" fallback. */
-    store?: {
-        ios?: string;
-        android?: string;
-    };
-}
-declare const DEFAULT_WALLET_LINKS: Record<string, WalletLink>;
-
-interface WalletConnectConfig {
-    projectId: string;
-    metadata: SignClientTypes.Metadata;
-    relayUrl?: string;
-    walletLinks?: Record<string, WalletLink>;
-    openTimeoutMs?: number;
-}
-declare class WalletConnectConnector extends BaseConnector {
-    private config;
-    readonly type: "walletconnect";
-    readonly walletIds: readonly string[];
-    private client;
-    private links;
-    private topics;
-    private warm;
-    private warming;
-    constructor(config: WalletConnectConfig);
-    isAvailable(): boolean;
-    private getClient;
-    /** Pre-create a pairing so connect() can deep-link synchronously within the gesture. */
-    private warmup;
-    connect(req: ConnectRequest): Promise<Connection>;
-    restore(): Promise<Connection[]>;
-    reset(): Promise<void>;
-    private tryReuse;
-    private toConnection;
-    private liveSession;
-    private walletForTopic;
-    private persist;
-    private load;
-}
-
-interface MetaMaskConfig {
-    dappMetadata: MetaMaskSDKOptions['dappMetadata'];
-    /** Extra options forwarded to MetaMaskSDK (infuraAPIKey, logging, …). */
-    sdkOptions?: Omit<MetaMaskSDKOptions, 'dappMetadata'>;
-}
-declare class MetaMaskConnector extends BaseConnector {
-    private config;
-    readonly type: "sdk";
-    readonly walletIds: readonly ["metamask"];
-    private sdk;
-    private provider;
-    private listenersBound;
-    constructor(config: MetaMaskConfig);
-    isAvailable(): boolean;
-    private getProvider;
-    private bindEvents;
-    connect(req: ConnectRequest): Promise<Connection>;
-    restore(): Promise<Connection[]>;
-    reset(): Promise<void>;
-    /** Best-effort switch to the requested chain; leaves the wallet as-is if it's unknown to it. */
-    private ensureChain;
-    private toConnection;
-}
-
-interface CoinbaseConfig {
-    appName: string;
-    appLogoUrl?: string;
-    /** EVM chain ids the dapp supports, passed to the SDK. */
-    appChainIds?: number[];
-}
-declare class CoinbaseConnector extends BaseConnector {
-    private config;
-    readonly type: "sdk";
-    readonly walletIds: readonly ["coinbase"];
-    private provider;
-    private listenersBound;
-    constructor(config: CoinbaseConfig);
-    isAvailable(): boolean;
-    private getProvider;
-    private bindEvents;
-    connect(req: ConnectRequest): Promise<Connection>;
-    restore(): Promise<Connection[]>;
-    reset(): Promise<void>;
-    private ensureChain;
-    private toConnection;
 }
 
-export { BaseConnector, type CaipNamespace, type CoinbaseConfig, CoinbaseConnector, type ConnectInput, type ConnectRequest, type Connection, type Connector, type ConnectorType, DEFAULT_WALLET_LINKS, LydianConnect, type LydianConnectConfig, type LydianConnectEvent, type LydianConnectEventHandler, type MetaMaskConfig, MetaMaskConnector, type WalletConnectConfig, WalletConnectConnector, type WalletLink };
+export { type CaipNamespace, type ConnectInput, type Connection, LydianConnect, type LydianConnectConfig, type LydianConnectEvent, type LydianConnectEventHandler };