Skip to content

feat(forms): field-level conditional rules — visibleWhen/readonlyWhen/requiredWhen (B2 client) - #1578

Merged
xuyushun441-sys merged 2 commits into
mainfrom
b2-pr3-client-cel-field-rules
Jun 7, 2026
Merged

feat(forms): field-level conditional rules — visibleWhen/readonlyWhen/requiredWhen (B2 client)#1578
xuyushun441-sys merged 2 commits into
mainfrom
b2-pr3-client-cel-field-rules

Conversation

@xuyushun441-sys

@xuyushun441-sysxuyushun441-sys commented Jun 7, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

What

Client-side enforcement of field-level conditional rules so a form field can be conditionally shown/hidden (visibleWhen), made read-only (readonlyWhen), or made required (requiredWhen) based on a CEL predicate over the live record. Evaluated reactively as the user types.

This is the client half of B2. The server half (framework PR #1649) enforces requiredWhen in the rule-validator and strips readonlyWhen writes in stripReadonlyWhenFields. The showcase example lives in a framework PR (see below). See ADR-0036.

Why delegate to @objectstack/formula

The point of dual-side rules is that the client UX and the persisted server verdict agree. The client evaluates with the exact same engine + dialect the server uses — @objectstack/formula's ExpressionEngine (CEL via @marcbachmann/cel-js) — rather than a parallel evaluator, so there is zero drift risk. The package is browser-safe (deps: @marcbachmann/cel-js + @objectstack/spec, which @object-ui/core already depends on).

Changes

  • core: evalFieldPredicate + resolveFieldRuleState — zero-React, fail-open (a broken/absent predicate never hides a field, blocks submit, or locks a field). Static required/readonly is a floor a FALSE predicate can't weaken.
  • types: FormField gains visibleWhen / readonlyWhen / requiredWhen (+ @deprecated conditionalRequired alias).
  • components: the form renderer watches the live record and gates visible/readonly/required per field. It seeds every declared field to null before overlaying defined watched values, so a predicate referencing a not-yet-registered field compares against null rather than faulting on a missing CEL key (mirrors the server's full-record merge).
  • plugin-form: ObjectForm carries the rule props through from object metadata.

Tests

  • 17 unit tests (packages/core/.../fieldRules.test.ts) — predicate eval, object form, previous.*, fail-open, missing-key contract, alias precedence, static-flag floor.
  • e2e/live/field-conditional-rules.spec.ts — drives the showcase Invoice Status through paid/sent/draft and asserts paid_on visibility, tax_rate lock, and issued_on required all re-gate reactively. Passes (full live suite 11/11 green).

Docs

  • docs/adr/0036-field-conditional-rules.md
  • skills/objectui/guides/schema-expressions.md — new CEL field-rules section (distinguishing the data-model CEL tier from the ${}/On widget tier).

🤖 Generated with Claude Code

@os-zhuang@claude
feat(forms): client-side CEL field rules — visibleWhen/readonlyWhen/r…
fcfbcb1
…equiredWhen (B2-PR3)
Evaluate field-level conditional rules reactively in the form renderer via the
canonical @objectstack/formula ExpressionEngine — the same dialect the server
enforces (requiredWhen in rule-validator, readonlyWhen in stripReadonlyWhenFields)
— so the client UX and the persisted verdict always agree.
- core: evalFieldPredicate / resolveFieldRuleState (zero-React, fail-open)
- types: FormField gains visibleWhen/readonlyWhen/requiredWhen (+ deprecated
conditionalRequired alias)
- components: form renderer watches the live record, gates visible/readonly/
required per field
- plugin-form: ObjectForm carries the rule props through from object metadata
- 16 unit tests
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel

vercelBot commented Jun 7, 2026•
edited
Loading

Copy link
Copy Markdown

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

1 Skipped Deployment
ProjectDeploymentActionsUpdated (UTC)
objectuiIgnoredIgnoredJun 7, 2026 1:13pm

Request Review

@github-actions

github-actionsBot commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

MetricValueBudget
Main entry (gzip)270.4 KB350 KB
Entry fileindex-CtfK5oqh.js—
StatusPASS—

📦 Bundle Size Report

PackageSizeGzipped
app-shell (index.js)5.77KB2.03KB
app-shell (runtime-config.js)4.29KB1.54KB
app-shell (types.js)0.01KB0.04KB
auth (AuthContext.js)0.31KB0.24KB
auth (AuthGuard.js)1.17KB0.53KB
auth (AuthProvider.js)17.16KB3.44KB
auth (AuthShell.js)3.49KB1.40KB
auth (ForgotPasswordForm.js)4.79KB1.88KB
auth (LoginForm.js)5.11KB1.92KB
auth (PreviewBanner.js)0.90KB0.50KB
auth (RegisterForm.js)6.63KB2.15KB
auth (SocialSignInButtons.js)8.89KB3.61KB
auth (UserMenu.js)3.40KB1.22KB
auth (authStyles.js)5.04KB1.72KB
auth (createAuthClient.js)22.29KB5.30KB
auth (createAuthenticatedFetch.js)3.33KB1.32KB
auth (index.js)1.75KB0.76KB
auth (types.js)0.59KB0.35KB
auth (useAuth.js)4.01KB0.79KB
auth (useIsWorkspaceAdmin.js)1.28KB0.70KB
collaboration (CommentThread.js)18.38KB4.49KB
collaboration (LiveCursors.js)3.17KB1.27KB
collaboration (PresenceAvatars.js)3.65KB1.42KB
collaboration (PresenceProvider.js)2.42KB0.96KB
collaboration (index.js)1.25KB0.53KB
collaboration (useCommentSearch.js)1.98KB0.88KB
collaboration (useConflictResolution.js)7.75KB1.86KB
collaboration (useMentionNotifications.js)1.81KB0.68KB
collaboration (usePresence.js)6.33KB1.84KB
collaboration (useRealtimeSubscription.js)7.91KB2.01KB
components (index.js)398.53KB84.27KB
core (index.js)1.45KB0.54KB
create-plugin (index.js)9.28KB2.98KB
data-objectstack (index.js)93.45KB23.26KB
fields (index.js)156.91KB37.31KB
i18n (i18n.js)4.32KB1.77KB
i18n (index.js)2.27KB0.91KB
i18n (provider.js)5.37KB1.72KB
i18n (useObjectLabel.js)19.40KB4.48KB
i18n (useSafeTranslation.js)1.63KB0.57KB
layout (index.js)36.05KB9.94KB
mobile (MobileProvider.js)0.92KB0.49KB
mobile (ResponsiveContainer.js)0.94KB0.38KB
mobile (breakpoints.js)1.51KB0.70KB
mobile (createOfflineDataSource.js)5.61KB1.74KB
mobile (index.js)1.50KB0.62KB
mobile (offlineQueue.js)3.91KB1.35KB
mobile (pwa.js)0.97KB0.49KB
mobile (serviceWorker.js)1.48KB0.62KB
mobile (serviceWorkerSource.js)3.41KB1.48KB
mobile (useBreakpoint.js)1.54KB0.65KB
mobile (useGesture.js)4.42KB1.27KB
mobile (useOfflineSync.js)1.99KB0.72KB
mobile (usePullToRefresh.js)2.53KB0.85KB
mobile (useResponsive.js)0.71KB0.42KB
mobile (useResponsiveConfig.js)1.36KB0.63KB
mobile (useSpecGesture.js)1.77KB0.77KB
mobile (useTouchTarget.js)1.01KB0.54KB
permissions (MePermissionsProvider.js)4.87KB1.77KB
permissions (PermissionContext.js)0.31KB0.25KB
permissions (PermissionGuard.js)0.89KB0.45KB
permissions (PermissionProvider.js)3.11KB0.87KB
permissions (evaluator.js)4.00KB1.23KB
permissions (index.js)0.91KB0.41KB
permissions (store.js)0.91KB0.42KB
permissions (useFieldPermissions.js)1.28KB0.52KB
permissions (usePermissions.js)1.42KB0.68KB
plugin-ai (index.js)15.71KB3.79KB
plugin-calendar (index.js)45.98KB12.65KB
plugin-charts (index.js)39.09KB11.07KB
plugin-chatbot (index.js)115.61KB28.14KB
plugin-dashboard (index.js)90.92KB21.73KB
plugin-designer (index.js)213.42KB42.94KB
plugin-detail (index.js)192.76KB46.42KB
plugin-editor (index.js)2.38KB1.06KB
plugin-form (index.js)88.60KB21.06KB
plugin-gantt (index.js)28.30KB7.76KB
plugin-grid (index.js)110.04KB29.58KB
plugin-kanban (index.js)48.82KB13.13KB
plugin-list (index.js)90.21KB21.20KB
plugin-map (index.js)16.02KB4.98KB
plugin-markdown (index.js)2.62KB1.18KB
plugin-report (index.js)129.03KB28.39KB
plugin-timeline (index.js)25.37KB7.20KB
plugin-view (index.js)81.53KB19.87KB
plugin-workflow (index.js)69.35KB14.42KB
providers (DataSourceProvider.js)0.75KB0.39KB
providers (MetadataProvider.js)1.37KB0.59KB
providers (ThemeProvider.js)1.55KB0.67KB
providers (UploadProvider.js)11.71KB3.53KB
providers (index.js)0.44KB0.22KB
providers (types.js)0.01KB0.04KB
react (LazyPluginLoader.js)3.77KB1.33KB
react (SchemaRenderer.js)14.98KB4.84KB
react (index.js)0.76KB0.42KB
tenant (TenantContext.js)0.31KB0.25KB
tenant (TenantGuard.js)1.04KB0.43KB
tenant (TenantProvider.js)2.76KB0.98KB
tenant (TenantScopedQuery.js)0.77KB0.44KB
tenant (index.js)0.75KB0.38KB
tenant (resolver.js)2.64KB0.76KB
tenant (useTenant.js)0.50KB0.32KB
tenant (useTenantBranding.js)0.62KB0.39KB
types (ai.js)0.20KB0.17KB
types (api-types.js)0.20KB0.18KB
types (app.js)2.87KB0.99KB
types (base.js)0.20KB0.18KB
types (blocks.js)0.20KB0.18KB
types (complex.js)0.20KB0.18KB
types (crud.js)0.20KB0.18KB
types (data-display.js)0.20KB0.18KB
types (data-protocol.js)0.20KB0.19KB
types (data.js)0.20KB0.18KB
types (designer.js)0.77KB0.41KB
types (disclosure.js)0.20KB0.18KB
types (feedback.js)0.20KB0.18KB
types (field-types.js)0.20KB0.18KB
types (form.js)0.20KB0.18KB
types (index.js)1.54KB0.68KB
types (layout.js)0.20KB0.18KB
types (mobile.js)0.20KB0.18KB
types (navigation.js)0.20KB0.18KB
types (objectql.js)0.20KB0.18KB
types (overlay.js)0.20KB0.18KB
types (permissions.js)0.20KB0.18KB
types (plugin-scope.js)0.20KB0.18KB
types (record-components.js)0.20KB0.19KB
types (registry.js)0.20KB0.18KB
types (reports.js)0.20KB0.18KB
types (spec-report.js)4.80KB1.76KB
types (tenant.js)0.20KB0.18KB
types (theme.js)0.20KB0.18KB
types (ui-action.js)0.75KB0.46KB
types (views.js)0.20KB0.18KB
types (widget.js)0.20KB0.18KB
types (workflow.js)0.20KB0.18KB

Size Limits

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

@os-zhuang@claude
feat(forms): seed null for unregistered fields, add live e2e + ADR-00…
19b397c
…36 + skill (B2)
Completes B2 client conditional rules:
- form renderer seeds every declared field to null before overlaying defined
watched values, so a visibleWhen/etc. predicate referencing a not-yet-
registered field compares against null instead of faulting on a missing key
(CEL "No such key") and failing open — mirrors the server's full-record merge
- core: unit test locking the missing-key fail-open contract (17 tests)
- e2e/live: field-conditional-rules.spec — drives Invoice Status through
paid/sent/draft and asserts paid_on visibility, tax_rate lock, issued_on
required all re-gate reactively (passes in a fresh context)
- docs: ADR-0036 (field-level conditional rules) + objectui skill
schema-expressions guide section
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@github-actionsgithub-actionsBot added the documentation Improvements or additions to documentation label Jun 7, 2026
@xuyushun441-sysxuyushun441-sys changed the title feat(forms): client CEL field rules — visibleWhen/readonlyWhen/requiredWhen (B2-PR3)feat(forms): field-level conditional rules — visibleWhen/readonlyWhen/requiredWhen (B2 client)Jun 7, 2026
@github-actions

github-actionsBot commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

MetricValueBudget
Main entry (gzip)270.4 KB350 KB
Entry fileindex-DDZv0Lhs.js—
StatusPASS—

📦 Bundle Size Report

PackageSizeGzipped
app-shell (index.js)5.77KB2.03KB
app-shell (runtime-config.js)4.29KB1.54KB
app-shell (types.js)0.01KB0.04KB
auth (AuthContext.js)0.31KB0.24KB
auth (AuthGuard.js)1.17KB0.53KB
auth (AuthProvider.js)17.16KB3.44KB
auth (AuthShell.js)3.49KB1.40KB
auth (ForgotPasswordForm.js)4.79KB1.88KB
auth (LoginForm.js)5.11KB1.92KB
auth (PreviewBanner.js)0.90KB0.50KB
auth (RegisterForm.js)6.63KB2.15KB
auth (SocialSignInButtons.js)8.89KB3.61KB
auth (UserMenu.js)3.40KB1.22KB
auth (authStyles.js)5.04KB1.72KB
auth (createAuthClient.js)22.29KB5.30KB
auth (createAuthenticatedFetch.js)3.33KB1.32KB
auth (index.js)1.75KB0.76KB
auth (types.js)0.59KB0.35KB
auth (useAuth.js)4.01KB0.79KB
auth (useIsWorkspaceAdmin.js)1.28KB0.70KB
collaboration (CommentThread.js)18.38KB4.49KB
collaboration (LiveCursors.js)3.17KB1.27KB
collaboration (PresenceAvatars.js)3.65KB1.42KB
collaboration (PresenceProvider.js)2.42KB0.96KB
collaboration (index.js)1.25KB0.53KB
collaboration (useCommentSearch.js)1.98KB0.88KB
collaboration (useConflictResolution.js)7.75KB1.86KB
collaboration (useMentionNotifications.js)1.81KB0.68KB
collaboration (usePresence.js)6.33KB1.84KB
collaboration (useRealtimeSubscription.js)7.91KB2.01KB
components (index.js)398.72KB84.33KB
core (index.js)1.45KB0.54KB
create-plugin (index.js)9.28KB2.98KB
data-objectstack (index.js)93.45KB23.26KB
fields (index.js)156.91KB37.31KB
i18n (i18n.js)4.32KB1.77KB
i18n (index.js)2.27KB0.91KB
i18n (provider.js)5.37KB1.72KB
i18n (useObjectLabel.js)19.40KB4.48KB
i18n (useSafeTranslation.js)1.63KB0.57KB
layout (index.js)36.05KB9.94KB
mobile (MobileProvider.js)0.92KB0.49KB
mobile (ResponsiveContainer.js)0.94KB0.38KB
mobile (breakpoints.js)1.51KB0.70KB
mobile (createOfflineDataSource.js)5.61KB1.74KB
mobile (index.js)1.50KB0.62KB
mobile (offlineQueue.js)3.91KB1.35KB
mobile (pwa.js)0.97KB0.49KB
mobile (serviceWorker.js)1.48KB0.62KB
mobile (serviceWorkerSource.js)3.41KB1.48KB
mobile (useBreakpoint.js)1.54KB0.65KB
mobile (useGesture.js)4.42KB1.27KB
mobile (useOfflineSync.js)1.99KB0.72KB
mobile (usePullToRefresh.js)2.53KB0.85KB
mobile (useResponsive.js)0.71KB0.42KB
mobile (useResponsiveConfig.js)1.36KB0.63KB
mobile (useSpecGesture.js)1.77KB0.77KB
mobile (useTouchTarget.js)1.01KB0.54KB
permissions (MePermissionsProvider.js)4.87KB1.77KB
permissions (PermissionContext.js)0.31KB0.25KB
permissions (PermissionGuard.js)0.89KB0.45KB
permissions (PermissionProvider.js)3.11KB0.87KB
permissions (evaluator.js)4.00KB1.23KB
permissions (index.js)0.91KB0.41KB
permissions (store.js)0.91KB0.42KB
permissions (useFieldPermissions.js)1.28KB0.52KB
permissions (usePermissions.js)1.42KB0.68KB
plugin-ai (index.js)15.71KB3.79KB
plugin-calendar (index.js)45.98KB12.65KB
plugin-charts (index.js)39.09KB11.07KB
plugin-chatbot (index.js)115.61KB28.14KB
plugin-dashboard (index.js)90.92KB21.73KB
plugin-designer (index.js)213.42KB42.94KB
plugin-detail (index.js)192.76KB46.42KB
plugin-editor (index.js)2.38KB1.06KB
plugin-form (index.js)88.60KB21.06KB
plugin-gantt (index.js)28.30KB7.76KB
plugin-grid (index.js)110.04KB29.58KB
plugin-kanban (index.js)48.82KB13.13KB
plugin-list (index.js)90.21KB21.20KB
plugin-map (index.js)16.02KB4.98KB
plugin-markdown (index.js)2.62KB1.18KB
plugin-report (index.js)129.03KB28.39KB
plugin-timeline (index.js)25.37KB7.20KB
plugin-view (index.js)81.53KB19.87KB
plugin-workflow (index.js)69.35KB14.42KB
providers (DataSourceProvider.js)0.75KB0.39KB
providers (MetadataProvider.js)1.37KB0.59KB
providers (ThemeProvider.js)1.55KB0.67KB
providers (UploadProvider.js)11.71KB3.53KB
providers (index.js)0.44KB0.22KB
providers (types.js)0.01KB0.04KB
react (LazyPluginLoader.js)3.77KB1.33KB
react (SchemaRenderer.js)14.98KB4.84KB
react (index.js)0.76KB0.42KB
tenant (TenantContext.js)0.31KB0.25KB
tenant (TenantGuard.js)1.04KB0.43KB
tenant (TenantProvider.js)2.76KB0.98KB
tenant (TenantScopedQuery.js)0.77KB0.44KB
tenant (index.js)0.75KB0.38KB
tenant (resolver.js)2.64KB0.76KB
tenant (useTenant.js)0.50KB0.32KB
tenant (useTenantBranding.js)0.62KB0.39KB
types (ai.js)0.20KB0.17KB
types (api-types.js)0.20KB0.18KB
types (app.js)2.87KB0.99KB
types (base.js)0.20KB0.18KB
types (blocks.js)0.20KB0.18KB
types (complex.js)0.20KB0.18KB
types (crud.js)0.20KB0.18KB
types (data-display.js)0.20KB0.18KB
types (data-protocol.js)0.20KB0.19KB
types (data.js)0.20KB0.18KB
types (designer.js)0.77KB0.41KB
types (disclosure.js)0.20KB0.18KB
types (feedback.js)0.20KB0.18KB
types (field-types.js)0.20KB0.18KB
types (form.js)0.20KB0.18KB
types (index.js)1.54KB0.68KB
types (layout.js)0.20KB0.18KB
types (mobile.js)0.20KB0.18KB
types (navigation.js)0.20KB0.18KB
types (objectql.js)0.20KB0.18KB
types (overlay.js)0.20KB0.18KB
types (permissions.js)0.20KB0.18KB
types (plugin-scope.js)0.20KB0.18KB
types (record-components.js)0.20KB0.19KB
types (registry.js)0.20KB0.18KB
types (reports.js)0.20KB0.18KB
types (spec-report.js)4.80KB1.76KB
types (tenant.js)0.20KB0.18KB
types (theme.js)0.20KB0.18KB
types (ui-action.js)0.75KB0.46KB
types (views.js)0.20KB0.18KB
types (widget.js)0.20KB0.18KB
types (workflow.js)0.20KB0.18KB

Size Limits

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

@xuyushun441-sys
xuyushun441-sys merged commit ddbe4a2 into mainJun 7, 2026
10 checks passed
@xuyushun441-sys
xuyushun441-sys deleted the b2-pr3-client-cel-field-rules branch June 7, 2026 13:18
@xuyushun441-sysxuyushun441-sys mentioned this pull request Jun 7, 2026
Closed
This was referenced Jul 16, 2026
Merged
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

dependenciesdocumentationImprovements or additions to documentationpackage: componentspackage: corepackage: typesplugintests

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@xuyushun441-sys@os-zhuang