dnf-api 0.6.4 → 1.0.0

package/src/api/auction.ts

@@ -1,5 +1,5 @@
-import type * as Model from "../model";
-import { type Params, Query, Static } from "../util";
+import type * as model from "../model";
+import { type params, query, staticUtil } from "../util";
 
 /**
  * 경매장에 등록된 아이템을 "아이템 이름"을 기준으로 받아옵니다
@@ -7,13 +7,13 @@ import { type Params, Query, Static } from "../util";
  * @param {string} itemName 검색할 아이템의 이름입니다.
  * @param {object} params 선택적 요청변수의 Object입니다.
  */
-export const itemName = (itemName: string, params: Params.IAuction = {}) => {
+export const itemName = (itemName: string, params: params.IAuction = {}) => {
   params.itemName = itemName;
   const opt = {
-    base: Query.UriBuilder(Static.BaseUri.Auction),
+    base: query.UriBuilder(staticUtil.baseUri.Auction),
     params,
   };
-  return Query.Request<Model.Rows<Model.Auction>>(opt);
+  return query.Request<model.IRows<model.IAuction>>(opt);
 };
 
 /**
@@ -22,13 +22,13 @@ export const itemName = (itemName: string, params: Params.IAuction = {}) => {
  * @param {string} itemID 검색할 아이템의 ID입니다.
  * @param {object} params 선택적 요청변수의 Object입니다.
  */
-export const itemId = (itemId: string, params: Params.IAuction = {}) => {
+export const itemId = (itemId: string, params: params.IAuction = {}) => {
   params.itemId = itemId;
   const opt = {
-    base: Query.UriBuilder(Static.BaseUri.Auction),
+    base: query.UriBuilder(staticUtil.baseUri.Auction),
     params: params,
   };
-  return Query.Request<Model.Rows<Model.Auction>>(opt);
+  return query.Request<model.IRows<model.IAuction>>(opt);
 };
 /**
  * 경매장에 등록된 경매장번호로 받아옵니다.
@@ -37,31 +37,31 @@ export const itemId = (itemId: string, params: Params.IAuction = {}) => {
  */
 export const no = (auctionNo: number) => {
   const opt = {
-    base: Query.UriBuilder(Static.BaseUri.Auction, auctionNo),
+    base: query.UriBuilder(staticUtil.baseUri.Auction, auctionNo),
   };
-  return Query.Request<Model.Auction>(opt);
+  return query.Request<model.IAuction>(opt);
 };
 
 export const auctionSoldName = (
   itemName: string,
-  params: Params.IActionSoldOption = {},
+  params: params.IActionSoldOption = {}
 ) => {
   params.itemName = itemName;
   const opt = {
-    base: Query.UriBuilder(Static.BaseUri.AuctionSold),
+    base: query.UriBuilder(staticUtil.baseUri.AuctionSold),
     params,
   };
-  return Query.Request<Model.Rows<Model.AuctionSolid>>(opt);
+  return query.Request<model.IRows<model.IAuctionSolid>>(opt);
 };
 
 export const auctionSoldId = (
   itemId: string,
-  params: Params.IActionSoldOption = {},
+  params: params.IActionSoldOption = {}
 ) => {
   params.itemId = itemId;
   const opt = {
-    base: Query.UriBuilder(Static.BaseUri.AuctionSold),
+    base: query.UriBuilder(staticUtil.baseUri.AuctionSold),
     params,
   };
-  return Query.Request<Model.Rows<Model.AuctionSolid>>(opt);
+  return query.Request<model.IRows<model.IAuctionSolid>>(opt);
 };

package/src/api/characters.equip.ts

@@ -1,81 +1,81 @@
-import { Query, Static } from "../util";
+import { query, staticUtil } from "../util";
 
 /**
  * 해당 캐릭터가 장착한 장비 정보를 받아옵니다.
  *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
  * @param {string} characterId 검색할 캐릭터의 ID입니다.
  */
-export const equipment = (serverId: Static.Server, characterId: string) => {
+export const equipment = (serverId: staticUtil.server, characterId: string) => {
   const opt = {
-    base: Query.UriBuilder(
-      Static.BaseUri.Servers,
+    base: query.UriBuilder(
+      staticUtil.baseUri.Servers,
       serverId,
       "characters",
       characterId,
       "equip",
-      "equipment",
+      "equipment"
     ),
   };
-  return Query.Request(opt);
+  return query.Request(opt);
 };
 
 /**
  * 해당 캐릭터가 장착한 아바타 정보를 받아옵니다.
  *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
  * @param {string} characterId 검색할 캐릭터의 ID입니다.
  */
-export const avatar = (serverId: Static.Server, characterId: string) => {
+export const avatar = (serverId: staticUtil.server, characterId: string) => {
   const opt = {
-    base: Query.UriBuilder(
-      Static.BaseUri.Servers,
+    base: query.UriBuilder(
+      staticUtil.baseUri.Servers,
       serverId,
       "characters",
       characterId,
       "equip",
-      "avatar",
+      "avatar"
     ),
   };
-  return Query.Request(opt);
+  return query.Request(opt);
 };
 
 /**
  * 해당 캐릭터가 장착한 크리쳐 정보를 받아옵니다.
  *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
  * @param {string} characterId 검색할 캐릭터의 ID입니다.
  */
-export const creature = (serverId: Static.Server, characterId: string) => {
+export const creature = (serverId: staticUtil.server, characterId: string) => {
   const opt = {
-    base: Query.UriBuilder(
-      Static.BaseUri.Servers,
+    base: query.UriBuilder(
+      staticUtil.baseUri.Servers,
       serverId,
       "characters",
       characterId,
       "equip",
-      "creature",
+      "creature"
     ),
   };
-  return Query.Request(opt);
+  return query.Request(opt);
 };
 
 /**
  * 해당 캐릭터가 장착한 휘장 정보를 받아옵니다.
  *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
  * @param {string} characterId 검색할 캐릭터의 ID입니다.
  */
-export const flag = (serverId: Static.Server, characterId: string) => {
+export const flag = (serverId: staticUtil.server, characterId: string) => {
   const opt = {
-    base: Query.UriBuilder(
-      Static.BaseUri.Servers,
+    base: query.UriBuilder(
+      staticUtil.baseUri.Servers,
       serverId,
       "characters",
       characterId,
       "equip",
-      "flag",
+      "flag"
     ),
   };
-  return Query.Request(opt);
+  return query.Request(opt);
 };

package/src/api/characters.skill.ts

@@ -1,52 +1,86 @@
-import { Query, Static } from "../util";
+import { query, staticUtil } from "../util";
 /**
  *  아이템 및 장비를 통한 스킬 강화 제외 입니다.
  *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
  * @param {string} characterId 검색할 캐릭터의 ID입니다.
  */
-export const style = (serverId: Static.Server, characterId: string) => {
+export const style = (serverId: staticUtil.server, characterId: string) => {
   const opt = {
-    base: `${Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "skill", "style")}`,
+    base: `${query.UriBuilder(
+      staticUtil.baseUri.Servers,
+      serverId,
+      "characters",
+      characterId,
+      "skill",
+      "style"
+    )}`,
   };
-  return Query.Request(opt);
+  return query.Request(opt);
 };
 
 /**
  * 캐릭터 '버프 스킬 강화 장착 장비'(스위칭) 를 조회합니다.
  *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
  * @param {string} characterId 검색할 캐릭터의 ID입니다.
  */
-export const equipment = (serverId: Static.Server, characterId: string) => {
+export const equipment = (serverId: staticUtil.server, characterId: string) => {
   const opt = {
-    base: `${Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "skill", "buff", "equip", "equipment")}`,
+    base: `${query.UriBuilder(
+      staticUtil.baseUri.Servers,
+      serverId,
+      "characters",
+      characterId,
+      "skill",
+      "buff",
+      "equip",
+      "equipment"
+    )}`,
   };
-  return Query.Request(opt);
+  return query.Request(opt);
 };
 
 /**
  * 캐릭터 '버프 스킬 강화 장착 아바타'(스위칭) 를 조회합니다.
  *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
  * @param {string} characterId 검색할 캐릭터의 ID입니다.
  */
-export const avatar = (serverId: Static.Server, characterId: string) => {
+export const avatar = (serverId: staticUtil.server, characterId: string) => {
   const opt = {
-    base: `${Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "skill", "buff", "equip", "avatar")}`,
+    base: `${query.UriBuilder(
+      staticUtil.baseUri.Servers,
+      serverId,
+      "characters",
+      characterId,
+      "skill",
+      "buff",
+      "equip",
+      "avatar"
+    )}`,
   };
-  return Query.Request(opt);
+  return query.Request(opt);
 };
 
 /**
  * 캐릭터 '버프 스킬 강화 장착 크리쳐'(스위칭) 를 조회합니다.
  *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
  * @param {string} characterId 검색할 캐릭터의 ID입니다.
  */
-export const creature = (serverId: Static.Server, characterId: string) => {
+export const creature = (serverId: staticUtil.server, characterId: string) => {
   const opt = {
-    base: `${Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "skill", "buff", "equip", "creature")}`,
+    base: `${query.UriBuilder(
+      staticUtil.baseUri.Servers,
+      serverId,
+      "characters",
+      characterId,
+      "skill",
+      "buff",
+      "equip",
+      "creature"
+    )}`,
   };
-  return Query.Request(opt);
+  return query.Request(opt);
 };

package/src/api/characters.ts

@@ -1,91 +1,91 @@
-import type * as Model from "../model";
-import { type Params, Query, Static } from "../util";
+import type * as model from "../model";
+import { type params, query, staticUtil } from "../util";
 
 /**
  * 서버 이름과 캐릭터 닉네임을 입력하여 해당 캐릭터를 검색합니다.
  *
- * @param {Static.Server} [serverId=""] 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {staticUtil.server} [serverId=""] 캐릭터가 존재하는 서버의 이름입니다.
  * @param {string} [characterName=""] 검색할 캐릭터의 이름입니다.
  * @param {object} [params={}] 선택적 요청변수의 Object입니다.
  */
 export const characterName = (
-  serverId: Static.Server,
+  serverId: staticUtil.server,
   characterName: string,
-  params: Params.ICharParams = {},
+  params: params.ICharParams = {}
 ) => {
   // if (params === undefined) params = {};
   params.characterName = characterName;
   const opt = {
-    base: Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters"),
+    base: query.UriBuilder(staticUtil.baseUri.Servers, serverId, "characters"),
     params: params,
   };
-  return Query.Request<Model.Rows<Model.Char.Character>>(opt);
+  return query.Request<model.IRows<model.char.ICharacter>>(opt);
 };
 
 /**
  * 캐릭터 ID를 입력하여 해당 캐릭터 정보를 받아옵니다
  *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
  * @param {string} characterId 검색할 캐릭터의 ID입니다.
  */
 export const characterId = (
-  serverId: Static.Server,
-  characterId: string,
-): Promise<Model.DnfResponse<Model.Char.Info>> => {
+  serverId: staticUtil.server,
+  characterId: string
+): Promise<model.IDnfResponse<model.char.IInfo>> => {
   const opt = {
-    base: Query.UriBuilder(
-      Static.BaseUri.Servers,
+    base: query.UriBuilder(
+      staticUtil.baseUri.Servers,
       serverId,
       "characters",
-      characterId,
+      characterId
     ),
   };
-  return Query.Request<Model.Char.Info>(opt);
+  return query.Request<model.char.IInfo>(opt);
 };
 
 /**
  * 캐릭터 ID를 입력하여 해당 캐릭터의 타임라인 정보를 검색합니다.
  *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
  * @param {string} characterId 검색할 캐릭터의 ID입니다.
  * @param {object} params 선택적 요청변수의 Object입니다.
  */
 export const timeline = (
-  serverId: Static.Server,
+  serverId: staticUtil.server,
   characterId: string,
-  params: Params.ITimeLine = {},
-): Promise<Model.DnfResponse<Model.Char.Timeline>> => {
+  params: params.ITimeLine = {}
+): Promise<model.IDnfResponse<model.char.ITimeline>> => {
   const opt = {
-    base: Query.UriBuilder(
-      Static.BaseUri.Servers,
+    base: query.UriBuilder(
+      staticUtil.baseUri.Servers,
       serverId,
       "characters",
       characterId,
-      "timeline",
+      "timeline"
     ),
     params: {
       ...params,
-      ...(params.code ? { code: Query.QueryBuilder(params.code) } : {}),
+      ...(params.code ? { code: query.QueryBuilder(params.code) } : {}),
     },
   };
-  return Query.Request<Model.Char.Timeline>(opt);
+  return query.Request<model.char.ITimeline>(opt);
 };
 
 /**
  * 캐릭터 ID를 입력하여 해당 캐릭터의 능력치 정보를 검색합니다.
  *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {staticUtil.server} serverId 캐릭터가 존재하는 서버의 이름입니다.
  * @param {string} characterId 검색할 캐릭터의 ID입니다.
  */
-export const status = (serverId: Static.Server, characterId: string) => {
+export const status = (serverId: staticUtil.server, characterId: string) => {
   const opt = {
-    base: Query.UriBuilder(
-      Static.BaseUri.Servers,
+    base: query.UriBuilder(
+      staticUtil.baseUri.Servers,
       serverId,
       "characters",
       characterId,
-      "status",
+      "status"
     ),
   };
-  return Query.Request<Model.Char.CharacterStatus>(opt);
+  return query.Request<model.char.ICharacterStatus>(opt);
 };

package/src/api/index.ts

@@ -1,9 +1,10 @@
-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";
+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 };
+export { action, equip, skill, characters, item, setItem, server, multi };

package/src/api/items.ts

@@ -1,49 +1,49 @@
-import type * as Model from "../model";
-import { type Params, Query, Static } from "../util";
-
-/**
- * 현재 인게임에서 획득 가능한 아이템의 경우만 검색 가능합니다.
- *
- * @param {string} itemName 검색할 아이템의 명칭
- * @param {string} params 선택적 요청변수의 Object입니다.
- */
-export const item = async (itemName: string, params: Params.IItem = {}) => {
-  //   if (params === undefined) params = {};
-  params.itemName = itemName;
-  //   if (query) params.q = Query.makeItemQuery(query);
-  //let querystring =
-  const opt = {
-    base: Query.UriBuilder(Static.BaseUri.Item),
-    params: {
-      ...params,
-      ...(params.hashtag
-        ? { hashtag: Query.QueryBuilder(params.hashtag ?? []) }
-        : {}),
-    },
-  };
-  return await Query.Request<Model.Rows<Model.Item.Item>>(opt);
-};
-/**
- * 해당하는 아이템의 상세정보를 요청합니다.
- *
- * @param {string} itemId 검색할 아이템의 ID
- */
-export const detail = (itemId: string) => {
-  const opt = {
-    base: Query.UriBuilder(Static.BaseUri.Item, itemId),
-  };
-  return Query.Request<Model.Item.Detail>(opt);
-};
-
-/**
- * 26. 아이템 상점 판매 정보 조회
- * 인게임 백과사전 기준의 상점 판매 95레벨 에픽, 100레벨 이상 유니크, 레전더리, 에픽 장비가 조회 가능 합니다.
- *
- * @param {string} itemId 검색할 아이템의 ID
- */
-// export const shop = (itemId: string) => {
-//   const opt = {
-//     base: Query.UriBuilder(Static.BaseUri.Item, itemId),
-//   };
-//   return Query.Request<Model.Item.Detail>(opt);
-// };
+import type * as model from "../model";
+import { type params, query, staticUtil } from "../util";
+
+/**
+ * 현재 인게임에서 획득 가능한 아이템의 경우만 검색 가능합니다.
+ *
+ * @param {string} itemName 검색할 아이템의 명칭
+ * @param {string} params 선택적 요청변수의 Object입니다.
+ */
+export const item = async (itemName: string, params: params.IItem = {}) => {
+  //   if (params === undefined) params = {};
+  params.itemName = itemName;
+  //   if (query) params.q = query.makeItemQuery(query);
+  //let querystring =
+  const opt = {
+    base: query.UriBuilder(staticUtil.baseUri.Item),
+    params: {
+      ...params,
+      ...(params.hashtag
+        ? { hashtag: query.QueryBuilder(params.hashtag ?? []) }
+        : {}),
+    },
+  };
+  return await query.Request<model.IDnfResponse<model.item.IItem>>(opt);
+};
+/**
+ * 해당하는 아이템의 상세정보를 요청합니다.
+ *
+ * @param {string} itemId 검색할 아이템의 ID
+ */
+export const detail = (itemId: string) => {
+  const opt = {
+    base: query.UriBuilder(staticUtil.baseUri.Item, itemId),
+  };
+  return query.Request<model.IDnfResponse<model.item.IDetail>>(opt);
+};
+
+/**
+ * 26. 아이템 상점 판매 정보 조회
+ * 인게임 백과사전 기준의 상점 판매 95레벨 에픽, 100레벨 이상 유니크, 레전더리, 에픽 장비가 조회 가능 합니다.
+ *
+ * @param {string} itemId 검색할 아이템의 ID
+ */
+// export const shop = (itemId: string) => {
+//   const opt = {
+//     base: query.UriBuilder(staticUtil.BaseUri.Item, itemId),
+//   };
+//   return query.Request<model.item.detail>(opt);
+// };

package/src/api/multi.ts

@@ -0,0 +1,17 @@
+import type * as Model from "../model";
+import { type params, query, staticUtil } from "../util";
+
+/**
+ * 해당하는 아이템의 상세정보를 요청합니다.
+ *
+ * @param {string} itemId 검색할 아이템의 ID
+ */
+export const items = (itemIdList: string[]) => {
+  const opt = {
+    base: query.UriBuilder(staticUtil.baseUri.Multi, "items"),
+    params: {
+      itemIds: itemIdList.join(","),
+    },
+  };
+  return query.Request<Model.item.IDetail[]>(opt);
+};

package/src/api/server.ts

@@ -1,9 +1,9 @@
 import type * as Model from "../model";
-import { Query, Static } from "../util";
+import { query, staticUtil } from "../util";
 
-export const List = (): Promise<Model.DnfResponse<Model.Server[]>> => {
+export const List = (): Promise<Model.IDnfResponse<Model.IServer[]>> => {
   const opt = {
-    base: Query.UriBuilder(Static.BaseUri.Servers),
+    base: query.UriBuilder(staticUtil.baseUri.Servers),
   };
-  return Query.Request<Model.Server[]>(opt);
+  return query.Request<Model.IServer[]>(opt);
 };

package/src/api/setitems.ts

@@ -1,5 +1,5 @@
 import type * as Model from "../model";
-import { type Params, Query, Static } from "../util";
+import { type params, query, staticUtil } from "../util";
 
 /**
  * 세트 아이템 정보를 세트의 이름으로 검색합니다.
@@ -9,14 +9,14 @@ import { type Params, Query, Static } from "../util";
  */
 export const setitem = (
   setItemName: string,
-  params: Params.ISetItem = {},
-): Promise<Model.DnfResponse<Model.SetItem.SetItem[]>> => {
+  params: params.ISetItem = {}
+): Promise<Model.IDnfResponse<Model.setItem.ISetItem[]>> => {
   params.setItemName = setItemName;
   const opt = {
-    base: Query.UriBuilder(Static.BaseUri.SetItem),
+    base: query.UriBuilder(staticUtil.baseUri.SetItem),
     params: params,
   };
-  return Query.Request<Model.SetItem.SetItem[]>(opt);
+  return query.Request<Model.setItem.ISetItem[]>(opt);
 };
 
 /**
@@ -25,10 +25,10 @@ export const setitem = (
  * @param {string} setItemId 세트 아이템의 ID입니다.
  */
 export const detail = (
-  setItemId: string,
-): Promise<Model.DnfResponse<Model.SetItem.Detail>> => {
+  setItemId: string
+): Promise<Model.IDnfResponse<Model.setItem.IDetail>> => {
   const opt = {
-    base: Query.UriBuilder(Static.BaseUri.SetItem, setItemId),
+    base: query.UriBuilder(staticUtil.baseUri.SetItem, setItemId),
   };
-  return Query.Request<Model.SetItem.Detail>(opt);
+  return query.Request<Model.setItem.IDetail>(opt);
 };