@privy-io/react-auth 1.37.2-beta.4 → 1.38.0-beta.2

package/dist/index.d.ts

@@ -17,7 +17,7 @@ import { FetchOptions } from 'ofetch';
  */
 
 declare const SUPPORTED_JSON_RPC_METHODS: readonly ["eth_sign", "eth_populateTransactionRequest", "eth_signTransaction", "personal_sign", "eth_signTypedData_v4"];
-type JsonRpcMethodType = typeof SUPPORTED_JSON_RPC_METHODS[number];
+type JsonRpcMethodType = (typeof SUPPORTED_JSON_RPC_METHODS)[number];
 type Quantity = string | number | bigint;
 type UnsignedTransactionRequest = {
     from?: string;
@@ -175,16 +175,26 @@ declare const DEFAULT_SUPPORTED_CHAINS: readonly [Chain, Chain, Chain, Chain, Ch
 
 type WalletCreateRequestDataType = {
     accessToken: string;
+    recoveryPassword?: string;
+    /**
+     * Will be deprecated in a future release, use `recoveryPassword` instead
+     * @deprecated
+     */
     recoveryPin?: string;
 };
-type WalletConnectRequestDataType = {
-    accessToken: string;
+type WalletRecoverRequestDataType = {
     address: string;
+    accessToken: string;
+    recoveryPassword?: string;
+    /**
+     * Will be deprecated in a future release, use `recoveryPassword` instead
+     * @deprecated
+     */
+    recoveryPin?: string;
 };
-type WalletRecoverRequestDataType = {
+type WalletConnectRequestDataType = {
     accessToken: string;
     address: string;
-    recoveryPin?: string;
 };
 type WalletRpcRequestDataType = {
     accessToken: string;
@@ -235,6 +245,7 @@ declare abstract class PrivyError extends Error {
 declare enum PrivyErrorCode {
     MISSING_OR_INVALID_PRIVY_APP_ID = "missing_or_invalid_privy_app_id",
     MISSING_OR_INVALID_PRIVY_ACCOUNT_ID = "missing_or_invalid_privy_account_id",
+    MISSING_OR_INVALID_TOKEN = "missing_or_invalid_token",
     INVALID_DATA = "invalid_data",
     LINKED_TO_ANOTHER_USER = "linked_to_another_user",
     ALLOWLIST_REJECTED = "allowlist_rejected",
@@ -287,8 +298,9 @@ interface EIP1193Provider {
     removeListener: (eventName: string | symbol, listener: (...args: any[]) => void) => any;
 }
 /**
- * The PrivyProxyProvider adds a middleware layer on top of the underlying wallet provider.
  * @hidden
+ *
+ * The PrivyProxyProvider adds a middleware layer on top of the underlying wallet provider.
  * */
 declare class PrivyProxyProvider implements EIP1193Provider {
     walletProvider?: EIP1193Provider;
@@ -322,8 +334,9 @@ declare class Embedded1193Provider extends EventEmitter implements EIP1193Provid
     connect(): Promise<string | null>;
 }
 /**
- * Shim to convert to ethers-compatible ExternalProvider class.
  * @hidden
+ *
+ * Shim to convert to ethers-compatible ExternalProvider class.
  */
 declare class AsExternalProvider extends PrivyProxyProvider implements ExternalProvider {
     constructor(provider: EIP1193Provider);
@@ -566,7 +579,6 @@ interface AuthFlow {
 interface ConnectorManagerEvents {
     walletsUpdated(): void;
 }
-/** @hidden */
 declare class ConnectorManager extends EventEmitter<ConnectorManagerEvents> {
     walletConnectors: WalletConnector[];
     initialized: boolean;
@@ -585,46 +597,15 @@ declare class ConnectorManager extends EventEmitter<ConnectorManagerEvents> {
      * 3. Active wallet is moved to front of array (if it exists)
      */
     get wallets(): BaseConnectedWallet[];
-    /**
-     * Detect and add all valid wallet connectors.
-     */
-    initialize(): void;
     /**
      * Helper function to find a wallet connector by connector type and wallet client type.
      */
     findWalletConnector(connectorType: ConnectorType, walletClientType: WalletClientType): WalletConnector | null;
-    /**
-     * Add any connectedAt overrides for newly initialized wallets and pass-through change events.
-     */
-    private onInitialized;
-    /**
-     * Save connection history and pass-through change events.
-     */
-    private onWalletsUpdated;
-    addEmbeddedWalletConnector(walletProxy: EmbeddedWalletProxy, address: string): void;
-    /**
-     * Normally, we do not remove connectors after creation. Privy embedded wallets are an exception
-     * because they are closely tied with an authenticated state.
-     */
-    removeEmbeddedWalletConnector(): void;
     /**
      * Creates a new wallet connector for the given connector type and wallet client type.
      * If a connector already exists, it will be returned instead.
      */
     createWalletConnector(connectorType: ConnectorType, walletClientType: WalletClientType): Promise<WalletConnector | null>;
-    private addWalletConnector;
-    /**
-     * Upon initialization, loads previous connections from local storage. If local storage
-     * is misformatted (e.g. due to previous privy:connectors usage), it returns an empty array that
-     * will be overwritten later.
-     *
-     * @returns StoredConnection[] list of stored connections from previous session
-     */
-    private loadConnectionHistory;
-    /**
-     * Saves all current connections to local storage overridding any previous connections.
-     */
-    private saveConnectionHistory;
     /**
      * @deprecated **Deprecated**: This feature will be removed and should be replaced by
      * interfacing with wallets directly (wallets[0].getEthereumProvider()).
@@ -784,40 +765,14 @@ type MoonpaySignResponse = {
 };
 
 declare const SUPPORTED_OAUTH_PROVIDERS: readonly ["google", "discord", "twitter", "github", "apple"];
-type OAuthProviderType = typeof SUPPORTED_OAUTH_PROVIDERS[number];
-/** @hidden */
+type OAuthProviderType = (typeof SUPPORTED_OAUTH_PROVIDERS)[number];
 type EmbeddedWalletClientType = 'privy';
-/** @hidden */
 type InjectedWalletClientType = 'metamask' | 'phantom';
-/** @hidden */
 type CoinbaseWalletClientType = 'coinbase_wallet';
-/** @hidden
- *
- * How this works:
- *
- * The raw data is pulled from https://registry.walletconnect.com/api/v3/wallets
- * Some post-processing is done using the following script.
- *
- * const axios = require('axios');
- * const walletTypes = [];
- * axios.get("https://explorer-api.walletconnect.com/v3/wallets?projectId=2f05ae7f1116030fde2d36508f472bfb&entries=400&page=1&version=2&chains=eip155%3A1").then((apiResult) => {
- *   Object.values(apiResult.data.listings).forEach((walletEntry) => {
- *     if (!walletEntry.mobile.native || !walletEntry.mobile.universal) return;
- *     if (!walletEntry.chains.includes('eip155:1')) return;
- *     if (!walletEntry.metadata.shortName) return;
- *     // Manually removed for cleanliness
- *     if (walletEntry.id === 'b2ce31fb31735fa886270806340de999f72342a7c29484badd8d4d013d77c8b8') return;
- *     if (walletEntry.id) walletTypes.push(`'${walletEntry.id}'`);
- *   });
- *   console.log(walletTypes.join("\n  | "));
- * });
- */
-type WalletConnectWalletClientType = 'metamask' | 'trust' | 'safe' | 'rainbow' | 'uniswap' | 'zerion' | 'argent' | 'spot' | 'omni' | 'cryptocom' | 'blockchain' | 'safepal' | 'bitkeep' | 'zengo' | '1inch' | 'binance' | 'exodus' | 'mew_wallet' | 'alphawallet' | 'keyring_pro' | 'mathwallet' | 'unstoppable' | 'obvious' | 'ambire' | 'internet_money_wallet' | 'coin98' | 'abc_wallet' | 'arculus_wallet' | 'haha' | 'cling_wallet' | 'broearn' | 'copiosa' | 'burrito_wallet' | 'enjin_wallet' | 'plasma_wallet' | 'avacus' | 'bee' | 'pitaka' | 'pltwallet' | 'minerva' | 'kryptogo' | 'prema' | 'slingshot' | 'kriptonio' | 'timeless' | 'secux' | 'bitizen' | 'blocto' | 'safemoon';
-/** @hidden */
 type UnknownWalletClientType = 'unknown';
 type WalletClientType = InjectedWalletClientType | CoinbaseWalletClientType | WalletConnectWalletClientType | EmbeddedWalletClientType | UnknownWalletClientType;
 declare const SUPPORTED_CONNECTOR_TYPES: string[];
-type ConnectorType = typeof SUPPORTED_CONNECTOR_TYPES[number];
+type ConnectorType = (typeof SUPPORTED_CONNECTOR_TYPES)[number];
 /**
  * Wallet metadata currently for internal use only
  */
@@ -1277,28 +1232,6 @@ type PrivyClientConfig = {
          */
         useSandbox?: boolean;
     };
-    /**
-     * Override the default rendering settings, used for displaying in a non-modal setting.
-     * For internal use only.
-     * @hidden
-     */
-    _render?: {
-        /**
-         * If true, the modal renders with a dialog, which centers the modal, blocks scrolling on the body, adds a backdrop,
-         * and adds a close button in the top right corner.
-         * If false, the modal renders wherever the portal is set to (defaults to the bottom of document.body), without the above features.
-         *
-         * Defaults to true.
-         */
-        inDialog?: boolean;
-        /**
-         * The id of the node to render the modal in, using a React portal.
-         * If the element with id specified does not exist, or is set to null, renders to document.body.
-         *
-         * Defaults to null.
-         */
-        inParentNodeId?: string | null;
-    };
 };
 interface AllowlistConfig {
     errorTitle: string | null;
@@ -1455,12 +1388,6 @@ interface PrivyProviderProps {
      * Values here will override their server-configuration counterparts.
      */
     config?: PrivyClientConfig;
-    /**
-     * Override the URL of the Privy API, which is 'https://auth.privy.io' by default.
-     * For development and testing use only.
-     * @hidden
-     */
-    apiUrl?: string;
     /**
      * @ignore
      * @class