fleethub-core 1.11.23 → 1.11.25

package/node/fleethub_core.d.ts

@@ -8,31 +8,44 @@ export function parse_ship_conditions(value: ShipConditions): ShipConditions;
 /**
  */
 export function set_panic_hook(): void;
-export interface CompAnalyzerConfig {
-  engagement: Engagement;
+export type GearTypeIdArray = [number, number, number, number, number];
+
+export interface FleetCutinReport<T> {
+  cutin: FleetCutin;
+  rate: number | null;
   formation: Formation;
-  anti_air_cutin: number | null;
-  ship_anti_air_resist: number;
-  fleet_anti_air_resist: number;
-  left_night_fleet_conditions: NightFleetConditions;
-  right_night_fleet_conditions: NightFleetConditions;
+  attacks: FleetCutinAttackReport<T>[];
 }
 
-export interface CompNightAnalysis {
-  night_cutin: CompNightCutinAnalysis;
-  fleet_cutin: FleetCutinReport<NightAttackStyle>[];
+export interface FleetCutinAttackReport<T> extends AttackReport<T> {
+  index: number;
+  ship_id: number;
+  power_mod: number;
 }
 
-export interface CompDayAnalysis {
-  day_cutin: CompDayCutinAnalysis;
-  fleet_cutin: FleetCutinReport<ShellingStyle>[];
+export interface DamageReport {
+  miss_damage_min: number;
+  miss_damage_max: number;
+  normal_damage_min: number;
+  normal_damage_max: number;
+  critical_damage_min: number;
+  critical_damage_max: number;
+  normal_scratch_rate: number;
+  critical_scratch_rate: number;
+  damage_density: Histogram<number, number>;
+  damage_state_density: Histogram<DamageState, number>;
 }
 
-export interface CompAnalysis {
-  day: CompDayAnalysis;
-  night: CompNightAnalysis;
-  contact: ContactAnalysis;
-  anti_air: CompAntiAirAnalysis;
+export interface AttackAnalysis {
+  attacker_is_player: boolean;
+  attacker_ship_id: number;
+  target_ship_id: number;
+  historical_params: HistoricalParams;
+  day: ActionReport<DayPhaseAttackStyle>;
+  night: ActionReport<NightPhaseAttackStyle>;
+  closing_torpedo: ActionReport<TorpedoAttackStyle>;
+  opening_asw: ActionReport<AswAttackStyle>;
+  support_shelling: ActionReport<SupportShellingStyle>;
 }
 
 export type AirSquadronMode = "Sortie" | "AirDefense";
@@ -42,19 +55,70 @@ export interface AirSquadronState extends GearVecState, SlotSizeVecState {
   mode?: AirSquadronMode;
 }
 
-export type AirState =
-  | "AirSupremacy"
-  | "AirSuperiority"
-  | "AirParity"
-  | "AirDenial"
-  | "AirIncapability";
+export type ContactRank = "Rank1" | "Rank2" | "Rank3";
 
-export type AirStateRank = "Rank0" | "Rank1" | "Rank2" | "Rank3";
+export type DamageState = "Normal" | "Shouha" | "Chuuha" | "Taiha" | "Sunk";
 
 export type Engagement = "GreenT" | "Parallel" | "HeadOn" | "RedT";
 
 export type Role = "Main" | "Escort";
 
+export interface ShipConditions extends ShipPosition {
+  formation?: Formation;
+  amagiri_index?: number | null;
+}
+
+export type ShipCategory =
+  | "Battleship"
+  | "AircraftCarrier"
+  | "HeavyCruiser"
+  | "LightCruiser"
+  | "Destroyer"
+  | "CoastalDefenseShip"
+  | "Submarine"
+  | "AuxiliaryShip";
+
+export type ShipType =
+  | "Unknown"
+  | "DE"
+  | "DD"
+  | "CL"
+  | "CLT"
+  | "CA"
+  | "CAV"
+  | "CVL"
+  | "FBB"
+  | "BB"
+  | "BBV"
+  | "CV"
+  | "XBB"
+  | "SS"
+  | "SSV"
+  | "AP"
+  | "AV"
+  | "LHA"
+  | "CVB"
+  | "AR"
+  | "AS"
+  | "CT"
+  | "AO";
+
+export type SpecialEnemyType =
+  | "None"
+  | "SoftSkinned"
+  | "Pillbox"
+  | "IsolatedIsland"
+  | "SupplyDepot"
+  | "NewSupplyDepot"
+  | "HarbourSummerPrincess"
+  | "PtImp"
+  | "BattleshipSummerPrincess"
+  | "HeavyCruiserSummerPrincess"
+  | "FrenchBattleshipPrincess"
+  | "AnchorageWaterDemonVacationMode"
+  | "DockPrincess"
+  | "SummerAircraftCarrierDemon";
+
 export interface SupportShellingSimulatorParams {
   attacker_formation?: Formation;
   target_formation?: Formation;
@@ -62,6 +126,8 @@ export interface SupportShellingSimulatorParams {
   node_state: NodeState;
 }
 
+export type FhResult<T> = { Ok: T } | { Err: string };
+
 export interface MasterIBonuses {
   shelling_power: MasterIBonusRule[];
   shelling_accuracy: MasterIBonusRule[];
@@ -167,10 +233,6 @@ export interface NightFleetConditions {
   activates_large_searchlight?: boolean;
 }
 
-export type ContactRank = "Rank1" | "Rank2" | "Rank3";
-
-export type DamageState = "Normal" | "Shouha" | "Chuuha" | "Taiha" | "Sunk";
-
 export interface FleetState {
   id?: string;
   len?: number;
@@ -200,29 +262,6 @@ export interface CompMeta {
 
 export type MoraleState = "Sparkle" | "Normal" | "Orange" | "Red";
 
-export interface ShipConditions extends ShipPosition {
-  formation?: Formation;
-  amagiri_index?: number | null;
-}
-
-export type SpecialEnemyType =
-  | "None"
-  | "SoftSkinned"
-  | "Pillbox"
-  | "IsolatedIsland"
-  | "SupplyDepot"
-  | "NewSupplyDepot"
-  | "HarbourSummerPrincess"
-  | "PtImp"
-  | "BattleshipSummerPrincess"
-  | "HeavyCruiserSummerPrincess"
-  | "FrenchBattleshipPrincess"
-  | "AnchorageWaterDemonVacationMode"
-  | "DockPrincess"
-  | "SummerAircraftCarrierDemon";
-
-export type FhResult<T> = { Ok: T } | { Err: string };
-
 export interface MasterData extends MasterBattleDefinitions {
   created_at: number;
   gears: MasterGear[];
@@ -244,37 +283,6 @@ export interface MasterAttrRule<T> {
   expr: CompiledEvaler;
 }
 
-export interface EquippabilityRule {
-  ship: CompiledEvaler;
-  keys?: string[];
-  include?: string;
-  exclude?: string;
-}
-
-export interface MasterEquippability {
-  equip_stype: EquipStype[];
-  equip_exslot: number[];
-  equip_ship: MstEquipShip[];
-  equip_exslot_ship: Record<number, MstEquipExslotShip>;
-  rules: EquippabilityRule[];
-}
-
-export interface MstEquipExslotShip {
-  api_ctypes: Record<number, number> | null;
-  api_ship_ids: Record<number, number> | null;
-  api_stypes: Record<number, number> | null;
-}
-
-export interface MstEquipShip {
-  api_ship_id: number;
-  api_equip_type: number[];
-}
-
-export interface EquipStype {
-  id: number;
-  equip_type: number[];
-}
-
 export interface MasterBattleDefinitions {
   formation: NestedFormationDef[];
   anti_air_cutin: AntiAirCutinDef[];
@@ -333,22 +341,6 @@ export interface AttackAnalyzerShipConfig
   fleet_los_mod?: number | null;
 }
 
-export type SingleFormation =
-  | "LineAhead"
-  | "DoubleLine"
-  | "Diamond"
-  | "Echelon"
-  | "LineAbreast"
-  | "Vanguard";
-
-export type CombinedFormation =
-  | "Cruising1"
-  | "Cruising2"
-  | "Cruising3"
-  | "Cruising4";
-
-export type Formation = SingleFormation | CombinedFormation;
-
 export type GearAttr =
   | "Unknown"
   | "HighAngleMount"
@@ -406,15 +398,35 @@ export type OrgType =
   | "EnemySingle"
   | "EnemyCombined";
 
-export interface AttackReport<T> {
-  style: T;
-  proc_rate: number | null;
-  attack_power: AttackPower | null;
-  attack_power_params: AttackPowerParams | null;
-  hits: number;
-  hit_rate: HitRate | null;
-  hit_rate_params: HitRateParams | null;
-  damage: DamageReport | null;
+export interface EquippabilityRule {
+  ship: CompiledEvaler;
+  keys?: string[];
+  include?: string;
+  exclude?: string;
+}
+
+export interface MasterEquippability {
+  equip_stype: EquipStype[];
+  equip_exslot: number[];
+  equip_ship: MstEquipShip[];
+  equip_exslot_ship: Record<number, MstEquipExslotShip>;
+  rules: EquippabilityRule[];
+}
+
+export interface MstEquipExslotShip {
+  api_ctypes: Record<number, number> | null;
+  api_ship_ids: Record<number, number> | null;
+  api_stypes: Record<number, number> | null;
+}
+
+export interface MstEquipShip {
+  api_ship_id: number;
+  api_equip_type: number[];
+}
+
+export interface EquipStype {
+  id: number;
+  equip_type: number[];
 }
 
 export interface CompAntiAirAnalysis {
@@ -510,6 +522,22 @@ export interface BattleDefinitions {
 
 export type FleetType = "Main" | "Escort" | "RouteSup" | "BossSup";
 
+export type SingleFormation =
+  | "LineAhead"
+  | "DoubleLine"
+  | "Diamond"
+  | "Echelon"
+  | "LineAbreast"
+  | "Vanguard";
+
+export type CombinedFormation =
+  | "Cruising1"
+  | "Cruising2"
+  | "Cruising3"
+  | "Cruising4";
+
+export type Formation = SingleFormation | CombinedFormation;
+
 export interface ShipPosition {
   org_type?: OrgType;
   fleet_type?: FleetType;
@@ -519,26 +547,9 @@ export interface ShipPosition {
 
 export type Histogram<K extends keyof any, V> = Partial<Record<K, V>>;
 
-export type NodeId = string;
-
-export interface NodeState {
-  map?: number;
-  node?: NodeId;
-  phase?: number;
-  debuff?: boolean;
-  disable_historical_mod?: boolean;
-  landing_battle?: boolean;
-}
-
-export type Side = "Player" | "Enemy";
-
-export type Align = "Left" | "Right";
-
-export type CompiledEvaler = string;
-
-export interface SimulatorResult {
-  items: SimulatorResultItem[];
-  sunk_vec: [number, number, number][];
+export interface SimulatorResult {
+  items: SimulatorResultItem[];
+  sunk_vec: [number, number, number][];
 }
 
 export interface SimulatorResultItem {
@@ -548,6 +559,25 @@ export interface SimulatorResultItem {
   damage_state_map: Record<DamageState, number>;
 }
 
+export interface AttackReport<T> {
+  style: T;
+  proc_rate: number | null;
+  attack_power: AttackPower | null;
+  attack_power_params: AttackPowerParams | null;
+  hits: number;
+  hit_rate: HitRate | null;
+  hit_rate_params: HitRateParams | null;
+  damage: DamageReport | null;
+}
+
+export type AirWaveType = "Jet" | "LandBase" | "Carrier";
+
+export type Side = "Player" | "Enemy";
+
+export type Align = "Left" | "Right";
+
+export type CompiledEvaler = string;
+
 export interface HitRate {
   normal: number;
   critical: number;
@@ -603,8 +633,6 @@ export interface DayContactChance {
   total: number;
 }
 
-export type AirWaveType = "Jet" | "LandBase" | "Carrier";
-
 export type AswAttackType = "DepthCharge" | "Aerial";
 
 export type ShellingType = "Normal" | "Aerial";
@@ -630,6 +658,19 @@ export type NightPhaseAttackType =
 
 export type TorpedoAttackType = null;
 
+export type NodeId = string;
+
+export interface NodeState {
+  map?: number;
+  node?: NodeId;
+  phase?: number;
+  debuff?: boolean;
+  disable_historical_mod?: boolean;
+  landing_battle?: boolean;
+}
+
+export type SlotSizeVec = (number | null)[];
+
 export interface MoveShipPayload {
   current: [string, string, ShipKey];
   target: [string | null, string, ShipKey];
@@ -698,6 +739,84 @@ export interface SupportShellingStyle {
   attack_type: SupportShellingType;
 }
 
+export type GearType =
+  | "Unknown"
+  | "SmallMainGun"
+  | "MediumMainGun"
+  | "LargeMainGun"
+  | "SecondaryGun"
+  | "Torpedo"
+  | "CbFighter"
+  | "CbDiveBomber"
+  | "CbTorpedoBomber"
+  | "CbRecon"
+  | "ReconSeaplane"
+  | "SeaplaneBomber"
+  | "SmallRadar"
+  | "LargeRadar"
+  | "Sonar"
+  | "DepthCharge"
+  | "ExtraArmor"
+  | "Engine"
+  | "AntiAirShell"
+  | "ApShell"
+  | "VtFuze"
+  | "AntiAirGun"
+  | "MidgetSubmarine"
+  | "EmergencyRepair"
+  | "LandingCraft"
+  | "Rotorcraft"
+  | "AntiSubPatrolAircraft"
+  | "MediumArmor"
+  | "LargeArmor"
+  | "Searchlight"
+  | "SupplyContainer"
+  | "ShipRepairFacility"
+  | "SubmarineTorpedo"
+  | "Starshell"
+  | "CommandFacility"
+  | "AviationPersonnel"
+  | "AntiAirFireDirector"
+  | "AntiGroundEquipment"
+  | "LargeMainGun2"
+  | "ShipPersonnel"
+  | "LargeSonar"
+  | "LargeFlyingBoat"
+  | "LargeSearchlight"
+  | "CombatRation"
+  | "Supplies"
+  | "SeaplaneFighter"
+  | "AmphibiousTank"
+  | "LbAttacker"
+  | "LbFighter"
+  | "LbRecon"
+  | "TransportationMaterial"
+  | "SubmarineEquipment"
+  | "LandingForce"
+  | "LargeLbAircraft"
+  | "SurfaceEquipment"
+  | "JetFighter"
+  | "JetFighterBomber"
+  | "JetTorpedoBomber"
+  | "JetRecon"
+  | "LargeRadar2"
+  | "CbRecon2"
+  | "SecondaryGun2";
+
+export type GearCategory =
+  | "Fighter"
+  | "Bomber"
+  | "Recon"
+  | "MainGun"
+  | "Secondary"
+  | "Torpedo"
+  | "AntiSub"
+  | "Radar"
+  | "Landing"
+  | "Ration"
+  | "LandBased"
+  | "Misc";
+
 export interface SlotSizeVecState {
   ss1?: number;
   ss2?: number;
@@ -730,10 +849,48 @@ export interface ShipState extends GearVecState, SlotSizeVecState {
 
 export type ShipKey = "s1" | "s2" | "s3" | "s4" | "s5" | "s6" | "s7";
 
-export type SlotSizeVec = (number | null)[];
-
 export type SpeedGroup = "A" | "B1" | "B2" | "C";
 
+export type GearVecInput = GearInput[];
+
+export interface GearInput {
+  gear_id: number;
+  types: GearTypeIdArray;
+  firepower: number;
+  torpedo: number;
+  anti_air: number;
+  armor: number;
+  evasion: number;
+  asw: number;
+  los: number;
+  bombing: number;
+  accuracy: number;
+  range: number;
+  radius: number;
+  stars: number;
+  ace: number;
+}
+
+export interface ShipInput {
+  ship_id: number;
+  ctype: number;
+  stype: number;
+  yomi: string;
+}
+
+export interface EBonuses {
+  firepower: number;
+  torpedo: number;
+  anti_air: number;
+  armor: number;
+  evasion: number;
+  asw: number;
+  los: number;
+  bombing: number;
+  accuracy: number;
+  range: number;
+}
+
 export interface MasterShip {
   ship_id: number;
   name: string;
@@ -768,18 +925,6 @@ export interface MasterShip {
 
 export type StatInterval = [number | null, number | null];
 
-export interface AttackAnalysis {
-  attacker_is_player: boolean;
-  attacker_ship_id: number;
-  target_ship_id: number;
-  historical_params: HistoricalParams;
-  day: ActionReport<DayPhaseAttackStyle>;
-  night: ActionReport<NightPhaseAttackStyle>;
-  closing_torpedo: ActionReport<TorpedoAttackStyle>;
-  opening_asw: ActionReport<AswAttackStyle>;
-  support_shelling: ActionReport<SupportShellingStyle>;
-}
-
 export type DayCutin =
   | "Zuiun"
   | "AirSea"
@@ -841,84 +986,6 @@ export interface GearVecState {
   gx?: GearState;
 }
 
-export type GearType =
-  | "Unknown"
-  | "SmallMainGun"
-  | "MediumMainGun"
-  | "LargeMainGun"
-  | "SecondaryGun"
-  | "Torpedo"
-  | "CbFighter"
-  | "CbDiveBomber"
-  | "CbTorpedoBomber"
-  | "CbRecon"
-  | "ReconSeaplane"
-  | "SeaplaneBomber"
-  | "SmallRadar"
-  | "LargeRadar"
-  | "Sonar"
-  | "DepthCharge"
-  | "ExtraArmor"
-  | "Engine"
-  | "AntiAirShell"
-  | "ApShell"
-  | "VtFuze"
-  | "AntiAirGun"
-  | "MidgetSubmarine"
-  | "EmergencyRepair"
-  | "LandingCraft"
-  | "Rotorcraft"
-  | "AntiSubPatrolAircraft"
-  | "MediumArmor"
-  | "LargeArmor"
-  | "Searchlight"
-  | "SupplyContainer"
-  | "ShipRepairFacility"
-  | "SubmarineTorpedo"
-  | "Starshell"
-  | "CommandFacility"
-  | "AviationPersonnel"
-  | "AntiAirFireDirector"
-  | "AntiGroundEquipment"
-  | "LargeMainGun2"
-  | "ShipPersonnel"
-  | "LargeSonar"
-  | "LargeFlyingBoat"
-  | "LargeSearchlight"
-  | "CombatRation"
-  | "Supplies"
-  | "SeaplaneFighter"
-  | "AmphibiousTank"
-  | "LbAttacker"
-  | "LbFighter"
-  | "LbRecon"
-  | "TransportationMaterial"
-  | "SubmarineEquipment"
-  | "LandingForce"
-  | "LargeLbAircraft"
-  | "SurfaceEquipment"
-  | "JetFighter"
-  | "JetFighterBomber"
-  | "JetTorpedoBomber"
-  | "JetRecon"
-  | "LargeRadar2"
-  | "CbRecon2"
-  | "SecondaryGun2";
-
-export type GearCategory =
-  | "Fighter"
-  | "Bomber"
-  | "Recon"
-  | "MainGun"
-  | "Secondary"
-  | "Torpedo"
-  | "AntiSub"
-  | "Radar"
-  | "Landing"
-  | "Ration"
-  | "LandBased"
-  | "Misc";
-
 export type ShipAttr =
   | "Unknown"
   | "NightCarrier"
@@ -940,108 +1007,41 @@ export type ShipAttr =
   | "DockPrincess"
   | "SummerAircraftCarrierDemon";
 
-export type ShipCategory =
-  | "Battleship"
-  | "AircraftCarrier"
-  | "HeavyCruiser"
-  | "LightCruiser"
-  | "Destroyer"
-  | "CoastalDefenseShip"
-  | "Submarine"
-  | "AuxiliaryShip";
-
-export type ShipType =
-  | "Unknown"
-  | "DE"
-  | "DD"
-  | "CL"
-  | "CLT"
-  | "CA"
-  | "CAV"
-  | "CVL"
-  | "FBB"
-  | "BB"
-  | "BBV"
-  | "CV"
-  | "XBB"
-  | "SS"
-  | "SSV"
-  | "AP"
-  | "AV"
-  | "LHA"
-  | "CVB"
-  | "AR"
-  | "AS"
-  | "CT"
-  | "AO";
-
-export type GearTypeIdArray = [number, number, number, number, number];
-
-export type GearVecInput = GearInput[];
-
-export interface GearInput {
-  gear_id: number;
-  types: GearTypeIdArray;
-  firepower: number;
-  torpedo: number;
-  anti_air: number;
-  armor: number;
-  evasion: number;
-  asw: number;
-  los: number;
-  bombing: number;
-  accuracy: number;
-  range: number;
-  radius: number;
-  stars: number;
-  ace: number;
+export interface CompAnalyzerConfig {
+  engagement: Engagement;
+  formation: Formation;
+  anti_air_cutin: number | null;
+  ship_anti_air_resist: number;
+  fleet_anti_air_resist: number;
+  left_night_fleet_conditions: NightFleetConditions;
+  right_night_fleet_conditions: NightFleetConditions;
 }
 
-export interface ShipInput {
-  ship_id: number;
-  ctype: number;
-  stype: number;
-  yomi: string;
+export interface CompNightAnalysis {
+  night_cutin: CompNightCutinAnalysis;
+  fleet_cutin: FleetCutinReport<NightAttackStyle>[];
 }
 
-export interface EBonuses {
-  firepower: number;
-  torpedo: number;
-  anti_air: number;
-  armor: number;
-  evasion: number;
-  asw: number;
-  los: number;
-  bombing: number;
-  accuracy: number;
-  range: number;
+export interface CompDayAnalysis {
+  day_cutin: CompDayCutinAnalysis;
+  fleet_cutin: FleetCutinReport<ShellingStyle>[];
 }
 
-export interface FleetCutinReport<T> {
-  cutin: FleetCutin;
-  rate: number | null;
-  formation: Formation;
-  attacks: FleetCutinAttackReport<T>[];
+export interface CompAnalysis {
+  day: CompDayAnalysis;
+  night: CompNightAnalysis;
+  contact: ContactAnalysis;
+  anti_air: CompAntiAirAnalysis;
 }
 
-export interface FleetCutinAttackReport<T> extends AttackReport<T> {
-  index: number;
-  ship_id: number;
-  power_mod: number;
-}
+export type AirState =
+  | "AirSupremacy"
+  | "AirSuperiority"
+  | "AirParity"
+  | "AirDenial"
+  | "AirIncapability";
 
-export interface DamageReport {
-  miss_damage_min: number;
-  miss_damage_max: number;
-  normal_damage_min: number;
-  normal_damage_max: number;
-  critical_damage_min: number;
-  critical_damage_max: number;
-  normal_scratch_rate: number;
-  critical_scratch_rate: number;
-  damage_density: Histogram<number, number>;
-  damage_state_density: Histogram<DamageState, number>;
-}
+export type AirStateRank = "Rank0" | "Rank1" | "Rank2" | "Rank3";
 
 /**
  */