keycloakify 10.0.0-rc.30 → 10.0.0-rc.32

package/account/KcContext/getKcContextMock.d.ts

@@ -18,5 +18,7 @@ export declare function createGetKcContextMock<KcContextExtraProperties extends
         overrides?: DeepPartial<Extract<ExtendKcContext<KcContextExtraProperties, KcContextExtraPropertiesPerPage>, {
             pageId: PageId;
         }>> | undefined;
-    }) => ExtendKcContext<KcContextExtraProperties, KcContextExtraPropertiesPerPage>;
+    }) => Extract<ExtendKcContext<KcContextExtraProperties, KcContextExtraPropertiesPerPage>, {
+        pageId: PageId;
+    }>;
 };

package/account/KcContext/getKcContextMock.js.map

@@ -1 +1 @@
-{"version":3,"file":"getKcContextMock.js","sourceRoot":"","sources":["../../src/account/KcContext/getKcContextMock.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,2BAA2B,EAAE,MAAM,+CAA+C,CAAC;AAC5F,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,MAAM,UAAU,sBAAsB,CAMpC,MAiBD;IACG,MAAM,EACF,wBAAwB,EACxB,+BAA+B,EAC/B,SAAS,EAAE,gBAAgB,EAC3B,gBAAgB,EAAE,uBAAuB,EAC5C,GAAG,MAAM,CAAC;IAOX,SAAS,gBAAgB,CAEvB,MAKD;;QACG,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAErC,MAAM,aAAa,GAAG,2BAA2B,CAC7C,MAAA,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,aAAa,CAAC,MAAM,KAAK,MAAM,CAAC,mEAC9D,mBAAmB,KACtB,MAAM,GACT,CACJ,CAAC;QAEF;YACI,wBAAwB;YACxB,+BAA+B,CAAC,MAAM,CAAC;YACvC,gBAAgB;YAChB,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAG,MAAM,CAAC;YACjC,SAAS;SACZ;aACI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;aAC1B,OAAO,CAAC,SAAS,CAAC,EAAE,CACjB,UAAU,CAAC;YACP,MAAM,EAAE,aAAa;YACrB,MAAM,EAAE,SAAS;SACpB,CAAC,CACL,CAAC;QAEN,mBAAmB;QACnB,OAAO,aAAa,CAAC;IACzB,CAAC;IAED,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAChC,CAAC"}
+{"version":3,"file":"getKcContextMock.js","sourceRoot":"","sources":["../../src/account/KcContext/getKcContextMock.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,2BAA2B,EAAE,MAAM,+CAA+C,CAAC;AAC5F,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,MAAM,UAAU,sBAAsB,CAMpC,MAiBD;IACG,MAAM,EACF,wBAAwB,EACxB,+BAA+B,EAC/B,SAAS,EAAE,gBAAgB,EAC3B,gBAAgB,EAAE,uBAAuB,EAC5C,GAAG,MAAM,CAAC;IAOX,SAAS,gBAAgB,CAEvB,MAGD;;QACG,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAErC,MAAM,aAAa,GAAG,2BAA2B,CAC7C,MAAA,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,aAAa,CAAC,MAAM,KAAK,MAAM,CAAC,mEAC9D,mBAAmB,KACtB,MAAM,GACT,CACJ,CAAC;QAEF;YACI,wBAAwB;YACxB,+BAA+B,CAAC,MAAM,CAAC;YACvC,gBAAgB;YAChB,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAG,MAAM,CAAC;YACjC,SAAS;SACZ;aACI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;aAC1B,OAAO,CAAC,SAAS,CAAC,EAAE,CACjB,UAAU,CAAC;YACP,MAAM,EAAE,aAAa;YACrB,MAAM,EAAE,SAAS;SACpB,CAAC,CACL,CAAC;QAEN,mBAAmB;QACnB,OAAO,aAAa,CAAC;IACzB,CAAC;IAED,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAChC,CAAC"}

package/bin/main.js

@@ -1193,6 +1193,7 @@ var constants_1 = __nccwpck_require__(173);
 var getThisCodebaseRootDirPath_1 = __nccwpck_require__(58822);
 (0, assert_1.assert)();
 function generateFtlFilesCodeFactory(params) {
+    var _a;
     var themeName = params.themeName, cssGlobalsToDefine = params.cssGlobalsToDefine, indexHtmlCode = params.indexHtmlCode, buildOptions = params.buildOptions, keycloakifyVersion = params.keycloakifyVersion, themeType = params.themeType, fieldNames = params.fieldNames;
     var $ = cheerio_1.default.load(indexHtmlCode);
     fix_imports_statements: {
@@ -1267,7 +1268,8 @@ function generateFtlFilesCodeFactory(params) {
         .replace("KEYCLOAKIFY_THEME_TYPE_dExKd3xEdr", themeType)
         .replace("KEYCLOAKIFY_THEME_NAME_cXxKd3xEer", themeName)
         .replace("RESOURCES_COMMON_cLsLsMrtDkpVv", constants_1.resources_common)
-        .replace("lOCALIZATION_REALM_OVERRIDES_USER_PROFILE_PROPERTY_KEY_aaGLsPgGIdeeX", constants_1.nameOfTheLocalizationRealmOverridesUserProfileProperty);
+        .replace("lOCALIZATION_REALM_OVERRIDES_USER_PROFILE_PROPERTY_KEY_aaGLsPgGIdeeX", constants_1.nameOfTheLocalizationRealmOverridesUserProfileProperty)
+        .replace("USER_DEFINED_EXCLUSIONS_eKsaY4ZsZ4eMr2", (_a = buildOptions.kcContextExclusionsFtlCode) !== null && _a !== void 0 ? _a : "");
     var ftlObjectToJsCodeDeclaringAnObjectPlaceholder = '{ "x": "vIdLqMeOed9sdLdIdOxdK0d" }';
     $("head").prepend("<script>\nwindow.".concat(constants_1.nameOfTheGlobal, "=").concat(ftlObjectToJsCodeDeclaringAnObjectPlaceholder, "</script>"));
     // Remove part of the document marked as ignored.
@@ -3858,7 +3860,8 @@ function readBuildOptions(params) {
             }
             return (0, path_1.join)(reactAppBuildDirPath, resolvedViteConfig.assetsDir);
         })(),
-        npmWorkspaceRootDirPath: npmWorkspaceRootDirPath
+        npmWorkspaceRootDirPath: npmWorkspaceRootDirPath,
+        kcContextExclusionsFtlCode: userProvidedBuildOptions.kcContextExclusionsFtlCode
     };
 }
 exports.readBuildOptions = readBuildOptions;

package/login/KcContext/getKcContextMock.d.ts

@@ -18,5 +18,7 @@ export declare function createGetKcContextMock<KcContextExtraProperties extends
         overrides?: DeepPartial<Extract<ExtendKcContext<KcContextExtraProperties, KcContextExtraPropertiesPerPage>, {
             pageId: PageId;
         }>> | undefined;
-    }) => ExtendKcContext<KcContextExtraProperties, KcContextExtraPropertiesPerPage>;
+    }) => Extract<ExtendKcContext<KcContextExtraProperties, KcContextExtraPropertiesPerPage>, {
+        pageId: PageId;
+    }>;
 };

package/login/KcContext/getKcContextMock.js.map

@@ -1 +1 @@
-{"version":3,"file":"getKcContextMock.js","sourceRoot":"","sources":["../../src/login/KcContext/getKcContextMock.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,2BAA2B,EAAE,MAAM,+CAA+C,CAAC;AAC5F,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,MAAM,UAAU,sBAAsB,CAMpC,MAiBD;IACG,MAAM,EACF,wBAAwB,EACxB,+BAA+B,EAC/B,SAAS,EAAE,gBAAgB,EAC3B,gBAAgB,EAAE,uBAAuB,EAC5C,GAAG,MAAM,CAAC;IAOX,SAAS,gBAAgB,CAEvB,MAKD;;QACG,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAErC,MAAM,aAAa,GAAG,2BAA2B,CAC7C,MAAA,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,aAAa,CAAC,MAAM,KAAK,MAAM,CAAC,mEAC9D,mBAAmB,KACtB,MAAM,GACT,CACJ,CAAC;QAEF;YACI,wBAAwB;YACxB,+BAA+B,CAAC,MAAM,CAAC;YACvC,gBAAgB;YAChB,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAG,MAAM,CAAC;YACjC,SAAS;SACZ;aACI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;aAC1B,OAAO,CAAC,SAAS,CAAC,EAAE,CACjB,UAAU,CAAC;YACP,MAAM,EAAE,aAAa;YACrB,MAAM,EAAE,SAAS;SACpB,CAAC,CACL,CAAC;QAEN,mBAAmB;QACnB,OAAO,aAAa,CAAC;IACzB,CAAC;IAED,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAChC,CAAC"}
+{"version":3,"file":"getKcContextMock.js","sourceRoot":"","sources":["../../src/login/KcContext/getKcContextMock.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,2BAA2B,EAAE,MAAM,+CAA+C,CAAC;AAC5F,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,MAAM,UAAU,sBAAsB,CAMpC,MAiBD;IACG,MAAM,EACF,wBAAwB,EACxB,+BAA+B,EAC/B,SAAS,EAAE,gBAAgB,EAC3B,gBAAgB,EAAE,uBAAuB,EAC5C,GAAG,MAAM,CAAC;IAOX,SAAS,gBAAgB,CAEvB,MAGD;;QACG,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAErC,MAAM,aAAa,GAAG,2BAA2B,CAC7C,MAAA,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,aAAa,CAAC,MAAM,KAAK,MAAM,CAAC,mEAC9D,mBAAmB,KACtB,MAAM,GACT,CACJ,CAAC;QAEF;YACI,wBAAwB;YACxB,+BAA+B,CAAC,MAAM,CAAC;YACvC,gBAAgB;YAChB,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAG,MAAM,CAAC;YACjC,SAAS;SACZ;aACI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;aAC1B,OAAO,CAAC,SAAS,CAAC,EAAE,CACjB,UAAU,CAAC;YACP,MAAM,EAAE,aAAa;YACrB,MAAM,EAAE,SAAS;SACpB,CAAC,CACL,CAAC;QAEN,mBAAmB;QACnB,OAAO,aAAa,CAAC;IACzB,CAAC;IAED,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAChC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "keycloakify",
-    "version": "10.0.0-rc.30",
+    "version": "10.0.0-rc.32",
     "description": "Create Keycloak themes using React",
     "repository": {
         "type": "git",

package/src/account/KcContext/getKcContextMock.ts

@@ -47,9 +47,7 @@ export function createGetKcContextMock<
     >(params: {
         pageId: PageId;
         overrides?: DeepPartial<Extract<KcContext, { pageId: PageId }>>;
-        // NOTE: We choose to have a return type less precise than Extract<KcContext, { pageId: PageId }> {
-        // because we want to be able to use the mock just as the real KcContext.
-    }): KcContext {
+    }): Extract<KcContext, { pageId: PageId }> {
         const { pageId, overrides } = params;
 
         const kcContextMock = structuredCloneButFunctions(

package/src/bin/keycloakify/generateFtl/ftl_object_to_js_code_declaring_an_object.ftl

@@ -299,6 +299,8 @@ function decodeHtmlEntities(htmlStr){
                     <#local out_seq += ["/*" + path?join(".") + "." + key + " excluded*/"]>
                     <#continue>
                 </#if>
+                
+                USER_DEFINED_EXCLUSIONS_eKsaY4ZsZ4eMr2
 
                 <#-- https://github.com/keycloakify/keycloakify/discussions/406 -->
                 <#if (

package/src/bin/keycloakify/generateFtl/generateFtl.ts

@@ -21,6 +21,7 @@ export type BuildOptionsLike = {
     urlPathname: string | undefined;
     reactAppBuildDirPath: string;
     assetsDirPath: string;
+    kcContextExclusionsFtlCode: string | undefined;
 };
 
 assert<BuildOptions extends BuildOptionsLike ? true : false>();
@@ -140,6 +141,10 @@ export function generateFtlFilesCodeFactory(params: {
         .replace(
             "lOCALIZATION_REALM_OVERRIDES_USER_PROFILE_PROPERTY_KEY_aaGLsPgGIdeeX",
             nameOfTheLocalizationRealmOverridesUserProfileProperty
+        )
+        .replace(
+            "USER_DEFINED_EXCLUSIONS_eKsaY4ZsZ4eMr2",
+            buildOptions.kcContextExclusionsFtlCode ?? ""
         );
     const ftlObjectToJsCodeDeclaringAnObjectPlaceholder =
         '{ "x": "vIdLqMeOed9sdLdIdOxdK0d" }';

package/src/bin/keycloakify/generateSrcMainResources/bringInAccountV1.ts

@@ -10,7 +10,7 @@ import {
 import { downloadKeycloakDefaultTheme } from "../../shared/downloadKeycloakDefaultTheme";
 import { transformCodebase } from "../../tools/transformCodebase";
 
-type BuildOptionsLike = {
+export type BuildOptionsLike = {
     cacheDirPath: string;
     npmWorkspaceRootDirPath: string;
     keycloakifyBuildDirPath: string;

package/src/bin/keycloakify/generateSrcMainResources/generateSrcMainResourcesForMainTheme.ts

@@ -3,7 +3,10 @@ import * as fs from "fs";
 import { join as pathJoin, resolve as pathResolve } from "path";
 import { replaceImportsInJsCode } from "../replacers/replaceImportsInJsCode";
 import { replaceImportsInCssCode } from "../replacers/replaceImportsInCssCode";
-import { generateFtlFilesCodeFactory } from "../generateFtl";
+import {
+    generateFtlFilesCodeFactory,
+    type BuildOptionsLike as BuildOptionsLike_kcContextExclusionsFtlCode
+} from "../generateFtl";
 import {
     type ThemeType,
     lastKeycloakVersionWithAccountV1,
@@ -16,11 +19,17 @@ import {
 import { isInside } from "../../tools/isInside";
 import type { BuildOptions } from "../../shared/buildOptions";
 import { assert, type Equals } from "tsafe/assert";
-import { downloadKeycloakStaticResources } from "../../shared/downloadKeycloakStaticResources";
+import {
+    downloadKeycloakStaticResources,
+    type BuildOptionsLike as BuildOptionsLike_downloadKeycloakStaticResources
+} from "../../shared/downloadKeycloakStaticResources";
 import { readFieldNameUsage } from "./readFieldNameUsage";
 import { readExtraPagesNames } from "./readExtraPageNames";
 import { generateMessageProperties } from "./generateMessageProperties";
-import { bringInAccountV1 } from "./bringInAccountV1";
+import {
+    bringInAccountV1,
+    type BuildOptionsLike as BuildOptionsLike_bringInAccountV1
+} from "./bringInAccountV1";
 import { getThemeSrcDirPath } from "../../shared/getThemeSrcDirPath";
 import { rmSync } from "../../tools/fs.rmSync";
 import { readThisNpmPackageVersion } from "../../tools/readThisNpmPackageVersion";
@@ -30,19 +39,18 @@ import {
 } from "../../shared/metaInfKeycloakThemes";
 import { objectEntries } from "tsafe/objectEntries";
 
-export type BuildOptionsLike = {
-    bundler: "vite" | "webpack";
-    extraThemeProperties: string[] | undefined;
-    themeVersion: string;
-    loginThemeResourcesFromKeycloakVersion: string;
-    reactAppBuildDirPath: string;
-    cacheDirPath: string;
-    assetsDirPath: string;
-    urlPathname: string | undefined;
-    npmWorkspaceRootDirPath: string;
-    reactAppRootDirPath: string;
-    keycloakifyBuildDirPath: string;
-};
+export type BuildOptionsLike = BuildOptionsLike_kcContextExclusionsFtlCode &
+    BuildOptionsLike_downloadKeycloakStaticResources &
+    BuildOptionsLike_bringInAccountV1 & {
+        bundler: "vite" | "webpack";
+        extraThemeProperties: string[] | undefined;
+        loginThemeResourcesFromKeycloakVersion: string;
+        reactAppBuildDirPath: string;
+        assetsDirPath: string;
+        urlPathname: string | undefined;
+        reactAppRootDirPath: string;
+        keycloakifyBuildDirPath: string;
+    };
 
 assert<BuildOptions extends BuildOptionsLike ? true : false>();
 

package/src/bin/shared/buildOptions.ts

@@ -30,6 +30,7 @@ export type BuildOptions = {
     urlPathname: string | undefined;
     assetsDirPath: string;
     npmWorkspaceRootDirPath: string;
+    kcContextExclusionsFtlCode: string | undefined;
 };
 
 export type UserProvidedBuildOptions = {
@@ -39,6 +40,7 @@ export type UserProvidedBuildOptions = {
     loginThemeResourcesFromKeycloakVersion?: string;
     keycloakifyBuildDirPath?: string;
     themeName?: string | string[];
+    kcContextExclusionsFtlCode?: string;
 };
 
 export type ResolvedViteConfig = {
@@ -302,6 +304,7 @@ export function readBuildOptions(params: {
 
             return pathJoin(reactAppBuildDirPath, resolvedViteConfig.assetsDir);
         })(),
-        npmWorkspaceRootDirPath
+        npmWorkspaceRootDirPath,
+        kcContextExclusionsFtlCode: userProvidedBuildOptions.kcContextExclusionsFtlCode
     };
 }

package/src/login/KcContext/getKcContextMock.ts

@@ -47,9 +47,7 @@ export function createGetKcContextMock<
     >(params: {
         pageId: PageId;
         overrides?: DeepPartial<Extract<KcContext, { pageId: PageId }>>;
-        // NOTE: We choose to have a return type less precise than Extract<KcContext, { pageId: PageId }> {
-        // because we want to be able to use the mock just as the real KcContext.
-    }): KcContext {
+    }): Extract<KcContext, { pageId: PageId }> {
         const { pageId, overrides } = params;
 
         const kcContextMock = structuredCloneButFunctions(

package/vite-plugin/index.js

@@ -226,7 +226,8 @@ function readBuildOptions(params) {
             }
             return (0, path_1.join)(reactAppBuildDirPath, resolvedViteConfig.assetsDir);
         })(),
-        npmWorkspaceRootDirPath: npmWorkspaceRootDirPath
+        npmWorkspaceRootDirPath: npmWorkspaceRootDirPath,
+        kcContextExclusionsFtlCode: userProvidedBuildOptions.kcContextExclusionsFtlCode
     };
 }
 exports.readBuildOptions = readBuildOptions;