@spacemolt/lib 17.2.0 → 18.0.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.
- package/COMMANDS.md +1 -1
- package/README.md +3 -2
- package/dist/generated/actions.gen.d.ts +1 -1
- package/dist/generated/commands.gen.d.ts +3 -3
- package/dist/generated/notifications.gen.d.ts +3 -4
- package/dist/generated/openapi/types.gen.d.ts +74 -41
- package/dist/index.js +5 -6
- package/dist/index.js.map +5 -5
- package/package.json +1 -1
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.711.2`). **312 commands across 19 tools.**
|
|
5
5
|
|
|
6
6
|
## How to call a command
|
|
7
7
|
|
package/README.md
CHANGED
|
@@ -220,8 +220,9 @@ handshake, on by default) is a fallback underneath the batching, in case
|
|
|
220
220
|
something unexpected still trips the cap (e.g. other traffic sharing the IP).
|
|
221
221
|
This is the path to reach for.
|
|
222
222
|
|
|
223
|
-
Reconnect is close-code-aware: a `session_replaced` (
|
|
224
|
-
|
|
223
|
+
Reconnect is close-code-aware: a `session_replaced` (the player opened one
|
|
224
|
+
connection more than the 4 the server allows per account, and this was the
|
|
225
|
+
oldest) or a deliberate `close()` is terminal; transient drops reconnect
|
|
225
226
|
with backoff and restore subscriptions.
|
|
226
227
|
|
|
227
228
|
### Getting a Clerk API key
|
|
@@ -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.711.2";
|
|
3
3
|
export type ToolName = "spacemolt" | "spacemolt_arena" | "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_mobile_base_jump" | "cancel_order" | "cancel_ship_buy_order" | "cancel_ship_listing" | "captains_log_add" | "captains_log_delete" | "captains_log_get" | "captains_log_list" | "challenge" | "challenges" | "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" | "decommission_mobile_base" | "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" | "fight" | "find_route" | "fit_preview" | "forum_create_thread" | "forum_delete_reply" | "forum_delete_thread" | "forum_edit_reply" | "forum_edit_thread" | "forum_get_thread" | "forum_list" | "forum_reply" | "forum_upvote" | "found_gate_site" | "found_station" | "garages" | "generator" | "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_mobile_base" | "get_nearby" | "get_notes" | "get_notification_settings" | "get_notifications" | "get_player" | "get_player_profile" | "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" | "interact_poi" | "invite" | "jettison" | "job_add" | "job_cancel" | "job_list" | "job_reorder" | "join" | "jump" | "jump_mobile_base" | "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" | "move_mobile_base" | "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" | "reset_contraband" | "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_contraband" | "set_description" | "set_enemy" | "set_gate_access" | "set_home" | "set_market_fee" | "set_name" | "set_output_price" | "set_public" | "set_refuel_price" | "set_repair_price" | "set_service_access" | "set_status" | "set_toll" | "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 {
|
|
@@ -325,7 +325,7 @@ export interface SpacemoltFacilitySetDescriptionParams {
|
|
|
325
325
|
description?: string;
|
|
326
326
|
}
|
|
327
327
|
export interface SpacemoltFacilitySetGateAccessParams {
|
|
328
|
-
/** Access level for set_service_access; public or faction for set_gate_access */
|
|
328
|
+
/** Access level for set_service_access; public, allies or faction for set_gate_access */
|
|
329
329
|
access: "public" | "allies" | "faction";
|
|
330
330
|
}
|
|
331
331
|
export interface SpacemoltFacilitySetMarketFeeParams {
|
|
@@ -357,7 +357,7 @@ export interface SpacemoltFacilitySetRepairPriceParams {
|
|
|
357
357
|
price?: number;
|
|
358
358
|
}
|
|
359
359
|
export interface SpacemoltFacilitySetServiceAccessParams {
|
|
360
|
-
/** Access level for set_service_access; public or faction for set_gate_access */
|
|
360
|
+
/** Access level for set_service_access; public, allies or faction for set_gate_access */
|
|
361
361
|
access: "public" | "allies" | "faction";
|
|
362
362
|
/** Service type for set_service_access (market, refuel, repair, shipyard, crafting, salvage_yard, missions) */
|
|
363
363
|
service: string;
|
|
@@ -1213,7 +1213,7 @@ export interface SpacemoltSocialGetChatHistoryParams {
|
|
|
1213
1213
|
limit?: number;
|
|
1214
1214
|
/** Chat channel to get history for (system, local, faction, private, emergency) */
|
|
1215
1215
|
target: "system" | "local" | "faction" | "private" | "emergency";
|
|
1216
|
-
/** Player ID or username for
|
|
1216
|
+
/** 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. */
|
|
1217
1217
|
target_id?: string;
|
|
1218
1218
|
}
|
|
1219
1219
|
export interface SpacemoltSocialGetNotesParams {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { NotificationAchievementUnlocked, NotificationActionError, NotificationActionResult, NotificationArenaChallenge, NotificationArenaObjective, NotificationBaseDestroyed, NotificationBattleAlert, NotificationBattleDamage, NotificationBattleEnded, NotificationBattleJoined, NotificationBattleLeft, NotificationBattleStarted, NotificationBattleUpdate, NotificationChatMessage, NotificationCloak, NotificationCompleteMission, NotificationCraftingUpdate, NotificationDroneAdrift, NotificationDroneDestroyed, NotificationDroneScan, NotificationDroneSurvey, NotificationDroneUpdate, NotificationError, NotificationExchangeFill,
|
|
1
|
+
import type { NotificationAchievementUnlocked, NotificationActionError, NotificationActionResult, NotificationArenaChallenge, NotificationArenaObjective, NotificationBaseDestroyed, NotificationBattleAlert, NotificationBattleDamage, NotificationBattleEnded, NotificationBattleJoined, NotificationBattleLeft, NotificationBattleStarted, NotificationBattleUpdate, NotificationChatMessage, NotificationCloak, NotificationCompleteMission, NotificationCraftingUpdate, NotificationDroneAdrift, NotificationDroneDestroyed, NotificationDroneScan, NotificationDroneSurvey, NotificationDroneUpdate, NotificationError, NotificationExchangeFill, NotificationFacilityRentWarning, NotificationFactionAllianceBroken, NotificationFactionAllianceFormed, NotificationFactionAllianceProposal, NotificationFactionInvite, NotificationFactionKick, NotificationFactionMobileBaseUpdate, NotificationFactionPeaceAccepted, NotificationFactionPeaceProposal, NotificationFactionPromote, NotificationFactionWarDeclared, NotificationFactionWithdrawInvite, NotificationFleet, NotificationGiftReceived, NotificationHazardWarning, NotificationHoldUpdate, NotificationMarketUpdate, NotificationMiningYield, NotificationObservationUpdate, NotificationOk, NotificationPathfinderStorm, NotificationPersonnelUpdate, NotificationPilotlessShip, NotificationPirateDestroyed, NotificationPirateRadio, NotificationPlayerDied, NotificationPlayerKill, NotificationPrizeUpdate, NotificationRanchPoached, NotificationReconnected, NotificationRefueledBy, NotificationRepairedBy, 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" | "action_error" | "action_result" | "arena_challenge" | "arena_objective" | "base_destroyed" | "battle_alert" | "battle_damage" | "battle_ended" | "battle_joined" | "battle_left" | "battle_started" | "battle_update" | "chat_message" | "cloak" | "complete_mission" | "crafting_update" | "drone_adrift" | "drone_destroyed" | "drone_scan" | "drone_survey" | "drone_update" | "error" | "exchange_fill" | "
|
|
3
|
+
export type TypedNotificationType = "achievement_unlocked" | "action_error" | "action_result" | "arena_challenge" | "arena_objective" | "base_destroyed" | "battle_alert" | "battle_damage" | "battle_ended" | "battle_joined" | "battle_left" | "battle_started" | "battle_update" | "chat_message" | "cloak" | "complete_mission" | "crafting_update" | "drone_adrift" | "drone_destroyed" | "drone_scan" | "drone_survey" | "drone_update" | "error" | "exchange_fill" | "facility_rent_warning" | "faction_alliance_broken" | "faction_alliance_formed" | "faction_alliance_proposal" | "faction_invite" | "faction_kick" | "faction_mobile_base_update" | "faction_peace_accepted" | "faction_peace_proposal" | "faction_promote" | "faction_war_declared" | "faction_withdraw_invite" | "fleet" | "gift_received" | "hazard_warning" | "hold_update" | "market_update" | "mining_yield" | "observation_update" | "ok" | "pathfinder_storm" | "personnel_update" | "pilotless_ship" | "pirate_destroyed" | "pirate_radio" | "player_died" | "player_kill" | "prize_update" | "ranch_poached" | "reconnected" | "refueled_by" | "repaired_by" | "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;
|
|
@@ -27,7 +27,6 @@ export interface NotificationPayloads {
|
|
|
27
27
|
"drone_update": NotificationDroneUpdate;
|
|
28
28
|
"error": NotificationError;
|
|
29
29
|
"exchange_fill": NotificationExchangeFill;
|
|
30
|
-
"facility_reclaimed": NotificationFacilityReclaimed;
|
|
31
30
|
"facility_rent_warning": NotificationFacilityRentWarning;
|
|
32
31
|
"faction_alliance_broken": NotificationFactionAllianceBroken;
|
|
33
32
|
"faction_alliance_formed": NotificationFactionAllianceFormed;
|
|
@@ -72,4 +71,4 @@ export interface NotificationPayloads {
|
|
|
72
71
|
"trade_offer_received": NotificationTradeOfferReceived;
|
|
73
72
|
}
|
|
74
73
|
/** Names of every push msg_type with a published schema, for runtime checks. */
|
|
75
|
-
export declare const TYPED_NOTIFICATION_TYPES: readonly ["achievement_unlocked", "action_error", "action_result", "arena_challenge", "arena_objective", "base_destroyed", "battle_alert", "battle_damage", "battle_ended", "battle_joined", "battle_left", "battle_started", "battle_update", "chat_message", "cloak", "complete_mission", "crafting_update", "drone_adrift", "drone_destroyed", "drone_scan", "drone_survey", "drone_update", "error", "exchange_fill", "
|
|
74
|
+
export declare const TYPED_NOTIFICATION_TYPES: readonly ["achievement_unlocked", "action_error", "action_result", "arena_challenge", "arena_objective", "base_destroyed", "battle_alert", "battle_damage", "battle_ended", "battle_joined", "battle_left", "battle_started", "battle_update", "chat_message", "cloak", "complete_mission", "crafting_update", "drone_adrift", "drone_destroyed", "drone_scan", "drone_survey", "drone_update", "error", "exchange_fill", "facility_rent_warning", "faction_alliance_broken", "faction_alliance_formed", "faction_alliance_proposal", "faction_invite", "faction_kick", "faction_mobile_base_update", "faction_peace_accepted", "faction_peace_proposal", "faction_promote", "faction_war_declared", "faction_withdraw_invite", "fleet", "gift_received", "hazard_warning", "hold_update", "market_update", "mining_yield", "observation_update", "ok", "pathfinder_storm", "personnel_update", "pilotless_ship", "pirate_destroyed", "pirate_radio", "player_died", "player_kill", "prize_update", "ranch_poached", "reconnected", "refueled_by", "repaired_by", "scan_detected", "server_restart_warning", "ship_captured", "ship_commission_complete", "skill_level_up", "station_repaired", "trade_cancelled", "trade_complete", "trade_declined", "trade_offer_received"];
|
|
@@ -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
|
*/
|
|
@@ -3430,6 +3434,10 @@ export type EmpireNpcInfo = {
|
|
|
3430
3434
|
};
|
|
3431
3435
|
export type EmpirePolicySnapshot = {
|
|
3432
3436
|
bounty_attack: number;
|
|
3437
|
+
/**
|
|
3438
|
+
* Bounty in credits issued for evading a customs inspection in policed space.
|
|
3439
|
+
*/
|
|
3440
|
+
bounty_customs_evasion: number;
|
|
3433
3441
|
bounty_hold: number;
|
|
3434
3442
|
bounty_kill: number;
|
|
3435
3443
|
bounty_plunder: number;
|
|
@@ -3445,7 +3453,6 @@ export type EmpirePolicySnapshot = {
|
|
|
3445
3453
|
customs_fine_multiplier_bps: number;
|
|
3446
3454
|
default_foreign_sales_tax_bps: number;
|
|
3447
3455
|
empire_id: string;
|
|
3448
|
-
eviction_grace_cycles: number;
|
|
3449
3456
|
faction_income_tax_bps: number;
|
|
3450
3457
|
foreign_income_tax_deduction?: {
|
|
3451
3458
|
[key: string]: number;
|
|
@@ -3463,6 +3470,10 @@ export type EmpirePolicySnapshot = {
|
|
|
3463
3470
|
rep_baseline_outsider: number;
|
|
3464
3471
|
rep_decay_amount: number;
|
|
3465
3472
|
rep_penalty_attack: number;
|
|
3473
|
+
/**
|
|
3474
|
+
* Reputation lost for a customs evasion crime (a positive number applied as a loss).
|
|
3475
|
+
*/
|
|
3476
|
+
rep_penalty_customs_evasion: number;
|
|
3466
3477
|
rep_penalty_hold: number;
|
|
3467
3478
|
rep_penalty_kill: number;
|
|
3468
3479
|
rep_penalty_plunder: number;
|
|
@@ -3837,7 +3848,7 @@ export type FacilityEntry = {
|
|
|
3837
3848
|
*/
|
|
3838
3849
|
maintenance_satisfied?: boolean;
|
|
3839
3850
|
/**
|
|
3840
|
-
* Facility cycles of rent currently unpaid. Arrears owed for this facility equal rent_per_cycle times missed_rent_cycles.
|
|
3851
|
+
* Facility cycles of rent currently unpaid. Arrears owed for this facility equal rent_per_cycle times missed_rent_cycles. While this is above 0 the facility does not work, except storage, fuel bunkers and ship garages. Present only on player_facilities and faction_facilities entries; omitted means 0.
|
|
3841
3852
|
*/
|
|
3842
3853
|
missed_rent_cycles?: number;
|
|
3843
3854
|
/**
|
|
@@ -3880,6 +3891,10 @@ export type FacilityEntry = {
|
|
|
3880
3891
|
* 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.
|
|
3881
3892
|
*/
|
|
3882
3893
|
service?: string;
|
|
3894
|
+
/**
|
|
3895
|
+
* Game ticks left until construction finishes. Present only on player_facilities and faction_facilities entries while under_construction is true; omitted otherwise.
|
|
3896
|
+
*/
|
|
3897
|
+
ticks_until_complete?: number;
|
|
3883
3898
|
/**
|
|
3884
3899
|
* 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.
|
|
3885
3900
|
*/
|
|
@@ -3928,6 +3943,9 @@ export type FacilityFactionEntry = {
|
|
|
3928
3943
|
medical_capacity?: number;
|
|
3929
3944
|
medical_refill_per_cycle?: number;
|
|
3930
3945
|
medical_supply_item?: string;
|
|
3946
|
+
/**
|
|
3947
|
+
* Facility cycles of rent currently unpaid. While this is above 0 the facility does not work, except storage, fuel bunkers and ship garages. Omitted means 0.
|
|
3948
|
+
*/
|
|
3931
3949
|
missed_rent_cycles?: number;
|
|
3932
3950
|
name: string;
|
|
3933
3951
|
/**
|
|
@@ -3937,7 +3955,7 @@ export type FacilityFactionEntry = {
|
|
|
3937
3955
|
rental_fee_per_run?: number;
|
|
3938
3956
|
repair_complete_tick?: number;
|
|
3939
3957
|
/**
|
|
3940
|
-
* Only active facilities produce or provide their service; damaged ones need facility action repair; repairing ones are already paid for and come back at repair_complete_tick. Dismantling facilities are offline and will be removed. Rent is paused for every status except active.
|
|
3958
|
+
* Only active facilities produce or provide their service; damaged ones need facility action repair; repairing ones are already paid for and come back at repair_complete_tick. Dismantling facilities are offline and will be removed. Rent is paused for every status except active. An active facility with missed_rent_cycles above 0 also does not work until the arrears are paid, except storage, fuel bunkers and ship garages.
|
|
3941
3959
|
*/
|
|
3942
3960
|
status: 'under_construction' | 'damaged' | 'repairing' | 'active' | 'dismantling';
|
|
3943
3961
|
ticks_until_complete?: number;
|
|
@@ -4200,10 +4218,6 @@ export type FacilityRentSummary = {
|
|
|
4200
4218
|
* Number of owned facilities in this summary including facilities whose billing is paused and facilities at the owner's own faction station or outpost, which pay no rent and count at 0.
|
|
4201
4219
|
*/
|
|
4202
4220
|
facilities: number;
|
|
4203
|
-
/**
|
|
4204
|
-
* Consecutive unpayable rent cycles allowed before the station repossesses the facility. Arrears still accrue during the grace window. Omitted means the station sets no grace window.
|
|
4205
|
-
*/
|
|
4206
|
-
grace_cycles?: number;
|
|
4207
4221
|
note?: string;
|
|
4208
4222
|
/**
|
|
4209
4223
|
* Current rent in credits per facility cycle (100 ticks): sum rent_per_cycle for facilities where damaged and under_construction and dismantling are all false. Missing pause flags mean false. Zero means no current recurring rent; excludes existing arrears. Legacy inactive facilities remain billable.
|
|
@@ -4933,6 +4947,10 @@ export type FactionOwnedFacilityEntry = {
|
|
|
4933
4947
|
rental_fee_per_run?: number;
|
|
4934
4948
|
repair_complete_tick?: number;
|
|
4935
4949
|
system_id?: string;
|
|
4950
|
+
/**
|
|
4951
|
+
* Game ticks left until construction finishes. Present only while under_construction is true; omitted otherwise.
|
|
4952
|
+
*/
|
|
4953
|
+
ticks_until_complete?: number;
|
|
4936
4954
|
type: string;
|
|
4937
4955
|
under_construction?: boolean;
|
|
4938
4956
|
};
|
|
@@ -6018,6 +6036,10 @@ export type GaragedShipEntry = {
|
|
|
6018
6036
|
ship_id: string;
|
|
6019
6037
|
};
|
|
6020
6038
|
export type GateStatus = {
|
|
6039
|
+
/**
|
|
6040
|
+
* True when only the owning faction and its allies may cross. Omitted otherwise.
|
|
6041
|
+
*/
|
|
6042
|
+
allies_only?: boolean;
|
|
6021
6043
|
/**
|
|
6022
6044
|
* True when this end is built.
|
|
6023
6045
|
*/
|
|
@@ -8168,6 +8190,7 @@ export type Module = {
|
|
|
8168
8190
|
* Percentage points subtracted from hostile sensor-dampener reach reduction. Fitted bonuses stack up to the combat resistance cap.
|
|
8169
8191
|
*/
|
|
8170
8192
|
targeting_resistance?: number;
|
|
8193
|
+
telescope_grade?: number;
|
|
8171
8194
|
tow_speed_penalty?: number;
|
|
8172
8195
|
tracking_bonus?: number;
|
|
8173
8196
|
type: string;
|
|
@@ -8253,7 +8276,7 @@ export type NotificationChannelInfo = {
|
|
|
8253
8276
|
/**
|
|
8254
8277
|
* Frame payload shared by polling and inline notifications. Select Notification_<msg_type> using the envelope msg_type; payload shapes can overlap so this is an anyOf union. Null means the frame supplied no payload.
|
|
8255
8278
|
*/
|
|
8256
|
-
export type NotificationPayload = NotificationAchievementUnlocked | NotificationActionError | NotificationActionResult | NotificationArenaChallenge | NotificationArenaObjective | NotificationBaseDestroyed | NotificationBattleAlert | NotificationBattleDamage | NotificationBattleEnded | NotificationBattleJoined | NotificationBattleLeft | NotificationBattleStarted | NotificationBattleUpdate | NotificationChatMessage | NotificationCloak | NotificationCompleteMission | NotificationCraftingUpdate | NotificationDroneAdrift | NotificationDroneDestroyed | NotificationDroneScan | NotificationDroneSurvey | NotificationDroneUpdate | NotificationError | NotificationExchangeFill |
|
|
8279
|
+
export type NotificationPayload = NotificationAchievementUnlocked | NotificationActionError | NotificationActionResult | NotificationArenaChallenge | NotificationArenaObjective | NotificationBaseDestroyed | NotificationBattleAlert | NotificationBattleDamage | NotificationBattleEnded | NotificationBattleJoined | NotificationBattleLeft | NotificationBattleStarted | NotificationBattleUpdate | NotificationChatMessage | NotificationCloak | NotificationCompleteMission | NotificationCraftingUpdate | NotificationDroneAdrift | NotificationDroneDestroyed | NotificationDroneScan | NotificationDroneSurvey | NotificationDroneUpdate | NotificationError | NotificationExchangeFill | NotificationFacilityRentWarning | NotificationFactionAllianceBroken | NotificationFactionAllianceFormed | NotificationFactionAllianceProposal | NotificationFactionInvite | NotificationFactionKick | NotificationFactionMobileBaseUpdate | NotificationFactionPeaceAccepted | NotificationFactionPeaceProposal | NotificationFactionPromote | NotificationFactionWarDeclared | NotificationFactionWithdrawInvite | NotificationFleet | NotificationGiftReceived | NotificationHazardWarning | NotificationHoldUpdate | NotificationMarketUpdate | NotificationMiningYield | NotificationObservationUpdate | NotificationOk | NotificationPathfinderStorm | NotificationPersonnelUpdate | NotificationPilotlessShip | NotificationPirateDestroyed | NotificationPirateRadio | NotificationPlayerDied | NotificationPlayerKill | NotificationPrizeUpdate | NotificationRanchPoached | NotificationReconnected | NotificationRefueledBy | NotificationRepairedBy | NotificationScanDetected | NotificationServerRestartWarning | NotificationShipCaptured | NotificationShipCommissionComplete | NotificationSkillLevelUp | NotificationStationRepaired | NotificationTradeCancelled | NotificationTradeComplete | NotificationTradeDeclined | NotificationTradeOfferReceived | null;
|
|
8257
8280
|
export type NotificationSettingsResponse = {
|
|
8258
8281
|
action: string;
|
|
8259
8282
|
channels: Array<NotificationChannelInfo>;
|
|
@@ -8308,7 +8331,7 @@ export type NotificationActionError = {
|
|
|
8308
8331
|
tick: number;
|
|
8309
8332
|
};
|
|
8310
8333
|
/**
|
|
8311
|
-
* 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
|
|
8334
|
+
* 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.
|
|
8312
8335
|
*/
|
|
8313
8336
|
export type NotificationActionResult = {
|
|
8314
8337
|
/**
|
|
@@ -8714,23 +8737,7 @@ export type NotificationExchangeFill = {
|
|
|
8714
8737
|
type: string;
|
|
8715
8738
|
};
|
|
8716
8739
|
/**
|
|
8717
|
-
* Pushed to a facility owner (or all faction members) when
|
|
8718
|
-
*/
|
|
8719
|
-
export type NotificationFacilityReclaimed = {
|
|
8720
|
-
base_id: string;
|
|
8721
|
-
base_name: string;
|
|
8722
|
-
/**
|
|
8723
|
-
* Names of the repossessed facilities.
|
|
8724
|
-
*/
|
|
8725
|
-
facilities?: Array<string>;
|
|
8726
|
-
/**
|
|
8727
|
-
* Set only on the faction-owned-facility variant.
|
|
8728
|
-
*/
|
|
8729
|
-
faction_id?: string;
|
|
8730
|
-
message: string;
|
|
8731
|
-
};
|
|
8732
|
-
/**
|
|
8733
|
-
* Pushed to a facility owner (or all faction members for faction-owned facilities) when rent is overdue and repossession is approaching. Sent when any one facility at the base reaches its 1st missed cycle, half of grace_cycles, 86 cycles (about one day) before repossession, or 3 cycles before it. A warning and a facility_reclaimed notice can both arrive in the same cycle. Each warning is also written to the action log as `other.rent_warning` (`faction.rent_warning` for faction-owned facilities) with the same fields.
|
|
8740
|
+
* Pushed to a facility owner (or all faction members for faction-owned facilities) when rent is overdue. A facility with arrears does not work until they are paid, except storage, fuel bunkers, and ship garages. Sent when any one facility at the base reaches its 1st missed cycle, then every 86 missed cycles (about one day). Each warning is also written to the action log as `other.rent_warning` (`faction.rent_warning` for faction-owned facilities) with the same fields.
|
|
8734
8741
|
*/
|
|
8735
8742
|
export type NotificationFacilityRentWarning = {
|
|
8736
8743
|
base_id: string;
|
|
@@ -8747,13 +8754,9 @@ export type NotificationFacilityRentWarning = {
|
|
|
8747
8754
|
* Set only on the faction-owned-facility variant.
|
|
8748
8755
|
*/
|
|
8749
8756
|
faction_id?: string;
|
|
8750
|
-
/**
|
|
8751
|
-
* Missed cycles at which the station repossesses.
|
|
8752
|
-
*/
|
|
8753
|
-
grace_cycles?: number;
|
|
8754
8757
|
message: string;
|
|
8755
8758
|
/**
|
|
8756
|
-
* Highest consecutive missed rent cycles among the owner's facilities at this base
|
|
8759
|
+
* Highest consecutive missed rent cycles among the owner's facilities at this base.
|
|
8757
8760
|
*/
|
|
8758
8761
|
missed_cycles?: number;
|
|
8759
8762
|
};
|
|
@@ -8988,11 +8991,11 @@ export type NotificationHoldUpdate = {
|
|
|
8988
8991
|
*/
|
|
8989
8992
|
event: 'started' | 'ended';
|
|
8990
8993
|
/**
|
|
8991
|
-
* Player whose warp scrambler holds the target.
|
|
8994
|
+
* Player or customs cutter (empire NPC ID) whose warp scrambler holds the target.
|
|
8992
8995
|
*/
|
|
8993
8996
|
holder_id: string;
|
|
8994
8997
|
/**
|
|
8995
|
-
* Holder username.
|
|
8998
|
+
* Holder username, or the customs cutter's name.
|
|
8996
8999
|
*/
|
|
8997
9000
|
holder_name: string;
|
|
8998
9001
|
/**
|
|
@@ -9000,13 +9003,13 @@ export type NotificationHoldUpdate = {
|
|
|
9000
9003
|
*/
|
|
9001
9004
|
message: string;
|
|
9002
9005
|
/**
|
|
9003
|
-
* Why the hold ended. Present only on ended. paid: the target accepted the toll. offer_closed: the toll was declined, cancelled or expired and the 2-tick grace ran out. holder_acted: the holder queued a command other than scan, trade_offer, attack or reload. holder_left: the holder or target left the POI, docked, jumped or died. battle: the two pilots are now in the same battle, and combat tackle applies. scan_over: a scan hold ran its 5 ticks with no toll offer.
|
|
9006
|
+
* Why the hold ended. Present only on ended. paid: the target accepted the toll. offer_closed: the toll was declined, cancelled or expired and the 2-tick grace ran out. holder_acted: the holder queued a command other than scan, trade_offer, attack or reload. holder_left: the holder or target left the POI, docked, jumped or died. battle: the two pilots are now in the same battle, and combat tackle applies. scan_over: a scan hold ran its 5 ticks with no toll offer, or a customs inspection ended.
|
|
9004
9007
|
*/
|
|
9005
9008
|
reason?: 'paid' | 'offer_closed' | 'holder_acted' | 'holder_left' | 'battle' | 'scan_over';
|
|
9006
9009
|
/**
|
|
9007
|
-
* What holds the target: toll is a trade_offer with hold=true; scan is a cargo scan from a ship with a warp scrambler. A toll offer sent during a scan hold turns it into a toll hold.
|
|
9010
|
+
* What holds the target: toll is a trade_offer with hold=true; scan is a cargo scan from a ship with a warp scrambler; customs is a customs inspection. A toll offer sent during a scan hold turns it into a toll hold.
|
|
9008
9011
|
*/
|
|
9009
|
-
source: 'toll' | 'scan';
|
|
9012
|
+
source: 'toll' | 'scan' | 'customs';
|
|
9010
9013
|
/**
|
|
9011
9014
|
* Tick the hold started.
|
|
9012
9015
|
*/
|
|
@@ -9774,6 +9777,10 @@ export type OwnedFacilityEntry = {
|
|
|
9774
9777
|
rental_fee_per_run?: number;
|
|
9775
9778
|
repair_complete_tick?: number;
|
|
9776
9779
|
system_id?: string;
|
|
9780
|
+
/**
|
|
9781
|
+
* Game ticks left until construction finishes. Present only while under_construction is true; omitted otherwise.
|
|
9782
|
+
*/
|
|
9783
|
+
ticks_until_complete?: number;
|
|
9777
9784
|
type: string;
|
|
9778
9785
|
under_construction?: boolean;
|
|
9779
9786
|
};
|
|
@@ -10682,7 +10689,7 @@ export type PlayerStats = {
|
|
|
10682
10689
|
*/
|
|
10683
10690
|
gate_crossings?: number;
|
|
10684
10691
|
/**
|
|
10685
|
-
* Jump gate ends you founded with build_gate_site. Omitted until the first.
|
|
10692
|
+
* Jump gate ends you founded with found_gate_site (v1: build_gate_site). Omitted until the first.
|
|
10686
10693
|
*/
|
|
10687
10694
|
gate_sites_founded?: number;
|
|
10688
10695
|
gifts_received?: number;
|
|
@@ -12997,6 +13004,20 @@ export type SovereignMintStatus = {
|
|
|
12997
13004
|
*/
|
|
12998
13005
|
status: 'blocked_inputs' | 'blocked_internal' | 'price_limited';
|
|
12999
13006
|
};
|
|
13007
|
+
export type StarSighting = {
|
|
13008
|
+
/**
|
|
13009
|
+
* Compass bearing to the star in degrees, in the convention of a numeric jump bearing.
|
|
13010
|
+
*/
|
|
13011
|
+
bearing: number;
|
|
13012
|
+
/**
|
|
13013
|
+
* Apparent brightness of the star from the current position. Higher is brighter.
|
|
13014
|
+
*/
|
|
13015
|
+
brightness: number;
|
|
13016
|
+
/**
|
|
13017
|
+
* Surface temperature read from the light of the star, in kelvin.
|
|
13018
|
+
*/
|
|
13019
|
+
temperature: number;
|
|
13020
|
+
};
|
|
13000
13021
|
export type StationConfigResponse = {
|
|
13001
13022
|
/**
|
|
13002
13023
|
* The station action that ran, lower-cased. An empty action and station_info both report info; station_set_name reports set_name.
|
|
@@ -14514,6 +14535,10 @@ export type V2Location = {
|
|
|
14514
14535
|
*/
|
|
14515
14536
|
resources: Array<V2Resource>;
|
|
14516
14537
|
security_status: string;
|
|
14538
|
+
/**
|
|
14539
|
+
* 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.
|
|
14540
|
+
*/
|
|
14541
|
+
star_sightings?: Array<StarSighting>;
|
|
14517
14542
|
system_id: string;
|
|
14518
14543
|
system_name: string;
|
|
14519
14544
|
/**
|
|
@@ -14737,7 +14762,7 @@ export type V2Response = {
|
|
|
14737
14762
|
*/
|
|
14738
14763
|
code?: string;
|
|
14739
14764
|
/**
|
|
14740
|
-
* 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.
|
|
14765
|
+
* 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.
|
|
14741
14766
|
*/
|
|
14742
14767
|
details?: {
|
|
14743
14768
|
[key: string]: unknown;
|
|
@@ -14906,6 +14931,14 @@ export type V2Ship = {
|
|
|
14906
14931
|
* Fit crew required for full operational efficiency
|
|
14907
14932
|
*/
|
|
14908
14933
|
minimum_crew: number;
|
|
14934
|
+
/**
|
|
14935
|
+
* CPU the fitted modules draw before the engineering efficiency bonus
|
|
14936
|
+
*/
|
|
14937
|
+
module_cpu: number;
|
|
14938
|
+
/**
|
|
14939
|
+
* Power the fitted modules draw before the engineering efficiency bonus
|
|
14940
|
+
*/
|
|
14941
|
+
module_power: number;
|
|
14909
14942
|
/**
|
|
14910
14943
|
* Display name of the ship (custom name if set, otherwise the class name)
|
|
14911
14944
|
*/
|
|
@@ -20863,7 +20896,7 @@ export type SpacemoltFacilitySetDescriptionResponse = SpacemoltFacilitySetDescri
|
|
|
20863
20896
|
export type SpacemoltFacilitySetGateAccessData = {
|
|
20864
20897
|
body?: {
|
|
20865
20898
|
/**
|
|
20866
|
-
* Access level for set_service_access; public or faction for set_gate_access
|
|
20899
|
+
* Access level for set_service_access; public, allies or faction for set_gate_access
|
|
20867
20900
|
*/
|
|
20868
20901
|
access: 'public' | 'allies' | 'faction';
|
|
20869
20902
|
};
|
|
@@ -21123,7 +21156,7 @@ export type SpacemoltFacilitySetRepairPriceResponse = SpacemoltFacilitySetRepair
|
|
|
21123
21156
|
export type SpacemoltFacilitySetServiceAccessData = {
|
|
21124
21157
|
body?: {
|
|
21125
21158
|
/**
|
|
21126
|
-
* Access level for set_service_access; public or faction for set_gate_access
|
|
21159
|
+
* Access level for set_service_access; public, allies or faction for set_gate_access
|
|
21127
21160
|
*/
|
|
21128
21161
|
access: 'public' | 'allies' | 'faction';
|
|
21129
21162
|
/**
|
|
@@ -27210,7 +27243,7 @@ export type SpacemoltSocialGetChatHistoryData = {
|
|
|
27210
27243
|
*/
|
|
27211
27244
|
target: 'system' | 'local' | 'faction' | 'private' | 'emergency';
|
|
27212
27245
|
/**
|
|
27213
|
-
* Player ID or username for
|
|
27246
|
+
* 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.
|
|
27214
27247
|
*/
|
|
27215
27248
|
target_id?: string;
|
|
27216
27249
|
};
|
package/dist/index.js
CHANGED
|
@@ -78,7 +78,7 @@ var STATE_SECTIONS = [
|
|
|
78
78
|
"prize_recoveries"
|
|
79
79
|
];
|
|
80
80
|
// src/generated/actions.gen.ts
|
|
81
|
-
var GENERATED_SPEC_VERSION = "v0.
|
|
81
|
+
var GENERATED_SPEC_VERSION = "v0.711.2";
|
|
82
82
|
var ACTIONS = {
|
|
83
83
|
"spacemolt_arena/accept": {
|
|
84
84
|
tool: "spacemolt_arena",
|
|
@@ -862,7 +862,7 @@ var ACTIONS = {
|
|
|
862
862
|
summary: "Administer one of your faction's stations or outposts: rename, access control, and build policy",
|
|
863
863
|
detailsType: "StationConfigResponse",
|
|
864
864
|
params: [
|
|
865
|
-
{ name: "access", type: '"public" | "allies" | "faction"', required: true, description: "Access level for set_service_access; public or faction for set_gate_access", enumValues: ["public", "allies", "faction"] }
|
|
865
|
+
{ name: "access", type: '"public" | "allies" | "faction"', required: true, description: "Access level for set_service_access; public, allies or faction for set_gate_access", enumValues: ["public", "allies", "faction"] }
|
|
866
866
|
]
|
|
867
867
|
},
|
|
868
868
|
"spacemolt_facility/set_market_fee": {
|
|
@@ -934,7 +934,7 @@ var ACTIONS = {
|
|
|
934
934
|
summary: "Administer one of your faction's stations or outposts: rename, access control, and build policy",
|
|
935
935
|
detailsType: "StationConfigResponse",
|
|
936
936
|
params: [
|
|
937
|
-
{ name: "access", type: '"public" | "allies" | "faction"', required: true, description: "Access level for set_service_access; public or faction for set_gate_access", enumValues: ["public", "allies", "faction"] },
|
|
937
|
+
{ name: "access", type: '"public" | "allies" | "faction"', required: true, description: "Access level for set_service_access; public, allies or faction for set_gate_access", enumValues: ["public", "allies", "faction"] },
|
|
938
938
|
{ name: "service", type: "string", required: true, description: "Service type for set_service_access (market, refuel, repair, shipyard, crafting, salvage_yard, missions)" }
|
|
939
939
|
]
|
|
940
940
|
},
|
|
@@ -2492,7 +2492,7 @@ var ACTIONS = {
|
|
|
2492
2492
|
{ name: "before", type: "string", required: false, description: "RFC3339 timestamp for cursor-based pagination - get messages before this time" },
|
|
2493
2493
|
{ name: "limit", type: "number", required: false, description: "Max messages to return (default 50, max 100)" },
|
|
2494
2494
|
{ name: "target", type: '"system" | "local" | "faction" | "private" | "emergency"', required: true, description: "Chat channel to get history for (system, local, faction, private, emergency)", enumValues: ["system", "local", "faction", "private", "emergency"], positional: 0 },
|
|
2495
|
-
{ name: "target_id", type: "string", required: false, description: "Player ID or username for
|
|
2495
|
+
{ name: "target_id", type: "string", required: false, description: "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." }
|
|
2496
2496
|
]
|
|
2497
2497
|
},
|
|
2498
2498
|
"spacemolt_social/get_notes": {
|
|
@@ -5949,7 +5949,6 @@ var TYPED_NOTIFICATION_TYPES = [
|
|
|
5949
5949
|
"drone_update",
|
|
5950
5950
|
"error",
|
|
5951
5951
|
"exchange_fill",
|
|
5952
|
-
"facility_reclaimed",
|
|
5953
5952
|
"facility_rent_warning",
|
|
5954
5953
|
"faction_alliance_broken",
|
|
5955
5954
|
"faction_alliance_formed",
|
|
@@ -6077,5 +6076,5 @@ export {
|
|
|
6077
6076
|
retryAfterMsFromClose
|
|
6078
6077
|
};
|
|
6079
6078
|
|
|
6080
|
-
//# debugId=
|
|
6079
|
+
//# debugId=0937380C3977240064756E2164756E21
|
|
6081
6080
|
//# sourceMappingURL=index.js.map
|