keycloakify 10.0.0-rc.6 → 10.0.0-rc.60

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/pageIds.ts

@@ -1,49 +0,0 @@
-export const loginThemePageIds = [
-    "login.ftl",
-    "login-username.ftl",
-    "login-password.ftl",
-    "webauthn-authenticate.ftl",
-    "webauthn-register.ftl",
-    "register.ftl",
-    "info.ftl",
-    "error.ftl",
-    "login-reset-password.ftl",
-    "login-verify-email.ftl",
-    "terms.ftl",
-    "login-oauth2-device-verify-user-code.ftl",
-    "login-oauth-grant.ftl",
-    "login-otp.ftl",
-    "login-update-profile.ftl",
-    "login-update-password.ftl",
-    "login-idp-link-confirm.ftl",
-    "login-idp-link-email.ftl",
-    "login-page-expired.ftl",
-    "login-config-totp.ftl",
-    "logout-confirm.ftl",
-    "idp-review-user-profile.ftl",
-    "update-email.ftl",
-    "select-authenticator.ftl",
-    "saml-post-form.ftl",
-    "delete-credential.ftl",
-    "code.ftl",
-    "delete-account-confirm.ftl",
-    "frontchannel-logout.ftl",
-    "login-recovery-authn-code-config.ftl",
-    "login-recovery-authn-code-input.ftl",
-    "login-reset-otp.ftl",
-    "login-x509-info.ftl",
-    "webauthn-error.ftl"
-] as const;
-
-export const accountThemePageIds = [
-    "password.ftl",
-    "account.ftl",
-    "sessions.ftl",
-    "totp.ftl",
-    "applications.ftl",
-    "log.ftl",
-    "federatedIdentity.ftl"
-] as const;
-
-export type LoginThemePageId = (typeof loginThemePageIds)[number];
-export type AccountThemePageId = (typeof accountThemePageIds)[number];

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

@@ -1,141 +0,0 @@
-import { readBuildOptions } from "./shared/buildOptions";
-import type { CliCommandOptions } 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";
-
-export async function command(params: { cliCommandOptions: CliCommandOptions }) {
-    const { cliCommandOptions } = params;
-
-    const buildOptions = readBuildOptions({ cliCommandOptions });
-
-    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;
-    }> {
-        const { keycloakVersion } = await promptKeycloakVersion({
-            "startingFromMajor": 17
-        });
-
-        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"
-            ]);
-            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", "8080: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(),
-            ...["-it", `quay.io/keycloak/keycloak:${keycloakVersion}`],
-            "start-dev",
-            ...(21 <= keycloakMajorNumber && keycloakMajorNumber < 24 ? ["--features=declarative-user-profile"] : [])
-        ],
-        {
-            "cwd": buildOptions.keycloakifyBuildDirPath
-        }
-    );
-
-    child.stdout.on("data", data => console.log(data.toString("utf8")));
-
-    child.stderr.on("data", data => console.error(data.toString("utf8")));
-}

package/src/bin/tools/logger.ts

@@ -1,27 +0,0 @@
-type LoggerOpts = {
-    force?: boolean;
-};
-
-type Logger = {
-    log: (message: string, opts?: LoggerOpts) => void;
-    warn: (message: string) => void;
-    error: (message: string) => void;
-};
-
-export const getLogger = ({ isSilent }: { isSilent?: boolean } = {}): Logger => {
-    return {
-        log: (message, { force } = {}) => {
-            if (isSilent && !force) {
-                return;
-            }
-
-            console.log(message);
-        },
-        warn: message => {
-            console.warn(message);
-        },
-        error: message => {
-            console.error(message);
-        }
-    };
-};

package/src/bin/tools/unzip.ts

@@ -1,141 +0,0 @@
-import fsp from "node:fs/promises";
-import fs from "fs";
-import path from "node:path";
-import yauzl from "yauzl";
-import yazl from "yazl";
-import stream from "node:stream";
-import { promisify } from "node:util";
-
-const pipeline = promisify(stream.pipeline);
-
-async function pathExists(path: string) {
-    try {
-        await fsp.stat(path);
-        return true;
-    } catch (error) {
-        if ((error as { code: string }).code === "ENOENT") {
-            return false;
-        }
-        throw error;
-    }
-}
-
-// Handlings of non posix path is not implemented correctly
-// it work by coincidence. Don't have the time to fix but it should be fixed.
-export async function unzip(file: string, targetFolder: string, specificDirsToExtract?: string[]) {
-    specificDirsToExtract = specificDirsToExtract?.map(dirPath => {
-        if (!dirPath.endsWith("/") || !dirPath.endsWith("\\")) {
-            dirPath += "/";
-        }
-
-        return dirPath;
-    });
-
-    if (!targetFolder.endsWith("/") || !targetFolder.endsWith("\\")) {
-        targetFolder += "/";
-    }
-    if (!fs.existsSync(targetFolder)) {
-        fs.mkdirSync(targetFolder, { recursive: true });
-    }
-
-    return new Promise<void>((resolve, reject) => {
-        yauzl.open(file, { lazyEntries: true }, async (err, zipfile) => {
-            if (err) {
-                reject(err);
-                return;
-            }
-
-            zipfile.readEntry();
-
-            zipfile.on("entry", async entry => {
-                if (specificDirsToExtract !== undefined) {
-                    const dirPath = specificDirsToExtract.find(dirPath => entry.fileName.startsWith(dirPath));
-
-                    // Skip files outside of the unzipSubPath
-                    if (dirPath === undefined) {
-                        zipfile.readEntry();
-                        return;
-                    }
-
-                    // Remove the unzipSubPath from the file name
-                    entry.fileName = entry.fileName.substring(dirPath.length);
-                }
-
-                const target = path.join(targetFolder, entry.fileName);
-
-                // Directory file names end with '/'.
-                // Note that entries for directories themselves are optional.
-                // An entry's fileName implicitly requires its parent directories to exist.
-                if (/[\/\\]$/.test(target)) {
-                    await fsp.mkdir(target, { recursive: true });
-
-                    zipfile.readEntry();
-                    return;
-                }
-
-                // Skip existing files
-                if (await pathExists(target)) {
-                    zipfile.readEntry();
-                    return;
-                }
-
-                zipfile.openReadStream(entry, async (err, readStream) => {
-                    if (err) {
-                        reject(err);
-                        return;
-                    }
-
-                    await fsp.mkdir(path.dirname(target), { "recursive": true });
-
-                    await pipeline(readStream, fs.createWriteStream(target));
-
-                    zipfile.readEntry();
-                });
-            });
-
-            zipfile.once("end", function () {
-                zipfile.close();
-                resolve();
-            });
-        });
-    });
-}
-
-// NOTE: This code was directly copied from ChatGPT and appears to function as expected.
-// However, confidence in its complete accuracy and robustness is limited.
-export async function zip(sourceFolder: string, targetZip: string) {
-    return new Promise<void>(async (resolve, reject) => {
-        const zipfile = new yazl.ZipFile();
-        const files: string[] = [];
-
-        // Recursive function to explore directories and their subdirectories
-        async function exploreDir(dir: string) {
-            const dirContent = await fsp.readdir(dir);
-            for (const file of dirContent) {
-                const filePath = path.join(dir, file);
-                const stat = await fsp.stat(filePath);
-                if (stat.isDirectory()) {
-                    await exploreDir(filePath);
-                } else if (stat.isFile()) {
-                    files.push(filePath);
-                }
-            }
-        }
-
-        // Collecting all files to be zipped
-        await exploreDir(sourceFolder);
-
-        // Adding files to zip
-        for (const file of files) {
-            const relativePath = path.relative(sourceFolder, file);
-            zipfile.addFile(file, relativePath);
-        }
-
-        zipfile.outputStream
-            .pipe(fs.createWriteStream(targetZip))
-            .on("close", () => resolve())
-            .on("error", err => reject(err)); // Listen to error events
-
-        zipfile.end();
-    });
-}

package/src/index.ts

@@ -1 +0,0 @@
-export { createKeycloakAdapter } from "keycloakify/lib/keycloakJsAdapter";

package/src/lib/isStorybook.ts

@@ -1 +0,0 @@
-export const isStorybook = typeof window === "object" && Object.keys(window).find(key => key.startsWith("__STORYBOOK")) !== undefined;