@fourt/sdk 1.2.2 → 1.3.0

package/dist/index.d.ts

@@ -120,6 +120,38 @@ type AuthenticationServiceEndpoints = [
             subOrgId: string;
         };
     },
+    {
+        Route: '/v1/email-auth';
+        Body: {};
+        Response: {
+            method: string;
+        };
+    },
+    {
+        Route: '/v1/otp-auth';
+        Body: AtLeastOne<{
+            init: {
+                email: string;
+            };
+            auth: {
+                email: string;
+                otpCode: string;
+                otpId: string;
+                targetPublicKey: string;
+            };
+        }>;
+        Response: AtLeastOne<{
+            init: {
+                otpId: string;
+            };
+            auth: {
+                userId: string;
+                apiKeyId: string;
+                credentialBundle: string;
+                subOrgId: string;
+            };
+        }>;
+    },
     {
         Route: '/v1/signup';
         Body: AtLeastOne<{
@@ -205,6 +237,10 @@ 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"]];
+type RouteMethod = (typeof ROUTE_METHOD_LIST)[number];
+type Route = RouteMethod[0];
+type Method = RouteMethod[1];
 
 type SignerClientConfiguration = {
     apiKey: string;
@@ -234,7 +270,14 @@ declare abstract class SignerClient {
     protected get stamper(): TurnkeyClient['stamper'];
     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 request<R extends Route, M extends Method>(route: R, method: M, body?: AuthenticationServiceBody<R>): Promise<AuthenticationServiceResponse<R>>;
+    /**
+     * Compute milliseconds until refresh time.
+     * - expSeconds is the JWT exp claim (seconds).
+     * - earlyMinutes is how many minutes before exp to refresh (default 2).
+     * Returns 0 if refresh time is already past.
+     */
+    private _computeRefreshDelayMs;
     protected _scheduleRefresh(token: string): void;
     private _refreshToken;
 }
@@ -242,11 +285,20 @@ declare abstract class SignerClient {
 type WebauthnSignInParams = {
     email: string;
 };
+type EmailAuthReturn = {
+    method: string;
+    otpId?: string;
+};
 type EmailInitializeAuthParams = {
     email: string;
     redirectUrl: string;
     expirationSeconds?: number;
 };
+type OtpAuthParams = {
+    email: string;
+    otpCode: string;
+    otpId: string;
+};
 type CompleteAuthWithBundleParams = {
     bundle: string;
     subOrgId: string;
@@ -300,12 +352,42 @@ declare class WebSignerClient extends SignerClient {
      */
     webauthnSignIn({ email }: WebauthnSignInParams): Promise<void>;
     /**
-     * Handle auth user process with email.
+     * 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
-     */
-    emailAuth(params: EmailInitializeAuthParams): Promise<void>;
+     * @param {EmailInitializeAuthParams} params params needed for the initialization of the auth process
+     */
+    emailAuth(params: EmailInitializeAuthParams): Promise<{
+        method: string;
+        otpId?: undefined;
+    } | {
+        method: string;
+        otpId: string;
+    }>;
     getIframePublicKey(): Promise<string>;
+    /**
+     * Verifies the provided otp code.
+     *
+     * @param {OtpAuthParams} params params needed for otp code verification
+     */
+    otpAuth(params: OtpAuthParams): Promise<AtLeastOne<{
+        init: {
+            otpId: string;
+        };
+        auth: {
+            userId: string;
+            apiKeyId: string;
+            credentialBundle: string;
+            subOrgId: string;
+        };
+    }>>;
+    /**
+     * Gets the email authentication method of the app.
+     */
+    private _getEmailAuthMethod;
+    /**
+     * Starts email authentication process via otp.
+     */
+    private _initOtpAuth;
     /**
      * Completes the authentication process with a credential bundle.
      *
@@ -344,12 +426,38 @@ declare class WebSignerClient extends SignerClient {
     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 {OtpAuthParams} params to complete the authentication process.
+     * @returns {Promise<void>} promise that completes the authentication process.
+     */
+    complete(params: OtpAuthParams): Promise<void>;
+}
+
 /**
  * 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;
+    private readonly _magicLinkModule;
+    private readonly _otpModule;
     constructor(_webSignerClient: WebSignerClient);
     /**
      * Initialize user authentication process using email.
@@ -357,14 +465,9 @@ declare class EmailModule {
      * @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 {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>;
+    initialize(params: EmailInitializeAuthParams): Promise<EmailAuthReturn>;
+    get magicLink(): MagicLinkModule;
+    get otp(): OtpModule;
 }
 
 /**
@@ -378,7 +481,6 @@ declare class PasskeysModule {
      * Signs in a user using Passkeys.
      *
      * @param params {WebauthnSignInParams} params for the sign-in process.
-     * @returns {Promise<void>} promise that resolves to the result of the sign-in process.
      */
     signIn(params: WebauthnSignInParams): Promise<void>;
 }
@@ -413,6 +515,10 @@ type CompleteParams = {
     bundle: string;
     subOrgId: string;
 };
+/**
+ * A module for interacting with the OAuth authentication methods.
+ * Available through the `auth.oauth` property on a `FourtWebSigner` instance.
+ */
 declare class OAuthModule {
     private readonly _webSignerClient;
     private readonly _googleModule;