@react-querybuilder/rules-engine

Rules engine extension for react-querybuilder.

Documentation

Full documentation is available at react-querybuilder.js.org.

Installation

npm install react-querybuilder @react-querybuilder/rules-engine
# OR yarn add / pnpm add / bun add

Usage

import { RulesEngineBuilder } from '@react-querybuilder/rules-engine';

function App() {
  return <RulesEngineBuilder />;
}

Export

Convert a RulesEngine/RulesEngineIC to an external rule engine format with formatRulesEngine. Supported formats:

Format	Output	Library
"native"	in-process evaluator function (facts) => Consequent[]	(none)
"json-rules-engine"	array of rules to add to an Engine	json-rules-engine
"node-rules"	array of Rule objects for new RuleEngine(...)	node-rules
"rulepilot"	single Rule (first-matched result)	rulepilot

import { formatRulesEngine } from '@react-querybuilder/rules-engine';

// "native" — zero-dependency in-process evaluator; returns fired consequents in order
const evaluate = formatRulesEngine(rulesEngine, { format: 'native' });
const firedConsequents = evaluate({ experience: 12 });

// "json-rules-engine" — add each rule to an Engine (pass `context: { engine }` to
// auto-register the supplemental operators)
const engine = new Engine();
for (const rule of formatRulesEngine(rulesEngine, {
  format: 'json-rules-engine',
  context: { engine },
})) {
  engine.addRule(rule);
}

// "node-rules" — pass the rules straight to a RuleEngine
const R = new RuleEngine(formatRulesEngine(rulesEngine, { format: 'node-rules' }));
R.execute({ experience: 12 }, ({ events }) => console.log(events));

// "rulepilot" — single (first-matched) result; pass `true` to skip pre-validation
const rule = formatRulesEngine(rulesEngine, { format: 'rulepilot' });
const result = await RulePilot.evaluate(rule, { experience: 12 }, true);