@getpara/core-sdk 1.12.0 → 2.0.0-alpha.5

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

@@ -0,0 +1,148 @@
+import { PrimaryAuthInfo, ServerAuthStateLogin, ServerAuthStateSignup, AuthMethod, ServerAuthStateVerify, VerifiedAuth, AuthExtras, TOAuthMethod, TWalletType } from '@getpara/user-management-client';
+import { Theme } from './theme.js';
+import { RecoveryStatus } from './recovery.js';
+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';
+export type PortalUrlOptions = {
+    params?: Record<string, string | undefined | null>;
+    isForNewDevice?: boolean;
+    thisDevice?: Device;
+    newDevice?: Device;
+    sessionId?: string;
+    portalTheme?: Theme;
+    pathId?: string;
+    shorten?: boolean;
+};
+export type WithAuthMethod = {
+    /**
+     * Which authorization method to use for the URL, either `'passkey'` or `'passwprd'`.
+     */
+    authMethod?: Uppercase<AuthMethod>;
+};
+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 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 LoginUrlParams = WithAuthMethod & WithCustomTheme & WithShorten & {
+    sessionId?: string;
+};
+export type NewCredentialUrlParams = WithAuthMethod & WithCustomTheme & WithShorten & {
+    /**
+     * Whether the URL is meant to add a passkey for a previous user on a new device. Defaults to `false`.
+     */
+    isForNewDevice?: boolean;
+};
+export type OAuthUrlParams = {
+    /**
+     * The third-party OAuth service.
+     */
+    method: Exclude<TOAuthMethod, 'TELEGRAM' | 'FARCASTER'>;
+    /**
+     * The deeplink URL to redirect to after OAuth is complete.
+     */
+    deeplinkUrl?: string;
+};
+export type AuthStateBaseParams = WithCustomTheme & WithUseShortUrls;
+export type AuthStateVerify = ServerAuthStateVerify;
+export type AuthStateLogin = Omit<ServerAuthStateLogin, 'loginAuthMethods'> & {
+    /**
+     * 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;
+};
+export type AuthStateSignup = Omit<ServerAuthStateSignup, 'signupAuthMethods'> & {
+    /**
+     * A Para Portal URL for creating a new WebAuth passkey.
+     */
+    passkeyUrl?: string;
+    /**
+     * A Para Portal URL for creating a new user password.
+     */
+    passwordUrl?: string;
+    /**
+     * The Para system ID for the newly generated passkey.
+     */
+    passkeyId?: string;
+    /**
+     * The Para system ID for the newly generated password.
+     */
+    passwordId?: string;
+};
+export type AuthStateVerifyOrLogin = AuthStateVerify | AuthStateLogin;
+export type AuthStateSignupOrLogin = AuthStateSignup | AuthStateLogin;
+export type OAuthResponse = AuthStateSignupOrLogin;
+export type AuthState = AuthStateVerify | AuthStateLogin | AuthStateSignup;
+export type Verify2faParams = {
+    auth: VerifiedAuth;
+    verificationCode: string;
+};
+export type Verify2faResponse = {
+    /**
+     * When the 2FA verification code was sent.
+     */
+    initiatedAt?: Date;
+    /**
+     * The status for the 2FA process.
+     */
+    status?: RecoveryStatus;
+    /**
+     * The matched user ID.
+     */
+    userId: string;
+    /**
+     * The wallets protected by this 2FA instance.
+     */
+    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/onRamps.d.ts

@@ -1,7 +1,7 @@
-import { Network, OnRampAsset, OnRampProvider, OnRampPurchaseType, WalletType } from '@getpara/user-management-client';
+import { Network, OnRampAsset, OnRampProvider, OnRampPurchaseType, TWalletType } from '@getpara/user-management-client';
 export type ProviderAssetInfo = [string, Partial<Record<OnRampPurchaseType, boolean>>];
-export type OnRampAssetInfo = Record<WalletType, Partial<Record<Network, Partial<Record<OnRampAsset, Partial<Record<OnRampProvider, ProviderAssetInfo>>>>>>>;
-export type OnRampAssetInfoRow = [WalletType, Network, OnRampAsset, Partial<Record<OnRampProvider, ProviderAssetInfo>>];
+export type OnRampAssetInfo = Record<TWalletType, Partial<Record<Network, Partial<Record<OnRampAsset, Partial<Record<OnRampProvider, ProviderAssetInfo>>>>>>>;
+export type OnRampAssetInfoRow = [TWalletType, Network, OnRampAsset, Partial<Record<OnRampProvider, ProviderAssetInfo>>];
 export declare enum OnRampMethod {
     ACH = "ACH",
     DEBIT = "Debit",

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

@@ -1,5 +1,4 @@
-import { PartnerEntity, TPregenIdentifierType, WalletScheme } from '@getpara/user-management-client';
-import { EmbeddedWalletType, ExternalWalletType } from './params.js';
+import { EmbeddedWalletType, ExternalWalletType, PartnerEntity, TPregenIdentifierType, TWalletScheme } from '@getpara/user-management-client';
 export interface Wallet {
     createdAt?: string;
     id: string;
@@ -8,7 +7,7 @@ export interface Wallet {
     address?: string;
     addressSecondary?: string;
     publicKey?: string;
-    scheme?: WalletScheme;
+    scheme?: TWalletScheme;
     type?: EmbeddedWalletType | ExternalWalletType;
     isPregen?: boolean;
     pregenIdentifier?: string;
@@ -20,9 +19,9 @@ export interface Wallet {
     lastUsedPartner?: PartnerEntity;
     lastUsedPartnerId?: string;
     isExternal?: boolean;
+    isExternalWithParaAuth?: boolean;
     ensName?: string | null;
     ensAvatar?: string | null;
-    isExternalWithParaAuth?: boolean;
 }
 /** @deprecated */
 export declare enum PregenIdentifierType {
@@ -40,3 +39,4 @@ export interface DeniedSignatureResWithUrl extends DeniedSignatureRes {
 }
 export type SignatureRes = SuccessfulSignatureRes | DeniedSignatureRes;
 export type FullSignatureRes = SuccessfulSignatureRes | DeniedSignatureResWithUrl;
+export type ExternalWalletConnectionType = 'NONE' | 'CONNECTION_ONLY' | 'AUTHENTICATED';

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

@@ -0,0 +1 @@
+export declare function autoBind(instance: any): void;

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

@@ -1,4 +1,4 @@
-import { WalletTypeProp } from '../types/index.js';
+import { TWalletType } from '@getpara/user-management-client';
 export type Hex = `0x${string}`;
 export interface Signature {
     r: Hex;
@@ -11,9 +11,7 @@ export declare function hexToUint8Array(hex: string): Uint8Array;
 export declare function hexToDecimal(hex: string): string;
 export declare function decimalToHex(decimal: string): Hex;
 export declare function getCosmosAddress(publicKey: string, prefix: string): string;
-export declare function truncateAddress(str: string, addressType: WalletTypeProp, { prefix, targetLength, }?: {
+export declare function truncateAddress(str: string, addressType: TWalletType, { prefix, targetLength, }?: {
     prefix?: string;
     targetLength?: number;
 }): string;
-export declare function stringToPhoneNumber(str: string): string;
-export declare function normalizePhoneNumber(countryCode: string, number: string): string | undefined;

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

@@ -1,6 +1,11 @@
+export * from './autobind.js';
 export * from './events.js';
 export * from './formatting.js';
+export * from './json.js';
+export * from './listeners.js';
 export * from './onRamps.js';
+export * from './phone.js';
 export * from './polling.js';
+export * from './types.js';
 export * from './url.js';
 export * from './wallet.js';

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

@@ -0,0 +1 @@
+export declare function jsonParse<T = any>(data: string | null | undefined, validate?: (res: any) => res is T): T | undefined;

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

@@ -1,15 +1,15 @@
-import { Network, OnRampAsset, OnRampProvider, OnRampPurchaseType, WalletType } from '@getpara/user-management-client';
+import { Network, OnRampAsset, OnRampProvider, OnRampPurchaseType, TWalletType } from '@getpara/user-management-client';
 import { OnRampAssetInfoRow, OnRampAssetInfo } from '../types/index.js';
 export declare function toAssetInfoArray(data: OnRampAssetInfo): OnRampAssetInfoRow[];
 export declare function getOnRampNetworks(data: OnRampAssetInfo, { walletType, allowed, assets, providers, action, }?: {
-    walletType?: WalletType;
+    walletType?: TWalletType;
     allowed?: Network[];
     assets?: OnRampAsset[];
     providers?: OnRampProvider[];
     action?: OnRampPurchaseType;
 }): Network[];
 export declare function getOnRampAssets(data: OnRampAssetInfo, { walletType, network, allowed, providers, action, }?: {
-    walletType?: WalletType;
+    walletType?: TWalletType;
     network?: Network;
     allowed?: OnRampAsset[];
     providers?: OnRampProvider[];

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

@@ -0,0 +1,7 @@
+export declare function formatPhoneNumber(phone: string, countryCode?: string | undefined, opts?: {
+    forDisplay: undefined | false;
+}): `+${number}` | null;
+export declare function formatPhoneNumber(phone: string, countryCode: string | undefined, opts: {
+    forDisplay: true;
+}): string | null;
+export declare function displayPhoneNumber(phone: string, countryCode?: string): string;

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

@@ -0,0 +1,2 @@
+import { ServerAuthState } from '@getpara/user-management-client';
+export declare function isServerAuthState(obj: ServerAuthState | Record<string, never>): obj is ServerAuthState;

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

@@ -1,4 +1,4 @@
-import { Environment } from '../types/index.js';
+import { Ctx, Environment } from '../types/index.js';
 export declare function getPortalDomain(env: Environment, isE2E?: boolean): "localhost" | "app.sandbox.usecapsule.com" | "app.beta.usecapsule.com" | "app.usecapsule.com";
 export declare function getPortalBaseURL({ env, isE2E }: {
     env: Environment;
@@ -13,3 +13,4 @@ export declare function constructUrl({ base, path, params, }: {
     path: string;
     params?: Record<string, string | undefined | null>;
 }): string;
+export declare function shortenUrl(ctx: Ctx, url: string): Promise<string>;

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

@@ -1,11 +1,13 @@
-import { TPregenIdentifierType, WalletEntity, WalletScheme, WalletType } from '@getpara/user-management-client';
-import { SupportedWalletTypes, Wallet, WalletTypeProp } from '../types/index.js';
-export declare const WalletSchemeTypeMap: Record<WalletScheme, Partial<Record<WalletType, true>>>;
+import { CurrentWalletIds, SupportedWalletTypes, TPregenIdentifierType, WalletEntity, TWalletScheme, TWalletType } from '@getpara/user-management-client';
+import { Wallet } from '../types/index.js';
+export declare const WalletSchemeTypeMap: Record<TWalletScheme, Partial<Record<TWalletType, true>>>;
 export declare function isPregenIdentifierMatch(a: string | null | undefined, b: string | null | undefined, type: TPregenIdentifierType): boolean;
-export declare function isWalletSupported(types: WalletType[], wallet: Omit<Wallet, 'signer'>): boolean;
-export declare function getSchemes(types: WalletTypeProp[] | SupportedWalletTypes): WalletScheme[];
-export declare function getWalletTypes(schemes: WalletScheme[]): WalletType[];
-export declare function getEquivalentTypes(types: WalletTypeProp[] | WalletTypeProp): WalletType[];
+export declare function isWalletSupported(types: TWalletType[], wallet: Omit<Wallet, 'signer'>): boolean;
+export declare function getSchemes(types: TWalletType[] | SupportedWalletTypes): TWalletScheme[];
+export declare function getWalletTypes(schemes: TWalletScheme[]): TWalletType[];
+export declare function getEquivalentTypes(types: TWalletType[] | TWalletType): TWalletType[];
 export declare function entityToWallet(w: WalletEntity): Omit<Wallet, 'signer'>;
 export declare function migrateWallet(obj: Record<string, unknown>): Wallet;
+export declare function supportedWalletTypesEq(a: SupportedWalletTypes, b: SupportedWalletTypes): boolean;
+export declare function mergeCurrentWalletIds(original: CurrentWalletIds, additional: CurrentWalletIds): CurrentWalletIds;
 export declare function newUuid(): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getpara/core-sdk",
-  "version": "1.12.0",
+  "version": "2.0.0-alpha.5",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -10,7 +10,7 @@
     "@celo/utils": "^8.0.2",
     "@cosmjs/encoding": "^0.32.4",
     "@ethereumjs/util": "^9.1.0",
-    "@getpara/user-management-client": "1.12.0",
+    "@getpara/user-management-client": "2.0.0-alpha.5",
     "@noble/hashes": "^1.5.0",
     "base64url": "^3.0.1",
     "libphonenumber-js": "1.11.2",
@@ -27,6 +27,7 @@
     "test": "vitest run --coverage"
   },
   "devDependencies": {
+    "@faker-js/faker": "^9.5.1",
     "typescript": "5.1.6"
   },
   "files": [
@@ -40,5 +41,5 @@
       "require": "./dist/cjs/index.js"
     }
   },
-  "gitHead": "748afcf08c9d307a2d3eaf0716f73132f3eb8529"
+  "gitHead": "3ecfca088f24489f2e8fa5493d0f4459b08880e1"
 }

package/dist/types/types/params.d.ts

@@ -1,73 +0,0 @@
-import { AuthType, WalletType } from '@getpara/user-management-client';
-import { Theme } from './theme.js';
-export type EmbeddedWalletType = Exclude<WalletType, never>;
-export type ExternalWalletType = Exclude<WalletType, never>;
-export type ExternalWalletInfo = {
-    address: string;
-    type: ExternalWalletType;
-    provider?: string;
-    addressBech32?: string;
-    ensName?: string | null;
-    ensAvatar?: string | null;
-    withFullParaAuth?: boolean;
-};
-export type VerifyExternalWallet = {
-    signedMessage: string;
-    cosmosPublicKeyHex?: string;
-    cosmosSigner?: string;
-};
-export type PortalUrlOptions = {
-    params?: Record<string, string | undefined | null>;
-    authType?: AuthType;
-    isForNewDevice?: boolean;
-    loginEncryptionPublicKey?: string;
-    newDeviceSessionId?: string;
-    newDeviceEncryptionKey?: string;
-    partnerId?: string;
-    sessionId?: string;
-    theme?: Theme;
-    pathId?: string;
-    displayName?: string;
-    pfpUrl?: string;
-};
-export type GetWebAuthUrlForLoginParams = {
-    /**
-     * The session ID for the URL.
-     */
-    sessionId: string;
-    /**
-     * Either 'email' | 'phone' | 'farcaster' | 'telegram'
-     */
-    authType?: AuthType;
-    /**
-     * The public key to use for encrypting the login encryption key.
-     */
-    loginEncryptionPublicKey: string;
-    /**
-     * The partner ID for the URL.
-     */
-    partnerId?: string;
-    /**
-     * The session ID for the new device being registered.
-     */
-    newDeviceSessionId?: string;
-    /**
-     * The public key for the new device being registered.
-     */
-    newDeviceEncryptionKey?: string;
-    /**
-     * The Telegram or Farcaster display name for the user.
-     */
-    displayName?: string;
-    /**
-     * The Telegram or Farcaster URL for the user's profile picture.
-     */
-    pfpUrl?: string;
-};
-export type GetWalletBalanceParams = {
-    walletId: string;
-    rpcUrl?: string;
-};
-export type CreateGuestWalletsParams = {
-    types?: WalletType[];
-};