@logto/schemas 1.30.1 → 1.31.0

package/lib/types/custom-profile-fields.js

@@ -7,7 +7,7 @@ import { consoleUserPreferenceKey, guideRequestsKey } from './user.js';
 const baseProfileFieldGuard = z.object({
     name: z.string(),
     type: customProfileFieldTypeGuard,
-    label: z.string(),
+    label: z.string().min(1).optional(),
     description: z.string().optional(),
     required: z.boolean(),
 });
@@ -41,17 +41,20 @@ export const dateProfileFieldGuard = baseProfileFieldGuard.extend({
     })
         .optional(),
 });
-export const checkboxProfileFieldGuard = baseProfileFieldGuard.extend({
+export const checkboxProfileFieldGuard = baseProfileFieldGuard.omit({ description: true }).extend({
     type: z.literal(CustomProfileFieldType.Checkbox),
-    config: z.object({
-        options: z.array(z.object({ label: z.string(), value: z.string() })),
-    }),
+    required: z.literal(false),
+    config: z
+        .object({
+        defaultValue: z.literal('true').or(z.literal('false')),
+    })
+        .optional(),
 });
 export const selectProfileFieldGuard = baseProfileFieldGuard.extend({
     type: z.literal(CustomProfileFieldType.Select),
     config: z.object({
         placeholder: z.string().optional(),
-        options: z.array(z.object({ label: z.string(), value: z.string() })),
+        options: z.array(z.object({ label: z.string().optional(), value: z.string() })),
     }),
 });
 export const urlProfileFieldGuard = baseProfileFieldGuard.extend({
@@ -126,16 +129,9 @@ export const updateCustomProfileFieldSieOrderGuard = z.object({
     name: z.string(),
     sieOrder: z.number(),
 });
-export const signInIdentifierKeyGuard = Users.createGuard
-    .pick({
-    username: true,
-    primaryEmail: true,
-    primaryPhone: true,
-})
-    .extend({
-    email: z.string().nullable().optional(),
-    phone: z.string().nullable().optional(),
-});
+/**
+ * Reserved custom data keys, which are used by the system and should not be used by custom profile fields.
+ */
 export const reservedCustomDataKeyGuard = z
     .object({
     [userOnboardingDataKey]: z.string(),
@@ -149,11 +145,34 @@ export const reservedCustomDataKeys = Object.freeze(reservedCustomDataKeyGuard.k
  * Disallow sign-in identifiers related field keys in custom profile fields, as this is conflicting
  * with the built-in sign-in/sign-up experience flows.
  */
+export const signInIdentifierKeyGuard = Users.createGuard
+    .pick({
+    username: true,
+    primaryEmail: true,
+    primaryPhone: true,
+})
+    .extend({
+    email: z.string().nullable().optional(),
+    phone: z.string().nullable().optional(),
+});
 export const reservedSignInIdentifierKeys = Object.freeze(signInIdentifierKeyGuard.keyof().options);
-export var supportedDateFormat;
-(function (supportedDateFormat) {
-    supportedDateFormat["US"] = "MM/dd/yyyy";
-    supportedDateFormat["UK"] = "dd/MM/yyyy";
-    supportedDateFormat["ISO"] = "yyyy-MM-dd";
-    supportedDateFormat["Custom"] = "custom";
-})(supportedDateFormat || (supportedDateFormat = {}));
+/**
+ * Reserved user profile keys.
+ * Currently only `preferredUsername` is reserved since it is the standard username property used
+ * by most identity providers. Should not allow user updating this field via profile related APIs.
+ */
+export const reservedBuiltInProfileKeyGuard = userProfileGuard.pick({ preferredUsername: true });
+export const reservedBuiltInProfileKeys = Object.freeze(reservedBuiltInProfileKeyGuard.keyof().options);
+export var SupportedDateFormat;
+(function (SupportedDateFormat) {
+    SupportedDateFormat["US"] = "MM/dd/yyyy";
+    SupportedDateFormat["UK"] = "dd/MM/yyyy";
+    SupportedDateFormat["ISO"] = "yyyy-MM-dd";
+    SupportedDateFormat["Custom"] = "custom";
+})(SupportedDateFormat || (SupportedDateFormat = {}));
+export var Gender;
+(function (Gender) {
+    Gender["Female"] = "female";
+    Gender["Male"] = "male";
+    Gender["Other"] = "prefer_not_to_say";
+})(Gender || (Gender = {}));

package/lib/types/interactions.d.ts

@@ -587,22 +587,6 @@ export declare const bindBackupCodePayloadGuard: z.ZodObject<{
     type: MfaFactor.BackupCode;
 }>;
 export type BindBackupCodePayload = z.infer<typeof bindBackupCodePayloadGuard>;
-export declare const bindEmailVerificationCodePayloadGuard: z.ZodObject<{
-    type: z.ZodLiteral<MfaFactor.EmailVerificationCode>;
-}, "strip", z.ZodTypeAny, {
-    type: MfaFactor.EmailVerificationCode;
-}, {
-    type: MfaFactor.EmailVerificationCode;
-}>;
-export type BindEmailVerificationCodePayload = z.infer<typeof bindEmailVerificationCodePayloadGuard>;
-export declare const bindPhoneVerificationCodePayloadGuard: z.ZodObject<{
-    type: z.ZodLiteral<MfaFactor.PhoneVerificationCode>;
-}, "strip", z.ZodTypeAny, {
-    type: MfaFactor.PhoneVerificationCode;
-}, {
-    type: MfaFactor.PhoneVerificationCode;
-}>;
-export type BindPhoneVerificationCodePayload = z.infer<typeof bindPhoneVerificationCodePayloadGuard>;
 export declare const bindMfaPayloadGuard: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
     type: z.ZodLiteral<MfaFactor.TOTP>;
     code: z.ZodString;
@@ -713,18 +697,6 @@ export declare const bindMfaPayloadGuard: z.ZodDiscriminatedUnion<"type", [z.Zod
     type: MfaFactor.BackupCode;
 }, {
     type: MfaFactor.BackupCode;
-}>, z.ZodObject<{
-    type: z.ZodLiteral<MfaFactor.EmailVerificationCode>;
-}, "strip", z.ZodTypeAny, {
-    type: MfaFactor.EmailVerificationCode;
-}, {
-    type: MfaFactor.EmailVerificationCode;
-}>, z.ZodObject<{
-    type: z.ZodLiteral<MfaFactor.PhoneVerificationCode>;
-}, "strip", z.ZodTypeAny, {
-    type: MfaFactor.PhoneVerificationCode;
-}, {
-    type: MfaFactor.PhoneVerificationCode;
 }>]>;
 export type BindMfaPayload = z.infer<typeof bindMfaPayloadGuard>;
 /** @deprecated  Legacy interaction API use only */
@@ -861,34 +833,6 @@ export declare const backupCodeVerificationPayloadGuard: z.ZodObject<{
     type: MfaFactor.BackupCode;
 }>;
 export type BackupCodeVerificationPayload = z.infer<typeof backupCodeVerificationPayloadGuard>;
-export declare const emailVerificationCodeVerificationPayloadGuard: z.ZodObject<{
-    type: z.ZodLiteral<MfaFactor.EmailVerificationCode>;
-    email: z.ZodString;
-    code: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    code: string;
-    type: MfaFactor.EmailVerificationCode;
-    email: string;
-}, {
-    code: string;
-    type: MfaFactor.EmailVerificationCode;
-    email: string;
-}>;
-export type EmailVerificationCodeVerificationPayload = z.infer<typeof emailVerificationCodeVerificationPayloadGuard>;
-export declare const phoneVerificationCodeVerificationPayloadGuard: z.ZodObject<{
-    type: z.ZodLiteral<MfaFactor.PhoneVerificationCode>;
-    phone: z.ZodString;
-    code: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    code: string;
-    type: MfaFactor.PhoneVerificationCode;
-    phone: string;
-}, {
-    code: string;
-    type: MfaFactor.PhoneVerificationCode;
-    phone: string;
-}>;
-export type PhoneVerificationCodeVerificationPayload = z.infer<typeof phoneVerificationCodeVerificationPayloadGuard>;
 export declare const verifyMfaPayloadGuard: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
     type: z.ZodLiteral<MfaFactor.TOTP>;
     code: z.ZodString;
@@ -1015,30 +959,6 @@ export declare const verifyMfaPayloadGuard: z.ZodDiscriminatedUnion<"type", [z.Z
 }, {
     code: string;
     type: MfaFactor.BackupCode;
-}>, z.ZodObject<{
-    type: z.ZodLiteral<MfaFactor.EmailVerificationCode>;
-    email: z.ZodString;
-    code: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    code: string;
-    type: MfaFactor.EmailVerificationCode;
-    email: string;
-}, {
-    code: string;
-    type: MfaFactor.EmailVerificationCode;
-    email: string;
-}>, z.ZodObject<{
-    type: z.ZodLiteral<MfaFactor.PhoneVerificationCode>;
-    phone: z.ZodString;
-    code: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    code: string;
-    type: MfaFactor.PhoneVerificationCode;
-    phone: string;
-}, {
-    code: string;
-    type: MfaFactor.PhoneVerificationCode;
-    phone: string;
 }>]>;
 export type VerifyMfaPayload = z.infer<typeof verifyMfaPayloadGuard>;
 export declare const pendingTotpGuard: z.ZodObject<{
@@ -1191,28 +1111,6 @@ export declare const bindBackupCodeGuard: z.ZodObject<{
     codes: string[];
 }>;
 export type BindBackupCode = z.infer<typeof bindBackupCodeGuard>;
-export declare const bindEmailVerificationCodeGuard: z.ZodObject<{
-    type: z.ZodLiteral<MfaFactor.EmailVerificationCode>;
-    email: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    type: MfaFactor.EmailVerificationCode;
-    email: string;
-}, {
-    type: MfaFactor.EmailVerificationCode;
-    email: string;
-}>;
-export type BindEmailVerificationCode = z.infer<typeof bindEmailVerificationCodeGuard>;
-export declare const bindPhoneVerificationCodeGuard: z.ZodObject<{
-    type: z.ZodLiteral<MfaFactor.PhoneVerificationCode>;
-    phone: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    type: MfaFactor.PhoneVerificationCode;
-    phone: string;
-}, {
-    type: MfaFactor.PhoneVerificationCode;
-    phone: string;
-}>;
-export type BindPhoneVerificationCode = z.infer<typeof bindPhoneVerificationCodeGuard>;
 export declare const bindMfaGuard: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
     type: z.ZodLiteral<MfaFactor.TOTP>;
     secret: z.ZodString;
@@ -1255,24 +1153,6 @@ export declare const bindMfaGuard: z.ZodDiscriminatedUnion<"type", [z.ZodObject<
 }, {
     type: MfaFactor.BackupCode;
     codes: string[];
-}>, z.ZodObject<{
-    type: z.ZodLiteral<MfaFactor.EmailVerificationCode>;
-    email: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    type: MfaFactor.EmailVerificationCode;
-    email: string;
-}, {
-    type: MfaFactor.EmailVerificationCode;
-    email: string;
-}>, z.ZodObject<{
-    type: z.ZodLiteral<MfaFactor.PhoneVerificationCode>;
-    phone: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    type: MfaFactor.PhoneVerificationCode;
-    phone: string;
-}, {
-    type: MfaFactor.PhoneVerificationCode;
-    phone: string;
 }>]>;
 export type BindMfa = z.infer<typeof bindMfaGuard>;
 export declare const verifyMfaResultGuard: z.ZodObject<{

package/lib/types/interactions.js

@@ -187,19 +187,10 @@ export const bindWebAuthnPayloadGuard = z.object({
 export const bindBackupCodePayloadGuard = z.object({
     type: z.literal(MfaFactor.BackupCode),
 });
-// TODO @sijie: Implement binding
-export const bindEmailVerificationCodePayloadGuard = z.object({
-    type: z.literal(MfaFactor.EmailVerificationCode),
-});
-export const bindPhoneVerificationCodePayloadGuard = z.object({
-    type: z.literal(MfaFactor.PhoneVerificationCode),
-});
 export const bindMfaPayloadGuard = z.discriminatedUnion('type', [
     bindTotpPayloadGuard,
     bindWebAuthnPayloadGuard,
     bindBackupCodePayloadGuard,
-    bindEmailVerificationCodePayloadGuard,
-    bindPhoneVerificationCodePayloadGuard,
 ]);
 /** @deprecated  Legacy interaction API use only */
 export const totpVerificationPayloadGuard = bindTotpPayloadGuard;
@@ -217,22 +208,10 @@ export const backupCodeVerificationPayloadGuard = z.object({
     type: z.literal(MfaFactor.BackupCode),
     code: z.string(),
 });
-export const emailVerificationCodeVerificationPayloadGuard = z.object({
-    type: z.literal(MfaFactor.EmailVerificationCode),
-    email: z.string(),
-    code: z.string(),
-});
-export const phoneVerificationCodeVerificationPayloadGuard = z.object({
-    type: z.literal(MfaFactor.PhoneVerificationCode),
-    phone: z.string(),
-    code: z.string(),
-});
 export const verifyMfaPayloadGuard = z.discriminatedUnion('type', [
     totpVerificationPayloadGuard,
     webAuthnVerificationPayloadGuard,
     backupCodeVerificationPayloadGuard,
-    emailVerificationCodeVerificationPayloadGuard,
-    phoneVerificationCodeVerificationPayloadGuard,
 ]);
 export const pendingTotpGuard = z.object({
     type: z.literal(MfaFactor.TOTP),
@@ -274,21 +253,11 @@ export const bindWebAuthnGuard = z.object({
     name: z.string().optional(),
 });
 export const bindBackupCodeGuard = pendingBackupCodeGuard;
-export const bindEmailVerificationCodeGuard = z.object({
-    type: z.literal(MfaFactor.EmailVerificationCode),
-    email: z.string(),
-});
-export const bindPhoneVerificationCodeGuard = z.object({
-    type: z.literal(MfaFactor.PhoneVerificationCode),
-    phone: z.string(),
-});
 // The type for binding new mfa verification to a user, not always equals to the pending type.
 export const bindMfaGuard = z.discriminatedUnion('type', [
     bindTotpGuard,
     bindWebAuthnGuard,
     bindBackupCodeGuard,
-    bindEmailVerificationCodeGuard,
-    bindPhoneVerificationCodeGuard,
 ]);
 export const verifyMfaResultGuard = z.object({
     type: z.nativeEnum(MfaFactor),

package/lib/types/logto-config/jwt-customizer.d.ts

@@ -123,16 +123,6 @@ export declare const jwtCustomizerUserContextGuard: z.ZodObject<Pick<{
             usedAt?: string | undefined;
         }[];
         lastUsedAt?: string | undefined;
-    } | {
-        type: import("../../foundations/index.js").MfaFactor.EmailVerificationCode;
-        id: string;
-        createdAt: string;
-        lastUsedAt?: string | undefined;
-    } | {
-        type: import("../../foundations/index.js").MfaFactor.PhoneVerificationCode;
-        id: string;
-        createdAt: string;
-        lastUsedAt?: string | undefined;
     })[], z.ZodTypeDef, ({
         type: import("../../foundations/index.js").MfaFactor.TOTP;
         id: string;
@@ -159,16 +149,6 @@ export declare const jwtCustomizerUserContextGuard: z.ZodObject<Pick<{
             usedAt?: string | undefined;
         }[];
         lastUsedAt?: string | undefined;
-    } | {
-        type: import("../../foundations/index.js").MfaFactor.EmailVerificationCode;
-        id: string;
-        createdAt: string;
-        lastUsedAt?: string | undefined;
-    } | {
-        type: import("../../foundations/index.js").MfaFactor.PhoneVerificationCode;
-        id: string;
-        createdAt: string;
-        lastUsedAt?: string | undefined;
     })[]>;
     isSuspended: ZodType<boolean, z.ZodTypeDef, boolean>;
     lastSignInAt: ZodType<number | null, z.ZodTypeDef, number | null>;

package/lib/types/sign-in-experience.d.ts

@@ -12,7 +12,7 @@ type ForgotPassword = {
  * the need to load the full connector metadata that is not needed for rendering.
  */
 export type ExperienceSocialConnector = Omit<ConnectorMetadata, 'description' | 'configTemplate' | 'formItems' | 'readme' | 'customData'>;
-export type FullSignInExperience = SignInExperience & {
+export type FullSignInExperience = Omit<SignInExperience, 'forgotPasswordMethods'> & {
     socialConnectors: ExperienceSocialConnector[];
     ssoConnectors: SsoConnectorMetadata[];
     forgotPassword: ForgotPassword;
@@ -35,7 +35,7 @@ export type FullSignInExperience = SignInExperience & {
     };
     customProfileFields?: Readonly<CustomProfileField[]>;
 };
-export declare const fullSignInExperienceGuard: z.ZodObject<{
+export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
     tenantId: z.ZodType<string, z.ZodTypeDef, string>;
     id: z.ZodType<string, z.ZodTypeDef, string>;
     color: z.ZodType<{
@@ -137,7 +137,8 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
     }>;
     sentinelPolicy: z.ZodType<import("../foundations/jsonb-types/sign-in-experience.js").SentinelPolicy, z.ZodTypeDef, import("../foundations/jsonb-types/sign-in-experience.js").SentinelPolicy>;
     emailBlocklistPolicy: z.ZodType<import("../foundations/jsonb-types/sign-in-experience.js").EmailBlocklistPolicy, z.ZodTypeDef, import("../foundations/jsonb-types/sign-in-experience.js").EmailBlocklistPolicy>;
-} & {
+    forgotPasswordMethods: z.ZodType<import("../foundations/jsonb-types/sign-in-experience.js").ForgotPasswordMethod[] | null, z.ZodTypeDef, import("../foundations/jsonb-types/sign-in-experience.js").ForgotPasswordMethod[] | null>;
+}, "forgotPasswordMethods"> & {
     socialConnectors: z.ZodArray<z.ZodObject<Omit<{
         id: z.ZodString;
         target: z.ZodString;
@@ -679,7 +680,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
         type: CaptchaType;
         siteKey: string;
     }>>;
-    customProfileFields: z.ZodOptional<z.ZodArray<import("../index.js").Guard<CustomProfileField>, "many">>;
+    customProfileFields: z.ZodArray<import("../index.js").Guard<CustomProfileField>, "many">;
 }, "strip", z.ZodTypeAny, {
     id: string;
     tenantId: string;
@@ -858,6 +859,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
         phone: boolean;
     };
     isDevelopmentTenant: boolean;
+    customProfileFields: CustomProfileField[];
     googleOneTap?: {
         connectorId: string;
         clientId: string;
@@ -870,7 +872,6 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
         type: CaptchaType;
         siteKey: string;
     } | undefined;
-    customProfileFields?: CustomProfileField[] | undefined;
 }, {
     id: string;
     tenantId: string;
@@ -1049,6 +1050,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
         phone: boolean;
     };
     isDevelopmentTenant: boolean;
+    customProfileFields: CustomProfileField[];
     googleOneTap?: {
         connectorId: string;
         clientId: string;
@@ -1061,6 +1063,5 @@ export declare const fullSignInExperienceGuard: z.ZodObject<{
         type: CaptchaType;
         siteKey: string;
     } | undefined;
-    customProfileFields?: CustomProfileField[] | undefined;
 }>;
 export {};

package/lib/types/sign-in-experience.js

@@ -3,7 +3,9 @@ import { z } from 'zod';
 import { CustomProfileFields, SignInExperiences, } from '../db-entries/index.js';
 import { CaptchaType } from '../foundations/jsonb-types/index.js';
 import { ssoConnectorMetadataGuard } from './sso-connector.js';
-export const fullSignInExperienceGuard = SignInExperiences.guard.extend({
+export const fullSignInExperienceGuard = SignInExperiences.guard
+    .omit({ forgotPasswordMethods: true })
+    .extend({
     socialConnectors: connectorMetadataGuard
         .omit({
         description: true,
@@ -25,6 +27,5 @@ export const fullSignInExperienceGuard = SignInExperiences.guard.extend({
         siteKey: z.string(),
     })
         .optional(),
-    // @charles TODO: Remove `optional` before release
-    customProfileFields: CustomProfileFields.guard.array().optional(),
+    customProfileFields: CustomProfileFields.guard.array(),
 });

package/lib/types/user.d.ts

@@ -89,16 +89,6 @@ export declare const userInfoGuard: z.ZodObject<Pick<{
             usedAt?: string | undefined;
         }[];
         lastUsedAt?: string | undefined;
-    } | {
-        type: MfaFactor.EmailVerificationCode;
-        id: string;
-        createdAt: string;
-        lastUsedAt?: string | undefined;
-    } | {
-        type: MfaFactor.PhoneVerificationCode;
-        id: string;
-        createdAt: string;
-        lastUsedAt?: string | undefined;
     })[], z.ZodTypeDef, ({
         type: MfaFactor.TOTP;
         id: string;
@@ -125,16 +115,6 @@ export declare const userInfoGuard: z.ZodObject<Pick<{
             usedAt?: string | undefined;
         }[];
         lastUsedAt?: string | undefined;
-    } | {
-        type: MfaFactor.EmailVerificationCode;
-        id: string;
-        createdAt: string;
-        lastUsedAt?: string | undefined;
-    } | {
-        type: MfaFactor.PhoneVerificationCode;
-        id: string;
-        createdAt: string;
-        lastUsedAt?: string | undefined;
     })[]>;
     isSuspended: z.ZodType<boolean, z.ZodTypeDef, boolean>;
     lastSignInAt: z.ZodType<number | null, z.ZodTypeDef, number | null>;
@@ -259,16 +239,6 @@ export declare const userProfileResponseGuard: z.ZodObject<Pick<{
             usedAt?: string | undefined;
         }[];
         lastUsedAt?: string | undefined;
-    } | {
-        type: MfaFactor.EmailVerificationCode;
-        id: string;
-        createdAt: string;
-        lastUsedAt?: string | undefined;
-    } | {
-        type: MfaFactor.PhoneVerificationCode;
-        id: string;
-        createdAt: string;
-        lastUsedAt?: string | undefined;
     })[], z.ZodTypeDef, ({
         type: MfaFactor.TOTP;
         id: string;
@@ -295,16 +265,6 @@ export declare const userProfileResponseGuard: z.ZodObject<Pick<{
             usedAt?: string | undefined;
         }[];
         lastUsedAt?: string | undefined;
-    } | {
-        type: MfaFactor.EmailVerificationCode;
-        id: string;
-        createdAt: string;
-        lastUsedAt?: string | undefined;
-    } | {
-        type: MfaFactor.PhoneVerificationCode;
-        id: string;
-        createdAt: string;
-        lastUsedAt?: string | undefined;
     })[]>;
     isSuspended: z.ZodType<boolean, z.ZodTypeDef, boolean>;
     lastSignInAt: z.ZodType<number | null, z.ZodTypeDef, number | null>;
@@ -487,16 +447,6 @@ export declare const featuredUserGuard: z.ZodObject<Pick<{
             usedAt?: string | undefined;
         }[];
         lastUsedAt?: string | undefined;
-    } | {
-        type: MfaFactor.EmailVerificationCode;
-        id: string;
-        createdAt: string;
-        lastUsedAt?: string | undefined;
-    } | {
-        type: MfaFactor.PhoneVerificationCode;
-        id: string;
-        createdAt: string;
-        lastUsedAt?: string | undefined;
     })[], z.ZodTypeDef, ({
         type: MfaFactor.TOTP;
         id: string;
@@ -523,16 +473,6 @@ export declare const featuredUserGuard: z.ZodObject<Pick<{
             usedAt?: string | undefined;
         }[];
         lastUsedAt?: string | undefined;
-    } | {
-        type: MfaFactor.EmailVerificationCode;
-        id: string;
-        createdAt: string;
-        lastUsedAt?: string | undefined;
-    } | {
-        type: MfaFactor.PhoneVerificationCode;
-        id: string;
-        createdAt: string;
-        lastUsedAt?: string | undefined;
     })[]>;
     isSuspended: z.ZodType<boolean, z.ZodTypeDef, boolean>;
     lastSignInAt: z.ZodType<number | null, z.ZodTypeDef, number | null>;

package/lib/types/verification-records/code-verification.d.ts

@@ -2,10 +2,12 @@ import { z } from 'zod';
 import { SignInIdentifier, TemplateType } from '../../foundations/index.js';
 import { type VerificationCodeIdentifier } from '../interactions.js';
 import { VerificationType } from './verification-type.js';
-export type CodeVerificationType = VerificationType.EmailVerificationCode | VerificationType.PhoneVerificationCode;
+export type CodeVerificationType = VerificationType.EmailVerificationCode | VerificationType.PhoneVerificationCode | VerificationType.MfaEmailVerificationCode | VerificationType.MfaPhoneVerificationCode;
 type SignInIdentifierTypeOf = {
     [VerificationType.EmailVerificationCode]: SignInIdentifier.Email;
     [VerificationType.PhoneVerificationCode]: SignInIdentifier.Phone;
+    [VerificationType.MfaEmailVerificationCode]: SignInIdentifier.Email;
+    [VerificationType.MfaPhoneVerificationCode]: SignInIdentifier.Phone;
 };
 export type VerificationCodeIdentifierOf<T extends CodeVerificationType> = VerificationCodeIdentifier<SignInIdentifierTypeOf[T]>;
 /** The JSON data type for the `CodeVerification` record */
@@ -86,4 +88,74 @@ export declare const phoneCodeVerificationRecordDataGuard: z.ZodObject<{
     templateType: TemplateType;
     verified: boolean;
 }>;
+export declare const mfaEmailCodeVerificationRecordDataGuard: z.ZodObject<{
+    id: z.ZodString;
+    templateType: z.ZodNativeEnum<typeof TemplateType>;
+    verified: z.ZodBoolean;
+} & {
+    type: z.ZodLiteral<VerificationType.MfaEmailVerificationCode>;
+    identifier: z.ZodObject<{
+        type: z.ZodLiteral<SignInIdentifier.Email>;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        type: SignInIdentifier.Email;
+    }, {
+        value: string;
+        type: SignInIdentifier.Email;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: VerificationType.MfaEmailVerificationCode;
+    id: string;
+    identifier: {
+        value: string;
+        type: SignInIdentifier.Email;
+    };
+    templateType: TemplateType;
+    verified: boolean;
+}, {
+    type: VerificationType.MfaEmailVerificationCode;
+    id: string;
+    identifier: {
+        value: string;
+        type: SignInIdentifier.Email;
+    };
+    templateType: TemplateType;
+    verified: boolean;
+}>;
+export declare const mfaPhoneCodeVerificationRecordDataGuard: z.ZodObject<{
+    id: z.ZodString;
+    templateType: z.ZodNativeEnum<typeof TemplateType>;
+    verified: z.ZodBoolean;
+} & {
+    type: z.ZodLiteral<VerificationType.MfaPhoneVerificationCode>;
+    identifier: z.ZodObject<{
+        type: z.ZodLiteral<SignInIdentifier.Phone>;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        type: SignInIdentifier.Phone;
+    }, {
+        value: string;
+        type: SignInIdentifier.Phone;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: VerificationType.MfaPhoneVerificationCode;
+    id: string;
+    identifier: {
+        value: string;
+        type: SignInIdentifier.Phone;
+    };
+    templateType: TemplateType;
+    verified: boolean;
+}, {
+    type: VerificationType.MfaPhoneVerificationCode;
+    id: string;
+    identifier: {
+        value: string;
+        type: SignInIdentifier.Phone;
+    };
+    templateType: TemplateType;
+    verified: boolean;
+}>;
 export {};

package/lib/types/verification-records/code-verification.js

@@ -20,3 +20,17 @@ export const phoneCodeVerificationRecordDataGuard = basicCodeVerificationRecordD
         value: z.string(),
     }),
 });
+export const mfaEmailCodeVerificationRecordDataGuard = basicCodeVerificationRecordDataGuard.extend({
+    type: z.literal(VerificationType.MfaEmailVerificationCode),
+    identifier: z.object({
+        type: z.literal(SignInIdentifier.Email),
+        value: z.string(),
+    }),
+});
+export const mfaPhoneCodeVerificationRecordDataGuard = basicCodeVerificationRecordDataGuard.extend({
+    type: z.literal(VerificationType.MfaPhoneVerificationCode),
+    identifier: z.object({
+        type: z.literal(SignInIdentifier.Phone),
+        value: z.string(),
+    }),
+});

package/lib/types/verification-records/verification-type.d.ts

@@ -3,6 +3,8 @@ export declare enum VerificationType {
     Password = "Password",
     EmailVerificationCode = "EmailVerificationCode",
     PhoneVerificationCode = "PhoneVerificationCode",
+    MfaEmailVerificationCode = "MfaEmailVerificationCode",
+    MfaPhoneVerificationCode = "MfaPhoneVerificationCode",
     Social = "Social",
     EnterpriseSso = "EnterpriseSso",
     TOTP = "Totp",

package/lib/types/verification-records/verification-type.js

@@ -4,6 +4,8 @@ export var VerificationType;
     VerificationType["Password"] = "Password";
     VerificationType["EmailVerificationCode"] = "EmailVerificationCode";
     VerificationType["PhoneVerificationCode"] = "PhoneVerificationCode";
+    VerificationType["MfaEmailVerificationCode"] = "MfaEmailVerificationCode";
+    VerificationType["MfaPhoneVerificationCode"] = "MfaPhoneVerificationCode";
     VerificationType["Social"] = "Social";
     VerificationType["EnterpriseSso"] = "EnterpriseSso";
     VerificationType["TOTP"] = "Totp";