keycloakify 10.0.0-rc.8 → 10.0.0-rc.80

package/src/bin/shared/downloadBuiltinKeycloakTheme.ts

@@ -1,264 +0,0 @@
-import { join as pathJoin } from "path";
-import { downloadAndUnzip } from "./downloadAndUnzip";
-import { type BuildOptions } from "./buildOptions";
-import { assert } from "tsafe/assert";
-import * as child_process from "child_process";
-import * as fs from "fs";
-import { rmSync } from "../tools/fs.rmSync";
-import { lastKeycloakVersionWithAccountV1 } from "../shared/constants";
-import { transformCodebase } from "../tools/transformCodebase";
-
-export type BuildOptionsLike = {
-    cacheDirPath: string;
-    npmWorkspaceRootDirPath: string;
-};
-
-assert<BuildOptions extends BuildOptionsLike ? true : false>();
-
-export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: string; destDirPath: string; buildOptions: BuildOptionsLike }) {
-    const { keycloakVersion, destDirPath, buildOptions } = params;
-
-    await downloadAndUnzip({
-        destDirPath,
-        "url": `https://github.com/keycloak/keycloak/archive/refs/tags/${keycloakVersion}.zip`,
-        "specificDirsToExtract": ["", "-community"].map(ext => `keycloak-${keycloakVersion}/themes/src/main/resources${ext}/theme`),
-        buildOptions,
-        "preCacheTransform": {
-            "actionCacheId": "npm install and build",
-            "action": async ({ destDirPath }) => {
-                install_common_node_modules: {
-                    const commonResourcesDirPath = pathJoin(destDirPath, "keycloak", "common", "resources");
-
-                    if (!fs.existsSync(commonResourcesDirPath)) {
-                        break install_common_node_modules;
-                    }
-
-                    if (!fs.existsSync(pathJoin(commonResourcesDirPath, "package.json"))) {
-                        break install_common_node_modules;
-                    }
-
-                    if (fs.existsSync(pathJoin(commonResourcesDirPath, "node_modules"))) {
-                        break install_common_node_modules;
-                    }
-
-                    child_process.execSync("npm install --omit=dev", {
-                        "cwd": commonResourcesDirPath,
-                        "stdio": "ignore"
-                    });
-                }
-
-                repatriate_common_resources_from_base_login_theme: {
-                    const baseLoginThemeResourceDir = pathJoin(destDirPath, "base", "login", "resources");
-
-                    if (!fs.existsSync(baseLoginThemeResourceDir)) {
-                        break repatriate_common_resources_from_base_login_theme;
-                    }
-
-                    transformCodebase({
-                        "srcDirPath": baseLoginThemeResourceDir,
-                        "destDirPath": pathJoin(destDirPath, "keycloak", "login", "resources")
-                    });
-                }
-
-                install_and_move_to_common_resources_generated_in_keycloak_v2: {
-                    if (!fs.readFileSync(pathJoin(destDirPath, "keycloak", "login", "theme.properties")).toString("utf8").includes("web_modules")) {
-                        break install_and_move_to_common_resources_generated_in_keycloak_v2;
-                    }
-
-                    const accountV2DirSrcDirPath = pathJoin(destDirPath, "keycloak.v2", "account", "src");
-
-                    if (!fs.existsSync(accountV2DirSrcDirPath)) {
-                        break install_and_move_to_common_resources_generated_in_keycloak_v2;
-                    }
-
-                    const packageManager = fs.existsSync(pathJoin(accountV2DirSrcDirPath, "pnpm-lock.yaml")) ? "pnpm" : "npm";
-
-                    if (packageManager === "pnpm") {
-                        try {
-                            child_process.execSync(`which pnpm`);
-                        } catch {
-                            console.log(`Installing pnpm globally`);
-                            child_process.execSync(`npm install -g pnpm`);
-                        }
-                    }
-
-                    child_process.execSync(`${packageManager} install`, { "cwd": accountV2DirSrcDirPath, "stdio": "ignore" });
-
-                    const packageJsonFilePath = pathJoin(accountV2DirSrcDirPath, "package.json");
-
-                    const packageJsonRaw = fs.readFileSync(packageJsonFilePath);
-
-                    const parsedPackageJson = JSON.parse(packageJsonRaw.toString("utf8"));
-
-                    parsedPackageJson.scripts.build = parsedPackageJson.scripts.build
-                        .replace(`${packageManager} run check-types`, "true")
-                        .replace(`${packageManager} run babel`, "true");
-
-                    fs.writeFileSync(packageJsonFilePath, Buffer.from(JSON.stringify(parsedPackageJson, null, 2), "utf8"));
-
-                    child_process.execSync(`${packageManager} run build`, { "cwd": accountV2DirSrcDirPath, "stdio": "ignore" });
-
-                    fs.writeFileSync(packageJsonFilePath, packageJsonRaw);
-
-                    fs.rmSync(pathJoin(accountV2DirSrcDirPath, "node_modules"), { "recursive": true });
-                }
-
-                remove_keycloak_v2: {
-                    const keycloakV2DirPath = pathJoin(destDirPath, "keycloak.v2");
-
-                    if (!fs.existsSync(keycloakV2DirPath)) {
-                        break remove_keycloak_v2;
-                    }
-
-                    rmSync(keycloakV2DirPath, { "recursive": true });
-                }
-
-                // Note, this is an optimization for reducing the size of the jar
-                remove_unused_node_modules: {
-                    const nodeModuleDirPath = pathJoin(destDirPath, "keycloak", "common", "resources", "node_modules");
-
-                    if (!fs.existsSync(nodeModuleDirPath)) {
-                        break remove_unused_node_modules;
-                    }
-
-                    const toDeletePerfixes = [
-                        "angular",
-                        "bootstrap",
-                        "rcue",
-                        "font-awesome",
-                        "ng-file-upload",
-                        pathJoin("patternfly", "dist", "sass"),
-                        pathJoin("patternfly", "dist", "less"),
-                        pathJoin("patternfly", "dist", "js"),
-                        "d3",
-                        pathJoin("jquery", "src"),
-                        "c3",
-                        "core-js",
-                        "eonasdan-bootstrap-datetimepicker",
-                        "moment",
-                        "react",
-                        "patternfly-bootstrap-treeview",
-                        "popper.js",
-                        "tippy.js",
-                        "jquery-match-height",
-                        "google-code-prettify",
-                        "patternfly-bootstrap-combobox",
-                        "focus-trap",
-                        "tabbable",
-                        "scheduler",
-                        "@types",
-                        "datatables.net",
-                        "datatables.net-colreorder",
-                        "tslib",
-                        "prop-types",
-                        "file-selector",
-                        "datatables.net-colreorder-bs",
-                        "object-assign",
-                        "warning",
-                        "js-tokens",
-                        "loose-envify",
-                        "prop-types-extra",
-                        "attr-accept",
-                        "datatables.net-select",
-                        "drmonty-datatables-colvis",
-                        "datatables.net-bs",
-                        pathJoin("@patternfly", "react"),
-                        pathJoin("@patternfly", "patternfly", "docs")
-                    ];
-
-                    transformCodebase({
-                        "srcDirPath": nodeModuleDirPath,
-                        "destDirPath": nodeModuleDirPath,
-                        "transformSourceCode": ({ sourceCode, fileRelativePath }) => {
-                            if (fileRelativePath.endsWith(".map")) {
-                                return undefined;
-                            }
-
-                            if (toDeletePerfixes.find(prefix => fileRelativePath.startsWith(prefix)) !== undefined) {
-                                return undefined;
-                            }
-
-                            if (fileRelativePath.startsWith(pathJoin("patternfly", "dist", "fonts"))) {
-                                if (
-                                    !fileRelativePath.endsWith(".woff2") &&
-                                    !fileRelativePath.endsWith(".woff") &&
-                                    !fileRelativePath.endsWith(".ttf")
-                                ) {
-                                    return undefined;
-                                }
-                            }
-
-                            return { "modifiedSourceCode": sourceCode };
-                        }
-                    });
-                }
-
-                // Just like node_modules
-                remove_unused_lib: {
-                    const libDirPath = pathJoin(destDirPath, "keycloak", "common", "resources", "lib");
-
-                    if (!fs.existsSync(libDirPath)) {
-                        break remove_unused_lib;
-                    }
-
-                    const toDeletePerfixes = ["ui-ace", "filesaver", "fileupload", "angular", "ui-ace"];
-
-                    transformCodebase({
-                        "srcDirPath": libDirPath,
-                        "destDirPath": libDirPath,
-                        "transformSourceCode": ({ sourceCode, fileRelativePath }) => {
-                            if (fileRelativePath.endsWith(".map")) {
-                                return undefined;
-                            }
-
-                            if (toDeletePerfixes.find(prefix => fileRelativePath.startsWith(prefix)) !== undefined) {
-                                return undefined;
-                            }
-
-                            return { "modifiedSourceCode": sourceCode };
-                        }
-                    });
-                }
-
-                last_account_v1_transformations: {
-                    if (lastKeycloakVersionWithAccountV1 !== keycloakVersion) {
-                        break last_account_v1_transformations;
-                    }
-
-                    {
-                        const accountCssFilePath = pathJoin(destDirPath, "keycloak", "account", "resources", "css", "account.css");
-
-                        fs.writeFileSync(
-                            accountCssFilePath,
-                            Buffer.from(fs.readFileSync(accountCssFilePath).toString("utf8").replace("top: -34px;", "top: -34px !important;"), "utf8")
-                        );
-                    }
-
-                    // Note, this is an optimization for reducing the size of the jar,
-                    // For this version we know exactly which resources are used.
-                    {
-                        const nodeModulesDirPath = pathJoin(destDirPath, "keycloak", "common", "resources", "node_modules");
-
-                        const toKeepPrefixes = [
-                            ...["patternfly.min.css", "patternfly-additions.min.css", "patternfly-additions.min.css"].map(fileBasename =>
-                                pathJoin("patternfly", "dist", "css", fileBasename)
-                            ),
-                            pathJoin("patternfly", "dist", "fonts")
-                        ];
-
-                        transformCodebase({
-                            "srcDirPath": nodeModulesDirPath,
-                            "destDirPath": nodeModulesDirPath,
-                            "transformSourceCode": ({ sourceCode, fileRelativePath }) => {
-                                if (toKeepPrefixes.find(prefix => fileRelativePath.startsWith(prefix)) === undefined) {
-                                    return undefined;
-                                }
-                                return { "modifiedSourceCode": sourceCode };
-                            }
-                        });
-                    }
-                }
-            }
-        }
-    });
-}

package/src/bin/shared/getJarFileBasename.ts

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

package/src/bin/shared/getThemeSrcDirPath.ts

@@ -1,47 +0,0 @@
-import * as fs from "fs";
-import { exclude } from "tsafe";
-import { crawl } from "../tools/crawl";
-import { join as pathJoin } from "path";
-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;
-
-    const srcDirPath = pathJoin(reactAppRootDirPath, "src");
-
-    const themeSrcDirPath: string | undefined = crawl({ "dirPath": srcDirPath, "returnedPathsType": "relative to dirPath" })
-        .map(fileRelativePath => {
-            for (const themeSrcDirBasename of themeSrcDirBasenames) {
-                const split = fileRelativePath.split(themeSrcDirBasename);
-                if (split.length === 2) {
-                    return pathJoin(srcDirPath, split[0] + themeSrcDirBasename);
-                }
-            }
-            return undefined;
-        })
-        .filter(exclude(undefined))[0];
-
-    if (themeSrcDirPath !== undefined) {
-        return { themeSrcDirPath };
-    }
-
-    for (const themeType of [...themeTypes, "email"]) {
-        if (!fs.existsSync(pathJoin(srcDirPath, themeType))) {
-            continue;
-        }
-        return { "themeSrcDirPath": srcDirPath };
-    }
-
-    console.error(
-        [
-            "Can't locate your theme source directory. It should be either: ",
-            "src/ or src/keycloak-theme or src/keycloak_theme.",
-            "Example in the starter: https://github.com/keycloakify/keycloakify-starter/tree/main/src/keycloak-theme"
-        ].join("\n")
-    );
-
-    process.exit(-1);
-}

package/src/bin/start-keycloak.ts

@@ -1,236 +0,0 @@
-import { readBuildOptions } from "./shared/buildOptions";
-import type { CliCommandOptions as CliCommandOptions_common } from "./main";
-import { promptKeycloakVersion } from "./shared/promptKeycloakVersion";
-import { readMetaInfKeycloakThemes } from "./shared/metaInfKeycloakThemes";
-import { accountV1ThemeName } 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 * as fs from "fs";
-import { join as pathJoin, posix as pathPosix } from "path";
-import * as child_process from "child_process";
-import chalk from "chalk";
-
-export type CliCommandOptions = CliCommandOptions_common & {
-    port: number;
-    keycloakVersion: string | undefined;
-};
-
-export async function command(params: { cliCommandOptions: CliCommandOptions }) {
-    exit_if_docker_not_installed: {
-        let commandOutput: Buffer | undefined = undefined;
-
-        try {
-            commandOutput = child_process.execSync("docker --version", { "stdio": ["ignore", "pipe", "ignore"] });
-        } catch {}
-
-        if (commandOutput?.toString("utf8").includes("Docker")) {
-            break exit_if_docker_not_installed;
-        }
-
-        console.log(
-            [
-                `${chalk.red("Docker required.")}`,
-                `Install it with Docker Desktop: ${chalk.bold.underline("https://www.docker.com/products/docker-desktop/")}`,
-                `(or any other way)`
-            ].join(" ")
-        );
-
-        process.exit(1);
-    }
-
-    exit_if_docker_not_running: {
-        let isDockerRunning: boolean;
-
-        try {
-            child_process.execSync("docker info", { "stdio": "ignore" });
-            isDockerRunning = true;
-        } catch {
-            isDockerRunning = false;
-        }
-
-        if (isDockerRunning) {
-            break exit_if_docker_not_running;
-        }
-
-        console.log([`${chalk.red("Docker daemon is not running.")}`, `Please start Docker Desktop and try again.`].join(" "));
-
-        process.exit(1);
-    }
-
-    const { cliCommandOptions } = params;
-
-    const buildOptions = readBuildOptions({ cliCommandOptions });
-
-    exit_if_theme_not_built: {
-        if (fs.existsSync(buildOptions.keycloakifyBuildDirPath)) {
-            break exit_if_theme_not_built;
-        }
-
-        console.log(
-            [`${chalk.red("The theme has not been built.")}`, `Please run ${chalk.bold("npx vite && npx keycloakify build")} first.`].join(" ")
-        );
-        process.exit(1);
-    }
-
-    const metaInfKeycloakThemes = readMetaInfKeycloakThemes({
-        "keycloakifyBuildDirPath": buildOptions.keycloakifyBuildDirPath
-    });
-
-    const doesImplementAccountTheme = metaInfKeycloakThemes.themes.some(({ name }) => name === accountV1ThemeName);
-
-    const { keycloakVersion, keycloakMajorNumber } = await (async function getKeycloakMajor(): Promise<{
-        keycloakVersion: string;
-        keycloakMajorNumber: number;
-    }> {
-        if (cliCommandOptions.keycloakVersion !== undefined) {
-            return {
-                "keycloakVersion": cliCommandOptions.keycloakVersion,
-                "keycloakMajorNumber": SemVer.parse(cliCommandOptions.keycloakVersion).major
-            };
-        }
-
-        console.log("On which version of Keycloak do you want to test your theme?");
-
-        const { keycloakVersion } = await promptKeycloakVersion({
-            "startingFromMajor": 17,
-            "cacheDirPath": buildOptions.cacheDirPath
-        });
-
-        const keycloakMajorNumber = SemVer.parse(keycloakVersion).major;
-
-        if (doesImplementAccountTheme && keycloakMajorNumber === 22) {
-            console.log(
-                [
-                    "Unfortunately, Keycloakify themes that implements an account theme do not work on Keycloak 22",
-                    "Please select any other Keycloak version"
-                ].join(" ")
-            );
-            return getKeycloakMajor();
-        }
-
-        return { keycloakVersion, keycloakMajorNumber };
-    })();
-
-    const keycloakVersionRange: KeycloakVersionRange = (() => {
-        if (doesImplementAccountTheme) {
-            const keycloakVersionRange = (() => {
-                if (keycloakMajorNumber <= 21) {
-                    return "21-and-below" as const;
-                }
-
-                assert(keycloakMajorNumber !== 22);
-
-                if (keycloakMajorNumber === 23) {
-                    return "23" as const;
-                }
-
-                return "24-and-above" as const;
-            })();
-
-            assert<Equals<typeof keycloakVersionRange, KeycloakVersionRange.WithAccountTheme>>();
-
-            return keycloakVersionRange;
-        } else {
-            const keycloakVersionRange = (() => {
-                if (keycloakMajorNumber <= 21) {
-                    return "21-and-below" as const;
-                }
-
-                return "22-and-above" as const;
-            })();
-
-            assert<Equals<typeof keycloakVersionRange, KeycloakVersionRange.WithoutAccountTheme>>();
-
-            return keycloakVersionRange;
-        }
-    })();
-
-    const { jarFileBasename } = getJarFileBasename({ keycloakVersionRange });
-
-    const mountTargets = buildOptions.themeNames
-        .map(themeName => {
-            const themeEntry = metaInfKeycloakThemes.themes.find(({ name }) => name === themeName);
-
-            assert(themeEntry !== undefined);
-
-            return themeEntry.types
-                .map(themeType => {
-                    const localPathDirname = pathJoin(
-                        buildOptions.keycloakifyBuildDirPath,
-                        "src",
-                        "main",
-                        "resources",
-                        "theme",
-                        themeName,
-                        themeType
-                    );
-
-                    return fs
-                        .readdirSync(localPathDirname)
-                        .filter(fileOrDirectoryBasename => !fileOrDirectoryBasename.endsWith(".properties"))
-                        .map(fileOrDirectoryBasename => ({
-                            "localPath": pathJoin(localPathDirname, fileOrDirectoryBasename),
-                            "containerPath": pathPosix.join("/", "opt", "keycloak", "themes", themeName, themeType, fileOrDirectoryBasename)
-                        }));
-                })
-                .flat();
-        })
-        .flat();
-
-    const containerName = "keycloak-keycloakify";
-
-    try {
-        child_process.execSync(`docker rm ${containerName}`, { "stdio": "ignore" });
-    } catch {}
-
-    const child = child_process.spawn(
-        "docker",
-        [
-            "run",
-            ...["-p", `${cliCommandOptions.port}:8080`],
-            ...["--name", containerName],
-            ...["-e", "KEYCLOAK_ADMIN=admin"],
-            ...["-e", "KEYCLOAK_ADMIN_PASSWORD=admin"],
-            ...["-v", `${pathJoin(buildOptions.keycloakifyBuildDirPath, jarFileBasename)}:/opt/keycloak/providers/keycloak-theme.jar`],
-            ...(keycloakMajorNumber <= 20 ? ["-e", "JAVA_OPTS=-Dkeycloak.profile=preview"] : []),
-            ...mountTargets.map(({ localPath, containerPath }) => ["-v", `${localPath}:${containerPath}:rw`]).flat(),
-            `quay.io/keycloak/keycloak:${keycloakVersion}`,
-            "start-dev",
-            ...(21 <= keycloakMajorNumber && keycloakMajorNumber < 24 ? ["--features=declarative-user-profile"] : [])
-        ],
-        {
-            "cwd": buildOptions.keycloakifyBuildDirPath
-        }
-    );
-
-    child.stdout.on("data", data => process.stdout.write(data));
-
-    child.stderr.on("data", data => process.stderr.write(data));
-
-    {
-        const handler = async (data: Buffer) => {
-            if (!data.toString("utf8").includes("Listening on: http://0.0.0.0:8080")) {
-                return;
-            }
-
-            child.stdout.off("data", handler);
-
-            await new Promise(resolve => setTimeout(resolve, 1_000));
-
-            console.log(
-                [
-                    "",
-                    `${chalk.green("Your theme is accessible at:")}`,
-                    `${chalk.green("➜")} ${chalk.cyan.bold("https://test.keycloakify.dev/")}`,
-                    ""
-                ].join("\n")
-            );
-        };
-
-        child.stdout.on("data", handler);
-    }
-
-    child.on("exit", process.exit);
-}