Skip to content

fix(types): zod example teaches the Zod 4 .issues accessor, and examples/ is type-checked (#2919) - #2939

Merged
os-zhuang merged 1 commit into
mainfrom
fix/zod4-errors-example
Jul 28, 2026
Merged

fix(types): zod example teaches the Zod 4 .issues accessor, and examples/ is type-checked (#2919)#2939
os-zhuang merged 1 commit into
mainfrom
fix/zod4-errors-example

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

ZodError.errors was removed in Zod 4; this repo is on zod 4.4.3.
packages/types/examples/zod-validation-example.ts
read .errors in seven places. Six printed undefined; the seventh —
invalidButtonResult.error.errors.length — threw, killing the example before its summary.

Confirmed empirically on 4.4.3 rather than assumed:

zod version: 4.4.3
.errors  -> undefined
.issues  -> ["invalid_value"]
.errors.length THREW -> TypeError: Cannot read properties of undefined (reading 'length')

And on the file itself, before the fix:

TypeError: Cannot read properties of undefined (reading 'length')
    at .../packages/types/examples/zod-validation-example.ts:182:79

After: it runs clean end-to-end and prints Expected validation errors: 2.

Same bug, same cause as the objectui validate fix in #2919 / #2936, used as the reference.

src/zod/README.md carried the same dead accessor plus a Zod 3 issue shape
(code: 'invalid_enum_value', "Invalid enum value. Expected …"). Both corrected
against what 4.4.3 actually emits: code: 'invalid_value' with a values array and
'Invalid option: expected one of …'.

Decision 1 — swap and gate, because the swap alone would rot again

Not just .errors -> .issues. The file is invisible to CI, so nothing stops the next drift.

One correction to the framing in the issue: removing "examples" from packages/types/tsconfig.json's exclude would have changed nothing. That project's include is already ["src/**/*"], so the exclude entry is belt-and-braces. Examples also cannot simply join that project — it is the package build (tsc -> dist) with rootDir: "./src", composite and declaration, so example files are both outside rootDir and would emit into dist.

So: a separate emit-free tsconfig.examples.json over examples/**/*.ts, chained from the package script:

"type-check": "tsc --noEmit && tsc -p tsconfig.examples.json"

The example also now imports ../src/zod/index.zod instead of ../dist/zod/index.zod.js — matching its three sibling example files (dashboard.ts, login-form.ts, rest-data-source.ts, all on ../src/index) — so the check needs no prior build.

Verified the gate has teeth rather than trusting the green (the standard set by #2936): restoring .errors makes tsc -p tsconfig.examples.json fail with seven

TS2339: Property 'errors' does not exist on type 'ZodError<...>'

Decision 2 — other examples/ dirs: one shares the exclusion, none share the risk

Grepped error.errors repo-wide over tracked files. Three hits beyond this file:

Location Verdict
packages/cli/src/commands/validate.ts:87 Already fixed in #2936 — clean on main.
packages/types/src/zod/README.md:246 Real — same stale accessor, fixed here.
packages/data-objectstack/src/errors.test.ts:112 False positive. BulkOperationError.errors, a custom class property, unrelated to Zod.

On the directories themselves:

  • Root examples/* — not a gap. All four are real workspace packages; byo-backend-console, console-starter and schema-catalog each already carry "type-check": "tsc --noEmit", so turbo run type-check covers them. hello-world has no build and no tsconfig and is the declared NOT_COMPILED exemption in check-type-check-coverage.mjs, re-validated on every run.
  • packages/plugin-charts/examples/chart-examples.ts — the only other package-internal examples dir, and it does share the exclusion (include: ["src"]). But it carries no imports at all — 54 lines of bare exported object literals — so there is no API surface to go stale. I deliberately did not add a tsconfig there: with nothing typed, the check would pass regardless of drift, and a gate that cannot fail is worse than an honest gap. Making it meaningful means typing those literals against the chart schemas, which is real work outside this fix.

So the systemic hole is narrower than "examples are excluded": it is package-internal examples/ dirs inside a package whose type-check is scoped to src. That set is exactly two, and only one had teeth to gain.

Verification

  • pnpm --filter @object-ui/types type-check — passes (both projects)
  • node scripts/check-type-check-coverage.mjs41/45, unchanged (no package count change)
  • npx eslint packages/types — 0 errors (263 pre-existing no-explicit-any warnings in untouched src/)
  • Example runs clean end-to-end under tsx

No runtime or published-type change — examples/ is not in the package's files.

🤖 Generated with Claude Code

…amples/` is type-checked (#2919)

`ZodError.errors` was removed in Zod 4 (the repo is on 4.4.3).
`packages/types/examples/zod-validation-example.ts` read `.errors` in seven
places, so every `console.error` printed `undefined` and the last one —
`invalidButtonResult.error.errors.length` — threw `TypeError: Cannot read
properties of undefined (reading 'length')`, killing the example before its
summary. Same bug and same cause as the `objectui validate` fix in #2919.

`src/zod/README.md` documented the same dead accessor plus a Zod 3 issue shape;
both corrected against what 4.4.3 emits (`invalid_value` + `values`, and
"Invalid option: expected one of ...").

The example was invisible to CI, so the swap alone would let this rot again.
`packages/types` type-checks a project whose `include` is `["src/**/*"]`, so
`examples/` sat outside it — the `"examples"` entry in `exclude` was
belt-and-braces, and deleting it alone would have changed nothing. Examples
cannot join that project either: it is the package build (`tsc` -> `dist`) with
`rootDir: "./src"`, `composite` and `declaration`.

Added an emit-free `tsconfig.examples.json` and chained it from `type-check`.
The example now imports `../src/zod/index.zod` instead of
`../dist/zod/index.zod.js`, matching its three sibling example files, so the
check needs no prior build.

Verified the gate has teeth: restoring `.errors` fails with seven
`TS2339: Property 'errors' does not exist on type 'ZodError<...>'`.

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 28, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
objectui Ignored Ignored Jul 28, 2026 5:21pm

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation dependencies package: types labels Jul 28, 2026
@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Main entry (gzip) 27.9 KB 350 KB
Entry file index-B1LNlMWm.js
Status PASS

📦 Bundle Size Report

Package Size Gzipped
app-shell (index.js) 8.20KB 2.97KB
app-shell (runtime-config.js) 7.42KB 2.32KB
app-shell (types.js) 0.01KB 0.04KB
app-shell (urlParams.js) 7.57KB 2.97KB
auth (AuthContext.js) 0.31KB 0.24KB
auth (AuthGuard.js) 1.17KB 0.53KB
auth (AuthProvider.js) 22.10KB 4.37KB
auth (AuthShell.js) 3.49KB 1.40KB
auth (ForgotPasswordForm.js) 12.12KB 3.41KB
auth (LoginForm.js) 17.86KB 5.29KB
auth (PreviewBanner.js) 0.90KB 0.50KB
auth (RegisterForm.js) 6.43KB 2.09KB
auth (SocialSignInButtons.js) 9.60KB 3.89KB
auth (UserMenu.js) 3.40KB 1.22KB
auth (auth-gate-events.js) 1.29KB 0.66KB
auth (authStyles.js) 5.04KB 1.72KB
auth (createAuthClient.js) 35.76KB 9.11KB
auth (createAuthenticatedFetch.js) 4.37KB 1.69KB
auth (index.js) 2.25KB 1.01KB
auth (org-roles.js) 6.72KB 2.85KB
auth (phone-identifier.js) 1.11KB 0.66KB
auth (types.js) 0.59KB 0.35KB
auth (useAuth.js) 4.91KB 0.87KB
auth (useIsWorkspaceAdmin.js) 1.61KB 0.85KB
collaboration (CommentThread.js) 18.38KB 4.49KB
collaboration (LiveCursors.js) 3.17KB 1.27KB
collaboration (PresenceAvatars.js) 3.65KB 1.42KB
collaboration (PresenceProvider.js) 2.79KB 1.13KB
collaboration (index.js) 1.25KB 0.53KB
collaboration (useCommentSearch.js) 1.98KB 0.88KB
collaboration (useConflictResolution.js) 7.75KB 1.86KB
collaboration (useMentionNotifications.js) 1.81KB 0.68KB
collaboration (usePresence.js) 6.33KB 1.84KB
collaboration (useRealtimeSubscription.js) 7.91KB 2.01KB
components (index.js) 450.13KB 97.92KB
core (index.js) 2.16KB 0.78KB
create-plugin (index.js) 9.28KB 2.98KB
data-objectstack (index.js) 127.78KB 32.15KB
fields (index.js) 220.07KB 53.90KB
i18n (LocalizationContext.js) 1.76KB 0.96KB
i18n (currency.js) 1.22KB 0.64KB
i18n (i18n.js) 4.32KB 1.77KB
i18n (index.js) 2.46KB 0.96KB
i18n (pickLocalized.js) 1.70KB 0.83KB
i18n (provider.js) 5.37KB 1.72KB
i18n (useObjectLabel.js) 25.17KB 5.80KB
i18n (useSafeTranslation.js) 3.26KB 1.44KB
layout (index.js) 38.45KB 10.67KB
mobile (MobileProvider.js) 0.92KB 0.49KB
mobile (ResponsiveContainer.js) 0.94KB 0.38KB
mobile (breakpoints.js) 1.51KB 0.70KB
mobile (createOfflineDataSource.js) 5.61KB 1.74KB
mobile (index.js) 1.50KB 0.62KB
mobile (offlineQueue.js) 3.91KB 1.35KB
mobile (pwa.js) 0.97KB 0.49KB
mobile (serviceWorker.js) 1.48KB 0.62KB
mobile (serviceWorkerSource.js) 3.41KB 1.48KB
mobile (useBreakpoint.js) 1.54KB 0.65KB
mobile (useGesture.js) 4.42KB 1.27KB
mobile (useOfflineSync.js) 1.99KB 0.72KB
mobile (usePullToRefresh.js) 2.53KB 0.85KB
mobile (useResponsive.js) 0.71KB 0.42KB
mobile (useResponsiveConfig.js) 1.36KB 0.63KB
mobile (useSpecGesture.js) 1.77KB 0.77KB
mobile (useTouchTarget.js) 1.01KB 0.54KB
permissions (MePermissionsProvider.js) 6.84KB 2.42KB
permissions (PermissionContext.js) 0.31KB 0.25KB
permissions (PermissionGuard.js) 0.89KB 0.45KB
permissions (PermissionProvider.js) 3.67KB 1.12KB
permissions (evaluator.js) 4.41KB 1.44KB
permissions (index.js) 0.91KB 0.41KB
permissions (store.js) 0.91KB 0.42KB
permissions (useFieldPermissions.js) 1.28KB 0.52KB
permissions (usePermissions.js) 1.55KB 0.71KB
plugin-ai (index.js) 15.71KB 3.79KB
plugin-calendar (index.js) 44.90KB 12.35KB
plugin-charts (index.js) 57.26KB 16.24KB
plugin-chatbot (index.js) 179.93KB 42.67KB
plugin-dashboard (index.js) 109.60KB 28.33KB
plugin-designer (index.js) 210.56KB 42.56KB
plugin-detail (index.js) 216.77KB 53.01KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 103.51KB 25.12KB
plugin-gantt (index.js) 162.26KB 39.53KB
plugin-grid (index.js) 179.35KB 46.97KB
plugin-kanban (index.js) 47.82KB 13.18KB
plugin-list (index.js) 98.55KB 23.28KB
plugin-map (index.js) 16.80KB 5.24KB
plugin-markdown (index.js) 13.65KB 4.67KB
plugin-report (index.js) 37.07KB 9.81KB
plugin-timeline (index.js) 25.03KB 7.11KB
plugin-tree (index.js) 8.36KB 2.81KB
plugin-view (index.js) 85.68KB 20.85KB
providers (DataSourceProvider.js) 0.75KB 0.39KB
providers (MetadataProvider.js) 1.37KB 0.59KB
providers (ThemeProvider.js) 1.55KB 0.67KB
providers (UploadProvider.js) 11.71KB 3.53KB
providers (index.js) 0.44KB 0.22KB
providers (types.js) 0.01KB 0.04KB
react-runtime (index.js) 3.19KB 1.38KB
react (LazyPluginLoader.js) 3.77KB 1.33KB
react (SchemaRenderer.js) 18.70KB 6.09KB
react (data-invalidation.js) 5.05KB 2.08KB
react (index.js) 1.00KB 0.55KB
sdui-parser (codegen.js) 4.09KB 1.74KB
sdui-parser (index.js) 2.16KB 0.94KB
sdui-parser (parse.js) 10.04KB 2.82KB
sdui-parser (types.js) 0.29KB 0.24KB
sdui-parser (validate.js) 4.69KB 1.48KB
types (ai.js) 0.20KB 0.17KB
types (api-types.js) 0.20KB 0.18KB
types (app.js) 2.87KB 0.99KB
types (base.js) 0.20KB 0.18KB
types (blocks.js) 0.20KB 0.18KB
types (complex.js) 0.20KB 0.18KB
types (crud.js) 0.20KB 0.18KB
types (data-display.js) 0.20KB 0.18KB
types (data-protocol.js) 0.20KB 0.19KB
types (data.js) 0.20KB 0.18KB
types (designer.js) 0.77KB 0.41KB
types (disclosure.js) 0.20KB 0.18KB
types (feedback.js) 0.20KB 0.18KB
types (field-types.js) 0.20KB 0.18KB
types (form.js) 0.20KB 0.18KB
types (index.js) 1.86KB 0.91KB
types (layout.js) 0.20KB 0.18KB
types (managed-by.js) 0.19KB 0.18KB
types (mobile.js) 0.20KB 0.18KB
types (navigation.js) 0.20KB 0.18KB
types (objectql.js) 0.20KB 0.18KB
types (overlay.js) 0.20KB 0.18KB
types (permissions.js) 0.20KB 0.18KB
types (plugin-scope.js) 0.20KB 0.18KB
types (record-components.js) 0.20KB 0.19KB
types (record-semantics.js) 1.28KB 0.67KB
types (registry.js) 0.20KB 0.18KB
types (reports.js) 0.20KB 0.18KB
types (spec-report.js) 5.04KB 1.93KB
types (system-fields.js) 2.39KB 1.17KB
types (theme.js) 0.20KB 0.18KB
types (ui-action.js) 0.75KB 0.46KB
types (views.js) 0.20KB 0.18KB
types (widget.js) 0.20KB 0.18KB

Size Limits

  • ✅ Core packages should be < 50KB gzipped
  • ✅ Component packages should be < 100KB gzipped
  • ⚠️ Plugin packages should be < 150KB gzipped

@os-zhuang
os-zhuang merged commit 9867281 into main Jul 28, 2026
16 checks passed
@os-zhuang
os-zhuang deleted the fix/zod4-errors-example branch July 28, 2026 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies documentation Improvements or additions to documentation package: types

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant