dnf-api 0.5.22 → 0.6.1

package/src/model/index.ts

@@ -1,62 +1,86 @@
-import * as Char from "./character";
-import * as Item from "./item";
-import * as SetItem from "./setitem";
-
-export { Char, Item, SetItem };
-
-export type DnfErrorResponse = {
-  url: string;
-  status: number;
-  statusText: string;
-  code: string;
-  message: string;
-};
-export type DnfResponse<T> = {
-  data?: T;
-  error?: DnfErrorResponse;
-};
-
-export type Auction = {
-  auctionNo: number;
-  regDate: Date;
-  expireDate: Date;
-  itemId: string;
-  itemName: string;
-  itemAvailableLevel: number;
-  itemRarity: string;
-  itemType: string;
-  itemTypeDetail: string;
-  refine: number;
-  reinforce: number;
-  amplificationName: string;
-  count: number;
-  price: number;
-  currentPrice: number;
-  unitPrice: number;
-  averagePrice: number;
-};
-
-export type AuctionSolid = {
-  soldDate: string;
-  itemId: string;
-  itemName: string;
-  itemAvailableLevel: number;
-  itemRarity: string;
-  itemType: string;
-  itemTypeDetail: string;
-  refine: number;
-  reinforce: number;
-  amplificationName: string | null;
-  count: number;
-  price: number;
-  unitPrice: number;
-};
-
-export type Rows<T> = {
-  rows: T[];
-};
-
-export type Server = {
-  serverId: string;
-  serverName: string;
-};
+import * as Char from "./character";
+import * as Item from "./item";
+import * as SetItem from "./setitem";
+
+export { Char, Item, SetItem };
+
+export type DnfErrorResponse = {
+  url: string;
+  status: number;
+  statusText: string;
+  code: string;
+  message: string;
+};
+
+export type DnfSuccess<T> = {
+  data: T;
+  error?: never;
+};
+
+export type DnfError = {
+  data?: never;
+  error: DnfErrorResponse;
+};
+
+export type DnfResponse<T> = DnfSuccess<T> | DnfError;
+
+export type Auction = {
+  auctionNo: number;
+  regDate: Date;
+  expireDate: Date;
+  itemId: string;
+  itemName: string;
+  itemAvailableLevel: number;
+  itemRarity: string;
+  itemTypeId: string;
+  itemType: string;
+  itemTypeDetailId: string;
+  itemTypeDetail: string;
+  refine: number;
+  reinforce: number;
+  amplificationName: string;
+  fame: number;
+  count: number;
+  regCount: number;
+  price: number;
+  currentPrice: number;
+  unitPrice: number;
+  averagePrice: number;
+  upgrade?: number;
+  upgradeMax?: number;
+};
+
+export type AuctionSolid = {
+  soldDate: string;
+  itemId: string;
+  itemName: string;
+  itemAvailableLevel: number;
+  itemRarity: string;
+  itemTypeId: string;
+  itemType: string;
+  itemTypeDetailId: string;
+  itemTypeDetail: string;
+  refine: number;
+  reinforce: number;
+  amplificationName: string | null;
+  fame: number;
+  count: number;
+  price: number;
+  unitPrice: number;
+  upgrade?: number;
+  upgradeMax?: number;
+};
+
+export type Rows<T> = {
+  rows: T[];
+};
+
+export type Server = {
+  serverId: string;
+  serverName: string;
+};
+
+export type NameValue = {
+  name: string;
+  value: string | number;
+};

package/src/model/item.ts

@@ -1,4 +1,10 @@
-import * as Static from "../util/static";
+import type * as Static from "../util/static";
+import type { NameValue } from "./";
+
+export enum ItemDetailKind {
+  Material = "material",
+  Equip = "equip",
+}
 
 export type Item = {
   itemId: string;
@@ -9,44 +15,90 @@ export type Item = {
   itemAvailableLevel: number;
 };
 
-export type Detail = {
+export type Detail = MaterialDetail | EquipDetail;
+
+export type MaterialDetail = {
+  kind: ItemDetailKind.Material;
   itemId: string;
   itemName: string;
-  itemRarity: Static.Rarity;
+  itemRarity: string;
+  itemTypeId: string;
   itemType: string;
+  itemTypeDetailId: string;
   itemTypeDetail: string;
   itemAvailableLevel: number;
-  itemObtainInfo: string;
   itemExplain: string;
   itemExplainDetail: string;
   itemFlavorText: string;
-  setItemId: string;
-  setItemName: string;
-  itemStatus?: itemStatus[];
-  cardInfo?: cardInfo[];
+  fame: number;
+  setItemId: string | null;
+  setItemName: string | null;
+  obtainInfo: ObtainInfo;
 };
 
-export type itemStatus = {
-  name: string;
-  value: number;
+export type EquipDetail = {
+  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: NameValue[];
+  tune: Tune;
+  itemBuff: ItemBuff;
+  hashtag: string[];
+  obtainInfo: ObtainInfoDetail;
 };
 
-export type cardInfo = {
-  slots: cardInfoSlot[];
-  enchant: cardInfoEnchant[];
+export type Tune = {
+  level: number;
+  setPoint: number;
+};
+
+export type ItemBuff = {
+  explain: string;
+  explainDetail: string;
+  reinforceSkill: any[];
+  status: any | null;
+};
+
+export type ObtainInfo = {
+  dungeon: string | null;
+  shop: ShopInfo[];
+};
+
+export type ObtainInfoDetail = {
+  dungeon: Dungeon[];
+  shop: ShopDetail[];
+};
+
+export type Dungeon = {
+  type: string;
+  rows: DungeonRow[];
+};
+
+export type DungeonRow = {
+  name: string;
 };
 
-export type cardInfoSlot = {
-  slotId: string;
-  slotName: string;
+export type ShopInfo = {
+  type: string;
 };
 
-export type cardInfoEnchant = {
-  status: cardInfoEnchantStatus[];
-  upgrade: number;
+export type ShopDetail = {
+  rows: ShopRow[];
 };
 
-export type cardInfoEnchantStatus = {
+export type ShopRow = {
   name: string;
-  value: number;
+  details: string[];
 };

package/src/model/setitem.ts

@@ -1,31 +1,31 @@
-export type SetItem = {
-  setItemId: string;
-  setItemName: string;
-};
-
-export type Detail = {
-  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;
-        }
-      ];
-    }
-  ];
-};
+export type SetItem = {
+  setItemId: string;
+  setItemName: string;
+};
+
+export type Detail = {
+  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/src/util/config.ts

@@ -1,19 +1,20 @@
-export interface IConfig {
-   key: string;
-   hideOnErrorApiKey: boolean;
-   hidekeyText: string;
-   axiosTimeout: number;
-   returnJSON: boolean;
-   responeHeader: boolean;
-   showURL: boolean
-}
-let defaultConfig: IConfig = {
-   key: "",
-   hideOnErrorApiKey: true,
-   hidekeyText: "{HIDEKEY}",
-   axiosTimeout: 5000,
-   returnJSON: false,
-   responeHeader: false,
-   showURL: false
-};
-export default defaultConfig;
+export interface IConfig {
+  key: string | undefined;
+  hideOnErrorApiKey: boolean;
+  hideKeyText: string;
+  timeout: number;
+  returnJSON: boolean;
+  responseHeader: boolean;
+  showURL: boolean;
+}
+// biome-ignore lint/style/useConst: <explanation>
+let defaultConfig: IConfig = {
+  key: "",
+  hideOnErrorApiKey: true,
+  hideKeyText: "{HIDE_KEY}",
+  timeout: 5000,
+  returnJSON: false,
+  responseHeader: false,
+  showURL: false,
+};
+export default defaultConfig;

package/src/util/index.ts

@@ -1,6 +1,6 @@
-import Config from "./config";
-import Query from "./query";
-import * as Params from "./params";
-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 Static from "./static";
+
+export { Config, Query, Static, Params };

package/src/util/params.ts

@@ -1,21 +1,24 @@
-import * as Static from "./static";
-export interface QueryOptions {
+import type * as Static from "./static";
+export interface QueryOptions<T = any> {
   base: string;
-  params?: any;
+  params?: T;
 }
 export interface ICharParams {
   characterName?: string;
   jobId?: string;
   jobGrowId?: string;
+  isAllJobGrow?: boolean;
   wordType?: Static.CharactersWordType;
   limit?: number;
 }
 
 export interface ITimeLine {
+  serverId?: Static.Server;
+  characterId?: string;
   startDate?: Date;
   endDate?: Date;
   limit?: number;
-  code?: string;
+  code?: string[];
   next?: string;
 }
 
@@ -25,6 +28,8 @@ export interface IAuction {
   itemId?: string;
   itemName?: string;
   wordType?: Static.AuctionWordType;
+  wordShort?: boolean;
+  q?: IAuctionQuery;
 }
 export interface IAuctionSort {
   unitPrice?: Static.Sort;
@@ -35,10 +40,13 @@ export interface IAuctionQuery {
   minLevel?: number;
   maxLevel?: number;
   raity?: Static.Rarity;
+  reinforceTypeId: Static.reinforceType;
   minReinforce?: number;
   maxReinforce?: number;
   minRefine?: number;
   maxRefine?: number;
+  minFame?: number;
+  maxFame?: number;
 }
 
 export interface IActionSoldOption {
@@ -52,6 +60,7 @@ export interface IActionSoldOption {
 export interface IItem {
   limit?: number;
   itemName?: string;
+  hashtag?: string[];
   wordType?: Static.AuctionWordType;
   q?: IItemQuery;
 }
@@ -59,7 +68,7 @@ export interface IItemQuery {
   minLevel?: number;
   maxLevel?: number;
   rarity?: Static.Rarity;
-  trade?: boolean;
+  // trade?: boolean;
 }
 
 export interface ISetItem {

package/src/util/query.ts

@@ -1,109 +1,103 @@
-import axios, { AxiosResponse } from "axios";
-import querystring from "querystring";
-// import urlencode from "urlencode";
-// import consola from "consola";
-const consola = require("consola");
-
-import * as Util from "./";
-import * as Model from "../model";
-
-const sender = axios.create({
-  baseURL: "https://api.neople.co.kr",
-  timeout: Util.Config.axiosTimeout,
-});
-const showUrl = (url: string): string => {
-  return url.replace(Util.Config.key, Util.Config.hidekeyText);
-};
-
-export default class Request {
-  public static UriBuilder(...args: any[]): string {
-    return args.join("/");
-  }
-  public static queryBuilder(query: any): string {
-    let qString: string[] = [];
-    for (let key in query) {
-      qString.push(`${key}:${query[key]},`);
-    }
-    return qString.join(",");
-  }
-
-  /**
-   *  던전앤파이터 API 서버에 응답을 요청하는 함수 입니다.
-   * 해당 함수를 직접 호출 하는것을 권장하지 않습니다.
-   *
-   * @param {object} opt (요청을 보낼 Parameter값)
-   * @returns
-   */
-  public static async Request<T>(opt: any = {}, method: string = "GET"): Promise<Model.DnfResponse<T>> {
-    if (!Util.Config.key || Util.Config.key == "") {
-      consola.error("Please change to your api key. ");
-    }
-
-    if (opt.params == undefined) opt.params = {};
-    if (opt.params.q) opt.params.q = this.queryBuilder(opt.params.q);
-
-    opt.params.apikey = Util.Config.key;
-    opt.url = `${opt.base}?${querystring.stringify(opt.params)}`;
-
-    if (Util.Config.showURL) console.log(showUrl(opt.url));
-
-    let responseData: Model.DnfResponse<T>;
-    switch (method.toLowerCase()) {
-      case "post":
-        responseData = await sender
-          .post(opt.url)
-          .then((res: any) => {
-            let data: T;
-            if (res.data.rows) data = res.data.rows;
-            else data = res.data;
-            return { data };
-          })
-          .catch((err: any) => {
-            if (err.response) {
-              let error: Model.DnfErrorResponse = {
-                url: showUrl(opt.url),
-                status: err.response.status || 0,
-                statusText: err.response.statusText,
-                code: err.response.data.error.code,
-                message: err.response.data.error.message,
-              };
-              return { error };
-            } else {
-              return { err: err };
-            }
-          });
-        break;
-      case "get":
-      default:
-        responseData = await sender
-          .get(opt.url)
-          .then((res: any) => {
-            let data: T;
-            if (res.data.rows) data = res.data.rows;
-            else data = res.data;
-            return { data };
-          })
-          .catch((err: any) => {
-            if (err.response) {
-              let error: Model.DnfErrorResponse = {
-                url: showUrl(opt.url),
-                status: err.response.status || 0,
-                statusText: err.response.statusText,
-                code: err.response.data.error.code,
-                message: err.response.data.error.message,
-              };
-              return { error };
-            } else {
-              return { err: err };
-            }
-          });
-        break;
-    }
-    return responseData;
-  }
-
-  public static makeItemQuery(query: any) {
-    //  return JSON.stringify(query).replace(/\"|\{|\}/gi, "");
-    return encodeURI(query);
-  }
-}
+import consola from "consola";
+import querystring from "query-string";
+import { Client, request } from "undici";
+
+import type * as Model from "../model";
+import * as Util from "./";
+
+const apiUrl = new URL("https://api.neople.co.kr");
+// const client = new Client("https://api.neople.co.kr", {
+//   connectTimeout: Util.Config.timeout,
+//   // allowH2: true,
+// });
+
+const sender = async <T>(path: string, method: "GET" | "POST", query: any) => {
+  // const res = await client.request<Model.DnfResponse<T>>({
+  // const res = await client.request<T>({
+  //   path,
+  //   method,
+  //   query,
+  // });
+  apiUrl.pathname = path;
+  apiUrl.search = querystring.stringify(query);
+
+  const res = await request<Model.DnfResponse<T>>(apiUrl.href, {
+    method,
+  });
+  return res;
+};
+const showUrl = (url: string): string => {
+  if (Util.Config.key) {
+    return url.replace(Util.Config.key, Util.Config.hideKeyText);
+  } else {
+    return url;
+  }
+};
+
+// biome-ignore lint/complexity/noStaticOnlyClass: <explanation>
+export default class Request {
+  public static UriBuilder(...args: any[]): string {
+    return args.join("/");
+  }
+  public static QueryBuilder(query: string[] | number[]): string {
+    const qString: string[] = [];
+    for (const key in query) {
+      qString.push(`${key}:${query[key]},`);
+    }
+    return qString.join(",");
+  }
+
+  /**
+   *  던전앤파이터 API 서버에 응답을 요청하는 함수 입니다.
+   * 해당 함수를 직접 호출 하는것을 권장하지 않습니다.
+   *
+   * @param {object} opt (요청을 보낼 Parameter값)
+   * @returns
+   */
+  public static async Request<T>(
+    opt: any = {},
+    method: "GET" | "POST" = "GET",
+  ): Promise<Model.DnfResponse<T>> {
+    if (!Util.Config.key || Util.Config.key === "") {
+      consola.error("Please change to your api key. ");
+    }
+
+    if (opt.params === undefined) opt.params = {};
+    if (opt.params.q) opt.params.q = Request.QueryBuilder(opt.params.q);
+
+    opt.params.apikey = Util.Config.key;
+
+    if (Util.Config.showURL)
+      consola.log(
+        "request url:",
+        showUrl(`${opt.base}?${querystring.stringify(opt.params)}`),
+      );
+
+    const res = await sender<Model.DnfResponse<T>>(
+      opt.base,
+      method,
+      opt.params,
+    );
+    if (res.statusCode !== 200) {
+      const resBody = (await res.body.json()) as Model.DnfResponse<T>;
+      const error: Model.DnfErrorResponse = {
+        url: showUrl(opt.url),
+        status: res.statusCode || 0,
+        statusText: "",
+        code: resBody.error?.code || "",
+        message: resBody.error?.message || "",
+      };
+      return { error };
+    } else {
+      const resBody = (await res.body.json()) as T;
+      return {
+        data: resBody,
+      };
+    }
+  }
+
+  public static makeItemQuery(query: any) {
+    //  return JSON.stringify(query).replace(/\"|\{|\}/gi, "");
+    return encodeURI(query);
+  }
+}