@getpara/core-sdk 2.12.0 → 2.13.0

package/dist/types/types/methods.d.ts

@@ -1,88 +1,11 @@
-import { PrimaryAuthInfo, ServerAuthStateLogin, ServerAuthStateSignup, TAuthMethod, ServerAuthStateVerify, VerifiedAuth, AuthExtras, RecoveryStatus, Theme, TOAuthMethod, TWalletType, TelegramAuthResponse, VerifyThirdPartyAuth, ServerAuthStateDone } from '@getpara/user-management-client';
+import { VerifiedAuth, RecoveryStatus, TelegramAuthResponse, VerifyThirdPartyAuth } from '@getpara/user-management-client';
 import { Wallet } from './wallet.js';
-type Device = {
-    sessionId: string;
-    encryptionKey: string;
-};
-export type EmbeddedWalletType = Exclude<TWalletType, never>;
-export type ExternalWalletType = Exclude<TWalletType, never>;
 export type VerifyExternalWalletV1 = {
     address: string;
     signedMessage: string;
     cosmosPublicKeyHex?: string;
     cosmosSigner?: string;
 };
-export type PortalUrlType = 'createAuth' | 'createPassword' | 'loginAuth' | 'loginPassword' | 'txReview' | 'onRamp' | 'telegramLogin' | 'createPIN' | 'loginPIN' | 'oAuth' | 'oAuthCallback' | 'loginOTP' | 'telegramLoginVerify' | 'loginFarcaster' | 'switchWallets' | 'addNewCredential' | 'exportPrivateKey' | 'loginExternalWallet' | 'connectExternalWallet';
-export type PortalUrlOptions = {
-    params?: Record<string, string | undefined | null>;
-    isForNewDevice?: boolean;
-    thisDevice?: Device;
-    newDevice?: Device;
-    sessionId?: string;
-    portalTheme?: Theme;
-    pathId?: string;
-    shorten?: boolean;
-    isEmbedded?: boolean;
-    oAuthMethod?: OAuthUrlParams['method'];
-    appScheme?: string;
-    encryptionKey?: string;
-    addNewCredentialType?: TAuthMethod;
-    addNewCredentialPasswordId?: string;
-    addNewCredentialPasskeyId?: string;
-    useLegacyUrl?: boolean;
-};
-export type WithAuthMethod = {
-    /**
-     * Which authorization method to use for the URL, either `'PASSKEY'`, `'PASSWORD'` or `'PIN'`.
-     */
-    authMethod?: Uppercase<TAuthMethod>;
-};
-export type WithCustomTheme = {
-    /**
-     * The theme to apply to generated URLs, if different from your configured theme.
-     */
-    portalTheme?: Theme;
-};
-export type WithUseShortUrls = {
-    /**
-     * Whether to shorten generated URLs. This may correct any issues with generated QR codes. Defaults to `false`.
-     */
-    useShortUrls?: boolean;
-};
-export type WithShorten = {
-    /**
-     * Whether to shorten the generated URL. This may correct any issues with generated QR codes. Defaults to `false`.
-     */
-    shorten?: boolean;
-};
-export type WithIsPasskeySupported = {
-    /**
-     * Whether the current device supports WebAuth passkeys.
-     */
-    isPasskeySupported: boolean;
-};
-export type PollParams = {
-    /**
-     * A callback function that will be invoked on each method poll.
-     */
-    onPoll?: () => void;
-    /**
-     * A callback function that will be invoked if the method call is canceled.
-     */
-    onCancel?: () => void;
-};
-export type FarcasterParams = PollParams & {
-    /**
-     * A function returning a boolean, indicating whether the Farcaster login process should be cancelled.
-     */
-    isCanceled?: () => boolean;
-    /**
-     * A callback function that will be invoked with the Farcaster Connect URI when it is available.
-     * You will need to display the URI as a QR code.
-     */
-    onConnectUri?: (uri: string) => void;
-    serverAuthState?: VerifyThirdPartyAuth;
-};
 export type TelegramParams = {
     /**
      * The response received from the Telegram login bot.
@@ -90,112 +13,6 @@ export type TelegramParams = {
     telegramAuthResponse?: TelegramAuthResponse;
     serverAuthState?: VerifyThirdPartyAuth;
 };
-export type LoginUrlParams = WithAuthMethod & WithCustomTheme & WithShorten & {
-    sessionId?: string;
-};
-export type NewCredentialUrlParams = WithCustomTheme & WithShorten & {
-    /**
-     * Whether the URL is meant to add a passkey for a previous user on a new device. Defaults to `false`.
-     */
-    isForNewDevice?: boolean;
-    /**
-     * The authentication method to add.
-     */
-    authMethod?: TAuthMethod;
-};
-export type OAuthUrlParams = {
-    /**
-     * The third-party OAuth service.
-     */
-    method: Exclude<TOAuthMethod, 'TELEGRAM' | 'FARCASTER'>;
-    /**
-     * The app scheme to redirect to after OAuth is complete.
-     */
-    appScheme?: string;
-};
-export type OAuthParams = OAuthUrlParams & PollParams & {
-    /**
-     * A function returning a boolean, indicating whether the OAuth process should be cancelled.
-     */
-    isCanceled?: () => boolean;
-    /**
-     * A callback function that will be invoked with the OAuth URL when it is available.
-     * For example, you can use this to open the URL in a new window or tab.
-     *
-     * You should pass one of `onOAuthUrl` or `onOAuthPopup`, not both.
-     */
-    onOAuthUrl?: (url: string) => void;
-    /**
-     * A callback function that will be invoked with the OAuth popup window when it is available.
-     * If supplied, a window will automatically be opened for you if running on an applicable platform.
-     *
-     * You should pass one of `onOAuthUrl` or `onOAuthPopup`, not both.
-     */
-    onOAuthPopup?: (popup: Window) => void;
-};
-export type AuthStateBaseParams = WithCustomTheme & WithUseShortUrls;
-export type AuthStateVerify = ServerAuthStateVerify & {
-    loginUrl?: string;
-};
-export type AuthStateLogin = Omit<ServerAuthStateLogin, 'loginAuthMethods'> & WithIsPasskeySupported & {
-    /**
-     * A Para Portal URL for logging in via a WebAuth passkey. For best compatibility, you should open this URL in a new window or tab.
-     */
-    passkeyUrl?: string;
-    /**
-     * A Para Portal URL for authorizing a new device using a WebAuth passkey located elsewhere, to be visited using that other device.
-     */
-    passkeyKnownDeviceUrl?: string;
-    /**
-     * A Para Portal URL for logging in via a password.
-     */
-    passwordUrl?: string;
-    /**
-     * A Para Portal URL for logging in via a PIN.
-     */
-    pinUrl?: string;
-    /**
-     * Supported login auth methods for this session.
-     */
-    loginAuthMethods?: TAuthMethod[];
-};
-export type AuthStateSignup = Omit<ServerAuthStateSignup, 'signupAuthMethods'> & WithIsPasskeySupported & {
-    /**
-     * A Para Portal URL for creating a new WebAuth passkey.
-     */
-    passkeyUrl?: string;
-    /**
-     * A Para Portal URL for creating a new user password.
-     */
-    passwordUrl?: string;
-    /**
-     * A Para Portal URL for creating a new user PIN.
-     */
-    pinUrl?: string;
-    /**
-     * The Para system ID for the newly generated passkey.
-     */
-    passkeyId?: string;
-    /**
-     * The Para system ID for the newly generated password.
-     */
-    passwordId?: string;
-    /**
-     * The Para system ID for the newly generated PIN.
-     */
-    pinId?: string;
-    /**
-     * Supported signup auth methods for this session.
-     */
-    signupAuthMethods?: TAuthMethod[];
-};
-export type AuthStateDone = Omit<ServerAuthStateDone, 'authMethods'> & {
-    authMethods: TAuthMethod[];
-};
-export type AuthStateVerifyOrLogin = AuthStateVerify | AuthStateLogin;
-export type AuthStateSignupOrLoginOrDone = AuthStateSignup | AuthStateLogin | AuthStateDone;
-export type OAuthResponse = AuthStateSignupOrLoginOrDone;
-export type AuthState = AuthStateVerify | AuthStateLogin | AuthStateSignup | AuthStateDone;
 export type Verify2faParams = {
     auth: VerifiedAuth;
     verificationCode: string;
@@ -218,11 +35,4 @@ export type Verify2faResponse = {
      */
     wallets: Pick<Wallet, 'address' | 'id'>[];
 };
-export type CoreAuthInfo = PrimaryAuthInfo & AuthExtras;
 export type StorageType = 'local' | 'session' | 'secure' | 'all';
-export type GetWalletBalanceParams = {
-    walletId: string;
-    rpcUrl?: string;
-};
-export type GetWalletBalanceResponse = Promise<string | undefined>;
-export {};

package/dist/types/types/serviceInterfaces.d.ts

@@ -0,0 +1,125 @@
+import type { pki as pkiType } from 'node-forge';
+import type { PartnerEntity, BackupKitEmailProps, VerificationEmailProps, TLinkedAccountType, Theme } from '@getpara/user-management-client';
+import type { Ctx, Environment, AccountLinkInProgress, ConstructorOpts } from './index.js';
+import type { PlatformUtils } from '../PlatformUtils.js';
+import type { AuthService } from '../services/AuthService.js';
+import type { WalletService } from '../services/WalletService.js';
+import type { PregenWalletService } from '../services/PregenWalletService.js';
+import type { PollingService } from '../services/PollingService.js';
+import type { SessionManagementService } from '../services/SessionManagementService.js';
+import type { ExternalWalletService } from '../services/ExternalWalletService.js';
+import { PortalUrlService } from '../services/PortalUrlService.js';
+export interface AuthServiceInterface {
+    logout: (opts?: {
+        clearPregenWallets?: boolean;
+        skipStateReset?: boolean;
+    }) => Promise<void>;
+    setLoginEncryptionKeyPair: (keyPair?: pkiType.rsa.KeyPair) => Promise<void>;
+    localStorageGetItem: (key: string) => Promise<string | null> | string | null;
+    localStorageSetItem: (key: string, value: string) => Promise<void> | void;
+    localStorageRemoveItem: (key: string) => Promise<void> | void;
+    isPasskeySupported: () => Promise<boolean>;
+    getVerificationEmailProps: () => VerificationEmailProps;
+    displayModalError: (error?: string) => void;
+    isPortal: (envOverride?: Environment) => boolean;
+    assertIsLinkingAccount: (types?: TLinkedAccountType[]) => AccountLinkInProgress;
+    requireApiKey: () => void;
+    get loginEncryptionKeyPair(): pkiType.rsa.KeyPair | undefined;
+    isNativePasskey: boolean;
+    ctx: Ctx;
+    get accountLinkInProgress(): AccountLinkInProgress | undefined;
+    partnerId: string | undefined;
+    platformUtils: PlatformUtils;
+    externalWalletConnectionOnly: boolean;
+}
+export interface WalletServiceInterface {
+    assertPartner: () => Promise<PartnerEntity>;
+    requireApiKey: () => void;
+    isPortal: () => boolean;
+    localStorageSetItem: (key: string, value: string) => Promise<void> | void;
+    getBackupKitEmailProps: () => BackupKitEmailProps;
+    retrieveSessionCookie: () => string | undefined;
+    isParaConnect: () => boolean;
+    ctx: Ctx;
+    get partner(): PartnerEntity | undefined;
+    platformUtils: PlatformUtils;
+    cosmosPrefix: string | undefined;
+}
+export interface PregenWalletServiceInterface {
+    assertPartner: () => Promise<PartnerEntity>;
+    requireApiKey: () => void;
+    getBackupKitEmailProps: () => BackupKitEmailProps;
+    isPortal: () => boolean;
+    retrieveSessionCookie: () => string | undefined;
+    fetchPregenWalletsOverride: ConstructorOpts['fetchPregenWalletsOverride'];
+    ctx: Ctx;
+    platformUtils: PlatformUtils;
+    get partner(): PartnerEntity | undefined;
+}
+export interface ExternalWalletServiceInterface {
+    assertPartner: () => Promise<PartnerEntity>;
+    localStorageSetItem: (key: string, value: string) => Promise<void> | void;
+    logout: (opts?: {
+        clearPregenWallets?: boolean;
+        skipStateReset?: boolean;
+    }) => Promise<void>;
+}
+export interface PortalUrlServiceInterface {
+    assertPartner: () => Promise<PartnerEntity>;
+    setLoginEncryptionKeyPair: (keyPair?: pkiType.rsa.KeyPair) => Promise<void>;
+    isPortal: (envOverride?: Environment) => boolean;
+    isPartnerOptional: boolean | undefined;
+    ctx: Ctx;
+    get loginEncryptionKeyPair(): pkiType.rsa.KeyPair | undefined;
+    portalTheme?: Theme;
+    portalPrimaryButtonColor?: string;
+    portalTextColor?: string;
+    portalPrimaryButtonTextColor?: string;
+    portalBackgroundColor?: string;
+    borderRadius?: string;
+    get accountLinkInProgress(): AccountLinkInProgress | undefined;
+}
+export interface SessionManagementServiceInterface {
+    displayModalError: (error?: string) => void;
+    setLoginEncryptionKeyPair: (keyPair?: pkiType.rsa.KeyPair) => Promise<void>;
+    initializeWorker: () => Promise<void>;
+    isPortal: () => boolean;
+    getPartner: (_: string) => Promise<PartnerEntity>;
+    assertPartner: () => Promise<PartnerEntity>;
+    platformUtils: PlatformUtils;
+    ctx: Ctx;
+    get loginEncryptionKeyPair(): pkiType.rsa.KeyPair | undefined;
+    isWorkerInitialized: boolean;
+    get partner(): PartnerEntity | undefined;
+    isReady: boolean;
+    isSwitchingWallets: boolean;
+    isNoWalletConfig: boolean;
+}
+export interface PollingServiceInterface {
+    isPortal: () => boolean;
+    devLog: (...s: any[]) => void;
+    popupWindow: Window | null;
+    platformUtils: PlatformUtils;
+    ctx: Ctx;
+}
+export interface StateMachineInterface {
+    setup: () => Promise<void>;
+    logout: (opts?: {
+        clearPregenWallets?: boolean;
+        skipStateReset?: boolean;
+    }) => Promise<void>;
+    isPortal: (envOverride?: Environment) => boolean;
+    setupAfterLogin: ({}: {
+        temporaryShares: any[];
+        skipSessionRefresh?: boolean;
+    }) => Promise<void>;
+    devLog: (...s: any[]) => void;
+    authService: AuthService;
+    walletService: WalletService;
+    pregenWalletService: PregenWalletService;
+    pollingService: PollingService;
+    externalWalletService: ExternalWalletService;
+    sessionManagementService: SessionManagementService;
+    portalUrlService: PortalUrlService;
+    get isNoWalletConfig(): boolean;
+}

package/dist/types/types/util.d.ts

@@ -0,0 +1,43 @@
+import { TAuthMethod, Theme } from '@getpara/user-management-client';
+export type WithAuthMethod = {
+    /**
+     * Which authorization method to use for the URL, either `'PASSKEY'`, `'PASSWORD'` or `'PIN'`.
+     */
+    authMethod?: Uppercase<TAuthMethod>;
+};
+export type WithCustomTheme = {
+    /**
+     * The theme to apply to generated URLs, if different from your configured theme.
+     */
+    portalTheme?: Theme;
+};
+export type WithUseShortUrls = {
+    /**
+     * Whether to shorten generated URLs. This may correct any issues with generated QR codes. Defaults to `false`.
+     */
+    useShortUrls?: boolean;
+};
+export type WithSessionLookupId = {
+    /**
+     * The session lookup ID to use for generated URLs.
+     */
+    sessionLookupId?: string;
+};
+export type WithSessionId = {
+    /**
+     * The session ID to use for generated URLs.
+     */
+    sessionId?: string;
+};
+export type WithShorten = {
+    /**
+     * Whether to shorten the generated URL. This may correct any issues with generated QR codes. Defaults to `false`.
+     */
+    shorten?: boolean;
+};
+export type WithIsPasskeySupported = {
+    /**
+     * Whether the current device supports WebAuth passkeys.
+     */
+    isPasskeySupported: boolean;
+};

package/dist/types/types/wallet.d.ts

@@ -26,6 +26,7 @@ export interface Wallet extends Omit<IWalletEntity, 'createdAt' | 'updatedAt' |
     ensName?: string | null;
     ensAvatar?: string | null;
 }
+export type WalletNoSigner = Omit<Wallet, 'signer'>;
 export type AvailableWallet = Pick<Wallet, 'id' | 'type' | 'name' | 'address' | 'partner' | 'ensName' | 'ensAvatar' | 'isExternal' | 'externalProviderId' | 'isExternalConnectionOnly'> & {
     addressShort?: string;
     displayName?: string;
@@ -46,4 +47,5 @@ export interface DeniedSignatureResWithUrl extends DeniedSignatureRes {
 }
 export type SignatureRes = SuccessfulSignatureRes | DeniedSignatureRes;
 export type FullSignatureRes = SuccessfulSignatureRes | DeniedSignatureResWithUrl;
-export type ExternalWalletConnectionType = 'NONE' | 'CONNECTION_ONLY' | 'AUTHENTICATED' | 'VERIFICATION';
+export type EmbeddedWalletType = Exclude<TWalletType, never>;
+export type ExternalWalletType = Exclude<TWalletType, never>;

package/dist/types/utils/retryBackoff.d.ts

@@ -0,0 +1,2 @@
+export declare const retryDelay: (attempt: number) => number;
+export declare const sleep: (ms: number) => Promise<void>;

package/dist/types/utils/stateErrorHelpers.d.ts

@@ -0,0 +1,2 @@
+export declare function extractErrorMessage(error: unknown, defaultMessage: string): string;
+export declare function formatStateError(error: unknown, defaultMessage: string): Error;

package/dist/types/utils/stateListener.d.ts

@@ -0,0 +1,47 @@
+import { CoreStateManager } from '../state/CoreStateManager.js';
+import { AuthPhase } from '../state/types/auth.js';
+import { CorePhase, CoreState } from '../state/types/core.js';
+type PhaseConfig<P, T> = {
+    phase: P;
+    onPhase: (state: CoreState) => T;
+};
+type BaseStateListenerParams = {
+    stateManager: CoreStateManager;
+    onReject?: (state: CoreState) => void;
+    /**
+     * Whether to reject the promise only when the state is in an error phase
+     *
+     * If false, the promise will reject if an error is present in state, regardless of the current phase
+     *
+     * Useful for flows where errors can be transient and retried (e.g. account verification)
+     * @default false
+     */
+    rejectInErrorPhaseOnly?: boolean;
+    /**
+     * Timeout in milliseconds after which the promise rejects if not resolved.
+     * @default 300000
+     */
+    timeoutMs?: number;
+};
+type WaitForCoreStateChangeParams<T> = BaseStateListenerParams & {
+    resolvePhases: PhaseConfig<CorePhase, T>[];
+    rejectPhases?: PhaseConfig<CorePhase, Error>[];
+};
+type WaitForAuthStateChangeParams<T> = BaseStateListenerParams & {
+    resolvePhases: PhaseConfig<AuthPhase, T>[];
+    rejectPhases?: PhaseConfig<AuthPhase, Error>[];
+    /**
+     * Whether to wait for the core state to also be 'authenticated' when resolving on the 'authenticated' auth phase
+     * @default true
+     */
+    waitForCoreAuthenticated?: boolean;
+};
+/**
+ * Helper specifically for core state changes
+ */
+export declare function waitForCoreStateChange<T>({ stateManager, resolvePhases, onReject, rejectInErrorPhaseOnly, timeoutMs, }: WaitForCoreStateChangeParams<T>): Promise<T>;
+/**
+ * Helper specifically for auth state changes
+ */
+export declare function waitForAuthStateChange<T>({ stateManager, resolvePhases, rejectPhases, onReject, waitForCoreAuthenticated, rejectInErrorPhaseOnly, timeoutMs, }: WaitForAuthStateChangeParams<T>): Promise<T>;
+export {};

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@getpara/core-sdk",
-  "version": "2.12.0",
+  "version": "2.13.0",
   "dependencies": {
     "@celo/utils": "^8.0.2",
     "@cosmjs/encoding": "^0.32.4",
     "@ethereumjs/util": "^9.1.0",
-    "@getpara/user-management-client": "2.12.0",
+    "@getpara/user-management-client": "2.13.0",
     "@noble/hashes": "^1.5.0",
     "base64url": "^3.0.1",
     "libphonenumber-js": "^1.11.7",
     "node-forge": "^1.3.1",
-    "uuid": "^11.1.0"
+    "uuid": "^11.1.0",
+    "xstate": "^5.24.0"
   },
   "devDependencies": {
     "@faker-js/faker": "^9.5.1",
@@ -27,7 +28,7 @@
     "dist",
     "package.json"
   ],
-  "gitHead": "09c114d148f7a0c2ad250d6346a76aa3b332b2d4",
+  "gitHead": "75ac5d1ebe87366c23bb4e485481deb1b593e299",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "scripts": {