maplestory-openapi 2.13.1 → 3.1.0

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

@@ -0,0 +1,112 @@
+import axios, { AxiosError } from 'axios';
+import dayjs from 'dayjs';
+import timezone from '../../../node_modules/dayjs/plugin/timezone.js';
+import utc from '../../../node_modules/dayjs/plugin/utc.js';
+import { MapleStoryApiError } from './mapleStoryApiError.js';
+
+dayjs.extend(timezone);
+dayjs.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.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 AxiosError) {
+                const errorBody = error.response
+                    .data;
+                throw new MapleStoryApiError(errorBody);
+            }
+            throw error;
+        });
+    }
+    //#endregion
+    /**
+     * API 서버의 데이터 갱신 시간에 따라 데이터가 조회 가능한 최신 날짜를 반환합니다.
+     *
+     * @param options
+     */
+    getProperDefaultDateOptions(options) {
+        const { hour, minute, dateOffset } = options;
+        const nowInTimezone = dayjs().utcOffset(this.timezoneOffset);
+        const updateDate = dayjs().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(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(`${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(`${minYear}-${minMonth}-${minDay}`).format('YYYY-MM-DD')}.`);
+            }
+        }
+        return str;
+    }
+    ;
+}
+
+export { MapleStoryApi };

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

@@ -0,0 +1,46 @@
+/**
+ * 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.
+ */
+var MapleStoryApiErrorCode;
+(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";
+})(MapleStoryApiErrorCode || (MapleStoryApiErrorCode = {}));
+const ERROR_MAP = {
+    ['OPENAPI00001']: MapleStoryApiErrorCode.OPENAPI00001,
+    ['OPENAPI00002']: MapleStoryApiErrorCode.OPENAPI00002,
+    ['OPENAPI00003']: MapleStoryApiErrorCode.OPENAPI00003,
+    ['OPENAPI00004']: MapleStoryApiErrorCode.OPENAPI00004,
+    ['OPENAPI00005']: MapleStoryApiErrorCode.OPENAPI00005,
+    ['OPENAPI00006']: MapleStoryApiErrorCode.OPENAPI00006,
+    ['OPENAPI00007']: MapleStoryApiErrorCode.OPENAPI00007,
+    ['OPENAPI00009']: MapleStoryApiErrorCode.OPENAPI00009,
+    ['OPENAPI00010']: MapleStoryApiErrorCode.OPENAPI00010,
+    ['OPENAPI00011']: MapleStoryApiErrorCode.OPENAPI00011,
+};
+
+export { MapleStoryApiError, MapleStoryApiErrorCode };

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

@@ -0,0 +1,18 @@
+import { CharacterDto as CharacterDto$1 } from '../../../common/dto/character/character.js';
+
+/**
+ * 캐릭터 식별 정보
+ */
+class CharacterDto extends CharacterDto$1 {
+    /**
+     * 캐릭터 식별자
+     */
+    ocid;
+    constructor(obj) {
+        super();
+        const { ocid } = obj;
+        this.ocid = ocid;
+    }
+}
+
+export { CharacterDto };

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

@@ -0,0 +1,102 @@
+import { CharacterAbilityDto as CharacterAbilityDto$1, CharacterAbilityInfoDto as CharacterAbilityInfoDto$1, CharacterAbilityPresetDto as CharacterAbilityPresetDto$1 } from '../../../common/dto/character/characterAbility.js';
+
+/**
+ * 캐릭터 어빌리티 정보
+ */
+class CharacterAbilityDto extends CharacterAbilityDto$1 {
+    /**
+     * 조회 기준일 (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 CharacterAbilityInfoDto$1 {
+    /**
+     * 어빌리티 번호
+     */
+    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 CharacterAbilityPresetDto$1 {
+    /**
+     * 프리셋의 어빌리티 등급
+     */
+    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));
+    }
+}
+
+export { CharacterAbilityDto, CharacterAbilityInfoDto, CharacterAbilityPresetDto };