@wfcd/relics 2.0.0 → 2.0.1

package/dist/index.js

@@ -19,6 +19,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
@@ -98,6 +102,10 @@ var Generator = class {
   constructor() {
     this.relics = [];
   }
+  /**
+   * Main function to fetch and generate the relic data
+   * @returns {Promise<Array<TitaniaRelic>>} The Relics data array
+   */
   async generate() {
     Logger_default.log("Starting Generation");
     await this.fetchRawData();
@@ -105,6 +113,9 @@ var Generator = class {
     this.generateTitaniaRelics();
     return this.relics;
   }
+  /**
+   * Fetches all required data from WFCD and WFM.
+   */
   async fetchRawData() {
     var _a;
     const relicRequest = await (0, import_node_fetch.default)(Config_default.warframeRelicDropUrl);
@@ -126,6 +137,11 @@ var Generator = class {
     }
     this.wfcdItems = await wfcdItemRequest.json();
   }
+  /**
+   * Generates the relic data
+   *  uses WFCD/warframe-drop-data to check what relics exist,
+   *  and adds information from WFCD/warframe-items and WFM
+   */
   generateTitaniaRelics() {
     if (typeof this.relicsRaw === "undefined" || typeof this.wfmItems === "undefined") {
       Logger_default.log("Failed to load relics/item data");
@@ -140,6 +156,12 @@ var Generator = class {
     }
     Logger_default.debug(`Finished parsing ${this.relics.length} relics`);
   }
+  /**
+   * Writes the fully generated data to disk.
+   * @param {string} dataDir Directory to store the relic data in. Default: ../data/
+   * @param {string} fileName Filename base ex: "Relics" becomes "Relics.json" and "Relics.min.json". Default: "Relics"
+   * @param {boolean} generateMin True if a minified json should be generated too. Default: true
+   */
   async writeData(dataDir, fileName, generateMin) {
     const DataDir = dataDir ?? import_node_path.default.join(__dirname, "..", "data");
     const RelicPath = fileName ? import_node_path.default.join(DataDir, `${fileName}.json`) : import_node_path.default.join(DataDir, "Relics.json");
@@ -149,6 +171,11 @@ var Generator = class {
       await import_promises.default.writeFile(RelicMinPath, JSON.stringify(this.relics));
     }
   }
+  /**
+   * Generates a single relic from all available data
+   * @param {WFCDRelic} rawRelic relic to pull Titania data from
+   * @returns {TitaniaRelicReward}
+   */
   generateTitaniaRelic(rawRelic) {
     var _a, _b;
     const name = `${rawRelic.tier} ${rawRelic.relicName}`;
@@ -158,7 +185,10 @@ var Generator = class {
       const { rarity } = rawReward;
       const wfmInfo = (_a2 = this.wfmItems) == null ? void 0 : _a2.payload.items.find((x) => x.item_name === rawReward.itemName);
       const isSpecial = ["Forma", "Kuva", "Exilus", "Riven"].find(
-        (x) => rawReward.itemName.toLowerCase().includes(x.toLowerCase())
+        (x) => (
+          // eslint-disable-next-line @typescript-eslint/comma-dangle
+          rawReward.itemName.toLowerCase().includes(x.toLowerCase())
+        )
       );
       if (!(wfmInfo || isSpecial)) {
         Logger_default.debug(`Failed to find wfm item for ${rawReward.itemName}`);
@@ -196,6 +226,9 @@ var Generator = class {
       ...(wfm == null ? void 0 : wfm.id) && (wfm == null ? void 0 : wfm.url_name) && { warframeMarket: { id: wfm == null ? void 0 : wfm.id, urlName: wfm == null ? void 0 : wfm.url_name } }
     };
   }
+  /**
+   * Filters WFCD's relic data to only include Intact variants, since we just need the base.
+   */
   filterWFCDRelics() {
     var _a, _b, _c;
     const before = ((_a = this.relicsRaw) == null ? void 0 : _a.length) || 0;
@@ -213,12 +246,20 @@ var VersionManager = class {
   versionPath;
   versionRawPath;
   hashPath;
+  /**
+   * Creates a new VersionManager instance.
+   * @param {string} dataDir Folder to write version information to.
+   * @constructor
+   */
   constructor(dataDir) {
     const DataDir = dataDir ?? import_node_path2.default.join(__dirname, "..", "data");
     this.versionPath = import_node_path2.default.join(DataDir, "version.json");
     this.versionRawPath = import_node_path2.default.join(DataDir, "version.txt");
     this.hashPath = import_node_path2.default.join(DataDir, "hash.json");
   }
+  /**
+   * Checks if the current data needs an update
+   */
   async updateNeeded() {
     const infoReq = await (0, import_node_fetch2.default)(Config_default.warframeRelicDropInfoUrl);
     if (!infoReq.ok) {
@@ -233,6 +274,10 @@ var VersionManager = class {
       return true;
     }
   }
+  /**
+   * Writes both game and drop version metadata
+   * @param {number} timestamp Timestamp the build was started at
+   */
   async writeVersion(timestamp) {
     const patchLogsReq = await (0, import_node_fetch2.default)(Config_default.warframePatchlogsUrl);
     if (!patchLogsReq.ok) {

package/dist/index.mjs

@@ -67,6 +67,10 @@ var Generator = class {
   constructor() {
     this.relics = [];
   }
+  /**
+   * Main function to fetch and generate the relic data
+   * @returns {Promise<Array<TitaniaRelic>>} The Relics data array
+   */
   async generate() {
     Logger_default.log("Starting Generation");
     await this.fetchRawData();
@@ -74,6 +78,9 @@ var Generator = class {
     this.generateTitaniaRelics();
     return this.relics;
   }
+  /**
+   * Fetches all required data from WFCD and WFM.
+   */
   async fetchRawData() {
     var _a;
     const relicRequest = await fetch(Config_default.warframeRelicDropUrl);
@@ -95,6 +102,11 @@ var Generator = class {
     }
     this.wfcdItems = await wfcdItemRequest.json();
   }
+  /**
+   * Generates the relic data
+   *  uses WFCD/warframe-drop-data to check what relics exist,
+   *  and adds information from WFCD/warframe-items and WFM
+   */
   generateTitaniaRelics() {
     if (typeof this.relicsRaw === "undefined" || typeof this.wfmItems === "undefined") {
       Logger_default.log("Failed to load relics/item data");
@@ -109,6 +121,12 @@ var Generator = class {
     }
     Logger_default.debug(`Finished parsing ${this.relics.length} relics`);
   }
+  /**
+   * Writes the fully generated data to disk.
+   * @param {string} dataDir Directory to store the relic data in. Default: ../data/
+   * @param {string} fileName Filename base ex: "Relics" becomes "Relics.json" and "Relics.min.json". Default: "Relics"
+   * @param {boolean} generateMin True if a minified json should be generated too. Default: true
+   */
   async writeData(dataDir, fileName, generateMin) {
     const DataDir = dataDir ?? path.join(__dirname, "..", "data");
     const RelicPath = fileName ? path.join(DataDir, `${fileName}.json`) : path.join(DataDir, "Relics.json");
@@ -118,6 +136,11 @@ var Generator = class {
       await fs.writeFile(RelicMinPath, JSON.stringify(this.relics));
     }
   }
+  /**
+   * Generates a single relic from all available data
+   * @param {WFCDRelic} rawRelic relic to pull Titania data from
+   * @returns {TitaniaRelicReward}
+   */
   generateTitaniaRelic(rawRelic) {
     var _a, _b;
     const name = `${rawRelic.tier} ${rawRelic.relicName}`;
@@ -127,7 +150,10 @@ var Generator = class {
       const { rarity } = rawReward;
       const wfmInfo = (_a2 = this.wfmItems) == null ? void 0 : _a2.payload.items.find((x) => x.item_name === rawReward.itemName);
       const isSpecial = ["Forma", "Kuva", "Exilus", "Riven"].find(
-        (x) => rawReward.itemName.toLowerCase().includes(x.toLowerCase())
+        (x) => (
+          // eslint-disable-next-line @typescript-eslint/comma-dangle
+          rawReward.itemName.toLowerCase().includes(x.toLowerCase())
+        )
       );
       if (!(wfmInfo || isSpecial)) {
         Logger_default.debug(`Failed to find wfm item for ${rawReward.itemName}`);
@@ -165,6 +191,9 @@ var Generator = class {
       ...(wfm == null ? void 0 : wfm.id) && (wfm == null ? void 0 : wfm.url_name) && { warframeMarket: { id: wfm == null ? void 0 : wfm.id, urlName: wfm == null ? void 0 : wfm.url_name } }
     };
   }
+  /**
+   * Filters WFCD's relic data to only include Intact variants, since we just need the base.
+   */
   filterWFCDRelics() {
     var _a, _b, _c;
     const before = ((_a = this.relicsRaw) == null ? void 0 : _a.length) || 0;
@@ -182,12 +211,20 @@ var VersionManager = class {
   versionPath;
   versionRawPath;
   hashPath;
+  /**
+   * Creates a new VersionManager instance.
+   * @param {string} dataDir Folder to write version information to.
+   * @constructor
+   */
   constructor(dataDir) {
     const DataDir = dataDir ?? path2.join(__dirname, "..", "data");
     this.versionPath = path2.join(DataDir, "version.json");
     this.versionRawPath = path2.join(DataDir, "version.txt");
     this.hashPath = path2.join(DataDir, "hash.json");
   }
+  /**
+   * Checks if the current data needs an update
+   */
   async updateNeeded() {
     const infoReq = await fetch2(Config_default.warframeRelicDropInfoUrl);
     if (!infoReq.ok) {
@@ -202,6 +239,10 @@ var VersionManager = class {
       return true;
     }
   }
+  /**
+   * Writes both game and drop version metadata
+   * @param {number} timestamp Timestamp the build was started at
+   */
   async writeVersion(timestamp) {
     const patchLogsReq = await fetch2(Config_default.warframePatchlogsUrl);
     if (!patchLogsReq.ok) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wfcd/relics",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Relic Data for Warframe",
   "main": "dist/index.js",
   "files": [
@@ -18,7 +18,7 @@
     "coverage": "npm test && nyc report --reporter=text-lcov | coveralls",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "postinstall": "install-peerdeps @wfcd/eslint-config@^1.2.0 -S",
+    "postinstall": "install-peerdeps @wfcd/eslint-config@^1.3.3 -S",
     "prepack": "npm run build",
     "start": "npm run build && node dist/Build.js",
     "test": "nyc mocha",
@@ -68,7 +68,7 @@
       "@wfcd/eslint-config/typescript"
     ],
     "parserOptions": {
-      "project": "./tsconfig.json"
+      "project": "tsconfig.json"
     }
   },
   "prettier": "@wfcd/eslint-config/prettier",