Release candidate

package.json

@@ -1,6 +1,6 @@
 {
     "name": "keycloakify",
-    "version": "10.0.0-rc.50",
+    "version": "10.0.0-rc.57",
     "description": "Create Keycloak themes using React",
     "repository": {
         "type": "git",

src/account/index.ts

@@ -1,4 +1,3 @@
 export type { ExtendKcContext } from "keycloakify/account/KcContext";
 export type { ClassKey } from "keycloakify/account/TemplateProps";
-export type { PageProps } from "keycloakify/account/pages/PageProps";
 export { createUseI18n } from "keycloakify/account/i18n";

src/bin/shared/generateKcGenTs.ts

@@ -46,7 +46,7 @@ export async function generateKcGenTs(params: {
             ``,
             `export type KcEnvName = ${buildContext.environmentVariables.length === 0 ? "never" : buildContext.environmentVariables.map(({ name }) => `"${name}"`).join(" | ")};`,
             ``,
-            `export const KcEnvNames: KcEnvName[] = [${buildContext.environmentVariables.map(({ name }) => `"${name}"`).join(", ")}];`,
+            `export const kcEnvNames: KcEnvName[] = [${buildContext.environmentVariables.map(({ name }) => `"${name}"`).join(", ")}];`,
             ``,
             `export const kcEnvDefaults: Record<KcEnvName, string> = ${JSON.stringify(
                 Object.fromEntries(

src/bin/start-keycloak/start-keycloak.ts

@@ -9,7 +9,12 @@ import type { KeycloakVersionRange } from "../shared/KeycloakVersionRange";
 import { getJarFileBasename } from "../shared/getJarFileBasename";
 import { assert, type Equals } from "tsafe/assert";
 import * as fs from "fs";
-import { join as pathJoin, relative as pathRelative, sep as pathSep } from "path";
+import {
+    join as pathJoin,
+    relative as pathRelative,
+    sep as pathSep,
+    basename as pathBasename
+} from "path";
 import * as child_process from "child_process";
 import chalk from "chalk";
 import chokidar from "chokidar";
@@ -248,46 +253,70 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
             });
         }
 
-        const dirPath = pathJoin(
-            getThisCodebaseRootDirPath(),
-            "src",
-            "bin",
-            "start-keycloak"
-        );
+        const internalFilePath = await (async () => {
+            const dirPath = pathJoin(
+                getThisCodebaseRootDirPath(),
+                "src",
+                "bin",
+                "start-keycloak"
+            );
 
-        const filePath = pathJoin(
-            dirPath,
-            `myrealm-realm-${keycloakMajorVersionNumber}.json`
-        );
+            const filePath = pathJoin(
+                dirPath,
+                `myrealm-realm-${keycloakMajorVersionNumber}.json`
+            );
 
-        if (fs.existsSync(filePath)) {
-            return filePath;
-        }
+            if (fs.existsSync(filePath)) {
+                return filePath;
+            }
 
-        console.log(
-            `${chalk.yellow(
-                `Keycloakify do not have a realm configuration for Keycloak ${keycloakMajorVersionNumber} yet.`
-            )}`
-        );
+            console.log(
+                `${chalk.yellow(
+                    `Keycloakify do not have a realm configuration for Keycloak ${keycloakMajorVersionNumber} yet.`
+                )}`
+            );
 
-        console.log(chalk.cyan("Select what configuration to use:"));
+            console.log(chalk.cyan("Select what configuration to use:"));
 
-        const { value } = await cliSelect<string>({
-            values: [
-                ...fs
-                    .readdirSync(dirPath)
-                    .filter(fileBasename => fileBasename.endsWith(".json")),
-                "none"
-            ]
-        }).catch(() => {
-            process.exit(-1);
-        });
+            const { value } = await cliSelect<string>({
+                values: [
+                    ...fs
+                        .readdirSync(dirPath)
+                        .filter(fileBasename => fileBasename.endsWith(".json")),
+                    "none"
+                ]
+            }).catch(() => {
+                process.exit(-1);
+            });
 
-        if (value === "none") {
+            if (value === "none") {
+                return undefined;
+            }
+
+            return pathJoin(dirPath, value);
+        })();
+
+        if (internalFilePath === undefined) {
             return undefined;
         }
 
-        return pathJoin(dirPath, value);
+        const filePath = pathJoin(
+            buildContext.cacheDirPath,
+            pathBasename(internalFilePath)
+        );
+
+        fs.writeFileSync(
+            filePath,
+            Buffer.from(
+                fs
+                    .readFileSync(internalFilePath)
+                    .toString("utf8")
+                    .replace(/keycloakify\-starter/g, buildContext.themeNames[0])
+            ),
+            "utf8"
+        );
+
+        return filePath;
     })();
 
     const jarFilePath = pathJoin(buildContext.keycloakifyBuildDirPath, jarFileBasename);

src/login/DefaultPage.tsx

@@ -4,7 +4,7 @@ import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
 import type { I18n } from "keycloakify/login/i18n";
 import type { KcContext } from "keycloakify/login/KcContext";
-import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFields";
+import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFieldsProps";
 
 const Login = lazy(() => import("keycloakify/login/pages/Login"));
 const Register = lazy(() => import("keycloakify/login/pages/Register"));

src/login/KcContext/KcContext.ts

@@ -209,17 +209,13 @@ export declare namespace KcContext {
     export type Register = Common & {
         pageId: "register.ftl";
         profile: UserProfile;
+        passwordPolicies?: PasswordPolicies;
         url: {
             registrationAction: string;
         };
         passwordRequired: boolean;
         recaptchaRequired: boolean;
         recaptchaSiteKey?: string;
-        /**
-         * Theses values are added by: https://github.com/jcputney/keycloak-theme-additional-info-extension
-         * A Keycloak Java extension used as dependency in Keycloakify.
-         */
-        passwordPolicies?: PasswordPolicies;
         termsAcceptanceRequired?: boolean;
     };
 
@@ -233,6 +229,7 @@ export declare namespace KcContext {
         client: {
             baseUrl?: string;
         };
+        message: NonNullable<Common["message"]>;
     };
 
     export type Error = Common & {
@@ -479,16 +476,19 @@ export declare namespace KcContext {
     export type LoginUpdateProfile = Common & {
         pageId: "login-update-profile.ftl";
         profile: UserProfile;
+        passwordPolicies?: PasswordPolicies;
     };
 
     export type IdpReviewUserProfile = Common & {
         pageId: "idp-review-user-profile.ftl";
         profile: UserProfile;
+        passwordPolicies?: PasswordPolicies;
     };
 
     export type UpdateEmail = Common & {
         pageId: "update-email.ftl";
         profile: UserProfile;
+        passwordPolicies?: PasswordPolicies;
     };
 
     export type SelectAuthenticator = Common & {
@@ -752,6 +752,10 @@ export declare namespace Validators {
     assert<Equals<OnlyInExpected, never>>();
 }
 
+/**
+ * Theses values are added by: https://github.com/jcputney/keycloak-theme-additional-info-extension
+ * A Keycloak Java extension used as dependency in Keycloakify.
+ */
 export type PasswordPolicies = {
     /** The minimum length of the password */
     length?: number;

src/login/KcContext/kcContextMocks.ts

@@ -212,6 +212,11 @@ export const kcContextMocks = [
             clientId: "myApp",
             baseUrl: "#",
             attributes: {}
+        },
+        message: {
+            type: "info",
+            summary:
+                "This is the info message from the Keycloak server (in real environment, this message is localized)"
         }
     }),
     id<KcContext.Error>({
@@ -224,7 +229,8 @@ export const kcContextMocks = [
         },
         message: {
             type: "error",
-            summary: "This is the error message"
+            summary:
+                "This is the error message from the Keycloak server (in real environment, this message is localized)"
         }
     }),
     id<KcContext.LoginResetPassword>({

src/login/UserProfileFormFields.tsx

@@ -4,33 +4,15 @@ import type { KcClsx } from "keycloakify/login/lib/kcClsx";
 import {
     useUserProfileForm,
     getButtonToDisplayForMultivaluedAttributeField,
-    type KcContextLike,
     type FormAction,
     type FormFieldError
 } from "keycloakify/login/lib/useUserProfileForm";
+import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFieldsProps";
 import type { Attribute } from "keycloakify/login/KcContext";
+import type { KcContext } from "./KcContext";
 import type { I18n } from "./i18n";
 
-export type UserProfileFormFieldsProps = {
-    kcContext: KcContextLike;
-    i18n: I18n;
-    kcClsx: KcClsx;
-    onIsFormSubmittableValueChange: (isFormSubmittable: boolean) => void;
-    doMakeUserConfirmPassword: boolean;
-    BeforeField?: (props: BeforeAfterFieldProps) => JSX.Element | null;
-    AfterField?: (props: BeforeAfterFieldProps) => JSX.Element | null;
-};
-
-type BeforeAfterFieldProps = {
-    attribute: Attribute;
-    dispatchFormAction: React.Dispatch<FormAction>;
-    displayableErrors: FormFieldError[];
-    valueOrValues: string | string[];
-    kcClsx: KcClsx;
-    i18n: I18n;
-};
-
-export default function UserProfileFormFields(props: UserProfileFormFieldsProps) {
+export default function UserProfileFormFields(props: UserProfileFormFieldsProps<KcContext, I18n>) {
     const { kcContext, i18n, kcClsx, onIsFormSubmittableValueChange, doMakeUserConfirmPassword, BeforeField, AfterField } = props;
 
     const { advancedMsg } = i18n;

src/login/UserProfileFormFieldsProps.tsx

@@ -0,0 +1,22 @@
+import { type FormAction, type FormFieldError } from "keycloakify/login/lib/useUserProfileForm";
+import type { KcClsx } from "keycloakify/login/lib/kcClsx";
+import type { Attribute } from "keycloakify/login/KcContext";
+
+export type UserProfileFormFieldsProps<KcContext = any, I18n = any> = {
+    kcContext: Extract<KcContext, { profile: unknown }>;
+    i18n: I18n;
+    kcClsx: KcClsx;
+    onIsFormSubmittableValueChange: (isFormSubmittable: boolean) => void;
+    doMakeUserConfirmPassword: boolean;
+    BeforeField?: (props: BeforeAfterFieldProps<I18n>) => JSX.Element | null;
+    AfterField?: (props: BeforeAfterFieldProps<I18n>) => JSX.Element | null;
+};
+
+type BeforeAfterFieldProps<I18n> = {
+    attribute: Attribute;
+    dispatchFormAction: React.Dispatch<FormAction>;
+    displayableErrors: FormFieldError[];
+    valueOrValues: string | string[];
+    kcClsx: KcClsx;
+    i18n: I18n;
+};

src/login/index.ts

@@ -1,5 +1,4 @@
 export type { ExtendKcContext, Attribute } from "keycloakify/login/KcContext";
 export type { ClassKey } from "keycloakify/login/TemplateProps";
-export type { PageProps } from "keycloakify/login/pages/PageProps";
 export { useDownloadTerms } from "keycloakify/login/lib/useDownloadTerms";
 export { createUseI18n } from "keycloakify/login/i18n";

src/login/lib/useUserProfileForm.tsx

@@ -79,9 +79,9 @@ export type KcContextLike = KcContextLike_i18n &
         };
     };
 
-assert<Extract<KcContext.Register, { pageId: "register.ftl" }> extends KcContextLike ? true : false>();
+assert<Extract<Extract<KcContext, { profile: unknown }>, { pageId: "register.ftl" }> extends KcContextLike ? true : false>();
 
-export type ParamsOfUseUserProfileForm = {
+export type UseUserProfileFormParams = {
     kcContext: KcContextLike;
     i18n: I18n;
     doMakeUserConfirmPassword: boolean;
@@ -105,7 +105,7 @@ namespace internal {
     };
 }
 
-export function useUserProfileForm(params: ParamsOfUseUserProfileForm): ReturnTypeOfUseUserProfileForm {
+export function useUserProfileForm(params: UseUserProfileFormParams): ReturnTypeOfUseUserProfileForm {
     const { kcContext, i18n, doMakeUserConfirmPassword } = params;
 
     const { insertScriptTags } = useInsertScriptTags({

src/login/pages/IdpReviewUserProfile.tsx

@@ -2,7 +2,7 @@ import { useState } from "react";
 import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
 import { getKcClsx } from "keycloakify/login/lib/kcClsx";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
-import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFields";
+import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFieldsProps";
 import type { KcContext } from "../KcContext";
 import type { I18n } from "../i18n";
 

src/login/pages/Info.tsx

@@ -1,4 +1,3 @@
-import { assert } from "keycloakify/tools/assert";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
 import type { KcContext } from "../KcContext";
 import type { I18n } from "../i18n";
@@ -8,11 +7,6 @@ export default function Info(props: PageProps<Extract<KcContext, { pageId: "info
 
     const { msgStr, msg } = i18n;
 
-    assert(
-        kcContext.message !== undefined,
-        "No message in kcContext.message, there will always be a message in production context, add it in your mock"
-    );
-
     const { messageHeader, message, requiredActions, skipLink, pageRedirectUri, actionUri, client } = kcContext;
 
     return (

src/login/pages/LoginUpdateProfile.tsx

@@ -1,7 +1,7 @@
 import { useState } from "react";
 import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
 import { getKcClsx } from "keycloakify/login/lib/kcClsx";
-import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFields";
+import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFieldsProps";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
 import type { KcContext } from "../KcContext";
 import type { I18n } from "../i18n";

src/login/pages/Register.tsx

@@ -3,7 +3,7 @@ import { Markdown } from "keycloakify/tools/Markdown";
 import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
 import { useTermsMarkdown } from "keycloakify/login/lib/useDownloadTerms";
 import { getKcClsx, type KcClsx } from "keycloakify/login/lib/kcClsx";
-import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFields";
+import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFieldsProps";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
 import type { KcContext } from "../KcContext";
 import type { I18n } from "../i18n";

src/login/pages/UpdateEmail.tsx

@@ -1,7 +1,7 @@
 import { useState } from "react";
 import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
 import { getKcClsx, type KcClsx } from "keycloakify/login/lib/kcClsx";
-import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFields";
+import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFieldsProps";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
 import type { KcContext } from "../KcContext";
 import type { I18n } from "../i18n";