keycloakify 11.8.37 → 11.8.38

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

@@ -7,12 +7,14 @@ import { KEYCLOAK_THEME } from "../shared/constants";
 
 export type BuildContextLike = {
     themeSrcDirPath: string;
+    publicDirPath: string;
 };
 
 assert<BuildContext extends BuildContextLike ? true : false>();
 
 export async function getExtensionModuleFileSourceCodeReadyToBeCopied(params: {
     buildContext: BuildContextLike;
+    isPublic: boolean;
     fileRelativePath: string;
     isOwnershipAction: boolean;
     extensionModuleDirPath: string;
@@ -22,17 +24,50 @@ export async function getExtensionModuleFileSourceCodeReadyToBeCopied(params: {
     const {
         buildContext,
         extensionModuleDirPath,
+        isPublic,
         fileRelativePath,
         isOwnershipAction,
         extensionModuleName,
         extensionModuleVersion
     } = params;
 
-    let sourceCode = (
-        await fsPr.readFile(
-            pathJoin(extensionModuleDirPath, KEYCLOAK_THEME, fileRelativePath)
-        )
-    ).toString("utf8");
+    const { refSourceCode } = await (async () => {
+        let sourceCode: string | undefined = undefined;
+
+        const sourceCode_originalBuffer = await fsPr.readFile(
+            pathJoin(
+                extensionModuleDirPath,
+                KEYCLOAK_THEME,
+                isPublic ? "public" : ".",
+                fileRelativePath
+            )
+        );
+
+        let hasBeenUpdated = false;
+
+        const refSourceCode = {
+            get current(): string {
+                if (sourceCode === undefined) {
+                    sourceCode = sourceCode_originalBuffer.toString("utf8");
+                }
+
+                return sourceCode;
+            },
+            set current(value: string) {
+                hasBeenUpdated = true;
+                sourceCode = value;
+            },
+            getAsBuffer: () => {
+                if (!hasBeenUpdated) {
+                    return sourceCode_originalBuffer;
+                }
+
+                return Buffer.from(refSourceCode.current, "utf8");
+            }
+        };
+
+        return { refSourceCode };
+    })();
 
     add_eslint_disable: {
         if (isOwnershipAction) {
@@ -43,15 +78,17 @@ export async function getExtensionModuleFileSourceCodeReadyToBeCopied(params: {
             break add_eslint_disable;
         }
 
-        if (sourceCode.includes("/* eslint-disable */")) {
+        if (refSourceCode.current.includes("/* eslint-disable */")) {
             break add_eslint_disable;
         }
 
-        sourceCode = ["/* eslint-disable */", "", sourceCode].join("\n");
+        refSourceCode.current = ["/* eslint-disable */", "", refSourceCode.current].join(
+            "\n"
+        );
     }
 
-    sourceCode = addCommentToSourceCode({
-        sourceCode,
+    addCommentToSourceCode({
+        refSourceCode,
         fileRelativePath,
         commentLines: (() => {
             const path = fileRelativePath.split(pathSep).join("/");
@@ -61,12 +98,12 @@ export async function getExtensionModuleFileSourceCodeReadyToBeCopied(params: {
                       `This file has been claimed for ownership from ${extensionModuleName} version ${extensionModuleVersion}.`,
                       `To relinquish ownership and restore this file to its original content, run the following command:`,
                       ``,
-                      `$ npx keycloakify own --path "${path}" --revert`
+                      `$ npx keycloakify own --path "${path}" ${isPublic ? "--public " : ""}--revert`
                   ]
                 : [
                       `WARNING: Before modifying this file, run the following command:`,
                       ``,
-                      `$ npx keycloakify own --path "${path}"`,
+                      `$ npx keycloakify own --path "${path}"${isPublic ? " --public" : ""}`,
                       ``,
                       `This file is provided by ${extensionModuleName} version ${extensionModuleVersion}.`,
                       `It was copied into your repository by the postinstall script: \`keycloakify sync-extensions\`.`
@@ -74,31 +111,41 @@ export async function getExtensionModuleFileSourceCodeReadyToBeCopied(params: {
         })()
     });
 
-    const destFilePath = pathJoin(buildContext.themeSrcDirPath, fileRelativePath);
-
     format: {
         if (!(await getIsPrettierAvailable())) {
             break format;
         }
 
-        sourceCode = await runPrettier({
-            filePath: destFilePath,
-            sourceCode
+        const sourceCode_buffer_before = refSourceCode.getAsBuffer();
+        const sourceCode_buffer_after = await runPrettier({
+            filePath: pathJoin(
+                isPublic
+                    ? pathJoin(buildContext.publicDirPath, KEYCLOAK_THEME)
+                    : buildContext.themeSrcDirPath,
+                fileRelativePath
+            ),
+            sourceCode: sourceCode_buffer_before
         });
+
+        if (sourceCode_buffer_before.compare(sourceCode_buffer_after) === 0) {
+            break format;
+        }
+
+        refSourceCode.current = sourceCode_buffer_after.toString("utf8");
     }
 
-    return Buffer.from(sourceCode, "utf8");
+    return refSourceCode.getAsBuffer();
 }
 
 function addCommentToSourceCode(params: {
-    sourceCode: string;
+    refSourceCode: { current: string };
     fileRelativePath: string;
     commentLines: string[];
-}): string {
-    const { sourceCode, fileRelativePath, commentLines } = params;
+}): void {
+    const { refSourceCode, fileRelativePath, commentLines } = params;
 
-    const toResult = (comment: string) => {
-        return [comment, ``, sourceCode].join("\n");
+    const updateRef = (comment: string) => {
+        refSourceCode.current = [comment, ``, refSourceCode.current].join("\n");
     };
 
     for (const ext of [".ts", ".tsx", ".css", ".less", ".sass", ".js", ".jsx"]) {
@@ -106,13 +153,13 @@ function addCommentToSourceCode(params: {
             continue;
         }
 
-        return toResult(
-            [`/**`, ...commentLines.map(line => ` * ${line}`), ` */`].join("\n")
-        );
+        updateRef([`/**`, ...commentLines.map(line => ` * ${line}`), ` */`].join("\n"));
+        return;
     }
 
     if (fileRelativePath.endsWith(".properties")) {
-        return toResult(commentLines.map(line => `# ${line}`).join("\n"));
+        updateRef(commentLines.map(line => `# ${line}`).join("\n"));
+        return;
     }
 
     if (fileRelativePath.endsWith(".ftl")) {
@@ -120,15 +167,17 @@ function addCommentToSourceCode(params: {
             "\n"
         );
 
-        if (sourceCode.trim().startsWith("<#ftl")) {
-            const [first, ...rest] = sourceCode.split(">");
+        if (refSourceCode.current.trim().startsWith("<#ftl")) {
+            const [first, ...rest] = refSourceCode.current.split(">");
 
             const last = rest.join(">");
 
-            return [`${first}>`, comment, last].join("\n");
+            refSourceCode.current = [`${first}>`, comment, last].join("\n");
+            return;
         }
 
-        return toResult(comment);
+        updateRef(comment);
+        return;
     }
 
     if (fileRelativePath.endsWith(".html") || fileRelativePath.endsWith(".svg")) {
@@ -144,24 +193,31 @@ function addCommentToSourceCode(params: {
             `-->`
         ].join("\n");
 
-        if (fileRelativePath.endsWith(".html") && sourceCode.trim().startsWith("<!")) {
-            const [first, ...rest] = sourceCode.split(">");
+        if (
+            fileRelativePath.endsWith(".html") &&
+            refSourceCode.current.trim().startsWith("<!")
+        ) {
+            const [first, ...rest] = refSourceCode.current.split(">");
 
             const last = rest.join(">");
 
-            return [`${first}>`, comment, last].join("\n");
+            refSourceCode.current = [`${first}>`, comment, last].join("\n");
+            return;
         }
 
-        if (fileRelativePath.endsWith(".svg") && sourceCode.trim().startsWith("<?")) {
-            const [first, ...rest] = sourceCode.split("?>");
+        if (
+            fileRelativePath.endsWith(".svg") &&
+            refSourceCode.current.trim().startsWith("<?")
+        ) {
+            const [first, ...rest] = refSourceCode.current.split("?>");
 
             const last = rest.join("?>");
 
-            return [`${first}?>`, comment, last].join("\n");
+            refSourceCode.current = [`${first}?>`, comment, last].join("\n");
+            return;
         }
 
-        return toResult(comment);
+        updateRef(comment);
+        return;
     }
-
-    return sourceCode;
 }

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

@@ -0,0 +1,189 @@
+import * as fsPr from "fs/promises";
+import {
+    join as pathJoin,
+    sep as pathSep,
+    dirname as pathDirname,
+    relative as pathRelative
+} from "path";
+import { assert } from "tsafe/assert";
+import type { BuildContext } from "../shared/buildContext";
+import type { ExtensionModuleMeta } from "./extensionModuleMeta";
+import { existsAsync } from "../tools/fs.existsAsync";
+import { getAbsoluteAndInOsFormatPath } from "../tools/getAbsoluteAndInOsFormatPath";
+import { KEYCLOAK_THEME } from "../shared/constants";
+
+export type BuildContextLike = {
+    themeSrcDirPath: string;
+    publicDirPath: string;
+};
+
+assert<BuildContext extends BuildContextLike ? true : false>();
+
+type ExtensionModuleMetaLike = {
+    moduleName: string;
+    version: string;
+    files: {
+        isPublic: boolean;
+        fileRelativePath: string;
+    }[];
+};
+
+assert<ExtensionModuleMeta extends ExtensionModuleMetaLike ? true : false>();
+
+const DELIMITER_START = `# === Owned files start ===`;
+const DELIMITER_END = `# === Owned files end =====`;
+
+export async function writeManagedGitignoreFiles(params: {
+    buildContext: BuildContextLike;
+    extensionModuleMetas: ExtensionModuleMetaLike[];
+    ownedFilesRelativePaths: { isPublic: boolean; fileRelativePath: string }[];
+}): Promise<void> {
+    const { buildContext } = params;
+
+    for (const isPublicIteration of [false, true] as const) {
+        const extensionModuleMetas_ctx = params.extensionModuleMetas
+            .map(extensionModuleMeta => ({
+                ...extensionModuleMeta,
+                files: extensionModuleMeta.files.filter(
+                    ({ isPublic }) => isPublic === isPublicIteration
+                )
+            }))
+            .filter(extensionModuleMeta => extensionModuleMeta.files.length !== 0);
+
+        if (extensionModuleMetas_ctx.length === 0) {
+            continue;
+        }
+
+        const ownedFilesRelativePaths_ctx = params.ownedFilesRelativePaths.filter(
+            ({ isPublic }) => isPublic === isPublicIteration
+        );
+
+        const filePath = pathJoin(
+            isPublicIteration
+                ? pathJoin(buildContext.publicDirPath, KEYCLOAK_THEME)
+                : buildContext.themeSrcDirPath,
+            ".gitignore"
+        );
+
+        const content_new = Buffer.from(
+            [
+                `# This file is managed by Keycloakify, do not edit it manually.`,
+                ``,
+                DELIMITER_START,
+                ...ownedFilesRelativePaths_ctx
+                    .map(({ fileRelativePath }) => fileRelativePath)
+                    .map(fileRelativePath => fileRelativePath.split(pathSep).join("/"))
+                    .map(line => `# ${line}`),
+                DELIMITER_END,
+                ``,
+                ...extensionModuleMetas_ctx
+                    .map(extensionModuleMeta => [
+                        `# === ${extensionModuleMeta.moduleName} v${extensionModuleMeta.version} ===`,
+                        ...extensionModuleMeta.files
+                            .map(({ fileRelativePath }) => fileRelativePath)
+                            .filter(
+                                fileRelativePath =>
+                                    !ownedFilesRelativePaths_ctx
+                                        .map(({ fileRelativePath }) => fileRelativePath)
+                                        .includes(fileRelativePath)
+                            )
+                            .map(
+                                fileRelativePath =>
+                                    `/${fileRelativePath.split(pathSep).join("/").replace(/^\.\//, "")}`
+                            ),
+
+                        ``
+                    ])
+                    .flat()
+            ].join("\n"),
+            "utf8"
+        );
+
+        const content_current = await (async () => {
+            if (!(await existsAsync(filePath))) {
+                return undefined;
+            }
+
+            return await fsPr.readFile(filePath);
+        })();
+
+        if (content_current !== undefined && content_current.equals(content_new)) {
+            continue;
+        }
+
+        create_dir: {
+            const dirPath = pathDirname(filePath);
+
+            if (await existsAsync(dirPath)) {
+                break create_dir;
+            }
+
+            await fsPr.mkdir(dirPath, { recursive: true });
+        }
+
+        await fsPr.writeFile(filePath, content_new);
+    }
+}
+
+export async function readManagedGitignoresFile(params: {
+    buildContext: BuildContextLike;
+}): Promise<{
+    ownedFilesRelativePaths: { isPublic: boolean; fileRelativePath: string }[];
+}> {
+    const { buildContext } = params;
+
+    const ownedFilesRelativePaths: { isPublic: boolean; fileRelativePath: string }[] = [];
+
+    for (const isPublicIteration of [false, true] as const) {
+        const filePath = pathJoin(
+            isPublicIteration
+                ? pathJoin(buildContext.publicDirPath, KEYCLOAK_THEME)
+                : buildContext.themeSrcDirPath,
+            ".gitignore"
+        );
+
+        if (!(await existsAsync(filePath))) {
+            continue;
+        }
+
+        const contentStr = (await fsPr.readFile(filePath)).toString("utf8");
+
+        const payload = (() => {
+            const index_start = contentStr.indexOf(DELIMITER_START);
+            const index_end = contentStr.indexOf(DELIMITER_END);
+
+            if (index_start === -1 || index_end === -1) {
+                return undefined;
+            }
+
+            return contentStr
+                .slice(index_start + DELIMITER_START.length, index_end)
+                .trim();
+        })();
+
+        if (payload === undefined) {
+            continue;
+        }
+
+        payload
+            .split("\n")
+            .map(line => line.trim())
+            .map(line => line.replace(/^# /, ""))
+            .filter(line => line !== "")
+            .map(line =>
+                getAbsoluteAndInOsFormatPath({
+                    cwd: buildContext.themeSrcDirPath,
+                    pathIsh: line
+                })
+            )
+            .map(filePath => pathRelative(buildContext.themeSrcDirPath, filePath))
+            .forEach(fileRelativePath =>
+                ownedFilesRelativePaths.push({
+                    isPublic: isPublicIteration,
+                    fileRelativePath
+                })
+            );
+    }
+
+    return { ownedFilesRelativePaths };
+}

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

@@ -2,9 +2,9 @@ import type { BuildContext } from "../shared/buildContext";
 import { getExtensionModuleMetas, computeHash } from "./extensionModuleMeta";
 import { installExtensionModulesPeerDependencies } from "./installExtensionModulesPeerDependencies";
 import {
-    readManagedGitignoreFile,
-    writeManagedGitignoreFile
-} from "./managedGitignoreFile";
+    readManagedGitignoresFile,
+    writeManagedGitignoreFiles
+} from "./managedGitignoreFiles";
 import { dirname as pathDirname } from "path";
 import { join as pathJoin } from "path";
 import { existsAsync } from "../tools/fs.existsAsync";
@@ -12,6 +12,8 @@ import * as fsPr from "fs/promises";
 import { getIsKnownByGit, untrackFromGit } from "../tools/gitUtils";
 import { command as updateKcGenCommand } from "../update-kc-gen";
 import { getBuildContext } from "../shared/buildContext";
+import { KEYCLOAK_THEME } from "../shared/constants";
+import { same } from "evt/tools/inDepth/same";
 
 export async function command(params: { buildContext: BuildContext }) {
     const { buildContext } = params;
@@ -23,11 +25,11 @@ export async function command(params: { buildContext: BuildContext }) {
         extensionModuleMetas
     });
 
-    const { ownedFilesRelativePaths } = await readManagedGitignoreFile({
+    const { ownedFilesRelativePaths } = await readManagedGitignoresFile({
         buildContext
     });
 
-    await writeManagedGitignoreFile({
+    await writeManagedGitignoreFiles({
         buildContext,
         ownedFilesRelativePaths,
         extensionModuleMetas
@@ -38,13 +40,24 @@ export async function command(params: { buildContext: BuildContext }) {
             .map(extensionModuleMeta =>
                 Promise.all(
                     extensionModuleMeta.files.map(
-                        async ({ fileRelativePath, copyableFilePath, hash }) => {
-                            if (ownedFilesRelativePaths.includes(fileRelativePath)) {
+                        async ({
+                            isPublic,
+                            fileRelativePath,
+                            copyableFilePath,
+                            hash
+                        }) => {
+                            if (
+                                ownedFilesRelativePaths.some(entry =>
+                                    same(entry, { isPublic, fileRelativePath })
+                                )
+                            ) {
                                 return;
                             }
 
                             const destFilePath = pathJoin(
-                                buildContext.themeSrcDirPath,
+                                isPublic
+                                    ? pathJoin(buildContext.publicDirPath, KEYCLOAK_THEME)
+                                    : buildContext.themeSrcDirPath,
                                 fileRelativePath
                             );
 

package/src/bin/tools/runPrettier.ts

@@ -111,7 +111,15 @@ export async function getPrettier(): Promise<PrettierAndConfigHash> {
 export async function runPrettier(params: {
     sourceCode: string;
     filePath: string;
-}): Promise<string> {
+}): Promise<string>;
+export async function runPrettier(params: {
+    sourceCode: Buffer;
+    filePath: string;
+}): Promise<Buffer>;
+export async function runPrettier(params: {
+    sourceCode: string | Buffer;
+    filePath: string;
+}): Promise<string | Buffer> {
     const { sourceCode, filePath } = params;
 
     let formattedSourceCode: string;
@@ -129,11 +137,14 @@ export async function runPrettier(params: {
 
         const config = await prettier.resolveConfig(filePath);
 
-        formattedSourceCode = await prettier.format(sourceCode, {
-            ...config,
-            filePath,
-            parser: inferredParser
-        });
+        formattedSourceCode = await prettier.format(
+            typeof sourceCode === "string" ? sourceCode : sourceCode.toString("utf8"),
+            {
+                ...config,
+                filePath,
+                parser: inferredParser
+            }
+        );
     } catch (error) {
         console.log(
             chalk.red(
@@ -144,5 +155,7 @@ export async function runPrettier(params: {
         throw error;
     }
 
-    return formattedSourceCode;
+    return typeof sourceCode === "string"
+        ? formattedSourceCode
+        : Buffer.from(formattedSourceCode, "utf8");
 }

package/src/vite-plugin/vite-plugin.ts

@@ -2,7 +2,8 @@ import { join as pathJoin, relative as pathRelative, sep as pathSep } from "path
 import type { Plugin } from "vite";
 import {
     WELL_KNOWN_DIRECTORY_BASE_NAME,
-    VITE_PLUGIN_SUB_SCRIPTS_ENV_NAMES
+    VITE_PLUGIN_SUB_SCRIPTS_ENV_NAMES,
+    KEYCLOAK_THEME
 } from "../bin/shared/constants";
 import { id } from "tsafe/id";
 import { rm } from "../bin/tools/fs.rm";
@@ -203,6 +204,7 @@ export function keycloakify(params: keycloakify.Params) {
 
             assert(buildDirPath !== undefined);
 
+            // NOTE: This is legacy and should eventually be removed
             await rm(
                 pathJoin(
                     buildDirPath,
@@ -213,6 +215,11 @@ export function keycloakify(params: keycloakify.Params) {
                     force: true
                 }
             );
+
+            await rm(pathJoin(buildDirPath, KEYCLOAK_THEME), {
+                recursive: true,
+                force: true
+            });
         },
         transformIndexHtml: html => {
             const doReadKcContextFromUrl =

package/vite-plugin/index.js

@@ -1790,13 +1790,15 @@ async function runPrettier(params) {
             return sourceCode;
         }
         const config = await prettier.resolveConfig(filePath);
-        formattedSourceCode = await prettier.format(sourceCode, Object.assign(Object.assign({}, config), { filePath, parser: inferredParser }));
+        formattedSourceCode = await prettier.format(typeof sourceCode === "string" ? sourceCode : sourceCode.toString("utf8"), Object.assign(Object.assign({}, config), { filePath, parser: inferredParser }));
     }
     catch (error) {
         console.log(chalk__WEBPACK_IMPORTED_MODULE_4___default().red(`You probably need to upgrade the version of prettier in your project`));
         throw error;
     }
-    return formattedSourceCode;
+    return typeof sourceCode === "string"
+        ? formattedSourceCode
+        : Buffer.from(formattedSourceCode, "utf8");
 }
 //# sourceMappingURL=runPrettier.js.map
 
@@ -2118,10 +2120,15 @@ function keycloakify(params) {
                 return;
             }
             (0, assert_1.assert)(buildDirPath !== undefined);
+            // NOTE: This is legacy and should eventually be removed
             await (0, fs_rm_1.rm)((0, path_1.join)(buildDirPath, constants_1.WELL_KNOWN_DIRECTORY_BASE_NAME.KEYCLOAKIFY_DEV_RESOURCES), {
                 recursive: true,
                 force: true
             });
+            await (0, fs_rm_1.rm)((0, path_1.join)(buildDirPath, constants_1.KEYCLOAK_THEME), {
+                recursive: true,
+                force: true
+            });
         },
         transformIndexHtml: html => {
             const doReadKcContextFromUrl = process.env.NODE_ENV === "development" &&

package/bin/sync-extensions/managedGitignoreFile.d.ts

@@ -1,14 +0,0 @@
-import type { ExtensionModuleMeta } from "./extensionModuleMeta";
-export type BuildContextLike = {
-    themeSrcDirPath: string;
-};
-export declare function writeManagedGitignoreFile(params: {
-    buildContext: BuildContextLike;
-    extensionModuleMetas: ExtensionModuleMeta[];
-    ownedFilesRelativePaths: string[];
-}): Promise<void>;
-export declare function readManagedGitignoreFile(params: {
-    buildContext: BuildContextLike;
-}): Promise<{
-    ownedFilesRelativePaths: string[];
-}>;