maplestory-openapi 1.0.1 → 2.0.0

package/README.md

@@ -2,7 +2,7 @@
 
 [![npm](https://img.shields.io/npm/v/maplestory-openapi)](https://www.npmjs.com/package/maplestory-openapi)
 
-This JavaScript library enables the use of the MapleStory OpenAPI provided by Nexon.
+This JavaScript library enables the use of the MapleStory OpenAPI of Nexon.
 
 Packages written in other languages can be found [HERE](https://github.com/SpiralMoon/maplestory.openapi).
 
@@ -13,11 +13,15 @@ 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@1.0.1 # Replace with the latest version
+npm install maplestory-openapi@2.0.0 # Replace with the latest version
 ```
 
 ## Usage
 
+### API Key
+
+Before using the library, register your application and obtain an **api key** from the [Nexon Open API Console](https://openapi.nexon.com/my-application/).
+
 ### Supports
 
 1. **CommonJS, ESM Support**: The library supports both CommonJS and ESM usage.
@@ -45,7 +49,7 @@ api.getCubeResult(1000, {
     day: 15
 })
     .then((dto) => {
-        const {count, cubeHistories, nextCursor} = dto;
+        const {count, cubeHistory, nextCursor} = dto;
 
         console.log('You used ' + count + ' cubes.');
     })
@@ -62,17 +66,18 @@ api.getCubeResult(1000, {
 
 ### Exception Handling
 
-Handle `MapleStoryApiError` to safely make calls, ensuring that specific Status defined in the [MapleStory OpenAPI Guide](https://developers.nexon.com/Maplestory/guides) are not encountered.
+Handle `MapleStoryApiError` to safely make calls, ensuring that specific Status defined in the [MapleStory OpenAPI Guide](https://openapi.nexon.com/guide/request-api) are not encountered.
 
 While `MapleStoryApi` is designed to prevent the occurrence of certain Status, exceptions may arise due to developer mistakes.
 
-Therefore, it's recommended to use `MapleStoryApiError` for exception handling based on the Status list described in the table below.
-
-| Status | Message                                                 |
-|--------|---------------------------------------------------------|
-| 400    | Request format error (incorrect parameter input)        |
-| 401    | Unauthorized service (unsupported service, service type) |
-| 403    | Unauthorized AccessToken usage                          |
-| 429    | AccessToken's request allowance (Rate Limit) exceeded   |
-| 500    | Internal server error                                   |
-| 504    | Internal server processing timeout                      |
+Therefore, it's recommended to use `MapleStoryApiError` for exception handling based on the `MapleStoryApiErrorCode` list described in the table below.
+
+| ErrorCode    | Description                                     |
+|--------------|-------------------------------------------------|
+| OPENAPI00001 | Internal server error                           |
+| OPENAPI00002 | Access denied                                   |
+| OPENAPI00003 | Invalid identifier                              |
+| OPENAPI00004 | Request format error (incorrect parameter input) |
+| OPENAPI00005 | Invalid api key                                 |
+| OPENAPI00006 | Invalid api path                                |
+| OPENAPI00007 | Request allowance (Rate Limit) exceeded         |

package/dist/index.js

@@ -2,11 +2,13 @@
 
 var axios = require('axios');
 var dayjs = require('dayjs');
+var xml2js = require('xml2js');
 
 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);
+var xml2js__default = /*#__PURE__*/_interopDefaultLegacy(xml2js);
 
 exports.PotentialOptionGrade = void 0;
 (function (PotentialOptionGrade) {
@@ -39,7 +41,7 @@ const potentialOptionGradeFromString = (text) => {
  */
 class CubeResultOptionDto {
     /**
-     * 옵션 이름
+     * 옵션 명
      */
     value;
     /**
@@ -57,31 +59,31 @@ class CubeResultOptionDto {
 }
 
 /**
- * 큐브히스토리 정보
+ * 큐브 히스토리
  */
 class CubeHistoryDto {
     /**
-     * 큐브 사용 내역에 대한 고유 식별자
+     * 큐브 히스토리 식별자
      */
     id;
     /**
-     * 캐릭터이름
+     * 캐릭터 명
      */
     characterName;
     /**
-     * 월드 이름
+     * 월드 명
      */
     worldName;
     /**
-     * 큐브 사용 날짜
+     * 사용 일시
      */
-    createDate;
+    dateCreate;
     /**
-     * 사용한 큐브
+     * 사용 큐브
      */
     cubeType;
     /**
-     * 큐브 사용 결과
+     * 사용 결과
      */
     itemUpgradeResult;
     /**
@@ -91,13 +93,13 @@ class CubeHistoryDto {
     /**
      * 장비 분류
      */
-    itemEquipPart;
+    itemEquipmentPart;
     /**
      * 장비 레벨
      */
     itemLevel;
     /**
-     * 큐브를 사용한 장비
+     * 큐브 사용한 장비
      */
     targetItem;
     /**
@@ -117,41 +119,41 @@ class CubeHistoryDto {
      */
     upgradeGuaranteeCount;
     /**
-     * 큐브 사용 전 잠재능력 옵션
+     * 사용 전 잠재능력 옵션
      */
-    beforePotentialOptions;
+    beforePotentialOption;
     /**
-     * 큐브 사용 전 에디셔널 잠재능력 옵션
+     * 사용 전 에디셔널 잠재능력 옵션
      */
-    beforeAdditionalPotentialOptions;
+    beforeAdditionalPotentialOption;
     /**
-     * 큐브 사용 후 잠재능력 옵션
+     * 사용 후 잠재능력 옵션
      */
-    afterPotentialOptions;
+    afterPotentialOption;
     /**
-     * 큐브 사용 후 에디셔널 잠재능력 옵션
+     * 사용 후 에디셔널 잠재능력 옵션
      */
-    afterAdditionalPotentialOptions;
+    afterAdditionalPotentialOption;
     constructor(obj) {
-        const { id, character_name, world_name, create_date, cube_type, item_upgrade_result, miracle_time_flag, item_equip_part, item_level, target_item, potential_option_grade, additional_potential_option_grade, upgradeguarantee, upgradeguaranteecount, before_potential_options, before_additional_potential_options, after_potential_options, after_additional_potential_options } = obj;
+        const { id, character_name, world_name, date_create, cube_type, item_upgrade_result, miracle_time_flag, item_equipment_part, item_level, target_item, potential_option_grade, additional_potential_option_grade, upgrade_guarantee, upgrade_guarantee_count, before_potential_option, before_additional_potential_option, after_potential_option, after_additional_potential_option } = obj;
         this.id = id;
         this.characterName = character_name;
         this.worldName = world_name;
-        this.createDate = create_date;
+        this.dateCreate = new Date(date_create);
         this.cubeType = cube_type;
         this.itemUpgradeResult = item_upgrade_result;
         this.miracleTimeFlag = miracle_time_flag;
-        this.itemEquipPart = item_equip_part;
+        this.itemEquipmentPart = item_equipment_part;
         this.itemLevel = item_level;
         this.targetItem = target_item;
         this.potentialOptionGrade = potential_option_grade;
         this.additionalPotentialOptionGrade = additional_potential_option_grade;
-        this.upgradeGuarantee = upgradeguarantee;
-        this.upgradeGuaranteeCount = upgradeguaranteecount;
-        this.beforePotentialOptions = before_potential_options.map(origin => new CubeResultOptionDto(origin));
-        this.beforeAdditionalPotentialOptions = before_additional_potential_options.map(origin => new CubeResultOptionDto(origin));
-        this.afterPotentialOptions = after_potential_options.map(origin => new CubeResultOptionDto(origin));
-        this.afterAdditionalPotentialOptions = after_additional_potential_options.map(origin => new CubeResultOptionDto(origin));
+        this.upgradeGuarantee = upgrade_guarantee;
+        this.upgradeGuaranteeCount = upgrade_guarantee_count;
+        this.beforePotentialOption = before_potential_option.map(origin => new CubeResultOptionDto(origin));
+        this.beforeAdditionalPotentialOption = before_additional_potential_option.map(origin => new CubeResultOptionDto(origin));
+        this.afterPotentialOption = after_potential_option.map(origin => new CubeResultOptionDto(origin));
+        this.afterAdditionalPotentialOption = after_additional_potential_option.map(origin => new CubeResultOptionDto(origin));
     }
     get isItemUpgrade() {
         return this.itemUpgradeResult === '성공';
@@ -168,7 +170,7 @@ class CubeHistoryDto {
 }
 
 /**
- * 큐브히스토리 응답 정보
+ * 큐브 히스토리 응답 정보
  */
 class CubeHistoryResponseDto {
     /**
@@ -178,34 +180,86 @@ class CubeHistoryResponseDto {
     /**
      * 큐브 히스토리
      */
-    cubeHistories;
+    cubeHistory;
     /**
      * 페이징 처리를 위한 cursor
      */
     nextCursor;
     constructor(obj) {
-        const { count, cube_histories, next_cursor } = obj;
+        const { count, cube_history, next_cursor } = obj;
         this.count = count;
-        this.cubeHistories = cube_histories.map(origin => new CubeHistoryDto(origin));
+        this.cubeHistory = cube_history.map(origin => new CubeHistoryDto(origin));
         this.nextCursor = next_cursor;
     }
 }
 
+/**
+ * 서버 점검 정보
+ */
+class InspectionInfoDto {
+    /**
+     * 서비스 코드
+     */
+    serviceCode;
+    /**
+     * 점검 시작 시각
+     */
+    startDateTime;
+    /**
+     * 점검 종료 시각
+     */
+    endDateTime;
+    /**
+     * 점검 안내 제목
+     */
+    strObstacleContents;
+    constructor(obj) {
+        const inspectionInfoTag = obj["soap:Envelope"]['soap:Body'][0]['GetInspectionInfoResponse'][0]['GetInspectionInfoResult'][0]['diffgr:diffgram'][0]['NewDataSet'][0]['InspectionInfo'][0];
+        this.serviceCode = Number(inspectionInfoTag.serviceCode[0]);
+        this.startDateTime = new Date(inspectionInfoTag.startDateTime[0]);
+        this.endDateTime = new Date(inspectionInfoTag.endDateTime[0]);
+        this.strObstacleContents = inspectionInfoTag.strObstacleContents[0];
+    }
+}
+
 /**
  * MapleStory OpenAPI error.<br>
- * Please refer to <a href="https://developers.nexon.com/Maplestory/guides">MapleStory API guide</a> for the error details.
+ * 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';
-    status;
+    errorCode;
     message;
-    constructor(params) {
-        const { status, message } = params;
+    constructor(errorBody) {
+        const { name, message } = errorBody.error;
         super(message);
-        this.status = status;
+        this.errorCode = errorMap[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";
+})(exports.MapleStoryApiErrorCode || (exports.MapleStoryApiErrorCode = {}));
+const errorMap = {
+    ['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,
+};
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -227,9 +281,13 @@ var utc = utc$1.exports;
 
 dayjs__default["default"].extend(timezone);
 dayjs__default["default"].extend(utc);
+/**
+ * MapleStory OpenAPI client.<br>
+ * This is an implementation of <a href="https://openapi.nexon.com/game/maplestory">MapleStory API</a>
+ */
 class MapleStoryApi {
     apiKey;
-    static baseUrl = 'https://public.api.nexon.com/';
+    static BASE_URL = 'https://open.api.nexon.com/';
     static kstOffset = 540;
     timeout;
     constructor(apiKey) {
@@ -249,16 +307,16 @@ class MapleStoryApi {
                 throw new Error('You can only retrieve data after 2022-11-25.');
             }
             const date = dayjs__default["default"](`${year}-${month}-${day}`).utcOffset(MapleStoryApi.kstOffset);
-            query.date = date.format('YYYY-MM-DD');
+            query.date_kst = date.format('YYYYMMDD');
         }
         else {
             const now = dayjs__default["default"]().utcOffset(MapleStoryApi.kstOffset);
-            query.date = now.format('YYYY-MM-DD');
+            query.date_kst = now.format('YYYYMMDD');
         }
         try {
-            const path = 'openapi/maplestory/v1/cube-use-results';
+            const path = 'maplestory/v1/history/cube';
             const response = await axios__default["default"].get(path, {
-                baseURL: MapleStoryApi.baseUrl,
+                baseURL: MapleStoryApi.BASE_URL,
                 timeout: this.timeout,
                 headers: this.buildHeaders(),
                 params: query
@@ -273,9 +331,45 @@ class MapleStoryApi {
             throw e;
         }
     }
+    /**
+     * 서버 점검 정보를 조회합니다.
+     */
+    async getInspectionInfo() {
+        const xmlBuilder = new xml2js__default["default"].Builder();
+        const soapEnvelop = {
+            'soap:Envelope': {
+                $: {
+                    'xmlns:xsi': 'http://www.w3.org/2001/XMLSchema-instance',
+                    'xmlns:xsd': 'http://www.w3.org/2001/XMLSchema',
+                    'xmlns:soap': 'http://schemas.xmlsoap.org/soap/envelope/'
+                },
+                'soap:Body': {
+                    'GetInspectionInfo': {
+                        $: {
+                            'xmlns': 'https://api.maplestory.nexon.com/soap/'
+                        }
+                    }
+                }
+            }
+        };
+        const baseUrl = 'https://api.maplestory.nexon.com/';
+        const path = 'soap/maplestory.asmx';
+        const headers = {
+            'SOAPAction': 'https://api.maplestory.nexon.com/soap/GetInspectionInfo',
+            'Content-Type': 'text/xml; charset=utf-8'
+        };
+        const body = xmlBuilder.buildObject(soapEnvelop);
+        const response = await axios__default["default"].post(path, body, {
+            baseURL: baseUrl,
+            timeout: this.timeout,
+            headers,
+        });
+        const xml = await xml2js__default["default"].parseStringPromise(response.data);
+        return new InspectionInfoDto(xml);
+    }
     buildHeaders() {
         return {
-            'authorization': this.apiKey
+            'x-nxopen-api-key': this.apiKey
         };
     }
 }
@@ -283,6 +377,7 @@ class MapleStoryApi {
 exports.CubeHistoryDto = CubeHistoryDto;
 exports.CubeHistoryResponseDto = CubeHistoryResponseDto;
 exports.CubeResultOptionDto = CubeResultOptionDto;
+exports.InspectionInfoDto = InspectionInfoDto;
 exports.MapleStoryApi = MapleStoryApi;
 exports.MapleStoryApiError = MapleStoryApiError;
 exports.potentialOptionGradeFromString = potentialOptionGradeFromString;

package/dist/index.min.js

@@ -1 +1 @@
-!function(t,e){"object"==typeof exports&&"undefined"!=typeof module?e(exports,require("axios"),require("dayjs")):"function"==typeof define&&define.amd?define(["exports","axios","dayjs"],e):e((t="undefined"!=typeof globalThis?globalThis:t||self)["maplestory-openapi"]={},t.axios,t.dayjs)}(this,(function(t,e,i){"use strict";function a(t){return t&&"object"==typeof t&&"default"in t?t:{default:t}}var o,n=a(e),r=a(i);t.PotentialOptionGrade=void 0,(o=t.PotentialOptionGrade||(t.PotentialOptionGrade={}))[o.RARE=0]="RARE",o[o.EPIC=1]="EPIC",o[o.UNIQUE=2]="UNIQUE",o[o.LEGENDARY=3]="LEGENDARY";const s=e=>{const i={"레어":t.PotentialOptionGrade.RARE,"에픽":t.PotentialOptionGrade.EPIC,"유니크":t.PotentialOptionGrade.UNIQUE,"레전드리":t.PotentialOptionGrade.LEGENDARY}[e];if(!i)throw new TypeError("No enum constant for string: "+e);return i};class u{value;grade;constructor(t){const{value:e,grade:i}=t;this.value=e,this.grade=i}get gradeEnum(){return s(this.grade)}}class f{id;characterName;worldName;createDate;cubeType;itemUpgradeResult;miracleTimeFlag;itemEquipPart;itemLevel;targetItem;potentialOptionGrade;additionalPotentialOptionGrade;upgradeGuarantee;upgradeGuaranteeCount;beforePotentialOptions;beforeAdditionalPotentialOptions;afterPotentialOptions;afterAdditionalPotentialOptions;constructor(t){const{id:e,character_name:i,world_name:a,create_date:o,cube_type:n,item_upgrade_result:r,miracle_time_flag:s,item_equip_part:f,item_level:l,target_item:c,potential_option_grade:d,additional_potential_option_grade:h,upgradeguarantee:p,upgradeguaranteecount:m,before_potential_options:g,before_additional_potential_options:v,after_potential_options:$,after_additional_potential_options:O}=t;this.id=e,this.characterName=i,this.worldName=a,this.createDate=o,this.cubeType=n,this.itemUpgradeResult=r,this.miracleTimeFlag=s,this.itemEquipPart=f,this.itemLevel=l,this.targetItem=c,this.potentialOptionGrade=d,this.additionalPotentialOptionGrade=h,this.upgradeGuarantee=p,this.upgradeGuaranteeCount=m,this.beforePotentialOptions=g.map((t=>new u(t))),this.beforeAdditionalPotentialOptions=v.map((t=>new u(t))),this.afterPotentialOptions=$.map((t=>new u(t))),this.afterAdditionalPotentialOptions=O.map((t=>new u(t)))}get isItemUpgrade(){return"성공"===this.itemUpgradeResult}get isMiracleTimeFlag(){return"이벤트 적용되지 않음"!==this.miracleTimeFlag}get potentialOptionGradeEnum(){return s(this.potentialOptionGrade)}get additionalPotentialOptionGradeEnum(){return s(this.additionalPotentialOptionGrade)}}class l{count;cubeHistories;nextCursor;constructor(t){const{count:e,cube_histories:i,next_cursor:a}=t;this.count=e,this.cubeHistories=i.map((t=>new f(t))),this.nextCursor=a}}class c extends Error{name="MapleStoryApiError";status;message;constructor(t){const{status:e,message:i}=t;super(i),this.status=e,this.message=i}}"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self&&self;var d={exports:{}};!function(t,e){var i,a;t.exports=(i={year:0,month:1,day:2,hour:3,minute:4,second:5},a={},function(t,e,o){var n,r=function(t,e,i){void 0===i&&(i={});var o=new Date(t),n=function(t,e){void 0===e&&(e={});var i=e.timeZoneName||"short",o=t+"|"+i,n=a[o];return n||(n=new Intl.DateTimeFormat("en-US",{hour12:!1,timeZone:t,year:"numeric",month:"2-digit",day:"2-digit",hour:"2-digit",minute:"2-digit",second:"2-digit",timeZoneName:i}),a[o]=n),n}(e,i);return n.formatToParts(o)},s=function(t,e){for(var a=r(t,e),n=[],s=0;s<a.length;s+=1){var u=a[s],f=u.type,l=u.value,c=i[f];c>=0&&(n[c]=parseInt(l,10))}var d=n[3],h=24===d?0:d,p=n[0]+"-"+n[1]+"-"+n[2]+" "+h+":"+n[4]+":"+n[5]+":000",m=+t;return(o.utc(p).valueOf()-(m-=m%1e3))/6e4},u=e.prototype;u.tz=function(t,e){void 0===t&&(t=n);var i=this.utcOffset(),a=this.toDate(),r=a.toLocaleString("en-US",{timeZone:t}),s=Math.round((a-new Date(r))/1e3/60),u=o(r,{locale:this.$L}).$set("millisecond",this.$ms).utcOffset(15*-Math.round(a.getTimezoneOffset()/15)-s,!0);if(e){var f=u.utcOffset();u=u.add(i-f,"minute")}return u.$x.$timezone=t,u},u.offsetName=function(t){var e=this.$x.$timezone||o.tz.guess(),i=r(this.valueOf(),e,{timeZoneName:t}).find((function(t){return"timezonename"===t.type.toLowerCase()}));return i&&i.value};var f=u.startOf;u.startOf=function(t,e){if(!this.$x||!this.$x.$timezone)return f.call(this,t,e);var i=o(this.format("YYYY-MM-DD HH:mm:ss:SSS"),{locale:this.$L});return f.call(i,t,e).tz(this.$x.$timezone,!0)},o.tz=function(t,e,i){var a=i&&e,r=i||e||n,u=s(+o(),r);if("string"!=typeof t)return o(t).tz(r);var f=function(t,e,i){var a=t-60*e*1e3,o=s(a,i);if(e===o)return[a,e];var n=s(a-=60*(o-e)*1e3,i);return o===n?[a,o]:[t-60*Math.min(o,n)*1e3,Math.max(o,n)]}(o.utc(t,a).valueOf(),u,r),l=f[0],c=f[1],d=o(l).utcOffset(c);return d.$x.$timezone=r,d},o.tz.guess=function(){return Intl.DateTimeFormat().resolvedOptions().timeZone},o.tz.setDefault=function(t){n=t}})}(d);var h=d.exports,p={exports:{}};!function(t,e){var i,a,o;t.exports=(i="minute",a=/[+-]\d\d(?::?\d\d)?/g,o=/([+-]|\d\d)/g,function(t,e,n){var r=e.prototype;n.utc=function(t){return new e({date:t,utc:!0,args:arguments})},r.utc=function(t){var e=n(this.toDate(),{locale:this.$L,utc:!0});return t?e.add(this.utcOffset(),i):e},r.local=function(){return n(this.toDate(),{locale:this.$L,utc:!1})};var s=r.parse;r.parse=function(t){t.utc&&(this.$u=!0),this.$utils().u(t.$offset)||(this.$offset=t.$offset),s.call(this,t)};var u=r.init;r.init=function(){if(this.$u){var t=this.$d;this.$y=t.getUTCFullYear(),this.$M=t.getUTCMonth(),this.$D=t.getUTCDate(),this.$W=t.getUTCDay(),this.$H=t.getUTCHours(),this.$m=t.getUTCMinutes(),this.$s=t.getUTCSeconds(),this.$ms=t.getUTCMilliseconds()}else u.call(this)};var f=r.utcOffset;r.utcOffset=function(t,e){var n=this.$utils().u;if(n(t))return this.$u?0:n(this.$offset)?f.call(this):this.$offset;if("string"==typeof t&&(t=function(t){void 0===t&&(t="");var e=t.match(a);if(!e)return null;var i=(""+e[0]).match(o)||["-",0,0],n=i[0],r=60*+i[1]+ +i[2];return 0===r?0:"+"===n?r:-r}(t),null===t))return this;var r=Math.abs(t)<=16?60*t:t,s=this;if(e)return s.$offset=r,s.$u=0===t,s;if(0!==t){var u=this.$u?this.toDate().getTimezoneOffset():-1*this.utcOffset();(s=this.local().add(r+u,i)).$offset=r,s.$x.$localOffset=u}else s=this.utc();return s};var l=r.format;r.format=function(t){var e=t||(this.$u?"YYYY-MM-DDTHH:mm:ss[Z]":"");return l.call(this,e)},r.valueOf=function(){var t=this.$utils().u(this.$offset)?0:this.$offset+(this.$x.$localOffset||this.$d.getTimezoneOffset());return this.$d.valueOf()-6e4*t},r.isUTC=function(){return!!this.$u},r.toISOString=function(){return this.toDate().toISOString()},r.toString=function(){return this.toDate().toUTCString()};var c=r.toDate;r.toDate=function(t){return"s"===t&&this.$offset?n(this.format("YYYY-MM-DD HH:mm:ss:SSS")).toDate():c.call(this)};var d=r.diff;r.diff=function(t,e,i){if(t&&this.$u===t.$u)return d.call(this,t,e,i);var a=this.local(),o=n(t).local();return d.call(a,o,e,i)}})}(p);var m=p.exports;r.default.extend(h),r.default.extend(m);class g{apiKey;static baseUrl="https://public.api.nexon.com/";static kstOffset=540;timeout;constructor(t){this.apiKey=t,this.timeout=5e3}async getCubeResult(t,i){const a={count:t};if("string"==typeof i)a.cursor=i;else if("object"==typeof i){const{year:t,month:e,day:o}=i;if(t<=2022&&e<=11&&o<25)throw new Error("You can only retrieve data after 2022-11-25.");const n=r.default(`${t}-${e}-${o}`).utcOffset(g.kstOffset);a.date=n.format("YYYY-MM-DD")}else{const t=r.default().utcOffset(g.kstOffset);a.date=t.format("YYYY-MM-DD")}try{const t="openapi/maplestory/v1/cube-use-results",e=await n.default.get(t,{baseURL:g.baseUrl,timeout:this.timeout,headers:this.buildHeaders(),params:a});return new l(e.data)}catch(t){if(t instanceof e.AxiosError){const e=t.response.data;throw new c(e)}throw t}}buildHeaders(){return{authorization:this.apiKey}}}t.CubeHistoryDto=f,t.CubeHistoryResponseDto=l,t.CubeResultOptionDto=u,t.MapleStoryApi=g,t.MapleStoryApiError=c,t.potentialOptionGradeFromString=s}));
+!function(t,e){"object"==typeof exports&&"undefined"!=typeof module?e(exports,require("axios"),require("dayjs"),require("xml2js")):"function"==typeof define&&define.amd?define(["exports","axios","dayjs","xml2js"],e):e((t="undefined"!=typeof globalThis?globalThis:t||self)["maplestory-openapi"]={},t.axios,t.dayjs,t.xml2js)}(this,(function(t,e,i,o){"use strict";function a(t){return t&&"object"==typeof t&&"default"in t?t:{default:t}}var r,n=a(e),s=a(i),u=a(o);t.PotentialOptionGrade=void 0,(r=t.PotentialOptionGrade||(t.PotentialOptionGrade={}))[r.RARE=0]="RARE",r[r.EPIC=1]="EPIC",r[r.UNIQUE=2]="UNIQUE",r[r.LEGENDARY=3]="LEGENDARY";const l=e=>{const i={"레어":t.PotentialOptionGrade.RARE,"에픽":t.PotentialOptionGrade.EPIC,"유니크":t.PotentialOptionGrade.UNIQUE,"레전드리":t.PotentialOptionGrade.LEGENDARY}[e];if(!i)throw new TypeError("No enum constant for string: "+e);return i};class f{value;grade;constructor(t){const{value:e,grade:i}=t;this.value=e,this.grade=i}get gradeEnum(){return l(this.grade)}}class d{id;characterName;worldName;dateCreate;cubeType;itemUpgradeResult;miracleTimeFlag;itemEquipmentPart;itemLevel;targetItem;potentialOptionGrade;additionalPotentialOptionGrade;upgradeGuarantee;upgradeGuaranteeCount;beforePotentialOption;beforeAdditionalPotentialOption;afterPotentialOption;afterAdditionalPotentialOption;constructor(t){const{id:e,character_name:i,world_name:o,date_create:a,cube_type:r,item_upgrade_result:n,miracle_time_flag:s,item_equipment_part:u,item_level:l,target_item:d,potential_option_grade:p,additional_potential_option_grade:c,upgrade_guarantee:h,upgrade_guarantee_count:m,before_potential_option:O,before_additional_potential_option:g,after_potential_option:P,after_additional_potential_option:y}=t;this.id=e,this.characterName=i,this.worldName=o,this.dateCreate=new Date(a),this.cubeType=r,this.itemUpgradeResult=n,this.miracleTimeFlag=s,this.itemEquipmentPart=u,this.itemLevel=l,this.targetItem=d,this.potentialOptionGrade=p,this.additionalPotentialOptionGrade=c,this.upgradeGuarantee=h,this.upgradeGuaranteeCount=m,this.beforePotentialOption=O.map((t=>new f(t))),this.beforeAdditionalPotentialOption=g.map((t=>new f(t))),this.afterPotentialOption=P.map((t=>new f(t))),this.afterAdditionalPotentialOption=y.map((t=>new f(t)))}get isItemUpgrade(){return"성공"===this.itemUpgradeResult}get isMiracleTimeFlag(){return"이벤트 적용되지 않음"!==this.miracleTimeFlag}get potentialOptionGradeEnum(){return l(this.potentialOptionGrade)}get additionalPotentialOptionGradeEnum(){return l(this.additionalPotentialOptionGrade)}}class p{count;cubeHistory;nextCursor;constructor(t){const{count:e,cube_history:i,next_cursor:o}=t;this.count=e,this.cubeHistory=i.map((t=>new d(t))),this.nextCursor=o}}class c{serviceCode;startDateTime;endDateTime;strObstacleContents;constructor(t){const e=t["soap:Envelope"]["soap:Body"][0].GetInspectionInfoResponse[0].GetInspectionInfoResult[0]["diffgr:diffgram"][0].NewDataSet[0].InspectionInfo[0];this.serviceCode=Number(e.serviceCode[0]),this.startDateTime=new Date(e.startDateTime[0]),this.endDateTime=new Date(e.endDateTime[0]),this.strObstacleContents=e.strObstacleContents[0]}}class h extends Error{name="MapleStoryApiError";errorCode;message;constructor(t){const{name:e,message:i}=t.error;super(i),this.errorCode=O[e],this.message=i}}var m;t.MapleStoryApiErrorCode=void 0,(m=t.MapleStoryApiErrorCode||(t.MapleStoryApiErrorCode={}))[m.OPENAPI00001=0]="OPENAPI00001",m[m.OPENAPI00002=1]="OPENAPI00002",m[m.OPENAPI00003=2]="OPENAPI00003",m[m.OPENAPI00004=3]="OPENAPI00004",m[m.OPENAPI00005=4]="OPENAPI00005",m[m.OPENAPI00006=5]="OPENAPI00006",m[m.OPENAPI00007=6]="OPENAPI00007";const O={OPENAPI00001:t.MapleStoryApiErrorCode.OPENAPI00001,OPENAPI00002:t.MapleStoryApiErrorCode.OPENAPI00002,OPENAPI00003:t.MapleStoryApiErrorCode.OPENAPI00003,OPENAPI00004:t.MapleStoryApiErrorCode.OPENAPI00004,OPENAPI00005:t.MapleStoryApiErrorCode.OPENAPI00005,OPENAPI00006:t.MapleStoryApiErrorCode.OPENAPI00006,OPENAPI00007:t.MapleStoryApiErrorCode.OPENAPI00007};"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self&&self;var g={exports:{}};!function(t,e){var i,o;t.exports=(i={year:0,month:1,day:2,hour:3,minute:4,second:5},o={},function(t,e,a){var r,n=function(t,e,i){void 0===i&&(i={});var a=new Date(t),r=function(t,e){void 0===e&&(e={});var i=e.timeZoneName||"short",a=t+"|"+i,r=o[a];return r||(r=new Intl.DateTimeFormat("en-US",{hour12:!1,timeZone:t,year:"numeric",month:"2-digit",day:"2-digit",hour:"2-digit",minute:"2-digit",second:"2-digit",timeZoneName:i}),o[a]=r),r}(e,i);return r.formatToParts(a)},s=function(t,e){for(var o=n(t,e),r=[],s=0;s<o.length;s+=1){var u=o[s],l=u.type,f=u.value,d=i[l];d>=0&&(r[d]=parseInt(f,10))}var p=r[3],c=24===p?0:p,h=r[0]+"-"+r[1]+"-"+r[2]+" "+c+":"+r[4]+":"+r[5]+":000",m=+t;return(a.utc(h).valueOf()-(m-=m%1e3))/6e4},u=e.prototype;u.tz=function(t,e){void 0===t&&(t=r);var i=this.utcOffset(),o=this.toDate(),n=o.toLocaleString("en-US",{timeZone:t}),s=Math.round((o-new Date(n))/1e3/60),u=a(n,{locale:this.$L}).$set("millisecond",this.$ms).utcOffset(15*-Math.round(o.getTimezoneOffset()/15)-s,!0);if(e){var l=u.utcOffset();u=u.add(i-l,"minute")}return u.$x.$timezone=t,u},u.offsetName=function(t){var e=this.$x.$timezone||a.tz.guess(),i=n(this.valueOf(),e,{timeZoneName:t}).find((function(t){return"timezonename"===t.type.toLowerCase()}));return i&&i.value};var l=u.startOf;u.startOf=function(t,e){if(!this.$x||!this.$x.$timezone)return l.call(this,t,e);var i=a(this.format("YYYY-MM-DD HH:mm:ss:SSS"),{locale:this.$L});return l.call(i,t,e).tz(this.$x.$timezone,!0)},a.tz=function(t,e,i){var o=i&&e,n=i||e||r,u=s(+a(),n);if("string"!=typeof t)return a(t).tz(n);var l=function(t,e,i){var o=t-60*e*1e3,a=s(o,i);if(e===a)return[o,e];var r=s(o-=60*(a-e)*1e3,i);return a===r?[o,a]:[t-60*Math.min(a,r)*1e3,Math.max(a,r)]}(a.utc(t,o).valueOf(),u,n),f=l[0],d=l[1],p=a(f).utcOffset(d);return p.$x.$timezone=n,p},a.tz.guess=function(){return Intl.DateTimeFormat().resolvedOptions().timeZone},a.tz.setDefault=function(t){r=t}})}(g);var P=g.exports,y={exports:{}};!function(t,e){var i,o,a;t.exports=(i="minute",o=/[+-]\d\d(?::?\d\d)?/g,a=/([+-]|\d\d)/g,function(t,e,r){var n=e.prototype;r.utc=function(t){return new e({date:t,utc:!0,args:arguments})},n.utc=function(t){var e=r(this.toDate(),{locale:this.$L,utc:!0});return t?e.add(this.utcOffset(),i):e},n.local=function(){return r(this.toDate(),{locale:this.$L,utc:!1})};var s=n.parse;n.parse=function(t){t.utc&&(this.$u=!0),this.$utils().u(t.$offset)||(this.$offset=t.$offset),s.call(this,t)};var u=n.init;n.init=function(){if(this.$u){var t=this.$d;this.$y=t.getUTCFullYear(),this.$M=t.getUTCMonth(),this.$D=t.getUTCDate(),this.$W=t.getUTCDay(),this.$H=t.getUTCHours(),this.$m=t.getUTCMinutes(),this.$s=t.getUTCSeconds(),this.$ms=t.getUTCMilliseconds()}else u.call(this)};var l=n.utcOffset;n.utcOffset=function(t,e){var r=this.$utils().u;if(r(t))return this.$u?0:r(this.$offset)?l.call(this):this.$offset;if("string"==typeof t&&(t=function(t){void 0===t&&(t="");var e=t.match(o);if(!e)return null;var i=(""+e[0]).match(a)||["-",0,0],r=i[0],n=60*+i[1]+ +i[2];return 0===n?0:"+"===r?n:-n}(t),null===t))return this;var n=Math.abs(t)<=16?60*t:t,s=this;if(e)return s.$offset=n,s.$u=0===t,s;if(0!==t){var u=this.$u?this.toDate().getTimezoneOffset():-1*this.utcOffset();(s=this.local().add(n+u,i)).$offset=n,s.$x.$localOffset=u}else s=this.utc();return s};var f=n.format;n.format=function(t){var e=t||(this.$u?"YYYY-MM-DDTHH:mm:ss[Z]":"");return f.call(this,e)},n.valueOf=function(){var t=this.$utils().u(this.$offset)?0:this.$offset+(this.$x.$localOffset||this.$d.getTimezoneOffset());return this.$d.valueOf()-6e4*t},n.isUTC=function(){return!!this.$u},n.toISOString=function(){return this.toDate().toISOString()},n.toString=function(){return this.toDate().toUTCString()};var d=n.toDate;n.toDate=function(t){return"s"===t&&this.$offset?r(this.format("YYYY-MM-DD HH:mm:ss:SSS")).toDate():d.call(this)};var p=n.diff;n.diff=function(t,e,i){if(t&&this.$u===t.$u)return p.call(this,t,e,i);var o=this.local(),a=r(t).local();return p.call(o,a,e,i)}})}(y);var E=y.exports;s.default.extend(P),s.default.extend(E);class v{apiKey;static BASE_URL="https://open.api.nexon.com/";static kstOffset=540;timeout;constructor(t){this.apiKey=t,this.timeout=5e3}async getCubeResult(t,i){const o={count:t};if("string"==typeof i)o.cursor=i;else if("object"==typeof i){const{year:t,month:e,day:a}=i;if(t<=2022&&e<=11&&a<25)throw new Error("You can only retrieve data after 2022-11-25.");const r=s.default(`${t}-${e}-${a}`).utcOffset(v.kstOffset);o.date_kst=r.format("YYYYMMDD")}else{const t=s.default().utcOffset(v.kstOffset);o.date_kst=t.format("YYYYMMDD")}try{const t="maplestory/v1/history/cube",e=await n.default.get(t,{baseURL:v.BASE_URL,timeout:this.timeout,headers:this.buildHeaders(),params:o});return new p(e.data)}catch(t){if(t instanceof e.AxiosError){const e=t.response.data;throw new h(e)}throw t}}async getInspectionInfo(){const t=(new u.default.Builder).buildObject({"soap:Envelope":{$:{"xmlns:xsi":"http://www.w3.org/2001/XMLSchema-instance","xmlns:xsd":"http://www.w3.org/2001/XMLSchema","xmlns:soap":"http://schemas.xmlsoap.org/soap/envelope/"},"soap:Body":{GetInspectionInfo:{$:{xmlns:"https://api.maplestory.nexon.com/soap/"}}}}}),e=await n.default.post("soap/maplestory.asmx",t,{baseURL:"https://api.maplestory.nexon.com/",timeout:this.timeout,headers:{SOAPAction:"https://api.maplestory.nexon.com/soap/GetInspectionInfo","Content-Type":"text/xml; charset=utf-8"}}),i=await u.default.parseStringPromise(e.data);return new c(i)}buildHeaders(){return{"x-nxopen-api-key":this.apiKey}}}t.CubeHistoryDto=d,t.CubeHistoryResponseDto=p,t.CubeResultOptionDto=f,t.InspectionInfoDto=c,t.MapleStoryApi=v,t.MapleStoryApiError=h,t.potentialOptionGradeFromString=l}));

package/dist/index.mjs

@@ -1,5 +1,6 @@
 import axios, { AxiosError } from 'axios';
 import dayjs from 'dayjs';
+import xml2js from 'xml2js';
 
 var PotentialOptionGrade;
 (function (PotentialOptionGrade) {
@@ -32,7 +33,7 @@ const potentialOptionGradeFromString = (text) => {
  */
 class CubeResultOptionDto {
     /**
-     * 옵션 이름
+     * 옵션 명
      */
     value;
     /**
@@ -50,31 +51,31 @@ class CubeResultOptionDto {
 }
 
 /**
- * 큐브히스토리 정보
+ * 큐브 히스토리
  */
 class CubeHistoryDto {
     /**
-     * 큐브 사용 내역에 대한 고유 식별자
+     * 큐브 히스토리 식별자
      */
     id;
     /**
-     * 캐릭터이름
+     * 캐릭터 명
      */
     characterName;
     /**
-     * 월드 이름
+     * 월드 명
      */
     worldName;
     /**
-     * 큐브 사용 날짜
+     * 사용 일시
      */
-    createDate;
+    dateCreate;
     /**
-     * 사용한 큐브
+     * 사용 큐브
      */
     cubeType;
     /**
-     * 큐브 사용 결과
+     * 사용 결과
      */
     itemUpgradeResult;
     /**
@@ -84,13 +85,13 @@ class CubeHistoryDto {
     /**
      * 장비 분류
      */
-    itemEquipPart;
+    itemEquipmentPart;
     /**
      * 장비 레벨
      */
     itemLevel;
     /**
-     * 큐브를 사용한 장비
+     * 큐브 사용한 장비
      */
     targetItem;
     /**
@@ -110,41 +111,41 @@ class CubeHistoryDto {
      */
     upgradeGuaranteeCount;
     /**
-     * 큐브 사용 전 잠재능력 옵션
+     * 사용 전 잠재능력 옵션
      */
-    beforePotentialOptions;
+    beforePotentialOption;
     /**
-     * 큐브 사용 전 에디셔널 잠재능력 옵션
+     * 사용 전 에디셔널 잠재능력 옵션
      */
-    beforeAdditionalPotentialOptions;
+    beforeAdditionalPotentialOption;
     /**
-     * 큐브 사용 후 잠재능력 옵션
+     * 사용 후 잠재능력 옵션
      */
-    afterPotentialOptions;
+    afterPotentialOption;
     /**
-     * 큐브 사용 후 에디셔널 잠재능력 옵션
+     * 사용 후 에디셔널 잠재능력 옵션
      */
-    afterAdditionalPotentialOptions;
+    afterAdditionalPotentialOption;
     constructor(obj) {
-        const { id, character_name, world_name, create_date, cube_type, item_upgrade_result, miracle_time_flag, item_equip_part, item_level, target_item, potential_option_grade, additional_potential_option_grade, upgradeguarantee, upgradeguaranteecount, before_potential_options, before_additional_potential_options, after_potential_options, after_additional_potential_options } = obj;
+        const { id, character_name, world_name, date_create, cube_type, item_upgrade_result, miracle_time_flag, item_equipment_part, item_level, target_item, potential_option_grade, additional_potential_option_grade, upgrade_guarantee, upgrade_guarantee_count, before_potential_option, before_additional_potential_option, after_potential_option, after_additional_potential_option } = obj;
         this.id = id;
         this.characterName = character_name;
         this.worldName = world_name;
-        this.createDate = create_date;
+        this.dateCreate = new Date(date_create);
         this.cubeType = cube_type;
         this.itemUpgradeResult = item_upgrade_result;
         this.miracleTimeFlag = miracle_time_flag;
-        this.itemEquipPart = item_equip_part;
+        this.itemEquipmentPart = item_equipment_part;
         this.itemLevel = item_level;
         this.targetItem = target_item;
         this.potentialOptionGrade = potential_option_grade;
         this.additionalPotentialOptionGrade = additional_potential_option_grade;
-        this.upgradeGuarantee = upgradeguarantee;
-        this.upgradeGuaranteeCount = upgradeguaranteecount;
-        this.beforePotentialOptions = before_potential_options.map(origin => new CubeResultOptionDto(origin));
-        this.beforeAdditionalPotentialOptions = before_additional_potential_options.map(origin => new CubeResultOptionDto(origin));
-        this.afterPotentialOptions = after_potential_options.map(origin => new CubeResultOptionDto(origin));
-        this.afterAdditionalPotentialOptions = after_additional_potential_options.map(origin => new CubeResultOptionDto(origin));
+        this.upgradeGuarantee = upgrade_guarantee;
+        this.upgradeGuaranteeCount = upgrade_guarantee_count;
+        this.beforePotentialOption = before_potential_option.map(origin => new CubeResultOptionDto(origin));
+        this.beforeAdditionalPotentialOption = before_additional_potential_option.map(origin => new CubeResultOptionDto(origin));
+        this.afterPotentialOption = after_potential_option.map(origin => new CubeResultOptionDto(origin));
+        this.afterAdditionalPotentialOption = after_additional_potential_option.map(origin => new CubeResultOptionDto(origin));
     }
     get isItemUpgrade() {
         return this.itemUpgradeResult === '성공';
@@ -161,7 +162,7 @@ class CubeHistoryDto {
 }
 
 /**
- * 큐브히스토리 응답 정보
+ * 큐브 히스토리 응답 정보
  */
 class CubeHistoryResponseDto {
     /**
@@ -171,34 +172,86 @@ class CubeHistoryResponseDto {
     /**
      * 큐브 히스토리
      */
-    cubeHistories;
+    cubeHistory;
     /**
      * 페이징 처리를 위한 cursor
      */
     nextCursor;
     constructor(obj) {
-        const { count, cube_histories, next_cursor } = obj;
+        const { count, cube_history, next_cursor } = obj;
         this.count = count;
-        this.cubeHistories = cube_histories.map(origin => new CubeHistoryDto(origin));
+        this.cubeHistory = cube_history.map(origin => new CubeHistoryDto(origin));
         this.nextCursor = next_cursor;
     }
 }
 
+/**
+ * 서버 점검 정보
+ */
+class InspectionInfoDto {
+    /**
+     * 서비스 코드
+     */
+    serviceCode;
+    /**
+     * 점검 시작 시각
+     */
+    startDateTime;
+    /**
+     * 점검 종료 시각
+     */
+    endDateTime;
+    /**
+     * 점검 안내 제목
+     */
+    strObstacleContents;
+    constructor(obj) {
+        const inspectionInfoTag = obj["soap:Envelope"]['soap:Body'][0]['GetInspectionInfoResponse'][0]['GetInspectionInfoResult'][0]['diffgr:diffgram'][0]['NewDataSet'][0]['InspectionInfo'][0];
+        this.serviceCode = Number(inspectionInfoTag.serviceCode[0]);
+        this.startDateTime = new Date(inspectionInfoTag.startDateTime[0]);
+        this.endDateTime = new Date(inspectionInfoTag.endDateTime[0]);
+        this.strObstacleContents = inspectionInfoTag.strObstacleContents[0];
+    }
+}
+
 /**
  * MapleStory OpenAPI error.<br>
- * Please refer to <a href="https://developers.nexon.com/Maplestory/guides">MapleStory API guide</a> for the error details.
+ * 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';
-    status;
+    errorCode;
     message;
-    constructor(params) {
-        const { status, message } = params;
+    constructor(errorBody) {
+        const { name, message } = errorBody.error;
         super(message);
-        this.status = status;
+        this.errorCode = errorMap[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 = {}));
+const errorMap = {
+    ['OPENAPI00001']: MapleStoryApiErrorCode.OPENAPI00001,
+    ['OPENAPI00002']: MapleStoryApiErrorCode.OPENAPI00002,
+    ['OPENAPI00003']: MapleStoryApiErrorCode.OPENAPI00003,
+    ['OPENAPI00004']: MapleStoryApiErrorCode.OPENAPI00004,
+    ['OPENAPI00005']: MapleStoryApiErrorCode.OPENAPI00005,
+    ['OPENAPI00006']: MapleStoryApiErrorCode.OPENAPI00006,
+    ['OPENAPI00007']: MapleStoryApiErrorCode.OPENAPI00007,
+};
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -220,9 +273,13 @@ var utc = utc$1.exports;
 
 dayjs.extend(timezone);
 dayjs.extend(utc);
+/**
+ * MapleStory OpenAPI client.<br>
+ * This is an implementation of <a href="https://openapi.nexon.com/game/maplestory">MapleStory API</a>
+ */
 class MapleStoryApi {
     apiKey;
-    static baseUrl = 'https://public.api.nexon.com/';
+    static BASE_URL = 'https://open.api.nexon.com/';
     static kstOffset = 540;
     timeout;
     constructor(apiKey) {
@@ -242,16 +299,16 @@ class MapleStoryApi {
                 throw new Error('You can only retrieve data after 2022-11-25.');
             }
             const date = dayjs(`${year}-${month}-${day}`).utcOffset(MapleStoryApi.kstOffset);
-            query.date = date.format('YYYY-MM-DD');
+            query.date_kst = date.format('YYYYMMDD');
         }
         else {
             const now = dayjs().utcOffset(MapleStoryApi.kstOffset);
-            query.date = now.format('YYYY-MM-DD');
+            query.date_kst = now.format('YYYYMMDD');
         }
         try {
-            const path = 'openapi/maplestory/v1/cube-use-results';
+            const path = 'maplestory/v1/history/cube';
             const response = await axios.get(path, {
-                baseURL: MapleStoryApi.baseUrl,
+                baseURL: MapleStoryApi.BASE_URL,
                 timeout: this.timeout,
                 headers: this.buildHeaders(),
                 params: query
@@ -266,11 +323,47 @@ class MapleStoryApi {
             throw e;
         }
     }
+    /**
+     * 서버 점검 정보를 조회합니다.
+     */
+    async getInspectionInfo() {
+        const xmlBuilder = new xml2js.Builder();
+        const soapEnvelop = {
+            'soap:Envelope': {
+                $: {
+                    'xmlns:xsi': 'http://www.w3.org/2001/XMLSchema-instance',
+                    'xmlns:xsd': 'http://www.w3.org/2001/XMLSchema',
+                    'xmlns:soap': 'http://schemas.xmlsoap.org/soap/envelope/'
+                },
+                'soap:Body': {
+                    'GetInspectionInfo': {
+                        $: {
+                            'xmlns': 'https://api.maplestory.nexon.com/soap/'
+                        }
+                    }
+                }
+            }
+        };
+        const baseUrl = 'https://api.maplestory.nexon.com/';
+        const path = 'soap/maplestory.asmx';
+        const headers = {
+            'SOAPAction': 'https://api.maplestory.nexon.com/soap/GetInspectionInfo',
+            'Content-Type': 'text/xml; charset=utf-8'
+        };
+        const body = xmlBuilder.buildObject(soapEnvelop);
+        const response = await axios.post(path, body, {
+            baseURL: baseUrl,
+            timeout: this.timeout,
+            headers,
+        });
+        const xml = await xml2js.parseStringPromise(response.data);
+        return new InspectionInfoDto(xml);
+    }
     buildHeaders() {
         return {
-            'authorization': this.apiKey
+            'x-nxopen-api-key': this.apiKey
         };
     }
 }
 
-export { CubeHistoryDto, CubeHistoryResponseDto, CubeResultOptionDto, MapleStoryApi, MapleStoryApiError, PotentialOptionGrade, potentialOptionGradeFromString };
+export { CubeHistoryDto, CubeHistoryResponseDto, CubeResultOptionDto, InspectionInfoDto, MapleStoryApi, MapleStoryApiError, MapleStoryApiErrorCode, PotentialOptionGrade, potentialOptionGradeFromString };

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "maplestory-openapi",
-  "version": "1.0.1",
+  "version": "2.0.0",
+  "description": "This JavaScript library enables the use of the MapleStory OpenAPI of Nexon.",
   "keywords": [
     "maplestory",
     "maplestory openapi",
     "maplestory api",
     "cube",
     "nexon",
-    "nexon developers"
+    "nexon developers",
+    "nexon openapi"
   ],
-  "description": "This JavaScript library enables the use of the MapleStory OpenAPI provided by Nexon.",
   "homepage": "https://github.com/SpiralMoon/maplestory.openapi",
   "bugs": {
     "url": "https://github.com/SpiralMoon/maplestory.openapi/issues"
@@ -45,11 +46,13 @@
   },
   "dependencies": {
     "axios": "^1.6.0",
-    "dayjs": "^1.11.10"
+    "dayjs": "^1.11.10",
+    "xml2js": "^0.6.2"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^21.1.0",
     "@rollup/plugin-node-resolve": "13.1.3",
+    "@types/xml2js": "^0.4.14",
     "rollup": "2.66.1",
     "rollup-plugin-terser": "7.0.2",
     "rollup-plugin-typescript2": "0.27.1",

package/types/index.d.ts

@@ -3,4 +3,5 @@ export * from './maplestory/api/mapleStoryApiError';
 export * from './maplestory/api/dto/cubeHistoryDto';
 export * from './maplestory/api/dto/cubeHistoryResponseDto';
 export * from './maplestory/api/dto/cubeResultOptionDto';
+export * from './maplestory/api/dto/inspectionInfoDto';
 export * from './maplestory/api/dto/potentialOptionGrade';

package/types/maplestory/api/dto/cubeHistoryDto.d.ts

@@ -2,31 +2,31 @@ import { CubeResultOptionDto } from "./cubeResultOptionDto";
 import { CubeHistoryDtoBody } from "../response/cubeHistoryDtoBody";
 import { PotentialOptionGrade } from "./potentialOptionGrade";
 /**
- * 큐브히스토리 정보
+ * 큐브 히스토리
  */
 declare class CubeHistoryDto {
     /**
-     * 큐브 사용 내역에 대한 고유 식별자
+     * 큐브 히스토리 식별자
      */
     id: string;
     /**
-     * 캐릭터이름
+     * 캐릭터 명
      */
     characterName: string;
     /**
-     * 월드 이름
+     * 월드 명
      */
     worldName: string;
     /**
-     * 큐브 사용 날짜
+     * 사용 일시
      */
-    createDate: string;
+    dateCreate: Date;
     /**
-     * 사용한 큐브
+     * 사용 큐브
      */
     cubeType: string;
     /**
-     * 큐브 사용 결과
+     * 사용 결과
      */
     itemUpgradeResult: string;
     /**
@@ -36,13 +36,13 @@ declare class CubeHistoryDto {
     /**
      * 장비 분류
      */
-    itemEquipPart: string;
+    itemEquipmentPart: string;
     /**
      * 장비 레벨
      */
     itemLevel: number;
     /**
-     * 큐브를 사용한 장비
+     * 큐브 사용한 장비
      */
     targetItem: string;
     /**
@@ -62,21 +62,21 @@ declare class CubeHistoryDto {
      */
     upgradeGuaranteeCount: number;
     /**
-     * 큐브 사용 전 잠재능력 옵션
+     * 사용 전 잠재능력 옵션
      */
-    beforePotentialOptions: CubeResultOptionDto[];
+    beforePotentialOption: CubeResultOptionDto[];
     /**
-     * 큐브 사용 전 에디셔널 잠재능력 옵션
+     * 사용 전 에디셔널 잠재능력 옵션
      */
-    beforeAdditionalPotentialOptions: CubeResultOptionDto[];
+    beforeAdditionalPotentialOption: CubeResultOptionDto[];
     /**
-     * 큐브 사용 후 잠재능력 옵션
+     * 사용 후 잠재능력 옵션
      */
-    afterPotentialOptions: CubeResultOptionDto[];
+    afterPotentialOption: CubeResultOptionDto[];
     /**
-     * 큐브 사용 후 에디셔널 잠재능력 옵션
+     * 사용 후 에디셔널 잠재능력 옵션
      */
-    afterAdditionalPotentialOptions: CubeResultOptionDto[];
+    afterAdditionalPotentialOption: CubeResultOptionDto[];
     constructor(obj: CubeHistoryDtoBody);
     get isItemUpgrade(): boolean;
     get isMiracleTimeFlag(): boolean;

package/types/maplestory/api/dto/cubeHistoryResponseDto.d.ts

@@ -1,7 +1,7 @@
 import { CubeHistoryDto } from "./cubeHistoryDto";
 import { CubeHistoryResponseDtoBody } from "../response/cubeHistoryResponseDtoBody";
 /**
- * 큐브히스토리 응답 정보
+ * 큐브 히스토리 응답 정보
  */
 declare class CubeHistoryResponseDto {
     /**
@@ -11,7 +11,7 @@ declare class CubeHistoryResponseDto {
     /**
      * 큐브 히스토리
      */
-    cubeHistories: CubeHistoryDto[];
+    cubeHistory: CubeHistoryDto[];
     /**
      * 페이징 처리를 위한 cursor
      */

package/types/maplestory/api/dto/cubeResultOptionDto.d.ts

@@ -5,7 +5,7 @@ import { PotentialOptionGrade } from "./potentialOptionGrade";
  */
 declare class CubeResultOptionDto {
     /**
-     * 옵션 이름
+     * 옵션 명
      */
     value: string;
     /**

package/types/maplestory/api/dto/inspectionInfoDto.d.ts

@@ -0,0 +1,24 @@
+import { InspectionInfoSoapBody } from "../response/inspectionInfoSoapBody";
+/**
+ * 서버 점검 정보
+ */
+declare class InspectionInfoDto {
+    /**
+     * 서비스 코드
+     */
+    serviceCode: number;
+    /**
+     * 점검 시작 시각
+     */
+    startDateTime: Date;
+    /**
+     * 점검 종료 시각
+     */
+    endDateTime: Date;
+    /**
+     * 점검 안내 제목
+     */
+    strObstacleContents: string;
+    constructor(obj: InspectionInfoSoapBody);
+}
+export { InspectionInfoDto };

package/types/maplestory/api/mapleStoryApi.d.ts

@@ -1,36 +1,48 @@
 import { CubeHistoryResponseDto } from "./dto/cubeHistoryResponseDto";
+import { InspectionInfoDto } from "./dto/inspectionInfoDto";
+/**
+ * MapleStory OpenAPI client.<br>
+ * This is an implementation of <a href="https://openapi.nexon.com/game/maplestory">MapleStory API</a>
+ */
 declare class MapleStoryApi {
     private readonly apiKey;
-    private static baseUrl;
+    private static BASE_URL;
     private static kstOffset;
     timeout: number;
     constructor(apiKey: string);
     /**
-     * 오늘 날짜의 확률형 아이템 큐브의 사용 결과를 조회합니다.<br>
-     * 데이터는 일단위로 갱신되며, 오전 4시 조회 시 전일 데이터를 조회할 수 있습니다.<br>
-     * 데이터는 2022년 11월 25일부터 조회할 수 있습니다.<br>
+     * 오늘 날짜의 큐브 사용 결과를 조회합니다.<br>
+     * 큐브 사용 결과 데이터는 매일 오전 4시, 전일 데이터가 갱신됩니다.<br>
+     * 큐브 사용 결과 데이터는 2022년 11월 25일부터 조회할 수 있습니다.<br>
+     * e.g. 오늘 오후 3시 5분 큐브 확률 정보 조회 시, 어제의 큐브 확률 정보 데이터를 조회할 수 있습니다.<br>
      *
-     * @param count 한번에 가져오려는 결과의 갯수(최소 10, 최대 1000) Default value : 10
+     * @param count 한번에 가져오려는 결과의 개수(최소 10, 최대 1000)
      */
     getCubeResult(count: number): Promise<CubeHistoryResponseDto>;
     /**
-     * 지목한 날짜의 확률형 아이템 큐브의 사용 결과를 조회합니다.<br>
-     * 데이터는 일단위로 갱신되며, 오전 4시 조회 시 전일 데이터를 조회할 수 있습니다.<br>
-     * 데이터는 2022년 11월 25일부터 조회할 수 있습니다.<br>
+     * 지목한 날짜의 큐브 사용 결과를 조회합니다.<br>
+     * 큐브 사용 결과 데이터는 매일 오전 4시, 전일 데이터가 갱신됩니다.<br>
+     * 큐브 사용 결과 데이터는 2022년 11월 25일부터 조회할 수 있습니다.<br>
+     * e.g. 오늘 오후 3시 5분 큐브 확률 정보 조회 시, 어제의 큐브 확률 정보 데이터를 조회할 수 있습니다.<br>
      *
-     * @param count 한번에 가져오려는 결과의 갯수(최소 10, 최대 1000) Default value : 10
-     * @param dateOptions 조회할 연월일 날짜 정보
+     * @param count 한번에 가져오려는 결과의 개수(최소 10, 최대 1000)
+     * @param dateOptions 조회 기준일 (KST)
      */
     getCubeResult(count: number, dateOptions: DateOptions): Promise<CubeHistoryResponseDto>;
     /**
-     * 확률형 아이템 큐브의 사용 결과를 조회합니다.<br>
-     * 데이터는 일단위로 갱신되며, 오전 4시 조회 시 전일 데이터를 조회할 수 있습니다.<br>
-     * 데이터는 2022년 11월 25일부터 조회할 수 있습니다.<br>
+     * 큐브 사용 결과를 조회합니다.<br>
+     * 큐브 사용 결과 데이터는 매일 오전 4시, 전일 데이터가 갱신됩니다.<br>
+     * 큐브 사용 결과 데이터는 2022년 11월 25일부터 조회할 수 있습니다.<br>
+     * e.g. 오늘 오후 3시 5분 큐브 확률 정보 조회 시, 어제의 큐브 확률 정보 데이터를 조회할 수 있습니다.<br>
      *
-     * @param count 한번에 가져오려는 결과의 갯수(최소 10, 최대 1000) Default value : 10
-     * @param cursor
+     * @param count 한번에 가져오려는 결과의 개수(최소 10, 최대 1000)
+     * @param cursor 페이징 처리를 위한 cursor
      */
     getCubeResult(count: number, cursor: string): Promise<CubeHistoryResponseDto>;
+    /**
+     * 서버 점검 정보를 조회합니다.
+     */
+    getInspectionInfo(): Promise<InspectionInfoDto>;
     private buildHeaders;
 }
 type DateOptions = {
@@ -38,4 +50,10 @@ type DateOptions = {
     month: number;
     day: number;
 };
-export { MapleStoryApi };
+type MapleStoryErrorBody = {
+    error: {
+        name: string;
+        message: string;
+    };
+};
+export { MapleStoryApi, MapleStoryErrorBody };

package/types/maplestory/api/mapleStoryApiError.d.ts

@@ -1,14 +1,25 @@
+import { MapleStoryErrorBody } from "./mapleStoryApi";
 /**
  * MapleStory OpenAPI error.<br>
- * Please refer to <a href="https://developers.nexon.com/Maplestory/guides">MapleStory API guide</a> for the error details.
+ * Please refer to <a href="https://openapi.nexon.com/guide/request-api/">MapleStory API guide</a> for the error details.
  */
 declare class MapleStoryApiError extends Error {
     readonly name = "MapleStoryApiError";
-    readonly status: number;
+    readonly errorCode: MapleStoryApiErrorCode;
     readonly message: string;
-    constructor(params: {
-        status: number;
-        message: string;
-    });
+    constructor(errorBody: MapleStoryErrorBody);
 }
-export { MapleStoryApiError };
+/**
+ * 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.
+ */
+declare enum MapleStoryApiErrorCode {
+    OPENAPI00001 = 0,
+    OPENAPI00002 = 1,
+    OPENAPI00003 = 2,
+    OPENAPI00004 = 3,
+    OPENAPI00005 = 4,
+    OPENAPI00006 = 5,
+    OPENAPI00007 = 6
+}
+export { MapleStoryApiError, MapleStoryApiErrorCode };

package/types/maplestory/api/response/cubeHistoryDtoBody.d.ts

@@ -3,20 +3,20 @@ type CubeHistoryDtoBody = {
     id: string;
     character_name: string;
     world_name: string;
-    create_date: string;
+    date_create: string;
     cube_type: string;
     item_upgrade_result: string;
     miracle_time_flag: string;
-    item_equip_part: string;
+    item_equipment_part: string;
     item_level: number;
     target_item: string;
     potential_option_grade: string;
     additional_potential_option_grade: string;
-    upgradeguarantee: boolean;
-    upgradeguaranteecount: number;
-    before_potential_options: CubeResultOptionDtoBody[];
-    before_additional_potential_options: CubeResultOptionDtoBody[];
-    after_potential_options: CubeResultOptionDtoBody[];
-    after_additional_potential_options: CubeResultOptionDtoBody[];
+    upgrade_guarantee: boolean;
+    upgrade_guarantee_count: number;
+    before_potential_option: CubeResultOptionDtoBody[];
+    before_additional_potential_option: CubeResultOptionDtoBody[];
+    after_potential_option: CubeResultOptionDtoBody[];
+    after_additional_potential_option: CubeResultOptionDtoBody[];
 };
 export type { CubeHistoryDtoBody };

package/types/maplestory/api/response/cubeHistoryResponseDtoBody.d.ts

@@ -1,7 +1,7 @@
 import { CubeHistoryDtoBody } from "./cubeHistoryDtoBody";
 type CubeHistoryResponseDtoBody = {
     count: number;
-    cube_histories: CubeHistoryDtoBody[];
+    cube_history: CubeHistoryDtoBody[];
     next_cursor: string;
 };
 export type { CubeHistoryResponseDtoBody };

package/types/maplestory/api/response/inspectionInfoSoapBody.d.ts

@@ -0,0 +1,137 @@
+type InspectionInfoSoapBody = {
+    'soap:Envelope': {
+        "$": {
+            "xmlns:soap": "http://schemas.xmlsoap.org/soap/envelope/";
+            "xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance";
+            "xmlns:xsd": "http://www.w3.org/2001/XMLSchema";
+        };
+        "soap:Body": [
+            {
+                "GetInspectionInfoResponse": [
+                    {
+                        "$": {
+                            "xmlns": "https://api.maplestory.nexon.com/soap/";
+                        };
+                        "GetInspectionInfoResult": [
+                            {
+                                "xs:schema": [
+                                    {
+                                        "$": {
+                                            "id": "NewDataSet";
+                                            "xmlns": "";
+                                            "xmlns:xs": "http://www.w3.org/2001/XMLSchema";
+                                            "xmlns:msdata": "urn:schemas-microsoft-com:xml-msdata";
+                                        };
+                                        "xs:element": [
+                                            {
+                                                "$": {
+                                                    "name": "NewDataSet";
+                                                    "msdata:IsDataSet": "true";
+                                                    "msdata:UseCurrentLocale": "true";
+                                                };
+                                                "xs:complexType": [
+                                                    {
+                                                        "xs:choice": [
+                                                            {
+                                                                "$": {
+                                                                    "minOccurs": "0";
+                                                                    "maxOccurs": "unbounded";
+                                                                };
+                                                                "xs:element": [
+                                                                    {
+                                                                        "$": {
+                                                                            "name": "InspectionInfo";
+                                                                        };
+                                                                        "xs:complexType": [
+                                                                            {
+                                                                                "xs:sequence": [
+                                                                                    {
+                                                                                        "xs:element": [
+                                                                                            {
+                                                                                                "$": {
+                                                                                                    "name": "serviceCode";
+                                                                                                    "type": "xs:unsignedByte";
+                                                                                                    "minOccurs": "0";
+                                                                                                };
+                                                                                            },
+                                                                                            {
+                                                                                                "$": {
+                                                                                                    "name": "startDateTime";
+                                                                                                    "type": "xs:dateTime";
+                                                                                                    "minOccurs": "0";
+                                                                                                };
+                                                                                            },
+                                                                                            {
+                                                                                                "$": {
+                                                                                                    "name": "endDateTime";
+                                                                                                    "type": "xs:dateTime";
+                                                                                                    "minOccurs": "0";
+                                                                                                };
+                                                                                            },
+                                                                                            {
+                                                                                                "$": {
+                                                                                                    "name": "strObstacleContents";
+                                                                                                    "type": "xs:string";
+                                                                                                    "minOccurs": "0";
+                                                                                                };
+                                                                                            }
+                                                                                        ];
+                                                                                    }
+                                                                                ];
+                                                                            }
+                                                                        ];
+                                                                    }
+                                                                ];
+                                                            }
+                                                        ];
+                                                    }
+                                                ];
+                                            }
+                                        ];
+                                    }
+                                ];
+                                "diffgr:diffgram": [
+                                    {
+                                        "$": {
+                                            "xmlns:msdata": "urn:schemas-microsoft-com:xml-msdata";
+                                            "xmlns:diffgr": "urn:schemas-microsoft-com:xml-diffgram-v1";
+                                        };
+                                        "NewDataSet": [
+                                            {
+                                                "$": {
+                                                    "xmlns": "";
+                                                };
+                                                "InspectionInfo": [
+                                                    {
+                                                        "$": {
+                                                            "diffgr:id": "InspectionInfo1";
+                                                            "msdata:rowOrder": "0";
+                                                            "diffgr:hasChanges": "inserted";
+                                                        };
+                                                        "serviceCode": [
+                                                            string
+                                                        ];
+                                                        "startDateTime": [
+                                                            string
+                                                        ];
+                                                        "endDateTime": [
+                                                            string
+                                                        ];
+                                                        "strObstacleContents": [
+                                                            string
+                                                        ];
+                                                    }
+                                                ];
+                                            }
+                                        ];
+                                    }
+                                ];
+                            }
+                        ];
+                    }
+                ];
+            }
+        ];
+    };
+};
+export type { InspectionInfoSoapBody };