From 7b43dd5de6363700166a68f9c4398bdce4507fc7 Mon Sep 17 00:00:00 2001
From: wangsijie <wangsijie@silverhand.io>
Date: Mon, 25 Sep 2023 11:37:43 +0800
Subject: [PATCH] feat(schemas,console): add mfa interaction log key (#4560)

---
 packages/console/src/consts/logs.ts            | 18 ++++++++++++++++++
 .../schemas/src/foundations/jsonb-types.ts     |  2 +-
 packages/schemas/src/types/log/interaction.ts  |  5 ++++-
 3 files changed, 23 insertions(+), 2 deletions(-)

diff --git a/packages/console/src/consts/logs.ts b/packages/console/src/consts/logs.ts
index 34f9ee62b..822748dc0 100644
--- a/packages/console/src/consts/logs.ts
+++ b/packages/console/src/consts/logs.ts
@@ -22,6 +22,12 @@ export const auditLogEventTitle: Record<string, Optional<string>> &
   'Interaction.ForgotPassword.Profile.Update': 'Patch update forgot-password interaction profile',
   'Interaction.ForgotPassword.Submit': 'Submit forgot-password interaction',
   'Interaction.ForgotPassword.Update': 'Update forgot-password interaction',
+  'Interaction.ForgotPassword.BindMfa.Totp.Create': undefined,
+  'Interaction.ForgotPassword.BindMfa.Totp.Submit': undefined,
+  'Interaction.ForgotPassword.BindMfa.BackupCode.Create': undefined,
+  'Interaction.ForgotPassword.BindMfa.BackupCode.Submit': undefined,
+  'Interaction.ForgotPassword.BindMfa.WebAuthn.Create': undefined,
+  'Interaction.ForgotPassword.BindMfa.WebAuthn.Submit': undefined,
   'Interaction.Register.Identifier.Password.Submit': undefined,
   'Interaction.Register.Identifier.Social.Create': undefined,
   'Interaction.Register.Identifier.Social.Submit': undefined,
@@ -34,6 +40,12 @@ export const auditLogEventTitle: Record<string, Optional<string>> &
   'Interaction.Register.Profile.Update': 'Patch update register interaction profile',
   'Interaction.Register.Submit': 'Submit register interaction',
   'Interaction.Register.Update': 'Update register interaction',
+  'Interaction.Register.BindMfa.Totp.Create': undefined,
+  'Interaction.Register.BindMfa.Totp.Submit': undefined,
+  'Interaction.Register.BindMfa.BackupCode.Create': undefined,
+  'Interaction.Register.BindMfa.BackupCode.Submit': undefined,
+  'Interaction.Register.BindMfa.WebAuthn.Create': undefined,
+  'Interaction.Register.BindMfa.WebAuthn.Submit': undefined,
   'Interaction.SignIn.Identifier.Password.Submit': 'Submit sign-in identifier with password',
   'Interaction.SignIn.Identifier.Social.Create': 'Create social sign-in authorization-url',
   'Interaction.SignIn.Identifier.Social.Submit': 'Authenticate and submit social identifier',
@@ -46,6 +58,12 @@ export const auditLogEventTitle: Record<string, Optional<string>> &
   'Interaction.SignIn.Profile.Update': 'Patch Update sign-in interaction profile',
   'Interaction.SignIn.Submit': 'Submit sign-in interaction',
   'Interaction.SignIn.Update': 'Update sign-in interaction',
+  'Interaction.SignIn.BindMfa.Totp.Create': undefined,
+  'Interaction.SignIn.BindMfa.Totp.Submit': undefined,
+  'Interaction.SignIn.BindMfa.BackupCode.Create': undefined,
+  'Interaction.SignIn.BindMfa.BackupCode.Submit': undefined,
+  'Interaction.SignIn.BindMfa.WebAuthn.Create': undefined,
+  'Interaction.SignIn.BindMfa.WebAuthn.Submit': undefined,
   RevokeToken: undefined,
   Unknown: undefined,
 });
diff --git a/packages/schemas/src/foundations/jsonb-types.ts b/packages/schemas/src/foundations/jsonb-types.ts
index ae1b633f5..c08806c2c 100644
--- a/packages/schemas/src/foundations/jsonb-types.ts
+++ b/packages/schemas/src/foundations/jsonb-types.ts
@@ -153,7 +153,7 @@ export const customContentGuard = z.record(z.string());
 export type CustomContent = z.infer<typeof customContentGuard>;
 
 export enum MfaFactor {
-  TOTP = 'TOTP',
+  TOTP = 'Totp',
   WebAuthn = 'WebAuthn',
   BackupCode = 'BackupCode',
 }
diff --git a/packages/schemas/src/types/log/interaction.ts b/packages/schemas/src/types/log/interaction.ts
index 8d14c2d17..5b311b513 100644
--- a/packages/schemas/src/types/log/interaction.ts
+++ b/packages/schemas/src/types/log/interaction.ts
@@ -1,3 +1,4 @@
+import { type MfaFactor } from '../../foundations/jsonb-types.js';
 import type { InteractionEvent } from '../interactions.js';
 
 export type Prefix = 'Interaction';
@@ -9,6 +10,7 @@ export enum Field {
   Event = 'Event',
   Identifier = 'Identifier',
   Profile = 'Profile',
+  BindMfa = 'BindMfa',
 }
 
 /** Method to verify the identifier */
@@ -81,4 +83,5 @@ export type LogKey =
   | `${Prefix}.${InteractionEvent}.${Field.Identifier}.${Exclude<
       Method,
       Method.VerificationCode | Method.Social
-    >}.${Action.Submit}`;
+    >}.${Action.Submit}`
+  | `${Prefix}.${InteractionEvent}.${Field.BindMfa}.${MfaFactor}.${Action.Submit | Action.Create}`;