keycloakify 10.0.0-rc.90 → 10.0.0-rc.91

package/src/bin/keycloakify/generateFtl/generateFtl.ts

@@ -1,6 +1,12 @@
 import cheerio from "cheerio";
-import { replaceImportsInJsCode } from "../replacers/replaceImportsInJsCode";
-import { replaceImportsInCssCode } from "../replacers/replaceImportsInCssCode";
+import {
+    replaceImportsInJsCode,
+    BuildContextLike as BuildContextLike_replaceImportsInJsCode
+} from "../replacers/replaceImportsInJsCode";
+import {
+    replaceImportsInCssCode,
+    BuildContextLike as BuildContextLike_replaceImportsInCssCode
+} from "../replacers/replaceImportsInCssCode";
 import * as fs from "fs";
 import { join as pathJoin } from "path";
 import type { BuildContext } from "../../shared/buildContext";
@@ -12,14 +18,12 @@ import {
 } from "../../shared/constants";
 import { getThisCodebaseRootDirPath } from "../../tools/getThisCodebaseRootDirPath";
 
-export type BuildContextLike = {
-    bundler: "vite" | "webpack";
-    themeVersion: string;
-    urlPathname: string | undefined;
-    projectBuildDirPath: string;
-    assetsDirPath: string;
-    kcContextExclusionsFtlCode: string | undefined;
-};
+export type BuildContextLike = BuildContextLike_replaceImportsInJsCode &
+    BuildContextLike_replaceImportsInCssCode & {
+        urlPathname: string | undefined;
+        themeVersion: string;
+        kcContextExclusionsFtlCode: string | undefined;
+    };
 
 assert<BuildContext extends BuildContextLike ? true : false>();
 

package/src/bin/keycloakify/generateResources/generateResourcesForMainTheme.ts

@@ -53,6 +53,7 @@ export type BuildContextLike = BuildContextLike_kcContextExclusionsFtlCode &
         environmentVariables: { name: string; default: string }[];
         recordIsImplementedByThemeType: BuildContext["recordIsImplementedByThemeType"];
         themeSrcDirPath: string;
+        bundler: { type: "vite" } | { type: "webpack" };
     };
 
 assert<BuildContext extends BuildContextLike ? true : false>();
@@ -113,7 +114,7 @@ export async function generateResourcesForMainTheme(params: {
                 );
 
                 if (fs.existsSync(dirPath)) {
-                    assert(buildContext.bundler === "webpack");
+                    assert(buildContext.bundler.type === "webpack");
 
                     throw new Error(
                         [

package/src/bin/keycloakify/keycloakify.ts

@@ -12,12 +12,6 @@ import * as os from "os";
 import { rmSync } from "../tools/fs.rmSync";
 
 export async function command(params: { cliCommandOptions: CliCommandOptions }) {
-    console.log("DEBUG:", {
-        __filename,
-        __dirname,
-        "process.cwd()": process.cwd()
-    });
-
     exit_if_maven_not_installed: {
         let commandOutput: Buffer | undefined = undefined;
 
@@ -91,7 +85,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
     });
 
     run_post_build_script: {
-        if (buildContext.bundler !== "vite") {
+        if (buildContext.bundler.type !== "vite") {
             break run_post_build_script;
         }
 

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

@@ -8,7 +8,7 @@ export type BuildContextLike = {
     projectBuildDirPath: string;
     assetsDirPath: string;
     urlPathname: string | undefined;
-    bundler: "vite" | "webpack";
+    bundler: { type: "vite" } | { type: "webpack" };
 };
 
 assert<BuildContext extends BuildContextLike ? true : false>();
@@ -20,7 +20,7 @@ export function replaceImportsInJsCode(params: {
     const { jsCode, buildContext } = params;
 
     const { fixedJsCode } = (() => {
-        switch (buildContext.bundler) {
+        switch (buildContext.bundler.type) {
             case "vite":
                 return replaceImportsInJsCode_vite({
                     jsCode,

package/src/bin/shared/buildContext.ts

@@ -1,7 +1,12 @@
 import { parse as urlParse } from "url";
-import { join as pathJoin } from "path";
+import {
+    join as pathJoin,
+    sep as pathSep,
+    relative as pathRelative,
+    resolve as pathResolve,
+    dirname as pathDirname
+} from "path";
 import { getAbsoluteAndInOsFormatPath } from "../tools/getAbsoluteAndInOsFormatPath";
-import { getNpmWorkspaceRootDirPath } from "../tools/getNpmWorkspaceRootDirPath";
 import type { CliCommandOptions } from "../main";
 import { z } from "zod";
 import * as fs from "fs";
@@ -21,9 +26,9 @@ import { type ThemeType } from "./constants";
 import { id } from "tsafe/id";
 import { symToStr } from "tsafe/symToStr";
 import chalk from "chalk";
+import { getProxyFetchOptions, type ProxyFetchOptions } from "../tools/fetchProxyOptions";
 
 export type BuildContext = {
-    bundler: "vite" | "webpack";
     themeVersion: string;
     themeNames: [string, ...string[]];
     extraThemeProperties: string[] | undefined;
@@ -40,7 +45,7 @@ export type BuildContext = {
      * In this case the urlPathname will be "/my-app/" */
     urlPathname: string | undefined;
     assetsDirPath: string;
-    npmWorkspaceRootDirPath: string;
+    fetchOptions: ProxyFetchOptions;
     kcContextExclusionsFtlCode: string | undefined;
     environmentVariables: { name: string; default: string }[];
     themeSrcDirPath: string;
@@ -49,6 +54,15 @@ export type BuildContext = {
         keycloakVersionRange: KeycloakVersionRange;
         jarFileBasename: string;
     }[];
+    bundler:
+        | {
+              type: "vite";
+          }
+        | {
+              type: "webpack";
+              packageJsonDirPath: string;
+              packageJsonScripts: Record<string, string>;
+          };
 };
 
 export type BuildOptions = {
@@ -90,20 +104,55 @@ export function getBuildContext(params: {
 }): BuildContext {
     const { cliCommandOptions } = params;
 
-    console.log("DEBUG:", { cliCommandOptions });
+    const projectDirPath =
+        cliCommandOptions.projectDirPath !== undefined
+            ? getAbsoluteAndInOsFormatPath({
+                  pathIsh: cliCommandOptions.projectDirPath,
+                  cwd: process.cwd()
+              })
+            : process.cwd();
+
+    const { themeSrcDirPath } = (() => {
+        const srcDirPath = pathJoin(projectDirPath, "src");
 
-    const projectDirPath = (() => {
-        if (cliCommandOptions.projectDirPath === undefined) {
-            return process.cwd();
+        const themeSrcDirPath: string | undefined = crawl({
+            dirPath: srcDirPath,
+            returnedPathsType: "relative to dirPath"
+        })
+            .map(fileRelativePath => {
+                for (const themeSrcDirBasename of ["keycloak-theme", "keycloak_theme"]) {
+                    const split = fileRelativePath.split(themeSrcDirBasename);
+                    if (split.length === 2) {
+                        return pathJoin(srcDirPath, split[0] + themeSrcDirBasename);
+                    }
+                }
+                return undefined;
+            })
+            .filter(exclude(undefined))[0];
+
+        if (themeSrcDirPath !== undefined) {
+            return { themeSrcDirPath };
         }
 
-        return getAbsoluteAndInOsFormatPath({
-            pathIsh: cliCommandOptions.projectDirPath,
-            cwd: process.cwd()
-        });
-    })();
+        for (const themeType of [...themeTypes, "email"]) {
+            if (!fs.existsSync(pathJoin(srcDirPath, themeType))) {
+                continue;
+            }
+            return { themeSrcDirPath: srcDirPath };
+        }
 
-    console.log("DEBUG:", { projectDirPath });
+        console.log(
+            chalk.red(
+                [
+                    `Can't locate your Keycloak theme source directory in .${pathSep}${pathRelative(process.cwd(), srcDirPath)}`,
+                    `Make sure to either use the Keycloakify CLI in the root of your Keycloakify project or use the --project CLI option`,
+                    `If you are collocating your Keycloak theme with your app you must have a directory named 'keycloak-theme' or 'keycloak_theme' in your 'src' directory`
+                ].join("\n")
+            )
+        );
+
+        process.exit(1);
+    })();
 
     const { resolvedViteConfig } = (() => {
         if (
@@ -139,7 +188,39 @@ export function getBuildContext(params: {
         return { resolvedViteConfig };
     })();
 
-    console.log("DEBUG:", { resolvedViteConfig });
+    const packageJsonFilePath = (function getPackageJSonDirPath(upCount: number): string {
+        const dirPath = pathResolve(
+            pathJoin(...[projectDirPath, ...Array(upCount).fill("..")])
+        );
+
+        assert(dirPath !== pathSep, "Root package.json not found");
+
+        success: {
+            const packageJsonFilePath = pathJoin(dirPath, "package.json");
+
+            if (!fs.existsSync(packageJsonFilePath)) {
+                break success;
+            }
+
+            const parsedPackageJson = z
+                .object({
+                    dependencies: z.record(z.string()).optional(),
+                    devDependencies: z.record(z.string()).optional()
+                })
+                .parse(JSON.parse(fs.readFileSync(packageJsonFilePath).toString("utf8")));
+
+            if (
+                parsedPackageJson.dependencies?.keycloakify === undefined &&
+                parsedPackageJson.devDependencies?.keycloakify === undefined
+            ) {
+                break success;
+            }
+
+            return packageJsonFilePath;
+        }
+
+        return getPackageJSonDirPath(upCount + 1);
+    })(0);
 
     const parsedPackageJson = (() => {
         type BuildOptions_packageJson = BuildOptions & {
@@ -149,14 +230,14 @@ export function getBuildContext(params: {
         };
 
         type ParsedPackageJson = {
-            name: string;
+            name?: string;
             version?: string;
             homepage?: string;
             keycloakify?: BuildOptions_packageJson;
         };
 
         const zParsedPackageJson = z.object({
-            name: z.string(),
+            name: z.string().optional(),
             version: z.string().optional(),
             homepage: z.string().optional(),
             keycloakify: id<z.ZodType<BuildOptions_packageJson>>(
@@ -234,63 +315,24 @@ export function getBuildContext(params: {
             assert<Equals<Got, Expected>>();
         }
 
+        const configurationPackageJsonFilePath = (() => {
+            const rootPackageJsonFilePath = pathJoin(projectDirPath, "package.json");
+
+            return fs.existsSync(rootPackageJsonFilePath)
+                ? rootPackageJsonFilePath
+                : packageJsonFilePath;
+        })();
+
         return zParsedPackageJson.parse(
-            JSON.parse(
-                fs.readFileSync(pathJoin(projectDirPath, "package.json")).toString("utf8")
-            )
+            JSON.parse(fs.readFileSync(configurationPackageJsonFilePath).toString("utf8"))
         );
     })();
 
-    console.log("DEBUG:", { parsedPackageJson });
-
     const buildOptions = {
         ...parsedPackageJson.keycloakify,
         ...resolvedViteConfig?.buildOptions
     };
 
-    console.log("DEBUG:", { buildOptions });
-
-    const { themeSrcDirPath } = (() => {
-        const srcDirPath = pathJoin(projectDirPath, "src");
-
-        const themeSrcDirPath: string | undefined = crawl({
-            dirPath: srcDirPath,
-            returnedPathsType: "relative to dirPath"
-        })
-            .map(fileRelativePath => {
-                for (const themeSrcDirBasename of ["keycloak-theme", "keycloak_theme"]) {
-                    const split = fileRelativePath.split(themeSrcDirBasename);
-                    if (split.length === 2) {
-                        return pathJoin(srcDirPath, split[0] + themeSrcDirBasename);
-                    }
-                }
-                return undefined;
-            })
-            .filter(exclude(undefined))[0];
-
-        if (themeSrcDirPath !== undefined) {
-            return { themeSrcDirPath };
-        }
-
-        for (const themeType of [...themeTypes, "email"]) {
-            if (!fs.existsSync(pathJoin(srcDirPath, themeType))) {
-                continue;
-            }
-            return { themeSrcDirPath: srcDirPath };
-        }
-
-        console.log(
-            chalk.red(
-                [
-                    "Can't locate your keycloak theme source directory.",
-                    "See: https://docs.keycloakify.dev/v/v10/keycloakify-in-my-app/collocation"
-                ].join("\n")
-            )
-        );
-
-        process.exit(1);
-    })();
-
     const recordIsImplementedByThemeType = objectFromEntries(
         (["login", "account", "email"] as const).map(themeType => [
             themeType,
@@ -298,16 +340,16 @@ export function getBuildContext(params: {
         ])
     );
 
-    console.log("DEBUG:", { themeSrcDirPath });
-
     const themeNames = ((): [string, ...string[]] => {
         if (buildOptions.themeName === undefined) {
-            return [
-                parsedPackageJson.name
-                    .replace(/^@(.*)/, "$1")
-                    .split("/")
-                    .join("-")
-            ];
+            return parsedPackageJson.name === undefined
+                ? ["keycloakify"]
+                : [
+                      parsedPackageJson.name
+                          .replace(/^@(.*)/, "$1")
+                          .split("/")
+                          .join("-")
+                  ];
         }
 
         if (typeof buildOptions.themeName === "string") {
@@ -321,8 +363,6 @@ export function getBuildContext(params: {
         return [mainThemeName, ...themeVariantNames];
     })();
 
-    console.log("DEBUG:", { themeNames });
-
     const projectBuildDirPath = (() => {
         webpack: {
             if (resolvedViteConfig !== undefined) {
@@ -342,19 +382,29 @@ export function getBuildContext(params: {
         return pathJoin(projectDirPath, resolvedViteConfig.buildDir);
     })();
 
-    console.log("DEBUG:", { projectBuildDirPath });
-
-    const { npmWorkspaceRootDirPath } = getNpmWorkspaceRootDirPath({
-        projectDirPath,
-        dependencyExpected: "keycloakify"
-    });
-
-    console.log("DEBUG:", { npmWorkspaceRootDirPath });
-
     const bundler = resolvedViteConfig !== undefined ? "vite" : "webpack";
 
-    const buildContext: BuildContext = {
-        bundler,
+    return {
+        bundler:
+            resolvedViteConfig !== undefined
+                ? { type: "vite" }
+                : (() => {
+                      const { scripts } = z
+                          .object({
+                              scripts: z.record(z.string()).optional()
+                          })
+                          .parse(
+                              JSON.parse(
+                                  fs.readFileSync(packageJsonFilePath).toString("utf8")
+                              )
+                          );
+
+                      return {
+                          type: "webpack",
+                          packageJsonDirPath: pathDirname(packageJsonFilePath),
+                          packageJsonScripts: scripts ?? {}
+                      };
+                  })(),
         themeVersion: buildOptions.themeVersion ?? parsedPackageJson.version ?? "0.0.0",
         themeNames,
         extraThemeProperties: buildOptions.extraThemeProperties,
@@ -431,7 +481,11 @@ export function getBuildContext(params: {
                         });
                     }
 
-                    return pathJoin(npmWorkspaceRootDirPath, "node_modules", ".cache");
+                    return pathJoin(
+                        pathDirname(packageJsonFilePath),
+                        "node_modules",
+                        ".cache"
+                    );
                 })(),
                 "keycloakify"
             );
@@ -480,7 +534,6 @@ export function getBuildContext(params: {
 
             return pathJoin(projectBuildDirPath, resolvedViteConfig.assetsDir);
         })(),
-        npmWorkspaceRootDirPath,
         kcContextExclusionsFtlCode: (() => {
             if (buildOptions.kcContextExclusionsFtl === undefined) {
                 return undefined;
@@ -500,6 +553,33 @@ export function getBuildContext(params: {
         environmentVariables: buildOptions.environmentVariables ?? [],
         recordIsImplementedByThemeType,
         themeSrcDirPath,
+        fetchOptions: getProxyFetchOptions({
+            npmConfigGetCwd: (function callee(upCount: number): string {
+                const dirPath = pathResolve(
+                    pathJoin(...[projectDirPath, ...Array(upCount).fill("..")])
+                );
+
+                assert(
+                    dirPath !== pathSep,
+                    "Couldn't find a place to run 'npm config get'"
+                );
+
+                try {
+                    child_process.execSync("npm config get", {
+                        cwd: dirPath,
+                        stdio: "ignore"
+                    });
+                } catch (error) {
+                    if (String(error).includes("ENOWORKSPACES")) {
+                        return callee(upCount + 1);
+                    }
+
+                    throw error;
+                }
+
+                return dirPath;
+            })(0)
+        }),
         jarTargets: (() => {
             const getDefaultJarFileBasename = (range: string) =>
                 `keycloak-theme-for-kc-${range}.jar`;
@@ -783,8 +863,4 @@ export function getBuildContext(params: {
             return jarTargets;
         })()
     };
-
-    console.log("DEBUG:", JSON.stringify({ buildContext }, null, 2));
-
-    return buildContext;
 }

package/src/bin/shared/copyKeycloakResourcesToPublic.ts

@@ -37,10 +37,7 @@ export async function copyKeycloakResourcesToPublic(params: {
             buildContext: {
                 loginThemeResourcesFromKeycloakVersion: readThisNpmPackageVersion(),
                 cacheDirPath: pathRelative(destDirPath, buildContext.cacheDirPath),
-                npmWorkspaceRootDirPath: pathRelative(
-                    destDirPath,
-                    buildContext.npmWorkspaceRootDirPath
-                )
+                fetchOptions: buildContext.fetchOptions
             }
         },
         null,

package/src/bin/shared/downloadKeycloakDefaultTheme.ts

@@ -6,7 +6,7 @@ import { downloadAndExtractArchive } from "../tools/downloadAndExtractArchive";
 
 export type BuildContextLike = {
     cacheDirPath: string;
-    npmWorkspaceRootDirPath: string;
+    fetchOptions: BuildContext["fetchOptions"];
 };
 
 assert<BuildContext extends BuildContextLike ? true : false>();
@@ -23,7 +23,7 @@ export async function downloadKeycloakDefaultTheme(params: {
     const { extractedDirPath } = await downloadAndExtractArchive({
         url: `https://repo1.maven.org/maven2/org/keycloak/keycloak-themes/${keycloakVersion}/keycloak-themes-${keycloakVersion}.jar`,
         cacheDirPath: buildContext.cacheDirPath,
-        npmWorkspaceRootDirPath: buildContext.npmWorkspaceRootDirPath,
+        fetchOptions: buildContext.fetchOptions,
         uniqueIdOfOnOnArchiveFile: "downloadKeycloakDefaultTheme",
         onArchiveFile: async params => {
             const fileRelativePath = pathRelative("theme", params.fileRelativePath);