onroute-policy-engine 2.20.2 → 2.22.0

package/dist/constants/stgvwi.d.ts

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,9 @@
+"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 = '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,5 +17,6 @@ export declare enum CostFacts {
     CostPerKilometre = "costPerKilometre",
     CostPerMonth = "costPerMonth",
     FixedCost = "fixedCost",
+    OverloadCost = "overloadCost",
     RangeMatrixCostLookup = "rangeMatrixCostLookup"
 }

package/dist/enum/facts.js

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

package/dist/helper/facts.helper.js

@@ -8,8 +8,8 @@ const dayjs_1 = __importDefault(require("dayjs"));
 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");
 dayjs_1.default.extend(quarterOfYear_1.default);
-const AXLE_CALC_RESULTS_FACT = 'axleCalcResults';
 const getAxleCalculationInputs = async (policy, almanac) => {
     var _a, _b;
     const vehicleDetails = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, enum_1.PermitAppInfo.VehicleDetails);
@@ -66,7 +66,9 @@ function addRuntimeFacts(engine, policy) {
     engine.addFact(enum_1.PolicyFacts.EndOfPermitYear, async function (params, almanac) {
         const startDate = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, enum_1.PermitAppInfo.PermitStartDate);
         const dateFrom = (0, dayjs_1.default)(startDate, enum_1.PermitAppInfo.PermitDateFormat);
-        const endOfYear = dateFrom.endOf('year').format(enum_1.PermitAppInfo.PermitDateFormat);
+        const endOfYear = dateFrom
+            .endOf('year')
+            .format(enum_1.PermitAppInfo.PermitDateFormat);
         return endOfYear;
     });
     /**
@@ -162,7 +164,7 @@ function addRuntimeFacts(engine, policy) {
      * Add runtime fact to return the complete runAxleCalculation result. This
      * is the structured ASW validation detail exposed by validate().
      */
-    engine.addFact(AXLE_CALC_RESULTS_FACT, async function (params, almanac) {
+    engine.addFact(stgvwi_1.AXLE_CALC_RESULTS_FACT, async function (params, almanac) {
         const { vehicleConfiguration, axleConfiguration, licensedGVW } = await getAxleCalculationInputs(policy, almanac);
         return policy.runAxleCalculation(vehicleConfiguration, axleConfiguration, licensedGVW);
     });
@@ -172,7 +174,7 @@ function addRuntimeFacts(engine, policy) {
      * axleCalcResults carries the structured ASW detail.
      */
     engine.addFact(enum_1.PolicyFacts.AxleCalcViolations, async function (params, almanac) {
-        const results = await almanac.factValue(AXLE_CALC_RESULTS_FACT);
+        const results = await almanac.factValue(stgvwi_1.AXLE_CALC_RESULTS_FACT);
         const violations = results.results.filter((r) => r.result === enum_1.PolicyCheckResultType.Fail);
         return violations.map((v) => v.message);
     });
@@ -302,4 +304,67 @@ function addRuntimeFacts(engine, policy) {
         }
         return cost;
     });
+    /**
+     * 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) {
+        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);
+        const overloadKg = actualGVW - licensedGVW;
+        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;
+        }
+        // Round to the nearest dollar (0.50 rounds up)
+        return Math.round(totalFee);
+    });
 }

package/dist/types/permit-application.d.ts

@@ -100,6 +100,15 @@ export type ICBCInsuranceCertificate = {
     /** Certificate number */
     certificateNumber?: string | null;
 };
+/**
+ * Extraordinary Load Request information for STOW permit applications
+ */
+export type ExtraordinaryLoadRequest = {
+    /** Whether or not an extraordinary load request is to be applied to the permit */
+    isExtraordinaryLoadRequest: boolean;
+    /** Approval number */
+    approvalNumber?: string | null;
+};
 /**
  * Complete permit data including all application details
  */
@@ -140,6 +149,8 @@ export type PermitData = {
     conditionalLicensingFee?: string | null;
     /** ICBC insurance certificate information (optional) */
     icbcInsuranceCertificate?: ICBCInsuranceCertificate | null;
+    /** Extraordinary load request information for STOW permit (optional) */
+    extraordinaryLoadRequest?: ExtraordinaryLoadRequest | null;
 };
 /**
  * Selected commodity for the permit with load description

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "v2.20.2";
+export declare const version = "v2.22.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.20.2';
+exports.version = 'v2.22.0';

package/package.json

@@ -91,5 +91,5 @@
     ],
     "testEnvironment": "node"
   },
-  "version": "v2.20.2"
+  "version": "v2.22.0"
 }