refactor!: better cross runtime support

.eslintrc.yml

@@ -8,6 +8,12 @@ extends: [ eslint:recommended, 'plugin:@typescript-eslint/recommended' ]
 parser: '@typescript-eslint/parser'
 parserOptions:
   ecmaVersion: latest
+overrides:
+  - 
+    files:
+      - '**/*.js'
+    rules:
+      'tsdoc/syntax': 'off'
 rules:
   max-len:
     - error
@@ -23,6 +29,7 @@ rules:
 
   '@typescript-eslint/ban-types': 'off'
   'tsdoc/syntax': 'warn'
+  '@typescript-eslint/no-explicit-any': 'off'
 
   no-template-curly-in-string: error
   no-unreachable-loop: error

bundle/browser.d.ts

@@ -1 +1 @@
-export * from "../dist/browser";
+export * from '../dist/browser';

index.ts

@@ -2,7 +2,7 @@ import { getRuntime } from './lib/utils/Utils';
 
 // Polyfill fetch for node
 if (getRuntime() === 'node') {
-  const undici = require('undici');
+  const undici = Reflect.get(module, 'require')('undici');
   Reflect.set(globalThis, 'fetch', undici.fetch);
   Reflect.set(globalThis, 'Headers', undici.Headers);
   Reflect.set(globalThis, 'Request', undici.Request);

lib/Innertube.ts

@@ -79,7 +79,7 @@ class Innertube {
   }
   /**
    * Searches a given query.
-   * @param string query - search query.
+   * @param query - search query.
    * @param filters - search filters.
    */
   async search(query: string, filters: SearchFilters = {}) {
@@ -139,7 +139,7 @@ class Innertube {
   }
   /**
    * Retrieves watch history.
-   * Which can also be achieved with {@link getLibrary()}.
+   * Which can also be achieved with {@link getLibrary}.
    */
   async getHistory() {
     const response = await this.actions.browse('FEhistory');
@@ -195,7 +195,7 @@ class Innertube {
    * An alternative to {@link download}.
    * Returns deciphered streaming data.
    *
-   * @note If you wish to retrieve the video info too, have a look at {@link getBasicInfo} or {@link getInfo}.
+   * If you wish to retrieve the video info too, have a look at {@link getBasicInfo} or {@link getInfo}.
    */
   async getStreamingData(video_id: string, options: FormatOptions = {}) {
     const info = await this.getBasicInfo(video_id);
@@ -204,7 +204,7 @@ class Innertube {
   /**
    * Downloads a given video. If you only need the direct download link take a look at {@link getStreamingData}.
    *
-   * @note If you wish to retrieve the video info too, have a look at {@link getBasicInfo} or {@link getInfo}.
+   * If you wish to retrieve the video info too, have a look at {@link getBasicInfo} or {@link getInfo}.
    */
   async download(video_id: string, options?: DownloadOptions) {
     throwIfMissing({ video_id });

lib/core/AccountManager.ts

@@ -4,7 +4,6 @@ import Analytics from '../parser/youtube/Analytics';
 import Proto from '../proto/index';
 import Actions from './Actions';
 
-/** @namespace */
 class AccountManager {
   #actions;
   channel;

lib/core/InteractionManager.ts

@@ -58,7 +58,7 @@ class InteractionManager {
    * Translates a given text using YouTube's comment translate feature.
    *
    * @param target_language - an ISO language code
-   * @param [args] - optional arguments
+   * @param args - optional arguments
    */
   async translate(text: string, target_language: string, args: {
         video_id?: string;

lib/core/Music.ts

@@ -17,12 +17,9 @@ import NavigationEndpoint from '../parser/classes/NavigationEndpoint';
 import MusicDescriptionShelf from '../parser/classes/MusicDescriptionShelf';
 import MusicCarouselShelf from '../parser/classes/MusicCarouselShelf';
 
-/** @namespace */
 class Music {
-  #session;
   #actions;
   constructor(session: Session) {
-    this.#session = session;
     this.#actions = session.actions;
   }
   /**
@@ -125,13 +122,9 @@ class Music {
     if (!upnext_content)
       throw new InnertubeError('Invalid id', video_id);
     return {
-      /** @type {string} */
       id: upnext_content.playlist_id,
-      /** @type {string} */
       title: upnext_content.title,
-      /** @type {boolean} */
       is_editable: upnext_content.is_editable,
-      /** @type {import('../parser/contents/classes/PlaylistPanelVideo')[]} */
       contents: observe(upnext_content.contents)
     };
   }

lib/core/OAuth.ts

@@ -179,24 +179,29 @@ class OAuth {
       headers: Constants.OAUTH.HEADERS
     });
     const response_data = await response.text();
-    const url_body = Constants.OAUTH.REGEX.AUTH_SCRIPT.exec(response_data)![1]; // TODO: probably check this rather than assume.
+    const url_body = Constants.OAUTH.REGEX.AUTH_SCRIPT.exec(response_data)?.[1];
+    if (!url_body)
+      throw new OAuthError('Could not obtain script url.', { status: 'FAILED' });
     const script = await this.#session.http.fetch(url_body, {
       baseURL: Constants.URLS.YT_BASE
     });
     const client_identity = (await script.text())
       .replace(/\n/g, '')
       .match(Constants.OAUTH.REGEX.CLIENT_IDENTITY);
     // TODO: check this.
-    return client_identity!.groups!;
+    const groups = client_identity?.groups;
+    if (!groups)
+      throw new OAuthError('Could not obtain client identity.', { status: 'FAILED' });
+    return groups;
   }
   get credentials() {
     return this.#credentials;
   }
-  validateCredentials() {
+  validateCredentials(): this is this & { credentials: Credentials } {
     return this.#credentials &&
             Reflect.has(this.#credentials, 'access_token') &&
             Reflect.has(this.#credentials, 'refresh_token') &&
-            Reflect.has(this.#credentials, 'expires');
+            Reflect.has(this.#credentials, 'expires') || false;
   }
 }
 export default OAuth;

lib/core/Player.ts

@@ -59,12 +59,14 @@ export default class Player {
     url_components.searchParams.set('ratebypass', 'yes');
     if (signature_cipher || cipher) {
       const signature = this.#signature.decipher(url);
-      args.get('sp') ?
-        url_components.searchParams.set(args.get('sp')!, signature) :
+      const sp = args.get('sp');
+      sp ?
+        url_components.searchParams.set(sp, signature) :
         url_components.searchParams.set('signature', signature);
     }
-    if (url_components.searchParams.get('n')) {
-      const ntoken = this.#ntoken.transform(url_components.searchParams.get('n')!);
+    const n = url_components.searchParams.get('n');
+    if (n) {
+      const ntoken = this.#ntoken.transform(n);
       url_components.searchParams.set('n', ntoken);
     }
     return url_components.toString();

lib/parser/classes/NavigationEndpoint.ts

@@ -35,7 +35,7 @@ class NavigationEndpoint extends YTNode {
     super();
     const name = Object.keys(data || {})
       .find((item) => item.endsWith('Endpoint') || item.endsWith('Command'));
-    this.payload = data?.[name!] || {};
+    this.payload = name ? Reflect.get(data, name) : {};
     if (Reflect.has(this.payload, 'dialog')) {
       this.dialog = Parser.parse(this.payload.dialog);
     }
@@ -178,7 +178,7 @@ class NavigationEndpoint extends YTNode {
     }
   }
   /**
-   * Calls the endpoint. (This is an experiment and may replace {@link call()} in the future.).
+   * Calls the endpoint. (This is an experiment and may replace {@link call} in the future.).
    */
   async callTest(actions: Actions, args = { parse: true, params: {} }) {
     if (!actions)

lib/parser/index.ts

@@ -94,9 +94,17 @@ export default class Parser {
   static #addToMemo(classname: string, result: YTNode) {
     if (!Parser.#memo)
       return;
-    if (!Parser.#memo.has(classname))
+
+    const list = Parser.#memo.get(classname);
+    if (!list)
       return Parser.#memo.set(classname, [ result ]);
-        Parser.#memo.get(classname)!.push(result);
+
+    list.push(result);
+  }
+  static #getMemo() {
+    if (!Parser.#memo)
+      throw new Error('Parser#getMemo() called before Parser#createMemo()');
+    return Parser.#memo;
   }
   /**
    * Parses InnerTube response.
@@ -106,24 +114,24 @@ export default class Parser {
     this.#createMemo();
     // TODO: is this parseItem?
     const contents = Parser.parse(data.contents);
-    const contents_memo = Parser.#memo!;
+    const contents_memo = this.#getMemo();
     // End of memoization
     this.#clearMemo();
     this.#createMemo();
     const on_response_received_actions = data.onResponseReceivedActions ? Parser.parseRR(data.onResponseReceivedActions) : null;
-    const on_response_received_actions_memo = Parser.#memo!;
+    const on_response_received_actions_memo = this.#getMemo();
     this.#clearMemo();
     this.#createMemo();
     const on_response_received_endpoints = data.onResponseReceivedEndpoints ? Parser.parseRR(data.onResponseReceivedEndpoints) : null;
-    const on_response_received_endpoints_memo = Parser.#memo!;
+    const on_response_received_endpoints_memo = this.#getMemo();
     this.#clearMemo();
     this.#createMemo();
     const on_response_received_commands = data.onResponseReceivedCommands ? Parser.parseRR(data.onResponseReceivedCommands) : null;
-    const on_response_received_commands_memo = Parser.#memo!;
+    const on_response_received_commands_memo = this.#getMemo();
     this.#clearMemo();
     this.#createMemo();
     const actions = data.actions ? Parser.parseActions(data.actions) : null;
-    const actions_memo = Parser.#memo!;
+    const actions_memo = this.#getMemo();
     this.#clearMemo();
     return {
       actions,

lib/parser/youtube/LiveChat.ts

@@ -34,8 +34,8 @@ class LiveChat extends EventEmitter {
       throw new InnertubeError('Video has no livechat');
     this.#video_info = video_info;
     this.#actions = video_info.actions;
-    this.#continuation = this.#video_info.livechat!.continuation;
-    this.is_replay = this.#video_info.livechat!.is_replay;
+    this.#continuation = video_info.livechat.continuation;
+    this.is_replay = video_info.livechat.is_replay;
     this.live_metadata = {
       title: null as UpdateTitleAction | null,
       description: null as UpdateDescriptionAction | null,

lib/parser/youtube/Playlist.ts

@@ -40,11 +40,5 @@ class Playlist extends Feed {
       return 'N/A';
     return primary_info.stats[index]?.toString() || 'N/A';
   }
-  /**
-   * @alias videos
-   */
-  get items() {
-    return this.videos;
-  }
 }
 export default Playlist;

lib/parser/youtube/Search.js

@@ -11,7 +11,7 @@ class Search extends Feed {
    */
   constructor(actions, data, already_parsed = false) {
     super(actions, data, already_parsed);
-    const contents = this.page.contents.item().as(TwoColumnSearchResults).primary_contents.item().contents.array()
+    const contents = this.page.contents.item().#as(TwoColumnSearchResults).primary_contents.item().contents.array()
             || this.page.on_response_received_commands[0].contents;
     const secondary_contents = this.page.contents?.secondary_contents?.contents;
     /** @type {object[]} */

lib/parser/youtube/VideoInfo.ts

@@ -145,8 +145,6 @@ class VideoInfo {
     this.watch_next_feed = data?.contents;
     return this;
   }
-  /** @typedef {import('../classes/CompactVideo')} CompactVideo */
-  /** @typedef {import('../classes/CompactMix')} CompactMix */
   /**
    * Retrieves watch next feed continuation.
    */
@@ -157,11 +155,6 @@ class VideoInfo {
     this.#watch_next_continuation = this.watch_next_feed?.pop()?.as(ContinuationItem);
     return this.watch_next_feed?.filterType<CompactVideo | CompactMix>([ CompactVideo, CompactMix ]);
   }
-  /**
-   * API response.
-   *
-   * @typedef {{ success: boolean, status_code: number, data: object }} Response
-   */
   /**
    * Likes the video.
    *

lib/parser/ytmusic/Search.ts

@@ -9,7 +9,6 @@ import RichShelf from '../classes/RichShelf';
 import ReelShelf from '../classes/ReelShelf';
 import ChipCloudChip from '../classes/ChipCloudChip';
 
-/** @namespace */
 class Search {
   #page;
   #actions;
@@ -83,11 +82,9 @@ class Search {
       throw new InnertubeError('Endpoint did not return any data');
     return new Search(response, this.#actions, { is_continuation: true });
   }
-  /** @type {boolean} */
   get has_continuation() {
     return !!this.#continuation;
   }
-  /** @type {string[]} */
   get filters() {
     return this.#header?.key('chips').parsed().array().as(ChipCloudChip).map((chip) => chip.text);
   }

lib/utils/Cache.ts

@@ -47,18 +47,16 @@ export default class UniversalCache {
     const dir = this.cache_dir;
     switch (getRuntime()) {
       case 'deno':
-        {
-          const Deno: any = Reflect.get(globalThis, 'Deno');
-          try {
-            const cwd = await Deno.stat(dir);
-            if (!cwd.isDirectory)
-              throw new Error('An unexpected file was found in place of the cache directory');
-          } catch (e) {
-            if (e instanceof Deno.errors.NotFound)
-              await Deno.mkdir(dir, { recursive: true });
-            else
-              throw e;
-          }
+        const Deno: any = Reflect.get(globalThis, 'Deno');
+        try {
+          const cwd = await Deno.stat(dir);
+          if (!cwd.isDirectory)
+            throw new Error('An unexpected file was found in place of the cache directory');
+        } catch (e) {
+          if (e instanceof Deno.errors.NotFound)
+            await Deno.mkdir(dir, { recursive: true });
+          else
+            throw e;
         }
         break;
 

lib/utils/HTTPClient.ts

@@ -88,7 +88,7 @@ export default class HTTPClient {
       if (oauth.validateCredentials()) {
         // Check if the access token is valid to avoid authorization errors.
         await oauth.checkAccessTokenValidity();
-        request_headers.set('authorization', `Bearer ${oauth.credentials!.access_token}`);
+        request_headers.set('authorization', `Bearer ${oauth.credentials.access_token}`);
         // Remove API key as it is not required when using oauth.
         request_url.searchParams.delete('key');
       }

lib/utils/Utils.ts

@@ -192,7 +192,7 @@ export function timeToSeconds(time: string) {
 /**
  * Converts strings in camelCase to snake_case.
  *
- * @param string The string in camelCase.
+ * @param string - The string in camelCase.
  */
 export function camelToSnake(string: string) {
   return string[0].toLowerCase() + string.slice(1, string.length).replace(/[A-Z]/g, (letter) => `_${letter.toLowerCase()}`);