keycloakify 11.8.46 → 11.8.47-rc.2

package/src/bin/shared/buildContext.ts

@@ -2,7 +2,6 @@ import { parse as urlParse } from "url";
 import {
     join as pathJoin,
     sep as pathSep,
-    relative as pathRelative,
     resolve as pathResolve,
     dirname as pathDirname
 } from "path";
@@ -13,8 +12,7 @@ import { assert, type Equals, is } from "tsafe/assert";
 import * as child_process from "child_process";
 import {
     VITE_PLUGIN_SUB_SCRIPTS_ENV_NAMES,
-    BUILD_FOR_KEYCLOAK_MAJOR_VERSION_ENV_NAME,
-    THEME_TYPES
+    BUILD_FOR_KEYCLOAK_MAJOR_VERSION_ENV_NAME
 } from "./constants";
 import type { KeycloakVersionRange } from "./KeycloakVersionRange";
 import { exclude } from "tsafe";
@@ -167,40 +165,7 @@ export function getBuildContext(params: {
             return { themeSrcDirPath };
         }
 
-        {
-            const basenames = fs.readdirSync(srcDirPath);
-
-            for (const basename of basenames) {
-                const path = pathJoin(srcDirPath, basename);
-
-                if (!fs.statSync(path).isFile()) {
-                    continue;
-                }
-
-                if (fs.readFileSync(path).toString("utf8").includes("./kc.gen")) {
-                    return { themeSrcDirPath: srcDirPath };
-                }
-            }
-        }
-
-        for (const themeType of [...THEME_TYPES, "email"]) {
-            if (!fs.existsSync(pathJoin(srcDirPath, themeType))) {
-                continue;
-            }
-            return { themeSrcDirPath: srcDirPath };
-        }
-
-        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.replace(/-/g, "_")}' in your 'src' directory`
-                ].join("\n")
-            )
-        );
-
-        process.exit(1);
+        return { themeSrcDirPath: srcDirPath };
     })();
 
     const { resolvedViteConfig } = (() => {
@@ -216,6 +181,7 @@ export function getBuildContext(params: {
         const output = child_process
             .execSync("npx vite", {
                 cwd: projectDirPath,
+                stdio: ["pipe", "pipe", "ignore"],
                 env: {
                     ...process.env,
                     [VITE_PLUGIN_SUB_SCRIPTS_ENV_NAMES.RESOLVE_VITE_CONFIG]: "true"
@@ -770,33 +736,36 @@ export function getBuildContext(params: {
         environmentVariables: buildOptions.environmentVariables ?? [],
         implementedThemeTypes,
         themeSrcDirPath,
-        fetchOptions: getProxyFetchOptions({
-            npmConfigGetCwd: (function callee(upCount: number): string {
-                const dirPath = pathResolve(
-                    pathJoin(...[projectDirPath, ...Array(upCount).fill("..")])
-                );
+        get fetchOptions() {
+            return 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'"
-                );
+                    assert(
+                        dirPath !== pathSep,
+                        "Couldn't find a place to run 'npm config get'"
+                    );
 
-                try {
-                    child_process.execSync("npm config get", {
-                        cwd: dirPath,
-                        stdio: "pipe"
-                    });
-                } catch (error) {
-                    if (String(error).includes("ENOWORKSPACES")) {
-                        return callee(upCount + 1);
+                    try {
+                        child_process.execSync("npm config get", {
+                            cwd: dirPath,
+                            stdio: "pipe"
+                        });
+                    } catch (error) {
+                        if (String(error).includes("ENOWORKSPACES")) {
+                            return callee(upCount + 1);
+                        }
+
+                        throw error;
                     }
 
-                    throw error;
-                }
+                    return dirPath;
+                })(0)
+            });
+        },
 
-                return dirPath;
-            })(0)
-        }),
         jarTargets: (() => {
             const getDefaultJarFileBasename = (range: string) =>
                 `keycloak-theme-for-kc-${range}.jar`;

package/src/bin/shared/customHandler.ts

@@ -10,11 +10,13 @@ export type CommandName =
     | "update-kc-gen"
     | "eject-page"
     | "add-story"
+    | "initialize-login-theme"
     | "initialize-account-theme"
     | "initialize-admin-theme"
     | "initialize-admin-theme"
     | "initialize-email-theme"
-    | "copy-keycloak-resources-to-public";
+    | "copy-keycloak-resources-to-public"
+    | "init";
 
 export type ApiVersion = "v1";
 

package/src/bin/shared/initializeSpa.ts

@@ -1,6 +1,7 @@
 import { dirname as pathDirname, join as pathJoin, relative as pathRelative } from "path";
 import type { BuildContext } from "./buildContext";
 import * as fs from "fs";
+import * as fsPr from "fs/promises";
 import { assert, is, type Equals } from "tsafe/assert";
 import { id } from "tsafe/id";
 import {
@@ -12,6 +13,7 @@ import { npmInstall } from "../tools/npmInstall";
 import * as child_process from "child_process";
 import { z } from "zod";
 import chalk from "chalk";
+import { existsAsync } from "../tools/fs.existsAsync";
 
 export type BuildContextLike = BuildContextLike_addSyncExtensionsToPostinstallScript & {
     themeSrcDirPath: string;
@@ -82,6 +84,10 @@ export async function initializeSpa(params: {
         buildContext
     });
 
+    await disableVerbatimModuleSyntax({
+        projectDirPath: buildContext.projectDirPath
+    });
+
     const uiSharedMajor = (() => {
         const dependencies = {
             ...parsedPackageJson.devDependencies,
@@ -154,3 +160,25 @@ export async function initializeSpa(params: {
         packageJsonDirPath: pathDirname(buildContext.packageJsonFilePath)
     });
 }
+
+async function disableVerbatimModuleSyntax(params: { projectDirPath: string }) {
+    const { projectDirPath } = params;
+
+    const filePath = pathJoin(projectDirPath, "tsconfig.app.json");
+
+    if (!(await existsAsync(filePath))) {
+        return;
+    }
+
+    let content = (await fsPr.readFile(filePath)).toString("utf8");
+
+    const regExp = /"verbatimModuleSyntax"\s*:\s*true\s*(,?)/m;
+
+    if (!regExp.test(content)) {
+        return;
+    }
+
+    content = content.replace(regExp, `"verbatimModuleSyntax": false$1`);
+
+    await fsPr.writeFile(filePath, Buffer.from(content, "utf8"));
+}

package/src/bin/sync-extensions/extensionModuleMeta.ts

@@ -206,92 +206,108 @@ export async function getExtensionModuleMetas(params: {
     })();
 
     const extensionModuleMetas = await Promise.all(
-        installedExtensionModules.map(
-            async ({
-                moduleName,
-                version,
-                peerDependencies,
-                dirPath
-            }): Promise<ExtensionModuleMeta> => {
-                use_cache: {
-                    const extensionModuleMeta_cache =
-                        extensionModuleMetas_cacheUpToDate.find(
-                            extensionModuleMeta =>
-                                extensionModuleMeta.moduleName === moduleName
-                        );
-
-                    if (extensionModuleMeta_cache === undefined) {
-                        break use_cache;
-                    }
-
-                    return extensionModuleMeta_cache;
-                }
+        [...installedExtensionModules]
+            .sort((a, b) => a.moduleName.localeCompare(b.moduleName))
+            .map(
+                async ({
+                    moduleName,
+                    version,
+                    peerDependencies,
+                    dirPath
+                }): Promise<ExtensionModuleMeta> => {
+                    use_cache: {
+                        const extensionModuleMeta_cache =
+                            extensionModuleMetas_cacheUpToDate.find(
+                                extensionModuleMeta =>
+                                    extensionModuleMeta.moduleName === moduleName
+                            );
+
+                        if (extensionModuleMeta_cache === undefined) {
+                            break use_cache;
+                        }
 
-                const files: ExtensionModuleMeta["files"] = [];
+                        return extensionModuleMeta_cache;
+                    }
 
-                await crawlAsync({
-                    dirPath: pathJoin(dirPath, KEYCLOAK_THEME),
-                    returnedPathsType: "relative to dirPath",
-                    onFileFound: async fileRelativePath_fromReservedDir => {
-                        const isPublic = fileRelativePath_fromReservedDir.startsWith(
-                            `public${pathSep}`
-                        );
+                    const files: ExtensionModuleMeta["files"] = [];
+
+                    await crawlAsync({
+                        dirPath: pathJoin(dirPath, KEYCLOAK_THEME),
+                        returnedPathsType: "relative to dirPath",
+                        onFileFound: async fileRelativePath_fromReservedDir => {
+                            const isPublic = fileRelativePath_fromReservedDir.startsWith(
+                                `public${pathSep}`
+                            );
+
+                            const fileRelativePath = isPublic
+                                ? pathRelative("public", fileRelativePath_fromReservedDir)
+                                : fileRelativePath_fromReservedDir;
+
+                            const sourceCode =
+                                await getExtensionModuleFileSourceCodeReadyToBeCopied({
+                                    buildContext,
+                                    isPublic,
+                                    fileRelativePath,
+                                    isOwnershipAction: false,
+                                    extensionModuleDirPath: dirPath,
+                                    extensionModuleName: moduleName,
+                                    extensionModuleVersion: version
+                                });
+
+                            const hash = computeHash(sourceCode);
+
+                            const copyableFilePath = pathJoin(
+                                pathDirname(cacheFilePath),
+                                KEYCLOAK_THEME,
+                                fileRelativePath_fromReservedDir
+                            );
+
+                            {
+                                const dirPath = pathDirname(copyableFilePath);
+
+                                if (!(await existsAsync(dirPath))) {
+                                    await fsPr.mkdir(dirPath, { recursive: true });
+                                }
+                            }
 
-                        const fileRelativePath = isPublic
-                            ? pathRelative("public", fileRelativePath_fromReservedDir)
-                            : fileRelativePath_fromReservedDir;
+                            fsPr.writeFile(copyableFilePath, sourceCode);
 
-                        const sourceCode =
-                            await getExtensionModuleFileSourceCodeReadyToBeCopied({
-                                buildContext,
+                            files.push({
                                 isPublic,
                                 fileRelativePath,
-                                isOwnershipAction: false,
-                                extensionModuleDirPath: dirPath,
-                                extensionModuleName: moduleName,
-                                extensionModuleVersion: version
+                                hash,
+                                copyableFilePath
                             });
-
-                        const hash = computeHash(sourceCode);
-
-                        const copyableFilePath = pathJoin(
-                            pathDirname(cacheFilePath),
-                            KEYCLOAK_THEME,
-                            fileRelativePath_fromReservedDir
-                        );
-
-                        {
-                            const dirPath = pathDirname(copyableFilePath);
-
-                            if (!(await existsAsync(dirPath))) {
-                                await fsPr.mkdir(dirPath, { recursive: true });
-                            }
                         }
+                    });
 
-                        fsPr.writeFile(copyableFilePath, sourceCode);
+                    {
+                        const getId = (file: {
+                            isPublic: boolean;
+                            fileRelativePath: string;
+                        }) =>
+                            `${file.isPublic ? "public" : "src"} - ${file.fileRelativePath}`;
 
-                        files.push({
-                            isPublic,
-                            fileRelativePath,
-                            hash,
-                            copyableFilePath
-                        });
+                        files.sort((a, b) => getId(a).localeCompare(getId(b)));
                     }
-                });
 
-                return id<ExtensionModuleMeta>({
-                    moduleName,
-                    version,
-                    files,
-                    peerDependencies: Object.fromEntries(
-                        Object.entries(peerDependencies).filter(
-                            ([moduleName]) =>
-                                !isAmong(["react", "@types/react"], moduleName)
+                    return id<ExtensionModuleMeta>({
+                        moduleName,
+                        version,
+                        files,
+                        peerDependencies: Object.fromEntries(
+                            Object.entries(peerDependencies)
+                                .filter(
+                                    ([moduleName]) =>
+                                        !isAmong(["react", "@types/react"], moduleName)
+                                )
+                                .sort(([moduleName_a], [moduleName_b]) =>
+                                    moduleName_a.localeCompare(moduleName_b)
+                                )
                         )
-                    )
-                });
-            }
-        )
+                    });
+                }
+            )
     );
 
     update_cache: {

package/src/bin/sync-extensions/managedGitignoreFiles.ts

@@ -73,10 +73,16 @@ export async function writeManagedGitignoreFiles(params: {
                 ...ownedFilesRelativePaths_ctx
                     .map(({ fileRelativePath }) => fileRelativePath)
                     .map(fileRelativePath => fileRelativePath.split(pathSep).join("/"))
+                    .sort(posixPathCompareFn)
                     .map(line => `# ${line}`),
                 DELIMITER_END,
                 ``,
-                ...extensionModuleMetas_ctx
+                ...[...extensionModuleMetas_ctx]
+                    .sort((a, b) => {
+                        const n = a.moduleName.length - b.moduleName.length;
+
+                        return n !== 0 ? n : a.moduleName.localeCompare(b.moduleName);
+                    })
                     .map(extensionModuleMeta => [
                         `# === ${extensionModuleMeta.moduleName} v${extensionModuleMeta.version} ===`,
                         ...extensionModuleMeta.files
@@ -90,7 +96,8 @@ export async function writeManagedGitignoreFiles(params: {
                             .map(
                                 fileRelativePath =>
                                     `/${fileRelativePath.split(pathSep).join("/").replace(/^\.\//, "")}`
-                            ),
+                            )
+                            .sort(posixPathCompareFn),
 
                         ``
                     ])
@@ -187,3 +194,26 @@ export async function readManagedGitignoresFile(params: {
 
     return { ownedFilesRelativePaths };
 }
+
+function posixPathCompareFn(a: string, b: string) {
+    const aParts = a.split("/");
+    const bParts = b.split("/");
+
+    const diff = aParts.length - bParts.length;
+
+    if (diff !== 0) {
+        return diff;
+    }
+
+    const len = Math.min(aParts.length, bParts.length);
+
+    for (let i = 0; i < len; i++) {
+        const cmp = aParts[i].localeCompare(bParts[i], undefined, {
+            numeric: true,
+            sensitivity: "base"
+        });
+        if (cmp !== 0) return cmp;
+    }
+
+    return 0;
+}

package/src/bin/tools/fetchProxyOptions.ts

@@ -18,7 +18,8 @@ export function getProxyFetchOptions(params: {
     const cfg = (() => {
         const output = child_process
             .execSync("npm config get", {
-                cwd: npmConfigGetCwd
+                cwd: npmConfigGetCwd,
+                stdio: ["pipe", "pipe", "ignore"]
             })
             .toString("utf8");
 

package/src/bin/tools/npmInstall.ts

@@ -99,24 +99,31 @@ async function runPackageManagerInstall(params: {
 
     const dCompleted = new Deferred<void>();
 
-    const child = child_process.spawn(packageManagerBinName, ["install"], {
-        cwd,
-        env: process.env,
-        shell: true
-    });
+    const child = child_process.spawn(
+        packageManagerBinName,
+        ["install", ...(packageManagerBinName !== "npm" ? [] : ["--force"])],
+        {
+            cwd,
+            env: process.env,
+            shell: true
+        }
+    );
 
     child.stdout.on("data", data => process.stdout.write(data));
 
+    let errorLog = "";
+
     child.stderr.on("data", data => {
         if (data.toString("utf8").includes("peer dependency")) {
             return;
         }
 
-        process.stderr.write(data);
+        errorLog += data.toString("utf8");
     });
 
     child.on("exit", code => {
         if (code !== 0) {
+            console.log(errorLog);
             dCompleted.reject(new Error(`Failed with code ${code}`));
             return;
         }

package/vite-plugin/index.js

@@ -287,7 +287,8 @@ function getProxyFetchOptions(params) {
     const { npmConfigGetCwd } = params;
     const cfg = (() => {
         const output = external_child_process_.execSync("npm config get", {
-            cwd: npmConfigGetCwd
+            cwd: npmConfigGetCwd,
+            stdio: ["pipe", "pipe", "ignore"]
         })
             .toString("utf8");
         return output
@@ -408,30 +409,7 @@ function getBuildContext(params) {
         if (themeSrcDirPath !== undefined) {
             return { themeSrcDirPath };
         }
-        {
-            const basenames = external_fs_.readdirSync(srcDirPath);
-            for (const basename of basenames) {
-                const path = (0,external_path_.join)(srcDirPath, basename);
-                if (!external_fs_.statSync(path).isFile()) {
-                    continue;
-                }
-                if (external_fs_.readFileSync(path).toString("utf8").includes("./kc.gen")) {
-                    return { themeSrcDirPath: srcDirPath };
-                }
-            }
-        }
-        for (const themeType of [...constants.THEME_TYPES, "email"]) {
-            if (!external_fs_.existsSync((0,external_path_.join)(srcDirPath, themeType))) {
-                continue;
-            }
-            return { themeSrcDirPath: srcDirPath };
-        }
-        console.log(source_default().red([
-            `Can't locate your Keycloak theme source directory in .${external_path_.sep}${(0,external_path_.relative)(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 '${constants.KEYCLOAK_THEME}' or '${constants.KEYCLOAK_THEME.replace(/-/g, "_")}' in your 'src' directory`
-        ].join("\n")));
-        process.exit(1);
+        return { themeSrcDirPath: srcDirPath };
     })();
     const { resolvedViteConfig } = (() => {
         if (external_fs_.readdirSync(projectDirPath)
@@ -441,6 +419,7 @@ function getBuildContext(params) {
         }
         const output = external_child_process_.execSync("npx vite", {
             cwd: projectDirPath,
+            stdio: ["pipe", "pipe", "ignore"],
             env: Object.assign(Object.assign({}, process.env), { [constants.VITE_PLUGIN_SUB_SCRIPTS_ENV_NAMES.RESOLVE_VITE_CONFIG]: "true" })
         })
             .toString("utf8");
@@ -814,25 +793,27 @@ function getBuildContext(params) {
         environmentVariables: (_e = buildOptions.environmentVariables) !== null && _e !== void 0 ? _e : [],
         implementedThemeTypes,
         themeSrcDirPath,
-        fetchOptions: getProxyFetchOptions({
-            npmConfigGetCwd: (function callee(upCount) {
-                const dirPath = (0,external_path_.resolve)((0,external_path_.join)(...[projectDirPath, ...Array(upCount).fill("..")]));
-                (0,assert/* assert */.h)(dirPath !== external_path_.sep, "Couldn't find a place to run 'npm config get'");
-                try {
-                    external_child_process_.execSync("npm config get", {
-                        cwd: dirPath,
-                        stdio: "pipe"
-                    });
-                }
-                catch (error) {
-                    if (String(error).includes("ENOWORKSPACES")) {
-                        return callee(upCount + 1);
+        get fetchOptions() {
+            return getProxyFetchOptions({
+                npmConfigGetCwd: (function callee(upCount) {
+                    const dirPath = (0,external_path_.resolve)((0,external_path_.join)(...[projectDirPath, ...Array(upCount).fill("..")]));
+                    (0,assert/* assert */.h)(dirPath !== external_path_.sep, "Couldn't find a place to run 'npm config get'");
+                    try {
+                        external_child_process_.execSync("npm config get", {
+                            cwd: dirPath,
+                            stdio: "pipe"
+                        });
                     }
-                    throw error;
-                }
-                return dirPath;
-            })(0)
-        }),
+                    catch (error) {
+                        if (String(error).includes("ENOWORKSPACES")) {
+                            return callee(upCount + 1);
+                        }
+                        throw error;
+                    }
+                    return dirPath;
+                })(0)
+            });
+        },
         jarTargets: (() => {
             const getDefaultJarFileBasename = (range) => `keycloak-theme-for-kc-${range}.jar`;
             build_for_specific_keycloak_major_version: {