dnf-api 0.6.4 → 1.0.0

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

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

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

@@ -1,8 +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 Server from "./server";
-import * as SetItem from "./setitems";
-export { Action, Equip, Skill, Characters, Item, SetItem, Server };
+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,18 +1,18 @@
-import type * as Model from "../model";
-import { type Params } from "../util";
+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.DnfResponse<Model.Rows<Model.Item.Item>>>;
+export declare const item: (itemName: string, params?: params.IItem) => Promise<model.IDnfResponse<model.IDnfResponse<model.item.IItem>>>;
 /**
  * 해당하는 아이템의 상세정보를 요청합니다.
  *
  * @param {string} itemId 검색할 아이템의 ID
  */
-export declare const detail: (itemId: string) => Promise<Model.DnfResponse<Model.Item.Detail>>;
+export declare const detail: (itemId: string) => Promise<model.IDnfResponse<model.IDnfResponse<model.item.IDetail>>>;
 /**
  * 26. 아이템 상점 판매 정보 조회
  * 인게임 백과사전 기준의 상점 판매 95레벨 에픽, 100레벨 이상 유니크, 레전더리, 에픽 장비가 조회 가능 합니다.

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

@@ -0,0 +1,7 @@
+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.DnfResponse<Model.Server[]>>;
+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";
+import { type params } from "../util";
 /**
  * 세트 아이템 정보를 세트의 이름으로 검색합니다.
  *
  * @param {string} setItemName 세트 아이템의 이름입니다.
  * @param {object} params 선택적 요청변수의 Object입니다.
  */
-export declare const setitem: (setItemName: string, params?: Params.ISetItem) => Promise<Model.DnfResponse<Model.SetItem.SetItem[]>>;
+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.DnfResponse<Model.SetItem.Detail>>;
+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 Static from "./util/static";
-export default class DnfApi {
-    static Util: typeof Util;
-    static Request: typeof Request;
-}
-declare const ServerNames: typeof Util.Static.Server;
-declare const RarityNames: typeof Util.Static.Rarity;
-export { Request as Api, Request, Config, Static, 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;

package/dist/src/model/character.d.ts

@@ -1,7 +1,8 @@
-import type { Static } from "../util";
-import type { NameValue } from "./";
-export type Character = {
-    serverId: Static.Server;
+import type { staticUtil } from "../util";
+import type { INameValue } from "./";
+/** 캐릭터 정보 인터페이스 */
+export interface ICharacter {
+    serverId: staticUtil.server;
     characterId: string;
     characterName: string;
     level: number;
@@ -10,9 +11,10 @@ export type Character = {
     jobName: string;
     jobGrowName: string;
     fame: number;
-};
-export type Info = {
-    serverId: Static.Server;
+}
+/** 캐릭터 상세 정보 인터페이스 */
+export interface IInfo {
+    serverId: staticUtil.server;
     characterId: string;
     characterName: string;
     level: number;
@@ -24,9 +26,10 @@ export type Info = {
     adventureName: string;
     guildId: string | null;
     guildName: string | null;
-};
-export type Timeline = {
-    serverId: Static.Server;
+}
+/** 캐릭터 타임라인 인터페이스 */
+export interface ITimeline {
+    serverId: staticUtil.server;
     characterId: string;
     characterName: string;
     level: number;
@@ -43,26 +46,29 @@ export type Timeline = {
             end: Date;
         };
         next: string;
-        rows: TimeLineRow[];
+        rows: ITimeLineRow[];
     };
-};
-export type TimeLineRow = {
+}
+/** 타임라인 행 인터페이스 */
+export interface ITimeLineRow {
     code: number;
     name: string;
     date: string;
-    data: TimeLineRowData;
-};
-export type TimeLineRowData = {
+    data: ITimeLineRowData;
+}
+/** 타임라인 행 데이터 인터페이스 */
+export interface ITimeLineRowData {
     itemId: string;
     itemName: string;
-    itemRarity: Static.Rarity;
+    itemRarity: staticUtil.rarity;
     channelName: string;
     channelNo: number;
     dungeonName: string;
     mistGear: boolean;
-};
-export type CharacterStatus = {
-    serverId: Static.Server;
+}
+/** 캐릭터 상태 인터페이스 */
+export interface ICharacterStatus {
+    serverId: staticUtil.server;
     characterId: string;
     characterName: string;
     level: number;
@@ -74,11 +80,12 @@ export type CharacterStatus = {
     adventureName: string;
     guildId: string | null;
     guildName: string | null;
-    buff: Buff[];
-    status: NameValue[];
-};
-export type Buff = {
+    buff: IBuff[];
+    status: INameValue[];
+}
+/** 버프 정보 인터페이스 */
+export interface IBuff {
     name: string;
     level?: number;
-    status: NameValue[];
-};
+    status: INameValue[];
+}

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

@@ -1,24 +1,29 @@
-import * as Char from "./character";
-import * as Item from "./item";
-import * as SetItem from "./setitem";
-export { Char, Item, SetItem };
-export type DnfErrorResponse = {
+import * as char from "./character";
+import * as item from "./item";
+import * as setItem from "./setitem";
+export { char, item, setItem };
+/** 에러 응답 인터페이스 */
+export interface IDnfErrorResponse {
     url: string;
     status: number;
     statusText: string;
     code: string;
     message: string;
-};
-export type DnfSuccess<T> = {
+}
+/** 성공 응답 인터페이스 */
+export interface IDnfSuccess<T> {
     data: T;
     error?: never;
-};
-export type DnfError = {
+}
+/** 에러 정보 인터페이스 */
+export interface IDnfError {
     data?: never;
-    error: DnfErrorResponse;
-};
-export type DnfResponse<T> = DnfSuccess<T> | DnfError;
-export type Auction = {
+    error: IDnfErrorResponse;
+}
+/** 응답 타입(합성 타입) */
+export type IDnfResponse<T> = IDnfSuccess<T> | IDnfError;
+/** 경매장 아이템 인터페이스 */
+export interface IAuction {
     auctionNo: number;
     regDate: Date;
     expireDate: Date;
@@ -42,8 +47,9 @@ export type Auction = {
     averagePrice: number;
     upgrade?: number;
     upgradeMax?: number;
-};
-export type AuctionSolid = {
+}
+/** 판매 완료 아이템 인터페이스 */
+export interface IAuctionSolid {
     soldDate: string;
     itemId: string;
     itemName: string;
@@ -62,15 +68,18 @@ export type AuctionSolid = {
     unitPrice: number;
     upgrade?: number;
     upgradeMax?: number;
-};
-export type Rows<T> = {
+}
+/** 행 배열 인터페이스 */
+export interface IRows<T> {
     rows: T[];
-};
-export type Server = {
+}
+/** 서버 정보 인터페이스 */
+export interface IServer {
     serverId: string;
     serverName: string;
-};
-export type NameValue = {
+}
+/** 이름-값 쌍 인터페이스 */
+export interface INameValue {
     name: string;
     value: string | number;
-};
+}

package/dist/src/model/item.d.ts

@@ -1,19 +1,22 @@
 import type * as Static from "../util/static";
-import type { NameValue } from "./";
+import type { INameValue } from "./";
 export declare enum ItemDetailKind {
     Material = "material",
     Equip = "equip"
 }
-export type Item = {
+/** 아이템 인터페이스 */
+export interface IItem {
     itemId: string;
     itemName: string;
-    itemRarity: Static.Rarity;
+    itemRarity: Static.rarity;
     itemType: string;
     itemTypeDetail: string;
     itemAvailableLevel: number;
-};
-export type Detail = MaterialDetail | EquipDetail;
-export type MaterialDetail = {
+}
+/** 아이템 상세 인터페이스(합성 타입) */
+export type IDetail = IMaterialDetail | IEquipDetail;
+/** 재료 아이템 상세 인터페이스 */
+export interface IMaterialDetail {
     kind: ItemDetailKind.Material;
     itemId: string;
     itemName: string;
@@ -29,9 +32,10 @@ export type MaterialDetail = {
     fame: number;
     setItemId: string | null;
     setItemName: string | null;
-    obtainInfo: ObtainInfo;
-};
-export type EquipDetail = {
+    obtainInfo: IObtainInfo;
+}
+/** 장비 아이템 상세 인터페이스 */
+export interface IEquipDetail {
     kind: ItemDetailKind.Equip;
     itemId: string;
     itemName: string;
@@ -47,44 +51,53 @@ export type EquipDetail = {
     fame: number;
     setItemId: string | null;
     setItemName: string | null;
-    itemStatus: NameValue[];
-    tune: Tune;
-    itemBuff: ItemBuff;
+    itemStatus: INameValue[];
+    tune: ITune;
+    itemBuff: IItemBuff;
     hashtag: string[];
-    obtainInfo: ObtainInfoDetail;
-};
-export type Tune = {
+    obtainInfo: IObtainInfoDetail;
+}
+/** 튠 정보 인터페이스 */
+export interface ITune {
     level: number;
     setPoint: number;
-};
-export type ItemBuff = {
+}
+/** 아이템 버프 인터페이스 */
+export interface IItemBuff {
     explain: string;
     explainDetail: string;
     reinforceSkill: any[];
     status: any | null;
-};
-export type ObtainInfo = {
+}
+/** 획득 정보 인터페이스 */
+export interface IObtainInfo {
     dungeon: string | null;
-    shop: ShopInfo[];
-};
-export type ObtainInfoDetail = {
-    dungeon: Dungeon[];
-    shop: ShopDetail[];
-};
-export type Dungeon = {
+    shop: IShopInfo[];
+}
+/** 획득 상세 정보 인터페이스 */
+export interface IObtainInfoDetail {
+    dungeon: IDungeon[];
+    shop: IShopDetail[];
+}
+/** 던전 정보 인터페이스 */
+export interface IDungeon {
     type: string;
-    rows: DungeonRow[];
-};
-export type DungeonRow = {
+    rows: IDungeonRow[];
+}
+/** 던전 행 인터페이스 */
+export interface IDungeonRow {
     name: string;
-};
-export type ShopInfo = {
+}
+/** 상점 정보 인터페이스 */
+export interface IShopInfo {
     type: string;
-};
-export type ShopDetail = {
-    rows: ShopRow[];
-};
-export type ShopRow = {
+}
+/** 상점 상세 정보 인터페이스 */
+export interface IShopDetail {
+    rows: IShopRow[];
+}
+/** 상점 행 인터페이스 */
+export interface IShopRow {
     name: string;
     details: string[];
-};
+}

package/dist/src/model/setitem.d.ts

@@ -1,8 +1,10 @@
-export type SetItem = {
+/** 세트 아이템 인터페이스 */
+export interface ISetItem {
     setItemId: string;
     setItemName: string;
-};
-export type Detail = {
+}
+/** 세트 아이템 상세 인터페이스 */
+export interface IDetail {
     setItemId: string;
     setItemName: string;
     setItems: [
@@ -27,4 +29,4 @@ export type Detail = {
             ];
         }
     ];
-};
+}

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

@@ -1,5 +1,5 @@
-import Config from "./config";
-import * as Params from "./params";
-import Query from "./query";
-import * as Static from "./static";
-export { Config, Query, Static, Params };
+import config from "./config";
+import * as params from "./params";
+import query from "./query";
+import * as staticUtil from "./static";
+export { config, query, staticUtil, params };

package/dist/src/util/params.d.ts

@@ -1,4 +1,4 @@
-import type * as Static from "./static";
+import type * as staticUtil from "./static";
 export interface QueryOptions<T = any> {
     base: string;
     params?: T;
@@ -8,11 +8,11 @@ export interface ICharParams {
     jobId?: string;
     jobGrowId?: string;
     isAllJobGrow?: boolean;
-    wordType?: Static.CharactersWordType;
+    wordType?: staticUtil.charactersWordType;
     limit?: number;
 }
 export interface ITimeLine {
-    serverId?: Static.Server;
+    serverId?: staticUtil.server;
     characterId?: string;
     startDate?: Date;
     endDate?: Date;
@@ -25,20 +25,20 @@ export interface IAuction {
     sort?: IAuctionSort;
     itemId?: string;
     itemName?: string;
-    wordType?: Static.AuctionWordType;
+    wordType?: staticUtil.auctionWordType;
     wordShort?: boolean;
     q?: IAuctionQuery;
 }
 export interface IAuctionSort {
-    unitPrice?: Static.Sort;
-    reinforce?: Static.Sort;
-    auctionNo?: Static.Sort;
+    unitPrice?: staticUtil.sort;
+    reinforce?: staticUtil.sort;
+    auctionNo?: staticUtil.sort;
 }
 export interface IAuctionQuery {
     minLevel?: number;
     maxLevel?: number;
-    raity?: Static.Rarity;
-    reinforceTypeId: Static.reinforceType;
+    raity?: staticUtil.rarity;
+    reinforceTypeId: staticUtil.reinforceType;
     minReinforce?: number;
     maxReinforce?: number;
     minRefine?: number;
@@ -48,7 +48,7 @@ export interface IAuctionQuery {
 }
 export interface IActionSoldOption {
     limit?: number;
-    wordType?: Static.AuctionWordType;
+    wordType?: staticUtil.auctionWordType;
     wordShort?: boolean;
     itemId?: string;
     itemName?: string;
@@ -57,18 +57,18 @@ export interface IItem {
     limit?: number;
     itemName?: string;
     hashtag?: string[];
-    wordType?: Static.AuctionWordType;
+    wordType?: staticUtil.auctionWordType;
     q?: IItemQuery;
 }
 export interface IItemQuery {
     minLevel?: number;
     maxLevel?: number;
-    rarity?: Static.Rarity;
+    rarity?: staticUtil.rarity;
 }
 export interface ISetItem {
     setItemName?: string;
     limit?: number;
-    wordType?: Static.AuctionWordType;
+    wordType?: staticUtil.auctionWordType;
 }
 export interface ISkill {
     jobGrowId: string;

package/dist/src/util/query.d.ts

@@ -1,4 +1,4 @@
-import type * as Model from "../model";
+import type * as model from "../model";
 export default class Request {
     static UriBuilder(...args: any[]): string;
     static QueryBuilder(query: string[] | number[]): string;
@@ -9,6 +9,6 @@ export default class Request {
      * @param {object} opt (요청을 보낼 Parameter값)
      * @returns
      */
-    static Request<T>(opt?: any, method?: "GET" | "POST"): Promise<Model.DnfResponse<T>>;
+    static Request<T>(opt?: any, method?: "GET" | "POST"): Promise<model.IDnfResponse<T>>;
     static makeItemQuery(query: any): string;
 }

package/dist/src/util/static.d.ts

@@ -1,4 +1,4 @@
-export declare enum Server {
+export declare enum server {
     Cain = "cain",
     Diregie = "diregie",
     Siroco = "siroco",
@@ -8,11 +8,11 @@ export declare enum Server {
     Anton = "anton",
     Bakal = "bakal"
 }
-export declare enum Sort {
+export declare enum sort {
     Asc = "asc",
     Desc = "desc"
 }
-export declare enum Rarity {
+export declare enum rarity {
     Common = "\uCEE4\uBA3C",
     Uncommon = "\uC5B8\uCEE4\uBA3C",
     Rare = "\uB808\uC5B4",
@@ -21,26 +21,27 @@ export declare enum Rarity {
     Chronicle = "\uD06C\uB85C\uB2C8\uD074",
     Legendary = "\uB808\uC804\uB354\uB9AC"
 }
-export declare enum AuctionWordType {
+export declare enum auctionWordType {
     Match = "match",
     Front = "front",
     Full = "full"
 }
-export declare enum WordType {
+export declare enum wordType {
     Match = "match",
     Front = "front",
     Full = "full"
 }
-export declare enum CharactersWordType {
+export declare enum charactersWordType {
     Match = "match",
     Full = "full"
 }
-export declare enum BaseUri {
+export declare enum baseUri {
     Servers = "df/servers",
     Auction = "df/auction",
     AuctionSold = "df/auction-sold",
     Item = "df/items",
-    SetItem = "df/setitems"
+    SetItem = "df/setitems",
+    Multi = "df/multi"
 }
 export declare enum reinforceType {
     reinforce = "\uAC15\uD654",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dnf-api",
-  "version": "0.6.4",
+  "version": "1.0.0",
   "description": "던전 앤 파이터 API",
   "main": "./dist/index.js",
   "types": "./dist/src/index.d.ts",
@@ -27,7 +27,9 @@
     "type": "git",
     "url": "git+https://github.com/k22pr/dnf-api.git"
   },
-  "keywords": ["dnf"],
+  "keywords": [
+    "dnf"
+  ],
   "author": "서버지기",
   "license": "MIT",
   "bugs": {