Skip to content

fix(spec): remove unrendered roadmap page types (enforce-or-remove) + liveness gate#2265

Merged
os-zhuang merged 1 commit into
mainfrom
fix/page-type-liveness
Jun 24, 2026
Merged

fix(spec): remove unrendered roadmap page types (enforce-or-remove) + liveness gate#2265
os-zhuang merged 1 commit into
mainfrom
fix/page-type-liveness

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Follow-up to the Studio page-design dogfood (#2254 / #2261). Asked as a low-code architect: are the roadmap page types a protocol error, and should they be deleted? — yes. They're authorizable-but-unrendered, a false affordance that passes validation then breaks at runtime, worse because templates are AI-authored. This applies the codebase's own ADR-0049 enforce-or-remove.

What

PageTypeSchema advertised six page types with no rendererdashboard, form, record_detail, record_review, overview, blank. Verified in-browser: authoring type: 'blank' renders "Unknown component type: blank"; none have a dedicated renderer (blank's blankLayout is destructured to _blankLayoutProp — ignored).

  • Enum is now the live set: record, home, app, utility, list. Authoring a removed type now fails fast at parse (the (1) "guard" the dogfood asked for is achieved by the enum reflecting reality) instead of silently at render (2).
  • New PAGE_TYPE_ROADMAP export tracks the removed types so the intent isn't lost — they re-enter the enum only when a renderer ships.
  • Liveness gate test (page-type-liveness) asserts the enum never re-grows a roadmap type — the regression backstop (4), in the spirit of the existing liveness/ gate (page isn't a governed type yet; full onboarding is a follow-up).
  • recordReview / blankLayout config schemas + fields kept @deprecated (their types are no longer authorizable) to avoid breaking downstream imports — objectui still imports BlankPageLayoutSchema; hard removal is a coordinated follow-up.
  • variables documented @experimental (3): the PageVariablesProvider + usePageVariables hook exist, but nothing reads/writes them end-to-end yet (no element:record_picker writer, not injected into the visible CEL context) — completion tracked separately.

Verification

  • ✅ 801 spec UI tests pass (rewrote the tests that authored removed types into live-type + roadmap-rejection tests); @objectstack/spec typecheck clean.
  • ✅ Swept framework + examples: no page is authored with a removed type (the type:'dashboard' hits are nav-item kinds / metadata-type refs, not PageType).

Follow-ups (not in this PR)

  • objectui: drop blank/blankLayout references in spec-bridge + types so the deprecated schemas can be hard-removed.
  • Onboard page to the liveness/ ledger (declare every authorable property + evidence).
  • Complete variables (writer + visible-CEL injection + example/proof) or remove it.

🤖 Generated with Claude Code

PageTypeSchema advertised 6 page types with no renderer (dashboard, form,
record_detail, record_review, overview, blank). Authoring one passed validation
then broke at runtime ("Unknown component type") — a false affordance, worse
because templates are AI-authored. Per ADR-0049 the enum is now the live set
(record/home/app/utility/list); removed types live in a new PAGE_TYPE_ROADMAP
export and a gate test stops the enum re-growing them. The record_review/blank
config schemas + fields are kept @deprecated (avoid breaking downstream imports,
coordinated removal to follow); `variables` is marked @experimental.

Found by dogfooding the Studio page designer (blank → "Unknown component type").

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

vercel Bot commented Jun 24, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
spec Building Building Preview, Comment Jun 24, 2026 4:42am

Request Review

@github-actions github-actions Bot added size/m documentation Improvements or additions to documentation tests protocol:ui tooling labels Jun 24, 2026
@os-zhuang
os-zhuang merged commit cfd5ac4 into main Jun 24, 2026
14 of 16 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

This PR changes 1 package(s): @objectstack/spec.

91 hand-written doc(s) reference the affected code and may need an implementation-accuracy re-verification:

  • content/docs/concepts/architecture.mdx (via @objectstack/spec)
  • content/docs/concepts/cloud-artifact-api.mdx (via packages/spec)
  • content/docs/concepts/cluster-semantics.mdx (via @objectstack/spec)
  • content/docs/concepts/design-principles.mdx (via packages/spec)
  • content/docs/concepts/implementation-status.mdx (via @objectstack/spec)
  • content/docs/concepts/index.mdx (via @objectstack/spec)
  • content/docs/concepts/metadata-driven.mdx (via @objectstack/spec)
  • content/docs/concepts/metadata-lifecycle.mdx (via packages/spec)
  • content/docs/concepts/north-star.mdx (via packages/spec)
  • content/docs/concepts/packages.mdx (via @objectstack/spec)
  • content/docs/concepts/setup-app.mdx (via @objectstack/spec)
  • content/docs/concepts/skills.mdx (via @objectstack/spec)
  • content/docs/concepts/webhook-delivery.mdx (via @objectstack/spec)
  • content/docs/getting-started/architecture.mdx (via @objectstack/spec)
  • content/docs/getting-started/cli.mdx (via @objectstack/spec)
  • content/docs/getting-started/core-concepts.mdx (via @objectstack/spec)
  • content/docs/getting-started/examples.mdx (via @objectstack/spec)
  • content/docs/getting-started/quick-start.mdx (via @objectstack/spec)
  • content/docs/guides/adding-a-metadata-type.mdx (via @objectstack/spec)
  • content/docs/guides/ai-capabilities.mdx (via @objectstack/spec)
  • content/docs/guides/airtable-dashboard-analysis.mdx (via @objectstack/spec)
  • content/docs/guides/analytics-datasets.mdx (via @objectstack/spec)
  • content/docs/guides/api-reference.mdx (via @objectstack/spec)
  • content/docs/guides/business-logic.mdx (via @objectstack/spec)
  • content/docs/guides/cheatsheets/backward-compatibility.mdx (via @objectstack/spec)
  • content/docs/guides/cheatsheets/error-catalog.mdx (via @objectstack/spec)
  • content/docs/guides/cheatsheets/field-type-gallery.mdx (via @objectstack/spec)
  • content/docs/guides/cheatsheets/field-validation-rules.mdx (via @objectstack/spec)
  • content/docs/guides/cheatsheets/permissions-matrix.mdx (via @objectstack/spec)
  • content/docs/guides/cheatsheets/protocol-diagram.mdx (via packages/spec)
  • content/docs/guides/cheatsheets/query-cheat-sheet.mdx (via @objectstack/spec)
  • content/docs/guides/cheatsheets/quick-reference.mdx (via @objectstack/spec)
  • content/docs/guides/client-sdk.mdx (via @objectstack/spec)
  • content/docs/guides/common-patterns.mdx (via @objectstack/spec)
  • content/docs/guides/contracts/auth-service.mdx (via packages/spec)
  • content/docs/guides/contracts/cache-service.mdx (via packages/spec)
  • content/docs/guides/contracts/data-engine.mdx (via @objectstack/spec)
  • content/docs/guides/contracts/index.mdx (via @objectstack/spec)
  • content/docs/guides/contracts/metadata-service.mdx (via packages/spec)
  • content/docs/guides/contracts/storage-service.mdx (via packages/spec)
  • content/docs/guides/data-modeling.mdx (via @objectstack/spec)
  • content/docs/guides/deployment-vercel.mdx (via @objectstack/spec)
  • content/docs/guides/driver-configuration.mdx (via @objectstack/spec)
  • content/docs/guides/error-handling-client.mdx (via @objectstack/spec)
  • content/docs/guides/error-handling-server.mdx (via @objectstack/spec)
  • content/docs/guides/external-datasources.mdx (via @objectstack/spec)
  • content/docs/guides/formula.mdx (via @objectstack/spec)
  • content/docs/guides/hook-bodies.mdx (via packages/spec)
  • content/docs/guides/kernel-services.mdx (via @objectstack/spec)
  • content/docs/guides/metadata/dashboard.mdx (via @objectstack/spec)
  • content/docs/guides/metadata/field.mdx (via @objectstack/spec)
  • content/docs/guides/metadata/flow.mdx (via @objectstack/spec)
  • content/docs/guides/metadata/index.mdx (via @objectstack/spec)
  • content/docs/guides/metadata/object.mdx (via @objectstack/spec)
  • content/docs/guides/metadata/validation.mdx (via @objectstack/spec)
  • content/docs/guides/metadata/workflow.mdx (via @objectstack/spec)
  • content/docs/guides/packages.mdx (via @objectstack/spec)
  • content/docs/guides/plugin-development.mdx (via @objectstack/spec)
  • content/docs/guides/plugins.mdx (via @objectstack/spec)
  • content/docs/guides/project-scoping.mdx (via @objectstack/spec)
  • content/docs/guides/public-forms.mdx (via @objectstack/spec)
  • content/docs/guides/runtime-services/email-service.mdx (via packages/spec)
  • content/docs/guides/runtime-services/index.mdx (via packages/spec)
  • content/docs/guides/runtime-services/queue-service.mdx (via packages/spec)
  • content/docs/guides/runtime-services/sharing-service.mdx (via packages/spec)
  • content/docs/guides/runtime-services/storage-service.mdx (via packages/spec)
  • content/docs/guides/security.mdx (via @objectstack/spec)
  • content/docs/guides/seed-data.mdx (via @objectstack/spec)
  • content/docs/guides/skills.mdx (via @objectstack/spec)
  • content/docs/guides/standards.mdx (via @objectstack/spec)
  • content/docs/guides/troubleshooting.mdx (via @objectstack/spec)
  • content/docs/guides/validating-metadata.mdx (via @objectstack/spec)
  • content/docs/protocol/knowledge.mdx (via @objectstack/spec)
  • content/docs/protocol/objectos/config-resolution.mdx (via @objectstack/spec)
  • content/docs/protocol/objectos/i18n-standard.mdx (via @objectstack/spec)
  • content/docs/protocol/objectos/lifecycle.mdx (via @objectstack/spec)
  • content/docs/protocol/objectos/plugin-spec.mdx (via @objectstack/spec)
  • content/docs/protocol/objectos/runtime-capabilities.mdx (via @objectstack/spec)
  • content/docs/protocol/objectql/index.mdx (via packages/spec)
  • content/docs/protocol/objectql/query-syntax.mdx (via @objectstack/spec)
  • content/docs/protocol/objectql/schema.mdx (via @objectstack/spec)
  • content/docs/protocol/objectql/security.mdx (via packages/spec)
  • content/docs/protocol/objectql/state-machine.mdx (via @objectstack/spec)
  • content/docs/protocol/objectui/actions.mdx (via @objectstack/spec)
  • content/docs/protocol/objectui/concept.mdx (via @objectstack/spec)
  • content/docs/protocol/objectui/index.mdx (via @objectstack/spec)
  • content/docs/protocol/objectui/layout-dsl.mdx (via packages/spec)
  • content/docs/protocol/objectui/record-alert.mdx (via @objectstack/spec)
  • content/docs/protocol/objectui/widget-contract.mdx (via @objectstack/spec)
  • content/docs/releases/index.mdx (via @objectstack/spec)
  • content/docs/releases/v9.mdx (via @objectstack/spec)

Advisory only. To re-verify, run the docs-accuracy-audit workflow scoped to these files:
node scripts/docs-audit/affected-docs.mjs origin/main → pass the list as args.docs.

@os-zhuang
os-zhuang deleted the fix/page-type-liveness branch June 24, 2026 04:42
os-zhuang added a commit that referenced this pull request Jun 24, 2026
…ig removal (#2268) (#2272)

#2268 hard-removed 16 dead exports (6 from ./ui Blank/RecordReview, 10 from
./studio PageBuilder/Canvas/Palette) and #2265 added PAGE_TYPE_ROADMAP, but the
committed api-surface.json snapshot was never regenerated — so check:api-surface
has been red on main for every PR touching packages/spec/** (surfaced on #2269).

Regenerate the snapshot to match the built surface. Diff is exactly the 16
intentional removals + PAGE_TYPE_ROADMAP; api-surface-signatures.json unchanged;
the frozen downstream-contract gate is unaffected (it never referenced these
symbols).

Kept at minor (not a major bump) as a deliberate, documented exception to the
ADR-0059 §4 freeze contract — see the appended note in the #2268 changeset. The
removed symbols are config for renderless page types with no plausible
functional consumer; the pre-publish hotcrm live gate guards any real break.

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation protocol:ui size/m tests tooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant