keycloakify 7.6.1 → 7.6.3

package/src/bin/keycloakify/keycloakify.ts

@@ -10,32 +10,25 @@ import { getCliOptions } from "../tools/cliOptions";
 import jar from "../tools/jar";
 import { assert } from "tsafe/assert";
 import { Equals } from "tsafe";
-import { getEmailThemeSrcDirPath } from "./build-paths";
-import { getCnamePath, getAppInputPath, getKeycloakBuildPath, getReactProjectDirPath } from "./build-paths";
+import { getEmailThemeSrcDirPath } from "../getSrcDirPath";
 
 export async function main() {
     const { isSilent, hasExternalAssets } = getCliOptions(process.argv.slice(2));
     const logger = getLogger({ isSilent });
     logger.log("🔏 Building the keycloak theme...⌚");
 
-    const buildOptions = readBuildOptions({
-        "CNAME": (() => {
-            const cnameFilePath = getCnamePath();
-
-            if (!fs.existsSync(cnameFilePath)) {
-                return undefined;
-            }
+    const projectDirPath = process.cwd();
 
-            return fs.readFileSync(cnameFilePath).toString("utf8");
-        })(),
+    const buildOptions = readBuildOptions({
+        projectDirPath,
         "isExternalAssetsCliParamProvided": hasExternalAssets,
         "isSilent": isSilent
     });
 
     const { doBundlesEmailTemplate } = await generateKeycloakThemeResources({
-        keycloakThemeBuildingDirPath: buildOptions.keycloakBuildPath,
+        keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
         "emailThemeSrcDirPath": (() => {
-            const { emailThemeSrcDirPath } = getEmailThemeSrcDirPath();
+            const { emailThemeSrcDirPath } = getEmailThemeSrcDirPath({ projectDirPath });
 
             if (emailThemeSrcDirPath === undefined || !fs.existsSync(emailThemeSrcDirPath)) {
                 return;
@@ -43,13 +36,13 @@ export async function main() {
 
             return emailThemeSrcDirPath;
         })(),
-        "reactAppBuildDirPath": getAppInputPath(),
+        "reactAppBuildDirPath": buildOptions.reactAppBuildDirPath,
         buildOptions,
         "keycloakVersion": buildOptions.keycloakVersionDefaultAssets
     });
 
     const { jarFilePath } = generateJavaStackFiles({
-        keycloakThemeBuildingDirPath: buildOptions.keycloakBuildPath,
+        keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
         doBundlesEmailTemplate,
         buildOptions
     });
@@ -61,7 +54,7 @@ export async function main() {
         case "keycloakify":
             logger.log("🫶 Let keycloakify do its thang");
             await jar({
-                "rootPath": pathJoin(buildOptions.keycloakBuildPath, "src", "main", "resources"),
+                "rootPath": pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources"),
                 "version": buildOptions.version,
                 "groupId": buildOptions.groupId,
                 "artifactId": buildOptions.artifactId,
@@ -70,7 +63,7 @@ export async function main() {
             break;
         case "mvn":
             logger.log("🫙 Run maven to deliver a jar");
-            child_process.execSync("mvn package", { "cwd": buildOptions.keycloakBuildPath });
+            child_process.execSync("mvn package", { "cwd": buildOptions.keycloakifyBuildDirPath });
             break;
         default:
             assert<Equals<typeof buildOptions.bundler, never>>(false);
@@ -80,7 +73,7 @@ export async function main() {
     const containerKeycloakVersion = "20.0.1";
 
     generateStartKeycloakTestingContainer({
-        keycloakThemeBuildingDirPath: buildOptions.keycloakBuildPath,
+        keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
         "keycloakVersion": containerKeycloakVersion,
         buildOptions
     });
@@ -88,7 +81,7 @@ export async function main() {
     logger.log(
         [
             "",
-            `✅ Your keycloak theme has been generated and bundled into ./${pathRelative(getReactProjectDirPath(), jarFilePath)} 🚀`,
+            `✅ Your keycloak theme has been generated and bundled into .${pathSep}${pathRelative(projectDirPath, jarFilePath)} 🚀`,
             `It is to be placed in "/opt/keycloak/providers" in the container running a quay.io/keycloak/keycloak Docker image.`,
             "",
             //TODO: Restore when we find a good Helm chart for Keycloak.
@@ -123,8 +116,8 @@ export async function main() {
             `To test your theme locally you can spin up a Keycloak ${containerKeycloakVersion} container image with the theme pre loaded by running:`,
             "",
             `👉 $ .${pathSep}${pathRelative(
-                getReactProjectDirPath(),
-                pathJoin(getKeycloakBuildPath(), generateStartKeycloakTestingContainer.basename)
+                projectDirPath,
+                pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename)
             )} 👈`,
             "",
             `Test with different Keycloak versions by editing the .sh file. see available versions here: https://quay.io/repository/keycloak/keycloak?tab=tags`,

package/src/bin/keycloakify/parsedPackageJson.ts

@@ -4,10 +4,9 @@ import type { Equals } from "tsafe";
 import { z } from "zod";
 import { pathJoin } from "../tools/pathJoin";
 
-const reactProjectDirPath = process.cwd();
 export const bundlers = ["mvn", "keycloakify", "none"] as const;
 export type Bundler = (typeof bundlers)[number];
-type ParsedPackageJson = {
+export type ParsedPackageJson = {
     name: string;
     version: string;
     homepage?: string;
@@ -22,8 +21,8 @@ type ParsedPackageJson = {
         groupId?: string;
         bundler?: Bundler;
         keycloakVersionDefaultAssets?: string;
-        appInputPath?: string;
-        keycloakBuildPath?: string;
+        reactAppBuildDirPath?: string;
+        keycloakifyBuildDirPath?: string;
         customUserAttributes?: string[];
         themeName?: string;
     };
@@ -44,8 +43,8 @@ const zParsedPackageJson = z.object({
             "groupId": z.string().optional(),
             "bundler": z.enum(bundlers).optional(),
             "keycloakVersionDefaultAssets": z.string().optional(),
-            "appInputPath": z.string().optional(),
-            "keycloakBuildPath": z.string().optional(),
+            "reactAppBuildDirPath": z.string().optional(),
+            "keycloakifyBuildDirPath": z.string().optional(),
             "customUserAttributes": z.array(z.string()).optional(),
             "themeName": z.string().optional()
         })
@@ -55,8 +54,11 @@ const zParsedPackageJson = z.object({
 assert<Equals<ReturnType<(typeof zParsedPackageJson)["parse"]>, ParsedPackageJson>>();
 
 let parsedPackageJson: undefined | ReturnType<(typeof zParsedPackageJson)["parse"]>;
-export const getParsedPackageJson = () => {
-    if (parsedPackageJson) return parsedPackageJson;
-    parsedPackageJson = zParsedPackageJson.parse(JSON.parse(fs.readFileSync(pathJoin(reactProjectDirPath, "package.json")).toString("utf8")));
+export function getParsedPackageJson(params: { projectDirPath: string }) {
+    const { projectDirPath } = params;
+    if (parsedPackageJson) {
+        return parsedPackageJson;
+    }
+    parsedPackageJson = zParsedPackageJson.parse(JSON.parse(fs.readFileSync(pathJoin(projectDirPath, "package.json")).toString("utf8")));
     return parsedPackageJson;
-};
+}

package/src/login/kcContext/getKcContext.ts

@@ -11,6 +11,7 @@ import { pathJoin } from "keycloakify/bin/tools/pathJoin";
 import { pathBasename } from "keycloakify/tools/pathBasename";
 import { mockTestingResourcesCommonPath } from "keycloakify/bin/mockTestingResourcesPath";
 import { symToStr } from "tsafe/symToStr";
+import { loginThemePageIds } from "keycloakify/bin/keycloakify/generateFtl/pageId";
 
 export function getKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
     mockPageId?: ExtendKcContext<KcContextExtension>["pageId"];
@@ -121,7 +122,7 @@ export function getKcContext<KcContextExtension extends { pageId: string } = nev
         return { "kcContext": undefined };
     }
 
-    if (!("login" in realKcContext)) {
+    if (id<readonly string[]>(loginThemePageIds).indexOf(realKcContext.pageId) < 0 && !("login" in realKcContext)) {
         return { "kcContext": undefined };
     }
 

package/src/login/lib/useDownloadTerms.ts

@@ -10,7 +10,7 @@ import { KcContext } from "../kcContext";
 export const evtTermMarkdown = Evt.create<string | undefined>(undefined);
 
 export type KcContextLike = {
-    pageId: KcContext["pageId"];
+    pageId: string;
     locale?: {
         currentLanguageTag: string;
     };

package/src/login/pages/Terms.tsx

@@ -21,13 +21,17 @@ export default function Terms(props: PageProps<Extract<KcContext, { pageId: "ter
 
     const { url } = kcContext;
 
-    if (evtTermMarkdown.state === undefined) {
+    const termMarkdown = evtTermMarkdown.state;
+
+    if (termMarkdown === undefined) {
         return null;
     }
 
     return (
         <Template {...{ kcContext, i18n, doUseDefaultCss, classes }} displayMessage={false} headerNode={msg("termsTitle")}>
-            <div id="kc-terms-text">{evtTermMarkdown.state && <Markdown>{evtTermMarkdown.state}</Markdown>}</div>
+            <div id="kc-terms-text">
+                <Markdown>{termMarkdown}</Markdown>
+            </div>
             <form className="form-actions" action={url.loginAction} method="POST">
                 <input
                     className={clsx(

package/bin/keycloakify/build-paths.d.ts

@@ -1,12 +0,0 @@
-export declare const getReactProjectDirPath: () => string;
-export declare const getCnamePath: () => string;
-export declare const getAppInputPath: () => string;
-export declare const getKeycloakBuildPath: () => string;
-export declare const getThemeSrcDirPath: () => {
-    themeSrcDirPath: string;
-} | {
-    themeSrcDirPath: undefined;
-};
-export declare const getEmailThemeSrcDirPath: () => {
-    emailThemeSrcDirPath: string | undefined;
-};

package/bin/keycloakify/build-paths.js

@@ -1,93 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEmailThemeSrcDirPath = exports.getThemeSrcDirPath = exports.getKeycloakBuildPath = exports.getAppInputPath = exports.getCnamePath = exports.getReactProjectDirPath = void 0;
-var fs = __importStar(require("fs"));
-var tsafe_1 = require("tsafe");
-var crawl_1 = require("../tools/crawl");
-var pathJoin_1 = require("../tools/pathJoin");
-var parsedPackageJson_1 = require("./parsedPackageJson");
-var DEFAULT_APP_INPUT_PATH = "build";
-var DEFAULT_KEYCLOAK_BUILD_PATH = "build_keycloak";
-var THEME_SRC_DIR_BASENAME = "keycloak-theme";
-var getReactProjectDirPath = function () { return process.cwd(); };
-exports.getReactProjectDirPath = getReactProjectDirPath;
-var getCnamePath = function () { return (0, pathJoin_1.pathJoin)((0, exports.getReactProjectDirPath)(), "public", "CNAME"); };
-exports.getCnamePath = getCnamePath;
-var parseAppInputPath = function (path) {
-    if (!path) {
-        return (0, pathJoin_1.pathJoin)(process.cwd(), DEFAULT_APP_INPUT_PATH);
-    }
-    else if (path.startsWith("./")) {
-        return (0, pathJoin_1.pathJoin)(process.cwd(), path.replace("./", ""));
-    }
-    return path;
-};
-var parseKeycloakBuildPath = function (path) {
-    if (!path) {
-        return (0, pathJoin_1.pathJoin)(process.cwd(), DEFAULT_KEYCLOAK_BUILD_PATH);
-    }
-    else if (path.startsWith("./")) {
-        return (0, pathJoin_1.pathJoin)(process.cwd(), path.replace("./", ""));
-    }
-    return path;
-};
-var getAppInputPath = function () {
-    var _a;
-    return parseAppInputPath((_a = (0, parsedPackageJson_1.getParsedPackageJson)().keycloakify) === null || _a === void 0 ? void 0 : _a.appInputPath);
-};
-exports.getAppInputPath = getAppInputPath;
-var getKeycloakBuildPath = function () {
-    var _a;
-    return parseKeycloakBuildPath((_a = (0, parsedPackageJson_1.getParsedPackageJson)().keycloakify) === null || _a === void 0 ? void 0 : _a.keycloakBuildPath);
-};
-exports.getKeycloakBuildPath = getKeycloakBuildPath;
-var getThemeSrcDirPath = function () {
-    var srcDirPath = (0, pathJoin_1.pathJoin)((0, exports.getReactProjectDirPath)(), "src");
-    var themeSrcDirPath = (0, crawl_1.crawl)(srcDirPath)
-        .map(function (fileRelativePath) {
-        var split = fileRelativePath.split(THEME_SRC_DIR_BASENAME);
-        if (split.length !== 2) {
-            return undefined;
-        }
-        return (0, pathJoin_1.pathJoin)(srcDirPath, split[0] + THEME_SRC_DIR_BASENAME);
-    })
-        .filter((0, tsafe_1.exclude)(undefined))[0];
-    if (themeSrcDirPath === undefined) {
-        if (fs.existsSync((0, pathJoin_1.pathJoin)(srcDirPath, "login")) || fs.existsSync((0, pathJoin_1.pathJoin)(srcDirPath, "account"))) {
-            return { "themeSrcDirPath": srcDirPath };
-        }
-        return { "themeSrcDirPath": undefined };
-    }
-    return { themeSrcDirPath: themeSrcDirPath };
-};
-exports.getThemeSrcDirPath = getThemeSrcDirPath;
-var getEmailThemeSrcDirPath = function () {
-    var themeSrcDirPath = (0, exports.getThemeSrcDirPath)().themeSrcDirPath;
-    var emailThemeSrcDirPath = themeSrcDirPath === undefined ? undefined : (0, pathJoin_1.pathJoin)(themeSrcDirPath, "email");
-    return { emailThemeSrcDirPath: emailThemeSrcDirPath };
-};
-exports.getEmailThemeSrcDirPath = getEmailThemeSrcDirPath;
-//# sourceMappingURL=build-paths.js.map

package/bin/keycloakify/build-paths.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"build-paths.js","sourceRoot":"","sources":["../../src/bin/keycloakify/build-paths.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAyB;AACzB,+BAAgC;AAChC,wCAAuC;AACvC,8CAA6C;AAC7C,yDAA2D;AAE3D,IAAM,sBAAsB,GAAG,OAAO,CAAC;AAEvC,IAAM,2BAA2B,GAAG,gBAAgB,CAAC;AAErD,IAAM,sBAAsB,GAAG,gBAAgB,CAAC;AAEzC,IAAM,sBAAsB,GAAG,cAAM,OAAA,OAAO,CAAC,GAAG,EAAE,EAAb,CAAa,CAAC;AAA7C,QAAA,sBAAsB,0BAAuB;AAEnD,IAAM,YAAY,GAAG,cAAM,OAAA,IAAA,mBAAQ,EAAC,IAAA,8BAAsB,GAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,EAArD,CAAqD,CAAC;AAA3E,QAAA,YAAY,gBAA+D;AAExF,IAAM,iBAAiB,GAAG,UAAC,IAAa;IACpC,IAAI,CAAC,IAAI,EAAE;QACP,OAAO,IAAA,mBAAQ,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,sBAAsB,CAAC,CAAC;KAC1D;SAAM,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QAC9B,OAAO,IAAA,mBAAQ,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;KAC1D;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,IAAM,sBAAsB,GAAG,UAAC,IAAa;IACzC,IAAI,CAAC,IAAI,EAAE;QACP,OAAO,IAAA,mBAAQ,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,2BAA2B,CAAC,CAAC;KAC/D;SAAM,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QAC9B,OAAO,IAAA,mBAAQ,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;KAC1D;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEK,IAAM,eAAe,GAAG;;IAC3B,OAAO,iBAAiB,CAAC,MAAA,IAAA,wCAAoB,GAAE,CAAC,WAAW,0CAAE,YAAY,CAAC,CAAC;AAC/E,CAAC,CAAC;AAFW,QAAA,eAAe,mBAE1B;AAEK,IAAM,oBAAoB,GAAG;;IAChC,OAAO,sBAAsB,CAAC,MAAA,IAAA,wCAAoB,GAAE,CAAC,WAAW,0CAAE,iBAAiB,CAAC,CAAC;AACzF,CAAC,CAAC;AAFW,QAAA,oBAAoB,wBAE/B;AACK,IAAM,kBAAkB,GAAG;IAC9B,IAAM,UAAU,GAAG,IAAA,mBAAQ,EAAC,IAAA,8BAAsB,GAAE,EAAE,KAAK,CAAC,CAAC;IAE7D,IAAM,eAAe,GAAuB,IAAA,aAAK,EAAC,UAAU,CAAC;SACxD,GAAG,CAAC,UAAA,gBAAgB;QACjB,IAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAE7D,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YACpB,OAAO,SAAS,CAAC;SACpB;QAED,OAAO,IAAA,mBAAQ,EAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,sBAAsB,CAAC,CAAC;IACnE,CAAC,CAAC;SACD,MAAM,CAAC,IAAA,eAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACnC,IAAI,eAAe,KAAK,SAAS,EAAE;QAC/B,IAAI,EAAE,CAAC,UAAU,CAAC,IAAA,mBAAQ,EAAC,UAAU,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,IAAA,mBAAQ,EAAC,UAAU,EAAE,SAAS,CAAC,CAAC,EAAE;YAChG,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,CAAC;SAC5C;QACD,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,CAAC;KAC3C;IAED,OAAO,EAAE,eAAe,iBAAA,EAAE,CAAC;AAC/B,CAAC,CAAC;AAtBW,QAAA,kBAAkB,sBAsB7B;AAEK,IAAM,uBAAuB,GAAG;IAC3B,IAAA,eAAe,GAAK,IAAA,0BAAkB,GAAE,gBAAzB,CAA0B;IAEjD,IAAM,oBAAoB,GAAG,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,mBAAQ,EAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAE5G,OAAO,EAAE,oBAAoB,sBAAA,EAAE,CAAC;AACpC,CAAC,CAAC;AANW,QAAA,uBAAuB,2BAMlC"}

package/src/bin/keycloakify/build-paths.ts

@@ -1,72 +0,0 @@
-import * as fs from "fs";
-import { exclude } from "tsafe";
-import { crawl } from "../tools/crawl";
-import { pathJoin } from "../tools/pathJoin";
-import { getParsedPackageJson } from "./parsedPackageJson";
-
-const DEFAULT_APP_INPUT_PATH = "build";
-
-const DEFAULT_KEYCLOAK_BUILD_PATH = "build_keycloak";
-
-const THEME_SRC_DIR_BASENAME = "keycloak-theme";
-
-export const getReactProjectDirPath = () => process.cwd();
-
-export const getCnamePath = () => pathJoin(getReactProjectDirPath(), "public", "CNAME");
-
-const parseAppInputPath = (path?: string) => {
-    if (!path) {
-        return pathJoin(process.cwd(), DEFAULT_APP_INPUT_PATH);
-    } else if (path.startsWith("./")) {
-        return pathJoin(process.cwd(), path.replace("./", ""));
-    }
-    return path;
-};
-
-const parseKeycloakBuildPath = (path?: string) => {
-    if (!path) {
-        return pathJoin(process.cwd(), DEFAULT_KEYCLOAK_BUILD_PATH);
-    } else if (path.startsWith("./")) {
-        return pathJoin(process.cwd(), path.replace("./", ""));
-    }
-    return path;
-};
-
-export const getAppInputPath = () => {
-    return parseAppInputPath(getParsedPackageJson().keycloakify?.appInputPath);
-};
-
-export const getKeycloakBuildPath = () => {
-    return parseKeycloakBuildPath(getParsedPackageJson().keycloakify?.keycloakBuildPath);
-};
-export const getThemeSrcDirPath = () => {
-    const srcDirPath = pathJoin(getReactProjectDirPath(), "src");
-
-    const themeSrcDirPath: string | undefined = crawl(srcDirPath)
-        .map(fileRelativePath => {
-            const split = fileRelativePath.split(THEME_SRC_DIR_BASENAME);
-
-            if (split.length !== 2) {
-                return undefined;
-            }
-
-            return pathJoin(srcDirPath, split[0] + THEME_SRC_DIR_BASENAME);
-        })
-        .filter(exclude(undefined))[0];
-    if (themeSrcDirPath === undefined) {
-        if (fs.existsSync(pathJoin(srcDirPath, "login")) || fs.existsSync(pathJoin(srcDirPath, "account"))) {
-            return { "themeSrcDirPath": srcDirPath };
-        }
-        return { "themeSrcDirPath": undefined };
-    }
-
-    return { themeSrcDirPath };
-};
-
-export const getEmailThemeSrcDirPath = () => {
-    const { themeSrcDirPath } = getThemeSrcDirPath();
-
-    const emailThemeSrcDirPath = themeSrcDirPath === undefined ? undefined : pathJoin(themeSrcDirPath, "email");
-
-    return { emailThemeSrcDirPath };
-};