keycloakify 10.0.0-rc.77 → 10.0.0-rc.78

package/src/login/i18n/useI18n.ts

@@ -0,0 +1,44 @@
+import { useEffect, useState } from "react";
+import {
+    createGetI18n,
+    type GenericI18n,
+    type MessageKey,
+    type KcContextLike
+} from "./i18n";
+import { Reflect } from "tsafe/Reflect";
+
+export function createUseI18n<ExtraMessageKey extends string = never>(extraMessages: {
+    [languageTag: string]: { [key in ExtraMessageKey]: string };
+}) {
+    type I18n = GenericI18n<MessageKey | ExtraMessageKey>;
+
+    const { getI18n } = createGetI18n(extraMessages);
+
+    function useI18n(params: { kcContext: KcContextLike }): { i18n: I18n } {
+        const { kcContext } = params;
+
+        const { i18n, prI18n_currentLanguage } = getI18n({ kcContext });
+
+        const [i18n_toReturn, setI18n_toReturn] = useState<I18n>(i18n);
+
+        useEffect(() => {
+            let isActive = true;
+
+            prI18n_currentLanguage?.then(i18n => {
+                if (!isActive) {
+                    return;
+                }
+
+                setI18n_toReturn(i18n);
+            });
+
+            return () => {
+                isActive = false;
+            };
+        }, []);
+
+        return { i18n: i18n_toReturn };
+    }
+
+    return { useI18n, ofTypeI18n: Reflect<I18n>() };
+}

package/src/login/lib/useDownloadTerms.tsx

@@ -0,0 +1,88 @@
+import { useState, useEffect } from "react";
+import { fallbackLanguageTag } from "keycloakify/login/i18n";
+import { assert } from "tsafe/assert";
+import { createStatefulObservable, useRerenderOnChange } from "keycloakify/tools/StatefulObservable";
+import { useOnFistMount } from "keycloakify/tools/useOnFirstMount";
+import { KcContext } from "../KcContext";
+import type { Options as ReactMarkdownOptions } from "../../tools/react-markdown";
+
+const obs = createStatefulObservable<
+    | {
+          ReactMarkdown: (props: Readonly<ReactMarkdownOptions>) => JSX.Element;
+          termsMarkdown: string;
+      }
+    | undefined
+>(() => undefined);
+
+export type KcContextLike_useDownloadTerms = {
+    pageId: string;
+    locale?: {
+        currentLanguageTag: string;
+    };
+    termsAcceptanceRequired?: boolean;
+};
+
+assert<KcContext extends KcContextLike_useDownloadTerms ? true : false>();
+
+/** Allow to avoid bundling the terms and download it on demand*/
+export function useDownloadTerms(params: {
+    kcContext: KcContextLike_useDownloadTerms;
+    downloadTermsMarkdown: (params: { currentLanguageTag: string }) => Promise<{ termsMarkdown: string; termsLanguageTag: string | undefined }>;
+}) {
+    const { kcContext, downloadTermsMarkdown } = params;
+
+    useOnFistMount(async () => {
+        if (kcContext.pageId === "terms.ftl" || kcContext.termsAcceptanceRequired) {
+            const currentLanguageTag = kcContext.locale?.currentLanguageTag ?? fallbackLanguageTag;
+
+            const [ReactMarkdown_base, { termsMarkdown, termsLanguageTag }] = await Promise.all([
+                import("../../tools/react-markdown").then(_ => _.default),
+                downloadTermsMarkdown({ currentLanguageTag })
+            ] as const);
+
+            const htmlLang = termsLanguageTag !== currentLanguageTag ? termsLanguageTag : undefined;
+
+            const ReactMarkdown: (props: Readonly<ReactMarkdownOptions>) => JSX.Element =
+                htmlLang === undefined
+                    ? ReactMarkdown_base
+                    : props => {
+                          const [anchor, setAnchor] = useState<HTMLDivElement | null>(null);
+
+                          useEffect(() => {
+                              if (anchor === null) {
+                                  return;
+                              }
+
+                              const parent = anchor.parentElement;
+
+                              assert(parent !== null);
+
+                              parent.setAttribute("lang", htmlLang);
+
+                              anchor.remove();
+                          }, [anchor]);
+
+                          return (
+                              <>
+                                  <ReactMarkdown_base {...props} />
+                                  <div ref={setAnchor} style={{ display: "none" }} aria-hidden />
+                              </>
+                          );
+                      };
+
+            obs.current = { ReactMarkdown, termsMarkdown };
+        }
+    });
+}
+
+export function useTermsMarkdown() {
+    useRerenderOnChange(obs);
+
+    if (obs.current === undefined) {
+        return { isDownloadComplete: false as const };
+    }
+
+    const { ReactMarkdown, termsMarkdown } = obs.current;
+
+    return { isDownloadComplete: true, ReactMarkdown, termsMarkdown };
+}

package/src/login/pages/Register.tsx

@@ -1,5 +1,4 @@
 import { useState } from "react";
-import { Markdown } from "keycloakify/tools/Markdown";
 import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
 import { useTermsMarkdown } from "keycloakify/login/lib/useDownloadTerms";
 import { getKcClsx, type KcClsx } from "keycloakify/login/lib/kcClsx";
@@ -78,23 +77,14 @@ export default function Register(props: RegisterProps) {
 function TermsAcceptance(props: { i18n: I18n; kcClsx: KcClsx; messagesPerField: Pick<KcContext["messagesPerField"], "existsError" | "get"> }) {
     const { i18n, kcClsx, messagesPerField } = props;
 
-    const { msg } = i18n;
-
-    // NOTE: Refer to https://docs.keycloakify.dev/terms-and-conditions to load your terms and conditions.
-    const { termsMarkdown } = useTermsMarkdown();
-
-    if (termsMarkdown === undefined) {
-        return null;
-    }
+    const { msg, msgStr } = i18n;
 
     return (
         <>
             <div className="form-group">
                 <div className={kcClsx("kcInputWrapperClass")}>
                     {msg("termsTitle")}
-                    <div id="kc-registration-terms-text">
-                        <Markdown>{termsMarkdown}</Markdown>
-                    </div>
+                    <div id="kc-registration-terms-text">{msgStr("termsText") ? msg("termsText") : <TermsMarkdown />}</div>
                 </div>
             </div>
             <div className="form-group">
@@ -121,3 +111,13 @@ function TermsAcceptance(props: { i18n: I18n; kcClsx: KcClsx; messagesPerField:
         </>
     );
 }
+
+function TermsMarkdown() {
+    const { isDownloadComplete, termsMarkdown, ReactMarkdown } = useTermsMarkdown();
+
+    if (!isDownloadComplete) {
+        return null;
+    }
+
+    return <ReactMarkdown>{termsMarkdown}</ReactMarkdown>;
+}

package/src/login/pages/Terms.tsx

@@ -1,4 +1,3 @@
-import { Markdown } from "keycloakify/tools/Markdown";
 import { getKcClsx } from "keycloakify/login/lib/kcClsx";
 import { useTermsMarkdown } from "keycloakify/login/lib/useDownloadTerms";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
@@ -15,13 +14,7 @@ export default function Terms(props: PageProps<Extract<KcContext, { pageId: "ter
 
     const { msg, msgStr } = i18n;
 
-    const { locale, url } = kcContext;
-
-    const { isDownloadComplete, termsMarkdown, termsLanguageTag } = useTermsMarkdown();
-
-    if (!isDownloadComplete) {
-        return null;
-    }
+    const { url } = kcContext;
 
     return (
         <Template
@@ -32,9 +25,7 @@ export default function Terms(props: PageProps<Extract<KcContext, { pageId: "ter
             displayMessage={false}
             headerNode={msg("termsTitle")}
         >
-            <div id="kc-terms-text" lang={termsLanguageTag !== locale?.currentLanguageTag ? termsLanguageTag : undefined}>
-                <Markdown>{termsMarkdown}</Markdown>
-            </div>
+            <div id="kc-terms-text">{msgStr("termsText") ? msg("termsText") : <TermsMarkdown />}</div>
             <form className="form-actions" action={url.loginAction} method="POST">
                 <input
                     className={kcClsx("kcButtonClass", "kcButtonClass", "kcButtonClass", "kcButtonPrimaryClass", "kcButtonLargeClass")}
@@ -55,3 +46,13 @@ export default function Terms(props: PageProps<Extract<KcContext, { pageId: "ter
         </Template>
     );
 }
+
+function TermsMarkdown() {
+    const { isDownloadComplete, termsMarkdown, ReactMarkdown } = useTermsMarkdown();
+
+    if (!isDownloadComplete) {
+        return null;
+    }
+
+    return <ReactMarkdown>{termsMarkdown}</ReactMarkdown>;
+}

package/src/tools/react-markdown.ts

@@ -0,0 +1,3 @@
+export * from "react-markdown";
+import Markdown from "react-markdown";
+export default Markdown;

package/tools/react-markdown.d.ts

@@ -0,0 +1,3 @@
+export * from "react-markdown";
+import Markdown from "react-markdown";
+export default Markdown;

package/tools/react-markdown.js

@@ -0,0 +1,4 @@
+export * from "react-markdown";
+import Markdown from "react-markdown";
+export default Markdown;
+//# sourceMappingURL=react-markdown.js.map

package/tools/react-markdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"react-markdown.js","sourceRoot":"","sources":["../src/tools/react-markdown.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,eAAe,QAAQ,CAAC"}

package/vite-plugin/index.js

@@ -4569,12 +4569,10 @@ __nccwpck_require__.r(__webpack_exports__);
 /* harmony export */   "keycloak_resources": () => (/* binding */ keycloak_resources),
 /* harmony export */   "lastKeycloakVersionWithAccountV1": () => (/* binding */ lastKeycloakVersionWithAccountV1),
 /* harmony export */   "loginThemePageIds": () => (/* binding */ loginThemePageIds),
-/* harmony export */   "nameOfTheLocalizationRealmOverridesUserProfileProperty": () => (/* binding */ nameOfTheLocalizationRealmOverridesUserProfileProperty),
 /* harmony export */   "resources_common": () => (/* binding */ resources_common),
 /* harmony export */   "themeTypes": () => (/* binding */ themeTypes),
 /* harmony export */   "vitePluginSubScriptEnvNames": () => (/* binding */ vitePluginSubScriptEnvNames)
 /* harmony export */ });
-const nameOfTheLocalizationRealmOverridesUserProfileProperty = "__localizationRealmOverridesUserProfile";
 const keycloak_resources = "keycloak-resources";
 const resources_common = "resources-common";
 const lastKeycloakVersionWithAccountV1 = "21.1.2";

package/src/login/lib/useDownloadTerms.ts

@@ -1,57 +0,0 @@
-import { fallbackLanguageTag } from "keycloakify/login/i18n";
-import { assert } from "tsafe/assert";
-import {
-    createStatefulObservable,
-    useRerenderOnChange
-} from "keycloakify/tools/StatefulObservable";
-import { useOnFistMount } from "keycloakify/tools/useOnFirstMount";
-import { KcContext } from "../KcContext";
-
-const obs = createStatefulObservable<
-    | {
-          termsMarkdown: string;
-          termsLanguageTag: string | undefined;
-      }
-    | undefined
->(() => undefined);
-
-export type KcContextLike = {
-    pageId: string;
-    locale?: {
-        currentLanguageTag: string;
-    };
-    termsAcceptanceRequired?: boolean;
-};
-
-assert<KcContext extends KcContextLike ? true : false>();
-
-/** Allow to avoid bundling the terms and download it on demand*/
-export function useDownloadTerms(params: {
-    kcContext: KcContextLike;
-    downloadTermsMarkdown: (params: {
-        currentLanguageTag: string;
-    }) => Promise<{ termsMarkdown: string; termsLanguageTag: string | undefined }>;
-}) {
-    const { kcContext, downloadTermsMarkdown } = params;
-
-    useOnFistMount(async () => {
-        if (kcContext.pageId === "terms.ftl" || kcContext.termsAcceptanceRequired) {
-            obs.current = await downloadTermsMarkdown({
-                currentLanguageTag:
-                    kcContext.locale?.currentLanguageTag ?? fallbackLanguageTag
-            });
-        }
-    });
-}
-
-export function useTermsMarkdown() {
-    useRerenderOnChange(obs);
-
-    if (obs.current === undefined) {
-        return { isDownloadComplete: false as const };
-    }
-
-    const { termsMarkdown, termsLanguageTag } = obs.current;
-
-    return { isDownloadComplete: true, termsMarkdown, termsLanguageTag };
-}

package/src/tools/Markdown.ts

@@ -1,3 +0,0 @@
-import Markdown from "react-markdown";
-
-export { Markdown };

package/tools/Markdown.d.ts

@@ -1,2 +0,0 @@
-import Markdown from "react-markdown";
-export { Markdown };

package/tools/Markdown.js

@@ -1,3 +0,0 @@
-import Markdown from "react-markdown";
-export { Markdown };
-//# sourceMappingURL=Markdown.js.map

package/tools/Markdown.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Markdown.js","sourceRoot":"","sources":["../src/tools/Markdown.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAEtC,OAAO,EAAE,QAAQ,EAAE,CAAC"}