dnf-api 0.6.5 → 1.0.1

package/src/util/params.ts

@@ -1,81 +1,81 @@
-import type * as Static from "./static";
-export interface QueryOptions<T = any> {
-  base: string;
-  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[];
-  next?: string;
-}
-
-export interface IAuction {
-  limit?: number;
-  sort?: IAuctionSort;
-  itemId?: string;
-  itemName?: string;
-  wordType?: Static.AuctionWordType;
-  wordShort?: boolean;
-  q?: IAuctionQuery;
-}
-export interface IAuctionSort {
-  unitPrice?: Static.Sort;
-  reinforce?: Static.Sort;
-  auctionNo?: Static.Sort;
-}
-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 {
-  limit?: number;
-  wordType?: Static.AuctionWordType;
-  wordShort?: boolean;
-  itemId?: string;
-  itemName?: string;
-}
-
-export interface IItem {
-  limit?: number;
-  itemName?: string;
-  hashtag?: string[];
-  wordType?: Static.AuctionWordType;
-  q?: IItemQuery;
-}
-export interface IItemQuery {
-  minLevel?: number;
-  maxLevel?: number;
-  rarity?: Static.Rarity;
-  // trade?: boolean;
-}
-
-export interface ISetItem {
-  setItemName?: string;
-  limit?: number;
-  wordType?: Static.AuctionWordType;
-}
-export interface ISkill {
-  jobGrowId: string;
-}
+import type * as staticUtil from "./static";
+export interface QueryOptions<T = any> {
+  base: string;
+  params?: T;
+}
+export interface ICharParams {
+  characterName?: string;
+  jobId?: string;
+  jobGrowId?: string;
+  isAllJobGrow?: boolean;
+  wordType?: staticUtil.charactersWordType;
+  limit?: number;
+}
+
+export interface ITimeLine {
+  serverId?: staticUtil.server;
+  characterId?: string;
+  startDate?: Date;
+  endDate?: Date;
+  limit?: number;
+  code?: string[];
+  next?: string;
+}
+
+export interface IAuction {
+  limit?: number;
+  sort?: IAuctionSort;
+  itemId?: string;
+  itemName?: string;
+  wordType?: staticUtil.auctionWordType;
+  wordShort?: boolean;
+  q?: IAuctionQuery;
+}
+export interface IAuctionSort {
+  unitPrice?: staticUtil.sort;
+  reinforce?: staticUtil.sort;
+  auctionNo?: staticUtil.sort;
+}
+export interface IAuctionQuery {
+  minLevel?: number;
+  maxLevel?: number;
+  raity?: staticUtil.rarity;
+  reinforceTypeId: staticUtil.reinforceType;
+  minReinforce?: number;
+  maxReinforce?: number;
+  minRefine?: number;
+  maxRefine?: number;
+  minFame?: number;
+  maxFame?: number;
+}
+
+export interface IActionSoldOption {
+  limit?: number;
+  wordType?: staticUtil.auctionWordType;
+  wordShort?: boolean;
+  itemId?: string;
+  itemName?: string;
+}
+
+export interface IItem {
+  limit?: number;
+  itemName?: string;
+  hashtag?: string[];
+  wordType?: staticUtil.auctionWordType;
+  q?: IItemQuery;
+}
+export interface IItemQuery {
+  minLevel?: number;
+  maxLevel?: number;
+  rarity?: staticUtil.rarity;
+  // trade?: boolean;
+}
+
+export interface ISetItem {
+  setItemName?: string;
+  limit?: number;
+  wordType?: staticUtil.auctionWordType;
+}
+export interface ISkill {
+  jobGrowId: string;
+}

package/src/util/query.ts

@@ -1,103 +1,93 @@
-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);
-  }
-}
+import consola from "consola";
+import querystring from "query-string";
+import { 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) => {
+  apiUrl.pathname = path;
+  apiUrl.search = querystring.stringify(query);
+  const res = await request<model.IDnfResponse<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.IDnfResponse<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<T>(opt.base, method, opt.params);
+    if (res.statusCode !== 200) {
+      const resBody = (await res.body.json()) as model.IDnfResponse<T>;
+      const error: model.IDnfErrorResponse = {
+        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);
+  }
+}

package/src/util/static.ts

@@ -1,4 +1,4 @@
-export enum Server {
+export enum server {
   Cain = "cain",
   Diregie = "diregie",
   Siroco = "siroco",
@@ -8,11 +8,11 @@ export enum Server {
   Anton = "anton",
   Bakal = "bakal",
 }
-export enum Sort {
+export enum sort {
   Asc = "asc",
   Desc = "desc",
 }
-export enum Rarity {
+export enum rarity {
   Common = "커먼",
   Uncommon = "언커먼",
   Rare = "레어",
@@ -22,21 +22,21 @@ export enum Rarity {
   Legendary = "레전더리",
 }
 
-export enum AuctionWordType {
+export enum auctionWordType {
   Match = "match",
   Front = "front",
   Full = "full",
 }
-export enum WordType {
+export enum wordType {
   Match = "match",
   Front = "front",
   Full = "full",
 }
-export enum CharactersWordType {
+export enum charactersWordType {
   Match = "match",
   Full = "full",
 }
-export enum BaseUri {
+export enum baseUri {
   Servers = "df/servers",
   Auction = "df/auction",
   AuctionSold = "df/auction-sold",