@getpara/user-management-client 1.12.0 → 2.0.0-alpha.11

package/dist/types/client.d.ts

@@ -1,5 +1,5 @@
 import { AxiosResponse } from 'axios';
-import { AccountMetadata, Auth, AuthMethod, AuthParams, BackupKitEmailProps, BiometricLocationHint, Chain, CurrentWalletIds, EncryptedKeyShare, EncryptorType, KeyShareType, Network, OnRampAsset, OnRampConfig, OnRampProvider, OnRampPurchase, OnRampPurchaseCreateParams, OnRampPurchaseUpdateParams, PasswordStatus, PregenIds, PublicKeyStatus, PublicKeyType, TelegramAuthResponse, TPregenIdentifierType, VerificationEmailProps, WalletEntity, WalletParams, WalletScheme, WalletType } from './types/index.js';
+import { AccountMetadata, Auth, AuthIdentifier, AuthMethod, BackupKitEmailProps, BiometricLocationHint, Chain, CurrentWalletIds, EncryptedKeyShare, EncryptorType, ExternalWalletInfo, LoginExternalWalletResponse, KeyShareType, Network, OnRampAsset, OnRampConfig, OnRampProvider, OnRampPurchase, OnRampPurchaseCreateParams, OnRampPurchaseUpdateParams, PasswordStatus, PregenIds, PrimaryAuth, PublicKeyStatus, PublicKeyType, ServerAuthStateSignup, SessionInfo, Setup2faResponse, SignUpOrLogInResponse, TelegramAuthResponse, TPregenIdentifierType, VerificationEmailProps, VerifiedAuth, VerifyFarcasterResponse, VerifyTelegramResponse, VerifyThirdPartyAuth, WalletEntity, WalletParams, TWalletScheme, TWalletType, VerifyExternalWalletParams } from './types/index.js';
 interface ConfigOpts {
     useFetchAdapter?: boolean;
 }
@@ -7,30 +7,11 @@ type ClientConfig = {
     userManagementHost: string;
     version?: string;
     partnerId?: string;
-    apiKey?: string;
+    apiKey: string;
     opts?: ConfigOpts;
     retrieveSessionCookie?: () => string | undefined;
     persistSessionCookie?: (cookie: string) => void;
 };
-interface createUserBody {
-    email: string;
-}
-interface createUserBodyForPhone {
-    phone: string;
-    countryCode: string;
-}
-interface ExternalWalletLoginBody {
-    externalAddress: string;
-    type: 'EVM' | 'SOLANA' | 'COSMOS';
-    externalWalletProvider?: string;
-    shouldTrackUser?: boolean;
-}
-export interface ExternalWalletLoginRes {
-    userId: string;
-    userExists: boolean;
-    isVerified: boolean;
-    signatureVerificationMessage: string;
-}
 interface createUserIdRes {
     protocolId: string;
     userId: string;
@@ -38,12 +19,6 @@ interface createUserIdRes {
 interface verifyBody {
     verificationCode: string;
 }
-interface verifyExternalWalletBody {
-    address: string;
-    signedMessage: string;
-    cosmosPublicKeyHex?: string;
-    cosmosSigner?: string;
-}
 interface getWebChallengeRes {
     challenge: string;
     allowedPublicKeys?: string[];
@@ -95,8 +70,8 @@ interface PasswordEntity {
 }
 interface createWalletBody {
     useTwoSigners?: boolean;
-    scheme: WalletScheme;
-    type: WalletType;
+    scheme: TWalletScheme;
+    type: TWalletType;
     cosmosPrefix?: string;
 }
 interface updatePregenWalletBody {
@@ -113,8 +88,8 @@ interface GetWalletBalanceRes {
 interface createPregenWalletBody {
     pregenIdentifier: string;
     pregenIdentifierType: TPregenIdentifierType;
-    scheme?: WalletScheme;
-    type: WalletType;
+    scheme?: TWalletScheme;
+    type: TWalletType;
     cosmosPrefix?: string;
 }
 interface claimPreGenWalletsBody {
@@ -141,7 +116,6 @@ interface sessionPasswordBody {
     encryptedWalletPrivateKey?: string;
     encryptionKeyHash?: string;
 }
-type BiometricLocationHintParams = AuthParams;
 export type SDKType = 'WEB' | 'SERVER' | 'BRIDGE' | 'REACT_NATIVE';
 export type VerifyTelegramRes = {
     isValid: true;
@@ -158,20 +132,35 @@ export declare const handleResponseError: (error: any) => never;
 declare class Client {
     private baseRequest;
     constructor({ userManagementHost, apiKey, partnerId, version, opts, retrieveSessionCookie, persistSessionCookie, }: ClientConfig);
-    createUser: (body: (createUserBody | createUserBodyForPhone) & VerificationEmailProps) => Promise<createUserIdRes>;
-    checkUserExists: (auth: Auth<"email" | "phone">) => Promise<any>;
-    verifyTelegram: (authObject: TelegramAuthResponse) => Promise<VerifyTelegramRes>;
-    externalWalletLogin: (body: ExternalWalletLoginBody) => Promise<ExternalWalletLoginRes>;
+    signUpOrLogIn: (body: VerifiedAuth & VerificationEmailProps) => Promise<SignUpOrLogInResponse>;
+    /**
+     * @deprecated
+     */
+    createUser: (body: VerifiedAuth & VerificationEmailProps) => Promise<createUserIdRes>;
+    checkUserExists: (auth: VerifiedAuth) => Promise<any>;
+    verifyTelegram: (authObject: TelegramAuthResponse) => Promise<VerifyTelegramResponse>;
+    verifyOAuth: () => Promise<VerifyThirdPartyAuth | null>;
+    loginExternalWallet: ({ externalWallet, shouldTrackUser, }: {
+        externalWallet: ExternalWalletInfo;
+        shouldTrackUser?: boolean;
+    }) => Promise<LoginExternalWalletResponse>;
+    verifyNewAccount: (userId: string, body: verifyBody) => Promise<ServerAuthStateSignup>;
+    /**
+     * @deprecated
+     */
     verifyEmail: (userId: string, body: verifyBody) => Promise<any>;
+    /**
+     * @deprecated
+     */
     verifyPhone: (userId: string, body: verifyBody) => Promise<any>;
-    verifyExternalWallet: (userId: string, body: verifyExternalWalletBody) => Promise<any>;
+    verifyExternalWallet: (userId: string, body: VerifyExternalWalletParams) => Promise<ServerAuthStateSignup>;
     addSessionPublicKey: (userId: string, body: sessionPublicKeyBody) => Promise<any>;
     getSessionPublicKeys: (userId: string) => Promise<any>;
-    getBiometricLocationHints: (params: BiometricLocationHintParams) => Promise<BiometricLocationHint[]>;
+    getBiometricLocationHints: (auth: PrimaryAuth) => Promise<BiometricLocationHint[]>;
     getSessionPublicKey: (userId: string, biometricId: string) => Promise<any>;
     patchSessionPublicKey: (partnerId: string, userId: string, biometricId: string, body: sessionPublicKeyBody) => Promise<any>;
-    getWebChallenge: (auth?: Auth) => Promise<getWebChallengeRes>;
-    touchSession: (regenerate?: boolean) => Promise<any>;
+    getWebChallenge: (auth?: PrimaryAuth | Auth<"userId">) => Promise<getWebChallengeRes>;
+    touchSession: (regenerate?: boolean) => Promise<SessionInfo>;
     sessionOrigin: (sessionLookupId: string) => Promise<{
         origin?: string;
     }>;
@@ -180,12 +169,12 @@ declare class Client {
     verifySessionChallenge: (userId: string, body: verifySessionChallengeBody) => Promise<any>;
     createWallet: (userId: string, body?: createWalletBody) => Promise<createWalletRes>;
     createPregenWallet: (body?: createPregenWalletBody) => Promise<createWalletRes>;
-    getPregenWallets: <ReturnType = {
+    getPregenWallets: (pregenIds: PregenIds, isPortal?: boolean, userId?: string) => Promise<{
         wallets: WalletEntity[];
-    }>(pregenIds: PregenIds, isPortal?: boolean, userId?: string) => Promise<ReturnType>;
-    claimPregenWallets: <ReturnType = {
-        walletIds?: string[];
-    }>(body?: claimPreGenWalletsBody) => Promise<ReturnType>;
+    }>;
+    claimPregenWallets: (body?: claimPreGenWalletsBody) => Promise<{
+        walletIds: string[];
+    }>;
     sendTransaction: (userId: string, walletId: string, body: sendTransactionBody) => Promise<any>;
     signTransaction: (userId: string, walletId: string, body: signTransactionBody) => Promise<any>;
     refreshKeys: (userId: string, walletId: string, oldPartnerId?: string, newPartnerId?: string, keyShareProtocolId?: string) => Promise<any>;
@@ -200,7 +189,7 @@ declare class Client {
     logout: () => Promise<any>;
     recoveryVerification: (email: string, verificationCode: string) => Promise<any>;
     recoveryInit: (email: string) => Promise<any>;
-    preSignMessage: (userId: string, walletId: string, message: string, scheme?: WalletScheme, cosmosSignDoc?: string) => Promise<any>;
+    preSignMessage: (userId: string, walletId: string, message: string, scheme?: TWalletScheme, cosmosSignDoc?: string) => Promise<any>;
     deleteSelf: (userId: string) => Promise<any>;
     uploadKeyshares(userId: string, walletId: string, encryptedKeyshares: EncryptedKeyShare[]): Promise<any>;
     uploadUserKeyShares(userId: string, encryptedKeyshares: (EncryptedKeyShare & {
@@ -227,10 +216,10 @@ declare class Client {
     cancelRecoveryAttempt(email: string): Promise<AxiosResponse<any, any>>;
     check2FAStatus(userId: string): Promise<AxiosResponse<any, any>>;
     enable2FA(userId: string, verificationCode: string): Promise<AxiosResponse<any, any>>;
-    setup2FA(userId: string): Promise<AxiosResponse<any, any>>;
+    setup2FA(userId: string): Promise<Setup2faResponse>;
     initializeRecovery(email: string): Promise<AxiosResponse<any, any>>;
     initializeFarcasterLogin(): Promise<AxiosResponse<any, any>>;
-    getFarcasterAuthStatus(): Promise<AxiosResponse<any, any>>;
+    getFarcasterAuthStatus(): Promise<VerifyFarcasterResponse>;
     initializeRecoveryForPhone(phone: string, countryCode: string): Promise<AxiosResponse<any, any>>;
     finalizeRecovery(userId: string, walletId: string): Promise<AxiosResponse<any, any>>;
     recoverUserShares(userId: string, walletId: string): Promise<AxiosResponse<{
@@ -249,8 +238,11 @@ declare class Client {
     }, any>>;
     verifyEmailForRecovery(email: string, verificationCode: string): Promise<AxiosResponse<any, any>>;
     verifyPhoneForRecovery(phone: string, countryCode: string, verificationCode: string): Promise<AxiosResponse<any, any>>;
-    verify2FA(email: string, verificationCode: string): Promise<AxiosResponse<any, any>>;
-    verify2FAForPhone(phone: string, countryCode: string, verificationCode: string): Promise<AxiosResponse<any, any>>;
+    verify2FA(auth: VerifiedAuth, verificationCode: string): Promise<any>;
+    /**
+     * @deprecated
+     */
+    verify2FAForPhone(phone: AuthIdentifier<'phone'>, verificationCode: string): Promise<AxiosResponse<any, any>>;
     tempTrasmissionInit(message: string, userId?: string): Promise<AxiosResponse<any, any>>;
     tempTrasmission(id: string): Promise<AxiosResponse<any, any>>;
     getPartner(partnerId: string): Promise<AxiosResponse<any, any>>;
@@ -273,7 +265,7 @@ declare class Client {
     } & WalletParams): Promise<AxiosResponse<OnRampPurchase, any>>;
     signMoonPayUrl(userId: string, { url, type, cosmosPrefix, testMode, walletId, externalWalletAddress, }: {
         url: string;
-        type: WalletType;
+        type: TWalletType;
         cosmosPrefix: string;
         testMode?: boolean;
         walletId?: string;
@@ -292,7 +284,7 @@ declare class Client {
         contractAddress?: string;
         testMode?: boolean;
         walletId: string;
-        walletType: WalletType;
+        walletType: TWalletType;
         destinationAddress: string;
         sourceAddress?: string;
         assetQuantity: string | number;
@@ -305,7 +297,7 @@ declare class Client {
         sourceAddress?: string;
         network: Network;
         walletId: string;
-        walletType: WalletType;
+        walletType: TWalletType;
     }): Promise<ReturnType>;
     distributeParaShare({ userId, walletId, ...rest }: {
         userId: string;
@@ -344,8 +336,7 @@ declare class Client {
     getAccountMetadata(userId: string, partnerId: string): Promise<{
         accountMetadata: AccountMetadata;
     }>;
-    getWalletBalance: ({ userId, walletId, rpcUrl, }: {
-        userId: string;
+    getWalletBalance: ({ walletId, rpcUrl }: {
         walletId: string;
         rpcUrl?: string;
     }) => Promise<GetWalletBalanceRes>;

package/dist/types/index.d.ts

@@ -1,5 +1,6 @@
 export * from './client.js';
 export * from './types/index.js';
 export * from './utils.js';
+export * from './error.js';
 import Client from './client.js';
 export default Client;

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

@@ -1,11 +1,18 @@
-export type AuthType = 'email' | 'phone' | 'farcaster' | 'telegram' | 'userId' | 'externalWallet';
-export type $ExtractAuth<T extends AuthType> = {
+import { CurrentWalletIds, ExternalWalletType, SupportedWalletTypes } from './wallet.js';
+export declare const AUTH_TYPES: readonly ["email", "phone", "phoneLegacy", "farcaster", "telegram", "userId", "externalWallet", "discord", "x", "customId", "guestId"];
+export type AuthType = 'email' | 'phone' | 'phoneLegacy' | 'farcaster' | 'telegram' | 'userId' | 'externalWallet' | 'discord' | 'x' | 'customId' | 'guestId';
+export type PrimaryAuthType = Extract<AuthType, 'email' | 'phone' | 'farcaster' | 'telegram' | 'externalWallet'>;
+export type VerifiedAuthType = Extract<PrimaryAuthType, 'email' | 'phone' | 'externalWallet'>;
+export type PregenAuthType = Exclude<PrimaryAuthType, 'externalWallet'> | Extract<AuthType, 'discord' | 'x' | 'customId'>;
+export type AuthIdentifier<T extends AuthType | never> = T extends 'phone' ? `+${number}` : string;
+export type AuthInfo<T extends Exclude<AuthType, 'phoneLegacy'> = Exclude<AuthType, 'phoneLegacy'>> = {
     auth: Auth<T>;
     authType: T;
-    identifier: string;
-    publicKeyIdentifier: string;
+    identifier: AuthIdentifier<T>;
 };
-export type ExtractAuth = $ExtractAuth<'email'> | $ExtractAuth<'phone'> | $ExtractAuth<'farcaster'> | $ExtractAuth<'telegram'> | $ExtractAuth<'userId'> | $ExtractAuth<'externalWallet'>;
+export type PrimaryAuthInfo = AuthInfo<PrimaryAuthType>;
+export type VerifiedAuthInfo = AuthInfo<VerifiedAuthType>;
+export type PregenAuthInfo = AuthInfo<PregenAuthType>;
 export type AuthParams = Record<string, any> & {
     email?: string;
     phone?: string;
@@ -17,17 +24,49 @@ export type AuthParams = Record<string, any> & {
 };
 export type Auth<T extends AuthType = AuthType> = T extends 'email' ? {
     email: string;
-} : T extends 'phone' ? {
+} : T extends 'phoneLegacy' ? {
     phone: string;
     countryCode: string;
+} : T extends 'phone' ? {
+    phone: AuthIdentifier<'phone'>;
 } : T extends 'farcaster' ? {
-    farcasterUsername: string;
+    farcasterUsername: AuthIdentifier<'farcaster'>;
 } : T extends 'telegram' ? {
-    telegramUserId: string;
+    telegramUserId: AuthIdentifier<'telegram'>;
 } : T extends 'externalWallet' ? {
-    externalWalletAddress: string;
+    externalWalletAddress: AuthIdentifier<'externalWallet'>;
+} : T extends 'x' ? {
+    xUsername: AuthIdentifier<'x'>;
+} : T extends 'discord' ? {
+    discordUsername: AuthIdentifier<'discord'>;
+} : T extends 'customId' ? {
+    customId: AuthIdentifier<'customId'>;
+} : T extends 'guestId' ? {
+    guestId: AuthIdentifier<'guestId'>;
 } : {
-    userId: string;
+    userId: AuthIdentifier<'userId'>;
+};
+export type PrimaryAuth = Auth<PrimaryAuthType>;
+export type VerifiedAuth = Auth<VerifiedAuthType>;
+export type PregenAuth = Auth<PregenAuthType>;
+export type PregenOrGuestAuth = Auth<PregenAuthType | 'guestId'>;
+export type AuthExtras = {
+    /**
+     * The current user's third-party username.
+     */
+    username?: string;
+    /**
+     * The current user's third-party display name.
+     */
+    displayName?: string;
+    /**
+     * The current user's third-party profile picture URL.
+     */
+    pfpUrl?: string;
+    /**
+     * The current user's external wallet information.
+     */
+    externalWallet?: ExternalWalletInfo;
 };
 export declare enum EncryptorType {
     USER = "USER",
@@ -61,6 +100,7 @@ export interface EncryptedKeyShare {
     partnerId?: string;
     protocolId?: string;
 }
+/** @deprecated use the string union type `TOAuthMethod` instead */
 export declare enum OAuthMethod {
     GOOGLE = "GOOGLE",
     TWITTER = "TWITTER",
@@ -70,6 +110,8 @@ export declare enum OAuthMethod {
     FARCASTER = "FARCASTER",
     TELEGRAM = "TELEGRAM"
 }
+export declare const OAUTH_METHODS: readonly ["GOOGLE", "TWITTER", "APPLE", "DISCORD", "FACEBOOK", "FARCASTER", "TELEGRAM"];
+export type TOAuthMethod = (typeof OAUTH_METHODS)[number];
 export declare enum AuthMethod {
     PASSWORD = "PASSWORD",
     PASSKEY = "PASSKEY"
@@ -87,7 +129,86 @@ export type TelegramAuthResponse = {
     photo_url?: string;
     username?: string;
 };
-export type AccountMetadataKey = Lowercase<Exclude<OAuthMethod, OAuthMethod.TWITTER> | 'X'>;
+export type SessionInfo = {
+    userId?: string;
+    sessionId?: string;
+    sessionLookupId?: string;
+    partnerId: string;
+    biometricVerifiedAt?: number;
+    currentWalletIds?: CurrentWalletIds;
+    needsWallet?: boolean;
+    isAuthenticated?: boolean;
+    supportedWalletTypes: SupportedWalletTypes;
+    cosmosPrefix?: string;
+    origin?: string;
+    email?: string;
+};
+export type ServerAuthStateBase = AuthExtras & {
+    auth: PrimaryAuth;
+    userId: string;
+};
+export type ServerAuthStateVerify = ServerAuthStateBase & {
+    stage: 'verify';
+    signatureVerificationMessage?: string;
+};
+export type ServerAuthStateSignup = ServerAuthStateBase & {
+    stage: 'signup';
+    signupAuthMethods: AuthMethod[];
+};
+export type ServerAuthStateLogin = ServerAuthStateBase & {
+    stage: 'login';
+    biometricHints?: BiometricLocationHint[];
+    loginAuthMethods: AuthMethod[];
+};
+export type VerifyThirdPartyAuth = ServerAuthStateSignup | ServerAuthStateLogin;
+export type ExternalWalletInfo = {
+    address: string;
+    type: ExternalWalletType;
+    provider?: string;
+    addressBech32?: string;
+    withFullParaAuth?: boolean;
+    ensName?: string | null;
+    ensAvatar?: string | null;
+};
+export type VerifyExternalWalletParams = {
+    /**
+     * The external wallet information to verify.
+     */
+    externalWallet: ExternalWalletInfo;
+    /**
+     * The signature of the signed verification string.
+     */
+    signedMessage: string;
+    /**
+     * For Cosmos wallets, the wallet's public key as a hex string.
+     */
+    cosmosPublicKeyHex?: string;
+    /**
+     * For Cosmos wallets, the base64 signer string.
+     */
+    cosmosSigner?: string;
+};
+export type LoginExternalWalletResponse = ServerAuthStateLogin | (ServerAuthStateVerify & {
+    signatureVerificationMessage: string;
+});
+export type VerifyTelegramResponse = VerifyThirdPartyAuth;
+export type VerifyFarcasterResponse = VerifyThirdPartyAuth | Record<string, never>;
+export type ServerAuthState = ServerAuthStateVerify | ServerAuthStateSignup | ServerAuthStateLogin;
+export type SignUpOrLogInResponse = ServerAuthStateVerify | ServerAuthStateLogin;
+export type Setup2faResponse = {
+    /**
+     * Indicates whether 2FA has already been set up for the current user.
+     */
+    isSetup: true;
+    uri: undefined;
+} | {
+    isSetup?: false;
+    /**
+     * A URI for the user to set up two-factor authentication.
+     */
+    uri: string;
+};
+export type AccountMetadataKey = Lowercase<Exclude<TOAuthMethod, 'TWITTER'> | 'X'>;
 export type AccountMetadata = Partial<Record<AccountMetadataKey, {
     date: Date;
     metadata: Record<string, any>;

package/dist/types/types/onRamp.d.ts

@@ -1,4 +1,4 @@
-import { Network, WalletType } from './wallet.js';
+import { Network, TWalletType } from './wallet.js';
 export declare enum OnRampProvider {
     RAMP = "RAMP",
     STRIPE = "STRIPE",
@@ -30,7 +30,7 @@ export interface OnRampPurchase {
     userId: string;
     type?: OnRampPurchaseType;
     walletId?: string | null;
-    walletType?: WalletType;
+    walletType?: TWalletType;
     externalWalletAddress?: string | null;
     address?: string | null;
     status?: OnRampPurchaseStatus;
@@ -51,7 +51,7 @@ export type OnRampPurchaseCreateParams = Omit<OnRampPurchase, 'id' | 'userId'> &
 };
 export type OnRampPurchaseUpdateParams = Omit<OnRampPurchase, 'id' | 'userId'>;
 type ProviderAssetInfo = [string, Partial<Record<OnRampPurchaseType, boolean>>];
-export type OnRampAssetInfo = Record<WalletType, Partial<Record<Network, Partial<Record<OnRampAsset, Partial<Record<OnRampProvider, ProviderAssetInfo>>>>>>>;
+export type OnRampAssetInfo = Record<TWalletType, Partial<Record<Network, Partial<Record<OnRampAsset, Partial<Record<OnRampProvider, ProviderAssetInfo>>>>>>>;
 export type OnRampAllowedAssets = Partial<Record<Network, true | OnRampAsset[]>>;
 export type OnRampConfig = {
     isBuyEnabled: boolean;

package/dist/types/types/partner.d.ts

@@ -1,6 +1,9 @@
+import { AuthMethod } from './auth.js';
+import { SupportedWalletTypes } from './wallet.js';
 export interface PartnerEntity {
     id: string;
     displayName: string;
+    apiKey?: string;
     logoUrl?: string;
     iconUrl?: string;
     portalHeaderLogoUrl?: string;
@@ -10,4 +13,8 @@ export interface PartnerEntity {
     accentColor?: string;
     font?: string;
     themeMode?: 'light' | 'dark';
+    portalUrl?: string;
+    supportedAuthMethods?: AuthMethod[];
+    supportedWalletTypes?: SupportedWalletTypes;
+    cosmosPrefix?: string;
 }

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

@@ -1,14 +1,20 @@
 import { PartnerEntity } from './partner.js';
+/** @deprecated use the string union type `TWalletScheme` instead */
 export declare enum WalletScheme {
     DKLS = "DKLS",
     CGGMP = "CGGMP",
     ED25519 = "ED25519"
 }
+export declare const WALLET_SCHEMES: readonly ["DKLS", "CGGMP", "ED25519"];
+export type TWalletScheme = (typeof WALLET_SCHEMES)[number];
+/** @deprecated use the string union type `TWalletType` instead */
 export declare enum WalletType {
     EVM = "EVM",
     SOLANA = "SOLANA",
     COSMOS = "COSMOS"
 }
+export declare const WALLET_TYPES: readonly ["EVM", "SOLANA", "COSMOS"];
+export type TWalletType = (typeof WALLET_TYPES)[number];
 export declare enum Chain {
     ETH = "ETH",
     CELO = "CELO",
@@ -32,7 +38,9 @@ export type WalletParams = Partial<{
     walletId?: string;
     externalWalletAddress?: string;
 }>;
-export declare const PREGEN_IDENTIFIER_TYPES: readonly ["EMAIL", "PHONE", "CUSTOM_ID", "GUEST_ID", "DISCORD", "TWITTER", "TELEGRAM"];
+export type EmbeddedWalletType = Exclude<TWalletType, never>;
+export type ExternalWalletType = Exclude<TWalletType, never>;
+export declare const PREGEN_IDENTIFIER_TYPES: readonly ["EMAIL", "PHONE", "CUSTOM_ID", "GUEST_ID", "DISCORD", "TWITTER", "TELEGRAM", "FARCASTER"];
 export type TPregenIdentifierType = (typeof PREGEN_IDENTIFIER_TYPES)[number];
 export type PregenIds = Partial<Record<TPregenIdentifierType, string[]>>;
 export interface WalletEntity {
@@ -48,7 +56,7 @@ export interface WalletEntity {
     partner?: PartnerEntity;
     publicKey: string | null;
     scheme: string;
-    type: WalletType;
+    type: TWalletType;
     updatedAt: string;
     userId: string | null;
     lastUsedAt: string | null;
@@ -57,5 +65,9 @@ export interface WalletEntity {
     ensName?: string | null;
     ensAvatar?: string | null;
 }
-export type CurrentWalletIds = Partial<Record<WalletType, string[]>>;
-export declare const NON_ED25519: WalletScheme[];
+export type CurrentWalletIds = Partial<Record<TWalletType, string[]>>;
+export declare const NON_ED25519: string[];
+export type SupportedWalletTypes = {
+    type: TWalletType;
+    optional?: boolean;
+}[];

package/dist/types/utils.d.ts

@@ -1,4 +1,6 @@
-import { Auth, AuthParams, ExtractAuth, WalletParams, WalletRef } from './types/index.js';
+import { Auth, AuthInfo, AuthParams, PrimaryAuth, PrimaryAuthInfo, VerifiedAuth, WalletParams, WalletRef } from './types/index.js';
+import { AccountMetadata, AccountMetadataKey, PregenAuth, PregenAuthInfo, PregenOrGuestAuth } from './types/auth.js';
+import { PregenIds, TPregenIdentifierType } from './types/wallet.js';
 export declare function isWalletId(params: WalletParams): params is {
     walletId: string;
 };
@@ -6,18 +8,51 @@ export declare function isExternalWalletAddress(params: WalletParams): params is
     externalWalletAddress: string;
 };
 export declare function extractWalletRef(params: WalletParams): [WalletRef, string];
-export declare function isEmail(params: AuthParams): params is Auth<'email'>;
-export declare function isPhone(params: AuthParams): params is Auth<'phone'>;
-export declare function isFarcaster(params: AuthParams): params is Auth<'farcaster'>;
-export declare function isTelegram(params: AuthParams): params is Auth<'telegram'>;
-export declare function isUserId(params: AuthParams): params is Auth<'userId'>;
-export declare function isExternalWallet(params: AuthParams): params is Auth<'externalWallet'>;
+export declare function isEmail(params: AuthParams | undefined): params is Auth<'email'>;
+export declare function isPhone(params: AuthParams | undefined): params is Auth<'phone'>;
+export declare function isPhoneLegacy(params: AuthParams | undefined): params is Auth<'phoneLegacy'>;
+export declare function isFarcaster(params: AuthParams | undefined): params is Auth<'farcaster'>;
+export declare function isTelegram(params: AuthParams | undefined): params is Auth<'telegram'>;
+export declare function isExternalWallet(params: AuthParams | undefined): params is Auth<'externalWallet'>;
+export declare function isX(params: AuthParams | undefined): params is Auth<'x'>;
+export declare function isDiscord(params: AuthParams | undefined): params is Auth<'discord'>;
+export declare function isCustomId(params: AuthParams | undefined): params is Auth<'customId'>;
+export declare function isGuestId(params: AuthParams | undefined): params is Auth<'guestId'>;
+export declare function isUserId(params: AuthParams | undefined): params is Auth<'userId'>;
+export declare function isPrimary(params: AuthParams | undefined): params is PrimaryAuth;
+export declare function isVerifiedAuth(params: AuthParams | undefined): params is VerifiedAuth;
+export declare function isPregenAuth(params: AuthParams | undefined): params is PregenAuth;
 type ExtractAuthOpts = {
     allowUserId?: boolean;
+    allowPregen?: boolean;
     isRequired?: boolean;
 };
+export declare function extractAuthInfo(obj: AuthParams): PrimaryAuthInfo | undefined;
 export declare function extractAuthInfo(obj: AuthParams, opts: ExtractAuthOpts & {
+    allowUserId: false | undefined;
+}): PrimaryAuthInfo | undefined;
+export declare function extractAuthInfo(obj: AuthParams, opts: ExtractAuthOpts & {
+    isRequired: true;
+    allowPregen?: undefined | false;
+}): PrimaryAuthInfo;
+export declare function extractAuthInfo(obj: AuthParams, opts: ExtractAuthOpts & {
+    allowUserId: true;
+}): PrimaryAuthInfo | AuthInfo<'userId'> | undefined;
+export declare function extractAuthInfo(obj: AuthParams, opts: ExtractAuthOpts & {
+    allowUserId: true;
+    isRequired: true;
+}): PrimaryAuthInfo | AuthInfo<'userId'>;
+export declare function extractAuthInfo(obj: AuthParams, opts: ExtractAuthOpts & {
+    allowPregen: true;
+}): PregenAuthInfo | undefined;
+export declare function extractAuthInfo(obj: AuthParams, opts: ExtractAuthOpts & {
+    allowPregen: true;
     isRequired: true;
-}): ExtractAuth;
-export declare function extractAuthInfo(obj: AuthParams, opts?: ExtractAuthOpts): ExtractAuth | undefined;
+}): PregenAuthInfo;
+export declare function toPregenTypeAndId(auth: PregenOrGuestAuth): [TPregenIdentifierType, string];
+export declare function toPregenIds(auth: PregenAuth): PregenIds;
+export declare function fromAccountMetadata(obj: Partial<Record<AccountMetadataKey, {
+    date: string;
+    metadata: object;
+}>> | undefined): AccountMetadata;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getpara/user-management-client",
-  "version": "1.12.0",
+  "version": "2.0.0-alpha.11",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -32,5 +32,5 @@
       "require": "./dist/cjs/index.js"
     }
   },
-  "gitHead": "748afcf08c9d307a2d3eaf0716f73132f3eb8529"
+  "gitHead": "e877dc4237cc4cc3a233f3d4166cc8f5a1942900"
 }