keycloakify 11.3.0-rc.4 → 11.3.0-rc.7

package/src/bin/copy-keycloak-resources-to-public.ts

@@ -1,9 +1,15 @@
 import { copyKeycloakResourcesToPublic } from "./shared/copyKeycloakResourcesToPublic";
 import type { BuildContext } from "./shared/buildContext";
+import { maybeDelegateCommandToCustomHandler } from "./shared/customHandler_delegate";
 
 export async function command(params: { buildContext: BuildContext }) {
     const { buildContext } = params;
 
+    maybeDelegateCommandToCustomHandler({
+        commandName: "copy-keycloak-resources-to-public",
+        buildContext
+    });
+
     copyKeycloakResourcesToPublic({
         buildContext
     });

package/src/bin/initialize-account-theme/initialize-account-theme.ts

@@ -5,11 +5,17 @@ import chalk from "chalk";
 import { join as pathJoin, relative as pathRelative } from "path";
 import * as fs from "fs";
 import { updateAccountThemeImplementationInConfig } from "./updateAccountThemeImplementationInConfig";
-import { generateKcGenTs } from "../shared/generateKcGenTs";
+import { command as updateKcGenCommand } from "../update-kc-gen";
+import { maybeDelegateCommandToCustomHandler } from "../shared/customHandler_delegate";
 
 export async function command(params: { buildContext: BuildContext }) {
     const { buildContext } = params;
 
+    maybeDelegateCommandToCustomHandler({
+        commandName: "initialize-account-theme",
+        buildContext
+    });
+
     const accountThemeSrcDirPath = pathJoin(buildContext.themeSrcDirPath, "account");
 
     if (
@@ -94,7 +100,7 @@ export async function command(params: { buildContext: BuildContext }) {
 
     updateAccountThemeImplementationInConfig({ buildContext, accountThemeType });
 
-    await generateKcGenTs({
+    await updateKcGenCommand({
         buildContext: {
             ...buildContext,
             implementedThemeTypes: {

package/src/bin/initialize-account-theme/updateAccountThemeImplementationInConfig.ts

@@ -8,12 +8,14 @@ import { id } from "tsafe/id";
 
 export type BuildContextLike = {
     bundler: BuildContext["bundler"];
+    projectDirPath: string;
+    packageJsonFilePath: string;
 };
 
 assert<BuildContext extends BuildContextLike ? true : false>();
 
 export function updateAccountThemeImplementationInConfig(params: {
-    buildContext: BuildContext;
+    buildContext: BuildContextLike;
     accountThemeType: "Single-Page" | "Multi-Page";
 }) {
     const { buildContext, accountThemeType } = params;

package/src/bin/initialize-email-theme.ts

@@ -4,10 +4,16 @@ import { promptKeycloakVersion } from "./shared/promptKeycloakVersion";
 import type { BuildContext } from "./shared/buildContext";
 import * as fs from "fs";
 import { downloadAndExtractArchive } from "./tools/downloadAndExtractArchive";
+import { maybeDelegateCommandToCustomHandler } from "./shared/customHandler_delegate";
 
 export async function command(params: { buildContext: BuildContext }) {
     const { buildContext } = params;
 
+    maybeDelegateCommandToCustomHandler({
+        commandName: "initialize-email-theme",
+        buildContext
+    });
+
     const emailThemeSrcDirPath = pathJoin(buildContext.themeSrcDirPath, "email");
 
     if (

package/src/bin/main.ts

@@ -4,7 +4,6 @@ import { termost } from "termost";
 import { readThisNpmPackageVersion } from "./tools/readThisNpmPackageVersion";
 import * as child_process from "child_process";
 import { assertNoPnpmDlx } from "./tools/assertNoPnpmDlx";
-import { callHandlerIfAny } from "./shared/customHandler_caller";
 import { getBuildContext } from "./shared/buildContext";
 
 type CliCommandOptions = {
@@ -72,153 +71,117 @@ program
     .task({
         skip,
         handler: async ({ projectDirPath }) => {
-            const buildContext = getBuildContext({ projectDirPath });
-
             const { command } = await import("./keycloakify");
 
-            await command({ buildContext });
+            await command({ buildContext: getBuildContext({ projectDirPath }) });
         }
     });
 
-{
-    const commandName = "start-keycloak";
-
-    program
-        .command<{
-            port: number | undefined;
-            keycloakVersion: string | undefined;
-            realmJsonFilePath: string | undefined;
-        }>({
-            name: commandName,
-            description:
-                "Spin up a pre configured Docker image of Keycloak to test your theme."
-        })
-        .option({
-            key: "port",
-            name: (() => {
-                const name = "port";
-
-                optionsKeys.push(name);
-
-                return name;
-            })(),
-            description: ["Keycloak server port.", "Example `--port 8085`"].join(" "),
-            defaultValue: undefined
-        })
-        .option({
-            key: "keycloakVersion",
-            name: (() => {
-                const name = "keycloak-version";
-
-                optionsKeys.push(name);
-
-                return name;
-            })(),
-            description: [
-                "Use a specific version of Keycloak.",
-                "Example `--keycloak-version 21.1.1`"
-            ].join(" "),
-            defaultValue: undefined
-        })
-        .option({
-            key: "realmJsonFilePath",
-            name: (() => {
-                const name = "import";
-
-                optionsKeys.push(name);
-
-                return name;
-            })(),
-            defaultValue: undefined,
-            description: [
-                "Import your own realm configuration file",
-                "Example `--import path/to/myrealm-realm.json`"
-            ].join(" ")
-        })
-        .task({
-            skip,
-            handler: async ({
-                projectDirPath,
-                keycloakVersion,
-                port,
-                realmJsonFilePath
-            }) => {
-                const buildContext = getBuildContext({ projectDirPath });
-
-                const { command } = await import("./start-keycloak");
-
-                await command({
-                    buildContext,
-                    cliCommandOptions: { keycloakVersion, port, realmJsonFilePath }
-                });
-            }
-        });
-}
-
-{
-    const commandName = "eject-page";
-
-    program
-        .command({
-            name: commandName,
-            description: "Eject a Keycloak page."
-        })
-        .task({
-            skip,
-            handler: async ({ projectDirPath }) => {
-                const buildContext = getBuildContext({ projectDirPath });
-
-                callHandlerIfAny({ buildContext, commandName });
-
-                const { command } = await import("./eject-page");
-
-                await command({ buildContext });
-            }
-        });
-}
+program
+    .command<{
+        port: number | undefined;
+        keycloakVersion: string | undefined;
+        realmJsonFilePath: string | undefined;
+    }>({
+        name: "start-keycloak",
+        description:
+            "Spin up a pre configured Docker image of Keycloak to test your theme."
+    })
+    .option({
+        key: "port",
+        name: (() => {
+            const name = "port";
 
-{
-    const commandName = "add-story";
+            optionsKeys.push(name);
 
-    program
-        .command({
-            name: commandName,
-            description:
-                "Add *.stories.tsx file for a specific page to in your Storybook."
-        })
-        .task({
-            skip,
-            handler: async ({ projectDirPath }) => {
-                const buildContext = getBuildContext({ projectDirPath });
+            return name;
+        })(),
+        description: ["Keycloak server port.", "Example `--port 8085`"].join(" "),
+        defaultValue: undefined
+    })
+    .option({
+        key: "keycloakVersion",
+        name: (() => {
+            const name = "keycloak-version";
+
+            optionsKeys.push(name);
+
+            return name;
+        })(),
+        description: [
+            "Use a specific version of Keycloak.",
+            "Example `--keycloak-version 21.1.1`"
+        ].join(" "),
+        defaultValue: undefined
+    })
+    .option({
+        key: "realmJsonFilePath",
+        name: (() => {
+            const name = "import";
+
+            optionsKeys.push(name);
+
+            return name;
+        })(),
+        defaultValue: undefined,
+        description: [
+            "Import your own realm configuration file",
+            "Example `--import path/to/myrealm-realm.json`"
+        ].join(" ")
+    })
+    .task({
+        skip,
+        handler: async ({ projectDirPath, keycloakVersion, port, realmJsonFilePath }) => {
+            const { command } = await import("./start-keycloak");
 
-                callHandlerIfAny({ buildContext, commandName });
+            await command({
+                buildContext: getBuildContext({ projectDirPath }),
+                cliCommandOptions: { keycloakVersion, port, realmJsonFilePath }
+            });
+        }
+    });
 
-                const { command } = await import("./add-story");
+program
+    .command({
+        name: "eject-page",
+        description: "Eject a Keycloak page."
+    })
+    .task({
+        skip,
+        handler: async ({ projectDirPath }) => {
+            const { command } = await import("./eject-page");
 
-                await command({ buildContext });
-            }
-        });
-}
+            await command({ buildContext: getBuildContext({ projectDirPath }) });
+        }
+    });
 
-{
-    const comandName = "initialize-login-theme";
+program
+    .command({
+        name: "add-story",
+        description: "Add *.stories.tsx file for a specific page to in your Storybook."
+    })
+    .task({
+        skip,
+        handler: async ({ projectDirPath }) => {
+            const { command } = await import("./add-story");
 
-    program
-        .command({
-            name: comandName,
-            description: "Initialize an email theme."
-        })
-        .task({
-            skip,
-            handler: async ({ projectDirPath }) => {
-                const buildContext = getBuildContext({ projectDirPath });
+            await command({ buildContext: getBuildContext({ projectDirPath }) });
+        }
+    });
 
-                const { command } = await import("./initialize-email-theme");
+program
+    .command({
+        name: "initialize-login-theme",
+        description: "Initialize an email theme."
+    })
+    .task({
+        skip,
+        handler: async ({ projectDirPath }) => {
+            const { command } = await import("./initialize-email-theme");
 
-                await command({ buildContext });
-            }
-        });
-}
+            await command({ buildContext: getBuildContext({ projectDirPath }) });
+        }
+    });
 
 program
     .command({
@@ -228,57 +191,41 @@ program
     .task({
         skip,
         handler: async ({ projectDirPath }) => {
-            const buildContext = getBuildContext({ projectDirPath });
-
             const { command } = await import("./initialize-account-theme");
 
-            await command({ buildContext });
+            await command({ buildContext: getBuildContext({ projectDirPath }) });
         }
     });
 
-{
-    const commandName = "copy-keycloak-resources-to-public";
-
-    program
-        .command({
-            name: commandName,
-            description:
-                "(Webpack/Create-React-App only) Copy Keycloak default theme resources to the public directory."
-        })
-        .task({
-            skip,
-            handler: async ({ projectDirPath }) => {
-                const buildContext = getBuildContext({ projectDirPath });
-
-                const { command } = await import("./copy-keycloak-resources-to-public");
-
-                await command({ buildContext });
-            }
-        });
-}
-
-{
-    const commandName = "update-kc-gen";
-
-    program
-        .command({
-            name: commandName,
-            description:
-                "(Webpack/Create-React-App only) Create/update the kc.gen.ts file in your project."
-        })
-        .task({
-            skip,
-            handler: async ({ projectDirPath }) => {
-                const buildContext = getBuildContext({ projectDirPath });
+program
+    .command({
+        name: "copy-keycloak-resources-to-public",
+        description:
+            "(Webpack/Create-React-App only) Copy Keycloak default theme resources to the public directory."
+    })
+    .task({
+        skip,
+        handler: async ({ projectDirPath }) => {
+            const { command } = await import("./copy-keycloak-resources-to-public");
 
-                callHandlerIfAny({ buildContext, commandName });
+            await command({ buildContext: getBuildContext({ projectDirPath }) });
+        }
+    });
 
-                const { command } = await import("./update-kc-gen");
+program
+    .command({
+        name: "update-kc-gen",
+        description:
+            "(Webpack/Create-React-App only) Create/update the kc.gen.ts file in your project."
+    })
+    .task({
+        skip,
+        handler: async ({ projectDirPath }) => {
+            const { command } = await import("./update-kc-gen");
 
-                await command({ buildContext });
-            }
-        });
-}
+            await command({ buildContext: getBuildContext({ projectDirPath }) });
+        }
+    });
 
 // Fallback to build command if no command is provided
 {

package/src/bin/shared/customHandler.ts

@@ -6,7 +6,13 @@ export const BIN_NAME = "_keycloakify-custom-handler";
 
 export const NOT_IMPLEMENTED_EXIT_CODE = 78;
 
-export type CommandName = "update-kc-gen" | "eject-page" | "add-story";
+export type CommandName =
+    | "update-kc-gen"
+    | "eject-page"
+    | "add-story"
+    | "initialize-account-theme"
+    | "initialize-email-theme"
+    | "copy-keycloak-resources-to-public";
 
 export type ApiVersion = "v1";
 

package/src/bin/shared/{customHandler_caller.ts → customHandler_delegate.ts}

@@ -13,7 +13,7 @@ import * as fs from "fs";
 
 assert<Equals<ApiVersion, "v1">>();
 
-export function callHandlerIfAny(params: {
+export function maybeDelegateCommandToCustomHandler(params: {
     commandName: CommandName;
     buildContext: BuildContext;
 }) {

package/src/bin/update-kc-gen.ts

@@ -1,8 +1,116 @@
 import type { BuildContext } from "./shared/buildContext";
-import { generateKcGenTs } from "./shared/generateKcGenTs";
+import * as fs from "fs/promises";
+import { join as pathJoin } from "path";
+import { existsAsync } from "./tools/fs.existsAsync";
+import { maybeDelegateCommandToCustomHandler } from "./shared/customHandler_delegate";
 
 export async function command(params: { buildContext: BuildContext }) {
     const { buildContext } = params;
 
-    await generateKcGenTs({ buildContext });
+    maybeDelegateCommandToCustomHandler({
+        commandName: "update-kc-gen",
+        buildContext
+    });
+
+    const filePath = pathJoin(buildContext.themeSrcDirPath, `kc.gen.tsx`);
+
+    const currentContent = (await existsAsync(filePath))
+        ? await fs.readFile(filePath)
+        : undefined;
+
+    const hasLoginTheme = buildContext.implementedThemeTypes.login.isImplemented;
+    const hasAccountTheme = buildContext.implementedThemeTypes.account.isImplemented;
+
+    const newContent = Buffer.from(
+        [
+            `/* prettier-ignore-start */`,
+            ``,
+            `/* eslint-disable */`,
+            ``,
+            `// @ts-nocheck`,
+            ``,
+            `// noinspection JSUnusedGlobalSymbols`,
+            ``,
+            `// This file is auto-generated by Keycloakify`,
+            ``,
+            `import { lazy, Suspense, type ReactNode } from "react";`,
+            ``,
+            `export type ThemeName = ${buildContext.themeNames.map(themeName => `"${themeName}"`).join(" | ")};`,
+            ``,
+            `export const themeNames: ThemeName[] = [${buildContext.themeNames.map(themeName => `"${themeName}"`).join(", ")}];`,
+            ``,
+            `export type KcEnvName = ${buildContext.environmentVariables.length === 0 ? "never" : buildContext.environmentVariables.map(({ name }) => `"${name}"`).join(" | ")};`,
+            ``,
+            `export const kcEnvNames: KcEnvName[] = [${buildContext.environmentVariables.map(({ name }) => `"${name}"`).join(", ")}];`,
+            ``,
+            `export const kcEnvDefaults: Record<KcEnvName, string> = ${JSON.stringify(
+                Object.fromEntries(
+                    buildContext.environmentVariables.map(
+                        ({ name, default: defaultValue }) => [name, defaultValue]
+                    )
+                ),
+                null,
+                2
+            )};`,
+            ``,
+            `export type KcContext =`,
+            hasLoginTheme && `    | import("./login/KcContext").KcContext`,
+            hasAccountTheme && `    | import("./account/KcContext").KcContext`,
+            `    ;`,
+            ``,
+            `declare global {`,
+            `    interface Window {`,
+            `        kcContext?: KcContext;`,
+            `    }`,
+            `}`,
+            ``,
+            hasLoginTheme &&
+                `export const KcLoginPage = lazy(() => import("./login/KcPage"));`,
+            hasAccountTheme &&
+                `export const KcAccountPage = lazy(() => import("./account/KcPage"));`,
+            ``,
+            `export function KcPage(`,
+            `    props: {`,
+            `        kcContext: KcContext;`,
+            `        fallback?: ReactNode;`,
+            `    }`,
+            `) {`,
+            `    const { kcContext, fallback } = props;`,
+            `    return (`,
+            `        <Suspense fallback={fallback}>`,
+            `            {(() => {`,
+            `                switch (kcContext.themeType) {`,
+            hasLoginTheme &&
+                `                    case "login": return <KcLoginPage kcContext={kcContext} />;`,
+            hasAccountTheme &&
+                `                    case "account": return <KcAccountPage kcContext={kcContext} />;`,
+            `                }`,
+            `            })()}`,
+            `        </Suspense>`,
+            `    );`,
+            `}`,
+            ``,
+            `/* prettier-ignore-end */`,
+            ``
+        ]
+            .filter(item => typeof item === "string")
+            .join("\n"),
+        "utf8"
+    );
+
+    if (currentContent !== undefined && currentContent.equals(newContent)) {
+        return;
+    }
+
+    await fs.writeFile(filePath, newContent);
+
+    delete_legacy_file: {
+        const legacyFilePath = filePath.replace(/tsx$/, "ts");
+
+        if (!(await existsAsync(legacyFilePath))) {
+            break delete_legacy_file;
+        }
+
+        await fs.unlink(legacyFilePath);
+    }
 }

package/src/vite-plugin/vite-plugin.ts

@@ -15,7 +15,7 @@ import {
     type ResolvedViteConfig
 } from "../bin/shared/buildContext";
 import MagicString from "magic-string";
-import { generateKcGenTs } from "../bin/shared/generateKcGenTs";
+import { command as updateKcGenCommand } from "../bin/update-kc-gen";
 
 export namespace keycloakify {
     export type Params = BuildOptions & {
@@ -125,8 +125,9 @@ export function keycloakify(params: keycloakify.Params) {
                 projectDirPath
             });
 
-            copyKeycloakResourcesToPublic({ buildContext }),
-                await generateKcGenTs({ buildContext });
+            copyKeycloakResourcesToPublic({ buildContext });
+
+            await updateKcGenCommand({ buildContext });
         },
         transform: (code, id) => {
             assert(command !== undefined);

package/stories/login/pages/Register.stories.tsx

@@ -115,7 +115,6 @@ export const WithFavoritePet: Story = {
     )
 };
 
-
 export const WithNewsletter: Story = {
     render: () => (
         <KcPageStory
@@ -132,7 +131,7 @@ export const WithNewsletter: Story = {
                             },
                             annotations: {
                                 inputOptionLabels: {
-                                    "yes": "I want my email inbox filled with spam"
+                                    yes: "I want my email inbox filled with spam"
                                 },
                                 inputType: "multiselect-checkboxes"
                             },
@@ -140,13 +139,12 @@ export const WithNewsletter: Story = {
                             readOnly: false
                         } satisfies Attribute
                     }
-                },
+                }
             }}
         />
     )
 };
 
-
 export const WithEmailAsUsername: Story = {
     render: () => (
         <KcPageStory