keycloakify 7.16.0-rc.1 → 8.0.0-rc.1

package/src/bin/keycloakify/BuildOptions.ts

@@ -4,228 +4,135 @@ import { parse as urlParse } from "url";
 import { typeGuard } from "tsafe/typeGuard";
 import { symToStr } from "tsafe/symToStr";
 import { bundlers, getParsedPackageJson, type Bundler } from "./parsedPackageJson";
-import * as fs from "fs";
 import { join as pathJoin, sep as pathSep } from "path";
 import parseArgv from "minimist";
 
 /** Consolidated build option gathered form CLI arguments and config in package.json */
-export type BuildOptions = BuildOptions.Standalone | BuildOptions.ExternalAssets;
-
-export namespace BuildOptions {
-    export type Common = {
-        isSilent: boolean;
-        themeVersion: string;
-        themeName: string;
-        extraThemeNames: string[];
-        extraThemeProperties: string[] | undefined;
-        groupId: string;
-        artifactId: string;
-        bundler: Bundler;
-        keycloakVersionDefaultAssets: string;
-        /** Directory of your built react project. Defaults to {cwd}/build */
-        reactAppBuildDirPath: string;
-        /** Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak */
-        keycloakifyBuildDirPath: string;
-    };
-
-    export type Standalone = Common & {
-        isStandalone: true;
-        urlPathname: string | undefined;
-    };
-
-    export type ExternalAssets = ExternalAssets.SameDomain | ExternalAssets.DifferentDomains;
-
-    export namespace ExternalAssets {
-        export type CommonExternalAssets = Common & {
-            isStandalone: false;
-        };
-
-        export type SameDomain = CommonExternalAssets & {
-            areAppAndKeycloakServerSharingSameDomain: true;
-        };
-
-        export type DifferentDomains = CommonExternalAssets & {
-            areAppAndKeycloakServerSharingSameDomain: false;
-            urlOrigin: string;
-            urlPathname: string | undefined;
-        };
-    }
-}
+export type BuildOptions = {
+    isSilent: boolean;
+    themeVersion: string;
+    themeName: string;
+    extraThemeNames: string[];
+    extraThemeProperties: string[] | undefined;
+    groupId: string;
+    artifactId: string;
+    bundler: Bundler;
+    keycloakVersionDefaultAssets: string;
+    /** Directory of your built react project. Defaults to {cwd}/build */
+    reactAppBuildDirPath: string;
+    /** Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak */
+    keycloakifyBuildDirPath: 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;
+};
 
 export function readBuildOptions(params: { projectDirPath: string; processArgv: string[] }): BuildOptions {
     const { projectDirPath, processArgv } = params;
 
-    const { isExternalAssetsCliParamProvided, isSilentCliParamProvided } = (() => {
+    const { isSilentCliParamProvided } = (() => {
         const argv = parseArgv(processArgv);
 
         return {
-            "isSilentCliParamProvided": typeof argv["silent"] === "boolean" ? argv["silent"] : false,
-            "isExternalAssetsCliParamProvided": typeof argv["external-assets"] === "boolean" ? argv["external-assets"] : false
+            "isSilentCliParamProvided": typeof argv["silent"] === "boolean" ? argv["silent"] : false
         };
     })();
 
     const parsedPackageJson = getParsedPackageJson({ projectDirPath });
 
-    const url = (() => {
-        const { homepage } = parsedPackageJson;
+    const { name, keycloakify = {}, version, homepage } = parsedPackageJson;
 
-        let url: URL | undefined = undefined;
+    const { extraThemeProperties, groupId, artifactId, bundler, keycloakVersionDefaultAssets, extraThemeNames = [] } = keycloakify ?? {};
 
-        if (homepage !== undefined) {
-            url = new URL(homepage);
-        }
+    const themeName =
+        keycloakify.themeName ??
+        name
+            .replace(/^@(.*)/, "$1")
+            .split("/")
+            .join("-");
 
-        const CNAME = (() => {
-            const cnameFilePath = pathJoin(projectDirPath, "public", "CNAME");
+    return {
+        themeName,
+        extraThemeNames,
+        "bundler": (() => {
+            const { KEYCLOAKIFY_BUNDLER } = process.env;
 
-            if (!fs.existsSync(cnameFilePath)) {
-                return undefined;
+            assert(
+                typeGuard<Bundler | undefined>(KEYCLOAKIFY_BUNDLER, [undefined, ...id<readonly string[]>(bundlers)].includes(KEYCLOAKIFY_BUNDLER)),
+                `${symToStr({ KEYCLOAKIFY_BUNDLER })} should be one of ${bundlers.join(", ")}`
+            );
+
+            return KEYCLOAKIFY_BUNDLER ?? bundler ?? "keycloakify";
+        })(),
+        "artifactId": process.env.KEYCLOAKIFY_ARTIFACT_ID ?? artifactId ?? `${themeName}-keycloak-theme`,
+        "groupId": (() => {
+            const fallbackGroupId = `${themeName}.keycloak`;
+
+            return (
+                process.env.KEYCLOAKIFY_GROUP_ID ??
+                groupId ??
+                (!homepage
+                    ? fallbackGroupId
+                    : urlParse(homepage)
+                          .host?.replace(/:[0-9]+$/, "")
+                          ?.split(".")
+                          .reverse()
+                          .join(".") ?? fallbackGroupId) + ".keycloak"
+            );
+        })(),
+        "themeVersion": process.env.KEYCLOAKIFY_THEME_VERSION ?? process.env.KEYCLOAKIFY_VERSION ?? version ?? "0.0.0",
+        extraThemeProperties,
+        "isSilent": isSilentCliParamProvided,
+        "keycloakVersionDefaultAssets": keycloakVersionDefaultAssets ?? "11.0.3",
+        "reactAppBuildDirPath": (() => {
+            let { reactAppBuildDirPath = undefined } = parsedPackageJson.keycloakify ?? {};
+
+            if (reactAppBuildDirPath === undefined) {
+                return pathJoin(projectDirPath, "build");
             }
 
-            return fs.readFileSync(cnameFilePath).toString("utf8");
-        })();
+            if (pathSep === "\\") {
+                reactAppBuildDirPath = reactAppBuildDirPath.replace(/\//g, pathSep);
+            }
 
-        if (CNAME !== undefined) {
-            url = new URL(`https://${CNAME.replace(/\s+$/, "")}`);
-        }
+            if (reactAppBuildDirPath.startsWith(`.${pathSep}`)) {
+                return pathJoin(projectDirPath, reactAppBuildDirPath);
+            }
 
-        if (url === undefined) {
-            return undefined;
-        }
+            return reactAppBuildDirPath;
+        })(),
+        "keycloakifyBuildDirPath": (() => {
+            let { keycloakifyBuildDirPath = undefined } = parsedPackageJson.keycloakify ?? {};
 
-        return {
-            "origin": url.origin,
-            "pathname": (() => {
-                const out = url.pathname.replace(/([^/])$/, "$1/");
+            if (keycloakifyBuildDirPath === undefined) {
+                return pathJoin(projectDirPath, "build_keycloak");
+            }
 
-                return out === "/" ? undefined : out;
-            })()
-        };
-    })();
+            if (pathSep === "\\") {
+                keycloakifyBuildDirPath = keycloakifyBuildDirPath.replace(/\//g, pathSep);
+            }
 
-    const common: BuildOptions.Common = (() => {
-        const { name, keycloakify = {}, version, homepage } = parsedPackageJson;
+            if (keycloakifyBuildDirPath.startsWith(`.${pathSep}`)) {
+                return pathJoin(projectDirPath, keycloakifyBuildDirPath);
+            }
 
-        const { extraThemeProperties, groupId, artifactId, bundler, keycloakVersionDefaultAssets, extraThemeNames = [] } = keycloakify ?? {};
+            return keycloakifyBuildDirPath;
+        })(),
+        "urlPathname": (() => {
+            const { homepage } = parsedPackageJson;
 
-        const themeName =
-            keycloakify.themeName ??
-            name
-                .replace(/^@(.*)/, "$1")
-                .split("/")
-                .join("-");
+            let url: URL | undefined = undefined;
 
-        return {
-            themeName,
-            extraThemeNames,
-            "bundler": (() => {
-                const { KEYCLOAKIFY_BUNDLER } = process.env;
-
-                assert(
-                    typeGuard<Bundler | undefined>(
-                        KEYCLOAKIFY_BUNDLER,
-                        [undefined, ...id<readonly string[]>(bundlers)].includes(KEYCLOAKIFY_BUNDLER)
-                    ),
-                    `${symToStr({ KEYCLOAKIFY_BUNDLER })} should be one of ${bundlers.join(", ")}`
-                );
-
-                return KEYCLOAKIFY_BUNDLER ?? bundler ?? "keycloakify";
-            })(),
-            "artifactId": process.env.KEYCLOAKIFY_ARTIFACT_ID ?? artifactId ?? `${themeName}-keycloak-theme`,
-            "groupId": (() => {
-                const fallbackGroupId = `${themeName}.keycloak`;
-
-                return (
-                    process.env.KEYCLOAKIFY_GROUP_ID ??
-                    groupId ??
-                    (!homepage
-                        ? fallbackGroupId
-                        : urlParse(homepage)
-                              .host?.replace(/:[0-9]+$/, "")
-                              ?.split(".")
-                              .reverse()
-                              .join(".") ?? fallbackGroupId) + ".keycloak"
-                );
-            })(),
-            "themeVersion": process.env.KEYCLOAKIFY_THEME_VERSION ?? process.env.KEYCLOAKIFY_VERSION ?? version ?? "0.0.0",
-            extraThemeProperties,
-            "isSilent": isSilentCliParamProvided,
-            "keycloakVersionDefaultAssets": keycloakVersionDefaultAssets ?? "11.0.3",
-            "reactAppBuildDirPath": (() => {
-                let { reactAppBuildDirPath = undefined } = parsedPackageJson.keycloakify ?? {};
-
-                if (reactAppBuildDirPath === undefined) {
-                    return pathJoin(projectDirPath, "build");
-                }
-
-                if (pathSep === "\\") {
-                    reactAppBuildDirPath = reactAppBuildDirPath.replace(/\//g, pathSep);
-                }
-
-                if (reactAppBuildDirPath.startsWith(`.${pathSep}`)) {
-                    return pathJoin(projectDirPath, reactAppBuildDirPath);
-                }
-
-                return reactAppBuildDirPath;
-            })(),
-            "keycloakifyBuildDirPath": (() => {
-                let { keycloakifyBuildDirPath = undefined } = parsedPackageJson.keycloakify ?? {};
-
-                if (keycloakifyBuildDirPath === undefined) {
-                    return pathJoin(projectDirPath, "build_keycloak");
-                }
-
-                if (pathSep === "\\") {
-                    keycloakifyBuildDirPath = keycloakifyBuildDirPath.replace(/\//g, pathSep);
-                }
-
-                if (keycloakifyBuildDirPath.startsWith(`.${pathSep}`)) {
-                    return pathJoin(projectDirPath, keycloakifyBuildDirPath);
-                }
-
-                return keycloakifyBuildDirPath;
-            })()
-        };
-    })();
+            if (homepage !== undefined) {
+                url = new URL(homepage);
+            }
 
-    if (isExternalAssetsCliParamProvided) {
-        const commonExternalAssets = id<BuildOptions.ExternalAssets.CommonExternalAssets>({
-            ...common,
-            "isStandalone": false
-        });
-
-        if (parsedPackageJson.keycloakify?.areAppAndKeycloakServerSharingSameDomain) {
-            return id<BuildOptions.ExternalAssets.SameDomain>({
-                ...commonExternalAssets,
-                "areAppAndKeycloakServerSharingSameDomain": true
-            });
-        } else {
-            assert(
-                url !== undefined,
-                [
-                    "Can't compile in external assets mode if we don't know where",
-                    "the app will be hosted.",
-                    "You should provide a homepage field in the package.json (or create a",
-                    "public/CNAME file.",
-                    "Alternatively, if your app and the Keycloak server are on the same domain, ",
-                    "eg https://example.com is your app and https://example.com/auth is the keycloak",
-                    'admin UI, you can set "keycloakify": { "areAppAndKeycloakServerSharingSameDomain": true }',
-                    "in your package.json"
-                ].join(" ")
-            );
+            if (url === undefined) {
+                return undefined;
+            }
 
-            return id<BuildOptions.ExternalAssets.DifferentDomains>({
-                ...commonExternalAssets,
-                "areAppAndKeycloakServerSharingSameDomain": false,
-                "urlOrigin": url.origin,
-                "urlPathname": url.pathname
-            });
-        }
-    }
-
-    return id<BuildOptions.Standalone>({
-        ...common,
-        "isStandalone": true,
-        "urlPathname": url?.pathname
-    });
+            const out = url.pathname.replace(/([^/])$/, "$1/");
+            return out === "/" ? undefined : out;
+        })()
+    };
 }

package/src/bin/keycloakify/generateFtl/ftl_object_to_js_code_declaring_an_object.ftl

@@ -483,18 +483,6 @@
                     <#local out_seq += ["/*If you need '" + key + "' on " + pageId + ", please submit an issue to the Keycloakify repo*/"]>
                     <#continue>
                 </#if>
-
-                <#if key == "attemptedUsername" && are_same_path(path, ["auth"])>
-
-                    <#attempt>
-                        <#-- https://github.com/keycloak/keycloak/blob/3a2bf0c04bcde185e497aaa32d0bb7ab7520cf4a/themes/src/main/resources/theme/base/login/template.ftl#L63 -->
-                        <#if !(auth?has_content && auth.showUsername() && !auth.showResetCredentials())>
-                            <#continue>
-                        </#if>
-                    <#recover>
-                    </#attempt>
-
-                </#if>
                 
                 <#attempt>
                     <#if !object[key]??>

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

@@ -13,39 +13,11 @@ export const themeTypes = ["login", "account"] as const;
 
 export type ThemeType = (typeof themeTypes)[number];
 
-export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.ExternalAssets;
-
-export namespace BuildOptionsLike {
-    export type Common = {
-        themeName: string;
-        themeVersion: string;
-    };
-
-    export type Standalone = Common & {
-        isStandalone: true;
-        urlPathname: string | undefined;
-    };
-
-    export type ExternalAssets = ExternalAssets.SameDomain | ExternalAssets.DifferentDomains;
-
-    export namespace ExternalAssets {
-        export type CommonExternalAssets = {
-            isStandalone: false;
-        };
-
-        export type SameDomain = Common &
-            CommonExternalAssets & {
-                areAppAndKeycloakServerSharingSameDomain: true;
-            };
-
-        export type DifferentDomains = Common &
-            CommonExternalAssets & {
-                areAppAndKeycloakServerSharingSameDomain: false;
-                urlOrigin: string;
-                urlPathname: string | undefined;
-            };
-    }
-}
+export type BuildOptionsLike = {
+    themeName: string;
+    themeVersion: string;
+    urlPathname: string | undefined;
+};
 
 assert<BuildOptions extends BuildOptionsLike ? true : false>();
 
@@ -63,22 +35,23 @@ export function generateFtlFilesCodeFactory(params: {
     const $ = cheerio.load(indexHtmlCode);
 
     fix_imports_statements: {
-        if (!buildOptions.isStandalone && buildOptions.areAppAndKeycloakServerSharingSameDomain) {
-            break fix_imports_statements;
-        }
-
         $("script:not([src])").each((...[, element]) => {
-            const { fixedJsCode } = replaceImportsFromStaticInJsCode({
-                "jsCode": $(element).html()!,
-                buildOptions
-            });
+            const jsCode = $(element).html();
+
+            assert(jsCode !== null);
+
+            const { fixedJsCode } = replaceImportsFromStaticInJsCode({ jsCode });
 
             $(element).text(fixedJsCode);
         });
 
         $("style").each((...[, element]) => {
+            const cssCode = $(element).html();
+
+            assert(cssCode !== null);
+
             const { fixedCssCode } = replaceImportsInInlineCssCode({
-                "cssCode": $(element).html()!,
+                cssCode,
                 buildOptions
             });
 
@@ -100,9 +73,7 @@ export function generateFtlFilesCodeFactory(params: {
 
                 $(element).attr(
                     attrName,
-                    buildOptions.isStandalone
-                        ? href.replace(new RegExp(`^${(buildOptions.urlPathname ?? "/").replace(/\//g, "\\/")}`), "${url.resourcesPath}/build/")
-                        : href.replace(/^\//, `${buildOptions.urlOrigin}/`)
+                    href.replace(new RegExp(`^${(buildOptions.urlPathname ?? "/").replace(/\//g, "\\/")}`), "${url.resourcesPath}/build/")
                 );
             })
         );

package/src/bin/keycloakify/generateJavaStackFiles.ts

@@ -0,0 +1,84 @@
+import * as fs from "fs";
+import { join as pathJoin, dirname as pathDirname } from "path";
+import { assert } from "tsafe/assert";
+import type { BuildOptions } from "./BuildOptions";
+import type { ThemeType } from "./generateFtl";
+
+export type BuildOptionsLike = {
+    themeName: string;
+    extraThemeNames: string[];
+    groupId: string;
+    artifactId: string;
+    themeVersion: string;
+};
+
+assert<BuildOptions extends BuildOptionsLike ? true : false>();
+
+export function generateJavaStackFiles(params: {
+    keycloakThemeBuildingDirPath: string;
+    implementedThemeTypes: Record<ThemeType | "email", boolean>;
+    buildOptions: BuildOptionsLike;
+}): {
+    jarFilePath: string;
+} {
+    const {
+        buildOptions: { groupId, themeName, extraThemeNames, themeVersion, artifactId },
+        keycloakThemeBuildingDirPath,
+        implementedThemeTypes
+    } = params;
+
+    {
+        const { pomFileCode } = (function generatePomFileCode(): {
+            pomFileCode: string;
+        } {
+            const pomFileCode = [
+                `<?xml version="1.0"?>`,
+                `<project xmlns="http://maven.apache.org/POM/4.0.0"`,
+                `	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"`,
+                `	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">`,
+                `	<modelVersion>4.0.0</modelVersion>`,
+                `	<groupId>${groupId}</groupId>`,
+                `	<artifactId>${artifactId}</artifactId>`,
+                `	<version>${themeVersion}</version>`,
+                `	<name>${artifactId}</name>`,
+                `	<description />`,
+                `</project>`
+            ].join("\n");
+
+            return { pomFileCode };
+        })();
+
+        fs.writeFileSync(pathJoin(keycloakThemeBuildingDirPath, "pom.xml"), Buffer.from(pomFileCode, "utf8"));
+    }
+
+    {
+        const themeManifestFilePath = pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "META-INF", "keycloak-themes.json");
+
+        try {
+            fs.mkdirSync(pathDirname(themeManifestFilePath));
+        } catch {}
+
+        fs.writeFileSync(
+            themeManifestFilePath,
+            Buffer.from(
+                JSON.stringify(
+                    {
+                        "themes": [themeName, ...extraThemeNames].map(themeName => ({
+                            "name": themeName,
+                            "types": Object.entries(implementedThemeTypes)
+                                .filter(([, isImplemented]) => isImplemented)
+                                .map(([themeType]) => themeType)
+                        }))
+                    },
+                    null,
+                    2
+                ),
+                "utf8"
+            )
+        );
+    }
+
+    return {
+        "jarFilePath": pathJoin(keycloakThemeBuildingDirPath, "target", `${artifactId}-${themeVersion}.jar`)
+    };
+}

package/src/bin/keycloakify/generateStartKeycloakTestingContainer.ts

@@ -1,7 +1,6 @@
 import * as fs from "fs";
 import { join as pathJoin } from "path";
 import { assert } from "tsafe/assert";
-import { Reflect } from "tsafe/Reflect";
 import type { BuildOptions } from "./BuildOptions";
 
 export type BuildOptionsLike = {
@@ -9,11 +8,7 @@ export type BuildOptionsLike = {
     extraThemeNames: string[];
 };
 
-{
-    const buildOptions = Reflect<BuildOptions>();
-
-    assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
-}
+assert<BuildOptions extends BuildOptionsLike ? true : false>();
 
 generateStartKeycloakTestingContainer.basename = "start_keycloak_testing_container.sh";
 

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

@@ -13,13 +13,17 @@ import * as crypto from "crypto";
 export async function downloadKeycloakStaticResources(
     // prettier-ignore
     params: {
+        projectDirPath: string;
         themeType: ThemeType;
         themeDirPath: string;
-        isSilent: boolean;
         keycloakVersion: string;
+        usedResources: {
+            resourcesCommonFilePaths: string[];
+            resourcesFilePaths: string[];
+        } | undefined
     }
 ) {
-    const { themeType, isSilent, themeDirPath, keycloakVersion } = params;
+    const { projectDirPath, themeType, themeDirPath, keycloakVersion, usedResources } = params;
 
     const tmpDirPath = pathJoin(
         themeDirPath,
@@ -28,19 +32,39 @@ export async function downloadKeycloakStaticResources(
     );
 
     await downloadBuiltinKeycloakTheme({
+        projectDirPath,
         keycloakVersion,
-        "destDirPath": tmpDirPath,
-        isSilent
+        "destDirPath": tmpDirPath
     });
 
     transformCodebase({
         "srcDirPath": pathJoin(tmpDirPath, "keycloak", themeType, "resources"),
-        "destDirPath": pathJoin(themeDirPath, pathRelative(basenameOfKeycloakDirInPublicDir, resourcesDirPathRelativeToPublicDir))
+        "destDirPath": pathJoin(themeDirPath, pathRelative(basenameOfKeycloakDirInPublicDir, resourcesDirPathRelativeToPublicDir)),
+        "transformSourceCode":
+            usedResources === undefined
+                ? undefined
+                : ({ fileRelativePath, sourceCode }) => {
+                      if (!usedResources.resourcesFilePaths.includes(fileRelativePath)) {
+                          return undefined;
+                      }
+
+                      return { "modifiedSourceCode": sourceCode };
+                  }
     });
 
     transformCodebase({
         "srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
-        "destDirPath": pathJoin(themeDirPath, pathRelative(basenameOfKeycloakDirInPublicDir, resourcesCommonDirPathRelativeToPublicDir))
+        "destDirPath": pathJoin(themeDirPath, pathRelative(basenameOfKeycloakDirInPublicDir, resourcesCommonDirPathRelativeToPublicDir)),
+        "transformSourceCode":
+            usedResources === undefined
+                ? undefined
+                : ({ fileRelativePath, sourceCode }) => {
+                      if (!usedResources.resourcesCommonFilePaths.includes(fileRelativePath)) {
+                          return undefined;
+                      }
+
+                      return { "modifiedSourceCode": sourceCode };
+                  }
     });
 
     fs.rmSync(tmpDirPath, { "recursive": true, "force": true });