buzzk 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Emin-G
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,192 @@
+<img  src="https://github.com/Emin-G/Img/blob/main/buzzk/buzzk_pamplet.gif?raw=true" alt="BuzzkThumb" width="100%">
+
+#  뿌지직
+
+<p align="center">
+<img  src="https://github.com/Emin-G/Img/blob/main/buzzk/buzzk_favi-min.png?raw=true" alt="BUZZK" width="30%">
+</p>
+
+<p align="center">
+뿌지직은 치지직 챗봇을 더욱 쉽게 개발할 수 있도록 돕는 비공식 라이브러리 입니다.
+</p>
+<p align="center">
+챗봇 개발에 초점이 맞춰저 있어, 여러 계정에 동시 로그인할 수 없습니다.
+</p>
+
+---
+
+##  설치
+
+1. 이 레포지토리를 다운받아 프로젝트 폴더 안에 넣어주세요.
+2. 폴더 이름을 `buzzk-master` 에서 `buzzk` 으로 변경해주세요.
+3.  `const buzzk = require("./buzzk");`
+
+##  빠른. 시작.
+
+    const buzzk = require("./buzzk");
+    buzzk.login("NID_AUT 쿠키 값", "NID_SES 쿠키 값");
+    
+    const buzzkChat = buzzk.chat;
+    
+    async function test () {
+    
+        let chSearch = await buzzk.channel.getChannel("녹두로로"); //채널 검색
+        
+        let channel = chSearch[0]; //검색 결과 첫번째 채널
+    
+        const lvDetail = await buzzk.live.getLiveDetail(channel.channelID); //현재 방송 정보
+    
+        let chat = new buzzkChat(channel.channelID);
+        await chat.connect(); //채팅창 연결
+    
+        let recentChat = await chat.getRecentChat(); //최근 채팅 가져오기 (기본값 50개)
+        console.log(recentChat);
+    
+        chat.onMessage((data) => { //채팅이 왔을 때
+            for (let o in data) {
+                console.log(data[o].message);
+
+				if (data[o].message === "!ping") await chat.send("pong!");
+				//채팅 보내기 (login 후에만 가능)
+            }
+        });
+        
+    }
+    
+    test();
+
+##  사용법
+
+> login
+
+    buzzk.login("NID_AUT 쿠키 값", "NID_SES 쿠키 값");
+
+dotenv와 함께 사용하는 것을 매우 권장합니다.
+
+    buzzk.login(process.env.NID_AUT, process.env.NID_SES);
+
+---
+
+> channel
+
+    let chSearch = await buzzk.channel.getChannel("녹두로로");
+    console.log(chSearch);
+
+<details>
+<summary>Return 값 보기</summary>
+
+ - Return
+	 - channelID
+	 - name
+	 - description
+	 - follower
+	 - imageURL
+	 - isLive
+
+</details>
+
+---
+
+> live
+
+    const lvDetail = await buzzk.live.getLiveDetail("channelID 값");
+    console.log(lvDetail);
+
+<details>
+<summary>Return 값 보기</summary>
+
+ - Return
+	 - channelID
+	 - channel
+	 - chatID
+	 - userCount
+		 - now
+		 - total
+	 - title
+	 - startOn
+	 - closeOn
+	 - status
+	 - polling
+
+</details>
+
+    const lvStatus = await buzzk.live.getLiveStatus("channelID 값");
+    console.log(lvStatus);
+
+<details>
+<summary>Return 값 보기</summary>
+
+ - Return
+	 - channelID
+	 - chatID
+	 - userCount
+		 - now
+		 - total
+	 - title
+	 - status
+	 - polling
+
+</details>
+
+---
+
+> chat
+
+    const buzzkChat = buzzk.chat;
+    let chat = new buzzkChat("channelID 값");
+    await chat.connect(); //채팅창 연결
+
+>
+
+    let recentChat = await chat.getRecentChat(갯수); //최근 채팅 가져오기 (기본값 50개)
+    console.log(recentChat);
+
+<details>
+<summary>Return 값 보기</summary>
+
+ - Return
+	 - 0
+		 - author
+			 - id
+			 - name
+			 - imageURL
+		 - message
+		 - time
+	 - 1
+	 - 2
+	 - 3
+	 - ...
+
+</details>
+
+    chat.onMessage((data) => { //채팅이 왔을 때
+    	console.log(data);
+    
+	    for (let o in data) {
+	        console.log(data[o].message); //메세지만 전부 꺼내기
+        }
+    });
+
+<details>
+<summary>Return 값 보기</summary>
+
+ - Return
+	 - 0
+		 - author
+			 - id
+			 - name
+			 - imageURL
+		 - message
+		 - time
+	 - 1
+	 - 2
+	 - 3
+	 - ...
+
+</details>
+
+    await chat.send("ㅋㅋㅋㅋㅋㅋ"); //채팅 보내기 (login 후에만 가능)
+
+> 
+
+    chat.disconnect(); //채팅창 연결 끊기

package/lib/channel.js

@@ -0,0 +1,36 @@
+const { reqChzzk } = require("./tool.js");
+
+class chzzkChannel {
+    constructor(channelID, name, description, follower, imageURL, isLive) {
+        this.channelID = channelID;
+        this.name = name;
+        this.description = description;
+        this.follower = follower;
+        this.imageURL = imageURL;
+        this.isLive = isLive;
+    }
+}
+
+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");
+        chSearch = chSearch.content.data;
+
+        if (!chSearch) return resolve();
+
+        let chRes = new Map();
+
+        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);
+        }
+
+        return resolve(chRes);
+
+    });
+}
+
+module.exports = {
+    getChannel: getChannel
+}

package/lib/chat.js

@@ -0,0 +1,223 @@
+const { getLiveStatus } = require("./live.js");
+const { reqGame } = require("./tool.js");
+
+const { WebSocket } = require("ws");
+
+class chzzkChat {
+    constructor(channelID) {
+        this.channelID = channelID;
+    }
+
+    //Private
+    #ws; //Chat Web Socket
+    #ssID; //kr-ss?.chat.naver.com/chat
+    #accTkn; //Account Access Token
+    #svcid; //game
+    #sid;
+    #chatID;
+    //Private
+
+    connect() {
+        return new Promise(async (resolve, reject) => {
+            //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");
+
+            this.#accTkn = accRes.content.accessToken;
+            //Get accTkn
+    
+            //Load Balancing
+            this.#ssID = Math.floor(Math.random() * 10) + 1;
+            //Load Balancing
+    
+            //Connect Web Socket
+            this.#ws = new WebSocket("wss://kr-ss" + this.#ssID + ".chat.naver.com/chat");
+            //Connect Web Socket
+
+            //WS Open
+            this.#ws.on("open", () => {
+                console.log("[WS] Connected!");
+
+                //WS First Connect
+                let connectOpt = {
+                    "ver": "2",
+                    "cmd": 100,
+                    "svcid": "game",
+                    "cid": this.#chatID,
+                    "bdy": {
+                        "uid":"7d98a20c25251e404ca61d0981bb1ab9",
+                        "devType":2001,
+                        "accTkn": this.#accTkn,
+                        "auth":"SEND"
+                    },
+                    "tid": 1
+                };
+    
+                this.#ws.send(JSON.stringify(connectOpt));
+                //WS First Connect
+            });
+            //WS Open
+
+            this.#ws.on("error", console.error);
+
+            this.#ws.on("close", () => {
+                console.log("[WS] Disconnect!");
+            });
+
+            //WS Message
+            this.#ws.on("message", (data) => {    
+                data = JSON.parse(data);
+    
+                //Update Var
+                if (data.cid) this.#chatID = data.cid;
+                if (data.svcid) this.#svcid = data.svcid;
+                if (data.bdy && data.bdy.sid) this.#sid = data.bdy.sid;
+                //Update Var
+    
+                //Ping Pong
+                if (data.cmd == 0) {
+                    let pongOpt = {
+                        "ver": "2",
+                        "cmd": 10000
+                    };
+                    this.#ws.send(JSON.stringify(pongOpt));
+                }
+                //Ping Pong
+    
+                //Connected
+                else if (data.cmd == 10100) resolve();
+                //Connected
+            });
+            //WS Message
+
+        });
+    }
+
+    send(message) {
+        return new Promise(async (resolve, reject) => {
+
+            let extras = {
+                "chatType":"STREAMING",
+                "osType":"PC",
+                "streamingChannelId": this.channelID,
+                "emojis":""
+            }
+
+            //WS Send
+            let date = new Date();
+            let sendOpt = {
+                "ver": "2",
+                "cmd": 3101,
+                "svcid": this.#svcid,
+                "cid": this.#chatID,
+                "sid": this.#sid,
+                "retry": false,
+                "bdy": {
+                    "msg": message,
+                    "msgTypeCode": 1,
+                    "extras": JSON.stringify(extras),
+
+                    "msgTime": date.getTime()
+                },
+                "tid": 3
+            };
+
+            this.#ws.send(JSON.stringify(sendOpt));
+
+            return resolve();
+            //WS Send
+
+        });
+    }
+
+    onMessage(callback) {
+        if (!this.#ws) return callback(null);
+
+        this.#ws.on("message", (data) => {
+            data = JSON.parse(data);
+
+            if (data.cmd == 93101) {
+                
+                data = data.bdy;
+                let msgList = new Map();
+
+                for (let o in data) {
+                    data[o].profile = JSON.parse(data[o].profile);
+
+                    msgList[Object.keys(msgList).length] = {
+                        author: {
+                            id: data[o].uid,
+                            name: data[o].profile.nickname,
+                            imageURL: data[o].profile.profileImageUrl
+                        },
+                        message: data[o].msg,
+                        time: data[o].msgTime
+                    };
+                }
+
+                callback(msgList);
+
+            }
+        });
+    }
+
+    getRecentChat(size) {
+        return new Promise(async (resolve, reject) => {
+            if (!this.#ws) return resolve(null);
+
+            let reqOpt = {
+                "ver": "2",
+                "cmd": 5101,
+                "svcid": this.#svcid,
+                "cid": this.#chatID,
+                "sid": this.#sid,
+                "bdy": {
+                    "recentMessageCount": size || 50
+                },
+                "tid": 2
+            };
+
+            this.#ws.send(JSON.stringify(reqOpt));
+
+            this.#ws.on("message", (data) => {
+                data = JSON.parse(data);
+
+                if (data.cmd == 15101) {
+                    data = data.bdy.messageList;
+                    let msgList = new Map();
+    
+                    for (let o in data) {
+                        data[o].profile = JSON.parse(data[o].profile);
+    
+                        msgList[Object.keys(msgList).length] = {
+                            author: {
+                                id: data[o].userId,
+                                name: data[o].profile.nickname,
+                                imageURL: data[o].profile.profileImageUrl
+                            },
+                            message: data[o].content,
+                            time: data[o].messageTime
+                        };
+                    }
+    
+                    return resolve(msgList);
+                }
+
+            });
+
+        });
+    }
+
+    disconnect() {
+        this.#ws.close();
+    }
+}
+
+module.exports = {
+    chzzkChat: chzzkChat
+}

package/lib/index.js

@@ -0,0 +1,7 @@
+module.exports = {
+    channel: require("./channel.js"),
+    chat: require("./chat.js").chzzkChat,
+    live: require("./live.js"),
+    
+    login: require("./val.js").login
+}

package/lib/live.js

@@ -0,0 +1,49 @@
+const { reqChzzk } = require("./tool.js");
+
+async function getLiveDetail (channelID) {
+    return new Promise(async (resolve, reject) => {
+
+        let res = await reqChzzk("service/v2/channels/" + channelID + "/live-detail");
+        res = res.content;
+
+        let lvDetail = {
+            channelID: res.channel.channelId,
+            channel: res.channel,
+            chatID: res.chatChannelId,
+            userCount: { now: res.concurrentUserCount, total: res.accumulateCount },
+            title: res.liveTitle,
+            startOn: res.openDate,
+            closeOn: res.closeDate,
+            status: res.status,
+            polling: JSON.parse(res.livePollingStatusJson)
+        }
+
+        return resolve(lvDetail);
+
+    });
+}
+
+async function getLiveStatus (channelID) {
+    return new Promise(async (resolve, reject) => {
+
+        let res = await reqChzzk("polling/v2/channels/" + channelID + "/live-status");
+        res = res.content;
+
+        let lvStatus = {
+            channelID: channelID,
+            chatID: res.chatChannelId,
+            userCount: { now: res.concurrentUserCount, total: res.accumulateCount },
+            title: res.liveTitle,
+            status: res.status,
+            polling: JSON.parse(res.livePollingStatusJson)
+        }
+        
+        return resolve(lvStatus);
+
+    });
+}
+
+module.exports = {
+    getLiveDetail: getLiveDetail,
+    getLiveStatus: getLiveStatus
+}

package/lib/tool.js

@@ -0,0 +1,36 @@
+const { chzzkBaseURL, gameBaseURL, NID } = require("./val.js");
+
+function reqChzzk (path) {
+    return new Promise(async (resolve, reject) => {
+
+        fetch(chzzkBaseURL + path, {
+            method: "GET",
+            headers: {
+                "Cookie": "NID_AUT=" + NID.AUT + ";NID_SES=" + NID.SES
+            }
+        })
+
+        .then((response) => resolve(response.json()));
+        
+    });
+}
+
+function reqGame (path) {
+    return new Promise(async (resolve, reject) => {
+
+        fetch(gameBaseURL + path, {
+            method: "GET",
+            headers: {
+                "Cookie": "NID_AUT=" + NID.AUT + ";NID_SES=" + NID.SES
+            }
+        })
+
+        .then((response) => resolve(response.json()));
+        
+    });
+}
+
+module.exports = {
+    reqChzzk: reqChzzk,
+    reqGame: reqGame
+}

package/lib/val.js

@@ -0,0 +1,19 @@
+const chzzkBaseURL = "https://api.chzzk.naver.com/";
+const gameBaseURL = "https://comm-api.game.naver.com/";
+
+let NID = {
+    AUT: null,
+    SES: null
+}
+
+function login (NID_AUT, NID_SES) {
+    NID.AUT = NID_AUT;
+    NID.SES = NID_SES;
+}
+
+module.exports = {
+    chzzkBaseURL: chzzkBaseURL,
+    gameBaseURL: gameBaseURL,
+    NID: NID,
+    login: login
+}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "buzzk",
+  "displayName": "BUZZK",
+  "version": "1.0.0",
+  "description": "뿌지직 (BUZZK) - 치지직(CHZZK) 챗봇을 더욱 쉽게 개발할 수 있도록 돕는 비공식 라이브러리.",
+  "main": "lib/index.js",
+  "directories": {
+    "lib": "lib"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": {
+    "name": "Emin-G",
+    "email": "dev.mingowo@gmail.com"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Emin-G/buzzk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Emin-G/buzzk/issues"
+  },
+  "homepage": "https://github.com/Emin-G/buzzk",
+  "keywords": ["chzzk", "buzzk", "치지직", "뿌지직"]
+}