@croct/rule-engine
v0.0.1-alpha.13
Published
A rule engine built on top of the Croct Plug.
Downloads
16
Readme
Installation
We currently offer two ways to install the library.
CDN
Add the following line to the <head> tag of your HTML document:
<script src="https://cdn.croct.io/js/v1/lib/engine.js"></script>This guarantees the application will always use the latest version of the library.
NPM
NPM is the recommended installation method when building large scale applications with Croct. It pairs nicely with module bundlers such as Webpack or Browserify and includes Typescript typings.
Run the following command to install the latest version of the package:
npm install @croct/rule-engineBasic usage
The following example shows how to define a rule to display a alert to returning users only:
import croct from '@croct/plug';
import {RuleEngine, Definitions, Action, actions, audiences} from '@croct/rule-engine';
export class WelcomeUser implements Action {
public apply(): void {
window.alert('Welcome back!');
}
}
const definitions: Definitions = {
extensions: [
actions({
'welcome-user': new WelcomeUser(),
}),
audiences({
'returning-users': 'user is returning',
}),
],
pages: {
'/home': [
{
rules: [
{
name: 'welcome-returning-users',
properties: {
audience: 'returning-users',
action: 'welcome-user',
},
},
],
},
],
},
};
croct.plug({appId: '<APP_ID>'});
const engine = new RuleEngine(croct.sdk, definitions);
engine.run();Don't forget replacing <APP_ID> with the public application ID.
Contributing
Contributions to the package are always welcome!
- Report any bugs or issues on the issue tracker.
- For major changes, please open an issue first to discuss what you would like to change.
- Please make sure to update tests as appropriate.
Testing
Before running the test suites, the development dependencies must be installed:
npm installThen, to run all tests:
npm testCopyright Notice
Copyright © 2015-2020 Croct Limited, All Rights Reserved.
All information contained herein is, and remains the property of Croct Limited. The intellectual, design and technical concepts contained herein are proprietary to Croct Limited s and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law. Dissemination of this information or reproduction of this material is strictly forbidden unless prior written permission is obtained from Croct Limited.