dnf-api 1.1.0 → 2.0.0

package/src/api/setitems.ts

@@ -1,29 +1,29 @@
-import type * as Model from "../model";
-import { type params, query, staticUtil } from "../util";
-
-/**
- * 세트 아이템 정보를 세트의 이름으로 검색합니다.
- *
- * @param {string} setItemName 세트 아이템의 이름입니다.
- * @param {object} params 선택적 요청변수의 Object입니다.
- */
-export const setitem = (setItemName: string, params: params.ISetItem = {}) => {
-  params.setItemName = setItemName;
-  const opt = {
-    base: query.UriBuilder(staticUtil.baseUri.SetItem),
-    params: params,
-  };
-  return query.Request<Model.setItem.ISetItem[]>(opt);
-};
-
-/**
- * 세트 ID로 세트 아이템 정보를 받아옵니다.
- *
- * @param {string} setItemId 세트 아이템의 ID입니다.
- */
-export const detail = (setItemId: string) => {
-  const opt = {
-    base: query.UriBuilder(staticUtil.baseUri.SetItem, setItemId),
-  };
-  return query.Request<Model.setItem.IDetail>(opt);
-};
+import type * as Model from "../model";
+import { type params, query, staticUtil } from "../util";
+
+/**
+ * 세트 아이템 정보를 세트의 이름으로 검색합니다.
+ *
+ * @param {string} setItemName 세트 아이템의 이름입니다.
+ * @param {object} params 선택적 요청변수의 Object입니다.
+ */
+export const setitem = (setItemName: string, params: params.ISetItem = {}) => {
+  params.setItemName = setItemName;
+  const opt = {
+    base: query.UriBuilder(staticUtil.BaseUri.SetItem),
+    params: params,
+  };
+  return query.Request<Model.setItem.ISetItem[]>(opt);
+};
+
+/**
+ * 세트 ID로 세트 아이템 정보를 받아옵니다.
+ *
+ * @param {string} setItemId 세트 아이템의 ID입니다.
+ */
+export const detail = (setItemId: string) => {
+  const opt = {
+    base: query.UriBuilder(staticUtil.BaseUri.SetItem, setItemId),
+  };
+  return query.Request<Model.setItem.IDetail>(opt);
+};

package/src/index.ts

@@ -1,35 +1,28 @@
-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 staticUtil from "./util/static";
-
-const serverNames = staticUtil.server;
-const rarityNames = staticUtil.rarity;
-
-const dnf = {
-  api: request,
-  request,
-  config,
-  staticUtil,
-  serverNames,
-  rarityNames,
-  query,
-  params,
-  model,
-};
-
-export {
-  request as api,
-  request,
-  config,
-  staticUtil,
-  serverNames,
-  rarityNames,
-  query,
-  params,
-  model,
-};
-export default dnf;
+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 staticUtil from "./util/static";
+
+export default class DnfApi {
+  util = util;
+  request = request;
+}
+
+const ServerNames = staticUtil.Server;
+const RarityNames = staticUtil.Rarity;
+
+export {
+  request as api,
+  request,
+  config,
+  staticUtil,
+  ServerNames,
+  RarityNames,
+  query,
+  params,
+  model,
+};

package/src/model/auction.ts

@@ -0,0 +1,48 @@
+/** 경매장 아이템 인터페이스 */
+export interface IAuction {
+  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 interface IAuctionSolid {
+  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;
+}

package/src/model/avatar-market.ts

@@ -0,0 +1,70 @@
+/** 아바타 마켓 상품 검색 결과 인터페이스 */
+export interface ISale {
+  goodsNo: number;
+  sellerId: string;
+  sellerName: string;
+  title: string;
+  price: number;
+  registDate: string;
+  hashtag: string[];
+  avatarCount: number;
+}
+
+/** 아바타 마켓 상품 상세 인터페이스 */
+export interface ISaleDetail extends ISale {
+  avatar: IAvatarItem[];
+}
+
+/** 아바타 아이템 인터페이스 */
+export interface IAvatarItem {
+  slotId: string;
+  slotName: string;
+  itemId: string;
+  itemName: string;
+  itemRarity: string;
+  clone: ICloneAvatar;
+  optionAbility: string | null;
+  emblems: IEmblem[];
+}
+
+/** 클론 아바타 인터페이스 */
+export interface ICloneAvatar {
+  itemId: string | null;
+  itemName: string | null;
+}
+
+/** 엠블렘 인터페이스 */
+export interface IEmblem {
+  slotNo: number;
+  slotColor: string;
+  itemName: string;
+  itemRarity: string;
+}
+
+/** 아바타 마켓 시세 검색 결과 인터페이스 */
+export interface ISold {
+  goodsNo: number;
+  sellerId: string;
+  sellerName: string;
+  title: string;
+  price: number;
+  soldDate: string;
+  hashtag: string[];
+  avatarCount: number;
+}
+
+/** 아바타 마켓 시세 상세 인터페이스 */
+export interface ISoldDetail extends ISold {
+  avatar: IAvatarItem[];
+}
+
+/** 해시태그 조회 결과 인터페이스 */
+export interface IHashtag {
+  hashtag: IHashtagItem[];
+}
+
+/** 해시태그 아이템 인터페이스 */
+export interface IHashtagItem {
+  hashtagType: string;
+  name: string;
+}

package/src/model/character.ts

@@ -1,98 +1,134 @@
-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[];
-}
+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[];
+}
+
+/** 캐릭터 명성 검색 결과 인터페이스 */
+export interface ICharacterFame {
+  serverId: staticUtil.Server;
+  characterId: string;
+  characterName: string;
+  level: number;
+  jobId: string;
+  jobGrowId: string;
+  jobName: string;
+  jobGrowName: string;
+  fame: number;
+}
+
+/** 안개 융화 정보 인터페이스 */
+export interface IMistAssimilation {
+  serverId: staticUtil.Server;
+  characterId: string;
+  characterName: string;
+  level: number;
+  jobId: string;
+  jobGrowId: string;
+  jobName: string;
+  jobGrowName: string;
+  mistAssimilation: {
+    level: number;
+    expRate: number;
+    status: IMistStatus[];
+  };
+}
+
+/** 안개 융화 상태 인터페이스 */
+export interface IMistStatus {
+  name: string;
+  value: number;
+}

package/src/model/index.ts

@@ -1,95 +1,49 @@
-import * as char from "./character";
-import * as item from "./item";
-import * as setItem from "./setitem";
-
-export { char, item, setItem };
-
-/** 에러 응답 인터페이스 */
-export interface IDnfErrorResponse {
-  url: string;
-  status: number;
-  statusText: string;
-  code: string;
-  message: string;
-}
-
-/** 성공 응답 인터페이스 */
-export interface IDnfSuccess<T> {
-  data: T;
-  error?: never;
-}
-
-/** 에러 정보 인터페이스 */
-export interface IDnfError {
-  data?: never;
-  error: IDnfErrorResponse;
-}
-
-/** 응답 타입(합성 타입) */
-export type IDnfResponse<T> = IDnfSuccess<T> | IDnfError;
-
-/** 경매장 아이템 인터페이스 */
-export interface IAuction {
-  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 interface IAuctionSolid {
-  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 interface IRows<T> {
-  rows: T[];
-}
-
-/** 서버 정보 인터페이스 */
-export interface IServer {
-  serverId: string;
-  serverName: string;
-}
-
-/** 이름-값 쌍 인터페이스 */
-export interface INameValue {
-  name: string;
-  value: string | number;
-}
+import * as auction from "./auction";
+import * as avatarMarket from "./avatar-market";
+import * as char from "./character";
+import * as item from "./item";
+import * as job from "./job";
+import * as setItem from "./setitem";
+
+export { char, item, setItem, auction, avatarMarket, job };
+
+/** 에러 응답 인터페이스 */
+export interface IDnfErrorResponse {
+  url: string;
+  status: number;
+  statusText: string;
+  code: string;
+  message: string;
+}
+
+/** 성공 응답 인터페이스 */
+export interface IDnfSuccess<T> {
+  data: T;
+  error?: never;
+}
+
+/** 에러 정보 인터페이스 */
+export interface IDnfError {
+  data?: never;
+  error: IDnfErrorResponse;
+}
+
+/** 응답 타입(합성 타입) */
+export type IDnfResponse<T> = IDnfSuccess<T> | IDnfError;
+
+/** 행 배열 인터페이스 */
+export interface IRows<T> {
+  rows: T[];
+}
+
+/** 서버 정보 인터페이스 */
+export interface IServer {
+  serverId: string;
+  serverName: string;
+}
+
+/** 이름-값 쌍 인터페이스 */
+export interface INameValue {
+  name: string;
+  value: string | number;
+}