Release candidate

Change node.js 16.6.0 dependency that Array.prototype.at

.all-contributorsrc

@@ -0,0 +1,169 @@
+{
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "commitConvention": "angular",
+  "contributors": [
+    {
+      "login": "lordvlad",
+      "name": "Waldemar Reusch",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1217769?v=4",
+      "profile": "https://github.com/lordvlad",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "willwill96",
+      "name": "William Will",
+      "avatar_url": "https://avatars.githubusercontent.com/u/10997562?v=4",
+      "profile": "https://willwill96.github.io/the-ui-dawg-static-site/en/introduction/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Ann2827",
+      "name": "Bystrova Ann",
+      "avatar_url": "https://avatars.githubusercontent.com/u/32645809?v=4",
+      "profile": "https://github.com/Ann2827",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "mkreuzmayr",
+      "name": "Michael Kreuzmayr",
+      "avatar_url": "https://avatars.githubusercontent.com/u/20108212?v=4",
+      "profile": "https://github.com/mkreuzmayr",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Mstrodl",
+      "name": "Mary ",
+      "avatar_url": "https://avatars.githubusercontent.com/u/6877780?v=4",
+      "profile": "https://coolmathgames.tech",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Tasyp",
+      "name": "German Öö",
+      "avatar_url": "https://avatars.githubusercontent.com/u/6623212?v=4",
+      "profile": "https://tasyp.xyz/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "revolunet",
+      "name": "Julien Bouquillon",
+      "avatar_url": "https://avatars.githubusercontent.com/u/124937?v=4",
+      "profile": "https://revolunet.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "aidangilmore",
+      "name": "Aidan Gilmore",
+      "avatar_url": "https://avatars.githubusercontent.com/u/32880357?v=4",
+      "profile": "https://github.com/aidangilmore",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "0x-Void",
+      "name": "Void",
+      "avatar_url": "https://avatars.githubusercontent.com/u/32745739?v=4",
+      "profile": "https://github.com/0x-Void",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "juffe",
+      "name": "juffe",
+      "avatar_url": "https://avatars.githubusercontent.com/u/5393231?v=4",
+      "profile": "https://github.com/juffe",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "lazToum",
+      "name": "Lazaros Toumanidis",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4764837?v=4",
+      "profile": "https://github.com/lazToum",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "marcmrf",
+      "name": "Marc",
+      "avatar_url": "https://avatars.githubusercontent.com/u/9928519?v=4",
+      "profile": "https://github.com/marcmrf",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "kasir-barati",
+      "name": "Kasir Barati",
+      "avatar_url": "https://avatars.githubusercontent.com/u/73785723?v=4",
+      "profile": "http://kasir-barati.github.io",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "asashay",
+      "name": "Alex Oliynyk",
+      "avatar_url": "https://avatars.githubusercontent.com/u/10714670?v=4",
+      "profile": "https://github.com/asashay",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "thosil",
+      "name": "Thomas Silvestre",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1140574?v=4",
+      "profile": "https://www.gravitysoftware.be",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "satanshiro",
+      "name": "satanshiro",
+      "avatar_url": "https://avatars.githubusercontent.com/u/38865738?v=4",
+      "profile": "https://github.com/satanshiro",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "kpoelhekke",
+      "name": "Koen Poelhekke",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1632377?v=4",
+      "profile": "https://poelhekke.dev",
+      "contributions": [
+        "code"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "skipCi": true,
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "projectName": "keycloakify",
+  "projectOwner": "keycloakify"
+}

.github/workflows/ci.yaml

@@ -17,44 +17,48 @@ jobs:
     - uses: actions/setup-node@v3
     - uses: bahmutov/npm-install@v1
     - name: If this step fails run 'yarn format' then commit again.
-      run: |
-        PACKAGE_MANAGER=npm
-        if [ -f "./yarn.lock" ]; then
-            PACKAGE_MANAGER=yarn
-        fi
-        $PACKAGE_MANAGER run format:check
+      run: yarn format:check
   test:
     runs-on: ${{ matrix.os }}
     needs: test_lint
     strategy:
       matrix:
-        node: [ '16' ]
+        node: [ '18' ]
         os: [ ubuntu-latest ]
     name: Test with Node v${{ matrix.node }} on ${{ matrix.os }}
     steps:
-    - name: Tell if project is using npm or yarn
-      id: step1
-      uses: garronej/ts-ci@v2.0.2
-      with: 
-        action_name: tell_if_project_uses_npm_or_yarn
     - uses: actions/checkout@v3
     - uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node }}
     - uses: bahmutov/npm-install@v1
-    - if: steps.step1.outputs.npm_or_yarn == 'yarn'
-      run: |
-        yarn build
-        yarn test
-    - if: steps.step1.outputs.npm_or_yarn == 'npm'
-      run: |
-        npm run build
-        npm test
+    - run: yarn build
+    - run: yarn test
+    - run: yarn test:keycloakify-starter
+
+  storybook:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push'
+    needs: test
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
+      with:
+        node-version: '18'
+    - uses: bahmutov/npm-install@v1
+    - run: yarn build-storybook -o ./build_storybook
+    - run: git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${{github.repository}}.git
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - run: npx -y -p gh-pages@3.1.0 gh-pages -d ./build_storybook -u "github-actions-bot <actions@github.com>" 
+
   check_if_version_upgraded:
     name: Check if version upgrade
-    # We run this only if it's a push on the default branch or if it's a PR from a 
-    # branch (meaning not a PR from a fork). It would be more straightforward to test if secrets.NPM_TOKEN is 
-    # defined but GitHub Action don't allow it yet.
+    # When someone forks the repo and opens a PR we want to enables the tests to be run (the previous jobs)
+    # but obviously only us should be allowed to release.
+    # In the following check we make sure that we own the branch this CI workflow is running on before continuing.
+    # Without this check, trying to release would fail anyway because only us have the correct secret.NPM_TOKEN but
+    # it's cleaner to stop the execution instead of letting the CI crash.
     if: |
       github.event_name == 'push' || 
       github.event.pull_request.head.repo.owner.login == github.event.pull_request.base.repo.owner.login 
@@ -66,7 +70,7 @@ jobs:
       is_upgraded_version: ${{ steps.step1.outputs.is_upgraded_version }}
       is_pre_release: ${{steps.step1.outputs.is_pre_release }}
     steps:
-    - uses: garronej/ts-ci@v2.0.2
+    - uses: garronej/ts-ci@v2.1.0
       id: step1
       with: 
         action_name: is_package_json_version_upgraded
@@ -74,8 +78,8 @@ jobs:
 
   create_github_release:
     runs-on: ubuntu-latest
-    # We create a release only if the version have been upgraded and we are on the main branch
-    # or if we are on a branch of the repo that has an PR open on main.
+    # We create release only if the version in the package.json have been upgraded and this CI is running against the main branch.
+    # We allow branches with a PR open on main to publish pre-release (x.y.z-rc.u) but not actual releases.
     if: |
       needs.check_if_version_upgraded.outputs.is_upgraded_version == 'true' &&
       (
@@ -109,15 +113,13 @@ jobs:
       with:
         registry-url: https://registry.npmjs.org/
     - uses: bahmutov/npm-install@v1
-    - run: |
-        PACKAGE_MANAGER=npm
-        if [ -f "./yarn.lock" ]; then
-            PACKAGE_MANAGER=yarn
-        fi
-        $PACKAGE_MANAGER run build
-    - run: npx -y -p denoify@1.2.2 enable_short_npm_import_path
+    - run: yarn build
+    - run: npx -y -p denoify@1.3.0 enable_short_npm_import_path
       env:
         DRY_RUN: "0"
+    - uses: garronej/ts-ci@v2.1.0
+      with: 
+        action_name: remove_dark_mode_specific_images_from_readme
     - name: Publishing on NPM
       run: |
         if [ "$(npm show . version)" = "$VERSION" ]; then

.gitignore

@@ -41,14 +41,21 @@ jspm_packages
 .DS_Store
 
 /dist
-/dist_test
-
+/keycloakify_starter_test/
+/sample_custom_react_project/
 /sample_react_project/
 /.yarn_home/
 
 .idea
 
-/keycloak_email
-/build_keycloak
 /src/login/i18n/baseMessages/
-/src/account/i18n/baseMessages/
+/src/account/i18n/baseMessages/
+
+# VS Code devcontainers
+.devcontainer
+/.yarn
+/.yarnrc.yml
+
+/stories/assets/fonts/
+/build_storybook/
+/storybook-static/

.prettierignore

@@ -1,12 +1,15 @@
 node_modules/
 /dist/
-/dist_test/
 /CHANGELOG.md
 /.yarn_home/
 /src/test/apps/
 /src/tools/types/
-/sample_react_project
 /build_keycloak/
 /.vscode/
 /src/login/i18n/baseMessages/
 /src/account/i18n/baseMessages/
+/dist_test
+/sample_react_project/
+/sample_custom_react_project/
+/keycloakify_starter_test/
+/.storybook/static/keycloak-resources/

.storybook/Containers.js

@@ -0,0 +1,76 @@
+
+import React from "react";
+import { DocsContainer as BaseContainer } from "@storybook/addon-docs";
+import { useDarkMode } from "storybook-dark-mode";
+import { darkTheme, lightTheme } from "./customTheme";
+import "./static/fonts/WorkSans/font.css";
+
+export function DocsContainer({ children, context }) {
+    const isStorybookUiDark = useDarkMode();
+
+    const theme = isStorybookUiDark ? darkTheme : lightTheme;
+
+    const backgroundColor = theme.appBg;
+
+    return (
+        <>
+            <style>{`
+                body {
+                    padding: 0 !important;
+                    background-color: ${backgroundColor};
+                }
+
+                .docs-story {
+                    background-color: ${backgroundColor};
+                }
+                [id^=story--] .container {
+                    border: 1px dashed #e8e8e8;
+                }
+
+                .docblock-argstable-head th:nth-child(3), .docblock-argstable-body tr > td:nth-child(3) {
+                    visibility: collapse;
+                }
+
+                .docblock-argstable-head th:nth-child(3), .docblock-argstable-body tr > td:nth-child(2) p {
+                    font-size: 13px;
+                }
+
+            `}</style>
+            <BaseContainer
+                context={{
+                    ...context,
+                    "storyById": id => {
+                        const storyContext = context.storyById(id);
+                        return {
+                            ...storyContext,
+                            "parameters": {
+                                ...storyContext?.parameters,
+                                "docs": {
+                                    ...storyContext?.parameters?.docs,
+                                    "theme": isStorybookUiDark ? darkTheme : lightTheme
+                                }
+                            }
+                        };
+                    }
+                }}
+            >
+                {children}
+            </BaseContainer>
+        </>
+    );
+}
+
+export function CanvasContainer({ children }) {
+
+    return (
+        <>
+            <style>{`
+                body {
+                    padding: 0 !important;
+                }
+            `}</style>
+            {children}
+        </>
+    );
+
+}

.storybook/customTheme.js

@@ -0,0 +1,35 @@
+import { create } from "@storybook/theming";
+
+const brandImage = "logo.png";
+const brandTitle = "Keycloakify";
+const brandUrl = "https://github.com/keycloakify/keycloakify";
+const fontBase = '"Work Sans", sans-serif';
+const fontCode = "monospace";
+
+export const darkTheme = create({
+    "base": "dark",
+    "appBg": "#1E1E1E",
+    "appContentBg": "#161616",
+    "barBg": "#161616",
+    "colorSecondary": "#8585F6",
+    "textColor": "#FFFFFF",
+    brandImage,
+    brandTitle,
+    brandUrl,
+    fontBase,
+    fontCode
+});
+
+export const lightTheme = create({
+    "base": "light",
+    "appBg": "#F6F6F6",
+    "appContentBg": "#FFFFFF",
+    "barBg": "#FFFFFF",
+    "colorSecondary": "#000091",
+    "textColor": "#212121",
+    brandImage,
+    brandTitle,
+    brandUrl,
+    fontBase,
+    fontCode
+});

.storybook/main.js

@@ -0,0 +1,15 @@
+module.exports = {
+    "stories": [
+        "../stories/**/*.stories.@(ts|tsx|mdx)"
+    ],
+    "addons": [
+        "@storybook/addon-links",
+        "@storybook/addon-essentials",
+        "storybook-dark-mode",
+        "@storybook/addon-a11y"
+    ],
+    "core": {
+        "builder": "webpack5"
+    },
+    "staticDirs": ["./static"]
+};

.storybook/manager-head.html

@@ -0,0 +1,32 @@
+<!-- start favicon -->
+<link rel="apple-touch-icon" sizes="180x180" href="/favicon_package/apple-touch-icon.png">
+<link rel="icon" type="image/png" sizes="32x32" href="/favicon_package/favicon-32x32.png">
+<link rel="icon" type="image/png" sizes="16x16" href="/favicon_package/favicon-16x16.png">
+<link rel="manifest" href="/favicon_package/site.webmanifest">
+<link rel="mask-icon" href="/favicon_package/safari-pinned-tab.svg" color="#5bbad5">
+<!-- end favicon -->
+
+<!-- Meta tags generated by metatags.io -->
+<!-- Primary Meta Tags -->
+<title>Keycloakify Storybook</title>
+<meta name="title" content="Keycloakify Storybook">
+<meta name="description" content="Storybook of default components to use as a reference when building a custom Keycloak theme">
+
+<!-- Facebook Meta Tags -->
+<meta property="og:url" content="https://www.keycloakify.dev">
+<meta property="og:type" content="website">
+<meta property="og:title" content="Keycloakify Storybook">
+<meta property="og:description" content="Storybook of default components to use as a reference when building a custom Keycloak theme">
+<meta property="og:image" content="https://storybook.keycloakify.dev/preview.png">
+
+<!-- Twitter Meta Tags -->
+<meta name="twitter:card" content="summary_large_image">
+<meta name="twitter:title" content="Keycloakify Storybook">
+<meta name="twitter:description" content="Storybook of default components to use as a reference when building a custom Keycloak theme">
+<meta name="twitter:image" content="https://storybook.keycloakify.dev/preview.png">
+
+<link rel="preload" href="/fonts/WorkSans/worksans-bold-webfont.woff2" as="font" crossorigin="anonymous">
+<link rel="preload" href="/fonts/WorkSans/worksans-medium-webfont.woff2" as="font" crossorigin="anonymous">
+<link rel="preload" href="/fonts/WorkSans/worksans-regular-webfont.woff2" as="font" crossorigin="anonymous">
+<link rel="preload" href="/fonts/WorkSans/worksans-semibold-webfont.woff2" as="font" crossorigin="anonymous">
+<link rel="stylesheet" type="text/css" href="/fonts/WorkSans/font.css">

.storybook/manager.js

@@ -0,0 +1,6 @@
+import { addons } from '@storybook/addons';
+
+addons.setConfig({
+  "selectedPanel": 'storybook/a11y/panel',
+  "showPanel": false,
+});

.storybook/preview.js

@@ -0,0 +1,137 @@
+import { darkTheme, lightTheme } from "./customTheme";
+import { DocsContainer, CanvasContainer } from "./Containers";
+
+export const parameters = {
+    "actions": { "argTypesRegex": "^on[A-Z].*" },
+    "controls": {
+        "matchers": {
+            "color": /(background|color)$/i,
+            "date": /Date$/,
+        },
+    },
+    "backgrounds": { "disable": true },
+    "darkMode": {
+        "light": lightTheme,
+        "dark": darkTheme,
+    },
+    "docs": {
+        "container": DocsContainer
+    },
+    "controls": {
+        "disable": true,
+    },
+    "actions": {
+        "disable": true
+    },
+    "viewport": {
+        "viewports": {
+            "1440p": {
+                "name": "1440p",
+                "styles": {
+                    "width": "2560px",
+                    "height": "1440px",
+                },
+            },
+            "fullHD": {
+                "name": "Full HD",
+                "styles": {
+                    "width": "1920px",
+                    "height": "1080px",
+                },
+            },
+            "macBookProBig": {
+                "name": "MacBook Pro Big",
+                "styles": {
+                    "width": "1024px",
+                    "height": "640px",
+                },
+            },
+            "macBookProMedium": {
+                "name": "MacBook Pro Medium",
+                "styles": {
+                    "width": "1440px",
+                    "height": "900px",
+                },
+            },
+            "macBookProSmall": {
+                "name": "MacBook Pro Small",
+                "styles": {
+                    "width": "1680px",
+                    "height": "1050px",
+                },
+            },
+            "pcAgent": {
+                "name": "PC Agent",
+                "styles": {
+                    "width": "960px",
+                    "height": "540px",
+                },
+            },
+            "iphone12Pro": {
+                "name": "Iphone 12 pro",
+                "styles": {
+                    "width": "390px",
+                    "height": "844px",
+                },
+            },
+            "iphone5se": {
+                "name": "Iphone 5/SE",
+                "styles": {
+                    "width": "320px",
+                    "height": "568px",
+                },
+            },
+            "ipadPro": {
+                "name": "Ipad pro",
+                "styles": {
+                    "width": "1240px",
+                    "height": "1366px",
+                },
+            },
+            "Galaxy s9+": {
+                "name": "Galaxy S9+",
+                "styles": {
+                    "width": "320px",
+                    "height": "658px",
+                },
+            }
+        },
+    },
+    "options": {
+        "storySort": (a, b) =>
+            getHardCodedWeight(b[1].kind) - getHardCodedWeight(a[1].kind),
+    },
+};
+
+export const decorators = [
+    (Story) => (
+        <CanvasContainer>
+            <Story />
+        </CanvasContainer>
+    ),
+];
+
+const { getHardCodedWeight } = (() => {
+
+    const orderedPagesPrefix = [
+        "Introduction",
+        "login/login.ftl",
+        "login/register-user-profile.ftl",
+        "login/register.ftl",
+        "login/terms.ftl",
+        "login/error.ftl",
+    ];
+
+    function getHardCodedWeight(kind) {
+
+        for (let i = 0; i < orderedPagesPrefix.length; i++) {
+            if (kind.toLowerCase().startsWith(orderedPagesPrefix[i].toLowerCase())) {
+                return orderedPagesPrefix.length - i;
+            }
+        }
+
+        return 0;
+    }
+
+    return { getHardCodedWeight };
+})();

.storybook/static/CNAME

@@ -0,0 +1 @@
+storybook.keycloakify.dev

.storybook/static/favicon_package/browserconfig.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<browserconfig>
+    <msapplication>
+        <tile>
+            <square150x150logo src="/mstile-150x150.png"/>
+            <TileColor>#da532c</TileColor>
+        </tile>
+    </msapplication>
+</browserconfig>

.storybook/static/favicon_package/safari-pinned-tab.svg

@@ -0,0 +1,193 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
+ "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
+<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
+ width="447.000000pt" height="447.000000pt" viewBox="0 0 447.000000 447.000000"
+ preserveAspectRatio="xMidYMid meet">
+<metadata>
+Created by potrace 1.14, written by Peter Selinger 2001-2017
+</metadata>
+<g transform="translate(0.000000,447.000000) scale(0.100000,-0.100000)"
+fill="#000000" stroke="none">
+<path d="M2177 4413 c-3 -2 -17 -6 -33 -9 -85 -15 -204 -109 -286 -225 -95
+-133 -229 -437 -263 -597 -4 -18 -10 -30 -13 -28 -4 2 -7 -11 -8 -30 0 -19 -3
+-36 -6 -39 -3 -4 -23 1 -44 10 -51 22 -213 73 -289 92 -301 73 -516 74 -670 3
+-124 -57 -186 -153 -188 -295 -1 -67 5 -128 18 -180 3 -13 15 -45 26 -70 43
+-99 57 -135 53 -135 -3 0 4 -10 16 -22 11 -12 20 -26 20 -31 0 -5 9 -22 21
+-38 11 -16 18 -29 14 -29 -3 0 4 -10 15 -22 11 -12 18 -28 15 -36 -2 -7 -1
+-11 3 -8 4 2 19 -12 32 -32 13 -20 33 -47 44 -59 11 -13 17 -23 13 -23 -3 0
+12 -19 33 -42 22 -24 38 -49 35 -55 -2 -7 -1 -12 4 -10 4 1 32 -25 62 -58 30
+-33 88 -94 131 -135 l76 -75 -71 -70 c-112 -110 -174 -181 -262 -300 -106
+-144 -142 -202 -203 -325 -9 -19 -21 -38 -27 -42 -5 -4 -7 -8 -3 -8 4 0 -4
+-27 -18 -60 -25 -63 -58 -199 -50 -208 3 -2 1 -12 -4 -22 -5 -10 -6 -20 -3
+-24 4 -4 8 -23 10 -44 9 -107 77 -201 183 -251 33 -16 56 -32 52 -36 -4 -5 -2
+-5 4 -2 6 4 44 1 85 -6 41 -7 102 -12 136 -12 41 1 60 -2 55 -9 -3 -6 2 -5 11
+3 11 8 44 14 86 15 38 0 67 4 64 9 -4 6 10 8 79 11 14 0 24 3 22 5 -4 4 33 14
+145 37 13 3 33 10 43 15 11 6 26 8 34 5 10 -4 12 -2 8 6 -5 8 -2 9 9 5 10 -3
+17 -2 17 3 0 6 8 10 18 10 9 0 36 9 58 19 32 15 45 16 54 8 9 -9 11 -9 8 2 -2
+7 2 15 8 18 10 3 23 -34 38 -108 2 -8 6 -21 9 -29 15 -36 70 -206 70 -217 0
+-7 4 -13 8 -13 11 0 30 -61 22 -74 -3 -6 -3 -8 2 -4 8 7 86 -135 88 -159 0 -7
+4 -13 8 -13 13 0 39 -56 31 -66 -4 -5 -3 -6 2 -2 5 4 22 -12 39 -35 17 -23 49
+-59 71 -80 23 -21 40 -42 39 -47 -2 -6 0 -9 5 -8 15 3 63 -22 68 -37 3 -8 10
+-12 15 -10 5 3 22 -1 39 -10 17 -9 35 -13 40 -10 6 3 10 2 10 -2 0 -5 12 -8
+28 -8 15 1 33 -4 41 -9 11 -8 13 -8 8 0 -4 7 7 13 33 17 21 3 53 12 71 21 17
+9 36 13 42 9 5 -3 7 -1 3 5 -3 6 3 13 14 17 11 3 20 11 20 16 0 5 5 9 11 9 5
+0 7 -6 3 -13 -4 -7 -3 -9 2 -4 5 5 9 12 9 17 0 4 14 21 30 37 69 67 162 196
+179 251 4 12 12 20 17 16 5 -3 8 -2 7 3 -1 4 6 29 17 56 14 33 24 45 35 41 11
+-4 12 -2 4 6 -14 14 -6 52 9 43 5 -3 7 -2 4 4 -3 5 8 45 24 88 17 44 33 86 35
+94 7 34 56 206 59 209 1 1 15 -3 31 -9 16 -7 34 -13 39 -15 61 -18 144 -51
+139 -56 -3 -4 3 -4 14 -1 11 2 23 0 26 -6 4 -5 14 -7 23 -4 9 4 14 2 10 -3 -3
+-5 7 -9 21 -8 34 1 63 -6 58 -15 -2 -3 19 -7 47 -9 28 -2 55 -6 61 -10 13 -8
+18 -9 79 -10 27 -1 46 -5 44 -9 -3 -5 20 -6 50 -5 44 3 54 1 48 -10 -6 -10 -5
+-11 6 0 16 15 33 16 23 0 -5 -7 -3 -8 7 -3 7 5 29 10 49 12 74 5 116 11 135
+18 11 4 37 13 57 21 28 10 38 11 41 1 4 -8 6 -7 6 3 1 8 21 28 46 44 43 26 92
+86 109 131 28 73 27 217 -3 313 -5 18 -10 33 -9 35 2 23 -118 257 -184 356
+-44 67 -124 177 -138 191 -3 3 -34 39 -70 80 -36 41 -97 107 -137 146 l-72 71
+25 22 c14 12 30 19 36 15 6 -4 8 -3 4 4 -3 6 24 42 61 80 38 38 86 91 108 117
+22 27 46 54 53 61 6 7 12 17 12 23 0 6 3 11 8 11 4 0 22 22 41 50 19 27 37 47
+41 45 4 -3 7 3 6 13 0 9 5 16 12 14 8 -1 11 2 7 7 -5 9 36 83 55 101 5 5 101
+200 121 245 7 18 26 84 36 125 2 8 4 27 5 42 0 16 5 25 11 21 6 -4 7 -1 2 7
+-11 18 -11 62 0 80 5 8 4 11 -2 7 -6 -4 -12 10 -16 36 -6 51 -10 70 -18 77 -3
+3 -15 21 -27 41 -42 70 -184 145 -292 155 -205 20 -451 -18 -709 -108 -30 -10
+-60 -17 -68 -14 -8 3 -12 2 -9 -3 5 -7 -42 -31 -60 -31 -1 0 -5 15 -9 33 -18
+86 -108 342 -156 444 -17 35 -29 66 -29 69 1 4 -2 10 -7 13 -5 3 -24 32 -42
+64 -108 190 -245 296 -403 311 -20 2 -39 2 -41 -1z m53 -124 c0 -5 5 -7 10 -4
+14 9 52 -4 45 -16 -3 -5 0 -6 8 -4 17 7 69 -33 61 -47 -5 -7 -2 -8 5 -4 13 8
+43 -23 35 -36 -3 -4 1 -6 8 -3 7 2 24 -11 38 -31 14 -19 30 -41 35 -47 50 -56
+148 -233 139 -249 -4 -6 -3 -9 2 -5 12 7 97 -192 90 -210 -3 -8 -2 -12 3 -9
+11 7 45 -120 35 -135 -4 -8 -3 -9 4 -5 7 4 12 3 12 -3 0 -5 3 -16 6 -25 4 -11
+-23 -30 -113 -75 -138 -71 -276 -145 -350 -189 -29 -17 -53 -29 -53 -26 0 3
+-7 -1 -15 -10 -14 -14 -19 -13 -53 6 -20 11 -62 34 -92 51 -30 16 -59 33 -65
+37 -5 4 -86 47 -180 95 -93 48 -173 91 -177 94 -11 10 3 52 15 44 6 -3 7 -1 3
+6 -9 14 12 113 22 107 4 -2 8 7 8 20 2 24 42 134 53 144 3 3 7 12 9 20 2 8 17
+44 33 80 24 50 32 61 40 50 8 -11 9 -10 4 7 -5 17 10 47 60 123 36 55 71 98
+76 94 5 -3 9 -2 8 3 -4 23 2 35 17 29 8 -3 12 -2 9 3 -7 12 60 78 100 99 25
+13 70 27 98 31 4 1 7 -4 7 -10z m-1411 -783 c9 -6 12 -5 8 1 -4 6 10 10 34 11
+29 1 38 -1 33 -11 -5 -9 -4 -9 7 1 7 6 19 12 27 12 8 0 10 -5 6 -12 -6 -10 -5
+-10 7 -1 9 7 26 10 40 8 13 -3 47 -8 74 -11 63 -7 155 -23 175 -31 15 -6 35
+-10 71 -12 12 -1 17 -5 13 -13 -4 -7 -3 -8 4 -4 6 4 31 1 54 -5 24 -7 49 -13
+55 -15 25 -5 73 -29 73 -37 0 -5 4 -6 9 -3 12 8 41 -4 41 -16 0 -5 -4 -6 -10
+-3 -6 3 -7 -1 -4 -9 3 -9 1 -45 -5 -81 -6 -36 -14 -91 -17 -122 -4 -32 -11
+-61 -18 -65 -8 -6 -7 -8 2 -8 7 0 11 -4 8 -8 -3 -4 -8 -42 -11 -83 -4 -40 -9
+-81 -12 -89 -3 -8 -6 -44 -8 -80 -1 -36 -3 -65 -4 -65 -1 0 -3 -27 -4 -61 -3
+-66 0 -62 -92 -139 -33 -27 -62 -53 -63 -58 -2 -4 -8 -5 -13 -1 -5 3 -9 1 -9
+-3 0 -5 -41 -44 -91 -88 -50 -43 -98 -85 -106 -93 -13 -14 -23 -6 -91 64 -86
+90 -172 188 -186 213 -5 9 -12 18 -16 21 -12 9 -106 154 -139 215 -18 33 -37
+66 -43 72 -6 7 -8 20 -4 28 3 9 2 14 -3 11 -19 -12 -102 225 -105 296 0 27 -4
+48 -7 48 -16 0 9 108 32 142 22 31 125 81 151 74 10 -2 18 0 18 5 0 5 14 7 30
+5 17 -2 30 0 30 4 0 9 42 7 59 -4z m2823 1 c6 -9 8 -9 8 1 0 7 4 10 10 7 5 -3
+29 -8 52 -11 113 -13 201 -66 197 -118 0 -5 4 -12 10 -15 9 -6 11 -27 11 -124
+0 -16 -4 -26 -9 -23 -5 3 -7 -2 -4 -13 11 -41 -89 -307 -110 -294 -6 3 -7 1
+-3 -6 13 -20 -142 -281 -166 -281 -6 0 -8 -3 -5 -7 11 -10 -51 -84 -197 -238
+l-86 -89 -47 44 c-26 25 -52 50 -58 55 -7 6 -39 33 -71 61 -33 29 -86 73 -119
+100 -86 69 -87 71 -90 112 -5 69 -16 207 -21 242 -4 33 -10 92 -18 170 -4 37
+-14 114 -21 165 -2 17 -9 52 -14 80 -5 27 -9 50 -8 51 50 22 109 44 129 48 15
+2 36 10 48 16 12 6 28 9 35 6 8 -3 15 -1 17 5 2 5 19 11 39 13 20 2 40 6 45 9
+5 3 29 8 54 12 25 4 48 9 52 11 5 3 8 -1 8 -8 0 -9 2 -10 8 -2 9 16 43 21 61
+10 10 -7 12 -6 6 4 -6 10 -3 12 12 8 12 -3 25 -3 31 1 20 12 206 11 214 -2z
+m-1950 -189 c23 -13 46 -27 49 -31 3 -5 9 -8 13 -7 15 3 64 -25 59 -34 -3 -5
+-1 -6 5 -2 14 9 63 -14 55 -27 -3 -6 -2 -7 4 -4 5 3 56 -21 113 -53 57 -33
+107 -60 111 -60 4 0 11 -5 15 -12 5 -8 2 -9 -9 -5 -9 3 -16 2 -14 -2 1 -5 -48
+-42 -110 -83 -61 -40 -144 -95 -183 -123 -40 -27 -80 -54 -89 -60 -9 -5 -18
+-12 -21 -15 -17 -17 -80 -60 -80 -54 0 3 -9 -4 -20 -17 l-20 -24 6 105 c3 58
+7 121 9 140 2 19 5 52 6 72 1 20 5 36 8 34 3 -2 7 19 7 47 2 79 15 149 31 176
+8 13 10 20 4 17 -6 -4 -11 -2 -11 3 0 6 4 11 10 11 5 0 7 7 4 15 -8 20 -4 19
+48 -7z m1114 -66 c3 -26 8 -56 10 -67 10 -50 19 -145 19 -192 0 -28 3 -49 7
+-47 4 3 6 -16 5 -41 -1 -25 0 -45 3 -45 3 0 6 -32 7 -70 2 -39 -1 -70 -5 -70
+-5 0 -18 9 -30 20 -12 11 -26 20 -31 20 -5 0 -17 10 -25 22 -9 12 -16 19 -16
+15 0 -6 -92 56 -135 90 -25 20 -253 169 -278 182 -15 8 -26 15 -25 16 9 7 158
+95 184 108 17 9 34 13 38 10 3 -4 6 -1 6 5 0 11 175 102 197 102 7 0 13 4 13
+9 0 5 8 11 18 13 20 4 29 -14 38 -80z m-531 -268 c30 -20 55 -41 55 -45 0 -5
+6 -8 13 -6 6 1 11 -4 9 -11 -1 -8 2 -11 7 -7 14 8 82 -38 76 -52 -2 -7 2 -10
+11 -6 8 3 25 -3 37 -14 12 -11 35 -27 50 -37 16 -9 25 -22 21 -28 -4 -7 -3 -8
+4 -4 10 6 242 -148 250 -166 2 -5 9 -8 16 -8 7 0 21 -9 31 -20 17 -19 14 -24
+-10 -21 -5 1 -3 -4 5 -11 12 -10 15 -40 16 -138 0 -77 -4 -128 -10 -132 -7 -5
+-7 -8 -1 -8 12 0 14 -259 2 -277 -5 -7 -4 -13 1 -13 12 0 7 -79 -5 -90 -7 -7
+-244 -174 -287 -203 -10 -6 -24 -16 -30 -22 -12 -10 -34 -26 -211 -146 -96
+-65 -108 -71 -131 -60 -14 6 -22 16 -19 21 3 5 0 7 -7 5 -8 -3 -23 4 -35 15
+-12 11 -24 20 -27 20 -5 0 -246 166 -271 187 -5 4 -30 22 -55 38 -25 17 -49
+33 -55 38 -5 4 -44 31 -85 61 l-75 54 0 337 c1 317 2 338 19 351 11 7 23 11
+29 7 6 -3 7 -1 3 5 -4 7 3 17 18 24 14 6 26 15 26 20 0 4 7 8 15 8 8 0 15 5
+15 11 0 6 7 8 16 5 8 -3 13 -2 9 3 -3 5 12 20 32 32 21 13 41 27 44 32 4 5 12
+6 19 2 8 -5 11 -4 7 2 -9 15 38 44 60 37 12 -4 14 -3 6 3 -9 6 1 19 37 46 27
+20 54 37 59 37 5 0 11 3 13 8 5 12 131 95 144 95 7 0 12 4 11 8 -2 8 51 47 66
+48 4 1 32 -15 62 -35z m-822 -752 c2 -270 4 -262 -48 -215 -12 10 -41 34 -65
+53 -43 33 -83 67 -157 136 l-34 31 57 49 c177 153 219 185 228 176 4 -4 7 -2
+6 3 -4 17 0 29 6 23 3 -4 6 -119 7 -256z m1539 245 c7 -7 26 -20 41 -30 15
+-10 25 -23 21 -29 -4 -7 -3 -8 4 -4 7 4 12 2 12 -3 0 -6 6 -10 13 -8 6 1 11
+-4 9 -11 -1 -8 2 -11 7 -8 5 4 14 -2 20 -11 5 -10 13 -18 18 -18 4 0 7 -3 6
+-7 -2 -5 1 -7 5 -5 5 1 37 -22 71 -52 l62 -54 -53 -49 c-29 -27 -66 -59 -81
+-71 -16 -12 -34 -27 -41 -33 -43 -40 -129 -105 -133 -101 -2 3 0 14 6 25 7 13
+7 23 -2 32 -9 10 -9 14 1 17 6 3 9 9 6 14 -5 9 -8 289 -4 314 1 6 2 14 1 19
+-4 22 -8 86 -5 86 1 0 9 -6 16 -13z m-1862 -353 c48 -45 72 -65 109 -93 17
+-13 31 -30 31 -37 0 -8 3 -13 8 -13 21 4 32 -3 32 -18 0 -9 3 -14 6 -10 4 3
+13 -1 21 -9 8 -8 30 -26 49 -40 18 -15 31 -31 27 -37 -3 -5 -2 -7 4 -4 23 14
+43 -19 48 -78 10 -127 16 -186 40 -410 4 -33 10 -79 14 -102 5 -27 4 -46 -3
+-54 -8 -9 -8 -10 0 -6 7 4 14 -2 17 -13 3 -11 0 -20 -5 -20 -6 0 -5 -6 2 -15
+7 -8 10 -26 8 -40 -3 -13 -1 -22 3 -19 5 3 9 1 9 -5 0 -8 -35 -25 -50 -23 -3
+0 -14 -5 -25 -11 -11 -6 -22 -12 -25 -12 -3 -1 -36 -11 -75 -23 -61 -18 -120
+-33 -190 -48 -11 -2 -40 -7 -65 -10 -25 -3 -49 -8 -53 -11 -5 -3 -70 -6 -145
+-8 -122 -3 -168 0 -263 18 -72 14 -145 78 -155 136 -3 20 -8 44 -11 54 -2 9
+-1 17 4 17 4 0 8 17 7 37 -1 50 6 74 20 66 8 -4 8 -3 0 6 -12 14 33 164 47
+155 5 -3 6 2 3 10 -3 9 6 36 20 62 14 26 26 53 26 60 0 8 5 14 10 14 6 0 10 5
+10 11 0 22 93 168 103 162 6 -3 7 -2 4 4 -10 17 64 118 77 105 4 -3 5 0 2 8
+-4 9 12 35 39 65 25 28 73 80 106 117 34 38 65 65 70 62 5 -3 8 -2 7 3 -5 13
+26 42 37 35 6 -3 26 -21 45 -38z m2364 -103 c-1 -3 7 -12 18 -19 10 -7 15 -18
+12 -24 -4 -6 -2 -8 3 -5 6 4 21 -8 34 -25 13 -17 29 -36 34 -42 30 -33 63 -84
+58 -90 -4 -3 -1 -6 5 -6 17 0 85 -108 76 -121 -4 -7 -3 -9 3 -6 13 8 106 -169
+97 -185 -4 -6 -3 -8 3 -5 12 7 36 -50 28 -63 -3 -4 1 -10 9 -13 7 -3 17 -23
+21 -44 5 -21 10 -45 12 -53 2 -8 4 -24 6 -35 1 -11 6 -23 10 -26 5 -3 8 -36 8
+-73 0 -178 -108 -238 -417 -231 -78 2 -150 5 -161 8 -10 3 -34 8 -53 11 -19 3
+-48 8 -65 11 -114 22 -337 94 -329 106 3 5 -2 6 -12 2 -12 -5 -15 -2 -11 13 6
+20 16 78 22 129 2 17 6 46 9 65 3 19 8 60 11 90 3 30 8 69 11 87 2 17 7 62 10
+100 3 37 10 73 15 80 7 7 6 14 -1 18 -6 3 -7 12 -3 18 4 6 6 26 5 45 -2 25 1
+32 10 26 10 -6 10 -5 2 7 -16 21 -6 71 18 88 11 8 30 25 41 38 11 12 24 23 29
+23 4 0 25 16 45 36 63 60 110 94 118 86 5 -4 5 -2 2 4 -4 7 9 24 29 39 20 15
+49 40 66 57 l30 29 71 -72 c40 -39 71 -74 71 -78z m-1901 -294 c-3 -5 -2 -7 4
+-4 12 8 83 -39 83 -55 0 -6 3 -8 6 -5 7 7 136 -80 142 -95 2 -4 10 -8 18 -8 8
+0 14 -3 14 -8 0 -4 20 -18 45 -32 25 -14 45 -28 45 -32 0 -5 5 -8 10 -8 12 0
+124 -72 128 -82 2 -5 11 -8 20 -8 10 0 -36 -32 -101 -70 -65 -39 -124 -67
+-130 -64 -7 4 -8 3 -4 -2 5 -5 -41 -33 -110 -66 -80 -38 -120 -52 -125 -45 -3
+7 -9 32 -12 57 -3 25 -8 58 -11 74 -3 15 -8 49 -11 75 -3 25 -7 62 -9 81 -2
+19 -7 62 -10 94 -3 33 -8 64 -11 68 -3 4 0 8 6 8 6 0 8 5 4 11 -3 6 -8 43 -11
+82 -5 65 -4 70 11 58 9 -7 13 -18 9 -24z m1261 -64 c-4 -94 -9 -162 -18 -228
+-2 -16 -7 -55 -10 -85 -4 -30 -8 -62 -10 -70 -1 -8 -7 -37 -11 -65 -5 -27 -10
+-53 -11 -57 -1 -5 -2 -13 -3 -20 -1 -9 -4 -9 -13 0 -7 7 -20 12 -30 12 -10 0
+-18 5 -18 12 0 6 -3 9 -6 5 -4 -3 -54 19 -113 50 -58 31 -123 64 -143 75 -21
+10 -38 23 -38 29 0 6 -4 8 -9 5 -5 -3 -19 2 -32 12 -13 10 -37 24 -52 32 -25
+12 -26 15 -10 24 10 6 22 11 26 11 4 0 11 5 15 12 4 6 13 13 21 15 8 2 24 12
+36 23 13 12 36 27 52 35 15 8 35 21 43 28 8 7 18 12 23 12 4 0 16 8 26 18 42
+37 52 43 64 36 6 -4 9 -3 4 1 -9 11 43 46 56 38 6 -3 7 -2 4 4 -3 5 27 33 68
+62 41 28 77 56 80 61 12 20 13 8 9 -87z m-524 -403 c8 -5 30 -17 48 -26 17 -9
+32 -21 32 -26 0 -5 4 -7 9 -3 5 3 36 -11 68 -30 32 -19 63 -35 69 -35 5 0 21
+-10 34 -22 14 -13 25 -21 25 -18 1 8 154 -64 155 -73 0 -5 -4 -5 -10 -2 -6 4
+-7 -1 -3 -10 3 -10 0 -21 -8 -26 -11 -6 -11 -9 -1 -9 9 0 10 -5 4 -17 -5 -10
+-15 -40 -21 -68 -7 -27 -18 -63 -26 -80 -7 -16 -24 -58 -36 -92 -13 -34 -28
+-59 -33 -56 -5 3 -6 1 -3 -4 9 -14 -22 -75 -34 -68 -5 4 -6 -1 -3 -10 4 -9 -5
+-33 -20 -55 -14 -22 -26 -42 -26 -46 0 -3 -19 -33 -42 -67 -185 -267 -312
+-305 -471 -142 -56 56 -164 205 -150 205 4 0 3 4 -3 8 -14 8 -97 164 -109 202
+-4 14 -16 43 -26 65 -25 55 -76 216 -81 251 -2 23 1 29 14 28 10 -1 16 1 14 5
+-3 4 19 18 47 31 29 13 55 29 59 35 4 5 8 7 8 3 0 -4 23 6 50 22 28 16 50 26
+50 22 0 -4 4 -2 8 3 4 6 25 19 47 30 22 11 47 25 55 31 38 28 169 92 176 86 4
+-4 4 -2 1 5 -19 32 42 11 133 -47z"/>
+<path d="M2556 3192 c-3 -5 1 -9 9 -9 8 0 12 4 9 9 -3 4 -7 8 -9 8 -2 0 -6 -4
+-9 -8z"/>
+<path d="M2455 2831 c-3 -5 -2 -12 3 -15 5 -3 9 1 9 9 0 17 -3 19 -12 6z"/>
+<path d="M2500 2790 c-9 -6 -10 -10 -3 -10 6 0 15 5 18 10 8 12 4 12 -15 0z"/>
+<path d="M2144 2592 c-70 -35 -108 -103 -100 -179 3 -38 32 -93 62 -118 9 -7
+1 -43 -31 -140 -65 -196 -66 -176 5 -173 33 2 60 -1 60 -5 0 -5 4 -6 8 -3 13
+8 227 10 239 3 18 -11 23 7 13 39 -6 16 -28 83 -49 149 l-39 120 29 27 c16 16
+29 30 29 33 0 22 1 26 8 22 4 -3 8 20 8 51 3 88 -33 145 -108 176 -44 19 -96
+18 -134 -2z"/>
+<path d="M1113 2105 c0 -8 4 -12 9 -9 5 3 6 10 3 15 -9 13 -12 11 -12 -6z"/>
+<path d="M859 1903 c-13 -16 -12 -17 4 -4 9 7 17 15 17 17 0 8 -8 3 -21 -13z"/>
+<path d="M1436 1803 c-6 -14 -5 -15 5 -6 7 7 10 15 7 18 -3 3 -9 -2 -12 -12z"/>
+<path d="M3760 1596 c0 -2 8 -10 18 -17 15 -13 16 -12 3 4 -13 16 -21 21 -21
+13z"/>
+<path d="M1616 1691 c-3 -5 2 -15 12 -22 15 -12 16 -12 5 2 -7 9 -10 19 -6 22
+3 4 4 7 0 7 -3 0 -8 -4 -11 -9z"/>
+<path d="M2710 1590 c0 -5 5 -10 11 -10 5 0 7 5 4 10 -3 6 -8 10 -11 10 -2 0
+-4 -4 -4 -10z"/>
+<path d="M1090 831 c0 -6 4 -13 10 -16 6 -3 7 1 4 9 -7 18 -14 21 -14 7z"/>
+</g>
+</svg>

.storybook/static/favicon_package/site.webmanifest

@@ -0,0 +1,19 @@
+{
+    "name": "",
+    "short_name": "",
+    "icons": [
+        {
+            "src": "/android-chrome-192x192.png",
+            "sizes": "192x192",
+            "type": "image/png"
+        },
+        {
+            "src": "/android-chrome-384x384.png",
+            "sizes": "384x384",
+            "type": "image/png"
+        }
+    ],
+    "theme_color": "#ffffff",
+    "background_color": "#ffffff",
+    "display": "standalone"
+}

.storybook/static/fonts/WorkSans/font.css

@@ -0,0 +1,37 @@
+/* latin */
+@font-face {
+  font-family: 'Work Sans';
+  font-style: normal;
+  font-weight: normal;
+  /*400*/
+  font-display: swap;
+  src: url("./worksans-regular-webfont.woff2") format("woff2");
+}
+
+/* latin */
+@font-face {
+  font-family: 'Work Sans';
+  font-style: normal;
+  font-weight: 500;
+  font-display: swap;
+  src: url("./worksans-medium-webfont.woff2") format("woff2");
+}
+
+/* latin */
+@font-face {
+  font-family: 'Work Sans';
+  font-style: normal;
+  font-weight: 600;
+  font-display: swap;
+  src: url("./worksans-semibold-webfont.woff2") format("woff2");
+}
+
+/* latin */
+@font-face {
+  font-family: 'Work Sans';
+  font-style: normal;
+  font-weight: bold;
+  /*700*/
+  font-display: swap;
+  src: url("./worksans-bold-webfont.woff2") format("woff2");
+}

README.md

@@ -20,30 +20,125 @@
     <a href="https://github.com/thomasdarimont/awesome-keycloak">
         <img src="https://awesome.re/mentioned-badge.svg"/>
     </a>
+    <a href="https://discord.gg/kYFZG7fQmn">
+        <img src="https://img.shields.io/discord/1097708346976505977"/>
+    </a>
     <p align="center">
         <a href="https://www.keycloakify.dev">Home</a>
         -
         <a href="https://docs.keycloakify.dev">Documentation</a>
         -
-        <a href="https://storybook.keycloakify.dev/storybook">Storybook</a>
+        <a href="https://storybook.keycloakify.dev">Storybook</a>
         -
         <a href="https://github.com/codegouvfr/keycloakify-starter">Starter project</a>
     </p>
 </p>
 
 <p align="center">
-    <i>Ultimately this build tool generates a Keycloak theme <a href="https://www.keycloakify.dev">Learn more</a></i>
+    <i>This build tool generates a Keycloak theme <a href="https://www.keycloakify.dev">Learn more</a></i>
     <img src="https://user-images.githubusercontent.com/6702424/110260457-a1c3d380-7fac-11eb-853a-80459b65626b.png">
 </p>
 
-The more ⭐️ the project gets, the more time I spend improving and maintaining it. Thank you for your support 😊
+> Whether or not React is your preferred framework, Keycloakify
+> offers a solid option for building Keycloak themes.
+> It's not just a convenient way to create a Keycloak theme
+> when using React; it's a well-regarded solution that many
+> developers appreciate.
 
-> 🗣 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).
+## Sponsor 👼
+
+We are exclusively sponsored by [Cloud IAM](https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github), a French company offering Keycloak as a service.  
+Their dedicated support helps us continue the development and maintenance of this project.
+
+[Cloud IAM](https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github) provides the following services:
+
+-   Simplify and secure your Keycloak Identity and Access Management. Keycloak as a Service.
+-   Custom theme building for your brand using Keycloakify.
+
+<div align="center">
+
+![Logo Dark](https://user-images.githubusercontent.com/6702424/234135797-c84d0a90-0526-43e5-a186-70cbebdeb278.png#gh-dark-mode-only)
+
+</div>
+
+<div align="center">
+
+![Logo Light](https://user-images.githubusercontent.com/6702424/234135799-68684c33-4ec5-48d4-8763-0f3922c86643.png#gh-light-mode-only)
+
+</div>
+
+<p align="center">
+    <i>Checkout <a href="https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github">Cloud IAM</a> and use promo code <code>keycloakify5</code></i>
+    <br/>
+    <i>5% of your annual subscription will be donated to us, and you'll get 5% off too.</i>
+</p>
+
+Thank you, [Cloud IAM](https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github), for your support!
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/lordvlad"><img src="https://avatars.githubusercontent.com/u/1217769?v=4?s=100" width="100px;" alt="Waldemar Reusch"/><br /><sub><b>Waldemar Reusch</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=lordvlad" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://willwill96.github.io/the-ui-dawg-static-site/en/introduction/"><img src="https://avatars.githubusercontent.com/u/10997562?v=4?s=100" width="100px;" alt="William Will"/><br /><sub><b>William Will</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=willwill96" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Ann2827"><img src="https://avatars.githubusercontent.com/u/32645809?v=4?s=100" width="100px;" alt="Bystrova Ann"/><br /><sub><b>Bystrova Ann</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=Ann2827" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/mkreuzmayr"><img src="https://avatars.githubusercontent.com/u/20108212?v=4?s=100" width="100px;" alt="Michael Kreuzmayr"/><br /><sub><b>Michael Kreuzmayr</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=mkreuzmayr" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://coolmathgames.tech"><img src="https://avatars.githubusercontent.com/u/6877780?v=4?s=100" width="100px;" alt="Mary "/><br /><sub><b>Mary </b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=Mstrodl" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://tasyp.xyz/"><img src="https://avatars.githubusercontent.com/u/6623212?v=4?s=100" width="100px;" alt="German Öö"/><br /><sub><b>German Öö</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=Tasyp" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://revolunet.com"><img src="https://avatars.githubusercontent.com/u/124937?v=4?s=100" width="100px;" alt="Julien Bouquillon"/><br /><sub><b>Julien Bouquillon</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=revolunet" title="Code">💻</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/aidangilmore"><img src="https://avatars.githubusercontent.com/u/32880357?v=4?s=100" width="100px;" alt="Aidan Gilmore"/><br /><sub><b>Aidan Gilmore</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=aidangilmore" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/0x-Void"><img src="https://avatars.githubusercontent.com/u/32745739?v=4?s=100" width="100px;" alt="Void"/><br /><sub><b>Void</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=0x-Void" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/juffe"><img src="https://avatars.githubusercontent.com/u/5393231?v=4?s=100" width="100px;" alt="juffe"/><br /><sub><b>juffe</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=juffe" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/lazToum"><img src="https://avatars.githubusercontent.com/u/4764837?v=4?s=100" width="100px;" alt="Lazaros Toumanidis"/><br /><sub><b>Lazaros Toumanidis</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=lazToum" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/marcmrf"><img src="https://avatars.githubusercontent.com/u/9928519?v=4?s=100" width="100px;" alt="Marc"/><br /><sub><b>Marc</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=marcmrf" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://kasir-barati.github.io"><img src="https://avatars.githubusercontent.com/u/73785723?v=4?s=100" width="100px;" alt="Kasir Barati"/><br /><sub><b>Kasir Barati</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=kasir-barati" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/asashay"><img src="https://avatars.githubusercontent.com/u/10714670?v=4?s=100" width="100px;" alt="Alex Oliynyk"/><br /><sub><b>Alex Oliynyk</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=asashay" title="Code">💻</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.gravitysoftware.be"><img src="https://avatars.githubusercontent.com/u/1140574?v=4?s=100" width="100px;" alt="Thomas Silvestre"/><br /><sub><b>Thomas Silvestre</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=thosil" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/satanshiro"><img src="https://avatars.githubusercontent.com/u/38865738?v=4?s=100" width="100px;" alt="satanshiro"/><br /><sub><b>satanshiro</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=satanshiro" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://poelhekke.dev"><img src="https://avatars.githubusercontent.com/u/1632377?v=4?s=100" width="100px;" alt="Koen Poelhekke"/><br /><sub><b>Koen Poelhekke</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=kpoelhekke" title="Code">💻</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
 
 # Changelog highlights
 
+## 7.13
+
+-   Deprecate `customUserAttribute`, Keycloakify now analyze your code to predict field name usage. [See doc](https://docs.keycloakify.dev/build-options#customuserattributes).
+
+## 7.12
+
+-   You can now pack multiple themes variant in a single `.jar` bundle. In vanilla Keycloak themes you have the ability to extend a base theme.
+    There is now an idiomatic way of achieving the same result. [Learn more](https://docs.keycloakify.dev/build-options#keycloakify.extrathemenames).
+
+## 7.9
+
+-   Separate script for copying the default theme static assets to the public directory.  
+    Theses assets are only needed for testing your theme locally in Storybook or with a `mockPageId`.  
+    You are now expected to have a `"prepare": "copy-keycloak-resources-to-public",` in your package.json scripts.  
+    This script will create `public/keycloak-assets` when you run `yarn install` (If you are using another package manager
+    like `pnpm` makes sure that `"prepare"` is actually ran.)  
+    [See the updated starter](https://github.com/keycloakify/keycloakify-starter/blob/94532fcf10bf8b19e0873be8575fd28a8958a806/package.json#L11). `public/keycloak-assets` shouldn't be tracked by GIT and is automatically ignored.
+
+## 7.7
+
+-   Better storybook support, see [the starter project](https://github.com/keycloakify/keycloakify-starter).
+
 ## 7.0 🍾
 
 -   Account theme support 🚀

keycloakify-json-schema.json

@@ -0,0 +1,91 @@
+{
+    "allOf": [
+        {
+            "$ref": "https://json.schemastore.org/package.json"
+        },
+        {
+            "$ref": "keycloakifyPackageJsonSchema"
+        }
+    ],
+    "$ref": "#/definitions/keycloakifyPackageJsonSchema",
+    "definitions": {
+        "keycloakifyPackageJsonSchema": {
+            "type": "object",
+            "properties": {
+                "name": {
+                    "type": "string"
+                },
+                "version": {
+                    "type": "string"
+                },
+                "homepage": {
+                    "type": "string"
+                },
+                "keycloakify": {
+                    "type": "object",
+                    "properties": {
+                        "extraPages": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "extraLoginPages": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "extraAccountPages": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "extraThemeProperties": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "areAppAndKeycloakServerSharingSameDomain": {
+                            "type": "boolean"
+                        },
+                        "artifactId": {
+                            "type": "string"
+                        },
+                        "groupId": {
+                            "type": "string"
+                        },
+                        "bundler": {
+                            "type": "string",
+                            "enum": ["mvn", "keycloakify", "none"]
+                        },
+                        "keycloakVersionDefaultAssets": {
+                            "type": "string"
+                        },
+                        "reactAppBuildDirPath": {
+                            "type": "string"
+                        },
+                        "keycloakifyBuildDirPath": {
+                            "type": "string"
+                        },
+                        "customUserAttributes": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "themeName": {
+                            "type": "string"
+                        }
+                    },
+                    "additionalProperties": false
+                }
+            },
+            "required": ["name", "version"],
+            "additionalProperties": false
+        }
+    },
+    "$schema": "http://json-schema.org/draft-07/schema#"
+}

package.json

@@ -1,6 +1,6 @@
 {
     "name": "keycloakify",
-    "version": "7.3.1",
+    "version": "7.13.2-rc.0",
     "description": "Create Keycloak themes using React",
     "repository": {
         "type": "git",
@@ -10,26 +10,30 @@
     "types": "dist/index.d.ts",
     "scripts": {
         "prepare": "yarn generate-i18n-messages",
-        "build": "rimraf dist/ && tsc -p src/bin && tsc -p src/tsconfig.json && tsc-alias -p src/tsconfig.json && yarn grant-exec-perms && yarn copy-files dist/",
-        "build:watch": "tsc -p src/tsconfig.json && (concurrently \"tsc -p src/tsconfig.json -w\" \"tsc-alias -p src/tsconfig.json\")",
-        "build:test": "rimraf dist_test/ && tsc -p test/tsconfig.json && tsc-alias -p test/tsconfig.json && yarn copy-files dist_test/src",
+        "build": "rimraf dist/ && tsc -p src/bin && tsc -p src && tsc-alias -p src/tsconfig.json && yarn grant-exec-perms && yarn copy-files dist/ && cp -r src dist/",
+        "generate:json-schema": "ts-node scripts/generate-json-schema.ts",
         "grant-exec-perms": "node dist/bin/tools/grant-exec-perms.js",
         "copy-files": "copyfiles -u 1 src/**/*.ftl",
-        "test": "yarn build:test && node dist_test/test/bin && node dist_test/test/lib",
-        "test:sample-app": "yarn build:test && node dist_test/test/bin/main.js",
+        "test": "yarn test:types && vitest run",
+        "test:keycloakify-starter": "ts-node scripts/test-keycloakify-starter",
+        "test:types": "tsc -p test/tsconfig.json --noEmit",
         "_format": "prettier '**/*.{ts,tsx,json,md}'",
         "format": "yarn _format --write",
         "format:check": "yarn _format --list-different",
         "generate-i18n-messages": "ts-node --skipProject scripts/generate-i18n-messages.ts",
         "link-in-app": "ts-node --skipProject scripts/link-in-app.ts",
         "link-in-starter": "yarn link-in-app keycloakify-starter",
-        "tsc-watch": "tsc -p src/bin -w & tsc -p src/lib -w "
+        "watch-in-starter": "yarn build && yarn link-in-starter && (concurrently \"tsc -p src -w\" \"tsc-alias -p src/tsconfig.json\" \"tsc -p src/bin -w\")",
+        "copy-keycloak-resources-to-storybook-static": "PUBLIC_DIR_PATH=.storybook/static node dist/bin/copy-keycloak-resources-to-public.js",
+        "storybook": "yarn build && yarn copy-keycloak-resources-to-storybook-static && start-storybook -p 6006",
+        "build-storybook": "yarn build && yarn copy-keycloak-resources-to-storybook-static && build-storybook"
     },
     "bin": {
-        "keycloakify": "dist/bin/keycloakify/index.js",
-        "initialize-email-theme": "dist/bin/initialize-email-theme.js",
+        "copy-keycloak-resources-to-public": "dist/bin/copy-keycloak-resources-to-public.js",
         "download-builtin-keycloak-theme": "dist/bin/download-builtin-keycloak-theme.js",
-        "eject-keycloak-page": "dist/bin/eject-keycloak-page.js"
+        "eject-keycloak-page": "dist/bin/eject-keycloak-page.js",
+        "initialize-email-theme": "dist/bin/initialize-email-theme.js",
+        "keycloakify": "dist/bin/keycloakify/index.js"
     },
     "lint-staged": {
         "*.{ts,tsx,json,md}": [
@@ -65,25 +69,45 @@
     },
     "devDependencies": {
         "@babel/core": "^7.0.0",
+        "@emotion/react": "^11.10.6",
+        "@storybook/addon-a11y": "^6.5.16",
+        "@storybook/addon-actions": "^6.5.13",
+        "@storybook/addon-essentials": "^6.5.13",
+        "@storybook/addon-interactions": "^6.5.13",
+        "@storybook/addon-links": "^6.5.13",
+        "@storybook/builder-webpack5": "^6.5.13",
+        "@storybook/manager-webpack5": "^6.5.13",
+        "@storybook/react": "^6.5.13",
+        "@storybook/testing-library": "^0.0.13",
         "@types/make-fetch-happen": "^10.0.1",
         "@types/minimist": "^1.2.2",
         "@types/node": "^18.15.3",
-        "@types/react": "18.0.9",
-        "concurrently": "^7.6.0",
+        "@types/react": "^18.0.35",
+        "@types/react-dom": "^18.0.11",
+        "@types/yauzl": "^2.10.0",
+        "concurrently": "^8.0.1",
         "copyfiles": "^2.4.1",
+        "eslint-plugin-storybook": "^0.6.7",
         "husky": "^4.3.8",
         "lint-staged": "^11.0.0",
+        "powerhooks": "^0.26.7",
         "prettier": "^2.3.0",
         "properties-parser": "^0.3.1",
-        "react": "18.1.0",
+        "react": "^18.2.0",
+        "react-dom": "^18.2.0",
         "rimraf": "^3.0.2",
         "scripting-tools": "^0.19.13",
+        "storybook-dark-mode": "^1.1.2",
         "ts-node": "^10.9.1",
         "tsc-alias": "^1.8.3",
-        "typescript": "^5.0.1-rc"
+        "tss-react": "^4.8.2",
+        "typescript": "^4.9.1-beta",
+        "vitest": "^0.29.8",
+        "zod-to-json-schema": "^3.20.4"
     },
     "dependencies": {
         "@octokit/rest": "^18.12.0",
+        "@types/yazl": "^2.4.2",
         "cheerio": "^1.0.0-rc.5",
         "cli-select": "^1.1.2",
         "evt": "^2.4.18",
@@ -94,6 +118,8 @@
         "react-markdown": "^5.0.3",
         "rfc4648": "^1.5.2",
         "tsafe": "^1.6.0",
+        "yauzl": "^2.10.0",
+        "yazl": "^2.5.1",
         "zod": "^3.17.10"
     }
 }

scripts/generate-i18n-messages.ts

@@ -1,10 +1,9 @@
 import "minimal-polyfills/Object.fromEntries";
 import * as fs from "fs";
-import { join as pathJoin, relative as pathRelative, dirname as pathDirname } from "path";
+import { join as pathJoin, relative as pathRelative, dirname as pathDirname, sep as pathSep } from "path";
 import { crawl } from "../src/bin/tools/crawl";
 import { downloadBuiltinKeycloakTheme } from "../src/bin/download-builtin-keycloak-theme";
 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,
@@ -13,7 +12,8 @@ import { getLogger } from "../src/bin/tools/logger";
 //@ts-ignore
 const propertiesParser = require("properties-parser");
 
-const { isSilent } = getCliOptions(process.argv.slice(2));
+const isSilent = true;
+
 const logger = getLogger({ isSilent });
 
 async function main() {
@@ -35,11 +35,10 @@ async function main() {
 
     {
         const baseThemeDirPath = pathJoin(tmpDirPath, "base");
+        const re = new RegExp(`^([^\\${pathSep}]+)\\${pathSep}messages\\${pathSep}messages_([^.]+).properties$`);
 
         crawl(baseThemeDirPath).forEach(filePath => {
-            const match =
-                filePath.match(/^([^/]+)\/messages\/messages_([^.]+)\.properties$/) ||
-                filePath.match(/^([^\\]+)\\messages\\messages_([^.]+)\.properties$/);
+            const match = filePath.match(re);
 
             if (match === null) {
                 return;
@@ -119,5 +118,5 @@ async function main() {
 }
 
 if (require.main === module) {
-    main().catch(e => console.error(e));
+    main();
 }

scripts/generate-json-schema.ts

@@ -0,0 +1,14 @@
+import fs from "fs";
+import path from "path";
+import zodToJsonSchema from "zod-to-json-schema";
+import { zParsedPackageJson } from "../src/bin/keycloakify/parsedPackageJson";
+
+const jsonSchemaName = "keycloakifyPackageJsonSchema";
+const jsonSchema = zodToJsonSchema(zParsedPackageJson, jsonSchemaName);
+
+const baseProperties = {
+    // merges package.json schema with keycloakify properties
+    "allOf": [{ "$ref": "https://json.schemastore.org/package.json" }, { "$ref": jsonSchemaName }]
+};
+
+fs.writeFileSync(path.join(process.cwd(), "keycloakify-json-schema.json"), JSON.stringify({ ...baseProperties, ...jsonSchema }, null, 2));

scripts/test-keycloakify-starter.ts

@@ -0,0 +1,29 @@
+import { execSync } from "child_process";
+import { existsSync, readFileSync, rmSync, writeFileSync } from "fs";
+import path from "path";
+
+const testDir = "keycloakify_starter_test";
+
+if (existsSync(path.join(process.cwd(), testDir))) {
+    rmSync(path.join(process.cwd(), testDir), { recursive: true });
+}
+// Build and link package
+execSync("yarn build");
+const pkgJSON = JSON.parse(readFileSync(path.join(process.cwd(), "package.json")).toString("utf8"));
+pkgJSON.main = "./index.js";
+pkgJSON.types = "./index.d.ts";
+pkgJSON.scripts.prepare = undefined;
+writeFileSync(path.join(process.cwd(), "dist", "package.json"), JSON.stringify(pkgJSON));
+// Wrapped in a try/catch because unlink errors if the package isn't linked
+try {
+    execSync("yarn unlink");
+} catch {}
+execSync("yarn link", { "cwd": path.join(process.cwd(), "dist") });
+
+// Clone latest keycloakify-starter and link to keycloakify output
+execSync(`git clone https://github.com/keycloakify/keycloakify-starter.git ${testDir}`);
+execSync("yarn install", { "cwd": path.join(process.cwd(), testDir) });
+execSync("yarn link keycloakify", { "cwd": path.join(process.cwd(), testDir) });
+
+//Ensure keycloak theme can be built
+execSync("yarn build-keycloak-theme", { "cwd": path.join(process.cwd(), testDir) });

src/account/Template.tsx

@@ -60,7 +60,7 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
                                         </div>
                                     </li>
                                 )}
-                                {referrer?.url !== undefined && (
+                                {referrer?.url && (
                                     <li>
                                         <a href={referrer.url} id="referrer">
                                             {msg("backTo", referrer.name)}

src/account/i18n/i18n.tsx

@@ -211,7 +211,9 @@ const keycloakifyExtraMessages = {
         "shouldBeDifferent": "{0} should be different to {1}",
         "shouldMatchPattern": "Pattern should match: `/{0}/`",
         "mustBeAnInteger": "Must be an integer",
-        "notAValidOption": "Not a valid option"
+        "notAValidOption": "Not a valid option",
+        "newPasswordSameAsOld": "New password must be different from the old one",
+        "passwordConfirmNotMatch": "Password confirmation does not match"
     },
     "fr": {
         /* spell-checker: disable */
@@ -223,7 +225,9 @@ const keycloakifyExtraMessages = {
 
         "logoutConfirmTitle": "Déconnexion",
         "logoutConfirmHeader": "Êtes-vous sûr(e) de vouloir vous déconnecter ?",
-        "doLogout": "Se déconnecter"
+        "doLogout": "Se déconnecter",
+        "newPasswordSameAsOld": "Le nouveau mot de passe doit être différent de l'ancien",
+        "passwordConfirmNotMatch": "La confirmation du mot de passe ne correspond pas"
         /* spell-checker: enable */
     }
 };

src/account/index.ts

@@ -3,6 +3,7 @@ import Fallback from "keycloakify/account/Fallback";
 export default Fallback;
 
 export { getKcContext } from "keycloakify/account/kcContext/getKcContext";
+export { createGetKcContext } from "keycloakify/account/kcContext/createGetKcContext";
 export { createUseI18n } from "keycloakify/account/i18n/i18n";
 
 export type { PageProps } from "keycloakify/account/pages/PageProps";

src/account/kcContext/KcContext.ts

@@ -1,4 +1,4 @@
-import type { AccountThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
+import type { AccountThemePageId, ThemeType } from "keycloakify/bin/keycloakify/generateFtl";
 import { assert } from "tsafe/assert";
 import type { Equals } from "tsafe";
 
@@ -6,6 +6,9 @@ export type KcContext = KcContext.Password | KcContext.Account;
 
 export declare namespace KcContext {
     export type Common = {
+        keycloakifyVersion: string;
+        themeType: "account";
+        themeName: string;
         locale?: {
             supported: {
                 url: string;
@@ -25,6 +28,8 @@ export declare namespace KcContext {
             resourceUrl: string;
             resourcesCommonPath: string;
             resourcesPath: string;
+            /** @deprecated, not present in recent keycloak version apparently, use kcContext.referrer instead */
+            referrerURI?: string;
             getLogoutUrl: () => string;
         };
         features: {
@@ -37,18 +42,44 @@ export declare namespace KcContext {
             internationalizationEnabled: boolean;
             userManagedAccessAllowed: boolean;
         };
+        // Present only if redirected to account page with ?referrer=xxx&referrer_uri=http...
         message?: {
             type: "success" | "warning" | "error" | "info";
             summary: string;
         };
         referrer?: {
-            url?: string;
-            name: string;
+            url: string; // The url of the App
+            name: string; // Client id
         };
         messagesPerField: {
-            printIfExists: <T>(fieldName: string, x: T) => T | undefined;
+            /**
+             * Return text if message for given field exists. Useful eg. to add css styles for fields with message.
+             *
+             * @param fieldName to check for
+             * @param text to return
+             * @return text if message exists for given field, else undefined
+             */
+            printIfExists: <T extends string>(fieldName: string, text: T) => T | undefined;
+            /**
+             * Check if exists error message for given fields
+             *
+             * @param fields
+             * @return boolean
+             */
             existsError: (fieldName: string) => boolean;
+            /**
+             * Get message for given field.
+             *
+             * @param fieldName
+             * @return message text or empty string
+             */
             get: (fieldName: string) => string;
+            /**
+             * Check if message for given field exists
+             *
+             * @param field
+             * @return boolean
+             */
             exists: (fieldName: string) => boolean;
         };
         account: {
@@ -70,7 +101,6 @@ export declare namespace KcContext {
     export type Account = Common & {
         pageId: "account.ftl";
         url: {
-            referrerURI: string;
             accountUrl: string;
         };
         realm: {
@@ -81,4 +111,15 @@ export declare namespace KcContext {
     };
 }
 
-assert<Equals<KcContext["pageId"], AccountThemePageId>>();
+{
+    type Got = KcContext["pageId"];
+    type Expected = AccountThemePageId;
+
+    type OnlyInGot = Exclude<Got, Expected>;
+    type OnlyInExpected = Exclude<Expected, Got>;
+
+    assert<Equals<OnlyInGot, never>>();
+    assert<Equals<OnlyInExpected, never>>();
+}
+
+assert<KcContext["themeType"] extends ThemeType ? true : false>();

src/account/kcContext/createGetKcContext.ts

@@ -0,0 +1,102 @@
+import type { DeepPartial } from "keycloakify/tools/DeepPartial";
+import { deepAssign } from "keycloakify/tools/deepAssign";
+import type { ExtendKcContext } from "./getKcContextFromWindow";
+import { getKcContextFromWindow } from "./getKcContextFromWindow";
+import { pathJoin } from "keycloakify/bin/tools/pathJoin";
+import { pathBasename } from "keycloakify/tools/pathBasename";
+import { resourcesCommonDirPathRelativeToPublicDir } from "keycloakify/bin/mockTestingResourcesPath";
+import { symToStr } from "tsafe/symToStr";
+import { kcContextMocks, kcContextCommonMock } from "keycloakify/account/kcContext/kcContextMocks";
+
+export function createGetKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
+    mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
+}) {
+    const { mockData } = params ?? {};
+
+    function getKcContext<PageId extends ExtendKcContext<KcContextExtension>["pageId"] | undefined = undefined>(params?: {
+        mockPageId?: PageId;
+        storyPartialKcContext?: DeepPartial<Extract<ExtendKcContext<KcContextExtension>, { pageId: PageId }>>;
+    }): {
+        kcContext: PageId extends undefined
+            ? ExtendKcContext<KcContextExtension> | undefined
+            : Extract<ExtendKcContext<KcContextExtension>, { pageId: PageId }>;
+    } {
+        const { mockPageId, storyPartialKcContext } = params ?? {};
+
+        const realKcContext = getKcContextFromWindow<KcContextExtension>();
+
+        if (mockPageId !== undefined && realKcContext === undefined) {
+            //TODO maybe trow if no mock fo custom page
+
+            console.log(`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`, "background: red; color: yellow; font-size: medium");
+
+            const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
+
+            const partialKcContextCustomMock = (() => {
+                const out: DeepPartial<ExtendKcContext<KcContextExtension>> = {};
+
+                const mockDataPick = mockData?.find(({ pageId }) => pageId === mockPageId);
+
+                if (mockDataPick !== undefined) {
+                    deepAssign({
+                        "target": out,
+                        "source": mockDataPick
+                    });
+                }
+
+                if (storyPartialKcContext !== undefined) {
+                    deepAssign({
+                        "target": out,
+                        "source": storyPartialKcContext
+                    });
+                }
+
+                return Object.keys(out).length === 0 ? undefined : out;
+            })();
+
+            if (kcContextDefaultMock === undefined && partialKcContextCustomMock === undefined) {
+                console.warn(
+                    [
+                        `WARNING: You declared the non build in page ${mockPageId} but you didn't `,
+                        `provide mock data needed to debug the page outside of Keycloak as you are trying to do now.`,
+                        `Please check the documentation of the getKcContext function`
+                    ].join("\n")
+                );
+            }
+
+            const kcContext: any = {};
+
+            deepAssign({
+                "target": kcContext,
+                "source": kcContextDefaultMock !== undefined ? kcContextDefaultMock : { "pageId": mockPageId, ...kcContextCommonMock }
+            });
+
+            if (partialKcContextCustomMock !== undefined) {
+                deepAssign({
+                    "target": kcContext,
+                    "source": partialKcContextCustomMock
+                });
+            }
+
+            return { kcContext };
+        }
+
+        if (realKcContext === undefined) {
+            return { "kcContext": undefined as any };
+        }
+
+        if (realKcContext.themeType !== "account") {
+            return { "kcContext": undefined as any };
+        }
+
+        {
+            const { url } = realKcContext;
+
+            url.resourcesCommonPath = pathJoin(url.resourcesPath, pathBasename(resourcesCommonDirPathRelativeToPublicDir));
+        }
+
+        return { "kcContext": realKcContext as any };
+    }
+
+    return { getKcContext };
+}

src/account/kcContext/getKcContext.ts

@@ -1,76 +1,21 @@
 import type { DeepPartial } from "keycloakify/tools/DeepPartial";
-import { deepAssign } from "keycloakify/tools/deepAssign";
 import type { ExtendKcContext } from "./getKcContextFromWindow";
-import { getKcContextFromWindow } from "./getKcContextFromWindow";
-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 { kcContextMocks, kcContextCommonMock } from "keycloakify/account/kcContext/kcContextMocks";
+import { createGetKcContext } from "./createGetKcContext";
 
+/** NOTE: We now recommend using createGetKcContext instead of this function to make storybook integration easier
+ *  See: https://github.com/keycloakify/keycloakify-starter/blob/main/src/keycloak-theme/account/kcContext.ts
+ */
 export function getKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
     mockPageId?: ExtendKcContext<KcContextExtension>["pageId"];
     mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
 }): { kcContext: ExtendKcContext<KcContextExtension> | undefined } {
     const { mockPageId, mockData } = params ?? {};
 
-    const realKcContext = getKcContextFromWindow<KcContextExtension>();
+    const { getKcContext } = createGetKcContext({
+        mockData
+    });
 
-    if (mockPageId !== undefined && realKcContext === undefined) {
-        //TODO maybe trow if no mock fo custom page
+    const { kcContext } = getKcContext({ mockPageId });
 
-        console.log(
-            [
-                `%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`,
-                `If assets are missing make sure you have built your Keycloak theme at least once.`
-            ].join(" "),
-            "background: red; color: yellow; font-size: medium"
-        );
-
-        const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
-
-        const partialKcContextCustomMock = mockData?.find(({ pageId }) => pageId === mockPageId);
-
-        if (kcContextDefaultMock === undefined && partialKcContextCustomMock === undefined) {
-            console.warn(
-                [
-                    `WARNING: You declared the non build in page ${mockPageId} but you didn't `,
-                    `provide mock data needed to debug the page outside of Keycloak as you are trying to do now.`,
-                    `Please check the documentation of the getKcContext function`
-                ].join("\n")
-            );
-        }
-
-        const kcContext: any = {};
-
-        deepAssign({
-            "target": kcContext,
-            "source": kcContextDefaultMock !== undefined ? kcContextDefaultMock : { "pageId": mockPageId, ...kcContextCommonMock }
-        });
-
-        if (partialKcContextCustomMock !== undefined) {
-            deepAssign({
-                "target": kcContext,
-                "source": partialKcContextCustomMock
-            });
-        }
-
-        return { kcContext };
-    }
-
-    if (realKcContext === undefined) {
-        return { "kcContext": undefined };
-    }
-
-    if (!("account" in realKcContext)) {
-        return { "kcContext": undefined };
-    }
-
-    {
-        const { url } = realKcContext;
-
-        url.resourcesCommonPath = pathJoin(url.resourcesPath, pathBasename(mockTestingResourcesCommonPath));
-    }
-
-    return { "kcContext": realKcContext };
+    return { kcContext };
 }

src/account/kcContext/kcContextMocks.ts

@@ -1,5 +1,5 @@
 import "minimal-polyfills/Object.fromEntries";
-import { mockTestingResourcesCommonPath, mockTestingResourcesPath } from "keycloakify/bin/mockTestingResourcesPath";
+import { resourcesCommonDirPathRelativeToPublicDir, resourcesDirPathRelativeToPublicDir } from "keycloakify/bin/mockTestingResourcesPath";
 import { pathJoin } from "keycloakify/bin/tools/pathJoin";
 import { id } from "tsafe/id";
 import type { KcContext } from "./KcContext";
@@ -7,9 +7,12 @@ import type { KcContext } from "./KcContext";
 const PUBLIC_URL = process.env["PUBLIC_URL"] ?? "/";
 
 export const kcContextCommonMock: KcContext.Common = {
+    "keycloakifyVersion": "0.0.0",
+    "themeType": "account",
+    "themeName": "my-theme-name",
     "url": {
-        "resourcesPath": pathJoin(PUBLIC_URL, mockTestingResourcesPath),
-        "resourcesCommonPath": pathJoin(PUBLIC_URL, mockTestingResourcesCommonPath),
+        "resourcesPath": pathJoin(PUBLIC_URL, resourcesDirPathRelativeToPublicDir),
+        "resourcesCommonPath": pathJoin(PUBLIC_URL, resourcesCommonDirPathRelativeToPublicDir),
         "resourceUrl": "#",
         "accountUrl": "#",
         "applicationsUrl": "#",

src/account/pages/Account.tsx

@@ -4,7 +4,7 @@ import { useGetClassName } from "keycloakify/account/lib/useGetClassName";
 import type { KcContext } from "../kcContext";
 import type { I18n } from "../i18n";
 
-export default function LogoutConfirm(props: PageProps<Extract<KcContext, { pageId: "account.ftl" }>, I18n>) {
+export default function Account(props: PageProps<Extract<KcContext, { pageId: "account.ftl" }>, I18n>) {
     const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
 
     const { getClassName } = useGetClassName({
@@ -15,7 +15,7 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
         }
     });
 
-    const { url, realm, messagesPerField, stateChecker, account } = kcContext;
+    const { url, realm, messagesPerField, stateChecker, account, referrer } = kcContext;
 
     const { msg } = i18n;
 
@@ -99,7 +99,7 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
                 <div className="form-group">
                     <div id="kc-form-buttons" className="col-md-offset-2 col-md-10 submit">
                         <div>
-                            {url.referrerURI !== undefined && <a href={url.referrerURI}>${msg("backToApplication")}</a>}
+                            {referrer !== undefined && <a href={referrer?.url}>{msg("backToApplication")}</a>}
                             <button
                                 type="submit"
                                 className={clsx(
@@ -124,7 +124,6 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
                             >
                                 {msg("doCancel")}
                             </button>
-                            I
                         </div>
                     </div>
                 </div>

src/account/pages/Password.tsx

@@ -1,10 +1,11 @@
+import { useState } from "react";
 import { clsx } from "keycloakify/tools/clsx";
 import type { PageProps } from "keycloakify/account/pages/PageProps";
 import { useGetClassName } from "keycloakify/account/lib/useGetClassName";
 import type { KcContext } from "../kcContext";
 import type { I18n } from "../i18n";
 
-export default function LogoutConfirm(props: PageProps<Extract<KcContext, { pageId: "password.ftl" }>, I18n>) {
+export default function Password(props: PageProps<Extract<KcContext, { pageId: "password.ftl" }>, I18n>) {
     const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
 
     const { getClassName } = useGetClassName({
@@ -17,16 +18,75 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
 
     const { url, password, account, stateChecker } = kcContext;
 
-    const { msg } = i18n;
+    const { msgStr, msg } = i18n;
+
+    const [currentPassword, setCurrentPassword] = useState("");
+    const [newPassword, setNewPassword] = useState("");
+    const [newPasswordConfirm, setNewPasswordConfirm] = useState("");
+    const [newPasswordError, setNewPasswordError] = useState("");
+    const [newPasswordConfirmError, setNewPasswordConfirmError] = useState("");
+    const [hasNewPasswordBlurred, setHasNewPasswordBlurred] = useState(false);
+    const [hasNewPasswordConfirmBlurred, setHasNewPasswordConfirmBlurred] = useState(false);
+
+    const checkNewPassword = (newPassword: string) => {
+        if (!password.passwordSet) {
+            return;
+        }
+
+        if (newPassword === currentPassword) {
+            setNewPasswordError(msgStr("newPasswordSameAsOld"));
+        } else {
+            setNewPasswordError("");
+        }
+    };
+
+    const checkNewPasswordConfirm = (newPasswordConfirm: string) => {
+        if (newPasswordConfirm === "") {
+            return;
+        }
+
+        if (newPassword !== newPasswordConfirm) {
+            setNewPasswordConfirmError(msgStr("passwordConfirmNotMatch"));
+        } else {
+            setNewPasswordConfirmError("");
+        }
+    };
 
     return (
-        <Template {...{ kcContext, i18n, doUseDefaultCss, classes }} active="password">
+        <Template
+            {...{
+                kcContext: {
+                    ...kcContext,
+                    "message": (() => {
+                        if (newPasswordError !== "") {
+                            return {
+                                "type": "error",
+                                "summary": newPasswordError
+                            };
+                        }
+
+                        if (newPasswordConfirmError !== "") {
+                            return {
+                                "type": "error",
+                                "summary": newPasswordConfirmError
+                            };
+                        }
+
+                        return kcContext.message;
+                    })()
+                },
+                i18n,
+                doUseDefaultCss,
+                classes
+            }}
+            active="password"
+        >
             <div className="row">
                 <div className="col-md-10">
                     <h2>{msg("changePasswordHtmlTitle")}</h2>
                 </div>
                 <div className="col-md-2 subtitle">
-                    <span className="subtitle">${msg("allFieldsRequired")}</span>
+                    <span className="subtitle">{msg("allFieldsRequired")}</span>
                 </div>
             </div>
 
@@ -38,7 +98,7 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
                     value={account.username ?? ""}
                     autoComplete="username"
                     readOnly
-                    style={{ "display": "none;" }}
+                    style={{ "display": "none" }}
                 />
 
                 {password.passwordSet && (
@@ -48,9 +108,17 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
                                 {msg("password")}
                             </label>
                         </div>
-
                         <div className="col-sm-10 col-md-10">
-                            <input type="password" className="form-control" id="password" name="password" autoFocus autoComplete="current-password" />
+                            <input
+                                type="password"
+                                className="form-control"
+                                id="password"
+                                name="password"
+                                autoFocus
+                                autoComplete="current-password"
+                                value={currentPassword}
+                                onChange={event => setCurrentPassword(event.target.value)}
+                            />
                         </div>
                     </div>
                 )}
@@ -63,9 +131,27 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
                             {msg("passwordNew")}
                         </label>
                     </div>
-
                     <div className="col-sm-10 col-md-10">
-                        <input type="password" className="form-control" id="password-new" name="password-new" autoComplete="new-password" />
+                        <input
+                            type="password"
+                            className="form-control"
+                            id="password-new"
+                            name="password-new"
+                            autoComplete="new-password"
+                            value={newPassword}
+                            onChange={event => {
+                                const newPassword = event.target.value;
+
+                                setNewPassword(newPassword);
+                                if (hasNewPasswordBlurred) {
+                                    checkNewPassword(newPassword);
+                                }
+                            }}
+                            onBlur={() => {
+                                setHasNewPasswordBlurred(true);
+                                checkNewPassword(newPassword);
+                            }}
+                        />
                     </div>
                 </div>
 
@@ -77,7 +163,26 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
                     </div>
 
                     <div className="col-sm-10 col-md-10">
-                        <input type="password" className="form-control" id="password-confirm" name="password-confirm" autoComplete="new-password" />
+                        <input
+                            type="password"
+                            className="form-control"
+                            id="password-confirm"
+                            name="password-confirm"
+                            autoComplete="new-password"
+                            value={newPasswordConfirm}
+                            onChange={event => {
+                                const newPasswordConfirm = event.target.value;
+
+                                setNewPasswordConfirm(newPasswordConfirm);
+                                if (hasNewPasswordConfirmBlurred) {
+                                    checkNewPasswordConfirm(newPasswordConfirm);
+                                }
+                            }}
+                            onBlur={() => {
+                                setHasNewPasswordConfirmBlurred(true);
+                                checkNewPasswordConfirm(newPasswordConfirm);
+                            }}
+                        />
                     </div>
                 </div>
 
@@ -85,6 +190,7 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
                     <div id="kc-form-buttons" className="col-md-offset-2 col-md-10 submit">
                         <div>
                             <button
+                                disabled={newPasswordError !== "" || newPasswordConfirmError !== ""}
                                 type="submit"
                                 className={clsx(
                                     getClassName("kcButtonClass"),

src/bin/copy-keycloak-resources-to-public.ts

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+
+import { downloadKeycloakStaticResources } from "./keycloakify/generateTheme/downloadKeycloakStaticResources";
+import { join as pathJoin, relative as pathRelative } from "path";
+import { basenameOfKeycloakDirInPublicDir } from "./mockTestingResourcesPath";
+import { readBuildOptions } from "./keycloakify/BuildOptions";
+import { themeTypes } from "./keycloakify/generateFtl";
+import * as fs from "fs";
+
+(async () => {
+    const projectDirPath = process.cwd();
+
+    const buildOptions = readBuildOptions({
+        "processArgv": process.argv.slice(2),
+        "projectDirPath": process.cwd()
+    });
+
+    const keycloakDirInPublicDir = pathJoin(process.env["PUBLIC_DIR_PATH"] || pathJoin(projectDirPath, "public"), basenameOfKeycloakDirInPublicDir);
+
+    if (fs.existsSync(keycloakDirInPublicDir)) {
+        console.log(`${pathRelative(projectDirPath, keycloakDirInPublicDir)} already exists.`);
+        return;
+    }
+
+    for (const themeType of themeTypes) {
+        await downloadKeycloakStaticResources({
+            "isSilent": false,
+            "keycloakVersion": buildOptions.keycloakVersionDefaultAssets,
+            "themeType": themeType,
+            "themeDirPath": keycloakDirInPublicDir
+        });
+    }
+
+    fs.writeFileSync(
+        pathJoin(keycloakDirInPublicDir, "README.txt"),
+        Buffer.from(
+            // prettier-ignore
+            [
+                "This is just a test folder that helps develop",
+                "the login and register page without having to run a Keycloak container"
+            ].join(" ")
+        )
+    );
+
+    fs.writeFileSync(pathJoin(keycloakDirInPublicDir, ".gitignore"), Buffer.from("*", "utf8"));
+
+    console.log(`${pathRelative(projectDirPath, keycloakDirInPublicDir)} directory created.`);
+})();

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

@@ -1,11 +1,9 @@
 #!/usr/bin/env node
-
-import { keycloakThemeBuildingDirPath } from "./keycloakify";
 import { join as pathJoin } from "path";
 import { downloadAndUnzip } from "./tools/downloadAndUnzip";
 import { promptKeycloakVersion } from "./promptKeycloakVersion";
-import { getCliOptions } from "./tools/cliOptions";
 import { getLogger } from "./tools/logger";
+import { readBuildOptions } from "./keycloakify/BuildOptions";
 
 export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: string; destDirPath: string; isSilent: boolean }) {
     const { keycloakVersion, destDirPath } = params;
@@ -22,21 +20,25 @@ export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: st
 }
 
 async function main() {
-    const { isSilent } = getCliOptions(process.argv.slice(2));
-    const logger = getLogger({ isSilent });
+    const buildOptions = readBuildOptions({
+        "projectDirPath": process.cwd(),
+        "processArgv": process.argv.slice(2)
+    });
+
+    const logger = getLogger({ "isSilent": buildOptions.isSilent });
     const { keycloakVersion } = await promptKeycloakVersion();
 
-    const destDirPath = pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme");
+    const destDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources", "theme");
 
     logger.log(`Downloading builtins theme of Keycloak ${keycloakVersion} here ${destDirPath}`);
 
     await downloadBuiltinKeycloakTheme({
         keycloakVersion,
         destDirPath,
-        isSilent
+        "isSilent": buildOptions.isSilent
     });
 }
 
 if (require.main === module) {
-    main().catch(e => console.error(e));
+    main();
 }

src/bin/eject-keycloak-page.ts

@@ -9,18 +9,16 @@ import {
     type AccountThemePageId,
     themeTypes,
     type ThemeType
-} from "./keycloakify/generateFtl/generateFtl";
+} from "./keycloakify/generateFtl";
 import { capitalize } from "tsafe/capitalize";
 import { readFile, writeFile } from "fs/promises";
 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";
+import { getThemeSrcDirPath } from "./getSrcDirPath";
 
 (async () => {
-    const projectRootDir = getProjectRoot();
-
     console.log("Select a theme type");
 
     const { value: themeType } = await cliSelect<ThemeType>({
@@ -51,7 +49,7 @@ import { getThemeSrcDirPath } from "./getThemeSrcDirPath";
 
     const pageBasename = capitalize(kebabCaseToCamelCase(pageId)).replace(/ftl$/, "tsx");
 
-    const { themeSrcDirPath } = getThemeSrcDirPath();
+    const { themeSrcDirPath } = getThemeSrcDirPath({ "projectDirPath": process.cwd() });
 
     if (themeSrcDirPath === undefined) {
         throw new Error("Couldn't locate your theme sources");
@@ -65,7 +63,7 @@ import { getThemeSrcDirPath } from "./getThemeSrcDirPath";
         process.exit(-1);
     }
 
-    writeFile(targetFilePath, await readFile(pathJoin(projectRootDir, "src", themeType, "pages", pageBasename)));
+    await writeFile(targetFilePath, await readFile(pathJoin(getProjectRoot(), "src", themeType, "pages", pageBasename)));
 
     console.log(`${pathRelative(process.cwd(), targetFilePath)} created`);
 })();

src/bin/getSrcDirPath.ts

@@ -1,14 +1,14 @@
-import { join as pathJoin } from "path";
 import * as fs from "fs";
+import { exclude } from "tsafe";
 import { crawl } from "./tools/crawl";
-import { exclude } from "tsafe/exclude";
-
-const reactProjectDirPath = process.cwd();
+import { join as pathJoin } from "path";
 
 const themeSrcDirBasename = "keycloak-theme";
 
-export function getThemeSrcDirPath() {
-    const srcDirPath = pathJoin(reactProjectDirPath, "src");
+export function getThemeSrcDirPath(params: { projectDirPath: string }) {
+    const { projectDirPath } = params;
+
+    const srcDirPath = pathJoin(projectDirPath, "src");
 
     const themeSrcDirPath: string | undefined = crawl(srcDirPath)
         .map(fileRelativePath => {

src/bin/initialize-email-theme.ts

@@ -4,31 +4,31 @@ import { downloadBuiltinKeycloakTheme } from "./download-builtin-keycloak-theme"
 import { join as pathJoin, relative as pathRelative } from "path";
 import { transformCodebase } from "./tools/transformCodebase";
 import { promptKeycloakVersion } from "./promptKeycloakVersion";
+import { readBuildOptions } from "./keycloakify/BuildOptions";
 import * as fs from "fs";
-import { getCliOptions } from "./tools/cliOptions";
 import { getLogger } from "./tools/logger";
-import { getThemeSrcDirPath } from "./getThemeSrcDirPath";
+import { getThemeSrcDirPath } from "./getSrcDirPath";
 
-export function getEmailThemeSrcDirPath() {
-    const { themeSrcDirPath } = getThemeSrcDirPath();
+export async function main() {
+    const { isSilent } = readBuildOptions({
+        "projectDirPath": process.cwd(),
+        "processArgv": process.argv.slice(2)
+    });
 
-    const emailThemeSrcDirPath = themeSrcDirPath === undefined ? undefined : pathJoin(themeSrcDirPath, "email");
-
-    return { emailThemeSrcDirPath };
-}
-
-async function main() {
-    const { isSilent } = getCliOptions(process.argv.slice(2));
     const logger = getLogger({ isSilent });
 
-    const { emailThemeSrcDirPath } = getEmailThemeSrcDirPath();
+    const { themeSrcDirPath } = getThemeSrcDirPath({
+        "projectDirPath": process.cwd()
+    });
 
-    if (emailThemeSrcDirPath === undefined) {
+    if (themeSrcDirPath === undefined) {
         logger.warn("Couldn't locate your theme source directory");
 
         process.exit(-1);
     }
 
+    const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
+
     if (fs.existsSync(emailThemeSrcDirPath)) {
         logger.warn(`There is already a ${pathRelative(process.cwd(), emailThemeSrcDirPath)} directory in your project. Aborting.`);
 

src/bin/keycloakify/BuildOptions.ts

@@ -1,51 +1,12 @@
-import { z } from "zod";
 import { assert } from "tsafe/assert";
-import type { Equals } from "tsafe";
 import { id } from "tsafe/id";
 import { parse as urlParse } from "url";
 import { typeGuard } from "tsafe/typeGuard";
 import { symToStr } from "tsafe/symToStr";
-
-const bundlers = ["mvn", "keycloakify", "none"] as const;
-type Bundler = (typeof bundlers)[number];
-type ParsedPackageJson = {
-    name: string;
-    version: string;
-    homepage?: string;
-    keycloakify?: {
-        /** @deprecated: use extraLoginPages instead */
-        extraPages?: string[];
-        extraLoginPages?: string[];
-        extraAccountPages?: string[];
-        extraThemeProperties?: string[];
-        areAppAndKeycloakServerSharingSameDomain?: boolean;
-        artifactId?: string;
-        groupId?: string;
-        bundler?: Bundler;
-        keycloakVersionDefaultAssets?: string;
-    };
-};
-
-const zParsedPackageJson = z.object({
-    "name": z.string(),
-    "version": z.string(),
-    "homepage": z.string().optional(),
-    "keycloakify": z
-        .object({
-            "extraPages": z.array(z.string()).optional(),
-            "extraLoginPages": z.array(z.string()).optional(),
-            "extraAccountPages": z.array(z.string()).optional(),
-            "extraThemeProperties": z.array(z.string()).optional(),
-            "areAppAndKeycloakServerSharingSameDomain": z.boolean().optional(),
-            "artifactId": z.string().optional(),
-            "groupId": z.string().optional(),
-            "bundler": z.enum(bundlers).optional(),
-            "keycloakVersionDefaultAssets": z.string().optional()
-        })
-        .optional()
-});
-
-assert<Equals<ReturnType<(typeof zParsedPackageJson)["parse"]>, ParsedPackageJson>>();
+import { bundlers, getParsedPackageJson, type Bundler } from "./parsedPackageJson";
+import * as fs from "fs";
+import { join as pathJoin, sep as pathSep } from "path";
+import parseArgv from "minimist";
 
 /** Consolidated build option gathered form CLI arguments and config in package.json */
 export type BuildOptions = BuildOptions.Standalone | BuildOptions.ExternalAssets;
@@ -53,8 +14,9 @@ export type BuildOptions = BuildOptions.Standalone | BuildOptions.ExternalAssets
 export namespace BuildOptions {
     export type Common = {
         isSilent: boolean;
-        version: string;
+        themeVersion: string;
         themeName: string;
+        extraThemeNames: string[];
         extraLoginPages: string[] | undefined;
         extraAccountPages: string[] | undefined;
         extraThemeProperties?: string[];
@@ -62,6 +24,10 @@ export namespace BuildOptions {
         artifactId: string;
         bundler: Bundler;
         keycloakVersionDefaultAssets: string;
+        /** Directory of your built react project. Defaults to {cwd}/build */
+        reactAppBuildDirPath: string;
+        /** Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak */
+        keycloakifyBuildDirPath: string;
     };
 
     export type Standalone = Common & {
@@ -88,15 +54,19 @@ export namespace BuildOptions {
     }
 }
 
-export function readBuildOptions(params: {
-    packageJson: string;
-    CNAME: string | undefined;
-    isExternalAssetsCliParamProvided: boolean;
-    isSilent: boolean;
-}): BuildOptions {
-    const { packageJson, CNAME, isExternalAssetsCliParamProvided, isSilent } = params;
+export function readBuildOptions(params: { projectDirPath: string; processArgv: string[] }): BuildOptions {
+    const { projectDirPath, processArgv } = params;
 
-    const parsedPackageJson = zParsedPackageJson.parse(JSON.parse(packageJson));
+    const { isExternalAssetsCliParamProvided, isSilentCliParamProvided } = (() => {
+        const argv = parseArgv(processArgv);
+
+        return {
+            "isSilentCliParamProvided": typeof argv["silent"] === "boolean" ? argv["silent"] : false,
+            "isExternalAssetsCliParamProvided": typeof argv["external-assets"] === "boolean" ? argv["external-assets"] : false
+        };
+    })();
+
+    const parsedPackageJson = getParsedPackageJson({ projectDirPath });
 
     const url = (() => {
         const { homepage } = parsedPackageJson;
@@ -107,6 +77,16 @@ export function readBuildOptions(params: {
             url = new URL(homepage);
         }
 
+        const CNAME = (() => {
+            const cnameFilePath = pathJoin(projectDirPath, "public", "CNAME");
+
+            if (!fs.existsSync(cnameFilePath)) {
+                return undefined;
+            }
+
+            return fs.readFileSync(cnameFilePath).toString("utf8");
+        })();
+
         if (CNAME !== undefined) {
             url = new URL(`https://${CNAME.replace(/\s+$/, "")}`);
         }
@@ -128,16 +108,28 @@ export function readBuildOptions(params: {
     const common: BuildOptions.Common = (() => {
         const { name, keycloakify = {}, version, homepage } = parsedPackageJson;
 
-        const { extraPages, extraLoginPages, extraAccountPages, extraThemeProperties, groupId, artifactId, bundler, keycloakVersionDefaultAssets } =
-            keycloakify ?? {};
+        const {
+            extraPages,
+            extraLoginPages,
+            extraAccountPages,
+            extraThemeProperties,
+            groupId,
+            artifactId,
+            bundler,
+            keycloakVersionDefaultAssets,
+            extraThemeNames = []
+        } = keycloakify ?? {};
 
-        const themeName = name
-            .replace(/^@(.*)/, "$1")
-            .split("/")
-            .join("-");
+        const themeName =
+            keycloakify.themeName ??
+            name
+                .replace(/^@(.*)/, "$1")
+                .split("/")
+                .join("-");
 
         return {
             themeName,
+            extraThemeNames,
             "bundler": (() => {
                 const { KEYCLOAKIFY_BUNDLER } = process.env;
 
@@ -167,12 +159,46 @@ export function readBuildOptions(params: {
                               .join(".") ?? fallbackGroupId) + ".keycloak"
                 );
             })(),
-            "version": process.env.KEYCLOAKIFY_VERSION ?? version,
+            "themeVersion": process.env.KEYCLOAKIFY_THEME_VERSION ?? process.env.KEYCLOAKIFY_VERSION ?? version ?? "0.0.0",
             "extraLoginPages": [...(extraPages ?? []), ...(extraLoginPages ?? [])],
             extraAccountPages,
             extraThemeProperties,
-            isSilent,
-            "keycloakVersionDefaultAssets": keycloakVersionDefaultAssets ?? "11.0.3"
+            "isSilent": isSilentCliParamProvided,
+            "keycloakVersionDefaultAssets": keycloakVersionDefaultAssets ?? "11.0.3",
+            "reactAppBuildDirPath": (() => {
+                let { reactAppBuildDirPath = undefined } = parsedPackageJson.keycloakify ?? {};
+
+                if (reactAppBuildDirPath === undefined) {
+                    return pathJoin(projectDirPath, "build");
+                }
+
+                if (pathSep === "\\") {
+                    reactAppBuildDirPath = reactAppBuildDirPath.replace(/\//g, pathSep);
+                }
+
+                if (reactAppBuildDirPath.startsWith(`.${pathSep}`)) {
+                    return pathJoin(projectDirPath, reactAppBuildDirPath);
+                }
+
+                return reactAppBuildDirPath;
+            })(),
+            "keycloakifyBuildDirPath": (() => {
+                let { keycloakifyBuildDirPath = undefined } = parsedPackageJson.keycloakify ?? {};
+
+                if (keycloakifyBuildDirPath === undefined) {
+                    return pathJoin(projectDirPath, "build_keycloak");
+                }
+
+                if (pathSep === "\\") {
+                    keycloakifyBuildDirPath = keycloakifyBuildDirPath.replace(/\//g, pathSep);
+                }
+
+                if (keycloakifyBuildDirPath.startsWith(`.${pathSep}`)) {
+                    return pathJoin(projectDirPath, keycloakifyBuildDirPath);
+                }
+
+                return keycloakifyBuildDirPath;
+            })()
         };
     })();
 

src/bin/keycloakify/generateFtl/ftl_object_to_js_code_declaring_an_object.ftl

@@ -8,14 +8,7 @@
     out["advancedMsg"]= function(){ throw new Error("use import { useKcMessage } from 'keycloakify'"); };
 
     out["messagesPerField"]= {
-        <#assign fieldNames = [
-            "global", "userLabel", "username", "email", "firstName", "lastName", "password", "password-confirm",
-            "totp", "totpSecret", "SAMLRequest", "SAMLResponse", "relayState", "device_user_code", "code", 
-            "password-new", "rememberMe", "login", "authenticationExecution", "cancel-aia", "clientDataJSON", 
-            "authenticatorData", "signature", "credentialId", "userHandle", "error", "authn_use_chk", "authenticationExecution", 
-            "isSetRetry", "try-again", "attestationObject", "publicKeyCredentialId", "authenticatorLabel",
-            "location", "occupation"
-        ]>
+        <#assign fieldNames = [ FIELD_NAMES_eKsIY4ZsZ4xeM ]>
     
         <#attempt>
             <#if profile?? && profile.attributes?? && profile.attributes?is_enumerable>
@@ -29,85 +22,375 @@
         <#recover>
         </#attempt>
     
-        "printIfExists": function (fieldName, x) {
-            <#if !messagesPerField?? >
-                return undefined;
-            <#else>
-                <#list fieldNames as fieldName>
-                    if(fieldName === "${fieldName}" ){
-                        <#attempt>
-                            <#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
-                                return <#if messagesPerField.existsError('username', 'password')>x<#else>undefined</#if>;
-                            <#else>
-                                return <#if messagesPerField.existsError('${fieldName}')>x<#else>undefined</#if>;
-                            </#if>
-                        <#recover>
-                        </#attempt>
-                    }
-                </#list>
-                throw new Error("There is no " + fieldName + " field");
+        "printIfExists": function (fieldName, text) {
+
+            <#if !messagesPerField?? || !(messagesPerField?is_hash)>   
+                throw new Error("You're not supposed to use messagesPerField.printIfExists in this page");
             </#if>
+
+            <#list fieldNames as fieldName>
+                if(fieldName === "${fieldName}" ){
+
+                    <#-- https://github.com/keycloakify/keycloakify/pull/359 Compat with Keycloak prior v12 -->
+                    <#if !messagesPerField.existsError??>
+
+                        /* Consider updating to Keycloak v12 or newer */
+
+                        <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
+                        <#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
+
+                            <#assign doExistMessageForUsernameOrPassword = "">
+
+                            <#attempt>
+                                <#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('username')>
+                            <#recover>
+                                /* There was an FTL error calling messagesPerField.exists('username') */
+                                <#assign doExistMessageForUsernameOrPassword = true>
+                            </#attempt>
+
+                            <#if !doExistMessageForUsernameOrPassword>
+                                <#attempt>
+                                    <#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('password')>
+                                <#recover>
+                                    /* There was an FTL error calling messagesPerField.exists('password') */
+                                    <#assign doExistMessageForUsernameOrPassword = true>
+                                </#attempt>
+                            </#if>
+
+                            return <#if doExistMessageForUsernameOrPassword>text<#else>undefined</#if>;
+
+                        <#else>
+
+                            <#assign doExistMessageForField = "">
+
+                            <#attempt>
+                                <#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
+                            <#recover>
+                                <#assign doExistMessageForField = true>
+                            </#attempt>
+
+                            return <#if doExistMessageForField>text<#else>undefined</#if>;
+
+                        </#if>
+
+                    <#else>
+
+                        <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
+                        <#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
+
+                            <#assign doExistErrorOnUsernameOrPassword = "">
+
+                            <#attempt>
+                                <#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
+                            <#recover>
+                                <#assign doExistErrorOnUsernameOrPassword = true>
+                            </#attempt>
+
+                            <#if doExistErrorOnUsernameOrPassword>
+                                return text;
+                            <#else>
+
+                                <#assign doExistMessageForField = "">
+
+                                <#attempt>
+                                    <#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
+                                <#recover>
+                                    <#assign doExistMessageForField = true>
+                                </#attempt>
+
+                                return <#if doExistMessageForField>text<#else>undefined</#if>;
+
+                            </#if>
+
+                        <#else>
+
+                            <#assign doExistMessageForField = "">
+
+                            <#attempt>
+                                <#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
+                            <#recover>
+                                <#assign doExistMessageForField = true>
+                            </#attempt>
+
+                            return <#if doExistMessageForField>text<#else>undefined</#if>;
+
+                        </#if>
+
+                    </#if>
+
+                }
+            </#list>
+
+            throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
         },
         "existsError": function (fieldName) {
-            <#if !messagesPerField?? >
-                return false;
-            <#else>
-                <#list fieldNames as fieldName>
-                    if(fieldName === "${fieldName}" ){
-                        <#attempt>
-                            <#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
-                                return <#if messagesPerField.existsError('username', 'password')>true<#else>false</#if>;
-                            <#else>
-                                return <#if messagesPerField.existsError('${fieldName}')>true<#else>false</#if>;
-                            </#if>
-                        <#recover>
-                        </#attempt>
-                    }
-                </#list>
-                throw new Error("There is no " + fieldName + " field");
+
+            <#if !messagesPerField?? || !(messagesPerField?is_hash)>   
+                throw new Error("You're not supposed to use messagesPerField.printIfExists in this page");
             </#if>
+
+            <#list fieldNames as fieldName>
+                if(fieldName === "${fieldName}" ){
+
+                    <#-- https://github.com/keycloakify/keycloakify/pull/359 Compat with Keycloak prior v12 -->
+                    <#if !messagesPerField.existsError??>
+
+                        <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
+                        <#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
+
+                            <#assign doExistMessageForUsernameOrPassword = "">
+
+                            <#attempt>
+                                <#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('username')>
+                            <#recover>
+                                <#assign doExistMessageForUsernameOrPassword = true>
+                            </#attempt>
+
+                            <#if !doExistMessageForUsernameOrPassword>
+                                <#attempt>
+                                    <#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('password')>
+                                <#recover>
+                                    <#assign doExistMessageForUsernameOrPassword = true>
+                                </#attempt>
+                            </#if>
+
+                            return <#if doExistMessageForUsernameOrPassword>true<#else>false</#if>;
+
+                        <#else>
+
+                            <#assign doExistMessageForField = "">
+
+                            <#attempt>
+                                <#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
+                            <#recover>
+                                <#assign doExistMessageForField = true>
+                            </#attempt>
+
+                            return <#if doExistMessageForField>true<#else>false</#if>;
+
+                        </#if>
+
+                    <#else>
+
+                        <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
+                        <#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
+
+                            <#assign doExistErrorOnUsernameOrPassword = "">
+
+                            <#attempt>
+                                <#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
+                            <#recover>
+                                <#assign doExistErrorOnUsernameOrPassword = true>
+                            </#attempt>
+
+                            return <#if doExistErrorOnUsernameOrPassword>true<#else>false</#if>;
+
+                        <#else>
+
+                            <#assign doExistErrorMessageForField = "">
+
+                            <#attempt>
+                                <#assign doExistErrorMessageForField = messagesPerField.existsError('${fieldName}')>
+                            <#recover>
+                                <#assign doExistErrorMessageForField = true>
+                            </#attempt>
+
+                            return <#if doExistErrorMessageForField>true<#else>false</#if>;
+
+                        </#if>
+
+                    </#if>
+
+                }
+            </#list>
+
+            throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
+
         },
         "get": function (fieldName) {
-            <#if !messagesPerField?? >
-                return '';
-            <#else>
-                <#list fieldNames as fieldName>
-                    if(fieldName === "${fieldName}" ){
-                        <#attempt>
-                            <#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
-                                <#if messagesPerField.existsError('username', 'password')>
-                                    return 'Invalid username or password.';
-                                </#if>
-                            <#else>
-                                <#if messagesPerField.existsError('${fieldName}')>
-                                    return "${messagesPerField.get('${fieldName}')?no_esc}";
-                                </#if>
-                            </#if>
-                        <#recover>
-                        </#attempt>
-                    }
-                </#list>
-                throw new Error("There is no " + fieldName + " field");
+
+
+            <#if !messagesPerField?? || !(messagesPerField?is_hash)>   
+                throw new Error("You're not supposed to use messagesPerField.get in this page");
             </#if>
+
+            <#list fieldNames as fieldName>
+                if(fieldName === "${fieldName}" ){
+
+                    <#-- https://github.com/keycloakify/keycloakify/pull/359 Compat with Keycloak prior v12 -->
+                    <#if !messagesPerField.existsError??>
+
+                        <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
+                        <#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
+
+                            <#assign doExistMessageForUsernameOrPassword = "">
+
+                            <#attempt>
+                                <#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('username')>
+                            <#recover>
+                                <#assign doExistMessageForUsernameOrPassword = true>
+                            </#attempt>
+
+                            <#if !doExistMessageForUsernameOrPassword>
+                                <#attempt>
+                                    <#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('password')>
+                                <#recover>
+                                    <#assign doExistMessageForUsernameOrPassword = true>
+                                </#attempt>
+                            </#if>
+
+                            <#if !doExistMessageForUsernameOrPassword>
+                                return "";
+                            <#else>
+                                <#attempt>
+                                    return "${kcSanitize(msg('invalidUserMessage'))?no_esc}";
+                                <#recover>
+                                    return "Invalid username or password.";
+                                </#attempt>
+                            </#if>
+
+                        <#else>
+
+                            <#attempt>
+                                return "${messagesPerField.get('${fieldName}')?no_esc}";
+                            <#recover>
+                                return "invalid field";
+                            </#attempt>
+
+                        </#if>
+
+                    <#else>
+
+                        <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
+                        <#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
+
+                            <#assign doExistErrorOnUsernameOrPassword = "">
+
+                            <#attempt>
+                                <#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
+                            <#recover>
+                                <#assign doExistErrorOnUsernameOrPassword = true>
+                            </#attempt>
+
+                            <#if doExistErrorOnUsernameOrPassword>
+
+                                <#attempt>
+                                    return "${kcSanitize(msg('invalidUserMessage'))?no_esc}";
+                                <#recover>
+                                    return "Invalid username or password.";
+                                </#attempt>
+
+                            <#else>
+
+                                <#attempt>
+                                    return "${messagesPerField.get('${fieldName}')?no_esc}";
+                                <#recover>
+                                    return "";
+                                </#attempt>
+
+                            </#if>
+
+                        <#else>
+
+                            <#attempt>
+                                return "${messagesPerField.get('${fieldName}')?no_esc}";
+                            <#recover>
+                                return "invalid field";
+                            </#attempt>
+
+                        </#if>
+
+                    </#if>
+
+                }
+            </#list>
+
+            throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
+
         },
         "exists": function (fieldName) {
-            <#if !messagesPerField?? >
-                return false;
-            <#else>
-                <#list fieldNames as fieldName>
-                    if(fieldName === "${fieldName}" ){
-                        <#attempt>
-                            <#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
-                                return <#if messagesPerField.exists('username') ||  messagesPerField.exists('password')>true<#else>false</#if>;
-                            <#else>
-                                return <#if messagesPerField.exists('${fieldName}')>true<#else>false</#if>;
-                            </#if>
-                        <#recover>
-                        </#attempt>
-                    }
-                </#list>
-                throw new Error("There is no " + fieldName + " field");
+
+            <#if !messagesPerField?? || !(messagesPerField?is_hash)>   
+                throw new Error("You're not supposed to use messagesPerField.exists in this page");
             </#if>
+
+            <#list fieldNames as fieldName>
+                if(fieldName === "${fieldName}" ){
+
+                    <#-- https://github.com/keycloakify/keycloakify/pull/359 Compat with Keycloak prior v12 -->
+                    <#if !messagesPerField.existsError??>
+
+                        <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
+                        <#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
+
+                            <#assign doExistMessageForUsernameOrPassword = "">
+
+                            <#attempt>
+                                <#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('username')>
+                            <#recover>
+                                <#assign doExistMessageForUsernameOrPassword = true>
+                            </#attempt>
+
+                            <#if !doExistMessageForUsernameOrPassword>
+                                <#attempt>
+                                    <#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('password')>
+                                <#recover>
+                                    <#assign doExistMessageForUsernameOrPassword = true>
+                                </#attempt>
+                            </#if>
+
+                            return <#if doExistMessageForUsernameOrPassword>true<#else>false</#if>;
+
+                        <#else>
+
+                            <#assign doExistMessageForField = "">
+
+                            <#attempt>
+                                <#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
+                            <#recover>
+                                <#assign doExistMessageForField = true>
+                            </#attempt>
+
+                            return <#if doExistMessageForField>true<#else>false</#if>;
+
+                        </#if>
+
+                    <#else>
+
+                        <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
+                        <#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
+
+                            <#assign doExistErrorOnUsernameOrPassword = "">
+
+                            <#attempt>
+                                <#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
+                            <#recover>
+                                <#assign doExistErrorOnUsernameOrPassword = true>
+                            </#attempt>
+
+                            return <#if doExistErrorOnUsernameOrPassword>true<#else>false</#if>;
+
+                        <#else>
+
+                            <#assign doExistErrorMessageForField = "">
+
+                            <#attempt>
+                                <#assign doExistErrorMessageForField = messagesPerField.exists('${fieldName}')>
+                            <#recover>
+                                <#assign doExistErrorMessageForField = true>
+                            </#attempt>
+
+                            return <#if doExistErrorMessageForField>true<#else>false</#if>;
+
+                        </#if>
+
+                    </#if>
+
+                }
+            </#list>
+
+            throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
+
         }
     };
 
@@ -120,6 +403,10 @@
         };
     </#if>
 
+    out["keycloakifyVersion"] = "KEYCLOAKIFY_VERSION_xEdKd3xEdr";
+    out["themeVersion"] = "KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx";
+    out["themeType"] = "KEYCLOAKIFY_THEME_TYPE_dExKd3xEdr";
+    out["themeName"] = "KEYCLOAKIFY_THEME_NAME_cXxKd3xEer";
     out["pageId"] = "${pageId}";
 
     return out;
@@ -168,10 +455,15 @@
                         <#-- 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 -->
+                        <#-- https://github.com/keycloakify/keycloakify/issues/357 -->
                         key == "loginAction" && 
                         are_same_path(path, ["url"]) && 
-                        ["saml-post-form.ftl", "error.ftl", "info.ftl"]?seq_contains(pageId) &&
+                        ["saml-post-form.ftl", "error.ftl", "info.ftl", "login-oauth-grant.ftl"]?seq_contains(pageId) &&
                         !(auth?has_content && auth.showTryAnotherWayLink())
+                    ) || (
+                        <#-- https://github.com/keycloakify/keycloakify/issues/362 -->
+                        ["secretData", "value"]?seq_contains(key) && 
+                        are_same_path(path, [ "totp", "otpCredentials", "*" ])
                     ) || (
                         ["contextData", "idpConfig", "idp", "authenticationSession"]?seq_contains(key) &&
                         are_same_path(path, ["brokerContext"]) &&
@@ -335,6 +627,17 @@
 
         </#if>
 
+        <#local isDate = "">
+        <#attempt>
+            <#local isDate = object?is_date_like>
+        <#recover>
+            <#return "ABORT: Can't test if it's a date">
+        </#attempt>
+
+        <#if isDate>
+            <#return '"' + object?datetime?iso_utc + '"'>
+        </#if>
+
         <#attempt>
             <#return '"' + object?js_string + '"'>;
         <#recover>

src/bin/keycloakify/generateFtl/generateFtl.ts

@@ -8,46 +8,20 @@ import { objectKeys } from "tsafe/objectKeys";
 import { ftlValuesGlobalName } from "../ftlValuesGlobalName";
 import type { BuildOptions } from "../BuildOptions";
 import { assert } from "tsafe/assert";
-import { Reflect } from "tsafe/Reflect";
 
 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"
-] 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 {
-    export type Standalone = {
+    export type Common = {
+        themeName: string;
+        themeVersion: string;
+    };
+
+    export type Standalone = Common & {
         isStandalone: true;
         urlPathname: string | undefined;
     };
@@ -59,31 +33,32 @@ export namespace BuildOptionsLike {
             isStandalone: false;
         };
 
-        export type SameDomain = CommonExternalAssets & {
-            areAppAndKeycloakServerSharingSameDomain: true;
-        };
+        export type SameDomain = Common &
+            CommonExternalAssets & {
+                areAppAndKeycloakServerSharingSameDomain: true;
+            };
 
-        export type DifferentDomains = CommonExternalAssets & {
-            areAppAndKeycloakServerSharingSameDomain: false;
-            urlOrigin: string;
-            urlPathname: string | undefined;
-        };
+        export type DifferentDomains = Common &
+            CommonExternalAssets & {
+                areAppAndKeycloakServerSharingSameDomain: false;
+                urlOrigin: string;
+                urlPathname: string | undefined;
+            };
     }
 }
 
-{
-    const buildOptions = Reflect<BuildOptions>();
-
-    assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
-}
+assert<BuildOptions extends BuildOptionsLike ? true : false>();
 
 export function generateFtlFilesCodeFactory(params: {
     indexHtmlCode: string;
     //NOTE: Expected to be an empty object if external assets mode is enabled.
     cssGlobalsToDefine: Record<string, string>;
     buildOptions: BuildOptionsLike;
+    keycloakifyVersion: string;
+    themeType: ThemeType;
+    fieldNames: string[];
 }) {
-    const { cssGlobalsToDefine, indexHtmlCode, buildOptions } = params;
+    const { cssGlobalsToDefine, indexHtmlCode, buildOptions, keycloakifyVersion, themeType, fieldNames } = params;
 
     const $ = cheerio.load(indexHtmlCode);
 
@@ -153,7 +128,12 @@ export function generateFtlFilesCodeFactory(params: {
         '{ "x": "vIdLqMeOed9sdLdIdOxdK0d" }': fs
             .readFileSync(pathJoin(__dirname, "ftl_object_to_js_code_declaring_an_object.ftl"))
             .toString("utf8")
-            .match(/^<script>const _=((?:.|\n)+)<\/script>[\n]?$/)![1],
+            .match(/^<script>const _=((?:.|\n)+)<\/script>[\n]?$/)![1]
+            .replace("FIELD_NAMES_eKsIY4ZsZ4xeM", fieldNames.map(name => `"${name}"`).join(", "))
+            .replace("KEYCLOAKIFY_VERSION_xEdKd3xEdr", keycloakifyVersion)
+            .replace("KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx", buildOptions.themeVersion)
+            .replace("KEYCLOAKIFY_THEME_TYPE_dExKd3xEdr", themeType)
+            .replace("KEYCLOAKIFY_THEME_NAME_cXxKd3xEer", buildOptions.themeName),
         "<!-- xIdLqMeOedErIdLsPdNdI9dSlxI -->": [
             "<#if scripts??>",
             "    <#list scripts as script>",
@@ -186,7 +166,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)));
 

src/bin/keycloakify/generateFtl/index.ts

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

src/bin/keycloakify/generateFtl/pageId.ts

@@ -0,0 +1,31 @@
+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",
+    "saml-post-form.ftl"
+] as const;
+
+export const accountThemePageIds = ["password.ftl", "account.ftl"] as const;
+
+export type LoginThemePageId = (typeof loginThemePageIds)[number];
+export type AccountThemePageId = (typeof accountThemePageIds)[number];

src/bin/keycloakify/generateJavaStackFiles.ts

@@ -1,15 +1,16 @@
 import * as fs from "fs";
 import { join as pathJoin, dirname as pathDirname } from "path";
-import { themeTypes } from "./generateFtl/generateFtl";
 import { assert } from "tsafe/assert";
 import { Reflect } from "tsafe/Reflect";
 import type { BuildOptions } from "./BuildOptions";
+import type { ThemeType } from "./generateFtl";
 
 export type BuildOptionsLike = {
     themeName: string;
+    extraThemeNames: string[];
     groupId: string;
     artifactId?: string;
-    version: string;
+    themeVersion: string;
 };
 
 {
@@ -20,15 +21,15 @@ export type BuildOptionsLike = {
 
 export function generateJavaStackFiles(params: {
     keycloakThemeBuildingDirPath: string;
-    doBundlesEmailTemplate: boolean;
+    implementedThemeTypes: Record<ThemeType | "email", boolean>;
     buildOptions: BuildOptionsLike;
 }): {
     jarFilePath: string;
 } {
     const {
-        buildOptions: { groupId, themeName, version, artifactId },
+        buildOptions: { groupId, themeName, extraThemeNames, themeVersion, artifactId },
         keycloakThemeBuildingDirPath,
-        doBundlesEmailTemplate
+        implementedThemeTypes
     } = params;
 
     {
@@ -43,7 +44,7 @@ export function generateJavaStackFiles(params: {
                 `	<modelVersion>4.0.0</modelVersion>`,
                 `	<groupId>${groupId}</groupId>`,
                 `	<artifactId>${artifactId}</artifactId>`,
-                `	<version>${version}</version>`,
+                `	<version>${themeVersion}</version>`,
                 `	<name>${artifactId}</name>`,
                 `	<description />`,
                 `</project>`
@@ -67,12 +68,12 @@ export function generateJavaStackFiles(params: {
             Buffer.from(
                 JSON.stringify(
                     {
-                        "themes": [
-                            {
-                                "name": themeName,
-                                "types": [...themeTypes, ...(doBundlesEmailTemplate ? ["email"] : [])]
-                            }
-                        ]
+                        "themes": [themeName, ...extraThemeNames].map(themeName => ({
+                            "name": themeName,
+                            "types": Object.entries(implementedThemeTypes)
+                                .filter(([, isImplemented]) => isImplemented)
+                                .map(([themeType]) => themeType)
+                        }))
                     },
                     null,
                     2
@@ -83,6 +84,6 @@ export function generateJavaStackFiles(params: {
     }
 
     return {
-        "jarFilePath": pathJoin(keycloakThemeBuildingDirPath, "target", `${artifactId}-${version}.jar`)
+        "jarFilePath": pathJoin(keycloakThemeBuildingDirPath, "target", `${artifactId}-${themeVersion}.jar`)
     };
 }

src/bin/keycloakify/generateStartKeycloakTestingContainer.ts

@@ -6,6 +6,7 @@ import type { BuildOptions } from "./BuildOptions";
 
 export type BuildOptionsLike = {
     themeName: string;
+    extraThemeNames: string[];
 };
 
 {
@@ -27,14 +28,11 @@ export function generateStartKeycloakTestingContainer(params: {
     const {
         keycloakThemeBuildingDirPath,
         keycloakVersion,
-        buildOptions: { themeName }
+        buildOptions: { themeName, extraThemeNames }
     } = params;
 
-    const keycloakThemePath = pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", themeName).replace(/\\/g, "/");
-
     fs.writeFileSync(
         pathJoin(keycloakThemeBuildingDirPath, generateStartKeycloakTestingContainer.basename),
-
         Buffer.from(
             [
                 "#!/usr/bin/env bash",
@@ -49,7 +47,13 @@ export function generateStartKeycloakTestingContainer(params: {
                 "   -e KEYCLOAK_ADMIN=admin \\",
                 "   -e KEYCLOAK_ADMIN_PASSWORD=admin \\",
                 "   -e JAVA_OPTS=-Dkeycloak.profile=preview \\",
-                `   -v "${keycloakThemePath}":"/opt/keycloak/themes/${themeName}":rw \\`,
+                ...[themeName, ...extraThemeNames].map(
+                    themeName =>
+                        `   -v "${pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", themeName).replace(
+                            /\\/g,
+                            "/"
+                        )}":"/opt/keycloak/themes/${themeName}":rw \\`
+                ),
                 `   -it quay.io/keycloak/keycloak:${keycloakVersion} \\`,
                 `   start-dev`,
                 ""

src/bin/keycloakify/generateTheme/downloadKeycloakStaticResources.ts

@@ -0,0 +1,47 @@
+import { transformCodebase } from "../../tools/transformCodebase";
+import * as fs from "fs";
+import { join as pathJoin, relative as pathRelative } from "path";
+import type { ThemeType } from "../generateFtl";
+import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
+import {
+    resourcesCommonDirPathRelativeToPublicDir,
+    resourcesDirPathRelativeToPublicDir,
+    basenameOfKeycloakDirInPublicDir
+} from "../../mockTestingResourcesPath";
+import * as crypto from "crypto";
+
+export async function downloadKeycloakStaticResources(
+    // prettier-ignore
+    params: {
+        themeType: ThemeType;
+        themeDirPath: string;
+        isSilent: boolean;
+        keycloakVersion: string;
+    }
+) {
+    const { themeType, isSilent, themeDirPath, keycloakVersion } = params;
+
+    const tmpDirPath = pathJoin(
+        themeDirPath,
+        "..",
+        `tmp_suLeKsxId_${crypto.createHash("sha256").update(`${themeType}-${keycloakVersion}`).digest("hex").slice(0, 8)}`
+    );
+
+    await downloadBuiltinKeycloakTheme({
+        keycloakVersion,
+        "destDirPath": tmpDirPath,
+        isSilent
+    });
+
+    transformCodebase({
+        "srcDirPath": pathJoin(tmpDirPath, "keycloak", themeType, "resources"),
+        "destDirPath": pathJoin(themeDirPath, pathRelative(basenameOfKeycloakDirInPublicDir, resourcesDirPathRelativeToPublicDir))
+    });
+
+    transformCodebase({
+        "srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
+        "destDirPath": pathJoin(themeDirPath, pathRelative(basenameOfKeycloakDirInPublicDir, resourcesCommonDirPathRelativeToPublicDir))
+    });
+
+    fs.rmSync(tmpDirPath, { "recursive": true, "force": true });
+}

src/bin/keycloakify/generateTheme/generateTheme.ts

@@ -1,15 +1,15 @@
-import { transformCodebase } from "../tools/transformCodebase";
+import { transformCodebase } from "../../tools/transformCodebase";
 import * as fs from "fs";
-import { join as pathJoin, basename as pathBasename } from "path";
-import { replaceImportsFromStaticInJsCode } from "./replacers/replaceImportsFromStaticInJsCode";
-import { replaceImportsInCssCode } from "./replacers/replaceImportsInCssCode";
-import { generateFtlFilesCodeFactory, loginThemePageIds, accountThemePageIds, themeTypes, type ThemeType } from "./generateFtl";
-import { downloadBuiltinKeycloakTheme } from "../download-builtin-keycloak-theme";
-import { mockTestingResourcesCommonPath, mockTestingResourcesPath, mockTestingSubDirOfPublicDirBasename } from "../mockTestingResourcesPath";
-import { isInside } from "../tools/isInside";
-import type { BuildOptions } from "./BuildOptions";
+import { join as pathJoin } from "path";
+import { replaceImportsFromStaticInJsCode } from "../replacers/replaceImportsFromStaticInJsCode";
+import { replaceImportsInCssCode } from "../replacers/replaceImportsInCssCode";
+import { generateFtlFilesCodeFactory, loginThemePageIds, accountThemePageIds, themeTypes, type ThemeType } from "../generateFtl";
+import { basenameOfKeycloakDirInPublicDir } from "../../mockTestingResourcesPath";
+import { isInside } from "../../tools/isInside";
+import type { BuildOptions } from "../BuildOptions";
 import { assert } from "tsafe/assert";
-import { Reflect } from "tsafe/Reflect";
+import { downloadKeycloakStaticResources } from "./downloadKeycloakStaticResources";
+import { readFieldNameUsage } from "./readFieldNameUsage";
 
 export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.ExternalAssets;
 
@@ -20,6 +20,8 @@ export namespace BuildOptionsLike {
         extraAccountPages?: string[];
         extraThemeProperties?: string[];
         isSilent: boolean;
+        themeVersion: string;
+        keycloakVersionDefaultAssets: string;
     };
 
     export type Standalone = Common & {
@@ -46,20 +48,17 @@ export namespace BuildOptionsLike {
     }
 }
 
-{
-    const buildOptions = Reflect<BuildOptions>();
+assert<BuildOptions extends BuildOptionsLike ? true : false>();
 
-    assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
-}
-
-export async function generateKeycloakThemeResources(params: {
+export async function generateTheme(params: {
     reactAppBuildDirPath: string;
     keycloakThemeBuildingDirPath: string;
-    emailThemeSrcDirPath: string | undefined;
-    keycloakVersion: string;
+    themeSrcDirPath: string | undefined;
+    keycloakifySrcDirPath: string;
     buildOptions: BuildOptionsLike;
-}): Promise<{ doBundlesEmailTemplate: boolean }> {
-    const { reactAppBuildDirPath, keycloakThemeBuildingDirPath, emailThemeSrcDirPath, keycloakVersion, buildOptions } = params;
+    keycloakifyVersion: string;
+}): Promise<void> {
+    const { reactAppBuildDirPath, keycloakThemeBuildingDirPath, themeSrcDirPath, keycloakifySrcDirPath, buildOptions, keycloakifyVersion } = params;
 
     const getThemeDirPath = (themeType: ThemeType | "email") =>
         pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", buildOptions.themeName, themeType);
@@ -86,7 +85,7 @@ export async function generateKeycloakThemeResources(params: {
                     if (
                         buildOptions.isStandalone &&
                         isInside({
-                            "dirPath": pathJoin(reactAppBuildDirPath, mockTestingSubDirOfPublicDirBasename),
+                            "dirPath": pathJoin(reactAppBuildDirPath, basenameOfKeycloakDirInPublicDir),
                             filePath
                         })
                     ) {
@@ -142,7 +141,14 @@ export async function generateKeycloakThemeResources(params: {
             const { generateFtlFilesCode } = generateFtlFilesCodeFactory({
                 "indexHtmlCode": fs.readFileSync(pathJoin(reactAppBuildDirPath, "index.html")).toString("utf8"),
                 "cssGlobalsToDefine": allCssGlobalsToDefine,
-                "buildOptions": buildOptions
+                buildOptions,
+                keycloakifyVersion,
+                themeType,
+                "fieldNames": readFieldNameUsage({
+                    keycloakifySrcDirPath,
+                    themeSrcDirPath,
+                    themeType
+                })
             });
 
             return generateFtlFilesCode;
@@ -173,70 +179,67 @@ export async function generateKeycloakThemeResources(params: {
             fs.writeFileSync(pathJoin(themeDirPath, pageId), Buffer.from(ftlCode, "utf8"));
         });
 
-        {
-            const tmpDirPath = pathJoin(themeDirPath, "..", "tmp_xxKdLpdIdLd");
+        //TODO: Remove this block we left it for now only for backward compatibility
+        // we now have a separate script for this
+        copy_keycloak_resources_to_public: {
+            const keycloakDirInPublicDir = pathJoin(reactAppBuildDirPath, "..", "public", basenameOfKeycloakDirInPublicDir);
 
-            await downloadBuiltinKeycloakTheme({
-                keycloakVersion,
-                "destDirPath": tmpDirPath,
-                isSilent: buildOptions.isSilent
+            if (fs.existsSync(keycloakDirInPublicDir)) {
+                break copy_keycloak_resources_to_public;
+            }
+
+            await downloadKeycloakStaticResources({
+                "isSilent": buildOptions.isSilent,
+                "keycloakVersion": buildOptions.keycloakVersionDefaultAssets,
+                "themeDirPath": keycloakDirInPublicDir,
+                themeType
             });
 
-            const themeResourcesDirPath = pathJoin(themeDirPath, "resources");
-
-            transformCodebase({
-                "srcDirPath": pathJoin(tmpDirPath, "keycloak", "login", "resources"),
-                "destDirPath": themeResourcesDirPath
-            });
-
-            const reactAppPublicDirPath = pathJoin(reactAppBuildDirPath, "..", "public");
-
-            transformCodebase({
-                "srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
-                "destDirPath": pathJoin(themeResourcesDirPath, pathBasename(mockTestingResourcesCommonPath))
-            });
-
-            transformCodebase({
-                "srcDirPath": themeResourcesDirPath,
-                "destDirPath": pathJoin(reactAppPublicDirPath, mockTestingResourcesPath)
-            });
-
-            const keycloakResourcesWithinPublicDirPath = pathJoin(reactAppPublicDirPath, mockTestingSubDirOfPublicDirBasename);
+            if (themeType !== themeTypes[0]) {
+                break copy_keycloak_resources_to_public;
+            }
 
             fs.writeFileSync(
-                pathJoin(keycloakResourcesWithinPublicDirPath, "README.txt"),
+                pathJoin(keycloakDirInPublicDir, "README.txt"),
                 Buffer.from(
-                    ["This is just a test folder that helps develop", "the login and register page without having to run a Keycloak container"].join(
-                        " "
-                    )
+                    // prettier-ignore
+                    [
+                        "This is just a test folder that helps develop",
+                        "the login and register page without having to run a Keycloak container"
+                    ].join(" ")
                 )
             );
 
-            fs.writeFileSync(pathJoin(keycloakResourcesWithinPublicDirPath, ".gitignore"), Buffer.from("*", "utf8"));
-            fs.rmSync(tmpDirPath, { recursive: true, force: true });
+            fs.writeFileSync(pathJoin(keycloakDirInPublicDir, ".gitignore"), Buffer.from("*", "utf8"));
         }
 
+        await downloadKeycloakStaticResources({
+            "isSilent": buildOptions.isSilent,
+            "keycloakVersion": buildOptions.keycloakVersionDefaultAssets,
+            themeDirPath,
+            themeType
+        });
+
         fs.writeFileSync(
             pathJoin(themeDirPath, "theme.properties"),
             Buffer.from(["parent=keycloak", ...(buildOptions.extraThemeProperties ?? [])].join("\n\n"), "utf8")
         );
     }
 
-    let doBundlesEmailTemplate: boolean;
-
     email: {
-        if (emailThemeSrcDirPath === undefined) {
-            doBundlesEmailTemplate = false;
+        if (themeSrcDirPath === undefined) {
             break email;
         }
 
-        doBundlesEmailTemplate = true;
+        const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
+
+        if (!fs.existsSync(emailThemeSrcDirPath)) {
+            break email;
+        }
 
         transformCodebase({
             "srcDirPath": emailThemeSrcDirPath,
             "destDirPath": getThemeDirPath("email")
         });
     }
-
-    return { doBundlesEmailTemplate };
 }

src/bin/keycloakify/generateTheme/index.ts

@@ -0,0 +1 @@
+export * from "./generateTheme";

src/bin/keycloakify/generateTheme/readFieldNameUsage.ts

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

src/bin/keycloakify/index.ts

@@ -4,5 +4,5 @@ export * from "./keycloakify";
 import { main } from "./keycloakify";
 
 if (require.main === module) {
-    main().catch(e => console.error(e));
+    main();
 }

src/bin/keycloakify/keycloakify.ts

@@ -1,4 +1,4 @@
-import { generateKeycloakThemeResources } from "./generateKeycloakThemeResources";
+import { generateTheme } from "./generateTheme";
 import { generateJavaStackFiles } from "./generateJavaStackFiles";
 import { join as pathJoin, relative as pathRelative, basename as pathBasename, sep as pathSep } from "path";
 import * as child_process from "child_process";
@@ -6,55 +6,72 @@ import { generateStartKeycloakTestingContainer } from "./generateStartKeycloakTe
 import * as fs from "fs";
 import { readBuildOptions } from "./BuildOptions";
 import { getLogger } from "../tools/logger";
-import { getCliOptions } from "../tools/cliOptions";
 import jar from "../tools/jar";
 import { assert } from "tsafe/assert";
 import { Equals } from "tsafe";
-import { getEmailThemeSrcDirPath } from "../initialize-email-theme";
-
-const reactProjectDirPath = process.cwd();
-
-export const keycloakThemeBuildingDirPath = pathJoin(reactProjectDirPath, "build_keycloak");
+import { getThemeSrcDirPath } from "../getSrcDirPath";
+import { getProjectRoot } from "../tools/getProjectRoot";
+import { objectKeys } from "tsafe/objectKeys";
 
 export async function main() {
-    const { isSilent, hasExternalAssets } = getCliOptions(process.argv.slice(2));
-    const logger = getLogger({ isSilent });
-    logger.log("🔏 Building the keycloak theme...⌚");
+    const projectDirPath = process.cwd();
 
     const buildOptions = readBuildOptions({
-        "packageJson": fs.readFileSync(pathJoin(reactProjectDirPath, "package.json")).toString("utf8"),
-        "CNAME": (() => {
-            const cnameFilePath = pathJoin(reactProjectDirPath, "public", "CNAME");
-
-            if (!fs.existsSync(cnameFilePath)) {
-                return undefined;
-            }
-
-            return fs.readFileSync(cnameFilePath).toString("utf8");
-        })(),
-        "isExternalAssetsCliParamProvided": hasExternalAssets,
-        "isSilent": isSilent
+        projectDirPath,
+        "processArgv": process.argv.slice(2)
     });
 
-    const { doBundlesEmailTemplate } = await generateKeycloakThemeResources({
-        keycloakThemeBuildingDirPath,
-        "emailThemeSrcDirPath": (() => {
-            const { emailThemeSrcDirPath } = getEmailThemeSrcDirPath();
+    const logger = getLogger({ "isSilent": buildOptions.isSilent });
+    logger.log("🔏 Building the keycloak theme...⌚");
 
-            if (emailThemeSrcDirPath === undefined || !fs.existsSync(emailThemeSrcDirPath)) {
-                return;
-            }
+    const keycloakifyDirPath = getProjectRoot();
 
-            return emailThemeSrcDirPath;
-        })(),
-        "reactAppBuildDirPath": pathJoin(reactProjectDirPath, "build"),
-        buildOptions,
-        "keycloakVersion": buildOptions.keycloakVersionDefaultAssets
-    });
+    const { themeSrcDirPath } = getThemeSrcDirPath({ projectDirPath });
+
+    for (const themeName of [buildOptions.themeName, ...buildOptions.extraThemeNames]) {
+        await generateTheme({
+            "keycloakThemeBuildingDirPath": buildOptions.keycloakifyBuildDirPath,
+            themeSrcDirPath,
+            "keycloakifySrcDirPath": pathJoin(keycloakifyDirPath, "src"),
+            "reactAppBuildDirPath": buildOptions.reactAppBuildDirPath,
+            "buildOptions": {
+                ...buildOptions,
+                "themeName": themeName
+            },
+            "keycloakifyVersion": (() => {
+                const version = JSON.parse(fs.readFileSync(pathJoin(keycloakifyDirPath, "package.json")).toString("utf8"))["version"];
+
+                assert(typeof version === "string");
+
+                return version;
+            })()
+        });
+    }
 
     const { jarFilePath } = generateJavaStackFiles({
-        keycloakThemeBuildingDirPath,
-        doBundlesEmailTemplate,
+        "keycloakThemeBuildingDirPath": buildOptions.keycloakifyBuildDirPath,
+        "implementedThemeTypes": (() => {
+            const implementedThemeTypes = {
+                "login": false,
+                "account": false,
+                "email": false
+            };
+
+            if (themeSrcDirPath === undefined) {
+                implementedThemeTypes["login"] = true;
+                implementedThemeTypes["account"] = true;
+                return implementedThemeTypes;
+            }
+
+            for (const themeType of objectKeys(implementedThemeTypes)) {
+                if (!fs.existsSync(pathJoin(themeSrcDirPath, themeType))) {
+                    continue;
+                }
+                implementedThemeTypes[themeType] = true;
+            }
+
+            return implementedThemeTypes;
+        })(),
         buildOptions
     });
 
@@ -65,8 +82,8 @@ export async function main() {
         case "keycloakify":
             logger.log("🫶 Let keycloakify do its thang");
             await jar({
-                "rootPath": pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources"),
-                "version": buildOptions.version,
+                "rootPath": buildOptions.keycloakifyBuildDirPath,
+                "version": buildOptions.themeVersion,
                 "groupId": buildOptions.groupId,
                 "artifactId": buildOptions.artifactId,
                 "targetPath": jarFilePath
@@ -74,7 +91,7 @@ export async function main() {
             break;
         case "mvn":
             logger.log("🫙 Run maven to deliver a jar");
-            child_process.execSync("mvn package", { "cwd": keycloakThemeBuildingDirPath });
+            child_process.execSync("mvn package", { "cwd": buildOptions.keycloakifyBuildDirPath });
             break;
         default:
             assert<Equals<typeof buildOptions.bundler, never>>(false);
@@ -84,7 +101,7 @@ export async function main() {
     const containerKeycloakVersion = "20.0.1";
 
     generateStartKeycloakTestingContainer({
-        keycloakThemeBuildingDirPath,
+        keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
         "keycloakVersion": containerKeycloakVersion,
         buildOptions
     });
@@ -92,7 +109,7 @@ export async function main() {
     logger.log(
         [
             "",
-            `✅ Your keycloak theme has been generated and bundled into ./${pathRelative(reactProjectDirPath, 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.
@@ -127,24 +144,26 @@ 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(
-                reactProjectDirPath,
-                pathJoin(keycloakThemeBuildingDirPath, 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`,
             ``,
             `Once your container is up and running: `,
             "- Log into the admin console 👉 http://localhost:8080/admin username: admin, password: admin 👈",
-            `- 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 is optional)`,
-            `  Valid post logout redirect URIs: https://www.keycloak.org/app* http://localhost*`,
-            `  Web origins:                     *`,
-            `  Login Theme:                     ${buildOptions.themeName}`,
-            `  Save (button at the bottom of the page)`,
+            `- Create a realm:                       Master         -> AddRealm   -> Name: myrealm`,
+            `- Enable registration:                  Realm settings -> Login tab  -> User registration: on`,
+            `- Enable the Account theme (optional):  Realm settings -> Themes tab -> Account theme: ${buildOptions.themeName}`,
+            `                                        Clients        -> account    -> Login theme:   ${buildOptions.themeName}`,
+            `- Enable the email theme (optional):    Realm settings -> Themes tab -> Email theme:   ${buildOptions.themeName} (option will appear only if you have ran npx initialize-email-theme)`,
+            `- Create a client                       Clients        -> Create     -> Client ID:                       myclient`,
+            `                                                                        Root URL:                        https://www.keycloak.org/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}`,
+            `                                                                        Save (button at the bottom of the page)`,
             ``,
             `- 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`,

src/bin/keycloakify/parsedPackageJson.ts

@@ -0,0 +1,64 @@
+import * as fs from "fs";
+import { assert } from "tsafe";
+import type { Equals } from "tsafe";
+import { z } from "zod";
+import { pathJoin } from "../tools/pathJoin";
+
+export const bundlers = ["mvn", "keycloakify", "none"] as const;
+export type Bundler = (typeof bundlers)[number];
+export type ParsedPackageJson = {
+    name: string;
+    version?: string;
+    homepage?: string;
+    keycloakify?: {
+        /** @deprecated: use extraLoginPages instead */
+        extraPages?: string[];
+        extraLoginPages?: string[];
+        extraAccountPages?: string[];
+        extraThemeProperties?: string[];
+        areAppAndKeycloakServerSharingSameDomain?: boolean;
+        artifactId?: string;
+        groupId?: string;
+        bundler?: Bundler;
+        keycloakVersionDefaultAssets?: string;
+        reactAppBuildDirPath?: string;
+        keycloakifyBuildDirPath?: string;
+        themeName?: string;
+        extraThemeNames?: string[];
+    };
+};
+
+export const zParsedPackageJson = z.object({
+    "name": z.string(),
+    "version": z.string().optional(),
+    "homepage": z.string().optional(),
+    "keycloakify": z
+        .object({
+            "extraPages": z.array(z.string()).optional(),
+            "extraLoginPages": z.array(z.string()).optional(),
+            "extraAccountPages": z.array(z.string()).optional(),
+            "extraThemeProperties": z.array(z.string()).optional(),
+            "areAppAndKeycloakServerSharingSameDomain": z.boolean().optional(),
+            "artifactId": z.string().optional(),
+            "groupId": z.string().optional(),
+            "bundler": z.enum(bundlers).optional(),
+            "keycloakVersionDefaultAssets": z.string().optional(),
+            "reactAppBuildDirPath": z.string().optional(),
+            "keycloakifyBuildDirPath": z.string().optional(),
+            "themeName": z.string().optional(),
+            "extraThemeNames": z.array(z.string()).optional()
+        })
+        .optional()
+});
+
+assert<Equals<ReturnType<(typeof zParsedPackageJson)["parse"]>, ParsedPackageJson>>();
+
+let parsedPackageJson: undefined | ReturnType<(typeof zParsedPackageJson)["parse"]>;
+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;
+}

src/bin/mockTestingResourcesPath.ts

@@ -1,5 +1,5 @@
 import { pathJoin } from "./tools/pathJoin";
 
-export const mockTestingSubDirOfPublicDirBasename = "keycloak_static";
-export const mockTestingResourcesPath = pathJoin(mockTestingSubDirOfPublicDirBasename, "resources");
-export const mockTestingResourcesCommonPath = pathJoin(mockTestingResourcesPath, "resources_common");
+export const basenameOfKeycloakDirInPublicDir = "keycloak-resources";
+export const resourcesDirPathRelativeToPublicDir = pathJoin(basenameOfKeycloakDirInPublicDir, "resources");
+export const resourcesCommonDirPathRelativeToPublicDir = pathJoin(resourcesDirPathRelativeToPublicDir, "resources_common");

src/bin/tools/cliOptions.ts

@@ -1,15 +0,0 @@
-import parseArgv from "minimist";
-
-export type CliOptions = {
-    isSilent: boolean;
-    hasExternalAssets: boolean;
-};
-
-export const getCliOptions = (processArgv: string[]): CliOptions => {
-    const argv = parseArgv(processArgv);
-
-    return {
-        isSilent: typeof argv["silent"] === "boolean" ? argv["silent"] : false,
-        hasExternalAssets: typeof argv["external-assets"] === "boolean" ? argv["external-assets"] : false
-    };
-};

src/bin/tools/downloadAndUnzip.ts

@@ -1,6 +1,6 @@
 import { exec as execCallback } from "child_process";
 import { createHash } from "crypto";
-import { mkdir, stat, writeFile } from "fs/promises";
+import { mkdir, readFile, 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";
@@ -25,53 +25,90 @@ async function exists(path: string) {
     }
 }
 
+function ensureArray<T>(arg0: T | T[]) {
+    return Array.isArray(arg0) ? arg0 : typeof arg0 === "undefined" ? [] : [arg0];
+}
+
+function ensureSingleOrNone<T>(arg0: T | T[]) {
+    if (!Array.isArray(arg0)) return arg0;
+    if (arg0.length === 0) return undefined;
+    if (arg0.length === 1) return arg0[0];
+    throw new Error("Illegal configuration, expected a single value but found multiple: " + arg0.map(String).join(", "));
+}
+
+type NPMConfig = Record<string, string | string[]>;
+
+const npmConfigReducer = (cfg: NPMConfig, [key, value]: [string, string]) =>
+    key in cfg ? { ...cfg, [key]: [...ensureArray(cfg[key]), value] } : { ...cfg, [key]: value };
+
 /**
  * Get npm configuration as map
  */
-async function getNmpConfig(): Promise<Record<string, string>> {
+async function getNmpConfig() {
+    return readNpmConfig().then(parseNpmConfig);
+}
+
+async function readNpmConfig() {
     const { stdout } = await exec("npm config get", { encoding: "utf8" });
+    return stdout;
+}
+
+function parseNpmConfig(stdout: string) {
     return stdout
         .split("\n")
         .filter(line => !line.startsWith(";"))
         .map(line => line.trim())
-        .map(line => line.split("=", 2))
-        .reduce((cfg, [key, value]) => ({ ...cfg, [key]: value }), {});
+        .map(line => line.split("=", 2) as [string, string])
+        .reduce(npmConfigReducer, {} as NPMConfig);
+}
+
+function maybeBoolean(arg0: string | undefined) {
+    return typeof arg0 === "undefined" ? undefined : Boolean(arg0);
+}
+
+function chunks<T>(arr: T[], size: number = 2) {
+    return arr.map((_, i) => i % size == 0 && arr.slice(i, i + size)).filter(Boolean) as T[][];
+}
+
+async function readCafile(cafile: string) {
+    const cafileContent = await readFile(cafile, "utf-8");
+    return chunks(cafileContent.split(/(-----END CERTIFICATE-----)/), 2).map(ca => ca.join("").replace(/^\n/, "").replace(/\n/g, "\\n"));
 }
 
 /**
- * Get proxy configuration from npm config files. Note that we don't care about
+ * Get proxy and ssl configuration from npm config files. Note that we don't care about
  * proxy config in env vars, because make-fetch-happen will do that for us.
  *
  * @returns proxy configuration
  */
-async function getNpmProxyConfig(): Promise<Pick<FetchOptions, "proxy" | "noProxy">> {
+async function getFetchOptions(): Promise<Pick<FetchOptions, "proxy" | "noProxy" | "strictSSL" | "ca" | "cert">> {
     const cfg = await getNmpConfig();
 
-    const proxy = cfg["https-proxy"] ?? cfg["proxy"];
+    const proxy = ensureSingleOrNone(cfg["https-proxy"] ?? cfg["proxy"]);
     const noProxy = cfg["noproxy"] ?? cfg["no-proxy"];
+    const strictSSL = maybeBoolean(ensureSingleOrNone(cfg["strict-ssl"]));
+    const cert = cfg["cert"];
+    const ca = ensureArray(cfg["ca"] ?? cfg["ca[]"]);
+    const cafile = ensureSingleOrNone(cfg["cafile"]);
 
-    return { proxy, noProxy };
+    if (typeof cafile !== "undefined" && cafile !== "null") ca.push(...(await readCafile(cafile)));
+
+    return { proxy, noProxy, strictSSL, cert, ca: ca.length === 0 ? undefined : ca };
 }
 
-export async function downloadAndUnzip({
-    url,
-    destDirPath,
-    pathOfDirToExtractInArchive
-}: {
-    url: string;
-    destDirPath: string;
-    pathOfDirToExtractInArchive?: string;
-}) {
+export async function downloadAndUnzip(params: { url: string; destDirPath: string; pathOfDirToExtractInArchive?: string }) {
+    const { url, destDirPath, pathOfDirToExtractInArchive } = params;
+
     const downloadHash = hash(JSON.stringify({ url })).substring(0, 15);
     const projectRoot = getProjectRoot();
-    const cacheRoot = process.env.XDG_CACHE_HOME ?? `${projectRoot}/node_modules/.cache`;
+    const cacheRoot = process.env.XDG_CACHE_HOME ?? pathJoin(projectRoot, "node_modules", ".cache");
     const zipFilePath = pathJoin(cacheRoot, "keycloakify", "zip", `_${downloadHash}.zip`);
     const extractDirPath = pathJoin(cacheRoot, "keycloakify", "unzip", `_${downloadHash}`);
 
     if (!(await exists(zipFilePath))) {
-        const proxyOpts = await getNpmProxyConfig();
-        const response = await fetch(url, proxyOpts);
-        await mkdir(pathDirname(zipFilePath), { recursive: true });
+        const opts = await getFetchOptions();
+        const response = await fetch(url, opts);
+        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.)

src/bin/tools/jar.ts

@@ -1,94 +1,99 @@
-import { Readable, Transform } from "stream";
-import { dirname, relative, sep } from "path";
+import { dirname, relative, sep, join } 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
+    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();
+
+    for await (const entry of asyncPathGeneratorFn()) {
+        if ("buffer" in entry) {
+            zipFile.addBuffer(entry.buffer, entry.zipPath);
+        } else if ("fsPath" in entry) {
+            if (entry.fsPath.endsWith(sep)) {
+                zipFile.addEmptyDirectory(entry.zipPath);
+            } else {
+                zipFile.addFile(entry.fsPath, entry.zipPath);
             }
-        });
+        }
+    }
 
-    await mkdir(dirname(targetPath), { recursive: true });
+    zipFile.addBuffer(manifestData, manifestPath);
+    zipFile.addBuffer(pomPropsData, pomPropsPath);
 
-    // 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.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.
+ * The root directory is expectedto have a conventional maven/gradle folder structure with a
+ * single `pom.xml` file at the root and a `src/main/resources` directory containing all
+ * application resources.
  */
-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().catch(e => console.error(e));
+export default async function jar({ groupId, artifactId, version, rootPath, targetPath }: JarArgs) {
+    await mkdir(dirname(targetPath), { recursive: true });
+
+    const asyncPathGeneratorFn = async function* (): ZipEntryGenerator {
+        const resourcesPath = join(rootPath, "src", "main", "resources");
+        for await (const fsPath of walk(resourcesPath)) {
+            const zipPath = relative(resourcesPath, fsPath).split(sep).join("/");
+            yield { fsPath, zipPath };
+        }
+        yield {
+            fsPath: join(rootPath, "pom.xml"),
+            zipPath: `META-INF/maven/${groupId}/${artifactId}/pom.xml`
+        };
+    };
+
+    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));
+    });
 }

src/bin/tools/trimIndent.ts

@@ -2,50 +2,45 @@
  * Concatenate the string fragments and interpolated values
  * to get a single string.
  */
-function populateTemplate(strings: TemplateStringsArray, ...args: any[]) {
-    const chunks = [];
+function populateTemplate(strings: TemplateStringsArray, ...args: unknown[]) {
+    const chunks: string[] = [];
     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;
+            lastStringLineLength = strings[i].split("\n").slice(-1)[0]?.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)));
+            const chunk = String(args[i]).replace(/([\r?\n])/g, "$1" + " ".repeat(lastStringLineLength));
+            chunks.push(chunk);
         }
     }
     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);
+    // Remove initial and final newlines
+    let string = populateTemplate(strings, ...args)
+        .replace(/^[\r\n]/, "")
+        .replace(/\r?\n *$/, "");
+    const dents =
+        string
+            .match(/^([ \t])+/gm)
+            ?.filter(s => /^\s+$/.test(s))
+            ?.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 re = new RegExp(`^${" ".repeat(minDent)}`, "gm");
+    const dedented = string.replace(re, "");
+    return dedented;
 }
-
-/**
- * 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

@@ -1,184 +1,92 @@
-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";
+import fsp from "node:fs/promises";
+import fs from "fs";
+import path from "node:path";
+import yauzl from "yauzl";
+import stream from "node:stream";
+import { promisify } from "node:util";
 
-export type MultiError = Error & { cause: Error[] };
+const pipeline = promisify(stream.pipeline);
 
-/**
- * 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;
+async function pathExists(path: string) {
+    try {
+        await fsp.stat(path);
+        return true;
+    } catch (error) {
+        if ((error as { code: string }).code === "ENOENT") {
+            return false;
         }
-        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 }));
+        throw error;
+    }
+}
 
-                // 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);
-            })
-        );
+export async function unzip(file: string, targetFolder: string, unzipSubPath?: string) {
+    // add trailing slash to unzipSubPath and targetFolder
+    if (unzipSubPath && (!unzipSubPath.endsWith("/") || !unzipSubPath.endsWith("\\"))) {
+        unzipSubPath += "/";
     }
 
-    // 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;
+    if (!targetFolder.endsWith("/") || !targetFolder.endsWith("\\")) {
+        targetFolder += "/";
+    }
+    if (!fs.existsSync(targetFolder)) {
+        fs.mkdirSync(targetFolder, { recursive: true });
     }
 
-    return success;
-}
+    return new Promise<void>((resolve, reject) => {
+        yauzl.open(file, { lazyEntries: true }, async (err, zipfile) => {
+            if (err) {
+                reject(err);
+                return;
+            }
 
-function depth(dir: string) {
-    return dir.match(/\//g)?.length ?? 0;
-}
+            zipfile.readEntry();
 
-function sortByFolderDepth(order: "asc" | "desc") {
-    const ord = order === "asc" ? 1 : -1;
-    return (a: string | undefined, b: string | undefined) => ord * depth(a ?? "") + -ord * depth(b ?? "");
-}
+            zipfile.on("entry", async entry => {
+                if (unzipSubPath) {
+                    // Skip files outside of the unzipSubPath
+                    if (!entry.fileName.startsWith(unzipSubPath)) {
+                        zipfile.readEntry();
+                        return;
+                    }
 
-/**
- *
- * @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));
+                    // Remove the unzipSubPath from the file name
+                    entry.fileName = entry.fileName.substring(unzipSubPath.length);
+                }
+
+                const target = path.join(targetFolder, entry.fileName);
+
+                // Directory file names end with '/'.
+                // Note that entries for directories themselves are optional.
+                // An entry's fileName implicitly requires its parent directories to exist.
+                if (/[\/\\]$/.test(target)) {
+                    await fsp.mkdir(target, { recursive: true });
+
+                    zipfile.readEntry();
+                    return;
+                }
+
+                // Skip existing files
+                if (await pathExists(target)) {
+                    zipfile.readEntry();
+                    return;
+                }
+
+                zipfile.openReadStream(entry, async (err, readStream) => {
+                    if (err) {
+                        reject(err);
+                        return;
+                    }
+
+                    await pipeline(readStream, fs.createWriteStream(target));
+
+                    zipfile.readEntry();
+                });
+            });
+
+            zipfile.once("end", function () {
+                zipfile.close();
+                resolve();
+            });
+        });
     });
 }
-
-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/bin/tools/walk.ts

@@ -1,19 +1,19 @@
 import { readdir } from "fs/promises";
-import { resolve } from "path";
+import { resolve, sep } from "path";
 
 /**
  * Asynchronously and recursively walk a directory tree, yielding every file and directory
- * found
+ * found. Directory paths will _always_ end with a path separator.
  *
  * @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()) {
-            yield absolutePath;
+            yield absolutePath.endsWith(sep) ? absolutePath : absolutePath + sep;
             yield* walk(absolutePath);
-        } else yield absolutePath;
+        } else yield absolutePath.endsWith(sep) ? absolutePath.substring(0, absolutePath.length - 1) : absolutePath;
     }
 }

src/bin/tools/zip.ts

@@ -1,246 +0,0 @@
-import { Transform, TransformOptions } from "stream";
-import { createReadStream } from "fs";
-import { stat } from "fs/promises";
-import { Blob } from "buffer";
-
-import { deflateBuffer, deflateStream } from "./deflate";
-
-/**
- * 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 the actual byte size of an string
- */
-function utf8size(s: string) {
-    return new Blob([s]).size;
-}
-
-/**
- * @param record
- * @returns a buffer representing a Zip local header
- * @link https://en.wikipedia.org/wiki/ZIP_(file_format)#Local_file_header
- */
-function localHeader(record: ZipRecord) {
-    const { path, compression, uncompressedSize } = record;
-    const filenameSize = utf8size(path);
-    const buf = Buffer.alloc(30 + filenameSize);
-
-    buf.writeUInt32LE(0x04_03_4b_50, 0); // local header signature
-    buf.writeUInt16LE(10, 4); // min version
-    // we write 0x08 because crc and compressed size are unknown at
-    buf.writeUInt16LE(0x08, 6); // general purpose bit flag
-    buf.writeUInt16LE(compression ? ({ "deflate": 8 } as const)[compression] : 0, 8);
-    buf.writeUInt16LE(0, 10); // modified time
-    buf.writeUInt16LE(0, 12); // modified date
-    buf.writeUInt32LE(0, 14); // crc unknown
-    buf.writeUInt32LE(0, 18); // compressed size unknown
-    buf.writeUInt32LE(uncompressedSize, 22);
-    buf.writeUInt16LE(filenameSize, 26);
-    buf.writeUInt16LE(0, 28); // extra field length
-    buf.write(path, 30, "utf-8");
-
-    return buf;
-}
-
-/**
- * @param record
- * @returns a buffer representing a Zip central header
- * @link https://en.wikipedia.org/wiki/ZIP_(file_format)#Central_directory_file_header
- */
-function centralHeader(record: ZipRecord) {
-    const { path, compression, crc32, compressedSize, uncompressedSize, offset } = record;
-    const filenameSize = utf8size(path);
-    const buf = Buffer.alloc(46 + filenameSize);
-    const isFile = !path.endsWith("/");
-
-    if (typeof offset === "undefined") throw new Error("Illegal argument");
-
-    // we don't want to deal with possibly messed up file or directory
-    // permissions, so we ignore the original permissions
-    const externalAttr = isFile ? 0x81a40000 : 0x41ed0000;
-
-    buf.writeUInt32LE(0x0201_4b50, 0); // central header signature
-    buf.writeUInt16LE(10, 4); // version
-    buf.writeUInt16LE(10, 6); // min version
-    buf.writeUInt16LE(0, 8); // general purpose bit flag
-    buf.writeUInt16LE(compression ? ({ "deflate": 8 } as const)[compression] : 0, 10);
-    buf.writeUInt16LE(0, 12); // modified time
-    buf.writeUInt16LE(0, 14); // modified date
-    buf.writeUInt32LE(crc32 || 0, 16);
-    buf.writeUInt32LE(compressedSize || 0, 20);
-    buf.writeUInt32LE(uncompressedSize, 24);
-    buf.writeUInt16LE(filenameSize, 28);
-    buf.writeUInt16LE(0, 30); // extra field length
-    buf.writeUInt16LE(0, 32); // comment field length
-    buf.writeUInt16LE(0, 34); // disk number
-    buf.writeUInt16LE(0, 36); // internal
-    buf.writeUInt32LE(externalAttr, 38); // external
-    buf.writeUInt32LE(offset, 42); // offset where file starts
-    buf.write(path, 46, "utf-8");
-
-    return buf;
-}
-
-/**
- * @returns a buffer representing an Zip End-Of-Central-Directory block
- * @link https://en.wikipedia.org/wiki/ZIP_(file_format)#End_of_central_directory_record_(EOCD)
- */
-function eocd({ offset, cdSize, nRecords }: { offset: number; cdSize: number; nRecords: number }) {
-    const buf = Buffer.alloc(22);
-    buf.writeUint32LE(0x06054b50, 0); // eocd signature
-    buf.writeUInt16LE(0, 4); // disc number
-    buf.writeUint16LE(0, 6); // disc where central directory starts
-    buf.writeUint16LE(nRecords, 8); // records on this disc
-    buf.writeUInt16LE(nRecords, 10); // records total
-    buf.writeUInt32LE(cdSize, 12); // byte size of cd
-    buf.writeUInt32LE(offset, 16); // cd offset
-    buf.writeUint16LE(0, 20); // comment length
-
-    return buf;
-}
-
-/**
- * @returns a stream Transform, which reads a stream of ZipRecords and
- * writes a bytestream
- */
-export default function zip() {
-    /**
-     * This is called when the input stream of ZipSource items is finished.
-     * Will write central directory and end-of-central-direcotry blocks.
-     */
-    const final = () => {
-        // write central directory
-        let cdSize = 0;
-        for (const record of records) {
-            const head = centralHeader(record);
-            zipTransform.push(head);
-            cdSize += head.length;
-        }
-
-        // write end-of-central-directory
-        zipTransform.push(eocd({ offset, cdSize, nRecords: records.length }));
-        // signal stream end
-        zipTransform.push(null);
-    };
-
-    /**
-     * Write a directory entry to the archive
-     * @param path
-     */
-    const writeDir = async (path: string) => {
-        const record: ZipRecord = {
-            path: path + "/",
-            offset,
-            compression: undefined,
-            uncompressedSize: 0
-        };
-        const head = localHeader(record);
-        zipTransform.push(head);
-        records.push(record);
-        offset += head.length;
-    };
-
-    /**
-     * Write a file entry to the archive
-     * @param archivePath path of the file in archive
-     * @param fsPath path to file on filesystem
-     * @param size of the actual, uncompressed, file
-     */
-    const writeFile = async (archivePath: string, fsPath: string, size: number) => {
-        const record: ZipRecord = {
-            path: archivePath,
-            offset,
-            compression: "deflate",
-            uncompressedSize: size
-        };
-        const head = localHeader(record);
-        zipTransform.push(head);
-
-        const { crc32, compressedSize } = await deflateStream(createReadStream(fsPath), chunk => zipTransform.push(chunk));
-
-        record.crc32 = crc32;
-        record.compressedSize = compressedSize;
-        records.push(record);
-        offset += head.length + compressedSize;
-    };
-
-    /**
-     * Write archive record based on filesystem file or directory
-     * @param archivePath path of item in archive
-     * @param fsPath path to item on filesystem
-     */
-    const writeFromPath = async (archivePath: string, fsPath: string) => {
-        const fileStats = await stat(fsPath);
-        fileStats.isDirectory() ? await writeDir(archivePath) /**/ : await writeFile(archivePath, fsPath, fileStats.size) /**/;
-    };
-
-    /**
-     * Write archive record based on data in a buffer
-     * @param path
-     * @param data
-     */
-    const writeFromBuffer = async (path: string, data: Buffer) => {
-        const { deflated, crc32 } = await deflateBuffer(data);
-        const record: ZipRecord = {
-            path,
-            compression: "deflate",
-            crc32,
-            uncompressedSize: data.length,
-            compressedSize: deflated.length,
-            offset
-        };
-        const head = localHeader(record);
-        zipTransform.push(head);
-        zipTransform.push(deflated);
-        records.push(record);
-        offset += head.length + deflated.length;
-    };
-
-    /**
-     * Write an archive record
-     * @param source
-     */
-    const writeRecord = async (source: ZipSource) => {
-        if ("fsPath" in source) await writeFromPath(source.path, source.fsPath);
-        else if ("data" in source) await writeFromBuffer(source.path, source.data);
-        else throw new Error("Illegal argument " + typeof source + "  " + JSON.stringify(source));
-    };
-
-    /**
-     * The actual stream transform function
-     * @param source
-     * @param _ encoding, ignored
-     * @param cb
-     */
-    const transform: TransformOptions["transform"] = async (source: ZipSource, _, cb) => {
-        await writeRecord(source);
-        cb();
-    };
-
-    /** offset and records keep local state during processing */
-    let offset = 0;
-    const records: ZipRecord[] = [];
-
-    const zipTransform = new Transform({
-        readableObjectMode: false,
-        writableObjectMode: true,
-        transform,
-        final
-    });
-
-    return zipTransform;
-}

src/lib/usePrepareTemplate.ts

@@ -15,7 +15,7 @@ export function usePrepareTemplate(params: {
     htmlClassName: string | undefined;
     bodyClassName: string | undefined;
 }) {
-    const { doFetchDefaultThemeResources, stylesCommon, styles, url, scripts, htmlClassName, bodyClassName } = params;
+    const { doFetchDefaultThemeResources, stylesCommon = [], styles = [], url, scripts = [], htmlClassName, bodyClassName } = params;
 
     const [isReady, setReady] = useReducer(() => true, !doFetchDefaultThemeResources);
 
@@ -26,36 +26,49 @@ export function usePrepareTemplate(params: {
 
         let isUnmounted = false;
 
-        Promise.all(
+        const removeArray: (() => void)[] = [];
+
+        (async () => {
+            const prLoadedArray: Promise<void>[] = [];
+
             [
-                ...(stylesCommon ?? []).map(relativePath => pathJoin(url.resourcesCommonPath, relativePath)),
-                ...(styles ?? []).map(relativePath => pathJoin(url.resourcesPath, relativePath))
+                ...stylesCommon.map(relativePath => pathJoin(url.resourcesCommonPath, relativePath)),
+                ...styles.map(relativePath => pathJoin(url.resourcesPath, relativePath))
             ]
                 .reverse()
-                .map(href =>
-                    headInsert({
+                .forEach(href => {
+                    const { prLoaded, remove } = headInsert({
                         "type": "css",
-                        href,
-                        "position": "prepend"
-                    })
-                )
-        ).then(() => {
+                        "position": "prepend",
+                        href
+                    });
+
+                    removeArray.push(remove);
+
+                    prLoadedArray.push(prLoaded);
+                });
+
+            await Promise.all(prLoadedArray);
+
             if (isUnmounted) {
                 return;
             }
 
             setReady();
-        });
+        })();
 
-        (scripts ?? []).forEach(relativePath =>
-            headInsert({
+        scripts.forEach(relativePath => {
+            const { remove } = headInsert({
                 "type": "javascript",
                 "src": pathJoin(url.resourcesPath, relativePath)
-            })
-        );
+            });
+
+            removeArray.push(remove);
+        });
 
         return () => {
             isUnmounted = true;
+            removeArray.forEach(remove => remove());
         };
     }, []);
 

src/login/Fallback.tsx

@@ -26,6 +26,8 @@ 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"));
+const SelectAuthenticator = lazy(() => import("keycloakify/login/pages/SelectAuthenticator"));
+const SamlPostForm = lazy(() => import("keycloakify/login/pages/SamlPostForm"));
 
 export default function Fallback(props: PageProps<KcContext, I18n>) {
     const { kcContext, ...rest } = props;
@@ -78,6 +80,10 @@ export default function Fallback(props: PageProps<KcContext, I18n>) {
                         return <IdpReviewUserProfile kcContext={kcContext} {...rest} />;
                     case "update-email.ftl":
                         return <UpdateEmail kcContext={kcContext} {...rest} />;
+                    case "select-authenticator.ftl":
+                        return <SelectAuthenticator kcContext={kcContext} {...rest} />;
+                    case "saml-post-form.ftl":
+                        return <SamlPostForm kcContext={kcContext} {...rest} />;
                 }
                 assert<Equals<typeof kcContext, never>>(false);
             })()}

src/login/index.ts

@@ -4,6 +4,7 @@ export default Fallback;
 
 export { useDownloadTerms } from "keycloakify/login/lib/useDownloadTerms";
 export { getKcContext } from "keycloakify/login/kcContext/getKcContext";
+export { createGetKcContext } from "keycloakify/login/kcContext/createGetKcContext";
 export { createUseI18n } from "keycloakify/login/i18n/i18n";
 
 export type { PageProps } from "keycloakify/login/pages/PageProps";

src/login/kcContext/KcContext.ts

@@ -1,4 +1,4 @@
-import type { LoginThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
+import type { LoginThemePageId, ThemeType } from "keycloakify/bin/keycloakify/generateFtl";
 import { assert } from "tsafe/assert";
 import type { Equals } from "tsafe";
 import type { MessageKey } from "../i18n/i18n";
@@ -31,10 +31,15 @@ export type KcContext =
     | KcContext.LogoutConfirm
     | KcContext.UpdateUserProfile
     | KcContext.IdpReviewUserProfile
-    | KcContext.UpdateEmail;
+    | KcContext.UpdateEmail
+    | KcContext.SelectAuthenticator
+    | KcContext.SamlPostForm;
 
 export declare namespace KcContext {
     export type Common = {
+        keycloakifyVersion: string;
+        themeType: "login";
+        themeName: string;
         url: {
             loginAction: string;
             resourcesPath: string;
@@ -76,13 +81,48 @@ export declare namespace KcContext {
         };
         isAppInitiatedAction: boolean;
         messagesPerField: {
-            printIfExists: <T>(fieldName: string, x: T) => T | undefined;
+            /**
+             * Return text if message for given field exists. Useful eg. to add css styles for fields with message.
+             *
+             * @param fieldName to check for
+             * @param text to return
+             * @return text if message exists for given field, else undefined
+             */
+            printIfExists: <T extends string>(fieldName: string, text: T) => T | undefined;
+            /**
+             * Check if exists error message for given fields
+             *
+             * @param fields
+             * @return boolean
+             */
             existsError: (fieldName: string) => boolean;
+            /**
+             * Get message for given field.
+             *
+             * @param fieldName
+             * @return message text or empty string
+             */
             get: (fieldName: string) => string;
+            /**
+             * Check if message for given field exists
+             *
+             * @param field
+             * @return boolean
+             */
             exists: (fieldName: string) => boolean;
         };
     };
 
+    export type SamlPostForm = Common & {
+        pageId: "saml-post-form.ftl";
+        samlPost: {
+            url: string;
+            SAMLRequest?: string;
+            SAMLResponse?: string;
+            relayState?: string;
+        };
+    };
+
     export type Login = Common & {
         pageId: "login.ftl";
         url: {
@@ -331,7 +371,6 @@ export declare namespace KcContext {
             totpSecretEncoded: string;
             qrUrl: string;
             policy: {
-                supportedApplications: string[];
                 algorithm: "HmacSHA1" | "HmacSHA256" | "HmacSHA512";
                 digits: number;
                 lookAheadWindow: number;
@@ -345,6 +384,7 @@ export declare namespace KcContext {
                       initialCounter: number;
                   }
             );
+            supportedApplications: string[];
             totpSecretQrCode: string;
             manualUrl: string;
             totpSecret: string;
@@ -389,6 +429,39 @@ export declare namespace KcContext {
             value?: string;
         };
     };
+
+    export type SelectAuthenticator = Common & {
+        pageId: "select-authenticator.ftl";
+        auth: {
+            authenticationSelections: SelectAuthenticator.AuthenticationSelection[];
+        };
+    };
+
+    export namespace SelectAuthenticator {
+        export type AuthenticationSelection = {
+            authExecId: string;
+            displayName:
+                | "otp-display-name"
+                | "password-display-name"
+                | "auth-username-form-display-name"
+                | "auth-username-password-form-display-name"
+                | "webauthn-display-name"
+                | "webauthn-passwordless-display-name";
+            helpText:
+                | "otp-help-text"
+                | "password-help-text"
+                | "auth-username-form-help-text"
+                | "auth-username-password-form-help-text"
+                | "webauthn-help-text"
+                | "webauthn-passwordless-help-text";
+            iconCssClass?:
+                | "kcAuthenticatorDefaultClass"
+                | "kcAuthenticatorPasswordClass"
+                | "kcAuthenticatorOTPClass"
+                | "kcAuthenticatorWebAuthnClass"
+                | "kcAuthenticatorWebAuthnPasswordlessClass";
+        };
+    }
 }
 
 export type Attribute = {
@@ -508,4 +581,15 @@ export declare namespace Validators {
     };
 }
 
-assert<Equals<KcContext["pageId"], LoginThemePageId>>();
+{
+    type Got = KcContext["pageId"];
+    type Expected = LoginThemePageId;
+
+    type OnlyInGot = Exclude<Got, Expected>;
+    type OnlyInExpected = Exclude<Expected, Got>;
+
+    assert<Equals<OnlyInGot, never>>();
+    assert<Equals<OnlyInExpected, never>>();
+}
+
+assert<KcContext["themeType"] extends ThemeType ? true : false>();

src/login/kcContext/createGetKcContext.ts

@@ -0,0 +1,161 @@
+import type { KcContext, Attribute } from "./KcContext";
+import { kcContextMocks, kcContextCommonMock } from "./kcContextMocks";
+import type { DeepPartial } from "keycloakify/tools/DeepPartial";
+import { deepAssign } from "keycloakify/tools/deepAssign";
+import { id } from "tsafe/id";
+import { exclude } from "tsafe/exclude";
+import { assert } from "tsafe/assert";
+import type { ExtendKcContext } from "./getKcContextFromWindow";
+import { getKcContextFromWindow } from "./getKcContextFromWindow";
+import { pathJoin } from "keycloakify/bin/tools/pathJoin";
+import { pathBasename } from "keycloakify/tools/pathBasename";
+import { resourcesCommonDirPathRelativeToPublicDir } from "keycloakify/bin/mockTestingResourcesPath";
+import { symToStr } from "tsafe/symToStr";
+
+export function createGetKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
+    mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
+}) {
+    const { mockData } = params ?? {};
+
+    function getKcContext<PageId extends ExtendKcContext<KcContextExtension>["pageId"] | undefined = undefined>(params?: {
+        mockPageId?: PageId;
+        storyPartialKcContext?: DeepPartial<Extract<ExtendKcContext<KcContextExtension>, { pageId: PageId }>>;
+    }): {
+        kcContext: PageId extends undefined
+            ? ExtendKcContext<KcContextExtension> | undefined
+            : Extract<ExtendKcContext<KcContextExtension>, { pageId: PageId }>;
+    } {
+        const { mockPageId, storyPartialKcContext } = params ?? {};
+
+        const realKcContext = getKcContextFromWindow<KcContextExtension>();
+
+        if (mockPageId !== undefined && realKcContext === undefined) {
+            //TODO maybe trow if no mock fo custom page
+
+            console.log(`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`, "background: red; color: yellow; font-size: medium");
+
+            const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
+
+            const partialKcContextCustomMock = (() => {
+                const out: DeepPartial<ExtendKcContext<KcContextExtension>> = {};
+
+                const mockDataPick = mockData?.find(({ pageId }) => pageId === mockPageId);
+
+                if (mockDataPick !== undefined) {
+                    deepAssign({
+                        "target": out,
+                        "source": mockDataPick
+                    });
+                }
+
+                if (storyPartialKcContext !== undefined) {
+                    deepAssign({
+                        "target": out,
+                        "source": storyPartialKcContext
+                    });
+                }
+
+                return Object.keys(out).length === 0 ? undefined : out;
+            })();
+
+            if (kcContextDefaultMock === undefined && partialKcContextCustomMock === undefined) {
+                console.warn(
+                    [
+                        `WARNING: You declared the non build in page ${mockPageId} but you didn't `,
+                        `provide mock data needed to debug the page outside of Keycloak as you are trying to do now.`,
+                        `Please check the documentation of the getKcContext function`
+                    ].join("\n")
+                );
+            }
+
+            const kcContext: any = {};
+
+            deepAssign({
+                "target": kcContext,
+                "source": kcContextDefaultMock !== undefined ? kcContextDefaultMock : { "pageId": mockPageId, ...kcContextCommonMock }
+            });
+
+            if (partialKcContextCustomMock !== undefined) {
+                deepAssign({
+                    "target": kcContext,
+                    "source": partialKcContextCustomMock
+                });
+
+                if (
+                    partialKcContextCustomMock.pageId === "register-user-profile.ftl" ||
+                    partialKcContextCustomMock.pageId === "update-user-profile.ftl" ||
+                    partialKcContextCustomMock.pageId === "idp-review-user-profile.ftl"
+                ) {
+                    assert(
+                        kcContextDefaultMock?.pageId === "register-user-profile.ftl" ||
+                            kcContextDefaultMock?.pageId === "update-user-profile.ftl" ||
+                            kcContextDefaultMock?.pageId === "idp-review-user-profile.ftl"
+                    );
+
+                    const { attributes } = kcContextDefaultMock.profile;
+
+                    id<KcContext.RegisterUserProfile>(kcContext).profile.attributes = [];
+                    id<KcContext.RegisterUserProfile>(kcContext).profile.attributesByName = {};
+
+                    const partialAttributes = [
+                        ...((partialKcContextCustomMock as DeepPartial<KcContext.RegisterUserProfile>).profile?.attributes ?? [])
+                    ].filter(exclude(undefined));
+
+                    attributes.forEach(attribute => {
+                        const partialAttribute = partialAttributes.find(({ name }) => name === attribute.name);
+
+                        const augmentedAttribute: Attribute = {} as any;
+
+                        deepAssign({
+                            "target": augmentedAttribute,
+                            "source": attribute
+                        });
+
+                        if (partialAttribute !== undefined) {
+                            partialAttributes.splice(partialAttributes.indexOf(partialAttribute), 1);
+
+                            deepAssign({
+                                "target": augmentedAttribute,
+                                "source": partialAttribute
+                            });
+                        }
+
+                        id<KcContext.RegisterUserProfile>(kcContext).profile.attributes.push(augmentedAttribute);
+                        id<KcContext.RegisterUserProfile>(kcContext).profile.attributesByName[augmentedAttribute.name] = augmentedAttribute;
+                    });
+
+                    partialAttributes
+                        .map(partialAttribute => ({ "validators": {}, ...partialAttribute }))
+                        .forEach(partialAttribute => {
+                            const { name } = partialAttribute;
+
+                            assert(name !== undefined, "If you define a mock attribute it must have at least a name");
+
+                            id<KcContext.RegisterUserProfile>(kcContext).profile.attributes.push(partialAttribute as any);
+                            id<KcContext.RegisterUserProfile>(kcContext).profile.attributesByName[name] = partialAttribute as any;
+                        });
+                }
+            }
+
+            return { kcContext };
+        }
+
+        if (realKcContext === undefined) {
+            return { "kcContext": undefined as any };
+        }
+
+        if (realKcContext.themeType !== "login") {
+            return { "kcContext": undefined as any };
+        }
+
+        {
+            const { url } = realKcContext;
+
+            url.resourcesCommonPath = pathJoin(url.resourcesPath, pathBasename(resourcesCommonDirPathRelativeToPublicDir));
+        }
+
+        return { "kcContext": realKcContext as any };
+    }
+
+    return { getKcContext };
+}

src/login/kcContext/getKcContext.ts

@@ -1,135 +1,21 @@
-import type { KcContext, Attribute } from "./KcContext";
-import { kcContextMocks, kcContextCommonMock } from "./kcContextMocks";
 import type { DeepPartial } from "keycloakify/tools/DeepPartial";
-import { deepAssign } from "keycloakify/tools/deepAssign";
-import { id } from "tsafe/id";
-import { exclude } from "tsafe/exclude";
-import { assert } from "tsafe/assert";
 import type { ExtendKcContext } from "./getKcContextFromWindow";
-import { getKcContextFromWindow } from "./getKcContextFromWindow";
-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 { createGetKcContext } from "./createGetKcContext";
 
+/** NOTE: We now recommend using createGetKcContext instead of this function to make storybook integration easier
+ *  See: https://github.com/keycloakify/keycloakify-starter/blob/main/src/keycloak-theme/account/kcContext.ts
+ */
 export function getKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
     mockPageId?: ExtendKcContext<KcContextExtension>["pageId"];
     mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
 }): { kcContext: ExtendKcContext<KcContextExtension> | undefined } {
     const { mockPageId, mockData } = params ?? {};
 
-    const realKcContext = getKcContextFromWindow<KcContextExtension>();
+    const { getKcContext } = createGetKcContext<KcContextExtension>({
+        mockData
+    });
 
-    if (mockPageId !== undefined && realKcContext === undefined) {
-        //TODO maybe trow if no mock fo custom page
+    const { kcContext } = getKcContext({ mockPageId });
 
-        console.log(
-            [
-                `%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`,
-                `If assets are missing make sure you have built your Keycloak theme at least once.`
-            ].join(" "),
-            "background: red; color: yellow; font-size: medium"
-        );
-
-        const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
-
-        const partialKcContextCustomMock = mockData?.find(({ pageId }) => pageId === mockPageId);
-
-        if (kcContextDefaultMock === undefined && partialKcContextCustomMock === undefined) {
-            console.warn(
-                [
-                    `WARNING: You declared the non build in page ${mockPageId} but you didn't `,
-                    `provide mock data needed to debug the page outside of Keycloak as you are trying to do now.`,
-                    `Please check the documentation of the getKcContext function`
-                ].join("\n")
-            );
-        }
-
-        const kcContext: any = {};
-
-        deepAssign({
-            "target": kcContext,
-            "source": kcContextDefaultMock !== undefined ? kcContextDefaultMock : { "pageId": mockPageId, ...kcContextCommonMock }
-        });
-
-        if (partialKcContextCustomMock !== undefined) {
-            deepAssign({
-                "target": kcContext,
-                "source": partialKcContextCustomMock
-            });
-
-            if (
-                partialKcContextCustomMock.pageId === "register-user-profile.ftl" ||
-                partialKcContextCustomMock.pageId === "update-user-profile.ftl" ||
-                partialKcContextCustomMock.pageId === "idp-review-user-profile.ftl"
-            ) {
-                assert(
-                    kcContextDefaultMock?.pageId === "register-user-profile.ftl" ||
-                        kcContextDefaultMock?.pageId === "update-user-profile.ftl" ||
-                        kcContextDefaultMock?.pageId === "idp-review-user-profile.ftl"
-                );
-
-                const { attributes } = kcContextDefaultMock.profile;
-
-                id<KcContext.RegisterUserProfile>(kcContext).profile.attributes = [];
-                id<KcContext.RegisterUserProfile>(kcContext).profile.attributesByName = {};
-
-                const partialAttributes = [
-                    ...((partialKcContextCustomMock as DeepPartial<KcContext.RegisterUserProfile>).profile?.attributes ?? [])
-                ].filter(exclude(undefined));
-
-                attributes.forEach(attribute => {
-                    const partialAttribute = partialAttributes.find(({ name }) => name === attribute.name);
-
-                    const augmentedAttribute: Attribute = {} as any;
-
-                    deepAssign({
-                        "target": augmentedAttribute,
-                        "source": attribute
-                    });
-
-                    if (partialAttribute !== undefined) {
-                        partialAttributes.splice(partialAttributes.indexOf(partialAttribute), 1);
-
-                        deepAssign({
-                            "target": augmentedAttribute,
-                            "source": partialAttribute
-                        });
-                    }
-
-                    id<KcContext.RegisterUserProfile>(kcContext).profile.attributes.push(augmentedAttribute);
-                    id<KcContext.RegisterUserProfile>(kcContext).profile.attributesByName[augmentedAttribute.name] = augmentedAttribute;
-                });
-
-                partialAttributes
-                    .map(partialAttribute => ({ "validators": {}, ...partialAttribute }))
-                    .forEach(partialAttribute => {
-                        const { name } = partialAttribute;
-
-                        assert(name !== undefined, "If you define a mock attribute it must have at least a name");
-
-                        id<KcContext.RegisterUserProfile>(kcContext).profile.attributes.push(partialAttribute as any);
-                        id<KcContext.RegisterUserProfile>(kcContext).profile.attributesByName[name] = partialAttribute as any;
-                    });
-            }
-        }
-
-        return { kcContext };
-    }
-
-    if (realKcContext === undefined) {
-        return { "kcContext": undefined };
-    }
-
-    if (!("login" in realKcContext)) {
-        return { "kcContext": undefined };
-    }
-
-    {
-        const { url } = realKcContext;
-
-        url.resourcesCommonPath = pathJoin(url.resourcesPath, pathBasename(mockTestingResourcesCommonPath));
-    }
-
-    return { "kcContext": realKcContext };
+    return { kcContext };
 }

src/login/kcContext/kcContextMocks.ts

@@ -1,8 +1,10 @@
 import "minimal-polyfills/Object.fromEntries";
 import type { KcContext, Attribute } from "./KcContext";
-import { mockTestingResourcesCommonPath, mockTestingResourcesPath } from "keycloakify/bin/mockTestingResourcesPath";
+import { resourcesCommonDirPathRelativeToPublicDir, resourcesDirPathRelativeToPublicDir } from "keycloakify/bin/mockTestingResourcesPath";
 import { pathJoin } from "keycloakify/bin/tools/pathJoin";
 import { id } from "tsafe/id";
+import { assert, type Equals } from "tsafe/assert";
+import type { LoginThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
 
 const PUBLIC_URL = process.env["PUBLIC_URL"] ?? "/";
 
@@ -101,10 +103,13 @@ const attributes: Attribute[] = [
 const attributesByName = Object.fromEntries(attributes.map(attribute => [attribute.name, attribute])) as any;
 
 export const kcContextCommonMock: KcContext.Common = {
+    "keycloakifyVersion": "0.0.0",
+    "themeType": "login",
+    "themeName": "my-theme-name",
     "url": {
         "loginAction": "#",
-        "resourcesPath": pathJoin(PUBLIC_URL, mockTestingResourcesPath),
-        "resourcesCommonPath": pathJoin(PUBLIC_URL, mockTestingResourcesCommonPath),
+        "resourcesPath": pathJoin(PUBLIC_URL, resourcesDirPathRelativeToPublicDir),
+        "resourcesCommonPath": pathJoin(PUBLIC_URL, resourcesCommonDirPathRelativeToPublicDir),
         "loginRestartFlowUrl": "/auth/realms/myrealm/login-actions/restart?client_id=account&tab_id=HoAx28ja4xg",
         "loginUrl": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg"
     },
@@ -242,7 +247,7 @@ const loginUrl = {
     "registrationUrl": "/auth/realms/myrealm/login-actions/registration?client_id=account&tab_id=HoAx28ja4xg"
 };
 
-export const kcContextMocks: KcContext[] = [
+export const kcContextMocks = [
     id<KcContext.Login>({
         ...kcContextCommonMock,
         "pageId": "login.ftl",
@@ -452,8 +457,8 @@ export const kcContextMocks: KcContext[] = [
             manualUrl: "#",
             totpSecret: "G4nsI8lQagRMUchH8jEG",
             otpCredentials: [],
+            supportedApplications: ["FreeOTP", "Google Authenticator"],
             policy: {
-                supportedApplications: ["FreeOTP", "Google Authenticator"],
                 algorithm: "HmacSHA1",
                 digits: 6,
                 lookAheadWindow: 1,
@@ -498,5 +503,47 @@ export const kcContextMocks: KcContext[] = [
         "email": {
             value: "email@example.com"
         }
+    }),
+    id<KcContext.SelectAuthenticator>({
+        ...kcContextCommonMock,
+        pageId: "select-authenticator.ftl",
+        auth: {
+            authenticationSelections: [
+                {
+                    authExecId: "f607f83c-537e-42b7-99d7-c52d459afe84",
+                    displayName: "otp-display-name",
+                    helpText: "otp-help-text",
+                    iconCssClass: "kcAuthenticatorOTPClass"
+                },
+                {
+                    authExecId: "5ed881b1-84cd-4e9b-b4d9-f329ea61a58c",
+                    displayName: "webauthn-display-name",
+                    helpText: "webauthn-help-text",
+                    iconCssClass: "kcAuthenticatorWebAuthnClass"
+                }
+            ]
+        }
+    }),
+    id<KcContext.SamlPostForm>({
+        ...kcContextCommonMock,
+        pageId: "saml-post-form.ftl",
+        "samlPost": {
+            "url": ""
+        }
+    }),
+    id<KcContext.LoginPageExpired>({
+        ...kcContextCommonMock,
+        pageId: "login-page-expired.ftl"
     })
 ];
+
+{
+    type Got = (typeof kcContextMocks)[number]["pageId"];
+    type Expected = LoginThemePageId;
+
+    type OnlyInGot = Exclude<Got, Expected>;
+    type OnlyInExpected = Exclude<Expected, Got>;
+
+    assert<Equals<OnlyInGot, never>>();
+    assert<Equals<OnlyInExpected, never>>();
+}

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;
     };

src/login/pages/LoginConfigTotp.tsx

@@ -3,6 +3,7 @@ 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";
+import { MessageKey } from "keycloakify/login/i18n/i18n";
 
 export default function LoginConfigTotp(props: PageProps<Extract<KcContext, { pageId: "login-config-totp.ftl" }>, I18n>) {
     const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
@@ -16,7 +17,7 @@ export default function LoginConfigTotp(props: PageProps<Extract<KcContext, { pa
 
     const { msg, msgStr } = i18n;
 
-    const algToKeyUriAlg: Record<KcContext.LoginConfigTotp["totp"]["policy"]["algorithm"], string> = {
+    const algToKeyUriAlg: Record<(typeof kcContext)["totp"]["policy"]["algorithm"], string> = {
         "HmacSHA1": "SHA1",
         "HmacSHA256": "SHA256",
         "HmacSHA512": "SHA512"
@@ -30,8 +31,8 @@ export default function LoginConfigTotp(props: PageProps<Extract<KcContext, { pa
                         <p>{msg("loginTotpStep1")}</p>
 
                         <ul id="kc-totp-supported-apps">
-                            {totp.policy.supportedApplications.map(app => (
-                                <li>{app}</li>
+                            {totp.supportedApplications.map(app => (
+                                <li>{msgStr(app as MessageKey, app)}</li>
                             ))}
                         </ul>
                     </li>
@@ -169,7 +170,7 @@ export default function LoginConfigTotp(props: PageProps<Extract<KcContext, { pa
                                 name="cancel-aia"
                                 value="true"
                             >
-                                ${msg("doCancel")}
+                                {msg("doCancel")}
                             </button>
                         </>
                     ) : (

src/login/pages/LoginOtp.tsx

@@ -22,17 +22,24 @@ export default function LoginOtp(props: PageProps<Extract<KcContext, { pageId: "
     useEffect(() => {
         let isCleanedUp = false;
 
-        headInsert({
+        const { prLoaded, remove } = headInsert({
             "type": "javascript",
             "src": pathJoin(kcContext.url.resourcesCommonPath, "node_modules/jquery/dist/jquery.min.js")
-        }).then(() => {
-            if (isCleanedUp) return;
+        });
+
+        (async () => {
+            await prLoaded;
+
+            if (isCleanedUp) {
+                return;
+            }
 
             evaluateInlineScript();
-        });
+        })();
 
         return () => {
             isCleanedUp = true;
+            remove();
         };
     }, []);
 

src/login/pages/LoginVerifyEmail.tsx

@@ -11,7 +11,7 @@ export default function LoginVerifyEmail(props: PageProps<Extract<KcContext, { p
 
     return (
         <Template {...{ kcContext, i18n, doUseDefaultCss, classes }} displayMessage={false} headerNode={msg("emailVerifyTitle")}>
-            <p className="instruction">{msg("emailVerifyInstruction1", user?.email)}</p>
+            <p className="instruction">{msg("emailVerifyInstruction1", user?.email ?? "")}</p>
             <p className="instruction">
                 {msg("emailVerifyInstruction2")}
                 <br />

src/login/pages/RegisterUserProfile.tsx

@@ -14,11 +14,13 @@ export default function RegisterUserProfile(props: PageProps<Extract<KcContext,
         classes
     });
 
-    const { url, messagesPerField, recaptchaRequired, recaptchaSiteKey } = kcContext;
+    const { url, messagesPerField, recaptchaRequired, recaptchaSiteKey, realm } = kcContext;
+
+    realm.registrationEmailAsUsername;
 
     const { msg, msgStr } = i18n;
 
-    const [isFomSubmittable, setIsFomSubmittable] = useState(false);
+    const [isFormSubmittable, setIsFormSubmittable] = useState(false);
 
     return (
         <Template
@@ -30,7 +32,7 @@ export default function RegisterUserProfile(props: PageProps<Extract<KcContext,
             <form id="kc-register-form" className={getClassName("kcFormClass")} action={url.registrationAction} method="post">
                 <UserProfileFormFields
                     kcContext={kcContext}
-                    onIsFormSubmittableValueChange={setIsFomSubmittable}
+                    onIsFormSubmittableValueChange={setIsFormSubmittable}
                     i18n={i18n}
                     getClassName={getClassName}
                 />
@@ -60,7 +62,7 @@ export default function RegisterUserProfile(props: PageProps<Extract<KcContext,
                             )}
                             type="submit"
                             value={msgStr("doRegister")}
-                            disabled={!isFomSubmittable}
+                            disabled={!isFormSubmittable}
                         />
                     </div>
                 </div>

src/login/pages/SamlPostForm.tsx

@@ -0,0 +1,42 @@
+import { useEffect, useState } from "react";
+import type { PageProps } from "keycloakify/login/pages/PageProps";
+import type { KcContext } from "../kcContext";
+import type { I18n } from "../i18n";
+
+export default function SamlPostForm(props: PageProps<Extract<KcContext, { pageId: "saml-post-form.ftl" }>, I18n>) {
+    const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
+
+    const { msgStr, msg } = i18n;
+
+    const { samlPost } = kcContext;
+
+    const [htmlFormElement, setHtmlFormElement] = useState<HTMLFormElement | null>(null);
+
+    useEffect(() => {
+        if (htmlFormElement === null) {
+            return;
+        }
+
+        // Storybook
+        if (samlPost.url === "") {
+            alert("In a real Keycloak the user would be redirected immediately");
+            return;
+        }
+
+        htmlFormElement.submit();
+    }, [htmlFormElement]);
+    return (
+        <Template {...{ kcContext, i18n, doUseDefaultCss, classes }} displayMessage={false} headerNode={msg("saml.post-form.title")}>
+            <p>{msg("saml.post-form.message")}</p>
+            <form name="saml-post-binding" method="post" action={samlPost.url} ref={setHtmlFormElement}>
+                {samlPost.SAMLRequest && <input type="hidden" name="SAMLRequest" value={samlPost.SAMLRequest} />}
+                {samlPost.SAMLResponse && <input type="hidden" name="SAMLResponse" value={samlPost.SAMLResponse} />}
+                {samlPost.relayState && <input type="hidden" name="RelayState" value={samlPost.relayState} />}
+                <noscript>
+                    <p>{msg("saml.post-form.js-disabled")}</p>
+                    <input type="submit" value={msgStr("doContinue")} />
+                </noscript>
+            </form>
+        </Template>
+    );
+}

src/login/pages/SelectAuthenticator.tsx

@@ -0,0 +1,73 @@
+import type { PageProps } from "keycloakify/login/pages/PageProps";
+import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
+import type { KcContext } from "keycloakify/login/kcContext";
+import type { I18n } from "keycloakify/login/i18n";
+import { MouseEvent, useRef } from "react";
+import { useConstCallback } from "keycloakify/tools/useConstCallback";
+
+export default function SelectAuthenticator(props: PageProps<Extract<KcContext, { pageId: "select-authenticator.ftl" }>, I18n>) {
+    const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
+    const { url, auth } = kcContext;
+
+    const { getClassName } = useGetClassName({ doUseDefaultCss, classes });
+    const { msg } = i18n;
+
+    const selectCredentialsForm = useRef<HTMLFormElement>(null);
+    const authExecIdInput = useRef<HTMLInputElement>(null);
+
+    const submitForm = useConstCallback(() => {
+        selectCredentialsForm.current?.submit();
+    });
+
+    const onSelectedAuthenticator = useConstCallback((event: MouseEvent<HTMLDivElement>) => {
+        const divElement = event.currentTarget;
+        const authExecId = divElement.dataset.authExecId;
+
+        if (!authExecIdInput.current || !authExecId) {
+            return;
+        }
+
+        authExecIdInput.current.value = authExecId;
+        submitForm();
+    });
+
+    return (
+        <Template {...{ kcContext, i18n, doUseDefaultCss, classes }} headerNode={msg("loginChooseAuthenticator")}>
+            <form
+                id="kc-select-credential-form"
+                className={getClassName("kcFormClass")}
+                ref={selectCredentialsForm}
+                action={url.loginAction}
+                method="post"
+            >
+                <div className={getClassName("kcSelectAuthListClass")}>
+                    {auth.authenticationSelections.map((authenticationSelection, index) => (
+                        <div key={index} className={getClassName("kcSelectAuthListItemClass")}>
+                            <div
+                                style={{ cursor: "pointer" }}
+                                onClick={onSelectedAuthenticator}
+                                data-auth-exec-id={authenticationSelection.authExecId}
+                                className={getClassName("kcSelectAuthListItemInfoClass")}
+                            >
+                                <div className={getClassName("kcSelectAuthListItemLeftClass")}>
+                                    <span className={getClassName(authenticationSelection.iconCssClass ?? "kcAuthenticatorDefaultClass")}></span>
+                                </div>
+                                <div className={getClassName("kcSelectAuthListItemBodyClass")}>
+                                    <div className={getClassName("kcSelectAuthListItemDescriptionClass")}>
+                                        <div className={getClassName("kcSelectAuthListItemHeadingClass")}>
+                                            {msg(authenticationSelection.displayName)}
+                                        </div>
+                                        <div className={getClassName("kcSelectAuthListItemHelpTextClass")}>
+                                            {msg(authenticationSelection.helpText)}
+                                        </div>
+                                    </div>
+                                </div>
+                            </div>
+                        </div>
+                    ))}
+                    <input type="hidden" id="authexec-hidden-input" name="authenticationExecution" ref={authExecIdInput} />
+                </div>
+            </form>
+        </Template>
+    );
+}

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(

src/login/pages/WebauthnAuthenticate.tsx

@@ -7,6 +7,9 @@ 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";
+import { assert } from "tsafe/assert";
+import { is } from "tsafe/is";
+import { typeGuard } from "tsafe/typeGuard";
 
 export default function WebauthnAuthenticate(props: PageProps<Extract<KcContext, { pageId: "webauthn-authenticate.ftl" }>, I18n>) {
     const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
@@ -21,10 +24,24 @@ export default function WebauthnAuthenticate(props: PageProps<Extract<KcContext,
     const createTimeout = Number(kcContext.createTimeout);
     const isUserIdentified = kcContext.isUserIdentified == "true";
 
+    const formElementRef = useRef<HTMLFormElement>(null);
+
     const webAuthnAuthenticate = useConstCallback(async () => {
         if (!isUserIdentified) {
             return;
         }
+
+        const submitForm = async (): Promise<void> => {
+            const formElement = formElementRef.current;
+
+            if (formElement === null) {
+                await new Promise(resolve => setTimeout(resolve, 100));
+                return submitForm();
+            }
+
+            formElement.submit();
+        };
+
         const allowCredentials = authenticators.authenticators.map(
             authenticator =>
                 ({
@@ -57,30 +74,36 @@ export default function WebauthnAuthenticate(props: PageProps<Extract<KcContext,
         }
 
         try {
-            const resultRaw = await navigator.credentials.get({ publicKey });
-            if (!resultRaw || resultRaw.type != "public-key") return;
-            const result = resultRaw as PublicKeyCredential;
-            if (!("authenticatorData" in result.response)) return;
-            const response = result.response as AuthenticatorAssertionResponse;
+            const result = await navigator.credentials.get({ publicKey });
+            if (!result || result.type != "public-key") {
+                return;
+            }
+            assert(is<PublicKeyCredential>(result));
+            if (!("authenticatorData" in result.response)) {
+                return;
+            }
+            const response = result.response;
+
             const clientDataJSON = response.clientDataJSON;
+
+            assert(
+                typeGuard<AuthenticatorAssertionResponse>(response, "signature" in response && response.authenticatorData instanceof ArrayBuffer),
+                "response not an AuthenticatorAssertionResponse"
+            );
+
             const authenticatorData = response.authenticatorData;
             const signature = response.signature;
 
-            setClientDataJSON(base64url.stringify(new Uint8Array(clientDataJSON), { pad: false }));
-            setAuthenticatorData(base64url.stringify(new Uint8Array(authenticatorData), { pad: false }));
-            setSignature(base64url.stringify(new Uint8Array(signature), { pad: false }));
+            setClientDataJSON(base64url.stringify(new Uint8Array(clientDataJSON), { "pad": false }));
+            setAuthenticatorData(base64url.stringify(new Uint8Array(authenticatorData), { "pad": false }));
+            setSignature(base64url.stringify(new Uint8Array(signature), { "pad": false }));
             setCredentialId(result.id);
-            setUserHandle(base64url.stringify(new Uint8Array(response.userHandle!), { pad: false }));
-            submitForm();
+            setUserHandle(base64url.stringify(new Uint8Array(response.userHandle!), { "pad": false }));
         } catch (err) {
             setError(String(err));
-            submitForm();
         }
-    });
 
-    const webAuthForm = useRef<HTMLFormElement>(null);
-    const submitForm = useConstCallback(() => {
-        webAuthForm.current!.submit();
+        submitForm();
     });
 
     const [clientDataJSON, setClientDataJSON] = useState("");
@@ -93,7 +116,7 @@ export default function WebauthnAuthenticate(props: PageProps<Extract<KcContext,
     return (
         <Template {...{ kcContext, i18n, doUseDefaultCss, classes }} headerNode={msg("webauthn-login-title")}>
             <div id="kc-form-webauthn" className={getClassName("kcFormClass")}>
-                <form id="webauth" action={url.loginAction} ref={webAuthForm} method="post">
+                <form id="webauth" action={url.loginAction} ref={formElementRef} method="post">
                     <input type="hidden" id="clientDataJSON" name="clientDataJSON" value={clientDataJSON} />
                     <input type="hidden" id="authenticatorData" name="authenticatorData" value={authenticatorData} />
                     <input type="hidden" id="signature" name="signature" value={signature} />

src/tools/headInsert.ts

@@ -12,7 +12,7 @@ export function headInsert(
               type: "javascript";
               src: string;
           }
-) {
+): { remove: () => void; prLoaded: Promise<void> } {
     const htmlElement = document.createElement(
         (() => {
             switch (params.type) {
@@ -66,5 +66,8 @@ export function headInsert(
         })()
     ](htmlElement);
 
-    return dLoaded.pr;
+    return {
+        "prLoaded": dLoaded.pr,
+        "remove": () => htmlElement.remove()
+    };
 }

stories/account/KcApp.tsx

@@ -0,0 +1,27 @@
+import React, { lazy, Suspense } from "react";
+import Fallback from "../../dist/account";
+import type { KcContext } from "./kcContext";
+import { useI18n } from "./i18n";
+
+const DefaultTemplate = lazy(() => import("../../dist/account/Template"));
+
+export default function KcApp(props: { kcContext: KcContext }) {
+    const { kcContext } = props;
+
+    const i18n = useI18n({ kcContext });
+
+    if (i18n === null) {
+        return null;
+    }
+
+    return (
+        <Suspense>
+            {(() => {
+                switch (kcContext.pageId) {
+                    default:
+                        return <Fallback {...{ kcContext, i18n }} Template={DefaultTemplate} doUseDefaultCss={true} />;
+                }
+            })()}
+        </Suspense>
+    );
+}

stories/account/createPageStory.tsx

@@ -0,0 +1,19 @@
+import React from "react";
+import { getKcContext, type KcContext } from "./kcContext";
+import KcApp from "./KcApp";
+import type { DeepPartial } from "../../dist/tools/DeepPartial";
+
+export function createPageStory<PageId extends KcContext["pageId"]>(params: { pageId: PageId }) {
+    const { pageId } = params;
+
+    function PageStory(params: { kcContext?: DeepPartial<Extract<KcContext, { pageId: PageId }>> }) {
+        const { kcContext } = getKcContext({
+            mockPageId: pageId,
+            storyPartialKcContext: params.kcContext
+        });
+
+        return <KcApp kcContext={kcContext} />;
+    }
+
+    return { PageStory };
+}

stories/account/i18n.ts

@@ -0,0 +1,5 @@
+import { createUseI18n } from "../../dist/account";
+
+export const { useI18n } = createUseI18n({});
+
+export type I18n = NonNullable<ReturnType<typeof useI18n>>;

stories/account/kcContext.ts

@@ -0,0 +1,7 @@
+import { createGetKcContext } from "../../dist/account";
+
+export const { getKcContext } = createGetKcContext();
+
+const { kcContext } = getKcContext();
+
+export type KcContext = NonNullable<typeof kcContext>;

stories/account/pages/Account.stories.tsx

@@ -0,0 +1,24 @@
+import React from "react";
+import type { ComponentMeta } from "@storybook/react";
+import { createPageStory } from "../createPageStory";
+
+const pageId = "account.ftl";
+
+const { PageStory } = createPageStory({ pageId });
+
+const meta: ComponentMeta<any> = {
+    title: `account/${pageId}`,
+    component: PageStory,
+    parameters: {
+        viewMode: "story",
+        previewTabs: {
+            "storybook/docs/panel": {
+                hidden: true
+            }
+        }
+    }
+};
+
+export default meta;
+
+export const Default = () => <PageStory />;

stories/account/pages/Pasword.stories.tsx

@@ -0,0 +1,31 @@
+import React from "react";
+import type { ComponentMeta } from "@storybook/react";
+import { createPageStory } from "../createPageStory";
+
+const pageId = "password.ftl";
+
+const { PageStory } = createPageStory({ pageId });
+
+const meta: ComponentMeta<any> = {
+    title: `account/${pageId}`,
+    component: PageStory,
+    parameters: {
+        viewMode: "story",
+        previewTabs: {
+            "storybook/docs/panel": {
+                hidden: true
+            }
+        }
+    }
+};
+
+export default meta;
+
+export const Default = () => <PageStory />;
+export const WithNoMessage = () => (
+    <PageStory
+        kcContext={{
+            message: undefined
+        }}
+    />
+);

stories/global.d.ts

@@ -0,0 +1,9 @@
+declare module "*.png" {
+    const _default: string;
+    export default _default;
+}
+
+declare module "*.md" {
+    const _default: string;
+    export default _default;
+}

stories/intro/KeycloakifyRotatingLogo.tsx

@@ -0,0 +1,61 @@
+import React from "react";
+import { memo, useState } from "react";
+import { useConstCallback } from "powerhooks";
+import { keyframes } from "tss-react";
+import keycloakifyLogoHeroMovingPngUrl from "./keycloakify-logo-hero-moving.png";
+import keycloakifyLogoHeroStillPngUrl from "./keycloakify-logo-hero-still.png";
+import { makeStyles } from "./tss";
+
+export type Props = {
+    style?: React.CSSProperties;
+    id?: string;
+    onLoad?: () => void;
+};
+
+export const KeycloakifyRotatingLogo = memo((props: Props) => {
+    const { id, style, onLoad: onLoadProp } = props;
+
+    const [isImageLoaded, setIsImageLoaded] = useState(false);
+
+    const onLoad = useConstCallback(() => {
+        setIsImageLoaded(true);
+        onLoadProp?.();
+    });
+
+    const { classes } = useStyles({
+        isImageLoaded
+    });
+    return (
+        <div id={id} className={classes.root} style={style}>
+            <img className={classes.rotatingImg} onLoad={onLoad} src={keycloakifyLogoHeroMovingPngUrl} alt={"Rotating react logo"} />
+            <img className={classes.stillImg} src={keycloakifyLogoHeroStillPngUrl} alt={"keyhole"} />
+        </div>
+    );
+});
+
+const useStyles = makeStyles<{ isImageLoaded: boolean }>({
+    "name": { KeycloakifyRotatingLogo }
+})((_theme, { isImageLoaded }) => ({
+    "root": {
+        "position": "relative"
+    },
+    "rotatingImg": {
+        "animation": `${keyframes({
+            "from": {
+                "transform": "rotate(0deg)"
+            },
+            "to": {
+                "transform": "rotate(360deg)"
+            }
+        })} infinite 20s linear`,
+        "width": isImageLoaded ? "100%" : undefined,
+        "height": isImageLoaded ? "auto" : undefined
+    },
+    "stillImg": {
+        "position": "absolute",
+        "top": "0",
+        "left": "0",
+        "width": isImageLoaded ? "100%" : undefined,
+        "height": isImageLoaded ? "auto" : undefined
+    }
+}));

stories/intro/intro.stories.mdx

@@ -0,0 +1,35 @@
+import { Meta } from "@storybook/addon-docs";
+import { KeycloakifyRotatingLogo } from "./KeycloakifyRotatingLogo";
+
+<Meta
+    title="Introduction" 
+    parameters={{
+        "viewMode": "docs",
+        "previewTabs": {
+            "canvas": { "hidden": true },
+            "zoom": { "hidden": true },
+            "storybook/background": { "hidden": true },
+            "storybook/viewport": { "hidden": true },
+        },
+    }}
+/>
+
+<div style={{ "margin": "0 auto", "maxWidth": "700px", "textAlign": "center" }}>
+<div style={{ "display": "flex", "justifyContent": "center" }}>
+<KeycloakifyRotatingLogo style={{ "width": 400 }} />
+</div>
+<h1><a href="#">Keycloakify </a> Storybook</h1>
+
+<p>
+This website showcases all the Keycloak user-facing pages that can be customized using Keycloakify.
+The storybook serves as a comprehensive reference to help you determine which pages you would like to personalize.
+Keep in mind that customizing the <a href="https://github.com/keycloakify/keycloakify-starter/blob/main/src/keycloak-theme/login/Template.tsx"><code>Template</code></a> component alone will already cover 90% of your customization needs.
+</p>
+
+<p>
+If you discover that a page you wish to customize is not currently supported by Keycloakify, don't worry. 
+Simply refer to <a href="https://docs.keycloakify.dev/limitations#i-have-established-that-a-page-that-i-need-isnt-supported-out-of-the-box-by-keycloakify-now-what">this documentation page</a> for further assistance.
+</p>
+
+
+</div>

stories/intro/tss.ts

@@ -0,0 +1,5 @@
+import { createMakeAndWithStyles } from "tss-react";
+
+export const { makeStyles, useStyles } = createMakeAndWithStyles({
+    "useTheme": () => ({})
+});

stories/login/KcApp.tsx

@@ -0,0 +1,50 @@
+import React, { lazy, Suspense } from "react";
+import Fallback from "../../dist/login";
+import type { KcContext } from "./kcContext";
+import { useI18n } from "./i18n";
+import { useDownloadTerms } from "../../dist/login/lib/useDownloadTerms";
+import tos_en_url from "./tos_en.md";
+import tos_fr_url from "./tos_fr.md";
+
+const DefaultTemplate = lazy(() => import("../../dist/login/Template"));
+
+export default function KcApp(props: { kcContext: KcContext }) {
+    const { kcContext } = props;
+
+    const i18n = useI18n({ kcContext });
+
+    useDownloadTerms({
+        "kcContext": kcContext as any,
+        "downloadTermMarkdown": async ({ currentLanguageTag }) => {
+            const resource = (() => {
+                switch (currentLanguageTag) {
+                    case "fr":
+                        return tos_fr_url;
+                    default:
+                        return tos_en_url;
+                }
+            })();
+
+            // webpack5 (used via storybook) loads markdown as string, not url
+            if (resource.includes("\n")) return resource;
+
+            const response = await fetch(resource);
+            return response.text();
+        }
+    });
+
+    if (i18n === null) {
+        return null;
+    }
+
+    return (
+        <Suspense>
+            {(() => {
+                switch (kcContext.pageId) {
+                    default:
+                        return <Fallback {...{ kcContext, i18n }} Template={DefaultTemplate} doUseDefaultCss={true} />;
+                }
+            })()}
+        </Suspense>
+    );
+}