feat: stricter type for first factor/mfa requirement

supertokens · Oct 13, 2023 · 107bed5 · 107bed5
1 parent 5806fa1
commit 107bed5
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 47 deletions.
diff --git a/lib/build/recipe/multifactorauth/types.d.ts b/lib/build/recipe/multifactorauth/types.d.ts
@@ -4,7 +4,18 @@ import OverrideableBuilder from "supertokens-js-override";
 import { GeneralErrorResponse, User } from "../../types";
 import { SessionContainer } from "../session";
 import { SessionContainerInterface } from "../session/types";
-export declare type MFARequirement = string;
+export declare type FirstFactor =
+    | "emailpassword"
+    | "thirdparty"
+    | "otp-email"
+    | "otp-phone"
+    | "link-email"
+    | "link-phone"
+    | {
+          type: "custom";
+          id: string;
+      };
+export declare type MFARequirement = FirstFactor | "totp";
 export declare type MFARequirementList = (
     | {
           oneOf: MFARequirement[];
@@ -19,18 +30,7 @@ export declare type MFAClaimValue = {
     n: string[];
 };
 export declare type TypeInput = {
-    firstFactors?: (
-        | "emailpassword"
-        | "thirdparty"
-        | "otp-email"
-        | "otp-phone"
-        | "link-email"
-        | "link-phone"
-        | {
-              type: "custom";
-              id: string;
-          }
-    )[];
+    firstFactors?: FirstFactor[];
     override?: {
         functions?: (
             originalImplementation: RecipeInterface,
@@ -40,18 +40,7 @@ export declare type TypeInput = {
     };
 };
 export declare type TypeNormalisedInput = {
-    firstFactors?: (
-        | "emailpassword"
-        | "thirdparty"
-        | "otp-email"
-        | "otp-phone"
-        | "link-email"
-        | "link-phone"
-        | {
-              type: "custom";
-              id: string;
-          }
-    )[];
+    firstFactors?: FirstFactor[];
     override: {
         functions: (
             originalImplementation: RecipeInterface,

diff --git a/lib/ts/recipe/multifactorauth/types.ts b/lib/ts/recipe/multifactorauth/types.ts
@@ -19,7 +19,16 @@ import { GeneralErrorResponse, User } from "../../types";
 import { SessionContainer } from "../session";
 import { SessionContainerInterface } from "../session/types";
 
-export type MFARequirement = string;
+export type FirstFactor =
+    | "emailpassword"
+    | "thirdparty"
+    | "otp-email"
+    | "otp-phone"
+    | "link-email"
+    | "link-phone"
+    | { type: "custom"; id: string };
+
+export type MFARequirement = FirstFactor | "totp";
 
 export type MFARequirementList = (
     | {
@@ -37,15 +46,7 @@ export type MFAClaimValue = {
 };
 
 export type TypeInput = {
-    firstFactors?: (
-        | "emailpassword"
-        | "thirdparty"
-        | "otp-email"
-        | "otp-phone"
-        | "link-email"
-        | "link-phone"
-        | { type: "custom"; id: string }
-    )[];
+    firstFactors?: FirstFactor[];
 
     override?: {
         functions?: (
@@ -57,15 +58,7 @@ export type TypeInput = {
 };
 
 export type TypeNormalisedInput = {
-    firstFactors?: (
-        | "emailpassword"
-        | "thirdparty"
-        | "otp-email"
-        | "otp-phone"
-        | "link-email"
-        | "link-phone"
-        | { type: "custom"; id: string }
-    )[];
+    firstFactors?: FirstFactor[];
 
     override: {
         functions: (

diff --git a/test/with-typescript/index.ts b/test/with-typescript/index.ts
@@ -1871,14 +1871,22 @@ Supertokens.init({
                     ...oI,
 
                     getMFARequirementsForAuth: ({ completedFactors }) => {
-                        const factors = ["otp-email", "totp", "biometric"];
-                        const completedFromList = factors.filter((id) => completedFactors[id] !== undefined);
+                        const factors = ["otp-email", "totp", { type: "custom", id: "biometric" }] as const;
+                        const completedFromList = factors.filter(
+                            (fact) => completedFactors[typeof fact === "string" ? fact : fact.id] !== undefined
+                        );
                         if (completedFromList.length >= 2) {
                             // We have completed two factors
                             return [];
                         }
                         // Otherwise the next step is completing something from the rest of the list
-                        return [{ oneOf: factors.filter((id) => completedFactors[id] === undefined) }];
+                        return [
+                            {
+                                oneOf: factors.filter(
+                                    (fact) => completedFactors[typeof fact === "string" ? fact : fact.id] === undefined
+                                ),
+                            },
+                        ];
                     },
                 }),
             },