keycloakify 2.2.0 → 2.5.1

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+### **2.5.1** (2021-10-13)  
+  
+- Update tss-react    
+  
+## **2.5.0** (2021-10-12)  
+  
+- register-user-profile.ftl tested working  
+- Make kcMessage more easily hackable  
+- fix useKcMessage  
+- Implement and type validators  
+- Remove syntax error in ftl and make it more directly debugable  
+- Support register-user-profile.ftl    
+  
+## **2.4.0** (2021-10-08)  
+  
+-  #38: Implement messagesPerField existsError and get    
+  
+## **2.3.0** (2021-10-07)  
+  
+- #20: Support advancedMsg    
+  
 ## **2.2.0** (2021-10-07)  
   
 - Feat scrip: download-builtin-keycloak-theme for downloading any version of the builtin themes  

package/README.md

@@ -20,17 +20,32 @@
     <img src="https://user-images.githubusercontent.com/6702424/110260457-a1c3d380-7fac-11eb-853a-80459b65626b.png">
 </p>
 
-**NEW in v2**  
-- It's now possible to implement custom `.ftl` pages.
-- Support for Keycloak plugins that introduce non standard ftl values. 
-  (Like for example [this plugin](https://github.com/micedre/keycloak-mail-whitelisting) that define `authorizedMailDomains` in `register.ftl`).
+**NEW in v2.5**
+
+-   User Profile ([`register-user-profile.ftl`](https://github.com/InseeFrLab/keycloakify/blob/main/src/lib/components/RegisterUserProfile.tsx))
+    is now supported! 🎉  
+    It enables to [define, from the admin console](https://user-images.githubusercontent.com/6702424/136872461-1f5b64ef-d2ef-4c6b-bb8d-07d4729552b3.png),
+    what information you want to collect on your users in the register page and to validate inputs
+    [**on the frontend**, in realtime](https://github.com/InseeFrLab/keycloakify/blob/6dca6a93d8cfe634ee4d8574ad0c091641220092/src/lib/getKcContext/KcContextBase.ts#L225-L261)!  
+    NOTE: User profile is only available in Keycloak 15 and it's a beta feature that
+    [needs to be enabled when launching keycloak](https://github.com/InseeFrLab/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/bin/build-keycloak-theme/build-keycloak-theme.ts#L116-L117) and [enabled in the console](https://user-images.githubusercontent.com/6702424/136874428-b071d614-c7f7-440d-9b2e-670faadc0871.png).
+-   Feature [Use advanced message](https://github.com/InseeFrLab/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/lib/i18n/useKcMessage.tsx#L53-L66)
+    and [`messagesPerFields`](https://github.com/InseeFrLab/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/lib/getKcContext/KcContextBase.ts#L70-L75) (implementation [here](https://github.com/InseeFrLab/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/bin/build-keycloak-theme/generateFtl/common.ftl#L130-L189))
+-   Test container now uses Keycloak version `15.0.2`.
+
+**NEW in v2**
+
+-   It's now possible to implement custom `.ftl` pages.
+-   Support for Keycloak plugins that introduce non standard ftl values.
+    (Like for example [this plugin](https://github.com/micedre/keycloak-mail-whitelisting) that define `authorizedMailDomains` in `register.ftl`).
+
 # Motivations
 
 Keycloak provides [theme support](https://www.keycloak.org/docs/latest/server_development/#_themes) for web pages. This allows customizing the look and feel of end-user facing pages so they can be integrated with your applications.
 It involves, however, a lot of raw JS/CSS/[FTL]() hacking, and bundling the theme is not exactly straightforward.
 
 Beyond that, if you use Keycloak for a specific app you want your login page to be tightly integrated with it.
-Ideally, you don't want the user to notice when he is being redirected away. 
+Ideally, you don't want the user to notice when he is being redirected away.
 
 Trying to reproduce the look and feel of a specific app in another stack is not an easy task not to mention
 the cheer amount of maintenance that it involves.
@@ -47,69 +62,72 @@ Here is `keycloakify` for you 🍸
     <i> <a href="https://datalab.sspcloud.fr">With keycloakify:</a> </i> 
     <br>
     <img src="https://user-images.githubusercontent.com/6702424/114332075-c5e37900-9b45-11eb-910b-48a05b3d90d9.gif">
-</p>  
+</p>
 
-**TL;DR**: [Here](https://github.com/garronej/keycloakify-demo-app) is a Hello World React project with Keycloakify set up.  
+**TL;DR**: [Here](https://github.com/garronej/keycloakify-demo-app) is a Hello World React project with Keycloakify set up.
 
 If you already have a Keycloak custom theme, it can be easily ported to Keycloakify.
 
 ---
 
-
-- [Motivations](#motivations)
-- [Requirements](#requirements)
-  - [My framework doesn’t seem to be supported, what can I do?](#my-framework-doesnt-seem-to-be-supported-what-can-i-do)
-- [How to use](#how-to-use)
-  - [Setting up the build tool](#setting-up-the-build-tool)
-    - [Changing just the look of the default Keycloak theme](#changing-just-the-look-of-the-default-keycloak-theme)
-    - [Advanced pages configuration](#advanced-pages-configuration)
-    - [Hot reload](#hot-reload)
-  - [Enable loading in a blink of an eye of login pages ⚡ (--external-assets)](#enable-loading-in-a-blink-of-an-eye-of-login-pages----external-assets)
-- [Support for Terms and conditions](#support-for-terms-and-conditions)
-- [Some pages still have the default theme. Why?](#some-pages-still-have-the-default-theme-why)
-- [GitHub Actions](#github-actions)
-- [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)
-    - [Possible workarounds](#possible-workarounds)
-- [Implement context persistence (optional)](#implement-context-persistence-optional)
-- [Kickstart video](#kickstart-video)
-- [About the errors related to `objectToJson` in Keycloak logs.](#about-the-errors-related-to-objecttojson-in-keycloak-logs)
-- [Email domain whitelist](#email-domain-whitelist)
-
-# 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)  
-- Tests ongoing with [14.0.0](https://hub.docker.com/layers/jboss/keycloak/14.0.0/images/sha256-ca713e87ad163da71ab329010de2464a41ff030a25ae0aef15c1c290252f3d7f?context=explore) 
-
-This tool will be maintained to stay compatible with Keycloak v11 and up, however, the default pages you will get 
+-   [Motivations](#motivations)
+-   [Requirements](#requirements)
+    -   [My framework doesn’t seem to be supported, what can I do?](#my-framework-doesnt-seem-to-be-supported-what-can-i-do)
+-   [How to use](#how-to-use)
+    -   [Setting up the build tool](#setting-up-the-build-tool)
+        -   [Changing just the look of the default Keycloak theme](#changing-just-the-look-of-the-default-keycloak-theme)
+        -   [Advanced pages configuration](#advanced-pages-configuration)
+        -   [Hot reload](#hot-reload)
+    -   [Enable loading in a blink of an eye of login pages ⚡ (--external-assets)](#enable-loading-in-a-blink-of-an-eye-of-login-pages----external-assets)
+-   [Support for Terms and conditions](#support-for-terms-and-conditions)
+-   [Some pages still have the default theme. Why?](#some-pages-still-have-the-default-theme-why)
+-   [GitHub Actions](#github-actions)
+-   [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)
+        -   [Possible workarounds](#possible-workarounds)
+-   [Implement context persistence (optional)](#implement-context-persistence-optional)
+-   [Kickstart video](#kickstart-video)
+-   [About the errors related to `objectToJson` in Keycloak logs.](#about-the-errors-related-to-objecttojson-in-keycloak-logs)
+-   [Adding custom message (to `i18n/useKcMessage.tsx`)](#adding-custom-message-to-i18nusekcmessagetsx)
+-   [Email domain whitelist](#email-domain-whitelist)
+
+# 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)
+-   [15.0.2](https://hub.docker.com/layers/jboss/keycloak/15.0.2/images/sha256-d8ed1ee5df42a178c341f924377da75db49eab08ea9f058ff39a8ed7ee05ec93?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 Keycloak v11.
 
 This tool 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. 
+and a `build/static/` directory generated by webpack.
 For more information see [this issue](https://github.com/InseeFrLab/keycloakify/issues/5#issuecomment-832296432)
 
 **All this is defaults with [`create-react-app`](https://create-react-app.dev)** (tested with 4.0.3)
 
-- `mvn` ([Maven](https://maven.apache.org/)), `rm`, `mkdir`, `wget`, `unzip` are assumed to be available.
-- `docker` must be up and running when running `yarn keycloak`.
+-   `mvn` ([Maven](https://maven.apache.org/)), `rm`, `mkdir`, `wget`, `unzip` are assumed to be available.
+-   `docker` must be up and running when running `yarn keycloak`.
 
 On Windows you'll have to use [WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
 
-## My framework doesn’t seem to be supported, what can I do?  
+## My framework doesn’t seem to be supported, what can I do?
 
 Currently Keycloakify is only compatible with `create-react-app` apps.
-It doesn’t mean that you can't use Keycloakify if you are using Next.js, Express or any other 
+It doesn’t mean that you can't use Keycloakify if you are using Next.js, Express or any other
 framework that involves SSR but your Keycloak theme will need to be a standalone project.  
-Find specific instructions about how to get started [**here**](https://github.com/garronej/keycloakify-demo-app#keycloak-theme-only).  
+Find specific instructions about how to get started [**here**](https://github.com/garronej/keycloakify-demo-app#keycloak-theme-only).
 
 To share your styles between your main app and your login pages you will need to externalize your design system by making it a
 separate module. Checkout [ts_ci](https://github.com/garronej/ts_ci), it can help with that.
+
 # How to use
+
 ## Setting up the build tool
 
 ```bash
@@ -117,6 +135,7 @@ yarn add keycloakify
 ```
 
 [`package.json`](https://github.com/garronej/keycloakify-demo-app/blob/main/package.json)
+
 ```json
 "scripts": {
     "keycloak": "yarn build && build-keycloak-theme",
@@ -135,14 +154,15 @@ The first approach is to only customize the style of the default Keycloak login
 your own class names.
 
 If you have created a new React project specifically to create a Keycloak theme and nothing else then
-your index should look something like:  
+your index should look something like:
 
 `src/index.tsx`
+
 ```tsx
 import { App } from "./<wherever>/App";
-import { 
-  KcApp, 
-  defaultKcProps, 
+import {
+  KcApp,
+  defaultKcProps,
   getKcContext
 } from "keycloakify";
 import { css } from "tss-react/@emotion/css";
@@ -152,59 +172,57 @@ const { kcContext } = getKcContext();
 const myClassName = css({ "color": "red" });
 
 reactDom.render(
-        <KcApp 
-            kcContext={kcContext} 
+        <KcApp
+            kcContext={kcContext}
             {...{
                 ...defaultKcProps,
                 "kcHeaderWrapperClass": myClassName
-            }} 
+            }}
         />
     document.getElementById("root")
 );
 ```
 
 If you share a unique project for your app and the Keycloak theme, your index should look
-more like this: 
+more like this:
 
 `src/index.tsx`
+
 ```tsx
-import { App } from "./<wherever>/App";
-import { 
-  KcApp, 
-  defaultKcProps, 
-  getKcContext
-} from "keycloakify";
-import { css } from "tss-react/@emotion/css";
+import { App } from "./<wherever>/App";
+import { KcApp, defaultKcProps, getKcContext } from "keycloakify";
+import { css } from "tss-react/@emotion/css";
 
 const { kcContext } = getKcContext();
 
 const myClassName = css({ "color": "red" });
 
 reactDom.render(
-    // Unless the app is currently being served by Keycloak 
+    // Unless the app is currently being served by Keycloak
     // kcContext is undefined.
-    kcContext !== undefined ? 
-        <KcApp 
-            kcContext={kcContext} 
+    kcContext !== undefined ? (
+        <KcApp
+            kcContext={kcContext}
             {...{
                 ...defaultKcProps,
-                "kcHeaderWrapperClass": myClassName
-            }} 
-        /> :
-        <App />, // Your actual app
-    document.getElementById("root")
+                "kcHeaderWrapperClass": myClassName,
+            }}
+        />
+    ) : (
+        <App />
+    ), // Your actual app
+    document.getElementById("root"),
 );
 ```
 
-
 <p align="center">
     <i>result:</i></br>
     <img src="https://user-images.githubusercontent.com/6702424/114326299-6892fc00-9b34-11eb-8d75-85696e55458f.png">
 </p>
 
-Example of a customization using only CSS: [here](https://github.com/InseeFrLab/onyxia-ui/blob/012639d62327a9a56be80c46e32c32c9497b82db/src/app/components/KcApp.tsx) 
+Example of a customization using only CSS: [here](https://github.com/InseeFrLab/onyxia-ui/blob/012639d62327a9a56be80c46e32c32c9497b82db/src/app/components/KcApp.tsx)
 (the [index.tsx](https://github.com/InseeFrLab/onyxia-ui/blob/012639d62327a9a56be80c46e32c32c9497b82db/src/app/index.tsx#L89-L94) )
-and the result you can expect: 
+and the result you can expect:
 
 <p align="center">
     <i> <a href="https://datalab.sspcloud.fr">Customization using only CSS:</a> </i> 
@@ -214,36 +232,39 @@ and the result you can expect:
 
 ### Advanced pages configuration
 
-If you want to go beyond only customizing the CSS you can re-implement some of the 
-pages or even add new ones. 
+If you want to go beyond only customizing the CSS you can re-implement some of the
+pages or even add new ones.
 
 If you want to go this way checkout the demo setup provided [here](https://github.com/garronej/keycloakify-demo-app/tree/look_and_feel).
-If you prefer a real life example you can checkout [onyxia-web's source](https://github.com/InseeFrLab/onyxia-web/tree/main/src/app/components/KcApp). 
+If you prefer a real life example you can checkout [onyxia-web's source](https://github.com/InseeFrLab/onyxia-web/tree/main/src/app/components/KcApp).
 The web app is in production [here](https://datalab.sspcloud.fr).
 
 Main takeaways are:
-- You must declare your custom pages in the package.json. [example](https://github.com/garronej/keycloakify-demo-app/blob/4eb2a9f63e9823e653b2d439495bda55e5ecc134/package.json#L17-L22)
-- (TS only) You must declare theses page in the type argument of the getter 
-  function for the `kcContext` in order to have the correct typings. [example](https://github.com/garronej/keycloakify-demo-app/blob/4eb2a9f63e9823e653b2d439495bda55e5ecc134/src/KcApp/kcContext.ts#L16-L21)
-- (TS only) If you use Keycloak plugins that defines non standard `.ftl` values
-  (Like for example [this plugin](https://github.com/micedre/keycloak-mail-whitelisting) 
-  that define `authorizedMailDomains` in `register.ftl`) you should 
-  declare theses value to get the type. [example](https://github.com/garronej/keycloakify-demo-app/blob/4eb2a9f63e9823e653b2d439495bda55e5ecc134/src/KcApp/kcContext.ts#L6-L13)
-- You should provide sample data for all the non standard value if you want to be able
-  to debug the page outside of keycloak. [example](https://github.com/garronej/keycloakify-demo-app/blob/4eb2a9f63e9823e653b2d439495bda55e5ecc134/src/KcApp/kcContext.ts#L28-L43)
+
+-   You must declare your custom pages in the package.json. [example](https://github.com/garronej/keycloakify-demo-app/blob/4eb2a9f63e9823e653b2d439495bda55e5ecc134/package.json#L17-L22)
+-   (TS only) You must declare theses page in the type argument of the getter
+    function for the `kcContext` in order to have the correct typings. [example](https://github.com/garronej/keycloakify-demo-app/blob/4eb2a9f63e9823e653b2d439495bda55e5ecc134/src/KcApp/kcContext.ts#L16-L21)
+-   (TS only) If you use Keycloak plugins that defines non standard `.ftl` values
+    (Like for example [this plugin](https://github.com/micedre/keycloak-mail-whitelisting)
+    that define `authorizedMailDomains` in `register.ftl`) you should
+    declare theses value to get the type. [example](https://github.com/garronej/keycloakify-demo-app/blob/4eb2a9f63e9823e653b2d439495bda55e5ecc134/src/KcApp/kcContext.ts#L6-L13)
+-   You should provide sample data for all the non standard value if you want to be able
+    to debug the page outside of keycloak. [example](https://github.com/garronej/keycloakify-demo-app/blob/4eb2a9f63e9823e653b2d439495bda55e5ecc134/src/KcApp/kcContext.ts#L28-L43)
 
 WARNING: If you chose to go this way use:
+
 ```json
 "dependencies": {
     "keycloakify": "~X.Y.Z"
 }
 ```
+
 in your `package.json` instead of `^X.Y.Z`. A minor update of Keycloakify might break your app.
 
 ### Hot reload
 
 Rebuild the theme each time you make a change to see the result is not practical.
-If you want to test your login screens outside of Keycloak you can mock a given `kcContext`: 
+If you want to test your login screens outside of Keycloak you can mock a given `kcContext`:
 
 ```tsx
 import {
@@ -257,9 +278,9 @@ const { kcContext } = getKcContext({
 });
 
 reactDom.render(
-        <KcApp 
+        <KcApp
             kcContext={kcContextMocks.kcLoginContext}
-            {...defaultKcProps} 
+            {...defaultKcProps}
         />
     document.getElementById("root")
 );
@@ -274,15 +295,15 @@ Checkout [this concrete example](https://github.com/garronej/keycloakify-demo-ap
 By default the theme generated is standalone. Meaning that when your users
 reach the login pages all scripts, images and stylesheet are downloaded from the Keycloak server.  
 If you are specifically building a theme to integrate with an app or a website that allows users
-to first browse unauthenticated before logging in, you will get a significant 
+to first browse unauthenticated before logging in, you will get a significant
 performance boost if you jump through those hoops:
 
-- Provide the url of your app in the `homepage` field of package.json. [ex](https://github.com/garronej/keycloakify-demo-app/blob/7847cc70ef374ab26a6cc7953461cf25603e9a6d/package.json#L2)
-- Build the theme using `npx build-keycloak-theme --external-assets` [ex](https://github.com/garronej/keycloakify-demo-app/blob/7847cc70ef374ab26a6cc7953461cf25603e9a6d/.github/workflows/ci.yaml#L21)
-- Enable [long-term assets caching](https://create-react-app.dev/docs/production-build/#static-file-caching) on the server hosting your app.
-- Make sure not to build your app and the keycloak theme separately
-  and remember to update the Keycloak theme every time you update your app.
-- Be mindful that if your app is down your login pages are down as well.
+-   Provide the url of your app in the `homepage` field of package.json. [ex](https://github.com/garronej/keycloakify-demo-app/blob/7847cc70ef374ab26a6cc7953461cf25603e9a6d/package.json#L2)
+-   Build the theme using `npx build-keycloak-theme --external-assets` [ex](https://github.com/garronej/keycloakify-demo-app/blob/7847cc70ef374ab26a6cc7953461cf25603e9a6d/.github/workflows/ci.yaml#L21)
+-   Enable [long-term assets caching](https://create-react-app.dev/docs/production-build/#static-file-caching) on the server hosting your app.
+-   Make sure not to build your app and the keycloak theme separately
+    and remember to update the Keycloak theme every time you update your app.
+-   Be mindful that if your app is down your login pages are down as well.
 
 Checkout a complete setup [here](https://github.com/garronej/keycloakify-demo-app#about-keycloakify)
 
@@ -308,51 +329,51 @@ If you need to customize pages that are not supported yet or if you need to impl
 
 [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).
+
 # 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). 
+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
 
-If you are building the theme with [--external-assets](#enable-loading-in-a-blink-of-a-eye-of-login-pages-) 
+If you are building the theme with [--external-assets](#enable-loading-in-a-blink-of-a-eye-of-login-pages-)
 this limitation doesn't apply, you can import fonts however you see fit.
 
-### Example of setup that **won't** work 
+### 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.  
+-   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.
 
-### Possible workarounds  
+### Possible workarounds
 
-- Use [`--external-assets`](#enable-loading-in-a-blink-of-a-eye-of-login-pages-).
-- 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](https://github.com/InseeFrLab/onyxia-ui/blob/0e3a04610cfe872ca71dad59e05ced8f785dee4b/public/index.html#L6-L51).  
-- You can also [use non relative 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).
+-   Use [`--external-assets`](#enable-loading-in-a-blink-of-a-eye-of-login-pages-).
+-   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](https://github.com/InseeFrLab/onyxia-ui/blob/0e3a04610cfe872ca71dad59e05ced8f785dee4b/public/index.html#L6-L51).
+-   You can also [use non relative 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 
+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
-the login or register pages.  
-  
+the login or register pages.
+
 Same goes for the dark mode, you don't want, if the user had it enabled
-to show the login page with light themes.  
-  
+to show the login page with light themes.
+
 The problem is that you are probably using `localStorage` to persist theses values across
 reload but, as the Keycloak pages are not served on the same domain that the rest of your
-app you won't be able to carry over states using `localStorage`.  
+app you won't be able to carry over states using `localStorage`.
 
 The only reliable solution is to inject parameters into the URL before
-redirecting to Keycloak. We integrate with 
-[`keycloak-js`](https://github.com/keycloak/keycloak-documentation/blob/master/securing_apps/topics/oidc/javascript-adapter.adoc), 
+redirecting to Keycloak. We integrate with
+[`keycloak-js`](https://github.com/keycloak/keycloak-documentation/blob/master/securing_apps/topics/oidc/javascript-adapter.adoc),
 by providing you a way to tell `keycloak-js` that you would like to inject
-some search parameters before redirecting.  
+some search parameters before redirecting.
 
 The method also works with [`@react-keycloak/web`](https://www.npmjs.com/package/@react-keycloak/web) (use the `initOptions`).
 
@@ -368,23 +389,23 @@ Note that the states are automatically restored on the other side by `powerhooks
 ```typescript
 import keycloak_js from "keycloak-js";
 import { injectGlobalStatesInSearchParams } from "powerhooks/useGlobalState";
-import { createKeycloakAdapter } from "keycloakify";
+import { createKeycloakAdapter } from "keycloakify";
 
 //...
 
 const keycloakInstance = keycloak_js({
     "url": "http://keycloak-server/auth",
     "realm": "myrealm",
-    "clientId": "myapp"
+    "clientId": "myapp",
 });
 
 keycloakInstance.init({
-    "onLoad": 'check-sso',
+    "onLoad": "check-sso",
     "silentCheckSsoRedirectUri": window.location.origin + "/silent-check-sso.html",
     "adapter": createKeycloakAdapter({
         "transformUrlBeforeRedirect": injectGlobalStatesInSearchParams,
-        keycloakInstance
-    })
+        keycloakInstance,
+    }),
 });
 
 //...
@@ -396,12 +417,13 @@ flash of the blank html before the js bundle have been evaluated
 
 # Kickstart video
 
-*NOTE: keycloak-react-theming was renamed keycloakify since this video was recorded*
+_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)
 
-# About the errors related to `objectToJson` in Keycloak logs.  
+# About the errors related to `objectToJson` in Keycloak logs.
+
+The logs of your keycloak server will always show this kind of errors every time a client request a page:
 
-The logs of your keycloak server will always show this kind of errors every time a client request a page:  
 ```log
 FTL stack trace ("~" means nesting-related):
         - Failed at: #local value = object[key]  [in template "login.ftl" in macro "objectToJson" at line 70, column 21]
@@ -410,13 +432,20 @@ FTL stack trace ("~" means nesting-related):
         - Reached through: @compress  [in template "login.ftl" in macro "objectToJson" at line 36, column 5]
         - Reached through: @objectToJson object=(.data_model) de...  [in template "login.ftl" at line 163, column 43]
 ```
-Theses are expected and can be safely ignored.  
 
-To [converts the `.ftl` values into a JavaScript object](https://github.com/InseeFrLab/keycloakify/blob/main/src/bin/build-keycloak-theme/generateFtl/common.ftl) 
+Theses are expected and can be safely ignored.
+
+To [converts the `.ftl` values into a JavaScript object](https://github.com/InseeFrLab/keycloakify/blob/main/src/bin/build-keycloak-theme/generateFtl/common.ftl)
 without making assumptions on the `.data_model` we have to do things that throws.  
 It's all-right though because every statement that can fail is inside an `<#attempt><#recorver>` block but it results in errors being printed to the logs.
 
+# Adding custom message (to `i18n/useKcMessage.tsx`)
+
+You can reproduce [this approach](https://github.com/garronej/keycloakify-demo-app/blob/main/src/kcMessagesExtension.ts)
+( don't forget to [evaluate the code](https://github.com/garronej/keycloakify-demo-app/blob/0a6d349dba89a5702f98ba48bca6c76ac7265e1f/src/index.tsx#L15) ).  
+This approach is a bit hacky as it doesn't provide type safety but it works.
+
 # Email domain whitelist
 
-If you want to restrict the emails domain that can register, you can use [this plugin](https://github.com/micedre/keycloak-mail-whitelisting) 
+If you want to restrict the emails domain that can register, you can use [this plugin](https://github.com/micedre/keycloak-mail-whitelisting)
 and `kcRegisterContext["authorizedMailDomains"]` to validate on.

package/bin/KeycloakVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"KeycloakVersion.js","sourceRoot":"","sources":["../src/bin/KeycloakVersion.ts"],"names":[],"mappings":";;;AACa,QAAA,gBAAgB,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAU,CAAC"}
+{"version":3,"file":"KeycloakVersion.js","sourceRoot":"","sources":["../src/bin/KeycloakVersion.ts"],"names":[],"mappings":";;;AAAa,QAAA,gBAAgB,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAU,CAAC"}