keycloakify 10.0.0-rc.38 → 10.0.0-rc.39

package/src/bin/start-keycloak/start-keycloak.ts

@@ -1,4 +1,5 @@
-import { readBuildOptions } from "../shared/buildOptions";
+import { getBuildContext } from "../shared/buildContext";
+import { exclude } from "tsafe/exclude";
 import type { CliCommandOptions as CliCommandOptions_common } from "../main";
 import { promptKeycloakVersion } from "../shared/promptKeycloakVersion";
 import { readMetaInfKeycloakThemes } from "../shared/metaInfKeycloakThemes";
@@ -80,11 +81,11 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
 
     const { cliCommandOptions } = params;
 
-    const buildOptions = readBuildOptions({ cliCommandOptions });
+    const buildContext = getBuildContext({ cliCommandOptions });
 
     {
         const { isAppBuildSuccess } = await appBuild({
-            buildOptions
+            buildContext
         });
 
         if (!isAppBuildSuccess) {
@@ -98,7 +99,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
 
         const { isKeycloakifyBuildSuccess } = await keycloakifyBuild({
             doSkipBuildJars: false,
-            buildOptions
+            buildContext
         });
 
         if (!isKeycloakifyBuildSuccess) {
@@ -112,7 +113,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
     }
 
     const metaInfKeycloakThemes = readMetaInfKeycloakThemes({
-        keycloakifyBuildDirPath: buildOptions.keycloakifyBuildDirPath
+        keycloakifyBuildDirPath: buildContext.keycloakifyBuildDirPath
     });
 
     const doesImplementAccountTheme = metaInfKeycloakThemes.themes.some(
@@ -138,7 +139,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
 
             const { keycloakVersion } = await promptKeycloakVersion({
                 startingFromMajor: 17,
-                cacheDirPath: buildOptions.cacheDirPath
+                cacheDirPath: buildContext.cacheDirPath
             });
 
             console.log(`→ ${keycloakVersion}`);
@@ -259,7 +260,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
         return pathJoin(dirPath, value);
     })();
 
-    const jarFilePath = pathJoin(buildOptions.keycloakifyBuildDirPath, jarFileBasename);
+    const jarFilePath = pathJoin(buildContext.keycloakifyBuildDirPath, jarFileBasename);
 
     const { doUseBuiltInAccountV1Theme } = await (async () => {
         let doUseBuiltInAccountV1Theme = false;
@@ -267,7 +268,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
         await extractArchive({
             archiveFilePath: jarFilePath,
             onArchiveFile: async ({ relativeFilePathInArchive, readFile, earlyExit }) => {
-                for (const themeName of buildOptions.themeNames) {
+                for (const themeName of buildContext.themeNames) {
                     if (
                         relativeFilePathInArchive ===
                         pathJoin("theme", themeName, "account", "theme.properties")
@@ -292,9 +293,9 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
     const accountThemePropertyPatch = !doUseBuiltInAccountV1Theme
         ? undefined
         : () => {
-              for (const themeName of buildOptions.themeNames) {
+              for (const themeName of buildContext.themeNames) {
                   const filePath = pathJoin(
-                      buildOptions.keycloakifyBuildDirPath,
+                      buildContext.keycloakifyBuildDirPath,
                       "src",
                       "main",
                       "resources",
@@ -346,12 +347,12 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
                 ? ["-e", "JAVA_OPTS=-Dkeycloak.profile=preview"]
                 : []),
             ...[
-                ...buildOptions.themeNames,
+                ...buildContext.themeNames,
                 ...(doUseBuiltInAccountV1Theme ? [] : [accountV1ThemeName])
             ]
                 .map(themeName => ({
                     localDirPath: pathJoin(
-                        buildOptions.keycloakifyBuildDirPath,
+                        buildContext.keycloakifyBuildDirPath,
                         "src",
                         "main",
                         "resources",
@@ -365,6 +366,17 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
                     `${localDirPath}:${containerDirPath}:rw`
                 ])
                 .flat(),
+            ...buildContext.environmentVariables
+                .map(({ name }) => ({ name, envValue: process.env[name] }))
+                .map(({ name, envValue }) =>
+                    envValue === undefined ? undefined : { name, envValue }
+                )
+                .filter(exclude(undefined))
+                .map(({ name, envValue }) => [
+                    "--env",
+                    `${name}='${envValue.replace(/'/g, "'\\''")}'`
+                ])
+                .flat(),
             `quay.io/keycloak/keycloak:${keycloakVersion}`,
             "start-dev",
             ...(21 <= keycloakMajorVersionNumber && keycloakMajorVersionNumber < 24
@@ -373,7 +385,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
             ...(realmJsonFilePath === undefined ? [] : ["--import-realm"])
         ],
         {
-            cwd: buildOptions.keycloakifyBuildDirPath
+            cwd: buildContext.keycloakifyBuildDirPath
         }
     ] as const;
 
@@ -385,7 +397,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
 
     child.on("exit", process.exit);
 
-    const srcDirPath = pathJoin(buildOptions.reactAppRootDirPath, "src");
+    const srcDirPath = pathJoin(buildContext.projectDirPath, "src");
 
     {
         const handler = async (data: Buffer) => {
@@ -417,7 +429,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
                     `- password: ${chalk.cyan.bold("password123")}`,
                     "",
                     `Watching for changes in ${chalk.bold(
-                        `.${pathSep}${pathRelative(process.cwd(), buildOptions.reactAppRootDirPath)}`
+                        `.${pathSep}${pathRelative(process.cwd(), buildContext.projectDirPath)}`
                     )}`
                 ].join("\n")
             );
@@ -431,7 +443,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
             console.log(chalk.cyan("Detected changes in the theme. Rebuilding ..."));
 
             const { isAppBuildSuccess } = await appBuild({
-                buildOptions
+                buildContext
             });
 
             if (!isAppBuildSuccess) {
@@ -440,7 +452,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
 
             const { isKeycloakifyBuildSuccess } = await keycloakifyBuild({
                 doSkipBuildJars: true,
-                buildOptions
+                buildContext
             });
 
             if (!isKeycloakifyBuildSuccess) {
@@ -458,11 +470,11 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
             .watch(
                 [
                     srcDirPath,
-                    buildOptions.publicDirPath,
-                    pathJoin(buildOptions.reactAppRootDirPath, "package.json"),
-                    pathJoin(buildOptions.reactAppRootDirPath, "vite.config.ts"),
-                    pathJoin(buildOptions.reactAppRootDirPath, "vite.config.js"),
-                    pathJoin(buildOptions.reactAppRootDirPath, "index.html"),
+                    buildContext.publicDirPath,
+                    pathJoin(buildContext.projectDirPath, "package.json"),
+                    pathJoin(buildContext.projectDirPath, "vite.config.ts"),
+                    pathJoin(buildContext.projectDirPath, "vite.config.js"),
+                    pathJoin(buildContext.projectDirPath, "index.html"),
                     pathJoin(getThisCodebaseRootDirPath(), "src")
                 ],
                 {

package/src/bin/tools/getNpmWorkspaceRootDirPath.ts

@@ -4,14 +4,14 @@ import { assert } from "tsafe/assert";
 import * as fs from "fs";
 
 export function getNpmWorkspaceRootDirPath(params: {
-    reactAppRootDirPath: string;
+    projectDirPath: string;
     dependencyExpected: string;
 }) {
-    const { reactAppRootDirPath, dependencyExpected } = params;
+    const { projectDirPath, dependencyExpected } = params;
 
     const npmWorkspaceRootDirPath = (function callee(depth: number): string {
         const cwd = pathResolve(
-            pathJoin(...[reactAppRootDirPath, ...Array(depth).fill("..")])
+            pathJoin(...[projectDirPath, ...Array(depth).fill("..")])
         );
 
         assert(cwd !== pathSep, "NPM workspace not found");

package/src/bin/update-kc-gen.ts

@@ -1,13 +1,13 @@
 import type { CliCommandOptions } from "./main";
-import { readBuildOptions } from "./shared/buildOptions";
+import { getBuildContext } from "./shared/buildContext";
 import { generateKcGenTs } from "./shared/generateKcGenTs";
 
 export async function command(params: { cliCommandOptions: CliCommandOptions }) {
     const { cliCommandOptions } = params;
 
-    const buildOptions = readBuildOptions({
+    const buildContext = getBuildContext({
         cliCommandOptions
     });
 
-    await generateKcGenTs({ buildOptions });
+    await generateKcGenTs({ buildContext });
 }

package/src/lib/getKcClsx.ts

@@ -21,7 +21,21 @@ export function createGetKcClsx<ClassKey extends string>(params: {
             return true;
         }
 
-        return JSON.stringify(params1.classes) === JSON.stringify(params2.classes);
+        if (params1.classes === undefined || params2.classes === undefined) {
+            return false;
+        }
+
+        if (Object.keys(params1.classes).length !== Object.keys(params2.classes).length) {
+            return false;
+        }
+
+        for (const key in params1.classes) {
+            if (params1.classes[key] !== params2.classes[key]) {
+                return false;
+            }
+        }
+
+        return true;
     }
 
     let cache:

package/src/login/Fallback.tsx

@@ -42,6 +42,7 @@ const WebauthnError = lazy(() => import("keycloakify/login/pages/WebauthnError")
 
 type FallbackProps = PageProps<KcContext> & {
     UserProfileFormFields: LazyOrNot<(props: UserProfileFormFieldsProps) => JSX.Element>;
+    doMakeUserConfirmPassword: boolean;
 };
 
 export default function Fallback(props: FallbackProps) {

package/src/login/UserProfileFormFields.tsx

@@ -15,6 +15,7 @@ export type UserProfileFormFieldsProps = {
     kcContext: KcContextLike;
     kcClsx: KcClsx;
     onIsFormSubmittableValueChange: (isFormSubmittable: boolean) => void;
+    doMakeUserConfirmPassword: boolean;
     BeforeField?: (props: BeforeAfterFieldProps) => JSX.Element | null;
     AfterField?: (props: BeforeAfterFieldProps) => JSX.Element | null;
 };
@@ -28,11 +29,8 @@ type BeforeAfterFieldProps = {
     i18n: I18n;
 };
 
-// NOTE: Enabled by default but it's a UX best practice to set it to false.
-const doMakeUserConfirmPassword = true;
-
 export default function UserProfileFormFields(props: UserProfileFormFieldsProps) {
-    const { kcContext, kcClsx, onIsFormSubmittableValueChange, BeforeField, AfterField } = props;
+    const { kcContext, kcClsx, onIsFormSubmittableValueChange, doMakeUserConfirmPassword, BeforeField, AfterField } = props;
 
     const { advancedMsg } = useI18n({ kcContext });
 

package/src/login/i18n/i18n.tsx

@@ -132,7 +132,7 @@ function createGetI18n<ExtraMessageKey extends string = never>(extraMessages: {
             __localizationRealmOverridesUserProfile: kcContext.__localizationRealmOverridesUserProfile
         });
 
-        const isCurrentLanguageFallbackLanguage = partialI18n.currentLanguageTag !== fallbackLanguageTag;
+        const isCurrentLanguageFallbackLanguage = partialI18n.currentLanguageTag === fallbackLanguageTag;
 
         const result: Result = {
             i18n: {

package/src/login/pages/IdpReviewUserProfile.tsx

@@ -8,10 +8,11 @@ import { useI18n } from "../i18n";
 
 type IdpReviewUserProfileProps = PageProps<Extract<KcContext, { pageId: "idp-review-user-profile.ftl" }>> & {
     UserProfileFormFields: LazyOrNot<(props: UserProfileFormFieldsProps) => JSX.Element>;
+    doMakeUserConfirmPassword: boolean;
 };
 
 export default function IdpReviewUserProfile(props: IdpReviewUserProfileProps) {
-    const { kcContext, doUseDefaultCss, Template, classes, UserProfileFormFields } = props;
+    const { kcContext, doUseDefaultCss, Template, classes, UserProfileFormFields, doMakeUserConfirmPassword } = props;
 
     const { kcClsx } = getKcClsx({
         doUseDefaultCss,
@@ -34,7 +35,12 @@ export default function IdpReviewUserProfile(props: IdpReviewUserProfileProps) {
             headerNode={msg("loginIdpReviewProfileTitle")}
         >
             <form id="kc-idp-review-profile-form" className={kcClsx("kcFormClass")} action={url.loginAction} method="post">
-                <UserProfileFormFields kcContext={kcContext} onIsFormSubmittableValueChange={setIsFomSubmittable} kcClsx={kcClsx} />
+                <UserProfileFormFields
+                    kcContext={kcContext}
+                    onIsFormSubmittableValueChange={setIsFomSubmittable}
+                    kcClsx={kcClsx}
+                    doMakeUserConfirmPassword={doMakeUserConfirmPassword}
+                />
                 <div className={kcClsx("kcFormGroupClass")}>
                     <div id="kc-form-options" className={kcClsx("kcFormOptionsClass")}>
                         <div className={kcClsx("kcFormOptionsWrapperClass")} />

package/src/login/pages/LoginUpdateProfile.tsx

@@ -8,10 +8,11 @@ import { useI18n } from "../i18n";
 
 type LoginUpdateProfileProps = PageProps<Extract<KcContext, { pageId: "login-update-profile.ftl" }>> & {
     UserProfileFormFields: LazyOrNot<(props: UserProfileFormFieldsProps) => JSX.Element>;
+    doMakeUserConfirmPassword: boolean;
 };
 
 export default function LoginUpdateProfile(props: LoginUpdateProfileProps) {
-    const { kcContext, doUseDefaultCss, Template, classes, UserProfileFormFields } = props;
+    const { kcContext, doUseDefaultCss, Template, classes, UserProfileFormFields, doMakeUserConfirmPassword } = props;
 
     const { kcClsx } = getKcClsx({
         doUseDefaultCss,
@@ -33,7 +34,12 @@ export default function LoginUpdateProfile(props: LoginUpdateProfileProps) {
             headerNode={msg("loginProfileTitle")}
         >
             <form id="kc-update-profile-form" className={kcClsx("kcFormClass")} action={url.loginAction} method="post">
-                <UserProfileFormFields kcContext={kcContext} kcClsx={kcClsx} onIsFormSubmittableValueChange={setIsFormSubmittable} />
+                <UserProfileFormFields
+                    kcContext={kcContext}
+                    kcClsx={kcClsx}
+                    onIsFormSubmittableValueChange={setIsFormSubmittable}
+                    doMakeUserConfirmPassword={doMakeUserConfirmPassword}
+                />
                 <div className={kcClsx("kcFormGroupClass")}>
                     <div id="kc-form-options" className={kcClsx("kcFormOptionsClass")}>
                         <div className={kcClsx("kcFormOptionsWrapperClass")} />

package/src/login/pages/Register.tsx

@@ -10,10 +10,11 @@ import { useI18n, type I18n } from "../i18n";
 
 type RegisterProps = PageProps<Extract<KcContext, { pageId: "register.ftl" }>> & {
     UserProfileFormFields: LazyOrNot<(props: UserProfileFormFieldsProps) => JSX.Element>;
+    doMakeUserConfirmPassword: boolean;
 };
 
 export default function Register(props: RegisterProps) {
-    const { kcContext, doUseDefaultCss, Template, classes, UserProfileFormFields } = props;
+    const { kcContext, doUseDefaultCss, Template, classes, UserProfileFormFields, doMakeUserConfirmPassword } = props;
 
     const { kcClsx } = getKcClsx({
         doUseDefaultCss,
@@ -30,7 +31,12 @@ export default function Register(props: RegisterProps) {
     return (
         <Template kcContext={kcContext} doUseDefaultCss={doUseDefaultCss} classes={classes} headerNode={msg("registerTitle")} displayRequiredFields>
             <form id="kc-register-form" className={kcClsx("kcFormClass")} action={url.registrationAction} method="post">
-                <UserProfileFormFields kcContext={kcContext} kcClsx={kcClsx} onIsFormSubmittableValueChange={setIsFormSubmittable} />
+                <UserProfileFormFields
+                    kcContext={kcContext}
+                    kcClsx={kcClsx}
+                    onIsFormSubmittableValueChange={setIsFormSubmittable}
+                    doMakeUserConfirmPassword={doMakeUserConfirmPassword}
+                />
                 {termsAcceptanceRequired && <TermsAcceptance i18n={i18n} kcClsx={kcClsx} messagesPerField={messagesPerField} />}
                 {recaptchaRequired && (
                     <div className="form-group">

package/src/login/pages/UpdateEmail.tsx

@@ -8,10 +8,11 @@ import { useI18n, type I18n } from "../i18n";
 
 type UpdateEmailProps = PageProps<Extract<KcContext, { pageId: "update-email.ftl" }>> & {
     UserProfileFormFields: LazyOrNot<(props: UserProfileFormFieldsProps) => JSX.Element>;
+    doMakeUserConfirmPassword: boolean;
 };
 
 export default function UpdateEmail(props: UpdateEmailProps) {
-    const { kcContext, doUseDefaultCss, Template, classes, UserProfileFormFields } = props;
+    const { kcContext, doUseDefaultCss, Template, classes, UserProfileFormFields, doMakeUserConfirmPassword } = props;
 
     const { kcClsx } = getKcClsx({
         doUseDefaultCss,
@@ -35,7 +36,12 @@ export default function UpdateEmail(props: UpdateEmailProps) {
             headerNode={msg("updateEmailTitle")}
         >
             <form id="kc-update-email-form" className={kcClsx("kcFormClass")} action={url.loginAction} method="post">
-                <UserProfileFormFields kcContext={kcContext} kcClsx={kcClsx} onIsFormSubmittableValueChange={setIsFormSubmittable} />
+                <UserProfileFormFields
+                    kcContext={kcContext}
+                    kcClsx={kcClsx}
+                    onIsFormSubmittableValueChange={setIsFormSubmittable}
+                    doMakeUserConfirmPassword={doMakeUserConfirmPassword}
+                />
 
                 <div className={kcClsx("kcFormGroupClass")}>
                     <div id="kc-form-options" className={kcClsx("kcFormOptionsClass")}>

package/src/vite-plugin/vite-plugin.ts

@@ -11,22 +11,22 @@ import { rm } from "../bin/tools/fs.rm";
 import { copyKeycloakResourcesToPublic } from "../bin/shared/copyKeycloakResourcesToPublic";
 import { assert } from "tsafe/assert";
 import {
-    readBuildOptions,
+    getBuildContext,
+    type BuildContext,
     type BuildOptions,
-    type UserProvidedBuildOptions,
     type ResolvedViteConfig
-} from "../bin/shared/buildOptions";
+} from "../bin/shared/buildContext";
 import MagicString from "magic-string";
 import { generateKcGenTs } from "../bin/shared/generateKcGenTs";
 
-export type Params = UserProvidedBuildOptions & {
-    postBuild?: (buildOptions: Omit<BuildOptions, "bundler">) => Promise<void>;
+export type Params = BuildOptions & {
+    postBuild?: (buildContext: Omit<BuildContext, "bundler">) => Promise<void>;
 };
 
 export function keycloakify(params?: Params) {
-    const { postBuild, ...userProvidedBuildOptions } = params ?? {};
+    const { postBuild, ...buildOptions } = params ?? {};
 
-    let reactAppRootDirPath: string | undefined = undefined;
+    let projectDirPath: string | undefined = undefined;
     let urlPathname: string | undefined = undefined;
     let buildDirPath: string | undefined = undefined;
     let command: "build" | "serve" | undefined = undefined;
@@ -45,16 +45,16 @@ export function keycloakify(params?: Params) {
                     break run_post_build_script_case;
                 }
 
-                const buildOptions = JSON.parse(envValue) as BuildOptions;
+                const buildContext = JSON.parse(envValue) as BuildContext;
 
-                await postBuild?.(buildOptions);
+                await postBuild?.(buildContext);
 
                 process.exit(0);
             }
 
             command = resolvedConfig.command;
 
-            reactAppRootDirPath = resolvedConfig.root;
+            projectDirPath = resolvedConfig.root;
             urlPathname = (() => {
                 let out = resolvedConfig.env.BASE_URL;
 
@@ -86,7 +86,7 @@ export function keycloakify(params?: Params) {
                 return out;
             })();
 
-            buildDirPath = pathJoin(reactAppRootDirPath, resolvedConfig.build.outDir);
+            buildDirPath = pathJoin(projectDirPath, resolvedConfig.build.outDir);
 
             resolve_vite_config_case: {
                 const envValue =
@@ -102,13 +102,13 @@ export function keycloakify(params?: Params) {
                     JSON.stringify(
                         id<ResolvedViteConfig>({
                             publicDir: pathRelative(
-                                reactAppRootDirPath,
+                                projectDirPath,
                                 resolvedConfig.publicDir
                             ),
                             assetsDir: resolvedConfig.build.assetsDir,
                             buildDir: resolvedConfig.build.outDir,
                             urlPathname,
-                            userProvidedBuildOptions
+                            buildOptions
                         })
                     )
                 );
@@ -116,18 +116,18 @@ export function keycloakify(params?: Params) {
                 process.exit(0);
             }
 
-            const buildOptions = readBuildOptions({
+            const buildContext = getBuildContext({
                 cliCommandOptions: {
-                    reactAppRootDirPath
+                    projectDirPath
                 }
             });
 
             await Promise.all([
                 copyKeycloakResourcesToPublic({
-                    buildOptions
+                    buildContext
                 }),
                 generateKcGenTs({
-                    buildOptions
+                    buildContext
                 })
             ]);
         },
@@ -139,11 +139,11 @@ export function keycloakify(params?: Params) {
                 return;
             }
 
-            assert(reactAppRootDirPath !== undefined);
+            assert(projectDirPath !== undefined);
 
             {
                 const isWithinSourceDirectory = id.startsWith(
-                    pathJoin(reactAppRootDirPath, "src") + pathSep
+                    pathJoin(projectDirPath, "src") + pathSep
                 );
 
                 if (!isWithinSourceDirectory) {