keycloakify 10.0.0-rc.37 → 10.0.0-rc.39

package/src/bin/keycloakify/replacers/replaceImportsInJsCode/vite.ts

@@ -3,21 +3,21 @@ import {
     basenameOfTheKeycloakifyResourcesDir
 } from "../../../shared/constants";
 import { assert } from "tsafe/assert";
-import type { BuildOptions } from "../../../shared/buildOptions";
+import type { BuildContext } from "../../../shared/buildContext";
 import * as nodePath from "path";
 import { replaceAll } from "../../../tools/String.prototype.replaceAll";
 
-export type BuildOptionsLike = {
-    reactAppBuildDirPath: string;
+export type BuildContextLike = {
+    projectBuildDirPath: string;
     assetsDirPath: string;
     urlPathname: string | undefined;
 };
 
-assert<BuildOptions extends BuildOptionsLike ? true : false>();
+assert<BuildContext extends BuildContextLike ? true : false>();
 
 export function replaceImportsInJsCode_vite(params: {
     jsCode: string;
-    buildOptions: BuildOptionsLike;
+    buildContext: BuildContextLike;
     basenameOfAssetsFiles: string[];
     systemType?: "posix" | "win32";
 }): {
@@ -25,7 +25,7 @@ export function replaceImportsInJsCode_vite(params: {
 } {
     const {
         jsCode,
-        buildOptions,
+        buildContext,
         basenameOfAssetsFiles,
         systemType = nodePath.sep === "/" ? "posix" : "win32"
     } = params;
@@ -35,11 +35,11 @@ export function replaceImportsInJsCode_vite(params: {
     let fixedJsCode = jsCode;
 
     replace_base_javacript_import: {
-        if (buildOptions.urlPathname === undefined) {
+        if (buildContext.urlPathname === undefined) {
             break replace_base_javacript_import;
         }
         // Optimization
-        if (!jsCode.includes(buildOptions.urlPathname)) {
+        if (!jsCode.includes(buildContext.urlPathname)) {
             break replace_base_javacript_import;
         }
 
@@ -47,7 +47,7 @@ export function replaceImportsInJsCode_vite(params: {
         fixedJsCode = fixedJsCode.replace(
             new RegExp(
                 `([\\w\\$][\\w\\d\\$]*)=function\\(([\\w\\$][\\w\\d\\$]*)\\)\\{return"${replaceAll(
-                    buildOptions.urlPathname,
+                    buildContext.urlPathname,
                     "/",
                     "\\/"
                 )}"\\+\\2\\}`,
@@ -62,15 +62,15 @@ export function replaceImportsInJsCode_vite(params: {
         // Example: "assets/ or "foo/bar/"
         const staticDir = (() => {
             let out = pathRelative(
-                buildOptions.reactAppBuildDirPath,
-                buildOptions.assetsDirPath
+                buildContext.projectBuildDirPath,
+                buildContext.assetsDirPath
             );
 
             out = replaceAll(out, pathSep, "/") + "/";
 
             if (out === "/") {
                 throw new Error(
-                    `The assetsDirPath must be a subdirectory of reactAppBuildDirPath`
+                    `The assetsDirPath must be a subdirectory of projectBuildDirPath`
                 );
             }
 
@@ -93,7 +93,7 @@ export function replaceImportsInJsCode_vite(params: {
 
                 fixedJsCode = replaceAll(
                     fixedJsCode,
-                    `"${buildOptions.urlPathname ?? "/"}${relativePathOfAssetFile}"`,
+                    `"${buildContext.urlPathname ?? "/"}${relativePathOfAssetFile}"`,
                     `(window.${nameOfTheGlobal}.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/${relativePathOfAssetFile}")`
                 );
             });

package/src/bin/keycloakify/replacers/replaceImportsInJsCode/webpack.ts

@@ -3,28 +3,28 @@ import {
     basenameOfTheKeycloakifyResourcesDir
 } from "../../../shared/constants";
 import { assert } from "tsafe/assert";
-import type { BuildOptions } from "../../../shared/buildOptions";
+import type { BuildContext } from "../../../shared/buildContext";
 import * as nodePath from "path";
 import { replaceAll } from "../../../tools/String.prototype.replaceAll";
 
-export type BuildOptionsLike = {
-    reactAppBuildDirPath: string;
+export type BuildContextLike = {
+    projectBuildDirPath: string;
     assetsDirPath: string;
     urlPathname: string | undefined;
 };
 
-assert<BuildOptions extends BuildOptionsLike ? true : false>();
+assert<BuildContext extends BuildContextLike ? true : false>();
 
 export function replaceImportsInJsCode_webpack(params: {
     jsCode: string;
-    buildOptions: BuildOptionsLike;
+    buildContext: BuildContextLike;
     systemType?: "posix" | "win32";
 }): {
     fixedJsCode: string;
 } {
     const {
         jsCode,
-        buildOptions,
+        buildContext,
         systemType = nodePath.sep === "/" ? "posix" : "win32"
     } = params;
 
@@ -32,12 +32,12 @@ export function replaceImportsInJsCode_webpack(params: {
 
     let fixedJsCode = jsCode;
 
-    if (buildOptions.urlPathname !== undefined) {
+    if (buildContext.urlPathname !== undefined) {
         // "__esModule",{value:!0})},n.p="/foo-bar/",function(){if("undefined"  -> ... n.p="/" ...
         fixedJsCode = fixedJsCode.replace(
             new RegExp(
                 `,([a-zA-Z]\\.[a-zA-Z])="${replaceAll(
-                    buildOptions.urlPathname,
+                    buildContext.urlPathname,
                     "/",
                     "\\/"
                 )}",`,
@@ -50,15 +50,15 @@ export function replaceImportsInJsCode_webpack(params: {
     // Example: "static/ or "foo/bar/"
     const staticDir = (() => {
         let out = pathRelative(
-            buildOptions.reactAppBuildDirPath,
-            buildOptions.assetsDirPath
+            buildContext.projectBuildDirPath,
+            buildContext.assetsDirPath
         );
 
         out = replaceAll(out, pathSep, "/") + "/";
 
         if (out === "/") {
             throw new Error(
-                `The assetsDirPath must be a subdirectory of reactAppBuildDirPath`
+                `The assetsDirPath must be a subdirectory of projectBuildDirPath`
             );
         }
 

package/src/bin/main.ts

@@ -5,7 +5,7 @@ import { readThisNpmPackageVersion } from "./tools/readThisNpmPackageVersion";
 import * as child_process from "child_process";
 
 export type CliCommandOptions = {
-    reactAppRootDirPath: string | undefined;
+    projectDirPath: string | undefined;
 };
 
 const program = termost<CliCommandOptions>(
@@ -25,7 +25,7 @@ const program = termost<CliCommandOptions>(
 const optionsKeys: string[] = [];
 
 program.option({
-    key: "reactAppRootDirPath",
+    key: "projectDirPath",
     name: (() => {
         const long = "project";
         const short = "p";
@@ -205,6 +205,21 @@ program
         }
     });
 
+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 cliCommandOptions => {
+            const { command } = await import("./update-kc-gen");
+
+            await command({ cliCommandOptions });
+        }
+    });
+
 // Fallback to build command if no command is provided
 {
     const [, , ...rest] = process.argv;

package/src/bin/shared/{buildOptions.ts → buildContext.ts}

@@ -9,8 +9,7 @@ import { assert } from "tsafe";
 import * as child_process from "child_process";
 import { vitePluginSubScriptEnvNames } from "./constants";
 
-/** Consolidated build option gathered form CLI arguments and config in package.json */
-export type BuildOptions = {
+export type BuildContext = {
     bundler: "vite" | "webpack";
     themeVersion: string;
     themeNames: string[];
@@ -18,9 +17,8 @@ export type BuildOptions = {
     groupId: string;
     artifactId: string;
     loginThemeResourcesFromKeycloakVersion: string;
-    reactAppRootDirPath: string;
-    // TODO: Remove from vite type
-    reactAppBuildDirPath: string;
+    projectDirPath: string;
+    projectBuildDirPath: string;
     /** Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak */
     keycloakifyBuildDirPath: string;
     publicDirPath: string;
@@ -31,16 +29,18 @@ export type BuildOptions = {
     assetsDirPath: string;
     npmWorkspaceRootDirPath: string;
     kcContextExclusionsFtlCode: string | undefined;
+    environmentVariables: { name: string; default: string }[];
 };
 
-export type UserProvidedBuildOptions = {
+export type BuildOptions = {
+    themeName?: string | string[];
+    environmentVariables?: { name: string; default: string }[];
     extraThemeProperties?: string[];
     artifactId?: string;
     groupId?: string;
     loginThemeResourcesFromKeycloakVersion?: string;
     keycloakifyBuildDirPath?: string;
-    themeName?: string | string[];
-    kcContextExclusionsFtlCode?: string;
+    kcContextExclusionsFtl?: string;
 };
 
 export type ResolvedViteConfig = {
@@ -48,21 +48,21 @@ export type ResolvedViteConfig = {
     publicDir: string;
     assetsDir: string;
     urlPathname: string | undefined;
-    userProvidedBuildOptions: UserProvidedBuildOptions;
+    buildOptions: BuildOptions;
 };
 
-export function readBuildOptions(params: {
+export function getBuildContext(params: {
     cliCommandOptions: CliCommandOptions;
-}): BuildOptions {
+}): BuildContext {
     const { cliCommandOptions } = params;
 
-    const reactAppRootDirPath = (() => {
-        if (cliCommandOptions.reactAppRootDirPath === undefined) {
+    const projectDirPath = (() => {
+        if (cliCommandOptions.projectDirPath === undefined) {
             return process.cwd();
         }
 
         return getAbsoluteAndInOsFormatPath({
-            pathIsh: cliCommandOptions.reactAppRootDirPath,
+            pathIsh: cliCommandOptions.projectDirPath,
             cwd: process.cwd()
         });
     })();
@@ -70,7 +70,7 @@ export function readBuildOptions(params: {
     const { resolvedViteConfig } = (() => {
         if (
             fs
-                .readdirSync(reactAppRootDirPath)
+                .readdirSync(projectDirPath)
                 .find(fileBasename => fileBasename.startsWith("vite.config")) ===
             undefined
         ) {
@@ -79,7 +79,7 @@ export function readBuildOptions(params: {
 
         const output = child_process
             .execSync("npx vite", {
-                cwd: reactAppRootDirPath,
+                cwd: projectDirPath,
                 env: {
                     ...process.env,
                     [vitePluginSubScriptEnvNames.resolveViteConfig]: "true"
@@ -106,8 +106,8 @@ export function readBuildOptions(params: {
             name: string;
             version?: string;
             homepage?: string;
-            keycloakify?: UserProvidedBuildOptions & {
-                reactAppBuildDirPath?: string;
+            keycloakify?: BuildOptions & {
+                projectBuildDirPath?: string;
             };
         };
 
@@ -121,7 +121,7 @@ export function readBuildOptions(params: {
                     artifactId: z.string().optional(),
                     groupId: z.string().optional(),
                     loginThemeResourcesFromKeycloakVersion: z.string().optional(),
-                    reactAppBuildDirPath: z.string().optional(),
+                    projectBuildDirPath: z.string().optional(),
                     keycloakifyBuildDirPath: z.string().optional(),
                     themeName: z.union([z.string(), z.array(z.string())]).optional()
                 })
@@ -137,20 +137,18 @@ export function readBuildOptions(params: {
 
         return zParsedPackageJson.parse(
             JSON.parse(
-                fs
-                    .readFileSync(pathJoin(reactAppRootDirPath, "package.json"))
-                    .toString("utf8")
+                fs.readFileSync(pathJoin(projectDirPath, "package.json")).toString("utf8")
             )
         );
     })();
 
-    const userProvidedBuildOptions: UserProvidedBuildOptions = {
+    const buildOptions: BuildOptions = {
         ...parsedPackageJson.keycloakify,
-        ...resolvedViteConfig?.userProvidedBuildOptions
+        ...resolvedViteConfig?.buildOptions
     };
 
     const themeNames = (() => {
-        if (userProvidedBuildOptions.themeName === undefined) {
+        if (buildOptions.themeName === undefined) {
             return [
                 parsedPackageJson.name
                     .replace(/^@(.*)/, "$1")
@@ -159,34 +157,34 @@ export function readBuildOptions(params: {
             ];
         }
 
-        if (typeof userProvidedBuildOptions.themeName === "string") {
-            return [userProvidedBuildOptions.themeName];
+        if (typeof buildOptions.themeName === "string") {
+            return [buildOptions.themeName];
         }
 
-        return userProvidedBuildOptions.themeName;
+        return buildOptions.themeName;
     })();
 
-    const reactAppBuildDirPath = (() => {
+    const projectBuildDirPath = (() => {
         webpack: {
             if (resolvedViteConfig !== undefined) {
                 break webpack;
             }
 
-            if (parsedPackageJson.keycloakify?.reactAppBuildDirPath !== undefined) {
+            if (parsedPackageJson.keycloakify?.projectBuildDirPath !== undefined) {
                 return getAbsoluteAndInOsFormatPath({
-                    pathIsh: parsedPackageJson.keycloakify.reactAppBuildDirPath,
-                    cwd: reactAppRootDirPath
+                    pathIsh: parsedPackageJson.keycloakify.projectBuildDirPath,
+                    cwd: projectDirPath
                 });
             }
 
-            return pathJoin(reactAppRootDirPath, "build");
+            return pathJoin(projectDirPath, "build");
         }
 
-        return pathJoin(reactAppRootDirPath, resolvedViteConfig.buildDir);
+        return pathJoin(projectDirPath, resolvedViteConfig.buildDir);
     })();
 
     const { npmWorkspaceRootDirPath } = getNpmWorkspaceRootDirPath({
-        reactAppRootDirPath,
+        projectDirPath,
         dependencyExpected: "keycloakify"
     });
 
@@ -195,13 +193,13 @@ export function readBuildOptions(params: {
         themeVersion:
             process.env.KEYCLOAKIFY_THEME_VERSION ?? parsedPackageJson.version ?? "0.0.0",
         themeNames,
-        extraThemeProperties: userProvidedBuildOptions.extraThemeProperties,
+        extraThemeProperties: buildOptions.extraThemeProperties,
         groupId: (() => {
             const fallbackGroupId = `${themeNames[0]}.keycloak`;
 
             return (
                 process.env.KEYCLOAKIFY_GROUP_ID ??
-                userProvidedBuildOptions.groupId ??
+                buildOptions.groupId ??
                 (parsedPackageJson.homepage === undefined
                     ? fallbackGroupId
                     : urlParse(parsedPackageJson.homepage)
@@ -213,22 +211,22 @@ export function readBuildOptions(params: {
         })(),
         artifactId:
             process.env.KEYCLOAKIFY_ARTIFACT_ID ??
-            userProvidedBuildOptions.artifactId ??
+            buildOptions.artifactId ??
             `${themeNames[0]}-keycloak-theme`,
         loginThemeResourcesFromKeycloakVersion:
-            userProvidedBuildOptions.loginThemeResourcesFromKeycloakVersion ?? "24.0.4",
-        reactAppRootDirPath,
-        reactAppBuildDirPath,
+            buildOptions.loginThemeResourcesFromKeycloakVersion ?? "24.0.4",
+        projectDirPath,
+        projectBuildDirPath,
         keycloakifyBuildDirPath: (() => {
-            if (userProvidedBuildOptions.keycloakifyBuildDirPath !== undefined) {
+            if (buildOptions.keycloakifyBuildDirPath !== undefined) {
                 return getAbsoluteAndInOsFormatPath({
-                    pathIsh: userProvidedBuildOptions.keycloakifyBuildDirPath,
-                    cwd: reactAppRootDirPath
+                    pathIsh: buildOptions.keycloakifyBuildDirPath,
+                    cwd: projectDirPath
                 });
             }
 
             return pathJoin(
-                reactAppRootDirPath,
+                projectDirPath,
                 resolvedViteConfig?.buildDir === undefined
                     ? "build_keycloak"
                     : `${resolvedViteConfig.buildDir}_keycloak`
@@ -243,14 +241,14 @@ export function readBuildOptions(params: {
                 if (process.env.PUBLIC_DIR_PATH !== undefined) {
                     return getAbsoluteAndInOsFormatPath({
                         pathIsh: process.env.PUBLIC_DIR_PATH,
-                        cwd: reactAppRootDirPath
+                        cwd: projectDirPath
                     });
                 }
 
-                return pathJoin(reactAppRootDirPath, "public");
+                return pathJoin(projectDirPath, "public");
             }
 
-            return pathJoin(reactAppRootDirPath, resolvedViteConfig.publicDir);
+            return pathJoin(projectDirPath, resolvedViteConfig.publicDir);
         })(),
         cacheDirPath: (() => {
             const cacheDirPath = pathJoin(
@@ -299,12 +297,28 @@ export function readBuildOptions(params: {
                     break webpack;
                 }
 
-                return pathJoin(reactAppBuildDirPath, "static");
+                return pathJoin(projectBuildDirPath, "static");
             }
 
-            return pathJoin(reactAppBuildDirPath, resolvedViteConfig.assetsDir);
+            return pathJoin(projectBuildDirPath, resolvedViteConfig.assetsDir);
         })(),
         npmWorkspaceRootDirPath,
-        kcContextExclusionsFtlCode: userProvidedBuildOptions.kcContextExclusionsFtlCode
+        kcContextExclusionsFtlCode: (() => {
+            if (buildOptions.kcContextExclusionsFtl === undefined) {
+                return undefined;
+            }
+
+            if (buildOptions.kcContextExclusionsFtl.endsWith(".ftl")) {
+                const kcContextExclusionsFtlPath = getAbsoluteAndInOsFormatPath({
+                    pathIsh: buildOptions.kcContextExclusionsFtl,
+                    cwd: projectDirPath
+                });
+
+                return fs.readFileSync(kcContextExclusionsFtlPath).toString("utf8");
+            }
+
+            return buildOptions.kcContextExclusionsFtl;
+        })(),
+        environmentVariables: buildOptions.environmentVariables ?? []
     };
 }

package/src/bin/shared/copyKeycloakResourcesToPublic.ts

@@ -1,6 +1,6 @@
 import {
     downloadKeycloakStaticResources,
-    type BuildOptionsLike as BuildOptionsLike_downloadKeycloakStaticResources
+    type BuildContextLike as BuildContextLike_downloadKeycloakStaticResources
 } from "./downloadKeycloakStaticResources";
 import { join as pathJoin, relative as pathRelative } from "path";
 import {
@@ -12,21 +12,21 @@ import { readThisNpmPackageVersion } from "../tools/readThisNpmPackageVersion";
 import { assert } from "tsafe/assert";
 import * as fs from "fs";
 import { rmSync } from "../tools/fs.rmSync";
-import type { BuildOptions } from "./buildOptions";
+import type { BuildContext } from "./buildContext";
 
-export type BuildOptionsLike = BuildOptionsLike_downloadKeycloakStaticResources & {
+export type BuildContextLike = BuildContextLike_downloadKeycloakStaticResources & {
     loginThemeResourcesFromKeycloakVersion: string;
     publicDirPath: string;
 };
 
-assert<BuildOptions extends BuildOptionsLike ? true : false>();
+assert<BuildContext extends BuildContextLike ? true : false>();
 
 export async function copyKeycloakResourcesToPublic(params: {
-    buildOptions: BuildOptionsLike;
+    buildContext: BuildContextLike;
 }) {
-    const { buildOptions } = params;
+    const { buildContext } = params;
 
-    const destDirPath = pathJoin(buildOptions.publicDirPath, keycloak_resources);
+    const destDirPath = pathJoin(buildContext.publicDirPath, keycloak_resources);
 
     const keycloakifyBuildinfoFilePath = pathJoin(destDirPath, "keycloakify.buildinfo");
 
@@ -34,12 +34,12 @@ export async function copyKeycloakResourcesToPublic(params: {
         {
             destDirPath,
             keycloakifyVersion: readThisNpmPackageVersion(),
-            buildOptions: {
+            buildContext: {
                 loginThemeResourcesFromKeycloakVersion: readThisNpmPackageVersion(),
-                cacheDirPath: pathRelative(destDirPath, buildOptions.cacheDirPath),
+                cacheDirPath: pathRelative(destDirPath, buildContext.cacheDirPath),
                 npmWorkspaceRootDirPath: pathRelative(
                     destDirPath,
-                    buildOptions.npmWorkspaceRootDirPath
+                    buildContext.npmWorkspaceRootDirPath
                 )
             }
         },
@@ -74,14 +74,14 @@ export async function copyKeycloakResourcesToPublic(params: {
             keycloakVersion: (() => {
                 switch (themeType) {
                     case "login":
-                        return buildOptions.loginThemeResourcesFromKeycloakVersion;
+                        return buildContext.loginThemeResourcesFromKeycloakVersion;
                     case "account":
                         return lastKeycloakVersionWithAccountV1;
                 }
             })(),
             themeType,
             themeDirPath: destDirPath,
-            buildOptions
+            buildContext
         });
     }
 

package/src/bin/shared/downloadKeycloakDefaultTheme.ts

@@ -1,27 +1,27 @@
 import { join as pathJoin, relative as pathRelative } from "path";
-import { type BuildOptions } from "./buildOptions";
+import { type BuildContext } from "./buildContext";
 import { assert } from "tsafe/assert";
 import { lastKeycloakVersionWithAccountV1 } from "./constants";
 import { downloadAndExtractArchive } from "../tools/downloadAndExtractArchive";
 import { isInside } from "../tools/isInside";
 
-export type BuildOptionsLike = {
+export type BuildContextLike = {
     cacheDirPath: string;
     npmWorkspaceRootDirPath: string;
 };
 
-assert<BuildOptions extends BuildOptionsLike ? true : false>();
+assert<BuildContext extends BuildContextLike ? true : false>();
 
 export async function downloadKeycloakDefaultTheme(params: {
     keycloakVersion: string;
-    buildOptions: BuildOptionsLike;
+    buildContext: BuildContextLike;
 }): Promise<{ defaultThemeDirPath: string }> {
-    const { keycloakVersion, buildOptions } = params;
+    const { keycloakVersion, buildContext } = params;
 
     const { extractedDirPath } = await downloadAndExtractArchive({
         url: `https://repo1.maven.org/maven2/org/keycloak/keycloak-themes/${keycloakVersion}/keycloak-themes-${keycloakVersion}.jar`,
-        cacheDirPath: buildOptions.cacheDirPath,
-        npmWorkspaceRootDirPath: buildOptions.npmWorkspaceRootDirPath,
+        cacheDirPath: buildContext.cacheDirPath,
+        npmWorkspaceRootDirPath: buildContext.npmWorkspaceRootDirPath,
         uniqueIdOfOnOnArchiveFile: "downloadKeycloakDefaultTheme",
         onArchiveFile: async params => {
             if (!isInside({ dirPath: "theme", filePath: params.fileRelativePath })) {

package/src/bin/shared/downloadKeycloakStaticResources.ts

@@ -2,28 +2,28 @@ import { transformCodebase } from "../tools/transformCodebase";
 import { join as pathJoin } from "path";
 import {
     downloadKeycloakDefaultTheme,
-    type BuildOptionsLike as BuildOptionsLike_downloadKeycloakDefaultTheme
+    type BuildContextLike as BuildContextLike_downloadKeycloakDefaultTheme
 } from "./downloadKeycloakDefaultTheme";
 import { resources_common, type ThemeType } from "./constants";
-import type { BuildOptions } from "./buildOptions";
+import type { BuildContext } from "./buildContext";
 import { assert } from "tsafe/assert";
 import { existsAsync } from "../tools/fs.existsAsync";
 
-export type BuildOptionsLike = BuildOptionsLike_downloadKeycloakDefaultTheme & {};
+export type BuildContextLike = BuildContextLike_downloadKeycloakDefaultTheme & {};
 
-assert<BuildOptions extends BuildOptionsLike ? true : false>();
+assert<BuildContext extends BuildContextLike ? true : false>();
 
 export async function downloadKeycloakStaticResources(params: {
     themeType: ThemeType;
     themeDirPath: string;
     keycloakVersion: string;
-    buildOptions: BuildOptionsLike;
+    buildContext: BuildContextLike;
 }) {
-    const { themeType, themeDirPath, keycloakVersion, buildOptions } = params;
+    const { themeType, themeDirPath, keycloakVersion, buildContext } = params;
 
     const { defaultThemeDirPath } = await downloadKeycloakDefaultTheme({
         keycloakVersion,
-        buildOptions
+        buildContext
     });
 
     const resourcesDirPath = pathJoin(themeDirPath, themeType, "resources");

package/src/bin/shared/generateKcGenTs.ts

@@ -0,0 +1,61 @@
+import { assert } from "tsafe/assert";
+import type { BuildContext } from "./buildContext";
+import { getThemeSrcDirPath } from "./getThemeSrcDirPath";
+import * as fs from "fs/promises";
+import { join as pathJoin } from "path";
+
+export type BuildContextLike = {
+    projectDirPath: string;
+    themeNames: string[];
+    environmentVariables: { name: string; default: string }[];
+};
+
+assert<BuildContext extends BuildContextLike ? true : false>();
+
+export async function generateKcGenTs(params: {
+    buildContext: BuildContextLike;
+}): Promise<void> {
+    const { buildContext } = params;
+
+    const { themeSrcDirPath } = getThemeSrcDirPath({
+        projectDirPath: buildContext.projectDirPath
+    });
+
+    await fs.writeFile(
+        pathJoin(themeSrcDirPath, "kc.gen.ts"),
+        Buffer.from(
+            [
+                `/* prettier-ignore-start */`,
+                ``,
+                `/* eslint-disable */`,
+                ``,
+                `// @ts-nocheck`,
+                ``,
+                `// noinspection JSUnusedGlobalSymbols`,
+                ``,
+                `// This file is auto-generated by Keycloakify`,
+                ``,
+                `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
+                )};`,
+                ``,
+                `/* prettier-ignore-end */`
+            ].join("\n"),
+            "utf8"
+        )
+    );
+}