maplestory-openapi 3.4.0 → 3.5.0

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

@@ -93,6 +93,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterBasic.CharacterBasicDto(data);
     }
     /**
@@ -107,7 +110,11 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
      * @param dateOptions Reference date for query (SGT)
      */
     async getCharacterImage(ocid, imageOptions, dateOptions) {
-        const { date, characterImage: path } = await this.getCharacterBasic(ocid, dateOptions);
+        const basic = await this.getCharacterBasic(ocid, dateOptions);
+        if (!basic) {
+            return null;
+        }
+        const { date, characterImage: path } = basic;
         const action = imageOptions?.action ?? characterImage.CharacterImageAction.Stand1;
         const emotion = imageOptions?.emotion ?? characterImage.CharacterImageEmotion.Default;
         const wmotion = imageOptions?.wmotion ?? characterImage.CharacterImageWeaponMotion.Default;
@@ -181,6 +188,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterPopularity.CharacterPopularityDto(data);
     }
     /**
@@ -209,6 +219,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterStat.CharacterStatDto(data);
     }
     /**
@@ -237,6 +250,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterHyperStat.CharacterHyperStatDto(data);
     }
     /**
@@ -265,6 +281,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterPropensity.CharacterPropensityDto(data);
     }
     /**
@@ -293,6 +312,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterAbility.CharacterAbilityDto(data);
     }
     /**
@@ -321,6 +343,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterItemEquipment.CharacterItemEquipmentDto(data);
     }
     /**
@@ -349,6 +374,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterCashItemEquipment.CharacterCashItemEquipmentDto(data);
     }
     /**
@@ -377,6 +405,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterSymbolEquipment.CharacterSymbolEquipmentDto(data);
     }
     /**
@@ -405,6 +436,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterSetEffect.CharacterSetEffectDto(data);
     }
     /**
@@ -433,6 +467,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterBeautyEquipment.CharacterBeautyEquipmentDto(data);
     }
     /**
@@ -461,6 +498,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterAndroidEquipment.CharacterAndroidEquipmentDto(data);
     }
     /**
@@ -489,6 +529,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterPetEquipment.CharacterPetEquipmentDto(data);
     }
     /**
@@ -519,6 +562,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterSkill.CharacterSkillDto(data);
     }
     /**
@@ -547,6 +593,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterLinkSkill.CharacterLinkSkillDto(data);
     }
     /**
@@ -575,6 +624,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterVMatrix.CharacterVMatrixDto(data);
     }
     /**
@@ -603,6 +655,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterHexaMatrix.CharacterHexaMatrixDto(data);
     }
     /**
@@ -631,6 +686,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterHexaMatrixStat.CharacterHexaMatrixStatDto(data);
     }
     /**
@@ -659,6 +717,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterDojang.CharacterDojangDto(data);
     }
     //#endregion
@@ -689,6 +750,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new union.UnionDto(data);
     }
     /**
@@ -717,6 +781,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new unionRaider.UnionRaiderDto(data);
     }
     /**
@@ -745,6 +812,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new unionArtifact.UnionArtifactDto(data);
     }
     //#endregion
@@ -767,6 +837,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
                 world_name: worldName,
             },
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new guild.GuildDto(data);
     }
     /**
@@ -795,6 +868,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new guildBasic.GuildBasicDto(data);
     }
 }

package/dist/cjs/maplestory/api/tms/dto/character/characterBasic.js

@@ -78,7 +78,7 @@ class CharacterBasicDto extends characterBasic.CharacterBasicDto {
         this.characterExpRate = character_exp_rate;
         this.characterGuildName = character_guild_name;
         this.characterImage = character_image;
-        this.characterDateCreate = new Date(character_date_create);
+        this.characterDateCreate = character_date_create ? new Date(character_date_create) : null;
         this.accessFlag = access_flag;
         this.liberationQuestClear = liberation_quest_clear;
     }

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

@@ -93,6 +93,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterBasic.CharacterBasicDto(data);
     }
     /**
@@ -107,7 +110,11 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
      * @param dateOptions 要搜尋的日期 (TST)
      */
     async getCharacterImage(ocid, imageOptions, dateOptions) {
-        const { date, characterImage: path } = await this.getCharacterBasic(ocid, dateOptions);
+        const basic = await this.getCharacterBasic(ocid, dateOptions);
+        if (!basic) {
+            return null;
+        }
+        const { date, characterImage: path } = basic;
         const action = imageOptions?.action ?? characterImage.CharacterImageAction.Stand1;
         const emotion = imageOptions?.emotion ?? characterImage.CharacterImageEmotion.Default;
         const wmotion = imageOptions?.wmotion ?? characterImage.CharacterImageWeaponMotion.Default;
@@ -181,6 +188,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterPopularity.CharacterPopularityDto(data);
     }
     /**
@@ -209,6 +219,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterStat.CharacterStatDto(data);
     }
     /**
@@ -237,6 +250,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterHyperStat.CharacterHyperStatDto(data);
     }
     /**
@@ -265,6 +281,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterPropensity.CharacterPropensityDto(data);
     }
     /**
@@ -293,6 +312,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterAbility.CharacterAbilityDto(data);
     }
     /**
@@ -321,6 +343,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterItemEquipment.CharacterItemEquipmentDto(data);
     }
     /**
@@ -349,6 +374,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterCashItemEquipment.CharacterCashItemEquipmentDto(data);
     }
     /**
@@ -377,6 +405,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterSymbolEquipment.CharacterSymbolEquipmentDto(data);
     }
     /**
@@ -405,6 +436,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterSetEffect.CharacterSetEffectDto(data);
     }
     /**
@@ -433,6 +467,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterBeautyEquipment.CharacterBeautyEquipmentDto(data);
     }
     /**
@@ -461,6 +498,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterAndroidEquipment.CharacterAndroidEquipmentDto(data);
     }
     /**
@@ -489,6 +529,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterPetEquipment.CharacterPetEquipmentDto(data);
     }
     /**
@@ -519,6 +562,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterSkill.CharacterSkillDto(data);
     }
     /**
@@ -547,6 +593,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterLinkSkill.CharacterLinkSkillDto(data);
     }
     /**
@@ -575,6 +624,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterVMatrix.CharacterVMatrixDto(data);
     }
     /**
@@ -603,6 +655,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterHexaMatrix.CharacterHexaMatrixDto(data);
     }
     /**
@@ -631,6 +686,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterHexaMatrixStat.CharacterHexaMatrixStatDto(data);
     }
     /**
@@ -659,6 +717,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new characterDojang.CharacterDojangDto(data);
     }
     //#endregion
@@ -689,6 +750,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new union.UnionDto(data);
     }
     /**
@@ -717,6 +781,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new unionRaider.UnionRaiderDto(data);
     }
     /**
@@ -745,6 +812,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new unionArtifact.UnionArtifactDto(data);
     }
     //#endregion
@@ -767,6 +837,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
                 world_name: worldName,
             },
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new guild.GuildDto(data);
     }
     /**
@@ -795,6 +868,9 @@ class MapleStoryApi extends mapleStoryApi.MapleStoryApi {
         const { data } = await this.client.get(path, {
             params: query,
         });
+        if (this.isEmptyResponse(data)) {
+            return null;
+        }
         return new guildBasic.GuildBasicDto(data);
     }
 }

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

@@ -107,6 +107,31 @@ class MapleStoryApi {
         return str;
     }
     ;
+    /**
+     * API 응답 데이터가 비어있는지 확인 합니다.<br/>
+     * API 요청 시 날짜에 해당하는 데이터가 없을 경우 date 필드만 값이 존재하는 상황을 검증할 때 사용 합니다.<br/>
+     * 일반적으로 API 지원 시작일과 캐릭터 생성일 사이의 날짜를 조회할 때 발생 합니다.
+     * @example
+     * ```
+     * isEmptyResponse({ date: '2024-01-01', popularity: null }) // true
+     * isEmptyResponse({ date: '2024-01-01', popularity: 10 }) // false
+     * ```
+     */
+    isEmptyResponse(body) {
+        for (const [key, value] of Object.entries(body)) {
+            if (key === 'date') {
+                continue;
+            }
+            if (value === null || value === undefined) {
+                continue;
+            }
+            if (Array.isArray(value) && value.length === 0) {
+                continue;
+            }
+            return false;
+        }
+        return true;
+    }
 }
 
 export { MapleStoryApi };

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

@@ -94,7 +94,7 @@ class CharacterAndroidEquipmentDto extends CharacterAndroidEquipmentDto$1 {
             ? new CharacterAndroidEquipmentSkinDto(android_skin)
             : null;
         this.androidCashItemEquipment = android_cash_item_equipment.map((equipment) => new CharacterAndroidCashItemEquipmentDto(equipment));
-        this.androidEarSensorClipFlag = android_ear_sensor_clip_flag ?? null;
+        this.androidEarSensorClipFlag = android_ear_sensor_clip_flag;
         this.androidGender = android_gender;
         this.androidGrade = android_grade;
         this.androidNonHumanoidFlag = android_non_humanoid_flag;

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

@@ -74,7 +74,7 @@ class CharacterBasicDto extends CharacterBasicDto$1 {
         this.characterExpRate = character_exp_rate;
         this.characterGuildName = character_guild_name;
         this.characterImage = character_image;
-        this.characterDateCreate = new Date(character_date_create);
+        this.characterDateCreate = character_date_create ? new Date(character_date_create) : null;
         this.accessFlag = access_flag;
         this.liberationQuestClear = liberation_quest_clear;
     }

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

@@ -18,12 +18,22 @@ class CharacterRingExchangeSkillEquipmentDto {
      * 링 익스체인지에 등록된 특수 반지 레벨
      */
     specialRingExchangeLevel;
+    /**
+     * 링 익스체인지에 등록된 특수 반지 아이콘
+     */
+    specialRingExchangeIcon;
+    /**
+     * 링 익스체인지에 등록된 특수 반지 설명
+     */
+    specialRingExchangeDescription;
     constructor(obj) {
-        const { date, character_class, special_ring_exchange_name, special_ring_exchange_level } = obj;
+        const { date, character_class, special_ring_exchange_name, special_ring_exchange_level, special_ring_exchange_icon, special_ring_exchange_description } = obj;
         this.date = date ? new Date(date) : null;
-        this.characterClass = character_class ?? '';
+        this.characterClass = character_class;
         this.specialRingExchangeName = special_ring_exchange_name ?? null;
         this.specialRingExchangeLevel = special_ring_exchange_level ?? null;
+        this.specialRingExchangeIcon = special_ring_exchange_icon ?? null;
+        this.specialRingExchangeDescription = special_ring_exchange_description ?? null;
     }
 }
 

package/dist/esm/maplestory/api/kms/dto/history/starforceHistory.js

@@ -90,7 +90,7 @@ class StarforceHistoryDto {
         this.dateCreate = new Date(date_create);
         this.starforceEventList =
             starforce_event_list?.map((event) => new StarforceEventDto(event)) ??
-                null;
+                [];
     }
 }
 /**