cauthy-auth 0.25.0 → 0.26.0

package/dist/client.d.mts

@@ -430,21 +430,34 @@ interface AuthClient {
         }): Promise<AuthResult<'signed_in', {
             session: PublicSession;
         }>>;
-        /** With address and password. `mfa_required`: ask for the code and call `signIn.mfa`. */
+        /**
+         * With address and password. `mfa_required`: ask for the code and call
+         * `signIn.mfa`. `method: 'email'` says the code was just mailed to the
+         * account's address (it has no factor of its own and the workspace, or
+         * the sign-in's risk, asked a second step): say so, and offer
+         * `mfaSendEmail` for another.
+         */
         email(form: {
             email: string;
             password: string;
             captchaToken?: string;
         }): Promise<AuthResult<'signed_in', {
             session: PublicSession;
-        }> | AuthResult<'mfa_required'>>;
-        /** The second step: the code of the authenticator app, or a recovery code. */
+        }> | AuthResult<'mfa_required', {
+            method?: 'email';
+        }>>;
+        /** The second step: the code of the authenticator app, the phone, the email, or a recovery code. */
         mfa(form: {
             code: string;
         }): Promise<AuthResult<'signed_in', {
             session: PublicSession;
         }>>;
-        /** While the second step is asked for: whether the account has an authenticator app, the phone (masked) a code can be sent to, and phones that approve sign-ins. */
+        /**
+         * While the second step is asked for: whether the account has an
+         * authenticator app, the phone (masked) a code can be sent to, phones
+         * that approve sign-ins, and the address (masked) a code went to when
+         * the step is by email.
+         */
         mfaMethods(): Promise<AuthResult<'ok', {
             totp: boolean;
             phone: {
@@ -454,6 +467,13 @@ interface AuthClient {
             push: {
                 devices: number;
             } | null;
+            email: {
+                to: string;
+            } | null;
+        }>>;
+        /** Mails the sign-in's code again, when its second step is by email; `mfa` takes it. A few per sign-in. */
+        mfaSendEmail(): Promise<AuthResult<'sent', {
+            sentTo: string;
         }>>;
         /**
          * Sends a push to the account's phones (the application's app, with

package/dist/client.d.ts

@@ -430,21 +430,34 @@ interface AuthClient {
         }): Promise<AuthResult<'signed_in', {
             session: PublicSession;
         }>>;
-        /** With address and password. `mfa_required`: ask for the code and call `signIn.mfa`. */
+        /**
+         * With address and password. `mfa_required`: ask for the code and call
+         * `signIn.mfa`. `method: 'email'` says the code was just mailed to the
+         * account's address (it has no factor of its own and the workspace, or
+         * the sign-in's risk, asked a second step): say so, and offer
+         * `mfaSendEmail` for another.
+         */
         email(form: {
             email: string;
             password: string;
             captchaToken?: string;
         }): Promise<AuthResult<'signed_in', {
             session: PublicSession;
-        }> | AuthResult<'mfa_required'>>;
-        /** The second step: the code of the authenticator app, or a recovery code. */
+        }> | AuthResult<'mfa_required', {
+            method?: 'email';
+        }>>;
+        /** The second step: the code of the authenticator app, the phone, the email, or a recovery code. */
         mfa(form: {
             code: string;
         }): Promise<AuthResult<'signed_in', {
             session: PublicSession;
         }>>;
-        /** While the second step is asked for: whether the account has an authenticator app, the phone (masked) a code can be sent to, and phones that approve sign-ins. */
+        /**
+         * While the second step is asked for: whether the account has an
+         * authenticator app, the phone (masked) a code can be sent to, phones
+         * that approve sign-ins, and the address (masked) a code went to when
+         * the step is by email.
+         */
         mfaMethods(): Promise<AuthResult<'ok', {
             totp: boolean;
             phone: {
@@ -454,6 +467,13 @@ interface AuthClient {
             push: {
                 devices: number;
             } | null;
+            email: {
+                to: string;
+            } | null;
+        }>>;
+        /** Mails the sign-in's code again, when its second step is by email; `mfa` takes it. A few per sign-in. */
+        mfaSendEmail(): Promise<AuthResult<'sent', {
+            sentTo: string;
         }>>;
         /**
          * Sends a push to the account's phones (the application's app, with

package/dist/client.js

@@ -400,6 +400,7 @@ function createAuthClient(options = {}) {
       mfa: (f) => post("/sign-in/mfa", { code: f.code }, checkCode(f.code)),
       mfaMethods: () => post("/sign-in/mfa/methods", {}, null),
       mfaSendCode: () => post("/sign-in/mfa/send", {}, null),
+      mfaSendEmail: () => post("/sign-in/mfa/email", {}, null),
       mfaPush: () => post("/sign-in/mfa/push", {}, null),
       async mfaPushWait(o = {}) {
         const status = await new Promise((resolve) => {