buzzk 1.1.0 → 1.3.0

package/README.md

@@ -1,9 +1,9 @@
-<img  src="https://github.com/Emin-G/Img/blob/main/buzzk/buzzk_pamplet.gif?raw=true" alt="BuzzkThumb" width="100%">
+<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%">
+<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">
@@ -15,8 +15,20 @@
 
 ---
 
-##  업데이트 내역
+##  📖 업데이트 내역
 
+ - 함수 이름 수정
+
+	**하단의 1.3.0 마이그레이션 가이드 참고**
+
+>
+
+ - channelID로 채널 정보 가져오기 함수 추가
+ - ws 라이브러리 종속성 추가
+
+>
+
+ - 자동완성 기능 지원
  - 팔로우 / 언팔로우 기능 추가
  - live.getLiveDetail의 Return 값에 chatLimit 추가 (팔로우 대상 채팅 등...)
  - 폴링 함수 추가 (chatID 변경 감지)
@@ -24,12 +36,75 @@
  - chat.disconnect 함수 보완
  - 버전 체크 함수 추가
 
-##  설치
+##  ✒️ 마이그레이션 가이드 (v.1.3.0)
+
+<details>
+<summary>펼쳐보기</summary>
+
+	buzzk.channel
+
+| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_change-min.png?raw=true"  alt="BUZZK"  width="70"> | buzzk.channel.getChannel |
+|--|--|
+|  | buzzk.channel.search |
+
+---
+
+| <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 |
+
+---
+
+| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_change-min.png?raw=true"  alt="BUZZK"  width="70"> | buzzk.channel.unFollowChannel |
+|--|--|
+|  | buzzk.channel.unFollow |
+
+---
+
+	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 |
+|--|--|
+|  | buzzk.live.getDetail |
+
+---
+
+| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_change-min.png?raw=true"  alt="BUZZK"  width="70"> | buzzk.live.getLiveStatus |
+|--|--|
+|  | buzzk.live.getStatus |
+
+---
+
+	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 |
+
+---
+
+| <img src="https://github.com/Emin-G/Img/blob/main/tags/tag_change-min.png?raw=true"  alt="BUZZK"  width="70"> | (return).channel.channelImageUrl |
+|--|--|
+|  | (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 |
+|--|--|
+
+</details>
+
+##  👋 설치
 
 1. `npm install buzzk`
 2. `const buzzk = require("buzzk");`
 
-##  빠른. 시작.
+##  🔥 빠른. 시작.
 
     const buzzk = require("buzzk");
     buzzk.login("NID_AUT 쿠키 값", "NID_SES 쿠키 값");
@@ -38,11 +113,11 @@
     
     async function test () {
     
-        let chSearch = await buzzk.channel.getChannel("녹두로로"); //채널 검색
+        let chSearch = await buzzk.channel.search("녹두로로"); //채널 검색
         
         let channel = chSearch[0]; //검색 결과 첫번째 채널
     
-        const lvDetail = await buzzk.live.getLiveDetail(channel.channelID); //현재 방송 정보
+        const lvDetail = await buzzk.live.getDetail(channel.channelID); //현재 방송 정보
     
         let chat = new buzzkChat(channel.channelID);
         await chat.connect(); //채팅창 연결
@@ -50,7 +125,7 @@
         let recentChat = await chat.getRecentChat(); //최근 채팅 가져오기 (기본값 50개)
         console.log(recentChat);
     
-        chat.onMessage((data) => { //채팅이 왔을 때
+        chat.onMessage(async (data) => { //채팅이 왔을 때
             for (let o in data) {
                 console.log(data[o].message);
 
@@ -63,9 +138,9 @@
     
     test();
 
-##  사용법
+##  🎀 사용법
 
-> login
+###  login
 
     buzzk.login("NID_AUT 쿠키 값", "NID_SES 쿠키 값");
 
@@ -75,13 +150,34 @@ dotenv와 함께 사용하는 것을 매우 권장합니다.
 
 ---
 
-> channel
+###  channel
 
-    let chSearch = await buzzk.channel.getChannel("녹두로로");
+    let chSearch = await buzzk.channel.search("녹두로로");
     console.log(chSearch);
 
 <details>
-<summary>Return 값 보기</summary>
+<summary>return</summary>
+
+ - Return
+	 - 0
+		- channelID
+		- name
+		- description
+		- follower
+		- imageURL
+		- isLive
+	 - 1
+	 - 2
+	 - 3
+	 - ...
+
+</details>
+
+    let channel = await buzzk.channel.get("channelID 값");
+    console.log(channel);
+
+<details>
+<summary>return</summary>
 
  - Return
 	 - channelID
@@ -93,25 +189,27 @@ dotenv와 함께 사용하는 것을 매우 권장합니다.
 
 </details>
 
-    await buzzk.channel.followChannel("channelID 값");
+    await buzzk.channel.follow("channelID 값");
 
 >
 
-    await buzzk.channel.unFollowChannel("channelID 값");
+    await buzzk.channel.unFollow("channelID 값");
 
 ---
 
-> live
+###  live
 
-    const lvDetail = await buzzk.live.getLiveDetail("channelID 값");
+    const lvDetail = await buzzk.live.getDetail("channelID 값");
     console.log(lvDetail);
 
 <details>
-<summary>Return 값 보기</summary>
+<summary>return</summary>
 
  - Return
 	 - channelID
 	 - channel
+		 - name
+		 - imageURL
 	 - chatID
 	 - chatLimit //팔로워 전용 채팅 등...
 	 - userCount
@@ -125,11 +223,11 @@ dotenv와 함께 사용하는 것을 매우 권장합니다.
 
 </details>
 
-    const lvStatus = await buzzk.live.getLiveStatus("channelID 값");
+    const lvStatus = await buzzk.live.getStatus("channelID 값");
     console.log(lvStatus);
 
 <details>
-<summary>Return 값 보기</summary>
+<summary>return</summary>
 
  - Return
 	 - channelID
@@ -145,7 +243,7 @@ dotenv와 함께 사용하는 것을 매우 권장합니다.
 
 ---
 
-> chat
+###  chat
 
     const buzzkChat = buzzk.chat;
     let chat = new buzzkChat("channelID 값");
@@ -157,7 +255,7 @@ dotenv와 함께 사용하는 것을 매우 권장합니다.
     console.log(recentChat);
 
 <details>
-<summary>Return 값 보기</summary>
+<summary>return</summary>
 
  - Return
 	 - 0
@@ -183,7 +281,7 @@ dotenv와 함께 사용하는 것을 매우 권장합니다.
     });
 
 <details>
-<summary>Return 값 보기</summary>
+<summary>callback</summary>
 
  - Return
 	 - 0

package/lib/channel.js

@@ -11,7 +11,25 @@ class chzzkChannel {
     }
 }
 
-async function getChannel (keyword) {
+/**
+ * @typedef {Object.<number, chzzkChannel>} chzzkChannels
+ */
+
+/**
+ * @typedef {Object} chzzkChannel
+ * @property {string} channelID
+ * @property {string} name
+ * @property {string} description
+ * @property {string} follower
+ * @property {string} imageURL
+ * @property {boolean} isLive
+ */
+
+/**
+ * @param {string} keyword
+ * @returns {Promise<chzzkChannels>}
+ */
+async function search (keyword) {
     return new Promise(async (resolve, reject) => {
 
         let chSearch = await reqChzzk("service/v1/search/channels?keyword=" + keyword + "&offset=0&size=13&withFirstChannelContent=false");
@@ -32,7 +50,30 @@ async function getChannel (keyword) {
     });
 }
 
-async function followChannel (channelID) {
+
+/**
+ * @param {string} channelID
+ * @returns {Promise<chzzkChannel>}
+ */
+async function get (channelID) {
+    return new Promise(async (resolve, reject) => {
+
+        let chGet = await reqChzzk("service/v1/channels/" + 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);
+
+        return resolve(chRes);
+
+    });
+}
+
+/**
+ * @param {string} channelID
+ * @returns {Promise<boolean>}
+ */
+async function follow (channelID) {
     return new Promise(async (resolve, reject) => {
 
         let flRes = await exChzzk("POST", "service/v1/channels/" + channelID + "/follow");
@@ -42,7 +83,11 @@ async function followChannel (channelID) {
     });
 }
 
-async function unFollowChannel (channelID) {
+/**
+ * @param {string} channelID
+ * @returns {Promise<boolean>}
+ */
+async function unFollow (channelID) {
     return new Promise(async (resolve, reject) => {
 
         let flRes = await exChzzk("DELETE", "service/v1/channels/" + channelID + "/follow");
@@ -53,7 +98,8 @@ async function unFollowChannel (channelID) {
 }
 
 module.exports = {
-    getChannel: getChannel,
-    followChannel: followChannel,
-    unFollowChannel: unFollowChannel
+    search: search,
+    get: get,
+    follow: follow,
+    unFollow: unFollow
 }

package/lib/chat.js

@@ -1,4 +1,4 @@
-const { getLiveStatus } = require("./live.js");
+const { getStatus } = require("./live.js");
 const { reqGame } = require("./tool.js");
 
 const { WebSocket } = require("ws");
@@ -19,12 +19,15 @@ class chzzkChat {
     #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);
+            let cidRes = await getStatus(this.channelID);
             this.#chatID = cidRes.chatID;
             //Get ChatID
 
@@ -105,6 +108,10 @@ class chzzkChat {
         });
     }
 
+    /**
+     * @param {string} message 
+     * @returns {Promise<boolean>}
+     */
     send(message) {
         return new Promise(async (resolve, reject) => {
             if (!this.#ws) return resolve(null);
@@ -143,6 +150,27 @@ class chzzkChat {
         });
     }
 
+    /**
+     * @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);
 
@@ -174,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);
@@ -221,6 +253,9 @@ class chzzkChat {
         });
     }
 
+    /**
+     * @returns {Promise<boolean>}
+     */
     async disconnect() {
         return new Promise(async (resolve, reject) => {
             if (!this.#ws) return resolve(null);
@@ -236,7 +271,7 @@ class chzzkChat {
         this.#pollingStatus = true;
 
         //Get ChatID
-        let cidRes = await getLiveStatus(this.channelID);
+        let cidRes = await getStatus(this.channelID);
         this.#chatID = cidRes.chatID;
         //Get ChatID
 

package/lib/live.js

@@ -1,6 +1,37 @@
 const { reqChzzk } = require("./tool.js");
 
-async function getLiveDetail (channelID) {
+/**
+ * @typedef {Object} chzzkLiveDetail
+ * @property {string} channelID
+ * @property {channelInfo} 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} channelInfo
+ * @property {string} name
+ * @property {string} imageURL
+ */
+
+/**
+ * @typedef {Object} userCount
+ * @property {number} now
+ * @property {number} total
+ */
+
+/**
+ * @param {string} channelID
+ * @returns {Promise<chzzkLiveDetail>}
+ */
+async function getDetail (channelID) {
     return new Promise(async (resolve, reject) => {
 
         let res = await reqChzzk("service/v2/channels/" + channelID + "/live-detail");
@@ -9,7 +40,7 @@ async function getLiveDetail (channelID) {
 
         let lvDetail = {
             channelID: res.channel.channelId,
-            channel: res.channel,
+            channel: { name: res.channel.channelName, imageURL: res.channel.channelImageUrl },
             chatID: res.chatChannelId,
             chatLimit: res.chatAvailableGroup,
             userCount: { now: res.concurrentUserCount, total: res.accumulateCount },
@@ -25,7 +56,22 @@ async function getLiveDetail (channelID) {
     });
 }
 
-async function getLiveStatus (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 getStatus (channelID) {
     return new Promise(async (resolve, reject) => {
 
         let res = await reqChzzk("polling/v2/channels/" + channelID + "/live-status");
@@ -47,6 +93,6 @@ async function getLiveStatus (channelID) {
 }
 
 module.exports = {
-    getLiveDetail: getLiveDetail,
-    getLiveStatus: getLiveStatus
+    getDetail: getDetail,
+    getStatus: getStatus
 }

package/lib/val.js

@@ -6,6 +6,10 @@ 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

@@ -11,7 +11,7 @@ async function check () {
     remotePkg = String(remotePkg.version).split(".");
 
     for (let v in remotePkg) {
-        if (parseInt(remotePkg[v]) > parseInt(localPkg[v])) return console.log("[BUZZK] 새로운 버전을 찾았습니다! ( 현재 버전 : " + localPkg.join(".") + " / 새로운 버전 : " + remotePkg.join(".") + " )");
+        if (parseInt(remotePkg[v]) > parseInt(localPkg[v])) return console.log("[BUZZK] 새로운 버전을 찾았습니다! ( npm install buzzk@" + remotePkg.join(".") + " )");
     }
 }
 

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "buzzk",
   "displayName": "BUZZK",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "뿌지직 (BUZZK) - 치지직(CHZZK) 챗봇을 더욱 쉽게 개발할 수 있도록 돕는 비공식 라이브러리.",
   "main": "lib/index.js",
+  "type": "commonjs",
   "directories": {
     "lib": "lib"
   },
@@ -23,5 +24,13 @@
     "url": "https://github.com/Emin-G/buzzk/issues"
   },
   "homepage": "https://github.com/Emin-G/buzzk",
-  "keywords": ["chzzk", "buzzk", "치지직", "뿌지직"]
+  "keywords": [
+    "chzzk",
+    "buzzk",
+    "치지직",
+    "뿌지직"
+  ],
+  "dependencies": {
+    "ws": "^8.16.0"
+  }
 }