88 lines
2.9 KiB
TypeScript
88 lines
2.9 KiB
TypeScript
|
import { getKcContext } from "keycloakify/lib/kcContext";
|
||
|
|
|
||
|
|
//NOTE: In most of the cases you do not need to overload the KcContext, you can
|
||
|
|
// just call getKcContext(...) without type arguments.
|
||
|
|
// You want to overload the KcContext only if:
|
||
|
|
// - You have custom plugins that add some values to the context (like https://github.com/micedre/keycloak-mail-whitelisting that adds authorizedMailDomains)
|
||
|
|
// - You want to add support for extra pages that are not yey featured by default, see: https://docs.keycloakify.dev/contributing#adding-support-for-a-new-page
|
||
|
|
export const { kcContext } = getKcContext<
|
||
|
|
// NOTE: A 'keycloakify' field must be added
|
||
|
|
// in the package.json to generate theses extra 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.
|
||
|
|
//"mockPageId": "login.ftl",
|
||
|
|
mockData: [
|
||
|
|
{
|
||
|
|
pageId: "login.ftl",
|
||
|
|
locale: {
|
||
|
|
//When we test the login page we do it in french
|
||
|
|
currentLanguageTag: "fr",
|
||
|
|
},
|
||
|
|
//Uncomment the following line for hiding the Alert message
|
||
|
|
//"message": undefined
|
||
|
|
//Uncomment the following line for showing an Error message
|
||
|
|
//message: { type: "error", summary: "This is an error" }
|
||
|
|
},
|
||
|
|
{
|
||
|
|
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>;
|