maplestory-openapi 2.13.0 → 3.0.0

package/types/maplestory/api/common/dto/guild/guildBasic.d.ts

@@ -0,0 +1,20 @@
+export declare abstract class GuildBasicDto {
+    abstract date: Date | null;
+    abstract worldName: string;
+    abstract guildName: string;
+    abstract guildLevel: number;
+    abstract guildFame: number;
+    abstract guildPoint: number;
+    abstract guildMasterName: string;
+    abstract guildMemberCount: number;
+    abstract guildMember: string[];
+    abstract guildSkill: GuildSkillDto[];
+    abstract guildNoblesseSkill: GuildSkillDto[];
+}
+export declare abstract class GuildSkillDto {
+    abstract skillName: string;
+    abstract skillDescription: string;
+    abstract skillLevel: number;
+    abstract skillEffect: string;
+    abstract skillIcon: string;
+}

package/types/maplestory/api/common/dto/union/union.d.ts

@@ -0,0 +1,8 @@
+export declare abstract class UnionDto {
+    abstract date: Date | null;
+    abstract unionLevel: number | null;
+    abstract unionGrade: string | null;
+    abstract unionArtifactLevel: number | null;
+    abstract unionArtifactExp: number | null;
+    abstract unionArtifactPoint: number | null;
+}

package/types/maplestory/api/common/dto/union/unionArtifact.d.ts

@@ -0,0 +1,20 @@
+export declare abstract class UnionArtifactDto {
+    abstract date: Date | null;
+    abstract unionArtifactEffect: UnionArtifactEffectDto[];
+    abstract unionArtifactCrystal: UnionArtifactCrystalDto[];
+    abstract unionArtifactRemainAp: number | null;
+}
+export declare abstract class UnionArtifactEffectDto {
+    abstract name: string;
+    abstract level: number;
+}
+export declare abstract class UnionArtifactCrystalDto {
+    abstract name: string;
+    abstract validityFlag: string;
+    abstract dateExpire: Date | null;
+    abstract isExpired: boolean | null;
+    abstract level: number;
+    abstract crystalOptionName1: string;
+    abstract crystalOptionName2: string;
+    abstract crystalOptionName3: string;
+}

package/types/maplestory/api/common/dto/union/unionRaider.d.ts

@@ -0,0 +1,38 @@
+export declare abstract class UnionRaiderDto {
+    abstract date: Date | null;
+    abstract unionRaiderStat: string[];
+    abstract unionOccupiedStat: string[];
+    abstract unionInnerStat: UnionRaiderInnerStatDto[];
+    abstract unionBlock: UnionRaiderBlockDto[];
+    abstract usePresetNo: number;
+    abstract unionRaiderPreset1: UnionRaiderPresetDto | null;
+    abstract unionRaiderPreset2: UnionRaiderPresetDto | null;
+    abstract unionRaiderPreset3: UnionRaiderPresetDto | null;
+    abstract unionRaiderPreset4: UnionRaiderPresetDto | null;
+    abstract unionRaiderPreset5: UnionRaiderPresetDto | null;
+}
+export declare abstract class UnionRaiderInnerStatDto {
+    abstract statFieldId: string;
+    abstract statFieldEffect: string;
+}
+export declare abstract class UnionRaiderBlockPositionDto {
+    abstract x: number;
+    abstract y: number;
+}
+export declare abstract class UnionRaiderBlockControlPointDto {
+    abstract x: number;
+    abstract y: number;
+}
+export declare abstract class UnionRaiderBlockDto {
+    abstract blockType: string;
+    abstract blockClass: string;
+    abstract blockLevel: string;
+    abstract blockControlPoint: UnionRaiderBlockControlPointDto;
+    abstract blockPosition: UnionRaiderBlockPositionDto[] | null;
+}
+export declare abstract class UnionRaiderPresetDto {
+    abstract unionRaiderStat: string[];
+    abstract unionOccupiedStat: string[];
+    abstract unionInnerStat: UnionRaiderInnerStatDto[];
+    abstract unionBlock: UnionRaiderBlockDto[];
+}

package/types/maplestory/api/common/enum/characterImage.d.ts

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

package/types/maplestory/api/common/enum/potentialOptionGrade.d.ts

@@ -0,0 +1,6 @@
+export declare enum PotentialOptionGrade {
+    RARE = 0,
+    EPIC = 1,
+    UNIQUE = 2,
+    LEGENDARY = 3
+}

package/types/maplestory/api/common/lib.d.ts

@@ -0,0 +1,7 @@
+import { PotentialOptionGrade } from './enum/potentialOptionGrade';
+/**
+ * 한글로 정의된 잠재옵션 등급을 PotentialOptionGrade으로 변환합니다.
+ *
+ * @param text support only "레어", "에픽", "유니크", "레전드리"
+ */
+export declare const potentialOptionGradeFromString: (text: string) => PotentialOptionGrade;

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

@@ -0,0 +1,140 @@
+import { Axios } from 'axios';
+import { CharacterDto } from './dto/character/character';
+import { CharacterAbilityDto } from './dto/character/characterAbility';
+import { CharacterAndroidEquipmentDto } from './dto/character/characterAndroidEquipment';
+import { CharacterBasicDto } from './dto/character/characterBasic';
+import { CharacterBeautyEquipmentDto } from './dto/character/characterBeautyEquipment';
+import { CharacterCashItemEquipmentDto } from './dto/character/characterCashItemEquipment';
+import { CharacterDojangDto } from './dto/character/characterDojang';
+import { CharacterHexaMatrixDto } from './dto/character/characterHexaMatrix';
+import { CharacterHexaMatrixStatDto } from './dto/character/characterHexaMatrixStat';
+import { CharacterHyperStatDto } from './dto/character/characterHyperStat';
+import { CharacterImageDto } from './dto/character/characterImage';
+import { CharacterItemEquipmentDto } from './dto/character/characterItemEquipment';
+import { CharacterLinkSkillDto } from './dto/character/characterLinkSkill';
+import { CharacterPetEquipmentDto } from './dto/character/characterPetEquipment';
+import { CharacterPopularityDto } from './dto/character/characterPopularity';
+import { CharacterPropensityDto } from './dto/character/characterPropensity';
+import { CharacterSetEffectDto } from './dto/character/characterSetEffect';
+import { CharacterSkillDto } from './dto/character/characterSkill';
+import { CharacterStatDto } from './dto/character/characterStat';
+import { CharacterSymbolEquipmentDto } from './dto/character/characterSymbolEquipment';
+import { CharacterVMatrixDto } from './dto/character/characterVMatrix';
+import { GuildDto } from './dto/guild/guild';
+import { GuildBasicDto } from './dto/guild/guildBasic';
+import { UnionDto } from './dto/union/union';
+import { UnionArtifactDto } from './dto/union/unionArtifact';
+import { UnionRaiderDto } from './dto/union/unionRaider';
+import { CharacterImageAction, CharacterImageEmotion, CharacterImageWeaponMotion } from './enum/characterImage';
+/**
+ * MapleStory OpenAPI client.
+ */
+export declare abstract class MapleStoryApi {
+    private readonly apiKey;
+    protected readonly client: Axios;
+    private static readonly BASE_URL;
+    private static readonly DEFAULT_TIMEOUT;
+    protected abstract subUrl: string;
+    protected abstract timezoneOffset: number;
+    get timeout(): number;
+    set timeout(value: number);
+    constructor(apiKey: string);
+    abstract getCharacter(characterName: string): Promise<CharacterDto>;
+    abstract getCharacterBasic(ocid: string, dateOptions?: DateOptions): Promise<CharacterBasicDto>;
+    abstract getCharacterImage(ocid: string, imageOptions?: CharacterImageOptions, dateOptions?: DateOptions): Promise<CharacterImageDto>;
+    abstract getCharacterPopularity(ocid: string, dateOptions?: DateOptions): Promise<CharacterPopularityDto>;
+    abstract getCharacterStat(ocid: string, dateOptions?: DateOptions): Promise<CharacterStatDto>;
+    abstract getCharacterHyperStat(ocid: string, dateOptions?: DateOptions): Promise<CharacterHyperStatDto>;
+    abstract getCharacterPropensity(ocid: string, dateOptions?: DateOptions): Promise<CharacterPropensityDto>;
+    abstract getCharacterAbility(ocid: string, dateOptions?: DateOptions): Promise<CharacterAbilityDto>;
+    abstract getCharacterItemEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterItemEquipmentDto>;
+    abstract getCharacterCashItemEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterCashItemEquipmentDto>;
+    abstract getCharacterSymbolEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterSymbolEquipmentDto>;
+    abstract getCharacterSetEffect(ocid: string, dateOptions?: DateOptions): Promise<CharacterSetEffectDto>;
+    abstract getCharacterBeautyEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterBeautyEquipmentDto>;
+    abstract getCharacterAndroidEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterAndroidEquipmentDto>;
+    abstract getCharacterPetEquipment(ocid: string, dateOptions?: DateOptions): Promise<CharacterPetEquipmentDto>;
+    abstract getCharacterSkill(ocid: string, characterSkillGrade: string, dateOptions?: DateOptions): Promise<CharacterSkillDto>;
+    abstract getCharacterLinkSkill(ocid: string, dateOptions?: DateOptions): Promise<CharacterLinkSkillDto>;
+    abstract getCharacterVMatrix(ocid: string, dateOptions?: DateOptions): Promise<CharacterVMatrixDto>;
+    abstract getCharacterHexaMatrix(ocid: string, dateOptions?: DateOptions): Promise<CharacterHexaMatrixDto>;
+    abstract getCharacterHexaMatrixStat(ocid: string, dateOptions?: DateOptions): Promise<CharacterHexaMatrixStatDto>;
+    abstract getCharacterDojang(ocid: string, dateOptions?: DateOptions): Promise<CharacterDojangDto>;
+    abstract getUnion(ocid: string, dateOptions?: DateOptions): Promise<UnionDto>;
+    abstract getUnionRaider(ocid: string, dateOptions?: DateOptions): Promise<UnionRaiderDto>;
+    abstract getUnionArtifact(ocid: string, dateOptions?: DateOptions): Promise<UnionArtifactDto>;
+    abstract getGuild(guildName: string, worldName: string): Promise<GuildDto>;
+    abstract getGuildBasic(guildId: string, dateOptions?: DateOptions): Promise<GuildBasicDto>;
+    /**
+     * API 서버의 데이터 갱신 시간에 따라 데이터가 조회 가능한 최신 날짜를 반환합니다.
+     *
+     * @param options
+     */
+    protected getProperDefaultDateOptions(options: LatestApiUpdateTimeOptions): DateOptions;
+    /**
+     * 날짜 정보를 API 서버에서 요구하는 포맷으로 변환합니다.
+     *
+     * @param dateOptions 조회 하려는 날짜
+     * @param minDateOptions API 호출 가능한 최소 날짜
+     */
+    protected toDateString(dateOptions: DateOptions, minDateOptions?: DateOptions): string | never;
+}
+/**
+ * API 서버의 데이터 갱신 시각과 조회 가능한 최근 날짜와 현재 날짜와의 차이
+ */
+type LatestApiUpdateTimeOptions = {
+    hour: number;
+    minute: number;
+    dateOffset?: number;
+};
+type YMD = {
+    year: number;
+    month: number;
+    day: number;
+};
+/**
+ * 날짜 옵션
+ * - Date 객체 또는 YMD 형식의 객체를 사용할 수 있습니다.
+ * - 날짜는 해당 서비스 지역의 표준 시를 사용 합니다.
+ * - Date 객체의 offset이 해당 서비스 지역의 offset과 다를 경우 자동으로 변환 됩니다.
+ */
+export type DateOptions = YMD | Date;
+type CharacterImageOptions = {
+    /**
+     * Character action
+     */
+    action?: CharacterImageAction;
+    /**
+     * Character emotion
+     */
+    emotion?: CharacterImageEmotion;
+    /**
+     * Character weapon motion
+     */
+    wmotion?: CharacterImageWeaponMotion;
+    /**
+     * Character action frame
+     */
+    actionFrame?: number;
+    /**
+     * Character emotion frame
+     */
+    emotionFrame?: number;
+    /**
+     * Horizontal length (corresponding to the background size, 96 (default) ~ 1000)
+     */
+    width?: number;
+    /**
+     * Vertical length (corresponding to the background size, 96 (default) ~ 1000)
+     */
+    height?: number;
+    /**
+     * Horizontal coordinate of the character (coordinate range 0 < x < width, 0 is the left starting point)
+     */
+    x?: number;
+    /**
+     * Vertical coordinate of the character (coordinate range 0 < y < height, 0 is the top starting point)
+     */
+    y?: number;
+};
+export {};

package/types/maplestory/api/{mapleStoryApiError.d.ts → common/mapleStoryApiError.d.ts}

@@ -1,9 +1,9 @@
-import { MapleStoryErrorBody } from './mapleStoryApi';
+import { MapleStoryErrorBody } from './mapleStoryApiErrorBody';
 /**
  * MapleStory OpenAPI error.<br>
  * 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 {
+export declare class MapleStoryApiError extends Error {
     readonly name = "MapleStoryApiError";
     readonly errorCode: MapleStoryApiErrorCode;
     readonly message: string;
@@ -13,7 +13,7 @@ declare class MapleStoryApiError extends Error {
  * 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 {
+export declare enum MapleStoryApiErrorCode {
     OPENAPI00001 = 0,
     OPENAPI00002 = 1,
     OPENAPI00003 = 2,
@@ -25,4 +25,3 @@ declare enum MapleStoryApiErrorCode {
     OPENAPI00010 = 8,
     OPENAPI00011 = 9
 }
-export { MapleStoryApiError, MapleStoryApiErrorCode };

package/types/maplestory/api/common/mapleStoryApiErrorBody.d.ts

@@ -0,0 +1,6 @@
+export type MapleStoryErrorBody = {
+    error: {
+        name: string;
+        message: string;
+    };
+};

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

@@ -0,0 +1,12 @@
+import * as base from '../../../common/dto/character/character';
+import { CharacterBody } from '../../response/character/characterBody';
+/**
+ * 캐릭터 식별 정보
+ */
+export declare class CharacterDto extends base.CharacterDto {
+    /**
+     * 캐릭터 식별자
+     */
+    ocid: string;
+    constructor(obj: CharacterBody);
+}

package/types/maplestory/api/kms/dto/character/characterAbility.d.ts

@@ -0,0 +1,72 @@
+import * as base from '../../../common/dto/character/characterAbility';
+import { CharacterAbilityBody, CharacterAbilityInfoBody, CharacterAbilityPresetBody } from '../../response/character/characterAbilityBody';
+/**
+ * 캐릭터 어빌리티 정보
+ */
+export declare class CharacterAbilityDto extends base.CharacterAbilityDto {
+    /**
+     * 조회 기준일 (KST, 일 단위 데이터로 시, 분은 일괄 0으로 표기)
+     */
+    date: Date | null;
+    /**
+     * 어빌리티 등급
+     */
+    abilityGrade: string | null;
+    /**
+     *  어빌리티 정보
+     */
+    abilityInfo: CharacterAbilityInfoDto[];
+    /**
+     * 보유 명성치
+     */
+    remainFame: number | null;
+    /**
+     * 적용 중인 어빌리티 프리셋 번호
+     */
+    presetNo: number | null;
+    /**
+     * 어빌리티 1번 프리셋 전체 정보
+     */
+    abilityPreset1: CharacterAbilityPresetDto | null;
+    /**
+     * 어빌리티 2번 프리셋 전체 정보
+     */
+    abilityPreset2: CharacterAbilityPresetDto | null;
+    /**
+     * 어빌리티 3번 프리셋 전체 정보
+     */
+    abilityPreset3: CharacterAbilityPresetDto | null;
+    constructor(obj: CharacterAbilityBody);
+}
+/**
+ * 캐릭터 어빌리티 상세 정보
+ */
+export declare class CharacterAbilityInfoDto extends base.CharacterAbilityInfoDto {
+    /**
+     * 어빌리티 번호
+     */
+    abilityNo: string;
+    /**
+     * 어빌리티 등급
+     */
+    abilityGrade: string;
+    /**
+     * 어빌리티 옵션 및 수치
+     */
+    abilityValue: string;
+    constructor(obj: CharacterAbilityInfoBody);
+}
+/**
+ * 캐릭터 어빌리티 프리셋 정보
+ */
+export declare class CharacterAbilityPresetDto extends base.CharacterAbilityPresetDto {
+    /**
+     * 프리셋의 어빌리티 등급
+     */
+    abilityPresetGrade: string;
+    /**
+     * 프리셋의 어빌리티 정보
+     */
+    abilityInfo: CharacterAbilityInfoDto[];
+    constructor(obj: CharacterAbilityPresetBody);
+}