onroute-policy-engine 2.23.0 → 2.24.0

package/dist/constants/cost.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This is the default description used for each cost object,
+ * when there is no explicit description provided (eg. Non-STWSE permit costs).
+ *
+ * NOTE: DO NOT change the value of this constant, as the value is being used elsewhere
+ * throughout the backend.
+ */
+export declare const DEFAULT_COST_DESCRIPTION = "Calculated permit cost";

package/dist/constants/cost.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_COST_DESCRIPTION = void 0;
+/**
+ * This is the default description used for each cost object,
+ * when there is no explicit description provided (eg. Non-STWSE permit costs).
+ *
+ * NOTE: DO NOT change the value of this constant, as the value is being used elsewhere
+ * throughout the backend.
+ */
+exports.DEFAULT_COST_DESCRIPTION = 'Calculated permit cost';

package/dist/constants/overload.d.ts

@@ -0,0 +1,9 @@
+export declare const BASE_OVERLOAD_LIMIT = 28000;
+export declare const EXTRA_WEIGHT_INTERVAL = 900;
+export declare const EXTRA_RATE_INCREMENT = 1.85;
+export declare const DEFAULT_MAX_RATE = 21.4;
+export declare const MINIMUM_OVERLOAD_FEE = 25;
+export declare const OVERLOAD_RATES_PER_10KM: {
+    max: number;
+    rate: number;
+}[];

package/dist/constants/overload.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OVERLOAD_RATES_PER_10KM = exports.MINIMUM_OVERLOAD_FEE = exports.DEFAULT_MAX_RATE = exports.EXTRA_RATE_INCREMENT = exports.EXTRA_WEIGHT_INTERVAL = exports.BASE_OVERLOAD_LIMIT = void 0;
+exports.BASE_OVERLOAD_LIMIT = 28000;
+exports.EXTRA_WEIGHT_INTERVAL = 900;
+exports.EXTRA_RATE_INCREMENT = 1.85;
+exports.DEFAULT_MAX_RATE = 21.4;
+exports.MINIMUM_OVERLOAD_FEE = 25;
+// Overload permit fee rate table mapping up to 28,000 kg
+exports.OVERLOAD_RATES_PER_10KM = [
+    { max: 2000, rate: 0.95 },
+    { max: 3000, rate: 1.15 },
+    { max: 4000, rate: 1.4 },
+    { max: 5000, rate: 1.6 },
+    { max: 6000, rate: 1.85 },
+    { max: 7000, rate: 2.15 },
+    { max: 8000, rate: 2.45 },
+    { max: 9000, rate: 2.95 },
+    { max: 10000, rate: 3.35 },
+    { max: 11000, rate: 3.75 },
+    { max: 12000, rate: 4.25 },
+    { max: 13000, rate: 4.95 },
+    { max: 14000, rate: 5.6 },
+    { max: 15000, rate: 6.25 },
+    { max: 16000, rate: 7.25 },
+    { max: 17000, rate: 8.25 },
+    { max: 18000, rate: 9.15 },
+    { max: 19000, rate: 10.1 },
+    { max: 20000, rate: 10.9 },
+    { max: 21000, rate: 11.85 },
+    { max: 22000, rate: 12.7 },
+    { max: 23000, rate: 13.95 },
+    { max: 24000, rate: 14.95 },
+    { max: 25000, rate: 16.1 },
+    { max: 26000, rate: 17.85 },
+    { max: 27000, rate: 19.85 },
+    { max: 28000, rate: 21.4 },
+];

package/dist/constants/stgvwi.d.ts

@@ -1,6 +1 @@
 export declare const AXLE_CALC_RESULTS_FACT = "axleCalcResults";
-export declare const BASE_OVERLOAD_LIMIT = 28000;
-export declare const EXTRA_WEIGHT_INTERVAL = 900;
-export declare const EXTRA_RATE_INCREMENT = 1.85;
-export declare const DEFAULT_MAX_RATE = 21.4;
-export declare const MINIMUM_OVERLOAD_FEE = 25;

package/dist/constants/stgvwi.js

@@ -1,9 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MINIMUM_OVERLOAD_FEE = exports.DEFAULT_MAX_RATE = exports.EXTRA_RATE_INCREMENT = exports.EXTRA_WEIGHT_INTERVAL = exports.BASE_OVERLOAD_LIMIT = exports.AXLE_CALC_RESULTS_FACT = void 0;
+exports.AXLE_CALC_RESULTS_FACT = void 0;
 exports.AXLE_CALC_RESULTS_FACT = 'axleCalcResults';
-exports.BASE_OVERLOAD_LIMIT = 28000;
-exports.EXTRA_WEIGHT_INTERVAL = 900;
-exports.EXTRA_RATE_INCREMENT = 1.85;
-exports.DEFAULT_MAX_RATE = 21.4;
-exports.MINIMUM_OVERLOAD_FEE = 25;

package/dist/enum/facts.d.ts

@@ -17,6 +17,7 @@ export declare enum CostFacts {
     CostPerKilometre = "costPerKilometre",
     CostPerMonth = "costPerMonth",
     FixedCost = "fixedCost",
-    OverloadCost = "overloadCost",
+    OverloadGvwCost = "overloadGvwCost",
+    OverloadWeightCost = "overloadWeightCost",
     RangeMatrixCostLookup = "rangeMatrixCostLookup"
 }

package/dist/enum/facts.js

@@ -22,6 +22,7 @@ var CostFacts;
     CostFacts["CostPerKilometre"] = "costPerKilometre";
     CostFacts["CostPerMonth"] = "costPerMonth";
     CostFacts["FixedCost"] = "fixedCost";
-    CostFacts["OverloadCost"] = "overloadCost";
+    CostFacts["OverloadGvwCost"] = "overloadGvwCost";
+    CostFacts["OverloadWeightCost"] = "overloadWeightCost";
     CostFacts["RangeMatrixCostLookup"] = "rangeMatrixCostLookup";
 })(CostFacts || (exports.CostFacts = CostFacts = {}));

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

@@ -4,6 +4,7 @@ export declare enum ValidationResultCode {
     PolicyValidationError = "policy-validation-error",
     ConfigurationInvalid = "configuration-invalid",
     GeneralResult = "general-result",
+    DimensionOversize = "dimension-oversize",
     CostValue = "cost-value",
     IsLcvCarrier = "lcv-carrier",
     NoFeeClient = "no-fee-client"

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

@@ -8,6 +8,7 @@ var ValidationResultCode;
     ValidationResultCode["PolicyValidationError"] = "policy-validation-error";
     ValidationResultCode["ConfigurationInvalid"] = "configuration-invalid";
     ValidationResultCode["GeneralResult"] = "general-result";
+    ValidationResultCode["DimensionOversize"] = "dimension-oversize";
     ValidationResultCode["CostValue"] = "cost-value";
     ValidationResultCode["IsLcvCarrier"] = "lcv-carrier";
     ValidationResultCode["NoFeeClient"] = "no-fee-client";

package/dist/helper/facts.helper.js

@@ -9,6 +9,7 @@ const quarterOfYear_1 = __importDefault(require("dayjs/plugin/quarterOfYear"));
 const enum_1 = require("onroute-policy-engine/enum");
 const policy_check_helper_1 = require("./policy-check.helper");
 const stgvwi_1 = require("../constants/stgvwi");
+const overload_1 = require("../constants/overload");
 dayjs_1.default.extend(quarterOfYear_1.default);
 const getAxleCalculationInputs = async (policy, almanac) => {
     var _a, _b;
@@ -28,6 +29,28 @@ const getAxleCalculationInputs = async (policy, almanac) => {
         licensedGVW: vehicleDetails.licensedGVW || 0,
     };
 };
+const getOverloadCost = (overloadKg, totalDistance) => {
+    let ratePer10km = 0;
+    if (overloadKg <= overload_1.BASE_OVERLOAD_LIMIT) {
+        const match = overload_1.OVERLOAD_RATES_PER_10KM.find((r) => overloadKg <= r.max);
+        ratePer10km = match ? match.rate : overload_1.DEFAULT_MAX_RATE;
+    }
+    else {
+        // For overload greater than BASE_OVERLOAD_LIMIT kg
+        const extraWeight = overloadKg - overload_1.BASE_OVERLOAD_LIMIT;
+        const intervals = Math.ceil(extraWeight / overload_1.EXTRA_WEIGHT_INTERVAL);
+        ratePer10km = overload_1.DEFAULT_MAX_RATE + intervals * overload_1.EXTRA_RATE_INCREMENT;
+    }
+    // Fee calculation: rate * (totalDistance / 10)
+    const distanceUnits = Math.ceil(totalDistance / 10);
+    let totalFee = ratePer10km * distanceUnits;
+    // Apply minimum fee rule
+    if (totalFee < overload_1.MINIMUM_OVERLOAD_FEE) {
+        totalFee = overload_1.MINIMUM_OVERLOAD_FEE;
+    }
+    // Round to the nearest dollar (0.50 rounds up)
+    return Math.round(totalFee);
+};
 /**
  * Adds runtime facts for the validation. For example, adds the
  * validation date for comparison against startDate of the permit.
@@ -308,7 +331,7 @@ function addRuntimeFacts(engine, policy) {
      * Add runtime fact to calculate the overload fee for STGVWI permits
      * based on the Licensed GVW Increase and Total Distance.
      */
-    engine.addFact(enum_1.CostFacts.OverloadCost.toString(), async function (params, almanac) {
+    engine.addFact(enum_1.CostFacts.OverloadGvwCost.toString(), async function (params, almanac) {
         const actualGVW = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, 'vehicleConfiguration.actualGVW');
         const licensedGVW = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, 'vehicleDetails.licensedGVW');
         const distance = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, enum_1.PermitAppInfo.TotalDistance);
@@ -316,55 +339,18 @@ function addRuntimeFacts(engine, policy) {
         if (overloadKg <= 0 || !distance) {
             return 0;
         }
-        let ratePer10km = 0;
-        if (overloadKg <= stgvwi_1.BASE_OVERLOAD_LIMIT) {
-            // Overload permit fee rate table mapping up to 28,000 kg
-            const rates = [
-                { max: 2000, rate: 0.95 },
-                { max: 3000, rate: 1.15 },
-                { max: 4000, rate: 1.4 },
-                { max: 5000, rate: 1.6 },
-                { max: 6000, rate: 1.85 },
-                { max: 7000, rate: 2.15 },
-                { max: 8000, rate: 2.45 },
-                { max: 9000, rate: 2.95 },
-                { max: 10000, rate: 3.35 },
-                { max: 11000, rate: 3.75 },
-                { max: 12000, rate: 4.25 },
-                { max: 13000, rate: 4.95 },
-                { max: 14000, rate: 5.6 },
-                { max: 15000, rate: 6.25 },
-                { max: 16000, rate: 7.25 },
-                { max: 17000, rate: 8.25 },
-                { max: 18000, rate: 9.15 },
-                { max: 19000, rate: 10.1 },
-                { max: 20000, rate: 10.9 },
-                { max: 21000, rate: 11.85 },
-                { max: 22000, rate: 12.7 },
-                { max: 23000, rate: 13.95 },
-                { max: 24000, rate: 14.95 },
-                { max: 25000, rate: 16.1 },
-                { max: 26000, rate: 17.85 },
-                { max: 27000, rate: 19.85 },
-                { max: 28000, rate: 21.4 },
-            ];
-            const match = rates.find((r) => overloadKg <= r.max);
-            ratePer10km = match ? match.rate : stgvwi_1.DEFAULT_MAX_RATE;
-        }
-        else {
-            // For overload greater than BASE_OVERLOAD_LIMIT kg
-            const extraWeight = overloadKg - stgvwi_1.BASE_OVERLOAD_LIMIT;
-            const intervals = Math.ceil(extraWeight / stgvwi_1.EXTRA_WEIGHT_INTERVAL);
-            ratePer10km = stgvwi_1.DEFAULT_MAX_RATE + intervals * stgvwi_1.EXTRA_RATE_INCREMENT;
-        }
-        // Fee calculation: rate * (distance / 10)
-        const distanceUnits = Math.ceil(distance / 10);
-        let totalFee = ratePer10km * distanceUnits;
-        // Apply minimum fee rule
-        if (totalFee < stgvwi_1.MINIMUM_OVERLOAD_FEE) {
-            totalFee = stgvwi_1.MINIMUM_OVERLOAD_FEE;
+        return getOverloadCost(overloadKg, distance);
+    });
+    /**
+     * Add runtime fact to calculate the overload fee for STWSE permits
+     * based on the Weight over 27.5m and Total Distance.
+     */
+    engine.addFact(enum_1.CostFacts.OverloadWeightCost.toString(), async function (params, almanac) {
+        const overloadWeight = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, 'vehicleConfiguration.overloadWeight');
+        const totalDistance = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, enum_1.PermitAppInfo.TotalDistance);
+        if (overloadWeight <= 0 || !totalDistance) {
+            return 0;
         }
-        // Round to the nearest dollar (0.50 rounds up)
-        return Math.round(totalFee);
+        return getOverloadCost(overloadWeight, totalDistance);
     });
 }

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRulesEngines = getRulesEngines;
 const json_rules_engine_1 = require("json-rules-engine");
 const custom_operators_1 = require("../rule-operator/custom-operators");
+const cost_1 = require("../constants/cost");
 /**
  * Gets a json-rules-engine with all onRouteBC custom operators added,
  * and all policy rules that apply to all permit types added.
@@ -51,7 +52,7 @@ function getRulesEngines(policy) {
                 event: {
                     type: 'cost',
                     params: {
-                        message: 'Calculated permit cost',
+                        message: c.params.description || cost_1.DEFAULT_COST_DESCRIPTION,
                         code: 'cost-value',
                         cost: c,
                     },

package/dist/policy-engine.js

@@ -21,6 +21,7 @@ const dimensions_helper_1 = require("./helper/dimensions.helper");
 const dimensions_helper_2 = require("./helper/dimensions.helper");
 const display_code_helper_1 = require("./helper/display-code-helper");
 const policy_check_helper_1 = require("./helper/policy-check.helper");
+const cost_1 = require("./constants/cost");
 /** Class representing commercial vehicle policy. */
 class Policy {
     /**
@@ -92,11 +93,22 @@ class Policy {
             // has a no fee flag set.
             if ((_d = this.specialAuthorizations) === null || _d === void 0 ? void 0 : _d.noFeeType) {
                 const originalPermitCost = validationResults === null || validationResults === void 0 ? void 0 : validationResults.cost.reduce((accumulator, { cost }) => accumulator + (cost !== null && cost !== void 0 ? cost : 0), 0);
-                // Clear the cost array and replace with zero cost
-                validationResults.cost.length = 0;
-                const newPermitCostResult = new validation_result_1.ValidationResult(enum_1.ValidationResultType.Cost, enum_1.ValidationResultCode.CostValue, 'Calculated permit cost');
-                newPermitCostResult.cost = 0;
-                validationResults.cost.push(newPermitCostResult);
+                if (permit.permitType !== "STWSE") {
+                    // Clear the cost array and replace with zero cost
+                    validationResults.cost.length = 0;
+                    const newPermitCostResult = new validation_result_1.ValidationResult(enum_1.ValidationResultType.Cost, enum_1.ValidationResultCode.CostValue, cost_1.DEFAULT_COST_DESCRIPTION);
+                    newPermitCostResult.cost = 0;
+                    validationResults.cost.push(newPermitCostResult);
+                }
+                else {
+                    // If permit type is STWSE, keep each of the cost objects, but set their costs to zero
+                    const newPermitCosts = validationResults.cost.map(cost => {
+                        const newPermitCostResult = new validation_result_1.ValidationResult(enum_1.ValidationResultType.Cost, enum_1.ValidationResultCode.CostValue, cost.message);
+                        newPermitCostResult.cost = 0;
+                        return newPermitCostResult;
+                    });
+                    validationResults.cost = newPermitCosts;
+                }
                 // Add an informational message to the results
                 validationResults.information.push(new validation_result_1.ValidationResult(enum_1.ValidationResultType.Information, enum_1.ValidationResultCode.NoFeeClient, `Client '${this.specialAuthorizations.companyId}' has no fee flag, original permit cost would otherwise be '${originalPermitCost}'`));
             }

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "v2.23.0";
+export declare const version = "v2.24.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.23.0';
+exports.version = 'v2.24.0';

package/package.json

@@ -91,5 +91,5 @@
     ],
     "testEnvironment": "node"
   },
-  "version": "v2.23.0"
+  "version": "v2.24.0"
 }