Gathering detailed insights and metrics for @o3r/rules-engine
Gathering detailed insights and metrics for @o3r/rules-engine
The Otter project is a highly modular framework whose goal is to provide a common platform to accelerate and facilitate the development of runtime customizable Angular based Web Applications
Installations
npm install @o3r/rules-engineDeveloper Guide
BETA
Typescript
No
Module System
ESM
Min. Node Version
^20.11.1 || >=22.0.0
Node Version
22.17.0
NPM Version
10.9.2
Releases
2,494
Languages
10
TypeScript
JavaScript
HTML
Java
SCSS
Handlebars
Mustache
Kotlin
EJS
Shell
TypeScript (87.45%)
JavaScript (6.18%)
HTML (2.46%)
Java (1.13%)
SCSS (1.05%)
Handlebars (0.77%)
Mustache (0.55%)
Kotlin (0.34%)
EJS (0.03%)
Shell (0.03%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
BSD-3-Clause License
56 Stars
5,360 Commits
43 Forks
3 Watchers
88 Branches
34 Contributors
Updated on Jul 14, 2025
Maintainers
5
Package Meta Information
Latest Version
12.2.7
Package Id
@o3r/rules-engine@12.2.7
Unpacked Size
689.68 kB
Size
134.12 kB
File Count
242
NPM Version
10.9.2
Node Version
22.17.0
Published on
Jul 11, 2025
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Peer Dependencies
24
@angular-devkit/architect@angular-devkit/core@angular-devkit/schematics@angular/common@angular/core@angular/forms@angular/platform-browser-dynamic@ngrx/effects@ngrx/entity@ngrx/store@ngx-translate/core@o3r/core@o3r/extractors@o3r/logger@o3r/schematics@schematics/angularglobbyjasminejsonpath-plusrxjsts-nodetype-festtypescripttypescript-json-schema
Otter rules-engine
This package is an Otter Framework Module.
Description
This module provides a rules engine that can run on your user's browser to customize the (translations, [//]: # (Should we target placeholder or the component npmjs, and we add a section on the placeholder there?) placeholders and configurations) of your application at runtime.
The rules engine interprets a list of actions to execute based on the evaluation of Rulesets and their conditions. Conditions are logical expressions relying on operators and variables we call facts.
You can store your list of Rulesets on a static JSON file.
This mechanism allows you to bring UI personalization based on runtime events without the need of a backend service. This can be useful if you want to drive dynamic behavior.
For example, you could consider leveraging this feature to display assets based on the current season or for some special events, or to drive A/B testing on your components.
You will find more information on the concepts behind the rules engine in its dedicated documentation. For a demonstration of the rules engine capabilities, you can refer to the live example in the Otter showcase.
How to install
1ng add @o3r/rules-engine
[!WARNING] This module requires @o3r/core to be installed.
How to use
The package exposes the RulesEngineRunnerService that can drive all the Otter customization-based services
in order to personalize the user experience.
On its own, the service will do nothing and will need action handlers to register with the list of supported actions
and their implementation.
Not only this allows for a better extensibility of the service, but it also keeps the number of imported module to the bare minimum for a lighter application.
Find more information on the Otter rules engine documentation.
Examples
Several examples of the rules engine usage are available on the following links:
Generators
Otter framework provides a set of code generators based on Angular schematics.
| Schematics | Description | How to use |
|---|---|---|
| add | Include Otter rules-engine module in a library / application. | ng add @o3r/rules-engine |
| rules-engine-to-component | Add rules-engine to an Otter component | ng g rules-engine-to-component |
| facts-service | Generate a facts service | ng g facts-service |
| operators | Generate an operator | ng g operator |
Debug
A whole section of the Otter Chrome Devtool extension is dedicated to the debug of the rules engine with a visual representation of your Rulesets and a history of the run, conditions met and actions applied.
Find more information on the tool in the Otter Chrome Devtool extension documentation and its dedicated section in the rules engine documentation.
External links
More details regarding the way the rules engine is working can be found in the documentation.
A live example is available in the Otter Showcase Application with reference to its code source.
No vulnerabilities found.
Reason
30 commit(s) and 4 issue activity found in the last 90 days -- score normalized to 10
Reason
all changesets reviewed
Reason
update tool detected
Details
- Info: detected update tool: RenovateBot: .renovaterc.json5:1
Reason
no dangerous workflow patterns detected
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1
- Info: Found text in security policy: SECURITY.md:1
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: BSD 3-Clause "New" or "Revised" License: LICENSE:0
Reason
SAST tool is run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Info: all commits (30) are checked with a SAST tool
Reason
15 out of 15 merged PRs checked by a CI test -- score normalized to 10
Reason
project has 7 contributing companies or organizations
Details
- Info: found contributions from: AmadeusITGroup, amadeus, amadeus it group, amadeus software labs, amadeusitgroup, ariatemplates, ng-bootstrap
Reason
binaries present in source code
Details
- Warn: binary detected: apps/intellij-extension/gradle/wrapper/gradle-wrapper.jar:1
Reason
dependency not pinned by hash detected -- score normalized to 9
Details
- Info: Possibly incomplete results: error parsing job operating system: .github/workflows/code-check.yml:72
- Info: Possibly incomplete results: error parsing job operating system: .github/workflows/code-check.yml:74
- Warn: npmCommand not pinned by hash: .github/workflows/publish.yml:109
- Info: 55 out of 55 GitHub-owned GitHubAction dependencies pinned
- Info: 11 out of 11 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
9 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
- Warn: Project is vulnerable to: GHSA-q5j8-9m9g-x2jh
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v
- Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h
- Warn: Project is vulnerable to: GHSA-776f-qx25-q3cc
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: jobLevel 'actions' permission set to 'write': .github/workflows/clean-cache.yml:19
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql.yml:34
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:35
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/e2e-tests.yml:62
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/main.yml:76
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/main.yml:125
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/main.yml:29
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/main.yml:139
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/publish-pr.yml:16
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/publish-pr.yml:41
- Warn: jobLevel 'checks' permission set to 'write': .github/workflows/publish-pr.yml:57
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/publish.yml:61
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/scorecards.yml:29
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/scorecards.yml:30
- Warn: jobLevel 'checks' permission set to 'write': .github/workflows/tests-reporter.yml:16
- Warn: jobLevel 'checks' permission set to 'write': .github/workflows/tests-reporter.yml:29
- Info: topLevel 'contents' permission set to 'read': .github/workflows/audit.yml:23
- Info: topLevel 'contents' permission set to 'read': .github/workflows/check-all-releases.yml:17
- Warn: no topLevel permission defined: .github/workflows/check-release.yml:1
- Info: topLevel permissions set to 'read-all': .github/workflows/clean-cache.yml:11
- Info: topLevel 'contents' permission set to 'read': .github/workflows/code-check.yml:32
- Info: topLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:27
- Info: topLevel 'contents' permission set to 'read': .github/workflows/deploy-showcase.yml:14
- Info: topLevel 'contents' permission set to 'read': .github/workflows/documentation.yml:4
- Warn: topLevel 'contents' permission set to 'write': .github/workflows/e2e-tests.yml:24
- Info: topLevel 'contents' permission set to 'read': .github/workflows/first-pr.yml:9
- Info: topLevel 'contents' permission set to 'read': .github/workflows/it-tests.yml:30
- Info: topLevel 'contents' permission set to 'read': .github/workflows/main.yml:8
- Info: topLevel 'contents' permission set to 'read': .github/workflows/md-external-links-check.yml:7
- Info: topLevel 'contents' permission set to 'read': .github/workflows/pr-labels.yml:6
- Info: topLevel 'contents' permission set to 'read': .github/workflows/publish-pr.yml:10
- Info: topLevel 'contents' permission set to 'read': .github/workflows/publish.yml:54
- Info: topLevel permissions set to 'read-all': .github/workflows/scorecards.yml:18
- Info: topLevel permissions set to 'read-all': .github/workflows/tests-reporter.yml:9
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
7.3
/10
Last Scanned on 2025-07-14T01:22:58Z
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More