wip

src/KcApp/kcContext.ts

@@ -1,16 +1,81 @@
 import { getKcContext } from "keycloakify/lib/getKcContext";
 
-export const { kcContext } = getKcContext({
-    /* Uncomment to test th<e login page for development */
+export const { kcContext } = getKcContext<
+    // NOTE: A 'keycloakify' field must be added 
+    // in the package.json to generate theses pages
+    // https://docs.keycloakify.dev/build-options#keycloakify.extrapages
+    | { pageId: "my-extra-page-1.ftl"; } 
+    | { pageId: "my-extra-page-2.ftl"; someCustomValue: string; }
+    // NOTE: register.ftl is deprecated in favor of register-user-profile.ftl
+    // but let's say we use it anyway and have this plugin enabled: https://github.com/micedre/keycloak-mail-whitelisting
+    // keycloak-mail-whitelisting define the non standard ftl global authorizedMailDomains, we declare it here.
+    | { pageId: "register.ftl"; authorizedMailDomains: string[]; }
+>({
+    // Uncomment to test the login page for development.
+    // Try with another page like "register-user-profile.ftl"
+    // DON'T forget to re-comment before publishing to production.
     //"mockPageId": "login.ftl",
     "mockData": [
         {
             "pageId": "login.ftl",
             "locale": {
-                "currentLanguageTag": "fr", //When we test the login page we do it in french
+                //When we test the login page we do it in french
+                "currentLanguageTag": "fr", 
             },
         },
-    ],
+        {
+			"pageId": "my-extra-page-2.ftl",
+			"someCustomValue": "foo bar baz"
+		},
+		{
+			"pageId": "register.ftl",
+			"authorizedMailDomains": [
+				"example.com",
+				"another-example.com",
+				"*.yet-another-example.com",
+				"*.example.com",
+				"hello-world.com"
+			]
+		},
+		{
+			//NOTE: You will either use register.ftl (legacy) or register-user-profile.ftl, not both
+			"pageId": "register-user-profile.ftl",
+			"locale": {
+				"currentLanguageTag": "fr"
+			},
+			"profile": {
+				"attributes": [
+					{
+						"validators": {
+							"pattern": {
+								"pattern": "^[a-zA-Z0-9]+$",
+								"ignore.empty.value": true,
+								// eslint-disable-next-line no-template-curly-in-string
+								"error-message": "${alphanumericalCharsOnly}",
+							},
+						},
+						//NOTE: To override the default mock value
+						"value": undefined,
+						"name": "username"
+					},
+					{
+						"validators": {
+							"options": {
+								"options": ["male", "female", "non-binary", "transgender", "intersex", "non_communicated"]
+							}
+						},
+						// eslint-disable-next-line no-template-curly-in-string
+						"displayName": "${gender}",
+						"annotations": {},
+						"required": true,
+						"groupAnnotations": {},
+						"readOnly": false,
+						"name": "gender"
+					}
+				]
+			}
+		}
+    ]
 });
 
-export type KcContext = NonNullable<typeof kcContext>;
+export type KcContext = NonNullable<typeof kcContext>;