maplestory-openapi 3.8.1 → 3.10.0

package/dist/esm/maplestory/api/kms/dto/battlePractice/battlePracticeReplayId.js

@@ -0,0 +1,36 @@
+/**
+ * 연무장 리플레이 식별자 목록
+ */
+class BattlePracticeReplayIdDto {
+    /**
+     * 리플레이 목록
+     */
+    replayList;
+    constructor(obj) {
+        this.replayList = obj.replay_list.map((r) => new BattlePracticeReplayIdInfoDto(r));
+    }
+}
+/**
+ * 연무장 리플레이 식별자 상세 정보
+ */
+class BattlePracticeReplayIdInfoDto {
+    /**
+     * 기간 번호 (연무장 초기화 시마다 1씩 증가됩니다.)
+     */
+    periodNo;
+    /**
+     * 리플레이 등록 일시 (KST)
+     */
+    registerDate;
+    /**
+     * 연무장 리플레이 고유 식별자
+     */
+    replayId;
+    constructor(obj) {
+        this.periodNo = obj.period_no;
+        this.registerDate = new Date(obj.register_date);
+        this.replayId = obj.replay_id;
+    }
+}
+
+export { BattlePracticeReplayIdDto, BattlePracticeReplayIdInfoDto };

package/dist/esm/maplestory/api/kms/dto/battlePractice/battlePracticeResult.js

@@ -0,0 +1,96 @@
+/**
+ * 연무장 측정 결과 정보
+ */
+class BattlePracticeResultDto {
+    /**
+     * 리플레이 등록 일시 (KST)
+     */
+    registerDate;
+    /**
+     * 총 연무 시간 (ms)
+     */
+    totalPlayTime;
+    /**
+     * 총합 데미지
+     */
+    totalDamage;
+    /**
+     * 초당 평균 데미지
+     */
+    totalDps;
+    /**
+     * 종료 타입 (1:자동 종료, 2:수동 종료, 3:시간 초과, 9:기타 종료)
+     */
+    endType;
+    /**
+     * 리플레이 추천 수
+     */
+    likeCount;
+    /**
+     * 스킬 단위 전투 분석 정보
+     */
+    skillStatistic;
+    constructor(obj) {
+        this.registerDate = new Date(obj.register_date);
+        this.totalPlayTime = obj.total_play_time;
+        this.totalDamage = obj.total_damage;
+        this.totalDps = obj.total_dps;
+        this.endType = obj.end_type;
+        this.likeCount = obj.like_count;
+        this.skillStatistic = obj.skill_statistic.map((s) => new BattlePracticeSkillStatisticDto(s));
+    }
+}
+/**
+ * 연무장 스킬 단위 전투 분석 정보
+ */
+class BattlePracticeSkillStatisticDto {
+    /**
+     * 스킬 명
+     */
+    skillName;
+    /**
+     * 누적 데미지
+     */
+    damage;
+    /**
+     * 데미지 점유율
+     */
+    damagePercent;
+    /**
+     * 초당 평균 데미지
+     */
+    dps;
+    /**
+     * 사용 횟수
+     */
+    useCount;
+    /**
+     * 1회당 평균 데미지
+     */
+    damagePerUse;
+    /**
+     * 공격 횟수
+     */
+    attackCount;
+    /**
+     * 최대 데미지 (1타)
+     */
+    maxDamage;
+    /**
+     * 최소 데미지 (1타)
+     */
+    minDamage;
+    constructor(obj) {
+        this.skillName = obj.skill_name;
+        this.damage = obj.damage;
+        this.damagePercent = obj.damage_percent;
+        this.dps = obj.dps;
+        this.useCount = obj.use_count;
+        this.damagePerUse = obj.damage_per_use;
+        this.attackCount = obj.attack_count;
+        this.maxDamage = obj.max_damage;
+        this.minDamage = obj.min_damage;
+    }
+}
+
+export { BattlePracticeResultDto, BattlePracticeSkillStatisticDto };

package/dist/esm/maplestory/api/kms/dto/battlePractice/battlePracticeSkillTimeline.js

@@ -0,0 +1,56 @@
+/**
+ * 연무장 스킬 사용 내역
+ */
+class BattlePracticeSkillTimelineDto {
+    /**
+     * 조회된 페이지 번호
+     */
+    pageNo;
+    /**
+     * 전체 페이지 번호
+     */
+    totalPageNo;
+    /**
+     * 스킬 타임라인 정보
+     */
+    skillTimeline;
+    constructor(obj) {
+        this.pageNo = obj.page_no;
+        this.totalPageNo = obj.total_page_no;
+        this.skillTimeline = obj.skill_timeline.map((event) => new BattlePracticeSkillTimelineEventDto(event));
+    }
+}
+/**
+ * 연무장 스킬 타임라인
+ */
+class BattlePracticeSkillTimelineEventDto {
+    /**
+     * 연무 시작 후 경과 시간 (ms)
+     */
+    elapseTime;
+    /**
+     * 사용한 스킬 명
+     */
+    skillName;
+    /**
+     * 헥사 스킬 특성 여부 (0:그 외 스킬, 1:오리진 스킬, 2:어센트 스킬)
+     */
+    hexaSkillSpecificityFlag;
+    /**
+     * 시퀀스 명
+     */
+    sequenceName;
+    /**
+     * 시퀀스 키
+     */
+    sequenceKey;
+    constructor(obj) {
+        this.elapseTime = obj.elapse_time;
+        this.skillName = obj.skill_name;
+        this.hexaSkillSpecificityFlag = obj.hexa_skill_specificity_flag;
+        this.sequenceName = obj.sequence_name;
+        this.sequenceKey = obj.sequence_key;
+    }
+}
+
+export { BattlePracticeSkillTimelineDto, BattlePracticeSkillTimelineEventDto };

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

@@ -308,9 +308,13 @@ class CharacterPetEquipmentItemDto extends CharacterPetEquipmentItemDto$1 {
      * 아이템 외형 아이콘
      */
     itemShapeIcon;
+    /**
+     * 아이템 만료시간 (KST, 분 단위는 일괄 0으로 표기, null:무제한, -1:미착용)
+     */
+    itemDateExpire;
     constructor(obj) {
         super();
-        const { item_name, item_icon, item_description, item_option, scroll_upgrade, scroll_upgradable, item_shape, item_shape_icon, } = obj;
+        const { item_name, item_icon, item_description, item_option, scroll_upgrade, scroll_upgradable, item_shape, item_shape_icon, item_date_expire, } = obj;
         this.itemName = item_name;
         this.itemIcon = item_icon;
         this.itemDescription = item_description;
@@ -319,6 +323,7 @@ class CharacterPetEquipmentItemDto extends CharacterPetEquipmentItemDto$1 {
         this.scrollUpgradable = scroll_upgradable;
         this.itemShape = item_shape;
         this.itemShapeIcon = item_shape_icon;
+        this.itemDateExpire = item_date_expire ? new Date(item_date_expire) : null;
     }
 }
 

package/dist/esm/maplestory/api/kms/dto/character/characterRingReserveSkillEquipment.js

@@ -0,0 +1,40 @@
+/**
+ * 캐릭터 예비 특수 반지 장착 정보
+ */
+class CharacterRingReserveSkillEquipmentDto {
+    /**
+     * 조회 기준일 (KST, 일 단위 데이터로 시, 분은 일괄 0으로 표기)
+     */
+    date;
+    /**
+     * 캐릭터 직업
+     */
+    characterClass;
+    /**
+     * 예비 특수 반지 슬롯에 장착한 특수 반지
+     */
+    specialRingReserveName;
+    /**
+     * 예비 특수 반지 슬롯에 장착한 특수 반지 레벨
+     */
+    specialRingReserveLevel;
+    /**
+     * 예비 특수 반지 슬롯에 장착한 특수 반지 아이콘
+     */
+    specialRingReserveIcon;
+    /**
+     * 예비 특수 반지 슬롯에 장착한 특수 반지 설명
+     */
+    specialRingReserveDescription;
+    constructor(obj) {
+        const { date, character_class, special_ring_reserve_name, special_ring_reserve_level, special_ring_reserve_icon, special_ring_reserve_description, } = obj;
+        this.date = date ? new Date(date) : null;
+        this.characterClass = character_class;
+        this.specialRingReserveName = special_ring_reserve_name;
+        this.specialRingReserveLevel = special_ring_reserve_level;
+        this.specialRingReserveIcon = special_ring_reserve_icon;
+        this.specialRingReserveDescription = special_ring_reserve_description;
+    }
+}
+
+export { CharacterRingReserveSkillEquipmentDto };

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

@@ -1,5 +1,9 @@
 export { MapleStoryApi } from './mapleStoryApi.js';
 export { MapleStoryFriendsApi } from './mapleStoryFriendsApi.js';
+export { BattlePracticeCharacterAbilityInfoDto, BattlePracticeCharacterAbilityObjectDto, BattlePracticeCharacterBasicDto, BattlePracticeCharacterBasicStatDto, BattlePracticeCharacterCashItemEquipmentDto, BattlePracticeCharacterCashItemObjectDto, BattlePracticeCharacterCashItemOptionDto, BattlePracticeCharacterFinalStatDto, BattlePracticeCharacterHexaCoreEquipmentDto, BattlePracticeCharacterHexaCoreObjectDto, BattlePracticeCharacterHexaLinkedSkillDto, BattlePracticeCharacterHexaMatrixObjectDto, BattlePracticeCharacterHexaMatrixStatObjectDto, BattlePracticeCharacterHexaStatCoreDto, BattlePracticeCharacterHyperStatDto, BattlePracticeCharacterHyperStatObjectDto, BattlePracticeCharacterInfoDto, BattlePracticeCharacterItemAddOptionDto, BattlePracticeCharacterItemBaseOptionDto, BattlePracticeCharacterItemDragonEquipmentDto, BattlePracticeCharacterItemEquipmentDto, BattlePracticeCharacterItemEquipmentObjectDto, BattlePracticeCharacterItemEtcOptionDto, BattlePracticeCharacterItemExceptionalOptionDto, BattlePracticeCharacterItemMechanicEquipmentDto, BattlePracticeCharacterItemObjectDto, BattlePracticeCharacterItemStarforceOptionDto, BattlePracticeCharacterItemTitleDto, BattlePracticeCharacterItemTotalOptionDto, BattlePracticeCharacterLinkSkillObjectDto, BattlePracticeCharacterOtherStatDetailDto, BattlePracticeCharacterOtherStatDto, BattlePracticeCharacterOtherStatInfoDto, BattlePracticeCharacterPetAutoSkillDto, BattlePracticeCharacterPetEquipmentDto, BattlePracticeCharacterPetEquipmentItemOptionDto, BattlePracticeCharacterPetObjectDto, BattlePracticeCharacterPropensityDto, BattlePracticeCharacterRingReserveSkillObjectDto, BattlePracticeCharacterSetEffectDto, BattlePracticeCharacterSetEffectInfoDto, BattlePracticeCharacterSetEffectObjectDto, BattlePracticeCharacterSkillInfoDto, BattlePracticeCharacterSkillObjectDto, BattlePracticeCharacterStatDto, BattlePracticeCharacterSymbolDto, BattlePracticeCharacterSymbolStatDto, BattlePracticeCharacterVCoreDto, BattlePracticeCharacterVMatrixObjectDto, BattlePracticeGuildObjectDto, BattlePracticeGuildSkillDto, BattlePracticeUnionArtifactEffectDto, BattlePracticeUnionArtifactObjectDto, BattlePracticeUnionChampionBadgeDto, BattlePracticeUnionChampionObjectDto, BattlePracticeUnionRaiderObjectDto } from './dto/battlePractice/battlePracticeCharacterInfo.js';
+export { BattlePracticeReplayIdDto, BattlePracticeReplayIdInfoDto } from './dto/battlePractice/battlePracticeReplayId.js';
+export { BattlePracticeResultDto, BattlePracticeSkillStatisticDto } from './dto/battlePractice/battlePracticeResult.js';
+export { BattlePracticeSkillTimelineDto, BattlePracticeSkillTimelineEventDto } from './dto/battlePractice/battlePracticeSkillTimeline.js';
 export { CharacterDto } from './dto/character/character.js';
 export { CharacterAbilityDto, CharacterAbilityInfoDto, CharacterAbilityPresetDto } from './dto/character/characterAbility.js';
 export { CharacterAndroidCashItemEquipmentColoringPrismDto, CharacterAndroidCashItemEquipmentDto, CharacterAndroidCashItemEquipmentOptionDto, CharacterAndroidEquipmentDto, CharacterAndroidEquipmentFaceDto, CharacterAndroidEquipmentHairDto, CharacterAndroidEquipmentPresetDto, CharacterAndroidEquipmentSkinDto } from './dto/character/characterAndroidEquipment.js';
@@ -21,6 +25,8 @@ export { CharacterSetEffectDto, CharacterSetEffectInfoDto, CharacterSetEffectOpt
 export { CharacterSkillDto, CharacterSkillInfoDto } from './dto/character/characterSkill.js';
 export { CharacterFinalStatDto, CharacterStatDto } from './dto/character/characterStat.js';
 export { CharacterSymbolEquipmentDto, CharacterSymbolEquipmentInfoDto } from './dto/character/characterSymbolEquipment.js';
+export { CharacterRingExchangeSkillEquipmentDto } from './dto/character/characterRingExchangeSkillEquipment.js';
+export { CharacterRingReserveSkillEquipmentDto } from './dto/character/characterRingReserveSkillEquipment.js';
 export { CharacterVMatrixCodeEquipmentDto, CharacterVMatrixDto } from './dto/character/characterVMatrix.js';
 export { GuildDto } from './dto/guild/guild.js';
 export { GuildBasicDto, GuildSkillDto } from './dto/guild/guildBasic.js';

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

@@ -1,6 +1,10 @@
 import axios from 'axios';
 import '../../../node_modules/buffer/index.js';
 import xml2js from 'xml2js';
+import { BattlePracticeCharacterInfoDto } from './dto/battlePractice/battlePracticeCharacterInfo.js';
+import { BattlePracticeReplayIdDto } from './dto/battlePractice/battlePracticeReplayId.js';
+import { BattlePracticeResultDto } from './dto/battlePractice/battlePracticeResult.js';
+import { BattlePracticeSkillTimelineDto } from './dto/battlePractice/battlePracticeSkillTimeline.js';
 import { CharacterDto } from './dto/character/character.js';
 import { CharacterAbilityDto } from './dto/character/characterAbility.js';
 import { CharacterAndroidEquipmentDto } from './dto/character/characterAndroidEquipment.js';
@@ -19,6 +23,7 @@ import { CharacterPetEquipmentDto } from './dto/character/characterPetEquipment.
 import { CharacterPopularityDto } from './dto/character/characterPopularity.js';
 import { CharacterPropensityDto } from './dto/character/characterPropensity.js';
 import { CharacterRingExchangeSkillEquipmentDto } from './dto/character/characterRingExchangeSkillEquipment.js';
+import { CharacterRingReserveSkillEquipmentDto } from './dto/character/characterRingReserveSkillEquipment.js';
 import { CharacterSetEffectDto } from './dto/character/characterSetEffect.js';
 import { CharacterSkillDto } from './dto/character/characterSkill.js';
 import { CharacterStatDto } from './dto/character/characterStat.js';
@@ -818,7 +823,8 @@ class MapleStoryApi extends MapleStoryApi$1 {
     /**
      * 링 익스체인지 스킬 등록 장비를 조회합니다.
      * - 메이플스토리 게임 데이터는 평균 15분 후 확인 가능합니다.
-     * - 2025년 8월 21일 데이터부터 조회할 수 있습니다.
+     * - 2025년 08월 21일부터 2026년 3월 18일까지의 데이터를 조회할 수 있습니다.
+     * - 2026년 3월 19일부터는 예비 특수 반지 장착 정보 조회를 사용해주세요.
      * - 과거 데이터는 원하는 일자를 입력해 조회할 수 있으며, 전일 데이터는 다음날 오전 2시부터 확인할 수 있습니다. (8월 22일 데이터 조회 시, 22일 00시부터 23일 00시 사이 데이터가 조회 됩니다.)
      * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
      * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
@@ -847,6 +853,38 @@ class MapleStoryApi extends MapleStoryApi$1 {
         }
         return new CharacterRingExchangeSkillEquipmentDto(data);
     }
+    /**
+     * 예비 특수 반지 장착 정보를 조회합니다.
+     * - 메이플스토리 게임 데이터는 평균 15분 후 확인 가능합니다.
+     * - 2026년 3월 19일 데이터부터 조회할 수 있습니다.
+     * - 과거 데이터는 원하는 일자를 입력해 조회할 수 있으며, 전일 데이터는 다음날 오전 2시부터 확인할 수 있습니다. (3월 20일 데이터 조회 시, 20일 00시부터 21일 00시 사이 데이터가 조회 됩니다.)
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    async getCharacterRingReserveSkillEquipment(ocid, dateOptions) {
+        const path = `${this.subUrl}/v1/character/ring-reserve-skill-equipment`;
+        const date = dateOptions
+            ? this.toDateString(dateOptions, {
+                year: 2026,
+                month: 3,
+                day: 19,
+            })
+            : undefined;
+        const query = {
+            ocid: ocid,
+            date: date,
+        };
+        const { data } = await this.client.get(path, {
+            params: query,
+        });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
+        return new CharacterRingReserveSkillEquipmentDto(data);
+    }
     //#endregion
     //#region 유니온 정보 조회
     /**
@@ -1036,6 +1074,82 @@ class MapleStoryApi extends MapleStoryApi$1 {
         }
         return new GuildBasicDto(data);
     }
+    //#endregion
+    //#region 연무장 정보 조회
+    /**
+     * 캐릭터의 연무장 리플레이 식별자를 조회합니다. 리플레이를 등록한 캐릭터에 대해서만 조회가 가능합니다.
+     * - 메이플스토리 게임 데이터는 평균 15분 후 확인 가능합니다.
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
+     *
+     * @param ocid 캐릭터 식별자
+     */
+    async getBattlePracticeReplayId(ocid) {
+        const path = `${this.subUrl}/v1/battle-practice/replay-id`;
+        const query = {
+            ocid: ocid,
+        };
+        const { data } = await this.client.get(path, {
+            params: query,
+        });
+        return new BattlePracticeReplayIdDto(data);
+    }
+    /**
+     * 연무장 측정 결과 정보를 조회합니다.
+     * - 메이플스토리 게임 데이터는 평균 15분 후 확인 가능합니다.
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
+     *
+     * @param replayId 연무장 리플레이 고유 식별자
+     */
+    async getBattlePracticeResult(replayId) {
+        const path = `${this.subUrl}/v1/battle-practice/result`;
+        const query = {
+            replay_id: replayId,
+        };
+        const { data } = await this.client.get(path, {
+            params: query,
+        });
+        return new BattlePracticeResultDto(data);
+    }
+    /**
+     * 연무장 진행 간 스킬 사용 내역을 조회합니다.
+     * - 메이플스토리 게임 데이터는 평균 15분 후 확인 가능합니다.
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
+     *
+     * @param replayId 연무장 리플레이 고유 식별자
+     * @param pageNo 페이지 번호 (미입력 시 1페이지 조회)
+     */
+    async getBattlePracticeSkillTimeline(replayId, pageNo) {
+        const path = `${this.subUrl}/v1/battle-practice/skill-timeline`;
+        const query = {
+            replay_id: replayId,
+            page_no: pageNo,
+        };
+        const { data } = await this.client.get(path, {
+            params: query,
+        });
+        return new BattlePracticeSkillTimelineDto(data);
+    }
+    /**
+     * 연무장 입장 시의 캐릭터 능력치 관련 정보를 조회합니다.
+     * - 메이플스토리 게임 데이터는 평균 15분 후 확인 가능합니다.
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     * - 해당 API는 메이플스토리 한국의 데이터가 제공됩니다.
+     *
+     * @param replayId 연무장 리플레이 고유 식별자
+     */
+    async getBattlePracticeCharacterInfo(replayId) {
+        const path = `${this.subUrl}/v1/battle-practice/character-info`;
+        const query = {
+            replay_id: replayId,
+        };
+        const { data } = await this.client.get(path, {
+            params: query,
+        });
+        return new BattlePracticeCharacterInfoDto(data);
+    }
     async getStarforceHistory(count, parameter) {
         const path = `${this.subUrl}/v1/history/starforce`;
         const query = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "maplestory-openapi",
-  "version": "3.8.1",
+  "version": "3.10.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,9 +87,9 @@
     "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-node": "^10.9.1",
+    "tslib": "^2.8.1",
     "tsm": "2.2.1",
     "typescript": "^5.2.2"
   },