Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akmjenkins/json-rules-engine-schema-operator
An operator for json-rules-engine to validate against a json schema
https://github.com/akmjenkins/json-rules-engine-schema-operator
json-rules-engine json-schema rules-engine
Last synced: 15 days ago
JSON representation
An operator for json-rules-engine to validate against a json schema
- Host: GitHub
- URL: https://github.com/akmjenkins/json-rules-engine-schema-operator
- Owner: akmjenkins
- License: mit
- Created: 2021-10-14T23:47:09.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-11-10T17:51:31.000Z (about 3 years ago)
- Last Synced: 2024-11-06T14:07:53.518Z (about 2 months ago)
- Topics: json-rules-engine, json-schema, rules-engine
- Language: JavaScript
- Homepage:
- Size: 73.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# json-rules-engine-schema-operator
[](https://npmjs.org/package/json-rules-engine-schema-operator)
[](https://codecov.io/gh/akmjenkins/json-rules-engine-schema-operator)
[](https://bundlephobia.com/result?p=json-rules-engine-schema-operator)
## What's This?
It's an operator to evaluate a value against a [JSON Schema](https://json-schema.org/) for the totally awesome [json-rules-engine](https://github.com/CacheControl/json-rules-engine) package.
## Why?
Because a JSON Schema **is a predicate**. A value either validates against a schema, or it doesn't. Rather than writing (and maintaining) a bunch of custom operators and bloating your codebase with them, you only need one operator - a schema operator.
## Installation
```bash
npm install json-rules-engine-schema-operator
# or
yarn add json-rules-engine-schema-operator
```
## Usage
This package is BYOV - bring your own validator (highly recommend [AJV](https://github.com/ajv-validator/ajv)!!)
```js
import Ajv from 'ajv';
import { Engine } from 'json-rules-engine';
import createSchemaOperator from 'json-rules-engine-schema-operator';
const ajv = new Ajv();
const validator = (subject,schema) => ajv.validate(schema,subject);
const engine = new Engine();
engine.addOperator(createSchemaOperator(validator));
```
and now you can do this:
```js
engine.addRule({
conditions: {
any: [
{
fact: 'firstName',
operator: 'schema',
value: {
type: 'string',
pattern: '^J',
},
},
],
},
event: {
type: 'j_firstName',
},
});
```
## Custom Operator Name
By default, the name of the operator added to the engine is `schema`. This is configurable by passing in a custom name via the second optional parameter `options`:
```js
const name = 'jsonSchemaOperator';
engine.addOperator(validator, { name });
engine.addRule({
conditions: {
any: [
{
fact: 'firstName',
operator: name,
value: {
type: 'string',
pattern: '^J',
},
},
],
},
event: {
type: 'j_firstName',
},
});
```
## Related
I ❤️ JSON schema and [json-rules-engine](https://github.com/CacheControl/json-rules-engine) both so much, that I created a package [json-schema-rules-engine](https://github.com/akmjenkins/json-schema-rules-engine) that works very similarly, but it relies entirely on JSON schemas for predicates (or "operators"), which greatly simplifies the concept of the rules engine.