fleethub-core 1.9.1 → 1.10.0

package/node/fleethub_core.d.ts

@@ -8,6 +8,44 @@ export function parse_ship_conditions(value: ShipConditions): ShipConditions;
 /**
  */
 export function set_panic_hook(): void;
+export type ShipKey = "s1" | "s2" | "s3" | "s4" | "s5" | "s6" | "s7";
+
+export interface ShipConditions extends ShipPosition {
+  formation?: Formation;
+  amagiri_index?: number | null;
+}
+
+export interface ShipPosition {
+  org_type?: OrgType;
+  fleet_type?: FleetType;
+  fleet_len?: number;
+  index?: number;
+}
+
+export interface NodeState {
+  map?: number;
+  node?: NodeId;
+  phase?: number;
+  debuff?: boolean;
+}
+
+export type NodeId = string;
+
+export interface CompMeta {
+  fleets: Record<FleetType, FleetMeta>;
+}
+
+export interface FleetMeta {
+  id: string;
+  len: number;
+  ships: [string, ShipMeta | null][];
+}
+
+export interface ShipMeta {
+  id: string;
+  ship_id: number;
+}
+
 export type GearCategory =
   | "Fighter"
   | "Bomber"
@@ -86,57 +124,30 @@ export type GearType =
 
 export type DamageState = "Normal" | "Shouha" | "Chuuha" | "Taiha" | "Sunk";
 
-export interface BattleDefinitions {
-  formation: Record<Formation, NestedFormationDef>;
-  anti_air_cutin: Record<number, AntiAirCutinDef>;
-  day_cutin: Record<DayCutin, DayCutinDef>;
-  night_cutin: Record<NightCutin, NightCutinDef>;
-}
+export type TorpedoAttackType = null;
 
-export interface NightCutinDef {
-  tag: NightCutin;
-  hits: number;
-  type_factor: number | null;
-  power_mod: number | null;
-  accuracy_mod: number | null;
-}
+export type NightPhaseAttackType =
+  | { t: "Night"; c: NightAttackType }
+  | { t: "Asw"; c: AswAttackType };
 
-export interface DayCutinDef {
-  tag: DayCutin;
-  hits: number;
-  type_factor: number | null;
-  power_mod: number | null;
-  accuracy_mod: number | null;
-}
+export type DayPhaseAttackType =
+  | { t: "Shelling"; c: ShellingType }
+  | { t: "Asw"; c: AswAttackType };
 
-export interface AntiAirCutinDef {
-  id: number;
-  type_factor: number | null;
-  multiplier: number | null;
-  guaranteed: number | null;
-  sequential: boolean | null;
-}
+export type AttackType =
+  | { t: "Asw"; c: AswAttackType }
+  | { t: "Shelling"; c: ShellingType }
+  | { t: "Night"; c: NightAttackType }
+  | { t: "Torpedo" }
+  | { t: "SupportShelling"; c: SupportShellingType };
 
-export type NestedFormationDef =
-  | FormationDef
-  | { top_half: FormationDef; bottom_half: FormationDef };
+export type SupportShellingType = ShellingType;
 
-export interface FormationDef {
-  tag: Formation;
-  protection_rate: number | null;
-  fleet_anti_air_mod: number;
-  shelling: FormationCombatModifiersDef;
-  torpedo: FormationCombatModifiersDef;
-  asw: FormationCombatModifiersDef;
-  night: FormationCombatModifiersDef;
-  support_shelling: FormationCombatModifiersDef;
-}
+export type NightAttackType = "Normal" | "Swordfish" | "Carrier";
 
-export interface FormationCombatModifiersDef {
-  power_mod?: number;
-  accuracy_mod?: number;
-  evasion_mod?: number;
-}
+export type ShellingType = "Normal" | "Carrier";
+
+export type AswAttackType = "DepthCharge" | "Aircraft";
 
 export type AirStateRank = "Rank0" | "Rank1" | "Rank2" | "Rank3";
 
@@ -154,7 +165,7 @@ export interface MasterData extends MasterBattleDefinitions {
   ships: MasterShip[];
   ship_attrs: MasterAttrRule<ShipAttr>[];
   ibonuses: MasterIBonuses;
-  equippable: MasterEquippability;
+  equippability: MasterEquippability;
 }
 
 export interface NationalityDef {
@@ -168,6 +179,85 @@ export interface MasterAttrRule<T> {
   expr: CompiledEvaler;
 }
 
+export type SpeedGroup = "A" | "B1" | "B2" | "C";
+
+export interface NightFleetConditions {
+  night_contact_rank?: ContactRank | null;
+  starshell_index?: number | null;
+  searchlight_index?: number | null;
+  activates_large_searchlight?: boolean;
+}
+
+export interface NightConditions {
+  player?: NightFleetConditions;
+  enemy?: NightFleetConditions;
+}
+
+export interface BattleConditions {
+  org_type: OrgType;
+  role: Role;
+  ship_index: number;
+  fleet_len: number;
+  formation: Formation;
+  fleet_los_mod: number | null;
+  night_conditions: NightFleetConditions;
+}
+
+export interface MasterGear {
+  gear_id: number;
+  name: string;
+  types: GearTypeIdArray;
+  special_type?: number;
+  max_hp?: number;
+  firepower?: number;
+  armor?: number;
+  torpedo?: number;
+  anti_air?: number;
+  speed?: number;
+  bombing?: number;
+  asw?: number;
+  los?: number;
+  luck?: number;
+  accuracy?: number;
+  evasion?: number;
+  range?: number;
+  radius?: number;
+  cost?: number;
+  improvable?: boolean;
+  ship_anti_air_resist?: number;
+  fleet_anti_air_resist?: number;
+}
+
+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: MstEquipExslotShip[];
+  rules: EquippabilityRule[];
+}
+
+export interface MstEquipExslotShip {
+  api_slotitem_id: number;
+  api_ship_ids: number[];
+}
+
+export interface MstEquipShip {
+  api_ship_id: number;
+  api_equip_type: number[];
+}
+
+export interface EquipStype {
+  id: number;
+  equip_type: number[];
+}
+
 export interface OrgState {
   id?: string;
   f1?: FleetState;
@@ -293,6 +383,7 @@ export interface NodeAttackAnalyzerShipConfig extends NightFleetConditions {
 export interface NodeAttackAnalyzerConfig {
   air_state?: AirState;
   engagement?: Engagement;
+  node_state?: NodeState;
   left?: NodeAttackAnalyzerShipConfig;
   right?: NodeAttackAnalyzerShipConfig;
 }
@@ -320,6 +411,22 @@ export type Role = "Main" | "Escort";
 
 export type MoraleState = "Sparkle" | "Normal" | "Orange" | "Red";
 
+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 MoveShipPayload {
+  current: [string, string, ShipKey];
+  target: [string | null, string, ShipKey];
+}
+
 export type NightCutinLike = NightCutin | FleetCutin;
 
 export type DayCutinLike = DayCutin | FleetCutin;
@@ -361,21 +468,7 @@ export type DayCutin =
   | "BBA"
   | "BA";
 
-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 MoveShipPayload {
-  current: [string, string, ShipKey];
-  target: [string | null, string, ShipKey];
-}
+export type ContactRank = "Rank1" | "Rank2" | "Rank3";
 
 export type AirWaveType = "Jet" | "LandBase" | "Carrier";
 
@@ -416,36 +509,103 @@ export interface MasterIBonusRule {
   formula: CompiledEvaler;
 }
 
-export type ShipKey = "s1" | "s2" | "s3" | "s4" | "s5" | "s6" | "s7";
+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 ShipConditions extends ShipPosition {
-  formation?: Formation;
-  amagiri_index?: number | null;
+export interface NightCutinDef {
+  tag: NightCutin;
+  hits: number;
+  type_factor: number | null;
+  power_mod: number | null;
+  accuracy_mod: number | null;
 }
 
-export type ContactRank = "Rank1" | "Rank2" | "Rank3";
+export interface HistoricalBonusDef {
+  map?: number;
+  node?: NodeId;
+  phase?: number;
+  debuff?: boolean;
+  ship?: CompiledEvaler;
+  enemy?: CompiledEvaler;
+  power_mod?: number;
+  accuracy_mod?: number;
+  evasion_mod?: number;
+}
 
-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 DayCutinDef {
+  tag: DayCutin;
+  hits: number;
+  type_factor: number | null;
+  power_mod: number | null;
+  accuracy_mod: number | null;
 }
 
-export interface ShipInput {
-  ship_id: number;
-  ctype: number;
-  stype: number;
-  yomi: string;
+export interface AntiAirCutinDef {
+  id: number;
+  type_factor: number | null;
+  multiplier: number | null;
+  guaranteed: number | null;
+  sequential: boolean | null;
 }
 
-export interface GearInput {
+export type NestedFormationDef =
+  | FormationDef
+  | { top_half: FormationDef; bottom_half: FormationDef };
+
+export interface FormationDef {
+  tag: Formation;
+  protection_rate: number | null;
+  fleet_anti_air_mod: number;
+  shelling: FormationCombatModifiersDef;
+  torpedo: FormationCombatModifiersDef;
+  asw: FormationCombatModifiersDef;
+  night: FormationCombatModifiersDef;
+  support_shelling: FormationCombatModifiersDef;
+}
+
+export interface FormationCombatModifiersDef {
+  power_mod?: number;
+  accuracy_mod?: number;
+  evasion_mod?: number;
+}
+
+export type Engagement = "GreenT" | "Parallel" | "HeadOn" | "RedT";
+
+export type FhResult<T> = { Ok: T } | { Err: string };
+
+export interface ShipAnalyzerConfig {
+  air_state?: AirState;
+  engagement?: Engagement;
+  left?: AttackAnalyzerShipConfig;
+  right?: AttackAnalyzerShipConfig;
+}
+
+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 ShipInput {
+  ship_id: number;
+  ctype: number;
+  stype: number;
+  yomi: string;
+}
+
+export interface GearInput {
   gear_id: number;
   types: GearTypeIdArray;
   firepower: number;
@@ -465,64 +625,6 @@ export interface GearInput {
 
 export type GearVecInput = GearInput[];
 
-export interface ShipPosition {
-  org_type?: OrgType;
-  fleet_type?: FleetType;
-  fleet_len?: number;
-  index?: number;
-}
-
-export interface CompMeta {
-  fleets: Record<FleetType, FleetMeta>;
-}
-
-export interface FleetMeta {
-  id: string;
-  len: number;
-  ships: [string, ShipMeta | null][];
-}
-
-export interface ShipMeta {
-  id: string;
-  ship_id: number;
-}
-
-export type Engagement = "GreenT" | "Parallel" | "HeadOn" | "RedT";
-
-export type TorpedoAttackType = null;
-
-export type NightPhaseAttackType =
-  | { t: "Night"; c: NightAttackType }
-  | { t: "Asw"; c: AswAttackType };
-
-export type DayPhaseAttackType =
-  | { t: "Shelling"; c: ShellingType }
-  | { t: "Asw"; c: AswAttackType };
-
-export type AttackType =
-  | { t: "Asw"; c: AswAttackType }
-  | { t: "Shelling"; c: ShellingType }
-  | { t: "Night"; c: NightAttackType }
-  | { t: "Torpedo" }
-  | { t: "SupportShelling"; c: SupportShellingType };
-
-export type SupportShellingType = ShellingType;
-
-export type NightAttackType = "Normal" | "Swordfish" | "Carrier";
-
-export type ShellingType = "Normal" | "Carrier";
-
-export type AswAttackType = "DepthCharge" | "Aircraft";
-
-export type FhResult<T> = { Ok: T } | { Err: string };
-
-export interface ShipAnalyzerConfig {
-  air_state?: AirState;
-  engagement?: Engagement;
-  left?: AttackAnalyzerShipConfig;
-  right?: AttackAnalyzerShipConfig;
-}
-
 export type ShipAttr =
   | "Unknown"
   | "Abyssal"
@@ -588,6 +690,57 @@ export interface SupportShellingSimulatorParams {
   engagement: Engagement;
 }
 
+export interface MasterBattleDefinitions {
+  formation: NestedFormationDef[];
+  anti_air_cutin: AntiAirCutinDef[];
+  day_cutin: DayCutinDef[];
+  night_cutin: NightCutinDef[];
+  historical_bonuses?: HistoricalBonusDef[];
+}
+
+export interface AttackAnalyzerShipConfig
+  extends ShipConditions,
+    NightFleetConditions {
+  fleet_los_mod?: number | null;
+}
+
+export interface SupportShellingStyle {
+  tag: "SupportShellingStyle";
+  attack_type: SupportShellingType;
+}
+
+export type NightPhaseAttackStyle = NightAttackStyle | AswAttackStyle;
+
+export type DayPhaseAttackStyle = ShellingStyle | AswAttackStyle;
+
+export interface TorpedoAttackStyle {
+  tag: "TorpedoAttackStyle";
+  attack_type: TorpedoAttackType;
+}
+
+export interface AswAttackStyle {
+  tag: "AswAttackStyle";
+  attack_type: AswAttackType;
+}
+
+export interface NightAttackStyle {
+  tag: "NightAttackStyle";
+  attack_type: NightAttackType;
+  cutin: NightCutinLike | null;
+  power_mod: number;
+  accuracy_mod: number;
+  hits: number;
+}
+
+export interface ShellingStyle {
+  tag: "ShellingStyle";
+  attack_type: ShellingType;
+  cutin: DayCutinLike | null;
+  power_mod: number;
+  accuracy_mod: number;
+  hits: number;
+}
+
 export interface NightContactChance {
   rank1: number;
   rank2: number;
@@ -611,6 +764,32 @@ export interface NightCutinActionReport
   cutin_term: number | null;
 }
 
+export interface FleetCutinReport<T> {
+  cutin: FleetCutin;
+  rate: number | null;
+  formation: Formation;
+  attacks: FleetCutinAttackReport<T>[];
+}
+
+export interface FleetCutinAttackReport<T> extends AttackReport<T> {
+  index: number;
+  ship_id: number;
+  power_mod: number;
+}
+
+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 CompAntiAirAnalysis {
   fleet_adjusted_anti_air: number;
   ships: AntiAirReport[];
@@ -629,44 +808,25 @@ export interface AntiAirReport {
   anti_air_propellant_barrage_chance: number | null;
 }
 
-export type FleetType = "Main" | "Escort" | "RouteSup" | "BossSup";
-
-export interface SupportShellingStyle {
-  tag: "SupportShellingStyle";
-  attack_type: SupportShellingType;
-}
-
-export type NightPhaseAttackStyle = NightAttackStyle | AswAttackStyle;
-
-export type DayPhaseAttackStyle = ShellingStyle | AswAttackStyle;
+export type CompiledEvaler = string;
 
-export interface TorpedoAttackStyle {
-  tag: "TorpedoAttackStyle";
-  attack_type: TorpedoAttackType;
-}
+export type Formation = SingleFormation | CombinedFormation;
 
-export interface AswAttackStyle {
-  tag: "AswAttackStyle";
-  attack_type: AswAttackType;
-}
+export type CombinedFormation =
+  | "Cruising1"
+  | "Cruising2"
+  | "Cruising3"
+  | "Cruising4";
 
-export interface NightAttackStyle {
-  tag: "NightAttackStyle";
-  attack_type: NightAttackType;
-  cutin: NightCutinLike | null;
-  power_mod: number;
-  accuracy_mod: number;
-  hits: number;
-}
+export type SingleFormation =
+  | "LineAhead"
+  | "DoubleLine"
+  | "Diamond"
+  | "Echelon"
+  | "LineAbreast"
+  | "Vanguard";
 
-export interface ShellingStyle {
-  tag: "ShellingStyle";
-  attack_type: ShellingType;
-  cutin: DayCutinLike | null;
-  power_mod: number;
-  accuracy_mod: number;
-  hits: number;
-}
+export type FleetType = "Main" | "Escort" | "RouteSup" | "BossSup";
 
 export interface CustomPowerModifiers {
   precap_mod?: AttackPowerModifier;
@@ -711,6 +871,7 @@ export interface AttackPowerParams {
   armor_penetration: number;
   remaining_ammo_mod: number;
   special_enemy_mods: SpecialEnemyModifiers;
+  historical_mod: number;
   custom_mods: CustomPowerModifiers;
 }
 
@@ -725,56 +886,6 @@ export interface SpecialEnemyModifiers {
   pt_mod: AttackPowerModifier;
 }
 
-export interface FleetCutinReport<T> {
-  cutin: FleetCutin;
-  rate: number | null;
-  formation: Formation;
-  attacks: FleetCutinAttackReport<T>[];
-}
-
-export interface FleetCutinAttackReport<T> extends AttackReport<T> {
-  index: number;
-  ship_id: number;
-  power_mod: number;
-}
-
-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 AttackAnalyzerShipConfig
-  extends ShipConditions,
-    NightFleetConditions {
-  fleet_los_mod?: number | null;
-}
-
-export type Histogram<K, V> = Partial<Record<K, V>>;
-
-export type Formation = SingleFormation | CombinedFormation;
-
-export type CombinedFormation =
-  | "Cruising1"
-  | "Cruising2"
-  | "Cruising3"
-  | "Cruising4";
-
-export type SingleFormation =
-  | "LineAhead"
-  | "DoubleLine"
-  | "Diamond"
-  | "Echelon"
-  | "LineAbreast"
-  | "Vanguard";
-
 export interface CompDayCutinAnalysis {
   rank3_air_state: AirState;
   rank2_air_state: AirState;
@@ -806,6 +917,8 @@ export interface AttackAnalysis {
   support_shelling: ActionReport<SupportShellingStyle>;
 }
 
+export type Histogram<K, V> = Partial<Record<K, V>>;
+
 export type SpecialEnemyType =
   | "None"
   | "SoftSkinned"
@@ -852,43 +965,6 @@ export interface MasterShip {
 
 export type StatInterval = [number | null, number | 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: MstEquipExslotShip[];
-  rules: EquippabilityRule[];
-}
-
-export interface MstEquipExslotShip {
-  api_slotitem_id: number;
-  api_ship_ids: number[];
-}
-
-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[];
-  day_cutin: DayCutinDef[];
-  night_cutin: NightCutinDef[];
-}
-
 export interface HitRate {
   normal: number;
   critical: number;
@@ -945,57 +1021,6 @@ export interface CompAnalysis {
   anti_air: CompAntiAirAnalysis;
 }
 
-export type CompiledEvaler = string;
-
-export type SpeedGroup = "A" | "B1" | "B2" | "C";
-
-export interface NightFleetConditions {
-  night_contact_rank?: ContactRank | null;
-  starshell_index?: number | null;
-  searchlight_index?: number | null;
-  activates_large_searchlight?: boolean;
-}
-
-export interface NightConditions {
-  player?: NightFleetConditions;
-  enemy?: NightFleetConditions;
-}
-
-export interface BattleConditions {
-  org_type: OrgType;
-  role: Role;
-  ship_index: number;
-  fleet_len: number;
-  formation: Formation;
-  fleet_los_mod: number | null;
-  night_conditions: NightFleetConditions;
-}
-
-export interface MasterGear {
-  gear_id: number;
-  name: string;
-  types: GearTypeIdArray;
-  special_type?: number;
-  max_hp?: number;
-  firepower?: number;
-  armor?: number;
-  torpedo?: number;
-  anti_air?: number;
-  speed?: number;
-  bombing?: number;
-  asw?: number;
-  los?: number;
-  luck?: number;
-  accuracy?: number;
-  evasion?: number;
-  range?: number;
-  radius?: number;
-  cost?: number;
-  improvable?: boolean;
-  ship_anti_air_resist?: number;
-  fleet_anti_air_resist?: number;
-}
-
 /**
  */
 export class AirSquadron {