feat(annotations): add annotations to DebugState

[rshen91]

Summary

Annotations are now added to debugState.

Details

The DebugStateAnnotations interface includes a data attribute which ultimately takes in an any type. I would like to restrict this if possible but it's from the dataValues off the LineAnnotationSpec or RectAnnotationSpec.

Issues

Closes #1260

Checklist

• The proper feature labels have been added (e.g. :interactions, :axis)
• All related issues have been linked (i.e. closes #123, fixes #123)
• New public API exports have been added to packages/charts/src/index.ts

[markov00]

can you please describe the API extractor failure?

[rshen91]

I get warnings when changing the type from any that result in the yarn api:check failing with results expected same but got worse but now when Im running it, it's not producing those errors d5591a0 for changes

[markov00]

yep now it looks good no?
can you remove the comment on the code?
// API Extractor failing with LineAnnotationDatum | RectAnnotationDatum, the dataValue in get_debug_state can be any value

[markov00]

This is an invalid array access: the index is the index of the annotationSpecs array, but here you want to enumerate the dataValues array. You should rewrite the code to return an DebugStateAnnotations per each element into the dataValues array of each spec

[rshen91]

Ok awesome I think I'm following commit isn't showing on github right now but it's 0d4024 in my local environment and it looks like the CI is running.

For the click handle rect story with multiple rectangle and a line annotation, the debug state looks as follows:

'annotations':
  [{'data':{'coordinates':{'x0':0,'x1':1,'y0':0,'y1':4},'details':'details about this annotation'},
    'id':'rect1',
    'color':{'stroke':'#FFEEBC','strokeWidth':0,'opacity':0.25,'fill':'red'},
    'type':'rectangle'},
  {'data':{'coordinates':{'x0':0.8,'x1':2,'y0':1,'y1':5},'details':'details about this other annotation'},
    'id':'rect2',
    'color':{'stroke':'#FFEEBC','strokeWidth':0,'opacity':0.25,'fill':'blue'},
    'type':'rectangle'},
  {'data':{'dataValue':2,'details':'detail-0'},
    'id':'line_annotation',
    'color':{'line':{'stroke':'#777','strokeWidth':1,'opacity':1},
    'details':{'fontSize':10,'fontFamily':'sans-serif','fontStyle':'normal','fill':'#777','padding':0}},'type':'line',
    'domainType':'xDomain'}
  ]}">

[nickofthyme]

LGTM, please review the changes I added in c4dc3a9.

[nickofthyme]

I don't know that we really need to export all of these. Generally I look at it as "is someone gonna use this on its own". For instance the Theme people may define LegendStyles on its own and thus would require us to export it.

In this case however, I see the debug state being readonly, such that people say this state value should be x, and not setting downstream values of the debug state.

@markov00 thoughts?

[markov00]

Isn't easier for them to know the shape of the debug state if we export the used types?

[rshen91]

jenkins test this please

[markov00]

It looks good for me!
Thanks for all the changes on the exposed APIs