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

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

@@ -1,24 +1,48 @@
-import { BackupKitEmailProps, CurrentWalletIds, ExternalWalletInfo, OnRampPurchase, OnRampPurchaseCreateParams, PregenAuth, Setup2faResponse, TelegramAuthResponse, VerifiedAuth, VerifyExternalWalletParams, WalletEntity, WalletParams, TWalletType } from '@getpara/user-management-client';
-import { AuthStateLogin, AuthStateVerify, OAuthResponse, AuthStateBaseParams, WithCustomTheme, WithUseShortUrls, Verify2faResponse, AuthStateSignup, AuthStateVerifyOrLogin, OAuthUrlParams, StorageType, PollParams, CoreAuthInfo, GetWalletBalanceParams, GetWalletBalanceResponse } from './methods.js';
+import { BackupKitEmailProps, CurrentWalletIds, ExternalWalletInfo, OnRampPurchase, OnRampPurchaseCreateParams, PregenAuth, Setup2faResponse, VerifiedAuth, VerifyExternalWalletParams, WalletEntity, WalletParams, TWalletType, IssueJwtParams, IssueJwtResponse, TLinkedAccountType, LinkedAccounts } from '@getpara/user-management-client';
+import { AuthStateLogin, AuthStateVerify, OAuthResponse, AuthStateBaseParams, WithCustomTheme, WithUseShortUrls, Verify2faResponse, AuthStateSignup, AuthStateVerifyOrLogin, OAuthUrlParams, StorageType, PollParams, CoreAuthInfo, GetWalletBalanceParams, GetWalletBalanceResponse, FarcasterParams, TelegramParams, OAuthParams } from './methods.js';
 import { ParaCore } from '../ParaCore.js';
 import { FullSignatureRes, Wallet } from './wallet.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"];
+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"];
+export declare const PARA_INTERNAL_METHODS: readonly ["linkAccount", "unlinkAccount", "verifyEmailOrPhoneLink", "verifyOAuthLink", "verifyFarcasterLink", "verifyTelegramLink", "verifyExternalWalletLink", "accountLinkInProgress", "prepareLogin", "sendLoginCode"];
 export type CoreMethodName = (typeof PARA_CORE_METHODS)[number];
 export type CoreMethodParams<method extends CoreMethodName & keyof CoreMethods> = CoreMethods[method] extends {
     params: infer P;
 } ? P : never;
+export type CoreMethodIsGetter<method extends CoreMethodName & keyof CoreMethods> = CoreMethods[method] extends {
+    isGetter: true;
+} ? true : false;
 export type CoreMethodResponse<method extends CoreMethodName & keyof CoreMethods> = CoreMethods[method] extends {
     response: infer R;
 } ? CoreMethods[method] extends {
     sync: true;
 } ? R : Promise<R> : void;
-export type CoreMethod<method extends CoreMethodName & keyof CoreMethods> = CoreMethodParams<method> extends void | never ? () => CoreMethodResponse<method> : (_?: CoreMethodParams<method>) => CoreMethodResponse<method>;
+export type CoreMethod<method extends CoreMethodName & keyof CoreMethods> = CoreMethodIsGetter<method> extends true ? Awaited<CoreMethodResponse<method>> : CoreMethodParams<method> extends void | never ? () => CoreMethodResponse<method> : (_?: CoreMethodParams<method>) => CoreMethodResponse<method>;
 export type CoreAction<method extends CoreMethodName & keyof CoreMethods> = CoreMethodParams<method> extends void | never ? (_?: ParaCore) => CoreMethodResponse<method> : (_?: ParaCore, __?: CoreMethodParams<method>) => CoreMethodResponse<method>;
+export type InternalMethodName = (typeof PARA_INTERNAL_METHODS)[number];
+export type InternalMethodParams<method extends InternalMethodName & keyof InternalMethods> = InternalMethods[method] extends {
+    params: infer P;
+} ? P : never;
+export type InternalMethodIsGetter<method extends InternalMethodName & keyof InternalMethods> = InternalMethods[method] extends {
+    isGetter: true;
+} ? true : false;
+export type InternalMethodResponse<method extends InternalMethodName & keyof InternalMethods> = InternalMethods[method] extends {
+    response: infer R;
+} ? InternalMethods[method] extends {
+    sync: true;
+} ? 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 CoreMethods = Record<CoreMethodName, {
     params?: unknown;
     response?: unknown;
     sync?: true;
 }> & {
+    accountLinkInProgress: {
+        params: never;
+        response: AccountLinkInProgress;
+        isGetter: true;
+    };
     getAuthInfo: {
         params: void;
         response: CoreAuthInfo | undefined;
@@ -98,17 +122,7 @@ export type CoreMethods = Record<CoreMethodName, {
         response: string;
     };
     verifyOAuth: {
-        params: AuthStateBaseParams & OAuthUrlParams & PollParams & {
-            /**
-             * A function returning a boolean, indicating whether the OAuth process should be cancelled.
-             */
-            isCanceled?: () => boolean;
-            /**
-             * A callback function that will be invoked with the OAuth URL when it is available.
-             * For example, you can use this to open the URL in a new window or tab.
-             */
-            onOAuthUrl?: (url: string) => void;
-        };
+        params: AuthStateBaseParams & OAuthParams;
         response: OAuthResponse;
     };
     getFarcasterConnectUri: {
@@ -116,26 +130,11 @@ export type CoreMethods = Record<CoreMethodName, {
         response: string;
     };
     verifyFarcaster: {
-        params: AuthStateBaseParams & PollParams & {
-            /**
-             * A function returning a boolean, indicating whether the Farcaster login process should be cancelled.
-             */
-            isCanceled?: () => boolean;
-            /**
-             * A callback function that will be invoked with the Farcaster Connect URI when it is available.
-             * You will need to display the URI as a QR code.
-             */
-            onConnectUri?: (uri: string) => void;
-        };
+        params: AuthStateBaseParams & FarcasterParams;
         response: OAuthResponse;
     };
     verifyTelegram: {
-        params: AuthStateBaseParams & {
-            /**
-             * The response received from the Telegram login bot.
-             */
-            telegramAuthResponse: TelegramAuthResponse;
-        };
+        params: AuthStateBaseParams & TelegramParams;
         response: OAuthResponse;
     };
     loginExternalWallet: {
@@ -143,16 +142,18 @@ export type CoreMethods = Record<CoreMethodName, {
             /**
              * The external wallet information to use for login.
              */
-            externalWallet: ExternalWalletInfo;
+            externalWallet: ExternalWalletInfo | ExternalWalletInfo[];
         };
         response: AuthStateVerifyOrLogin;
     };
     verifyExternalWallet: {
         params: AuthStateBaseParams & VerifyExternalWalletParams;
-        response: AuthStateSignup;
+        response: AuthStateSignup | AuthStateLogin;
     };
     resendVerificationCode: {
-        params: void;
+        params: {
+            type?: 'SIGNUP' | 'LINK_ACCOUNT' | 'LOGIN';
+        } | undefined;
         response: void;
     };
     logout: {
@@ -469,7 +470,70 @@ export type CoreMethods = Record<CoreMethodName, {
         params: GetWalletBalanceParams;
         response: GetWalletBalanceResponse;
     };
+    issueJwt: {
+        params: IssueJwtParams;
+        response: IssueJwtResponse;
+    };
+    getLinkedAccounts: {
+        params: {
+            withMetadata?: boolean;
+        };
+        response: LinkedAccounts & {
+            userId: string;
+        };
+    };
+};
+export type InternalMethods = {
+    linkAccount: {
+        params: {
+            auth: VerifiedAuth;
+        } | {
+            externalWallet: ExternalWalletInfo;
+        } | {
+            type: TLinkedAccountType | 'X';
+        };
+        response: AccountLinkInProgress;
+    };
+    unlinkAccount: {
+        params: {
+            linkedAccountId: string;
+        };
+        response: LinkedAccounts;
+    };
+    verifyEmailOrPhoneLink: {
+        params: {
+            verificationCode?: string;
+        };
+        response: LinkedAccounts;
+    };
+    verifyOAuthLink: {
+        params: OAuthParams;
+        response: LinkedAccounts;
+    };
+    verifyFarcasterLink: {
+        params: FarcasterParams;
+        response: LinkedAccounts;
+    };
+    verifyTelegramLink: {
+        params: TelegramParams;
+        response: LinkedAccounts;
+    };
+    verifyExternalWalletLink: {
+        params: Omit<VerifyExternalWalletParams, 'externalWallet'>;
+        response: LinkedAccounts;
+    };
+    prepareLogin: {
+        params: void;
+        response: string;
+    };
+    sendLoginCode: {
+        params: void;
+        response: void;
+    };
 };
 export type CoreInterface = {
-    [key in keyof CoreMethods]: CoreMethod<key>;
+    [key in keyof CoreMethods]: Partial<CoreMethod<key>>;
+};
+export type InternalInterface = {
+    [key in keyof InternalMethods]: Partial<InternalMethod<key>>;
 };

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

@@ -1,3 +1,4 @@
+export * from './auth.js';
 export * from './config.js';
 export * from './coreApi.js';
 export * from './wallet.js';

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

@@ -1,4 +1,4 @@
-import { PrimaryAuthInfo, ServerAuthStateLogin, ServerAuthStateSignup, AuthMethod, ServerAuthStateVerify, VerifiedAuth, AuthExtras, TOAuthMethod, TWalletType } from '@getpara/user-management-client';
+import { PrimaryAuthInfo, ServerAuthStateLogin, ServerAuthStateSignup, AuthMethod, ServerAuthStateVerify, VerifiedAuth, AuthExtras, TOAuthMethod, TWalletType, TelegramAuthResponse } from '@getpara/user-management-client';
 import { Theme } from './theme.js';
 import { RecoveryStatus } from './recovery.js';
 import { Wallet } from './wallet.js';
@@ -14,7 +14,7 @@ export type VerifyExternalWalletV1 = {
     cosmosPublicKeyHex?: string;
     cosmosSigner?: string;
 };
-export type PortalUrlType = 'createAuth' | 'createPassword' | 'loginAuth' | 'loginPassword' | 'txReview' | 'onRamp';
+export type PortalUrlType = 'createAuth' | 'createPassword' | 'loginAuth' | 'loginPassword' | 'txReview' | 'onRamp' | 'telegramLogin' | 'createPIN' | 'loginPIN';
 export type PortalUrlOptions = {
     params?: Record<string, string | undefined | null>;
     isForNewDevice?: boolean;
@@ -24,10 +24,11 @@ export type PortalUrlOptions = {
     portalTheme?: Theme;
     pathId?: string;
     shorten?: boolean;
+    isEmbedded?: boolean;
 };
 export type WithAuthMethod = {
     /**
-     * Which authorization method to use for the URL, either `'passkey'` or `'passwprd'`.
+     * Which authorization method to use for the URL, either `'passkey'` or `'password'`.
      */
     authMethod?: Uppercase<AuthMethod>;
 };
@@ -49,6 +50,12 @@ export type WithShorten = {
      */
     shorten?: boolean;
 };
+export type WithIsPasskeySupported = {
+    /**
+     * Whether the current device supports WebAuth passkeys.
+     */
+    isPasskeySupported: boolean;
+};
 export type PollParams = {
     /**
      * A callback function that will be invoked on each method poll.
@@ -59,6 +66,23 @@ export type PollParams = {
      */
     onCancel?: () => void;
 };
+export type FarcasterParams = PollParams & {
+    /**
+     * A function returning a boolean, indicating whether the Farcaster login process should be cancelled.
+     */
+    isCanceled?: () => boolean;
+    /**
+     * A callback function that will be invoked with the Farcaster Connect URI when it is available.
+     * You will need to display the URI as a QR code.
+     */
+    onConnectUri?: (uri: string) => void;
+};
+export type TelegramParams = {
+    /**
+     * The response received from the Telegram login bot.
+     */
+    telegramAuthResponse: TelegramAuthResponse;
+};
 export type LoginUrlParams = WithAuthMethod & WithCustomTheme & WithShorten & {
     sessionId?: string;
 };
@@ -74,13 +98,33 @@ export type OAuthUrlParams = {
      */
     method: Exclude<TOAuthMethod, 'TELEGRAM' | 'FARCASTER'>;
     /**
-     * The deeplink URL to redirect to after OAuth is complete.
+     * The app scheme to redirect to after OAuth is complete.
+     */
+    appScheme?: string;
+};
+export type OAuthParams = OAuthUrlParams & PollParams & {
+    /**
+     * A function returning a boolean, indicating whether the OAuth process should be cancelled.
+     */
+    isCanceled?: () => boolean;
+    /**
+     * A callback function that will be invoked with the OAuth URL when it is available.
+     * For example, you can use this to open the URL in a new window or tab.
+     *
+     * You should pass one of `onOAuthUrl` or `onOAuthPopup`, not both.
+     */
+    onOAuthUrl?: (url: string) => void;
+    /**
+     * A callback function that will be invoked with the OAuth popup window when it is available.
+     * If supplied, a window will automatically be opened for you if running on an applicable platform.
+     *
+     * You should pass one of `onOAuthUrl` or `onOAuthPopup`, not both.
      */
-    deeplinkUrl?: string;
+    onOAuthPopup?: (popup: Window) => void;
 };
 export type AuthStateBaseParams = WithCustomTheme & WithUseShortUrls;
 export type AuthStateVerify = ServerAuthStateVerify;
-export type AuthStateLogin = Omit<ServerAuthStateLogin, 'loginAuthMethods'> & {
+export type AuthStateLogin = Omit<ServerAuthStateLogin, 'loginAuthMethods'> & WithIsPasskeySupported & {
     /**
      * 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.
      */
@@ -93,8 +137,12 @@ export type AuthStateLogin = Omit<ServerAuthStateLogin, 'loginAuthMethods'> & {
      * A Para Portal URL for logging in via a password.
      */
     passwordUrl?: string;
+    /**
+     * A Para Portal URL for logging in via a PIN.
+     */
+    pinUrl?: string;
 };
-export type AuthStateSignup = Omit<ServerAuthStateSignup, 'signupAuthMethods'> & {
+export type AuthStateSignup = Omit<ServerAuthStateSignup, 'signupAuthMethods'> & WithIsPasskeySupported & {
     /**
      * A Para Portal URL for creating a new WebAuth passkey.
      */
@@ -103,6 +151,10 @@ export type AuthStateSignup = Omit<ServerAuthStateSignup, 'signupAuthMethods'> &
      * A Para Portal URL for creating a new user password.
      */
     passwordUrl?: string;
+    /**
+     * A Para Portal URL for creating a new user PIN.
+     */
+    pinUrl?: string;
     /**
      * The Para system ID for the newly generated passkey.
      */
@@ -111,6 +163,10 @@ export type AuthStateSignup = Omit<ServerAuthStateSignup, 'signupAuthMethods'> &
      * The Para system ID for the newly generated password.
      */
     passwordId?: string;
+    /**
+     * The Para system ID for the newly generated PIN.
+     */
+    pinId?: string;
 };
 export type AuthStateVerifyOrLogin = AuthStateVerify | AuthStateLogin;
 export type AuthStateSignupOrLogin = AuthStateSignup | AuthStateLogin;

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

@@ -20,6 +20,9 @@ export interface Wallet {
     lastUsedPartnerId?: string;
     isExternal?: boolean;
     isExternalWithParaAuth?: boolean;
+    externalProviderId?: string;
+    isExternalWithVerification?: boolean;
+    isExternalConnectionOnly?: boolean;
     ensName?: string | null;
     ensAvatar?: string | null;
 }
@@ -39,4 +42,4 @@ export interface DeniedSignatureResWithUrl extends DeniedSignatureRes {
 }
 export type SignatureRes = SuccessfulSignatureRes | DeniedSignatureRes;
 export type FullSignatureRes = SuccessfulSignatureRes | DeniedSignatureResWithUrl;
-export type ExternalWalletConnectionType = 'NONE' | 'CONNECTION_ONLY' | 'AUTHENTICATED';
+export type ExternalWalletConnectionType = 'NONE' | 'CONNECTION_ONLY' | 'AUTHENTICATED' | 'VERIFICATION';

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

@@ -10,6 +10,8 @@ export declare function hexToSignature(hexSig: string): Signature;
 export declare function hexToUint8Array(hex: string): Uint8Array;
 export declare function hexToDecimal(hex: string): string;
 export declare function decimalToHex(decimal: string): Hex;
+export declare function compressPubkey(pubkey: Uint8Array): Uint8Array;
+export declare function rawSecp256k1PubkeyToRawAddress(pubkeyData: Uint8Array): Uint8Array;
 export declare function getCosmosAddress(publicKey: string, prefix: string): string;
 export declare function truncateAddress(str: string, addressType: TWalletType, { prefix, targetLength, }?: {
     prefix?: string;

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

@@ -5,3 +5,7 @@ export declare function formatPhoneNumber(phone: string, countryCode: string | u
     forDisplay: true;
 }): string | null;
 export declare function displayPhoneNumber(phone: string, countryCode?: string): string;
+export declare function splitPhoneNumber(phone: `+${number}`): {
+    phone: string;
+    countryCode: string;
+};

package/package.json

@@ -1,39 +1,21 @@
 {
   "name": "@getpara/core-sdk",
-  "version": "2.0.0-alpha.5",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "types": "dist/types/index.d.ts",
-  "typings": "dist/types/index.d.ts",
-  "sideEffects": false,
+  "version": "2.0.0-alpha.51",
   "dependencies": {
     "@celo/utils": "^8.0.2",
     "@cosmjs/encoding": "^0.32.4",
     "@ethereumjs/util": "^9.1.0",
-    "@getpara/user-management-client": "2.0.0-alpha.5",
+    "@getpara/user-management-client": "2.0.0-alpha.51",
     "@noble/hashes": "^1.5.0",
     "base64url": "^3.0.1",
-    "libphonenumber-js": "1.11.2",
+    "libphonenumber-js": "^1.11.7",
     "node-forge": "^1.3.1",
     "uuid": "^11.1.0"
   },
-  "scripts": {
-    "build": "rm -rf dist && node ./scripts/build.mjs && yarn build:types",
-    "old-build": "yarn build:cjs && yarn build:esm && yarn build:types; yarn post-build",
-    "post-build": "./scripts/set-version.sh",
-    "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"
-  },
   "devDependencies": {
     "@faker-js/faker": "^9.5.1",
-    "typescript": "5.1.6"
+    "typescript": "^5.8.3"
   },
-  "files": [
-    "dist",
-    "package.json"
-  ],
   "exports": {
     ".": {
       "types": "./dist/types/index.d.ts",
@@ -41,5 +23,23 @@
       "require": "./dist/cjs/index.js"
     }
   },
-  "gitHead": "3ecfca088f24489f2e8fa5493d0f4459b08880e1"
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "gitHead": "f5b6354bac51de2e6988af340d7490dbdb62bc88",
+  "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; yarn post-build",
+    "post-build": "./scripts/set-version.sh",
+    "test": "vitest run --coverage"
+  },
+  "sideEffects": false,
+  "types": "dist/types/index.d.ts",
+  "typings": "dist/types/index.d.ts"
 }