@logto/schemas 1.40.1 → 1.42.0

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

@@ -12,7 +12,7 @@ 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, 'forgotPasswordMethods'> & {
+export type FullSignInExperience = Omit<SignInExperience, 'emailBlocklistPolicy' | 'forgotPasswordMethods'> & {
     socialConnectors: ExperienceSocialConnector[];
     ssoConnectors: SsoConnectorMetadata[];
     forgotPassword: ForgotPassword;
@@ -150,6 +150,7 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
     }>;
     sentinelPolicy: z.ZodType<import("../foundations/jsonb-types/sign-in-experience.js").SentinelPolicy, z.ZodTypeDef, import("../foundations/jsonb-types/sign-in-experience.js").SentinelPolicy>;
     emailBlocklistPolicy: z.ZodType<import("../foundations/jsonb-types/sign-in-experience.js").EmailBlocklistPolicy, z.ZodTypeDef, import("../foundations/jsonb-types/sign-in-experience.js").EmailBlocklistPolicy>;
+    verificationCodePolicy: z.ZodType<import("../foundations/jsonb-types/sign-in-experience.js").VerificationCodePolicy, z.ZodTypeDef, import("../foundations/jsonb-types/sign-in-experience.js").VerificationCodePolicy>;
     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<{
@@ -157,7 +158,9 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
     }[] | null, z.ZodTypeDef, {
         name: string;
     }[] | null>;
-}, "forgotPasswordMethods"> & {
+    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"> & {
     socialConnectors: z.ZodArray<z.ZodObject<Omit<{
         id: z.ZodString;
         target: z.ZodString;
@@ -737,9 +740,11 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
     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;
+    verificationCodePolicy: import("../foundations/jsonb-types/sign-in-experience.js").VerificationCodePolicy;
     passkeySignIn: import("../foundations/jsonb-types/sign-in-experience.js").PasskeySignIn;
     signUpProfileFields: import("../foundations/jsonb-types/sign-in-experience.js").SignUpProfileFields | null;
+    passwordExpiration: import("../foundations/jsonb-types/sign-in-experience.js").PasswordExpirationPolicy;
+    usernamePolicy: import("../foundations/jsonb-types/index.js").UsernamePolicy;
     socialConnectors: {
         name: {
             en: string;
@@ -937,9 +942,11 @@ export declare const fullSignInExperienceGuard: z.ZodObject<Omit<{
     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;
+    verificationCodePolicy: import("../foundations/jsonb-types/sign-in-experience.js").VerificationCodePolicy;
     passkeySignIn: import("../foundations/jsonb-types/sign-in-experience.js").PasskeySignIn;
     signUpProfileFields: import("../foundations/jsonb-types/sign-in-experience.js").SignUpProfileFields | null;
+    passwordExpiration: import("../foundations/jsonb-types/sign-in-experience.js").PasswordExpirationPolicy;
+    usernamePolicy: import("../foundations/jsonb-types/index.js").UsernamePolicy;
     socialConnectors: {
         name: {
             en: string;

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

@@ -4,7 +4,7 @@ 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({ forgotPasswordMethods: true })
+    .omit({ emailBlocklistPolicy: true, forgotPasswordMethods: true })
     .extend({
     socialConnectors: connectorMetadataGuard
         .omit({

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

@@ -168,4 +168,62 @@ export declare const extendedSocialUserInfoGuard: z.ZodObject<{
     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 declare const samlSsoConnectorSigningKeyResponseGuard: z.ZodObject<Omit<{
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+    ssoConnectorId: z.ZodType<string, z.ZodTypeDef, string>;
+    privateKey: z.ZodType<string, z.ZodTypeDef, string>;
+    certificate: z.ZodType<string, z.ZodTypeDef, string>;
+    createdAt: z.ZodType<number, z.ZodTypeDef, number>;
+    expiresAt: z.ZodType<number, z.ZodTypeDef, number>;
+    active: z.ZodType<boolean, z.ZodTypeDef, boolean>;
+}, "tenantId" | "ssoConnectorId" | "privateKey"> & {
+    fingerprints: z.ZodObject<{
+        sha256: z.ZodObject<{
+            formatted: z.ZodString;
+            unformatted: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            formatted: string;
+            unformatted: string;
+        }, {
+            formatted: string;
+            unformatted: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        sha256: {
+            formatted: string;
+            unformatted: string;
+        };
+    }, {
+        sha256: {
+            formatted: string;
+            unformatted: string;
+        };
+    }>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    createdAt: number;
+    certificate: string;
+    active: boolean;
+    expiresAt: number;
+    fingerprints: {
+        sha256: {
+            formatted: string;
+            unformatted: string;
+        };
+    };
+}, {
+    id: string;
+    createdAt: number;
+    certificate: string;
+    active: boolean;
+    expiresAt: number;
+    fingerprints: {
+        sha256: {
+            formatted: string;
+            unformatted: string;
+        };
+    };
+}>;
+export type SamlSsoConnectorSigningKeyResponse = z.infer<typeof samlSsoConnectorSigningKeyResponseGuard>;
 export {};

package/lib/types/sso-connector.js

@@ -1,6 +1,8 @@
 import { socialUserInfoGuard } from '@logto/connector-kit';
 import { z } from 'zod';
+import { SamlSsoConnectorSigningKeys } from '../db-entries/saml-sso-connector-signing-key.js';
 import { SsoConnectors } from '../db-entries/sso-connector.js';
+import { certificateFingerprintsGuard } from './saml-application.js';
 /**
  * SSO Connector data type that are returned to the experience client for sign-in use.
  */
@@ -76,3 +78,13 @@ export var SsoAuthenticationQueryKey;
 })(SsoAuthenticationQueryKey || (SsoAuthenticationQueryKey = {}));
 // Saml assertion returned user attribute value
 export const extendedSocialUserInfoGuard = socialUserInfoGuard.catchall(z.unknown());
+// Make sure the `privateKey` is not exposed in the response.
+export const samlSsoConnectorSigningKeyResponseGuard = SamlSsoConnectorSigningKeys.guard
+    .omit({
+    tenantId: true,
+    ssoConnectorId: true,
+    privateKey: true,
+})
+    .extend({
+    fingerprints: certificateFingerprintsGuard,
+});

package/lib/types/ssr.d.ts

@@ -1,4 +1,5 @@
 import { type LocalePhrase } from '@logto/phrases-experience';
+import { type SignInExperience } from '../db-entries/index.js';
 import { type FullSignInExperience } from './sign-in-experience.js';
 /**
  * The server-side rendering data type for **experience**.
@@ -15,6 +16,16 @@ export type SsrData = {
         data: LocalePhrase;
     };
 };
+/**
+ * The server-side rendering data type for **account center**. Only sign-in experience color/theme
+ * data is needed for theme flash prevention.
+ */
+export type AccountCenterSsrSignInExperience = Pick<SignInExperience, 'color'>;
+export type AccountCenterSsrData = {
+    signInExperience: {
+        data: AccountCenterSsrSignInExperience;
+    };
+};
 /**
  * Variable placeholder for **experience** server-side rendering. The value should be replaced by
  * the server.

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

@@ -7,14 +7,18 @@ export declare const userAssetsServiceStatusGuard: z.ZodObject<{
     status: z.ZodUnion<[z.ZodLiteral<"ready">, z.ZodLiteral<"not_configured">]>;
     allowUploadMimeTypes: z.ZodOptional<z.ZodArray<z.ZodEnum<["image/jpeg", "image/png", "image/gif", "image/vnd.microsoft.icon", "image/x-icon", "image/svg+xml", "image/tiff", "image/webp", "image/bmp", "application/zip"]>, "many">>;
     maxUploadFileSize: z.ZodOptional<z.ZodNumber>;
+    /** Whether Experience avatar upload during sign-up is available on this server. */
+    isExperienceAvatarUploadEnabled: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     status: "ready" | "not_configured";
     allowUploadMimeTypes?: ("image/jpeg" | "image/png" | "image/gif" | "image/vnd.microsoft.icon" | "image/x-icon" | "image/svg+xml" | "image/tiff" | "image/webp" | "image/bmp" | "application/zip")[] | undefined;
     maxUploadFileSize?: number | undefined;
+    isExperienceAvatarUploadEnabled?: boolean | undefined;
 }, {
     status: "ready" | "not_configured";
     allowUploadMimeTypes?: ("image/jpeg" | "image/png" | "image/gif" | "image/vnd.microsoft.icon" | "image/x-icon" | "image/svg+xml" | "image/tiff" | "image/webp" | "image/bmp" | "application/zip")[] | undefined;
     maxUploadFileSize?: number | undefined;
+    isExperienceAvatarUploadEnabled?: boolean | undefined;
 }>;
 export type UserAssetsServiceStatus = z.infer<typeof userAssetsServiceStatusGuard>;
 export declare const userAssetsGuard: z.ZodObject<{
@@ -45,4 +49,10 @@ type MimeTypeToFileExtensionMappings = {
     [key in AllowedUploadMimeType]: readonly [string, ...string[]];
 };
 export declare const mimeTypeToFileExtensionMappings: MimeTypeToFileExtensionMappings;
+/** MIME types allowed for avatar uploads (Experience, Account Center, Console). */
+export declare const avatarMimeTypes: readonly ["image/jpeg", "image/png", "image/gif", "image/webp", "image/bmp"];
+export type AvatarMimeType = (typeof avatarMimeTypes)[number];
+export declare const isAvatarMimeType: (mimeType: string) => mimeType is AvatarMimeType;
+export declare const avatarFileAccept: string;
+export declare const avatarFileExtensionsLabel: string;
 export {};

package/lib/types/user-assets.js

@@ -18,6 +18,8 @@ export const userAssetsServiceStatusGuard = z.object({
     status: z.union([z.literal('ready'), z.literal('not_configured')]),
     allowUploadMimeTypes: z.array(allowUploadMimeTypeGuard).optional(),
     maxUploadFileSize: z.number().optional(),
+    /** Whether Experience avatar upload during sign-up is available on this server. */
+    isExperienceAvatarUploadEnabled: z.boolean().optional(),
 });
 export const userAssetsGuard = z.object({
     url: z.string(),
@@ -40,3 +42,18 @@ export const mimeTypeToFileExtensionMappings = Object.freeze({
     'image/bmp': ['bmp'],
     'application/zip': ['zip'],
 });
+/** MIME types allowed for avatar uploads (Experience, Account Center, Console). */
+export const avatarMimeTypes = [
+    'image/jpeg',
+    'image/png',
+    'image/gif',
+    'image/webp',
+    'image/bmp',
+];
+const avatarMimeTypeSet = new Set(avatarMimeTypes);
+export const isAvatarMimeType = (mimeType) => avatarMimeTypeSet.has(mimeType);
+export const avatarFileAccept = avatarMimeTypes.join(',');
+const formatAvatarExtensionLabel = (extension) => extension === 'webp' ? 'WebP' : extension.toUpperCase();
+export const avatarFileExtensionsLabel = avatarMimeTypes
+    .map((mimeType) => formatAvatarExtensionLabel(mimeTypeToFileExtensionMappings[mimeType][0]))
+    .join(', ');