maplestory-openapi 2.13.1 → 3.1.0

package/dist/cjs/maplestory/api/common/dto/union/unionRaider.js

@@ -0,0 +1,23 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+class UnionRaiderDto {
+}
+class UnionRaiderInnerStatDto {
+}
+class UnionRaiderBlockPositionDto {
+}
+class UnionRaiderBlockControlPointDto {
+}
+class UnionRaiderBlockDto {
+}
+class UnionRaiderPresetDto {
+}
+
+exports.UnionRaiderBlockControlPointDto = UnionRaiderBlockControlPointDto;
+exports.UnionRaiderBlockDto = UnionRaiderBlockDto;
+exports.UnionRaiderBlockPositionDto = UnionRaiderBlockPositionDto;
+exports.UnionRaiderDto = UnionRaiderDto;
+exports.UnionRaiderInnerStatDto = UnionRaiderInnerStatDto;
+exports.UnionRaiderPresetDto = UnionRaiderPresetDto;

package/dist/cjs/maplestory/api/common/enum/characterImage.js

@@ -0,0 +1,94 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * Character action
+ */
+exports.CharacterImageAction = void 0;
+(function (CharacterImageAction) {
+    CharacterImageAction["Stand1"] = "A00";
+    CharacterImageAction["Stand2"] = "A01";
+    CharacterImageAction["Walk1"] = "A02";
+    CharacterImageAction["Walk2"] = "A03";
+    CharacterImageAction["Prone"] = "A04";
+    CharacterImageAction["Fly"] = "A05";
+    CharacterImageAction["Jump"] = "A06";
+    CharacterImageAction["Sit"] = "A07";
+    CharacterImageAction["Ladder"] = "A08";
+    CharacterImageAction["Rope"] = "A09";
+    CharacterImageAction["Heal"] = "A10";
+    CharacterImageAction["Alert"] = "A11";
+    CharacterImageAction["ProneStab"] = "A12";
+    CharacterImageAction["SwingO1"] = "A13";
+    CharacterImageAction["SwingO2"] = "A14";
+    CharacterImageAction["SwingO3"] = "A15";
+    CharacterImageAction["SwingOF"] = "A16";
+    CharacterImageAction["SwingP1"] = "A17";
+    CharacterImageAction["SwingP2"] = "A18";
+    CharacterImageAction["SwingPF"] = "A19";
+    CharacterImageAction["SwingT1"] = "A20";
+    CharacterImageAction["SwingT2"] = "A21";
+    CharacterImageAction["SwingT3"] = "A22";
+    CharacterImageAction["SwingTF"] = "A23";
+    CharacterImageAction["StabO1"] = "A24";
+    CharacterImageAction["StabO2"] = "A25";
+    CharacterImageAction["StabOF"] = "A26";
+    CharacterImageAction["StabT1"] = "A27";
+    CharacterImageAction["StabT2"] = "A28";
+    CharacterImageAction["StabTF"] = "A29";
+    CharacterImageAction["Shoot1"] = "A30";
+    CharacterImageAction["Shoot2"] = "A31";
+    CharacterImageAction["ShootF"] = "A32";
+    CharacterImageAction["Dead"] = "A33";
+    CharacterImageAction["GhostWalk"] = "A34";
+    CharacterImageAction["GhostStand"] = "A35";
+    CharacterImageAction["GhostJump"] = "A36";
+    CharacterImageAction["GhostProneStab"] = "A37";
+    CharacterImageAction["GhostLadder"] = "A38";
+    CharacterImageAction["GhostRope"] = "A39";
+    CharacterImageAction["GhostFly"] = "A40";
+    CharacterImageAction["GhostSit"] = "A41";
+})(exports.CharacterImageAction || (exports.CharacterImageAction = {}));
+/**
+ * Character emotion
+ */
+exports.CharacterImageEmotion = void 0;
+(function (CharacterImageEmotion) {
+    CharacterImageEmotion["Default"] = "E00";
+    CharacterImageEmotion["Wink"] = "E01";
+    CharacterImageEmotion["Smile"] = "E02";
+    CharacterImageEmotion["Cry"] = "E03";
+    CharacterImageEmotion["Angry"] = "E04";
+    CharacterImageEmotion["Bewildered"] = "E05";
+    CharacterImageEmotion["Blink"] = "E06";
+    CharacterImageEmotion["Blaze"] = "E07";
+    CharacterImageEmotion["Bowing"] = "E08";
+    CharacterImageEmotion["Cheers"] = "E09";
+    CharacterImageEmotion["Chu"] = "E10";
+    CharacterImageEmotion["Dam"] = "E11";
+    CharacterImageEmotion["Despair"] = "E12";
+    CharacterImageEmotion["Glitter"] = "E13";
+    CharacterImageEmotion["Hit"] = "E14";
+    CharacterImageEmotion["Hot"] = "E15";
+    CharacterImageEmotion["Hum"] = "E16";
+    CharacterImageEmotion["Love"] = "E17";
+    CharacterImageEmotion["Oops"] = "E18";
+    CharacterImageEmotion["Pain"] = "E19";
+    CharacterImageEmotion["Troubled"] = "E20";
+    CharacterImageEmotion["QBlue"] = "E21";
+    CharacterImageEmotion["Shine"] = "E22";
+    CharacterImageEmotion["Stunned"] = "E23";
+    CharacterImageEmotion["Vomit"] = "E24";
+})(exports.CharacterImageEmotion || (exports.CharacterImageEmotion = {}));
+/**
+ * Character weapon motion
+ */
+exports.CharacterImageWeaponMotion = void 0;
+(function (CharacterImageWeaponMotion) {
+    CharacterImageWeaponMotion["Default"] = "W00";
+    CharacterImageWeaponMotion["OneHand"] = "W01";
+    CharacterImageWeaponMotion["TwoHands"] = "W02";
+    CharacterImageWeaponMotion["Gun"] = "W03";
+    CharacterImageWeaponMotion["Nothing"] = "W04";
+})(exports.CharacterImageWeaponMotion || (exports.CharacterImageWeaponMotion = {}));

package/dist/cjs/maplestory/api/common/enum/potentialOptionGrade.js

@@ -0,0 +1,11 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+exports.PotentialOptionGrade = void 0;
+(function (PotentialOptionGrade) {
+    PotentialOptionGrade[PotentialOptionGrade["RARE"] = 0] = "RARE";
+    PotentialOptionGrade[PotentialOptionGrade["EPIC"] = 1] = "EPIC";
+    PotentialOptionGrade[PotentialOptionGrade["UNIQUE"] = 2] = "UNIQUE";
+    PotentialOptionGrade[PotentialOptionGrade["LEGENDARY"] = 3] = "LEGENDARY";
+})(exports.PotentialOptionGrade || (exports.PotentialOptionGrade = {}));

package/dist/cjs/maplestory/api/common/lib.js

@@ -0,0 +1,26 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var potentialOptionGrade = require('./enum/potentialOptionGrade.js');
+
+/**
+ * 한글로 정의된 잠재옵션 등급을 PotentialOptionGrade으로 변환합니다.
+ *
+ * @param text support only "레어", "에픽", "유니크", "레전드리"
+ */
+const potentialOptionGradeFromString = (text) => {
+    const potentialOptionGradeMap = {
+        레어: potentialOptionGrade.PotentialOptionGrade.RARE,
+        에픽: potentialOptionGrade.PotentialOptionGrade.EPIC,
+        유니크: potentialOptionGrade.PotentialOptionGrade.UNIQUE,
+        레전드리: potentialOptionGrade.PotentialOptionGrade.LEGENDARY,
+    };
+    const grade = potentialOptionGradeMap[text];
+    if (!grade) {
+        throw new TypeError('No enum constant for string: ' + text);
+    }
+    return grade;
+};
+
+exports.potentialOptionGradeFromString = potentialOptionGradeFromString;

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

@@ -0,0 +1,121 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var axios = require('axios');
+var dayjs = require('dayjs');
+var timezone = require('../../../node_modules/dayjs/plugin/timezone.js');
+var utc = require('../../../node_modules/dayjs/plugin/utc.js');
+var mapleStoryApiError = require('./mapleStoryApiError.js');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
+var dayjs__default = /*#__PURE__*/_interopDefaultLegacy(dayjs);
+
+dayjs__default["default"].extend(timezone);
+dayjs__default["default"].extend(utc);
+/**
+ * MapleStory OpenAPI client.
+ */
+class MapleStoryApi {
+    apiKey;
+    client;
+    static BASE_URL = 'https://open.api.nexon.com/';
+    static DEFAULT_TIMEOUT = 5000;
+    get timeout() {
+        return this.client.defaults.timeout;
+    }
+    set timeout(value) {
+        this.client.defaults.timeout = value;
+    }
+    constructor(apiKey) {
+        this.apiKey = apiKey;
+        this.client = axios__default["default"].create({
+            baseURL: MapleStoryApi.BASE_URL,
+            timeout: MapleStoryApi.DEFAULT_TIMEOUT,
+            headers: {
+                'x-nxopen-api-key': this.apiKey,
+            },
+        });
+        this.client.interceptors.response.use((response) => response, (error) => {
+            if (error instanceof axios.AxiosError) {
+                const errorBody = error.response
+                    .data;
+                throw new mapleStoryApiError.MapleStoryApiError(errorBody);
+            }
+            throw error;
+        });
+    }
+    //#endregion
+    /**
+     * API 서버의 데이터 갱신 시간에 따라 데이터가 조회 가능한 최신 날짜를 반환합니다.
+     *
+     * @param options
+     */
+    getProperDefaultDateOptions(options) {
+        const { hour, minute, dateOffset } = options;
+        const nowInTimezone = dayjs__default["default"]().utcOffset(this.timezoneOffset);
+        const updateDate = dayjs__default["default"]().utcOffset(this.timezoneOffset).hour(hour).minute(minute);
+        let adjustedDate;
+        if (nowInTimezone.isAfter(updateDate)) {
+            adjustedDate = nowInTimezone;
+        }
+        else {
+            adjustedDate = nowInTimezone.subtract(1, 'day');
+        }
+        adjustedDate = adjustedDate.subtract(dateOffset ?? 0, 'day');
+        return {
+            year: adjustedDate.year(),
+            month: adjustedDate.month() + 1,
+            day: adjustedDate.date(),
+        };
+    }
+    ;
+    /**
+     * 날짜 정보를 API 서버에서 요구하는 포맷으로 변환합니다.
+     *
+     * @param dateOptions 조회 하려는 날짜
+     * @param minDateOptions API 호출 가능한 최소 날짜
+     */
+    toDateString(dateOptions, minDateOptions) {
+        const convert = (dateOptions) => {
+            let year;
+            let month;
+            let day;
+            let d;
+            if (dateOptions instanceof Date) {
+                d = dayjs__default["default"](dateOptions).utcOffset(this.timezoneOffset);
+                year = d.year();
+                month = d.month() + 1;
+                day = d.date();
+            }
+            else {
+                year = dateOptions.year;
+                month = dateOptions.month;
+                day = dateOptions.day;
+                d = dayjs__default["default"](`${year}-${month}-${day}`).utcOffset(this.timezoneOffset);
+            }
+            return {
+                year,
+                month,
+                day,
+                d,
+            };
+        };
+        const { year, month, day, d } = convert(dateOptions);
+        const str = d.format('YYYY-MM-DD');
+        if (minDateOptions) {
+            const { year: minYear, month: minMonth, day: minDay, } = convert(minDateOptions);
+            if (year < minYear ||
+                (year === minYear && month < minMonth) ||
+                (year === minYear && month === minMonth && day < minDay)) {
+                throw new Error(`You can only retrieve data after ${dayjs__default["default"](`${minYear}-${minMonth}-${minDay}`).format('YYYY-MM-DD')}.`);
+            }
+        }
+        return str;
+    }
+    ;
+}
+
+exports.MapleStoryApi = MapleStoryApi;

package/dist/cjs/maplestory/api/common/mapleStoryApiError.js

@@ -0,0 +1,50 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * MapleStory OpenAPI error.<br>
+ * Please refer to <a href="https://openapi.nexon.com/guide/request-api/">MapleStory API guide</a> for the error details.
+ */
+class MapleStoryApiError extends Error {
+    name = 'MapleStoryApiError';
+    errorCode;
+    message;
+    constructor(errorBody) {
+        const { name, message } = errorBody.error;
+        super(message);
+        this.errorCode = ERROR_MAP[name];
+        this.message = message;
+    }
+}
+/**
+ * MapleStory OpenAPI error codes.<br>
+ * Please refer to <a href="https://openapi.nexon.com/guide/request-api/">MapleStory API guide</a> for the error code details.
+ */
+exports.MapleStoryApiErrorCode = void 0;
+(function (MapleStoryApiErrorCode) {
+    MapleStoryApiErrorCode[MapleStoryApiErrorCode["OPENAPI00001"] = 0] = "OPENAPI00001";
+    MapleStoryApiErrorCode[MapleStoryApiErrorCode["OPENAPI00002"] = 1] = "OPENAPI00002";
+    MapleStoryApiErrorCode[MapleStoryApiErrorCode["OPENAPI00003"] = 2] = "OPENAPI00003";
+    MapleStoryApiErrorCode[MapleStoryApiErrorCode["OPENAPI00004"] = 3] = "OPENAPI00004";
+    MapleStoryApiErrorCode[MapleStoryApiErrorCode["OPENAPI00005"] = 4] = "OPENAPI00005";
+    MapleStoryApiErrorCode[MapleStoryApiErrorCode["OPENAPI00006"] = 5] = "OPENAPI00006";
+    MapleStoryApiErrorCode[MapleStoryApiErrorCode["OPENAPI00007"] = 6] = "OPENAPI00007";
+    MapleStoryApiErrorCode[MapleStoryApiErrorCode["OPENAPI00009"] = 7] = "OPENAPI00009";
+    MapleStoryApiErrorCode[MapleStoryApiErrorCode["OPENAPI00010"] = 8] = "OPENAPI00010";
+    MapleStoryApiErrorCode[MapleStoryApiErrorCode["OPENAPI00011"] = 9] = "OPENAPI00011";
+})(exports.MapleStoryApiErrorCode || (exports.MapleStoryApiErrorCode = {}));
+const ERROR_MAP = {
+    ['OPENAPI00001']: exports.MapleStoryApiErrorCode.OPENAPI00001,
+    ['OPENAPI00002']: exports.MapleStoryApiErrorCode.OPENAPI00002,
+    ['OPENAPI00003']: exports.MapleStoryApiErrorCode.OPENAPI00003,
+    ['OPENAPI00004']: exports.MapleStoryApiErrorCode.OPENAPI00004,
+    ['OPENAPI00005']: exports.MapleStoryApiErrorCode.OPENAPI00005,
+    ['OPENAPI00006']: exports.MapleStoryApiErrorCode.OPENAPI00006,
+    ['OPENAPI00007']: exports.MapleStoryApiErrorCode.OPENAPI00007,
+    ['OPENAPI00009']: exports.MapleStoryApiErrorCode.OPENAPI00009,
+    ['OPENAPI00010']: exports.MapleStoryApiErrorCode.OPENAPI00010,
+    ['OPENAPI00011']: exports.MapleStoryApiErrorCode.OPENAPI00011,
+};
+
+exports.MapleStoryApiError = MapleStoryApiError;

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

@@ -0,0 +1,22 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var character = require('../../../common/dto/character/character.js');
+
+/**
+ * 캐릭터 식별 정보
+ */
+class CharacterDto extends character.CharacterDto {
+    /**
+     * 캐릭터 식별자
+     */
+    ocid;
+    constructor(obj) {
+        super();
+        const { ocid } = obj;
+        this.ocid = ocid;
+    }
+}
+
+exports.CharacterDto = CharacterDto;

package/dist/cjs/maplestory/api/kms/dto/character/characterAbility.js

@@ -0,0 +1,108 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var characterAbility = require('../../../common/dto/character/characterAbility.js');
+
+/**
+ * 캐릭터 어빌리티 정보
+ */
+class CharacterAbilityDto extends characterAbility.CharacterAbilityDto {
+    /**
+     * 조회 기준일 (KST, 일 단위 데이터로 시, 분은 일괄 0으로 표기)
+     */
+    date;
+    /**
+     * 어빌리티 등급
+     */
+    abilityGrade;
+    /**
+     *  어빌리티 정보
+     */
+    abilityInfo;
+    /**
+     * 보유 명성치
+     */
+    remainFame;
+    /**
+     * 적용 중인 어빌리티 프리셋 번호
+     */
+    presetNo;
+    /**
+     * 어빌리티 1번 프리셋 전체 정보
+     */
+    abilityPreset1;
+    /**
+     * 어빌리티 2번 프리셋 전체 정보
+     */
+    abilityPreset2;
+    /**
+     * 어빌리티 3번 프리셋 전체 정보
+     */
+    abilityPreset3;
+    constructor(obj) {
+        super();
+        const { date, ability_grade, ability_info, remain_fame, preset_no, ability_preset_1, ability_preset_2, ability_preset_3, } = obj;
+        this.date = date ? new Date(date) : null;
+        this.abilityGrade = ability_grade;
+        this.abilityInfo = ability_info.map((info) => new CharacterAbilityInfoDto(info));
+        this.remainFame = remain_fame;
+        this.presetNo = preset_no;
+        this.abilityPreset1 = ability_preset_1
+            ? new CharacterAbilityPresetDto(ability_preset_1)
+            : null;
+        this.abilityPreset2 = ability_preset_2
+            ? new CharacterAbilityPresetDto(ability_preset_2)
+            : null;
+        this.abilityPreset3 = ability_preset_3
+            ? new CharacterAbilityPresetDto(ability_preset_3)
+            : null;
+    }
+}
+/**
+ * 캐릭터 어빌리티 상세 정보
+ */
+class CharacterAbilityInfoDto extends characterAbility.CharacterAbilityInfoDto {
+    /**
+     * 어빌리티 번호
+     */
+    abilityNo;
+    /**
+     * 어빌리티 등급
+     */
+    abilityGrade;
+    /**
+     * 어빌리티 옵션 및 수치
+     */
+    abilityValue;
+    constructor(obj) {
+        super();
+        const { ability_no, ability_grade, ability_value } = obj;
+        this.abilityNo = ability_no;
+        this.abilityGrade = ability_grade;
+        this.abilityValue = ability_value;
+    }
+}
+/**
+ * 캐릭터 어빌리티 프리셋 정보
+ */
+class CharacterAbilityPresetDto extends characterAbility.CharacterAbilityPresetDto {
+    /**
+     * 프리셋의 어빌리티 등급
+     */
+    abilityPresetGrade;
+    /**
+     * 프리셋의 어빌리티 정보
+     */
+    abilityInfo;
+    constructor(obj) {
+        super();
+        const { ability_preset_grade, ability_info } = obj;
+        this.abilityPresetGrade = ability_preset_grade;
+        this.abilityInfo = ability_info.map((info) => new CharacterAbilityInfoDto(info));
+    }
+}
+
+exports.CharacterAbilityDto = CharacterAbilityDto;
+exports.CharacterAbilityInfoDto = CharacterAbilityInfoDto;
+exports.CharacterAbilityPresetDto = CharacterAbilityPresetDto;