keycloakify 7.6.2 → 7.6.4

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

@@ -13,37 +13,6 @@ export const themeTypes = ["login", "account"] as const;
 
 export type ThemeType = (typeof themeTypes)[number];
 
-export const loginThemePageIds = [
-    "login.ftl",
-    "login-username.ftl",
-    "login-password.ftl",
-    "webauthn-authenticate.ftl",
-    "register.ftl",
-    "register-user-profile.ftl",
-    "info.ftl",
-    "error.ftl",
-    "login-reset-password.ftl",
-    "login-verify-email.ftl",
-    "terms.ftl",
-    "login-otp.ftl",
-    "login-update-profile.ftl",
-    "login-update-password.ftl",
-    "login-idp-link-confirm.ftl",
-    "login-idp-link-email.ftl",
-    "login-page-expired.ftl",
-    "login-config-totp.ftl",
-    "logout-confirm.ftl",
-    "update-user-profile.ftl",
-    "idp-review-user-profile.ftl",
-    "update-email.ftl",
-    "select-authenticator.ftl"
-] as const;
-
-export const accountThemePageIds = ["password.ftl", "account.ftl"] as const;
-
-export type LoginThemePageId = (typeof loginThemePageIds)[number];
-export type AccountThemePageId = (typeof accountThemePageIds)[number];
-
 export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.ExternalAssets;
 
 export namespace BuildOptionsLike {
@@ -84,8 +53,9 @@ export function generateFtlFilesCodeFactory(params: {
     //NOTE: Expected to be an empty object if external assets mode is enabled.
     cssGlobalsToDefine: Record<string, string>;
     buildOptions: BuildOptionsLike;
+    keycloakifyVersion: string;
 }) {
-    const { cssGlobalsToDefine, indexHtmlCode, buildOptions } = params;
+    const { cssGlobalsToDefine, indexHtmlCode, buildOptions, keycloakifyVersion } = params;
 
     const $ = cheerio.load(indexHtmlCode);
 
@@ -159,7 +129,8 @@ export function generateFtlFilesCodeFactory(params: {
             .replace(
                 "CUSTOM_USER_ATTRIBUTES_eKsIY4ZsZ4xeM",
                 buildOptions.customUserAttributes.length === 0 ? "" : ", " + buildOptions.customUserAttributes.map(name => `"${name}"`).join(", ")
-            ),
+            )
+            .replace("KEYCLOAKIFY_VERSION_xEdKd3xEdr", keycloakifyVersion),
         "<!-- xIdLqMeOedErIdLsPdNdI9dSlxI -->": [
             "<#if scripts??>",
             "    <#list scripts as script>",
@@ -192,7 +163,6 @@ export function generateFtlFilesCodeFactory(params: {
 
         Object.entries({
             ...replaceValueBySearchValue,
-            //If updated, don't forget to change in the ftl script as well.
             "PAGE_ID_xIgLsPgGId9D8e": pageId
         }).map(([searchValue, replaceValue]) => (ftlCode = ftlCode.replace(searchValue, replaceValue)));
 

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

@@ -1 +1,2 @@
 export * from "./generateFtl";
+export * from "./pageId";

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

@@ -0,0 +1,30 @@
+export const loginThemePageIds = [
+    "login.ftl",
+    "login-username.ftl",
+    "login-password.ftl",
+    "webauthn-authenticate.ftl",
+    "register.ftl",
+    "register-user-profile.ftl",
+    "info.ftl",
+    "error.ftl",
+    "login-reset-password.ftl",
+    "login-verify-email.ftl",
+    "terms.ftl",
+    "login-otp.ftl",
+    "login-update-profile.ftl",
+    "login-update-password.ftl",
+    "login-idp-link-confirm.ftl",
+    "login-idp-link-email.ftl",
+    "login-page-expired.ftl",
+    "login-config-totp.ftl",
+    "logout-confirm.ftl",
+    "update-user-profile.ftl",
+    "idp-review-user-profile.ftl",
+    "update-email.ftl",
+    "select-authenticator.ftl"
+] as const;
+
+export const accountThemePageIds = ["password.ftl", "account.ftl"] as const;
+
+export type LoginThemePageId = (typeof loginThemePageIds)[number];
+export type AccountThemePageId = (typeof accountThemePageIds)[number];

package/src/bin/keycloakify/generateKeycloakThemeResources.ts

@@ -54,8 +54,9 @@ export async function generateKeycloakThemeResources(params: {
     emailThemeSrcDirPath: string | undefined;
     keycloakVersion: string;
     buildOptions: BuildOptionsLike;
+    keycloakifyVersion: string;
 }): Promise<{ doBundlesEmailTemplate: boolean }> {
-    const { reactAppBuildDirPath, keycloakThemeBuildingDirPath, emailThemeSrcDirPath, keycloakVersion, buildOptions } = params;
+    const { reactAppBuildDirPath, keycloakThemeBuildingDirPath, emailThemeSrcDirPath, keycloakVersion, buildOptions, keycloakifyVersion } = params;
 
     const getThemeDirPath = (themeType: ThemeType | "email") =>
         pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", buildOptions.themeName, themeType);
@@ -138,7 +139,8 @@ export async function generateKeycloakThemeResources(params: {
             const { generateFtlFilesCode } = generateFtlFilesCodeFactory({
                 "indexHtmlCode": fs.readFileSync(pathJoin(reactAppBuildDirPath, "index.html")).toString("utf8"),
                 "cssGlobalsToDefine": allCssGlobalsToDefine,
-                buildOptions
+                buildOptions,
+                keycloakifyVersion
             });
 
             return generateFtlFilesCode;

package/src/bin/keycloakify/keycloakify.ts

@@ -11,6 +11,7 @@ import jar from "../tools/jar";
 import { assert } from "tsafe/assert";
 import { Equals } from "tsafe";
 import { getEmailThemeSrcDirPath } from "../getSrcDirPath";
+import { getProjectRoot } from "../tools/getProjectRoot";
 
 export async function main() {
     const { isSilent, hasExternalAssets } = getCliOptions(process.argv.slice(2));
@@ -38,7 +39,14 @@ export async function main() {
         })(),
         "reactAppBuildDirPath": buildOptions.reactAppBuildDirPath,
         buildOptions,
-        "keycloakVersion": buildOptions.keycloakVersionDefaultAssets
+        "keycloakVersion": buildOptions.keycloakVersionDefaultAssets,
+        "keycloakifyVersion": (() => {
+            const version = JSON.parse(fs.readFileSync(pathJoin(getProjectRoot(), "package.json")).toString("utf8"))["version"];
+
+            assert(typeof version === "string");
+
+            return version;
+        })()
     });
 
     const { jarFilePath } = generateJavaStackFiles({

package/src/bin/tools/jar.ts

@@ -1,94 +1,87 @@
-import { Readable, Transform } from "stream";
 import { dirname, relative, sep } from "path";
 import { createWriteStream } from "fs";
 
 import walk from "./walk";
-import zip, { type ZipSource } from "./zip";
+import { ZipFile } from "yazl";
 import { mkdir } from "fs/promises";
 import trimIndent from "./trimIndent";
 
-type JarArgs = {
-    rootPath: string;
-    targetPath: string;
+export type ZipEntry = { zipPath: string } & ({ fsPath: string } | { buffer: Buffer });
+export type ZipEntryGenerator = AsyncGenerator<ZipEntry, void, unknown>;
+
+type CommonJarArgs = {
     groupId: string;
     artifactId: string;
     version: string;
 };
 
-/**
- * Create a jar archive, using the resources found at `rootPath` (a directory) and write the
- * archive to `targetPath` (a file). Use `groupId`, `artifactId` and `version` to define
- * the contents of the pom.properties file which is going to be added to the archive.
- */
-export default async function jar({ groupId, artifactId, version, rootPath, targetPath }: JarArgs) {
-    const manifest: ZipSource = {
-        path: "META-INF/MANIFEST.MF",
-        data: Buffer.from(trimIndent`
+export type JarStreamArgs = CommonJarArgs & {
+    asyncPathGeneratorFn(): ZipEntryGenerator;
+};
+
+export type JarArgs = CommonJarArgs & {
+    targetPath: string;
+    rootPath: string;
+};
+
+export async function jarStream({ groupId, artifactId, version, asyncPathGeneratorFn }: JarStreamArgs) {
+    const manifestPath = "META-INF/MANIFEST.MF";
+    const manifestData = Buffer.from(trimIndent`
             Manifest-Version: 1.0
             Archiver-Version: Plexus Archiver
             Created-By: Keycloakify
             Built-By: unknown
             Build-Jdk: 19.0.0
-            `)
-    };
+            `);
 
-    const pomProps: ZipSource = {
-        path: `META-INF/maven/${groupId}/${artifactId}/pom.properties`,
-        data: Buffer.from(trimIndent`# Generated by keycloakify
-            # ${new Date().toString()}
+    const pomPropsPath = `META-INF/maven/${groupId}/${artifactId}/pom.properties`;
+    const pomPropsData = Buffer.from(trimIndent`
+            # Generated by keycloakify
+            # ${new Date()}
             artifactId=${artifactId}
             groupId=${groupId}
             version=${version}
-            `)
-    };
+            `);
 
-    /**
-     * Convert every path entry to a ZipSource record, and when all records are
-     * processed, append records for MANIFEST.mf and pom.properties
-     */
-    const pathToRecord = () =>
-        new Transform({
-            objectMode: true,
-            transform: function (fsPath, _, cb) {
-                const path = relative(rootPath, fsPath).split(sep).join("/");
-                this.push({ path, fsPath });
-                cb();
-            },
-            final: function () {
-                this.push(manifest);
-                this.push(pomProps);
-                this.push(null);
-            }
-        });
+    const zipFile = new ZipFile();
 
-    await mkdir(dirname(targetPath), { recursive: true });
+    for await (const entry of asyncPathGeneratorFn()) {
+        if ("buffer" in entry) {
+            zipFile.addBuffer(entry.buffer, entry.zipPath);
+        } else if ("fsPath" in entry && entry.fsPath.endsWith(sep)) {
+            zipFile.addFile(entry.fsPath, entry.zipPath);
+        }
+    }
 
-    // Create an async pipeline, wait until everything is fully processed
-    await new Promise<void>((resolve, reject) => {
-        // walk all files in `rootPath` recursively
-        Readable.from(walk(rootPath))
-            // transform every path into a ZipSource object
-            .pipe(pathToRecord())
-            // let the zip lib convert all ZipSource objects into a byte stream
-            .pipe(zip())
-            // write that byte stream to targetPath
-            .pipe(createWriteStream(targetPath, { encoding: "binary" }))
-            .on("finish", () => resolve())
-            .on("error", e => reject(e));
-    });
+    zipFile.addBuffer(manifestData, manifestPath);
+    zipFile.addBuffer(pomPropsData, pomPropsPath);
+
+    zipFile.end();
+
+    return zipFile;
 }
 
 /**
- * Standalone usage, call e.g. `ts-node jar.ts dirWithSources some-jar.jar`
+ * Create a jar archive, using the resources found at `rootPath` (a directory) and write the
+ * archive to `targetPath` (a file). Use `groupId`, `artifactId` and `version` to define
+ * the contents of the pom.properties file which is going to be added to the archive.
  */
-if (require.main === module) {
-    const main = () =>
-        jar({
-            rootPath: process.argv[2],
-            targetPath: process.argv[3],
-            artifactId: process.env.ARTIFACT_ID ?? "artifact",
-            groupId: process.env.GROUP_ID ?? "group",
-            version: process.env.VERSION ?? "1.0.0"
-        });
-    main();
+export default async function jar({ groupId, artifactId, version, rootPath, targetPath }: JarArgs) {
+    await mkdir(dirname(targetPath), { recursive: true });
+
+    const asyncPathGeneratorFn = async function* (): ZipEntryGenerator {
+        for await (const fsPath of walk(rootPath)) {
+            const zipPath = relative(rootPath, fsPath).split(sep).join("/");
+            yield { fsPath, zipPath };
+        }
+    };
+
+    const zipFile = await jarStream({ groupId, artifactId, version, asyncPathGeneratorFn });
+
+    await new Promise<void>(async (resolve, reject) => {
+        zipFile.outputStream
+            .pipe(createWriteStream(targetPath, { encoding: "binary" }))
+            .on("close", () => resolve())
+            .on("error", e => reject(e));
+    });
 }

package/src/bin/tools/walk.ts

@@ -8,7 +8,7 @@ import { resolve } from "path";
  * @param root the starting directory
  * @returns AsyncGenerator
  */
-export default async function* walk(root: string): AsyncGenerator<string, void, void> {
+export default async function* walk(root: string): AsyncGenerator<string, void, unknown> {
     for (const entry of await readdir(root, { withFileTypes: true })) {
         const absolutePath = resolve(root, entry.name);
         if (entry.isDirectory()) {

package/src/login/kcContext/KcContext.ts

@@ -36,6 +36,7 @@ export type KcContext =
 
 export declare namespace KcContext {
     export type Common = {
+        keycloakifyVersion: string;
         url: {
             loginAction: string;
             resourcesPath: string;

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/kcContext/kcContextMocks.ts

@@ -101,6 +101,7 @@ const attributes: Attribute[] = [
 const attributesByName = Object.fromEntries(attributes.map(attribute => [attribute.name, attribute])) as any;
 
 export const kcContextCommonMock: KcContext.Common = {
+    "keycloakifyVersion": "0.0.0",
     "url": {
         "loginAction": "#",
         "resourcesPath": pathJoin(PUBLIC_URL, mockTestingResourcesPath),

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/tools/zip.d.ts

@@ -1,29 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { Transform } from "stream";
-/**
- * Zip source
- * @property filename the name of the entry in the archie
- * @property path of the source file, if the source is an actual file
- * @property data the actual data buffer, if the source is constructed in-memory
- */
-export type ZipSource = {
-    path: string;
-} & ({
-    fsPath: string;
-} | {
-    data: Buffer;
-});
-export type ZipRecord = {
-    path: string;
-    compression: "deflate" | undefined;
-    uncompressedSize: number;
-    compressedSize?: number;
-    crc32?: number;
-    offset?: number;
-};
-/**
- * @returns a stream Transform, which reads a stream of ZipRecords and
- * writes a bytestream
- */
-export default function zip(): Transform;