maplestory-openapi 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,78 @@
+# MapleStory OpenAPI JavaScript Library
+
+[![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.
+
+Packages written in other languages can be found [HERE](https://github.com/SpiralMoon/maplestory.openapi).
+
+(한국어 문서는 [이쪽](https://github.com/SpiralMoon/maplestory.openapi/blob/master/js/README-ko.md)입니다.)
+
+## Installation
+
+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
+```
+
+## Usage
+
+### Supports
+
+1. **CommonJS, ESM Support**: The library supports both CommonJS and ESM usage.
+
+```javascript
+const {MapleStoryApi, MapleStoryApiError} = require('maplestory-openapi'); // CommonJS
+```
+```typescript
+import {MapleStoryApi, MapleStoryApiError} from 'maplestory-openapi'; // ESM
+```
+
+2. **TypeScript Support**: TypeScript is fully supported. Type definitions are included.
+
+### Sample Code
+
+```javascript
+const {MapleStoryApi, MapleStoryApiError} = require('maplestory-openapi');
+
+const apiKey = '{Your API Key}';
+const api = new MapleStoryApi(apiKey);
+
+api.getCubeResult(1000, {
+    year: 2023,
+    month: 10,
+    day: 15
+})
+    .then((dto) => {
+        const {count, cubeHistories, nextCursor} = dto;
+
+        console.log('You used ' + count + ' cubes.');
+    })
+    .catch((e) => {
+        if (e instanceof MapleStoryApiError) {
+            // handle MapleStoryApiError
+        } else {
+            // handle other errors
+        }
+
+        console.log(e);
+    });
+```
+
+### 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.
+
+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                      |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "maplestory-openapi",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "keywords": [
     "maplestory",
     "maplestory openapi",
@@ -9,6 +9,7 @@
     "nexon",
     "nexon developers"
   ],
+  "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"

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

@@ -7,14 +7,16 @@ declare class MapleStoryApi {
     constructor(apiKey: string);
     /**
      * 오늘 날짜의 확률형 아이템 큐브의 사용 결과를 조회합니다.<br>
-     * 데이터는 일단위로 갱신되며, 오전 4시 조회 시 전일 데이터를 조회할 수 있습니다.
+     * 데이터는 일단위로 갱신되며, 오전 4시 조회 시 전일 데이터를 조회할 수 있습니다.<br>
+     * 데이터는 2022년 11월 25일부터 조회할 수 있습니다.<br>
      *
      * @param count 한번에 가져오려는 결과의 갯수(최소 10, 최대 1000) Default value : 10
      */
     getCubeResult(count: number): Promise<CubeHistoryResponseDto>;
     /**
      * 지목한 날짜의 확률형 아이템 큐브의 사용 결과를 조회합니다.<br>
-     * 데이터는 일단위로 갱신되며, 오전 4시 조회 시 전일 데이터를 조회할 수 있습니다.
+     * 데이터는 일단위로 갱신되며, 오전 4시 조회 시 전일 데이터를 조회할 수 있습니다.<br>
+     * 데이터는 2022년 11월 25일부터 조회할 수 있습니다.<br>
      *
      * @param count 한번에 가져오려는 결과의 갯수(최소 10, 최대 1000) Default value : 10
      * @param dateOptions 조회할 연월일 날짜 정보
@@ -22,7 +24,8 @@ declare class MapleStoryApi {
     getCubeResult(count: number, dateOptions: DateOptions): Promise<CubeHistoryResponseDto>;
     /**
      * 확률형 아이템 큐브의 사용 결과를 조회합니다.<br>
-     * 데이터는 일단위로 갱신되며, 오전 4시 조회 시 전일 데이터를 조회할 수 있습니다.
+     * 데이터는 일단위로 갱신되며, 오전 4시 조회 시 전일 데이터를 조회할 수 있습니다.<br>
+     * 데이터는 2022년 11월 25일부터 조회할 수 있습니다.<br>
      *
      * @param count 한번에 가져오려는 결과의 갯수(최소 10, 최대 1000) Default value : 10
      * @param cursor