ogamejs 4.0.0 → 4.0.2

package/README.md

@@ -366,13 +366,20 @@ Ogame.Trader.sellCrystal(10000); // → { deut, metal }
 
 #### `parseRate(rate = '2:1.5:1', type = 'deut')`
 
-Normalizes a rate relative to a reference resource (`'metal'`, `'crystal'` or `'deut'`). Throws if the rate is malformed.
+Normalizes a rate relative to a reference resource (`'metal'`, `'crystal'` or `'deut'`). Throws if the rate is malformed — that includes a term that is not a number, but also a `0`, an empty one (`'2::1'`) and a negative one, none of which describe a trade.
 
 ```javascript
 Ogame.Trader.parseRate('3:2:1', 'deut');
 // → { rateMetal: 3, rateCrystal: 2, rateDeut: 1 }
 ```
 
+The reference term always comes back as `1`, so a rate and any multiple of it are the same rate, whichever resource you sell:
+
+```javascript
+Ogame.Trader.parseRate('4:3:2', 'deut');
+// → { rateMetal: 2, rateCrystal: 1.5, rateDeut: 1 }  — same as '2:1.5:1'
+```
+
 ### `Ogame.i18n`
 
 Every model entry carries `names: { en, fr }`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ogamejs",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "description": "OGame formulas as a dependency-free ESM library: building and research costs, production, build times, fleet debris and marketplace rates.",
   "type": "module",
   "main": "src/index.js",

package/src/trades/parseRate.js

@@ -1,4 +1,4 @@
-import hasNaN from './utils.js';
+import isUsableRate from './utils.js';
 
 function extract(rate, type) {
   let res = {};
@@ -20,9 +20,14 @@ function extract(rate, type) {
       rateDeut: deut / crystal,
     };
   } else if (type === 'deut') {
+    // Like the two branches above: express the other terms in units of the one
+    // being sold, so its own term becomes 1. Reading `metal` and `crystal` raw
+    // here only happened to work because rates are usually written against 1
+    // deuterium — `4:3:2` is the same rate as `2:1.5:1`, but used to pay twice
+    // as much for the very same deuterium.
     res = {
-      rateMetal: metal,
-      rateCrystal: crystal,
+      rateMetal: metal / deut,
+      rateCrystal: crystal / deut,
       rateDeut: 1,
     };
   } else {
@@ -41,7 +46,10 @@ export default function parseRate(rate = '2:1.5:1', type = 'deut') {
 
   const res = extract(rate, type);
 
-  if (hasNaN(Object.values(res))) {
+  // Checked after normalizing rather than on the raw terms: whatever makes a
+  // rate unusable — a term that is not a number, `0`, empty, negative — shows
+  // up here as a NaN, an Infinity, a 0 or a negative ratio.
+  if (!isUsableRate(Object.values(res))) {
     throw new Error('rate not parsed correctly');
   }
 

package/src/trades/utils.js

@@ -1,9 +1,8 @@
-export default function hasNaN(args) {
-  let response = false;
-  args.forEach((val) => {
-    if (Number.isNaN(Number(val))) {
-      response = true;
-    }
-  });
-  return response;
+// A normalized rate is usable when every term is a real, strictly positive
+// number. Checking only for `NaN` let two kinds of nonsense through as if they
+// were answers: `Infinity`, produced by dividing into a `0` term, and `0`
+// itself, which is what an empty term (`'2::1'`) parses to. A negative worth is
+// not something the game can express either.
+export default function isUsableRate(values) {
+  return values.every((value) => Number.isFinite(value) && value > 0);
 }

package/types/trades/parseRate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parseRate.d.ts","sourceRoot":"","sources":["../../src/trades/parseRate.js"],"names":[],"mappings":"AAkCA,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,IAAI,SAAY,EAAE,IAAI,SAAS,MAchE"}
+{"version":3,"file":"parseRate.d.ts","sourceRoot":"","sources":["../../src/trades/parseRate.js"],"names":[],"mappings":"AAuCA,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,IAAI,SAAY,EAAE,IAAI,SAAS,MAiBhE"}

package/types/trades/utils.d.ts

@@ -1,2 +1,2 @@
-export default function hasNaN(args: any): boolean;
+export default function isUsableRate(values: any): any;
 //# sourceMappingURL=utils.d.ts.map

package/types/trades/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/trades/utils.js"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,IAAI,KAAA,WAQlC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/trades/utils.js"],"names":[],"mappings":"AAKA,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,MAAM,KAAA,OAE1C"}