koreanbots / js-sdk

Official JS SDK for Koreanbots

Koreanbots.js

TypeScript/JavaScript SDK for KOREANBOTS

🏠 홈페이지

설치

# NPM
$ npm install koreanbots
# Yarn
$ yarn add koreanbots

사용 조건

3.1 버전 이상은 Node.js v16.6.0 이상이 필요합니다. 그 이하 버전은 Node.js v12부터 지원됩니다.

discord.js version	supported	planned to support
v11.x	no	no
v12.x	yes	-
v13.x (stable)	yes	-

사용법

• 자동 업데이트

const { KoreanbotsClient } = require("koreanbots")
const client = new KoreanbotsClient({
    intents: ["GUILDS", "GUILD_MESSAGES", "GUILD_MEMBERS"],
    koreanbots: {
        api: {
            token: "KOREANBOTS 토큰"
        }
    },
    koreanbotsClient: {
        updateInterval: 600000 //10분마다 서버 수를 업데이트합니다. (기본값 30분)
    }
})

client.on("ready", () => console.log(`${client.user.tag}로 로그인하였습니다.`))

client.login("토큰")

process.on("SIGINT", () => {
    client.destroy()
    process.exit()
})

• 수동 업데이트

const { Koreanbots } = require("koreanbots")
const Discord = require("discord.js")
const client = new Discord.Client()
const koreanbots = new Koreanbots({
    api: {
        token: "KOREANBOTS 토큰"
    },
    clientID: "봇 아이디"
})

let update = servers => koreanbots.mybot.update({ servers, shards: client.shard?.count }) 
    .then(res => console.log("서버 수를 정상적으로 업데이트하였습니다!\n반환된 정보:" + JSON.stringify(res)))
    .catch(console.error)

client.on("ready", () => {
    console.log(`${client.user.tag}로 로그인하였습니다.`)

    update(client.guilds.cache.size) // 준비 상태를 시작할 때, 최초로 업데이트합니다.
    setInterval(() => update(client.guilds.cache.size), 600000) // 10분마다 서버 수를 업데이트합니다.
})

client.login("토큰")

Author

👤 zero734kr

• 개인 GitHub: @zero734kr
• Organization GitHub: @koreanbots

🤝 도움주기

이슈와 PR은 모두 환영입니다!
무언가 문제가 생겼다면 이슈 페이지에 이슈를 열어주세요.
코드 수정 요청은 PR 페이지에 올려주세요.

서포트

만약 이 모듈이 도움이 되었다면 ⭐️를 눌러주세요!

📝 라이센스

Copyright © 2020-2021 koreanbots.
This project is MIT licensed.

---

This README was generated with ❤️ by readme-md-generator

js-sdk's Issues

autoFlushInterval options of MyBot is too big.

MyBot endpoints are checked frequently. But the cache clear interval is too big. (3600000ms)

Cache not cleaning

cache is not cleaning even the autoFlushInterval pass

sdk 관련 문제

다음과 같은 오류가 뜹니다. 패키지에서 에러가 나는것 같아요ㅠㅠ

Option to disable caching

Discord.js v13 업데이트 필요

v13 버전으로 업데이트 할시 기존 koreanbots 이 작동이 안됩니다. 해결해주시기 바랍니다.

Todo: add support for widgets

Title is the todo

Error: {"code": 400} - Bad Request

new (require("koreanbots").MyBot)(process.env.KOREANBOTS_TOKEN)
    .update(client.guilds.cache.size)
    .catch(e => console.error(e.toString()))

시도시 항상 {"code": 400}를 반환함.

• 버그 적용 버전 목록

• v1.0.9
• v1 최신 버전 - ?
• v2.0.0 - 오류 버전

• 참고할것: 헤더, 캐시, 등

모듈 버그남

sdk 오류

오류 메시지 -
/home/discord/project/bloodmoon/node_modules/koreanbots/src/KoreanbotsClient.js:12
this.options.koreanbotsOptions.interval = options.koreanbotsOptions.interval || 60000 * 30
^

TypeError: Cannot read property 'interval' of undefined
at new KoreanbotsClient (/home/discord/project/bloodmoon/node_modules/koreanbots/src/KoreanbotsClient.js:12:77)
at Object. (/home/discord/project/bloodmoon/bloodmoon.js:13:16)
at Module._compile (internal/modules/cjs/loader.js:1085:14)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:1114:10)
at Module.load (internal/modules/cjs/loader.js:950:32)
at Function.Module._load (internal/modules/cjs/loader.js:790:14)
at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:76:12)
at internal/main/run_main_module.js:17:47

코드 -
const { KoreanbotsClient } = require("koreanbots");
const client = new KoreanbotsClient({
intents: ["GUILDS", "GUILD_MESSAGES", "GUILD_MEMBERS", "DIRECT_MESSAGES"],
koreanbots: {
api: {
token: "비밀"
}
},
koreanbotsClient: {
updateInterval: 600000
}
})

v3 migration link not working

잘못된 링크

---

koreanbots js sdk의 v2 -> v3 마이그레이션 가이드의 링크가 작동하지 않습니다

예상되는 정상적인 동작

---

링크가 작동해야 합니다

버전

---

koreanbots sdk: v3.0.0

AVIF image widget support

오타

Bot.js 114번줄 버젼 오타 수정 부탁드립니다

[버그] Cannot read property 'options' of undefined.

재현방법

저한테만 발생하는 것인지 잘은 모르겠으나, 봇을 켜놓고 몇시간 지속적으로 기다리다 보면 에러가 뜹니다.
[ 단순히 모듈 업데이트를 안해서 에러가 뜨는 것이라 생각했는데 업데이트를 해도 뜹니다. ]

예상되는 정상적인 동작

에러가 뜨지 않고 프로세스가 그대로 유지되어야 합니다.

발생한 문제

Cannot read property 'options' of undefined. 에러가 뜨고 프로세스가 재시작됩니다.

클라이언트 버전

Node.js = 14.7.0 / Npm = 6.14.7 / Koreanbots = 2.0.4

사양

Windows 10 1903 [Build 18362.959]

확인

• 중복되는 이슈는 없나요?
• 해당 버그를 다시 발생시킬 수 있나요?

오류 내용을 영어도 추가해줬으면

뭐 그냥 요청 사항이긴한데 오류가 한글이라 영문만 지원하는 터미널에선 깨진답니다 ㅠㅠ..
영어도 추가해줬으면 좋겠네요.

라이브러리 타입 사용 안됨

https://github.com/koreanbots/js-sdk/blob/master/src/types.ts:33

API에선 라이브러리의 데이터도 함께 넘겨주지만 사용되지 않는거 같습니다.

Import using paths

Use typescript config paths.

"paths" : {
  "@util/*": ["src/util/*"]
}

Like this

Should consider sharded bot

If bot is sharded, only server count of that shard would be updated.

Supporting v2 API

Should support v2 API before v2 release.

Reference

BaseURL

Beta(For now):

beta.koreanbots.dev/api

Production

koreanbots.dev/api

Document

https://github.com/koreanbots/api-docs

To-do

• Get User
• Get Bot
• Widget
• Update Server

Bug: Memory Leak vulnerability

koreanbots의 자바스크립트 라이브러리에서 memory leak 공격이 가능한 심각한 버그를 찾았습니다. 캐시 시스템을 개발할때 이를 고려하지 못한 제 잘못이며 지금 해당 수정본을 개발 중입니다.

제 프라이빗 프로젝트 개발 중에 사용 중인 힙 메모리가 1.5GB에 육박하는것을 보고 메모리 누수된 곳을 찾다가 발견 되었으며 라이브러리 내부 구조를 잘 살펴보시면 어떤 부분이 memory leak를 일으키는지 알아내실수 있을겁니다. (보안 상의 이유 때문에 여기서 밝히진 않겠습니다)

해당 라이브러리의 개발자인 제 명백한 잘못이며, 오해 없으시길 바랍니다.

죄송합니다.

라이선스 지정 안됨

types.ts Librarys -> Libraries

복수형 오타

간단한 오타가 있습니다.

Discord.js v11에는 필요없는 cache 가 붙어있습니다.