Merge pull request #104 from koreanbots/node16

BREAKING: Koreanbots JS/TS SDK v3.1

Author: zero734kr

.eslintrc.json

@@ -5,15 +5,18 @@
     },
     "extends": [
         "eslint:recommended",
-        "plugin:@typescript-eslint/recommended"
+        "plugin:@typescript-eslint/recommended",
+        "plugin:import/recommended",
+        "plugin:import/typescript"
     ],
     "parser": "@typescript-eslint/parser",
     "parserOptions": {
         "ecmaVersion": 2020,
         "sourceType": "module"
     },
     "plugins": [
-        "@typescript-eslint"
+        "@typescript-eslint",
+        "import"
     ],
     "rules": {
         "indent": [

.github/workflows/commitlint.yml

@@ -38,7 +38,8 @@ $ yarn add koreanbots
 
 ## 사용 조건
 
-> Node.js v12 이상이 권장됩니다.
+> 3.1 버전 이상은 Node.js v16.6.0 이상이 필요합니다.
+> 그 이하 버전은 Node.js v12부터 지원됩니다.
 
 | discord.js version        | supported | planned to support |
 |---------------------------|-----------|--------------------|
@@ -106,8 +107,8 @@ client.login("토큰")
 
 👤 **zero734kr**
 
-* 개인 Github: [@zero734kr](https://github.com/zero734kr)
-* Organization Github: [@koreanbots](https://github.com/koreanbots)
+* 개인 GitHub: [@zero734kr](https://github.com/zero734kr)
+* Organization GitHub: [@koreanbots](https://github.com/koreanbots)
 
 
 ## 🤝 도움주기

README.md

@@ -1,19 +1,19 @@
 {
   "name": "koreanbots",
-  "version": "3.0.0",
+  "version": "3.1.0-rc.1",
   "description": "JavaScript/TypeScript SDK for KOREANBOTS",
   "main": "dist/src/index.js",
   "typings": "dist/src/index.d.ts",
   "license": "MIT",
   "scripts": {
-    "test": "cross-env NODE_ENV=test jest --forceExit --detectOpenHandles",
+    "test": "cross-env NODE_ENV=test jest --forceExit",
     "test:local": "node tests/local/index.js",
     "coverage": "yarn test --coverage",
     "prepack": "yarn install -D && tsc",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "commit": "git-cz",
-    "docgen": "typedoc src/index.ts --out web --darkHighlightTheme github-dark --lightHighlightTheme github-light --includeVersion"
+    "docgen": "typedoc --options ./typedoc.json"
   },
   "repository": {
     "type": "git",
@@ -31,33 +31,31 @@
     }
   ],
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=16.6.0"
   },
   "dependencies": {
-    "abort-controller": "^3.0.0",
-    "discord.js": ">=12",
-    "node-fetch": "^2.6.1"
+    "discord.js": ">=13",
+    "undici": "^4.7.0"
   },
   "devDependencies": {
     "@next/env": "^11.0.1",
     "@swc-node/jest": "^1.3.0",
     "@swc-node/register": "^1.3.0",
     "@tsconfig/recommended": "^1.0.1",
     "@types/jest": "^26.0.24",
-    "@types/node": "^14.14.6",
-    "@types/node-fetch": "^2.5.7",
-    "@types/sharp": "^0.27.1",
+    "@types/node": "^16.10.2",
+    "@types/sharp": "^0.29.2",
     "@typescript-eslint/eslint-plugin": "^4.6.0",
     "@typescript-eslint/parser": "^4.6.0",
-    "commitizen": "^4.2.2",
     "cross-env": "^7.0.3",
     "eslint": "^7.12.1",
+    "eslint-plugin-import": "^2.24.2",
     "husky": "^5.1.3",
-    "jest": "^26.6.3",
-    "typedoc": "^0.22.2",
-    "typescript": "^4.3.5"
+    "jest": "^27.2.4",
+    "typedoc": "^0.22.4",
+    "typescript": "^4.4.3"
   },
   "optionalDependencies": {
-    "sharp": "^0.28.3"
+    "sharp": "^0.29.1"
   }
 }

package.json

@@ -1,14 +1,21 @@
 import { snowflakeRegex } from "../utils/Constants"
 import APIRouter from "../rest/APIRouter"
+
 import { Mybot } from "../managers/Mybot"
 import { BotManager } from "../managers/BotManager"
 import { UserManager } from "../managers/UserManager"
 import { WidgetManager } from "../managers/WidgetManager"
 
-import type { BotManagerOptions, KoreanbotsOptions, ProxyValidator, UserManagerOptions, WidgetManagerOptions } from "../utils/types"
+import type { 
+    BotManagerOptions, 
+    KoreanbotsOptions, 
+    ProxyValidator, 
+    UserManagerOptions, 
+    WidgetManagerOptions 
+} from "../utils/types"
 
-const defaultMaxOption = 100
-const defaultMaxAgeOption = 10000
+const defaultCacheMaxSize = 100
+const defaultCacheSweepInterval = 10000
 
 export class Koreanbots {
     public readonly options!: KoreanbotsOptions
@@ -39,16 +46,16 @@ export class Koreanbots {
      * ```js
      * new Koreanbots({
      *     clientID: process.env.CLIENT_ID,
-     *     apiOptions: {
+     *     api: {
      *         token: process.env.KOREANBOTS_TOKEN
      *     },
      *     // 글로벌 캐시 옵션이며, 누락할 경우 모든 캐시 옵션이 각각의 기본 값으로 설정됩니다 (로컬 캐시 옵션이 우선권을 가집니다)
-     *     max: 250, // (기본값: 100) 캐시에 최대 250개의 내용을 저장
-     *     maxAge: 60000 * 15, // (기본값: 10000 = 10초) 캐시에 저장한 내용을 15분 뒤에 삭제합니다.
+     *     maxSize: 250, // (기본값: 100) 캐시에 최대 250개의 내용을 저장
+     *     sweepInterval: 60000 * 15, // (기본값: 10000 = 10초) 캐시에 저장한 내용을 15분 뒤에 삭제합니다.
      *     users: {
      *         cache: { // 이 캐시 설정은 로컬이므로 앞서 적은 글로벌 캐시 옵션보다 우선권을 갖습니다.
-     *             max: 500, // (기본값: 100)
-     *             maxAge: 60000 * 30 // (기본값: 60000 * 60)
+     *             maxSize: 500, // (기본값: 100)
+     *             sweepInterval: 60000 * 30 // (기본값: 60000 * 60)
      *         }
      *     }
      * })
@@ -66,8 +73,8 @@ export class Koreanbots {
 
         optionsProxy.clientID = options.clientID
 
-        this.options.max = options.max ?? defaultMaxOption
-        this.options.maxAge = options.maxAge ?? defaultMaxAgeOption
+        if (!this.options?.maxSize) this.options.maxSize = defaultCacheMaxSize
+        if (!this.options?.sweepInterval) this.options.sweepInterval = defaultCacheSweepInterval
 
         this.bots = new BotManager(this, this.getOptions(options.bots))
         this.users = new UserManager(this, this.getOptions(options.users))

src/client/Koreanbots.ts

@@ -1,25 +1,25 @@
-import LifetimeCollection from "../utils/Collection"
+import { LimitedCollection } from "discord.js"
 import { Bot } from "../structures/Bot"
-import { CacheOptionsValidator } from "../utils"
 
 import type {
-    BotManagerOptions, FetchResponse, Nullable, RawBotInstance,
+    BotManagerOptions,
+    Nullable,
     FetchOptions
 } from "../utils/types"
 import type { Koreanbots } from "../client/Koreanbots"
-import type { RequestInit } from "node-fetch"
 
-interface BotQuery {
-    bots(botID: string): {
-        get(options?: RequestInit): Promise<FetchResponse<RawBotInstance>>
-    }
-}
 
 const defaultCacheMaxSize = 100
-const defaultCacheMaxAge = 60000 * 60
+const defaultCacheSweepInterval = 60000 * 60
+const defaultOptions = {
+    cache: {
+        maxSize: defaultCacheMaxSize,
+        sweepInterval: defaultCacheSweepInterval
+    }
+}
 
 export class BotManager {
-    public cache: LifetimeCollection<string, Nullable<Bot>>
+    public cache: LimitedCollection<string, Nullable<Bot>>
 
     /**
      * 새로운 BotManager 인스턴스를 만듭니다.
@@ -33,23 +33,22 @@ export class BotManager {
      *     })),
      *     {
      *         cache: {
-     *             max: 150,
-     *             maxAge: 60000
+     *             maxSize: 150,
+     *             sweepInterval: 60000
      *         }
      *     }
      * )
      * ```
      */
     constructor(public readonly koreanbots: Koreanbots, public readonly options?: BotManagerOptions) {
-        this.options = options ?? { cache: {} }
-        const optionsProxy = new Proxy(this.options, CacheOptionsValidator<BotManagerOptions>())
+        this.options = options ?? defaultOptions
 
-        optionsProxy.cache.max = options?.cache?.max ?? defaultCacheMaxSize
-        optionsProxy.cache.maxAge = options?.cache?.maxAge ?? defaultCacheMaxAge
+        if (!this.options?.cache.maxSize) this.options.cache.maxSize = defaultCacheMaxSize
+        if (!this.options?.cache.sweepInterval) this.options.cache.sweepInterval = defaultCacheSweepInterval
 
-        this.cache = new LifetimeCollection({
-            max: this.options.cache.max,
-            maxAge: this.options.cache.maxAge
+        this.cache = new LimitedCollection({
+            maxSize: this.options.cache.maxSize,
+            sweepInterval: this.options.cache.sweepInterval
         })
     }
 
@@ -78,12 +77,12 @@ export class BotManager {
      * ```
      */
     async fetch(botID: string, options: FetchOptions = { cache: true, force: false }): Promise<Bot> {
-        if (!botID || typeof botID !== "string") throw new Error(`"botID" 값은 주어지지 않았거나 문자열이어야 합니다. (받은 타입: ${typeof botID})`)
+        if (!botID || typeof botID !== "string") throw new Error(`"botID" 값이 주어지지 않았거나 문자열이어야 합니다. (받은 타입: ${typeof botID})`)
 
         const cache = this.cache.get(botID)
         if (!options?.force && cache) return cache
 
-        const res = await this.koreanbots.api<BotQuery>().bots(botID).get()
+        const res = await this.koreanbots.api().bots(botID).get()
         if (res.code !== 200 || !res.data) throw new Error(res.message || `API에서 알 수 없는 응답이 돌아왔습니다. ${JSON.stringify(res.data)}`)
 
         const bot = new Bot(this.koreanbots, res.data)

src/managers/BotManager.ts

@@ -1,37 +1,20 @@
+import { LimitedCollection } from "discord.js"
 import { URLSearchParams } from "url"
 import { Bot } from "../structures/Bot"
 import { KoreanbotsInternal } from "../utils/Constants"
 
 import type { Koreanbots } from "../client/Koreanbots"
-import type { FetchResponse, RawBotInstance, RequestInitWithInternals, Vote } from "../utils/types"
-import LifetimeCollection from "../utils/Collection"
-
-export interface UpdateResponse {
-    code: number
-    version: number
-    message: string
-    servers?: number
-}
+import type { UpdateResponse, Vote } from "../utils/types"
 
-interface BotQuery {
-    bots(clientID: string): {
-        get(options?: RequestInitWithInternals): Promise<FetchResponse<RawBotInstance>>
-        vote: {
-            get(options?: RequestInitWithInternals): Promise<FetchResponse<Vote>>
-        }
-        stats: {
-            post(options?: RequestInitWithInternals): Promise<FetchResponse<UpdateResponse>>
-        }
-    }
-}
+const defaultCacheSweepInterval = 10000
 
 export class Mybot {
     public bot: Bot | null
 
     public lastGuildCount?: number
     public updatedAt?: Date
     public updatedTimestamp?: number
-    public votes: LifetimeCollection<string, Vote>
+    public votes: LimitedCollection<string, Vote>
 
     /**
      * 새로운 Mybot 인스턴스를 생성합니다.
@@ -41,15 +24,15 @@ export class Mybot {
     constructor(public readonly koreanbots: Koreanbots, public readonly clientID: string) {
         this.bot = null
 
-        this.votes = new LifetimeCollection({
-            maxAge: 10000
+        this.votes = new LimitedCollection({
+            sweepInterval: koreanbots.options.sweepInterval ?? defaultCacheSweepInterval
         })
 
         this.mybotInit()
     }
 
     protected async mybotInit(): Promise<Bot> {
-        const res = await this.koreanbots.api<BotQuery>().bots(this.clientID).get()
+        const res = await this.koreanbots.api().bots(this.clientID).get()
 
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         return this.bot = new Bot(this.koreanbots, res.data!)
@@ -76,7 +59,7 @@ export class Mybot {
         const query = new URLSearchParams()
         query.append("userID", id)
 
-        const res = await this.koreanbots.api<BotQuery>().bots(this.clientID).vote.get({
+        const res = await this.koreanbots.api().bots(this.clientID).vote.get({
             [KoreanbotsInternal]: {
                 query
             }
@@ -111,7 +94,7 @@ export class Mybot {
             servers: servers,
             shards
         })
-        const response = await this.koreanbots.api<BotQuery>().bots(this.clientID).stats.post({
+        const response = await this.koreanbots.api().bots(this.clientID).stats.post({
             body
         })