keycloakify 6.1.0 → 6.2.0

package/lib/useFormValidationSlice.d.ts

@@ -33,7 +33,7 @@ export declare function useFormValidationSlice(params: {
         profile: {
             attributes: Attribute[];
         };
-        passwordRequired: boolean;
+        passwordRequired?: boolean;
         realm: {
             registrationEmailAsUsername: boolean;
         };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "keycloakify",
-    "version": "6.1.0",
+    "version": "6.2.0",
     "description": "Keycloak theme generator for Reacts app",
     "repository": {
         "type": "git",
@@ -78,6 +78,8 @@
         "src/lib/components/RegisterUserProfile.tsx",
         "src/lib/components/Template.tsx",
         "src/lib/components/Terms.tsx",
+        "src/lib/components/UpdateUserProfile.tsx",
+        "src/lib/components/shared/UserProfileCommons.tsx",
         "src/lib/getKcContext/KcContextBase.ts",
         "src/lib/getKcContext/getKcContext.ts",
         "src/lib/getKcContext/getKcContextFromWindow.ts",
@@ -487,6 +489,12 @@
         "lib/components/Terms.d.ts",
         "lib/components/Terms.js",
         "lib/components/Terms.js.map",
+        "lib/components/UpdateUserProfile.d.ts",
+        "lib/components/UpdateUserProfile.js",
+        "lib/components/UpdateUserProfile.js.map",
+        "lib/components/shared/UserProfileCommons.d.ts",
+        "lib/components/shared/UserProfileCommons.js",
+        "lib/components/shared/UserProfileCommons.js.map",
         "lib/getKcContext/KcContextBase.d.ts",
         "lib/getKcContext/KcContextBase.js",
         "lib/getKcContext/KcContextBase.js.map",

package/src/bin/keycloakify/generateFtl/generateFtl.ts

@@ -27,7 +27,8 @@ export const pageIds = [
     "login-idp-link-email.ftl",
     "login-page-expired.ftl",
     "login-config-totp.ftl",
-    "logout-confirm.ftl"
+    "logout-confirm.ftl",
+    "update-user-profile.ftl"
 ] as const;
 
 export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.ExternalAssets;

package/src/lib/components/KcApp.tsx

@@ -20,6 +20,7 @@ const LoginPageExpired = lazy(() => import("./LoginPageExpired"));
 const LoginIdpLinkEmail = lazy(() => import("./LoginIdpLinkEmail"));
 const LoginConfigTotp = lazy(() => import("./LoginConfigTotp"));
 const LogoutConfirm = lazy(() => import("./LogoutConfirm"));
+const UpdateUserProfile = lazy(() => import("./UpdateUserProfile"));
 
 const KcApp = memo(({ kcContext, i18n: userProvidedI18n, ...kcProps }: { kcContext: KcContextBase; i18n?: I18n } & KcProps) => {
     const i18n = (function useClosure() {
@@ -74,6 +75,8 @@ const KcApp = memo(({ kcContext, i18n: userProvidedI18n, ...kcProps }: { kcConte
                         return <LoginConfigTotp {...{ kcContext, ...props }} />;
                     case "logout-confirm.ftl":
                         return <LogoutConfirm {...{ kcContext, ...props }} />;
+                    case "update-user-profile.ftl":
+                        return <UpdateUserProfile {...{ kcContext, ...props }} />;
                 }
             })()}
         </Suspense>

package/src/lib/components/RegisterUserProfile.tsx

@@ -1,12 +1,10 @@
-import React, { useMemo, memo, useEffect, useState, Fragment } from "react";
+import React, { useMemo, memo, useState } from "react";
 import Template from "./Template";
 import type { KcProps } from "./KcProps";
-import type { KcContextBase, Attribute } from "../getKcContext/KcContextBase";
+import type { KcContextBase } from "../getKcContext/KcContextBase";
 import { useCssAndCx } from "../tools/useCssAndCx";
-import type { ReactComponent } from "../tools/ReactComponent";
-import { useCallbackFactory } from "powerhooks/useCallbackFactory";
-import { useFormValidationSlice } from "../useFormValidationSlice";
 import type { I18n } from "../i18n";
+import { UserProfileFormFields } from "./shared/UserProfileCommons";
 
 const RegisterUserProfile = memo(({ kcContext, i18n, ...props_ }: { kcContext: KcContextBase.RegisterUserProfile; i18n: I18n } & KcProps) => {
     const { url, messagesPerField, recaptchaRequired, recaptchaSiteKey } = kcContext;
@@ -34,7 +32,13 @@ const RegisterUserProfile = memo(({ kcContext, i18n, ...props_ }: { kcContext: K
             headerNode={msg("registerTitle")}
             formNode={
                 <form id="kc-register-form" className={cx(props.kcFormClass)} action={url.registrationAction} method="post">
-                    <UserProfileFormFields kcContext={kcContext} onIsFormSubmittableValueChange={setIsFomSubmittable} i18n={i18n} {...props} />
+                    <UserProfileFormFields
+                        kcContext={kcContext}
+                        doInsertPasswordFields={true}
+                        onIsFormSubmittableValueChange={setIsFomSubmittable}
+                        i18n={i18n}
+                        {...props}
+                    />
                     {recaptchaRequired && (
                         <div className="form-group">
                             <div className={cx(props.kcInputWrapperClass)}>
@@ -66,155 +70,4 @@ const RegisterUserProfile = memo(({ kcContext, i18n, ...props_ }: { kcContext: K
     );
 });
 
-type UserProfileFormFieldsProps = { kcContext: KcContextBase.RegisterUserProfile; i18n: I18n } & KcProps &
-    Partial<Record<"BeforeField" | "AfterField", ReactComponent<{ attribute: Attribute }>>> & {
-        onIsFormSubmittableValueChange: (isFormSubmittable: boolean) => void;
-    };
-
-const UserProfileFormFields = memo(({ kcContext, onIsFormSubmittableValueChange, i18n, ...props }: UserProfileFormFieldsProps) => {
-    const { cx, css } = useCssAndCx();
-
-    const { advancedMsg } = i18n;
-
-    const {
-        formValidationState: { fieldStateByAttributeName, isFormSubmittable },
-        formValidationReducer,
-        attributesWithPassword
-    } = useFormValidationSlice({
-        kcContext,
-        i18n
-    });
-
-    useEffect(() => {
-        onIsFormSubmittableValueChange(isFormSubmittable);
-    }, [isFormSubmittable]);
-
-    const onChangeFactory = useCallbackFactory(
-        (
-            [name]: [string],
-            [
-                {
-                    target: { value }
-                }
-            ]: [React.ChangeEvent<HTMLInputElement | HTMLSelectElement>]
-        ) =>
-            formValidationReducer({
-                "action": "update value",
-                name,
-                "newValue": value
-            })
-    );
-
-    const onBlurFactory = useCallbackFactory(([name]: [string]) =>
-        formValidationReducer({
-            "action": "focus lost",
-            name
-        })
-    );
-
-    let currentGroup = "";
-
-    return (
-        <>
-            {attributesWithPassword.map((attribute, i) => {
-                const { group = "", groupDisplayHeader = "", groupDisplayDescription = "" } = attribute;
-
-                const { value, displayableErrors } = fieldStateByAttributeName[attribute.name];
-
-                const formGroupClassName = cx(props.kcFormGroupClass, displayableErrors.length !== 0 && props.kcFormGroupErrorClass);
-
-                return (
-                    <Fragment key={i}>
-                        {group !== currentGroup && (currentGroup = group) !== "" && (
-                            <div className={formGroupClassName}>
-                                <div className={cx(props.kcContentWrapperClass)}>
-                                    <label id={`header-${group}`} className={cx(props.kcFormGroupHeader)}>
-                                        {advancedMsg(groupDisplayHeader) || currentGroup}
-                                    </label>
-                                </div>
-                                {groupDisplayDescription !== "" && (
-                                    <div className={cx(props.kcLabelWrapperClass)}>
-                                        <label id={`description-${group}`} className={`${cx(props.kcLabelClass)}`}>
-                                            {advancedMsg(groupDisplayDescription)}
-                                        </label>
-                                    </div>
-                                )}
-                            </div>
-                        )}
-                        <div className={formGroupClassName}>
-                            <div className={cx(props.kcLabelWrapperClass)}>
-                                <label htmlFor={attribute.name} className={cx(props.kcLabelClass)}>
-                                    {advancedMsg(attribute.displayName ?? "")}
-                                </label>
-                                {attribute.required && <>*</>}
-                            </div>
-                            <div className={cx(props.kcInputWrapperClass)}>
-                                {(() => {
-                                    const { options } = attribute.validators;
-
-                                    if (options !== undefined) {
-                                        return (
-                                            <select
-                                                id={attribute.name}
-                                                name={attribute.name}
-                                                onChange={onChangeFactory(attribute.name)}
-                                                onBlur={onBlurFactory(attribute.name)}
-                                                value={value}
-                                            >
-                                                {options.options.map(option => (
-                                                    <option key={option} value={option}>
-                                                        {option}
-                                                    </option>
-                                                ))}
-                                            </select>
-                                        );
-                                    }
-
-                                    return (
-                                        <input
-                                            type={(() => {
-                                                switch (attribute.name) {
-                                                    case "password-confirm":
-                                                    case "password":
-                                                        return "password";
-                                                    default:
-                                                        return "text";
-                                                }
-                                            })()}
-                                            id={attribute.name}
-                                            name={attribute.name}
-                                            value={value}
-                                            onChange={onChangeFactory(attribute.name)}
-                                            className={cx(props.kcInputClass)}
-                                            aria-invalid={displayableErrors.length !== 0}
-                                            disabled={attribute.readOnly}
-                                            autoComplete={attribute.autocomplete}
-                                            onBlur={onBlurFactory(attribute.name)}
-                                        />
-                                    );
-                                })()}
-                                {displayableErrors.length !== 0 && (
-                                    <span
-                                        id={`input-error-${attribute.name}`}
-                                        className={cx(
-                                            props.kcInputErrorMessageClass,
-                                            css({
-                                                "position": displayableErrors.length === 1 ? "absolute" : undefined,
-                                                "& > span": { "display": "block" }
-                                            })
-                                        )}
-                                        aria-live="polite"
-                                    >
-                                        {displayableErrors.map(({ errorMessage }) => errorMessage)}
-                                    </span>
-                                )}
-                            </div>
-                        </div>
-                    </Fragment>
-                );
-            })}
-        </>
-    );
-});
-
 export default RegisterUserProfile;

package/src/lib/components/UpdateUserProfile.tsx

@@ -0,0 +1,77 @@
+import React, { useState, memo } from "react";
+import Template from "./Template";
+import type { KcProps } from "./KcProps";
+import type { KcContextBase } from "../getKcContext/KcContextBase";
+import { useCssAndCx } from "../tools/useCssAndCx";
+import type { I18n } from "../i18n";
+import { UserProfileFormFields } from "./shared/UserProfileCommons";
+
+const LoginUpdateProfile = memo(({ kcContext, i18n, ...props }: { kcContext: KcContextBase.UpdateUserProfile; i18n: I18n } & KcProps) => {
+    const { cx } = useCssAndCx();
+
+    const { msg, msgStr } = i18n;
+
+    const { url, isAppInitiatedAction } = kcContext;
+
+    const [isFomSubmittable, setIsFomSubmittable] = useState(false);
+
+    return (
+        <Template
+            {...{ kcContext, i18n, ...props }}
+            doFetchDefaultThemeResources={true}
+            headerNode={msg("loginProfileTitle")}
+            formNode={
+                <form id="kc-update-profile-form" className={cx(props.kcFormClass)} action={url.loginAction} method="post">
+                    <UserProfileFormFields
+                        kcContext={kcContext}
+                        doInsertPasswordFields={true}
+                        onIsFormSubmittableValueChange={setIsFomSubmittable}
+                        i18n={i18n}
+                        {...props}
+                    />
+
+                    <div className={cx(props.kcFormGroupClass)}>
+                        <div id="kc-form-options" className={cx(props.kcFormOptionsClass)}>
+                            <div className={cx(props.kcFormOptionsWrapperClass)}></div>
+                        </div>
+
+                        <div id="kc-form-buttons" className={cx(props.kcFormButtonsClass)}>
+                            {isAppInitiatedAction ? (
+                                <>
+                                    <input
+                                        className={cx(props.kcButtonClass, props.kcButtonPrimaryClass, props.kcButtonLargeClass)}
+                                        type="submit"
+                                        value={msgStr("doSubmit")}
+                                    />
+                                    <button
+                                        className={cx(props.kcButtonClass, props.kcButtonDefaultClass, props.kcButtonLargeClass)}
+                                        type="submit"
+                                        name="cancel-aia"
+                                        value="true"
+                                        formNoValidate
+                                    >
+                                        {msg("doCancel")}
+                                    </button>
+                                </>
+                            ) : (
+                                <input
+                                    className={cx(
+                                        props.kcButtonClass,
+                                        props.kcButtonPrimaryClass,
+                                        props.kcButtonBlockClass,
+                                        props.kcButtonLargeClass
+                                    )}
+                                    type="submit"
+                                    defaultValue={msgStr("doSubmit")}
+                                    disabled={!isFomSubmittable}
+                                />
+                            )}
+                        </div>
+                    </div>
+                </form>
+            }
+        />
+    );
+});
+
+export default LoginUpdateProfile;

package/src/lib/components/shared/UserProfileCommons.tsx

@@ -0,0 +1,172 @@
+import React, { memo, useEffect, Fragment } from "react";
+import type { KcProps } from "../KcProps";
+import type { Attribute } from "../../getKcContext/KcContextBase";
+import { useCssAndCx } from "../../tools/useCssAndCx";
+import type { ReactComponent } from "../../tools/ReactComponent";
+import { useCallbackFactory } from "powerhooks/useCallbackFactory";
+import { useFormValidationSlice } from "../../useFormValidationSlice";
+import type { I18n } from "../../i18n";
+import type { Param0 } from "tsafe/Param0";
+
+export type UserProfileFormFieldsProps = {
+    //kcContext: KcContextBase.RegisterUserProfile;
+    kcContext: Param0<typeof useFormValidationSlice>["kcContext"];
+    doInsertPasswordFields: boolean;
+    i18n: I18n;
+} & KcProps &
+    Partial<Record<"BeforeField" | "AfterField", ReactComponent<{ attribute: Attribute }>>> & {
+        onIsFormSubmittableValueChange: (isFormSubmittable: boolean) => void;
+    };
+
+export const UserProfileFormFields = memo(
+    ({ kcContext, doInsertPasswordFields, onIsFormSubmittableValueChange, i18n, BeforeField, AfterField, ...props }: UserProfileFormFieldsProps) => {
+        const { cx, css } = useCssAndCx();
+
+        const { advancedMsg } = i18n;
+
+        const {
+            formValidationState: { fieldStateByAttributeName, isFormSubmittable },
+            formValidationReducer,
+            attributesWithPassword
+        } = useFormValidationSlice({
+            kcContext,
+            i18n
+        });
+
+        useEffect(() => {
+            onIsFormSubmittableValueChange(isFormSubmittable);
+        }, [isFormSubmittable]);
+
+        const onChangeFactory = useCallbackFactory(
+            (
+                [name]: [string],
+                [
+                    {
+                        target: { value }
+                    }
+                ]: [React.ChangeEvent<HTMLInputElement | HTMLSelectElement>]
+            ) =>
+                formValidationReducer({
+                    "action": "update value",
+                    name,
+                    "newValue": value
+                })
+        );
+
+        const onBlurFactory = useCallbackFactory(([name]: [string]) =>
+            formValidationReducer({
+                "action": "focus lost",
+                name
+            })
+        );
+
+        let currentGroup = "";
+
+        return (
+            <>
+                {(doInsertPasswordFields ? attributesWithPassword : kcContext.profile.attributes).map((attribute, i) => {
+                    const { group = "", groupDisplayHeader = "", groupDisplayDescription = "" } = attribute;
+
+                    const { value, displayableErrors } = fieldStateByAttributeName[attribute.name];
+
+                    const formGroupClassName = cx(props.kcFormGroupClass, displayableErrors.length !== 0 && props.kcFormGroupErrorClass);
+
+                    return (
+                        <Fragment key={i}>
+                            {group !== currentGroup && (currentGroup = group) !== "" && (
+                                <div className={formGroupClassName}>
+                                    <div className={cx(props.kcContentWrapperClass)}>
+                                        <label id={`header-${group}`} className={cx(props.kcFormGroupHeader)}>
+                                            {advancedMsg(groupDisplayHeader) || currentGroup}
+                                        </label>
+                                    </div>
+                                    {groupDisplayDescription !== "" && (
+                                        <div className={cx(props.kcLabelWrapperClass)}>
+                                            <label id={`description-${group}`} className={`${cx(props.kcLabelClass)}`}>
+                                                {advancedMsg(groupDisplayDescription)}
+                                            </label>
+                                        </div>
+                                    )}
+                                </div>
+                            )}
+
+                            {BeforeField && <BeforeField attribute={attribute} />}
+
+                            <div className={formGroupClassName}>
+                                <div className={cx(props.kcLabelWrapperClass)}>
+                                    <label htmlFor={attribute.name} className={cx(props.kcLabelClass)}>
+                                        {advancedMsg(attribute.displayName ?? "")}
+                                    </label>
+                                    {attribute.required && <>*</>}
+                                </div>
+                                <div className={cx(props.kcInputWrapperClass)}>
+                                    {(() => {
+                                        const { options } = attribute.validators;
+
+                                        if (options !== undefined) {
+                                            return (
+                                                <select
+                                                    id={attribute.name}
+                                                    name={attribute.name}
+                                                    onChange={onChangeFactory(attribute.name)}
+                                                    onBlur={onBlurFactory(attribute.name)}
+                                                    value={value}
+                                                >
+                                                    {options.options.map(option => (
+                                                        <option key={option} value={option}>
+                                                            {option}
+                                                        </option>
+                                                    ))}
+                                                </select>
+                                            );
+                                        }
+
+                                        return (
+                                            <input
+                                                type={(() => {
+                                                    switch (attribute.name) {
+                                                        case "password-confirm":
+                                                        case "password":
+                                                            return "password";
+                                                        default:
+                                                            return "text";
+                                                    }
+                                                })()}
+                                                id={attribute.name}
+                                                name={attribute.name}
+                                                value={value}
+                                                onChange={onChangeFactory(attribute.name)}
+                                                className={cx(props.kcInputClass)}
+                                                aria-invalid={displayableErrors.length !== 0}
+                                                disabled={attribute.readOnly}
+                                                autoComplete={attribute.autocomplete}
+                                                onBlur={onBlurFactory(attribute.name)}
+                                            />
+                                        );
+                                    })()}
+                                    {displayableErrors.length !== 0 && (
+                                        <span
+                                            id={`input-error-${attribute.name}`}
+                                            className={cx(
+                                                props.kcInputErrorMessageClass,
+                                                css({
+                                                    "position": displayableErrors.length === 1 ? "absolute" : undefined,
+                                                    "& > span": { "display": "block" }
+                                                })
+                                            )}
+                                            aria-live="polite"
+                                        >
+                                            {displayableErrors.map(({ errorMessage }) => errorMessage)}
+                                        </span>
+                                    )}
+                                </div>
+                            </div>
+
+                            {AfterField && <AfterField attribute={attribute} />}
+                        </Fragment>
+                    );
+                })}
+            </>
+        );
+    }
+);

package/src/lib/getKcContext/KcContextBase.ts

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