@getpara/user-management-client 2.0.0-alpha.3 → 2.0.0-alpha.30

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

@@ -1,6 +1,6 @@
-import { CurrentWalletIds, ExternalWalletType, SupportedWalletTypes } from './wallet.js';
-export declare const AUTH_TYPES: readonly ["email", "phone", "phoneLegacy", "farcaster", "telegram", "userId", "externalWallet", "discord", "x", "customId"];
-export type AuthType = 'email' | 'phone' | 'phoneLegacy' | 'farcaster' | 'telegram' | 'userId' | 'externalWallet' | 'discord' | 'x' | 'customId';
+import { CurrentWalletIds, ExternalWalletType, SupportedWalletTypes, TExternalWallet } 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'>;
@@ -41,12 +41,15 @@ export type Auth<T extends AuthType = AuthType> = T extends 'email' ? {
     discordUsername: AuthIdentifier<'discord'>;
 } : T extends 'customId' ? {
     customId: AuthIdentifier<'customId'>;
+} : T extends 'guestId' ? {
+    guestId: AuthIdentifier<'guestId'>;
 } : {
     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.
@@ -97,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",
@@ -106,6 +110,11 @@ 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 const LINKED_ACCOUNT_TYPES: readonly ["EMAIL", "PHONE", "GOOGLE", "FACEBOOK", "APPLE", "TWITTER", "DISCORD", "TELEGRAM", "FARCASTER", "EXTERNAL_WALLET"];
+export type TLinkedAccountType = (typeof LINKED_ACCOUNT_TYPES)[number] | 'EXTERNAL_WALLET';
+export type SupportedAccountLinks = (TLinkedAccountType | TExternalWallet)[];
 export declare enum AuthMethod {
     PASSWORD = "PASSWORD",
     PASSKEY = "PASSKEY"
@@ -136,6 +145,7 @@ export type SessionInfo = {
     cosmosPrefix?: string;
     origin?: string;
     email?: string;
+    verifiedExternalWalletAddresses?: string[];
 };
 export type ServerAuthStateBase = AuthExtras & {
     auth: PrimaryAuth;
@@ -153,14 +163,20 @@ export type ServerAuthStateLogin = ServerAuthStateBase & {
     stage: 'login';
     biometricHints?: BiometricLocationHint[];
     loginAuthMethods: AuthMethod[];
+    isWalletSelectionNeeded?: boolean;
 };
 export type VerifyThirdPartyAuth = ServerAuthStateSignup | ServerAuthStateLogin;
 export type ExternalWalletInfo = {
     address: string;
     type: ExternalWalletType;
     provider?: string;
+    providerId?: TExternalWallet;
     addressBech32?: string;
     withFullParaAuth?: boolean;
+    ensName?: string | null;
+    ensAvatar?: string | null;
+    isConnectionOnly?: boolean;
+    withVerification?: boolean;
 };
 export type VerifyExternalWalletParams = {
     /**
@@ -200,3 +216,48 @@ export type Setup2faResponse = {
      */
     uri: string;
 };
+export type AccountMetadataKey = Lowercase<Exclude<TOAuthMethod, 'TWITTER'> | 'X'>;
+export type AccountMetadata = Partial<Record<AccountMetadataKey, {
+    date: Date;
+    metadata: Record<string, any>;
+}>>;
+export type IssueJwtParams = {
+    /**
+     * The index of the Para RSA keypair to use for signing the JWT. Defaults to `0`.
+     */
+    keyIndex?: number;
+};
+export type IssueJwtResponse = {
+    /**
+     * The Para JWT token.
+     */
+    token: string;
+    /**
+     * The `keyid`` / `kid` of the keypair used to sign the JWT.
+     */
+    keyId: string;
+};
+export type LinkedAccount<D extends Date | string = Date> = {
+    id?: string;
+    date: D;
+    type: TLinkedAccountType;
+    identifier: string;
+    displayName: string;
+    externalWallet?: ExternalWalletInfo;
+    metadata?: unknown;
+};
+export type LinkedAccounts<D extends Date | string = Date> = {
+    primary: LinkedAccount<D>[];
+    linked: LinkedAccount<D>[];
+};
+export type LinkAccountParams = {
+    type: TLinkedAccountType;
+    identifier?: string;
+    externalWallet?: ExternalWalletInfo;
+};
+export type VerifyLinkParams = {
+    linkedAccountId: string;
+    userId: string;
+    telegramAuthResponse?: TelegramAuthResponse;
+    verificationCode?: string;
+};

package/dist/types/types/email.d.ts

@@ -20,3 +20,8 @@ export interface BackupKitEmailProps {
     supportUrl?: string;
     brandColor?: string;
 }
+export type ResendVerificationCodeParams = VerificationEmailProps & {
+    userId: string;
+    type?: 'EMAIL' | 'PHONE';
+    linkedAccountId?: string;
+};

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",
@@ -14,7 +14,8 @@ export declare enum OnRampAsset {
     CELO = "CELO",
     CUSD = "CUSD",
     CEUR = "CEUR",
-    CREAL = "CREAL"
+    CREAL = "CREAL",
+    BERA = "BERA"
 }
 export declare enum OnRampPurchaseStatus {
     INITIATED = "INITIATED",
@@ -30,7 +31,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 +52,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,4 +1,4 @@
-import { AuthMethod } from './auth.js';
+import { AuthMethod, SupportedAccountLinks } from './auth.js';
 import { SupportedWalletTypes } from './wallet.js';
 export interface PartnerEntity {
     id: string;
@@ -16,5 +16,6 @@ export interface PartnerEntity {
     portalUrl?: string;
     supportedAuthMethods?: AuthMethod[];
     supportedWalletTypes?: SupportedWalletTypes;
+    supportedAccountLinks?: SupportedAccountLinks;
     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",
@@ -24,16 +30,18 @@ export declare enum Network {
     SOLANA = "SOLANA",
     COSMOS = "COSMOS",
     CELO = "CELO",
-    NOBLE = "NOBLE"
+    NOBLE = "NOBLE",
+    SOLANA_DEVNET = "SOLANA_DEVNET",
+    BERACHAIN = "BERACHAIN"
 }
 export type WalletRef = 'walletId' | 'externalWalletAddress';
 export type WalletParams = Partial<{
     walletId?: string;
     externalWalletAddress?: string;
 }>;
-export type EmbeddedWalletType = Exclude<WalletType, never>;
-export type ExternalWalletType = Exclude<WalletType, never>;
-export declare const PREGEN_IDENTIFIER_TYPES: readonly ["EMAIL", "PHONE", "CUSTOM_ID", "DISCORD", "TWITTER", "TELEGRAM", "FARCASTER"];
+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 {
@@ -49,16 +57,23 @@ export interface WalletEntity {
     partner?: PartnerEntity;
     publicKey: string | null;
     scheme: string;
-    type: WalletType;
+    type: TWalletType;
     updatedAt: string;
     userId: string | null;
     lastUsedAt: string | null;
     lastUsedPartnerId?: string;
     lastUsedPartner?: PartnerEntity;
+    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: WalletType;
+    type: TWalletType;
     optional?: boolean;
 }[];
+export declare const EVM_WALLETS: readonly ["METAMASK", "RAINBOW", "COINBASE", "WALLETCONNECT", "FARCASTER", "ZERION", "SAFE", "RABBY", "OKX", "HAHA", "BACKPACK", "PHANTOM", "VALORA"];
+export declare const SOLANA_WALLETS: readonly ["PHANTOM", "GLOW", "BACKPACK", "SOLFLARE"];
+export declare const COSMOS_WALLETS: readonly ["KEPLR", "LEAP", "COSMOSTATION"];
+export declare const EXTERNAL_WALLET_TYPES: readonly ("FARCASTER" | "METAMASK" | "RAINBOW" | "COINBASE" | "WALLETCONNECT" | "ZERION" | "SAFE" | "RABBY" | "OKX" | "HAHA" | "BACKPACK" | "PHANTOM" | "VALORA" | "GLOW" | "SOLFLARE" | "KEPLR" | "LEAP" | "COSMOSTATION")[];
+export type TExternalWallet = (typeof EXTERNAL_WALLET_TYPES)[number];

package/dist/types/utils.d.ts

@@ -1,5 +1,5 @@
 import { Auth, AuthInfo, AuthParams, PrimaryAuth, PrimaryAuthInfo, VerifiedAuth, WalletParams, WalletRef } from './types/index.js';
-import { PregenAuth, PregenAuthInfo } from './types/auth.js';
+import { AccountMetadata, AccountMetadataKey, LinkedAccounts, PregenAuth, PregenAuthInfo, PregenOrGuestAuth } from './types/auth.js';
 import { PregenIds, TPregenIdentifierType } from './types/wallet.js';
 export declare function isWalletId(params: WalletParams): params is {
     walletId: string;
@@ -17,6 +17,7 @@ export declare function isExternalWallet(params: AuthParams | undefined): params
 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;
@@ -48,6 +49,11 @@ export declare function extractAuthInfo(obj: AuthParams, opts: ExtractAuthOpts &
     allowPregen: true;
     isRequired: true;
 }): PregenAuthInfo;
-export declare function toPregenTypeAndId(auth: PregenAuth): [TPregenIdentifierType, string];
+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 declare function fromLinkedAccounts({ primary, linked }: LinkedAccounts<string>): LinkedAccounts<Date>;
 export {};

package/package.json

@@ -1,31 +1,13 @@
 {
   "name": "@getpara/user-management-client",
-  "version": "2.0.0-alpha.3",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "types": "dist/types/index.d.ts",
-  "typings": "dist/types/index.d.ts",
-  "sideEffects": false,
-  "scripts": {
-    "build": "rm -rf dist && node ./scripts/build.mjs && yarn build:types",
-    "old-build": "yarn build:cjs && yarn build:esm && yarn build:types",
-    "build:cjs": "rm -rf dist/cjs && tsc --module commonjs --outDir dist/cjs && printf '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
-    "build:esm": "rm -rf dist/esm && tsc --module es6 --outDir dist/esm && printf '{\"type\":\"module\",\"sideEffects\":false}' > dist/esm/package.json",
-    "build:types": "rm -rf dist/types && tsc --module es6 --declarationDir dist/types --emitDeclarationOnly --declaration",
-    "test": "vitest run --coverage"
-  },
+  "version": "2.0.0-alpha.30",
   "dependencies": {
-    "axios": "^1.6.3",
-    "libphonenumber-js": "1.11.2",
-    "qs": "^6.12.0"
+    "axios": "^1.8.4",
+    "libphonenumber-js": "^1.11.7"
   },
   "devDependencies": {
-    "typescript": "^5.0.4"
+    "typescript": "^5.8.3"
   },
-  "files": [
-    "dist",
-    "package.json"
-  ],
   "exports": {
     ".": {
       "types": "./dist/types/index.d.ts",
@@ -33,5 +15,22 @@
       "require": "./dist/cjs/index.js"
     }
   },
-  "gitHead": "77a1e04b06258842ca9c81e3db2a2b0092517659"
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "gitHead": "8b06219b9c248a3fbdbd05dc7501e8042c369301",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "scripts": {
+    "build": "rm -rf dist && node ./scripts/build.mjs && yarn build:types",
+    "build:cjs": "rm -rf dist/cjs && tsc --module commonjs --outDir dist/cjs && printf '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
+    "build:esm": "rm -rf dist/esm && tsc --module es6 --outDir dist/esm && printf '{\"type\":\"module\",\"sideEffects\":false}' > dist/esm/package.json",
+    "build:types": "rm -rf dist/types && tsc --module es6 --declarationDir dist/types --emitDeclarationOnly --declaration",
+    "old-build": "yarn build:cjs && yarn build:esm && yarn build:types",
+    "test": "vitest run --coverage"
+  },
+  "sideEffects": false,
+  "types": "dist/types/index.d.ts",
+  "typings": "dist/types/index.d.ts"
 }