keycloakify 10.0.0-rc.17 → 10.0.0-rc.19

package/src/login/i18n/i18n.tsx

@@ -91,19 +91,19 @@ export function createUseI18n<ExtraMessageKey extends string = never>(extraMessa
 
                 setI18n({
                     ...createI18nTranslationFunctions({
-                        "fallbackMessages": {
+                        fallbackMessages: {
                             ...fallbackMessages,
                             ...(keycloakifyExtraMessages[fallbackLanguageTag] ?? {}),
                             ...(extraMessages[fallbackLanguageTag] ?? {})
                         } as any,
-                        "messages": {
+                        messages: {
                             ...(await getMessages(currentLanguageTag)),
                             ...((keycloakifyExtraMessages as any)[currentLanguageTag] ?? {}),
                             ...(extraMessages[currentLanguageTag] ?? {})
                         } as any
                     }),
                     currentLanguageTag,
-                    "getChangeLocalUrl": newLanguageTag => {
+                    getChangeLocalUrl: newLanguageTag => {
                         const { locale } = kcContext;
 
                         assert(locale !== undefined, "Internationalization not enabled");
@@ -114,7 +114,7 @@ export function createUseI18n<ExtraMessageKey extends string = never>(extraMessa
 
                         return targetSupportedLocale.url;
                     },
-                    "labelBySupportedLanguageTag": Object.fromEntries(
+                    labelBySupportedLanguageTag: Object.fromEntries(
                         (kcContext.locale?.supported ?? []).map(({ languageTag, label }) => [languageTag, label])
                     )
                 });
@@ -170,7 +170,7 @@ function createI18nTranslationFunctions<MessageKey extends string>(params: {
         })();
 
         return doRenderMarkdown ? (
-            <Markdown allowDangerousHtml renderers={{ "paragraph": "span" }}>
+            <Markdown allowDangerousHtml renderers={{ paragraph: "span" }}>
                 {messageWithArgsInjectedIfAny}
             </Markdown>
         ) : (
@@ -186,7 +186,7 @@ function createI18nTranslationFunctions<MessageKey extends string>(params: {
         const keyUnwrappedFromCurlyBraces = match === null ? key : match[1];
 
         const out = resolveMsg({
-            "key": keyUnwrappedFromCurlyBraces,
+            key: keyUnwrappedFromCurlyBraces,
             args,
             doRenderMarkdown
         });
@@ -195,38 +195,48 @@ function createI18nTranslationFunctions<MessageKey extends string>(params: {
     }
 
     return {
-        "msgStr": (key, ...args) => resolveMsg({ key, args, "doRenderMarkdown": false }) as string,
-        "msg": (key, ...args) => resolveMsg({ key, args, "doRenderMarkdown": true }) as JSX.Element,
-        "advancedMsg": (key, ...args) => resolveMsgAdvanced({ key, args, "doRenderMarkdown": true }) as JSX.Element,
-        "advancedMsgStr": (key, ...args) => resolveMsgAdvanced({ key, args, "doRenderMarkdown": false }) as string
+        msgStr: (key, ...args) => resolveMsg({ key, args, doRenderMarkdown: false }) as string,
+        msg: (key, ...args) => resolveMsg({ key, args, doRenderMarkdown: true }) as JSX.Element,
+        advancedMsg: (key, ...args) =>
+            resolveMsgAdvanced({
+                key,
+                args,
+                doRenderMarkdown: true
+            }) as JSX.Element,
+        advancedMsgStr: (key, ...args) =>
+            resolveMsgAdvanced({
+                key,
+                args,
+                doRenderMarkdown: false
+            }) as string
     };
 }
 
 const keycloakifyExtraMessages = {
-    "en": {
-        "shouldBeEqual": "{0} should be equal to {1}",
-        "shouldBeDifferent": "{0} should be different to {1}",
-        "shouldMatchPattern": "Pattern should match: `/{0}/`",
-        "mustBeAnInteger": "Must be an integer",
-        "notAValidOption": "Not a valid option",
-        "selectAnOption": "Select an option",
-        "remove": "Remove",
-        "addValue": "Add value"
+    en: {
+        shouldBeEqual: "{0} should be equal to {1}",
+        shouldBeDifferent: "{0} should be different to {1}",
+        shouldMatchPattern: "Pattern should match: `/{0}/`",
+        mustBeAnInteger: "Must be an integer",
+        notAValidOption: "Not a valid option",
+        selectAnOption: "Select an option",
+        remove: "Remove",
+        addValue: "Add value"
     },
-    "fr": {
+    fr: {
         /* spell-checker: disable */
-        "shouldBeEqual": "{0} doit être égal à {1}",
-        "shouldBeDifferent": "{0} doit être différent de {1}",
-        "shouldMatchPattern": "Dois respecter le schéma: `/{0}/`",
-        "mustBeAnInteger": "Doit être un nombre entier",
-        "notAValidOption": "N'est pas une option valide",
-
-        "logoutConfirmTitle": "Déconnexion",
-        "logoutConfirmHeader": "Êtes-vous sûr(e) de vouloir vous déconnecter ?",
-        "doLogout": "Se déconnecter",
-        "selectAnOption": "Sélectionner une option",
-        "remove": "Supprimer",
-        "addValue": "Ajouter une valeur"
+        shouldBeEqual: "{0} doit être égal à {1}",
+        shouldBeDifferent: "{0} doit être différent de {1}",
+        shouldMatchPattern: "Dois respecter le schéma: `/{0}/`",
+        mustBeAnInteger: "Doit être un nombre entier",
+        notAValidOption: "N'est pas une option valide",
+
+        logoutConfirmTitle: "Déconnexion",
+        logoutConfirmHeader: "Êtes-vous sûr(e) de vouloir vous déconnecter ?",
+        doLogout: "Se déconnecter",
+        selectAnOption: "Sélectionner une option",
+        remove: "Supprimer",
+        addValue: "Ajouter une valeur"
         /* spell-checker: enable */
     }
 };

package/src/login/kcContext/KcContext.ts

@@ -3,7 +3,10 @@ import { assert } from "tsafe/assert";
 import type { Equals } from "tsafe";
 import type { MessageKey } from "../i18n/i18n";
 
-type ExtractAfterStartingWith<Prefix extends string, StrEnum> = StrEnum extends `${Prefix}${infer U}` ? U : never;
+type ExtractAfterStartingWith<
+    Prefix extends string,
+    StrEnum
+> = StrEnum extends `${Prefix}${infer U}` ? U : never;
 
 /** Take theses type definition with a grain of salt.
  * Some values might be undefined on some pages.
@@ -103,7 +106,10 @@ export declare namespace KcContext {
              * @param text to return
              * @return text if message exists for given field, else undefined
              */
-            printIfExists: <T extends string>(fieldName: string, text: T) => T | undefined;
+            printIfExists: <T extends string>(
+                fieldName: string,
+                text: T
+            ) => T | undefined;
             /**
              * Check if exists error message for given fields
              *

package/src/login/kcContext/createGetKcContext.ts

@@ -10,15 +10,23 @@ import type { ExtendKcContext } from "./getKcContextFromWindow";
 import { getKcContextFromWindow } from "./getKcContextFromWindow";
 import { symToStr } from "tsafe/symToStr";
 
-export function createGetKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
+export function createGetKcContext<
+    KcContextExtension extends { pageId: string } = never
+>(params?: {
     mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
     mockProperties?: Record<string, string>;
 }) {
     const { mockData, mockProperties } = params ?? {};
 
-    function getKcContext<PageId extends ExtendKcContext<KcContextExtension>["pageId"] | undefined = undefined>(params?: {
+    function getKcContext<
+        PageId extends
+            | ExtendKcContext<KcContextExtension>["pageId"]
+            | undefined = undefined
+    >(params?: {
         mockPageId?: PageId;
-        storyPartialKcContext?: DeepPartial<Extract<ExtendKcContext<KcContextExtension>, { pageId: PageId }>>;
+        storyPartialKcContext?: DeepPartial<
+            Extract<ExtendKcContext<KcContextExtension>, { pageId: PageId }>
+        >;
     }): {
         kcContext: PageId extends undefined
             ? ExtendKcContext<KcContextExtension> | undefined
@@ -36,34 +44,46 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
                     break warn_that_mock_is_enbaled;
                 }
 
-                console.log(`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`, "background: red; color: yellow; font-size: medium");
+                console.log(
+                    `%cKeycloakify: ${symToStr({
+                        mockPageId
+                    })} set to ${mockPageId}.`,
+                    "background: red; color: yellow; font-size: medium"
+                );
             }
 
-            const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
+            const kcContextDefaultMock = kcContextMocks.find(
+                ({ pageId }) => pageId === mockPageId
+            );
 
             const partialKcContextCustomMock = (() => {
                 const out: DeepPartial<ExtendKcContext<KcContextExtension>> = {};
 
-                const mockDataPick = mockData?.find(({ pageId }) => pageId === mockPageId);
+                const mockDataPick = mockData?.find(
+                    ({ pageId }) => pageId === mockPageId
+                );
 
                 if (mockDataPick !== undefined) {
                     deepAssign({
-                        "target": out,
-                        "source": mockDataPick
+                        target: out,
+                        source: mockDataPick
                     });
                 }
 
                 if (storyPartialKcContext !== undefined) {
                     deepAssign({
-                        "target": out,
-                        "source": storyPartialKcContext
+                        target: out,
+                        source: storyPartialKcContext
                     });
                 }
 
                 return Object.keys(out).length === 0 ? undefined : out;
             })();
 
-            if (kcContextDefaultMock === undefined && partialKcContextCustomMock === undefined) {
+            if (
+                kcContextDefaultMock === undefined &&
+                partialKcContextCustomMock === undefined
+            ) {
                 console.warn(
                     [
                         `WARNING: You declared the non build in page ${mockPageId} but you didn't `,
@@ -76,68 +96,95 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
             const kcContext: any = {};
 
             deepAssign({
-                "target": kcContext,
-                "source": kcContextDefaultMock !== undefined ? kcContextDefaultMock : { "pageId": mockPageId, ...kcContextCommonMock }
+                target: kcContext,
+                source:
+                    kcContextDefaultMock !== undefined
+                        ? kcContextDefaultMock
+                        : { pageId: mockPageId, ...kcContextCommonMock }
             });
 
             if (partialKcContextCustomMock !== undefined) {
                 deepAssign({
-                    "target": kcContext,
-                    "source": partialKcContextCustomMock
+                    target: kcContext,
+                    source: partialKcContextCustomMock
                 });
 
                 if ("profile" in partialKcContextCustomMock) {
-                    assert(kcContextDefaultMock !== undefined && "profile" in kcContextDefaultMock);
+                    assert(
+                        kcContextDefaultMock !== undefined &&
+                            "profile" in kcContextDefaultMock
+                    );
 
                     const { attributes } = kcContextDefaultMock.profile;
 
                     id<KcContext.Register>(kcContext).profile.attributes = [];
                     id<KcContext.Register>(kcContext).profile.attributesByName = {};
 
-                    const partialAttributes = [...((partialKcContextCustomMock as DeepPartial<KcContext.Register>).profile?.attributes ?? [])].filter(
-                        exclude(undefined)
-                    );
+                    const partialAttributes = [
+                        ...((
+                            partialKcContextCustomMock as DeepPartial<KcContext.Register>
+                        ).profile?.attributes ?? [])
+                    ].filter(exclude(undefined));
 
                     attributes.forEach(attribute => {
-                        const partialAttribute = partialAttributes.find(({ name }) => name === attribute.name);
+                        const partialAttribute = partialAttributes.find(
+                            ({ name }) => name === attribute.name
+                        );
 
                         const augmentedAttribute: Attribute = {} as any;
 
                         deepAssign({
-                            "target": augmentedAttribute,
-                            "source": attribute
+                            target: augmentedAttribute,
+                            source: attribute
                         });
 
                         if (partialAttribute !== undefined) {
-                            partialAttributes.splice(partialAttributes.indexOf(partialAttribute), 1);
+                            partialAttributes.splice(
+                                partialAttributes.indexOf(partialAttribute),
+                                1
+                            );
 
                             deepAssign({
-                                "target": augmentedAttribute,
-                                "source": partialAttribute
+                                target: augmentedAttribute,
+                                source: partialAttribute
                             });
                         }
 
-                        id<KcContext.Register>(kcContext).profile.attributes.push(augmentedAttribute);
-                        id<KcContext.Register>(kcContext).profile.attributesByName[augmentedAttribute.name] = augmentedAttribute;
+                        id<KcContext.Register>(kcContext).profile.attributes.push(
+                            augmentedAttribute
+                        );
+                        id<KcContext.Register>(kcContext).profile.attributesByName[
+                            augmentedAttribute.name
+                        ] = augmentedAttribute;
                     });
 
                     partialAttributes
-                        .map(partialAttribute => ({ "validators": {}, ...partialAttribute }))
+                        .map(partialAttribute => ({
+                            validators: {},
+                            ...partialAttribute
+                        }))
                         .forEach(partialAttribute => {
                             const { name } = partialAttribute;
 
-                            assert(name !== undefined, "If you define a mock attribute it must have at least a name");
-
-                            id<KcContext.Register>(kcContext).profile.attributes.push(partialAttribute as any);
-                            id<KcContext.Register>(kcContext).profile.attributesByName[name] = partialAttribute as any;
+                            assert(
+                                name !== undefined,
+                                "If you define a mock attribute it must have at least a name"
+                            );
+
+                            id<KcContext.Register>(kcContext).profile.attributes.push(
+                                partialAttribute as any
+                            );
+                            id<KcContext.Register>(kcContext).profile.attributesByName[
+                                name
+                            ] = partialAttribute as any;
                         });
                 }
             }
 
             if (mockProperties !== undefined) {
                 deepAssign({
-                    "target": kcContext.properties,
-                    "source": mockProperties
+                    target: kcContext.properties,
+                    source: mockProperties
                 });
             }
 
@@ -145,14 +192,14 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
         }
 
         if (realKcContext === undefined) {
-            return { "kcContext": undefined as any };
+            return { kcContext: undefined as any };
         }
 
         if (realKcContext.themeType !== "login") {
-            return { "kcContext": undefined as any };
+            return { kcContext: undefined as any };
         }
 
-        return { "kcContext": realKcContext as any };
+        return { kcContext: realKcContext as any };
     }
 
     return { getKcContext };

package/src/login/kcContext/getKcContext.ts

@@ -5,7 +5,9 @@ import { createGetKcContext } from "./createGetKcContext";
 /** NOTE: We now recommend using createGetKcContext instead of this function to make storybook integration easier
  *  See: https://github.com/keycloakify/keycloakify-starter/blob/main/src/keycloak-theme/account/kcContext.ts
  */
-export function getKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
+export function getKcContext<
+    KcContextExtension extends { pageId: string } = never
+>(params?: {
     mockPageId?: ExtendKcContext<KcContextExtension>["pageId"];
     mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
 }): { kcContext: ExtendKcContext<KcContextExtension> | undefined } {

package/src/login/kcContext/getKcContextFromWindow.ts

@@ -2,10 +2,14 @@ import type { KcContext } from "./KcContext";
 import type { AndByDiscriminatingKey } from "keycloakify/tools/AndByDiscriminatingKey";
 import { nameOfTheGlobal } from "keycloakify/bin/shared/constants";
 
-export type ExtendKcContext<KcContextExtension extends { pageId: string }> = [KcContextExtension] extends [never]
+export type ExtendKcContext<KcContextExtension extends { pageId: string }> = [
+    KcContextExtension
+] extends [never]
     ? KcContext
     : AndByDiscriminatingKey<"pageId", KcContextExtension & KcContext.Common, KcContext>;
 
-export function getKcContextFromWindow<KcContextExtension extends { pageId: string } = never>(): ExtendKcContext<KcContextExtension> | undefined {
+export function getKcContextFromWindow<
+    KcContextExtension extends { pageId: string } = never
+>(): ExtendKcContext<KcContextExtension> | undefined {
     return typeof window === "undefined" ? undefined : (window as any)[nameOfTheGlobal];
 }