keycloakify 9.4.0-rc.0 → 9.4.0-rc.10

package/src/bin/tools/downloadAndUnzip.ts

@@ -2,12 +2,13 @@ import { exec as execCallback } from "child_process";
 import { createHash } from "crypto";
 import { mkdir, readFile, stat, writeFile, unlink } from "fs/promises";
 import fetch, { type FetchOptions } from "make-fetch-happen";
-import { dirname as pathDirname, join as pathJoin, resolve as pathResolve, sep as pathSep } from "path";
+import { dirname as pathDirname, join as pathJoin, resolve as pathResolve, sep as pathSep, basename as pathBasename } from "path";
 import { assert } from "tsafe/assert";
 import { promisify } from "util";
 import { transformCodebase } from "./transformCodebase";
 import { unzip, zip } from "./unzip";
 import { rm } from "../tools/fs.rm";
+import * as child_process from "child_process";
 
 const exec = promisify(execCallback);
 
@@ -188,10 +189,31 @@ export async function downloadAndUnzip(
     const zipFilePath = pathJoin(cacheDirPath, `${zipFileBasename}.zip`);
     const extractDirPath = pathJoin(cacheDirPath, `tmp_unzip_${zipFileBasename}`);
 
-    if (!(await exists(zipFilePath))) {
+    download_zip_and_transform: {
+        if (await exists(zipFilePath)) {
+            break download_zip_and_transform;
+        }
+
         const opts = await getFetchOptions();
-        const response = await fetch(url, opts);
+
+        const { response, isFromRemoteCache } = await (async () => {
+            const response = await fetch(`https://github.com/keycloakify/keycloakify/releases/download/v0.0.1/${pathBasename(zipFilePath)}`, opts);
+
+            if (response.status === 200) {
+                return {
+                    response,
+                    "isFromRemoteCache": true
+                };
+            }
+
+            return {
+                "response": await fetch(url, opts),
+                "isFromRemoteCache": false
+            };
+        })();
+
         await mkdir(pathDirname(zipFilePath), { "recursive": true });
+
         /**
          * The correct way to fix this is to upgrade node-fetch beyond 3.2.5
          * (see https://github.com/node-fetch/node-fetch/issues/1295#issuecomment-1144061991.)
@@ -201,26 +223,66 @@ export async function downloadAndUnzip(
          */
         response.body?.setMaxListeners(Number.MAX_VALUE);
         assert(typeof response.body !== "undefined" && response.body != null);
+
         await writeFile(zipFilePath, response.body);
 
-        if (specificDirsToExtract !== undefined || preCacheTransform !== undefined) {
-            await unzip(zipFilePath, extractDirPath, specificDirsToExtract);
+        if (isFromRemoteCache) {
+            break download_zip_and_transform;
+        }
 
-            try {
-                await preCacheTransform?.action({
-                    "destDirPath": extractDirPath
-                });
-            } catch (error) {
-                await Promise.all([rm(extractDirPath, { "recursive": true }), unlink(zipFilePath)]);
+        if (specificDirsToExtract === undefined && preCacheTransform === undefined) {
+            break download_zip_and_transform;
+        }
+
+        await unzip(zipFilePath, extractDirPath, specificDirsToExtract);
+
+        try {
+            await preCacheTransform?.action({
+                "destDirPath": extractDirPath
+            });
+        } catch (error) {
+            await Promise.all([rm(extractDirPath, { "recursive": true }), unlink(zipFilePath)]);
+
+            throw error;
+        }
+
+        await unlink(zipFilePath);
+
+        await zip(extractDirPath, zipFilePath);
 
-                throw error;
+        await rm(extractDirPath, { "recursive": true });
+
+        upload_to_remot_cache_if_admin: {
+            const githubToken = process.env["KEYCLOAKIFY_ADMIN_GITHUB_PERSONAL_ACCESS_TOKEN"];
+
+            if (githubToken === undefined) {
+                break upload_to_remot_cache_if_admin;
             }
 
-            await unlink(zipFilePath);
+            console.log("uploading to remote cache");
 
-            await zip(extractDirPath, zipFilePath);
+            try {
+                child_process.execSync(`which putasset`);
+            } catch {
+                child_process.execSync(`npm install -g putasset`);
+            }
 
-            await rm(extractDirPath, { "recursive": true });
+            try {
+                child_process.execFileSync("putasset", [
+                    "--owner",
+                    "keycloakify",
+                    "--repo",
+                    "keycloakify",
+                    "--tag",
+                    "v0.0.1",
+                    "--filename",
+                    zipFilePath,
+                    "--token",
+                    githubToken
+                ]);
+            } catch {
+                console.log("upload failed, asset probably already exists in remote cache");
+            }
         }
     }
 

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" ? "\\" : "/");
-}