chore: Fixes output for chart-components core chart API

[pan-kot]

Without these changes, the documenter fails in chart-components - see: cloudscape-design/chart-components#88

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.22%. Comparing base (d65ba86) to head (2653a72).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #85   +/-   ##
=======================================
  Coverage   92.21%   92.22%           
=======================================
  Files          15       15           
  Lines         925      926    +1     
  Branches      273      274    +1     
=======================================
+ Hits          853      854    +1     
  Misses         72       72           

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[pan-kot]

The SVG elements are complex fail with the following error:

Error: Multiple declarations found for symbol: addEventListener

Having multiple function declarations is valid TS, but unsupported by documenter. There is also no reason to deep-expand native types.

[just-boris]

Still recommend full name matches, just in case if we have any our own type "SVGIcon" or something

[pan-kot]

The Highcharts objects are complex and recursive - those fails with Max call stack exceeded error.

There is also no good reason to expand these as the customers can use Highcharts docs for these instead. Also, atm. both SVG and Highcharts objects are only present in the unofficial chart-core component, not shown in the website. We generate docs for snapshots only.

[just-boris]

Similar comment here. Instead of includes it should be a full text. Or at least realTypeName.split('.')[0] === 'Highcharts'

[just-boris]

And there should be a unit test on this, of course

[just-boris]

Still recommend full name matches, just in case if we have any our own type "SVGIcon" or something

[just-boris]

Similar comment here. Instead of includes it should be a full text. Or at least realTypeName.split('.')[0] === 'Highcharts'

[pan-kot]

And there should be a unit test on this, of course

@just-boris could you recommend a test design for this one?

I attempted a snapshot test, for which I created a fixture like this:

interface ComponentProps {
  buttonRef(button: null | HTMLElement): void;
  chartRef(chart: null | SVGSVGElement): void;
}

namespace ComponentProps {
  interface Ref {
    register(button: HTMLButton, chart: SVGSVGElement): void;
  }
}

However, it generated an output that listed the SVGSVGElement type as is, w/o any changes to the code.

Edit: I managed to make the snapshot test work with fake Highcharts.Point interface.

[pan-kot]

@just-boris , @georgylobko

I made the following updates:

1. Replaced highcharts type check with exact comparison (only need Highcharts.Point, which is present in core chart event listeners);
2. Added snapshot test to ensure the type named Highcharts.Point is not expanded;
3. Removed SVG check (SVG refs were inside the Highcharts.Point, we don't reference them otherwise, so not needed yet).

[just-boris]

SVG refs were inside the Highcharts.Point, we don't reference them otherwise, so not needed yet

Ok, good for now, approving

[just-boris]

To make your life simpler, I still recommend checking realTypeName.split('.')[0] only to avoid editing this check any time someone uses a new type from Highcharts

[pan-kot]

Makes total sense, updated!