cyclops-infobook-html 5.1.0 → 5.2.1

package/lib/parse/XmlInfoBookParser.d.ts

@@ -1,7 +1,7 @@
-import { IInfoBookAppendixHandler } from "../infobook/appendix/IInfoBookAppendixHandler";
-import { IInfoAppendix } from "../infobook/IInfoAppendix";
-import { IInfoBook } from "../infobook/IInfoBook";
-import { IInfoSection } from "../infobook/IInfoSection";
+import type { IInfoBookAppendixHandler } from '../infobook/appendix/IInfoBookAppendixHandler';
+import type { IInfoAppendix } from '../infobook/IInfoAppendix';
+import type { IInfoBook } from '../infobook/IInfoBook';
+import type { IInfoSection } from '../infobook/IInfoSection';
 /**
  * Parses an XML file into an {@link IInfoBook}.
  */
@@ -34,9 +34,7 @@ export declare class XmlInfoBookParser {
      * @param {string} modId The owning mod.
      * @returns {IInfoSection} A section.
      */
-    jsonToSection(data: any, sections: {
-        [id: string]: IInfoSection;
-    }, modId: string): IInfoSection;
+    jsonToSection(data: any, sections: Record<string, IInfoSection>, modId: string): IInfoSection;
     /**
      * Convert a data object to a paragraph.
      * @param data A data object.

package/lib/parse/XmlInfoBookParser.js

@@ -1,7 +1,40 @@
 "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;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.XmlInfoBookParser = void 0;
-const fs = require("fs");
+const fs = __importStar(require("node:fs"));
 const xml2js_1 = require("xml2js");
 /**
  * Parses an XML file into an {@link IInfoBook}.
@@ -29,7 +62,7 @@ class XmlInfoBookParser {
      */
     parse(path, modId) {
         return new Promise((resolve, reject) => {
-            (0, xml2js_1.parseString)(fs.readFileSync(path), (error, data) => {
+            (0, xml2js_1.parseString)(fs.readFileSync(path, 'utf8'), (error, data) => {
                 if (error) {
                     return reject(error);
                 }
@@ -58,14 +91,15 @@ class XmlInfoBookParser {
      * @returns {IInfoSection} A section.
      */
     jsonToSection(data, sections, modId) {
-        // tslint:disable:object-literal-sort-keys
         const section = {
             nameTranslationKey: data.$.name,
             subSections: (data.section || []).map((subData) => this.jsonToSection(subData, sections, modId)),
             paragraphTranslationKeys: (data.paragraph || []).map((subData) => this.jsonToParagraph(subData)),
-            appendix: ((data.appendix || []).concat(data.appendix_list || []))
-                .map((subData) => this.jsonToAppendix(subData, modId)),
-            tags: (data.tag ? data.tag.filter((entry) => typeof entry === 'string') : undefined) || [],
+            appendix: [
+                ...(data.appendix || []),
+                ...(data.appendix_list || []),
+            ].map((subData) => this.jsonToAppendix(subData, modId)),
+            tags: (data.tag ? data.tag.filter((entry) => typeof entry === 'string') : []),
             modId,
         };
         sections[section.nameTranslationKey] = section;
@@ -89,13 +123,12 @@ class XmlInfoBookParser {
         if (!data.$ || (!data.$.type && !data.$.factory)) {
             throw new Error(`No type or factory was found for the appendix ${JSON.stringify(data)}.`);
         }
-        const type = data.$.type || data.$.factory;
+        const type = (data.$.type || data.$.factory);
         const handler = this.appendixHandlers[type];
         if (handler) {
             return handler.createAppendix(data, modId);
         }
-        // tslint:disable-next-line:no-console
-        console.error(`Could not find an appendix handler for type '${type}'`);
+        process.stderr.write(`Could not find an appendix handler for type '${type}'\n`);
         return null;
     }
 }

package/lib/resource/ResourceHandler.d.ts

@@ -1,10 +1,10 @@
-import { IFluid } from "../infobook/IFluid";
-import { IItem } from "../infobook/IItem";
+import type { IFluid } from '../infobook/IFluid';
+import type { IItem } from '../infobook/IItem';
 /**
  * Allows Minecraft resources to be used.
  */
 export declare class ResourceHandler {
-    private static readonly TRANSLATION_DEFAULTS;
+    private static readonly translationDefaults;
     private readonly translations;
     private readonly languages;
     private readonly resourcePackBasePaths;
@@ -25,6 +25,7 @@ export declare class ResourceHandler {
     };
     /**
      * Add an entry to a {@llink IItemKeyedRegistry}.
+     * @param {IItemKeyedRegistry} registry The registry.
      * @param {string} namespace The namespace.
      * @param {string} path The path.
      * @param {string} nbt The NBT. (empty string represents no NBT)
@@ -33,6 +34,7 @@ export declare class ResourceHandler {
     protected static addItemKeyedRegistryEntry(registry: IItemKeyedRegistry, namespace: string, path: string, nbt: string, value: string): void;
     /**
      * Get an value from a {@llink IItemKeyedRegistry}.
+     * @param {IItemKeyedRegistry} registry The registry.
      * @param {string} namespace The namespace.
      * @param {string} path The path.
      * @param {string} nbt The NBT. (empty string represents no NBT)
@@ -48,9 +50,7 @@ export declare class ResourceHandler {
      * @param {string} language A language key.
      * @param {{[p: string]: string}} translations A mapping from translation key to translated value.
      */
-    addTranslations(language: string, translations: {
-        [key: string]: string;
-    }, excludedModLanguage: boolean): void;
+    addTranslations(language: string, translations: Record<string, string>, excludedModLanguage: boolean): void;
     /**
      * Get the translation for the given key.
      * @param {string} translationKey A translation key.
@@ -146,13 +146,7 @@ export declare class ResourceHandler {
      */
     getKeybinding(id: string): string;
 }
-export interface IItemKeyedRegistry {
-    [namespace: string]: {
-        [path: string]: {
-            [nbt: string]: string;
-        };
-    };
-}
+export type IItemKeyedRegistry = Record<string, Record<string, Record<string, string>>>;
 export interface IAdvancement {
     itemIcon: IItem;
     title: string;

package/lib/resource/ResourceHandler.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ResourceHandler = void 0;
-const path_1 = require("path");
+const node_path_1 = require("node:path");
 /**
  * Allows Minecraft resources to be used.
  */
@@ -30,6 +30,7 @@ class ResourceHandler {
     }
     /**
      * Add an entry to a {@llink IItemKeyedRegistry}.
+     * @param {IItemKeyedRegistry} registry The registry.
      * @param {string} namespace The namespace.
      * @param {string} path The path.
      * @param {string} nbt The NBT. (empty string represents no NBT)
@@ -48,6 +49,7 @@ class ResourceHandler {
     }
     /**
      * Get an value from a {@llink IItemKeyedRegistry}.
+     * @param {IItemKeyedRegistry} registry The registry.
      * @param {string} namespace The namespace.
      * @param {string} path The path.
      * @param {string} nbt The NBT. (empty string represents no NBT)
@@ -64,7 +66,8 @@ class ResourceHandler {
         }
         let file = nbts[nbt];
         if (!file) {
-            file = nbts[Object.keys(nbts)[0]]; // Take the first NBT-tagged item if none without NBT could be found
+            // Take the first NBT-tagged item if none without NBT could be found
+            file = nbts[Object.keys(nbts)[0]];
         }
         return file;
     }
@@ -82,14 +85,14 @@ class ResourceHandler {
     addTranslations(language, translations, excludedModLanguage) {
         language = language.toLowerCase();
         const existingTranslations = this.translations[language];
-        if (!existingTranslations) {
-            this.translations[language] = translations;
-        }
-        else {
+        if (existingTranslations) {
             for (const key in translations) {
                 existingTranslations[key] = translations[key];
             }
         }
+        else {
+            this.translations[language] = translations;
+        }
         if (!excludedModLanguage && Object.keys(translations).length > 0) {
             this.languages[language] = true;
         }
@@ -104,7 +107,7 @@ class ResourceHandler {
         const entries = this.translations[languageKey] || this.translations.en_us;
         let value = entries[translationKey];
         if (!value) {
-            value = this.translations.en_us[translationKey] || ResourceHandler.TRANSLATION_DEFAULTS[translationKey];
+            value = this.translations.en_us[translationKey] || ResourceHandler.translationDefaults[translationKey];
             if (!value) {
                 throw new Error(`Could not find translation key ${translationKey} in ${languageKey}`);
             }
@@ -132,13 +135,13 @@ class ResourceHandler {
         if (separator < 0) {
             throw new Error(`Invalid resource key for expansion: ${resourceKey}`);
         }
-        const resourcePackId = resourceKey.substr(0, separator);
+        const resourcePackId = resourceKey.slice(0, Math.max(0, separator));
         const basePath = this.resourcePackBasePaths[resourcePackId];
         if (!basePath) {
             throw new Error(`Failed to expand unknown resource pack id for resource path: ${resourceKey}`);
         }
-        const suffix = resourceKey.substr(separator + 1);
-        return (0, path_1.join)(basePath, suffix);
+        const suffix = resourceKey.slice(separator + 1);
+        return (0, node_path_1.join)(basePath, suffix);
     }
     /**
      * Add an item icon file.
@@ -258,8 +261,10 @@ class ResourceHandler {
     }
 }
 exports.ResourceHandler = ResourceHandler;
-ResourceHandler.TRANSLATION_DEFAULTS = {
+ResourceHandler.translationDefaults = {
+    // eslint-disable-next-line ts/naming-convention
     'fluid.tile.lava': 'Lava',
+    // eslint-disable-next-line ts/naming-convention
     'fluid.tile.water': 'Water',
 };
 //# sourceMappingURL=ResourceHandler.js.map

package/lib/resource/ResourceLoader.d.ts

@@ -1,4 +1,4 @@
-import { ResourceHandler } from "./ResourceHandler";
+import { ResourceHandler } from './ResourceHandler';
 /**
  * Loads Minecraft resources in-memory.
  */
@@ -30,7 +30,8 @@ export declare class ResourceLoader {
     /**
      * Load all resources within the given paths.
      * @param {string} baseDir A base directory.
-     * @param {string[]} paths An array of paths to traverse to look for resources.
+     * @param {string} path A path.
+     * @param {string[]} excludedModLanguages Excluded mod languages.
      * @returns {Promise<void>} A promise resolving when loading is done.
      */
     loadAll(baseDir: string, path: string, excludedModLanguages: string[]): Promise<void>;
@@ -83,7 +84,5 @@ export declare class ResourceLoader {
      * Load the given keybindings.
      * @param {{[p: string]: string}} keybindings Keybindings.
      */
-    loadKeybindings(keybindings: {
-        [key: string]: string;
-    }): void;
+    loadKeybindings(keybindings: Record<string, string>): void;
 }

package/lib/resource/ResourceLoader.js

@@ -10,8 +10,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ResourceLoader = void 0;
-const fs_1 = require("fs");
-const path_1 = require("path");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
 const ResourceHandler_1 = require("./ResourceHandler");
 /**
  * Loads Minecraft resources in-memory.
@@ -33,23 +33,23 @@ class ResourceLoader {
      */
     loadIcons(iconsPath) {
         return __awaiter(this, void 0, void 0, function* () {
-            const iconNames = yield fs_1.promises.readdir(iconsPath);
+            const iconNames = yield node_fs_1.promises.readdir(iconsPath);
             for (const iconName of iconNames) {
-                const iconFile = (0, path_1.join)(iconsPath, iconName);
+                const iconFile = (0, node_path_1.join)(iconsPath, iconName);
                 if (iconName.startsWith('fluid__')) {
-                    this.resourceHandler.addFluidIcon(iconName.substring(7, iconName.length - 4), iconFile);
+                    this.resourceHandler.addFluidIcon(iconName.slice(7, -4), iconFile);
                 }
                 else {
-                    const split = iconName.split("__");
+                    const split = iconName.split('__');
                     const namespace = split[0];
                     let path = split[1];
                     let nbt = '';
                     if (split.length > 2) {
-                        nbt = split.slice(2, split.length).join(":");
-                        nbt = nbt.substr(0, nbt.length - 4);
+                        nbt = split.slice(2, split.length).join(':');
+                        nbt = nbt.slice(0, Math.max(0, nbt.length - 4));
                     }
                     else {
-                        path = path.substr(0, path.length - 4);
+                        path = path.slice(0, Math.max(0, path.length - 4));
                     }
                     this.resourceHandler.addItemIcon(namespace, path, nbt, iconFile);
                 }
@@ -63,7 +63,7 @@ class ResourceLoader {
      */
     loadItemTranslationKeys(registriesPath) {
         return __awaiter(this, void 0, void 0, function* () {
-            const registry = JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(registriesPath, 'item_translation_keys.json'), "utf8"));
+            const registry = JSON.parse((0, node_fs_1.readFileSync)((0, node_path_1.join)(registriesPath, 'item_translation_keys.json'), 'utf8'));
             for (const entry of registry.items) {
                 this.resourceHandler.addItemTranslationKey(entry.item, entry.translationKey);
             }
@@ -76,7 +76,7 @@ class ResourceLoader {
      */
     loadFluidTranslationKeys(registriesPath) {
         return __awaiter(this, void 0, void 0, function* () {
-            const registry = JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(registriesPath, 'fluid_translation_keys.json'), "utf8"));
+            const registry = JSON.parse((0, node_fs_1.readFileSync)((0, node_path_1.join)(registriesPath, 'fluid_translation_keys.json'), 'utf8'));
             for (const entry of registry.fluids) {
                 this.resourceHandler.addFluidTranslationKey(entry.fluid, entry.translationKey);
             }
@@ -85,12 +85,13 @@ class ResourceLoader {
     /**
      * Load all resources within the given paths.
      * @param {string} baseDir A base directory.
-     * @param {string[]} paths An array of paths to traverse to look for resources.
+     * @param {string} path A path.
+     * @param {string[]} excludedModLanguages Excluded mod languages.
      * @returns {Promise<void>} A promise resolving when loading is done.
      */
     loadAll(baseDir, path, excludedModLanguages) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.load((0, path_1.join)(baseDir, path), excludedModLanguages);
+            yield this.load((0, node_path_1.join)(baseDir, path), excludedModLanguages);
         });
     }
     /**
@@ -103,12 +104,12 @@ class ResourceLoader {
      */
     load(fullPath, excludedModLanguages) {
         return __awaiter(this, void 0, void 0, function* () {
-            const entries = yield fs_1.promises.readdir(fullPath);
+            const entries = yield node_fs_1.promises.readdir(fullPath);
             // Look for a valid pack
             for (const modid of entries) {
                 const excludedModLanguage = excludedModLanguages.includes(modid);
-                const modPath = (0, path_1.join)(fullPath, modid);
-                if ((yield fs_1.promises.stat(modPath)).isDirectory()) {
+                const modPath = (0, node_path_1.join)(fullPath, modid);
+                if ((yield node_fs_1.promises.stat(modPath)).isDirectory()) {
                     yield this.loadAssets(modid, modPath, excludedModLanguage);
                 }
             }
@@ -125,23 +126,23 @@ class ResourceLoader {
             // Set base path
             this.resourceHandler.setResourcePackBasePath(modid, fullPath);
             // Handle languages
-            const langDir = (0, path_1.join)(fullPath, 'lang');
+            const langDir = (0, node_path_1.join)(fullPath, 'lang');
             try {
-                if ((yield fs_1.promises.stat(langDir)).isDirectory()) {
+                if ((yield node_fs_1.promises.stat(langDir)).isDirectory()) {
                     yield this.loadAssetsLang(modid, langDir, excludedModLanguage);
                 }
             }
-            catch (e) {
+            catch (_a) {
                 // Ignore mods without language files
             }
             // Handle advancements
-            const advancementsDir = (0, path_1.join)(fullPath, 'advancement');
+            const advancementsDir = (0, node_path_1.join)(fullPath, 'advancement');
             try {
-                if ((yield fs_1.promises.stat(langDir)).isDirectory()) {
+                if ((yield node_fs_1.promises.stat(langDir)).isDirectory()) {
                     yield this.loadAssetsAdvancements(modid, advancementsDir, '');
                 }
             }
-            catch (e) {
+            catch (_b) {
                 // Ignore mods without advancements
             }
         });
@@ -154,10 +155,10 @@ class ResourceLoader {
      */
     loadAssetsLang(modid, langDir, excludedModLanguage) {
         return __awaiter(this, void 0, void 0, function* () {
-            const entries = yield fs_1.promises.readdir(langDir);
+            const entries = yield node_fs_1.promises.readdir(langDir);
             for (const entry of entries) {
-                const language = entry.substring(0, entry.indexOf('.'));
-                yield this.loadAssetsLangFile(modid, language, (0, path_1.join)(langDir, entry), excludedModLanguage);
+                const language = entry.slice(0, Math.max(0, entry.indexOf('.')));
+                yield this.loadAssetsLangFile(modid, language, (0, node_path_1.join)(langDir, entry), excludedModLanguage);
             }
         });
     }
@@ -170,7 +171,7 @@ class ResourceLoader {
      */
     loadAssetsLangFile(modid, language, fullFilePath, excludedModLanguage) {
         return __awaiter(this, void 0, void 0, function* () {
-            const translations = JSON.parse((yield fs_1.promises.readFile(fullFilePath)).toString('utf8'));
+            const translations = JSON.parse((yield node_fs_1.promises.readFile(fullFilePath)).toString('utf8'));
             this.resourceHandler.addTranslations(language, translations, excludedModLanguage);
         });
     }
@@ -182,11 +183,11 @@ class ResourceLoader {
      */
     loadAssetsAdvancements(modid, advancementsDir, idPrefix) {
         return __awaiter(this, void 0, void 0, function* () {
-            const entries = yield fs_1.promises.readdir(advancementsDir);
+            const entries = yield node_fs_1.promises.readdir(advancementsDir);
             for (const entry of entries) {
-                const entryFullPath = (0, path_1.join)(advancementsDir, entry);
-                const entryId = idPrefix + '/' + entry;
-                if ((yield fs_1.promises.stat(entryFullPath)).isDirectory()) {
+                const entryFullPath = (0, node_path_1.join)(advancementsDir, entry);
+                const entryId = `${idPrefix}/${entry}`;
+                if ((yield node_fs_1.promises.stat(entryFullPath)).isDirectory()) {
                     yield this.loadAssetsAdvancements(modid, entryFullPath, entryId);
                 }
                 else {
@@ -203,13 +204,14 @@ class ResourceLoader {
      */
     loadAssetsAdvancement(modid, advancementsFile, id) {
         return __awaiter(this, void 0, void 0, function* () {
-            const contents = JSON.parse((yield fs_1.promises.readFile(advancementsFile)).toString('utf8'));
+            const contentsData = (yield node_fs_1.promises.readFile(advancementsFile)).toString('utf8');
+            const contents = JSON.parse(contentsData);
             const itemIcon = contents.display.icon;
             const title = contents.display.title.translate;
             const description = contents.display.description.translate;
             // Remove first slash and '.json' suffix.
-            id = id.substr(1, id.length - 6);
-            this.resourceHandler.addAdvancement({ itemIcon, title, description }, modid + ':' + id);
+            id = id.slice(1, 1 + id.length - 6);
+            this.resourceHandler.addAdvancement({ itemIcon, title, description }, `${modid}:${id}`);
         });
     }
     /**

package/lib/serialize/HtmlInfoBookSerializer.d.ts

@@ -1,10 +1,10 @@
-import { compileTemplate } from "pug";
-import { IFileWriter } from "../infobook/IFileWriter";
-import { IFluid } from "../infobook/IFluid";
-import { IInfoBook } from "../infobook/IInfoBook";
-import { IInfoSection } from "../infobook/IInfoSection";
-import { IItem } from "../infobook/IItem";
-import { ResourceHandler } from "../resource/ResourceHandler";
+import type { compileTemplate } from 'pug';
+import type { IFileWriter } from '../infobook/IFileWriter';
+import type { IFluid } from '../infobook/IFluid';
+import type { IInfoBook } from '../infobook/IInfoBook';
+import type { IInfoSection } from '../infobook/IInfoSection';
+import type { IItem } from '../infobook/IItem';
+import type { ResourceHandler } from '../resource/ResourceHandler';
 /**
  * Serializes an infobook to a collection of HTML files.
  */
@@ -53,9 +53,7 @@ export interface ISerializeContext {
     path: string;
     modId: string;
     resourceHandler: ResourceHandler;
-    colors: {
-        [key: string]: string;
-    };
+    colors: Record<string, string>;
     headSuffixGetters: ((context: ISerializeContext) => string)[];
     sectionIndex?: ISectionIndex;
     root: boolean;
@@ -98,13 +96,9 @@ export interface ISectionIndex {
     /**
      * Mapping from url to page index within linkedPagesList.
      */
-    urlIndex: {
-        [url: string]: number;
-    };
+    urlIndex: Record<string, number>;
     /**
      * Mapping from tag to page URL.
      */
-    tags: {
-        [tag: string]: string;
-    };
+    tags: Record<string, string>;
 }