@logto/schemas 1.42.0 → 1.44.0

package/lib/types/logto-config/index.d.ts

@@ -127,8 +127,8 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
             kind?: "AccessToken" | undefined;
             accountId?: string | undefined;
             scope?: string | undefined;
-            sessionUid?: string | undefined;
             clientId?: string | undefined;
+            sessionUid?: string | undefined;
             expiresWithSession?: boolean | undefined;
             gty?: string | undefined;
             aud?: string | string[] | undefined;
@@ -139,8 +139,8 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
             kind?: "AccessToken" | undefined;
             accountId?: string | undefined;
             scope?: string | undefined;
-            sessionUid?: string | undefined;
             clientId?: string | undefined;
+            sessionUid?: string | undefined;
             expiresWithSession?: boolean | undefined;
             gty?: string | undefined;
             aud?: string | string[] | undefined;
@@ -150,6 +150,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                 name: z.ZodOptional<ZodType<string | null, z.ZodTypeDef, string | null>>;
                 id: z.ZodOptional<ZodType<string, z.ZodTypeDef, string>>;
                 applicationId: z.ZodOptional<ZodType<string | null, z.ZodTypeDef, string | null>>;
+                cimdClientId: z.ZodOptional<ZodType<string | null, z.ZodTypeDef, string | null>>;
                 username: z.ZodOptional<ZodType<string | null, z.ZodTypeDef, string | null>>;
                 createdAt: z.ZodOptional<ZodType<number, z.ZodTypeDef, number>>;
                 profile: z.ZodOptional<ZodType<Partial<{
@@ -288,6 +289,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     description: ZodType<string | null, z.ZodTypeDef, string | null>;
                     customData: ZodType<import("@withtyped/server").JsonObject, z.ZodTypeDef, import("@withtyped/server").JsonObject>;
                     isMfaRequired: ZodType<boolean, z.ZodTypeDef, boolean>;
+                    isTrustedDeviceAllowed: ZodType<boolean, z.ZodTypeDef, boolean>;
                     color: ZodType<Partial<{
                         primaryColor: string;
                         isDarkModeEnabled: boolean;
@@ -336,6 +338,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                 name?: string | null | undefined;
                 id?: string | undefined;
                 applicationId?: string | null | undefined;
+                cimdClientId?: string | null | undefined;
                 username?: string | null | undefined;
                 createdAt?: number | undefined;
                 profile?: Partial<{
@@ -403,6 +406,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                 name?: string | null | undefined;
                 id?: string | undefined;
                 applicationId?: string | null | undefined;
+                cimdClientId?: string | null | undefined;
                 username?: string | null | undefined;
                 createdAt?: number | undefined;
                 profile?: Partial<{
@@ -514,6 +518,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     id: z.ZodString;
                     templateType: z.ZodNativeEnum<typeof import("@logto/connector-kit").TemplateType>;
                     verified: z.ZodBoolean;
+                    userId: z.ZodOptional<z.ZodString>;
                 } & {
                     type: z.ZodLiteral<import("../index.js").VerificationType.EmailVerificationCode>;
                     identifier: z.ZodObject<{
@@ -535,6 +540,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 }, {
                     type: import("../index.js").VerificationType.EmailVerificationCode;
                     id: string;
@@ -544,10 +550,12 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 }>, z.ZodObject<{
                     id: z.ZodString;
                     templateType: z.ZodNativeEnum<typeof import("@logto/connector-kit").TemplateType>;
                     verified: z.ZodBoolean;
+                    userId: z.ZodOptional<z.ZodString>;
                 } & {
                     type: z.ZodLiteral<import("../index.js").VerificationType.PhoneVerificationCode>;
                     identifier: z.ZodObject<{
@@ -569,6 +577,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 }, {
                     type: import("../index.js").VerificationType.PhoneVerificationCode;
                     id: string;
@@ -578,10 +587,12 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 }>, z.ZodObject<{
                     id: z.ZodString;
                     templateType: z.ZodNativeEnum<typeof import("@logto/connector-kit").TemplateType>;
                     verified: z.ZodBoolean;
+                    userId: z.ZodOptional<z.ZodString>;
                 } & {
                     type: z.ZodLiteral<import("../index.js").VerificationType.MfaEmailVerificationCode>;
                     identifier: z.ZodObject<{
@@ -603,6 +614,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 }, {
                     type: import("../index.js").VerificationType.MfaEmailVerificationCode;
                     id: string;
@@ -612,10 +624,12 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 }>, z.ZodObject<{
                     id: z.ZodString;
                     templateType: z.ZodNativeEnum<typeof import("@logto/connector-kit").TemplateType>;
                     verified: z.ZodBoolean;
+                    userId: z.ZodOptional<z.ZodString>;
                 } & {
                     type: z.ZodLiteral<import("../index.js").VerificationType.MfaPhoneVerificationCode>;
                     identifier: z.ZodObject<{
@@ -637,6 +651,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 }, {
                     type: import("../index.js").VerificationType.MfaPhoneVerificationCode;
                     id: string;
@@ -646,6 +661,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 }>, z.ZodObject<Omit<{
                     id: z.ZodString;
                     connectorId: z.ZodString;
@@ -1034,6 +1050,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.PhoneVerificationCode;
                     id: string;
@@ -1043,6 +1060,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.MfaEmailVerificationCode;
                     id: string;
@@ -1052,6 +1070,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.MfaPhoneVerificationCode;
                     id: string;
@@ -1061,6 +1080,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.NewPasswordIdentity;
                     id: string;
@@ -1149,6 +1169,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.PhoneVerificationCode;
                     id: string;
@@ -1158,6 +1179,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.MfaEmailVerificationCode;
                     id: string;
@@ -1167,6 +1189,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.MfaPhoneVerificationCode;
                     id: string;
@@ -1176,6 +1199,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.NewPasswordIdentity;
                     id: string;
@@ -1469,6 +1493,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                 name?: string | null | undefined;
                 id?: string | undefined;
                 applicationId?: string | null | undefined;
+                cimdClientId?: string | null | undefined;
                 username?: string | null | undefined;
                 createdAt?: number | undefined;
                 profile?: Partial<{
@@ -1614,6 +1639,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.PhoneVerificationCode;
                     id: string;
@@ -1623,6 +1649,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.MfaEmailVerificationCode;
                     id: string;
@@ -1632,6 +1659,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.MfaPhoneVerificationCode;
                     id: string;
@@ -1641,6 +1669,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.NewPasswordIdentity;
                     id: string;
@@ -1718,6 +1747,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                 name?: string | null | undefined;
                 id?: string | undefined;
                 applicationId?: string | null | undefined;
+                cimdClientId?: string | null | undefined;
                 username?: string | null | undefined;
                 createdAt?: number | undefined;
                 profile?: Partial<{
@@ -1863,6 +1893,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.PhoneVerificationCode;
                     id: string;
@@ -1872,6 +1903,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.MfaEmailVerificationCode;
                     id: string;
@@ -1881,6 +1913,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.MfaPhoneVerificationCode;
                     id: string;
@@ -1890,6 +1923,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.NewPasswordIdentity;
                     id: string;
@@ -1971,6 +2005,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                 name?: string | null | undefined;
                 id?: string | undefined;
                 applicationId?: string | null | undefined;
+                cimdClientId?: string | null | undefined;
                 username?: string | null | undefined;
                 createdAt?: number | undefined;
                 profile?: Partial<{
@@ -2116,6 +2151,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.PhoneVerificationCode;
                     id: string;
@@ -2125,6 +2161,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.MfaEmailVerificationCode;
                     id: string;
@@ -2134,6 +2171,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.MfaPhoneVerificationCode;
                     id: string;
@@ -2143,6 +2181,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.NewPasswordIdentity;
                     id: string;
@@ -2224,8 +2263,8 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
             kind?: "AccessToken" | undefined;
             accountId?: string | undefined;
             scope?: string | undefined;
-            sessionUid?: string | undefined;
             clientId?: string | undefined;
+            sessionUid?: string | undefined;
             expiresWithSession?: boolean | undefined;
             gty?: string | undefined;
             aud?: string | string[] | undefined;
@@ -2238,6 +2277,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                 name?: string | null | undefined;
                 id?: string | undefined;
                 applicationId?: string | null | undefined;
+                cimdClientId?: string | null | undefined;
                 username?: string | null | undefined;
                 createdAt?: number | undefined;
                 profile?: Partial<{
@@ -2383,6 +2423,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.PhoneVerificationCode;
                     id: string;
@@ -2392,6 +2433,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.MfaEmailVerificationCode;
                     id: string;
@@ -2401,6 +2443,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.MfaPhoneVerificationCode;
                     id: string;
@@ -2410,6 +2453,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.NewPasswordIdentity;
                     id: string;
@@ -2491,8 +2535,8 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
             kind?: "AccessToken" | undefined;
             accountId?: string | undefined;
             scope?: string | undefined;
-            sessionUid?: string | undefined;
             clientId?: string | undefined;
+            sessionUid?: string | undefined;
             expiresWithSession?: boolean | undefined;
             gty?: string | undefined;
             aud?: string | string[] | undefined;
@@ -2507,6 +2551,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                 name?: string | null | undefined;
                 id?: string | undefined;
                 applicationId?: string | null | undefined;
+                cimdClientId?: string | null | undefined;
                 username?: string | null | undefined;
                 createdAt?: number | undefined;
                 profile?: Partial<{
@@ -2652,6 +2697,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.PhoneVerificationCode;
                     id: string;
@@ -2661,6 +2707,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.MfaEmailVerificationCode;
                     id: string;
@@ -2670,6 +2717,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.MfaPhoneVerificationCode;
                     id: string;
@@ -2679,6 +2727,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.NewPasswordIdentity;
                     id: string;
@@ -2760,8 +2809,8 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
             kind?: "AccessToken" | undefined;
             accountId?: string | undefined;
             scope?: string | undefined;
-            sessionUid?: string | undefined;
             clientId?: string | undefined;
+            sessionUid?: string | undefined;
             expiresWithSession?: boolean | undefined;
             gty?: string | undefined;
             aud?: string | string[] | undefined;
@@ -2777,6 +2826,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                 name?: string | null | undefined;
                 id?: string | undefined;
                 applicationId?: string | null | undefined;
+                cimdClientId?: string | null | undefined;
                 username?: string | null | undefined;
                 createdAt?: number | undefined;
                 profile?: Partial<{
@@ -2922,6 +2972,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.PhoneVerificationCode;
                     id: string;
@@ -2931,6 +2982,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.MfaEmailVerificationCode;
                     id: string;
@@ -2940,6 +2992,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.MfaPhoneVerificationCode;
                     id: string;
@@ -2949,6 +3002,7 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
                     };
                     templateType: import("@logto/connector-kit").TemplateType;
                     verified: boolean;
+                    userId?: string | undefined;
                 } | {
                     type: import("../index.js").VerificationType.NewPasswordIdentity;
                     id: string;
@@ -3030,8 +3084,8 @@ export declare const jwtCustomizerConfigsGuard: z.ZodDiscriminatedUnion<"key", [
             kind?: "AccessToken" | undefined;
             accountId?: string | undefined;
             scope?: string | undefined;
-            sessionUid?: string | undefined;
             clientId?: string | undefined;
+            sessionUid?: string | undefined;
             expiresWithSession?: boolean | undefined;
             gty?: string | undefined;
             aud?: string | string[] | undefined;
@@ -3754,6 +3808,25 @@ export declare const signingKeyRotationStateGuard: z.ZodObject<{
     signingKeyRotationAt?: number | undefined;
 }>;
 export type SigningKeyRotationState = z.infer<typeof signingKeyRotationStateGuard>;
+/**
+ * Config for the OAuth Client ID Metadata Document (CIMD) feature. The row is only written once
+ * the feature is toggled, so readers must fall back to {@link defaultCimdConfig}.
+ */
+export declare const cimdConfigGuard: z.ZodObject<{
+    enabled: z.ZodBoolean;
+    addConsentPromptForOfflineAccess: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    enabled: boolean;
+    addConsentPromptForOfflineAccess?: boolean | undefined;
+}, {
+    enabled: boolean;
+    addConsentPromptForOfflineAccess?: boolean | undefined;
+}>;
+export type CimdConfig = z.infer<typeof cimdConfigGuard>;
+/** Applied when the `cimd` row is absent: the feature is opt-in per tenant. */
+export declare const defaultCimdConfig: Readonly<{
+    enabled: false;
+}>;
 export declare enum LogtoTenantConfigKey {
     AdminConsole = "adminConsole",
     CloudConnection = "cloudConnection",
@@ -3764,7 +3837,9 @@ export declare enum LogtoTenantConfigKey {
     /** Tenant-scoped rotation state for staged private signing key activation. */
     SigningKeyRotationState = "signingKeyRotationState",
     /** Internal, ops-only override of the system message send-rate-limit policy. Not exposed by any API. */
-    MessageRateLimitOverride = "messageRateLimitOverride"
+    MessageRateLimitOverride = "messageRateLimitOverride",
+    /** Tenant-level switch for the OAuth Client ID Metadata Document feature. */
+    Cimd = "cimd"
 }
 export type LogtoTenantConfigType = {
     [LogtoTenantConfigKey.AdminConsole]: AdminConsoleData;
@@ -3775,6 +3850,7 @@ export type LogtoTenantConfigType = {
     [LogtoTenantConfigKey.IdToken]: IdTokenConfig;
     [LogtoTenantConfigKey.SigningKeyRotationState]: SigningKeyRotationState;
     [LogtoTenantConfigKey.MessageRateLimitOverride]: MessageRateLimitOverride;
+    [LogtoTenantConfigKey.Cimd]: CimdConfig;
 };
 export declare const logtoTenantConfigGuard: Readonly<{
     [key in LogtoTenantConfigKey]: ZodType<LogtoTenantConfigType[key]>;

package/lib/types/logto-config/index.js

@@ -116,6 +116,17 @@ export const signingKeyRotationStateGuard = z.object({
     tenantCacheExpiresAt: z.number().optional(),
     signingKeyRotationAt: z.number().optional(),
 });
+/* --- CIMD Config --- */
+/**
+ * Config for the OAuth Client ID Metadata Document (CIMD) feature. The row is only written once
+ * the feature is toggled, so readers must fall back to {@link defaultCimdConfig}.
+ */
+export const cimdConfigGuard = z.object({
+    enabled: z.boolean(),
+    addConsentPromptForOfflineAccess: z.boolean().optional(),
+});
+/** Applied when the `cimd` row is absent: the feature is opt-in per tenant. */
+export const defaultCimdConfig = Object.freeze({ enabled: false });
 export var LogtoTenantConfigKey;
 (function (LogtoTenantConfigKey) {
     LogtoTenantConfigKey["AdminConsole"] = "adminConsole";
@@ -128,6 +139,8 @@ export var LogtoTenantConfigKey;
     LogtoTenantConfigKey["SigningKeyRotationState"] = "signingKeyRotationState";
     /** Internal, ops-only override of the system message send-rate-limit policy. Not exposed by any API. */
     LogtoTenantConfigKey["MessageRateLimitOverride"] = "messageRateLimitOverride";
+    /** Tenant-level switch for the OAuth Client ID Metadata Document feature. */
+    LogtoTenantConfigKey["Cimd"] = "cimd";
 })(LogtoTenantConfigKey || (LogtoTenantConfigKey = {}));
 export const logtoTenantConfigGuard = Object.freeze({
     [LogtoTenantConfigKey.AdminConsole]: adminConsoleDataGuard,
@@ -136,6 +149,7 @@ export const logtoTenantConfigGuard = Object.freeze({
     [LogtoTenantConfigKey.IdToken]: idTokenConfigGuard,
     [LogtoTenantConfigKey.SigningKeyRotationState]: signingKeyRotationStateGuard,
     [LogtoTenantConfigKey.MessageRateLimitOverride]: messageRateLimitOverrideGuard,
+    [LogtoTenantConfigKey.Cimd]: cimdConfigGuard,
 });
 export const logtoConfigKeys = Object.freeze([
     ...Object.values(LogtoOidcConfigKey),

package/lib/types/logto-config/index.test.js

@@ -1,4 +1,5 @@
 import { describe, expect, it } from 'vitest';
+import { z } from 'zod';
 import { LogtoActionKey, LogtoOidcConfigKey, LogtoTenantConfigKey, OidcSigningKeyStatus, actionConfigGuard, logtoOidcConfigGuard, logtoConfigGuards, logtoConfigKeys, logtoTenantConfigGuard, oidcConfigKeysResponseGuard, } from './index.js';
 describe('logto config guards', () => {
     it('accepts legacy private keys without status', () => {
@@ -50,4 +51,26 @@ describe('logto config guards', () => {
         expect(logtoConfigKeys).toContain(LogtoActionKey.PostSignIn);
         expect(logtoConfigGuards[LogtoActionKey.PostSignIn]).toBe(actionConfigGuard[LogtoActionKey.PostSignIn]);
     });
+    it('includes the CIMD key in the logto config summary guards', () => {
+        expect(logtoConfigKeys).toContain(LogtoTenantConfigKey.Cimd);
+        expect(logtoConfigGuards[LogtoTenantConfigKey.Cimd]).toBe(logtoTenantConfigGuard[LogtoTenantConfigKey.Cimd]);
+    });
+    it('keeps a stored CIMD config value', () => {
+        expect(logtoTenantConfigGuard[LogtoTenantConfigKey.Cimd].parse({ enabled: true })).toEqual({
+            enabled: true,
+        });
+    });
+    it('rejects invalid CIMD config values', () => {
+        const result = logtoTenantConfigGuard[LogtoTenantConfigKey.Cimd].safeParse({ enabled: 'yes' });
+        expect(result.success).toBe(false);
+    });
+    it('parses OIDC configs without the optional session row', () => {
+        const result = z.object(logtoOidcConfigGuard).parse({
+            [LogtoOidcConfigKey.PrivateKeys]: [
+                { id: 'key_1', value: 'private-key-1', createdAt: 1_710_000_000_000 },
+            ],
+            [LogtoOidcConfigKey.CookieKeys]: [],
+        });
+        expect(result[LogtoOidcConfigKey.Session]).toEqual({});
+    });
 });