keycloakify 10.0.0-rc.118 → 10.0.0-rc.119

package/src/bin/shared/getLatestsSemVersionedTag.ts

@@ -0,0 +1,180 @@
+import { getLatestsSemVersionedTagFactory } from "../tools/octokit-addons/getLatestsSemVersionedTag";
+import { Octokit } from "@octokit/rest";
+import type { ReturnType } from "tsafe";
+import type { Param0 } from "tsafe";
+import { join as pathJoin, dirname as pathDirname } from "path";
+import * as fs from "fs";
+import { z } from "zod";
+import { assert, type Equals } from "tsafe/assert";
+import { id } from "tsafe/id";
+import type { SemVer } from "../tools/SemVer";
+import { same } from "evt/tools/inDepth/same";
+
+type GetLatestsSemVersionedTag = ReturnType<
+    typeof getLatestsSemVersionedTagFactory
+>["getLatestsSemVersionedTag"];
+
+type Params = Param0<GetLatestsSemVersionedTag>;
+type R = ReturnType<GetLatestsSemVersionedTag>;
+
+let getLatestsSemVersionedTag_stateless: GetLatestsSemVersionedTag | undefined =
+    undefined;
+
+const CACHE_VERSION = 1;
+
+type Cache = {
+    version: typeof CACHE_VERSION;
+    entries: {
+        time: number;
+        params: Params;
+        result: R;
+    }[];
+};
+
+export async function getLatestsSemVersionedTag({
+    cacheDirPath,
+    ...params
+}: Params & { cacheDirPath: string }): Promise<R> {
+    const cacheFilePath = pathJoin(cacheDirPath, "latest-sem-versioned-tags.json");
+
+    const cacheLookupResult = (() => {
+        const getResult_currentCache = (currentCacheEntries: Cache["entries"]) => ({
+            hasCachedResult: false as const,
+            currentCache: {
+                version: CACHE_VERSION,
+                entries: currentCacheEntries
+            }
+        });
+
+        if (!fs.existsSync(cacheFilePath)) {
+            return getResult_currentCache([]);
+        }
+
+        let cache_json;
+
+        try {
+            cache_json = fs.readFileSync(cacheFilePath).toString("utf8");
+        } catch {
+            return getResult_currentCache([]);
+        }
+
+        let cache_json_parsed: unknown;
+
+        try {
+            cache_json_parsed = JSON.parse(cache_json);
+        } catch {
+            return getResult_currentCache([]);
+        }
+
+        const zSemVer = (() => {
+            type TargetType = SemVer;
+
+            const zTargetType = z.object({
+                major: z.number(),
+                minor: z.number(),
+                patch: z.number(),
+                rc: z.number().optional(),
+                parsedFrom: z.string()
+            });
+
+            assert<Equals<z.infer<typeof zTargetType>, TargetType>>();
+
+            return id<z.ZodType<TargetType>>(zTargetType);
+        })();
+
+        const zCache = (() => {
+            type TargetType = Cache;
+
+            const zTargetType = z.object({
+                version: z.literal(CACHE_VERSION),
+                entries: z.array(
+                    z.object({
+                        time: z.number(),
+                        params: z.object({
+                            owner: z.string(),
+                            repo: z.string(),
+                            count: z.number(),
+                            doIgnoreReleaseCandidates: z.boolean()
+                        }),
+                        result: z.array(
+                            z.object({
+                                tag: z.string(),
+                                version: zSemVer
+                            })
+                        )
+                    })
+                )
+            });
+
+            assert<Equals<z.infer<typeof zTargetType>, TargetType>>();
+
+            return id<z.ZodType<TargetType>>(zTargetType);
+        })();
+
+        let cache: Cache;
+
+        try {
+            cache = zCache.parse(cache_json_parsed);
+        } catch {
+            return getResult_currentCache([]);
+        }
+
+        const cacheEntry = cache.entries.find(e => same(e.params, params));
+
+        if (cacheEntry === undefined) {
+            return getResult_currentCache(cache.entries);
+        }
+
+        if (Date.now() - cacheEntry.time > 3_600_000) {
+            return getResult_currentCache(cache.entries.filter(e => e !== cacheEntry));
+        }
+        return {
+            hasCachedResult: true as const,
+            cachedResult: cacheEntry.result
+        };
+    })();
+
+    if (cacheLookupResult.hasCachedResult) {
+        return cacheLookupResult.cachedResult;
+    }
+
+    const { currentCache } = cacheLookupResult;
+
+    getLatestsSemVersionedTag_stateless ??= (() => {
+        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;
+    })();
+
+    const result = await getLatestsSemVersionedTag_stateless(params);
+
+    currentCache.entries.push({
+        time: Date.now(),
+        params,
+        result
+    });
+
+    {
+        const dirPath = pathDirname(cacheFilePath);
+
+        if (!fs.existsSync(dirPath)) {
+            fs.mkdirSync(dirPath, { recursive: true });
+        }
+    }
+
+    fs.writeFileSync(cacheFilePath, JSON.stringify(currentCache, null, 2));
+
+    return result;
+}

package/src/bin/shared/promptKeycloakVersion.ts

@@ -1,11 +1,6 @@
-import { getLatestsSemVersionedTagFactory } from "../tools/octokit-addons/getLatestsSemVersionedTag";
-import { Octokit } from "@octokit/rest";
+import { getLatestsSemVersionedTag } from "./getLatestsSemVersionedTag";
 import cliSelect from "cli-select";
 import { SemVer } from "../tools/SemVer";
-import { join as pathJoin, dirname as pathDirname } from "path";
-import * as fs from "fs";
-import type { ReturnType } from "tsafe";
-import { id } from "tsafe/id";
 
 export async function promptKeycloakVersion(params: {
     startingFromMajor: number | undefined;
@@ -14,79 +9,15 @@ export async function promptKeycloakVersion(params: {
 }) {
     const { startingFromMajor, excludeMajorVersions, cacheDirPath } = params;
 
-    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 };
-    })();
-
     const semVersionedTagByMajor = new Map<number, { tag: string; version: SemVer }>();
 
-    const semVersionedTags = await (async () => {
-        const cacheFilePath = pathJoin(cacheDirPath, "keycloak-versions.json");
-
-        type Cache = {
-            time: number;
-            semVersionedTags: ReturnType<typeof getLatestsSemVersionedTag>;
-        };
-
-        use_cache: {
-            if (!fs.existsSync(cacheFilePath)) {
-                break use_cache;
-            }
-
-            const cache: Cache = JSON.parse(
-                fs.readFileSync(cacheFilePath).toString("utf8")
-            );
-
-            if (Date.now() - cache.time > 3_600_000) {
-                fs.unlinkSync(cacheFilePath);
-                break use_cache;
-            }
-
-            return cache.semVersionedTags;
-        }
-
-        const semVersionedTags = await getLatestsSemVersionedTag({
-            count: 50,
-            owner: "keycloak",
-            repo: "keycloak"
-        });
-
-        {
-            const dirPath = pathDirname(cacheFilePath);
-
-            if (!fs.existsSync(dirPath)) {
-                fs.mkdirSync(dirPath, { recursive: true });
-            }
-        }
-
-        fs.writeFileSync(
-            cacheFilePath,
-            JSON.stringify(
-                id<Cache>({
-                    time: Date.now(),
-                    semVersionedTags
-                }),
-                null,
-                2
-            )
-        );
-
-        return semVersionedTags;
-    })();
+    const semVersionedTags = await getLatestsSemVersionedTag({
+        cacheDirPath,
+        count: 50,
+        owner: "keycloak",
+        repo: "keycloak",
+        doIgnoreReleaseCandidates: true
+    });
 
     semVersionedTags.forEach(semVersionedTag => {
         if (

package/src/bin/start-keycloak/appBuild.ts

@@ -5,12 +5,15 @@ import type { BuildContext } from "../shared/buildContext";
 import chalk from "chalk";
 import { sep as pathSep, join as pathJoin } from "path";
 import { getAbsoluteAndInOsFormatPath } from "../tools/getAbsoluteAndInOsFormatPath";
+import * as fs from "fs";
+import { dirname as pathDirname, relative as pathRelative } from "path";
 
 export type BuildContextLike = {
     projectDirPath: string;
     keycloakifyBuildDirPath: string;
     bundler: BuildContext["bundler"];
     projectBuildDirPath: string;
+    packageJsonFilePath: string;
 };
 
 assert<BuildContext extends BuildContextLike ? true : false>();
@@ -20,7 +23,7 @@ export async function appBuild(params: {
 }): Promise<{ isAppBuildSuccess: boolean }> {
     const { buildContext } = params;
 
-    switch (buildContext.bundler.type) {
+    switch (buildContext.bundler) {
         case "vite":
             return appBuild_vite({ buildContext });
         case "webpack":
@@ -33,7 +36,7 @@ async function appBuild_vite(params: {
 }): Promise<{ isAppBuildSuccess: boolean }> {
     const { buildContext } = params;
 
-    assert(buildContext.bundler.type === "vite");
+    assert(buildContext.bundler === "vite");
 
     const dIsSuccess = new Deferred<boolean>();
 
@@ -66,17 +69,18 @@ async function appBuild_webpack(params: {
 }): Promise<{ isAppBuildSuccess: boolean }> {
     const { buildContext } = params;
 
-    assert(buildContext.bundler.type === "webpack");
+    assert(buildContext.bundler === "webpack");
 
-    const entries = Object.entries(buildContext.bundler.packageJsonScripts).filter(
-        ([, scriptCommand]) => scriptCommand.includes("keycloakify build")
-    );
+    const entries = Object.entries(
+        (JSON.parse(fs.readFileSync(buildContext.packageJsonFilePath).toString("utf8"))
+            .scripts ?? {}) as Record<string, string>
+    ).filter(([, scriptCommand]) => scriptCommand.includes("keycloakify build"));
 
     if (entries.length === 0) {
         console.log(
             chalk.red(
                 [
-                    `You should have a script in your package.json at ${buildContext.bundler.packageJsonDirPath}`,
+                    `You should have a script in your package.json at ${pathRelative(process.cwd(), pathDirname(buildContext.packageJsonFilePath))}`,
                     `that includes the 'keycloakify build' command`
                 ].join(" ")
             )
@@ -123,7 +127,7 @@ async function appBuild_webpack(params: {
         process.exit(-1);
     }
 
-    let commandCwd = buildContext.bundler.packageJsonDirPath;
+    let commandCwd = pathDirname(buildContext.packageJsonFilePath);
 
     for (const subCommand of appBuildSubCommands) {
         const dIsSuccess = new Deferred<boolean>();
@@ -152,7 +156,7 @@ async function appBuild_webpack(params: {
 
                     return [
                         pathJoin(
-                            buildContext.bundler.packageJsonDirPath,
+                            pathDirname(buildContext.packageJsonFilePath),
                             "node_modules",
                             ".bin"
                         ),

package/src/bin/tools/downloadAndExtractArchive.ts

@@ -63,7 +63,7 @@ export async function downloadAndExtractArchive(params: {
         });
     }
 
-    const extractDirBasename = `${archiveFileBasename.split(".")[0]}_${uniqueIdOfOnArchiveFile}_${crypto
+    const extractDirBasename = `${archiveFileBasename.replace(/\.([^.]+)$/, (...[, ext]) => `_${ext}`)}_${uniqueIdOfOnArchiveFile}_${crypto
         .createHash("sha256")
         .update(onArchiveFile.toString())
         .digest("hex")
@@ -85,7 +85,9 @@ export async function downloadAndExtractArchive(params: {
                 })()
             )
             .map(async extractDirBasename => {
-                await rm(pathJoin(cacheDirPath, extractDirBasename), { recursive: true });
+                await rm(pathJoin(cacheDirPath, extractDirBasename), {
+                    recursive: true
+                });
                 await SuccessTracker.removeFromExtracted({
                     cacheDirPath,
                     extractDirBasename

package/src/bin/tools/npmInstall.ts

@@ -0,0 +1,63 @@
+import * as fs from "fs";
+import { join as pathJoin } from "path";
+import * as child_process from "child_process";
+import chalk from "chalk";
+
+export function npmInstall(params: { packageJsonDirPath: string }) {
+    const { packageJsonDirPath } = params;
+
+    const packageManagerBinName = (() => {
+        const packageMangers = [
+            {
+                binName: "yarn",
+                lockFileBasename: "yarn.lock"
+            },
+            {
+                binName: "npm",
+                lockFileBasename: "package-lock.json"
+            },
+            {
+                binName: "pnpm",
+                lockFileBasename: "pnpm-lock.yaml"
+            },
+            {
+                binName: "bun",
+                lockFileBasename: "bun.lockdb"
+            }
+        ] as const;
+
+        for (const packageManager of packageMangers) {
+            if (
+                fs.existsSync(
+                    pathJoin(packageJsonDirPath, packageManager.lockFileBasename)
+                ) ||
+                fs.existsSync(pathJoin(process.cwd(), packageManager.lockFileBasename))
+            ) {
+                return packageManager.binName;
+            }
+        }
+
+        return undefined;
+    })();
+
+    install_dependencies: {
+        if (packageManagerBinName === undefined) {
+            break install_dependencies;
+        }
+
+        console.log(`Installing the new dependencies...`);
+
+        try {
+            child_process.execSync(`${packageManagerBinName} install`, {
+                cwd: packageJsonDirPath,
+                stdio: "inherit"
+            });
+        } catch {
+            console.log(
+                chalk.yellow(
+                    `\`${packageManagerBinName} install\` failed, continuing anyway...`
+                )
+            );
+        }
+    }
+}

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

@@ -9,13 +9,14 @@ export function getLatestsSemVersionedTagFactory(params: { octokit: Octokit }) {
         owner: string;
         repo: string;
         count: number;
+        doIgnoreReleaseCandidates: boolean;
     }): Promise<
         {
             tag: string;
             version: SemVer;
         }[]
     > {
-        const { owner, repo, count } = params;
+        const { owner, repo, count, doIgnoreReleaseCandidates } = params;
 
         const semVersionedTags: { tag: string; version: SemVer }[] = [];
 
@@ -30,7 +31,7 @@ export function getLatestsSemVersionedTagFactory(params: { octokit: Octokit }) {
                 continue;
             }
 
-            if (version.rc !== undefined) {
+            if (doIgnoreReleaseCandidates && version.rc !== undefined) {
                 continue;
             }
 

package/src/bin/tsconfig.json

@@ -8,5 +8,7 @@
         "moduleResolution": "node",
         "outDir": "../../dist/bin",
         "rootDir": "."
-    }
+    },
+    "include": ["**/*.ts", "**/*.tsx"],
+    "exclude": ["initialize-account-theme/src"]
 }

package/src/vite-plugin/vite-plugin.ts

@@ -18,12 +18,14 @@ import {
 import MagicString from "magic-string";
 import { generateKcGenTs } from "../bin/shared/generateKcGenTs";
 
-export type Params = BuildOptions & {
-    postBuild?: (buildContext: Omit<BuildContext, "bundler">) => Promise<void>;
-};
+export namespace keycloakify {
+    export type Params = BuildOptions & {
+        postBuild?: (buildContext: Omit<BuildContext, "bundler">) => Promise<void>;
+    };
+}
 
-export function keycloakify(params?: Params) {
-    const { postBuild, ...buildOptions } = params ?? {};
+export function keycloakify(params: keycloakify.Params) {
+    const { postBuild, ...buildOptions } = params;
 
     let projectDirPath: string | undefined = undefined;
     let urlPathname: string | undefined = undefined;