build(client): generate legacy API report #21634
Conversation
client-utils is in the `@fluid-internal` scope and thus does not have trimmed exports. But it currently support legacy APIs for typed event emitter. Setup a non-production legacy "roll up" file for both the browser and Node.js entrypoints. Generate API reports and perform linting like `@fluidframework` scoped packages with /legacy, but using the faux "roll ups". Additionally now verify API reports for browser and Node.js entrypoints are identical. Note: `api` task and `api-extractor` named scripts are not used as in `@fluidframework` scoped packages as these scripts are not part of production API. They are only used for docs and linting which have task dependencies defined.
github-actions
bot
added
public api change
Also use same path tree will need to use (to be node10 compat capable - tooling defect)
| @@ -9,8 +9,6 @@ export { EventEmitter } | |||
| // @alpha | |||
| export type EventEmitterEventType = string; | |||
|
|
|||
| export { performance_2 as performance } | |||
There was a problem hiding this comment.
This is an @internal export, right? So this change is effectively a correction of this API-Extractor bug?
What is our plan for |
There was a problem hiding this comment.
Changes look good to me, assuming we need to support TypedEventEmitter for Loop. But I do wonder if it would be reasonable for us to just copy TypedEventEmitter into their code and let them maintain their own copy of it.
Presumably we also export (alpha+) classes that extend this? So presumably there is more blocking us from making the type @internal, but at least then we could remove any remaining direct dependencies on our @fluid-internal package from Loop?
There is some work planned around event emitter cleanup which I think will relocate it from this package. That is tracked as either or both AB#7377 and AB#6595. But I don't think it will go away anytime soon because of the way classes are exported for telemetry-utils and some test mock classes. Gotta have factory functions to hide classes that extend |
client-utils is in the
@fluid-internalscope and thus does not have trimmed exports. But it currently support legacy APIs for typed event emitter.Setup a non-production legacy "roll up" file for both the browser and Node.js entrypoints. Generate API reports and perform linting like
@fluidframeworkscoped packages with /legacy, but using the faux "roll ups".Additionally now verify API reports for browser and Node.js entrypoints are identical.
Note:
apitask andapi-extractornamed scripts are not used as in@fluidframeworkscoped packages as these scripts are not part of production API. They are only used for docs and linting which have task dependencies defined.