@logto/schemas 1.38.0 → 1.40.0

package/lib/types/onboarding.d.ts

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 export declare const userOnboardingDataKey = "onboarding";
+export declare const ossUserOnboardingDataKey = "ossOnboarding";
 export declare enum Project {
     Personal = "personal",
     Company = "company"
@@ -18,7 +19,6 @@ export declare enum Title {
     Product = "product",
     Others = "others"
 }
-/** @deprecated */
 export declare enum CompanySize {
     Scale1 = "1",
     Scale2 = "2-49",
@@ -81,6 +81,52 @@ declare const questionnaireGuard: z.ZodObject<{
     additionalFeatures?: AdditionalFeatures[] | undefined;
 }>;
 export type Questionnaire = z.infer<typeof questionnaireGuard>;
+declare const ossQuestionnaireGuard: z.ZodObject<{
+    emailAddress: z.ZodOptional<z.ZodString>;
+    newsletter: z.ZodOptional<z.ZodBoolean>;
+    project: z.ZodOptional<z.ZodNativeEnum<typeof Project>>;
+    projectName: z.ZodOptional<z.ZodString>;
+    companyName: z.ZodOptional<z.ZodString>;
+    companySize: z.ZodOptional<z.ZodNativeEnum<typeof CompanySize>>;
+}, "strip", z.ZodTypeAny, {
+    project?: Project | undefined;
+    companyName?: string | undefined;
+    companySize?: CompanySize | undefined;
+    emailAddress?: string | undefined;
+    newsletter?: boolean | undefined;
+    projectName?: string | undefined;
+}, {
+    project?: Project | undefined;
+    companyName?: string | undefined;
+    companySize?: CompanySize | undefined;
+    emailAddress?: string | undefined;
+    newsletter?: boolean | undefined;
+    projectName?: string | undefined;
+}>;
+export type OssQuestionnaire = z.infer<typeof ossQuestionnaireGuard>;
+export declare const ossSurveyReportPayloadGuard: z.ZodObject<{
+    emailAddress: z.ZodString;
+    newsletter: z.ZodOptional<z.ZodBoolean>;
+    project: z.ZodNativeEnum<typeof Project>;
+    projectName: z.ZodOptional<z.ZodString>;
+    companyName: z.ZodOptional<z.ZodString>;
+    companySize: z.ZodOptional<z.ZodNativeEnum<typeof CompanySize>>;
+}, "strip", z.ZodTypeAny, {
+    project: Project;
+    emailAddress: string;
+    companyName?: string | undefined;
+    companySize?: CompanySize | undefined;
+    newsletter?: boolean | undefined;
+    projectName?: string | undefined;
+}, {
+    project: Project;
+    emailAddress: string;
+    companyName?: string | undefined;
+    companySize?: CompanySize | undefined;
+    newsletter?: boolean | undefined;
+    projectName?: string | undefined;
+}>;
+export type OssSurveyReportPayload = z.infer<typeof ossSurveyReportPayloadGuard>;
 export declare const userOnboardingDataGuard: z.ZodObject<{
     questionnaire: z.ZodOptional<z.ZodObject<{
         project: z.ZodOptional<z.ZodNativeEnum<typeof Project>>;
@@ -141,4 +187,50 @@ export declare const userOnboardingDataGuard: z.ZodObject<{
     isOnboardingDone?: boolean | undefined;
 }>;
 export type UserOnboardingData = z.infer<typeof userOnboardingDataGuard>;
+export declare const ossUserOnboardingDataGuard: z.ZodObject<{
+    questionnaire: z.ZodOptional<z.ZodObject<{
+        emailAddress: z.ZodOptional<z.ZodString>;
+        newsletter: z.ZodOptional<z.ZodBoolean>;
+        project: z.ZodOptional<z.ZodNativeEnum<typeof Project>>;
+        projectName: z.ZodOptional<z.ZodString>;
+        companyName: z.ZodOptional<z.ZodString>;
+        companySize: z.ZodOptional<z.ZodNativeEnum<typeof CompanySize>>;
+    }, "strip", z.ZodTypeAny, {
+        project?: Project | undefined;
+        companyName?: string | undefined;
+        companySize?: CompanySize | undefined;
+        emailAddress?: string | undefined;
+        newsletter?: boolean | undefined;
+        projectName?: string | undefined;
+    }, {
+        project?: Project | undefined;
+        companyName?: string | undefined;
+        companySize?: CompanySize | undefined;
+        emailAddress?: string | undefined;
+        newsletter?: boolean | undefined;
+        projectName?: string | undefined;
+    }>>;
+    isOnboardingDone: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    questionnaire?: {
+        project?: Project | undefined;
+        companyName?: string | undefined;
+        companySize?: CompanySize | undefined;
+        emailAddress?: string | undefined;
+        newsletter?: boolean | undefined;
+        projectName?: string | undefined;
+    } | undefined;
+    isOnboardingDone?: boolean | undefined;
+}, {
+    questionnaire?: {
+        project?: Project | undefined;
+        companyName?: string | undefined;
+        companySize?: CompanySize | undefined;
+        emailAddress?: string | undefined;
+        newsletter?: boolean | undefined;
+        projectName?: string | undefined;
+    } | undefined;
+    isOnboardingDone?: boolean | undefined;
+}>;
+export type OssUserOnboardingData = z.infer<typeof ossUserOnboardingDataGuard>;
 export {};

package/lib/types/onboarding.js

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 export const userOnboardingDataKey = 'onboarding';
+export const ossUserOnboardingDataKey = 'ossOnboarding';
 export var Project;
 (function (Project) {
     Project["Personal"] = "personal";
@@ -21,7 +22,6 @@ export var Title;
     Title["Product"] = "product";
     Title["Others"] = "others";
 })(Title || (Title = {}));
-/** @deprecated */
 export var CompanySize;
 (function (CompanySize) {
     CompanySize["Scale1"] = "1";
@@ -30,6 +30,7 @@ export var CompanySize;
     CompanySize["Scale4"] = "200-999";
     CompanySize["Scale5"] = "1000+";
 })(CompanySize || (CompanySize = {}));
+// Kept as a shared enum for OSS onboarding and existing questionnaire payloads.
 /** @deprecated */
 export var Reason;
 (function (Reason) {
@@ -69,7 +70,27 @@ const questionnaireGuard = z.object({
     stage: z.nativeEnum(Stage).optional(),
     additionalFeatures: z.array(z.nativeEnum(AdditionalFeatures)).optional(),
 });
+const ossQuestionnaireGuard = z.object({
+    emailAddress: z.string().optional(),
+    newsletter: z.boolean().optional(),
+    project: z.nativeEnum(Project).optional(),
+    projectName: z.string().max(200).optional(),
+    companyName: z.string().optional(),
+    companySize: z.nativeEnum(CompanySize).optional(),
+});
+export const ossSurveyReportPayloadGuard = z.object({
+    emailAddress: z.string().email().max(320),
+    newsletter: z.boolean().optional(),
+    project: z.nativeEnum(Project),
+    projectName: z.string().max(200).optional(),
+    companyName: z.string().max(200).optional(),
+    companySize: z.nativeEnum(CompanySize).optional(),
+});
 export const userOnboardingDataGuard = z.object({
     questionnaire: questionnaireGuard.optional(),
     isOnboardingDone: z.boolean().optional(),
 });
+export const ossUserOnboardingDataGuard = z.object({
+    questionnaire: ossQuestionnaireGuard.optional(),
+    isOnboardingDone: z.boolean().optional(),
+});

package/lib/types/saml-application.d.ts

@@ -101,6 +101,7 @@ export declare const samlApplicationResponseGuard: z.ZodObject<{
     customData: z.ZodType<import("@withtyped/server/lib/types.js").JsonObject, z.ZodTypeDef, import("@withtyped/server/lib/types.js").JsonObject>;
     description: z.ZodType<string | null, z.ZodTypeDef, string | null>;
     isThirdParty: z.ZodType<boolean, z.ZodTypeDef, boolean>;
+    appLevelAccessControlEnabled: z.ZodType<boolean, z.ZodTypeDef, boolean>;
     attributeMapping: z.ZodType<Partial<Record<"name" | "username" | "email" | "sub" | "nickname" | "profile" | "website" | "gender" | "birthdate" | "zoneinfo" | "locale" | "address" | "given_name" | "family_name" | "middle_name" | "preferred_username" | "picture" | "email_verified" | "phone_number" | "phone_number_verified" | "updated_at" | "created_at" | "custom_data" | "identities" | "sso_identities" | "roles" | "organizations" | "organization_data" | "organization_roles", string>>, z.ZodTypeDef, Partial<Record<"name" | "username" | "email" | "sub" | "nickname" | "profile" | "website" | "gender" | "birthdate" | "zoneinfo" | "locale" | "address" | "given_name" | "family_name" | "middle_name" | "preferred_username" | "picture" | "email_verified" | "phone_number" | "phone_number_verified" | "updated_at" | "created_at" | "custom_data" | "identities" | "sso_identities" | "roles" | "organizations" | "organization_data" | "organization_roles", string>>>;
     entityId: z.ZodType<string | null, z.ZodTypeDef, string | null>;
     acsUrl: z.ZodType<import("../foundations/index.js").SamlAcsUrl | null, z.ZodTypeDef, import("../foundations/index.js").SamlAcsUrl | null>;
@@ -124,6 +125,7 @@ export declare const samlApplicationResponseGuard: z.ZodObject<{
     customData: import("@withtyped/server/lib/types.js").JsonObject;
     description: string | null;
     isThirdParty: boolean;
+    appLevelAccessControlEnabled: boolean;
     attributeMapping: import("../foundations/index.js").SamlAttributeMapping;
     entityId: string | null;
     acsUrl: import("../foundations/index.js").SamlAcsUrl | null;
@@ -138,6 +140,7 @@ export declare const samlApplicationResponseGuard: z.ZodObject<{
     customData: import("@withtyped/server/lib/types.js").JsonObject;
     description: string | null;
     isThirdParty: boolean;
+    appLevelAccessControlEnabled: boolean;
     attributeMapping: import("../foundations/index.js").SamlAttributeMapping;
     entityId: string | null;
     acsUrl: import("../foundations/index.js").SamlAcsUrl | null;

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

@@ -35,7 +35,15 @@ export type FullSignInExperience = Omit<SignInExperience, 'forgotPasswordMethods
         domain?: string;
         mode?: RecaptchaEnterpriseMode;
     };
+    /**
+     * Custom profile fields selected for the sign-up (Collect user profile) flow.
+     */
     customProfileFields?: Readonly<CustomProfileField[]>;
+    /**
+     * Full custom profile field catalog used to resolve field metadata (for example `required`
+     * and `type`) outside the sign-up field list, such as the account center profile page.
+     */
+    customProfileFieldCatalog?: Readonly<CustomProfileField[]>;
 };
 export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
     tenantId: z.ZodType<string, z.ZodTypeDef, string>;
@@ -99,6 +107,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
         id: string;
         createdAt: number;
     } | null>;
+    customUiCsp: z.ZodType<import("../foundations/jsonb-types/index.js").CustomUiCsp, z.ZodTypeDef, import("../foundations/jsonb-types/index.js").CustomUiCsp>;
     passwordPolicy: z.ZodType<{
         length?: {
             min?: number | undefined;
@@ -143,6 +152,11 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
     emailBlocklistPolicy: z.ZodType<import("../foundations/jsonb-types/sign-in-experience.js").EmailBlocklistPolicy, z.ZodTypeDef, import("../foundations/jsonb-types/sign-in-experience.js").EmailBlocklistPolicy>;
     forgotPasswordMethods: z.ZodType<import("../foundations/jsonb-types/sign-in-experience.js").ForgotPasswordMethod[] | null, z.ZodTypeDef, import("../foundations/jsonb-types/sign-in-experience.js").ForgotPasswordMethod[] | null>;
     passkeySignIn: z.ZodType<import("../foundations/jsonb-types/sign-in-experience.js").PasskeySignIn, z.ZodTypeDef, import("../foundations/jsonb-types/sign-in-experience.js").PasskeySignIn>;
+    signUpProfileFields: z.ZodType<{
+        name: string;
+    }[] | null, z.ZodTypeDef, {
+        name: string;
+    }[] | null>;
 }, "forgotPasswordMethods"> & {
     socialConnectors: z.ZodArray<z.ZodObject<Omit<{
         id: z.ZodString;
@@ -694,13 +708,14 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
         mode?: RecaptchaEnterpriseMode | undefined;
     }>>;
     customProfileFields: z.ZodArray<import("../index.js").Guard<CustomProfileField>, "many">;
+    customProfileFieldCatalog: z.ZodOptional<z.ZodArray<import("../index.js").Guard<CustomProfileField>, "many">>;
 }, "strip", z.ZodTypeAny, {
     id: string;
     tenantId: string;
     mfa: import("../foundations/jsonb-types/sign-in-experience.js").Mfa;
+    customCss: string | null;
     color: import("../foundations/jsonb-types/sign-in-experience.js").Color;
     branding: import("../foundations/jsonb-types/sign-in-experience.js").Branding;
-    customCss: string | null;
     termsOfUseUrl: string | null;
     privacyPolicyUrl: string | null;
     hideLogtoBranding: boolean;
@@ -713,6 +728,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
     signInMode: import("../db-entries/custom-types.js").SignInMode;
     customContent: import("../foundations/jsonb-types/sign-in-experience.js").CustomContent;
     customUiAssets: import("../foundations/jsonb-types/sign-in-experience.js").CustomUiAssets | null;
+    customUiCsp: import("../foundations/jsonb-types/index.js").CustomUiCsp;
     passwordPolicy: import("../foundations/jsonb-types/logs.js").PartialPasswordPolicy;
     adaptiveMfa: import("../foundations/jsonb-types/sign-in-experience.js").AdaptiveMfa;
     singleSignOnEnabled: boolean;
@@ -723,6 +739,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
     sentinelPolicy: import("../foundations/jsonb-types/sign-in-experience.js").SentinelPolicy;
     emailBlocklistPolicy: import("../foundations/jsonb-types/sign-in-experience.js").EmailBlocklistPolicy;
     passkeySignIn: import("../foundations/jsonb-types/sign-in-experience.js").PasskeySignIn;
+    signUpProfileFields: import("../foundations/jsonb-types/sign-in-experience.js").SignUpProfileFields | null;
     socialConnectors: {
         name: {
             en: string;
@@ -891,13 +908,14 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
         domain?: string | undefined;
         mode?: RecaptchaEnterpriseMode | undefined;
     } | undefined;
+    customProfileFieldCatalog?: CustomProfileField[] | undefined;
 }, {
     id: string;
     tenantId: string;
     mfa: import("../foundations/jsonb-types/sign-in-experience.js").Mfa;
+    customCss: string | null;
     color: import("../foundations/jsonb-types/sign-in-experience.js").Color;
     branding: import("../foundations/jsonb-types/sign-in-experience.js").Branding;
-    customCss: string | null;
     termsOfUseUrl: string | null;
     privacyPolicyUrl: string | null;
     hideLogtoBranding: boolean;
@@ -910,6 +928,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
     signInMode: import("../db-entries/custom-types.js").SignInMode;
     customContent: import("../foundations/jsonb-types/sign-in-experience.js").CustomContent;
     customUiAssets: import("../foundations/jsonb-types/sign-in-experience.js").CustomUiAssets | null;
+    customUiCsp: import("../foundations/jsonb-types/index.js").CustomUiCsp;
     passwordPolicy: import("../foundations/jsonb-types/logs.js").PartialPasswordPolicy;
     adaptiveMfa: import("../foundations/jsonb-types/sign-in-experience.js").AdaptiveMfa;
     singleSignOnEnabled: boolean;
@@ -920,6 +939,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
     sentinelPolicy: import("../foundations/jsonb-types/sign-in-experience.js").SentinelPolicy;
     emailBlocklistPolicy: import("../foundations/jsonb-types/sign-in-experience.js").EmailBlocklistPolicy;
     passkeySignIn: import("../foundations/jsonb-types/sign-in-experience.js").PasskeySignIn;
+    signUpProfileFields: import("../foundations/jsonb-types/sign-in-experience.js").SignUpProfileFields | null;
     socialConnectors: {
         name: {
             en: string;
@@ -1088,5 +1108,6 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
         domain?: string | undefined;
         mode?: RecaptchaEnterpriseMode | undefined;
     } | undefined;
+    customProfileFieldCatalog?: CustomProfileField[] | undefined;
 }>;
 export {};

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

@@ -30,4 +30,5 @@ export const fullSignInExperienceGuard = SignInExperiences.guard
     })
         .optional(),
     customProfileFields: CustomProfileFields.guard.array(),
+    customProfileFieldCatalog: CustomProfileFields.guard.array().optional(),
 });

package/lib/types/system.d.ts

@@ -94,46 +94,85 @@ export declare const storageProviderGuard: Readonly<{
     [key in StorageProviderKey]: ZodType<StorageProviderType[key]>;
 }>;
 export declare enum EmailServiceProvider {
-    SendGrid = "SendGrid"
+    SendGrid = "SendGrid",
+    Cloudflare = "Cloudflare"
 }
 export declare const sendgridEmailServiceConfigGuard: z.ZodObject<{
-    provider: z.ZodLiteral<EmailServiceProvider>;
+    provider: z.ZodLiteral<EmailServiceProvider.SendGrid>;
     apiKey: z.ZodString;
     templateId: z.ZodString;
     fromName: z.ZodString;
     fromEmail: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     fromEmail: string;
-    provider: EmailServiceProvider;
+    provider: EmailServiceProvider.SendGrid;
     apiKey: string;
     templateId: string;
     fromName: string;
 }, {
     fromEmail: string;
-    provider: EmailServiceProvider;
+    provider: EmailServiceProvider.SendGrid;
     apiKey: string;
     templateId: string;
     fromName: string;
 }>;
 export type SendgridEmailServiceConfig = z.infer<typeof sendgridEmailServiceConfigGuard>;
+export declare const cloudflareEmailServiceConfigGuard: z.ZodObject<{
+    provider: z.ZodLiteral<EmailServiceProvider.Cloudflare>;
+    apiKey: z.ZodString;
+    accountId: z.ZodString;
+    fromName: z.ZodString;
+    fromEmail: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    accountId: string;
+    fromEmail: string;
+    provider: EmailServiceProvider.Cloudflare;
+    apiKey: string;
+    fromName: string;
+}, {
+    accountId: string;
+    fromEmail: string;
+    provider: EmailServiceProvider.Cloudflare;
+    apiKey: string;
+    fromName: string;
+}>;
+export type CloudflareEmailServiceConfig = z.infer<typeof cloudflareEmailServiceConfigGuard>;
 export declare const emailServiceConfigGuard: z.ZodDiscriminatedUnion<"provider", [z.ZodObject<{
-    provider: z.ZodLiteral<EmailServiceProvider>;
+    provider: z.ZodLiteral<EmailServiceProvider.SendGrid>;
     apiKey: z.ZodString;
     templateId: z.ZodString;
     fromName: z.ZodString;
     fromEmail: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     fromEmail: string;
-    provider: EmailServiceProvider;
+    provider: EmailServiceProvider.SendGrid;
     apiKey: string;
     templateId: string;
     fromName: string;
 }, {
     fromEmail: string;
-    provider: EmailServiceProvider;
+    provider: EmailServiceProvider.SendGrid;
     apiKey: string;
     templateId: string;
     fromName: string;
+}>, z.ZodObject<{
+    provider: z.ZodLiteral<EmailServiceProvider.Cloudflare>;
+    apiKey: z.ZodString;
+    accountId: z.ZodString;
+    fromName: z.ZodString;
+    fromEmail: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    accountId: string;
+    fromEmail: string;
+    provider: EmailServiceProvider.Cloudflare;
+    apiKey: string;
+    fromName: string;
+}, {
+    accountId: string;
+    fromEmail: string;
+    provider: EmailServiceProvider.Cloudflare;
+    apiKey: string;
+    fromName: string;
 }>]>;
 export type EmailServiceConfig = z.infer<typeof emailServiceConfigGuard>;
 export declare enum EmailServiceProviderKey {

package/lib/types/system.js

@@ -60,6 +60,7 @@ export const storageProviderGuard = Object.freeze({
 export var EmailServiceProvider;
 (function (EmailServiceProvider) {
     EmailServiceProvider["SendGrid"] = "SendGrid";
+    EmailServiceProvider["Cloudflare"] = "Cloudflare";
 })(EmailServiceProvider || (EmailServiceProvider = {}));
 export const sendgridEmailServiceConfigGuard = z.object({
     provider: z.literal(EmailServiceProvider.SendGrid),
@@ -68,8 +69,16 @@ export const sendgridEmailServiceConfigGuard = z.object({
     fromName: z.string(),
     fromEmail: z.string(),
 });
+export const cloudflareEmailServiceConfigGuard = z.object({
+    provider: z.literal(EmailServiceProvider.Cloudflare),
+    apiKey: z.string(),
+    accountId: z.string(),
+    fromName: z.string(),
+    fromEmail: z.string(),
+});
 export const emailServiceConfigGuard = z.discriminatedUnion('provider', [
     sendgridEmailServiceConfigGuard,
+    cloudflareEmailServiceConfigGuard,
 ]);
 export var EmailServiceProviderKey;
 (function (EmailServiceProviderKey) {

package/lib/types/user-assets.d.ts

@@ -42,7 +42,7 @@ export declare const uploadFileGuard: z.ZodObject<{
     size: number;
 }>;
 type MimeTypeToFileExtensionMappings = {
-    [key in AllowedUploadMimeType]: readonly string[];
+    [key in AllowedUploadMimeType]: readonly [string, ...string[]];
 };
 export declare const mimeTypeToFileExtensionMappings: MimeTypeToFileExtensionMappings;
 export {};

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

@@ -58,6 +58,17 @@ export declare const userPasskeySignInDataGuard: z.ZodObject<{
     skipped?: boolean | undefined;
 }>;
 export type UserPasskeySignInData = z.infer<typeof userPasskeySignInDataGuard>;
+/**
+ * Schema for the MFA settings API response (GET/PATCH /api/my-account/mfa-settings)
+ */
+export declare const userMfaSettingsResponseGuard: z.ZodObject<{
+    skipMfaOnSignIn: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    skipMfaOnSignIn: boolean;
+}, {
+    skipMfaOnSignIn: boolean;
+}>;
+export type UserMfaSettingsResponse = z.infer<typeof userMfaSettingsResponseGuard>;
 /**
  * Schema for user's logto_config field
  */

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

@@ -45,6 +45,12 @@ export const userPasskeySignInDataGuard = z.object({
      */
     skipped: z.boolean().optional(),
 });
+/**
+ * Schema for the MFA settings API response (GET/PATCH /api/my-account/mfa-settings)
+ */
+export const userMfaSettingsResponseGuard = z.object({
+    skipMfaOnSignIn: z.boolean(),
+});
 /**
  * Schema for user's logto_config field
  */