@ifc-lite/rules

The filter-rule vocabulary, the Path-B rule evaluator, and the .rules.json information-validation engine for IFC-Lite. This is the shared core behind the viewer's Advanced Filter / Data Validation panel and the ifc-lite check CLI command (#5138) — one evaluator, one .rules.json format, run identically in the browser and on the command line.

Install

npm install @ifc-lite/rules

Usage

import { Rule, evaluateFilterRules, parseRuleSetFile, runRuleSet } from '@ifc-lite/rules';
import type { IfcDataStore } from '@ifc-lite/parser';

declare const store: IfcDataStore;
declare const ruleSetJson: string; // the text of a saved `<name>.rules.json`

// Evaluate an ad-hoc filter against one model.
const matches = evaluateFilterRules('model-1', store, [Rule.ifcType(['IfcWall'])], 'AND');

// Parse and run a saved `.rules.json` rule set against every loaded model.
const parsed = parseRuleSetFile(JSON.parse(ruleSetJson));
if (parsed.ok) {
  const report = await runRuleSet({
    ruleSet: parsed.file,
    models: [{ id: 'model-1', store }],
  });
}

Features

• isFilterRule validates mandatory names, operands and operators at JSON boundaries; text operands remain strings and quantity/elevation operands remain finite numbers. parseFilterGroups refuses an entire unreadable query, while parseFilterRules retains its per-rule filtering behavior. Missing comparison operands are rejected rather than coerced to empty strings.
• FilterRule / FilterGroup vocabulary (ifcType, name, property, quantity, material, classification, storey, model, modelTag, parent, group, modelFact, elevation, type, predefinedType, attribute, globalId) plus the Rule builder helpers.
• listCondition: a saved Lists value predicate (zone, spatial level, model file, quantity/material presence, Lists attributes, inherited properties) inside a FilterGroup. The Lists engine answers it through EvaluatorModel.listConditions (listConditionMatcher(provider) from @ifc-lite/lists); a model without one throws, and rule-set files refuse the kind.
• legacyLensOperatorToFilterRule and legacyListOperatorToFilterRule convert saved viewer comparisons to this vocabulary. Each returns { status: 'readable', value: rule } or an explicit { status: 'unreadable', vocabulary, operator }; the corresponding filterRuleToLegacy*Operator functions convert supported rules back for export. Pass the target property or attribute as the rule template.
• evaluateFilterRules / evaluateFilterRulesFederated (sync + async chunked, cancellable, multi-model) — the same Path-B evaluator the viewer's Advanced Filter and Data Validation panel use, with index prefiltering and cheap-first rule ordering for large models.
• parseRuleSetFile / serializeRuleSet — validate and round-trip a <name>.rules.json file (never throws; failures come back as { ok: false, error }).
• ruleSetToIds / idsToRuleSet — export the IDS-expressible rules of a rule set as IDS 1.0 XML, and import the simple specifications of an IDS as rules. Each rule or specification that has no exact equivalent is refused with its reasons (see the IDS guide).
• runRuleSet / resolveTargetModels — the information-validation engine: resolve applicability, check cardinality, dispatch element / unique / aggregate / compare / unit requirements, and fold the result into a @ifc-lite/ids-shaped ValidationReport.

No React, no store, no DOM — every export takes plain data (IfcDataStore, EvaluatorModel[]) in and returns plain data out, so it runs the same in a browser tab and a Node CLI process.

License

MPL-2.0