warframe-worldstate-parser 5.2.17 → 5.3.0

package/dist/lib/models/WorldEvent.d.mts

@@ -1,205 +1,2 @@
-import { Dependency } from "../supporting/Dependency.mjs";
-import "../supporting/index.mjs";
-import { RawReward, Reward } from "./Reward.mjs";
-import { BaseContentObject, Identifier, WorldStateObject } from "./WorldStateObject.mjs";
-import { RawSyndicateJob, SyndicateJob } from "./SyndicateJob.mjs";
-import { ContentTimestamp } from "warframe-worldstate-data/utilities";
-
-//#region lib/models/WorldEvent.d.ts
-/**
- * Interim step for an event reward system.
- */
-interface InterimStep {
-  goal: number;
-  reward: Reward | undefined;
-  winnerCount: number;
-  message: object;
-}
-/**
- * Progress for one of multiple stages
- */
-interface ProgressStep {
-  type: string;
-  progressAmt: number;
-}
-interface InterimRewardMessage {
-  sender: string;
-  subject: string;
-  message: string;
-  senderIcon: string;
-  attachments: string;
-}
-interface RawWorldEvent extends BaseContentObject {
-  Goal: number;
-  Count?: number;
-  GoalInterim?: string;
-  GoalInterim2?: string;
-  Faction?: string;
-  Desc: string;
-  ToolTip?: string;
-  Node?: string;
-  ConcurrentNodes?: string[] | undefined;
-  VictimNode?: string;
-  Fomorian?: string;
-  ScoreLocTag?: string;
-  HealthPct?: number;
-  JobPreviousVersion?: Identifier;
-  Reward?: RawReward;
-  InterimRewards?: RawReward[];
-  InterimRewardMessages?: InterimRewardMessage[];
-  InterimGoals: number[];
-  _interimWinnerCounts?: number[];
-  IsMultiProgress?: boolean;
-  Types?: string[];
-  MultiProgress?: string[];
-  ShowTotalAtEOM?: boolean;
-  Personal: boolean;
-  Community?: boolean;
-  RegionDrops?: string[];
-  ArchwingDrops?: string[];
-  Metadata?: string;
-  CompletionBonus?: number[];
-  ScoreVar: string;
-  AltExpiry?: ContentTimestamp;
-  AltActivation?: ContentTimestamp;
-  NextAltExpiry?: ContentTimestamp;
-  NextAltActivation?: ContentTimestamp;
-  JobAffiliationTag?: string;
-  Tag: string;
-  Jobs?: RawSyndicateJob[];
-  PreviousJobs?: RawSyndicateJob[];
-}
-/**
- * Represents an in-game special event
- * @augments {WorldStateObject}
- */
-declare class WorldEvent extends WorldStateObject {
-  jobs: SyndicateJob[];
-  previousJobs: SyndicateJob[];
-  /**
-   * The event's main score goal
-   */
-  maximumScore: number;
-  /**
-   * The current score on the event
-   */
-  currentScore: number;
-  /**
-   * The first intermediate score goal
-   */
-  smallInterval: number;
-  /**
-   * The second intermediate score goal
-   */
-  largeInterval: number;
-  /**
-   * The faction that the players must fight in the event
-   */
-  faction: string | undefined;
-  /**
-   * The description of the event
-   */
-  description: string;
-  /**
-   * Tooltip for the event
-   */
-  tooltip: string | undefined;
-  /**
-   * The node where the event takes place
-   */
-  node: string | undefined;
-  /**
-   * The other nodes where the event takes place
-   */
-  concurrentNodes: string[];
-  /**
-   * The victim node
-   */
-  victimNode: string | undefined;
-  /**
-   * The score description
-   */
-  scoreLocTag: string | undefined;
-  /**
-   * The event's rewards
-   */
-  rewards: Reward[];
-  /**
-   * Health remaining for the target
-   */
-  health: number | undefined;
-  /**
-   * Previous job id
-   */
-  previousId: string | undefined;
-  /**
-   * Array of steps
-   */
-  interimSteps: InterimStep[];
-  /**
-   * Progress Steps, if any are present
-   */
-  progressSteps: ProgressStep[];
-  /**
-   * Total of all MultiProgress
-   */
-  progressTotal?: number;
-  /**
-   * Whether to show the total score at the end of the mission
-   */
-  showTotalAtEndOfMission: boolean;
-  /**
-   * Whether the event is personal
-   */
-  isPersonal: boolean;
-  /**
-   * Whether the event is community
-   */
-  isCommunity: boolean;
-  regionDrops: string[];
-  /**
-   * Archwing Drops in effect while this event is active
-   */
-  archwingDrops: string[];
-  /**
-   * Metadata provided by DE
-   */
-  metadata: object;
-  /**
-   * Bonuses given for completion
-   */
-  completionBonuses: number[];
-  scoreVar: string;
-  altExpiry: Date;
-  altActivation: Date;
-  nextAlt: {
-    expiry: Date;
-    activation: Date;
-  };
-  affiliatedWith?: string;
-  /**
-   * The event's tag
-   */
-  tag: string;
-  victim?: string;
-  /**
-   * Asynchronously build a new WorldEvent
-   * @param data The event data
-   * @param deps The dependencies object
-   * @returns The created WorldEvent object
-   */
-  static build(data: RawWorldEvent, deps: Dependency): Promise<WorldEvent>;
-  /**
-   * @param data The event data
-   * @param deps The dependencies object
-   */
-  constructor(data: RawWorldEvent, {
-    locale
-  }?: Dependency);
-  /**
-   * Whether the event has expired
-   */
-  get expired(): boolean;
-}
-//#endregion
+import { a as WorldEvent, i as RawWorldEvent, n as InterimStep, r as ProgressStep, t as InterimRewardMessage } from "../../index-BK5W1mAn.mjs";
 export { InterimRewardMessage, InterimStep, ProgressStep, RawWorldEvent, WorldEvent };

package/dist/lib/models/WorldEvent.mjs

@@ -1,15 +1,25 @@
+import { n as __decorateMetadata, t as __decorate } from "../../decorate-CltSo06_.mjs";
 import { Reward } from "./Reward.mjs";
 import { WorldStateObject } from "./WorldStateObject.mjs";
 import { SyndicateJob } from "./SyndicateJob.mjs";
+import { ApiProperty, ApiPropertyOptional } from "@nestjs/swagger";
+import { Type } from "class-transformer";
+import { IsArray, IsBoolean, IsDate, IsInt, IsNumber, IsObject, IsOptional, IsString, Min, ValidateNested } from "class-validator";
 import { faction, fromNow, languageString, node, parseDate, syndicate } from "warframe-worldstate-data/utilities";
-
 //#region lib/models/WorldEvent.ts
+var _ref, _ref2;
 /**
 * Represents an in-game special event
 * @augments {WorldStateObject}
 */
 var WorldEvent = class WorldEvent extends WorldStateObject {
+	/**
+	* Jobs associated with this event
+	*/
 	jobs;
+	/**
+	* Previous jobs associated with this event
+	*/
 	previousJobs;
 	/**
 	* The event's main score goal
@@ -104,15 +114,33 @@ var WorldEvent = class WorldEvent extends WorldStateObject {
 	* Bonuses given for completion
 	*/
 	completionBonuses;
+	/**
+	* Score variable name
+	*/
 	scoreVar;
+	/**
+	* Alternative expiry date
+	*/
 	altExpiry;
+	/**
+	* Alternative activation date
+	*/
 	altActivation;
+	/**
+	* Next alternative cycle dates
+	*/
 	nextAlt;
+	/**
+	* Affiliated syndicate, if any
+	*/
 	affiliatedWith;
 	/**
 	* The event's tag
 	*/
 	tag;
+	/**
+	* Victim identifier, if any
+	*/
 	victim;
 	/**
 	* Asynchronously build a new WorldEvent
@@ -208,6 +236,239 @@ var WorldEvent = class WorldEvent extends WorldStateObject {
 		return fromNow(this.expiry) < 0;
 	}
 };
-
+__decorate([
+	ApiProperty({
+		description: "Jobs associated with this event",
+		type: [SyndicateJob]
+	}),
+	IsArray(),
+	ValidateNested({ each: true }),
+	Type(() => SyndicateJob),
+	__decorateMetadata("design:type", Array)
+], WorldEvent.prototype, "jobs", void 0);
+__decorate([
+	ApiProperty({
+		description: "Previous jobs associated with this event",
+		type: [SyndicateJob]
+	}),
+	IsArray(),
+	ValidateNested({ each: true }),
+	Type(() => SyndicateJob),
+	__decorateMetadata("design:type", Array)
+], WorldEvent.prototype, "previousJobs", void 0);
+__decorate([
+	ApiProperty({ description: "The event's main score goal" }),
+	IsInt(),
+	Min(0),
+	__decorateMetadata("design:type", Number)
+], WorldEvent.prototype, "maximumScore", void 0);
+__decorate([
+	ApiProperty({ description: "The current score on the event" }),
+	IsInt(),
+	Min(0),
+	__decorateMetadata("design:type", Number)
+], WorldEvent.prototype, "currentScore", void 0);
+__decorate([
+	ApiProperty({ description: "The first intermediate score goal" }),
+	IsInt(),
+	Min(0),
+	__decorateMetadata("design:type", Number)
+], WorldEvent.prototype, "smallInterval", void 0);
+__decorate([
+	ApiProperty({ description: "The second intermediate score goal" }),
+	IsInt(),
+	Min(0),
+	__decorateMetadata("design:type", Number)
+], WorldEvent.prototype, "largeInterval", void 0);
+__decorate([
+	ApiPropertyOptional({ description: "The faction that the players must fight in the event" }),
+	IsOptional(),
+	IsString(),
+	__decorateMetadata("design:type", Object)
+], WorldEvent.prototype, "faction", void 0);
+__decorate([
+	ApiProperty({ description: "The description of the event" }),
+	IsString(),
+	__decorateMetadata("design:type", String)
+], WorldEvent.prototype, "description", void 0);
+__decorate([
+	ApiPropertyOptional({ description: "Tooltip for the event" }),
+	IsOptional(),
+	IsString(),
+	__decorateMetadata("design:type", Object)
+], WorldEvent.prototype, "tooltip", void 0);
+__decorate([
+	ApiPropertyOptional({ description: "The node where the event takes place" }),
+	IsOptional(),
+	IsString(),
+	__decorateMetadata("design:type", Object)
+], WorldEvent.prototype, "node", void 0);
+__decorate([
+	ApiProperty({
+		description: "The other nodes where the event takes place",
+		type: [String]
+	}),
+	IsArray(),
+	IsString({ each: true }),
+	__decorateMetadata("design:type", Array)
+], WorldEvent.prototype, "concurrentNodes", void 0);
+__decorate([
+	ApiPropertyOptional({ description: "The victim node" }),
+	IsOptional(),
+	IsString(),
+	__decorateMetadata("design:type", Object)
+], WorldEvent.prototype, "victimNode", void 0);
+__decorate([
+	ApiPropertyOptional({ description: "The score description" }),
+	IsOptional(),
+	IsString(),
+	__decorateMetadata("design:type", Object)
+], WorldEvent.prototype, "scoreLocTag", void 0);
+__decorate([
+	ApiProperty({
+		description: "The event's rewards",
+		type: [Reward]
+	}),
+	IsArray(),
+	ValidateNested({ each: true }),
+	Type(() => Reward),
+	__decorateMetadata("design:type", Array)
+], WorldEvent.prototype, "rewards", void 0);
+__decorate([
+	ApiPropertyOptional({ description: "Health remaining for the target" }),
+	IsOptional(),
+	IsNumber(),
+	Min(0),
+	__decorateMetadata("design:type", Object)
+], WorldEvent.prototype, "health", void 0);
+__decorate([
+	ApiPropertyOptional({ description: "Previous job id" }),
+	IsOptional(),
+	IsString(),
+	__decorateMetadata("design:type", Object)
+], WorldEvent.prototype, "previousId", void 0);
+__decorate([
+	ApiProperty({
+		description: "Array of interim steps",
+		type: "array",
+		items: { type: "object" }
+	}),
+	IsArray(),
+	__decorateMetadata("design:type", Array)
+], WorldEvent.prototype, "interimSteps", void 0);
+__decorate([
+	ApiProperty({
+		description: "Progress steps, if any are present",
+		type: "array",
+		items: { type: "object" }
+	}),
+	IsArray(),
+	__decorateMetadata("design:type", Array)
+], WorldEvent.prototype, "progressSteps", void 0);
+__decorate([
+	ApiPropertyOptional({ description: "Total of all MultiProgress" }),
+	IsOptional(),
+	IsNumber(),
+	__decorateMetadata("design:type", Number)
+], WorldEvent.prototype, "progressTotal", void 0);
+__decorate([
+	ApiProperty({ description: "Whether to show the total score at the end of the mission" }),
+	IsBoolean(),
+	__decorateMetadata("design:type", Boolean)
+], WorldEvent.prototype, "showTotalAtEndOfMission", void 0);
+__decorate([
+	ApiProperty({ description: "Whether the event is personal" }),
+	IsBoolean(),
+	__decorateMetadata("design:type", Boolean)
+], WorldEvent.prototype, "isPersonal", void 0);
+__decorate([
+	ApiProperty({ description: "Whether the event is community" }),
+	IsBoolean(),
+	__decorateMetadata("design:type", Boolean)
+], WorldEvent.prototype, "isCommunity", void 0);
+__decorate([
+	ApiProperty({
+		description: "Affectors for this mission",
+		type: [String]
+	}),
+	IsArray(),
+	IsString({ each: true }),
+	__decorateMetadata("design:type", Array)
+], WorldEvent.prototype, "regionDrops", void 0);
+__decorate([
+	ApiProperty({
+		description: "Archwing Drops in effect while this event is active",
+		type: [String]
+	}),
+	IsArray(),
+	IsString({ each: true }),
+	__decorateMetadata("design:type", Array)
+], WorldEvent.prototype, "archwingDrops", void 0);
+__decorate([
+	ApiProperty({
+		description: "Metadata provided by DE",
+		type: "object"
+	}),
+	IsObject(),
+	__decorateMetadata("design:type", Object)
+], WorldEvent.prototype, "metadata", void 0);
+__decorate([
+	ApiProperty({
+		description: "Bonuses given for completion",
+		type: [Number]
+	}),
+	IsArray(),
+	IsNumber({}, { each: true }),
+	__decorateMetadata("design:type", Array)
+], WorldEvent.prototype, "completionBonuses", void 0);
+__decorate([
+	ApiProperty({ description: "Score variable name" }),
+	IsString(),
+	__decorateMetadata("design:type", String)
+], WorldEvent.prototype, "scoreVar", void 0);
+__decorate([
+	ApiProperty({
+		description: "Alternative expiry date",
+		type: Date
+	}),
+	IsDate(),
+	Type(() => Date),
+	__decorateMetadata("design:type", typeof (_ref = typeof Date !== "undefined" && Date) === "function" ? _ref : Object)
+], WorldEvent.prototype, "altExpiry", void 0);
+__decorate([
+	ApiProperty({
+		description: "Alternative activation date",
+		type: Date
+	}),
+	IsDate(),
+	Type(() => Date),
+	__decorateMetadata("design:type", typeof (_ref2 = typeof Date !== "undefined" && Date) === "function" ? _ref2 : Object)
+], WorldEvent.prototype, "altActivation", void 0);
+__decorate([
+	ApiProperty({
+		description: "Next alternative cycle dates",
+		type: "object"
+	}),
+	IsObject(),
+	ValidateNested(),
+	__decorateMetadata("design:type", Object)
+], WorldEvent.prototype, "nextAlt", void 0);
+__decorate([
+	ApiPropertyOptional({ description: "Affiliated syndicate, if any" }),
+	IsOptional(),
+	IsString(),
+	__decorateMetadata("design:type", String)
+], WorldEvent.prototype, "affiliatedWith", void 0);
+__decorate([
+	ApiProperty({ description: "The event's tag" }),
+	IsString(),
+	__decorateMetadata("design:type", String)
+], WorldEvent.prototype, "tag", void 0);
+__decorate([
+	ApiPropertyOptional({ description: "Victim identifier, if any" }),
+	IsOptional(),
+	IsString(),
+	__decorateMetadata("design:type", String)
+], WorldEvent.prototype, "victim", void 0);
 //#endregion
-export { WorldEvent };
+export { WorldEvent };

package/dist/lib/models/WorldStateObject.d.mts

@@ -1,48 +1,2 @@
-import { ContentTimestamp } from "warframe-worldstate-data/utilities";
-
-//#region lib/models/WorldStateObject.d.ts
-interface Identifier {
-  $id?: string;
-  $oid?: string;
-}
-interface BaseContentObject {
-  _id?: Identifier;
-  Activation?: ContentTimestamp;
-  Expiry?: ContentTimestamp;
-}
-/**
- * Represents a generic object from WorldState
- */
-declare class WorldStateObject {
-  /**
-   * The object's id field
-   */
-  id?: string;
-  /**
-   * The date and time at which the WorldStateObject started
-   */
-  activation?: Date;
-  /**
-   * The date and time at which the WorldStateObject ends
-   */
-  expiry?: Date;
-  /**
-   * @param data The object data
-   */
-  constructor(data: BaseContentObject);
-  /**
-   * Whether the void trader is active (at time of object creation)
-   */
-  get active(): boolean;
-  /**
-   * A string indicating how long it will take for the trader to arrive
-   *  (at time of object creation)
-   */
-  get startString(): string | undefined;
-  /**
-   * Time delta string from now to the end
-   */
-  get endString(): string | undefined;
-}
-//#endregion
+import { n as Identifier, r as WorldStateObject, t as BaseContentObject } from "../../WorldStateObject-BgeCocs9.mjs";
 export { BaseContentObject, Identifier, WorldStateObject };

package/dist/lib/models/WorldStateObject.mjs

@@ -1,6 +1,9 @@
+import { n as __decorateMetadata, t as __decorate } from "../../decorate-CltSo06_.mjs";
+import { ApiPropertyOptional } from "@nestjs/swagger";
+import { IsDate, IsOptional, IsString } from "class-validator";
 import { fromNow, insist, parseDate, timeDeltaToString } from "warframe-worldstate-data/utilities";
-
 //#region lib/models/WorldStateObject.ts
+var _ref, _ref2;
 /**
 * Represents a generic object from WorldState
 */
@@ -49,6 +52,29 @@ var WorldStateObject = class {
 		return timeDeltaToString(fromNow(this.expiry));
 	}
 };
-
+__decorate([
+	ApiPropertyOptional({ description: "The unique identifier for this world state object" }),
+	IsOptional(),
+	IsString(),
+	__decorateMetadata("design:type", String)
+], WorldStateObject.prototype, "id", void 0);
+__decorate([
+	ApiPropertyOptional({
+		description: "The date and time when this object becomes active",
+		type: Date
+	}),
+	IsOptional(),
+	IsDate(),
+	__decorateMetadata("design:type", typeof (_ref = typeof Date !== "undefined" && Date) === "function" ? _ref : Object)
+], WorldStateObject.prototype, "activation", void 0);
+__decorate([
+	ApiPropertyOptional({
+		description: "The date and time when this object expires",
+		type: Date
+	}),
+	IsOptional(),
+	IsDate(),
+	__decorateMetadata("design:type", typeof (_ref2 = typeof Date !== "undefined" && Date) === "function" ? _ref2 : Object)
+], WorldStateObject.prototype, "expiry", void 0);
 //#endregion
-export { WorldStateObject };
+export { WorldStateObject };

package/dist/lib/models/ZarimanCycle.d.mts

@@ -1,45 +1,2 @@
-import { WorldStateObject } from "./WorldStateObject.mjs";
-
-//#region lib/models/ZarimanCycle.d.ts
-interface CurrentZarimanCycle {
-  isCorpus: boolean;
-  timeLeft: string;
-  expiry: Date;
-  expiresIn: number;
-  state: string;
-  start: number;
-}
-/**
- * Represents the current Zariman Corpus/Grineer Cycle
- * @augments {WorldStateObject}
- */
-declare class ZarimanCycle extends WorldStateObject {
-  #private;
-  /**
-   * Whether or not this it's corpus or grineer
-   */
-  isCorpus: boolean;
-  /**
-   * Current cycle state. One of `corpus`, `grineer`
-   */
-  state: string;
-  /**
-   * Time remaining string
-   */
-  timeLeft: string;
-  /**
-   * @param {Date} bountiesEndDate The current Zariman cycle expiry
-   */
-  constructor(bountiesEndDate: Date);
-  /**
-   * Whether this is expired
-   */
-  get expired(): boolean;
-  getCurrentZarimanCycle(): CurrentZarimanCycle;
-  /**
-   * The event's string representation
-   */
-  get shortString(): string;
-}
-//#endregion
+import { n as ZarimanCycle, t as CurrentZarimanCycle } from "../../ZarimanCycle-D4YCSLmR.mjs";
 export { CurrentZarimanCycle, ZarimanCycle };

package/dist/lib/models/ZarimanCycle.mjs

@@ -1,6 +1,8 @@
+import { n as __decorateMetadata, t as __decorate } from "../../decorate-CltSo06_.mjs";
 import { WorldStateObject } from "./WorldStateObject.mjs";
+import { ApiProperty } from "@nestjs/swagger";
+import { IsBoolean, IsString } from "class-validator";
 import { fromNow, timeDeltaToString } from "warframe-worldstate-data/utilities";
-
 //#region lib/models/ZarimanCycle.ts
 const corpusTimeMillis = 16551828e5;
 const fullCycle = 18e6;
@@ -74,6 +76,20 @@ var ZarimanCycle = class extends WorldStateObject {
 		return `${this.timeLeft.replace(/\s\d*s/gi, "")} to ${this.isCorpus ? "grineer" : "corpus"}`;
 	}
 };
-
+__decorate([
+	ApiProperty({ description: "Whether or not it is currently Corpus (false = Grineer)" }),
+	IsBoolean(),
+	__decorateMetadata("design:type", Boolean)
+], ZarimanCycle.prototype, "isCorpus", void 0);
+__decorate([
+	ApiProperty({ description: "Current cycle state. One of 'corpus', 'grineer'" }),
+	IsString(),
+	__decorateMetadata("design:type", String)
+], ZarimanCycle.prototype, "state", void 0);
+__decorate([
+	ApiProperty({ description: "Time remaining in the current cycle" }),
+	IsString(),
+	__decorateMetadata("design:type", String)
+], ZarimanCycle.prototype, "timeLeft", void 0);
 //#endregion
-export { ZarimanCycle };
+export { ZarimanCycle };