keycloakify 10.0.0-rc.7 → 10.0.0-rc.70

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")
-    );
-}

package/src/bin/keycloakify/generateSrcMainResources/bringInAccountV1.ts

@@ -1,79 +0,0 @@
-import * as fs from "fs";
-import { join as pathJoin } from "path";
-import { assert } from "tsafe/assert";
-import type { BuildOptions } from "../../shared/buildOptions";
-import { resources_common, lastKeycloakVersionWithAccountV1, accountV1ThemeName } from "../../shared/constants";
-import { downloadBuiltinKeycloakTheme } from "../../shared/downloadBuiltinKeycloakTheme";
-import { transformCodebase } from "../../tools/transformCodebase";
-import { rmSync } from "../../tools/fs.rmSync";
-
-type BuildOptionsLike = {
-    cacheDirPath: string;
-    npmWorkspaceRootDirPath: string;
-    keycloakifyBuildDirPath: string;
-};
-
-assert<BuildOptions extends BuildOptionsLike ? true : false>();
-
-export async function bringInAccountV1(params: { buildOptions: BuildOptionsLike }) {
-    const { buildOptions } = params;
-
-    const builtinKeycloakThemeTmpDirPath = pathJoin(buildOptions.cacheDirPath, "bringInAccountV1_tmp");
-
-    await downloadBuiltinKeycloakTheme({
-        "destDirPath": builtinKeycloakThemeTmpDirPath,
-        "keycloakVersion": lastKeycloakVersionWithAccountV1,
-        buildOptions
-    });
-
-    const accountV1DirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources", "theme", accountV1ThemeName, "account");
-
-    transformCodebase({
-        "srcDirPath": pathJoin(builtinKeycloakThemeTmpDirPath, "base", "account"),
-        "destDirPath": accountV1DirPath
-    });
-
-    transformCodebase({
-        "srcDirPath": pathJoin(builtinKeycloakThemeTmpDirPath, "keycloak", "account", "resources"),
-        "destDirPath": pathJoin(accountV1DirPath, "resources")
-    });
-
-    transformCodebase({
-        "srcDirPath": pathJoin(builtinKeycloakThemeTmpDirPath, "keycloak", "common", "resources"),
-        "destDirPath": pathJoin(accountV1DirPath, "resources", resources_common)
-    });
-
-    rmSync(builtinKeycloakThemeTmpDirPath, { "recursive": true });
-
-    fs.writeFileSync(
-        pathJoin(accountV1DirPath, "theme.properties"),
-        Buffer.from(
-            [
-                "accountResourceProvider=account-v1",
-                "",
-                "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",
-                "",
-                "styles=" +
-                    [
-                        "css/account.css",
-                        "img/icon-sidebar-active.png",
-                        "img/logo.png",
-                        ...["patternfly.min.css", "patternfly-additions.min.css", "patternfly-additions.min.css"].map(
-                            fileBasename => `${resources_common}/node_modules/patternfly/dist/css/${fileBasename}`
-                        )
-                    ].join(" "),
-                "",
-                "##### css classes for form buttons",
-                "# main class used for all buttons",
-                "kcButtonClass=btn",
-                "# classes defining priority of the button - primary or default (there is typically only one priority button for the form)",
-                "kcButtonPrimaryClass=btn-primary",
-                "kcButtonDefaultClass=btn-default",
-                "# classes defining size of the button",
-                "kcButtonLargeClass=btn-lg",
-                ""
-            ].join("\n"),
-            "utf8"
-        )
-    );
-}

package/src/bin/keycloakify/generateSrcMainResources/generateSrcMainResources.ts

@@ -1,32 +0,0 @@
-import type { BuildOptions } from "../../shared/buildOptions";
-import { assert } from "tsafe/assert";
-import {
-    generateSrcMainResourcesForMainTheme,
-    type BuildOptionsLike as BuildOptionsLike_generateSrcMainResourcesForMainTheme
-} from "./generateSrcMainResourcesForMainTheme";
-import { generateSrcMainResourcesForThemeVariant } from "./generateSrcMainResourcesForThemeVariant";
-
-export type BuildOptionsLike = BuildOptionsLike_generateSrcMainResourcesForMainTheme & {
-    themeNames: string[];
-};
-
-assert<BuildOptions extends BuildOptionsLike ? true : false>();
-
-export async function generateSrcMainResources(params: { buildOptions: BuildOptionsLike }): Promise<void> {
-    const { buildOptions } = params;
-
-    const [themeName, ...themeVariantNames] = buildOptions.themeNames;
-
-    await generateSrcMainResourcesForMainTheme({
-        themeName,
-        buildOptions
-    });
-
-    for (const themeVariantName of themeVariantNames) {
-        generateSrcMainResourcesForThemeVariant({
-            themeName,
-            themeVariantName,
-            buildOptions
-        });
-    }
-}

package/src/bin/keycloakify/generateSrcMainResources/generateSrcMainResourcesForMainTheme.ts

@@ -1,261 +0,0 @@
-import { transformCodebase } from "../../tools/transformCodebase";
-import * as fs from "fs";
-import { join as pathJoin, resolve as pathResolve } from "path";
-import { replaceImportsInJsCode } from "../replacers/replaceImportsInJsCode";
-import { replaceImportsInCssCode } from "../replacers/replaceImportsInCssCode";
-import { generateFtlFilesCodeFactory } from "../generateFtl";
-import {
-    type ThemeType,
-    lastKeycloakVersionWithAccountV1,
-    keycloak_resources,
-    accountV1ThemeName,
-    basenameOfTheKeycloakifyResourcesDir,
-    loginThemePageIds,
-    accountThemePageIds
-} from "../../shared/constants";
-import { isInside } from "../../tools/isInside";
-import type { BuildOptions } from "../../shared/buildOptions";
-import { assert, type Equals } from "tsafe/assert";
-import { downloadKeycloakStaticResources } from "../../shared/downloadKeycloakStaticResources";
-import { readFieldNameUsage } from "./readFieldNameUsage";
-import { readExtraPagesNames } from "./readExtraPageNames";
-import { generateMessageProperties } from "./generateMessageProperties";
-import { bringInAccountV1 } from "./bringInAccountV1";
-import { getThemeSrcDirPath } from "../../shared/getThemeSrcDirPath";
-import { rmSync } from "../../tools/fs.rmSync";
-import { readThisNpmPackageVersion } from "../../tools/readThisNpmPackageVersion";
-import { writeMetaInfKeycloakThemes, type MetaInfKeycloakTheme } from "../../shared/metaInfKeycloakThemes";
-import { objectEntries } from "tsafe/objectEntries";
-
-export type BuildOptionsLike = {
-    bundler: "vite" | "webpack";
-    extraThemeProperties: string[] | undefined;
-    themeVersion: string;
-    loginThemeResourcesFromKeycloakVersion: string;
-    reactAppBuildDirPath: string;
-    cacheDirPath: string;
-    assetsDirPath: string;
-    urlPathname: string | undefined;
-    npmWorkspaceRootDirPath: string;
-    reactAppRootDirPath: string;
-    keycloakifyBuildDirPath: string;
-};
-
-assert<BuildOptions extends BuildOptionsLike ? true : false>();
-
-export async function generateSrcMainResourcesForMainTheme(params: { themeName: string; buildOptions: BuildOptionsLike }): Promise<void> {
-    const { themeName, buildOptions } = params;
-
-    const { themeSrcDirPath } = getThemeSrcDirPath({ "reactAppRootDirPath": buildOptions.reactAppRootDirPath });
-
-    const getThemeTypeDirPath = (params: { themeType: ThemeType | "email" }) => {
-        const { themeType } = params;
-        return pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources", "theme", themeName, themeType);
-    };
-
-    const cssGlobalsToDefine: Record<string, string> = {};
-
-    const implementedThemeTypes: Record<ThemeType | "email", boolean> = {
-        "login": false,
-        "account": false,
-        "email": false
-    };
-
-    for (const themeType of ["login", "account"] as const) {
-        if (!fs.existsSync(pathJoin(themeSrcDirPath, themeType))) {
-            continue;
-        }
-
-        implementedThemeTypes[themeType] = true;
-
-        const themeTypeDirPath = getThemeTypeDirPath({ themeType });
-
-        apply_replacers_and_move_to_theme_resources: {
-            const destDirPath = pathJoin(themeTypeDirPath, "resources", basenameOfTheKeycloakifyResourcesDir);
-
-            // NOTE: Prevent accumulation of files in the assets dir, as names are hashed they pile up.
-            rmSync(destDirPath, { "recursive": true, "force": true });
-
-            if (themeType === "account" && implementedThemeTypes.login) {
-                // NOTE: We prevent doing it twice, it has been done for the login theme.
-
-                transformCodebase({
-                    "srcDirPath": pathJoin(
-                        getThemeTypeDirPath({
-                            "themeType": "login"
-                        }),
-                        "resources",
-                        basenameOfTheKeycloakifyResourcesDir
-                    ),
-                    destDirPath
-                });
-
-                break apply_replacers_and_move_to_theme_resources;
-            }
-
-            transformCodebase({
-                "srcDirPath": buildOptions.reactAppBuildDirPath,
-                destDirPath,
-                "transformSourceCode": ({ filePath, sourceCode }) => {
-                    //NOTE: Prevent cycles, excludes the folder we generated for debug in public/
-                    // This should not happen if users follow the new instruction setup but we keep it for retrocompatibility.
-                    if (
-                        isInside({
-                            "dirPath": pathJoin(buildOptions.reactAppBuildDirPath, keycloak_resources),
-                            filePath
-                        })
-                    ) {
-                        return undefined;
-                    }
-
-                    if (/\.css?$/i.test(filePath)) {
-                        const { cssGlobalsToDefine: cssGlobalsToDefineForThisFile, fixedCssCode } = replaceImportsInCssCode({
-                            "cssCode": sourceCode.toString("utf8")
-                        });
-
-                        Object.entries(cssGlobalsToDefineForThisFile).forEach(([key, value]) => {
-                            cssGlobalsToDefine[key] = value;
-                        });
-
-                        return { "modifiedSourceCode": Buffer.from(fixedCssCode, "utf8") };
-                    }
-
-                    if (/\.js?$/i.test(filePath)) {
-                        const { fixedJsCode } = replaceImportsInJsCode({
-                            "jsCode": sourceCode.toString("utf8"),
-                            buildOptions
-                        });
-
-                        return { "modifiedSourceCode": Buffer.from(fixedJsCode, "utf8") };
-                    }
-
-                    return { "modifiedSourceCode": sourceCode };
-                }
-            });
-        }
-
-        const { generateFtlFilesCode } = generateFtlFilesCodeFactory({
-            themeName,
-            "indexHtmlCode": fs.readFileSync(pathJoin(buildOptions.reactAppBuildDirPath, "index.html")).toString("utf8"),
-            cssGlobalsToDefine,
-            buildOptions,
-            "keycloakifyVersion": readThisNpmPackageVersion(),
-            themeType,
-            "fieldNames": readFieldNameUsage({
-                themeSrcDirPath,
-                themeType
-            })
-        });
-
-        [
-            ...(() => {
-                switch (themeType) {
-                    case "login":
-                        return loginThemePageIds;
-                    case "account":
-                        return accountThemePageIds;
-                }
-            })(),
-            ...readExtraPagesNames({
-                themeType,
-                themeSrcDirPath
-            })
-        ].forEach(pageId => {
-            const { ftlCode } = generateFtlFilesCode({ pageId });
-
-            fs.mkdirSync(themeTypeDirPath, { "recursive": true });
-
-            fs.writeFileSync(pathJoin(themeTypeDirPath, pageId), Buffer.from(ftlCode, "utf8"));
-        });
-
-        generateMessageProperties({
-            themeSrcDirPath,
-            themeType
-        }).forEach(({ languageTag, propertiesFileSource }) => {
-            const messagesDirPath = pathJoin(themeTypeDirPath, "messages");
-
-            fs.mkdirSync(pathJoin(themeTypeDirPath, "messages"), { "recursive": true });
-
-            const propertiesFilePath = pathJoin(messagesDirPath, `messages_${languageTag}.properties`);
-
-            fs.writeFileSync(propertiesFilePath, Buffer.from(propertiesFileSource, "utf8"));
-        });
-
-        await downloadKeycloakStaticResources({
-            "keycloakVersion": (() => {
-                switch (themeType) {
-                    case "account":
-                        return lastKeycloakVersionWithAccountV1;
-                    case "login":
-                        return buildOptions.loginThemeResourcesFromKeycloakVersion;
-                }
-            })(),
-            "themeDirPath": pathResolve(pathJoin(themeTypeDirPath, "..")),
-            themeType,
-            buildOptions
-        });
-
-        fs.writeFileSync(
-            pathJoin(themeTypeDirPath, "theme.properties"),
-            Buffer.from(
-                [
-                    `parent=${(() => {
-                        switch (themeType) {
-                            case "account":
-                                return accountV1ThemeName;
-                            case "login":
-                                return "keycloak";
-                        }
-                        assert<Equals<typeof themeType, never>>(false);
-                    })()}`,
-                    ...(buildOptions.extraThemeProperties ?? [])
-                ].join("\n\n"),
-                "utf8"
-            )
-        );
-    }
-
-    email: {
-        const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
-
-        if (!fs.existsSync(emailThemeSrcDirPath)) {
-            break email;
-        }
-
-        implementedThemeTypes.email = true;
-
-        transformCodebase({
-            "srcDirPath": emailThemeSrcDirPath,
-            "destDirPath": getThemeTypeDirPath({ "themeType": "email" })
-        });
-    }
-
-    if (implementedThemeTypes.account) {
-        await bringInAccountV1({
-            buildOptions
-        });
-    }
-
-    {
-        const metaInfKeycloakThemes: MetaInfKeycloakTheme = { "themes": [] };
-
-        metaInfKeycloakThemes.themes.push({
-            "name": themeName,
-            "types": objectEntries(implementedThemeTypes)
-                .filter(([, isImplemented]) => isImplemented)
-                .map(([themeType]) => themeType)
-        });
-
-        if (implementedThemeTypes.account) {
-            metaInfKeycloakThemes.themes.push({
-                "name": accountV1ThemeName,
-                "types": ["account"]
-            });
-        }
-
-        writeMetaInfKeycloakThemes({
-            "keycloakifyBuildDirPath": buildOptions.keycloakifyBuildDirPath,
-            metaInfKeycloakThemes
-        });
-    }
-}

package/src/bin/keycloakify/generateSrcMainResources/generateSrcMainResourcesForThemeVariant.ts

@@ -1,56 +0,0 @@
-import { join as pathJoin, extname as pathExtname, sep as pathSep } from "path";
-import { transformCodebase } from "../../tools/transformCodebase";
-import type { BuildOptions } from "../../shared/buildOptions";
-import { readMetaInfKeycloakThemes, writeMetaInfKeycloakThemes } from "../../shared/metaInfKeycloakThemes";
-import { assert } from "tsafe/assert";
-
-export type BuildOptionsLike = {
-    keycloakifyBuildDirPath: string;
-};
-
-assert<BuildOptions extends BuildOptionsLike ? true : false>();
-
-export function generateSrcMainResourcesForThemeVariant(params: { themeName: string; themeVariantName: string; buildOptions: BuildOptionsLike }) {
-    const { themeName, themeVariantName, buildOptions } = params;
-
-    const mainThemeDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources", "theme", themeName);
-
-    transformCodebase({
-        "srcDirPath": mainThemeDirPath,
-        "destDirPath": pathJoin(mainThemeDirPath, "..", themeVariantName),
-        "transformSourceCode": ({ fileRelativePath, sourceCode }) => {
-            if (pathExtname(fileRelativePath) === ".ftl" && fileRelativePath.split(pathSep).length === 2) {
-                const modifiedSourceCode = Buffer.from(
-                    Buffer.from(sourceCode)
-                        .toString("utf-8")
-                        .replace(`out["themeName"] = "${themeName}";`, `out["themeName"] = "${themeVariantName}";`),
-                    "utf8"
-                );
-
-                assert(Buffer.compare(modifiedSourceCode, sourceCode) !== 0);
-
-                return { modifiedSourceCode };
-            }
-
-            return { "modifiedSourceCode": sourceCode };
-        }
-    });
-
-    {
-        const updatedMetaInfKeycloakThemes = readMetaInfKeycloakThemes({ "keycloakifyBuildDirPath": buildOptions.keycloakifyBuildDirPath });
-
-        updatedMetaInfKeycloakThemes.themes.push({
-            "name": themeVariantName,
-            "types": (() => {
-                const theme = updatedMetaInfKeycloakThemes.themes.find(({ name }) => name === themeName);
-                assert(theme !== undefined);
-                return theme.types;
-            })()
-        });
-
-        writeMetaInfKeycloakThemes({
-            "keycloakifyBuildDirPath": buildOptions.keycloakifyBuildDirPath,
-            "metaInfKeycloakThemes": updatedMetaInfKeycloakThemes
-        });
-    }
-}

package/src/bin/keycloakify/generateSrcMainResources/index.ts

@@ -1 +0,0 @@
-export * from "./generateSrcMainResources";

package/src/bin/keycloakify/generateStartKeycloakTestingContainer.ts

@@ -1,60 +0,0 @@
-import * as fs from "fs";
-import { join as pathJoin, relative as pathRelative, basename as pathBasename } from "path";
-import { assert } from "tsafe/assert";
-import type { BuildOptions } from "../shared/buildOptions";
-import { accountV1ThemeName } from "../shared/constants";
-
-export type BuildOptionsLike = {
-    keycloakifyBuildDirPath: string;
-    themeNames: string[];
-};
-
-assert<BuildOptions extends BuildOptionsLike ? true : false>();
-
-generateStartKeycloakTestingContainer.basename = "start_keycloak_testing_container.sh";
-
-const containerName = "keycloak-testing-container";
-const keycloakVersion = "24.0.4";
-
-/** Files for being able to run a hot reload keycloak container */
-export function generateStartKeycloakTestingContainer(params: {
-    jarFilePath: string;
-    doesImplementAccountTheme: boolean;
-    buildOptions: BuildOptionsLike;
-}) {
-    const { jarFilePath, doesImplementAccountTheme, buildOptions } = params;
-
-    const themeRelativeDirPath = pathJoin("src", "main", "resources", "theme");
-
-    fs.writeFileSync(
-        pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename),
-        Buffer.from(
-            [
-                "#!/usr/bin/env bash",
-                "",
-                `docker rm ${containerName} || true`,
-                "",
-                `cd "${buildOptions.keycloakifyBuildDirPath}"`,
-                "",
-                "docker run \\",
-                "   -p 8080:8080 \\",
-                `   --name ${containerName} \\`,
-                "   -e KEYCLOAK_ADMIN=admin \\",
-                "   -e KEYCLOAK_ADMIN_PASSWORD=admin \\",
-                `   -v "${pathJoin(
-                    "$(pwd)",
-                    pathRelative(buildOptions.keycloakifyBuildDirPath, jarFilePath)
-                )}":"/opt/keycloak/providers/${pathBasename(jarFilePath)}" \\`,
-                [...(doesImplementAccountTheme ? [accountV1ThemeName] : []), ...buildOptions.themeNames].map(
-                    themeName =>
-                        `   -v "${pathJoin("$(pwd)", themeRelativeDirPath, themeName).replace(/\\/g, "/")}":"/opt/keycloak/themes/${themeName}":rw \\`
-                ),
-                `   -it quay.io/keycloak/keycloak:${keycloakVersion} \\`,
-                `   start-dev`,
-                ""
-            ].join("\n"),
-            "utf8"
-        ),
-        { "mode": 0o755 }
-    );
-}