add RelicType class

CHANGELOG.md

@@ -1,5 +1,7 @@
 # 0.4.2
 - Renamed StatProperty#statPropertyType to StatProperty#type.
+- Renamed typedef RelicType to RelicTypeId, and added RelicType class.
+- Changed type of RelicData#type to RelicType (class).
 # 0.4.1
 - Changed type of CharacterStats#overallStats to OverlayStatList. (forgot updating)
 # 0.4.0

src/client/CachedAssetsManager.ts

@@ -52,6 +52,7 @@ const contents = [
     "RelicSubAffixConfig", // Relic Sub Stats
     "RelicSetConfig", // Relic Sets
     "RelicSetSkillConfig", // Relic Set Bonus
+    "RelicBaseType", // Relic Types
     "AvatarPropertyConfig", // StatProperty
     "AvatarPlayerIcon", // Character Icon for a player
     "PlayerIcon", // Other Icon for a player
@@ -532,6 +533,13 @@ class CachedAssetsManager {
             });
         });
 
+        Object.values(data["RelicBaseType"]).forEach(t => {
+            const json = new JsonReader(t);
+            push(
+                json.getAsNumber("BaseTypeText", "Hash"),
+            );
+        });
+
         Object.values(data["AvatarPropertyConfig"]).forEach(s => {
             const json = new JsonReader(s);
             push(

src/index.ts

@@ -25,6 +25,7 @@ import RelicMainStatGroup from "./models/relic/RelicMainStatGroup";
 import RelicSet from "./models/relic/RelicSet";
 import RelicSetBonus from "./models/relic/RelicSetBonus";
 import RelicSubStatGroup from "./models/relic/RelicSubStatGroup";
+import RelicType from "./models/relic/RelicType";
 import CombatType from "./models/CombatType";
 import Path from "./models/Path";
 import StatProperty, { StatPropertyValue } from "./models/StatProperty";
@@ -63,6 +64,7 @@ export {
     RelicSet,
     RelicSetBonus,
     RelicSubStatGroup,
+    RelicType,
     CombatType,
     Path,
     StatProperty,
@@ -76,10 +78,10 @@ export { ClientOptions } from "./client/StarRail";
 export { ImageBaseUrl } from "./models/assets/ImageAssets";
 export { AttackType, EffectType } from "./models/character/skill/Skill";
 export { LightConeLevel } from "./models/light_cone/LightConeExpType";
-export { RelicType } from "./models/relic/RelicData";
 export { RelicLevel } from "./models/relic/RelicExpType";
 export { RelicMainStatData } from "./models/relic/RelicMainStatGroup";
 export { RelicSubStatData } from "./models/relic/RelicSubStatGroup";
+export { RelicTypeId } from "./models/relic/RelicType";
 export { CombatTypeId } from "./models/CombatType";
 export { PathId } from "./models/Path";
 export { StatPropertyType, OtherStatPropertyType } from "./models/StatProperty";

src/models/relic/RelicData.ts

@@ -7,9 +7,7 @@ import RelicSubStatGroup from "./RelicSubStatGroup";
 import RelicSet from "./RelicSet";
 import TextAssets from "../assets/TextAssets";
 import ImageAssets from "../assets/ImageAssets";
-
-/** @typedef */
-export type RelicType = "HEAD" | "HAND" | "BODY" | "FOOT" | "OBJECT" | "NECK";
+import RelicType, { RelicTypeId } from "./RelicType";
 
 /**
  * @en RelicData
@@ -72,7 +70,7 @@ class RelicData {
         this.name = new TextAssets(itemJson.getAsNumber("ItemName", "Hash"), this.client);
         this.description = new TextAssets(itemJson.getAsNumber("ItemBGDesc", "Hash"), this.client);
 
-        this.type = json.getAsString("Type") as RelicType;
+        this.type = new RelicType(json.getAsString("Type") as RelicTypeId, this.client);
 
         this.stars = Number(json.getAsString("Rarity").slice(-1));
 

src/models/relic/RelicType.ts

@@ -0,0 +1,56 @@
+import { JsonObject, JsonReader } from "config_file.js";
+import StarRail from "../../client/StarRail";
+import AssetsNotFoundError from "../../errors/AssetsNotFoundError";
+import TextAssets from "../assets/TextAssets";
+import ImageAssets from "../assets/ImageAssets";
+
+/**
+ * @typedef
+ * @example
+ * |RelicTypeId|In-game Name|
+ * |---|---|
+ * |HEAD|Head|
+ * |HAND|Hands|
+ * |BODY|Body|
+ * |FOOT|Feet|
+ * |OBJECT|Link Rope|
+ * |NECK|Planar Sphere|
+ */
+export type RelicTypeId = "HEAD" | "HAND" | "BODY" | "FOOT" | "OBJECT" | "NECK";
+
+/**
+ * @en RelicType
+ */
+class RelicType {
+    /**  */
+    readonly id: RelicTypeId;
+    /**  */
+    readonly client: StarRail;
+
+    /**  */
+    readonly name: TextAssets;
+    /**  */
+    readonly icon: ImageAssets;
+
+    readonly _data: JsonObject;
+
+    /**
+     * @param id
+     * @param client
+     */
+    constructor(id: RelicTypeId, client: StarRail) {
+        this.id = id;
+        this.client = client;
+
+        const _data = client.cachedAssetsManager.getStarRailCacheData("RelicBaseType")[this.id];
+        if (!_data) throw new AssetsNotFoundError("RelicType", this.id);
+        this._data = _data;
+
+        const json = new JsonReader(this._data);
+
+        this.name = new TextAssets(json.getAsNumber("BaseTypeText", "Hash"), this.client);
+        this.icon = new ImageAssets(json.getAsString("BaseTypeIconPath"), this.client);
+    }
+}
+
+export default RelicType;