keycloakify 9.3.1 → 9.4.0-rc.1

package/src/bin/copy-keycloak-resources-to-public.ts

@@ -2,7 +2,7 @@
 
 import { downloadKeycloakStaticResources } from "./keycloakify/generateTheme/downloadKeycloakStaticResources";
 import { join as pathJoin, relative as pathRelative } from "path";
-import { readBuildOptions } from "./keycloakify/BuildOptions";
+import { readBuildOptions } from "./keycloakify/buildOptions";
 import { themeTypes, keycloak_resources, lastKeycloakVersionWithAccountV1 } from "./constants";
 import * as fs from "fs";
 
@@ -28,7 +28,6 @@ import * as fs from "fs";
             })(),
             themeType,
             "themeDirPath": reservedDirPath,
-            "usedResources": undefined,
             buildOptions
         });
     }
@@ -44,7 +43,7 @@ import * as fs from "fs";
         )
     );
 
-    fs.writeFileSync(pathJoin(buildOptions.publicDirPath, "keycloak-resources", ".gitignore"), Buffer.from("*", "utf8"));
+    fs.writeFileSync(pathJoin(buildOptions.publicDirPath, keycloak_resources, ".gitignore"), Buffer.from("*", "utf8"));
 
     console.log(`${pathRelative(reactAppRootDirPath, reservedDirPath)} directory created.`);
 })();

package/src/bin/download-builtin-keycloak-theme.ts

@@ -3,11 +3,13 @@ import { join as pathJoin } from "path";
 import { downloadAndUnzip } from "./tools/downloadAndUnzip";
 import { promptKeycloakVersion } from "./promptKeycloakVersion";
 import { getLogger } from "./tools/logger";
-import { readBuildOptions } from "./keycloakify/BuildOptions";
+import { readBuildOptions, type BuildOptions } from "./keycloakify/buildOptions";
 import { assert } from "tsafe/assert";
-import type { BuildOptions } from "./keycloakify/BuildOptions";
 import * as child_process from "child_process";
 import * as fs from "fs";
+import { rmSync } from "./tools/fs.rmSync";
+import { lastKeycloakVersionWithAccountV1 } from "./constants";
+import { transformCodebase } from "./tools/transformCodebase";
 
 export type BuildOptionsLike = {
     cacheDirPath: string;
@@ -27,51 +29,6 @@ export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: st
         "preCacheTransform": {
             "actionCacheId": "npm install and build",
             "action": async ({ destDirPath }) => {
-                fix_account_css: {
-                    const accountCssFilePath = pathJoin(destDirPath, "keycloak", "account", "resources", "css", "account.css");
-
-                    if (!fs.existsSync(accountCssFilePath)) {
-                        break fix_account_css;
-                    }
-
-                    fs.writeFileSync(
-                        accountCssFilePath,
-                        Buffer.from(fs.readFileSync(accountCssFilePath).toString("utf8").replace("top: -34px;", "top: -34px !important;"), "utf8")
-                    );
-                }
-
-                fix_account_topt: {
-                    const totpFtlFilePath = pathJoin(destDirPath, "base", "account", "totp.ftl");
-
-                    if (!fs.existsSync(totpFtlFilePath)) {
-                        break fix_account_topt;
-                    }
-
-                    fs.writeFileSync(
-                        totpFtlFilePath,
-                        Buffer.from(
-                            fs
-                                .readFileSync(totpFtlFilePath)
-                                .toString("utf8")
-                                .replace(
-                                    [
-                                        "                <#list totp.policy.supportedApplications as app>",
-                                        "                    <li>${app}</li>",
-                                        "                </#list>"
-                                    ].join("\n"),
-                                    [
-                                        "                <#if totp.policy.supportedApplications?has_content>",
-                                        "                    <#list totp.policy.supportedApplications as app>",
-                                        "                        <li>${app}</li>",
-                                        "                    </#list>",
-                                        "                </#if>"
-                                    ].join("\n")
-                                ),
-                            "utf8"
-                        )
-                    );
-                }
-
                 install_common_node_modules: {
                     const commonResourcesDirPath = pathJoin(destDirPath, "keycloak", "common", "resources");
 
@@ -93,43 +50,174 @@ export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: st
                     });
                 }
 
-                install_and_move_to_common_resources_generated_in_keycloak_v2: {
-                    const accountV2DirSrcDirPath = pathJoin(destDirPath, "keycloak.v2", "account", "src");
+                remove_keycloak_v2: {
+                    const keycloakV2DirPath = pathJoin(destDirPath, "keycloak.v2");
 
-                    if (!fs.existsSync(accountV2DirSrcDirPath)) {
-                        break install_and_move_to_common_resources_generated_in_keycloak_v2;
+                    if (!fs.existsSync(keycloakV2DirPath)) {
+                        break remove_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" });
+                    rmSync(keycloakV2DirPath, { "recursive": true });
+                }
 
-                    const packageJsonFilePath = pathJoin(accountV2DirSrcDirPath, "package.json");
+                // Note, this is an optimization for reducing the size of the jar
+                remove_unused_node_modules: {
+                    const pathOfNodeModules = pathJoin(destDirPath, "keycloak", "common", "resources", "node_modules");
 
-                    const packageJsonRaw = fs.readFileSync(packageJsonFilePath);
+                    if (!fs.existsSync(pathOfNodeModules)) {
+                        break remove_unused_node_modules;
+                    }
 
-                    const parsedPackageJson = JSON.parse(packageJsonRaw.toString("utf8"));
+                    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": pathOfNodeModules,
+                        "destDirPath": pathOfNodeModules,
+                        "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 };
+                        }
+                    });
+                }
 
-                    parsedPackageJson.scripts.build = parsedPackageJson.scripts.build
-                        .replace(`${packageManager} run check-types`, "true")
-                        .replace(`${packageManager} run babel`, "true");
+                last_account_v1_transformations: {
+                    if (lastKeycloakVersionWithAccountV1 !== keycloakVersion) {
+                        break last_account_v1_transformations;
+                    }
 
-                    fs.writeFileSync(packageJsonFilePath, Buffer.from(JSON.stringify(parsedPackageJson, null, 2), "utf8"));
+                    {
+                        const accountCssFilePath = pathJoin(destDirPath, "keycloak", "account", "resources", "css", "account.css");
 
-                    child_process.execSync(`${packageManager} run build`, { "cwd": accountV2DirSrcDirPath, "stdio": "ignore" });
+                        fs.writeFileSync(
+                            accountCssFilePath,
+                            Buffer.from(fs.readFileSync(accountCssFilePath).toString("utf8").replace("top: -34px;", "top: -34px !important;"), "utf8")
+                        );
+                    }
 
-                    fs.writeFileSync(packageJsonFilePath, packageJsonRaw);
+                    {
+                        const totpFtlFilePath = pathJoin(destDirPath, "base", "account", "totp.ftl");
+
+                        fs.writeFileSync(
+                            totpFtlFilePath,
+                            Buffer.from(
+                                fs
+                                    .readFileSync(totpFtlFilePath)
+                                    .toString("utf8")
+                                    .replace(
+                                        [
+                                            "                <#list totp.policy.supportedApplications as app>",
+                                            "                    <li>${app}</li>",
+                                            "                </#list>"
+                                        ].join("\n"),
+                                        [
+                                            "                <#if totp.policy.supportedApplications?has_content>",
+                                            "                    <#list totp.policy.supportedApplications as app>",
+                                            "                        <li>${app}</li>",
+                                            "                    </#list>",
+                                            "                </#if>"
+                                        ].join("\n")
+                                    ),
+                                "utf8"
+                            )
+                        );
+                    }
 
-                    fs.rmSync(pathJoin(accountV2DirSrcDirPath, "node_modules"), { "recursive": true });
+                    // Note, this is an optimization for reducing the size of the jar
+                    {
+                        const nodeModulesDirPath = pathJoin(destDirPath, "keycloak", "common", "resources");
+
+                        const usedCommonResourceRelativeFilePaths = [
+                            ...["patternfly.min.css", "patternfly-additions.min.css", "patternfly-additions.min.css"].map(fileBasename =>
+                                pathJoin("patternfly", "dist", "css", fileBasename)
+                            ),
+                            ...[
+                                "OpenSans-Light-webfont.woff2",
+                                "OpenSans-Regular-webfont.woff2",
+                                "OpenSans-Bold-webfont.woff2",
+                                "OpenSans-Semibold-webfont.woff2",
+                                "OpenSans-Bold-webfont.woff",
+                                "OpenSans-Light-webfont.woff",
+                                "OpenSans-Regular-webfont.woff",
+                                "OpenSans-Semibold-webfont.woff",
+                                "OpenSans-Regular-webfont.ttf",
+                                "OpenSans-Light-webfont.ttf",
+                                "OpenSans-Semibold-webfont.ttf",
+                                "OpenSans-Bold-webfont.ttf"
+                            ].map(fileBasename => pathJoin("patternfly", "dist", "fonts", fileBasename))
+                        ];
+
+                        transformCodebase({
+                            "srcDirPath": nodeModulesDirPath,
+                            "destDirPath": nodeModulesDirPath,
+                            "transformSourceCode": ({ sourceCode, fileRelativePath }) => {
+                                if (!usedCommonResourceRelativeFilePaths.includes(fileRelativePath)) {
+                                    return undefined;
+                                }
+
+                                return { "modifiedSourceCode": sourceCode };
+                            }
+                        });
+                    }
                 }
             }
         }

package/src/bin/eject-keycloak-page.ts

@@ -9,7 +9,7 @@ import { existsSync } from "fs";
 import { join as pathJoin, relative as pathRelative } from "path";
 import { kebabCaseToCamelCase } from "./tools/kebabCaseToSnakeCase";
 import { assert, Equals } from "tsafe/assert";
-import { getThemeSrcDirPath } from "./getSrcDirPath";
+import { getThemeSrcDirPath } from "./getThemeSrcDirPath";
 import { themeTypes, type ThemeType } from "./constants";
 
 (async () => {

package/src/bin/initialize-email-theme.ts

@@ -4,10 +4,11 @@ import { downloadBuiltinKeycloakTheme } from "./download-builtin-keycloak-theme"
 import { join as pathJoin, relative as pathRelative } from "path";
 import { transformCodebase } from "./tools/transformCodebase";
 import { promptKeycloakVersion } from "./promptKeycloakVersion";
-import { readBuildOptions } from "./keycloakify/BuildOptions";
+import { readBuildOptions } from "./keycloakify/buildOptions";
 import * as fs from "fs";
 import { getLogger } from "./tools/logger";
-import { getThemeSrcDirPath } from "./getSrcDirPath";
+import { getThemeSrcDirPath } from "./getThemeSrcDirPath";
+import { rmSync } from "./tools/fs.rmSync";
 
 export async function main() {
     const reactAppRootDirPath = process.cwd();
@@ -54,7 +55,7 @@ export async function main() {
 
     logger.log(`${pathRelative(process.cwd(), emailThemeSrcDirPath)} ready to be customized, feel free to remove every file you do not customize`);
 
-    fs.rmSync(builtinKeycloakThemeTmpDirPath, { "recursive": true, "force": true });
+    rmSync(builtinKeycloakThemeTmpDirPath, { "recursive": true, "force": true });
 }
 
 if (require.main === module) {

package/src/bin/keycloakify/buildOptions/buildOptions.ts

@@ -0,0 +1,185 @@
+import { parse as urlParse } from "url";
+import { readParsedPackageJson } from "./parsedPackageJson";
+import { join as pathJoin } from "path";
+import parseArgv from "minimist";
+import { getAbsoluteAndInOsFormatPath } from "../../tools/getAbsoluteAndInOsFormatPath";
+import { readResolvedViteConfig } from "./resolvedViteConfig";
+import { getKeycloakifyBuildDirPath } from "./getKeycloakifyBuildDirPath";
+
+/** Consolidated build option gathered form CLI arguments and config in package.json */
+export type BuildOptions = {
+    bundler: "vite" | "webpack";
+    isSilent: boolean;
+    themeVersion: string;
+    themeNames: string[];
+    extraThemeProperties: string[] | undefined;
+    groupId: string;
+    artifactId: string;
+    doCreateJar: boolean;
+    loginThemeResourcesFromKeycloakVersion: string;
+    reactAppRootDirPath: string;
+    reactAppBuildDirPath: string;
+    /** Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak */
+    keycloakifyBuildDirPath: string;
+    publicDirPath: string;
+    cacheDirPath: string;
+    /** If your app is hosted under a subpath, it's the case in CRA if you have "homepage": "https://example.com/my-app" in your package.json
+     * In this case the urlPathname will be "/my-app/" */
+    urlPathname: string | undefined;
+    assetsDirPath: string;
+    doBuildRetrocompatAccountTheme: boolean;
+};
+
+export function readBuildOptions(params: { reactAppRootDirPath: string; processArgv: string[] }): BuildOptions {
+    const { reactAppRootDirPath, processArgv } = params;
+
+    const parsedPackageJson = readParsedPackageJson({ reactAppRootDirPath });
+
+    const { resolvedViteConfig } =
+        readResolvedViteConfig({
+            "parsedPackageJson_keycloakify_keycloakifyBuildDirPath": parsedPackageJson.keycloakify?.keycloakifyBuildDirPath,
+            reactAppRootDirPath
+        }) ?? {};
+
+    const themeNames = (() => {
+        if (parsedPackageJson.keycloakify?.themeName === undefined) {
+            return [
+                parsedPackageJson.name
+                    .replace(/^@(.*)/, "$1")
+                    .split("/")
+                    .join("-")
+            ];
+        }
+
+        if (typeof parsedPackageJson.keycloakify.themeName === "string") {
+            return [parsedPackageJson.keycloakify.themeName];
+        }
+
+        return parsedPackageJson.keycloakify.themeName;
+    })();
+
+    const { keycloakifyBuildDirPath } = getKeycloakifyBuildDirPath({
+        "parsedPackageJson_keycloakify_keycloakifyBuildDirPath": parsedPackageJson.keycloakify?.keycloakifyBuildDirPath,
+        reactAppRootDirPath,
+        "bundler": resolvedViteConfig !== undefined ? "vite" : "webpack"
+    });
+
+    const reactAppBuildDirPath = (() => {
+        webpack: {
+            if (resolvedViteConfig !== undefined) {
+                break webpack;
+            }
+
+            if (parsedPackageJson.keycloakify?.reactAppBuildDirPath !== undefined) {
+                return getAbsoluteAndInOsFormatPath({
+                    "pathIsh": parsedPackageJson.keycloakify?.reactAppBuildDirPath,
+                    "cwd": reactAppRootDirPath
+                });
+            }
+
+            return pathJoin(reactAppRootDirPath, "build");
+        }
+
+        return pathJoin(reactAppRootDirPath, resolvedViteConfig.buildDir);
+    })();
+
+    return {
+        "bundler": resolvedViteConfig !== undefined ? "vite" : "webpack",
+        "isSilent": (() => {
+            const argv = parseArgv(processArgv);
+
+            return typeof argv["silent"] === "boolean" ? argv["silent"] : false;
+        })(),
+        "themeVersion": process.env.KEYCLOAKIFY_THEME_VERSION ?? parsedPackageJson.version ?? "0.0.0",
+        themeNames,
+        "extraThemeProperties": parsedPackageJson.keycloakify?.extraThemeProperties,
+        "groupId": (() => {
+            const fallbackGroupId = `${themeNames[0]}.keycloak`;
+
+            return (
+                process.env.KEYCLOAKIFY_GROUP_ID ??
+                parsedPackageJson.keycloakify?.groupId ??
+                (parsedPackageJson.homepage === undefined
+                    ? fallbackGroupId
+                    : urlParse(parsedPackageJson.homepage)
+                          .host?.replace(/:[0-9]+$/, "")
+                          ?.split(".")
+                          .reverse()
+                          .join(".") ?? fallbackGroupId) + ".keycloak"
+            );
+        })(),
+        "artifactId": process.env.KEYCLOAKIFY_ARTIFACT_ID ?? parsedPackageJson.keycloakify?.artifactId ?? `${themeNames[0]}-keycloak-theme`,
+        "doCreateJar": parsedPackageJson.keycloakify?.doCreateJar ?? true,
+        "loginThemeResourcesFromKeycloakVersion": parsedPackageJson.keycloakify?.loginThemeResourcesFromKeycloakVersion ?? "11.0.3",
+        reactAppRootDirPath,
+        reactAppBuildDirPath,
+        keycloakifyBuildDirPath,
+        "publicDirPath": (() => {
+            webpack: {
+                if (resolvedViteConfig !== undefined) {
+                    break webpack;
+                }
+
+                if (process.env.PUBLIC_DIR_PATH !== undefined) {
+                    return getAbsoluteAndInOsFormatPath({
+                        "pathIsh": process.env.PUBLIC_DIR_PATH,
+                        "cwd": reactAppRootDirPath
+                    });
+                }
+
+                return pathJoin(reactAppRootDirPath, "public");
+            }
+
+            return pathJoin(reactAppRootDirPath, resolvedViteConfig.publicDir);
+        })(),
+        "cacheDirPath": pathJoin(
+            (() => {
+                if (process.env.XDG_CACHE_HOME !== undefined) {
+                    return getAbsoluteAndInOsFormatPath({
+                        "pathIsh": process.env.XDG_CACHE_HOME,
+                        "cwd": reactAppRootDirPath
+                    });
+                }
+
+                return pathJoin(reactAppRootDirPath, "node_modules", ".cache");
+            })(),
+            "keycloakify"
+        ),
+        "urlPathname": (() => {
+            webpack: {
+                if (resolvedViteConfig !== undefined) {
+                    break webpack;
+                }
+
+                const { homepage } = parsedPackageJson;
+
+                let url: URL | undefined = undefined;
+
+                if (homepage !== undefined) {
+                    url = new URL(homepage);
+                }
+
+                if (url === undefined) {
+                    return undefined;
+                }
+
+                const out = url.pathname.replace(/([^/])$/, "$1/");
+                return out === "/" ? undefined : out;
+            }
+
+            return resolvedViteConfig.urlPathname;
+        })(),
+        "assetsDirPath": (() => {
+            webpack: {
+                if (resolvedViteConfig !== undefined) {
+                    break webpack;
+                }
+
+                return pathJoin(reactAppBuildDirPath, "static");
+            }
+
+            return pathJoin(reactAppBuildDirPath, resolvedViteConfig.assetsDir);
+        })(),
+        "doBuildRetrocompatAccountTheme": parsedPackageJson.keycloakify?.doBuildRetrocompatAccountTheme ?? true
+    };
+}

package/src/bin/keycloakify/buildOptions/getKeycloakifyBuildDirPath.ts

@@ -0,0 +1,33 @@
+import { getAbsoluteAndInOsFormatPath } from "../../tools/getAbsoluteAndInOsFormatPath";
+import { join as pathJoin } from "path";
+
+export function getKeycloakifyBuildDirPath(params: {
+    reactAppRootDirPath: string;
+    parsedPackageJson_keycloakify_keycloakifyBuildDirPath: string | undefined;
+    bundler: "vite" | "webpack";
+}) {
+    const { reactAppRootDirPath, parsedPackageJson_keycloakify_keycloakifyBuildDirPath, bundler } = params;
+
+    const keycloakifyBuildDirPath = (() => {
+        if (parsedPackageJson_keycloakify_keycloakifyBuildDirPath !== undefined) {
+            getAbsoluteAndInOsFormatPath({
+                "pathIsh": parsedPackageJson_keycloakify_keycloakifyBuildDirPath,
+                "cwd": reactAppRootDirPath
+            });
+        }
+
+        return pathJoin(
+            reactAppRootDirPath,
+            `${(() => {
+                switch (bundler) {
+                    case "vite":
+                        return "dist";
+                    case "webpack":
+                        return "build";
+                }
+            })()}_keycloak`
+        );
+    })();
+
+    return { keycloakifyBuildDirPath };
+}

package/src/bin/keycloakify/buildOptions/index.ts

@@ -0,0 +1 @@
+export * from "./buildOptions";

package/src/bin/keycloakify/{parsedPackageJson.ts → buildOptions/parsedPackageJson.ts}

@@ -2,7 +2,7 @@ import * as fs from "fs";
 import { assert } from "tsafe";
 import type { Equals } from "tsafe";
 import { z } from "zod";
-import { pathJoin } from "../tools/pathJoin";
+import { join as pathJoin } from "path";
 
 export type ParsedPackageJson = {
     name: string;
@@ -10,7 +10,6 @@ export type ParsedPackageJson = {
     homepage?: string;
     keycloakify?: {
         extraThemeProperties?: string[];
-        areAppAndKeycloakServerSharingSameDomain?: boolean;
         artifactId?: string;
         groupId?: string;
         doCreateJar?: boolean;
@@ -22,14 +21,13 @@ export type ParsedPackageJson = {
     };
 };
 
-export const zParsedPackageJson = z.object({
+const zParsedPackageJson = z.object({
     "name": z.string(),
     "version": z.string().optional(),
     "homepage": z.string().optional(),
     "keycloakify": z
         .object({
             "extraThemeProperties": z.array(z.string()).optional(),
-            "areAppAndKeycloakServerSharingSameDomain": z.boolean().optional(),
             "artifactId": z.string().optional(),
             "groupId": z.string().optional(),
             "doCreateJar": z.boolean().optional(),
@@ -44,8 +42,8 @@ export const zParsedPackageJson = z.object({
 
 assert<Equals<ReturnType<(typeof zParsedPackageJson)["parse"]>, ParsedPackageJson>>();
 
-let parsedPackageJson: undefined | ReturnType<(typeof zParsedPackageJson)["parse"]>;
-export function getParsedPackageJson(params: { reactAppRootDirPath: string }) {
+let parsedPackageJson: undefined | ParsedPackageJson;
+export function readParsedPackageJson(params: { reactAppRootDirPath: string }) {
     const { reactAppRootDirPath } = params;
     if (parsedPackageJson) {
         return parsedPackageJson;