keycloakify 11.8.37-rc.1 → 11.8.37

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "keycloakify",
-    "version": "11.8.37-rc.1",
+    "version": "11.8.37",
     "description": "Framework to create custom Keycloak UIs",
     "repository": {
         "type": "git",
@@ -717,7 +717,7 @@
         "src/bin/sync-extensions/getExtensionModuleFileSourceCodeReadyToBeCopied.ts",
         "src/bin/sync-extensions/index.ts",
         "src/bin/sync-extensions/installExtensionModulesPeerDependencies.ts",
-        "src/bin/sync-extensions/managedGitignoreFiles.ts",
+        "src/bin/sync-extensions/managedGitignoreFile.ts",
         "src/bin/sync-extensions/sync-extension.ts",
         "src/bin/tools/SemVer.ts",
         "src/bin/tools/String.prototype.replaceAll.ts",
@@ -1081,7 +1081,7 @@
         "bin/sync-extensions/getExtensionModuleFileSourceCodeReadyToBeCopied.d.ts",
         "bin/sync-extensions/index.d.ts",
         "bin/sync-extensions/installExtensionModulesPeerDependencies.d.ts",
-        "bin/sync-extensions/managedGitignoreFiles.d.ts",
+        "bin/sync-extensions/managedGitignoreFile.d.ts",
         "bin/sync-extensions/sync-extension.d.ts",
         "bin/tools/assertNoPnpmDlx.d.ts",
         "bin/tools/canonicalStringify.d.ts",
@@ -1128,9 +1128,9 @@
         "bin/712.index.js",
         "bin/720.index.js",
         "bin/780.index.js",
-        "bin/783.index.js",
         "bin/786.index.js",
         "bin/84.index.js",
+        "bin/864.index.js",
         "bin/877.index.js",
         "bin/910.index.js",
         "bin/930.index.js",
@@ -1214,6 +1214,7 @@
         "webpack": "5.93.0",
         "webpack-cli": "5.1.4",
         "yauzl": "^2.10.0",
-        "zod": "^3.17.10"
+        "zod": "^3.17.10",
+        "json5": "^2.2.3"
     }
 }

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

@@ -12,6 +12,7 @@ import * as fs from "fs";
 import { assert } from "tsafe/assert";
 import type { BuildContext } from "../../shared/buildContext";
 import { getAbsoluteAndInOsFormatPath } from "../../tools/getAbsoluteAndInOsFormatPath";
+import JSON5 from "json5";
 
 export type BuildContextLike = {
     themeNames: string[];
@@ -74,7 +75,7 @@ export function generateMessageProperties(params: {
                     messagesJson += line;
                 }
 
-                const messages = JSON.parse(messagesJson) as Record<string, string>;
+                const messages = JSON5.parse(messagesJson) as Record<string, string>;
 
                 return [languageTag, messages];
             })

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

@@ -37,7 +37,6 @@ import { createObjectThatThrowsIfAccessed } from "../../tools/createObjectThatTh
 import { listInstalledModules } from "../../tools/listInstalledModules";
 import { isInside } from "../../tools/isInside";
 import { id } from "tsafe/id";
-import { KEYCLOAK_THEME } from "../../shared/constants";
 
 export type BuildContextLike = BuildContextLike_kcContextExclusionsFtlCode &
     BuildContextLike_generateMessageProperties & {
@@ -45,7 +44,6 @@ export type BuildContextLike = BuildContextLike_kcContextExclusionsFtlCode &
         extraThemeProperties: string[] | undefined;
         projectDirPath: string;
         projectBuildDirPath: string;
-        publicDirPath: string;
         environmentVariables: { name: string; default: string }[];
         implementedThemeTypes: BuildContext["implementedThemeTypes"];
         themeSrcDirPath: string;
@@ -155,14 +153,10 @@ export async function generateResources(params: {
                 break apply_replacers_and_move_to_theme_resources;
             }
 
-            for (const directoryBasename of [
-                KEYCLOAK_THEME,
-                // NOTE: This is legacy and should eventually be removed
-                WELL_KNOWN_DIRECTORY_BASE_NAME.KEYCLOAKIFY_DEV_RESOURCES
-            ]) {
+            {
                 const dirPath = pathJoin(
                     buildContext.projectBuildDirPath,
-                    directoryBasename
+                    WELL_KNOWN_DIRECTORY_BASE_NAME.KEYCLOAKIFY_DEV_RESOURCES
                 );
 
                 if (fs.existsSync(dirPath)) {
@@ -170,7 +164,7 @@ export async function generateResources(params: {
 
                     throw new Error(
                         [
-                            `Keycloakify build error: The ${directoryBasename} directory shouldn't exist in your build directory.`,
+                            `Keycloakify build error: The ${WELL_KNOWN_DIRECTORY_BASE_NAME.KEYCLOAKIFY_DEV_RESOURCES} directory shouldn't exist in your build directory.`,
                             `(${pathRelative(process.cwd(), dirPath)}).\n`,
                             `Theses assets are only required for local development with Storybook.",
                             "Please remove this directory as an additional step of your command.\n`,
@@ -575,7 +569,6 @@ export async function generateResources(params: {
             };
         }
 
-        // NOTE: Legacy
         keycloak_static_resources: {
             if (isNative) {
                 break keycloak_static_resources;
@@ -585,8 +578,6 @@ export async function generateResources(params: {
                 break keycloak_static_resources;
             }
 
-            // TODO: Implement a check to skip that.
-
             transformCodebase({
                 srcDirPath: pathJoin(
                     getThisCodebaseRootDirPath(),
@@ -599,37 +590,6 @@ export async function generateResources(params: {
             });
         }
 
-        extensions_static_resources: {
-            if (isNative) {
-                break extensions_static_resources;
-            }
-
-            if (isSpa) {
-                break extensions_static_resources;
-            }
-
-            const dirPath = pathJoin(
-                buildContext.publicDirPath,
-                KEYCLOAK_THEME,
-                themeType
-            );
-
-            if (!fs.existsSync(dirPath)) {
-                break extensions_static_resources;
-            }
-
-            transformCodebase({
-                srcDirPath: dirPath,
-                destDirPath: pathJoin(
-                    themeTypeDirPath,
-                    "resources",
-                    WELL_KNOWN_DIRECTORY_BASE_NAME.DIST,
-                    KEYCLOAK_THEME,
-                    themeType
-                )
-            });
-        }
-
         bring_in_account_v1: {
             if (isNative) {
                 break bring_in_account_v1;

package/src/bin/main.ts

@@ -281,7 +281,6 @@ program
     .command<{
         path: string;
         revert: boolean;
-        public: boolean;
     }>({
         name: "own",
         description: [
@@ -332,30 +331,14 @@ program
         ].join(" "),
         defaultValue: false
     })
-    .option({
-        key: "public",
-        name: (() => {
-            const long = "public";
-            const short = "p";
-
-            optionsKeys.push(long, short);
-
-            return { long, short };
-        })(),
-        description: [
-            "Flag to use when targeting a file or directory in the public directory",
-            "instead of the src"
-        ].join(" "),
-        defaultValue: false
-    })
     .task({
         skip,
-        handler: async ({ projectDirPath, path, revert, public: public_params }) => {
+        handler: async ({ projectDirPath, path, revert }) => {
             const { command } = await import("./own");
 
             await command({
                 buildContext: getBuildContext({ projectDirPath }),
-                cliCommandOptions: { path, isRevert: revert, isPublic: public_params }
+                cliCommandOptions: { path, isRevert: revert }
             });
         }
     });

package/src/bin/own.ts

@@ -3,17 +3,15 @@ import { getExtensionModuleFileSourceCodeReadyToBeCopied } from "./sync-extensio
 import type { ExtensionModuleMeta } from "./sync-extensions/extensionModuleMeta";
 import { command as command_syncExtensions } from "./sync-extensions/sync-extension";
 import {
-    readManagedGitignoresFile,
-    writeManagedGitignoreFiles
-} from "./sync-extensions/managedGitignoreFiles";
+    readManagedGitignoreFile,
+    writeManagedGitignoreFile
+} from "./sync-extensions/managedGitignoreFile";
 import { getExtensionModuleMetas } from "./sync-extensions/extensionModuleMeta";
 import { getAbsoluteAndInOsFormatPath } from "./tools/getAbsoluteAndInOsFormatPath";
 import { relative as pathRelative, dirname as pathDirname, join as pathJoin } from "path";
 import { getInstalledModuleDirPath } from "./tools/getInstalledModuleDirPath";
 import * as fsPr from "fs/promises";
 import { isInside } from "./tools/isInside";
-import { KEYCLOAK_THEME } from "./shared/constants";
-import { same } from "evt/tools/inDepth/same";
 import chalk from "chalk";
 
 export async function command(params: {
@@ -21,7 +19,6 @@ export async function command(params: {
     cliCommandOptions: {
         path: string;
         isRevert: boolean;
-        isPublic: boolean;
     };
 }) {
     const { buildContext, cliCommandOptions } = params;
@@ -29,34 +26,27 @@ export async function command(params: {
     const extensionModuleMetas = await getExtensionModuleMetas({ buildContext });
 
     const { targetFileRelativePathsByExtensionModuleMeta } = await (async () => {
-        const fileOrDirectoryRelativePath = (() => {
-            const dirPath_ctx = cliCommandOptions.isPublic
-                ? pathJoin(buildContext.publicDirPath, KEYCLOAK_THEME)
-                : buildContext.themeSrcDirPath;
-
-            return pathRelative(
-                dirPath_ctx,
-                getAbsoluteAndInOsFormatPath({
-                    cwd: dirPath_ctx,
-                    pathIsh: cliCommandOptions.path
-                })
-            );
-        })();
+        const fileOrDirectoryRelativePath = pathRelative(
+            buildContext.themeSrcDirPath,
+            getAbsoluteAndInOsFormatPath({
+                cwd: buildContext.themeSrcDirPath,
+                pathIsh: cliCommandOptions.path
+            })
+        );
 
         const arr = extensionModuleMetas
             .map(extensionModuleMeta => ({
                 extensionModuleMeta,
                 fileRelativePaths: extensionModuleMeta.files
+                    .map(({ fileRelativePath }) => fileRelativePath)
                     .filter(
-                        ({ fileRelativePath, isPublic }) =>
-                            cliCommandOptions.isPublic === isPublic &&
-                            (fileRelativePath === fileOrDirectoryRelativePath ||
-                                isInside({
-                                    dirPath: fileOrDirectoryRelativePath,
-                                    filePath: fileRelativePath
-                                }))
+                        fileRelativePath =>
+                            fileRelativePath === fileOrDirectoryRelativePath ||
+                            isInside({
+                                dirPath: fileOrDirectoryRelativePath,
+                                filePath: fileRelativePath
+                            })
                     )
-                    .map(({ fileRelativePath }) => fileRelativePath)
             }))
             .filter(({ fileRelativePaths }) => fileRelativePaths.length !== 0);
 
@@ -85,13 +75,12 @@ export async function command(params: {
     }
 
     const { ownedFilesRelativePaths: ownedFilesRelativePaths_current } =
-        await readManagedGitignoresFile({
+        await readManagedGitignoreFile({
             buildContext
         });
 
     await (cliCommandOptions.isRevert ? command_revert : command_own)({
         extensionModuleMetas,
-        isPublic: cliCommandOptions.isPublic,
         targetFileRelativePathsByExtensionModuleMeta,
         ownedFilesRelativePaths_current,
         buildContext
@@ -100,22 +89,20 @@ export async function command(params: {
 
 type Params_subcommands = {
     extensionModuleMetas: ExtensionModuleMeta[];
-    isPublic: boolean;
     targetFileRelativePathsByExtensionModuleMeta: Map<ExtensionModuleMeta, string[]>;
-    ownedFilesRelativePaths_current: { isPublic: boolean; fileRelativePath: string }[];
+    ownedFilesRelativePaths_current: string[];
     buildContext: BuildContext;
 };
 
 async function command_own(params: Params_subcommands) {
     const {
         extensionModuleMetas,
-        isPublic,
         targetFileRelativePathsByExtensionModuleMeta,
         ownedFilesRelativePaths_current,
         buildContext
     } = params;
 
-    await writeManagedGitignoreFiles({
+    await writeManagedGitignoreFile({
         buildContext,
         extensionModuleMetas,
         ownedFilesRelativePaths: [
@@ -124,11 +111,8 @@ async function command_own(params: Params_subcommands) {
                 .flat()
                 .filter(
                     fileRelativePath =>
-                        !ownedFilesRelativePaths_current.some(entry =>
-                            same(entry, { isPublic, fileRelativePath })
-                        )
+                        !ownedFilesRelativePaths_current.includes(fileRelativePath)
                 )
-                .map(fileRelativePath => ({ isPublic, fileRelativePath }))
         ]
     });
 
@@ -144,11 +128,7 @@ async function command_own(params: Params_subcommands) {
         });
 
         for (const fileRelativePath of fileRelativePaths) {
-            if (
-                ownedFilesRelativePaths_current.some(entry =>
-                    same(entry, { isPublic, fileRelativePath })
-                )
-            ) {
+            if (ownedFilesRelativePaths_current.includes(fileRelativePath)) {
                 console.log(
                     chalk.grey(`You already have ownership over '${fileRelativePath}'.`)
                 );
@@ -158,7 +138,6 @@ async function command_own(params: Params_subcommands) {
             writeActions.push(async () => {
                 const sourceCode = await getExtensionModuleFileSourceCodeReadyToBeCopied({
                     buildContext,
-                    isPublic,
                     fileRelativePath,
                     isOwnershipAction: true,
                     extensionModuleName: extensionModuleMeta.moduleName,
@@ -167,12 +146,7 @@ async function command_own(params: Params_subcommands) {
                 });
 
                 await fsPr.writeFile(
-                    pathJoin(
-                        isPublic
-                            ? pathJoin(buildContext.publicDirPath, KEYCLOAK_THEME)
-                            : buildContext.themeSrcDirPath,
-                        fileRelativePath
-                    ),
+                    pathJoin(buildContext.themeSrcDirPath, fileRelativePath),
                     sourceCode
                 );
 
@@ -192,7 +166,6 @@ async function command_own(params: Params_subcommands) {
 async function command_revert(params: Params_subcommands) {
     const {
         extensionModuleMetas,
-        isPublic,
         targetFileRelativePathsByExtensionModuleMeta,
         ownedFilesRelativePaths_current,
         buildContext
@@ -203,11 +176,7 @@ async function command_revert(params: Params_subcommands) {
     )
         .flat()
         .filter(fileRelativePath => {
-            if (
-                !ownedFilesRelativePaths_current.some(entry =>
-                    same(entry, { isPublic, fileRelativePath })
-                )
-            ) {
+            if (!ownedFilesRelativePaths_current.includes(fileRelativePath)) {
                 console.log(
                     chalk.grey(`Ownership over '${fileRelativePath}' wasn't claimed.`)
                 );
@@ -226,14 +195,12 @@ async function command_revert(params: Params_subcommands) {
         return;
     }
 
-    await writeManagedGitignoreFiles({
+    await writeManagedGitignoreFile({
         buildContext,
         extensionModuleMetas,
         ownedFilesRelativePaths: ownedFilesRelativePaths_current.filter(
-            entry =>
-                !ownedFilesRelativePaths_toRemove.some(fileRelativePath =>
-                    same(entry, { isPublic, fileRelativePath })
-                )
+            fileRelativePath =>
+                !ownedFilesRelativePaths_toRemove.includes(fileRelativePath)
         )
     });
 

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

@@ -1,12 +1,7 @@
 import { assert, type Equals, is } from "tsafe/assert";
 import { id } from "tsafe/id";
 import { z } from "zod";
-import {
-    join as pathJoin,
-    dirname as pathDirname,
-    relative as pathRelative,
-    sep as pathSep
-} from "path";
+import { join as pathJoin, dirname as pathDirname } from "path";
 import * as fsPr from "fs/promises";
 import type { BuildContext } from "../shared/buildContext";
 import { existsAsync } from "../tools/fs.existsAsync";
@@ -27,7 +22,6 @@ export type ExtensionModuleMeta = {
     moduleName: string;
     version: string;
     files: {
-        isPublic: boolean;
         fileRelativePath: string;
         hash: string;
         copyableFilePath: string;
@@ -43,7 +37,6 @@ const zExtensionModuleMeta = (() => {
         version: z.string(),
         files: z.array(
             z.object({
-                isPublic: z.boolean(),
                 fileRelativePath: z.string(),
                 hash: z.string(),
                 copyableFilePath: z.string()
@@ -229,53 +222,49 @@ export async function getExtensionModuleMetas(params: {
 
                 const files: ExtensionModuleMeta["files"] = [];
 
-                await crawlAsync({
-                    dirPath: pathJoin(dirPath, KEYCLOAK_THEME),
-                    returnedPathsType: "relative to dirPath",
-                    onFileFound: async fileRelativePath => {
-                        const isPublic = fileRelativePath.startsWith(`public${pathSep}`);
-
-                        const fileRelativePath_contextual = isPublic
-                            ? pathRelative("public", fileRelativePath)
-                            : fileRelativePath;
-
-                        const sourceCode =
-                            await getExtensionModuleFileSourceCodeReadyToBeCopied({
-                                buildContext,
-                                isPublic,
-                                fileRelativePath: fileRelativePath_contextual,
-                                isOwnershipAction: false,
-                                extensionModuleDirPath: dirPath,
-                                extensionModuleName: moduleName,
-                                extensionModuleVersion: version
-                            });
-
-                        const hash = computeHash(sourceCode);
-
-                        const copyableFilePath = pathJoin(
-                            pathDirname(cacheFilePath),
-                            KEYCLOAK_THEME,
-                            fileRelativePath
-                        );
-
-                        {
-                            const dirPath = pathDirname(copyableFilePath);
-
-                            if (!(await existsAsync(dirPath))) {
-                                await fsPr.mkdir(dirPath, { recursive: true });
+                {
+                    const srcDirPath = pathJoin(dirPath, KEYCLOAK_THEME);
+
+                    await crawlAsync({
+                        dirPath: srcDirPath,
+                        returnedPathsType: "relative to dirPath",
+                        onFileFound: async fileRelativePath => {
+                            const sourceCode =
+                                await getExtensionModuleFileSourceCodeReadyToBeCopied({
+                                    buildContext,
+                                    fileRelativePath,
+                                    isOwnershipAction: false,
+                                    extensionModuleDirPath: dirPath,
+                                    extensionModuleName: moduleName,
+                                    extensionModuleVersion: version
+                                });
+
+                            const hash = computeHash(sourceCode);
+
+                            const copyableFilePath = pathJoin(
+                                pathDirname(cacheFilePath),
+                                KEYCLOAK_THEME,
+                                fileRelativePath
+                            );
+
+                            {
+                                const dirPath = pathDirname(copyableFilePath);
+
+                                if (!(await existsAsync(dirPath))) {
+                                    await fsPr.mkdir(dirPath, { recursive: true });
+                                }
                             }
-                        }
 
-                        fsPr.writeFile(copyableFilePath, sourceCode);
+                            fsPr.writeFile(copyableFilePath, sourceCode);
 
-                        files.push({
-                            isPublic,
-                            fileRelativePath: fileRelativePath_contextual,
-                            hash,
-                            copyableFilePath
-                        });
-                    }
-                });
+                            files.push({
+                                fileRelativePath,
+                                hash,
+                                copyableFilePath
+                            });
+                        }
+                    });
+                }
 
                 return id<ExtensionModuleMeta>({
                     moduleName,

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

@@ -7,14 +7,12 @@ 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;
@@ -24,7 +22,6 @@ export async function getExtensionModuleFileSourceCodeReadyToBeCopied(params: {
     const {
         buildContext,
         extensionModuleDirPath,
-        isPublic,
         fileRelativePath,
         isOwnershipAction,
         extensionModuleName,
@@ -64,12 +61,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}"${isPublic ? " --public " : ""}--revert`
+                      `$ npx keycloakify own --path "${path}" --revert`
                   ]
                 : [
                       `WARNING: Before modifying this file, run the following command:`,
                       ``,
-                      `$ npx keycloakify own --path "${path}"${isPublic ? " --public" : ""}`,
+                      `$ npx keycloakify own --path "${path}"`,
                       ``,
                       `This file is provided by ${extensionModuleName} version ${extensionModuleVersion}.`,
                       `It was copied into your repository by the postinstall script: \`keycloakify sync-extensions\`.`
@@ -77,12 +74,7 @@ export async function getExtensionModuleFileSourceCodeReadyToBeCopied(params: {
         })()
     });
 
-    const destFilePath = pathJoin(
-        isPublic
-            ? pathJoin(buildContext.publicDirPath, KEYCLOAK_THEME)
-            : buildContext.themeSrcDirPath,
-        fileRelativePath
-    );
+    const destFilePath = pathJoin(buildContext.themeSrcDirPath, fileRelativePath);
 
     format: {
         if (!(await getIsPrettierAvailable())) {