Relase candidate

Fix start container script paths for windows

.github/workflows/ci.yaml

@@ -28,7 +28,7 @@ jobs:
     needs: test_lint
     strategy:
       matrix:
-        node: [ '14', '15' ,'16', '17' ]
+        node: [ '14','16' ]
         os: [ windows-latest, ubuntu-latest ]
     name: Test with Node v${{ matrix.node }} on ${{ matrix.os }}
     steps:
@@ -136,4 +136,4 @@ jobs:
       env:
         NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
         VERSION: ${{ needs.check_if_version_upgraded.outputs.to_version }}
-        IS_PRE_RELEASE: ${{ needs.check_if_version_upgraded.outputs.is_pre_release }}
+        IS_PRE_RELEASE: ${{ needs.check_if_version_upgraded.outputs.is_pre_release }}

README.md

@@ -40,6 +40,10 @@
 
 # Changelog highlights
 
+## 6.13
+
+-   Build work behind corporate proxies, [see issue](https://github.com/InseeFrLab/keycloakify/issues/257).
+
 ## 6.12
 
 Massive improvement in the developer experience:

package.json

@@ -1,32 +1,34 @@
 {
     "name": "keycloakify",
-    "version": "6.12.7-rc.0",
-    "description": "Keycloak theme generator for Reacts app",
+    "version": "7.0.0-rc.0",
+    "description": "Create Keycloak themes using React",
     "repository": {
         "type": "git",
-        "url": "git://github.com/garronej/keycloakify.git"
+        "url": "git://github.com/inseefrlab/keycloakify.git"
     },
-    "main": "dist/lib/index.js",
-    "types": "dist/lib/index.d.ts",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
     "scripts": {
-        "build": "rimraf dist/ && tsc -p src/bin && tsc -p src/lib && yarn grant-exec-perms && yarn copy-files dist/",
-        "build:test": "rimraf dist_test/ && tsc -p src/test && yarn copy-files dist_test/",
+        "build": "rimraf dist/ && tsc -p src/bin && tsc -p src/tsconfig.json && tsc-alias -p src/tsconfig.json && yarn grant-exec-perms && yarn copy-files dist/",
+        "build:watch": "tsc -p src/tsconfig.json && (concurrently \"tsc -p src/tsconfig.json -w\" \"tsc-alias -p src/tsconfig.json\")",
+        "build:test": "rimraf dist_test/ && tsc -p test/tsconfig.json && tsc-alias -p test/tsconfig.json && yarn copy-files dist_test/src",
         "grant-exec-perms": "node dist/bin/tools/grant-exec-perms.js",
         "copy-files": "copyfiles -u 1 src/**/*.ftl",
-        "pretest": "yarn build:test",
-        "test": "node dist_test/test/bin && node dist_test/test/lib",
+        "test": "yarn build:test && node dist_test/test/bin && node dist_test/test/lib",
+        "test:sample-app": "yarn build:test && node dist_test/test/bin/main.js",
         "_format": "prettier '**/*.{ts,tsx,json,md}'",
         "format": "yarn _format --write",
         "format:check": "yarn _format --list-different",
-        "generate-messages": "ts-node --skipProject src/scripts/generate-i18n-messages.ts",
-        "link-in-app": "ts-node --skipProject src/scripts/link-in-app.ts",
-        "link-in-starter": "yarn link-in-app keycloakify-advanced-starter",
+        "generate-messages": "ts-node --skipProject scripts/generate-i18n-messages.ts",
+        "link-in-app": "ts-node --skipProject scripts/link-in-app.ts",
+        "link-in-starter": "yarn link-in-app keycloakify-starter",
         "tsc-watch": "tsc -p src/bin -w & tsc -p src/lib -w "
     },
     "bin": {
         "keycloakify": "dist/bin/keycloakify/index.js",
         "create-keycloak-email-directory": "dist/bin/create-keycloak-email-directory.js",
-        "download-builtin-keycloak-theme": "dist/bin/download-builtin-keycloak-theme.js"
+        "download-builtin-keycloak-theme": "dist/bin/download-builtin-keycloak-theme.js",
+        "eject-keycloak-page": "dist/bin/eject-keycloak-page.js"
     },
     "lint-staged": {
         "*.{ts,tsx,json,md}": [
@@ -42,9 +44,9 @@
     "license": "MIT",
     "files": [
         "src/",
-        "!src/scripts",
         "dist/",
-        "!dist/tsconfig.tsbuildinfo"
+        "!dist/tsconfig.tsbuildinfo",
+        "!dist/bin/tsconfig.tsbuildinfo"
     ],
     "keywords": [
         "bluehats",
@@ -56,16 +58,17 @@
         "login",
         "register"
     ],
-    "homepage": "https://github.com/garronej/keycloakify",
+    "homepage": "https://www.keycloakify.dev",
     "peerDependencies": {
         "react": "^16.8.0 || ^17.0.0 || ^18.0.0"
     },
     "devDependencies": {
         "@babel/core": "^7.0.0",
-        "@types/memoizee": "^0.4.7",
+        "@types/make-fetch-happen": "^10.0.1",
         "@types/minimist": "^1.2.2",
         "@types/node": "^18.14.1",
         "@types/react": "18.0.9",
+        "concurrently": "^7.6.0",
         "copyfiles": "^2.4.1",
         "husky": "^4.3.8",
         "lint-staged": "^11.0.0",
@@ -73,21 +76,23 @@
         "properties-parser": "^0.3.1",
         "react": "18.1.0",
         "rimraf": "^3.0.2",
-        "typescript": "^4.9.5",
+        "scripting-tools": "^0.19.13",
         "ts-node": "^10.9.1",
-        "scripting-tools": "^0.19.13"
+        "tsc-alias": "^1.8.3",
+        "typescript": "^5.0.1-rc"
     },
     "dependencies": {
         "@octokit/rest": "^18.12.0",
         "cheerio": "^1.0.0-rc.5",
         "cli-select": "^1.1.2",
-        "evt": "^2.4.15",
+        "evt": "^2.4.18",
+        "make-fetch-happen": "^11.0.3",
         "minimal-polyfills": "^2.2.2",
         "minimist": "^1.2.6",
         "path-browserify": "^1.0.1",
         "react-markdown": "^5.0.3",
         "rfc4648": "^1.5.2",
-        "tsafe": "^1.4.3",
+        "tsafe": "^1.6.0",
         "zod": "^3.17.10"
     }
 }

scripts/generate-i18n-messages.ts

@@ -1,11 +1,11 @@
 import "minimal-polyfills/Object.fromEntries";
 import * as fs from "fs";
 import { join as pathJoin, relative as pathRelative, dirname as pathDirname } from "path";
-import { crawl } from "../bin/tools/crawl";
-import { downloadBuiltinKeycloakTheme } from "../bin/download-builtin-keycloak-theme";
-import { getProjectRoot } from "../bin/tools/getProjectRoot";
-import { getCliOptions } from "../bin/tools/cliOptions";
-import { getLogger } from "../bin/tools/logger";
+import { crawl } from "../src/bin/tools/crawl";
+import { downloadBuiltinKeycloakTheme } from "../src/bin/download-builtin-keycloak-theme";
+import { getProjectRoot } from "../src/bin/tools/getProjectRoot";
+import { getCliOptions } from "../src/bin/tools/cliOptions";
+import { getLogger } from "../src/bin/tools/logger";
 
 //NOTE: To run without argument when we want to generate src/i18n/generated_kcMessages files,
 // update the version array for generating for newer version.

scripts/link-in-app.ts

@@ -1,10 +1,11 @@
 import { execSync } from "child_process";
 import { join as pathJoin, relative as pathRelative } from "path";
+import { getProjectRoot } from "../src/bin/tools/getProjectRoot";
 import * as fs from "fs";
 
 const singletonDependencies: string[] = ["react", "@types/react"];
 
-const rootDirPath = pathJoin(__dirname, "..", "..");
+const rootDirPath = getProjectRoot();
 
 //NOTE: This is only required because of: https://github.com/garronej/ts-ci/blob/c0e207b9677523d4ec97fe672ddd72ccbb3c1cc4/README.md?plain=1#L54-L58
 fs.writeFileSync(

src/Fallback.tsx

@@ -0,0 +1,81 @@
+import { lazy, Suspense } from "react";
+import type { PageProps } from "keycloakify/pages/PageProps";
+import type { I18n } from "keycloakify/i18n";
+import type { KcContext } from "./kcContext";
+
+const Login = lazy(() => import("keycloakify/pages/Login"));
+const Register = lazy(() => import("keycloakify/pages/Register"));
+const RegisterUserProfile = lazy(() => import("keycloakify/pages/RegisterUserProfile"));
+const Info = lazy(() => import("keycloakify/pages/Info"));
+const Error = lazy(() => import("keycloakify/pages/Error"));
+const LoginResetPassword = lazy(() => import("keycloakify/pages/LoginResetPassword"));
+const LoginVerifyEmail = lazy(() => import("keycloakify/pages/LoginVerifyEmail"));
+const Terms = lazy(() => import("keycloakify/pages/Terms"));
+const LoginOtp = lazy(() => import("keycloakify/pages/LoginOtp"));
+const LoginPassword = lazy(() => import("keycloakify/pages/LoginPassword"));
+const LoginUsername = lazy(() => import("keycloakify/pages/LoginUsername"));
+const WebauthnAuthenticate = lazy(() => import("keycloakify/pages/WebauthnAuthenticate"));
+const LoginUpdatePassword = lazy(() => import("keycloakify/pages/LoginUpdatePassword"));
+const LoginUpdateProfile = lazy(() => import("keycloakify/pages/LoginUpdateProfile"));
+const LoginIdpLinkConfirm = lazy(() => import("keycloakify/pages/LoginIdpLinkConfirm"));
+const LoginPageExpired = lazy(() => import("keycloakify/pages/LoginPageExpired"));
+const LoginIdpLinkEmail = lazy(() => import("keycloakify/pages/LoginIdpLinkEmail"));
+const LoginConfigTotp = lazy(() => import("keycloakify/pages/LoginConfigTotp"));
+const LogoutConfirm = lazy(() => import("keycloakify/pages/LogoutConfirm"));
+const UpdateUserProfile = lazy(() => import("keycloakify/pages/UpdateUserProfile"));
+const IdpReviewUserProfile = lazy(() => import("keycloakify/pages/IdpReviewUserProfile"));
+
+export default function Fallback(props: PageProps<KcContext, I18n>) {
+    const { kcContext, ...rest } = props;
+
+    return (
+        <Suspense>
+            {(() => {
+                switch (kcContext.pageId) {
+                    case "login.ftl":
+                        return <Login kcContext={kcContext} {...rest} />;
+                    case "register.ftl":
+                        return <Register kcContext={kcContext} {...rest} />;
+                    case "register-user-profile.ftl":
+                        return <RegisterUserProfile kcContext={kcContext} {...rest} />;
+                    case "info.ftl":
+                        return <Info kcContext={kcContext} {...rest} />;
+                    case "error.ftl":
+                        return <Error kcContext={kcContext} {...rest} />;
+                    case "login-reset-password.ftl":
+                        return <LoginResetPassword kcContext={kcContext} {...rest} />;
+                    case "login-verify-email.ftl":
+                        return <LoginVerifyEmail kcContext={kcContext} {...rest} />;
+                    case "terms.ftl":
+                        return <Terms kcContext={kcContext} {...rest} />;
+                    case "login-otp.ftl":
+                        return <LoginOtp kcContext={kcContext} {...rest} />;
+                    case "login-username.ftl":
+                        return <LoginUsername kcContext={kcContext} {...rest} />;
+                    case "login-password.ftl":
+                        return <LoginPassword kcContext={kcContext} {...rest} />;
+                    case "webauthn-authenticate.ftl":
+                        return <WebauthnAuthenticate kcContext={kcContext} {...rest} />;
+                    case "login-update-password.ftl":
+                        return <LoginUpdatePassword kcContext={kcContext} {...rest} />;
+                    case "login-update-profile.ftl":
+                        return <LoginUpdateProfile kcContext={kcContext} {...rest} />;
+                    case "login-idp-link-confirm.ftl":
+                        return <LoginIdpLinkConfirm kcContext={kcContext} {...rest} />;
+                    case "login-idp-link-email.ftl":
+                        return <LoginIdpLinkEmail kcContext={kcContext} {...rest} />;
+                    case "login-page-expired.ftl":
+                        return <LoginPageExpired kcContext={kcContext} {...rest} />;
+                    case "login-config-totp.ftl":
+                        return <LoginConfigTotp kcContext={kcContext} {...rest} />;
+                    case "logout-confirm.ftl":
+                        return <LogoutConfirm kcContext={kcContext} {...rest} />;
+                    case "update-user-profile.ftl":
+                        return <UpdateUserProfile kcContext={kcContext} {...rest} />;
+                    case "idp-review-user-profile.ftl":
+                        return <IdpReviewUserProfile kcContext={kcContext} {...rest} />;
+                }
+            })()}
+        </Suspense>
+    );
+}

src/Template.tsx

@@ -1,13 +1,12 @@
-import React, { useReducer, useEffect } from "react";
-import { assert } from "./tools/assert";
-import { headInsert } from "./tools/headInsert";
-import { pathJoin } from "../bin/tools/pathJoin";
-import { clsx } from "./tools/clsx";
-import type { TemplateProps } from "./KcProps";
-import type { KcContextBase } from "./getKcContext/KcContextBase";
-import type { I18nBase } from "./i18n";
+import { assert } from "keycloakify/tools/assert";
+import { clsx } from "keycloakify/tools/clsx";
+import { usePrepareTemplate } from "keycloakify/lib/usePrepareTemplate";
+import { type TemplateProps, defaultTemplateClasses } from "keycloakify/TemplateProps";
+import { useGetClassName } from "keycloakify/lib/useGetClassName";
+import type { KcContext } from "./kcContext";
+import type { I18n } from "./i18n";
 
-export default function Template(props: TemplateProps<KcContextBase.Common, I18nBase>) {
+export default function Template(props: TemplateProps<KcContext, I18n>) {
     const {
         displayInfo = false,
         displayMessage = true,
@@ -20,24 +19,29 @@ export default function Template(props: TemplateProps<KcContextBase.Common, I18n
         infoNode = null,
         kcContext,
         i18n,
-        doFetchDefaultThemeResources,
-        stylesCommon,
-        styles,
-        scripts,
-        kcHtmlClass
+        doUseDefaultCss,
+        classes
     } = props;
 
+    const { getClassName } = useGetClassName({
+        "defaultClasses": !doUseDefaultCss ? undefined : defaultTemplateClasses,
+        classes
+    });
+
     const { msg, changeLocale, labelBySupportedLanguageTag, currentLanguageTag } = i18n;
 
     const { realm, locale, auth, url, message, isAppInitiatedAction } = kcContext;
 
     const { isReady } = usePrepareTemplate({
-        doFetchDefaultThemeResources,
-        stylesCommon,
-        styles,
-        scripts,
+        "doFetchDefaultThemeResources": doUseDefaultCss,
         url,
-        kcHtmlClass
+        "stylesCommon": [
+            "node_modules/patternfly/dist/css/patternfly.min.css",
+            "node_modules/patternfly/dist/css/patternfly-additions.min.css",
+            "lib/zocial/zocial.css"
+        ],
+        "styles": ["css/login.css"],
+        "htmlClassName": getClassName("kcHtmlClass")
     });
 
     if (!isReady) {
@@ -45,18 +49,18 @@ export default function Template(props: TemplateProps<KcContextBase.Common, I18n
     }
 
     return (
-        <div className={clsx(props.kcLoginClass)}>
-            <div id="kc-header" className={clsx(props.kcHeaderClass)}>
-                <div id="kc-header-wrapper" className={clsx(props.kcHeaderWrapperClass)}>
+        <div className={getClassName("kcLoginClass")}>
+            <div id="kc-header" className={getClassName("kcHeaderClass")}>
+                <div id="kc-header-wrapper" className={getClassName("kcHeaderWrapperClass")}>
                     {msg("loginTitleHtml", realm.displayNameHtml)}
                 </div>
             </div>
 
-            <div className={clsx(props.kcFormCardClass, displayWide && props.kcFormCardAccountClass)}>
-                <header className={clsx(props.kcFormHeaderClass)}>
+            <div className={clsx(getClassName("kcFormCardClass"), displayWide && getClassName("kcFormCardAccountClass"))}>
+                <header className={getClassName("kcFormHeaderClass")}>
                     {realm.internationalizationEnabled && (assert(locale !== undefined), true) && locale.supported.length > 1 && (
                         <div id="kc-locale">
-                            <div id="kc-locale-wrapper" className={clsx(props.kcLocaleWrapperClass)}>
+                            <div id="kc-locale-wrapper" className={getClassName("kcLocaleWrapperClass")}>
                                 <div className="kc-dropdown" id="kc-locale-dropdown">
                                     {/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}
                                     <a href="#" id="kc-current-locale-link">
@@ -78,8 +82,8 @@ export default function Template(props: TemplateProps<KcContextBase.Common, I18n
                     )}
                     {!(auth !== undefined && auth.showUsername && !auth.showResetCredentials) ? (
                         displayRequiredFields ? (
-                            <div className={clsx(props.kcContentWrapperClass)}>
-                                <div className={clsx(props.kcLabelWrapperClass, "subtitle")}>
+                            <div className={getClassName("kcContentWrapperClass")}>
+                                <div className={clsx(getClassName("kcLabelWrapperClass"), "subtitle")}>
                                     <span className="subtitle">
                                         <span className="required">*</span>
                                         {msg("requiredFields")}
@@ -93,20 +97,20 @@ export default function Template(props: TemplateProps<KcContextBase.Common, I18n
                             <h1 id="kc-page-title">{headerNode}</h1>
                         )
                     ) : displayRequiredFields ? (
-                        <div className={clsx(props.kcContentWrapperClass)}>
-                            <div className={clsx(props.kcLabelWrapperClass, "subtitle")}>
+                        <div className={getClassName("kcContentWrapperClass")}>
+                            <div className={clsx(getClassName("kcLabelWrapperClass"), "subtitle")}>
                                 <span className="subtitle">
                                     <span className="required">*</span> {msg("requiredFields")}
                                 </span>
                             </div>
                             <div className="col-md-10">
                                 {showUsernameNode}
-                                <div className={clsx(props.kcFormGroupClass)}>
+                                <div className={getClassName("kcFormGroupClass")}>
                                     <div id="kc-username">
                                         <label id="kc-attempted-username">{auth?.attemptedUsername}</label>
                                         <a id="reset-login" href={url.loginRestartFlowUrl}>
                                             <div className="kc-login-tooltip">
-                                                <i className={clsx(props.kcResetFlowIcon)}></i>
+                                                <i className={getClassName("kcResetFlowIcon")}></i>
                                                 <span className="kc-tooltip-text">{msg("restartLoginTooltip")}</span>
                                             </div>
                                         </a>
@@ -117,12 +121,12 @@ export default function Template(props: TemplateProps<KcContextBase.Common, I18n
                     ) : (
                         <>
                             {showUsernameNode}
-                            <div className={clsx(props.kcFormGroupClass)}>
+                            <div className={getClassName("kcFormGroupClass")}>
                                 <div id="kc-username">
                                     <label id="kc-attempted-username">{auth?.attemptedUsername}</label>
                                     <a id="reset-login" href={url.loginRestartFlowUrl}>
                                         <div className="kc-login-tooltip">
-                                            <i className={clsx(props.kcResetFlowIcon)}></i>
+                                            <i className={getClassName("kcResetFlowIcon")}></i>
                                             <span className="kc-tooltip-text">{msg("restartLoginTooltip")}</span>
                                         </div>
                                     </a>
@@ -136,10 +140,10 @@ export default function Template(props: TemplateProps<KcContextBase.Common, I18n
                         {/* App-initiated actions should not see warning messages about the need to complete the action during login. */}
                         {displayMessage && message !== undefined && (message.type !== "warning" || !isAppInitiatedAction) && (
                             <div className={clsx("alert", `alert-${message.type}`)}>
-                                {message.type === "success" && <span className={clsx(props.kcFeedbackSuccessIcon)}></span>}
-                                {message.type === "warning" && <span className={clsx(props.kcFeedbackWarningIcon)}></span>}
-                                {message.type === "error" && <span className={clsx(props.kcFeedbackErrorIcon)}></span>}
-                                {message.type === "info" && <span className={clsx(props.kcFeedbackInfoIcon)}></span>}
+                                {message.type === "success" && <span className={getClassName("kcFeedbackSuccessIcon")}></span>}
+                                {message.type === "warning" && <span className={getClassName("kcFeedbackWarningIcon")}></span>}
+                                {message.type === "error" && <span className={getClassName("kcFeedbackErrorIcon")}></span>}
+                                {message.type === "info" && <span className={getClassName("kcFeedbackInfoIcon")}></span>}
                                 <span
                                     className="kc-feedback-text"
                                     dangerouslySetInnerHTML={{
@@ -154,10 +158,14 @@ export default function Template(props: TemplateProps<KcContextBase.Common, I18n
                                 id="kc-select-try-another-way-form"
                                 action={url.loginAction}
                                 method="post"
-                                className={clsx(displayWide && props.kcContentWrapperClass)}
+                                className={clsx(displayWide && getClassName("kcContentWrapperClass"))}
                             >
-                                <div className={clsx(displayWide && [props.kcFormSocialAccountContentClass, props.kcFormSocialAccountClass])}>
-                                    <div className={clsx(props.kcFormGroupClass)}>
+                                <div
+                                    className={clsx(
+                                        displayWide && [getClassName("kcFormSocialAccountContentClass"), getClassName("kcFormSocialAccountClass")]
+                                    )}
+                                >
+                                    <div className={getClassName("kcFormGroupClass")}>
                                         <input type="hidden" name="tryAnotherWay" value="on" />
                                         {/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}
                                         <a
@@ -175,8 +183,8 @@ export default function Template(props: TemplateProps<KcContextBase.Common, I18n
                             </form>
                         )}
                         {displayInfo && (
-                            <div id="kc-info" className={clsx(props.kcSignUpClass)}>
-                                <div id="kc-info-wrapper" className={clsx(props.kcInfoAreaWrapperClass)}>
+                            <div id="kc-info" className={getClassName("kcSignUpClass")}>
+                                <div id="kc-info-wrapper" className={getClassName("kcInfoAreaWrapperClass")}>
                                     {infoNode}
                                 </div>
                             </div>
@@ -187,79 +195,3 @@ export default function Template(props: TemplateProps<KcContextBase.Common, I18n
         </div>
     );
 }
-
-export function usePrepareTemplate(params: {
-    doFetchDefaultThemeResources: boolean;
-    stylesCommon: string | readonly string[] | undefined;
-    styles: string | readonly string[] | undefined;
-    scripts: string | readonly string[] | undefined;
-    url: {
-        resourcesCommonPath: string;
-        resourcesPath: string;
-    };
-    kcHtmlClass: string | readonly string[] | undefined;
-}) {
-    const { doFetchDefaultThemeResources, stylesCommon, styles, url, scripts, kcHtmlClass } = params;
-
-    const [isReady, setReady] = useReducer(() => true, !doFetchDefaultThemeResources);
-
-    useEffect(() => {
-        if (!doFetchDefaultThemeResources) {
-            return;
-        }
-
-        let isUnmounted = false;
-
-        const toArr = (x: string | readonly string[] | undefined) => (typeof x === "string" ? x.split(" ") : x ?? []);
-
-        Promise.all(
-            [
-                ...toArr(stylesCommon).map(relativePath => pathJoin(url.resourcesCommonPath, relativePath)),
-                ...toArr(styles).map(relativePath => pathJoin(url.resourcesPath, relativePath))
-            ]
-                .reverse()
-                .map(href =>
-                    headInsert({
-                        "type": "css",
-                        href,
-                        "position": "prepend"
-                    })
-                )
-        ).then(() => {
-            if (isUnmounted) {
-                return;
-            }
-
-            setReady();
-        });
-
-        toArr(scripts).forEach(relativePath =>
-            headInsert({
-                "type": "javascript",
-                "src": pathJoin(url.resourcesPath, relativePath)
-            })
-        );
-
-        return () => {
-            isUnmounted = true;
-        };
-    }, [kcHtmlClass]);
-
-    useEffect(() => {
-        if (kcHtmlClass === undefined) {
-            return;
-        }
-
-        const htmlClassList = document.getElementsByTagName("html")[0].classList;
-
-        const tokens = clsx(kcHtmlClass).split(" ");
-
-        htmlClassList.add(...tokens);
-
-        return () => {
-            htmlClassList.remove(...tokens);
-        };
-    }, [kcHtmlClass]);
-
-    return { isReady };
-}

src/TemplateProps.ts

@@ -0,0 +1,65 @@
+import type { ReactNode } from "react";
+import type { KcContext } from "./kcContext";
+import type { I18n } from "./i18n";
+
+export type TemplateProps<KcContext extends KcContext.Common, I18nExtended extends I18n> = {
+    kcContext: KcContext;
+    i18n: I18nExtended;
+    doUseDefaultCss: boolean;
+    classes?: Partial<Record<TemplateClassKey, string>>;
+
+    formNode: ReactNode;
+    displayInfo?: boolean;
+    displayMessage?: boolean;
+    displayRequiredFields?: boolean;
+    displayWide?: boolean;
+    showAnotherWayIfPresent?: boolean;
+    headerNode: ReactNode;
+    showUsernameNode?: ReactNode;
+    infoNode?: ReactNode;
+};
+
+export type TemplateClassKey =
+    | "kcHtmlClass"
+    | "kcLoginClass"
+    | "kcHeaderClass"
+    | "kcHeaderWrapperClass"
+    | "kcFormCardClass"
+    | "kcFormCardAccountClass"
+    | "kcFormHeaderClass"
+    | "kcLocaleWrapperClass"
+    | "kcContentWrapperClass"
+    | "kcLabelWrapperClass"
+    | "kcFormGroupClass"
+    | "kcResetFlowIcon"
+    | "kcFeedbackSuccessIcon"
+    | "kcFeedbackWarningIcon"
+    | "kcFeedbackErrorIcon"
+    | "kcFeedbackInfoIcon"
+    | "kcFormSocialAccountContentClass"
+    | "kcFormSocialAccountClass"
+    | "kcSignUpClass"
+    | "kcInfoAreaWrapperClass";
+
+export const defaultTemplateClasses: Record<TemplateClassKey, string | undefined> = {
+    "kcHtmlClass": "login-pf",
+    "kcLoginClass": "login-pf-page",
+    "kcContentWrapperClass": "row",
+    "kcHeaderClass": "login-pf-page-header",
+    "kcHeaderWrapperClass": undefined,
+    "kcFormCardClass": "card-pf",
+    "kcFormCardAccountClass": "login-pf-accounts",
+    "kcFormSocialAccountClass": "login-pf-social-section",
+    "kcFormSocialAccountContentClass": "col-xs-12 col-sm-6",
+    "kcFormHeaderClass": "login-pf-header",
+    "kcLocaleWrapperClass": undefined,
+    "kcFeedbackErrorIcon": "pficon pficon-error-circle-o",
+    "kcFeedbackWarningIcon": "pficon pficon-warning-triangle-o",
+    "kcFeedbackSuccessIcon": "pficon pficon-ok",
+    "kcFeedbackInfoIcon": "pficon pficon-info",
+    "kcResetFlowIcon": "pficon pficon-arrow fa-2x",
+    "kcFormGroupClass": "form-group",
+    "kcLabelWrapperClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
+    "kcSignUpClass": "login-pf-signup",
+    "kcInfoAreaWrapperClass": undefined
+};

src/bin/eject-keycloak-page.ts

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+
+import { getProjectRoot } from "./tools/getProjectRoot";
+import cliSelect from "cli-select";
+import { loginThemePageIds, type PageId } from "./keycloakify/generateFtl/generateFtl";
+import { capitalize } from "tsafe/capitalize";
+import { readFile, writeFile } from "fs/promises";
+import { existsSync } from "fs";
+import { join as pathJoin, relative as pathRelative } from "path";
+import { kebabCaseToCamelCase } from "./tools/kebabCaseToSnakeCase";
+
+(async () => {
+    const projectRootDir = getProjectRoot();
+
+    const { value: pageId } = await cliSelect<PageId>({
+        "values": [...loginThemePageIds]
+    }).catch(() => {
+        console.log("Aborting");
+
+        process.exit(-1);
+    });
+
+    const pageBasename = `${capitalize(kebabCaseToCamelCase(pageId))}.tsx`;
+
+    console.log(pageId);
+
+    const targetFilePath = pathJoin(process.cwd(), "src", "keycloak-theme", "pages", pageBasename);
+
+    if (existsSync(targetFilePath)) {
+        console.log(`${pageId} is already ejected, ${pathRelative(process.cwd(), targetFilePath)} already exists`);
+
+        process.exit(-1);
+    }
+
+    writeFile(targetFilePath, await readFile(pathJoin(projectRootDir, "src", "pages", pageBasename)));
+
+    console.log(`${pathRelative(process.cwd(), targetFilePath)} created`);
+})();

src/bin/keycloakify/BuildOptions.ts

@@ -13,7 +13,10 @@ type ParsedPackageJson = {
     version: string;
     homepage?: string;
     keycloakify?: {
+        /** @deprecated: use extraLoginPages instead */
         extraPages?: string[];
+        extraLoginPages?: string[];
+        extraAccountPages?: string[];
         extraThemeProperties?: string[];
         areAppAndKeycloakServerSharingSameDomain?: boolean;
         artifactId?: string;
@@ -29,6 +32,8 @@ const zParsedPackageJson = z.object({
     "keycloakify": z
         .object({
             "extraPages": z.array(z.string()).optional(),
+            "extraLoginPages": z.array(z.string()).optional(),
+            "extraAccountPages": z.array(z.string()).optional(),
             "extraThemeProperties": z.array(z.string()).optional(),
             "areAppAndKeycloakServerSharingSameDomain": z.boolean().optional(),
             "artifactId": z.string().optional(),
@@ -48,7 +53,8 @@ export namespace BuildOptions {
         isSilent: boolean;
         version: string;
         themeName: string;
-        extraPages?: string[];
+        extraLoginPages: string[] | undefined;
+        extraAccountPages: string[] | undefined;
         extraThemeProperties?: string[];
         groupId: string;
         artifactId: string;
@@ -119,7 +125,7 @@ export function readBuildOptions(params: {
     const common: BuildOptions.Common = (() => {
         const { name, keycloakify = {}, version, homepage } = parsedPackageJson;
 
-        const { extraPages, extraThemeProperties, groupId, artifactId, bundler } = keycloakify ?? {};
+        const { extraPages, extraLoginPages, extraAccountPages, extraThemeProperties, groupId, artifactId, bundler } = keycloakify ?? {};
 
         const themeName = name
             .replace(/^@(.*)/, "$1")
@@ -158,7 +164,8 @@ export function readBuildOptions(params: {
                 );
             })(),
             "version": process.env.KEYCLOAKIFY_VERSION ?? version,
-            extraPages,
+            "extraLoginPages": [...(extraPages ?? []), ...(extraLoginPages ?? [])],
+            extraAccountPages,
             extraThemeProperties,
             isSilent
         };

src/bin/keycloakify/generateFtl/generateFtl.ts

@@ -10,8 +10,11 @@ import type { BuildOptions } from "../BuildOptions";
 import { assert } from "tsafe/assert";
 import { Reflect } from "tsafe/Reflect";
 
-// https://github.com/keycloak/keycloak/blob/main/services/src/main/java/org/keycloak/forms/login/freemarker/Templates.java
-export const pageIds = [
+export const themeTypes = ["login", "account"] as const;
+
+export type ThemeType = (typeof themeTypes)[number];
+
+export const loginThemePageIds = [
     "login.ftl",
     "login-username.ftl",
     "login-password.ftl",
@@ -35,6 +38,11 @@ export const pageIds = [
     "idp-review-user-profile.ftl"
 ] as const;
 
+export const accountThemePageIds = ["password.ftl"] as const;
+
+export type PageId = (typeof loginThemePageIds)[number];
+export type AccountThemePageId = (typeof accountThemePageIds)[number];
+
 export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.ExternalAssets;
 
 export namespace BuildOptionsLike {
@@ -68,8 +76,6 @@ export namespace BuildOptionsLike {
     assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
 }
 
-export type PageId = (typeof pageIds)[number];
-
 export function generateFtlFilesCodeFactory(params: {
     indexHtmlCode: string;
     //NOTE: Expected to be an empty object if external assets mode is enabled.

src/bin/keycloakify/generateJavaStackFiles.ts

@@ -1,5 +1,6 @@
 import * as fs from "fs";
 import { join as pathJoin, dirname as pathDirname } from "path";
+import { themeTypes } from "./generateFtl/generateFtl";
 import { assert } from "tsafe/assert";
 import { Reflect } from "tsafe/Reflect";
 import type { BuildOptions } from "./BuildOptions";
@@ -69,7 +70,7 @@ export function generateJavaStackFiles(params: {
                         "themes": [
                             {
                                 "name": themeName,
-                                "types": ["login", ...(doBundlesEmailTemplate ? ["email"] : [])]
+                                "types": [...themeTypes, ...(doBundlesEmailTemplate ? ["email"] : [])]
                             }
                         ]
                     },

src/bin/keycloakify/generateKeycloakThemeResources.ts

@@ -3,7 +3,7 @@ import * as fs from "fs";
 import { join as pathJoin, basename as pathBasename } from "path";
 import { replaceImportsFromStaticInJsCode } from "./replacers/replaceImportsFromStaticInJsCode";
 import { replaceImportsInCssCode } from "./replacers/replaceImportsInCssCode";
-import { generateFtlFilesCodeFactory, pageIds } from "./generateFtl";
+import { generateFtlFilesCodeFactory, loginThemePageIds, themeTypes, ThemeType } from "./generateFtl";
 import { downloadBuiltinKeycloakTheme } from "../download-builtin-keycloak-theme";
 import { mockTestingResourcesCommonPath, mockTestingResourcesPath, mockTestingSubDirOfPublicDirBasename } from "../mockTestingResourcesPath";
 import { isInside } from "../tools/isInside";
@@ -17,7 +17,8 @@ export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.Ex
 export namespace BuildOptionsLike {
     export type Common = {
         themeName: string;
-        extraPages?: string[];
+        extraLoginPages?: string[];
+        extraAccountPages?: string[];
         extraThemeProperties?: string[];
         isSilent: boolean;
     };
@@ -62,58 +63,154 @@ export async function generateKeycloakThemeResources(params: {
     const { reactAppBuildDirPath, keycloakThemeBuildingDirPath, keycloakThemeEmailDirPath, keycloakVersion, buildOptions } = params;
 
     const logger = getLogger({ isSilent: buildOptions.isSilent });
-    const themeDirPath = pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", buildOptions.themeName, "login");
+
+    const getThemeDirPath = (themeType: ThemeType | "email") =>
+        pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", buildOptions.themeName, themeType);
 
     let allCssGlobalsToDefine: Record<string, string> = {};
 
-    transformCodebase({
-        "destDirPath": buildOptions.isStandalone ? pathJoin(themeDirPath, "resources", "build") : reactAppBuildDirPath,
-        "srcDirPath": reactAppBuildDirPath,
-        "transformSourceCode": ({ filePath, sourceCode }) => {
-            //NOTE: Prevent cycles, excludes the folder we generated for debug in public/
-            if (
-                buildOptions.isStandalone &&
-                isInside({
-                    "dirPath": pathJoin(reactAppBuildDirPath, mockTestingSubDirOfPublicDirBasename),
-                    filePath
-                })
-            ) {
-                return undefined;
-            }
+    let generateFtlFilesCode_glob: ReturnType<typeof generateFtlFilesCodeFactory>["generateFtlFilesCode"] | undefined = undefined;
 
-            if (/\.css?$/i.test(filePath)) {
-                if (!buildOptions.isStandalone) {
-                    return undefined;
-                }
-
-                const { cssGlobalsToDefine, fixedCssCode } = replaceImportsInCssCode({
-                    "cssCode": sourceCode.toString("utf8")
-                });
-
-                allCssGlobalsToDefine = {
-                    ...allCssGlobalsToDefine,
-                    ...cssGlobalsToDefine
-                };
-
-                return { "modifiedSourceCode": Buffer.from(fixedCssCode, "utf8") };
-            }
-
-            if (/\.js?$/i.test(filePath)) {
-                if (!buildOptions.isStandalone && buildOptions.areAppAndKeycloakServerSharingSameDomain) {
-                    return undefined;
-                }
-
-                const { fixedJsCode } = replaceImportsFromStaticInJsCode({
-                    "jsCode": sourceCode.toString("utf8"),
-                    buildOptions
-                });
-
-                return { "modifiedSourceCode": Buffer.from(fixedJsCode, "utf8") };
-            }
-
-            return buildOptions.isStandalone ? { "modifiedSourceCode": sourceCode } : undefined;
+    for (const themeType of themeTypes) {
+        if (themeType === "account") {
+            continue;
         }
-    });
+
+        const themeDirPath = getThemeDirPath(themeType);
+
+        copy_app_resources_to_theme_path: {
+            const isFirstPass = themeType.indexOf(themeType) === 0;
+
+            if (!isFirstPass && !buildOptions.isStandalone) {
+                break copy_app_resources_to_theme_path;
+            }
+
+            transformCodebase({
+                "destDirPath": buildOptions.isStandalone ? pathJoin(themeDirPath, "resources", "build") : reactAppBuildDirPath,
+                "srcDirPath": reactAppBuildDirPath,
+                "transformSourceCode": ({ filePath, sourceCode }) => {
+                    //NOTE: Prevent cycles, excludes the folder we generated for debug in public/
+                    if (
+                        buildOptions.isStandalone &&
+                        isInside({
+                            "dirPath": pathJoin(reactAppBuildDirPath, mockTestingSubDirOfPublicDirBasename),
+                            filePath
+                        })
+                    ) {
+                        return undefined;
+                    }
+
+                    if (/\.css?$/i.test(filePath)) {
+                        if (!buildOptions.isStandalone) {
+                            return undefined;
+                        }
+
+                        const { cssGlobalsToDefine, fixedCssCode } = replaceImportsInCssCode({
+                            "cssCode": sourceCode.toString("utf8")
+                        });
+
+                        register_css_variables: {
+                            if (!isFirstPass) {
+                                break register_css_variables;
+                            }
+
+                            allCssGlobalsToDefine = {
+                                ...allCssGlobalsToDefine,
+                                ...cssGlobalsToDefine
+                            };
+                        }
+
+                        return { "modifiedSourceCode": Buffer.from(fixedCssCode, "utf8") };
+                    }
+
+                    if (/\.js?$/i.test(filePath)) {
+                        if (!buildOptions.isStandalone && buildOptions.areAppAndKeycloakServerSharingSameDomain) {
+                            return undefined;
+                        }
+
+                        const { fixedJsCode } = replaceImportsFromStaticInJsCode({
+                            "jsCode": sourceCode.toString("utf8"),
+                            buildOptions
+                        });
+
+                        return { "modifiedSourceCode": Buffer.from(fixedJsCode, "utf8") };
+                    }
+
+                    return buildOptions.isStandalone ? { "modifiedSourceCode": sourceCode } : undefined;
+                }
+            });
+        }
+
+        const generateFtlFilesCode = (() => {
+            if (generateFtlFilesCode_glob !== undefined) {
+                return generateFtlFilesCode_glob;
+            }
+
+            const { generateFtlFilesCode } = generateFtlFilesCodeFactory({
+                "indexHtmlCode": fs.readFileSync(pathJoin(reactAppBuildDirPath, "index.html")).toString("utf8"),
+                "cssGlobalsToDefine": allCssGlobalsToDefine,
+                "buildOptions": buildOptions
+            });
+
+            return generateFtlFilesCode;
+        })();
+
+        [...loginThemePageIds, ...(buildOptions.extraLoginPages ?? [])].forEach(pageId => {
+            const { ftlCode } = generateFtlFilesCode({ pageId });
+
+            fs.mkdirSync(themeDirPath, { "recursive": true });
+
+            fs.writeFileSync(pathJoin(themeDirPath, pageId), Buffer.from(ftlCode, "utf8"));
+        });
+
+        {
+            const tmpDirPath = pathJoin(themeDirPath, "..", "tmp_xxKdLpdIdLd");
+
+            await downloadBuiltinKeycloakTheme({
+                keycloakVersion,
+                "destDirPath": tmpDirPath,
+                isSilent: buildOptions.isSilent
+            });
+
+            const themeResourcesDirPath = pathJoin(themeDirPath, "resources");
+
+            transformCodebase({
+                "srcDirPath": pathJoin(tmpDirPath, "keycloak", "login", "resources"),
+                "destDirPath": themeResourcesDirPath
+            });
+
+            const reactAppPublicDirPath = pathJoin(reactAppBuildDirPath, "..", "public");
+
+            transformCodebase({
+                "srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
+                "destDirPath": pathJoin(themeResourcesDirPath, pathBasename(mockTestingResourcesCommonPath))
+            });
+
+            transformCodebase({
+                "srcDirPath": themeResourcesDirPath,
+                "destDirPath": pathJoin(reactAppPublicDirPath, mockTestingResourcesPath)
+            });
+
+            const keycloakResourcesWithinPublicDirPath = pathJoin(reactAppPublicDirPath, mockTestingSubDirOfPublicDirBasename);
+
+            fs.writeFileSync(
+                pathJoin(keycloakResourcesWithinPublicDirPath, "README.txt"),
+                Buffer.from(
+                    ["This is just a test folder that helps develop", "the login and register page without having to run a Keycloak container"].join(
+                        " "
+                    )
+                )
+            );
+
+            fs.writeFileSync(pathJoin(keycloakResourcesWithinPublicDirPath, ".gitignore"), Buffer.from("*", "utf8"));
+            fs.rmSync(tmpDirPath, { recursive: true, force: true });
+        }
+
+        fs.writeFileSync(
+            pathJoin(themeDirPath, "theme.properties"),
+            Buffer.from(["parent=keycloak", ...(buildOptions.extraThemeProperties ?? [])].join("\n\n"), "utf8")
+        );
+    }
 
     let doBundlesEmailTemplate: boolean;
 
@@ -133,69 +230,9 @@ export async function generateKeycloakThemeResources(params: {
 
         transformCodebase({
             "srcDirPath": keycloakThemeEmailDirPath,
-            "destDirPath": pathJoin(themeDirPath, "..", "email")
+            "destDirPath": getThemeDirPath("email")
         });
     }
 
-    const { generateFtlFilesCode } = generateFtlFilesCodeFactory({
-        "indexHtmlCode": fs.readFileSync(pathJoin(reactAppBuildDirPath, "index.html")).toString("utf8"),
-        "cssGlobalsToDefine": allCssGlobalsToDefine,
-        "buildOptions": buildOptions
-    });
-
-    [...pageIds, ...(buildOptions.extraPages ?? [])].forEach(pageId => {
-        const { ftlCode } = generateFtlFilesCode({ pageId });
-
-        fs.mkdirSync(themeDirPath, { "recursive": true });
-
-        fs.writeFileSync(pathJoin(themeDirPath, pageId), Buffer.from(ftlCode, "utf8"));
-    });
-
-    {
-        const tmpDirPath = pathJoin(themeDirPath, "..", "tmp_xxKdLpdIdLd");
-
-        await downloadBuiltinKeycloakTheme({
-            keycloakVersion,
-            "destDirPath": tmpDirPath,
-            isSilent: buildOptions.isSilent
-        });
-
-        const themeResourcesDirPath = pathJoin(themeDirPath, "resources");
-
-        transformCodebase({
-            "srcDirPath": pathJoin(tmpDirPath, "keycloak", "login", "resources"),
-            "destDirPath": themeResourcesDirPath
-        });
-
-        const reactAppPublicDirPath = pathJoin(reactAppBuildDirPath, "..", "public");
-
-        transformCodebase({
-            "srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
-            "destDirPath": pathJoin(themeResourcesDirPath, pathBasename(mockTestingResourcesCommonPath))
-        });
-
-        transformCodebase({
-            "srcDirPath": themeResourcesDirPath,
-            "destDirPath": pathJoin(reactAppPublicDirPath, mockTestingResourcesPath)
-        });
-
-        const keycloakResourcesWithinPublicDirPath = pathJoin(reactAppPublicDirPath, mockTestingSubDirOfPublicDirBasename);
-
-        fs.writeFileSync(
-            pathJoin(keycloakResourcesWithinPublicDirPath, "README.txt"),
-            Buffer.from(
-                ["This is just a test folder that helps develop", "the login and register page without having to run a Keycloak container"].join(" ")
-            )
-        );
-
-        fs.writeFileSync(pathJoin(keycloakResourcesWithinPublicDirPath, ".gitignore"), Buffer.from("*", "utf8"));
-        fs.rmSync(tmpDirPath, { recursive: true, force: true });
-    }
-
-    fs.writeFileSync(
-        pathJoin(themeDirPath, "theme.properties"),
-        Buffer.from(["parent=keycloak", ...(buildOptions.extraThemeProperties ?? [])].join("\n\n"), "utf8")
-    );
-
     return { doBundlesEmailTemplate };
 }

src/bin/keycloakify/generateStartKeycloakTestingContainer.ts

@@ -30,15 +30,18 @@ export function generateStartKeycloakTestingContainer(params: {
         buildOptions: { themeName }
     } = params;
 
+    const keycloakThemePath = pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", themeName).replace(/\\/g, "/");
+
     fs.writeFileSync(
         pathJoin(keycloakThemeBuildingDirPath, generateStartKeycloakTestingContainer.basename),
+
         Buffer.from(
             [
                 "#!/usr/bin/env bash",
                 "",
                 `docker rm ${containerName} || true`,
                 "",
-                `cd ${keycloakThemeBuildingDirPath}`,
+                `cd "${keycloakThemeBuildingDirPath.replace(/\\/g, "/")}"`,
                 "",
                 "docker run \\",
                 "   -p 8080:8080 \\",
@@ -46,14 +49,7 @@ export function generateStartKeycloakTestingContainer(params: {
                 "   -e KEYCLOAK_ADMIN=admin \\",
                 "   -e KEYCLOAK_ADMIN_PASSWORD=admin \\",
                 "   -e JAVA_OPTS=-Dkeycloak.profile=preview \\",
-                `   -v ${pathJoin(
-                    keycloakThemeBuildingDirPath,
-                    "src",
-                    "main",
-                    "resources",
-                    "theme",
-                    themeName
-                )}:/opt/keycloak/themes/${themeName}:rw \\`,
+                `   -v "${keycloakThemePath}":"/opt/keycloak/themes/${themeName}":rw \\`,
                 `   -it quay.io/keycloak/keycloak:${keycloakVersion} \\`,
                 `   start-dev`,
                 ""

src/bin/tools/downloadAndUnzip.ts

@@ -1,27 +1,22 @@
-import { dirname as pathDirname, basename as pathBasename, join as pathJoin } from "path";
-import { createReadStream, createWriteStream, unlinkSync } from "fs";
-import { stat, mkdir, unlink, readFile, writeFile } from "fs/promises";
+import { dirname as pathDirname, basename as pathBasename, join as pathJoin, join } from "path";
+import { createReadStream, createWriteStream } from "fs";
+import { stat, mkdir, unlink, writeFile } from "fs/promises";
 import { transformCodebase } from "./transformCodebase";
 import { createHash } from "crypto";
-import http from "http";
-import https from "https";
+import fetch from "make-fetch-happen";
 import { createInflateRaw } from "zlib";
-
 import type { Readable } from "stream";
+import { homedir } from "os";
+import { FetchOptions } from "make-fetch-happen";
+import { exec as execCallback } from "child_process";
+import { promisify } from "util";
+
+const exec = promisify(execCallback);
 
 function hash(s: string) {
     return createHash("sha256").update(s).digest("hex");
 }
 
-async function maybeReadFile(path: string) {
-    try {
-        return await readFile(path, "utf-8");
-    } catch (error) {
-        if ((error as Error & { code: string }).code === "ENOENT") return undefined;
-        throw error;
-    }
-}
-
 async function maybeStat(path: string) {
     try {
         return await stat(path);
@@ -32,69 +27,59 @@ async function maybeStat(path: string) {
 }
 
 /**
- * Download a file from `url` to `dir`. Will try to avoid downloading existing
- * files by using an `{hash(url)}.etag` file. If this file exists, we add an
- * etag headear, so server can tell us if file changed and we should re-download
- * or if our file is up-to-date.
+ * Get an npm configuration value as string, undefined if not set.
  *
- * Warning, this method assumes that the target filename can be extracted from
- * url, content-disposition headers are ignored.
+ * @param key
+ * @returns string or undefined
+ */
+async function getNmpConfig(key: string): Promise<string | undefined> {
+    const { stdout } = await exec(`npm config get ${key}`);
+    const value = stdout.trim();
+    return value && value !== "null" ? value : undefined;
+}
+
+/**
+ * Get proxy configuration from npm config files. Note that we don't care about
+ * proxy config in env vars, because make-fetch-happen will do that for us.
+ *
+ * @returns proxy configuration
+ */
+async function getNpmProxyConfig(): Promise<Pick<FetchOptions, "proxy" | "noProxy">> {
+    const proxy = (await getNmpConfig("https-proxy")) ?? (await getNmpConfig("proxy"));
+    const noProxy = (await getNmpConfig("noproxy")) ?? (await getNmpConfig("no-proxy"));
+
+    return { proxy, noProxy };
+}
+
+/**
+ * Download a file from `url` to `dir`. Will try to avoid downloading existing
+ * files by using the cache directory ~/.keycloakify/cache
  *
  * If the target directory does not exist, it will be created.
  *
- * If the target file exists and is out of date, it will be overwritten.
- * If the target file exists and there is no etag file, the target file will
- * be overwritten.
+ * If the target file exists, it will be overwritten.
+ *
+ * We use make-fetch-happen's internal file cache here, so we don't need to
+ * worry about redownloading the same file over and over. Unfortunately, that
+ * cache does not have a single file per entry, but bundles and indexes them,
+ * so we still need to write the contents to the target directory (possibly
+ * over and over), cause the current unzip implementation wants random access.
  *
  * @param url download url
  * @param dir target directory
+ * @param filename target filename
  * @returns promise for the full path of the downloaded file
  */
-async function download(url: string, dir: string): Promise<string> {
-    await mkdir(dir, { recursive: true });
-    const filename = pathBasename(url);
+async function download(url: string, dir: string, filename: string): Promise<string> {
+    const proxyOpts = await getNpmProxyConfig();
+    const cacheRoot = process.env.XDG_CACHE_HOME ?? homedir();
+    const cachePath = join(cacheRoot, ".keycloakify/cache");
+    const opts: FetchOptions = { cachePath, ...proxyOpts };
+    const response = await fetch(url, opts);
     const filepath = pathJoin(dir, filename);
-    // If downloaded file exists already and has an `.etag` companion file,
-    // read the etag from that file. This will avoid re-downloading the file
-    // if it is up to date.
-    const exists = await maybeStat(filepath);
-    const etagFilepath = pathJoin(dir, "_" + hash(url).substring(0, 15) + ".etag");
-    const etag = !exists ? undefined : await maybeReadFile(etagFilepath);
-
-    return new Promise((resolve, reject) => {
-        // use inner method to allow following redirects
-        function request(url1: URL) {
-            const headers: Record<string, string> = {};
-            if (etag) headers["If-None-Match"] = etag;
-            (url1.protocol === "https:" ? https : http).get(url1, { headers }, response => {
-                if (response.statusCode === 301 || response.statusCode === 302) {
-                    // follow redirects
-                    request(new URL(response.headers.location!!));
-                } else if (response.statusCode === 304) {
-                    // up-to-date, resolve now
-                    resolve(filepath);
-                } else if (response.statusCode !== 200) {
-                    reject(new Error(`Request to ${url1} returned status ${response.statusCode}.`));
-                } else {
-                    const fp = createWriteStream(filepath, { autoClose: true });
-                    fp.on("err", e => {
-                        fp.close();
-                        unlinkSync(filepath);
-                        reject(e);
-                    });
-                    fp.on("finish", async () => {
-                        // when targetfile has been written, write etag file so that
-                        // next time around we don't need to re-download
-                        const responseEtag = response.headers.etag;
-                        if (responseEtag) await writeFile(etagFilepath, responseEtag, "utf-8");
-                        resolve(filepath);
-                    });
-                    response.pipe(fp);
-                }
-            });
-        }
-        request(new URL(url));
-    });
+    await mkdir(dir, { recursive: true });
+    await writeFile(filepath, response.body);
+    return filepath;
 }
 
 /**
@@ -145,6 +130,7 @@ async function unzip(zipFile: string, dir: string, archiveDir?: string): Promise
                 // Pull the file out of the archive, write it to the target directory
                 const input = createRecordReadStream();
                 const output = createWriteStream(filePath);
+                output.setMaxListeners(Infinity);
                 output.on("error", e => reject(Object.assign(e, { filePath })));
                 output.on("finish", () => resolve(filePath));
                 input.pipe(output);
@@ -181,6 +167,7 @@ async function readFileChunk(file: string, start: number, end: number): Promise<
     const chunks: Buffer[] = [];
     return new Promise((resolve, reject) => {
         const stream = createReadStream(file, { start, end });
+        stream.setMaxListeners(Infinity);
         stream.on("error", e => reject(e));
         stream.on("end", () => resolve(Buffer.concat(chunks)));
         stream.on("data", chunk => chunks.push(chunk as Buffer));
@@ -278,7 +265,8 @@ export async function downloadAndUnzip({
     const downloadHash = hash(JSON.stringify({ url, pathOfDirToExtractInArchive })).substring(0, 15);
     const extractDirPath = pathJoin(cacheDirPath, `_${downloadHash}`);
 
-    const zipFilepath = await download(url, cacheDirPath);
+    const filename = pathBasename(url);
+    const zipFilepath = await download(url, cacheDirPath, filename);
     const zipMtime = (await stat(zipFilepath)).mtimeMs;
     const unzipMtime = (await maybeStat(extractDirPath))?.mtimeMs;
 

src/bin/tools/kebabCaseToSnakeCase.ts

@@ -0,0 +1,7 @@
+import { capitalize } from "tsafe/capitalize";
+
+export function kebabCaseToCamelCase(kebabCaseString: string): string {
+    const [first, ...rest] = kebabCaseString.split("-");
+
+    return [first, rest.map(capitalize)].join("");
+}