warframe-worldstate-parser 2.31.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (98) hide show
  1. package/README.md +1 -0
  2. package/lib/WorldState.js +60 -94
  3. package/lib/models/Alert.js +18 -44
  4. package/lib/models/CambionCycle.js +8 -12
  5. package/lib/models/CetusCycle.js +34 -54
  6. package/lib/models/ChallengeInstance.js +11 -14
  7. package/lib/models/ConclaveChallenge.js +24 -44
  8. package/lib/models/ConstructionProgress.js +10 -22
  9. package/lib/models/DailyDeal.js +15 -34
  10. package/lib/models/DarkSector.js +14 -25
  11. package/lib/models/DarkSectorBattle.js +6 -8
  12. package/lib/models/DuviriCycle.js +9 -10
  13. package/lib/models/EarthCycle.js +36 -35
  14. package/lib/models/Fissure.js +36 -44
  15. package/lib/models/FlashSale.js +17 -37
  16. package/lib/models/GlobalUpgrade.js +23 -41
  17. package/lib/models/Invasion.js +37 -79
  18. package/lib/models/Kuva.js +20 -26
  19. package/lib/models/Mission.js +28 -38
  20. package/lib/models/News.js +34 -54
  21. package/lib/models/Nightwave.js +22 -48
  22. package/lib/models/NightwaveChallenge.js +19 -17
  23. package/lib/models/PersistentEnemy.js +21 -30
  24. package/lib/models/Reward.js +18 -20
  25. package/lib/models/SentientOutpost.js +11 -12
  26. package/lib/models/Simaris.js +9 -21
  27. package/lib/models/Sortie.js +36 -54
  28. package/lib/models/SortieVariant.js +23 -25
  29. package/lib/models/SteelPathOffering.js +26 -9
  30. package/lib/models/SyndicateJob.js +20 -30
  31. package/lib/models/SyndicateMission.js +22 -52
  32. package/lib/models/VallisCycle.js +37 -45
  33. package/lib/models/VoidTrader.js +35 -54
  34. package/lib/models/VoidTraderItem.js +5 -8
  35. package/lib/models/VoidTraderSchedule.js +7 -6
  36. package/lib/models/WeeklyChallenge.js +9 -17
  37. package/lib/models/WorldEvent.js +49 -74
  38. package/lib/models/WorldstateObject.js +23 -34
  39. package/lib/models/ZarimanCycle.js +34 -54
  40. package/lib/supporting/Dependency.js +2 -11
  41. package/lib/supporting/DuviriChoice.js +1 -5
  42. package/lib/supporting/ExternalMission.js +2 -6
  43. package/lib/supporting/MarkdownSettings.js +15 -19
  44. package/lib/supporting/RewardData.js +4 -6
  45. package/lib/supporting/RewardTypes.js +2 -4
  46. package/lib/utilities/integrity.js +11 -0
  47. package/lib/utilities/timeDate.js +16 -18
  48. package/lib/utilities/translation.js +188 -56
  49. package/main.js +2 -2
  50. package/package.json +3 -5
  51. package/types/lib/WorldState.d.ts +39 -28
  52. package/types/lib/models/Alert.d.ts +13 -24
  53. package/types/lib/models/CambionCycle.d.ts +5 -10
  54. package/types/lib/models/CetusCycle.d.ts +8 -26
  55. package/types/lib/models/ChallengeInstance.d.ts +7 -9
  56. package/types/lib/models/ConclaveChallenge.d.ts +11 -24
  57. package/types/lib/models/ConstructionProgress.d.ts +5 -16
  58. package/types/lib/models/DailyDeal.d.ts +7 -26
  59. package/types/lib/models/DarkSector.d.ts +11 -22
  60. package/types/lib/models/DarkSectorBattle.d.ts +3 -6
  61. package/types/lib/models/DuviriCycle.d.ts +5 -11
  62. package/types/lib/models/EarthCycle.d.ts +40 -17
  63. package/types/lib/models/Fissure.d.ts +10 -17
  64. package/types/lib/models/FlashSale.d.ts +8 -29
  65. package/types/lib/models/GlobalUpgrade.d.ts +8 -27
  66. package/types/lib/models/Invasion.d.ts +18 -53
  67. package/types/lib/models/Kuva.d.ts +10 -21
  68. package/types/lib/models/Mission.d.ts +11 -23
  69. package/types/lib/models/News.d.ts +18 -31
  70. package/types/lib/models/Nightwave.d.ts +12 -29
  71. package/types/lib/models/NightwaveChallenge.d.ts +14 -14
  72. package/types/lib/models/PersistentEnemy.d.ts +9 -20
  73. package/types/lib/models/Reward.d.ts +34 -18
  74. package/types/lib/models/SentientOutpost.d.ts +9 -13
  75. package/types/lib/models/Simaris.d.ts +6 -17
  76. package/types/lib/models/Sortie.d.ts +16 -25
  77. package/types/lib/models/SortieVariant.d.ts +13 -15
  78. package/types/lib/models/SteelPathOffering.d.ts +5 -8
  79. package/types/lib/models/SyndicateJob.d.ts +13 -14
  80. package/types/lib/models/SyndicateMission.d.ts +9 -22
  81. package/types/lib/models/VallisCycle.d.ts +28 -18
  82. package/types/lib/models/VoidTrader.d.ts +8 -21
  83. package/types/lib/models/VoidTraderItem.d.ts +4 -6
  84. package/types/lib/models/VoidTraderSchedule.d.ts +5 -8
  85. package/types/lib/models/WeeklyChallenge.d.ts +5 -14
  86. package/types/lib/models/WorldEvent.d.ts +38 -52
  87. package/types/lib/models/WorldstateObject.d.ts +50 -28
  88. package/types/lib/models/ZarimanCycle.d.ts +9 -27
  89. package/types/lib/supporting/Dependency.d.ts +2 -8
  90. package/types/lib/supporting/DuviriChoice.d.ts +1 -2
  91. package/types/lib/supporting/ExternalMission.d.ts +3 -7
  92. package/types/lib/supporting/MarkdownSettings.d.ts +29 -15
  93. package/types/lib/supporting/RewardData.d.ts +8 -2
  94. package/types/lib/supporting/RewardTypes.d.ts +2 -2
  95. package/types/lib/utilities/integrity.d.ts +1 -0
  96. package/types/lib/utilities/timeDate.d.ts +19 -12
  97. package/types/lib/utilities/translation.d.ts +188 -23
  98. package/types/main.d.ts +2 -4
@@ -1,27 +1,192 @@
1
+ /**
2
+ * Rough Titlecase!
3
+ * @param {string} str string to be titlecased
4
+ * @returns {string} titlecased string
5
+ */
6
+ export function toTitleCase(str: string): string;
7
+ /**
8
+ * Utility function to split the resource name and return somewhat human-readable string
9
+ * @param {string} str localization resource key
10
+ * @returns {string} human-readable string
11
+ */
12
+ export function splitResourceName(str: string): string;
13
+ /**
14
+ *
15
+ * @param {string} key - The data key
16
+ * @param {string} dataOverride locale for use with translation
17
+ * @returns {string} faction name
18
+ */
19
+ export function faction(key: string, dataOverride: string): string;
20
+ /**
21
+ *
22
+ * @param {string} key - The data key
23
+ * @param {string} dataOverride locale for use with translation
24
+ * @returns {string} node name
25
+ */
26
+ export function node(key: string, dataOverride: string): string;
27
+ /**
28
+ *
29
+ * @param {string} key - The data key
30
+ * @param {string} dataOverride locale for use with translation
31
+ * @returns {string} mission type of the node
32
+ */
33
+ export function nodeMissionType(key: string, dataOverride: string): string;
34
+ /**
35
+ *
36
+ * @param {string} key - The data key
37
+ * @param {string} dataOverride locale for use with translation
38
+ * @returns {string} faction that controls the node
39
+ */
40
+ export function nodeEnemy(key: string, dataOverride: string): string;
41
+ /**
42
+ *
43
+ * @param {string} key - The data key
44
+ * @param {string} dataOverride locale for use with translation
45
+ * @returns {string} localization for language string
46
+ */
47
+ export function languageString(key: string, dataOverride: string): string;
48
+ /**
49
+ *
50
+ * @param {string} key - The data key
51
+ * @param {string} dataOverride locale for use with translation
52
+ * @returns {string} localization for language description
53
+ */
54
+ export function languageDesc(key: string, dataOverride: string): string;
55
+ /**
56
+ *
57
+ * @param {string} key - The data key
58
+ * @param {string} dataOverride locale for use with translation
59
+ * @returns {string} translation for mission type
60
+ */
61
+ export function missionType(key: string, dataOverride: string): string;
62
+ /**
63
+ *
64
+ * @param {string} key - The data key
65
+ * @param {string} dataOverride locale for use with translation
66
+ * @returns {string} conclave mode
67
+ */
68
+ export function conclaveMode(key: string, dataOverride: string): string;
69
+ /**
70
+ *
71
+ * @param {string} key - The data key
72
+ * @param {string} dataOverride locale for use with translation
73
+ * @returns {string} conclave category
74
+ */
75
+ export function conclaveCategory(key: string, dataOverride: string): string;
76
+ /**
77
+ *
78
+ * @param {string} key - The data key
79
+ * @param {string} dataOverride locale for use with translation
80
+ * @returns {string} fissure modifier data
81
+ */
82
+ export function fissureModifier(key: string, dataOverride: string): string;
83
+ /**
84
+ *
85
+ * @param {string} key - The data key
86
+ * @param {string} dataOverride locale for use with translation
87
+ * @returns {number | string} fissure tier
88
+ */
89
+ export function fissureTier(key: string, dataOverride: string): number | string;
90
+ /**
91
+ *
92
+ * @param {string} key - The data key
93
+ * @param {string} dataOverride locale for use with translation
94
+ * @returns {string} syndicate name
95
+ */
96
+ export function syndicate(key: string, dataOverride: string): string;
97
+ /**
98
+ *
99
+ * @param {string} key - The data key
100
+ * @param {string} dataOverride locale for use with translation
101
+ * @returns {string} upgrade type
102
+ */
103
+ export function upgrade(key: string, dataOverride: string): string;
104
+ /**
105
+ *
106
+ * @param {string} key - The data key
107
+ * @param {string} dataOverride locale for use with translation
108
+ * @returns {string} mathematical operation value
109
+ */
110
+ export function operation(key: string, dataOverride: string): string;
111
+ /**
112
+ *
113
+ * @param {string} key - The data key
114
+ * @param {string} dataOverride locale for use with translation
115
+ * @returns {string} symbol of mathematical operation
116
+ */
117
+ export function operationSymbol(key: string, dataOverride: string): string;
118
+ /**
119
+ * @param {string} key - The data key
120
+ * @param {string} dataOverride locale for use with translation
121
+ * @returns {string} sortie boss name
122
+ */
123
+ export function sortieBoss(key: string, dataOverride: string): string;
124
+ /**
125
+ * @param {string} key - The data key
126
+ * @param {string} dataOverride locale for use with translation
127
+ * @returns {string} faction for a sortie based on the boss
128
+ */
129
+ export function sortieFaction(key: string, dataOverride: string): string;
130
+ /**
131
+ *
132
+ * @param {string} key - The data key
133
+ * @param {string} dataOverride locale for use with translation
134
+ * @returns {string} sortie modifier data
135
+ */
136
+ export function sortieModifier(key: string, dataOverride: string): string;
137
+ /**
138
+ * @param {string} key - The data key
139
+ * @param {string} dataOverride locale for use with translation
140
+ * @returns {string} sortie modifier description
141
+ */
142
+ export function sortieModDesc(key: string, dataOverride: string): string;
143
+ /**
144
+ * Retrieve the localized region for a given key
145
+ * @param {string} key - The region key
146
+ * @param {string} dataOverride - The locale to use for translations
147
+ * @returns {string} localized region name
148
+ */
149
+ export function region(key: string, dataOverride: string): string;
150
+ /**
151
+ * Retrieve conclave challenge name for the given key and locale
152
+ * @param {string} key key to retrieve
153
+ * @param {string} dataOverride locale key override
154
+ * @returns {string} - The conclave challenge name for the given key
155
+ */
156
+ export function conclaveChallenge(key: string, dataOverride: string): string;
157
+ /**
158
+ * Get the steel path data for given key
159
+ * @param {string} dataOverride - The locale to use for translations
160
+ * @returns {string} - The steel path data for the given key
161
+ */
162
+ export function steelPath(dataOverride: string): string;
163
+ declare namespace _default {
164
+ export { faction };
165
+ export { node };
166
+ export { nodeMissionType };
167
+ export { nodeEnemy };
168
+ export { languageString };
169
+ export { languageDesc };
170
+ export { missionType };
171
+ export { conclaveMode };
172
+ export { conclaveCategory };
173
+ export { fissureModifier };
174
+ export { fissureTier };
175
+ export { syndicate };
176
+ export { upgrade };
177
+ export { operation };
178
+ export { operationSymbol };
179
+ export { sortieBoss };
180
+ export { sortieModifier };
181
+ export { sortieModDesc };
182
+ export { sortieFaction };
183
+ export { region };
184
+ export { conclaveChallenge };
185
+ export { steelPath };
186
+ export { toTitleCase };
187
+ }
188
+ export default _default;
1
189
  /**
2
190
  * An object containing functions to convert in-game names to their localizations
3
191
  */
4
192
  export type Translator = Record<string, Function>;
5
- export function faction(key: any, dataOverride: any): any;
6
- export function node(key: any, dataOverride: any): any;
7
- export function nodeMissionType(key: any, dataOverride: any): any;
8
- export function nodeEnemy(key: any, dataOverride: any): any;
9
- export function languageString(key: any, dataOverride: any): any;
10
- export function languageDesc(key: any, dataOverride: any): any;
11
- export function missionType(key: any, dataOverride: any): any;
12
- export function conclaveMode(key: any, dataOverride: any): any;
13
- export function conclaveCategory(key: any, dataOverride: any): any;
14
- export function fissureModifier(key: any, dataOverride: any): any;
15
- export function fissureTier(key: any, dataOverride: any): any;
16
- export function syndicate(key: any, dataOverride: any): any;
17
- export function upgrade(key: any, dataOverride: any): any;
18
- export function operation(key: any, dataOverride: any): any;
19
- export function operationSymbol(key: any, dataOverride: any): any;
20
- export function sortieBoss(key: any, dataOverride: any): any;
21
- export function sortieModifier(key: any, dataOverride: any): any;
22
- export function sortieModDesc(key: any, dataOverride: any): any;
23
- export function sortieFaction(key: any, dataOverride: any): any;
24
- export function region(key: any, dataOverride: any): any;
25
- export function conclaveChallenge(key: any, dataOverride: any): any;
26
- export function steelPath(dataOverride: any): any;
27
- export function toTitleCase(str: any): any;
package/types/main.d.ts CHANGED
@@ -1,4 +1,2 @@
1
- declare const _exports: {
2
- new (json: string, deps?: import("./lib/supporting/Dependency")): import("./lib/WorldState");
3
- };
4
- export = _exports;
1
+ export default WorldState;
2
+ import WorldState from './lib/WorldState.js';