warframe-worldstate-parser 2.23.2 → 2.24.0

package/package.json

@@ -1,59 +1,25 @@
 {
   "name": "warframe-worldstate-parser",
-  "version": "2.23.2",
+  "version": "2.24.0",
   "description": "An Open parser for Warframe's Worldstate in Javascript",
   "types": "./types/main.d.ts",
   "main": "main.js",
-  "directories": {
-    "test": "test"
-  },
   "dependencies": {
     "node-fetch": "^2.6.1"
   },
   "peerDependencies": {
     "warframe-worldstate-data": ">=1.0"
   },
-  "devDependencies": {
-    "@types/chai": "^4.2.11",
-    "@types/node-fetch": "^2.5.8",
-    "@types/rewire": "^2.5.28",
-    "@types/sinon-chai": "^3.2.5",
-    "chai": "^4.2.0",
-    "coveralls": "^3.1.0",
-    "eslint": "^8.2.0",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-import": "^2.20.1",
-    "greenkeeper-lockfile": "^1.15.1",
-    "mocha": "^10.0.0",
-    "nyc": "^15.1.0",
-    "precommit-hook": "^3.0.0",
-    "rewire": "^6.0.0",
-    "sinon": "^13.0.0",
-    "sinon-chai": "^3.5.0",
-    "typescript": "^4.0.5"
-  },
   "engines": {
     "node": ">=8.9.0"
   },
-  "scripts": {
-    "test": "nyc mocha",
-    "test:integration": "npm run test -- -g 'should parse live worldstate data'",
-    "printcov": "nyc report",
-    "coverage": "npm test && nyc report --reporter=text-lcov | coveralls",
-    "build-docs": "jsdoc -c jsdoc-config.json -d docs",
-    "lint": "eslint main.js lib/ test/",
-    "lint:fix": "eslint main.js lib/ test/ --fix",
-    "prepublishOnly": "npm run build:types",
-    "build:types": "tsc -p tsconfig.declaration.json",
-    "validate": "npm run lint:fix && git add -u ."
-  },
   "files": [
     "lib",
     "main.js",
     "LICENSE",
     "types"
   ],
-  "repository": "wfcd/warframe-worldstate-parser",
+  "repository": "github:wfcd/warframe-worldstate-parser",
   "keywords": [
     "warframe-worldstate",
     "warframe"
@@ -66,86 +32,5 @@
   "bugs": {
     "url": "https://github.com/wfcd/warframe-worldstate-parser/issues"
   },
-  "homepage": "https://github.com/wfcd/warframe-worldstate-parser#readme",
-  "release": {
-    "branch": "master"
-  },
-  "eslintIgnore": [
-    ".github/**",
-    "docs/**",
-    "resources/**",
-    "types/**"
-  ],
-  "eslintConfig": {
-    "extends": "airbnb-base",
-    "parserOptions": {
-      "sourceType": "script"
-    },
-    "rules": {
-      "valid-jsdoc": [
-        "error",
-        {
-          "requireReturn": false,
-          "requireReturnDescription": false,
-          "preferType": {
-            "String": "string",
-            "Number": "number",
-            "Boolean": "boolean",
-            "Function": "function",
-            "object": "Object",
-            "date": "Date",
-            "error": "Error"
-          },
-          "prefer": {
-            "return": "returns"
-          }
-        }
-      ],
-      "no-underscore-dangle": "off",
-      "strict": [
-        "error",
-        "safe"
-      ],
-      "linebreak-style": "off",
-      "import/no-unresolved": 0
-    }
-  },
-  "pre-commit": [
-    "validate"
-  ],
-  "mocha": {
-    "exit": true,
-    "spec": "test/**/*.spec.js",
-    "timeout": 10000
-  },
-  "nyc": {
-    "exclude": [
-      "test/**",
-      "lib/DarkSector*.js",
-      "lib/Alert.js",
-      "lib/PersistentEnemy.js",
-      "lib/GlobalUpgrade.js",
-      "lib/ChallengeInstance.js",
-      "lib/WeeklyChallenge.js"
-    ],
-    "reporter": [
-      "lcov",
-      "text"
-    ],
-    "skip-full": true
-  },
-  "clean-package": {
-    "remove": [
-      "devDependencies",
-      "scripts",
-      "release",
-      "eslintIgnore",
-      "eslintConfig",
-      "pre-commit",
-      "nyc",
-      "mocha",
-      "clean-package",
-      "directories"
-    ]
-  }
+  "homepage": "https://github.com/wfcd/warframe-worldstate-parser#readme"
 }

package/types/lib/Alert.d.ts

@@ -13,7 +13,7 @@ declare class Alert extends WorldstateObject {
      * @param   {Reward}             Reward     The Reward parser
      * @param   {string}             locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, Mission, Reward, locale, }: MarkdownSettings);
+    constructor(data: any, { mdConfig, translator, timeDate, Mission, Reward, locale }: MarkdownSettings);
     /**
      * The markdown settings
      * @type {MarkdownSettings}

package/types/lib/ConclaveChallenge.d.ts

@@ -12,7 +12,7 @@ declare class ConclaveChallenge extends WorldstateObject {
      * @param   {TimeDateFunctions}  deps.timeDate   The time and date functions
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, locale, }: {
+    constructor(data: any, { mdConfig, translator, timeDate, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         timeDate: TimeDateFunctions;

package/types/lib/DailyDeal.d.ts

@@ -11,7 +11,7 @@ declare class DailyDeal {
      * @param   {TimeDateFunctions} deps.timeDate   The time and date functions
      * @param   {string}            deps.locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, locale, }: {
+    constructor(data: any, { mdConfig, translator, timeDate, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         timeDate: TimeDateFunctions;

package/types/lib/DarkSector.d.ts

@@ -15,7 +15,7 @@ declare class DarkSector extends WorldstateObject {
      * @param   {Reward}             deps.Reward           The reward parser
      * @param   {string}             deps.locale           Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, Mission, DarkSectorBattle, Reward, locale, }: {
+    constructor(data: any, { mdConfig, translator, timeDate, Mission, DarkSectorBattle, Reward, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         timeDate: TimeDateFunctions;

package/types/lib/Fissure.d.ts

@@ -42,9 +42,9 @@ declare class Fissure extends WorldstateObject {
      */
     enemyKey: string;
     /**
-       * The node key where the fissure has appeared
-       * @type {string}
-       */
+     * The node key where the fissure has appeared
+     * @type {string}
+     */
     nodeKey: string;
     /**
      * The fissure's tier

package/types/lib/FlashSale.d.ts

@@ -11,7 +11,7 @@ declare class FlashSale {
      * @param   {TimeDateFunctions}  deps.timeDate   The time and date functions
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { translator, mdConfig, timeDate, locale, }: {
+    constructor(data: any, { translator, mdConfig, timeDate, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         timeDate: TimeDateFunctions;

package/types/lib/GlobalUpgrade.d.ts

@@ -11,7 +11,7 @@ declare class GlobalUpgrade {
      * @param   {MarkdownSettings}   deps.mdConfig   The markdown settings
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { translator, timeDate, mdConfig, locale, }: {
+    constructor(data: any, { translator, timeDate, mdConfig, locale }: {
         translator: Translator;
         timeDate: TimeDateFunctions;
         mdConfig: MarkdownSettings;

package/types/lib/Invasion.d.ts

@@ -19,7 +19,7 @@ declare class Invasion extends WorldstateObject {
      * @param   {Reward}             deps.Reward     The Reward parser
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, Reward, locale, }: {
+    constructor(data: any, { mdConfig, translator, timeDate, Reward, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         timeDate: TimeDateFunctions;
@@ -38,9 +38,9 @@ declare class Invasion extends WorldstateObject {
      */
     node: string;
     /**
-    * The node key where the invasion is taking place
-    * @type {string}
-    */
+     * The node key where the invasion is taking place
+     * @type {string}
+     */
     nodeKey: string;
     /**
      * The invasion's description

package/types/lib/Kuva.d.ts

@@ -1,11 +1,6 @@
 export = Kuva;
-/**
- * Stores and parses kuva data from https://10o.io/kuvalog.json
- * @property {ExternalMission[]} kuva currently active kuva missions
- * @property {ExternalMission} arbitration current arbitration
- */
 declare class Kuva {
-    constructor({ kuvaData, translator, locale, logger, }: {
+    constructor({ kuvaData, translator, locale, logger }: {
         kuvaData: any;
         translator: any;
         locale: any;

package/types/lib/Mission.d.ts

@@ -1,7 +1,4 @@
 export = Mission;
-/**
- * Represents an in-game mission
- */
 declare class Mission {
     /**
      * @param   {Object}             data            The mission data
@@ -11,7 +8,7 @@ declare class Mission {
      * @param   {Reward}             deps.Reward     The Reward parser
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, Reward, locale, }: {
+    constructor(data: any, { mdConfig, translator, Reward, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         Reward: Reward;
@@ -33,11 +30,21 @@ declare class Mission {
      * @type {string}
      */
     node: string;
+    /**
+     * Unlocalized {@link mission#node}
+     * @type {string}
+     */
+    nodeKey: string;
     /**
      * The mission's type
      * @type {string}
      */
     type: string;
+    /**
+     * The mission's type
+     * @type {string}
+     */
+    typeKey: string;
     /**
      * The factions that the players must fight in the mission
      * @type {string}

package/types/lib/News.d.ts

@@ -107,10 +107,10 @@ declare class News extends WorldstateObject {
      */
     isStream(): boolean;
     /**
-    * The title of the news item in the specified language
-    * @param {string} langCode Ex. 'es', 'de', 'fr'
-    * @returns {string}
-    */
+     * The title of the news item in the specified language
+     * @param {string} langCode Ex. 'es', 'de', 'fr'
+     * @returns {string}
+     */
     getTitle(langCode: string): string;
 }
 import WorldstateObject = require("./WorldstateObject");

package/types/lib/Nightwave.d.ts

@@ -14,7 +14,7 @@ declare class Nightwave extends WorldstateObject {
      * @param   {Reward}             deps.Reward     The Reward parser
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, Mission, Reward, locale, }: {
+    constructor(data: any, { mdConfig, translator, timeDate, Mission, Reward, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         timeDate: TimeDateFunctions;

package/types/lib/NightwaveChallenge.d.ts

@@ -11,7 +11,7 @@ declare class NightwaveChallenge extends WorldstateObject {
      * @param   {TimeDateFunctions}  deps.timeDate   The time and date functions
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { translator, timeDate, locale, }: {
+    constructor(data: any, { translator, timeDate, locale }: {
         translator: Translator;
         timeDate: TimeDateFunctions;
         locale: string;

package/types/lib/PersistentEnemy.d.ts

@@ -11,7 +11,7 @@ declare class PersistentEnemy extends WorldstateObject {
      * @param   {Translator}         deps.translator The string translator
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, locale, }: {
+    constructor(data: any, { mdConfig, translator, timeDate, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         locale: string;

package/types/lib/SentientOutpost.d.ts

@@ -20,7 +20,7 @@ export = SentientOutpost;
  * @property {Date}    previous.expiry     When the mission became or becomes inactive
  */
 declare class SentientOutpost {
-    constructor(data: any, { translator, locale, sentientData, logger, }: {
+    constructor(data: any, { translator, locale, sentientData, logger }: {
         translator: any;
         locale: any;
         sentientData: any;

package/types/lib/Sortie.d.ts

@@ -14,7 +14,7 @@ declare class Sortie extends WorldstateObject {
      * @param   {SortieVariant}     deps.SortieVariant The sortie variant parser
      * @param   {string}            deps.locale        Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, sortieData, SortieVariant, locale, }: {
+    constructor(data: any, { mdConfig, translator, timeDate, sortieData, SortieVariant, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         timeDate: TimeDateFunctions;

package/types/lib/SortieVariant.d.ts

@@ -11,7 +11,7 @@ declare class SortieVariant {
      * @param   {Object}            deps.sortieData    The data used to parse sorties
      * @param   {string}            deps.locale        Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, locale, }: {
+    constructor(data: any, { mdConfig, translator, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         sortieData: any;
@@ -24,19 +24,19 @@ declare class SortieVariant {
      */
     private mdConfig;
     /**
-       * The variant's mission type
-       * @type {string}
-       */
+     * The variant's mission type
+     * @type {string}
+     */
     missionType: string;
     /**
-       * The variant's modifier
-       * @type {string}
-       */
+     * The variant's modifier
+     * @type {string}
+     */
     modifier: string;
     /**
-       * The variant's modifier description
-       * @type {string}
-       */
+     * The variant's modifier description
+     * @type {string}
+     */
     modifierDescription: string;
     /**
      * The node where the variant takes place

package/types/lib/SyndicateMission.d.ts

@@ -12,7 +12,7 @@ declare class SyndicateMission extends WorldstateObject {
      * @param   {TimeDateFunctions}  deps.timeDate   The time and date functions
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, locale, }: {
+    constructor(data: any, { mdConfig, translator, timeDate, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         timeDate: TimeDateFunctions;

package/types/lib/VoidTrader.d.ts

@@ -12,7 +12,7 @@ declare class VoidTrader extends WorldstateObject {
      * @param   {TimeDateFunctions}  deps.timeDate   The time and date functions
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, locale, }: {
+    constructor(data: any, { mdConfig, translator, timeDate, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         timeDate: TimeDateFunctions;

package/types/lib/WorldEvent.d.ts

@@ -30,7 +30,7 @@ declare class WorldEvent extends WorldstateObject {
      * @param   {Reward}            deps.Reward     The Reward parser
      * @param   {string}            deps.locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, Reward, locale, }: {
+    constructor(data: any, { mdConfig, translator, timeDate, Reward, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         timeDate: TimeDateFunctions;
@@ -128,9 +128,9 @@ declare class WorldEvent extends WorldstateObject {
     interimSteps: InterimStep[];
     /**
      * Progress Steps, if any are present
-     * @type {ProgessStep[]}
+     * @type {ProgressStep[]}
      */
-    progressSteps: ProgessStep[];
+    progressSteps: ProgressStep[];
     /**
      * Total of all MultiProgress
      * @type {Number}

package/types/lib/WorldState.d.ts

@@ -91,6 +91,11 @@ declare class WorldState {
      * @type {CambionCycle}
      */
     cambionCycle: CambionCycle;
+    /**
+     * The current Zariman cycle based off current time
+     * @type {ZarimanCycle}
+     */
+    zarimanCycle: ZarimanCycle;
     /**
      * Weekly challenges
      * @type {Array.<WeeklyChallenge>}

package/types/lib/ZarimanCycle.d.ts

@@ -0,0 +1,55 @@
+export = ZarimanCycle;
+declare class ZarimanCycle extends WorldstateObject {
+    /**
+     * @param   {Date}              currentTime     The current time to calculate Zariman cycle for
+     * @param   {Object}            deps            The dependencies object
+     * @param   {MarkdownSettings}  deps.mdConfig   The markdown settings
+     * @param   {TimeDateFunctions} deps.timeDate   The time and date functions
+     */
+    constructor(currentTime: Date, { mdConfig, timeDate }: {
+        mdConfig: MarkdownSettings;
+        timeDate: TimeDateFunctions;
+    });
+    /**
+     * The markdown settings
+     * @type {MarkdownSettings}
+     * @private
+     */
+    private mdConfig;
+    /**
+     * The end of the Zariman bounties timer, the faction changes exactly half way through
+     * @type {Date}
+     * @private
+     */
+    private currentTime;
+    /**
+     * Whether or not this it's daytime
+     * @type {boolean}
+     */
+    isCorpus: boolean;
+    /**
+     * Current cycle state. One of `corpus`, `grineer`
+     * @type {string}
+     */
+    state: string;
+    /**
+     * Time remaining string
+     * @type {string}
+     */
+    timeLeft: string;
+    shortString: string;
+    /**
+     * Get whether or not the event has expired
+     * @returns {boolean}
+     */
+    getExpired(): boolean;
+    getCurrentZarimanCycle(): {
+        corpusTime: boolean;
+        timeLeft: any;
+        expiry: Date;
+        expiresIn: number;
+        state: string;
+        start: number;
+    };
+}
+import WorldstateObject = require("./WorldstateObject");