migrated to typescript, updated the readme and added more examples

Author: io780

.eslintrc.yml

@@ -0,0 +1,35 @@
+'use strict';
+
+import parser from '@typescript-eslint/parser';
+import plugin from '@typescript-eslint/eslint-plugin';
+
+export default [
+    {
+        files: ['**/*.ts'],
+        languageOptions: {
+            parser,
+            ecmaVersion: 'latest',
+            sourceType: 'module',
+            globals: {
+                describe: 'readonly',
+                it: 'readonly',
+                before: 'readonly',
+                after: 'readonly',
+                beforeEach: 'readonly',
+                afterEach: 'readonly'
+            }
+        },
+        plugins: {
+            '@typescript-eslint': plugin
+        },
+        rules: {
+            indent: ['error', 4],
+            'linebreak-style': ['error', 'unix'],
+            quotes: ['error', 'single'],
+            semi: ['error', 'always']
+        }
+    },
+    {
+        ignores: ['node_modules/', 'dist/', 'coverage/']
+    }
+];

README.md

@@ -0,0 +1,32 @@
+/**
+ * Example 1: High-spending customer discount
+ * Run from project root: node examples/01-high-spending-discount.mjs
+ * (Run "npm run build" first.)
+ */
+import { Fact, Condition, Conditions, Rule, RuleEngine } from '../dist/index.js';
+
+const transactionFact = new Fact('transaction');
+transactionFact.setFact = { amount: 600 };
+const customerStatusFact = new Fact('customer_status');
+customerStatusFact.setFact = { status: 'gold' };
+
+const condition1 = new Condition();
+condition1.fact('transaction').operator('greaterThan').value(500).path('amount');
+const condition2 = new Condition();
+condition2.fact('customer_status').operator('equal').value('gold').path('status');
+
+const conditions = new Conditions('promoEligibility');
+conditions.all([condition1.getCondition, condition2.getCondition]);
+
+const rule = new Rule('applyDiscount');
+rule.conditions('promoEligibility')
+    .event('discount', { discount: 10 })
+    .priority(1)
+    .onSuccess(() => console.log('Discount applied successfully'))
+    .onFailure(() => console.log('Discount could not be applied'));
+
+const ruleEngine = new RuleEngine();
+const results = await ruleEngine.run();
+console.log('Events:', results.events.length);
+console.log('First event type:', results.events[0]?.type);
+console.log('OK: High-spending discount example passed.\n');

eslint.config.js

@@ -0,0 +1,14 @@
+/**
+ * Example 2: Action arithmetic and run()
+ * Run: node examples/02-action-arithmetic.mjs
+ */
+import { Action } from '../dist/index.js';
+
+const data = { price: 100, taxRate: 0.2 };
+const params = { action: 'multiply', value: 0.2, dataPath: 'price' };
+const action = new Action(data, params);
+
+// Compute tax: price * taxRate via run() (uses params.action, params.value, params.dataPath)
+const result = await action.run();
+console.log('Tax (100 * 0.2):', result);
+console.log(result === 20 ? 'OK: Action arithmetic example passed.\n' : 'FAIL');

examples/01-high-spending-discount.mjs

@@ -0,0 +1,22 @@
+/**
+ * Example 3: Date difference (numberOfDays, numberOfWeeks, numberOfMonths, numberOfYears)
+ * Run: node examples/03-date-difference.mjs
+ */
+import { Action } from '../dist/index.js';
+
+const action = new Action(
+    { dummy: 1 },
+    { action: 'numberOfDays', value: null, dataPath: 'dummy' }
+);
+
+action.numberOfDays('2023-01-01', '2023-01-10');
+console.log('Days between 2023-01-01 and 2023-01-10:', action.getResult);
+console.log(action.getResult === 9 ? 'OK: numberOfDays passed.' : 'FAIL');
+
+action.numberOfMonths('2023-01-01', '2024-01-01');
+console.log('Months between 2023-01-01 and 2024-01-01:', action.getResult);
+console.log(action.getResult === 12 ? 'OK: numberOfMonths passed.' : 'FAIL');
+
+action.numberOfYears('2020-01-01', '2024-01-01');
+console.log('Years between 2020 and 2024:', action.getResult);
+console.log(action.getResult === 4 ? 'OK: Date difference example passed.\n' : 'FAIL');

examples/02-action-arithmetic.mjs

@@ -0,0 +1,17 @@
+/**
+ * Example 4: Boolean actions (true() and false())
+ * Run: node examples/04-boolean-action.mjs
+ */
+import { Action } from '../dist/index.js';
+
+const action = new Action(
+    { x: 1 },
+    { action: 'true', value: null, dataPath: 'x' }
+);
+action.true();
+console.log('action.true() result:', action.getResult);
+console.log(action.getResult === true ? 'OK: true() passed.' : 'FAIL');
+
+action.false();
+console.log('action.false() result:', action.getResult);
+console.log(action.getResult === false ? 'OK: Boolean action example passed.\n' : 'FAIL');

examples/03-date-difference.mjs

@@ -0,0 +1,29 @@
+/**
+ * Example 5: OR conditions (any) — rule fires if status is gold OR silver
+ * Run: node examples/05-or-conditions.mjs
+ */
+import { Fact, Condition, Conditions, Rule, RuleEngine } from '../dist/index.js';
+
+const fact = new Fact('customer_status');
+fact.setFact = { status: 'silver' }; // Not gold; silver qualifies with "any"
+
+const condGold = new Condition();
+condGold.fact('customer_status').operator('equal').value('gold').path('status');
+const condSilver = new Condition();
+condSilver.fact('customer_status').operator('equal').value('silver').path('status');
+
+const conditions = new Conditions('premiumStatus');
+conditions.any([condGold.getCondition, condSilver.getCondition]);
+
+const rule = new Rule('premiumAccess');
+rule.conditions('premiumStatus')
+    .event('grantAccess', { level: 'premium' })
+    .priority(1)
+    .onSuccess(() => console.log('Premium access granted (gold or silver).'))
+    .onFailure(() => console.log('Access denied.'));
+
+const ruleEngine = new RuleEngine();
+const results = await ruleEngine.run();
+console.log('Events:', results.events.length, results.events[0]?.type);
+console.log(results.events.length === 1 && results.events[0].type === 'grantAccess'
+    ? 'OK: OR conditions example passed.\n' : 'FAIL');

examples/04-boolean-action.mjs

@@ -0,0 +1,26 @@
+/**
+ * Example 6: Rule that does not fire (onFailure) — amount too low
+ * Run: node examples/06-rule-failure.mjs
+ */
+import { Fact, Condition, Conditions, Rule, RuleEngine } from '../dist/index.js';
+
+const transactionFact = new Fact('transaction');
+transactionFact.setFact = { amount: 100 }; // Below 500
+
+const condition1 = new Condition();
+condition1.fact('transaction').operator('greaterThan').value(500).path('amount');
+
+const conditions = new Conditions('noDiscountEligibility');
+conditions.all([condition1.getCondition]);
+
+const rule = new Rule('noDiscount');
+rule.conditions('noDiscountEligibility')
+    .event('discount', { discount: 0 })
+    .priority(1)
+    .onSuccess(() => console.log('Discount applied'))
+    .onFailure(() => console.log('Discount could not be applied (amount too low)'));
+
+const ruleEngine = new RuleEngine();
+const results = await ruleEngine.run();
+console.log('Events fired:', results.events.length);
+console.log(results.events.length === 0 ? 'OK: Rule failure (onFailure) example passed.\n' : 'FAIL');

examples/05-or-conditions.mjs

@@ -0,0 +1,27 @@
+/**
+ * Example 7: HTTP request (Action with a public API)
+ * Run: node examples/07-api-request.mjs
+ * Uses JSONPlaceholder (https://jsonplaceholder.typicode.com) - no auth required.
+ */
+import { Action } from '../dist/index.js';
+
+const action = new Action(
+    { dummy: 1 },
+    { action: 'request', value: null, dataPath: 'dummy' }
+);
+
+action.setUrl = 'https://jsonplaceholder.typicode.com/posts/1';
+action.setMethod = 'GET';
+action.setHeaders = {};
+
+await action.request('post', {});
+
+const result = action.getResult;
+const byName = action.getData.requestData?.post;
+
+console.log('GET https://jsonplaceholder.typicode.com/posts/1');
+console.log('Response (getResult):', typeof result === 'object' && result !== null ? { ...result } : result);
+console.log('Response (requestData.post):', typeof byName === 'object' && byName !== null ? { ...byName } : byName);
+
+const ok = result && typeof result === 'object' && 'id' in result && result.id === 1 && 'title' in result;
+console.log(ok ? 'OK: API request example passed.\n' : 'FAIL');