Skip to content

refactor(types): replace json-schema library with custom JSONSchema type #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryoppippi merged 10 commits into from
Dec 12, 2025
Merged

refactor(types): replace json-schema library with custom JSONSchema type #220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
acac6b9
refactor(types): replace json-schema library with custom JSONSchema type
ryoppippi Dec 12, 2025
ddd8495
refactor(tool): use toJsonSchema() in toAISDK method
ryoppippi Dec 12, 2025
5e9caa2
refactor(tool): add type-safe schema validation for AI SDK
ryoppippi Dec 12, 2025
3ce8949
refactor(utils): add tryImport utility for optional dependencies
ryoppippi Dec 12, 2025
4be98cf
test(utils): add tests for tryImport utility
ryoppippi Dec 12, 2025
3b9ced9
refactor(tool): clean up toAISDK method
ryoppippi Dec 12, 2025
91d6c79
chore(oxfmt): ignore .claude/settings.local.json
ryoppippi Dec 12, 2025
463e366
chore(deps): move @ai-sdk/provider to catalog:dev
ryoppippi Dec 12, 2025
f296b42
docs: tanstack ai jsonschema
ryoppippi Dec 12, 2025
fafd7ff
Revert "chore(oxfmt): ignore .claude/settings.local.json"
ryoppippi Dec 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,12 @@
"@modelcontextprotocol/sdk": "catalog:prod",
"@orama/orama": "catalog:prod",
"defu": "catalog:prod",
"json-schema": "catalog:prod",
"zod": "catalog:dev"
},
"devDependencies": {
"@ai-sdk/provider": "catalog:dev",
"@ai-sdk/provider-utils": "catalog:dev",
"@hono/mcp": "catalog:dev",
"@types/json-schema": "catalog:dev",
"@types/node": "catalog:dev",
"@typescript/native-preview": "catalog:dev",
"@vitest/coverage-v8": "catalog:dev",
Expand Down
76 changes: 31 additions & 45 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 2 additions & 3 deletions pnpm-workspace.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ catalogMode: strict
catalogs:
dev:
'@ai-sdk/openai': ^2.0.80
'@clack/prompts': ^0.11.0
'@ai-sdk/provider': ^2.0.0
'@ai-sdk/provider-utils': ^3.0.18
'@clack/prompts': ^0.11.0
'@hono/mcp': ^0.1.4
'@types/json-schema': ^7.0.15
'@types/node': ^22.13.5
'@typescript/native-preview': ^7.0.0-dev.20251209.1
'@vitest/coverage-v8': ^4.0.15
Expand All @@ -35,7 +35,6 @@ catalogs:
'@modelcontextprotocol/sdk': ^1.24.3
'@orama/orama': ^3.1.11
defu: ^6.1.4
json-schema: ^0.4.0

enablePrePostScripts: true

Expand Down
21 changes: 12 additions & 9 deletions src/tool.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
import { jsonSchema } from 'ai';
import type { JSONSchema7 } from 'json-schema';
import { BaseTool, type MetaToolSearchResult, StackOneTool, Tools } from './tool';
import { type ExecuteConfig, ParameterLocation, type ToolParameters } from './types';
import {
type ExecuteConfig,
type JSONSchema,
ParameterLocation,
type ToolParameters,
} from './types';
import { StackOneAPIError } from './utils/errors';

// Create a mock tool for testing
Expand Down Expand Up @@ -1107,11 +1111,10 @@ describe('Schema Validation', () => {
);

const parameters = tool.toOpenAI().function.parameters;
expect(parameters).toBeDefined();
const properties = parameters?.properties as Record<string, JSONSchema7>;
const properties = parameters?.properties as Record<string, JSONSchema>;

expect(properties.arrayWithItems.items).toBeDefined();
expect((properties.arrayWithItems.items as JSONSchema7).type).toBe('number');
expect((properties.arrayWithItems.items as JSONSchema).type).toBe('number');
});

it('should handle nested object structure', () => {
Expand Down Expand Up @@ -1144,7 +1147,7 @@ describe('Schema Validation', () => {

const parameters = tool.toOpenAI().function.parameters;
expect(parameters).toBeDefined();
const properties = parameters?.properties as Record<string, JSONSchema7>;
const properties = parameters?.properties as Record<string, JSONSchema>;
const nestedObject = properties.nestedObject;

expect(nestedObject.type).toBe('object');
Expand Down Expand Up @@ -1185,7 +1188,7 @@ describe('Schema Validation', () => {
// @ts-ignore - jsonSchema is available on Schema wrapper from ai sdk
const arrayWithItems = toolObj.inputSchema.jsonSchema.properties?.arrayWithItems;
expect(arrayWithItems?.type).toBe('array');
expect((arrayWithItems?.items as JSONSchema7)?.type).toBe('string');
expect((arrayWithItems?.items as JSONSchema)?.type).toBe('string');
});

it('should handle nested filter object for AI SDK', async () => {
Expand Down Expand Up @@ -1220,14 +1223,14 @@ describe('Schema Validation', () => {

const parameters = tool.toOpenAI().function.parameters;
expect(parameters).toBeDefined();
const aiSchema = jsonSchema(parameters as JSONSchema7);
const aiSchema = jsonSchema(parameters as JSONSchema);
expect(aiSchema).toBeDefined();

const aiSdkTool = await tool.toAISDK();
// TODO: Remove ts-ignore once AISDKToolDefinition properly types inputSchema.jsonSchema
// @ts-ignore - jsonSchema is available on Schema wrapper from ai sdk
const filterProp = aiSdkTool[tool.name].inputSchema.jsonSchema.properties?.filter as
| (JSONSchema7 & { properties: Record<string, JSONSchema7> })
| (JSONSchema & { properties: Record<string, JSONSchema> })
| undefined;

expect(filterProp?.type).toBe('object');
Expand Down
Loading
Loading