keycloakify 9.4.0-rc.1 → 9.4.0-rc.10

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

@@ -7,7 +7,7 @@ import { join as pathJoin } from "path";
 import { objectKeys } from "tsafe/objectKeys";
 import type { BuildOptions } from "../buildOptions";
 import { assert } from "tsafe/assert";
-import { type ThemeType, nameOfTheGlobal, basenameOfTheKeycloakifyResourcesDir } from "../../constants";
+import { type ThemeType, nameOfTheGlobal, basenameOfTheKeycloakifyResourcesDir, resources_common } from "../../constants";
 
 export type BuildOptionsLike = {
     bundler: "vite" | "webpack";
@@ -105,7 +105,8 @@ export function generateFtlFilesCodeFactory(params: {
             .replace("KEYCLOAKIFY_VERSION_xEdKd3xEdr", keycloakifyVersion)
             .replace("KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx", buildOptions.themeVersion)
             .replace("KEYCLOAKIFY_THEME_TYPE_dExKd3xEdr", themeType)
-            .replace("KEYCLOAKIFY_THEME_NAME_cXxKd3xEer", themeName),
+            .replace("KEYCLOAKIFY_THEME_NAME_cXxKd3xEer", themeName)
+            .replace("RESOURCES_COMMON_cLsLsMrtDkpVv", resources_common),
         "<!-- xIdLqMeOedErIdLsPdNdI9dSlxI -->": [
             "<#if scripts??>",
             "    <#list scripts as script>",

package/src/bin/keycloakify/generateStartKeycloakTestingContainer.ts

@@ -30,7 +30,6 @@ export function generateStartKeycloakTestingContainer(params: { jarFilePath: str
         Buffer.from(
             [
                 "#!/usr/bin/env bash",
-                `# If you want to test with Keycloak version prior to 23 use the retrocompat-${pathBasename(jarFilePath)}`,
                 "",
                 `docker rm ${containerName} || true`,
                 "",

package/src/bin/keycloakify/keycloakify.ts

@@ -11,10 +11,7 @@ import { getThemeSrcDirPath } from "../getThemeSrcDirPath";
 import { getProjectRoot } from "../tools/getProjectRoot";
 
 export async function main() {
-    const reactAppRootDirPath = process.cwd();
-
     const buildOptions = readBuildOptions({
-        reactAppRootDirPath,
         "processArgv": process.argv.slice(2)
     });
 
@@ -23,7 +20,7 @@ export async function main() {
 
     const keycloakifyDirPath = getProjectRoot();
 
-    const { themeSrcDirPath } = getThemeSrcDirPath({ reactAppRootDirPath });
+    const { themeSrcDirPath } = getThemeSrcDirPath({ "reactAppRootDirPath": buildOptions.reactAppRootDirPath });
 
     for (const themeName of buildOptions.themeNames) {
         await generateTheme({
@@ -83,12 +80,17 @@ export async function main() {
             "",
             ...(!buildOptions.doCreateJar
                 ? []
-                : [`✅ Your keycloak theme has been generated and bundled into .${pathSep}${pathRelative(reactAppRootDirPath, jarFilePath)} 🚀`]),
+                : [
+                      `✅ Your keycloak theme has been generated and bundled into .${pathSep}${pathRelative(
+                          buildOptions.reactAppRootDirPath,
+                          jarFilePath
+                      )} 🚀`
+                  ]),
             "",
             `To test your theme locally you can spin up a Keycloak ${containerKeycloakVersion} container image with the theme pre loaded by running:`,
             "",
             `👉 $ .${pathSep}${pathRelative(
-                reactAppRootDirPath,
+                buildOptions.reactAppRootDirPath,
                 pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename)
             )} 👈`,
             ``,

package/src/bin/keycloakify/replacers/replaceImportsInJsCode/webpack.ts

@@ -29,20 +29,6 @@ export function replaceImportsInJsCode_webpack(params: { jsCode: string; buildOp
         );
     }
 
-    // d={NODE_ENV:"production",PUBLIC_URL:"/foo-bar",WDS_SOCKET_HOST
-    // d={NODE_ENV:"production",PUBLIC_URL:"",WDS_SOCKET_HOST
-    // ->
-    // ... PUBLIC_URL:window.kcContext.url.resourcesPath+"/build" ...
-    fixedJsCode = fixedJsCode.replace(
-        new RegExp(
-            `NODE_ENV:"production",PUBLIC_URL:"${
-                buildOptions.urlPathname !== undefined ? replaceAll(buildOptions.urlPathname.slice(0, -1), "/", "\\/") : ""
-            }"`,
-            "g"
-        ),
-        `NODE_ENV:"production",PUBLIC_URL:window.${nameOfTheGlobal}.url.resourcesPath+"/${basenameOfTheKeycloakifyResourcesDir}"`
-    );
-
     // Example: "static/ or "foo/bar/"
     const staticDir = (() => {
         let out = pathRelative(buildOptions.reactAppBuildDirPath, buildOptions.assetsDirPath);

package/src/bin/tools/transformCodebase.ts

@@ -17,13 +17,14 @@ type TransformSourceCode = (params: { sourceCode: Buffer; filePath: string; file
  * */
 export function transformCodebase(params: { srcDirPath: string; destDirPath: string; transformSourceCode?: TransformSourceCode }) {
     const { srcDirPath, transformSourceCode } = params;
-    let { destDirPath } = params;
 
-    const isTargetSameAsSource = path.relative(srcDirPath, destDirPath) === "";
+    const isTargetSameAsSource = path.relative(srcDirPath, params.destDirPath) === "";
 
-    if (isTargetSameAsSource) {
-        destDirPath = path.join(srcDirPath, "..", "tmp_xOsPdkPsTdzPs34sOkHs");
-    }
+    const destDirPath = isTargetSameAsSource ? path.join(srcDirPath, "..", "tmp_xOsPdkPsTdzPs34sOkHs") : params.destDirPath;
+
+    fs.mkdirSync(destDirPath, {
+        "recursive": true
+    });
 
     for (const fileRelativePath of crawl({ "dirPath": srcDirPath, "returnedPathsType": "relative to dirPath" })) {
         const filePath = path.join(srcDirPath, fileRelativePath);

package/src/lib/BASE_URL.ts

@@ -0,0 +1,44 @@
+import { assert } from "tsafe/assert";
+
+/**
+ * WARNING: Internal use only!!
+ * THIS DOES NOT WORK IN KEYCLOAK! It's only for resolving mock assets.
+ * This is just a way to know what's the base url that works
+ * both in webpack and vite.
+ * You can see this as a polyfill that return `import.meta.env.BASE_URL` when in Vite
+ * and when in Webpack returns the base url in the same format as vite does meaning
+ * "/" if hosted at root or "/foo/" when hosted under a subpath (always start and ends with a "/").
+ */
+export const BASE_URL = (() => {
+    vite: {
+        let BASE_URL: string;
+
+        try {
+            // @ts-expect-error
+            BASE_URL = import.meta.env.BASE_URL;
+
+            assert(typeof BASE_URL === "string");
+        } catch {
+            break vite;
+        }
+
+        return BASE_URL;
+    }
+
+    webpack: {
+        let BASE_URL: string;
+
+        try {
+            // @ts-expect-error
+            BASE_URL = process.env.PUBLIC_URL;
+
+            assert(typeof BASE_URL === "string");
+        } catch {
+            break webpack;
+        }
+
+        return BASE_URL === "" ? "/" : `${BASE_URL}/`;
+    }
+
+    throw new Error("Bundler not supported");
+})();

package/src/lib/isStorybook.ts

@@ -0,0 +1,3 @@
+import { BASE_URL } from "./BASE_URL";
+
+export const isStorybook = BASE_URL.startsWith(".");

package/src/lib/keycloakJsAdapter.ts

@@ -36,6 +36,10 @@ export declare namespace keycloak_js {
 }
 
 /**
+ * @deprecated: This will be removed in the next major version.
+ * If you use this, please copy paste the code into your project.
+ * Better yet migrate away from keycloak-js and use https://docs.oidc-spa.dev instead.
+ *
  * NOTE: This is just a slightly modified version of the default adapter in keycloak-js
  * The goal here is just to be able to inject search param in url before keycloak redirect.
  * Our use case for it is to pass over the login screen the states of useGlobalState

package/src/login/kcContext/createGetKcContext.ts

@@ -2,14 +2,13 @@ import type { KcContext, Attribute } from "./KcContext";
 import { kcContextMocks, kcContextCommonMock } from "./kcContextMocks";
 import type { DeepPartial } from "keycloakify/tools/DeepPartial";
 import { deepAssign } from "keycloakify/tools/deepAssign";
+import { isStorybook } from "keycloakify/lib/isStorybook";
 import { id } from "tsafe/id";
 import { exclude } from "tsafe/exclude";
 import { assert } from "tsafe/assert";
 import type { ExtendKcContext } from "./getKcContextFromWindow";
 import { getKcContextFromWindow } from "./getKcContextFromWindow";
-import { pathJoin } from "keycloakify/bin/tools/pathJoin";
 import { symToStr } from "tsafe/symToStr";
-import { resources_common } from "keycloakify/bin/constants";
 
 export function createGetKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
     mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
@@ -31,7 +30,13 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
         if (mockPageId !== undefined && realKcContext === undefined) {
             //TODO maybe trow if no mock fo custom page
 
-            console.log(`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`, "background: red; color: yellow; font-size: medium");
+            warn_that_mock_is_enbaled: {
+                if (isStorybook) {
+                    break warn_that_mock_is_enbaled;
+                }
+
+                console.log(`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`, "background: red; color: yellow; font-size: medium");
+            }
 
             const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
 
@@ -147,8 +152,6 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
             return { "kcContext": undefined as any };
         }
 
-        realKcContext.url.resourcesCommonPath = pathJoin(realKcContext.url.resourcesPath, resources_common);
-
         return { "kcContext": realKcContext as any };
     }
 

package/src/login/kcContext/kcContextMocks.ts

@@ -1,10 +1,10 @@
 import "minimal-polyfills/Object.fromEntries";
 import type { KcContext, Attribute } from "./KcContext";
 import { resources_common, keycloak_resources } from "keycloakify/bin/constants";
-import { pathJoin } from "keycloakify/bin/tools/pathJoin";
 import { id } from "tsafe/id";
 import { assert, type Equals } from "tsafe/assert";
 import type { LoginThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
+import { BASE_URL } from "keycloakify/lib/BASE_URL";
 
 const attributes: Attribute[] = [
     {
@@ -100,9 +100,7 @@ const attributes: Attribute[] = [
 
 const attributesByName = Object.fromEntries(attributes.map(attribute => [attribute.name, attribute])) as any;
 
-const PUBLIC_URL = (typeof process !== "object" ? undefined : process.env?.["PUBLIC_URL"]) || "/";
-
-const resourcesPath = pathJoin(PUBLIC_URL, keycloak_resources, "login", "resources");
+const resourcesPath = `${BASE_URL}${keycloak_resources}/login/resources`;
 
 export const kcContextCommonMock: KcContext.Common = {
     "themeVersion": "0.0.0",
@@ -112,7 +110,7 @@ export const kcContextCommonMock: KcContext.Common = {
     "url": {
         "loginAction": "#",
         resourcesPath,
-        "resourcesCommonPath": pathJoin(resourcesPath, resources_common),
+        "resourcesCommonPath": `${resourcesPath}/${resources_common}`,
         "loginRestartFlowUrl": "/auth/realms/myrealm/login-actions/restart?client_id=account&tab_id=HoAx28ja4xg",
         "loginUrl": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg"
     },

package/bin/tools/pathJoin.d.ts

@@ -1 +0,0 @@
-export declare function pathJoin(...path: string[]): string;

package/bin/tools/pathJoin.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.pathJoin = void 0;
-function pathJoin() {
-    var path = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        path[_i] = arguments[_i];
-    }
-    return path
-        .map(function (part, i) { return (i === 0 ? part : part.replace(/^\/+/, "")); })
-        .map(function (part, i) { return (i === path.length - 1 ? part : part.replace(/\/+$/, "")); })
-        .join(typeof process !== "undefined" && process.platform === "win32" ? "\\" : "/");
-}
-exports.pathJoin = pathJoin;
-//# sourceMappingURL=pathJoin.js.map

package/bin/tools/pathJoin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"pathJoin.js","sourceRoot":"","sources":["../../src/bin/tools/pathJoin.ts"],"names":[],"mappings":";;;AAAA,SAAgB,QAAQ;IAAC,cAAiB;SAAjB,UAAiB,EAAjB,qBAAiB,EAAjB,IAAiB;QAAjB,yBAAiB;;IACtC,OAAO,IAAI;SACN,GAAG,CAAC,UAAC,IAAI,EAAE,CAAC,IAAK,OAAA,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAA3C,CAA2C,CAAC;SAC7D,GAAG,CAAC,UAAC,IAAI,EAAE,CAAC,IAAK,OAAA,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAzD,CAAyD,CAAC;SAC3E,IAAI,CAAC,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAC3F,CAAC;AALD,4BAKC"}

package/src/bin/tools/pathJoin.ts

@@ -1,6 +0,0 @@
-export function pathJoin(...path: string[]): string {
-    return path
-        .map((part, i) => (i === 0 ? part : part.replace(/^\/+/, "")))
-        .map((part, i) => (i === path.length - 1 ? part : part.replace(/\/+$/, "")))
-        .join(typeof process !== "undefined" && process.platform === "win32" ? "\\" : "/");
-}