keycloakify 10.0.0-rc.0 → 10.0.0-rc.10

package/bin/keycloakify/generateFtl/ftl_object_to_js_code_declaring_an_object.ftl

@@ -1,593 +0,0 @@
-<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>
-
-            }
-
-            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 () {
-
-            for( let i = 0; i < arguments.length; i++ ){
-
-                const fieldName = arguments[i];
-
-                if( out.messagesPerField.existsError(fieldName) ){
-                    return out.messagesPerField.get(fieldName);
-                }
-
-            }
-
-        }
-    };
-
-    <#if account??>
-        out["url"]["getLogoutUrl"] = function () {
-            <#attempt>
-                return "${url.getLogoutUrl()}";
-            <#recover>
-            </#attempt>
-        };
-    </#if>
-
-    out["keycloakifyVersion"] = "KEYCLOAKIFY_VERSION_xEdKd3xEdr";
-    out["themeVersion"] = "KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx";
-    out["themeType"] = "KEYCLOAKIFY_THEME_TYPE_dExKd3xEdr";
-    out["themeName"] = "KEYCLOAKIFY_THEME_NAME_cXxKd3xEer";
-    out["pageId"] = "${pageId}";
-
-    try {
-
-        out["url"]["resourcesCommonPath"] = out["url"]["resourcesPath"] + "/" + "RESOURCES_COMMON_cLsLsMrtDkpVv";
-
-    } catch(error) {
-
-    }
-
-    return out;
-
-})()
-<#function ftl_object_to_js_code_declaring_an_object object path>
-
-        <#local isHash = "">
-        <#attempt>
-            <#local isHash = object?is_hash || object?is_hash_ex>
-        <#recover>
-            <#return "ABORT: Can't evaluate if " + path?join(".") + " is hash">
-        </#attempt>
-
-        <#if isHash>
-
-            <#if path?size gt 10>
-                <#return "ABORT: Too many recursive calls, path: " + path?join(".")>
-            </#if>
-
-            <#local keys = "">
-
-            <#attempt>
-                <#local keys = object?keys>
-            <#recover>
-                <#return "ABORT: We can't list keys on this object">
-            </#attempt>
-
-
-            <#local out_seq = []>
-
-            <#list keys as key>
-
-                <#if ["class","declaredConstructors","superclass","declaringClass" ]?seq_contains(key) >
-                    <#continue>
-                </#if>
-
-                <#if 
-                    (
-                        ["loginUpdatePasswordUrl", "loginUpdateProfileUrl", "loginUsernameReminderUrl", "loginUpdateTotpUrl"]?seq_contains(key) && 
-                        are_same_path(path, ["url"])
-                    ) || (
-                        key == "updateProfileCtx" && 
-                        are_same_path(path, [])
-                    ) || (
-                        <#-- https://github.com/keycloakify/keycloakify/pull/65#issuecomment-991896344 (reports with saml-post-form.ftl) -->
-                        <#-- https://github.com/keycloakify/keycloakify/issues/91#issue-1212319466 (reports with error.ftl and Kc18) -->
-                        <#-- https://github.com/keycloakify/keycloakify/issues/109#issuecomment-1134610163 -->
-                        <#-- https://github.com/keycloakify/keycloakify/issues/357 -->
-                        <#-- https://github.com/keycloakify/keycloakify/discussions/406#discussioncomment-7514787 -->
-                        key == "loginAction" && 
-                        are_same_path(path, ["url"]) && 
-                        ["saml-post-form.ftl", "error.ftl", "info.ftl", "login-oauth-grant.ftl", "logout-confirm.ftl", "login-oauth2-device-verify-user-code.ftl"]?seq_contains(pageId) &&
-                        !(auth?has_content && auth.showTryAnotherWayLink())
-                    ) || (
-                        <#-- https://github.com/keycloakify/keycloakify/issues/362 -->
-                        ["secretData", "value"]?seq_contains(key) && 
-                        are_same_path(path, [ "totp", "otpCredentials", "*" ])
-                    ) || (
-                        ["contextData", "idpConfig", "idp", "authenticationSession"]?seq_contains(key) &&
-                        are_same_path(path, ["brokerContext"]) &&
-                        ["login-idp-link-confirm.ftl", "login-idp-link-email.ftl" ]?seq_contains(pageId)
-                    ) || (
-                        key == "identityProviderBrokerCtx" && 
-                        are_same_path(path, []) &&
-                        ["login-idp-link-confirm.ftl", "login-idp-link-email.ftl" ]?seq_contains(pageId)
-                    ) ||  (
-                        ["masterAdminClient", "delegateForUpdate", "defaultRole"]?seq_contains(key) &&
-                        are_same_path(path, ["realm"])
-                    ) || (
-                        "error.ftl" == pageId &&
-                        are_same_path(path, ["realm"]) &&
-                        !["name", "displayName", "displayNameHtml", "internationalizationEnabled", "registrationEmailAsUsername" ]?seq_contains(key)
-                    ) || (
-                        "applications.ftl" == pageId &&
-                        is_subpath(path, ["applications", "applications"]) &&
-                        ( 
-                            key == "realm" || 
-                            key == "container" 
-                        )
-                    ) || (
-                        are_same_path(path, ["user"]) &&
-                        key == "delegateForUpdate"
-                    ) || (
-                        <#-- Security audit forwarded by Garth (Gmail) -->
-                        are_same_path(path, ["client", "attributes"]) &&
-                        key == "saml.signing.private.key"
-                    ) || (
-                        <#-- See: https://github.com/keycloakify/keycloakify/issues/534 -->
-                        are_same_path(path, ["login"]) &&
-                        key == "password"
-                    ) || (
-                        <#-- Remove realmAttributes added by https://github.com/jcputney/keycloak-theme-additional-info-extension for peace of mind. -->
-                        are_same_path(path, []) &&
-                        key == "realmAttributes"
-                    )
-                >
-                    <#local out_seq += ["/*If you need '" + path?join(".") + "." + key + "' on " + pageId + ", please submit an issue to the Keycloakify repo*/"]>
-                    <#continue>
-                </#if>
-
-                <#-- https://github.com/keycloakify/keycloakify/discussions/406 -->
-                <#if (
-                    ["register.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>
-                        <#-- https://github.com/keycloak/keycloak/blob/3a2bf0c04bcde185e497aaa32d0bb7ab7520cf4a/themes/src/main/resources/theme/base/login/template.ftl#L63 -->
-                        <#if !(auth?has_content && auth.showUsername() && !auth.showResetCredentials())>
-                            <#local out_seq += ["/*If you need '" + key + "' on " + pageId + ", please submit an issue to the Keycloakify repo*/"]>
-                            <#continue>
-                        </#if>
-                    <#recover>
-                        <#local out_seq += ["/*Testing if attemptedUsername should be skipped throwed an exception */"]>
-                    </#attempt>
-                </#if>
-                
-                <#attempt>
-                    <#if !object[key]??>
-                        <#continue>
-                    </#if>
-                <#recover>
-                    <#local out_seq += ["/*Couldn't test if '" + key + "' is available on this object*/"]>
-                    <#continue>
-                </#attempt>
-
-                <#local propertyValue = "">
-
-                <#attempt>
-                    <#local propertyValue = object[key]>
-                <#recover>
-                    <#local out_seq += ["/*Couldn't dereference '" + key + "' on this object*/"]>
-                    <#continue>
-                </#attempt>
-
-                <#local rec_out = ftl_object_to_js_code_declaring_an_object(propertyValue, path + [ key ])>
-
-                <#if rec_out?starts_with("ABORT:")>
-
-                    <#local errorMessage = rec_out?remove_beginning("ABORT:")>
-
-                    <#if errorMessage != " It's a method" >
-                        <#local out_seq += ["/*" + key + ": " + errorMessage + "*/"]>
-                    </#if>
-
-                    <#continue>
-                </#if>
-
-                <#local out_seq +=  ['"' + key + '": ' + rec_out + ","]>
-
-            </#list>
-
-            <#return (["{"] + out_seq?map(str -> ""?right_pad(4 * (path?size + 1)) + str) + [ ""?right_pad(4 * path?size) + "}"])?join("\n")>
-
-        </#if>
-
-        <#local isMethod = "">
-        <#attempt>
-            <#local isMethod = object?is_method>
-        <#recover>
-            <#return "ABORT: Can't test if it'sa method.">
-        </#attempt>
-
-        <#if isMethod>
-
-            <#if are_same_path(path, ["auth", "showUsername"])>
-                <#attempt>
-                    <#return auth.showUsername()?c>
-                <#recover>
-                    <#return "ABORT: Couldn't evaluate auth.showUsername()">
-                </#attempt>
-            </#if>
-
-            <#if are_same_path(path, ["auth", "showResetCredentials"])>
-                <#attempt>
-                    <#return auth.showResetCredentials()?c>
-                <#recover>
-                    <#return "ABORT: Couldn't evaluate auth.showResetCredentials()">
-                </#attempt>
-            </#if>
-
-            <#if are_same_path(path, ["auth", "showTryAnotherWayLink"])>
-                <#attempt>
-                    <#return auth.showTryAnotherWayLink()?c>
-                <#recover>
-                    <#return "ABORT: Couldn't evaluate auth.showTryAnotherWayLink()">
-                </#attempt>
-            </#if>
-
-            <#return "ABORT: It's a method">
-        </#if>
-
-        <#local isBoolean = "">
-        <#attempt>
-            <#local isBoolean = object?is_boolean>
-        <#recover>
-            <#return "ABORT: Can't test if it's a boolean">
-        </#attempt>
-
-        <#if isBoolean>
-            <#return object?c>
-        </#if>
-
-        <#local isEnumerable = "">
-        <#attempt>
-            <#local isEnumerable = object?is_enumerable>
-        <#recover>
-            <#return "ABORT: Can't test if it's an enumerable">
-        </#attempt>
-
-
-        <#if isEnumerable>
-
-            <#local out_seq = []>
-
-            <#local i = 0>
-
-            <#list object as array_item>
-
-                <#if !array_item??>
-                    <#local out_seq += ["null,"]>
-                    <#continue>
-                </#if>
-
-                <#local rec_out = ftl_object_to_js_code_declaring_an_object(array_item, path + [ i ])>
-
-                <#local i = i + 1>
-
-                <#if rec_out?starts_with("ABORT:")>
-
-                    <#local errorMessage = rec_out?remove_beginning("ABORT:")>
-
-                    <#if errorMessage != " It's a method" >
-                        <#local out_seq += ["/*" + i?string + ": " + errorMessage + "*/"]>
-                    </#if>
-
-                    <#continue>
-                </#if>
-
-                <#local out_seq += [rec_out + ","]>
-
-            </#list>
-
-            <#return (["["] + out_seq?map(str -> ""?right_pad(4 * (path?size + 1)) + str) + [ ""?right_pad(4 * path?size) + "]"])?join("\n")>
-
-        </#if>
-
-        <#local isDate = "">
-        <#attempt>
-            <#local isDate = object?is_date_like>
-        <#recover>
-            <#return "ABORT: Can't test if it's a date">
-        </#attempt>
-
-        <#if isDate>
-            <#return '"' + object?datetime?iso_utc + '"'>
-        </#if>
-
-        <#local isNumber = "">
-        <#attempt>
-            <#local isNumber = object?is_number>
-        <#recover>
-            <#return "ABORT: Can't test if it's a number">
-        </#attempt>
-
-        <#if isNumber>
-            <#return object?c>
-        </#if>
-
-        <#attempt>
-            <#return '"' + object?js_string + '"'>;
-        <#recover>
-        </#attempt>
-
-        <#return "ABORT: Couldn't convert into string non hash, non method, non boolean, non number, non enumerable object">
-
-</#function>
-<#function is_subpath path searchedPath>
-
-    <#if path?size < searchedPath?size>
-        <#return false>
-    </#if>
-
-    <#local i=0>
-
-    <#list path as property>
-
-        <#if i == searchedPath?size >
-            <#continue>
-        </#if>
-
-        <#local searchedProperty=searchedPath[i]>
-
-        <#local i+= 1>
-
-        <#if searchedProperty?is_string && searchedProperty == "*">
-            <#continue>
-        </#if>
-
-        <#if searchedProperty?is_string && !property?is_string>
-            <#return false>
-        </#if>
-
-        <#if searchedProperty?is_number && !property?is_number>
-            <#return false>
-        </#if>
-
-        <#if searchedProperty?string != property?string>
-            <#return false>
-        </#if>
-
-    </#list>
-
-    <#return true>
-
-</#function>
-
-<#function are_same_path path searchedPath>
-    <#return path?size == searchedPath?size && is_subpath(path, searchedPath)>
-</#function>
-</script>

package/bin/keycloakify/generateFtl/generateFtl.d.ts

@@ -1,23 +0,0 @@
-import { type ThemeType } from "../../constants";
-export type BuildOptionsLike = {
-    bundler: "vite" | "webpack";
-    themeVersion: string;
-    urlPathname: string | undefined;
-    reactAppBuildDirPath: string;
-    assetsDirPath: string;
-};
-export declare function generateFtlFilesCodeFactory(params: {
-    themeName: string;
-    indexHtmlCode: string;
-    cssGlobalsToDefine: Record<string, string>;
-    buildOptions: BuildOptionsLike;
-    keycloakifyVersion: string;
-    themeType: ThemeType;
-    fieldNames: string[];
-}): {
-    generateFtlFilesCode: (params: {
-        pageId: string;
-    }) => {
-        ftlCode: string;
-    };
-};