fleethub-core 1.4.2 → 1.6.1

package/node/fleethub_core.d.ts

@@ -43,6 +43,41 @@ export interface GearInput {
 
 export type GearVecInput = GearInput[];
 
+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 ShipCategory =
+  | "Battleship"
+  | "AircraftCarrier"
+  | "HeavyCruiser"
+  | "LightCruiser"
+  | "Destroyer"
+  | "CoastalDefenseShip"
+  | "Submarine"
+  | "AuxiliaryShip";
+
 export type AirStateRank = "Rank0" | "Rank1" | "Rank2" | "Rank3";
 
 export type AirState =
@@ -52,34 +87,23 @@ export type AirState =
   | "AirDenial"
   | "AirIncapability";
 
-export interface MasterIBonuses {
-  shelling_power: MasterIBonusRule[];
-  carrier_shelling_power: MasterIBonusRule[];
-  shelling_accuracy: MasterIBonusRule[];
-  torpedo_power: MasterIBonusRule[];
-  torpedo_accuracy: MasterIBonusRule[];
-  torpedo_evasion: MasterIBonusRule[];
-  asw_power: MasterIBonusRule[];
-  asw_accuracy: MasterIBonusRule[];
-  night_power: MasterIBonusRule[];
-  night_accuracy: MasterIBonusRule[];
-  defense_power: MasterIBonusRule[];
-  contact_selection: MasterIBonusRule[];
-  fighter_power: MasterIBonusRule[];
-  ship_anti_air: MasterIBonusRule[];
-  fleet_anti_air: MasterIBonusRule[];
-  elos: MasterIBonusRule[];
+export interface FleetCutinAnalysis {
+  shelling: FleetCutinInfo[];
+  night: FleetCutinInfo[];
 }
 
-export interface MasterIBonusRule {
-  expr: CompiledEvaler;
-  formula: CompiledEvaler;
+export interface FleetCutinInfo {
+  cutin: FleetCutin;
+  rate: number | null;
+  formation: Formation;
+  items: FleetCutinInfoItem[];
 }
 
-export interface NightSituation {
-  night_contact_rank: ContactRank | null;
-  starshell: boolean;
-  searchlight: boolean;
+export interface FleetCutinInfoItem {
+  ship_id: number;
+  cutin: FleetCutin;
+  fleet_cutin_mod: number;
+  stats: AttackStats;
 }
 
 export interface DamageInfo {
@@ -95,70 +119,6 @@ export interface DamageInfo {
   damage_state_map: NumMap<DamageState, number>;
 }
 
-export interface BattleConfig {
-  formation: Record<Formation, NestedFormationDef>;
-  anti_air_cutin: Record<number, AntiAirCutinDef>;
-  day_cutin: Record<DayCutin, DayCutinDef>;
-  night_cutin: Record<NightCutin, NightCutinDef>;
-}
-
-export interface NightCutinDef {
-  tag: NightCutin;
-  hits: number;
-  type_factor: number | null;
-  power_mod: number | null;
-  accuracy_mod: number | null;
-}
-
-export interface DayCutinDef {
-  tag: DayCutin;
-  hits: number;
-  type_factor: number | null;
-  power_mod: number | null;
-  accuracy_mod: number | null;
-}
-
-export interface AntiAirCutinDef {
-  id: number;
-  type_factor: number | null;
-  multiplier: number | null;
-  guaranteed: number | null;
-  sequential: boolean | null;
-}
-
-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: FormationWarfareDef;
-  torpedo: FormationWarfareDef;
-  asw: FormationWarfareDef;
-  night: FormationWarfareDef;
-  shelling_support: FormationWarfareDef;
-}
-
-export interface FormationWarfareDef {
-  power_mod: number | null;
-  accuracy_mod: number | null;
-  evasion_mod: number | null;
-}
-
-export type AirWaveType = "Jet" | "LandBase" | "Carrier";
-
-export type AswAttackType = "DepthCharge" | "Aircraft";
-
-export type OrgType =
-  | "Single"
-  | "CarrierTaskForce"
-  | "SurfaceTaskForce"
-  | "TransportEscort"
-  | "EnemySingle"
-  | "EnemyCombined";
-
 export interface WarfareContext {
   attacker_env: WarfareShipEnvironment;
   target_env: WarfareShipEnvironment;
@@ -176,6 +136,55 @@ export interface WarfareShipEnvironment {
   fleet_los_mod: number | null;
 }
 
+export type OrgType =
+  | "Single"
+  | "CarrierTaskForce"
+  | "SurfaceTaskForce"
+  | "TransportEscort"
+  | "EnemySingle"
+  | "EnemyCombined";
+
+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 interface MasterData {
+  gears: MasterGear[];
+  gear_attrs: MasterAttrRule<GearAttr>[];
+  ships: MasterShip[];
+  ship_attrs: MasterAttrRule<ShipAttr>[];
+  ibonuses: MasterIBonuses;
+  equippable: MasterEquippable;
+  formation: NestedFormationDef[];
+  anti_air_cutin: AntiAirCutinDef[];
+  day_cutin: DayCutinDef[];
+  night_cutin: NightCutinDef[];
+}
+
+export interface MasterConfig {
+  formation: NestedFormationDef[];
+  anti_air_cutin: AntiAirCutinDef[];
+  day_cutin: DayCutinDef[];
+  night_cutin: NightCutinDef[];
+}
+
+export interface MasterAttrRule<T> {
+  tag: T;
+  name: string;
+  expr: string;
+}
+
 export interface AttackPower {
   precap: number;
   is_capped: boolean;
@@ -223,80 +232,6 @@ export interface AttackPowerModifier {
 
 export type NumMap<K, V> = Partial<Record<K, V>>;
 
-export type Role = "Main" | "Escort";
-
-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 interface CompDayCutinRateInfo {
-  main: FleetDayCutinRateInfo;
-  escort: FleetDayCutinRateInfo | null;
-}
-
-export interface FleetDayCutinRateInfo {
-  fleet_los_mod: number | null;
-  ships: ShipDayCutinRateInfo[];
-}
-
-export interface ShipDayCutinRateInfo {
-  ship_id: number;
-  air_supremacy: DayCutinRateInfo;
-  air_superiority: DayCutinRateInfo;
-}
-
-export interface DayCutinRateInfo {
-  observation_term: number | null;
-  rates: [DayCutin | null, number | null][];
-  total_cutin_rate: number | null;
-}
-
-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 ShipCategory =
-  | "Battleship"
-  | "AircraftCarrier"
-  | "HeavyCruiser"
-  | "LightCruiser"
-  | "Destroyer"
-  | "CoastalDefenseShip"
-  | "Submarine"
-  | "AuxiliaryShip";
-
 export type ShellingSpecialAttack =
   | { DayCutin: DayCutin }
   | { FleetCutin: FleetCutin };
@@ -313,6 +248,8 @@ export type DayCutin =
   | "Zuiun"
   | "AirSea";
 
+export type Role = "Main" | "Escort";
+
 export type GearCategory =
   | "Fighter"
   | "Bomber"
@@ -397,63 +334,29 @@ export interface ShellingSupportSimulatorParams {
   custom_mods: CustomModifiers;
 }
 
-export interface MasterData {
-  gears: MasterGear[];
-  gear_attrs: MasterAttrRule<GearAttr>[];
-  ships: MasterShip[];
-  ship_attrs: MasterAttrRule<ShipAttr>[];
-  ibonuses: MasterIBonuses;
-  equippable: MasterEquippable;
-  formation: NestedFormationDef[];
-  anti_air_cutin: AntiAirCutinDef[];
-  day_cutin: DayCutinDef[];
-  night_cutin: NightCutinDef[];
-}
-
-export interface MasterConfig {
-  formation: NestedFormationDef[];
-  anti_air_cutin: AntiAirCutinDef[];
-  day_cutin: DayCutinDef[];
-  night_cutin: NightCutinDef[];
-}
+export type ShellingAttackType = "Normal" | "Carrier";
 
-export interface MasterAttrRule<T> {
-  tag: T;
-  name: string;
-  expr: string;
+export interface CompDayCutinRateInfo {
+  main: FleetDayCutinRateInfo;
+  escort: FleetDayCutinRateInfo | null;
 }
 
-export interface MasterShip {
-  ship_id: number;
-  name: string;
-  yomi: string;
-  stype: number;
-  ctype: number;
-  sort_id?: number;
-  max_hp: StatInterval;
-  firepower: StatInterval;
-  armor: StatInterval;
-  torpedo: StatInterval;
-  evasion: StatInterval;
-  anti_air: StatInterval;
-  asw: StatInterval;
-  los: StatInterval;
-  luck: StatInterval;
-  torpedo_accuracy?: number;
-  speed: number;
-  range?: number;
-  fuel?: number;
-  ammo?: number;
-  next_id?: number;
-  next_level?: number;
-  slotnum: number;
-  slots: SlotSizeVec;
-  stock: GearState[];
-  speed_group?: SpeedGroup;
-  useful?: boolean;
+export interface FleetDayCutinRateInfo {
+  fleet_los_mod: number | null;
+  ships: ShipDayCutinRateInfo[];
 }
 
-export type StatInterval = [number | null, number | null];
+export interface ShipDayCutinRateInfo {
+  ship_id: number;
+  air_supremacy: DayCutinRateInfo;
+  air_superiority: DayCutinRateInfo;
+}
+
+export interface DayCutinRateInfo {
+  observation_term: number | null;
+  rates: [DayCutin | null, number | null][];
+  total_cutin_rate: number | null;
+}
 
 export type ShipAttr =
   | "Unknown"
@@ -471,54 +374,34 @@ export type ShipAttr =
   | "BattleshipSummerPrincess"
   | "HeavyCruiserSummerPrincess";
 
-export type Formation = SingleFormation | CombinedFormation;
-
-export type CombinedFormation =
-  | "Cruising1"
-  | "Cruising2"
-  | "Cruising3"
-  | "Cruising4";
-
-export type SingleFormation =
-  | "LineAhead"
-  | "DoubleLine"
-  | "Diamond"
-  | "Echelon"
-  | "LineAbreast"
-  | "Vanguard";
-
-export type ShellingAttackType = "Normal" | "Carrier";
-
-export interface FleetCutinAnalysis {
-  shelling: FleetCutinInfo[];
-  night: FleetCutinInfo[];
-}
-
-export interface FleetCutinInfo {
-  cutin: FleetCutin;
-  formation: Formation;
-  items: FleetCutinInfoItem[];
-}
-
-export interface FleetCutinInfoItem {
-  ship_id: number;
-  cutin: FleetCutin;
-  fleet_cutin_mod: number;
-  stats: AttackStats;
+export interface MasterIBonuses {
+  shelling_power: MasterIBonusRule[];
+  carrier_shelling_power: MasterIBonusRule[];
+  shelling_accuracy: MasterIBonusRule[];
+  torpedo_power: MasterIBonusRule[];
+  torpedo_accuracy: MasterIBonusRule[];
+  torpedo_evasion: MasterIBonusRule[];
+  asw_power: MasterIBonusRule[];
+  asw_accuracy: MasterIBonusRule[];
+  night_power: MasterIBonusRule[];
+  night_accuracy: MasterIBonusRule[];
+  defense_power: MasterIBonusRule[];
+  contact_selection: MasterIBonusRule[];
+  fighter_power: MasterIBonusRule[];
+  ship_anti_air: MasterIBonusRule[];
+  fleet_anti_air: MasterIBonusRule[];
+  elos: MasterIBonusRule[];
 }
 
-export interface CompContactChanceInfo {
-  single: AirstrikeContactChance[] | null;
-  combined: AirstrikeContactChance[] | null;
+export interface MasterIBonusRule {
+  expr: CompiledEvaler;
+  formula: CompiledEvaler;
 }
 
-export interface AirstrikeContactChance {
-  air_state: AirState;
-  trigger_rate: number;
-  rank3: number;
-  rank2: number;
-  rank1: number;
-  total: number;
+export interface NightSituation {
+  night_contact_rank: ContactRank | null;
+  starshell: boolean;
+  searchlight: boolean;
 }
 
 export type GearAttr =
@@ -552,29 +435,23 @@ export type GearAttr =
   | "SemiNightPlane"
   | "HighAltitudeInterceptor";
 
-export type FleetType = "Main" | "Escort" | "RouteSup" | "BossSup";
-
-export interface MasterEquippable {
-  equip_stype: EquipStype[];
-  equip_exslot: number[];
-  equip_ship: MstEquipShip[];
-  equip_exslot_ship: MstEquipExslotShip[];
-}
+export type Formation = SingleFormation | CombinedFormation;
 
-export interface MstEquipExslotShip {
-  api_slotitem_id: number;
-  api_ship_ids: number[];
-}
+export type CombinedFormation =
+  | "Cruising1"
+  | "Cruising2"
+  | "Cruising3"
+  | "Cruising4";
 
-export interface MstEquipShip {
-  api_ship_id: number;
-  api_equip_type: number[];
-}
+export type SingleFormation =
+  | "LineAhead"
+  | "DoubleLine"
+  | "Diamond"
+  | "Echelon"
+  | "LineAbreast"
+  | "Vanguard";
 
-export interface EquipStype {
-  id: number;
-  equip_type: number[];
-}
+export type FleetType = "Main" | "Escort" | "RouteSup" | "BossSup";
 
 export interface AttackInfo<AttackType, Cutin> {
   attack_type: AttackType;
@@ -613,6 +490,20 @@ export interface ShipAntiAirInfo {
   anti_air_propellant_barrage_chance: number | null;
 }
 
+export interface CompContactChanceInfo {
+  single: AirstrikeContactChance[] | null;
+  combined: AirstrikeContactChance[] | null;
+}
+
+export interface AirstrikeContactChance {
+  air_state: AirState;
+  trigger_rate: number;
+  rank3: number;
+  rank2: number;
+  rank1: number;
+  total: number;
+}
+
 export type ShipStateMap = Record<ShipKey, ShipState>;
 
 export type ShipKey = "s1" | "s2" | "s3" | "s4" | "s5" | "s6" | "s7";
@@ -709,7 +600,27 @@ export interface GearState {
   stars?: number;
 }
 
-export type Side = "Player" | "Enemy";
+export interface MasterEquippable {
+  equip_stype: EquipStype[];
+  equip_exslot: number[];
+  equip_ship: MstEquipShip[];
+  equip_exslot_ship: MstEquipExslotShip[];
+}
+
+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 type NightBattleAttackType =
   | { t: "NightAttack"; c: NightAttackType }
@@ -719,6 +630,10 @@ export type DayBattleAttackType =
   | { t: "Shelling"; c: ShellingAttackType }
   | { t: "Asw"; c: AswAttackType };
 
+export type SlotSizeVec = (number | null)[];
+
+export type Side = "Player" | "Enemy";
+
 export type NightAttackType = "Normal" | "ArkRoyal" | "Carrier";
 
 export type NightSpecialAttack =
@@ -742,6 +657,58 @@ export type NightCutin =
   | "Cvci1_18"
   | "Photobomber";
 
+export interface BattleConfig {
+  formation: Record<Formation, NestedFormationDef>;
+  anti_air_cutin: Record<number, AntiAirCutinDef>;
+  day_cutin: Record<DayCutin, DayCutinDef>;
+  night_cutin: Record<NightCutin, NightCutinDef>;
+}
+
+export interface NightCutinDef {
+  tag: NightCutin;
+  hits: number;
+  type_factor: number | null;
+  power_mod: number | null;
+  accuracy_mod: number | null;
+}
+
+export interface DayCutinDef {
+  tag: DayCutin;
+  hits: number;
+  type_factor: number | null;
+  power_mod: number | null;
+  accuracy_mod: number | null;
+}
+
+export interface AntiAirCutinDef {
+  id: number;
+  type_factor: number | null;
+  multiplier: number | null;
+  guaranteed: number | null;
+  sequential: boolean | null;
+}
+
+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: FormationWarfareDef;
+  torpedo: FormationWarfareDef;
+  asw: FormationWarfareDef;
+  night: FormationWarfareDef;
+  shelling_support: FormationWarfareDef;
+}
+
+export interface FormationWarfareDef {
+  power_mod: number | null;
+  accuracy_mod: number | null;
+  evasion_mod: number | null;
+}
+
 export interface MasterGear {
   gear_id: number;
   name: string;
@@ -782,6 +749,40 @@ export interface HitRateParams {
   hit_percentage_bonus: number;
 }
 
+export type GearTypeIdArray = [number, number, number, number, number];
+
+export interface MasterShip {
+  ship_id: number;
+  name: string;
+  yomi: string;
+  stype: number;
+  ctype: number;
+  sort_id?: number;
+  max_hp: StatInterval;
+  firepower: StatInterval;
+  armor: StatInterval;
+  torpedo: StatInterval;
+  evasion: StatInterval;
+  anti_air: StatInterval;
+  asw: StatInterval;
+  los: StatInterval;
+  luck: StatInterval;
+  torpedo_accuracy?: number;
+  speed: number;
+  range?: number;
+  fuel?: number;
+  ammo?: number;
+  next_id?: number;
+  next_level?: number;
+  slotnum: number;
+  slots: SlotSizeVec;
+  stock: GearState[];
+  speed_group?: SpeedGroup;
+  useful?: boolean;
+}
+
+export type StatInterval = [number | null, number | null];
+
 export interface WarfareInfo {
   day: AttackInfo<DayBattleAttackType, DayCutin | null> | null;
   closing_torpedo: AttackInfo<null, null> | null;
@@ -808,10 +809,6 @@ export interface WarfareAnalyzerShipEnvironment {
   custom_mods: CustomModifiers;
 }
 
-export type GearTypeIdArray = [number, number, number, number, number];
-
-export type SlotSizeVec = (number | null)[];
-
 export type SpecialEnemyType =
   | "None"
   | "SoftSkinned"
@@ -837,6 +834,8 @@ export type FleetCutin =
 
 export type ContactRank = "Rank1" | "Rank2" | "Rank3";
 
+export type AirWaveType = "Jet" | "LandBase" | "Carrier";
+
 export interface SimulatorResult {
   items: SimulatorResultItem[];
   sunk_vec: [number, number, number][];
@@ -849,6 +848,8 @@ export interface SimulatorResultItem {
   damage_state_map: Record<DamageState, number>;
 }
 
+export type AswAttackType = "DepthCharge" | "Aircraft";
+
 export interface FleetNightCutinRateInfo {
   night_contact_chance: NightContactChance;
   ships: ShipNightCutinRateInfo[];
@@ -1318,6 +1319,14 @@ export class Gear {
    * @returns {number}
    */
   night_contact_rate(level: number): number;
+  /**
+   * @returns {boolean}
+   */
+  is_night_attacker(): boolean;
+  /**
+   * @returns {boolean}
+   */
+  is_night_fighter(): boolean;
   /**
    * @returns {boolean}
    */