keycloakify 6.1.0 → 6.3.2

package/src/lib/getKcContext/KcContextBase.ts

@@ -25,7 +25,9 @@ export type KcContextBase =
     | KcContextBase.LoginIdpLinkEmail
     | KcContextBase.LoginPageExpired
     | KcContextBase.LoginConfigTotp
-    | KcContextBase.LogoutConfirm;
+    | KcContextBase.LogoutConfirm
+    | KcContextBase.UpdateUserProfile
+    | KcContextBase.IdpReviewUserProfile;
 
 export declare namespace KcContextBase {
     export type Common = {
@@ -270,6 +272,23 @@ export declare namespace KcContextBase {
             skipLink?: boolean;
         };
     };
+
+    export type UpdateUserProfile = Common & {
+        pageId: "update-user-profile.ftl";
+        profile: {
+            attributes: Attribute[];
+            attributesByName: Record<string, Attribute>;
+        };
+    };
+
+    export type IdpReviewUserProfile = Common & {
+        pageId: "idp-review-user-profile.ftl";
+        profile: {
+            context: "IDP_REVIEW";
+            attributes: Attribute[];
+            attributesByName: Record<string, Attribute>;
+        };
+    };
 }
 
 export type Attribute = {

package/src/lib/getKcContext/getKcContext.ts

@@ -47,8 +47,16 @@ export function getKcContext<KcContextExtended extends { pageId: string } = neve
                 "source": partialKcContextCustomMock
             });
 
-            if (partialKcContextCustomMock.pageId === "register-user-profile.ftl") {
-                assert(kcContextDefaultMock?.pageId === "register-user-profile.ftl");
+            if (
+                partialKcContextCustomMock.pageId === "register-user-profile.ftl" ||
+                partialKcContextCustomMock.pageId === "update-user-profile.ftl" ||
+                partialKcContextCustomMock.pageId === "idp-review-user-profile.ftl"
+            ) {
+                assert(
+                    kcContextDefaultMock?.pageId === "register-user-profile.ftl" ||
+                        kcContextDefaultMock?.pageId === "update-user-profile.ftl" ||
+                        kcContextDefaultMock?.pageId === "idp-review-user-profile.ftl"
+                );
 
                 const { attributes } = kcContextDefaultMock.profile;
 
@@ -60,8 +68,6 @@ 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;

package/src/lib/getKcContext/kcContextMocks/kcContextMocks.ts

@@ -7,6 +7,100 @@ import { pathJoin } from "../../../bin/tools/pathJoin";
 
 const PUBLIC_URL = process.env["PUBLIC_URL"] ?? "/";
 
+const attributes: Attribute[] = [
+    {
+        "validators": {
+            "username-prohibited-characters": {
+                "ignore.empty.value": true
+            },
+            "up-username-has-value": {},
+            "length": {
+                "ignore.empty.value": true,
+                "min": "3",
+                "max": "255"
+            },
+            "up-duplicate-username": {},
+            "up-username-mutation": {}
+        },
+        "displayName": "${username}",
+        "annotations": {},
+        "required": true,
+        "groupAnnotations": {},
+        "autocomplete": "username",
+        "readOnly": false,
+        "name": "username",
+        "value": "xxxx"
+    },
+    {
+        "validators": {
+            "up-email-exists-as-username": {},
+            "length": {
+                "max": "255",
+                "ignore.empty.value": true
+            },
+            "up-blank-attribute-value": {
+                "error-message": "missingEmailMessage",
+                "fail-on-null": false
+            },
+            "up-duplicate-email": {},
+            "email": {
+                "ignore.empty.value": true
+            },
+            "pattern": {
+                "ignore.empty.value": true,
+                "pattern": "gmail\\.com$"
+            }
+        },
+        "displayName": "${email}",
+        "annotations": {},
+        "required": true,
+        "groupAnnotations": {},
+        "autocomplete": "email",
+        "readOnly": false,
+        "name": "email"
+    },
+    {
+        "validators": {
+            "length": {
+                "max": "255",
+                "ignore.empty.value": true
+            },
+            "person-name-prohibited-characters": {
+                "ignore.empty.value": true
+            },
+            "up-immutable-attribute": {},
+            "up-attribute-required-by-metadata-value": {}
+        },
+        "displayName": "${firstName}",
+        "annotations": {},
+        "required": true,
+        "groupAnnotations": {},
+        "readOnly": false,
+        "name": "firstName"
+    },
+    {
+        "validators": {
+            "length": {
+                "max": "255",
+                "ignore.empty.value": true
+            },
+            "person-name-prohibited-characters": {
+                "ignore.empty.value": true
+            },
+            "up-immutable-attribute": {},
+            "up-attribute-required-by-metadata-value": {}
+        },
+        "displayName": "${lastName}",
+        "annotations": {},
+        "required": true,
+        "groupAnnotations": {},
+        "readOnly": false,
+        "name": "lastName"
+    }
+];
+
+const attributesByName = Object.fromEntries(attributes.map(attribute => [attribute.name, attribute])) as any;
+
 export const kcContextCommonMock: KcContextBase.Common = {
     "url": {
         "loginAction": "#",
@@ -200,104 +294,8 @@ export const kcContextMocks: KcContextBase[] = [
                 ...registerCommon,
                 "profile": {
                     "context": "REGISTRATION_PROFILE" as const,
-                    ...(() => {
-                        const attributes: Attribute[] = [
-                            {
-                                "validators": {
-                                    "username-prohibited-characters": {
-                                        "ignore.empty.value": true
-                                    },
-                                    "up-username-has-value": {},
-                                    "length": {
-                                        "ignore.empty.value": true,
-                                        "min": "3",
-                                        "max": "255"
-                                    },
-                                    "up-duplicate-username": {},
-                                    "up-username-mutation": {}
-                                },
-                                "displayName": "${username}",
-                                "annotations": {},
-                                "required": true,
-                                "groupAnnotations": {},
-                                "autocomplete": "username",
-                                "readOnly": false,
-                                "name": "username",
-                                "value": "xxxx"
-                            },
-                            {
-                                "validators": {
-                                    "up-email-exists-as-username": {},
-                                    "length": {
-                                        "max": "255",
-                                        "ignore.empty.value": true
-                                    },
-                                    "up-blank-attribute-value": {
-                                        "error-message": "missingEmailMessage",
-                                        "fail-on-null": false
-                                    },
-                                    "up-duplicate-email": {},
-                                    "email": {
-                                        "ignore.empty.value": true
-                                    },
-                                    "pattern": {
-                                        "ignore.empty.value": true,
-                                        "pattern": "gmail\\.com$"
-                                    }
-                                },
-                                "displayName": "${email}",
-                                "annotations": {},
-                                "required": true,
-                                "groupAnnotations": {},
-                                "autocomplete": "email",
-                                "readOnly": false,
-                                "name": "email"
-                            },
-                            {
-                                "validators": {
-                                    "length": {
-                                        "max": "255",
-                                        "ignore.empty.value": true
-                                    },
-                                    "person-name-prohibited-characters": {
-                                        "ignore.empty.value": true
-                                    },
-                                    "up-immutable-attribute": {},
-                                    "up-attribute-required-by-metadata-value": {}
-                                },
-                                "displayName": "${firstName}",
-                                "annotations": {},
-                                "required": true,
-                                "groupAnnotations": {},
-                                "readOnly": false,
-                                "name": "firstName"
-                            },
-                            {
-                                "validators": {
-                                    "length": {
-                                        "max": "255",
-                                        "ignore.empty.value": true
-                                    },
-                                    "person-name-prohibited-characters": {
-                                        "ignore.empty.value": true
-                                    },
-                                    "up-immutable-attribute": {},
-                                    "up-attribute-required-by-metadata-value": {}
-                                },
-                                "displayName": "${lastName}",
-                                "annotations": {},
-                                "required": true,
-                                "groupAnnotations": {},
-                                "readOnly": false,
-                                "name": "lastName"
-                            }
-                        ];
-
-                        return {
-                            attributes,
-                            "attributesByName": Object.fromEntries(attributes.map(attribute => [attribute.name, attribute])) as any
-                        } as any;
-                    })()
+                    attributes,
+                    attributesByName
                 }
             })
         ];
@@ -423,5 +421,22 @@ export const kcContextMocks: KcContextBase[] = [
             "baseUrl": "#"
         },
         "logoutConfirm": { "code": "123", skipLink: false }
+    }),
+    id<KcContextBase.UpdateUserProfile>({
+        ...kcContextCommonMock,
+        "pageId": "update-user-profile.ftl",
+        "profile": {
+            attributes,
+            attributesByName
+        }
+    }),
+    id<KcContextBase.IdpReviewUserProfile>({
+        ...kcContextCommonMock,
+        "pageId": "idp-review-user-profile.ftl",
+        "profile": {
+            context: "IDP_REVIEW",
+            attributes,
+            attributesByName
+        }
     })
 ];

package/src/lib/i18n/index.tsx

@@ -1,10 +1,10 @@
 import "minimal-polyfills/Object.fromEntries";
 //NOTE for later: https://github.com/remarkjs/react-markdown/blob/236182ecf30bd89c1e5a7652acaf8d0bf81e6170/src/renderers.js#L7-L35
 import React, { useEffect, useState, useRef } from "react";
-import ReactMarkdown from "react-markdown";
 import type baseMessages from "./generated_messages/18.0.1/login/en";
 import { assert } from "tsafe/assert";
 import type { KcContextBase } from "../getKcContext/KcContextBase";
+import { Markdown } from "../tools/Markdown";
 
 export const fallbackLanguageTag = "en";
 
@@ -234,9 +234,9 @@ function createI18nTranslationFunctions<MessageKey extends string>(params: {
         })();
 
         return doRenderMarkdown ? (
-            <ReactMarkdown allowDangerousHtml renderers={key === "termsText" ? undefined : { "paragraph": "span" }}>
+            <Markdown allowDangerousHtml renderers={{ "paragraph": "span" }}>
                 {messageWithArgsInjectedIfAny}
-            </ReactMarkdown>
+            </Markdown>
         ) : (
             messageWithArgsInjectedIfAny
         );

package/src/lib/tools/Markdown.ts

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

package/src/lib/useFormValidationSlice.tsx

@@ -304,13 +304,17 @@ export function useGetErrors(params: {
     return { getErrors };
 }
 
+/**
+ * NOTE: The attributesWithPassword returned is actually augmented with
+ * artificial password related attributes only if kcContext.passwordRequired === true
+ */
 export function useFormValidationSlice(params: {
     kcContext: {
         messagesPerField: Pick<KcContextBase.Common["messagesPerField"], "existsError" | "get">;
         profile: {
             attributes: Attribute[];
         };
-        passwordRequired: boolean;
+        passwordRequired?: boolean;
         realm: { registrationEmailAsUsername: boolean };
     };
     /** NOTE: Try to avoid passing a new ref every render for better performances. */