Update changelog v0.3.23

CHANGELOG.md

@@ -1,3 +1,98 @@
+### **0.3.23** (2021-04-08)  
+  
+- Allow to lazily load therms    
+  
+### **0.3.22** (2021-04-08)  
+  
+- update powerhooks  
+- Support terms and condition  
+- Fix info.ftl  
+- For useKcMessage we prefer returning callbacks with a changing references    
+  
+### **0.3.21** (2021-04-04)  
+  
+- Update powerhooks    
+  
+### **0.3.20** (2021-04-01)  
+  
+- Always catch freemarker errors    
+  
+### **0.3.19** (2021-04-01)  
+  
+- Fix previous release    
+  
+### **0.3.18** (2021-04-01)  
+  
+- Fix error.ftt, Adopt best effort strategy to convert ftl values into JS    
+  
+### **0.3.17** (2021-03-29)  
+  
+- Use push instead of replace in keycloak-js adapter to enable going back    
+  
+### **0.3.15** (2021-03-28)  
+  
+- Remove all reference to --external-assets, broken feature    
+  
+### **0.3.14** (2021-03-28)  
+  
+- Fix standalone mode: imports from js    
+  
+### **0.3.13** (2021-03-26)  
+  
+  
+  
+### **0.3.12** (2021-03-26)  
+  
+- Fix mocksContext    
+  
+### **0.3.11** (2021-03-26)  
+  
+- Fix previous build, improve README    
+  
+### **0.3.10** (2021-03-26)  
+  
+- Handle <style> tag, improve documentation    
+  
+### **0.3.9** (2021-03-25)  
+  
+- Update readme  
+- Document  --external-assets  
+- Update README.md  
+- Update README.md  
+- Update README.md    
+  
+### **0.3.8** (2021-03-22)  
+  
+- Make standalone mode the default    
+  
+### **0.3.7** (2021-03-22)  
+  
+- (test) external asset mode by default    
+  
+### **0.3.6** (2021-03-22)  
+  
+- Fix previous release    
+  
+### **0.3.5** (2021-03-22)  
+  
+- support homepage with urlPath    
+  
+### **0.3.4** (2021-03-22)  
+  
+- Bugfix: Import assets from CSS    
+  
+### **0.3.3** (2021-03-22)  
+  
+- Fix submit not receving correct text    
+  
+### **0.3.2** (2021-03-21)  
+  
+- Fix broken previous release    
+  
+### **0.3.1** (2021-03-21)  
+  
+- kcHeaderClass can be updated after initial mount    
+  
 ## **0.3.0** (2021-03-20)  
   
 - Bump version  

README.md

@@ -20,8 +20,10 @@
 
 The problem: 
 
-![keycloak_before](https://user-images.githubusercontent.com/6702424/108838381-dbbbcf80-75d3-11eb-8ae8-db41563ef9db.gif)
-
+<p align="center">
+    <i>Without keycloakify:</i><br>
+    <img src="https://user-images.githubusercontent.com/6702424/108838381-dbbbcf80-75d3-11eb-8ae8-db41563ef9db.gif">
+</p>
 When we redirected to Keycloak the user suffers from a harsh context switch.
 Keycloak does offer a way to customize theses pages but it requires a lot of raw HTML/CSS hacking
 to reproduce the look and feel of a specific app. Not mentioning the maintenance cost of such an endeavour.  
@@ -29,14 +31,12 @@ to reproduce the look and feel of a specific app. Not mentioning the maintenance
 Wouldn't it be great if we could just design the login and register pages as if they where part of our app?  
 Here is `yarn add keycloakify` for you 🍸
 
-TODO: Insert video after.
+<p align="center">
+    <i>With keycloakify:</i><br>
+    <img src="https://github.com/InseeFrLab/keycloakify/releases/download/v0.3.8/keycloakify_after.gif">
+</p>
 
-Tested with the following Keycloak versions: 
-- [11.0.3](https://hub.docker.com/layers/jboss/keycloak/11.0.3/images/sha256-4438f1e51c1369371cb807dffa526e1208086b3ebb9cab009830a178de949782?context=explore)  
-- [12.0.4](https://hub.docker.com/layers/jboss/keycloak/12.0.4/images/sha256-67e0c88e69bd0c7aef972c40bdeb558a974013a28b3668ca790ed63a04d70584?context=explore)  
-
-**Disclaimer**: This tool will be maintained to stay compatible with Keycloak v11 and up, however, the default pages you will get 
-(before you customize it) will always be the ones of the Keycloak v11.
+**TL;DR**: [Here](https://github.com/garronej/keycloakify-demo-app) is a Hello World React project with Keycloakify set up.  
 
 - [Motivations](#motivations)
 - [How to use](#how-to-use)
@@ -45,39 +45,48 @@ Tested with the following Keycloak versions:
     - [Just changing the look](#just-changing-the-look)
     - [Changing the look **and** feel](#changing-the-look-and-feel)
     - [Hot reload](#hot-reload)
-- [Implement context persistance (optional)](#implement-context-persistance-optional)
 - [GitHub Actions](#github-actions)
-- [REQUIREMENTS](#requirements)
+- [Requirements](#requirements)
+- [Limitations](#limitations)
+  - [`process.env.PUBLIC_URL` not supported.](#processenvpublic_url-not-supported)
+  - [`@font-face` importing fonts from the `src/` dir](#font-face-importing-fonts-from-thesrc-dir)
+    - [Example of setup that **won't** work](#example-of-setup-that-wont-work)
+    - [Workarounds](#workarounds)
+- [Implement context persistence (optional)](#implement-context-persistence-optional)
 - [API Reference](#api-reference)
   - [The build tool](#the-build-tool)
-  - [The fronted lib ( imported into your react app )](#the-fronted-lib--imported-into-your-react-app-)
 
 # How to use
 ## Setting up the build tool
 
-Add `keycloakify` to the dev dependencies of your project `npm install --save-dev keycloakify` or `yarn add --dev keycloakify`
-then configure your `package.json` build's script to build the keycloak's theme by adding `&& build-keycloak-theme`.
-
-Typically you will get: 
-
-`package.json`
+[`package.json`](https://github.com/garronej/keycloakify-demo-app/blob/main/package.json)
 ```json
-"devDependencies": {
+"homepage": "https://URL.OF/YOUR-APP"
+"dependencies": {
     "keycloakify": "^0.0.10"
 },
 "scripts": {
     "keycloak": "yarn build && build-keycloak-theme",
 },
 ```
+`"homepage"` must be specified only if the url path is not `/` 
+(Onl `/YOUR-APP` matters `URL.OF` don't have to be the actual domain)
 
-Then run `yarn keycloak` or `npm run keycloak`, you will be provided with instructions
-about how to load the theme into Keycloak.
+It is mandatory that you specify the url where your app will be available
+using the `homepage` field.
+
+Once you've edited your `package.json` you can install your new
+dependency with `yarn install` and build the keycloak theme with
+`yarn keycloak`. 
+
+Once the build is complete instructions about how to load
+the theme into Keycloak are printed in the console.
 
 ## Developing your login and register pages in your React app
 
 ### Just changing the look
 
-The fist approach is to only arr/replace the default class names by your
+The first approach is to only arr/replace the default class names by your
 own.
 
 ```tsx
@@ -152,7 +161,58 @@ Checkout [this concrete example](https://github.com/garronej/keycloakify-demo-ap
 
 *NOTE: keycloak-react-theming was renamed keycloakify since this video was recorded*
 [![kickstart_video](https://user-images.githubusercontent.com/6702424/108877866-f146ee80-75ff-11eb-8120-003b3c5f6dd8.png)](https://youtu.be/xTz0Rj7i2v8)
-# Implement context persistance (optional)
+
+# GitHub Actions
+
+![image](https://user-images.githubusercontent.com/6702424/110708305-c44b2c00-81fa-11eb-8152-eeaaac0883d6.png)
+
+[Here is a demo repo](https://github.com/garronej/keycloakify-demo-app) to show how to automate
+the building and publishing of the theme (the .jar file).
+
+# Requirements 
+
+Tested with the following Keycloak versions: 
+- [11.0.3](https://hub.docker.com/layers/jboss/keycloak/11.0.3/images/sha256-4438f1e51c1369371cb807dffa526e1208086b3ebb9cab009830a178de949782?context=explore)  
+- [12.0.4](https://hub.docker.com/layers/jboss/keycloak/12.0.4/images/sha256-67e0c88e69bd0c7aef972c40bdeb558a974013a28b3668ca790ed63a04d70584?context=explore)  
+
+This tool will be maintained to stay compatible with Keycloak v11 and up, however, the default pages you will get 
+(before you customize it) will always be the ones of the Keycloak v11.
+
+This tools assumes you are bundling your app with Webpack (tested with 4.44.2) .
+It assumes there is a `build/` directory at the root of your react project directory containing a `index.html` file
+and a `build/static/` directory generated by webpack.
+
+**All this is defaults with [`create-react-app`](https://create-react-app.dev)** (tested with 4.0.3=)
+
+- For building the theme: `mvn` (Maven) must be installed
+- For development (testing the theme in a local container ): `rm`, `mkdir`, `wget`, `unzip` are assumed to be available
+  and `docker` up and running.
+
+NOTE: This build tool has only be tested on MacOS.
+
+# Limitations
+
+## `process.env.PUBLIC_URL` not supported.
+
+You won't be able to [import things from your public directory in your JavaScript code](https://create-react-app.dev/docs/using-the-public-folder/#adding-assets-outside-of-the-module-system). (This isn't recommended anyway).
+
+## `@font-face` importing fonts from the `src/` dir
+### Example of setup that **won't** work 
+
+- We have a `fonts/` directory in `src/`
+- We import the font like this [`src: url("/fonts/my-font.woff2") format("woff2");`(https://github.com/garronej/keycloakify-demo-app/blob/07d54a3012ef354ee12b1374c6f7ad1cb125d56b/src/fonts.scss#L4) in a `.scss` a file.  
+
+### Workarounds  
+
+If it is possible, use Google Fonts or any other font provider.
+
+If you want to host your font recommended approach is to move your fonts into the `public` 
+directory and to place your `@font-face` statements in the `public/index.html`.  
+Example [here]().  
+
+You can also [use your explicit url](https://github.com/garronej/keycloakify-demo-app/blob/2de8a9eb6f5de9c94f9cd3991faad0377e63268c/src/fonts.scss#L16) but don't forget [`Access-Control-Allow-Origin`](https://github.com/garronej/keycloakify-demo-app/blob/2de8a9eb6f5de9c94f9cd3991faad0377e63268c/nginx.conf#L17-L19).
+
+# Implement context persistence (optional)
 
 If, before logging in, a user has selected a specific language 
 you don't want it to be reset to default when the user gets redirected to
@@ -211,27 +271,6 @@ If you really want to go the extra miles and avoid having the white
 flash of the blank html before the js bundle have been evaluated
 [here is a snippet](https://github.com/InseeFrLab/onyxia-ui/blob/a77eb502870cfe6878edd0d956c646d28746d053/public/index.html#L5-L54) that you can place in your `public/index.html` if you are using `powerhooks/useGlobalState`.
 
-# GitHub Actions
-
-![image](https://user-images.githubusercontent.com/6702424/110708305-c44b2c00-81fa-11eb-8152-eeaaac0883d6.png)
-
-[Here is a demo repo](https://github.com/garronej/keycloakify-demo-app) to show how to automate
-the building and publishing of the theme (the .jar file).
-
-# REQUIREMENTS
-
-This tools assumes you are bundling your app with Webpack (tested with 4.44.2) .
-It assumes there is a `build/` directory at the root of your react project directory containing a `index.html` file
-and a `static/` directory generated by webpack.
-
-**All this is defaults with [`create-react-app`](https://create-react-app.dev)** (tested with 4.0.3=)
-
-- For building the theme: `mvn` (Maven) must be installed
-- For development, (testing the theme in a local container ): `rm`, `mkdir`, `wget`, `unzip` are assumed to be available
-  and `docker` up and running.
-
-NOTE: This build tool has only be tested on MacOS.
-
 # API Reference 
 
 ## The build tool 
@@ -239,11 +278,4 @@ NOTE: This build tool has only be tested on MacOS.
 Part of the lib that runs with node, at build time.
 
 - `npx build-keycloak-theme`: Builds the theme, the CWD is assumed to be the root of your react project.
-- `npx download-sample-keycloak-themes`: Downloads the keycloak default themes (for development purposes)
-
-## The fronted lib ( imported into your react app )
-
-Part of the lib that you import in your react project and runs on the browser.
-
-**TODO**
-
+- `npx download-sample-keycloak-themes`: Downloads the keycloak default themes (for development purposes)

package.json

@@ -1,6 +1,6 @@
 {
     "name": "keycloakify",
-    "version": "0.3.0",
+    "version": "0.3.23",
     "description": "Keycloak theme generator for Reacts app",
     "repository": {
         "type": "git",
@@ -14,8 +14,7 @@
         "grant-exec-perms": "node dist/bin/tools/grant-exec-perms.js",
         "test": "node dist/test",
         "copy-files": "copyfiles -u 1 src/**/*.ftl src/**/*.xml src/**/*.js dist/",
-        "generate-messages": "node dist/bin/generate-i18n-messages.js",
-        "watch": "tsc -w"
+        "generate-messages": "node dist/bin/generate-i18n-messages.js"
     },
     "bin": {
         "build-keycloak-theme": "dist/bin/build-keycloak-theme/index.js",
@@ -54,8 +53,8 @@
         "evt": "2.0.0-beta.15",
         "minimal-polyfills": "^2.1.6",
         "path": "^0.12.7",
-        "powerhooks": "^0.0.27",
+        "powerhooks": "^0.0.36",
         "scripting-tools": "^0.19.13",
-        "tss-react": "^0.0.11"
+        "tss-react": "^0.0.12"
     }
 }

src/bin/build-keycloak-theme/generateFtl/common.ftl

@@ -0,0 +1,263 @@
+<script>const _= 
+{
+    "url": {
+        "loginAction": (function (){
+
+            <#attempt>
+                return "${url.loginAction?no_esc}";
+            <#recover>
+            </#attempt>
+
+        })(),
+        "resourcesPath": (function (){
+
+            <#attempt>
+                return "${url.resourcesPath?no_esc}";
+            <#recover>
+            </#attempt>
+
+        })(),
+        "resourcesCommonPath": (function (){
+
+            <#attempt>
+                return "${url.resourcesCommonPath?no_esc}";
+            <#recover>
+            </#attempt>
+
+        })(),
+        "loginRestartFlowUrl": (function (){
+
+            <#attempt>
+                return "${url.loginRestartFlowUrl?no_esc}";
+            <#recover>
+            </#attempt>
+
+        })(),
+        "loginUrl": (function (){
+
+            <#attempt>
+                return "${url.loginUrl?no_esc}";
+            <#recover>
+            </#attempt>
+
+        })()
+    },
+    "realm": {
+        "displayName": (function (){
+
+            <#attempt>
+                return "${realm.displayName!''}" || undefined;
+            <#recover>
+            </#attempt>
+
+        })(),
+        "displayNameHtml": (function (){
+
+            <#attempt>
+                return "${realm.displayNameHtml!''}" || undefined;
+            <#recover>
+            </#attempt>
+
+        })(),
+        "internationalizationEnabled": (function (){
+
+            <#attempt>
+                return ${realm.internationalizationEnabled?c};
+            <#recover>
+            </#attempt>
+
+        })(),
+        "registrationEmailAsUsername": (function (){
+
+            <#attempt>
+                return ${realm.registrationEmailAsUsername?c};
+            <#recover>
+            </#attempt>
+
+        })()
+    },
+    "locale": (function (){
+
+        <#attempt>
+            <#if realm.internationalizationEnabled>
+
+                return {
+                    "supported": (function(){
+
+                        var out= [];
+
+                        <#attempt>
+                            <#list locale.supported as lng>
+                                out.push({ 
+                                    "url": (function (){
+
+                                        <#attempt>
+                                            return "${lng.url?no_esc}";
+                                        <#recover>
+                                        </#attempt>
+
+                                    })(),
+                                    "label": (function (){
+
+                                        <#attempt>
+                                            return "${lng.label}";
+                                        <#recover>
+                                        </#attempt>
+
+                                    })(),
+                                    "languageTag": (function (){
+
+                                        <#attempt>
+                                            return "${lng.languageTag}";
+                                        <#recover>
+                                        </#attempt>
+
+                                    })()
+                                });
+                            </#list>
+                        <#recover>
+                        </#attempt>
+
+                        return out;
+
+                    })(),
+                    "current": (function (){
+
+                        <#attempt>
+                            return "${locale.current}";
+                        <#recover>
+                        </#attempt>
+
+                    })()
+                };
+
+            </#if>
+        <#recover>
+        </#attempt>
+
+    })(),
+    "auth": (function (){
+
+        <#attempt>
+        <#if auth?has_content>
+
+            var out= {
+                "showUsername": (function (){
+
+                    <#attempt>
+                        return ${auth.showUsername()?c};
+                    <#recover>
+                    </#attempt>
+
+                })(),
+                "showResetCredentials": (function (){
+
+                    <#attempt>
+                        return ${auth.showResetCredentials()?c};
+                    <#recover>
+                    </#attempt>
+
+                })(),
+                "showTryAnotherWayLink": (function(){
+
+                    <#attempt>
+                        return ${auth.showTryAnotherWayLink()?c};
+                    <#recover>
+                    </#attempt>
+
+                })()
+            };
+
+            <#attempt>
+            <#if auth.showUsername() && !auth.showResetCredentials()>
+                Object.assign(
+                    out,
+                    {
+                        "attemptedUsername": (function (){
+                            <#attempt>
+                                return "${auth.attemptedUsername}";
+                            <#recover>
+                            </#attempt>
+                        })()
+                    }
+                );
+            </#if>
+            <#recover>
+            </#attempt>
+
+            return out;
+
+        </#if>
+        <#recover>
+        </#attempt>
+
+    })(),
+    "scripts": (function(){
+
+        var out = [];
+
+        <#attempt>
+            <#if scripts??>
+                <#attempt>
+                    <#list scripts as script>
+                        out.push((function (){
+
+                            <#attempt>
+                                return "${script}";
+                            <#recover>
+                            </#attempt>
+
+                        })());
+                    </#list>
+                <#recover>
+                </#attempt>
+            </#if>
+        <#recover>
+        </#attempt>
+
+        return out;
+
+    })(),
+    "message": (function (){
+
+        <#attempt>
+            <#if message?has_content>
+
+                return { 
+                    "type": (function (){
+
+                        <#attempt>
+                            return "${message.type}";
+                        <#recover>
+                        </#attempt>
+
+                    })(),
+                    "summary": (function (){
+
+                        <#attempt>
+                            return String.htmlUnescape("${message.summary}");
+                        <#recover>
+                        </#attempt>
+
+                    })()
+                };
+
+            </#if>
+        <#recover>
+        </#attempt>
+
+    })(),
+    "isAppInitiatedAction": (function (){
+
+        <#attempt>
+            <#if isAppInitiatedAction??>
+                return true;
+            </#if>
+        <#recover>
+        </#attempt>
+
+        return false;
+
+    })()
+}
+</script>

src/bin/build-keycloak-theme/generateFtl/error.ftl

@@ -2,13 +2,21 @@
 {
     "client": (function (){
 
+        <#attempt>
             <#if client??>
                 return {
-                    "baseUrl": "${(client.baseUrl!'')?no_esc}" || undefined
+                    "baseUrl": (function (){
+
+                        <#attempt>
+                            return "${(client.baseUrl!'')?no_esc}" || undefined;
+                        <#recover>
+                        </#attempt>
+
+                    })()
                 };
             </#if>
-
-            return undefined;
+        <#recover>
+        </#attempt>
 
     })()
 }

src/bin/build-keycloak-theme/generateFtl/index.ts

@@ -2,23 +2,28 @@
 
 import cheerio from "cheerio";
 import {
-    replaceImportFromStaticInJsCode,
+    replaceImportsFromStaticInJsCode,
+    replaceImportsInInlineCssCode,
     generateCssCodeToDefineGlobals
 } from "../replaceImportFromStatic";
 import fs from "fs";
 import { join as pathJoin } from "path";
 import { objectKeys } from "evt/tools/typeSafety/objectKeys";
 
-export const pageIds = ["login.ftl", "register.ftl", "info.ftl", "error.ftl", "login-reset-password.ftl", "login-verify-email.ftl"] as const;
+export const pageIds = [
+    "login.ftl", "register.ftl", "info.ftl", 
+    "error.ftl", "login-reset-password.ftl", 
+    "login-verify-email.ftl", "terms.ftl"
+] as const;
 
-export type PageId =  typeof pageIds[number];
+export type PageId = typeof pageIds[number];
 
-function loadAdjacentFile(fileBasename: string){
+function loadAdjacentFile(fileBasename: string) {
     return fs.readFileSync(pathJoin(__dirname, fileBasename))
         .toString("utf8");
 };
 
-function loadFtlFile(ftlFileBasename: PageId | "template.ftl") {
+function loadFtlFile(ftlFileBasename: PageId | "common.ftl") {
     try {
 
         return loadAdjacentFile(ftlFileBasename)
@@ -29,21 +34,23 @@ function loadFtlFile(ftlFileBasename: PageId | "template.ftl") {
     }
 }
 
+
 export function generateFtlFilesCodeFactory(
     params: {
         ftlValuesGlobalName: string;
         cssGlobalsToDefine: Record<string, string>;
         indexHtmlCode: string;
+        urlPathname: string;
     }
 ) {
 
-    const { ftlValuesGlobalName, cssGlobalsToDefine, indexHtmlCode } = params;
+    const { ftlValuesGlobalName, cssGlobalsToDefine, indexHtmlCode, urlPathname } = params;
 
     const $ = cheerio.load(indexHtmlCode);
 
     $("script:not([src])").each((...[, element]) => {
 
-        const { fixedJsCode } = replaceImportFromStaticInJsCode({
+        const { fixedJsCode } = replaceImportsFromStaticInJsCode({
             ftlValuesGlobalName,
             "jsCode": $(element).html()!
         });
@@ -52,6 +59,17 @@ export function generateFtlFilesCodeFactory(
 
     });
 
+    $("style").each((...[, element]) => {
+
+        const { fixedCssCode } = replaceImportsInInlineCssCode({
+            "cssCode": $(element).html()!,
+            "urlPathname": params.urlPathname
+        });
+
+        $(element).text(fixedCssCode);
+
+    });
+
     ([
         ["link", "href"],
         ["script", "src"],
@@ -60,18 +78,24 @@ export function generateFtlFilesCodeFactory(
 
             const href = $(element).attr(attrName);
 
-            if (!href?.startsWith("/")) {
+            if (href === undefined) {
                 return;
             }
 
-            $(element).attr(attrName, "${url.resourcesPath}/build" + href);
+            $(element).attr(
+                attrName,
+                href.replace(
+                    new RegExp(`^${urlPathname.replace(/\//g, "\\/")}`),
+                    "${url.resourcesPath}/build/"
+                )
+            );
 
         })
     );
 
     //FTL is no valid html, we can't insert with cheerio, we put placeholder for injecting later.
     const ftlCommonPlaceholders = {
-        '{ "x": "vIdLqMeOed9sdLdIdOxdK0d" }': loadFtlFile("template.ftl"),
+        '{ "x": "vIdLqMeOed9sdLdIdOxdK0d" }': loadFtlFile("common.ftl"),
         '<!-- xIdLqMeOedErIdLsPdNdI9dSlxI -->':
             [
                 '<#if scripts??>',
@@ -89,9 +113,10 @@ export function generateFtlFilesCodeFactory(
             ...(Object.keys(cssGlobalsToDefine).length === 0 ? [] : [
                 '',
                 '<style>',
-                generateCssCodeToDefineGlobals(
-                    { cssGlobalsToDefine }
-                ).cssCodeToPrependInHead,
+                generateCssCodeToDefineGlobals({
+                    cssGlobalsToDefine,
+                    urlPathname
+                }).cssCodeToPrependInHead,
                 '</style>',
                 ''
             ]),

src/bin/build-keycloak-theme/generateFtl/info.ftl

@@ -1,37 +1,82 @@
 <script>const _= 
 {
-    "messageHeader": "${messageHeader!''}" || undefined,
+    "messageHeader": (function (){
+
+        <#attempt>
+            return "${messageHeader!''}" || undefined;
+        <#recover>
+        </#attempt>
+
+    })(),
     "requiredActions": (function (){
 
+        <#attempt>
         <#if requiredActions??>
 
             var out =[];
 
+            <#attempt>
             <#list requiredActions>
+                <#attempt>
                 <#items as reqActionItem>
-                    out.push("${reqActionItem}");
-                </#items></b>
+                    out.push((function (){
+
+                        <#attempt>
+                            return "${reqActionItem}";
+                        <#recover>
+                        </#attempt>
+
+                    })());
+                </#items>
+                <#recover>
+                </#attempt>
             </#list>
+            <#recover>
+            </#attempt>
 
             return out;
 
-        <#else>
-
-        return undefined;
+        </#if>
+        <#recover>
+        </#attempt>
 
     })(),
     "skipLink": (function (){
 
+        <#attempt>
         <#if skipLink??>
             return true;
         </#if>
+        <#recover>
+        </#attempt>
         return false;
 
     })(),
-    "pageRedirectUri": "${(pageRedirectUri!'')?no_esc}" || undefined,
-    "actionUri": "${(actionUri!'')?no_esc}" || undefined,
+    "pageRedirectUri": (function (){
+
+        <#attempt>
+            return "${(pageRedirectUri!'')?no_esc}" || undefined;
+        <#recover>
+        </#attempt>
+
+    })(),
+    "actionUri": (function (){
+
+        <#attempt>
+            return "${(actionUri!'')?no_esc}" || undefined;
+        <#recover>
+        </#attempt>
+
+    })(),
     "client": {
-        "baseUrl": "${(client.baseUrl!'')?no_esc}" || undefined
+        "baseUrl": (function(){
+
+            <#attempt>
+                return "${(client.baseUrl!'')?no_esc}" || undefined;
+            <#recover>
+            </#attempt>
+
+        })()
     }
 }
 </script>

src/bin/build-keycloak-theme/generateFtl/login-reset-password.ftl

@@ -1,7 +1,14 @@
 <script>const _= 
 {
     "realm": {
-        "loginWithEmailAllowed": ${realm.loginWithEmailAllowed?c}
-    },
+        "loginWithEmailAllowed": (function (){
+
+            <#attempt>
+                return ${realm.loginWithEmailAllowed?c};
+            <#recover>
+            </#attempt>
+
+        })()
+    }
 }
 </script>

src/bin/build-keycloak-theme/generateFtl/login.ftl

@@ -1,83 +1,160 @@
 <script>const _= 
 {
     "url": {
-        "loginResetCredentialsUrl": "${url.loginResetCredentialsUrl?no_esc}",
-        "registrationUrl": "${url.registrationUrl?no_esc}"
+        "loginResetCredentialsUrl": (function (){
+            <#attempt>
+                return "${url.loginResetCredentialsUrl?no_esc}";
+            <#recover>
+            </#attempt>
+        })(),
+        "registrationUrl": (function (){
+            <#attempt>
+                return "${url.registrationUrl?no_esc}";
+            <#recover>
+            </#attempt>
+        })()
     },
     "realm": {
-        "loginWithEmailAllowed": ${realm.loginWithEmailAllowed?c},
-        "rememberMe": ${realm.rememberMe?c},
-        "password": ${realm.password?c},
-        "resetPasswordAllowed": ${realm.resetPasswordAllowed?c},
-        "registrationAllowed": ${realm.registrationAllowed?c}
+        "loginWithEmailAllowed": (function(){
+            <#attempt>
+                return ${realm.loginWithEmailAllowed?c};
+            <#recover>
+            </#attempt>
+        })(),
+        "rememberMe": (function (){
+            <#attempt>
+                return ${realm.rememberMe?c};
+            <#recover>
+            </#attempt>
+        })(),
+        "password": (function (){
+            <#attempt>
+                return ${realm.password?c};
+            <#recover>
+            </#attempt>
+        })(),
+        "resetPasswordAllowed": (function (){
+            <#attempt>
+                return ${realm.resetPasswordAllowed?c};
+            <#recover>
+            </#attempt>
+        })(),
+        "registrationAllowed": (function (){
+            <#attempt>
+                return ${realm.registrationAllowed?c};
+            <#recover>
+            </#attempt>
+        })()
     },
     "auth": (function (){
 
+        <#attempt>
         <#if auth?has_content>
 
-            var out= {
-                "selectedCredential": "${auth.selectedCredential!''}" || undefined
+            return {
+                "selectedCredential": (function (){
+                    <#attempt>
+                        return "${auth.selectedCredential!''}" || undefined;
+                    <#recover>
+                    </#attempt>
+                })()
             };
 
-            return out;
-
         </#if>
-
-        return undefined;
+        <#recover>
+        </#attempt>
 
     })(),
     "social": {
-        "displayInfo": ${social.displayInfo?c},
+        "displayInfo": (function (){
+            <#attempt>
+                return ${social.displayInfo?c};
+            <#recover>
+            </#attempt>
+        })(),
         "providers": (()=>{
 
+            <#attempt>
             <#if social.providers??>
 
                 var out= [];
 
+                <#attempt>
                 <#list social.providers as p>
                     out.push({ 
-                        "loginUrl": "${p.loginUrl?no_esc}",
-                        "alias": "${p.alias}",
-                        "providerId": "${p.providerId}",
-                        "displayName": "${p.displayName}"
+                        "loginUrl": (function (){
+                            <#attempt>
+                                return "${p.loginUrl?no_esc}";
+                            <#recover>
+                            </#attempt>
+                        })(),
+                        "alias": (function (){
+                            <#attempt>
+                                return "${p.alias}";
+                            <#recover>
+                            </#attempt>
+                        })(),
+                        "providerId": (function (){
+                            <#attempt>
+                                return "${p.providerId}";
+                            <#recover>
+                            </#attempt>
+                        })(),
+                        "displayName": (function (){
+                            <#attempt>
+                                return "${p.displayName}";
+                            <#recover>
+                            </#attempt>
+                        })()
                     });
                 </#list>
+                <#recover>
+                </#attempt>
 
                 return out;
 
             </#if>
-
-            return undefined;
+            <#recover>
+            </#attempt>
 
         })()
     },
     "usernameEditDisabled": (function () {
 
+        <#attempt>
         <#if usernameEditDisabled??>
             return true;
         </#if>
+        <#recover>
+        </#attempt>
         return false;
 
     })(),
     "login": {
-        "username": "${login.username!''}" || undefined,
+        "username": (function (){
+            <#attempt>
+                return "${login.username!''}" || undefined;
+            <#recover>
+            </#attempt>
+        })(),
         "rememberMe": (function (){
-
+            <#attempt>
             <#if login.rememberMe??>
                 return true;
             </#if>
+            <#recover>
+            </#attempt>
             return false;
-
-
         })()
     },
     "registrationDisabled": (function (){
-
+        <#attempt>
         <#if registrationDisabled??>
             return true;
         </#if>
+        <#recover>
+        </#attempt>
         return false;
-
     })()
 }
 </script>

src/bin/build-keycloak-theme/generateFtl/register.ftl

@@ -1,46 +1,152 @@
 <script>const _= 
 {
     "url": {
-        "registrationAction": "${url.registrationAction?no_esc}"
+        "registrationAction": (function (){
+
+            <#attempt>
+                return "${url.registrationAction?no_esc}";
+            <#recover>
+            </#attempt>
+
+        })()
     },
     "messagesPerField": {
         "printIfExists": function (key, x) {
             switch(key){
-                case "userLabel": "${messagesPerField.printIfExists('userLabel','1')}" ? x : undefined;
-                case "username": "${messagesPerField.printIfExists('username','1')}" ? x : undefined;
-                case "email": "${messagesPerField.printIfExists('email','1')}" ? x : undefined;
-                case "firstName": "${messagesPerField.printIfExists('firstName','1')}" ? x : undefined;
-                case "lastName": "${messagesPerField.printIfExists('lastName','1')}" ? x : undefined;
-                case "password": "${messagesPerField.printIfExists('password','1')}" ? x : undefined;
-                case "password-confirm": "${messagesPerField.printIfExists('password-confirm','1')}" ? x : undefined;
+                case "userLabel": return (function (){
+
+                    <#attempt>
+                        return "${messagesPerField.printIfExists('userLabel','1')}" ? x : undefined;
+                    <#recover>
+                    </#attempt>
+
+                })();
+                case "username": return (function (){
+
+                    <#attempt>
+                        return "${messagesPerField.printIfExists('username','1')}" ? x : undefined;
+                    <#recover>
+                    </#attempt>
+
+                })();
+                case "email": return (function (){
+
+                    <#attempt>
+                        return "${messagesPerField.printIfExists('email','1')}" ? x : undefined;
+                    <#recover>
+                    </#attempt>
+
+                })();
+                case "firstName": return (function (){
+
+                    <#attempt>
+                        return "${messagesPerField.printIfExists('firstName','1')}" ? x : undefined;
+                    <#recover>
+                    </#attempt>
+
+                })();
+                case "lastName": return (function (){
+
+                    <#attempt>
+                        return "${messagesPerField.printIfExists('lastName','1')}" ? x : undefined;
+                    <#recover>
+                    </#attempt>
+
+                })();
+                case "password": return (function (){
+
+                    <#attempt>
+                        return "${messagesPerField.printIfExists('password','1')}" ? x : undefined;
+                    <#recover>
+                    </#attempt>
+
+                })();
+                case "password-confirm": return (function (){
+
+                    <#attempt>
+                        return "${messagesPerField.printIfExists('password-confirm','1')}" ? x : undefined;
+                    <#recover>
+                    </#attempt>
+
+                })();
             }
         }
     },
     "register": {
         "formData": {
-            "firstName": "${register.formData.firstName!''}" || undefined,
-            "displayName": "${register.formData.displayName!''}" || undefined,
-            "lastName": "${register.formData.lastName!''}" || undefined,
-            "email": "${register.formData.email!''}" || undefined,
-            "username": "${register.formData.username!''}" || undefined
+            "firstName": (function (){
+
+                <#attempt>
+                    return "${register.formData.firstName!''}" || undefined;
+                <#recover>
+                </#attempt>
+
+            })(),
+            "displayName": (function (){
+
+                <#attempt>
+                    return "${register.formData.displayName!''}" || undefined;
+                <#recover>
+                </#attempt>
+
+            })(),
+            "lastName": (function (){
+
+                <#attempt>
+                    return "${register.formData.lastName!''}" || undefined;
+                <#recover>
+                </#attempt>
+
+            })(),
+            "email": (function(){
+
+                <#attempt>
+                    return "${register.formData.email!''}" || undefined;
+                <#recover>
+                </#attempt>
+
+            })(),
+            "username": (function (){
+
+                <#attempt>
+                    return "${register.formData.username!''}" || undefined;
+                <#recover>
+                </#attempt>
+
+            })()
         }
     },
     "passwordRequired": (function (){
 
+        <#attempt>
         <#if passwordRequired??>
             return true;
         </#if>
+        <#recover>
+        </#attempt>
+
         return false;
 
     })(),
     "recaptchaRequired": (function (){
 
+        <#attempt>
         <#if passwordRequired??>
             return true;
         </#if>
+        <#recover>
+        </#attempt>
+
         return false;
 
     })(),
-    "recaptchaSiteKey": "${recaptchaSiteKey!''}" || undefined
+    "recaptchaSiteKey": (function (){
+
+        <#attempt>
+            return "${recaptchaSiteKey!''}" || undefined;
+        <#recover>
+        </#attempt>
+
+    })()
 }
 </script>

src/bin/build-keycloak-theme/generateFtl/template.ftl

@@ -1,114 +0,0 @@
-<script>const _= 
-{
-    "url": {
-        "loginAction": "${url.loginAction?no_esc}",
-        "resourcesPath": "${url.resourcesPath?no_esc}",
-        "resourcesCommonPath": "${url.resourcesCommonPath?no_esc}",
-        "loginRestartFlowUrl": "${url.loginRestartFlowUrl?no_esc}",
-        "loginUrl": "${url.loginUrl?no_esc}"
-    },
-    "realm": {
-        "displayName": "${realm.displayName!''}" || undefined,
-        "displayNameHtml": "${realm.displayNameHtml!''}" || undefined,
-        "internationalizationEnabled": ${realm.internationalizationEnabled?c},
-        "registrationEmailAsUsername": ${realm.registrationEmailAsUsername?c},
-    },
-    "locale": (function (){
-
-        <#if realm.internationalizationEnabled>
-
-            return {
-                "supported": (function(){
-
-                    <#if realm.internationalizationEnabled>
-
-                        var out= [];
-
-                        <#list locale.supported as lng>
-                            out.push({ 
-                                "url": "${lng.url?no_esc}", 
-                                "label": "${lng.label}",
-                                "languageTag": "${lng.languageTag}"
-                            });
-                        </#list>
-
-                        return out;
-
-                    </#if>
-
-                    return undefined;
-
-                })(),
-                "current": "${locale.current}"
-            };
-
-        </#if>
-
-        return undefined;
-
-    })(),
-    "auth": (function (){
-
-
-        <#if auth?has_content>
-
-            var out= {
-                "showUsername": ${auth.showUsername()?c},
-                "showResetCredentials": ${auth.showResetCredentials()?c},
-                "showTryAnotherWayLink": ${auth.showTryAnotherWayLink()?c},
-            };
-
-            <#if auth.showUsername() && !auth.showResetCredentials()>
-                Object.assign(
-                    out,
-                    {
-                        "attemptedUsername": "${auth.attemptedUsername}"
-                    }
-                );
-            </#if>
-
-            return out;
-
-        </#if>
-
-
-        return undefined;
-
-    })(),
-    "scripts": (function(){
-
-        var out = [];
-
-        <#if scripts??>
-            <#list scripts as script>
-                out.push("${script}");
-            </#list>
-        </#if>
-
-        return out;
-
-    })(),
-    "message": (function (){
-
-        <#if message?has_content>
-
-            return { 
-                "type": "${message.type}",
-                "summary": String.htmlUnescape("${message.summary}")
-            };
-
-        </#if>
-
-        return undefined;
-
-    })(),
-    "isAppInitiatedAction": (function (){
-
-        <#if isAppInitiatedAction??>
-            return true;
-        </#if>
-        return false;
-
-    })()
-}
-</script>

src/bin/build-keycloak-theme/generateKeycloakThemeResources.ts

@@ -3,26 +3,28 @@ import { transformCodebase } from "../tools/transformCodebase";
 import * as fs from "fs";
 import { join as pathJoin } from "path";
 import {
-    replaceImportFromStaticInCssCode,
-    replaceImportFromStaticInJsCode
+    replaceImportsInCssCode,
+    replaceImportsFromStaticInJsCode
 } from "./replaceImportFromStatic";
 import { generateFtlFilesCodeFactory, pageIds } from "./generateFtl";
-import { builtinThemesUrl } from "../install-builtin-keycloak-themes";
-import { downloadAndUnzip } from "../tools/downloadAndUnzip";
+import { builtinThemesUrl } from "../install-builtin-keycloak-themes";
+import { downloadAndUnzip } from "../tools/downloadAndUnzip";
 import * as child_process from "child_process";
-import { ftlValuesGlobalName } from "./ftlValuesGlobalName";
-import { resourcesCommonPath, resourcesPath, subDirOfPublicDirBasename } from "../../lib/kcContextMocks/urlResourcesPath";
-import { isInside } from "../tools/isInside";
+import { ftlValuesGlobalName } from "./ftlValuesGlobalName";
+import { resourcesCommonPath, resourcesPath, subDirOfPublicDirBasename } from "../../lib/kcContextMocks/urlResourcesPath";
+import { isInside } from "../tools/isInside";
+
 
 export function generateKeycloakThemeResources(
     params: {
         themeName: string;
         reactAppBuildDirPath: string;
         keycloakThemeBuildingDirPath: string;
+        urlPathname: string;
     }
 ) {
 
-    const { themeName, reactAppBuildDirPath, keycloakThemeBuildingDirPath } = params;
+    const { themeName, reactAppBuildDirPath, keycloakThemeBuildingDirPath, urlPathname } = params;
 
     const themeDirPath = pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", themeName, "login");
 
@@ -46,7 +48,7 @@ export function generateKeycloakThemeResources(
 
             if (/\.css?$/i.test(filePath)) {
 
-                const { cssGlobalsToDefine, fixedCssCode } = replaceImportFromStaticInCssCode(
+                const { cssGlobalsToDefine, fixedCssCode } = replaceImportsInCssCode(
                     { "cssCode": sourceCode.toString("utf8") }
                 );
 
@@ -59,9 +61,10 @@ export function generateKeycloakThemeResources(
 
             }
 
+
             if (/\.js?$/i.test(filePath)) {
 
-                const { fixedJsCode } = replaceImportFromStaticInJsCode({
+                const { fixedJsCode } = replaceImportsFromStaticInJsCode({
                     "jsCode": sourceCode.toString("utf8"),
                     ftlValuesGlobalName
                 });
@@ -80,7 +83,8 @@ export function generateKeycloakThemeResources(
         ftlValuesGlobalName,
         "indexHtmlCode": fs.readFileSync(
             pathJoin(reactAppBuildDirPath, "index.html")
-        ).toString("utf8")
+        ).toString("utf8"),
+        urlPathname
     });
 
     pageIds.forEach(pageId => {

src/bin/build-keycloak-theme/index.ts

@@ -6,6 +6,7 @@ import type { ParsedPackageJson } from "./generateJavaStackFiles";
 import { join as pathJoin, relative as pathRelative, basename as pathBasename } from "path";
 import * as child_process from "child_process";
 import { generateDebugFiles, containerLaunchScriptBasename } from "./generateDebugFiles";
+import { URL } from "url";
 
 
 const reactProjectDirPath = process.cwd();
@@ -22,7 +23,25 @@ if (require.main === module) {
     generateKeycloakThemeResources({
         keycloakThemeBuildingDirPath,
         "reactAppBuildDirPath": pathJoin(reactProjectDirPath, "build"),
-        "themeName": parsedPackageJson.name
+        "themeName": parsedPackageJson.name,
+        "urlPathname": (() => {
+
+            const url = (() => {
+
+                const { homepage } = parsedPackageJson;
+
+                return homepage === undefined ?
+                    undefined :
+                    new URL(homepage);
+
+            })();
+
+            return url === undefined ?
+                "/" :
+                url.pathname.replace(/([^/])$/, "$1/");
+
+
+        })()
     });
 
     const { jarFilePath } = generateJavaStackFiles({

src/bin/build-keycloak-theme/replaceImportFromStatic.ts

@@ -1,7 +1,7 @@
 
 import * as crypto from "crypto";
 
-export function replaceImportFromStaticInJsCode(
+export function replaceImportsFromStaticInJsCode(
     params: {
         ftlValuesGlobalName: string;
         jsCode: string;
@@ -10,16 +10,36 @@ export function replaceImportFromStaticInJsCode(
 
     const { jsCode, ftlValuesGlobalName } = params;
 
-    const fixedJsCode = jsCode!.replace(
-        /"static\//g,
-        `window.${ftlValuesGlobalName}.url.resourcesPath.replace(/^\\//,"") + "/build/static/`
+    const fixedJsCode = jsCode.replace(
+        /[a-z]+\.[a-z]+\+"static\//g,
+        `window.${ftlValuesGlobalName}.url.resourcesPath + "/build/static/`
     );
 
     return { fixedJsCode };
 
 }
 
-export function replaceImportFromStaticInCssCode(
+export function replaceImportsInInlineCssCode(
+    params: {
+        cssCode: string;
+        urlPathname: string;
+    }
+): { fixedCssCode: string; } {
+
+    const { cssCode, urlPathname } = params;
+
+    const fixedCssCode = cssCode.replace(
+        urlPathname === "/" ?
+            /url\(\/([^/][^)]+)\)/g :
+            new RegExp(`url\\(${urlPathname}([^)]+)\\)`, "g"),
+        (...[, group]) => `url(${"${url.resourcesPath}/build/" + group})`
+    );
+
+    return { fixedCssCode };
+
+}
+
+export function replaceImportsInCssCode(
     params: {
         cssCode: string;
     }
@@ -32,7 +52,7 @@ export function replaceImportFromStaticInCssCode(
 
     const cssGlobalsToDefine: Record<string, string> = {};
 
-    new Set(cssCode.match(/(url\(\/[^)]+\))/g) ?? [])
+    new Set(cssCode.match(/url\(\/[^/][^)]+\)[^;}]*/g) ?? [])
         .forEach(match =>
             cssGlobalsToDefine[
             "url" + crypto
@@ -60,12 +80,13 @@ export function replaceImportFromStaticInCssCode(
 export function generateCssCodeToDefineGlobals(
     params: {
         cssGlobalsToDefine: Record<string, string>;
+        urlPathname: string;
     }
 ): {
     cssCodeToPrependInHead: string;
 } {
 
-    const { cssGlobalsToDefine } = params;
+    const { cssGlobalsToDefine, urlPathname } = params;
 
     return {
         "cssCodeToPrependInHead": [
@@ -73,12 +94,8 @@ export function generateCssCodeToDefineGlobals(
             ...Object.keys(cssGlobalsToDefine)
                 .map(cssVariableName => [
                     `--${cssVariableName}:`,
-                    [
-                        "url(",
-                        "${url.resourcesPath}/build" +
-                        cssGlobalsToDefine[cssVariableName].match(/^url\(([^)]+)\)$/)![1],
-                        ")"
-                    ].join("")
+                    cssGlobalsToDefine[cssVariableName]
+                        .replace(new RegExp(`url\\(${urlPathname.replace(/\//g, "\\/")}`, "g"), "url(${url.resourcesPath}/build/")
                 ].join(" "))
                 .map(line => `    ${line};`),
             "}"

src/bin/generate-i18n-messages.ts

@@ -49,7 +49,7 @@ crawl(".").forEach(filePath => {
 
 child_process.execSync(`rm -r ${tmpDirPath}`);
 
-const targetDirPath = pathJoin(getProjectRoot(), "src", "lib", "i18n", "generated_messages");
+const targetDirPath = pathJoin(getProjectRoot(), "src", "lib", "i18n", "generated_kcMessages");
 
 fs.mkdirSync(targetDirPath, { "recursive": true });
 
@@ -65,7 +65,7 @@ Object.keys(record).forEach(pageType => {
                 '//PLEASE DO NOT EDIT MANUALLY',
                 '',
                 '/* spell-checker: disable */',
-                `export const messages= ${JSON.stringify(record[pageType], null, 2)} as const;`,
+                `export const kcMessages= ${JSON.stringify(record[pageType], null, 2)};`,
                 '/* spell-checker: enable */'
             ].join("\n"), "utf8")
     );

src/lib/components/Info.tsx

@@ -53,13 +53,13 @@ export const Info = memo(({ kcContext, ...props }: { kcContext: KcContext.Info;
                     {
                         !skipLink &&
                             pageRedirectUri !== undefined ?
-                            <p><a href="${pageRedirectUri}">${(msg("backToApplication"))}</a></p>
+                            <p><a href={pageRedirectUri}>{(msg("backToApplication"))}</a></p>
                             :
                             actionUri !== undefined ?
-                                <p><a href="${actionUri}">${msg("proceedWithAction")}</a></p>
+                                <p><a href={actionUri}>{msg("proceedWithAction")}</a></p>
                                 :
                                 client.baseUrl !== undefined &&
-                                <p><a href="${client.baseUrl}">${msg("backToApplication")}</a></p>
+                                <p><a href={client.baseUrl}>{msg("backToApplication")}</a></p>
                     }
                 </div>
 

src/lib/components/KcApp.tsx

@@ -8,6 +8,7 @@ import { Info } from "./Info";
 import { Error } from "./Error";
 import { LoginResetPassword } from "./LoginResetPassword";
 import { LoginVerifyEmail } from "./LoginVerifyEmail";
+import { Terms } from "./Terms";
 
 export const KcApp = memo(({ kcContext, ...props }: { kcContext: KcContext; } & KcProps ) => {
     switch (kcContext.pageId) {
@@ -17,5 +18,6 @@ export const KcApp = memo(({ kcContext, ...props }: { kcContext: KcContext; } &
         case "error.ftl": return <Error {...{ kcContext, ...props }} />;
         case "login-reset-password.ftl": return <LoginResetPassword {...{ kcContext, ...props }} />;
         case "login-verify-email.ftl": return <LoginVerifyEmail {...{ kcContext, ...props }} />;
+        case "terms.ftl": return <Terms {...{ kcContext, ...props }}/>;
     }
 });

src/lib/components/LoginResetPassword.tsx

@@ -66,7 +66,7 @@ export const LoginResetPassword = memo(({ kcContext, ...props }: { kcContext: Kc
                                     props.kcButtonBlockClass, props.kcButtonLargeClass
                                 )}
                                 type="submit"
-                                defaultValue={msgStr("doSubmit")}
+                                value={msgStr("doSubmit")}
                             />
                         </div>
                     </div>

src/lib/components/Register.tsx

@@ -113,7 +113,7 @@ export const Register = memo(({ kcContext, ...props }: { kcContext: KcContext.Re
 
                         <div id="kc-form-buttons" className={cx(props.kcFormButtonsClass)}>
                             <input className={cx(props.kcButtonClass, props.kcButtonPrimaryClass, props.kcButtonBlockClass, props.kcButtonLargeClass)} type="submit"
-                                defaultValue={msgStr("doRegister")} />
+                                value={msgStr("doRegister")} />
                         </div>
                     </div>
                 </form >

src/lib/components/Template.tsx

@@ -25,8 +25,7 @@ export type TemplateProps = {
     showUsernameNode?: ReactNode;
     formNode: ReactNode;
     infoNode?: ReactNode;
-} & { kcContext: KcContext.Template; }  & KcTemplateProps;
-
+} & { kcContext: KcContext; } & KcTemplateProps;
 
 export const Template = memo((props: TemplateProps) => {
 
@@ -60,34 +59,35 @@ export const Template = memo((props: TemplateProps) => {
     );
 
     const {
-        realm, locale, auth, 
+        realm, locale, auth,
         url, message, isAppInitiatedAction
-    }= kcContext;
+    } = kcContext;
 
-    useEffect(()=>{
+    useEffect(() => {
 
-        if( !realm.internationalizationEnabled ){
+        if (!realm.internationalizationEnabled) {
             return;
         }
 
-        assert( locale !== undefined );
+        assert(locale !== undefined);
 
-        if( kcLanguageTag === getBestMatchAmongKcLanguageTag(locale.current) ){
+        if (kcLanguageTag === getBestMatchAmongKcLanguageTag(locale.current)) {
             return;
         }
 
-        window.location.href = 
+        window.location.href =
             locale.supported.find(({ languageTag }) => languageTag === kcLanguageTag)!.url;
 
-    },[kcLanguageTag]);
+    }, [kcLanguageTag]);
 
     const [isExtraCssLoaded, setExtraCssLoaded] = useReducer(() => true, false);
 
     useEffect(() => {
 
         let isUnmounted = false;
+        const cleanups: (() => void)[] = [];
 
-        const toArr = (x: string | readonly string[] | undefined) => 
+        const toArr = (x: string | readonly string[] | undefined) =>
             typeof x === "string" ? x.split(" ") : x ?? [];
 
         Promise.all(
@@ -116,15 +116,27 @@ export const Template = memo((props: TemplateProps) => {
 
         if (props.kcHtmlClass !== undefined) {
 
-            document.getElementsByTagName("html")[0]
-                .classList
-                .add(...cx(props.kcHtmlClass).split(" "));
+            const htmlClassList =
+                document.getElementsByTagName("html")[0]
+                    .classList;
+
+            const tokens = cx(props.kcHtmlClass).split(" ")
+
+            htmlClassList.add(...tokens);
+
+            cleanups.push(() => htmlClassList.remove(...tokens));
 
         }
 
-        return () => { isUnmounted = true; };
+        return () => {
 
-    }, []);
+            isUnmounted = true;
+
+            cleanups.forEach(f => f());
+
+        };
+
+    }, [props.kcHtmlClass]);
 
     if (!isExtraCssLoaded) {
         return null;

src/lib/components/Terms.tsx

@@ -0,0 +1,57 @@
+import { memo } from "react";
+import { Template } from "./Template";
+import type { KcProps } from "./KcProps";
+import type { KcContext } from "../KcContext";
+import { useKcMessage } from "../i18n/useKcMessage";
+import { cx } from "tss-react";
+
+export const Terms = memo(({ kcContext, ...props }: { kcContext: KcContext.Terms; } & KcProps) => {
+
+    const { msg, msgStr } = useKcMessage();
+
+    const { url } = kcContext;
+
+    return (
+        <Template
+            {...{ kcContext, ...props }}
+            displayMessage={false}
+            headerNode={msg("termsTitle")}
+            formNode={
+                <>
+                    <div id="kc-terms-text">
+                        {msg("termsText")}
+                    </div>
+                    <form className="form-actions" action={url.loginAction} method="POST">
+                        <input
+                            className={cx(
+                                props.kcButtonClass,
+                                props.kcButtonClass,
+                                props.kcButtonClass,
+                                props.kcButtonPrimaryClass,
+                                props.kcButtonLargeClass
+                            )}
+                            name="accept"
+                            id="kc-accept"
+                            type="submit"
+                            value={msgStr("doAccept")}
+                        />
+                        <input
+                            className={cx(
+                                props.kcButtonClass,
+                                props.kcButtonDefaultClass,
+                                props.kcButtonLargeClass
+                            )}
+                            name="cancel"
+                            id="kc-decline"
+                            type="submit"
+                            value={msgStr("doDecline")}
+                        />
+                    </form>
+                    <div className="clearfix" />
+                </>
+            }
+        />
+    );
+});
+
+

src/lib/i18n/KcLanguageTag.ts

@@ -1,8 +1,8 @@
 
 import { objectKeys } from "evt/tools/typeSafety/objectKeys";
-import { messages } from "./generated_messages/login";
+import { kcMessages } from "./kcMessages/login";
 
-export type KcLanguageTag = keyof typeof messages;
+export type KcLanguageTag = keyof typeof kcMessages;
 
 export type LanguageLabel =
     /* spell-checker: disable */
@@ -40,7 +40,7 @@ export function getKcLanguageTagLabel(language: KcLanguageTag): LanguageLabel {
 
 }
 
-const availableLanguages = objectKeys(messages);
+const availableLanguages = objectKeys(kcMessages);
 
 /** 
  * Pass in "fr-FR" or "français" for example, it will return the AvailableLanguage

src/lib/i18n/generated_kcMessages/account.ts

@@ -2,7 +2,7 @@
 //PLEASE DO NOT EDIT MANUALLY
 
 /* spell-checker: disable */
-export const messages= {
+export const kcMessages= {
   "ca": {
     "doSave": "Desa",
     "doCancel": "Cancel·la",
@@ -3060,5 +3060,5 @@ export const messages= {
     "locale_ru": "Русский",
     "locale_zh-CN": "中文简体"
   }
-} as const;
+};
 /* spell-checker: enable */

src/lib/i18n/generated_kcMessages/admin.ts

@@ -2,7 +2,7 @@
 //PLEASE DO NOT EDIT MANUALLY
 
 /* spell-checker: disable */
-export const messages= {
+export const kcMessages= {
   "ca": {
     "invalidPasswordHistoryMessage": "Contrasenya incorrecta: no pot ser igual a cap de les últimes {0} contrasenyes.",
     "invalidPasswordMinDigitsMessage": "Contraseña incorrecta: debe contener al menos {0} caracteres numéricos.",
@@ -240,5 +240,5 @@ export const messages= {
     "pairwiseFailedToGetRedirectURIs": "无法从服务器获得重定向URL",
     "pairwiseRedirectURIsMismatch": "客户端的重定向URI与服务器端获取的URI配置不匹配。"
   }
-} as const;
+};
 /* spell-checker: enable */

src/lib/i18n/generated_kcMessages/email.ts

@@ -2,7 +2,7 @@
 //PLEASE DO NOT EDIT MANUALLY
 
 /* spell-checker: disable */
-export const messages= {
+export const kcMessages= {
   "ca": {
     "emailVerificationSubject": "Verificació d'email",
     "emailVerificationBody": "Algú ha creat un compte de {2} amb aquesta adreça de correu electrònic. Si has estat tu, fes clic a l'enllaç següent per verificar la teva adreça de correu electrònic.\n\n{0}\n\nAquest enllaç expirarà en {1} minuts.\n\nSi tu no has creat aquest compte, simplement ignora aquest missatge.",
@@ -634,5 +634,5 @@ export const messages= {
     "eventUpdateTotpBody": "您账户的OTP 配置在{0} 由 {1}更改. 如非本人操作，请联系管理员。",
     "eventUpdateTotpBodyHtml": "<p>您账户的OTP 配置在{0} 由 {1}更改. 如非本人操作，请联系管理员。</p>"
   }
-} as const;
+};
 /* spell-checker: enable */

src/lib/i18n/generated_kcMessages/login.ts

@@ -2,7 +2,7 @@
 //PLEASE DO NOT EDIT MANUALLY
 
 /* spell-checker: disable */
-export const messages= {
+export const kcMessages= {
   "ca": {
     "doLogIn": "Inicia sessió",
     "doRegister": "Registra't",
@@ -4360,5 +4360,5 @@ export const messages= {
     "invalidParameterMessage": "无效的参数 : {0}",
     "alreadyLoggedIn": "您已经登录"
   }
-} as const;
+};
 /* spell-checker: enable */

src/lib/i18n/kcMessages/login.ts

@@ -0,0 +1,33 @@
+
+import { kcMessages } from "../generated_kcMessages/login";
+import { Evt } from "evt";
+import { objectKeys } from "evt/tools/typeSafety/objectKeys";
+
+export const evtTermsUpdated = Evt.asNonPostable(Evt.create<void>());
+
+objectKeys(kcMessages).forEach(kcLanguage =>
+    Object.defineProperty(
+        kcMessages[kcLanguage],
+        "termsText",
+        (() => {
+
+            let value = kcMessages[kcLanguage].termsText;
+
+            return {
+                "enumerable": true,
+                "get": () => value,
+                "set": (newValue: string) => {
+
+                    Evt.asPostable(evtTermsUpdated).post();
+
+                    value = newValue;
+                }
+            };
+
+
+        })()
+    )
+);
+
+export { kcMessages };
+

src/lib/i18n/useKcMessage.tsx

@@ -1,20 +1,26 @@
 
+import { useCallback, useReducer } from "react";
 import { useKcLanguageTag } from "./useKcLanguageTag";
-import { messages } from "./generated_messages/login";
-import { useConstCallback } from "powerhooks";
+import { kcMessages, evtTermsUpdated } from "./kcMessages/login";
 import type { ReactNode } from "react";
-import { id } from "evt/tools/typeSafety/id";
+import { useEvt } from "evt/hooks";
+//@ts-ignore
+import * as markdown from "markdown";
 
-export type MessageKey = keyof typeof messages["en"];
+export type MessageKey = keyof typeof kcMessages["en"];
 
 export function useKcMessage() {
 
     const { kcLanguageTag } = useKcLanguageTag();
 
-    const msgStr = useConstCallback(
+    const [trigger, forceUpdate] = useReducer((counter: number) => counter + 1, 0);
+
+    useEvt(ctx => evtTermsUpdated.attach(ctx, forceUpdate), []);
+
+    const msgStr = useCallback(
         (key: MessageKey, ...args: (string | undefined)[]): string => {
 
-            let str: string = messages[kcLanguageTag as any as "en"][key] ?? messages["en"][key];
+            let str: string = kcMessages[kcLanguageTag as any as "en"][key] ?? kcMessages["en"][key];
 
             args.forEach((arg, i) => {
 
@@ -28,14 +34,21 @@ export function useKcMessage() {
 
             return str;
 
-        }
+        },
+        [kcLanguageTag, trigger]
     );
 
-    const msg = useConstCallback(
-        id<(...args: Parameters<typeof msgStr>) => ReactNode>(
-            (key, ...args) =>
-                <span className={key} dangerouslySetInnerHTML={{ "__html": msgStr(key, ...args) }} />
-        )
+    const msg = useCallback<(...args: Parameters<typeof msgStr>) => ReactNode>(
+        (key, ...args) =>
+            <span
+                className={key}
+                dangerouslySetInnerHTML={{
+                    "__html":
+                        markdown.toHTML(msgStr(key, ...args))
+                }}
+            />
+        ,
+        [kcLanguageTag, trigger]
     );
 
     return { msg, msgStr };

src/lib/index.ts

@@ -3,6 +3,7 @@ export * from "./KcContext";
 export * from "./i18n/KcLanguageTag";
 export * from "./i18n/useKcLanguageTag";
 export * from "./i18n/useKcMessage";
+export * from "./i18n/kcMessages/login";
 
 export * from "./components/KcProps";
 export * from "./components/Login";
@@ -16,4 +17,5 @@ export * from "./keycloakJsAdapter";
 
 export * from "./tools/assert";
 
+
 export * as kcContextMocks from "./kcContextMocks";

src/lib/kcContext.ts

@@ -10,12 +10,18 @@ import type { LanguageLabel } from "./i18n/KcLanguageTag";
 type ExtractAfterStartingWith<Prefix extends string, StrEnum> =
     StrEnum extends `${Prefix}${infer U}` ? U : never;
 
+/** Take theses type definition with a grain of salt. 
+ * Some values might be undefined on some pages.
+ * (ex: url.loginAction is undefined on error.ftl)
+ */
 export type KcContext =
     KcContext.Login | KcContext.Register | KcContext.Info |
-    KcContext.Error | KcContext.LoginResetPassword | KcContext.LoginVerifyEmail;
+    KcContext.Error | KcContext.LoginResetPassword | KcContext.LoginVerifyEmail |
+    KcContext.Terms;
+
 export declare namespace KcContext {
 
-    export type Template = {
+    export type Common = {
         url: {
             loginAction: string;
             resourcesPath: string;
@@ -27,7 +33,7 @@ export declare namespace KcContext {
             displayName?: string;
             displayNameHtml?: string;
             internationalizationEnabled: boolean;
-            registrationEmailAsUsername: boolean; //<---
+            registrationEmailAsUsername: boolean;
         };
         /** Undefined if !realm.internationalizationEnabled */
         locale?: {
@@ -55,7 +61,7 @@ export declare namespace KcContext {
         isAppInitiatedAction: boolean;
     };
 
-    export type Login = Template & {
+    export type Login = Common & {
         pageId: "login.ftl";
         url: {
             loginResetCredentialsUrl: string;
@@ -88,7 +94,7 @@ export declare namespace KcContext {
         };
     };
 
-    export type Register = Template & {
+    export type Register = Common & {
         pageId: "register.ftl";
         url: {
             registrationAction: string;
@@ -120,7 +126,7 @@ export declare namespace KcContext {
         recaptchaSiteKey?: string;
     };
 
-    export type Info = Template & {
+    export type Info = Common & {
         pageId: "info.ftl";
         messageHeader?: string;
         requiredActions?: ExtractAfterStartingWith<"requiredAction.", MessageKey>[];
@@ -132,24 +138,28 @@ export declare namespace KcContext {
         }
     };
 
-    export type Error = Template & {
+    export type Error = Common & {
         pageId: "error.ftl";
         client?: {
             baseUrl?: string;
         }
     };
 
-    export type LoginResetPassword = Template & {
+    export type LoginResetPassword = Common & {
         pageId: "login-reset-password.ftl";
         realm: {
             loginWithEmailAllowed: boolean;
         }
     };
 
-    export type LoginVerifyEmail = Template & {
+    export type LoginVerifyEmail = Common & {
         pageId: "login-verify-email.ftl";
     };
 
+    export type Terms = Common & {
+        pageId: "terms.ftl";
+    };
+
 }
 
 doExtends<KcContext["pageId"], PageId>();

src/lib/kcContextMocks/index.ts

@@ -6,11 +6,11 @@ import { getKcLanguageTagLabel } from "../i18n/KcLanguageTag";
 //NOTE: Aside because we want to be able to import them from node
 import { resourcesCommonPath, resourcesPath } from "./urlResourcesPath";
 
-export const kcTemplateContext: KcContext.Template = {
+const kcCommonContext: KcContext.Common = {
     "url": {
         "loginAction": "#",
-        "resourcesPath": "/" + resourcesPath,
-        "resourcesCommonPath": "/" + resourcesCommonPath,
+        "resourcesPath": `${process.env["PUBLIC_URL"]}/${resourcesPath}`,
+        "resourcesCommonPath": `${process.env["PUBLIC_URL"]}/${resourcesCommonPath}`,
         "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",
     },
@@ -111,7 +111,7 @@ export const kcTemplateContext: KcContext.Template = {
 };
 
 Object.defineProperty(
-    kcTemplateContext.locale!,
+    kcCommonContext.locale!,
     "current",
     {
         "get": () => getKcLanguageTagLabel(getEvtKcLanguage().state),
@@ -120,22 +120,22 @@ Object.defineProperty(
 );
 
 export const kcLoginContext: KcContext.Login = {
-    ...kcTemplateContext,
+    ...kcCommonContext,
     "pageId": "login.ftl",
     "url": {
-        ...kcTemplateContext.url,
+        ...kcCommonContext.url,
         "loginResetCredentialsUrl": "/auth/realms/myrealm/login-actions/reset-credentials?client_id=account&tab_id=HoAx28ja4xg",
         "registrationUrl": "/auth/realms/myrealm/login-actions/registration?client_id=account&tab_id=HoAx28ja4xg"
     },
     "realm": {
-        ...kcTemplateContext.realm,
+        ...kcCommonContext.realm,
         "loginWithEmailAllowed": true,
         "rememberMe": true,
         "password": true,
         "resetPasswordAllowed": true,
         "registrationAllowed": true
     },
-    "auth": kcTemplateContext.auth!,
+    "auth": kcCommonContext.auth!,
     "social": {
         "displayInfo": true
     },
@@ -147,7 +147,7 @@ export const kcLoginContext: KcContext.Login = {
 };
 
 export const kcRegisterContext: KcContext.Register = {
-    ...kcTemplateContext,
+    ...kcCommonContext,
     "url": {
         ...kcLoginContext.url,
         "registrationAction": "http://localhost:8080/auth/realms/myrealm/login-actions/registration?session_code=gwZdUeO7pbYpFTRxiIxRg_QtzMbtFTKrNu6XW_f8asM&execution=12146ce0-b139-4bbd-b25b-0eccfee6577e&client_id=account&tab_id=uS8lYfebLa0"
@@ -166,7 +166,7 @@ export const kcRegisterContext: KcContext.Register = {
 };
 
 export const kcInfoContext: KcContext.Info ={
-    ...kcTemplateContext,
+    ...kcCommonContext,
     "pageId": "info.ftl",
     "messageHeader": "<Message header>",
     "requiredActions": undefined,
@@ -178,7 +178,7 @@ export const kcInfoContext: KcContext.Info ={
 };
 
 export const kcErrorContext: KcContext.Error = {
-    ...kcTemplateContext,
+    ...kcCommonContext,
     "pageId": "error.ftl",
     "client": {
         "baseUrl": "#"
@@ -186,16 +186,21 @@ export const kcErrorContext: KcContext.Error = {
 };
 
 export const kcLoginResetPasswordContext: KcContext.LoginResetPassword = {
-    ...kcTemplateContext,
+    ...kcCommonContext,
     "pageId": "login-reset-password.ftl",
     "realm":{
-        ...kcTemplateContext.realm,
+        ...kcCommonContext.realm,
         "loginWithEmailAllowed": false
     }
 };
 
 export const kcLoginVerifyEmailContext: KcContext.LoginVerifyEmail = {
-    ...kcTemplateContext,
+    ...kcCommonContext,
     "pageId": "login-verify-email.ftl"
 };
 
+export const kcTermContext: KcContext.Terms = {
+    ...kcCommonContext,
+    "pageId": "terms.ftl"
+};
+

src/lib/keycloakJsAdapter.ts

@@ -66,13 +66,12 @@ export function createKeycloakAdapter(
 
     return {
         "login": options => {
-            window.location.replace(
+            window.location.href= 
                 transformUrlBeforeRedirect(
                     keycloakInstance.createLoginUrl(
                         options
                     )
-                )
-            );
+                );
             return neverResolvingPromise;
         },
         "logout": options => {
@@ -86,13 +85,13 @@ export function createKeycloakAdapter(
             return neverResolvingPromise;
         },
         "register": options => {
-            window.location.replace(
+            window.location.href =
                 transformUrlBeforeRedirect(
                     keycloakInstance.createRegisterUrl(
                         options
                     )
-                )
-            );
+                );
+
             return neverResolvingPromise;
         },
         "accountManagement": () => {

src/test/generateKeycloakThemeResources.ts

@@ -1,7 +1,7 @@
 
 import { join as pathJoin } from "path";
 import { generateKeycloakThemeResources } from "../bin/build-keycloak-theme/generateKeycloakThemeResources";
-import { 
+import {
     setupSampleReactProject,
     sampleReactProjectDirPath
 } from "./setupSampleReactProject";
@@ -9,8 +9,9 @@ import {
 setupSampleReactProject();
 
 generateKeycloakThemeResources({
-    "themeName": "onyxia-ui",
+    "themeName": "keycloakify-demo-app",
     "reactAppBuildDirPath": pathJoin(sampleReactProjectDirPath, "build"),
-    "keycloakThemeBuildingDirPath": pathJoin(sampleReactProjectDirPath, "build_keycloak_theme")
+    "keycloakThemeBuildingDirPath": pathJoin(sampleReactProjectDirPath, "build_keycloak_theme"),
+    "urlPathname": "/keycloakify-demo-app/"
 });
 

src/test/replaceImportFromStatic.ts

@@ -1,11 +1,11 @@
 
 import { 
-    replaceImportFromStaticInJsCode,
-    replaceImportFromStaticInCssCode,
+    replaceImportsFromStaticInJsCode,
+    replaceImportsInCssCode,
     generateCssCodeToDefineGlobals
 } from "../bin/build-keycloak-theme/replaceImportFromStatic";
 
-const { fixedJsCode } = replaceImportFromStaticInJsCode({
+const { fixedJsCode } = replaceImportsFromStaticInJsCode({
     "ftlValuesGlobalName": "keycloakFtlValues",
     "jsCode": `
         function f() {
@@ -24,7 +24,7 @@ const { fixedJsCode } = replaceImportFromStaticInJsCode({
 
 console.log({ fixedJsCode });
 
-const { fixedCssCode, cssGlobalsToDefine } = replaceImportFromStaticInCssCode({
+const { fixedCssCode, cssGlobalsToDefine } = replaceImportsInCssCode({
     "cssCode": `
 
     .my-div {
@@ -45,6 +45,6 @@ const { fixedCssCode, cssGlobalsToDefine } = replaceImportFromStaticInCssCode({
 console.log({ fixedCssCode, cssGlobalsToDefine });
 
 
-const { cssCodeToPrependInHead } = generateCssCodeToDefineGlobals({ cssGlobalsToDefine });
+const { cssCodeToPrependInHead } = generateCssCodeToDefineGlobals({ cssGlobalsToDefine, "urlPathname": "/" });
 
 console.log({ cssCodeToPrependInHead });

yarn.lock

@@ -747,10 +747,10 @@ path@^0.12.7:
     process "^0.11.1"
     util "^0.10.3"
 
-powerhooks@^0.0.27:
-  version "0.0.27"
-  resolved "https://registry.yarnpkg.com/powerhooks/-/powerhooks-0.0.27.tgz#e9dc29258860d2f6bf32b249d9cba07c6f53f393"
-  integrity sha512-ohayWhtIEdLqiC2th/GEhaRfOhqekFg2uFo0JZ8Dn7oTnAZybs618QJeq5ag9oy3lFVzl+kbROpVa8Ch5zrkaA==
+powerhooks@^0.0.36:
+  version "0.0.36"
+  resolved "https://registry.yarnpkg.com/powerhooks/-/powerhooks-0.0.36.tgz#d973d339ad8ca7ce52ea9d288ebe8e138df7d769"
+  integrity sha512-0fEGKLfJmuFeEYDGsAlTuvGKKdqOH059xezosmYRoGurfC1bbUlaNJD+TuzOT5cTGURi88DCLcDnhk/2eLyCyA==
   dependencies:
     evt "2.0.0-beta.15"
     memoizee "^0.4.15"
@@ -927,10 +927,10 @@ to-fast-properties@^2.0.0:
   resolved "https://registry.yarnpkg.com/to-fast-properties/-/to-fast-properties-2.0.0.tgz#dc5e698cbd079265bc73e0377681a4e4e83f616e"
   integrity sha1-3F5pjL0HkmW8c+A3doGk5Og/YW4=
 
-tss-react@^0.0.11:
-  version "0.0.11"
-  resolved "https://registry.yarnpkg.com/tss-react/-/tss-react-0.0.11.tgz#1cd061927744cd4fc9b7346e2fd1cfcf896a18d5"
-  integrity sha512-j8CDpHHIl6S6/mX+AmK08v7waPqwgNA7urHOD3qknCgbY79LRlS7he5DF4NUNE/5B4/Btc3F25w+KqgChNbyGw==
+tss-react@^0.0.12:
+  version "0.0.12"
+  resolved "https://registry.yarnpkg.com/tss-react/-/tss-react-0.0.12.tgz#6463617ae5e7f670742e48e497d8825d59e2a2e9"
+  integrity sha512-oHekukqdaE71uhHx4XEdHy6aMnDYhoHLWB94iy2Fy9X8btH2lJH1joPj0zS1q7+1Xy2TydkLEZsTq3ElVd7ZqA==
   dependencies:
     "@emotion/css" "^11.1.3"