feat: expose API abstractions from webiny/api root#5080
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Users can now import commonly-used API abstractions like
Logger,BuildParams,EventPublisher,KeyValueStore, andDomainEventdirectly from the rootwebiny/apipath, instead of from separate sub-paths likewebiny/api/logger.Why
The Webiny API package had scattered exports across many sub-paths, making it harder for users to discover and remember the correct import paths. By exposing the most commonly used abstractions from the root
webiny/apientry point, the API becomes simpler and more intuitive to use.How
packages/api-core/src/exports/api.tsforLogger,BuildParams,EventPublisher,KeyValueStore, andDomainEvent.GenerateWebinyPkgCommandpipeline (ParseExportsFileService,MergeExportsService) to propagate@deprecatedJSDoc comments to generated sub-path exports, marking the old sub-paths as deprecated with guidance to usewebiny/apiinstead.webinypackage exports viayarn webiny-scripts generate-webiny-package.Changelog
Consolidated API Exports to Root: Import commonly used abstractions like
Logger,BuildParams,EventPublisher,KeyValueStore, andDomainEventdirectly fromwebiny/api. The old sub-path imports are now marked as deprecated.Squash Merge Commit
feat: expose API abstractions from webiny/api root