@logto/schemas 1.27.0 → 1.29.0

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

@@ -34,7 +34,7 @@ export type FullSignInExperience = SignInExperience & {
         siteKey: string;
     };
 };
-export declare const fullSignInExperienceGuard: z.ZodObject<z.objectUtil.extendShape<{
+export declare const fullSignInExperienceGuard: z.ZodObject<{
     tenantId: z.ZodType<string, z.ZodTypeDef, string>;
     id: z.ZodType<string, z.ZodTypeDef, string>;
     color: z.ZodType<{
@@ -135,8 +135,9 @@ export declare const fullSignInExperienceGuard: z.ZodObject<z.objectUtil.extendS
         enabled?: boolean | undefined;
     }>;
     sentinelPolicy: z.ZodType<import("../foundations/jsonb-types/sign-in-experience.js").SentinelPolicy, z.ZodTypeDef, import("../foundations/jsonb-types/sign-in-experience.js").SentinelPolicy>;
-}, {
-    socialConnectors: z.ZodArray<z.ZodObject<Omit<z.objectUtil.extendShape<{
+    emailBlocklistPolicy: z.ZodType<import("../foundations/jsonb-types/sign-in-experience.js").EmailBlocklistPolicy, z.ZodTypeDef, import("../foundations/jsonb-types/sign-in-experience.js").EmailBlocklistPolicy>;
+} & {
+    socialConnectors: z.ZodArray<z.ZodObject<Omit<{
         id: z.ZodString;
         target: z.ZodString;
         name: z.ZodType<import("@logto/connector-kit").I18nPhrases, z.ZodTypeDef, import("@logto/connector-kit").I18nPhrases>;
@@ -323,10 +324,10 @@ export declare const fullSignInExperienceGuard: z.ZodObject<z.objectUtil.extendS
         }>]>, "many">>;
         customData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
         fromEmail: z.ZodOptional<z.ZodString>;
-    }, {
+    } & {
         platform: z.ZodNullable<z.ZodNativeEnum<typeof import("@logto/connector-kit").ConnectorPlatform>>;
         isStandard: z.ZodOptional<z.ZodBoolean>;
-    }>, "customData" | "description" | "readme" | "configTemplate" | "formItems">, "strip", z.ZodTypeAny, {
+    }, "customData" | "description" | "readme" | "configTemplate" | "formItems">, "strip", z.ZodTypeAny, {
         name: {
             en: string;
         } & {
@@ -632,15 +633,15 @@ export declare const fullSignInExperienceGuard: z.ZodObject<z.objectUtil.extendS
         phone: boolean;
     }>;
     isDevelopmentTenant: z.ZodBoolean;
-    googleOneTap: z.ZodOptional<z.ZodObject<z.objectUtil.extendShape<{
+    googleOneTap: z.ZodOptional<z.ZodObject<{
         isEnabled: z.ZodOptional<z.ZodBoolean>;
         autoSelect: z.ZodOptional<z.ZodBoolean>;
         closeOnTapOutside: z.ZodOptional<z.ZodBoolean>;
         itpSupport: z.ZodOptional<z.ZodBoolean>;
-    }, {
+    } & {
         clientId: z.ZodString;
         connectorId: z.ZodString;
-    }>, "strip", z.ZodTypeAny, {
+    }, "strip", z.ZodTypeAny, {
         connectorId: string;
         clientId: string;
         isEnabled?: boolean | undefined;
@@ -665,9 +666,10 @@ export declare const fullSignInExperienceGuard: z.ZodObject<z.objectUtil.extendS
         type: CaptchaType;
         siteKey: string;
     }>>;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     id: string;
     tenantId: string;
+    mfa: import("../foundations/jsonb-types/sign-in-experience.js").Mfa;
     color: import("../foundations/jsonb-types/sign-in-experience.js").Color;
     branding: import("../foundations/jsonb-types/sign-in-experience.js").Branding;
     termsOfUseUrl: string | null;
@@ -683,13 +685,13 @@ export declare const fullSignInExperienceGuard: z.ZodObject<z.objectUtil.extendS
     customContent: import("../foundations/jsonb-types/sign-in-experience.js").CustomContent;
     customUiAssets: import("../foundations/jsonb-types/sign-in-experience.js").CustomUiAssets | null;
     passwordPolicy: import("../foundations/jsonb-types/logs.js").PartialPasswordPolicy;
-    mfa: import("../foundations/jsonb-types/sign-in-experience.js").Mfa;
     singleSignOnEnabled: boolean;
     supportEmail: string | null;
     supportWebsiteUrl: string | null;
     unknownSessionRedirectUrl: string | null;
     captchaPolicy: import("../foundations/jsonb-types/sign-in-experience.js").CaptchaPolicy;
     sentinelPolicy: import("../foundations/jsonb-types/sign-in-experience.js").SentinelPolicy;
+    emailBlocklistPolicy: import("../foundations/jsonb-types/sign-in-experience.js").EmailBlocklistPolicy;
     socialConnectors: {
         name: {
             en: string;
@@ -856,6 +858,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<z.objectUtil.extendS
 }, {
     id: string;
     tenantId: string;
+    mfa: import("../foundations/jsonb-types/sign-in-experience.js").Mfa;
     color: import("../foundations/jsonb-types/sign-in-experience.js").Color;
     branding: import("../foundations/jsonb-types/sign-in-experience.js").Branding;
     termsOfUseUrl: string | null;
@@ -871,13 +874,13 @@ export declare const fullSignInExperienceGuard: z.ZodObject<z.objectUtil.extendS
     customContent: import("../foundations/jsonb-types/sign-in-experience.js").CustomContent;
     customUiAssets: import("../foundations/jsonb-types/sign-in-experience.js").CustomUiAssets | null;
     passwordPolicy: import("../foundations/jsonb-types/logs.js").PartialPasswordPolicy;
-    mfa: import("../foundations/jsonb-types/sign-in-experience.js").Mfa;
     singleSignOnEnabled: boolean;
     supportEmail: string | null;
     supportWebsiteUrl: string | null;
     unknownSessionRedirectUrl: string | null;
     captchaPolicy: import("../foundations/jsonb-types/sign-in-experience.js").CaptchaPolicy;
     sentinelPolicy: import("../foundations/jsonb-types/sign-in-experience.js").SentinelPolicy;
+    emailBlocklistPolicy: import("../foundations/jsonb-types/sign-in-experience.js").EmailBlocklistPolicy;
     socialConnectors: {
         name: {
             en: string;

package/lib/types/sso-connector.d.ts

@@ -82,10 +82,9 @@ export declare const ssoConnectorProvidersResponseGuard: z.ZodArray<z.ZodObject<
     providerType: SsoProviderType;
 }>, "many">;
 export type SsoConnectorProvidersResponse = z.infer<typeof ssoConnectorProvidersResponseGuard>;
-export declare const ssoConnectorWithProviderConfigGuard: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+export declare const ssoConnectorWithProviderConfigGuard: z.ZodObject<{
     tenantId: z.ZodType<string, z.ZodTypeDef, string>;
     id: z.ZodType<string, z.ZodTypeDef, string>;
-    providerName: z.ZodType<string, z.ZodTypeDef, string>;
     connectorName: z.ZodType<string, z.ZodTypeDef, string>;
     config: z.ZodType<import("@withtyped/server").JsonObject, z.ZodTypeDef, import("@withtyped/server").JsonObject>;
     domains: z.ZodType<string[], z.ZodTypeDef, string[]>;
@@ -100,15 +99,15 @@ export declare const ssoConnectorWithProviderConfigGuard: z.ZodObject<z.objectUt
     }>;
     syncProfile: z.ZodType<boolean, z.ZodTypeDef, boolean>;
     createdAt: z.ZodType<number, z.ZodTypeDef, number>;
-}, {
+} & {
     providerName: z.ZodNativeEnum<typeof SsoProviderName>;
-}>, {
+} & {
     name: z.ZodString;
     providerType: z.ZodNativeEnum<typeof SsoProviderType>;
     providerLogo: z.ZodString;
     providerLogoDark: z.ZodString;
     providerConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     name: string;
     id: string;
     tenantId: string;
@@ -143,4 +142,27 @@ export type SsoConnectorWithProviderConfig = z.infer<typeof ssoConnectorWithProv
 export declare enum SsoAuthenticationQueryKey {
     SsoConnectorId = "ssoConnectorId"
 }
+export declare const extendedSocialUserInfoGuard: z.ZodObject<{
+    id: z.ZodString;
+    email: z.ZodOptional<z.ZodString>;
+    phone: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodString>;
+    avatar: z.ZodOptional<z.ZodString>;
+    rawData: z.ZodOptional<z.ZodType<import("@withtyped/server").Json, z.ZodTypeDef, import("@withtyped/server").Json>>;
+}, "strip", z.ZodUnknown, z.objectOutputType<{
+    id: z.ZodString;
+    email: z.ZodOptional<z.ZodString>;
+    phone: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodString>;
+    avatar: z.ZodOptional<z.ZodString>;
+    rawData: z.ZodOptional<z.ZodType<import("@withtyped/server").Json, z.ZodTypeDef, import("@withtyped/server").Json>>;
+}, z.ZodUnknown, "strip">, z.objectInputType<{
+    id: z.ZodString;
+    email: z.ZodOptional<z.ZodString>;
+    phone: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodString>;
+    avatar: z.ZodOptional<z.ZodString>;
+    rawData: z.ZodOptional<z.ZodType<import("@withtyped/server").Json, z.ZodTypeDef, import("@withtyped/server").Json>>;
+}, z.ZodUnknown, "strip">>;
+export type ExtendedSocialUserInfo = z.infer<typeof extendedSocialUserInfoGuard>;
 export {};

package/lib/types/sso-connector.js

@@ -1,3 +1,4 @@
+import { socialUserInfoGuard } from '@logto/connector-kit';
 import { z } from 'zod';
 import { SsoConnectors } from '../db-entries/sso-connector.js';
 /**
@@ -73,3 +74,5 @@ export var SsoAuthenticationQueryKey;
 (function (SsoAuthenticationQueryKey) {
     SsoAuthenticationQueryKey["SsoConnectorId"] = "ssoConnectorId";
 })(SsoAuthenticationQueryKey || (SsoAuthenticationQueryKey = {}));
+// Saml assertion returned user attribute value
+export const extendedSocialUserInfoGuard = socialUserInfoGuard.catchall(z.unknown());

package/lib/types/tenant.d.ts

@@ -2,3 +2,4 @@ export declare enum TenantTag {
     Development = "development",
     Production = "production"
 }
+export declare const defaultTenantIdKey = "defaultTenantId";

package/lib/types/tenant.js

@@ -5,3 +5,4 @@ export var TenantTag;
     /* A production tenant must have an associated subscription plan, even if it's a free plan. */
     TenantTag["Production"] = "production";
 })(TenantTag || (TenantTag = {}));
+export const defaultTenantIdKey = 'defaultTenantId';

package/lib/types/user.d.ts

@@ -77,6 +77,7 @@ export declare const userInfoGuard: z.ZodObject<Pick<{
         publicKey: string;
         counter: number;
         agent: string;
+        name?: string | undefined;
         lastUsedAt?: string | undefined;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
     } | {
@@ -102,6 +103,7 @@ export declare const userInfoGuard: z.ZodObject<Pick<{
         publicKey: string;
         counter: number;
         agent: string;
+        name?: string | undefined;
         lastUsedAt?: string | undefined;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
     } | {
@@ -150,7 +152,7 @@ export declare const userInfoGuard: z.ZodObject<Pick<{
     lastSignInAt: number | null;
 }>;
 export type UserInfo = z.infer<typeof userInfoGuard>;
-export declare const userProfileResponseGuard: z.ZodObject<z.objectUtil.extendShape<Pick<{
+export declare const userProfileResponseGuard: z.ZodObject<Pick<{
     tenantId: z.ZodType<string, z.ZodTypeDef, string>;
     id: z.ZodType<string, z.ZodTypeDef, string>;
     username: z.ZodType<string | null, z.ZodTypeDef, string | null>;
@@ -225,6 +227,7 @@ export declare const userProfileResponseGuard: z.ZodObject<z.objectUtil.extendSh
         publicKey: string;
         counter: number;
         agent: string;
+        name?: string | undefined;
         lastUsedAt?: string | undefined;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
     } | {
@@ -250,6 +253,7 @@ export declare const userProfileResponseGuard: z.ZodObject<z.objectUtil.extendSh
         publicKey: string;
         counter: number;
         agent: string;
+        name?: string | undefined;
         lastUsedAt?: string | undefined;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
     } | {
@@ -266,10 +270,10 @@ export declare const userProfileResponseGuard: z.ZodObject<z.objectUtil.extendSh
     lastSignInAt: z.ZodType<number | null, z.ZodTypeDef, number | null>;
     createdAt: z.ZodType<number, z.ZodTypeDef, number>;
     updatedAt: z.ZodType<number, z.ZodTypeDef, number>;
-}, "name" | "id" | "applicationId" | "username" | "createdAt" | "profile" | "avatar" | "customData" | "identities" | "updatedAt" | "primaryEmail" | "primaryPhone" | "isSuspended" | "lastSignInAt">, {
+}, "name" | "id" | "applicationId" | "username" | "createdAt" | "profile" | "avatar" | "customData" | "identities" | "updatedAt" | "primaryEmail" | "primaryPhone" | "isSuspended" | "lastSignInAt"> & {
     hasPassword: z.ZodOptional<z.ZodBoolean>;
     ssoIdentities: z.ZodOptional<z.ZodArray<import("../foundations/schemas.js").Guard<import("../db-entries/user-sso-identity.js").UserSsoIdentity>, "many">>;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     name: string | null;
     id: string;
     applicationId: string | null;
@@ -310,17 +314,20 @@ export declare const userMfaVerificationResponseGuard: z.ZodArray<z.ZodObject<{
     createdAt: z.ZodString;
     type: z.ZodNativeEnum<typeof MfaFactor>;
     agent: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodString>;
     remainCodes: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     type: MfaFactor;
     id: string;
     createdAt: string;
+    name?: string | undefined;
     agent?: string | undefined;
     remainCodes?: number | undefined;
 }, {
     type: MfaFactor;
     id: string;
     createdAt: string;
+    name?: string | undefined;
     agent?: string | undefined;
     remainCodes?: number | undefined;
 }>, "many">;
@@ -428,6 +435,7 @@ export declare const featuredUserGuard: z.ZodObject<Pick<{
         publicKey: string;
         counter: number;
         agent: string;
+        name?: string | undefined;
         lastUsedAt?: string | undefined;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
     } | {
@@ -453,6 +461,7 @@ export declare const featuredUserGuard: z.ZodObject<Pick<{
         publicKey: string;
         counter: number;
         agent: string;
+        name?: string | undefined;
         lastUsedAt?: string | undefined;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
     } | {
@@ -478,3 +487,5 @@ export declare const featuredUserGuard: z.ZodObject<Pick<{
     id: string;
     avatar: string | null;
 }>;
+export declare const consoleUserPreferenceKey = "adminConsolePreferences";
+export declare const guideRequestsKey = "guideRequests";

package/lib/types/user.js

@@ -30,6 +30,7 @@ export const userMfaVerificationResponseGuard = z
     createdAt: z.string(),
     type: z.nativeEnum(MfaFactor),
     agent: z.string().optional(),
+    name: z.string().optional(),
     remainCodes: z.number().optional(),
 })
     .array();
@@ -64,3 +65,5 @@ export const featuredUserGuard = Users.guard.pick({
     avatar: true,
     name: true,
 });
+export const consoleUserPreferenceKey = 'adminConsolePreferences';
+export const guideRequestsKey = 'guideRequests';

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

@@ -0,0 +1,29 @@
+import { z } from 'zod';
+import { VerificationType } from './verification-type.js';
+export type BackupCodeVerificationRecordData = {
+    id: string;
+    type: VerificationType.BackupCode;
+    /** UserId is required for backup code verification */
+    userId: string;
+    code?: string;
+    backupCodes?: string[];
+};
+export declare const backupCodeVerificationRecordDataGuard: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodLiteral<VerificationType.BackupCode>;
+    userId: z.ZodString;
+    code: z.ZodOptional<z.ZodString>;
+    backupCodes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    type: VerificationType.BackupCode;
+    id: string;
+    userId: string;
+    code?: string | undefined;
+    backupCodes?: string[] | undefined;
+}, {
+    type: VerificationType.BackupCode;
+    id: string;
+    userId: string;
+    code?: string | undefined;
+    backupCodes?: string[] | undefined;
+}>;

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

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+import { VerificationType } from './verification-type.js';
+export const backupCodeVerificationRecordDataGuard = z.object({
+    id: z.string(),
+    type: z.literal(VerificationType.BackupCode),
+    userId: z.string(),
+    code: z.string().optional(),
+    backupCodes: z.string().array().optional(),
+});

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

@@ -0,0 +1,89 @@
+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;
+type SignInIdentifierTypeOf = {
+    [VerificationType.EmailVerificationCode]: SignInIdentifier.Email;
+    [VerificationType.PhoneVerificationCode]: SignInIdentifier.Phone;
+};
+export type VerificationCodeIdentifierOf<T extends CodeVerificationType> = VerificationCodeIdentifier<SignInIdentifierTypeOf[T]>;
+/** The JSON data type for the `CodeVerification` record */
+export type CodeVerificationRecordData<T extends CodeVerificationType = CodeVerificationType> = {
+    id: string;
+    type: T;
+    identifier: VerificationCodeIdentifierOf<T>;
+    templateType: TemplateType;
+    verified: boolean;
+};
+export declare const emailCodeVerificationRecordDataGuard: z.ZodObject<{
+    id: z.ZodString;
+    templateType: z.ZodNativeEnum<typeof TemplateType>;
+    verified: z.ZodBoolean;
+} & {
+    type: z.ZodLiteral<VerificationType.EmailVerificationCode>;
+    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.EmailVerificationCode;
+    id: string;
+    identifier: {
+        value: string;
+        type: SignInIdentifier.Email;
+    };
+    templateType: TemplateType;
+    verified: boolean;
+}, {
+    type: VerificationType.EmailVerificationCode;
+    id: string;
+    identifier: {
+        value: string;
+        type: SignInIdentifier.Email;
+    };
+    templateType: TemplateType;
+    verified: boolean;
+}>;
+export declare const phoneCodeVerificationRecordDataGuard: z.ZodObject<{
+    id: z.ZodString;
+    templateType: z.ZodNativeEnum<typeof TemplateType>;
+    verified: z.ZodBoolean;
+} & {
+    type: z.ZodLiteral<VerificationType.PhoneVerificationCode>;
+    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.PhoneVerificationCode;
+    id: string;
+    identifier: {
+        value: string;
+        type: SignInIdentifier.Phone;
+    };
+    templateType: TemplateType;
+    verified: boolean;
+}, {
+    type: VerificationType.PhoneVerificationCode;
+    id: string;
+    identifier: {
+        value: string;
+        type: SignInIdentifier.Phone;
+    };
+    templateType: TemplateType;
+    verified: boolean;
+}>;
+export {};

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

@@ -0,0 +1,22 @@
+import { z } from 'zod';
+import { SignInIdentifier, TemplateType } from '../../foundations/index.js';
+import { VerificationType } from './verification-type.js';
+const basicCodeVerificationRecordDataGuard = z.object({
+    id: z.string(),
+    templateType: z.nativeEnum(TemplateType),
+    verified: z.boolean(),
+});
+export const emailCodeVerificationRecordDataGuard = basicCodeVerificationRecordDataGuard.extend({
+    type: z.literal(VerificationType.EmailVerificationCode),
+    identifier: z.object({
+        type: z.literal(SignInIdentifier.Email),
+        value: z.string(),
+    }),
+});
+export const phoneCodeVerificationRecordDataGuard = basicCodeVerificationRecordDataGuard.extend({
+    type: z.literal(VerificationType.PhoneVerificationCode),
+    identifier: z.object({
+        type: z.literal(SignInIdentifier.Phone),
+        value: z.string(),
+    }),
+});

package/lib/types/verification-records/enterprise-sso-verification.d.ts

@@ -0,0 +1,68 @@
+import { z } from 'zod';
+import { type ExtendedSocialUserInfo } from '../sso-connector.js';
+import { VerificationType } from './verification-type.js';
+/** The JSON data type for the EnterpriseSsoVerification record stored in the interaction storage */
+export type EnterpriseSsoVerificationRecordData = {
+    id: string;
+    connectorId: string;
+    type: VerificationType.EnterpriseSso;
+    /**
+     * The enterprise SSO identity returned by the connector.
+     */
+    enterpriseSsoUserInfo?: ExtendedSocialUserInfo;
+    issuer?: string;
+};
+export declare const enterpriseSsoVerificationRecordDataGuard: z.ZodObject<{
+    id: z.ZodString;
+    connectorId: z.ZodString;
+    type: z.ZodLiteral<VerificationType.EnterpriseSso>;
+    enterpriseSsoUserInfo: z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+        email: z.ZodOptional<z.ZodString>;
+        phone: z.ZodOptional<z.ZodString>;
+        name: z.ZodOptional<z.ZodString>;
+        avatar: z.ZodOptional<z.ZodString>;
+        rawData: z.ZodOptional<z.ZodType<import("@withtyped/server").Json, z.ZodTypeDef, import("@withtyped/server").Json>>;
+    }, "strip", z.ZodUnknown, z.objectOutputType<{
+        id: z.ZodString;
+        email: z.ZodOptional<z.ZodString>;
+        phone: z.ZodOptional<z.ZodString>;
+        name: z.ZodOptional<z.ZodString>;
+        avatar: z.ZodOptional<z.ZodString>;
+        rawData: z.ZodOptional<z.ZodType<import("@withtyped/server").Json, z.ZodTypeDef, import("@withtyped/server").Json>>;
+    }, z.ZodUnknown, "strip">, z.objectInputType<{
+        id: z.ZodString;
+        email: z.ZodOptional<z.ZodString>;
+        phone: z.ZodOptional<z.ZodString>;
+        name: z.ZodOptional<z.ZodString>;
+        avatar: z.ZodOptional<z.ZodString>;
+        rawData: z.ZodOptional<z.ZodType<import("@withtyped/server").Json, z.ZodTypeDef, import("@withtyped/server").Json>>;
+    }, z.ZodUnknown, "strip">>>;
+    issuer: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: VerificationType.EnterpriseSso;
+    id: string;
+    connectorId: string;
+    issuer?: string | undefined;
+    enterpriseSsoUserInfo?: z.objectOutputType<{
+        id: z.ZodString;
+        email: z.ZodOptional<z.ZodString>;
+        phone: z.ZodOptional<z.ZodString>;
+        name: z.ZodOptional<z.ZodString>;
+        avatar: z.ZodOptional<z.ZodString>;
+        rawData: z.ZodOptional<z.ZodType<import("@withtyped/server").Json, z.ZodTypeDef, import("@withtyped/server").Json>>;
+    }, z.ZodUnknown, "strip"> | undefined;
+}, {
+    type: VerificationType.EnterpriseSso;
+    id: string;
+    connectorId: string;
+    issuer?: string | undefined;
+    enterpriseSsoUserInfo?: z.objectInputType<{
+        id: z.ZodString;
+        email: z.ZodOptional<z.ZodString>;
+        phone: z.ZodOptional<z.ZodString>;
+        name: z.ZodOptional<z.ZodString>;
+        avatar: z.ZodOptional<z.ZodString>;
+        rawData: z.ZodOptional<z.ZodType<import("@withtyped/server").Json, z.ZodTypeDef, import("@withtyped/server").Json>>;
+    }, z.ZodUnknown, "strip"> | undefined;
+}>;

package/lib/types/verification-records/enterprise-sso-verification.js

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+import { extendedSocialUserInfoGuard } from '../sso-connector.js';
+import { VerificationType } from './verification-type.js';
+export const enterpriseSsoVerificationRecordDataGuard = z.object({
+    id: z.string(),
+    connectorId: z.string(),
+    type: z.literal(VerificationType.EnterpriseSso),
+    enterpriseSsoUserInfo: extendedSocialUserInfoGuard.optional(),
+    issuer: z.string().optional(),
+});

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

@@ -0,0 +1,16 @@
+/**
+ * This file defines the data types and guards for verification records in Logto.
+ * We keep these definitions in @logto/schemas to ensure it can be shared accross different packages.
+ *
+ * Check {@link @logto/core/src/routes/experience/classes/verifications} for the implementation of verification records.
+ */
+export * from './verification-type.js';
+export * from './backup-code-verification.js';
+export * from './code-verification.js';
+export * from './enterprise-sso-verification.js';
+export * from './new-password-identity-verification.js';
+export * from './one-time-token-verification.js';
+export * from './password-verification.js';
+export * from './social-verification.js';
+export * from './totp-verification.js';
+export * from './web-authn-verification.js';

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

@@ -0,0 +1,16 @@
+/**
+ * This file defines the data types and guards for verification records in Logto.
+ * We keep these definitions in @logto/schemas to ensure it can be shared accross different packages.
+ *
+ * Check {@link @logto/core/src/routes/experience/classes/verifications} for the implementation of verification records.
+ */
+export * from './verification-type.js';
+export * from './backup-code-verification.js';
+export * from './code-verification.js';
+export * from './enterprise-sso-verification.js';
+export * from './new-password-identity-verification.js';
+export * from './one-time-token-verification.js';
+export * from './password-verification.js';
+export * from './social-verification.js';
+export * from './totp-verification.js';
+export * from './web-authn-verification.js';

package/lib/types/verification-records/new-password-identity-verification.d.ts

@@ -0,0 +1,54 @@
+/**
+ * @deprecated
+ * This verification record type is deprecated.
+ * DO NOT use this verification record type in new code.
+ */
+import { z } from 'zod';
+import { UsersPasswordEncryptionMethod } from '../../db-entries/custom-types.js';
+import { type InteractionIdentifier } from '../interactions.js';
+import { VerificationType } from './verification-type.js';
+export type NewPasswordIdentityVerificationRecordData = {
+    id: string;
+    type: VerificationType.NewPasswordIdentity;
+    /**
+     * For now we only support username identifier for new password identity registration.
+     * For email and phone new identity registration, a `CodeVerification` record is required.
+     */
+    identifier: InteractionIdentifier;
+    passwordEncrypted?: string;
+    passwordEncryptionMethod?: UsersPasswordEncryptionMethod.Argon2i;
+};
+export declare const newPasswordIdentityVerificationRecordDataGuard: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodLiteral<VerificationType.NewPasswordIdentity>;
+    identifier: z.ZodObject<{
+        type: z.ZodNativeEnum<typeof import("../../index.js").SignInIdentifier>;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        type: import("../../index.js").SignInIdentifier;
+    }, {
+        value: string;
+        type: import("../../index.js").SignInIdentifier;
+    }>;
+    passwordEncrypted: z.ZodOptional<z.ZodString>;
+    passwordEncryptionMethod: z.ZodOptional<z.ZodLiteral<UsersPasswordEncryptionMethod.Argon2i>>;
+}, "strip", z.ZodTypeAny, {
+    type: VerificationType.NewPasswordIdentity;
+    id: string;
+    identifier: {
+        value: string;
+        type: import("../../index.js").SignInIdentifier;
+    };
+    passwordEncrypted?: string | undefined;
+    passwordEncryptionMethod?: UsersPasswordEncryptionMethod.Argon2i | undefined;
+}, {
+    type: VerificationType.NewPasswordIdentity;
+    id: string;
+    identifier: {
+        value: string;
+        type: import("../../index.js").SignInIdentifier;
+    };
+    passwordEncrypted?: string | undefined;
+    passwordEncryptionMethod?: UsersPasswordEncryptionMethod.Argon2i | undefined;
+}>;

package/lib/types/verification-records/new-password-identity-verification.js

@@ -0,0 +1,16 @@
+/**
+ * @deprecated
+ * This verification record type is deprecated.
+ * DO NOT use this verification record type in new code.
+ */
+import { z } from 'zod';
+import { UsersPasswordEncryptionMethod } from '../../db-entries/custom-types.js';
+import { interactionIdentifierGuard } from '../interactions.js';
+import { VerificationType } from './verification-type.js';
+export const newPasswordIdentityVerificationRecordDataGuard = z.object({
+    id: z.string(),
+    type: z.literal(VerificationType.NewPasswordIdentity),
+    identifier: interactionIdentifierGuard,
+    passwordEncrypted: z.string().optional(),
+    passwordEncryptionMethod: z.literal(UsersPasswordEncryptionMethod.Argon2i).optional(),
+});