onroute-policy-engine 0.5.0 → 0.7.0

package/.github/workflows/analysis.yml

@@ -63,6 +63,6 @@ jobs:
     if: always()
     runs-on: ubuntu-22.04
     steps:
-      - if: contains(needs.*.result, 'failure')
+      - if: contains(needs.*.result, 'failure')||contains(needs.*.result, 'canceled')
         run: echo "At least one job has failed." && exit 1
       - run: echo "Success!"

package/dist/enum/facts.d.ts

@@ -1,11 +1,14 @@
 export declare enum PolicyFacts {
     AllowedVehicles = "allowedVehicles",
-    ConditionalFixedCost = "conditionalFixedCost",
     DaysInPermitYear = "daysInPermitYear",
     EndOfPermitQuarter = "endOfPermitQuarter",
     ValidationDate = "validationDate",
+    ConfigurationIsValid = "configurationIsValid"
+}
+export declare enum CostFacts {
+    ConditionalFixedCost = "conditionalFixedCost",
     FixedCost = "fixedCost",
     CostPerMonth = "costPerMonth",
-    RangeMatrixCostLookup = "rangeMatrixCostLookup",
-    ConfigurationIsValid = "configurationIsValid"
+    CostPerKilometre = "costPerKilometre",
+    RangeMatrixCostLookup = "rangeMatrixCostLookup"
 }

package/dist/enum/facts.js

@@ -1,15 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PolicyFacts = void 0;
+exports.CostFacts = exports.PolicyFacts = void 0;
 var PolicyFacts;
 (function (PolicyFacts) {
     PolicyFacts["AllowedVehicles"] = "allowedVehicles";
-    PolicyFacts["ConditionalFixedCost"] = "conditionalFixedCost";
     PolicyFacts["DaysInPermitYear"] = "daysInPermitYear";
     PolicyFacts["EndOfPermitQuarter"] = "endOfPermitQuarter";
     PolicyFacts["ValidationDate"] = "validationDate";
-    PolicyFacts["FixedCost"] = "fixedCost";
-    PolicyFacts["CostPerMonth"] = "costPerMonth";
-    PolicyFacts["RangeMatrixCostLookup"] = "rangeMatrixCostLookup";
     PolicyFacts["ConfigurationIsValid"] = "configurationIsValid";
 })(PolicyFacts || (exports.PolicyFacts = PolicyFacts = {}));
+var CostFacts;
+(function (CostFacts) {
+    CostFacts["ConditionalFixedCost"] = "conditionalFixedCost";
+    CostFacts["FixedCost"] = "fixedCost";
+    CostFacts["CostPerMonth"] = "costPerMonth";
+    CostFacts["CostPerKilometre"] = "costPerKilometre";
+    CostFacts["RangeMatrixCostLookup"] = "rangeMatrixCostLookup";
+})(CostFacts || (exports.CostFacts = CostFacts = {}));

package/dist/enum/index.d.ts

@@ -1,5 +1,5 @@
 export { AccessoryVehicleType } from './accessory-vehicle-type';
-export { PolicyFacts } from './facts';
+export { PolicyFacts, CostFacts } from './facts';
 export { PermitAppInfo } from './permit-app-info';
 export { RelativePosition } from './relative-position';
 export { ValidationResultCode } from './validation-result-code';

package/dist/enum/index.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VehicleTypes = exports.ValidationResultType = exports.ValidationResultCode = exports.RelativePosition = exports.PermitAppInfo = exports.PolicyFacts = exports.AccessoryVehicleType = void 0;
+exports.VehicleTypes = exports.ValidationResultType = exports.ValidationResultCode = exports.RelativePosition = exports.PermitAppInfo = exports.CostFacts = exports.PolicyFacts = 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 facts_1 = require("./facts");
 Object.defineProperty(exports, "PolicyFacts", { enumerable: true, get: function () { return facts_1.PolicyFacts; } });
+Object.defineProperty(exports, "CostFacts", { enumerable: true, get: function () { return facts_1.CostFacts; } });
 var permit_app_info_1 = require("./permit-app-info");
 Object.defineProperty(exports, "PermitAppInfo", { enumerable: true, get: function () { return permit_app_info_1.PermitAppInfo; } });
 var relative_position_1 = require("./relative-position");

package/dist/enum/permit-app-info.d.ts

@@ -12,5 +12,6 @@ export declare enum PermitAppInfo {
     PermitDuration = "$.permitDuration",
     PowerUnitType = "$.vehicleDetails.vehicleSubType",
     TrailerList = "$.vehicleConfiguration.trailers",
-    Commodity = "$.permittedCommodity.commodityType"
+    Commodity = "$.permittedCommodity.commodityType",
+    TotalDistance = "$.permittedRoute.manualRoute.totalDistance"
 }

package/dist/enum/permit-app-info.js

@@ -17,4 +17,5 @@ var PermitAppInfo;
     PermitAppInfo["PowerUnitType"] = "$.vehicleDetails.vehicleSubType";
     PermitAppInfo["TrailerList"] = "$.vehicleConfiguration.trailers";
     PermitAppInfo["Commodity"] = "$.permittedCommodity.commodityType";
+    PermitAppInfo["TotalDistance"] = "$.permittedRoute.manualRoute.totalDistance";
 })(PermitAppInfo || (exports.PermitAppInfo = PermitAppInfo = {}));

package/dist/helper/facts.helper.js

@@ -65,7 +65,7 @@ function addRuntimeFacts(engine, policy) {
      * Add runtime fact for a fixed permit cost, the cost supplied
      * as a parameter.
      */
-    engine.addFact(enum_1.PolicyFacts.FixedCost.toString(), async function (params) {
+    engine.addFact(enum_1.CostFacts.FixedCost.toString(), async function (params) {
         return params.cost;
     });
     /**
@@ -73,7 +73,7 @@ function addRuntimeFacts(engine, policy) {
      * cost rule applied only when the fact and value supplied as parameters
      * match.
      */
-    engine.addFact(enum_1.PolicyFacts.ConditionalFixedCost.toString(), async function (params, almanac) {
+    engine.addFact(enum_1.CostFacts.ConditionalFixedCost.toString(), async function (params, almanac) {
         const conditionValue = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, params.fact);
         if (conditionValue && conditionValue === params.value) {
             return params.cost;
@@ -87,7 +87,7 @@ function addRuntimeFacts(engine, policy) {
      * policy as a 30 day period or portion thereof, except in the
      * case of a full year in which case it is 12 months.
      */
-    engine.addFact(enum_1.PolicyFacts.CostPerMonth.toString(), async function (params, almanac) {
+    engine.addFact(enum_1.CostFacts.CostPerMonth.toString(), async function (params, almanac) {
         const duration = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, enum_1.PermitAppInfo.PermitDuration);
         const daysInPermitYear = await almanac.factValue(enum_1.PolicyFacts.DaysInPermitYear.toString());
         let months = Math.floor(duration / 30);
@@ -101,4 +101,74 @@ function addRuntimeFacts(engine, policy) {
         }
         return months * params.cost;
     });
+    /**
+     * Add runtime fact for cost per kilometre driven in the applicant's
+     * permitted route. Accepts an optional parameter minValue which
+     * specifies the minimum value for the permit if the kilometre cost
+     * is less than that value.
+     */
+    engine.addFact(enum_1.CostFacts.CostPerKilometre.toString(), async function (params, almanac) {
+        const distance = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, enum_1.PermitAppInfo.TotalDistance);
+        let cost = distance * params.cost;
+        if (typeof params.minValue === 'number') {
+            cost = Math.max(cost, params.minValue);
+        }
+        return cost;
+    });
+    /**
+     * Add runtime fact to look up the permit cost from a matrix of
+     * value ranges configured in policy json. This is most commonly
+     * used for a permit cost that is based on the vehicle weight.
+     */
+    engine.addFact(enum_1.CostFacts.RangeMatrixCostLookup.toString(), async function (params, almanac) {
+        var _a, _b;
+        // Get the parameter from the permit application whose
+        // value will be used to select the correct range matrix key
+        const rangeLookupKey = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, params.rangeLookupKey);
+        // Initialize cost to zero, if we are unable to find
+        // a matching value or matrix for whatever reason, the
+        // cost will default to zero (no matrix applicable)
+        let cost = 0;
+        // Get the ID of the matrix to look up
+        const matrixRef = (_a = params.matrixMap) === null || _a === void 0 ? void 0 : _a.find((r) => r.key === rangeLookupKey);
+        if (matrixRef) {
+            // If a matrix ID was returned, retrieve the matrix from the
+            // policy configuration that we need to use for cost lookup
+            // (for example, the 'annualFeeIndustrial' matrix)
+            const matrix = (_b = policy.policyDefinition.rangeMatrices) === null || _b === void 0 ? void 0 : _b.find((m) => m.id === matrixRef.value);
+            if (matrix) {
+                // if the matrix exists in policy configuration
+                // Retrieve the numeric value for the matrix lookup
+                // (for example, may be loaded GVW)
+                const matrixFactValue = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, params.matrixFactValue);
+                // Look up the correct entry in the matrix, where the lookup
+                // value falls within the min/max range
+                const matrixMatch = matrix.matrix.find((m) => {
+                    let min = m.min;
+                    if (typeof min !== 'number') {
+                        min = Number.MIN_SAFE_INTEGER;
+                    }
+                    let max = m.max;
+                    if (typeof max !== 'number') {
+                        max = Number.MAX_SAFE_INTEGER;
+                    }
+                    return matrixFactValue >= min && matrixFactValue <= max;
+                });
+                if (matrixMatch) {
+                    // If we got a hit from the matrix
+                    cost = matrixMatch.value;
+                    // If the cost rule includes a divisor, apply it here. A divisor
+                    // may be used if, for example, the value from the lookup matrix
+                    // is an annual fee but the permit is just a month or quarter.
+                    if (typeof params.divisor === 'number' && params.divisor > 0) {
+                        cost = Math.round(cost / params.divisor);
+                    }
+                }
+            }
+            else {
+                console.log(`No range matrix with id ${matrixRef} found in the policy configuration`);
+            }
+        }
+        return cost;
+    });
 }

package/package.json

@@ -86,5 +86,5 @@
     ],
     "testEnvironment": "node"
   },
-  "version": "v0.5.0"
+  "version": "v0.7.0"
 }