keycloakify 11.8.36-rc.1 → 11.8.37-rc.1

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/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

@@ -2118,10 +2118,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[];
-}>;

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

@@ -1,136 +0,0 @@
-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";
-
-export type BuildContextLike = {
-    themeSrcDirPath: string;
-};
-
-assert<BuildContext extends BuildContextLike ? true : false>();
-
-const DELIMITER_START = `# === Owned files start ===`;
-const DELIMITER_END = `# === Owned files end =====`;
-
-export async function writeManagedGitignoreFile(params: {
-    buildContext: BuildContextLike;
-    extensionModuleMetas: ExtensionModuleMeta[];
-    ownedFilesRelativePaths: string[];
-}): Promise<void> {
-    const { buildContext, extensionModuleMetas, ownedFilesRelativePaths } = params;
-
-    if (extensionModuleMetas.length === 0) {
-        return;
-    }
-
-    const filePath = pathJoin(buildContext.themeSrcDirPath, ".gitignore");
-
-    const content_new = Buffer.from(
-        [
-            `# This file is managed by Keycloakify, do not edit it manually.`,
-            ``,
-            DELIMITER_START,
-            ...ownedFilesRelativePaths
-                .map(fileRelativePath => fileRelativePath.split(pathSep).join("/"))
-                .map(line => `# ${line}`),
-            DELIMITER_END,
-            ``,
-            ...extensionModuleMetas
-                .map(extensionModuleMeta => [
-                    `# === ${extensionModuleMeta.moduleName} v${extensionModuleMeta.version} ===`,
-                    ...extensionModuleMeta.files
-                        .map(({ fileRelativePath }) => fileRelativePath)
-                        .filter(
-                            fileRelativePath =>
-                                !ownedFilesRelativePaths.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)) {
-        return;
-    }
-
-    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 readManagedGitignoreFile(params: {
-    buildContext: BuildContextLike;
-}): Promise<{
-    ownedFilesRelativePaths: string[];
-}> {
-    const { buildContext } = params;
-
-    const filePath = pathJoin(buildContext.themeSrcDirPath, ".gitignore");
-
-    if (!(await existsAsync(filePath))) {
-        return { ownedFilesRelativePaths: [] };
-    }
-
-    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) {
-        return { ownedFilesRelativePaths: [] };
-    }
-
-    const ownedFilesRelativePaths = 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));
-
-    return { ownedFilesRelativePaths };
-}