Replace custom jsonSchemaToZod implementation with Zod's native z.fromJSONSchema() method
#1735
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| "@inkeep/agents-api": patch | ||
| "@inkeep/agents-core": patch | ||
| --- | ||
|
|
||
| Replace custom jsonSchemaToZod implementation with Zod's native z.fromJSONSchema() method |
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 |
|---|---|---|
| @@ -1,73 +1,18 @@ | ||
| import { z } from '@hono/zod-openapi'; | ||
| import type { | ||
| ArtifactComponentApiInsert, | ||
| ArtifactComponentApiSelect, | ||
| DataComponentInsert, | ||
| } from '@inkeep/agents-core'; | ||
| import type { JSONSchema } from 'zod/v4/core'; | ||
| import { SchemaProcessor } from './SchemaProcessor'; | ||
|
|
||
| /** | ||
| * Standard artifact reference component schema for tool responses | ||
| */ | ||
| export class ArtifactReferenceSchema { | ||
| // Standard artifact props schema - single source of truth | ||
| private static readonly ARTIFACT_PROPS_SCHEMA: JSONSchema.BaseSchema = { | ||
| type: 'object', | ||
| properties: { | ||
| artifact_id: { | ||
|
|
@@ -90,7 +35,7 @@ export class ArtifactReferenceSchema { | |
| return z.object({ | ||
| id: z.string(), | ||
| name: z.literal('Artifact'), | ||
| props: z.fromJSONSchema(ArtifactReferenceSchema.ARTIFACT_PROPS_SCHEMA), | ||
| }); | ||
| } | ||
|
|
||
|
|
@@ -128,7 +73,7 @@ export class ArtifactCreateSchema { | |
| ? SchemaProcessor.enhanceSchemaWithJMESPathGuidance(component.props) | ||
| : { type: 'object', properties: {} }; | ||
|
|
||
| const propsSchema: JSONSchema.BaseSchema = { | ||
| type: 'object', | ||
| properties: { | ||
| id: { | ||
|
|
@@ -158,7 +103,7 @@ export class ArtifactCreateSchema { | |
| return z.object({ | ||
| id: z.string(), | ||
| name: z.literal(`ArtifactCreate_${component.name}`), | ||
| props: z.fromJSONSchema(propsSchema), | ||
| }); | ||
| }); | ||
| } | ||
|
|
@@ -170,7 +115,7 @@ export class ArtifactCreateSchema { | |
| */ | ||
| static getDataComponents( | ||
| tenantId: string, | ||
| projectId = '', | ||
| artifactComponents: Array<ArtifactComponentApiInsert | ArtifactComponentApiSelect> | ||
| ): DataComponentInsert[] { | ||
| return artifactComponents.map((component) => { | ||
|
|
@@ -179,7 +124,7 @@ export class ArtifactCreateSchema { | |
| ? SchemaProcessor.enhanceSchemaWithJMESPathGuidance(component.props) | ||
| : { type: 'object', properties: {} }; | ||
|
|
||
| const propsSchema: JSONSchema.BaseSchema = { | ||
| type: 'object', | ||
| properties: { | ||
| id: { | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -9,7 +9,7 @@ | |
| * 4. Streams NDJSON response back to client | ||
| */ | ||
|
|
||
| import { ModelFactory } from '@inkeep/agents-core'; | ||
| import { Output, streamText } from 'ai'; | ||
| import type { NextRequest } from 'next/server'; | ||
| import { z } from 'zod'; | ||
|
|
@@ -68,7 +68,9 @@ export async function POST( | |
| const modelConfig = ModelFactory.prepareGenerationConfig(project.models?.base as any); | ||
|
|
||
| // Define schema for generated output | ||
| const mockDataSchema = artifactComponent.props | ||
| ? z.fromJSONSchema(artifactComponent.props) | ||
| : z.string(); | ||
|
Comment on lines
+71
to
+73
Collaborator
Author
There was a problem hiding this comment. |
||
| const renderSchema = z.object({ | ||
| component: z.string().describe('The React component code'), | ||
| mockData: mockDataSchema.describe('Sample data matching the props schema'), | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -9,7 +9,7 @@ | |
| * 4. Streams NDJSON response back to client | ||
| */ | ||
|
|
||
| import { ModelFactory } from '@inkeep/agents-core'; | ||
| import { Output, streamText } from 'ai'; | ||
| import type { NextRequest } from 'next/server'; | ||
| import { z } from 'zod'; | ||
|
|
@@ -66,7 +66,7 @@ export async function POST( | |
| // Define schema for generated output | ||
| // Dynamically create mockData schema from component's props JSON Schema. | ||
| // This ensures Anthropic gets proper types instead of z.any() which it rejects. | ||
| const mockDataSchema = z.fromJSONSchema(dataComponent.props); | ||
| const renderSchema = z.object({ | ||
| component: z.string().describe('The React component code'), | ||
| mockData: mockDataSchema.describe('Sample data matching the props schema'), | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -102,7 +102,7 @@ describe('validation', () => { | |
| { | ||
| path: [], | ||
| message: | ||
| "Error during parsing JSON schema headers: Cannot read properties of null (reading '$schema')", | ||
| }, | ||
| ]); | ||
| }); | ||
|
|
||
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 |
|---|---|---|
| @@ -1,4 +1,3 @@ | ||
| import { z } from 'zod'; | ||
| import { transformToJson } from '@/lib/json-schema-validation'; | ||
|
|
||
|
|
@@ -43,7 +42,7 @@ export function createCustomHeadersSchema(customHeaders: string) { | |
| } | ||
| if (customHeaders) { | ||
| try { | ||
| const customSchema = z.fromJSONSchema(JSON.parse(customHeaders)); | ||
| const result = customSchema.safeParse(value); | ||
| if (result.success) return; | ||
| addIssue(ctx, result.error); | ||
|
|
||
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 |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| import { z } from 'zod'; | ||
| import type { JSONSchema } from 'zod/v4/core'; | ||
|
|
||
| const jsonSchema: JSONSchema.BaseSchema = { | ||
| type: 'object', | ||
|
|
@@ -14,7 +14,7 @@ const jsonSchema: JSONSchema.BaseSchema = { | |
|
|
||
| describe('jsonSchemaToZod', () => { | ||
| test('should return json schema', () => { | ||
| const zodSchema = z.fromJSONSchema(jsonSchema); | ||
| expect(zodSchema.toJSONSchema()).toStrictEqual({ | ||
| $schema: 'https://json-schema.org/draft/2020-12/schema', | ||
| type: 'object', | ||
|
|
||
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.
backward compatibility, previous
jsonSchemaToZodreturnsz.stringfor falsy values