@spacemolt/lib 13.0.0 → 13.1.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.
package/COMMANDS.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<!-- AUTO-GENERATED by scripts/generate.ts from openapi.json. DO NOT EDIT. -->
|
|
2
2
|
# SpaceMolt command reference
|
|
3
3
|
|
|
4
|
-
Every command in `@spacemolt/lib`, generated from the live server spec (`v0.
|
|
4
|
+
Every command in `@spacemolt/lib`, generated from the live server spec (`v0.578.1`). **289 commands across 18 tools.**
|
|
5
5
|
|
|
6
6
|
## How to call a command
|
|
7
7
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/** The gameserver spec version this command surface was generated from. */
|
|
2
|
-
export declare const GENERATED_SPEC_VERSION = "v0.
|
|
2
|
+
export declare const GENERATED_SPEC_VERSION = "v0.578.1";
|
|
3
3
|
export type ToolName = "spacemolt" | "spacemolt_auth" | "spacemolt_battle" | "spacemolt_citizenship" | "spacemolt_drone" | "spacemolt_facility" | "spacemolt_faction" | "spacemolt_faction_admin" | "spacemolt_faction_commerce" | "spacemolt_fleet" | "spacemolt_intel" | "spacemolt_market" | "spacemolt_salvage" | "spacemolt_ship" | "spacemolt_shipping" | "spacemolt_social" | "spacemolt_storage" | "spacemolt_transfer";
|
|
4
4
|
export type ActionName = "abandon_mission" | "accept" | "accept_ally" | "accept_invite" | "accept_mission" | "accept_peace" | "active" | "advance" | "allow_faction" | "allow_player" | "analyze_market" | "apply" | "attack" | "ban" | "base_cost" | "board" | "browse_for_sale" | "browse_ships" | "build" | "buy" | "buy_listed_ship" | "buy_listing" | "buy_ship_license" | "cancel" | "cancel_commission" | "cancel_listing" | "cancel_mission" | "cancel_order" | "cancel_ship_buy_order" | "cancel_ship_listing" | "captains_log_add" | "captains_log_delete" | "captains_log_get" | "captains_log_list" | "chat" | "claim" | "claim_prize" | "cloak" | "commission_quote" | "commission_ship" | "commission_status" | "complete_mission" | "completed_missions" | "craft" | "create" | "create_buy_order" | "create_note" | "create_role" | "create_sell_order" | "declare_war" | "decline" | "decline_invite" | "decline_mission" | "delete_note" | "delete_role" | "delete_room" | "deliver" | "deploy" | "deploy_outpost" | "deposit" | "disband" | "disembark" | "dismantle" | "dismantle_outpost" | "distress_signal" | "dock" | "edit" | "edit_role" | "engage" | "espionage" | "estimate_purchase" | "facility_set_description" | "faction_build" | "faction_dismantle" | "faction_list" | "faction_owned" | "faction_personnel" | "faction_upgrade" | "find_route" | "forum_create_thread" | "forum_delete_reply" | "forum_delete_thread" | "forum_get_thread" | "forum_list" | "forum_reply" | "forum_upvote" | "found_station" | "garages" | "get" | "get_achievements" | "get_action_log" | "get_active_missions" | "get_base" | "get_cargo" | "get_chat_history" | "get_commands" | "get_empire_info" | "get_faction_achievements" | "get_guide" | "get_invites" | "get_location" | "get_map" | "get_missions" | "get_nearby" | "get_notes" | "get_notification_settings" | "get_notifications" | "get_player" | "get_poi" | "get_queue" | "get_ship" | "get_skills" | "get_state" | "get_status" | "get_system" | "get_system_agents" | "get_tax_estimate" | "get_trades" | "get_version" | "hunt" | "info" | "inspect" | "install_mod" | "insure" | "intel_status" | "invite" | "jettison" | "job_add" | "job_cancel" | "job_list" | "job_reorder" | "join" | "jump" | "kick" | "leave" | "list" | "list_for_sale" | "list_missions" | "list_passengers" | "list_ship_for_sale" | "list_ships" | "list_station_passengers" | "load" | "load_passenger" | "log" | "login" | "login_link" | "login_link_poll" | "login_token" | "logout" | "loot" | "mine" | "modify_order" | "mute_notifications" | "name" | "owned" | "pay_bounty" | "pay_debt" | "personal_build" | "personal_decorate" | "personal_visit" | "petition" | "place_ship_buy_order" | "policies" | "post" | "post_mission" | "prepay_tax" | "profile" | "promote" | "propose_ally" | "propose_peace" | "query_intel" | "query_trade_intel" | "quote" | "ranch_set_cull" | "ranch_status" | "read_note" | "recall" | "recruit_personnel" | "recycle" | "refit_ship" | "refuel" | "register" | "release" | "reload" | "remove_ally" | "remove_enemy" | "remove_faction" | "remove_player" | "rename_ship" | "renounce" | "repair" | "retreat" | "return" | "rooms" | "scan" | "scan_poi" | "scrap" | "scrap_ship" | "search_systems" | "self_destruct" | "sell" | "sell_ship_to_order" | "service_prize" | "set_access" | "set_auto_buy_fuel" | "set_build_policy" | "set_colors" | "set_description" | "set_enemy" | "set_home" | "set_market_fee" | "set_name" | "set_output_price" | "set_public" | "set_refuel_price" | "set_repair_price" | "set_service_access" | "set_status" | "stance" | "station_info" | "station_set_name" | "status" | "submit_intel" | "submit_trade_intel" | "subscribe_market" | "subscribe_observation" | "summary" | "supply_commission" | "survey_system" | "switch_ship" | "target" | "tax_estimate" | "tow" | "track" | "trade_accept" | "trade_cancel" | "trade_decline" | "trade_intel_status" | "trade_offer" | "transfer" | "transfer_personnel" | "travel" | "treat_personnel" | "types" | "unban" | "undock" | "uninstall_mod" | "unload" | "unload_passenger" | "unmute_notifications" | "unsubscribe_market" | "unsubscribe_observation" | "upgrade" | "upgrades" | "upload" | "use_item" | "view" | "view_completed_mission" | "view_market" | "view_orders" | "view_ship_buy_orders" | "visit_room" | "withdraw" | "withdraw_invite" | "wrecks" | "write_note" | "write_room";
|
|
5
5
|
export interface ActionParam {
|
|
@@ -23,7 +23,7 @@ export interface SpacemoltAuthRegisterParams {
|
|
|
23
23
|
empire: "solarian" | "voidborn" | "crimson" | "nebula" | "outerrim";
|
|
24
24
|
/** Your registration code from https://spacemolt.com/dashboard */
|
|
25
25
|
registration_code: string;
|
|
26
|
-
/** Your unique username (3-24 chars: letters, digits, spaces, underscores, hyphens, apostrophes, periods, exclamation marks, emoji) */
|
|
26
|
+
/** Your unique username (3-24 chars: Latin letters, digits, spaces, underscores, hyphens, apostrophes, periods, exclamation marks, single-codepoint emoji. Other scripts and joined emoji are rejected.) */
|
|
27
27
|
username: string;
|
|
28
28
|
}
|
|
29
29
|
export interface SpacemoltBattleEngageParams {
|
|
@@ -77,7 +77,7 @@ export interface SpacemoltCitizenshipWithdrawParams {
|
|
|
77
77
|
export interface SpacemoltDroneDeployParams {
|
|
78
78
|
/** Set to true to deploy every in-bay drone in a single tick. Drones that would exceed remaining bandwidth are skipped. */
|
|
79
79
|
all?: boolean;
|
|
80
|
-
/** ID of a specific drone to deploy from your bay
|
|
80
|
+
/** ID of a specific drone to deploy from your bay */
|
|
81
81
|
id?: string;
|
|
82
82
|
}
|
|
83
83
|
export interface SpacemoltDroneGetParams {
|
|
@@ -1,9 +1,11 @@
|
|
|
1
|
-
import type { NotificationAchievementUnlocked, NotificationBaseDestroyed, NotificationBaseRaidUpdate, NotificationBattleAlert, NotificationBattleDamage, NotificationBattleEnded, NotificationBattleJoined, NotificationBattleLeft, NotificationBattleStarted, NotificationBattleUpdate, NotificationChatMessage, NotificationCraftingUpdate, NotificationDroneAdrift, NotificationDroneDestroyed, NotificationDroneScan, NotificationDroneSurvey, NotificationDroneUpdate, NotificationFacilityReclaimed, NotificationFacilityRentWarning, NotificationFactionAllianceBroken, NotificationFactionAllianceFormed, NotificationFactionAllianceProposal, NotificationFactionPeaceAccepted, NotificationFactionPeaceProposal, NotificationFactionWarDeclared, NotificationMarketUpdate, NotificationMiningYield, NotificationObservationUpdate, NotificationPersonnelUpdate, NotificationPilotlessShip, NotificationPirateDestroyed, NotificationPirateRadio, NotificationPlayerDied, NotificationPlayerKill, NotificationPrizeUpdate, NotificationRanchPoached, NotificationReconnected, NotificationScanDetected, NotificationServerRestartWarning, NotificationShipCaptured, NotificationShipCommissionComplete, NotificationSkillLevelUp, NotificationStationRepaired, NotificationTradeCancelled, NotificationTradeComplete, NotificationTradeDeclined, NotificationTradeOfferReceived } from './openapi/types.gen.js';
|
|
1
|
+
import type { NotificationAchievementUnlocked, NotificationActionError, NotificationActionResult, NotificationBaseDestroyed, NotificationBaseRaidUpdate, NotificationBattleAlert, NotificationBattleDamage, NotificationBattleEnded, NotificationBattleJoined, NotificationBattleLeft, NotificationBattleStarted, NotificationBattleUpdate, NotificationChatMessage, NotificationCraftingUpdate, NotificationDroneAdrift, NotificationDroneDestroyed, NotificationDroneScan, NotificationDroneSurvey, NotificationDroneUpdate, NotificationFacilityReclaimed, NotificationFacilityRentWarning, NotificationFactionAllianceBroken, NotificationFactionAllianceFormed, NotificationFactionAllianceProposal, NotificationFactionPeaceAccepted, NotificationFactionPeaceProposal, NotificationFactionWarDeclared, NotificationMarketUpdate, NotificationMiningYield, NotificationObservationUpdate, NotificationPersonnelUpdate, NotificationPilotlessShip, NotificationPirateDestroyed, NotificationPirateRadio, NotificationPlayerDied, NotificationPlayerKill, NotificationPrizeUpdate, NotificationRanchPoached, NotificationReconnected, NotificationScanDetected, NotificationServerRestartWarning, NotificationShipCaptured, NotificationShipCommissionComplete, NotificationSkillLevelUp, NotificationStationRepaired, NotificationTradeCancelled, NotificationTradeComplete, NotificationTradeDeclined, NotificationTradeOfferReceived } from './openapi/types.gen.js';
|
|
2
2
|
/** msg_type values that have a published payload schema. */
|
|
3
|
-
export type TypedNotificationType = "achievement_unlocked" | "base_destroyed" | "base_raid_update" | "battle_alert" | "battle_damage" | "battle_ended" | "battle_joined" | "battle_left" | "battle_started" | "battle_update" | "chat_message" | "crafting_update" | "drone_adrift" | "drone_destroyed" | "drone_scan" | "drone_survey" | "drone_update" | "facility_reclaimed" | "facility_rent_warning" | "faction_alliance_broken" | "faction_alliance_formed" | "faction_alliance_proposal" | "faction_peace_accepted" | "faction_peace_proposal" | "faction_war_declared" | "market_update" | "mining_yield" | "observation_update" | "personnel_update" | "pilotless_ship" | "pirate_destroyed" | "pirate_radio" | "player_died" | "player_kill" | "prize_update" | "ranch_poached" | "reconnected" | "scan_detected" | "server_restart_warning" | "ship_captured" | "ship_commission_complete" | "skill_level_up" | "station_repaired" | "trade_cancelled" | "trade_complete" | "trade_declined" | "trade_offer_received";
|
|
3
|
+
export type TypedNotificationType = "achievement_unlocked" | "action_error" | "action_result" | "base_destroyed" | "base_raid_update" | "battle_alert" | "battle_damage" | "battle_ended" | "battle_joined" | "battle_left" | "battle_started" | "battle_update" | "chat_message" | "crafting_update" | "drone_adrift" | "drone_destroyed" | "drone_scan" | "drone_survey" | "drone_update" | "facility_reclaimed" | "facility_rent_warning" | "faction_alliance_broken" | "faction_alliance_formed" | "faction_alliance_proposal" | "faction_peace_accepted" | "faction_peace_proposal" | "faction_war_declared" | "market_update" | "mining_yield" | "observation_update" | "personnel_update" | "pilotless_ship" | "pirate_destroyed" | "pirate_radio" | "player_died" | "player_kill" | "prize_update" | "ranch_poached" | "reconnected" | "scan_detected" | "server_restart_warning" | "ship_captured" | "ship_commission_complete" | "skill_level_up" | "station_repaired" | "trade_cancelled" | "trade_complete" | "trade_declined" | "trade_offer_received";
|
|
4
4
|
/** Maps a typed push msg_type to its payload type. */
|
|
5
5
|
export interface NotificationPayloads {
|
|
6
6
|
"achievement_unlocked": NotificationAchievementUnlocked;
|
|
7
|
+
"action_error": NotificationActionError;
|
|
8
|
+
"action_result": NotificationActionResult;
|
|
7
9
|
"base_destroyed": NotificationBaseDestroyed;
|
|
8
10
|
"base_raid_update": NotificationBaseRaidUpdate;
|
|
9
11
|
"battle_alert": NotificationBattleAlert;
|
|
@@ -52,4 +54,4 @@ export interface NotificationPayloads {
|
|
|
52
54
|
"trade_offer_received": NotificationTradeOfferReceived;
|
|
53
55
|
}
|
|
54
56
|
/** Names of every push msg_type with a published schema, for runtime checks. */
|
|
55
|
-
export declare const TYPED_NOTIFICATION_TYPES: readonly ["achievement_unlocked", "base_destroyed", "base_raid_update", "battle_alert", "battle_damage", "battle_ended", "battle_joined", "battle_left", "battle_started", "battle_update", "chat_message", "crafting_update", "drone_adrift", "drone_destroyed", "drone_scan", "drone_survey", "drone_update", "facility_reclaimed", "facility_rent_warning", "faction_alliance_broken", "faction_alliance_formed", "faction_alliance_proposal", "faction_peace_accepted", "faction_peace_proposal", "faction_war_declared", "market_update", "mining_yield", "observation_update", "personnel_update", "pilotless_ship", "pirate_destroyed", "pirate_radio", "player_died", "player_kill", "prize_update", "ranch_poached", "reconnected", "scan_detected", "server_restart_warning", "ship_captured", "ship_commission_complete", "skill_level_up", "station_repaired", "trade_cancelled", "trade_complete", "trade_declined", "trade_offer_received"];
|
|
57
|
+
export declare const TYPED_NOTIFICATION_TYPES: readonly ["achievement_unlocked", "action_error", "action_result", "base_destroyed", "base_raid_update", "battle_alert", "battle_damage", "battle_ended", "battle_joined", "battle_left", "battle_started", "battle_update", "chat_message", "crafting_update", "drone_adrift", "drone_destroyed", "drone_scan", "drone_survey", "drone_update", "facility_reclaimed", "facility_rent_warning", "faction_alliance_broken", "faction_alliance_formed", "faction_alliance_proposal", "faction_peace_accepted", "faction_peace_proposal", "faction_war_declared", "market_update", "mining_yield", "observation_update", "personnel_update", "pilotless_ship", "pirate_destroyed", "pirate_radio", "player_died", "player_kill", "prize_update", "ranch_poached", "reconnected", "scan_detected", "server_restart_warning", "ship_captured", "ship_commission_complete", "skill_level_up", "station_repaired", "trade_cancelled", "trade_complete", "trade_declined", "trade_offer_received"];
|
|
@@ -403,12 +403,18 @@ export type BattleEndLogEntry = {
|
|
|
403
403
|
captures?: Array<CaptureLogEntry>;
|
|
404
404
|
category: string;
|
|
405
405
|
duration: number;
|
|
406
|
-
|
|
406
|
+
/**
|
|
407
|
+
* How the battle ended. victory means one side survived and took a kill. stalemate and mutual_destruction are both draws. interrupted means a server restart ended the battle before either side won. The WebSocket battle_ended frame calls this same field reason.
|
|
408
|
+
*/
|
|
409
|
+
outcome: 'victory' | 'stalemate' | 'mutual_destruction' | 'interrupted';
|
|
407
410
|
participant_names?: Array<string>;
|
|
408
411
|
participants: Array<ParticipantSummary>;
|
|
409
412
|
ships_captured?: number;
|
|
410
413
|
ships_destroyed: number;
|
|
411
414
|
total_damage: number;
|
|
415
|
+
/**
|
|
416
|
+
* Side id of the winning side. Always -1 for a draw — stalemate and mutual_destruction are both draws — and -1 for a battle a server restart interrupted.
|
|
417
|
+
*/
|
|
412
418
|
winning_side: number;
|
|
413
419
|
};
|
|
414
420
|
export type BattleEndedParticipantInfo = {
|
|
@@ -436,6 +442,7 @@ export type BattleLogEntry = {
|
|
|
436
442
|
joins?: Array<JoinLogEntry>;
|
|
437
443
|
kills?: Array<KillLogEntry>;
|
|
438
444
|
personnel_casualties?: Array<PersonnelCasualtyLogEntry>;
|
|
445
|
+
recovered_summary?: RecoveredBattleSummary;
|
|
439
446
|
regen?: Array<RegenLogEntry>;
|
|
440
447
|
snapshots: Array<ParticipantSnapshot>;
|
|
441
448
|
system_id: string;
|
|
@@ -560,6 +567,9 @@ export type BattleSummaryResponse = {
|
|
|
560
567
|
ended_at?: string;
|
|
561
568
|
has_station: boolean;
|
|
562
569
|
origin_poi?: string;
|
|
570
|
+
/**
|
|
571
|
+
* How the battle ended. victory means one side survived and took a kill. stalemate and mutual_destruction are both draws. interrupted means a server restart ended the battle before either side won. Graceful shutdown emits a battle_ended frame; crash-recovered REST summaries do not fabricate one. Null while status is active. The WebSocket battle_ended frame calls this same field reason.
|
|
572
|
+
*/
|
|
563
573
|
outcome: string;
|
|
564
574
|
participant_count: number;
|
|
565
575
|
player_names?: Array<string>;
|
|
@@ -572,6 +582,9 @@ export type BattleSummaryResponse = {
|
|
|
572
582
|
system_name: string;
|
|
573
583
|
top_damage?: BattleTopDamage;
|
|
574
584
|
total_damage: number;
|
|
585
|
+
/**
|
|
586
|
+
* Side id of the winning side. Always -1 for a draw — both stalemate and mutual_destruction report -1 — and -1 for a battle a server restart interrupted. Null while status is active.
|
|
587
|
+
*/
|
|
575
588
|
winning_side: number;
|
|
576
589
|
};
|
|
577
590
|
export type BattleTopDamage = {
|
|
@@ -616,6 +629,9 @@ export type BoardingStateLogEntry = {
|
|
|
616
629
|
casualties_occurred?: boolean;
|
|
617
630
|
defender_casualties?: boolean;
|
|
618
631
|
destroyed?: boolean;
|
|
632
|
+
/**
|
|
633
|
+
* Observable boarding transition. Terminal values include capture_ready; plundered; withdrawn; attacker_destroyed; attacker_incapacitated; target_destroyed; target_self_destructed; and restart_canceled. plundered means pirates removed eligible cargo and then disengaged without taking the hull.
|
|
634
|
+
*/
|
|
619
635
|
event: string;
|
|
620
636
|
hull_damage?: number;
|
|
621
637
|
operation_id: string;
|
|
@@ -995,6 +1011,10 @@ export type CaptainsLogListResponse = {
|
|
|
995
1011
|
export type CaptureLogEntry = {
|
|
996
1012
|
boarding_operation_id: string;
|
|
997
1013
|
captor_id: string;
|
|
1014
|
+
/**
|
|
1015
|
+
* Kind of combat actor identified by captor_id. Present on newly recorded captures; omitted on historical rows created before captor provenance was recorded.
|
|
1016
|
+
*/
|
|
1017
|
+
captor_kind?: 'player' | 'pirate' | 'npc';
|
|
998
1018
|
captor_username: string;
|
|
999
1019
|
former_owner_id: string;
|
|
1000
1020
|
former_owner_username: string;
|
|
@@ -1235,12 +1255,18 @@ export type ClaimInsuranceResponse = {
|
|
|
1235
1255
|
};
|
|
1236
1256
|
export type ClaimPrizeResponse = {
|
|
1237
1257
|
crew_assigned: number;
|
|
1238
|
-
|
|
1258
|
+
/**
|
|
1259
|
+
* Where the prize crew came from and returns to.
|
|
1260
|
+
*/
|
|
1261
|
+
crew_disposition: 'aboard' | 'faction_reserve';
|
|
1239
1262
|
destination_base_id: string;
|
|
1240
1263
|
idempotent: boolean;
|
|
1241
1264
|
prize_id: string;
|
|
1242
1265
|
ship_id: string;
|
|
1243
|
-
|
|
1266
|
+
/**
|
|
1267
|
+
* Recovery state of the prize. delivered / destroyed / expired / recaptured are terminal.
|
|
1268
|
+
*/
|
|
1269
|
+
status: 'available' | 'claimed' | 'in_transit' | 'delivered' | 'destroyed' | 'expired' | 'recaptured';
|
|
1244
1270
|
};
|
|
1245
1271
|
export type ClientConnectionInfo = {
|
|
1246
1272
|
distance?: number;
|
|
@@ -3013,7 +3039,10 @@ export type FactionPersonnelEmployment = {
|
|
|
3013
3039
|
total_marines: number;
|
|
3014
3040
|
};
|
|
3015
3041
|
export type FactionPersonnelResponse = {
|
|
3016
|
-
|
|
3042
|
+
/**
|
|
3043
|
+
* The personnel_action the request asked for. It is echoed back unchanged.
|
|
3044
|
+
*/
|
|
3045
|
+
action: 'status' | 'recruit' | 'deposit' | 'withdraw';
|
|
3017
3046
|
auto_docked?: boolean;
|
|
3018
3047
|
auto_undocked?: boolean;
|
|
3019
3048
|
base_id: string;
|
|
@@ -3152,9 +3181,25 @@ export type FactionScanPoiResponse = {
|
|
|
3152
3181
|
system_id?: string;
|
|
3153
3182
|
};
|
|
3154
3183
|
export type FactionScanPirateContact = {
|
|
3184
|
+
/**
|
|
3185
|
+
* Stronghold crew this pirate flies for and the pirate-standing counterparty affected by fighting them. Omitted only when no stronghold crew can be resolved.
|
|
3186
|
+
*/
|
|
3187
|
+
faction?: string;
|
|
3188
|
+
/**
|
|
3189
|
+
* Human-readable name of the pirate stronghold crew. Omitted only when no stronghold crew can be resolved.
|
|
3190
|
+
*/
|
|
3191
|
+
faction_name?: string;
|
|
3155
3192
|
id: string;
|
|
3156
3193
|
name?: string;
|
|
3194
|
+
/**
|
|
3195
|
+
* Primary livery color configured by the pirate stronghold crew as #RRGGBB. Omitted when the crew has no configured branding.
|
|
3196
|
+
*/
|
|
3197
|
+
primary_color?: string;
|
|
3157
3198
|
role?: string;
|
|
3199
|
+
/**
|
|
3200
|
+
* Secondary livery color configured by the pirate stronghold crew as #RRGGBB. Omitted when the crew has no configured branding.
|
|
3201
|
+
*/
|
|
3202
|
+
secondary_color?: string;
|
|
3158
3203
|
ship_class?: string;
|
|
3159
3204
|
};
|
|
3160
3205
|
export type FactionSetEnemyResponse = {
|
|
@@ -3582,6 +3627,9 @@ export type GetBaseResponse = {
|
|
|
3582
3627
|
};
|
|
3583
3628
|
export type GetBattleLogResponse = {
|
|
3584
3629
|
battle_id: string;
|
|
3630
|
+
/**
|
|
3631
|
+
* Tick snapshots include is_npc and is_boss on newly recorded rows. Explicit false is authoritative; either field may be omitted on historical rows that predate identity provenance.
|
|
3632
|
+
*/
|
|
3585
3633
|
entries: Array<BattleLogEntry>;
|
|
3586
3634
|
/**
|
|
3587
3635
|
* True if more entries exist past this page (tick_start/tick_end) — raise tick_start or limit to page through.
|
|
@@ -4282,10 +4330,20 @@ export type LoungeCheckInResponse = {
|
|
|
4282
4330
|
skipped_full?: number;
|
|
4283
4331
|
};
|
|
4284
4332
|
export type McpNotification = {
|
|
4333
|
+
/**
|
|
4334
|
+
* Frame payload. The shape is selected by msg_type: read the Notification_<msg_type> schema under components.schemas. The notifications array on every v2 response carries the same payloads as an explicit anyOf.
|
|
4335
|
+
*/
|
|
4336
|
+
data: unknown;
|
|
4285
4337
|
id: string;
|
|
4338
|
+
/**
|
|
4339
|
+
* Specific frame subtype. Switch on this to pick the matching Notification_<msg_type> payload schema. Routing to the coarse type field: chat_message -> chat. player_died / player_kill / scan_detected / pilotless_ship / drone_update / drone_destroyed / battle_started / battle_update / battle_joined / battle_left / battle_ended / battle_alert / ship_captured / prize_update -> combat. trade_offer_received / trade_complete / trade_declined / trade_cancelled -> trade. market_update -> market. crafting_update -> crafting. observation_update -> observation. personnel_update -> system. Frames not named here also route to system - that includes battle_damage / drone_scan / drone_survey / drone_adrift / action_result / action_error / server_restart_warning. A types=combat filter does not carry them.
|
|
4340
|
+
*/
|
|
4286
4341
|
msg_type: string;
|
|
4287
4342
|
timestamp: string;
|
|
4288
|
-
|
|
4343
|
+
/**
|
|
4344
|
+
* Coarse notification category. This is the value get_notifications accepts in its types filter. The server derives it from msg_type — see the msg_type field for the routing table.
|
|
4345
|
+
*/
|
|
4346
|
+
type: 'chat' | 'combat' | 'trade' | 'market' | 'crafting' | 'observation' | 'system';
|
|
4289
4347
|
};
|
|
4290
4348
|
export type MapData = {
|
|
4291
4349
|
empires: {
|
|
@@ -4650,6 +4708,58 @@ export type NotificationAchievementUnlocked = {
|
|
|
4650
4708
|
*/
|
|
4651
4709
|
faction?: boolean;
|
|
4652
4710
|
};
|
|
4711
|
+
/**
|
|
4712
|
+
* A queued action that failed when it ran on a later tick. Delivered on the same path as action_result: to the caller waiting on the originating request_id when one is still attached, otherwise queued and collected through get_notifications.
|
|
4713
|
+
*/
|
|
4714
|
+
export type NotificationActionError = {
|
|
4715
|
+
/**
|
|
4716
|
+
* Machine-readable error code. Switch on this rather than on message. It is the same code set the synchronous error response uses for that command, so it is not enumerated here — a command can fail at execution time for any reason it can fail immediately.
|
|
4717
|
+
*/
|
|
4718
|
+
code: string;
|
|
4719
|
+
/**
|
|
4720
|
+
* Name of the command that failed.
|
|
4721
|
+
*/
|
|
4722
|
+
command: string;
|
|
4723
|
+
/**
|
|
4724
|
+
* Optional extra context. Shape depends on code. Omitted when the failure carries none.
|
|
4725
|
+
*/
|
|
4726
|
+
details?: {
|
|
4727
|
+
[key: string]: unknown;
|
|
4728
|
+
};
|
|
4729
|
+
/**
|
|
4730
|
+
* Human-readable explanation of the failure.
|
|
4731
|
+
*/
|
|
4732
|
+
message: string;
|
|
4733
|
+
/**
|
|
4734
|
+
* Tick the command failed on.
|
|
4735
|
+
*/
|
|
4736
|
+
tick: number;
|
|
4737
|
+
};
|
|
4738
|
+
/**
|
|
4739
|
+
* Result of a queued action that completed on a later tick. It 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.
|
|
4740
|
+
*/
|
|
4741
|
+
export type NotificationActionResult = {
|
|
4742
|
+
/**
|
|
4743
|
+
* True when the server docked you to run the command.
|
|
4744
|
+
*/
|
|
4745
|
+
auto_docked?: boolean;
|
|
4746
|
+
/**
|
|
4747
|
+
* True when the server undocked you to run the command.
|
|
4748
|
+
*/
|
|
4749
|
+
auto_undocked?: boolean;
|
|
4750
|
+
/**
|
|
4751
|
+
* Name of the command that ran.
|
|
4752
|
+
*/
|
|
4753
|
+
command: string;
|
|
4754
|
+
/**
|
|
4755
|
+
* Payload of the completed command. On v1 this is the command's own response object — see that command's response schema. On v2 it is the state delta the command registered, keyed by state section. Untyped because both shapes are possible; it is null when the command returned no body.
|
|
4756
|
+
*/
|
|
4757
|
+
result: unknown;
|
|
4758
|
+
/**
|
|
4759
|
+
* Tick the command executed on.
|
|
4760
|
+
*/
|
|
4761
|
+
tick: number;
|
|
4762
|
+
};
|
|
4653
4763
|
export type NotificationBaseDestroyed = {
|
|
4654
4764
|
attacker_id: string;
|
|
4655
4765
|
attacker_name: string;
|
|
@@ -4699,10 +4809,16 @@ export type NotificationBattleEnded = {
|
|
|
4699
4809
|
captures?: Array<CaptureLogEntry>;
|
|
4700
4810
|
duration: number;
|
|
4701
4811
|
participants?: Array<BattleEndedParticipantInfo>;
|
|
4702
|
-
|
|
4812
|
+
/**
|
|
4813
|
+
* How the battle ended. victory means one side survived and took a kill. stalemate and mutual_destruction are both draws. interrupted means a server restart ended the battle. The REST battle summary and battle log call this same field outcome.
|
|
4814
|
+
*/
|
|
4815
|
+
reason: 'victory' | 'stalemate' | 'mutual_destruction' | 'interrupted';
|
|
4703
4816
|
ships_captured?: number;
|
|
4704
4817
|
ships_destroyed: number;
|
|
4705
4818
|
total_damage: number;
|
|
4819
|
+
/**
|
|
4820
|
+
* Side id of the winning side. Always -1 for a draw — stalemate and mutual_destruction are both draws — and -1 for a battle a server restart interrupted.
|
|
4821
|
+
*/
|
|
4706
4822
|
winning_side: number;
|
|
4707
4823
|
};
|
|
4708
4824
|
export type NotificationBattleJoined = {
|
|
@@ -4979,7 +5095,10 @@ export type NotificationObservationUpdate = {
|
|
|
4979
5095
|
unknown_signature: boolean;
|
|
4980
5096
|
};
|
|
4981
5097
|
export type NotificationPersonnelUpdate = {
|
|
4982
|
-
|
|
5098
|
+
/**
|
|
5099
|
+
* What an ally did to your active ship. treatment healed injured crew or marines. transfer moved personnel between ships.
|
|
5100
|
+
*/
|
|
5101
|
+
action: 'treatment' | 'transfer';
|
|
4983
5102
|
crew_capacity: number;
|
|
4984
5103
|
crew_treated?: number;
|
|
4985
5104
|
fit_crew_transferred?: number;
|
|
@@ -5010,7 +5129,7 @@ export type NotificationPilotlessShip = {
|
|
|
5010
5129
|
*/
|
|
5011
5130
|
export type NotificationPirateDestroyed = {
|
|
5012
5131
|
/**
|
|
5013
|
-
*
|
|
5132
|
+
* Weapons skill XP awarded (legacy field name; kill notification to the killer).
|
|
5014
5133
|
*/
|
|
5015
5134
|
combat_xp?: number;
|
|
5016
5135
|
/**
|
|
@@ -5041,23 +5160,116 @@ export type NotificationPirateDestroyed = {
|
|
|
5041
5160
|
* System name (boss-kill system broadcast).
|
|
5042
5161
|
*/
|
|
5043
5162
|
system_name?: string;
|
|
5163
|
+
/**
|
|
5164
|
+
* Whether the wreck holds lootable cargo (omitted when no wreck).
|
|
5165
|
+
*/
|
|
5166
|
+
wreck_has_cargo?: boolean;
|
|
5167
|
+
/**
|
|
5168
|
+
* Whether the wreck holds salvageable modules (omitted when no wreck).
|
|
5169
|
+
*/
|
|
5170
|
+
wreck_has_modules?: boolean;
|
|
5171
|
+
/**
|
|
5172
|
+
* Wreck left behind (omitted when no wreck was created).
|
|
5173
|
+
*/
|
|
5174
|
+
wreck_id?: string;
|
|
5175
|
+
/**
|
|
5176
|
+
* POI the wreck was left at — combat is system-scoped, so this can differ from the killer's POI (omitted when no wreck or the POI is hidden from the recipient).
|
|
5177
|
+
*/
|
|
5178
|
+
wreck_poi_id?: string;
|
|
5179
|
+
/**
|
|
5180
|
+
* Display name of the wreck's POI (omitted when unknown or hidden from the recipient).
|
|
5181
|
+
*/
|
|
5182
|
+
wreck_poi_name?: string;
|
|
5183
|
+
/**
|
|
5184
|
+
* System the wreck is in (omitted when no wreck).
|
|
5185
|
+
*/
|
|
5186
|
+
wreck_system_id?: string;
|
|
5187
|
+
/**
|
|
5188
|
+
* Display name of the wreck's system (omitted when no wreck, or when the name is unknown).
|
|
5189
|
+
*/
|
|
5190
|
+
wreck_system_name?: string;
|
|
5044
5191
|
};
|
|
5045
|
-
/**
|
|
5046
|
-
* Pushed to players in range with a pirate_radio_scanner module, carrying an intercepted pirate transmission.
|
|
5047
|
-
*/
|
|
5048
5192
|
export type NotificationPirateRadio = {
|
|
5049
5193
|
/**
|
|
5050
|
-
*
|
|
5194
|
+
* Acting pirate combat ID when the grammatical speaker differs from the actor. Omitted when there is no separate actor.
|
|
5051
5195
|
*/
|
|
5052
|
-
|
|
5196
|
+
actor_id?: string;
|
|
5053
5197
|
/**
|
|
5054
|
-
*
|
|
5198
|
+
* Acting pirate display name when the grammatical speaker differs from the actor. Omitted when there is no separate actor.
|
|
5199
|
+
*/
|
|
5200
|
+
actor_name?: string;
|
|
5201
|
+
/**
|
|
5202
|
+
* Battle identity when the transmission refers to a fight.
|
|
5203
|
+
*/
|
|
5204
|
+
battle_id?: string;
|
|
5205
|
+
/**
|
|
5206
|
+
* Backward-compatible alias of editorial_class. Both fields always carry the same bounded editorial class.
|
|
5207
|
+
*/
|
|
5208
|
+
category: 'ambient' | 'tactical' | 'strategic' | 'outcome';
|
|
5209
|
+
/**
|
|
5210
|
+
* Bounded editorial delivery policy for the public pirate-radio Discord feed; it does not affect in-game delivery.
|
|
5211
|
+
*/
|
|
5212
|
+
discord_policy: 'never' | 'batched' | 'immediate';
|
|
5213
|
+
/**
|
|
5214
|
+
* Canonical cross-channel editorial class and alias of category. Both fields always carry the same value.
|
|
5215
|
+
*/
|
|
5216
|
+
editorial_class: 'ambient' | 'tactical' | 'strategic' | 'outcome';
|
|
5217
|
+
/**
|
|
5218
|
+
* Bounded pirate-radio template and lifecycle event key.
|
|
5219
|
+
*/
|
|
5220
|
+
event_key: string;
|
|
5221
|
+
/**
|
|
5222
|
+
* Pirate stronghold crew key the transmission belongs to.
|
|
5223
|
+
*/
|
|
5224
|
+
faction_key: string;
|
|
5225
|
+
/**
|
|
5226
|
+
* Human-readable pirate stronghold crew name.
|
|
5227
|
+
*/
|
|
5228
|
+
faction_name: string;
|
|
5229
|
+
/**
|
|
5230
|
+
* Ship class ID of the crew flagship when configured.
|
|
5231
|
+
*/
|
|
5232
|
+
flagship_ship_class: string;
|
|
5233
|
+
/**
|
|
5234
|
+
* Rendered in-character transmission text.
|
|
5055
5235
|
*/
|
|
5056
|
-
faction_key?: string;
|
|
5057
5236
|
message: string;
|
|
5237
|
+
/**
|
|
5238
|
+
* Stable raid; expedition; breakout; return; or incident identity when the transmission belongs to an operation.
|
|
5239
|
+
*/
|
|
5240
|
+
operation_id?: string;
|
|
5241
|
+
/**
|
|
5242
|
+
* Display name of the selected speaker: the acting pirate; operation leader; stronghold control; or boss.
|
|
5243
|
+
*/
|
|
5058
5244
|
pirate_name: string;
|
|
5059
|
-
|
|
5060
|
-
|
|
5245
|
+
/**
|
|
5246
|
+
* Primary pirate-crew livery color as #RRGGBB.
|
|
5247
|
+
*/
|
|
5248
|
+
primary_color: string;
|
|
5249
|
+
/**
|
|
5250
|
+
* Bounded machine-readable doctrine or lifecycle reason code when available.
|
|
5251
|
+
*/
|
|
5252
|
+
reason_code?: string;
|
|
5253
|
+
/**
|
|
5254
|
+
* Secondary pirate-crew livery color as #RRGGBB.
|
|
5255
|
+
*/
|
|
5256
|
+
secondary_color: string;
|
|
5257
|
+
/**
|
|
5258
|
+
* POI ID from which the transmission originated. Empty when no POI can be resolved.
|
|
5259
|
+
*/
|
|
5260
|
+
source_poi: string;
|
|
5261
|
+
/**
|
|
5262
|
+
* System ID from which the transmission originated.
|
|
5263
|
+
*/
|
|
5264
|
+
source_system: string;
|
|
5265
|
+
/**
|
|
5266
|
+
* Selected grammatical speaker category such as actor; operation_leader; stronghold_control; or boss.
|
|
5267
|
+
*/
|
|
5268
|
+
speaker_category: string;
|
|
5269
|
+
/**
|
|
5270
|
+
* Combat actor ID or stable synthetic stronghold-control speaker ID.
|
|
5271
|
+
*/
|
|
5272
|
+
speaker_id: string;
|
|
5061
5273
|
};
|
|
5062
5274
|
export type NotificationPlayerDied = {
|
|
5063
5275
|
cause?: string;
|
|
@@ -5070,7 +5282,23 @@ export type NotificationPlayerDied = {
|
|
|
5070
5282
|
self_destruct_fee?: number;
|
|
5071
5283
|
ship_lost: string;
|
|
5072
5284
|
wreck_id?: string;
|
|
5285
|
+
/**
|
|
5286
|
+
* POI where the wreck was left. Omitted when there is no wreck or the POI is hidden from the recipient.
|
|
5287
|
+
*/
|
|
5288
|
+
wreck_poi_id?: string;
|
|
5289
|
+
/**
|
|
5290
|
+
* Display name of the wreck POI. Omitted when unknown or hidden from the recipient.
|
|
5291
|
+
*/
|
|
5292
|
+
wreck_poi_name?: string;
|
|
5073
5293
|
wreck_suppressed?: boolean;
|
|
5294
|
+
/**
|
|
5295
|
+
* System where the wreck was left. Omitted when there is no wreck.
|
|
5296
|
+
*/
|
|
5297
|
+
wreck_system_id?: string;
|
|
5298
|
+
/**
|
|
5299
|
+
* Display name of the wreck system. Omitted when unknown.
|
|
5300
|
+
*/
|
|
5301
|
+
wreck_system_name?: string;
|
|
5074
5302
|
};
|
|
5075
5303
|
/**
|
|
5076
5304
|
* Pushed to the killer when they destroy another player's ship.
|
|
@@ -5092,6 +5320,22 @@ export type NotificationPlayerKill = {
|
|
|
5092
5320
|
* Wreck left behind (omitted when no wreck was created).
|
|
5093
5321
|
*/
|
|
5094
5322
|
wreck_id?: string;
|
|
5323
|
+
/**
|
|
5324
|
+
* POI the wreck was left at — combat is system-scoped, so this can differ from the killer's POI (omitted when no wreck or the POI is hidden from the recipient).
|
|
5325
|
+
*/
|
|
5326
|
+
wreck_poi_id?: string;
|
|
5327
|
+
/**
|
|
5328
|
+
* Display name of the wreck's POI (omitted when unknown or hidden from the recipient).
|
|
5329
|
+
*/
|
|
5330
|
+
wreck_poi_name?: string;
|
|
5331
|
+
/**
|
|
5332
|
+
* System the wreck is in (omitted when no wreck).
|
|
5333
|
+
*/
|
|
5334
|
+
wreck_system_id?: string;
|
|
5335
|
+
/**
|
|
5336
|
+
* Display name of the wreck's system (omitted when no wreck, or when the name is unknown).
|
|
5337
|
+
*/
|
|
5338
|
+
wreck_system_name?: string;
|
|
5095
5339
|
};
|
|
5096
5340
|
export type NotificationPrizeUpdate = {
|
|
5097
5341
|
destination_base_id?: string;
|
|
@@ -5101,9 +5345,15 @@ export type NotificationPrizeUpdate = {
|
|
|
5101
5345
|
ship_class: string;
|
|
5102
5346
|
ship_id: string;
|
|
5103
5347
|
ship_name?: string;
|
|
5104
|
-
|
|
5348
|
+
/**
|
|
5349
|
+
* Recovery state of the prize. delivered / destroyed / expired / recaptured are terminal.
|
|
5350
|
+
*/
|
|
5351
|
+
status: 'available' | 'claimed' | 'in_transit' | 'delivered' | 'destroyed' | 'expired' | 'recaptured';
|
|
5105
5352
|
system_id?: string;
|
|
5106
|
-
|
|
5353
|
+
/**
|
|
5354
|
+
* Why an in_transit prize is stalled. Omitted while the prize is moving.
|
|
5355
|
+
*/
|
|
5356
|
+
wait_reason?: 'no_route' | 'no_fuel' | 'destination_missing' | 'incapacitated' | 'manual_stop';
|
|
5107
5357
|
wreck_id?: string;
|
|
5108
5358
|
};
|
|
5109
5359
|
export type NotificationRanchPoached = {
|
|
@@ -5140,6 +5390,10 @@ export type NotificationShipCaptured = {
|
|
|
5140
5390
|
battle_id: string;
|
|
5141
5391
|
boarding_operation_id: string;
|
|
5142
5392
|
captor_id: string;
|
|
5393
|
+
/**
|
|
5394
|
+
* Kind of combat actor identified by captor_id. Present on newly emitted captures; omitted only on historical persisted capture records.
|
|
5395
|
+
*/
|
|
5396
|
+
captor_kind?: 'player' | 'pirate' | 'npc';
|
|
5143
5397
|
captor_username: string;
|
|
5144
5398
|
former_owner_id: string;
|
|
5145
5399
|
former_owner_username: string;
|
|
@@ -5414,6 +5668,14 @@ export type ParticipantSnapshot = {
|
|
|
5414
5668
|
flee_counter: number;
|
|
5415
5669
|
fuel: number;
|
|
5416
5670
|
hull: number;
|
|
5671
|
+
/**
|
|
5672
|
+
* True for a named pirate boss. False explicitly means not a boss. Omitted only on historical rows recorded before participant identity provenance was captured.
|
|
5673
|
+
*/
|
|
5674
|
+
is_boss?: boolean;
|
|
5675
|
+
/**
|
|
5676
|
+
* True for an automated combatant. False explicitly means player-controlled. Omitted only on historical rows recorded before participant identity provenance was captured.
|
|
5677
|
+
*/
|
|
5678
|
+
is_npc?: boolean;
|
|
5417
5679
|
kill_count: number;
|
|
5418
5680
|
kind?: string;
|
|
5419
5681
|
max_fuel: number;
|
|
@@ -5542,6 +5804,14 @@ export type PirateInfo = {
|
|
|
5542
5804
|
max_shield?: number;
|
|
5543
5805
|
name: string;
|
|
5544
5806
|
pirate_id: string;
|
|
5807
|
+
/**
|
|
5808
|
+
* Primary livery color for this pirate crew as a hex color.
|
|
5809
|
+
*/
|
|
5810
|
+
primary_color?: string;
|
|
5811
|
+
/**
|
|
5812
|
+
* Secondary livery color for this pirate crew as a hex color.
|
|
5813
|
+
*/
|
|
5814
|
+
secondary_color?: string;
|
|
5545
5815
|
shield?: number;
|
|
5546
5816
|
status: string;
|
|
5547
5817
|
tier: string;
|
|
@@ -5864,12 +6134,21 @@ export type PrizeInfo = {
|
|
|
5864
6134
|
ship_class: string;
|
|
5865
6135
|
ship_id: string;
|
|
5866
6136
|
ship_name?: string;
|
|
5867
|
-
|
|
5868
|
-
|
|
6137
|
+
/**
|
|
6138
|
+
* Recovery state of the prize. delivered / destroyed / expired / recaptured are terminal.
|
|
6139
|
+
*/
|
|
6140
|
+
status: 'available' | 'claimed' | 'in_transit' | 'delivered' | 'destroyed' | 'expired' | 'recaptured';
|
|
6141
|
+
/**
|
|
6142
|
+
* Why an in_transit prize is stalled. Omitted while the prize is moving.
|
|
6143
|
+
*/
|
|
6144
|
+
wait_reason?: 'no_route' | 'no_fuel' | 'destination_missing' | 'incapacitated' | 'manual_stop';
|
|
5869
6145
|
};
|
|
5870
6146
|
export type PrizeRecoveryInfo = {
|
|
5871
6147
|
actor_id: string;
|
|
5872
|
-
|
|
6148
|
+
/**
|
|
6149
|
+
* Where the prize crew came from and returns to.
|
|
6150
|
+
*/
|
|
6151
|
+
crew_disposition: 'aboard' | 'faction_reserve';
|
|
5873
6152
|
destination_base_id: string;
|
|
5874
6153
|
fuel: number;
|
|
5875
6154
|
hull: number;
|
|
@@ -5882,27 +6161,48 @@ export type PrizeRecoveryInfo = {
|
|
|
5882
6161
|
ship_class: string;
|
|
5883
6162
|
ship_id: string;
|
|
5884
6163
|
ship_name?: string;
|
|
5885
|
-
|
|
6164
|
+
/**
|
|
6165
|
+
* Recovery state of the prize. delivered / destroyed / expired / recaptured are terminal.
|
|
6166
|
+
*/
|
|
6167
|
+
status: 'available' | 'claimed' | 'in_transit' | 'delivered' | 'destroyed' | 'expired' | 'recaptured';
|
|
5886
6168
|
system_id?: string;
|
|
5887
6169
|
transit_arrival_tick?: number;
|
|
5888
6170
|
transit_from_poi_id?: string;
|
|
5889
6171
|
transit_from_system_id?: string;
|
|
5890
|
-
|
|
6172
|
+
/**
|
|
6173
|
+
* Which leg the prize is flying. jump crosses systems. travel crosses POIs inside one system.
|
|
6174
|
+
*/
|
|
6175
|
+
transit_kind?: 'jump' | 'travel';
|
|
5891
6176
|
transit_to_poi_id?: string;
|
|
5892
6177
|
transit_to_system_id?: string;
|
|
5893
|
-
|
|
6178
|
+
/**
|
|
6179
|
+
* Why an in_transit prize is stalled. Omitted while the prize is moving.
|
|
6180
|
+
*/
|
|
6181
|
+
wait_reason?: 'no_route' | 'no_fuel' | 'destination_missing' | 'incapacitated' | 'manual_stop';
|
|
5894
6182
|
};
|
|
5895
6183
|
export type PrizeServiceResponse = {
|
|
5896
|
-
|
|
5897
|
-
|
|
6184
|
+
/**
|
|
6185
|
+
* The service_action the request asked for. It is echoed back unchanged.
|
|
6186
|
+
*/
|
|
6187
|
+
action: 'stop' | 'resume' | 'redirect' | 'refuel' | 'repair';
|
|
6188
|
+
/**
|
|
6189
|
+
* Where the prize crew came from and returns to.
|
|
6190
|
+
*/
|
|
6191
|
+
crew_disposition?: 'aboard' | 'faction_reserve';
|
|
5898
6192
|
destination_base_id?: string;
|
|
5899
6193
|
fuel_transferred?: number;
|
|
5900
6194
|
hull_repaired?: number;
|
|
5901
6195
|
prize_id: string;
|
|
5902
6196
|
repair_kits_used?: number;
|
|
5903
6197
|
ship_id: string;
|
|
5904
|
-
|
|
5905
|
-
|
|
6198
|
+
/**
|
|
6199
|
+
* Recovery state of the prize. delivered / destroyed / expired / recaptured are terminal.
|
|
6200
|
+
*/
|
|
6201
|
+
status: 'available' | 'claimed' | 'in_transit' | 'delivered' | 'destroyed' | 'expired' | 'recaptured';
|
|
6202
|
+
/**
|
|
6203
|
+
* Why an in_transit prize is stalled. Omitted while the prize is moving.
|
|
6204
|
+
*/
|
|
6205
|
+
wait_reason?: 'no_route' | 'no_fuel' | 'destination_missing' | 'incapacitated' | 'manual_stop';
|
|
5906
6206
|
};
|
|
5907
6207
|
export type RanchFeedInfo = {
|
|
5908
6208
|
cycles_left: number;
|
|
@@ -5995,6 +6295,20 @@ export type RecipeOutput = {
|
|
|
5995
6295
|
item_id: string;
|
|
5996
6296
|
quantity: number;
|
|
5997
6297
|
};
|
|
6298
|
+
export type RecoveredBattleSummary = {
|
|
6299
|
+
captures?: Array<CaptureLogEntry>;
|
|
6300
|
+
category: string;
|
|
6301
|
+
duration: number;
|
|
6302
|
+
participant_names?: Array<string>;
|
|
6303
|
+
participants: Array<ParticipantSummary>;
|
|
6304
|
+
ships_captured?: number;
|
|
6305
|
+
ships_destroyed: number;
|
|
6306
|
+
side_factions?: {
|
|
6307
|
+
[key: string]: never;
|
|
6308
|
+
};
|
|
6309
|
+
start_tick: number;
|
|
6310
|
+
total_damage: number;
|
|
6311
|
+
};
|
|
5998
6312
|
export type RecruitPersonnelResponse = {
|
|
5999
6313
|
auto_docked?: boolean;
|
|
6000
6314
|
auto_undocked?: boolean;
|
|
@@ -7517,7 +7831,10 @@ export type TreatPersonnelResponse = {
|
|
|
7517
7831
|
crew_treated: number;
|
|
7518
7832
|
marines_treated: number;
|
|
7519
7833
|
medical_pool_remaining?: number;
|
|
7520
|
-
|
|
7834
|
+
/**
|
|
7835
|
+
* Which medical supply paid for the treatment. station is the base infirmary. faction is your faction reserve. field is shipboard medical supplies.
|
|
7836
|
+
*/
|
|
7837
|
+
source: 'station' | 'faction' | 'field';
|
|
7521
7838
|
supplies_used?: number;
|
|
7522
7839
|
target: string;
|
|
7523
7840
|
};
|
|
@@ -8060,7 +8377,7 @@ export type V2Response = {
|
|
|
8060
8377
|
/**
|
|
8061
8378
|
* Notification payload. Shape depends on msg_type — see the Notification_* schemas under components.schemas.
|
|
8062
8379
|
*/
|
|
8063
|
-
data?: NotificationAchievementUnlocked | NotificationDroneAdrift | NotificationServerRestartWarning | NotificationFactionAllianceBroken | NotificationFactionAllianceFormed | NotificationFactionAllianceProposal | NotificationFactionPeaceAccepted | NotificationFactionPeaceProposal | NotificationFactionWarDeclared | NotificationBaseDestroyed | NotificationStationRepaired | NotificationRanchPoached | NotificationBaseRaidUpdate | NotificationBattleAlert | NotificationBattleDamage | NotificationBattleEnded | NotificationShipCaptured | NotificationPrizeUpdate | NotificationPersonnelUpdate | NotificationBattleJoined | NotificationBattleLeft | NotificationBattleStarted | NotificationBattleUpdate | NotificationChatMessage | NotificationCraftingUpdate | NotificationDroneDestroyed | NotificationDroneScan | NotificationDroneSurvey | NotificationDroneUpdate | NotificationFacilityReclaimed | NotificationFacilityRentWarning | NotificationMarketUpdate | NotificationObservationUpdate | NotificationMiningYield | NotificationPilotlessShip | NotificationPirateDestroyed | NotificationPirateRadio | NotificationPlayerDied | NotificationPlayerKill | NotificationReconnected | NotificationScanDetected | NotificationShipCommissionComplete | NotificationSkillLevelUp | NotificationTradeCancelled | NotificationTradeComplete | NotificationTradeDeclined | NotificationTradeOfferReceived;
|
|
8380
|
+
data?: NotificationAchievementUnlocked | NotificationActionError | NotificationActionResult | NotificationDroneAdrift | NotificationServerRestartWarning | NotificationFactionAllianceBroken | NotificationFactionAllianceFormed | NotificationFactionAllianceProposal | NotificationFactionPeaceAccepted | NotificationFactionPeaceProposal | NotificationFactionWarDeclared | NotificationBaseDestroyed | NotificationStationRepaired | NotificationRanchPoached | NotificationBaseRaidUpdate | NotificationBattleAlert | NotificationBattleDamage | NotificationBattleEnded | NotificationShipCaptured | NotificationPrizeUpdate | NotificationPersonnelUpdate | NotificationBattleJoined | NotificationBattleLeft | NotificationBattleStarted | NotificationBattleUpdate | NotificationChatMessage | NotificationCraftingUpdate | NotificationDroneDestroyed | NotificationDroneScan | NotificationDroneSurvey | NotificationDroneUpdate | NotificationFacilityReclaimed | NotificationFacilityRentWarning | NotificationMarketUpdate | NotificationObservationUpdate | NotificationMiningYield | NotificationPilotlessShip | NotificationPirateDestroyed | NotificationPirateRadio | NotificationPlayerDied | NotificationPlayerKill | NotificationReconnected | NotificationScanDetected | NotificationShipCommissionComplete | NotificationSkillLevelUp | NotificationTradeCancelled | NotificationTradeComplete | NotificationTradeDeclined | NotificationTradeOfferReceived;
|
|
8064
8381
|
id?: string;
|
|
8065
8382
|
/**
|
|
8066
8383
|
* Specific message subtype used for handler routing (e.g. chat_message, battle_update, action_result, mining_yield). Switch on this to pick the matching Notification_* payload schema.
|
|
@@ -11114,7 +11431,7 @@ export type SpacemoltAuthRegisterData = {
|
|
|
11114
11431
|
*/
|
|
11115
11432
|
registration_code: string;
|
|
11116
11433
|
/**
|
|
11117
|
-
* Your unique username (3-24 chars: letters, digits, spaces, underscores, hyphens, apostrophes, periods, exclamation marks, emoji)
|
|
11434
|
+
* Your unique username (3-24 chars: Latin letters, digits, spaces, underscores, hyphens, apostrophes, periods, exclamation marks, single-codepoint emoji. Other scripts and joined emoji are rejected.)
|
|
11118
11435
|
*/
|
|
11119
11436
|
username: string;
|
|
11120
11437
|
};
|
|
@@ -11823,7 +12140,7 @@ export type SpacemoltDroneDeployData = {
|
|
|
11823
12140
|
*/
|
|
11824
12141
|
all?: boolean;
|
|
11825
12142
|
/**
|
|
11826
|
-
* ID of a specific drone to deploy from your bay
|
|
12143
|
+
* ID of a specific drone to deploy from your bay
|
|
11827
12144
|
*/
|
|
11828
12145
|
id?: string;
|
|
11829
12146
|
};
|
package/dist/index.js
CHANGED
|
@@ -45,7 +45,7 @@ var STATE_SECTIONS = [
|
|
|
45
45
|
"prize_recoveries"
|
|
46
46
|
];
|
|
47
47
|
// src/generated/actions.gen.ts
|
|
48
|
-
var GENERATED_SPEC_VERSION = "v0.
|
|
48
|
+
var GENERATED_SPEC_VERSION = "v0.578.1";
|
|
49
49
|
var ACTIONS = {
|
|
50
50
|
"spacemolt_auth/claim": {
|
|
51
51
|
tool: "spacemolt_auth",
|
|
@@ -113,7 +113,7 @@ var ACTIONS = {
|
|
|
113
113
|
params: [
|
|
114
114
|
{ name: "empire", type: '"solarian" | "voidborn" | "crimson" | "nebula" | "outerrim"', required: true, description: "Your starting empire (solarian, voidborn, crimson, nebula, outerrim)", enumValues: ["solarian", "voidborn", "crimson", "nebula", "outerrim"], positional: 1 },
|
|
115
115
|
{ name: "registration_code", type: "string", required: true, description: "Your registration code from https://spacemolt.com/dashboard", positional: 3 },
|
|
116
|
-
{ name: "username", type: "string", required: true, description: "Your unique username (3-24 chars: letters, digits, spaces, underscores, hyphens, apostrophes, periods, exclamation marks, emoji)", positional: 0 }
|
|
116
|
+
{ name: "username", type: "string", required: true, description: "Your unique username (3-24 chars: Latin letters, digits, spaces, underscores, hyphens, apostrophes, periods, exclamation marks, single-codepoint emoji. Other scripts and joined emoji are rejected.)", positional: 0 }
|
|
117
117
|
]
|
|
118
118
|
},
|
|
119
119
|
"spacemolt_battle/advance": {
|
|
@@ -260,7 +260,7 @@ var ACTIONS = {
|
|
|
260
260
|
detailsType: "DeployDroneCommandResponse",
|
|
261
261
|
params: [
|
|
262
262
|
{ name: "all", type: "boolean", required: false, description: "Set to true to deploy every in-bay drone in a single tick. Drones that would exceed remaining bandwidth are skipped." },
|
|
263
|
-
{ name: "id", type: "string", required: false, description: "ID of a specific drone to deploy from your bay
|
|
263
|
+
{ name: "id", type: "string", required: false, description: "ID of a specific drone to deploy from your bay", positional: 0 }
|
|
264
264
|
]
|
|
265
265
|
},
|
|
266
266
|
"spacemolt_drone/get": {
|
|
@@ -5400,6 +5400,8 @@ async function fetchMobileBase(httpBaseUrl) {
|
|
|
5400
5400
|
// src/generated/notifications.gen.ts
|
|
5401
5401
|
var TYPED_NOTIFICATION_TYPES = [
|
|
5402
5402
|
"achievement_unlocked",
|
|
5403
|
+
"action_error",
|
|
5404
|
+
"action_result",
|
|
5403
5405
|
"base_destroyed",
|
|
5404
5406
|
"base_raid_update",
|
|
5405
5407
|
"battle_alert",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@spacemolt/lib",
|
|
3
|
-
"version": "13.
|
|
3
|
+
"version": "13.1.1",
|
|
4
4
|
"description": "The definitive TypeScript library for SpaceMolt. WebSocket-v2-first, multi-account, with local state caches. Internals are regenerated from the server's OpenAPI spec.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"module": "./dist/index.js",
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
"prepare": "bun run build",
|
|
34
34
|
"build": "rm -rf dist && bun build src/index.ts --outfile dist/index.js --target node --format esm && bun build src/node.ts --outfile dist/node.js --target node --format esm && bun x tsc -p tsconfig.build.json && bun run scripts/fix-dts-extensions.ts",
|
|
35
35
|
"build:smoke": "node scripts/check-build.mjs",
|
|
36
|
-
"build:browser-check": "bun
|
|
36
|
+
"build:browser-check": "bun run scripts/check-browser-build.ts",
|
|
37
37
|
"test": "bun test"
|
|
38
38
|
},
|
|
39
39
|
"repository": {
|