@fourt/sdk 1.1.7 → 1.2.1

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { getWebAuthnAttestation, TSignedRequest, TurnkeyClient } from '@turnkey/
 import * as viem_account_abstraction from 'viem/account-abstraction';
 import { Hex } from '../types/misc.js';
 import * as viem from 'viem';
-import { LocalAccount, Client, SignableMessage, Hex as Hex$1, TypedData, TypedDataDefinition, SerializeTransactionFn, TransactionSerializable, IsNarrowable, TransactionSerialized, GetTransactionType } from 'viem';
+import { LocalAccount, Client, Transport, Chain, JsonRpcAccount, SignableMessage, Hex as Hex$1, TypedData, TypedDataDefinition, SerializeTransactionFn, TransactionSerializable, IsNarrowable, TransactionSerialized, GetTransactionType } from 'viem';
 import { toLightSmartAccount } from 'permissionless/accounts';
 
 declare enum SessionType {
@@ -16,9 +16,6 @@ declare enum SessionType {
  */
 declare class SessionStore {
     private readonly _store;
-    /**
-     * Initializes a new instance of the `SessionStore` class by creating a new `zustand`store with the initial state.
-     */
     constructor();
     /**
      * Gets the type from the session state.
@@ -44,6 +41,18 @@ declare class SessionStore {
      * @param {string} token the token to set.
      */
     set token(token: string);
+    /**
+     * Gets the CSRF token from the session state.
+     *
+     * @returns {string | undefined} the CSRF token.
+     */
+    get csrfToken(): string | undefined;
+    /**
+     * Sets the CSRF token in the session state.
+     *
+     * @param {string} csrfToken the CSRF token to set.
+     */
+    set csrfToken(csrfToken: string);
     /**
      * Gets the bundle from the session state.
      *
@@ -128,7 +137,8 @@ type AuthenticationServiceEndpoints = [
         };
         Response: {
             user: User;
-            token: string;
+            token?: string;
+            csrfToken?: string;
         };
     },
     {
@@ -148,6 +158,7 @@ type AuthenticationServiceEndpoints = [
         Response: {
             user: User;
             token: string;
+            csrfToken: string;
         };
     },
     {
@@ -160,13 +171,38 @@ type AuthenticationServiceEndpoints = [
         };
     },
     {
-        Route: 'v1/oauth/init';
+        Route: '/v1/oauth/init';
         Body: {
             provider: string;
         };
         Response: {
             url: string;
         };
+    },
+    {
+        Route: '/v1/refresh';
+        Body: {};
+        Response: {
+            token: string;
+            csrfToken: string;
+        };
+    },
+    {
+        Route: '/v1/csrf-token';
+        Body: {};
+        Response: {
+            csrfToken: string;
+        };
+    },
+    {
+        Route: '/v1/logout';
+        Body: {};
+        Response: {};
+    },
+    {
+        Route: '/v1/me';
+        Body: {};
+        Response: User;
     }
 ];
 
@@ -184,20 +220,23 @@ declare abstract class SignerClient {
     protected readonly _turnkeyClient: TurnkeyClient;
     protected readonly _configuration: Required<SignerClientConstructorParams['configuration']>;
     protected readonly _sessionStore: SessionStore;
-    private _user?;
+    private _refreshPromise?;
+    private _refreshTimer?;
     constructor({ stamper, configuration: { apiUrl, paymasterRpcUrl, ...requiredConfiguration }, }: SignerClientConstructorParams);
-    logout(): void;
     get configuration(): Required<SignerClientConfiguration>;
-    get user(): User | undefined;
-    protected set user(value: User | undefined);
+    getUser(): Promise<User>;
+    isLoggedIn(): Promise<boolean>;
+    getToken(): Promise<string>;
+    private _isTokenExpired;
+    logout(): Promise<void>;
+    signRawMessage<Into extends string>(msg: string): Promise<Into>;
     protected set stamper(stamper: TurnkeyClient['stamper']);
     protected get stamper(): TurnkeyClient['stamper'];
-    protected get sessionStore(): SessionStore;
-    signRawMessage<Into extends string>(msg: string): Promise<Into>;
-    getToken(): string | undefined;
     protected lookUpUser(email: string): Promise<string | null>;
     protected whoAmI(subOrgId?: string): Promise<void>;
     protected request<Route extends AuthenticationServiceRoutes>(route: Route, body?: AuthenticationServiceBody<Route>): Promise<AuthenticationServiceResponse<Route>>;
+    protected _scheduleRefresh(token: string): void;
+    private _refreshToken;
 }
 
 type WebauthnSignInParams = {
@@ -246,13 +285,14 @@ declare class WebSignerClient extends SignerClient {
      * @param {WebSignerClientConstructorParams} params params for the constructor
      */
     constructor({ configuration, webauthn, iframe, oauth, }: WebSignerClientConstructorParams);
-    signRawMessage<Into extends string>(msg: string): Promise<Into>;
     logout(): Promise<void>;
+    signRawMessage<Into extends string>(msg: string): Promise<Into>;
     /**
-     * Checks for an existing session and if exists, updates the stamper accordingly.
+     * Get the pre-filled URL for initiating oauth with a specific provider.
      *
+     * @param {string} provider provider for which we are getting the URL, currently google or apple
      */
-    private updateStamper;
+    getOAuthInitUrl(provider: string): Promise<string>;
     /**
      * Signs in a user with webauthn.
      *
@@ -266,18 +306,22 @@ declare class WebSignerClient extends SignerClient {
      */
     emailAuth(params: EmailInitializeAuthParams): Promise<void>;
     getIframePublicKey(): Promise<string>;
-    /**
-     * Signs in a user with email.
-     *
-     * @param {EmailInitializeAuthParams} params params for the sign in
-     */
-    private _signInWithEmail;
     /**
      * Completes the authentication process with a credential bundle.
      *
      * @param {CompleteAuthWithBundleParams} params params for the completion of the auth process
      */
     completeAuthWithBundle({ bundle, subOrgId, sessionType, }: CompleteAuthWithBundleParams): Promise<void>;
+    /**
+     * Checks for an existing session and if exists, updates the stamper accordingly.
+     */
+    private _updateStamper;
+    /**
+     * Signs in a user with email.
+     *
+     * @param {EmailInitializeAuthParams} params params for the sign in
+     */
+    private _signInWithEmail;
     /**
      * Creates a passkey account using the webauthn stamper.
      *
@@ -298,12 +342,6 @@ declare class WebSignerClient extends SignerClient {
     private _createAccount;
     private _webauthnGenerateAttestation;
     private _initIframeStamper;
-    /**
-     * Get the pre-filled URL for initiating oauth with a specific provider.
-     *
-     * @param {string} provider provider for which we are getting the URL, currently google or apple
-     */
-    getOAuthInitUrl(provider: string): Promise<string>;
 }
 
 /**
@@ -426,20 +464,21 @@ declare class UserModule {
      */
     constructor(_webSignerClient: WebSignerClient);
     /**
-     * Gets the user information.
-     *
-     * @returns {User | undefined} user information.
+     * Retrieves information for the authenticated user.
+     * Assumes a user is already logged in, otherwise it will throw an error.
      */
-    get info(): User | undefined;
-    /**  Gets the user token.
-     *
-     * @returns {string | undefined} user token.
+    getInfo(): Promise<User>;
+    /**
+     * Checks if a user is currently logged in to the fourt.io SDK.
      */
-    get token(): string | undefined;
+    isLoggedIn(): Promise<boolean>;
+    /**
+     * Generates an access token with a lifespan of 15 minutes.
+     * Assumes a user is already logged in, otherwise it will throw an error.
+     */
+    getToken(): Promise<string>;
     /**
      * Logs out the user.
-     *
-     * @returns {void}
      */
     logout(): Promise<void>;
 }
@@ -448,7 +487,7 @@ type CcipRequestReturnType = Hex;
 
 type CurrentUserToLightSmartAccountParams = {
     owner: LocalAccount;
-    client: Client;
+    client: Client<Transport, Chain | undefined, JsonRpcAccount | LocalAccount | undefined>;
 };
 declare class ViemModule {
     private readonly _signerClient;
@@ -465,6 +504,7 @@ declare class ViemModule {
             request?: (parameters: viem.CcipRequestParameters) => Promise<CcipRequestReturnType>;
         } | undefined;
         chain: undefined;
+        experimental_blockTag?: viem.BlockTag | undefined;
         key: string;
         name: string;
         pollingInterval: number;
@@ -484,6 +524,7 @@ declare class ViemModule {
             cacheTime?: undefined;
             ccipRead?: undefined;
             chain?: undefined;
+            experimental_blockTag?: undefined;
             key?: undefined;
             name?: undefined;
             pollingInterval?: undefined;
@@ -491,7 +532,7 @@ declare class ViemModule {
             transport?: undefined;
             type?: undefined;
             uid?: undefined;
-        } & viem.ExactPartial<Pick<viem.PublicActions<viem.HttpTransport, undefined, undefined>, "call" | "createContractEventFilter" | "createEventFilter" | "estimateContractGas" | "estimateGas" | "getBlock" | "getBlockNumber" | "getChainId" | "getContractEvents" | "getEnsText" | "getFilterChanges" | "getGasPrice" | "getLogs" | "getTransaction" | "getTransactionCount" | "getTransactionReceipt" | "prepareTransactionRequest" | "readContract" | "sendRawTransaction" | "simulateContract" | "uninstallFilter" | "watchBlockNumber" | "watchContractEvent"> & Pick<viem.WalletActions<undefined, undefined>, "sendTransaction" | "writeContract">>>(fn: (client: Client<viem.HttpTransport, undefined, undefined, viem.PaymasterRpcSchema, viem_account_abstraction.PaymasterActions>) => client) => Client<viem.HttpTransport, undefined, undefined, viem.PaymasterRpcSchema, { [K in keyof client]: client[K]; } & viem_account_abstraction.PaymasterActions>;
+        } & viem.ExactPartial<Pick<viem.PublicActions<viem.HttpTransport<undefined, false>, undefined, undefined>, "getChainId" | "prepareTransactionRequest" | "sendRawTransaction" | "call" | "createContractEventFilter" | "createEventFilter" | "estimateContractGas" | "estimateGas" | "getBlock" | "getBlockNumber" | "getContractEvents" | "getEnsText" | "getFilterChanges" | "getGasPrice" | "getLogs" | "getTransaction" | "getTransactionCount" | "getTransactionReceipt" | "readContract" | "simulateContract" | "uninstallFilter" | "watchBlockNumber" | "watchContractEvent"> & Pick<viem.WalletActions<undefined, undefined>, "sendTransaction" | "writeContract">>>(fn: (client: Client<viem.HttpTransport<undefined, false>, undefined, undefined, viem.PaymasterRpcSchema, viem_account_abstraction.PaymasterActions>) => client) => Client<viem.HttpTransport<undefined, false>, undefined, undefined, viem.PaymasterRpcSchema, { [K in keyof client]: client[K]; } & viem_account_abstraction.PaymasterActions>;
     }>;
     signMessage(msg: SignableMessage): Promise<Hex$1>;
     signTypedData<TTypedData extends TypedData | Record<string, unknown>, TPrimaryType extends keyof TTypedData | 'EIP712Domain' = keyof TTypedData>(params: TypedDataDefinition<TTypedData, TPrimaryType>): Promise<Hex$1>;