# srisaa-aegis/rulesengine architecture

> Architecture diagram of the GitHub repository srisaa-aegis/rulesengine, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/srisaa-aegis/rulesengine
- Repository: https://github.com/srisaa-aegis/rulesengine

## Overview

This is a domain-neutral, versioned rules-engine library. A caller supplies facts to RuleEngine; it resolves a published rule-set version through a RuleSetSource, validates and caches it, dispatches evaluation by rule kind, and returns a value tagged with the producing version and optional trace. Its distinct evaluation stages are decision trees, decision tables (including collection aggregation), and parameter sets. The graph also shows regression replay and the in-memory testing adapter. Unsampled validation and error modules are included from the tree and engine references; no internals beyond those references are assumed.

Main entry points: [`src/engine.ts`](https://github.com/srisaa-aegis/rulesengine/blob/master/src/engine.ts) (RuleEngine Facade), [`src/index.ts`](https://github.com/srisaa-aegis/rulesengine/blob/master/src/index.ts) (Public Exports), [`src/tree.ts`](https://github.com/srisaa-aegis/rulesengine/blob/master/src/tree.ts) (Tree Interpreter), [`src/table.ts`](https://github.com/srisaa-aegis/rulesengine/blob/master/src/table.ts) (Table Evaluator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Engine API"]
  node_engine["RuleEngine Facade<br/>[engine.ts]"]
  node_memory_source[("In-Memory Source<br/>[index.ts]")]
  node_contracts["Rule Contracts<br/>[types.ts]"]
  node_errors["Engine Errors<br/>[errors.ts]"]
  node_exports["Public Exports<br/>[index.ts]"]
end

subgraph group_evaluation["Rule Evaluation"]
  node_tree["Tree Interpreter<br/>[tree.ts]"]
  node_table["Table Evaluator<br/>[table.ts]"]
  node_aggregation["Collection Aggregation<br/>[table.ts]"]
  node_parameters["Parameter Lookup<br/>[engine.ts]"]
end

subgraph group_support["Validation And Testing"]
  node_validation["Definition Validation<br/>[validate.ts]"]
  node_regression["Regression Replay<br/>[engine.ts]"]
end

node_caller(("Library Caller"))
node_source["RuleSetSource Port"]

node_caller -->|"evaluates rules"| node_engine
node_engine -->|"loads versions"| node_source
node_memory_source -->|"implements port"| node_source
node_engine -->|"validates definitions"| node_validation
node_engine -->|"dispatches trees"| node_tree
node_engine -->|"dispatches tables"| node_table
node_engine -->|"evaluates collections"| node_aggregation
node_engine -->|"reads values"| node_parameters
node_engine -->|"raises errors"| node_errors
node_engine -->|"replays cases"| node_regression
node_tree -->|"uses definitions"| node_contracts
node_table -->|"uses definitions"| node_contracts
node_exports -->|"exports facade"| node_engine
node_exports -->|"exports evaluator"| node_tree
node_exports -->|"exports evaluator"| node_table
node_exports -->|"exports validators"| node_validation
node_exports -->|"exports types"| node_contracts

click node_engine "https://github.com/srisaa-aegis/rulesengine/blob/master/src/engine.ts"
click node_memory_source "https://github.com/srisaa-aegis/rulesengine/blob/master/src/testing/index.ts"
click node_contracts "https://github.com/srisaa-aegis/rulesengine/blob/master/src/types.ts"
click node_errors "https://github.com/srisaa-aegis/rulesengine/blob/master/src/errors.ts"
click node_tree "https://github.com/srisaa-aegis/rulesengine/blob/master/src/tree.ts"
click node_table "https://github.com/srisaa-aegis/rulesengine/blob/master/src/table.ts"
click node_aggregation "https://github.com/srisaa-aegis/rulesengine/blob/master/src/table.ts"
click node_parameters "https://github.com/srisaa-aegis/rulesengine/blob/master/src/engine.ts"
click node_validation "https://github.com/srisaa-aegis/rulesengine/blob/master/src/validate.ts"
click node_regression "https://github.com/srisaa-aegis/rulesengine/blob/master/src/engine.ts"
click node_exports "https://github.com/srisaa-aegis/rulesengine/blob/master/src/index.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_engine,node_memory_source,node_contracts,node_errors,node_exports toneBlue
class node_tree,node_table,node_aggregation,node_parameters toneAmber
class node_validation,node_regression toneMint
class node_caller,node_source toneIndigo
```

## Components

### Engine API

- [RuleEngine Facade](https://github.com/srisaa-aegis/rulesengine/blob/master/src/engine.ts): `src/engine.ts`
- [In-Memory Source](https://github.com/srisaa-aegis/rulesengine/blob/master/src/testing/index.ts): `src/testing/index.ts`
- [Rule Contracts](https://github.com/srisaa-aegis/rulesengine/blob/master/src/types.ts): `src/types.ts`
- [Engine Errors](https://github.com/srisaa-aegis/rulesengine/blob/master/src/errors.ts): `src/errors.ts`
- [Public Exports](https://github.com/srisaa-aegis/rulesengine/blob/master/src/index.ts): `src/index.ts`

### Rule Evaluation

- [Tree Interpreter](https://github.com/srisaa-aegis/rulesengine/blob/master/src/tree.ts): `src/tree.ts`
- [Table Evaluator](https://github.com/srisaa-aegis/rulesengine/blob/master/src/table.ts): `src/table.ts`
- [Collection Aggregation](https://github.com/srisaa-aegis/rulesengine/blob/master/src/table.ts): `src/table.ts`
- [Parameter Lookup](https://github.com/srisaa-aegis/rulesengine/blob/master/src/engine.ts): `src/engine.ts`

### Validation And Testing

- [Definition Validation](https://github.com/srisaa-aegis/rulesengine/blob/master/src/validate.ts): `src/validate.ts`
- [Regression Replay](https://github.com/srisaa-aegis/rulesengine/blob/master/src/engine.ts): `src/engine.ts`

### Other components

- **Library Caller**
- **RuleSetSource Port**

## Connections

- Library Caller → RuleEngine Facade: evaluates rules (evidence: `README.md`)
- RuleEngine Facade → RuleSetSource Port: loads versions (evidence: `src/engine.ts`)
- In-Memory Source → RuleSetSource Port: implements port (evidence: `src/testing/index.ts`)
- RuleEngine Facade → Definition Validation: validates definitions (evidence: `src/engine.ts`)
- RuleEngine Facade → Tree Interpreter: dispatches trees (evidence: `src/engine.ts`)
- RuleEngine Facade → Table Evaluator: dispatches tables (evidence: `src/engine.ts`)
- RuleEngine Facade → Collection Aggregation: evaluates collections (evidence: `src/engine.ts`)
- RuleEngine Facade → Parameter Lookup: reads values (evidence: `src/engine.ts`)
- RuleEngine Facade → Engine Errors: raises errors (evidence: `src/engine.ts`)
- RuleEngine Facade → Regression Replay: replays cases (evidence: `src/engine.ts`)
- Tree Interpreter → Rule Contracts: uses definitions (evidence: `src/tree.ts`)
- Table Evaluator → Rule Contracts: uses definitions (evidence: `src/table.ts`)
- Public Exports → RuleEngine Facade: exports facade (evidence: `src/index.ts`)
- Public Exports → Tree Interpreter: exports evaluator (evidence: `src/index.ts`)
- Public Exports → Table Evaluator: exports evaluator (evidence: `src/index.ts`)
- Public Exports → Definition Validation: exports validators (evidence: `src/index.ts`)
- Public Exports → Rule Contracts: exports types (evidence: `src/index.ts`)
