keycloakify 10.0.0-rc.97 → 10.0.0

package/src/bin/initialize-account-theme/updateAccountThemeImplementationInConfig.ts

@@ -0,0 +1,92 @@
+import { join as pathJoin } from "path";
+import { assert, type Equals } from "tsafe/assert";
+import type { BuildContext } from "../shared/buildContext";
+import * as fs from "fs";
+import chalk from "chalk";
+import { z } from "zod";
+import { id } from "tsafe/id";
+
+export type BuildContextLike = {
+    bundler: BuildContext["bundler"];
+};
+
+assert<BuildContext extends BuildContextLike ? true : false>();
+
+export function updateAccountThemeImplementationInConfig(params: {
+    buildContext: BuildContext;
+    accountThemeType: "Single-Page" | "Multi-Page";
+}) {
+    const { buildContext, accountThemeType } = params;
+
+    switch (buildContext.bundler) {
+        case "vite":
+            {
+                const viteConfigPath = pathJoin(
+                    buildContext.projectDirPath,
+                    "vite.config.ts"
+                );
+
+                if (!fs.existsSync(viteConfigPath)) {
+                    console.log(
+                        chalk.bold(
+                            `You must manually set the accountThemeImplementation to "${accountThemeType}" in your vite config`
+                        )
+                    );
+                    break;
+                }
+
+                const viteConfigContent = fs
+                    .readFileSync(viteConfigPath)
+                    .toString("utf8");
+
+                const modifiedViteConfigContent = viteConfigContent.replace(
+                    /accountThemeImplementation\s*:\s*"none"/,
+                    `accountThemeImplementation: "${accountThemeType}"`
+                );
+
+                if (modifiedViteConfigContent === viteConfigContent) {
+                    console.log(
+                        chalk.bold(
+                            `You must manually set the accountThemeImplementation to "${accountThemeType}" in your vite.config.ts`
+                        )
+                    );
+                    break;
+                }
+
+                fs.writeFileSync(viteConfigPath, modifiedViteConfigContent);
+            }
+            break;
+        case "webpack":
+            {
+                const parsedPackageJson = (() => {
+                    type ParsedPackageJson = {
+                        keycloakify: Record<string, string>;
+                    };
+
+                    const zParsedPackageJson = (() => {
+                        type TargetType = ParsedPackageJson;
+
+                        const zTargetType = z.object({
+                            keycloakify: z.record(z.string())
+                        });
+
+                        assert<Equals<z.infer<typeof zTargetType>, TargetType>>();
+
+                        return id<z.ZodType<TargetType>>(zTargetType);
+                    })();
+
+                    return zParsedPackageJson.parse(
+                        JSON.parse(
+                            fs
+                                .readFileSync(buildContext.packageJsonFilePath)
+                                .toString("utf8")
+                        )
+                    );
+                })();
+
+                parsedPackageJson.keycloakify.accountThemeImplementation =
+                    accountThemeType;
+            }
+            break;
+    }
+}

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

@@ -30,7 +30,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
         // NOTE: This is arbitrary
         startingFromMajor: 17,
         excludeMajorVersions: [],
-        cacheDirPath: buildContext.cacheDirPath
+        buildContext
     });
 
     const { defaultThemeDirPath } = await downloadKeycloakDefaultTheme({

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

@@ -7,7 +7,7 @@ import { join as pathJoin, dirname as pathDirname } from "path";
 import { transformCodebase } from "../../tools/transformCodebase";
 import type { BuildContext } from "../../shared/buildContext";
 import * as fs from "fs/promises";
-import { accountV1ThemeName } from "../../shared/constants";
+import { ACCOUNT_V1_THEME_NAME } from "../../shared/constants";
 import {
     generatePom,
     BuildContextLike as BuildContextLike_generatePom
@@ -24,6 +24,7 @@ export type BuildContextLike = BuildContextLike_generatePom & {
     artifactId: string;
     themeVersion: string;
     cacheDirPath: string;
+    implementedThemeTypes: BuildContext["implementedThemeTypes"];
 };
 
 assert<BuildContext extends BuildContextLike ? true : false>();
@@ -33,6 +34,7 @@ export async function buildJar(params: {
     keycloakAccountV1Version: KeycloakAccountV1Version;
     keycloakThemeAdditionalInfoExtensionVersion: KeycloakThemeAdditionalInfoExtensionVersion;
     resourcesDirPath: string;
+    doesImplementAccountV1Theme: boolean;
     buildContext: BuildContextLike;
 }): Promise<void> {
     const {
@@ -40,28 +42,30 @@ export async function buildJar(params: {
         keycloakAccountV1Version,
         keycloakThemeAdditionalInfoExtensionVersion,
         resourcesDirPath,
+        doesImplementAccountV1Theme,
         buildContext
     } = params;
 
-    const keycloakifyBuildTmpDirPath = pathJoin(
+    const keycloakifyBuildCacheDirPath = pathJoin(
         buildContext.cacheDirPath,
+        "maven",
         jarFileBasename.replace(".jar", "")
     );
 
-    rmSync(keycloakifyBuildTmpDirPath, { recursive: true, force: true });
-
     const tmpResourcesDirPath = pathJoin(
-        keycloakifyBuildTmpDirPath,
+        keycloakifyBuildCacheDirPath,
         "src",
         "main",
         "resources"
     );
 
+    rmSync(tmpResourcesDirPath, { recursive: true, force: true });
+
     transformCodebase({
         srcDirPath: resourcesDirPath,
         destDirPath: tmpResourcesDirPath,
         transformSourceCode:
-            keycloakAccountV1Version !== null
+            !doesImplementAccountV1Theme || keycloakAccountV1Version !== null
                 ? undefined
                 : (params: {
                       fileRelativePath: string;
@@ -71,7 +75,7 @@ export async function buildJar(params: {
 
                       if (
                           isInside({
-                              dirPath: pathJoin("theme", accountV1ThemeName),
+                              dirPath: pathJoin("theme", ACCOUNT_V1_THEME_NAME),
                               filePath: fileRelativePath
                           })
                       ) {
@@ -87,7 +91,7 @@ export async function buildJar(params: {
                                   sourceCode
                                       .toString("utf8")
                                       .replace(
-                                          `parent=${accountV1ThemeName}`,
+                                          `parent=${ACCOUNT_V1_THEME_NAME}`,
                                           "parent=keycloak"
                                       ),
                                   "utf8"
@@ -105,14 +109,24 @@ export async function buildJar(params: {
                   }
     });
 
-    if (keycloakAccountV1Version === null) {
+    remove_account_v1_in_meta_inf: {
+        if (!doesImplementAccountV1Theme) {
+            // NOTE: We do not have account v1 anyway
+            break remove_account_v1_in_meta_inf;
+        }
+
+        if (keycloakAccountV1Version !== null) {
+            // NOTE: No, we need to keep account-v1 in meta-inf
+            break remove_account_v1_in_meta_inf;
+        }
+
         writeMetaInfKeycloakThemes({
             resourcesDirPath: tmpResourcesDirPath,
             getNewMetaInfKeycloakTheme: ({ metaInfKeycloakTheme }) => {
                 assert(metaInfKeycloakTheme !== undefined);
 
                 metaInfKeycloakTheme.themes = metaInfKeycloakTheme.themes.filter(
-                    ({ name }) => name !== accountV1ThemeName
+                    ({ name }) => name !== ACCOUNT_V1_THEME_NAME
                 );
 
                 return metaInfKeycloakTheme;
@@ -121,6 +135,10 @@ export async function buildJar(params: {
     }
 
     route_legacy_pages: {
+        if (!buildContext.implementedThemeTypes.login.isImplemented) {
+            break route_legacy_pages;
+        }
+
         // NOTE: If there's no account theme there is no special target for keycloak 24 and up so we create
         // the pages anyway. If there is an account pages, since we know that account-v1 is only support keycloak
         // 24 in version 0.4 and up, we can safely break the route for legacy pages.
@@ -135,6 +153,7 @@ export async function buildJar(params: {
             }
         })();
 
+        // TODO: Remove this optimization, it's a bit hacky.
         if (doBreak) {
             break route_legacy_pages;
         }
@@ -142,10 +161,7 @@ export async function buildJar(params: {
         (["register.ftl", "login-update-profile.ftl"] as const).forEach(pageId =>
             buildContext.themeNames.map(themeName => {
                 const ftlFilePath = pathJoin(
-                    keycloakifyBuildTmpDirPath,
-                    "src",
-                    "main",
-                    "resources",
+                    tmpResourcesDirPath,
                     "theme",
                     themeName,
                     "login",
@@ -154,7 +170,7 @@ export async function buildJar(params: {
 
                 const ftlFileContent = readFileSync(ftlFilePath).toString("utf8");
 
-                const realPageId = (() => {
+                const ftlFileBasename = (() => {
                     switch (pageId) {
                         case "register.ftl":
                             return "register-user-profile.ftl";
@@ -165,14 +181,14 @@ export async function buildJar(params: {
                 })();
 
                 const modifiedFtlFileContent = ftlFileContent.replace(
-                    `kcContext.pageId = "\${pageId}";`,
-                    `kcContext.pageId = "${pageId}"; kcContext.realPageId = "${realPageId}";`
+                    `"ftlTemplateFileName": "${pageId}"`,
+                    `"ftlTemplateFileName": "${ftlFileBasename}"`
                 );
 
                 assert(modifiedFtlFileContent !== ftlFileContent);
 
                 fs.writeFile(
-                    pathJoin(pathDirname(ftlFilePath), realPageId),
+                    pathJoin(pathDirname(ftlFilePath), ftlFileBasename),
                     Buffer.from(modifiedFtlFileContent, "utf8")
                 );
             })
@@ -187,15 +203,15 @@ export async function buildJar(params: {
         });
 
         await fs.writeFile(
-            pathJoin(keycloakifyBuildTmpDirPath, "pom.xml"),
+            pathJoin(keycloakifyBuildCacheDirPath, "pom.xml"),
             Buffer.from(pomFileCode, "utf8")
         );
     }
 
     await new Promise<void>((resolve, reject) =>
         child_process.exec(
-            `mvn clean install -Dmaven.repo.local=${pathJoin(keycloakifyBuildTmpDirPath, ".m2")}`,
-            { cwd: keycloakifyBuildTmpDirPath },
+            `mvn install -Dmaven.repo.local="${pathJoin(keycloakifyBuildCacheDirPath, ".m2")}"`,
+            { cwd: keycloakifyBuildCacheDirPath },
             error => {
                 if (error !== null) {
                     console.error(
@@ -220,12 +236,10 @@ export async function buildJar(params: {
 
     await fs.rename(
         pathJoin(
-            keycloakifyBuildTmpDirPath,
+            keycloakifyBuildCacheDirPath,
             "target",
             `${buildContext.artifactId}-${buildContext.themeVersion}.jar`
         ),
         pathJoin(buildContext.keycloakifyBuildDirPath, jarFileBasename)
     );
-
-    rmSync(keycloakifyBuildTmpDirPath, { recursive: true });
 }

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

@@ -10,7 +10,7 @@ import type { BuildContext } from "../../shared/buildContext";
 export type BuildContextLike = BuildContextLike_buildJar & {
     projectDirPath: string;
     keycloakifyBuildDirPath: string;
-    recordIsImplementedByThemeType: BuildContext["recordIsImplementedByThemeType"];
+    implementedThemeTypes: BuildContext["implementedThemeTypes"];
     jarTargets: BuildContext["jarTargets"];
 };
 
@@ -22,7 +22,9 @@ export async function buildJars(params: {
 }): Promise<void> {
     const { resourcesDirPath, buildContext } = params;
 
-    const doesImplementAccountTheme = buildContext.recordIsImplementedByThemeType.account;
+    const doesImplementAccountV1Theme =
+        buildContext.implementedThemeTypes.account.isImplemented &&
+        buildContext.implementedThemeTypes.account.type === "Multi-Page";
 
     await Promise.all(
         keycloakAccountV1Versions
@@ -30,7 +32,7 @@ export async function buildJars(params: {
                 keycloakThemeAdditionalInfoExtensionVersions.map(
                     keycloakThemeAdditionalInfoExtensionVersion => {
                         const keycloakVersionRange = getKeycloakVersionRangeForJar({
-                            doesImplementAccountTheme,
+                            doesImplementAccountV1Theme,
                             keycloakAccountV1Version,
                             keycloakThemeAdditionalInfoExtensionVersion
                         });
@@ -55,6 +57,7 @@ export async function buildJars(params: {
                             keycloakAccountV1Version,
                             keycloakThemeAdditionalInfoExtensionVersion,
                             resourcesDirPath,
+                            doesImplementAccountV1Theme,
                             buildContext
                         });
                     }

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

@@ -6,17 +6,17 @@ import type {
 import type { KeycloakVersionRange } from "../../shared/KeycloakVersionRange";
 
 export function getKeycloakVersionRangeForJar(params: {
-    doesImplementAccountTheme: boolean;
+    doesImplementAccountV1Theme: boolean;
     keycloakAccountV1Version: KeycloakAccountV1Version;
     keycloakThemeAdditionalInfoExtensionVersion: KeycloakThemeAdditionalInfoExtensionVersion;
 }): KeycloakVersionRange | undefined {
     const {
         keycloakAccountV1Version,
         keycloakThemeAdditionalInfoExtensionVersion,
-        doesImplementAccountTheme
+        doesImplementAccountV1Theme
     } = params;
 
-    if (doesImplementAccountTheme) {
+    if (doesImplementAccountV1Theme) {
         const keycloakVersionRange = (() => {
             switch (keycloakAccountV1Version) {
                 case null:
@@ -63,7 +63,7 @@ export function getKeycloakVersionRangeForJar(params: {
         assert<
             Equals<
                 typeof keycloakVersionRange,
-                KeycloakVersionRange.WithAccountTheme | undefined
+                KeycloakVersionRange.WithAccountV1Theme | undefined
             >
         >();
 
@@ -87,7 +87,7 @@ export function getKeycloakVersionRangeForJar(params: {
         assert<
             Equals<
                 typeof keycloakVersionRange,
-                KeycloakVersionRange.WithoutAccountTheme | undefined
+                KeycloakVersionRange.WithoutAccountV1Theme | undefined
             >
         >();
 

package/src/bin/keycloakify/generateFtl/generateFtl.ts

@@ -1,4 +1,4 @@
-import cheerio from "cheerio";
+import * as cheerio from "cheerio";
 import {
     replaceImportsInJsCode,
     BuildContextLike as BuildContextLike_replaceImportsInJsCode
@@ -13,8 +13,8 @@ import type { BuildContext } from "../../shared/buildContext";
 import { assert } from "tsafe/assert";
 import {
     type ThemeType,
-    basenameOfTheKeycloakifyResourcesDir,
-    resources_common
+    BASENAME_OF_KEYCLOAKIFY_RESOURCES_DIR,
+    RESOURCES_COMMON
 } from "../../shared/constants";
 import { getThisCodebaseRootDirPath } from "../../tools/getThisCodebaseRootDirPath";
 
@@ -77,7 +77,8 @@ export function generateFtlFilesCodeFactory(params: {
         (
             [
                 ["link", "href"],
-                ["script", "src"]
+                ["script", "src"],
+                ["script", "data-src"]
             ] as const
         ).forEach(([selector, attrName]) =>
             $(selector).each((...[, element]) => {
@@ -93,7 +94,7 @@ export function generateFtlFilesCodeFactory(params: {
                         new RegExp(
                             `^${(buildContext.urlPathname ?? "/").replace(/\//g, "\\/")}`
                         ),
-                        `\${url.resourcesPath}/${basenameOfTheKeycloakifyResourcesDir}/`
+                        `\${xKeycloakify.resourcesPath}/${BASENAME_OF_KEYCLOAKIFY_RESOURCES_DIR}/`
                     )
                 );
             })
@@ -113,19 +114,17 @@ export function generateFtlFilesCodeFactory(params: {
             )
         )
         .toString("utf8")
+        .replace("{{themeType}}", themeType)
+        .replace("{{themeName}}", themeName)
+        .replace("{{keycloakifyVersion}}", keycloakifyVersion)
+        .replace("{{themeVersion}}", buildContext.themeVersion)
+        .replace("{{fieldNames}}", fieldNames.map(name => `"${name}"`).join(", "))
+        .replace("{{RESOURCES_COMMON}}", RESOURCES_COMMON)
         .replace(
-            "FIELD_NAMES_eKsIY4ZsZ4xeM",
-            fieldNames.map(name => `"${name}"`).join(", ")
-        )
-        .replace("KEYCLOAKIFY_VERSION_xEdKd3xEdr", keycloakifyVersion)
-        .replace("KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx", buildContext.themeVersion)
-        .replace("KEYCLOAKIFY_THEME_TYPE_dExKd3xEdr", themeType)
-        .replace("KEYCLOAKIFY_THEME_NAME_cXxKd3xEer", themeName)
-        .replace("RESOURCES_COMMON_cLsLsMrtDkpVv", resources_common)
-        .replace(
-            "USER_DEFINED_EXCLUSIONS_eKsaY4ZsZ4eMr2",
+            "{{userDefinedExclusions}}",
             buildContext.kcContextExclusionsFtlCode ?? ""
         );
+
     const ftlObjectToJsCodeDeclaringAnObjectPlaceholder =
         '{ "x": "vIdLqMeOed9sdLdIdOxdK0d" }';
 
@@ -170,7 +169,8 @@ export function generateFtlFilesCodeFactory(params: {
         Object.entries({
             [ftlObjectToJsCodeDeclaringAnObjectPlaceholder]:
                 kcContextDeclarationTemplateFtl,
-            PAGE_ID_xIgLsPgGId9D8e: pageId
+            "{{pageId}}": pageId,
+            "{{ftlTemplateFileName}}": pageId
         }).map(
             ([searchValue, replaceValue]) =>
                 (ftlCode = ftlCode.replace(searchValue, replaceValue))