Merge branch 'main' of https://github.com/InseeFrLab/keycloakify

.github/workflows/ci.yaml

@@ -3,11 +3,9 @@ on:
   push:
     branches:
       - main
-      - v6
   pull_request:
     branches:
       - main
-      - v6
 
 jobs:
 

README.md

@@ -2,7 +2,7 @@
     <img src="https://user-images.githubusercontent.com/6702424/109387840-eba11f80-7903-11eb-9050-db1dad883f78.png">  
 </p>
 <p align="center">
-    <i>🔏  Create Keycloak themes using React 🔏</i>
+    <i>🔏 Create Keycloak themes using React 🔏</i>
     <br>
     <br>
     <a href="https://github.com/garronej/keycloakify/actions">
@@ -36,6 +36,10 @@
     <img src="https://user-images.githubusercontent.com/6702424/110260457-a1c3d380-7fac-11eb-853a-80459b65626b.png">
 </p>
 
+> 🗣 V6 have been released 🎉  
+> [It features major improvements](https://github.com/InseeFrLab/keycloakify#600).  
+> Checkout [the migration guide](https://docs.keycloakify.dev/v5-to-v6).
+
 # Changelog highlights
 
 ## 6.0.0
@@ -45,7 +49,7 @@
 -   Real i18n API.
 -   Actual documentation for build options.
 
-Checkout the migration guide.
+Checkout [the migration guide](https://docs.keycloakify.dev/v5-to-v6)
 
 ## 5.8.0
 

package.json

@@ -1,6 +1,6 @@
 {
     "name": "keycloakify",
-    "version": "6.0.0-beta.10",
+    "version": "6.0.1",
     "description": "Keycloak theme generator for Reacts app",
     "repository": {
         "type": "git",
@@ -83,7 +83,7 @@
         "react-markdown": "^5.0.3",
         "scripting-tools": "^0.19.13",
         "tsafe": "^1.0.1",
-        "tss-react": "^4.0.0",
+        "tss-react": "^4.1.1",
         "zod": "^3.17.10"
     }
 }

src/bin/keycloakify/BuildOptions.ts

@@ -11,7 +11,7 @@ type ParsedPackageJson = {
     keycloakify?: {
         extraPages?: string[];
         extraThemeProperties?: string[];
-        isAppAndKeycloakServerSharingSameDomain?: boolean;
+        areAppAndKeycloakServerSharingSameDomain?: boolean;
     };
 };
 
@@ -23,7 +23,7 @@ const zParsedPackageJson = z.object({
         .object({
             "extraPages": z.array(z.string()).optional(),
             "extraThemeProperties": z.array(z.string()).optional(),
-            "isAppAndKeycloakServerSharingSameDomain": z.boolean().optional()
+            "areAppAndKeycloakServerSharingSameDomain": z.boolean().optional()
         })
         .optional()
 });
@@ -56,11 +56,11 @@ export namespace BuildOptions {
         };
 
         export type SameDomain = CommonExternalAssets & {
-            isAppAndKeycloakServerSharingSameDomain: true;
+            areAppAndKeycloakServerSharingSameDomain: true;
         };
 
         export type DifferentDomains = CommonExternalAssets & {
-            isAppAndKeycloakServerSharingSameDomain: false;
+            areAppAndKeycloakServerSharingSameDomain: false;
             urlOrigin: string;
             urlPathname: string | undefined;
         };
@@ -140,10 +140,10 @@ export function readBuildOptions(params: {
             "isStandalone": false
         });
 
-        if (parsedPackageJson.keycloakify?.isAppAndKeycloakServerSharingSameDomain) {
+        if (parsedPackageJson.keycloakify?.areAppAndKeycloakServerSharingSameDomain) {
             return id<BuildOptions.ExternalAssets.SameDomain>({
                 ...commonExternalAssets,
-                "isAppAndKeycloakServerSharingSameDomain": true
+                "areAppAndKeycloakServerSharingSameDomain": true
             });
         } else {
             assert(
@@ -155,14 +155,14 @@ export function readBuildOptions(params: {
                     "public/CNAME file.",
                     "Alternatively, if your app and the Keycloak server are on the same domain, ",
                     "eg https://example.com is your app and https://example.com/auth is the keycloak",
-                    'admin UI, you can set "keycloakify": { "isAppAndKeycloakServerSharingSameDomain": true }',
+                    'admin UI, you can set "keycloakify": { "areAppAndKeycloakServerSharingSameDomain": true }',
                     "in your package.json"
                 ].join(" ")
             );
 
             return id<BuildOptions.ExternalAssets.DifferentDomains>({
                 ...commonExternalAssets,
-                "isAppAndKeycloakServerSharingSameDomain": false,
+                "areAppAndKeycloakServerSharingSameDomain": false,
                 "urlOrigin": url.origin,
                 "urlPathname": url.pathname
             });

src/bin/keycloakify/generateFtl/generateFtl.ts

@@ -46,11 +46,11 @@ export namespace BuildOptionsLike {
         };
 
         export type SameDomain = CommonExternalAssets & {
-            isAppAndKeycloakServerSharingSameDomain: true;
+            areAppAndKeycloakServerSharingSameDomain: true;
         };
 
         export type DifferentDomains = CommonExternalAssets & {
-            isAppAndKeycloakServerSharingSameDomain: false;
+            areAppAndKeycloakServerSharingSameDomain: false;
             urlOrigin: string;
             urlPathname: string | undefined;
         };
@@ -76,7 +76,7 @@ export function generateFtlFilesCodeFactory(params: {
     const $ = cheerio.load(indexHtmlCode);
 
     fix_imports_statements: {
-        if (!buildOptions.isStandalone && buildOptions.isAppAndKeycloakServerSharingSameDomain) {
+        if (!buildOptions.isStandalone && buildOptions.areAppAndKeycloakServerSharingSameDomain) {
             break fix_imports_statements;
         }
 

src/bin/keycloakify/generateKeycloakThemeResources.ts

@@ -34,11 +34,11 @@ export namespace BuildOptionsLike {
         };
 
         export type SameDomain = CommonExternalAssets & {
-            isAppAndKeycloakServerSharingSameDomain: true;
+            areAppAndKeycloakServerSharingSameDomain: true;
         };
 
         export type DifferentDomains = CommonExternalAssets & {
-            isAppAndKeycloakServerSharingSameDomain: false;
+            areAppAndKeycloakServerSharingSameDomain: false;
             urlOrigin: string;
             urlPathname: string | undefined;
         };
@@ -97,7 +97,7 @@ export function generateKeycloakThemeResources(params: {
             }
 
             if (/\.js?$/i.test(filePath)) {
-                if (!buildOptions.isStandalone && buildOptions.isAppAndKeycloakServerSharingSameDomain) {
+                if (!buildOptions.isStandalone && buildOptions.areAppAndKeycloakServerSharingSameDomain) {
                     return undefined;
                 }
 

src/bin/keycloakify/replacers/replaceImportsFromStaticInJsCode.ts

@@ -41,10 +41,10 @@ export function replaceImportsFromStaticInJsCode(params: { jsCode: string; build
     const { jsCode, buildOptions } = params;
 
     const getReplaceArgs = (language: "js" | "css"): Parameters<typeof String.prototype.replace> => [
-        new RegExp(`([a-zA-Z]+)\\.([a-zA-Z]+)=function\\(([a-zA-Z]+)\\){return"static\\/${language}\\/"`, "g"),
+        new RegExp(`([a-zA-Z_]+)\\.([a-zA-Z]+)=function\\(([a-zA-Z]+)\\){return"static\\/${language}\\/"`, "g"),
         (...[, n, u, e]) => `
 			${n}[(function(){
-                var pd= Object.getOwnPropertyDescriptor(n, "p");
+                var pd= Object.getOwnPropertyDescriptor(${n}, "p");
                 if( pd === undefined || pd.configurable ){
                 ${
                     buildOptions.isStandalone
@@ -57,7 +57,7 @@ export function replaceImportsFromStaticInJsCode(params: { jsCode: string; build
                         : `
                     var p= "";
                     Object.defineProperty(${n}, "p", {
-                        get: function() { return ("${ftlValuesGlobalName}" in window ? "${buildOptions.urlOrigin}" : "") + p; },
+                        get: function() { return "${ftlValuesGlobalName}" in window ? "${buildOptions.urlOrigin}" : p; },
                         set: function (value){ p = value;}
                     });
                     `
@@ -73,13 +73,13 @@ export function replaceImportsFromStaticInJsCode(params: { jsCode: string; build
         .replace(/([a-zA-Z]+\.[a-zA-Z]+)\+"static\//g, (...[, group]) =>
             buildOptions.isStandalone
                 ? `window.${ftlValuesGlobalName}.url.resourcesPath + "/build/static/`
-                : `("${ftlValuesGlobalName}" in window ? "${buildOptions.urlOrigin}" : "") + ${group} + "static/`
+                : `("${ftlValuesGlobalName}" in window ? "${buildOptions.urlOrigin}" : ${group}) + "static/`
         )
         //TODO: Write a test case for this
         .replace(/".chunk.css",([a-zA-Z])+=([a-zA-Z]+\.[a-zA-Z]+)\+([a-zA-Z]+),/, (...[, group1, group2, group3]) =>
             buildOptions.isStandalone
                 ? `".chunk.css",${group1} = window.${ftlValuesGlobalName}.url.resourcesPath + "/build/" + ${group3},`
-                : `".chunk.css",${group1} = ("${ftlValuesGlobalName}" in window ? "${buildOptions.urlOrigin}" : "") + ${group2} + ${group3},`
+                : `".chunk.css",${group1} = ("${ftlValuesGlobalName}" in window ? "${buildOptions.urlOrigin}" : ${group2}) + ${group3},`
         );
 
     return { fixedJsCode };

src/bin/link_in_test_app.ts

@@ -81,8 +81,6 @@ const testAppPaths = (() => {
         .filter(exclude(undefined));
 })();
 
-console.log(testAppPaths);
-
 if (testAppPaths.length === 0) {
     console.error("No test app to link into!");
     process.exit(-1);

src/lib/getKcContext/getKcContext.ts

@@ -60,6 +60,8 @@ export function getKcContext<KcContextExtended extends { pageId: string } = neve
                 ].filter(exclude(undefined));
 
                 attributes.forEach(attribute => {
+                    console.log("====>", attribute);
+
                     const partialAttribute = partialAttributes.find(({ name }) => name === attribute.name);
 
                     const augmentedAttribute: Attribute = {} as any;
@@ -82,14 +84,16 @@ export function getKcContext<KcContextExtended extends { pageId: string } = neve
                     id<KcContextBase.RegisterUserProfile>(kcContext).profile.attributesByName[augmentedAttribute.name] = augmentedAttribute;
                 });
 
-                partialAttributes.forEach(partialAttribute => {
+                partialAttributes
-                    const { name } = partialAttribute;
+                    .map(partialAttribute => ({ "validators": {}, ...partialAttribute }))
+                    .forEach(partialAttribute => {
+                        const { name } = partialAttribute;
 
-                    assert(name !== undefined, "If you define a mock attribute it must have at least a name");
+                        assert(name !== undefined, "If you define a mock attribute it must have at least a name");
 
-                    id<KcContextBase.RegisterUserProfile>(kcContext).profile.attributes.push(partialAttribute as any);
+                        id<KcContextBase.RegisterUserProfile>(kcContext).profile.attributes.push(partialAttribute as any);
-                    id<KcContextBase.RegisterUserProfile>(kcContext).profile.attributesByName[name] = partialAttribute as any;
+                        id<KcContextBase.RegisterUserProfile>(kcContext).profile.attributesByName[name] = partialAttribute as any;
-                });
+                    });
             }
         }
 

src/lib/tsconfig.json

@@ -4,7 +4,7 @@
         "outDir": "../../dist/lib",
         "rootDir": ".",
         "module": "ES2020",
-        "target": "ES2020",
+        "target": "ES2017",
         "lib": ["es2015", "DOM", "ES2019.Object"],
         "moduleResolution": "node",
         "jsx": "react",

src/test/bin/replaceImportFromStatic.ts

@@ -19,7 +19,7 @@ import { assetIsSameCode } from "../tools/assertIsSameCode";
             }[e] + ".chunk.js"
         }
 
-        n.u=function(e){return"static/js/" + e + "." + {
+        __webpack_require__.u=function(e){return"static/js/" + e + "." + {
                 147: "6c5cee76",
                 787: "8da10fcf",
                 922: "be170a73"
@@ -54,10 +54,10 @@ import { assetIsSameCode } from "../tools/assertIsSameCode";
                 }[e] + ".chunk.js"
             }
 
-            n[(function (){
+            __webpack_require__[(function (){
-                var pd= Object.getOwnPropertyDescriptor(n, "p");
+                var pd= Object.getOwnPropertyDescriptor(__webpack_require__, "p");
                 if( pd === undefined || pd.configurable ){
-                    Object.defineProperty(n, "p", {
+                    Object.defineProperty(__webpack_require__, "p", {
                         get: function() { return window.kcContext.url.resourcesPath; },
                         set: function (){}
                     });
@@ -72,7 +72,7 @@ import { assetIsSameCode } from "../tools/assertIsSameCode";
             }
 
             t[(function (){
-                var pd= Object.getOwnPropertyDescriptor(n, "p");
+                var pd= Object.getOwnPropertyDescriptor(t, "p");
                 if( pd === undefined || pd.configurable ){
                     Object.defineProperty(t, "p", {
                         get: function() { return window.kcContext.url.resourcesPath; },
@@ -103,23 +103,23 @@ import { assetIsSameCode } from "../tools/assertIsSameCode";
 
         const fixedJsCodeExpected = `
             function f() {
-                return ("kcContext" in window ? "https://demo-app.keycloakify.dev" : "") + a.p + "static/js/" + ({}[e] || e) + "." + {
+                return ("kcContext" in window ? "https://demo-app.keycloakify.dev" : a.p) + "static/js/" + ({}[e] || e) + "." + {
                     3: "0664cdc0"
                 }[e] + ".chunk.js"
             }
 
             function sameAsF() {
-                return ("kcContext" in window ? "https://demo-app.keycloakify.dev" : "") + a.p + "static/js/" + ({}[e] || e) + "." + {
+                return ("kcContext" in window ? "https://demo-app.keycloakify.dev" : a.p) + "static/js/" + ({}[e] || e) + "." + {
                     3: "0664cdc0"
                 }[e] + ".chunk.js"
             }
 
-            n[(function (){
+            __webpack_require__[(function (){
-                var pd= Object.getOwnPropertyDescriptor(n, "p");
+                var pd= Object.getOwnPropertyDescriptor(__webpack_require__, "p");
                 if( pd === undefined || pd.configurable ){
                     var p= "";
-                    Object.defineProperty(n, "p", {
+                    Object.defineProperty(__webpack_require__, "p", {
-                        get: function() { return ("kcContext" in window ? "https://demo-app.keycloakify.dev" : "") + p; },
+                        get: function() { return "kcContext" in window ? "https://demo-app.keycloakify.dev" : p; },
                         set: function (value){ p = value; }
                     });
                 }
@@ -133,11 +133,11 @@ import { assetIsSameCode } from "../tools/assertIsSameCode";
             }
 
             t[(function (){
-                var pd= Object.getOwnPropertyDescriptor(n, "p");
+                var pd= Object.getOwnPropertyDescriptor(t, "p");
                 if( pd === undefined || pd.configurable ){
                     var p= "";
                     Object.defineProperty(t, "p", {
-                        get: function() { return ("kcContext" in window ? "https://demo-app.keycloakify.dev" : "") + p; },
+                        get: function() { return "kcContext" in window ? "https://demo-app.keycloakify.dev" : p; },
                         set: function (value){ p = value; }
                     });
                 }

yarn.lock

@@ -1733,10 +1733,10 @@ tslib@^2.1.0:
   resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.4.0.tgz#7cecaa7f073ce680a05847aa77be941098f36dc3"
   integrity sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ==
 
-tss-react@^4.0.0:
+tss-react@^4.1.1:
-  version "4.0.0"
+  version "4.1.1"
-  resolved "https://registry.yarnpkg.com/tss-react/-/tss-react-4.0.0.tgz#cdd9d4c4ae24de04c13b9deff59b50fdf6ce10ae"
+  resolved "https://registry.yarnpkg.com/tss-react/-/tss-react-4.1.1.tgz#207220417e4b2f8eb26d8280ab9cdeb385063069"
-  integrity sha512-pPkOKWiWWPbKdQFnGGeHEgRceUwkjrv0eldVCAdBll3j6Y3Ys/xwqsnlWYwWOU3SMJygVRE/S4CsIYx6KPpOkA==
+  integrity sha512-K1U2s/GGw+XycUjJGztJsLUhwm8KJWz5afL5WZU3SwMeQsA+gbETM6bSxVk2/DXBdw9uYLL9jkSYPAXh0tfYBw==
   dependencies:
     "@emotion/cache" "*"
     "@emotion/serialize" "*"