feat: Add granular UI tool controls for create and update #558
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
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request effectively introduces granular controls for UI surface creation and updates by adding a SurfaceUpdateMode. The refactoring of SurfaceUpdateTool and the updates to the AI content generators are well-executed and align with the goal of preventing unintended UI modifications. The code is clear and the changes are consistent across the different packages. I have two suggestions to improve maintainability and adopt more modern Dart syntax.
Comment on lines
196
to
214
| final String surfaceIdDescription; | ||
| switch (updateMode) { | ||
| case SurfaceUpdateMode.create: | ||
| surfaceIdDescription = | ||
| 'The unique identifier for the new UI surface to create. This ' | ||
| '*must* be a new, unique identifier.'; | ||
| break; | ||
| case SurfaceUpdateMode.update: | ||
| surfaceIdDescription = | ||
| 'The unique identifier for the existing UI surface to update.'; | ||
| break; | ||
| case SurfaceUpdateMode.both: | ||
| surfaceIdDescription = | ||
| 'The unique identifier for the UI surface to create or ' | ||
| 'update. If you are adding a new surface this *must* be a ' | ||
| 'new, unique identified that has never been used for any ' | ||
| 'existing surfaces shown.', | ||
| ), | ||
| 'components': S.list( | ||
| description: 'A list of component definitions.', | ||
| minItems: 1, | ||
| items: S.object( | ||
| description: | ||
| 'Represents a *single* component in a UI widget tree. ' | ||
| 'This component could be one of many supported types.', | ||
| properties: { | ||
| 'id': S.string(), | ||
| 'weight': S.integer( | ||
| description: | ||
| 'Optional layout weight for use in Row/Column children.', | ||
| ), | ||
| 'component': S.object( | ||
| description: | ||
| '''A wrapper object that MUST contain exactly one key, which is the name of the component type (e.g., 'Text'). The value is an object containing the properties for that specific component.''', | ||
| properties: { | ||
| for (var entry | ||
| in ((catalog.definition as ObjectSchema) | ||
| .properties!['components']! | ||
| as ObjectSchema) | ||
| .properties! | ||
| .entries) | ||
| entry.key: entry.value, | ||
| }, | ||
| ), | ||
| }, | ||
| required: ['id', 'component'], | ||
| 'existing surfaces shown.'; | ||
| break; | ||
| } |
Contributor
There was a problem hiding this comment.
For improved conciseness and readability, you could refactor this switch statement into a switch expression, which is a feature available in modern Dart. This would make the assignment of surfaceIdDescription more direct and the code more idiomatic.
final String surfaceIdDescription = switch (updateMode) {
SurfaceUpdateMode.create =>
'The unique identifier for the new UI surface to create. This '
'*must* be a new, unique identifier.',
SurfaceUpdateMode.update =>
'The unique identifier for the existing UI surface to update.',
SurfaceUpdateMode.both =>
'The unique identifier for the UI surface to create or '
'update. If you are adding a new surface this *must* be a '
'new, unique identified that has never been used for any '
'existing surfaces shown.',
};
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Introduces
SurfaceUpdateModeto provide distinctcreateandupdatecapabilities for UI surfaces. This change refactorsSurfaceUpdateToolto be configurable and updates the AI content generators to provide separatesurfaceCreateandsurfaceUpdatetools based on theGenUiConfiguration.This allows developers to control whether the AI can only create new UI surfaces, only update existing ones, or both, preventing unintended UI modifications.
Fixes #463