ogamejs 2.1.1 → 2.1.4

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [2.1.3](https://github.com/rolljee/ogamejs/compare/v2.1.2...v2.1.3) (2020-04-16)
+
+### [2.1.2](https://github.com/rolljee/ogamejs/compare/v2.1.1...v2.1.2) (2020-04-12)
+
 ### [2.1.1](https://github.com/rolljee/ogamejs/compare/v2.1.0...v2.1.1) (2020-04-12)
 
 ### [2.0.4](https://github.com/rolljee/ogamejs/compare/v2.0.3...v2.0.4) (2020-04-08)

package/README.md

@@ -2,7 +2,7 @@
 
 ## Introduction
 
-I always wanted an Ogame calculator that suited me, all those I could see online are, either too old in graphic terms, or it didn't work, it was calculating badly the number of resources to send for each exchange...
+I always wanted an Ogame calculator that suited me, all those I could see online are, either too old in graphic terms, or it didn't work, it was calculating badly the number of resources to send for each exchange... 
 
 So I decided to write a library in Javascript to create accessible methods to perform all calculations in a simple way for anyone who wants to create a graphical interface.
 
@@ -10,51 +10,226 @@ So I decided to write a library in Javascript to create accessible methods to pe
 
 All available methods will be listed below
 
-- `sellDeut` Exchange of deuterium against `Metal` and `Crystal`
+### Building
 
-```javascript
+* `getCrystalMine` Return information about the crystal mine given a specific level
+
+``` javascript
+/**
+ *
+ * Return information about the crystal mine given a specific level
+ * @param {object} mine The crystal mine base information
+ * @param {number} targetLevel the crystal mine target level
+ * @param {number} pos pos 1/2/3 have a 15/10/5%
+ * @param {number} universeSpeed production factor is increased for some universe
+ * @returns {Object} informations about the crystal mine at this specific level
+ */
+function getCrystalMine(mine, targetLevel, pos, universeSpeed = 1) {
+    @return {
+        crystal: Number,
+        deut: Number,
+        energy: Number,
+        metal: Number,
+        production: Number
+    }
+}
+```
+
+* `getDeutSynth` Return information about the deuterium synth given a specific level
+
+``` javascript
+/**
+ *
+ * Return information about the deuterium synth given a specific level
+ * @param {object} mine The deut synth base information
+ * @param {number} targetLevel the deuterieum synth target level
+ * @param {number} avg planet average temperature - The lower the higher the prod is
+ * @param {number} universeSpeed production factor is increased for some universe
+ * @returns {Object} informations about the deut synth at this specific level
+ */
+function getDeutSynth(mine, targetLevel, avg, universeSpeed = 1) {
+    @return {
+        crystal: Number,
+        deut: Number,
+        energy: Number,
+        metal: Number,
+        production: Number
+    }
+}
+```
+
+* `getMetalMine` Return information about the metal mine given a specific level
+
+``` javascript
+/**
+ *
+ * Return information about the metal mine given a specific level
+ * @param {object} mine The metal mine base information
+ * @param {number} targetLevel
+ * @param {number} universeSpeed production factor is increased for some universe
+ * @returns {Object} informations about the metal mine at this specific level
+ */
+function getMetalMine(mine, targetLevel, universeSpeed = 1) {
+    @return {
+        crystal: Number,
+        deut: Number,
+        energy: Number,
+        metal: Number,
+        production: Number
+    }
+}
+```
+
+* `getSolarPlant` Return information about the solar plant given a specific level
+
+``` javascript
+/**
+ *
+ * Return information about the solar plant given a specific level
+ * @param {object} solarPlant The solarPlant base information
+ * @param {number} targetLevel
+ * @returns {Object} informations about the solar plant at this specific level
+ */
+function getSolarPlant(solarPlant, targetLevel) {
+    @return {
+        crystal: Number,
+        deut: Number,
+        energy: Number,
+        metal: Number,
+        production: Number
+    }
+}
+```
+
+* `getFusionReactor` Return information about the fusion reactor given a specific level
+
+``` javascript
+/**
+ *
+ * Return information about the fusion reactor given a specific level
+ * @param {object} reactor The fusion react base information
+ * @param {number} targetLevel
+ * @param {number} energyTech The technology energy level
+ * @param {number} universeSpeed production factor is increased for some universe
+ * @returns {Object} informations about the fusion reactor at this specific level
+ */
+
+function getFusionReactor(reactor, targetLevel, energyTech, universeSpeed = 1) {
+    @return {
+        crystal: Number,
+        deut: Number,
+        energy: Number,
+        metal: Number,
+        production: Number
+    }
+}
+```
+
+* `parseInfoCompteData` Return the number of debris generated
+
+``` javascript
+/**
+ *
+ * Return information about the crystal mine given a specific level
+ * @param {object} data The infocompte bb-code
+ * @returns {Object} The parsed JSON object of infocompte
+ */
+function parseInfoCompteData(data) {
+    @return {
+        planet: String,
+        metal: String,
+        crystal: String,
+        deut: String,
+        temperature: Number,
+    }
+}
+```
+
+### Fleet
+
+* `getDebris` Return the number of debris generated
+
+``` javascript
+/**
+ *
+ * Returns the number of debris generated
+ * @param {number} shipId The ship identifier
+ * @param {number} number The number of ship
+ * @param {number} factor The universe debris factor
+ * @return {Object} The debris generated
+ */
+getDebris(ship, number, facror) {
+    @return {
+        metal: Number,
+        crystal: Number,
+    }
+}
+```
+
+### Trader
+
+* `sellDeut` Exchange of deuterium against `Metal` and `Crystal` 
+
+``` javascript
 // All params are optionnals
 // values placed here will be used if not specified
-sellDeut(deut = 0, percentM = 60, percentC = 40, rate = '2:1.5:1')
-@return {
-  metal: Number,
-  crystal: Number
+sellDeut(deut = 0, percentM = 60, percentC = 40, rate = '2:1.5:1') {
+    @return {
+        metal: Number,
+        crystal: Number
+    }
 }
 ```
 
-- `sellMetal` Exchange of deuterium against `Metal` and `Crystal`
+* `sellMetal` Exchange of deuterium against `Metal` and `Crystal` 
 
-```javascript
+``` javascript
 // All params are optionnals
 // values placed here will be used if not specified
-sellMetal(metal = 0, percentD = 40, percentC = 60, rate = '2:1.5:1')
-@return {
-  deut: Number,
-  metal: Number
+sellMetal(metal = 0, percentD = 40, percentC = 60, rate = '2:1.5:1') {
+    @return {
+        deut: Number,
+        metal: Number
+    }
 }
 ```
 
-- `sellCrystal` Exchange of deuterium against `Metal` and `Crystal`
+* `sellCrystal` Exchange of deuterium against `Metal` and `Crystal` 
 
-```javascript
+``` javascript
 // All params are optionnals
 // values placed here will be used if not specified
-sellCrystal(crystal = 0, percentD = 40, percentM = 60, rate = '2:1.5:1')
-@return {
-  deut: Number,
-  metal: Number
+sellCrystal(crystal = 0, percentD = 40, percentM = 60, rate = '2:1.5:1') {
+    @return {
+        deut: Number,
+        metal: Number
+    }
 }
 ```
 
-- `parseRate()` Parse the exchange rate
+* `parseRate()` Parse the exchange rate
 
-```javascript
+``` javascript
 // All params are optionnals
 // values placed here will be used if not specified
-parseRate(rate = '2:1.5:1') {};
-@return {
-  rateDeut: Number,
-  rateMetal: Number,
-  rateCrystal: Number
-};
+parseRate(rate = '2:1.5:1') {
+    @return {
+        rateDeut: Number,
+        rateMetal: Number,
+        rateCrystal: Number
+    };
+}
 ```
+
+### Models
+
+Listed below are categories of Buildings / Ships / Defenses
+
+#### Buildings
+
+[Buildings](./src/models/buildings.js) Here you will find all listed Buildings in the game
+
+#### Destroyable
+
+[Destroyable](./src/models/destroyable.js) Here you will find all listed Ships / Defense in the game
+

package/build/buildings/infocompte.js

@@ -23,9 +23,23 @@ function toNumber() {
   var number = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
   return Number(number.split('.').join(''));
 }
+/**
+ *
+ * Return information about the crystal mine given a specific level
+ * @param {object} data The infocompte bb-code
+ * @returns {Object} The parsed JSON object of infocompte
+ */
+
 
 function parseInfoCompteData(data) {
-  // eslint-disable-next-line security/detect-unsafe-regex
+  var universeDataRe = new RegExp('([0-9]{3}-[a-z]{2})');
+
+  var _data$match$1$split = data.match(universeDataRe)[1].split('-'),
+      _data$match$1$split2 = _slicedToArray(_data$match$1$split, 2),
+      universe = _data$match$1$split2[0],
+      lang = _data$match$1$split2[1]; // eslint-disable-next-line security/detect-unsafe-regex
+
+
   var planetsRe = new RegExp('(?:Planète [0-9]+(.+))(?:s+(?:Planète [0-9]+))*', 'g');
   var planets = data.matchAll(planetsRe);
   var metalPointRe = new RegExp('Points dans les mines de métal : (.+)');
@@ -87,7 +101,9 @@ function parseInfoCompteData(data) {
       deut: deutPoint,
       total: metalPoint + crystalPoint + deutPoint
     },
-    plasma: plasmaTechLevel
+    plasma: plasmaTechLevel,
+    universe: Number(universe),
+    lang: lang
   }; // eslint-disable-next-line no-restricted-syntax
 
   var _iterator = _createForOfIteratorHelper(planets),

package/build/buildings/infocompte.test.js

@@ -99,7 +99,9 @@ describe('Infocompte informations should be correctly return when', function ()
         deut: 3343660,
         total: 10983438
       },
-      plasma: 15
+      plasma: 15,
+      universe: 165,
+      lang: 'fr'
     });
   });
 });

package/package.json

@@ -1,14 +1,12 @@
 {
   "name": "ogamejs",
-  "version": "2.1.1",
+  "version": "2.1.4",
   "description": "",
   "main": "build/index.js",
   "scripts": {
     "start": "babel-node index.js",
     "commit": "git-cz",
-    "prerelease": "babel src -d build",
-    "release": "standard-version",
-    "release:beta": "standard-version -p beta",
+    "build": "babel src -d build",
     "lint": "eslint .",
     "test": "jest"
   },
@@ -49,7 +47,7 @@
     "git-cz": "^4.3.1",
     "jest": "^25.3.0",
     "regenerator-runtime": "^0.13.5",
-    "standard-version": "^7.1.0"
+    "standard-version": "^8.0.1"
   },
   "dependencies": {
     "lodash": "^4.17.15"