@reown/appkit-controllers 1.7.20-turbo-fix.0 → 1.7.20

package/dist/types/exports/features.d.ts

@@ -0,0 +1 @@
+export * from '../src/features/reown-authentication/index.js';

package/dist/types/exports/testing.d.ts

@@ -1,4 +1,5 @@
 import type { CaipNetwork, ChainNamespace } from '@reown/appkit-common';
+import type { SIWXSession } from '@reown/appkit-controllers';
 import { type AccountControllerState, type AdapterNetworkState, type ChainAdapter, type ChainControllerState } from '../exports/index.js';
 export declare const extendedMainnet: CaipNetwork;
 export declare function mockChainControllerState(state: Partial<Omit<ChainControllerState, 'chains'> & {
@@ -12,3 +13,8 @@ export declare function updateChainsMap(namespace: ChainNamespace, state: Partia
     networkState?: Partial<AdapterNetworkState>;
 }): void;
 export declare function mockAccountControllerState(state: AccountControllerState): void;
+type MockSessionReplaces = {
+    [K in keyof SIWXSession]?: Partial<SIWXSession[K]>;
+};
+export declare function mockSession(replaces?: MockSessionReplaces): SIWXSession;
+export {};

package/dist/types/src/controllers/BlockchainApiController.d.ts

@@ -21,9 +21,7 @@ export declare const BlockchainApiController: {
         http: CaipNetworkId[];
         ws: CaipNetworkId[];
     }>;
-    fetchIdentity({ address, caipNetworkId }: BlockchainApiIdentityRequest & {
-        caipNetworkId: CaipNetworkId;
-    }): Promise<BlockchainApiIdentityResponse>;
+    fetchIdentity({ address }: BlockchainApiIdentityRequest): Promise<BlockchainApiIdentityResponse>;
     fetchTransactions({ account, cursor, signal, cache, chainId }: BlockchainApiTransactionsRequest): Promise<BlockchainApiTransactionsResponse | {
         data: never[];
         next: undefined;

package/dist/types/src/controllers/OptionsController.d.ts

@@ -1508,6 +1508,7 @@ export declare const OptionsController: {
             readonly walletFeaturesOrder?: readonly WalletFeature[] | undefined;
             readonly collapseWallets?: boolean | undefined;
             readonly pay?: boolean | undefined;
+            readonly reownAuthentication?: boolean | undefined;
         } | undefined;
         readonly siwx?: {
             readonly createMessage: (input: import("../utils/SIWXUtil.js").SIWXMessage.Input) => Promise<import("../utils/SIWXUtil.js").SIWXMessage>;
@@ -1531,7 +1532,7 @@ export declare const OptionsController: {
          */
          | undefined;
         readonly defaultAccountTypes: {
-            readonly eip155?: "smartAccount" | "eoa" | undefined;
+            readonly eip155?: "eoa" | "smartAccount" | undefined;
             readonly solana?: "eoa" | undefined;
             readonly bip122?: "payment" | "ordinal" | "stx" | undefined;
             readonly polkadot?: "eoa" | undefined;
@@ -1578,6 +1579,7 @@ export declare const OptionsController: {
             readonly reownBranding?: boolean | undefined;
             readonly multiWallet?: boolean | undefined;
             readonly emailCapture?: boolean | readonly "required"[] | undefined;
+            readonly reownAuthentication?: boolean | undefined;
             readonly payWithExchange?: boolean | undefined;
             readonly payments?: boolean | undefined;
             readonly onramp?: false | readonly "meld"[] | undefined;

package/dist/types/src/features/reown-authentication/ReownAuthentication.d.ts

@@ -0,0 +1,187 @@
+import { type CaipNetworkId, type ChainNamespace } from '@reown/appkit-common';
+import type { SIWXConfig, SIWXMessage, SIWXSession } from '../../utils/SIWXUtil.js';
+/**
+ * This is the configuration for using SIWX with Reown Authentication service.
+ * It allows you to authenticate and capture user sessions through the Cloud Dashboard.
+ */
+export declare class ReownAuthentication implements SIWXConfig {
+    private readonly localAuthStorageKey;
+    private readonly localNonceStorageKey;
+    private readonly messenger;
+    private required;
+    private otpUuid;
+    private listeners;
+    constructor(params?: ReownAuthentication.ConstructorParams);
+    createMessage(input: SIWXMessage.Input): Promise<SIWXMessage>;
+    addSession(session: SIWXSession): Promise<void>;
+    getSessions(chainId: CaipNetworkId, address: string): Promise<SIWXSession[]>;
+    revokeSession(_chainId: CaipNetworkId, _address: string): Promise<void>;
+    setSessions(sessions: SIWXSession[]): Promise<void>;
+    getRequired(): boolean;
+    getSessionAccount(): Promise<Omit<ReownAuthentication.SessionAccount, "appKitAccount">>;
+    setSessionAccountMetadata(metadata?: object | null): Promise<unknown>;
+    on<Event extends keyof ReownAuthentication.Events>(event: Event, callback: ReownAuthentication.Listener<Event>): () => void;
+    removeAllListeners(): void;
+    requestEmailOtp({ email, account }: {
+        email: string;
+        account: string;
+    }): Promise<{
+        uuid: string | null;
+    }>;
+    confirmEmailOtp({ code }: {
+        code: string;
+    }): Promise<null>;
+    private request;
+    private getStorageToken;
+    private setStorageToken;
+    private clearStorageTokens;
+    private getNonce;
+    private getClientId;
+    private getWalletInfo;
+    private getSDKProperties;
+    private emit;
+    private setAppKitAccountUser;
+}
+export declare namespace ReownAuthentication {
+    type ConstructorParams = {
+        /**
+         * The key to use for storing the session token in local storage.
+         * @default '@appkit/siwx-auth-token'
+         */
+        localAuthStorageKey?: string;
+        /**
+         * The key to use for storing the nonce token in local storage.
+         * @default '@appkit/siwx-nonce-token'
+         */
+        localNonceStorageKey?: string;
+        /**
+         * If false the wallet stays connected when user denies the signature request.
+         * @default true
+         */
+        required?: boolean;
+    };
+    type AvailableRequestHeaders = {
+        nonce: {
+            'x-nonce-jwt': string;
+        };
+        auth: {
+            Authorization: string;
+        };
+        otp: {
+            'x-otp'?: string;
+        };
+    };
+    type RequestParams<Key extends keyof Requests[Method], Method extends Methods> = {
+        method: Method;
+        key: Key;
+    } & Pick<Requests[Method][Key], 'query' | 'body' | 'headers'>;
+    type RequestResponse<Method extends Methods, Key extends RequestKeys<Method>> = Requests[Method][Key]['response'];
+    type Request<Body, Response, Query extends Record<string, unknown> | undefined = undefined, Headers extends (keyof AvailableRequestHeaders)[] | undefined = undefined> = (Response extends undefined ? {
+        response?: never;
+    } : {
+        response: Response;
+    }) & (Body extends undefined ? {
+        body?: never;
+    } : {
+        body: Body;
+    }) & (Query extends undefined ? {
+        query?: never;
+    } : {
+        query: Query;
+    }) & (Headers extends undefined ? {
+        headers?: never;
+    } : {
+        headers: Headers;
+    });
+    type Requests = {
+        GET: {
+            nonce: Request<undefined, {
+                nonce: string;
+                token: string;
+            }>;
+            me: Request<undefined, Omit<SessionAccount, 'appKitAccount'>, {
+                includeAppKitAccount?: boolean;
+            }, [
+                'auth'
+            ]>;
+        };
+        POST: {
+            authenticate: Request<{
+                data?: SIWXMessage.Data;
+                message: string;
+                signature: string;
+                clientId?: string | null;
+                walletInfo?: WalletInfo;
+            }, {
+                token: string;
+            }, undefined, [
+                'nonce',
+                'otp'
+            ]>;
+            'sign-out': Request<undefined, never, never, ['auth']>;
+            otp: Request<{
+                email: string;
+                account: string;
+            }, {
+                uuid: string | null;
+            }>;
+        };
+        PUT: {
+            'account-metadata': Request<{
+                metadata: object | null;
+            }, unknown, undefined, ['auth']>;
+            otp: Request<{
+                code: string;
+            }, null, undefined, ['otp']>;
+        };
+    };
+    type Methods = 'GET' | 'POST' | 'PUT';
+    type RequestKeys<Method extends Methods> = keyof Requests[Method];
+    type WalletInfo = {
+        type: 'walletconnect' | 'extension' | 'unknown';
+        name: string | undefined;
+        icon: string | undefined;
+    } | {
+        type: 'social';
+        social: string;
+        identifier: string;
+    };
+    type Events = {
+        sessionChanged: SIWXSession | undefined;
+    };
+    type Listener<Event extends keyof Events> = (event: Events[Event]) => void;
+    type EventListeners = {
+        [Key in keyof Events]: Listener<Key>[];
+    };
+    type SessionAccount = {
+        aud: string;
+        iss: string;
+        exp: number;
+        projectIdKey: string;
+        sub: string;
+        address: string;
+        chainId: number | string;
+        chainNamespace: ChainNamespace;
+        caip2Network: string;
+        uri: string;
+        domain: string;
+        projectUuid: string;
+        profileUuid: string;
+        nonce: string;
+        email?: string;
+        appKitAccount?: {
+            uuid: string;
+            caip2_chain: string;
+            address: string;
+            profile_uuid: string;
+            created_at: string;
+            is_main_account: boolean;
+            verification_status: null;
+            connection_method: object | null;
+            metadata: object;
+            last_signed_in_at: string;
+            signed_up_at: string;
+            updated_at: string;
+        };
+    };
+}

package/dist/types/src/features/reown-authentication/ReownAuthenticationMessenger.d.ts

@@ -0,0 +1,15 @@
+import type { SIWXMessage } from '../../utils/SIWXUtil.js';
+export declare class ReownAuthenticationMessenger {
+    resources?: SIWXMessage['resources'];
+    protected getNonce: (params: SIWXMessage.Input) => Promise<SIWXMessage['nonce']>;
+    constructor(params: ReownAuthenticationMessenger.ConstructorParams);
+    createMessage(input: SIWXMessage.Input): Promise<SIWXMessage>;
+    private stringify;
+    private getNetworkName;
+    private stringifyDate;
+}
+export declare namespace ReownAuthenticationMessenger {
+    interface ConstructorParams {
+        getNonce: (params: SIWXMessage.Input) => Promise<SIWXMessage['nonce']>;
+    }
+}

package/dist/types/src/features/reown-authentication/index.d.ts

@@ -0,0 +1,2 @@
+export * from './ReownAuthentication.js';
+export * from './ReownAuthenticationMessenger.js';

package/dist/types/src/utils/ChainControllerUtil.d.ts

@@ -17,7 +17,7 @@ export declare function getActiveNetworkTokenAddress(): string;
  * @param namespace - The namespace of the account
  * @returns The preferred account type
  */
-export declare function getPreferredAccountType(namespace: ChainNamespace | undefined): "payment" | "ordinal" | "stx" | "smartAccount" | "eoa" | undefined;
+export declare function getPreferredAccountType(namespace: ChainNamespace | undefined): "eoa" | "smartAccount" | "payment" | "ordinal" | "stx" | undefined;
 /**
  * Get the active CAIP network for a given chain namespace, if no namespace is provided, it returns the active CAIP network
  * @param chainNamespace - The chain namespace to get the active CAIP network for

package/dist/types/src/utils/ConstantsUtil.d.ts

@@ -50,6 +50,7 @@ export declare const ConstantsUtil: {
         emailCapture: boolean;
         payWithExchange: boolean;
         payments: boolean;
+        reownAuthentication: boolean;
     };
     DEFAULT_REMOTE_FEATURES_DISABLED: {
         readonly email: false;
@@ -59,12 +60,13 @@ export declare const ConstantsUtil: {
         readonly activity: false;
         readonly reownBranding: false;
         readonly emailCapture: false;
+        readonly reownAuthentication: false;
     };
     DEFAULT_FEATURES: {
         receive: true;
         send: true;
         emailShowWallets: true;
-        connectorTypeOrder: ("walletConnect" | "recent" | "injected" | "featured" | "custom" | "external" | "recommended")[];
+        connectorTypeOrder: ("custom" | "walletConnect" | "recent" | "injected" | "featured" | "external" | "recommended")[];
         analytics: true;
         allWallets: true;
         legalCheckbox: false;
@@ -73,6 +75,7 @@ export declare const ConstantsUtil: {
         walletFeaturesOrder: ("swaps" | "onramp" | "receive" | "send")[];
         connectMethodsOrder: undefined;
         pay: false;
+        reownAuthentication: false;
     };
     DEFAULT_SOCIALS: SocialProvider[];
     DEFAULT_ACCOUNT_TYPES: {

package/dist/types/src/utils/TypeUtil.d.ts

@@ -345,6 +345,7 @@ export type Event = {
     properties: {
         method: 'qrcode' | 'mobile' | 'browser' | 'email';
         name: string;
+        reconnect?: boolean;
     };
 } | {
     type: 'track';
@@ -606,6 +607,7 @@ export type Event = {
     event: 'SOCIAL_LOGIN_SUCCESS';
     properties: {
         provider: SocialProvider;
+        reconnect?: boolean;
     };
 } | {
     type: 'track';
@@ -971,6 +973,7 @@ export type RemoteFeatures = {
     reownBranding?: boolean;
     multiWallet?: boolean;
     emailCapture?: EmailCaptureOptions[] | boolean;
+    reownAuthentication?: boolean;
     payWithExchange?: boolean;
     payments?: boolean;
     onramp?: OnRampProvider[] | false;
@@ -1067,6 +1070,11 @@ export type Features = {
      * @type {boolean}
      */
     pay?: boolean;
+    /**
+     * @description Enable or disable the ReownAuthentication SIWX feature. Disabled by default.
+     * @type {boolean}
+     */
+    reownAuthentication?: boolean;
 };
 export type FeaturesKeys = Exclude<keyof Features, 'swaps' | 'onramp' | 'email' | 'socials' | 'history'>;
 export type WalletGuideType = 'get-started' | 'explore';
@@ -1098,7 +1106,7 @@ export type ConnectionStatus = 'connected' | 'disconnected' | 'connecting' | 're
 export type PreferredAccountTypes = {
     [Key in keyof NamespaceTypeMap]?: NamespaceTypeMap[Key];
 };
-export type FeatureID = 'multi_wallet' | 'activity' | 'onramp' | 'swap' | 'social_login' | 'reown_branding' | 'email_capture' | 'fund_from_exchange' | 'payments';
+export type FeatureID = 'multi_wallet' | 'activity' | 'onramp' | 'swap' | 'social_login' | 'reown_branding' | 'email_capture' | 'fund_from_exchange' | 'payments' | 'reown_authentication';
 export interface BaseFeature<T extends FeatureID, C extends string[] | null> {
     id: T;
     isEnabled: boolean;
@@ -1169,6 +1177,12 @@ export type FeatureConfigMap = {
         returnType: boolean;
         isLegacy: false;
     };
+    reownAuthentication: {
+        apiFeatureName: 'reown_authentication';
+        localFeatureName: 'reownAuthentication';
+        returnType: boolean;
+        isLegacy: false;
+    };
 };
 export type FeatureKey = keyof FeatureConfigMap;
 export {};

package/dist/types/tests/features/ReownAuthentication.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reown/appkit-controllers",
-  "version": "1.7.20-turbo-fix.0",
+  "version": "1.7.20",
   "sideEffects": false,
   "type": "module",
   "main": "./dist/esm/exports/index.js",
@@ -35,6 +35,11 @@
       "types": "./dist/types/exports/testing.d.ts",
       "import": "./dist/esm/exports/testing.js",
       "default": "./dist/esm/exports/testing.js"
+    },
+    "./features": {
+      "types": "./dist/types/exports/features.d.ts",
+      "import": "./dist/esm/exports/features.js",
+      "default": "./dist/esm/exports/features.js"
     }
   },
   "typesVersions": {
@@ -51,8 +56,8 @@
     "@walletconnect/universal-provider": "2.21.7",
     "valtio": "2.1.5",
     "viem": ">=2.33.3",
-    "@reown/appkit-common": "1.7.20-turbo-fix.0",
-    "@reown/appkit-wallet": "1.7.20-turbo-fix.0"
+    "@reown/appkit-common": "1.7.20",
+    "@reown/appkit-wallet": "1.7.20"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "2.1.9",