Skip to content

fix(plugin-designer): NAV_TYPE_META has an entry for the spec's doc navigation item type (#10287) - #10315

Merged
objectstack-fleet[bot] merged 1 commit into
mainfrom
claude/issue-10287-navigation-designer-doc-type
Sep 24, 2026
Merged

objectstack-fleet[bot] merged 1 commit into
mainfrom
claude/issue-10287-navigation-designer-doc-type

Conversation

@objectstack-fleet

Copy link
Copy Markdown
Contributor

Fixes #10287
Clause-②: no

What was wrong

objectstack#19789 added a doc member to the spec's navigation item union. In packages/plugin-designer/src/NavigationDesigner.tsx, NAV_TYPE_META is a Record keyed by the spec-derived NavigationItemType, and it had nine entries and no doc. So Spec Main Shape Gate, which compiles objectui against @objectstack/spec built from objectstack main, failed with TS2741 on that map on main and on every PR head. The TS7016 errors in app-shell's AppContent.tsx were a knock-on effect of the failed plugin-designer build.

What changed

  • NAV_TYPE_META gets a doc entry: labelKey: 'appDesigner.navTypeDoc', bg-blue-100 text-blue-700 (a colour none of the other nine use), and lucide BookOpen.
  • It has to compile against two specs. The pinned @objectstack/spec 17.4.0 has no doc, so a plain doc: key is an excess property there (TS2353). objectstack main has doc, so the gate fails without the key (TS2741). The map is now a Record keyed by NavigationItemType | 'doc', which compiles against both. A comment in the code says the | 'doc' goes at the pin bump that ships doc. The map is still a Record over the spec-derived union, not Partial and not string-keyed.
  • appDesigner.navTypeDoc is added to the useDesignerTranslation English fallback table and to all ten locale packs, each in its own language.
  • Guard test packages/plugin-designer/src/__tests__/NavigationDesigner.specNavTypes.test.tsx: it reads the discriminants of the installed spec's NavigationItemSchema at runtime, renders one item of each type in the tree and the live preview, and asserts that the type badge shows a label and not a raw key. It checks that every spec type is in the map, not that the two sets are equal, because the map has doc before the pin does. Run against the pinned spec it covers 9 types. Run against a spec built from main it covers 10.
  • doc is not added to QUICK_ADD_TYPES. An empty doc item fails the spec's book-or-doc requirement, and authoring one belongs to objectui#10188.
  • Changeset: @object-ui/plugin-designer and @object-ui/i18n patch.

Verification (every run below is on head 6f970da0)

The gate's own path, reproduced locally. objectstack main was 6bf7f1c0b441 when this was read. I made a sparse, blobless clone of it the way the workflow does, ran pnpm --filter @objectstack/spec build, ran npm pack --ignore-scripts, and ran node scripts/spec-main-shape-gate.mjs inject into a separate objectui worktree. The inject step re-pointed zod to 4.6.1, which is the gate's own behaviour. Then I ran a forced turbo type-check --continue in that worktree, with a private cache dir.

run objectui tree scope result
RED 8b1f0661 (origin/main) --filter=@object-ui/plugin-designer (17 tasks) plugin-designer:type-check fails at NavigationDesigner.tsx(82,7) with TS2741 "Property 'doc' is missing". The gate's report step exits 1 and attributes the error to that file and to 6bf7f1c0b441.
GREEN 6f970da0 (this branch) --filter=...@object-ui/plugin-designer (40 tasks) Tasks: 40 successful, 40 total, 0 error TS. The report step exits 0: "objectui type-checks against @objectstack/spec at that commit."

The GREEN scope is plugin-designer and its dependents: plugin-designer, app-shell, console, example-console-starter and example-byo-backend-console type-check, plus 33 builds, including the plugin-designer and app-shell builds that the failure had been hiding. Nothing new surfaces once the build is unblocked. I narrowed the scope on purpose: a package that does not depend on plugin-designer cannot be moved by this diff, and the full-graph run is this PR's own Spec Main Shape Gate check.

Pinned spec (17.4.0), normal path. pnpm --filter @object-ui/plugin-designer --filter @object-ui/i18n type-check passes. Both tsc --noEmit && tsc -p tsconfig.test.json scripts echoed. tsc -p tsconfig.test.json --listFiles includes the new test file.

Ablation. I committed the change first. ablation-replace.mjs deleted the doc entry line and verified it on disk (anchor count 1 to 0, blob dc6cc9b5f055 to a1ec0cb78efb). It then restored the file to HEAD and proved the restore (the blob matches HEAD's and git diff HEAD is empty).

leg with the doc entry doc entry deleted
gate path (main spec): plugin-designer type-check green TS2741 "Property 'doc' is missing"
gate path (main spec): guard test 11 passed 1 failed: "draws the doc type…", TypeError: Cannot read properties of undefined (reading 'Icon')
pinned spec: plugin-designer type-check green TS2741, because the Record key now includes 'doc'
pinned spec: plugin-designer type-check with | 'doc' removed from the key — TS2353 "'doc' does not exist in type" (this shows the extra union member is needed)

Suites, run from the repo root:

  • pnpm exec vitest run packages/plugin-designer/ packages/i18n/ packages/app-shell/src/__tests__/defaults-maps-mirror-en-pack.test.tsx: Test Files 94 passed (94), Tests 1340 passed (1340).
  • The three files run by name (all-locales-key-parity, defaults-maps-mirror-en-pack, the guard test): 3 passed, 57 tests passed.

Gates, all exit 0:

  • check:i18n-keys, check:i18n-drift (1 key added, 0 en values changed), check:i18n-dead-keys (report only; navTypeDoc lands in needs-review like its nine siblings, because the key is reached through the map and not through a literal t() call), check:control-bytes, check:new-line-citations (0 new);
  • node scripts/check-changeset-presence.mjs, check:changeset-claims, check:pending-changeset-literals;
  • check:phantom-deps, check:unused-deps, check:icon-record-names, check:spec-symbols, check:test-path-roots, check:designer-field-key-parity, check:installed-pin-claims, check:published-tsconfig-exclude, check:published-dist, check:vi-mock-inherit, check:unreferenced-sources.

Lint, narrowed to the files this PR touches:

  1. Population: pnpm lint is turbo run lint, which runs eslint . per package. eslint --print-config resolves a config for each of the 13 changed .ts/.tsx files, so none of them is ignored.
  2. eslint --no-inline-config --format json on those 13 files reports 0 errors and 4 warnings. All 4 are in NavigationDesigner.tsx. The base version of that file, linted through stdin, gives the same 4 warnings, and none of them is on a changed line.
  3. eslint.config.js does not turn on type-aware linting (no parserOptions.project or projectService), and no rule under eslint-rules/ reads other files. So this diff cannot change the verdict on any file it does not touch.

NOT MEASURED:

  • check:eager-locale-catalogues: PREREQUISITE NOT MET, it needs apps/console/dist/eager-closure.json.
  • check:doc-examples: prerequisite not met, it needs built dist/ for about 20 packages. This diff touches no doc example.
  • Both are left to CI's build jobs.

Acceptance notes

  • Out of scope, as the triage recorded: the product gaps around doc belong to objectui#10188, not this PR. They are the NavigationRenderer and navSurface default: fallthroughs, the AppNavCanvas KIND_TONE fallback, AppCreationWizard TYPE_BADGE_COLORS, the hand-written nine-member NavigationItemTypeSchema in packages/types, and quick-add or authoring of doc items.
  • Wording now slightly out of date: the doc comment on NavigationItemType in packages/types/src/app.ts still describes NAV_TYPE_META as keyed by exactly NavigationItemType. The point it makes (a new spec member breaks the compile loudly) still holds. The wording goes back to exact at the pin bump. It is outside this surface, so I left it.
  • A hazard when reproducing the gate locally, for whoever runs it next: turbo 2.10 shares one local cache across linked git worktrees ("using shared worktree cache"). Turbo's hash does not cover node_modules. So a gate reproduction in a linked worktree writes build outputs compiled against the injected spec into the cache that sibling worktrees read. The workflow's TURBO_FORCE bypasses cache reads but does not stop the writes. Pass --cache-dir pointing at a private directory. My first attempt did write 6 entries before I stopped it. I compared each of them with the same package built against the pinned spec, and all 6 are byte-identical, so nothing wrong is in the shared cache.

Written by the domain:ui seat #1 dev agent, session https://claude.ai/code/session_01BA3nKVUwKQJf8DBxrSVtNC.


Generated by Claude Code

… navigation item type

objectstack#19789 widened the spec's navigation item union with `doc`, and
`NAV_TYPE_META` is a Record keyed by that spec-derived union, so objectui
stopped compiling against @objectstack/spec built from objectstack main (the
Spec Main Shape Gate, TS2741 on NavigationDesigner).

- `doc` entry: `appDesigner.navTypeDoc`, `bg-blue-100 text-blue-700`, `BookOpen`.
- The map is typed `Record<NavigationItemType | 'doc', ...>`: the pinned spec
  17.4.0 has no `doc`, so a plain `doc:` key is an excess property there. The
  `| 'doc'` goes at the pin bump that ships `doc`.
- `appDesigner.navTypeDoc` fallback in useDesignerTranslation and all ten
  locale packs.
- Guard test: every discriminant of the installed spec's NavigationItemSchema
  renders a row with a resolved type badge (spec subset of map, not equality).
- `doc` is deliberately NOT in QUICK_ADD_TYPES: an empty doc item fails the
  spec's book-or-doc requirement; authoring it is objectui#10188.

Co-authored-by: Claude <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BA3nKVUwKQJf8DBxrSVtNC
@github-actions

Copy link
Copy Markdown
Contributor

changeset-claim-re-read

⚠️ 2 pending changeset(s) describe a file this change touches

Their bodies publish verbatim into the CHANGELOG at the next release, so this is a request to re-read them against your diff — addressed here because you are the one seat that can answer it without re-deriving anything.

⛔ Nothing here blocks, and nothing here is a verdict on your change. This gate exits 0, is not a required context, and judges name resolution, never meaning: it asked whether a pending body names a file you touched. "Is this sentence still true?" is the one question it will not answer, and the one you are being asked to answer.

.changeset/6310-designer-formula-key-retired.md

  • names packages/plugin-designer/src/hooks/useDesignerTranslation.ts → packages/plugin-designer/src/hooks/useDesignerTranslation.ts — edited by this change

    objectui#6043 retired the Field Designer's formula-expression textarea, which was the key's only call site (FieldDesigner.tsx, the { name: 'formula', label: t('appDesigner.fieldDesigner.formula') } field descriptor). The value outlived it in eleven places: DESIGNER_DEFAULT_TRANSLATIONS in packages/plugin-designer/src/hooks/useDesignerTranslation.ts, and the appDesigner > fieldDesigner > formula leaf of packages/i18n/src/locales/{en,de,es,fr,pt,ru,ja,ko,zh,ar}.ts.

.changeset/6661-app-launcher-nav-menu-renderers.md

  • names en.ts → packages/i18n/src/locales/en.ts — edited by this change

    Three new strings — the launcher's and the menu's accessible names, and the menu's empty state — are declared under console.nav in en.ts and its nine sibling packs. An inline defaultValue alone is not a fix: it renders English at one call site and leaves the string untranslatable everywhere (objectui#3517).

Read the paragraph, not the line: both false halves of the objectui#8617 claim sat in one paragraph, and correcting either alone would have left it asserting the same wrong thing.

If a claim did go false, correct the body. That is precedented and prose-only, frontmatter untouched; check-changeset-overwrite.mjs will report the correction as its own case 2 ("correcting a declaration on purpose … legitimate"), which is the intended shape — one gate asks for the read, the other records the write.

Not covered, stated so nobody reads this as more: a born-false claim that spells no line address at all (objectui#9495 coordinated one by ORDINAL — "a grep finds that member first" — and deciding that means reading what the sentence means), a claim spelled as a symbol or a package rather than a backticked file name, and a file named ambiguously.

Compared the checked-out tree with 8b1f06619 (merge-base with origin/main): 13 file(s) changed outside .changeset/, read against 1295 pending declaration(s) that publish a body (1864 pending in total). · run

@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Eager closure (gzip, 329 chunks) 3039.2 KB 3104.5 KB
Main entry chunk (gzip) 147.8 KB 350 KB
Entry file index-DOH1fdA5.js —
Status PASS —

The eager closure is every chunk the entry reaches through static imports — what the browser fetches and parses before the app renders. The entry chunk on its own is a small fraction of it.


📦 Bundle Size Report

Package Size Gzipped
app-shell (consoleActionDispatch.js) 0.20KB 0.19KB
app-shell (index.js) 16.68KB 6.20KB
app-shell (runtime-config.js) 20.68KB 7.36KB
app-shell (types.js) 0.01KB 0.04KB
app-shell (urlParams.js) 10.06KB 3.86KB
auth (ActiveOrganizationStorage.js) 25.05KB 9.16KB
auth (AuthContext.js) 0.31KB 0.24KB
auth (AuthGuard.js) 2.07KB 1.00KB
auth (AuthProvider.js) 40.18KB 10.59KB
auth (AuthShell.js) 3.49KB 1.40KB
auth (ForgotPasswordForm.js) 12.21KB 3.45KB
auth (LoginForm.js) 18.15KB 5.39KB
auth (PreviewBanner.js) 0.90KB 0.50KB
auth (RegisterForm.js) 6.65KB 2.22KB
auth (SocialSignInButtons.js) 9.61KB 3.89KB
auth (UserMenu.js) 3.41KB 1.23KB
auth (auth-gate-events.js) 1.29KB 0.66KB
auth (authStyles.js) 5.04KB 1.72KB
auth (createAuthClient.js) 40.21KB 10.80KB
auth (createAuthenticatedFetch.js) 8.46KB 3.43KB
auth (index.js) 3.19KB 1.44KB
auth (invitation-status.js) 1.22KB 0.70KB
auth (org-roles.js) 6.66KB 2.78KB
auth (phone-identifier.js) 1.11KB 0.66KB
auth (types.js) 0.59KB 0.35KB
auth (useAuth.js) 5.30KB 1.02KB
auth (useWorkspaceAdminStatus.js) 11.08KB 4.58KB
collaboration (CommentThread.js) 26.08KB 7.56KB
collaboration (LiveCursors.js) 3.17KB 1.27KB
collaboration (PresenceAvatars.js) 6.49KB 2.64KB
collaboration (PresenceProvider.js) 2.79KB 1.13KB
collaboration (index.js) 1.68KB 0.73KB
collaboration (useCollaborationTranslation.js) 6.05KB 2.52KB
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) 541.66KB 129.51KB
core (index.js) 8.94KB 3.59KB
create-plugin (index.js) 27.94KB 9.51KB
data-objectstack (index.js) 222.47KB 61.83KB
fields (index.js) 253.41KB 64.01KB
i18n (LocalizationContext.js) 1.76KB 0.96KB
i18n (builtinAggregateLabels.js) 0.86KB 0.49KB
i18n (currency.js) 1.22KB 0.64KB
i18n (fallbackInterpolation.js) 6.25KB 2.77KB
i18n (i18n.js) 8.87KB 3.64KB
i18n (index.js) 5.22KB 2.26KB
i18n (pickLocalized.js) 9.86KB 3.95KB
i18n (provider.js) 33.36KB 10.88KB
i18n (useDisplayLocale.js) 2.85KB 1.45KB
i18n (useObjectLabel.js) 34.34KB 9.17KB
i18n (useSafeTranslation.js) 5.60KB 2.33KB
layout (index.js) 39.15KB 11.05KB
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.75KB
mobile (index.js) 1.99KB 0.87KB
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) 6.62KB 2.45KB
mobile (useResponsive.js) 0.72KB 0.42KB
mobile (useSpecGesture.js) 5.52KB 2.10KB
mobile (useTouchTarget.js) 1.01KB 0.54KB
permissions (MePermissionsProvider.js) 13.52KB 4.88KB
permissions (PermissionContext.js) 0.31KB 0.25KB
permissions (PermissionGuard.js) 0.89KB 0.45KB
permissions (PermissionProvider.js) 6.24KB 2.16KB
permissions (discardProofCache.js) 1.04KB 0.55KB
permissions (evaluator.js) 8.39KB 3.10KB
permissions (index.js) 0.93KB 0.41KB
permissions (store.js) 0.91KB 0.42KB
permissions (useFieldPermissions.js) 1.28KB 0.53KB
permissions (usePermissions.js) 4.83KB 2.27KB
plugin-ai (index.js) 14.81KB 3.63KB
plugin-calendar (index.js) 51.44KB 14.62KB
plugin-charts (index.js) 71.82KB 20.13KB
plugin-chatbot (index.js) 198.27KB 47.18KB
plugin-dashboard (index.js) 133.00KB 35.19KB
plugin-designer (index.js) 216.12KB 44.37KB
plugin-detail (index.js) 258.85KB 67.53KB
plugin-editor (index.js) 2.23KB 1.05KB
plugin-form (index.js) 144.77KB 37.17KB
plugin-gantt (index.js) 167.99KB 41.37KB
plugin-grid (index.js) 215.46KB 58.88KB
plugin-kanban (index.js) 48.83KB 15.21KB
plugin-list (index.js) 113.90KB 28.11KB
plugin-map (index.js) 21.74KB 7.07KB
plugin-markdown (index.js) 13.88KB 4.80KB
plugin-report (index.js) 43.55KB 11.99KB
plugin-timeline (index.js) 30.68KB 8.95KB
plugin-tree (index.js) 10.56KB 3.71KB
plugin-view (index.js) 85.18KB 21.05KB
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.66KB 3.50KB
providers (index.js) 0.45KB 0.23KB
providers (types.js) 0.01KB 0.04KB
react-runtime (index.js) 5.62KB 2.34KB
react (LazyPluginLoader.js) 4.47KB 1.63KB
react (SchemaRenderer.js) 110.46KB 36.33KB
react (data-invalidation.js) 5.05KB 2.08KB
react (index.js) 4.63KB 2.18KB
react (schema-input.js) 4.25KB 2.04KB
react (spec-input.js) 0.20KB 0.18KB
sdui-parser (body-dialect.js) 4.78KB 2.09KB
sdui-parser (codegen.js) 6.58KB 2.74KB
sdui-parser (dashboard-widget-options.js) 3.08KB 1.30KB
sdui-parser (index.js) 5.78KB 2.56KB
sdui-parser (input-type.js) 2.84KB 1.40KB
sdui-parser (kanban-quick-add.js) 3.89KB 1.87KB
sdui-parser (parse.js) 25.28KB 7.80KB
sdui-parser (provenance.js) 3.66KB 1.82KB
sdui-parser (types.js) 0.28KB 0.23KB
sdui-parser (validate.js) 18.27KB 6.20KB
types (ai.js) 4.11KB 2.06KB
types (api-types.js) 0.20KB 0.18KB
types (app.js) 2.87KB 1.00KB
types (base.js) 0.20KB 0.18KB
types (blocks.js) 0.20KB 0.18KB
types (complex.js) 2.93KB 1.49KB
types (crud.js) 0.20KB 0.18KB
types (dashboard-filter-alias.js) 6.23KB 2.74KB
types (data-display.js) 3.75KB 1.85KB
types (data-protocol.js) 0.20KB 0.19KB
types (data.js) 0.20KB 0.18KB
types (designer.js) 1.85KB 0.85KB
types (disclosure.js) 0.20KB 0.18KB
types (error-code.js) 1.54KB 0.88KB
types (expression.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 (http-inflight.js) 8.87KB 3.73KB
types (http-retry.js) 4.32KB 2.02KB
types (icon-key-migration.js) 4.26KB 1.63KB
types (index.js) 4.74KB 2.25KB
types (layout.js) 0.20KB 0.18KB
types (managed-by.js) 0.19KB 0.18KB
types (mobile.js) 5.00KB 2.39KB
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 (select-option.js) 0.20KB 0.19KB
types (spec-report.js) 5.05KB 1.93KB
types (spec-ui-namespace.js) 0.20KB 0.19KB
types (strict-authoring-face.js) 17.15KB 6.32KB
types (system-fields.js) 3.33KB 1.54KB
types (theme.js) 6.28KB 2.87KB
types (ui-action.js) 8.11KB 3.32KB
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Spec Main Shape Gate red on every PR head: plugin-designer NavigationDesigner has no doc entry after objectstack#19789 added the doc navigation type

1 participant