DSL and SQL

X-Filter keeps the visual builder and text-based workflows aligned. The same Filter can be serialized to JSON, formatted as DSL, parsed back from DSL, and converted to parameterized SQL.

DSL format

import { formatDSL, tryParseDSL } from '@x-filter/core/dsl';
 
const dsl = formatDSL(filter);
const parsed = tryParseDSL('status:equals:open AND amount:gt:1000');

DSL conditions use field:operator:value. Groups and boolean logic are explicit:

accountTier:equals:enterprise AND (contractValue:gt:50000 OR ownerActive:equals:true)

SQL generation

SQL output is parameterized and returns { sql, params }.

import { toSQL } from '@x-filter/core/sql';
 
const result = toSQL(filter, {
  fieldMap: {
    accountTier: 'accounts.tier',
    contractValue: 'contracts.arr',
  },
});

Safety model

Use fieldMap to map public field names to database identifiers. Identifiers are checked before SQL is emitted, and values are always placed into the params array.

Validation order

Validate first, then export:

const validation = validate(filter, schema);
if (!validation.valid) return validation.errors;
 
return toSQL(filter, { fieldMap });