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

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"];
+export type AuthType = 'email' | 'phone' | 'phoneLegacy' | 'farcaster' | 'telegram' | 'userId' | 'externalWallet' | 'discord' | 'x' | 'customId';
+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,46 @@ 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'>;
 } : {
-    userId: string;
+    userId: AuthIdentifier<'userId'>;
+};
+export type PrimaryAuth = Auth<PrimaryAuthType>;
+export type VerifiedAuth = Auth<VerifiedAuthType>;
+export type PregenAuth = Auth<PregenAuthType>;
+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",
@@ -87,8 +123,80 @@ export type TelegramAuthResponse = {
     photo_url?: string;
     username?: string;
 };
-export type AccountMetadataKey = Lowercase<Exclude<OAuthMethod, OAuthMethod.TWITTER> | 'X'>;
-export type AccountMetadata = Partial<Record<AccountMetadataKey, {
-    date: Date;
-    metadata: Record<string, any>;
-}>>;
+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;
+};
+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;
+};

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,4 +1,3 @@
-import { OAuthMethod } from './auth.js';
 import { PartnerEntity } from './partner.js';
 export declare enum WalletScheme {
     DKLS = "DKLS",
@@ -32,7 +31,9 @@ export type WalletParams = Partial<{
     walletId?: string;
     externalWalletAddress?: string;
 }>;
-export declare const PREGEN_IDENTIFIER_TYPES: readonly ["EMAIL", "PHONE", "CUSTOM_ID", OAuthMethod.DISCORD, OAuthMethod.TWITTER, OAuthMethod.TELEGRAM];
+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 TPregenIdentifierType = (typeof PREGEN_IDENTIFIER_TYPES)[number];
 export type PregenIds = Partial<Record<TPregenIdentifierType, string[]>>;
 export interface WalletEntity {
@@ -54,8 +55,10 @@ export interface WalletEntity {
     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 SupportedWalletTypes = {
+    type: WalletType;
+    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 { PregenAuth, PregenAuthInfo } from './types/auth.js';
+import { PregenIds, TPregenIdentifierType } from './types/wallet.js';
 export declare function isWalletId(params: WalletParams): params is {
     walletId: string;
 };
@@ -6,18 +8,46 @@ 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 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: PregenAuth): [TPregenIdentifierType, string];
+export declare function toPregenIds(auth: PregenAuth): PregenIds;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getpara/user-management-client",
-  "version": "1.7.1",
+  "version": "2.0.0-alpha.3",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -33,5 +33,5 @@
       "require": "./dist/cjs/index.js"
     }
   },
-  "gitHead": "767395af96d4a724946a092de760e9137a73369a"
+  "gitHead": "77a1e04b06258842ca9c81e3db2a2b0092517659"
 }

package/dist/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/dist/esm/package.json

@@ -1,4 +0,0 @@
-{
-  "type": "module",
-  "sideEffects": false
-}