keycloakify 10.0.0-rc.97 → 10.0.0

package/src/bin/tools/npmInstall.ts

@@ -0,0 +1,63 @@
+import * as fs from "fs";
+import { join as pathJoin } from "path";
+import * as child_process from "child_process";
+import chalk from "chalk";
+
+export function npmInstall(params: { packageJsonDirPath: string }) {
+    const { packageJsonDirPath } = params;
+
+    const packageManagerBinName = (() => {
+        const packageMangers = [
+            {
+                binName: "yarn",
+                lockFileBasename: "yarn.lock"
+            },
+            {
+                binName: "npm",
+                lockFileBasename: "package-lock.json"
+            },
+            {
+                binName: "pnpm",
+                lockFileBasename: "pnpm-lock.yaml"
+            },
+            {
+                binName: "bun",
+                lockFileBasename: "bun.lockdb"
+            }
+        ] as const;
+
+        for (const packageManager of packageMangers) {
+            if (
+                fs.existsSync(
+                    pathJoin(packageJsonDirPath, packageManager.lockFileBasename)
+                ) ||
+                fs.existsSync(pathJoin(process.cwd(), packageManager.lockFileBasename))
+            ) {
+                return packageManager.binName;
+            }
+        }
+
+        return undefined;
+    })();
+
+    install_dependencies: {
+        if (packageManagerBinName === undefined) {
+            break install_dependencies;
+        }
+
+        console.log(`Installing the new dependencies...`);
+
+        try {
+            child_process.execSync(`${packageManagerBinName} install`, {
+                cwd: packageJsonDirPath,
+                stdio: "inherit"
+            });
+        } catch {
+            console.log(
+                chalk.yellow(
+                    `\`${packageManagerBinName} install\` failed, continuing anyway...`
+                )
+            );
+        }
+    }
+}

package/src/bin/tools/octokit-addons/getLatestsSemVersionedTag.ts

@@ -9,13 +9,14 @@ export function getLatestsSemVersionedTagFactory(params: { octokit: Octokit }) {
         owner: string;
         repo: string;
         count: number;
+        doIgnoreReleaseCandidates: boolean;
     }): Promise<
         {
             tag: string;
             version: SemVer;
         }[]
     > {
-        const { owner, repo, count } = params;
+        const { owner, repo, count, doIgnoreReleaseCandidates } = params;
 
         const semVersionedTags: { tag: string; version: SemVer }[] = [];
 
@@ -30,7 +31,7 @@ export function getLatestsSemVersionedTagFactory(params: { octokit: Octokit }) {
                 continue;
             }
 
-            if (version.rc !== undefined) {
+            if (doIgnoreReleaseCandidates && version.rc !== undefined) {
                 continue;
             }
 

package/src/bin/tsconfig.json

@@ -8,5 +8,7 @@
         "moduleResolution": "node",
         "outDir": "../../dist/bin",
         "rootDir": "."
-    }
+    },
+    "include": ["**/*.ts", "**/*.tsx"],
+    "exclude": ["initialize-account-theme/src"]
 }

package/src/lib/getKcClsx.ts

@@ -73,8 +73,8 @@ export function createGetKcClsx<ClassKey extends string>(params: {
 
                     return clsx(
                         classKey,
-                        doUseDefaultCss ? defaultClasses[classKey] : undefined,
-                        classes?.[classKey]
+                        classes?.[classKey] ??
+                            (doUseDefaultCss ? defaultClasses[classKey] : undefined)
                     );
                 }
             });

package/src/login/KcContext/KcContext.ts

@@ -1,9 +1,8 @@
 import type { ThemeType, LoginThemePageId } from "keycloakify/bin/shared/constants";
-import type { ExtractAfterStartingWith } from "keycloakify/tools/ExtractAfterStartingWith";
 import type { ValueOf } from "keycloakify/tools/ValueOf";
 import { assert } from "tsafe/assert";
 import type { Equals } from "tsafe";
-import type { MessageKey } from "../i18n/i18n";
+import type { ClassKey } from "keycloakify/login/TemplateProps";
 
 export type ExtendKcContext<
     KcContextExtension extends { properties?: Record<string, string | undefined> },
@@ -80,8 +79,8 @@ export declare namespace KcContext {
         };
         realm: {
             name: string;
-            displayName?: string;
-            displayNameHtml?: string;
+            displayName: string;
+            displayNameHtml: string;
             internationalizationEnabled: boolean;
             registrationEmailAsUsername: boolean;
         };
@@ -155,8 +154,7 @@ export declare namespace KcContext {
         };
         properties: {};
         "x-keycloakify": {
-            realmMessageBundleUserProfile: Record<string, string> | undefined;
-            realmMessageBundleTermsText: string | undefined;
+            messages: Record<string, string>;
         };
     };
 
@@ -221,7 +219,7 @@ export declare namespace KcContext {
     export type Info = Common & {
         pageId: "info.ftl";
         messageHeader?: string;
-        requiredActions?: ExtractAfterStartingWith<"requiredAction.", MessageKey>[];
+        requiredActions?: string[];
         skipLink: boolean;
         pageRedirectUri?: string;
         actionUri?: string;
@@ -384,7 +382,7 @@ export declare namespace KcContext {
             credentialId: string;
             transports: {
                 iconClass: string;
-                displayNameProperties?: MessageKey[];
+                displayNameProperties?: string[];
             };
             label: string;
             createdAt: string;
@@ -501,26 +499,9 @@ export declare namespace KcContext {
     export namespace SelectAuthenticator {
         export type AuthenticationSelection = {
             authExecId: string;
-            displayName:
-                | "otp-display-name"
-                | "password-display-name"
-                | "auth-username-form-display-name"
-                | "auth-username-password-form-display-name"
-                | "webauthn-display-name"
-                | "webauthn-passwordless-display-name";
-            helpText:
-                | "otp-help-text"
-                | "password-help-text"
-                | "auth-username-form-help-text"
-                | "auth-username-password-form-help-text"
-                | "webauthn-help-text"
-                | "webauthn-passwordless-help-text";
-            iconCssClass?:
-                | "kcAuthenticatorDefaultClass"
-                | "kcAuthenticatorPasswordClass"
-                | "kcAuthenticatorOTPClass"
-                | "kcAuthenticatorWebAuthnClass"
-                | "kcAuthenticatorWebAuthnPasswordlessClass";
+            displayName: string;
+            helpText: string;
+            iconCssClass?: ClassKey;
         };
     }
 
@@ -610,6 +591,7 @@ export type Attribute = {
     value?: string;
     values?: string[];
     group?: {
+        annotations: Record<string, string>;
         html5DataAnnotations: Record<string, string>;
         displayHeader?: string;
         name: string;

package/src/login/KcContext/kcContextMocks.ts

@@ -1,8 +1,8 @@
 import "keycloakify/tools/Object.fromEntries";
 import type { KcContext, Attribute } from "./KcContext";
 import {
-    resources_common,
-    keycloak_resources,
+    RESOURCES_COMMON,
+    KEYCLOAK_RESOURCES,
     type LoginThemePageId
 } from "keycloakify/bin/shared/constants";
 import { id } from "tsafe/id";
@@ -76,7 +76,7 @@ const attributesByName = Object.fromEntries(
     ]).map(attribute => [attribute.name, attribute])
 );
 
-const resourcesPath = `${BASE_URL}${keycloak_resources}/login/resources`;
+const resourcesPath = `${BASE_URL}${KEYCLOAK_RESOURCES}/login/resources`;
 
 export const kcContextCommonMock: KcContext.Common = {
     themeVersion: "0.0.0",
@@ -86,7 +86,7 @@ export const kcContextCommonMock: KcContext.Common = {
     url: {
         loginAction: "#",
         resourcesPath,
-        resourcesCommonPath: `${resourcesPath}/${resources_common}`,
+        resourcesCommonPath: `${resourcesPath}/${RESOURCES_COMMON}`,
         loginRestartFlowUrl: "#",
         loginUrl: "#",
         ssoLoginInOtherTabsUrl: "#"
@@ -162,8 +162,7 @@ export const kcContextCommonMock: KcContext.Common = {
     isAppInitiatedAction: false,
     properties: {},
     "x-keycloakify": {
-        realmMessageBundleUserProfile: undefined,
-        realmMessageBundleTermsText: undefined
+        messages: {}
     }
 };
 

package/src/login/Template.tsx

@@ -15,7 +15,6 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
         displayMessage = true,
         displayRequiredFields = false,
         headerNode,
-        showUsernameNode = null,
         socialProvidersNode = null,
         infoNode = null,
         documentTitle,
@@ -164,45 +163,10 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
                             </div>
                         </div>
                     )}
-                    {!(auth !== undefined && auth.showUsername && !auth.showResetCredentials) ? (
-                        displayRequiredFields ? (
-                            <div className={kcClsx("kcContentWrapperClass")}>
-                                <div className={clsx(kcClsx("kcLabelWrapperClass"), "subtitle")}>
-                                    <span className="subtitle">
-                                        <span className="required">*</span>
-                                        {msg("requiredFields")}
-                                    </span>
-                                </div>
-                                <div className="col-md-10">
-                                    <h1 id="kc-page-title">{headerNode}</h1>
-                                </div>
-                            </div>
-                        ) : (
+                    {(() => {
+                        const node = !(auth !== undefined && auth.showUsername && !auth.showResetCredentials) ? (
                             <h1 id="kc-page-title">{headerNode}</h1>
-                        )
-                    ) : displayRequiredFields ? (
-                        <div className={kcClsx("kcContentWrapperClass")}>
-                            <div className={clsx(kcClsx("kcLabelWrapperClass"), "subtitle")}>
-                                <span className="subtitle">
-                                    <span className="required">*</span> {msg("requiredFields")}
-                                </span>
-                            </div>
-                            <div className="col-md-10">
-                                {showUsernameNode}
-                                <div id="kc-username" className={kcClsx("kcFormGroupClass")}>
-                                    <label id="kc-attempted-username">{auth.attemptedUsername}</label>
-                                    <a id="reset-login" href={url.loginRestartFlowUrl} aria-label={msgStr("restartLoginTooltip")}>
-                                        <div className="kc-login-tooltip">
-                                            <i className={kcClsx("kcResetFlowIcon")}></i>
-                                            <span className="kc-tooltip-text">{msg("restartLoginTooltip")}</span>
-                                        </div>
-                                    </a>
-                                </div>
-                            </div>
-                        </div>
-                    ) : (
-                        <>
-                            {showUsernameNode}
+                        ) : (
                             <div id="kc-username" className={kcClsx("kcFormGroupClass")}>
                                 <label id="kc-attempted-username">{auth.attemptedUsername}</label>
                                 <a id="reset-login" href={url.loginRestartFlowUrl} aria-label={msgStr("restartLoginTooltip")}>
@@ -212,8 +176,24 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
                                     </div>
                                 </a>
                             </div>
-                        </>
-                    )}
+                        );
+
+                        if (displayRequiredFields) {
+                            return (
+                                <div className={kcClsx("kcContentWrapperClass")}>
+                                    <div className={clsx(kcClsx("kcLabelWrapperClass"), "subtitle")}>
+                                        <span className="subtitle">
+                                            <span className="required">*</span>
+                                            {msg("requiredFields")}
+                                        </span>
+                                    </div>
+                                    <div className="col-md-10">{node}</div>
+                                </div>
+                            );
+                        }
+
+                        return node;
+                    })()}
                 </header>
                 <div id="kc-content">
                     <div id="kc-content-wrapper">
@@ -244,19 +224,17 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
                         {auth !== undefined && auth.showTryAnotherWayLink && (
                             <form id="kc-select-try-another-way-form" action={url.loginAction} method="post">
                                 <div className={kcClsx("kcFormGroupClass")}>
-                                    <div className={kcClsx("kcFormGroupClass")}>
-                                        <input type="hidden" name="tryAnotherWay" value="on" />
-                                        <a
-                                            href="#"
-                                            id="try-another-way"
-                                            onClick={() => {
-                                                document.forms["kc-select-try-another-way-form" as never].submit();
-                                                return false;
-                                            }}
-                                        >
-                                            {msg("doTryAnotherWay")}
-                                        </a>
-                                    </div>
+                                    <input type="hidden" name="tryAnotherWay" value="on" />
+                                    <a
+                                        href="#"
+                                        id="try-another-way"
+                                        onClick={() => {
+                                            document.forms["kc-select-try-another-way-form" as never].submit();
+                                            return false;
+                                        }}
+                                    >
+                                        {msg("doTryAnotherWay")}
+                                    </a>
                                 </div>
                             </form>
                         )}

package/src/login/TemplateProps.ts

@@ -12,7 +12,6 @@ export type TemplateProps<KcContext, I18n> = {
     displayRequiredFields?: boolean;
     showAnotherWayIfPresent?: boolean;
     headerNode: ReactNode;
-    showUsernameNode?: ReactNode;
     socialProvidersNode?: ReactNode;
     infoNode?: ReactNode;
     documentTitle?: string;

package/src/login/UserProfileFormFields.tsx

@@ -1,5 +1,5 @@
 import { useEffect, useReducer, Fragment } from "react";
-import { assert } from "tsafe/assert";
+import { assert } from "keycloakify/tools/assert";
 import type { KcClsx } from "keycloakify/login/lib/kcClsx";
 import {
     useUserProfileForm,
@@ -58,7 +58,7 @@ export default function UserProfileFormFields(props: UserProfileFormFieldsProps<
                                 <label htmlFor={attribute.name} className={kcClsx("kcLabelClass")}>
                                     {advancedMsg(attribute.displayName ?? "")}
                                 </label>
-                                {attribute.required && <>*</>}
+                                {attribute.required && <> *</>}
                             </div>
                             <div className={kcClsx("kcInputWrapperClass")}>
                                 {attribute.annotations.inputHelperTextBefore !== undefined && (
@@ -70,7 +70,7 @@ export default function UserProfileFormFields(props: UserProfileFormFieldsProps<
                                         {advancedMsg(attribute.annotations.inputHelperTextBefore)}
                                     </div>
                                 )}
-                                <InputFiledByType
+                                <InputFieldByType
                                     attribute={attribute}
                                     valueOrValues={valueOrValues}
                                     displayableErrors={displayableErrors}
@@ -188,7 +188,7 @@ function FieldErrors(props: { attribute: Attribute; displayableErrors: FormField
                 .filter(error => error.fieldIndex === fieldIndex)
                 .map(({ errorMessage }, i, arr) => (
                     <Fragment key={i}>
-                        <span key={i}>{errorMessage}</span>
+                        {errorMessage}
                         {arr.length - 1 !== i && <br />}
                     </Fragment>
                 ))}
@@ -196,7 +196,7 @@ function FieldErrors(props: { attribute: Attribute; displayableErrors: FormField
     );
 }
 
-type InputFiledByTypeProps = {
+type InputFieldByTypeProps = {
     attribute: Attribute;
     valueOrValues: string | string[];
     displayableErrors: FormFieldError[];
@@ -205,7 +205,7 @@ type InputFiledByTypeProps = {
     kcClsx: KcClsx;
 };
 
-function InputFiledByType(props: InputFiledByTypeProps) {
+function InputFieldByType(props: InputFieldByTypeProps) {
     const { attribute, valueOrValues } = props;
 
     switch (attribute.annotations.inputType) {
@@ -274,9 +274,11 @@ function PasswordWrapper(props: { kcClsx: KcClsx; i18n: I18n; passwordInputId: s
     );
 }
 
-function InputTag(props: InputFiledByTypeProps & { fieldIndex: number | undefined }) {
+function InputTag(props: InputFieldByTypeProps & { fieldIndex: number | undefined }) {
     const { attribute, fieldIndex, kcClsx, dispatchFormAction, valueOrValues, i18n, displayableErrors } = props;
 
+    const { advancedMsgStr } = i18n;
+
     return (
         <>
             <input
@@ -305,7 +307,9 @@ function InputTag(props: InputFiledByTypeProps & { fieldIndex: number | undefine
                 aria-invalid={displayableErrors.find(error => error.fieldIndex === fieldIndex) !== undefined}
                 disabled={attribute.readOnly}
                 autoComplete={attribute.autocomplete}
-                placeholder={attribute.annotations.inputTypePlaceholder}
+                placeholder={
+                    attribute.annotations.inputTypePlaceholder === undefined ? undefined : advancedMsgStr(attribute.annotations.inputTypePlaceholder)
+                }
                 pattern={attribute.annotations.inputTypePattern}
                 size={attribute.annotations.inputTypeSize === undefined ? undefined : parseInt(`${attribute.annotations.inputTypeSize}`)}
                 maxLength={
@@ -429,7 +433,7 @@ function AddRemoveButtonsMultiValuedAttribute(props: {
     );
 }
 
-function InputTagSelects(props: InputFiledByTypeProps) {
+function InputTagSelects(props: InputFieldByTypeProps) {
     const { attribute, dispatchFormAction, kcClsx, valueOrValues } = props;
 
     const { advancedMsg } = props.i18n;
@@ -537,7 +541,7 @@ function InputTagSelects(props: InputFiledByTypeProps) {
     );
 }
 
-function TextareaTag(props: InputFiledByTypeProps) {
+function TextareaTag(props: InputFieldByTypeProps) {
     const { attribute, dispatchFormAction, kcClsx, displayableErrors, valueOrValues } = props;
 
     assert(typeof valueOrValues === "string");
@@ -573,7 +577,7 @@ function TextareaTag(props: InputFiledByTypeProps) {
     );
 }
 
-function SelectTag(props: InputFiledByTypeProps) {
+function SelectTag(props: InputFieldByTypeProps) {
     const { attribute, dispatchFormAction, kcClsx, displayableErrors, i18n, valueOrValues } = props;
 
     const { advancedMsg } = i18n;

package/src/login/i18n/GenericI18n.tsx

@@ -0,0 +1,6 @@
+import type { GenericI18n_noJsx } from "./i18n";
+
+export type GenericI18n<MessageKey extends string> = GenericI18n_noJsx<MessageKey> & {
+    msg: (key: MessageKey, ...args: (string | undefined)[]) => JSX.Element;
+    advancedMsg: (key: string, ...args: (string | undefined)[]) => JSX.Element;
+};