Skip to content

fix(types,layout): nav item type component joins NavigationItemType and its zod enum - #3039

Merged
os-zhuang merged 1 commit into
mainfrom
claude/navigationitemtype-layout-enum-6c6985
Jul 30, 2026
Merged

fix(types,layout): nav item type component joins NavigationItemType and its zod enum#3039
os-zhuang merged 1 commit into
mainfrom
claude/navigationitemtype-layout-enum-6c6985

Conversation

@os-zhuang

@os-zhuang os-zhuang commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Closes #2918.

The zod enum was the part that bit

Both renderer sites (NavigationRenderer.tsx, AppSchemaRenderer.tsx) carry a full, fleshed-out component nav item implementation — componentRef colon-split to /component/<ns>/<name>, params serialised as querystring, metadata:* special-cases — and the route (component/:ns/:name → ComponentNavView) exists in app-shell. But NavigationItemType never gained the member, and NavigationItemTypeSchema rejected type: 'component' at validation time, so authors could not declare one. The feature was dead on arrival rather than dead code.

Not a cross-repo change: @objectstack/spec already ships ComponentNavItemSchema (componentRef: string, params?: Record<string, unknown>, doc example componentRef: 'metadata:resource'). objectui's local copy of the vocabulary was simply behind; the new fields mirror spec's shape.

What moved

  • @object-ui/types — 'component' in both the TS union and the zod enum (two copies of one vocabulary, moved together). NavigationItem gains componentRef + params (params is shared with type: 'page', which already forwarded it). Both are declared in zod too, so parse keeps them — without that, an item would validate and then render # because strip-mode parse dropped the fields the renderer reads.
  • @object-ui/layout — the (item as any).componentRef / params casts in the two component branches (and the page-params site) become typed access.
  • @object-ui/plugin-designer — the exhaustive Record<NavigationItemType, …> type-meta map gains a component badge entry (indigo, Puzzle); appDesigner.navTypeComponent added to the designer's English fallback and all 10 locales (all-locales-key-parity enforces the sweep).
  • Closing out the DEBT entry — layout gains "type-check": "tsc --noEmit && tsc -p tsconfig.test.json" with the fix(plugin-map): drop the maplibre-gl@6 default import + gate type-check in CI (#2911) #2915 paths override (verified: no TS6059 flood, and the guard's new test-coverage rule is satisfied via tsconfig.test.json on the packages/types model). The @object-ui/layout entry in check-type-check-coverage.mjs is deleted; the guard now reports 42/45 via type-check.

End-to-end proof (validates → routes → renders)

  • validates: navigation-model.test.ts parses a component item and asserts componentRef/params survive (safeParse success alone would not catch strip).
  • routes: resolveHref.test.ts gains a component-targets suite — /component/<ns>/<name>, params querystring (non-strings as JSON), missing-ref dead link, metadata:directory / metadata:resource nested paths, and template-var params resolving via contextValues (dropped when unscoped).
  • renders: AppSchemaRenderer.test.tsx renders a component item through the real sidebar and asserts the anchor's href.

Verification

check result
layout tsc --noEmit (was the 2 errors) clean
layout tsc -p tsconfig.test.json clean
types build + tests/examples tsconfigs clean
plugin-designer src + test tsc clean
app-shell tsc --noEmit clean
i18n tsc --noEmit clean
node scripts/check-type-check-coverage.mjs ✅ 42/45
vitest: navigation-model, resolveHref, AppSchemaRenderer, full i18n suite, full types + designer suites 62 + 155 + 269 tests, all green

🤖 Generated with Claude Code

@os-zhuang @claude
fix(types,layout): nav item type 'component' joins NavigationItemType…
af0f4d1 
… and its zod enum (#2918)

The renderers have carried a full `type: 'component'` implementation
(componentRef → /component/<ns>/<name>, params → querystring, metadata:*
special-cases), and @objectstack/spec has ComponentNavItem — but the
local vocabulary never gained the member. NavigationItemTypeSchema
rejected `type: 'component'` at validation time, so authors could not
declare one: the feature was dead on arrival rather than dead code.

- NavigationItemType + NavigationItemTypeSchema gain 'component';
  NavigationItem gains componentRef/params (declared in zod too, so
  parse no longer strips them), mirroring spec's ComponentNavItem.
- The `(item as any)` casts in the two renderer sites become typed.
- NavigationDesigner's exhaustive Record gains a component entry, with
  appDesigner.navTypeComponent in the designer fallback + 10 locales.
- layout gains "type-check" (src + tests via tsconfig.test.json, with
  the #2915 paths override); its DEBT entry is deleted — coverage is
  now 42/45.

Proof: navigation-model.test.ts validates a component item end-to-end,
resolveHref.test.ts covers the /component and metadata:* routing, and
AppSchemaRenderer.test.tsx renders one through the real sidebar.

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

vercel Bot commented Jul 30, 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 30, 2026 1:08pm

Request Review

@github-actions

github-actions Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Main entry (gzip) 27.9 KB 350 KB
Entry file index-ES5gneGW.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) 457.71KB 100.07KB
core (index.js) 2.16KB 0.78KB
create-plugin (index.js) 9.28KB 2.98KB
data-objectstack (index.js) 134.67KB 34.24KB
fields (index.js) 222.07KB 54.35KB
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) 6.96KB 1.98KB
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) 4.05KB 1.53KB
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) 60.52KB 17.11KB
plugin-chatbot (index.js) 180.09KB 42.72KB
plugin-dashboard (index.js) 111.59KB 28.74KB
plugin-designer (index.js) 210.73KB 42.59KB
plugin-detail (index.js) 221.50KB 54.15KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 106.35KB 25.82KB
plugin-gantt (index.js) 162.26KB 39.53KB
plugin-grid (index.js) 183.96KB 48.23KB
plugin-kanban (index.js) 47.82KB 13.18KB
plugin-list (index.js) 102.39KB 24.18KB
plugin-map (index.js) 16.80KB 5.24KB
plugin-markdown (index.js) 13.65KB 4.67KB
plugin-report (index.js) 40.32KB 10.53KB
plugin-timeline (index.js) 25.75KB 7.32KB
plugin-tree (index.js) 8.36KB 2.81KB
plugin-view (index.js) 85.91KB 20.99KB
providers (DataSourceProvider.js) 0.75KB 0.39KB
providers (MetadataProvider.js) 1.37KB 0.59KB
providers (ThemeProvider.js) 1.90KB 0.85KB
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) 5.67KB 2.37KB
react (LazyPluginLoader.js) 3.77KB 1.33KB
react (SchemaRenderer.js) 19.28KB 6.38KB
react (data-invalidation.js) 5.05KB 2.08KB
react (index.js) 1.02KB 0.55KB
sdui-parser (codegen.js) 4.09KB 1.74KB
sdui-parser (index.js) 3.47KB 1.54KB
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 (error-code.js) 1.54KB 0.88KB
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) 2.00KB 0.96KB
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) 1.08KB 0.64KB
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 b5b97e2 into main Jul 30, 2026
16 checks passed
@os-zhuang
os-zhuang deleted the claude/navigationitemtype-layout-enum-6c6985 branch July 30, 2026 13:15
xuyushun441-sys pushed a commit that referenced this pull request Jul 30, 2026
@os-zhuang @claude
Merge origin/main into claude/chart-view-label-icon-385ace
110a567 
Conflict was structural, not semantic: #3039 (issue #2918, the `layout` nav-type
gap) and this branch (issue #2916) each removed a different entry from the same
three-line `DEBT` object in `scripts/check-type-check-coverage.mjs`. Both removals
are correct and independent, so the resolution keeps neither — `DEBT` is now empty,
which the guard reports as `0 known-broken`.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

dependencies package: types plugin tests

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

layout: nav item type component is implemented but missing from NavigationItemType and its zod enum — authors cannot declare it

1 participant

@os-zhuang