dnf-api 0.6.1 → 0.6.3

package/dist/src/api/auction.d.ts

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

package/dist/src/api/characters.d.ts

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

package/dist/src/api/characters.equip.d.ts

@@ -0,0 +1,29 @@
+import { Static } from "../util";
+/**
+ * 해당 캐릭터가 장착한 장비 정보를 받아옵니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const equipment: (serverId: Static.Server, characterId: string) => Promise<import("../model").DnfResponse<unknown>>;
+/**
+ * 해당 캐릭터가 장착한 아바타 정보를 받아옵니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const avatar: (serverId: Static.Server, characterId: string) => Promise<import("../model").DnfResponse<unknown>>;
+/**
+ * 해당 캐릭터가 장착한 크리쳐 정보를 받아옵니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const creature: (serverId: Static.Server, characterId: string) => Promise<import("../model").DnfResponse<unknown>>;
+/**
+ * 해당 캐릭터가 장착한 휘장 정보를 받아옵니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const flag: (serverId: Static.Server, characterId: string) => Promise<import("../model").DnfResponse<unknown>>;

package/dist/src/api/characters.skill.d.ts

@@ -0,0 +1,29 @@
+import { Static } from "../util";
+/**
+ *  아이템 및 장비를 통한 스킬 강화 제외 입니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const style: (serverId: Static.Server, characterId: string) => Promise<import("../model").DnfResponse<unknown>>;
+/**
+ * 캐릭터 '버프 스킬 강화 장착 장비'(스위칭) 를 조회합니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const equipment: (serverId: Static.Server, characterId: string) => Promise<import("../model").DnfResponse<unknown>>;
+/**
+ * 캐릭터 '버프 스킬 강화 장착 아바타'(스위칭) 를 조회합니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const avatar: (serverId: Static.Server, characterId: string) => Promise<import("../model").DnfResponse<unknown>>;
+/**
+ * 캐릭터 '버프 스킬 강화 장착 크리쳐'(스위칭) 를 조회합니다.
+ *
+ * @param {Static.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
+ * @param {string} characterId 검색할 캐릭터의 ID입니다.
+ */
+export declare const creature: (serverId: Static.Server, characterId: string) => Promise<import("../model").DnfResponse<unknown>>;

package/dist/src/api/index.d.ts

@@ -0,0 +1,8 @@
+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 };

package/dist/src/api/items.d.ts

@@ -0,0 +1,21 @@
+import type * as Model from "../model";
+import { type Params } from "../util";
+/**
+ * 현재 인게임에서 획득 가능한 아이템의 경우만 검색 가능합니다.
+ *
+ * @param {string} itemName 검색할 아이템의 명칭
+ * @param {string} params 선택적 요청변수의 Object입니다.
+ */
+export declare const item: (itemName: string, params?: Params.IItem) => Promise<Model.DnfResponse<Model.Rows<Model.Item.Item>>>;
+/**
+ * 해당하는 아이템의 상세정보를 요청합니다.
+ *
+ * @param {string} itemId 검색할 아이템의 ID
+ */
+export declare const detail: (itemId: string) => Promise<Model.DnfResponse<Model.Item.Detail>>;
+/**
+ * 26. 아이템 상점 판매 정보 조회
+ * 인게임 백과사전 기준의 상점 판매 95레벨 에픽, 100레벨 이상 유니크, 레전더리, 에픽 장비가 조회 가능 합니다.
+ *
+ * @param {string} itemId 검색할 아이템의 ID
+ */

package/dist/src/api/server.d.ts

@@ -0,0 +1,2 @@
+import type * as Model from "../model";
+export declare const List: () => Promise<Model.DnfResponse<Model.Server[]>>;

package/dist/src/api/setitems.d.ts

@@ -0,0 +1,15 @@
+import type * as Model from "../model";
+import { type Params } from "../util";
+/**
+ * 세트 아이템 정보를 세트의 이름으로 검색합니다.
+ *
+ * @param {string} setItemName 세트 아이템의 이름입니다.
+ * @param {object} params 선택적 요청변수의 Object입니다.
+ */
+export declare const setitem: (setItemName: string, params?: Params.ISetItem) => Promise<Model.DnfResponse<Model.SetItem.SetItem[]>>;
+/**
+ * 세트 ID로 세트 아이템 정보를 받아옵니다.
+ *
+ * @param {string} setItemId 세트 아이템의 ID입니다.
+ */
+export declare const detail: (setItemId: string) => Promise<Model.DnfResponse<Model.SetItem.Detail>>;

package/dist/src/index.d.ts

@@ -0,0 +1,14 @@
+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";
+export default class DnfApi {
+    static Util: typeof Util;
+    static Request: typeof Request;
+}
+declare const ServerNames: typeof Util.Static.Server;
+declare const RarityNames: typeof Util.Static.Rarity;
+export { Request as Api, Request, Config, Static, ServerNames, RarityNames, Query, Params, Model, };

package/dist/src/model/character.d.ts

@@ -0,0 +1,84 @@
+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[];
+};

package/dist/src/model/index.d.ts

@@ -0,0 +1,76 @@
+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/dist/src/model/item.d.ts

@@ -0,0 +1,90 @@
+import type * as Static from "../util/static";
+import type { NameValue } from "./";
+export declare 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[];
+};

package/dist/src/model/setitem.d.ts

@@ -0,0 +1,30 @@
+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/dist/src/util/config.d.ts

@@ -0,0 +1,11 @@
+export interface IConfig {
+    key: string | undefined;
+    hideOnErrorApiKey: boolean;
+    hideKeyText: string;
+    timeout: number;
+    returnJSON: boolean;
+    responseHeader: boolean;
+    showURL: boolean;
+}
+declare let defaultConfig: IConfig;
+export default defaultConfig;

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

@@ -0,0 +1,5 @@
+import Config from "./config";
+import * as Params from "./params";
+import Query from "./query";
+import * as Static from "./static";
+export { Config, Query, Static, Params };

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

@@ -0,0 +1,75 @@
+import type * as Static from "./static";
+export interface QueryOptions<T = any> {
+    base: string;
+    params?: T;
+}
+export interface ICharParams {
+    characterName?: string;
+    jobId?: string;
+    jobGrowId?: string;
+    isAllJobGrow?: boolean;
+    wordType?: Static.CharactersWordType;
+    limit?: number;
+}
+export interface ITimeLine {
+    serverId?: Static.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?: Static.AuctionWordType;
+    wordShort?: boolean;
+    q?: IAuctionQuery;
+}
+export interface IAuctionSort {
+    unitPrice?: Static.Sort;
+    reinforce?: Static.Sort;
+    auctionNo?: Static.Sort;
+}
+export interface IAuctionQuery {
+    minLevel?: number;
+    maxLevel?: number;
+    raity?: Static.Rarity;
+    reinforceTypeId: Static.reinforceType;
+    minReinforce?: number;
+    maxReinforce?: number;
+    minRefine?: number;
+    maxRefine?: number;
+    minFame?: number;
+    maxFame?: number;
+}
+export interface IActionSoldOption {
+    limit?: number;
+    wordType?: Static.AuctionWordType;
+    wordShort?: boolean;
+    itemId?: string;
+    itemName?: string;
+}
+export interface IItem {
+    limit?: number;
+    itemName?: string;
+    hashtag?: string[];
+    wordType?: Static.AuctionWordType;
+    q?: IItemQuery;
+}
+export interface IItemQuery {
+    minLevel?: number;
+    maxLevel?: number;
+    rarity?: Static.Rarity;
+}
+export interface ISetItem {
+    setItemName?: string;
+    limit?: number;
+    wordType?: Static.AuctionWordType;
+}
+export interface ISkill {
+    jobGrowId: string;
+}

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

@@ -0,0 +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.DnfResponse<T>>;
+    static makeItemQuery(query: any): string;
+}

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

@@ -0,0 +1,49 @@
+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"
+}
+export declare enum reinforceType {
+    reinforce = "\uAC15\uD654",
+    minRefine = "\uC99D\uD3ED",
+    modify = "\uAC1C\uC870"
+}

package/dist/test.d.ts

@@ -0,0 +1 @@
+import "dotenv/config";

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "dnf-api",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "description": "던전 앤 파이터 API",
-  "main": "./dist/src/index.js",
+  "main": "./dist/index.js",
   "types": "./dist/src/index.d.ts",
   "dependencies": {
     "@types/bun": "1.1.6",
@@ -19,7 +19,7 @@
   },
   "scripts": {
     "dev": "bun --watch src/index.ts",
-    "bundle": "bun build src/index.ts --minify --target=bun --outfile dist/index.js",
+    "bundle": "tsc --declaration --emitDeclarationOnly --outDir dist && bun build src/index.ts --minify --target=bun --outfile dist/index.js",
     "test:dev": "bun --watch test.ts",
     "test": "jest"
   },

package/src/util/query.ts

@@ -28,7 +28,7 @@ const sender = async <T>(path: string, method: "GET" | "POST", query: any) => {
 };
 const showUrl = (url: string): string => {
   if (Util.Config.key) {
-    return url.replace(Util.Config.key, Util.Config.hideKeyText);
+    return url?.replace(Util.Config.key, Util.Config.hideKeyText);
   } else {
     return url;
   }