keycloakify 10.0.0-rc.13 → 10.0.0-rc.131

package/src/bin/shared/constants.ts

@@ -1,20 +1,22 @@
-export const nameOfTheGlobal = "kcContext";
-export const keycloak_resources = "keycloak-resources";
-export const resources_common = "resources-common";
-export const lastKeycloakVersionWithAccountV1 = "21.1.2";
-export const basenameOfTheKeycloakifyResourcesDir = "build";
+export const KEYCLOAK_RESOURCES = "keycloak-resources";
+export const RESOURCES_COMMON = "resources-common";
+export const LAST_KEYCLOAK_VERSION_WITH_ACCOUNT_V1 = "21.1.2";
+export const BASENAME_OF_KEYCLOAKIFY_RESOURCES_DIR = "dist";
 
-export const themeTypes = ["login", "account"] as const;
-export const accountV1ThemeName = "account-v1";
+export const THEME_TYPES = ["login", "account"] as const;
+export const ACCOUNT_V1_THEME_NAME = "account-v1";
 
-export type ThemeType = (typeof themeTypes)[number];
+export type ThemeType = (typeof THEME_TYPES)[number];
 
-export const vitePluginSubScriptEnvNames = {
-    "runPostBuildScript": "KEYCLOAKIFY_RUN_POST_BUILD_SCRIPT",
-    "resolveViteConfig": "KEYCLOAKIFY_RESOLVE_VITE_CONFIG"
+export const VITE_PLUGIN_SUB_SCRIPTS_ENV_NAMES = {
+    RUN_POST_BUILD_SCRIPT: "KEYCLOAKIFY_RUN_POST_BUILD_SCRIPT",
+    RESOLVE_VITE_CONFIG: "KEYCLOAKIFY_RESOLVE_VITE_CONFIG"
 } as const;
 
-export const loginThemePageIds = [
+export const BUILD_FOR_KEYCLOAK_MAJOR_VERSION_ENV_NAME =
+    "KEYCLOAKIFY_BUILD_FOR_KEYCLOAK_MAJOR_VERSION";
+
+export const LOGIN_THEME_PAGE_IDS = [
     "login.ftl",
     "login-username.ftl",
     "login-password.ftl",
@@ -51,7 +53,7 @@ export const loginThemePageIds = [
     "webauthn-error.ftl"
 ] as const;
 
-export const accountThemePageIds = [
+export const ACCOUNT_THEME_PAGE_IDS = [
     "password.ftl",
     "account.ftl",
     "sessions.ftl",
@@ -61,5 +63,11 @@ export const accountThemePageIds = [
     "federatedIdentity.ftl"
 ] as const;
 
-export type LoginThemePageId = (typeof loginThemePageIds)[number];
-export type AccountThemePageId = (typeof accountThemePageIds)[number];
+export type LoginThemePageId = (typeof LOGIN_THEME_PAGE_IDS)[number];
+export type AccountThemePageId = (typeof ACCOUNT_THEME_PAGE_IDS)[number];
+
+export const CONTAINER_NAME = "keycloak-keycloakify";
+
+export const FALLBACK_LANGUAGE_TAG = "en";
+
+export const LOGIN_THEME_RESOURCES_FROMkEYCLOAK_VERSION_DEFAULT = "24.0.4";

package/src/bin/shared/copyKeycloakResourcesToPublic.ts

@@ -1,37 +1,43 @@
 import {
     downloadKeycloakStaticResources,
-    type BuildOptionsLike as BuildOptionsLike_downloadKeycloakStaticResources
+    type BuildContextLike as BuildContextLike_downloadKeycloakStaticResources
 } from "./downloadKeycloakStaticResources";
 import { join as pathJoin, relative as pathRelative } from "path";
-import { themeTypes, keycloak_resources, lastKeycloakVersionWithAccountV1 } from "../shared/constants";
+import {
+    THEME_TYPES,
+    KEYCLOAK_RESOURCES,
+    LAST_KEYCLOAK_VERSION_WITH_ACCOUNT_V1
+} from "../shared/constants";
 import { readThisNpmPackageVersion } from "../tools/readThisNpmPackageVersion";
 import { assert } from "tsafe/assert";
 import * as fs from "fs";
 import { rmSync } from "../tools/fs.rmSync";
-import type { BuildOptions } from "./buildOptions";
+import type { BuildContext } from "./buildContext";
 
-export type BuildOptionsLike = BuildOptionsLike_downloadKeycloakStaticResources & {
+export type BuildContextLike = BuildContextLike_downloadKeycloakStaticResources & {
     loginThemeResourcesFromKeycloakVersion: string;
     publicDirPath: string;
 };
 
-assert<BuildOptions extends BuildOptionsLike ? true : false>();
+assert<BuildContext extends BuildContextLike ? true : false>();
 
-export async function copyKeycloakResourcesToPublic(params: { buildOptions: BuildOptionsLike }) {
-    const { buildOptions } = params;
+export async function copyKeycloakResourcesToPublic(params: {
+    buildContext: BuildContextLike;
+}) {
+    const { buildContext } = params;
 
-    const destDirPath = pathJoin(buildOptions.publicDirPath, keycloak_resources);
+    const destDirPath = pathJoin(buildContext.publicDirPath, KEYCLOAK_RESOURCES);
 
     const keycloakifyBuildinfoFilePath = pathJoin(destDirPath, "keycloakify.buildinfo");
 
     const keycloakifyBuildinfoRaw = JSON.stringify(
         {
             destDirPath,
-            "keycloakifyVersion": readThisNpmPackageVersion(),
-            "buildOptions": {
-                "loginThemeResourcesFromKeycloakVersion": readThisNpmPackageVersion(),
-                "cacheDirPath": pathRelative(destDirPath, buildOptions.cacheDirPath),
-                "npmWorkspaceRootDirPath": pathRelative(destDirPath, buildOptions.npmWorkspaceRootDirPath)
+            keycloakifyVersion: readThisNpmPackageVersion(),
+            buildContext: {
+                loginThemeResourcesFromKeycloakVersion: readThisNpmPackageVersion(),
+                cacheDirPath: pathRelative(destDirPath, buildContext.cacheDirPath),
+                fetchOptions: buildContext.fetchOptions
             }
         },
         null,
@@ -43,7 +49,9 @@ export async function copyKeycloakResourcesToPublic(params: { buildOptions: Buil
             break skip_if_already_done;
         }
 
-        const keycloakifyBuildinfoRaw_previousRun = fs.readFileSync(keycloakifyBuildinfoFilePath).toString("utf8");
+        const keycloakifyBuildinfoRaw_previousRun = fs
+            .readFileSync(keycloakifyBuildinfoFilePath)
+            .toString("utf8");
 
         if (keycloakifyBuildinfoRaw_previousRun !== keycloakifyBuildinfoRaw) {
             break skip_if_already_done;
@@ -52,25 +60,25 @@ export async function copyKeycloakResourcesToPublic(params: { buildOptions: Buil
         return;
     }
 
-    rmSync(destDirPath, { "force": true, "recursive": true });
+    rmSync(destDirPath, { force: true, recursive: true });
 
-    fs.mkdirSync(destDirPath, { "recursive": true });
+    fs.mkdirSync(destDirPath, { recursive: true });
 
     fs.writeFileSync(pathJoin(destDirPath, ".gitignore"), Buffer.from("*", "utf8"));
 
-    for (const themeType of themeTypes) {
+    for (const themeType of THEME_TYPES) {
         await downloadKeycloakStaticResources({
-            "keycloakVersion": (() => {
+            keycloakVersion: (() => {
                 switch (themeType) {
                     case "login":
-                        return buildOptions.loginThemeResourcesFromKeycloakVersion;
+                        return buildContext.loginThemeResourcesFromKeycloakVersion;
                     case "account":
-                        return lastKeycloakVersionWithAccountV1;
+                        return LAST_KEYCLOAK_VERSION_WITH_ACCOUNT_V1;
                 }
             })(),
             themeType,
-            "themeDirPath": destDirPath,
-            buildOptions
+            themeDirPath: destDirPath,
+            buildContext
         });
     }
 
@@ -86,5 +94,8 @@ export async function copyKeycloakResourcesToPublic(params: { buildOptions: Buil
         )
     );
 
-    fs.writeFileSync(keycloakifyBuildinfoFilePath, Buffer.from(keycloakifyBuildinfoRaw, "utf8"));
+    fs.writeFileSync(
+        keycloakifyBuildinfoFilePath,
+        Buffer.from(keycloakifyBuildinfoRaw, "utf8")
+    );
 }

package/src/bin/shared/downloadKeycloakDefaultTheme.ts

@@ -0,0 +1,297 @@
+import { join as pathJoin, relative as pathRelative } from "path";
+import { type BuildContext } from "./buildContext";
+import { assert } from "tsafe/assert";
+import { LAST_KEYCLOAK_VERSION_WITH_ACCOUNT_V1 } from "./constants";
+import { downloadAndExtractArchive } from "../tools/downloadAndExtractArchive";
+
+export type BuildContextLike = {
+    cacheDirPath: string;
+    fetchOptions: BuildContext["fetchOptions"];
+};
+
+assert<BuildContext extends BuildContextLike ? true : false>();
+
+export async function downloadKeycloakDefaultTheme(params: {
+    keycloakVersion: string;
+    buildContext: BuildContextLike;
+}): Promise<{ defaultThemeDirPath: string }> {
+    const { keycloakVersion, buildContext } = params;
+
+    let kcNodeModulesKeepFilePaths: Set<string> | undefined = undefined;
+    let kcNodeModulesKeepFilePaths_lastAccountV1: Set<string> | undefined = undefined;
+
+    const { extractedDirPath } = await downloadAndExtractArchive({
+        url: `https://repo1.maven.org/maven2/org/keycloak/keycloak-themes/${keycloakVersion}/keycloak-themes-${keycloakVersion}.jar`,
+        cacheDirPath: buildContext.cacheDirPath,
+        fetchOptions: buildContext.fetchOptions,
+        uniqueIdOfOnArchiveFile: "downloadKeycloakDefaultTheme",
+        onArchiveFile: async params => {
+            const fileRelativePath = pathRelative("theme", params.fileRelativePath);
+
+            if (fileRelativePath.startsWith("..")) {
+                return;
+            }
+
+            const { readFile, writeFile } = params;
+
+            skip_keycloak_v2: {
+                if (!fileRelativePath.startsWith(pathJoin("keycloak.v2"))) {
+                    break skip_keycloak_v2;
+                }
+
+                return;
+            }
+
+            last_account_v1_transformations: {
+                if (LAST_KEYCLOAK_VERSION_WITH_ACCOUNT_V1 !== keycloakVersion) {
+                    break last_account_v1_transformations;
+                }
+
+                skip_web_modules: {
+                    if (
+                        !fileRelativePath.startsWith(
+                            pathJoin("keycloak", "common", "resources", "web_modules")
+                        )
+                    ) {
+                        break skip_web_modules;
+                    }
+
+                    return;
+                }
+
+                skip_lib: {
+                    if (
+                        !fileRelativePath.startsWith(
+                            pathJoin("keycloak", "common", "resources", "lib")
+                        )
+                    ) {
+                        break skip_lib;
+                    }
+
+                    return;
+                }
+
+                skip_node_modules: {
+                    const nodeModulesRelativeDirPath = pathJoin(
+                        "keycloak",
+                        "common",
+                        "resources",
+                        "node_modules"
+                    );
+
+                    if (!fileRelativePath.startsWith(nodeModulesRelativeDirPath)) {
+                        break skip_node_modules;
+                    }
+
+                    if (kcNodeModulesKeepFilePaths_lastAccountV1 === undefined) {
+                        kcNodeModulesKeepFilePaths_lastAccountV1 = new Set([
+                            pathJoin("patternfly", "dist", "css", "patternfly.min.css"),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "css",
+                                "patternfly-additions.min.css"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "OpenSans-Regular-webfont.woff2"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "OpenSans-Bold-webfont.woff2"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "OpenSans-Light-webfont.woff2"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "OpenSans-Semibold-webfont.woff2"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "PatternFlyIcons-webfont.ttf"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "PatternFlyIcons-webfont.woff"
+                            )
+                        ]);
+                    }
+
+                    const fileRelativeToNodeModulesPath = fileRelativePath.substring(
+                        nodeModulesRelativeDirPath.length + 1
+                    );
+
+                    if (
+                        kcNodeModulesKeepFilePaths_lastAccountV1.has(
+                            fileRelativeToNodeModulesPath
+                        )
+                    ) {
+                        break skip_node_modules;
+                    }
+
+                    return;
+                }
+
+                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_unused_resources: {
+                if (keycloakVersion !== "24.0.4") {
+                    break skip_unused_resources;
+                }
+
+                skip_node_modules: {
+                    const nodeModulesRelativeDirPath = pathJoin(
+                        "keycloak",
+                        "common",
+                        "resources",
+                        "node_modules"
+                    );
+
+                    if (!fileRelativePath.startsWith(nodeModulesRelativeDirPath)) {
+                        break skip_node_modules;
+                    }
+
+                    if (kcNodeModulesKeepFilePaths === undefined) {
+                        kcNodeModulesKeepFilePaths = new Set([
+                            pathJoin("@patternfly", "patternfly", "patternfly.min.css"),
+                            pathJoin("patternfly", "dist", "css", "patternfly.min.css"),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "css",
+                                "patternfly-additions.min.css"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "OpenSans-Regular-webfont.woff2"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "OpenSans-Light-webfont.woff2"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "OpenSans-Bold-webfont.woff2"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "OpenSans-Bold-webfont.woff"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "OpenSans-Bold-webfont.ttf"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "fontawesome-webfont.woff2"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "PatternFlyIcons-webfont.ttf"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "PatternFlyIcons-webfont.woff"
+                            ),
+                            pathJoin(
+                                "patternfly",
+                                "dist",
+                                "fonts",
+                                "OpenSans-Semibold-webfont.woff2"
+                            ),
+                            pathJoin("patternfly", "dist", "img", "bg-login.jpg"),
+                            pathJoin("jquery", "dist", "jquery.min.js")
+                        ]);
+                    }
+
+                    const fileRelativeToNodeModulesPath = fileRelativePath.substring(
+                        nodeModulesRelativeDirPath.length + 1
+                    );
+
+                    if (kcNodeModulesKeepFilePaths.has(fileRelativeToNodeModulesPath)) {
+                        break skip_node_modules;
+                    }
+
+                    return;
+                }
+
+                skip_vendor: {
+                    if (
+                        !fileRelativePath.startsWith(
+                            pathJoin("keycloak", "common", "resources", "vendor")
+                        )
+                    ) {
+                        break skip_vendor;
+                    }
+
+                    return;
+                }
+
+                skip_rollup_config: {
+                    if (
+                        fileRelativePath !==
+                        pathJoin("keycloak", "common", "resources", "rollup.config.js")
+                    ) {
+                        break skip_rollup_config;
+                    }
+
+                    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 { resources_common, type ThemeType } from "./constants";
-import type { BuildOptions } from "./buildOptions";
+import {
+    downloadKeycloakDefaultTheme,
+    type BuildContextLike as BuildContextLike_downloadKeycloakDefaultTheme
+} from "./downloadKeycloakDefaultTheme";
+import { RESOURCES_COMMON, type ThemeType } from "./constants";
+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 });
 }