keycloakify 9.4.0-rc.1 → 9.4.0-rc.11

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/fetchProxyOptions.ts

@@ -0,0 +1,73 @@
+import { exec as execCallback } from "child_process";
+import { readFile } from "fs/promises";
+import { type FetchOptions } from "make-fetch-happen";
+import { promisify } from "util";
+
+function ensureArray<T>(arg0: T | T[]) {
+    return Array.isArray(arg0) ? arg0 : typeof arg0 === "undefined" ? [] : [arg0];
+}
+
+function ensureSingleOrNone<T>(arg0: T | T[]) {
+    if (!Array.isArray(arg0)) return arg0;
+    if (arg0.length === 0) return undefined;
+    if (arg0.length === 1) return arg0[0];
+    throw new Error("Illegal configuration, expected a single value but found multiple: " + arg0.map(String).join(", "));
+}
+
+type NPMConfig = Record<string, string | string[]>;
+
+/**
+ * Get npm configuration as map
+ */
+async function getNmpConfig(params: { npmWorkspaceRootDirPath: string }) {
+    const { npmWorkspaceRootDirPath } = params;
+
+    const exec = promisify(execCallback);
+
+    const stdout = await exec("npm config get", { "encoding": "utf8", "cwd": npmWorkspaceRootDirPath }).then(({ stdout }) => stdout);
+
+    const npmConfigReducer = (cfg: NPMConfig, [key, value]: [string, string]) =>
+        key in cfg ? { ...cfg, [key]: [...ensureArray(cfg[key]), value] } : { ...cfg, [key]: value };
+
+    return stdout
+        .split("\n")
+        .filter(line => !line.startsWith(";"))
+        .map(line => line.trim())
+        .map(line => line.split("=", 2) as [string, string])
+        .reduce(npmConfigReducer, {} as NPMConfig);
+}
+
+export type ProxyFetchOptions = Pick<FetchOptions, "proxy" | "noProxy" | "strictSSL" | "cert" | "ca">;
+
+export async function getProxyFetchOptions(params: { npmWorkspaceRootDirPath: string }): Promise<ProxyFetchOptions> {
+    const { npmWorkspaceRootDirPath } = params;
+
+    const cfg = await getNmpConfig({ npmWorkspaceRootDirPath });
+
+    const proxy = ensureSingleOrNone(cfg["https-proxy"] ?? cfg["proxy"]);
+    const noProxy = cfg["noproxy"] ?? cfg["no-proxy"];
+
+    function maybeBoolean(arg0: string | undefined) {
+        return typeof arg0 === "undefined" ? undefined : Boolean(arg0);
+    }
+
+    const strictSSL = maybeBoolean(ensureSingleOrNone(cfg["strict-ssl"]));
+    const cert = cfg["cert"];
+    const ca = ensureArray(cfg["ca"] ?? cfg["ca[]"]);
+    const cafile = ensureSingleOrNone(cfg["cafile"]);
+
+    if (typeof cafile !== "undefined" && cafile !== "null") {
+        ca.push(
+            ...(await (async () => {
+                function chunks<T>(arr: T[], size: number = 2) {
+                    return arr.map((_, i) => i % size == 0 && arr.slice(i, i + size)).filter(Boolean) as T[][];
+                }
+
+                const cafileContent = await readFile(cafile, "utf-8");
+                return chunks(cafileContent.split(/(-----END CERTIFICATE-----)/), 2).map(ca => ca.join("").replace(/^\n/, "").replace(/\n/g, "\\n"));
+            })())
+        );
+    }
+
+    return { proxy, noProxy, strictSSL, cert, "ca": ca.length === 0 ? undefined : ca };
+}

package/src/bin/tools/fs.existsAsync.ts

@@ -0,0 +1,11 @@
+import * as fs from "fs/promises";
+
+export async function existsAsync(path: string) {
+    try {
+        await fs.stat(path);
+        return true;
+    } catch (error) {
+        if ((error as Error & { code: string }).code === "ENOENT") return false;
+        throw error;
+    }
+}

package/src/bin/tools/{getProjectRoot.ts → getThisCodebaseRootDirPath.ts}

@@ -1,19 +1,19 @@
 import * as fs from "fs";
 import * as path from "path";
 
-function getProjectRootRec(dirPath: string): string {
+function getThisCodebaseRootDirPath_rec(dirPath: string): string {
     if (fs.existsSync(path.join(dirPath, "package.json"))) {
         return dirPath;
     }
-    return getProjectRootRec(path.join(dirPath, ".."));
+    return getThisCodebaseRootDirPath_rec(path.join(dirPath, ".."));
 }
 
 let result: string | undefined = undefined;
 
-export function getProjectRoot(): string {
+export function getThisCodebaseRootDirPath(): string {
     if (result !== undefined) {
         return result;
     }
 
-    return (result = getProjectRootRec(__dirname));
+    return (result = getThisCodebaseRootDirPath_rec(__dirname));
 }

package/src/bin/tools/grant-exec-perms.ts

@@ -1,13 +1,15 @@
-import { getProjectRoot } from "./getProjectRoot";
+import { getThisCodebaseRootDirPath } from "./getThisCodebaseRootDirPath";
 import { join as pathJoin } from "path";
 import { constants } from "fs";
 import { chmod, stat } from "fs/promises";
 
 (async () => {
-    const { bin } = await import(pathJoin(getProjectRoot(), "package.json"));
+    const thisCodebaseRootDirPath = getThisCodebaseRootDirPath();
+
+    const { bin } = await import(pathJoin(thisCodebaseRootDirPath, "package.json"));
 
     const promises = Object.values<string>(bin).map(async scriptPath => {
-        const fullPath = pathJoin(getProjectRoot(), scriptPath);
+        const fullPath = pathJoin(thisCodebaseRootDirPath, scriptPath);
         const oldMode = (await stat(fullPath)).mode;
         const newMode = oldMode | constants.S_IXUSR | constants.S_IXGRP | constants.S_IXOTH;
         await chmod(fullPath, newMode);

package/src/bin/tools/readThisNpmProjectVersion.ts

@@ -0,0 +1,12 @@
+import { getThisCodebaseRootDirPath } from "./getThisCodebaseRootDirPath";
+import { assert } from "tsafe/assert";
+import * as fs from "fs";
+import { join as pathJoin } from "path";
+
+export function readThisNpmProjectVersion(): string {
+    const version = JSON.parse(fs.readFileSync(pathJoin(getThisCodebaseRootDirPath(), "package.json")).toString("utf8"))["version"];
+
+    assert(typeof version === "string");
+
+    return version;
+}

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/src/vite-plugin/vite-plugin.ts

@@ -1,14 +1,14 @@
 import { join as pathJoin, relative as pathRelative, sep as pathSep } from "path";
-import { readParsedPackageJson } from "../bin/keycloakify/buildOptions/parsedPackageJson";
 import type { Plugin } from "vite";
 import { assert } from "tsafe/assert";
 import * as fs from "fs";
 import { resolvedViteConfigJsonBasename, nameOfTheGlobal, basenameOfTheKeycloakifyResourcesDir, keycloak_resources } from "../bin/constants";
 import type { ResolvedViteConfig } from "../bin/keycloakify/buildOptions/resolvedViteConfig";
-import { getKeycloakifyBuildDirPath } from "../bin/keycloakify/buildOptions/getKeycloakifyBuildDirPath";
+import { getCacheDirPath } from "../bin/keycloakify/buildOptions/getCacheDirPath";
 import { replaceAll } from "../bin/tools/String.prototype.replaceAll";
 import { id } from "tsafe/id";
 import { rm } from "../bin/tools/fs.rm";
+import { copyKeycloakResourcesToPublic } from "../bin/copy-keycloak-resources-to-public";
 
 export function keycloakify(): Plugin {
     let reactAppRootDirPath: string | undefined = undefined;
@@ -18,7 +18,7 @@ export function keycloakify(): Plugin {
     return {
         "name": "keycloakify",
         "apply": "build",
-        "configResolved": resolvedConfig => {
+        "configResolved": async resolvedConfig => {
             reactAppRootDirPath = resolvedConfig.root;
             urlPathname = (() => {
                 let out = resolvedConfig.env.BASE_URL;
@@ -40,19 +40,16 @@ export function keycloakify(): Plugin {
 
             buildDirPath = pathJoin(reactAppRootDirPath, resolvedConfig.build.outDir);
 
-            const { keycloakifyBuildDirPath } = getKeycloakifyBuildDirPath({
-                "parsedPackageJson_keycloakify_keycloakifyBuildDirPath": readParsedPackageJson({ reactAppRootDirPath }).keycloakify
-                    ?.keycloakifyBuildDirPath,
-                reactAppRootDirPath,
-                "bundler": "vite"
+            const { cacheDirPath } = getCacheDirPath({
+                reactAppRootDirPath
             });
 
-            if (!fs.existsSync(keycloakifyBuildDirPath)) {
-                fs.mkdirSync(keycloakifyBuildDirPath);
+            if (!fs.existsSync(cacheDirPath)) {
+                fs.mkdirSync(cacheDirPath);
             }
 
             fs.writeFileSync(
-                pathJoin(keycloakifyBuildDirPath, resolvedViteConfigJsonBasename),
+                pathJoin(cacheDirPath, resolvedViteConfigJsonBasename),
                 Buffer.from(
                     JSON.stringify(
                         id<ResolvedViteConfig>({
@@ -67,6 +64,10 @@ export function keycloakify(): Plugin {
                     "utf8"
                 )
             );
+
+            await copyKeycloakResourcesToPublic({
+                "processArgv": ["--project", reactAppRootDirPath]
+            });
         },
         "transform": (code, id) => {
             assert(reactAppRootDirPath !== undefined);