keycloakify 10.0.0-rc.5 → 10.0.0-rc.50

package/src/bin/shared/downloadKeycloakDefaultTheme.ts

@@ -0,0 +1,207 @@
+import { join as pathJoin, relative as pathRelative } from "path";
+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;
+    npmWorkspaceRootDirPath: string;
+};
+
+assert<BuildContext extends BuildContextLike ? true : false>();
+
+export async function downloadKeycloakDefaultTheme(params: {
+    keycloakVersion: string;
+    buildContext: BuildContextLike;
+}): Promise<{ defaultThemeDirPath: string }> {
+    const { keycloakVersion, buildContext } = params;
+
+    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 })) {
+                return;
+            }
+
+            const { readFile, writeFile } = params;
+
+            const fileRelativePath = pathRelative("theme", params.fileRelativePath);
+
+            skip_keycloak_v2: {
+                if (
+                    !isInside({
+                        dirPath: pathJoin("keycloak.v2"),
+                        filePath: fileRelativePath
+                    })
+                ) {
+                    break skip_keycloak_v2;
+                }
+
+                return;
+            }
+
+            last_account_v1_transformations: {
+                if (lastKeycloakVersionWithAccountV1 !== keycloakVersion) {
+                    break last_account_v1_transformations;
+                }
+
+                patch_account_css: {
+                    if (
+                        fileRelativePath !==
+                        pathJoin("keycloak", "account", "resources", "css", "account.css")
+                    ) {
+                        break patch_account_css;
+                    }
+
+                    await writeFile({
+                        fileRelativePath,
+                        modifiedData: Buffer.from(
+                            (await readFile())
+                                .toString("utf8")
+                                .replace("top: -34px;", "top: -34px !important;"),
+                            "utf8"
+                        )
+                    });
+
+                    return;
+                }
+
+                skip_web_modules: {
+                    if (
+                        !isInside({
+                            dirPath: pathJoin(
+                                "keycloak",
+                                "common",
+                                "resources",
+                                "web_modules"
+                            ),
+                            filePath: fileRelativePath
+                        })
+                    ) {
+                        break skip_web_modules;
+                    }
+
+                    return;
+                }
+
+                skip_unused_node_modules: {
+                    const nodeModulesDirPath = pathJoin(
+                        "keycloak",
+                        "common",
+                        "resources",
+                        "node_modules"
+                    );
+
+                    if (
+                        !isInside({
+                            dirPath: nodeModulesDirPath,
+                            filePath: fileRelativePath
+                        })
+                    ) {
+                        break skip_unused_node_modules;
+                    }
+
+                    const toKeepPrefixes = [
+                        ...[
+                            "patternfly.min.css",
+                            "patternfly-additions.min.css",
+                            "patternfly-additions.min.css"
+                        ].map(fileBasename =>
+                            pathJoin(
+                                nodeModulesDirPath,
+                                "patternfly",
+                                "dist",
+                                "css",
+                                fileBasename
+                            )
+                        ),
+                        pathJoin(nodeModulesDirPath, "patternfly", "dist", "fonts")
+                    ];
+
+                    if (
+                        toKeepPrefixes.find(prefix =>
+                            fileRelativePath.startsWith(prefix)
+                        ) !== undefined
+                    ) {
+                        break skip_unused_node_modules;
+                    }
+
+                    return;
+                }
+            }
+
+            skip_unused_resources: {
+                if (keycloakVersion !== "24.0.4") {
+                    break skip_unused_resources;
+                }
+
+                for (const dirBasename of [
+                    "@patternfly-v5",
+                    "@rollup",
+                    "rollup",
+                    "react",
+                    "react-dom",
+                    "shx",
+                    ".pnpm"
+                ]) {
+                    if (
+                        isInside({
+                            dirPath: pathJoin(
+                                "keycloak",
+                                "common",
+                                "resources",
+                                "node_modules",
+                                dirBasename
+                            ),
+                            filePath: fileRelativePath
+                        })
+                    ) {
+                        return;
+                    }
+                }
+
+                for (const dirBasename of ["react", "react-dom"]) {
+                    if (
+                        isInside({
+                            dirPath: pathJoin(
+                                "keycloak",
+                                "common",
+                                "resources",
+                                "vendor",
+                                dirBasename
+                            ),
+                            filePath: fileRelativePath
+                        })
+                    ) {
+                        return;
+                    }
+                }
+
+                if (
+                    isInside({
+                        dirPath: pathJoin(
+                            "keycloak",
+                            "common",
+                            "resources",
+                            "node_modules",
+                            "@patternfly",
+                            "react-core"
+                        ),
+                        filePath: fileRelativePath
+                    })
+                ) {
+                    return;
+                }
+            }
+
+            await writeFile({ fileRelativePath });
+        }
+    });
+
+    return { defaultThemeDirPath: extractedDirPath };
+}

package/src/bin/shared/downloadKeycloakStaticResources.ts

@@ -1,49 +1,53 @@
 import { transformCodebase } from "../tools/transformCodebase";
 import { join as pathJoin } from "path";
-import { downloadBuiltinKeycloakTheme } from "./downloadBuiltinKeycloakTheme";
+import {
+    downloadKeycloakDefaultTheme,
+    type BuildContextLike as BuildContextLike_downloadKeycloakDefaultTheme
+} from "./downloadKeycloakDefaultTheme";
 import { resources_common, type ThemeType } from "./constants";
-import type { BuildOptions } from "./buildOptions";
+import type { BuildContext } from "./buildContext";
 import { assert } from "tsafe/assert";
-import * as crypto from "crypto";
-import { rmSync } from "../tools/fs.rmSync";
+import { existsAsync } from "../tools/fs.existsAsync";
 
-export type BuildOptionsLike = {
-    cacheDirPath: string;
-    npmWorkspaceRootDirPath: string;
-};
+export type BuildContextLike = BuildContextLike_downloadKeycloakDefaultTheme & {};
 
-assert<BuildOptions extends BuildOptionsLike ? true : false>();
+assert<BuildContext extends BuildContextLike ? true : false>();
 
 export async function downloadKeycloakStaticResources(params: {
     themeType: ThemeType;
     themeDirPath: string;
     keycloakVersion: string;
-    buildOptions: BuildOptionsLike;
+    buildContext: BuildContextLike;
 }) {
-    const { themeType, themeDirPath, keycloakVersion, buildOptions } = params;
+    const { themeType, themeDirPath, keycloakVersion, buildContext } = params;
 
-    const tmpDirPath = pathJoin(
-        buildOptions.cacheDirPath,
-        `downloadKeycloakStaticResources_tmp_${crypto.createHash("sha256").update(`${themeType}-${keycloakVersion}`).digest("hex").slice(0, 8)}`
-    );
-
-    await downloadBuiltinKeycloakTheme({
+    const { defaultThemeDirPath } = await downloadKeycloakDefaultTheme({
         keycloakVersion,
-        "destDirPath": tmpDirPath,
-        buildOptions
+        buildContext
     });
 
-    const resourcesPath = pathJoin(themeDirPath, themeType, "resources");
+    const resourcesDirPath = pathJoin(themeDirPath, themeType, "resources");
+
+    repatriate_base_resources: {
+        const srcDirPath = pathJoin(defaultThemeDirPath, "base", themeType, "resources");
+
+        if (!(await existsAsync(srcDirPath))) {
+            break repatriate_base_resources;
+        }
+
+        transformCodebase({
+            srcDirPath,
+            destDirPath: resourcesDirPath
+        });
+    }
 
     transformCodebase({
-        "srcDirPath": pathJoin(tmpDirPath, "keycloak", themeType, "resources"),
-        "destDirPath": resourcesPath
+        srcDirPath: pathJoin(defaultThemeDirPath, "keycloak", themeType, "resources"),
+        destDirPath: resourcesDirPath
     });
 
     transformCodebase({
-        "srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
-        "destDirPath": pathJoin(resourcesPath, resources_common)
+        srcDirPath: pathJoin(defaultThemeDirPath, "keycloak", "common", "resources"),
+        destDirPath: pathJoin(resourcesDirPath, resources_common)
     });
-
-    rmSync(tmpDirPath, { "recursive": true });
 }

package/src/bin/shared/generateKcGenTs.ts

@@ -0,0 +1,72 @@
+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";
+
+export type BuildContextLike = {
+    projectDirPath: string;
+    themeNames: string[];
+    environmentVariables: { name: string; default: string }[];
+};
+
+assert<BuildContext extends BuildContextLike ? true : false>();
+
+export async function generateKcGenTs(params: {
+    buildContext: BuildContextLike;
+}): Promise<void> {
+    const { buildContext } = params;
+
+    const { themeSrcDirPath } = getThemeSrcDirPath({
+        projectDirPath: buildContext.projectDirPath
+    });
+
+    const filePath = pathJoin(themeSrcDirPath, "kc.gen.ts");
+
+    const currentContent = (await existsAsync(filePath))
+        ? await fs.readFile(filePath)
+        : undefined;
+
+    const newContent = Buffer.from(
+        [
+            `/* prettier-ignore-start */`,
+            ``,
+            `/* eslint-disable */`,
+            ``,
+            `// @ts-nocheck`,
+            ``,
+            `// noinspection JSUnusedGlobalSymbols`,
+            ``,
+            `// This file is auto-generated by Keycloakify`,
+            ``,
+            `export type ThemeName = ${buildContext.themeNames.map(themeName => `"${themeName}"`).join(" | ")};`,
+            ``,
+            `export const themeNames: ThemeName[] = [${buildContext.themeNames.map(themeName => `"${themeName}"`).join(", ")}];`,
+            ``,
+            `export type KcEnvName = ${buildContext.environmentVariables.length === 0 ? "never" : buildContext.environmentVariables.map(({ name }) => `"${name}"`).join(" | ")};`,
+            ``,
+            `export const KcEnvNames: KcEnvName[] = [${buildContext.environmentVariables.map(({ name }) => `"${name}"`).join(", ")}];`,
+            ``,
+            `export const kcEnvDefaults: Record<KcEnvName, string> = ${JSON.stringify(
+                Object.fromEntries(
+                    buildContext.environmentVariables.map(
+                        ({ name, default: defaultValue }) => [name, defaultValue]
+                    )
+                ),
+                null,
+                2
+            )};`,
+            ``,
+            `/* prettier-ignore-end */`,
+            ``
+        ].join("\n"),
+        "utf8"
+    );
+
+    if (currentContent !== undefined && currentContent.equals(newContent)) {
+        return;
+    }
+
+    await fs.writeFile(filePath, newContent);
+}

package/src/bin/shared/getJarFileBasename.ts

@@ -1,6 +1,8 @@
 import type { KeycloakVersionRange } from "./KeycloakVersionRange";
 
-export function getJarFileBasename(params: { keycloakVersionRange: KeycloakVersionRange }) {
+export function getJarFileBasename(params: {
+    keycloakVersionRange: KeycloakVersionRange;
+}) {
     const { keycloakVersionRange } = params;
 
     const jarFileBasename = `keycloak-theme-for-kc-${keycloakVersionRange}.jar`;

package/src/bin/shared/getThemeSrcDirPath.ts

@@ -7,12 +7,15 @@ import { themeTypes } from "./constants";
 const themeSrcDirBasenames = ["keycloak-theme", "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: { reactAppRootDirPath: string }) {
-    const { reactAppRootDirPath } = params;
+export function getThemeSrcDirPath(params: { projectDirPath: string }) {
+    const { projectDirPath } = params;
 
-    const srcDirPath = pathJoin(reactAppRootDirPath, "src");
+    const srcDirPath = pathJoin(projectDirPath, "src");
 
-    const themeSrcDirPath: string | undefined = crawl({ "dirPath": srcDirPath, "returnedPathsType": "relative to dirPath" })
+    const themeSrcDirPath: string | undefined = crawl({
+        dirPath: srcDirPath,
+        returnedPathsType: "relative to dirPath"
+    })
         .map(fileRelativePath => {
             for (const themeSrcDirBasename of themeSrcDirBasenames) {
                 const split = fileRelativePath.split(themeSrcDirBasename);
@@ -32,7 +35,7 @@ export function getThemeSrcDirPath(params: { reactAppRootDirPath: string }) {
         if (!fs.existsSync(pathJoin(srcDirPath, themeType))) {
             continue;
         }
-        return { "themeSrcDirPath": srcDirPath };
+        return { themeSrcDirPath: srcDirPath };
     }
 
     console.error(

package/src/bin/shared/metaInfKeycloakThemes.ts

@@ -1,34 +1,84 @@
 import { join as pathJoin, dirname as pathDirname } from "path";
 import type { ThemeType } from "./constants";
 import * as fs from "fs";
+import { assert } from "tsafe/assert";
+import { extractArchive } from "../tools/extractArchive";
 
 export type MetaInfKeycloakTheme = {
     themes: { name: string; types: (ThemeType | "email")[] }[];
 };
 
-export function getMetaInfKeycloakThemesJsonPath(params: { keycloakifyBuildDirPath: string }) {
-    const { keycloakifyBuildDirPath } = params;
+export function getMetaInfKeycloakThemesJsonFilePath(params: {
+    resourcesDirPath: string;
+}) {
+    const { resourcesDirPath } = params;
 
-    return pathJoin(keycloakifyBuildDirPath, "src", "main", "resources", "META-INF", "keycloak-themes.json");
+    return pathJoin(
+        resourcesDirPath === "." ? "" : resourcesDirPath,
+        "META-INF",
+        "keycloak-themes.json"
+    );
 }
 
-export function readMetaInfKeycloakThemes(params: { keycloakifyBuildDirPath: string }): MetaInfKeycloakTheme {
-    const { keycloakifyBuildDirPath } = params;
+export function readMetaInfKeycloakThemes_fromResourcesDirPath(params: {
+    resourcesDirPath: string;
+}) {
+    const { resourcesDirPath } = params;
 
-    return JSON.parse(fs.readFileSync(getMetaInfKeycloakThemesJsonPath({ keycloakifyBuildDirPath })).toString("utf8")) as MetaInfKeycloakTheme;
+    return JSON.parse(
+        fs
+            .readFileSync(
+                getMetaInfKeycloakThemesJsonFilePath({
+                    resourcesDirPath
+                })
+            )
+            .toString("utf8")
+    ) as MetaInfKeycloakTheme;
 }
 
-export function writeMetaInfKeycloakThemes(params: { keycloakifyBuildDirPath: string; metaInfKeycloakThemes: MetaInfKeycloakTheme }) {
-    const { keycloakifyBuildDirPath, metaInfKeycloakThemes } = params;
+export async function readMetaInfKeycloakThemes_fromJar(params: {
+    jarFilePath: string;
+}): Promise<MetaInfKeycloakTheme> {
+    const { jarFilePath } = params;
+    let metaInfKeycloakThemes: MetaInfKeycloakTheme | undefined = undefined;
 
-    const metaInfKeycloakThemesJsonPath = getMetaInfKeycloakThemesJsonPath({ keycloakifyBuildDirPath });
+    await extractArchive({
+        archiveFilePath: jarFilePath,
+        onArchiveFile: async ({ relativeFilePathInArchive, readFile, earlyExit }) => {
+            if (
+                relativeFilePathInArchive ===
+                getMetaInfKeycloakThemesJsonFilePath({ resourcesDirPath: "." })
+            ) {
+                metaInfKeycloakThemes = JSON.parse((await readFile()).toString("utf8"));
+                earlyExit();
+            }
+        }
+    });
+
+    assert(metaInfKeycloakThemes !== undefined);
+
+    return metaInfKeycloakThemes;
+}
+
+export function writeMetaInfKeycloakThemes(params: {
+    resourcesDirPath: string;
+    metaInfKeycloakThemes: MetaInfKeycloakTheme;
+}) {
+    const { resourcesDirPath, metaInfKeycloakThemes } = params;
+
+    const metaInfKeycloakThemesJsonPath = getMetaInfKeycloakThemesJsonFilePath({
+        resourcesDirPath
+    });
 
     {
         const dirPath = pathDirname(metaInfKeycloakThemesJsonPath);
         if (!fs.existsSync(dirPath)) {
-            fs.mkdirSync(dirPath, { "recursive": true });
+            fs.mkdirSync(dirPath, { recursive: true });
         }
     }
 
-    fs.writeFileSync(metaInfKeycloakThemesJsonPath, Buffer.from(JSON.stringify(metaInfKeycloakThemes, null, 2), "utf8"));
+    fs.writeFileSync(
+        metaInfKeycloakThemesJsonPath,
+        Buffer.from(JSON.stringify(metaInfKeycloakThemes, null, 2), "utf8")
+    );
 }

package/src/bin/shared/promptKeycloakVersion.ts

@@ -1,65 +1,126 @@
 import { getLatestsSemVersionedTagFactory } from "../tools/octokit-addons/getLatestsSemVersionedTag";
 import { Octokit } from "@octokit/rest";
 import cliSelect from "cli-select";
-import { lastKeycloakVersionWithAccountV1 } from "./constants";
 import { SemVer } from "../tools/SemVer";
-
-export async function promptKeycloakVersion(params: { startingFromMajor: number | undefined }) {
-    const { startingFromMajor } = params;
+import { join as pathJoin, dirname as pathDirname } from "path";
+import * as fs from "fs";
+import type { ReturnType } from "tsafe";
+import { id } from "tsafe/id";
+
+export async function promptKeycloakVersion(params: {
+    startingFromMajor: number | undefined;
+    excludeMajorVersions: number[];
+    cacheDirPath: string;
+}) {
+    const { startingFromMajor, excludeMajorVersions, cacheDirPath } = params;
 
     const { getLatestsSemVersionedTag } = (() => {
         const { octokit } = (() => {
             const githubToken = process.env.GITHUB_TOKEN;
 
-            const octokit = new Octokit(githubToken === undefined ? undefined : { "auth": githubToken });
+            const octokit = new Octokit(
+                githubToken === undefined ? undefined : { auth: githubToken }
+            );
 
             return { octokit };
         })();
 
-        const { getLatestsSemVersionedTag } = getLatestsSemVersionedTagFactory({ octokit });
+        const { getLatestsSemVersionedTag } = getLatestsSemVersionedTagFactory({
+            octokit
+        });
 
         return { getLatestsSemVersionedTag };
     })();
 
-    console.log("Select Keycloak version");
-
     const semVersionedTagByMajor = new Map<number, { tag: string; version: SemVer }>();
 
-    (
-        await getLatestsSemVersionedTag({
-            "count": 50,
-            "owner": "keycloak",
-            "repo": "keycloak"
-        })
-    ).forEach(semVersionedTag => {
-        if (startingFromMajor !== undefined && semVersionedTag.version.major < startingFromMajor) {
-            return;
+    const semVersionedTags = await (async () => {
+        const cacheFilePath = pathJoin(cacheDirPath, "keycloak-versions.json");
+
+        type Cache = {
+            time: number;
+            semVersionedTags: ReturnType<typeof getLatestsSemVersionedTag>;
+        };
+
+        use_cache: {
+            if (!fs.existsSync(cacheFilePath)) {
+                break use_cache;
+            }
+
+            const cache: Cache = JSON.parse(
+                fs.readFileSync(cacheFilePath).toString("utf8")
+            );
+
+            if (Date.now() - cache.time > 3_600_000) {
+                fs.unlinkSync(cacheFilePath);
+                break use_cache;
+            }
+
+            return cache.semVersionedTags;
         }
 
-        const currentSemVersionedTag = semVersionedTagByMajor.get(semVersionedTag.version.major);
+        const semVersionedTags = await getLatestsSemVersionedTag({
+            count: 50,
+            owner: "keycloak",
+            repo: "keycloak"
+        });
+
+        {
+            const dirPath = pathDirname(cacheFilePath);
+
+            if (!fs.existsSync(dirPath)) {
+                fs.mkdirSync(dirPath, { recursive: true });
+            }
+        }
 
-        if (currentSemVersionedTag !== undefined && SemVer.compare(semVersionedTag.version, currentSemVersionedTag.version) === -1) {
+        fs.writeFileSync(
+            cacheFilePath,
+            JSON.stringify(
+                id<Cache>({
+                    time: Date.now(),
+                    semVersionedTags
+                }),
+                null,
+                2
+            )
+        );
+
+        return semVersionedTags;
+    })();
+
+    semVersionedTags.forEach(semVersionedTag => {
+        if (
+            startingFromMajor !== undefined &&
+            semVersionedTag.version.major < startingFromMajor
+        ) {
             return;
         }
 
-        semVersionedTagByMajor.set(semVersionedTag.version.major, semVersionedTag);
-    });
+        if (excludeMajorVersions.includes(semVersionedTag.version.major)) {
+            return;
+        }
 
-    const lastMajorVersions = Array.from(semVersionedTagByMajor.values()).map(({ tag: version }) => {
-        let out = version;
+        const currentSemVersionedTag = semVersionedTagByMajor.get(
+            semVersionedTag.version.major
+        );
 
-        if (version === lastKeycloakVersionWithAccountV1) {
-            out += " (last version with account v1 built in)";
+        if (
+            currentSemVersionedTag !== undefined &&
+            SemVer.compare(semVersionedTag.version, currentSemVersionedTag.version) === -1
+        ) {
+            return;
         }
 
-        return out;
+        semVersionedTagByMajor.set(semVersionedTag.version.major, semVersionedTag);
     });
 
+    const lastMajorVersions = Array.from(semVersionedTagByMajor.values()).map(
+        ({ tag }) => tag
+    );
+
     const { value } = await cliSelect<string>({
-        "values": lastMajorVersions
+        values: lastMajorVersions
     }).catch(() => {
-        console.log("Aborting");
-
         process.exit(-1);
     });