dnf-api 0.6.5 → 1.0.0

package/src/index.ts

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

package/src/model/character.ts

@@ -1,8 +1,9 @@
-import type { Static } from "../util";
-import type { NameValue } from "./";
+import type { staticUtil } from "../util";
+import type { INameValue } from "./";
 
-export type Character = {
-  serverId: Static.Server;
+/** 캐릭터 정보 인터페이스 */
+export interface ICharacter {
+  serverId: staticUtil.server;
   characterId: string;
   characterName: string;
   level: number;
@@ -11,10 +12,11 @@ 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;
@@ -26,10 +28,11 @@ 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;
@@ -46,29 +49,32 @@ 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;
-};
+  data: ITimeLineRowData;
+}
 
-export type TimeLineRowData = {
+/** 타임라인 행 데이터 인터페이스 */
+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;
@@ -80,12 +86,13 @@ export type CharacterStatus = {
   adventureName: string;
   guildId: string | null;
   guildName: string | null;
-  buff: Buff[];
-  status: NameValue[];
-};
+  buff: IBuff[];
+  status: INameValue[];
+}
 
-export type Buff = {
+/** 버프 정보 인터페이스 */
+export interface IBuff {
   name: string;
   level?: number;
-  status: NameValue[];
-};
+  status: INameValue[];
+}

package/src/model/index.ts

@@ -1,30 +1,35 @@
-import * as Char from "./character";
-import * as Item from "./item";
-import * as SetItem from "./setitem";
+import * as char from "./character";
+import * as item from "./item";
+import * as setItem from "./setitem";
 
-export { Char, Item, SetItem };
+export { char, item, setItem };
 
-export type DnfErrorResponse = {
+/** 에러 응답 인터페이스 */
+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;
-};
+  error: IDnfErrorResponse;
+}
 
-export type DnfResponse<T> = DnfSuccess<T> | DnfError;
+/** 응답 타입(합성 타입) */
+export type IDnfResponse<T> = IDnfSuccess<T> | IDnfError;
 
-export type Auction = {
+/** 경매장 아이템 인터페이스 */
+export interface IAuction {
   auctionNo: number;
   regDate: Date;
   expireDate: Date;
@@ -48,9 +53,10 @@ export type Auction = {
   averagePrice: number;
   upgrade?: number;
   upgradeMax?: number;
-};
+}
 
-export type AuctionSolid = {
+/** 판매 완료 아이템 인터페이스 */
+export interface IAuctionSolid {
   soldDate: string;
   itemId: string;
   itemName: string;
@@ -69,18 +75,21 @@ 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/src/model/item.ts

@@ -1,23 +1,26 @@
 import type * as Static from "../util/static";
-import type { NameValue } from "./";
+import type { INameValue } from "./";
 
 export 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 IDetail = IMaterialDetail | IEquipDetail;
 
-export type MaterialDetail = {
+/** 재료 아이템 상세 인터페이스 */
+export interface IMaterialDetail {
   kind: ItemDetailKind.Material;
   itemId: string;
   itemName: string;
@@ -33,10 +36,11 @@ export type MaterialDetail = {
   fame: number;
   setItemId: string | null;
   setItemName: string | null;
-  obtainInfo: ObtainInfo;
-};
+  obtainInfo: IObtainInfo;
+}
 
-export type EquipDetail = {
+/** 장비 아이템 상세 인터페이스 */
+export interface IEquipDetail {
   kind: ItemDetailKind.Equip;
   itemId: string;
   itemName: string;
@@ -52,53 +56,62 @@ 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;
-};
+  obtainInfo: IObtainInfoDetail;
+}
 
-export type Tune = {
+/** 튠 정보 인터페이스 */
+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[];
-};
+  shop: IShopInfo[];
+}
 
-export type ObtainInfoDetail = {
-  dungeon: Dungeon[];
-  shop: ShopDetail[];
-};
+/** 획득 상세 정보 인터페이스 */
+export interface IObtainInfoDetail {
+  dungeon: IDungeon[];
+  shop: IShopDetail[];
+}
 
-export type Dungeon = {
+/** 던전 정보 인터페이스 */
+export interface IDungeon {
   type: string;
-  rows: DungeonRow[];
-};
+  rows: IDungeonRow[];
+}
 
-export type DungeonRow = {
+/** 던전 행 인터페이스 */
+export interface IDungeonRow {
   name: string;
-};
+}
 
-export type ShopInfo = {
+/** 상점 정보 인터페이스 */
+export interface IShopInfo {
   type: string;
-};
+}
 
-export type ShopDetail = {
-  rows: ShopRow[];
-};
+/** 상점 상세 정보 인터페이스 */
+export interface IShopDetail {
+  rows: IShopRow[];
+}
 
-export type ShopRow = {
+/** 상점 행 인터페이스 */
+export interface IShopRow {
   name: string;
   details: string[];
-};
+}

package/src/model/setitem.ts

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

package/src/util/index.ts

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

package/src/util/params.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,12 +8,12 @@ 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;
@@ -27,20 +27,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;
@@ -51,7 +51,7 @@ export interface IAuctionQuery {
 
 export interface IActionSoldOption {
   limit?: number;
-  wordType?: Static.AuctionWordType;
+  wordType?: staticUtil.auctionWordType;
   wordShort?: boolean;
   itemId?: string;
   itemName?: string;
@@ -61,20 +61,20 @@ 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;
   // trade?: boolean;
 }
 
 export interface ISetItem {
   setItemName?: string;
   limit?: number;
-  wordType?: Static.AuctionWordType;
+  wordType?: staticUtil.auctionWordType;
 }
 export interface ISkill {
   jobGrowId: string;

package/src/util/query.ts

@@ -1,8 +1,8 @@
 import consola from "consola";
 import querystring from "query-string";
-import { Client, request } from "undici";
+import { request } from "undici";
 
-import type * as Model from "../model";
+import type * as model from "../model";
 import * as Util from "./";
 
 const apiUrl = new URL("https://api.neople.co.kr");
@@ -12,7 +12,7 @@ const apiUrl = new URL("https://api.neople.co.kr");
 // });
 
 const sender = async <T>(path: string, method: "GET" | "POST", query: any) => {
-  // const res = await client.request<Model.DnfResponse<T>>({
+  // const res = await client.request<model.DnfResponse<T>>({
   // const res = await client.request<T>({
   //   path,
   //   method,
@@ -21,14 +21,14 @@ const sender = async <T>(path: string, method: "GET" | "POST", query: any) => {
   apiUrl.pathname = path;
   apiUrl.search = querystring.stringify(query);
 
-  const res = await request<Model.DnfResponse<T>>(apiUrl.href, {
+  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);
+  if (Util.config.key) {
+    return url?.replace(Util.config.key, Util.config.hideKeyText);
   } else {
     return url;
   }
@@ -56,31 +56,31 @@ export default class Request {
    */
   public static async Request<T>(
     opt: any = {},
-    method: "GET" | "POST" = "GET",
-  ): Promise<Model.DnfResponse<T>> {
-    if (!Util.Config.key || Util.Config.key === "") {
+    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;
+    opt.params.apikey = Util.config.key;
 
-    if (Util.Config.showURL)
+    if (Util.config.showURL)
       consola.log(
         "request url:",
-        showUrl(`${opt.base}?${querystring.stringify(opt.params)}`),
+        showUrl(`${opt.base}?${querystring.stringify(opt.params)}`)
       );
 
-    const res = await sender<Model.DnfResponse<T>>(
+    const res = await sender<model.IDnfResponse<T>>(
       opt.base,
       method,
-      opt.params,
+      opt.params
     );
     if (res.statusCode !== 200) {
-      const resBody = (await res.body.json()) as Model.DnfResponse<T>;
-      const error: Model.DnfErrorResponse = {
+      const resBody = (await res.body.json()) as model.IDnfResponse<T>;
+      const error: model.IDnfErrorResponse = {
         url: showUrl(opt.url ?? ""),
         status: res.statusCode || 0,
         statusText: "",

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",