keycloakify 7.12.7 → 7.13.0

package/src/bin/keycloakify/generateTheme/generateTheme.ts

@@ -9,6 +9,7 @@ import { isInside } from "../../tools/isInside";
 import type { BuildOptions } from "../BuildOptions";
 import { assert } from "tsafe/assert";
 import { downloadKeycloakStaticResources } from "./downloadKeycloakStaticResources";
+import { readFieldNameUsage } from "./readFieldNameUsage";
 
 export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.ExternalAssets;
 
@@ -19,7 +20,6 @@ export namespace BuildOptionsLike {
         extraAccountPages?: string[];
         extraThemeProperties?: string[];
         isSilent: boolean;
-        customUserAttributes: string[];
         themeVersion: string;
         keycloakVersionDefaultAssets: string;
     };
@@ -53,11 +53,12 @@ assert<BuildOptions extends BuildOptionsLike ? true : false>();
 export async function generateTheme(params: {
     reactAppBuildDirPath: string;
     keycloakThemeBuildingDirPath: string;
-    emailThemeSrcDirPath: string | undefined;
+    themeSrcDirPath: string | undefined;
+    keycloakifySrcDirPath: string;
     buildOptions: BuildOptionsLike;
     keycloakifyVersion: string;
-}): Promise<{ doBundlesEmailTemplate: boolean }> {
-    const { reactAppBuildDirPath, keycloakThemeBuildingDirPath, emailThemeSrcDirPath, buildOptions, keycloakifyVersion } = params;
+}): Promise<void> {
+    const { reactAppBuildDirPath, keycloakThemeBuildingDirPath, themeSrcDirPath, keycloakifySrcDirPath, buildOptions, keycloakifyVersion } = params;
 
     const getThemeDirPath = (themeType: ThemeType | "email") =>
         pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", buildOptions.themeName, themeType);
@@ -142,7 +143,12 @@ export async function generateTheme(params: {
                 "cssGlobalsToDefine": allCssGlobalsToDefine,
                 buildOptions,
                 keycloakifyVersion,
-                themeType
+                themeType,
+                "fieldNames": readFieldNameUsage({
+                    keycloakifySrcDirPath,
+                    themeSrcDirPath,
+                    themeType
+                })
             });
 
             return generateFtlFilesCode;
@@ -220,21 +226,20 @@ export async function generateTheme(params: {
         );
     }
 
-    let doBundlesEmailTemplate: boolean;
-
     email: {
-        if (emailThemeSrcDirPath === undefined) {
-            doBundlesEmailTemplate = false;
+        if (themeSrcDirPath === undefined) {
             break email;
         }
 
-        doBundlesEmailTemplate = true;
+        const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
+
+        if (!fs.existsSync(emailThemeSrcDirPath)) {
+            break email;
+        }
 
         transformCodebase({
             "srcDirPath": emailThemeSrcDirPath,
             "destDirPath": getThemeDirPath("email")
         });
     }
-
-    return { doBundlesEmailTemplate };
 }

package/src/bin/keycloakify/generateTheme/readFieldNameUsage.ts

@@ -0,0 +1,96 @@
+import { crawl } from "../../tools/crawl";
+import { removeDuplicates } from "evt/tools/reducers/removeDuplicates";
+import { join as pathJoin } from "path";
+import * as fs from "fs";
+import type { ThemeType } from "../generateFtl";
+import { exclude } from "tsafe/exclude";
+
+export function readFieldNameUsage(params: {
+    keycloakifySrcDirPath: string;
+    themeSrcDirPath: string | undefined;
+    themeType: ThemeType | "email";
+}): string[] {
+    const { keycloakifySrcDirPath, themeSrcDirPath, themeType } = params;
+
+    const fieldNames: string[] = [];
+
+    if (themeSrcDirPath === undefined) {
+        //If we can't detect the user theme directory we restore the fieldNames we had previously to prevent errors.
+        fieldNames.push(
+            ...[
+                "global",
+                "userLabel",
+                "username",
+                "email",
+                "firstName",
+                "lastName",
+                "password",
+                "password-confirm",
+                "totp",
+                "totpSecret",
+                "SAMLRequest",
+                "SAMLResponse",
+                "relayState",
+                "device_user_code",
+                "code",
+                "password-new",
+                "rememberMe",
+                "login",
+                "authenticationExecution",
+                "cancel-aia",
+                "clientDataJSON",
+                "authenticatorData",
+                "signature",
+                "credentialId",
+                "userHandle",
+                "error",
+                "authn_use_chk",
+                "authenticationExecution",
+                "isSetRetry",
+                "try-again",
+                "attestationObject",
+                "publicKeyCredentialId",
+                "authenticatorLabel"
+            ]
+        );
+    }
+
+    for (const srcDirPath of (
+        [
+            pathJoin(keycloakifySrcDirPath, themeType),
+            (() => {
+                if (themeSrcDirPath === undefined) {
+                    return undefined;
+                }
+
+                const srcDirPath = pathJoin(themeSrcDirPath, themeType);
+
+                if (!fs.existsSync(srcDirPath)) {
+                    return undefined;
+                }
+
+                return srcDirPath;
+            })()
+        ] as const
+    ).filter(exclude(undefined))) {
+        const filePaths = crawl(srcDirPath)
+            .filter(filePath => /\.(ts|tsx|js|jsx)$/.test(filePath))
+            .map(filePath => pathJoin(srcDirPath, filePath));
+
+        for (const filePath of filePaths) {
+            const rawSourceFile = fs.readFileSync(filePath).toString("utf8");
+
+            if (!rawSourceFile.includes("messagesPerField")) {
+                continue;
+            }
+
+            fieldNames.push(
+                ...Array.from(rawSourceFile.matchAll(/(?:(?:printIfExists)|(?:existsError)|(?:get)|(?:exists))\(["']([^"']+)["']/g), m => m[1])
+            );
+        }
+    }
+
+    const out = fieldNames.reduce(...removeDuplicates<string>());
+
+    return out;
+}

package/src/bin/keycloakify/keycloakify.ts

@@ -9,8 +9,9 @@ import { getLogger } from "../tools/logger";
 import jar from "../tools/jar";
 import { assert } from "tsafe/assert";
 import { Equals } from "tsafe";
-import { getEmailThemeSrcDirPath } from "../getSrcDirPath";
+import { getThemeSrcDirPath } from "../getSrcDirPath";
 import { getProjectRoot } from "../tools/getProjectRoot";
+import { objectKeys } from "tsafe/objectKeys";
 
 export async function main() {
     const projectDirPath = process.cwd();
@@ -23,42 +24,54 @@ export async function main() {
     const logger = getLogger({ "isSilent": buildOptions.isSilent });
     logger.log("🔏 Building the keycloak theme...⌚");
 
-    let doBundlesEmailTemplate: boolean | undefined;
+    const keycloakifyDirPath = getProjectRoot();
 
-    for (const themeName of [buildOptions.themeName, ...buildOptions.extraThemeNames]) {
-        const { doBundlesEmailTemplate: doBundlesEmailTemplate_ } = await generateTheme({
-            keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
-            "emailThemeSrcDirPath": (() => {
-                const { emailThemeSrcDirPath } = getEmailThemeSrcDirPath({ projectDirPath });
-
-                if (emailThemeSrcDirPath === undefined || !fs.existsSync(emailThemeSrcDirPath)) {
-                    return;
-                }
+    const { themeSrcDirPath } = getThemeSrcDirPath({ projectDirPath });
 
-                return emailThemeSrcDirPath;
-            })(),
+    for (const themeName of [buildOptions.themeName, ...buildOptions.extraThemeNames]) {
+        await generateTheme({
+            "keycloakThemeBuildingDirPath": buildOptions.keycloakifyBuildDirPath,
+            themeSrcDirPath,
+            "keycloakifySrcDirPath": pathJoin(keycloakifyDirPath, "src"),
             "reactAppBuildDirPath": buildOptions.reactAppBuildDirPath,
             "buildOptions": {
                 ...buildOptions,
                 "themeName": themeName
             },
             "keycloakifyVersion": (() => {
-                const version = JSON.parse(fs.readFileSync(pathJoin(getProjectRoot(), "package.json")).toString("utf8"))["version"];
+                const version = JSON.parse(fs.readFileSync(pathJoin(keycloakifyDirPath, "package.json")).toString("utf8"))["version"];
 
                 assert(typeof version === "string");
 
                 return version;
             })()
         });
-
-        doBundlesEmailTemplate ??= doBundlesEmailTemplate_;
     }
 
-    assert(doBundlesEmailTemplate !== undefined);
-
     const { jarFilePath } = generateJavaStackFiles({
-        keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
-        doBundlesEmailTemplate,
+        "keycloakThemeBuildingDirPath": buildOptions.keycloakifyBuildDirPath,
+        "implementedThemeTypes": (() => {
+            const implementedThemeTypes = {
+                "login": false,
+                "account": false,
+                "email": false
+            };
+
+            if (themeSrcDirPath === undefined) {
+                implementedThemeTypes["login"] = true;
+                implementedThemeTypes["account"] = true;
+                return implementedThemeTypes;
+            }
+
+            for (const themeType of objectKeys(implementedThemeTypes)) {
+                if (!fs.existsSync(pathJoin(themeSrcDirPath, themeType))) {
+                    continue;
+                }
+                implementedThemeTypes[themeType] = true;
+            }
+
+            return implementedThemeTypes;
+        })(),
         buildOptions
     });
 

package/src/bin/keycloakify/parsedPackageJson.ts

@@ -23,7 +23,6 @@ export type ParsedPackageJson = {
         keycloakVersionDefaultAssets?: string;
         reactAppBuildDirPath?: string;
         keycloakifyBuildDirPath?: string;
-        customUserAttributes?: string[];
         themeName?: string;
         extraThemeNames?: string[];
     };
@@ -46,7 +45,6 @@ export const zParsedPackageJson = z.object({
             "keycloakVersionDefaultAssets": z.string().optional(),
             "reactAppBuildDirPath": z.string().optional(),
             "keycloakifyBuildDirPath": z.string().optional(),
-            "customUserAttributes": z.array(z.string()).optional(),
             "themeName": z.string().optional(),
             "extraThemeNames": z.array(z.string()).optional()
         })