keycloakify 10.0.0-rc.64 → 10.0.0-rc.66

package/src/bin/shared/downloadKeycloakDefaultTheme.ts

@@ -3,7 +3,6 @@ import { type BuildContext } from "./buildContext";
 import { assert } from "tsafe/assert";
 import { lastKeycloakVersionWithAccountV1 } from "./constants";
 import { downloadAndExtractArchive } from "../tools/downloadAndExtractArchive";
-import { isInside } from "../tools/isInside";
 
 export type BuildContextLike = {
     cacheDirPath: string;
@@ -18,27 +17,25 @@ export async function downloadKeycloakDefaultTheme(params: {
 }): Promise<{ defaultThemeDirPath: string }> {
     const { keycloakVersion, buildContext } = params;
 
+    let kcNodeModulesKeepFilePaths: string[] | undefined = undefined;
+    let kcNodeModulesKeepFilePaths_lastAccountV1: string[] | undefined = undefined;
+
     const { extractedDirPath } = await downloadAndExtractArchive({
         url: `https://repo1.maven.org/maven2/org/keycloak/keycloak-themes/${keycloakVersion}/keycloak-themes-${keycloakVersion}.jar`,
         cacheDirPath: buildContext.cacheDirPath,
         npmWorkspaceRootDirPath: buildContext.npmWorkspaceRootDirPath,
         uniqueIdOfOnOnArchiveFile: "downloadKeycloakDefaultTheme",
         onArchiveFile: async params => {
-            if (!isInside({ dirPath: "theme", filePath: params.fileRelativePath })) {
+            const fileRelativePath = pathRelative("theme", params.fileRelativePath);
+
+            if (fileRelativePath.startsWith("..")) {
                 return;
             }
 
             const { readFile, writeFile } = params;
 
-            const fileRelativePath = pathRelative("theme", params.fileRelativePath);
-
             skip_keycloak_v2: {
-                if (
-                    !isInside({
-                        dirPath: pathJoin("keycloak.v2"),
-                        filePath: fileRelativePath
-                    })
-                ) {
+                if (!fileRelativePath.startsWith(pathJoin("keycloak.v2"))) {
                     break skip_keycloak_v2;
                 }
 
@@ -50,87 +47,102 @@ export async function downloadKeycloakDefaultTheme(params: {
                     break last_account_v1_transformations;
                 }
 
-                patch_account_css: {
+                skip_web_modules: {
                     if (
-                        fileRelativePath !==
-                        pathJoin("keycloak", "account", "resources", "css", "account.css")
+                        !fileRelativePath.startsWith(
+                            pathJoin("keycloak", "common", "resources", "web_modules")
+                        )
                     ) {
-                        break patch_account_css;
+                        break skip_web_modules;
                     }
 
-                    await writeFile({
-                        fileRelativePath,
-                        modifiedData: Buffer.from(
-                            (await readFile())
-                                .toString("utf8")
-                                .replace("top: -34px;", "top: -34px !important;"),
-                            "utf8"
-                        )
-                    });
-
                     return;
                 }
 
-                skip_web_modules: {
+                skip_lib: {
                     if (
-                        !isInside({
-                            dirPath: pathJoin(
-                                "keycloak",
-                                "common",
-                                "resources",
-                                "web_modules"
-                            ),
-                            filePath: fileRelativePath
-                        })
+                        !fileRelativePath.startsWith(
+                            pathJoin("keycloak", "common", "resources", "lib")
+                        )
                     ) {
-                        break skip_web_modules;
+                        break skip_lib;
                     }
 
                     return;
                 }
 
-                skip_unused_node_modules: {
-                    const nodeModulesDirPath = pathJoin(
-                        "keycloak",
-                        "common",
-                        "resources",
-                        "node_modules"
-                    );
-
+                skip_node_modules: {
                     if (
-                        !isInside({
-                            dirPath: nodeModulesDirPath,
-                            filePath: fileRelativePath
-                        })
+                        !fileRelativePath.startsWith(
+                            pathJoin("keycloak", "common", "resources", "node_modules")
+                        )
                     ) {
-                        break skip_unused_node_modules;
+                        break skip_node_modules;
                     }
 
-                    const toKeepPrefixes = [
-                        ...[
-                            "patternfly.min.css",
-                            "patternfly-additions.min.css",
-                            "patternfly-additions.min.css"
-                        ].map(fileBasename =>
+                    if (kcNodeModulesKeepFilePaths_lastAccountV1 === undefined) {
+                        kcNodeModulesKeepFilePaths_lastAccountV1 = [
+                            pathJoin("patternfly", "dist", "css", "patternfly.min.css"),
                             pathJoin(
-                                nodeModulesDirPath,
                                 "patternfly",
                                 "dist",
                                 "css",
-                                fileBasename
+                                "patternfly-additions.min.css"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "OpenSans-Regular-webfont.woff2"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "OpenSans-Bold-webfont.woff2"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "OpenSans-Light-webfont.woff2"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "OpenSans-Semibold-webfont.woff2"
                             )
-                        ),
-                        pathJoin(nodeModulesDirPath, "patternfly", "dist", "fonts")
-                    ];
+                        ];
+                    }
+
+                    for (const keepPath of kcNodeModulesKeepFilePaths_lastAccountV1) {
+                        if (fileRelativePath.endsWith(keepPath)) {
+                            break skip_node_modules;
+                        }
+                    }
+
+                    return;
+                }
 
+                patch_account_css: {
                     if (
-                        toKeepPrefixes.find(prefix =>
-                            fileRelativePath.startsWith(prefix)
-                        ) !== undefined
+                        fileRelativePath !==
+                        pathJoin("keycloak", "account", "resources", "css", "account.css")
                     ) {
-                        break skip_unused_node_modules;
+                        break patch_account_css;
                     }
 
+                    await writeFile({
+                        fileRelativePath,
+                        modifiedData: Buffer.from(
+                            (await readFile())
+                                .toString("utf8")
+                                .replace("top: -34px;", "top: -34px !important;"),
+                            "utf8"
+                        )
+                    });
+
                     return;
                 }
             }
@@ -140,61 +152,76 @@ export async function downloadKeycloakDefaultTheme(params: {
                     break skip_unused_resources;
                 }
 
-                for (const dirBasename of [
-                    "@patternfly-v5",
-                    "@rollup",
-                    "rollup",
-                    "react",
-                    "react-dom",
-                    "shx",
-                    ".pnpm"
-                ]) {
+                skip_node_modules: {
                     if (
-                        isInside({
-                            dirPath: pathJoin(
-                                "keycloak",
-                                "common",
-                                "resources",
-                                "node_modules",
-                                dirBasename
-                            ),
-                            filePath: fileRelativePath
-                        })
+                        !fileRelativePath.startsWith(
+                            pathJoin("keycloak", "common", "resources", "node_modules")
+                        )
                     ) {
-                        return;
+                        break skip_node_modules;
                     }
+
+                    if (kcNodeModulesKeepFilePaths === undefined) {
+                        kcNodeModulesKeepFilePaths = [
+                            pathJoin("@patternfly", "patternfly", "patternfly.min.css"),
+                            pathJoin("patternfly", "dist", "css", "patternfly.min.css"),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "css",
+                                "patternfly-additions.min.css"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "OpenSans-Regular-webfont.woff2"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "OpenSans-Light-webfont.woff2"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "fontawesome-webfont.woff2"
+                            ),
+                            pathJoin("jquery", "dist", "jquery.min.js")
+                        ];
+                    }
+
+                    for (const keepPath of kcNodeModulesKeepFilePaths) {
+                        if (fileRelativePath.endsWith(keepPath)) {
+                            break skip_node_modules;
+                        }
+                    }
+
+                    return;
                 }
 
-                for (const dirBasename of ["react", "react-dom"]) {
+                skip_vendor: {
                     if (
-                        isInside({
-                            dirPath: pathJoin(
-                                "keycloak",
-                                "common",
-                                "resources",
-                                "vendor",
-                                dirBasename
-                            ),
-                            filePath: fileRelativePath
-                        })
+                        !fileRelativePath.startsWith(
+                            pathJoin("keycloak", "common", "resources", "vendor")
+                        )
                     ) {
-                        return;
+                        break skip_vendor;
                     }
+
+                    return;
                 }
 
-                if (
-                    isInside({
-                        dirPath: pathJoin(
-                            "keycloak",
-                            "common",
-                            "resources",
-                            "node_modules",
-                            "@patternfly",
-                            "react-core"
-                        ),
-                        filePath: fileRelativePath
-                    })
-                ) {
+                skip_rollup_config: {
+                    if (
+                        fileRelativePath !==
+                        pathJoin("keycloak", "common", "resources", "rollup.config.js")
+                    ) {
+                        break skip_rollup_config;
+                    }
+
                     return;
                 }
             }

package/src/bin/shared/generateKcGenTs.ts

@@ -1,6 +1,5 @@
 import { assert } from "tsafe/assert";
 import type { BuildContext } from "./buildContext";
-import { getThemeSrcDirPath } from "./getThemeSrcDirPath";
 import * as fs from "fs/promises";
 import { join as pathJoin } from "path";
 import { existsAsync } from "../tools/fs.existsAsync";
@@ -9,6 +8,7 @@ export type BuildContextLike = {
     projectDirPath: string;
     themeNames: string[];
     environmentVariables: { name: string; default: string }[];
+    themeSrcDirPath: string;
 };
 
 assert<BuildContext extends BuildContextLike ? true : false>();
@@ -18,11 +18,7 @@ export async function generateKcGenTs(params: {
 }): Promise<void> {
     const { buildContext } = params;
 
-    const { themeSrcDirPath } = getThemeSrcDirPath({
-        projectDirPath: buildContext.projectDirPath
-    });
-
-    const filePath = pathJoin(themeSrcDirPath, "kc.gen.ts");
+    const filePath = pathJoin(buildContext.themeSrcDirPath, "kc.gen.ts");
 
     const currentContent = (await existsAsync(filePath))
         ? await fs.readFile(filePath)

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

@@ -1,4 +1,4 @@
-import { onlyBuildJarFileBasenameEnvName } from "../shared/constants";
+import { buildForKeycloakMajorVersionEnvName } from "../shared/constants";
 import * as child_process from "child_process";
 import { Deferred } from "evt/tools/Deferred";
 import { assert } from "tsafe/assert";
@@ -14,10 +14,10 @@ export type BuildContextLike = {
 assert<BuildContext extends BuildContextLike ? true : false>();
 
 export async function keycloakifyBuild(params: {
-    onlyBuildJarFileBasename: string;
+    buildForKeycloakMajorVersionNumber: number;
     buildContext: BuildContextLike;
 }): Promise<{ isKeycloakifyBuildSuccess: boolean }> {
-    const { buildContext, onlyBuildJarFileBasename } = params;
+    const { buildForKeycloakMajorVersionNumber, buildContext } = params;
 
     const dResult = new Deferred<{ isSuccess: boolean }>();
 
@@ -25,7 +25,7 @@ export async function keycloakifyBuild(params: {
         cwd: buildContext.projectDirPath,
         env: {
             ...process.env,
-            [onlyBuildJarFileBasenameEnvName]: onlyBuildJarFileBasename
+            [buildForKeycloakMajorVersionEnvName]: `${buildForKeycloakMajorVersionNumber}`
         },
         shell: true
     });

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

@@ -2,12 +2,9 @@ import { getBuildContext } from "../shared/buildContext";
 import { exclude } from "tsafe/exclude";
 import type { CliCommandOptions as CliCommandOptions_common } from "../main";
 import { promptKeycloakVersion } from "../shared/promptKeycloakVersion";
-import { getImplementedThemeTypes } from "../shared/getImplementedThemeTypes";
 import { accountV1ThemeName, containerName } from "../shared/constants";
 import { SemVer } from "../tools/SemVer";
-import type { KeycloakVersionRange } from "../shared/KeycloakVersionRange";
-import { getJarFileBasename } from "../shared/getJarFileBasename";
-import { assert, type Equals } from "tsafe/assert";
+import { assert } from "tsafe/assert";
 import * as fs from "fs";
 import {
     join as pathJoin,
@@ -91,83 +88,30 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
 
     const buildContext = getBuildContext({ cliCommandOptions });
 
-    const { keycloakVersion, keycloakMajorNumber: keycloakMajorVersionNumber } =
-        await (async () => {
-            if (cliCommandOptions.keycloakVersion !== undefined) {
-                return {
-                    keycloakVersion: cliCommandOptions.keycloakVersion,
-                    keycloakMajorNumber: SemVer.parse(cliCommandOptions.keycloakVersion)
-                        .major
-                };
-            }
-
-            console.log(
-                chalk.cyan("On which version of Keycloak do you want to test your theme?")
-            );
-
-            const { keycloakVersion } = await promptKeycloakVersion({
-                startingFromMajor: 18,
-                excludeMajorVersions: [22],
-                cacheDirPath: buildContext.cacheDirPath
-            });
-
-            console.log(`→ ${keycloakVersion}`);
-
-            const keycloakMajorNumber = SemVer.parse(keycloakVersion).major;
-
-            return { keycloakVersion, keycloakMajorNumber };
-        })();
-
-    const keycloakVersionRange: KeycloakVersionRange = (() => {
-        const doesImplementAccountTheme = getImplementedThemeTypes({
-            projectDirPath: buildContext.projectDirPath
-        }).implementedThemeTypes.account;
-
-        if (doesImplementAccountTheme) {
-            const keycloakVersionRange = (() => {
-                if (keycloakMajorVersionNumber <= 21) {
-                    return "21-and-below" as const;
-                }
-
-                assert(keycloakMajorVersionNumber !== 22);
-
-                if (keycloakMajorVersionNumber === 23) {
-                    return "23" as const;
-                }
-
-                if (keycloakMajorVersionNumber === 24) {
-                    return "24" as const;
-                }
-
-                return "25-and-above" as const;
-            })();
-
-            assert<
-                Equals<typeof keycloakVersionRange, KeycloakVersionRange.WithAccountTheme>
-            >();
+    const { keycloakVersion } = await (async () => {
+        if (cliCommandOptions.keycloakVersion !== undefined) {
+            return {
+                keycloakVersion: cliCommandOptions.keycloakVersion,
+                keycloakMajorNumber: SemVer.parse(cliCommandOptions.keycloakVersion).major
+            };
+        }
 
-            return keycloakVersionRange;
-        } else {
-            const keycloakVersionRange = (() => {
-                if (keycloakMajorVersionNumber <= 21) {
-                    return "21-and-below" as const;
-                }
+        console.log(
+            chalk.cyan("On which version of Keycloak do you want to test your theme?")
+        );
 
-                return "22-and-above" as const;
-            })();
+        const { keycloakVersion } = await promptKeycloakVersion({
+            startingFromMajor: 18,
+            excludeMajorVersions: [22],
+            cacheDirPath: buildContext.cacheDirPath
+        });
 
-            assert<
-                Equals<
-                    typeof keycloakVersionRange,
-                    KeycloakVersionRange.WithoutAccountTheme
-                >
-            >();
+        console.log(`→ ${keycloakVersion}`);
 
-            return keycloakVersionRange;
-        }
+        return { keycloakVersion };
     })();
 
-    const { jarFileBasename } = getJarFileBasename({ keycloakVersionRange });
+    const keycloakMajorVersionNumber = SemVer.parse(keycloakVersion).major;
 
     {
         const { isAppBuildSuccess } = await appBuild({
@@ -177,28 +121,36 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
         if (!isAppBuildSuccess) {
             console.log(
                 chalk.red(
-                    `App build failed, exiting. Try running 'npm run build-keycloak-theme' and see what's wrong.`
+                    `App build failed, exiting. Try running 'npm run build' and see what's wrong.`
                 )
             );
             process.exit(1);
         }
 
         const { isKeycloakifyBuildSuccess } = await keycloakifyBuild({
-            onlyBuildJarFileBasename: jarFileBasename,
+            buildForKeycloakMajorVersionNumber: keycloakMajorVersionNumber,
             buildContext
         });
 
         if (!isKeycloakifyBuildSuccess) {
             console.log(
                 chalk.red(
-                    `Keycloakify build failed, exiting. Try running 'npm run build-keycloak-theme' and see what's wrong.`
+                    `Keycloakify build failed, exiting. Try running 'npx keycloakify build' and see what's wrong.`
                 )
             );
             process.exit(1);
         }
     }
 
-    console.log(`Using Keycloak ${chalk.bold(jarFileBasename)}`);
+    const jarFilePath = fs
+        .readdirSync(buildContext.keycloakifyBuildDirPath)
+        .filter(fileBasename => fileBasename.endsWith(".jar"))
+        .map(fileBasename => pathJoin(buildContext.keycloakifyBuildDirPath, fileBasename))
+        .sort((a, b) => fs.statSync(b).mtimeMs - fs.statSync(a).mtimeMs)[0];
+
+    assert(jarFilePath !== undefined);
+
+    console.log(`Using ${chalk.bold(pathBasename(jarFilePath))}`);
 
     const realmJsonFilePath = await (async () => {
         if (cliCommandOptions.realmJsonFilePath !== undefined) {
@@ -284,8 +236,6 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
         return filePath;
     })();
 
-    const jarFilePath = pathJoin(buildContext.keycloakifyBuildDirPath, jarFileBasename);
-
     async function extractThemeResourcesFromJar() {
         await extractArchive({
             archiveFilePath: jarFilePath,
@@ -311,7 +261,10 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
 
     await extractThemeResourcesFromJar();
 
-    const jarFilePath_cacheDir = pathJoin(buildContext.cacheDirPath, jarFileBasename);
+    const jarFilePath_cacheDir = pathJoin(
+        buildContext.cacheDirPath,
+        pathBasename(jarFilePath)
+    );
 
     fs.copyFileSync(jarFilePath, jarFilePath_cacheDir);
 
@@ -413,6 +366,10 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
 
             console.log(
                 [
+                    "",
+                    `The ftl files from ${chalk.bold(
+                        `.${pathSep}${pathRelative(process.cwd(), pathJoin(buildContext.keycloakifyBuildDirPath, "theme"))}`
+                    )} are mounted in the Keycloak container.`,
                     "",
                     `Keycloak Admin console: ${chalk.cyan.bold(
                         `http://localhost:${cliCommandOptions.port}`
@@ -453,7 +410,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
             }
 
             const { isKeycloakifyBuildSuccess } = await keycloakifyBuild({
-                onlyBuildJarFileBasename: jarFileBasename,
+                buildForKeycloakMajorVersionNumber: keycloakMajorVersionNumber,
                 buildContext
             });
 

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

@@ -44,11 +44,12 @@ export function keycloakify(params?: Params) {
                     break run_post_build_script_case;
                 }
 
-                const buildContext = JSON.parse(envValue) as BuildContext;
+                const { buildContext, resourcesDirPath } = JSON.parse(envValue) as {
+                    buildContext: BuildContext;
+                    resourcesDirPath: string;
+                };
 
-                process.chdir(
-                    pathJoin(buildContext.keycloakifyBuildDirPath, "resources")
-                );
+                process.chdir(resourcesDirPath);
 
                 await postBuild?.(buildContext);