Bump version

.github/workflows/ci.yaml

@@ -34,7 +34,7 @@ jobs:
     - uses: bahmutov/npm-install@v1
     - run: yarn build
     - run: yarn test
-    #- run: yarn test:keycloakify-starter
+    - run: yarn test:keycloakify-starter
 
   storybook:
     runs-on: ubuntu-latest

README.md

@@ -45,14 +45,6 @@
 > when using React; it's a well-regarded solution that many
 > developers appreciate.
 
-> 📣 🛑 Account themes generated by Keycloakify are currently not compatible with Keycloak 22.  
-> We are working on a solution. [More info](https://github.com/keycloakify/keycloakify/issues/389#issuecomment-1661591906).  
-> Note that login and email themes are not affected.
-
-Keycloakify is fully compatible with Keycloak, starting from version 11 and is anticipated to maintain compatibility with all future versions.  
-You can update your Keycloak, your Keycloakify generated theme won't break.  
-To understand the basis of my confidence in this, you can [visit this discussion thread where I've explained in detail](https://github.com/keycloakify/keycloakify/discussions/346#discussioncomment-5889791).
-
 ## Sponsor 👼
 
 We are exclusively sponsored by [Cloud IAM](https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github), a French company offering Keycloak as a service.  
@@ -125,23 +117,6 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 # Changelog highlights
 
-## 7.15
-
--   The i18n messages you defines in your theme are now also maid available to Keycloak.
-    In practice this mean that you can now customize the `kcContext.message.summary` that
-    display a general alert and the values returned by `kcContext.messagesPerField.get()` that
-    are used to display specific error on some field of the form.  
-    [See video](https://youtu.be/D6tZcemReTI)
-
-## 7.14
-
--   Deprecate the `extraPages` build option. Keycloakify is now able to analyze your code to detect extra pages.
-
-## 7.13
-
--   Deprecate `customUserAttribute`, Keycloakify now analyze your code to predict field name usage. [See doc](https://docs.keycloakify.dev/build-options#customuserattributes).  
-    It's now mandatory to [adopt the new directory structure](https://docs.keycloakify.dev/migration-guides/v6-greater-than-v7).
-
 ## 7.12
 
 -   You can now pack multiple themes variant in a single `.jar` bundle. In vanilla Keycloak themes you have the ability to extend a base theme.

keycloakify-json-schema.json

@@ -30,6 +30,18 @@
                                 "type": "string"
                             }
                         },
+                        "extraLoginPages": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "extraAccountPages": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
                         "extraThemeProperties": {
                             "type": "array",
                             "items": {
@@ -58,6 +70,12 @@
                         "keycloakifyBuildDirPath": {
                             "type": "string"
                         },
+                        "customUserAttributes": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
                         "themeName": {
                             "type": "string"
                         }

package.json

@@ -1,6 +1,6 @@
 {
     "name": "keycloakify",
-    "version": "7.15.9",
+    "version": "7.12.5",
     "description": "Create Keycloak themes using React",
     "repository": {
         "type": "git",
@@ -10,7 +10,8 @@
     "types": "dist/index.d.ts",
     "scripts": {
         "prepare": "yarn generate-i18n-messages",
-        "build": "rimraf dist/ && tsc -p src/bin && tsc -p src && tsc-alias -p src/tsconfig.json && yarn grant-exec-perms && yarn copy-files dist/ && cp -r src dist/",
+        "build": "rimraf dist/ && tsc -p src/bin && tsc -p src && tsc-alias -p src/tsconfig.json && yarn grant-exec-perms && yarn copy-files dist/",
+        "watch-in-starter": "yarn build && yarn link-in-starter && (concurrently \"tsc -p src -w\" \"tsc-alias -p src/tsconfig.json\" \"tsc -p src/bin -w\")",
         "generate:json-schema": "ts-node scripts/generate-json-schema.ts",
         "grant-exec-perms": "node dist/bin/tools/grant-exec-perms.js",
         "copy-files": "copyfiles -u 1 src/**/*.ftl",
@@ -23,7 +24,6 @@
         "generate-i18n-messages": "ts-node --skipProject scripts/generate-i18n-messages.ts",
         "link-in-app": "ts-node --skipProject scripts/link-in-app.ts",
         "link-in-starter": "yarn link-in-app keycloakify-starter",
-        "watch-in-starter": "yarn build && yarn link-in-starter && (concurrently \"tsc -p src -w\" \"tsc-alias -p src/tsconfig.json\" \"tsc -p src/bin -w\")",
         "copy-keycloak-resources-to-storybook-static": "PUBLIC_DIR_PATH=.storybook/static node dist/bin/copy-keycloak-resources-to-public.js",
         "storybook": "yarn build && yarn copy-keycloak-resources-to-storybook-static && start-storybook -p 6006",
         "build-storybook": "yarn build && yarn copy-keycloak-resources-to-storybook-static && build-storybook"
@@ -79,14 +79,12 @@
         "@storybook/manager-webpack5": "^6.5.13",
         "@storybook/react": "^6.5.13",
         "@storybook/testing-library": "^0.0.13",
-        "@types/babel__generator": "^7.6.4",
         "@types/make-fetch-happen": "^10.0.1",
         "@types/minimist": "^1.2.2",
         "@types/node": "^18.15.3",
         "@types/react": "^18.0.35",
         "@types/react-dom": "^18.0.11",
         "@types/yauzl": "^2.10.0",
-        "@types/yazl": "^2.4.2",
         "concurrently": "^8.0.1",
         "copyfiles": "^2.4.1",
         "eslint-plugin-storybook": "^0.6.7",
@@ -108,10 +106,8 @@
         "zod-to-json-schema": "^3.20.4"
     },
     "dependencies": {
-        "@babel/generator": "^7.22.9",
-        "@babel/parser": "^7.22.7",
-        "@babel/types": "^7.22.5",
         "@octokit/rest": "^18.12.0",
+        "@types/yazl": "^2.4.2",
         "cheerio": "^1.0.0-rc.5",
         "cli-select": "^1.1.2",
         "evt": "^2.4.18",
@@ -120,7 +116,6 @@
         "minimist": "^1.2.6",
         "path-browserify": "^1.0.1",
         "react-markdown": "^5.0.3",
-        "recast": "^0.23.3",
         "rfc4648": "^1.5.2",
         "tsafe": "^1.6.0",
         "yauzl": "^2.10.0",

scripts/generate-i18n-messages.ts

@@ -37,10 +37,7 @@ async function main() {
         const baseThemeDirPath = pathJoin(tmpDirPath, "base");
         const re = new RegExp(`^([^\\${pathSep}]+)\\${pathSep}messages\\${pathSep}messages_([^.]+).properties$`);
 
-        crawl({
+        crawl(baseThemeDirPath).forEach(filePath => {
-            "dirPath": baseThemeDirPath,
-            "returnedPathsType": "relative to dirPath"
-        }).forEach(filePath => {
             const match = filePath.match(re);
 
             if (match === null) {

src/account/index.ts

@@ -4,7 +4,6 @@ export default Fallback;
 
 export { getKcContext } from "keycloakify/account/kcContext/getKcContext";
 export { createGetKcContext } from "keycloakify/account/kcContext/createGetKcContext";
-export type { AccountThemePageId as PageId } from "keycloakify/bin/keycloakify/generateFtl";
 export { createUseI18n } from "keycloakify/account/i18n/i18n";
 
 export type { PageProps } from "keycloakify/account/pages/PageProps";

src/account/kcContext/KcContext.ts

@@ -52,34 +52,9 @@ export declare namespace KcContext {
             name: string; // Client id
         };
         messagesPerField: {
-            /**
+            printIfExists: <T>(fieldName: string, x: T) => T | undefined;
-             * Return text if message for given field exists. Useful eg. to add css styles for fields with message.
-             *
-             * @param fieldName to check for
-             * @param text to return
-             * @return text if message exists for given field, else undefined
-             */
-            printIfExists: <T extends string>(fieldName: string, text: T) => T | undefined;
-            /**
-             * Check if exists error message for given fields
-             *
-             * @param fields
-             * @return boolean
-             */
             existsError: (fieldName: string) => boolean;
-            /**
-             * Get message for given field.
-             *
-             * @param fieldName
-             * @return message text or empty string
-             */
             get: (fieldName: string) => string;
-            /**
-             * Check if message for given field exists
-             *
-             * @param field
-             * @return boolean
-             */
             exists: (fieldName: string) => boolean;
         };
         account: {

src/account/kcContext/kcContextMocks.ts

@@ -4,7 +4,7 @@ import { pathJoin } from "keycloakify/bin/tools/pathJoin";
 import { id } from "tsafe/id";
 import type { KcContext } from "./KcContext";
 
-const PUBLIC_URL = (typeof process !== "object" ? undefined : process.env?.["PUBLIC_URL"]) || "/";
+const PUBLIC_URL = process.env["PUBLIC_URL"] ?? "/";
 
 export const kcContextCommonMock: KcContext.Common = {
     "keycloakifyVersion": "0.0.0",

src/bin/eject-keycloak-page.ts

@@ -51,6 +51,10 @@ import { getThemeSrcDirPath } from "./getSrcDirPath";
 
     const { themeSrcDirPath } = getThemeSrcDirPath({ "projectDirPath": process.cwd() });
 
+    if (themeSrcDirPath === undefined) {
+        throw new Error("Couldn't locate your theme sources");
+    }
+
     const targetFilePath = pathJoin(themeSrcDirPath, themeType, "pages", pageBasename);
 
     if (existsSync(targetFilePath)) {

src/bin/getSrcDirPath.ts

@@ -2,17 +2,15 @@ import * as fs from "fs";
 import { exclude } from "tsafe";
 import { crawl } from "./tools/crawl";
 import { join as pathJoin } from "path";
-import { themeTypes } from "./keycloakify/generateFtl";
 
 const themeSrcDirBasename = "keycloak-theme";
 
-/** Can't catch error, if the directory isn't found, this function will just exit the process with an error message. */
 export function getThemeSrcDirPath(params: { projectDirPath: string }) {
     const { projectDirPath } = params;
 
     const srcDirPath = pathJoin(projectDirPath, "src");
 
-    const themeSrcDirPath: string | undefined = crawl({ "dirPath": srcDirPath, "returnedPathsType": "relative to dirPath" })
+    const themeSrcDirPath: string | undefined = crawl(srcDirPath)
         .map(fileRelativePath => {
             const split = fileRelativePath.split(themeSrcDirBasename);
 
@@ -24,24 +22,22 @@ export function getThemeSrcDirPath(params: { projectDirPath: string }) {
         })
         .filter(exclude(undefined))[0];
 
-    if (themeSrcDirPath !== undefined) {
+    if (themeSrcDirPath === undefined) {
-        return { themeSrcDirPath };
+        if (fs.existsSync(pathJoin(srcDirPath, "login")) || fs.existsSync(pathJoin(srcDirPath, "account"))) {
-    }
+            return { "themeSrcDirPath": srcDirPath };
-
-    for (const themeType of [...themeTypes, "email"]) {
-        if (!fs.existsSync(pathJoin(srcDirPath, themeType))) {
-            continue;
         }
-        return { "themeSrcDirPath": srcDirPath };
+        return { "themeSrcDirPath": undefined };
     }
 
-    console.error(
+    return { themeSrcDirPath };
-        [
+}
-            "Can't locate your theme source directory. It should be either: ",
+
-            "src/ or src/keycloak-theme.",
+export function getEmailThemeSrcDirPath(params: { projectDirPath: string }) {
-            "Example in the starter: https://github.com/keycloakify/keycloakify-starter/tree/main/src/keycloak-theme"
+    const { projectDirPath } = params;
-        ].join("\n")
+
-    );
+    const { themeSrcDirPath } = getThemeSrcDirPath({ projectDirPath });
-
+
-    process.exit(-1);
+    const emailThemeSrcDirPath = themeSrcDirPath === undefined ? undefined : pathJoin(themeSrcDirPath, "email");
+
+    return { emailThemeSrcDirPath };
 }

src/bin/initialize-email-theme.ts

@@ -7,7 +7,7 @@ import { promptKeycloakVersion } from "./promptKeycloakVersion";
 import { readBuildOptions } from "./keycloakify/BuildOptions";
 import * as fs from "fs";
 import { getLogger } from "./tools/logger";
-import { getThemeSrcDirPath } from "./getSrcDirPath";
+import { getEmailThemeSrcDirPath } from "./getSrcDirPath";
 
 export async function main() {
     const { isSilent } = readBuildOptions({
@@ -17,11 +17,15 @@ export async function main() {
 
     const logger = getLogger({ isSilent });
 
-    const { themeSrcDirPath } = getThemeSrcDirPath({
+    const { emailThemeSrcDirPath } = getEmailThemeSrcDirPath({
         "projectDirPath": process.cwd()
     });
 
-    const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
+    if (emailThemeSrcDirPath === undefined) {
+        logger.warn("Couldn't locate your theme source directory");
+
+        process.exit(-1);
+    }
 
     if (fs.existsSync(emailThemeSrcDirPath)) {
         logger.warn(`There is already a ${pathRelative(process.cwd(), emailThemeSrcDirPath)} directory in your project. Aborting.`);

src/bin/keycloakify/BuildOptions.ts

@@ -17,7 +17,9 @@ export namespace BuildOptions {
         themeVersion: string;
         themeName: string;
         extraThemeNames: string[];
-        extraThemeProperties: string[] | undefined;
+        extraLoginPages: string[] | undefined;
+        extraAccountPages: string[] | undefined;
+        extraThemeProperties?: string[];
         groupId: string;
         artifactId: string;
         bundler: Bundler;
@@ -26,6 +28,7 @@ export namespace BuildOptions {
         reactAppBuildDirPath: string;
         /** Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak */
         keycloakifyBuildDirPath: string;
+        customUserAttributes: string[];
     };
 
     export type Standalone = Common & {
@@ -106,7 +109,17 @@ export function readBuildOptions(params: { projectDirPath: string; processArgv:
     const common: BuildOptions.Common = (() => {
         const { name, keycloakify = {}, version, homepage } = parsedPackageJson;
 
-        const { extraThemeProperties, groupId, artifactId, bundler, keycloakVersionDefaultAssets, extraThemeNames = [] } = keycloakify ?? {};
+        const {
+            extraPages,
+            extraLoginPages,
+            extraAccountPages,
+            extraThemeProperties,
+            groupId,
+            artifactId,
+            bundler,
+            keycloakVersionDefaultAssets,
+            extraThemeNames = []
+        } = keycloakify ?? {};
 
         const themeName =
             keycloakify.themeName ??
@@ -148,6 +161,8 @@ export function readBuildOptions(params: { projectDirPath: string; processArgv:
                 );
             })(),
             "themeVersion": process.env.KEYCLOAKIFY_THEME_VERSION ?? process.env.KEYCLOAKIFY_VERSION ?? version ?? "0.0.0",
+            "extraLoginPages": [...(extraPages ?? []), ...(extraLoginPages ?? [])],
+            extraAccountPages,
             extraThemeProperties,
             "isSilent": isSilentCliParamProvided,
             "keycloakVersionDefaultAssets": keycloakVersionDefaultAssets ?? "11.0.3",
@@ -184,7 +199,8 @@ export function readBuildOptions(params: { projectDirPath: string; processArgv:
                 }
 
                 return keycloakifyBuildDirPath;
-            })()
+            })(),
+            "customUserAttributes": keycloakify.customUserAttributes ?? []
         };
     })();
 

src/bin/keycloakify/generateFtl/ftl_object_to_js_code_declaring_an_object.ftl

@@ -8,7 +8,13 @@
     out["advancedMsg"]= function(){ throw new Error("use import { useKcMessage } from 'keycloakify'"); };
 
     out["messagesPerField"]= {
-        <#assign fieldNames = [ FIELD_NAMES_eKsIY4ZsZ4xeM ]>
+        <#assign fieldNames = [
+            "global", "userLabel", "username", "email", "firstName", "lastName", "password", "password-confirm",
+            "totp", "totpSecret", "SAMLRequest", "SAMLResponse", "relayState", "device_user_code", "code", 
+            "password-new", "rememberMe", "login", "authenticationExecution", "cancel-aia", "clientDataJSON", 
+            "authenticatorData", "signature", "credentialId", "userHandle", "error", "authn_use_chk", "authenticationExecution", 
+            "isSetRetry", "try-again", "attestationObject", "publicKeyCredentialId", "authenticatorLabel"CUSTOM_USER_ATTRIBUTES_eKsIY4ZsZ4xeM
+        ]>
     
         <#attempt>
             <#if profile?? && profile.attributes?? && profile.attributes?is_enumerable>
@@ -22,374 +28,85 @@
         <#recover>
         </#attempt>
     
-        "printIfExists": function (fieldName, text) {
+        "printIfExists": function (fieldName, x) {
-
+            <#if !messagesPerField?? >
-            <#if !messagesPerField?? || !(messagesPerField?is_hash)>   
+                return undefined;
-                throw new Error("You're not supposed to use messagesPerField.printIfExists in this page");
             <#else>
                 <#list fieldNames as fieldName>
                     if(fieldName === "${fieldName}" ){
-
+                        <#attempt>
-                        <#-- https://github.com/keycloakify/keycloakify/pull/359 Compat with Keycloak prior v12 -->
+                            <#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
-                        <#if !messagesPerField.existsError??>
+                                return <#if messagesPerField.existsError('username', 'password')>x<#else>undefined</#if>;
-
-                            <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
-                            <#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
-
-                                <#assign doExistMessageForUsernameOrPassword = "">
-
-                                <#attempt>
-                                    <#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('username')>
-                                <#recover>
-                                    <#assign doExistMessageForUsernameOrPassword = true>
-                                </#attempt>
-
-                                <#if !doExistMessageForUsernameOrPassword>
-                                    <#attempt>
-                                        <#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('password')>
-                                    <#recover>
-                                        <#assign doExistMessageForUsernameOrPassword = true>
-                                    </#attempt>
-                                </#if>
-
-                                return <#if doExistMessageForUsernameOrPassword>text<#else>undefined</#if>;
-
                             <#else>
-
+                                return <#if messagesPerField.existsError('${fieldName}')>x<#else>undefined</#if>;
-                                <#assign doExistMessageForField = "">
-
-                                <#attempt>
-                                    <#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
-                                <#recover>
-                                    <#assign doExistMessageForField = true>
-                                </#attempt>
-
-                                return <#if doExistMessageForField>text<#else>undefined</#if>;
-
                             </#if>
-
+                        <#recover>
-                        <#else>
+                        </#attempt>
-
-                            <#-- 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>
-                                    return text;
-                                <#else>
-
-                                    <#assign doExistMessageForField = "">
-
-                                    <#attempt>
-                                        <#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
-                                    <#recover>
-                                        <#assign doExistMessageForField = true>
-                                    </#attempt>
-
-                                    return <#if doExistMessageForField>text<#else>undefined</#if>;
-
-                                </#if>
-
-                            <#else>
-
-                                <#assign doExistMessageForField = "">
-
-                                <#attempt>
-                                    <#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
-                                <#recover>
-                                    <#assign doExistMessageForField = true>
-                                </#attempt>
-
-                                return <#if doExistMessageForField>text<#else>undefined</#if>;
-
-                            </#if>
-
-                        </#if>
-
                     }
                 </#list>
-
+                throw new Error("There is no " + fieldName + " field");
-                throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
             </#if>
-
         },
         "existsError": function (fieldName) {
-
+            <#if !messagesPerField?? >
-            <#if !messagesPerField?? || !(messagesPerField?is_hash)>   
+                return false;
-                throw new Error("You're not supposed to use messagesPerField.printIfExists in this page");
             <#else>
                 <#list fieldNames as fieldName>
                     if(fieldName === "${fieldName}" ){
-
+                        <#attempt>
-                        <#-- https://github.com/keycloakify/keycloakify/pull/359 Compat with Keycloak prior v12 -->
+                            <#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
-                        <#if !messagesPerField.existsError??>
+                                return <#if messagesPerField.existsError('username', 'password')>true<#else>false</#if>;
-
-                            <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
-                            <#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
-
-                                <#assign doExistMessageForUsernameOrPassword = "">
-
-                                <#attempt>
-                                    <#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('username')>
-                                <#recover>
-                                    <#assign doExistMessageForUsernameOrPassword = true>
-                                </#attempt>
-
-                                <#if !doExistMessageForUsernameOrPassword>
-                                    <#attempt>
-                                        <#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('password')>
-                                    <#recover>
-                                        <#assign doExistMessageForUsernameOrPassword = true>
-                                    </#attempt>
-                                </#if>
-
-                                return <#if doExistMessageForUsernameOrPassword>true<#else>false</#if>;
-
                             <#else>
-
+                                return <#if messagesPerField.existsError('${fieldName}')>true<#else>false</#if>;
-                                <#assign doExistMessageForField = "">
-
-                                <#attempt>
-                                    <#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
-                                <#recover>
-                                    <#assign doExistMessageForField = true>
-                                </#attempt>
-
-                                return <#if doExistMessageForField>true<#else>false</#if>;
-
                             </#if>
-
+                        <#recover>
-                        <#else>
+                        </#attempt>
-
-                            <#-- 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>
-
-                        </#if>
-
                     }
                 </#list>
-
+                throw new Error("There is no " + fieldName + " field");
-                throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
-
             </#if>
-
         },
         "get": function (fieldName) {
-
+            <#if !messagesPerField?? >
-
+                return '';
-            <#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}" ){
-
+                        <#attempt>
-                        <#-- https://github.com/keycloakify/keycloakify/pull/359 Compat with Keycloak prior v12 -->
+                            <#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
-                        <#if !messagesPerField.existsError??>
+                                <#if messagesPerField.existsError('username', 'password')>
-
+                                    return 'Invalid username or password.';
-                            <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
-                            <#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
-
-                                <#assign doExistMessageForUsernameOrPassword = "">
-
-                                <#attempt>
-                                    <#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('username')>
-                                <#recover>
-                                    <#assign doExistMessageForUsernameOrPassword = true>
-                                </#attempt>
-
-                                <#if !doExistMessageForUsernameOrPassword>
-                                    <#attempt>
-                                        <#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('password')>
-                                    <#recover>
-                                        <#assign doExistMessageForUsernameOrPassword = true>
-                                    </#attempt>
                                 </#if>
-
-                                <#if !doExistMessageForUsernameOrPassword>
-                                    return "";
-                                <#else>
-                                    <#attempt>
-                                        return "${kcSanitize(msg('invalidUserMessage'))?no_esc}";
-                                    <#recover>
-                                        return "Invalid username or password.";
-                                    </#attempt>
-                                </#if>
-
                             <#else>
-
+                                <#if messagesPerField.existsError('${fieldName}')>
-                                <#attempt>
                                     return "${messagesPerField.get('${fieldName}')?no_esc}";
-                                <#recover>
-                                    return "invalid field";
-                                </#attempt>
-
-                            </#if>
-
-                        <#else>
-
-                            <#-- 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 "${kcSanitize(msg('invalidUserMessage'))?no_esc}";
-                                    <#recover>
-                                        return "Invalid username or password.";
-                                    </#attempt>
-
-                                <#else>
-
-                                    <#attempt>
-                                        return "${messagesPerField.get('${fieldName}')?no_esc}";
-                                    <#recover>
-                                        return "";
-                                    </#attempt>
-
                                 </#if>
-
-                            <#else>
-
-                                <#attempt>
-                                    return "${messagesPerField.get('${fieldName}')?no_esc}";
-                                <#recover>
-                                    return "invalid field";
-                                </#attempt>
-
                             </#if>
-
+                        <#recover>
-                        </#if>
+                        </#attempt>
-
                     }
                 </#list>
-
+                throw new Error("There is no " + fieldName + " field");
-                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?? >
-            <#if !messagesPerField?? || !(messagesPerField?is_hash)>   
+                return false;
-                throw new Error("You're not supposed to use messagesPerField.exists in this page");
             <#else>
                 <#list fieldNames as fieldName>
                     if(fieldName === "${fieldName}" ){
-
+                        <#attempt>
-                        <#-- https://github.com/keycloakify/keycloakify/pull/359 Compat with Keycloak prior v12 -->
+                            <#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
-                        <#if !messagesPerField.existsError??>
+                                return <#if messagesPerField.exists('username') ||  messagesPerField.exists('password')>true<#else>false</#if>;
-
-                            <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
-                            <#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
-
-                                <#assign doExistMessageForUsernameOrPassword = "">
-
-                                <#attempt>
-                                    <#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('username')>
-                                <#recover>
-                                    <#assign doExistMessageForUsernameOrPassword = true>
-                                </#attempt>
-
-                                <#if !doExistMessageForUsernameOrPassword>
-                                    <#attempt>
-                                        <#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('password')>
-                                    <#recover>
-                                        <#assign doExistMessageForUsernameOrPassword = true>
-                                    </#attempt>
-                                </#if>
-
-                                return <#if doExistMessageForUsernameOrPassword>true<#else>false</#if>;
-
                             <#else>
-
+                                return <#if messagesPerField.exists('${fieldName}')>true<#else>false</#if>;
-                                <#assign doExistMessageForField = "">
-
-                                <#attempt>
-                                    <#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
-                                <#recover>
-                                    <#assign doExistMessageForField = true>
-                                </#attempt>
-
-                                return <#if doExistMessageForField>true<#else>false</#if>;
-
                             </#if>
-
+                        <#recover>
-                        <#else>
+                        </#attempt>
-
-                            <#-- 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>
-
-                        </#if>
-
                     }
                 </#list>
-
+                throw new Error("There is no " + fieldName + " field");
-                throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
             </#if>
-
         }
     };
 
@@ -457,12 +174,8 @@
                         <#-- https://github.com/keycloakify/keycloakify/issues/357 -->
                         key == "loginAction" && 
                         are_same_path(path, ["url"]) && 
-                        ["saml-post-form.ftl", "error.ftl", "info.ftl", "login-oauth-grant.ftl", "logout-confirm.ftl"]?seq_contains(pageId) &&
+                        ["saml-post-form.ftl", "error.ftl", "info.ftl", "login-oauth-grant.ftl"]?seq_contains(pageId) &&
                         !(auth?has_content && auth.showTryAnotherWayLink())
-                    ) || (
-                        <#-- https://github.com/keycloakify/keycloakify/issues/362 -->
-                        ["secretData", "value"]?seq_contains(key) && 
-                        are_same_path(path, [ "totp", "otpCredentials", "*" ])
                     ) || (
                         ["contextData", "idpConfig", "idp", "authenticationSession"]?seq_contains(key) &&
                         are_same_path(path, ["brokerContext"]) &&

src/bin/keycloakify/generateFtl/generateFtl.ts

@@ -18,6 +18,7 @@ export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.Ex
 export namespace BuildOptionsLike {
     export type Common = {
         themeName: string;
+        customUserAttributes: string[];
         themeVersion: string;
     };
 
@@ -56,9 +57,8 @@ export function generateFtlFilesCodeFactory(params: {
     buildOptions: BuildOptionsLike;
     keycloakifyVersion: string;
     themeType: ThemeType;
-    fieldNames: string[];
 }) {
-    const { cssGlobalsToDefine, indexHtmlCode, buildOptions, keycloakifyVersion, themeType, fieldNames } = params;
+    const { cssGlobalsToDefine, indexHtmlCode, buildOptions, keycloakifyVersion, themeType } = params;
 
     const $ = cheerio.load(indexHtmlCode);
 
@@ -129,7 +129,10 @@ export function generateFtlFilesCodeFactory(params: {
             .readFileSync(pathJoin(__dirname, "ftl_object_to_js_code_declaring_an_object.ftl"))
             .toString("utf8")
             .match(/^<script>const _=((?:.|\n)+)<\/script>[\n]?$/)![1]
-            .replace("FIELD_NAMES_eKsIY4ZsZ4xeM", fieldNames.map(name => `"${name}"`).join(", "))
+            .replace(
+                "CUSTOM_USER_ATTRIBUTES_eKsIY4ZsZ4xeM",
+                buildOptions.customUserAttributes.length === 0 ? "" : ", " + buildOptions.customUserAttributes.map(name => `"${name}"`).join(", ")
+            )
             .replace("KEYCLOAKIFY_VERSION_xEdKd3xEdr", keycloakifyVersion)
             .replace("KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx", buildOptions.themeVersion)
             .replace("KEYCLOAKIFY_THEME_TYPE_dExKd3xEdr", themeType)

src/bin/keycloakify/generateJavaStackFiles.ts

@@ -1,15 +1,15 @@
 import * as fs from "fs";
 import { join as pathJoin, dirname as pathDirname } from "path";
+import { themeTypes } from "./generateFtl/generateFtl";
 import { assert } from "tsafe/assert";
 import { Reflect } from "tsafe/Reflect";
 import type { BuildOptions } from "./BuildOptions";
-import type { ThemeType } from "./generateFtl";
 
 export type BuildOptionsLike = {
     themeName: string;
     extraThemeNames: string[];
     groupId: string;
-    artifactId: string;
+    artifactId?: string;
     themeVersion: string;
 };
 
@@ -21,7 +21,7 @@ export type BuildOptionsLike = {
 
 export function generateJavaStackFiles(params: {
     keycloakThemeBuildingDirPath: string;
-    implementedThemeTypes: Record<ThemeType | "email", boolean>;
+    doBundlesEmailTemplate: boolean;
     buildOptions: BuildOptionsLike;
 }): {
     jarFilePath: string;
@@ -29,7 +29,7 @@ export function generateJavaStackFiles(params: {
     const {
         buildOptions: { groupId, themeName, extraThemeNames, themeVersion, artifactId },
         keycloakThemeBuildingDirPath,
-        implementedThemeTypes
+        doBundlesEmailTemplate
     } = params;
 
     {
@@ -70,9 +70,7 @@ export function generateJavaStackFiles(params: {
                     {
                         "themes": [themeName, ...extraThemeNames].map(themeName => ({
                             "name": themeName,
-                            "types": Object.entries(implementedThemeTypes)
+                            "types": [...themeTypes, ...(doBundlesEmailTemplate ? ["email"] : [])]
-                                .filter(([, isImplemented]) => isImplemented)
-                                .map(([themeType]) => themeType)
                         }))
                     },
                     null,

src/bin/keycloakify/generateStartKeycloakTestingContainer.ts

@@ -33,6 +33,7 @@ export function generateStartKeycloakTestingContainer(params: {
 
     fs.writeFileSync(
         pathJoin(keycloakThemeBuildingDirPath, generateStartKeycloakTestingContainer.basename),
+
         Buffer.from(
             [
                 "#!/usr/bin/env bash",
@@ -46,6 +47,7 @@ export function generateStartKeycloakTestingContainer(params: {
                 `   --name ${containerName} \\`,
                 "   -e KEYCLOAK_ADMIN=admin \\",
                 "   -e KEYCLOAK_ADMIN_PASSWORD=admin \\",
+                "   -e JAVA_OPTS=-Dkeycloak.profile=preview \\",
                 ...[themeName, ...extraThemeNames].map(
                     themeName =>
                         `   -v "${pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", themeName).replace(
@@ -54,7 +56,7 @@ export function generateStartKeycloakTestingContainer(params: {
                         )}":"/opt/keycloak/themes/${themeName}":rw \\`
                 ),
                 `   -it quay.io/keycloak/keycloak:${keycloakVersion} \\`,
-                `   start-dev --features=declarative-user-profile`,
+                `   start-dev`,
                 ""
             ].join("\n"),
             "utf8"

src/bin/keycloakify/generateTheme/generateMessageProperties.ts

@@ -1,179 +0,0 @@
-import type { ThemeType } from "../generateFtl";
-import { crawl } from "../../tools/crawl";
-import { join as pathJoin } from "path";
-import { readFileSync } from "fs";
-import { symToStr } from "tsafe/symToStr";
-import { removeDuplicates } from "evt/tools/reducers/removeDuplicates";
-import * as recast from "recast";
-import * as babelParser from "@babel/parser";
-import babelGenerate from "@babel/generator";
-import * as babelTypes from "@babel/types";
-
-export function generateMessageProperties(params: {
-    themeSrcDirPath: string;
-    themeType: ThemeType;
-}): { languageTag: string; propertiesFileSource: string }[] {
-    const { themeSrcDirPath, themeType } = params;
-
-    let files = crawl({
-        "dirPath": pathJoin(themeSrcDirPath, themeType),
-        "returnedPathsType": "absolute"
-    });
-
-    files = files.filter(file => {
-        const regex = /\.(js|ts|tsx)$/;
-        return regex.test(file);
-    });
-
-    files = files.sort((a, b) => {
-        const regex = /\.i18n\.(ts|js|tsx)$/;
-        const aIsI18nFile = regex.test(a);
-        const bIsI18nFile = regex.test(b);
-        return aIsI18nFile === bIsI18nFile ? 0 : aIsI18nFile ? -1 : 1;
-    });
-
-    files = files.sort((a, b) => a.length - b.length);
-
-    files = files.filter(file => readFileSync(file).toString("utf8").includes("createUseI18n"));
-
-    if (files.length === 0) {
-        return [];
-    }
-
-    const extraMessages = files
-        .map(file => {
-            const root = recast.parse(readFileSync(file).toString("utf8"), {
-                "parser": {
-                    "parse": (code: string) => babelParser.parse(code, { "sourceType": "module", "plugins": ["typescript"] }),
-                    "generator": babelGenerate,
-                    "types": babelTypes
-                }
-            });
-
-            const codes: string[] = [];
-
-            recast.visit(root, {
-                "visitCallExpression": function (path) {
-                    if (path.node.callee.type === "Identifier" && path.node.callee.name === "createUseI18n") {
-                        codes.push(babelGenerate(path.node.arguments[0] as any).code);
-                    }
-                    this.traverse(path);
-                }
-            });
-
-            return codes;
-        })
-        .flat()
-        .map(code => {
-            let extraMessages: { [languageTag: string]: Record<string, string> } = {};
-
-            try {
-                eval(`${symToStr({ extraMessages })} = ${code}`);
-            } catch {
-                console.warn(
-                    [
-                        "WARNING: Make sure that the first argument of createUseI18n can be evaluated in a javascript",
-                        "runtime where only the node globals are available.",
-                        "This is important because we need to put your i18n messages in messages_*.properties files",
-                        "or they won't be available server side.",
-                        "\n",
-                        "The following code could not be evaluated:",
-                        "\n",
-                        code
-                    ].join(" ")
-                );
-            }
-
-            return extraMessages;
-        });
-
-    const languageTags = extraMessages
-        .map(extraMessage => Object.keys(extraMessage))
-        .flat()
-        .reduce(...removeDuplicates<string>());
-
-    const keyValueMapByLanguageTag: Record<string, Record<string, string>> = {};
-
-    for (const languageTag of languageTags) {
-        const keyValueMap: Record<string, string> = {};
-
-        for (const extraMessage of extraMessages) {
-            const keyValueMap_i = extraMessage[languageTag];
-
-            if (keyValueMap_i === undefined) {
-                continue;
-            }
-
-            for (const [key, value] of Object.entries(keyValueMap_i)) {
-                if (keyValueMap[key] !== undefined) {
-                    console.warn(
-                        [
-                            "WARNING: The following key is defined multiple times:",
-                            "\n",
-                            key,
-                            "\n",
-                            "The following value will be ignored:",
-                            "\n",
-                            value,
-                            "\n",
-                            "The following value was already defined:",
-                            "\n",
-                            keyValueMap[key]
-                        ].join(" ")
-                    );
-                    continue;
-                }
-
-                keyValueMap[key] = value;
-            }
-        }
-
-        keyValueMapByLanguageTag[languageTag] = keyValueMap;
-    }
-
-    const out: { languageTag: string; propertiesFileSource: string }[] = [];
-
-    for (const [languageTag, keyValueMap] of Object.entries(keyValueMapByLanguageTag)) {
-        const propertiesFileSource = Object.entries(keyValueMap)
-            .map(([key, value]) => `${key}=${escapeString(value)}`)
-            .join("\n");
-
-        out.push({
-            languageTag,
-            "propertiesFileSource": ["# This file was generated by keycloakify", "", "parent=base", "", propertiesFileSource, ""].join("\n")
-        });
-    }
-
-    return out;
-}
-
-// Convert a JavaScript string to UTF-16 encoding
-function toUTF16(codePoint: number): string {
-    if (codePoint <= 0xffff) {
-        // BMP character
-        return "\\u" + codePoint.toString(16).padStart(4, "0");
-    } else {
-        // Non-BMP character
-        codePoint -= 0x10000;
-        let highSurrogate = (codePoint >> 10) + 0xd800;
-        let lowSurrogate = (codePoint % 0x400) + 0xdc00;
-        return "\\u" + highSurrogate.toString(16).padStart(4, "0") + "\\u" + lowSurrogate.toString(16).padStart(4, "0");
-    }
-}
-
-// Escapes special characters and converts unicode to UTF-16 encoding
-function escapeString(str: string): string {
-    let escapedStr = "";
-    for (const char of [...str]) {
-        const codePoint = char.codePointAt(0);
-        if (!codePoint) continue;
-        if (char === "'") {
-            escapedStr += "''"; // double single quotes
-        } else if (codePoint > 0x7f) {
-            escapedStr += toUTF16(codePoint); // non-ascii characters
-        } else {
-            escapedStr += char;
-        }
-    }
-    return escapedStr;
-}

src/bin/keycloakify/generateTheme/generateTheme.ts

@@ -9,17 +9,17 @@ import { isInside } from "../../tools/isInside";
 import type { BuildOptions } from "../BuildOptions";
 import { assert } from "tsafe/assert";
 import { downloadKeycloakStaticResources } from "./downloadKeycloakStaticResources";
-import { readFieldNameUsage } from "./readFieldNameUsage";
-import { readExtraPagesNames } from "./readExtraPageNames";
-import { generateMessageProperties } from "./generateMessageProperties";
 
 export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.ExternalAssets;
 
 export namespace BuildOptionsLike {
     export type Common = {
         themeName: string;
-        extraThemeProperties: string[] | undefined;
+        extraLoginPages?: string[];
+        extraAccountPages?: string[];
+        extraThemeProperties?: string[];
         isSilent: boolean;
+        customUserAttributes: string[];
         themeVersion: string;
         keycloakVersionDefaultAssets: string;
     };
@@ -53,12 +53,11 @@ assert<BuildOptions extends BuildOptionsLike ? true : false>();
 export async function generateTheme(params: {
     reactAppBuildDirPath: string;
     keycloakThemeBuildingDirPath: string;
-    themeSrcDirPath: string;
+    emailThemeSrcDirPath: string | undefined;
-    keycloakifySrcDirPath: string;
     buildOptions: BuildOptionsLike;
     keycloakifyVersion: string;
-}): Promise<void> {
+}): Promise<{ doBundlesEmailTemplate: boolean }> {
-    const { reactAppBuildDirPath, keycloakThemeBuildingDirPath, themeSrcDirPath, keycloakifySrcDirPath, buildOptions, keycloakifyVersion } = params;
+    const { reactAppBuildDirPath, keycloakThemeBuildingDirPath, emailThemeSrcDirPath, buildOptions, keycloakifyVersion } = params;
 
     const getThemeDirPath = (themeType: ThemeType | "email") =>
         pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", buildOptions.themeName, themeType);
@@ -68,10 +67,6 @@ export async function generateTheme(params: {
     let generateFtlFilesCode_glob: ReturnType<typeof generateFtlFilesCodeFactory>["generateFtlFilesCode"] | undefined = undefined;
 
     for (const themeType of themeTypes) {
-        if (!fs.existsSync(pathJoin(themeSrcDirPath, themeType))) {
-            continue;
-        }
-
         const themeDirPath = getThemeDirPath(themeType);
 
         copy_app_resources_to_theme_path: {
@@ -137,21 +132,21 @@ export async function generateTheme(params: {
             });
         }
 
-        const generateFtlFilesCode =
+        const generateFtlFilesCode = (() => {
-            generateFtlFilesCode_glob !== undefined
+            if (generateFtlFilesCode_glob !== undefined) {
-                ? generateFtlFilesCode_glob
+                return generateFtlFilesCode_glob;
-                : generateFtlFilesCodeFactory({
+            }
-                      "indexHtmlCode": fs.readFileSync(pathJoin(reactAppBuildDirPath, "index.html")).toString("utf8"),
+
-                      "cssGlobalsToDefine": allCssGlobalsToDefine,
+            const { generateFtlFilesCode } = generateFtlFilesCodeFactory({
-                      buildOptions,
+                "indexHtmlCode": fs.readFileSync(pathJoin(reactAppBuildDirPath, "index.html")).toString("utf8"),
-                      keycloakifyVersion,
+                "cssGlobalsToDefine": allCssGlobalsToDefine,
-                      themeType,
+                buildOptions,
-                      "fieldNames": readFieldNameUsage({
+                keycloakifyVersion,
-                          keycloakifySrcDirPath,
+                themeType
-                          themeSrcDirPath,
+            });
-                          themeType
+
-                      })
+            return generateFtlFilesCode;
-                  }).generateFtlFilesCode;
+        })();
 
         [
             ...(() => {
@@ -162,10 +157,14 @@ export async function generateTheme(params: {
                         return accountThemePageIds;
                 }
             })(),
-            ...readExtraPagesNames({
+            ...((() => {
-                themeType,
+                switch (themeType) {
-                themeSrcDirPath
+                    case "login":
-            })
+                        return buildOptions.extraLoginPages;
+                    case "account":
+                        return buildOptions.extraAccountPages;
+                }
+            })() ?? [])
         ].forEach(pageId => {
             const { ftlCode } = generateFtlFilesCode({ pageId });
 
@@ -174,19 +173,6 @@ export async function generateTheme(params: {
             fs.writeFileSync(pathJoin(themeDirPath, pageId), Buffer.from(ftlCode, "utf8"));
         });
 
-        generateMessageProperties({
-            themeSrcDirPath,
-            themeType
-        }).forEach(({ languageTag, propertiesFileSource }) => {
-            const messagesDirPath = pathJoin(themeDirPath, "messages");
-
-            fs.mkdirSync(pathJoin(themeDirPath, "messages"), { "recursive": true });
-
-            const propertiesFilePath = pathJoin(messagesDirPath, `messages_${languageTag}.properties`);
-
-            fs.writeFileSync(propertiesFilePath, Buffer.from(propertiesFileSource, "utf8"));
-        });
-
         //TODO: Remove this block we left it for now only for backward compatibility
         // we now have a separate script for this
         copy_keycloak_resources_to_public: {
@@ -230,20 +216,25 @@ export async function generateTheme(params: {
 
         fs.writeFileSync(
             pathJoin(themeDirPath, "theme.properties"),
-            Buffer.from([`parent=keycloak`, ...(buildOptions.extraThemeProperties ?? [])].join("\n\n"), "utf8")
+            Buffer.from(["parent=keycloak", ...(buildOptions.extraThemeProperties ?? [])].join("\n\n"), "utf8")
         );
     }
 
-    email: {
+    let doBundlesEmailTemplate: boolean;
-        const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
 
-        if (!fs.existsSync(emailThemeSrcDirPath)) {
+    email: {
+        if (emailThemeSrcDirPath === undefined) {
+            doBundlesEmailTemplate = false;
             break email;
         }
 
+        doBundlesEmailTemplate = true;
+
         transformCodebase({
             "srcDirPath": emailThemeSrcDirPath,
             "destDirPath": getThemeDirPath("email")
         });
     }
+
+    return { doBundlesEmailTemplate };
 }

src/bin/keycloakify/generateTheme/readExtraPageNames.ts

@@ -1,38 +0,0 @@
-import { crawl } from "../../tools/crawl";
-import { type ThemeType, accountThemePageIds, loginThemePageIds } from "../generateFtl";
-import { id } from "tsafe/id";
-import { removeDuplicates } from "evt/tools/reducers/removeDuplicates";
-import * as fs from "fs";
-import { join as pathJoin } from "path";
-
-export function readExtraPagesNames(params: { themeSrcDirPath: string; themeType: ThemeType }): string[] {
-    const { themeSrcDirPath, themeType } = params;
-
-    const filePaths = crawl({
-        "dirPath": pathJoin(themeSrcDirPath, themeType),
-        "returnedPathsType": "absolute"
-    }).filter(filePath => /\.(ts|tsx|js|jsx)$/.test(filePath));
-
-    const candidateFilePaths = filePaths.filter(filePath => /kcContext\.[^.]+$/.test(filePath));
-
-    if (candidateFilePaths.length === 0) {
-        candidateFilePaths.push(...filePaths);
-    }
-
-    const extraPages: string[] = [];
-
-    for (const candidateFilPath of candidateFilePaths) {
-        const rawSourceFile = fs.readFileSync(candidateFilPath).toString("utf8");
-
-        extraPages.push(...Array.from(rawSourceFile.matchAll(/["']?pageId["']?\s*:\s*["']([^.]+.ftl)["']/g), m => m[1]));
-    }
-
-    return extraPages.reduce(...removeDuplicates<string>()).filter(pageId => {
-        switch (themeType) {
-            case "account":
-                return !id<readonly string[]>(accountThemePageIds).includes(pageId);
-            case "login":
-                return !id<readonly string[]>(loginThemePageIds).includes(pageId);
-        }
-    });
-}

src/bin/keycloakify/generateTheme/readFieldNameUsage.ts

@@ -1,35 +0,0 @@
-import { crawl } from "../../tools/crawl";
-import { removeDuplicates } from "evt/tools/reducers/removeDuplicates";
-import { join as pathJoin } from "path";
-import * as fs from "fs";
-import type { ThemeType } from "../generateFtl";
-import { exclude } from "tsafe/exclude";
-
-/** Assumes the theme type exists */
-export function readFieldNameUsage(params: { keycloakifySrcDirPath: string; themeSrcDirPath: string; themeType: ThemeType }): string[] {
-    const { keycloakifySrcDirPath, themeSrcDirPath, themeType } = params;
-
-    const fieldNames: string[] = [];
-
-    for (const srcDirPath of ([pathJoin(keycloakifySrcDirPath, themeType), pathJoin(themeSrcDirPath, themeType)] as const).filter(
-        exclude(undefined)
-    )) {
-        const filePaths = crawl({ "dirPath": srcDirPath, "returnedPathsType": "absolute" }).filter(filePath => /\.(ts|tsx|js|jsx)$/.test(filePath));
-
-        for (const filePath of filePaths) {
-            const rawSourceFile = fs.readFileSync(filePath).toString("utf8");
-
-            if (!rawSourceFile.includes("messagesPerField")) {
-                continue;
-            }
-
-            fieldNames.push(
-                ...Array.from(rawSourceFile.matchAll(/(?:(?:printIfExists)|(?:existsError)|(?:get)|(?:exists))\(\s*["']([^"']+)["']/g), m => m[1])
-            );
-        }
-    }
-
-    const out = fieldNames.reduce(...removeDuplicates<string>());
-
-    return out;
-}

src/bin/keycloakify/keycloakify.ts

@@ -9,9 +9,8 @@ import { getLogger } from "../tools/logger";
 import jar from "../tools/jar";
 import { assert } from "tsafe/assert";
 import { Equals } from "tsafe";
-import { getThemeSrcDirPath } from "../getSrcDirPath";
+import { getEmailThemeSrcDirPath } from "../getSrcDirPath";
 import { getProjectRoot } from "../tools/getProjectRoot";
-import { objectKeys } from "tsafe/objectKeys";
 
 export async function main() {
     const projectDirPath = process.cwd();
@@ -24,48 +23,42 @@ export async function main() {
     const logger = getLogger({ "isSilent": buildOptions.isSilent });
     logger.log("🔏 Building the keycloak theme...⌚");
 
-    const keycloakifyDirPath = getProjectRoot();
+    let doBundlesEmailTemplate: boolean | undefined;
-
-    const { themeSrcDirPath } = getThemeSrcDirPath({ projectDirPath });
 
     for (const themeName of [buildOptions.themeName, ...buildOptions.extraThemeNames]) {
-        await generateTheme({
+        const { doBundlesEmailTemplate: doBundlesEmailTemplate_ } = await generateTheme({
-            "keycloakThemeBuildingDirPath": buildOptions.keycloakifyBuildDirPath,
+            keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
-            themeSrcDirPath,
+            "emailThemeSrcDirPath": (() => {
-            "keycloakifySrcDirPath": pathJoin(keycloakifyDirPath, "src"),
+                const { emailThemeSrcDirPath } = getEmailThemeSrcDirPath({ projectDirPath });
+
+                if (emailThemeSrcDirPath === undefined || !fs.existsSync(emailThemeSrcDirPath)) {
+                    return;
+                }
+
+                return emailThemeSrcDirPath;
+            })(),
             "reactAppBuildDirPath": buildOptions.reactAppBuildDirPath,
             "buildOptions": {
                 ...buildOptions,
                 "themeName": themeName
             },
             "keycloakifyVersion": (() => {
-                const version = JSON.parse(fs.readFileSync(pathJoin(keycloakifyDirPath, "package.json")).toString("utf8"))["version"];
+                const version = JSON.parse(fs.readFileSync(pathJoin(getProjectRoot(), "package.json")).toString("utf8"))["version"];
 
                 assert(typeof version === "string");
 
                 return version;
             })()
         });
+
+        doBundlesEmailTemplate ??= doBundlesEmailTemplate_;
     }
 
+    assert(doBundlesEmailTemplate !== undefined);
+
     const { jarFilePath } = generateJavaStackFiles({
-        "keycloakThemeBuildingDirPath": buildOptions.keycloakifyBuildDirPath,
+        keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
-        "implementedThemeTypes": (() => {
+        doBundlesEmailTemplate,
-            const implementedThemeTypes = {
-                "login": false,
-                "account": false,
-                "email": false
-            };
-
-            for (const themeType of objectKeys(implementedThemeTypes)) {
-                if (!fs.existsSync(pathJoin(themeSrcDirPath, themeType))) {
-                    continue;
-                }
-                implementedThemeTypes[themeType] = true;
-            }
-
-            return implementedThemeTypes;
-        })(),
         buildOptions
     });
 
@@ -92,7 +85,7 @@ export async function main() {
     }
 
     // We want, however, to test in a container running the latest Keycloak version
-    const containerKeycloakVersion = "21.1.2";
+    const containerKeycloakVersion = "20.0.1";
 
     generateStartKeycloakTestingContainer({
         keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,

src/bin/keycloakify/parsedPackageJson.ts

@@ -11,6 +11,10 @@ export type ParsedPackageJson = {
     version?: string;
     homepage?: string;
     keycloakify?: {
+        /** @deprecated: use extraLoginPages instead */
+        extraPages?: string[];
+        extraLoginPages?: string[];
+        extraAccountPages?: string[];
         extraThemeProperties?: string[];
         areAppAndKeycloakServerSharingSameDomain?: boolean;
         artifactId?: string;
@@ -19,6 +23,7 @@ export type ParsedPackageJson = {
         keycloakVersionDefaultAssets?: string;
         reactAppBuildDirPath?: string;
         keycloakifyBuildDirPath?: string;
+        customUserAttributes?: string[];
         themeName?: string;
         extraThemeNames?: string[];
     };
@@ -30,6 +35,9 @@ export const zParsedPackageJson = z.object({
     "homepage": z.string().optional(),
     "keycloakify": z
         .object({
+            "extraPages": z.array(z.string()).optional(),
+            "extraLoginPages": z.array(z.string()).optional(),
+            "extraAccountPages": z.array(z.string()).optional(),
             "extraThemeProperties": z.array(z.string()).optional(),
             "areAppAndKeycloakServerSharingSameDomain": z.boolean().optional(),
             "artifactId": z.string().optional(),
@@ -38,6 +46,7 @@ export const zParsedPackageJson = z.object({
             "keycloakVersionDefaultAssets": z.string().optional(),
             "reactAppBuildDirPath": z.string().optional(),
             "keycloakifyBuildDirPath": z.string().optional(),
+            "customUserAttributes": z.array(z.string()).optional(),
             "themeName": z.string().optional(),
             "extraThemeNames": z.array(z.string()).optional()
         })

src/bin/tools/crawl.ts

@@ -1,32 +1,27 @@
 import * as fs from "fs";
 import * as path from "path";
 
-const crawlRec = (dir_path: string, paths: string[]) => {
-    for (const file_name of fs.readdirSync(dir_path)) {
-        const file_path = path.join(dir_path, file_name);
-
-        if (fs.lstatSync(file_path).isDirectory()) {
-            crawlRec(file_path, paths);
-
-            continue;
-        }
-
-        paths.push(file_path);
-    }
-};
-
 /** List all files in a given directory return paths relative to the dir_path */
-export function crawl(params: { dirPath: string; returnedPathsType: "absolute" | "relative to dirPath" }): string[] {
+export const crawl = (() => {
-    const { dirPath, returnedPathsType } = params;
+    const crawlRec = (dir_path: string, paths: string[]) => {
+        for (const file_name of fs.readdirSync(dir_path)) {
+            const file_path = path.join(dir_path, file_name);
 
-    const filePaths: string[] = [];
+            if (fs.lstatSync(file_path).isDirectory()) {
+                crawlRec(file_path, paths);
 
-    crawlRec(dirPath, filePaths);
+                continue;
+            }
 
-    switch (returnedPathsType) {
+            paths.push(file_path);
-        case "absolute":
+        }
-            return filePaths;
+    };
-        case "relative to dirPath":
+
-            return filePaths.map(filePath => path.relative(dirPath, filePath));
+    return function crawl(dir_path: string): string[] {
-    }
+        const paths: string[] = [];
-}
+
+        crawlRec(dir_path, paths);
+
+        return paths.map(file_path => path.relative(dir_path, file_path));
+    };
+})();

src/bin/tools/downloadAndUnzip.ts

@@ -2,8 +2,8 @@ import { exec as execCallback } from "child_process";
 import { createHash } from "crypto";
 import { mkdir, readFile, stat, writeFile } from "fs/promises";
 import fetch, { type FetchOptions } from "make-fetch-happen";
-import { dirname as pathDirname, join as pathJoin, resolve as pathResolve, sep as pathSep } from "path";
+import { dirname as pathDirname, join as pathJoin } from "path";
-import { assert } from "tsafe/assert";
+import { assert } from "tsafe";
 import { promisify } from "util";
 import { getProjectRoot } from "./getProjectRoot";
 import { transformCodebase } from "./transformCodebase";
@@ -48,28 +48,9 @@ async function getNmpConfig() {
     return readNpmConfig().then(parseNpmConfig);
 }
 
-function readNpmConfig(): Promise<string> {
+async function readNpmConfig() {
-    return (async function callee(depth: number): Promise<string> {
+    const { stdout } = await exec("npm config get", { encoding: "utf8" });
-        const cwd = pathResolve(pathJoin(...[process.cwd(), ...Array(depth).fill("..")]));
+    return stdout;
-
-        let stdout: string;
-
-        try {
-            stdout = await exec("npm config get", { "encoding": "utf8", cwd }).then(({ stdout }) => stdout);
-        } catch (error) {
-            console.log(String(error), error);
-
-            if (String(error).includes("ENOWORKSPACES")) {
-                assert(cwd !== pathSep);
-
-                return callee(depth + 1);
-            }
-
-            throw error;
-        }
-
-        return stdout;
-    })(0);
 }
 
 function parseNpmConfig(stdout: string) {

src/bin/tools/transformCodebase.ts

@@ -20,12 +20,12 @@ export function transformCodebase(params: { srcDirPath: string; destDirPath: str
         }))
     } = params;
 
-    for (const file_relative_path of crawl({ "dirPath": srcDirPath, "returnedPathsType": "relative to dirPath" })) {
+    for (const file_relative_path of crawl(srcDirPath)) {
         const filePath = path.join(srcDirPath, file_relative_path);
 
         const transformSourceCodeResult = transformSourceCode({
             "sourceCode": fs.readFileSync(filePath),
-            filePath
+            "filePath": path.join(srcDirPath, file_relative_path)
         });
 
         if (transformSourceCodeResult === undefined) {

src/login/i18n/i18n.tsx

@@ -211,8 +211,7 @@ const keycloakifyExtraMessages = {
         "shouldBeDifferent": "{0} should be different to {1}",
         "shouldMatchPattern": "Pattern should match: `/{0}/`",
         "mustBeAnInteger": "Must be an integer",
-        "notAValidOption": "Not a valid option",
+        "notAValidOption": "Not a valid option"
-        "selectAnOption": "Select an option"
     },
     "fr": {
         /* spell-checker: disable */
@@ -224,8 +223,7 @@ const keycloakifyExtraMessages = {
 
         "logoutConfirmTitle": "Déconnexion",
         "logoutConfirmHeader": "Êtes-vous sûr(e) de vouloir vous déconnecter ?",
-        "doLogout": "Se déconnecter",
+        "doLogout": "Se déconnecter"
-        "selectAnOption": "Sélectionner une option"
         /* spell-checker: enable */
     }
 };

src/login/index.ts

@@ -5,7 +5,6 @@ export default Fallback;
 export { useDownloadTerms } from "keycloakify/login/lib/useDownloadTerms";
 export { getKcContext } from "keycloakify/login/kcContext/getKcContext";
 export { createGetKcContext } from "keycloakify/login/kcContext/createGetKcContext";
-export type { LoginThemePageId as PageId } from "keycloakify/bin/keycloakify/generateFtl";
 export { createUseI18n } from "keycloakify/login/i18n/i18n";
 
 export type { PageProps } from "keycloakify/login/pages/PageProps";

src/login/kcContext/KcContext.ts

@@ -81,34 +81,9 @@ export declare namespace KcContext {
         };
         isAppInitiatedAction: boolean;
         messagesPerField: {
-            /**
+            printIfExists: <T>(fieldName: string, x: T) => T | undefined;
-             * Return text if message for given field exists. Useful eg. to add css styles for fields with message.
-             *
-             * @param fieldName to check for
-             * @param text to return
-             * @return text if message exists for given field, else undefined
-             */
-            printIfExists: <T extends string>(fieldName: string, text: T) => T | undefined;
-            /**
-             * Check if exists error message for given fields
-             *
-             * @param fields
-             * @return boolean
-             */
             existsError: (fieldName: string) => boolean;
-            /**
-             * Get message for given field.
-             *
-             * @param fieldName
-             * @return message text or empty string
-             */
             get: (fieldName: string) => string;
-            /**
-             * Check if message for given field exists
-             *
-             * @param field
-             * @return boolean
-             */
             exists: (fieldName: string) => boolean;
         };
     };
@@ -145,7 +120,7 @@ export declare namespace KcContext {
             rememberMe?: string;
             password?: string;
         };
-        usernameHidden?: boolean;
+        usernameEditDisabled: boolean;
         social: {
             displayInfo: boolean;
             providers?: {

src/login/kcContext/kcContextMocks.ts

@@ -6,7 +6,7 @@ import { id } from "tsafe/id";
 import { assert, type Equals } from "tsafe/assert";
 import type { LoginThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
 
-const PUBLIC_URL = (typeof process !== "object" ? undefined : process.env?.["PUBLIC_URL"]) || "/";
+const PUBLIC_URL = process.env["PUBLIC_URL"] ?? "/";
 
 const attributes: Attribute[] = [
     {
@@ -264,7 +264,7 @@ export const kcContextMocks = [
         "social": {
             "displayInfo": true
         },
-        "usernameHidden": false,
+        "usernameEditDisabled": false,
         "login": {},
         "registrationDisabled": false
     }),

src/login/lib/useFormValidation.tsx

@@ -25,7 +25,16 @@ export function useFormValidation(params: {
     passwordValidators?: Validators;
     i18n: I18n;
 }) {
-    const { kcContext, passwordValidators = {}, i18n } = params;
+    const {
+        kcContext,
+        passwordValidators = {
+            "length": {
+                "ignore.empty.value": true,
+                "min": "4"
+            }
+        },
+        i18n
+    } = params;
 
     const attributesWithPassword = useMemo(
         () =>
@@ -202,7 +211,7 @@ function useGetErrors(params: {
         const { value: defaultValue, validators } = attributes.find(attribute => attribute.name === name)!;
 
         block: {
-            if ((defaultValue ?? "") !== value) {
+            if (defaultValue !== value) {
                 break block;
             }
 

src/login/pages/Login.tsx

@@ -14,7 +14,7 @@ export default function Login(props: PageProps<Extract<KcContext, { pageId: "log
         classes
     });
 
-    const { social, realm, url, usernameHidden, login, auth, registrationDisabled } = kcContext;
+    const { social, realm, url, usernameEditDisabled, login, auth, registrationDisabled } = kcContext;
 
     const { msg, msgStr } = i18n;
 
@@ -66,37 +66,40 @@ export default function Login(props: PageProps<Extract<KcContext, { pageId: "log
                     {realm.password && (
                         <form id="kc-form-login" onSubmit={onSubmit} action={url.loginAction} method="post">
                             <div className={getClassName("kcFormGroupClass")}>
-                                {!usernameHidden &&
+                                {(() => {
-                                    (() => {
+                                    const label = !realm.loginWithEmailAllowed
-                                        const label = !realm.loginWithEmailAllowed
+                                        ? "username"
-                                            ? "username"
+                                        : realm.registrationEmailAsUsername
-                                            : realm.registrationEmailAsUsername
+                                        ? "email"
-                                            ? "email"
+                                        : "usernameOrEmail";
-                                            : "usernameOrEmail";
 
-                                        const autoCompleteHelper: typeof label = label === "usernameOrEmail" ? "username" : label;
+                                    const autoCompleteHelper: typeof label = label === "usernameOrEmail" ? "username" : label;
 
-                                        return (
+                                    return (
-                                            <>
+                                        <>
-                                                <label htmlFor={autoCompleteHelper} className={getClassName("kcLabelClass")}>
+                                            <label htmlFor={autoCompleteHelper} className={getClassName("kcLabelClass")}>
-                                                    {msg(label)}
+                                                {msg(label)}
-                                                </label>
+                                            </label>
-                                                <input
+                                            <input
-                                                    tabIndex={1}
+                                                tabIndex={1}
-                                                    id={autoCompleteHelper}
+                                                id={autoCompleteHelper}
-                                                    className={getClassName("kcInputClass")}
+                                                className={getClassName("kcInputClass")}
-                                                    //NOTE: This is used by Google Chrome auto fill so we use it to tell
+                                                //NOTE: This is used by Google Chrome auto fill so we use it to tell
-                                                    //the browser how to pre fill the form but before submit we put it back
+                                                //the browser how to pre fill the form but before submit we put it back
-                                                    //to username because it is what keycloak expects.
+                                                //to username because it is what keycloak expects.
-                                                    name={autoCompleteHelper}
+                                                name={autoCompleteHelper}
-                                                    defaultValue={login.username ?? ""}
+                                                defaultValue={login.username ?? ""}
-                                                    type="text"
+                                                type="text"
-                                                    autoFocus={true}
+                                                {...(usernameEditDisabled
-                                                    autoComplete="off"
+                                                    ? { "disabled": true }
-                                                />
+                                                    : {
-                                            </>
+                                                          "autoFocus": true,
-                                        );
+                                                          "autoComplete": "off"
-                                    })()}
+                                                      })}
+                                            />
+                                        </>
+                                    );
+                                })()}
                             </div>
                             <div className={getClassName("kcFormGroupClass")}>
                                 <label htmlFor="password" className={getClassName("kcLabelClass")}>
@@ -113,7 +116,7 @@ export default function Login(props: PageProps<Extract<KcContext, { pageId: "log
                             </div>
                             <div className={clsx(getClassName("kcFormGroupClass"), getClassName("kcFormSettingClass"))}>
                                 <div id="kc-form-options">
-                                    {realm.rememberMe && !usernameHidden && (
+                                    {realm.rememberMe && !usernameEditDisabled && (
                                         <div className="checkbox">
                                             <label>
                                                 <input

src/login/pages/LoginUpdatePassword.tsx

@@ -123,7 +123,7 @@ export default function LoginUpdatePassword(props: PageProps<Extract<KcContext,
                                     getClassName("kcButtonLargeClass")
                                 )}
                                 type="submit"
-                                value={msgStr("doSubmit")}
+                                defaultValue={msgStr("doSubmit")}
                             />
                         )}
                     </div>

src/login/pages/shared/UserProfileFormFields.tsx

@@ -17,7 +17,7 @@ export type UserProfileFormFieldsProps = {
 export function UserProfileFormFields(props: UserProfileFormFieldsProps) {
     const { kcContext, onIsFormSubmittableValueChange, i18n, getClassName, BeforeField, AfterField } = props;
 
-    const { advancedMsg, msg } = i18n;
+    const { advancedMsg } = i18n;
 
     const {
         formValidationState: { fieldStateByAttributeName, isFormSubmittable },
@@ -98,16 +98,11 @@ export function UserProfileFormFields(props: UserProfileFormFieldsProps) {
                                                 }
                                                 value={value}
                                             >
-                                                <>
+                                                {options.options.map(option => (
-                                                    <option value="" selected disabled hidden>
+                                                    <option key={option} value={option}>
-                                                        {msg("selectAnOption")}
+                                                        {option}
                                                     </option>
-                                                    {options.options.map(option => (
+                                                ))}
-                                                        <option key={option} value={option}>
-                                                            {option}
-                                                        </option>
-                                                    ))}
-                                                </>
                                             </select>
                                         );
                                     }

stories/login/pages/Login.stories.tsx

@@ -74,12 +74,8 @@ export const WithPresetUsername = () => (
 export const WithImmutablePresetUsername = () => (
     <PageStory
         kcContext={{
-            auth: {
+            login: { username: "max.mustermann@mail.com" },
-                attemptedUsername: "max.mustermann@mail.com",
+            usernameEditDisabled: true
-                showUsername: true
-            },
-            usernameHidden: true,
-            message: { type: "info", summary: "Please re-authenticate to continue" }
         }}
     />
 );

test/bin/tools/crawl.spec.ts

@@ -1,68 +0,0 @@
-import path from "path";
-import { it, describe, expect, vi, beforeAll, afterAll } from "vitest";
-import { crawl } from "keycloakify/bin/tools/crawl";
-
-describe("crawl", () => {
-    describe("crawRec", () => {
-        beforeAll(() => {
-            vi.mock("node:fs", async () => {
-                const mod = await vi.importActual<typeof import("fs")>("fs");
-                return {
-                    ...mod,
-                    readdirSync: vi.fn().mockImplementation((dir_path: string) => {
-                        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"):
-                                return ["file_3", "sub_3_dir", "file_4"];
-                            case path.join("root_dir", "sub_1_dir", "sub_3_dir"):
-                                return ["file_5"];
-                            case path.join("root_dir", "sub_2_dir"):
-                                return [];
-                            default: {
-                                const enoent = new Error(`ENOENT: no such file or directory, scandir '${dir_path}'`);
-                                // @ts-ignore
-                                enoent.code = "ENOENT";
-                                // @ts-ignore
-                                enoent.syscall = "open";
-                                // @ts-ignore
-                                enoent.path = dir_path;
-                                throw enoent;
-                            }
-                        }
-                    }),
-                    lstatSync: vi.fn().mockImplementation((file_path: string) => {
-                        return { isDirectory: () => file_path.endsWith("_dir") };
-                    })
-                };
-            });
-        });
-        afterAll(() => {
-            vi.resetAllMocks();
-        });
-        it("returns files under a given dir_path", async () => {
-            const paths = crawl({ "dirPath": "root_dir/sub_1_dir/sub_3_dir", "returnedPathsType": "absolute" });
-            expect(paths).toEqual(["root_dir/sub_1_dir/sub_3_dir/file_5"]);
-        });
-        it("returns files recursively under a given dir_path", async () => {
-            const paths = crawl({ "dirPath": "root_dir", "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"
-            ]);
-        });
-        it("throw dir_path does not exist", async () => {
-            try {
-                crawl({ "dirPath": "404", "returnedPathsType": "absolute" });
-            } catch {
-                expect(true);
-                return;
-            }
-
-            expect(false);
-        });
-    });
-});

yarn.lock

@@ -75,16 +75,6 @@
     "@jridgewell/trace-mapping" "^0.3.17"
     jsesc "^2.5.1"
 
-"@babel/generator@^7.22.9":
-  version "7.22.9"
-  resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.22.9.tgz#572ecfa7a31002fa1de2a9d91621fd895da8493d"
-  integrity sha512-KtLMbmicyuK2Ak/FTCJVbDnkN1SlT8/kceFTiuDiiRUUSMnHMidxSCdG4ndkTOHHpoomWe/4xkvHkEOncwjYIw==
-  dependencies:
-    "@babel/types" "^7.22.5"
-    "@jridgewell/gen-mapping" "^0.3.2"
-    "@jridgewell/trace-mapping" "^0.3.17"
-    jsesc "^2.5.1"
-
 "@babel/helper-annotate-as-pure@^7.18.6":
   version "7.18.6"
   resolved "https://registry.yarnpkg.com/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.18.6.tgz#eaa49f6f80d5a33f9a5dd2276e6d6e451be0a6bb"
@@ -279,21 +269,11 @@
   resolved "https://registry.yarnpkg.com/@babel/helper-string-parser/-/helper-string-parser-7.19.4.tgz#38d3acb654b4701a9b77fb0615a96f775c3a9e63"
   integrity sha512-nHtDoQcuqFmwYNYPz3Rah5ph2p8PFeFCsZk9A/48dPc/rGocJ5J3hAAZ7pb76VWX3fZKu+uEr/FhH5jLx7umrw==
 
-"@babel/helper-string-parser@^7.22.5":
-  version "7.22.5"
-  resolved "https://registry.yarnpkg.com/@babel/helper-string-parser/-/helper-string-parser-7.22.5.tgz#533f36457a25814cf1df6488523ad547d784a99f"
-  integrity sha512-mM4COjgZox8U+JcXQwPijIZLElkgEpO5rsERVDJTc2qfCDfERyob6k5WegS14SX18IIjv+XD+GrqNumY5JRCDw==
-
 "@babel/helper-validator-identifier@^7.18.6", "@babel/helper-validator-identifier@^7.19.1":
   version "7.19.1"
   resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.19.1.tgz#7eea834cf32901ffdc1a7ee555e2f9c27e249ca2"
   integrity sha512-awrNfaMtnHUr653GgGEs++LlAvW6w+DcPrOliSMXWCKo597CwL5Acf/wWdNkf/tfEQE3mjkeD1YOVZOUV/od1w==
 
-"@babel/helper-validator-identifier@^7.22.5":
-  version "7.22.5"
-  resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.22.5.tgz#9544ef6a33999343c8740fa51350f30eeaaaf193"
-  integrity sha512-aJXu+6lErq8ltp+JhkJUfk1MTGyuA4v7f3pA+BJ5HLfNC6nAQ0Cpi9uOquUj8Hehg0aUiHzWQbOVJGao6ztBAQ==
-
 "@babel/helper-validator-option@^7.18.6", "@babel/helper-validator-option@^7.21.0":
   version "7.21.0"
   resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.21.0.tgz#8224c7e13ace4bafdc4004da2cf064ef42673180"
@@ -332,11 +312,6 @@
   resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.21.4.tgz#94003fdfc520bbe2875d4ae557b43ddb6d880f17"
   integrity sha512-alVJj7k7zIxqBZ7BTRhz0IqJFxW1VJbm6N8JbcYhQ186df9ZBPbZBmWSqAMXwHGsCJdYks7z/voa3ibiS5bCIw==
 
-"@babel/parser@^7.22.7":
-  version "7.22.7"
-  resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.22.7.tgz#df8cf085ce92ddbdbf668a7f186ce848c9036cae"
-  integrity sha512-7NF8pOkHP5o2vpmGgNGcfAeCvOYhGLyA3Z4eBQkT1RJlWu47n63bCs93QfJ2hIAFCil7L5P2IWhs1oToVgrL0Q==
-
 "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression@^7.18.6":
   version "7.18.6"
   resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression/-/plugin-bugfix-safari-id-destructuring-collision-in-function-expression-7.18.6.tgz#da5b8f9a580acdfbe53494dba45ea389fb09a4d2"
@@ -1145,15 +1120,6 @@
     debug "^4.1.0"
     globals "^11.1.0"
 
-"@babel/types@^7.0.0", "@babel/types@^7.22.5":
-  version "7.22.5"
-  resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.22.5.tgz#cd93eeaab025880a3a47ec881f4b096a5b786fbe"
-  integrity sha512-zo3MIHGOkPOfoRXitsgHLjEXmlDaD/5KU1Uzuc9GNiZPhSqVxVRtxuPaSBZDsYZ9qV88AjtMtWW7ww98loJ9KA==
-  dependencies:
-    "@babel/helper-string-parser" "^7.22.5"
-    "@babel/helper-validator-identifier" "^7.22.5"
-    to-fast-properties "^2.0.0"
-
 "@babel/types@^7.12.11", "@babel/types@^7.12.7", "@babel/types@^7.18.6", "@babel/types@^7.18.9", "@babel/types@^7.2.0", "@babel/types@^7.20.0", "@babel/types@^7.20.2", "@babel/types@^7.20.5", "@babel/types@^7.20.7", "@babel/types@^7.21.0", "@babel/types@^7.21.2", "@babel/types@^7.21.4", "@babel/types@^7.4.4":
   version "7.21.4"
   resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.21.4.tgz#2d5d6bb7908699b3b416409ffd3b5daa25b030d4"
@@ -2797,13 +2763,6 @@
   resolved "https://registry.yarnpkg.com/@types/aria-query/-/aria-query-5.0.1.tgz#3286741fb8f1e1580ac28784add4c7a1d49bdfbc"
   integrity sha512-XTIieEY+gvJ39ChLcB4If5zHtPxt3Syj5rgZR+e1ctpmK8NjPf0zFqsz4JpLJT0xla9GFDKjy8Cpu331nrmE1Q==
 
-"@types/babel__generator@^7.6.4":
-  version "7.6.4"
-  resolved "https://registry.yarnpkg.com/@types/babel__generator/-/babel__generator-7.6.4.tgz#1f20ce4c5b1990b37900b63f050182d28c2439b7"
-  integrity sha512-tFkciB9j2K755yrTALxD44McOrk+gfpIpvC3sxHjRawj6PfnQxrse4Clq5y/Rq+G3mrBurMax/lG8Qn2t9mSsg==
-  dependencies:
-    "@babel/types" "^7.0.0"
-
 "@types/chai-subset@^1.3.3":
   version "1.3.3"
   resolved "https://registry.yarnpkg.com/@types/chai-subset/-/chai-subset-1.3.3.tgz#97893814e92abd2c534de422cb377e0e0bdaac94"
@@ -3857,16 +3816,6 @@ assert@^1.1.1:
     object-assign "^4.1.1"
     util "0.10.3"
 
-assert@^2.0.0:
-  version "2.0.0"
-  resolved "https://registry.yarnpkg.com/assert/-/assert-2.0.0.tgz#95fc1c616d48713510680f2eaf2d10dd22e02d32"
-  integrity sha512-se5Cd+js9dXJnu6Ag2JFc00t+HmHOen+8Q+L7O9zI0PqQXr20uk2J0XQqMxZEeo5U50o8Nvmmx7dZrl+Ufr35A==
-  dependencies:
-    es6-object-assign "^1.1.0"
-    is-nan "^1.2.1"
-    object-is "^1.0.1"
-    util "^0.12.0"
-
 assertion-error@^1.1.0:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/assertion-error/-/assertion-error-1.1.0.tgz#e60b6b0e8f301bd97e5375215bda406c85118c0b"
@@ -3884,13 +3833,6 @@ ast-types@^0.14.2:
   dependencies:
     tslib "^2.0.1"
 
-ast-types@^0.16.1:
-  version "0.16.1"
-  resolved "https://registry.yarnpkg.com/ast-types/-/ast-types-0.16.1.tgz#7a9da1617c9081bc121faafe91711b4c8bb81da2"
-  integrity sha512-6t10qk83GOG8p0vKmaCr8eiilZwO171AvbROMtvvNiwrTly62t+7XkA8RdIIVbpMhCASAsxgAzdRSwh6nw/5Dg==
-  dependencies:
-    tslib "^2.0.1"
-
 astral-regex@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/astral-regex/-/astral-regex-2.0.0.tgz#483143c567aeed4785759c0865786dc77d7d2e31"
@@ -5797,11 +5739,6 @@ es6-iterator@^2.0.3:
     es5-ext "^0.10.35"
     es6-symbol "^3.1.1"
 
-es6-object-assign@^1.1.0:
-  version "1.1.0"
-  resolved "https://registry.yarnpkg.com/es6-object-assign/-/es6-object-assign-1.1.0.tgz#c2c3582656247c39ea107cb1e6652b6f9f24523c"
-  integrity sha512-MEl9uirslVwqQU369iHNWZXsI8yaZYGg/D65aOgZkeyFJwHYSxilf7rQzXKI7DdDuBPrBXbfk3sl9hJhmd5AUw==
-
 es6-shim@^0.35.5:
   version "0.35.8"
   resolved "https://registry.yarnpkg.com/es6-shim/-/es6-shim-0.35.8.tgz#89216f6fbf8bacba3f897c8c0e814d2a41c05fb7"
@@ -5916,7 +5853,7 @@ eslint-visitor-keys@^3.3.0:
   resolved "https://registry.yarnpkg.com/eslint-visitor-keys/-/eslint-visitor-keys-3.4.0.tgz#c7f0f956124ce677047ddbc192a68f999454dedc"
   integrity sha512-HPpKPUBQcAsZOsHAFwTtIKcYlCje62XB7SEAcxjtmW6TD1WVpkS6i6/hOVtTZIl4zGj/mBqpFVGvaDneik+VoQ==
 
-esprima@^4.0.0, esprima@^4.0.1, esprima@~4.0.0:
+esprima@^4.0.0, esprima@^4.0.1:
   version "4.0.1"
   resolved "https://registry.yarnpkg.com/esprima/-/esprima-4.0.1.tgz#13b04cdb3e6c5d19df91ab6987a8695619b0aa71"
   integrity sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==
@@ -7240,7 +7177,7 @@ is-alphanumerical@^1.0.0:
     is-alphabetical "^1.0.0"
     is-decimal "^1.0.0"
 
-is-arguments@^1.0.4, is-arguments@^1.1.1:
+is-arguments@^1.1.1:
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/is-arguments/-/is-arguments-1.1.1.tgz#15b3f88fda01f2a97fec84ca761a560f123efa9b"
   integrity sha512-8Q7EARjzEnKpt/PCD7e1cgUS0a6X8u5tdSiMqXhojOdoV9TsMsiO+9VLC5vAmO8N7/GmXn7yjR8qnA6bVAEzfA==
@@ -7414,13 +7351,6 @@ is-function@^1.0.2:
   resolved "https://registry.yarnpkg.com/is-function/-/is-function-1.0.2.tgz#4f097f30abf6efadac9833b17ca5dc03f8144e08"
   integrity sha512-lw7DUp0aWXYg+CBCN+JKkcE0Q2RayZnSvnZBlwgxHBQhqt5pZNVy4Ri7H9GmmXkdu7LUthszM+Tor1u/2iBcpQ==
 
-is-generator-function@^1.0.7:
-  version "1.0.10"
-  resolved "https://registry.yarnpkg.com/is-generator-function/-/is-generator-function-1.0.10.tgz#f1558baf1ac17e0deea7c0415c438351ff2b3c72"
-  integrity sha512-jsEjy9l3yiXEQ+PsXdmBwEPcOxaXWLspKdplFUVI9vq1iZgIekeC0L167qeu86czQaxed3q/Uzuw0swL0irL8A==
-  dependencies:
-    has-tostringtag "^1.0.0"
-
 is-glob@^3.0.0, is-glob@^3.1.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/is-glob/-/is-glob-3.1.0.tgz#7ba5ae24217804ac70707b96922567486cc3e84a"
@@ -7450,14 +7380,6 @@ is-map@^2.0.1, is-map@^2.0.2:
   resolved "https://registry.yarnpkg.com/is-map/-/is-map-2.0.2.tgz#00922db8c9bf73e81b7a335827bc2a43f2b91127"
   integrity sha512-cOZFQQozTha1f4MxLFzlgKYPTyj26picdZTx82hbc/Xf4K/tZOOXSCkMvU4pKioRXGDLJRn0GM7Upe7kR721yg==
 
-is-nan@^1.2.1:
-  version "1.3.2"
-  resolved "https://registry.yarnpkg.com/is-nan/-/is-nan-1.3.2.tgz#043a54adea31748b55b6cd4e09aadafa69bd9e1d"
-  integrity sha512-E+zBKpQ2t6MEo1VsonYmluk9NxGrbzpeeLC2xIViuO2EjU2xsXsBPwTr3Ykv9l08UYEVEdWeRZNouaZqF6RN0w==
-  dependencies:
-    call-bind "^1.0.0"
-    define-properties "^1.1.3"
-
 is-negative-zero@^2.0.2:
   version "2.0.2"
   resolved "https://registry.yarnpkg.com/is-negative-zero/-/is-negative-zero-2.0.2.tgz#7bf6f03a28003b8b3965de3ac26f664d765f3150"
@@ -7574,13 +7496,6 @@ is-typed-array@^1.1.10, is-typed-array@^1.1.9:
     gopd "^1.0.1"
     has-tostringtag "^1.0.0"
 
-is-typed-array@^1.1.3:
-  version "1.1.12"
-  resolved "https://registry.yarnpkg.com/is-typed-array/-/is-typed-array-1.1.12.tgz#d0bab5686ef4a76f7a73097b95470ab199c57d4a"
-  integrity sha512-Z14TF2JNG8Lss5/HMqt0//T9JeHXttXy5pH/DBU4vi98ozO2btxzq9MwYDZYnKwU8nRsz/+GVFVRDq3DkVuSPg==
-  dependencies:
-    which-typed-array "^1.1.11"
-
 is-typedarray@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/is-typedarray/-/is-typedarray-1.0.0.tgz#e479c80858df0c1b11ddda6940f96011fcda4a9a"
@@ -8854,7 +8769,7 @@ object-inspect@^1.12.3, object-inspect@^1.9.0:
   resolved "https://registry.yarnpkg.com/object-inspect/-/object-inspect-1.12.3.tgz#ba62dffd67ee256c8c086dfae69e016cd1f198b9"
   integrity sha512-geUvdk7c+eizMNUDkRpW1wJwgfOiOeHbxBR/hLXK1aT6zmVSO0jsQcs7fj6MGw89jC/cjGfLcNOrtMYtGqm81g==
 
-object-is@^1.0.1, object-is@^1.1.5:
+object-is@^1.1.5:
   version "1.1.5"
   resolved "https://registry.yarnpkg.com/object-is/-/object-is-1.1.5.tgz#b9deeaa5fc7f1846a0faecdceec138e5778f53ac"
   integrity sha512-3cyDsyHgtmi7I7DfSSI2LDp6SK2lwvtbg0p0R1e0RvTqF5ceGx+K2dfSjm1bKDMVCFEDAQvy+o8c6a7VujOddw==
@@ -10001,17 +9916,6 @@ readdirp@~3.6.0:
   dependencies:
     picomatch "^2.2.1"
 
-recast@^0.23.3:
-  version "0.23.3"
-  resolved "https://registry.yarnpkg.com/recast/-/recast-0.23.3.tgz#f205d1f46b2c6f730de413ab18f96c166263d85f"
-  integrity sha512-HbCVFh2ANP6a09nzD4lx7XthsxMOJWKX5pIcUwtLrmeEIl3I0DwjCoVXDE0Aobk+7k/mS3H50FK4iuYArpcT6Q==
-  dependencies:
-    assert "^2.0.0"
-    ast-types "^0.16.1"
-    esprima "~4.0.0"
-    source-map "~0.6.1"
-    tslib "^2.0.1"
-
 redent@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/redent/-/redent-1.0.0.tgz#cf916ab1fd5f1f16dfb20822dd6ec7f730c2afde"
@@ -11846,17 +11750,6 @@ util@^0.11.0:
   dependencies:
     inherits "2.0.3"
 
-util@^0.12.0:
-  version "0.12.5"
-  resolved "https://registry.yarnpkg.com/util/-/util-0.12.5.tgz#5f17a6059b73db61a875668781a1c2b136bd6fbc"
-  integrity sha512-kZf/K6hEIrWHI6XqOFUiiMa+79wE/D8Q+NCNAWclkyg3b4d2k7s0QGepNjiABc+aR3N1PAyHL7p6UcLY6LmrnA==
-  dependencies:
-    inherits "^2.0.3"
-    is-arguments "^1.0.4"
-    is-generator-function "^1.0.7"
-    is-typed-array "^1.1.3"
-    which-typed-array "^1.1.2"
-
 utila@~0.4:
   version "0.4.0"
   resolved "https://registry.yarnpkg.com/utila/-/utila-0.4.0.tgz#8a16a05d445657a3aea5eecc5b12a4fa5379772c"
@@ -12192,17 +12085,6 @@ which-pm-runs@^1.0.0:
   resolved "https://registry.yarnpkg.com/which-pm-runs/-/which-pm-runs-1.1.0.tgz#35ccf7b1a0fce87bd8b92a478c9d045785d3bf35"
   integrity sha512-n1brCuqClxfFfq/Rb0ICg9giSZqCS+pLtccdag6C2HyufBrh3fBOiy9nb6ggRMvWOVH5GrdJskj5iGTZNxd7SA==
 
-which-typed-array@^1.1.11, which-typed-array@^1.1.2:
-  version "1.1.11"
-  resolved "https://registry.yarnpkg.com/which-typed-array/-/which-typed-array-1.1.11.tgz#99d691f23c72aab6768680805a271b69761ed61a"
-  integrity sha512-qe9UWWpkeG5yzZ0tNYxDmd7vo58HDBc39mZ0xWWpolAGADdFOzkfamWLDxkOWcvHQKVmdTyQdLD4NOfjLWTKew==
-  dependencies:
-    available-typed-arrays "^1.0.5"
-    call-bind "^1.0.2"
-    for-each "^0.3.3"
-    gopd "^1.0.1"
-    has-tostringtag "^1.0.0"
-
 which-typed-array@^1.1.9:
   version "1.1.9"
   resolved "https://registry.yarnpkg.com/which-typed-array/-/which-typed-array-1.1.9.tgz#307cf898025848cf995e795e8423c7f337efbde6"