docs: better docs and types for the API

[ozyx]

Describe your changes:

• Update docs and types for just about all of Open MCT's API
• Export commonly used types from the top level of the typings files
  • This makes common types like DomainObject, Identifier, ObjectPath, etc. available at the root level so they can be used easily in JSDocs
• Removes the alias for EventEmitter so that tsc correctly generates types for classes that extend it

Screen.Recording.2024-07-30.at.11.29.01.AM.mov

All Submissions:

• Have you followed the guidelines in our Contributing document?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?
• Is this a notable change that will require a special callout in the release notes? For example, will this break compatibility with existing APIs or projects that consume these plugins?

Author Checklist

• Changes address original issue?
• Tests included and/or updated with changes?
• Has this been smoke tested?
• Have you associated this PR with a type: label? Note: this is not necessarily the same as the original issue.
• Have you associated a milestone with this PR? Note: leave blank if unsure.
• Testing instructions included in associated issue OR is this a dependency/testcase change?

Reviewer Checklist

• Changes appear to address issue?
• Reviewer has tested changes by following the provided instructions?
• Changes appear not to be breaking changes?
• Appropriate automated tests included?
• Code style and in-line documentation are appropriate?

[codecov]

Codecov Report

Attention: Patch coverage is 84.90566% with 8 lines in your changes missing coverage. Please review.

Project coverage is 56.83%. Comparing base (e3fcbe1) to head (6945652).

Files	Patch %	Lines
src/api/annotation/AnnotationAPI.js	85.00%	3 Missing ⚠️
src/utils/clock/DefaultClock.js	66.66%	2 Missing ⚠️
src/utils/visibility/VisibilityObserver.js	83.33%	2 Missing ⚠️
src/api/composition/CompositionProvider.js	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #7796      +/-   ##
==========================================
- Coverage   57.15%   56.83%   -0.32%     
==========================================
  Files         674      674              
  Lines       27276    27283       +7     
  Branches     2668     2668              
==========================================
- Hits        15589    15506      -83     
- Misses      11347    11437      +90     
  Partials      340      340              

Flag	Coverage Δ
e2e-full	23.52% <22.64%> (-18.46%)	⬇️
e2e-stable	60.83% <84.90%> (-0.01%)	⬇️
unit	49.40% <65.38%> (-0.04%)	⬇️

Files	Coverage Δ
example/exampleUser/ExampleUserProvider.js	83.60% <ø> (ø)
example/generator/SinewaveStalenessProvider.js	100.00% <ø> (ø)
openmct.js	100.00% <100.00%> (ø)
src/MCT.js	96.93% <ø> (ø)
src/api/Editor.js	90.90% <ø> (ø)
src/api/actions/ActionCollection.js	83.58% <ø> (ø)
src/api/actions/ActionsAPI.js	96.15% <100.00%> (ø)
src/api/composition/CompositionAPI.js	100.00% <ø> (ø)
src/api/composition/CompositionCollection.js	93.58% <ø> (ø)
src/api/composition/DefaultCompositionProvider.js	95.45% <ø> (ø)
... and 86 more

... and 5 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e3fcbe1...6945652. Read the comment docs.

[scottbell]

Looking good @ozyx! Had a few suggestions below. Also tested renderWhenVisible changes and they seemed to work nicely.

[scottbell]

Good stuff!