dnf-api 1.0.7 → 1.1.1

package/dist/src/util/params.d.ts

@@ -1,76 +1,76 @@
-import type * as staticUtil from "./static";
-export interface QueryOptions<T = any> {
-    base: string;
-    params?: T;
-}
-export interface ICharParams {
-    characterName?: string;
-    jobId?: string;
-    jobGrowId?: string;
-    isAllJobGrow?: boolean;
-    wordType?: staticUtil.charactersWordType;
-    limit?: number;
-}
-export interface ITimeLine {
-    serverId?: staticUtil.server;
-    characterId?: string;
-    startDate?: Date;
-    endDate?: Date;
-    limit?: number;
-    code?: string[];
-    next?: string;
-}
-export interface IAuction {
-    limit?: number;
-    sort?: IAuctionSort;
-    itemId?: string;
-    itemName?: string;
-    wordType?: staticUtil.auctionWordType;
-    wordShort?: boolean;
-    q?: IAuctionQuery;
-}
-export interface IAuctionSort {
-    unitPrice?: staticUtil.sort;
-    reinforce?: staticUtil.sort;
-    auctionNo?: staticUtil.sort;
-}
-export interface IAuctionQuery {
-    minLevel?: number;
-    maxLevel?: number;
-    raity?: staticUtil.rarity;
-    reinforceTypeId: staticUtil.reinforceType;
-    minReinforce?: number;
-    maxReinforce?: number;
-    minRefine?: number;
-    maxRefine?: number;
-    minFame?: number;
-    maxFame?: number;
-}
-export interface IActionSoldOption {
-    limit?: number;
-    wordType?: staticUtil.auctionWordType;
-    wordShort?: boolean;
-    itemId?: string;
-    itemName?: string;
-    sort?: IAuctionSort;
-}
-export interface IItem {
-    limit?: number;
-    itemName?: string;
-    hashtag?: string[];
-    wordType?: staticUtil.auctionWordType;
-    q?: IItemQuery;
-}
-export interface IItemQuery {
-    minLevel?: number;
-    maxLevel?: number;
-    rarity?: staticUtil.rarity;
-}
-export interface ISetItem {
-    setItemName?: string;
-    limit?: number;
-    wordType?: staticUtil.auctionWordType;
-}
-export interface ISkill {
-    jobGrowId: string;
-}
+import type * as staticUtil from "./static";
+export interface QueryOptions<T = any> {
+    base: string;
+    params?: T;
+}
+export interface ICharParams {
+    characterName?: string;
+    jobId?: string;
+    jobGrowId?: string;
+    isAllJobGrow?: boolean;
+    wordType?: staticUtil.charactersWordType;
+    limit?: number;
+}
+export interface ITimeLine {
+    serverId?: staticUtil.server;
+    characterId?: string;
+    startDate?: Date;
+    endDate?: Date;
+    limit?: number;
+    code?: string[];
+    next?: string;
+}
+export interface IAuction {
+    limit?: number;
+    sort?: IAuctionSort;
+    itemId?: string;
+    itemName?: string;
+    wordType?: staticUtil.auctionWordType;
+    wordShort?: boolean;
+    q?: IAuctionQuery;
+}
+export interface IAuctionSort {
+    unitPrice?: staticUtil.sort;
+    reinforce?: staticUtil.sort;
+    auctionNo?: staticUtil.sort;
+}
+export interface IAuctionQuery {
+    minLevel?: number;
+    maxLevel?: number;
+    raity?: staticUtil.rarity;
+    reinforceTypeId: staticUtil.reinforceType;
+    minReinforce?: number;
+    maxReinforce?: number;
+    minRefine?: number;
+    maxRefine?: number;
+    minFame?: number;
+    maxFame?: number;
+}
+export interface IActionSoldOption {
+    limit?: number;
+    wordType?: staticUtil.auctionWordType;
+    wordShort?: boolean;
+    itemId?: string;
+    itemName?: string;
+    sort?: IAuctionSort;
+}
+export interface IItem {
+    limit?: number;
+    itemName?: string;
+    hashtag?: string[];
+    wordType?: staticUtil.auctionWordType;
+    q?: IItemQuery;
+}
+export interface IItemQuery {
+    minLevel?: number;
+    maxLevel?: number;
+    rarity?: staticUtil.rarity;
+}
+export interface ISetItem {
+    setItemName?: string;
+    limit?: number;
+    wordType?: staticUtil.auctionWordType;
+}
+export interface ISkill {
+    jobGrowId: string;
+}

package/dist/src/util/query.d.ts

@@ -1,14 +1,14 @@
-import type * as model from "../model";
-export default class Request {
-    static UriBuilder(...args: any[]): string;
-    static QueryBuilder(query: string[] | number[]): string;
-    /**
-     *  던전앤파이터 API 서버에 응답을 요청하는 함수 입니다.
-     * 해당 함수를 직접 호출 하는것을 권장하지 않습니다.
-     *
-     * @param {object} opt (요청을 보낼 Parameter값)
-     * @returns
-     */
-    static Request<T>(opt?: any, method?: "GET" | "POST"): Promise<model.IDnfResponse<T>>;
-    static makeItemQuery(query: any): string;
-}
+import type * as model from "../model";
+export default class Request {
+    static UriBuilder(...args: any[]): string;
+    static QueryBuilder(query: string[] | number[]): string;
+    /**
+     *  던전앤파이터 API 서버에 응답을 요청하는 함수 입니다.
+     * 해당 함수를 직접 호출 하는것을 권장하지 않습니다.
+     *
+     * @param {object} opt (요청을 보낼 Parameter값)
+     * @returns
+     */
+    static Request<T>(opt?: any, method?: "GET" | "POST"): Promise<model.IDnfResponse<T>>;
+    static makeItemQuery(query: any): string;
+}

package/dist/src/util/static.d.ts

@@ -1,50 +1,50 @@
-export declare enum server {
-    Cain = "cain",
-    Diregie = "diregie",
-    Siroco = "siroco",
-    Prey = "prey",
-    Casillas = "casillas",
-    Hilder = "hilder",
-    Anton = "anton",
-    Bakal = "bakal"
-}
-export declare enum sort {
-    Asc = "asc",
-    Desc = "desc"
-}
-export declare enum rarity {
-    Common = "\uCEE4\uBA3C",
-    Uncommon = "\uC5B8\uCEE4\uBA3C",
-    Rare = "\uB808\uC5B4",
-    Unique = "\uC720\uB2C8\uD06C",
-    Eqic = "\uC5D0\uD53D",
-    Chronicle = "\uD06C\uB85C\uB2C8\uD074",
-    Legendary = "\uB808\uC804\uB354\uB9AC"
-}
-export declare enum auctionWordType {
-    Match = "match",
-    Front = "front",
-    Full = "full"
-}
-export declare enum wordType {
-    Match = "match",
-    Front = "front",
-    Full = "full"
-}
-export declare enum charactersWordType {
-    Match = "match",
-    Full = "full"
-}
-export declare enum baseUri {
-    Servers = "df/servers",
-    Auction = "df/auction",
-    AuctionSold = "df/auction-sold",
-    Item = "df/items",
-    SetItem = "df/setitems",
-    Multi = "df/multi"
-}
-export declare enum reinforceType {
-    reinforce = "\uAC15\uD654",
-    minRefine = "\uC99D\uD3ED",
-    modify = "\uAC1C\uC870"
-}
+export declare enum server {
+    Cain = "cain",
+    Diregie = "diregie",
+    Siroco = "siroco",
+    Prey = "prey",
+    Casillas = "casillas",
+    Hilder = "hilder",
+    Anton = "anton",
+    Bakal = "bakal"
+}
+export declare enum sort {
+    Asc = "asc",
+    Desc = "desc"
+}
+export declare enum rarity {
+    Common = "\uCEE4\uBA3C",
+    Uncommon = "\uC5B8\uCEE4\uBA3C",
+    Rare = "\uB808\uC5B4",
+    Unique = "\uC720\uB2C8\uD06C",
+    Eqic = "\uC5D0\uD53D",
+    Chronicle = "\uD06C\uB85C\uB2C8\uD074",
+    Legendary = "\uB808\uC804\uB354\uB9AC"
+}
+export declare enum auctionWordType {
+    Match = "match",
+    Front = "front",
+    Full = "full"
+}
+export declare enum wordType {
+    Match = "match",
+    Front = "front",
+    Full = "full"
+}
+export declare enum charactersWordType {
+    Match = "match",
+    Full = "full"
+}
+export declare enum baseUri {
+    Servers = "df/servers",
+    Auction = "df/auction",
+    AuctionSold = "df/auction-sold",
+    Item = "df/items",
+    SetItem = "df/setitems",
+    Multi = "df/multi"
+}
+export declare enum reinforceType {
+    reinforce = "\uAC15\uD654",
+    minRefine = "\uC99D\uD3ED",
+    modify = "\uAC1C\uC870"
+}

package/dist/util/config.d.ts

@@ -0,0 +1,21 @@
+export interface IConfig {
+    key: string;
+    hideOnErrorApiKey: boolean;
+    hideKeyText: string;
+    timeout: number;
+    returnJSON: boolean;
+    responseHeader: boolean;
+    showURL: boolean;
+    maxRequestsPerSecond: number;
+}
+export declare const config: IConfig;
+/**
+ * 설정을 업데이트합니다.
+ * @param newConfig 업데이트할 설정 값
+ */
+export declare function setConfig(newConfig: Partial<IConfig>): void;
+/**
+ * 설정을 기본값으로 초기화합니다.
+ */
+export declare function resetConfig(): void;
+export default config;

package/dist/util/index.d.ts

@@ -0,0 +1,7 @@
+import config, { setConfig, resetConfig } from "./config";
+import * as params from "./params";
+import query from "./query";
+import { requestQueue } from "./queue";
+import { createRequest } from "./request-helper";
+import * as staticUtil from "./static";
+export { config, setConfig, resetConfig, query, staticUtil, params, createRequest, requestQueue, };

package/dist/util/params.d.ts

@@ -0,0 +1,80 @@
+import type * as staticUtil from "./static";
+export type ParamValue = string | number | boolean | undefined;
+export interface BaseParams {
+    [key: string]: ParamValue | ParamValue[] | object | undefined;
+}
+export interface QueryOptions<T = BaseParams> {
+    base: string;
+    params?: T;
+}
+export interface ICharParams extends BaseParams {
+    characterName?: string;
+    jobId?: string;
+    jobGrowId?: string;
+    isAllJobGrow?: boolean;
+    wordType?: staticUtil.charactersWordType;
+    limit?: number;
+}
+export interface ITimeLine extends BaseParams {
+    serverId?: staticUtil.server;
+    characterId?: string;
+    startDate?: Date;
+    endDate?: Date;
+    limit?: number;
+    code?: string[];
+    next?: string;
+}
+export interface IAuction extends BaseParams {
+    limit?: number;
+    sort?: IAuctionSort;
+    itemId?: string;
+    itemName?: string;
+    wordType?: staticUtil.auctionWordType;
+    wordShort?: boolean;
+    q?: IAuctionQuery;
+}
+export interface IAuctionSort {
+    unitPrice?: staticUtil.sort;
+    reinforce?: staticUtil.sort;
+    auctionNo?: staticUtil.sort;
+}
+export interface IAuctionQuery {
+    minLevel?: number;
+    maxLevel?: number;
+    raity?: staticUtil.rarity;
+    reinforceTypeId: staticUtil.reinforceType;
+    minReinforce?: number;
+    maxReinforce?: number;
+    minRefine?: number;
+    maxRefine?: number;
+    minFame?: number;
+    maxFame?: number;
+}
+export interface IActionSoldOption extends BaseParams {
+    limit?: number;
+    wordType?: staticUtil.auctionWordType;
+    wordShort?: boolean;
+    itemId?: string;
+    itemName?: string;
+    sort?: IAuctionSort;
+}
+export interface IItem extends BaseParams {
+    limit?: number;
+    itemName?: string;
+    hashtag?: string[];
+    wordType?: staticUtil.auctionWordType;
+    q?: IItemQuery;
+}
+export interface IItemQuery {
+    minLevel?: number;
+    maxLevel?: number;
+    rarity?: staticUtil.rarity;
+}
+export interface ISetItem extends BaseParams {
+    setItemName?: string;
+    limit?: number;
+    wordType?: staticUtil.auctionWordType;
+}
+export interface ISkill extends BaseParams {
+    jobGrowId: string;
+}

package/dist/util/query.d.ts

@@ -0,0 +1,39 @@
+import type * as model from "../model";
+import type { BaseParams } from "./params";
+export interface RequestOptions {
+    base: string;
+    params?: BaseParams;
+    url?: string;
+}
+/**
+ * URI 경로를 빌드합니다.
+ * @param args 경로 세그먼트들
+ * @returns 결합된 URI 경로
+ */
+export declare function UriBuilder(...args: (string | number)[]): string;
+/**
+ * 쿼리 문자열을 빌드합니다.
+ * @param query 쿼리 배열
+ * @returns 쿼리 문자열
+ */
+export declare function QueryBuilder(query: (string | number)[]): string;
+/**
+ * 던전앤파이터 API 서버에 요청을 보내는 함수입니다.
+ * @param opt 요청 옵션
+ * @param method HTTP 메서드
+ * @returns API 응답
+ */
+export declare function Request<T>(opt?: RequestOptions, method?: "GET" | "POST"): Promise<model.IDnfResponse<T>>;
+/**
+ * 아이템 쿼리를 생성합니다.
+ * @param query 쿼리 문자열
+ * @returns 인코딩된 쿼리
+ */
+export declare function makeItemQuery(query: string): string;
+declare const _default: {
+    UriBuilder: typeof UriBuilder;
+    QueryBuilder: typeof QueryBuilder;
+    Request: typeof Request;
+    makeItemQuery: typeof makeItemQuery;
+};
+export default _default;

package/dist/util/queue.d.ts

@@ -0,0 +1,31 @@
+export declare class RequestQueue {
+    private queue;
+    private processing;
+    private requestCount;
+    private lastResetTime;
+    /**
+     * 큐에 요청을 추가합니다.
+     * @param task 실행할 비동기 작업
+     * @returns 작업 결과 Promise
+     */
+    add<T>(task: () => Promise<T>): Promise<T>;
+    /**
+     * 큐를 처리합니다.
+     */
+    private processQueue;
+    private sleep;
+    /**
+     * 현재 큐 상태를 반환합니다.
+     */
+    get status(): {
+        queueLength: number;
+        requestCount: number;
+        maxRequestsPerSecond: number;
+    };
+    /**
+     * 큐를 초기화합니다.
+     */
+    clear(): void;
+}
+export declare const requestQueue: RequestQueue;
+export default requestQueue;

package/dist/util/request-helper.d.ts

@@ -0,0 +1,9 @@
+import type * as model from "../model";
+import type { BaseParams } from "./params";
+/**
+ * API 요청을 생성하는 헬퍼 함수
+ * @param baseParts URI 경로 세그먼트들
+ * @param params 요청 파라미터
+ * @returns API 응답 Promise
+ */
+export declare function createRequest<T>(baseParts: (string | number)[], params?: BaseParams): Promise<model.IDnfResponse<T>>;

package/dist/util/static.d.ts

@@ -0,0 +1,50 @@
+export declare enum server {
+    Cain = "cain",
+    Diregie = "diregie",
+    Siroco = "siroco",
+    Prey = "prey",
+    Casillas = "casillas",
+    Hilder = "hilder",
+    Anton = "anton",
+    Bakal = "bakal"
+}
+export declare enum sort {
+    Asc = "asc",
+    Desc = "desc"
+}
+export declare enum rarity {
+    Common = "\uCEE4\uBA3C",
+    Uncommon = "\uC5B8\uCEE4\uBA3C",
+    Rare = "\uB808\uC5B4",
+    Unique = "\uC720\uB2C8\uD06C",
+    Eqic = "\uC5D0\uD53D",
+    Chronicle = "\uD06C\uB85C\uB2C8\uD074",
+    Legendary = "\uB808\uC804\uB354\uB9AC"
+}
+export declare enum auctionWordType {
+    Match = "match",
+    Front = "front",
+    Full = "full"
+}
+export declare enum wordType {
+    Match = "match",
+    Front = "front",
+    Full = "full"
+}
+export declare enum charactersWordType {
+    Match = "match",
+    Full = "full"
+}
+export declare enum baseUri {
+    Servers = "df/servers",
+    Auction = "df/auction",
+    AuctionSold = "df/auction-sold",
+    Item = "df/items",
+    SetItem = "df/setitems",
+    Multi = "df/multi"
+}
+export declare enum reinforceType {
+    reinforce = "\uAC15\uD654",
+    minRefine = "\uC99D\uD3ED",
+    modify = "\uAC1C\uC870"
+}

package/package.json

@@ -1,39 +1,42 @@
-{
-  "name": "dnf-api",
-  "version": "1.0.7",
-  "description": "던전 앤 파이터 API",
-  "main": "./dist/index.js",
-  "types": "./dist/src/index.d.ts",
-  "dependencies": {
-    "@types/bun": "1.1.7",
-    "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 test.ts",
-    "bundle": "tsc --declaration --emitDeclarationOnly --outDir dist && bun build src/index.ts --minify --target=bun --outfile dist/index.js",
-    "dev:test": "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"
-}
+{
+  "name": "dnf-api",
+  "version": "1.1.1",
+  "description": "던전 앤 파이터 API",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/src/index.d.ts",
+  "dependencies": {
+    "consola": "^2.15.3",
+    "prototype-helper": "^0.4.2"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.1.6",
+    "@biomejs/biome": "^1.9.4",
+    "dotenv": "^16.4.7",
+    "typescript": "5.5.3"
+  },
+  "scripts": {
+    "dev": "bun --watch test.ts",
+    "bundle": "tsc --declaration --emitDeclarationOnly --outDir dist && bun build src/index.ts --minify --target=bun --outfile dist/index.js",
+    "dev:test": "bun --watch test.ts",
+    "lint": "biome lint ./src",
+    "lint:fix": "biome lint --write ./src",
+    "format": "biome format --write ./src",
+    "check": "biome check ./src",
+    "check:fix": "biome check --write ./src"
+  },
+  "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

@@ -44,7 +44,7 @@ export const no = (auctionNo: number) => {
 
 export const auctionSoldName = (
   itemName: string,
-  params: params.IActionSoldOption = {}
+  params: params.IActionSoldOption = {},
 ) => {
   params.itemName = itemName;
   const opt = {
@@ -56,7 +56,7 @@ export const auctionSoldName = (
 
 export const auctionSoldId = (
   itemId: string,
-  params: params.IActionSoldOption = {}
+  params: params.IActionSoldOption = {},
 ) => {
   params.itemId = itemId;
   const opt = {

package/src/api/characters.equip.ts

@@ -14,7 +14,7 @@ export const equipment = (serverId: staticUtil.server, characterId: string) => {
       "characters",
       characterId,
       "equip",
-      "equipment"
+      "equipment",
     ),
   };
   return query.Request(opt);
@@ -34,7 +34,7 @@ export const avatar = (serverId: staticUtil.server, characterId: string) => {
       "characters",
       characterId,
       "equip",
-      "avatar"
+      "avatar",
     ),
   };
   return query.Request(opt);
@@ -54,7 +54,7 @@ export const creature = (serverId: staticUtil.server, characterId: string) => {
       "characters",
       characterId,
       "equip",
-      "creature"
+      "creature",
     ),
   };
   return query.Request(opt);
@@ -74,7 +74,7 @@ export const flag = (serverId: staticUtil.server, characterId: string) => {
       "characters",
       characterId,
       "equip",
-      "flag"
+      "flag",
     ),
   };
   return query.Request(opt);