keycloakify 10.0.0-rc.3 → 10.0.0-rc.30

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

@@ -1,60 +1,69 @@
-#!/usr/bin/env node
-
-import { downloadBuiltinKeycloakTheme } from "./download-builtin-keycloak-theme";
+import { downloadKeycloakDefaultTheme } from "./shared/downloadKeycloakDefaultTheme";
 import { join as pathJoin, relative as pathRelative } from "path";
 import { transformCodebase } from "./tools/transformCodebase";
-import { promptKeycloakVersion } from "./promptKeycloakVersion";
-import { readBuildOptions } from "./keycloakify/buildOptions";
+import { promptKeycloakVersion } from "./shared/promptKeycloakVersion";
+import { readBuildOptions } from "./shared/buildOptions";
 import * as fs from "fs";
-import { getLogger } from "./tools/logger";
-import { getThemeSrcDirPath } from "./getThemeSrcDirPath";
-import { rmSync } from "./tools/fs.rmSync";
+import { getThemeSrcDirPath } from "./shared/getThemeSrcDirPath";
+import type { CliCommandOptions } from "./main";
 
-export async function main() {
-    const buildOptions = readBuildOptions({
-        "processArgv": process.argv.slice(2)
-    });
+export async function command(params: { cliCommandOptions: CliCommandOptions }) {
+    const { cliCommandOptions } = params;
 
-    const logger = getLogger({ "isSilent": buildOptions.isSilent });
+    const buildOptions = readBuildOptions({ cliCommandOptions });
 
     const { themeSrcDirPath } = getThemeSrcDirPath({
-        "reactAppRootDirPath": buildOptions.reactAppRootDirPath
+        reactAppRootDirPath: buildOptions.reactAppRootDirPath
     });
 
     const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
 
     if (fs.existsSync(emailThemeSrcDirPath)) {
-        logger.warn(`There is already a ${pathRelative(process.cwd(), emailThemeSrcDirPath)} directory in your project. Aborting.`);
+        console.warn(
+            `There is already a ${pathRelative(
+                process.cwd(),
+                emailThemeSrcDirPath
+            )} directory in your project. Aborting.`
+        );
 
         process.exit(-1);
     }
 
-    const { keycloakVersion } = await promptKeycloakVersion();
+    console.log("Initialize with the base email theme from which version of Keycloak?");
 
-    const builtinKeycloakThemeTmpDirPath = pathJoin(emailThemeSrcDirPath, "..", "tmp_xIdP3_builtin_keycloak_theme");
+    const { keycloakVersion } = await promptKeycloakVersion({
+        // NOTE: This is arbitrary
+        startingFromMajor: 17,
+        cacheDirPath: buildOptions.cacheDirPath
+    });
 
-    await downloadBuiltinKeycloakTheme({
+    const { defaultThemeDirPath } = await downloadKeycloakDefaultTheme({
         keycloakVersion,
-        "destDirPath": builtinKeycloakThemeTmpDirPath,
         buildOptions
     });
 
     transformCodebase({
-        "srcDirPath": pathJoin(builtinKeycloakThemeTmpDirPath, "base", "email"),
-        "destDirPath": emailThemeSrcDirPath
+        srcDirPath: pathJoin(defaultThemeDirPath, "base", "email"),
+        destDirPath: emailThemeSrcDirPath
     });
 
     {
         const themePropertyFilePath = pathJoin(emailThemeSrcDirPath, "theme.properties");
 
-        fs.writeFileSync(themePropertyFilePath, Buffer.from(`parent=base\n${fs.readFileSync(themePropertyFilePath).toString("utf8")}`, "utf8"));
+        fs.writeFileSync(
+            themePropertyFilePath,
+            Buffer.from(
+                `parent=base\n${fs.readFileSync(themePropertyFilePath).toString("utf8")}`,
+                "utf8"
+            )
+        );
     }
 
-    logger.log(`${pathRelative(process.cwd(), emailThemeSrcDirPath)} ready to be customized, feel free to remove every file you do not customize`);
-
-    rmSync(builtinKeycloakThemeTmpDirPath, { "recursive": true, "force": true });
-}
-
-if (require.main === module) {
-    main();
+    console.log(
+        `The \`${pathJoin(
+            ".",
+            pathRelative(process.cwd(), emailThemeSrcDirPath)
+        )}\` directory have been created.`
+    );
+    console.log("You can delete any file you don't modify.");
 }

package/src/bin/keycloakify/buildJars/buildJar.ts

@@ -1,20 +1,29 @@
 import { assert, type Equals } from "tsafe/assert";
-import type { KeycloakAccountV1Version, KeycloakThemeAdditionalInfoExtensionVersion } from "./extensionVersions";
+import type {
+    KeycloakAccountV1Version,
+    KeycloakThemeAdditionalInfoExtensionVersion
+} from "./extensionVersions";
 import { join as pathJoin, dirname as pathDirname } from "path";
 import { transformCodebase } from "../../tools/transformCodebase";
-import type { BuildOptions } from "../buildOptions";
+import type { BuildOptions } from "../../shared/buildOptions";
 import * as fs from "fs/promises";
-import { accountV1ThemeName } from "../../constants";
-import { generatePom, BuildOptionsLike as BuildOptionsLike_generatePom } from "./generatePom";
-import { existsSync, readFileSync } from "fs";
+import { accountV1ThemeName } from "../../shared/constants";
+import {
+    generatePom,
+    BuildOptionsLike as BuildOptionsLike_generatePom
+} from "./generatePom";
+import { readFileSync } from "fs";
 import { isInside } from "../../tools/isInside";
 import child_process from "child_process";
+import { rmSync } from "../../tools/fs.rmSync";
+import { getMetaInfKeycloakThemesJsonFilePath } from "../../shared/metaInfKeycloakThemes";
 
 export type BuildOptionsLike = BuildOptionsLike_generatePom & {
     keycloakifyBuildDirPath: string;
     themeNames: string[];
     artifactId: string;
     themeVersion: string;
+    cacheDirPath: string;
 };
 
 assert<BuildOptions extends BuildOptionsLike ? true : false>();
@@ -25,64 +34,152 @@ export async function buildJar(params: {
     keycloakThemeAdditionalInfoExtensionVersion: KeycloakThemeAdditionalInfoExtensionVersion;
     buildOptions: BuildOptionsLike;
 }): Promise<void> {
-    const { jarFileBasename, keycloakAccountV1Version, keycloakThemeAdditionalInfoExtensionVersion, buildOptions } = params;
+    const {
+        jarFileBasename,
+        keycloakAccountV1Version,
+        keycloakThemeAdditionalInfoExtensionVersion,
+        buildOptions
+    } = params;
 
-    const keycloakifyBuildTmpDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "..", jarFileBasename.replace(".jar", ""));
+    const keycloakifyBuildTmpDirPath = pathJoin(
+        buildOptions.cacheDirPath,
+        jarFileBasename.replace(".jar", "")
+    );
 
-    if (existsSync(keycloakifyBuildTmpDirPath)) {
-        await fs.rm(keycloakifyBuildTmpDirPath, { "recursive": true });
-    }
+    rmSync(keycloakifyBuildTmpDirPath, { recursive: true, force: true });
 
-    await fs.mkdir(keycloakifyBuildTmpDirPath, { "recursive": true });
-    await fs.writeFile(pathJoin(keycloakifyBuildTmpDirPath, ".gitignore"), Buffer.from("*", "utf8"));
+    {
+        const transformCodebase_common = (params: {
+            fileRelativePath: string;
+            sourceCode: Buffer;
+        }): { modifiedSourceCode: Buffer } | undefined => {
+            const { fileRelativePath, sourceCode } = params;
 
-    const srcMainResourcesRelativeDirPath = pathJoin("src", "main", "resources");
+            if (
+                fileRelativePath ===
+                getMetaInfKeycloakThemesJsonFilePath({ keycloakifyBuildDirPath: "." })
+            ) {
+                return { modifiedSourceCode: sourceCode };
+            }
 
-    {
-        const keycloakThemesJsonFilePath = pathJoin(srcMainResourcesRelativeDirPath, "META-INF", "keycloak-themes.json");
+            for (const themeName of [...buildOptions.themeNames, accountV1ThemeName]) {
+                if (
+                    isInside({
+                        dirPath: pathJoin("src", "main", "resources", "theme", themeName),
+                        filePath: fileRelativePath
+                    })
+                ) {
+                    return { modifiedSourceCode: sourceCode };
+                }
+            }
 
-        const themePropertiesFilePathSet = new Set(
-            ...buildOptions.themeNames.map(themeName => pathJoin(srcMainResourcesRelativeDirPath, "theme", themeName, "account", "theme.properties"))
-        );
+            return undefined;
+        };
 
-        const accountV1RelativeDirPath = pathJoin(srcMainResourcesRelativeDirPath, "theme", accountV1ThemeName);
+        const transformCodebase_patchForUsingBuiltinAccountV1 =
+            keycloakAccountV1Version !== null
+                ? undefined
+                : (params: {
+                      fileRelativePath: string;
+                      sourceCode: Buffer;
+                  }): { modifiedSourceCode: Buffer } | undefined => {
+                      const { fileRelativePath, sourceCode } = params;
 
-        transformCodebase({
-            "srcDirPath": buildOptions.keycloakifyBuildDirPath,
-            "destDirPath": keycloakifyBuildTmpDirPath,
-            "transformSourceCode":
-                keycloakAccountV1Version !== null
-                    ? undefined
-                    : ({ fileRelativePath, sourceCode }) => {
-                          if (fileRelativePath === keycloakThemesJsonFilePath) {
-                              const keycloakThemesJsonParsed = JSON.parse(sourceCode.toString("utf8")) as {
-                                  themes: { name: string; types: string[] }[];
-                              };
-
-                              keycloakThemesJsonParsed.themes = keycloakThemesJsonParsed.themes.filter(({ name }) => name !== accountV1ThemeName);
-
-                              return { "modifiedSourceCode": Buffer.from(JSON.stringify(keycloakThemesJsonParsed, null, 2), "utf8") };
-                          }
+                      if (
+                          isInside({
+                              dirPath: pathJoin(
+                                  "src",
+                                  "main",
+                                  "resources",
+                                  "theme",
+                                  accountV1ThemeName
+                              ),
+                              filePath: fileRelativePath
+                          })
+                      ) {
+                          return undefined;
+                      }
 
-                          if (isInside({ "dirPath": "target", "filePath": fileRelativePath })) {
-                              return undefined;
-                          }
+                      if (
+                          fileRelativePath ===
+                          getMetaInfKeycloakThemesJsonFilePath({
+                              keycloakifyBuildDirPath: "."
+                          })
+                      ) {
+                          const keycloakThemesJsonParsed = JSON.parse(
+                              sourceCode.toString("utf8")
+                          ) as {
+                              themes: { name: string; types: string[] }[];
+                          };
 
-                          if (isInside({ "dirPath": accountV1RelativeDirPath, "filePath": fileRelativePath })) {
-                              return undefined;
-                          }
+                          keycloakThemesJsonParsed.themes =
+                              keycloakThemesJsonParsed.themes.filter(
+                                  ({ name }) => name !== accountV1ThemeName
+                              );
 
-                          if (themePropertiesFilePathSet.has(fileRelativePath)) {
-                              return {
-                                  "modifiedSourceCode": Buffer.from(
-                                      sourceCode.toString("utf8").replace(`parent=${accountV1ThemeName}`, "parent=keycloak"),
-                                      "utf8"
-                                  )
-                              };
-                          }
+                          return {
+                              modifiedSourceCode: Buffer.from(
+                                  JSON.stringify(keycloakThemesJsonParsed, null, 2),
+                                  "utf8"
+                              )
+                          };
+                      }
+
+                      for (const themeName of buildOptions.themeNames) {
+                          if (
+                              fileRelativePath ===
+                              pathJoin(
+                                  "src",
+                                  "main",
+                                  "resources",
+                                  "theme",
+                                  themeName,
+                                  "account",
+                                  "theme.properties"
+                              )
+                          ) {
+                              const modifiedSourceCode = Buffer.from(
+                                  sourceCode
+                                      .toString("utf8")
+                                      .replace(
+                                          `parent=${accountV1ThemeName}`,
+                                          "parent=keycloak"
+                                      ),
+                                  "utf8"
+                              );
 
-                          return { "modifiedSourceCode": sourceCode };
+                              assert(
+                                  Buffer.compare(modifiedSourceCode, sourceCode) !== 0
+                              );
+
+                              return { modifiedSourceCode };
+                          }
                       }
+
+                      return { modifiedSourceCode: sourceCode };
+                  };
+
+        transformCodebase({
+            srcDirPath: buildOptions.keycloakifyBuildDirPath,
+            destDirPath: keycloakifyBuildTmpDirPath,
+            transformSourceCode: params => {
+                const resultCommon = transformCodebase_common(params);
+
+                if (transformCodebase_patchForUsingBuiltinAccountV1 === undefined) {
+                    return resultCommon;
+                }
+
+                if (resultCommon === undefined) {
+                    return undefined;
+                }
+
+                const { modifiedSourceCode } = resultCommon;
+
+                return transformCodebase_patchForUsingBuiltinAccountV1({
+                    ...params,
+                    sourceCode: modifiedSourceCode
+                });
+            }
         });
     }
 
@@ -107,7 +204,16 @@ export async function buildJar(params: {
 
         (["register.ftl", "login-update-profile.ftl"] as const).forEach(pageId =>
             buildOptions.themeNames.map(themeName => {
-                const ftlFilePath = pathJoin(keycloakifyBuildTmpDirPath, srcMainResourcesRelativeDirPath, "theme", themeName, "login", pageId);
+                const ftlFilePath = pathJoin(
+                    keycloakifyBuildTmpDirPath,
+                    "src",
+                    "main",
+                    "resources",
+                    "theme",
+                    themeName,
+                    "login",
+                    pageId
+                );
 
                 const ftlFileContent = readFileSync(ftlFilePath).toString("utf8");
 
@@ -128,7 +234,10 @@ export async function buildJar(params: {
 
                 assert(modifiedFtlFileContent !== ftlFileContent);
 
-                fs.writeFile(pathJoin(pathDirname(ftlFilePath), realPageId), Buffer.from(modifiedFtlFileContent, "utf8"));
+                fs.writeFile(
+                    pathJoin(pathDirname(ftlFilePath), realPageId),
+                    Buffer.from(modifiedFtlFileContent, "utf8")
+                );
             })
         );
     }
@@ -140,35 +249,46 @@ export async function buildJar(params: {
             keycloakThemeAdditionalInfoExtensionVersion
         });
 
-        await fs.writeFile(pathJoin(keycloakifyBuildTmpDirPath, "pom.xml"), Buffer.from(pomFileCode, "utf8"));
+        await fs.writeFile(
+            pathJoin(keycloakifyBuildTmpDirPath, "pom.xml"),
+            Buffer.from(pomFileCode, "utf8")
+        );
     }
 
     await new Promise<void>((resolve, reject) =>
-        child_process.exec("mvn clean install", { "cwd": keycloakifyBuildTmpDirPath }, error => {
-            if (error !== null) {
-                console.error(
-                    `Build jar failed: ${JSON.stringify(
-                        {
-                            jarFileBasename,
-                            keycloakAccountV1Version,
-                            keycloakThemeAdditionalInfoExtensionVersion
-                        },
-                        null,
-                        2
-                    )}`
-                );
+        child_process.exec(
+            `mvn clean install -Dmaven.repo.local=${pathJoin(keycloakifyBuildTmpDirPath, ".m2")}`,
+            { cwd: keycloakifyBuildTmpDirPath },
+            error => {
+                if (error !== null) {
+                    console.error(
+                        `Build jar failed: ${JSON.stringify(
+                            {
+                                jarFileBasename,
+                                keycloakAccountV1Version,
+                                keycloakThemeAdditionalInfoExtensionVersion
+                            },
+                            null,
+                            2
+                        )}`
+                    );
 
-                reject(error);
-                return;
+                    reject(error);
+                    return;
+                }
+                resolve();
             }
-            resolve();
-        })
+        )
     );
 
     await fs.rename(
-        pathJoin(keycloakifyBuildTmpDirPath, "target", `${buildOptions.artifactId}-${buildOptions.themeVersion}.jar`),
+        pathJoin(
+            keycloakifyBuildTmpDirPath,
+            "target",
+            `${buildOptions.artifactId}-${buildOptions.themeVersion}.jar`
+        ),
         pathJoin(buildOptions.keycloakifyBuildDirPath, jarFileBasename)
     );
 
-    await fs.rm(keycloakifyBuildTmpDirPath, { "recursive": true });
+    rmSync(keycloakifyBuildTmpDirPath, { recursive: true });
 }

package/src/bin/keycloakify/buildJars/buildJars.ts

@@ -1,9 +1,15 @@
 import { assert } from "tsafe/assert";
 import { exclude } from "tsafe/exclude";
-import { keycloakAccountV1Versions, keycloakThemeAdditionalInfoExtensionVersions } from "./extensionVersions";
+import {
+    keycloakAccountV1Versions,
+    keycloakThemeAdditionalInfoExtensionVersions
+} from "./extensionVersions";
 import { getKeycloakVersionRangeForJar } from "./getKeycloakVersionRangeForJar";
 import { buildJar, BuildOptionsLike as BuildOptionsLike_buildJar } from "./buildJar";
-import type { BuildOptions } from "../buildOptions";
+import type { BuildOptions } from "../../shared/buildOptions";
+import { getJarFileBasename } from "../../shared/getJarFileBasename";
+import { readMetaInfKeycloakThemes } from "../../shared/metaInfKeycloakThemes";
+import { accountV1ThemeName } from "../../shared/constants";
 
 export type BuildOptionsLike = BuildOptionsLike_buildJar & {
     keycloakifyBuildDirPath: string;
@@ -12,12 +18,13 @@ export type BuildOptionsLike = BuildOptionsLike_buildJar & {
 assert<BuildOptions extends BuildOptionsLike ? true : false>();
 
 export async function buildJars(params: {
-    doesImplementAccountTheme: boolean;
     buildOptions: BuildOptionsLike;
-}): Promise<{ lastJarFileBasename: string }> {
-    const { doesImplementAccountTheme, buildOptions } = params;
+}): Promise<void> {
+    const { buildOptions } = params;
 
-    let lastJarFileBasename: string | undefined = undefined;
+    const doesImplementAccountTheme = readMetaInfKeycloakThemes({
+        keycloakifyBuildDirPath: buildOptions.keycloakifyBuildDirPath
+    }).themes.some(({ name }) => name === accountV1ThemeName);
 
     await Promise.all(
         keycloakAccountV1Versions
@@ -34,29 +41,40 @@ export async function buildJars(params: {
                             return undefined;
                         }
 
-                        return { keycloakThemeAdditionalInfoExtensionVersion, keycloakVersionRange };
+                        return {
+                            keycloakThemeAdditionalInfoExtensionVersion,
+                            keycloakVersionRange
+                        };
                     })
                     .filter(exclude(undefined))
-                    .map(({ keycloakThemeAdditionalInfoExtensionVersion, keycloakVersionRange }) => {
-                        const jarFileBasename = `keycloak-theme-for-kc-${keycloakVersionRange}.jar`;
-
-                        lastJarFileBasename = jarFileBasename;
+                    .map(
+                        ({
+                            keycloakThemeAdditionalInfoExtensionVersion,
+                            keycloakVersionRange
+                        }) => {
+                            const { jarFileBasename } = getJarFileBasename({
+                                keycloakVersionRange
+                            });
 
-                        return { keycloakThemeAdditionalInfoExtensionVersion, jarFileBasename };
-                    })
-                    .map(({ keycloakThemeAdditionalInfoExtensionVersion, jarFileBasename }) =>
-                        buildJar({
-                            jarFileBasename,
-                            keycloakAccountV1Version,
+                            return {
+                                keycloakThemeAdditionalInfoExtensionVersion,
+                                jarFileBasename
+                            };
+                        }
+                    )
+                    .map(
+                        ({
                             keycloakThemeAdditionalInfoExtensionVersion,
-                            buildOptions
-                        })
+                            jarFileBasename
+                        }) =>
+                            buildJar({
+                                jarFileBasename,
+                                keycloakAccountV1Version,
+                                keycloakThemeAdditionalInfoExtensionVersion,
+                                buildOptions
+                            })
                     )
             )
             .flat()
     );
-
-    assert(lastJarFileBasename !== undefined);
-
-    return { lastJarFileBasename };
 }

package/src/bin/keycloakify/buildJars/extensionVersions.ts

@@ -13,4 +13,5 @@ export const keycloakThemeAdditionalInfoExtensionVersions = [null, "1.1.5"] as c
  * https://central.sonatype.com/artifact/dev.jcputney/keycloak-theme-additional-info-extension
  * https://github.com/jcputney/keycloak-theme-additional-info-extension
  * */
-export type KeycloakThemeAdditionalInfoExtensionVersion = (typeof keycloakThemeAdditionalInfoExtensionVersions)[number];
+export type KeycloakThemeAdditionalInfoExtensionVersion =
+    (typeof keycloakThemeAdditionalInfoExtensionVersions)[number];

package/src/bin/keycloakify/buildJars/generatePom.ts

@@ -1,6 +1,9 @@
 import { assert } from "tsafe/assert";
-import type { BuildOptions } from "../buildOptions";
-import type { KeycloakAccountV1Version, KeycloakThemeAdditionalInfoExtensionVersion } from "./extensionVersions";
+import type { BuildOptions } from "../../shared/buildOptions";
+import type {
+    KeycloakAccountV1Version,
+    KeycloakThemeAdditionalInfoExtensionVersion
+} from "./extensionVersions";
 
 export type BuildOptionsLike = {
     groupId: string;
@@ -15,7 +18,11 @@ export function generatePom(params: {
     keycloakThemeAdditionalInfoExtensionVersion: KeycloakThemeAdditionalInfoExtensionVersion;
     buildOptions: BuildOptionsLike;
 }) {
-    const { keycloakAccountV1Version, keycloakThemeAdditionalInfoExtensionVersion, buildOptions } = params;
+    const {
+        keycloakAccountV1Version,
+        keycloakThemeAdditionalInfoExtensionVersion,
+        buildOptions
+    } = params;
 
     const { pomFileCode } = (function generatePomFileCode(): {
         pomFileCode: string;
@@ -35,7 +42,8 @@ export function generatePom(params: {
             `  <properties>`,
             `    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>`,
             `  </properties>`,
-            ...(keycloakAccountV1Version !== null && keycloakThemeAdditionalInfoExtensionVersion !== null
+            ...(keycloakAccountV1Version !== null &&
+            keycloakThemeAdditionalInfoExtensionVersion !== null
                 ? [
                       `  <build>`,
                       `    <plugins>`,