keycloakify 10.0.0-rc.12 → 10.0.0-rc.120

package/src/account/kcContext/kcContextMocks.ts

@@ -1,260 +0,0 @@
-import "minimal-polyfills/Object.fromEntries";
-import { resources_common, keycloak_resources } from "keycloakify/bin/shared/constants";
-import { id } from "tsafe/id";
-import type { KcContext } from "./KcContext";
-import { BASE_URL } from "keycloakify/lib/BASE_URL";
-
-const resourcesPath = `${BASE_URL}${keycloak_resources}/account/resources`;
-
-export const kcContextCommonMock: KcContext.Common = {
-    "themeVersion": "0.0.0",
-    "keycloakifyVersion": "0.0.0",
-    "themeType": "account",
-    "themeName": "my-theme-name",
-    "url": {
-        resourcesPath,
-        "resourcesCommonPath": `${resourcesPath}/${resources_common}`,
-        "resourceUrl": "#",
-        "accountUrl": "#",
-        "applicationsUrl": "#",
-        "logoutUrl": "#",
-        "getLogoutUrl": () => "#",
-        "logUrl": "#",
-        "passwordUrl": "#",
-        "sessionsUrl": "#",
-        "socialUrl": "#",
-        "totpUrl": "#"
-    },
-    "realm": {
-        "internationalizationEnabled": true,
-        "userManagedAccessAllowed": true
-    },
-    "messagesPerField": {
-        "printIfExists": () => {
-            return undefined;
-        },
-        "existsError": () => false,
-        "get": key => `Fake error for ${key}`,
-        "exists": () => false
-    },
-    "locale": {
-        "supported": [
-            /* spell-checker: disable */
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=de",
-                "label": "Deutsch",
-                "languageTag": "de"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=no",
-                "label": "Norsk",
-                "languageTag": "no"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=ru",
-                "label": "Русский",
-                "languageTag": "ru"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=sv",
-                "label": "Svenska",
-                "languageTag": "sv"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=pt-BR",
-                "label": "Português (Brasil)",
-                "languageTag": "pt-BR"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=lt",
-                "label": "Lietuvių",
-                "languageTag": "lt"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=en",
-                "label": "English",
-                "languageTag": "en"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=it",
-                "label": "Italiano",
-                "languageTag": "it"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=fr",
-                "label": "Français",
-                "languageTag": "fr"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=zh-CN",
-                "label": "中文简体",
-                "languageTag": "zh-CN"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=es",
-                "label": "Español",
-                "languageTag": "es"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=cs",
-                "label": "Čeština",
-                "languageTag": "cs"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=ja",
-                "label": "日本語",
-                "languageTag": "ja"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=sk",
-                "label": "Slovenčina",
-                "languageTag": "sk"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=pl",
-                "label": "Polski",
-                "languageTag": "pl"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=ca",
-                "label": "Català",
-                "languageTag": "ca"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=nl",
-                "label": "Nederlands",
-                "languageTag": "nl"
-            },
-            {
-                "url": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg&execution=ee6c2834-46a4-4a20-a1b6-f6d6f6451b36&kc_locale=tr",
-                "label": "Türkçe",
-                "languageTag": "tr"
-            }
-            /* spell-checker: enable */
-        ],
-        "currentLanguageTag": "en"
-    },
-    "features": {
-        "authorization": true,
-        "identityFederation": true,
-        "log": true,
-        "passwordUpdateSupported": true
-    },
-    "referrer": undefined,
-    "account": {
-        "firstName": "john",
-        "lastName": "doe",
-        "email": "john.doe@code.gouv.fr",
-        "username": "doe_j"
-    },
-    "properties": {
-        "parent": "account-v1",
-        "kcButtonLargeClass": "btn-lg",
-        "locales": "ar,ca,cs,da,de,en,es,fr,fi,hu,it,ja,lt,nl,no,pl,pt-BR,ru,sk,sv,tr,zh-CN",
-        "kcButtonPrimaryClass": "btn-primary",
-        "accountResourceProvider": "account-v1",
-        "styles":
-            "css/account.css img/icon-sidebar-active.png img/logo.png resources-common/node_modules/patternfly/dist/css/patternfly.min.css resources-common/node_modules/patternfly/dist/css/patternfly-additions.min.css resources-common/node_modules/patternfly/dist/css/patternfly-additions.min.css",
-        "kcButtonClass": "btn",
-        "kcButtonDefaultClass": "btn-default"
-    }
-};
-
-export const kcContextMocks: KcContext[] = [
-    id<KcContext.Password>({
-        ...kcContextCommonMock,
-        "pageId": "password.ftl",
-        "password": {
-            "passwordSet": true
-        },
-        "stateChecker": "state checker"
-    }),
-    id<KcContext.Account>({
-        ...kcContextCommonMock,
-        "pageId": "account.ftl",
-        "url": {
-            ...kcContextCommonMock.url,
-            "referrerURI": "#",
-            "accountUrl": "#"
-        },
-        "realm": {
-            ...kcContextCommonMock.realm,
-            "registrationEmailAsUsername": true,
-            "editUsernameAllowed": true
-        },
-        "stateChecker": ""
-    }),
-    id<KcContext.Sessions>({
-        ...kcContextCommonMock,
-        "pageId": "sessions.ftl",
-        "sessions": {
-            "sessions": [
-                {
-                    "ipAddress": "127.0.0.1",
-                    "started": new Date().toString(),
-                    "lastAccess": new Date().toString(),
-                    "expires": new Date().toString(),
-                    "clients": ["Chrome", "Firefox"],
-                    "id": "f8951177-817d-4a70-9c02-86d3c170fe51"
-                }
-            ]
-        },
-        "stateChecker": "g6WB1FaYnKotTkiy7ZrlxvFztSqS0U8jvHsOOOb2z4g"
-    }),
-    id<KcContext.Totp>({
-        ...kcContextCommonMock,
-        "pageId": "totp.ftl",
-        "totp": {
-            "enabled": true,
-            "totpSecretEncoded": "KVVF G2BY N4YX S6LB IUYT K2LH IFYE 4SBV",
-            "qrUrl": "#",
-            "totpSecretQrCode":
-                "iVBORw0KGgoAAAANSUhEUgAAAPYAAAD2AQAAAADNaUdlAAACM0lEQVR4Xu3OIZJgOQwDUDFd2UxiurLAVnnbHw4YGDKtSiWOn4Gxf81//7r/+q8b4HfLGBZDK9d85NmNR+sB42sXvOYrN5P1DcgYYFTGfOlbzE8gzwy3euweGizw7cfdl34/GRhlkxjKNV+5AebPXPORX1JuB9x8ZfbyyD2y1krWAKsbMq1HnqQDaLfa77p4+MqvzEGSqvSAD/2IHW2yHaigR9tX3m8dDIYGcNf3f+gDpVBZbZU77zyJ6Rlcy+qoTMG887KAPD9hsh6a1Sv3gJUHGHUAxSMzj7zqDDe7Phmt2eG+8UsMxjRGm816MAO+8VMl1R1jGHOrZB/5Zo/WXAPgxixm9Mo96vDGrM1eOto8c4Ax4wF437mifOXlpiPzCnN7Y9l95NnEMxgMY9AAGA8fucH14Y1aVb6N/cqrmyh0BVht7k1e+bU8LK0Cg5vmVq9c5vHIjOfqxDIfeTraNVTwewa4wVe+SW5N+uP1qACeudUZbqGOfA6VZV750Noq2Xx3kpveV44ZelSV1V7KFHzkWyVrrlUwG0Pl9pWnoy3vsQoME6vKI69i5osVgwWzHT7zjmJtMcNUSVn1oYMd7ZodbgowZl45VG0uVuLPUr1yc79uaQBag/mqR34xhlWyHm1prplHboCWdZ4TeZjsK8+dI+jbz1C5hl65mcpgB5dhcj8+dGO+0Ko68+lD37JDD83dpDLzzK+TrQyaVwGj6pUboGV+7+AyN8An/pf84/7rv/4/1l4OCc/1BYMAAAAASUVORK5CYII=",
-            "manualUrl": "#",
-            "totpSecret": "G4nsI8lQagRMUchH8jEG",
-            "otpCredentials": [],
-            "supportedApplications": ["totpAppFreeOTPName", "totpAppMicrosoftAuthenticatorName", "totpAppGoogleName"],
-            "policy": {
-                "algorithm": "HmacSHA1",
-                "digits": 6,
-                "lookAheadWindow": 1,
-                "type": "totp",
-                "period": 30
-            }
-        },
-        "mode": "qr",
-        "isAppInitiatedAction": false,
-        "stateChecker": ""
-    }),
-    id<KcContext.Log>({
-        ...kcContextCommonMock,
-        "pageId": "log.ftl",
-        "log": {
-            "events": [
-                {
-                    "date": "2/21/2024, 1:28:39 PM",
-                    "event": "login",
-                    "ipAddress": "172.17.0.1",
-                    "client": "security-admin-console",
-                    "details": [{ key: "openid-connect", value: "admin" }]
-                }
-            ]
-        }
-    }),
-    id<KcContext.FederatedIdentity>({
-        ...kcContextCommonMock,
-        "stateChecker": "",
-        "pageId": "federatedIdentity.ftl",
-        "federatedIdentity": {
-            "identities": [
-                {
-                    "providerId": "keycloak-oidc",
-                    "displayName": "keycloak-oidc",
-                    "userName": "John",
-                    "connected": true
-                }
-            ],
-            "removeLinkPossible": true
-        }
-    })
-];

package/src/account/lib/useGetClassName.ts

@@ -1,20 +0,0 @@
-import { createUseClassName } from "keycloakify/lib/useGetClassName";
-import type { ClassKey } from "keycloakify/account/TemplateProps";
-
-export const { useGetClassName } = createUseClassName<ClassKey>({
-    "defaultClasses": {
-        "kcHtmlClass": undefined,
-        "kcBodyClass": undefined,
-        "kcButtonClass": "btn",
-        "kcContentWrapperClass": "row",
-        "kcButtonPrimaryClass": "btn-primary",
-        "kcButtonLargeClass": "btn-lg",
-        "kcButtonDefaultClass": "btn-default",
-        "kcFormClass": "form-horizontal",
-        "kcFormGroupClass": "form-group",
-        "kcInputWrapperClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
-        "kcLabelClass": "control-label",
-        "kcInputClass": "form-control",
-        "kcInputErrorMessageClass": "pf-c-form__helper-text pf-m-error required kc-feedback-text"
-    }
-});

package/src/bin/download-builtin-keycloak-theme.ts

@@ -1,30 +0,0 @@
-import { join as pathJoin } from "path";
-import { promptKeycloakVersion } from "./shared/promptKeycloakVersion";
-import { readBuildOptions } from "./shared/buildOptions";
-import { downloadBuiltinKeycloakTheme } from "./shared/downloadBuiltinKeycloakTheme";
-import type { CliCommandOptions } from "./main";
-
-export async function command(params: { cliCommandOptions: CliCommandOptions }) {
-    const { cliCommandOptions } = params;
-
-    const buildOptions = readBuildOptions({
-        cliCommandOptions
-    });
-
-    console.log("Select the Keycloak version from which you want to download the builtins theme:");
-
-    const { keycloakVersion } = await promptKeycloakVersion({
-        "startingFromMajor": undefined,
-        "cacheDirPath": buildOptions.cacheDirPath
-    });
-
-    const destDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources", "theme");
-
-    console.log(`Downloading builtins theme of Keycloak ${keycloakVersion} here ${destDirPath}`);
-
-    await downloadBuiltinKeycloakTheme({
-        keycloakVersion,
-        destDirPath,
-        buildOptions
-    });
-}

package/src/bin/eject-keycloak-page.ts

@@ -1,126 +0,0 @@
-#!/usr/bin/env node
-
-import { getThisCodebaseRootDirPath } from "./tools/getThisCodebaseRootDirPath";
-import cliSelect from "cli-select";
-import {
-    loginThemePageIds,
-    accountThemePageIds,
-    type LoginThemePageId,
-    type AccountThemePageId,
-    themeTypes,
-    type ThemeType
-} from "./shared/constants";
-import { capitalize } from "tsafe/capitalize";
-import * as fs from "fs";
-import { join as pathJoin, relative as pathRelative, dirname as pathDirname } from "path";
-import { kebabCaseToCamelCase } from "./tools/kebabCaseToSnakeCase";
-import { assert, Equals } from "tsafe/assert";
-import { getThemeSrcDirPath } from "./shared/getThemeSrcDirPath";
-import type { CliCommandOptions } from "./main";
-import { readBuildOptions } from "./shared/buildOptions";
-
-export async function command(params: { cliCommandOptions: CliCommandOptions }) {
-    const { cliCommandOptions } = params;
-
-    const buildOptions = readBuildOptions({
-        cliCommandOptions
-    });
-
-    console.log("Theme type:");
-
-    const { value: themeType } = await cliSelect<ThemeType>({
-        "values": [...themeTypes]
-    }).catch(() => {
-        console.log("Aborting");
-
-        process.exit(-1);
-    });
-
-    console.log("Select the page you want to customize:");
-
-    const { value: pageId } = await cliSelect<LoginThemePageId | AccountThemePageId>({
-        "values": (() => {
-            switch (themeType) {
-                case "login":
-                    return [...loginThemePageIds];
-                case "account":
-                    return [...accountThemePageIds];
-            }
-            assert<Equals<typeof themeType, never>>(false);
-        })()
-    }).catch(() => {
-        console.log("Aborting");
-
-        process.exit(-1);
-    });
-
-    const componentPageBasename = capitalize(kebabCaseToCamelCase(pageId)).replace(/ftl$/, "tsx");
-
-    const { themeSrcDirPath } = getThemeSrcDirPath({ "reactAppRootDirPath": buildOptions.reactAppRootDirPath });
-
-    const targetFilePath = pathJoin(themeSrcDirPath, themeType, "pages", componentPageBasename);
-
-    if (fs.existsSync(targetFilePath)) {
-        console.log(`${pageId} is already ejected, ${pathRelative(process.cwd(), targetFilePath)} already exists`);
-
-        process.exit(-1);
-    }
-
-    {
-        const targetDirPath = pathDirname(targetFilePath);
-
-        if (!fs.existsSync(targetDirPath)) {
-            fs.mkdirSync(targetDirPath, { "recursive": true });
-        }
-    }
-
-    const componentPageContent = fs
-        .readFileSync(pathJoin(getThisCodebaseRootDirPath(), "src", themeType, "pages", componentPageBasename))
-        .toString("utf8");
-
-    fs.writeFileSync(targetFilePath, Buffer.from(componentPageContent, "utf8"));
-
-    const userProfileFormFieldComponentName = "UserProfileFormFields";
-
-    console.log(
-        [
-            ``,
-            `\`${pathJoin(".", pathRelative(process.cwd(), targetFilePath))}\` copy pasted from the Keycloakify source code into your project.`,
-            ``,
-            `You now need to update your page router:`,
-            ``,
-            `\`${pathJoin(".", pathRelative(process.cwd(), themeSrcDirPath), themeType, "KcApp.tsx")}\`:`,
-            "```",
-            `// ...`,
-            ``,
-            `+const ${componentPageBasename.replace(/.tsx$/, "")} = lazy(() => import("./pages/${componentPageBasename}"));`,
-            ``,
-            ` export default function KcApp(props: { kcContext: KcContext; }) {`,
-            ``,
-            `     // ...`,
-            ``,
-            `     return (`,
-            `         <Suspense>`,
-            `             {(() => {`,
-            `                 switch (kcContext.pageId) {`,
-            `                     // ...`,
-            `                     case "${pageId}": return (`,
-            `+                        <Login`,
-            `+                            {...{ kcContext, i18n, classes }}`,
-            `+                            Template={Template}`,
-            ...(!componentPageContent.includes(userProfileFormFieldComponentName)
-                ? []
-                : [`+                            ${userProfileFormFieldComponentName}={${userProfileFormFieldComponentName}}`]),
-            `+                            doUseDefaultCss={true}`,
-            `+                        />`,
-            `+                    );`,
-            `                     default: return <Fallback /* .. */ />;`,
-            `                 }`,
-            `             })()}`,
-            `         </Suspense>`,
-            `     );`,
-            ` }`,
-            "```"
-        ].join("\n")
-    );
-}