Skip to content

Use Zod 4 JSON schema generation #267

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
Ian Clanton-Thuon (iclanton) merged 1 commit into from
Aug 12, 2026
Merged

Use Zod 4 JSON schema generation #267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion api/spfx-template-api/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"lodash": "^4.17.23",
"semver": "~7.7.4",
"uuid": "^11.0.5",
"zod": "^4.1.5"
"zod": "^4.4.3"
},
"devDependencies": {
"@microsoft/spfx-cli-build-rig": "workspace:*",
Expand Down
2 changes: 1 addition & 1 deletion apps/spfx-cli/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"@rushstack/node-core-library": "~5.23.1",
"@rushstack/ts-command-line": "~5.3.10",
"@rushstack/terminal": "~0.24.0",
"zod": "^4.1.5"
"zod": "^4.4.3"
},
"devDependencies": {
"@microsoft/spfx-cli-build-rig": "workspace:*",
Expand Down
11 changes: 11 additions & 0 deletions common/changes/@microsoft/spfx-cli/main_2026-08-12-14-49-33.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"changes": [
{
"comment": "",
"type": "none",
"packageName": "@microsoft/spfx-cli"
}
],
"packageName": "@microsoft/spfx-cli",
"email": "iclanton@users.noreply.github.com"
}
5 changes: 1 addition & 4 deletions common/config/rush/common-versions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,6 @@
"@microsoft/eslint-plugin-spfx": ["1.24.0-beta.2"],
"@microsoft/sp-lodash-subset": ["1.24.0-beta.2"],
"@microsoft/sp-module-interfaces": ["1.24.0-beta.2"],
"@microsoft/spfx-web-build-rig": ["1.24.0-beta.2"],
// Copilot component templates use zod 3.x (required by zod-to-json-schema),
// whereas the CLI tooling uses zod 4.x.
"zod": ["3.24.1"]
"@microsoft/spfx-web-build-rig": ["1.24.0-beta.2"]
}
}
73 changes: 25 additions & 48 deletions common/config/rush/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.

2 changes: 1 addition & 1 deletion common/config/rush/repo-state.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush.
{
"pnpmShrinkwrapHash": "0b93ab9d09fb0ae272fcc80188c87dce6ea8a8d1",
"pnpmShrinkwrapHash": "03b9a8403725f70d0684106a3321c9f0e49b9897",
"preferredVersionsHash": "e0fe58342c5c916209e75bfdee56e81689af3359"
}
3 changes: 1 addition & 2 deletions examples/copilot-component-minimal/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@
"dependencies": {
"@microsoft/sp-copilot-component": "1.24.0-beta.2",
"tslib": "2.3.1",
"zod": "3.24.1",
"zod-to-json-schema": "3.24.1"
"zod": "^4.4.3"
},
"devDependencies": {
"@microsoft/eslint-config-spfx": "1.24.0-beta.2",
Expand Down
3 changes: 1 addition & 2 deletions examples/copilot-component-minimal/src/MinimalProperties.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import { z } from 'zod';
import zodToJsonSchema from 'zod-to-json-schema';

const propertiesSchema = z.object({
message: z.string().describe('A message to display.')
});

export type IMinimalCopilotComponentProperties = z.infer<typeof propertiesSchema>;

export default zodToJsonSchema(propertiesSchema);
export default propertiesSchema.toJSONSchema();
3 changes: 1 addition & 2 deletions examples/copilot-component-noframework/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@
"@microsoft/sp-copilot-component": "1.24.0-beta.2",
"@microsoft/sp-lodash-subset": "1.24.0-beta.2",
"tslib": "2.3.1",
"zod": "3.24.1",
"zod-to-json-schema": "3.24.1"
"zod": "^4.4.3"
},
"devDependencies": {
"@microsoft/eslint-config-spfx": "1.24.0-beta.2",
Expand Down
3 changes: 1 addition & 2 deletions examples/copilot-component-noframework/src/NoFrameworkProperties.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import { z } from 'zod';
import zodToJsonSchema from 'zod-to-json-schema';

const propertiesSchema = z.object({
message: z.string().describe('A message to display.')
});

export type INoFrameworkCopilotComponentProperties = z.infer<typeof propertiesSchema>;

export default zodToJsonSchema(propertiesSchema);
export default propertiesSchema.toJSONSchema();
3 changes: 1 addition & 2 deletions examples/copilot-component-react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@
"react": "17.0.1",
"react-dom": "17.0.1",
"tslib": "2.3.1",
"zod": "3.24.1",
"zod-to-json-schema": "3.24.1"
"zod": "^4.4.3"
},
"devDependencies": {
"@microsoft/eslint-config-spfx": "1.24.0-beta.2",
Expand Down
3 changes: 1 addition & 2 deletions examples/copilot-component-react/src/SampleProperties.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import { z } from 'zod';
import zodToJsonSchema from 'zod-to-json-schema';

const propertiesSchema = z.object({
message: z.string().describe('A message to display.')
});

export type ISampleCopilotComponentProperties = z.infer<typeof propertiesSchema>;

export default zodToJsonSchema(propertiesSchema);
export default propertiesSchema.toJSONSchema();
3 changes: 1 addition & 2 deletions templates/copilot-component-minimal/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@
"dependencies": {
"@microsoft/sp-copilot-component": "<%= spfxVersion %>",
"tslib": "2.3.1",
"zod": "3.24.1",
"zod-to-json-schema": "3.24.1"
"zod": "^4.4.3"
},
"devDependencies": {
"@microsoft/eslint-config-spfx": "<%= spfxVersion %>",
Expand Down
3 changes: 1 addition & 2 deletions templates/copilot-component-minimal/src/{componentName.pascal}Properties.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import { z } from 'zod';
import zodToJsonSchema from 'zod-to-json-schema';

const propertiesSchema = z.object({
message: z.string().describe('A message to display.')
});

export type I<%= componentName.pascal %>CopilotComponentProperties = z.infer<typeof propertiesSchema>;

export default zodToJsonSchema(propertiesSchema);
export default propertiesSchema.toJSONSchema();
3 changes: 1 addition & 2 deletions templates/copilot-component-noframework/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@
"@microsoft/sp-copilot-component": "<%= spfxVersion %>",
"@microsoft/sp-lodash-subset": "<%= spfxVersion %>",
"tslib": "2.3.1",
"zod": "3.24.1",
"zod-to-json-schema": "3.24.1"
"zod": "^4.4.3"
},
"devDependencies": {
"@microsoft/eslint-config-spfx": "<%= spfxVersion %>",
Expand Down
3 changes: 1 addition & 2 deletions templates/copilot-component-noframework/src/{componentName.pascal}Properties.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import { z } from 'zod';
import zodToJsonSchema from 'zod-to-json-schema';

const propertiesSchema = z.object({
message: z.string().describe('A message to display.')
});

export type I<%= componentName.pascal %>CopilotComponentProperties = z.infer<typeof propertiesSchema>;

export default zodToJsonSchema(propertiesSchema);
export default propertiesSchema.toJSONSchema();
3 changes: 1 addition & 2 deletions templates/copilot-component-react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@
"react": "17.0.1",
"react-dom": "17.0.1",
"tslib": "2.3.1",
"zod": "3.24.1",
"zod-to-json-schema": "3.24.1"
"zod": "^4.4.3"
},
"devDependencies": {
"@microsoft/eslint-config-spfx": "<%= spfxVersion %>",
Expand Down
3 changes: 1 addition & 2 deletions templates/copilot-component-react/src/{componentName.pascal}Properties.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import { z } from 'zod';
import zodToJsonSchema from 'zod-to-json-schema';

const propertiesSchema = z.object({
message: z.string().describe('A message to display.')
});

export type I<%= componentName.pascal %>CopilotComponentProperties = z.infer<typeof propertiesSchema>;

export default zodToJsonSchema(propertiesSchema);
export default propertiesSchema.toJSONSchema();