@kayahr/edsm 1.1.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 (84) hide show
  1. package/LICENSE.md +22 -0
  2. package/README.md +168 -0
  3. package/lib/body.schema.json +587 -0
  4. package/lib/codex.schema.json +55 -0
  5. package/lib/commander-credits-response.schema.json +52 -0
  6. package/lib/commander-inventory-response.schema.json +91 -0
  7. package/lib/commander-position-response.schema.json +101 -0
  8. package/lib/commander-ranks-response.schema.json +138 -0
  9. package/lib/elite-server-status-response.schema.json +38 -0
  10. package/lib/flight-logs-response.schema.json +68 -0
  11. package/lib/main/api/commander.d.ts +96 -0
  12. package/lib/main/api/commander.js +38 -0
  13. package/lib/main/api/commander.js.map +1 -0
  14. package/lib/main/api/common.d.ts +28 -0
  15. package/lib/main/api/common.js +54 -0
  16. package/lib/main/api/common.js.map +1 -0
  17. package/lib/main/api/journal.d.ts +51 -0
  18. package/lib/main/api/journal.js +35 -0
  19. package/lib/main/api/journal.js.map +1 -0
  20. package/lib/main/api/logs.d.ts +130 -0
  21. package/lib/main/api/logs.js +60 -0
  22. package/lib/main/api/logs.js.map +1 -0
  23. package/lib/main/api/status.d.ts +13 -0
  24. package/lib/main/api/status.js +14 -0
  25. package/lib/main/api/status.js.map +1 -0
  26. package/lib/main/api/system.d.ts +279 -0
  27. package/lib/main/api/system.js +125 -0
  28. package/lib/main/api/system.js.map +1 -0
  29. package/lib/main/api/systems.d.ts +148 -0
  30. package/lib/main/api/systems.js +51 -0
  31. package/lib/main/api/systems.js.map +1 -0
  32. package/lib/main/bodies.d.ts +116 -0
  33. package/lib/main/bodies.js +33 -0
  34. package/lib/main/bodies.js.map +1 -0
  35. package/lib/main/codex.d.ts +20 -0
  36. package/lib/main/codex.js +15 -0
  37. package/lib/main/codex.js.map +1 -0
  38. package/lib/main/common.d.ts +14 -0
  39. package/lib/main/common.js +20 -0
  40. package/lib/main/common.js.map +1 -0
  41. package/lib/main/index.d.ts +14 -0
  42. package/lib/main/index.js +19 -0
  43. package/lib/main/index.js.map +1 -0
  44. package/lib/main/powerplay.d.ts +23 -0
  45. package/lib/main/powerplay.js +15 -0
  46. package/lib/main/powerplay.js.map +1 -0
  47. package/lib/main/stations.d.ts +69 -0
  48. package/lib/main/stations.js +15 -0
  49. package/lib/main/stations.js.map +1 -0
  50. package/lib/main/systems.d.ts +61 -0
  51. package/lib/main/systems.js +15 -0
  52. package/lib/main/systems.js.map +1 -0
  53. package/lib/main/util.d.ts +38 -0
  54. package/lib/main/util.js +104 -0
  55. package/lib/main/util.js.map +1 -0
  56. package/lib/powerplay.schema.json +90 -0
  57. package/lib/station-market-response.schema.json +95 -0
  58. package/lib/station-outfitting-response.schema.json +75 -0
  59. package/lib/station-shipyard-response.schema.json +72 -0
  60. package/lib/station.schema.json +315 -0
  61. package/lib/system-bodies-response.schema.json +609 -0
  62. package/lib/system-deaths-response.schema.json +58 -0
  63. package/lib/system-estimated-value-response.schema.json +76 -0
  64. package/lib/system-factions-response.schema.json +313 -0
  65. package/lib/system-response.schema.json +137 -0
  66. package/lib/system-stations-response.schema.json +222 -0
  67. package/lib/system-traffic-response.schema.json +85 -0
  68. package/lib/system.schema.json +1016 -0
  69. package/package.json +82 -0
  70. package/src/main/api/commander.ts +116 -0
  71. package/src/main/api/common.ts +77 -0
  72. package/src/main/api/journal.ts +76 -0
  73. package/src/main/api/logs.ts +166 -0
  74. package/src/main/api/status.ts +24 -0
  75. package/src/main/api/system.ts +361 -0
  76. package/src/main/api/systems.ts +199 -0
  77. package/src/main/bodies.ts +153 -0
  78. package/src/main/codex.ts +31 -0
  79. package/src/main/common.ts +29 -0
  80. package/src/main/index.ts +42 -0
  81. package/src/main/powerplay.ts +34 -0
  82. package/src/main/stations.ts +87 -0
  83. package/src/main/systems.ts +77 -0
  84. package/src/main/util.ts +103 -0
@@ -0,0 +1,587 @@
1
+ {
2
+ "$ref": "#/definitions/Body",
3
+ "$schema": "http://json-schema.org/draft-07/schema#",
4
+ "definitions": {
5
+ "Asteroids": {
6
+ "additionalProperties": false,
7
+ "description": "EDSM data about asteroid ring/belt.",
8
+ "properties": {
9
+ "innerRadius": {
10
+ "type": "number"
11
+ },
12
+ "mass": {
13
+ "type": "number"
14
+ },
15
+ "name": {
16
+ "type": "string"
17
+ },
18
+ "outerRadius": {
19
+ "type": "number"
20
+ },
21
+ "type": {
22
+ "type": "string"
23
+ }
24
+ },
25
+ "required": [
26
+ "name",
27
+ "type",
28
+ "mass",
29
+ "innerRadius",
30
+ "outerRadius"
31
+ ],
32
+ "type": "object"
33
+ },
34
+ "AtmosphereComposition": {
35
+ "$ref": "#/definitions/Record%3Cstring%2Cnumber%3E",
36
+ "description": "EDSM data about atmosphere composition of a planet."
37
+ },
38
+ "Body": {
39
+ "anyOf": [
40
+ {
41
+ "$ref": "#/definitions/Planet"
42
+ },
43
+ {
44
+ "$ref": "#/definitions/Star"
45
+ }
46
+ ],
47
+ "description": "Union type for EDSM star and planet data."
48
+ },
49
+ "Id64": {
50
+ "description": "A 64 bit ID. Can be a `number` if ID does not need more then 53 bit. Must be `bigint` if ID needs more than 53 bit.",
51
+ "type": [
52
+ "number"
53
+ ]
54
+ },
55
+ "Materials": {
56
+ "$ref": "#/definitions/Record%3Cstring%2Cnumber%3E",
57
+ "description": "EDSM data about raw materials on a planet."
58
+ },
59
+ "Planet": {
60
+ "additionalProperties": false,
61
+ "description": "EDSM planet data.",
62
+ "properties": {
63
+ "argOfPeriapsis": {
64
+ "type": [
65
+ "number",
66
+ "null"
67
+ ]
68
+ },
69
+ "atmosphereComposition": {
70
+ "anyOf": [
71
+ {
72
+ "$ref": "#/definitions/AtmosphereComposition"
73
+ },
74
+ {
75
+ "type": "null"
76
+ }
77
+ ]
78
+ },
79
+ "atmosphereType": {
80
+ "type": [
81
+ "string",
82
+ "null"
83
+ ]
84
+ },
85
+ "axialTilt": {
86
+ "type": [
87
+ "number",
88
+ "null"
89
+ ]
90
+ },
91
+ "belts": {
92
+ "items": {
93
+ "$ref": "#/definitions/Asteroids"
94
+ },
95
+ "type": "array"
96
+ },
97
+ "bodyId": {
98
+ "type": [
99
+ "number",
100
+ "null"
101
+ ]
102
+ },
103
+ "discovery": {
104
+ "additionalProperties": false,
105
+ "properties": {
106
+ "commander": {
107
+ "type": "string"
108
+ },
109
+ "date": {
110
+ "type": "string"
111
+ }
112
+ },
113
+ "required": [
114
+ "commander",
115
+ "date"
116
+ ],
117
+ "type": "object"
118
+ },
119
+ "distanceToArrival": {
120
+ "type": "number"
121
+ },
122
+ "earthMasses": {
123
+ "type": "number"
124
+ },
125
+ "gravity": {
126
+ "type": "number"
127
+ },
128
+ "id": {
129
+ "type": "number"
130
+ },
131
+ "id64": {
132
+ "anyOf": [
133
+ {
134
+ "$ref": "#/definitions/Id64"
135
+ },
136
+ {
137
+ "type": "null"
138
+ }
139
+ ]
140
+ },
141
+ "isLandable": {
142
+ "type": "boolean"
143
+ },
144
+ "materials": {
145
+ "$ref": "#/definitions/Materials"
146
+ },
147
+ "name": {
148
+ "type": "string"
149
+ },
150
+ "orbitalEccentricity": {
151
+ "type": [
152
+ "number",
153
+ "null"
154
+ ]
155
+ },
156
+ "orbitalInclination": {
157
+ "type": [
158
+ "number",
159
+ "null"
160
+ ]
161
+ },
162
+ "orbitalPeriod": {
163
+ "type": [
164
+ "number",
165
+ "null"
166
+ ]
167
+ },
168
+ "parents": {
169
+ "anyOf": [
170
+ {
171
+ "type": "null"
172
+ },
173
+ {
174
+ "items": {
175
+ "anyOf": [
176
+ {
177
+ "additionalProperties": false,
178
+ "properties": {
179
+ "Star": {
180
+ "type": "number"
181
+ }
182
+ },
183
+ "required": [
184
+ "Star"
185
+ ],
186
+ "type": "object"
187
+ },
188
+ {
189
+ "additionalProperties": false,
190
+ "properties": {
191
+ "Planet": {
192
+ "type": "number"
193
+ }
194
+ },
195
+ "required": [
196
+ "Planet"
197
+ ],
198
+ "type": "object"
199
+ },
200
+ {
201
+ "additionalProperties": false,
202
+ "properties": {
203
+ "Null": {
204
+ "type": "number"
205
+ }
206
+ },
207
+ "required": [
208
+ "Null"
209
+ ],
210
+ "type": "object"
211
+ }
212
+ ]
213
+ },
214
+ "type": "array"
215
+ }
216
+ ]
217
+ },
218
+ "radius": {
219
+ "type": "number"
220
+ },
221
+ "reserveLevel": {
222
+ "type": [
223
+ "string",
224
+ "null"
225
+ ]
226
+ },
227
+ "rings": {
228
+ "items": {
229
+ "$ref": "#/definitions/Asteroids"
230
+ },
231
+ "type": "array"
232
+ },
233
+ "rotationalPeriod": {
234
+ "type": [
235
+ "number",
236
+ "null"
237
+ ]
238
+ },
239
+ "rotationalPeriodTidallyLocked": {
240
+ "type": "boolean"
241
+ },
242
+ "semiMajorAxis": {
243
+ "type": [
244
+ "number",
245
+ "null"
246
+ ]
247
+ },
248
+ "solidComposition": {
249
+ "anyOf": [
250
+ {
251
+ "$ref": "#/definitions/SolidComposition"
252
+ },
253
+ {
254
+ "type": "null"
255
+ }
256
+ ]
257
+ },
258
+ "subType": {
259
+ "type": "string"
260
+ },
261
+ "surfacePressure": {
262
+ "type": [
263
+ "number",
264
+ "null"
265
+ ]
266
+ },
267
+ "surfaceTemperature": {
268
+ "type": "number"
269
+ },
270
+ "systemId": {
271
+ "type": "number"
272
+ },
273
+ "systemId64": {
274
+ "$ref": "#/definitions/Id64"
275
+ },
276
+ "systemName": {
277
+ "type": "string"
278
+ },
279
+ "terraformingState": {
280
+ "type": [
281
+ "string",
282
+ "null"
283
+ ]
284
+ },
285
+ "type": {
286
+ "const": "Planet",
287
+ "type": "string"
288
+ },
289
+ "updateTime": {
290
+ "type": "string"
291
+ },
292
+ "volcanismType": {
293
+ "type": [
294
+ "string",
295
+ "null"
296
+ ]
297
+ }
298
+ },
299
+ "required": [
300
+ "argOfPeriapsis",
301
+ "atmosphereComposition",
302
+ "atmosphereType",
303
+ "axialTilt",
304
+ "bodyId",
305
+ "distanceToArrival",
306
+ "earthMasses",
307
+ "gravity",
308
+ "id",
309
+ "id64",
310
+ "isLandable",
311
+ "name",
312
+ "orbitalEccentricity",
313
+ "orbitalInclination",
314
+ "orbitalPeriod",
315
+ "parents",
316
+ "radius",
317
+ "rotationalPeriod",
318
+ "rotationalPeriodTidallyLocked",
319
+ "semiMajorAxis",
320
+ "solidComposition",
321
+ "subType",
322
+ "surfacePressure",
323
+ "surfaceTemperature",
324
+ "systemId",
325
+ "systemId64",
326
+ "systemName",
327
+ "terraformingState",
328
+ "type",
329
+ "updateTime",
330
+ "volcanismType"
331
+ ],
332
+ "type": "object"
333
+ },
334
+ "Record<string,number>": {
335
+ "additionalProperties": {
336
+ "type": "number"
337
+ },
338
+ "type": "object"
339
+ },
340
+ "SolidComposition": {
341
+ "$ref": "#/definitions/Record%3Cstring%2Cnumber%3E",
342
+ "description": "EDSM data about solid composition of a planet."
343
+ },
344
+ "Star": {
345
+ "additionalProperties": false,
346
+ "description": "EDSM star data.",
347
+ "properties": {
348
+ "absoluteMagnitude": {
349
+ "type": "number"
350
+ },
351
+ "age": {
352
+ "type": "number"
353
+ },
354
+ "argOfPeriapsis": {
355
+ "type": [
356
+ "number",
357
+ "null"
358
+ ]
359
+ },
360
+ "axialTilt": {
361
+ "type": [
362
+ "number",
363
+ "null"
364
+ ]
365
+ },
366
+ "belts": {
367
+ "items": {
368
+ "$ref": "#/definitions/Asteroids"
369
+ },
370
+ "type": "array"
371
+ },
372
+ "bodyId": {
373
+ "type": [
374
+ "number",
375
+ "null"
376
+ ]
377
+ },
378
+ "discovery": {
379
+ "additionalProperties": false,
380
+ "properties": {
381
+ "commander": {
382
+ "type": "string"
383
+ },
384
+ "date": {
385
+ "type": "string"
386
+ }
387
+ },
388
+ "required": [
389
+ "commander",
390
+ "date"
391
+ ],
392
+ "type": "object"
393
+ },
394
+ "distanceToArrival": {
395
+ "type": "number"
396
+ },
397
+ "id": {
398
+ "type": "number"
399
+ },
400
+ "id64": {
401
+ "anyOf": [
402
+ {
403
+ "$ref": "#/definitions/Id64"
404
+ },
405
+ {
406
+ "type": "null"
407
+ }
408
+ ]
409
+ },
410
+ "isMainStar": {
411
+ "type": "boolean"
412
+ },
413
+ "isScoopable": {
414
+ "type": "boolean"
415
+ },
416
+ "luminosity": {
417
+ "type": [
418
+ "string",
419
+ "null"
420
+ ]
421
+ },
422
+ "name": {
423
+ "type": "string"
424
+ },
425
+ "orbitalEccentricity": {
426
+ "type": [
427
+ "number",
428
+ "null"
429
+ ]
430
+ },
431
+ "orbitalInclination": {
432
+ "type": [
433
+ "number",
434
+ "null"
435
+ ]
436
+ },
437
+ "orbitalPeriod": {
438
+ "type": [
439
+ "number",
440
+ "null"
441
+ ]
442
+ },
443
+ "parents": {
444
+ "anyOf": [
445
+ {
446
+ "type": "null"
447
+ },
448
+ {
449
+ "items": {
450
+ "anyOf": [
451
+ {
452
+ "additionalProperties": false,
453
+ "properties": {
454
+ "Star": {
455
+ "type": "number"
456
+ }
457
+ },
458
+ "required": [
459
+ "Star"
460
+ ],
461
+ "type": "object"
462
+ },
463
+ {
464
+ "additionalProperties": false,
465
+ "properties": {
466
+ "Planet": {
467
+ "type": "number"
468
+ }
469
+ },
470
+ "required": [
471
+ "Planet"
472
+ ],
473
+ "type": "object"
474
+ },
475
+ {
476
+ "additionalProperties": false,
477
+ "properties": {
478
+ "Null": {
479
+ "type": "number"
480
+ }
481
+ },
482
+ "required": [
483
+ "Null"
484
+ ],
485
+ "type": "object"
486
+ }
487
+ ]
488
+ },
489
+ "type": "array"
490
+ }
491
+ ]
492
+ },
493
+ "reserveLevel": {
494
+ "type": [
495
+ "string",
496
+ "null"
497
+ ]
498
+ },
499
+ "rings": {
500
+ "items": {
501
+ "$ref": "#/definitions/Asteroids"
502
+ },
503
+ "type": "array"
504
+ },
505
+ "rotationalPeriod": {
506
+ "type": [
507
+ "number",
508
+ "null"
509
+ ]
510
+ },
511
+ "rotationalPeriodTidallyLocked": {
512
+ "type": "boolean"
513
+ },
514
+ "semiMajorAxis": {
515
+ "type": [
516
+ "number",
517
+ "null"
518
+ ]
519
+ },
520
+ "solarMasses": {
521
+ "type": "number"
522
+ },
523
+ "solarRadius": {
524
+ "type": "number"
525
+ },
526
+ "spectralClass": {
527
+ "type": [
528
+ "string",
529
+ "null"
530
+ ]
531
+ },
532
+ "subType": {
533
+ "type": "string"
534
+ },
535
+ "surfaceTemperature": {
536
+ "type": "number"
537
+ },
538
+ "systemId": {
539
+ "type": "number"
540
+ },
541
+ "systemId64": {
542
+ "$ref": "#/definitions/Id64"
543
+ },
544
+ "systemName": {
545
+ "type": "string"
546
+ },
547
+ "type": {
548
+ "const": "Star",
549
+ "type": "string"
550
+ },
551
+ "updateTime": {
552
+ "type": "string"
553
+ }
554
+ },
555
+ "required": [
556
+ "absoluteMagnitude",
557
+ "age",
558
+ "argOfPeriapsis",
559
+ "axialTilt",
560
+ "bodyId",
561
+ "distanceToArrival",
562
+ "id",
563
+ "id64",
564
+ "luminosity",
565
+ "name",
566
+ "orbitalEccentricity",
567
+ "orbitalInclination",
568
+ "orbitalPeriod",
569
+ "parents",
570
+ "rotationalPeriod",
571
+ "rotationalPeriodTidallyLocked",
572
+ "semiMajorAxis",
573
+ "solarMasses",
574
+ "solarRadius",
575
+ "spectralClass",
576
+ "subType",
577
+ "surfaceTemperature",
578
+ "systemId",
579
+ "systemId64",
580
+ "systemName",
581
+ "type",
582
+ "updateTime"
583
+ ],
584
+ "type": "object"
585
+ }
586
+ }
587
+ }
@@ -0,0 +1,55 @@
1
+ {
2
+ "$ref": "#/definitions/Codex",
3
+ "$schema": "http://json-schema.org/draft-07/schema#",
4
+ "definitions": {
5
+ "Codex": {
6
+ "additionalProperties": false,
7
+ "description": "Single EDSM codex.",
8
+ "properties": {
9
+ "name": {
10
+ "type": [
11
+ "string",
12
+ "number"
13
+ ]
14
+ },
15
+ "region": {
16
+ "type": "string"
17
+ },
18
+ "reportedOn": {
19
+ "type": "string"
20
+ },
21
+ "systemId": {
22
+ "type": "number"
23
+ },
24
+ "systemId64": {
25
+ "$ref": "#/definitions/Id64"
26
+ },
27
+ "systemName": {
28
+ "type": "string"
29
+ },
30
+ "type": {
31
+ "type": [
32
+ "string",
33
+ "null"
34
+ ]
35
+ }
36
+ },
37
+ "required": [
38
+ "systemId",
39
+ "systemId64",
40
+ "systemName",
41
+ "region",
42
+ "type",
43
+ "name",
44
+ "reportedOn"
45
+ ],
46
+ "type": "object"
47
+ },
48
+ "Id64": {
49
+ "description": "A 64 bit ID. Can be a `number` if ID does not need more then 53 bit. Must be `bigint` if ID needs more than 53 bit.",
50
+ "type": [
51
+ "number"
52
+ ]
53
+ }
54
+ }
55
+ }
@@ -0,0 +1,52 @@
1
+ {
2
+ "$ref": "#/definitions/CommanderCreditsResponse",
3
+ "$schema": "http://json-schema.org/draft-07/schema#",
4
+ "definitions": {
5
+ "CommanderCreditsResponse": {
6
+ "additionalProperties": false,
7
+ "description": "Commander credits response returned by {@link getCommanderCredits } request.",
8
+ "properties": {
9
+ "credits": {
10
+ "items": {
11
+ "additionalProperties": false,
12
+ "properties": {
13
+ "balance": {
14
+ "type": "number"
15
+ },
16
+ "date": {
17
+ "type": "string"
18
+ },
19
+ "loan": {
20
+ "type": "number"
21
+ }
22
+ },
23
+ "required": [
24
+ "balance",
25
+ "loan",
26
+ "date"
27
+ ],
28
+ "type": "object"
29
+ },
30
+ "type": "array"
31
+ },
32
+ "period": {
33
+ "$ref": "#/definitions/CreditsPeriod"
34
+ }
35
+ },
36
+ "required": [
37
+ "credits"
38
+ ],
39
+ "type": "object"
40
+ },
41
+ "CreditsPeriod": {
42
+ "description": "Credits period type",
43
+ "enum": [
44
+ "7DAY",
45
+ "1MONTH",
46
+ "3MONTH",
47
+ "6MONTH"
48
+ ],
49
+ "type": "string"
50
+ }
51
+ }
52
+ }