dnf-api 0.5.22 → 0.6.1

package/src/api/characters.skill.ts

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

package/src/api/characters.ts

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

package/src/api/index.ts

@@ -1,9 +1,9 @@
-import * as Action from "./auction";
-import * as Equip from "./characters.equip";
-import * as Skill from "./characters.skill";
-import * as Characters from "./characters";
-import * as Item from "./items";
-import * as SetItem from "./setitems";
-import * as Server from "./server";
-
-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 Server from "./server";
+import * as SetItem from "./setitems";
+
+export { Action, Equip, Skill, Characters, Item, SetItem, Server };

package/src/api/items.ts

@@ -1,5 +1,5 @@
-import { Query, Static, Params } from "../util";
-import * as Model from "../model";
+import type * as Model from "../model";
+import { type Params, Query, Static } from "../util";
 
 /**
  * 현재 인게임에서 획득 가능한 아이템의 경우만 검색 가능합니다.
@@ -7,25 +7,43 @@ import * as Model from "../model";
  * @param {string} itemName 검색할 아이템의 명칭
  * @param {string} params 선택적 요청변수의 Object입니다.
  */
-export const item = async (itemName: string, params: Params.IItem = {}): Promise<Model.DnfResponse<Model.Item.Item[]>> => {
+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 =
-  let opt = {
+  const opt = {
     base: Query.UriBuilder(Static.BaseUri.Item),
-    params: params,
+    params: {
+      ...params,
+      ...(params.hashtag
+        ? { hashtag: Query.QueryBuilder(params.hashtag) }
+        : {}),
+    },
   };
-  return await Query.Request<Model.Item.Item[]>(opt);
+  return await Query.Request<Model.Rows<Model.Item.Item>>(opt);
 };
 /**
  * 해당하는 아이템의 상세정보를 요청합니다.
  *
  * @param {string} itemId 검색할 아이템의 ID
  */
-export const detail = (itemId: string): Promise<Model.DnfResponse<Model.Item.Detail>> => {
-  let opt = {
-    base: Query.UriBuilder(Static.BaseUri.Item, itemId),  
+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);
+// };

package/src/api/server.ts

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

package/src/api/setitems.ts

@@ -1,29 +1,34 @@
-import { Query, Static, Params } from "../util";
-import * as Model from "../model";
-
-/**
- * 세트 아이템 정보를 세트의 이름으로 검색합니다.
- *
- * @param {string} setItemName 세트 아이템의 이름입니다.
- * @param {object} params 선택적 요청변수의 Object입니다.
- */
-export const setitem = (setItemName: string, params: Params.ISetItem = {}): Promise<Model.DnfResponse<Model.SetItem.SetItem[]>> => {
-  params.setItemName = setItemName;
-  let opt = {
-    base: Query.UriBuilder(Static.BaseUri.SetItem),
-    params: params,
-  };
-  return Query.Request<Model.SetItem.SetItem[]>(opt);
-};
-
-/**
- * 세트 ID로 세트 아이템 정보를 받아옵니다.
- *
- * @param {string} setItemId 세트 아이템의 ID입니다.
- */
-export const detail = (setItemId: string): Promise<Model.DnfResponse<Model.SetItem.Detail>> => {
-  let opt = {
-    base: Query.UriBuilder(Static.BaseUri.SetItem, setItemId),
-  };
-  return Query.Request<Model.SetItem.Detail>(opt);
-};
+import type * as Model from "../model";
+import { type Params, Query, Static } from "../util";
+
+/**
+ * 세트 아이템 정보를 세트의 이름으로 검색합니다.
+ *
+ * @param {string} setItemName 세트 아이템의 이름입니다.
+ * @param {object} params 선택적 요청변수의 Object입니다.
+ */
+export const setitem = (
+  setItemName: string,
+  params: Params.ISetItem = {},
+): Promise<Model.DnfResponse<Model.SetItem.SetItem[]>> => {
+  params.setItemName = setItemName;
+  const opt = {
+    base: Query.UriBuilder(Static.BaseUri.SetItem),
+    params: params,
+  };
+  return Query.Request<Model.SetItem.SetItem[]>(opt);
+};
+
+/**
+ * 세트 ID로 세트 아이템 정보를 받아옵니다.
+ *
+ * @param {string} setItemId 세트 아이템의 ID입니다.
+ */
+export const detail = (
+  setItemId: string,
+): Promise<Model.DnfResponse<Model.SetItem.Detail>> => {
+  const opt = {
+    base: Query.UriBuilder(Static.BaseUri.SetItem, setItemId),
+  };
+  return Query.Request<Model.SetItem.Detail>(opt);
+};

package/src/index.ts

@@ -1,18 +1,29 @@
-import * as Request from "./api";
-import * as Util from "./util";
-import * as Model from "./model/index";
-
-import * as Params from "./util/params";
-import Config from "./util/config";
-import * as Static from "./util/static";
-import * as Query from "./util/query";
-
-export default class DnfApi {
-  public static Util = Util;
-  public static Request = Request;
-}
-
-const ServerNames = Static.Server;
-const RarityNames = 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 * 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";
+
+// biome-ignore lint/complexity/noStaticOnlyClass: <explanation>
+export default class DnfApi {
+  public static Util = Util;
+  public static Request = Request;
+}
+
+const ServerNames = Static.Server;
+const RarityNames = Static.Rarity;
+
+export {
+  Request as Api,
+  Request,
+  Config,
+  Static,
+  ServerNames,
+  RarityNames,
+  Query,
+  Params,
+  Model,
+};

package/src/model/character.ts

@@ -1,4 +1,8 @@
+import type { Static } from "../util";
+import type { NameValue } from "./";
+
 export type Character = {
+  serverId: Static.Server;
   characterId: string;
   characterName: string;
   level: number;
@@ -6,9 +10,11 @@ export type Character = {
   jobGrowId: string;
   jobName: string;
   jobGrowName: string;
+  fame: number;
 };
 
 export type Info = {
+  serverId: Static.Server;
   characterId: string;
   characterName: string;
   level: number;
@@ -16,12 +22,14 @@ export type Info = {
   jobGrowId: string;
   jobName: string;
   jobGrowName: string;
+  fame: number;
   adventureName: string;
-  guildId: string;
-  guildName: string;
+  guildId: string | null;
+  guildName: string | null;
 };
 
 export type Timeline = {
+  serverId: Static.Server;
   characterId: string;
   characterName: string;
   level: number;
@@ -38,6 +46,46 @@ export type Timeline = {
       end: Date;
     };
     next: string;
-    rows: any[];
+    rows: TimeLineRow[];
   };
 };
+
+export type TimeLineRow = {
+  code: number;
+  name: string;
+  date: string;
+  data: TimeLineRowData;
+};
+
+export type TimeLineRowData = {
+  itemId: string;
+  itemName: string;
+  itemRarity: Static.Rarity;
+  channelName: string;
+  channelNo: number;
+  dungeonName: string;
+  mistGear: boolean;
+};
+
+export type CharacterStatus = {
+  serverId: Static.Server;
+  characterId: string;
+  characterName: string;
+  level: number;
+  jobId: string;
+  jobGrowId: string;
+  jobName: string;
+  jobGrowName: string;
+  fame: number;
+  adventureName: string;
+  guildId: string | null;
+  guildName: string | null;
+  buff: Buff[];
+  status: NameValue[];
+};
+
+export type Buff = {
+  name: string;
+  level?: number;
+  status: NameValue[];
+};