feat: add __internalApplicationType to tool spec #235
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
azaxarov
reviewed
Jan 7, 2025
| component: Tool | ||
| component: Tool, | ||
| // @ts-expect-error TS doesn't know about this internal field see https://github.com/sanity-io/sanity/pull/7980 | ||
| __internalApplicationType: 'sanity/media' | ||
| } satisfies SanityTool |
There was a problem hiding this comment.
An alternative approach to avoid @ts-expect-error would be to extend the satisfies clause to the following:
satisfies SanityTool & {__internalApplicationType: 'sanity/media'}
That way, the __internalApplicationType property with its value will be expected.
There was a problem hiding this comment.
I thought about this but then i thought:
- it might fail the plugin type check below since it's not a SanityTool anymore?
- it's meant to be internal I felt augmenting the type was probably misleading.
But valid point for sure!
azaxarov
approved these changes
Jan 7, 2025
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.
Adds the __internalApplicationType property to the configuration of the tool as part of the CoreUI project. More information can be seen here – sanity-io/sanity#7980 – we added this parameter to many of the common tools sanity provides.
TLDR; this helps us identify & group tools across studio manifests to be used for the CoreUI menus etc. We see it as a temporary measure of using a studio manifest (similar to create) and this will be replaced in the ✨ future ✨.