@spacemolt/lib 17.1.0 → 17.2.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.
@@ -970,7 +970,7 @@ export type Base = {
970
970
  */
971
971
  far_system_id?: string;
972
972
  /**
973
- * True once the owners were warned that this end holds fewer than 3 cycles of upkeep, or while building that it stalled; omitted otherwise
973
+ * True while the owners have been warned this end is short of supplies; omitted otherwise
974
974
  */
975
975
  low_supply_warned?: boolean;
976
976
  /**
@@ -982,11 +982,11 @@ export type Base = {
982
982
  */
983
983
  partner_base_id?: string;
984
984
  /**
985
- * Construction phases this end has completed (0-4); 4 means built
985
+ * Construction phases this end has completed
986
986
  */
987
987
  phase?: number;
988
988
  /**
989
- * While building: facility cycles of the current phase done. Once built: upkeep cycles paid so far
989
+ * Facility cycles counted for the current phase or upkeep
990
990
  */
991
991
  phase_cycles?: number;
992
992
  /**
@@ -1470,11 +1470,36 @@ export type BoardingStateLogEntry = {
1470
1470
  target_id?: string;
1471
1471
  };
1472
1472
  export type BrowseShipsResponse = {
1473
+ /**
1474
+ * Base ID of the station browsed. Empty with all_stations.
1475
+ */
1473
1476
  base_id: string;
1477
+ /**
1478
+ * Name of the station browsed. Empty with all_stations.
1479
+ */
1474
1480
  base_name: string;
1475
1481
  buy_orders?: Array<ShipBuyOrderInfo>;
1482
+ /**
1483
+ * Number of listings in this response.
1484
+ */
1476
1485
  count: number;
1477
1486
  listings: Array<ShipListing>;
1487
+ /**
1488
+ * With all_stations: the 1-based page returned. Omitted otherwise.
1489
+ */
1490
+ page?: number;
1491
+ /**
1492
+ * With all_stations: listings per page (default 50, max 100). Omitted otherwise.
1493
+ */
1494
+ page_size?: number;
1495
+ /**
1496
+ * With all_stations: listings matching the filters across every page. Omitted when nothing matches or without all_stations.
1497
+ */
1498
+ total?: number;
1499
+ /**
1500
+ * With all_stations: number of pages (at least 1). Omitted otherwise.
1501
+ */
1502
+ total_pages?: number;
1478
1503
  };
1479
1504
  export type BuildBaseResponse = {
1480
1505
  /**
@@ -2458,7 +2483,7 @@ export type ClientPoiInfo = {
2458
2483
  */
2459
2484
  name: string;
2460
2485
  /**
2461
- * Position in AU from the system center.
2486
+ * Position in AU from the system center. It changes with time.
2462
2487
  */
2463
2488
  position: Position;
2464
2489
  /**
@@ -2475,7 +2500,7 @@ export type ClientSystemInfo = {
2475
2500
  description?: string;
2476
2501
  empire?: string;
2477
2502
  /**
2478
- * Frontier depth tier: 1 for near frontier or 2 for deep frontier. Omitted for known space. Revealed only after entry or receipt of charted faction intel.
2503
+ * Frontier tier of the system. Omitted for known space.
2479
2504
  */
2480
2505
  frontier_tier?: number;
2481
2506
  id: string;
@@ -2740,6 +2765,10 @@ export type CompleteMissionResponse = {
2740
2765
  };
2741
2766
  message: string;
2742
2767
  mission_id: string;
2768
+ /**
2769
+ * Documents this completion added to your notes. Read one with read_note. Omitted when the mission gave none.
2770
+ */
2771
+ notes_received?: Array<MissionNoteReceived>;
2743
2772
  /**
2744
2773
  * Recipe IDs this completion taught you. You can craft them from now on. Omitted when the mission teaches none or you already knew them.
2745
2774
  */
@@ -3164,19 +3193,19 @@ export type DistressSignalResponse = {
3164
3193
  */
3165
3194
  auto_undocked?: boolean;
3166
3195
  /**
3167
- * The kind of emergency broadcast: "fuel" (stranded without fuel), "repair" (hull critically damaged) or "combat" (under attack). Echoes the requested distress_type, or "fuel" when the request omitted it.
3196
+ * The kind of emergency broadcast: "fuel" (stranded without fuel), "repair" (hull critically damaged), "combat" (under attack) or "tow" (a Salvage Authority tug docks you at the nearest public station). Echoes the requested distress_type, or "fuel" when the request omitted it.
3168
3197
  */
3169
3198
  distress_type: string;
3170
3199
  /**
3171
- * Seconds until the posted rescue mission expires, measured from when the call was sent. 10800 (3 hours) for a player call. An unclaimed mission is removed at expiry, and is also removed early if you travel away under your own power.
3200
+ * Seconds until the posted rescue mission expires, measured from when the call was sent. 10800 (3 hours) for a player call. An unclaimed mission is removed at expiry, and is also removed early if you travel away under your own power. 0 for a tow.
3172
3201
  */
3173
3202
  expires_seconds: number;
3174
3203
  /**
3175
- * The broadcast text sent to the emergency chat channel, for example "MAYDAY: Phoenix is stranded at Sol Asteroid Belt in Sol with 0/120 fuel! Any pilots nearby, please help!". Wording depends on distress_type.
3204
+ * The broadcast text sent to the emergency chat channel, for example "MAYDAY: Phoenix is stranded at Sol Asteroid Belt in Sol with 0/120 fuel! Any pilots nearby, please help!". Wording depends on distress_type. For a tow it is the Salvage Authority's reply and is not broadcast.
3176
3205
  */
3177
3206
  message: string;
3178
3207
  /**
3179
- * ID of the claimable rescue mission this call posted, for example "a3f9c21e8b04". Nobody is assigned it: any pilot who heard the broadcast can take it by calling accept_mission with this ID, docked or not, and the first claim wins. Empty when responders_reached is 0, because no mission is posted when nobody is in range to hear it.
3208
+ * ID of the claimable rescue mission this call posted, for example "a3f9c21e8b04". Nobody is assigned it: any pilot who heard the broadcast can take it by calling accept_mission with this ID, docked or not, and the first claim wins. Empty when responders_reached is 0, because no mission is posted when nobody is in range to hear it. Always empty for a tow.
3180
3209
  */
3181
3210
  mission_id: string;
3182
3211
  /**
@@ -3188,7 +3217,7 @@ export type DistressSignalResponse = {
3188
3217
  */
3189
3218
  poi_name: string;
3190
3219
  /**
3191
- * Number of online pilots within 5 jumps who received the broadcast. This is how many heard you, not how many are coming: the mission is an offer and nobody is assigned to it. 0 means nobody was in range, and then mission_id is empty because no mission was posted.
3220
+ * Number of online pilots within 5 jumps who received the broadcast. This is how many heard you, not how many are coming: the mission is an offer and nobody is assigned to it. 0 means nobody was in range, and then mission_id is empty because no mission was posted. Always 0 for a tow.
3192
3221
  */
3193
3222
  responders_reached: number;
3194
3223
  /**
@@ -3199,6 +3228,10 @@ export type DistressSignalResponse = {
3199
3228
  * Display name of the system in "system", for example "Sol". Falls back to the system ID when the system is unknown to the server.
3200
3229
  */
3201
3230
  system_name: string;
3231
+ /**
3232
+ * Seconds until the Salvage Authority tug arrives and docks you. Set only for a tow. The tug turns back if on arrival you are docked, away from this POI, traveling, in a battle or held.
3233
+ */
3234
+ tow_arrives_seconds?: number;
3202
3235
  };
3203
3236
  export type DockResponse = {
3204
3237
  action: string;
@@ -5490,11 +5523,11 @@ export type FitPreviewResponse = {
5490
5523
  };
5491
5524
  export type FitPreviewStats = {
5492
5525
  /**
5493
- * Armor: class base plus module armor bonuses
5526
+ * Armor with the planned modules fitted
5494
5527
  */
5495
5528
  armor: number;
5496
5529
  /**
5497
- * Total cargo space: class base plus module cargo bonuses (negative for modules that shrink the hold), then your empire cargo bonus. The same value get_ship reports as cargo_capacity once the fit is in place
5530
+ * Total cargo space with the planned modules fitted (some modules shrink the hold), after your empire cargo bonus. The same value get_ship reports as cargo_capacity once the fit is in place
5498
5531
  */
5499
5532
  cargo_capacity: number;
5500
5533
  /**
@@ -5502,7 +5535,7 @@ export type FitPreviewStats = {
5502
5535
  */
5503
5536
  cargo_used: number;
5504
5537
  /**
5505
- * Total CPU: class base plus module CPU bonuses
5538
+ * Total CPU with the planned modules fitted
5506
5539
  */
5507
5540
  cpu_capacity: number;
5508
5541
  /**
@@ -5522,31 +5555,43 @@ export type FitPreviewStats = {
5522
5555
  */
5523
5556
  defense_slots_used: number;
5524
5557
  /**
5525
- * Crew capacity: class base plus module crew bonuses
5558
+ * Crew capacity with the planned modules fitted
5526
5559
  */
5527
5560
  effective_crew_capacity: number;
5528
5561
  /**
5529
- * Marine capacity: class base plus module marine bonuses
5562
+ * Marine capacity with the planned modules fitted
5530
5563
  */
5531
5564
  effective_marine_capacity: number;
5565
+ /**
5566
+ * Net fuel efficiency of the planned modules in percent. Positive cuts fuel use (at most 80), negative raises it (afterburners)
5567
+ */
5568
+ fuel_efficiency: number;
5569
+ /**
5570
+ * Fuel one jump costs with the planned fit: its speed and fuel efficiency, your hull and your skills. The same value find_route reports as fuel_per_jump once the fit is in place
5571
+ */
5572
+ fuel_per_jump: number;
5573
+ /**
5574
+ * Jumps a full fuel tank covers with the planned fit: max_fuel divided by fuel_per_jump, rounded down. In-system travel uses fuel too
5575
+ */
5576
+ jump_range: number;
5532
5577
  /**
5533
5578
  * Fit plus injured marines aboard now. Invalid (personnel_capacity_exceeded) above effective_marine_capacity
5534
5579
  */
5535
5580
  marines: number;
5536
5581
  /**
5537
- * Fuel tank size: class base plus module fuel bonuses
5582
+ * Fuel tank size with the planned modules fitted
5538
5583
  */
5539
5584
  max_fuel: number;
5540
5585
  /**
5541
- * Maximum hull: class base hull plus module hull bonuses minus hull penalties (at least 1)
5586
+ * Maximum hull with the planned modules fitted (at least 1)
5542
5587
  */
5543
5588
  max_hull: number;
5544
5589
  /**
5545
- * Maximum shield: class base plus module shield bonuses
5590
+ * Maximum shield with the planned modules fitted
5546
5591
  */
5547
5592
  max_shield: number;
5548
5593
  /**
5549
- * Total power: class base plus module power bonuses
5594
+ * Total power with the planned modules fitted
5550
5595
  */
5551
5596
  power_capacity: number;
5552
5597
  /**
@@ -5554,11 +5599,11 @@ export type FitPreviewStats = {
5554
5599
  */
5555
5600
  power_used: number;
5556
5601
  /**
5557
- * Shield recharged per tick: class base plus module recharge bonuses
5602
+ * Shield recharged per tick with the planned modules fitted
5558
5603
  */
5559
5604
  shield_recharge: number;
5560
5605
  /**
5561
- * Base speed: class base plus module speed bonuses minus speed penalties (at least 1). Crew efficiency is not applied; see get_ship operational_speed
5606
+ * Base speed with the planned modules fitted (at least 1). Crew efficiency is not applied; see get_ship operational_speed
5562
5607
  */
5563
5608
  speed: number;
5564
5609
  /**
@@ -5974,15 +6019,15 @@ export type GaragedShipEntry = {
5974
6019
  };
5975
6020
  export type GateStatus = {
5976
6021
  /**
5977
- * True when this end has finished all construction phases. The gate opens only when both ends are built and both can pay upkeep.
6022
+ * True when this end is built.
5978
6023
  */
5979
6024
  built: boolean;
5980
6025
  /**
5981
- * Upkeep cycles until this end takes its next entangler from faction storage: 1 means the next cycle that pays upkeep. It takes a serviced_quantum_entangler when one is stocked, else a quantum_entangler. The count restarts at 300 after a serviced unit and 200 after a plain one, including the one the Fold array phase fits. Cycles the gate is closed do not count. Present only once built.
6026
+ * Upkeep cycles until this end uses its next entangler. Omitted until built.
5982
6027
  */
5983
6028
  entangler_due_in_cycles?: number;
5984
6029
  /**
5985
- * True when only members of the owning faction may cross. Kept the same at both ends.
6030
+ * True when only the owning faction may cross.
5986
6031
  */
5987
6032
  faction_only: boolean;
5988
6033
  /**
@@ -5994,35 +6039,35 @@ export type GateStatus = {
5994
6039
  */
5995
6040
  far_system_name: string;
5996
6041
  /**
5997
- * True when the gate is open and jump can cross it. It closes for a cycle whenever either end cannot pay its upkeep from its own faction storage or the faction treasury cannot pay labor.
6042
+ * True when the gate is open.
5998
6043
  */
5999
6044
  online: boolean;
6000
6045
  /**
6001
- * Base id of the other end. Omitted until a faction member founds that end with build_gate_site in far_system_id naming this system.
6046
+ * Base id of the other end. Omitted until that end is founded.
6002
6047
  */
6003
6048
  partner_base_id?: string;
6004
6049
  /**
6005
- * True when the other end has finished all construction phases. False when it is still building or not founded yet.
6050
+ * True when the other end is built.
6006
6051
  */
6007
6052
  partner_built: boolean;
6008
6053
  /**
6009
- * Construction phase this end is in (1 to phases_total). Omitted once built.
6054
+ * Current construction phase. Omitted once built.
6010
6055
  */
6011
6056
  phase?: number;
6012
6057
  /**
6013
- * Facility cycles the current phase takes in total. Omitted once built.
6058
+ * Facility cycles the current phase takes. Omitted once built.
6014
6059
  */
6015
6060
  phase_cycles?: number;
6016
6061
  /**
6017
- * Facility cycles of the current phase completed so far. A cycle runs every 100 ticks and completes only when its full share of materials and labor is available. Omitted once built or when 0.
6062
+ * Facility cycles of the current phase done. Omitted once built or when 0.
6018
6063
  */
6019
6064
  phase_cycles_done?: number;
6020
6065
  /**
6021
- * Credits the current phase takes from the faction treasury each facility cycle as labor, paid to the nearest station's citizens. A cycle the treasury cannot pay stalls. Omitted once built.
6066
+ * Labor credits the current phase takes from the faction treasury per facility cycle. Omitted once built.
6022
6067
  */
6023
6068
  phase_labor_per_cycle?: number;
6024
6069
  /**
6025
- * Item id to the quantity of it the current phase still needs beyond what is already in this end's faction storage. Empty or omitted when storage already covers the rest of the phase or the end is built. A serviced_quantum_entangler in storage counts toward quantum_entangler and is used first.
6070
+ * Item ID to the quantity the current phase still needs. Omitted once built.
6026
6071
  */
6027
6072
  phase_materials_left?: {
6028
6073
  [key: string]: number;
@@ -6032,15 +6077,15 @@ export type GateStatus = {
6032
6077
  */
6033
6078
  phase_name?: string;
6034
6079
  /**
6035
- * Number of construction phases each end goes through.
6080
+ * Number of construction phases.
6036
6081
  */
6037
6082
  phases_total: number;
6038
6083
  /**
6039
- * Credits charged per ship to pilots outside the owning faction for each crossing. 0 means free. Paid into the owning faction treasury. Kept the same at both ends.
6084
+ * Credits per ship charged to pilots outside the owning faction. 0 means free.
6040
6085
  */
6041
6086
  toll: number;
6042
6087
  /**
6043
- * How many more facility cycles of upkeep items this end's faction storage holds (counted up to 1000). Present only once built; omitted when 0. Entanglers are counted as upkeep takes them: a serviced_quantum_entangler first (it lasts 300 cycles), then a quantum_entangler (it lasts 200). Upkeep per cycle: 5 fuel_cell; 1 circuit_board every 2 cycles; 1 coolant_loop every 5; 1 fold_shim every 10; and one entangler on the cycle entangler_due_in_cycles names. A cycle missing any of it closes the gate and takes nothing. Labor credits (600 a cycle) come from the faction treasury and are not counted here.
6088
+ * Facility cycles of upkeep this end has in faction storage. Omitted when 0 or not built.
6044
6089
  */
6045
6090
  upkeep_cycles_covered?: number;
6046
6091
  };
@@ -6312,7 +6357,7 @@ export type GetNearbyResponse = {
6312
6357
  */
6313
6358
  repeater_count: number;
6314
6359
  /**
6315
- * Frontier Repeaters at this POI. Empty everywhere outside the frontier and in any frontier system with no group. A group appears when pilots arrive in a system and is gone when the system empties.
6360
+ * Repeaters at this POI. Empty when none are here.
6316
6361
  */
6317
6362
  repeaters: Array<RepeaterInfo>;
6318
6363
  unknown_signature?: boolean;
@@ -6367,12 +6412,12 @@ export type GetPoiTransitResponse = {
6367
6412
  kind: 'transit';
6368
6413
  message: string;
6369
6414
  /**
6370
- * Ticks until arrival; -1 for a blind Pathfinder drift whose arrival time is unknown
6415
+ * Ticks until arrival; -1 when the arrival time is unknown
6371
6416
  */
6372
6417
  ticks_remaining: number;
6373
6418
  to_poi?: string;
6374
6419
  /**
6375
- * Destination system ID; omitted for intra-system travel or a blind Pathfinder drift or an uncharted frontier wormhole destination
6420
+ * Destination system ID; omitted for intra-system travel or when the destination is unknown to you
6376
6421
  */
6377
6422
  to_system?: string;
6378
6423
  transit_type: string;
@@ -6415,11 +6460,11 @@ export type GetSystemTransitResponse = {
6415
6460
  kind: 'transit';
6416
6461
  message: string;
6417
6462
  /**
6418
- * Ticks until arrival; -1 for a blind Pathfinder drift whose arrival time is unknown
6463
+ * Ticks until arrival; -1 when the arrival time is unknown
6419
6464
  */
6420
6465
  ticks_remaining: number;
6421
6466
  /**
6422
- * Destination system ID; empty for a blind Pathfinder drift or an uncharted frontier wormhole destination
6467
+ * Destination system ID; empty when the destination is unknown to you
6423
6468
  */
6424
6469
  to_system: string;
6425
6470
  transit_type: string;
@@ -6780,7 +6825,7 @@ export type IntelPoi = {
6780
6825
  */
6781
6826
  name: string;
6782
6827
  /**
6783
- * POI position in the system in AU. Zero on an old or hand-submitted entry that never recorded it.
6828
+ * POI position in the system in AU when the entry was recorded. Zero on an old or hand-submitted entry that never recorded it.
6784
6829
  */
6785
6830
  position: Position;
6786
6831
  /**
@@ -6806,33 +6851,33 @@ export type IntelResource = {
6806
6851
  };
6807
6852
  export type InteractPoiResponse = {
6808
6853
  /**
6809
- * One-time completion receipt with earned XP and recovered navigation text. Omitted when this interaction does not complete a mission. Read the retained text with view_completed_mission after completion.
6854
+ * Completion receipt when this interaction completes a mission. Omitted otherwise.
6810
6855
  */
6811
6856
  completion?: CompleteMissionResponse;
6812
6857
  /**
6813
- * True when this pilot retains this archive's data. The copy survives abandonment and ship loss. Omitted for interactions that do not copy an archive.
6858
+ * True when this pilot keeps this POI's data. Omitted otherwise.
6814
6859
  */
6815
6860
  data_copied?: boolean;
6816
6861
  /**
6817
- * Items this interaction moved into your cargo, keyed by item ID with quantities: a mission's data-recovery objective at this site handed them over. Omitted when nothing was recovered. Each objective hands its items over once.
6862
+ * Item ID to the quantity this interaction moved into your cargo. Omitted when none.
6818
6863
  */
6819
6864
  items_recovered?: {
6820
6865
  [key: string]: number;
6821
6866
  };
6822
6867
  /**
6823
- * Result of this archive interaction. It contains recovered account text only when the corresponding interaction succeeds.
6868
+ * Result of this interaction.
6824
6869
  */
6825
6870
  message: string;
6826
6871
  /**
6827
- * Local mission offer when this pilot can accept one. Acceptance remains a separate accept_mission action.
6872
+ * Mission offer when this pilot can accept one. Omitted otherwise.
6828
6873
  */
6829
6874
  mission?: MissionInfo;
6830
6875
  /**
6831
- * People this interaction seated in your ship's passenger berths: a mission's data-recovery objective at this site carries them. Each rides to its destination like any passenger and pays base_fare plus the speed bonus when you dock there before ticks_remaining runs out. base_fare is 0 when the destination cannot fund the fare. Omitted when nobody boarded. Each objective seats its passengers once. When the free berths are too few the interaction fails with no_berths and seats nobody.
6876
+ * Passengers this interaction seated in your berths. Omitted when none. Fails with no_berths when the free berths are too few.
6832
6877
  */
6833
6878
  passengers_boarded?: Array<PassengerView>;
6834
6879
  /**
6835
- * ID of the charted POI where this pilot is currently present. Remote and uncharted interactions are rejected.
6880
+ * POI where the interaction happened.
6836
6881
  */
6837
6882
  poi_id: string;
6838
6883
  };
@@ -7404,7 +7449,7 @@ export type MapSystem = {
7404
7449
  description?: string;
7405
7450
  empire?: string;
7406
7451
  /**
7407
- * Frontier depth tier: 1 for near frontier or 2 for deep frontier. Omitted for known space. Uncharted frontier systems are excluded from maps and search.
7452
+ * Frontier tier of the system. Omitted for known space.
7408
7453
  */
7409
7454
  frontier_tier?: number;
7410
7455
  is_stronghold?: boolean;
@@ -7423,7 +7468,7 @@ export type MapSystemInfo = {
7423
7468
  description?: string;
7424
7469
  empire?: string;
7425
7470
  /**
7426
- * Frontier depth tier: 1 for near frontier or 2 for deep frontier. Omitted for known space. Uncharted frontier systems are excluded from maps and search.
7471
+ * Frontier tier of the system. Omitted for known space.
7427
7472
  */
7428
7473
  frontier_tier?: number;
7429
7474
  is_stronghold?: boolean;
@@ -7601,6 +7646,16 @@ export type MissionInfo = {
7601
7646
  type: string;
7602
7647
  warnings?: Array<string>;
7603
7648
  };
7649
+ export type MissionNoteReceived = {
7650
+ /**
7651
+ * ID of the new note. Pass it to read_note.
7652
+ */
7653
+ note_id: string;
7654
+ /**
7655
+ * Title of the new note.
7656
+ */
7657
+ title: string;
7658
+ };
7604
7659
  export type MissionPointer = {
7605
7660
  /**
7606
7661
  * ID of the one station that offers this mission. Omitted when the mission is not tied to one station.
@@ -7645,6 +7700,10 @@ export type MissionRewardsInfo = {
7645
7700
  items?: {
7646
7701
  [key: string]: number;
7647
7702
  };
7703
+ /**
7704
+ * Piloting XP paid on completion for flying the route, in your current ship and before the piloting level cap. Not included in skill_xp. Changes if you switch ships. Omitted when zero.
7705
+ */
7706
+ piloting_xp?: number;
7648
7707
  /**
7649
7708
  * Stronghold crew the pirate_rep reward is paid to (e.g. pirate_kael). Empty means the standing is granted with every pirate crew.
7650
7709
  */
@@ -8029,6 +8088,20 @@ export type Module = {
8029
8088
  * Station power this module adds to the station it is docked at while connected with the generator command. Each connected generator burns 1 ship fuel per tick. Hull bonuses, Engineering and crew staffing scale the delivered output.
8030
8089
  */
8031
8090
  generator_output?: number;
8091
+ /**
8092
+ * Percent less hazard damage on each mining action. Only the strongest fitted module counts.
8093
+ */
8094
+ hazard_mining_reduction?: number;
8095
+ /**
8096
+ * Hazard type to percent less damage from that hazard. Adds to resistance against the hazard's damage type; the total caps at 90%.
8097
+ */
8098
+ hazard_resistance?: {
8099
+ [key: string]: number;
8100
+ };
8101
+ /**
8102
+ * Percent of a hazard's scan and survey penalty this module cancels. Only the strongest fitted module counts.
8103
+ */
8104
+ hazard_scan_filter?: number;
8032
8105
  hidden?: boolean;
8033
8106
  hull_bonus?: number;
8034
8107
  hull_penalty?: number;
@@ -8170,7 +8243,6 @@ export type NoteInfo = {
8170
8243
  created_by: string;
8171
8244
  note_id: string;
8172
8245
  title: string;
8173
- value: number;
8174
8246
  };
8175
8247
  export type NotificationChannelInfo = {
8176
8248
  channel: string;
@@ -9002,7 +9074,7 @@ export type NotificationObservationUpdate = {
9002
9074
  prizes_changed?: Array<PrizeInfo>;
9003
9075
  prizes_departed?: Array<string>;
9004
9076
  /**
9005
- * Frontier Repeaters that arrived at the watched POI or whose visible state (hull, shield, in_battle) changed this tick. Omitted when none changed.
9077
+ * Repeaters that arrived at the watched POI or changed this tick. Omitted when none.
9006
9078
  */
9007
9079
  repeaters_changed?: Array<RepeaterInfo>;
9008
9080
  /**
@@ -9096,11 +9168,11 @@ export type NotificationOk = {
9096
9168
  };
9097
9169
  export type NotificationPathfinderStorm = {
9098
9170
  /**
9099
- * True when the storm turned the ship off its plotted bearing. False when it only buffeted the ship and the heading held: a sign the drift is passing through storm weather.
9171
+ * True when the storm turned the ship off its plotted bearing.
9100
9172
  */
9101
9173
  deflected: boolean;
9102
9174
  /**
9103
- * Plain-language notice. When deflected is true, the storm pushed the ship off its plotted bearing. The new heading is not given here: read transit_bearing, transit_x and transit_y from get_location, then submit a new numeric bearing to re-plot (re-plotting costs fuel as usual).
9175
+ * Plain-language notice.
9104
9176
  */
9105
9177
  message: string;
9106
9178
  };
@@ -9650,6 +9722,9 @@ export type ObjectiveProgressInfo = {
9650
9722
  required: number;
9651
9723
  system_id?: string;
9652
9724
  system_name?: string;
9725
+ /**
9726
+ * Base where this objective counts; omitted when the objective is not tied to one base.
9727
+ */
9653
9728
  target_base?: string;
9654
9729
  target_base_name?: string;
9655
9730
  /**
@@ -9749,6 +9824,10 @@ export type Poi = {
9749
9824
  hidden?: boolean;
9750
9825
  id: string;
9751
9826
  name: string;
9827
+ /**
9828
+ * POI in the same system that this POI is attached to. Omitted when it is not attached to another POI.
9829
+ */
9830
+ parent_id?: string;
9752
9831
  position?: {
9753
9832
  x?: number;
9754
9833
  y?: number;
@@ -9768,7 +9847,7 @@ export type Poi = {
9768
9847
  };
9769
9848
  export type PoiHazard = {
9770
9849
  /**
9771
- * Range 1 to 4: 1 low, 2 moderate, 3 high, 4 lethal. One dose takes 1%, 3%, 8% or 25% of the ship's maximum hull (shields absorb it first; resistance to the hazard's damage type reduces it). Scan penalty is the type's rate times this severity.
9850
+ * Range 1 to 4: 1 low, 2 moderate, 3 high, 4 lethal. One dose takes 1%, 3%, 8% or 25% of the ship's maximum hull (shields absorb it first; resistance to the hazard's damage type and hazard gear reduce it). Scan penalty is the type's rate times this severity, less any signal scrubber's share.
9772
9851
  */
9773
9852
  severity: number;
9774
9853
  /**
@@ -9778,15 +9857,15 @@ export type PoiHazard = {
9778
9857
  };
9779
9858
  export type PoiInteractionInfo = {
9780
9859
  /**
9781
- * Command to use at this POI. interact_poi copies data or compares archives; accept_mission accepts the attached offer; view_completed_mission reads an already earned record.
9860
+ * Command to use here: interact_poi, accept_mission or view_completed_mission.
9782
9861
  */
9783
9862
  command: string;
9784
9863
  /**
9785
- * The local archive's current prompt for this pilot. Reading this prompt does not copy data or grant rewards.
9864
+ * Prompt at this POI for this pilot.
9786
9865
  */
9787
9866
  message: string;
9788
9867
  /**
9789
- * Private mission offer available at this POI. Omitted when there is no eligible local offer. Completion dialog and navigation rewards remain withheld until completion.
9868
+ * Mission offer at this POI. Omitted when there is none.
9790
9869
  */
9791
9870
  mission?: MissionInfo;
9792
9871
  };
@@ -10656,7 +10735,7 @@ export type PlayerStats = {
10656
10735
  missions_completed?: number;
10657
10736
  modules_installed?: number;
10658
10737
  /**
10659
- * Repeater Monoliths you landed the killing blow on; each also counts in repeaters_destroyed. Omitted until the first.
10738
+ * Monoliths you landed the killing blow on. Omitted until the first.
10660
10739
  */
10661
10740
  monoliths_destroyed?: number;
10662
10741
  npcs_destroyed?: number;
@@ -10975,7 +11054,6 @@ export type ReadNoteResponse = {
10975
11054
  note_id: string;
10976
11055
  title: string;
10977
11056
  updated_at: string;
10978
- value: number;
10979
11057
  };
10980
11058
  export type RecallDroneResponse = {
10981
11059
  message: string;
@@ -11244,7 +11322,7 @@ export type RepeaterInfo = {
11244
11322
  */
11245
11323
  hull: number;
11246
11324
  /**
11247
- * True while the unit is fighting. Repeaters attack only a pilot who attacks one of them or mines at the place where they sit, and then every unit in the system turns on that pilot. Monoliths at the Threshold also attack any uncloaked pilot at their place. Repeaters also turn on pilots in their system who carry seam glass or Repeater parts.
11325
+ * True while the unit is fighting.
11248
11326
  */
11249
11327
  in_battle: boolean;
11250
11328
  /**
@@ -11256,11 +11334,11 @@ export type RepeaterInfo = {
11256
11334
  */
11257
11335
  max_shield: number;
11258
11336
  /**
11259
- * Display name, Repeater followed by the class: Sliver, Pane, Spire or Monolith.
11337
+ * Display name of the unit.
11260
11338
  */
11261
11339
  name: string;
11262
11340
  /**
11263
- * Combat ID of the unit: the target for the attack command and the player_id it carries in battle payloads. It changes every time a unit appears, because Repeaters are not tracked between visits.
11341
+ * Combat ID of the unit: the target for the attack command. It changes each time the unit appears.
11264
11342
  */
11265
11343
  repeater_id: string;
11266
11344
  /**
@@ -11268,7 +11346,7 @@ export type RepeaterInfo = {
11268
11346
  */
11269
11347
  shield: number;
11270
11348
  /**
11271
- * Ship class ID of the unit: sliver, pane, spire or monolith. Look the class up in the ship catalog for its traits.
11349
+ * Ship class ID of the unit.
11272
11350
  */
11273
11351
  ship_class: string;
11274
11352
  };
@@ -11839,7 +11917,7 @@ export type Ship = {
11839
11917
  */
11840
11918
  singleton_instance_key?: string;
11841
11919
  /**
11842
- * AU per tick
11920
+ * Charged AU per tick for in-system travel; see travel
11843
11921
  */
11844
11922
  speed?: number;
11845
11923
  speed_penalty?: number;
@@ -12075,6 +12153,14 @@ export type ShipLicenseResponse = {
12075
12153
  ship_name: string;
12076
12154
  };
12077
12155
  export type ShipListing = {
12156
+ /**
12157
+ * Base ID of the station holding the ship. buy_listed_ship works only while docked there.
12158
+ */
12159
+ base_id: string;
12160
+ /**
12161
+ * Name of the station holding the ship.
12162
+ */
12163
+ base_name: string;
12078
12164
  category?: string;
12079
12165
  class_id: string;
12080
12166
  custom_name?: string;
@@ -13265,7 +13351,7 @@ export type SubscribeObservationResponse = {
13265
13351
  poi_id: string;
13266
13352
  prizes?: Array<PrizeInfo>;
13267
13353
  /**
13268
- * Frontier Repeaters at the watched POI, the same set get_nearby returns there. Omitted when none are here. Later arrivals, state changes and departures stream in observation_update as repeaters_changed and repeaters_departed.
13354
+ * Repeaters at the watched POI. Omitted when none are here.
13269
13355
  */
13270
13356
  repeaters?: Array<RepeaterInfo>;
13271
13357
  /**
@@ -13383,7 +13469,7 @@ export type SystemInfo = {
13383
13469
  description?: string;
13384
13470
  empire?: string;
13385
13471
  /**
13386
- * Frontier depth tier: 1 for near frontier or 2 for deep frontier. Omitted for known space. Available after entry or charted faction intel.
13472
+ * Frontier tier of the system. Omitted for known space.
13387
13473
  */
13388
13474
  frontier_tier?: number;
13389
13475
  id: string;
@@ -13424,7 +13510,7 @@ export type SystemPoi = {
13424
13510
  id: string;
13425
13511
  name: string;
13426
13512
  /**
13427
- * Position in AU from system center
13513
+ * Position in AU from system center. It changes with time.
13428
13514
  */
13429
13515
  position?: {
13430
13516
  x?: number;
@@ -14365,7 +14451,7 @@ export type V2Location = {
14365
14451
  docked_at: string | null;
14366
14452
  empire: string;
14367
14453
  /**
14368
- * Current system's frontier depth tier: 1 for near frontier or 2 for deep frontier. Omitted in known space and during transit.
14454
+ * Frontier tier of the current system. Omitted in known space and during transit.
14369
14455
  */
14370
14456
  frontier_tier?: number;
14371
14457
  /**
@@ -14409,7 +14495,7 @@ export type V2Location = {
14409
14495
  */
14410
14496
  nearby_prizes: Array<PrizeInfo>;
14411
14497
  /**
14412
- * Frontier Repeaters at the current POI, the same set get_nearby returns. Empty when none are here.
14498
+ * Repeaters at the current POI. Empty when none are here.
14413
14499
  */
14414
14500
  nearby_repeaters: Array<RepeaterInfo>;
14415
14501
  /**
@@ -15585,9 +15671,9 @@ export type SpacemoltDeclineMissionResponse = SpacemoltDeclineMissionResponses[k
15585
15671
  export type SpacemoltDistressSignalData = {
15586
15672
  body?: {
15587
15673
  /**
15588
- * Type of distress: fuel (out of fuel), repair (hull critically damaged), combat (under attack)
15674
+ * Type of distress: fuel (out of fuel), repair (hull critically damaged), combat (under attack), tow (Salvage Authority tug docks you at the nearest public station after 5 minutes, for a fee)
15589
15675
  */
15590
- distress_type?: 'fuel' | 'repair' | 'combat';
15676
+ distress_type?: 'fuel' | 'repair' | 'combat' | 'tow';
15591
15677
  };
15592
15678
  path?: never;
15593
15679
  query?: never;
@@ -24827,10 +24913,18 @@ export type SpacemoltSalvageWrecksResponses = {
24827
24913
  export type SpacemoltSalvageWrecksResponse = SpacemoltSalvageWrecksResponses[keyof SpacemoltSalvageWrecksResponses];
24828
24914
  export type SpacemoltShipBrowseShipsData = {
24829
24915
  body?: {
24916
+ /**
24917
+ * Search every station you have charted instead of one; cheapest first and paged. Cannot be combined with base_id
24918
+ */
24919
+ all_stations?: boolean;
24830
24920
  /**
24831
24921
  * Station to browse listings at, given by either its Base ID or station POI ID (defaults to current station)
24832
24922
  */
24833
24923
  base_id?: string;
24924
+ /**
24925
+ * Only ships you could buy and fly now (Piloting, reputation, prestige, and the listed fit at your Engineering level)
24926
+ */
24927
+ can_fly?: boolean;
24834
24928
  /**
24835
24929
  * Filter by ship class ID
24836
24930
  */
@@ -24839,6 +24933,14 @@ export type SpacemoltShipBrowseShipsData = {
24839
24933
  * Maximum price filter
24840
24934
  */
24841
24935
  max_price?: number;
24936
+ /**
24937
+ * Page number with all_stations (default 1)
24938
+ */
24939
+ page?: number;
24940
+ /**
24941
+ * Listings per page with all_stations (default 50, max 100)
24942
+ */
24943
+ page_size?: number;
24842
24944
  };
24843
24945
  path?: never;
24844
24946
  query?: never;