keycloakify 10.0.0-rc.8 → 10.0.0-rc.80

package/src/bin/keycloakify/generateFtl/{ftl_object_to_js_code_declaring_an_object.ftl → kcContextDeclarationTemplate.ftl}

@@ -1,189 +1,95 @@
-<script>const _= 
-(()=>{
 <#assign pageId="PAGE_ID_xIgLsPgGId9D8e">
-const out = ${ftl_object_to_js_code_declaring_an_object(.data_model, [])?no_esc};
-out["msg"]= function(){ throw new Error("use import { useKcMessage } from 'keycloakify'"); };
-out["advancedMsg"]= function(){ throw new Error("use import { useKcMessage } from 'keycloakify'"); };
-out["messagesPerField"]= {
-    <#assign fieldNames = [ FIELD_NAMES_eKsIY4ZsZ4xeM ]>
-    <#attempt>
-        <#if profile?? && profile.attributes?? && profile.attributes?is_enumerable>
-            <#list profile.attributes as attribute>
-                <#if fieldNames?seq_contains(attribute.name)>
-                    <#continue>
-                </#if>
-                <#assign fieldNames += [attribute.name]>
-            </#list>
-        </#if>
-    <#recover>
-    </#attempt>
-    "printIfExists": function (fieldName, text) {
-        <#if !messagesPerField?? || !(messagesPerField?is_hash)>   
-            throw new Error("You're not supposed to use messagesPerField.printIfExists in this page");
-        <#else>
-            <#list fieldNames as fieldName>
-                if(fieldName === "${fieldName}" ){
-                    <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
-                    <#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
-                        <#assign doExistErrorOnUsernameOrPassword = "">
-                        <#attempt>
-                            <#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
-                        <#recover>
-                            <#assign doExistErrorOnUsernameOrPassword = true>
-                        </#attempt>
-                        <#if doExistErrorOnUsernameOrPassword>
-                            return text;
-                        <#else>
-                            <#assign doExistMessageForField = "">
-                            <#attempt>
-                                <#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
-                            <#recover>
-                                <#assign doExistMessageForField = true>
-                            </#attempt>
-                            return <#if doExistMessageForField>text<#else>undefined</#if>;
-                        </#if>
-                    <#else>
-                        <#assign doExistMessageForField = "">
-                        <#attempt>
-                            <#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
-                        <#recover>
-                            <#assign doExistMessageForField = true>
-                        </#attempt>
-                        return <#if doExistMessageForField>text<#else>undefined</#if>;
-                    </#if>
-                }
-            </#list>
-            throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
-        </#if>
-    },
-    "existsError": function (){
-        function existsError_singleFieldName(fieldName) {
-            <#if !messagesPerField?? || !(messagesPerField?is_hash)>   
-                throw new Error("You're not supposed to use messagesPerField.printIfExists in this page");
-            <#else>
-                <#list fieldNames as fieldName>
-                    if(fieldName === "${fieldName}" ){
-                        <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
-                        <#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
-                            <#assign doExistErrorOnUsernameOrPassword = "">
-                            <#attempt>
-                                <#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
-                            <#recover>
-                                <#assign doExistErrorOnUsernameOrPassword = true>
-                            </#attempt>
-                            return <#if doExistErrorOnUsernameOrPassword>true<#else>false</#if>;
-                        <#else>
-                            <#assign doExistErrorMessageForField = "">
-                            <#attempt>
-                                <#assign doExistErrorMessageForField = messagesPerField.existsError('${fieldName}')>
-                            <#recover>
-                                <#assign doExistErrorMessageForField = true>
-                            </#attempt>
-                            return <#if doExistErrorMessageForField>true<#else>false</#if>;
-                        </#if>
-                    }
-                </#list>
-                throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
-            </#if>
-        }
+const kcContext = ${ftl_object_to_js_code_declaring_an_object(.data_model, [])?no_esc};
+if( kcContext.messagesPerField ){
+    var existsError_singleFieldName = kcContext.messagesPerField.existsError;
+    kcContext.messagesPerField.existsError = function (){
         for( let i = 0; i < arguments.length; i++ ){
             if( existsError_singleFieldName(arguments[i]) ){
                 return true;
             }
         }
         return false;
-    },
-    "get": function (fieldName) {
-        <#if !messagesPerField?? || !(messagesPerField?is_hash)>   
-            throw new Error("You're not supposed to use messagesPerField.get in this page");
-        <#else>
-            <#list fieldNames as fieldName>
-                if(fieldName === "${fieldName}" ){
-                    <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
-                    <#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
-                        <#assign doExistErrorOnUsernameOrPassword = "">
-                        <#attempt>
-                            <#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
-                        <#recover>
-                            <#assign doExistErrorOnUsernameOrPassword = true>
-                        </#attempt>
-                        <#if doExistErrorOnUsernameOrPassword>
-                            <#attempt>
-                                return "${kcSanitize(msg('invalidUserMessage'))?no_esc}";
-                            <#recover>
-                                return "Invalid username or password.";
-                            </#attempt>
-                        <#else>
-                            <#attempt>
-                                return "${messagesPerField.get('${fieldName}')?no_esc}";
-                            <#recover>
-                                return "";
-                            </#attempt>
-                        </#if>
-                    <#else>
-                        <#attempt>
-                            return "${messagesPerField.get('${fieldName}')?no_esc}";
-                        <#recover>
-                            return "invalid field";
-                        </#attempt>
-                    </#if>
-                }
-            </#list>
-            throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
-        </#if>
-    },
-    "exists": function (fieldName) {
-        <#if !messagesPerField?? || !(messagesPerField?is_hash)>   
-            throw new Error("You're not supposed to use messagesPerField.exists in this page");
-        <#else>
-            <#list fieldNames as fieldName>
-                if(fieldName === "${fieldName}" ){
-                    <#-- https://github.com/keycloakify/keycloakify/pull/218 -->
-                    <#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
-                        <#assign doExistErrorOnUsernameOrPassword = "">
-                        <#attempt>
-                            <#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
-                        <#recover>
-                            <#assign doExistErrorOnUsernameOrPassword = true>
-                        </#attempt>
-                        return <#if doExistErrorOnUsernameOrPassword>true<#else>false</#if>;
-                    <#else>
-                        <#assign doExistErrorMessageForField = "">
-                        <#attempt>
-                            <#assign doExistErrorMessageForField = messagesPerField.exists('${fieldName}')>
-                        <#recover>
-                            <#assign doExistErrorMessageForField = true>
-                        </#attempt>
-                        return <#if doExistErrorMessageForField>true<#else>false</#if>;
-                    </#if>
-                }
-            </#list>
-            throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
-        </#if>
-    },
-    "getFirstError": function () {
+    };
+    kcContext.messagesPerField.exists = function (fieldName) {
+        return kcContext.messagesPerField.get(fieldName) !== "";
+    };
+    kcContext.messagesPerField.printIfExists = function (fieldName, text) {
+        return kcContext.messagesPerField.exists(fieldName) ? text : undefined;
+    };
+    kcContext.messagesPerField.getFirstError = function () {
         for( let i = 0; i < arguments.length; i++ ){
             const fieldName = arguments[i];
-            if( out.messagesPerField.existsError(fieldName) ){
-                return out.messagesPerField.get(fieldName);
+            if( kcContext.messagesPerField.existsError(fieldName) ){
+                return kcContext.messagesPerField.get(fieldName);
             }
         }
+    };
+}
+kcContext.keycloakifyVersion = "KEYCLOAKIFY_VERSION_xEdKd3xEdr";
+kcContext.themeVersion = "KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx";
+kcContext.themeType = "KEYCLOAKIFY_THEME_TYPE_dExKd3xEdr";
+kcContext.themeName = "KEYCLOAKIFY_THEME_NAME_cXxKd3xEer";
+kcContext.pageId = "${pageId}";
+if( kcContext.url && kcContext.url.resourcesPath ){
+    kcContext.url.resourcesCommonPath = kcContext.url.resourcesPath + "/" + "RESOURCES_COMMON_cLsLsMrtDkpVv";
+}
+kcContext["x-keycloakify"] = {};
+<#if profile?? && profile.attributes??>
+    kcContext["x-keycloakify"].realmMessageBundleUserProfile = {
+        <#list profile.attributes as attribute>
+            <#if attribute.annotations?? && attribute.displayName??>
+                "${attribute.displayName}": decodeHtmlEntities("${advancedMsg(attribute.displayName)?js_string}"),
+            </#if>
+            <#if attribute.annotations.inputHelperTextBefore??>
+                "${attribute.annotations.inputHelperTextBefore}": decodeHtmlEntities("${advancedMsg(attribute.annotations.inputHelperTextBefore)?js_string}"),
+            </#if>
+            <#if attribute.annotations.inputHelperTextAfter??>
+                "${attribute.annotations.inputHelperTextAfter}": decodeHtmlEntities("${advancedMsg(attribute.annotations.inputHelperTextAfter)?js_string}"),
+            </#if>
+            <#if attribute.annotations.inputTypePlaceholder??>
+                "${attribute.annotations.inputTypePlaceholder}": decodeHtmlEntities("${advancedMsg(attribute.annotations.inputTypePlaceholder)?js_string}"),
+            </#if>
+            <!-- Loop through the options that are in attribute.validators.options.options -->
+            <#if (
+                attribute.annotations.inputOptionLabelsI18nPrefix?? &&
+                attribute.validators?? &&
+                attribute.validators.options??
+            )>
+                <#list attribute.validators.options.options as option>
+                    "${attribute.annotations.inputOptionLabelsI18nPrefix}.${option}": decodeHtmlEntities("${msg(attribute.annotations.inputOptionLabelsI18nPrefix + "." + option)?js_string}"),
+                </#list>
+            </#if>
+        </#list>
+    };
+</#if>
+<#if pageId == "terms.ftl" || termsAcceptanceRequired?? && termsAcceptanceRequired>
+    kcContext["x-keycloakify"].realmMessageBundleTermsText= decodeHtmlEntities("${msg("termsText")?js_string}");
+</#if>
+attributes_to_attributesByName: {
+    if( !kcContext.profile ){
+        break attributes_to_attributesByName;
     }
-};
-
-out["keycloakifyVersion"] = "KEYCLOAKIFY_VERSION_xEdKd3xEdr";
-out["themeVersion"] = "KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx";
-out["themeType"] = "KEYCLOAKIFY_THEME_TYPE_dExKd3xEdr";
-out["themeName"] = "KEYCLOAKIFY_THEME_NAME_cXxKd3xEer";
-out["pageId"] = "${pageId}";
-
-try {
-    out["url"]["resourcesCommonPath"] = out["url"]["resourcesPath"] + "/" + "RESOURCES_COMMON_cLsLsMrtDkpVv";
-} catch(error) { }
-
-return out;
+    if( !kcContext.profile.attributes ){
+        break attributes_to_attributesByName;
+    }
+    var attributes =  kcContext.profile.attributes;
+    delete kcContext.profile.attributes;
+    kcContext.profile.attributesByName = {};
+    attributes.forEach(function(attribute){
+        kcContext.profile.attributesByName[attribute.name] = attribute;
+    });
+}
+window.kcContext = kcContext;
+function decodeHtmlEntities(htmlStr){
+    var element = decodeHtmlEntities.element;
+    if (!element) {
+        element = document.createElement("textarea");
+        decodeHtmlEntities.element = element;
+    }
+    element.innerHTML = htmlStr;
+    return element.value;
+}
 
-})();
 <#function ftl_object_to_js_code_declaring_an_object object path>
 
         <#local isHash = "">
@@ -253,35 +159,63 @@ return out;
                         !["name", "displayName", "displayNameHtml", "internationalizationEnabled", "registrationEmailAsUsername" ]?seq_contains(key)
                     ) || (
                         "applications.ftl" == pageId &&
-                        is_subpath(path, ["applications", "applications"]) &&
                         ( 
                             key == "realm" || 
                             key == "container" 
-                        )
+                        ) &&
+                        is_subpath(path, ["applications", "applications"])
                     ) || (
-                        are_same_path(path, ["user"]) &&
-                        key == "delegateForUpdate"
+                        key == "delegateForUpdate" &&
+                        are_same_path(path, ["user"])
                     ) || (
                         <#-- Security audit forwarded by Garth (Gmail) -->
-                        are_same_path(path, ["client", "attributes"]) &&
-                        key == "saml.signing.private.key"
+                        key == "saml.signing.private.key" &&
+                        are_same_path(path, ["client", "attributes"])
                     ) || (
                         <#-- See: https://github.com/keycloakify/keycloakify/issues/534 -->
-                        are_same_path(path, ["login"]) &&
-                        key == "password"
+                        key == "password" &&
+                        are_same_path(path, ["login"])
                     ) || (
                         <#-- Remove realmAttributes added by https://github.com/jcputney/keycloak-theme-additional-info-extension for peace of mind. -->
-                        are_same_path(path, []) &&
-                        key == "realmAttributes"
+                        key == "realmAttributes" &&
+                        are_same_path(path, [])
+                    ) || (
+                        <#-- attributesByName adds a lot of noise to the output and is not needed, we already have profile.attributes -->
+                        key == "attributesByName" &&
+                        are_same_path(path, ["profile"]) 
+                    ) || (
+                        <#-- We already have the attributes in profile speedup the rendering by filtering it out from the register object -->
+                        (key == "attributes" || key == "attributesByName") &&
+                        are_same_path(path, ["register"])
+                    ) || (
+                        are_same_path(path, ["properties"]) &&
+                        (
+                            key?starts_with("kc") || 
+                            key == "locales" || 
+                            key == "import" || 
+                            key == "parent" || 
+                            key == "meta" ||
+                            key == "stylesCommon" ||
+                            key == "styles" ||
+                            key == "accountResourceProvider"
+                        )
+                    ) || (
+                        key == "execution" &&
+                        are_same_path(path, [])
+                    ) || (
+                        key == "entity" &&
+                        are_same_path(path, ["user"])
                     )
                 >
-                    <#local out_seq += ["/*" + path?join(".") + "." + key + " excluded*/"]>
+                    <#-- <#local out_seq += ["/*" + path?join(".") + "." + key + " excluded*/"]> -->
                     <#continue>
                 </#if>
+                
+                USER_DEFINED_EXCLUSIONS_eKsaY4ZsZ4eMr2
 
                 <#-- https://github.com/keycloakify/keycloakify/discussions/406 -->
                 <#if (
-                    ["register.ftl", "register-user-profile.ftl", "info.ftl", "login.ftl", "login-update-password.ftl", "login-oauth2-device-verify-user-code.ftl"]?seq_contains(pageId) && 
+                    ["register.ftl", "register-user-profile.ftl", "terms.ftl", "info.ftl", "login.ftl", "login-update-password.ftl", "login-oauth2-device-verify-user-code.ftl"]?seq_contains(pageId) && 
                     key == "attemptedUsername" && are_same_path(path, ["auth"])
                 )>
                     <#attempt>
@@ -378,15 +312,121 @@ return out;
             </#if>
 
             <#if are_same_path(path, ["totp", "policy", "getAlgorithmKey"])>
-                <#local returnValue = "">
-                <#attempt>
-                    <#local returnValue = totp.policy.getAlgorithmKey()>
-                <#recover>
-                    <#return "ABORT: Couldn't evaluate totp.policy.getAlgorithmKey()">
-                </#attempt>
+                <#local returnValue = "error">
+                <#if mode?? && mode = "manual">
+                    <#attempt>
+                        <#local returnValue = totp.policy.getAlgorithmKey()>
+                    <#recover>
+                        <#return "ABORT: Couldn't evaluate totp.policy.getAlgorithmKey()">
+                    </#attempt>
+                </#if>
                 <#return 'function(){ return "' + returnValue + '"; }'>
             </#if>
 
+            <#assign fieldNames = [ FIELD_NAMES_eKsIY4ZsZ4xeM ]>
+            <#if profile?? && profile.attributes??>
+                <#list profile.attributes as attribute>
+                    <#if fieldNames?seq_contains(attribute.name)>
+                        <#continue>
+                    </#if>
+                    <#assign fieldNames += [attribute.name]>
+                </#list>
+            </#if>
+
+            <#if are_same_path(path, ["messagesPerField", "get"])>
+
+                <#local jsFunctionCode = "function (fieldName) { ">
+
+                <#list fieldNames as fieldName>
+
+                    <#-- See: https://github.com/keycloakify/keycloakify/issues/217 -->
+                    <#if pageId == "login.ftl" >
+
+                        <#if fieldName == "username">
+
+                            <#local jsFunctionCode += "if(fieldName === 'username' || fieldName === 'password' ){ ">
+
+                            <#if messagesPerField.exists('username') || messagesPerField.exists('password')>
+                                <#local jsFunctionCode += "return kcContext.message && kcContext.message.summary ? kcContext.message.summary : 'error'; ">
+                            <#else>
+                                <#local jsFunctionCode += "return ''; ">
+                            </#if>
+
+                            <#local jsFunctionCode += "} ">
+
+                            <#continue>
+                        </#if>
+
+                        <#if fieldName == "password">
+                            <#continue>
+                        </#if>
+
+                    </#if>
+
+                    <#local jsFunctionCode += "if(fieldName === '" + fieldName + "'){ ">
+
+                    <#if messagesPerField.exists('${fieldName}')>
+                        <#local jsFunctionCode += 'return decodeHtmlEntities("' + messagesPerField.get('${fieldName}')?js_string + '"); '>
+                    <#else>
+                        <#local jsFunctionCode += "return ''; ">
+                    </#if>
+
+                    <#local jsFunctionCode += "} ">
+
+                </#list>
+
+                <#local jsFunctionCode += "}">
+
+                <#return jsFunctionCode>
+
+            </#if>
+
+            <#if are_same_path(path, ["messagesPerField", "existsError"])>
+
+                <#local jsFunctionCode = "function (fieldName) { ">
+
+                <#list fieldNames as fieldName>
+
+                    <#-- See: https://github.com/keycloakify/keycloakify/issues/217 -->
+                    <#if pageId == "login.ftl" >
+                        <#if fieldName == "username">
+
+                            <#local jsFunctionCode += "if(fieldName === 'username' || fieldName === 'password' ){ ">
+
+                            <#if messagesPerField.existsError('username') || messagesPerField.existsError('password')>
+                                <#local jsFunctionCode += "return true; ">
+                            <#else>
+                                <#local jsFunctionCode += "return false; ">
+                            </#if>
+
+                            <#local jsFunctionCode += "} ">
+
+                            <#continue>
+                        </#if>
+
+                        <#if fieldName == "password">
+                            <#continue>
+                        </#if>
+                    </#if>
+
+                    <#local jsFunctionCode += "if(fieldName === '" + fieldName + "' ){ ">
+
+                    <#if messagesPerField.existsError('${fieldName}')>
+                        <#local jsFunctionCode += 'return true; '>
+                    <#else>
+                        <#local jsFunctionCode += "return false; ">
+                    </#if>
+
+                    <#local jsFunctionCode += "}">
+
+                </#list>
+
+                <#local jsFunctionCode += "}">
+
+                <#return jsFunctionCode>
+
+            </#if>
+
             <#return "ABORT: It's a method">
         </#if>
 
@@ -517,5 +557,4 @@ return out;
 
 <#function are_same_path path searchedPath>
     <#return path?size == searchedPath?size && is_subpath(path, searchedPath)>
-</#function>
-</script>
+</#function>

package/src/bin/keycloakify/generateResources/bringInAccountV1.ts

@@ -0,0 +1,89 @@
+import * as fs from "fs";
+import { join as pathJoin } from "path";
+import { assert } from "tsafe/assert";
+import type { BuildContext } from "../../shared/buildContext";
+import {
+    resources_common,
+    lastKeycloakVersionWithAccountV1,
+    accountV1ThemeName
+} from "../../shared/constants";
+import { downloadKeycloakDefaultTheme } from "../../shared/downloadKeycloakDefaultTheme";
+import { transformCodebase } from "../../tools/transformCodebase";
+
+export type BuildContextLike = {
+    cacheDirPath: string;
+    npmWorkspaceRootDirPath: string;
+};
+
+assert<BuildContext extends BuildContextLike ? true : false>();
+
+export async function bringInAccountV1(params: {
+    resourcesDirPath: string;
+    buildContext: BuildContextLike;
+}) {
+    const { resourcesDirPath, buildContext } = params;
+
+    const { defaultThemeDirPath } = await downloadKeycloakDefaultTheme({
+        keycloakVersion: lastKeycloakVersionWithAccountV1,
+        buildContext
+    });
+
+    const accountV1DirPath = pathJoin(
+        resourcesDirPath,
+        "theme",
+        accountV1ThemeName,
+        "account"
+    );
+
+    transformCodebase({
+        srcDirPath: pathJoin(defaultThemeDirPath, "base", "account"),
+        destDirPath: accountV1DirPath
+    });
+
+    transformCodebase({
+        srcDirPath: pathJoin(defaultThemeDirPath, "keycloak", "account", "resources"),
+        destDirPath: pathJoin(accountV1DirPath, "resources")
+    });
+
+    transformCodebase({
+        srcDirPath: pathJoin(defaultThemeDirPath, "keycloak", "common", "resources"),
+        destDirPath: pathJoin(accountV1DirPath, "resources", resources_common)
+    });
+
+    fs.writeFileSync(
+        pathJoin(accountV1DirPath, "theme.properties"),
+        Buffer.from(
+            [
+                "accountResourceProvider=account-v1",
+                "",
+                "locales=ar,ca,cs,da,de,en,es,fr,fi,hu,it,ja,lt,nl,no,pl,pt-BR,ru,sk,sv,tr,zh-CN",
+                "",
+                "styles=" +
+                    [
+                        "css/account.css",
+                        "img/icon-sidebar-active.png",
+                        "img/logo.png",
+                        ...[
+                            "patternfly.min.css",
+                            "patternfly-additions.min.css",
+                            "patternfly-additions.min.css"
+                        ].map(
+                            fileBasename =>
+                                `${resources_common}/node_modules/patternfly/dist/css/${fileBasename}`
+                        )
+                    ].join(" "),
+                "",
+                "##### css classes for form buttons",
+                "# main class used for all buttons",
+                "kcButtonClass=btn",
+                "# classes defining priority of the button - primary or default (there is typically only one priority button for the form)",
+                "kcButtonPrimaryClass=btn-primary",
+                "kcButtonDefaultClass=btn-default",
+                "# classes defining size of the button",
+                "kcButtonLargeClass=btn-lg",
+                ""
+            ].join("\n"),
+            "utf8"
+        )
+    );
+}