keycloakify 10.0.0-rc.106 → 10.0.0-rc.108

package/src/login/KcContext/kcContextMocks.ts

@@ -162,8 +162,7 @@ export const kcContextCommonMock: KcContext.Common = {
     isAppInitiatedAction: false,
     properties: {},
     "x-keycloakify": {
-        realmMessageBundleUserProfile: undefined,
-        realmMessageBundleTermsText: undefined
+        messages: {}
     }
 };
 

package/src/login/i18n/i18n.tsx

@@ -11,8 +11,7 @@ export type KcContextLike = {
         supported: { languageTag: string; url: string; label: string }[];
     };
     "x-keycloakify": {
-        realmMessageBundleUserProfile: Record<string, string> | undefined;
-        realmMessageBundleTermsText: string | undefined;
+        messages: Record<string, string>;
     };
 };
 
@@ -131,8 +130,7 @@ export function createGetI18n<ExtraMessageKey extends string = never>(messageBun
             messages_fallbackLanguage,
             messageBundle_fallbackLanguage: messageBundle[fallbackLanguageTag],
             messageBundle_currentLanguage: messageBundle[partialI18n.currentLanguageTag],
-            realmMessageBundleUserProfile: kcContext["x-keycloakify"].realmMessageBundleUserProfile,
-            realmMessageBundleTermsText: kcContext["x-keycloakify"].realmMessageBundleTermsText
+            messageBundle_realm: kcContext["x-keycloakify"].messages
         });
 
         const isCurrentLanguageFallbackLanguage = partialI18n.currentLanguageTag === fallbackLanguageTag;
@@ -179,10 +177,9 @@ function createI18nTranslationFunctionsFactory<MessageKey extends string, ExtraM
     messages_fallbackLanguage: Record<MessageKey, string>;
     messageBundle_fallbackLanguage: Record<ExtraMessageKey, string> | undefined;
     messageBundle_currentLanguage: Partial<Record<ExtraMessageKey, string>> | undefined;
-    realmMessageBundleUserProfile: Record<string, string> | undefined;
-    realmMessageBundleTermsText: string | undefined;
+    messageBundle_realm: Record<string, string>;
 }) {
-    const { messageBundle_currentLanguage, realmMessageBundleUserProfile, realmMessageBundleTermsText } = params;
+    const { messageBundle_currentLanguage, messageBundle_realm } = params;
 
     const messages_fallbackLanguage = {
         ...params.messages_fallbackLanguage,
@@ -201,12 +198,21 @@ function createI18nTranslationFunctionsFactory<MessageKey extends string, ExtraM
             const { key, args, doRenderAsHtml } = props;
 
             const messageOrUndefined: string | undefined = (() => {
-                const messageOrUndefined = (messages_currentLanguage as any)[key] ?? (messages_fallbackLanguage as any)[key];
+                terms_text: {
+                    if (key !== "termsText") {
+                        break terms_text;
+                    }
+                    const termsTextMessage = messageBundle_realm[key];
+
+                    if (termsTextMessage === undefined) {
+                        break terms_text;
+                    }
 
-                if (key === "termsText" && realmMessageBundleTermsText !== undefined) {
-                    return realmMessageBundleTermsText;
+                    return termsTextMessage;
                 }
 
+                const messageOrUndefined = (messages_currentLanguage as any)[key] ?? (messages_fallbackLanguage as any)[key];
+
                 return messageOrUndefined;
             })();
 
@@ -259,15 +265,11 @@ function createI18nTranslationFunctionsFactory<MessageKey extends string, ExtraM
         function resolveMsgAdvanced(props: { key: string; args: (string | undefined)[]; doRenderAsHtml: boolean }): JSX.Element | string {
             const { key, args, doRenderAsHtml } = props;
 
-            user_profile: {
-                if (realmMessageBundleUserProfile === undefined) {
-                    break user_profile;
-                }
-
-                const resolvedMessage = realmMessageBundleUserProfile[key] ?? realmMessageBundleUserProfile["${" + key + "}"];
+            realm_messages: {
+                const resolvedMessage = messageBundle_realm[key] ?? messageBundle_realm["${" + key + "}"];
 
                 if (resolvedMessage === undefined) {
-                    break user_profile;
+                    break realm_messages;
                 }
 
                 return doRenderAsHtml ? (

package/src/login/pages/Info.tsx

@@ -5,7 +5,7 @@ import type { I18n } from "../i18n";
 export default function Info(props: PageProps<Extract<KcContext, { pageId: "info.ftl" }>, I18n>) {
     const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
 
-    const { msgStr, msg } = i18n;
+    const { advancedMsgStr, msg } = i18n;
 
     const { messageHeader, message, requiredActions, skipLink, pageRedirectUri, actionUri, client } = kcContext;
 
@@ -34,7 +34,7 @@ export default function Info(props: PageProps<Extract<KcContext, { pageId: "info
                             if (requiredActions) {
                                 html += "<b>";
 
-                                html += requiredActions.map(requiredAction => msgStr(`requiredAction.${requiredAction}` as const)).join(",");
+                                html += requiredActions.map(requiredAction => advancedMsgStr(`requiredAction.${requiredAction}`)).join(",");
 
                                 html += "</b>";
                             }

package/src/login/pages/SelectAuthenticator.tsx

@@ -8,7 +8,7 @@ export default function SelectAuthenticator(props: PageProps<Extract<KcContext,
     const { url, auth } = kcContext;
 
     const { kcClsx } = getKcClsx({ doUseDefaultCss, classes });
-    const { msg } = i18n;
+    const { msg, advancedMsg } = i18n;
 
     return (
         <Template
@@ -30,11 +30,11 @@ export default function SelectAuthenticator(props: PageProps<Extract<KcContext,
                             value={authenticationSelection.authExecId}
                         >
                             <div className={kcClsx("kcSelectAuthListItemIconClass")}>
-                                <i className={kcClsx(authenticationSelection.iconCssClass, "kcSelectAuthListItemIconPropertyClass")} />
+                                <i className={kcClsx("kcSelectAuthListItemIconPropertyClass", authenticationSelection.iconCssClass)} />
                             </div>
                             <div className={kcClsx("kcSelectAuthListItemBodyClass")}>
-                                <div className={kcClsx("kcSelectAuthListItemHeadingClass")}>{msg(authenticationSelection.displayName)}</div>
-                                <div className={kcClsx("kcSelectAuthListItemDescriptionClass")}>{msg(authenticationSelection.helpText)}</div>
+                                <div className={kcClsx("kcSelectAuthListItemHeadingClass")}>{advancedMsg(authenticationSelection.displayName)}</div>
+                                <div className={kcClsx("kcSelectAuthListItemDescriptionClass")}>{advancedMsg(authenticationSelection.helpText)}</div>
                             </div>
                             <div className={kcClsx("kcSelectAuthListItemFillClass")} />
                             <div className={kcClsx("kcSelectAuthListItemArrowClass")}>

package/src/login/pages/WebauthnAuthenticate.tsx

@@ -204,13 +204,13 @@ export default function WebauthnAuthenticate(props: PageProps<Extract<KcContext,
                                                             className={kcClsx("kcSelectAuthListItemDescriptionClass")}
                                                         >
                                                             {authenticator.transports.displayNameProperties
-                                                                .map((nameProperty, i, arr) => ({
-                                                                    nameProperty,
+                                                                .map((displayNameProperty, i, arr) => ({
+                                                                    displayNameProperty,
                                                                     hasNext: i !== arr.length - 1
                                                                 }))
-                                                                .map(({ nameProperty, hasNext }) => (
-                                                                    <Fragment key={nameProperty}>
-                                                                        <span>{msg(nameProperty)}</span>
+                                                                .map(({ displayNameProperty, hasNext }) => (
+                                                                    <Fragment key={displayNameProperty}>
+                                                                        {advancedMsg(displayNameProperty)}
                                                                         {hasNext && <span>, </span>}
                                                                     </Fragment>
                                                                 ))}

package/stories/login/pages/Info.stories.tsx

@@ -43,9 +43,14 @@ export const WithRequiredActions: Story = {
         <KcPageStory
             kcContext={{
                 message: {
-                    summary: "Server message"
+                    summary: "Required actions: "
                 },
-                requiredActions: ["CONFIGURE_TOTP", "UPDATE_PROFILE", "VERIFY_EMAIL"]
+                requiredActions: ["CONFIGURE_TOTP", "UPDATE_PROFILE", "VERIFY_EMAIL", "CUSTOM_ACTION"],
+                "x-keycloakify": {
+                    messages: {
+                        "requiredAction.CUSTOM_ACTION": "Custom action"
+                    }
+                }
             }}
         />
     )

package/stories/login/pages/Register.stories.tsx

@@ -69,7 +69,7 @@ export const WithRestrictedToMITStudents: Story = {
                     }
                 },
                 "x-keycloakify": {
-                    realmMessageBundleUserProfile: {
+                    messages: {
                         "${profile.attributes.email.inputHelperTextBefore}": "Please use your MIT or Berkeley email.",
                         "${profile.attributes.email.pattern.error}":
                             "This is not an MIT (<strong>@mit.edu</strong>) nor a Berkeley (<strong>@berkeley.edu</strong>) email."
@@ -103,7 +103,7 @@ export const WithFavoritePet: Story = {
                     }
                 },
                 "x-keycloakify": {
-                    realmMessageBundleUserProfile: {
+                    messages: {
                         "${profile.attributes.favoritePet}": "Favorite Pet",
                         "${profile.attributes.favoritePet.options.cat}": "Fluffy Cat",
                         "${profile.attributes.favoritePet.options.dog}": "Loyal Dog",
@@ -177,7 +177,9 @@ export const WithTermsAcceptance: Story = {
             kcContext={{
                 termsAcceptanceRequired: true,
                 "x-keycloakify": {
-                    realmMessageBundleTermsText: "<a href='https://example.com/terms'>Service Terms of Use</a>"
+                    messages: {
+                        termsText: "<a href='https://example.com/terms'>Service Terms of Use</a>"
+                    }
                 }
             }}
         />

package/stories/login/pages/SelectAuthenticator.stories.tsx

@@ -41,3 +41,29 @@ export const WithDifferentAuthenticationMethods: Story = {
         />
     )
 };
+
+export const WithRealmTranslations: Story = {
+    render: () => (
+        <KcPageStory
+            kcContext={{
+                auth: {
+                    authenticationSelections: [
+                        {
+                            authExecId: "f0c22855-eda7-4092-8565-0c22f77d2ffb",
+                            displayName: "home-idp-discovery-display-name",
+                            helpText: "home-idp-discovery-help-text",
+                            iconCssClass: "kcAuthenticatorDefaultClass"
+                        }
+                    ]
+                },
+                ["x-keycloakify"]: {
+                    messages: {
+                        "${home-idp-discovery-display-name}": "Home identity provider",
+                        "${home-idp-discovery-help-text}":
+                            "Sign in via your home identity provider which will be automatically determined based on your provided email address."
+                    }
+                }
+            }}
+        />
+    )
+};

package/stories/login/pages/Terms.stories.tsx

@@ -18,7 +18,9 @@ export const Default: Story = {
         <KcPageStory
             kcContext={{
                 "x-keycloakify": {
-                    realmMessageBundleTermsText: "<p>My terms in <strong>English</strong></p>"
+                    messages: {
+                        termsText: "<p>My terms in <strong>English</strong></p>"
+                    }
                 }
             }}
         />
@@ -34,7 +36,9 @@ export const French: Story = {
                 },
                 "x-keycloakify": {
                     // cSpell: disable
-                    realmMessageBundleTermsText: "<p>Mes terme en <strong>Français</strong></p>"
+                    messages: {
+                        termsText: "<p>Mes terme en <strong>Français</strong></p>"
+                    }
                     // cSpell: enable
                 }
             }}

package/vite-plugin/index.js

@@ -5135,11 +5135,12 @@ async function downloadKeycloakDefaultTheme(params) {
                     return;
                 }
                 skip_node_modules: {
-                    if (!fileRelativePath.startsWith((0,external_path_.join)("keycloak", "common", "resources", "node_modules"))) {
+                    const nodeModulesRelativeDirPath = (0,external_path_.join)("keycloak", "common", "resources", "node_modules");
+                    if (!fileRelativePath.startsWith(nodeModulesRelativeDirPath)) {
                         break skip_node_modules;
                     }
                     if (kcNodeModulesKeepFilePaths_lastAccountV1 === undefined) {
-                        kcNodeModulesKeepFilePaths_lastAccountV1 = [
+                        kcNodeModulesKeepFilePaths_lastAccountV1 = new Set([
                             (0,external_path_.join)("patternfly", "dist", "css", "patternfly.min.css"),
                             (0,external_path_.join)("patternfly", "dist", "css", "patternfly-additions.min.css"),
                             (0,external_path_.join)("patternfly", "dist", "fonts", "OpenSans-Regular-webfont.woff2"),
@@ -5148,12 +5149,11 @@ async function downloadKeycloakDefaultTheme(params) {
                             (0,external_path_.join)("patternfly", "dist", "fonts", "OpenSans-Semibold-webfont.woff2"),
                             (0,external_path_.join)("patternfly", "dist", "fonts", "PatternFlyIcons-webfont.ttf"),
                             (0,external_path_.join)("patternfly", "dist", "fonts", "PatternFlyIcons-webfont.woff")
-                        ];
+                        ]);
                     }
-                    for (const keepPath of kcNodeModulesKeepFilePaths_lastAccountV1) {
-                        if (fileRelativePath.endsWith(keepPath)) {
-                            break skip_node_modules;
-                        }
+                    const fileRelativeToNodeModulesPath = fileRelativePath.substring(nodeModulesRelativeDirPath.length + 1);
+                    if (kcNodeModulesKeepFilePaths_lastAccountV1.has(fileRelativeToNodeModulesPath)) {
+                        break skip_node_modules;
                     }
                     return;
                 }
@@ -5176,11 +5176,12 @@ async function downloadKeycloakDefaultTheme(params) {
                     break skip_unused_resources;
                 }
                 skip_node_modules: {
-                    if (!fileRelativePath.startsWith((0,external_path_.join)("keycloak", "common", "resources", "node_modules"))) {
+                    const nodeModulesRelativeDirPath = (0,external_path_.join)("keycloak", "common", "resources", "node_modules");
+                    if (!fileRelativePath.startsWith(nodeModulesRelativeDirPath)) {
                         break skip_node_modules;
                     }
                     if (kcNodeModulesKeepFilePaths === undefined) {
-                        kcNodeModulesKeepFilePaths = [
+                        kcNodeModulesKeepFilePaths = new Set([
                             (0,external_path_.join)("@patternfly", "patternfly", "patternfly.min.css"),
                             (0,external_path_.join)("patternfly", "dist", "css", "patternfly.min.css"),
                             (0,external_path_.join)("patternfly", "dist", "css", "patternfly-additions.min.css"),
@@ -5192,14 +5193,14 @@ async function downloadKeycloakDefaultTheme(params) {
                             (0,external_path_.join)("patternfly", "dist", "fonts", "fontawesome-webfont.woff2"),
                             (0,external_path_.join)("patternfly", "dist", "fonts", "PatternFlyIcons-webfont.ttf"),
                             (0,external_path_.join)("patternfly", "dist", "fonts", "PatternFlyIcons-webfont.woff"),
+                            (0,external_path_.join)("patternfly", "dist", "fonts", "OpenSans-Semibold-webfont.woff2"),
                             (0,external_path_.join)("patternfly", "dist", "img", "bg-login.jpg"),
                             (0,external_path_.join)("jquery", "dist", "jquery.min.js")
-                        ];
+                        ]);
                     }
-                    for (const keepPath of kcNodeModulesKeepFilePaths) {
-                        if (fileRelativePath.endsWith(keepPath)) {
-                            break skip_node_modules;
-                        }
+                    const fileRelativeToNodeModulesPath = fileRelativePath.substring(nodeModulesRelativeDirPath.length + 1);
+                    if (kcNodeModulesKeepFilePaths.has(fileRelativeToNodeModulesPath)) {
+                        break skip_node_modules;
                     }
                     return;
                 }

package/src/tools/ExtractAfterStartingWith.ts

@@ -1,4 +0,0 @@
-export type ExtractAfterStartingWith<
-    Prefix extends string,
-    StrEnum
-> = StrEnum extends `${Prefix}${infer U}` ? U : never;

package/tools/ExtractAfterStartingWith.d.ts

@@ -1 +0,0 @@
-export type ExtractAfterStartingWith<Prefix extends string, StrEnum> = StrEnum extends `${Prefix}${infer U}` ? U : never;

package/tools/ExtractAfterStartingWith.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=ExtractAfterStartingWith.js.map

package/tools/ExtractAfterStartingWith.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ExtractAfterStartingWith.js","sourceRoot":"","sources":["../src/tools/ExtractAfterStartingWith.ts"],"names":[],"mappings":""}