warframe-worldstate-parser 4.5.2 → 4.6.0

package/lib/WorldState.js

@@ -33,6 +33,7 @@ import News from './models/News.js';
 import Kinepage from './models/Kinepage.js';
 import DeepArchimedea from './models/DeepArchidemea.js';
 import Calendar from './models/Calendar.js';
+import MidrathCycle from './models/MidrathCycle.js';
 
 const { sortieData } = wsData;
 
@@ -278,6 +279,12 @@ export class WorldState {
      */
     this.zarimanCycle = new ZarimanCycle(zarimanBountyEnd, deps);
 
+    /**
+     * Midrath cycle (soulframe)
+     * @type {MidrathCycle}
+     */
+    this.midrathCycle = new MidrathCycle();
+
     /**
      * Weekly challenges
      * @type {Array.<WeeklyChallenge>}

package/lib/models/MidrathCycle.js

@@ -0,0 +1,93 @@
+import { timeDeltaToString, fromNow } from 'warframe-worldstate-data/utilities';
+
+import mdConfig from '../supporting/MarkdownSettings.js';
+
+import WorldstateObject from './WorldstateObject.js';
+
+/**
+ * @typedef {object} MidrathCycle
+ * @property {Date} expiry The date and time at which the event ends
+ * @property {Date} activation The date and time at which the event started
+ * @property {boolean} isDay Whether or not this it's daytime
+ * @property {string} state Current cycle state. One of `day`, `night`
+ * @property {string} timeLeft Time remaining string
+ * @property {boolean} expired Whether or not the event has expired
+ */
+
+/**
+ * Get the current Midrath cycle time
+ * @returns {MidrathCycle} Current midrath cycle time
+ */
+function getCurrentMidrathCycle() {
+  const dayDuration = 32 * 60 * 1000; // 32 minutes in milliseconds
+  const nightDuration = 16 * 60 * 1000; // 16 minutes in milliseconds
+  const totalDuration = dayDuration + nightDuration;
+
+  const now = new Date();
+  const elapsedInCycle = (now.getTime() - 222000) % totalDuration;
+  const isDay = elapsedInCycle < dayDuration;
+
+  let phase = {
+    name: 'night',
+    remaining: totalDuration - elapsedInCycle,
+    duration: nightDuration,
+  };
+
+  if (isDay) {
+    phase = {
+      name: 'day',
+      remaining: dayDuration - elapsedInCycle,
+      duration: dayDuration,
+    };
+  }
+
+  const activation = new Date(now.getTime() - (phase.duration - phase.remaining));
+  const expiry = new Date(activation.getTime() + phase.duration);
+  const timeLeft = timeDeltaToString(phase.remaining);
+
+  return {
+    activation,
+    expiry,
+    state: phase.name,
+    timeLeft,
+    isDay,
+  };
+}
+
+export default class MidrathCycle extends WorldstateObject {
+  #mc = getCurrentMidrathCycle();
+  constructor() {
+    super({ _id: { $oid: 'midrathCycle0' } });
+
+    this.activation = this.#mc.activation;
+
+    this.expiry = this.#mc.expiry;
+
+    this.isDay = this.#mc.isDay;
+
+    this.state = this.#mc.state;
+
+    this.timeLeft = this.#mc.timeLeft;
+  }
+
+  /**
+   * Get whether or not the event has expired
+   * @returns {boolean} Whether or not the event has expired
+   */
+  getExpired() {
+    return fromNow(this.expiry) < 0;
+  }
+
+  /**
+   * The event's string representation
+   * @returns {string} The string representation of the event
+   */
+  toString() {
+    const lines = [
+      `Envoy, it is currently ${this.isDay ? 'Day' : 'Night'}time in Midrath`,
+      `Time remaining until ${this.isDay ? 'night' : 'day'}: ${this.timeLeft}`,
+    ];
+
+    return lines.join(mdConfig.lineEnd);
+  }
+}

package/package.json

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

package/types/lib/WorldState.d.ts

@@ -116,6 +116,11 @@ export class WorldState {
      * @type {ZarimanCycle}
      */
     zarimanCycle: ZarimanCycle;
+    /**
+     * Midrath cycle (soulframe)
+     * @type {MidrathCycle}
+     */
+    midrathCycle: MidrathCycle;
     /**
      * Weekly challenges
      * @type {Array.<WeeklyChallenge>}
@@ -182,6 +187,7 @@ import EarthCycle from './models/EarthCycle.js';
 import CetusCycle from './models/CetusCycle.js';
 import CambionCycle from './models/CambionCycle.js';
 import ZarimanCycle from './models/ZarimanCycle.js';
+import MidrathCycle from './models/MidrathCycle.js';
 import WeeklyChallenge from './models/WeeklyChallenge.js';
 import ConstructionProgress from './models/ConstructionProgress.js';
 import VallisCycle from './models/VallisCycle.js';

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

@@ -0,0 +1,39 @@
+export default class MidrathCycle extends WorldstateObject {
+    constructor();
+    isDay: any;
+    state: any;
+    timeLeft: any;
+    /**
+     * Get whether or not the event has expired
+     * @returns {boolean} Whether or not the event has expired
+     */
+    getExpired(): boolean;
+    #private;
+}
+export type MidrathCycle = {
+    /**
+     * The date and time at which the event ends
+     */
+    expiry: Date;
+    /**
+     * The date and time at which the event started
+     */
+    activation: Date;
+    /**
+     * Whether or not this it's daytime
+     */
+    isDay: boolean;
+    /**
+     * Current cycle state. One of `day`, `night`
+     */
+    state: string;
+    /**
+     * Time remaining string
+     */
+    timeLeft: string;
+    /**
+     * Whether or not the event has expired
+     */
+    expired: boolean;
+};
+import WorldstateObject from './WorldstateObject.js';