@fourt/sdk 0.4.0 → 0.5.0

package/dist/index.d.cts

@@ -1,10 +1,14 @@
 import { getWebAuthnAttestation, TSignedRequest, TurnkeyClient } from '@turnkey/http';
-import { User } from './types/index.cjs';
+import { U as User, A as AtLeastOne } from './index-Cy_WMhHm.cjs';
 import * as viem_account_abstraction from 'viem/account-abstraction';
 import * as viem from 'viem';
 import { LocalAccount, Client, SignableMessage, Hex, TypedData, TypedDataDefinition, SerializeTransactionFn, TransactionSerializable, IsNarrowable, TransactionSerialized, GetTransactionType } from 'viem';
 import { toLightSmartAccount } from 'permissionless/accounts';
 
+declare enum SessionType {
+    Email = "email",
+    Passkeys = "passkeys"
+}
 /**
  * A store for the session state.
  */
@@ -14,6 +18,18 @@ declare class SessionStore {
      * 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.
+     *
+     * @returns {SessionType | undefined} the type.
+     */
+    get type(): SessionType | undefined;
+    /**
+     * Sets the type in the session state.
+     *
+     * @param {SessionType} type the type to set.
+     */
+    set type(type: SessionType);
     /**
      * Gets the token from the session state.
      *
@@ -26,6 +42,18 @@ declare class SessionStore {
      * @param {string} token the token to set.
      */
     set token(token: string);
+    /**
+     * Gets the bundle from the session state.
+     *
+     * @returns {string | undefined} the bundle.
+     */
+    get bundle(): string | undefined;
+    /**
+     * Sets the bundle in the session state.
+     *
+     * @param {string} bundle the bundle to set.
+     */
+    set bundle(bundle: string);
     /**
      * Gets the user from the session state.
      *
@@ -42,6 +70,14 @@ declare class SessionStore {
      * Clears the user from the session state.
      */
     clearUser(): void;
+    /**
+     * Clears the bundle from the session state.
+     */
+    clearBundle(): void;
+    /**
+     * Clears the type from the session state.
+     */
+    clearType(): void;
     /**
      * Clears the token from the session state.
      */
@@ -62,12 +98,30 @@ type AuthenticationServiceResponse<Route extends AuthenticationServiceRoutes> =
 }>['Response'];
 type AuthenticationServiceEndpoints = [
     {
-        Route: '/v1/signup';
+        Route: '/v1/email-auth';
         Body: {
+            email: string;
+            targetPublicKey: string;
+            redirectUrl: string;
+            expirationSeconds?: number;
+        };
+        Response: {
+            subOrgId: string;
+        };
+    },
+    {
+        Route: '/v1/signup';
+        Body: AtLeastOne<{
             passkey: {
                 challenge: string;
                 attestation: Awaited<ReturnType<typeof getWebAuthnAttestation>>;
             };
+            iframe: {
+                targetPublicKey: string;
+                redirectUrl: string;
+                expirationSeconds?: number;
+            };
+        }> & {
             email: string;
         };
         Response: {
@@ -137,10 +191,24 @@ declare abstract class SignerClient {
 type WebauthnSignInParams = {
     email: string;
 };
+type EmailInitializeAuthParams = {
+    email: string;
+    redirectUrl: string;
+    expirationSeconds?: number;
+};
+type EmailCompleteAuthWithBundleParams = {
+    bundle: string;
+    subOrgId: string;
+    isNewUser?: boolean;
+};
 type WebSignerClientConstructorParams = SignerClientInheritedConstructorParams<{
     webauthn: {
         rpId: string;
     };
+    iframe?: {
+        iframeElementId?: string;
+        iframeContainerId?: string;
+    };
 }>;
 /**
  * A signer client for web applications.
@@ -152,15 +220,58 @@ declare class WebSignerClient extends SignerClient {
      *
      * @param {WebSignerClientConstructorParams} params params for the constructor
      */
-    constructor({ configuration, webauthn }: WebSignerClientConstructorParams);
+    constructor({ configuration, webauthn, iframe, }: WebSignerClientConstructorParams);
+    signRawMessage<Into extends string>(msg: string): Promise<Into>;
+    logout(): Promise<void>;
+    /**
+     * Checks for an existing session and if exists, updates the stamper accordingly.
+     *
+     */
+    private updateStamper;
     /**
      * Signs in a user with webauthn.
      *
      * @param {WebauthnSignInParams} params params for the sign in
      */
     webauthnSignIn({ email }: WebauthnSignInParams): Promise<void>;
+    /**
+     * Handle auth user process with email.
+     *
+     * @param {EmailInitializeAuthParams} params Params needed for the initialization of the auth process
+     */
+    emailAuth(params: EmailInitializeAuthParams): Promise<void>;
+    /**
+     * 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 {EmailCompleteAuthWithBundleParams} params params for the completion of the auth process
+     */
+    completeAuthWithBundle({ bundle, subOrgId, }: EmailCompleteAuthWithBundleParams): Promise<void>;
+    /**
+     * 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
+     */
+    private _createEmailAccount;
+    /**
+     * Handle the account creation process.
+     *
+     * @param {CreateAccountParams} params params to create an account
+     */
     private _createAccount;
     private _webauthnGenerateAttestation;
+    private _initIframeStamper;
 }
 
 type CurrentUserToLightSmartAccountParams = {
@@ -213,6 +324,29 @@ declare class ViemModule {
     } | undefined): Promise<IsNarrowable<TransactionSerialized<GetTransactionType<transaction>>, Hex> extends true ? TransactionSerialized<GetTransactionType<transaction>> : Hex>;
 }
 
+/**
+ * A module for interacting with the Email authentication methods.
+ * Available through the `auth.email` property on a `FourtWebSigner` instance.
+ */
+declare class EmailModule {
+    private readonly _webSignerClient;
+    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.
+     */
+    initialize(params: EmailInitializeAuthParams): Promise<void>;
+    /**
+     * Completes authentication with bundle after user receives the bundle and subOrgId as URL params.
+     *
+     * @param params {EmailCompleteAuthWithBundleParams} params received as URL params necessary to complete authentication process.
+     * @returns {Promise<void>} promise that completes the authentication process.
+     */
+    complete(params: EmailCompleteAuthWithBundleParams): Promise<void>;
+}
+
 /**
  * A module for interacting with the Passkeys authentication methods.
  * Available through the `auth.passkeys` property on a `FourtWebSigner` instance.
@@ -236,6 +370,7 @@ declare class PasskeysModule {
 declare class AuthModule {
     private readonly _webSignerClient;
     private readonly _passkeys;
+    private readonly _email;
     /**
      * Initializes a new instance of the `AuthModule` class.
      *
@@ -246,6 +381,10 @@ declare class AuthModule {
      * A module for interacting with the Passkeys authentication methods.
      */
     get passkeys(): PasskeysModule;
+    /**
+     * A module for interacting with the Passkeys authentication methods.
+     */
+    get email(): EmailModule;
 }
 
 /**
@@ -271,12 +410,12 @@ declare class UserModule {
      *
      * @returns {void}
      */
-    logout(): void;
+    logout(): Promise<void>;
 }
 
 type FourtWebSignerConstructorParams = {
     configuration: SignerClientConstructorParams['configuration'];
-    auth: Pick<WebSignerClientConstructorParams, 'webauthn'>;
+    auth: Pick<WebSignerClientConstructorParams, 'webauthn' | 'iframe'>;
 };
 /**
  * A client for interacting with the Fourt Web Signer.
@@ -305,7 +444,7 @@ declare class FourtWebSigner {
      *
      * @param {FourtWebSignerConstructorParams} params the required parameters to initialize the client
      */
-    constructor({ configuration, auth: { webauthn }, }: FourtWebSignerConstructorParams);
+    constructor({ configuration, auth: { webauthn, iframe }, }: FourtWebSignerConstructorParams);
     /**
      * A module for interacting with the Viem library.
      */

package/dist/index.d.ts

@@ -1,10 +1,14 @@
 import { getWebAuthnAttestation, TSignedRequest, TurnkeyClient } from '@turnkey/http';
-import { User } from './types/index.js';
+import { U as User, A as AtLeastOne } from './index-Cy_WMhHm.js';
 import * as viem_account_abstraction from 'viem/account-abstraction';
 import * as viem from 'viem';
 import { LocalAccount, Client, SignableMessage, Hex, TypedData, TypedDataDefinition, SerializeTransactionFn, TransactionSerializable, IsNarrowable, TransactionSerialized, GetTransactionType } from 'viem';
 import { toLightSmartAccount } from 'permissionless/accounts';
 
+declare enum SessionType {
+    Email = "email",
+    Passkeys = "passkeys"
+}
 /**
  * A store for the session state.
  */
@@ -14,6 +18,18 @@ declare class SessionStore {
      * 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.
+     *
+     * @returns {SessionType | undefined} the type.
+     */
+    get type(): SessionType | undefined;
+    /**
+     * Sets the type in the session state.
+     *
+     * @param {SessionType} type the type to set.
+     */
+    set type(type: SessionType);
     /**
      * Gets the token from the session state.
      *
@@ -26,6 +42,18 @@ declare class SessionStore {
      * @param {string} token the token to set.
      */
     set token(token: string);
+    /**
+     * Gets the bundle from the session state.
+     *
+     * @returns {string | undefined} the bundle.
+     */
+    get bundle(): string | undefined;
+    /**
+     * Sets the bundle in the session state.
+     *
+     * @param {string} bundle the bundle to set.
+     */
+    set bundle(bundle: string);
     /**
      * Gets the user from the session state.
      *
@@ -42,6 +70,14 @@ declare class SessionStore {
      * Clears the user from the session state.
      */
     clearUser(): void;
+    /**
+     * Clears the bundle from the session state.
+     */
+    clearBundle(): void;
+    /**
+     * Clears the type from the session state.
+     */
+    clearType(): void;
     /**
      * Clears the token from the session state.
      */
@@ -62,12 +98,30 @@ type AuthenticationServiceResponse<Route extends AuthenticationServiceRoutes> =
 }>['Response'];
 type AuthenticationServiceEndpoints = [
     {
-        Route: '/v1/signup';
+        Route: '/v1/email-auth';
         Body: {
+            email: string;
+            targetPublicKey: string;
+            redirectUrl: string;
+            expirationSeconds?: number;
+        };
+        Response: {
+            subOrgId: string;
+        };
+    },
+    {
+        Route: '/v1/signup';
+        Body: AtLeastOne<{
             passkey: {
                 challenge: string;
                 attestation: Awaited<ReturnType<typeof getWebAuthnAttestation>>;
             };
+            iframe: {
+                targetPublicKey: string;
+                redirectUrl: string;
+                expirationSeconds?: number;
+            };
+        }> & {
             email: string;
         };
         Response: {
@@ -137,10 +191,24 @@ declare abstract class SignerClient {
 type WebauthnSignInParams = {
     email: string;
 };
+type EmailInitializeAuthParams = {
+    email: string;
+    redirectUrl: string;
+    expirationSeconds?: number;
+};
+type EmailCompleteAuthWithBundleParams = {
+    bundle: string;
+    subOrgId: string;
+    isNewUser?: boolean;
+};
 type WebSignerClientConstructorParams = SignerClientInheritedConstructorParams<{
     webauthn: {
         rpId: string;
     };
+    iframe?: {
+        iframeElementId?: string;
+        iframeContainerId?: string;
+    };
 }>;
 /**
  * A signer client for web applications.
@@ -152,15 +220,58 @@ declare class WebSignerClient extends SignerClient {
      *
      * @param {WebSignerClientConstructorParams} params params for the constructor
      */
-    constructor({ configuration, webauthn }: WebSignerClientConstructorParams);
+    constructor({ configuration, webauthn, iframe, }: WebSignerClientConstructorParams);
+    signRawMessage<Into extends string>(msg: string): Promise<Into>;
+    logout(): Promise<void>;
+    /**
+     * Checks for an existing session and if exists, updates the stamper accordingly.
+     *
+     */
+    private updateStamper;
     /**
      * Signs in a user with webauthn.
      *
      * @param {WebauthnSignInParams} params params for the sign in
      */
     webauthnSignIn({ email }: WebauthnSignInParams): Promise<void>;
+    /**
+     * Handle auth user process with email.
+     *
+     * @param {EmailInitializeAuthParams} params Params needed for the initialization of the auth process
+     */
+    emailAuth(params: EmailInitializeAuthParams): Promise<void>;
+    /**
+     * 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 {EmailCompleteAuthWithBundleParams} params params for the completion of the auth process
+     */
+    completeAuthWithBundle({ bundle, subOrgId, }: EmailCompleteAuthWithBundleParams): Promise<void>;
+    /**
+     * 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
+     */
+    private _createEmailAccount;
+    /**
+     * Handle the account creation process.
+     *
+     * @param {CreateAccountParams} params params to create an account
+     */
     private _createAccount;
     private _webauthnGenerateAttestation;
+    private _initIframeStamper;
 }
 
 type CurrentUserToLightSmartAccountParams = {
@@ -213,6 +324,29 @@ declare class ViemModule {
     } | undefined): Promise<IsNarrowable<TransactionSerialized<GetTransactionType<transaction>>, Hex> extends true ? TransactionSerialized<GetTransactionType<transaction>> : Hex>;
 }
 
+/**
+ * A module for interacting with the Email authentication methods.
+ * Available through the `auth.email` property on a `FourtWebSigner` instance.
+ */
+declare class EmailModule {
+    private readonly _webSignerClient;
+    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.
+     */
+    initialize(params: EmailInitializeAuthParams): Promise<void>;
+    /**
+     * Completes authentication with bundle after user receives the bundle and subOrgId as URL params.
+     *
+     * @param params {EmailCompleteAuthWithBundleParams} params received as URL params necessary to complete authentication process.
+     * @returns {Promise<void>} promise that completes the authentication process.
+     */
+    complete(params: EmailCompleteAuthWithBundleParams): Promise<void>;
+}
+
 /**
  * A module for interacting with the Passkeys authentication methods.
  * Available through the `auth.passkeys` property on a `FourtWebSigner` instance.
@@ -236,6 +370,7 @@ declare class PasskeysModule {
 declare class AuthModule {
     private readonly _webSignerClient;
     private readonly _passkeys;
+    private readonly _email;
     /**
      * Initializes a new instance of the `AuthModule` class.
      *
@@ -246,6 +381,10 @@ declare class AuthModule {
      * A module for interacting with the Passkeys authentication methods.
      */
     get passkeys(): PasskeysModule;
+    /**
+     * A module for interacting with the Passkeys authentication methods.
+     */
+    get email(): EmailModule;
 }
 
 /**
@@ -271,12 +410,12 @@ declare class UserModule {
      *
      * @returns {void}
      */
-    logout(): void;
+    logout(): Promise<void>;
 }
 
 type FourtWebSignerConstructorParams = {
     configuration: SignerClientConstructorParams['configuration'];
-    auth: Pick<WebSignerClientConstructorParams, 'webauthn'>;
+    auth: Pick<WebSignerClientConstructorParams, 'webauthn' | 'iframe'>;
 };
 /**
  * A client for interacting with the Fourt Web Signer.
@@ -305,7 +444,7 @@ declare class FourtWebSigner {
      *
      * @param {FourtWebSignerConstructorParams} params the required parameters to initialize the client
      */
-    constructor({ configuration, auth: { webauthn }, }: FourtWebSignerConstructorParams);
+    constructor({ configuration, auth: { webauthn, iframe }, }: FourtWebSignerConstructorParams);
     /**
      * A module for interacting with the Viem library.
      */