keycloakify 10.0.0-rc.12 → 10.0.0-rc.120

package/src/bin/keycloakify/generateStartKeycloakTestingContainer.ts

@@ -1,60 +0,0 @@
-import * as fs from "fs";
-import { join as pathJoin, relative as pathRelative, basename as pathBasename } from "path";
-import { assert } from "tsafe/assert";
-import type { BuildOptions } from "../shared/buildOptions";
-import { accountV1ThemeName } from "../shared/constants";
-
-export type BuildOptionsLike = {
-    keycloakifyBuildDirPath: string;
-    themeNames: string[];
-};
-
-assert<BuildOptions extends BuildOptionsLike ? true : false>();
-
-generateStartKeycloakTestingContainer.basename = "start_keycloak_testing_container.sh";
-
-const containerName = "keycloak-testing-container";
-const keycloakVersion = "24.0.4";
-
-/** Files for being able to run a hot reload keycloak container */
-export function generateStartKeycloakTestingContainer(params: {
-    jarFilePath: string;
-    doesImplementAccountTheme: boolean;
-    buildOptions: BuildOptionsLike;
-}) {
-    const { jarFilePath, doesImplementAccountTheme, buildOptions } = params;
-
-    const themeRelativeDirPath = pathJoin("src", "main", "resources", "theme");
-
-    fs.writeFileSync(
-        pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename),
-        Buffer.from(
-            [
-                "#!/usr/bin/env bash",
-                "",
-                `docker rm ${containerName} || true`,
-                "",
-                `cd "${buildOptions.keycloakifyBuildDirPath}"`,
-                "",
-                "docker run \\",
-                "   -p 8080:8080 \\",
-                `   --name ${containerName} \\`,
-                "   -e KEYCLOAK_ADMIN=admin \\",
-                "   -e KEYCLOAK_ADMIN_PASSWORD=admin \\",
-                `   -v "${pathJoin(
-                    "$(pwd)",
-                    pathRelative(buildOptions.keycloakifyBuildDirPath, jarFilePath)
-                )}":"/opt/keycloak/providers/${pathBasename(jarFilePath)}" \\`,
-                [...(doesImplementAccountTheme ? [accountV1ThemeName] : []), ...buildOptions.themeNames].map(
-                    themeName =>
-                        `   -v "${pathJoin("$(pwd)", themeRelativeDirPath, themeName).replace(/\\/g, "/")}":"/opt/keycloak/themes/${themeName}":rw \\`
-                ),
-                `   -it quay.io/keycloak/keycloak:${keycloakVersion} \\`,
-                `   start-dev`,
-                ""
-            ].join("\n"),
-            "utf8"
-        ),
-        { "mode": 0o755 }
-    );
-}

package/src/bin/keycloakify/replacers/replaceImportsInInlineCssCode.ts

@@ -1,24 +0,0 @@
-import type { BuildOptions } from "../../shared/buildOptions";
-import { assert } from "tsafe/assert";
-import { basenameOfTheKeycloakifyResourcesDir } from "../../shared/constants";
-
-export type BuildOptionsLike = {
-    urlPathname: string | undefined;
-};
-
-assert<BuildOptions extends BuildOptionsLike ? true : false>();
-
-export function replaceImportsInInlineCssCode(params: { cssCode: string; buildOptions: BuildOptionsLike }): {
-    fixedCssCode: string;
-} {
-    const { cssCode, buildOptions } = params;
-
-    const fixedCssCode = cssCode.replace(
-        buildOptions.urlPathname === undefined
-            ? /url\(["']?\/([^/][^)"']+)["']?\)/g
-            : new RegExp(`url\\(["']?${buildOptions.urlPathname}([^)"']+)["']?\\)`, "g"),
-        (...[, group]) => `url(\${url.resourcesPath}/${basenameOfTheKeycloakifyResourcesDir}/${group})`
-    );
-
-    return { fixedCssCode };
-}

package/src/bin/shared/buildOptions.ts

@@ -1,277 +0,0 @@
-import { parse as urlParse } from "url";
-import { join as pathJoin } from "path";
-import { getAbsoluteAndInOsFormatPath } from "../tools/getAbsoluteAndInOsFormatPath";
-import { getNpmWorkspaceRootDirPath } from "../tools/getNpmWorkspaceRootDirPath";
-import type { CliCommandOptions } from "../main";
-import { z } from "zod";
-import * as fs from "fs";
-import { assert } from "tsafe";
-import * as child_process from "child_process";
-import { vitePluginSubScriptEnvNames } from "./constants";
-
-/** Consolidated build option gathered form CLI arguments and config in package.json */
-export type BuildOptions = {
-    bundler: "vite" | "webpack";
-    themeVersion: string;
-    themeNames: string[];
-    extraThemeProperties: string[] | undefined;
-    groupId: string;
-    artifactId: string;
-    loginThemeResourcesFromKeycloakVersion: string;
-    reactAppRootDirPath: string;
-    // TODO: Remove from vite type
-    reactAppBuildDirPath: string;
-    /** Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak */
-    keycloakifyBuildDirPath: string;
-    publicDirPath: string;
-    cacheDirPath: string;
-    /** If your app is hosted under a subpath, it's the case in CRA if you have "homepage": "https://example.com/my-app" in your package.json
-     * In this case the urlPathname will be "/my-app/" */
-    urlPathname: string | undefined;
-    assetsDirPath: string;
-    npmWorkspaceRootDirPath: string;
-};
-
-export type UserProvidedBuildOptions = {
-    extraThemeProperties?: string[];
-    artifactId?: string;
-    groupId?: string;
-    loginThemeResourcesFromKeycloakVersion?: string;
-    keycloakifyBuildDirPath?: string;
-    themeName?: string | string[];
-};
-
-export type ResolvedViteConfig = {
-    buildDir: string;
-    publicDir: string;
-    assetsDir: string;
-    urlPathname: string | undefined;
-    userProvidedBuildOptions: UserProvidedBuildOptions;
-};
-
-export function readBuildOptions(params: { cliCommandOptions: CliCommandOptions }): BuildOptions {
-    const { cliCommandOptions } = params;
-
-    const reactAppRootDirPath = (() => {
-        if (cliCommandOptions.reactAppRootDirPath === undefined) {
-            return process.cwd();
-        }
-
-        return getAbsoluteAndInOsFormatPath({
-            "pathIsh": cliCommandOptions.reactAppRootDirPath,
-            "cwd": process.cwd()
-        });
-    })();
-
-    const { resolvedViteConfig } = (() => {
-        if (fs.readdirSync(reactAppRootDirPath).find(fileBasename => fileBasename.startsWith("vite.config")) === undefined) {
-            return { "resolvedViteConfig": undefined };
-        }
-
-        const output = child_process
-            .execSync("npx vite", {
-                "cwd": reactAppRootDirPath,
-                "env": {
-                    ...process.env,
-                    [vitePluginSubScriptEnvNames.resolveViteConfig]: "true"
-                }
-            })
-            .toString("utf8");
-
-        assert(output.includes(vitePluginSubScriptEnvNames.resolveViteConfig), "Seems like the Keycloakify's Vite plugin is not installed.");
-
-        const resolvedViteConfigStr = output.split(vitePluginSubScriptEnvNames.resolveViteConfig).reverse()[0];
-
-        const resolvedViteConfig: ResolvedViteConfig = JSON.parse(resolvedViteConfigStr);
-
-        return { resolvedViteConfig };
-    })();
-
-    const parsedPackageJson = (() => {
-        type ParsedPackageJson = {
-            name: string;
-            version?: string;
-            homepage?: string;
-            keycloakify?: UserProvidedBuildOptions & { reactAppBuildDirPath?: string };
-        };
-
-        const zParsedPackageJson = z.object({
-            "name": z.string(),
-            "version": z.string().optional(),
-            "homepage": z.string().optional(),
-            "keycloakify": z
-                .object({
-                    "extraThemeProperties": z.array(z.string()).optional(),
-                    "artifactId": z.string().optional(),
-                    "groupId": z.string().optional(),
-                    "loginThemeResourcesFromKeycloakVersion": z.string().optional(),
-                    "reactAppBuildDirPath": z.string().optional(),
-                    "keycloakifyBuildDirPath": z.string().optional(),
-                    "themeName": z.union([z.string(), z.array(z.string())]).optional()
-                })
-                .optional()
-        });
-
-        {
-            type Got = ReturnType<(typeof zParsedPackageJson)["parse"]>;
-            type Expected = ParsedPackageJson;
-            assert<Got extends Expected ? true : false>();
-            assert<Expected extends Got ? true : false>();
-        }
-
-        return zParsedPackageJson.parse(JSON.parse(fs.readFileSync(pathJoin(reactAppRootDirPath, "package.json")).toString("utf8")));
-    })();
-
-    const userProvidedBuildOptions: UserProvidedBuildOptions = {
-        ...parsedPackageJson.keycloakify,
-        ...resolvedViteConfig?.userProvidedBuildOptions
-    };
-
-    const themeNames = (() => {
-        if (userProvidedBuildOptions.themeName === undefined) {
-            return [
-                parsedPackageJson.name
-                    .replace(/^@(.*)/, "$1")
-                    .split("/")
-                    .join("-")
-            ];
-        }
-
-        if (typeof userProvidedBuildOptions.themeName === "string") {
-            return [userProvidedBuildOptions.themeName];
-        }
-
-        return userProvidedBuildOptions.themeName;
-    })();
-
-    const reactAppBuildDirPath = (() => {
-        webpack: {
-            if (resolvedViteConfig !== undefined) {
-                break webpack;
-            }
-
-            if (parsedPackageJson.keycloakify?.reactAppBuildDirPath !== undefined) {
-                return getAbsoluteAndInOsFormatPath({
-                    "pathIsh": parsedPackageJson.keycloakify.reactAppBuildDirPath,
-                    "cwd": reactAppRootDirPath
-                });
-            }
-
-            return pathJoin(reactAppRootDirPath, "build");
-        }
-
-        return pathJoin(reactAppRootDirPath, resolvedViteConfig.buildDir);
-    })();
-
-    const { npmWorkspaceRootDirPath } = getNpmWorkspaceRootDirPath({ reactAppRootDirPath });
-
-    return {
-        "bundler": resolvedViteConfig !== undefined ? "vite" : "webpack",
-        "themeVersion": process.env.KEYCLOAKIFY_THEME_VERSION ?? parsedPackageJson.version ?? "0.0.0",
-        themeNames,
-        "extraThemeProperties": userProvidedBuildOptions.extraThemeProperties,
-        "groupId": (() => {
-            const fallbackGroupId = `${themeNames[0]}.keycloak`;
-
-            return (
-                process.env.KEYCLOAKIFY_GROUP_ID ??
-                userProvidedBuildOptions.groupId ??
-                (parsedPackageJson.homepage === undefined
-                    ? fallbackGroupId
-                    : urlParse(parsedPackageJson.homepage)
-                          .host?.replace(/:[0-9]+$/, "")
-                          ?.split(".")
-                          .reverse()
-                          .join(".") ?? fallbackGroupId) + ".keycloak"
-            );
-        })(),
-        "artifactId": process.env.KEYCLOAKIFY_ARTIFACT_ID ?? userProvidedBuildOptions.artifactId ?? `${themeNames[0]}-keycloak-theme`,
-        "loginThemeResourcesFromKeycloakVersion": userProvidedBuildOptions.loginThemeResourcesFromKeycloakVersion ?? "24.0.4",
-        reactAppRootDirPath,
-        reactAppBuildDirPath,
-        "keycloakifyBuildDirPath": (() => {
-            if (userProvidedBuildOptions.keycloakifyBuildDirPath !== undefined) {
-                return getAbsoluteAndInOsFormatPath({
-                    "pathIsh": userProvidedBuildOptions.keycloakifyBuildDirPath,
-                    "cwd": reactAppRootDirPath
-                });
-            }
-
-            return pathJoin(
-                reactAppRootDirPath,
-                resolvedViteConfig?.buildDir === undefined ? "build_keycloak" : `${resolvedViteConfig.buildDir}_keycloak`
-            );
-        })(),
-        "publicDirPath": (() => {
-            webpack: {
-                if (resolvedViteConfig !== undefined) {
-                    break webpack;
-                }
-
-                if (process.env.PUBLIC_DIR_PATH !== undefined) {
-                    return getAbsoluteAndInOsFormatPath({
-                        "pathIsh": process.env.PUBLIC_DIR_PATH,
-                        "cwd": reactAppRootDirPath
-                    });
-                }
-
-                return pathJoin(reactAppRootDirPath, "public");
-            }
-
-            return pathJoin(reactAppRootDirPath, resolvedViteConfig.publicDir);
-        })(),
-        "cacheDirPath": (() => {
-            const cacheDirPath = pathJoin(
-                (() => {
-                    if (process.env.XDG_CACHE_HOME !== undefined) {
-                        return getAbsoluteAndInOsFormatPath({
-                            "pathIsh": process.env.XDG_CACHE_HOME,
-                            "cwd": process.cwd()
-                        });
-                    }
-
-                    return pathJoin(npmWorkspaceRootDirPath, "node_modules", ".cache");
-                })(),
-                "keycloakify"
-            );
-
-            return cacheDirPath;
-        })(),
-        "urlPathname": (() => {
-            webpack: {
-                if (resolvedViteConfig !== undefined) {
-                    break webpack;
-                }
-
-                const { homepage } = parsedPackageJson;
-
-                let url: URL | undefined = undefined;
-
-                if (homepage !== undefined) {
-                    url = new URL(homepage);
-                }
-
-                if (url === undefined) {
-                    return undefined;
-                }
-
-                const out = url.pathname.replace(/([^/])$/, "$1/");
-                return out === "/" ? undefined : out;
-            }
-
-            return resolvedViteConfig.urlPathname;
-        })(),
-        "assetsDirPath": (() => {
-            webpack: {
-                if (resolvedViteConfig !== undefined) {
-                    break webpack;
-                }
-
-                return pathJoin(reactAppBuildDirPath, "static");
-            }
-
-            return pathJoin(reactAppBuildDirPath, resolvedViteConfig.assetsDir);
-        })(),
-        npmWorkspaceRootDirPath
-    };
-}

package/src/bin/shared/downloadAndUnzip.ts

@@ -1,203 +0,0 @@
-import { createHash } from "crypto";
-import { mkdir, writeFile, unlink } from "fs/promises";
-import fetch from "make-fetch-happen";
-import { dirname as pathDirname, join as pathJoin, basename as pathBasename } from "path";
-import { assert } from "tsafe/assert";
-import { transformCodebase } from "../tools/transformCodebase";
-import { unzip, zip } from "../tools/unzip";
-import { rm } from "../tools/fs.rm";
-import * as child_process from "child_process";
-import { existsAsync } from "../tools/fs.existsAsync";
-import type { BuildOptions } from "./buildOptions";
-import { getProxyFetchOptions } from "../tools/fetchProxyOptions";
-
-export type BuildOptionsLike = {
-    cacheDirPath: string;
-    npmWorkspaceRootDirPath: string;
-};
-
-assert<BuildOptions extends BuildOptionsLike ? true : false>();
-
-export async function downloadAndUnzip(params: {
-    url: string;
-    destDirPath: string;
-    specificDirsToExtract?: string[];
-    preCacheTransform?: {
-        actionCacheId: string;
-        action: (params: { destDirPath: string }) => Promise<void>;
-    };
-    buildOptions: BuildOptionsLike;
-}) {
-    const { url, destDirPath, specificDirsToExtract, preCacheTransform, buildOptions } = params;
-
-    const { extractDirPath, zipFilePath } = (() => {
-        const zipFileBasenameWithoutExt = generateFileNameFromURL({
-            url,
-            "preCacheTransform":
-                preCacheTransform === undefined
-                    ? undefined
-                    : {
-                          "actionCacheId": preCacheTransform.actionCacheId,
-                          "actionFootprint": preCacheTransform.action.toString()
-                      }
-        });
-
-        const zipFilePath = pathJoin(buildOptions.cacheDirPath, `${zipFileBasenameWithoutExt}.zip`);
-        const extractDirPath = pathJoin(buildOptions.cacheDirPath, `tmp_unzip_${zipFileBasenameWithoutExt}`);
-
-        return { zipFilePath, extractDirPath };
-    })();
-
-    download_zip_and_transform: {
-        if (await existsAsync(zipFilePath)) {
-            break download_zip_and_transform;
-        }
-
-        const { response, isFromRemoteCache } = await (async () => {
-            const proxyFetchOptions = await getProxyFetchOptions({
-                "npmWorkspaceRootDirPath": buildOptions.npmWorkspaceRootDirPath
-            });
-
-            const response = await fetch(
-                `https://github.com/keycloakify/keycloakify/releases/download/v0.0.1/${pathBasename(zipFilePath)}`,
-                proxyFetchOptions
-            );
-
-            if (response.status === 200) {
-                return {
-                    response,
-                    "isFromRemoteCache": true
-                };
-            }
-
-            return {
-                "response": await fetch(url, proxyFetchOptions),
-                "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.)
-         * Unfortunately, octokit (a dependency of keycloakify) also uses node-fetch, and
-         * does not support node-fetch 3.x. So we stick around with this band-aid until
-         * octokit upgrades.
-         */
-        response.body?.setMaxListeners(Number.MAX_VALUE);
-        assert(typeof response.body !== "undefined" && response.body != null);
-
-        await writeFile(zipFilePath, response.body);
-
-        if (isFromRemoteCache) {
-            break download_zip_and_transform;
-        }
-
-        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);
-
-        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;
-            }
-
-            console.log("uploading to remote cache");
-
-            try {
-                child_process.execSync(`which putasset`);
-            } catch {
-                child_process.execSync(`npm install -g putasset`);
-            }
-
-            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");
-            }
-        }
-    }
-
-    await unzip(zipFilePath, extractDirPath);
-
-    transformCodebase({
-        "srcDirPath": extractDirPath,
-        "destDirPath": destDirPath
-    });
-
-    await rm(extractDirPath, { "recursive": true });
-}
-
-function generateFileNameFromURL(params: {
-    url: string;
-    preCacheTransform:
-        | {
-              actionCacheId: string;
-              actionFootprint: string;
-          }
-        | undefined;
-}): string {
-    const { preCacheTransform } = params;
-
-    // Parse the URL
-    const url = new URL(params.url);
-
-    // Extract pathname and remove leading slashes
-    let fileName = url.pathname.replace(/^\//, "").replace(/\//g, "_");
-
-    // Optionally, add query parameters replacing special characters
-    if (url.search) {
-        fileName += url.search.replace(/[&=?]/g, "-");
-    }
-
-    // Replace any characters that are not valid in filenames
-    fileName = fileName.replace(/[^a-zA-Z0-9-_]/g, "");
-
-    // Trim or pad the fileName to a specific length
-    fileName = fileName.substring(0, 50);
-
-    add_pre_cache_transform: {
-        if (preCacheTransform === undefined) {
-            break add_pre_cache_transform;
-        }
-
-        // Sanitize actionCacheId the same way as other components
-        const sanitizedActionCacheId = preCacheTransform.actionCacheId.replace(/[^a-zA-Z0-9-_]/g, "_");
-
-        fileName += `_${sanitizedActionCacheId}_${createHash("sha256").update(preCacheTransform.actionFootprint).digest("hex").substring(0, 5)}`;
-    }
-
-    return fileName;
-}