Throws MihomoError in StarRail#fetchUser

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
     "cSpell.words": [
         "autodrain",
+        "Mihomo",
         "starfaring",
         "starrail",
         "Trailblaze",

CHANGELOG.md

@@ -1,6 +1,7 @@
 # 0.3.1
 - Added CharacterData#eidolons and Eidolon class.
 - Added CharacterData#skillTreeNodes.
+- Throws MihomoError if an error occurs when requesting with StarRail#fetchUser.
 # 0.3.0
 - Added StarRail#fetchUser.
 - Renamed RelicSubStat to RelicSubStatData.

src/client/StarRail.ts

@@ -7,6 +7,9 @@ import RelicData from "../models/relic/RelicData";
 import { fetchJSON } from "../utils/axios_utils";
 import RequestError from "../errors/RequestError";
 import User from "../models/User";
+import InvalidUidFormatError from "../errors/InvalidUidFormatError";
+import UserNotFoundError from "../errors/UserNotFoundError";
+import MihomoError from "../errors/MihomoError";
 
 const defaultImageBaseUrls: ImageBaseUrl[] = [];
 
@@ -49,6 +52,7 @@ class StarRail {
 
     /**
      * @param uid
+     * @throws {MihomoError}
      */
     async fetchUser(uid: number | string): Promise<User> {
         if (isNaN(Number(uid))) throw new Error("Parameter `uid` must be a number or a string number.");
@@ -60,6 +64,20 @@ class StarRail {
 
         if (response.status !== 200) {
             throw new RequestError(`Request failed with unknown status code ${response.status} - ${response.statusText}\nRequest url: ${url}`, response.status, response.statusText);
+        } else if (response.data["detail"]) {
+            switch (response.data["detail"]) {
+                case "Invalid uid":
+                    throw new InvalidUidFormatError(Number(uid));
+                default:
+                    throw new MihomoError(`Unknown error occurred. Error: ${response.data["detail"]}`);
+            }
+        } else if (response.data["ErrCode"]) {
+            switch (response.data["ErrCode"]) {
+                case 3612:
+                    throw new UserNotFoundError(Number(uid));
+                default:
+                    throw new MihomoError(`Unknown error occurred. ErrorCode: ${response.data["ErrCode"]}`);
+            }
         }
 
         return new User({ ...response.data }, this);

src/errors/InvalidUidFormatError.ts

@@ -0,0 +1,22 @@
+import MihomoError from "./MihomoError";
+
+/**
+ * @en InvalidUidFormatError
+ * @extends {MihomoError}
+ */
+class InvalidUidFormatError extends MihomoError {
+    /**  */
+    readonly uid: number;
+
+    /**
+     * @param uid
+     */
+    constructor(uid: number) {
+        super(`Invalid uid format. (${uid} provided.)`);
+
+        this.name = "InvalidUidFormatError";
+        this.uid = uid;
+    }
+}
+
+export default InvalidUidFormatError;

src/errors/MihomoError.ts

@@ -0,0 +1,14 @@
+/**
+ * @en MihomoError
+ * @extends {Error}
+ */
+class MihomoError extends Error {
+    /**
+     * @param message
+     */
+    constructor(message: string) {
+        super(message);
+    }
+}
+
+export default MihomoError;

src/errors/RequestError.ts

@@ -1,8 +1,10 @@
+import MihomoError from "./MihomoError";
+
 /**
  * @en RequestError
- * @extends {Error}
+ * @extends {MihomoError}
  */
-class RequestError extends Error {
+class RequestError extends MihomoError {
     /** HTTP response status code */
     readonly statusCode: number;
     /** The message of the status code */

src/errors/UserNotFoundError.ts

@@ -0,0 +1,22 @@
+import MihomoError from "./MihomoError";
+
+/**
+ * @en UserNotFoundError
+ * @extends {MihomoError}
+ */
+class UserNotFoundError extends MihomoError {
+    /**  */
+    readonly uid: number;
+
+    /**
+     * @param uid
+     */
+    constructor(uid: number) {
+        super(`The user with uid ${uid} was not found.`);
+
+        this.name = "UserNotFoundError";
+        this.uid = uid;
+    }
+}
+
+export default UserNotFoundError;

src/index.ts

@@ -2,13 +2,17 @@ import CachedAssetsManager from "./client/CachedAssetsManager";
 import ObjectKeysManager from "./client/ObjectKeysManager";
 import StarRail from "./client/StarRail";
 import AssetsNotFoundError from "./errors/AssetsNotFoundError";
+import InvalidUidFormatError from "./errors/InvalidUidFormatError";
+import MihomoError from "./errors/MihomoError";
 import RequestError from "./errors/RequestError";
+import UserNotFoundError from "./errors/UserNotFoundError";
 import ImageAssets from "./models/assets/ImageAssets";
 import TextAssets from "./models/assets/TextAssets";
 import LeveledSkill from "./models/character/skill/LeveledSkill";
 import Skill from "./models/character/skill/Skill";
 import Character from "./models/character/Character";
 import CharacterData from "./models/character/CharacterData";
+import Eidolon from "./models/character/Eidolon";
 import LightCone from "./models/light_cone/LightCone";
 import LightConeData from "./models/light_cone/LightConeData";
 import LightConeExpType from "./models/light_cone/LightConeExpType";
@@ -31,13 +35,17 @@ export {
     ObjectKeysManager,
     StarRail,
     AssetsNotFoundError,
+    InvalidUidFormatError,
+    MihomoError,
     RequestError,
+    UserNotFoundError,
     ImageAssets,
     TextAssets,
     LeveledSkill,
     Skill,
     Character,
     CharacterData,
+    Eidolon,
     LightCone,
     LightConeData,
     LightConeExpType,
@@ -72,4 +80,5 @@ export { StatPropertyType } from "./models/StatProperty";
 export { Birthday } from "./models/User";
 
 // functions
-export { fetchJSON } from "./utils/axios_utils";
+export { fetchJSON } from "./utils/axios_utils";
+export { getStableHash } from "./utils/hash_utils";

src/models/User.ts

@@ -65,7 +65,6 @@ class User {
 
         this._data = data;
 
-        // TODO: error handling (e.g. user does not exist)
         const json = new JsonReader(this._data);
         const playerDetailInfo = json.get("PlayerDetailInfo");