cyclops-infobook-html 5.0.0 → 5.2.0

package/index.d.ts

@@ -1,23 +1,25 @@
-export * from "./lib/infobook/appendix/IInfoBookAppendixHandler";
-export * from "./lib/infobook/appendix/InfoBookAppendixAd";
-export * from "./lib/infobook/appendix/InfoBookAppendixHandlerAbstractRecipe";
-export * from "./lib/infobook/appendix/InfoBookAppendixHandlerAdvancementRewards";
-export * from "./lib/infobook/appendix/InfoBookAppendixHandlerCraftingRecipe";
-export * from "./lib/infobook/appendix/InfoBookAppendixHandlerSmeltingRecipe";
-export * from "./lib/infobook/appendix/InfoBookAppendixHandlerImage";
-export * from "./lib/infobook/appendix/InfoBookAppendixHandlerKeybinding";
-export * from "./lib/infobook/appendix/InfoBookAppendixTagIndex";
-export * from "./lib/infobook/FileWriter";
-export * from "./lib/infobook/IFileWriter";
-export * from "./lib/infobook/IFluid";
-export * from "./lib/infobook/IInfoAppendix";
-export * from "./lib/infobook/IInfoBook";
-export * from "./lib/infobook/IInfobookPlugin";
-export * from "./lib/infobook/IInfoSection";
-export * from "./lib/infobook/IItem";
-export * from "./lib/infobook/InfoBookInitializer";
-export * from "./lib/modloader/ModLoader";
-export * from "./lib/parse/XmlInfoBookParser";
-export * from "./lib/resource/ResourceHandler";
-export * from "./lib/resource/ResourceLoader";
-export * from "./lib/serialize/HtmlInfoBookSerializer";
+export * from './lib/icon/IconsCompressor';
+export * from './lib/icon/IconsGenerator';
+export * from './lib/infobook/appendix/IInfoBookAppendixHandler';
+export * from './lib/infobook/appendix/InfoBookAppendixAd';
+export * from './lib/infobook/appendix/InfoBookAppendixHandlerAbstractRecipe';
+export * from './lib/infobook/appendix/InfoBookAppendixHandlerAdvancementRewards';
+export * from './lib/infobook/appendix/InfoBookAppendixHandlerCraftingRecipe';
+export * from './lib/infobook/appendix/InfoBookAppendixHandlerSmeltingRecipe';
+export * from './lib/infobook/appendix/InfoBookAppendixHandlerImage';
+export * from './lib/infobook/appendix/InfoBookAppendixHandlerKeybinding';
+export * from './lib/infobook/appendix/InfoBookAppendixTagIndex';
+export * from './lib/infobook/FileWriter';
+export * from './lib/infobook/IFileWriter';
+export * from './lib/infobook/IFluid';
+export * from './lib/infobook/IInfoAppendix';
+export * from './lib/infobook/IInfoBook';
+export * from './lib/infobook/IInfobookPlugin';
+export * from './lib/infobook/IInfoSection';
+export * from './lib/infobook/IItem';
+export * from './lib/infobook/InfoBookInitializer';
+export * from './lib/modloader/ModLoader';
+export * from './lib/parse/XmlInfoBookParser';
+export * from './lib/resource/ResourceHandler';
+export * from './lib/resource/ResourceLoader';
+export * from './lib/serialize/HtmlInfoBookSerializer';

package/index.js

@@ -1,27 +1,42 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./lib/infobook/appendix/IInfoBookAppendixHandler"), exports);
-tslib_1.__exportStar(require("./lib/infobook/appendix/InfoBookAppendixAd"), exports);
-tslib_1.__exportStar(require("./lib/infobook/appendix/InfoBookAppendixHandlerAbstractRecipe"), exports);
-tslib_1.__exportStar(require("./lib/infobook/appendix/InfoBookAppendixHandlerAdvancementRewards"), exports);
-tslib_1.__exportStar(require("./lib/infobook/appendix/InfoBookAppendixHandlerCraftingRecipe"), exports);
-tslib_1.__exportStar(require("./lib/infobook/appendix/InfoBookAppendixHandlerSmeltingRecipe"), exports);
-tslib_1.__exportStar(require("./lib/infobook/appendix/InfoBookAppendixHandlerImage"), exports);
-tslib_1.__exportStar(require("./lib/infobook/appendix/InfoBookAppendixHandlerKeybinding"), exports);
-tslib_1.__exportStar(require("./lib/infobook/appendix/InfoBookAppendixTagIndex"), exports);
-tslib_1.__exportStar(require("./lib/infobook/FileWriter"), exports);
-tslib_1.__exportStar(require("./lib/infobook/IFileWriter"), exports);
-tslib_1.__exportStar(require("./lib/infobook/IFluid"), exports);
-tslib_1.__exportStar(require("./lib/infobook/IInfoAppendix"), exports);
-tslib_1.__exportStar(require("./lib/infobook/IInfoBook"), exports);
-tslib_1.__exportStar(require("./lib/infobook/IInfobookPlugin"), exports);
-tslib_1.__exportStar(require("./lib/infobook/IInfoSection"), exports);
-tslib_1.__exportStar(require("./lib/infobook/IItem"), exports);
-tslib_1.__exportStar(require("./lib/infobook/InfoBookInitializer"), exports);
-tslib_1.__exportStar(require("./lib/modloader/ModLoader"), exports);
-tslib_1.__exportStar(require("./lib/parse/XmlInfoBookParser"), exports);
-tslib_1.__exportStar(require("./lib/resource/ResourceHandler"), exports);
-tslib_1.__exportStar(require("./lib/resource/ResourceLoader"), exports);
-tslib_1.__exportStar(require("./lib/serialize/HtmlInfoBookSerializer"), exports);
+__exportStar(require("./lib/icon/IconsCompressor"), exports);
+__exportStar(require("./lib/icon/IconsGenerator"), exports);
+__exportStar(require("./lib/infobook/appendix/IInfoBookAppendixHandler"), exports);
+__exportStar(require("./lib/infobook/appendix/InfoBookAppendixAd"), exports);
+__exportStar(require("./lib/infobook/appendix/InfoBookAppendixHandlerAbstractRecipe"), exports);
+__exportStar(require("./lib/infobook/appendix/InfoBookAppendixHandlerAdvancementRewards"), exports);
+__exportStar(require("./lib/infobook/appendix/InfoBookAppendixHandlerCraftingRecipe"), exports);
+__exportStar(require("./lib/infobook/appendix/InfoBookAppendixHandlerSmeltingRecipe"), exports);
+__exportStar(require("./lib/infobook/appendix/InfoBookAppendixHandlerImage"), exports);
+__exportStar(require("./lib/infobook/appendix/InfoBookAppendixHandlerKeybinding"), exports);
+__exportStar(require("./lib/infobook/appendix/InfoBookAppendixTagIndex"), exports);
+__exportStar(require("./lib/infobook/FileWriter"), exports);
+__exportStar(require("./lib/infobook/IFileWriter"), exports);
+__exportStar(require("./lib/infobook/IFluid"), exports);
+__exportStar(require("./lib/infobook/IInfoAppendix"), exports);
+__exportStar(require("./lib/infobook/IInfoBook"), exports);
+__exportStar(require("./lib/infobook/IInfobookPlugin"), exports);
+__exportStar(require("./lib/infobook/IInfoSection"), exports);
+__exportStar(require("./lib/infobook/IItem"), exports);
+__exportStar(require("./lib/infobook/InfoBookInitializer"), exports);
+__exportStar(require("./lib/modloader/ModLoader"), exports);
+__exportStar(require("./lib/parse/XmlInfoBookParser"), exports);
+__exportStar(require("./lib/resource/ResourceHandler"), exports);
+__exportStar(require("./lib/resource/ResourceLoader"), exports);
+__exportStar(require("./lib/serialize/HtmlInfoBookSerializer"), exports);
 //# sourceMappingURL=index.js.map

package/lib/icon/IconsCompressor.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Losslessly compresses PNG icon files using OptiPNG.
+ * Mimics how ImgBot compresses images: lossless PNG compression at optimization level 7
+ * with metadata stripping.
+ */
+export declare class IconsCompressor {
+    private readonly iconsDir;
+    constructor(iconsDir: string);
+    /**
+     * Compress all PNG files in the icon directory using OptiPNG.
+     */
+    compress(): Promise<void>;
+    /**
+     * Get the path to the optipng binary from optipng-bin package.
+     * Uses require.resolve to find the package root, then constructs the vendor binary path.
+     */
+    getOptipngPath(): string;
+}

package/lib/icon/IconsCompressor.js

@@ -0,0 +1,112 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IconsCompressor = void 0;
+const node_child_process_1 = require("node:child_process");
+const fs = __importStar(require("node:fs"));
+const node_path_1 = require("node:path");
+const node_util_1 = require("node:util");
+const execFileAsync = (0, node_util_1.promisify)(node_child_process_1.execFile);
+/**
+ * Losslessly compresses PNG icon files using OptiPNG.
+ * Mimics how ImgBot compresses images: lossless PNG compression at optimization level 7
+ * with metadata stripping.
+ */
+class IconsCompressor {
+    constructor(iconsDir) {
+        if (!iconsDir) {
+            throw new Error('Missing iconsDir argument');
+        }
+        this.iconsDir = iconsDir;
+    }
+    /**
+     * Compress all PNG files in the icon directory using OptiPNG.
+     */
+    compress() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const optipngPath = this.getOptipngPath();
+            if (!fs.existsSync(optipngPath)) {
+                throw new Error(`OptiPNG binary not found at: ${optipngPath}. Ensure optipng-bin is installed.`);
+            }
+            const files = yield fs.promises.readdir(this.iconsDir);
+            const pngFiles = files.filter(f => f.endsWith('.png'));
+            if (pngFiles.length === 0) {
+                process.stdout.write(`No PNG files found in ${this.iconsDir}\n`);
+                return;
+            }
+            process.stdout.write(`Compressing ${pngFiles.length} icons in ${this.iconsDir}...\n`);
+            let compressed = 0;
+            let errors = 0;
+            let totalSavedBytes = 0;
+            for (const file of pngFiles) {
+                const filePath = (0, node_path_1.join)(this.iconsDir, file);
+                const sizeBefore = fs.statSync(filePath).size;
+                try {
+                    yield execFileAsync(optipngPath, ['-o7', '-strip', 'all', '-quiet', filePath]);
+                    const sizeAfter = fs.statSync(filePath).size;
+                    totalSavedBytes += sizeBefore - sizeAfter;
+                    compressed++;
+                }
+                catch (err) {
+                    process.stderr.write(`Warning: failed to compress ${file}: ${err}\n`);
+                    errors++;
+                }
+            }
+            const savedKb = (totalSavedBytes / 1024).toFixed(1);
+            process.stdout.write(`Compressed ${compressed} icons (saved ${savedKb} KB)${errors > 0 ? `, ${errors} errors` : ''}\n`);
+        });
+    }
+    /**
+     * Get the path to the optipng binary from optipng-bin package.
+     * Uses require.resolve to find the package root, then constructs the vendor binary path.
+     */
+    getOptipngPath() {
+        const indexPath = require.resolve('optipng-bin');
+        const pkgRoot = (0, node_path_1.dirname)(indexPath);
+        const binaryName = process.platform === 'win32' ? 'optipng.exe' : 'optipng';
+        return (0, node_path_1.join)(pkgRoot, 'vendor', binaryName);
+    }
+}
+exports.IconsCompressor = IconsCompressor;
+//# sourceMappingURL=IconsCompressor.js.map

package/lib/icon/IconsGenerator.d.ts

@@ -0,0 +1,150 @@
+/**
+ * Generates icons using the IconExporter mod and HeadlessMC.
+ * This class downloads HeadlessMC and the IconExporter mod, sets up a headless
+ * Minecraft client with NeoForge and all specified mods, launches the game,
+ * runs the iconexporter export command, and copies the resulting icons.
+ */
+export declare class IconsGenerator {
+    private static readonly headlessMcJar;
+    private static readonly iconExporterJar;
+    private static readonly hmcGameSubdir;
+    private static readonly hmcConfigSubdir;
+    private static readonly iconExportSubdir;
+    private static readonly defaultIconSize;
+    private static readonly hmcSpecificsRepo;
+    private static readonly modrinthApiBase;
+    private static readonly iconExporterModrinthSlug;
+    private readonly modsDir;
+    private readonly iconsDir;
+    private readonly workDir;
+    private readonly minecraftVersion;
+    private readonly neoforgeVersion;
+    private readonly iconExporterVersion;
+    private readonly headlessMcVersion;
+    private readonly launchTimeoutMs;
+    constructor(args: IIconsGeneratorArgs);
+    /**
+     * Run the full icon generation pipeline.
+     */
+    generate(): Promise<void>;
+    /**
+     * Download the HeadlessMC launcher jar.
+     */
+    downloadHeadlessMc(): Promise<void>;
+    /**
+     * Download the IconExporter mod from Modrinth.
+     * If an explicit version is configured, fetches that specific version; otherwise fetches the
+     * latest version for the configured Minecraft version. No authentication is required.
+     */
+    downloadIconExporter(): Promise<void>;
+    /**
+     * Fetch an IconExporter release from Modrinth for the configured Minecraft version and the
+     * NeoForge loader. If a specific version number is provided, that version is matched;
+     * otherwise the latest (newest) version is returned.
+     * Returns the primary file's download URL and filename.
+     */
+    fetchIconExporterFromModrinth(version?: string): Promise<{
+        url: string;
+        filename: string;
+    }>;
+    /**
+     * Set up the game directory with mods and options.
+     */
+    setupGameDirectory(): Promise<void>;
+    /**
+     * Write the HeadlessMC configuration file.
+     */
+    writeHmcConfig(): void;
+    /**
+     * Run the Minecraft client using HeadlessMC and export icons.
+     */
+    runGameAndExportIcons(): Promise<void>;
+    /**
+     * Copy exported icons to the output icons directory.
+     */
+    copyIcons(): Promise<void>;
+    /**
+     * Parse the HeadlessMC `gui` command output and find the numeric button ID for a given
+     * button text label. HeadlessMC's `click` command requires a numeric id, not the text.
+     * The gui table format is:
+     *   id   text                    x    y    w    h    on   type
+     *   0    Multiplayer             140  123  200  20   1    Button
+     *   1    Singleplayer            140  99   200  20   1    Button
+     * Columns are separated by two or more spaces.
+     */
+    findButtonIdByText(guiOutput: string, buttonText: string): number | null;
+    /**
+     * Determine if the Minecraft game has fully loaded based on log output.
+     */
+    isGameFullyLoaded(output: string): boolean;
+    /**
+     * Determine if the HeadlessMC launcher is ready to accept commands based on its startup output.
+     * In non-TTY mode HeadlessMC does not print a '>' prompt, so we detect readiness from the
+     * version-table header or the DefaultCommandLineProvider warning it prints on startup.
+     */
+    isHeadlessMcReady(output: string): boolean;
+    /**
+     * Download the hmc-specifics mod from GitHub Releases into the given mods directory.
+     * This avoids relying on HeadlessMC's built-in `-specifics` auto-download which checks
+     * the GitHub API without authentication and can hit rate limits.
+     */
+    downloadHmcSpecifics(modsDir: string): Promise<void>;
+    /**
+     * Download a file from a URL to a destination path.
+     */
+    downloadFile(url: string, destPath: string, headers?: Record<string, string>): Promise<void>;
+}
+export type IGameState = 'waiting_for_prompt' | 'game_launching' | 'checking_screen' | 'navigating_singleplayer' | 'creating_world' | 'exporting_icons' | 'quitting';
+export interface IModrinthVersionFile {
+    url: string;
+    filename: string;
+    primary: boolean;
+}
+export interface IModrinthVersion {
+    version_number: string;
+    files: IModrinthVersionFile[];
+}
+export interface IGithubAsset {
+    name: string;
+    browser_download_url: string;
+}
+export interface IGithubRelease {
+    assets: IGithubAsset[];
+    tag_name: string;
+}
+export interface IIconsGeneratorArgs {
+    /**
+     * Directory containing mod JARs to include in the client (usually server/mods).
+     */
+    modsDir: string;
+    /**
+     * Directory where icons will be written.
+     */
+    iconsDir: string;
+    /**
+     * Working directory for HeadlessMC and game files.
+     */
+    workDir: string;
+    /**
+     * Minecraft version (e.g., "1.21.1").
+     */
+    minecraftVersion: string;
+    /**
+     * NeoForge version (e.g., "21.1.210").
+     */
+    neoforgeVersion: string;
+    /**
+     * Version of the IconExporter artifact to pin (e.g., "1.4.0-174").
+     * If not provided, the latest version for the configured Minecraft version is
+     * automatically fetched from Modrinth (no authentication required).
+     */
+    iconExporterVersion?: string;
+    /**
+     * Version of HeadlessMC to download (e.g., "2.8.0").
+     */
+    headlessMcVersion?: string;
+    /**
+     * Timeout in milliseconds for the full game launch and icon export (default: 30 minutes).
+     */
+    launchTimeoutMs?: number;
+}