@fourt/sdk 1.4.1 → 1.5.1

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { U as User, A as AtLeastOne } from './index-Cy_WMhHm.cjs';
+import { User } from './types/index.cjs';
 import { getWebAuthnAttestation, TSignedRequest, TurnkeyClient } from '@turnkey/http';
 import * as viem_account_abstraction from 'viem/account-abstraction';
 import { Hex } from '../types/misc.js';
@@ -30,6 +30,7 @@ declare class SessionStore {
     clearBundle(): void;
     clearType(): void;
     clearToken(): void;
+    clearCsrfToken(): void;
     clearOtpId(): void;
     clearAll(): void;
     private _getInitialState;
@@ -44,57 +45,40 @@ type AuthenticationServiceResponse<Route extends AuthenticationServiceRoutes> =
 }>['Response'];
 type AuthenticationServiceEndpoints = [
     {
-        Route: '/v1/email-auth';
+        Route: '/v1/email/init';
         Body: {
             email: string;
-            targetPublicKey: string;
-            redirectUrl: string;
-            expirationSeconds?: number;
+            redirectUrl?: string;
         };
         Response: {
-            subOrgId: string;
-        };
-    },
-    {
-        Route: '/v1/email-auth';
-        Body: {};
-        Response: {
-            method: string;
+            otpId: string;
         };
     },
     {
-        Route: '/v1/otp-auth';
+        Route: '/v1/email/complete';
         Body: {
-            email: string;
-        } | {
-            email: string;
-            otpCode: string;
             otpId: string;
-            targetPublicKey: string;
+            otpCode: string;
+            publicKey: string;
         };
-        Response: AtLeastOne<{
-            otpId: string;
-        } & {
+        Response: {
             userId: string;
-            apiKeyId: string;
-            credentialBundle: string;
             subOrgId: string;
-        }>;
+        };
+    },
+    {
+        Route: '/v1/email/method';
+        Body: {};
+        Response: {
+            method: 'otp' | 'magiclink';
+        };
     },
     {
         Route: '/v1/signup';
-        Body: AtLeastOne<{
-            passkey: {
-                challenge: string;
-                attestation: Awaited<ReturnType<typeof getWebAuthnAttestation>>;
-            };
-            iframe: {
-                targetPublicKey: string;
-                redirectUrl: string;
-                expirationSeconds?: number;
-            };
-        }> & {
+        Body: {
             email: string;
+            challenge: string;
+            attestation: Awaited<ReturnType<typeof getWebAuthnAttestation>>;
         };
         Response: {
             user: User;
@@ -166,7 +150,7 @@ type AuthenticationServiceEndpoints = [
         Response: User;
     }
 ];
-declare const ROUTE_METHOD_LIST: readonly [readonly ["/v1/signup", "POST"], readonly ["/v1/email-auth", "POST"], readonly ["/v1/email-auth", "GET"], readonly ["/v1/otp-auth", "POST"], readonly ["/v1/lookup", "POST"], readonly ["/v1/signin", "POST"], readonly ["/v1/sign", "POST"], readonly ["/v1/oauth/init", "POST"], readonly ["/v1/refresh", "POST"], readonly ["/v1/csrf-token", "GET"], readonly ["/v1/logout", "POST"], readonly ["/v1/me", "GET"]];
+declare const ROUTE_METHOD_LIST: readonly [readonly ["/v1/signup", "POST"], readonly ["/v1/email/init", "POST"], readonly ["/v1/email/method", "GET"], readonly ["/v1/email/complete", "POST"], readonly ["/v1/lookup", "POST"], readonly ["/v1/signin", "POST"], readonly ["/v1/sign", "POST"], readonly ["/v1/oauth/init", "POST"], readonly ["/v1/refresh", "POST"], readonly ["/v1/csrf-token", "GET"], readonly ["/v1/logout", "POST"], readonly ["/v1/me", "GET"]];
 type RouteMethod = (typeof ROUTE_METHOD_LIST)[number];
 type Route = RouteMethod[0];
 type Method = RouteMethod[1];
@@ -198,7 +182,7 @@ declare abstract class SignerClient {
     protected set stamper(stamper: TurnkeyClient['stamper']);
     protected get stamper(): TurnkeyClient['stamper'];
     protected lookUpUser(email: string): Promise<string | null>;
-    protected whoAmI(subOrgId?: string): Promise<void>;
+    protected signIn(subOrgId?: string): Promise<void>;
     protected request<R extends Route, M extends Method>(route: R, method: M, body?: AuthenticationServiceBody<R>): Promise<AuthenticationServiceResponse<R>>;
     /**
      * Compute milliseconds until refresh time.
@@ -211,24 +195,14 @@ declare abstract class SignerClient {
     private _refreshToken;
 }
 
-type WebauthnSignInParams = {
+type WebAuthnSignInParams = {
     email: string;
 };
-type EmailAuthReturn = {
-    method: string;
-};
-type EmailInitializeAuthParams = {
+type InitEmailAuthParams = {
     email: string;
     redirectUrl?: string;
-    expirationSeconds?: number;
 };
-type CompleteAuthWithBundleParams = {
-    bundle: string;
-    subOrgId: string;
-    sessionType: SessionType;
-    isNewUser?: boolean;
-};
-type CompleteAuthWithOtpParams = {
+type CompleteEmailAuthParams = {
     email: string;
     otpCode: string;
 };
@@ -241,29 +215,21 @@ type WebSignerClientConstructorParams = SignerClientInheritedConstructorParams<{
     webauthn: {
         rpId: string;
     };
-    iframe?: {
-        iframeElementId?: string;
-        iframeContainerId?: string;
-    };
     oauth?: OAuthConfiguration;
 }>;
 /**
  * A signer client for web applications.
  */
 declare class WebSignerClient extends SignerClient {
-    private iframeStamper;
+    private indexedDbStamper;
     private webauthnStamper;
-    iframeConfig: {
-        iframeElementId: string;
-        iframeContainerId: string;
-    };
     readonly oauthConfiguration: WebSignerClientConstructorParams['oauth'];
     /**
      * Initializes a new instance of the `WebSignerClient` class.
      *
      * @param {WebSignerClientConstructorParams} params params for the constructor
      */
-    constructor({ configuration, webauthn, iframe, oauth, }: WebSignerClientConstructorParams);
+    constructor({ configuration, webauthn, oauth, }: WebSignerClientConstructorParams);
     logout(): Promise<void>;
     signRawMessage<Into extends string>(msg: string): Promise<Into>;
     /**
@@ -275,95 +241,45 @@ declare class WebSignerClient extends SignerClient {
     /**
      * Signs in a user with webauthn.
      *
-     * @param {WebauthnSignInParams} params params for the sign in
+     * @param {WebAuthnSignInParams} params params for the sign in
      */
-    webauthnSignIn({ email }: WebauthnSignInParams): Promise<void>;
+    webAuthnSignIn({ email }: WebAuthnSignInParams): Promise<void>;
     /**
      * Handles auth user process with email according to the method of the used app.
      *
-     * @param {EmailInitializeAuthParams} params params needed for the initialization of the auth process
+     * @param {InitEmailAuthParams} params params needed for the initialization of the auth process
      */
-    emailAuth(params: EmailInitializeAuthParams): Promise<{
-        method: string;
-    }>;
-    getIframePublicKey(): Promise<string>;
+    initEmailAuth(params: InitEmailAuthParams): Promise<void>;
+    getPublicKey(): Promise<string>;
+    resetKeyPair(): Promise<void>;
     /**
      * Verifies the provided otp code.
      *
-     * @param {CompleteAuthWithOtpParams} params params needed for otp code verification
+     * @param {CompleteEmailAuthParams} params params needed for otp code verification
      */
-    otpAuth(params: CompleteAuthWithOtpParams): Promise<{
-        bundle: string;
-        subOrgId: string;
-    }>;
+    completeEmailAuth(params: CompleteEmailAuthParams): Promise<void>;
     /**
      * Gets the email authentication method of the app.
      */
-    getEmailAuthMethod(): Promise<string>;
-    /**
-     * Starts email authentication process via otp.
-     */
-    private _initOtpAuth;
-    /**
-     * 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>;
+    getEmailAuthMethod(): Promise<"otp" | "magiclink">;
     /**
      * Checks for an existing session and if exists, updates the stamper accordingly.
      */
     private _updateStamper;
-    /**
-     * Init authentication with magic link email.
-     *
-     * @param {EmailInitializeAuthParams} params params for the sign in
-     */
-    private _initMagicLinkAuth;
     /**
      * Creates a passkey account using the webauthn stamper.
      *
-     * @param {Extract<CreateAccountParams, { method: 'webauthn' }>} params params for the creation of the account
-     */
-    private _createWebauthnAccount;
-    /**
-     * Creates an email account using the iframe stamper.
-     *
-     * @param {Extract<CreateAccountParams, { method: 'email' }>} params params for the creation of the account
+     * @param {WebAuthnSignInParams} params params for the creation of the account
      */
-    private _createEmailAccount;
+    private _createWebAuthnAccount;
     /**
-     * Handle the account creation process.
+     * Init account creation with email.
      *
-     * @param {CreateAccountParams} params params to create an account
+     * @param {InitEmailAuthParams} params params for the creation of the account
      */
-    private _createAccount;
+    private _initEmailAuth;
     private _webauthnGenerateAttestation;
-    private _initIframeStamper;
-}
-
-declare class MagicLinkModule {
-    private readonly _webSignerClient;
-    constructor(_webSignerClient: WebSignerClient);
-    /**
-     * Completes authentication with magic link that contains a bundle.
-     *
-     * @param params {CompleteAuthWithBundleParams} params received as URL params necessary to complete authentication process.
-     * @returns {Promise<void>} promise that completes the authentication process.
-     */
-    complete(params: Pick<CompleteAuthWithBundleParams, 'subOrgId' | 'bundle'>): Promise<void>;
-}
-
-declare class OtpModule {
-    private readonly _webSignerClient;
-    constructor(_webSignerClient: WebSignerClient);
-    /**
-     * Completes authentication with OTP code after user receives the bundle and subOrgId.
-     *
-     * @param params {CompleteAuthWithOtpParams} params to complete the authentication process.
-     * @returns {Promise<void>} promise that completes the authentication process.
-     */
-    complete(params: CompleteAuthWithOtpParams): Promise<void>;
+    private _initIndexedDbStamper;
 }
 
 /**
@@ -372,25 +288,28 @@ declare class OtpModule {
  */
 declare class EmailModule {
     private readonly _webSignerClient;
-    private readonly _magicLinkModule;
-    private readonly _otpModule;
     constructor(_webSignerClient: WebSignerClient);
     /**
      * Initialize user authentication process using email.
      *
-     * @param params {EmailInitializeAuthParams} params to initialize the user authentication process.
-     * @returns {Promise<void>} promise that resolves to the result of the authentication process.
+     * @param params {InitEmailAuthParams} params to initialize the user authentication process.
+     * @returns {Promise<void>} promise that resolves when the initialization is complete.
+     */
+    initialize(params: InitEmailAuthParams): Promise<void>;
+    /**
+     * Completes email authentication with OTP code.
+     *
+     * @param params {CompleteEmailAuthParams} params to complete the authentication process.
+     * @returns {Promise<void>} promise that completes the authentication process.
      */
-    initialize(params: EmailInitializeAuthParams): Promise<EmailAuthReturn>;
+    complete(params: CompleteEmailAuthParams): Promise<void>;
     /**
      * Get the email authentication method of the app, that was chosen in fourt.io dashboard.
      * It can be either `magiclink` or `otp`.
      *
-     * @returns {Promise<string>} promise that resolves to the email authentication method.
+     * @returns {Promise<'otp' | 'magiclink'>} promise that resolves to the email authentication method.
      */
-    getAuthMethod(): Promise<string>;
-    get magicLink(): MagicLinkModule;
-    get otp(): OtpModule;
+    getAuthMethod(): Promise<'otp' | 'magiclink'>;
 }
 
 /**
@@ -403,18 +322,14 @@ declare class PasskeysModule {
     /**
      * Signs in a user using Passkeys.
      *
-     * @param params {WebauthnSignInParams} params for the sign-in process.
+     * @param params {WebAuthnSignInParams} params for the sign-in process.
      */
-    signIn(params: WebauthnSignInParams): Promise<void>;
+    signIn(params: WebAuthnSignInParams): Promise<void>;
 }
 
 declare class GoogleModule {
     private readonly _webSignerClient;
     constructor(_webSignerClient: WebSignerClient);
-    /**
-     *
-     * @returns
-     */
     init(): Promise<string>;
 }
 
@@ -427,10 +342,6 @@ declare class FacebookModule {
 declare class AppleModule {
     private readonly _webSignerClient;
     constructor(_webSignerClient: WebSignerClient);
-    /**
-     *
-     * @returns
-     */
     init(): Promise<string>;
 }
 
@@ -451,7 +362,7 @@ declare class OAuthModule {
     get google(): GoogleModule;
     get facebook(): FacebookModule;
     get apple(): AppleModule;
-    complete({ bundle, subOrgId }: CompleteParams): Promise<void>;
+    complete({ subOrgId }: CompleteParams): Promise<void>;
 }
 
 /**
@@ -572,7 +483,7 @@ declare class ViemModule {
 
 type FourtWebSignerConstructorParams = {
     configuration: SignerClientConstructorParams['configuration'];
-    auth: Pick<WebSignerClientConstructorParams, 'webauthn' | 'iframe' | 'oauth'>;
+    auth: Pick<WebSignerClientConstructorParams, 'webauthn' | 'oauth'>;
 };
 /**
  * A client for interacting with the Fourt Web Signer.
@@ -601,7 +512,7 @@ declare class FourtWebSigner {
      *
      * @param {FourtWebSignerConstructorParams} params the required parameters to initialize the client
      */
-    constructor({ configuration, auth: { webauthn, iframe, oauth }, }: FourtWebSignerConstructorParams);
+    constructor({ configuration, auth: { webauthn, oauth }, }: FourtWebSignerConstructorParams);
     /**
      * A module for interacting with the Viem library.
      */