keycloakify 9.6.7 → 10.0.0-rc.0

package/src/login/kcContext/KcContext.ts

@@ -13,7 +13,6 @@ type ExtractAfterStartingWith<Prefix extends string, StrEnum> = StrEnum extends
 export type KcContext =
     | KcContext.Login
     | KcContext.Register
-    | KcContext.RegisterUserProfile
     | KcContext.Info
     | KcContext.Error
     | KcContext.LoginResetPassword
@@ -24,6 +23,7 @@ export type KcContext =
     | KcContext.LoginOtp
     | KcContext.LoginUsername
     | KcContext.WebauthnAuthenticate
+    | KcContext.WebauthnRegister
     | KcContext.LoginPassword
     | KcContext.LoginUpdatePassword
     | KcContext.LoginUpdateProfile
@@ -32,11 +32,21 @@ export type KcContext =
     | KcContext.LoginPageExpired
     | KcContext.LoginConfigTotp
     | KcContext.LogoutConfirm
-    | KcContext.UpdateUserProfile
     | KcContext.IdpReviewUserProfile
     | KcContext.UpdateEmail
     | KcContext.SelectAuthenticator
-    | KcContext.SamlPostForm;
+    | KcContext.SamlPostForm
+    | KcContext.DeleteCredential
+    | KcContext.Code
+    | KcContext.DeleteAccountConfirm
+    | KcContext.FrontchannelLogout
+    | KcContext.LoginRecoveryAuthnCodeConfig
+    | KcContext.LoginRecoveryAuthnCodeInput
+    | KcContext.LoginResetOtp
+    | KcContext.LoginX509Info
+    | KcContext.WebauthnError;
+
+assert<KcContext["themeType"] extends ThemeType ? true : false>();
 
 export declare namespace KcContext {
     export type Common = {
@@ -50,6 +60,7 @@ export declare namespace KcContext {
             resourcesCommonPath: string;
             loginRestartFlowUrl: string;
             loginUrl: string;
+            ssoLoginInOtherTabsUrl: string;
         };
         realm: {
             name: string;
@@ -100,7 +111,7 @@ export declare namespace KcContext {
              * @param fields
              * @return boolean
              */
-            existsError: (fieldName: string) => boolean;
+            existsError: (fieldName: string, ...otherFiledNames: string[]) => boolean;
             /**
              * Get message for given field.
              *
@@ -115,8 +126,15 @@ export declare namespace KcContext {
              * @return boolean
              */
             exists: (fieldName: string) => boolean;
+
+            getFirstError: (...fieldNames: string[]) => string;
         };
         properties: Record<string, string | undefined>;
+        authenticationSession?: {
+            authSessionId: string;
+            tabId: string;
+            ssoLoginInOtherTabsUrl: string;
+        };
     };
 
     export type SamlPostForm = Common & {
@@ -148,7 +166,7 @@ export declare namespace KcContext {
         registrationDisabled: boolean;
         login: {
             username?: string;
-            rememberMe?: string;
+            rememberMe?: string; // "on" | undefined
             password?: string;
         };
         usernameHidden?: boolean;
@@ -159,52 +177,28 @@ export declare namespace KcContext {
                 alias: string;
                 providerId: string;
                 displayName: string;
+                iconClasses?: string;
             }[];
         };
     };
 
-    export type Register = RegisterUserProfile.CommonWithLegacy & {
+    export type Register = Common & {
         pageId: "register.ftl";
-        register: {
-            formData: {
-                firstName?: string;
-                displayName?: string;
-                lastName?: string;
-                email?: string;
-                username?: string;
-            };
-        };
-    };
-
-    export type RegisterUserProfile = RegisterUserProfile.CommonWithLegacy & {
-        pageId: "register-user-profile.ftl";
-        profile: {
-            context: "REGISTRATION_PROFILE";
-            attributes: Attribute[];
-            attributesByName: Record<string, Attribute>;
+        profile: UserProfile;
+        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;
     };
 
-    export namespace RegisterUserProfile {
-        export type CommonWithLegacy = Common & {
-            url: {
-                registrationAction: string;
-            };
-            passwordRequired: boolean;
-            recaptchaRequired: boolean;
-            recaptchaSiteKey?: string;
-            social: {
-                displayInfo: boolean;
-                providers?: {
-                    loginUrl: string;
-                    alias: string;
-                    providerId: string;
-                    displayName: string;
-                }[];
-            };
-        };
-    }
-
     export type Info = Common & {
         pageId: "info.ftl";
         messageHeader?: string;
@@ -223,16 +217,21 @@ export declare namespace KcContext {
             baseUrl?: string;
         };
         message: NonNullable<Common["message"]>;
+        skipLink?: boolean;
     };
 
     export type LoginResetPassword = Common & {
         pageId: "login-reset-password.ftl";
         realm: {
             loginWithEmailAllowed: boolean;
+            duplicateEmailsAllowed: boolean;
         };
         url: {
             loginResetCredentialsUrl: string;
         };
+        auth: {
+            attemptedUsername?: string;
+        };
     };
 
     export type LoginVerifyEmail = Common & {
@@ -272,6 +271,7 @@ export declare namespace KcContext {
             client: string;
             clientScopesRequested: {
                 consentScreenText: string;
+                dynamicScopeParameter?: string;
             }[];
         };
         url: {
@@ -282,7 +282,11 @@ export declare namespace KcContext {
     export type LoginOtp = Common & {
         pageId: "login-otp.ftl";
         otpLogin: {
-            userOtpCredentials: { id: string; userLabel: string }[];
+            userOtpCredentials: {
+                id: string;
+                userLabel: string;
+            }[];
+            selectedCredentialId?: string;
         };
     };
 
@@ -305,15 +309,7 @@ export declare namespace KcContext {
             rememberMe?: string;
         };
         usernameHidden?: boolean;
-        social: {
-            displayInfo: boolean;
-            providers?: {
-                loginUrl: string;
-                alias: string;
-                providerId: string;
-                displayName: string;
-            }[];
-        };
+        social: Login["social"];
     };
 
     export type LoginPassword = Common & {
@@ -334,9 +330,6 @@ export declare namespace KcContext {
         social: {
             displayInfo: boolean;
         };
-        login: {
-            password?: string;
-        };
     };
 
     export type WebauthnAuthenticate = Common & {
@@ -355,6 +348,14 @@ export declare namespace KcContext {
             displayInfo: boolean;
         };
         login: {};
+        realm: {
+            password: boolean;
+            registrationAllowed: boolean;
+        };
+        registrationDisabled?: boolean;
+        url: {
+            registrationUrl?: string;
+        };
     };
 
     export namespace WebauthnAuthenticate {
@@ -362,27 +363,33 @@ export declare namespace KcContext {
             credentialId: string;
             transports: {
                 iconClass: string;
-                displayNameProperties: MessageKey[];
+                displayNameProperties?: MessageKey[];
             };
             label: string;
             createdAt: string;
         };
     }
 
-    export type LoginUpdatePassword = Common & {
-        pageId: "login-update-password.ftl";
+    export type WebauthnRegister = Common & {
+        pageId: "webauthn-register.ftl";
+        challenge: string;
+        userid: string;
         username: string;
+        signatureAlgorithms: string[];
+        rpEntityName: string;
+        rpId: string;
+        attestationConveyancePreference: string;
+        authenticatorAttachment: string;
+        requireResidentKey: string;
+        userVerificationRequirement: string;
+        createTimeout: number;
+        excludeCredentialIds: string;
+        isSetRetry?: boolean;
+        isAppInitiatedAction?: boolean;
     };
 
-    export type LoginUpdateProfile = Common & {
-        pageId: "login-update-profile.ftl";
-        user: {
-            editUsernameAllowed: boolean;
-            username?: string;
-            email?: string;
-            firstName?: string;
-            lastName?: string;
-        };
+    export type LoginUpdatePassword = Common & {
+        pageId: "login-update-password.ftl";
     };
 
     export type LoginIdpLinkConfirm = Common & {
@@ -444,28 +451,19 @@ export declare namespace KcContext {
         };
     };
 
-    export type UpdateUserProfile = Common & {
-        pageId: "update-user-profile.ftl";
-        profile: {
-            attributes: Attribute[];
-            attributesByName: Record<string, Attribute>;
-        };
+    export type LoginUpdateProfile = Common & {
+        pageId: "login-update-profile.ftl";
+        profile: UserProfile;
     };
 
     export type IdpReviewUserProfile = Common & {
         pageId: "idp-review-user-profile.ftl";
-        profile: {
-            context: "IDP_REVIEW";
-            attributes: Attribute[];
-            attributesByName: Record<string, Attribute>;
-        };
+        profile: UserProfile;
     };
 
     export type UpdateEmail = Common & {
         pageId: "update-email.ftl";
-        email: {
-            value?: string;
-        };
+        profile: UserProfile;
     };
 
     export type SelectAuthenticator = Common & {
@@ -500,20 +498,124 @@ export declare namespace KcContext {
                 | "kcAuthenticatorWebAuthnPasswordlessClass";
         };
     }
+
+    export type DeleteCredential = Common & {
+        pageId: "delete-credential.ftl";
+        credentialLabel: string;
+    };
+
+    export type Code = Common & {
+        pageId: "code.ftl";
+        code: {
+            success: boolean;
+            code?: string;
+            error?: string;
+        };
+    };
+
+    export type DeleteAccountConfirm = Common & {
+        pageId: "delete-account-confirm.ftl";
+        triggered_from_aia: boolean;
+    };
+
+    export type FrontchannelLogout = Common & {
+        pageId: "frontchannel-logout.ftl";
+        logout: {
+            clients: {
+                name: string;
+                frontChannelLogoutUrl: string;
+            }[];
+            logoutRedirectUri?: string;
+        };
+    };
+
+    export type LoginRecoveryAuthnCodeConfig = Common & {
+        pageId: "login-recovery-authn-code-config.ftl";
+        recoveryAuthnCodesConfigBean: {
+            generatedRecoveryAuthnCodesList: string[];
+            generatedRecoveryAuthnCodesAsString: string;
+            generatedAt: number;
+        };
+    };
+
+    export type LoginRecoveryAuthnCodeInput = Common & {
+        pageId: "login-recovery-authn-code-input.ftl";
+        recoveryAuthnCodesInputBean: {
+            codeNumber: number;
+        };
+    };
+
+    export type LoginResetOtp = Common & {
+        pageId: "login-reset-otp.ftl";
+        configuredOtpCredentials: {
+            userOtpCredentials: {
+                id: string;
+                userLabel: string;
+            }[];
+            selectedCredentialId: string;
+        };
+    };
+
+    export type LoginX509Info = Common & {
+        pageId: "login-x509-info.ftl";
+        x509: {
+            formData: {
+                subjectDN?: string;
+                isUserEnabled?: boolean;
+                username?: string;
+            };
+        };
+    };
+
+    export type WebauthnError = Common & {
+        pageId: "webauthn-error.ftl";
+        isAppInitiatedAction?: boolean;
+    };
 }
 
+export type UserProfile = {
+    attributes: Attribute[];
+    attributesByName: Record<string, Attribute>;
+    html5DataAnnotations?: Record<string, string>;
+};
+
 export type Attribute = {
     name: string;
     displayName?: string;
     required: boolean;
     value?: string;
-    group?: string;
-    groupDisplayHeader?: string;
-    groupDisplayDescription?: string;
+    values?: string[];
+    group?: {
+        html5DataAnnotations: Record<string, string>;
+        displayHeader?: string;
+        name: string;
+        displayDescription?: string;
+    };
+    html5DataAnnotations?: {
+        kcNumberFormat?: string;
+        kcNumberUnFormat?: string;
+    };
     readOnly: boolean;
     validators: Validators;
-    annotations: Record<string, string>;
-    groupAnnotations: Record<string, string>;
+    annotations: {
+        inputType?: string;
+        inputTypeSize?: `${number}` | number;
+        inputOptionsFromValidation?: string;
+        inputOptionLabels?: Record<string, string | undefined>;
+        inputOptionLabelsI18nPrefix?: string;
+        inputTypeCols?: `${number}` | number;
+        inputTypeRows?: `${number}` | number;
+        inputTypeMaxlength?: `${number}` | number;
+        inputHelperTextBefore?: string;
+        inputHelperTextAfter?: string;
+        inputTypePlaceholder?: string;
+        inputTypePattern?: string;
+        inputTypeMinlength?: `${number}` | number;
+        inputTypeMax?: string;
+        inputTypeMin?: string;
+        inputTypeStep?: string;
+    };
+    multivalued?: boolean;
     autocomplete?:
         | "on"
         | "off"
@@ -573,31 +675,28 @@ export type Attribute = {
 
 export type Validators = Partial<{
     length: Validators.DoIgnoreEmpty & Validators.Range;
-    double: Validators.DoIgnoreEmpty & Validators.Range;
     integer: Validators.DoIgnoreEmpty & Validators.Range;
     email: Validators.DoIgnoreEmpty;
+    pattern: Validators.DoIgnoreEmpty & Validators.ErrorMessage & { pattern: string };
+    options: Validators.Options;
+    multivalued: Validators.DoIgnoreEmpty & Validators.Range;
+    // NOTE: Following are the validators for which we don't implement client side validation yet
+    // or for which the validation can't be performed on the client side.
+    /*
+    double: Validators.DoIgnoreEmpty & Validators.Range;
     "up-immutable-attribute": {};
     "up-attribute-required-by-metadata-value": {};
     "up-username-has-value": {};
     "up-duplicate-username": {};
     "up-username-mutation": {};
     "up-email-exists-as-username": {};
-    "up-blank-attribute-value": Validators.ErrorMessage & {
-        "fail-on-null": boolean;
-    };
+    "up-blank-attribute-value": Validators.ErrorMessage & { "fail-on-null": boolean; };
     "up-duplicate-email": {};
     "local-date": Validators.DoIgnoreEmpty;
-    pattern: Validators.DoIgnoreEmpty & Validators.ErrorMessage & { pattern: string };
     "person-name-prohibited-characters": Validators.DoIgnoreEmpty & Validators.ErrorMessage;
     uri: Validators.DoIgnoreEmpty;
     "username-prohibited-characters": Validators.DoIgnoreEmpty & Validators.ErrorMessage;
-    /** Made up validator that only exists in Keycloakify */
-    _compareToOther: Validators.DoIgnoreEmpty &
-        Validators.ErrorMessage & {
-            name: string;
-            shouldBe: "equal" | "different";
-        };
-    options: Validators.Options;
+    */
 }>;
 
 export declare namespace Validators {
@@ -610,9 +709,8 @@ export declare namespace Validators {
     };
 
     export type Range = {
-        /** "0", "1", "2"... yeah I know, don't tell me */
-        min?: `${number}`;
-        max?: `${number}`;
+        min?: `${number}` | number;
+        max?: `${number}` | number;
     };
     export type Options = {
         options: string[];
@@ -630,4 +728,19 @@ export declare namespace Validators {
     assert<Equals<OnlyInExpected, never>>();
 }
 
-assert<KcContext["themeType"] extends ThemeType ? true : false>();
+export type PasswordPolicies = {
+    /** The minimum length of the password */
+    length?: number;
+    /** The minimum number of digits required in the password */
+    digits?: number;
+    /** The minimum number of lowercase characters required in the password */
+    lowerCase?: number;
+    /** The minimum number of uppercase characters required in the password */
+    upperCase?: number;
+    /** The minimum number of special characters required in the password */
+    specialChars?: number;
+    /** Whether the password can be the username */
+    notUsername?: boolean;
+    /** Whether the password can be the email address */
+    notEmail?: boolean;
+};

package/src/login/kcContext/createGetKcContext.ts

@@ -86,25 +86,17 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
                     "source": partialKcContextCustomMock
                 });
 
-                if (
-                    partialKcContextCustomMock.pageId === "register-user-profile.ftl" ||
-                    partialKcContextCustomMock.pageId === "update-user-profile.ftl" ||
-                    partialKcContextCustomMock.pageId === "idp-review-user-profile.ftl"
-                ) {
-                    assert(
-                        kcContextDefaultMock?.pageId === "register-user-profile.ftl" ||
-                            kcContextDefaultMock?.pageId === "update-user-profile.ftl" ||
-                            kcContextDefaultMock?.pageId === "idp-review-user-profile.ftl"
-                    );
+                if ("profile" in partialKcContextCustomMock) {
+                    assert(kcContextDefaultMock !== undefined && "profile" in kcContextDefaultMock);
 
                     const { attributes } = kcContextDefaultMock.profile;
 
-                    id<KcContext.RegisterUserProfile>(kcContext).profile.attributes = [];
-                    id<KcContext.RegisterUserProfile>(kcContext).profile.attributesByName = {};
+                    id<KcContext.Register>(kcContext).profile.attributes = [];
+                    id<KcContext.Register>(kcContext).profile.attributesByName = {};
 
-                    const partialAttributes = [
-                        ...((partialKcContextCustomMock as DeepPartial<KcContext.RegisterUserProfile>).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);
@@ -125,8 +117,8 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
                             });
                         }
 
-                        id<KcContext.RegisterUserProfile>(kcContext).profile.attributes.push(augmentedAttribute);
-                        id<KcContext.RegisterUserProfile>(kcContext).profile.attributesByName[augmentedAttribute.name] = augmentedAttribute;
+                        id<KcContext.Register>(kcContext).profile.attributes.push(augmentedAttribute);
+                        id<KcContext.Register>(kcContext).profile.attributesByName[augmentedAttribute.name] = augmentedAttribute;
                     });
 
                     partialAttributes
@@ -136,8 +128,8 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
 
                             assert(name !== undefined, "If you define a mock attribute it must have at least a name");
 
-                            id<KcContext.RegisterUserProfile>(kcContext).profile.attributes.push(partialAttribute as any);
-                            id<KcContext.RegisterUserProfile>(kcContext).profile.attributesByName[name] = partialAttribute as any;
+                            id<KcContext.Register>(kcContext).profile.attributes.push(partialAttribute as any);
+                            id<KcContext.Register>(kcContext).profile.attributesByName[name] = partialAttribute as any;
                         });
                 }
             }