keycloakify 9.6.6 → 10.0.0-rc.0

package/src/bin/keycloakify/generateTheme/generateTheme.ts

@@ -1,331 +1,44 @@
-import { transformCodebase } from "../../tools/transformCodebase";
-import * as fs from "fs";
-import { join as pathJoin, basename as pathBasename, resolve as pathResolve, dirname as pathDirname } from "path";
-import { replaceImportsInJsCode } from "../replacers/replaceImportsInJsCode";
-import { replaceImportsInCssCode } from "../replacers/replaceImportsInCssCode";
-import { generateFtlFilesCodeFactory, loginThemePageIds, accountThemePageIds } from "../generateFtl";
-import {
-    type ThemeType,
-    lastKeycloakVersionWithAccountV1,
-    keycloak_resources,
-    retrocompatPostfix,
-    accountV1ThemeName,
-    basenameOfTheKeycloakifyResourcesDir
-} from "../../constants";
-import { isInside } from "../../tools/isInside";
+import { join as pathJoin } from "path";
 import type { BuildOptions } from "../buildOptions";
-import { assert, type Equals } from "tsafe/assert";
-import { downloadKeycloakStaticResources } from "./downloadKeycloakStaticResources";
-import { readFieldNameUsage } from "./readFieldNameUsage";
-import { readExtraPagesNames } from "./readExtraPageNames";
-import { generateMessageProperties } from "./generateMessageProperties";
-import { bringInAccountV1 } from "./bringInAccountV1";
-import { rmSync } from "../../tools/fs.rmSync";
+import { assert } from "tsafe/assert";
+import { generateSrcMainResources, type BuildOptionsLike as BuildOptionsLike_generateSrcMainResources } from "./generateSrcMainResources";
+import { generateThemeVariations } from "./generateThemeVariants";
 
-export type BuildOptionsLike = {
-    bundler: "vite" | "webpack";
-    extraThemeProperties: string[] | undefined;
-    themeVersion: string;
-    loginThemeResourcesFromKeycloakVersion: string;
+export type BuildOptionsLike = BuildOptionsLike_generateSrcMainResources & {
     keycloakifyBuildDirPath: string;
-    reactAppBuildDirPath: string;
-    cacheDirPath: string;
-    assetsDirPath: string;
-    urlPathname: string | undefined;
-    doBuildRetrocompatAccountTheme: boolean;
     themeNames: string[];
-    npmWorkspaceRootDirPath: string;
 };
 
 assert<BuildOptions extends BuildOptionsLike ? true : false>();
 
 export async function generateTheme(params: {
-    themeName: string;
     themeSrcDirPath: string;
     keycloakifySrcDirPath: string;
     buildOptions: BuildOptionsLike;
     keycloakifyVersion: string;
-}): Promise<void> {
-    const { themeName, themeSrcDirPath, keycloakifySrcDirPath, buildOptions, keycloakifyVersion } = params;
+}): Promise<{ doesImplementAccountTheme: boolean }> {
+    const { themeSrcDirPath, keycloakifySrcDirPath, buildOptions, keycloakifyVersion } = params;
 
-    const getThemeTypeDirPath = (params: { themeType: ThemeType | "email"; isRetrocompat?: true }) => {
-        const { themeType, isRetrocompat = false } = params;
-        return pathJoin(
-            buildOptions.keycloakifyBuildDirPath,
-            "src",
-            "main",
-            "resources",
-            "theme",
-            `${themeName}${isRetrocompat ? retrocompatPostfix : ""}`,
-            themeType
-        );
-    };
+    const [themeName, ...themeVariantNames] = buildOptions.themeNames;
 
-    const cssGlobalsToDefine: Record<string, string> = {};
+    const srcMainResourcesDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources");
 
-    const implementedThemeTypes: Record<ThemeType | "email", boolean> = {
-        "login": false,
-        "account": false,
-        "email": false
-    };
+    const { doesImplementAccountTheme } = await generateSrcMainResources({
+        themeName,
+        srcMainResourcesDirPath,
+        themeSrcDirPath,
+        keycloakifySrcDirPath,
+        keycloakifyVersion,
+        buildOptions
+    });
 
-    for (const themeType of ["login", "account"] as const) {
-        if (!fs.existsSync(pathJoin(themeSrcDirPath, themeType))) {
-            continue;
-        }
-
-        implementedThemeTypes[themeType] = true;
-
-        const themeTypeDirPath = getThemeTypeDirPath({ themeType });
-
-        apply_replacers_and_move_to_theme_resources: {
-            const destDirPath = pathJoin(themeTypeDirPath, "resources", basenameOfTheKeycloakifyResourcesDir);
-
-            // NOTE: Prevent accumulation of files in the assets dir, as names are hashed they pile up.
-            rmSync(destDirPath, { "recursive": true, "force": true });
-
-            if (themeType === "account" && implementedThemeTypes.login) {
-                // NOTE: We prevend doing it twice, it has been done for the login theme.
-
-                transformCodebase({
-                    "srcDirPath": pathJoin(
-                        getThemeTypeDirPath({
-                            "themeType": "login"
-                        }),
-                        "resources",
-                        basenameOfTheKeycloakifyResourcesDir
-                    ),
-                    destDirPath
-                });
-
-                break apply_replacers_and_move_to_theme_resources;
-            }
-
-            transformCodebase({
-                "srcDirPath": buildOptions.reactAppBuildDirPath,
-                destDirPath,
-                "transformSourceCode": ({ filePath, sourceCode }) => {
-                    //NOTE: Prevent cycles, excludes the folder we generated for debug in public/
-                    // This should not happen if users follow the new instruction setup but we keep it for retrocompatibility.
-                    if (
-                        isInside({
-                            "dirPath": pathJoin(buildOptions.reactAppBuildDirPath, keycloak_resources),
-                            filePath
-                        })
-                    ) {
-                        return undefined;
-                    }
-
-                    if (/\.css?$/i.test(filePath)) {
-                        const { cssGlobalsToDefine: cssGlobalsToDefineForThisFile, fixedCssCode } = replaceImportsInCssCode({
-                            "cssCode": sourceCode.toString("utf8")
-                        });
-
-                        Object.entries(cssGlobalsToDefineForThisFile).forEach(([key, value]) => {
-                            cssGlobalsToDefine[key] = value;
-                        });
-
-                        return { "modifiedSourceCode": Buffer.from(fixedCssCode, "utf8") };
-                    }
-
-                    if (/\.js?$/i.test(filePath)) {
-                        const { fixedJsCode } = replaceImportsInJsCode({
-                            "jsCode": sourceCode.toString("utf8"),
-                            buildOptions
-                        });
-
-                        return { "modifiedSourceCode": Buffer.from(fixedJsCode, "utf8") };
-                    }
-
-                    return { "modifiedSourceCode": sourceCode };
-                }
-            });
-        }
-
-        const { generateFtlFilesCode } = generateFtlFilesCodeFactory({
+    for (const themeVariantName of themeVariantNames) {
+        generateThemeVariations({
             themeName,
-            "indexHtmlCode": fs.readFileSync(pathJoin(buildOptions.reactAppBuildDirPath, "index.html")).toString("utf8"),
-            cssGlobalsToDefine,
-            buildOptions,
-            keycloakifyVersion,
-            themeType,
-            "fieldNames": readFieldNameUsage({
-                keycloakifySrcDirPath,
-                themeSrcDirPath,
-                themeType
-            })
-        });
-
-        [
-            ...(() => {
-                switch (themeType) {
-                    case "login":
-                        return loginThemePageIds;
-                    case "account":
-                        return accountThemePageIds;
-                }
-            })(),
-            ...readExtraPagesNames({
-                themeType,
-                themeSrcDirPath
-            })
-        ].forEach(pageId => {
-            const { ftlCode } = generateFtlFilesCode({ pageId });
-
-            fs.mkdirSync(themeTypeDirPath, { "recursive": true });
-
-            fs.writeFileSync(pathJoin(themeTypeDirPath, pageId), Buffer.from(ftlCode, "utf8"));
+            themeVariantName,
+            srcMainResourcesDirPath
         });
-
-        generateMessageProperties({
-            themeSrcDirPath,
-            themeType
-        }).forEach(({ languageTag, propertiesFileSource }) => {
-            const messagesDirPath = pathJoin(themeTypeDirPath, "messages");
-
-            fs.mkdirSync(pathJoin(themeTypeDirPath, "messages"), { "recursive": true });
-
-            const propertiesFilePath = pathJoin(messagesDirPath, `messages_${languageTag}.properties`);
-
-            fs.writeFileSync(propertiesFilePath, Buffer.from(propertiesFileSource, "utf8"));
-        });
-
-        await downloadKeycloakStaticResources({
-            "keycloakVersion": (() => {
-                switch (themeType) {
-                    case "account":
-                        return lastKeycloakVersionWithAccountV1;
-                    case "login":
-                        return buildOptions.loginThemeResourcesFromKeycloakVersion;
-                }
-            })(),
-            "themeDirPath": pathResolve(pathJoin(themeTypeDirPath, "..")),
-            themeType,
-            buildOptions
-        });
-
-        fs.writeFileSync(
-            pathJoin(themeTypeDirPath, "theme.properties"),
-            Buffer.from(
-                [
-                    `parent=${(() => {
-                        switch (themeType) {
-                            case "account":
-                                return accountV1ThemeName;
-                            case "login":
-                                return "keycloak";
-                        }
-                        assert<Equals<typeof themeType, never>>(false);
-                    })()}`,
-                    ...(buildOptions.extraThemeProperties ?? [])
-                ].join("\n\n"),
-                "utf8"
-            )
-        );
-
-        if (themeType === "account" && buildOptions.doBuildRetrocompatAccountTheme) {
-            transformCodebase({
-                "srcDirPath": themeTypeDirPath,
-                "destDirPath": getThemeTypeDirPath({ themeType, "isRetrocompat": true }),
-                "transformSourceCode": ({ filePath, sourceCode }) => {
-                    if (pathBasename(filePath) === "theme.properties") {
-                        return {
-                            "modifiedSourceCode": Buffer.from(
-                                sourceCode.toString("utf8").replace(`parent=${accountV1ThemeName}`, "parent=keycloak"),
-                                "utf8"
-                            )
-                        };
-                    }
-
-                    return { "modifiedSourceCode": sourceCode };
-                }
-            });
-        }
-    }
-
-    email: {
-        const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
-
-        if (!fs.existsSync(emailThemeSrcDirPath)) {
-            break email;
-        }
-
-        implementedThemeTypes.email = true;
-
-        transformCodebase({
-            "srcDirPath": emailThemeSrcDirPath,
-            "destDirPath": getThemeTypeDirPath({ "themeType": "email" })
-        });
-    }
-
-    const parsedKeycloakThemeJson: { themes: { name: string; types: string[] }[] } = { "themes": [] };
-
-    buildOptions.themeNames.forEach(themeName =>
-        parsedKeycloakThemeJson.themes.push({
-            "name": themeName,
-            "types": Object.entries(implementedThemeTypes)
-                .filter(([, isImplemented]) => isImplemented)
-                .map(([themeType]) => themeType)
-        })
-    );
-
-    account_specific_extra_work: {
-        if (!implementedThemeTypes.account) {
-            break account_specific_extra_work;
-        }
-
-        await bringInAccountV1({ buildOptions });
-
-        parsedKeycloakThemeJson.themes.push({
-            "name": accountV1ThemeName,
-            "types": ["account"]
-        });
-
-        add_retrocompat_account_theme: {
-            if (!buildOptions.doBuildRetrocompatAccountTheme) {
-                break add_retrocompat_account_theme;
-            }
-
-            transformCodebase({
-                "srcDirPath": getThemeTypeDirPath({ "themeType": "account" }),
-                "destDirPath": getThemeTypeDirPath({ "themeType": "account", "isRetrocompat": true }),
-                "transformSourceCode": ({ filePath, sourceCode }) => {
-                    if (pathBasename(filePath) === "theme.properties") {
-                        return {
-                            "modifiedSourceCode": Buffer.from(
-                                sourceCode.toString("utf8").replace(`parent=${accountV1ThemeName}`, "parent=keycloak"),
-                                "utf8"
-                            )
-                        };
-                    }
-
-                    return { "modifiedSourceCode": sourceCode };
-                }
-            });
-
-            buildOptions.themeNames.forEach(themeName =>
-                parsedKeycloakThemeJson.themes.push({
-                    "name": `${themeName}${retrocompatPostfix}`,
-                    "types": ["account"]
-                })
-            );
-        }
     }
 
-    {
-        const keycloakThemeJsonFilePath = pathJoin(
-            buildOptions.keycloakifyBuildDirPath,
-            "src",
-            "main",
-            "resources",
-            "META-INF",
-            "keycloak-themes.json"
-        );
-
-        try {
-            fs.mkdirSync(pathDirname(keycloakThemeJsonFilePath));
-        } catch {}
-
-        fs.writeFileSync(keycloakThemeJsonFilePath, Buffer.from(JSON.stringify(parsedKeycloakThemeJson, null, 2), "utf8"));
-    }
+    return { doesImplementAccountTheme };
 }

package/src/bin/keycloakify/generateTheme/generateThemeVariants.ts

@@ -0,0 +1,50 @@
+import { join as pathJoin, extname as pathExtname, sep as pathSep } from "path";
+import { transformCodebase } from "../../tools/transformCodebase";
+import { assert } from "tsafe/assert";
+import * as fs from "fs";
+
+export function generateThemeVariations(params: { themeName: string; themeVariantName: string; srcMainResourcesDirPath: string }) {
+    const { themeName, themeVariantName, srcMainResourcesDirPath } = params;
+
+    const mainThemeDirPath = pathJoin(srcMainResourcesDirPath, "theme", themeName);
+
+    transformCodebase({
+        "srcDirPath": mainThemeDirPath,
+        "destDirPath": pathJoin(mainThemeDirPath, themeVariantName),
+        "transformSourceCode": ({ fileRelativePath, sourceCode }) => {
+            if (pathExtname(fileRelativePath) === ".ftl" && fileRelativePath.split(pathSep).length === 2) {
+                const modifiedSourceCode = Buffer.from(
+                    Buffer.from(sourceCode)
+                        .toString("utf-8")
+                        .replace(`out["themeName"] = "${themeName}";`, `out["themeName"] = "${themeVariantName}";`),
+                    "utf8"
+                );
+
+                assert(Buffer.compare(modifiedSourceCode, sourceCode) !== 0);
+
+                return { modifiedSourceCode };
+            }
+
+            return { "modifiedSourceCode": sourceCode };
+        }
+    });
+
+    {
+        const keycloakThemeJsonFilePath = pathJoin(srcMainResourcesDirPath, "META-INF", "keycloak-themes.json");
+
+        const modifiedParsedJson = JSON.parse(fs.readFileSync(keycloakThemeJsonFilePath).toString("utf8")) as {
+            themes: { name: string; types: string[] }[];
+        };
+
+        modifiedParsedJson.themes.push({
+            "name": themeVariantName,
+            "types": (() => {
+                const theme = modifiedParsedJson.themes.find(({ name }) => name === themeName);
+                assert(theme !== undefined);
+                return theme.types;
+            })()
+        });
+
+        fs.writeFileSync(keycloakThemeJsonFilePath, Buffer.from(JSON.stringify(modifiedParsedJson, null, 2), "utf8"));
+    }
+}

package/src/bin/keycloakify/generateTheme/readFieldNameUsage.ts

@@ -1,5 +1,4 @@
 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 "../../constants";
@@ -8,7 +7,7 @@ import type { ThemeType } from "../../constants";
 export function readFieldNameUsage(params: { keycloakifySrcDirPath: string; themeSrcDirPath: string; themeType: ThemeType }): string[] {
     const { keycloakifySrcDirPath, themeSrcDirPath, themeType } = params;
 
-    const fieldNames: string[] = [];
+    const fieldNames = new Set<string>();
 
     for (const srcDirPath of [pathJoin(keycloakifySrcDirPath, themeType), pathJoin(themeSrcDirPath, themeType)]) {
         const filePaths = crawl({ "dirPath": srcDirPath, "returnedPathsType": "absolute" }).filter(filePath => /\.(ts|tsx|js|jsx)$/.test(filePath));
@@ -20,13 +19,39 @@ export function readFieldNameUsage(params: { keycloakifySrcDirPath: string; them
                 continue;
             }
 
-            fieldNames.push(
-                ...Array.from(rawSourceFile.matchAll(/(?:(?:printIfExists)|(?:existsError)|(?:get)|(?:exists))\(\s*["']([^"']+)["']/g), m => m[1])
-            );
+            for (const functionName of ["printIfExists", "existsError", "get", "exists", "getFirstError"] as const) {
+                if (!rawSourceFile.includes(functionName)) {
+                    continue;
+                }
+
+                try {
+                    rawSourceFile
+                        .split(functionName)
+                        .filter(part => part.startsWith("("))
+                        .map(part => {
+                            let [p1] = part.split(")");
+
+                            p1 = p1.slice(1);
+
+                            return p1;
+                        })
+                        .map(part => {
+                            console.log(part);
+
+                            return part
+                                .split(",")
+                                .map(a => a.trim())
+                                .filter((...[, i]) => (functionName !== "printIfExists" ? true : i === 0))
+                                .filter(a => a.startsWith('"') || a.startsWith("'") || a.startsWith("`"))
+                                .filter(a => a.endsWith('"') || a.endsWith("'") || a.endsWith("`"))
+                                .map(a => a.slice(1).slice(0, -1));
+                        })
+                        .flat()
+                        .forEach(fieldName => fieldNames.add(fieldName));
+                } catch {}
+            }
         }
     }
 
-    const out = fieldNames.reduce(...removeDuplicates<string>());
-
-    return out;
+    return Array.from(fieldNames);
 }

package/src/bin/keycloakify/keycloakify.ts

@@ -1,6 +1,5 @@
 import { generateTheme } from "./generateTheme";
-import { generatePom } from "./generatePom";
-import { join as pathJoin, relative as pathRelative, basename as pathBasename, dirname as pathDirname, sep as pathSep } from "path";
+import { join as pathJoin, relative as pathRelative, sep as pathSep } from "path";
 import * as child_process from "child_process";
 import { generateStartKeycloakTestingContainer } from "./generateStartKeycloakTestingContainer";
 import * as fs from "fs";
@@ -10,6 +9,7 @@ import { getThemeSrcDirPath } from "../getThemeSrcDirPath";
 import { getThisCodebaseRootDirPath } from "../tools/getThisCodebaseRootDirPath";
 import { readThisNpmProjectVersion } from "../tools/readThisNpmProjectVersion";
 import { keycloakifyBuildOptionsForPostPostBuildScriptEnvName } from "../constants";
+import { buildJars } from "./buildJars";
 
 export async function main() {
     const buildOptions = readBuildOptions({
@@ -21,34 +21,21 @@ export async function main() {
 
     const { themeSrcDirPath } = getThemeSrcDirPath({ "reactAppRootDirPath": buildOptions.reactAppRootDirPath });
 
-    for (const themeName of buildOptions.themeNames) {
-        await generateTheme({
-            themeName,
-            themeSrcDirPath,
-            "keycloakifySrcDirPath": pathJoin(getThisCodebaseRootDirPath(), "src"),
-            "keycloakifyVersion": readThisNpmProjectVersion(),
-            buildOptions
-        });
-    }
-
     {
-        const { pomFileCode } = generatePom({ buildOptions });
+        if (!fs.existsSync(buildOptions.keycloakifyBuildDirPath)) {
+            fs.mkdirSync(buildOptions.keycloakifyBuildDirPath, { "recursive": true });
+        }
 
-        fs.writeFileSync(pathJoin(buildOptions.keycloakifyBuildDirPath, "pom.xml"), Buffer.from(pomFileCode, "utf8"));
+        fs.writeFileSync(pathJoin(buildOptions.keycloakifyBuildDirPath, ".gitignore"), Buffer.from("*", "utf8"));
     }
 
-    const containerKeycloakVersion = "23.0.6";
-
-    const jarFilePath = pathJoin(buildOptions.keycloakifyBuildDirPath, "target", `${buildOptions.artifactId}-${buildOptions.themeVersion}.jar`);
-
-    generateStartKeycloakTestingContainer({
-        "keycloakVersion": containerKeycloakVersion,
-        jarFilePath,
+    const { doesImplementAccountTheme } = await generateTheme({
+        themeSrcDirPath,
+        "keycloakifySrcDirPath": pathJoin(getThisCodebaseRootDirPath(), "src"),
+        "keycloakifyVersion": readThisNpmProjectVersion(),
         buildOptions
     });
 
-    fs.writeFileSync(pathJoin(buildOptions.keycloakifyBuildDirPath, ".gitignore"), Buffer.from("*", "utf8"));
-
     run_post_build_script: {
         if (buildOptions.bundler !== "vite") {
             break run_post_build_script;
@@ -63,44 +50,24 @@ export async function main() {
         });
     }
 
-    create_jar: {
-        if (!buildOptions.doCreateJar) {
-            break create_jar;
-        }
-
-        child_process.execSync("mvn clean install", { "cwd": buildOptions.keycloakifyBuildDirPath });
-
-        const jarDirPath = pathDirname(jarFilePath);
-        const retrocompatJarFilePath = pathJoin(jarDirPath, "retrocompat-" + pathBasename(jarFilePath));
-
-        fs.renameSync(pathJoin(jarDirPath, "original-" + pathBasename(jarFilePath)), retrocompatJarFilePath);
+    const { lastJarFileBasename } = await buildJars({
+        doesImplementAccountTheme,
+        buildOptions
+    });
 
-        fs.writeFileSync(
-            pathJoin(jarDirPath, "README.md"),
-            Buffer.from(
-                [
-                    `- The ${jarFilePath} is to be used in Keycloak 23 and up.  `,
-                    `- The ${retrocompatJarFilePath} is to be used in Keycloak 22 and below.`,
-                    `  Note that Keycloak 22 is only supported for login and email theme but not for account themes.  `
-                ].join("\n"),
-                "utf8"
-            )
-        );
-    }
+    generateStartKeycloakTestingContainer({
+        "jarFilePath": pathJoin(buildOptions.keycloakifyBuildDirPath, lastJarFileBasename),
+        buildOptions
+    });
 
     logger.log(
         [
+            `✅ Your keycloak theme has been generated and bundled into .${pathSep}${pathJoin(
+                pathRelative(buildOptions.reactAppRootDirPath, buildOptions.keycloakifyBuildDirPath),
+                "keycloak-theme-for-kc-*.jar"
+            )}`,
             "",
-            ...(!buildOptions.doCreateJar
-                ? []
-                : [
-                      `✅ Your keycloak theme has been generated and bundled into .${pathSep}${pathRelative(
-                          buildOptions.reactAppRootDirPath,
-                          jarFilePath
-                      )} 🚀`
-                  ]),
-            "",
-            `To test your theme locally you can spin up a Keycloak ${containerKeycloakVersion} container image with the theme pre loaded by running:`,
+            `To test your theme locally you can spin up a Keycloak container image with the theme pre loaded by running:`,
             "",
             `👉 $ .${pathSep}${pathRelative(
                 buildOptions.reactAppRootDirPath,

package/src/lib/useGetClassName.ts

@@ -5,10 +5,10 @@ export function createUseClassName<ClassKey extends string>(params: { defaultCla
     const { defaultClasses } = params;
 
     function useGetClassName(params: { doUseDefaultCss: boolean; classes: Partial<Record<ClassKey, string>> | undefined }) {
-        const { classes } = params;
+        const { classes, doUseDefaultCss } = params;
 
         const getClassName = useConstCallback((classKey: ClassKey): string => {
-            return clsx(classKey, defaultClasses[classKey], classes?.[classKey]);
+            return clsx(classKey, doUseDefaultCss ? defaultClasses[classKey] : undefined, classes?.[classKey]);
         });
 
         return { getClassName };