diff --git a/packages/lib/data/ModInfo.js b/packages/lib/data/ModInfo.js index 4ad3873b..2c254935 100644 --- a/packages/lib/data/ModInfo.js +++ b/packages/lib/data/ModInfo.js @@ -15,7 +15,7 @@ const { integerModVersion, integerFactorioVersion, modVersionRegExp } = require( * * See https://wiki.factorio.com/Tutorial:Mod_structure#info.json for * details of the invidiual fields sourced from info.json. - * @alias module:lib/data/ModInfo + * @alias module:lib/data.ModInfo */ class ModInfo { /** diff --git a/packages/lib/data/ModPack.js b/packages/lib/data/ModPack.js index 73bd8aab..50f21db1 100644 --- a/packages/lib/data/ModPack.js +++ b/packages/lib/data/ModPack.js @@ -8,7 +8,7 @@ const { integerFactorioVersion } = require("./version"); /** * A setting for a mod. - * @typedef {object} module:lib/data/ModPack~ModSetting + * @typedef {object} module:lib/data.ModPack~ModSetting * @property {boolean|number|string} value - Value of the given mod setting. */ const ModSettingJsonSchema = { @@ -27,10 +27,10 @@ const ModSettingsJsonSchema = { /** * A mod in a mod pack - * @typedef {object} module:lib/data/ModPack~ModRecord + * @typedef {object} module:lib/data.ModPack~ModRecord * @property {string} name - name of the mod. * @property {string} version - version of the mod. - * @property {string} sha1 - SHA1 hash of the zip file. + * @property {string=} sha1 - SHA1 hash of the zip file. */ const ModRecordJsonSchema = { type: "object", @@ -47,7 +47,7 @@ const ModRecordJsonSchema = { * Factorio Mod Pack * * Tracks mods and settings for a collection of Factorio mods. - * @alias module:lib/data/ModPack + * @alias module:lib/data.ModPack */ class ModPack { /** @@ -84,13 +84,13 @@ class ModPack { /** * Mods included in this mod pack - * @type {Map} + * @type {Map} */ mods = new Map(); /** * Mod settings for this mod pack - * @type {Object>=} + * @type {Object>=} */ settings = { "startup": new Map(), diff --git a/packages/lib/data/index.js b/packages/lib/data/index.js index 2b280cc2..cec20aed 100644 --- a/packages/lib/data/index.js +++ b/packages/lib/data/index.js @@ -6,8 +6,10 @@ "use strict"; const ModInfo = require("./ModInfo"); const ModPack = require("./ModPack"); +const version = require("./version"); module.exports = { ModInfo, ModPack, + ...version, }; diff --git a/packages/lib/data/version.js b/packages/lib/data/version.js index bda52be7..52588c26 100644 --- a/packages/lib/data/version.js +++ b/packages/lib/data/version.js @@ -9,7 +9,7 @@ * number of leading zeros in them. * @param {string} version - string representation of version. * @returns {number} numeric representation. - * @private + * @alias module:lib/data.integerModVersion */ function integerModVersion(version) { const [major, minor, sub] = version.split(".").map(n => Number.parseInt(n, 10)); @@ -23,7 +23,7 @@ function integerModVersion(version) { * number of leading zeros in them. * @param {string} version - string representation of version. * @returns {number} numeric representation. - * @private + * @alias module:lib/data.integerFactorioVersion */ function integerFactorioVersion(version) { const [major, minor, sub] = version.split(".").map(n => Number.parseInt(n, 10)); @@ -33,7 +33,7 @@ function integerFactorioVersion(version) { /** * Matches valid mod versions. * @type {RegExp} - * @private + * @alias module:lib/data.modVersionRegExp */ const modVersionRegExp = /^\d+\.\d+\.\d+$/; diff --git a/packages/lib/plugin.js b/packages/lib/plugin.js index 38a7675d..ac2d3ffb 100644 --- a/packages/lib/plugin.js +++ b/packages/lib/plugin.js @@ -502,7 +502,7 @@ class BaseMasterPlugin { * If the mod pack has been deleted its `.isDeleted` property will be * true. * - * @param {module:lib/data/ModPack} modPack - Mod pack that updated. + * @param {module:lib/data.ModPack} modPack - Mod pack that updated. */ async onModPackUpdated(modPack) { } @@ -514,7 +514,7 @@ class BaseMasterPlugin { * * If a mod has been deleted its `.isDeleted` property will be true. * - * @param {module:lib/data/ModInfo} mod - Mod that updated. + * @param {module:lib/data.ModInfo} mod - Mod that updated. */ async onModUpdated(mod) { } diff --git a/packages/master/src/Master.js b/packages/master/src/Master.js index 6175ff46..2974f571 100644 --- a/packages/master/src/Master.js +++ b/packages/master/src/Master.js @@ -68,13 +68,13 @@ class Master { /** * Mapping of mod pack id to mod pack - * @type {Map} + * @type {Map} */ this.modPacks = null; /** * Mapping of mod names to mod infos - * @type {Map} + * @type {Map} */ this.mods = null;