@jss-rule-engine/core
Version:
Rule engine for Sitecore JSS
235 lines • 12.7 kB
JavaScript
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.JssRuleEngine = void 0;
var initializeRules_1 = __importDefault(require("./rules/initializeRules"));
var initializeCommands_1 = __importDefault(require("./commands/initializeCommands"));
var initializeOperators_1 = __importDefault(require("./operators/initializeOperators"));
var ruleParser_1 = __importDefault(require("./ruleParser"));
var ruleEngineRunner_1 = __importDefault(require("./ruleEngineRunner"));
var ruleEngineSessionContext_1 = require("./types/ruleEngineSessionContext");
var JssRuleEngine = /** @class */ (function () {
function JssRuleEngine(options) {
this.debug = false;
this.commandDefinitions = new Map();
this.ruleDefinitions = new Map();
this.operatorDefinitions = new Map();
this.setOptions(options);
this.initialize(options);
}
JssRuleEngine.prototype.setOptions = function (options) {
if (options) {
this.debug = options.debug ? options.debug : false;
this.sitecoreContext = options.sitecoreContext;
this.requestContext = options.requestContext;
this.mockDate = options.mockDate;
}
if (typeof (window) !== "undefined" && window && !this.requestContext) {
if (!this.requestContext) {
this.requestContext = {
url: window.location.href
};
}
}
this.setRequestContext(this.requestContext);
};
JssRuleEngine.prototype.initialize = function (_options) {
(0, initializeRules_1.default)(this);
(0, initializeCommands_1.default)(this);
(0, initializeOperators_1.default)(this);
};
JssRuleEngine.prototype.registerAction = function (id, command) {
this.commandDefinitions.set(id, command);
};
JssRuleEngine.prototype.registerCondition = function (id, rule) {
this.ruleDefinitions.set(id, rule);
};
JssRuleEngine.prototype.registerOperator = function (id, operator) {
this.operatorDefinitions.set(id, operator);
};
JssRuleEngine.prototype.parseRuleXml = function (ruleXml, ruleEngineContext) {
var parsedRule = (0, ruleParser_1.default)(ruleXml, ruleEngineContext);
return parsedRule;
};
JssRuleEngine.prototype.setSitecoreContext = function (sitecoreContext) {
this.sitecoreContext = sitecoreContext;
};
JssRuleEngine.prototype.setRequestContext = function (requestContext) {
var _a;
this.requestContext = requestContext;
if (this.requestContext &&
this.requestContext.url) {
console.log('Setting up request context', (_a = this.requestContext) === null || _a === void 0 ? void 0 : _a.url);
var queryString = this.requestContext.url.indexOf('?') >= 0 ? this.requestContext.url.split('?')[1] : '';
console.log('Query string ', queryString);
this.requestContext.queryString = queryString;
var urlParams = new URLSearchParams(queryString);
console.log('Url params', urlParams === null || urlParams === void 0 ? void 0 : urlParams.size);
this.requestContext.urlParams = urlParams;
this.requestContext.cookies = requestContext === null || requestContext === void 0 ? void 0 : requestContext.cookies;
}
};
JssRuleEngine.prototype.setMockDate = function (dateObj) {
this.mockDate = dateObj;
};
JssRuleEngine.prototype.getRuleEngineContext = function () {
var dateObj = {
now: this.mockDate ? this.mockDate : new Date()
};
return {
//location: typeof(window) !== "undefined" && window ? window.location : null,
//cookies: typeof(document) !== "undefined" && document ? document.cookie : null,
sitecoreContext: this.sitecoreContext,
requestContext: this.requestContext,
dateTime: dateObj,
sessionContext: new ruleEngineSessionContext_1.RuleEngineSessionContext(),
//env: process.env,
ruleEngine: this,
clientCommands: []
};
};
JssRuleEngine.prototype.runRule = function (parsedRule, ruleEngineContext) {
return __awaiter(this, void 0, void 0, function () {
var result;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, ruleEngineRunner_1.default)(parsedRule, ruleEngineContext)];
case 1:
result = _a.sent();
return [2 /*return*/, result];
}
});
});
};
JssRuleEngine.prototype.runRuleActions = function (parsedRule, ruleActions, ruleEngineContext) {
var _a;
return __awaiter(this, void 0, void 0, function () {
var rules, i, rule;
var _this = this;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
console.log('#### runRuleActions ### ', (_a = parsedRule === null || parsedRule === void 0 ? void 0 : parsedRule.rules) === null || _a === void 0 ? void 0 : _a.length, ruleActions.length);
if (!(parsedRule === null || parsedRule === void 0 ? void 0 : parsedRule.rules) || parsedRule.rules.length != ruleActions.length) {
console.warn("Parsed rules and provided rule actions array lengths doesn't match");
console.log('$$$$$', parsedRule, ruleActions);
console.log('#######');
return [2 /*return*/];
}
if (parsedRule.rules.length == 0) {
console.log('Empty rules array');
}
rules = parsedRule.rules;
i = 0;
_b.label = 1;
case 1:
if (!(i < rules.length)) return [3 /*break*/, 4];
rule = rules[i];
if (!(ruleActions[i] && rule.actions)) return [3 /*break*/, 3];
console.log('Running rule actions for rule ', i);
return [4 /*yield*/, Promise.all(rule.actions.map(function (ruleAction) { return __awaiter(_this, void 0, void 0, function () {
var actionFunction;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
console.log('Running rule action', ruleAction.id);
actionFunction = (_a = ruleEngineContext.ruleEngine) === null || _a === void 0 ? void 0 : _a.commandDefinitions.get(ruleAction.id);
if (typeof (actionFunction) === "undefined" || !ruleAction) {
throw new Error('Rule definitions missing for id ' + ruleAction.id);
}
console.log('Running action function');
return [4 /*yield*/, actionFunction(ruleAction, ruleEngineContext)];
case 1:
_b.sent();
return [2 /*return*/];
}
});
}); }))];
case 2:
_b.sent();
_b.label = 3;
case 3:
i++;
return [3 /*break*/, 1];
case 4:
console.log('#### runRuleActions end');
return [2 /*return*/];
}
});
});
};
JssRuleEngine.prototype.prefetchItems = function (_ruleEngineContext) {
//ruleEngineContext.prefetchKeys = uniq(ruleEngineContext.prefetchKeys);
//TODO: Retrieve items for the rule here
};
JssRuleEngine.prototype.parseAndRunRule = function (ruleXml, context) {
var _a;
return __awaiter(this, void 0, void 0, function () {
var ruleEngineContext, parsedRule, ruleResult;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
ruleEngineContext = context ? context : this.getRuleEngineContext();
this.debugMessage('Context vars: ', (_a = ruleEngineContext.sessionContext) === null || _a === void 0 ? void 0 : _a.keys());
parsedRule = this.parseRuleXml(ruleXml, ruleEngineContext);
this.prefetchItems(ruleEngineContext);
return [4 /*yield*/, this.runRule(parsedRule, ruleEngineContext)];
case 1:
ruleResult = _b.sent();
return [2 /*return*/, ruleResult];
}
});
});
};
JssRuleEngine.prototype.debugMessage = function () {
var _args = [];
for (var _i = 0; _i < arguments.length; _i++) {
_args[_i] = arguments[_i];
}
if (this.debug && typeof (console) !== 'undefined') {
console.log.apply(console, _args);
}
};
return JssRuleEngine;
}());
exports.JssRuleEngine = JssRuleEngine;
//# sourceMappingURL=ruleEngine.js.map