@getpara/core-sdk 3.3.0 → 3.5.0

package/dist/types/state/types/auth.d.ts

@@ -19,7 +19,7 @@ import type { BaseVerifyExternalWalletParams, ConnectExternalWalletParams, InitO
  * }
  * ```
  */
-export type AuthPhase = 'uninitialized' | 'checking_state' | 'clearing_state' | 'unauthenticated' | 'authenticating_email_phone' | 'authenticating_oauth' | 'connecting_external_wallet' | 'switching_external_wallet' | 'authenticating_external_wallet' | 'authenticating_telegram' | 'authenticating_telegram_legacy' | 'authenticating_farcaster' | 'authenticating_farcaster_legacy' | 'waiting_for_farcaster' | 'processing_authentication' | 'awaiting_wallet_signature' | 'awaiting_wallet_verification' | 'awaiting_account_verification' | 'awaiting_session_start' | 'verifying_new_account' | 'verifying_external_wallet' | 'waiting_for_session' | 'authenticated' | 'guest_mode' | 'error' | 'signing_external_wallet_verification';
+export type AuthPhase = 'uninitialized' | 'checking_state' | 'clearing_state' | 'unauthenticated' | 'authenticating_email_phone' | 'authenticating_oauth' | 'connecting_external_wallet' | 'switching_external_wallet' | 'authenticating_external_wallet' | 'authenticating_telegram' | 'authenticating_telegram_legacy' | 'authenticating_farcaster' | 'authenticating_farcaster_legacy' | 'waiting_for_farcaster' | 'processing_authentication' | 'awaiting_wallet_signature' | 'awaiting_wallet_verification' | 'awaiting_account_verification' | 'awaiting_2fa' | 'awaiting_2fa_enrollment' | 'resolving_2fa' | 'awaiting_session_start' | 'verifying_new_account' | 'verifying_external_wallet' | 'waiting_for_session' | 'authenticated' | 'guest_mode' | 'error' | 'signing_external_wallet_verification';
 export type AuthEvents = {
     type: 'AUTHENTICATE_EMAIL_PHONE';
     data: PerformSignUpOrLogInParams & {
@@ -54,6 +54,9 @@ export type AuthEvents = {
 } | {
     type: 'VERIFY_NEW_ACCOUNT';
     data: PerformVerifyNewAccountParams;
+} | {
+    type: 'RESOLVE_2FA';
+    data?: PollingCallbacks;
 } | {
     type: 'VERIFY_EXTERNAL_WALLET';
     data?: VerifyExternalWalletParams;

package/dist/types/state/types/core.d.ts

@@ -1,4 +1,4 @@
-import type { BiometricLocationHint, CurrentWalletIds, DeliveryChannel, ServerAuthState, TOAuthMethod } from '@getpara/user-management-client';
+import type { BiometricLocationHint, CurrentWalletIds, DeliveryChannel, MfaMode, MfaStep, ServerAuthState, TOAuthMethod } from '@getpara/user-management-client';
 import type { AuthState, Wallet, WithCustomTheme, WithUseShortUrls } from '../../types/index.js';
 import { AuthMachine, AuthPhase } from './auth.js';
 import { WalletMachine, WalletPhase } from './wallet.js';
@@ -108,6 +108,28 @@ export type AuthStateInfo = {
         walletAddress: string;
         walletType: string;
     } | null;
+    /**
+     * Login-time 2FA challenge data (ENG-6906). Non-null only while the auth phase is
+     * `awaiting_2fa` / `awaiting_2fa_enrollment`. A custom UI reads this via
+     * onStatePhaseChange to render the enroll/verify step, then drives it with the
+     * useEnrollMfa / useVerifyMfa hooks.
+     */
+    mfa: {
+        /** 'enroll' = no factor yet (set one up); 'verify' = satisfy an existing factor. */
+        mode: MfaMode;
+        /** The specific step within the enroll/verify flow (show_secret, prompt, failed, …). */
+        step: MfaStep;
+        /** Methods the user may use to satisfy the challenge (e.g. totp, backup_code). */
+        methods: ('totp' | 'backup_code')[] | null;
+        /** Remaining verify attempts before lockout, when the server provides it. */
+        attemptsRemaining: number | null;
+        /** Epoch ms until which verification is locked out, when applicable. */
+        lockedUntil: number | null;
+        /** otpauth:// URI — present during headless enrollment (show_secret). */
+        secretUri: string | null;
+        /** One-time backup codes — present at show_backup_codes (shown once). */
+        backupCodes: string[] | null;
+    } | null;
     /** Recovery secret after wallet creation */
     recoverySecret: string | null;
     /** Whether this is a new user (signup flow) */

package/dist/types/types/authState.d.ts

@@ -1,4 +1,4 @@
-import type { AuthExtras, PrimaryAuthInfo, ServerAuthStateDone, ServerAuthStateLogin, ServerAuthStateSignup, ServerAuthStateVerify, TAuthMethod } from '@getpara/user-management-client';
+import type { AuthExtras, PrimaryAuthInfo, ServerAuthStateDone, ServerAuthStateLogin, ServerAuthStateMfa, ServerAuthStateSignup, ServerAuthStateVerify, TAuthMethod } from '@getpara/user-management-client';
 import type { WithCustomTheme, WithIsPasskeySupported, WithUseShortUrls } from './util';
 export type CoreAuthInfo = PrimaryAuthInfo & AuthExtras;
 export type AuthStateBaseParams = WithCustomTheme & WithUseShortUrls;
@@ -85,7 +85,13 @@ export type AuthStateSignup = Omit<ServerAuthStateSignup, 'signupAuthMethods'> &
 export type AuthStateDone = Omit<ServerAuthStateDone, 'authMethods'> & {
     authMethods: TAuthMethod[];
 };
+/**
+ * Login-time 2FA (MFA) challenge state (ENG-6906). The server returns
+ * `stage:'mfa'` with the `mfa` challenge during a login; the SDK surfaces it
+ * unchanged (no portal-URL adornment) so a custom UI can drive enroll/verify.
+ */
+export type AuthStateMfa = ServerAuthStateMfa;
 export type AuthStateVerifyOrLogin = AuthStateVerify | AuthStateLogin;
 export type AuthStateSignupOrLoginOrDone = AuthStateSignup | AuthStateLogin | AuthStateDone;
-export type OAuthResponse = AuthStateSignupOrLoginOrDone;
-export type AuthState = AuthStateVerify | AuthStateLogin | AuthStateSignup | AuthStateDone;
+export type OAuthResponse = AuthStateSignupOrLoginOrDone | AuthStateMfa;
+export type AuthState = AuthStateVerify | AuthStateLogin | AuthStateSignup | AuthStateDone | AuthStateMfa;

package/dist/types/types/coreApi.d.ts

@@ -1,10 +1,10 @@
-import { ExternalWalletInfo, OnRampPurchase, OnRampPurchaseCreateParams, Setup2faResponse, VerifiedAuth, WalletEntity, WalletParams, TWalletType, IssueJwtParams, IssueJwtResponse, TLinkedAccountType, LinkedAccounts, AuthMethod, DeliveryChannel } from '@getpara/user-management-client';
+import { EnrollMfaResponse, ExternalWalletInfo, OnRampPurchase, OnRampPurchaseCreateParams, Setup2faResponse, VerifiedAuth, VerifyMfaResult, WalletEntity, WalletParams, TWalletType, IssueJwtParams, IssueJwtResponse, TLinkedAccountType, LinkedAccounts, AuthMethod, DeliveryChannel } from '@getpara/user-management-client';
 import type { OAuthResponse, WithCustomTheme, WithUseShortUrls, Verify2faParams, Verify2faResponse, AuthStateSignup, StorageType, CoreAuthInfo, TelegramParams } from './';
 import { ParaCore } from '../ParaCore.js';
 import { FullSignatureRes, Wallet } from './wallet.js';
 import { AccountLinkInProgress } from './accountLinking.js';
 import type { WaitForLoginParams, WaitForLoginResponse, WaitForSignupParams, WaitForWalletCreationParams, WaitForWalletCreationResponse, GetOAuthUrlParams, AddCredentialParams, LoginExternalWalletParams, LoginExternalWalletResponse, ResendVerificationCodeParams, ResendVerificationCodeResponse, SignUpOrLogInParams, SignUpOrLogInResponse, VerifyOAuthProcessParams, VerifyExternalWalletParams, VerifyExternalWalletResponse, VerifyFarcasterParams, VerifyTelegramParams, ClaimPregenWalletsParams, ClaimPregenWalletsResponse, CreateGuestWalletsResponse, CreatePregenWalletParams, CreatePregenWalletPerTypeParams, CreatePregenWalletPerTypeResponse, CreatePregenWalletResponse, CreateWalletParams, CreateWalletPerTypeParams, CreateWalletPerTypeResponse, CreateWalletResponse, DistributeNewWalletShareParams, GetPregenWalletsParams, GetPregenWalletsResponse, GetWalletBalanceParams, HasPregenWalletParams, PollingCallbacks, RefreshShareParams, RefreshShareResponse, RequestFaucetParams, RequestFaucetResponse, UpdatePregenWalletIdentifierParams, BaseVerifyExternalWalletParams, AuthenticateWithEmailOrPhoneParams, AuthenticateWithEmailOrPhoneResponse, AuthenticateWithOAuthParams, AuthenticateWithOAuthResponse } from '../services/types';
-export declare const PARA_CORE_METHODS: readonly ["getAuthInfo", "signUpOrLogIn", "verifyNewAccount", "waitForLogin", "waitForSignup", "waitForWalletCreation", "getOAuthUrl", "verifyOAuth", "getFarcasterConnectUri", "verifyFarcaster", "verifyTelegram", "resendVerificationCode", "loginExternalWallet", "verifyExternalWallet", "setup2fa", "enable2fa", "verify2fa", "logout", "clearStorage", "isSessionActive", "isFullyLoggedIn", "refreshSession", "keepSessionAlive", "exportSession", "waitAndExportSession", "importSession", "getVerificationToken", "getWallets", "getWalletsByType", "fetchWallets", "createWallet", "createWalletPerType", "getPregenWallets", "hasPregenWallet", "updatePregenWalletIdentifier", "createPregenWallet", "createPregenWalletPerType", "claimPregenWallets", "createGuestWallets", "distributeNewWalletShare", "getUserShare", "setUserShare", "refreshShare", "signMessage", "signTransaction", "initiateOnRampTransaction", "getWalletBalance", "requestFaucet", "issueJwt", "getLinkedAccounts", "accountLinkInProgress", "addCredential", "exportPrivateKey", "authenticateWithEmailOrPhone", "authenticateWithOAuth"];
+export declare const PARA_CORE_METHODS: readonly ["getAuthInfo", "signUpOrLogIn", "verifyNewAccount", "waitForLogin", "waitForSignup", "waitForWalletCreation", "getOAuthUrl", "verifyOAuth", "getFarcasterConnectUri", "verifyFarcaster", "verifyTelegram", "resendVerificationCode", "loginExternalWallet", "verifyExternalWallet", "setup2fa", "enable2fa", "verify2fa", "enrollMfa", "verifyMfa", "logout", "clearStorage", "isSessionActive", "isFullyLoggedIn", "refreshSession", "keepSessionAlive", "exportSession", "waitAndExportSession", "importSession", "getVerificationToken", "getWallets", "getWalletsByType", "fetchWallets", "createWallet", "createWalletPerType", "getPregenWallets", "hasPregenWallet", "updatePregenWalletIdentifier", "createPregenWallet", "createPregenWalletPerType", "claimPregenWallets", "createGuestWallets", "distributeNewWalletShare", "getUserShare", "setUserShare", "refreshShare", "signMessage", "signTransaction", "initiateOnRampTransaction", "getWalletBalance", "requestFaucet", "issueJwt", "getLinkedAccounts", "accountLinkInProgress", "addCredential", "exportPrivateKey", "authenticateWithEmailOrPhone", "authenticateWithOAuth"];
 export declare const PARA_INTERNAL_METHODS: readonly ["linkAccount", "unlinkAccount", "verifyEmailOrPhoneLink", "verifyOAuthLink", "verifyFarcasterLink", "verifyTelegramLink", "verifyExternalWalletLink", "accountLinkInProgress", "prepareLogin", "sendLoginCode", "supportedUserAuthMethods"];
 export type CoreMethodName = (typeof PARA_CORE_METHODS)[number];
 export type CoreMethodParams<method extends CoreMethodName & keyof CoreMethods> = CoreMethods[method] extends {
@@ -46,6 +46,13 @@ export type Enable2faParams = {
      */
     verificationCode: string;
 };
+/** Login-time 2FA (ENG-6906) verify params. */
+export type VerifyMfaParams = {
+    /**
+     * The TOTP or one-time backup code entered by the user.
+     */
+    code: string;
+};
 export type SignMessageParams = PollingCallbacks & {
     /**
      * The ID of the wallet to use for signing.
@@ -256,6 +263,14 @@ export type CoreMethods = Record<CoreMethodName, {
         params: Verify2faParams;
         response: Verify2faResponse;
     };
+    enrollMfa: {
+        params: void;
+        response: EnrollMfaResponse;
+    };
+    verifyMfa: {
+        params: VerifyMfaParams;
+        response: VerifyMfaResult;
+    };
     getWallets: {
         params: void;
         response: Record<string, Wallet>;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@getpara/core-sdk",
-  "version": "3.3.0",
+  "version": "3.5.0",
   "dependencies": {
     "@celo/utils": "^8.0.2",
     "@cosmjs/encoding": "^0.32.4",
     "@ethereumjs/util": "^9.1.0",
-    "@getpara/user-management-client": "3.3.0",
+    "@getpara/user-management-client": "3.5.0",
     "@noble/hashes": "^1.5.0",
     "@opentelemetry/api": "^1.9.1",
     "@opentelemetry/context-zone": "^2.7.1",
@@ -41,7 +41,7 @@
     "dist",
     "package.json"
   ],
-  "gitHead": "d9b54921d4187e2dd25f314b62ed99988e9b5b1c",
+  "gitHead": "2e70485f8f206ff50f58b339ebf0922fd259858f",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "scripts": {