keycloakify 10.0.0-rc.17 → 10.0.0-rc.18

package/src/bin/main.ts

@@ -10,12 +10,12 @@ export type CliCommandOptions = {
 
 const program = termost<CliCommandOptions>(
     {
-        "name": "keycloakify",
-        "description": "Keycloakify CLI",
-        "version": readThisNpmPackageVersion()
+        name: "keycloakify",
+        description: "Keycloakify CLI",
+        version: readThisNpmPackageVersion()
     },
     {
-        "onException": error => {
+        onException: error => {
             console.error(error);
             process.exit(1);
         }
@@ -25,8 +25,8 @@ const program = termost<CliCommandOptions>(
 const optionsKeys: string[] = [];
 
 program.option({
-    "key": "reactAppRootDirPath",
-    "name": (() => {
+    key: "reactAppRootDirPath",
+    name: (() => {
         const long = "project";
         const short = "p";
 
@@ -34,19 +34,25 @@ program.option({
 
         return { long, short };
     })(),
-    "description": [
+    description: [
         `For monorepos, path to the keycloakify project.`,
         "Example: `npx keycloakify build --project packages/keycloak-theme`",
         "https://docs.keycloakify.dev/build-options#project-or-p-cli-option"
     ].join(" "),
-    "defaultValue": undefined
+    defaultValue: undefined
 });
 
 function skip(_context: any, argv: { options: Record<string, unknown> }) {
-    const unrecognizedOptionKey = Object.keys(argv.options).find(key => !optionsKeys.includes(key));
+    const unrecognizedOptionKey = Object.keys(argv.options).find(
+        key => !optionsKeys.includes(key)
+    );
 
     if (unrecognizedOptionKey !== undefined) {
-        console.error(`keycloakify: Unrecognized option: ${unrecognizedOptionKey.length === 1 ? "-" : "--"}${unrecognizedOptionKey}`);
+        console.error(
+            `keycloakify: Unrecognized option: ${
+                unrecognizedOptionKey.length === 1 ? "-" : "--"
+            }${unrecognizedOptionKey}`
+        );
         process.exit(1);
     }
 
@@ -55,12 +61,12 @@ function skip(_context: any, argv: { options: Record<string, unknown> }) {
 
 program
     .command({
-        "name": "build",
-        "description": "Build the theme (default subcommand)."
+        name: "build",
+        description: "Build the theme (default subcommand)."
     })
     .task({
         skip,
-        "handler": async cliCommandOptions => {
+        handler: async cliCommandOptions => {
             const { command } = await import("./keycloakify");
 
             await command({ cliCommandOptions });
@@ -68,37 +74,60 @@ program
     });
 
 program
-    .command<{ port: number; keycloakVersion: string | undefined }>({
-        "name": "start-keycloak",
-        "description": "Spin up a pre configured Docker image of Keycloak to test your theme."
+    .command<{
+        port: number;
+        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": (() => {
+        key: "port",
+        name: (() => {
             const name = "port";
 
             optionsKeys.push(name);
 
             return name;
         })(),
-        "description": "Keycloak server port.",
-        "defaultValue": 8080
+        description: ["Keycloak server port.", "Example `--port 8085`"].join(" "),
+        defaultValue: 8080
     })
     .option({
-        "key": "keycloakVersion",
-        "name": (() => {
+        key: "keycloakVersion",
+        name: (() => {
             const name = "keycloak-version";
 
             optionsKeys.push(name);
 
             return name;
         })(),
-        "description": "Use a specific version of Keycloak.",
-        "defaultValue": undefined
+        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 cliCommandOptions => {
+        handler: async cliCommandOptions => {
             const { command } = await import("./start-keycloak");
 
             await command({ cliCommandOptions });
@@ -107,12 +136,12 @@ program
 
 program
     .command({
-        "name": "download-keycloak-default-theme",
-        "description": "Download the built-in Keycloak theme."
+        name: "download-keycloak-default-theme",
+        description: "Download the built-in Keycloak theme."
     })
     .task({
         skip,
-        "handler": async cliCommandOptions => {
+        handler: async cliCommandOptions => {
             const { command } = await import("./download-keycloak-default-theme");
 
             await command({ cliCommandOptions });
@@ -121,12 +150,12 @@ program
 
 program
     .command({
-        "name": "eject-page",
-        "description": "Eject a Keycloak page."
+        name: "eject-page",
+        description: "Eject a Keycloak page."
     })
     .task({
         skip,
-        "handler": async cliCommandOptions => {
+        handler: async cliCommandOptions => {
             const { command } = await import("./eject-page");
 
             await command({ cliCommandOptions });
@@ -135,12 +164,12 @@ program
 
 program
     .command({
-        "name": "initialize-email-theme",
-        "description": "Initialize an email theme."
+        name: "initialize-email-theme",
+        description: "Initialize an email theme."
     })
     .task({
         skip,
-        "handler": async cliCommandOptions => {
+        handler: async cliCommandOptions => {
             const { command } = await import("./initialize-email-theme");
 
             await command({ cliCommandOptions });
@@ -149,12 +178,13 @@ program
 
 program
     .command({
-        "name": "copy-keycloak-resources-to-public",
-        "description": "(Webpack/Create-React-App only) Copy Keycloak default theme resources to the public directory."
+        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 cliCommandOptions => {
+        handler: async cliCommandOptions => {
             const { command } = await import("./copy-keycloak-resources-to-public");
 
             await command({ cliCommandOptions });
@@ -165,10 +195,17 @@ program
 {
     const [, , ...rest] = process.argv;
 
-    if (rest.length === 0 || (rest[0].startsWith("-") && rest[0] !== "--help" && rest[0] !== "-h")) {
-        const { status } = child_process.spawnSync("npx", ["keycloakify", "build", ...rest], {
-            "stdio": "inherit"
-        });
+    if (
+        rest.length === 0 ||
+        (rest[0].startsWith("-") && rest[0] !== "--help" && rest[0] !== "-h")
+    ) {
+        const { status } = child_process.spawnSync(
+            "npx",
+            ["keycloakify", "build", ...rest],
+            {
+                stdio: "inherit"
+            }
+        );
 
         process.exit(status ?? 1);
     }

package/src/bin/shared/KeycloakVersionRange.ts

@@ -1,4 +1,6 @@
-export type KeycloakVersionRange = KeycloakVersionRange.WithAccountTheme | KeycloakVersionRange.WithoutAccountTheme;
+export type KeycloakVersionRange =
+    | KeycloakVersionRange.WithAccountTheme
+    | KeycloakVersionRange.WithoutAccountTheme;
 
 export namespace KeycloakVersionRange {
     export type WithoutAccountTheme = "21-and-below" | "22-and-above";

package/src/bin/shared/buildOptions.ts

@@ -49,7 +49,9 @@ export type ResolvedViteConfig = {
     userProvidedBuildOptions: UserProvidedBuildOptions;
 };
 
-export function readBuildOptions(params: { cliCommandOptions: CliCommandOptions }): BuildOptions {
+export function readBuildOptions(params: {
+    cliCommandOptions: CliCommandOptions;
+}): BuildOptions {
     const { cliCommandOptions } = params;
 
     const reactAppRootDirPath = (() => {
@@ -58,29 +60,39 @@ export function readBuildOptions(params: { cliCommandOptions: CliCommandOptions
         }
 
         return getAbsoluteAndInOsFormatPath({
-            "pathIsh": cliCommandOptions.reactAppRootDirPath,
-            "cwd": process.cwd()
+            pathIsh: cliCommandOptions.reactAppRootDirPath,
+            cwd: process.cwd()
         });
     })();
 
     const { resolvedViteConfig } = (() => {
-        if (fs.readdirSync(reactAppRootDirPath).find(fileBasename => fileBasename.startsWith("vite.config")) === undefined) {
-            return { "resolvedViteConfig": undefined };
+        if (
+            fs
+                .readdirSync(reactAppRootDirPath)
+                .find(fileBasename => fileBasename.startsWith("vite.config")) ===
+            undefined
+        ) {
+            return { resolvedViteConfig: undefined };
         }
 
         const output = child_process
             .execSync("npx vite", {
-                "cwd": reactAppRootDirPath,
-                "env": {
+                cwd: reactAppRootDirPath,
+                env: {
                     ...process.env,
                     [vitePluginSubScriptEnvNames.resolveViteConfig]: "true"
                 }
             })
             .toString("utf8");
 
-        assert(output.includes(vitePluginSubScriptEnvNames.resolveViteConfig), "Seems like the Keycloakify's Vite plugin is not installed.");
+        assert(
+            output.includes(vitePluginSubScriptEnvNames.resolveViteConfig),
+            "Seems like the Keycloakify's Vite plugin is not installed."
+        );
 
-        const resolvedViteConfigStr = output.split(vitePluginSubScriptEnvNames.resolveViteConfig).reverse()[0];
+        const resolvedViteConfigStr = output
+            .split(vitePluginSubScriptEnvNames.resolveViteConfig)
+            .reverse()[0];
 
         const resolvedViteConfig: ResolvedViteConfig = JSON.parse(resolvedViteConfigStr);
 
@@ -92,22 +104,24 @@ export function readBuildOptions(params: { cliCommandOptions: CliCommandOptions
             name: string;
             version?: string;
             homepage?: string;
-            keycloakify?: UserProvidedBuildOptions & { reactAppBuildDirPath?: string };
+            keycloakify?: UserProvidedBuildOptions & {
+                reactAppBuildDirPath?: string;
+            };
         };
 
         const zParsedPackageJson = z.object({
-            "name": z.string(),
-            "version": z.string().optional(),
-            "homepage": z.string().optional(),
-            "keycloakify": z
+            name: z.string(),
+            version: z.string().optional(),
+            homepage: z.string().optional(),
+            keycloakify: z
                 .object({
-                    "extraThemeProperties": z.array(z.string()).optional(),
-                    "artifactId": z.string().optional(),
-                    "groupId": z.string().optional(),
-                    "loginThemeResourcesFromKeycloakVersion": z.string().optional(),
-                    "reactAppBuildDirPath": z.string().optional(),
-                    "keycloakifyBuildDirPath": z.string().optional(),
-                    "themeName": z.union([z.string(), z.array(z.string())]).optional()
+                    extraThemeProperties: z.array(z.string()).optional(),
+                    artifactId: z.string().optional(),
+                    groupId: z.string().optional(),
+                    loginThemeResourcesFromKeycloakVersion: z.string().optional(),
+                    reactAppBuildDirPath: z.string().optional(),
+                    keycloakifyBuildDirPath: z.string().optional(),
+                    themeName: z.union([z.string(), z.array(z.string())]).optional()
                 })
                 .optional()
         });
@@ -119,7 +133,13 @@ export function readBuildOptions(params: { cliCommandOptions: CliCommandOptions
             assert<Expected extends Got ? true : false>();
         }
 
-        return zParsedPackageJson.parse(JSON.parse(fs.readFileSync(pathJoin(reactAppRootDirPath, "package.json")).toString("utf8")));
+        return zParsedPackageJson.parse(
+            JSON.parse(
+                fs
+                    .readFileSync(pathJoin(reactAppRootDirPath, "package.json"))
+                    .toString("utf8")
+            )
+        );
     })();
 
     const userProvidedBuildOptions: UserProvidedBuildOptions = {
@@ -152,8 +172,8 @@ export function readBuildOptions(params: { cliCommandOptions: CliCommandOptions
 
             if (parsedPackageJson.keycloakify?.reactAppBuildDirPath !== undefined) {
                 return getAbsoluteAndInOsFormatPath({
-                    "pathIsh": parsedPackageJson.keycloakify.reactAppBuildDirPath,
-                    "cwd": reactAppRootDirPath
+                    pathIsh: parsedPackageJson.keycloakify.reactAppBuildDirPath,
+                    cwd: reactAppRootDirPath
                 });
             }
 
@@ -165,15 +185,16 @@ export function readBuildOptions(params: { cliCommandOptions: CliCommandOptions
 
     const { npmWorkspaceRootDirPath } = getNpmWorkspaceRootDirPath({
         reactAppRootDirPath,
-        "dependencyExpected": "keycloakify"
+        dependencyExpected: "keycloakify"
     });
 
     return {
-        "bundler": resolvedViteConfig !== undefined ? "vite" : "webpack",
-        "themeVersion": process.env.KEYCLOAKIFY_THEME_VERSION ?? parsedPackageJson.version ?? "0.0.0",
+        bundler: resolvedViteConfig !== undefined ? "vite" : "webpack",
+        themeVersion:
+            process.env.KEYCLOAKIFY_THEME_VERSION ?? parsedPackageJson.version ?? "0.0.0",
         themeNames,
-        "extraThemeProperties": userProvidedBuildOptions.extraThemeProperties,
-        "groupId": (() => {
+        extraThemeProperties: userProvidedBuildOptions.extraThemeProperties,
+        groupId: (() => {
             const fallbackGroupId = `${themeNames[0]}.keycloak`;
 
             return (
@@ -188,24 +209,30 @@ export function readBuildOptions(params: { cliCommandOptions: CliCommandOptions
                           .join(".") ?? fallbackGroupId) + ".keycloak"
             );
         })(),
-        "artifactId": process.env.KEYCLOAKIFY_ARTIFACT_ID ?? userProvidedBuildOptions.artifactId ?? `${themeNames[0]}-keycloak-theme`,
-        "loginThemeResourcesFromKeycloakVersion": userProvidedBuildOptions.loginThemeResourcesFromKeycloakVersion ?? "24.0.4",
+        artifactId:
+            process.env.KEYCLOAKIFY_ARTIFACT_ID ??
+            userProvidedBuildOptions.artifactId ??
+            `${themeNames[0]}-keycloak-theme`,
+        loginThemeResourcesFromKeycloakVersion:
+            userProvidedBuildOptions.loginThemeResourcesFromKeycloakVersion ?? "24.0.4",
         reactAppRootDirPath,
         reactAppBuildDirPath,
-        "keycloakifyBuildDirPath": (() => {
+        keycloakifyBuildDirPath: (() => {
             if (userProvidedBuildOptions.keycloakifyBuildDirPath !== undefined) {
                 return getAbsoluteAndInOsFormatPath({
-                    "pathIsh": userProvidedBuildOptions.keycloakifyBuildDirPath,
-                    "cwd": reactAppRootDirPath
+                    pathIsh: userProvidedBuildOptions.keycloakifyBuildDirPath,
+                    cwd: reactAppRootDirPath
                 });
             }
 
             return pathJoin(
                 reactAppRootDirPath,
-                resolvedViteConfig?.buildDir === undefined ? "build_keycloak" : `${resolvedViteConfig.buildDir}_keycloak`
+                resolvedViteConfig?.buildDir === undefined
+                    ? "build_keycloak"
+                    : `${resolvedViteConfig.buildDir}_keycloak`
             );
         })(),
-        "publicDirPath": (() => {
+        publicDirPath: (() => {
             webpack: {
                 if (resolvedViteConfig !== undefined) {
                     break webpack;
@@ -213,8 +240,8 @@ export function readBuildOptions(params: { cliCommandOptions: CliCommandOptions
 
                 if (process.env.PUBLIC_DIR_PATH !== undefined) {
                     return getAbsoluteAndInOsFormatPath({
-                        "pathIsh": process.env.PUBLIC_DIR_PATH,
-                        "cwd": reactAppRootDirPath
+                        pathIsh: process.env.PUBLIC_DIR_PATH,
+                        cwd: reactAppRootDirPath
                     });
                 }
 
@@ -223,13 +250,13 @@ export function readBuildOptions(params: { cliCommandOptions: CliCommandOptions
 
             return pathJoin(reactAppRootDirPath, resolvedViteConfig.publicDir);
         })(),
-        "cacheDirPath": (() => {
+        cacheDirPath: (() => {
             const cacheDirPath = pathJoin(
                 (() => {
                     if (process.env.XDG_CACHE_HOME !== undefined) {
                         return getAbsoluteAndInOsFormatPath({
-                            "pathIsh": process.env.XDG_CACHE_HOME,
-                            "cwd": process.cwd()
+                            pathIsh: process.env.XDG_CACHE_HOME,
+                            cwd: process.cwd()
                         });
                     }
 
@@ -240,7 +267,7 @@ export function readBuildOptions(params: { cliCommandOptions: CliCommandOptions
 
             return cacheDirPath;
         })(),
-        "urlPathname": (() => {
+        urlPathname: (() => {
             webpack: {
                 if (resolvedViteConfig !== undefined) {
                     break webpack;
@@ -264,7 +291,7 @@ export function readBuildOptions(params: { cliCommandOptions: CliCommandOptions
 
             return resolvedViteConfig.urlPathname;
         })(),
-        "assetsDirPath": (() => {
+        assetsDirPath: (() => {
             webpack: {
                 if (resolvedViteConfig !== undefined) {
                     break webpack;

package/src/bin/shared/constants.ts

@@ -10,8 +10,8 @@ export const accountV1ThemeName = "account-v1";
 export type ThemeType = (typeof themeTypes)[number];
 
 export const vitePluginSubScriptEnvNames = {
-    "runPostBuildScript": "KEYCLOAKIFY_RUN_POST_BUILD_SCRIPT",
-    "resolveViteConfig": "KEYCLOAKIFY_RESOLVE_VITE_CONFIG"
+    runPostBuildScript: "KEYCLOAKIFY_RUN_POST_BUILD_SCRIPT",
+    resolveViteConfig: "KEYCLOAKIFY_RESOLVE_VITE_CONFIG"
 } as const;
 
 export const skipBuildJarsEnvName = "KEYCLOAKIFY_SKIP_BUILD_JAR";
@@ -65,3 +65,5 @@ export const accountThemePageIds = [
 
 export type LoginThemePageId = (typeof loginThemePageIds)[number];
 export type AccountThemePageId = (typeof accountThemePageIds)[number];
+
+export const containerName = "keycloak-keycloakify";

package/src/bin/shared/copyKeycloakResourcesToPublic.ts

@@ -3,7 +3,11 @@ import {
     type BuildOptionsLike as BuildOptionsLike_downloadKeycloakStaticResources
 } from "./downloadKeycloakStaticResources";
 import { join as pathJoin, relative as pathRelative } from "path";
-import { themeTypes, keycloak_resources, lastKeycloakVersionWithAccountV1 } from "../shared/constants";
+import {
+    themeTypes,
+    keycloak_resources,
+    lastKeycloakVersionWithAccountV1
+} from "../shared/constants";
 import { readThisNpmPackageVersion } from "../tools/readThisNpmPackageVersion";
 import { assert } from "tsafe/assert";
 import * as fs from "fs";
@@ -17,7 +21,9 @@ export type BuildOptionsLike = BuildOptionsLike_downloadKeycloakStaticResources
 
 assert<BuildOptions extends BuildOptionsLike ? true : false>();
 
-export async function copyKeycloakResourcesToPublic(params: { buildOptions: BuildOptionsLike }) {
+export async function copyKeycloakResourcesToPublic(params: {
+    buildOptions: BuildOptionsLike;
+}) {
     const { buildOptions } = params;
 
     const destDirPath = pathJoin(buildOptions.publicDirPath, keycloak_resources);
@@ -27,11 +33,14 @@ export async function copyKeycloakResourcesToPublic(params: { buildOptions: Buil
     const keycloakifyBuildinfoRaw = JSON.stringify(
         {
             destDirPath,
-            "keycloakifyVersion": readThisNpmPackageVersion(),
-            "buildOptions": {
-                "loginThemeResourcesFromKeycloakVersion": readThisNpmPackageVersion(),
-                "cacheDirPath": pathRelative(destDirPath, buildOptions.cacheDirPath),
-                "npmWorkspaceRootDirPath": pathRelative(destDirPath, buildOptions.npmWorkspaceRootDirPath)
+            keycloakifyVersion: readThisNpmPackageVersion(),
+            buildOptions: {
+                loginThemeResourcesFromKeycloakVersion: readThisNpmPackageVersion(),
+                cacheDirPath: pathRelative(destDirPath, buildOptions.cacheDirPath),
+                npmWorkspaceRootDirPath: pathRelative(
+                    destDirPath,
+                    buildOptions.npmWorkspaceRootDirPath
+                )
             }
         },
         null,
@@ -43,7 +52,9 @@ export async function copyKeycloakResourcesToPublic(params: { buildOptions: Buil
             break skip_if_already_done;
         }
 
-        const keycloakifyBuildinfoRaw_previousRun = fs.readFileSync(keycloakifyBuildinfoFilePath).toString("utf8");
+        const keycloakifyBuildinfoRaw_previousRun = fs
+            .readFileSync(keycloakifyBuildinfoFilePath)
+            .toString("utf8");
 
         if (keycloakifyBuildinfoRaw_previousRun !== keycloakifyBuildinfoRaw) {
             break skip_if_already_done;
@@ -52,15 +63,15 @@ export async function copyKeycloakResourcesToPublic(params: { buildOptions: Buil
         return;
     }
 
-    rmSync(destDirPath, { "force": true, "recursive": true });
+    rmSync(destDirPath, { force: true, recursive: true });
 
-    fs.mkdirSync(destDirPath, { "recursive": true });
+    fs.mkdirSync(destDirPath, { recursive: true });
 
     fs.writeFileSync(pathJoin(destDirPath, ".gitignore"), Buffer.from("*", "utf8"));
 
     for (const themeType of themeTypes) {
         await downloadKeycloakStaticResources({
-            "keycloakVersion": (() => {
+            keycloakVersion: (() => {
                 switch (themeType) {
                     case "login":
                         return buildOptions.loginThemeResourcesFromKeycloakVersion;
@@ -69,7 +80,7 @@ export async function copyKeycloakResourcesToPublic(params: { buildOptions: Buil
                 }
             })(),
             themeType,
-            "themeDirPath": destDirPath,
+            themeDirPath: destDirPath,
             buildOptions
         });
     }
@@ -86,5 +97,8 @@ export async function copyKeycloakResourcesToPublic(params: { buildOptions: Buil
         )
     );
 
-    fs.writeFileSync(keycloakifyBuildinfoFilePath, Buffer.from(keycloakifyBuildinfoRaw, "utf8"));
+    fs.writeFileSync(
+        keycloakifyBuildinfoFilePath,
+        Buffer.from(keycloakifyBuildinfoRaw, "utf8")
+    );
 }