ObjectStackFilter
Filter protocol schemas
Unified Query DSL Specification
Based on industry best practices from:
-
Prisma ORM
-
Strapi CMS
-
TypeORM
-
LoopBack Framework
Version: 1.0.0
Status: Draft
Objective: Define a JSON-based, database-agnostic query syntax standard
for data filtering interactions between frontend and backend APIs.
Design Principles:
-
Declarative: Frontend describes "what data to get", not "how to query"
-
Database Agnostic: Syntax contains no database-specific directives
-
Type Safe: Structure can be statically inferred by TypeScript
-
Convention over Configuration: Implicit syntax for common queries
Source: packages/spec/src/data/filter.zod.ts
TypeScript Usage
import { EqualityOperator, FieldReference, FilterCondition, QueryFilter, SetOperator, SpecialOperator, StringOperator } from '@objectstack/spec/data';
import type { EqualityOperator, FieldReference, FilterCondition, QueryFilter, SetOperator, SpecialOperator, StringOperator } from '@objectstack/spec/data';
// Validate data
const result = EqualityOperator.parse(data);EqualityOperator
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| $eq | any | optional | |
| $ne | any | optional |
FieldReference
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| $field | string | ✅ | Field Reference/Column Name |
QueryFilter
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| where | [__schema0](./__schema0) | optional |
SetOperator
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| $in | any[] | optional | |
| $nin | any[] | optional |
SpecialOperator
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| $null | boolean | optional | |
| $exists | boolean | optional |
StringOperator
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| $contains | string | optional | |
| $startsWith | string | optional | |
| $endsWith | string | optional |