dnf-api 1.0.6 → 1.1.0

package/dist/model/item.d.ts

@@ -0,0 +1,103 @@
+import type * as Static from "../util/static";
+import type { INameValue } from "./";
+export declare enum ItemDetailKind {
+    Material = "material",
+    Equip = "equip"
+}
+/** 아이템 인터페이스 */
+export interface IItem {
+    itemId: string;
+    itemName: string;
+    itemRarity: Static.rarity;
+    itemType: string;
+    itemTypeDetail: string;
+    itemAvailableLevel: number;
+}
+/** 아이템 상세 인터페이스(합성 타입) */
+export type IDetail = IMaterialDetail | IEquipDetail;
+/** 재료 아이템 상세 인터페이스 */
+export interface IMaterialDetail {
+    kind: ItemDetailKind.Material;
+    itemId: string;
+    itemName: string;
+    itemRarity: string;
+    itemTypeId: string;
+    itemType: string;
+    itemTypeDetailId: string;
+    itemTypeDetail: string;
+    itemAvailableLevel: number;
+    itemExplain: string;
+    itemExplainDetail: string;
+    itemFlavorText: string;
+    fame: number;
+    setItemId: string | null;
+    setItemName: string | null;
+    obtainInfo: IObtainInfo;
+}
+/** 장비 아이템 상세 인터페이스 */
+export interface IEquipDetail {
+    kind: ItemDetailKind.Equip;
+    itemId: string;
+    itemName: string;
+    itemRarity: string;
+    itemTypeId: string;
+    itemType: string;
+    itemTypeDetailId: string;
+    itemTypeDetail: string;
+    itemAvailableLevel: number;
+    itemExplain: string;
+    itemExplainDetail: string;
+    itemFlavorText: string;
+    fame: number;
+    setItemId: string | null;
+    setItemName: string | null;
+    itemStatus: INameValue[];
+    tune: ITune;
+    itemBuff: IItemBuff;
+    hashtag: string[];
+    obtainInfo: IObtainInfoDetail;
+}
+/** 튠 정보 인터페이스 */
+export interface ITune {
+    level: number;
+    setPoint: number;
+}
+/** 아이템 버프 인터페이스 */
+export interface IItemBuff {
+    explain: string;
+    explainDetail: string;
+    reinforceSkill: any[];
+    status: any | null;
+}
+/** 획득 정보 인터페이스 */
+export interface IObtainInfo {
+    dungeon: string | null;
+    shop: IShopInfo[];
+}
+/** 획득 상세 정보 인터페이스 */
+export interface IObtainInfoDetail {
+    dungeon: IDungeon[];
+    shop: IShopDetail[];
+}
+/** 던전 정보 인터페이스 */
+export interface IDungeon {
+    type: string;
+    rows: IDungeonRow[];
+}
+/** 던전 행 인터페이스 */
+export interface IDungeonRow {
+    name: string;
+}
+/** 상점 정보 인터페이스 */
+export interface IShopInfo {
+    type: string;
+}
+/** 상점 상세 정보 인터페이스 */
+export interface IShopDetail {
+    rows: IShopRow[];
+}
+/** 상점 행 인터페이스 */
+export interface IShopRow {
+    name: string;
+    details: string[];
+}

package/dist/model/setitem.d.ts

@@ -0,0 +1,32 @@
+/** 세트 아이템 인터페이스 */
+export interface ISetItem {
+    setItemId: string;
+    setItemName: string;
+}
+/** 세트 아이템 상세 인터페이스 */
+export interface IDetail {
+    setItemId: string;
+    setItemName: string;
+    setItems: [
+        {
+            slotId: string;
+            slotName: string;
+            itemId: string;
+            itemName: string;
+            itemRarity: string;
+        }
+    ];
+    setItemOption: [
+        {
+            optionNo: number;
+            explain: string;
+            detailExplain: string;
+            status: [
+                {
+                    name: string;
+                    value: number;
+                }
+            ];
+        }
+    ];
+}

package/dist/src/api/auction.d.ts

@@ -1,24 +1,24 @@
-import type * as model from "../model";
-import { type params } from "../util";
-/**
- * 경매장에 등록된 아이템을 "아이템 이름"을 기준으로 받아옵니다
- *
- * @param {string} itemName 검색할 아이템의 이름입니다.
- * @param {object} params 선택적 요청변수의 Object입니다.
- */
-export declare const itemName: (itemName: string, params?: params.IAuction) => Promise<model.IDnfResponse<model.IRows<model.auction.IAuction>>>;
-/**
- * 경매장에 등록된 아이템을 "아이템 아이디"을 기준으로 받아옵니다
- *
- * @param {string} itemID 검색할 아이템의 ID입니다.
- * @param {object} params 선택적 요청변수의 Object입니다.
- */
-export declare const itemId: (itemId: string, params?: params.IAuction) => Promise<model.IDnfResponse<model.IRows<model.auction.IAuction>>>;
-/**
- * 경매장에 등록된 경매장번호로 받아옵니다.
- *
- * @param {Number} auctionNo 검색할 경매장 번호입니다.
- */
-export declare const no: (auctionNo: number) => Promise<model.IDnfResponse<model.auction.IAuction>>;
-export declare const auctionSoldName: (itemName: string, params?: params.IActionSoldOption) => Promise<model.IDnfResponse<model.IRows<model.auction.IAuctionSolid>>>;
-export declare const auctionSoldId: (itemId: string, params?: params.IActionSoldOption) => Promise<model.IDnfResponse<model.IRows<model.auction.IAuctionSolid>>>;
+import type * as model from "../model";
+import { type params } from "../util";
+/**
+ * 경매장에 등록된 아이템을 "아이템 이름"을 기준으로 받아옵니다
+ *
+ * @param {string} itemName 검색할 아이템의 이름입니다.
+ * @param {object} params 선택적 요청변수의 Object입니다.
+ */
+export declare const itemName: (itemName: string, params?: params.IAuction) => Promise<model.IDnfResponse<model.IRows<model.IAuction>>>;
+/**
+ * 경매장에 등록된 아이템을 "아이템 아이디"을 기준으로 받아옵니다
+ *
+ * @param {string} itemID 검색할 아이템의 ID입니다.
+ * @param {object} params 선택적 요청변수의 Object입니다.
+ */
+export declare const itemId: (itemId: string, params?: params.IAuction) => Promise<model.IDnfResponse<model.IRows<model.IAuction>>>;
+/**
+ * 경매장에 등록된 경매장번호로 받아옵니다.
+ *
+ * @param {Number} auctionNo 검색할 경매장 번호입니다.
+ */
+export declare const no: (auctionNo: number) => Promise<model.IDnfResponse<model.IAuction>>;
+export declare const auctionSoldName: (itemName: string, params?: params.IActionSoldOption) => Promise<model.IDnfResponse<model.IRows<model.IAuctionSolid>>>;
+export declare const auctionSoldId: (itemId: string, params?: params.IActionSoldOption) => Promise<model.IDnfResponse<model.IRows<model.IAuctionSolid>>>;

package/dist/src/api/characters.d.ts

@@ -1,32 +1,32 @@
-import type * as model from "../model";
-import { type params, staticUtil } from "../util";
-/**
- * 서버 이름과 캐릭터 닉네임을 입력하여 해당 캐릭터를 검색합니다.
- *
- * @param {staticUtil.server} [serverId=""] 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} [characterName=""] 검색할 캐릭터의 이름입니다.
- * @param {object} [params={}] 선택적 요청변수의 Object입니다.
- */
-export declare const characterName: (serverId: staticUtil.server, characterName: string, params?: params.ICharParams) => Promise<model.IDnfResponse<model.IRows<model.char.ICharacter>>>;
-/**
- * 캐릭터 ID를 입력하여 해당 캐릭터 정보를 받아옵니다
- *
- * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export declare const characterId: (serverId: staticUtil.server, characterId: string) => Promise<model.IDnfResponse<model.char.IInfo>>;
-/**
- * 캐릭터 ID를 입력하여 해당 캐릭터의 타임라인 정보를 검색합니다.
- *
- * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- * @param {object} params 선택적 요청변수의 Object입니다.
- */
-export declare const timeline: (serverId: staticUtil.server, characterId: string, params?: params.ITimeLine) => Promise<model.IDnfResponse<model.char.ITimeline>>;
-/**
- * 캐릭터 ID를 입력하여 해당 캐릭터의 능력치 정보를 검색합니다.
- *
- * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export declare const status: (serverId: staticUtil.server, characterId: string) => Promise<model.IDnfResponse<model.char.ICharacterStatus>>;
+import type * as model from "../model";
+import { type params, staticUtil } from "../util";
+/**
+ * 서버 이름과 캐릭터 닉네임을 입력하여 해당 캐릭터를 검색합니다.
+ *
+ * @param {staticUtil.server} [serverId=""] 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} [characterName=""] 검색할 캐릭터의 이름입니다.
+ * @param {object} [params={}] 선택적 요청변수의 Object입니다.
+ */
+export declare const characterName: (serverId: staticUtil.server, characterName: string, params?: params.ICharParams) => Promise<model.IDnfResponse<model.IRows<model.char.ICharacter>>>;
+/**
+ * 캐릭터 ID를 입력하여 해당 캐릭터 정보를 받아옵니다
+ *
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const characterId: (serverId: staticUtil.server, characterId: string) => Promise<model.IDnfResponse<model.char.IInfo>>;
+/**
+ * 캐릭터 ID를 입력하여 해당 캐릭터의 타임라인 정보를 검색합니다.
+ *
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ * @param {object} params 선택적 요청변수의 Object입니다.
+ */
+export declare const timeline: (serverId: staticUtil.server, characterId: string, params?: params.ITimeLine) => Promise<model.IDnfResponse<model.char.ITimeline>>;
+/**
+ * 캐릭터 ID를 입력하여 해당 캐릭터의 능력치 정보를 검색합니다.
+ *
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const status: (serverId: staticUtil.server, characterId: string) => Promise<model.IDnfResponse<model.char.ICharacterStatus>>;

package/dist/src/api/characters.equip.d.ts

@@ -1,29 +1,29 @@
-import { staticUtil } from "../util";
-/**
- * 해당 캐릭터가 장착한 장비 정보를 받아옵니다.
- *
- * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export declare const equipment: (serverId: staticUtil.server, characterId: string) => Promise<import("../model").IDnfResponse<unknown>>;
-/**
- * 해당 캐릭터가 장착한 아바타 정보를 받아옵니다.
- *
- * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export declare const avatar: (serverId: staticUtil.server, characterId: string) => Promise<import("../model").IDnfResponse<unknown>>;
-/**
- * 해당 캐릭터가 장착한 크리쳐 정보를 받아옵니다.
- *
- * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export declare const creature: (serverId: staticUtil.server, characterId: string) => Promise<import("../model").IDnfResponse<unknown>>;
-/**
- * 해당 캐릭터가 장착한 휘장 정보를 받아옵니다.
- *
- * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export declare const flag: (serverId: staticUtil.server, characterId: string) => Promise<import("../model").IDnfResponse<unknown>>;
+import { staticUtil } from "../util";
+/**
+ * 해당 캐릭터가 장착한 장비 정보를 받아옵니다.
+ *
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const equipment: (serverId: staticUtil.server, characterId: string) => Promise<import("../model").IDnfResponse<unknown>>;
+/**
+ * 해당 캐릭터가 장착한 아바타 정보를 받아옵니다.
+ *
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const avatar: (serverId: staticUtil.server, characterId: string) => Promise<import("../model").IDnfResponse<unknown>>;
+/**
+ * 해당 캐릭터가 장착한 크리쳐 정보를 받아옵니다.
+ *
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const creature: (serverId: staticUtil.server, characterId: string) => Promise<import("../model").IDnfResponse<unknown>>;
+/**
+ * 해당 캐릭터가 장착한 휘장 정보를 받아옵니다.
+ *
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const flag: (serverId: staticUtil.server, characterId: string) => Promise<import("../model").IDnfResponse<unknown>>;

package/dist/src/api/characters.skill.d.ts

@@ -1,29 +1,29 @@
-import { staticUtil } from "../util";
-/**
- *  아이템 및 장비를 통한 스킬 강화 제외 입니다.
- *
- * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export declare const style: (serverId: staticUtil.server, characterId: string) => Promise<import("../model").IDnfResponse<unknown>>;
-/**
- * 캐릭터 '버프 스킬 강화 장착 장비'(스위칭) 를 조회합니다.
- *
- * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export declare const equipment: (serverId: staticUtil.server, characterId: string) => Promise<import("../model").IDnfResponse<unknown>>;
-/**
- * 캐릭터 '버프 스킬 강화 장착 아바타'(스위칭) 를 조회합니다.
- *
- * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export declare const avatar: (serverId: staticUtil.server, characterId: string) => Promise<import("../model").IDnfResponse<unknown>>;
-/**
- * 캐릭터 '버프 스킬 강화 장착 크리쳐'(스위칭) 를 조회합니다.
- *
- * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export declare const creature: (serverId: staticUtil.server, characterId: string) => Promise<import("../model").IDnfResponse<unknown>>;
+import { staticUtil } from "../util";
+/**
+ *  아이템 및 장비를 통한 스킬 강화 제외 입니다.
+ *
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const style: (serverId: staticUtil.server, characterId: string) => Promise<import("../model").IDnfResponse<unknown>>;
+/**
+ * 캐릭터 '버프 스킬 강화 장착 장비'(스위칭) 를 조회합니다.
+ *
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const equipment: (serverId: staticUtil.server, characterId: string) => Promise<import("../model").IDnfResponse<unknown>>;
+/**
+ * 캐릭터 '버프 스킬 강화 장착 아바타'(스위칭) 를 조회합니다.
+ *
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const avatar: (serverId: staticUtil.server, characterId: string) => Promise<import("../model").IDnfResponse<unknown>>;
+/**
+ * 캐릭터 '버프 스킬 강화 장착 크리쳐'(스위칭) 를 조회합니다.
+ *
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const creature: (serverId: staticUtil.server, characterId: string) => Promise<import("../model").IDnfResponse<unknown>>;

package/dist/src/api/index.d.ts

@@ -1,9 +1,9 @@
-import * as action from "./auction";
-import * as characters from "./characters";
-import * as equip from "./characters.equip";
-import * as skill from "./characters.skill";
-import * as item from "./items";
-import * as multi from "./multi";
-import * as server from "./server";
-import * as setItem from "./setitems";
-export { action, equip, skill, characters, item, setItem, server, multi };
+import * as action from "./auction";
+import * as characters from "./characters";
+import * as equip from "./characters.equip";
+import * as skill from "./characters.skill";
+import * as item from "./items";
+import * as multi from "./multi";
+import * as server from "./server";
+import * as setItem from "./setitems";
+export { action, equip, skill, characters, item, setItem, server, multi };

package/dist/src/api/items.d.ts

@@ -1,21 +1,21 @@
-import type * as model from "../model";
-import { type params } from "../util";
-/**
- * 현재 인게임에서 획득 가능한 아이템의 경우만 검색 가능합니다.
- *
- * @param {string} itemName 검색할 아이템의 명칭
- * @param {string} params 선택적 요청변수의 Object입니다.
- */
-export declare const item: (itemName: string, params?: params.IItem) => Promise<model.IDnfResponse<model.item.IItem>>;
-/**
- * 해당하는 아이템의 상세정보를 요청합니다.
- *
- * @param {string} itemId 검색할 아이템의 ID
- */
-export declare const detail: (itemId: string) => Promise<model.IDnfResponse<model.item.IDetail>>;
-/**
- * 26. 아이템 상점 판매 정보 조회
- * 인게임 백과사전 기준의 상점 판매 95레벨 에픽, 100레벨 이상 유니크, 레전더리, 에픽 장비가 조회 가능 합니다.
- *
- * @param {string} itemId 검색할 아이템의 ID
- */
+import type * as model from "../model";
+import { type params } from "../util";
+/**
+ * 현재 인게임에서 획득 가능한 아이템의 경우만 검색 가능합니다.
+ *
+ * @param {string} itemName 검색할 아이템의 명칭
+ * @param {string} params 선택적 요청변수의 Object입니다.
+ */
+export declare const item: (itemName: string, params?: params.IItem) => Promise<model.IDnfResponse<model.item.IItem>>;
+/**
+ * 해당하는 아이템의 상세정보를 요청합니다.
+ *
+ * @param {string} itemId 검색할 아이템의 ID
+ */
+export declare const detail: (itemId: string) => Promise<model.IDnfResponse<model.item.IDetail>>;
+/**
+ * 26. 아이템 상점 판매 정보 조회
+ * 인게임 백과사전 기준의 상점 판매 95레벨 에픽, 100레벨 이상 유니크, 레전더리, 에픽 장비가 조회 가능 합니다.
+ *
+ * @param {string} itemId 검색할 아이템의 ID
+ */

package/dist/src/api/multi.d.ts

@@ -1,7 +1,7 @@
-import type * as model from "../model";
-/**
- * 해당하는 아이템의 상세정보를 요청합니다.
- *
- * @param {string} itemId 검색할 아이템의 ID
- */
-export declare const items: (itemIdList: string[]) => Promise<model.IDnfResponse<model.IRows<model.item.IDetail>>>;
+import type * as Model from "../model";
+/**
+ * 해당하는 아이템의 상세정보를 요청합니다.
+ *
+ * @param {string} itemId 검색할 아이템의 ID
+ */
+export declare const items: (itemIdList: string[]) => Promise<Model.IDnfResponse<Model.item.IDetail[]>>;

package/dist/src/api/server.d.ts

@@ -1,2 +1,2 @@
-import type * as Model from "../model";
-export declare const List: () => Promise<Model.IDnfResponse<Model.IServer[]>>;
+import type * as Model from "../model";
+export declare const List: () => Promise<Model.IDnfResponse<Model.IServer[]>>;

package/dist/src/api/setitems.d.ts

@@ -1,15 +1,15 @@
-import type * as Model from "../model";
-import { type params } from "../util";
-/**
- * 세트 아이템 정보를 세트의 이름으로 검색합니다.
- *
- * @param {string} setItemName 세트 아이템의 이름입니다.
- * @param {object} params 선택적 요청변수의 Object입니다.
- */
-export declare const setitem: (setItemName: string, params?: params.ISetItem) => Promise<Model.IDnfResponse<Model.setItem.ISetItem[]>>;
-/**
- * 세트 ID로 세트 아이템 정보를 받아옵니다.
- *
- * @param {string} setItemId 세트 아이템의 ID입니다.
- */
-export declare const detail: (setItemId: string) => Promise<Model.IDnfResponse<Model.setItem.IDetail>>;
+import type * as Model from "../model";
+import { type params } from "../util";
+/**
+ * 세트 아이템 정보를 세트의 이름으로 검색합니다.
+ *
+ * @param {string} setItemName 세트 아이템의 이름입니다.
+ * @param {object} params 선택적 요청변수의 Object입니다.
+ */
+export declare const setitem: (setItemName: string, params?: params.ISetItem) => Promise<Model.IDnfResponse<Model.setItem.ISetItem[]>>;
+/**
+ * 세트 ID로 세트 아이템 정보를 받아옵니다.
+ *
+ * @param {string} setItemId 세트 아이템의 ID입니다.
+ */
+export declare const detail: (setItemId: string) => Promise<Model.IDnfResponse<Model.setItem.IDetail>>;

package/dist/src/index.d.ts

@@ -1,14 +1,21 @@
-import * as request from "./api";
-import * as model from "./model/index";
-import * as util from "./util";
-import config from "./util/config";
-import * as params from "./util/params";
-import * as query from "./util/query";
-import * as staticUtil from "./util/static";
-export default class DnfApi {
-    util: typeof util;
-    request: typeof request;
-}
-declare const ServerNames: typeof util.staticUtil.server;
-declare const RarityNames: typeof util.staticUtil.rarity;
-export { request as api, request, config, staticUtil, ServerNames, RarityNames, query, params, model, };
+import * as request from "./api";
+import * as model from "./model/index";
+import config from "./util/config";
+import * as params from "./util/params";
+import * as query from "./util/query";
+import * as staticUtil from "./util/static";
+declare const serverNames: typeof staticUtil.server;
+declare const rarityNames: typeof staticUtil.rarity;
+declare const dnf: {
+    api: typeof request;
+    request: typeof request;
+    config: import("./util/config").IConfig;
+    staticUtil: typeof staticUtil;
+    serverNames: typeof staticUtil.server;
+    rarityNames: typeof staticUtil.rarity;
+    query: typeof query;
+    params: typeof params;
+    model: typeof model;
+};
+export { request as api, request, config, staticUtil, serverNames, rarityNames, query, params, model, };
+export default dnf;