Fix members only stream error & update video metadata

CHANGELOG.md

@@ -1,5 +1,52 @@
 # Changelog
 
+## v1.3.0
+
+### New
+
+- Add `ErrorAction`, `UnknownAction`
+- Add `BotError`
+
+### Improvements
+
+- Update from [stu43005/masterchat](https://github.com/stu43005/masterchat)
+  - Commit: [5e30cf71ee0c9b7739e59cdcf92402f7794b7ee5](https://github.com/stu43005/masterchat/commit/5e30cf71ee0c9b7739e59cdcf92402f7794b7ee5)
+  - `addBannerToLiveChatCommand`
+  - `addChatItemAction`
+- #1 Updated version of timeoutParams() (@FlashlightXi)
+- Update interfaces
+  - `YTAnyText`
+  - `YTPlayabilityStatus`
+- `MembersOnlyError` should have additional data
+- `parseMetadataFromWatch` should handle more edge cases
+  - Chat can be available even when `playabilityStatus` not exist
+  - `MembersOnly` chat should be available when stream ended
+
+## v1.2.0
+
+### New
+
+- Add `isUpcoming`
+- Add `isMembersOnly`
+- Add `videoMetadata` following format [VideoObject](./src/interfaces/yt/metadata.ts)
+
+### Improvements
+
+- Add more field on `Credentials` for members-only live stream
+
+  - `__Secure-1PAPISID`
+  - `__Secure-1PSID`
+  - `__Secure-1PSIDTS`
+  - `__Secure-1PSIDCC`
+
+- Error parsing action `parseAction` should not crash
+- Change access modifier of `get`, `post`, `postWithRetry` to `protected`
+
+### Fixes
+
+- Milestone message duration parsing error
+- Question text from `parseShowLiveChatActionPanelAction` realted to poll
+
 ## v1.1.0
 
 ### New

MANUAL.md

@@ -113,7 +113,7 @@ await mc
   .iter()
   .filter((action) => action.type === "addChatItemAction") // only chat events
   .map((chat) => JSON.stringify(chat) + "\n") // convert to JSONL
-  .forEach((jsonl) => appendFile("./chats.jsonl", jsonl)) // append to the file
+  .forEach((jsonl) => appendFile("./chats.jsonl", jsonl)); // append to the file
 ```
 
 ### Chat moderation bot
@@ -248,7 +248,7 @@ const mc = await Masterchat.init("<videoId>", { axiosInstance });
 
 ## Reference
 
-[API Documentation](https://holodata.github.io/masterchat)
+[API Documentation](https://sigvt.github.io/masterchat)
 
 ### Action type
 

README.md

@@ -1,20 +1,20 @@
 # Masterchat
 
-[![npm](https://badgen.net/npm/v/masterchat)](https://npmjs.org/package/masterchat)
-[![npm: total downloads](https://badgen.net/npm/dt/masterchat)](https://npmjs.org/package/masterchat)
-[![npm: publish size](https://badgen.net/packagephobia/publish/masterchat)](https://npmjs.org/package/masterchat)
-[![typedoc](https://badgen.net/badge/docs/typedoc/purple)](https://holodata.github.io/masterchat/)
+[![npm](https://badgen.net/npm/v/@hitomaru/masterchat)](https://npmjs.org/package/@hitomaru/masterchat)
+[![npm: total downloads](https://badgen.net/npm/dt/@hitomaru/masterchat)](https://npmjs.org/package/@hitomaru/masterchat)
+[![npm: publish size](https://badgen.net/packagephobia/publish/@hitomaru/masterchat)](https://npmjs.org/package/@hitomaru/masterchat)
+[![typedoc](https://badgen.net/badge/docs/typedoc/purple)](https://sigvt.github.io/masterchat/)
 
 Masterchat is the most powerful library for YouTube Live Chat, supporting parsing 20+ actions, video comments and transcripts, as well as sending messages and moderating chats.
 
 ## Install
 
 ```
-npm install masterchat
+npm install @hitomaru/masterchat
 ```
 
 ```js
-import { Masterchat, stringify } from "masterchat";
+import { Masterchat, stringify } from "@hitomaru/masterchat";
 
 const mc = await Masterchat.init("oyxvhJW1Cf8");
 

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "masterchat",
+  "name": "@hitomaru/masterchat",
   "description": "JavaScript library for YouTube Live Chat",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "author": "Yasuaki Uechi <y@uechi.io> (https://uechi.io/)",
   "scripts": {
     "build": "cross-env NODE_ENV=production rollup -c && shx rm -rf lib/lib lib/*.map && patch lib/masterchat.d.ts patches/fix-dts.patch",
@@ -30,6 +30,7 @@
   ],
   "dependencies": {
     "axios": "^0.27.2",
+    "cheerio": "^1.0.0-rc.12",
     "debug": "^4.3.2",
     "iterator-helpers-polyfill": "^2.2.8",
     "sha1": "^1.1.1"
@@ -64,13 +65,13 @@
     "typedoc": "^0.22.16",
     "typescript": "^4.7.2"
   },
-  "homepage": "https://github.com/holodata/masterchat",
+  "homepage": "https://github.com/HitomaruKonpaku/masterchat",
   "repository": {
     "type": "git",
-    "url": "https://github.com/holodata/masterchat.git"
+    "url": "git+https://github.com/HitomaruKonpaku/masterchat.git"
   },
   "bugs": {
-    "url": "https://github.com/holodata/masterchat/issues"
+    "url": "https://github.com/HitomaruKonpaku/masterchat/issues"
   },
   "license": "Apache-2.0",
   "keywords": [

src/chat/actions/addBannerToLiveChatCommand.ts

@@ -1,9 +1,14 @@
+import { toUnknownAction } from "..";
 import {
   AddBannerAction,
-  AddRedirectBannerAction,
+  AddIncomingRaidBannerAction,
+  AddOutgoingRaidBannerAction,
+  AddProductBannerAction,
+  AddChatSummaryBannerAction,
+  AddCallForQuestionsBannerAction,
 } from "../../interfaces/actions";
 import { YTAddBannerToLiveChatCommand } from "../../interfaces/yt/chat";
-import { debugLog, stringify, tsToDate } from "../../utils";
+import { debugLog, endpointToUrl, stringify, tsToDate } from "../../utils";
 import { parseBadges } from "../badge";
 import { pickThumbUrl } from "../utils";
 
@@ -13,20 +18,12 @@ export function parseAddBannerToLiveChatCommand(
   // add pinned item
   const bannerRdr = payload["bannerRenderer"]["liveChatBannerRenderer"];
 
-  if (
-    bannerRdr.header &&
-    bannerRdr.header.liveChatBannerHeaderRenderer.icon.iconType !== "KEEP"
-  ) {
-    debugLog(
-      "[action required] Unknown icon type (addBannerToLiveChatCommand)",
-      JSON.stringify(bannerRdr.header)
-    );
-  }
-
   // banner
   const actionId = bannerRdr.actionId;
   const targetId = bannerRdr.targetId;
   const viewerIsCreator = bannerRdr.viewerIsCreator;
+  const isStackable = bannerRdr.isStackable;
+  const bannerType = bannerRdr.bannerType;
 
   // contents
   const contents = bannerRdr.contents;
@@ -40,7 +37,7 @@ export function parseAddBannerToLiveChatCommand(
     const authorName = stringify(rdr.authorName);
     const authorPhoto = pickThumbUrl(rdr.authorPhoto);
     const authorChannelId = rdr.authorExternalChannelId;
-    const { isVerified, isOwner, isModerator, membership } = parseBadges(rdr);
+    const badges = parseBadges(rdr);
 
     // header
     const header = bannerRdr.header!.liveChatBannerHeaderRenderer;
@@ -65,33 +62,137 @@ export function parseAddBannerToLiveChatCommand(
       authorName,
       authorPhoto,
       authorChannelId,
-      isVerified,
-      isOwner,
-      isModerator,
-      membership,
+      ...badges,
       viewerIsCreator,
       contextMenuEndpointParams:
         rdr.contextMenuEndpoint?.liveChatItemContextMenuEndpoint.params,
     };
     return parsed;
-  } else if ("liveChatBannerRedirectRenderer" in contents) {
-    // TODO:
+  }
+
+  if ("liveChatBannerRedirectRenderer" in contents) {
     const rdr = contents.liveChatBannerRedirectRenderer;
-    const authorName = rdr.bannerMessage.runs[0].text;
+    const targetVideoId =
+      "watchEndpoint" in rdr.inlineActionButton.buttonRenderer.command
+        ? rdr.inlineActionButton.buttonRenderer.command.watchEndpoint.videoId
+        : undefined;
+
+    const photo = pickThumbUrl(rdr.authorPhoto);
+
+    if (targetVideoId) {
+      // Outgoing
+      const targetName = rdr.bannerMessage.runs[1].text;
+      const payload: AddOutgoingRaidBannerAction = {
+        type: "addOutgoingRaidBannerAction",
+        actionId,
+        targetId,
+        targetName,
+        targetPhoto: photo,
+        targetVideoId,
+      };
+      return payload;
+    } else {
+      // Incoming
+      const sourceName = rdr.bannerMessage.runs[0].text;
+      const payload: AddIncomingRaidBannerAction = {
+        type: "addIncomingRaidBannerAction",
+        actionId,
+        targetId,
+        sourceName,
+        sourcePhoto: photo,
+      };
+      return payload;
+    }
+  }
+
+  if ("liveChatProductItemRenderer" in contents) {
+    const rdr = contents.liveChatProductItemRenderer;
+    const title = rdr.title;
+    const description = rdr.accessibilityTitle;
+    const thumbnail = rdr.thumbnail.thumbnails[0].url;
+    const price = rdr.price;
+    const vendorName = rdr.vendorName;
+    const creatorMessage = rdr.creatorMessage;
+    const creatorName = rdr.creatorName;
     const authorPhoto = pickThumbUrl(rdr.authorPhoto);
-    const payload: AddRedirectBannerAction = {
-      type: "addRedirectBannerAction",
+    const url = endpointToUrl(rdr.onClickCommand)!;
+
+    if (!url) {
+      debugLog(
+        `Empty url at liveChatProductItemRenderer: ${JSON.stringify(rdr)}`
+      );
+    }
+
+    const dialogMessage =
+      rdr.informationDialog.liveChatDialogRenderer.dialogMessages;
+    const isVerified = rdr.isVerified;
+
+    const payload: AddProductBannerAction = {
+      type: "addProductBannerAction",
       actionId,
       targetId,
-      authorName,
+      viewerIsCreator,
+      isStackable,
+      title,
+      description,
+      thumbnail,
+      price,
+      vendorName,
+      creatorMessage,
+      creatorName,
       authorPhoto,
+      url,
+      dialogMessage,
+      isVerified,
     };
     return payload;
-  } else {
-    throw new Error(
-      `[action required] Unrecognized content type found in parseAddBannerToLiveChatCommand: ${JSON.stringify(
-        payload
-      )}`
-    );
   }
+
+  if ("liveChatCallForQuestionsRenderer" in contents) {
+    const rdr = contents.liveChatCallForQuestionsRenderer;
+    const creatorAvatar = rdr.creatorAvatar.thumbnails[0].url;
+    const creatorAuthorName = stringify(rdr.creatorAuthorName);
+    const questionMessage = rdr.questionMessage.runs;
+
+    const parsed: AddCallForQuestionsBannerAction = {
+      type: "addCallForQuestionsBannerAction",
+      actionId,
+      targetId,
+      isStackable,
+      bannerType,
+      creatorAvatar,
+      creatorAuthorName,
+      questionMessage,
+    };
+    return parsed;
+  }
+
+  if ("liveChatBannerChatSummaryRenderer" in contents) {
+    const rdr = contents.liveChatBannerChatSummaryRenderer;
+    const id = rdr.liveChatSummaryId;
+    const timestampUsec = id.split("_").at(-1)!;
+    const timestamp = tsToDate(timestampUsec);
+    const chatSummary = rdr.chatSummary.runs;
+
+    const parsed: AddChatSummaryBannerAction = {
+      type: "addChatSummaryBannerAction",
+      id,
+      actionId,
+      targetId,
+      isStackable,
+      bannerType,
+      timestampUsec,
+      timestamp,
+      chatSummary,
+    };
+    return parsed;
+  }
+
+  debugLog(
+    `[action required] Unrecognized content type found in parseAddBannerToLiveChatCommand: ${JSON.stringify(
+      payload
+    )}`
+  );
+
+  return toUnknownAction(payload);
 }