maplestory-openapi 2.2.1 → 2.3.1

package/README.md

@@ -13,7 +13,7 @@ Packages written in other languages can be found [HERE](https://github.com/Spira
 Install the latest version of the JavaScript/TypeScript library in your npm project:
 
 ```bash
-npm install maplestory-openapi@2.2.1 # Replace with the latest version
+npm install maplestory-openapi@2.3.1 # Replace with the latest version
 ```
 
 ## Usage

package/dist/index.js

@@ -236,11 +236,14 @@ class CharacterAndroidCashItemEquipmentDto {
         this.cashItemIcon = cash_item_icon;
         this.cashItemDescription = cash_item_description;
         this.cashItemOption = cash_item_option.map((option) => new CharacterAndroidCashItemEquipmentOptionDto(option));
-        this.dateExpire = new Date(date_expire);
-        this.dateOptionExpire = new Date(date_option_expire);
+        this.dateExpire = date_expire ? new Date(date_expire) : null;
+        this.dateOptionExpire = date_option_expire
+            ? new Date(date_option_expire)
+            : null;
         this.cashItemLabel = cash_item_label;
-        this.cashItemColoringPrism =
-            new CharacterAndroidCashItemEquipmentColoringPrismDto(cash_item_coloring_prism);
+        this.cashItemColoringPrism = cash_item_coloring_prism
+            ? new CharacterAndroidCashItemEquipmentColoringPrismDto(cash_item_coloring_prism)
+            : null;
     }
 }
 
@@ -357,7 +360,7 @@ class CharacterAndroidEquipmentDto {
         this.androidFace = new CharacterAndroidEquipmentFaceDto(android_face);
         this.androidSkinName = android_skin_name;
         this.androidCashItemEquipment = android_cash_item_equipment.map((equipment) => new CharacterAndroidCashItemEquipmentDto(equipment));
-        this.androidEarSensorClipFlag = android_ear_sensor_clip_flag;
+        this.androidEarSensorClipFlag = android_ear_sensor_clip_flag ?? null;
     }
 }
 
@@ -531,8 +534,12 @@ class CharacterBeautyEquipmentDto {
         this.characterHair = new CharacterBeautyEquipmentHairDto(character_hair);
         this.characterFace = new CharacterBeautyEquipmentFaceDto(character_face);
         this.characterSkinName = character_skin_name;
-        this.additionalCharacterHair = new CharacterBeautyEquipmentHairDto(additional_character_hair);
-        this.additionalCharacterFace = new CharacterBeautyEquipmentFaceDto(additional_character_face);
+        this.additionalCharacterHair = additional_character_hair
+            ? new CharacterBeautyEquipmentHairDto(additional_character_hair)
+            : null;
+        this.additionalCharacterFace = additional_character_face
+            ? new CharacterBeautyEquipmentFaceDto(additional_character_face)
+            : null;
         this.additionalCharacterSkinName = additional_character_skin_name;
     }
 }
@@ -644,7 +651,9 @@ class CharacterCashItemEquipmentPresetDto {
         this.dateExpire = date_expire;
         this.dateOptionExpire = date_option_expire;
         this.cashItemLabel = cash_item_label;
-        this.cashItemColoringPrism = new CharacterCashItemEquipmentColoringPrismDto(cash_item_coloring_prism);
+        this.cashItemColoringPrism = cash_item_coloring_prism
+            ? new CharacterCashItemEquipmentColoringPrismDto(cash_item_coloring_prism)
+            : null;
         this.basePresetItemDisableFlag = base_preset_item_disable_flag;
     }
 }
@@ -744,7 +753,9 @@ class CharacterDojangDto {
         this.characterClass = character_class;
         this.worldName = world_name;
         this.dojangBestFloor = dojang_best_floor;
-        this.dateDojangRecord = new Date(date_dojang_record);
+        this.dateDojangRecord = date_dojang_record
+            ? new Date(date_dojang_record)
+            : null;
         this.dojangBestTime = dojang_best_time;
     }
 }
@@ -904,9 +915,9 @@ class CharacterHexaMatrixStatDto {
 }
 
 /**
- * 캐릭터 하이퍼 스탯 상세 정보
+ * 캐릭터 하이퍼 스탯 프리셋 정보
  */
-class CharacterHyperStatInfoDto {
+class CharacterHyperStatPresetDto {
     /**
      * 스탯 종류
      */
@@ -982,11 +993,11 @@ class CharacterHyperStatDto {
         this.characterClass = character_class;
         this.usePresetNo = use_preset_no;
         this.useAvailableHyperStat = use_available_hyper_stat;
-        this.hyperStatPreset1 = hyper_stat_preset_1.map((preset) => new CharacterHyperStatInfoDto(preset));
+        this.hyperStatPreset1 = hyper_stat_preset_1.map((preset) => new CharacterHyperStatPresetDto(preset));
         this.hyperStatPreset1RemainPoint = hyper_stat_preset_1_remain_point;
-        this.hyperStatPreset2 = hyper_stat_preset_2.map((preset) => new CharacterHyperStatInfoDto(preset));
+        this.hyperStatPreset2 = hyper_stat_preset_2.map((preset) => new CharacterHyperStatPresetDto(preset));
         this.hyperStatPreset2RemainPoint = hyper_stat_preset_2_remain_point;
-        this.hyperStatPreset3 = hyper_stat_preset_3.map((preset) => new CharacterHyperStatInfoDto(preset));
+        this.hyperStatPreset3 = hyper_stat_preset_3.map((preset) => new CharacterHyperStatPresetDto(preset));
         this.hyperStatPreset3RemainPoint = hyper_stat_preset_3_remain_point;
     }
 }
@@ -1477,7 +1488,7 @@ class CharacterItemEquipmentInfoDto {
     /**
      * 전용 성별
      */
-    gender;
+    itemGender;
     /**
      * 장비 최종 옵션
      */
@@ -1591,7 +1602,7 @@ class CharacterItemEquipmentInfoDto {
      */
     dateExpire;
     constructor(obj) {
-        const { item_equipment_part, equipment_slot, item_name, item_icon, item_description, item_shape_name, item_shape_icon, gender, item_total_option, item_base_option, potential_option_grade, additional_potential_option_grade, potential_option_1, potential_option_2, potential_option_3, additional_potential_option_1, additional_potential_option_2, additional_potential_option_3, equipment_level_increase, item_exceptional_option, item_add_option, growth_exp, growth_level, scroll_upgrade, cuttable_count, golden_hammer_flag, scroll_resilience_count, scroll_upgradeable_count, soul_name, soul_option, item_etc_option, starforce, starforce_scroll_flag, item_starforce_option, special_ring_level, date_expire, } = obj;
+        const { item_equipment_part, equipment_slot, item_name, item_icon, item_description, item_shape_name, item_shape_icon, item_gender, item_total_option, item_base_option, potential_option_grade, additional_potential_option_grade, potential_option_1, potential_option_2, potential_option_3, additional_potential_option_1, additional_potential_option_2, additional_potential_option_3, equipment_level_increase, item_exceptional_option, item_add_option, growth_exp, growth_level, scroll_upgrade, cuttable_count, golden_hammer_flag, scroll_resilience_count, scroll_upgradeable_count, soul_name, soul_option, item_etc_option, starforce, starforce_scroll_flag, item_starforce_option, special_ring_level, date_expire, } = obj;
         this.itemEquipmentPart = item_equipment_part;
         this.equipmentSlot = equipment_slot;
         this.itemName = item_name;
@@ -1599,7 +1610,7 @@ class CharacterItemEquipmentInfoDto {
         this.itemDescription = item_description;
         this.itemShapeName = item_shape_name;
         this.itemShapeIcon = item_shape_icon;
-        this.gender = gender;
+        this.itemGender = item_gender;
         this.itemTotalOption = new CharacterItemEquipmentTotalOptionDto(item_total_option);
         this.itemBaseOption = new CharacterItemEquipmentBaseOptionDto(item_base_option);
         this.potentialOptionGrade = potential_option_grade;
@@ -1627,7 +1638,7 @@ class CharacterItemEquipmentInfoDto {
         this.starforceScrollFlag = starforce_scroll_flag;
         this.itemStarforceOption = new CharacterItemEquipmentStarforceOptionDto(item_starforce_option);
         this.specialRingLevel = special_ring_level;
-        this.dateExpire = new Date(date_expire);
+        this.dateExpire = date_expire ? new Date(date_expire) : null;
     }
 }
 
@@ -1654,16 +1665,25 @@ class CharacterItemEquipmentTitleDto {
     /**
      * 칭호 옵션 유효 기간
      */
-    dateOptionExpire;
+    dateOptionExpire = null;
+    /**
+     * 칭호 옵션 유효 기간 만료 여부
+     */
+    isOptionExpired = null;
     constructor(obj) {
         const { title_name, title_icon, title_description, date_expire, date_option_expire, } = obj;
         this.titleName = title_name;
         this.titleIcon = title_icon;
         this.titleDescription = title_description;
-        this.dateExpire = new Date(date_expire);
-        this.dateOptionExpire = date_option_expire
-            ? new Date(date_option_expire)
-            : undefined;
+        this.dateExpire = date_expire ? new Date(date_expire) : null;
+        if (date_option_expire === 'expired') {
+            this.isOptionExpired = true;
+        }
+        else if (typeof date_option_expire === 'string') {
+            this.dateOptionExpire = date_option_expire
+                ? new Date(date_option_expire)
+                : null;
+        }
     }
 }
 
@@ -2738,7 +2758,7 @@ class GuildBasicDto {
     /**
      * 노블레스 스킬 목록
      */
-    guildNoblessSkill;
+    guildNoblesseSkill;
     /**
      * 조합형 길드 마크
      */
@@ -2748,7 +2768,7 @@ class GuildBasicDto {
      */
     guildMarkCustom;
     constructor(obj) {
-        const { date, world_name, guild_name, guild_level, guild_fame, guild_point, guild_master_name, guild_member_count, guild_member, guild_skill, guild_nobless_skill, guild_mark, guild_mark_custom, } = obj;
+        const { date, world_name, guild_name, guild_level, guild_fame, guild_point, guild_master_name, guild_member_count, guild_member, guild_skill, guild_noblesse_skill, guild_mark, guild_mark_custom, } = obj;
         this.date = new Date(date);
         this.worldName = world_name;
         this.guildName = guild_name;
@@ -2759,7 +2779,7 @@ class GuildBasicDto {
         this.guildMemberCount = guild_member_count;
         this.guildMember = guild_member;
         this.guildSkill = guild_skill.map((skill) => new GuildSkillDto(skill));
-        this.guildNoblessSkill = guild_nobless_skill.map((skill) => new GuildSkillDto(skill));
+        this.guildNoblesseSkill = guild_noblesse_skill.map((skill) => new GuildSkillDto(skill));
         this.guildMark = guild_mark;
         this.guildMarkCustom = guild_mark_custom;
     }
@@ -3104,7 +3124,9 @@ class UnionRaiderBlockDto {
         this.blockClass = block_class;
         this.blockLevel = block_level;
         this.blockControlPoint = new UnionRaiderBlockControlPointDto(block_control_point);
-        this.blockPosition = block_position.map((position) => new UnionRaiderBlockPositionDto(position));
+        this.blockPosition = block_position
+            ? block_position.map((position) => new UnionRaiderBlockPositionDto(position))
+            : null;
     }
 }
 
@@ -3260,6 +3282,153 @@ const errorMap = {
     ['OPENAPI00007']: exports.MapleStoryApiErrorCode.OPENAPI00007,
 };
 
+/**
+ * 스타포스 강화 이벤트 정보
+ */
+class StarforceEventDto {
+    /**
+     * 이벤트 성공 확률
+     */
+    successRate;
+    /**
+     * 이벤트 비용 할인율
+     */
+    costDiscountRate;
+    /**
+     * 이벤트 강화 수치 가중값
+     */
+    plusValue;
+    /**
+     * 이벤트 적용 강화 시도 가능한 n성 범위
+     */
+    starforceEventRange;
+    constructor(obj) {
+        const { success_rate, cost_discount_rate, plus_value, starforce_event_range, } = obj;
+        this.successRate = success_rate;
+        this.costDiscountRate = cost_discount_rate;
+        this.plusValue = plus_value;
+        this.starforceEventRange = starforce_event_range;
+    }
+}
+
+/**
+ * 스타포스 히스토리
+ */
+class StarforceHistoryDto {
+    /**
+     *스타포스 히스토리 식별자
+     */
+    id;
+    /**
+     *강화 시도 결과
+     */
+    itemUpgradeResult;
+    /**
+     *강화 시도 전 스타포스 수치
+     */
+    beforeStarforceCount;
+    /**
+     *강화 시도 후 스타포스 수치
+     */
+    afterStarforceCount;
+    /**
+     *스타 캐치
+     */
+    starCatchResult;
+    /**
+     *슈페리얼 장비
+     */
+    superiorItemFlag;
+    /**
+     *파괴 방지
+     */
+    destroyDefence;
+    /**
+     *찬스 타임
+     */
+    chanceTime;
+    /**
+     *파괴 방지 필드 이벤트
+     */
+    eventFieldFlag;
+    /**
+     *사용 주문서 명
+     */
+    upgradeItem;
+    /**
+     *프로텍트 실드
+     */
+    protectShield;
+    /**
+     *보너스 스탯 부여 아이템 여부
+     */
+    bonusStatUpgrade;
+    /**
+     *캐릭터 명
+     */
+    characterName;
+    /**
+     *월드 명
+     */
+    worldName;
+    /**
+     *대상 장비 아이템 명
+     */
+    targetItem;
+    /**
+     *강화 일시 (KST)
+     */
+    dateCreate;
+    /**
+     * 진행 중인 스타포스 강화 이벤트 정보
+     */
+    starforceEventList;
+    constructor(obj) {
+        const { id, item_upgrade_result, before_starforce_count, after_starforce_count, starcatch_result, superior_item_flag, destroy_defence, chance_time, event_field_flag, upgrade_item, protect_shield, bonus_stat_upgrade, character_name, world_name, target_item, date_create, starforce_event_list, } = obj;
+        this.id = id;
+        this.itemUpgradeResult = item_upgrade_result;
+        this.beforeStarforceCount = before_starforce_count;
+        this.afterStarforceCount = after_starforce_count;
+        this.starCatchResult = starcatch_result;
+        this.superiorItemFlag = superior_item_flag;
+        this.destroyDefence = destroy_defence;
+        this.chanceTime = chance_time;
+        this.eventFieldFlag = event_field_flag;
+        this.upgradeItem = upgrade_item;
+        this.protectShield = protect_shield;
+        this.bonusStatUpgrade = bonus_stat_upgrade;
+        this.characterName = character_name;
+        this.worldName = world_name;
+        this.targetItem = target_item;
+        this.dateCreate = new Date(date_create);
+        this.starforceEventList = starforce_event_list.map((event) => new StarforceEventDto(event));
+    }
+}
+
+/**
+ * 스타포스 히스토리 응답 정보
+ */
+class StarforceHistoryResponseDto {
+    /**
+     * 결과 건 수
+     */
+    count;
+    /**
+     * 스타포스 히스토리
+     */
+    starforceHistory;
+    /**
+     * 페이징 처리를 위한 cursor
+     */
+    nextCursor;
+    constructor(obj) {
+        const { count, starforce_history, next_cursor } = obj;
+        this.count = count;
+        this.starforceHistory = starforce_history.map((origin) => new StarforceHistoryDto(origin));
+        this.nextCursor = next_cursor;
+    }
+}
+
 dayjs__default["default"].extend(timezone);
 dayjs__default["default"].extend(utc);
 /**
@@ -4233,6 +4402,42 @@ class MapleStoryApi {
             throw e;
         }
     }
+    async getStarforceHistory(count, parameter) {
+        const query = {
+            count,
+        };
+        if (typeof parameter === 'string') {
+            query.cursor = parameter;
+        }
+        else if (typeof parameter === 'object') {
+            query.date = MapleStoryApi.toDateString({
+                year: 2023,
+                month: 12,
+                day: 27,
+            }, parameter ?? MapleStoryApi.getProperDefaultDateOptions({
+                hour: 0,
+                minute: 0,
+                dateOffset: 0
+            }));
+        }
+        try {
+            const path = 'maplestory/v1/history/starforce';
+            const response = await axios__default["default"].get(path, {
+                baseURL: MapleStoryApi.BASE_URL,
+                timeout: this.timeout,
+                headers: this.buildHeaders(),
+                params: query,
+            });
+            return new StarforceHistoryResponseDto(response.data);
+        }
+        catch (e) {
+            if (e instanceof axios.AxiosError) {
+                const errorBody = e.response.data;
+                throw new MapleStoryApiError(errorBody);
+            }
+            throw e;
+        }
+    }
     async getCubeHistory(count, parameter) {
         const query = {
             count,
@@ -4662,7 +4867,7 @@ exports.CharacterHexaMatrixEquipmentLinkedSkillDto = CharacterHexaMatrixEquipmen
 exports.CharacterHexaMatrixStatCoreDto = CharacterHexaMatrixStatCoreDto;
 exports.CharacterHexaMatrixStatDto = CharacterHexaMatrixStatDto;
 exports.CharacterHyperStatDto = CharacterHyperStatDto;
-exports.CharacterHyperStatInfoDto = CharacterHyperStatInfoDto;
+exports.CharacterHyperStatPresetDto = CharacterHyperStatPresetDto;
 exports.CharacterItemEquipmentAddOptionDto = CharacterItemEquipmentAddOptionDto;
 exports.CharacterItemEquipmentBaseOptionDto = CharacterItemEquipmentBaseOptionDto;
 exports.CharacterItemEquipmentDto = CharacterItemEquipmentDto;
@@ -4705,6 +4910,9 @@ exports.MapleStoryApi = MapleStoryApi;
 exports.MapleStoryApiError = MapleStoryApiError;
 exports.OverallRankingDto = OverallRankingDto;
 exports.OverallRankingResponseDto = OverallRankingResponseDto;
+exports.StarforceEventDto = StarforceEventDto;
+exports.StarforceHistoryDto = StarforceHistoryDto;
+exports.StarforceHistoryResponseDto = StarforceHistoryResponseDto;
 exports.TheSeedRankingDto = TheSeedRankingDto;
 exports.TheSeedRankingResponseDto = TheSeedRankingResponseDto;
 exports.UnionDto = UnionDto;