fleethub-core 1.12.12 → 1.12.13

package/node/fleethub_core.d.ts

@@ -52,6 +52,11 @@ export interface MasterGear {
   historical_aircraft_group?: number;
 }
 
+export interface MasterIBonusRule {
+  expr: CompiledEvaler;
+  formula: CompiledEvaler;
+}
+
 export interface MasterIBonuses {
   shelling_power: MasterIBonusRule[];
   shelling_accuracy: MasterIBonusRule[];
@@ -72,11 +77,6 @@ export interface MasterIBonuses {
   elos: MasterIBonusRule[];
 }
 
-export interface MasterIBonusRule {
-  expr: CompiledEvaler;
-  formula: CompiledEvaler;
-}
-
 export interface MasterBattleDefinitions {
   formation: NestedFormationDef[];
   anti_air_cutin: AntiAirCutinDef[];
@@ -155,12 +155,18 @@ export interface SlotSizeVecState {
   ss5?: number;
 }
 
+export type AirSquadronMode = "Sortie" | "AirDefense";
+
 export interface AirSquadronState extends GearVecState, SlotSizeVecState {
   id?: string;
   mode?: AirSquadronMode;
 }
 
-export type AirSquadronMode = "Sortie" | "AirDefense";
+export interface FleetMeta {
+  id: string;
+  len: number;
+  ships: [string, ShipMeta | null][];
+}
 
 export interface ShipMeta {
   id: string;
@@ -171,15 +177,16 @@ export interface CompMeta {
   fleets: Record<FleetType, FleetMeta>;
 }
 
-export interface FleetMeta {
-  id: string;
-  len: number;
-  ships: [string, ShipMeta | null][];
-}
+export type Side = "Player" | "Enemy";
 
 export type Align = "Left" | "Right";
 
-export type Side = "Player" | "Enemy";
+export interface ShipInput {
+  ship_id: number;
+  ctype: number;
+  stype: number;
+  yomi: string;
+}
 
 export interface GearInput {
   gear_id: number;
@@ -199,13 +206,6 @@ export interface GearInput {
   ace: number;
 }
 
-export interface ShipInput {
-  ship_id: number;
-  ctype: number;
-  stype: number;
-  yomi: string;
-}
-
 export type GearVecInput = GearInput[];
 
 export interface EBonuses {
@@ -299,8 +299,6 @@ export type GearType =
   | "CbRecon2"
   | "SecondaryGun2";
 
-export type FleetKey = "f1" | "f2" | "f3" | "f4";
-
 export interface OrgState {
   id?: string;
   f1?: FleetState;
@@ -317,18 +315,13 @@ export interface OrgState {
   boss_sup?: FleetKey;
 }
 
+export type FleetKey = "f1" | "f2" | "f3" | "f4";
+
 export interface CompDayAnalysis {
   day_cutin: CompDayCutinAnalysis;
   fleet_cutin: FleetCutinReport<ShellingStyle>[];
 }
 
-export interface CompAnalysis {
-  day: CompDayAnalysis;
-  night: CompNightAnalysis;
-  contact: ContactAnalysis;
-  anti_air: CompAntiAirAnalysis;
-}
-
 export interface CompNightAnalysis {
   night_cutin: CompNightCutinAnalysis;
   fleet_cutin: FleetCutinReport<NightAttackStyle>[];
@@ -344,6 +337,13 @@ export interface CompAnalyzerConfig {
   right_night_fleet_conditions: NightFleetConditions;
 }
 
+export interface CompAnalysis {
+  day: CompDayAnalysis;
+  night: CompNightAnalysis;
+  contact: ContactAnalysis;
+  anti_air: CompAntiAirAnalysis;
+}
+
 export interface ShipAnalyzerConfig {
   air_state?: AirState;
   engagement?: Engagement;
@@ -358,11 +358,6 @@ export interface AttackAnalyzerShipConfig
   fleet_los_mod?: number | null;
 }
 
-export interface SimulatorResult {
-  items: SimulatorResultItem[];
-  sunk_vec: [number, number, number][];
-}
-
 export interface SimulatorResultItem {
   id: string;
   fleet_type: FleetType;
@@ -370,6 +365,11 @@ export interface SimulatorResultItem {
   damage_state_map: Record<DamageState, number>;
 }
 
+export interface SimulatorResult {
+  items: SimulatorResultItem[];
+  sunk_vec: [number, number, number][];
+}
+
 export type SpeedGroup = "A" | "B1" | "B2" | "C";
 
 export interface SupportShellingSimulatorParams {
@@ -379,24 +379,12 @@ export interface SupportShellingSimulatorParams {
   node_state: NodeState;
 }
 
-export type NightAttackType = "Normal" | "Swordfish" | "Aerial";
+export type TorpedoAttackType = null;
 
 export type SupportShellingType = ShellingType;
 
-export type ShellingType = "Normal" | "Aerial";
-
-export type NightPhaseAttackType =
-  | { t: "Night"; c: NightAttackType }
-  | { t: "Asw"; c: AswAttackType };
-
 export type AswAttackType = "DepthCharge" | "Aerial";
 
-export type TorpedoAttackType = null;
-
-export type DayPhaseAttackType =
-  | { t: "Shelling"; c: ShellingType }
-  | { t: "Asw"; c: AswAttackType };
-
 export type AttackType =
   | { t: "Asw"; c: AswAttackType }
   | { t: "Shelling"; c: ShellingType }
@@ -404,6 +392,18 @@ export type AttackType =
   | { t: "Torpedo" }
   | { t: "SupportShelling"; c: SupportShellingType };
 
+export type DayPhaseAttackType =
+  | { t: "Shelling"; c: ShellingType }
+  | { t: "Asw"; c: AswAttackType };
+
+export type NightAttackType = "Normal" | "Swordfish" | "Aerial";
+
+export type ShellingType = "Normal" | "Aerial";
+
+export type NightPhaseAttackType =
+  | { t: "Night"; c: NightAttackType }
+  | { t: "Asw"; c: AswAttackType };
+
 export type SlotSizeVec = (number | null)[];
 
 export type GearTypeIdArray = [number, number, number, number, number];
@@ -427,8 +427,6 @@ export type SpecialEnemyType =
 
 export type Role = "Main" | "Escort";
 
-export type NightCutinLike = NightCutin | FleetCutin;
-
 export type FleetCutin =
   | "NelsonTouch"
   | "NagatoClassCutin"
@@ -460,6 +458,10 @@ export type NightCutin =
   | "Cvci1_18"
   | "Photobomber";
 
+export type NightCutinLike = NightCutin | FleetCutin;
+
+export type DayCutinLike = DayCutin | FleetCutin;
+
 export type DayCutin =
   | "Zuiun"
   | "AirSea"
@@ -472,7 +474,15 @@ export type DayCutin =
   | "BBA"
   | "BA";
 
-export type DayCutinLike = DayCutin | FleetCutin;
+export type ShipCategory =
+  | "Battleship"
+  | "AircraftCarrier"
+  | "HeavyCruiser"
+  | "LightCruiser"
+  | "Destroyer"
+  | "CoastalDefenseShip"
+  | "Submarine"
+  | "AuxiliaryShip";
 
 export type ShipType =
   | "Unknown"
@@ -499,15 +509,11 @@ export type ShipType =
   | "CT"
   | "AO";
 
-export type ShipCategory =
-  | "Battleship"
-  | "AircraftCarrier"
-  | "HeavyCruiser"
-  | "LightCruiser"
-  | "Destroyer"
-  | "CoastalDefenseShip"
-  | "Submarine"
-  | "AuxiliaryShip";
+export interface HitRate {
+  normal: number;
+  critical: number;
+  total: number;
+}
 
 export interface HitRateParams {
   accuracy_term: number;
@@ -518,12 +524,6 @@ export interface HitRateParams {
   hit_percentage_bonus: number;
 }
 
-export interface HitRate {
-  normal: number;
-  critical: number;
-  total: number;
-}
-
 export type FhResult<T> = { Ok: T } | { Err: string };
 
 export interface DamageReport {
@@ -539,8 +539,12 @@ export interface DamageReport {
   damage_state_density: Histogram<DamageState, number>;
 }
 
-export interface DayCutinReport extends ActionReport<DayPhaseAttackStyle> {
-  observation_term: number | null;
+export interface ShipDayCutinAnalysis {
+  ship_id: number;
+  role: Role;
+  index: number;
+  rank3: DayCutinReport;
+  rank2: DayCutinReport;
 }
 
 export interface CompDayCutinAnalysis {
@@ -551,17 +555,8 @@ export interface CompDayCutinAnalysis {
   ships: ShipDayCutinAnalysis[];
 }
 
-export interface ShipDayCutinAnalysis {
-  ship_id: number;
-  role: Role;
-  index: number;
-  rank3: DayCutinReport;
-  rank2: DayCutinReport;
-}
-
-export interface NightCutinActionReport
-  extends ActionReport<NightPhaseAttackStyle> {
-  cutin_term: number | null;
+export interface DayCutinReport extends ActionReport<DayPhaseAttackStyle> {
+  observation_term: number | null;
 }
 
 export interface NightContactChance {
@@ -570,6 +565,11 @@ export interface NightContactChance {
   rank3: number;
 }
 
+export interface NightCutinActionReport
+  extends ActionReport<NightPhaseAttackStyle> {
+  cutin_term: number | null;
+}
+
 export interface ShipNightCutinAnalysis {
   ship_id: number;
   index: number;
@@ -588,25 +588,14 @@ export type DamageState = "Normal" | "Shouha" | "Chuuha" | "Taiha" | "Sunk";
 
 export type MoraleState = "Sparkle" | "Normal" | "Orange" | "Red";
 
-export interface NightCutinDef {
-  tag: NightCutin;
-  hits: number;
-  type_factor: number | null;
-  power_mod: number | null;
-  accuracy_mod: number | null;
-}
-
-export interface HistoricalParams {
-  power_mod: AttackPowerModifier;
-  armor_penetration: number;
-  accuracy_mod: number;
-  target_evasion_mod: number;
+export interface BattleDefinitions {
+  formation: Record<Formation, NestedFormationDef>;
+  anti_air_cutin: Record<number, AntiAirCutinDef>;
+  day_cutin: Record<DayCutin, DayCutinDef>;
+  night_cutin: Record<NightCutin, NightCutinDef>;
+  historical_bonuses: HistoricalBonusDef[];
 }
 
-export type NestedFormationDef =
-  | FormationDef
-  | { top_half: FormationDef; bottom_half: FormationDef };
-
 export interface AntiAirCutinDef {
   id: number;
   type_factor: number | null;
@@ -615,28 +604,19 @@ export interface AntiAirCutinDef {
   sequential: boolean | null;
 }
 
-export interface DayCutinDef {
-  tag: DayCutin;
-  hits: number;
-  type_factor: number | null;
-  power_mod: number | null;
-  accuracy_mod: number | null;
-}
-
-export interface FormationCombatModifiersDef {
-  power_mod?: number;
+export interface HistoricalBonusDef {
+  map?: number;
+  node?: CompiledEvaler;
+  phase?: number;
+  debuff?: boolean;
+  ship?: CompiledEvaler;
+  enemy?: CompiledEvaler;
+  power_mod?: AttackPowerModifier;
+  armor_penetration?: number;
   accuracy_mod?: number;
   evasion_mod?: number;
 }
 
-export interface BattleDefinitions {
-  formation: Record<Formation, NestedFormationDef>;
-  anti_air_cutin: Record<number, AntiAirCutinDef>;
-  day_cutin: Record<DayCutin, DayCutinDef>;
-  night_cutin: Record<NightCutin, NightCutinDef>;
-  historical_bonuses: HistoricalBonusDef[];
-}
-
 export interface FormationDef {
   tag: Formation;
   protection_rate: number | null;
@@ -648,15 +628,35 @@ export interface FormationDef {
   support_shelling: FormationCombatModifiersDef;
 }
 
-export interface HistoricalBonusDef {
-  map?: number;
-  node?: CompiledEvaler;
-  phase?: number;
-  debuff?: boolean;
-  ship?: CompiledEvaler;
-  enemy?: CompiledEvaler;
-  power_mod?: AttackPowerModifier;
-  armor_penetration?: number;
+export interface DayCutinDef {
+  tag: DayCutin;
+  hits: number;
+  type_factor: number | null;
+  power_mod: number | null;
+  accuracy_mod: number | null;
+}
+
+export type NestedFormationDef =
+  | FormationDef
+  | { top_half: FormationDef; bottom_half: FormationDef };
+
+export interface NightCutinDef {
+  tag: NightCutin;
+  hits: number;
+  type_factor: number | null;
+  power_mod: number | null;
+  accuracy_mod: number | null;
+}
+
+export interface HistoricalParams {
+  power_mod: AttackPowerModifier;
+  armor_penetration: number;
+  accuracy_mod: number;
+  target_evasion_mod: number;
+}
+
+export interface FormationCombatModifiersDef {
+  power_mod?: number;
   accuracy_mod?: number;
   evasion_mod?: number;
 }
@@ -666,6 +666,13 @@ export interface AttackPowerModifier {
   b?: number;
 }
 
+export interface CustomPowerModifiers {
+  precap_mod?: AttackPowerModifier;
+  postcap_mod?: AttackPowerModifier;
+  basic_power_mod?: AttackPowerModifier;
+  historical_mod?: AttackPowerModifier;
+}
+
 export interface SpecialEnemyModifiers {
   precap_general_mod: AttackPowerModifier;
   stype_mod: AttackPowerModifier;
@@ -681,13 +688,6 @@ export interface SpecialEnemyModifiers {
   pt_mod: AttackPowerModifier | null;
 }
 
-export interface CustomPowerModifiers {
-  precap_mod?: AttackPowerModifier;
-  postcap_mod?: AttackPowerModifier;
-  basic_power_mod?: AttackPowerModifier;
-  historical_mod?: AttackPowerModifier;
-}
-
 export type OrgType =
   | "Single"
   | "CarrierTaskForce"
@@ -696,6 +696,8 @@ export type OrgType =
   | "EnemySingle"
   | "EnemyCombined";
 
+export type AirStateRank = "Rank0" | "Rank1" | "Rank2" | "Rank3";
+
 export type AirState =
   | "AirSupremacy"
   | "AirSuperiority"
@@ -703,7 +705,13 @@ export type AirState =
   | "AirDenial"
   | "AirIncapability";
 
-export type AirStateRank = "Rank0" | "Rank1" | "Rank2" | "Rank3";
+export type CombinedFormation =
+  | "Cruising1"
+  | "Cruising2"
+  | "Cruising3"
+  | "Cruising4";
+
+export type Formation = SingleFormation | CombinedFormation;
 
 export type SingleFormation =
   | "LineAhead"
@@ -713,20 +721,6 @@ export type SingleFormation =
   | "LineAbreast"
   | "Vanguard";
 
-export type Formation = SingleFormation | CombinedFormation;
-
-export type CombinedFormation =
-  | "Cruising1"
-  | "Cruising2"
-  | "Cruising3"
-  | "Cruising4";
-
-export interface CompAntiAirAnalysis {
-  fleet_adjusted_anti_air: number;
-  ships: AntiAirReport[];
-  anti_air_cutin_chance: [number, number][];
-}
-
 export interface AntiAirReport {
   ship_id: number;
   role: Role;
@@ -739,10 +733,10 @@ export interface AntiAirReport {
   anti_air_propellant_barrage_chance: number | null;
 }
 
-export interface FleetCutinAttackReport<T> extends AttackReport<T> {
-  index: number;
-  ship_id: number;
-  power_mod: number;
+export interface CompAntiAirAnalysis {
+  fleet_adjusted_anti_air: number;
+  ships: AntiAirReport[];
+  anti_air_cutin_chance: [number, number][];
 }
 
 export interface FleetCutinReport<T> {
@@ -752,14 +746,10 @@ export interface FleetCutinReport<T> {
   attacks: FleetCutinAttackReport<T>[];
 }
 
-export interface AttackPower {
-  precap: number;
-  is_capped: boolean;
-  capped: number;
-  normal: number;
-  critical: number;
-  armor_penetration: number;
-  remaining_ammo_mod: number;
+export interface FleetCutinAttackReport<T> extends AttackReport<T> {
+  index: number;
+  ship_id: number;
+  power_mod: number;
 }
 
 export interface AttackPowerParams {
@@ -779,6 +769,16 @@ export interface AttackPowerParams {
   custom_mods: CustomPowerModifiers;
 }
 
+export interface AttackPower {
+  precap: number;
+  is_capped: boolean;
+  capped: number;
+  normal: number;
+  critical: number;
+  armor_penetration: number;
+  remaining_ammo_mod: number;
+}
+
 export interface AttackAnalysis {
   attacker_is_player: boolean;
   attacker_ship_id: number;
@@ -791,11 +791,6 @@ export interface AttackAnalysis {
   support_shelling: ActionReport<SupportShellingStyle>;
 }
 
-export interface ContactAnalysis {
-  single: DayContactChance[] | null;
-  combined: DayContactChance[] | null;
-}
-
 export interface DayContactChance {
   air_state: AirState;
   trigger_rate: number;
@@ -805,14 +800,9 @@ export interface DayContactChance {
   total: number;
 }
 
-export interface MasterData extends MasterBattleDefinitions {
-  created_at: number;
-  gears: MasterGear[];
-  gear_attrs: MasterAttrRule<GearAttr>[];
-  ships: MasterShip[];
-  ship_attrs: MasterAttrRule<ShipAttr>[];
-  ibonuses: MasterIBonuses;
-  equippability: MasterEquippability;
+export interface ContactAnalysis {
+  single: DayContactChance[] | null;
+  combined: DayContactChance[] | null;
 }
 
 export interface MasterAttrRule<T> {
@@ -826,8 +816,23 @@ export interface NationalityDef {
   ctypes: number[];
 }
 
+export interface MasterData extends MasterBattleDefinitions {
+  created_at: number;
+  gears: MasterGear[];
+  gear_attrs: MasterAttrRule<GearAttr>[];
+  ships: MasterShip[];
+  ship_attrs: MasterAttrRule<ShipAttr>[];
+  ibonuses: MasterIBonuses;
+  equippability: MasterEquippability;
+}
+
 export type CompiledEvaler = string;
 
+export interface NightConditions {
+  player?: NightFleetConditions;
+  enemy?: NightFleetConditions;
+}
+
 export interface BattleConditions {
   org_type: OrgType;
   role: Role;
@@ -838,11 +843,6 @@ export interface BattleConditions {
   night_conditions: NightFleetConditions;
 }
 
-export interface NightConditions {
-  player?: NightFleetConditions;
-  enemy?: NightFleetConditions;
-}
-
 export interface NightFleetConditions {
   night_contact_rank?: ContactRank | null;
   starshell_index?: number | null;
@@ -888,6 +888,8 @@ export type GearAttr =
   | "SemiNightPlane"
   | "HighAltitudeInterceptor";
 
+export type StatInterval = [number | null, number | null];
+
 export interface MasterShip {
   ship_id: number;
   name: string;
@@ -920,8 +922,6 @@ export interface MasterShip {
   useful?: boolean;
 }
 
-export type StatInterval = [number | null, number | null];
-
 export interface GearVecState {
   g1?: GearState;
   g2?: GearState;
@@ -938,6 +938,11 @@ export interface GearState {
   stars?: number;
 }
 
+export interface TorpedoAttackStyle {
+  tag: "TorpedoAttackStyle";
+  attack_type: TorpedoAttackType;
+}
+
 export interface ShellingStyle {
   tag: "ShellingStyle";
   attack_type: ShellingType;
@@ -947,6 +952,8 @@ export interface ShellingStyle {
   hits: number;
 }
 
+export type DayPhaseAttackStyle = ShellingStyle | AswAttackStyle;
+
 export interface AswAttackStyle {
   tag: "AswAttackStyle";
   attack_type: AswAttackType;
@@ -961,20 +968,13 @@ export interface NightAttackStyle {
   hits: number;
 }
 
+export type NightPhaseAttackStyle = NightAttackStyle | AswAttackStyle;
+
 export interface SupportShellingStyle {
   tag: "SupportShellingStyle";
   attack_type: SupportShellingType;
 }
 
-export interface TorpedoAttackStyle {
-  tag: "TorpedoAttackStyle";
-  attack_type: TorpedoAttackType;
-}
-
-export type NightPhaseAttackStyle = NightAttackStyle | AswAttackStyle;
-
-export type DayPhaseAttackStyle = ShellingStyle | AswAttackStyle;
-
 export interface ShipConditions extends ShipPosition {
   formation?: Formation;
   amagiri_index?: number | null;
@@ -984,13 +984,6 @@ export interface NodeAttackAnalyzerShipConfig extends NightFleetConditions {
   formation?: Formation;
 }
 
-export interface NodeAttackAnalysis {
-  left: AttackAnalysis;
-  right: AttackAnalysis;
-  shelling_fleet_cutin: FleetCutinReport<ShellingStyle>[];
-  night_fleet_cutin: FleetCutinReport<NightAttackStyle>[];
-}
-
 export interface NodeAttackAnalyzerConfig {
   air_state?: AirState;
   engagement?: Engagement;
@@ -999,6 +992,13 @@ export interface NodeAttackAnalyzerConfig {
   right?: NodeAttackAnalyzerShipConfig;
 }
 
+export interface NodeAttackAnalysis {
+  left: AttackAnalysis;
+  right: AttackAnalysis;
+  shelling_fleet_cutin: FleetCutinReport<ShellingStyle>[];
+  night_fleet_cutin: FleetCutinReport<NightAttackStyle>[];
+}
+
 export interface MasterEquippability {
   equip_stype: MstStype[];
   equip_exslot: number[];
@@ -1007,9 +1007,16 @@ export interface MasterEquippability {
   rules: EquippabilityRule[];
 }
 
-export interface MstStype {
-  api_id: number;
-  api_equip_type: Record<number, number>;
+export type MstEquipShipValue = null | number[];
+
+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_equip_type: Record<number, MstEquipShipValue>;
 }
 
 export interface EquippabilityRule {
@@ -1019,20 +1026,11 @@ export interface EquippabilityRule {
   exclude?: string;
 }
 
-export interface MstEquipShip {
-  api_equip_type: Record<number, MstEquipShipValue>;
-}
-
-export interface MstEquipExslotShip {
-  api_ctypes: Record<number, number> | null;
-  api_ship_ids: Record<number, number> | null;
-  api_stypes: Record<number, number> | null;
+export interface MstStype {
+  api_id: number;
+  api_equip_type: Record<number, number>;
 }
 
-export type MstEquipShipValue = null | number[];
-
-export type NodeId = string;
-
 export interface NodeState {
   map?: number;
   node?: NodeId;
@@ -1042,6 +1040,8 @@ export interface NodeState {
   landing_battle?: boolean;
 }
 
+export type NodeId = string;
+
 export type ContactRank = "Rank1" | "Rank2" | "Rank3";
 
 export class AirSquadron {