@logto/schemas 1.42.0 → 1.43.0

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

@@ -12,7 +12,9 @@ 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 = Omit<SignInExperience, 'emailBlocklistPolicy' | 'forgotPasswordMethods'> & {
+export type FullSignInExperience = Omit<SignInExperience, 'emailBlocklistPolicy' | 'forgotPasswordMethods' | 'trustedDevice'> & {
+    /** Available while the MFA trusted-device feature is under development. */
+    trustedDevice?: SignInExperience['trustedDevice'];
     socialConnectors: ExperienceSocialConnector[];
     ssoConnectors: SsoConnectorMetadata[];
     forgotPassword: ForgotPassword;
@@ -71,10 +73,10 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
     hideLogtoBranding: z.ZodType<boolean, z.ZodTypeDef, boolean>;
     languageInfo: z.ZodType<{
         autoDetect: boolean;
-        fallbackLanguage: "af-ZA" | "am-ET" | "ar" | "ar-AR" | "as-IN" | "az-AZ" | "be-BY" | "bg-BG" | "bn-IN" | "br-FR" | "bs-BA" | "ca-ES" | "cb-IQ" | "co-FR" | "cs" | "cs-CZ" | "cx-PH" | "cy-GB" | "da-DK" | "de" | "de-DE" | "el-GR" | "en" | "en-GB" | "en-US" | "eo-EO" | "es" | "es-ES" | "es-419" | "et-EE" | "eu-ES" | "fa-IR" | "ff-NG" | "fi" | "fi-FI" | "fo-FO" | "fr" | "fr-CA" | "fr-FR" | "fy-NL" | "ga-IE" | "gl-ES" | "gn-PY" | "gu-IN" | "ha-NG" | "he-IL" | "hi-IN" | "hr-HR" | "ht-HT" | "hu-HU" | "hy-AM" | "id-ID" | "ik-US" | "is-IS" | "it" | "it-IT" | "iu-CA" | "ja" | "ja-JP" | "ja-KS" | "jv-ID" | "ka-GE" | "kk-KZ" | "km-KH" | "kn-IN" | "ko" | "ko-KR" | "ku-TR" | "ky-KG" | "lo-LA" | "lt-LT" | "lv-LV" | "mg-MG" | "mk-MK" | "ml-IN" | "mn-MN" | "mr-IN" | "ms-MY" | "mt-MT" | "my-MM" | "nb-NO" | "ne-NP" | "nl" | "nl-BE" | "nl-NL" | "nn-NO" | "or-IN" | "pa-IN" | "pl-PL" | "ps-AF" | "pt" | "pt-BR" | "pt-PT" | "ro-RO" | "ru" | "ru-RU" | "rw-RW" | "sc-IT" | "si-LK" | "sk-SK" | "sl-SI" | "sn-ZW" | "sq-AL" | "sr-RS" | "sv" | "sv-SE" | "sw-KE" | "sy-SY" | "sz-PL" | "ta-IN" | "te-IN" | "tg-TJ" | "th" | "th-TH" | "tl-PH" | "tr" | "tr-TR" | "tt-RU" | "tz-MA" | "uk-UA" | "ur-PK" | "uz-UZ" | "vi-VN" | "zh" | "zh-CN" | "zh-HK" | "zh-MO" | "zh-TW" | "zz-TR";
+        fallbackLanguage: "af-ZA" | "am-ET" | "ar" | "ar-AR" | "as-IN" | "az-AZ" | "be-BY" | "bg-BG" | "bn-IN" | "br-FR" | "bs-BA" | "ca-ES" | "cb-IQ" | "co-FR" | "cs" | "cs-CZ" | "cx-PH" | "cy-GB" | "da-DK" | "de" | "de-DE" | "el-GR" | "en" | "en-GB" | "en-US" | "eo-EO" | "es" | "es-ES" | "es-419" | "es-MX" | "et-EE" | "eu-ES" | "fa-IR" | "ff-NG" | "fi" | "fi-FI" | "fo-FO" | "fr" | "fr-CA" | "fr-FR" | "fy-NL" | "ga-IE" | "gl-ES" | "gn-PY" | "gu-IN" | "ha-NG" | "he-IL" | "hi-IN" | "hr-HR" | "ht-HT" | "hu-HU" | "hy-AM" | "id-ID" | "ik-US" | "is-IS" | "it" | "it-IT" | "iu-CA" | "ja" | "ja-JP" | "ja-KS" | "jv-ID" | "ka-GE" | "kk-KZ" | "km-KH" | "kn-IN" | "ko" | "ko-KR" | "ku-TR" | "ky-KG" | "lo-LA" | "lt-LT" | "lv-LV" | "mg-MG" | "mk-MK" | "ml-IN" | "mn-MN" | "mr-IN" | "ms-MY" | "mt-MT" | "my-MM" | "nb-NO" | "ne-NP" | "nl" | "nl-BE" | "nl-NL" | "nn-NO" | "or-IN" | "pa-IN" | "pl-PL" | "ps-AF" | "pt" | "pt-BR" | "pt-PT" | "ro-RO" | "ru" | "ru-RU" | "rw-RW" | "sc-IT" | "si-LK" | "sk-SK" | "sl-SI" | "sn-ZW" | "sq-AL" | "sr-RS" | "sv" | "sv-SE" | "sw-KE" | "sy-SY" | "sz-PL" | "ta-IN" | "te-IN" | "tg-TJ" | "th" | "th-TH" | "tl-PH" | "tr" | "tr-TR" | "tt-RU" | "tz-MA" | "uk-UA" | "ur-PK" | "uz-UZ" | "vi-VN" | "zh" | "zh-CN" | "zh-HK" | "zh-MO" | "zh-TW" | "zz-TR";
     }, z.ZodTypeDef, {
         autoDetect: boolean;
-        fallbackLanguage: "af-ZA" | "am-ET" | "ar" | "ar-AR" | "as-IN" | "az-AZ" | "be-BY" | "bg-BG" | "bn-IN" | "br-FR" | "bs-BA" | "ca-ES" | "cb-IQ" | "co-FR" | "cs" | "cs-CZ" | "cx-PH" | "cy-GB" | "da-DK" | "de" | "de-DE" | "el-GR" | "en" | "en-GB" | "en-US" | "eo-EO" | "es" | "es-ES" | "es-419" | "et-EE" | "eu-ES" | "fa-IR" | "ff-NG" | "fi" | "fi-FI" | "fo-FO" | "fr" | "fr-CA" | "fr-FR" | "fy-NL" | "ga-IE" | "gl-ES" | "gn-PY" | "gu-IN" | "ha-NG" | "he-IL" | "hi-IN" | "hr-HR" | "ht-HT" | "hu-HU" | "hy-AM" | "id-ID" | "ik-US" | "is-IS" | "it" | "it-IT" | "iu-CA" | "ja" | "ja-JP" | "ja-KS" | "jv-ID" | "ka-GE" | "kk-KZ" | "km-KH" | "kn-IN" | "ko" | "ko-KR" | "ku-TR" | "ky-KG" | "lo-LA" | "lt-LT" | "lv-LV" | "mg-MG" | "mk-MK" | "ml-IN" | "mn-MN" | "mr-IN" | "ms-MY" | "mt-MT" | "my-MM" | "nb-NO" | "ne-NP" | "nl" | "nl-BE" | "nl-NL" | "nn-NO" | "or-IN" | "pa-IN" | "pl-PL" | "ps-AF" | "pt" | "pt-BR" | "pt-PT" | "ro-RO" | "ru" | "ru-RU" | "rw-RW" | "sc-IT" | "si-LK" | "sk-SK" | "sl-SI" | "sn-ZW" | "sq-AL" | "sr-RS" | "sv" | "sv-SE" | "sw-KE" | "sy-SY" | "sz-PL" | "ta-IN" | "te-IN" | "tg-TJ" | "th" | "th-TH" | "tl-PH" | "tr" | "tr-TR" | "tt-RU" | "tz-MA" | "uk-UA" | "ur-PK" | "uz-UZ" | "vi-VN" | "zh" | "zh-CN" | "zh-HK" | "zh-MO" | "zh-TW" | "zz-TR";
+        fallbackLanguage: "af-ZA" | "am-ET" | "ar" | "ar-AR" | "as-IN" | "az-AZ" | "be-BY" | "bg-BG" | "bn-IN" | "br-FR" | "bs-BA" | "ca-ES" | "cb-IQ" | "co-FR" | "cs" | "cs-CZ" | "cx-PH" | "cy-GB" | "da-DK" | "de" | "de-DE" | "el-GR" | "en" | "en-GB" | "en-US" | "eo-EO" | "es" | "es-ES" | "es-419" | "es-MX" | "et-EE" | "eu-ES" | "fa-IR" | "ff-NG" | "fi" | "fi-FI" | "fo-FO" | "fr" | "fr-CA" | "fr-FR" | "fy-NL" | "ga-IE" | "gl-ES" | "gn-PY" | "gu-IN" | "ha-NG" | "he-IL" | "hi-IN" | "hr-HR" | "ht-HT" | "hu-HU" | "hy-AM" | "id-ID" | "ik-US" | "is-IS" | "it" | "it-IT" | "iu-CA" | "ja" | "ja-JP" | "ja-KS" | "jv-ID" | "ka-GE" | "kk-KZ" | "km-KH" | "kn-IN" | "ko" | "ko-KR" | "ku-TR" | "ky-KG" | "lo-LA" | "lt-LT" | "lv-LV" | "mg-MG" | "mk-MK" | "ml-IN" | "mn-MN" | "mr-IN" | "ms-MY" | "mt-MT" | "my-MM" | "nb-NO" | "ne-NP" | "nl" | "nl-BE" | "nl-NL" | "nn-NO" | "or-IN" | "pa-IN" | "pl-PL" | "ps-AF" | "pt" | "pt-BR" | "pt-PT" | "ro-RO" | "ru" | "ru-RU" | "rw-RW" | "sc-IT" | "si-LK" | "sk-SK" | "sl-SI" | "sn-ZW" | "sq-AL" | "sr-RS" | "sv" | "sv-SE" | "sw-KE" | "sy-SY" | "sz-PL" | "ta-IN" | "te-IN" | "tg-TJ" | "th" | "th-TH" | "tl-PH" | "tr" | "tr-TR" | "tt-RU" | "tz-MA" | "uk-UA" | "ur-PK" | "uz-UZ" | "vi-VN" | "zh" | "zh-CN" | "zh-HK" | "zh-MO" | "zh-TW" | "zz-TR";
     }>;
     termsOfUseUrl: z.ZodType<string | null, z.ZodTypeDef, string | null>;
     privacyPolicyUrl: z.ZodType<string | null, z.ZodTypeDef, string | null>;
@@ -139,6 +141,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
     }>;
     mfa: z.ZodType<import("../foundations/jsonb-types/sign-in-experience.js").Mfa, z.ZodTypeDef, import("../foundations/jsonb-types/sign-in-experience.js").Mfa>;
     adaptiveMfa: z.ZodType<import("../foundations/jsonb-types/sign-in-experience.js").AdaptiveMfa, z.ZodTypeDef, import("../foundations/jsonb-types/sign-in-experience.js").AdaptiveMfa>;
+    trustedDevice: z.ZodType<import("../foundations/jsonb-types/sign-in-experience.js").TrustedDevicePolicy, z.ZodTypeDef, import("../foundations/jsonb-types/sign-in-experience.js").TrustedDevicePolicy>;
     singleSignOnEnabled: z.ZodType<boolean, z.ZodTypeDef, boolean>;
     supportEmail: z.ZodType<string | null, z.ZodTypeDef, string | null>;
     supportWebsiteUrl: z.ZodType<string | null, z.ZodTypeDef, string | null>;
@@ -160,7 +163,8 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
     }[] | null>;
     passwordExpiration: z.ZodType<import("../foundations/jsonb-types/sign-in-experience.js").PasswordExpirationPolicy, z.ZodTypeDef, import("../foundations/jsonb-types/sign-in-experience.js").PasswordExpirationPolicy>;
     usernamePolicy: z.ZodType<import("../foundations/jsonb-types/index.js").UsernamePolicy, z.ZodTypeDef, import("../foundations/jsonb-types/index.js").UsernamePolicy>;
-}, "emailBlocklistPolicy" | "forgotPasswordMethods"> & {
+}, "trustedDevice" | "emailBlocklistPolicy" | "forgotPasswordMethods"> & {
+    trustedDevice: z.ZodOptional<z.ZodType<import("../foundations/jsonb-types/sign-in-experience.js").TrustedDevicePolicy, z.ZodTypeDef, import("../foundations/jsonb-types/sign-in-experience.js").TrustedDevicePolicy>>;
     socialConnectors: z.ZodArray<z.ZodObject<Omit<{
         id: z.ZodString;
         target: z.ZodString;
@@ -393,6 +397,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
             es?: string | undefined;
             "es-ES"?: string | undefined;
             "es-419"?: string | undefined;
+            "es-MX"?: string | undefined;
             "et-EE"?: string | undefined;
             "eu-ES"?: string | undefined;
             "fa-IR"?: string | undefined;
@@ -534,6 +539,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
             es?: string | undefined;
             "es-ES"?: string | undefined;
             "es-419"?: string | undefined;
+            "es-MX"?: string | undefined;
             "et-EE"?: string | undefined;
             "eu-ES"?: string | undefined;
             "fa-IR"?: string | undefined;
@@ -680,15 +686,15 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
         clientId: z.ZodString;
         connectorId: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        connectorId: string;
         clientId: string;
+        connectorId: string;
         isEnabled?: boolean | undefined;
         autoSelect?: boolean | undefined;
         closeOnTapOutside?: boolean | undefined;
         itpSupport?: boolean | undefined;
     }, {
-        connectorId: string;
         clientId: string;
+        connectorId: string;
         isEnabled?: boolean | undefined;
         autoSelect?: boolean | undefined;
         closeOnTapOutside?: boolean | undefined;
@@ -777,6 +783,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
             es?: string | undefined;
             "es-ES"?: string | undefined;
             "es-419"?: string | undefined;
+            "es-MX"?: string | undefined;
             "et-EE"?: string | undefined;
             "eu-ES"?: string | undefined;
             "fa-IR"?: string | undefined;
@@ -899,9 +906,10 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
     };
     isDevelopmentTenant: boolean;
     customProfileFields: CustomProfileField[];
+    trustedDevice?: import("../foundations/jsonb-types/sign-in-experience.js").TrustedDevicePolicy | undefined;
     googleOneTap?: {
-        connectorId: string;
         clientId: string;
+        connectorId: string;
         isEnabled?: boolean | undefined;
         autoSelect?: boolean | undefined;
         closeOnTapOutside?: boolean | undefined;
@@ -979,6 +987,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
             es?: string | undefined;
             "es-ES"?: string | undefined;
             "es-419"?: string | undefined;
+            "es-MX"?: string | undefined;
             "et-EE"?: string | undefined;
             "eu-ES"?: string | undefined;
             "fa-IR"?: string | undefined;
@@ -1101,9 +1110,10 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
     };
     isDevelopmentTenant: boolean;
     customProfileFields: CustomProfileField[];
+    trustedDevice?: import("../foundations/jsonb-types/sign-in-experience.js").TrustedDevicePolicy | undefined;
     googleOneTap?: {
-        connectorId: string;
         clientId: string;
+        connectorId: string;
         isEnabled?: boolean | undefined;
         autoSelect?: boolean | undefined;
         closeOnTapOutside?: boolean | undefined;

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

@@ -4,8 +4,9 @@ import { CustomProfileFields, SignInExperiences, } from '../db-entries/index.js'
 import { CaptchaType, RecaptchaEnterpriseMode } from '../foundations/jsonb-types/index.js';
 import { ssoConnectorMetadataGuard } from './sso-connector.js';
 export const fullSignInExperienceGuard = SignInExperiences.guard
-    .omit({ emailBlocklistPolicy: true, forgotPasswordMethods: true })
+    .omit({ emailBlocklistPolicy: true, forgotPasswordMethods: true, trustedDevice: true })
     .extend({
+    trustedDevice: SignInExperiences.guard.shape.trustedDevice.optional(),
     socialConnectors: connectorMetadataGuard
         .omit({
         description: true,

package/lib/types/system.d.ts

@@ -198,14 +198,14 @@ export declare const demoSocialDataGuard: z.ZodArray<z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     name: string;
     logo: string;
-    logoDark: string;
     clientId: string;
+    logoDark: string;
     provider: DemoSocialProvider;
 }, {
     name: string;
     logo: string;
-    logoDark: string;
     clientId: string;
+    logoDark: string;
     provider: DemoSocialProvider;
 }>, "many">;
 export type DemoSocialData = z.infer<typeof demoSocialDataGuard>;

package/lib/types/trusted-device.d.ts

@@ -0,0 +1,67 @@
+import { z } from 'zod';
+/** Public trusted-device metadata returned by user management APIs. */
+export declare const trustedDeviceResponseGuard: z.ZodObject<Pick<{
+    tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    userId: z.ZodType<string, z.ZodTypeDef, string>;
+    secretHash: z.ZodType<Buffer, z.ZodTypeDef, Buffer>;
+    userAgent: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    ip: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    country: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    city: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    createdAt: z.ZodType<number, z.ZodTypeDef, number>;
+    lastUsedAt: z.ZodType<number, z.ZodTypeDef, number>;
+    expiresAt: z.ZodType<number, z.ZodTypeDef, number>;
+}, "id" | "userAgent" | "createdAt" | "country" | "lastUsedAt" | "expiresAt" | "city">, "strip", z.ZodTypeAny, {
+    id: string;
+    userAgent: string | null;
+    createdAt: number;
+    country: string | null;
+    lastUsedAt: number;
+    expiresAt: number;
+    city: string | null;
+}, {
+    id: string;
+    userAgent: string | null;
+    createdAt: number;
+    country: string | null;
+    lastUsedAt: number;
+    expiresAt: number;
+    city: string | null;
+}>;
+export type TrustedDeviceResponse = z.infer<typeof trustedDeviceResponseGuard>;
+/** Account API trusted-device metadata with current-browser state. */
+export declare const accountTrustedDeviceResponseGuard: z.ZodObject<Pick<{
+    tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    userId: z.ZodType<string, z.ZodTypeDef, string>;
+    secretHash: z.ZodType<Buffer, z.ZodTypeDef, Buffer>;
+    userAgent: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    ip: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    country: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    city: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    createdAt: z.ZodType<number, z.ZodTypeDef, number>;
+    lastUsedAt: z.ZodType<number, z.ZodTypeDef, number>;
+    expiresAt: z.ZodType<number, z.ZodTypeDef, number>;
+}, "id" | "userAgent" | "createdAt" | "country" | "lastUsedAt" | "expiresAt" | "city"> & {
+    isCurrent: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    userAgent: string | null;
+    createdAt: number;
+    country: string | null;
+    lastUsedAt: number;
+    expiresAt: number;
+    city: string | null;
+    isCurrent: boolean;
+}, {
+    id: string;
+    userAgent: string | null;
+    createdAt: number;
+    country: string | null;
+    lastUsedAt: number;
+    expiresAt: number;
+    city: string | null;
+    isCurrent: boolean;
+}>;
+export type AccountTrustedDeviceResponse = z.infer<typeof accountTrustedDeviceResponseGuard>;

package/lib/types/trusted-device.js

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+import { TrustedDevices } from '../db-entries/index.js';
+/** Public trusted-device metadata returned by user management APIs. */
+export const trustedDeviceResponseGuard = TrustedDevices.guard.pick({
+    id: true,
+    userAgent: true,
+    country: true,
+    city: true,
+    createdAt: true,
+    lastUsedAt: true,
+    expiresAt: true,
+});
+/** Account API trusted-device metadata with current-browser state. */
+export const accountTrustedDeviceResponseGuard = trustedDeviceResponseGuard.extend({
+    isCurrent: z.boolean(),
+});