@spacemolt/lib 17.1.0 → 17.2.1

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.
@@ -961,6 +961,10 @@ export type Base = {
961
961
  * Present only when this outpost is one end of a player-built jump gate; omitted otherwise. The owning faction's station info action describes it in full.
962
962
  */
963
963
  gate?: {
964
+ /**
965
+ * True when only the owning faction and its allies may cross; omitted otherwise
966
+ */
967
+ allies_only?: boolean;
964
968
  /**
965
969
  * True when only the owning faction may cross; omitted when public
966
970
  */
@@ -970,7 +974,7 @@ export type Base = {
970
974
  */
971
975
  far_system_id?: string;
972
976
  /**
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
977
+ * True while the owners have been warned this end is short of supplies; omitted otherwise
974
978
  */
975
979
  low_supply_warned?: boolean;
976
980
  /**
@@ -982,11 +986,11 @@ export type Base = {
982
986
  */
983
987
  partner_base_id?: string;
984
988
  /**
985
- * Construction phases this end has completed (0-4); 4 means built
989
+ * Construction phases this end has completed
986
990
  */
987
991
  phase?: number;
988
992
  /**
989
- * While building: facility cycles of the current phase done. Once built: upkeep cycles paid so far
993
+ * Facility cycles counted for the current phase or upkeep
990
994
  */
991
995
  phase_cycles?: number;
992
996
  /**
@@ -1470,11 +1474,36 @@ export type BoardingStateLogEntry = {
1470
1474
  target_id?: string;
1471
1475
  };
1472
1476
  export type BrowseShipsResponse = {
1477
+ /**
1478
+ * Base ID of the station browsed. Empty with all_stations.
1479
+ */
1473
1480
  base_id: string;
1481
+ /**
1482
+ * Name of the station browsed. Empty with all_stations.
1483
+ */
1474
1484
  base_name: string;
1475
1485
  buy_orders?: Array<ShipBuyOrderInfo>;
1486
+ /**
1487
+ * Number of listings in this response.
1488
+ */
1476
1489
  count: number;
1477
1490
  listings: Array<ShipListing>;
1491
+ /**
1492
+ * With all_stations: the 1-based page returned. Omitted otherwise.
1493
+ */
1494
+ page?: number;
1495
+ /**
1496
+ * With all_stations: listings per page (default 50, max 100). Omitted otherwise.
1497
+ */
1498
+ page_size?: number;
1499
+ /**
1500
+ * With all_stations: listings matching the filters across every page. Omitted when nothing matches or without all_stations.
1501
+ */
1502
+ total?: number;
1503
+ /**
1504
+ * With all_stations: number of pages (at least 1). Omitted otherwise.
1505
+ */
1506
+ total_pages?: number;
1478
1507
  };
1479
1508
  export type BuildBaseResponse = {
1480
1509
  /**
@@ -2458,7 +2487,7 @@ export type ClientPoiInfo = {
2458
2487
  */
2459
2488
  name: string;
2460
2489
  /**
2461
- * Position in AU from the system center.
2490
+ * Position in AU from the system center. It changes with time.
2462
2491
  */
2463
2492
  position: Position;
2464
2493
  /**
@@ -2475,7 +2504,7 @@ export type ClientSystemInfo = {
2475
2504
  description?: string;
2476
2505
  empire?: string;
2477
2506
  /**
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.
2507
+ * Frontier tier of the system. Omitted for known space.
2479
2508
  */
2480
2509
  frontier_tier?: number;
2481
2510
  id: string;
@@ -2740,6 +2769,10 @@ export type CompleteMissionResponse = {
2740
2769
  };
2741
2770
  message: string;
2742
2771
  mission_id: string;
2772
+ /**
2773
+ * Documents this completion added to your notes. Read one with read_note. Omitted when the mission gave none.
2774
+ */
2775
+ notes_received?: Array<MissionNoteReceived>;
2743
2776
  /**
2744
2777
  * 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
2778
  */
@@ -3164,19 +3197,19 @@ export type DistressSignalResponse = {
3164
3197
  */
3165
3198
  auto_undocked?: boolean;
3166
3199
  /**
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.
3200
+ * 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
3201
  */
3169
3202
  distress_type: string;
3170
3203
  /**
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.
3204
+ * 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
3205
  */
3173
3206
  expires_seconds: number;
3174
3207
  /**
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.
3208
+ * 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
3209
  */
3177
3210
  message: string;
3178
3211
  /**
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.
3212
+ * 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
3213
  */
3181
3214
  mission_id: string;
3182
3215
  /**
@@ -3188,7 +3221,7 @@ export type DistressSignalResponse = {
3188
3221
  */
3189
3222
  poi_name: string;
3190
3223
  /**
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.
3224
+ * 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
3225
  */
3193
3226
  responders_reached: number;
3194
3227
  /**
@@ -3199,6 +3232,10 @@ export type DistressSignalResponse = {
3199
3232
  * 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
3233
  */
3201
3234
  system_name: string;
3235
+ /**
3236
+ * 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.
3237
+ */
3238
+ tow_arrives_seconds?: number;
3202
3239
  };
3203
3240
  export type DockResponse = {
3204
3241
  action: string;
@@ -3847,6 +3884,10 @@ export type FacilityEntry = {
3847
3884
  * Station service this facility provides to everyone docked here, for example market, repair, refuel, shipyard, storage, crafting, missions, salvage_yard, personnel, marine_training, medical or police. Omitted when the facility provides no station service.
3848
3885
  */
3849
3886
  service?: string;
3887
+ /**
3888
+ * Game ticks left until construction finishes. Present only on player_facilities and faction_facilities entries while under_construction is true; omitted otherwise.
3889
+ */
3890
+ ticks_until_complete?: number;
3850
3891
  /**
3851
3892
  * True for a dining or leisure venue whose upkeep stock and labor scale with recent paying guests instead of a fixed bill; see maintenance_per_cycle and labor_per_cycle. Omitted means false.
3852
3893
  */
@@ -4900,6 +4941,10 @@ export type FactionOwnedFacilityEntry = {
4900
4941
  rental_fee_per_run?: number;
4901
4942
  repair_complete_tick?: number;
4902
4943
  system_id?: string;
4944
+ /**
4945
+ * Game ticks left until construction finishes. Present only while under_construction is true; omitted otherwise.
4946
+ */
4947
+ ticks_until_complete?: number;
4903
4948
  type: string;
4904
4949
  under_construction?: boolean;
4905
4950
  };
@@ -5490,11 +5535,11 @@ export type FitPreviewResponse = {
5490
5535
  };
5491
5536
  export type FitPreviewStats = {
5492
5537
  /**
5493
- * Armor: class base plus module armor bonuses
5538
+ * Armor with the planned modules fitted
5494
5539
  */
5495
5540
  armor: number;
5496
5541
  /**
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
5542
+ * 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
5543
  */
5499
5544
  cargo_capacity: number;
5500
5545
  /**
@@ -5502,7 +5547,7 @@ export type FitPreviewStats = {
5502
5547
  */
5503
5548
  cargo_used: number;
5504
5549
  /**
5505
- * Total CPU: class base plus module CPU bonuses
5550
+ * Total CPU with the planned modules fitted
5506
5551
  */
5507
5552
  cpu_capacity: number;
5508
5553
  /**
@@ -5522,31 +5567,43 @@ export type FitPreviewStats = {
5522
5567
  */
5523
5568
  defense_slots_used: number;
5524
5569
  /**
5525
- * Crew capacity: class base plus module crew bonuses
5570
+ * Crew capacity with the planned modules fitted
5526
5571
  */
5527
5572
  effective_crew_capacity: number;
5528
5573
  /**
5529
- * Marine capacity: class base plus module marine bonuses
5574
+ * Marine capacity with the planned modules fitted
5530
5575
  */
5531
5576
  effective_marine_capacity: number;
5577
+ /**
5578
+ * Net fuel efficiency of the planned modules in percent. Positive cuts fuel use (at most 80), negative raises it (afterburners)
5579
+ */
5580
+ fuel_efficiency: number;
5581
+ /**
5582
+ * 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
5583
+ */
5584
+ fuel_per_jump: number;
5585
+ /**
5586
+ * 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
5587
+ */
5588
+ jump_range: number;
5532
5589
  /**
5533
5590
  * Fit plus injured marines aboard now. Invalid (personnel_capacity_exceeded) above effective_marine_capacity
5534
5591
  */
5535
5592
  marines: number;
5536
5593
  /**
5537
- * Fuel tank size: class base plus module fuel bonuses
5594
+ * Fuel tank size with the planned modules fitted
5538
5595
  */
5539
5596
  max_fuel: number;
5540
5597
  /**
5541
- * Maximum hull: class base hull plus module hull bonuses minus hull penalties (at least 1)
5598
+ * Maximum hull with the planned modules fitted (at least 1)
5542
5599
  */
5543
5600
  max_hull: number;
5544
5601
  /**
5545
- * Maximum shield: class base plus module shield bonuses
5602
+ * Maximum shield with the planned modules fitted
5546
5603
  */
5547
5604
  max_shield: number;
5548
5605
  /**
5549
- * Total power: class base plus module power bonuses
5606
+ * Total power with the planned modules fitted
5550
5607
  */
5551
5608
  power_capacity: number;
5552
5609
  /**
@@ -5554,11 +5611,11 @@ export type FitPreviewStats = {
5554
5611
  */
5555
5612
  power_used: number;
5556
5613
  /**
5557
- * Shield recharged per tick: class base plus module recharge bonuses
5614
+ * Shield recharged per tick with the planned modules fitted
5558
5615
  */
5559
5616
  shield_recharge: number;
5560
5617
  /**
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
5618
+ * Base speed with the planned modules fitted (at least 1). Crew efficiency is not applied; see get_ship operational_speed
5562
5619
  */
5563
5620
  speed: number;
5564
5621
  /**
@@ -5974,15 +6031,19 @@ export type GaragedShipEntry = {
5974
6031
  };
5975
6032
  export type GateStatus = {
5976
6033
  /**
5977
- * True when this end has finished all construction phases. The gate opens only when both ends are built and both can pay upkeep.
6034
+ * True when only the owning faction and its allies may cross. Omitted otherwise.
6035
+ */
6036
+ allies_only?: boolean;
6037
+ /**
6038
+ * True when this end is built.
5978
6039
  */
5979
6040
  built: boolean;
5980
6041
  /**
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.
6042
+ * Upkeep cycles until this end uses its next entangler. Omitted until built.
5982
6043
  */
5983
6044
  entangler_due_in_cycles?: number;
5984
6045
  /**
5985
- * True when only members of the owning faction may cross. Kept the same at both ends.
6046
+ * True when only the owning faction may cross.
5986
6047
  */
5987
6048
  faction_only: boolean;
5988
6049
  /**
@@ -5994,35 +6055,35 @@ export type GateStatus = {
5994
6055
  */
5995
6056
  far_system_name: string;
5996
6057
  /**
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.
6058
+ * True when the gate is open.
5998
6059
  */
5999
6060
  online: boolean;
6000
6061
  /**
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.
6062
+ * Base id of the other end. Omitted until that end is founded.
6002
6063
  */
6003
6064
  partner_base_id?: string;
6004
6065
  /**
6005
- * True when the other end has finished all construction phases. False when it is still building or not founded yet.
6066
+ * True when the other end is built.
6006
6067
  */
6007
6068
  partner_built: boolean;
6008
6069
  /**
6009
- * Construction phase this end is in (1 to phases_total). Omitted once built.
6070
+ * Current construction phase. Omitted once built.
6010
6071
  */
6011
6072
  phase?: number;
6012
6073
  /**
6013
- * Facility cycles the current phase takes in total. Omitted once built.
6074
+ * Facility cycles the current phase takes. Omitted once built.
6014
6075
  */
6015
6076
  phase_cycles?: number;
6016
6077
  /**
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.
6078
+ * Facility cycles of the current phase done. Omitted once built or when 0.
6018
6079
  */
6019
6080
  phase_cycles_done?: number;
6020
6081
  /**
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.
6082
+ * Labor credits the current phase takes from the faction treasury per facility cycle. Omitted once built.
6022
6083
  */
6023
6084
  phase_labor_per_cycle?: number;
6024
6085
  /**
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.
6086
+ * Item ID to the quantity the current phase still needs. Omitted once built.
6026
6087
  */
6027
6088
  phase_materials_left?: {
6028
6089
  [key: string]: number;
@@ -6032,15 +6093,15 @@ export type GateStatus = {
6032
6093
  */
6033
6094
  phase_name?: string;
6034
6095
  /**
6035
- * Number of construction phases each end goes through.
6096
+ * Number of construction phases.
6036
6097
  */
6037
6098
  phases_total: number;
6038
6099
  /**
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.
6100
+ * Credits per ship charged to pilots outside the owning faction. 0 means free.
6040
6101
  */
6041
6102
  toll: number;
6042
6103
  /**
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.
6104
+ * Facility cycles of upkeep this end has in faction storage. Omitted when 0 or not built.
6044
6105
  */
6045
6106
  upkeep_cycles_covered?: number;
6046
6107
  };
@@ -6312,7 +6373,7 @@ export type GetNearbyResponse = {
6312
6373
  */
6313
6374
  repeater_count: number;
6314
6375
  /**
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.
6376
+ * Repeaters at this POI. Empty when none are here.
6316
6377
  */
6317
6378
  repeaters: Array<RepeaterInfo>;
6318
6379
  unknown_signature?: boolean;
@@ -6367,12 +6428,12 @@ export type GetPoiTransitResponse = {
6367
6428
  kind: 'transit';
6368
6429
  message: string;
6369
6430
  /**
6370
- * Ticks until arrival; -1 for a blind Pathfinder drift whose arrival time is unknown
6431
+ * Ticks until arrival; -1 when the arrival time is unknown
6371
6432
  */
6372
6433
  ticks_remaining: number;
6373
6434
  to_poi?: string;
6374
6435
  /**
6375
- * Destination system ID; omitted for intra-system travel or a blind Pathfinder drift or an uncharted frontier wormhole destination
6436
+ * Destination system ID; omitted for intra-system travel or when the destination is unknown to you
6376
6437
  */
6377
6438
  to_system?: string;
6378
6439
  transit_type: string;
@@ -6415,11 +6476,11 @@ export type GetSystemTransitResponse = {
6415
6476
  kind: 'transit';
6416
6477
  message: string;
6417
6478
  /**
6418
- * Ticks until arrival; -1 for a blind Pathfinder drift whose arrival time is unknown
6479
+ * Ticks until arrival; -1 when the arrival time is unknown
6419
6480
  */
6420
6481
  ticks_remaining: number;
6421
6482
  /**
6422
- * Destination system ID; empty for a blind Pathfinder drift or an uncharted frontier wormhole destination
6483
+ * Destination system ID; empty when the destination is unknown to you
6423
6484
  */
6424
6485
  to_system: string;
6425
6486
  transit_type: string;
@@ -6780,7 +6841,7 @@ export type IntelPoi = {
6780
6841
  */
6781
6842
  name: string;
6782
6843
  /**
6783
- * POI position in the system in AU. Zero on an old or hand-submitted entry that never recorded it.
6844
+ * 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
6845
  */
6785
6846
  position: Position;
6786
6847
  /**
@@ -6806,33 +6867,33 @@ export type IntelResource = {
6806
6867
  };
6807
6868
  export type InteractPoiResponse = {
6808
6869
  /**
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.
6870
+ * Completion receipt when this interaction completes a mission. Omitted otherwise.
6810
6871
  */
6811
6872
  completion?: CompleteMissionResponse;
6812
6873
  /**
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.
6874
+ * True when this pilot keeps this POI's data. Omitted otherwise.
6814
6875
  */
6815
6876
  data_copied?: boolean;
6816
6877
  /**
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.
6878
+ * Item ID to the quantity this interaction moved into your cargo. Omitted when none.
6818
6879
  */
6819
6880
  items_recovered?: {
6820
6881
  [key: string]: number;
6821
6882
  };
6822
6883
  /**
6823
- * Result of this archive interaction. It contains recovered account text only when the corresponding interaction succeeds.
6884
+ * Result of this interaction.
6824
6885
  */
6825
6886
  message: string;
6826
6887
  /**
6827
- * Local mission offer when this pilot can accept one. Acceptance remains a separate accept_mission action.
6888
+ * Mission offer when this pilot can accept one. Omitted otherwise.
6828
6889
  */
6829
6890
  mission?: MissionInfo;
6830
6891
  /**
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.
6892
+ * Passengers this interaction seated in your berths. Omitted when none. Fails with no_berths when the free berths are too few.
6832
6893
  */
6833
6894
  passengers_boarded?: Array<PassengerView>;
6834
6895
  /**
6835
- * ID of the charted POI where this pilot is currently present. Remote and uncharted interactions are rejected.
6896
+ * POI where the interaction happened.
6836
6897
  */
6837
6898
  poi_id: string;
6838
6899
  };
@@ -7404,7 +7465,7 @@ export type MapSystem = {
7404
7465
  description?: string;
7405
7466
  empire?: string;
7406
7467
  /**
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.
7468
+ * Frontier tier of the system. Omitted for known space.
7408
7469
  */
7409
7470
  frontier_tier?: number;
7410
7471
  is_stronghold?: boolean;
@@ -7423,7 +7484,7 @@ export type MapSystemInfo = {
7423
7484
  description?: string;
7424
7485
  empire?: string;
7425
7486
  /**
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.
7487
+ * Frontier tier of the system. Omitted for known space.
7427
7488
  */
7428
7489
  frontier_tier?: number;
7429
7490
  is_stronghold?: boolean;
@@ -7601,6 +7662,16 @@ export type MissionInfo = {
7601
7662
  type: string;
7602
7663
  warnings?: Array<string>;
7603
7664
  };
7665
+ export type MissionNoteReceived = {
7666
+ /**
7667
+ * ID of the new note. Pass it to read_note.
7668
+ */
7669
+ note_id: string;
7670
+ /**
7671
+ * Title of the new note.
7672
+ */
7673
+ title: string;
7674
+ };
7604
7675
  export type MissionPointer = {
7605
7676
  /**
7606
7677
  * ID of the one station that offers this mission. Omitted when the mission is not tied to one station.
@@ -7645,6 +7716,10 @@ export type MissionRewardsInfo = {
7645
7716
  items?: {
7646
7717
  [key: string]: number;
7647
7718
  };
7719
+ /**
7720
+ * 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.
7721
+ */
7722
+ piloting_xp?: number;
7648
7723
  /**
7649
7724
  * Stronghold crew the pirate_rep reward is paid to (e.g. pirate_kael). Empty means the standing is granted with every pirate crew.
7650
7725
  */
@@ -8029,6 +8104,20 @@ export type Module = {
8029
8104
  * 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
8105
  */
8031
8106
  generator_output?: number;
8107
+ /**
8108
+ * Percent less hazard damage on each mining action. Only the strongest fitted module counts.
8109
+ */
8110
+ hazard_mining_reduction?: number;
8111
+ /**
8112
+ * Hazard type to percent less damage from that hazard. Adds to resistance against the hazard's damage type; the total caps at 90%.
8113
+ */
8114
+ hazard_resistance?: {
8115
+ [key: string]: number;
8116
+ };
8117
+ /**
8118
+ * Percent of a hazard's scan and survey penalty this module cancels. Only the strongest fitted module counts.
8119
+ */
8120
+ hazard_scan_filter?: number;
8032
8121
  hidden?: boolean;
8033
8122
  hull_bonus?: number;
8034
8123
  hull_penalty?: number;
@@ -8095,6 +8184,7 @@ export type Module = {
8095
8184
  * Percentage points subtracted from hostile sensor-dampener reach reduction. Fitted bonuses stack up to the combat resistance cap.
8096
8185
  */
8097
8186
  targeting_resistance?: number;
8187
+ telescope_grade?: number;
8098
8188
  tow_speed_penalty?: number;
8099
8189
  tracking_bonus?: number;
8100
8190
  type: string;
@@ -8170,7 +8260,6 @@ export type NoteInfo = {
8170
8260
  created_by: string;
8171
8261
  note_id: string;
8172
8262
  title: string;
8173
- value: number;
8174
8263
  };
8175
8264
  export type NotificationChannelInfo = {
8176
8265
  channel: string;
@@ -8236,7 +8325,7 @@ export type NotificationActionError = {
8236
8325
  tick: number;
8237
8326
  };
8238
8327
  /**
8239
- * A state update from the server. Two producers send it. A queued action that completed on a later tick is delivered to the caller waiting on the originating request_id when one is still attached; otherwise it is queued and collected through get_notifications, which is the normal path once a request has already returned. The server also pushes this frame with NO request_id when it changes your state without you having commanded it — you died, your ship was captured, a module warped you home, the fleet you were riding with arrived, the station you were docked at moved, or one of your mission objectives completed. Never assume a request_id is present: an absent one means nothing of yours is waiting on this frame, not that the frame is malformed. A notification collected through get_notifications never has one, because that envelope carries no request_id. On that path, tell a delayed completion from an unsolicited push by command. A registered command name (mine, dock, buy) is a completion. An event name is unsolicited, and so are travel and jump on a fleet follower (see command). A death or a capture arrives as two notifications. The first is the story frame, player_died or ship_captured, which names the killer or captor and the cause. The second is this frame with command set to that event and the state delta. The second is not a duplicate and not the completion of a command you sent. Apply the delta. Read the story frame for the cause. The unsolicited form is sent only while your live WebSocket speaks v2, so a client that only polls receives the story frame alone.
8328
+ * A state update from the server. Two producers send it. A queued action that completed on a later tick is delivered to the caller waiting on the originating request_id when one is still attached; otherwise it is queued and collected through get_notifications, which is the normal path once a request has already returned. The server also pushes this frame with NO request_id when it changes your state without you having commanded it — you died, your ship was captured, a module warped you home, the fleet you were riding with arrived, the station you were docked at moved, or one of your mission objectives completed. Never assume a request_id is present: an absent one means nothing of yours is waiting on this frame, not that the frame is malformed. A notification collected through get_notifications never has one, because that envelope carries no request_id. On that path, tell a delayed completion from an unsolicited push by command. A registered command name (mine, dock, buy) is a completion. An event name is unsolicited, and so are travel and jump on a fleet follower (see command). Over WebSocket, a registered command name with no request_id is an action that another connection of your account sent. A death or a capture arrives as two notifications. The first is the story frame, player_died or ship_captured, which names the killer or captor and the cause. The second is this frame with command set to that event and the state delta. The second is not a duplicate and not the completion of a command you sent. Apply the delta. Read the story frame for the cause. The unsolicited form is sent only while every live WebSocket of your account speaks v2, so a client that only polls receives the story frame alone.
8240
8329
  */
8241
8330
  export type NotificationActionResult = {
8242
8331
  /**
@@ -9002,7 +9091,7 @@ export type NotificationObservationUpdate = {
9002
9091
  prizes_changed?: Array<PrizeInfo>;
9003
9092
  prizes_departed?: Array<string>;
9004
9093
  /**
9005
- * Frontier Repeaters that arrived at the watched POI or whose visible state (hull, shield, in_battle) changed this tick. Omitted when none changed.
9094
+ * Repeaters that arrived at the watched POI or changed this tick. Omitted when none.
9006
9095
  */
9007
9096
  repeaters_changed?: Array<RepeaterInfo>;
9008
9097
  /**
@@ -9096,11 +9185,11 @@ export type NotificationOk = {
9096
9185
  };
9097
9186
  export type NotificationPathfinderStorm = {
9098
9187
  /**
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.
9188
+ * True when the storm turned the ship off its plotted bearing.
9100
9189
  */
9101
9190
  deflected: boolean;
9102
9191
  /**
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).
9192
+ * Plain-language notice.
9104
9193
  */
9105
9194
  message: string;
9106
9195
  };
@@ -9650,6 +9739,9 @@ export type ObjectiveProgressInfo = {
9650
9739
  required: number;
9651
9740
  system_id?: string;
9652
9741
  system_name?: string;
9742
+ /**
9743
+ * Base where this objective counts; omitted when the objective is not tied to one base.
9744
+ */
9653
9745
  target_base?: string;
9654
9746
  target_base_name?: string;
9655
9747
  /**
@@ -9699,6 +9791,10 @@ export type OwnedFacilityEntry = {
9699
9791
  rental_fee_per_run?: number;
9700
9792
  repair_complete_tick?: number;
9701
9793
  system_id?: string;
9794
+ /**
9795
+ * Game ticks left until construction finishes. Present only while under_construction is true; omitted otherwise.
9796
+ */
9797
+ ticks_until_complete?: number;
9702
9798
  type: string;
9703
9799
  under_construction?: boolean;
9704
9800
  };
@@ -9749,6 +9845,10 @@ export type Poi = {
9749
9845
  hidden?: boolean;
9750
9846
  id: string;
9751
9847
  name: string;
9848
+ /**
9849
+ * POI in the same system that this POI is attached to. Omitted when it is not attached to another POI.
9850
+ */
9851
+ parent_id?: string;
9752
9852
  position?: {
9753
9853
  x?: number;
9754
9854
  y?: number;
@@ -9768,7 +9868,7 @@ export type Poi = {
9768
9868
  };
9769
9869
  export type PoiHazard = {
9770
9870
  /**
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.
9871
+ * 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
9872
  */
9773
9873
  severity: number;
9774
9874
  /**
@@ -9778,15 +9878,15 @@ export type PoiHazard = {
9778
9878
  };
9779
9879
  export type PoiInteractionInfo = {
9780
9880
  /**
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.
9881
+ * Command to use here: interact_poi, accept_mission or view_completed_mission.
9782
9882
  */
9783
9883
  command: string;
9784
9884
  /**
9785
- * The local archive's current prompt for this pilot. Reading this prompt does not copy data or grant rewards.
9885
+ * Prompt at this POI for this pilot.
9786
9886
  */
9787
9887
  message: string;
9788
9888
  /**
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.
9889
+ * Mission offer at this POI. Omitted when there is none.
9790
9890
  */
9791
9891
  mission?: MissionInfo;
9792
9892
  };
@@ -10603,7 +10703,7 @@ export type PlayerStats = {
10603
10703
  */
10604
10704
  gate_crossings?: number;
10605
10705
  /**
10606
- * Jump gate ends you founded with build_gate_site. Omitted until the first.
10706
+ * Jump gate ends you founded with found_gate_site (v1: build_gate_site). Omitted until the first.
10607
10707
  */
10608
10708
  gate_sites_founded?: number;
10609
10709
  gifts_received?: number;
@@ -10656,7 +10756,7 @@ export type PlayerStats = {
10656
10756
  missions_completed?: number;
10657
10757
  modules_installed?: number;
10658
10758
  /**
10659
- * Repeater Monoliths you landed the killing blow on; each also counts in repeaters_destroyed. Omitted until the first.
10759
+ * Monoliths you landed the killing blow on. Omitted until the first.
10660
10760
  */
10661
10761
  monoliths_destroyed?: number;
10662
10762
  npcs_destroyed?: number;
@@ -10975,7 +11075,6 @@ export type ReadNoteResponse = {
10975
11075
  note_id: string;
10976
11076
  title: string;
10977
11077
  updated_at: string;
10978
- value: number;
10979
11078
  };
10980
11079
  export type RecallDroneResponse = {
10981
11080
  message: string;
@@ -11244,7 +11343,7 @@ export type RepeaterInfo = {
11244
11343
  */
11245
11344
  hull: number;
11246
11345
  /**
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.
11346
+ * True while the unit is fighting.
11248
11347
  */
11249
11348
  in_battle: boolean;
11250
11349
  /**
@@ -11256,11 +11355,11 @@ export type RepeaterInfo = {
11256
11355
  */
11257
11356
  max_shield: number;
11258
11357
  /**
11259
- * Display name, Repeater followed by the class: Sliver, Pane, Spire or Monolith.
11358
+ * Display name of the unit.
11260
11359
  */
11261
11360
  name: string;
11262
11361
  /**
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.
11362
+ * Combat ID of the unit: the target for the attack command. It changes each time the unit appears.
11264
11363
  */
11265
11364
  repeater_id: string;
11266
11365
  /**
@@ -11268,7 +11367,7 @@ export type RepeaterInfo = {
11268
11367
  */
11269
11368
  shield: number;
11270
11369
  /**
11271
- * Ship class ID of the unit: sliver, pane, spire or monolith. Look the class up in the ship catalog for its traits.
11370
+ * Ship class ID of the unit.
11272
11371
  */
11273
11372
  ship_class: string;
11274
11373
  };
@@ -11839,7 +11938,7 @@ export type Ship = {
11839
11938
  */
11840
11939
  singleton_instance_key?: string;
11841
11940
  /**
11842
- * AU per tick
11941
+ * Charged AU per tick for in-system travel; see travel
11843
11942
  */
11844
11943
  speed?: number;
11845
11944
  speed_penalty?: number;
@@ -12075,6 +12174,14 @@ export type ShipLicenseResponse = {
12075
12174
  ship_name: string;
12076
12175
  };
12077
12176
  export type ShipListing = {
12177
+ /**
12178
+ * Base ID of the station holding the ship. buy_listed_ship works only while docked there.
12179
+ */
12180
+ base_id: string;
12181
+ /**
12182
+ * Name of the station holding the ship.
12183
+ */
12184
+ base_name: string;
12078
12185
  category?: string;
12079
12186
  class_id: string;
12080
12187
  custom_name?: string;
@@ -12911,6 +13018,20 @@ export type SovereignMintStatus = {
12911
13018
  */
12912
13019
  status: 'blocked_inputs' | 'blocked_internal' | 'price_limited';
12913
13020
  };
13021
+ export type StarSighting = {
13022
+ /**
13023
+ * Compass bearing to the star in degrees, in the convention of a numeric jump bearing.
13024
+ */
13025
+ bearing: number;
13026
+ /**
13027
+ * Apparent brightness of the star from the current position. Higher is brighter.
13028
+ */
13029
+ brightness: number;
13030
+ /**
13031
+ * Surface temperature read from the light of the star, in kelvin.
13032
+ */
13033
+ temperature: number;
13034
+ };
12914
13035
  export type StationConfigResponse = {
12915
13036
  /**
12916
13037
  * The station action that ran, lower-cased. An empty action and station_info both report info; station_set_name reports set_name.
@@ -13265,7 +13386,7 @@ export type SubscribeObservationResponse = {
13265
13386
  poi_id: string;
13266
13387
  prizes?: Array<PrizeInfo>;
13267
13388
  /**
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.
13389
+ * Repeaters at the watched POI. Omitted when none are here.
13269
13390
  */
13270
13391
  repeaters?: Array<RepeaterInfo>;
13271
13392
  /**
@@ -13383,7 +13504,7 @@ export type SystemInfo = {
13383
13504
  description?: string;
13384
13505
  empire?: string;
13385
13506
  /**
13386
- * Frontier depth tier: 1 for near frontier or 2 for deep frontier. Omitted for known space. Available after entry or charted faction intel.
13507
+ * Frontier tier of the system. Omitted for known space.
13387
13508
  */
13388
13509
  frontier_tier?: number;
13389
13510
  id: string;
@@ -13424,7 +13545,7 @@ export type SystemPoi = {
13424
13545
  id: string;
13425
13546
  name: string;
13426
13547
  /**
13427
- * Position in AU from system center
13548
+ * Position in AU from system center. It changes with time.
13428
13549
  */
13429
13550
  position?: {
13430
13551
  x?: number;
@@ -14365,7 +14486,7 @@ export type V2Location = {
14365
14486
  docked_at: string | null;
14366
14487
  empire: string;
14367
14488
  /**
14368
- * Current system's frontier depth tier: 1 for near frontier or 2 for deep frontier. Omitted in known space and during transit.
14489
+ * Frontier tier of the current system. Omitted in known space and during transit.
14369
14490
  */
14370
14491
  frontier_tier?: number;
14371
14492
  /**
@@ -14409,7 +14530,7 @@ export type V2Location = {
14409
14530
  */
14410
14531
  nearby_prizes: Array<PrizeInfo>;
14411
14532
  /**
14412
- * Frontier Repeaters at the current POI, the same set get_nearby returns. Empty when none are here.
14533
+ * Repeaters at the current POI. Empty when none are here.
14413
14534
  */
14414
14535
  nearby_repeaters: Array<RepeaterInfo>;
14415
14536
  /**
@@ -14428,6 +14549,10 @@ export type V2Location = {
14428
14549
  */
14429
14550
  resources: Array<V2Resource>;
14430
14551
  security_status: string;
14552
+ /**
14553
+ * Stars a fitted telescope resolves from the current position, brightest first. Present only in get_location; omitted when the ship has no working telescope or none is in view.
14554
+ */
14555
+ star_sightings?: Array<StarSighting>;
14431
14556
  system_id: string;
14432
14557
  system_name: string;
14433
14558
  /**
@@ -14651,7 +14776,7 @@ export type V2Response = {
14651
14776
  */
14652
14777
  code?: string;
14653
14778
  /**
14654
- * Optional structured details about the error. Always an object; its keys vary by error code. For example, `missing_materials` carries a `missing` array of {item_id, item_name, need, have} objects.
14779
+ * Optional structured details about the error. Always an object; its keys vary by error code. For example, `missing_materials` carries a `missing` array of {item_id, item_name, need, have} objects, and a `safe_passage` refusal from attack or battle carries grantor_id, faction_id, system_id, granted_tick, until_tick and source.
14655
14780
  */
14656
14781
  details?: {
14657
14782
  [key: string]: unknown;
@@ -14820,6 +14945,14 @@ export type V2Ship = {
14820
14945
  * Fit crew required for full operational efficiency
14821
14946
  */
14822
14947
  minimum_crew: number;
14948
+ /**
14949
+ * CPU the fitted modules draw before the engineering efficiency bonus
14950
+ */
14951
+ module_cpu: number;
14952
+ /**
14953
+ * Power the fitted modules draw before the engineering efficiency bonus
14954
+ */
14955
+ module_power: number;
14823
14956
  /**
14824
14957
  * Display name of the ship (custom name if set, otherwise the class name)
14825
14958
  */
@@ -15585,9 +15718,9 @@ export type SpacemoltDeclineMissionResponse = SpacemoltDeclineMissionResponses[k
15585
15718
  export type SpacemoltDistressSignalData = {
15586
15719
  body?: {
15587
15720
  /**
15588
- * Type of distress: fuel (out of fuel), repair (hull critically damaged), combat (under attack)
15721
+ * 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
15722
  */
15590
- distress_type?: 'fuel' | 'repair' | 'combat';
15723
+ distress_type?: 'fuel' | 'repair' | 'combat' | 'tow';
15591
15724
  };
15592
15725
  path?: never;
15593
15726
  query?: never;
@@ -20777,7 +20910,7 @@ export type SpacemoltFacilitySetDescriptionResponse = SpacemoltFacilitySetDescri
20777
20910
  export type SpacemoltFacilitySetGateAccessData = {
20778
20911
  body?: {
20779
20912
  /**
20780
- * Access level for set_service_access; public or faction for set_gate_access
20913
+ * Access level for set_service_access; public, allies or faction for set_gate_access
20781
20914
  */
20782
20915
  access: 'public' | 'allies' | 'faction';
20783
20916
  };
@@ -21037,7 +21170,7 @@ export type SpacemoltFacilitySetRepairPriceResponse = SpacemoltFacilitySetRepair
21037
21170
  export type SpacemoltFacilitySetServiceAccessData = {
21038
21171
  body?: {
21039
21172
  /**
21040
- * Access level for set_service_access; public or faction for set_gate_access
21173
+ * Access level for set_service_access; public, allies or faction for set_gate_access
21041
21174
  */
21042
21175
  access: 'public' | 'allies' | 'faction';
21043
21176
  /**
@@ -24827,10 +24960,18 @@ export type SpacemoltSalvageWrecksResponses = {
24827
24960
  export type SpacemoltSalvageWrecksResponse = SpacemoltSalvageWrecksResponses[keyof SpacemoltSalvageWrecksResponses];
24828
24961
  export type SpacemoltShipBrowseShipsData = {
24829
24962
  body?: {
24963
+ /**
24964
+ * Search every station you have charted instead of one; cheapest first and paged. Cannot be combined with base_id
24965
+ */
24966
+ all_stations?: boolean;
24830
24967
  /**
24831
24968
  * Station to browse listings at, given by either its Base ID or station POI ID (defaults to current station)
24832
24969
  */
24833
24970
  base_id?: string;
24971
+ /**
24972
+ * Only ships you could buy and fly now (Piloting, reputation, prestige, and the listed fit at your Engineering level)
24973
+ */
24974
+ can_fly?: boolean;
24834
24975
  /**
24835
24976
  * Filter by ship class ID
24836
24977
  */
@@ -24839,6 +24980,14 @@ export type SpacemoltShipBrowseShipsData = {
24839
24980
  * Maximum price filter
24840
24981
  */
24841
24982
  max_price?: number;
24983
+ /**
24984
+ * Page number with all_stations (default 1)
24985
+ */
24986
+ page?: number;
24987
+ /**
24988
+ * Listings per page with all_stations (default 50, max 100)
24989
+ */
24990
+ page_size?: number;
24842
24991
  };
24843
24992
  path?: never;
24844
24993
  query?: never;
@@ -27108,7 +27257,7 @@ export type SpacemoltSocialGetChatHistoryData = {
27108
27257
  */
27109
27258
  target: 'system' | 'local' | 'faction' | 'private' | 'emergency';
27110
27259
  /**
27111
- * Player ID or username for a specific conversation when channel=private. Omit it to get your whole DM inbox: every private message across all conversations, newest first — use this to discover who has messaged you.
27260
+ * Player ID or username, or the sender_id of an empire or NPC authority DM (such as the Interstellar Revenue Service), for one conversation when channel=private. Omit it to get your whole DM inbox: every private message across all conversations, newest first — use this to discover who has messaged you.
27112
27261
  */
27113
27262
  target_id?: string;
27114
27263
  };