warframe-worldstate-parser 4.2.2 → 4.3.1

package/lib/WorldState.js

@@ -32,6 +32,7 @@ import WorldEvent from './models/WorldEvent.js';
 import News from './models/News.js';
 import Kinepage from './models/Kinepage.js';
 import DeepArchimedea from './models/DeepArchidemea.js';
+import Calendar from './models/Calendar.js';
 
 const { sortieData } = wsData;
 
@@ -376,6 +377,8 @@ export class WorldState {
        */
       this.deepArchimedea = new DeepArchimedea(activation, expiry, tmp.lqo27);
     }
+
+    this.calendar = parseArray(Calendar, data.KnownCalendarSeasons, deps);
   }
 }
 

package/lib/models/Calendar.js

@@ -0,0 +1,59 @@
+import {
+  languageDesc,
+  languageString,
+  parseDate,
+  translateCalendarEvent,
+  translateSeason,
+} from 'warframe-worldstate-data/utilities';
+
+const EventTypes = Object.freeze({
+  PLOT: 'CET_PLOT',
+  REWARD: 'CET_REWARD',
+  CHALLENGE: 'CET_CHALLENGE',
+  UPGRADE: 'CET_UPGRADE',
+});
+
+/**
+ * Event data for a 1999 calendar day
+ * @param {object} event raw event data
+ */
+class DayEvent {
+  constructor(event) {
+    this.type = translateCalendarEvent(event.type);
+
+    if (event.challenge) this.challenge = this.eventDescription(event.challenge);
+
+    if (event.upgrade) this.upgrade = this.eventDescription(event.upgrade);
+
+    if (event.reward) this.reward = languageString(event.reward);
+
+    if (event.type === EventTypes.PLOT) {
+      this.dialogueName = event.dialogueName;
+      this.dialogueConvo = event.dialogueConvo;
+    }
+  }
+
+  eventDescription(name) {
+    return { title: languageString(name), description: languageDesc(name) };
+  }
+}
+
+export default class Calendar {
+  constructor(calendar) {
+    this.activation = parseDate(calendar.Activation);
+
+    this.expiry = parseDate(calendar.Expiry);
+
+    this.days = Array.isArray(calendar.Days)
+      ? calendar.Days.filter(Boolean).map((d) => ({ ...d, events: d.events.map((e) => new DayEvent(e)) }))
+      : [];
+
+    this.season = translateSeason(calendar.Season);
+
+    this.yearIteration = calendar.YearIteration;
+
+    this.version = calendar.Version;
+
+    this.requirements = calendar.UpgradeAvaliabilityRequirements;
+  }
+}

package/lib/models/WorldEvent.js

@@ -268,6 +268,12 @@ export default class WorldEvent extends WorldstateObject {
     if (data.JobAffiliationTag) {
       this.affiliatedWith = syndicate(data.JobAffiliationTag, locale);
     }
+
+    /**
+     * The event's tag
+     * @type {string}
+     */
+    this.tag = data.Tag;
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "warframe-worldstate-parser",
-  "version": "4.2.2",
+  "version": "4.3.1",
   "description": "An Open parser for Warframe's Worldstate in Javascript",
   "keywords": [
     "warframe-worldstate",

package/types/lib/WorldState.d.ts

@@ -154,6 +154,7 @@ export class WorldState {
      * @type {DeepArchimedea}
      */
     deepArchimedea: DeepArchimedea;
+    calendar: WorldstateObject[];
 }
 declare function _default(json: any, deps: any): Promise<WorldState>;
 export default _default;

package/types/lib/models/Calendar.d.ts

@@ -0,0 +1,10 @@
+export default class Calendar {
+    constructor(calendar: any);
+    activation: any;
+    expiry: any;
+    days: any;
+    season: any;
+    yearIteration: any;
+    version: any;
+    requirements: any;
+}

package/types/lib/models/WorldEvent.d.ts

@@ -167,6 +167,11 @@ export default class WorldEvent extends WorldstateObject {
         activation: any;
     };
     affiliatedWith: any;
+    /**
+     * The event's tag
+     * @type {string}
+     */
+    tag: string;
     /**
      * Get whether the event has expired
      * @returns {boolean} whether the event has expired