keycloakify 9.6.6 → 10.0.0-rc.0

package/src/login/pages/Code.tsx

@@ -0,0 +1,35 @@
+import type { PageProps } from "keycloakify/login/pages/PageProps";
+import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
+import type { KcContext } from "../kcContext";
+import type { I18n } from "../i18n";
+
+export default function Code(props: PageProps<Extract<KcContext, { pageId: "code.ftl" }>, I18n>) {
+    const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
+
+    const { getClassName } = useGetClassName({
+        doUseDefaultCss,
+        classes
+    });
+
+    const { code } = kcContext;
+
+    const { msg } = i18n;
+
+    return (
+        <Template
+            {...{ kcContext, i18n, doUseDefaultCss, classes }}
+            headerNode={code.success ? msg("codeSuccessTitle") : msg("codeErrorTitle", code.error)}
+        >
+            <div id="kc-code">
+                {code.success ? (
+                    <>
+                        <p>{msg("copyCodeInstruction")}</p>
+                        <input id="code" className={getClassName("kcTextareaClass")} value={code.code} />
+                    </>
+                ) : (
+                    <p id="error">{code.error}</p>
+                )}
+            </div>
+        </Template>
+    );
+}

package/src/login/pages/DeleteAccountConfirm.tsx

@@ -0,0 +1,53 @@
+import { clsx } from "keycloakify/tools/clsx";
+import type { PageProps } from "keycloakify/login/pages/PageProps";
+import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
+import type { KcContext } from "../kcContext";
+import type { I18n } from "../i18n";
+
+export default function DeleteAccountConfirm(props: PageProps<Extract<KcContext, { pageId: "delete-account-confirm.ftl" }>, I18n>) {
+    const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
+
+    const { getClassName } = useGetClassName({
+        doUseDefaultCss,
+        classes
+    });
+
+    const { url, triggered_from_aia } = kcContext;
+
+    const { msg, msgStr } = i18n;
+
+    return (
+        <Template {...{ kcContext, i18n, doUseDefaultCss, classes }} headerNode={msg("deleteAccountConfirm")}>
+            <form action={url.loginAction} className="form-vertical" method="post">
+                <div className="alert alert-warning" style={{ "marginTop": "0", "marginBottom": "30px" }}>
+                    <span className="pficon pficon-warning-triangle-o"></span>
+                    {msg("irreversibleAction")}
+                </div>
+                <p>{msg("deletingImplies")}</p>
+                <ul style={{ "color": "#72767b", "listStyle": "disc", "listStylePosition": "inside" }}>
+                    <li>{msg("loggingOutImmediately")}</li>
+                    <li>{msg("errasingData")}</li>
+                </ul>
+                <p className="delete-account-text">{msg("finalDeletionConfirmation")}</p>
+                <div id="kc-form-buttons">
+                    <input
+                        className={clsx(getClassName("kcButtonClass"), getClassName("kcButtonPrimaryClass"), getClassName("kcButtonLargeClass"))}
+                        type="submit"
+                        value={msgStr("doConfirmDelete")}
+                    />
+                    {triggered_from_aia && (
+                        <button
+                            className={clsx(getClassName("kcButtonClass"), getClassName("kcButtonDefaultClass"), getClassName("kcButtonLargeClass"))}
+                            style={{ "marginLeft": "calc(100% - 220px)" }}
+                            type="submit"
+                            name="cancel-aia"
+                            value="true"
+                        >
+                            {msgStr("doCancel")}
+                        </button>
+                    )}
+                </div>
+            </form>
+        </Template>
+    );
+}

package/src/login/pages/DeleteCredential.tsx

@@ -0,0 +1,45 @@
+import { clsx } from "keycloakify/tools/clsx";
+import type { PageProps } from "keycloakify/login/pages/PageProps";
+import type { KcContext } from "../kcContext";
+import type { I18n } from "../i18n";
+import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
+
+export default function DeleteCredential(props: PageProps<Extract<KcContext, { pageId: "delete-credential.ftl" }>, I18n>) {
+    const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
+
+    const { msgStr, msg } = i18n;
+
+    const { getClassName } = useGetClassName({
+        doUseDefaultCss,
+        classes
+    });
+
+    const { url, credentialLabel } = kcContext;
+
+    return (
+        <Template
+            {...{ kcContext, i18n, doUseDefaultCss, classes }}
+            displayMessage={false}
+            headerNode={msg("deleteCredentialTitle", credentialLabel)}
+        >
+            <div id="kc-delete-text">{msg("deleteCredentialMessage", credentialLabel)}</div>
+            <form className="form-actions" action={url.loginAction} method="POST">
+                <input
+                    className={clsx(getClassName("kcButtonClass"), getClassName("kcButtonPrimaryClass"), getClassName("kcButtonLargeClass"))}
+                    name="accept"
+                    id="kc-accept"
+                    type="submit"
+                    value={msgStr("doConfirmDelete")}
+                />
+                <input
+                    className={clsx(getClassName("kcButtonClass"), getClassName("kcButtonDefaultClass"), getClassName("kcButtonLargeClass"))}
+                    name="cancel-aia"
+                    value={msgStr("doCancel")}
+                    id="kc-decline"
+                    type="submit"
+                />
+            </form>
+            <div className="clearfix" />
+        </Template>
+    );
+}

package/src/login/pages/Error.tsx

@@ -5,7 +5,7 @@ import type { I18n } from "../i18n";
 export default function Error(props: PageProps<Extract<KcContext, { pageId: "error.ftl" }>, I18n>) {
     const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
 
-    const { message, client } = kcContext;
+    const { message, client, skipLink } = kcContext;
 
     const { msg } = i18n;
 
@@ -13,7 +13,7 @@ export default function Error(props: PageProps<Extract<KcContext, { pageId: "err
         <Template {...{ kcContext, i18n, doUseDefaultCss, classes }} displayMessage={false} headerNode={msg("errorTitle")}>
             <div id="kc-error-message">
                 <p className="instruction">{message.summary}</p>
-                {client !== undefined && client.baseUrl !== undefined && (
+                {!skipLink && client !== undefined && client.baseUrl !== undefined && (
                     <p>
                         <a id="backToApplication" href={client.baseUrl}>
                             {msg("backToApplication")}

package/src/login/pages/FrontchannelLogout.tsx

@@ -0,0 +1,41 @@
+import { useEffect } from "react";
+import type { PageProps } from "keycloakify/login/pages/PageProps";
+import type { KcContext } from "../kcContext";
+import type { I18n } from "../i18n";
+
+export default function FrontchannelLogout(props: PageProps<Extract<KcContext, { pageId: "frontchannel-logout.ftl" }>, I18n>) {
+    const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
+
+    const { logout } = kcContext;
+
+    const { msg, msgStr } = i18n;
+
+    useEffect(() => {
+        if (logout.logoutRedirectUri) {
+            window.location.replace(logout.logoutRedirectUri);
+        }
+    }, []);
+
+    return (
+        <Template
+            {...{ kcContext, i18n, doUseDefaultCss, classes }}
+            documentTitle={msgStr("frontchannel-logout.title")}
+            headerNode={msg("frontchannel-logout.title")}
+        >
+            <p>{msg("frontchannel-logout.message")}</p>
+            <ul>
+                {logout.clients.map(client => (
+                    <li key={client.name}>
+                        {client.name}
+                        <iframe src={client.frontChannelLogoutUrl} style={{ "display": "none" }} />
+                    </li>
+                ))}
+            </ul>
+            {logout.logoutRedirectUri && (
+                <a id="continue" className="btn btn-primary" href={logout.logoutRedirectUri}>
+                    {msg("doContinue")}
+                </a>
+            )}
+        </Template>
+    );
+}

package/src/login/pages/IdpReviewUserProfile.tsx

@@ -1,13 +1,18 @@
 import { useState } from "react";
 import { clsx } from "keycloakify/tools/clsx";
-import { UserProfileFormFields } from "keycloakify/login/pages/shared/UserProfileFormFields";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
 import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
+import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
+import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFields";
 import type { KcContext } from "../kcContext";
 import type { I18n } from "../i18n";
 
-export default function IdpReviewUserProfile(props: PageProps<Extract<KcContext, { pageId: "idp-review-user-profile.ftl" }>, I18n>) {
-    const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
+type IdpReviewUserProfileProps = PageProps<Extract<KcContext, { pageId: "idp-review-user-profile.ftl" }>, I18n> & {
+    UserProfileFormFields: LazyOrNot<(props: UserProfileFormFieldsProps) => JSX.Element>;
+};
+
+export default function IdpReviewUserProfile(props: IdpReviewUserProfileProps) {
+    const { kcContext, i18n, doUseDefaultCss, Template, classes, UserProfileFormFields } = props;
 
     const { getClassName } = useGetClassName({
         doUseDefaultCss,
@@ -16,12 +21,17 @@ export default function IdpReviewUserProfile(props: PageProps<Extract<KcContext,
 
     const { msg, msgStr } = i18n;
 
-    const { url } = kcContext;
+    const { url, messagesPerField } = kcContext;
 
     const [isFomSubmittable, setIsFomSubmittable] = useState(false);
 
     return (
-        <Template {...{ kcContext, i18n, doUseDefaultCss, classes }} headerNode={msg("loginIdpReviewProfileTitle")}>
+        <Template
+            {...{ kcContext, i18n, doUseDefaultCss, classes }}
+            displayMessage={messagesPerField.exists("global")}
+            displayRequiredFields={true}
+            headerNode={msg("loginIdpReviewProfileTitle")}
+        >
             <form id="kc-idp-review-profile-form" className={getClassName("kcFormClass")} action={url.loginAction} method="post">
                 <UserProfileFormFields
                     kcContext={kcContext}

package/src/login/pages/Info.tsx

@@ -24,26 +24,36 @@ export default function Info(props: PageProps<Extract<KcContext, { pageId: "info
             <div id="kc-info-message">
                 <p className="instruction">
                     {message.summary}
-
-                    {requiredActions !== undefined && (
-                        <b>{requiredActions.map(requiredAction => msgStr(`requiredAction.${requiredAction}` as const)).join(",")}</b>
-                    )}
+                    {requiredActions && <b>{requiredActions.map(requiredAction => msgStr(`requiredAction.${requiredAction}` as const)).join(",")}</b>}
                 </p>
-                {!skipLink && pageRedirectUri !== undefined ? (
-                    <p>
-                        <a href={pageRedirectUri}>{msg("backToApplication")}</a>
-                    </p>
-                ) : actionUri !== undefined ? (
-                    <p>
-                        <a href={actionUri}>{msg("proceedWithAction")}</a>
-                    </p>
-                ) : (
-                    client.baseUrl !== undefined && (
-                        <p>
-                            <a href={client.baseUrl}>{msg("backToApplication")}</a>
-                        </p>
-                    )
-                )}
+                {(() => {
+                    if (skipLink) {
+                        return null;
+                    }
+
+                    if (pageRedirectUri) {
+                        return (
+                            <p>
+                                <a href={pageRedirectUri}>{msg("backToApplication")}</a>
+                            </p>
+                        );
+                    }
+                    if (actionUri) {
+                        return (
+                            <p>
+                                <a href={actionUri}>{msg("proceedWithAction")}</a>
+                            </p>
+                        );
+                    }
+
+                    if (client.baseUrl) {
+                        return (
+                            <p>
+                                <a href={client.baseUrl}>{msg("backToApplication")}</a>
+                            </p>
+                        );
+                    }
+                })()}
             </div>
         </Template>
     );

package/src/login/pages/Login.tsx

@@ -1,6 +1,6 @@
-import { useState, type FormEventHandler } from "react";
+import { useState, useEffect, useReducer } from "react";
+import { assert } from "tsafe/assert";
 import { clsx } from "keycloakify/tools/clsx";
-import { useConstCallback } from "keycloakify/tools/useConstCallback";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
 import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
 import type { KcContext } from "../kcContext";
@@ -14,115 +14,144 @@ export default function Login(props: PageProps<Extract<KcContext, { pageId: "log
         classes
     });
 
-    const { social, realm, url, usernameHidden, login, auth, registrationDisabled } = kcContext;
+    const { social, realm, url, usernameHidden, login, auth, registrationDisabled, messagesPerField } = kcContext;
 
     const { msg, msgStr } = i18n;
 
     const [isLoginButtonDisabled, setIsLoginButtonDisabled] = useState(false);
 
-    const onSubmit = useConstCallback<FormEventHandler<HTMLFormElement>>(e => {
-        e.preventDefault();
-
-        setIsLoginButtonDisabled(true);
-
-        const formElement = e.target as HTMLFormElement;
-
-        //NOTE: Even if we login with email Keycloak expect username and password in
-        //the POST request.
-        formElement.querySelector("input[name='email']")?.setAttribute("name", "username");
-
-        formElement.submit();
-    });
-
     return (
         <Template
             {...{ kcContext, i18n, doUseDefaultCss, classes }}
+            displayMessage={!messagesPerField.existsError("username", "password")}
+            headerNode={msg("loginAccountTitle")}
             displayInfo={realm.password && realm.registrationAllowed && !registrationDisabled}
-            displayWide={realm.password && social.providers !== undefined}
-            headerNode={msg("doLogIn")}
             infoNode={
-                <div id="kc-registration">
-                    <span>
-                        {msg("noAccount")}
-                        <a tabIndex={6} href={url.registrationUrl}>
-                            {msg("doRegister")}
-                        </a>
-                    </span>
+                <div id="kc-registration-container">
+                    <div id="kc-registration">
+                        <span>
+                            {msg("noAccount")}{" "}
+                            <a tabIndex={8} href={url.registrationUrl}>
+                                {msg("doRegister")}
+                            </a>
+                        </span>
+                    </div>
                 </div>
             }
-        >
-            <div id="kc-form" className={clsx(realm.password && social.providers !== undefined && getClassName("kcContentWrapperClass"))}>
-                <div
-                    id="kc-form-wrapper"
-                    className={clsx(
-                        realm.password &&
-                            social.providers && [getClassName("kcFormSocialAccountContentClass"), getClassName("kcFormSocialAccountClass")]
+            socialProvidersNode={
+                <>
+                    {realm.password && social.providers?.length && (
+                        <div id="kc-social-providers" className={getClassName("kcFormSocialAccountSectionClass")}>
+                            <hr />
+                            <h2>{msg("identity-provider-login-label")}</h2>
+                            <ul
+                                className={clsx(
+                                    getClassName("kcFormSocialAccountListClass"),
+                                    social.providers.length > 3 && getClassName("kcFormSocialAccountListGridClass")
+                                )}
+                            >
+                                {social.providers.map((...[p, , providers]) => (
+                                    <li key={p.alias}>
+                                        <a
+                                            id={`social-${p.alias}`}
+                                            className={clsx(
+                                                getClassName("kcFormSocialAccountListButtonClass"),
+                                                providers.length > 3 && getClassName("kcFormSocialAccountGridItem")
+                                            )}
+                                            type="button"
+                                            href={p.loginUrl}
+                                        >
+                                            {p.iconClasses && (
+                                                <i className={clsx(getClassName("kcCommonLogoIdP"), p.iconClasses)} aria-hidden="true"></i>
+                                            )}
+                                            <span
+                                                className={clsx(getClassName("kcFormSocialAccountNameClass"), p.iconClasses && "kc-social-icon-text")}
+                                            >
+                                                {p.displayName}
+                                            </span>
+                                        </a>
+                                    </li>
+                                ))}
+                            </ul>
+                        </div>
                     )}
-                >
+                </>
+            }
+        >
+            <div id="kc-form">
+                <div id="kc-form-wrapper">
                     {realm.password && (
-                        <form id="kc-form-login" onSubmit={onSubmit} action={url.loginAction} method="post">
-                            <div className={getClassName("kcFormGroupClass")}>
-                                {!usernameHidden &&
-                                    (() => {
-                                        const label = !realm.loginWithEmailAllowed
-                                            ? "username"
-                                            : realm.registrationEmailAsUsername
-                                            ? "email"
-                                            : "usernameOrEmail";
-
-                                        const autoCompleteHelper: typeof label = label === "usernameOrEmail" ? "username" : label;
-
-                                        return (
-                                            <>
-                                                <label htmlFor={autoCompleteHelper} className={getClassName("kcLabelClass")}>
-                                                    {msg(label)}
-                                                </label>
-                                                <input
-                                                    tabIndex={1}
-                                                    id={autoCompleteHelper}
-                                                    className={getClassName("kcInputClass")}
-                                                    //NOTE: This is used by Google Chrome auto fill so we use it to tell
-                                                    //the browser how to pre fill the form but before submit we put it back
-                                                    //to username because it is what keycloak expects.
-                                                    name={autoCompleteHelper}
-                                                    defaultValue={login.username ?? ""}
-                                                    type="text"
-                                                    autoFocus={true}
-                                                    autoComplete="off"
-                                                />
-                                            </>
-                                        );
-                                    })()}
-                            </div>
+                        <form
+                            id="kc-form-login"
+                            onSubmit={() => {
+                                setIsLoginButtonDisabled(true);
+                                return true;
+                            }}
+                            action={url.loginAction}
+                            method="post"
+                        >
+                            {!usernameHidden && (
+                                <div className={getClassName("kcFormGroupClass")}>
+                                    <label htmlFor="username" className={getClassName("kcLabelClass")}>
+                                        {!realm.loginWithEmailAllowed
+                                            ? msg("username")
+                                            : !realm.registrationEmailAsUsername
+                                            ? msg("usernameOrEmail")
+                                            : msg("email")}
+                                    </label>
+                                    <input
+                                        tabIndex={2}
+                                        id="username"
+                                        className={getClassName("kcInputClass")}
+                                        name="username"
+                                        value={login.username ?? ""}
+                                        type="text"
+                                        autoFocus
+                                        autoComplete="username"
+                                        aria-invalid={messagesPerField.existsError("username", "password")}
+                                    />
+                                    {messagesPerField.existsError("username", "password") && (
+                                        <span id="input-error" className={getClassName("kcInputErrorMessageClass")} aria-live="polite">
+                                            {messagesPerField.getFirstError("username", "password")}
+                                        </span>
+                                    )}
+                                </div>
+                            )}
+
                             <div className={getClassName("kcFormGroupClass")}>
                                 <label htmlFor="password" className={getClassName("kcLabelClass")}>
                                     {msg("password")}
                                 </label>
-                                <input
-                                    tabIndex={2}
-                                    id="password"
-                                    className={getClassName("kcInputClass")}
-                                    name="password"
-                                    type="password"
-                                    autoComplete="off"
-                                />
+                                <PasswordWrapper getClassName={getClassName} i18n={i18n} passwordInputId="password">
+                                    <input
+                                        tabIndex={3}
+                                        id="password"
+                                        className={getClassName("kcInputClass")}
+                                        name="password"
+                                        type="password"
+                                        autoComplete="current-password"
+                                        aria-invalid={messagesPerField.existsError("username", "password")}
+                                    />
+                                </PasswordWrapper>
+                                {usernameHidden && messagesPerField.existsError("username", "password") && (
+                                    <span id="input-error" className={getClassName("kcInputErrorMessageClass")} aria-live="polite">
+                                        {messagesPerField.getFirstError("username", "password")}
+                                    </span>
+                                )}
                             </div>
+
                             <div className={clsx(getClassName("kcFormGroupClass"), getClassName("kcFormSettingClass"))}>
                                 <div id="kc-form-options">
                                     {realm.rememberMe && !usernameHidden && (
                                         <div className="checkbox">
                                             <label>
                                                 <input
-                                                    tabIndex={3}
+                                                    tabIndex={5}
                                                     id="rememberMe"
                                                     name="rememberMe"
                                                     type="checkbox"
-                                                    {...(login.rememberMe === "on"
-                                                        ? {
-                                                              "checked": true
-                                                          }
-                                                        : {})}
-                                                />
+                                                    defaultChecked={!!login.rememberMe}
+                                                />{" "}
                                                 {msg("rememberMe")}
                                             </label>
                                         </div>
@@ -131,26 +160,19 @@ export default function Login(props: PageProps<Extract<KcContext, { pageId: "log
                                 <div className={getClassName("kcFormOptionsWrapperClass")}>
                                     {realm.resetPasswordAllowed && (
                                         <span>
-                                            <a tabIndex={5} href={url.loginResetCredentialsUrl}>
+                                            <a tabIndex={6} href={url.loginResetCredentialsUrl}>
                                                 {msg("doForgotPassword")}
                                             </a>
                                         </span>
                                     )}
                                 </div>
                             </div>
+
                             <div id="kc-form-buttons" className={getClassName("kcFormGroupClass")}>
+                                <input type="hidden" id="id-hidden-input" name="credentialId" value={auth.selectedCredential} />
                                 <input
-                                    type="hidden"
-                                    id="id-hidden-input"
-                                    name="credentialId"
-                                    {...(auth?.selectedCredential !== undefined
-                                        ? {
-                                              "value": auth.selectedCredential
-                                          }
-                                        : {})}
-                                />
-                                <input
-                                    tabIndex={4}
+                                    tabIndex={7}
+                                    disabled={isLoginButtonDisabled}
                                     className={clsx(
                                         getClassName("kcButtonClass"),
                                         getClassName("kcButtonPrimaryClass"),
@@ -161,34 +183,51 @@ export default function Login(props: PageProps<Extract<KcContext, { pageId: "log
                                     id="kc-login"
                                     type="submit"
                                     value={msgStr("doLogIn")}
-                                    disabled={isLoginButtonDisabled}
                                 />
                             </div>
                         </form>
                     )}
                 </div>
-                {realm.password && social.providers !== undefined && (
-                    <div
-                        id="kc-social-providers"
-                        className={clsx(getClassName("kcFormSocialAccountContentClass"), getClassName("kcFormSocialAccountClass"))}
-                    >
-                        <ul
-                            className={clsx(
-                                getClassName("kcFormSocialAccountListClass"),
-                                social.providers.length > 4 && getClassName("kcFormSocialAccountDoubleListClass")
-                            )}
-                        >
-                            {social.providers.map(p => (
-                                <li key={p.providerId} className={getClassName("kcFormSocialAccountListLinkClass")}>
-                                    <a href={p.loginUrl} id={`zocial-${p.alias}`} className={clsx("zocial", p.providerId)}>
-                                        <span>{p.displayName}</span>
-                                    </a>
-                                </li>
-                            ))}
-                        </ul>
-                    </div>
-                )}
             </div>
         </Template>
     );
 }
+
+function PasswordWrapper(props: {
+    getClassName: ReturnType<typeof useGetClassName>["getClassName"];
+    i18n: I18n;
+    passwordInputId: string;
+    children: JSX.Element;
+}) {
+    const { getClassName, i18n, passwordInputId, children } = props;
+
+    const { msgStr } = i18n;
+
+    const [isPasswordRevealed, toggleIsPasswordRevealed] = useReducer((isPasswordRevealed: boolean) => !isPasswordRevealed, false);
+
+    useEffect(() => {
+        const passwordInputElement = document.getElementById(passwordInputId);
+
+        assert(passwordInputElement instanceof HTMLInputElement);
+
+        passwordInputElement.type = isPasswordRevealed ? "text" : "password";
+    }, [isPasswordRevealed]);
+
+    return (
+        <div className={getClassName("kcInputGroup")}>
+            {children}
+            <button
+                type="button"
+                className={getClassName("kcFormPasswordVisibilityButtonClass")}
+                aria-label={msgStr(isPasswordRevealed ? "hidePassword" : "showPassword")}
+                aria-controls={passwordInputId}
+                onClick={toggleIsPasswordRevealed}
+            >
+                <i
+                    className={getClassName(isPasswordRevealed ? "kcFormPasswordVisibilityIconHide" : "kcFormPasswordVisibilityIconShow")}
+                    aria-hidden
+                />
+            </button>
+        </div>
+    );
+}