Hide @internal APIs from TypeScript consumers
#1924
Merged
Conversation
This file contains 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
…rked as `@internal`. This may result in a few errors where you're accessing things you oughtn't be, but also may hide some interfaces that should be exposed - please file an issue if an API you were dependent on has been removed from the TypeScript typings. If that API happens to be `step.dependencies`; you should first read this: https://benjie.dev/graphql/ancestors
🦋 Changeset detectedLatest commit: 04bbd64 The changes in this PR will be included in the next version bump. This PR includes changesets to release 17 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
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.
Description
Various of our APIs were marked with
@internaland yet people were using them anyway; one risk with this is that we may break those APIs in future, but a more pressing issue is you may be using them incorrectly. For example, if you are accessing a stepsdependenciesfrom inside a plan resolver, you are likely doing something wrong - read https://benjie.dev/graphql/ancestors🚨 This is a major change since it significantly reduces our exposed API.
Performance impact
Marginal, plan-time only.
Security impact
Marginal improvement, perhaps.
Checklist
yarn lint:fixpasses.I've added tests for the new feature, andyarn testpasses.I have detailed the new feature in the relevant documentation.RELEASE_NOTES.mdfile (if one exists).Related