@getpara/core-sdk 2.11.0 → 2.13.0

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

@@ -1,9 +1,10 @@
-import { BackupKitEmailProps, CurrentWalletIds, ExternalWalletInfo, OnRampPurchase, OnRampPurchaseCreateParams, PregenAuth, Setup2faResponse, VerifiedAuth, VerifyExternalWalletParams, WalletEntity, WalletParams, TWalletType, IssueJwtParams, IssueJwtResponse, TLinkedAccountType, LinkedAccounts, AuthMethod, ServerAuthStateSignup, ServerAuthStateLogin, ServerAuthStateDone } from '@getpara/user-management-client';
-import { AuthStateLogin, AuthStateVerify, OAuthResponse, AuthStateBaseParams, WithCustomTheme, WithUseShortUrls, Verify2faResponse, AuthStateSignup, AuthStateVerifyOrLogin, OAuthUrlParams, StorageType, PollParams, CoreAuthInfo, GetWalletBalanceParams, GetWalletBalanceResponse, FarcasterParams, TelegramParams, OAuthParams, NewCredentialUrlParams, AuthStateDone } from './methods.js';
+import { ExternalWalletInfo, OnRampPurchase, OnRampPurchaseCreateParams, Setup2faResponse, VerifiedAuth, WalletEntity, WalletParams, TWalletType, IssueJwtParams, IssueJwtResponse, TLinkedAccountType, LinkedAccounts, AuthMethod } 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 './auth.js';
-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", "importSession", "getVerificationToken", "getWallets", "getWalletsByType", "fetchWallets", "createWallet", "createWalletPerType", "getPregenWallets", "hasPregenWallet", "updatePregenWalletIdentifier", "createPregenWallet", "createPregenWalletPerType", "claimPregenWallets", "createGuestWallets", "distributeNewWalletShare", "getUserShare", "setUserShare", "refreshShare", "signMessage", "signTransaction", "initiateOnRampTransaction", "getWalletBalance", "issueJwt", "getLinkedAccounts", "accountLinkInProgress", "addCredential", "exportPrivateKey"];
+import { AccountLinkInProgress } from './accountLinking.js';
+import type { WaitForLoginParams, WaitForLoginResponse, WaitForSignupParams, WaitForWalletCreationParams, WaitForWalletCreationResponse, GetOAuthUrlParams, AddCredentialParams, LoginExternalWalletParams, LoginExternalWalletResponse, ResendVerificationCodeParams, 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, 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", "importSession", "getVerificationToken", "getWallets", "getWalletsByType", "fetchWallets", "createWallet", "createWalletPerType", "getPregenWallets", "hasPregenWallet", "updatePregenWalletIdentifier", "createPregenWallet", "createPregenWalletPerType", "claimPregenWallets", "createGuestWallets", "distributeNewWalletShare", "getUserShare", "setUserShare", "refreshShare", "signMessage", "signTransaction", "initiateOnRampTransaction", "getWalletBalance", "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 {
@@ -33,6 +34,89 @@ export type InternalMethodResponse<method extends InternalMethodName & keyof Int
 } ? R : Promise<R> : void;
 export type InternalMethod<method extends InternalMethodName & keyof InternalMethods> = InternalMethodIsGetter<method> extends true ? Awaited<InternalMethodResponse<method>> : InternalMethodParams<method> extends void | never ? () => InternalMethodResponse<method> : (_?: InternalMethodParams<method>) => InternalMethodResponse<method>;
 export type InternalAction<method extends InternalMethodName & keyof InternalMethods> = InternalMethodParams<method> extends void | never ? (_?: ParaCore) => InternalMethodResponse<method> : (_?: ParaCore, __?: InternalMethodParams<method>) => InternalMethodResponse<method>;
+export type LogoutParams = {
+    /**
+     * Whether to remove all pregen wallets from storage.
+     */
+    clearPregenWallets?: boolean;
+};
+export type Enable2faParams = {
+    /**
+     * The two-factor authentication code entered by the user.
+     */
+    verificationCode: string;
+};
+export type SignMessageParams = PollingCallbacks & {
+    /**
+     * The ID of the wallet to use for signing.
+     */
+    walletId: string;
+    /**
+     * The message to sign as a base64-encoded string.
+     */
+    messageBase64: string;
+    /**
+     * The duration in milliseconds to wait before the signing operation times out.
+     */
+    timeoutMs?: number;
+    /**
+     * For Cosmos transactions, the `SignDoc` as a base64-encoded string.
+     */
+    cosmosSignDocBase64?: string;
+    /**
+     * A callback that returns a boolean, indicating whether the signing operation should be cancelled.
+     */
+    isCanceled?: () => boolean;
+};
+export type SignTransactionParams = PollingCallbacks & {
+    /**
+     * The ID of the wallet to use for signing.
+     */
+    walletId: string;
+    /**
+     * The transaction to sign as a base64-encoded string.
+     */
+    rlpEncodedTxBase64: string;
+    /**
+     * For EVM transactions, the chain ID.
+     */
+    chainId: string;
+    /**
+     * The duration in milliseconds to wait before the signing operation times out.
+     */
+    timeoutMs?: number;
+    /**
+     * A callback that returns a boolean, indicating whether the signing operation should be cancelled.
+     */
+    isCanceled?: () => boolean;
+};
+export type GetLinkedAccountsParams = {
+    withMetadata?: boolean;
+};
+export type GetLinkedAccountsResponse = LinkedAccounts & {
+    userId: string;
+};
+export type ExportPrivateKeyParams = {
+    walletId?: string;
+    shouldOpenPopup?: boolean;
+} | undefined;
+export type ExportPrivateKeyResponse = {
+    popupWindow?: Window;
+    url: string;
+};
+export type LinkAccountParams = {
+    auth: VerifiedAuth;
+} | {
+    externalWallet: ExternalWalletInfo;
+} | {
+    type: TLinkedAccountType | 'X';
+};
+export type UnlinkAccountParams = {
+    linkedAccountId: string;
+};
+export type VerifyEmailOrPhoneLinkParams = {
+    verificationCode?: string;
+};
 export type CoreMethods = Record<CoreMethodName, {
     params?: unknown;
     response?: unknown;
@@ -49,13 +133,8 @@ export type CoreMethods = Record<CoreMethodName, {
         sync: true;
     };
     signUpOrLogIn: {
-        params: WithCustomTheme & WithUseShortUrls & {
-            /**
-             * The user's email address or phone number, in the form `{ email: '...' } | { phone: '+1...' }`}
-             */
-            auth: VerifiedAuth;
-        };
-        response: AuthStateVerify | AuthStateLogin;
+        params: SignUpOrLogInParams;
+        response: SignUpOrLogInResponse;
     };
     verifyNewAccount: {
         params: WithCustomTheme & WithUseShortUrls & {
@@ -67,64 +146,23 @@ export type CoreMethods = Record<CoreMethodName, {
         response: AuthStateSignup;
     };
     waitForLogin: {
-        params: PollParams & {
-            /**
-             * Whether to skip the session refresh
-             */
-            skipSessionRefresh?: boolean;
-            /**
-             * A function returning a boolean, indicating whether the login process should be cancelled.
-             */
-            isCanceled?: () => boolean;
-        };
-        response: {
-            /**
-             * Whether the signed-in user still needs to create one or more wallets for this application.
-             */
-            needsWallet?: boolean;
-            /**
-             * The partner ID for the current application.
-             */
-            partnerId?: string;
-        };
+        params: WaitForLoginParams;
+        response: WaitForLoginResponse;
     };
     waitForSignup: {
-        params: PollParams & {
-            /**
-             * A function returning a boolean, indicating whether the signup process should be cancelled.
-             */
-            isCanceled?: () => boolean;
-        };
+        params: WaitForSignupParams;
         response: true;
     };
     waitForWalletCreation: {
-        params: PollParams & {
-            /**
-             * A function returning a boolean, indicating whether wallet creation should be cancelled.
-             */
-            isCanceled?: () => boolean;
-        };
-        response: {
-            /**
-             * The IDs of the newly created wallets.
-             */
-            walletIds: CurrentWalletIds;
-            /**
-             * The recovery secret for the new wallets, if available.
-             */
-            recoverySecret?: string;
-        };
+        params: WaitForWalletCreationParams;
+        response: WaitForWalletCreationResponse;
     };
     getOAuthUrl: {
-        params: OAuthUrlParams & {
-            sessionLookupId?: string;
-            encryptionKey?: string;
-            portalCallbackParams?: Record<string, string>;
-        };
+        params: GetOAuthUrlParams;
         response: string;
     };
     verifyOAuth: {
-        params: AuthStateBaseParams & OAuthParams;
+        params: VerifyOAuthProcessParams;
         response: OAuthResponse;
     };
     getFarcasterConnectUri: {
@@ -132,51 +170,27 @@ export type CoreMethods = Record<CoreMethodName, {
         response: string;
     };
     verifyFarcaster: {
-        params: AuthStateBaseParams & FarcasterParams;
+        params: VerifyFarcasterParams;
         response: OAuthResponse;
     };
     verifyTelegram: {
-        params: AuthStateBaseParams & TelegramParams;
+        params: VerifyTelegramParams;
         response: OAuthResponse;
     };
     loginExternalWallet: {
-        params: AuthStateBaseParams & {
-            /**
-             * The external wallet information to use for login.
-             */
-            externalWallet: ExternalWalletInfo | ExternalWalletInfo[];
-            /**
-             * The chain ID used to generate the SIWE message.
-             */
-            chainId?: string;
-            /**
-             * The URI used to generate the SIWE message.
-             */
-            uri?: string;
-        };
-        response: AuthStateVerifyOrLogin;
+        params: LoginExternalWalletParams;
+        response: LoginExternalWalletResponse;
     };
     verifyExternalWallet: {
-        params: (AuthStateBaseParams & {
-            serverAuthState: ServerAuthStateSignup | ServerAuthStateLogin | ServerAuthStateDone;
-        }) | (AuthStateBaseParams & VerifyExternalWalletParams & {
-            serverAuthState?: undefined;
-        });
-        response: AuthStateSignup | AuthStateLogin | AuthStateDone;
+        params: VerifyExternalWalletParams;
+        response: VerifyExternalWalletResponse;
     };
     resendVerificationCode: {
-        params: {
-            type?: 'SIGNUP' | 'LINK_ACCOUNT' | 'LOGIN';
-        } | undefined;
+        params: ResendVerificationCodeParams;
         response: void;
     };
     logout: {
-        params: {
-            /**
-             * Whether to remove all pregen wallets from storage.
-             */
-            clearPregenWallets?: boolean;
-        };
+        params: LogoutParams;
         response: void;
     };
     clearStorage: {
@@ -224,25 +238,11 @@ export type CoreMethods = Record<CoreMethodName, {
         response: Setup2faResponse;
     };
     enable2fa: {
-        params: {
-            /**
-             * The two-factor authentication code entered by the user.
-             */
-            verificationCode: string;
-        };
+        params: Enable2faParams;
         response: void;
     };
     verify2fa: {
-        params: {
-            /**
-             * The email or phone number for the user to verify, in the form `{ email: '...' } | { phone: '+1...' }`
-             */
-            auth: VerifiedAuth;
-            /**
-             * The two-factor authentication code entered by the user.
-             */
-            verificationCode: string;
-        };
+        params: Verify2faParams;
         response: Verify2faResponse;
     };
     getWallets: {
@@ -260,127 +260,43 @@ export type CoreMethods = Record<CoreMethodName, {
         response: WalletEntity[];
     };
     createWallet: {
-        params: {
-            type?: Uppercase<TWalletType>;
-            skipDistribute?: boolean;
-        };
-        response: [Wallet, string | undefined];
+        params: CreateWalletParams;
+        response: CreateWalletResponse;
     };
     createWalletPerType: {
-        params: {
-            /**
-             * Array of the wallet types to create
-             */
-            types?: Uppercase<TWalletType>[];
-            /**
-             * If `true`, skip distributing the new wallets shares.
-             */
-            skipDistribute?: boolean;
-        };
-        response: {
-            /**
-             * Array of the created wallets
-             */
-            wallets: Wallet[];
-            /**
-             * The `CurrentWalletIds` value for the new wallets
-             */
-            walletIds: CurrentWalletIds;
-            /**
-             * The recovery secret for the new wallets, if available.
-             */
-            recoverySecret?: string;
-        };
+        params: CreateWalletPerTypeParams;
+        response: CreateWalletPerTypeResponse;
     };
     getPregenWallets: {
-        params: {
-            /**
-             * The pregen ID for the wallets to fetch. If not provided, all available wallets will be retrieved.
-             */
-            pregenId?: PregenAuth;
-        };
-        response: WalletEntity[];
+        params: GetPregenWalletsParams;
+        response: GetPregenWalletsResponse;
     };
     updatePregenWalletIdentifier: {
-        params: {
-            /**
-             * The ID of the pregen wallet to update.
-             */
-            walletId: string;
-            /**
-             * The new identifer for the wallet.
-             */
-            newPregenId: PregenAuth;
-        };
+        params: UpdatePregenWalletIdentifierParams;
         response: void;
     };
     hasPregenWallet: {
-        params: {
-            /**
-             * The pregen ID for the wallet to check.
-             */
-            pregenId: PregenAuth;
-        };
+        params: HasPregenWalletParams;
         response: boolean;
     };
     createPregenWallet: {
-        params: {
-            /**
-             * The type of wallet to create, 'EVM' | 'SOLANA' | 'COSMOS'
-             */
-            type: TWalletType;
-            /**
-             * The pregen identifier for the wallet, in the form: `{ email: string } | { phone: string } | { telegramUserId: string } | { farcasterUsername: string } | { xUsername: string } | { discordUsername: string } | { customId: string }`
-             */
-            pregenId: PregenAuth;
-        };
-        response: Wallet;
+        params: CreatePregenWalletParams;
+        response: CreatePregenWalletResponse;
     };
     createPregenWalletPerType: {
-        params: {
-            /**
-             * The wallet types to create. If not provided, defaults to your application's `supportedWalletTypes` setting.
-             */
-            types?: TWalletType[];
-            /**
-             * The pregen identifier for the wallets, in the form: `{ email: string } | { phone: string } | { telegramUserId: string } | { farcasterUsername: string } | { xUsername: string } | { discordUsername: string } | { customId: string }`
-             */
-            pregenId: PregenAuth;
-        };
-        response: Wallet[];
+        params: CreatePregenWalletPerTypeParams;
+        response: CreatePregenWalletPerTypeResponse;
     };
     claimPregenWallets: {
-        params: {
-            /**
-             * The pregen identifier for the wallet to claim. If not provided, will attempt to claim all wallets in storage.
-             */
-            pregenId?: PregenAuth;
-        };
-        response: string | undefined;
+        params: ClaimPregenWalletsParams;
+        response: ClaimPregenWalletsResponse;
     };
     createGuestWallets: {
         params: void;
-        response: Wallet[];
+        response: CreateGuestWalletsResponse;
     };
     distributeNewWalletShare: {
-        params: {
-            /**
-             * The ID of the wallet whose share to distribute.
-             */
-            walletId: string;
-            /**
-             * The user share string.
-             */
-            userShare?: string;
-            /**
-             * If `true`, skip biometric share creation.
-             */
-            skipBiometricShareCreation?: boolean;
-            /**
-             * If `true`, force a session refresh.
-             */
-            forceRefresh?: boolean;
-        };
+        params: DistributeNewWalletShareParams;
         response: string;
     };
     getUserShare: {
@@ -393,69 +309,15 @@ export type CoreMethods = Record<CoreMethodName, {
         response: void;
     };
     refreshShare: {
-        params: {
-            walletId: string;
-            share: string;
-            oldPartnerId?: string;
-            newPartnerId?: string;
-            keyShareProtocolId?: string;
-            redistributeBackupEncryptedShares?: boolean;
-            emailProps?: BackupKitEmailProps;
-        };
-        response: {
-            protocolId: string;
-            recoverySecret?: string;
-            signer: string;
-        };
+        params: RefreshShareParams;
+        response: RefreshShareResponse;
     };
     signMessage: {
-        params: PollParams & {
-            /**
-             * The ID of the wallet to use for signing.
-             */
-            walletId: string;
-            /**
-             * The message to sign as a base64-encoded string.
-             */
-            messageBase64: string;
-            /**
-             * The duration in milliseconds to wait before the signing operation times out.
-             */
-            timeoutMs?: number;
-            /**
-             * For Cosmos transactions, the `SignDoc` as a base64-encoded string.
-             */
-            cosmosSignDocBase64?: string;
-            /**
-             * A callback that returns a boolean, indicating whether the signing operation should be cancelled.
-             */
-            isCanceled?: () => boolean;
-        };
+        params: SignMessageParams;
         response: FullSignatureRes;
     };
     signTransaction: {
-        params: PollParams & {
-            /**
-             * The ID of the wallet to use for signing.
-             */
-            walletId: string;
-            /**
-             * The transaction to sign as a base64-encoded string.
-             */
-            rlpEncodedTxBase64: string;
-            /**
-             * For EVM transactions, the chain ID.
-             */
-            chainId: string;
-            /**
-             * The duration in milliseconds to wait before the signing operation times out.
-             */
-            timeoutMs?: number;
-            /**
-             * A callback that returns a boolean, indicating whether the signing operation should be cancelled.
-             */
-            isCanceled?: () => boolean;
-        };
+        params: SignTransactionParams;
         response: FullSignatureRes;
     };
     initiateOnRampTransaction: {
@@ -482,64 +344,52 @@ export type CoreMethods = Record<CoreMethodName, {
     };
     getWalletBalance: {
         params: GetWalletBalanceParams;
-        response: GetWalletBalanceResponse;
+        response: string;
     };
     issueJwt: {
         params: IssueJwtParams;
         response: IssueJwtResponse;
     };
     getLinkedAccounts: {
-        params: {
-            withMetadata?: boolean;
-        };
-        response: LinkedAccounts & {
-            userId: string;
-        };
+        params: GetLinkedAccountsParams;
+        response: GetLinkedAccountsResponse;
     };
     addCredential: {
-        params: Pick<NewCredentialUrlParams, 'authMethod'>;
-        response: Promise<string>;
+        params: AddCredentialParams;
+        response: string;
     };
     exportPrivateKey: {
-        params: {
-            walletId?: string;
-            shouldOpenPopup?: boolean;
-        } | undefined;
-        response: {
-            popupWindow?: Window;
-            url: string;
-        };
+        params: ExportPrivateKeyParams;
+        response: ExportPrivateKeyResponse;
+    };
+    authenticateWithEmailOrPhone: {
+        params: AuthenticateWithEmailOrPhoneParams;
+        response: AuthenticateWithEmailOrPhoneResponse;
+    };
+    authenticateWithOAuth: {
+        params: AuthenticateWithOAuthParams;
+        response: AuthenticateWithOAuthResponse;
     };
 };
 export type InternalMethods = {
     linkAccount: {
-        params: {
-            auth: VerifiedAuth;
-        } | {
-            externalWallet: ExternalWalletInfo;
-        } | {
-            type: TLinkedAccountType | 'X';
-        };
+        params: LinkAccountParams;
         response: AccountLinkInProgress;
     };
     unlinkAccount: {
-        params: {
-            linkedAccountId: string;
-        };
+        params: UnlinkAccountParams;
         response: LinkedAccounts;
     };
     verifyEmailOrPhoneLink: {
-        params: {
-            verificationCode?: string;
-        };
+        params: VerifyEmailOrPhoneLinkParams;
         response: LinkedAccounts;
     };
     verifyOAuthLink: {
-        params: OAuthParams;
+        params: VerifyOAuthProcessParams;
         response: LinkedAccounts;
     };
     verifyFarcasterLink: {
-        params: FarcasterParams;
+        params: VerifyFarcasterParams;
         response: LinkedAccounts;
     };
     verifyTelegramLink: {
@@ -547,7 +397,7 @@ export type InternalMethods = {
         response: LinkedAccounts;
     };
     verifyExternalWalletLink: {
-        params: Omit<VerifyExternalWalletParams, 'externalWallet'>;
+        params: Omit<BaseVerifyExternalWalletParams, 'externalWallet'>;
         response: LinkedAccounts;
     };
     prepareLogin: {

package/dist/types/types/index.d.ts

@@ -1,7 +1,9 @@
-export * from './auth.js';
+export * from './accountLinking.js';
 export * from './config.js';
 export * from './coreApi.js';
 export * from './wallet.js';
 export * from './methods.js';
 export * from './popup.js';
 export * from './events.js';
+export type * from './util';
+export type * from './authState';