keycloakify 11.7.3 → 11.8.0

package/bin/main.js

@@ -15698,26 +15698,54 @@ function getBuildContext(params) {
         }
         (0,assert/* assert */.h)(false);
     })();
-    const implementedThemeTypes = {
-        login: {
-            isImplemented: external_fs_.existsSync((0,external_path_.join)(themeSrcDirPath, "login"))
-        },
-        email: {
-            isImplemented: external_fs_.existsSync((0,external_path_.join)(themeSrcDirPath, "email"))
-        },
-        account: (() => {
-            if (buildOptions.accountThemeImplementation === "none") {
-                return { isImplemented: false };
-            }
-            return {
-                isImplemented: true,
-                type: buildOptions.accountThemeImplementation
-            };
-        })(),
-        admin: {
-            isImplemented: external_fs_.existsSync((0,external_path_.join)(themeSrcDirPath, "admin"))
-        }
-    };
+    const implementedThemeTypes = (() => {
+        const getIsNative = (dirPath) => external_fs_.existsSync((0,external_path_.join)(dirPath, "theme.properties"));
+        return {
+            login: (() => {
+                const dirPath = (0,external_path_.join)(themeSrcDirPath, "login");
+                if (!external_fs_.existsSync(dirPath)) {
+                    return { isImplemented: false, isImplemented_native: false };
+                }
+                if (getIsNative(dirPath)) {
+                    return { isImplemented: false, isImplemented_native: true };
+                }
+                return { isImplemented: true };
+            })(),
+            email: (() => {
+                const dirPath = (0,external_path_.join)(themeSrcDirPath, "email");
+                if (!external_fs_.existsSync(dirPath) || !getIsNative(dirPath)) {
+                    return { isImplemented: false, isImplemented_native: false };
+                }
+                return { isImplemented: false, isImplemented_native: true };
+            })(),
+            account: (() => {
+                const dirPath = (0,external_path_.join)(themeSrcDirPath, "account");
+                if (!external_fs_.existsSync(dirPath)) {
+                    return { isImplemented: false, isImplemented_native: false };
+                }
+                if (getIsNative(dirPath)) {
+                    return { isImplemented: false, isImplemented_native: true };
+                }
+                if (buildOptions.accountThemeImplementation === "none") {
+                    return { isImplemented: false, isImplemented_native: false };
+                }
+                return {
+                    isImplemented: true,
+                    type: buildOptions.accountThemeImplementation
+                };
+            })(),
+            admin: (() => {
+                const dirPath = (0,external_path_.join)(themeSrcDirPath, "admin");
+                if (!external_fs_.existsSync(dirPath)) {
+                    return { isImplemented: false, isImplemented_native: false };
+                }
+                if (getIsNative(dirPath)) {
+                    return { isImplemented: false, isImplemented_native: true };
+                }
+                return { isImplemented: true };
+            })()
+        };
+    })();
     if (implementedThemeTypes.account.isImplemented &&
         !external_fs_.existsSync((0,external_path_.join)(themeSrcDirPath, "account"))) {
         console.error(source_default().red([
@@ -16201,7 +16229,7 @@ program
     .task({
     skip,
     handler: async ({ projectDirPath, keycloakVersion, port, realmJsonFilePath }) => {
-        const { command } = await Promise.all(/* import() */[__nccwpck_require__.e(33), __nccwpck_require__.e(911), __nccwpck_require__.e(678), __nccwpck_require__.e(9), __nccwpck_require__.e(947)]).then(__nccwpck_require__.bind(__nccwpck_require__, 32947));
+        const { command } = await Promise.all(/* import() */[__nccwpck_require__.e(33), __nccwpck_require__.e(297), __nccwpck_require__.e(97)]).then(__nccwpck_require__.bind(__nccwpck_require__, 64097));
         await command({
             buildContext: getBuildContext({ projectDirPath }),
             cliCommandOptions: {
@@ -16232,7 +16260,7 @@ program
     .task({
     skip,
     handler: async ({ projectDirPath }) => {
-        const { command } = await __nccwpck_require__.e(/* import() */ 97).then(__nccwpck_require__.bind(__nccwpck_require__, 98097));
+        const { command } = await __nccwpck_require__.e(/* import() */ 369).then(__nccwpck_require__.bind(__nccwpck_require__, 98097));
         await command({ buildContext: getBuildContext({ projectDirPath }) });
     }
 });
@@ -16244,7 +16272,7 @@ program
     .task({
     skip,
     handler: async ({ projectDirPath }) => {
-        const { command } = await Promise.all(/* import() */[__nccwpck_require__.e(911), __nccwpck_require__.e(9), __nccwpck_require__.e(313)]).then(__nccwpck_require__.bind(__nccwpck_require__, 16932));
+        const { command } = await Promise.all(/* import() */[__nccwpck_require__.e(664), __nccwpck_require__.e(932)]).then(__nccwpck_require__.bind(__nccwpck_require__, 16932));
         await command({ buildContext: getBuildContext({ projectDirPath }) });
     }
 });
@@ -16268,7 +16296,7 @@ program
     .task({
     skip,
     handler: async ({ projectDirPath }) => {
-        const { command } = await __nccwpck_require__.e(/* import() */ 355).then(__nccwpck_require__.bind(__nccwpck_require__, 60355));
+        const { command } = await Promise.all(/* import() */[__nccwpck_require__.e(664), __nccwpck_require__.e(355)]).then(__nccwpck_require__.bind(__nccwpck_require__, 60355));
         await command({ buildContext: getBuildContext({ projectDirPath }) });
     }
 });

package/bin/shared/buildContext.d.ts

@@ -25,19 +25,27 @@ export type BuildContext = {
     themeSrcDirPath: string;
     implementedThemeTypes: {
         login: {
-            isImplemented: boolean;
+            isImplemented: true;
+        } | {
+            isImplemented: false;
+            isImplemented_native: boolean;
         };
         email: {
-            isImplemented: boolean;
+            isImplemented: false;
+            isImplemented_native: boolean;
         };
         account: {
             isImplemented: false;
+            isImplemented_native: boolean;
         } | {
             isImplemented: true;
             type: "Single-Page" | "Multi-Page";
         };
         admin: {
-            isImplemented: boolean;
+            isImplemented: true;
+        } | {
+            isImplemented: false;
+            isImplemented_native: boolean;
         };
     };
     packageJsonFilePath: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "keycloakify",
-    "version": "11.7.3",
+    "version": "11.8.0",
     "description": "Framework to create custom Keycloak UIs",
     "repository": {
         "type": "git",
@@ -681,14 +681,13 @@
         "src/bin/main.ts",
         "src/bin/own.ts",
         "src/bin/shared/KeycloakVersionRange.ts",
+        "src/bin/shared/addSyncExtensionsToPostinstallScript.ts",
         "src/bin/shared/buildContext.ts",
         "src/bin/shared/constants.ts",
         "src/bin/shared/customHandler.ts",
         "src/bin/shared/customHandler_delegate.ts",
         "src/bin/shared/exitIfUncommittedChanges.ts",
-        "src/bin/shared/initializeSpa/addSyncExtensionsToPostinstallScript.ts",
-        "src/bin/shared/initializeSpa/index.ts",
-        "src/bin/shared/initializeSpa/initializeSpa.ts",
+        "src/bin/shared/initializeSpa.ts",
         "src/bin/shared/metaInfKeycloakThemes.ts",
         "src/bin/start-keycloak/appBuild.ts",
         "src/bin/start-keycloak/getSupportedDockerImageTags.ts",
@@ -1053,14 +1052,13 @@
         "bin/keycloakify/replacers/replaceImportsInJsCode/webpack.d.ts",
         "bin/main.d.ts",
         "bin/own.d.ts",
+        "bin/shared/addSyncExtensionsToPostinstallScript.d.ts",
         "bin/shared/buildContext.d.ts",
         "bin/shared/constants.d.ts",
         "bin/shared/customHandler_delegate.d.ts",
         "bin/shared/customHandler.d.ts",
         "bin/shared/exitIfUncommittedChanges.d.ts",
-        "bin/shared/initializeSpa/addSyncExtensionsToPostinstallScript.d.ts",
-        "bin/shared/initializeSpa/index.d.ts",
-        "bin/shared/initializeSpa/initializeSpa.d.ts",
+        "bin/shared/initializeSpa.d.ts",
         "bin/shared/KeycloakVersionRange.d.ts",
         "bin/shared/metaInfKeycloakThemes.d.ts",
         "bin/start-keycloak/appBuild.d.ts",
@@ -1118,27 +1116,26 @@
         "bin/update-kc-gen.d.ts",
         "bin/main.js",
         "bin/266.index.js",
-        "bin/288.index.js",
+        "bin/297.index.js",
         "bin/304.index.js",
-        "bin/313.index.js",
         "bin/33.index.js",
         "bin/355.index.js",
         "bin/363.index.js",
+        "bin/369.index.js",
         "bin/40.index.js",
         "bin/453.index.js",
+        "bin/656.index.js",
         "bin/658.index.js",
-        "bin/678.index.js",
+        "bin/664.index.js",
         "bin/720.index.js",
         "bin/780.index.js",
         "bin/783.index.js",
         "bin/786.index.js",
         "bin/877.index.js",
         "bin/880.index.js",
-        "bin/9.index.js",
-        "bin/911.index.js",
         "bin/930.index.js",
+        "bin/932.index.js",
         "bin/946.index.js",
-        "bin/947.index.js",
         "bin/97.index.js",
         "bin/shared/constants.js",
         "bin/shared/constants.js.map",

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

@@ -23,22 +23,6 @@ export async function command(params: { buildContext: BuildContext }) {
 
     const accountThemeSrcDirPath = pathJoin(buildContext.themeSrcDirPath, "account");
 
-    if (
-        fs.existsSync(accountThemeSrcDirPath) &&
-        fs.readdirSync(accountThemeSrcDirPath).length > 0
-    ) {
-        console.warn(
-            chalk.red(
-                `There is already a ${pathRelative(
-                    process.cwd(),
-                    accountThemeSrcDirPath
-                )} directory in your project. Aborting.`
-            )
-        );
-
-        process.exit(-1);
-    }
-
     exitIfUncommittedChanges({
         projectDirPath: buildContext.projectDirPath
     });
@@ -51,17 +35,35 @@ export async function command(params: { buildContext: BuildContext }) {
 
     switch (accountThemeType) {
         case "Multi-Page":
-            fs.cpSync(
-                pathJoin(
-                    getThisCodebaseRootDirPath(),
-                    "src",
-                    "bin",
-                    "initialize-account-theme",
-                    "multi-page-boilerplate"
-                ),
-                accountThemeSrcDirPath,
-                { recursive: true }
-            );
+            {
+                if (
+                    fs.existsSync(accountThemeSrcDirPath) &&
+                    fs.readdirSync(accountThemeSrcDirPath).length > 0
+                ) {
+                    console.warn(
+                        chalk.red(
+                            `There is already a ${pathRelative(
+                                process.cwd(),
+                                accountThemeSrcDirPath
+                            )} directory in your project. Aborting.`
+                        )
+                    );
+
+                    process.exit(-1);
+                }
+
+                fs.cpSync(
+                    pathJoin(
+                        getThisCodebaseRootDirPath(),
+                        "src",
+                        "bin",
+                        "initialize-account-theme",
+                        "multi-page-boilerplate"
+                    ),
+                    accountThemeSrcDirPath,
+                    { recursive: true }
+                );
+            }
             break;
         case "Single-Page":
             {

package/src/bin/initialize-account-theme/multi-page-boilerplate/i18n.ts

@@ -1,8 +1,8 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
 import { i18nBuilder } from "keycloakify/account";
 import type { ThemeName } from "../kc.gen";
 
-/** @see: https://docs.keycloakify.dev/i18n */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
+/** @see: https://docs.keycloakify.dev/features/i18n */
 const { useI18n, ofTypeI18n } = i18nBuilder.withThemeName<ThemeName>().build();
 
 type I18n = typeof ofTypeI18n;

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

@@ -1,17 +1,24 @@
-import { join as pathJoin, relative as pathRelative } from "path";
-import { transformCodebase } from "./tools/transformCodebase";
 import type { BuildContext } from "./shared/buildContext";
-import * as fs from "fs";
-import { downloadAndExtractArchive } from "./tools/downloadAndExtractArchive";
+import cliSelect from "cli-select";
 import { maybeDelegateCommandToCustomHandler } from "./shared/customHandler_delegate";
-import { assert } from "tsafe/assert";
-import { getSupportedDockerImageTags } from "./start-keycloak/getSupportedDockerImageTags";
+import { exitIfUncommittedChanges } from "./shared/exitIfUncommittedChanges";
+
+import { dirname as pathDirname, join as pathJoin, relative as pathRelative } from "path";
+import * as fs from "fs";
+import { assert, is, type Equals } from "tsafe/assert";
+import { id } from "tsafe/id";
+import { addSyncExtensionsToPostinstallScript } from "./shared/addSyncExtensionsToPostinstallScript";
+import { getIsPrettierAvailable, runPrettier } from "./tools/runPrettier";
+import { npmInstall } from "./tools/npmInstall";
+import * as child_process from "child_process";
+import { z } from "zod";
+import chalk from "chalk";
 
 export async function command(params: { buildContext: BuildContext }) {
     const { buildContext } = params;
 
     const { hasBeenHandled } = maybeDelegateCommandToCustomHandler({
-        commandName: "initialize-email-theme",
+        commandName: "initialize-account-theme",
         buildContext
     });
 
@@ -19,6 +26,10 @@ export async function command(params: { buildContext: BuildContext }) {
         return;
     }
 
+    exitIfUncommittedChanges({
+        projectDirPath: buildContext.projectDirPath
+    });
+
     const emailThemeSrcDirPath = pathJoin(buildContext.themeSrcDirPath, "email");
 
     if (
@@ -26,71 +37,110 @@ export async function command(params: { buildContext: BuildContext }) {
         fs.readdirSync(emailThemeSrcDirPath).length > 0
     ) {
         console.warn(
-            `There is already a non empty ${pathRelative(
-                process.cwd(),
-                emailThemeSrcDirPath
-            )} directory in your project. Aborting.`
+            chalk.red(
+                `There is already a ${pathRelative(
+                    process.cwd(),
+                    emailThemeSrcDirPath
+                )} directory in your project. Aborting.`
+            )
         );
 
         process.exit(-1);
     }
 
-    console.log("Initialize with the base email theme from which version of Keycloak?");
+    const { value: emailThemeType } = await cliSelect({
+        values: ["native (FreeMarker)" as const, "jsx-email (React)" as const]
+    }).catch(() => {
+        process.exit(-1);
+    });
 
-    const { extractedDirPath } = await downloadAndExtractArchive({
-        url: await (async () => {
-            const { latestMajorTags } = await getSupportedDockerImageTags({
-                buildContext
+    if (emailThemeType === "jsx-email (React)") {
+        console.log(
+            [
+                "There is currently no automated support for keycloakify-email, it has to be done manually, see documentation:",
+                "https://docs.keycloakify.dev/theme-types/email-theme"
+            ].join("\n")
+        );
+
+        process.exit(0);
+    }
+
+    const parsedPackageJson = (() => {
+        type ParsedPackageJson = {
+            scripts?: Record<string, string | undefined>;
+            dependencies?: Record<string, string | undefined>;
+            devDependencies?: Record<string, string | undefined>;
+        };
+
+        const zParsedPackageJson = (() => {
+            type TargetType = ParsedPackageJson;
+
+            const zTargetType = z.object({
+                scripts: z.record(z.union([z.string(), z.undefined()])).optional(),
+                dependencies: z.record(z.union([z.string(), z.undefined()])).optional(),
+                devDependencies: z.record(z.union([z.string(), z.undefined()])).optional()
             });
 
-            const keycloakVersion = latestMajorTags[0];
+            assert<Equals<z.infer<typeof zTargetType>, TargetType>>;
+
+            return id<z.ZodType<TargetType>>(zTargetType);
+        })();
+        const parsedPackageJson = JSON.parse(
+            fs.readFileSync(buildContext.packageJsonFilePath).toString("utf8")
+        );
 
-            assert(keycloakVersion !== undefined);
+        zParsedPackageJson.parse(parsedPackageJson);
 
-            return `https://repo1.maven.org/maven2/org/keycloak/keycloak-themes/${keycloakVersion}/keycloak-themes-${keycloakVersion}.jar`;
-        })(),
-        cacheDirPath: buildContext.cacheDirPath,
-        fetchOptions: buildContext.fetchOptions,
-        uniqueIdOfOnArchiveFile: "extractOnlyEmailTheme",
-        onArchiveFile: async ({ fileRelativePath, writeFile }) => {
-            const fileRelativePath_target = pathRelative(
-                pathJoin("theme", "base", "email"),
-                fileRelativePath
-            );
+        assert(is<ParsedPackageJson>(parsedPackageJson));
 
-            if (fileRelativePath_target.startsWith("..")) {
-                return;
-            }
+        return parsedPackageJson;
+    })();
 
-            await writeFile({ fileRelativePath: fileRelativePath_target });
-        }
+    addSyncExtensionsToPostinstallScript({
+        parsedPackageJson,
+        buildContext
     });
 
-    transformCodebase({
-        srcDirPath: extractedDirPath,
-        destDirPath: emailThemeSrcDirPath
-    });
+    const moduleName = `@keycloakify/email-native`;
+
+    const [version] = (
+        JSON.parse(
+            child_process
+                .execSync(`npm show ${moduleName} versions --json`)
+                .toString("utf8")
+                .trim()
+        ) as string[]
+    )
+        .reverse()
+        .filter(version => !version.includes("-"));
+
+    assert(version !== undefined);
+
+    (parsedPackageJson.dependencies ??= {})[moduleName] = `~${version}`;
+
+    if (parsedPackageJson.devDependencies !== undefined) {
+        delete parsedPackageJson.devDependencies[moduleName];
+    }
 
     {
-        const themePropertyFilePath = pathJoin(emailThemeSrcDirPath, "theme.properties");
+        let sourceCode = JSON.stringify(parsedPackageJson, undefined, 2);
+
+        if (await getIsPrettierAvailable()) {
+            sourceCode = await runPrettier({
+                sourceCode,
+                filePath: buildContext.packageJsonFilePath
+            });
+        }
 
         fs.writeFileSync(
-            themePropertyFilePath,
-            Buffer.from(
-                [
-                    `parent=base`,
-                    fs.readFileSync(themePropertyFilePath).toString("utf8")
-                ].join("\n"),
-                "utf8"
-            )
+            buildContext.packageJsonFilePath,
+            Buffer.from(sourceCode, "utf8")
         );
     }
 
-    console.log(
-        `The \`${pathJoin(
-            ".",
-            pathRelative(process.cwd(), emailThemeSrcDirPath)
-        )}\` directory have been created.`
-    );
-    console.log("You can delete any file you don't modify.");
+    await npmInstall({
+        packageJsonDirPath: pathDirname(buildContext.packageJsonFilePath)
+    });
+
+    console.log(chalk.green("Email theme initialized."));
 }