keycloakify 10.0.0-rc.48 → 10.0.0-rc.49

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

@@ -159,7 +159,8 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
             );
 
             const { keycloakVersion } = await promptKeycloakVersion({
-                startingFromMajor: 17,
+                startingFromMajor: 18,
+                excludeMajorVersions: [22],
                 cacheDirPath: buildContext.cacheDirPath
             });
 
@@ -231,6 +232,10 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
 
     const realmJsonFilePath = await (async () => {
         if (cliCommandOptions.realmJsonFilePath !== undefined) {
+            if (cliCommandOptions.realmJsonFilePath === "none") {
+                return undefined;
+            }
+
             console.log(
                 chalk.green(
                     `Using realm json file: ${cliCommandOptions.realmJsonFilePath}`
@@ -312,6 +317,10 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
 
     await extractThemeResourcesFromJar();
 
+    const jarFilePath_cacheDir = pathJoin(buildContext.cacheDirPath, jarFileBasename);
+
+    fs.copyFileSync(jarFilePath, jarFilePath_cacheDir);
+
     try {
         child_process.execSync(`docker rm --force ${containerName}`, {
             stdio: "ignore"
@@ -332,7 +341,10 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
                       "-v",
                       `${realmJsonFilePath}:/opt/keycloak/data/import/myrealm-realm.json`
                   ]),
-            ...["-v", `${jarFilePath}:/opt/keycloak/providers/keycloak-theme.jar`],
+            ...[
+                "-v",
+                `${jarFilePath_cacheDir}:/opt/keycloak/providers/keycloak-theme.jar`
+            ],
             ...(keycloakMajorVersionNumber <= 20
                 ? ["-e", "JAVA_OPTS=-Dkeycloak.profile=preview"]
                 : []),

package/src/login/lib/useUserProfileForm.tsx

@@ -130,168 +130,137 @@ export function useUserProfileForm(params: ParamsOfUseUserProfileForm): ReturnTy
     const initialState = useMemo((): internal.State => {
         // NOTE: We don't use te kcContext.profile.attributes directly because
         // they don't includes the password and password confirm fields and we want to add them.
-        // Also, we want to polyfill the attributes for older Keycloak version before User Profile was introduced.
-        // Finally we want to patch the changes made by Keycloak on the attributes format so we have an homogeneous
-        // attributes format to work with.
-        const syntheticAttributes = (() => {
-            const syntheticAttributes: Attribute[] = [];
-
-            const attributes = (() => {
-                retrocompat_patch: {
-                    if (
-                        "profile" in kcContext &&
-                        "attributesByName" in kcContext.profile &&
-                        Object.keys(kcContext.profile.attributesByName).length !== 0
-                    ) {
-                        break retrocompat_patch;
-                    }
-
-                    if ("register" in kcContext && kcContext.register instanceof Object && "formData" in kcContext.register) {
-                        //NOTE: Handle legacy register.ftl page
-                        return (["firstName", "lastName", "email", "username"] as const)
-                            .filter(name => (name !== "username" ? true : !kcContext.realm.registrationEmailAsUsername))
-                            .map(name =>
-                                id<Attribute>({
-                                    name: name,
-                                    displayName: id<`\${${MessageKey}}`>(`\${${name}}`),
-                                    required: true,
-                                    value: (kcContext.register as any).formData[name] ?? "",
-                                    html5DataAnnotations: {},
-                                    readOnly: false,
-                                    validators: {},
-                                    annotations: {},
-                                    autocomplete: (() => {
-                                        switch (name) {
-                                            case "email":
-                                                return "email";
-                                            case "username":
-                                                return "username";
-                                            default:
-                                                return undefined;
-                                        }
-                                    })()
-                                })
-                            );
-                    }
+        // We also want to apply some retro-compatibility and consistency patches.
+        const attributes: Attribute[] = (() => {
+            mock_user_profile_attributes_for_older_keycloak_versions: {
+                if (
+                    "profile" in kcContext &&
+                    "attributesByName" in kcContext.profile &&
+                    Object.keys(kcContext.profile.attributesByName).length !== 0
+                ) {
+                    break mock_user_profile_attributes_for_older_keycloak_versions;
+                }
 
-                    if ("user" in kcContext && kcContext.user instanceof Object) {
-                        //NOTE: Handle legacy login-update-profile.ftl
-                        return (["username", "email", "firstName", "lastName"] as const)
-                            .filter(name => (name !== "username" ? true : (kcContext.user as any).editUsernameAllowed))
-                            .map(name =>
-                                id<Attribute>({
-                                    name: name,
-                                    displayName: id<`\${${MessageKey}}`>(`\${${name}}`),
-                                    required: true,
-                                    value: (kcContext as any).user[name] ?? "",
-                                    html5DataAnnotations: {},
-                                    readOnly: false,
-                                    validators: {},
-                                    annotations: {},
-                                    autocomplete: (() => {
-                                        switch (name) {
-                                            case "email":
-                                                return "email";
-                                            case "username":
-                                                return "username";
-                                            default:
-                                                return undefined;
-                                        }
-                                    })()
-                                })
-                            );
-                    }
+                if ("register" in kcContext && kcContext.register instanceof Object && "formData" in kcContext.register) {
+                    //NOTE: Handle legacy register.ftl page
+                    return (["firstName", "lastName", "email", "username"] as const)
+                        .filter(name => (name !== "username" ? true : !kcContext.realm.registrationEmailAsUsername))
+                        .map(name =>
+                            id<Attribute>({
+                                name: name,
+                                displayName: id<`\${${MessageKey}}`>(`\${${name}}`),
+                                required: true,
+                                value: (kcContext.register as any).formData[name] ?? "",
+                                html5DataAnnotations: {},
+                                readOnly: false,
+                                validators: {},
+                                annotations: {},
+                                autocomplete: (() => {
+                                    switch (name) {
+                                        case "email":
+                                            return "email";
+                                        case "username":
+                                            return "username";
+                                        default:
+                                            return undefined;
+                                    }
+                                })()
+                            })
+                        );
+                }
 
-                    if ("email" in kcContext && kcContext.email instanceof Object) {
-                        //NOTE: Handle legacy update-email.ftl
-                        return [
+                if ("user" in kcContext && kcContext.user instanceof Object) {
+                    //NOTE: Handle legacy login-update-profile.ftl
+                    return (["username", "email", "firstName", "lastName"] as const)
+                        .filter(name => (name !== "username" ? true : (kcContext.user as any).editUsernameAllowed))
+                        .map(name =>
                             id<Attribute>({
-                                name: "email",
-                                displayName: id<`\${${MessageKey}}`>(`\${email}`),
+                                name: name,
+                                displayName: id<`\${${MessageKey}}`>(`\${${name}}`),
                                 required: true,
-                                value: (kcContext.email as any).value ?? "",
+                                value: (kcContext as any).user[name] ?? "",
                                 html5DataAnnotations: {},
                                 readOnly: false,
                                 validators: {},
                                 annotations: {},
-                                autocomplete: "email"
+                                autocomplete: (() => {
+                                    switch (name) {
+                                        case "email":
+                                            return "email";
+                                        case "username":
+                                            return "username";
+                                        default:
+                                            return undefined;
+                                    }
+                                })()
                             })
-                        ];
-                    }
+                        );
+                }
 
-                    assert(false, "Unable to mock user profile from the current kcContext");
+                if ("email" in kcContext && kcContext.email instanceof Object) {
+                    //NOTE: Handle legacy update-email.ftl
+                    return [
+                        id<Attribute>({
+                            name: "email",
+                            displayName: id<`\${${MessageKey}}`>(`\${email}`),
+                            required: true,
+                            value: (kcContext.email as any).value ?? "",
+                            html5DataAnnotations: {},
+                            readOnly: false,
+                            validators: {},
+                            annotations: {},
+                            autocomplete: "email"
+                        })
+                    ];
                 }
 
-                return Object.values(kcContext.profile.attributesByName).map(attribute_pre_group_patch => {
-                    if (typeof attribute_pre_group_patch.group === "string" && attribute_pre_group_patch.group !== "") {
-                        const { group, groupDisplayHeader, groupDisplayDescription, groupAnnotations, ...rest } =
-                            attribute_pre_group_patch as Attribute & {
-                                group: string;
-                                groupDisplayHeader?: string;
-                                groupDisplayDescription?: string;
-                                groupAnnotations: Record<string, string>;
-                            };
-
-                        return id<Attribute>({
-                            ...rest,
-                            group: {
-                                name: group,
-                                displayHeader: groupDisplayHeader,
-                                displayDescription: groupDisplayDescription,
-                                html5DataAnnotations: {}
-                            }
-                        });
-                    }
+                assert(false, "Unable to mock user profile from the current kcContext");
+            }
 
-                    return attribute_pre_group_patch;
-                });
-            })();
+            return Object.values(kcContext.profile.attributesByName).map(structuredCloneButFunctions);
+        })();
 
-            for (const attribute of attributes) {
-                syntheticAttributes.push(structuredCloneButFunctions(attribute));
+        // Retro-compatibility and consistency patches
+        attributes.forEach(attribute => {
+            patch_legacy_group: {
+                if (typeof attribute.group !== "string") {
+                    break patch_legacy_group;
+                }
 
-                add_password_and_password_confirm: {
-                    if (!kcContext.passwordRequired) {
-                        break add_password_and_password_confirm;
-                    }
+                const { group, groupDisplayHeader, groupDisplayDescription /*, groupAnnotations*/ } = attribute as Attribute & {
+                    group: string;
+                    groupDisplayHeader?: string;
+                    groupDisplayDescription?: string;
+                    groupAnnotations: Record<string, string>;
+                };
 
-                    if (attribute.name !== (kcContext.realm.registrationEmailAsUsername ? "email" : "username")) {
-                        // NOTE: We want to add password and password-confirm after the field that identifies the user.
-                        // It's either email or username.
-                        break add_password_and_password_confirm;
-                    }
+                delete attribute.group;
+                // @ts-expect-error
+                delete attribute.groupDisplayHeader;
+                // @ts-expect-error
+                delete attribute.groupDisplayDescription;
+                // @ts-expect-error
+                delete attribute.groupAnnotations;
 
-                    syntheticAttributes.push(
-                        {
-                            name: "password",
-                            displayName: id<`\${${MessageKey}}`>("${password}"),
-                            required: true,
-                            readOnly: false,
-                            validators: {},
-                            annotations: {},
-                            autocomplete: "new-password",
-                            html5DataAnnotations: {},
-                            // NOTE: Compat with Keycloak version prior to 24
-                            ...({ groupAnnotations: {} } as {})
-                        },
-                        {
-                            name: "password-confirm",
-                            displayName: id<`\${${MessageKey}}`>("${passwordConfirm}"),
-                            required: true,
-                            readOnly: false,
-                            validators: {},
-                            annotations: {},
-                            html5DataAnnotations: {},
-                            autocomplete: "new-password",
-                            // NOTE: Compat with Keycloak version prior to 24
-                            ...({ groupAnnotations: {} } as {})
-                        }
-                    );
+                if (group === "") {
+                    break patch_legacy_group;
                 }
+
+                attribute.group = {
+                    name: group,
+                    displayHeader: groupDisplayHeader,
+                    displayDescription: groupDisplayDescription,
+                    html5DataAnnotations: {}
+                };
+            }
+
+            // Attributes with options rendered by default as select inputs
+            if (attribute.validators.options !== undefined && attribute.annotations.inputType === undefined) {
+                attribute.annotations.inputType = "select";
             }
 
-            // NOTE: Consistency patch
-            syntheticAttributes.forEach(attribute => {
+            // Consistency patch on values/value property
+            {
                 if (getIsMultivaluedSingleField({ attribute })) {
                     attribute.multivalued = true;
                 }
@@ -303,65 +272,98 @@ export function useUserProfileForm(params: ParamsOfUseUserProfileForm): ReturnTy
                     attribute.value ??= attribute.values?.[0];
                     delete attribute.values;
                 }
-            });
+            }
+        });
 
-            return syntheticAttributes;
-        })();
+        add_password_and_password_confirm: {
+            if (!kcContext.passwordRequired) {
+                break add_password_and_password_confirm;
+            }
 
-        const initialFormFieldState = (() => {
-            const out: {
-                attribute: Attribute;
-                valueOrValues: string | string[];
-            }[] = [];
+            attributes.forEach((attribute, i) => {
+                if (attribute.name !== (kcContext.realm.registrationEmailAsUsername ? "email" : "username")) {
+                    // NOTE: We want to add password and password-confirm after the field that identifies the user.
+                    // It's either email or username.
+                    return;
+                }
 
-            for (const attribute of syntheticAttributes) {
-                handle_multi_valued_attribute: {
-                    if (!attribute.multivalued) {
-                        break handle_multi_valued_attribute;
+                attributes.splice(
+                    i + 1,
+                    0,
+                    {
+                        name: "password",
+                        displayName: id<`\${${MessageKey}}`>("${password}"),
+                        required: true,
+                        readOnly: false,
+                        validators: {},
+                        annotations: {},
+                        autocomplete: "new-password",
+                        html5DataAnnotations: {}
+                    },
+                    {
+                        name: "password-confirm",
+                        displayName: id<`\${${MessageKey}}`>("${passwordConfirm}"),
+                        required: true,
+                        readOnly: false,
+                        validators: {},
+                        annotations: {},
+                        html5DataAnnotations: {},
+                        autocomplete: "new-password"
                     }
+                );
+            });
+        }
 
-                    const values = attribute.values?.length ? attribute.values : [""];
+        const initialFormFieldState: {
+            attribute: Attribute;
+            valueOrValues: string | string[];
+        }[] = [];
 
-                    apply_validator_min_range: {
-                        if (getIsMultivaluedSingleField({ attribute })) {
-                            break apply_validator_min_range;
-                        }
+        for (const attribute of attributes) {
+            handle_multi_valued_attribute: {
+                if (!attribute.multivalued) {
+                    break handle_multi_valued_attribute;
+                }
 
-                        const validator = attribute.validators.multivalued;
+                const values = attribute.values?.length ? attribute.values : [""];
 
-                        if (validator === undefined) {
-                            break apply_validator_min_range;
-                        }
+                apply_validator_min_range: {
+                    if (getIsMultivaluedSingleField({ attribute })) {
+                        break apply_validator_min_range;
+                    }
 
-                        const { min: minStr } = validator;
+                    const validator = attribute.validators.multivalued;
 
-                        if (!minStr) {
-                            break apply_validator_min_range;
-                        }
+                    if (validator === undefined) {
+                        break apply_validator_min_range;
+                    }
 
-                        const min = parseInt(`${minStr}`);
+                    const { min: minStr } = validator;
 
-                        for (let index = values.length; index < min; index++) {
-                            values.push("");
-                        }
+                    if (!minStr) {
+                        break apply_validator_min_range;
                     }
 
-                    out.push({
-                        attribute,
-                        valueOrValues: values
-                    });
+                    const min = parseInt(`${minStr}`);
 
-                    continue;
+                    for (let index = values.length; index < min; index++) {
+                        values.push("");
+                    }
                 }
 
-                out.push({
+                initialFormFieldState.push({
                     attribute,
-                    valueOrValues: attribute.value ?? ""
+                    valueOrValues: values
                 });
+
+                continue;
             }
 
-            return out;
-        })();
+            initialFormFieldState.push({
+                attribute,
+                valueOrValues: attribute.value ?? ""
+            });
+        }
 
         const initialState: internal.State = {
             formFieldStates: initialFormFieldState.map(({ attribute, valueOrValues }) => ({

package/src/tools/formatNumber.ts

@@ -1,4 +1,4 @@
-export const formatNumber = (input: string, format: string): string => {
+export const formatNumber = (input: string, format: string) => {
     if (!input) {
         return "";
     }
@@ -20,7 +20,8 @@ export const formatNumber = (input: string, format: string): string => {
     let rawValue = input.replace(/\D+/g, "");
 
     // make sure the value is a number
-    if (`${parseInt(rawValue)}` !== rawValue) {
+    // @ts-expect-error: It's Keycloak's code, we trust it.
+    if (parseInt(rawValue) != rawValue) {
         return "";
     }
 

package/tools/formatNumber.js

@@ -12,7 +12,8 @@ export const formatNumber = (input, format) => {
     // keep only digits
     let rawValue = input.replace(/\D+/g, "");
     // make sure the value is a number
-    if (`${parseInt(rawValue)}` !== rawValue) {
+    // @ts-expect-error: It's Keycloak's code, we trust it.
+    if (parseInt(rawValue) != rawValue) {
         return "";
     }
     // make sure the number of digits does not exceed the maximum size

package/tools/formatNumber.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatNumber.js","sourceRoot":"","sources":["../src/tools/formatNumber.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,KAAa,EAAE,MAAc,EAAU,EAAE;IAClE,IAAI,CAAC,KAAK,EAAE;QACR,OAAO,EAAE,CAAC;KACb;IAED,4EAA4E;IAC5E,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE5C,IAAI,CAAC,YAAY,EAAE;QACf,OAAO,EAAE,CAAC;KACb;IAED,0FAA0F;IAC1F,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAC/B,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EACnE,CAAC,CACJ,CAAC;IAEF,mBAAmB;IACnB,IAAI,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAEzC,kCAAkC;IAClC,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,EAAE,KAAK,QAAQ,EAAE;QACtC,OAAO,EAAE,CAAC;KACb;IAED,kEAAkE;IAClE,IAAI,QAAQ,CAAC,MAAM,GAAG,OAAO,EAAE;QAC3B,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;KAC7C;IAED,kEAAkE;IAClE,MAAM,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAEhF,mFAAmF;IACnF,IAAI,MAAM,GAAG,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAElD,oDAAoD;IACpD,IAAI,CAAC,MAAM,EAAE;QACT,OAAO,KAAK,CAAC;KAChB;IAED,IAAI,MAAM,GAAG,MAAM,CAAC;IAEpB,oEAAoE;IACpE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC1C,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KAC3D;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC"}
+{"version":3,"file":"formatNumber.js","sourceRoot":"","sources":["../src/tools/formatNumber.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,KAAa,EAAE,MAAc,EAAE,EAAE;IAC1D,IAAI,CAAC,KAAK,EAAE;QACR,OAAO,EAAE,CAAC;KACb;IAED,4EAA4E;IAC5E,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE5C,IAAI,CAAC,YAAY,EAAE;QACf,OAAO,EAAE,CAAC;KACb;IAED,0FAA0F;IAC1F,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAC/B,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EACnE,CAAC,CACJ,CAAC;IAEF,mBAAmB;IACnB,IAAI,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAEzC,kCAAkC;IAClC,uDAAuD;IACvD,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,EAAE;QAChC,OAAO,EAAE,CAAC;KACb;IAED,kEAAkE;IAClE,IAAI,QAAQ,CAAC,MAAM,GAAG,OAAO,EAAE;QAC3B,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;KAC7C;IAED,kEAAkE;IAClE,MAAM,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAEhF,mFAAmF;IACnF,IAAI,MAAM,GAAG,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAElD,oDAAoD;IACpD,IAAI,CAAC,MAAM,EAAE;QACT,OAAO,KAAK,CAAC;KAChB;IAED,IAAI,MAAM,GAAG,MAAM,CAAC;IAEpB,oEAAoE;IACpE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC1C,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KAC3D;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC"}