maplestory-openapi 3.9.0 → 3.10.0

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

@@ -0,0 +1,41 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * 연무장 리플레이 식별자 목록
+ */
+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;
+    }
+}
+
+exports.BattlePracticeReplayIdDto = BattlePracticeReplayIdDto;
+exports.BattlePracticeReplayIdInfoDto = BattlePracticeReplayIdInfoDto;

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

@@ -0,0 +1,101 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * 연무장 측정 결과 정보
+ */
+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;
+    }
+}
+
+exports.BattlePracticeResultDto = BattlePracticeResultDto;
+exports.BattlePracticeSkillStatisticDto = BattlePracticeSkillStatisticDto;

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

@@ -0,0 +1,61 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * 연무장 스킬 사용 내역
+ */
+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;
+    }
+}
+
+exports.BattlePracticeSkillTimelineDto = BattlePracticeSkillTimelineDto;
+exports.BattlePracticeSkillTimelineEventDto = BattlePracticeSkillTimelineEventDto;

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

@@ -4,6 +4,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var mapleStoryApi = require('./mapleStoryApi.js');
 var mapleStoryFriendsApi = require('./mapleStoryFriendsApi.js');
+var battlePracticeCharacterInfo = require('./dto/battlePractice/battlePracticeCharacterInfo.js');
+var battlePracticeReplayId = require('./dto/battlePractice/battlePracticeReplayId.js');
+var battlePracticeResult = require('./dto/battlePractice/battlePracticeResult.js');
+var battlePracticeSkillTimeline = require('./dto/battlePractice/battlePracticeSkillTimeline.js');
 var character = require('./dto/character/character.js');
 var characterAbility = require('./dto/character/characterAbility.js');
 var characterAndroidEquipment = require('./dto/character/characterAndroidEquipment.js');
@@ -59,6 +63,68 @@ var inspectionInfo = require('./dto/inspectionInfo.js');
 
 exports.MapleStoryApi = mapleStoryApi.MapleStoryApi;
 exports.MapleStoryFriendsApi = mapleStoryFriendsApi.MapleStoryFriendsApi;
+exports.BattlePracticeCharacterAbilityInfoDto = battlePracticeCharacterInfo.BattlePracticeCharacterAbilityInfoDto;
+exports.BattlePracticeCharacterAbilityObjectDto = battlePracticeCharacterInfo.BattlePracticeCharacterAbilityObjectDto;
+exports.BattlePracticeCharacterBasicDto = battlePracticeCharacterInfo.BattlePracticeCharacterBasicDto;
+exports.BattlePracticeCharacterBasicStatDto = battlePracticeCharacterInfo.BattlePracticeCharacterBasicStatDto;
+exports.BattlePracticeCharacterCashItemEquipmentDto = battlePracticeCharacterInfo.BattlePracticeCharacterCashItemEquipmentDto;
+exports.BattlePracticeCharacterCashItemObjectDto = battlePracticeCharacterInfo.BattlePracticeCharacterCashItemObjectDto;
+exports.BattlePracticeCharacterCashItemOptionDto = battlePracticeCharacterInfo.BattlePracticeCharacterCashItemOptionDto;
+exports.BattlePracticeCharacterFinalStatDto = battlePracticeCharacterInfo.BattlePracticeCharacterFinalStatDto;
+exports.BattlePracticeCharacterHexaCoreEquipmentDto = battlePracticeCharacterInfo.BattlePracticeCharacterHexaCoreEquipmentDto;
+exports.BattlePracticeCharacterHexaCoreObjectDto = battlePracticeCharacterInfo.BattlePracticeCharacterHexaCoreObjectDto;
+exports.BattlePracticeCharacterHexaLinkedSkillDto = battlePracticeCharacterInfo.BattlePracticeCharacterHexaLinkedSkillDto;
+exports.BattlePracticeCharacterHexaMatrixObjectDto = battlePracticeCharacterInfo.BattlePracticeCharacterHexaMatrixObjectDto;
+exports.BattlePracticeCharacterHexaMatrixStatObjectDto = battlePracticeCharacterInfo.BattlePracticeCharacterHexaMatrixStatObjectDto;
+exports.BattlePracticeCharacterHexaStatCoreDto = battlePracticeCharacterInfo.BattlePracticeCharacterHexaStatCoreDto;
+exports.BattlePracticeCharacterHyperStatDto = battlePracticeCharacterInfo.BattlePracticeCharacterHyperStatDto;
+exports.BattlePracticeCharacterHyperStatObjectDto = battlePracticeCharacterInfo.BattlePracticeCharacterHyperStatObjectDto;
+exports.BattlePracticeCharacterInfoDto = battlePracticeCharacterInfo.BattlePracticeCharacterInfoDto;
+exports.BattlePracticeCharacterItemAddOptionDto = battlePracticeCharacterInfo.BattlePracticeCharacterItemAddOptionDto;
+exports.BattlePracticeCharacterItemBaseOptionDto = battlePracticeCharacterInfo.BattlePracticeCharacterItemBaseOptionDto;
+exports.BattlePracticeCharacterItemDragonEquipmentDto = battlePracticeCharacterInfo.BattlePracticeCharacterItemDragonEquipmentDto;
+exports.BattlePracticeCharacterItemEquipmentDto = battlePracticeCharacterInfo.BattlePracticeCharacterItemEquipmentDto;
+exports.BattlePracticeCharacterItemEquipmentObjectDto = battlePracticeCharacterInfo.BattlePracticeCharacterItemEquipmentObjectDto;
+exports.BattlePracticeCharacterItemEtcOptionDto = battlePracticeCharacterInfo.BattlePracticeCharacterItemEtcOptionDto;
+exports.BattlePracticeCharacterItemExceptionalOptionDto = battlePracticeCharacterInfo.BattlePracticeCharacterItemExceptionalOptionDto;
+exports.BattlePracticeCharacterItemMechanicEquipmentDto = battlePracticeCharacterInfo.BattlePracticeCharacterItemMechanicEquipmentDto;
+exports.BattlePracticeCharacterItemObjectDto = battlePracticeCharacterInfo.BattlePracticeCharacterItemObjectDto;
+exports.BattlePracticeCharacterItemStarforceOptionDto = battlePracticeCharacterInfo.BattlePracticeCharacterItemStarforceOptionDto;
+exports.BattlePracticeCharacterItemTitleDto = battlePracticeCharacterInfo.BattlePracticeCharacterItemTitleDto;
+exports.BattlePracticeCharacterItemTotalOptionDto = battlePracticeCharacterInfo.BattlePracticeCharacterItemTotalOptionDto;
+exports.BattlePracticeCharacterLinkSkillObjectDto = battlePracticeCharacterInfo.BattlePracticeCharacterLinkSkillObjectDto;
+exports.BattlePracticeCharacterOtherStatDetailDto = battlePracticeCharacterInfo.BattlePracticeCharacterOtherStatDetailDto;
+exports.BattlePracticeCharacterOtherStatDto = battlePracticeCharacterInfo.BattlePracticeCharacterOtherStatDto;
+exports.BattlePracticeCharacterOtherStatInfoDto = battlePracticeCharacterInfo.BattlePracticeCharacterOtherStatInfoDto;
+exports.BattlePracticeCharacterPetAutoSkillDto = battlePracticeCharacterInfo.BattlePracticeCharacterPetAutoSkillDto;
+exports.BattlePracticeCharacterPetEquipmentDto = battlePracticeCharacterInfo.BattlePracticeCharacterPetEquipmentDto;
+exports.BattlePracticeCharacterPetEquipmentItemOptionDto = battlePracticeCharacterInfo.BattlePracticeCharacterPetEquipmentItemOptionDto;
+exports.BattlePracticeCharacterPetObjectDto = battlePracticeCharacterInfo.BattlePracticeCharacterPetObjectDto;
+exports.BattlePracticeCharacterPropensityDto = battlePracticeCharacterInfo.BattlePracticeCharacterPropensityDto;
+exports.BattlePracticeCharacterRingReserveSkillObjectDto = battlePracticeCharacterInfo.BattlePracticeCharacterRingReserveSkillObjectDto;
+exports.BattlePracticeCharacterSetEffectDto = battlePracticeCharacterInfo.BattlePracticeCharacterSetEffectDto;
+exports.BattlePracticeCharacterSetEffectInfoDto = battlePracticeCharacterInfo.BattlePracticeCharacterSetEffectInfoDto;
+exports.BattlePracticeCharacterSetEffectObjectDto = battlePracticeCharacterInfo.BattlePracticeCharacterSetEffectObjectDto;
+exports.BattlePracticeCharacterSkillInfoDto = battlePracticeCharacterInfo.BattlePracticeCharacterSkillInfoDto;
+exports.BattlePracticeCharacterSkillObjectDto = battlePracticeCharacterInfo.BattlePracticeCharacterSkillObjectDto;
+exports.BattlePracticeCharacterStatDto = battlePracticeCharacterInfo.BattlePracticeCharacterStatDto;
+exports.BattlePracticeCharacterSymbolDto = battlePracticeCharacterInfo.BattlePracticeCharacterSymbolDto;
+exports.BattlePracticeCharacterSymbolStatDto = battlePracticeCharacterInfo.BattlePracticeCharacterSymbolStatDto;
+exports.BattlePracticeCharacterVCoreDto = battlePracticeCharacterInfo.BattlePracticeCharacterVCoreDto;
+exports.BattlePracticeCharacterVMatrixObjectDto = battlePracticeCharacterInfo.BattlePracticeCharacterVMatrixObjectDto;
+exports.BattlePracticeGuildObjectDto = battlePracticeCharacterInfo.BattlePracticeGuildObjectDto;
+exports.BattlePracticeGuildSkillDto = battlePracticeCharacterInfo.BattlePracticeGuildSkillDto;
+exports.BattlePracticeUnionArtifactEffectDto = battlePracticeCharacterInfo.BattlePracticeUnionArtifactEffectDto;
+exports.BattlePracticeUnionArtifactObjectDto = battlePracticeCharacterInfo.BattlePracticeUnionArtifactObjectDto;
+exports.BattlePracticeUnionChampionBadgeDto = battlePracticeCharacterInfo.BattlePracticeUnionChampionBadgeDto;
+exports.BattlePracticeUnionChampionObjectDto = battlePracticeCharacterInfo.BattlePracticeUnionChampionObjectDto;
+exports.BattlePracticeUnionRaiderObjectDto = battlePracticeCharacterInfo.BattlePracticeUnionRaiderObjectDto;
+exports.BattlePracticeReplayIdDto = battlePracticeReplayId.BattlePracticeReplayIdDto;
+exports.BattlePracticeReplayIdInfoDto = battlePracticeReplayId.BattlePracticeReplayIdInfoDto;
+exports.BattlePracticeResultDto = battlePracticeResult.BattlePracticeResultDto;
+exports.BattlePracticeSkillStatisticDto = battlePracticeResult.BattlePracticeSkillStatisticDto;
+exports.BattlePracticeSkillTimelineDto = battlePracticeSkillTimeline.BattlePracticeSkillTimelineDto;
+exports.BattlePracticeSkillTimelineEventDto = battlePracticeSkillTimeline.BattlePracticeSkillTimelineEventDto;
 exports.CharacterDto = character.CharacterDto;
 exports.CharacterAbilityDto = characterAbility.CharacterAbilityDto;
 exports.CharacterAbilityInfoDto = characterAbility.CharacterAbilityInfoDto;

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

@@ -5,6 +5,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var axios = require('axios');
 require('../../../node_modules/buffer/index.js');
 var xml2js = require('xml2js');
+var battlePracticeCharacterInfo = require('./dto/battlePractice/battlePracticeCharacterInfo.js');
+var battlePracticeReplayId = require('./dto/battlePractice/battlePracticeReplayId.js');
+var battlePracticeResult = require('./dto/battlePractice/battlePracticeResult.js');
+var battlePracticeSkillTimeline = require('./dto/battlePractice/battlePracticeSkillTimeline.js');
 var character = require('./dto/character/character.js');
 var characterAbility = require('./dto/character/characterAbility.js');
 var characterAndroidEquipment = require('./dto/character/characterAndroidEquipment.js');
@@ -1079,6 +1083,82 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         }
         return new guildBasic.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 battlePracticeReplayId.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 battlePracticeResult.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 battlePracticeSkillTimeline.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 battlePracticeCharacterInfo.BattlePracticeCharacterInfoDto(data);
+    }
     async getStarforceHistory(count, parameter) {
         const path = `${this.subUrl}/v1/history/starforce`;
         const query = {