Skip to content

refactor(types)!: authoring types are input types — ActionParam takes the spec's declaration forms, ListViewSchema stops promising phantom defaults (objectstack#4074) - #3020

Merged
os-zhuang merged 1 commit into
mainfrom
claude/quirky-euler-p9dsfm
Jul 30, 2026
Merged

refactor(types)!: authoring types are input types — ActionParam takes the spec's declaration forms, ListViewSchema stops promising phantom defaults (objectstack#4074)#3020
os-zhuang merged 1 commit into
mainfrom
claude/quirky-euler-p9dsfm

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Closes the remaining scope of objectstack-ai/objectstack#4074 (steps 2–3) and retires the p1-spec-alignment.test.ts debt #3009 declared. Three public types said something different from what the platform accepts; each fix below carries its runtime evidence.

1. ActionParam is the authoring shape, aligned with the spec's input

name / label / type become optional and field / objectOverride appear. The spec's primary way to declare a param — a bare field reference that inherits label/type/validation/options from an object field — was unrepresentable while all three were required: { field: 'status' } was a type error in the very package that claims spec alignment.

The resolved shape the dialog consumes — after app-shell's resolveActionParams() inlines the reference — remains @object-ui/core's ActionParamDef, with all three required. Authoring and resolved are different types on purpose; that separation is the whole point (and is spec's own: it exports ResolvedActionParam distinct from the schema input).

The new guard caught me in the act. I typed label as the spec's I18nLabel and wrote a per-locale-record fixture, matching what I'd claimed in the issue — the now-compiled annotation immediately failed: in the current spec, I18nLabelSchema is z.ZodString (the record form is the separate I18nObject). The fixture was corrected, and since label imports the alias rather than restating it, objectui tracks any future widening automatically. Guards that run beat claims that don't — the PR's thesis, demonstrated against its own author mid-PR.

2. ListViewInferred is z.input, not z.infer

The spec sub-schemas flowing into the list-view surface (userActions, tabsViewTab, sharing) carry .default()s, so the inferred output type made userActions.refresh or a tab's pinned / visible required. But nothing on the render path ever runs .parse(): normalizeListViewSchema deliberately applies no defaults — "an absent flag stays absent" is one of its own test names. So the output type simultaneously

  • rejected valid authored metadata (userActions: { sort: true }, a tab without pinned), and
  • promised renderers defaults that never arrive at runtime.

z.input matches both the author and the actual runtime object. Code that trusted the phantom defaults now gets an optionality error — a latent bug surfacing, not a regression.

3. FormField.dependsOn matches its runtime reader

resolveCascadingOptions (@object-ui/core) has always accepted a bare name, a list of names, or lookup-parameter entries { field, param } — its parameter type DependsOnInput says so. The public FormField.dependsOn said string, so array-authored metadata type-errored while working, and the components form renderer read the key through (f as any).dependsOn to get past its own type — the as any was the confession.

DependsOnInput now lives in @object-ui/types next to FormField (single source of truth; the dependency direction types → core is the correct one), core imports and re-exports it for its existing consumers (@object-ui/fields' useCascadingOptions keeps working untouched), and both as any reads are typed. form.tsx lint warnings drop 87 → 85.

The p1 exclusion is gone

tsconfig.test.json no longer excludes anything. The 14 errors resolved site-by-site rather than papered over:

sites resolution
userActions / tabs minimal fixtures valid under the input type (fix #2)
dependsOn: ['industry'] valid under DependsOnInput (fix #3)
2× "sharing in ObjectUI format { visibility, enabled }" + legacy-ARIA spellings deleted/rewritten — these are normalizer input dialects, folded by normalizeListViewSchema and already asserted branch-by-branch in core's normalize-list-view.test.ts (visibility→type collapse, bare-enabled mapping, lockedBy preservation, explicit-type precedence). Asserting a fold's input dialect on the canonical type is the wrong seam, and only ever "passed" because nothing compiled the file. Widening the canonical type to advertise a dialect that already has a fold would invite new metadata to author it.
tab filter: ['owner', '=', 'current_user'] corrected — an ObjectQL triplet as a spec ViewTab.filter has never been admitted by any type on this surface; the fixture now uses the rule-object form

Verification

  • Discrimination checks, 3/3 bite: revert ListViewInferred to z.inferTS2739 on the exact fixtures; revert dependsOn to stringTS2322; revert ActionParam.name to required → TS2741 on the field-backed annotation. Restored: clean.
  • pnpm type-check76/76 tasks.
  • pnpm vitest run731 files / 8516 tests passed, 1 file / 24 skipped.
  • Affected suites directly: types (16 files/246), core normalizer + evaluator + fields cascading (26 files/552 with types), components form + plugin-form (38 files/290).
  • eslint on changed files: 0 errors, no new warnings (form.tsx count drops by 2).
  • node scripts/check-changeset-fixed.mjs — clean.

Changeset: @object-ui/types major (the ActionParam optionality and ListViewInferred input-typing are breaking for consumers that destructured required fields), core/components patch.

Also fixes a wrong reference merged in #3009: the guard file's header said the test project landed in "#3005".

Refs objectstack#4074, #3009, #3003, #2231, #2890, objectstack#4115, objectstack#4118


Generated by Claude Code

… the spec's declaration forms, ListViewSchema stops promising phantom defaults (objectstack#4074)

Three public types said something different from what the platform accepts,
found by making packages/types' tests compile (#3009) and resolving the
declared p1-spec-alignment.test.ts debt site-by-site.

ActionParam is now the AUTHORING shape, aligned with the spec's input:
name/label/type optional, field/objectOverride added. The spec's primary
declaration form — a bare field reference inheriting label/type/validation/
options from an object field — was unrepresentable while all three were
required. The RESOLVED shape the dialog consumes (after app-shell's
resolveActionParams() inlines the reference) remains core's ActionParamDef,
all three required: authoring and resolved are different types on purpose.
label is the spec's I18nLabel by import — which the new compile-time guard
promptly revealed to be aliased to plain string in the current spec, so no
behavioural widening today; importing the alias means objectui tracks any
future widening automatically.

ListViewInferred is z.input, not z.infer. The spec sub-schemas flowing into
the list-view surface (userActions, tabs→ViewTab, sharing) carry .default()s,
so the inferred output type made userActions.refresh or a tab's pinned/visible
REQUIRED — but nothing on the render path runs .parse(): normalizeListViewSchema
deliberately applies no defaults ("an absent flag stays absent", its own suite).
The output type rejected valid authored metadata while promising renderers
defaults that never arrive; input matches both author and runtime.

FormField.dependsOn is DependsOnInput. The runtime reader
(resolveCascadingOptions) has always accepted a bare name, a list of names, or
{field, param} entries; the public property said string, so array-authored
metadata type-errored while working and the form renderer read the key through
(f as any).dependsOn to get past its own type. The shape now lives in
@object-ui/types next to FormField; core imports and re-exports it; the two
as-any reads in components are typed.

The p1-spec-alignment.test.ts exclusion is gone — its 14 errors resolved:
the "sharing in ObjectUI format" and legacy-ARIA fixtures are re-seated as
normalizer-input dialects (folded by normalizeListViewSchema; asserted
branch-by-branch in core's normalize-list-view.test.ts, the seam where the
fold runs), and the one fixture no surface ever admitted (an ObjectQL triplet
as a spec ViewTab.filter) is corrected to the rule-object form. Every test
file in @object-ui/types is compiled, no exclusions.

Discrimination-checked: reverting ListViewInferred to z.infer, dependsOn to
string, or ActionParam.name to required each fails compile in the now-compiled
tests (TS2739 / TS2322 / TS2741); restored, all projects clean.

Co-Authored-By: Claude <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014DBMo8gnFduzgpuSHd5Eje
@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 10:54am

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Main entry (gzip) 27.9 KB 350 KB
Entry file index-CqAm4ZZD.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.75KB 99.96KB
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.56KB 42.56KB
plugin-detail (index.js) 216.52KB 53.02KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 104.79KB 25.28KB
plugin-gantt (index.js) 162.26KB 39.53KB
plugin-grid (index.js) 180.86KB 47.45KB
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.88KB 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 marked this pull request as ready for review July 30, 2026 11:02
@os-zhuang
os-zhuang merged commit b41f401 into main Jul 30, 2026
16 checks passed
@os-zhuang
os-zhuang deleted the claude/quirky-euler-p9dsfm branch July 30, 2026 11:02
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.

2 participants