paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 34 Packages Projects Releases Wiki Activity

frontend-plugin-api: clarify that zod v3 /v4 subpath does not support configSchema

Browse Source 
Update error messages, deprecation warnings, migration docs, release
notes, and changelogs to reflect that the zod/v4 subpath export from
the Zod v3 package does not support JSON Schema conversion via the
Standard Schema interface. Users must fully migrate to the zod v4
package (zod@^4.0.0) to use configSchema.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
This commit is contained in:
Patrik Oldsberg
2026-04-16 17:23:54 +02:00
parent ebfa023123
commit 72a552f0db
8 changed files with 22 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/releases/v1.50.0.md
+2 -6
View File
@@ -20,17 +20,13 @@ To get ownership info for the current user, code should use the `userInfo` core
The new frontend system now uses [Standard Schema](https://github.com/standard-schema/standard-schema) for extension configuration. A new `configSchema` option has been added to `createExtension`, `createExtensionBlueprint`, as well as the `override` and `makeWithOverrides` methods on extension definitions and blueprints. This option accepts direct schema values from any Standard Schema compatible library with JSON Schema support, replacing the old `config.schema` callback format which is now deprecated.
To use the new `configSchema` option with Zod, you need Zod v4 or the `zod/v4` subpath export from the Zod v3 package. The `zod/v4` subpath requires a minimum Zod version of **3.25.0** — make sure to update your Zod dependency if needed:
To use the new `configSchema` option with Zod, you need Zod v4 (`zod@^4.0.0`):
```ts
// Either use Zod v4 directly (requires zod@^4.0.0):
import { z } from 'zod';
// Or the v4 subpath from the Zod v3 package (requires zod@^3.25.0):
import { z } from 'zod/v4';
```
Note that direct Zod v3 schemas are **not** supported by the new `configSchema` option — they only work with the deprecated `config.schema` callback format.
Note that neither direct Zod v3 schemas nor the `zod/v4` subpath export from the Zod v3 package are supported by the new `configSchema` option. While the `zod/v4` subpath exposes the Zod v4 API surface, the resulting schema objects do not support the JSON Schema conversion that `configSchema` requires. A full migration to the `zod` v4 package is needed. Direct Zod v3 schemas only work with the deprecated `config.schema` callback format.
The deprecated `createSchemaFromZod` helper has been removed from `@backstage/frontend-plugin-api`.