dnf-api 0.5.21 → 0.6.0

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[];
+};

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 };