@phantom/browser-sdk 1.0.0-beta.2 → 1.0.0-beta.21

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { EmbeddedProviderConfig, AuthOptions, ConnectResult, WalletAddress, EmbeddedProviderEvent, EventCallback } from '@phantom/embedded-provider-core';
-export { AuthOptions, ConnectResult, SignAndSendTransactionParams, SignMessageParams, SignMessageResult, SignedTransaction, WalletAddress } from '@phantom/embedded-provider-core';
-import { ISolanaChain, IEthereumChain } from '@phantom/chains';
-export { EthTransactionRequest, IEthereumChain, ISolanaChain } from '@phantom/chains';
+export { AuthOptions, ConnectErrorEventData, ConnectEventData, ConnectResult, ConnectStartEventData, DisconnectEventData, EmbeddedProviderEvent, EmbeddedProviderEventMap, EventCallback, SignAndSendTransactionParams, SignMessageParams, SignMessageResult, SignedTransaction, WalletAddress } from '@phantom/embedded-provider-core';
+import { ISolanaChain, IEthereumChain } from '@phantom/chain-interfaces';
+export { EthTransactionRequest, IEthereumChain, ISolanaChain } from '@phantom/chain-interfaces';
 import { AddressType } from '@phantom/client';
 export { AddressType } from '@phantom/client';
 import { AutoConfirmEnableParams, AutoConfirmResult, AutoConfirmSupportedChainsResult } from '@phantom/browser-injected-sdk/auto-confirm';
@@ -52,18 +52,69 @@ declare const DebugCategory: {
     readonly SESSION: "Session";
 };
 
+/**
+ * Phantom extension app.login API types
+ */
+interface PhantomAppLoginOptions {
+    publicKey: string;
+    appId: string;
+    sessionId: string;
+}
+interface PhantomAppLoginResult {
+    walletId: string;
+    organizationId: string;
+    accountDerivationIndex?: number;
+    expiresInMs?: number;
+    authUserId?: string;
+}
+interface PhantomApp {
+    login(options: PhantomAppLoginOptions): Promise<PhantomAppLoginResult>;
+    features(): Promise<{
+        features: string[];
+    }>;
+    getUser(): Promise<{
+        authUserId?: string;
+    } | undefined>;
+}
+declare global {
+    interface Window {
+        phantom?: {
+            solana?: unknown;
+            ethereum?: unknown;
+            app?: PhantomApp;
+        } | undefined;
+    }
+}
+
+interface InjectedProviderConfig {
+    addressTypes: AddressType[];
+}
+
 interface DebugConfig {
     enabled?: boolean;
     level?: DebugLevel;
     callback?: DebugCallback;
 }
-interface BrowserSDKConfig extends Partial<EmbeddedProviderConfig> {
-    providerType: "injected" | "embedded" | (string & Record<never, never>);
-    addressTypes: [AddressType, ...AddressType[]];
-    apiBaseUrl?: string;
-    appId?: string;
-    embeddedWalletType?: "app-wallet" | "user-wallet" | (string & Record<never, never>);
+type BrowserSDKConfig = Prettify<(ExtendedEmbeddedProviderConfig | ExtendedInjectedProviderConfig) & {
     autoConnect?: boolean;
+}>;
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+interface ExtendedEmbeddedProviderConfig extends Omit<EmbeddedProviderConfig, "authOptions" | "apiBaseUrl" | "embeddedWalletType"> {
+    providerType: "embedded";
+    apiBaseUrl?: string;
+    embeddedWalletType?: "app-wallet" | "user-wallet";
+    authOptions?: {
+        authUrl?: string;
+        redirectUrl?: string;
+    };
+}
+interface ExtendedInjectedProviderConfig extends InjectedProviderConfig {
+    providerType: "injected";
+    appId?: never;
+    authOptions?: never;
+    embeddedWalletType?: never;
 }
 
 interface Provider {
@@ -71,6 +122,7 @@ interface Provider {
     disconnect(): Promise<void>;
     getAddresses(): WalletAddress[];
     isConnected(): boolean;
+    autoConnect(): Promise<void>;
     solana: ISolanaChain;
     ethereum: IEthereumChain;
 }
@@ -79,9 +131,6 @@ interface ProviderPreference {
     type: "injected" | "embedded";
     embeddedWalletType?: "app-wallet" | "user-wallet";
 }
-interface SwitchProviderOptions {
-    embeddedWalletType?: "app-wallet" | "user-wallet" | (string & Record<never, never>);
-}
 
 /**
  * Browser SDK with chain-specific API
@@ -110,15 +159,11 @@ declare class BrowserSDK {
     /**
      * Connect to the wallet
      */
-    connect(options?: AuthOptions): Promise<ConnectResult>;
+    connect(options: AuthOptions): Promise<ConnectResult>;
     /**
      * Disconnect from the wallet
      */
     disconnect(): Promise<void>;
-    /**
-     * Switch between provider types (injected vs embedded)
-     */
-    switchProvider(type: "injected" | "embedded", options?: SwitchProviderOptions): Promise<void>;
     /**
      * Check if the SDK is connected to a wallet
      */
@@ -131,10 +176,6 @@ declare class BrowserSDK {
      * Get information about the current provider
      */
     getCurrentProviderInfo(): ProviderPreference | null;
-    /**
-     * Get the wallet ID (for embedded wallets)
-     */
-    getWalletId(): string | null;
     /**
      * Check if Phantom extension is installed
      */
@@ -152,7 +193,7 @@ declare class BrowserSDK {
     /**
      * Attempt auto-connection using existing session
      * Should be called after setting up event listeners
-     * Only works with embedded providers
+     * Tries embedded provider first, then injected provider as fallback
      */
     autoConnect(): Promise<void>;
     /**
@@ -205,18 +246,13 @@ declare class BrowserSDK {
     getSupportedAutoConfirmChains(): Promise<AutoConfirmSupportedChainsResult>;
 }
 
-/**
- * Constants used throughout the browser SDK
- */
-declare const DEFAULT_AUTH_URL = "https://connect.phantom.app";
-declare const DEFAULT_WALLET_API_URL = "https://api.phantom.app/v1/wallets";
-
 /**
  * Browser detection utility to identify browser name and version
  */
 interface BrowserInfo {
     name: string;
     version: string;
+    userAgent: string;
 }
 /**
  * Parse browser information from a user agent string
@@ -237,6 +273,18 @@ declare function getPlatformName(): string;
  * Format: "Chrome 120.0" or "Firefox 119.0"
  */
 declare function getBrowserDisplayName(): string;
+/**
+ * Detect if the current device is a mobile device
+ * Checks user agent for mobile indicators and screen size
+ */
+declare function isMobileDevice(): boolean;
+
+/**
+ * Generates a deeplink URL to open the current page in Phantom mobile app
+ * @param ref Optional referrer parameter
+ * @returns Phantom mobile app deeplink URL
+ */
+declare function getDeeplinkToPhantom(ref?: string): string;
 
 /**
  * Wait for Phantom extension to be available with retry logic
@@ -256,4 +304,26 @@ declare function getBrowserDisplayName(): string;
  */
 declare function waitForPhantomExtension(timeoutMs?: number): Promise<boolean>;
 
-export { BrowserInfo, BrowserSDK, BrowserSDKConfig, DEFAULT_AUTH_URL, DEFAULT_WALLET_API_URL, DebugCallback, DebugCategory, DebugConfig, DebugLevel, DebugMessage, Provider, debug, detectBrowser, getBrowserDisplayName, getPlatformName, parseBrowserFromUserAgent, waitForPhantomExtension };
+/**
+ * Check if Phantom Login is available
+ *
+ * This function checks if:
+ * 1. The Phantom extension is installed
+ * 2. The extension supports the phantom_login feature
+ *
+ * @param timeoutMs - Maximum time to wait for extension in milliseconds (default: 3000)
+ * @returns Promise<boolean> - true if Phantom Login is available, false otherwise
+ *
+ * Usage:
+ * ```typescript
+ * const isAvailable = await isPhantomLoginAvailable();
+ * if (isAvailable) {
+ *   console.log("Phantom Login is available!");
+ * } else {
+ *   console.log("Phantom Login is not available");
+ * }
+ * ```
+ */
+declare function isPhantomLoginAvailable(timeoutMs?: number): Promise<boolean>;
+
+export { BrowserInfo, BrowserSDK, BrowserSDKConfig, DebugCallback, DebugCategory, DebugConfig, DebugLevel, DebugMessage, Provider, debug, detectBrowser, getBrowserDisplayName, getDeeplinkToPhantom, getPlatformName, isMobileDevice, isPhantomLoginAvailable, parseBrowserFromUserAgent, waitForPhantomExtension };