keycloakify 9.3.1 → 9.4.0-rc.1

package/src/bin/keycloakify/buildOptions/resolvedViteConfig.ts

@@ -0,0 +1,85 @@
+import * as fs from "fs";
+import { assert } from "tsafe";
+import type { Equals } from "tsafe";
+import { z } from "zod";
+import { join as pathJoin } from "path";
+import { resolvedViteConfigJsonBasename } from "../../constants";
+import type { OptionalIfCanBeUndefined } from "../../tools/OptionalIfCanBeUndefined";
+import { getKeycloakifyBuildDirPath } from "./getKeycloakifyBuildDirPath";
+
+export type ResolvedViteConfig = {
+    buildDir: string;
+    publicDir: string;
+    assetsDir: string;
+    urlPathname: string | undefined;
+};
+
+const zResolvedViteConfig = z.object({
+    "buildDir": z.string(),
+    "publicDir": z.string(),
+    "assetsDir": z.string(),
+    "urlPathname": z.string().optional()
+});
+
+{
+    type Got = ReturnType<(typeof zResolvedViteConfig)["parse"]>;
+    type Expected = OptionalIfCanBeUndefined<ResolvedViteConfig>;
+
+    assert<Equals<Got, Expected>>();
+}
+
+export function readResolvedViteConfig(params: {
+    reactAppRootDirPath: string;
+    parsedPackageJson_keycloakify_keycloakifyBuildDirPath: string | undefined;
+}):
+    | {
+          resolvedViteConfig: ResolvedViteConfig;
+      }
+    | undefined {
+    const { reactAppRootDirPath, parsedPackageJson_keycloakify_keycloakifyBuildDirPath } = params;
+
+    const viteConfigTsFilePath = pathJoin(reactAppRootDirPath, "vite.config.ts");
+
+    if (!fs.existsSync(viteConfigTsFilePath)) {
+        return undefined;
+    }
+
+    const { keycloakifyBuildDirPath } = getKeycloakifyBuildDirPath({
+        reactAppRootDirPath,
+        parsedPackageJson_keycloakify_keycloakifyBuildDirPath,
+        "bundler": "vite"
+    });
+
+    const resolvedViteConfig = (() => {
+        const resolvedViteConfigJsonFilePath = pathJoin(keycloakifyBuildDirPath, resolvedViteConfigJsonBasename);
+
+        if (!fs.existsSync(resolvedViteConfigJsonFilePath)) {
+            throw new Error("Missing Keycloakify Vite plugin output.");
+        }
+
+        let out: ResolvedViteConfig;
+
+        try {
+            out = JSON.parse(fs.readFileSync(resolvedViteConfigJsonFilePath).toString("utf8"));
+        } catch {
+            throw new Error("The output of the Keycloakify Vite plugin is not a valid JSON.");
+        }
+
+        try {
+            const zodParseReturn = zResolvedViteConfig.parse(out);
+
+            // So that objectKeys from tsafe return the expected result no matter what.
+            Object.keys(zodParseReturn)
+                .filter(key => !(key in out))
+                .forEach(key => {
+                    delete (out as any)[key];
+                });
+        } catch {
+            throw new Error("The output of the Keycloakify Vite plugin do not match the expected schema.");
+        }
+
+        return out;
+    })();
+
+    return { resolvedViteConfig };
+}

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

@@ -1,18 +1,20 @@
 import cheerio from "cheerio";
-import { replaceImportsFromStaticInJsCode } from "../replacers/replaceImportsFromStaticInJsCode";
+import { replaceImportsInJsCode } from "../replacers/replaceImportsInJsCode";
 import { generateCssCodeToDefineGlobals } from "../replacers/replaceImportsInCssCode";
 import { replaceImportsInInlineCssCode } from "../replacers/replaceImportsInInlineCssCode";
 import * as fs from "fs";
 import { join as pathJoin } from "path";
 import { objectKeys } from "tsafe/objectKeys";
-import { ftlValuesGlobalName } from "../ftlValuesGlobalName";
-import type { BuildOptions } from "../BuildOptions";
+import type { BuildOptions } from "../buildOptions";
 import { assert } from "tsafe/assert";
-import type { ThemeType } from "../../constants";
+import { type ThemeType, nameOfTheGlobal, basenameOfTheKeycloakifyResourcesDir } from "../../constants";
 
 export type BuildOptionsLike = {
+    bundler: "vite" | "webpack";
     themeVersion: string;
     urlPathname: string | undefined;
+    reactAppBuildDirPath: string;
+    assetsDirPath: string;
 };
 
 assert<BuildOptions extends BuildOptionsLike ? true : false>();
@@ -20,7 +22,6 @@ assert<BuildOptions extends BuildOptionsLike ? true : false>();
 export function generateFtlFilesCodeFactory(params: {
     themeName: string;
     indexHtmlCode: string;
-    //NOTE: Expected to be an empty object if external assets mode is enabled.
     cssGlobalsToDefine: Record<string, string>;
     buildOptions: BuildOptionsLike;
     keycloakifyVersion: string;
@@ -37,7 +38,7 @@ export function generateFtlFilesCodeFactory(params: {
 
             assert(jsCode !== null);
 
-            const { fixedJsCode } = replaceImportsFromStaticInJsCode({ jsCode });
+            const { fixedJsCode } = replaceImportsInJsCode({ jsCode, buildOptions });
 
             $(element).text(fixedJsCode);
         });
@@ -70,7 +71,10 @@ export function generateFtlFilesCodeFactory(params: {
 
                 $(element).attr(
                     attrName,
-                    href.replace(new RegExp(`^${(buildOptions.urlPathname ?? "/").replace(/\//g, "\\/")}`), "${url.resourcesPath}/build/")
+                    href.replace(
+                        new RegExp(`^${(buildOptions.urlPathname ?? "/").replace(/\//g, "\\/")}`),
+                        `\${url.resourcesPath}/${basenameOfTheKeycloakifyResourcesDir}/`
+                    )
                 );
             })
         );
@@ -114,7 +118,7 @@ export function generateFtlFilesCodeFactory(params: {
     $("head").prepend(
         [
             "<script>",
-            `    window.${ftlValuesGlobalName}= ${objectKeys(replaceValueBySearchValue)[0]};`,
+            `    window.${nameOfTheGlobal}= ${objectKeys(replaceValueBySearchValue)[0]};`,
             "</script>",
             "",
             objectKeys(replaceValueBySearchValue)[1]

package/src/bin/keycloakify/generatePom.ts

@@ -0,0 +1,70 @@
+import { assert } from "tsafe/assert";
+import { Reflect } from "tsafe/Reflect";
+import type { BuildOptions } from "./buildOptions";
+
+type BuildOptionsLike = {
+    groupId: string;
+    artifactId: string;
+    themeVersion: string;
+    keycloakifyBuildDirPath: string;
+};
+
+{
+    const buildOptions = Reflect<BuildOptions>();
+
+    assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
+}
+
+export function generatePom(params: { buildOptions: BuildOptionsLike }) {
+    const { buildOptions } = params;
+
+    const { pomFileCode } = (function generatePomFileCode(): {
+        pomFileCode: string;
+    } {
+        const pomFileCode = [
+            `<?xml version="1.0"?>`,
+            `<project xmlns="http://maven.apache.org/POM/4.0.0"`,
+            `	 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"`,
+            `	 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">`,
+            `  <modelVersion>4.0.0</modelVersion>`,
+            `	<groupId>${buildOptions.groupId}</groupId>`,
+            `	<artifactId>${buildOptions.artifactId}</artifactId>`,
+            `	<version>${buildOptions.themeVersion}</version>`,
+            `	<name>${buildOptions.artifactId}</name>`,
+            `  <description />`,
+            `  <packaging>jar</packaging>`,
+            `  <properties>`,
+            `    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>`,
+            `  </properties>`,
+            `  <build>`,
+            `    <plugins>`,
+            `      <plugin>`,
+            `        <groupId>org.apache.maven.plugins</groupId>`,
+            `        <artifactId>maven-shade-plugin</artifactId>`,
+            `	     <version>3.5.1</version>`,
+            `        <executions>`,
+            `          <execution>`,
+            `            <phase>package</phase>`,
+            `            <goals>`,
+            `              <goal>shade</goal>`,
+            `            </goals>`,
+            `          </execution>`,
+            `        </executions>`,
+            `      </plugin>`,
+            `    </plugins>`,
+            `  </build>`,
+            `  <dependencies>`,
+            `    <dependency>`,
+            `      <groupId>io.phasetwo.keycloak</groupId>`,
+            `      <artifactId>keycloak-account-v1</artifactId>`,
+            `      <version>0.1</version>`,
+            `    </dependency>`,
+            `  </dependencies>`,
+            `</project>`
+        ].join("\n");
+
+        return { pomFileCode };
+    })();
+
+    return { pomFileCode };
+}

package/src/bin/keycloakify/generateStartKeycloakTestingContainer.ts

@@ -2,7 +2,7 @@ import * as fs from "fs";
 import { join as pathJoin, relative as pathRelative, basename as pathBasename } from "path";
 import { assert } from "tsafe/assert";
 import { Reflect } from "tsafe/Reflect";
-import type { BuildOptions } from "./BuildOptions";
+import type { BuildOptions } from "./buildOptions";
 
 export type BuildOptionsLike = {
     keycloakifyBuildDirPath: string;

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

@@ -0,0 +1,83 @@
+import * as fs from "fs";
+import { join as pathJoin } from "path";
+import { assert } from "tsafe/assert";
+import { Reflect } from "tsafe/Reflect";
+import type { BuildOptions } from "../buildOptions";
+import { resources_common, lastKeycloakVersionWithAccountV1, accountV1ThemeName } from "../../constants";
+import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
+import { transformCodebase } from "../../tools/transformCodebase";
+import { rmSync } from "../../tools/fs.rmSync";
+
+type BuildOptionsLike = {
+    keycloakifyBuildDirPath: string;
+    cacheDirPath: string;
+};
+
+{
+    const buildOptions = Reflect<BuildOptions>();
+
+    assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
+}
+
+export async function bringInAccountV1(params: { buildOptions: BuildOptionsLike }) {
+    const { buildOptions } = params;
+
+    const builtinKeycloakThemeTmpDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "..", "tmp_yxdE2_builtin_keycloak_theme");
+
+    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/generateTheme/downloadKeycloakStaticResources.ts

@@ -1,11 +1,11 @@
 import { transformCodebase } from "../../tools/transformCodebase";
-import * as fs from "fs";
-import { join as pathJoin, dirname as pathDirname } from "path";
+import { join as pathJoin } from "path";
 import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
 import { resources_common, type ThemeType } from "../../constants";
-import { BuildOptions } from "../BuildOptions";
+import { BuildOptions } from "../buildOptions";
 import { assert } from "tsafe/assert";
 import * as crypto from "crypto";
+import { rmSync } from "../../tools/fs.rmSync";
 
 export type BuildOptionsLike = {
     cacheDirPath: string;
@@ -13,45 +13,14 @@ export type BuildOptionsLike = {
 
 assert<BuildOptions extends BuildOptionsLike ? true : false>();
 
-export async function downloadKeycloakStaticResources(
-    // prettier-ignore
-    params: {
-        themeType: ThemeType;
-        themeDirPath: string;
-        keycloakVersion: string;
-        usedResources: {
-            resourcesCommonFilePaths: string[];
-        } | undefined;
-        buildOptions: BuildOptionsLike;
-    }
-) {
+export async function downloadKeycloakStaticResources(params: {
+    themeType: ThemeType;
+    themeDirPath: string;
+    keycloakVersion: string;
+    buildOptions: BuildOptionsLike;
+}) {
     const { themeType, themeDirPath, keycloakVersion, buildOptions } = params;
 
-    // NOTE: Hack for 427
-    const usedResources = (() => {
-        const { usedResources } = params;
-
-        if (usedResources === undefined) {
-            return undefined;
-        }
-
-        assert(usedResources !== undefined);
-
-        return {
-            "resourcesCommonDirPaths": usedResources.resourcesCommonFilePaths.map(filePath => {
-                {
-                    const splitArg = "/dist/";
-
-                    if (filePath.includes(splitArg)) {
-                        return filePath.split(splitArg)[0] + splitArg;
-                    }
-                }
-
-                return pathDirname(filePath);
-            })
-        };
-    })();
-
     const tmpDirPath = pathJoin(
         themeDirPath,
         `tmp_suLeKsxId_${crypto.createHash("sha256").update(`${themeType}-${keycloakVersion}`).digest("hex").slice(0, 8)}`
@@ -72,18 +41,8 @@ export async function downloadKeycloakStaticResources(
 
     transformCodebase({
         "srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
-        "destDirPath": pathJoin(resourcesPath, resources_common),
-        "transformSourceCode":
-            usedResources === undefined
-                ? undefined
-                : ({ fileRelativePath, sourceCode }) => {
-                      if (usedResources.resourcesCommonDirPaths.find(dirPath => fileRelativePath.startsWith(dirPath)) === undefined) {
-                          return undefined;
-                      }
-
-                      return { "modifiedSourceCode": sourceCode };
-                  }
+        "destDirPath": pathJoin(resourcesPath, resources_common)
     });
 
-    fs.rmSync(tmpDirPath, { "recursive": true, "force": true });
+    rmSync(tmpDirPath, { "recursive": true, "force": true });
 }