Business Rules Library

SonarQube Report

Documentation Portal

Architecture Diagrams

Dependencies

• NodeJS >= 20.x
• pnpm i -g rimraf cross-env serve

Development

• clone the repo
• pnpm i

Unit Test

• pnpm test

Architecture

For comprehensive architecture diagrams and documentation, see the diagrams folder.

Quick Links

• System Architecture - Overall system structure
• Flowcharts - Component and service workflows
• Sequence Diagrams - Event flows and interactions
• State Machines - State transitions
• Mind Maps - Feature overview

API

• Initialize and re-initialize Business rules by calling function BrInstance.init()
  Function Doc
• Use React Component to show errors and PATF validation:
  <BrComponent fieldId={fieldID} value={value} brConfig={brConfig}>{ChildComponent}</BrComponent>
• Track trigger field changes with callback:
  BrInstance.subscribeToTriggerFieldChange((fieldId, value) => {})
• For other public methods visit Documentation Portal

Key Features

• Direct SSF Integration: No wrapper layer, direct elli.getObject('loan') usage
• Event-Driven: Automatic re-initialization on SSF events (sync, committed, update)
• Type Safe: Full TypeScript support with IelliGuest interface
• Singleton Service: Centralized BR management with BrInitializationService
• Callback Support: Execute custom logic via brConfig.init() after rule updates

Commit Message Convention

This project uses Conventional Commits and semantic-release for automated versioning and publishing.

Note: Only the following commit types will trigger a new release:

• feat: A new feature (triggers a minor version bump)
• fix: A bug fix (triggers a patch version bump)
• perf: A performance improvement (triggers a patch version bump)

Commits with types like chore, docs, style, refactor, test, or ci will not trigger a release.