Bump version #284

fix(download): fix download cache not behaving as expected

README.md

@@ -14,7 +14,7 @@
     <a href="https://github.com/garronej/keycloakify/blob/main/LICENSE">
       <img src="https://img.shields.io/npm/l/keycloakify">
     </a>
-    <a href="https://github.com/InseeFrLab/keycloakify/blob/729503fe31a155a823f46dd66ad4ff34ca274e0a/tsconfig.json#L14">
+    <a href="https://github.com/keycloakify/keycloakify/blob/729503fe31a155a823f46dd66ad4ff34ca274e0a/tsconfig.json#L14">
         <img src="https://camo.githubusercontent.com/0f9fcc0ac1b8617ad4989364f60f78b2d6b32985ad6a508f215f14d8f897b8d3/68747470733a2f2f62616467656e2e6e65742f62616467652f547970655363726970742f7374726963742532302546302539462539322541412f626c7565">
     </a>
     <a href="https://github.com/thomasdarimont/awesome-keycloak">
@@ -25,6 +25,8 @@
         -
         <a href="https://docs.keycloakify.dev">Documentation</a>
         -
+        <a href="https://storybook.keycloakify.dev/storybook">Storybook</a>
+        -
         <a href="https://github.com/codegouvfr/keycloakify-starter">Starter project</a>
     </p>
 </p>
@@ -34,15 +36,25 @@
     <img src="https://user-images.githubusercontent.com/6702424/110260457-a1c3d380-7fac-11eb-853a-80459b65626b.png">
 </p>
 
-> 🗣 V6 have been released 🎉  
-> [It features major improvements](https://github.com/InseeFrLab/keycloakify#600).  
-> Checkout [the migration guide](https://docs.keycloakify.dev/v5-to-v6).
+The more ⭐️ the project gets, the more time I spend improving and maintaining it. Thank you for your support 😊
+
+> 🗣 V7 have been released 🎉  
+> [It features major improvements](https://github.com/keycloakify/keycloakify#70-).  
+> Checkout [the migration guide](https://docs.keycloakify.dev/migration-guides/v6-greater-than-v7).
 
 # Changelog highlights
 
+## 7.0 🍾
+
+-   Account theme support 🚀
+-   It's much easier to customize pages at the CSS level, you can now see in the browser dev tool the customizable classes.
+-   New interactive CLI tool `npx eject-keycloak-page`, that enables to select the page you want to customize at the component level.
+-   There is [a Storybook](https://storybook.keycloakify.dev)
+-   [Remember me is fixed](https://github.com/keycloakify/keycloakify/pull/272)
+
 ## 6.13
 
--   Build work behind corporate proxies, [see issue](https://github.com/InseeFrLab/keycloakify/issues/257).
+-   Build work behind corporate proxies, [see issue](https://github.com/keycloakify/keycloakify/issues/257).
 
 ## 6.12
 
@@ -55,13 +67,13 @@ Massive improvement in the developer experience:
 
 ## 6.11.4
 
--   You no longer need to have Maven installed to build the theme. Thanks to @lordvlad, [see PR](https://github.com/InseeFrLab/keycloakify/pull/239).
+-   You no longer need to have Maven installed to build the theme. Thanks to @lordvlad, [see PR](https://github.com/keycloakify/keycloakify/pull/239).
 -   Feature new build options: [`bundler`](https://docs.keycloakify.dev/build-options#keycloakify.bundler), [`groupId`](https://docs.keycloakify.dev/build-options#keycloakify.groupid), [`artifactId`](https://docs.keycloakify.dev/build-options#keycloakify.artifactid), [`version`](https://docs.keycloakify.dev/build-options#version).  
     Theses options can be user to customize the output name of the .jar. You can use environnement variables to overrides the values read in the package.json. Thanks to @lordvlad.
 
 ## 6.10.0
 
--   Widows compat (thanks to @lordvlad, [see PR](https://github.com/InseeFrLab/keycloakify/pull/226)). WSL is no longer required 🎉
+-   Widows compat (thanks to @lordvlad, [see PR](https://github.com/keycloakify/keycloakify/pull/226)). WSL is no longer required 🎉
 
 ## 6.8.4
 
@@ -71,19 +83,19 @@ Massive improvement in the developer experience:
 
 -   It is now possible to pass a custom `<Template />` component as a prop to `<KcApp />` and every
     individual page (`<Login />`, `<RegisterUserProfile />`, ...) it enables to customize only the header and footer for
-    example without having to switch to a full-component level customization. [See issue](https://github.com/InseeFrLab/keycloakify/issues/191).
+    example without having to switch to a full-component level customization. [See issue](https://github.com/keycloakify/keycloakify/issues/191).
 
 ## 6.7.0
 
--   Add support for `webauthn-authenticate.ftl` thanks to [@mstrodl](https://github.com/Mstrodl)'s hacktoberfest [PR](https://github.com/InseeFrLab/keycloakify/pull/185).
+-   Add support for `webauthn-authenticate.ftl` thanks to [@mstrodl](https://github.com/Mstrodl)'s hacktoberfest [PR](https://github.com/keycloakify/keycloakify/pull/185).
 
 ## 6.6.0
 
--   Add support for `login-password.ftl` thanks to [@mstrodl](https://github.com/Mstrodl)'s hacktoberfest [PR](https://github.com/InseeFrLab/keycloakify/pull/184).
+-   Add support for `login-password.ftl` thanks to [@mstrodl](https://github.com/Mstrodl)'s hacktoberfest [PR](https://github.com/keycloakify/keycloakify/pull/184).
 
 ## 6.5.0
 
--   Add support for `login-username.ftl` thanks to [@mstrodl](https://github.com/Mstrodl)'s hacktoberfest [PR](https://github.com/InseeFrLab/keycloakify/pull/183).
+-   Add support for `login-username.ftl` thanks to [@mstrodl](https://github.com/Mstrodl)'s hacktoberfest [PR](https://github.com/keycloakify/keycloakify/pull/183).
 
 ## 6.4.0
 
@@ -102,11 +114,11 @@ Checkout [the migration guide](https://docs.keycloakify.dev/v5-to-v6)
 
 ## 5.8.0
 
--   [React.lazy()](https://reactjs.org/docs/code-splitting.html#reactlazy) support 🎉. [#141](https://github.com/InseeFrLab/keycloakify/issues/141)
+-   [React.lazy()](https://reactjs.org/docs/code-splitting.html#reactlazy) support 🎉. [#141](https://github.com/keycloakify/keycloakify/issues/141)
 
 ## 5.7.0
 
--   Feat `logout-confirm.ftl`. [PR](https://github.com/InseeFrLab/keycloakify/pull/120)
+-   Feat `logout-confirm.ftl`. [PR](https://github.com/keycloakify/keycloakify/pull/120)
 
 ## 5.6.4
 
@@ -114,7 +126,7 @@ Fix `login-verify-email.ftl` page. [Before](https://user-images.githubuserconten
 
 ## v5.6.0
 
-Add support for `login-config-totp.ftl` page [#127](https://github.com/InseeFrLab/keycloakify/pull/127).
+Add support for `login-config-totp.ftl` page [#127](https://github.com/keycloakify/keycloakify/pull/127).
 
 ## v5.3.0
 
@@ -129,7 +141,7 @@ Import of terms and services have changed. [See example](https://github.com/garr
 
 ## v4.10.0
 
-Add `login-idp-link-email.ftl` page [See PR](https://github.com/InseeFrLab/keycloakify/pull/92).
+Add `login-idp-link-email.ftl` page [See PR](https://github.com/keycloakify/keycloakify/pull/92).
 
 ## v4.8.0
 
@@ -142,7 +154,7 @@ Add `login-idp-link-email.ftl` page [See PR](https://github.com/InseeFrLab/keycl
 ## v4.7.2
 
 > WARNING: This is broken.  
-> Testing with local Keycloak container working with M1 Mac. Thanks to [@eduardosanzb](https://github.com/InseeFrLab/keycloakify/issues/43#issuecomment-975699658).  
+> Testing with local Keycloak container working with M1 Mac. Thanks to [@eduardosanzb](https://github.com/keycloakify/keycloakify/issues/43#issuecomment-975699658).  
 > Be aware: When running M1s you are testing with Keycloak v15 else the local container spun will be a Keycloak v16.1.0.
 
 ## v4.7.0
@@ -176,12 +188,12 @@ Change [this](https://github.com/garronej/keycloakify-demo-app/blob/df664c13c77c
 
 No breaking changes except that `@emotion/react`, [`tss-react`](https://www.npmjs.com/package/tss-react) and [`powerhooks`](https://www.npmjs.com/package/powerhooks) are now `peerDependencies` instead of being just dependencies.  
 It's important to avoid problem when using `keycloakify` alongside [`mui`](https://mui.com) and
-[when passing params from the app to the login page](https://github.com/InseeFrLab/keycloakify#implement-context-persistence-optional).
+[when passing params from the app to the login page](https://github.com/keycloakify/keycloakify#implement-context-persistence-optional).
 
 ## v2.5
 
--   Feature [Use advanced message](https://github.com/InseeFrLab/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/lib/i18n/useKcMessage.tsx#L53-L66)
-    and [`messagesPerFields`](https://github.com/InseeFrLab/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/lib/getKcContext/KcContextBase.ts#L70-L75) (implementation [here](https://github.com/InseeFrLab/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/bin/build-keycloak-theme/generateFtl/common.ftl#L130-L189))
+-   Feature [Use advanced message](https://github.com/keycloakify/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/lib/i18n/useKcMessage.tsx#L53-L66)
+    and [`messagesPerFields`](https://github.com/keycloakify/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/lib/getKcContext/KcContextBase.ts#L70-L75) (implementation [here](https://github.com/keycloakify/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/bin/build-keycloak-theme/generateFtl/common.ftl#L130-L189))
 -   Test container now uses Keycloak version `15.0.2`.
 
 ## v2

package.json

@@ -1,10 +1,10 @@
 {
     "name": "keycloakify",
-    "version": "7.0.0-rc.12",
+    "version": "7.3.1",
     "description": "Create Keycloak themes using React",
     "repository": {
         "type": "git",
-        "url": "git://github.com/inseefrlab/keycloakify.git"
+        "url": "git://github.com/keycloakify/keycloakify.git"
     },
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

scripts/generate-i18n-messages.ts

@@ -7,7 +7,7 @@ import { getProjectRoot } from "../src/bin/tools/getProjectRoot";
 import { getCliOptions } from "../src/bin/tools/cliOptions";
 import { getLogger } from "../src/bin/tools/logger";
 
-//NOTE: To run without argument when we want to generate src/i18n/generated_kcMessages files,
+// NOTE: To run without argument when we want to generate src/i18n/generated_kcMessages files,
 // update the version array for generating for newer version.
 
 //@ts-ignore
@@ -16,7 +16,7 @@ const propertiesParser = require("properties-parser");
 const { isSilent } = getCliOptions(process.argv.slice(2));
 const logger = getLogger({ isSilent });
 
-(async () => {
+async function main() {
     const keycloakVersion = "21.0.1";
 
     const tmpDirPath = pathJoin(getProjectRoot(), "tmp_xImOef9dOd44");
@@ -37,7 +37,9 @@ const logger = getLogger({ isSilent });
         const baseThemeDirPath = pathJoin(tmpDirPath, "base");
 
         crawl(baseThemeDirPath).forEach(filePath => {
-            const match = filePath.match(/^([^/]+)\/messages\/messages_([^.]+)\.properties$/);
+            const match =
+                filePath.match(/^([^/]+)\/messages\/messages_([^.]+)\.properties$/) ||
+                filePath.match(/^([^\\]+)\\messages\\messages_([^.]+)\.properties$/);
 
             if (match === null) {
                 return;
@@ -114,4 +116,8 @@ const logger = getLogger({ isSilent });
             )
         );
     });
-})();
+}
+
+if (require.main === module) {
+    main().catch(e => console.error(e));
+}

src/account/Template.tsx

@@ -43,6 +43,7 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
                                 {realm.internationalizationEnabled && (assert(locale !== undefined), true) && locale.supported.length > 1 && (
                                     <li>
                                         <div className="kc-dropdown" id="kc-locale-dropdown">
+                                            {/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}
                                             <a href="#" id="kc-current-locale-link">
                                                 {labelBySupportedLanguageTag[currentLanguageTag]}
                                             </a>

src/account/kcContext/KcContext.ts

@@ -64,6 +64,7 @@ export declare namespace KcContext {
         password: {
             passwordSet: boolean;
         };
+        stateChecker: string;
     };
 
     export type Account = Common & {

src/account/kcContext/getKcContext.ts

@@ -62,6 +62,10 @@ export function getKcContext<KcContextExtension extends { pageId: string } = nev
         return { "kcContext": undefined };
     }
 
+    if (!("account" in realKcContext)) {
+        return { "kcContext": undefined };
+    }
+
     {
         const { url } = realKcContext;
 

src/account/kcContext/kcContextMocks.ts

@@ -154,7 +154,8 @@ export const kcContextMocks: KcContext[] = [
         "pageId": "password.ftl",
         "password": {
             "passwordSet": true
-        }
+        },
+        "stateChecker": "state checker"
     }),
     id<KcContext.Account>({
         ...kcContextCommonMock,

src/account/pages/Password.tsx

@@ -15,7 +15,7 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
         }
     });
 
-    const { url, password, account } = kcContext;
+    const { url, password, account, stateChecker } = kcContext;
 
     const { msg } = i18n;
 
@@ -55,7 +55,7 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
                     </div>
                 )}
 
-                <input type="hidden" id="stateChecker" name="stateChecker" value="${stateChecker}" />
+                <input type="hidden" id="stateChecker" name="stateChecker" value={stateChecker} />
 
                 <div className="form-group">
                     <div className="col-sm-2 col-md-2">

src/bin/download-builtin-keycloak-theme.ts

@@ -8,33 +8,35 @@ import { getCliOptions } from "./tools/cliOptions";
 import { getLogger } from "./tools/logger";
 
 export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: string; destDirPath: string; isSilent: boolean }) {
-    const { keycloakVersion, destDirPath, isSilent } = params;
+    const { keycloakVersion, destDirPath } = params;
 
-    for (const ext of ["", "-community"]) {
-        await downloadAndUnzip({
-            "destDirPath": destDirPath,
-            "url": `https://github.com/keycloak/keycloak/archive/refs/tags/${keycloakVersion}.zip`,
-            "pathOfDirToExtractInArchive": `keycloak-${keycloakVersion}/themes/src/main/resources${ext}/theme`,
-            "cacheDirPath": pathJoin(keycloakThemeBuildingDirPath, ".cache"),
-            isSilent
-        });
-    }
+    await Promise.all(
+        ["", "-community"].map(ext =>
+            downloadAndUnzip({
+                "destDirPath": destDirPath,
+                "url": `https://github.com/keycloak/keycloak/archive/refs/tags/${keycloakVersion}.zip`,
+                "pathOfDirToExtractInArchive": `keycloak-${keycloakVersion}/themes/src/main/resources${ext}/theme`
+            })
+        )
+    );
+}
+
+async function main() {
+    const { isSilent } = getCliOptions(process.argv.slice(2));
+    const logger = getLogger({ isSilent });
+    const { keycloakVersion } = await promptKeycloakVersion();
+
+    const destDirPath = pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme");
+
+    logger.log(`Downloading builtins theme of Keycloak ${keycloakVersion} here ${destDirPath}`);
+
+    await downloadBuiltinKeycloakTheme({
+        keycloakVersion,
+        destDirPath,
+        isSilent
+    });
 }
 
 if (require.main === module) {
-    (async () => {
-        const { isSilent } = getCliOptions(process.argv.slice(2));
-        const logger = getLogger({ isSilent });
-        const { keycloakVersion } = await promptKeycloakVersion();
-
-        const destDirPath = pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme");
-
-        logger.log(`Downloading builtins theme of Keycloak ${keycloakVersion} here ${destDirPath}`);
-
-        await downloadBuiltinKeycloakTheme({
-            keycloakVersion,
-            destDirPath,
-            isSilent
-        });
-    })();
+    main().catch(e => console.error(e));
 }

src/bin/eject-keycloak-page.ts

@@ -16,6 +16,7 @@ import { existsSync } from "fs";
 import { join as pathJoin, relative as pathRelative } from "path";
 import { kebabCaseToCamelCase } from "./tools/kebabCaseToSnakeCase";
 import { assert, Equals } from "tsafe/assert";
+import { getThemeSrcDirPath } from "./getThemeSrcDirPath";
 
 (async () => {
     const projectRootDir = getProjectRoot();
@@ -50,7 +51,13 @@ import { assert, Equals } from "tsafe/assert";
 
     const pageBasename = capitalize(kebabCaseToCamelCase(pageId)).replace(/ftl$/, "tsx");
 
-    const targetFilePath = pathJoin(process.cwd(), "src", "keycloak-theme", themeType, "pages", pageBasename);
+    const { themeSrcDirPath } = getThemeSrcDirPath();
+
+    if (themeSrcDirPath === undefined) {
+        throw new Error("Couldn't locate your theme sources");
+    }
+
+    const targetFilePath = pathJoin(themeSrcDirPath, themeType, "pages", pageBasename);
 
     if (existsSync(targetFilePath)) {
         console.log(`${pageId} is already ejected, ${pathRelative(process.cwd(), targetFilePath)} already exists`);

src/bin/getThemeSrcDirPath.ts

@@ -0,0 +1,33 @@
+import { join as pathJoin } from "path";
+import * as fs from "fs";
+import { crawl } from "./tools/crawl";
+import { exclude } from "tsafe/exclude";
+
+const reactProjectDirPath = process.cwd();
+
+const themeSrcDirBasename = "keycloak-theme";
+
+export function getThemeSrcDirPath() {
+    const srcDirPath = pathJoin(reactProjectDirPath, "src");
+
+    const themeSrcDirPath: string | undefined = crawl(srcDirPath)
+        .map(fileRelativePath => {
+            const split = fileRelativePath.split(themeSrcDirBasename);
+
+            if (split.length !== 2) {
+                return undefined;
+            }
+
+            return pathJoin(srcDirPath, split[0] + themeSrcDirBasename);
+        })
+        .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 };
+}

src/bin/initialize-email-theme.ts

@@ -1,27 +1,43 @@
 #!/usr/bin/env node
 
 import { downloadBuiltinKeycloakTheme } from "./download-builtin-keycloak-theme";
-import { keycloakThemeEmailDirPath } from "./keycloakify";
 import { join as pathJoin, relative as pathRelative } from "path";
 import { transformCodebase } from "./tools/transformCodebase";
 import { promptKeycloakVersion } from "./promptKeycloakVersion";
 import * as fs from "fs";
 import { getCliOptions } from "./tools/cliOptions";
 import { getLogger } from "./tools/logger";
+import { getThemeSrcDirPath } from "./getThemeSrcDirPath";
 
-(async () => {
+export function getEmailThemeSrcDirPath() {
+    const { themeSrcDirPath } = getThemeSrcDirPath();
+
+    const emailThemeSrcDirPath = themeSrcDirPath === undefined ? undefined : pathJoin(themeSrcDirPath, "email");
+
+    return { emailThemeSrcDirPath };
+}
+
+async function main() {
     const { isSilent } = getCliOptions(process.argv.slice(2));
     const logger = getLogger({ isSilent });
 
-    if (fs.existsSync(keycloakThemeEmailDirPath)) {
-        logger.warn(`There is already a ${pathRelative(process.cwd(), keycloakThemeEmailDirPath)} directory in your project. Aborting.`);
+    const { emailThemeSrcDirPath } = getEmailThemeSrcDirPath();
+
+    if (emailThemeSrcDirPath === undefined) {
+        logger.warn("Couldn't locate your theme source directory");
+
+        process.exit(-1);
+    }
+
+    if (fs.existsSync(emailThemeSrcDirPath)) {
+        logger.warn(`There is already a ${pathRelative(process.cwd(), emailThemeSrcDirPath)} directory in your project. Aborting.`);
 
         process.exit(-1);
     }
 
     const { keycloakVersion } = await promptKeycloakVersion();
 
-    const builtinKeycloakThemeTmpDirPath = pathJoin(keycloakThemeEmailDirPath, "..", "tmp_xIdP3_builtin_keycloak_theme");
+    const builtinKeycloakThemeTmpDirPath = pathJoin(emailThemeSrcDirPath, "..", "tmp_xIdP3_builtin_keycloak_theme");
 
     await downloadBuiltinKeycloakTheme({
         keycloakVersion,
@@ -31,18 +47,20 @@ import { getLogger } from "./tools/logger";
 
     transformCodebase({
         "srcDirPath": pathJoin(builtinKeycloakThemeTmpDirPath, "base", "email"),
-        "destDirPath": keycloakThemeEmailDirPath
+        "destDirPath": emailThemeSrcDirPath
     });
 
     {
-        const themePropertyFilePath = pathJoin(keycloakThemeEmailDirPath, "theme.properties");
+        const themePropertyFilePath = pathJoin(emailThemeSrcDirPath, "theme.properties");
 
         fs.writeFileSync(themePropertyFilePath, Buffer.from(`parent=base\n${fs.readFileSync(themePropertyFilePath).toString("utf8")}`, "utf8"));
     }
 
-    logger.log(
-        `${pathRelative(process.cwd(), keycloakThemeEmailDirPath)} ready to be customized, feel free to remove every file you do not customize`
-    );
+    logger.log(`${pathRelative(process.cwd(), emailThemeSrcDirPath)} ready to be customized, feel free to remove every file you do not customize`);
 
     fs.rmSync(builtinKeycloakThemeTmpDirPath, { "recursive": true, "force": true });
-})();
+}
+
+if (require.main === module) {
+    main();
+}

src/bin/keycloakify/BuildOptions.ts

@@ -22,6 +22,7 @@ type ParsedPackageJson = {
         artifactId?: string;
         groupId?: string;
         bundler?: Bundler;
+        keycloakVersionDefaultAssets?: string;
     };
 };
 
@@ -38,7 +39,8 @@ const zParsedPackageJson = z.object({
             "areAppAndKeycloakServerSharingSameDomain": z.boolean().optional(),
             "artifactId": z.string().optional(),
             "groupId": z.string().optional(),
-            "bundler": z.enum(bundlers).optional()
+            "bundler": z.enum(bundlers).optional(),
+            "keycloakVersionDefaultAssets": z.string().optional()
         })
         .optional()
 });
@@ -59,6 +61,7 @@ export namespace BuildOptions {
         groupId: string;
         artifactId: string;
         bundler: Bundler;
+        keycloakVersionDefaultAssets: string;
     };
 
     export type Standalone = Common & {
@@ -125,7 +128,8 @@ export function readBuildOptions(params: {
     const common: BuildOptions.Common = (() => {
         const { name, keycloakify = {}, version, homepage } = parsedPackageJson;
 
-        const { extraPages, extraLoginPages, extraAccountPages, extraThemeProperties, groupId, artifactId, bundler } = keycloakify ?? {};
+        const { extraPages, extraLoginPages, extraAccountPages, extraThemeProperties, groupId, artifactId, bundler, keycloakVersionDefaultAssets } =
+            keycloakify ?? {};
 
         const themeName = name
             .replace(/^@(.*)/, "$1")
@@ -167,7 +171,8 @@ export function readBuildOptions(params: {
             "extraLoginPages": [...(extraPages ?? []), ...(extraLoginPages ?? [])],
             extraAccountPages,
             extraThemeProperties,
-            isSilent
+            isSilent,
+            "keycloakVersionDefaultAssets": keycloakVersionDefaultAssets ?? "11.0.3"
         };
     })();
 

src/bin/keycloakify/generateFtl/ftl_object_to_js_code_declaring_an_object.ftl

@@ -13,7 +13,8 @@
             "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"
+            "isSetRetry", "try-again", "attestationObject", "publicKeyCredentialId", "authenticatorLabel",
+            "location", "occupation"
         ]>
     
         <#attempt>
@@ -110,14 +111,16 @@
         }
     };
 
-    out["pageId"] = "${pageId}";
+    <#if account??>
+        out["url"]["getLogoutUrl"] = function () {
+            <#attempt>
+                return "${url.getLogoutUrl()}";
+            <#recover>
+            </#attempt>
+        };
+    </#if>
 
-    out["url"]["getLogoutUrl"] = function () {
-        <#attempt>
-            return "${url.getLogoutUrl()}";
-        <#recover>
-        </#attempt>
-    };
+    out["pageId"] = "${pageId}";
 
     return out;
 
@@ -162,9 +165,9 @@
                         key == "updateProfileCtx" && 
                         are_same_path(path, [])
                     ) || (
-                        <#-- https://github.com/InseeFrLab/keycloakify/pull/65#issuecomment-991896344 (reports with saml-post-form.ftl) -->
-                        <#-- https://github.com/InseeFrLab/keycloakify/issues/91#issue-1212319466 (reports with error.ftl and Kc18) -->
-                        <#-- https://github.com/InseeFrLab/keycloakify/issues/109#issuecomment-1134610163 -->
+                        <#-- https://github.com/keycloakify/keycloakify/pull/65#issuecomment-991896344 (reports with saml-post-form.ftl) -->
+                        <#-- https://github.com/keycloakify/keycloakify/issues/91#issue-1212319466 (reports with error.ftl and Kc18) -->
+                        <#-- https://github.com/keycloakify/keycloakify/issues/109#issuecomment-1134610163 -->
                         key == "loginAction" && 
                         are_same_path(path, ["url"]) && 
                         ["saml-post-form.ftl", "error.ftl", "info.ftl"]?seq_contains(pageId) &&

src/bin/keycloakify/generateFtl/generateFtl.ts

@@ -35,7 +35,8 @@ export const loginThemePageIds = [
     "login-config-totp.ftl",
     "logout-confirm.ftl",
     "update-user-profile.ftl",
-    "idp-review-user-profile.ftl"
+    "idp-review-user-profile.ftl",
+    "update-email.ftl"
 ] as const;
 
 export const accountThemePageIds = ["password.ftl", "account.ftl"] as const;

src/bin/keycloakify/generateKeycloakThemeResources.ts

@@ -10,7 +10,6 @@ import { isInside } from "../tools/isInside";
 import type { BuildOptions } from "./BuildOptions";
 import { assert } from "tsafe/assert";
 import { Reflect } from "tsafe/Reflect";
-import { getLogger } from "../tools/logger";
 
 export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.ExternalAssets;
 
@@ -56,13 +55,11 @@ export namespace BuildOptionsLike {
 export async function generateKeycloakThemeResources(params: {
     reactAppBuildDirPath: string;
     keycloakThemeBuildingDirPath: string;
-    keycloakThemeEmailDirPath: string;
+    emailThemeSrcDirPath: string | undefined;
     keycloakVersion: string;
     buildOptions: BuildOptionsLike;
 }): Promise<{ doBundlesEmailTemplate: boolean }> {
-    const { reactAppBuildDirPath, keycloakThemeBuildingDirPath, keycloakThemeEmailDirPath, keycloakVersion, buildOptions } = params;
-
-    const logger = getLogger({ isSilent: buildOptions.isSilent });
+    const { reactAppBuildDirPath, keycloakThemeBuildingDirPath, emailThemeSrcDirPath, keycloakVersion, buildOptions } = params;
 
     const getThemeDirPath = (themeType: ThemeType | "email") =>
         pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", buildOptions.themeName, themeType);
@@ -228,13 +225,7 @@ export async function generateKeycloakThemeResources(params: {
     let doBundlesEmailTemplate: boolean;
 
     email: {
-        if (!fs.existsSync(keycloakThemeEmailDirPath)) {
-            logger.log(
-                [
-                    `Not bundling email template because ${pathBasename(keycloakThemeEmailDirPath)} does not exist`,
-                    `To start customizing the email template, run: 👉 npx create-keycloak-email-directory 👈`
-                ].join("\n")
-            );
+        if (emailThemeSrcDirPath === undefined) {
             doBundlesEmailTemplate = false;
             break email;
         }
@@ -242,7 +233,7 @@ export async function generateKeycloakThemeResources(params: {
         doBundlesEmailTemplate = true;
 
         transformCodebase({
-            "srcDirPath": keycloakThemeEmailDirPath,
+            "srcDirPath": emailThemeSrcDirPath,
             "destDirPath": getThemeDirPath("email")
         });
     }

src/bin/keycloakify/keycloakify.ts

@@ -9,12 +9,12 @@ import { getLogger } from "../tools/logger";
 import { getCliOptions } from "../tools/cliOptions";
 import jar from "../tools/jar";
 import { assert } from "tsafe/assert";
-import type { Equals } from "tsafe";
+import { Equals } from "tsafe";
+import { getEmailThemeSrcDirPath } from "../initialize-email-theme";
 
 const reactProjectDirPath = process.cwd();
 
 export const keycloakThemeBuildingDirPath = pathJoin(reactProjectDirPath, "build_keycloak");
-export const keycloakThemeEmailDirPath = pathJoin(reactProjectDirPath, "src", "keycloak-theme", "email");
 
 export async function main() {
     const { isSilent, hasExternalAssets } = getCliOptions(process.argv.slice(2));
@@ -38,13 +38,18 @@ export async function main() {
 
     const { doBundlesEmailTemplate } = await generateKeycloakThemeResources({
         keycloakThemeBuildingDirPath,
-        keycloakThemeEmailDirPath,
+        "emailThemeSrcDirPath": (() => {
+            const { emailThemeSrcDirPath } = getEmailThemeSrcDirPath();
+
+            if (emailThemeSrcDirPath === undefined || !fs.existsSync(emailThemeSrcDirPath)) {
+                return;
+            }
+
+            return emailThemeSrcDirPath;
+        })(),
         "reactAppBuildDirPath": pathJoin(reactProjectDirPath, "build"),
         buildOptions,
-        //We have to leave it at that otherwise we break our default theme.
-        //Problem is that we can`t guarantee that the the old resources
-        //will still be available on the newer keycloak version.
-        "keycloakVersion": "11.0.3"
+        "keycloakVersion": buildOptions.keycloakVersionDefaultAssets
     });
 
     const { jarFilePath } = generateJavaStackFiles({
@@ -130,17 +135,21 @@ export async function main() {
             ``,
             `Once your container is up and running: `,
             "- Log into the admin console 👉 http://localhost:8080/admin username: admin, password: admin 👈",
-            `- Create a realm named     "myrealm"`,
-            `- Create a client with ID: "myclient"`,
+            `- Create a realm:                  myrealm`,
+            `- Enable registration:             Realm settings -> Login tab  -> User registration: on`,
+            `- Enable the Account theme:        Realm settings -> Themes tab -> Account theme, select ${buildOptions.themeName} `,
+            `- Create a client id               myclient`,
             `  Root URL:                        https://www.keycloak.org/app/`,
-            `  Valid redirect URIs:             https://www.keycloak.org/app* http://localhost* (localhost isn't necessary here but it will be once you'll want to test the integration with your app)`,
+            `  Valid redirect URIs:             https://www.keycloak.org/app* http://localhost* (localhost is optional)`,
             `  Valid post logout redirect URIs: https://www.keycloak.org/app* http://localhost*`,
             `  Web origins:                     *`,
-            `  Login Theme: ${buildOptions.themeName}`,
-            `  Click save at the bottom of the page.`,
-            `- Go to 👉 https://www.keycloak.org/app/ 👈 Click "Save" then "Sign in". You should see your login page`,
+            `  Login Theme:                     ${buildOptions.themeName}`,
+            `  Save (button at the bottom of the page)`,
             ``,
-            `Video demoing this process: https://youtu.be/N3wlBoH4hKg`,
+            `- Go to  👉  https://www.keycloak.org/app/ 👈 Click "Save" then "Sign in". You should see your login page`,
+            `- Got to 👉  http://localhost:8080/realms/myrealm/account 👈 to see your account theme`,
+            ``,
+            `Video tutorial: https://youtu.be/WMyGZNHQkjU`,
             ``
         ].join("\n")
     );

src/bin/tools/downloadAndUnzip.ts

@@ -1,15 +1,13 @@
-import { dirname as pathDirname, basename as pathBasename, join as pathJoin, join } from "path";
-import { createReadStream, createWriteStream } from "fs";
-import { stat, mkdir, unlink, writeFile } from "fs/promises";
-import { transformCodebase } from "./transformCodebase";
-import { createHash } from "crypto";
-import fetch from "make-fetch-happen";
-import { createInflateRaw } from "zlib";
-import type { Readable } from "stream";
-import { homedir } from "os";
-import { FetchOptions } from "make-fetch-happen";
 import { exec as execCallback } from "child_process";
+import { createHash } from "crypto";
+import { mkdir, stat, writeFile } from "fs/promises";
+import fetch, { type FetchOptions } from "make-fetch-happen";
+import { dirname as pathDirname, join as pathJoin } from "path";
+import { assert } from "tsafe";
 import { promisify } from "util";
+import { getProjectRoot } from "./getProjectRoot";
+import { transformCodebase } from "./transformCodebase";
+import { unzip } from "./unzip";
 
 const exec = promisify(execCallback);
 
@@ -17,25 +15,27 @@ function hash(s: string) {
     return createHash("sha256").update(s).digest("hex");
 }
 
-async function maybeStat(path: string) {
+async function exists(path: string) {
     try {
-        return await stat(path);
+        await stat(path);
+        return true;
     } catch (error) {
-        if ((error as Error & { code: string }).code === "ENOENT") return undefined;
+        if ((error as Error & { code: string }).code === "ENOENT") return false;
         throw error;
     }
 }
 
 /**
- * Get an npm configuration value as string, undefined if not set.
- *
- * @param key
- * @returns string or undefined
+ * Get npm configuration as map
  */
-async function getNmpConfig(key: string): Promise<string | undefined> {
-    const { stdout } = await exec(`npm config get ${key}`);
-    const value = stdout.trim();
-    return value && value !== "null" ? value : undefined;
+async function getNmpConfig(): Promise<Record<string, string>> {
+    const { stdout } = await exec("npm config get", { encoding: "utf8" });
+    return stdout
+        .split("\n")
+        .filter(line => !line.startsWith(";"))
+        .map(line => line.trim())
+        .map(line => line.split("=", 2))
+        .reduce((cfg, [key, value]) => ({ ...cfg, [key]: value }), {});
 }
 
 /**
@@ -45,233 +45,49 @@ async function getNmpConfig(key: string): Promise<string | undefined> {
  * @returns proxy configuration
  */
 async function getNpmProxyConfig(): Promise<Pick<FetchOptions, "proxy" | "noProxy">> {
-    const proxy = (await getNmpConfig("https-proxy")) ?? (await getNmpConfig("proxy"));
-    const noProxy = (await getNmpConfig("noproxy")) ?? (await getNmpConfig("no-proxy"));
+    const cfg = await getNmpConfig();
+
+    const proxy = cfg["https-proxy"] ?? cfg["proxy"];
+    const noProxy = cfg["noproxy"] ?? cfg["no-proxy"];
 
     return { proxy, noProxy };
 }
 
-/**
- * Download a file from `url` to `dir`. Will try to avoid downloading existing
- * files by using the cache directory ~/.keycloakify/cache
- *
- * If the target directory does not exist, it will be created.
- *
- * If the target file exists, it will be overwritten.
- *
- * We use make-fetch-happen's internal file cache here, so we don't need to
- * worry about redownloading the same file over and over. Unfortunately, that
- * cache does not have a single file per entry, but bundles and indexes them,
- * so we still need to write the contents to the target directory (possibly
- * over and over), cause the current unzip implementation wants random access.
- *
- * @param url download url
- * @param dir target directory
- * @param filename target filename
- * @returns promise for the full path of the downloaded file
- */
-async function download(url: string, dir: string, filename: string): Promise<string> {
-    const proxyOpts = await getNpmProxyConfig();
-    const cacheRoot = process.env.XDG_CACHE_HOME ?? homedir();
-    const cachePath = join(cacheRoot, ".keycloakify/cache");
-    const opts: FetchOptions = { cachePath, ...proxyOpts };
-    const response = await fetch(url, opts);
-    const filepath = pathJoin(dir, filename);
-    await mkdir(dir, { recursive: true });
-    await writeFile(filepath, response.body);
-    return filepath;
-}
-
-/**
- * @typedef
- * @type MultiError = Error & { cause: Error[] }
- */
-
-/**
- * Extract the archive `zipFile` into the directory `dir`. If `archiveDir` is given,
- * only that directory will be extracted, stripping the given path components.
- *
- * If dir does not exist, it will be created.
- *
- * If any archive file exists, it will be overwritten.
- *
- * Will unzip using all available nodejs worker threads.
- *
- * Will try to clean up extracted files on failure.
- *
- * If unpacking fails, will either throw an regular error, or
- * possibly an `MultiError`, which contains a `cause` field with
- * a number of root cause errors.
- *
- * Warning this method is not optimized for continuous reading of the zip
- * archive, but is a trade-off between simplicity and allowing extraction
- * of a single directory from the archive.
- *
- * @param zipFile the file to unzip
- * @param dir the target directory
- * @param archiveDir if given, unpack only files from this archive directory
- * @throws {MultiError} error
- * @returns Promise for a list of full file paths pointing to actually extracted files
- */
-async function unzip(zipFile: string, dir: string, archiveDir?: string): Promise<string[]> {
-    await mkdir(dir, { recursive: true });
-    const promises: Promise<string>[] = [];
-
-    // Iterate over all files in the zip, skip files which are not in archiveDir,
-    // if given.
-    for await (const record of iterateZipArchive(zipFile)) {
-        const { path: recordPath, createReadStream: createRecordReadStream } = record;
-        const filePath = pathJoin(dir, recordPath);
-        const parent = pathDirname(filePath);
-        if (archiveDir && !recordPath.startsWith(archiveDir)) continue;
-        promises.push(
-            new Promise<string>(async (resolve, reject) => {
-                await mkdir(parent, { recursive: true });
-                // Pull the file out of the archive, write it to the target directory
-                const input = createRecordReadStream();
-                const output = createWriteStream(filePath);
-                output.setMaxListeners(Infinity);
-                output.on("error", e => reject(Object.assign(e, { filePath })));
-                output.on("finish", () => resolve(filePath));
-                input.pipe(output);
-            })
-        );
-    }
-
-    // Wait until _all_ files are either extracted or failed
-    const results = await Promise.allSettled(promises);
-    const success = results.filter(r => r.status === "fulfilled").map(r => (r as PromiseFulfilledResult<string>).value);
-    const failure = results.filter(r => r.status === "rejected").map(r => (r as PromiseRejectedResult).reason);
-
-    // If any extraction failed, try to clean up, then throw a MultiError,
-    // which has a `cause` field, containing a list of root cause errors.
-    if (failure.length) {
-        await Promise.all(success.map(path => unlink(path)));
-        await Promise.all(failure.map(e => e && e.path && unlink(e.path as string)));
-        const e = new Error("Failed to extract: " + failure.map(e => e.message).join(";"));
-        (e as any).cause = failure;
-        throw e;
-    }
-
-    return success;
-}
-
-/**
- *
- * @param file file to read
- * @param start first byte to read
- * @param end last byte to read
- * @returns Promise of a buffer of read bytes
- */
-async function readFileChunk(file: string, start: number, end: number): Promise<Buffer> {
-    const chunks: Buffer[] = [];
-    return new Promise((resolve, reject) => {
-        const stream = createReadStream(file, { start, end });
-        stream.setMaxListeners(Infinity);
-        stream.on("error", e => reject(e));
-        stream.on("end", () => resolve(Buffer.concat(chunks)));
-        stream.on("data", chunk => chunks.push(chunk as Buffer));
-    });
-}
-
-type ZipRecord = {
-    path: string;
-    createReadStream: () => Readable;
-    compressionMethod: "deflate" | undefined;
-};
-
-type ZipRecordGenerator = AsyncGenerator<ZipRecord, void, unknown>;
-
-/**
- * Iterate over all records of a zipfile, and yield a ZipRecord.
- * Use `record.createReadStream()` to actually read the file.
- *
- * Warning this method will only work with single-disk zip files.
- * Warning this method may fail if the zip archive has an crazy amount
- * of files and the central directory is not fully contained within the
- * last 65k bytes of the zip file.
- *
- * @param zipFile
- * @returns AsyncGenerator which will yield ZipRecords
- */
-async function* iterateZipArchive(zipFile: string): ZipRecordGenerator {
-    // Need to know zip file size before we can do anything  else
-    const { size } = await stat(zipFile);
-    const chunkSize = 65_535 + 22 + 1; // max comment size + end header size + wiggle
-    // Read last ~65k bytes. Zip files have an comment up to 65_535 bytes at the very end,
-    // before that comes the zip central directory end header.
-    let chunk = await readFileChunk(zipFile, size - chunkSize, size);
-    const unread = size - chunk.length;
-    let i = chunk.length - 4;
-    let found = false;
-    // Find central directory end header, reading backwards from the end
-    while (!found && i-- > 0) if (chunk[i] === 0x50 && chunk.readUInt32LE(i) === 0x06054b50) found = true;
-    if (!found) throw new Error("Not a zip file");
-    // This method will fail on a multi-disk zip, so bail early.
-    if (chunk.readUInt16LE(i + 4) !== 0) throw new Error("Multi-disk zip not supported");
-    let nFiles = chunk.readUint16LE(i + 10);
-    // Get the position of the central directory
-    const directorySize = chunk.readUint32LE(i + 12);
-    const directoryOffset = chunk.readUint32LE(i + 16);
-    if (directoryOffset === 0xffff_ffff) throw new Error("zip64 not supported");
-    if (directoryOffset > size) throw new Error(`Central directory offset ${directoryOffset} is outside file`);
-    i = directoryOffset - unread;
-    // If i < 0, it means that the central directory is not contained within `chunk`
-    if (i < 0) {
-        chunk = await readFileChunk(zipFile, directoryOffset, directoryOffset + directorySize);
-        i = 0;
-    }
-    // Now iterate the central directory records, yield an `ZipRecord` for every entry
-    while (nFiles-- > 0) {
-        // Check for marker bytes
-        if (chunk.readUInt32LE(i) !== 0x02014b50) throw new Error("No central directory record at position " + (unread + i));
-        const compressionMethod = ({ 8: "deflate" } as const)[chunk.readUint16LE(i + 10)];
-        const compressedFileSize = chunk.readUint32LE(i + 20);
-        const filenameLength = chunk.readUint16LE(i + 28);
-        const extraLength = chunk.readUint16LE(i + 30);
-        const commentLength = chunk.readUint16LE(i + 32);
-        // Start of the actual content byte stream is after the 'local' record header,
-        // which is  30 bytes long plus filename and extra field
-        const start = chunk.readUint32LE(i + 42) + 30 + filenameLength + extraLength;
-        const end = start + compressedFileSize;
-        const filename = chunk.slice(i + 46, i + 46 + filenameLength).toString("utf-8");
-        const createRecordReadStream = () => {
-            const input = createReadStream(zipFile, { start, end });
-            if (compressionMethod === "deflate") {
-                const inflate = createInflateRaw();
-                input.pipe(inflate);
-                return inflate;
-            }
-            return input;
-        };
-        if (end > start) yield { path: filename, createReadStream: createRecordReadStream, compressionMethod };
-        // advance pointer to next central directory entry
-        i += 46 + filenameLength + extraLength + commentLength;
-    }
-}
-
 export async function downloadAndUnzip({
     url,
     destDirPath,
-    pathOfDirToExtractInArchive,
-    cacheDirPath
+    pathOfDirToExtractInArchive
 }: {
-    isSilent: boolean;
     url: string;
     destDirPath: string;
     pathOfDirToExtractInArchive?: string;
-    cacheDirPath: string;
 }) {
-    const downloadHash = hash(JSON.stringify({ url, pathOfDirToExtractInArchive })).substring(0, 15);
-    const extractDirPath = pathJoin(cacheDirPath, `_${downloadHash}`);
+    const downloadHash = hash(JSON.stringify({ url })).substring(0, 15);
+    const projectRoot = getProjectRoot();
+    const cacheRoot = process.env.XDG_CACHE_HOME ?? `${projectRoot}/node_modules/.cache`;
+    const zipFilePath = pathJoin(cacheRoot, "keycloakify", "zip", `_${downloadHash}.zip`);
+    const extractDirPath = pathJoin(cacheRoot, "keycloakify", "unzip", `_${downloadHash}`);
 
-    const filename = pathBasename(url);
-    const zipFilepath = await download(url, cacheDirPath, filename);
-    const zipMtime = (await stat(zipFilepath)).mtimeMs;
-    const unzipMtime = (await maybeStat(extractDirPath))?.mtimeMs;
+    if (!(await exists(zipFilePath))) {
+        const proxyOpts = await getNpmProxyConfig();
+        const response = await fetch(url, proxyOpts);
+        await mkdir(pathDirname(zipFilePath), { recursive: true });
+        /**
+         * The correct way to fix this is to upgrade node-fetch beyond 3.2.5
+         * (see https://github.com/node-fetch/node-fetch/issues/1295#issuecomment-1144061991.)
+         * Unfortunately, octokit (a dependency of keycloakify) also uses node-fetch, and
+         * does not support node-fetch 3.x. So we stick around with this band-aid until
+         * octokit upgrades.
+         */
+        response.body?.setMaxListeners(Number.MAX_VALUE);
+        assert(typeof response.body !== "undefined" && response.body != null);
+        await writeFile(zipFilePath, response.body);
+    }
 
-    if (!unzipMtime || zipMtime > unzipMtime) await unzip(zipFilepath, extractDirPath, pathOfDirToExtractInArchive);
+    await unzip(zipFilePath, extractDirPath, pathOfDirToExtractInArchive);
 
-    const srcDirPath = pathOfDirToExtractInArchive === undefined ? extractDirPath : pathJoin(extractDirPath, pathOfDirToExtractInArchive);
-    transformCodebase({ srcDirPath, destDirPath });
+    transformCodebase({
+        "srcDirPath": extractDirPath,
+        "destDirPath": destDirPath
+    });
 }

src/bin/tools/jar.ts

@@ -3,12 +3,9 @@ import { dirname, relative, sep } from "path";
 import { createWriteStream } from "fs";
 
 import walk from "./walk";
-import type { ZipSource } from "./zip";
-import zip from "./zip";
+import zip, { type ZipSource } from "./zip";
 import { mkdir } from "fs/promises";
-
-/** Trim leading whitespace from every line */
-const trimIndent = (s: string) => s.replace(/(\n)\s+/g, "$1");
+import trimIndent from "./trimIndent";
 
 type JarArgs = {
     rootPath: string;
@@ -26,28 +23,23 @@ type JarArgs = {
 export default async function jar({ groupId, artifactId, version, rootPath, targetPath }: JarArgs) {
     const manifest: ZipSource = {
         path: "META-INF/MANIFEST.MF",
-        data: Buffer.from(
-            trimIndent(
-                `Manifest-Version: 1.0
-                 Archiver-Version: Plexus Archiver
-                 Created-By: Keycloakify
-                 Built-By: unknown
-                 Build-Jdk: 19.0.0`
-            )
-        )
+        data: 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()}
-                 artifactId=${artifactId}
-                 groupId=${groupId}
-                 version=${version}`
-            )
-        )
+        data: Buffer.from(trimIndent`# Generated by keycloakify
+            # ${new Date()}
+            artifactId=${artifactId}
+            groupId=${groupId}
+            version=${version}
+            `)
     };
 
     /**

src/bin/tools/partitionPromiseSettledResults.ts

@@ -0,0 +1,11 @@
+export type PromiseSettledAndPartitioned<T> = [T[], any[]];
+
+export function partitionPromiseSettledResults<T>() {
+    return [
+        ([successes, failures]: PromiseSettledAndPartitioned<T>, item: PromiseSettledResult<T>) =>
+            item.status === "rejected"
+                ? ([successes, [item.reason, ...failures]] as PromiseSettledAndPartitioned<T>)
+                : ([[item.value, ...successes], failures] as PromiseSettledAndPartitioned<T>),
+        [[], []] as PromiseSettledAndPartitioned<T>
+    ] as const;
+}

src/bin/tools/tee.ts

@@ -7,6 +7,8 @@ export default function tee(input: Readable) {
     let aFull = false;
     let bFull = false;
 
+    a.setMaxListeners(Infinity);
+
     a.on("drain", () => {
         aFull = false;
         if (!aFull && !bFull) input.resume();

src/bin/tools/trimIndent.ts

@@ -0,0 +1,51 @@
+/**
+ * Concatenate the string fragments and interpolated values
+ * to get a single string.
+ */
+function populateTemplate(strings: TemplateStringsArray, ...args: any[]) {
+    const chunks = [];
+    for (let i = 0; i < strings.length; i++) {
+        let lastStringLineLength = 0;
+        if (strings[i]) {
+            chunks.push(strings[i]);
+            // remember last indent of the string portion
+            lastStringLineLength = strings[i].split("\n").at(-1)?.length ?? 0;
+        }
+        if (args[i]) {
+            // if the interpolation value has newlines, indent the interpolation values
+            // using the last known string indent
+            chunks.push(args[i].replace(/([\r?\n])/g, "$1" + " ".repeat(lastStringLineLength)));
+        }
+    }
+    return chunks.join("");
+}
+
+function trimIndentPrivate(removeEmptyLeadingAndTrailingLines: boolean, strings: TemplateStringsArray, ...args: any[]) {
+    // Remove initial and final newlines
+    let string = populateTemplate(strings, ...args);
+    if (removeEmptyLeadingAndTrailingLines) string = string.replace(/^[\r\n]/, "").replace(/[^\S\r\n]*[\r\n]$/, "");
+    const dents = string.match(/^([ \t])+/gm)?.map(s => s.length) ?? [];
+    // No dents? no change required
+    if (!dents || dents.length == 0) return string;
+    const minDent = Math.min(...dents);
+    // The min indentation is 0, no change needed
+    if (!minDent) return string;
+    const dedented = string.replace(new RegExp(`^${" ".repeat(minDent)}`, "gm"), "");
+    return dedented;
+}
+
+/**
+ * Shift all lines left by the *smallest* indentation level,
+ * and remove initial newline and all trailing spaces.
+ */
+export default function trimIndent(strings: TemplateStringsArray, ...args: any[]) {
+    return trimIndentPrivate(true, strings, ...args);
+}
+
+/**
+ * Shift all lines left by the *smallest* indentation level,
+ * and _keep_ initial newline and all trailing spaces.
+ */
+trimIndent.keepLeadingAndTrailingNewlines = function (strings: TemplateStringsArray, ...args: any[]) {
+    return trimIndentPrivate(false, strings, ...args);
+};

src/bin/tools/unzip.ts

@@ -0,0 +1,184 @@
+import { createReadStream, createWriteStream } from "fs";
+import { mkdir, stat, unlink } from "fs/promises";
+import { dirname as pathDirname, join as pathJoin, relative as pathRelative } from "path";
+import { type Readable } from "stream";
+import { createInflateRaw } from "zlib";
+import { partitionPromiseSettledResults } from "./partitionPromiseSettledResults";
+
+export type MultiError = Error & { cause: Error[] };
+
+/**
+ * Extract the archive `zipFile` into the directory `dir`. If `archiveDir` is given,
+ * only that directory will be extracted, stripping the given path components.
+ *
+ * If dir does not exist, it will be created.
+ *
+ * If any archive file exists, it will be overwritten.
+ *
+ * Will unzip using all available nodejs worker threads.
+ *
+ * Will try to clean up extracted files on failure.
+ *
+ * If unpacking fails, will either throw an regular error, or
+ * possibly an `MultiError`, which contains a `cause` field with
+ * a number of root cause errors.
+ *
+ * Warning this method is not optimized for continuous reading of the zip
+ * archive, but is a trade-off between simplicity and allowing extraction
+ * of a single directory from the archive.
+ *
+ * @param zipFilePath the file to unzip
+ * @param extractDirPath the target directory
+ * @param pathOfDirToExtractInArchive if given, unpack only files from this archive directory
+ * @throws {MultiError} error
+ * @returns Promise for a list of full file paths pointing to actually extracted files
+ */
+export async function unzip(zipFilePath: string, extractDirPath: string, pathOfDirToExtractInArchive?: string): Promise<string[]> {
+    const dirsCreated: (string | undefined)[] = [];
+    dirsCreated.push(await mkdir(extractDirPath, { recursive: true }));
+    const promises: Promise<string>[] = [];
+
+    // Iterate over all files in the zip, skip files which are not in archiveDir,
+    // if given.
+    for await (const record of iterateZipArchive(zipFilePath)) {
+        const { path: recordPath, createReadStream: createRecordReadStream } = record;
+        if (pathOfDirToExtractInArchive && !recordPath.startsWith(pathOfDirToExtractInArchive)) {
+            continue;
+        }
+        const relativePath = pathOfDirToExtractInArchive ? pathRelative(pathOfDirToExtractInArchive, recordPath) : recordPath;
+        const filePath = pathJoin(extractDirPath, relativePath);
+        const parent = pathDirname(filePath);
+        promises.push(
+            new Promise<string>(async (resolve, reject) => {
+                if (!dirsCreated.includes(parent)) dirsCreated.push(await mkdir(parent, { recursive: true }));
+
+                // Pull the file out of the archive, write it to the target directory
+                const output = createWriteStream(filePath);
+                output.on("error", e => reject(Object.assign(e, { filePath })));
+                output.on("finish", () => resolve(filePath));
+                createRecordReadStream().pipe(output);
+            })
+        );
+    }
+
+    // Wait until _all_ files are either extracted or failed
+    const [success, failure] = (await Promise.allSettled(promises)).reduce(...partitionPromiseSettledResults<string>());
+
+    // If any extraction failed, try to clean up, then throw a MultiError,
+    // which has a `cause` field, containing a list of root cause errors.
+    if (failure.length) {
+        await Promise.all([
+            ...success.map(path => unlink(path).catch(_unused => undefined)),
+            ...failure.map(e => e && e.path && unlink(e.path as string).catch(_unused => undefined))
+        ]);
+        await Promise.all(dirsCreated.filter(Boolean).sort(sortByFolderDepth("desc")));
+        const e = new Error("Failed to extract: " + failure.map(e => e.message).join(";"));
+        (e as any).cause = failure;
+        throw e;
+    }
+
+    return success;
+}
+
+function depth(dir: string) {
+    return dir.match(/\//g)?.length ?? 0;
+}
+
+function sortByFolderDepth(order: "asc" | "desc") {
+    const ord = order === "asc" ? 1 : -1;
+    return (a: string | undefined, b: string | undefined) => ord * depth(a ?? "") + -ord * depth(b ?? "");
+}
+
+/**
+ *
+ * @param file file to read
+ * @param start first byte to read
+ * @param end last byte to read
+ * @returns Promise of a buffer of read bytes
+ */
+async function readFileChunk(file: string, start: number, end: number): Promise<Buffer> {
+    const chunks: Buffer[] = [];
+    return new Promise((resolve, reject) => {
+        const stream = createReadStream(file, { start, end });
+        stream.setMaxListeners(Infinity);
+        stream.on("error", e => reject(e));
+        stream.on("end", () => resolve(Buffer.concat(chunks)));
+        stream.on("data", chunk => chunks.push(chunk as Buffer));
+    });
+}
+
+type ZipRecord = {
+    path: string;
+    createReadStream: () => Readable;
+    compressionMethod: "deflate" | undefined;
+};
+
+type ZipRecordGenerator = AsyncGenerator<ZipRecord, void, unknown>;
+
+/**
+ * Iterate over all records of a zipfile, and yield a ZipRecord.
+ * Use `record.createReadStream()` to actually read the file.
+ *
+ * Warning this method will only work with single-disk zip files.
+ * Warning this method may fail if the zip archive has an crazy amount
+ * of files and the central directory is not fully contained within the
+ * last 65k bytes of the zip file.
+ *
+ * @param zipFile
+ * @returns AsyncGenerator which will yield ZipRecords
+ */
+async function* iterateZipArchive(zipFile: string): ZipRecordGenerator {
+    // Need to know zip file size before we can do anything  else
+    const { size } = await stat(zipFile);
+    const chunkSize = 65_535 + 22 + 1; // max comment size + end header size + wiggle
+    // Read last ~65k bytes. Zip files have an comment up to 65_535 bytes at the very end,
+    // before that comes the zip central directory end header.
+    let chunk = await readFileChunk(zipFile, size - chunkSize, size);
+    const unread = size - chunk.length;
+    let i = chunk.length - 4;
+    let found = false;
+    // Find central directory end header, reading backwards from the end
+    while (!found && i-- > 0) if (chunk[i] === 0x50 && chunk.readUInt32LE(i) === 0x06054b50) found = true;
+    if (!found) throw new Error("Not a zip file");
+    // This method will fail on a multi-disk zip, so bail early.
+    if (chunk.readUInt16LE(i + 4) !== 0) throw new Error("Multi-disk zip not supported");
+    let nFiles = chunk.readUint16LE(i + 10);
+    // Get the position of the central directory
+    const directorySize = chunk.readUint32LE(i + 12);
+    const directoryOffset = chunk.readUint32LE(i + 16);
+    if (directoryOffset === 0xffff_ffff) throw new Error("zip64 not supported");
+    if (directoryOffset > size) throw new Error(`Central directory offset ${directoryOffset} is outside file`);
+    i = directoryOffset - unread;
+    // If i < 0, it means that the central directory is not contained within `chunk`
+    if (i < 0) {
+        chunk = await readFileChunk(zipFile, directoryOffset, directoryOffset + directorySize);
+        i = 0;
+    }
+    // Now iterate the central directory records, yield an `ZipRecord` for every entry
+    while (nFiles-- > 0) {
+        // Check for marker bytes
+        if (chunk.readUInt32LE(i) !== 0x02014b50) throw new Error("No central directory record at position " + (unread + i));
+        const compressionMethod = ({ 8: "deflate" } as const)[chunk.readUint16LE(i + 10)];
+        const compressedFileSize = chunk.readUint32LE(i + 20);
+        const filenameLength = chunk.readUint16LE(i + 28);
+        const extraLength = chunk.readUint16LE(i + 30);
+        const commentLength = chunk.readUint16LE(i + 32);
+        // Start of the actual content byte stream is after the 'local' record header,
+        // which is  30 bytes long plus filename and extra field
+        const start = chunk.readUint32LE(i + 42) + 30 + filenameLength + extraLength;
+        const end = start + compressedFileSize;
+        const filename = chunk.slice(i + 46, i + 46 + filenameLength).toString("utf-8");
+        const createRecordReadStream = () => {
+            const input = createReadStream(zipFile, { start, end });
+            if (compressionMethod === "deflate") {
+                const inflate = createInflateRaw();
+                input.pipe(inflate);
+                return inflate;
+            }
+            return input;
+        };
+        if (end > start) yield { path: filename, createReadStream: createRecordReadStream, compressionMethod };
+        // advance pointer to next central directory entry
+        i += 46 + filenameLength + extraLength + commentLength;
+    }
+}

src/login/Fallback.tsx

@@ -25,6 +25,7 @@ const LoginConfigTotp = lazy(() => import("keycloakify/login/pages/LoginConfigTo
 const LogoutConfirm = lazy(() => import("keycloakify/login/pages/LogoutConfirm"));
 const UpdateUserProfile = lazy(() => import("keycloakify/login/pages/UpdateUserProfile"));
 const IdpReviewUserProfile = lazy(() => import("keycloakify/login/pages/IdpReviewUserProfile"));
+const UpdateEmail = lazy(() => import("keycloakify/login/pages/UpdateEmail"));
 
 export default function Fallback(props: PageProps<KcContext, I18n>) {
     const { kcContext, ...rest } = props;
@@ -75,6 +76,8 @@ export default function Fallback(props: PageProps<KcContext, I18n>) {
                         return <UpdateUserProfile kcContext={kcContext} {...rest} />;
                     case "idp-review-user-profile.ftl":
                         return <IdpReviewUserProfile kcContext={kcContext} {...rest} />;
+                    case "update-email.ftl":
+                        return <UpdateEmail kcContext={kcContext} {...rest} />;
                 }
                 assert<Equals<typeof kcContext, never>>(false);
             })()}

src/login/kcContext/KcContext.ts

@@ -30,7 +30,8 @@ export type KcContext =
     | KcContext.LoginConfigTotp
     | KcContext.LogoutConfirm
     | KcContext.UpdateUserProfile
-    | KcContext.IdpReviewUserProfile;
+    | KcContext.IdpReviewUserProfile
+    | KcContext.UpdateEmail;
 
 export declare namespace KcContext {
     export type Common = {
@@ -101,7 +102,8 @@ export declare namespace KcContext {
         registrationDisabled: boolean;
         login: {
             username?: string;
-            rememberMe?: boolean;
+            rememberMe?: string;
+            password?: string;
         };
         usernameEditDisabled: boolean;
         social: {
@@ -182,6 +184,9 @@ export declare namespace KcContext {
         realm: {
             loginWithEmailAllowed: boolean;
         };
+        url: {
+            loginResetCredentialsUrl: string;
+        };
     };
 
     export type LoginVerifyEmail = Common & {
@@ -219,7 +224,7 @@ export declare namespace KcContext {
         registrationDisabled: boolean;
         login: {
             username?: string;
-            rememberMe?: boolean;
+            rememberMe?: string;
         };
         usernameHidden?: boolean;
         social: {
@@ -377,6 +382,13 @@ export declare namespace KcContext {
             attributesByName: Record<string, Attribute>;
         };
     };
+
+    export type UpdateEmail = Common & {
+        pageId: "update-email.ftl";
+        email: {
+            value?: string;
+        };
+    };
 }
 
 export type Attribute = {

src/login/kcContext/getKcContext.ts

@@ -121,6 +121,10 @@ export function getKcContext<KcContextExtension extends { pageId: string } = nev
         return { "kcContext": undefined };
     }
 
+    if (!("login" in realKcContext)) {
+        return { "kcContext": undefined };
+    }
+
     {
         const { url } = realKcContext;
 

src/login/kcContext/kcContextMocks.ts

@@ -260,9 +260,7 @@ export const kcContextMocks: KcContext[] = [
             "displayInfo": true
         },
         "usernameEditDisabled": false,
-        "login": {
-            "rememberMe": false
-        },
+        "login": {},
         "registrationDisabled": false
     }),
     ...(() => {
@@ -331,7 +329,8 @@ export const kcContextMocks: KcContext[] = [
         "realm": {
             ...kcContextCommonMock.realm,
             "loginWithEmailAllowed": false
-        }
+        },
+        url: loginUrl
     }),
     id<KcContext.LoginVerifyEmail>({
         ...kcContextCommonMock,
@@ -376,9 +375,7 @@ export const kcContextMocks: KcContext[] = [
             "displayInfo": true
         },
         "usernameHidden": false,
-        "login": {
-            "rememberMe": false
-        },
+        "login": {},
         "registrationDisabled": false
     }),
     id<KcContext.LoginPassword>({
@@ -494,5 +491,12 @@ export const kcContextMocks: KcContext[] = [
             attributes,
             attributesByName
         }
+    }),
+    id<KcContext.UpdateEmail>({
+        ...kcContextCommonMock,
+        "pageId": "update-email.ftl",
+        "email": {
+            value: "email@example.com"
+        }
     })
 ];

src/login/pages/IdpReviewUserProfile.tsx

@@ -1,6 +1,6 @@
 import { useState } from "react";
 import { clsx } from "keycloakify/tools/clsx";
-import { UserProfileFormFields } from "keycloakify/login/pages/shared/UserProfileCommons";
+import { UserProfileFormFields } from "keycloakify/login/pages/shared/UserProfileFormFields";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
 import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
 import type { KcContext } from "../kcContext";

src/login/pages/Login.tsx

@@ -124,7 +124,7 @@ export default function Login(props: PageProps<Extract<KcContext, { pageId: "log
                                                     id="rememberMe"
                                                     name="rememberMe"
                                                     type="checkbox"
-                                                    {...(login.rememberMe
+                                                    {...(login.rememberMe === "on"
                                                         ? {
                                                               "checked": true
                                                           }

src/login/pages/LoginUsername.tsx

@@ -109,7 +109,7 @@ export default function LoginUsername(props: PageProps<Extract<KcContext, { page
                                                     id="rememberMe"
                                                     name="rememberMe"
                                                     type="checkbox"
-                                                    {...(login.rememberMe
+                                                    {...(login.rememberMe === "on"
                                                         ? {
                                                               "checked": true
                                                           }

src/login/pages/RegisterUserProfile.tsx

@@ -1,6 +1,6 @@
 import { useState } from "react";
 import { clsx } from "keycloakify/tools/clsx";
-import { UserProfileFormFields } from "./shared/UserProfileCommons";
+import { UserProfileFormFields } from "./shared/UserProfileFormFields";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
 import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
 import type { KcContext } from "../kcContext";

src/login/pages/UpdateEmail.tsx

@@ -0,0 +1,88 @@
+import { clsx } from "keycloakify/tools/clsx";
+import type { PageProps } from "keycloakify/login/pages/PageProps";
+import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
+import type { KcContext } from "../kcContext";
+import type { I18n } from "../i18n";
+
+export default function UpdateEmail(props: PageProps<Extract<KcContext, { pageId: "update-email.ftl" }>, I18n>) {
+    const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
+
+    const { getClassName } = useGetClassName({
+        doUseDefaultCss,
+        classes
+    });
+
+    const { msg, msgStr } = i18n;
+
+    const { url, messagesPerField, isAppInitiatedAction, email } = kcContext;
+
+    return (
+        <Template {...{ kcContext, i18n, doUseDefaultCss, classes }} headerNode={msg("updateEmailTitle")}>
+            <form id="kc-update-email-form" className={getClassName("kcFormClass")} action={url.loginAction} method="post">
+                <div
+                    className={clsx(getClassName("kcFormGroupClass"), messagesPerField.printIfExists("email", getClassName("kcFormGroupErrorClass")))}
+                >
+                    <div className={getClassName("kcLabelWrapperClass")}>
+                        <label htmlFor="email" className={getClassName("kcLabelClass")}>
+                            {msg("email")}
+                        </label>
+                    </div>
+                    <div className={getClassName("kcInputWrapperClass")}>
+                        <input
+                            type="text"
+                            id="email"
+                            name="email"
+                            defaultValue={email.value ?? ""}
+                            className={getClassName("kcInputClass")}
+                            aria-invalid={messagesPerField.existsError("email")}
+                        />
+                    </div>
+                </div>
+
+                <div className={getClassName("kcFormGroupClass")}>
+                    <div id="kc-form-options" className={getClassName("kcFormOptionsClass")}>
+                        <div className={getClassName("kcFormOptionsWrapperClass")}></div>
+                    </div>
+                    <div id="kc-form-buttons" className={getClassName("kcFormButtonsClass")}>
+                        {isAppInitiatedAction ? (
+                            <>
+                                <input
+                                    className={clsx(
+                                        getClassName("kcButtonClass"),
+                                        getClassName("kcButtonPrimaryClass"),
+                                        getClassName("kcButtonLargeClass")
+                                    )}
+                                    type="submit"
+                                    defaultValue={msgStr("doSubmit")}
+                                />
+                                <button
+                                    className={clsx(
+                                        getClassName("kcButtonClass"),
+                                        getClassName("kcButtonDefaultClass"),
+                                        getClassName("kcButtonLargeClass")
+                                    )}
+                                    type="submit"
+                                    name="cancel-aia"
+                                    value="true"
+                                >
+                                    {msg("doCancel")}
+                                </button>
+                            </>
+                        ) : (
+                            <input
+                                className={clsx(
+                                    getClassName("kcButtonClass"),
+                                    getClassName("kcButtonPrimaryClass"),
+                                    getClassName("kcButtonBlockClass"),
+                                    getClassName("kcButtonLargeClass")
+                                )}
+                                type="submit"
+                                defaultValue={msgStr("doSubmit")}
+                            />
+                        )}
+                    </div>
+                </div>
+            </form>
+        </Template>
+    );
+}

src/login/pages/UpdateUserProfile.tsx

@@ -1,6 +1,6 @@
 import { useState } from "react";
 import { clsx } from "keycloakify/tools/clsx";
-import { UserProfileFormFields } from "keycloakify/login/pages/shared/UserProfileCommons";
+import { UserProfileFormFields } from "keycloakify/login/pages/shared/UserProfileFormFields";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
 import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
 import type { KcContext } from "../kcContext";

test/bin/generateKeycloakThemeResources.ts

@@ -7,7 +7,7 @@ setupSampleReactProject();
 generateKeycloakThemeResources({
     "reactAppBuildDirPath": pathJoin(sampleReactProjectDirPath, "build"),
     "keycloakThemeBuildingDirPath": pathJoin(sampleReactProjectDirPath, "build_keycloak_theme"),
-    "keycloakThemeEmailDirPath": pathJoin(sampleReactProjectDirPath, "keycloak_email"),
+    "emailThemeSrcDirPath": undefined,
     "keycloakVersion": "11.0.3",
     "buildOptions": {
         "themeName": "keycloakify-demo-app",

test/bin/setupSampleReactProject.ts

@@ -6,9 +6,7 @@ export const sampleReactProjectDirPath = pathJoin(getProjectRoot(), "sample_reac
 
 export async function setupSampleReactProject() {
     await downloadAndUnzip({
-        "url": "https://github.com/InseeFrLab/keycloakify/releases/download/v0.0.1/sample_build_dir_and_package_json.zip",
-        "destDirPath": sampleReactProjectDirPath,
-        "cacheDirPath": pathJoin(sampleReactProjectDirPath, "build_keycloak", ".cache"),
-        "isSilent": false
+        "url": "https://github.com/keycloakify/keycloakify/releases/download/v0.0.1/sample_build_dir_and_package_json.zip",
+        "destDirPath": sampleReactProjectDirPath
     });
 }