onroute-policy-engine 2.28.0 → 2.29.0

package/dist/enum/index.d.ts

@@ -6,6 +6,7 @@ export { OverloadCalculationDetailKind } from './overload-calculation-detail-kin
 export { PolicyCheckResultType, PolicyCheckId } from './policy-check';
 export { RelativePosition } from './relative-position';
 export { ValidationResultCode } from './validation-result-code';
+export { ValidationResultId } from './validation-result-id';
 export { ValidationResultType } from './validation-result-type';
 export { VehicleCategory } from './vehicle-category';
 export { VehicleTypes } from './vehicle-types';

package/dist/enum/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VehicleTypes = exports.VehicleCategory = exports.ValidationResultType = exports.ValidationResultCode = exports.RelativePosition = exports.PolicyCheckId = exports.PolicyCheckResultType = exports.OverloadCalculationDetailKind = exports.PermitAppInfo = exports.CostFacts = exports.PolicyFacts = exports.CustomOperator = exports.AccessoryVehicleType = void 0;
+exports.VehicleTypes = exports.VehicleCategory = exports.ValidationResultType = exports.ValidationResultId = exports.ValidationResultCode = exports.RelativePosition = exports.PolicyCheckId = exports.PolicyCheckResultType = exports.OverloadCalculationDetailKind = exports.PermitAppInfo = exports.CostFacts = exports.PolicyFacts = exports.CustomOperator = exports.AccessoryVehicleType = void 0;
 var accessory_vehicle_type_1 = require("./accessory-vehicle-type");
 Object.defineProperty(exports, "AccessoryVehicleType", { enumerable: true, get: function () { return accessory_vehicle_type_1.AccessoryVehicleType; } });
 var custom_operator_1 = require("./custom-operator");
@@ -19,6 +19,8 @@ var relative_position_1 = require("./relative-position");
 Object.defineProperty(exports, "RelativePosition", { enumerable: true, get: function () { return relative_position_1.RelativePosition; } });
 var validation_result_code_1 = require("./validation-result-code");
 Object.defineProperty(exports, "ValidationResultCode", { enumerable: true, get: function () { return validation_result_code_1.ValidationResultCode; } });
+var validation_result_id_1 = require("./validation-result-id");
+Object.defineProperty(exports, "ValidationResultId", { enumerable: true, get: function () { return validation_result_id_1.ValidationResultId; } });
 var validation_result_type_1 = require("./validation-result-type");
 Object.defineProperty(exports, "ValidationResultType", { enumerable: true, get: function () { return validation_result_type_1.ValidationResultType; } });
 var vehicle_category_1 = require("./vehicle-category");

package/dist/enum/validation-result-id.d.ts

@@ -0,0 +1,4 @@
+/** Identifies validation results that require specific consumer processing. */
+export declare enum ValidationResultId {
+    AxleWeightSpacing = "axle-weight-spacing"
+}

package/dist/enum/validation-result-id.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationResultId = void 0;
+/** Identifies validation results that require specific consumer processing. */
+var ValidationResultId;
+(function (ValidationResultId) {
+    ValidationResultId["AxleWeightSpacing"] = "axle-weight-spacing";
+})(ValidationResultId || (exports.ValidationResultId = ValidationResultId = {}));

package/dist/helper/rules-engine.helper.d.ts

@@ -1,5 +1,17 @@
-import { Engine } from 'json-rules-engine';
+import { Engine, EngineResult, Event } from 'json-rules-engine';
 import { Policy } from 'onroute-policy-engine';
+/** This returns the "Event", eg the axleCalcViolations event, in the _current-config.json. Helps
+ * identify an object like this from the JSON and return it for in-memory modification
+ *
+ *  This is the structure of the object we retrieve with this function
+ *   "conditions": {
+ *         "not": {
+ *         "fact": "axleCalcViolations",
+ *         "operator": "isEmptyArray",
+ *         "value": true
+ *       }
+ */
+export declare function getSuccessfulEventByFact(engineResult: EngineResult, fact: string): Event | undefined;
 /**
  * Creates a json-rules-engine Engine object for each permit type specified in
  * the policy definition, added to a Map. All rules specific to each permit type

package/dist/helper/rules-engine.helper.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSuccessfulEventByFact = getSuccessfulEventByFact;
 exports.getRulesEngines = getRulesEngines;
 const json_rules_engine_1 = require("json-rules-engine");
 const custom_operators_1 = require("../rule-operator/custom-operators");
@@ -19,6 +20,23 @@ function getEngine(policyDefinition) {
     policyDefinition.commonRules.forEach((r) => engine.addRule(r));
     return engine;
 }
+/** This returns the "Event", eg the axleCalcViolations event, in the _current-config.json. Helps
+ * identify an object like this from the JSON and return it for in-memory modification
+ *
+ *  This is the structure of the object we retrieve with this function
+ *   "conditions": {
+ *         "not": {
+ *         "fact": "axleCalcViolations",
+ *         "operator": "isEmptyArray",
+ *         "value": true
+ *       }
+ */
+function getSuccessfulEventByFact(engineResult, fact) {
+    var _a;
+    return (_a = engineResult.results.find(({ conditions }) => 'not' in conditions &&
+        'fact' in conditions.not &&
+        conditions.not.fact === fact)) === null || _a === void 0 ? void 0 : _a.event;
+}
 /**
  * Creates a json-rules-engine Engine object for each permit type specified in
  * the policy definition, added to a Map. All rules specific to each permit type

package/dist/policy-engine.js

@@ -78,6 +78,10 @@ class Policy {
             (0, facts_helper_1.addRuntimeFacts)(engine, this);
             // Run the json-rules-engine against the permit facts
             const engineResult = await engine.run(permit);
+            const axleCalculationEvent = (0, rules_engine_helper_1.getSuccessfulEventByFact)(engineResult, enum_1.PolicyFacts.AxleCalcViolations);
+            if (axleCalculationEvent === null || axleCalculationEvent === void 0 ? void 0 : axleCalculationEvent.params) {
+                axleCalculationEvent.params.id = enum_1.ValidationResultId.AxleWeightSpacing;
+            }
             // Wrap the json-rules-engine result in a ValidationResult object
             const validationResults = new validation_results_1.ValidationResults(engineResult);
             const shouldIncludeAxleCalculationResults = permit.permitType === 'STOW' &&

package/dist/validation-result.d.ts

@@ -15,6 +15,8 @@ export declare class ValidationResult {
     type: string;
     code: string;
     message: string;
+    /** Stable identifier for validation classes requiring specific processing. */
+    id?: string;
     fieldReference?: string;
     cost?: number;
     details?: Array<string>;

package/dist/validation-results.js

@@ -36,15 +36,16 @@ class ValidationResults {
         this.cost = [];
         if (engineResult) {
             engineResult.events.forEach((e) => {
-                var _a, _b, _c, _d, _e;
-                var _f, _g, _h;
-                const message = (_f = (_a = e.params) === null || _a === void 0 ? void 0 : _a.message) !== null && _f !== void 0 ? _f : `Unknown message: params=${JSON.stringify(e.params)}`;
-                const code = (_g = (_b = e.params) === null || _b === void 0 ? void 0 : _b.code) !== null && _g !== void 0 ? _g : validation_result_code_1.ValidationResultCode.GeneralResult;
-                const type = (_h = e.type) !== null && _h !== void 0 ? _h : validation_result_type_1.ValidationResultType.Violation.toString();
+                var _a, _b, _c, _d, _e, _f;
+                var _g, _h, _j;
+                const message = (_g = (_a = e.params) === null || _a === void 0 ? void 0 : _a.message) !== null && _g !== void 0 ? _g : `Unknown message: params=${JSON.stringify(e.params)}`;
+                const code = (_h = (_b = e.params) === null || _b === void 0 ? void 0 : _b.code) !== null && _h !== void 0 ? _h : validation_result_code_1.ValidationResultCode.GeneralResult;
+                const type = (_j = e.type) !== null && _j !== void 0 ? _j : validation_result_type_1.ValidationResultType.Violation.toString();
                 const result = new validation_result_1.ValidationResult(type, code, message);
-                result.fieldReference = (_c = e.params) === null || _c === void 0 ? void 0 : _c.fieldReference;
-                result.cost = (_d = e.params) === null || _d === void 0 ? void 0 : _d.cost;
-                result.details = (_e = e.params) === null || _e === void 0 ? void 0 : _e.details;
+                result.id = (_c = e.params) === null || _c === void 0 ? void 0 : _c.id;
+                result.fieldReference = (_d = e.params) === null || _d === void 0 ? void 0 : _d.fieldReference;
+                result.cost = (_e = e.params) === null || _e === void 0 ? void 0 : _e.cost;
+                result.details = (_f = e.params) === null || _f === void 0 ? void 0 : _f.details;
                 switch (type) {
                     case validation_result_type_1.ValidationResultType.Violation:
                         this.violations.push(result);

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "v2.28.0";
+export declare const version = "v2.29.0";

package/dist/version.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // Generated by genversion.
-exports.version = 'v2.28.0';
+exports.version = 'v2.29.0';

package/package.json

@@ -91,5 +91,5 @@
     ],
     "testEnvironment": "node"
   },
-  "version": "v2.28.0"
+  "version": "v2.29.0"
 }