keycloakify 11.6.1 → 11.7.0

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

@@ -7,6 +7,7 @@ import { updateAccountThemeImplementationInConfig } from "./updateAccountThemeIm
 import { command as updateKcGenCommand } from "../update-kc-gen";
 import { maybeDelegateCommandToCustomHandler } from "../shared/customHandler_delegate";
 import { exitIfUncommittedChanges } from "../shared/exitIfUncommittedChanges";
+import { getThisCodebaseRootDirPath } from "../tools/getThisCodebaseRootDirPath";
 
 export async function command(params: { buildContext: BuildContext }) {
     const { buildContext } = params;
@@ -50,24 +51,24 @@ export async function command(params: { buildContext: BuildContext }) {
 
     switch (accountThemeType) {
         case "Multi-Page":
-            {
-                const { initializeAccountTheme_multiPage } = await import(
-                    "./initializeAccountTheme_multiPage"
-                );
-
-                await initializeAccountTheme_multiPage({
-                    accountThemeSrcDirPath
-                });
-            }
+            fs.cpSync(
+                pathJoin(
+                    getThisCodebaseRootDirPath(),
+                    "src",
+                    "bin",
+                    "initialize-account-theme",
+                    "multi-page-boilerplate"
+                ),
+                accountThemeSrcDirPath,
+                { recursive: true }
+            );
             break;
         case "Single-Page":
             {
-                const { initializeAccountTheme_singlePage } = await import(
-                    "./initializeAccountTheme_singlePage"
-                );
+                const { initializeSpa } = await import("../shared/initializeSpa");
 
-                await initializeAccountTheme_singlePage({
-                    accountThemeSrcDirPath,
+                await initializeSpa({
+                    themeType: "account",
                     buildContext
                 });
             }

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

@@ -1,15 +1,8 @@
-import { dirname as pathDirname, join as pathJoin, relative as pathRelative } from "path";
 import type { BuildContext } from "./shared/buildContext";
-import * as fs from "fs";
 import { maybeDelegateCommandToCustomHandler } from "./shared/customHandler_delegate";
-import { assert, is, type Equals } from "tsafe/assert";
-import { id } from "tsafe/id";
-import { addPostinstallScriptIfNotPresent } from "./shared/addPostinstallScriptIfNotPresent";
-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";
+import { initializeSpa } from "./shared/initializeSpa";
+import { exitIfUncommittedChanges } from "./shared/exitIfUncommittedChanges";
+import { command as updateKcGenCommand } from "./update-kc-gen";
 
 export async function command(params: { buildContext: BuildContext }) {
     const { buildContext } = params;
@@ -23,124 +16,24 @@ export async function command(params: { buildContext: BuildContext }) {
         return;
     }
 
-    {
-        const adminThemeSrcDirPath = pathJoin(buildContext.themeSrcDirPath, "admin");
-
-        if (
-            fs.existsSync(adminThemeSrcDirPath) &&
-            fs.readdirSync(adminThemeSrcDirPath).length > 0
-        ) {
-            console.warn(
-                chalk.red(
-                    `There is already a ${pathRelative(
-                        process.cwd(),
-                        adminThemeSrcDirPath
-                    )} directory in your project. Aborting.`
-                )
-            );
-
-            process.exit(-1);
-        }
-    }
-
-    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()
-            });
-
-            assert<Equals<z.infer<typeof zTargetType>, TargetType>>;
-
-            return id<z.ZodType<TargetType>>(zTargetType);
-        })();
-        const parsedPackageJson = JSON.parse(
-            fs.readFileSync(buildContext.packageJsonFilePath).toString("utf8")
-        );
-
-        zParsedPackageJson.parse(parsedPackageJson);
-
-        assert(is<ParsedPackageJson>(parsedPackageJson));
-
-        return parsedPackageJson;
-    })();
+    exitIfUncommittedChanges({
+        projectDirPath: buildContext.projectDirPath
+    });
 
-    addPostinstallScriptIfNotPresent({
-        parsedPackageJson,
+    await initializeSpa({
+        themeType: "admin",
         buildContext
     });
 
-    const uiSharedMajor = (() => {
-        const dependencies = {
-            ...parsedPackageJson.devDependencies,
-            ...parsedPackageJson.dependencies
-        };
-
-        const version = dependencies["@keycloakify/keycloak-ui-shared"];
-
-        if (version === undefined) {
-            return undefined;
+    await updateKcGenCommand({
+        buildContext: {
+            ...buildContext,
+            implementedThemeTypes: {
+                ...buildContext.implementedThemeTypes,
+                admin: {
+                    isImplemented: true
+                }
+            }
         }
-
-        const match = version.match(/^[^~]?(\d+)\./);
-
-        if (match === null) {
-            return undefined;
-        }
-
-        return match[1];
-    })();
-
-    const moduleName = "@keycloakify/keycloak-admin-ui";
-
-    const version = (
-        JSON.parse(
-            child_process
-                .execSync(`npm show ${moduleName} versions --json`)
-                .toString("utf8")
-                .trim()
-        ) as string[]
-    )
-        .reverse()
-        .filter(version => !version.includes("-"))
-        .find(version =>
-            uiSharedMajor === undefined ? true : version.startsWith(`${uiSharedMajor}.`)
-        );
-
-    assert(version !== undefined);
-
-    (parsedPackageJson.dependencies ??= {})[moduleName] = `~${version}`;
-
-    if (parsedPackageJson.devDependencies !== undefined) {
-        delete parsedPackageJson.devDependencies[moduleName];
-    }
-
-    {
-        let sourceCode = JSON.stringify(parsedPackageJson, undefined, 2);
-
-        if (await getIsPrettierAvailable()) {
-            sourceCode = await runPrettier({
-                sourceCode,
-                filePath: buildContext.packageJsonFilePath
-            });
-        }
-
-        fs.writeFileSync(
-            buildContext.packageJsonFilePath,
-            Buffer.from(sourceCode, "utf8")
-        );
-    }
-
-    await npmInstall({
-        packageJsonDirPath: pathDirname(buildContext.packageJsonFilePath)
     });
 }

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

@@ -1,13 +1,11 @@
 import { join as pathJoin, relative as pathRelative } from "path";
 import { transformCodebase } from "./tools/transformCodebase";
-import { promptKeycloakVersion } from "./shared/promptKeycloakVersion";
 import type { BuildContext } from "./shared/buildContext";
 import * as fs from "fs";
 import { downloadAndExtractArchive } from "./tools/downloadAndExtractArchive";
 import { maybeDelegateCommandToCustomHandler } from "./shared/customHandler_delegate";
-import fetch from "make-fetch-happen";
-import { SemVer } from "./tools/SemVer";
 import { assert } from "tsafe/assert";
+import { getSupportedDockerImageTags } from "./start-keycloak/getSupportedDockerImageTags";
 
 export async function command(params: { buildContext: BuildContext }) {
     const { buildContext } = params;
@@ -39,40 +37,18 @@ export async function command(params: { buildContext: BuildContext }) {
 
     console.log("Initialize with the base email theme from which version of Keycloak?");
 
-    let { keycloakVersion } = await promptKeycloakVersion({
-        // NOTE: This is arbitrary
-        startingFromMajor: 17,
-        excludeMajorVersions: [],
-        doOmitPatch: false,
-        buildContext
-    });
-
-    const getUrl = (keycloakVersion: string) => {
-        return `https://repo1.maven.org/maven2/org/keycloak/keycloak-themes/${keycloakVersion}/keycloak-themes-${keycloakVersion}.jar`;
-    };
-
-    keycloakVersion = await (async () => {
-        const keycloakVersionParsed = SemVer.parse(keycloakVersion);
-
-        while (true) {
-            const url = getUrl(SemVer.stringify(keycloakVersionParsed));
-
-            const response = await fetch(url, buildContext.fetchOptions);
-
-            if (response.ok) {
-                break;
-            }
-
-            assert(keycloakVersionParsed.patch !== 0);
+    const { extractedDirPath } = await downloadAndExtractArchive({
+        url: await (async () => {
+            const { latestMajorTags } = await getSupportedDockerImageTags({
+                buildContext
+            });
 
-            keycloakVersionParsed.patch--;
-        }
+            const keycloakVersion = latestMajorTags[0];
 
-        return SemVer.stringify(keycloakVersionParsed);
-    })();
+            assert(keycloakVersion !== undefined);
 
-    const { extractedDirPath } = await downloadAndExtractArchive({
-        url: getUrl(keycloakVersion),
+            return `https://repo1.maven.org/maven2/org/keycloak/keycloak-themes/${keycloakVersion}/keycloak-themes-${keycloakVersion}.jar`;
+        })(),
         cacheDirPath: buildContext.cacheDirPath,
         fetchOptions: buildContext.fetchOptions,
         uniqueIdOfOnArchiveFile: "extractOnlyEmailTheme",

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

@@ -37,10 +37,10 @@ import {
 } from "../../shared/metaInfKeycloakThemes";
 import { objectEntries } from "tsafe/objectEntries";
 import { escapeStringForPropertiesFile } from "../../tools/escapeStringForPropertiesFile";
-import * as child_process from "child_process";
 import { getThisCodebaseRootDirPath } from "../../tools/getThisCodebaseRootDirPath";
 import propertiesParser from "properties-parser";
 import { createObjectThatThrowsIfAccessed } from "../../tools/createObjectThatThrowsIfAccessed";
+import { listInstalledModules } from "../../tools/listInstalledModules";
 
 export type BuildContextLike = BuildContextLike_kcContextExclusionsFtlCode &
     BuildContextLike_generateMessageProperties & {
@@ -238,9 +238,9 @@ export async function generateResources(params: {
 
         let languageTags: string[] | undefined = undefined;
 
-        i18n_messages_generation: {
+        i18n_multi_page: {
             if (isSpa) {
-                break i18n_messages_generation;
+                break i18n_multi_page;
             }
 
             assert(themeType !== "admin");
@@ -257,23 +257,43 @@ export async function generateResources(params: {
                 writeMessagePropertiesFiles;
         }
 
-        bring_in_account_spa_messages: {
+        let isLegacyAccountSpa = false;
+
+        // NOTE: Eventually remove this block.
+        i18n_single_page_account_legacy: {
             if (!isSpa) {
-                break bring_in_account_spa_messages;
+                break i18n_single_page_account_legacy;
             }
 
             if (themeType !== "account") {
-                break bring_in_account_spa_messages;
+                break i18n_single_page_account_legacy;
             }
 
-            const accountUiDirPath = child_process
-                .execSync(`npm list @keycloakify/keycloak-account-ui --parseable`, {
-                    cwd: pathDirname(buildContext.packageJsonFilePath)
-                })
-                .toString("utf8")
-                .trim();
+            const [moduleMeta] = await listInstalledModules({
+                packageJsonFilePath: buildContext.packageJsonFilePath,
+                filter: ({ moduleName }) =>
+                    moduleName === "@keycloakify/keycloak-account-ui"
+            });
+
+            assert(
+                moduleMeta !== undefined,
+                `@keycloakify/keycloak-account-ui is supposed to be installed`
+            );
+
+            {
+                const [majorStr] = moduleMeta.version.split(".");
+
+                if (majorStr.length === 6) {
+                    // NOTE: Now we use the format MMmmpp (Major, minor, patch) for example for
+                    // 26.0.7 it would be 260007.
+                    break i18n_single_page_account_legacy;
+                } else {
+                    // 25.0.4-rc.5 or later
+                    isLegacyAccountSpa = true;
+                }
+            }
 
-            const messageDirPath_defaults = pathJoin(accountUiDirPath, "messages");
+            const messageDirPath_defaults = pathJoin(moduleMeta.dirPath, "messages");
 
             if (!fs.existsSync(messageDirPath_defaults)) {
                 throw new Error(
@@ -281,6 +301,8 @@ export async function generateResources(params: {
                 );
             }
 
+            isLegacyAccountSpa = true;
+
             const messagesDirPath_dest = pathJoin(
                 getThemeTypeDirPath({ themeName, themeType: "account" }),
                 "messages"
@@ -342,14 +364,20 @@ export async function generateResources(params: {
                 );
         }
 
-        bring_in_admin_messages: {
-            if (themeType !== "admin") {
-                break bring_in_admin_messages;
+        i18n_single_page: {
+            if (!isSpa) {
+                break i18n_single_page;
+            }
+
+            if (isLegacyAccountSpa) {
+                break i18n_single_page;
             }
 
+            assert(themeType === "account" || themeType === "admin");
+
             const messagesDirPath_theme = pathJoin(
                 buildContext.themeSrcDirPath,
-                "admin",
+                themeType,
                 "i18n"
             );
 
@@ -423,7 +451,7 @@ export async function generateResources(params: {
 
                 propertiesByLang[parsedBasename.lang] ??= {
                     base: createObjectThatThrowsIfAccessed<Buffer>({
-                        debugMessage: `No base ${parsedBasename.lang} translation for admin theme`
+                        debugMessage: `No base ${parsedBasename.lang} translation for ${themeType} theme`
                     }),
                     override: undefined,
                     overrideByThemeName: {}
@@ -446,7 +474,9 @@ export async function generateResources(params: {
                 ] = buffer;
             });
 
-            writeMessagePropertiesFilesByThemeType.admin = ({
+            languageTags = Object.keys(propertiesByLang);
+
+            writeMessagePropertiesFilesByThemeType[themeType] = ({
                 messageDirPath,
                 themeName
             }) => {
@@ -456,8 +486,6 @@ export async function generateResources(params: {
 
                 Object.entries(propertiesByLang).forEach(
                     ([lang, { base, override, overrideByThemeName }]) => {
-                        (languageTags ??= []).push(lang);
-
                         const messages = propertiesParser.parse(base.toString("utf8"));
 
                         if (override !== undefined) {

package/src/bin/main.ts

@@ -248,13 +248,30 @@ program
 
 program
     .command({
-        name: "postinstall",
-        description: "Initialize all the Keycloakify UI modules installed in the project."
+        name: "sync-extensions",
+        description: [
+            "Synchronizes all installed Keycloakify extension modules with your project.",
+            "",
+            "Example of extension modules: '@keycloakify/keycloak-account-ui', '@keycloakify/keycloak-admin-ui', '@keycloakify/keycloak-ui-shared'",
+            "",
+            "This command ensures that:",
+            "- All required files from installed extensions are copied into your project.",
+            "- The copied files are correctly ignored by Git to help you distinguish between your custom source files",
+            "  and those provided by the extensions.",
+            "- Peer dependencies declared by the extensions are automatically added to your package.json.",
+            "",
+            "You can safely run this command multiple times. It will only update the files and dependencies if needed,",
+            "ensuring your project stays in sync with the installed extensions.",
+            "",
+            "Typical usage:",
+            "- Should be run as a postinstall script of your project.",
+            ""
+        ].join("\n")
     })
     .task({
         skip,
         handler: async ({ projectDirPath }) => {
-            const { command } = await import("./postinstall");
+            const { command } = await import("./sync-extensions");
 
             await command({ buildContext: getBuildContext({ projectDirPath }) });
         }
@@ -262,37 +279,65 @@ program
 
 program
     .command<{
-        file: string;
+        path: string;
+        revert: boolean;
     }>({
-        name: "eject-file",
+        name: "own",
         description: [
-            "WARNING: Not usable yet, will be used for future features",
-            "Take ownership over a given file"
-        ].join(" ")
+            "Manages ownership of auto-generated files provided by Keycloakify extensions.",
+            "",
+            "This command allows you to take ownership of a specific file or directory generated",
+            "by an extension. Once owned, you can freely modify and version-control the file.",
+            "",
+            "You can also use the --revert flag to relinquish ownership and restore the file",
+            "or directory to its original auto-generated state.",
+            "",
+            "For convenience, the exact command to take ownership of any file is included as a comment",
+            "in the header of each extension-generated file.",
+            "",
+            "Examples:",
+            "$ npx keycloakify own --path admin/KcPage.tsx"
+        ].join("\n")
     })
     .option({
-        key: "file",
+        key: "path",
         name: (() => {
-            const long = "file";
-            const short = "f";
+            const long = "path";
+            const short = "p";
 
             optionsKeys.push(long, short);
 
             return { long, short };
         })(),
         description: [
-            "Relative path of the file relative to the directory of your keycloak theme source",
-            "Example `--file src/login/page/Login.tsx`"
+            "Specifies the relative path of the file or directory to take ownership of.",
+            "This path should be relative to your theme directory.",
+            "Example: `--path 'admin/KcPage.tsx'`"
         ].join(" ")
     })
+    .option({
+        key: "revert",
+        name: (() => {
+            const name = "revert";
+
+            optionsKeys.push(name);
+
+            return name;
+        })(),
+        description: [
+            "Restores a file or directory to its original auto-generated state,",
+            "removing your ownership claim and reverting any modifications."
+        ].join(" "),
+        defaultValue: false
+    })
     .task({
         skip,
-        handler: async ({ projectDirPath, file }) => {
-            const { command } = await import("./eject-file");
+        handler: async ({ projectDirPath, path, revert }) => {
+            const { command } = await import("./own");
 
             await command({
                 buildContext: getBuildContext({ projectDirPath }),
-                cliCommandOptions: { file }
+                cliCommandOptions: { path, isRevert: revert }
             });
         }
     });