feat: add videoDetails.chapters (#913)

* feat: add `videoDetails.chapters` closes #625 * docs(example): Update `info.json` * doc(typings): Add `videoDetails.chapters`
fent · May 4, 2021 · 838de41 · 838de41
1 parent 67eb6dd
commit 838de41
Show file tree

Hide file tree

Showing 8 changed files with 21,060 additions and 2,677 deletions.
diff --git a/example/info.json b/example/info.json
diff --git a/lib/info-extras.js b/lib/info-extras.js
@@ -336,3 +336,30 @@ exports.getStoryboards = info => {
     };
   });
 };
+
+/**
+ * Get chapters info.
+ *
+ * @param {Object} info
+ * @returns {Array.<Object>}
+ */
+exports.getChapters = info => {
+  const playerOverlayRenderer = info.response &&
+    info.response.playerOverlays &&
+    info.response.playerOverlays.playerOverlayRenderer;
+  const playerBar = playerOverlayRenderer &&
+    playerOverlayRenderer.decoratedPlayerBarRenderer &&
+    playerOverlayRenderer.decoratedPlayerBarRenderer.decoratedPlayerBarRenderer &&
+    playerOverlayRenderer.decoratedPlayerBarRenderer.decoratedPlayerBarRenderer.playerBar;
+  const markersMap = playerBar &&
+    playerBar.multiMarkersPlayerBarRenderer &&
+    playerBar.multiMarkersPlayerBarRenderer.markersMap;
+  const marker = Array.isArray(markersMap) && markersMap.find(m => m.value && Array.isArray(m.value.chapters));
+  if (!marker) return [];
+  const chapters = marker.value.chapters;
+
+  return chapters.map(chapter => ({
+    title: getText(chapter.chapterRenderer.title),
+    start_time: chapter.chapterRenderer.timeRangeStartMillis / 1000,
+  }));
+};
diff --git a/lib/info.js b/lib/info.js
@@ -72,7 +72,7 @@ exports.getBasicInfo = async(id, options) => {
 
   // Add additional properties to info.
   const media = extras.getMedia(info);
-  let additional = {
+  const additional = {
     author: extras.getAuthor(info),
     media,
     likes: extras.getLikes(info),
@@ -82,6 +82,7 @@ exports.getBasicInfo = async(id, options) => {
     // Give the standard link to the video.
     video_url: BASE_URL + id,
     storyboards: extras.getStoryboards(info),
+    chapters: extras.getChapters(info),
   };
 
   info.videoDetails = extras.cleanVideoDetails(Object.assign({},

diff --git a/test/files/refresh.js b/test/files/refresh.js
@@ -112,6 +112,12 @@ const videos = [
     type: 'longest-upload',
     basicInfo: true,
   },
+  {
+    id: 'W6NZfCO5SIk',
+    type: 'chapters',
+    basicInfo: true,
+    saveInfo: true,
+  },
 ];
 
 

diff --git a/test/files/videos/chapters/expected-info.json b/test/files/videos/chapters/expected-info.json
diff --git a/test/files/videos/chapters/watch.html b/test/files/videos/chapters/watch.html
diff --git a/test/info-extras-test.js b/test/info-extras-test.js
@@ -281,3 +281,26 @@ describe('extras.getStoryboards()', () => {
     });
   });
 });
+
+describe('extras.getChapters()', () => {
+  it('Returns chapters', () => {
+    const info = require('./files/videos/chapters/expected-info.json');
+    const chapters = extras.getChapters(info);
+
+    assert.ok(Array.isArray(chapters) && chapters.length);
+
+    for (const chapter of chapters) {
+      assert.ok(chapter.title);
+      assert.number(chapter.start_time);
+    }
+  });
+
+  describe('With no chapters', () => {
+    it('Returns empty array', () => {
+      const info = infoFromWatchJSON('regular');
+      const chapters = extras.getChapters(info);
+
+      assert.ok(Array.isArray(chapters) && !chapters.length);
+    });
+  });
+});
diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -212,6 +212,11 @@ declare module 'ytdl-core' {
       storyboardCount: number;
     }
 
+    interface Chapter {
+      title: string;
+      start_time: number;
+    }
+
     interface MoreVideoDetails extends Omit<VideoDetails, 'author' | 'thumbnail' | 'shortDescription'>, Omit<MicroformatRenderer, 'title' | 'description'> {
       published: number;
       video_url: string;
@@ -222,6 +227,7 @@ declare module 'ytdl-core' {
       author: Author;
       thumbnails: thumbnail[];
       storyboards: storyboard[];
+      chapters: Chapter[];
       description: string | null;
     }