buzzk 1.0.0 → 1.2.0

package/README.md

@@ -15,15 +15,27 @@
 
 ---
 
+##  업데이트 내역
+
+ - 자동완성 기능 지원
+
+>
+
+ - 팔로우 / 언팔로우 기능 추가
+ - live.getLiveDetail의 Return 값에 chatLimit 추가 (팔로우 대상 채팅 등...)
+ - 폴링 함수 추가 (chatID 변경 감지)
+ - API 호출 실패 시 오류 핸들링 (Return true / null)
+ - chat.disconnect 함수 보완
+ - 버전 체크 함수 추가
+
 ##  설치
 
-1. 이 레포지토리를 다운받아 프로젝트 폴더 안에 넣어주세요.
-2. 폴더 이름을 `buzzk-master` 에서 `buzzk` 으로 변경해주세요.
-3.  `const buzzk = require("./buzzk");`
+1. `npm install buzzk`
+2. `const buzzk = require("buzzk");`
 
 ##  빠른. 시작.
 
-    const buzzk = require("./buzzk");
+    const buzzk = require("buzzk");
     buzzk.login("NID_AUT 쿠키 값", "NID_SES 쿠키 값");
     
     const buzzkChat = buzzk.chat;
@@ -85,6 +97,12 @@ dotenv와 함께 사용하는 것을 매우 권장합니다.
 
 </details>
 
+    await buzzk.channel.followChannel("channelID 값");
+
+>
+
+    await buzzk.channel.unFollowChannel("channelID 값");
+
 ---
 
 > live
@@ -99,6 +117,7 @@ dotenv와 함께 사용하는 것을 매우 권장합니다.
 	 - channelID
 	 - channel
 	 - chatID
+	 - chatLimit //팔로워 전용 채팅 등...
 	 - userCount
 		 - now
 		 - total
@@ -189,4 +208,4 @@ dotenv와 함께 사용하는 것을 매우 권장합니다.
 
 > 
 
-    chat.disconnect(); //채팅창 연결 끊기
+    await chat.disconnect(); //채팅창 연결 끊기

package/lib/channel.js

@@ -1,4 +1,4 @@
-const { reqChzzk } = require("./tool.js");
+const { reqChzzk, exChzzk } = require("./tool.js");
 
 class chzzkChannel {
     constructor(channelID, name, description, follower, imageURL, isLive) {
@@ -11,13 +11,32 @@ class chzzkChannel {
     }
 }
 
+/**
+ * @typedef {Object.<number, chzzkChannel>} chzzkChannels
+ */
+
+/**
+ * @typedef {Object} chzzkChannel
+ * @property {string} channelID
+ * @property {string} name
+ * @property {string} description
+ * @property {string} follower
+ * @property {string} imageURL
+ * @property {string} isLive
+ */
+
+/**
+ * @param {string} keyword
+ * @returns {Promise<chzzkChannels>}
+ */
 async function getChannel (keyword) {
     return new Promise(async (resolve, reject) => {
 
         let chSearch = await reqChzzk("service/v1/search/channels?keyword=" + keyword + "&offset=0&size=13&withFirstChannelContent=false");
+        if (chSearch.code != 200) return resolve(null);
         chSearch = chSearch.content.data;
 
-        if (!chSearch) return resolve();
+        if (!chSearch) return resolve(null);
 
         let chRes = new Map();
 
@@ -31,6 +50,36 @@ async function getChannel (keyword) {
     });
 }
 
+/**
+ * @param {string} channelID
+ * @returns {Promise<boolean>}
+ */
+async function followChannel (channelID) {
+    return new Promise(async (resolve, reject) => {
+
+        let flRes = await exChzzk("POST", "service/v1/channels/" + channelID + "/follow");
+        if (flRes.code == 200) return resolve(true);
+        else return resolve(null);
+
+    });
+}
+
+/**
+ * @param {string} channelID
+ * @returns {Promise<boolean>}
+ */
+async function unFollowChannel (channelID) {
+    return new Promise(async (resolve, reject) => {
+
+        let flRes = await exChzzk("DELETE", "service/v1/channels/" + channelID + "/follow");
+        if (flRes.code == 200) return resolve(true);
+        else return resolve(null);
+
+    });
+}
+
 module.exports = {
-    getChannel: getChannel
+    getChannel: getChannel,
+    followChannel: followChannel,
+    unFollowChannel: unFollowChannel
 }

package/lib/chat.js

@@ -15,19 +15,25 @@ class chzzkChat {
     #svcid; //game
     #sid;
     #chatID;
+
+    #pollingStatus = false;
     //Private
 
+    /**
+     * @returns {Promise<boolean>}
+     */
     connect() {
         return new Promise(async (resolve, reject) => {
+            if (this.#ws) return resolve(null);
+
             //Get ChatID
             let cidRes = await getLiveStatus(this.channelID);
-
             this.#chatID = cidRes.chatID;
             //Get ChatID
 
             //Get accTkn
             let accRes = await reqGame("nng_main/v1/chats/access-token?channelId=" + this.#chatID + "&chatType=STREAMING");
-
+            if (accRes.code != 200) return resolve(null);
             this.#accTkn = accRes.content.accessToken;
             //Get accTkn
     
@@ -39,6 +45,10 @@ class chzzkChat {
             this.#ws = new WebSocket("wss://kr-ss" + this.#ssID + ".chat.naver.com/chat");
             //Connect Web Socket
 
+            //SetPolling
+            if (!this.#pollingStatus) this.polling();
+            //SetPolling
+
             //WS Open
             this.#ws.on("open", () => {
                 console.log("[WS] Connected!");
@@ -90,7 +100,7 @@ class chzzkChat {
                 //Ping Pong
     
                 //Connected
-                else if (data.cmd == 10100) resolve();
+                else if (data.cmd == 10100) resolve(true);
                 //Connected
             });
             //WS Message
@@ -98,8 +108,13 @@ class chzzkChat {
         });
     }
 
+    /**
+     * @param {string} message 
+     * @returns {Promise<boolean>}
+     */
     send(message) {
         return new Promise(async (resolve, reject) => {
+            if (!this.#ws) return resolve(null);
 
             let extras = {
                 "chatType":"STREAMING",
@@ -129,12 +144,33 @@ class chzzkChat {
 
             this.#ws.send(JSON.stringify(sendOpt));
 
-            return resolve();
+            return resolve(true);
             //WS Send
 
         });
     }
 
+    /**
+     * @typedef {Object.<number, chzzkMessage>} chzzkMessages
+     */
+
+    /**
+     * @typedef {Object} chzzkMessage
+     * @property {chzzkMessageAuthor} author
+     * @property {string} message
+     * @property {number} time
+     */
+
+    /**
+     * @typedef {Object} chzzkMessageAuthor
+     * @property {string} id
+     * @property {string} name
+     * @property {string} imageURL
+     */
+
+    /**
+     * @param {function(chzzkMessages)} callback
+     */
     onMessage(callback) {
         if (!this.#ws) return callback(null);
 
@@ -166,6 +202,10 @@ class chzzkChat {
         });
     }
 
+    /**
+     * @param {?number} size
+     * @return {Promise<chzzkMessages>}
+     */
     getRecentChat(size) {
         return new Promise(async (resolve, reject) => {
             if (!this.#ws) return resolve(null);
@@ -213,8 +253,31 @@ class chzzkChat {
         });
     }
 
-    disconnect() {
-        this.#ws.close();
+    /**
+     * @returns {Promise<boolean>}
+     */
+    async disconnect() {
+        return new Promise(async (resolve, reject) => {
+            if (!this.#ws) return resolve(null);
+
+            await this.#ws.close();
+            this.#ws = null;
+            return resolve(true);
+        });
+    }
+
+    async polling () {
+        if (!this.#ws) return this.#pollingStatus = false;
+        this.#pollingStatus = true;
+
+        //Get ChatID
+        let cidRes = await getLiveStatus(this.channelID);
+        this.#chatID = cidRes.chatID;
+        //Get ChatID
+
+        setTimeout(() => {
+            return this.polling();
+        }, cidRes.polling.callPeriodMilliSecond);
     }
 }
 

package/lib/index.js

@@ -1,3 +1,5 @@
+require("./vm.js");
+
 module.exports = {
     channel: require("./channel.js"),
     chat: require("./chat.js").chzzkChat,

package/lib/live.js

@@ -1,15 +1,42 @@
 const { reqChzzk } = require("./tool.js");
 
+/**
+ * @typedef {Object} chzzkLiveDetail
+ * @property {string} channelID
+ * @property {Object} channel
+ * @property {string} chatID
+ * @property {string} chatLimit
+ * @property {userCount} userCount
+ * @property {string} title
+ * @property {string} startOn
+ * @property {string} closeOn
+ * @property {string} status
+ * @property {Object} polling
+ * 
+ */
+
+/**
+ * @typedef {Object} userCount
+ * @property {number} now
+ * @property {number} total
+ */
+
+/**
+ * @param {string} channelID
+ * @returns {Promise<chzzkLiveDetail>}
+ */
 async function getLiveDetail (channelID) {
     return new Promise(async (resolve, reject) => {
 
         let res = await reqChzzk("service/v2/channels/" + channelID + "/live-detail");
+        if (res.code != 200) return resolve(null);
         res = res.content;
 
         let lvDetail = {
             channelID: res.channel.channelId,
             channel: res.channel,
             chatID: res.chatChannelId,
+            chatLimit: res.chatAvailableGroup,
             userCount: { now: res.concurrentUserCount, total: res.accumulateCount },
             title: res.liveTitle,
             startOn: res.openDate,
@@ -23,10 +50,26 @@ async function getLiveDetail (channelID) {
     });
 }
 
+/**
+ * @typedef {Object} chzzkLiveStatus
+ * @property {string} channelID
+ * @property {string} chatID
+ * @property {userCount} userCount
+ * @property {string} title
+ * @property {string} status
+ * @property {Object} polling
+ * 
+ */
+
+/**
+ * @param {string} channelID
+ * @returns {Promise<chzzkLiveStatus>}
+ */
 async function getLiveStatus (channelID) {
     return new Promise(async (resolve, reject) => {
 
         let res = await reqChzzk("polling/v2/channels/" + channelID + "/live-status");
+        if (res.code != 200) return resolve(null);
         res = res.content;
 
         let lvStatus = {

package/lib/tool.js

@@ -15,6 +15,21 @@ function reqChzzk (path) {
     });
 }
 
+function exChzzk (method, path) {
+    return new Promise(async (resolve, reject) => {
+
+        fetch(chzzkBaseURL + path, {
+            method: method,
+            headers: {
+                "Cookie": "NID_AUT=" + NID.AUT + ";NID_SES=" + NID.SES
+            }
+        })
+
+        .then((response) => resolve(response.json()));
+        
+    });
+}
+
 function reqGame (path) {
     return new Promise(async (resolve, reject) => {
 
@@ -32,5 +47,6 @@ function reqGame (path) {
 
 module.exports = {
     reqChzzk: reqChzzk,
+    exChzzk: exChzzk,
     reqGame: reqGame
 }

package/lib/val.js

@@ -6,6 +6,11 @@ let NID = {
     SES: null
 }
 
+
+/**
+ * @param {string} NID_AUT
+ * @param {string} NID_SES
+ */
 function login (NID_AUT, NID_SES) {
     NID.AUT = NID_AUT;
     NID.SES = NID_SES;

package/lib/vm.js

@@ -0,0 +1,18 @@
+async function check () {
+
+    let localPkg = require("../package.json");
+    let remotePkg = await fetch("https://raw.githubusercontent.com/Emin-G/buzzk/master/package.json");
+
+    if (remotePkg.status != 200) return console.log("[BUZZK] 최신 버전에 대한 정보를 불러오지 못했습니다.");
+
+    remotePkg = await remotePkg.json();
+
+    localPkg = String(localPkg.version).split(".");
+    remotePkg = String(remotePkg.version).split(".");
+
+    for (let v in remotePkg) {
+        if (parseInt(remotePkg[v]) > parseInt(localPkg[v])) return console.log("[BUZZK] 새로운 버전을 찾았습니다! ( npm install buzzk@" + remotePkg.join(".") + " )");
+    }
+}
+
+check();

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "buzzk",
   "displayName": "BUZZK",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "뿌지직 (BUZZK) - 치지직(CHZZK) 챗봇을 더욱 쉽게 개발할 수 있도록 돕는 비공식 라이브러리.",
   "main": "lib/index.js",
+  "type": "commonjs",
   "directories": {
     "lib": "lib"
   },