maplestory-openapi 2.7.3 → 2.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "maplestory-openapi",
-  "version": "2.7.3",
+  "version": "2.8.0",
   "description": "This JavaScript library enables the use of the MapleStory OpenAPI of Nexon.",
   "keywords": [
     "maplestory",
@@ -58,6 +58,7 @@
     "@types/xml2js": "^0.4.14",
     "@typescript-eslint/eslint-plugin": "^6.15.0",
     "@typescript-eslint/parser": "^6.15.0",
+    "buffer": "^6.0.3",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint": "^8.56.0",
     "eslint-config-google": "^0.14.0",

package/types/maplestory/api/dto/character/characterImageDto.d.ts

@@ -0,0 +1,96 @@
+/**
+ * 캐릭터 외형 이미지 정보
+ */
+declare class CharacterImageDto {
+    /**
+     * 조회 기준일
+     */
+    date: Date | null;
+    /**
+     * 캐릭터 외형 이미지 원본 (URL)
+     */
+    originUrl: string;
+    /**
+     * 캐릭터 외형 기본 이미지 (base64)
+     */
+    originImage: string;
+    /**
+     * 캐릭터 외형 이미지 (base64)
+     */
+    image: string;
+    /**
+     * 캐릭터 액션
+     */
+    action: CharacterImageAction;
+    /**
+     * 캐릭터 감정표현
+     */
+    emotion: CharacterImageEmotion;
+    /**
+     * 캐릭터 무기 모션
+     */
+    wmotion: CharacterImageWeaponMotion;
+    /**
+     * 가로 길이. 배경 크기에 해당함, 96 (default) ~ 1000
+     */
+    width: number;
+    /**
+     * 세로 길이. 배경 크기에 해당함, 96 (default) ~ 1000
+     */
+    height: number;
+    /**
+     * 캐릭터의 가로 좌표
+     */
+    x: number | null;
+    /**
+     * 캐릭터의 세로 좌표.
+     */
+    y: number | null;
+    constructor(obj: {
+        date: Date | null;
+        originUrl: string;
+        originImage: string;
+        image: string;
+        action: CharacterImageAction;
+        emotion: CharacterImageEmotion;
+        wmotion: CharacterImageWeaponMotion;
+        width: number;
+        height: number;
+        x: number | null;
+        y: number | null;
+    });
+}
+/**
+ * 캐릭터 액션
+ */
+declare enum CharacterImageAction {
+    Stand1 = "A00",
+    Stand2 = "A01",
+    Walk1 = "A02",
+    Walk2 = "A03",
+    Prone = "A04",
+    Fly = "A05",
+    Jump = "A06",
+    Sit = "A07"
+}
+/**
+ * 캐릭터 감정표현
+ */
+declare enum CharacterImageEmotion {
+    Default = "E00",
+    Wink = "E01",
+    Smile = "E02",
+    Cry = "E03",
+    Angry = "E04",
+    Bewildered = "E05"
+}
+/**
+ * 캐릭터 무기 모션
+ */
+declare enum CharacterImageWeaponMotion {
+    Default = "W00",
+    OneHand = "W01",
+    TwoHands = "W02",
+    Gun = "W03"
+}
+export { CharacterImageDto, CharacterImageAction, CharacterImageEmotion, CharacterImageWeaponMotion };

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

@@ -8,6 +8,7 @@ import { CharacterDto } from './dto/character/characterDto';
 import { CharacterHexaMatrixDto } from './dto/character/characterHexaMatrixDto';
 import { CharacterHexaMatrixStatDto } from './dto/character/characterHexaMatrixStatDto';
 import { CharacterHyperStatDto } from './dto/character/characterHyperStatDto';
+import { CharacterImageAction, CharacterImageDto, CharacterImageEmotion, CharacterImageWeaponMotion } from './dto/character/characterImageDto';
 import { CharacterItemEquipmentDto } from './dto/character/characterItemEquipmentDto';
 import { CharacterLinkSkillDto } from './dto/character/characterLinkSkillDto';
 import { CharacterListDto } from './dto/character/characterListDto';
@@ -83,6 +84,18 @@ declare class MapleStoryApi {
      * @param dateOptions 조회 기준일 (KST)
      */
     getCharacterBasic(ocid: string, dateOptions?: DateOptions): Promise<CharacterBasicDto>;
+    /**
+     * 캐릭터 외형 이미지 정보를 조회합니다.
+     * - 메이플스토리 게임 데이터는 평균 15분 후 확인 가능합니다.
+     * - 2023년 12월 21일 데이터부터 조회할 수 있습니다.
+     * - 과거 데이터는 원하는 일자를 입력해 조회할 수 있으며, 전일 데이터는 다음날 오전 2시부터 확인할 수 있습니다. (12월 22일 데이터 조회 시, 22일 00시부터 23일 00시 사이 데이터가 조회 됩니다.)
+     * - 게임 콘텐츠 변경으로 ocid가 변경될 수 있습니다. ocid 기반 서비스 갱신 시 유의해 주시길 바랍니다.
+     *
+     * @param ocid 캐릭터 식별자
+     * @param imageOptions 캐릭터 외형 파라미터
+     * @param dateOptions 조회 기준일 (KST)
+     */
+    getCharacterImage(ocid: string, imageOptions?: CharacterImageOptions, dateOptions?: DateOptions): Promise<CharacterImageDto>;
     /**
      * 인기도 정보를 조회합니다.
      * - 메이플스토리 게임 데이터는 평균 15분 후 확인 가능합니다.
@@ -573,6 +586,36 @@ declare class MapleStoryApi {
      */
     private static toDateString;
 }
+type CharacterImageOptions = {
+    /**
+     * 캐릭터 액션
+     */
+    action?: CharacterImageAction;
+    /**
+     * 캐릭터 감정표현
+     */
+    emotion?: CharacterImageEmotion;
+    /**
+     * 캐릭터 무기 모션
+     */
+    wmotion?: CharacterImageWeaponMotion;
+    /**
+     * 가로 길이. 배경 크기에 해당함, 96 (default) ~ 1000
+     */
+    width?: number;
+    /**
+     * 세로 길이. 배경 크기에 해당함, 96 (default) ~ 1000
+     */
+    height?: number;
+    /**
+     * 캐릭터의 가로 좌표
+     */
+    x?: number;
+    /**
+     * 캐릭터의 세로 좌표.
+     */
+    y?: number;
+};
 type OverallRankingApiFilterOptions = {
     /**
      * 월드 명