keycloakify 10.0.0-rc.14 → 10.0.0-rc.16

package/src/bin/{download-builtin-keycloak-theme.ts → download-keycloak-default-theme.ts}

@@ -1,8 +1,9 @@
-import { join as pathJoin } from "path";
+import { join as pathJoin, relative as pathRelative, sep as pathSep } from "path";
 import { promptKeycloakVersion } from "./shared/promptKeycloakVersion";
 import { readBuildOptions } from "./shared/buildOptions";
-import { downloadBuiltinKeycloakTheme } from "./shared/downloadBuiltinKeycloakTheme";
+import { downloadKeycloakDefaultTheme } from "./shared/downloadKeycloakDefaultTheme";
 import type { CliCommandOptions } from "./main";
+import chalk from "chalk";
 
 export async function command(params: { cliCommandOptions: CliCommandOptions }) {
     const { cliCommandOptions } = params;
@@ -11,20 +12,26 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
         cliCommandOptions
     });
 
-    console.log("Select the Keycloak version from which you want to download the builtins theme:");
+    console.log(chalk.cyan("Select the Keycloak version from which you want to download the builtins theme:"));
 
     const { keycloakVersion } = await promptKeycloakVersion({
         "startingFromMajor": undefined,
         "cacheDirPath": buildOptions.cacheDirPath
     });
 
+    console.log(`→ ${keycloakVersion}`);
+
     const destDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources", "theme");
 
-    console.log(`Downloading builtins theme of Keycloak ${keycloakVersion} here ${destDirPath}`);
+    console.log(
+        `Downloading builtins theme of Keycloak ${keycloakVersion} here ${chalk.bold(`.${pathSep}${pathRelative(process.cwd(), destDirPath)}`)}`
+    );
 
-    await downloadBuiltinKeycloakTheme({
+    await downloadKeycloakDefaultTheme({
         keycloakVersion,
         destDirPath,
         buildOptions
     });
+
+    console.log(chalk.green(`✓ done`));
 }

package/src/bin/{eject-keycloak-page.ts → eject-page.ts}

@@ -18,6 +18,7 @@ import { assert, Equals } from "tsafe/assert";
 import { getThemeSrcDirPath } from "./shared/getThemeSrcDirPath";
 import type { CliCommandOptions } from "./main";
 import { readBuildOptions } from "./shared/buildOptions";
+import chalk from "chalk";
 
 export async function command(params: { cliCommandOptions: CliCommandOptions }) {
     const { cliCommandOptions } = params;
@@ -26,17 +27,17 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
         cliCommandOptions
     });
 
-    console.log("Theme type:");
+    console.log(chalk.cyan("Theme type:"));
 
     const { value: themeType } = await cliSelect<ThemeType>({
         "values": [...themeTypes]
     }).catch(() => {
-        console.log("Aborting");
-
         process.exit(-1);
     });
 
-    console.log("Select the page you want to customize:");
+    console.log(`→ ${themeType}`);
+
+    console.log(chalk.cyan("Select the page you want to customize:"));
 
     const { value: pageId } = await cliSelect<LoginThemePageId | AccountThemePageId>({
         "values": (() => {
@@ -49,11 +50,11 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
             assert<Equals<typeof themeType, never>>(false);
         })()
     }).catch(() => {
-        console.log("Aborting");
-
         process.exit(-1);
     });
 
+    console.log(`→ ${pageId}`);
+
     const componentPageBasename = capitalize(kebabCaseToCamelCase(pageId)).replace(/ftl$/, "tsx");
 
     const { themeSrcDirPath } = getThemeSrcDirPath({ "reactAppRootDirPath": buildOptions.reactAppRootDirPath });
@@ -85,42 +86,54 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
     console.log(
         [
             ``,
-            `\`${pathJoin(".", pathRelative(process.cwd(), targetFilePath))}\` copy pasted from the Keycloakify source code into your project.`,
+            `${chalk.green("✓")} ${chalk.bold(
+                pathJoin(".", pathRelative(process.cwd(), targetFilePath))
+            )} copy pasted from the Keycloakify source code into your project`,
             ``,
             `You now need to update your page router:`,
             ``,
-            `\`${pathJoin(".", pathRelative(process.cwd(), themeSrcDirPath), themeType, "KcApp.tsx")}\`:`,
-            "```",
+            `${chalk.bold(pathJoin(".", pathRelative(process.cwd(), themeSrcDirPath), themeType, "KcApp.tsx"))}:`,
+            chalk.grey("```"),
             `// ...`,
             ``,
-            `+const ${componentPageBasename.replace(/.tsx$/, "")} = lazy(() => import("./pages/${componentPageBasename}"));`,
-            ``,
-            ` export default function KcApp(props: { kcContext: KcContext; }) {`,
-            ``,
-            `     // ...`,
-            ``,
-            `     return (`,
-            `         <Suspense>`,
-            `             {(() => {`,
-            `                 switch (kcContext.pageId) {`,
-            `                     // ...`,
-            `                     case "${pageId}": return (`,
-            `+                        <Login`,
-            `+                            {...{ kcContext, i18n, classes }}`,
-            `+                            Template={Template}`,
-            ...(!componentPageContent.includes(userProfileFormFieldComponentName)
-                ? []
-                : [`+                            ${userProfileFormFieldComponentName}={${userProfileFormFieldComponentName}}`]),
-            `+                            doUseDefaultCss={true}`,
-            `+                        />`,
-            `+                    );`,
-            `                     default: return <Fallback /* .. */ />;`,
-            `                 }`,
-            `             })()}`,
-            `         </Suspense>`,
-            `     );`,
-            ` }`,
-            "```"
+            chalk.green(`+const ${componentPageBasename.replace(/.tsx$/, "")} = lazy(() => import("./pages/${componentPageBasename}"));`),
+            ...[
+                ``,
+                ` export default function KcApp(props: { kcContext: KcContext; }) {`,
+                ``,
+                `     // ...`,
+                ``,
+                `     return (`,
+                `         <Suspense>`,
+                `             {(() => {`,
+                `                 switch (kcContext.pageId) {`,
+                `                     // ...`,
+                `+                    case "${pageId}": return (`,
+                `+                        <Login`,
+                `+                            {...{ kcContext, i18n, classes }}`,
+                `+                            Template={Template}`,
+                ...(!componentPageContent.includes(userProfileFormFieldComponentName)
+                    ? []
+                    : [`+                            ${userProfileFormFieldComponentName}={${userProfileFormFieldComponentName}}`]),
+                `+                            doUseDefaultCss={true}`,
+                `+                        />`,
+                `+                    );`,
+                `                     default: return <Fallback /* .. */ />;`,
+                `                 }`,
+                `             })()}`,
+                `         </Suspense>`,
+                `     );`,
+                ` }`
+            ].map(line => {
+                if (line.startsWith("+")) {
+                    return chalk.green(line);
+                }
+                if (line.startsWith("-")) {
+                    return chalk.red(line);
+                }
+                return chalk.grey(line);
+            }),
+            chalk.grey("```")
         ].join("\n")
     );
 }

package/src/bin/initialize-email-theme.ts

@@ -1,4 +1,4 @@
-import { downloadBuiltinKeycloakTheme } from "./shared/downloadBuiltinKeycloakTheme";
+import { downloadKeycloakDefaultTheme } from "./shared/downloadKeycloakDefaultTheme";
 import { join as pathJoin, relative as pathRelative } from "path";
 import { transformCodebase } from "./tools/transformCodebase";
 import { promptKeycloakVersion } from "./shared/promptKeycloakVersion";
@@ -37,7 +37,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
 
     rmSync(builtinKeycloakThemeTmpDirPath, { "recursive": true, "force": true });
 
-    await downloadBuiltinKeycloakTheme({
+    await downloadKeycloakDefaultTheme({
         keycloakVersion,
         "destDirPath": builtinKeycloakThemeTmpDirPath,
         buildOptions

package/src/bin/keycloakify/generateSrcMainResources/bringInAccountV1.ts

@@ -3,7 +3,7 @@ import { join as pathJoin } from "path";
 import { assert } from "tsafe/assert";
 import type { BuildOptions } from "../../shared/buildOptions";
 import { resources_common, lastKeycloakVersionWithAccountV1, accountV1ThemeName } from "../../shared/constants";
-import { downloadBuiltinKeycloakTheme } from "../../shared/downloadBuiltinKeycloakTheme";
+import { downloadKeycloakDefaultTheme } from "../../shared/downloadKeycloakDefaultTheme";
 import { transformCodebase } from "../../tools/transformCodebase";
 import { rmSync } from "../../tools/fs.rmSync";
 
@@ -20,7 +20,7 @@ export async function bringInAccountV1(params: { buildOptions: BuildOptionsLike
 
     const builtinKeycloakThemeTmpDirPath = pathJoin(buildOptions.cacheDirPath, "bringInAccountV1_tmp");
 
-    await downloadBuiltinKeycloakTheme({
+    await downloadKeycloakDefaultTheme({
         "destDirPath": builtinKeycloakThemeTmpDirPath,
         "keycloakVersion": lastKeycloakVersionWithAccountV1,
         buildOptions

package/src/bin/main.ts

@@ -107,13 +107,13 @@ program
 
 program
     .command({
-        "name": "download-builtin-keycloak-theme",
+        "name": "download-keycloak-default-theme",
         "description": "Download the built-in Keycloak theme."
     })
     .task({
         skip,
         "handler": async cliCommandOptions => {
-            const { command } = await import("./download-builtin-keycloak-theme");
+            const { command } = await import("./download-keycloak-default-theme");
 
             await command({ cliCommandOptions });
         }
@@ -121,13 +121,13 @@ program
 
 program
     .command({
-        "name": "eject-keycloak-page",
+        "name": "eject-page",
         "description": "Eject a Keycloak page."
     })
     .task({
         skip,
         "handler": async cliCommandOptions => {
-            const { command } = await import("./eject-keycloak-page");
+            const { command } = await import("./eject-page");
 
             await command({ cliCommandOptions });
         }

package/src/bin/shared/downloadAndUnzip.ts

@@ -116,11 +116,11 @@ export async function downloadAndUnzip(params: {
 
         await rm(extractDirPath, { "recursive": true });
 
-        upload_to_remot_cache_if_admin: {
+        upload_to_remote_cache_if_admin: {
             const githubToken = process.env["KEYCLOAKIFY_ADMIN_GITHUB_PERSONAL_ACCESS_TOKEN"];
 
-            if (githubToken === undefined) {
-                break upload_to_remot_cache_if_admin;
+            if (!githubToken) {
+                break upload_to_remote_cache_if_admin;
             }
 
             console.log("uploading to remote cache");

package/src/bin/shared/{downloadBuiltinKeycloakTheme.ts → downloadKeycloakDefaultTheme.ts}

@@ -5,7 +5,7 @@ import { assert } from "tsafe/assert";
 import * as child_process from "child_process";
 import * as fs from "fs";
 import { rmSync } from "../tools/fs.rmSync";
-import { lastKeycloakVersionWithAccountV1 } from "../shared/constants";
+import { lastKeycloakVersionWithAccountV1 } from "./constants";
 import { transformCodebase } from "../tools/transformCodebase";
 
 export type BuildOptionsLike = {
@@ -15,7 +15,7 @@ export type BuildOptionsLike = {
 
 assert<BuildOptions extends BuildOptionsLike ? true : false>();
 
-export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: string; destDirPath: string; buildOptions: BuildOptionsLike }) {
+export async function downloadKeycloakDefaultTheme(params: { keycloakVersion: string; destDirPath: string; buildOptions: BuildOptionsLike }) {
     const { keycloakVersion, destDirPath, buildOptions } = params;
 
     await downloadAndUnzip({

package/src/bin/shared/downloadKeycloakStaticResources.ts

@@ -1,6 +1,6 @@
 import { transformCodebase } from "../tools/transformCodebase";
 import { join as pathJoin } from "path";
-import { downloadBuiltinKeycloakTheme } from "./downloadBuiltinKeycloakTheme";
+import { downloadKeycloakDefaultTheme } from "./downloadKeycloakDefaultTheme";
 import { resources_common, type ThemeType } from "./constants";
 import type { BuildOptions } from "./buildOptions";
 import { assert } from "tsafe/assert";
@@ -27,7 +27,7 @@ export async function downloadKeycloakStaticResources(params: {
         `downloadKeycloakStaticResources_tmp_${crypto.createHash("sha256").update(`${themeType}-${keycloakVersion}`).digest("hex").slice(0, 8)}`
     );
 
-    await downloadBuiltinKeycloakTheme({
+    await downloadKeycloakDefaultTheme({
         keycloakVersion,
         "destDirPath": tmpDirPath,
         buildOptions