dnf-api 0.5.22 → 0.6.0

package/jest.config.js

@@ -1,12 +1,12 @@
-module.exports = {
-  transform: {
-    "^.+\\.ts$": "ts-jest",
-  },
-  testRegex: "\\.test\\.ts$",
-  moduleFileExtensions: ["ts", "js"],
-  globals: {
-    "ts-jest": {
-      enableTsDiagnostics: true,
-    },
-  },
-};
+module.exports = {
+  transform: {
+    "^.+\\.ts$": "ts-jest",
+  },
+  testRegex: "\\.test\\.ts$",
+  moduleFileExtensions: ["ts", "js"],
+  globals: {
+    "ts-jest": {
+      enableTsDiagnostics: true,
+    },
+  },
+};

package/package.json

@@ -1,41 +1,37 @@
-{
-  "name": "dnf-api",
-  "version": "0.5.22",
-  "description": "던전 앤 파이터 API",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "dependencies": {
-    "@types/jest": "^24.0.15",
-    "@types/node": "^12.0.12",
-    "axios": "^0.18.0",
-    "consola": "^2.9.0",
-    "querystring": "^0.2.0",
-    "urlencode": "^1.1.0"
-  },
-  "devDependencies": {
-    "nodemon": "^1.18.4",
-    "ts-jest": "^24.0.2",
-    "ts-loader": "^6.0.4",
-    "ts-node": "^9.0.0",
-    "typescript": "^3.5.3"
-  },
-  "scripts": {
-    "serve": "nodemon --exec yar./src/index.ts",
-    "build": "tsc",
-    "test:dev": "nodemon --exec ts-node ./test.ts",
-    "test": "jest"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/k22pr/dnf-api.git"
-  },
-  "keywords": [
-    "dnf"
-  ],
-  "author": "서버지기",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/k22pr/dnf-api/issues"
-  },
-  "homepage": "https://github.com/k22pr/dnf-api#readme"
-}
+{
+  "name": "dnf-api",
+  "version": "0.6.0",
+  "description": "던전 앤 파이터 API",
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "dependencies": {
+    "@types/bun": "1.1.6",
+    "axios": "^0.18.1",
+    "consola": "^2.15.3",
+    "prototype-helper": "^0.4.2",
+    "query-string": "^9.1.1",
+    "undici": "^7.3.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "dotenv": "^16.4.7",
+    "typescript": "5.5.3"
+  },
+  "scripts": {
+    "dev": "bun --watch src/index.ts",
+    "build": "bun build src/index.ts --minify --target=bun --outfile dist/index.js",
+    "test:dev": "bun --watch test.ts",
+    "test": "jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/k22pr/dnf-api.git"
+  },
+  "keywords": ["dnf"],
+  "author": "서버지기",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/k22pr/dnf-api/issues"
+  },
+  "homepage": "https://github.com/k22pr/dnf-api#readme"
+}

package/src/api/auction.ts

@@ -1,61 +1,67 @@
-import { Query, Static, Params } from "../util";
-import * as Model from "../model";
-
-/**
- * 경매장에 등록된 아이템을 "아이템 이름"을 기준으로 받아옵니다
- *
- * @param {string} itemName 검색할 아이템의 이름입니다.
- * @param {object} params 선택적 요청변수의 Object입니다.
- */
-export const itemName = (itemName: string, params: Params.IAuction = {}): Promise<Model.DnfResponse<Model.Auction[]>> => {
-  params.itemName = itemName;
-  let opt = {
-    base: Query.UriBuilder(Static.BaseUri.Auction),
-    params,
-  };
-  return Query.Request<Model.Auction[]>(opt);
-};
-
-/**
- * 경매장에 등록된 아이템을 "아이템 아이디"을 기준으로 받아옵니다
- *
- * @param {string} itemID 검색할 아이템의 ID입니다.
- * @param {object} params 선택적 요청변수의 Object입니다.
- */
-export const itemId = (itemId: string, params: Params.IAuction = {}): Promise<Model.DnfResponse<Model.Auction[]>> => {
-  params.itemId = itemId;
-  let opt = {
-    base: Query.UriBuilder(Static.BaseUri.Auction),
-    params: params,
-  };
-  return Query.Request<Model.Auction[]>(opt);
-};
-/**
- * 경매장에 등록된 경매장번호로 받아옵니다.
- *
- * @param {Number} auctionNo 검색할 경매장 번호입니다.
- */
-export const no = (auctionNo: number): Promise<Model.DnfResponse<Model.Auction>> => {
-  let opt = {
-    base: Query.UriBuilder(Static.BaseUri.Auction, auctionNo),
-  };
-  return Query.Request<Model.Auction>(opt);
-};
-
-export const auctionSoldName = (itemName: string, params: Params.IActionSoldOption = {}) => {
-  params.itemName = itemName;
-  let opt = {
-    base: Query.UriBuilder(Static.BaseUri.AuctionSold),
-    params,
-  };
-  return Query.Request<Model.AuctionSolid[]>(opt);
-};
-
-export const auctionSoldId = (itemId: string, params: Params.IActionSoldOption = {}) => {
-  params.itemId = itemId;
-  let opt = {
-    base: Query.UriBuilder(Static.BaseUri.AuctionSold),
-    params,
-  };
-  return Query.Request<Model.AuctionSolid[]>(opt);
-};
+import type * as Model from "../model";
+import { type Params, Query, Static } from "../util";
+
+/**
+ * 경매장에 등록된 아이템을 "아이템 이름"을 기준으로 받아옵니다
+ *
+ * @param {string} itemName 검색할 아이템의 이름입니다.
+ * @param {object} params 선택적 요청변수의 Object입니다.
+ */
+export const itemName = (itemName: string, params: Params.IAuction = {}) => {
+  params.itemName = itemName;
+  const opt = {
+    base: Query.UriBuilder(Static.BaseUri.Auction),
+    params,
+  };
+  return Query.Request<Model.Rows<Model.Auction>>(opt);
+};
+
+/**
+ * 경매장에 등록된 아이템을 "아이템 아이디"을 기준으로 받아옵니다
+ *
+ * @param {string} itemID 검색할 아이템의 ID입니다.
+ * @param {object} params 선택적 요청변수의 Object입니다.
+ */
+export const itemId = (itemId: string, params: Params.IAuction = {}) => {
+  params.itemId = itemId;
+  const opt = {
+    base: Query.UriBuilder(Static.BaseUri.Auction),
+    params: params,
+  };
+  return Query.Request<Model.Rows<Model.Auction>>(opt);
+};
+/**
+ * 경매장에 등록된 경매장번호로 받아옵니다.
+ *
+ * @param {Number} auctionNo 검색할 경매장 번호입니다.
+ */
+export const no = (auctionNo: number) => {
+  const opt = {
+    base: Query.UriBuilder(Static.BaseUri.Auction, auctionNo),
+  };
+  return Query.Request<Model.Auction>(opt);
+};
+
+export const auctionSoldName = (
+  itemName: string,
+  params: Params.IActionSoldOption = {},
+) => {
+  params.itemName = itemName;
+  const opt = {
+    base: Query.UriBuilder(Static.BaseUri.AuctionSold),
+    params,
+  };
+  return Query.Request<Model.Rows<Model.AuctionSolid>>(opt);
+};
+
+export const auctionSoldId = (
+  itemId: string,
+  params: Params.IActionSoldOption = {},
+) => {
+  params.itemId = itemId;
+  const opt = {
+    base: Query.UriBuilder(Static.BaseUri.AuctionSold),
+    params,
+  };
+  return Query.Request<Model.Rows<Model.AuctionSolid>>(opt);
+};

package/src/api/characters.equip.ts

@@ -1,53 +1,81 @@
-import { Query, Static } from "../util";
-
-/**
- * 해당 캐릭터가 장착한 장비 정보를 받아옵니다.
- *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export const equipment = (serverId: Static.Server, characterId: string) => {
-  let opt = {
-    base: Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "equip", "equipment"),
-  };
-  return Query.Request(opt);
-};
-
-/**
- * 해당 캐릭터가 장착한 아바타 정보를 받아옵니다.
- *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export const avatar = (serverId: Static.Server, characterId: string) => {
-  let opt = {
-    base: Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "equip", "avatar"),
-  };
-  return Query.Request(opt);
-};
-
-/**
- * 해당 캐릭터가 장착한 크리쳐 정보를 받아옵니다.
- *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export const creature = (serverId: Static.Server, characterId: string) => {
-  let opt = {
-    base: Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "equip", "creature"),
-  };
-  return Query.Request(opt);
-};
-
-/**
- * 해당 캐릭터가 장착한 휘장 정보를 받아옵니다.
- *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export const flag = (serverId: Static.Server, characterId: string) => {
-  let opt = {
-    base: Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "equip", "flag"),
-  };
-  return Query.Request(opt);
-};
+import { Query, Static } from "../util";
+
+/**
+ * 해당 캐릭터가 장착한 장비 정보를 받아옵니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export const equipment = (serverId: Static.Server, characterId: string) => {
+  const opt = {
+    base: Query.UriBuilder(
+      Static.BaseUri.Servers,
+      serverId,
+      "characters",
+      characterId,
+      "equip",
+      "equipment",
+    ),
+  };
+  return Query.Request(opt);
+};
+
+/**
+ * 해당 캐릭터가 장착한 아바타 정보를 받아옵니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export const avatar = (serverId: Static.Server, characterId: string) => {
+  const opt = {
+    base: Query.UriBuilder(
+      Static.BaseUri.Servers,
+      serverId,
+      "characters",
+      characterId,
+      "equip",
+      "avatar",
+    ),
+  };
+  return Query.Request(opt);
+};
+
+/**
+ * 해당 캐릭터가 장착한 크리쳐 정보를 받아옵니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export const creature = (serverId: Static.Server, characterId: string) => {
+  const opt = {
+    base: Query.UriBuilder(
+      Static.BaseUri.Servers,
+      serverId,
+      "characters",
+      characterId,
+      "equip",
+      "creature",
+    ),
+  };
+  return Query.Request(opt);
+};
+
+/**
+ * 해당 캐릭터가 장착한 휘장 정보를 받아옵니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export const flag = (serverId: Static.Server, characterId: string) => {
+  const opt = {
+    base: Query.UriBuilder(
+      Static.BaseUri.Servers,
+      serverId,
+      "characters",
+      characterId,
+      "equip",
+      "flag",
+    ),
+  };
+  return Query.Request(opt);
+};

package/src/api/characters.skill.ts

@@ -1,52 +1,52 @@
-import { Query, Static } from "../util";
-/**
- *  아이템 및 장비를 통한 스킬 강화 제외 입니다.
- *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export const style = (serverId: Static.Server, characterId: string) => {
-   let opt = {
-      base: `${Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "skill", "style")}`,
-   };
-   return Query.Request(opt);
-};
-
-/**
- * 캐릭터 '버프 스킬 강화 장착 장비'(스위칭) 를 조회합니다.
- *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export const equipment = (serverId: Static.Server, characterId: string) => {
-   let opt = {
-      base: `${Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "skill", "buff", "equip", "equipment")}`,
-   };
-   return Query.Request(opt);
-};
-
-/**
- * 캐릭터 '버프 스킬 강화 장착 아바타'(스위칭) 를 조회합니다.
- *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export const avatar = (serverId: Static.Server, characterId: string) => {
-   let opt = {
-      base: `${Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "skill", "buff", "equip", "avatar")}`,
-   };
-   return Query.Request(opt);
-};
-
-/**
- * 캐릭터 '버프 스킬 강화 장착 크리쳐'(스위칭) 를 조회합니다.
- *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export const creature = (serverId: Static.Server, characterId: string) => {
-   let opt = {
-      base: `${Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "skill", "buff", "equip", "creature")}`,
-   };
-   return Query.Request(opt);
-};
+import { Query, Static } from "../util";
+/**
+ *  아이템 및 장비를 통한 스킬 강화 제외 입니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export const style = (serverId: Static.Server, characterId: string) => {
+  const opt = {
+    base: `${Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "skill", "style")}`,
+  };
+  return Query.Request(opt);
+};
+
+/**
+ * 캐릭터 '버프 스킬 강화 장착 장비'(스위칭) 를 조회합니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export const equipment = (serverId: Static.Server, characterId: string) => {
+  const opt = {
+    base: `${Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "skill", "buff", "equip", "equipment")}`,
+  };
+  return Query.Request(opt);
+};
+
+/**
+ * 캐릭터 '버프 스킬 강화 장착 아바타'(스위칭) 를 조회합니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export const avatar = (serverId: Static.Server, characterId: string) => {
+  const opt = {
+    base: `${Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "skill", "buff", "equip", "avatar")}`,
+  };
+  return Query.Request(opt);
+};
+
+/**
+ * 캐릭터 '버프 스킬 강화 장착 크리쳐'(스위칭) 를 조회합니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export const creature = (serverId: Static.Server, characterId: string) => {
+  const opt = {
+    base: `${Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "skill", "buff", "equip", "creature")}`,
+  };
+  return Query.Request(opt);
+};

package/src/api/characters.ts

@@ -1,60 +1,91 @@
-import { Query, Static, Params } from "../util";
-import * as Model from "../model";
-
-/**
- * 서버 이름과 캐릭터 닉네임을 입력하여 해당 캐릭터를 검색합니다.
- *
- * @param {Static.Server} [serverId=""] 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} [characterName=""] 검색할 캐릭터의 이름입니다.
- * @param {object} [params={}] 선택적 요청변수의 Object입니다.
- */
-export const characterName = (serverId: Static.Server, characterName: string, params: Params.ICharParams = {}): Promise<Model.DnfResponse<Model.Char.Character[]>> => {
-  if (params === undefined) params = {};
-  params.characterName = characterName;
-  let opt = {
-    base: Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters"),
-    params: params,
-  };
-  return Query.Request<Model.Char.Character[]>(opt);
-};
-
-/**
- * 캐릭터 ID를 입력하여 해당 캐릭터 정보를 받아옵니다
- *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export const characterId = (serverId: Static.Server, characterId: string): Promise<Model.DnfResponse<Model.Char.Info>> => {
-  let opt = {
-    base: Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId),
-  };
-  return Query.Request<Model.Char.Info>(opt);
-};
-
-/**
- * 캐릭터 ID를 입력하여 해당 캐릭터의 타임라인 정보를 검색합니다.
- *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- * @param {object} params 선택적 요청변수의 Object입니다.
- */
-export const timeline = (serverId: Static.Server, characterId: string, params: Params.ICharParams = {}): Promise<Model.DnfResponse<Model.Char.Timeline>> => {
-  let opt = {
-    base: Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "timeline"),
-    params: params,
-  };
-  return Query.Request<Model.Char.Timeline>(opt);
-};
-
-/**
- * 캐릭터 ID를 입력하여 해당 캐릭터의 능력치 정보를 검색합니다.
- *
- * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export const status = (serverId: Static.Server, characterId: string) => {
-  let opt = {
-    base: Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters", characterId, "status"),
-  };
-  return Query.Request(opt);
-};
+import type * as Model from "../model";
+import { type Params, Query, Static } from "../util";
+
+/**
+ * 서버 이름과 캐릭터 닉네임을 입력하여 해당 캐릭터를 검색합니다.
+ *
+ * @param {Static.Server} [serverId=""] 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} [characterName=""] 검색할 캐릭터의 이름입니다.
+ * @param {object} [params={}] 선택적 요청변수의 Object입니다.
+ */
+export const characterName = (
+  serverId: Static.Server,
+  characterName: string,
+  params: Params.ICharParams = {},
+) => {
+  // if (params === undefined) params = {};
+  params.characterName = characterName;
+  const opt = {
+    base: Query.UriBuilder(Static.BaseUri.Servers, serverId, "characters"),
+    params: params,
+  };
+  return Query.Request<Model.Rows<Model.Char.Character>>(opt);
+};
+
+/**
+ * 캐릭터 ID를 입력하여 해당 캐릭터 정보를 받아옵니다
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export const characterId = (
+  serverId: Static.Server,
+  characterId: string,
+): Promise<Model.DnfResponse<Model.Char.Info>> => {
+  const opt = {
+    base: Query.UriBuilder(
+      Static.BaseUri.Servers,
+      serverId,
+      "characters",
+      characterId,
+    ),
+  };
+  return Query.Request<Model.Char.Info>(opt);
+};
+
+/**
+ * 캐릭터 ID를 입력하여 해당 캐릭터의 타임라인 정보를 검색합니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ * @param {object} params 선택적 요청변수의 Object입니다.
+ */
+export const timeline = (
+  serverId: Static.Server,
+  characterId: string,
+  params: Params.ITimeLine = {},
+): Promise<Model.DnfResponse<Model.Char.Timeline>> => {
+  const opt = {
+    base: Query.UriBuilder(
+      Static.BaseUri.Servers,
+      serverId,
+      "characters",
+      characterId,
+      "timeline",
+    ),
+    params: {
+      ...params,
+      ...(params.code ? { code: Query.QueryBuilder(params.code) } : {}),
+    },
+  };
+  return Query.Request<Model.Char.Timeline>(opt);
+};
+
+/**
+ * 캐릭터 ID를 입력하여 해당 캐릭터의 능력치 정보를 검색합니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export const status = (serverId: Static.Server, characterId: string) => {
+  const opt = {
+    base: Query.UriBuilder(
+      Static.BaseUri.Servers,
+      serverId,
+      "characters",
+      characterId,
+      "status",
+    ),
+  };
+  return Query.Request<Model.Char.CharacterStatus>(opt);
+};

package/src/api/index.ts

@@ -1,9 +1,9 @@
-import * as Action from "./auction";
-import * as Equip from "./characters.equip";
-import * as Skill from "./characters.skill";
-import * as Characters from "./characters";
-import * as Item from "./items";
-import * as SetItem from "./setitems";
-import * as Server from "./server";
-
-export { Action, Equip, Skill, Characters, Item, SetItem, Server };
+import * as Action from "./auction";
+import * as Characters from "./characters";
+import * as Equip from "./characters.equip";
+import * as Skill from "./characters.skill";
+import * as Item from "./items";
+import * as Server from "./server";
+import * as SetItem from "./setitems";
+
+export { Action, Equip, Skill, Characters, Item, SetItem, Server };