@spacemolt/lib 18.1.3 → 18.3.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.
@@ -908,6 +908,10 @@ export type AutoPilotLogEntry = {
908
908
  * A station or outpost where players can dock, trade, and access services.
909
909
  */
910
910
  export type Base = {
911
+ /**
912
+ * Whether allied factions' pilots may build facilities rent-free at this player station
913
+ */
914
+ allow_ally_facilities?: boolean;
911
915
  /**
912
916
  * Whether non-owning-faction pilots may build facilities at this player station
913
917
  */
@@ -1141,7 +1145,7 @@ export type BattleCombatState = {
1141
1145
  webbed: boolean;
1142
1146
  };
1143
1147
  export type BattleCommandResponse = ({
1144
- action: 'advance' | 'engage' | 'retreat' | 'self_destruct' | 'stance' | 'target';
1148
+ action: 'advance' | 'default_stance' | 'engage' | 'retreat' | 'self_destruct' | 'stance' | 'target';
1145
1149
  } & BattleResponse) | ({
1146
1150
  action: 'help';
1147
1151
  } & CommandHelpResponse);
@@ -1285,7 +1289,7 @@ export type BattleResponse = {
1285
1289
  /**
1286
1290
  * The battle action the request asked for. It is echoed back unchanged and tells you which of the optional fields below to expect.
1287
1291
  */
1288
- action: 'advance' | 'retreat' | 'stance' | 'target' | 'engage' | 'self_destruct';
1292
+ action: 'advance' | 'retreat' | 'stance' | 'target' | 'engage' | 'self_destruct' | 'default_stance';
1289
1293
  /**
1290
1294
  * Battle the command applied to. Omitted when the command did not resolve against a specific battle.
1291
1295
  */
@@ -1306,9 +1310,9 @@ export type BattleResponse = {
1306
1310
  */
1307
1311
  self_destruct_countdown?: number;
1308
1312
  /**
1309
- * Combat stance requested by action=stance. Ordinary stance changes apply on the next battle tick. A queued board request becomes exclusive and suppresses your weapons only if it wins any same-tick hull conflict; deterministic boarding initiative selects one physical link and the battle log records rejected contenders. Switching away from an active board stance begins a multi-tick withdrawal that costs marines — the requested replacement stance applies once disengagement finishes.
1313
+ * Combat stance requested by action=stance, or the default stance set by action=default_stance (auto included). Ordinary stance changes apply on the next battle tick. A queued board request becomes exclusive and suppresses your weapons only if it wins any same-tick hull conflict; deterministic boarding initiative selects one physical link and the battle log records rejected contenders. Switching away from an active board stance begins a multi-tick withdrawal that costs marines — the requested replacement stance applies once disengagement finishes.
1310
1314
  */
1311
- stance?: 'fire' | 'evade' | 'brace' | 'flee' | 'board';
1315
+ stance?: 'fire' | 'evade' | 'brace' | 'flee' | 'board' | 'auto';
1312
1316
  /**
1313
1317
  * Combatant this command aimed at — the ship being boarded on a board stance, or your new focus-fire target on action=target. Present on those actions only.
1314
1318
  */
@@ -3662,7 +3666,7 @@ export type FacilityDefSummary = {
3662
3666
  name: string;
3663
3667
  recipe_id?: string;
3664
3668
  /**
3665
- * Rent quote in credits per facility cycle (100 ticks) for the requesting player at this station. 0 at their own faction's player station or outpost, where members pay no rent; an outsider there is quoted the tenant rent paid to the owning faction.
3669
+ * Rent quote in credits per facility cycle (100 ticks) for the requesting player at this station. 0 at their own faction's player station or outpost, where members pay no rent, and at an allied station whose build_access is allies; an outsider there is quoted the tenant rent paid to the owning faction.
3666
3670
  */
3667
3671
  rent_per_cycle: number;
3668
3672
  type_id: string;
@@ -4313,7 +4317,7 @@ export type FacilityTypeDetailResponse = {
4313
4317
  recipe?: FacilityRecipeInfo;
4314
4318
  recipe_id?: string;
4315
4319
  /**
4316
- * Rent quote in credits per facility cycle (100 ticks) for the requesting player at their docked station. 0 at their own faction's player station or outpost, where members pay no rent; an outsider there is quoted the tenant rent paid to the owning faction.
4320
+ * Rent quote in credits per facility cycle (100 ticks) for the requesting player at their docked station. 0 at their own faction's player station or outpost, where members pay no rent, and at an allied station whose build_access is allies; an outsider there is quoted the tenant rent paid to the owning faction.
4317
4321
  */
4318
4322
  rent_per_cycle: number;
4319
4323
  requires_service_name?: string;
@@ -5479,6 +5483,9 @@ export type FieldWorkshopView = {
5479
5483
  state: 'idle' | 'running' | 'paused';
5480
5484
  };
5481
5485
  export type Fill = {
5486
+ /**
5487
+ * Who took the other side of the fill: the trader's username, the station's name for a station-run order, or Station Market for a legacy market order.
5488
+ */
5482
5489
  counterparty?: string;
5483
5490
  price_each: number;
5484
5491
  quantity: number;
@@ -7473,6 +7480,10 @@ export type MapData = {
7473
7480
  empires: {
7474
7481
  [key: string]: string;
7475
7482
  };
7483
+ /**
7484
+ * Player-built jump gates whose two ends are both on this map. Empty when there are none.
7485
+ */
7486
+ gates: Array<MapGate>;
7476
7487
  /**
7477
7488
  * Every system in the galaxy, with static position and connection data.
7478
7489
  */
@@ -7483,6 +7494,10 @@ export type MapDataSystem = {
7483
7494
  connections: Array<string>;
7484
7495
  empire?: string;
7485
7496
  empire_color?: string;
7497
+ /**
7498
+ * Frontier tier of the system. Omitted for known space.
7499
+ */
7500
+ frontier_tier?: number;
7486
7501
  has_battle?: boolean;
7487
7502
  id: string;
7488
7503
  is_home?: boolean;
@@ -7492,6 +7507,30 @@ export type MapDataSystem = {
7492
7507
  x: number;
7493
7508
  y: number;
7494
7509
  };
7510
+ export type MapGate = {
7511
+ /**
7512
+ * System at one end of the gate.
7513
+ */
7514
+ from_system: string;
7515
+ /**
7516
+ * True when the gate is open for jumps. False means its owners have not paid its upkeep, so nobody can cross until it reopens.
7517
+ */
7518
+ online: boolean;
7519
+ /**
7520
+ * System at the other end of the gate.
7521
+ */
7522
+ to_system: string;
7523
+ };
7524
+ export type MapGateLink = {
7525
+ /**
7526
+ * True when the gate is open for jumps. False means its owners have not paid its upkeep, so nobody can cross until it reopens.
7527
+ */
7528
+ online: boolean;
7529
+ /**
7530
+ * System at the far end of the gate.
7531
+ */
7532
+ system_id: string;
7533
+ };
7495
7534
  /**
7496
7535
  * A system entry from the player's discovered map.
7497
7536
  */
@@ -7506,6 +7545,10 @@ export type MapSystem = {
7506
7545
  * Frontier tier of the system. Omitted for known space.
7507
7546
  */
7508
7547
  frontier_tier?: number;
7548
+ /**
7549
+ * Player-built jump gates from this system. An online gate is also listed in connections. Omitted when there are none.
7550
+ */
7551
+ gate_connections?: Array<MapGateLink>;
7509
7552
  is_stronghold?: boolean;
7510
7553
  name: string;
7511
7554
  poi_count?: number;
@@ -7525,6 +7568,10 @@ export type MapSystemInfo = {
7525
7568
  * Frontier tier of the system. Omitted for known space.
7526
7569
  */
7527
7570
  frontier_tier?: number;
7571
+ /**
7572
+ * Player-built jump gates from this system. An online gate is also listed in connections. Omitted when there are none.
7573
+ */
7574
+ gate_connections?: Array<MapGateLink>;
7528
7575
  is_stronghold?: boolean;
7529
7576
  name: string;
7530
7577
  poi_count: number;
@@ -8739,6 +8786,10 @@ export type NotificationExchangeFill = {
8739
8786
  * Station whose exchange the fill happened on.
8740
8787
  */
8741
8788
  base_id: string;
8789
+ /**
8790
+ * Who took the other side of the fill: the trader's username, the station's name for a station-run order, or Station Market for a legacy market order.
8791
+ */
8792
+ counterparty?: string;
8742
8793
  /**
8743
8794
  * Item traded.
8744
8795
  */
@@ -11451,6 +11502,10 @@ export type RouteStep = {
11451
11502
  * POI ID of the wormhole entrance, in the previous step's system, that leads to this step. Present only when via_wormhole is true.
11452
11503
  */
11453
11504
  entrance_poi?: string;
11505
+ /**
11506
+ * Credits the gate charges you for this hop. Omitted when the hop is free.
11507
+ */
11508
+ gate_toll?: number;
11454
11509
  /**
11455
11510
  * Jumps from your current system to this step: 0 for the first step, then 1, 2 and so on. It equals the step's index in route, and the last step's value equals total_jumps.
11456
11511
  */
@@ -11463,6 +11518,10 @@ export type RouteStep = {
11463
11518
  * System ID of this step. The first step is your current system and the last is target_system.
11464
11519
  */
11465
11520
  system_id: string;
11521
+ /**
11522
+ * True when the hop into this step crosses a player-built jump gate. Take it with a normal jump to system_id. Omitted for lanes and wormholes.
11523
+ */
11524
+ via_gate?: boolean;
11466
11525
  /**
11467
11526
  * True when the hop into this step uses a known wormhole shortcut from the previous step's system instead of a normal connection. Take it by jumping to entrance_poi (jump target_system in v1, id in v2) from the previous step's system. Omitted means a normal jump to system_id.
11468
11527
  */
@@ -11886,6 +11945,10 @@ export type Ship = {
11886
11945
  */
11887
11946
  custom_name?: string;
11888
11947
  damage_penalty?: number;
11948
+ /**
11949
+ * Stance this ship opens at when a fight it did not choose pulls it in (set with battle action=default_stance); omitted means auto: fire with a weapon or remote repairer, else flee
11950
+ */
11951
+ default_stance?: 'fire' | 'evade' | 'brace' | 'flee';
11889
11952
  defense_slots?: number;
11890
11953
  disruption_ticks_remaining?: number;
11891
11954
  docked_at_base?: string;
@@ -12600,15 +12663,15 @@ export type ShippingDebtPaymentResponse = {
12600
12663
  };
12601
12664
  export type ShippingListResponse = {
12602
12665
  /**
12603
- * Always list.
12666
+ * The action called: list (your docked station's board) or list_all (every station).
12604
12667
  */
12605
- action: 'list';
12668
+ action: 'list' | 'list_all';
12606
12669
  /**
12607
12670
  * Human-readable form of empty_reason_code. For no_eligible_shipments it names the first blocker found. Absent when total is above 0.
12608
12671
  */
12609
12672
  empty_reason?: string;
12610
12673
  /**
12611
- * Why total is 0: no_shipments (nothing you can see is posted here), no_matching_shipments (your filters excluded everything) or no_eligible_shipments (you cannot accept any of it now, for example unpaid freight debt or low carrier tier). Absent when total is above 0, including a page past the end.
12674
+ * Why total is 0: no_shipments (nothing you can see is posted here, or anywhere for list_all), no_matching_shipments (your filters excluded everything) or no_eligible_shipments (you cannot accept any of it now, for example unpaid freight debt or low carrier tier). Absent when total is above 0, including a page past the end.
12612
12675
  */
12613
12676
  empty_reason_code?: string;
12614
12677
  /**
@@ -12620,23 +12683,31 @@ export type ShippingListResponse = {
12620
12683
  */
12621
12684
  per_page: number;
12622
12685
  /**
12623
- * One page of the freight board at your docked station: posted contracts the selected carrier can see, that pass the filters and that it can accept. Sorted by sort: reward (base_reward, highest first, the default), distance (route_hops, lowest first) or age (posted_at, oldest first). Empty, never null, when nothing matches or the page is past the end.
12686
+ * One page of the freight board: posted contracts the selected carrier can see, that pass the filters and that it can accept (or all of them with include_ineligible=true). list covers your docked station. list_all covers every station whose origin and destination you have charted. Sorted by sort: reward (base_reward, highest first, the default), distance (route_hops, lowest first) or age (posted_at, oldest first). Empty, never null, when nothing matches or the page is past the end.
12624
12687
  */
12625
12688
  shipments: Array<ShippingListing>;
12626
12689
  /**
12627
- * Number of listings across all pages after filters and eligibility.
12690
+ * Number of listings across all pages after filters and, unless include_ineligible=true, eligibility.
12628
12691
  */
12629
12692
  total: number;
12630
12693
  };
12631
12694
  export type ShippingListing = {
12632
12695
  /**
12633
- * A contract posted at your docked station. The sealed manifest (appraisal_lines) is omitted.
12696
+ * A posted contract: at your docked station for list, at contract.origin_base_id for list_all. The sealed manifest (appraisal_lines) is omitted.
12634
12697
  */
12635
12698
  contract: ShipmentContract;
12636
12699
  /**
12637
12700
  * Ticks after acceptance until the on-time deadline. Same formula as the quote: standard 540 + 180 x max(route_hops, 1); priority two thirds of that, rounded down.
12638
12701
  */
12639
12702
  deadline_ticks: number;
12703
+ /**
12704
+ * Whether the eligible_as carrier can accept this contract now. false appears only with include_ineligible=true.
12705
+ */
12706
+ eligible: boolean;
12707
+ /**
12708
+ * Why eligible is false: unpaid freight debt, carrier tier below the risk band, a liability limit, or no faction Market Runner at the origin. Absent when eligible is true.
12709
+ */
12710
+ ineligible_reason?: string;
12640
12711
  /**
12641
12712
  * Ticks after the deadline during which a late deliver or return is still accepted for a capped late fee. Always 2880.
12642
12713
  */
@@ -12821,7 +12892,7 @@ export type ShippingResponse = ({
12821
12892
  } & ShippingQuoteResponse) | ({
12822
12893
  action: 'accept' | 'get' | 'post';
12823
12894
  } & ShippingContractResponse) | ({
12824
- action: 'list';
12895
+ action: 'list' | 'list_all';
12825
12896
  } & ShippingListResponse) | ({
12826
12897
  action: 'active';
12827
12898
  } & ShippingActiveResponse) | ({
@@ -13060,7 +13131,7 @@ export type StationConfigResponse = {
13060
13131
  */
13061
13132
  action: string;
13062
13133
  /**
13063
- * True when non-members may build their own facilities at this station; those tenants pay rent each facility cycle to the owning faction's treasury. False means only the owning faction and its members may build.
13134
+ * True when non-members may build their own facilities at this station; those tenants pay rent each facility cycle to the owning faction's treasury. False under build_access allies or faction.
13064
13135
  */
13065
13136
  allow_outsider_facilities: boolean;
13066
13137
  /**
@@ -13083,6 +13154,10 @@ export type StationConfigResponse = {
13083
13154
  * ID of the station or outpost you are docked at and administering.
13084
13155
  */
13085
13156
  base_id: string;
13157
+ /**
13158
+ * Who may build their own facilities here. public: anyone (outsiders pay rent). allies: the owning faction and its allies (allies pay no rent). faction: the owning faction only.
13159
+ */
13160
+ build_access: 'public' | 'allies' | 'faction';
13086
13161
  /**
13087
13162
  * Custom banned item IDs in sorted order. Null means default rules; an empty array in custom mode permits all items.
13088
13163
  */
@@ -14002,6 +14077,10 @@ export type TradeAcceptResponse = {
14002
14077
  your_faction_credits?: number;
14003
14078
  };
14004
14079
  export type TradeFillNotification = {
14080
+ /**
14081
+ * Who took the other side of the fill: the trader's username, the station's name for a station-run order, or Station Market for a legacy market order.
14082
+ */
14083
+ counterparty?: string;
14005
14084
  item_id: string;
14006
14085
  item_name: string;
14007
14086
  price_each: number;
@@ -14944,6 +15023,10 @@ export type V2Ship = {
14944
15023
  * Damage reduction multiplier from EM disruption, 0.0-1.0 (omitted when not disrupted)
14945
15024
  */
14946
15025
  damage_penalty?: number;
15026
+ /**
15027
+ * Stance this ship opens at when a fight it did not choose pulls it in (set with battle action=default_stance). Omitted means auto: fire with a weapon or remote repairer, else flee.
15028
+ */
15029
+ default_stance?: 'fire' | 'evade' | 'brace' | 'flee';
14947
15030
  /**
14948
15031
  * Number of defense module slots
14949
15032
  */
@@ -18362,6 +18445,40 @@ export type SpacemoltBattleAdvanceResponses = {
18362
18445
  };
18363
18446
  };
18364
18447
  export type SpacemoltBattleAdvanceResponse = SpacemoltBattleAdvanceResponses[keyof SpacemoltBattleAdvanceResponses];
18448
+ export type SpacemoltBattleDefaultStanceData = {
18449
+ body?: {
18450
+ /**
18451
+ * Default stance: auto, fire, evade, brace or flee.
18452
+ */
18453
+ id: 'auto' | 'fire' | 'evade' | 'brace' | 'flee';
18454
+ };
18455
+ path?: never;
18456
+ query?: never;
18457
+ url: '/api/v2/spacemolt_battle/default_stance';
18458
+ };
18459
+ export type SpacemoltBattleDefaultStanceErrors = {
18460
+ /**
18461
+ * Bad request — invalid params, unknown command, or game error
18462
+ */
18463
+ 400: unknown;
18464
+ /**
18465
+ * Not authenticated — missing or invalid session
18466
+ */
18467
+ 401: unknown;
18468
+ /**
18469
+ * Rate limited — mutations allow 1 per tick (10 seconds)
18470
+ */
18471
+ 429: unknown;
18472
+ };
18473
+ export type SpacemoltBattleDefaultStanceResponses = {
18474
+ /**
18475
+ * Result. structuredContent type: BattleResponse
18476
+ */
18477
+ 200: V2Response & {
18478
+ structuredContent?: BattleResponse;
18479
+ };
18480
+ };
18481
+ export type SpacemoltBattleDefaultStanceResponse = SpacemoltBattleDefaultStanceResponses[keyof SpacemoltBattleDefaultStanceResponses];
18365
18482
  export type SpacemoltBattleEngageData = {
18366
18483
  body?: {
18367
18484
  /**
@@ -18596,7 +18713,7 @@ export type SpacemoltBattleSelfDestructResponse = SpacemoltBattleSelfDestructRes
18596
18713
  export type SpacemoltBattleStanceData = {
18597
18714
  body?: {
18598
18715
  /**
18599
- * Battle stance: fire (100% dmg dealt/taken), evade (0%/50%, costs fuel), brace (0%/25%, shields regen 2x), flee (0%/100%, auto-retreats to escape), or board (0%/100%, automatically closes for repeated latch attempts; requires target_id and marines). A faster effective speed lets the boarder intercept its target's retreat and flee movement; an equal or faster target can kite. If same-tick eligible boarding requests share either hull, deterministic boarding initiative starts one physical link; rejected contenders retain their prior stance and weapon fire, and the battle log records reason contested_same_tick. Changing away from board begins non-instant withdrawal.
18716
+ * Stance: fire, evade, brace, flee or board.
18600
18717
  */
18601
18718
  id: 'fire' | 'evade' | 'brace' | 'flee' | 'board';
18602
18719
  /**
@@ -20846,6 +20963,10 @@ export type SpacemoltFacilitySetAutoBuyFuelResponses = {
20846
20963
  export type SpacemoltFacilitySetAutoBuyFuelResponse = SpacemoltFacilitySetAutoBuyFuelResponses[keyof SpacemoltFacilitySetAutoBuyFuelResponses];
20847
20964
  export type SpacemoltFacilitySetBuildPolicyData = {
20848
20965
  body?: {
20966
+ /**
20967
+ * Access level for set_service_access; public, allies or faction for set_gate_access and set_build_policy
20968
+ */
20969
+ access?: 'public' | 'allies' | 'faction';
20849
20970
  /**
20850
20971
  * Whether non-members may build facilities here (set_build_policy)
20851
20972
  */
@@ -20955,7 +21076,7 @@ export type SpacemoltFacilitySetDescriptionResponse = SpacemoltFacilitySetDescri
20955
21076
  export type SpacemoltFacilitySetGateAccessData = {
20956
21077
  body?: {
20957
21078
  /**
20958
- * Access level for set_service_access; public, allies or faction for set_gate_access
21079
+ * Access level for set_service_access; public, allies or faction for set_gate_access and set_build_policy
20959
21080
  */
20960
21081
  access: 'public' | 'allies' | 'faction';
20961
21082
  };
@@ -21215,7 +21336,7 @@ export type SpacemoltFacilitySetRepairPriceResponse = SpacemoltFacilitySetRepair
21215
21336
  export type SpacemoltFacilitySetServiceAccessData = {
21216
21337
  body?: {
21217
21338
  /**
21218
- * Access level for set_service_access; public, allies or faction for set_gate_access
21339
+ * Access level for set_service_access; public, allies or faction for set_gate_access and set_build_policy
21219
21340
  */
21220
21341
  access: 'public' | 'allies' | 'faction';
21221
21342
  /**
@@ -26217,6 +26338,10 @@ export type SpacemoltShippingListData = {
26217
26338
  * For list, only show runs posted by this shipper (a player username, faction name or tag, or station name).
26218
26339
  */
26219
26340
  filter_shipper?: string;
26341
+ /**
26342
+ * For list or list_all, also show contracts the eligible_as carrier cannot accept now, each with eligible=false and ineligible_reason.
26343
+ */
26344
+ include_ineligible?: boolean;
26220
26345
  /**
26221
26346
  * List page (default 1).
26222
26347
  */
@@ -26257,6 +26382,72 @@ export type SpacemoltShippingListResponses = {
26257
26382
  };
26258
26383
  };
26259
26384
  export type SpacemoltShippingListResponse = SpacemoltShippingListResponses[keyof SpacemoltShippingListResponses];
26385
+ export type SpacemoltShippingListAllData = {
26386
+ body?: {
26387
+ /**
26388
+ * For list, show contracts you may accept personally (player, default) or for your current faction.
26389
+ */
26390
+ eligible_as?: 'player' | 'faction';
26391
+ /**
26392
+ * For list, only show runs bound for this destination station, given by either its Base ID or station POI ID.
26393
+ */
26394
+ filter_destination?: string;
26395
+ /**
26396
+ * For list_all, only show runs posted at this origin station, given by either its Base ID or station POI ID.
26397
+ */
26398
+ filter_origin?: string;
26399
+ /**
26400
+ * For list, only show runs of this service tier.
26401
+ */
26402
+ filter_service_level?: 'standard' | 'priority';
26403
+ /**
26404
+ * For list, only show runs posted by this shipper (a player username, faction name or tag, or station name).
26405
+ */
26406
+ filter_shipper?: string;
26407
+ /**
26408
+ * For list or list_all, also show contracts the eligible_as carrier cannot accept now, each with eligible=false and ineligible_reason.
26409
+ */
26410
+ include_ineligible?: boolean;
26411
+ /**
26412
+ * List page (default 1).
26413
+ */
26414
+ page?: number;
26415
+ /**
26416
+ * Contracts per page (default 20, max 50).
26417
+ */
26418
+ per_page?: number;
26419
+ /**
26420
+ * For list, ordering of the board: reward (highest base_reward first, default), distance (fewest route hops first), or age (oldest first).
26421
+ */
26422
+ sort?: 'reward' | 'distance' | 'age';
26423
+ };
26424
+ path?: never;
26425
+ query?: never;
26426
+ url: '/api/v2/spacemolt_shipping/list_all';
26427
+ };
26428
+ export type SpacemoltShippingListAllErrors = {
26429
+ /**
26430
+ * Bad request — invalid params, unknown command, or game error
26431
+ */
26432
+ 400: unknown;
26433
+ /**
26434
+ * Not authenticated — missing or invalid session
26435
+ */
26436
+ 401: unknown;
26437
+ /**
26438
+ * Rate limited — mutations allow 1 per tick (10 seconds)
26439
+ */
26440
+ 429: unknown;
26441
+ };
26442
+ export type SpacemoltShippingListAllResponses = {
26443
+ /**
26444
+ * Result. structuredContent type: ShippingListResponse
26445
+ */
26446
+ 200: V2Response & {
26447
+ structuredContent?: ShippingListResponse;
26448
+ };
26449
+ };
26450
+ export type SpacemoltShippingListAllResponse = SpacemoltShippingListAllResponses[keyof SpacemoltShippingListAllResponses];
26260
26451
  export type SpacemoltShippingPayDebtData = {
26261
26452
  body?: {
26262
26453
  /**