chore(types): add oneOf property def #3639
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Deploying content with
|
| Latest commit: |
3d64bfd
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://2d4085d0.content-f0q.pages.dev |
| Branch Preview URL: | https://chore-schema-types.content-f0q.pages.dev |
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
There was a problem hiding this comment.
Additional Suggestions:
- The
isJSONPropertyandgetPropertyTypefunctions don't handle the newDraft07DefinitionPropertyOneOftype, causingoneOfschema properties to be misclassified.
View Details
📝 Patch Details
diff --git a/src/runtime/internal/schema.ts b/src/runtime/internal/schema.ts
index 50614143..c68c81a7 100644
--- a/src/runtime/internal/schema.ts
+++ b/src/runtime/internal/schema.ts
@@ -1,4 +1,4 @@
-import type { Draft07, Draft07DefinitionProperty, Draft07DefinitionPropertyAllOf, Draft07DefinitionPropertyAnyOf } from '@nuxt/content'
+import type { Draft07, Draft07DefinitionProperty, Draft07DefinitionPropertyAllOf, Draft07DefinitionPropertyAnyOf, Draft07DefinitionPropertyOneOf } from '@nuxt/content'
const propertyTypes = {
string: 'VARCHAR',
@@ -20,15 +20,16 @@ export function getOrderedSchemaKeys(schema: Draft07) {
return Array.from(keys) as string[]
}
-function isJSONProperty(property: Draft07DefinitionProperty | Draft07DefinitionPropertyAllOf | Draft07DefinitionPropertyAnyOf) {
+function isJSONProperty(property: Draft07DefinitionProperty | Draft07DefinitionPropertyAllOf | Draft07DefinitionPropertyAnyOf | Draft07DefinitionPropertyOneOf) {
const propertyType = (property as Draft07DefinitionProperty).type
return propertyType === 'object'
|| propertyType === 'array'
|| !!(property as Draft07DefinitionPropertyAnyOf).anyOf
|| !!(property as Draft07DefinitionPropertyAllOf).allOf
+ || !!(property as Draft07DefinitionPropertyOneOf).oneOf
}
-function getPropertyType(property: Draft07DefinitionProperty | Draft07DefinitionPropertyAllOf | Draft07DefinitionPropertyAnyOf) {
+function getPropertyType(property: Draft07DefinitionProperty | Draft07DefinitionPropertyAllOf | Draft07DefinitionPropertyAnyOf | Draft07DefinitionPropertyOneOf) {
const propertyType = (property as Draft07DefinitionProperty).type
let type = propertyTypes[propertyType as keyof typeof propertyTypes] || 'TEXT'
@@ -52,6 +53,18 @@ function getPropertyType(property: Draft07DefinitionProperty | Draft07Definition
}
}
+ if ((property as Draft07DefinitionPropertyOneOf).oneOf) {
+ type = 'TEXT'
+
+ const oneOf = (property as Draft07DefinitionPropertyOneOf).oneOf
+ const nullIndex = oneOf.findIndex(t => t.type === 'null')
+ if (oneOf.length === 2 && nullIndex !== -1) {
+ type = nullIndex === 0
+ ? getPropertyType(oneOf[1]!)
+ : getPropertyType(oneOf[0]!)
+ }
+ }
+
if (Array.isArray(propertyType) && propertyType.includes('null') && propertyType.length === 2) {
type = propertyType[0] === 'null'
? propertyTypes[propertyType[1] as keyof typeof propertyTypes] || 'TEXT'
@@ -85,6 +98,12 @@ export function describeProperty(schema: Draft07, property: string) {
}
}
+ if ((shape[property] as Draft07DefinitionPropertyOneOf).oneOf) {
+ if (((shape[property] as Draft07DefinitionPropertyOneOf).oneOf).find(t => t.type === 'null')) {
+ result.nullable = true
+ }
+ }
+
if (Array.isArray(type) && type.includes('null')) {
result.nullable = true
}
Analysis
Missing oneOf property handling in schema runtime functions
What fails: isJSONProperty() and getPropertyType() functions in src/runtime/internal/schema.ts don't recognize Draft07DefinitionPropertyOneOf type, causing oneOf schema properties to be incorrectly classified as non-JSON and missing nullable detection logic.
How to reproduce:
// Using a schema with oneOf property:
const schema = {
$schema: 'http://json-schema.org/draft-07/schema#',
definitions: {
Content: {
properties: {
config: {
oneOf: [
{ type: 'object', properties: { key: { type: 'string' } } },
{ type: 'object', properties: { value: { type: 'number' } } }
]
}
},
required: []
}
}
}
const property = describeProperty(schema, 'config')
console.log(property.json) // Returns false, should be trueResult: isJSONProperty() returns false for oneOf properties (should return true), and getPropertyType() doesn't apply nullable detection when oneOf contains a null type. This causes oneOf properties to be misclassified in the database schema generation.
Expected: oneOf properties should be treated as JSON properties (like anyOf and allOf are), and nullable detection should work correctly for oneOf combinations with null types.
Fix: Updated src/runtime/internal/schema.ts to:
- Import
Draft07DefinitionPropertyOneOftype - Add
Draft07DefinitionPropertyOneOfto type parameters inisJSONProperty()andgetPropertyType() - Add
|| !!(property as Draft07DefinitionPropertyOneOf).oneOfcheck toisJSONProperty() - Add oneOf handling block in
getPropertyType()with nullable detection (mirrors anyOf logic) - Add oneOf nullable detection in
describeProperty()
This ensures oneOf properties are handled consistently with anyOf and allOf patterns already in the codebase.
View Details
📝 Patch Details
diff --git a/src/runtime/internal/schema.ts b/src/runtime/internal/schema.ts
index 50614143..c68c81a7 100644
--- a/src/runtime/internal/schema.ts
+++ b/src/runtime/internal/schema.ts
@@ -1,4 +1,4 @@
-import type { Draft07, Draft07DefinitionProperty, Draft07DefinitionPropertyAllOf, Draft07DefinitionPropertyAnyOf } from '@nuxt/content'
+import type { Draft07, Draft07DefinitionProperty, Draft07DefinitionPropertyAllOf, Draft07DefinitionPropertyAnyOf, Draft07DefinitionPropertyOneOf } from '@nuxt/content'
const propertyTypes = {
string: 'VARCHAR',
@@ -20,15 +20,16 @@ export function getOrderedSchemaKeys(schema: Draft07) {
return Array.from(keys) as string[]
}
-function isJSONProperty(property: Draft07DefinitionProperty | Draft07DefinitionPropertyAllOf | Draft07DefinitionPropertyAnyOf) {
+function isJSONProperty(property: Draft07DefinitionProperty | Draft07DefinitionPropertyAllOf | Draft07DefinitionPropertyAnyOf | Draft07DefinitionPropertyOneOf) {
const propertyType = (property as Draft07DefinitionProperty).type
return propertyType === 'object'
|| propertyType === 'array'
|| !!(property as Draft07DefinitionPropertyAnyOf).anyOf
|| !!(property as Draft07DefinitionPropertyAllOf).allOf
+ || !!(property as Draft07DefinitionPropertyOneOf).oneOf
}
-function getPropertyType(property: Draft07DefinitionProperty | Draft07DefinitionPropertyAllOf | Draft07DefinitionPropertyAnyOf) {
+function getPropertyType(property: Draft07DefinitionProperty | Draft07DefinitionPropertyAllOf | Draft07DefinitionPropertyAnyOf | Draft07DefinitionPropertyOneOf) {
const propertyType = (property as Draft07DefinitionProperty).type
let type = propertyTypes[propertyType as keyof typeof propertyTypes] || 'TEXT'
@@ -52,6 +53,18 @@ function getPropertyType(property: Draft07DefinitionProperty | Draft07Definition
}
}
+ if ((property as Draft07DefinitionPropertyOneOf).oneOf) {
+ type = 'TEXT'
+
+ const oneOf = (property as Draft07DefinitionPropertyOneOf).oneOf
+ const nullIndex = oneOf.findIndex(t => t.type === 'null')
+ if (oneOf.length === 2 && nullIndex !== -1) {
+ type = nullIndex === 0
+ ? getPropertyType(oneOf[1]!)
+ : getPropertyType(oneOf[0]!)
+ }
+ }
+
if (Array.isArray(propertyType) && propertyType.includes('null') && propertyType.length === 2) {
type = propertyType[0] === 'null'
? propertyTypes[propertyType[1] as keyof typeof propertyTypes] || 'TEXT'
@@ -85,6 +98,12 @@ export function describeProperty(schema: Draft07, property: string) {
}
}
+ if ((shape[property] as Draft07DefinitionPropertyOneOf).oneOf) {
+ if (((shape[property] as Draft07DefinitionPropertyOneOf).oneOf).find(t => t.type === 'null')) {
+ result.nullable = true
+ }
+ }
+
if (Array.isArray(type) && type.includes('null')) {
result.nullable = true
}
Analysis
Missing nullable detection for oneOf schema properties in describeProperty()
What fails: Properties using oneOf with a null option are not detected as nullable. The describeProperty(), isJSONProperty(), and getPropertyType() functions only check anyOf and allOf, ignoring oneOf.
How to reproduce:
// Schema using oneOf with null option
const schema = {
definitions: {
__SCHEMA__: {
properties: {
field: {
oneOf: [
{ type: 'string' },
{ type: 'null' }
]
}
}
}
}
}
// Current behavior
describeProperty(schema, 'field').nullable // Returns false (WRONG)
// Expected behavior
describeProperty(schema, 'field').nullable // Should return trueResult:
describeProperty()returnsnullable: falseforoneOfproperties containing nullisJSONProperty()does not recognizeoneOfas JSON propertiesgetPropertyType()does not extract the correct type fromoneOf[type|null]
Expected: Per JSON Schema Draft 7 specification, oneOf is a valid keyword for union types alongside anyOf. Properties with oneOf containing a null option should be marked as nullable, similar to how anyOf properties are handled.
Root cause: The functions in src/runtime/internal/schema.ts only check for anyOf and allOf but do not handle the oneOf keyword, which is part of the schema property types as defined in src/types/schema.ts.
Fix applied:
- Added
Draft07DefinitionPropertyOneOfto imports - Updated
isJSONProperty()to check foroneOf - Updated
getPropertyType()to extract types fromoneOfwith null similar toanyOfhandling - Updated
describeProperty()to detect nullable fromoneOfwith null option
View Details
📝 Patch Details
diff --git a/src/utils/schema/zod4.ts b/src/utils/schema/zod4.ts
index d3ee67cb..ab17b51c 100644
--- a/src/utils/schema/zod4.ts
+++ b/src/utils/schema/zod4.ts
@@ -1,5 +1,5 @@
import { z as zod } from 'zod/v4'
-import type { Draft07, Draft07DefinitionProperty, Draft07DefinitionPropertyAllOf, Draft07DefinitionPropertyAnyOf } from '../../types'
+import type { Draft07, Draft07DefinitionProperty, Draft07DefinitionPropertyAllOf, Draft07DefinitionPropertyAnyOf, Draft07DefinitionPropertyOneOf } from '../../types'
export function toJSONSchema(
_schema: unknown,
@@ -34,6 +34,7 @@ export function toJSONSchema(
| Draft07DefinitionProperty
| Draft07DefinitionPropertyAnyOf
| Draft07DefinitionPropertyAllOf
+ | Draft07DefinitionPropertyOneOf
>) || {},
required: (baseSchema.required as string[]) || [],
additionalProperties:
Analysis
Missing Draft07DefinitionPropertyOneOf type in zod4.ts schema converter
What fails: The zod4.ts schema converter has incomplete type annotations for JSON Schema properties. The Draft07Definition type includes Draft07DefinitionPropertyOneOf in its valid property types (line 11 of schema.ts), but zod4.ts does not include this type in its property union cast (lines 34-36), creating a type mismatch.
How to reproduce:
- Create a zod schema that produces a property with
oneOf(e.g., from a future version of zod/v4 or when manually providing such properties) - Pass it through the
toJSONSchema()function insrc/utils/schema/zod4.ts - The TypeScript compiler will report a type error when the resulting schema is assigned to
Draft07Definition
Result: While Zod v4's current toJSONSchema implementation generates anyOf (not oneOf), the type system should be consistent with the Draft07Definition interface which explicitly allows Draft07DefinitionPropertyOneOf in its property union. The missing import and type union cause TypeScript type checking to fail if a property with oneOf structure were present.
Expected: The import statement should include Draft07DefinitionPropertyOneOf and the property type cast should include Draft07DefinitionPropertyOneOf in its union, matching the requirements defined in src/types/schema.ts line 11.
Fix: Added Draft07DefinitionPropertyOneOf to both the import statement (line 2) and the property type union (lines 34-36) to align with the Draft07Definition type definition.
commit: |
There was a problem hiding this comment.
Additional Suggestion:
Missing nullable detection for oneOf properties. Properties using oneOf with a null variant won't be marked as nullable, even though properties using anyOf with the same pattern are correctly handled.
View Details
📝 Patch Details
diff --git a/src/runtime/internal/schema.ts b/src/runtime/internal/schema.ts
index de479f80..c68c81a7 100644
--- a/src/runtime/internal/schema.ts
+++ b/src/runtime/internal/schema.ts
@@ -98,6 +98,12 @@ export function describeProperty(schema: Draft07, property: string) {
}
}
+ if ((shape[property] as Draft07DefinitionPropertyOneOf).oneOf) {
+ if (((shape[property] as Draft07DefinitionPropertyOneOf).oneOf).find(t => t.type === 'null')) {
+ result.nullable = true
+ }
+ }
+
if (Array.isArray(type) && type.includes('null')) {
result.nullable = true
}
Analysis
Missing nullable detection for oneOf properties in describeProperty()
What fails: Properties using oneOf with a null variant are not marked as nullable in the describeProperty() function, even though equivalent anyOf properties are correctly marked. This causes inconsistent behavior when both schema patterns represent optional fields.
How to reproduce:
const schema: Draft07 = {
definitions: {
__SCHEMA__: {
type: 'object',
properties: {
testProp: {
oneOf: [
{ type: 'null' },
{ type: 'string' }
]
}
},
required: ['testProp']
}
}
}
const result = describeProperty(schema, 'testProp')
// Result: nullable = false (INCORRECT)Expected behavior: Should return nullable: true because the property supports null values via the oneOf pattern, matching the behavior of anyOf.
Root cause: describeProperty() in src/runtime/internal/schema.ts (lines 95-98) checks anyOf properties for null variants, but has no corresponding check for oneOf properties. The getPropertyType() function already correctly handles both patterns (lines 56-66), but the nullable flag detection is incomplete.
Fix: Added nullable detection for oneOf properties matching the existing anyOf pattern in describeProperty().
🔗 Linked issue
❓ Type of change
📚 Description
Need it in Studio to build form based on Schema
📝 Checklist