dnf-api 2.0.3 → 3.0.0

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

@@ -1,11 +0,0 @@
-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

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

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

@@ -1,76 +0,0 @@
-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 +0,0 @@
-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 +0,0 @@
-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/jest.config.js

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

package/src/api/auction.ts

@@ -1,104 +0,0 @@
-import type * as model from "../model";
-import { type params, query, staticUtil } 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(staticUtil.BaseUri.Auction),
-    params,
-  };
-  return query.Request<model.IRows<model.auction.IAuction>>(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(staticUtil.BaseUri.Auction),
-    params: params,
-  };
-  return query.Request<model.IRows<model.auction.IAuction>>(opt);
-};
-/**
- * 경매장에 등록된 경매장번호로 받아옵니다.
- *
- * @param {Number} auctionNo 검색할 경매장 번호입니다.
- */
-export const no = (auctionNo: number) => {
-  const opt = {
-    base: query.UriBuilder(staticUtil.BaseUri.Auction, auctionNo),
-  };
-  return query.Request<model.auction.IAuction>(opt);
-};
-
-export const auctionSoldName = (
-  itemName: string,
-  params: params.IAuctionSoldOption = {}
-) => {
-  params.itemName = itemName;
-  const opt = {
-    base: query.UriBuilder(staticUtil.BaseUri.AuctionSold),
-    params,
-  };
-  return query.Request<model.IRows<model.auction.IAuctionSolid>>(opt);
-};
-
-export const auctionSoldId = (
-  itemId: string,
-  params: params.IAuctionSoldOption = {}
-) => {
-  params.itemId = itemId;
-  const opt = {
-    base: query.UriBuilder(staticUtil.BaseUri.AuctionSold),
-    params,
-  };
-  return query.Request<model.IRows<model.auction.IAuctionSolid>>(opt);
-};
-
-/**
- * 경매장에 등록된 아이템을 복수 "아이템 아이디"로 검색합니다 (최대 10개)
- *
- * @param {string[]} itemIds 검색할 아이템 ID 배열 (최대 10개)
- * @param {object} params 선택적 요청변수의 Object입니다.
- */
-export const itemIds = (itemIdList: string[], params: params.IAuction = {}) => {
-  const opt = {
-    base: query.UriBuilder(staticUtil.BaseUri.Auction),
-    params: {
-      ...params,
-      itemIds: itemIdList.join(","),
-    },
-  };
-  return query.Request<model.IRows<model.auction.IAuction>>(opt);
-};
-
-/**
- * 경매장 시세를 복수 "아이템 아이디"로 검색합니다 (최대 10개)
- *
- * @param {string[]} itemIds 검색할 아이템 ID 배열 (최대 10개)
- * @param {object} params 선택적 요청변수의 Object입니다.
- */
-export const auctionSoldIds = (
-  itemIdList: string[],
-  params: params.IAuctionSoldOption = {}
-) => {
-  const opt = {
-    base: query.UriBuilder(staticUtil.BaseUri.AuctionSold),
-    params: {
-      ...params,
-      itemIds: itemIdList.join(","),
-    },
-  };
-  return query.Request<model.IRows<model.auction.IAuctionSolid>>(opt);
-};

package/src/api/avatar-market.ts

@@ -1,77 +0,0 @@
-import type * as model from "../model";
-import { type params, query, staticUtil } from "../util";
-
-/**
- * 19. 아바타 마켓 상품 검색
- * hashtag 정보는 "아바타 마켓 해시태그 조회 API"를 통해서 확인 가능합니다.
- *
- * @param {object} params 요청변수 Object
- */
-export const sale = (params: params.IAvatarMarketSale = {}) => {
-  const opt = {
-    base: query.UriBuilder(staticUtil.BaseUri.AvatarMarket, "sale"),
-    params: {
-      ...params,
-      ...(params.hashtag
-        ? { hashtag: query.QueryBuilder(params.hashtag) }
-        : {}),
-    },
-  };
-  return query.Request<model.IRows<model.avatarMarket.ISale>>(opt);
-};
-
-/**
- * 20. 아바타 마켓 상품 조회
- *
- * @param {number} goodsNo 아바타 마켓 등록 번호
- */
-export const saleDetail = (goodsNo: number) => {
-  const opt = {
-    base: query.UriBuilder(staticUtil.BaseUri.AvatarMarket, "sale", goodsNo),
-  };
-  return query.Request<model.avatarMarket.ISaleDetail>(opt);
-};
-
-/**
- * 21. 아바타 마켓 상품 시세 검색
- * hashtag 정보는 "아바타 마켓 해시태그 조회 API"를 통해서 확인 가능합니다.
- *
- * @param {object} params 요청변수 Object
- */
-export const sold = (params: params.IAvatarMarketSold = {}) => {
-  const opt = {
-    base: query.UriBuilder(staticUtil.BaseUri.AvatarMarket, "sold"),
-    params: {
-      ...params,
-      ...(params.hashtag
-        ? { hashtag: query.QueryBuilder(params.hashtag) }
-        : {}),
-    },
-  };
-  return query.Request<model.IRows<model.avatarMarket.ISold>>(opt);
-};
-
-/**
- * 22. 아바타 마켓 상품 시세 조회
- *
- * @param {number} goodsNo 아바타 마켓 등록 번호
- */
-export const soldDetail = (goodsNo: number) => {
-  const opt = {
-    base: query.UriBuilder(staticUtil.BaseUri.AvatarMarket, "sold", goodsNo),
-  };
-  return query.Request<model.avatarMarket.ISoldDetail>(opt);
-};
-
-/**
- * 23. 아바타 마켓 해시태그 조회
- *
- * @param {string} hashtagType 해시태그 타입 (category: 카테고리, mood: 분위기)
- */
-export const hashtag = (hashtagType?: staticUtil.HashtagType) => {
-  const opt = {
-    base: query.UriBuilder(staticUtil.BaseUri.AvatarMarket, "hashtag"),
-    params: hashtagType ? { hashtagType } : {},
-  };
-  return query.Request<model.avatarMarket.IHashtag>(opt);
-};

package/src/api/characters.equip.ts

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

package/src/api/characters.skill.ts

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

package/src/api/characters.ts

@@ -1,114 +0,0 @@
-import type * as model from "../model";
-import { type params, query, staticUtil } from "../util";
-
-/**
- * 서버 이름과 캐릭터 닉네임을 입력하여 해당 캐릭터를 검색합니다.
- *
- * @param {staticUtil.Server} [serverId=""] 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} [characterName=""] 검색할 캐릭터의 이름입니다.
- * @param {object} [params={}] 선택적 요청변수의 Object입니다.
- */
-export const characterName = (
-  serverId: staticUtil.Server,
-  characterName: string,
-  params: params.ICharParams = {}
-) => {
-  // if (params === undefined) params = {};
-  params.characterName = characterName;
-  const opt = {
-    base: query.UriBuilder(staticUtil.BaseUri.Servers, serverId, "characters"),
-    params: params,
-  };
-  return query.Request<model.IRows<model.char.ICharacter>>(opt);
-};
-
-/**
- * 캐릭터 ID를 입력하여 해당 캐릭터 정보를 받아옵니다
- *
- * @param {staticUtil.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export const characterId = (
-  serverId: staticUtil.Server,
-  characterId: string
-) => {
-  const opt = {
-    base: query.UriBuilder(
-      staticUtil.BaseUri.Servers,
-      serverId,
-      "characters",
-      characterId
-    ),
-  };
-  return query.Request<model.char.IInfo>(opt);
-};
-
-/**
- * 캐릭터 ID를 입력하여 해당 캐릭터의 타임라인 정보를 검색합니다.
- *
- * @param {staticUtil.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- * @param {object} params 선택적 요청변수의 Object입니다.
- */
-export const timeline = (
-  serverId: staticUtil.Server,
-  characterId: string,
-  params: params.ITimeLine = {}
-) => {
-  const opt = {
-    base: query.UriBuilder(
-      staticUtil.BaseUri.Servers,
-      serverId,
-      "characters",
-      characterId,
-      "timeline"
-    ),
-    params: {
-      ...params,
-      ...(params.code ? { code: query.QueryBuilder(params.code) } : {}),
-    },
-  };
-  return query.Request<model.char.ITimeline>(opt);
-};
-
-/**
- * 캐릭터 ID를 입력하여 해당 캐릭터의 능력치 정보를 검색합니다.
- *
- * @param {staticUtil.Server} serverId 캐릭터가 존재하는 서버의 이름입니다.
- * @param {string} characterId 검색할 캐릭터의 ID입니다.
- */
-export const status = (serverId: staticUtil.Server, characterId: string) => {
-  const opt = {
-    base: query.UriBuilder(
-      staticUtil.BaseUri.Servers,
-      serverId,
-      "characters",
-      characterId,
-      "status"
-    ),
-  };
-  return query.Request<model.char.ICharacterStatus>(opt);
-};
-
-/**
- * 캐릭터를 명성 구간으로 검색합니다.
- * 최근 90일 이내 접속한 110 레벨 이상 캐릭터만 검색 가능합니다.
- * 최대 2,000 범위내에서만 검색 가능합니다.
- *
- * @param {staticUtil.Server} serverId 캐릭터가 존재하는 서버의 이름입니다. 'all'로 전체 서버 검색 가능
- * @param {object} params 선택적 요청변수의 Object입니다.
- */
-export const charactersFame = (
-  serverId: staticUtil.Server | "all",
-  params: params.ICharactersFame = {}
-) => {
-  const opt = {
-    base: query.UriBuilder(
-      staticUtil.BaseUri.Servers,
-      serverId,
-      "characters-fame"
-    ),
-    params: params,
-  };
-  return query.Request<model.IRows<model.char.ICharacterFame>>(opt);
-};

package/src/api/index.ts

@@ -1,23 +0,0 @@
-import * as action from "./auction";
-import * as avatarMarket from "./avatar-market";
-import * as characters from "./characters";
-import * as equip from "./characters.equip";
-import * as skill from "./characters.skill";
-import * as item from "./items";
-import * as jobs from "./jobs";
-import * as multi from "./multi";
-import * as server from "./server";
-import * as setItem from "./setitems";
-
-export {
-  action,
-  equip,
-  skill,
-  characters,
-  item,
-  setItem,
-  server,
-  multi,
-  jobs,
-  avatarMarket,
-};