Release candidate

package.json

@@ -1,6 +1,6 @@
 {
     "name": "keycloakify",
-    "version": "10.0.0-rc.48",
+    "version": "10.0.0-rc.63",
     "description": "Create Keycloak themes using React",
     "repository": {
         "type": "git",
@@ -110,7 +110,6 @@
         "react-dom": "^18.2.0",
         "recast": "^0.23.3",
         "run-exclusive": "^2.2.19",
-        "scripting-tools": "^0.19.13",
         "storybook-dark-mode": "^1.1.2",
         "termost": "^0.12.0",
         "ts-node": "^10.9.2",

scripts/dump-keycloak-realm.ts

@@ -3,40 +3,83 @@ import child_process from "child_process";
 import { SemVer } from "../src/bin/tools/SemVer";
 import { join as pathJoin, relative as pathRelative } from "path";
 import chalk from "chalk";
+import { Deferred } from "evt/tools/Deferred";
+import { assert } from "tsafe/assert";
+import { is } from "tsafe/is";
 
-run(
-    [
-        `docker exec -it ${containerName}`,
-        `/opt/keycloak/bin/kc.sh export`,
-        `--dir /tmp`,
-        `--realm myrealm`,
-        `--users realm_file`
-    ].join(" ")
-);
+(async () => {
+    {
+        const dCompleted = new Deferred<void>();
 
-const keycloakMajorVersionNumber = SemVer.parse(
-    child_process
-        .execSync(`docker inspect --format '{{.Config.Image}}' ${containerName}`)
-        .toString("utf8")
-        .trim()
-        .split(":")[1]
-).major;
+        const child = child_process.spawn("docker", [
+            ...["exec", containerName],
+            ...["/opt/keycloak/bin/kc.sh", "export"],
+            ...["--dir", "/tmp"],
+            ...["--realm", "myrealm"],
+            ...["--users", "realm_file"]
+        ]);
 
-const targetFilePath = pathRelative(
-    process.cwd(),
-    pathJoin(
-        __dirname,
-        "..",
-        "src",
-        "bin",
-        "start-keycloak",
-        `myrealm-realm-${keycloakMajorVersionNumber}.json`
-    )
-);
+        let output = "";
 
-run(`docker cp ${containerName}:/tmp/myrealm-realm.json ${targetFilePath}`);
+        const onExit = (code: number | null) => {
+            dCompleted.reject(new Error(`Exited with code ${code}`));
+        };
 
-console.log(`${chalk.green(`✓ Exported realm to`)} ${chalk.bold(targetFilePath)}`);
+        child.on("exit", onExit);
+
+        child.stdout.on("data", data => {
+            const outputStr = data.toString("utf8");
+
+            if (outputStr.includes("Export finished successfully")) {
+                child.removeListener("exit", onExit);
+
+                child.kill();
+
+                dCompleted.resolve();
+            }
+
+            output += outputStr;
+        });
+
+        child.stderr.on("data", data => (output += chalk.red(data.toString("utf8"))));
+
+        try {
+            await dCompleted.pr;
+        } catch (error) {
+            assert(is<Error>(error));
+
+            console.log(chalk.red(error.message));
+
+            console.log(output);
+
+            process.exit(1);
+        }
+    }
+
+    const keycloakMajorVersionNumber = SemVer.parse(
+        child_process
+            .execSync(`docker inspect --format '{{.Config.Image}}' ${containerName}`)
+            .toString("utf8")
+            .trim()
+            .split(":")[1]
+    ).major;
+
+    const targetFilePath = pathRelative(
+        process.cwd(),
+        pathJoin(
+            __dirname,
+            "..",
+            "src",
+            "bin",
+            "start-keycloak",
+            `myrealm-realm-${keycloakMajorVersionNumber}.json`
+        )
+    );
+
+    run(`docker cp ${containerName}:/tmp/myrealm-realm.json ${targetFilePath}`);
+
+    console.log(`${chalk.green(`✓ Exported realm to`)} ${chalk.bold(targetFilePath)}`);
+})();
 
 function run(command: string) {
     console.log(chalk.grey(`$ ${command}`));

scripts/link-in-app.ts

@@ -2,46 +2,37 @@ import { execSync } from "child_process";
 import { join as pathJoin, relative as pathRelative } from "path";
 import { getThisCodebaseRootDirPath } from "../src/bin/tools/getThisCodebaseRootDirPath";
 import * as fs from "fs";
+import * as os from "os";
 
 const singletonDependencies: string[] = ["react", "@types/react"];
 
 const rootDirPath = getThisCodebaseRootDirPath();
 
 //NOTE: This is only required because of: https://github.com/garronej/ts-ci/blob/c0e207b9677523d4ec97fe672ddd72ccbb3c1cc4/README.md?plain=1#L54-L58
-fs.writeFileSync(
-    pathJoin(rootDirPath, "dist", "package.json"),
-    Buffer.from(
-        JSON.stringify(
-            (() => {
-                const packageJsonParsed = JSON.parse(
-                    fs
-                        .readFileSync(pathJoin(rootDirPath, "package.json"))
-                        .toString("utf8")
-                );
+{
+    let modifiedPackageJsonContent = fs
+        .readFileSync(pathJoin(rootDirPath, "package.json"))
+        .toString("utf8");
 
-                return {
-                    ...packageJsonParsed,
-                    main: packageJsonParsed["main"]?.replace(/^dist\//, ""),
-                    types: packageJsonParsed["types"]?.replace(/^dist\//, ""),
-                    module: packageJsonParsed["module"]?.replace(/^dist\//, ""),
-                    exports: !("exports" in packageJsonParsed)
-                        ? undefined
-                        : Object.fromEntries(
-                              Object.entries(packageJsonParsed["exports"]).map(
-                                  ([key, value]) => [
-                                      key,
-                                      (value as string).replace(/^\.\/dist\//, "./")
-                                  ]
-                              )
-                          )
-                };
-            })(),
-            null,
-            2
-        ),
-        "utf8"
-    )
-);
+    modifiedPackageJsonContent = (() => {
+        const o = JSON.parse(modifiedPackageJsonContent);
+
+        delete o.files;
+
+        return JSON.stringify(o, null, 2);
+    })();
+
+    modifiedPackageJsonContent = modifiedPackageJsonContent
+        .replace(/"dist\//g, '"')
+        .replace(/"\.\/dist\//g, '"./')
+        .replace(/"!dist\//g, '"!')
+        .replace(/"!\.\/dist\//g, '"!./');
+
+    fs.writeFileSync(
+        pathJoin(rootDirPath, "dist", "package.json"),
+        Buffer.from(modifiedPackageJsonContent, "utf8")
+    );
+}
 
 const commonThirdPartyDeps = (() => {
     // For example [ "@emotion" ] it's more convenient than
@@ -83,7 +74,9 @@ const execYarnLink = (params: { targetModuleName?: string; cwd: string }) => {
         cwd,
         env: {
             ...process.env,
-            HOME: yarnGlobalDirPath
+            ...(os.platform() === "win32"
+                ? { USERPROFILE: yarnGlobalDirPath }
+                : { HOME: yarnGlobalDirPath })
         }
     });
 };

src/PUBLIC_URL.ts

@@ -1,7 +1,4 @@
-import {
-    nameOfTheGlobal,
-    basenameOfTheKeycloakifyResourcesDir
-} from "keycloakify/bin/shared/constants";
+import { basenameOfTheKeycloakifyResourcesDir } from "keycloakify/bin/shared/constants";
 import { assert } from "tsafe/assert";
 
 /**
@@ -9,7 +6,7 @@ import { assert } from "tsafe/assert";
  * This works both in your main app and in your Keycloak theme.
  */
 export const PUBLIC_URL = (() => {
-    const kcContext = (window as any)[nameOfTheGlobal];
+    const kcContext = (window as any).kcContext;
 
     if (kcContext === undefined || process.env.NODE_ENV === "development") {
         assert(

src/account/KcContext/kcContextMocks.ts

@@ -82,17 +82,7 @@ export const kcContextCommonMock: KcContext.Common = {
         email: "john.doe@code.gouv.fr",
         username: "doe_j"
     },
-    properties: {
-        parent: "account-v1",
-        kcButtonLargeClass: "btn-lg",
-        locales:
-            "ar,ca,cs,da,de,en,es,fr,fi,hu,it,ja,lt,nl,no,pl,pt-BR,ru,sk,sv,tr,zh-CN",
-        kcButtonPrimaryClass: "btn-primary",
-        accountResourceProvider: "account-v1",
-        styles: "css/account.css img/icon-sidebar-active.png img/logo.png resources-common/node_modules/patternfly/dist/css/patternfly.min.css resources-common/node_modules/patternfly/dist/css/patternfly-additions.min.css resources-common/node_modules/patternfly/dist/css/patternfly-additions.min.css",
-        kcButtonClass: "btn",
-        kcButtonDefaultClass: "btn-default"
-    }
+    properties: {}
 };
 
 export const kcContextMocks: KcContext[] = [

src/bin/initialize-email-theme.ts

@@ -34,6 +34,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
     const { keycloakVersion } = await promptKeycloakVersion({
         // NOTE: This is arbitrary
         startingFromMajor: 17,
+        excludeMajorVersions: [],
         cacheDirPath: buildContext.cacheDirPath
     });
 

src/bin/keycloakify/buildJars/buildJar.ts

@@ -168,8 +168,8 @@ export async function buildJar(params: {
                 })();
 
                 const modifiedFtlFileContent = ftlFileContent.replace(
-                    `out["pageId"] = "\${pageId}";`,
-                    `out["pageId"] = "${pageId}"; out["realPageId"] = "${realPageId}";`
+                    `kcContext.pageId = "\${pageId}";`,
+                    `kcContext.pageId = "${pageId}"; kcContext.realPageId = "${realPageId}";`
                 );
 
                 assert(modifiedFtlFileContent !== ftlFileContent);

src/bin/keycloakify/buildJars/generatePom.ts

@@ -42,7 +42,7 @@ export function generatePom(params: {
             `  <properties>`,
             `    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>`,
             `  </properties>`,
-            ...(keycloakAccountV1Version !== null &&
+            ...(keycloakAccountV1Version !== null ||
             keycloakThemeAdditionalInfoExtensionVersion !== null
                 ? [
                       `  <build>`,

src/bin/keycloakify/generateFtl/generateFtl.ts

@@ -8,7 +8,6 @@ import type { BuildContext } from "../../shared/buildContext";
 import { assert } from "tsafe/assert";
 import {
     type ThemeType,
-    nameOfTheGlobal,
     basenameOfTheKeycloakifyResourcesDir,
     resources_common,
     nameOfTheLocalizationRealmOverridesUserProfileProperty
@@ -116,7 +115,7 @@ export function generateFtlFilesCodeFactory(params: {
     }
 
     //FTL is no valid html, we can't insert with cheerio, we put placeholder for injecting later.
-    const ftlObjectToJsCodeDeclaringAnObject = fs
+    const kcContextDeclarationTemplateFtl = fs
         .readFileSync(
             pathJoin(
                 getThisCodebaseRootDirPath(),
@@ -124,11 +123,10 @@ export function generateFtlFilesCodeFactory(params: {
                 "bin",
                 "keycloakify",
                 "generateFtl",
-                "ftl_object_to_js_code_declaring_an_object.ftl"
+                "kcContextDeclarationTemplate.ftl"
             )
         )
         .toString("utf8")
-        .match(/^<script>const _=((?:.|\n)+)<\/script>[\n]?$/)![1]
         .replace(
             "FIELD_NAMES_eKsIY4ZsZ4xeM",
             fieldNames.map(name => `"${name}"`).join(", ")
@@ -150,7 +148,7 @@ export function generateFtlFilesCodeFactory(params: {
         '{ "x": "vIdLqMeOed9sdLdIdOxdK0d" }';
 
     $("head").prepend(
-        `<script>\nwindow.${nameOfTheGlobal}=${ftlObjectToJsCodeDeclaringAnObjectPlaceholder}</script>`
+        `<script>\n${ftlObjectToJsCodeDeclaringAnObjectPlaceholder}\n</script>`
     );
 
     // Remove part of the document marked as ignored.
@@ -189,7 +187,7 @@ export function generateFtlFilesCodeFactory(params: {
 
         Object.entries({
             [ftlObjectToJsCodeDeclaringAnObjectPlaceholder]:
-                ftlObjectToJsCodeDeclaringAnObject,
+                kcContextDeclarationTemplateFtl,
             PAGE_ID_xIgLsPgGId9D8e: pageId
         }).map(
             ([searchValue, replaceValue]) =>

src/bin/keycloakify/generateFtl/kcContextDeclarationTemplate.ftl

@@ -1,172 +1,40 @@
-<script>const _= 
-(()=>{
 <#assign pageId="PAGE_ID_xIgLsPgGId9D8e">
-const out = ${ftl_object_to_js_code_declaring_an_object(.data_model, [])?no_esc};
-out["messagesPerField"]= {
-    <#assign fieldNames = [ FIELD_NAMES_eKsIY4ZsZ4xeM ]>
-    <#attempt>
-        <#if profile?? && profile.attributes?? && profile.attributes?is_enumerable>
-            <#list profile.attributes as attribute>
-                <#if fieldNames?seq_contains(attribute.name)>
-                    <#continue>
-                </#if>
-                <#assign fieldNames += [attribute.name]>
-            </#list>
-        </#if>
-    <#recover>
-    </#attempt>
-    "printIfExists": function (fieldName, text) {
-        <#if !messagesPerField?? || !(messagesPerField?is_hash)>   
-            throw new Error("You're not supposed to use messagesPerField.printIfExists in this page");
-        <#else>
-            <#list fieldNames as fieldName>
-                if(fieldName === "${fieldName}" ){
-                    <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
-                    <#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
-                        <#assign doExistErrorOnUsernameOrPassword = "">
-                        <#attempt>
-                            <#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
-                        <#recover>
-                            <#assign doExistErrorOnUsernameOrPassword = true>
-                        </#attempt>
-                        return <#if doExistErrorOnUsernameOrPassword>text<#else>undefined</#if>
-                    <#else>
-                        <#assign doExistMessageForField = "">
-                        <#attempt>
-                            <#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
-                        <#recover>
-                            <#assign doExistMessageForField = true>
-                        </#attempt>
-                        return <#if doExistMessageForField>text<#else>undefined</#if>;
-                    </#if>
-                }
-            </#list>
-            throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
-        </#if>
-    },
-    "existsError": function (){
-        function existsError_singleFieldName(fieldName) {
-            <#if !messagesPerField?? || !(messagesPerField?is_hash)>   
-                throw new Error("You're not supposed to use messagesPerField.printIfExists in this page");
-            <#else>
-                <#list fieldNames as fieldName>
-                    if(fieldName === "${fieldName}" ){
-                        <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
-                        <#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
-                            <#assign doExistErrorOnUsernameOrPassword = "">
-                            <#attempt>
-                                <#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
-                            <#recover>
-                                <#assign doExistErrorOnUsernameOrPassword = true>
-                            </#attempt>
-                            return <#if doExistErrorOnUsernameOrPassword>true<#else>false</#if>;
-                        <#else>
-                            <#assign doExistErrorMessageForField = "">
-                            <#attempt>
-                                <#assign doExistErrorMessageForField = messagesPerField.existsError('${fieldName}')>
-                            <#recover>
-                                <#assign doExistErrorMessageForField = true>
-                            </#attempt>
-                            return <#if doExistErrorMessageForField>true<#else>false</#if>;
-                        </#if>
-                    }
-                </#list>
-                throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
-            </#if>
-        }
+const kcContext = ${ftl_object_to_js_code_declaring_an_object(.data_model, [])?no_esc};
+if( kcContext.messagesPerField ){
+    var existsError_singleFieldName = kcContext.messagesPerField.existsError;
+    kcContext.messagesPerField.existsError = function (){
         for( let i = 0; i < arguments.length; i++ ){
             if( existsError_singleFieldName(arguments[i]) ){
                 return true;
             }
         }
         return false;
-    },
-    "get": function (fieldName) {
-        <#if !messagesPerField?? || !(messagesPerField?is_hash)>   
-            throw new Error("You're not supposed to use messagesPerField.get in this page");
-        <#else>
-            <#list fieldNames as fieldName>
-                if(fieldName === "${fieldName}" ){
-                    <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
-                    <#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
-                        <#assign doExistErrorOnUsernameOrPassword = "">
-                        <#attempt>
-                            <#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
-                        <#recover>
-                            <#assign doExistErrorOnUsernameOrPassword = true>
-                        </#attempt>
-                        <#if doExistErrorOnUsernameOrPassword>
-                            <#attempt>
-                                return decodeHtmlEntities("${msg('invalidUserMessage')?js_string}");
-                            <#recover>
-                                return "Invalid username or password.";
-                            </#attempt>
-                        <#else>
-                            return "";
-                        </#if>
-                    <#else>
-                        <#attempt>
-                            return decodeHtmlEntities("${messagesPerField.get('${fieldName}')?js_string}");
-                        <#recover>
-                            return "Invalid field";
-                        </#attempt>
-                    </#if>
-                }
-            </#list>
-            throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
-        </#if>
-    },
-    "exists": function (fieldName) {
-        <#if !messagesPerField?? || !(messagesPerField?is_hash)>   
-            throw new Error("You're not supposed to use messagesPerField.exists in this page");
-        <#else>
-            <#list fieldNames as fieldName>
-                if(fieldName === "${fieldName}" ){
-                    <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
-                    <#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
-                        <#assign doExistErrorOnUsernameOrPassword = "">
-                        <#attempt>
-                            <#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
-                        <#recover>
-                            <#assign doExistErrorOnUsernameOrPassword = true>
-                        </#attempt>
-                        return <#if doExistErrorOnUsernameOrPassword>true<#else>false</#if>;
-                    <#else>
-                        <#assign doExistErrorMessageForField = "">
-                        <#attempt>
-                            <#assign doExistErrorMessageForField = messagesPerField.exists('${fieldName}')>
-                        <#recover>
-                            <#assign doExistErrorMessageForField = true>
-                        </#attempt>
-                        return <#if doExistErrorMessageForField>true<#else>false</#if>;
-                    </#if>
-                }
-            </#list>
-            throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
-        </#if>
-    },
-    "getFirstError": function () {
+    };
+    kcContext.messagesPerField.exists = function (fieldName) {
+        return kcContext.messagesPerField.get(fieldName) !== "";
+    };
+    kcContext.messagesPerField.printIfExists = function (fieldName, text) {
+        return kcContext.messagesPerField.exists(fieldName) ? text : undefined;
+    };
+    kcContext.messagesPerField.getFirstError = function () {
         for( let i = 0; i < arguments.length; i++ ){
             const fieldName = arguments[i];
-            if( out.messagesPerField.existsError(fieldName) ){
-                return out.messagesPerField.get(fieldName);
+            if( kcContext.messagesPerField.existsError(fieldName) ){
+                return kcContext.messagesPerField.get(fieldName);
             }
         }
-    }
-};
-
-out["keycloakifyVersion"] = "KEYCLOAKIFY_VERSION_xEdKd3xEdr";
-out["themeVersion"] = "KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx";
-out["themeType"] = "KEYCLOAKIFY_THEME_TYPE_dExKd3xEdr";
-out["themeName"] = "KEYCLOAKIFY_THEME_NAME_cXxKd3xEer";
-out["pageId"] = "${pageId}";
-
-try {
-    out["url"]["resourcesCommonPath"] = out["url"]["resourcesPath"] + "/" + "RESOURCES_COMMON_cLsLsMrtDkpVv";
-} catch(error) { }
-
+    };
+}
+kcContext.keycloakifyVersion = "KEYCLOAKIFY_VERSION_xEdKd3xEdr";
+kcContext.themeVersion = "KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx";
+kcContext.themeType = "KEYCLOAKIFY_THEME_TYPE_dExKd3xEdr";
+kcContext.themeName = "KEYCLOAKIFY_THEME_NAME_cXxKd3xEer";
+kcContext.pageId = "${pageId}";
+if( kcContext.url && kcContext.url.resourcesPath ){
+    kcContext.url.resourcesCommonPath = kcContext.url.resourcesPath + "/" + "RESOURCES_COMMON_cLsLsMrtDkpVv";
+}
 <#if profile?? && profile.attributes??>
-    out["lOCALIZATION_REALM_OVERRIDES_USER_PROFILE_PROPERTY_KEY_aaGLsPgGIdeeX"] = {
+    kcContext.lOCALIZATION_REALM_OVERRIDES_USER_PROFILE_PROPERTY_KEY_aaGLsPgGIdeeX = {
         <#list profile.attributes as attribute>
             <#if attribute.annotations?? && attribute.displayName??>
                 "${attribute.displayName}": decodeHtmlEntities("${advancedMsg(attribute.displayName)?js_string}"),
@@ -180,34 +48,34 @@ try {
             <#if attribute.annotations.inputTypePlaceholder??>
                 "${attribute.annotations.inputTypePlaceholder}": decodeHtmlEntities("${advancedMsg(attribute.annotations.inputTypePlaceholder)?js_string}"),
             </#if>
+            <!-- Loop through the options that are in attribute.validators.options.options -->
+            <#if (
+                attribute.annotations.inputOptionLabelsI18nPrefix?? &&
+                attribute.validators?? &&
+                attribute.validators.options??
+            )>
+                <#list attribute.validators.options.options as option>
+                    "${attribute.annotations.inputOptionLabelsI18nPrefix}.${option}": decodeHtmlEntities("${msg(attribute.annotations.inputOptionLabelsI18nPrefix + "." + option)?js_string}"),
+                </#list>
+            </#if>
         </#list>
     };
 </#if>
-
 attributes_to_attributesByName: {
-
-    if( !out["profile"] ){
+    if( !kcContext.profile ){
         break attributes_to_attributesByName;
     }
-
-    if( !out["profile"]["attributes"] ){
+    if( !kcContext.profile.attributes ){
         break attributes_to_attributesByName;
     }
-
-    var attributes =  out["profile"]["attributes"];
-
-    delete out["profile"]["attributes"];
-
-    out["profile"]["attributesByName"] = {};
-
+    var attributes =  kcContext.profile.attributes;
+    delete kcContext.profile.attributes;
+    kcContext.profile.attributesByName = {};
     attributes.forEach(function(attribute){
-        out["profile"]["attributesByName"][attribute.name] = attribute;
+        kcContext.profile.attributesByName[attribute.name] = attribute;
     });
-
 }
-
-return out;
-
+window.kcContext = kcContext;
 function decodeHtmlEntities(htmlStr){
     var element = decodeHtmlEntities.element;
     if (!element) {
@@ -218,7 +86,6 @@ function decodeHtmlEntities(htmlStr){
     return element.value;
 }
 
-})();
 <#function ftl_object_to_js_code_declaring_an_object object path>
 
         <#local isHash = "">
@@ -316,9 +183,24 @@ function decodeHtmlEntities(htmlStr){
                         <#-- We already have the attributes in profile speedup the rendering by filtering it out from the register object -->
                         (key == "attributes" || key == "attributesByName") &&
                         are_same_path(path, ["register"])
+                    ) || (
+                        are_same_path(path, ["properties"]) &&
+                        (
+                            key?starts_with("kc") || 
+                            key == "locales" || 
+                            key == "import" || 
+                            key == "parent" || 
+                            key == "meta" ||
+                            key == "stylesCommon" ||
+                            key == "styles" ||
+                            key == "accountResourceProvider"
+                        )
+                    ) || (
+                        key == "execution" &&
+                        are_same_path(path, [])
                     )
                 >
-                    <#local out_seq += ["/*" + path?join(".") + "." + key + " excluded*/"]>
+                    <#-- <#local out_seq += ["/*" + path?join(".") + "." + key + " excluded*/"]> -->
                     <#continue>
                 </#if>
                 
@@ -326,7 +208,7 @@ function decodeHtmlEntities(htmlStr){
 
                 <#-- https://github.com/keycloakify/keycloakify/discussions/406 -->
                 <#if (
-                    ["register.ftl", "register-user-profile.ftl", "info.ftl", "login.ftl", "login-update-password.ftl", "login-oauth2-device-verify-user-code.ftl"]?seq_contains(pageId) && 
+                    ["register.ftl", "register-user-profile.ftl", "terms.ftl", "info.ftl", "login.ftl", "login-update-password.ftl", "login-oauth2-device-verify-user-code.ftl"]?seq_contains(pageId) && 
                     key == "attemptedUsername" && are_same_path(path, ["auth"])
                 )>
                     <#attempt>
@@ -432,6 +314,110 @@ function decodeHtmlEntities(htmlStr){
                 <#return 'function(){ return "' + returnValue + '"; }'>
             </#if>
 
+            <#assign fieldNames = [ FIELD_NAMES_eKsIY4ZsZ4xeM ]>
+            <#if profile?? && profile.attributes??>
+                <#list profile.attributes as attribute>
+                    <#if fieldNames?seq_contains(attribute.name)>
+                        <#continue>
+                    </#if>
+                    <#assign fieldNames += [attribute.name]>
+                </#list>
+            </#if>
+
+            <#if are_same_path(path, ["messagesPerField", "get"])>
+
+                <#local jsFunctionCode = "function (fieldName) { ">
+
+                <#list fieldNames as fieldName>
+
+                    <#-- See: https://github.com/keycloakify/keycloakify/issues/217 -->
+                    <#if pageId == "login.ftl" >
+
+                        <#if fieldName == "username">
+
+                            <#local jsFunctionCode += "if(fieldName === 'username' || fieldName === 'password' ){ ">
+
+                            <#if messagesPerField.exists('username') || messagesPerField.exists('password')>
+                                <#local jsFunctionCode += "return kcContext.message && kcContext.message.summary ? kcContext.message.summary : 'error'; ">
+                            <#else>
+                                <#local jsFunctionCode += "return ''; ">
+                            </#if>
+
+                            <#local jsFunctionCode += "} ">
+
+                            <#continue>
+                        </#if>
+
+                        <#if fieldName == "password">
+                            <#continue>
+                        </#if>
+
+                    </#if>
+
+                    <#local jsFunctionCode += "if(fieldName === '" + fieldName + "'){ ">
+
+                    <#if messagesPerField.exists('${fieldName}')>
+                        <#local jsFunctionCode += 'return decodeHtmlEntities("' + messagesPerField.get('${fieldName}')?js_string + '"); '>
+                    <#else>
+                        <#local jsFunctionCode += "return ''; ">
+                    </#if>
+
+                    <#local jsFunctionCode += "} ">
+
+                </#list>
+
+                <#local jsFunctionCode += "}">
+
+                <#return jsFunctionCode>
+
+            </#if>
+
+            <#if are_same_path(path, ["messagesPerField", "existsError"])>
+
+                <#local jsFunctionCode = "function (fieldName) { ">
+
+                <#list fieldNames as fieldName>
+
+                    <#-- See: https://github.com/keycloakify/keycloakify/issues/217 -->
+                    <#if pageId == "login.ftl" >
+                        <#if fieldName == "username">
+
+                            <#local jsFunctionCode += "if(fieldName === 'username' || fieldName === 'password' ){ ">
+
+                            <#if messagesPerField.existsError('username') || messagesPerField.existsError('password')>
+                                <#local jsFunctionCode += "return true; ">
+                            <#else>
+                                <#local jsFunctionCode += "return false; ">
+                            </#if>
+
+                            <#local jsFunctionCode += "} ">
+
+                            <#continue>
+                        </#if>
+
+                        <#if fieldName == "password">
+                            <#continue>
+                        </#if>
+                    </#if>
+
+                    <#local jsFunctionCode += "if(fieldName === '" + fieldName + "' ){ ">
+
+                    <#if messagesPerField.existsError('${fieldName}')>
+                        <#local jsFunctionCode += 'return true; '>
+                    <#else>
+                        <#local jsFunctionCode += "return false; ">
+                    </#if>
+
+                    <#local jsFunctionCode += "}">
+
+                </#list>
+
+                <#local jsFunctionCode += "}">
+
+                <#return jsFunctionCode>
+
+            </#if>
+
             <#return "ABORT: It's a method">
         </#if>
 
@@ -562,5 +548,4 @@ function decodeHtmlEntities(htmlStr){
 
 <#function are_same_path path searchedPath>
     <#return path?size == searchedPath?size && is_subpath(path, searchedPath)>
-</#function>
-</script>
+</#function>

src/bin/keycloakify/generateResources/generateResources.ts

@@ -1,20 +1,20 @@
 import type { BuildContext } from "../../shared/buildContext";
 import { assert } from "tsafe/assert";
 import {
-    generateSrcMainResourcesForMainTheme,
-    type BuildContextLike as BuildContextLike_generateSrcMainResourcesForMainTheme
-} from "./generateSrcMainResourcesForMainTheme";
-import { generateSrcMainResourcesForThemeVariant } from "./generateSrcMainResourcesForThemeVariant";
+    generateResourcesForMainTheme,
+    type BuildContextLike as BuildContextLike_generateResourcesForMainTheme
+} from "./generateResourcesForMainTheme";
+import { generateResourcesForThemeVariant } from "./generateResourcesForThemeVariant";
 import fs from "fs";
 import { rmSync } from "../../tools/fs.rmSync";
 
-export type BuildContextLike = BuildContextLike_generateSrcMainResourcesForMainTheme & {
+export type BuildContextLike = BuildContextLike_generateResourcesForMainTheme & {
     themeNames: string[];
 };
 
 assert<BuildContext extends BuildContextLike ? true : false>();
 
-export async function generateSrcMainResources(params: {
+export async function generateResources(params: {
     buildContext: BuildContextLike;
     resourcesDirPath: string;
 }): Promise<void> {
@@ -26,14 +26,14 @@ export async function generateSrcMainResources(params: {
         rmSync(resourcesDirPath, { recursive: true });
     }
 
-    await generateSrcMainResourcesForMainTheme({
+    await generateResourcesForMainTheme({
         resourcesDirPath,
         themeName,
         buildContext
     });
 
     for (const themeVariantName of themeVariantNames) {
-        generateSrcMainResourcesForThemeVariant({
+        generateResourcesForThemeVariant({
             resourcesDirPath,
             themeName,
             themeVariantName

src/bin/keycloakify/generateResources/generateResourcesForMainTheme.ts

@@ -52,7 +52,7 @@ export type BuildContextLike = BuildContextLike_kcContextExclusionsFtlCode &
 
 assert<BuildContext extends BuildContextLike ? true : false>();
 
-export async function generateSrcMainResourcesForMainTheme(params: {
+export async function generateResourcesForMainTheme(params: {
     themeName: string;
     resourcesDirPath: string;
     buildContext: BuildContextLike;
@@ -251,7 +251,7 @@ export async function generateSrcMainResourcesForMainTheme(params: {
                         assert<Equals<typeof themeType, never>>(false);
                     })()}`,
                     ...(buildContext.extraThemeProperties ?? []),
-                    buildContext.environmentVariables.map(
+                    ...buildContext.environmentVariables.map(
                         ({ name, default: defaultValue }) =>
                             `${name}=\${env.${name}:${escapeStringForPropertiesFile(defaultValue)}}`
                     )

src/bin/keycloakify/generateResources/generateResourcesForThemeVariant.ts

@@ -13,7 +13,7 @@ export type BuildContextLike = {
 
 assert<BuildContext extends BuildContextLike ? true : false>();
 
-export function generateSrcMainResourcesForThemeVariant(params: {
+export function generateResourcesForThemeVariant(params: {
     resourcesDirPath: string;
     themeName: string;
     themeVariantName: string;

src/bin/keycloakify/generateResources/index.ts

@@ -0,0 +1 @@
+export * from "./generateResources";

src/bin/keycloakify/generateSrcMainResources/index.ts

@@ -1 +0,0 @@
-export * from "./generateSrcMainResources";

src/bin/keycloakify/keycloakify.ts

@@ -1,4 +1,4 @@
-import { generateSrcMainResources } from "./generateSrcMainResources";
+import { generateResources } from "./generateResources";
 import { join as pathJoin, relative as pathRelative, sep as pathSep } from "path";
 import * as child_process from "child_process";
 import * as fs from "fs";
@@ -82,7 +82,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
 
     const resourcesDirPath = pathJoin(buildContext.keycloakifyBuildDirPath, "resources");
 
-    await generateSrcMainResources({
+    await generateResources({
         resourcesDirPath,
         buildContext
     });

src/bin/keycloakify/replacers/replaceImportsInJsCode/vite.ts

@@ -1,7 +1,4 @@
-import {
-    nameOfTheGlobal,
-    basenameOfTheKeycloakifyResourcesDir
-} from "../../../shared/constants";
+import { basenameOfTheKeycloakifyResourcesDir } from "../../../shared/constants";
 import { assert } from "tsafe/assert";
 import type { BuildContext } from "../../../shared/buildContext";
 import * as nodePath from "path";
@@ -88,13 +85,13 @@ export function replaceImportsInJsCode_vite(params: {
                 fixedJsCode = replaceAll(
                     fixedJsCode,
                     `"${relativePathOfAssetFile}"`,
-                    `(window.${nameOfTheGlobal}.url.resourcesPath.substring(1) + "/${basenameOfTheKeycloakifyResourcesDir}/${relativePathOfAssetFile}")`
+                    `(window.kcContext.url.resourcesPath.substring(1) + "/${basenameOfTheKeycloakifyResourcesDir}/${relativePathOfAssetFile}")`
                 );
 
                 fixedJsCode = replaceAll(
                     fixedJsCode,
                     `"${buildContext.urlPathname ?? "/"}${relativePathOfAssetFile}"`,
-                    `(window.${nameOfTheGlobal}.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/${relativePathOfAssetFile}")`
+                    `(window.kcContext.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/${relativePathOfAssetFile}")`
                 );
             });
     }

src/bin/keycloakify/replacers/replaceImportsInJsCode/webpack.ts

@@ -1,7 +1,4 @@
-import {
-    nameOfTheGlobal,
-    basenameOfTheKeycloakifyResourcesDir
-} from "../../../shared/constants";
+import { basenameOfTheKeycloakifyResourcesDir } from "../../../shared/constants";
 import { assert } from "tsafe/assert";
 import type { BuildContext } from "../../../shared/buildContext";
 import * as nodePath from "path";
@@ -86,7 +83,7 @@ export function replaceImportsInJsCode_webpack(params: {
                 var pd = Object.getOwnPropertyDescriptor(${n}, "p");
                 if( pd === undefined || pd.configurable ){
                     Object.defineProperty(${n}, "p", {
-                        get: function() { return window.${nameOfTheGlobal}.url.resourcesPath; },
+                        get: function() { return window.kcContext.url.resourcesPath; },
                         set: function() {}
                     });
                 }
@@ -107,7 +104,7 @@ export function replaceImportsInJsCode_webpack(params: {
                 `[a-zA-Z]+\\.[a-zA-Z]+\\+"${staticDir.replace(/\//g, "\\/")}`,
                 "g"
             ),
-            `window.${nameOfTheGlobal}.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/${staticDir}`
+            `window.kcContext.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/${staticDir}`
         );
 
     return { fixedJsCode };

src/bin/shared/buildContext.ts

@@ -5,7 +5,7 @@ import { getNpmWorkspaceRootDirPath } from "../tools/getNpmWorkspaceRootDirPath"
 import type { CliCommandOptions } from "../main";
 import { z } from "zod";
 import * as fs from "fs";
-import { assert } from "tsafe";
+import { assert, type Equals } from "tsafe";
 import * as child_process from "child_process";
 import { vitePluginSubScriptEnvNames } from "./constants";
 
@@ -102,15 +102,33 @@ export function getBuildContext(params: {
     })();
 
     const parsedPackageJson = (() => {
+        type WebpackSpecificBuildOptions = {
+            projectBuildDirPath?: string;
+        };
+
         type ParsedPackageJson = {
             name: string;
             version?: string;
             homepage?: string;
-            keycloakify?: BuildOptions & {
+            keycloakify?: {
+                themeName?: string | string[];
+                environmentVariables?: { name: string; default: string }[];
+                extraThemeProperties?: string[];
+                artifactId?: string;
+                groupId?: string;
+                loginThemeResourcesFromKeycloakVersion?: string;
+                keycloakifyBuildDirPath?: string;
+                kcContextExclusionsFtl?: string;
                 projectBuildDirPath?: string;
             };
         };
 
+        {
+            type Got = NonNullable<ParsedPackageJson["keycloakify"]>;
+            type Expected = BuildOptions & WebpackSpecificBuildOptions;
+            assert<Equals<Got, Expected>>();
+        }
+
         const zParsedPackageJson = z.object({
             name: z.string(),
             version: z.string().optional(),
@@ -123,16 +141,24 @@ export function getBuildContext(params: {
                     loginThemeResourcesFromKeycloakVersion: z.string().optional(),
                     projectBuildDirPath: z.string().optional(),
                     keycloakifyBuildDirPath: z.string().optional(),
+                    kcContextExclusionsFtl: z.string().optional(),
+                    environmentVariables: z
+                        .array(
+                            z.object({
+                                name: z.string(),
+                                default: z.string()
+                            })
+                        )
+                        .optional(),
                     themeName: z.union([z.string(), z.array(z.string())]).optional()
                 })
                 .optional()
         });
 
         {
-            type Got = ReturnType<(typeof zParsedPackageJson)["parse"]>;
+            type Got = z.infer<typeof zParsedPackageJson>;
             type Expected = ParsedPackageJson;
-            assert<Got extends Expected ? true : false>();
-            assert<Expected extends Got ? true : false>();
+            assert<Equals<Got, Expected>>();
         }
 
         return zParsedPackageJson.parse(

src/bin/shared/constants.ts

@@ -1,4 +1,3 @@
-export const nameOfTheGlobal = "kcContext";
 export const nameOfTheLocalizationRealmOverridesUserProfileProperty =
     "__localizationRealmOverridesUserProfile";
 export const keycloak_resources = "keycloak-resources";

src/bin/shared/generateKcGenTs.ts

@@ -46,7 +46,7 @@ export async function generateKcGenTs(params: {
             ``,
             `export type KcEnvName = ${buildContext.environmentVariables.length === 0 ? "never" : buildContext.environmentVariables.map(({ name }) => `"${name}"`).join(" | ")};`,
             ``,
-            `export const KcEnvNames: KcEnvName[] = [${buildContext.environmentVariables.map(({ name }) => `"${name}"`).join(", ")}];`,
+            `export const kcEnvNames: KcEnvName[] = [${buildContext.environmentVariables.map(({ name }) => `"${name}"`).join(", ")}];`,
             ``,
             `export const kcEnvDefaults: Record<KcEnvName, string> = ${JSON.stringify(
                 Object.fromEntries(

src/bin/shared/promptKeycloakVersion.ts

@@ -9,9 +9,10 @@ import { id } from "tsafe/id";
 
 export async function promptKeycloakVersion(params: {
     startingFromMajor: number | undefined;
+    excludeMajorVersions: number[];
     cacheDirPath: string;
 }) {
-    const { startingFromMajor, cacheDirPath } = params;
+    const { startingFromMajor, excludeMajorVersions, cacheDirPath } = params;
 
     const { getLatestsSemVersionedTag } = (() => {
         const { octokit } = (() => {
@@ -95,6 +96,10 @@ export async function promptKeycloakVersion(params: {
             return;
         }
 
+        if (excludeMajorVersions.includes(semVersionedTag.version.major)) {
+            return;
+        }
+
         const currentSemVersionedTag = semVersionedTagByMajor.get(
             semVersionedTag.version.major
         );

src/bin/start-keycloak/appBuild.ts

@@ -109,7 +109,7 @@ export async function appBuild(params: {
 
     const dResult = new Deferred<{ isSuccess: boolean }>();
 
-    const child = child_process.spawn(command, args, { cwd });
+    const child = child_process.spawn(command, args, { cwd, shell: true });
 
     child.stdout.on("data", data => {
         if (data.toString("utf8").includes("gzip:")) {

src/bin/start-keycloak/keycloakifyBuild.ts

@@ -26,7 +26,8 @@ export async function keycloakifyBuild(params: {
         env: {
             ...process.env,
             [onlyBuildJarFileBasenameEnvName]: onlyBuildJarFileBasename
-        }
+        },
+        shell: true
     });
 
     child.stdout.on("data", data => process.stdout.write(data));

src/bin/start-keycloak/myrealm-realm-23.json

@@ -587,7 +587,9 @@
             "publicClient": true,
             "frontchannelLogout": false,
             "protocol": "openid-connect",
-            "attributes": {},
+            "attributes": {
+                "post.logout.redirect.uris": "+"
+            },
             "authenticationFlowBindingOverrides": {},
             "fullScopeAllowed": false,
             "nodeReRegistrationTimeout": 0,
@@ -619,7 +621,9 @@
             "publicClient": false,
             "frontchannelLogout": false,
             "protocol": "openid-connect",
-            "attributes": {},
+            "attributes": {
+                "post.logout.redirect.uris": "+"
+            },
             "authenticationFlowBindingOverrides": {},
             "fullScopeAllowed": false,
             "nodeReRegistrationTimeout": 0,
@@ -695,7 +699,9 @@
             "publicClient": false,
             "frontchannelLogout": false,
             "protocol": "openid-connect",
-            "attributes": {},
+            "attributes": {
+                "post.logout.redirect.uris": "+"
+            },
             "authenticationFlowBindingOverrides": {},
             "fullScopeAllowed": false,
             "nodeReRegistrationTimeout": 0,
@@ -783,6 +789,7 @@
                     "config": {
                         "introspection.token.claim": "true",
                         "multivalued": "true",
+                        "userinfo.token.claim": "true",
                         "user.attribute": "foo",
                         "id.token.claim": "true",
                         "access.token.claim": "true",
@@ -827,7 +834,8 @@
                     "config": {
                         "id.token.claim": "true",
                         "introspection.token.claim": "true",
-                        "access.token.claim": "true"
+                        "access.token.claim": "true",
+                        "userinfo.token.claim": "true"
                     }
                 }
             ]
@@ -1348,10 +1356,10 @@
                 "config": {
                     "allowed-protocol-mapper-types": [
                         "oidc-sha256-pairwise-sub-mapper",
+                        "oidc-address-mapper",
+                        "saml-user-property-mapper",
                         "oidc-full-name-mapper",
                         "oidc-usermodel-attribute-mapper",
-                        "saml-user-property-mapper",
-                        "oidc-address-mapper",
                         "saml-role-list-mapper",
                         "saml-user-attribute-mapper",
                         "oidc-usermodel-property-mapper"
@@ -1423,13 +1431,13 @@
                 "subComponents": {},
                 "config": {
                     "allowed-protocol-mapper-types": [
+                        "saml-user-property-mapper",
+                        "oidc-full-name-mapper",
                         "saml-user-attribute-mapper",
                         "oidc-sha256-pairwise-sub-mapper",
-                        "oidc-usermodel-attribute-mapper",
-                        "oidc-address-mapper",
                         "saml-role-list-mapper",
-                        "oidc-full-name-mapper",
-                        "saml-user-property-mapper",
+                        "oidc-address-mapper",
+                        "oidc-usermodel-attribute-mapper",
                         "oidc-usermodel-property-mapper"
                     ]
                 }
@@ -2043,7 +2051,7 @@
             "name": "Terms and Conditions",
             "providerId": "TERMS_AND_CONDITIONS",
             "enabled": true,
-            "defaultAction": false,
+            "defaultAction": true,
             "priority": 20,
             "config": {}
         },
@@ -2122,8 +2130,8 @@
         "cibaExpiresIn": "120",
         "cibaAuthRequestedUserHint": "login_hint",
         "oauth2DeviceCodeLifespan": "600",
-        "oauth2DevicePollingInterval": "5",
         "clientOfflineSessionMaxLifespan": "0",
+        "oauth2DevicePollingInterval": "5",
         "clientSessionIdleTimeout": "0",
         "parRequestUriLifespan": "60",
         "clientSessionMaxLifespan": "0",

src/bin/start-keycloak/myrealm-realm-24.json

@@ -1501,14 +1501,14 @@
                 "subComponents": {},
                 "config": {
                     "allowed-protocol-mapper-types": [
-                        "oidc-sha256-pairwise-sub-mapper",
                         "saml-role-list-mapper",
                         "oidc-address-mapper",
                         "oidc-usermodel-property-mapper",
+                        "oidc-sha256-pairwise-sub-mapper",
                         "saml-user-attribute-mapper",
+                        "oidc-usermodel-attribute-mapper",
                         "oidc-full-name-mapper",
-                        "saml-user-property-mapper",
-                        "oidc-usermodel-attribute-mapper"
+                        "saml-user-property-mapper"
                     ]
                 }
             },
@@ -1541,13 +1541,13 @@
                 "config": {
                     "allowed-protocol-mapper-types": [
                         "oidc-sha256-pairwise-sub-mapper",
-                        "saml-user-property-mapper",
-                        "oidc-usermodel-attribute-mapper",
-                        "oidc-address-mapper",
                         "oidc-usermodel-property-mapper",
+                        "oidc-full-name-mapper",
+                        "oidc-address-mapper",
+                        "oidc-usermodel-attribute-mapper",
+                        "saml-user-property-mapper",
                         "saml-role-list-mapper",
-                        "saml-user-attribute-mapper",
-                        "oidc-full-name-mapper"
+                        "saml-user-attribute-mapper"
                     ]
                 }
             },
@@ -2200,7 +2200,7 @@
             "name": "Terms and Conditions",
             "providerId": "TERMS_AND_CONDITIONS",
             "enabled": true,
-            "defaultAction": false,
+            "defaultAction": true,
             "priority": 20,
             "config": {}
         },
@@ -2307,7 +2307,7 @@
         "cibaInterval": "5",
         "realmReusableOtpCode": "false"
     },
-    "keycloakVersion": "24.0.4",
+    "keycloakVersion": "24.0.5",
     "userManagedAccessAllowed": false,
     "clientProfiles": {
         "profiles": []

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

@@ -9,7 +9,12 @@ import type { KeycloakVersionRange } from "../shared/KeycloakVersionRange";
 import { getJarFileBasename } from "../shared/getJarFileBasename";
 import { assert, type Equals } from "tsafe/assert";
 import * as fs from "fs";
-import { join as pathJoin, relative as pathRelative, sep as pathSep } from "path";
+import {
+    join as pathJoin,
+    relative as pathRelative,
+    sep as pathSep,
+    basename as pathBasename
+} from "path";
 import * as child_process from "child_process";
 import chalk from "chalk";
 import chokidar from "chokidar";
@@ -159,7 +164,8 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
             );
 
             const { keycloakVersion } = await promptKeycloakVersion({
-                startingFromMajor: 17,
+                startingFromMajor: 18,
+                excludeMajorVersions: [22],
                 cacheDirPath: buildContext.cacheDirPath
             });
 
@@ -231,6 +237,10 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
 
     const realmJsonFilePath = await (async () => {
         if (cliCommandOptions.realmJsonFilePath !== undefined) {
+            if (cliCommandOptions.realmJsonFilePath === "none") {
+                return undefined;
+            }
+
             console.log(
                 chalk.green(
                     `Using realm json file: ${cliCommandOptions.realmJsonFilePath}`
@@ -243,46 +253,70 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
             });
         }
 
-        const dirPath = pathJoin(
-            getThisCodebaseRootDirPath(),
-            "src",
-            "bin",
-            "start-keycloak"
-        );
+        const internalFilePath = await (async () => {
+            const dirPath = pathJoin(
+                getThisCodebaseRootDirPath(),
+                "src",
+                "bin",
+                "start-keycloak"
+            );
 
-        const filePath = pathJoin(
-            dirPath,
-            `myrealm-realm-${keycloakMajorVersionNumber}.json`
-        );
+            const filePath = pathJoin(
+                dirPath,
+                `myrealm-realm-${keycloakMajorVersionNumber}.json`
+            );
 
-        if (fs.existsSync(filePath)) {
-            return filePath;
-        }
+            if (fs.existsSync(filePath)) {
+                return filePath;
+            }
 
-        console.log(
-            `${chalk.yellow(
-                `Keycloakify do not have a realm configuration for Keycloak ${keycloakMajorVersionNumber} yet.`
-            )}`
-        );
+            console.log(
+                `${chalk.yellow(
+                    `Keycloakify do not have a realm configuration for Keycloak ${keycloakMajorVersionNumber} yet.`
+                )}`
+            );
 
-        console.log(chalk.cyan("Select what configuration to use:"));
+            console.log(chalk.cyan("Select what configuration to use:"));
 
-        const { value } = await cliSelect<string>({
-            values: [
-                ...fs
-                    .readdirSync(dirPath)
-                    .filter(fileBasename => fileBasename.endsWith(".json")),
-                "none"
-            ]
-        }).catch(() => {
-            process.exit(-1);
-        });
+            const { value } = await cliSelect<string>({
+                values: [
+                    ...fs
+                        .readdirSync(dirPath)
+                        .filter(fileBasename => fileBasename.endsWith(".json")),
+                    "none"
+                ]
+            }).catch(() => {
+                process.exit(-1);
+            });
 
-        if (value === "none") {
+            if (value === "none") {
+                return undefined;
+            }
+
+            return pathJoin(dirPath, value);
+        })();
+
+        if (internalFilePath === undefined) {
             return undefined;
         }
 
-        return pathJoin(dirPath, value);
+        const filePath = pathJoin(
+            buildContext.cacheDirPath,
+            pathBasename(internalFilePath)
+        );
+
+        fs.writeFileSync(
+            filePath,
+            Buffer.from(
+                fs
+                    .readFileSync(internalFilePath)
+                    .toString("utf8")
+                    .replace(/keycloakify\-starter/g, buildContext.themeNames[0])
+            ),
+            "utf8"
+        );
+
+        return filePath;
     })();
 
     const jarFilePath = pathJoin(buildContext.keycloakifyBuildDirPath, jarFileBasename);
@@ -312,6 +346,10 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
 
     await extractThemeResourcesFromJar();
 
+    const jarFilePath_cacheDir = pathJoin(buildContext.cacheDirPath, jarFileBasename);
+
+    fs.copyFileSync(jarFilePath, jarFilePath_cacheDir);
+
     try {
         child_process.execSync(`docker rm --force ${containerName}`, {
             stdio: "ignore"
@@ -332,7 +370,10 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
                       "-v",
                       `${realmJsonFilePath}:/opt/keycloak/data/import/myrealm-realm.json`
                   ]),
-            ...["-v", `${jarFilePath}:/opt/keycloak/providers/keycloak-theme.jar`],
+            ...[
+                "-v",
+                `${jarFilePath_cacheDir}:/opt/keycloak/providers/keycloak-theme.jar`
+            ],
             ...(keycloakMajorVersionNumber <= 20
                 ? ["-e", "JAVA_OPTS=-Dkeycloak.profile=preview"]
                 : []),
@@ -380,7 +421,8 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
             ...(realmJsonFilePath === undefined ? [] : ["--import-realm"])
         ],
         {
-            cwd: buildContext.keycloakifyBuildDirPath
+            cwd: buildContext.keycloakifyBuildDirPath,
+            shell: true
         }
     ] as const;
 

src/bin/tools/downloadAndExtractArchive/fetchProxyOptions.ts

@@ -79,8 +79,16 @@ export async function getProxyFetchOptions(params: {
                 }
 
                 const cafileContent = await readFile(cafile, "utf-8");
+
+                const newLinePlaceholder = "NEW_LINE_PLACEHOLDER_xIsPsK23svt";
+
                 return chunks(cafileContent.split(/(-----END CERTIFICATE-----)/), 2).map(
-                    ca => ca.join("").replace(/^\n/, "").replace(/\n/g, "\\n")
+                    ca =>
+                        ca
+                            .join("")
+                            .replace(/\r?\n/g, newLinePlaceholder)
+                            .replace(new RegExp(`^${newLinePlaceholder}`), "")
+                            .replace(new RegExp(newLinePlaceholder, "g"), "\\n")
                 );
             })())
         );

src/bin/tools/extractArchive.ts

@@ -109,7 +109,7 @@ export async function extractArchive(params: {
     zipFile.on("entry", async (entry: yauzl.Entry) => {
         handle_file: {
             // NOTE: Skip directories
-            if (entry.fileName.endsWith(pathSep)) {
+            if (entry.fileName.endsWith("/")) {
                 break handle_file;
             }
 

src/bin/tools/fetchProxyOptions.ts

@@ -1,96 +0,0 @@
-import { exec as execCallback } from "child_process";
-import { readFile } from "fs/promises";
-import { type FetchOptions } from "make-fetch-happen";
-import { promisify } from "util";
-
-function ensureArray<T>(arg0: T | T[]) {
-    return Array.isArray(arg0) ? arg0 : typeof arg0 === "undefined" ? [] : [arg0];
-}
-
-function ensureSingleOrNone<T>(arg0: T | T[]) {
-    if (!Array.isArray(arg0)) return arg0;
-    if (arg0.length === 0) return undefined;
-    if (arg0.length === 1) return arg0[0];
-    throw new Error(
-        "Illegal configuration, expected a single value but found multiple: " +
-            arg0.map(String).join(", ")
-    );
-}
-
-type NPMConfig = Record<string, string | string[]>;
-
-/**
- * Get npm configuration as map
- */
-async function getNmpConfig(params: { npmWorkspaceRootDirPath: string }) {
-    const { npmWorkspaceRootDirPath } = params;
-
-    const exec = promisify(execCallback);
-
-    const stdout = await exec("npm config get", {
-        encoding: "utf8",
-        cwd: npmWorkspaceRootDirPath
-    }).then(({ stdout }) => stdout);
-
-    const npmConfigReducer = (cfg: NPMConfig, [key, value]: [string, string]) =>
-        key in cfg
-            ? { ...cfg, [key]: [...ensureArray(cfg[key]), value] }
-            : { ...cfg, [key]: value };
-
-    return stdout
-        .split("\n")
-        .filter(line => !line.startsWith(";"))
-        .map(line => line.trim())
-        .map(line => line.split("=", 2) as [string, string])
-        .reduce(npmConfigReducer, {} as NPMConfig);
-}
-
-export type ProxyFetchOptions = Pick<
-    FetchOptions,
-    "proxy" | "noProxy" | "strictSSL" | "cert" | "ca"
->;
-
-export async function getProxyFetchOptions(params: {
-    npmWorkspaceRootDirPath: string;
-}): Promise<ProxyFetchOptions> {
-    const { npmWorkspaceRootDirPath } = params;
-
-    const cfg = await getNmpConfig({ npmWorkspaceRootDirPath });
-
-    const proxy = ensureSingleOrNone(cfg["https-proxy"] ?? cfg["proxy"]);
-    const noProxy = cfg["noproxy"] ?? cfg["no-proxy"];
-
-    function maybeBoolean(arg0: string | undefined) {
-        return typeof arg0 === "undefined" ? undefined : Boolean(arg0);
-    }
-
-    const strictSSL = maybeBoolean(ensureSingleOrNone(cfg["strict-ssl"]));
-    const cert = cfg["cert"];
-    const ca = ensureArray(cfg["ca"] ?? cfg["ca[]"]);
-    const cafile = ensureSingleOrNone(cfg["cafile"]);
-
-    if (typeof cafile !== "undefined" && cafile !== "null") {
-        ca.push(
-            ...(await (async () => {
-                function chunks<T>(arr: T[], size: number = 2) {
-                    return arr
-                        .map((_, i) => i % size == 0 && arr.slice(i, i + size))
-                        .filter(Boolean) as T[][];
-                }
-
-                const cafileContent = await readFile(cafile, "utf-8");
-                return chunks(cafileContent.split(/(-----END CERTIFICATE-----)/), 2).map(
-                    ca => ca.join("").replace(/^\n/, "").replace(/\n/g, "\\n")
-                );
-            })())
-        );
-    }
-
-    return {
-        proxy,
-        noProxy,
-        strictSSL,
-        cert,
-        ca: ca.length === 0 ? undefined : ca
-    };
-}

src/login/DefaultPage.tsx

@@ -4,7 +4,7 @@ import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
 import type { I18n } from "keycloakify/login/i18n";
 import type { KcContext } from "keycloakify/login/KcContext";
-import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFields";
+import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFieldsProps";
 
 const Login = lazy(() => import("keycloakify/login/pages/Login"));
 const Register = lazy(() => import("keycloakify/login/pages/Register"));

src/login/KcContext/KcContext.ts

@@ -209,17 +209,13 @@ export declare namespace KcContext {
     export type Register = Common & {
         pageId: "register.ftl";
         profile: UserProfile;
+        passwordPolicies?: PasswordPolicies;
         url: {
             registrationAction: string;
         };
         passwordRequired: boolean;
         recaptchaRequired: boolean;
         recaptchaSiteKey?: string;
-        /**
-         * Theses values are added by: https://github.com/jcputney/keycloak-theme-additional-info-extension
-         * A Keycloak Java extension used as dependency in Keycloakify.
-         */
-        passwordPolicies?: PasswordPolicies;
         termsAcceptanceRequired?: boolean;
     };
 
@@ -233,6 +229,7 @@ export declare namespace KcContext {
         client: {
             baseUrl?: string;
         };
+        message: NonNullable<Common["message"]>;
     };
 
     export type Error = Common & {
@@ -479,16 +476,19 @@ export declare namespace KcContext {
     export type LoginUpdateProfile = Common & {
         pageId: "login-update-profile.ftl";
         profile: UserProfile;
+        passwordPolicies?: PasswordPolicies;
     };
 
     export type IdpReviewUserProfile = Common & {
         pageId: "idp-review-user-profile.ftl";
         profile: UserProfile;
+        passwordPolicies?: PasswordPolicies;
     };
 
     export type UpdateEmail = Common & {
         pageId: "update-email.ftl";
         profile: UserProfile;
+        passwordPolicies?: PasswordPolicies;
     };
 
     export type SelectAuthenticator = Common & {
@@ -752,6 +752,10 @@ export declare namespace Validators {
     assert<Equals<OnlyInExpected, never>>();
 }
 
+/**
+ * Theses values are added by: https://github.com/jcputney/keycloak-theme-additional-info-extension
+ * A Keycloak Java extension used as dependency in Keycloakify.
+ */
 export type PasswordPolicies = {
     /** The minimum length of the password */
     length?: number;

src/login/KcContext/kcContextMocks.ts

@@ -99,13 +99,22 @@ export const kcContextCommonMock: KcContext.Common = {
         registrationEmailAsUsername: false
     },
     messagesPerField: {
-        printIfExists: () => {
-            return undefined;
-        },
+        get: () => "",
         existsError: () => false,
-        get: fieldName => `Fake error for ${fieldName}`,
-        exists: () => false,
-        getFirstError: fieldName => `Fake error for ${fieldName}`
+        printIfExists: function <T>(fieldName: string, text: T) {
+            return this.get(fieldName) !== "" ? text : undefined;
+        },
+        exists: function (fieldName) {
+            return this.get(fieldName) !== "";
+        },
+        getFirstError: function (...fieldNames) {
+            for (const fieldName of fieldNames) {
+                if (this.existsError(fieldName)) {
+                    return this.get(fieldName);
+                }
+            }
+            return "";
+        }
     },
     locale: {
         supported: [
@@ -212,6 +221,11 @@ export const kcContextMocks = [
             clientId: "myApp",
             baseUrl: "#",
             attributes: {}
+        },
+        message: {
+            type: "info",
+            summary:
+                "This is the info message from the Keycloak server (in real environment, this message is localized)"
         }
     }),
     id<KcContext.Error>({
@@ -224,7 +238,8 @@ export const kcContextMocks = [
         },
         message: {
             type: "error",
-            summary: "This is the error message"
+            summary:
+                "This is the error message from the Keycloak server (in real environment, this message is localized)"
         }
     }),
     id<KcContext.LoginResetPassword>({

src/login/UserProfileFormFields.tsx

@@ -4,33 +4,15 @@ import type { KcClsx } from "keycloakify/login/lib/kcClsx";
 import {
     useUserProfileForm,
     getButtonToDisplayForMultivaluedAttributeField,
-    type KcContextLike,
     type FormAction,
     type FormFieldError
 } from "keycloakify/login/lib/useUserProfileForm";
+import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFieldsProps";
 import type { Attribute } from "keycloakify/login/KcContext";
+import type { KcContext } from "./KcContext";
 import type { I18n } from "./i18n";
 
-export type UserProfileFormFieldsProps = {
-    kcContext: KcContextLike;
-    i18n: I18n;
-    kcClsx: KcClsx;
-    onIsFormSubmittableValueChange: (isFormSubmittable: boolean) => void;
-    doMakeUserConfirmPassword: boolean;
-    BeforeField?: (props: BeforeAfterFieldProps) => JSX.Element | null;
-    AfterField?: (props: BeforeAfterFieldProps) => JSX.Element | null;
-};
-
-type BeforeAfterFieldProps = {
-    attribute: Attribute;
-    dispatchFormAction: React.Dispatch<FormAction>;
-    displayableErrors: FormFieldError[];
-    valueOrValues: string | string[];
-    kcClsx: KcClsx;
-    i18n: I18n;
-};
-
-export default function UserProfileFormFields(props: UserProfileFormFieldsProps) {
+export default function UserProfileFormFields(props: UserProfileFormFieldsProps<KcContext, I18n>) {
     const { kcContext, i18n, kcClsx, onIsFormSubmittableValueChange, doMakeUserConfirmPassword, BeforeField, AfterField } = props;
 
     const { advancedMsg } = i18n;

src/login/UserProfileFormFieldsProps.tsx

@@ -0,0 +1,22 @@
+import { type FormAction, type FormFieldError } from "keycloakify/login/lib/useUserProfileForm";
+import type { KcClsx } from "keycloakify/login/lib/kcClsx";
+import type { Attribute } from "keycloakify/login/KcContext";
+
+export type UserProfileFormFieldsProps<KcContext = any, I18n = any> = {
+    kcContext: Extract<KcContext, { profile: unknown }>;
+    i18n: I18n;
+    kcClsx: KcClsx;
+    onIsFormSubmittableValueChange: (isFormSubmittable: boolean) => void;
+    doMakeUserConfirmPassword: boolean;
+    BeforeField?: (props: BeforeAfterFieldProps<I18n>) => JSX.Element | null;
+    AfterField?: (props: BeforeAfterFieldProps<I18n>) => JSX.Element | null;
+};
+
+type BeforeAfterFieldProps<I18n> = {
+    attribute: Attribute;
+    dispatchFormAction: React.Dispatch<FormAction>;
+    displayableErrors: FormFieldError[];
+    valueOrValues: string | string[];
+    kcClsx: KcClsx;
+    i18n: I18n;
+};

src/login/lib/useUserProfileForm.tsx

@@ -79,9 +79,9 @@ export type KcContextLike = KcContextLike_i18n &
         };
     };
 
-assert<Extract<KcContext.Register, { pageId: "register.ftl" }> extends KcContextLike ? true : false>();
+assert<Extract<Extract<KcContext, { profile: unknown }>, { pageId: "register.ftl" }> extends KcContextLike ? true : false>();
 
-export type ParamsOfUseUserProfileForm = {
+export type UseUserProfileFormParams = {
     kcContext: KcContextLike;
     i18n: I18n;
     doMakeUserConfirmPassword: boolean;
@@ -105,7 +105,7 @@ namespace internal {
     };
 }
 
-export function useUserProfileForm(params: ParamsOfUseUserProfileForm): ReturnTypeOfUseUserProfileForm {
+export function useUserProfileForm(params: UseUserProfileFormParams): ReturnTypeOfUseUserProfileForm {
     const { kcContext, i18n, doMakeUserConfirmPassword } = params;
 
     const { insertScriptTags } = useInsertScriptTags({
@@ -130,168 +130,137 @@ export function useUserProfileForm(params: ParamsOfUseUserProfileForm): ReturnTy
     const initialState = useMemo((): internal.State => {
         // NOTE: We don't use te kcContext.profile.attributes directly because
         // they don't includes the password and password confirm fields and we want to add them.
-        // Also, we want to polyfill the attributes for older Keycloak version before User Profile was introduced.
-        // Finally we want to patch the changes made by Keycloak on the attributes format so we have an homogeneous
-        // attributes format to work with.
-        const syntheticAttributes = (() => {
-            const syntheticAttributes: Attribute[] = [];
+        // We also want to apply some retro-compatibility and consistency patches.
+        const attributes: Attribute[] = (() => {
+            mock_user_profile_attributes_for_older_keycloak_versions: {
+                if (
+                    "profile" in kcContext &&
+                    "attributesByName" in kcContext.profile &&
+                    Object.keys(kcContext.profile.attributesByName).length !== 0
+                ) {
+                    break mock_user_profile_attributes_for_older_keycloak_versions;
+                }
 
-            const attributes = (() => {
-                retrocompat_patch: {
-                    if (
-                        "profile" in kcContext &&
-                        "attributesByName" in kcContext.profile &&
-                        Object.keys(kcContext.profile.attributesByName).length !== 0
-                    ) {
-                        break retrocompat_patch;
-                    }
-
-                    if ("register" in kcContext && kcContext.register instanceof Object && "formData" in kcContext.register) {
-                        //NOTE: Handle legacy register.ftl page
-                        return (["firstName", "lastName", "email", "username"] as const)
-                            .filter(name => (name !== "username" ? true : !kcContext.realm.registrationEmailAsUsername))
-                            .map(name =>
-                                id<Attribute>({
-                                    name: name,
-                                    displayName: id<`\${${MessageKey}}`>(`\${${name}}`),
-                                    required: true,
-                                    value: (kcContext.register as any).formData[name] ?? "",
-                                    html5DataAnnotations: {},
-                                    readOnly: false,
-                                    validators: {},
-                                    annotations: {},
-                                    autocomplete: (() => {
-                                        switch (name) {
-                                            case "email":
-                                                return "email";
-                                            case "username":
-                                                return "username";
-                                            default:
-                                                return undefined;
-                                        }
-                                    })()
-                                })
-                            );
-                    }
-
-                    if ("user" in kcContext && kcContext.user instanceof Object) {
-                        //NOTE: Handle legacy login-update-profile.ftl
-                        return (["username", "email", "firstName", "lastName"] as const)
-                            .filter(name => (name !== "username" ? true : (kcContext.user as any).editUsernameAllowed))
-                            .map(name =>
-                                id<Attribute>({
-                                    name: name,
-                                    displayName: id<`\${${MessageKey}}`>(`\${${name}}`),
-                                    required: true,
-                                    value: (kcContext as any).user[name] ?? "",
-                                    html5DataAnnotations: {},
-                                    readOnly: false,
-                                    validators: {},
-                                    annotations: {},
-                                    autocomplete: (() => {
-                                        switch (name) {
-                                            case "email":
-                                                return "email";
-                                            case "username":
-                                                return "username";
-                                            default:
-                                                return undefined;
-                                        }
-                                    })()
-                                })
-                            );
-                    }
-
-                    if ("email" in kcContext && kcContext.email instanceof Object) {
-                        //NOTE: Handle legacy update-email.ftl
-                        return [
+                if ("register" in kcContext && kcContext.register instanceof Object && "formData" in kcContext.register) {
+                    //NOTE: Handle legacy register.ftl page
+                    return (["firstName", "lastName", "email", "username"] as const)
+                        .filter(name => (name !== "username" ? true : !kcContext.realm.registrationEmailAsUsername))
+                        .map(name =>
                             id<Attribute>({
-                                name: "email",
-                                displayName: id<`\${${MessageKey}}`>(`\${email}`),
+                                name: name,
+                                displayName: id<`\${${MessageKey}}`>(`\${${name}}`),
                                 required: true,
-                                value: (kcContext.email as any).value ?? "",
+                                value: (kcContext.register as any).formData[name] ?? "",
                                 html5DataAnnotations: {},
                                 readOnly: false,
                                 validators: {},
                                 annotations: {},
-                                autocomplete: "email"
+                                autocomplete: (() => {
+                                    switch (name) {
+                                        case "email":
+                                            return "email";
+                                        case "username":
+                                            return "username";
+                                        default:
+                                            return undefined;
+                                    }
+                                })()
                             })
-                        ];
-                    }
-
-                    assert(false, "Unable to mock user profile from the current kcContext");
+                        );
                 }
 
-                return Object.values(kcContext.profile.attributesByName).map(attribute_pre_group_patch => {
-                    if (typeof attribute_pre_group_patch.group === "string" && attribute_pre_group_patch.group !== "") {
-                        const { group, groupDisplayHeader, groupDisplayDescription, groupAnnotations, ...rest } =
-                            attribute_pre_group_patch as Attribute & {
-                                group: string;
-                                groupDisplayHeader?: string;
-                                groupDisplayDescription?: string;
-                                groupAnnotations: Record<string, string>;
-                            };
+                if ("user" in kcContext && kcContext.user instanceof Object) {
+                    //NOTE: Handle legacy login-update-profile.ftl
+                    return (["username", "email", "firstName", "lastName"] as const)
+                        .filter(name => (name !== "username" ? true : (kcContext.user as any).editUsernameAllowed))
+                        .map(name =>
+                            id<Attribute>({
+                                name: name,
+                                displayName: id<`\${${MessageKey}}`>(`\${${name}}`),
+                                required: true,
+                                value: (kcContext as any).user[name] ?? "",
+                                html5DataAnnotations: {},
+                                readOnly: false,
+                                validators: {},
+                                annotations: {},
+                                autocomplete: (() => {
+                                    switch (name) {
+                                        case "email":
+                                            return "email";
+                                        case "username":
+                                            return "username";
+                                        default:
+                                            return undefined;
+                                    }
+                                })()
+                            })
+                        );
+                }
 
-                        return id<Attribute>({
-                            ...rest,
-                            group: {
-                                name: group,
-                                displayHeader: groupDisplayHeader,
-                                displayDescription: groupDisplayDescription,
-                                html5DataAnnotations: {}
-                            }
-                        });
-                    }
-
-                    return attribute_pre_group_patch;
-                });
-            })();
-
-            for (const attribute of attributes) {
-                syntheticAttributes.push(structuredCloneButFunctions(attribute));
-
-                add_password_and_password_confirm: {
-                    if (!kcContext.passwordRequired) {
-                        break add_password_and_password_confirm;
-                    }
-
-                    if (attribute.name !== (kcContext.realm.registrationEmailAsUsername ? "email" : "username")) {
-                        // NOTE: We want to add password and password-confirm after the field that identifies the user.
-                        // It's either email or username.
-                        break add_password_and_password_confirm;
-                    }
-
-                    syntheticAttributes.push(
-                        {
-                            name: "password",
-                            displayName: id<`\${${MessageKey}}`>("${password}"),
+                if ("email" in kcContext && kcContext.email instanceof Object) {
+                    //NOTE: Handle legacy update-email.ftl
+                    return [
+                        id<Attribute>({
+                            name: "email",
+                            displayName: id<`\${${MessageKey}}`>(`\${email}`),
                             required: true,
+                            value: (kcContext.email as any).value ?? "",
+                            html5DataAnnotations: {},
                             readOnly: false,
                             validators: {},
                             annotations: {},
-                            autocomplete: "new-password",
-                            html5DataAnnotations: {},
-                            // NOTE: Compat with Keycloak version prior to 24
-                            ...({ groupAnnotations: {} } as {})
-                        },
-                        {
-                            name: "password-confirm",
-                            displayName: id<`\${${MessageKey}}`>("${passwordConfirm}"),
-                            required: true,
-                            readOnly: false,
-                            validators: {},
-                            annotations: {},
-                            html5DataAnnotations: {},
-                            autocomplete: "new-password",
-                            // NOTE: Compat with Keycloak version prior to 24
-                            ...({ groupAnnotations: {} } as {})
-                        }
-                    );
+                            autocomplete: "email"
+                        })
+                    ];
                 }
+
+                assert(false, "Unable to mock user profile from the current kcContext");
             }
 
-            // NOTE: Consistency patch
-            syntheticAttributes.forEach(attribute => {
+            return Object.values(kcContext.profile.attributesByName).map(structuredCloneButFunctions);
+        })();
+
+        // Retro-compatibility and consistency patches
+        attributes.forEach(attribute => {
+            patch_legacy_group: {
+                if (typeof attribute.group !== "string") {
+                    break patch_legacy_group;
+                }
+
+                const { group, groupDisplayHeader, groupDisplayDescription /*, groupAnnotations*/ } = attribute as Attribute & {
+                    group: string;
+                    groupDisplayHeader?: string;
+                    groupDisplayDescription?: string;
+                    groupAnnotations: Record<string, string>;
+                };
+
+                delete attribute.group;
+                // @ts-expect-error
+                delete attribute.groupDisplayHeader;
+                // @ts-expect-error
+                delete attribute.groupDisplayDescription;
+                // @ts-expect-error
+                delete attribute.groupAnnotations;
+
+                if (group === "") {
+                    break patch_legacy_group;
+                }
+
+                attribute.group = {
+                    name: group,
+                    displayHeader: groupDisplayHeader,
+                    displayDescription: groupDisplayDescription,
+                    html5DataAnnotations: {}
+                };
+            }
+
+            // Attributes with options rendered by default as select inputs
+            if (attribute.validators.options !== undefined && attribute.annotations.inputType === undefined) {
+                attribute.annotations.inputType = "select";
+            }
+
+            // Consistency patch on values/value property
+            {
                 if (getIsMultivaluedSingleField({ attribute })) {
                     attribute.multivalued = true;
                 }
@@ -303,65 +272,98 @@ export function useUserProfileForm(params: ParamsOfUseUserProfileForm): ReturnTy
                     attribute.value ??= attribute.values?.[0];
                     delete attribute.values;
                 }
-            });
+            }
+        });
 
-            return syntheticAttributes;
-        })();
-
-        const initialFormFieldState = (() => {
-            const out: {
-                attribute: Attribute;
-                valueOrValues: string | string[];
-            }[] = [];
-
-            for (const attribute of syntheticAttributes) {
-                handle_multi_valued_attribute: {
-                    if (!attribute.multivalued) {
-                        break handle_multi_valued_attribute;
-                    }
-
-                    const values = attribute.values?.length ? attribute.values : [""];
-
-                    apply_validator_min_range: {
-                        if (getIsMultivaluedSingleField({ attribute })) {
-                            break apply_validator_min_range;
-                        }
-
-                        const validator = attribute.validators.multivalued;
-
-                        if (validator === undefined) {
-                            break apply_validator_min_range;
-                        }
-
-                        const { min: minStr } = validator;
-
-                        if (!minStr) {
-                            break apply_validator_min_range;
-                        }
-
-                        const min = parseInt(`${minStr}`);
-
-                        for (let index = values.length; index < min; index++) {
-                            values.push("");
-                        }
-                    }
-
-                    out.push({
-                        attribute,
-                        valueOrValues: values
-                    });
-
-                    continue;
-                }
-
-                out.push({
-                    attribute,
-                    valueOrValues: attribute.value ?? ""
-                });
+        add_password_and_password_confirm: {
+            if (!kcContext.passwordRequired) {
+                break add_password_and_password_confirm;
             }
 
-            return out;
-        })();
+            attributes.forEach((attribute, i) => {
+                if (attribute.name !== (kcContext.realm.registrationEmailAsUsername ? "email" : "username")) {
+                    // NOTE: We want to add password and password-confirm after the field that identifies the user.
+                    // It's either email or username.
+                    return;
+                }
+
+                attributes.splice(
+                    i + 1,
+                    0,
+                    {
+                        name: "password",
+                        displayName: id<`\${${MessageKey}}`>("${password}"),
+                        required: true,
+                        readOnly: false,
+                        validators: {},
+                        annotations: {},
+                        autocomplete: "new-password",
+                        html5DataAnnotations: {}
+                    },
+                    {
+                        name: "password-confirm",
+                        displayName: id<`\${${MessageKey}}`>("${passwordConfirm}"),
+                        required: true,
+                        readOnly: false,
+                        validators: {},
+                        annotations: {},
+                        html5DataAnnotations: {},
+                        autocomplete: "new-password"
+                    }
+                );
+            });
+        }
+
+        const initialFormFieldState: {
+            attribute: Attribute;
+            valueOrValues: string | string[];
+        }[] = [];
+
+        for (const attribute of attributes) {
+            handle_multi_valued_attribute: {
+                if (!attribute.multivalued) {
+                    break handle_multi_valued_attribute;
+                }
+
+                const values = attribute.values?.length ? attribute.values : [""];
+
+                apply_validator_min_range: {
+                    if (getIsMultivaluedSingleField({ attribute })) {
+                        break apply_validator_min_range;
+                    }
+
+                    const validator = attribute.validators.multivalued;
+
+                    if (validator === undefined) {
+                        break apply_validator_min_range;
+                    }
+
+                    const { min: minStr } = validator;
+
+                    if (!minStr) {
+                        break apply_validator_min_range;
+                    }
+
+                    const min = parseInt(`${minStr}`);
+
+                    for (let index = values.length; index < min; index++) {
+                        values.push("");
+                    }
+                }
+
+                initialFormFieldState.push({
+                    attribute,
+                    valueOrValues: values
+                });
+
+                continue;
+            }
+
+            initialFormFieldState.push({
+                attribute,
+                valueOrValues: attribute.value ?? ""
+            });
+        }
 
         const initialState: internal.State = {
             formFieldStates: initialFormFieldState.map(({ attribute, valueOrValues }) => ({

src/login/pages/IdpReviewUserProfile.tsx

@@ -2,7 +2,7 @@ import { useState } from "react";
 import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
 import { getKcClsx } from "keycloakify/login/lib/kcClsx";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
-import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFields";
+import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFieldsProps";
 import type { KcContext } from "../KcContext";
 import type { I18n } from "../i18n";
 

src/login/pages/Info.tsx

@@ -1,4 +1,3 @@
-import { assert } from "keycloakify/tools/assert";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
 import type { KcContext } from "../KcContext";
 import type { I18n } from "../i18n";
@@ -8,11 +7,6 @@ export default function Info(props: PageProps<Extract<KcContext, { pageId: "info
 
     const { msgStr, msg } = i18n;
 
-    assert(
-        kcContext.message !== undefined,
-        "No message in kcContext.message, there will always be a message in production context, add it in your mock"
-    );
-
     const { messageHeader, message, requiredActions, skipLink, pageRedirectUri, actionUri, client } = kcContext;
 
     return (

src/login/pages/LoginConfigTotp.tsx

@@ -16,7 +16,14 @@ export default function LoginConfigTotp(props: PageProps<Extract<KcContext, { pa
     const { msg, msgStr, advancedMsg } = i18n;
 
     return (
-        <Template kcContext={kcContext} i18n={i18n} doUseDefaultCss={doUseDefaultCss} classes={classes} headerNode={msg("loginTotpTitle")}>
+        <Template
+            kcContext={kcContext}
+            i18n={i18n}
+            doUseDefaultCss={doUseDefaultCss}
+            classes={classes}
+            headerNode={msg("loginTotpTitle")}
+            displayMessage={!messagesPerField.existsError("totp", "userLabel")}
+        >
             <>
                 <ol id="kc-totp-settings">
                     <li>

src/login/pages/LoginUpdateProfile.tsx

@@ -1,7 +1,7 @@
 import { useState } from "react";
 import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
 import { getKcClsx } from "keycloakify/login/lib/kcClsx";
-import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFields";
+import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFieldsProps";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
 import type { KcContext } from "../KcContext";
 import type { I18n } from "../i18n";
@@ -19,7 +19,7 @@ export default function LoginUpdateProfile(props: LoginUpdateProfileProps) {
         classes
     });
 
-    const { url, isAppInitiatedAction } = kcContext;
+    const { messagesPerField, url, isAppInitiatedAction } = kcContext;
 
     const { msg, msgStr } = i18n;
 
@@ -33,6 +33,7 @@ export default function LoginUpdateProfile(props: LoginUpdateProfileProps) {
             classes={classes}
             displayRequiredFields
             headerNode={msg("loginProfileTitle")}
+            displayMessage={messagesPerField.exists("global")}
         >
             <form id="kc-update-profile-form" className={kcClsx("kcFormClass")} action={url.loginAction} method="post">
                 <UserProfileFormFields

src/login/pages/Register.tsx

@@ -3,7 +3,7 @@ import { Markdown } from "keycloakify/tools/Markdown";
 import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
 import { useTermsMarkdown } from "keycloakify/login/lib/useDownloadTerms";
 import { getKcClsx, type KcClsx } from "keycloakify/login/lib/kcClsx";
-import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFields";
+import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFieldsProps";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
 import type { KcContext } from "../KcContext";
 import type { I18n } from "../i18n";
@@ -34,6 +34,7 @@ export default function Register(props: RegisterProps) {
             doUseDefaultCss={doUseDefaultCss}
             classes={classes}
             headerNode={msg("registerTitle")}
+            displayMessage={messagesPerField.exists("global")}
             displayRequiredFields
         >
             <form id="kc-register-form" className={kcClsx("kcFormClass")} action={url.registrationAction} method="post">

src/login/pages/UpdateEmail.tsx

@@ -1,7 +1,7 @@
 import { useState } from "react";
 import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
 import { getKcClsx, type KcClsx } from "keycloakify/login/lib/kcClsx";
-import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFields";
+import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFieldsProps";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
 import type { KcContext } from "../KcContext";
 import type { I18n } from "../i18n";

src/tools/formatNumber.ts

@@ -1,4 +1,4 @@
-export const formatNumber = (input: string, format: string): string => {
+export const formatNumber = (input: string, format: string) => {
     if (!input) {
         return "";
     }
@@ -20,7 +20,8 @@ export const formatNumber = (input: string, format: string): string => {
     let rawValue = input.replace(/\D+/g, "");
 
     // make sure the value is a number
-    if (`${parseInt(rawValue)}` !== rawValue) {
+    // @ts-expect-error: It's Keycloak's code, we trust it.
+    if (parseInt(rawValue) != rawValue) {
         return "";
     }
 

src/vite-plugin/vite-plugin.ts

@@ -1,7 +1,6 @@
 import { join as pathJoin, relative as pathRelative, sep as pathSep } from "path";
 import type { Plugin } from "vite";
 import {
-    nameOfTheGlobal,
     basenameOfTheKeycloakifyResourcesDir,
     keycloak_resources,
     vitePluginSubScriptEnvNames
@@ -170,9 +169,9 @@ export function keycloakify(params?: Params) {
                 /import\.meta\.env(?:(?:\.BASE_URL)|(?:\["BASE_URL"\]))/g,
                 [
                     `(`,
-                    `(window.${nameOfTheGlobal} === undefined || import.meta.env.MODE === "development")?`,
+                    `(window.kcContext === undefined || import.meta.env.MODE === "development")?`,
                     `"${urlPathname ?? "/"}":`,
-                    `(window.${nameOfTheGlobal}.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/")`,
+                    `(window.kcContext.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/")`,
                     `)`
                 ].join("")
             );

stories/account/KcPage.tsx

@@ -1,5 +1,5 @@
 import React from "react";
-import DefaultPage from "../../dist/account/Fallback";
+import DefaultPage from "../../dist/account/DefaultPage";
 import { useI18n } from "./i18n";
 import type { KcContext } from "./KcContext";
 import Template from "../../dist/account/Template";

stories/login/KcPage.tsx

@@ -1,5 +1,5 @@
 import React from "react";
-import DefaultPage from "../../dist/login/Fallback";
+import DefaultPage from "../../dist/login/DefaultPage";
 import type { KcContext } from "./KcContext";
 import { useI18n } from "./i18n";
 import { useDownloadTerms } from "../../dist/login/lib/useDownloadTerms";

stories/login/pages/Login.stories.tsx

@@ -17,6 +17,32 @@ export const Default: Story = {
     render: () => <KcPageStory />
 };
 
+export const WithInvalidCredential: Story = {
+    render: () => (
+        <KcPageStory
+            kcContext={{
+                login: {
+                    username: "johndoe"
+                },
+                messagesPerField: {
+                    // NOTE: The other functions of messagesPerField are derived from get() and
+                    // existsError() so they are the only ones that need to mock.
+                    existsError: (fieldName: string, ...otherFieldNames: string[]) => {
+                        const fieldNames = [fieldName, ...otherFieldNames];
+                        return fieldNames.includes("username") || fieldNames.includes("password");
+                    },
+                    get: (fieldName: string) => {
+                        if (fieldName === "username" || fieldName === "password") {
+                            return "Invalid username or password.";
+                        }
+                        return "";
+                    }
+                }
+            }}
+        />
+    )
+};
+
 export const WithoutRegistration: Story = {
     render: () => (
         <KcPageStory
@@ -180,3 +206,16 @@ export const WithoutPasswordField: Story = {
         />
     )
 };
+
+export const WithErrorMessage: Story = {
+    render: () => (
+        <KcPageStory
+            kcContext={{
+                message: {
+                    summary: "The time allotted for the connection has elapsed. The login process will restart from the beginning.",
+                    type: "error"
+                }
+            }}
+        />
+    )
+};

stories/login/pages/LoginVerifyEmail.stories.tsx

@@ -14,5 +14,17 @@ export default meta;
 type Story = StoryObj<typeof meta>;
 
 export const Default: Story = {
-    render: () => <KcPageStory />
+    render: () => (
+        <KcPageStory
+            kcContext={{
+                message: {
+                    summary: "You need to verify your email to activate your account.",
+                    type: "warning"
+                },
+                user: {
+                    email: "john.doe@gmail.com"
+                }
+            }}
+        />
+    )
 };

stories/login/pages/Register.stories.tsx

@@ -17,22 +17,31 @@ export const Default: Story = {
     render: () => <KcPageStory />
 };
 
-export const WithFieldError: Story = {
+export const WithEmailAlreadyExists: Story = {
     render: () => (
         <KcPageStory
             kcContext={{
                 profile: {
                     attributesByName: {
+                        username: {
+                            value: "johndoe"
+                        },
                         email: {
-                            value: "max.mustermann@gmail.com"
+                            value: "jhon.doe@gmail.com"
+                        },
+                        firstName: {
+                            value: "John"
+                        },
+                        lastName: {
+                            value: "Doe"
                         }
                     }
                 },
                 messagesPerField: {
-                    existsError: (fieldName: string) => fieldName === "email",
-                    exists: (fieldName: string) => fieldName === "email",
-                    get: (fieldName: string) => (fieldName === "email" ? "I don't like your email address" : undefined),
-                    printIfExists: <T,>(fieldName: string, x: T) => (fieldName === "email" ? x : undefined)
+                    // NOTE: The other functions of messagesPerField are derived from get() and
+                    // existsError() so they are the only ones that need to mock.
+                    existsError: (fieldName: string, ...otherFieldNames: string[]) => [fieldName, ...otherFieldNames].includes("email"),
+                    get: (fieldName: string) => (fieldName === "email" ? "Email already exists." : undefined)
                 }
             }}
         />
@@ -112,3 +121,15 @@ export const WithPresets: Story = {
         />
     )
 };
+
+export const WithPasswordMinLength8: Story = {
+    render: () => (
+        <KcPageStory
+            kcContext={{
+                passwordPolicies: {
+                    length: 8
+                }
+            }}
+        />
+    )
+};

test/bin/replacers.spec.ts

@@ -7,10 +7,7 @@ import {
 import { replaceImportsInInlineCssCode } from "keycloakify/bin/keycloakify/replacers/replaceImportsInInlineCssCode";
 import { same } from "evt/tools/inDepth/same";
 import { expect, it, describe } from "vitest";
-import {
-    basenameOfTheKeycloakifyResourcesDir,
-    nameOfTheGlobal
-} from "keycloakify/bin/shared/constants";
+import { basenameOfTheKeycloakifyResourcesDir } from "keycloakify/bin/shared/constants";
 
 describe("js replacer - vite", () => {
     it("replaceImportsInJsCode_vite - 1", () => {
@@ -95,13 +92,13 @@ describe("js replacer - vite", () => {
             });
 
             const fixedJsCodeExpected = `
-                    S=(window.${nameOfTheGlobal}.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/assets/keycloakify-logo-mqjydaoZ.png"),H=(()=>{
+                    S=(window.kcContext.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/assets/keycloakify-logo-mqjydaoZ.png"),H=(()=>{
 
                     function __vite__mapDeps(indexes) {
                         if (!__vite__mapDeps.viteFileDeps) {
                             __vite__mapDeps.viteFileDeps = [
-                                (window.${nameOfTheGlobal}.url.resourcesPath.substring(1) + "/${basenameOfTheKeycloakifyResourcesDir}/assets/Login-dJpPRzM4.js"), 
-                                (window.${nameOfTheGlobal}.url.resourcesPath.substring(1) + "/${basenameOfTheKeycloakifyResourcesDir}/assets/index-XwzrZ5Gu.js")
+                                (window.kcContext.url.resourcesPath.substring(1) + "/${basenameOfTheKeycloakifyResourcesDir}/assets/Login-dJpPRzM4.js"), 
+                                (window.kcContext.url.resourcesPath.substring(1) + "/${basenameOfTheKeycloakifyResourcesDir}/assets/index-XwzrZ5Gu.js")
                             ]
                         }
                         return indexes.map((i) => __vite__mapDeps.viteFileDeps[i])
@@ -154,13 +151,13 @@ describe("js replacer - vite", () => {
             });
 
             const fixedJsCodeExpected = `
-                    S=(window.${nameOfTheGlobal}.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/foo/bar/keycloakify-logo-mqjydaoZ.png"),H=(()=>{
+                    S=(window.kcContext.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/foo/bar/keycloakify-logo-mqjydaoZ.png"),H=(()=>{
 
                     function __vite__mapDeps(indexes) {
                         if (!__vite__mapDeps.viteFileDeps) {
                             __vite__mapDeps.viteFileDeps = [
-                                (window.${nameOfTheGlobal}.url.resourcesPath.substring(1) + "/${basenameOfTheKeycloakifyResourcesDir}/foo/bar/Login-dJpPRzM4.js"), 
-                                (window.${nameOfTheGlobal}.url.resourcesPath.substring(1) + "/${basenameOfTheKeycloakifyResourcesDir}/foo/bar/index-XwzrZ5Gu.js")
+                                (window.kcContext.url.resourcesPath.substring(1) + "/${basenameOfTheKeycloakifyResourcesDir}/foo/bar/Login-dJpPRzM4.js"), 
+                                (window.kcContext.url.resourcesPath.substring(1) + "/${basenameOfTheKeycloakifyResourcesDir}/foo/bar/index-XwzrZ5Gu.js")
                             ]
                         }
                         return indexes.map((i) => __vite__mapDeps.viteFileDeps[i])
@@ -213,13 +210,13 @@ describe("js replacer - vite", () => {
             });
 
             const fixedJsCodeExpected = `
-                    S=(window.${nameOfTheGlobal}.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/assets/keycloakify-logo-mqjydaoZ.png"),H=(()=>{
+                    S=(window.kcContext.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/assets/keycloakify-logo-mqjydaoZ.png"),H=(()=>{
 
                     function __vite__mapDeps(indexes) {
                         if (!__vite__mapDeps.viteFileDeps) {
                             __vite__mapDeps.viteFileDeps = [
-                                (window.${nameOfTheGlobal}.url.resourcesPath.substring(1) + "/${basenameOfTheKeycloakifyResourcesDir}/assets/Login-dJpPRzM4.js"), 
-                                (window.${nameOfTheGlobal}.url.resourcesPath.substring(1) + "/${basenameOfTheKeycloakifyResourcesDir}/assets/index-XwzrZ5Gu.js")
+                                (window.kcContext.url.resourcesPath.substring(1) + "/${basenameOfTheKeycloakifyResourcesDir}/assets/Login-dJpPRzM4.js"), 
+                                (window.kcContext.url.resourcesPath.substring(1) + "/${basenameOfTheKeycloakifyResourcesDir}/assets/index-XwzrZ5Gu.js")
                             ]
                         }
                         return indexes.map((i) => __vite__mapDeps.viteFileDeps[i])

test/bin/tools/crawl.spec.ts

@@ -1,4 +1,4 @@
-import path from "path";
+import { join as pathJoin } from "path";
 import { it, describe, expect, vi, beforeAll, afterAll } from "vitest";
 import { crawl } from "keycloakify/bin/tools/crawl";
 
@@ -13,11 +13,11 @@ describe("crawl", () => {
                         switch (dir_path) {
                             case "root_dir":
                                 return ["sub_1_dir", "file_1", "sub_2_dir", "file_2"];
-                            case path.join("root_dir", "sub_1_dir"):
+                            case pathJoin("root_dir", "sub_1_dir"):
                                 return ["file_3", "sub_3_dir", "file_4"];
-                            case path.join("root_dir", "sub_1_dir", "sub_3_dir"):
+                            case pathJoin("root_dir", "sub_1_dir", "sub_3_dir"):
                                 return ["file_5"];
-                            case path.join("root_dir", "sub_2_dir"):
+                            case pathJoin("root_dir", "sub_2_dir"):
                                 return [];
                             default: {
                                 const enoent = new Error(
@@ -46,10 +46,12 @@ describe("crawl", () => {
         });
         it("returns files under a given dir_path", async () => {
             const paths = crawl({
-                dirPath: "root_dir/sub_1_dir/sub_3_dir",
+                dirPath: pathJoin("root_dir", "sub_1_dir", "sub_3_dir"),
                 returnedPathsType: "absolute"
             });
-            expect(paths).toEqual(["root_dir/sub_1_dir/sub_3_dir/file_5"]);
+            expect(paths).toEqual([
+                pathJoin("root_dir", "sub_1_dir", "sub_3_dir", "file_5")
+            ]);
         });
         it("returns files recursively under a given dir_path", async () => {
             const paths = crawl({
@@ -57,11 +59,11 @@ describe("crawl", () => {
                 returnedPathsType: "absolute"
             });
             expect(paths).toEqual([
-                "root_dir/sub_1_dir/file_3",
-                "root_dir/sub_1_dir/sub_3_dir/file_5",
-                "root_dir/sub_1_dir/file_4",
-                "root_dir/file_1",
-                "root_dir/file_2"
+                pathJoin("root_dir", "sub_1_dir", "file_3"),
+                pathJoin("root_dir", "sub_1_dir", "sub_3_dir", "file_5"),
+                pathJoin("root_dir", "sub_1_dir", "file_4"),
+                pathJoin("root_dir", "file_1"),
+                pathJoin("root_dir", "file_2")
             ]);
         });
         it("throw dir_path does not exist", async () => {

yarn.lock

@@ -11144,11 +11144,6 @@ schema-utils@^3.0.0, schema-utils@^3.1.1, schema-utils@^3.1.2:
     ajv "^6.12.5"
     ajv-keywords "^3.5.2"
 
-scripting-tools@^0.19.13:
-  version "0.19.14"
-  resolved "https://registry.yarnpkg.com/scripting-tools/-/scripting-tools-0.19.14.tgz#d46cdea3dcf042b103b1712103b007e72c4901d5"
-  integrity sha512-KGRES70dEmcaCdpx3R88bLWmfA4mQ/EGikCQy0FGTZwx3y9F5yYkzEhwp02+ZTgpvF25JcNOhDBbOqL6z92kwg==
-
 semver-compare@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/semver-compare/-/semver-compare-1.0.0.tgz#0dee216a1c941ab37e9efb1788f6afc5ff5537fc"