Compare commits
14 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 376a8c3113 | |||
| fcd50a780a | |||
| 875c06f86c | |||
| 0a8e4a3517 | |||
| 8b9dec976c | |||
| 1493848dc8 | |||
| 17287a9ba3 | |||
| 11921a2864 | |||
| 9035fafdc2 | |||
| 773ae00517 | |||
| e67fbfebf6 | |||
| b2478d79f2 | |||
| 917e630554 | |||
| b3b02fee70 |
4
.gitignore
vendored
4
.gitignore
vendored
@@ -15,8 +15,6 @@ node_modules/
|
||||
|
||||
# builds
|
||||
dist/
|
||||
dist_web/
|
||||
dist_serve/
|
||||
dist_ts_web/
|
||||
dist_*/
|
||||
|
||||
# custom
|
||||
@@ -12,29 +12,35 @@ stages:
|
||||
- release
|
||||
- metadata
|
||||
|
||||
before_script:
|
||||
- npm install -g @shipzone/npmci
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
mirror:
|
||||
auditProductionDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --production --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=prod --production
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
allow_failure: true
|
||||
|
||||
snyk:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
|
||||
auditDevDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command snyk test
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=dev
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
allow_failure: true
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
@@ -49,9 +55,7 @@ testStable:
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
@@ -62,9 +66,7 @@ testBuild:
|
||||
- npmci command npm run build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
release:
|
||||
stage: release
|
||||
@@ -84,11 +86,12 @@ release:
|
||||
codequality:
|
||||
stage: metadata
|
||||
allow_failure: true
|
||||
only:
|
||||
- tags
|
||||
script:
|
||||
- npmci command npm install -g tslint typescript
|
||||
- npmci command npm install -g typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
@@ -108,11 +111,10 @@ trigger:
|
||||
pages:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci node install lts
|
||||
- npmci command npm install -g @gitzone/tsdoc
|
||||
- npmci node install stable
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
- npmci command npm run buildDocs
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
|
||||
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@@ -2,28 +2,10 @@
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "current file",
|
||||
"type": "node",
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"${relativeFile}"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
},
|
||||
{
|
||||
"name": "test.ts",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"test/test.ts"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
"type": "node-terminal"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
8
.vscode/settings.json
vendored
8
.vscode/settings.json
vendored
@@ -11,7 +11,13 @@
|
||||
},
|
||||
"gitzone": {
|
||||
"type": "object",
|
||||
"description": "settings for gitzone"
|
||||
"description": "settings for gitzone",
|
||||
"properties": {
|
||||
"projectType": {
|
||||
"type": "string",
|
||||
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
1
dist_ts/index.d.ts
vendored
Normal file
1
dist_ts/index.d.ts
vendored
Normal file
@@ -0,0 +1 @@
|
||||
export * from './smartrule.classes.smartrule.js';
|
||||
2
dist_ts/index.js
Normal file
2
dist_ts/index.js
Normal file
@@ -0,0 +1,2 @@
|
||||
export * from './smartrule.classes.smartrule.js';
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxjQUFjLGtDQUFrQyxDQUFDIn0=
|
||||
11
dist_ts/smartrule.classes.rule.d.ts
vendored
Normal file
11
dist_ts/smartrule.classes.rule.d.ts
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
import { SmartRule } from './smartrule.classes.smartrule.js';
|
||||
export declare type TTreeActionResult = 'continue' | 'apply-continue' | 'apply-stop' | 'stop';
|
||||
export declare type TActionFunc<T = any> = (objectArg: T) => Promise<any>;
|
||||
export declare type TCheckFunc<T> = (objectArg: T) => Promise<TTreeActionResult>;
|
||||
export declare class Rule<T> {
|
||||
smartRuleRef: SmartRule<T>;
|
||||
priority: number;
|
||||
checkFunction: TCheckFunc<T>;
|
||||
actionFunction: TActionFunc;
|
||||
constructor(smartRuleRef: SmartRule<T>, priorityArg: number, checkFunctionArg: TCheckFunc<T>, actionFunctionArg: TActionFunc);
|
||||
}
|
||||
11
dist_ts/smartrule.classes.rule.js
Normal file
11
dist_ts/smartrule.classes.rule.js
Normal file
@@ -0,0 +1,11 @@
|
||||
import './smartrule.plugins.js';
|
||||
import './smartrule.classes.smartrule.js';
|
||||
export class Rule {
|
||||
constructor(smartRuleRef, priorityArg, checkFunctionArg, actionFunctionArg) {
|
||||
this.smartRuleRef = smartRuleRef;
|
||||
this.priority = priorityArg;
|
||||
this.checkFunction = checkFunctionArg;
|
||||
this.actionFunction = actionFunctionArg;
|
||||
}
|
||||
}
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRydWxlLmNsYXNzZXMucnVsZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0cnVsZS5jbGFzc2VzLnJ1bGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBeUIsd0JBQXdCLENBQUM7QUFDbEQsT0FBMEIsa0NBQWtDLENBQUM7QUFPN0QsTUFBTSxPQUFPLElBQUk7SUFNZixZQUNFLFlBQTBCLEVBQzFCLFdBQW1CLEVBQ25CLGdCQUErQixFQUMvQixpQkFBOEI7UUFFOUIsSUFBSSxDQUFDLFlBQVksR0FBRyxZQUFZLENBQUM7UUFDakMsSUFBSSxDQUFDLFFBQVEsR0FBRyxXQUFXLENBQUM7UUFDNUIsSUFBSSxDQUFDLGFBQWEsR0FBRyxnQkFBZ0IsQ0FBQztRQUN0QyxJQUFJLENBQUMsY0FBYyxHQUFHLGlCQUFpQixDQUFDO0lBQzFDLENBQUM7Q0FDRiJ9
|
||||
10
dist_ts/smartrule.classes.smartrule.d.ts
vendored
Normal file
10
dist_ts/smartrule.classes.smartrule.d.ts
vendored
Normal file
@@ -0,0 +1,10 @@
|
||||
import { Rule, TCheckFunc, TActionFunc } from './smartrule.classes.rule.js';
|
||||
export declare class SmartRule<T> {
|
||||
rules: Array<Rule<T>>;
|
||||
/**
|
||||
* makes a decision based on the given obect and the given rules
|
||||
* @param objectArg
|
||||
*/
|
||||
makeDecision(objectArg: T): Promise<void>;
|
||||
createRule(priorityArg: number, checkFunctionArg: TCheckFunc<T>, actionFunctionArg: TActionFunc): void;
|
||||
}
|
||||
69
dist_ts/smartrule.classes.smartrule.js
Normal file
69
dist_ts/smartrule.classes.smartrule.js
Normal file
@@ -0,0 +1,69 @@
|
||||
import './smartrule.plugins.js';
|
||||
import { Rule } from './smartrule.classes.rule.js';
|
||||
export class SmartRule {
|
||||
constructor() {
|
||||
this.rules = [];
|
||||
}
|
||||
/**
|
||||
* makes a decision based on the given obect and the given rules
|
||||
* @param objectArg
|
||||
*/
|
||||
async makeDecision(objectArg) {
|
||||
// lets sort the rules
|
||||
this.rules = this.rules.sort((a, b) => {
|
||||
if (a.priority > b.priority) {
|
||||
return 1;
|
||||
}
|
||||
else {
|
||||
return 0;
|
||||
}
|
||||
});
|
||||
// gets the next batch with the same priority
|
||||
const getNextParallelBatch = (priorityStart) => {
|
||||
return this.rules.filter(rule => {
|
||||
return rule.priority === priorityStart;
|
||||
});
|
||||
};
|
||||
// lets run the checks
|
||||
const runNextBatch = async (startPriority, runRulesAmount) => {
|
||||
const nextBatch = getNextParallelBatch(startPriority);
|
||||
runRulesAmount = runRulesAmount + nextBatch.length;
|
||||
const outcomes = [];
|
||||
for (const rule of nextBatch) {
|
||||
const checkResult = await rule.checkFunction(objectArg);
|
||||
checkResult
|
||||
? null
|
||||
: console.log('WARNING!!! Please make sure your rule always returns a statement of how to continue!');
|
||||
if (checkResult.startsWith('apply')) {
|
||||
await rule.actionFunction(objectArg); // here the action function is run
|
||||
}
|
||||
outcomes.push(checkResult);
|
||||
}
|
||||
if (outcomes.length > 0) {
|
||||
const finalOutcomeOfBatch = outcomes.reduce((previous, current, index, array) => {
|
||||
if (current.includes('continue') || previous.includes('continue')) {
|
||||
return 'continue';
|
||||
}
|
||||
else {
|
||||
return 'stop';
|
||||
}
|
||||
});
|
||||
if (finalOutcomeOfBatch === 'stop') {
|
||||
return;
|
||||
}
|
||||
}
|
||||
if (runRulesAmount < this.rules.length) {
|
||||
await runNextBatch(startPriority + 1, runRulesAmount);
|
||||
}
|
||||
else {
|
||||
return;
|
||||
}
|
||||
};
|
||||
await runNextBatch(0, 0);
|
||||
}
|
||||
createRule(priorityArg, checkFunctionArg, actionFunctionArg) {
|
||||
const rule = new Rule(this, priorityArg, checkFunctionArg, actionFunctionArg);
|
||||
this.rules.push(rule);
|
||||
}
|
||||
}
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRydWxlLmNsYXNzZXMuc21hcnRydWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRydWxlLmNsYXNzZXMuc21hcnRydWxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQXlCLHdCQUF3QixDQUFDO0FBQ2xELE9BQU8sRUFBRSxJQUFJLEVBQThDLE1BQU0sNkJBQTZCLENBQUM7QUFFL0YsTUFBTSxPQUFPLFNBQVM7SUFBdEI7UUFDUyxVQUFLLEdBQW1CLEVBQUUsQ0FBQztJQTJFcEMsQ0FBQztJQXpFQzs7O09BR0c7SUFDSSxLQUFLLENBQUMsWUFBWSxDQUFDLFNBQVk7UUFDcEMsc0JBQXNCO1FBQ3RCLElBQUksQ0FBQyxLQUFLLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxFQUFFLEVBQUU7WUFDcEMsSUFBSSxDQUFDLENBQUMsUUFBUSxHQUFHLENBQUMsQ0FBQyxRQUFRLEVBQUU7Z0JBQzNCLE9BQU8sQ0FBQyxDQUFDO2FBQ1Y7aUJBQU07Z0JBQ0wsT0FBTyxDQUFDLENBQUM7YUFDVjtRQUNILENBQUMsQ0FBQyxDQUFDO1FBRUgsNkNBQTZDO1FBQzdDLE1BQU0sb0JBQW9CLEdBQUcsQ0FBQyxhQUFxQixFQUFFLEVBQUU7WUFDckQsT0FBTyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsRUFBRTtnQkFDOUIsT0FBTyxJQUFJLENBQUMsUUFBUSxLQUFLLGFBQWEsQ0FBQztZQUN6QyxDQUFDLENBQUMsQ0FBQztRQUNMLENBQUMsQ0FBQztRQUVGLHNCQUFzQjtRQUN0QixNQUFNLFlBQVksR0FBRyxLQUFLLEVBQUUsYUFBcUIsRUFBRSxjQUFzQixFQUFpQixFQUFFO1lBQzFGLE1BQU0sU0FBUyxHQUFHLG9CQUFvQixDQUFDLGFBQWEsQ0FBQyxDQUFDO1lBQ3RELGNBQWMsR0FBRyxjQUFjLEdBQUcsU0FBUyxDQUFDLE1BQU0sQ0FBQztZQUNuRCxNQUFNLFFBQVEsR0FBd0IsRUFBRSxDQUFDO1lBQ3pDLEtBQUssTUFBTSxJQUFJLElBQUksU0FBUyxFQUFFO2dCQUM1QixNQUFNLFdBQVcsR0FBRyxNQUFNLElBQUksQ0FBQyxhQUFhLENBQUMsU0FBUyxDQUFDLENBQUM7Z0JBQ3hELFdBQVc7b0JBQ1QsQ0FBQyxDQUFDLElBQUk7b0JBQ04sQ0FBQyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQ1Qsc0ZBQXNGLENBQ3ZGLENBQUM7Z0JBRU4sSUFBSSxXQUFXLENBQUMsVUFBVSxDQUFDLE9BQU8sQ0FBQyxFQUFFO29CQUNuQyxNQUFNLElBQUksQ0FBQyxjQUFjLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQyxrQ0FBa0M7aUJBQ3pFO2dCQUNELFFBQVEsQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLENBQUM7YUFDNUI7WUFFRCxJQUFJLFFBQVEsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFO2dCQUN2QixNQUFNLG1CQUFtQixHQUFzQixRQUFRLENBQUMsTUFBTSxDQUM1RCxDQUFDLFFBQVEsRUFBRSxPQUFPLEVBQUUsS0FBSyxFQUFFLEtBQUssRUFBRSxFQUFFO29CQUNsQyxJQUFJLE9BQU8sQ0FBQyxRQUFRLENBQUMsVUFBVSxDQUFDLElBQUksUUFBUSxDQUFDLFFBQVEsQ0FBQyxVQUFVLENBQUMsRUFBRTt3QkFDakUsT0FBTyxVQUFVLENBQUM7cUJBQ25CO3lCQUFNO3dCQUNMLE9BQU8sTUFBTSxDQUFDO3FCQUNmO2dCQUNILENBQUMsQ0FDRixDQUFDO2dCQUNGLElBQUksbUJBQW1CLEtBQUssTUFBTSxFQUFFO29CQUNsQyxPQUFPO2lCQUNSO2FBQ0Y7WUFFRCxJQUFJLGNBQWMsR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sRUFBRTtnQkFDdEMsTUFBTSxZQUFZLENBQUMsYUFBYSxHQUFHLENBQUMsRUFBRSxjQUFjLENBQUMsQ0FBQzthQUN2RDtpQkFBTTtnQkFDTCxPQUFPO2FBQ1I7UUFDSCxDQUFDLENBQUM7UUFFRixNQUFNLFlBQVksQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUM7SUFDM0IsQ0FBQztJQUVNLFVBQVUsQ0FDZixXQUFtQixFQUNuQixnQkFBK0IsRUFDL0IsaUJBQThCO1FBRTlCLE1BQU0sSUFBSSxHQUFHLElBQUksSUFBSSxDQUFJLElBQUksRUFBRSxXQUFXLEVBQUUsZ0JBQWdCLEVBQUUsaUJBQWlCLENBQUMsQ0FBQztRQUNqRixJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUN4QixDQUFDO0NBQ0YifQ==
|
||||
2
dist_ts/smartrule.plugins.d.ts
vendored
Normal file
2
dist_ts/smartrule.plugins.d.ts
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
declare const removeme: {};
|
||||
export { removeme };
|
||||
3
dist_ts/smartrule.plugins.js
Normal file
3
dist_ts/smartrule.plugins.js
Normal file
@@ -0,0 +1,3 @@
|
||||
const removeme = {};
|
||||
export { removeme };
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRydWxlLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHJ1bGUucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxNQUFNLFFBQVEsR0FBRyxFQUFFLENBQUM7QUFDcEIsT0FBTyxFQUFFLFFBQVEsRUFBRSxDQUFDIn0=
|
||||
@@ -1,10 +1,11 @@
|
||||
{
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"gitrepo": "smartrule",
|
||||
"shortDescription": "a smart rule library for handling decision trees.",
|
||||
"description": "a smart rule library for handling decision trees.",
|
||||
"npmPackagename": "@pushrocks/smartrule",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks"
|
||||
|
||||
13547
package-lock.json
generated
13547
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
29
package.json
29
package.json
@@ -1,35 +1,38 @@
|
||||
{
|
||||
"name": "@pushrocks/smartrule",
|
||||
"version": "1.0.5",
|
||||
"version": "2.0.1",
|
||||
"private": false,
|
||||
"description": "a smart rule library for handling decision trees.",
|
||||
"main": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"author": "Lossless GmbH",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"test": "(tstest test/)",
|
||||
"build": "(tsbuild)",
|
||||
"format": "(gitzone format)"
|
||||
"build": "(tsbuild --web)",
|
||||
"format": "(gitzone format)",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.0.22",
|
||||
"@gitzone/tstest": "^1.0.15",
|
||||
"@pushrocks/tapbundle": "^3.0.7",
|
||||
"@types/node": "^10.11.7",
|
||||
"tslint": "^5.11.0",
|
||||
"tslint-config-prettier": "^1.15.0"
|
||||
"@gitzone/tsbuild": "^2.1.65",
|
||||
"@gitzone/tstest": "^1.0.73",
|
||||
"@pushrocks/tapbundle": "^5.0.4",
|
||||
"@types/node": "^18.6.4"
|
||||
},
|
||||
"dependencies": {},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
"ts_web/**/*",
|
||||
"dist/**/*",
|
||||
"dist_web/**/*",
|
||||
"dist_*/**/*",
|
||||
"dist_ts/**/*",
|
||||
"dist_ts_web/**/*",
|
||||
"assets/**/*",
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
]
|
||||
}
|
||||
|
||||
21
readme.md
21
readme.md
@@ -8,13 +8,20 @@ a smart rule library for handling decision trees.
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartrule/)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/smartrule/commits/master)
|
||||
[](https://gitlab.com/pushrocks/smartrule/commits/master)
|
||||
[](https://www.npmjs.com/package/@pushrocks/smartrule)
|
||||
[](https://snyk.io/test/npm/@pushrocks/smartrule)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://prettier.io/)
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
12
test/test.ts
12
test/test.ts
@@ -1,5 +1,5 @@
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import * as smartrule from '../ts/index';
|
||||
import * as smartrule from '../ts/index.js';
|
||||
|
||||
interface ITestMessage {
|
||||
id: string;
|
||||
@@ -11,13 +11,13 @@ let testSmartruleInstance: smartrule.SmartRule<ITestMessage>;
|
||||
tap.test('first test', async () => {
|
||||
testSmartruleInstance = new smartrule.SmartRule<ITestMessage>();
|
||||
testSmartruleInstance.createRule(
|
||||
0,
|
||||
async messageArg => {
|
||||
2,
|
||||
async (messageArg) => {
|
||||
if (messageArg.body.startsWith('hello')) {
|
||||
return 'apply-stop';
|
||||
}
|
||||
},
|
||||
async messageArg => {
|
||||
async (messageArg) => {
|
||||
console.log(`rule triggered for message with body ${messageArg.body}`);
|
||||
}
|
||||
);
|
||||
@@ -26,8 +26,8 @@ tap.test('first test', async () => {
|
||||
tap.test('make a decision based on an object', async () => {
|
||||
testSmartruleInstance.makeDecision({
|
||||
id: '123456',
|
||||
body: 'hello, there. This is a cool message!'
|
||||
})
|
||||
body: 'hello, there. This is a cool message!',
|
||||
});
|
||||
});
|
||||
|
||||
tap.start();
|
||||
|
||||
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@pushrocks/smartrule',
|
||||
version: '2.0.1',
|
||||
description: 'a smart rule library for handling decision trees.'
|
||||
}
|
||||
@@ -1 +1 @@
|
||||
export * from './smartrule.classes.smartrule';
|
||||
export * from './smartrule.classes.smartrule.js';
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
import * as plugins from './smartrule.plugins';
|
||||
import { SmartRule } from './smartrule.classes.smartrule';
|
||||
import * as plugins from './smartrule.plugins.js';
|
||||
import { SmartRule } from './smartrule.classes.smartrule.js';
|
||||
|
||||
export type TTreeActionResult = 'continue' | 'apply-continue' | 'apply-stop' | 'stop';
|
||||
export type TActionFunc = (objectArg) => Promise<any>;
|
||||
export type TActionFunc<T = any> = (objectArg: T) => Promise<any>;
|
||||
|
||||
export type TCheckFunc<T> = (objectArg: T) => Promise<TTreeActionResult>;
|
||||
|
||||
@@ -12,10 +12,15 @@ export class Rule<T> {
|
||||
public checkFunction: TCheckFunc<T>;
|
||||
public actionFunction: TActionFunc;
|
||||
|
||||
constructor(smartRuleRef: SmartRule<T>, priorityArg: number, checkFunctionArg: TCheckFunc<T>, actionFunctionArg: TActionFunc) {
|
||||
constructor(
|
||||
smartRuleRef: SmartRule<T>,
|
||||
priorityArg: number,
|
||||
checkFunctionArg: TCheckFunc<T>,
|
||||
actionFunctionArg: TActionFunc
|
||||
) {
|
||||
this.smartRuleRef = smartRuleRef;
|
||||
this.priority = priorityArg;
|
||||
this.checkFunction = checkFunctionArg;
|
||||
this.actionFunction = actionFunctionArg;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
import * as plugins from './smartrule.plugins';
|
||||
import { Rule, TCheckFunc, TActionFunc, TTreeActionResult } from './smartrule.classes.rule';
|
||||
import * as plugins from './smartrule.plugins.js';
|
||||
import { Rule, TCheckFunc, TActionFunc, TTreeActionResult } from './smartrule.classes.rule.js';
|
||||
|
||||
export class SmartRule<T> {
|
||||
public rules: Array<Rule<T>> = [];
|
||||
|
||||
/**
|
||||
* makes a decision based on the given obect and the given rules
|
||||
* @param objectArg
|
||||
* @param objectArg
|
||||
*/
|
||||
public async makeDecision(objectArg: T) {
|
||||
// lets sort the rules
|
||||
this.rules = this.rules.sort((a,b) => {
|
||||
this.rules = this.rules.sort((a, b) => {
|
||||
if (a.priority > b.priority) {
|
||||
return 1;
|
||||
} else {
|
||||
@@ -20,46 +20,61 @@ export class SmartRule<T> {
|
||||
|
||||
// gets the next batch with the same priority
|
||||
const getNextParallelBatch = (priorityStart: number) => {
|
||||
return this.rules.filter(rule => {
|
||||
return this.rules.filter((rule) => {
|
||||
return rule.priority === priorityStart;
|
||||
});
|
||||
};
|
||||
|
||||
// lets run the checks
|
||||
const runNextBatch = async (startPriority: number) => {
|
||||
const nextBatch = getNextParallelBatch(0);
|
||||
const runNextBatch = async (startPriority: number, runRulesAmount: number): Promise<void> => {
|
||||
const nextBatch = getNextParallelBatch(startPriority);
|
||||
runRulesAmount = runRulesAmount + nextBatch.length;
|
||||
const outcomes: TTreeActionResult[] = [];
|
||||
for (const rule of nextBatch) {
|
||||
const checkResult = await rule.checkFunction(objectArg);
|
||||
if (checkResult.startsWith("apply")) {
|
||||
await rule.actionFunction(objectArg);
|
||||
checkResult
|
||||
? null
|
||||
: console.log(
|
||||
'WARNING!!! Please make sure your rule always returns a statement of how to continue!'
|
||||
);
|
||||
|
||||
if (checkResult.startsWith('apply')) {
|
||||
await rule.actionFunction(objectArg); // here the action function is run
|
||||
}
|
||||
outcomes.push(checkResult);
|
||||
}
|
||||
|
||||
if (outcomes.length > 0) {
|
||||
const finalOutcomeOfBatch: TTreeActionResult = outcomes.reduce((previous, current, index, array) => {
|
||||
if (current.includes('continue') || previous.includes('continue')) {
|
||||
return 'continue';
|
||||
} else {
|
||||
return 'stop';
|
||||
const finalOutcomeOfBatch: TTreeActionResult = outcomes.reduce(
|
||||
(previous, current, index, array) => {
|
||||
if (current.includes('continue') || previous.includes('continue')) {
|
||||
return 'continue';
|
||||
} else {
|
||||
return 'stop';
|
||||
}
|
||||
}
|
||||
});
|
||||
);
|
||||
if (finalOutcomeOfBatch === 'stop') {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
if (startPriority < this.rules[this.rules.length-1].priority) {
|
||||
runNextBatch(startPriority++);
|
||||
if (runRulesAmount < this.rules.length) {
|
||||
await runNextBatch(startPriority + 1, runRulesAmount);
|
||||
} else {
|
||||
return;
|
||||
}
|
||||
};
|
||||
|
||||
await runNextBatch(0);
|
||||
await runNextBatch(0, 0);
|
||||
}
|
||||
|
||||
public createRule(priorityArg: number, checkFunctionArg: TCheckFunc<T>, actionFunctionArg: TActionFunc) {
|
||||
public createRule(
|
||||
priorityArg: number,
|
||||
checkFunctionArg: TCheckFunc<T>,
|
||||
actionFunctionArg: TActionFunc
|
||||
) {
|
||||
const rule = new Rule<T>(this, priorityArg, checkFunctionArg, actionFunctionArg);
|
||||
this.rules.push(rule);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
10
tsconfig.json
Normal file
10
tsconfig.json
Normal file
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "ES2022",
|
||||
"moduleResolution": "nodenext",
|
||||
"esModuleInterop": true
|
||||
}
|
||||
}
|
||||
17
tslint.json
17
tslint.json
@@ -1,17 +0,0 @@
|
||||
{
|
||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||
"rules": {
|
||||
"semicolon": [true, "always"],
|
||||
"no-console": false,
|
||||
"ordered-imports": false,
|
||||
"object-literal-sort-keys": false,
|
||||
"member-ordering": {
|
||||
"options":{
|
||||
"order": [
|
||||
"static-method"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"defaultSeverity": "warning"
|
||||
}
|
||||
Reference in New Issue
Block a user