Standardize filter syntax to MongoDB-style and complete documentation by Copilot · Pull Request #53 · objectstack-ai/objectstack

Copilot · 2026-01-21T05:01:47Z

Filter Documentation & Code Standardization - COMPLETED ✅

Issues Identified

Two different filter systems exist: array-based (old) vs MongoDB-style (new)
Documentation is incomplete and missing examples
All examples use the old array-based system
Operator naming is inconsistent
Report filters use a hybrid format
Build error fixed

Documentation Updates Completed ✅

Update QueryFilter documentation with comprehensive examples
Update NormalizedFilter documentation with usage guide
Update FilterCondition documentation with real-world examples
Update FilterOperator documentation to align with new system and migration guide
Update FilterNode documentation with deprecation notice

Code Updates Completed ✅

Update DashboardWidget schema to use FilterCondition
Update Report schema to use FilterCondition (removed old filter + filterItems)
Update all dashboard tests to use modern filter syntax
Update client-test.ts example to use MongoDB-style filters with correct 'filters' property
Update CRM dashboard filters (14 filters converted)
Update CRM report filters (6 reports converted)
Fix build error: changed 'where' to 'filters' in QueryOptions
All tests passing, build successful

Summary of Changes

5 documentation files updated with comprehensive examples and migration guides
3 schema files updated to use FilterCondition
3 example files updated to modern syntax
Build fixed - all packages compile successfully

Migration Notes

Old array-based syntax: [['field', '=', 'value']] → New: { field: 'value' }
Old inequality: [['stage', '!=', 'won'], ['stage', '!=', 'lost']] → New: { stage: { $nin: ['won', 'lost'] } }
Old Report structure with filter + filterItems → New: single filter object with FilterCondition
Client SDK uses filters property (not where) for MongoDB-style filters

Original prompt

更新filter相关的文档，规范相关的代码相关的例子

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

vercel · 2026-01-21T05:02:27Z

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

Project	Deployment	Review	Updated (UTC)
spec	Error		Jan 21, 2026 5:55am

… guide Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

…ters Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

hotlong · 2026-01-21T05:52:12Z

@copilot fix build

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Copilot · 2026-01-21T05:55:31Z

@copilot fix build

Fixed in 9dc055e. The issue was using where instead of filters in the QueryOptions interface for the client SDK. Build now passes successfully.

Copilot

Pull request overview

This pull request standardizes filter syntax across the ObjectStack spec from array-based filters to MongoDB-style FilterCondition objects. The change affects dashboard widgets, reports, and client SDK examples, providing a more intuitive and type-safe querying interface.

Changes:

Replaced old filter + filterItems structure in Reports with a single filter: FilterConditionSchema
Updated Dashboard widgets to use FilterConditionSchema instead of z.any()
Migrated all examples (dashboards, reports, client tests) from array-based syntax [['field', '=', 'value']] to MongoDB-style { field: value } or { field: { $op: value } }

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
packages/spec/src/ui/report.zod.ts	Replaced filter/filterItems with single FilterConditionSchema
packages/spec/src/ui/dashboard.zod.ts	Changed filter from z.any() to FilterConditionSchema
packages/spec/src/ui/dashboard.test.ts	Updated all 14 test filters to MongoDB-style syntax
packages/spec/json-schema/Report.json	Generated JSON schema for new FilterCondition structure
packages/spec/json-schema/DashboardWidget.json	Generated JSON schema with FilterCondition allOf pattern
packages/spec/json-schema/Dashboard.json	Generated JSON schema with FilterCondition allOf pattern
examples/todo/src/client-test.ts	Updated client example to use MongoDB-style filters with 'filters' property
examples/crm/src/ui/reports.ts	Converted 6 report filters from old filterItems to FilterCondition
examples/crm/src/ui/dashboards.ts	Converted 14 dashboard widget filters to MongoDB-style syntax
content/docs/references/ui/analytics/Report.mdx	Updated documentation to reflect filter schema change

Copilot · 2026-01-21T06:36:01Z

 | **groupingsAcross** | `object[]` | optional | Column groupings (Matrix only) |
-| **filter** | `string` | optional | Filter logic (e.g. "1 AND (2 OR 3)") |
-| **filterItems** | `object[]` | optional | Filter criteria lines |
+| **filter** | `any` | optional | Filter criteria |


…on-GET (ADR §5.2) (#1568) Removes the framework's hardcoded install-policy dead-end. The marketplace proxy is a BROWSE mechanism: it forwards GET/HEAD reads and carries no credentialled cloud auth. It must not pretend to own install *policy*. Previously a non-GET marketplace request returned a 405 `marketplace_method_not_allowed` "install via cloud" — a dead-end the in-env Install button hit (framework#1548). Now non-GET requests PASS THROUGH (`next()`) so a host-supplied install route — mounted after this plugin via the createObjectOSStack `extraPlugins` seam — can claim them; if none does, the app returns its normal 404 instead of a misleading policy 405. This is the "remove framework's hardcoded marketplace policy" half of ADR §5.2, now that the cloud side has landed + deployed: ObjectStack Cloud owns install (the `/cloud-connection/install` route + `sys_package.install_package` action + the tiered cloud-connection gate — cloud PR #53). The framework keeps only the neutral browse mechanism. Test: 3 cases — non-GET passes through (not 405); install-local still passes through; no-control-plane still 503s. Full src/cloud suite (40) stays green. Co-authored-by: Jack Zhuang <277994282+os-zhuang@users.noreply.github.com> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>

Initial plan

a765148

Copilot AI assigned Copilot and hotlong Jan 21, 2026

Copilot started work on behalf of hotlong January 21, 2026 05:02 View session

vercel Bot had a problem deploying to Preview January 21, 2026 05:02 Failure

Update filter documentation with comprehensive examples and migration…

d22ccaf

… guide Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

vercel Bot had a problem deploying to Preview January 21, 2026 05:09 Failure

Update dashboard schema and tests to use modern MongoDB-style filters

29e2655

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

vercel Bot had a problem deploying to Preview January 21, 2026 05:13 Failure

Copilot AI and others added 2 commits January 21, 2026 05:18

Update CRM examples and Report schema to use modern MongoDB-style fil…

31b6038

…ters Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Remove backup file

503ec7a

vercel Bot had a problem deploying to Preview January 21, 2026 05:19 Failure

github-actions Bot added tests protocol:ui size/m labels Jan 21, 2026

Copilot AI changed the title ~~[WIP] Update filter documentation and code examples~~ Standardize filter syntax to MongoDB-style and complete documentation Jan 21, 2026

Copilot AI requested a review from hotlong January 21, 2026 05:22

Copilot finished work on behalf of hotlong January 21, 2026 05:22

Copilot started work on behalf of hotlong January 21, 2026 05:52 View session

Fix build error: use 'filters' instead of 'where' in QueryOptions

9dc055e

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

vercel Bot had a problem deploying to Preview January 21, 2026 05:55 Failure

Copilot finished work on behalf of hotlong January 21, 2026 05:56

github-actions Bot added the documentation Improvements or additions to documentation label Jan 21, 2026

hotlong approved these changes Jan 21, 2026

View reviewed changes

hotlong marked this pull request as ready for review January 21, 2026 06:32

Copilot AI review requested due to automatic review settings January 21, 2026 06:32

hotlong merged commit f7afab7 into main Jan 21, 2026
11 of 12 checks passed

Copilot started reviewing on behalf of hotlong January 21, 2026 06:33 View session

Copilot AI reviewed Jan 21, 2026

View reviewed changes

This was referenced Jun 3, 2026

feat(runtime): extraPlugins host seam on createObjectOSStack (ADR §5.2) #1566

Merged

feat(runtime): MarketplaceProxyPlugin browse-only — drop the install 405 dead-end (ADR §5.2) #1568

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Standardize filter syntax to MongoDB-style and complete documentation#53

Standardize filter syntax to MongoDB-style and complete documentation#53
hotlong merged 6 commits into
mainfrom
copilot/update-filter-documentation

Copilot AI commented Jan 21, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Jan 21, 2026 •

edited

Loading

Uh oh!

hotlong commented Jan 21, 2026

Uh oh!

Copilot AI commented Jan 21, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	\| filter \| `any` \| optional \| Filter criteria \|
	\| filter \| `FilterCondition` \| optional \| Filter criteria \|

Uh oh!

Conversation

Copilot AI commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Filter Documentation & Code Standardization - COMPLETED ✅

Issues Identified

Documentation Updates Completed ✅

Code Updates Completed ✅

Summary of Changes

Migration Notes

Uh oh!

vercel Bot commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hotlong commented Jan 21, 2026

Uh oh!

Copilot AI commented Jan 21, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 21, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jan 21, 2026 •

edited

Loading

vercel Bot commented Jan 21, 2026 •

edited

Loading