@logto/schemas 1.18.0 → 1.20.0

package/lib/types/interactions.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { MfaFactor } from '../foundations/index.js';
+import { MfaFactor, SignInIdentifier } from '../foundations/index.js';
 import type { EmailVerificationCodePayload, PhoneVerificationCodePayload } from './verification-code.js';
 /**
  * User interaction events defined in Logto RFC 0004.
@@ -10,52 +10,38 @@ export declare enum InteractionEvent {
     Register = "Register",
     ForgotPassword = "ForgotPassword"
 }
-export declare enum InteractionIdentifierType {
-    Username = "username",
-    Email = "email",
-    Phone = "phone"
-}
 /** Identifiers that can be used to uniquely identify a user. */
-export type InteractionIdentifier = {
-    type: InteractionIdentifierType;
+export type InteractionIdentifier<T extends SignInIdentifier = SignInIdentifier> = {
+    type: T;
     value: string;
 };
 export declare const interactionIdentifierGuard: z.ZodObject<{
-    type: z.ZodNativeEnum<typeof InteractionIdentifierType>;
+    type: z.ZodNativeEnum<typeof SignInIdentifier>;
     value: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    type: InteractionIdentifierType;
+    type: SignInIdentifier;
     value: string;
 }, {
-    type: InteractionIdentifierType;
+    type: SignInIdentifier;
     value: string;
 }>;
+export type VerificationCodeSignInIdentifier = SignInIdentifier.Email | SignInIdentifier.Phone;
 /** Currently only email and phone are supported for verification code validation. */
-export type VerificationCodeIdentifier = {
-    type: InteractionIdentifierType.Email | InteractionIdentifierType.Phone;
+export type VerificationCodeIdentifier<T extends VerificationCodeSignInIdentifier = VerificationCodeSignInIdentifier> = {
+    type: T;
     value: string;
 };
 export declare const verificationCodeIdentifierGuard: z.ZodObject<{
-    type: z.ZodEnum<[InteractionIdentifierType.Email, InteractionIdentifierType.Phone]>;
+    type: z.ZodEnum<[SignInIdentifier.Email, SignInIdentifier.Phone]>;
     value: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    type: InteractionIdentifierType.Email | InteractionIdentifierType.Phone;
+    type: SignInIdentifier.Email | SignInIdentifier.Phone;
     value: string;
 }, {
-    type: InteractionIdentifierType.Email | InteractionIdentifierType.Phone;
+    type: SignInIdentifier.Email | SignInIdentifier.Phone;
     value: string;
 }>;
-/** Logto supported interaction verification types. */
-export declare enum VerificationType {
-    Password = "Password",
-    VerificationCode = "VerificationCode",
-    Social = "Social",
-    EnterpriseSso = "EnterpriseSso",
-    TOTP = "Totp",
-    WebAuthn = "WebAuthn",
-    BackupCode = "BackupCode"
-}
-/** Payload type for `POST /api/experience/verification/social/:connectorId/authorization-uri`. */
+/** Payload type for `POST /api/experience/verification/{social|sso}/:connectorId/authorization-uri`. */
 export type SocialAuthorizationUrlPayload = {
     state: string;
     redirectUri: string;
@@ -70,22 +56,22 @@ export declare const socialAuthorizationUrlPayloadGuard: z.ZodObject<{
     state: string;
     redirectUri: string;
 }>;
-/** Payload type for `POST /api/experience/verification/social/:connectorId/verify`. */
+/** Payload type for `POST /api/experience/verification/{social|sso}/:connectorId/verify`. */
 export type SocialVerificationCallbackPayload = {
     /** The callback data from the social connector. */
     connectorData: Record<string, unknown>;
-    /**  The verification ID returned from the authorization URI. */
-    verificationId: string;
+    /**  The verification ID returned from the authorization URI. Optional for Google one tap callback */
+    verificationId?: string;
 };
 export declare const socialVerificationCallbackPayloadGuard: z.ZodObject<{
     connectorData: z.ZodRecord<z.ZodString, z.ZodType<import("@withtyped/server/lib/types.js").Json, z.ZodTypeDef, import("@withtyped/server/lib/types.js").Json>>;
-    verificationId: z.ZodString;
+    verificationId: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     connectorData: Record<string, import("@withtyped/server/lib/types.js").Json>;
-    verificationId: string;
+    verificationId?: string | undefined;
 }, {
     connectorData: Record<string, import("@withtyped/server/lib/types.js").Json>;
-    verificationId: string;
+    verificationId?: string | undefined;
 }>;
 /** Payload type for `POST /api/experience/verification/password`. */
 export type PasswordVerificationPayload = {
@@ -94,44 +80,137 @@ export type PasswordVerificationPayload = {
 };
 export declare const passwordVerificationPayloadGuard: z.ZodObject<{
     identifier: z.ZodObject<{
-        type: z.ZodNativeEnum<typeof InteractionIdentifierType>;
+        type: z.ZodNativeEnum<typeof SignInIdentifier>;
         value: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        type: InteractionIdentifierType;
+        type: SignInIdentifier;
         value: string;
     }, {
-        type: InteractionIdentifierType;
+        type: SignInIdentifier;
         value: string;
     }>;
     password: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     password: string;
     identifier: {
-        type: InteractionIdentifierType;
+        type: SignInIdentifier;
         value: string;
     };
 }, {
     password: string;
     identifier: {
-        type: InteractionIdentifierType;
+        type: SignInIdentifier;
         value: string;
     };
 }>;
+/** Payload type for `POST /api/experience/verification/totp/verify`. */
+export type TotpVerificationVerifyPayload = {
+    code: string;
+    verificationId?: string;
+};
+export declare const totpVerificationVerifyPayloadGuard: z.ZodObject<{
+    code: z.ZodString;
+    verificationId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    code: string;
+    verificationId?: string | undefined;
+}, {
+    code: string;
+    verificationId?: string | undefined;
+}>;
+/** Payload type for `POST /api/experience/verification/backup-code/verify */
+export type BackupCodeVerificationVerifyPayload = {
+    code: string;
+};
+export declare const backupCodeVerificationVerifyPayloadGuard: z.ZodObject<{
+    code: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    code: string;
+}, {
+    code: string;
+}>;
 /** Payload type for `POST /api/experience/identification`. */
 export type IdentificationApiPayload = {
-    interactionEvent: InteractionEvent;
-    verificationId: string;
+    /**
+     * The ID of the verification record that is used to identify the user.
+     * Optional for the register interaction event
+     */
+    verificationId?: string;
+    /**
+     * Link social identity to a related user account with the same email or phone.
+     * Only applicable for social verification records and a related user account is found.
+     */
+    linkSocialIdentity?: boolean;
 };
 export declare const identificationApiPayloadGuard: z.ZodObject<{
+    verificationId: z.ZodOptional<z.ZodString>;
+    linkSocialIdentity: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    verificationId?: string | undefined;
+    linkSocialIdentity?: boolean | undefined;
+}, {
+    verificationId?: string | undefined;
+    linkSocialIdentity?: boolean | undefined;
+}>;
+/** Payload type for `POST /api/experience`. */
+export type CreateExperienceApiPayload = {
+    interactionEvent: InteractionEvent;
+};
+export declare const CreateExperienceApiPayloadGuard: z.ZodObject<{
     interactionEvent: z.ZodNativeEnum<typeof InteractionEvent>;
-    verificationId: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    verificationId: string;
     interactionEvent: InteractionEvent;
 }, {
-    verificationId: string;
     interactionEvent: InteractionEvent;
 }>;
+/** Payload type for `POST /api/experience/profile */
+export declare const updateProfileApiPayloadGuard: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<SignInIdentifier.Username>;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: SignInIdentifier.Username;
+    value: string;
+}, {
+    type: SignInIdentifier.Username;
+    value: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"password">;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "password";
+    value: string;
+}, {
+    type: "password";
+    value: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<SignInIdentifier.Email>;
+    verificationId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: SignInIdentifier.Email;
+    verificationId: string;
+}, {
+    type: SignInIdentifier.Email;
+    verificationId: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<SignInIdentifier.Phone>;
+    verificationId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: SignInIdentifier.Phone;
+    verificationId: string;
+}, {
+    type: SignInIdentifier.Phone;
+    verificationId: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"social">;
+    verificationId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "social";
+    verificationId: string;
+}, {
+    type: "social";
+    verificationId: string;
+}>]>;
+export type UpdateProfileApiPayload = z.infer<typeof updateProfileApiPayloadGuard>;
 /**
  * Legacy interaction identifier payload guard
  *
@@ -294,14 +373,14 @@ export declare const profileGuard: z.ZodObject<{
     username?: string | undefined;
     email?: string | undefined;
     phone?: string | undefined;
-    connectorId?: string | undefined;
     password?: string | undefined;
+    connectorId?: string | undefined;
 }, {
     username?: string | undefined;
     email?: string | undefined;
     phone?: string | undefined;
-    connectorId?: string | undefined;
     password?: string | undefined;
+    connectorId?: string | undefined;
 }>;
 export type Profile = z.infer<typeof profileGuard>;
 export declare enum MissingProfile {
@@ -341,17 +420,17 @@ export declare const bindWebAuthnPayloadGuard: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         clientDataJSON: string;
         attestationObject: string;
-        authenticatorData?: string | undefined;
+        publicKey?: string | undefined;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
+        authenticatorData?: string | undefined;
         publicKeyAlgorithm?: number | undefined;
-        publicKey?: string | undefined;
     }, {
         clientDataJSON: string;
         attestationObject: string;
-        authenticatorData?: string | undefined;
+        publicKey?: string | undefined;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
+        authenticatorData?: string | undefined;
         publicKeyAlgorithm?: number | undefined;
-        publicKey?: string | undefined;
     }>;
     authenticatorAttachment: z.ZodOptional<z.ZodEnum<["cross-platform", "platform"]>>;
     clientExtensionResults: z.ZodObject<{
@@ -384,10 +463,10 @@ export declare const bindWebAuthnPayloadGuard: z.ZodObject<{
     response: {
         clientDataJSON: string;
         attestationObject: string;
-        authenticatorData?: string | undefined;
+        publicKey?: string | undefined;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
+        authenticatorData?: string | undefined;
         publicKeyAlgorithm?: number | undefined;
-        publicKey?: string | undefined;
     };
     clientExtensionResults: {
         appid?: boolean | undefined;
@@ -404,10 +483,10 @@ export declare const bindWebAuthnPayloadGuard: z.ZodObject<{
     response: {
         clientDataJSON: string;
         attestationObject: string;
-        authenticatorData?: string | undefined;
+        publicKey?: string | undefined;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
+        authenticatorData?: string | undefined;
         publicKeyAlgorithm?: number | undefined;
-        publicKey?: string | undefined;
     };
     clientExtensionResults: {
         appid?: boolean | undefined;
@@ -455,17 +534,17 @@ export declare const bindMfaPayloadGuard: z.ZodDiscriminatedUnion<"type", [z.Zod
     }, "strip", z.ZodTypeAny, {
         clientDataJSON: string;
         attestationObject: string;
-        authenticatorData?: string | undefined;
+        publicKey?: string | undefined;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
+        authenticatorData?: string | undefined;
         publicKeyAlgorithm?: number | undefined;
-        publicKey?: string | undefined;
     }, {
         clientDataJSON: string;
         attestationObject: string;
-        authenticatorData?: string | undefined;
+        publicKey?: string | undefined;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
+        authenticatorData?: string | undefined;
         publicKeyAlgorithm?: number | undefined;
-        publicKey?: string | undefined;
     }>;
     authenticatorAttachment: z.ZodOptional<z.ZodEnum<["cross-platform", "platform"]>>;
     clientExtensionResults: z.ZodObject<{
@@ -498,10 +577,10 @@ export declare const bindMfaPayloadGuard: z.ZodDiscriminatedUnion<"type", [z.Zod
     response: {
         clientDataJSON: string;
         attestationObject: string;
-        authenticatorData?: string | undefined;
+        publicKey?: string | undefined;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
+        authenticatorData?: string | undefined;
         publicKeyAlgorithm?: number | undefined;
-        publicKey?: string | undefined;
     };
     clientExtensionResults: {
         appid?: boolean | undefined;
@@ -518,10 +597,10 @@ export declare const bindMfaPayloadGuard: z.ZodDiscriminatedUnion<"type", [z.Zod
     response: {
         clientDataJSON: string;
         attestationObject: string;
-        authenticatorData?: string | undefined;
+        publicKey?: string | undefined;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
+        authenticatorData?: string | undefined;
         publicKeyAlgorithm?: number | undefined;
-        publicKey?: string | undefined;
     };
     clientExtensionResults: {
         appid?: boolean | undefined;
@@ -539,6 +618,7 @@ export declare const bindMfaPayloadGuard: z.ZodDiscriminatedUnion<"type", [z.Zod
     type: MfaFactor.BackupCode;
 }>]>;
 export type BindMfaPayload = z.infer<typeof bindMfaPayloadGuard>;
+/** @deprecated  Legacy interaction API use only */
 export declare const totpVerificationPayloadGuard: z.ZodObject<{
     type: z.ZodLiteral<MfaFactor.TOTP>;
     code: z.ZodString;
@@ -549,11 +629,39 @@ export declare const totpVerificationPayloadGuard: z.ZodObject<{
     code: string;
     type: MfaFactor.TOTP;
 }>;
+/** @deprecated Legacy interaction API use only */
 export type TotpVerificationPayload = z.infer<typeof totpVerificationPayloadGuard>;
-export declare const webAuthnVerificationPayloadGuard: z.ZodObject<{
+export declare const webAuthnVerificationPayloadGuard: z.ZodObject<z.objectUtil.extendShape<Omit<{
     type: z.ZodLiteral<MfaFactor.WebAuthn>;
     id: z.ZodString;
     rawId: z.ZodString;
+    /**
+     * The response from WebAuthn API
+     *
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/PublicKeyCredential}
+     */
+    response: z.ZodObject<{
+        clientDataJSON: z.ZodString;
+        attestationObject: z.ZodString;
+        authenticatorData: z.ZodOptional<z.ZodString>;
+        transports: z.ZodOptional<z.ZodArray<z.ZodEnum<["usb", "nfc", "ble", "internal", "cable", "hybrid", "smart-card"]>, "many">>;
+        publicKeyAlgorithm: z.ZodOptional<z.ZodNumber>;
+        publicKey: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        clientDataJSON: string;
+        attestationObject: string;
+        publicKey?: string | undefined;
+        transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
+        authenticatorData?: string | undefined;
+        publicKeyAlgorithm?: number | undefined;
+    }, {
+        clientDataJSON: string;
+        attestationObject: string;
+        publicKey?: string | undefined;
+        transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
+        authenticatorData?: string | undefined;
+        publicKeyAlgorithm?: number | undefined;
+    }>;
     authenticatorAttachment: z.ZodOptional<z.ZodEnum<["cross-platform", "platform"]>>;
     clientExtensionResults: z.ZodObject<{
         appid: z.ZodOptional<z.ZodBoolean>;
@@ -578,6 +686,7 @@ export declare const webAuthnVerificationPayloadGuard: z.ZodObject<{
         } | undefined;
         hmacCreateSecret?: boolean | undefined;
     }>;
+}, "response">, {
     response: z.ZodObject<{
         clientDataJSON: z.ZodString;
         authenticatorData: z.ZodString;
@@ -594,7 +703,7 @@ export declare const webAuthnVerificationPayloadGuard: z.ZodObject<{
         signature: string;
         userHandle?: string | undefined;
     }>;
-}, "strip", z.ZodTypeAny, {
+}>, "strip", z.ZodTypeAny, {
     type: MfaFactor.WebAuthn;
     id: string;
     rawId: string;
@@ -652,10 +761,37 @@ export declare const verifyMfaPayloadGuard: z.ZodDiscriminatedUnion<"type", [z.Z
 }, {
     code: string;
     type: MfaFactor.TOTP;
-}>, z.ZodObject<{
+}>, z.ZodObject<z.objectUtil.extendShape<Omit<{
     type: z.ZodLiteral<MfaFactor.WebAuthn>;
     id: z.ZodString;
     rawId: z.ZodString;
+    /**
+     * The response from WebAuthn API
+     *
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/PublicKeyCredential}
+     */
+    response: z.ZodObject<{
+        clientDataJSON: z.ZodString;
+        attestationObject: z.ZodString;
+        authenticatorData: z.ZodOptional<z.ZodString>;
+        transports: z.ZodOptional<z.ZodArray<z.ZodEnum<["usb", "nfc", "ble", "internal", "cable", "hybrid", "smart-card"]>, "many">>;
+        publicKeyAlgorithm: z.ZodOptional<z.ZodNumber>;
+        publicKey: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        clientDataJSON: string;
+        attestationObject: string;
+        publicKey?: string | undefined;
+        transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
+        authenticatorData?: string | undefined;
+        publicKeyAlgorithm?: number | undefined;
+    }, {
+        clientDataJSON: string;
+        attestationObject: string;
+        publicKey?: string | undefined;
+        transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
+        authenticatorData?: string | undefined;
+        publicKeyAlgorithm?: number | undefined;
+    }>;
     authenticatorAttachment: z.ZodOptional<z.ZodEnum<["cross-platform", "platform"]>>;
     clientExtensionResults: z.ZodObject<{
         appid: z.ZodOptional<z.ZodBoolean>;
@@ -680,6 +816,7 @@ export declare const verifyMfaPayloadGuard: z.ZodDiscriminatedUnion<"type", [z.Z
         } | undefined;
         hmacCreateSecret?: boolean | undefined;
     }>;
+}, "response">, {
     response: z.ZodObject<{
         clientDataJSON: z.ZodString;
         authenticatorData: z.ZodString;
@@ -696,7 +833,7 @@ export declare const verifyMfaPayloadGuard: z.ZodDiscriminatedUnion<"type", [z.Z
         signature: string;
         userHandle?: string | undefined;
     }>;
-}, "strip", z.ZodTypeAny, {
+}>, "strip", z.ZodTypeAny, {
     type: MfaFactor.WebAuthn;
     id: string;
     rawId: string;

package/lib/types/interactions.js

@@ -1,6 +1,6 @@
 import { emailRegEx, phoneRegEx, usernameRegEx } from '@logto/core-kit';
 import { z } from 'zod';
-import { MfaFactor, jsonObjectGuard, webAuthnTransportGuard } from '../foundations/index.js';
+import { MfaFactor, SignInIdentifier, jsonObjectGuard, webAuthnTransportGuard, } from '../foundations/index.js';
 import { emailVerificationCodePayloadGuard, phoneVerificationCodePayloadGuard, } from './verification-code.js';
 /**
  * User interaction events defined in Logto RFC 0004.
@@ -12,48 +12,63 @@ export var InteractionEvent;
     InteractionEvent["Register"] = "Register";
     InteractionEvent["ForgotPassword"] = "ForgotPassword";
 })(InteractionEvent || (InteractionEvent = {}));
-// ====== Experience API payload guards and type definitions start ======
-export var InteractionIdentifierType;
-(function (InteractionIdentifierType) {
-    InteractionIdentifierType["Username"] = "username";
-    InteractionIdentifierType["Email"] = "email";
-    InteractionIdentifierType["Phone"] = "phone";
-})(InteractionIdentifierType || (InteractionIdentifierType = {}));
 export const interactionIdentifierGuard = z.object({
-    type: z.nativeEnum(InteractionIdentifierType),
+    type: z.nativeEnum(SignInIdentifier),
     value: z.string(),
 });
 export const verificationCodeIdentifierGuard = z.object({
-    type: z.enum([InteractionIdentifierType.Email, InteractionIdentifierType.Phone]),
+    type: z.enum([SignInIdentifier.Email, SignInIdentifier.Phone]),
     value: z.string(),
 });
-/** Logto supported interaction verification types. */
-export var VerificationType;
-(function (VerificationType) {
-    VerificationType["Password"] = "Password";
-    VerificationType["VerificationCode"] = "VerificationCode";
-    VerificationType["Social"] = "Social";
-    VerificationType["EnterpriseSso"] = "EnterpriseSso";
-    VerificationType["TOTP"] = "Totp";
-    VerificationType["WebAuthn"] = "WebAuthn";
-    VerificationType["BackupCode"] = "BackupCode";
-})(VerificationType || (VerificationType = {}));
 export const socialAuthorizationUrlPayloadGuard = z.object({
     state: z.string(),
     redirectUri: z.string(),
 });
 export const socialVerificationCallbackPayloadGuard = z.object({
     connectorData: jsonObjectGuard,
-    verificationId: z.string(),
+    verificationId: z.string().optional(),
 });
 export const passwordVerificationPayloadGuard = z.object({
     identifier: interactionIdentifierGuard,
     password: z.string().min(1),
 });
+export const totpVerificationVerifyPayloadGuard = z.object({
+    code: z.string().min(1),
+    verificationId: z.string().optional(),
+});
+export const backupCodeVerificationVerifyPayloadGuard = z.object({
+    code: z.string().min(1),
+});
 export const identificationApiPayloadGuard = z.object({
+    verificationId: z.string().optional(),
+    linkSocialIdentity: z.boolean().optional(),
+});
+export const CreateExperienceApiPayloadGuard = z.object({
     interactionEvent: z.nativeEnum(InteractionEvent),
-    verificationId: z.string(),
 });
+/** Payload type for `POST /api/experience/profile */
+export const updateProfileApiPayloadGuard = z.discriminatedUnion('type', [
+    z.object({
+        type: z.literal(SignInIdentifier.Username),
+        value: z.string().regex(usernameRegEx),
+    }),
+    z.object({
+        type: z.literal('password'),
+        value: z.string(),
+    }),
+    z.object({
+        type: z.literal(SignInIdentifier.Email),
+        verificationId: z.string(),
+    }),
+    z.object({
+        type: z.literal(SignInIdentifier.Phone),
+        verificationId: z.string(),
+    }),
+    z.object({
+        type: z.literal('social'),
+        verificationId: z.string(),
+    }),
+]);
 // ====== Experience API payload guard and types definitions end ======
 /**
  * Legacy interaction identifier payload guard
@@ -158,6 +173,7 @@ export const bindMfaPayloadGuard = z.discriminatedUnion('type', [
     bindWebAuthnPayloadGuard,
     bindBackupCodePayloadGuard,
 ]);
+/** @deprecated  Legacy interaction API use only */
 export const totpVerificationPayloadGuard = bindTotpPayloadGuard;
 export const webAuthnVerificationPayloadGuard = bindWebAuthnPayloadGuard
     .omit({ response: true })

package/lib/types/log/interaction.d.ts

@@ -1,4 +1,4 @@
-import { type MfaFactor } from '../../foundations/index.js';
+import { type VerificationType, type MfaFactor } from '../../foundations/index.js';
 import type { InteractionEvent } from '../interactions.js';
 export type Prefix = 'Interaction';
 export declare const prefix: Prefix;
@@ -8,7 +8,8 @@ export declare enum Field {
     Identifier = "Identifier",
     Profile = "Profile",
     BindMfa = "BindMfa",
-    Mfa = "Mfa"
+    Mfa = "Mfa",
+    Verification = "Verification"
 }
 /** Method to verify the identifier */
 export declare enum Method {
@@ -66,4 +67,4 @@ export declare enum Action {
  *   - When {@link Method} is `VerificationCode`, {@link Action} can be `Create` (generate and send a code) or `Submit` (verify and submit to the identifiers);
  *   - Otherwise, {@link Action} is fixed to `Submit` (other methods can be verified on submitting).
  */
-export type LogKey = `${Prefix}.${Action.Create | Action.End}` | `${Prefix}.${InteractionEvent}.${Action.Update | Action.Submit}` | `${Prefix}.${InteractionEvent}.${Field.Profile}.${Action.Update | Action.Create | Action.Delete}` | `${Prefix}.${Exclude<InteractionEvent, InteractionEvent.ForgotPassword>}.${Field.Identifier}.${Exclude<Method, Method.Password>}.${Action.Create | Action.Submit}` | `${Prefix}.${Exclude<InteractionEvent, InteractionEvent.ForgotPassword>}.${Field.Identifier}.${Method.Password}.${Action.Submit}` | `${Prefix}.${InteractionEvent.ForgotPassword}.${Field.Identifier}.${Method.VerificationCode}.${Action.Create | Action.Submit}` | `${Prefix}.${InteractionEvent}.${Field.BindMfa}.${MfaFactor}.${Action.Submit | Action.Create}` | `${Prefix}.${InteractionEvent.SignIn}.${Field.Mfa}.${MfaFactor}.${Action.Submit | Action.Create}`;
+export type LogKey = `${Prefix}.${Action.Create | Action.End}` | `${Prefix}.${InteractionEvent}.${Action.Create | Action.Update | Action.Submit}` | `${Prefix}.${InteractionEvent}.${Field.Profile}.${Action.Update | Action.Create | Action.Delete}` | `${Prefix}.${Exclude<InteractionEvent, InteractionEvent.ForgotPassword>}.${Field.Identifier}.${Exclude<Method, Method.Password>}.${Action.Create | Action.Submit}` | `${Prefix}.${Exclude<InteractionEvent, InteractionEvent.ForgotPassword>}.${Field.Identifier}.${Method.Password}.${Action.Submit}` | `${Prefix}.${InteractionEvent.ForgotPassword}.${Field.Identifier}.${Method.VerificationCode}.${Action.Create | Action.Submit}` | `${Prefix}.${InteractionEvent}.${Field.BindMfa}.${MfaFactor}.${Action.Submit | Action.Create}` | `${Prefix}.${InteractionEvent.SignIn}.${Field.Mfa}.${MfaFactor}.${Action.Submit | Action.Create}` | `${Prefix}.${InteractionEvent}.${Field.Verification}.${VerificationType}.${Action}` | `${Prefix}.${InteractionEvent}.${Field.Identifier}.${Action.Submit}`;

package/lib/types/log/interaction.js

@@ -7,6 +7,7 @@ export var Field;
     Field["Profile"] = "Profile";
     Field["BindMfa"] = "BindMfa";
     Field["Mfa"] = "Mfa";
+    Field["Verification"] = "Verification";
 })(Field || (Field = {}));
 /** Method to verify the identifier */
 export var Method;