buzzk 1.11.3 → 2.0.1

package/README.md

@@ -17,97 +17,59 @@
 
 ##  📖 업데이트 내역
 
- - 채팅 채널 연결을 유지하지 못하는 문제 완벽 해결
+ ### 🎉 2.0 업데이트
+ - 공식 API를 일부 지원하기 시작했어요!
 
->
-
- - video 함수 추가
-
->
-
- - 채팅 채널 연결을 유지하지 못하는 문제 해결
-
->
-
- - 채팅 채널이 없을 때 오류가 생기는 문제 해결
-
->
-
- - onDonation 함수 추가
-
- - 본인 인증 채팅 지원 추가
-
->
-
- - 채팅 데이터에 hasMod 항목 추가
-
->
-
- - JSON을 Parse 하는 중 오류가 생기는 문제 해결
-
-> 
+> [!CAUTION]
+> 이 버전 이후부터는 공식 API와 비공식 API를 혼용하여 사용합니다.
+> 공식 API로 대체 가능한 기능은 모두 공식 API를 이용할 예정입니다.
 
- - User-Agent 추가 (API 호출에 실패하는 문제 해결)
+> [!WARNING]
+> * 비공식 API 전용 모듈은 더 이상 지원되지 않습니다.
+> * 비공식 API로만 이루어진 모듈을 사용하시려면
+> `npm install buzzk@1.11.3`
 
-##  ✒️ 마이그레이션 가이드 (v.1.2.x -> v.1.3.0)
+##  ✒️ 마이그레이션 가이드 (v.1.x -> v.2.0.0)
 
 <details>
 <summary>펼쳐보기</summary>
 
-	buzzk.channel
+	buzzk.auth
 
-| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_change-min.png?raw=true"  alt="BUZZK"  width="70"> | buzzk.channel.getChannel |
+| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_change-min.png?raw=true"  alt="BUZZK"  width="70"> | 추가 |
 |--|--|
-|  | buzzk.channel.search |
+|  | buzzk.auth |
 
 ---
 
-| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_change-min.png?raw=true"  alt="BUZZK"  width="70"> | buzzk.channel.followChannel |
-|--|--|
-|  | buzzk.channel.follow |
-
----
+	buzzk.oauth
 
-| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_change-min.png?raw=true"  alt="BUZZK"  width="70"> | buzzk.channel.unFollowChannel |
+| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_change-min.png?raw=true"  alt="BUZZK"  width="70"> | 추가 |
 |--|--|
-|  | buzzk.channel.unFollow |
+|  | buzzk.oauth.get |
 
 ---
 
-	buzzk.live
-
-| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_change-min.png?raw=true"  alt="BUZZK"  width="70"> | buzzk.live.getLiveDetail |
+| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_change-min.png?raw=true"  alt="BUZZK"  width="70"> | 추가 |
 |--|--|
-|  | buzzk.live.getDetail |
+|  | buzzk.oauth.refresh |
 
 ---
 
-| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_change-min.png?raw=true"  alt="BUZZK"  width="70"> | buzzk.live.getLiveStatus |
+| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_change-min.png?raw=true"  alt="BUZZK"  width="70"> | 추가 |
 |--|--|
-|  | buzzk.live.getStatus |
+|  | buzzk.channel.resolve |
 
 ---
 
-	buzzk.live.getDetail (getLiveDetail)
-
-| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_change-min.png?raw=true"  alt="BUZZK"  width="70"> | (return).channel.channelName |
-|--|--|
-|  | (return).channel.name |
-
----
+	buzzk.channel.get
 
-| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_change-min.png?raw=true"  alt="BUZZK"  width="70"> | (return).channel.channelImageUrl |
+| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_delete-min.png?raw=true"  alt="BUZZK"  width="70"> | (return).channel.description |
 |--|--|
-|  | (return).channel.imageURL |
 
 ---
 
-| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_delete-min.png?raw=true"  alt="BUZZK"  width="70"> | (return).channel.channelId |
-|--|--|
-
----
-
-| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_delete-min.png?raw=true"  alt="BUZZK"  width="70"> | (return).channel.verifiedMark |
+| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_delete-min.png?raw=true"  alt="BUZZK"  width="70"> | (return).channel.isLive |
 |--|--|
 
 </details>
@@ -120,6 +82,7 @@
 ##  🔥 빠른. 시작.
 
     const buzzk = require("buzzk");
+	buzzk.auth("ClientID 값", "ClientSecret 값");
     buzzk.login("NID_AUT 쿠키 값", "NID_SES 쿠키 값");
     
     const buzzkChat = buzzk.chat;
@@ -161,6 +124,22 @@
 
 ##  🎀 사용법
 
+###  auth
+
+✅ Official API
+
+    buzzk.auth("ClientID 값", "ClientSecret 값");
+
+https://developers.chzzk.naver.com/application
+네이버 치지직 개발자 센터에서 등록 후 사용 가능합니다.
+✅ Official API 표기가 있는 모든 함수에서 사용됩니다.
+
+dotenv와 함께 사용하는 것을 매우 권장합니다.
+
+    buzzk.auth(process.env.CLIENT_ID, process.env.CLIENT_SECRET);
+
+---
+
 ###  login
 
     buzzk.login("NID_AUT 쿠키 값", "NID_SES 쿠키 값");
@@ -171,6 +150,56 @@ dotenv와 함께 사용하는 것을 매우 권장합니다.
 
 ---
 
+###  oauth
+
+✅ Official API
+
+    let oauth = await buzzk.oauth.get("Code 값");
+    console.log(oauth);
+
+<details>
+<summary>return</summary>
+
+ - Return
+	 - access
+	 - refresh
+	 - expireIn
+
+</details>
+
+✅ Official API
+
+    let oauth = await buzzk.oauth.refresh("refreshToken 값");
+    console.log(oauth);
+
+<details>
+<summary>return</summary>
+
+ - Return
+	 - access
+	 - refresh
+	 - expireIn
+
+</details>
+
+✅ Official API
+
+    let oauth = await buzzk.oauth.resolve("accessToken 값");
+    console.log(oauth);
+
+<details>
+<summary>return</summary>
+
+ - Return
+	 - channelID
+	 - name
+	 - follower
+	 - imageURL
+
+</details>
+
+---
+
 ###  channel
 
     let chSearch = await buzzk.channel.search("녹두로로");
@@ -194,6 +223,8 @@ dotenv와 함께 사용하는 것을 매우 권장합니다.
 
 </details>
 
+✅ Official API
+
     let channel = await buzzk.channel.get("channelID 값");
     console.log(channel);
 
@@ -203,10 +234,8 @@ dotenv와 함께 사용하는 것을 매우 권장합니다.
  - Return
 	 - channelID
 	 - name
-	 - description
 	 - follower
 	 - imageURL
-	 - isLive
 
 </details>
 

package/lib/channel.js

@@ -1,13 +1,11 @@
-const { reqChzzk, exChzzk } = require("./tool.js");
+const { CLIENT, reqChzzk, exChzzk } = require("./tool.js");
 
 class chzzkChannel {
-    constructor(channelID, name, description, follower, imageURL, isLive) {
+    constructor(channelID, name, follower, imageURL) {
         this.channelID = channelID;
         this.name = name;
-        this.description = description;
         this.follower = follower;
         this.imageURL = imageURL;
-        this.isLive = isLive;
     }
 }
 
@@ -19,10 +17,8 @@ class chzzkChannel {
  * @typedef {Object} chzzkChannel
  * @property {string} channelID
  * @property {string} name
- * @property {string} description
  * @property {string} follower
  * @property {string} imageURL
- * @property {boolean} isLive
  */
 
 /**
@@ -42,7 +38,7 @@ async function search (keyword) {
 
         for (let o in chSearch) {
             let tempChannel = chSearch[o].channel;
-            chRes[Object.keys(chRes).length] = new chzzkChannel(tempChannel.channelId, tempChannel.channelName, tempChannel.channelDescription, tempChannel.followerCount, tempChannel.channelImageUrl, tempChannel.openLive);
+            chRes[Object.keys(chRes).length] = new chzzkChannel(tempChannel.channelId, tempChannel.channelName, tempChannel.followerCount, tempChannel.channelImageUrl);
         }
 
         return resolve(chRes);
@@ -58,11 +54,12 @@ async function search (keyword) {
 async function get (channelID) {
     return new Promise(async (resolve, reject) => {
 
-        let chGet = await reqChzzk("service/v1/channels/" + channelID);
+        let chGet = await CLIENT.get("open/v1/channels?channelIds=" + channelID);
         if (chGet.code != 200) return resolve(null);
-        chGet = chGet.content;
 
-        let chRes = new chzzkChannel(chGet.channelId, chGet.channelName, chGet.channelDescription, chGet.followerCount, chGet.channelImageUrl, chGet.openLive);
+        chGet = chGet.content.data[0];
+
+        let chRes = new chzzkChannel(chGet.channelId, chGet.channelName, chGet.followerCount, chGet.channelImageUrl);
 
         return resolve(chRes);
 

package/lib/index.js

@@ -4,7 +4,9 @@ module.exports = {
     channel: require("./channel.js"),
     chat: require("./chat.js").chzzkChat,
     live: require("./live.js"),
+    oauth: require("./oauth.js"),
     video: require("./video.js"),
     
+    auth: require("./val.js").auth,
     login: require("./val.js").login
 }

package/lib/oauth.js

@@ -0,0 +1,105 @@
+const { USER, CLIENT } = require("./tool.js");
+const { AUTH, state } = require("./val.js");
+
+const channel = require("./channel.js");
+
+class chzzkToken {
+    constructor(access, refresh, expireIn) {
+        this.access = access;
+        this.refresh = refresh;
+        this.expireIn = expireIn;
+    }
+}
+
+/**
+ * @typedef {Object} chzzkChannel
+ * @property {string} channelID
+ * @property {string} name
+ * @property {string} follower
+ * @property {string} imageURL
+ */
+
+/**
+ * @typedef {Object} chzzkTokenData
+ * @property {string} access
+ * @property {string} refresh
+ * @property {string} expireIn
+ */
+
+/**
+ * @param {string} code
+ * @returns {Promise<chzzkTokenData>}
+ */
+async function get (code) {
+    return new Promise(async (resolve, reject) => {
+        let options = {
+            grantType: "authorization_code",
+            clientId: AUTH.id,
+            clientSecret: AUTH.secret,
+            code: code,
+            state: state
+        }
+
+        options = JSON.stringify(options);
+
+        let oauthGet = await CLIENT.post("auth/v1/token", options);
+        if (oauthGet.code != 200) return resolve(null);
+
+        oauthGet = oauthGet.content;
+
+        let oauthRes = new chzzkToken(oauthGet.accessToken, oauthGet.refreshToken, oauthGet.expiresIn);
+
+        return resolve(oauthRes);
+    });
+}
+
+/**
+ * @param {string} refreshToken
+ * @returns {Promise<chzzkTokenData>}
+ */
+async function refresh (refreshToken) {
+    return new Promise(async (resolve, reject) => {
+        let options = {
+            grantType: "refresh_token",
+            clientId: AUTH.id,
+            clientSecret: AUTH.secret,
+            refreshToken: refreshToken,
+        }
+
+        options = JSON.stringify(options);
+
+        let oauthGet = await CLIENT.post("auth/v1/token", options);
+        if (oauthGet.code != 200) return resolve(null);
+
+        oauthGet = oauthGet.content;
+
+        let oauthRes = new chzzkToken(oauthGet.accessToken, oauthGet.refreshToken, oauthGet.expiresIn);
+
+        return resolve(oauthRes);
+    });
+}
+
+/**
+ * @param {string} accessToken
+ * @returns {Promise<chzzkChannel>}
+ */
+async function resolve (accessToken) {
+    return new Promise(async (resolve, reject) => {
+
+        let oauthGet = await USER.get(accessToken, "open/v1/users/me");
+        if (oauthGet.code != 200) return resolve(null);
+
+        oauthGet = oauthGet.content;
+
+        let oauthChannel = await channel.get(oauthGet.channelId);
+
+        return resolve(oauthChannel);
+
+    });
+}
+
+module.exports = {
+    get: get,
+    refresh: refresh,
+    resolve: resolve
+}

package/lib/tool.js

@@ -1,6 +1,122 @@
-const { chzzkBaseURL, gameBaseURL, naverBaseURL, NID } = require("./val.js");
+const { chzzkAPIURL, chzzkBaseURL, gameBaseURL, naverBaseURL, NID, AUTH } = require("./val.js");
 const vm = require("./vm.js");
 
+function clientGet (path) {
+    return new Promise(async (resolve, reject) => {
+
+        fetch(chzzkAPIURL + path, {
+            method: "GET",
+            headers: {
+                "Client-Id": AUTH.id,
+                "Client-Secret": AUTH.secret,
+                "Content-Type": "application/json",
+                "User-Agent": "BuzzkLib/" + vm.getVersion() + " (Node)"
+            }
+        })
+
+        .then(async (response) => {
+            let json;
+            try {
+                json = await response.json();
+            }
+
+            catch(error) {
+                return resolve({"code": 500});
+            }
+
+            return resolve(json);
+        });
+
+    });
+}
+
+function clientPost (path, body) {
+    return new Promise(async (resolve, reject) => {
+
+        fetch(chzzkAPIURL + path, {
+            method: "POST",
+            headers: {
+                "Client-Id": AUTH.id,
+                "Client-Secret": AUTH.secret,
+                "Content-Type": "application/json",
+                "User-Agent": "BuzzkLib/" + vm.getVersion() + " (Node)"
+            },
+            body: body
+        })
+
+        .then(async (response) => {
+            let json;
+            try {
+                json = await response.json();
+            }
+
+            catch(error) {
+                return resolve({"code": 500});
+            }
+
+            return resolve(json);
+        });
+
+    });
+}
+
+function userGet (token, path) {
+    return new Promise(async (resolve, reject) => {
+
+        fetch(chzzkAPIURL + path, {
+            method: "GET",
+            headers: {
+                "Authorization": "Bearer " + token,
+                "Content-Type": "application/json",
+                "User-Agent": "BuzzkLib/" + vm.getVersion() + " (Node)"
+            }
+        })
+
+        .then(async (response) => {
+            let json;
+            try {
+                json = await response.json();
+            }
+
+            catch(error) {
+                return resolve({"code": 500});
+            }
+
+            return resolve(json);
+        });
+
+    });
+}
+
+function userPost (token, path, body) {
+    return new Promise(async (resolve, reject) => {
+
+        fetch(chzzkAPIURL + path, {
+            method: "POST",
+            headers: {
+                "Authorization": "Bearer " + token,
+                "Content-Type": "application/json",
+                "User-Agent": "BuzzkLib/" + vm.getVersion() + " (Node)"
+            },
+            body: body
+        })
+
+        .then(async (response) => {
+            let json;
+            try {
+                json = await response.json();
+            }
+
+            catch(error) {
+                return resolve({"code": 500});
+            }
+
+            return resolve(json);
+        });
+
+    });
+}
+
 function reqChzzk (path) {
     return new Promise(async (resolve, reject) => {
 
@@ -104,6 +220,14 @@ function reqNaver (path) {
 }
 
 module.exports = {
+    CLIENT: {
+        get: clientGet,
+        post: clientPost
+    },
+    USER: {
+        get: userGet,
+        post: userPost
+    },
     reqChzzk: reqChzzk,
     exChzzk: exChzzk,
     reqGame: reqGame,

package/lib/val.js

@@ -1,12 +1,20 @@
+const chzzkAPIURL = "https://openapi.chzzk.naver.com/";
 const chzzkBaseURL = "https://api.chzzk.naver.com/";
 const gameBaseURL = "https://comm-api.game.naver.com/";
 const naverBaseURL = "https://apis.naver.com/";
 
+const state = "zxclDasdfA25";
+
 let NID = {
     AUT: null,
     SES: null
 }
 
+let AUTH = {
+    id: null,
+    secret: null
+}
+
 /**
  * @param {string} NID_AUT
  * @param {string} NID_SES
@@ -16,10 +24,23 @@ function login (NID_AUT, NID_SES) {
     NID.SES = NID_SES;
 }
 
+/**
+ * @param {string} ClientID
+ * @param {string} ClientSecret
+ */
+function auth (ClientID, ClientSecret) {
+    AUTH.id = ClientID;
+    AUTH.secret = ClientSecret;
+}
+
 module.exports = {
+    chzzkAPIURL: chzzkAPIURL,
     chzzkBaseURL: chzzkBaseURL,
     gameBaseURL: gameBaseURL,
     naverBaseURL: naverBaseURL,
+    state: state,
     NID: NID,
-    login: login
+    AUTH: AUTH,
+    login: login,
+    auth: auth
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "buzzk",
   "displayName": "BUZZK",
-  "version": "1.11.3",
+  "version": "2.0.1",
   "description": "뿌지직 (BUZZK) - 치지직(CHZZK) 챗봇을 더욱 쉽게 개발할 수 있도록 돕는 비공식 라이브러리.",
   "main": "lib/index.js",
   "type": "commonjs",
@@ -31,6 +31,7 @@
     "뿌지직"
   ],
   "dependencies": {
-    "ws": "^8.16.0"
+    "socket.io-client": "^4.8.1",
+    "ws": "^8.18.0"
   }
 }