From 53174db3519cbaa3380e3d70230412a8e59b8f0e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tr=C3=A8sAbhi?= <43380238+tresabhi@users.noreply.github.com>
Date: Thu, 7 Mar 2024 18:30:02 -0600
Subject: [PATCH] feat: rename tank types to tank classes

---
 scripts/buildAssets/definitions.ts            |  4 +--
 src/app/embeds/session/page.tsx               |  2 +-
 .../[id]/components/Characteristics/index.tsx | 29 ++++++-------------
 .../tankopedia/[id]/components/Title.tsx      |  2 +-
 .../TankSearch/components/Options/index.tsx   |  8 ++---
 .../components/TankSearch/index.tsx           |  8 ++---
 src/commands/breakdown.tsx                    |  2 +-
 src/commands/ownedTanks.tsx                   |  4 +--
 src/components/Breakdown/components/Row.tsx   |  4 +--
 src/components/Tanks/components/Item.tsx      |  8 ++---
 src/core/blitzkrieg/filtersToDescription.ts   |  2 +-
 src/core/blitzkrieg/tankDefinitions.ts        | 10 +++----
 src/core/discord/addFilterOptions.ts          | 16 +++++-----
 src/core/discord/getFiltersFromButton.ts      |  2 +-
 src/core/discord/getFiltersFromCommand.ts     |  2 +-
 src/core/statistics/filterStats.ts            |  2 +-
 src/lang/en-US.json                           |  8 ++---
 src/stores/tankopedia.ts                      |  4 +--
 18 files changed, 53 insertions(+), 64 deletions(-)

diff --git a/scripts/buildAssets/definitions.ts b/scripts/buildAssets/definitions.ts
index 1dbd313a1..d73cf9208 100644
--- a/scripts/buildAssets/definitions.ts
+++ b/scripts/buildAssets/definitions.ts
@@ -2,7 +2,7 @@ import { readdir } from 'fs/promises';
 import { parse as parsePath } from 'path';
 import { Vector3Tuple } from 'three';
 import { parse as parseYaml } from 'yaml';
-import { TankType } from '../../src/components/Tanks';
+import { TankClass } from '../../src/components/Tanks';
 import { readXMLDVPL } from '../../src/core/blitz/readXMLDVPL';
 import { readYAMLDVPL } from '../../src/core/blitz/readYAMLDVPL';
 import { toUniqueId } from '../../src/core/blitz/toUniqueId';
@@ -488,7 +488,7 @@ export async function definitions(production: boolean) {
               ? 'premium'
               : 'researchable',
           tier: tank.level as Tier,
-          type: tankTags[0] as TankType,
+          class: tankTags[0] as TankClass,
           testing: tankTags.includes('testTank') ? true : undefined,
           price: tankPrice,
           camouflage: {
diff --git a/src/app/embeds/session/page.tsx b/src/app/embeds/session/page.tsx
index c4b81a6f9..85b766b22 100644
--- a/src/app/embeds/session/page.tsx
+++ b/src/app/embeds/session/page.tsx
@@ -311,7 +311,7 @@ export default function SessionPage({ naked = true }: SessionPageProps) {
                         tankDefinitions?.name ?? `Unknown tank ${stats.tank_id}`
                       }
                       type="tank"
-                      tankType={tankDefinitions?.type}
+                      tankType={tankDefinitions?.class}
                       treeType={tankDefinitions?.treeType}
                       stats={session.customColumns.map((customColumn) => {
                         const rowStat = rowStats[customColumn.display];
diff --git a/src/app/tools/tankopedia/[id]/components/Characteristics/index.tsx b/src/app/tools/tankopedia/[id]/components/Characteristics/index.tsx
index dae69588d..a7b4b308c 100644
--- a/src/app/tools/tankopedia/[id]/components/Characteristics/index.tsx
+++ b/src/app/tools/tankopedia/[id]/components/Characteristics/index.tsx
@@ -136,12 +136,13 @@ export function Characteristics() {
   ]);
   const enginePowerCoefficient = coefficient(
     [
-      hasEngineAccelerator && (tank.type === 'lightTank' || tank.type === 'mediumTank'),
+      hasEngineAccelerator &&
+        (tank.class === 'lightTank' || tank.class === 'mediumTank'),
       0.05,
     ],
     [
       hasEngineAccelerator &&
-        (tank.type === 'heavyTank' || tank.type === 'AT-SPG'),
+        (tank.class === 'heavyTank' || tank.class === 'AT-SPG'),
       0.07,
     ],
     [hasEnginePowerBoost, 0.2],
@@ -163,7 +164,7 @@ export function Characteristics() {
   const viewRangeCoefficient =
     coefficient([
       hasImprovedOptics,
-      tank.type === 'AT-SPG' ? 0.05 : tank.type === 'heavyTank' ? 0.07 : 0.1,
+      tank.class === 'AT-SPG' ? 0.05 : tank.class === 'heavyTank' ? 0.07 : 0.1,
     ]) * coefficient([true, progressiveStat(commanderMastery)]);
   const fireChanceCoefficient = coefficient([hasProtectiveKit, -0.2]);
 
@@ -180,38 +181,26 @@ export function Characteristics() {
   const camouflageSumMoving = sum(
     [
       hasCamouflageNet,
-      tank.type === 'heavyTank'
-        ? 0.03
-        : tank.type === 'AT-SPG'
-          ? 0.07
-          : 0.05,
+      tank.class === 'heavyTank' ? 0.03 : tank.class === 'AT-SPG' ? 0.07 : 0.05,
     ],
     [
       camouflage,
-      tank.type === 'AT-SPG'
-        ? 0.04
-        : tank.type === 'heavyTank'
-          ? 0.03
-          : 0.02,
+      tank.class === 'AT-SPG' ? 0.04 : tank.class === 'heavyTank' ? 0.03 : 0.02,
     ],
   );
   const camouflageSumStill = sum(
     [
       hasCamouflageNet,
       2 *
-        (tank.type === 'heavyTank'
+        (tank.class === 'heavyTank'
           ? 0.03
-          : tank.type === 'AT-SPG'
+          : tank.class === 'AT-SPG'
             ? 0.07
             : 0.05),
     ],
     [
       camouflage,
-      tank.type === 'AT-SPG'
-        ? 0.04
-        : tank.type === 'heavyTank'
-          ? 0.03
-          : 0.02,
+      tank.class === 'AT-SPG' ? 0.04 : tank.class === 'heavyTank' ? 0.03 : 0.02,
     ],
   );
 
diff --git a/src/app/tools/tankopedia/[id]/components/Title.tsx b/src/app/tools/tankopedia/[id]/components/Title.tsx
index 24a8febde..22caff8ce 100644
--- a/src/app/tools/tankopedia/[id]/components/Title.tsx
+++ b/src/app/tools/tankopedia/[id]/components/Title.tsx
@@ -30,7 +30,7 @@ export function Title() {
               <img
                 src={
                   TREE_TYPE_ICONS[protagonist.tank.treeType][
-                    protagonist.tank.type
+                    protagonist.tank.class
                   ]
                 }
                 style={{
diff --git a/src/app/tools/tankopedia/components/TankSearch/components/Options/index.tsx b/src/app/tools/tankopedia/components/TankSearch/components/Options/index.tsx
index 0b512243f..bf99d4869 100644
--- a/src/app/tools/tankopedia/components/TankSearch/components/Options/index.tsx
+++ b/src/app/tools/tankopedia/components/TankSearch/components/Options/index.tsx
@@ -5,7 +5,7 @@ import { Button, DropdownMenu, Flex } from '@radix-ui/themes';
 import { use } from 'react';
 import { Flag } from '../../../../../../../components/Flag';
 import {
-  TANK_TYPES,
+  TANK_CLASSES,
   TREE_TYPES,
   TREE_TYPE_ICONS,
   TREE_TYPE_IMAGES,
@@ -121,7 +121,7 @@ export function Options() {
         ))}
       </Flex>
       <Flex>
-        {[...TANK_TYPES].map((type, index) => (
+        {[...TANK_CLASSES].map((type, index) => (
           <Button
             key={type}
             color={filters.types.includes(type) ? undefined : 'gray'}
@@ -132,9 +132,9 @@ export function Options() {
               borderTopLeftRadius: index === 0 ? undefined : 0,
               borderBottomLeftRadius: index === 0 ? undefined : 0,
               borderTopRightRadius:
-                index === TANK_TYPES.length - 1 ? undefined : 0,
+                index === TANK_CLASSES.length - 1 ? undefined : 0,
               borderBottomRightRadius:
-                index === TANK_TYPES.length - 1 ? undefined : 0,
+                index === TANK_CLASSES.length - 1 ? undefined : 0,
             }}
             onClick={() =>
               mutateTankopediaPersistent((draft) => {
diff --git a/src/app/tools/tankopedia/components/TankSearch/index.tsx b/src/app/tools/tankopedia/components/TankSearch/index.tsx
index 6c5d00a10..c0ae0672c 100644
--- a/src/app/tools/tankopedia/components/TankSearch/index.tsx
+++ b/src/app/tools/tankopedia/components/TankSearch/index.tsx
@@ -15,7 +15,7 @@ import {
 } from '@radix-ui/themes';
 import { go } from 'fuzzysort';
 import { use, useEffect, useMemo, useRef, useState } from 'react';
-import { TANK_TYPES, TreeType } from '../../../../../components/Tanks';
+import { TANK_CLASSES, TreeType } from '../../../../../components/Tanks';
 import { resolveNearPenetration } from '../../../../../core/blitz/resolveNearPenetration';
 import { asset } from '../../../../../core/blitzkrieg/asset';
 import { modelDefinitions } from '../../../../../core/blitzkrieg/modelDefinitions';
@@ -69,7 +69,7 @@ export function TankSearch({ compact, onSelect = () => {} }: TankSearchProps) {
         )
         .sort(
           (a, b) =>
-            (TANK_TYPES.indexOf(a.type) - TANK_TYPES.indexOf(b.type)) *
+            (TANK_CLASSES.indexOf(a.class) - TANK_CLASSES.indexOf(b.class)) *
             (sort.direction === 'descending' ? -1 : 1),
         )
         .sort(
@@ -88,7 +88,7 @@ export function TankSearch({ compact, onSelect = () => {} }: TankSearchProps) {
           : filters.tiers.includes(tank.tier)) &&
         (filters.types.length === 0
           ? true
-          : filters.types.includes(tank.type)) &&
+          : filters.types.includes(tank.class)) &&
         (filters.treeTypes.length === 0
           ? true
           : filters.treeTypes.includes(tank.treeType)) &&
@@ -843,7 +843,7 @@ export function TankSearch({ compact, onSelect = () => {} }: TankSearchProps) {
                           ? TANK_ICONS_COLLECTOR
                           : tank.treeType === 'premium'
                             ? TANK_ICONS_PREMIUM
-                            : TANK_ICONS)[tank.type]
+                            : TANK_ICONS)[tank.class]
                       }
                       style={{ width: '1em', height: '1em' }}
                     />
diff --git a/src/commands/breakdown.tsx b/src/commands/breakdown.tsx
index f48f8733c..2eb6a3af1 100644
--- a/src/commands/breakdown.tsx
+++ b/src/commands/breakdown.tsx
@@ -199,7 +199,7 @@ export async function renderBreakdown(
         <Breakdown.Row
           key={id}
           type="tank"
-          tankType={tankDefinition?.type}
+          tankType={tankDefinition?.class}
           treeType={tankDefinition?.treeType}
           title={
             tankDefinition?.name ??
diff --git a/src/commands/ownedTanks.tsx b/src/commands/ownedTanks.tsx
index c88dcb07a..a5584bb1e 100644
--- a/src/commands/ownedTanks.tsx
+++ b/src/commands/ownedTanks.tsx
@@ -98,7 +98,7 @@ export const ownedTanksCommand = new Promise<CommandRegistry>((resolve) => {
                             <Tanks.Item
                               key={tank.id}
                               name={tank.name}
-                              tankType={tank.type}
+                              tankType={tank.class}
                               image={tankIcon(tank.id)}
                               treeType={tank.treeType}
                             />
@@ -111,7 +111,7 @@ export const ownedTanksCommand = new Promise<CommandRegistry>((resolve) => {
                             <Tanks.Item
                               key={tank.id}
                               name={tank.name}
-                              tankType={tank.type}
+                              tankType={tank.class}
                               image={tankIcon(tank.id)}
                               treeType={tank.treeType}
                             />
diff --git a/src/components/Breakdown/components/Row.tsx b/src/components/Breakdown/components/Row.tsx
index b22f1cb86..36097debe 100644
--- a/src/components/Breakdown/components/Row.tsx
+++ b/src/components/Breakdown/components/Row.tsx
@@ -5,7 +5,7 @@ import {
   GrayColor,
   PALETTES,
 } from '../../../constants/radixColors';
-import { TREE_TYPE_ICONS, TankType, TreeType } from '../../Tanks';
+import { TREE_TYPE_ICONS, TankClass, TreeType } from '../../Tanks';
 import { RowStat } from './RowStat';
 
 export interface RowStatItem {
@@ -22,7 +22,7 @@ interface RowProps {
   title: string;
   minimized?: boolean;
   treeType?: TreeType;
-  tankType?: TankType;
+  tankType?: TankClass;
   color?: AccentColor | GrayColor;
   stats: (RowStatItem | undefined)[];
 }
diff --git a/src/components/Tanks/components/Item.tsx b/src/components/Tanks/components/Item.tsx
index 886493113..2d1818a2e 100644
--- a/src/components/Tanks/components/Item.tsx
+++ b/src/components/Tanks/components/Item.tsx
@@ -5,7 +5,7 @@ import {
 } from '../../../core/blitzkrieg/tankDefinitions';
 import { theme } from '../../../stitches.config';
 
-export const TANK_TYPES = [
+export const TANK_CLASSES = [
   'lightTank',
   'mediumTank',
   'heavyTank',
@@ -14,7 +14,7 @@ export const TANK_TYPES = [
 
 export const TREE_TYPES = ['researchable', 'premium', 'collector'] as const;
 
-export type TankType = (typeof TANK_TYPES)[number];
+export type TankClass = (typeof TANK_CLASSES)[number];
 export type TreeType = (typeof TREE_TYPES)[number];
 
 // BIG TODO: REMOVE THIS AFTER LOCALIZATION
@@ -32,7 +32,7 @@ export const TREE_TYPE_IMAGES: Record<TreeType, string> = {
 
 export interface ItemProps {
   image?: string;
-  tankType?: TankType;
+  tankType?: TankClass;
   name: string;
   treeType: TreeType;
 }
@@ -43,7 +43,7 @@ const TREE_TYPE_COLOR = {
   collector: '_blue',
 } as const;
 
-export const TREE_TYPE_ICONS: Record<TreeType, Record<TankType, string>> = {
+export const TREE_TYPE_ICONS: Record<TreeType, Record<TankClass, string>> = {
   researchable: TANK_ICONS,
   premium: TANK_ICONS_PREMIUM,
   collector: TANK_ICONS_COLLECTOR,
diff --git a/src/core/blitzkrieg/filtersToDescription.ts b/src/core/blitzkrieg/filtersToDescription.ts
index 122cab1e8..9a6b91ce0 100644
--- a/src/core/blitzkrieg/filtersToDescription.ts
+++ b/src/core/blitzkrieg/filtersToDescription.ts
@@ -19,7 +19,7 @@ export async function filtersToDescription(
       translate('bot.common.filters.tier', [TIER_ROMAN_NUMERALS[tier as Tier]]),
     );
   }
-  if (tankType) info.push(translate(`common.tank_type_short.${tankType}`));
+  if (tankType) info.push(translate(`common.tank_class_short.${tankType}`));
   if (treeType) info.push(translate(`common.tree_type.${treeType}`));
 
   return info.length === 0
diff --git a/src/core/blitzkrieg/tankDefinitions.ts b/src/core/blitzkrieg/tankDefinitions.ts
index fd3d08fb6..7258cf30d 100644
--- a/src/core/blitzkrieg/tankDefinitions.ts
+++ b/src/core/blitzkrieg/tankDefinitions.ts
@@ -1,6 +1,6 @@
 import { deburr } from 'lodash';
 import { Vector2Tuple } from 'three';
-import { TankType, TreeType } from '../../components/Tanks';
+import { TankClass, TreeType } from '../../components/Tanks';
 import { asset } from './asset';
 import { fetchCdonLz4 } from './fetchCdonLz4';
 
@@ -44,7 +44,7 @@ export interface TankDefinition {
   consumables: number;
   provisions: number;
   tier: Tier;
-  type: TankType;
+  class: TankClass;
   testing?: boolean;
   turrets: TurretDefinition[];
   engines: EngineDefinition[];
@@ -180,21 +180,21 @@ export const tankNames = tanksDefinitionsArray.then((tanks) =>
   ),
 );
 
-export const TANK_ICONS: Record<TankType, string> = {
+export const TANK_ICONS: Record<TankClass, string> = {
   'AT-SPG': 'https://i.imgur.com/BIHSEH0.png',
   lightTank: 'https://i.imgur.com/CSNha5V.png',
   mediumTank: 'https://i.imgur.com/wvf3ltm.png',
   heavyTank: 'https://i.imgur.com/ECeqlZa.png',
 };
 
-export const TANK_ICONS_PREMIUM: Record<TankType, string> = {
+export const TANK_ICONS_PREMIUM: Record<TankClass, string> = {
   'AT-SPG': 'https://i.imgur.com/TCu3EdR.png',
   lightTank: 'https://i.imgur.com/zdkpTRb.png',
   mediumTank: 'https://i.imgur.com/3z7eHX6.png',
   heavyTank: 'https://i.imgur.com/P3vbmyA.png',
 };
 
-export const TANK_ICONS_COLLECTOR: Record<TankType, string> = {
+export const TANK_ICONS_COLLECTOR: Record<TankClass, string> = {
   'AT-SPG': 'https://i.imgur.com/WTjeirB.png',
   lightTank: 'https://i.imgur.com/EwhtKkU.png',
   mediumTank: 'https://i.imgur.com/u8YDMBh.png',
diff --git a/src/core/discord/addFilterOptions.ts b/src/core/discord/addFilterOptions.ts
index 7e626a232..d8d345e8e 100644
--- a/src/core/discord/addFilterOptions.ts
+++ b/src/core/discord/addFilterOptions.ts
@@ -4,7 +4,7 @@ import {
   SlashCommandBuilder,
   SlashCommandSubcommandBuilder,
 } from 'discord.js';
-import { TANK_TYPES, TREE_TYPES } from '../../components/Tanks';
+import { TANK_CLASSES, TREE_TYPES } from '../../components/Tanks';
 import { translator } from '../localization/translator';
 import addTankChoices from './addTankChoices';
 import addTierChoices from './addTierChoices';
@@ -46,26 +46,26 @@ export function addFilterOptions<
       .addStringOption((option) => addTierChoices(option).setRequired(false))
       .addStringOption((option) =>
         option
-          .setName(translate('bot.common.options.filters.tank_type'))
+          .setName(translate('bot.common.options.filters.tank_class'))
           .setNameLocalizations(
-            localizationObject('bot.common.options.filters.tank_type'),
+            localizationObject('bot.common.options.filters.tank_class'),
           )
           .setDescription(
-            translate('bot.common.options.filters.tank_type.description'),
+            translate('bot.common.options.filters.tank_class.description'),
           )
           .setDescriptionLocalizations(
             localizationObject(
-              'bot.common.options.filters.tank_type.description',
+              'bot.common.options.filters.tank_class.description',
             ),
           )
           .addChoices(
-            ...TANK_TYPES.map(
+            ...TANK_CLASSES.map(
               (tankType) =>
                 ({
                   value: tankType,
-                  name: translate(`common.tank_type_short.${tankType}`),
+                  name: translate(`common.tank_class_short.${tankType}`),
                   name_localizations: localizationObject(
-                    `common.tank_type_short.${tankType}`,
+                    `common.tank_class_short.${tankType}`,
                   ),
                 }) satisfies APIApplicationCommandOptionChoice,
             ),
diff --git a/src/core/discord/getFiltersFromButton.ts b/src/core/discord/getFiltersFromButton.ts
index f1b24829e..3ad62a16c 100644
--- a/src/core/discord/getFiltersFromButton.ts
+++ b/src/core/discord/getFiltersFromButton.ts
@@ -8,7 +8,7 @@ export function getFiltersFromButton(interaction: ButtonInteraction) {
   return {
     nation: url.searchParams.get('nation') ?? undefined,
     tank: parseInt(url.searchParams.get('tank') ?? '0') || undefined,
-    tankType: url.searchParams.get('tank-type') ?? undefined,
+    tankType: url.searchParams.get('tank-class') ?? undefined,
     treeType:
       (url.searchParams.get('tree-type') as TreeType | undefined) ?? undefined,
     tier: parseInt(url.searchParams.get('tier') ?? '0') || undefined,
diff --git a/src/core/discord/getFiltersFromCommand.ts b/src/core/discord/getFiltersFromCommand.ts
index c958dbc35..171316635 100644
--- a/src/core/discord/getFiltersFromCommand.ts
+++ b/src/core/discord/getFiltersFromCommand.ts
@@ -11,7 +11,7 @@ export async function getFiltersFromCommand(
   return {
     nation: interaction.options.getString('nation') ?? undefined,
     tier: parseInt(interaction.options.getString('tier') ?? '0') || undefined,
-    tankType: interaction.options.getString('tank-type') ?? undefined,
+    tankType: interaction.options.getString('tank-class') ?? undefined,
     treeType:
       (interaction.options.getString('tree-type') as TreeType | undefined) ??
       undefined,
diff --git a/src/core/statistics/filterStats.ts b/src/core/statistics/filterStats.ts
index c13845ffc..42a60015e 100644
--- a/src/core/statistics/filterStats.ts
+++ b/src/core/statistics/filterStats.ts
@@ -29,7 +29,7 @@ export async function filterStats(
       entry &&
       (filters.nation === undefined || entry.nation === filters.nation) &&
       (filters.tier === undefined || entry.tier === filters.tier) &&
-      (filters.tankType === undefined || entry.type === filters.tankType) &&
+      (filters.tankType === undefined || entry.class === filters.tankType) &&
       (filters.treeType === undefined ||
         (filters.treeType === 'collector' && entry.treeType === 'collector') ||
         (filters.treeType === 'premium' && entry.treeType === 'premium') ||
diff --git a/src/lang/en-US.json b/src/lang/en-US.json
index fcc60b649..5a36d1722 100644
--- a/src/lang/en-US.json
+++ b/src/lang/en-US.json
@@ -12,7 +12,7 @@
       "other": "Hybrid nation"
     },
 
-    "tank_type_short": {
+    "tank_class_short": {
       "lightTank": "Light",
       "mediumTank": "Medium",
       "heavyTank": "Heavy",
@@ -122,9 +122,9 @@
             "$": "nation",
             "description": "Nation"
           },
-          "tank_type": {
-            "$": "tank-type",
-            "description": "Tank type"
+          "tank_class": {
+            "$": "tank-class",
+            "description": "Tank class"
           },
           "tree_type": {
             "$": "tree-type",
diff --git a/src/stores/tankopedia.ts b/src/stores/tankopedia.ts
index 3cbaeb781..f4dd7946c 100644
--- a/src/stores/tankopedia.ts
+++ b/src/stores/tankopedia.ts
@@ -5,7 +5,7 @@ import { create } from 'zustand';
 import { persist, subscribeWithSelector } from 'zustand/middleware';
 import { ENVIRONMENTS } from '../app/tools/tankopedia/[id]/components/Lighting';
 import { ArmorType } from '../components/Armor/components/SpacedArmorScene';
-import { TankType, TreeType } from '../components/Tanks';
+import { TankClass, TreeType } from '../components/Tanks';
 import { Tier } from '../core/blitzkrieg/tankDefinitions';
 
 export type TankopediaSortBy = keyof typeof SORT_NAMES;
@@ -31,7 +31,7 @@ export interface TankopediaPersistent {
   };
   filters: {
     tiers: Tier[];
-    types: TankType[];
+    types: TankClass[];
     treeTypes: TreeType[];
     nations: string[];
     test: TankopediaTestTankDisplay;