maplestory-openapi 3.9.0 → 3.11.0

package/dist/esm/maplestory/api/tms/dto/character/characterFamiliar.js

@@ -0,0 +1,149 @@
+/**
+ * 萌獸 資訊
+ */
+class CharacterFamiliarDto {
+    /**
+     * 要搜尋的日期 (TST，每日資料中的小時與分鐘將顯示為 0)
+     */
+    date;
+    /**
+     * 萌獸 鏈路插槽資訊
+     */
+    familiarLinkSlot;
+    /**
+     * 萌獸 細節
+     */
+    familiarInfo;
+    constructor(obj) {
+        const { date, familiar_link_slot, familiar_info } = obj;
+        this.date = date ? new Date(date) : null;
+        this.familiarLinkSlot = familiar_link_slot.map((x) => new CharacterFamiliarLinkSlotDto(x));
+        this.familiarInfo = familiar_info.map((x) => new CharacterFamiliarInfoDto(x));
+    }
+}
+/**
+ * 萌獸 鏈路插槽資訊
+ */
+class CharacterFamiliarLinkSlotDto {
+    /**
+     * 插槽標識符 (1~3, vip)
+     */
+    slotId;
+    /**
+     * 連結的 萌獸 名稱 (如果插槽中沒有任何關聯，則為 null)
+     */
+    familiarName;
+    /**
+     * 已啟用還是未啟用 (true, false)
+     */
+    activeFlag;
+    /**
+     * 截止日期
+     */
+    expireDate;
+    constructor(obj) {
+        const { slot_id, familiar_name, active_flag, expire_date } = obj;
+        this.slotId = slot_id;
+        this.familiarName = familiar_name;
+        this.activeFlag = active_flag;
+        this.expireDate = expire_date ? new Date(expire_date) : null;
+    }
+}
+/**
+ * 萌獸 細節
+ */
+class CharacterFamiliarInfoDto {
+    /**
+     * 萌獸 名稱
+     */
+    familiarName;
+    /**
+     * 萌獸 暱稱
+     */
+    familiarNickname;
+    /**
+     * 特別與否
+     */
+    familiarSpecialFlag;
+    /**
+     * 萌獸 情況
+     */
+    familiarState;
+    /**
+     * 等級
+     */
+    familiarLevel;
+    /**
+     * 經驗
+     */
+    familiarExp;
+    /**
+     * 具備的技能
+     */
+    skillName;
+    /**
+     * 選項等級
+     */
+    optionLevel;
+    /**
+     * 選項訊息
+     */
+    option;
+    /**
+     * 等級
+     */
+    familiarGrade;
+    /**
+     * 外觀名稱
+     */
+    lookName;
+    /**
+     * 當前是否已被召喚
+     */
+    summonedFlag;
+    /**
+     * 連結槽索引 (1~3, vip, not link)
+     */
+    slotId;
+    constructor(obj) {
+        const { familiar_name, familiar_nickname, familiar_special_flag, familiar_state, familiar_level, familiar_exp, skill_name, option_level, option, familiar_grade, look_name, summoned_flag, slot_id, } = obj;
+        this.familiarName = familiar_name;
+        this.familiarNickname = familiar_nickname;
+        this.familiarSpecialFlag = familiar_special_flag;
+        this.familiarState = familiar_state;
+        this.familiarLevel = familiar_level;
+        this.familiarExp = familiar_exp;
+        this.skillName = skill_name;
+        this.optionLevel = option_level;
+        this.option = option.map((x) => new CharacterFamiliarInfoOptionDto(x));
+        this.familiarGrade = familiar_grade;
+        this.lookName = look_name;
+        this.summonedFlag = summoned_flag;
+        this.slotId = slot_id;
+    }
+}
+/**
+ * 選項訊息
+ */
+class CharacterFamiliarInfoOptionDto {
+    /**
+     * 選項號
+     */
+    optionNo;
+    /**
+     * 選項名稱
+     */
+    optionName;
+    /**
+     * 選擇權價值
+     */
+    optionValue;
+    constructor(obj) {
+        const { option_no, option_name, option_value } = obj;
+        this.optionNo = option_no;
+        this.optionName = option_name;
+        this.optionValue = option_value;
+    }
+}
+
+export { CharacterFamiliarDto, CharacterFamiliarInfoDto, CharacterFamiliarInfoOptionDto, CharacterFamiliarLinkSlotDto };

package/dist/esm/maplestory/api/tms/dto/character/characterPetEquipment.js

@@ -56,6 +56,10 @@ class CharacterPetEquipmentDto extends CharacterPetEquipmentDto$1 {
      * 寵物 1 外型圖示
      */
     pet1AppearanceIcon;
+    /**
+     * 寵物1 潛在的
+     */
+    pet1Potential;
     /**
      * 寵物 2 名稱
      */
@@ -104,6 +108,10 @@ class CharacterPetEquipmentDto extends CharacterPetEquipmentDto$1 {
      * 寵物 2 外型圖示
      */
     pet2AppearanceIcon;
+    /**
+     * 寵物2 潛在的
+     */
+    pet2Potential;
     /**
      * 寵物 3 名稱
      */
@@ -152,9 +160,13 @@ class CharacterPetEquipmentDto extends CharacterPetEquipmentDto$1 {
      * 寵物 3 外型圖示
      */
     pet3AppearanceIcon;
+    /**
+     * 寵物3 潛在的
+     */
+    pet3Potential;
     constructor(obj) {
         super();
-        const { date, pet_1_name, pet_1_nickname, pet_1_icon, pet_1_description, pet_1_equipment, pet_1_auto_skill, pet_1_pet_type, pet_1_skill, pet_1_date_expire, pet_1_appearance, pet_1_appearance_icon, pet_2_name, pet_2_nickname, pet_2_icon, pet_2_description, pet_2_equipment, pet_2_auto_skill, pet_2_pet_type, pet_2_skill, pet_2_date_expire, pet_2_appearance, pet_2_appearance_icon, pet_3_name, pet_3_nickname, pet_3_icon, pet_3_description, pet_3_equipment, pet_3_auto_skill, pet_3_pet_type, pet_3_skill, pet_3_date_expire, pet_3_appearance, pet_3_appearance_icon, } = obj;
+        const { date, pet_1_name, pet_1_nickname, pet_1_icon, pet_1_description, pet_1_equipment, pet_1_auto_skill, pet_1_pet_type, pet_1_skill, pet_1_date_expire, pet_1_appearance, pet_1_appearance_icon, pet_1_potential, pet_2_name, pet_2_nickname, pet_2_icon, pet_2_description, pet_2_equipment, pet_2_auto_skill, pet_2_pet_type, pet_2_skill, pet_2_date_expire, pet_2_appearance, pet_2_appearance_icon, pet_2_potential, pet_3_name, pet_3_nickname, pet_3_icon, pet_3_description, pet_3_equipment, pet_3_auto_skill, pet_3_pet_type, pet_3_skill, pet_3_date_expire, pet_3_appearance, pet_3_appearance_icon, pet_3_potential, } = obj;
         this.date = date ? new Date(date) : null;
         this.pet1Name = pet_1_name;
         this.pet1Nickname = pet_1_nickname;
@@ -170,6 +182,7 @@ class CharacterPetEquipmentDto extends CharacterPetEquipmentDto$1 {
         this.pet1Skill = pet_1_skill;
         this.pet1Appearance = pet_1_appearance;
         this.pet1AppearanceIcon = pet_1_appearance_icon;
+        this.pet1Potential = pet_1_potential.map((potential) => new CharacterPetEquipmentPotentialDto(potential));
         this.pet2Name = pet_2_name;
         this.pet2Nickname = pet_2_nickname;
         this.pet2Icon = pet_2_icon;
@@ -184,6 +197,7 @@ class CharacterPetEquipmentDto extends CharacterPetEquipmentDto$1 {
         this.pet2Skill = pet_2_skill;
         this.pet2Appearance = pet_2_appearance;
         this.pet2AppearanceIcon = pet_2_appearance_icon;
+        this.pet2Potential = pet_2_potential.map((potential) => new CharacterPetEquipmentPotentialDto(potential));
         this.pet3Name = pet_3_name;
         this.pet3Nickname = pet_3_nickname;
         this.pet3Icon = pet_3_icon;
@@ -198,6 +212,7 @@ class CharacterPetEquipmentDto extends CharacterPetEquipmentDto$1 {
         this.pet3Skill = pet_3_skill;
         this.pet3Appearance = pet_3_appearance;
         this.pet3AppearanceIcon = pet_3_appearance_icon;
+        this.pet3Potential = pet_3_potential.map((potential) => new CharacterPetEquipmentPotentialDto(potential));
         if (pet_1_date_expire === 'expired') {
             this.pet1Expired = true;
         }
@@ -321,5 +336,33 @@ class CharacterPetEquipmentItemDto extends CharacterPetEquipmentItemDto$1 {
         this.itemShapeIcon = item_shape_icon;
     }
 }
+/**
+ * 寵物 潛在的
+ */
+class CharacterPetEquipmentPotentialDto {
+    /**
+     * 潛在的 步 (1~3, 0:停用)
+     */
+    potentialStep;
+    /**
+     * 潛在的 類型
+     */
+    potentialType;
+    /**
+     * 潛在的 增加 (對於攻擊力/魔法攻擊力以外的其他潛在能力類型，百分比)
+     */
+    potentialIncrease1;
+    /**
+     * 潛在的 增加 2 (如果潛在能力類型為攻擊力/魔法攻擊力，則攻擊力分配給 potential_increase_1，魔法攻擊力分配給 potential_increase_2；如果潛在能力類型為最大生命值/最大魔法值，則最大生命值分配給 potential_increase_1，最大魔法值分配給 potential_increase_2。)
+     */
+    potentialIncrease2;
+    constructor(obj) {
+        const { potential_step, potential_type, potential_increase1, potential_increase2, } = obj;
+        this.potentialStep = potential_step;
+        this.potentialType = potential_type;
+        this.potentialIncrease1 = potential_increase1;
+        this.potentialIncrease2 = potential_increase2;
+    }
+}
 
-export { CharacterPetEquipmentAutoSkillDto, CharacterPetEquipmentDto, CharacterPetEquipmentItemDto, CharacterPetEquipmentItemOptionDto };
+export { CharacterPetEquipmentAutoSkillDto, CharacterPetEquipmentDto, CharacterPetEquipmentItemDto, CharacterPetEquipmentItemOptionDto, CharacterPetEquipmentPotentialDto };

package/dist/esm/maplestory/api/tms/mapleStoryApi.js

@@ -1,5 +1,6 @@
 import axios from 'axios';
 import '../../../node_modules/buffer/index.js';
+import { removeQuery } from '../common/lib.js';
 import { CharacterDto } from './dto/character/character.js';
 import { CharacterAbilityDto } from './dto/character/characterAbility.js';
 import { CharacterAndroidEquipmentDto } from './dto/character/characterAndroidEquipment.js';
@@ -7,6 +8,7 @@ import { CharacterBasicDto } from './dto/character/characterBasic.js';
 import { CharacterBeautyEquipmentDto } from './dto/character/characterBeautyEquipment.js';
 import { CharacterCashItemEquipmentDto } from './dto/character/characterCashItemEquipment.js';
 import { CharacterDojangDto } from './dto/character/characterDojang.js';
+import { CharacterFamiliarDto } from './dto/character/characterFamiliar.js';
 import { CharacterHexaMatrixDto } from './dto/character/characterHexaMatrix.js';
 import { CharacterHexaMatrixStatDto } from './dto/character/characterHexaMatrixStat.js';
 import { CharacterHyperStatDto } from './dto/character/characterHyperStat.js';
@@ -29,7 +31,6 @@ import { UnionChampionDto } from './dto/union/unionChampion.js';
 import { UnionRaiderDto } from './dto/union/unionRaider.js';
 import { CharacterImageAction, CharacterImageEmotion, CharacterImageWeaponMotion } from '../common/enum/characterImage.js';
 import { MapleStoryApi as MapleStoryApi$1 } from '../common/mapleStoryApi.js';
-import { removeQuery } from '../common/lib.js';
 import { __exports as buffer } from '../../../_virtual/index.js_commonjs-exports.js';
 
 /**
@@ -717,6 +718,37 @@ class MapleStoryApi extends MapleStoryApi$1 {
         }
         return new CharacterDojangDto(data);
     }
+    /**
+     * 檢視萌獸資訊。
+     * - 楓之谷遊戲資料平均在 15 分鐘後即可使用。
+     * - 您可以從 2025 年 10 月 15 日起搜尋資料。
+     * - 您可以輸入所需日期以搜尋過往資料。前一日的資料將於翌日凌晨 2:00 起提供。(當您搜尋 10 月 15 日的資料時，將會擷取從 15 日 00:00 到 16 日 00:00 的資料。)
+     * - 由於遊戲內容變動，OCID 可能會有所變更。在更新以 OCID 為基礎的服務時，請務必留意。
+     * - 此 API 提供來自楓之谷台灣的資料。
+     * @param ocid 角色辨識器
+     * @param dateOptions 要搜尋的日期 (TST)
+     */
+    async getCharacterFamiliar(ocid, dateOptions) {
+        const path = `${this.subUrl}/v1/character/familiar`;
+        const date = dateOptions
+            ? this.toDateString(dateOptions, {
+                year: 2025,
+                month: 10,
+                day: 15,
+            })
+            : undefined;
+        const query = {
+            ocid: ocid,
+            date: date,
+        };
+        const { data } = await this.client.get(path, {
+            params: query,
+        });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
+        return new CharacterFamiliarDto(data);
+    }
     //#endregion
     //#region 檢視聯盟資訊
     /**

package/dist/esm/maplestory/api/tms/tms.js

@@ -6,13 +6,14 @@ export { CharacterBasicDto } from './dto/character/characterBasic.js';
 export { CharacterBeautyEquipmentDto, CharacterBeautyEquipmentFaceDto, CharacterBeautyEquipmentHairDto, CharacterBeautyEquipmentSkinDto } from './dto/character/characterBeautyEquipment.js';
 export { CharacterCashItemEquipmentColoringPrismDto, CharacterCashItemEquipmentDto, CharacterCashItemEquipmentOptionDto, CharacterCashItemEquipmentPresetDto } from './dto/character/characterCashItemEquipment.js';
 export { CharacterDojangDto } from './dto/character/characterDojang.js';
+export { CharacterFamiliarDto, CharacterFamiliarInfoDto, CharacterFamiliarInfoOptionDto, CharacterFamiliarLinkSlotDto } from './dto/character/characterFamiliar.js';
 export { CharacterHexaMatrixDto, CharacterHexaMatrixEquipmentDto, CharacterHexaMatrixEquipmentLinkedSkillDto } from './dto/character/characterHexaMatrix.js';
 export { CharacterHexaMatrixStatCoreDto, CharacterHexaMatrixStatDto } from './dto/character/characterHexaMatrixStat.js';
 export { CharacterHyperStatDto, CharacterHyperStatPresetDto } from './dto/character/characterHyperStat.js';
 export { CharacterImageDto } from './dto/character/characterImage.js';
 export { CharacterItemEquipmentAddOptionDto, CharacterItemEquipmentBaseOptionDto, CharacterItemEquipmentDragonInfoDto, CharacterItemEquipmentDto, CharacterItemEquipmentEtcOptionDto, CharacterItemEquipmentExceptionalOptionDto, CharacterItemEquipmentInfoDto, CharacterItemEquipmentMechanicInfoDto, CharacterItemEquipmentMedalShapeDto, CharacterItemEquipmentStarforceOptionDto, CharacterItemEquipmentTitleDto, CharacterItemEquipmentTotalOptionDto } from './dto/character/characterItemEquipment.js';
 export { CharacterLinkSkillDto, CharacterLinkSkillInfoDto } from './dto/character/characterLinkSkill.js';
-export { CharacterPetEquipmentAutoSkillDto, CharacterPetEquipmentDto, CharacterPetEquipmentItemDto, CharacterPetEquipmentItemOptionDto } from './dto/character/characterPetEquipment.js';
+export { CharacterPetEquipmentAutoSkillDto, CharacterPetEquipmentDto, CharacterPetEquipmentItemDto, CharacterPetEquipmentItemOptionDto, CharacterPetEquipmentPotentialDto } from './dto/character/characterPetEquipment.js';
 export { CharacterPopularityDto } from './dto/character/characterPopularity.js';
 export { CharacterPropensityDto } from './dto/character/characterPropensity.js';
 export { CharacterSetEffectDto, CharacterSetEffectInfoDto, CharacterSetEffectOptionFullDto, CharacterSetEffectSetDto } from './dto/character/characterSetEffect.js';

package/dist/esm/node_modules/base64-js/index.js

@@ -1,5 +1,5 @@
-import { __exports as base64Js } from '../../_virtual/index.js_commonjs-exports3.js';
-export { __exports as default } from '../../_virtual/index.js_commonjs-exports3.js';
+import { __exports as base64Js } from '../../_virtual/index.js_commonjs-exports2.js';
+export { __exports as default } from '../../_virtual/index.js_commonjs-exports2.js';
 
 base64Js.byteLength = byteLength;
 base64Js.toByteArray = toByteArray;

package/dist/esm/node_modules/buffer/index.js

@@ -2,8 +2,8 @@ import { __exports as buffer } from '../../_virtual/index.js_commonjs-exports.js
 export { __exports as default } from '../../_virtual/index.js_commonjs-exports.js';
 import '../base64-js/index.js';
 import '../ieee754/index.js';
-import { __exports as base64Js } from '../../_virtual/index.js_commonjs-exports3.js';
-import { __exports as ieee754 } from '../../_virtual/index.js_commonjs-exports2.js';
+import { __exports as base64Js } from '../../_virtual/index.js_commonjs-exports2.js';
+import { __exports as ieee754 } from '../../_virtual/index.js_commonjs-exports3.js';
 
 /*!
  * The buffer module from node.js, for the browser.

package/dist/esm/node_modules/ieee754/index.js

@@ -1,5 +1,5 @@
-import { __exports as ieee754 } from '../../_virtual/index.js_commonjs-exports2.js';
-export { __exports as default } from '../../_virtual/index.js_commonjs-exports2.js';
+import { __exports as ieee754 } from '../../_virtual/index.js_commonjs-exports3.js';
+export { __exports as default } from '../../_virtual/index.js_commonjs-exports3.js';
 
 /*! ieee754. BSD-3-Clause License. Feross Aboukhadijeh <https://feross.org/opensource> */
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "maplestory-openapi",
-  "version": "3.9.0",
+  "version": "3.11.0",
   "description": "This JavaScript library enables the use of the MapleStory OpenAPI of Nexon.",
   "keywords": [
     "maplestory",
@@ -53,7 +53,7 @@
     "types"
   ],
   "scripts": {
-    "build": "rollup -c",
+    "build": "rollup -c && tsc -p tsconfig.build.json --emitDeclarationOnly --rootDir src --outDir types",
     "js_sample": "node sample/js_sample.js",
     "lint": "eslint ./src/** --fix",
     "format": "prettier --write ./**/*.{ts,js}",
@@ -70,6 +70,7 @@
   "devDependencies": {
     "@rollup/plugin-commonjs": "^21.1.0",
     "@rollup/plugin-node-resolve": "13.1.3",
+    "@rollup/plugin-typescript": "^11.1.6",
     "@types/jest": "^29.5.12",
     "@types/xml2js": "^0.4.14",
     "@typescript-eslint/eslint-plugin": "^6.15.0",
@@ -86,11 +87,11 @@
     "prettier": "^3.1.1",
     "rollup": "2.66.1",
     "rollup-plugin-terser": "7.0.2",
-    "rollup-plugin-typescript2": "0.27.1",
-    "ts-jest": "^29.1.4",
+    "ts-jest": "^29.4.11",
     "ts-node": "^10.9.1",
+    "tslib": "^2.8.1",
     "tsm": "2.2.1",
-    "typescript": "^5.2.2"
+    "typescript": "^6.0.3"
   },
   "engines": {
     "node": ">=12"