refactor(types): Type enhancements

[mister-ben]

Several changes for Typescript.

• Adds a jsdoc plugin to not break on @template {xyz} T. Replaces uses of T with Class.<xyz>
• Adds definitions for ComponentOptions, SourceObject, PlayerOptions, MediaObject
• Removes further uses of ~ namespacing in jsdoc, which tsc fails to understand
• Changes track kinds to simple union types. Change the existing definitions to enums so we can use them as object lookups without conflicting with the standard definitions.
• Use native TextTrackCue, TextTrackCue definitions.
• Exports Player, PlayerOptions and Plugin from video.js.
  • This makes it easier to add to the object than at present e.g. in a plugin to declare module 'video.js' { interface Player {
  • This sets a precedent - what else could/should be exported at this level? Should the names be more verbose?
• Adds additional jsdoc on for track and readyState in HTMLTrackElement, as tsc doesn't understand documentation for properties added with Object.defineProperties . Fixes HTMLTrackElement class provided missing two properties as stated in MDN #8959

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.13%. Comparing base (8842d37) to head (4e5dbb1).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #8968   +/-   ##
=======================================
  Coverage   84.13%   84.13%           
=======================================
  Files         120      120           
  Lines        8117     8119    +2     
  Branches     1948     1948           
=======================================
+ Hits         6829     6831    +2     
  Misses       1288     1288           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[mister-ben]

This allows adding to the Player interface in plugins:

declare module 'video.js' {
  interface Player {
    touchOverlay: TouchOverlay;
    touchOverlayDirect: TouchOverlay;
    mobileUi: {
      (options?: MobileUiPluginOptions): void;
      VERSION: string;
    }
  }
}

[mister-ben]

Renders like this in the API docs with the changes to jsdoc-typeof-plugin:

[amtins]

Do you think it's possible to modify the regex so that this case is also handled?

    class CustomComponent extends Component{
      __z(){}
    }
    const Custom = Component.registerComponent('CustomComponent', CustomComponent);
    const custom = new Custom(player);

Instead of:

We would have:

[mister-ben]

Thanks! The latest commit should cover that.

[amtins]

Based on my previous comment, if the regex could handle @template {typeof Component} T we could have:

  /**
   * 
   * @template {typeof Component} T
   * 
   * Register a `Component` with `videojs` given the name and the component.
   *
   * > NOTE: {@link Tech}s should not be registered as a `Component`. {@link Tech}s
   *         should be registered using {@link Tech.registerTech} or
   *         {@link videojs:videojs.registerTech}.
   *
   * > NOTE: This function can also be seen on videojs as
   *         {@link videojs:videojs.registerComponent}.
   *
   * @param {string} name
   *        The name of the `Component` to register.
   *
   * @param {T} ComponentToRegister
   *        The `Component` class to register.
   *
   * @return {T}
   *         The `Component` that was registered.
   */