dnf-api 0.6.5 → 1.0.1

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,91 +1,98 @@
-import type { Static } from "../util";
-import type { NameValue } from "./";
-
-export type Character = {
-  serverId: Static.Server;
-  characterId: string;
-  characterName: string;
-  level: number;
-  jobId: string;
-  jobGrowId: string;
-  jobName: string;
-  jobGrowName: string;
-  fame: number;
-};
-
-export type Info = {
-  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;
-};
-
-export type Timeline = {
-  serverId: Static.Server;
-  characterId: string;
-  characterName: string;
-  level: number;
-  jobId: string;
-  jobGrowId: string;
-  jobName: string;
-  jobGrowName: string;
-  adventureName: string;
-  guildId: string;
-  guildName: string;
-  timeline: {
-    date: {
-      start: Date;
-      end: Date;
-    };
-    next: string;
-    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[];
-};
+import type { staticUtil } from "../util";
+import type { INameValue } from "./";
+
+/** 캐릭터 정보 인터페이스 */
+export interface ICharacter {
+  serverId: staticUtil.server;
+  characterId: string;
+  characterName: string;
+  level: number;
+  jobId: string;
+  jobGrowId: string;
+  jobName: string;
+  jobGrowName: string;
+  fame: number;
+}
+
+/** 캐릭터 상세 정보 인터페이스 */
+export interface IInfo {
+  serverId: staticUtil.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;
+}
+
+/** 캐릭터 타임라인 인터페이스 */
+export interface ITimeline {
+  serverId: staticUtil.server;
+  characterId: string;
+  characterName: string;
+  level: number;
+  jobId: string;
+  jobGrowId: string;
+  jobName: string;
+  jobGrowName: string;
+  adventureName: string;
+  guildId: string;
+  guildName: string;
+  timeline: {
+    date: {
+      start: Date;
+      end: Date;
+    };
+    next: string;
+    rows: ITimeLineRow[];
+  };
+}
+
+/** 타임라인 행 인터페이스 */
+export interface ITimeLineRow {
+  code: number;
+  name: string;
+  date: string;
+  data: ITimeLineRowData;
+}
+
+/** 타임라인 행 데이터 인터페이스 */
+export interface ITimeLineRowData {
+  itemId: string;
+  itemName: string;
+  itemRarity: staticUtil.rarity;
+  channelName: string;
+  channelNo: number;
+  dungeonName: string;
+  mistGear: boolean;
+}
+
+/** 캐릭터 상태 인터페이스 */
+export interface ICharacterStatus {
+  serverId: staticUtil.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: IBuff[];
+  status: INameValue[];
+}
+
+/** 버프 정보 인터페이스 */
+export interface IBuff {
+  name: string;
+  level?: number;
+  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,104 +1,117 @@
-import type * as Static from "../util/static";
-import type { NameValue } from "./";
-
-export enum ItemDetailKind {
-  Material = "material",
-  Equip = "equip",
-}
-
-export type Item = {
-  itemId: string;
-  itemName: string;
-  itemRarity: Static.Rarity;
-  itemType: string;
-  itemTypeDetail: string;
-  itemAvailableLevel: number;
-};
-
-export type Detail = MaterialDetail | EquipDetail;
-
-export type MaterialDetail = {
-  kind: ItemDetailKind.Material;
-  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;
-  obtainInfo: ObtainInfo;
-};
-
-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 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 ShopInfo = {
-  type: string;
-};
-
-export type ShopDetail = {
-  rows: ShopRow[];
-};
-
-export type ShopRow = {
-  name: string;
-  details: string[];
-};
+import type * as Static from "../util/static";
+import type { INameValue } from "./";
+
+export enum ItemDetailKind {
+  Material = "material",
+  Equip = "equip",
+}
+
+/** 아이템 인터페이스 */
+export interface IItem {
+  itemId: string;
+  itemName: string;
+  itemRarity: Static.rarity;
+  itemType: string;
+  itemTypeDetail: string;
+  itemAvailableLevel: number;
+}
+
+/** 아이템 상세 인터페이스(합성 타입) */
+export type IDetail = IMaterialDetail | IEquipDetail;
+
+/** 재료 아이템 상세 인터페이스 */
+export interface IMaterialDetail {
+  kind: ItemDetailKind.Material;
+  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;
+  obtainInfo: IObtainInfo;
+}
+
+/** 장비 아이템 상세 인터페이스 */
+export interface IEquipDetail {
+  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: INameValue[];
+  tune: ITune;
+  itemBuff: IItemBuff;
+  hashtag: string[];
+  obtainInfo: IObtainInfoDetail;
+}
+
+/** 튠 정보 인터페이스 */
+export interface ITune {
+  level: number;
+  setPoint: number;
+}
+
+/** 아이템 버프 인터페이스 */
+export interface IItemBuff {
+  explain: string;
+  explainDetail: string;
+  reinforceSkill: any[];
+  status: any | null;
+}
+
+/** 획득 정보 인터페이스 */
+export interface IObtainInfo {
+  dungeon: string | null;
+  shop: IShopInfo[];
+}
+
+/** 획득 상세 정보 인터페이스 */
+export interface IObtainInfoDetail {
+  dungeon: IDungeon[];
+  shop: IShopDetail[];
+}
+
+/** 던전 정보 인터페이스 */
+export interface IDungeon {
+  type: string;
+  rows: IDungeonRow[];
+}
+
+/** 던전 행 인터페이스 */
+export interface IDungeonRow {
+  name: string;
+}
+
+/** 상점 정보 인터페이스 */
+export interface IShopInfo {
+  type: string;
+}
+
+/** 상점 상세 정보 인터페이스 */
+export interface IShopDetail {
+  rows: IShopRow[];
+}
+
+/** 상점 행 인터페이스 */
+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 };