keycloakify 4.7.6 → 4.8.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "keycloakify",
-    "version": "4.7.6",
+    "version": "4.8.2",
     "description": "Keycloak theme generator for Reacts app",
     "repository": {
         "type": "git",
@@ -10,6 +10,7 @@
     "types": "lib/index.d.ts",
     "bin": {
         "build-keycloak-theme": "bin/build-keycloak-theme/index.js",
+        "create-keycloak-theme-email-directory": "bin/create-keycloak-theme-email-directory.js",
         "download-builtin-keycloak-theme": "bin/download-builtin-keycloak-theme.js"
     },
     "lint-staged": {
@@ -35,14 +36,20 @@
         "src/bin/build-keycloak-theme/generateStartKeycloakTestingContainer.ts",
         "src/bin/build-keycloak-theme/index.ts",
         "src/bin/build-keycloak-theme/replaceImportFromStatic.ts",
+        "src/bin/create-keycloak-theme-email-directory.ts",
         "src/bin/download-builtin-keycloak-theme.ts",
         "src/bin/generate-i18n-messages.ts",
         "src/bin/link_in_test_app.ts",
+        "src/bin/promptKeycloakVersion.ts",
+        "src/bin/tools/NpmModuleVersion.ts",
         "src/bin/tools/crawl.ts",
+        "src/bin/tools/createOctokit.ts",
         "src/bin/tools/downloadAndUnzip.ts",
         "src/bin/tools/getProjectRoot.ts",
         "src/bin/tools/grant-exec-perms.ts",
         "src/bin/tools/isInside.ts",
+        "src/bin/tools/octokit-addons/getLatestsSemVersionedTag.ts",
+        "src/bin/tools/octokit-addons/listTags.ts",
         "src/bin/tools/rm.ts",
         "src/bin/tools/transformCodebase.ts",
         "src/lib/components/Error.tsx",
@@ -124,6 +131,9 @@
         "bin/build-keycloak-theme/replaceImportFromStatic.d.ts",
         "bin/build-keycloak-theme/replaceImportFromStatic.js",
         "bin/build-keycloak-theme/replaceImportFromStatic.js.map",
+        "bin/create-keycloak-theme-email-directory.d.ts",
+        "bin/create-keycloak-theme-email-directory.js",
+        "bin/create-keycloak-theme-email-directory.js.map",
         "bin/download-builtin-keycloak-theme.d.ts",
         "bin/download-builtin-keycloak-theme.js",
         "bin/download-builtin-keycloak-theme.js.map",
@@ -133,9 +143,18 @@
         "bin/link_in_test_app.d.ts",
         "bin/link_in_test_app.js",
         "bin/link_in_test_app.js.map",
+        "bin/promptKeycloakVersion.d.ts",
+        "bin/promptKeycloakVersion.js",
+        "bin/promptKeycloakVersion.js.map",
+        "bin/tools/NpmModuleVersion.d.ts",
+        "bin/tools/NpmModuleVersion.js",
+        "bin/tools/NpmModuleVersion.js.map",
         "bin/tools/crawl.d.ts",
         "bin/tools/crawl.js",
         "bin/tools/crawl.js.map",
+        "bin/tools/createOctokit.d.ts",
+        "bin/tools/createOctokit.js",
+        "bin/tools/createOctokit.js.map",
         "bin/tools/downloadAndUnzip.d.ts",
         "bin/tools/downloadAndUnzip.js",
         "bin/tools/downloadAndUnzip.js.map",
@@ -148,6 +167,12 @@
         "bin/tools/isInside.d.ts",
         "bin/tools/isInside.js",
         "bin/tools/isInside.js.map",
+        "bin/tools/octokit-addons/getLatestsSemVersionedTag.d.ts",
+        "bin/tools/octokit-addons/getLatestsSemVersionedTag.js",
+        "bin/tools/octokit-addons/getLatestsSemVersionedTag.js.map",
+        "bin/tools/octokit-addons/listTags.d.ts",
+        "bin/tools/octokit-addons/listTags.js",
+        "bin/tools/octokit-addons/listTags.js.map",
         "bin/tools/rm.d.ts",
         "bin/tools/rm.js",
         "bin/tools/rm.js.map",
@@ -325,7 +350,7 @@
     },
     "devDependencies": {
         "@emotion/react": "^11.4.1",
-        "@types/node": "^10.0.0",
+        "@types/node": "^17.0.25",
         "@types/react": "^17.0.0",
         "copyfiles": "^2.4.1",
         "husky": "^4.3.8",
@@ -337,14 +362,16 @@
         "typescript": "^4.2.3"
     },
     "dependencies": {
+        "@octokit/rest": "^18.12.0",
         "cheerio": "^1.0.0-rc.5",
+        "cli-select": "^1.1.2",
         "evt": "2.0.0-beta.39",
         "minimal-polyfills": "^2.2.1",
         "path-browserify": "^1.0.1",
+        "powerhooks": "^0.14.0",
         "react-markdown": "^5.0.3",
         "scripting-tools": "^0.19.13",
         "tsafe": "^0.9.0",
-        "tss-react": "^3.5.2",
-        "powerhooks": "^0.14.0"
+        "tss-react": "^3.5.2"
     }
 }

package/src/bin/build-keycloak-theme/build-keycloak-theme.ts

@@ -19,6 +19,7 @@ const doUseExternalAssets = process.argv[2]?.toLowerCase() === "--external-asset
 const parsedPackageJson: ParsedPackageJson = require(pathJoin(reactProjectDirPath, "package.json"));
 
 export const keycloakThemeBuildingDirPath = pathJoin(reactProjectDirPath, "build_keycloak");
+export const keycloakThemeEmailDirPath = pathJoin(keycloakThemeBuildingDirPath, "..", "keycloak_theme_email");
 
 function sanitizeThemeName(name: string) {
     return name
@@ -34,8 +35,9 @@ export function main() {
     const extraThemeProperties: string[] = (parsedPackageJson as any)["keycloakify"]?.["extraThemeProperties"] ?? [];
     const themeName = sanitizeThemeName(parsedPackageJson.name);
 
-    generateKeycloakThemeResources({
+    const { doBundleEmailTemplate } = generateKeycloakThemeResources({
         keycloakThemeBuildingDirPath,
+        keycloakThemeEmailDirPath,
         "reactAppBuildDirPath": pathJoin(reactProjectDirPath, "build"),
         themeName,
         ...(() => {
@@ -78,21 +80,24 @@ export function main() {
     });
 
     const { jarFilePath } = generateJavaStackFiles({
-        version: parsedPackageJson.version,
+        "version": parsedPackageJson.version,
         themeName,
-        homepage: parsedPackageJson.homepage,
+        "homepage": parsedPackageJson.homepage,
         keycloakThemeBuildingDirPath,
+        doBundleEmailTemplate,
     });
 
     child_process.execSync("mvn package", {
         "cwd": keycloakThemeBuildingDirPath,
     });
 
+    //We want, however to test in a container running the latest Keycloak version
+    const containerKeycloakVersion = "18.0.0";
+
     generateStartKeycloakTestingContainer({
         keycloakThemeBuildingDirPath,
         themeName,
-        //We want, however to test in a container running the latest Keycloak version
-        "keycloakVersion": "17.0.1",
+        "keycloakVersion": containerKeycloakVersion,
     });
 
     console.log(
@@ -129,10 +134,12 @@ export function main() {
             "      value: -Dkeycloak.profile=preview",
             "",
             "",
-            "To test your theme locally, with hot reloading, you can spin up a Keycloak container image with the theme loaded by running:",
+            `To test your theme locally you can spin up a Keycloak ${containerKeycloakVersion} container image with the theme pre loaded by running:`,
             "",
             `👉 $ ./${pathRelative(reactProjectDirPath, pathJoin(keycloakThemeBuildingDirPath, generateStartKeycloakTestingContainer.basename))} 👈`,
             "",
+            "Test with different Keycloak versions by editing the .sh file. see available versions here: https://quay.io/repository/keycloak/keycloak?tab=tags",
+            "",
             "Once your container is up and running: ",
             "- Log into the admin console 👉 http://localhost:8080/admin username: admin, password: admin 👈",
             '- Create a realm named "myrealm"',

package/src/bin/build-keycloak-theme/generateJavaStackFiles.ts

@@ -2,10 +2,16 @@ import * as url from "url";
 import * as fs from "fs";
 import { join as pathJoin, dirname as pathDirname } from "path";
 
-export function generateJavaStackFiles(params: { version: string; themeName: string; homepage?: string; keycloakThemeBuildingDirPath: string }): {
+export function generateJavaStackFiles(params: {
+    version: string;
+    themeName: string;
+    homepage?: string;
+    keycloakThemeBuildingDirPath: string;
+    doBundleEmailTemplate: boolean;
+}): {
     jarFilePath: string;
 } {
-    const { themeName, version, homepage, keycloakThemeBuildingDirPath } = params;
+    const { themeName, version, homepage, keycloakThemeBuildingDirPath, doBundleEmailTemplate } = params;
 
     {
         const { pomFileCode } = (function generatePomFileCode(): {
@@ -63,7 +69,7 @@ export function generateJavaStackFiles(params: { version: string; themeName: str
                         "themes": [
                             {
                                 "name": themeName,
-                                "types": ["login"],
+                                "types": ["login", ...(doBundleEmailTemplate ? ["email"] : [])],
                             },
                         ],
                     },

package/src/bin/build-keycloak-theme/generateKeycloakThemeResources.ts

@@ -12,17 +12,19 @@ export function generateKeycloakThemeResources(params: {
     themeName: string;
     reactAppBuildDirPath: string;
     keycloakThemeBuildingDirPath: string;
+    keycloakThemeEmailDirPath: string;
     urlPathname: string;
     //If urlOrigin is not undefined then it means --externals-assets
     urlOrigin: undefined | string;
     extraPagesId: string[];
     extraThemeProperties: string[];
     keycloakVersion: string;
-}) {
+}): { doBundleEmailTemplate: boolean } {
     const {
         themeName,
         reactAppBuildDirPath,
         keycloakThemeBuildingDirPath,
+        keycloakThemeEmailDirPath,
         urlPathname,
         urlOrigin,
         extraPagesId,
@@ -79,6 +81,28 @@ export function generateKeycloakThemeResources(params: {
         },
     });
 
+    let doBundleEmailTemplate: boolean;
+
+    email: {
+        if (!fs.existsSync(keycloakThemeEmailDirPath)) {
+            console.log(
+                [
+                    `Not bundling email template because ${pathBasename(keycloakThemeEmailDirPath)} does not exist`,
+                    `To start customizing the email template, run: 👉 npx create-keycloak-theme-email-directory 👈`,
+                ].join("\n"),
+            );
+            doBundleEmailTemplate = false;
+            break email;
+        }
+
+        doBundleEmailTemplate = true;
+
+        transformCodebase({
+            "srcDirPath": keycloakThemeEmailDirPath,
+            "destDirPath": pathJoin(themeDirPath, "..", "email"),
+        });
+    }
+
     const { generateFtlFilesCode } = generateFtlFilesCodeFactory({
         "cssGlobalsToDefine": allCssGlobalsToDefine,
         "indexHtmlCode": fs.readFileSync(pathJoin(reactAppBuildDirPath, "index.html")).toString("utf8"),
@@ -139,4 +163,6 @@ export function generateKeycloakThemeResources(params: {
         pathJoin(themeDirPath, "theme.properties"),
         Buffer.from("parent=keycloak".concat("\n\n", extraThemeProperties.join("\n\n")), "utf8"),
     );
+
+    return { doBundleEmailTemplate };
 }

package/src/bin/create-keycloak-theme-email-directory.ts

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+
+import { downloadBuiltinKeycloakTheme } from "./download-builtin-keycloak-theme";
+import { keycloakThemeEmailDirPath } from "./build-keycloak-theme";
+import { join as pathJoin, basename as pathBasename } from "path";
+import { transformCodebase } from "./tools/transformCodebase";
+import { promptKeycloakVersion } from "./promptKeycloakVersion";
+import * as fs from "fs";
+
+if (require.main === module) {
+    (async () => {
+        if (fs.existsSync(keycloakThemeEmailDirPath)) {
+            console.log(`There is already a ./${pathBasename(keycloakThemeEmailDirPath)} directory in your project. Aborting.`);
+
+            process.exit(-1);
+        }
+
+        const { keycloakVersion } = await promptKeycloakVersion();
+
+        const builtinKeycloakThemeTmpDirPath = pathJoin(keycloakThemeEmailDirPath, "..", "tmp_xIdP3_builtin_keycloak_theme");
+
+        downloadBuiltinKeycloakTheme({
+            keycloakVersion,
+            "destDirPath": builtinKeycloakThemeTmpDirPath,
+        });
+
+        transformCodebase({
+            "srcDirPath": pathJoin(builtinKeycloakThemeTmpDirPath, "base", "email"),
+            "destDirPath": keycloakThemeEmailDirPath,
+        });
+
+        console.log(`./${pathBasename(keycloakThemeEmailDirPath)} ready to be customized`);
+
+        fs.rmSync(builtinKeycloakThemeTmpDirPath, { "recursive": true, "force": true });
+    })();
+}

package/src/bin/download-builtin-keycloak-theme.ts

@@ -3,6 +3,7 @@
 import { keycloakThemeBuildingDirPath } from "./build-keycloak-theme";
 import { join as pathJoin } from "path";
 import { downloadAndUnzip } from "./tools/downloadAndUnzip";
+import { promptKeycloakVersion } from "./promptKeycloakVersion";
 
 export function downloadBuiltinKeycloakTheme(params: { keycloakVersion: string; destDirPath: string }) {
     const { keycloakVersion, destDirPath } = params;
@@ -17,22 +18,16 @@ export function downloadBuiltinKeycloakTheme(params: { keycloakVersion: string;
 }
 
 if (require.main === module) {
-    const keycloakVersion = (() => {
-        const keycloakVersion = process.argv[2] as string | undefined;
+    (async () => {
+        const { keycloakVersion } = await promptKeycloakVersion();
 
-        if (keycloakVersion === undefined) {
-            return "11.0.3";
-        }
+        const destDirPath = pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme");
 
-        return keycloakVersion;
-    })();
-
-    const destDirPath = pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme");
-
-    console.log(`Downloading builtins theme of Keycloak ${keycloakVersion} here ${destDirPath}`);
+        console.log(`Downloading builtins theme of Keycloak ${keycloakVersion} here ${destDirPath}`);
 
-    downloadBuiltinKeycloakTheme({
-        keycloakVersion,
-        destDirPath,
-    });
+        downloadBuiltinKeycloakTheme({
+            keycloakVersion,
+            destDirPath,
+        });
+    })();
 }

package/src/bin/promptKeycloakVersion.ts

@@ -0,0 +1,44 @@
+import { getLatestsSemVersionedTagFactory } from "./tools/octokit-addons/getLatestsSemVersionedTag";
+import { Octokit } from "@octokit/rest";
+import cliSelect from "cli-select";
+
+export async function promptKeycloakVersion() {
+    const { getLatestsSemVersionedTag } = (() => {
+        const { octokit } = (() => {
+            const githubToken = process.env.GITHUB_TOKEN;
+
+            const octokit = new Octokit(githubToken === undefined ? undefined : { "auth": githubToken });
+
+            return { octokit };
+        })();
+
+        const { getLatestsSemVersionedTag } = getLatestsSemVersionedTagFactory({ octokit });
+
+        return { getLatestsSemVersionedTag };
+    })();
+
+    console.log("Initialize the directory with email template from which keycloak version?");
+
+    const tags = await getLatestsSemVersionedTag({
+        "count": 15,
+        "doIgnoreBeta": true,
+        "owner": "keycloak",
+        "repo": "keycloak",
+    }).then(arr => arr.map(({ tag }) => tag));
+
+    if (process.env["GITHUB_ACTIONS"] === "true") {
+        return { "keycloakVersion": tags[0] };
+    }
+
+    const { value: keycloakVersion } = await cliSelect<string>({
+        "values": tags,
+    }).catch(() => {
+        console.log("Aborting");
+
+        process.exit(-1);
+    });
+
+    console.log(keycloakVersion);
+
+    return { keycloakVersion };
+}

package/src/bin/tools/NpmModuleVersion.ts

@@ -0,0 +1,73 @@
+export type NpmModuleVersion = {
+    major: number;
+    minor: number;
+    patch: number;
+    betaPreRelease?: number;
+};
+
+export namespace NpmModuleVersion {
+    export function parse(versionStr: string): NpmModuleVersion {
+        const match = versionStr.match(/^([0-9]+)\.([0-9]+)\.([0-9]+)(?:-beta.([0-9]+))?/);
+
+        if (!match) {
+            throw new Error(`${versionStr} is not a valid NPM version`);
+        }
+
+        return {
+            "major": parseInt(match[1]),
+            "minor": parseInt(match[2]),
+            "patch": parseInt(match[3]),
+            ...(() => {
+                const str = match[4];
+                return str === undefined ? {} : { "betaPreRelease": parseInt(str) };
+            })(),
+        };
+    }
+
+    export function stringify(v: NpmModuleVersion) {
+        return `${v.major}.${v.minor}.${v.patch}${v.betaPreRelease === undefined ? "" : `-beta.${v.betaPreRelease}`}`;
+    }
+
+    /**
+     *
+     * v1  <  v2  => -1
+     * v1 === v2  => 0
+     * v1  >  v2  => 1
+     *
+     */
+    export function compare(v1: NpmModuleVersion, v2: NpmModuleVersion): -1 | 0 | 1 {
+        const sign = (diff: number): -1 | 0 | 1 => (diff === 0 ? 0 : diff < 0 ? -1 : 1);
+        const noUndefined = (n: number | undefined) => n ?? Infinity;
+
+        for (const level of ["major", "minor", "patch", "betaPreRelease"] as const) {
+            if (noUndefined(v1[level]) !== noUndefined(v2[level])) {
+                return sign(noUndefined(v1[level]) - noUndefined(v2[level]));
+            }
+        }
+
+        return 0;
+    }
+
+    /*
+    console.log(compare(parse("3.0.0-beta.3"), parse("3.0.0")) === -1 )
+    console.log(compare(parse("3.0.0-beta.3"), parse("3.0.0-beta.4")) === -1 )
+    console.log(compare(parse("3.0.0-beta.3"), parse("4.0.0")) === -1 )
+    */
+
+    export function bumpType(params: { versionBehindStr: string; versionAheadStr: string }): "major" | "minor" | "patch" | "betaPreRelease" | "same" {
+        const versionAhead = parse(params.versionAheadStr);
+        const versionBehind = parse(params.versionBehindStr);
+
+        if (compare(versionBehind, versionAhead) === 1) {
+            throw new Error(`Version regression ${versionBehind} -> ${versionAhead}`);
+        }
+
+        for (const level of ["major", "minor", "patch", "betaPreRelease"] as const) {
+            if (versionBehind[level] !== versionAhead[level]) {
+                return level;
+            }
+        }
+
+        return "same";
+    }
+}

package/src/bin/tools/createOctokit.ts

@@ -0,0 +1,7 @@
+import { Octokit } from "@octokit/rest";
+
+export function createOctokit(params: { github_token: string }) {
+    const { github_token } = params;
+
+    return new Octokit({ ...(github_token !== "" ? { "auth": github_token } : {}) });
+}

package/src/bin/tools/octokit-addons/getLatestsSemVersionedTag.ts

@@ -0,0 +1,40 @@
+import { listTagsFactory } from "./listTags";
+import type { Octokit } from "@octokit/rest";
+import { NpmModuleVersion } from "../NpmModuleVersion";
+
+export function getLatestsSemVersionedTagFactory(params: { octokit: Octokit }) {
+    const { octokit } = params;
+
+    async function getLatestsSemVersionedTag(params: { owner: string; repo: string; doIgnoreBeta: boolean; count: number }): Promise<
+        {
+            tag: string;
+            version: NpmModuleVersion;
+        }[]
+    > {
+        const { owner, repo, doIgnoreBeta, count } = params;
+
+        const semVersionedTags: { tag: string; version: NpmModuleVersion }[] = [];
+
+        const { listTags } = listTagsFactory({ octokit });
+
+        for await (const tag of listTags({ owner, repo })) {
+            let version: NpmModuleVersion;
+
+            try {
+                version = NpmModuleVersion.parse(tag.replace(/^[vV]?/, ""));
+            } catch {
+                continue;
+            }
+
+            if (doIgnoreBeta && version.betaPreRelease !== undefined) {
+                continue;
+            }
+
+            semVersionedTags.push({ tag, version });
+        }
+
+        return semVersionedTags.sort(({ version: vX }, { version: vY }) => NpmModuleVersion.compare(vY, vX)).slice(0, count);
+    }
+
+    return { getLatestsSemVersionedTag };
+}

package/src/bin/tools/octokit-addons/listTags.ts

@@ -0,0 +1,49 @@
+import type { Octokit } from "@octokit/rest";
+
+const per_page = 99;
+
+export function listTagsFactory(params: { octokit: Octokit }) {
+    const { octokit } = params;
+
+    const octokit_repo_listTags = async (params: { owner: string; repo: string; per_page: number; page: number }) => {
+        return octokit.repos.listTags(params);
+    };
+
+    async function* listTags(params: { owner: string; repo: string }): AsyncGenerator<string> {
+        const { owner, repo } = params;
+
+        let page = 1;
+
+        while (true) {
+            const resp = await octokit_repo_listTags({
+                owner,
+                repo,
+                per_page,
+                "page": page++,
+            });
+
+            for (const branch of resp.data.map(({ name }) => name)) {
+                yield branch;
+            }
+
+            if (resp.data.length < 99) {
+                break;
+            }
+        }
+    }
+
+    /** Returns the same "latest" tag as deno.land/x, not actually the latest though */
+    async function getLatestTag(params: { owner: string; repo: string }): Promise<string | undefined> {
+        const { owner, repo } = params;
+
+        const itRes = await listTags({ owner, repo }).next();
+
+        if (itRes.done) {
+            return undefined;
+        }
+
+        return itRes.value;
+    }
+
+    return { listTags, getLatestTag };
+}