Add full $ref support to the visual editor #47
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| import { CirclePlus } from "lucide-react"; | ||
| import { type FC, type FormEvent, useMemo, useState } from "react"; | ||
| import { useTranslation } from "../../hooks/use-translation.ts"; | ||
| import { | ||
| getRootDefinitions, | ||
| removeDefinition, | ||
| renameDefinition, | ||
| updateDefinition, | ||
| } from "../../lib/refUtils.ts"; | ||
| import { cn } from "../../lib/utils.ts"; | ||
| import type { JsonSchema, ObjectJsonSchema } from "../../types/jsonSchema.ts"; | ||
| import { asObjectSchema } from "../../types/jsonSchema.ts"; | ||
| import { buildValidationTree } from "../../types/validation.ts"; | ||
| import { Button } from "../ui/button.tsx"; | ||
| import { Input } from "../ui/input.tsx"; | ||
| import { DefinitionSchemaPropertyEditor } from "./SchemaPropertyEditor.tsx"; | ||
|
|
||
| interface DefinitionsEditorProps { | ||
| schema: JsonSchema; | ||
| readOnly: boolean; | ||
| onChange: (schema: JsonSchema) => void; | ||
| autoFocus?: boolean; | ||
| } | ||
|
|
||
| /** | ||
| * Edits the reusable definitions of the document ($defs and the legacy | ||
| * definitions keyword), which can be referenced elsewhere with $ref. | ||
| */ | ||
| const DefinitionsEditor: FC<DefinitionsEditorProps> = ({ | ||
| schema, | ||
| readOnly = false, | ||
| onChange, | ||
| autoFocus = true, | ||
| }) => { | ||
| const t = useTranslation(); | ||
| const [newName, setNewName] = useState(""); | ||
| const [nameError, setNameError] = useState(false); | ||
|
|
||
| const definitions = getRootDefinitions(schema); | ||
| const validationTree = useMemo( | ||
| () => buildValidationTree(schema, t), | ||
| [schema, t], | ||
| ); | ||
|
|
||
| if (readOnly && definitions.length === 0) return null; | ||
|
|
||
| const nameExists = (name: string) => | ||
| definitions.some((definition) => definition.name === name); | ||
|
|
||
| const handleAdd = (e: FormEvent) => { | ||
| e.preventDefault(); | ||
| const name = newName.trim(); | ||
| if (!name) return; | ||
| if (nameExists(name)) { | ||
| setNameError(true); | ||
| return; | ||
| } | ||
|
|
||
| onChange( | ||
| updateDefinition(asObjectSchema(schema), "$defs", name, { | ||
| type: "object", | ||
| }), | ||
| ); | ||
| setNewName(""); | ||
| setNameError(false); | ||
| }; | ||
|
|
||
| return ( | ||
| <div className="mt-6 pt-4 border-t"> | ||
| <h4 className="font-medium text-sm">{t.definitionsTitle}</h4> | ||
| <p className="text-xs text-muted-foreground italic mt-1 mb-3"> | ||
| {t.definitionsDescription} | ||
| </p> | ||
|
|
||
| {definitions.map((definition) => ( | ||
| <DefinitionSchemaPropertyEditor | ||
| key={`${definition.container}:${definition.name}`} | ||
| name={definition.name} | ||
| pointer={definition.pointer} | ||
| schema={definition.schema} | ||
| schemaKey={definition.pointer} | ||
| readOnly={readOnly} | ||
| autoFocus={autoFocus} | ||
| validationNode={ | ||
| validationTree.children[ | ||
| `${definition.container}:${definition.name}` | ||
| ] | ||
| } | ||
| onDelete={() => | ||
| onChange( | ||
| removeDefinition( | ||
| asObjectSchema(schema), | ||
| definition.container, | ||
| definition.name, | ||
| ), | ||
| ) | ||
| } | ||
| onNameChange={(name) => { | ||
| if (!name || nameExists(name)) return; | ||
| onChange( | ||
| renameDefinition( | ||
| asObjectSchema(schema), | ||
| definition.container, | ||
| definition.name, | ||
| name, | ||
| ), | ||
|
Comment on lines
+101
to
+106
Collaborator
There was a problem hiding this comment. If a user types a name that already exists, the rename is silently swallowed — no toast, no inline error, no tooltip. The user sees the field revert to its old name and may not understand why. The add flow already has a |
||
| ); | ||
| }} | ||
| onSchemaChange={(updated: ObjectJsonSchema) => | ||
| onChange( | ||
| updateDefinition( | ||
| asObjectSchema(schema), | ||
| definition.container, | ||
| definition.name, | ||
| updated, | ||
| ), | ||
| ) | ||
| } | ||
| /> | ||
| ))} | ||
|
|
||
| {!readOnly && ( | ||
| <form onSubmit={handleAdd} className="mt-3"> | ||
| <div className="flex items-center gap-2"> | ||
| <Input | ||
| aria-label={t.definitionsTitle} | ||
| value={newName} | ||
| onChange={(e) => { | ||
| setNewName(e.target.value); | ||
| setNameError(false); | ||
| }} | ||
| placeholder={t.definitionNamePlaceholder} | ||
| aria-invalid={nameError ? true : undefined} | ||
| className={cn( | ||
| "h-8 text-sm font-mono max-w-[260px]", | ||
| nameError && "border-destructive", | ||
| )} | ||
| /> | ||
| <Button | ||
| type="submit" | ||
| variant="outline" | ||
| size="sm" | ||
| className="flex items-center gap-1.5" | ||
| > | ||
| <CirclePlus size={14} /> | ||
| {t.definitionAddButton} | ||
| </Button> | ||
| </div> | ||
| {nameError && ( | ||
| <p className="text-xs text-destructive mt-1.5"> | ||
| {t.definitionNameExists} | ||
| </p> | ||
| )} | ||
| </form> | ||
| )} | ||
| </div> | ||
| ); | ||
| }; | ||
|
|
||
| export default DefinitionsEditor; | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The validation tree lookup uses
${definition.container}:${definition.name}as the key, which matches howbuildValidationTreewrites its children. That's correct. However,buildValidationTreeprocesses$defsanddefinitionsas separate passes — if a document happens to define the same name in both containers (e.g.$defs.addressanddefinitions.address), thedefinitionsentry silently overwrites the$defsentry in the tree, and only one of them gets validation feedback. Unlikely in practice, but a latent collision.