onroute-policy-engine 2.5.2 → 2.7.0

package/dist/enum/policy-check.d.ts

@@ -3,6 +3,7 @@ export declare enum PolicyCheckResultType {
     Fail = "fail"
 }
 export declare enum PolicyCheckId {
+    BoosterAxleLimit = "booster-axle-limit",
     BridgeFormula = "bridge-formula",
     CheckPermittableWeight = "check-permittable-weight",
     MaxTireLoad = "max-tire-load",

package/dist/enum/policy-check.js

@@ -8,6 +8,7 @@ var PolicyCheckResultType;
 })(PolicyCheckResultType || (exports.PolicyCheckResultType = PolicyCheckResultType = {}));
 var PolicyCheckId;
 (function (PolicyCheckId) {
+    PolicyCheckId["BoosterAxleLimit"] = "booster-axle-limit";
     PolicyCheckId["BridgeFormula"] = "bridge-formula";
     PolicyCheckId["CheckPermittableWeight"] = "check-permittable-weight";
     PolicyCheckId["MaxTireLoad"] = "max-tire-load";

package/dist/helper/policy-check.helper.d.ts

@@ -222,6 +222,19 @@ export declare function CheckMinDriveAxleWeight(_policy: Policy, _vehicleConfigu
  * @see AxleConfiguration
  */
 export declare function CheckMaxTireLoad(_policy: Policy, _vehicleConfiguration: Array<string>, axleConfiguration: Array<AxleConfiguration>): Array<PolicyCheckResult>;
+/**
+ * Validates that each booster has no more axles than the trailer it follows.
+ *
+ * Vehicle configuration has one power unit entry, while axle configuration has
+ * separate steer and drive entries for the power unit. For vehicle entries after
+ * the power unit, the matching axle unit index is therefore vehicle index + 1.
+ *
+ * @param _policy - The policy instance (unused in this check, but required by PolicyCheck type)
+ * @param vehicleConfiguration - Array of vehicle type identifiers representing the vehicle configuration
+ * @param axleConfiguration - Array of axle configurations containing axle count information
+ * @returns Array of AxleGroupPolicyCheckResult objects, one for each booster tested
+ */
+export declare function CheckBoosterAxleLimit(_policy: Policy, vehicleConfiguration: Array<string>, axleConfiguration: Array<AxleConfiguration>): Array<PolicyCheckResult>;
 /**
  * Map of policy check functions keyed by their corresponding PolicyCheckId.
  *
@@ -238,6 +251,7 @@ export declare function CheckMaxTireLoad(_policy: Policy, _vehicleConfiguration:
  * - MinSteerAxleWeight: Validates minimum weight requirements for steer axles
  * - NumberOfAxles: Validates axle count per axle unit
  * - NumberOfWheelsPerAxle: Validates tire count per axle unit
+ * - BoosterAxleLimit: Validates booster axle count against the preceding trailer
  *
  * @see PolicyCheck
  * @see PolicyCheckId

package/dist/helper/policy-check.helper.js

@@ -8,6 +8,7 @@ exports.CheckPermittableWeight = CheckPermittableWeight;
 exports.CheckMinSteerAxleWeight = CheckMinSteerAxleWeight;
 exports.CheckMinDriveAxleWeight = CheckMinDriveAxleWeight;
 exports.CheckMaxTireLoad = CheckMaxTireLoad;
+exports.CheckBoosterAxleLimit = CheckBoosterAxleLimit;
 const enum_1 = require("../enum");
 /**
  * Validates the number of axles in each axle unit.
@@ -493,6 +494,62 @@ function CheckMaxTireLoad(_policy, _vehicleConfiguration, axleConfiguration) {
     }
     return policyCheckResults;
 }
+/**
+ * Validates that each booster has no more axles than the trailer it follows.
+ *
+ * Vehicle configuration has one power unit entry, while axle configuration has
+ * separate steer and drive entries for the power unit. For vehicle entries after
+ * the power unit, the matching axle unit index is therefore vehicle index + 1.
+ *
+ * @param _policy - The policy instance (unused in this check, but required by PolicyCheck type)
+ * @param vehicleConfiguration - Array of vehicle type identifiers representing the vehicle configuration
+ * @param axleConfiguration - Array of axle configurations containing axle count information
+ * @returns Array of AxleGroupPolicyCheckResult objects, one for each booster tested
+ */
+function CheckBoosterAxleLimit(_policy, vehicleConfiguration, axleConfiguration) {
+    const policyCheckResults = new Array();
+    const policyId = enum_1.PolicyCheckId.BoosterAxleLimit;
+    let trailerAxleConfigIndex;
+    vehicleConfiguration.forEach((vehicleSubType, vehicleIndex) => {
+        if (vehicleIndex === 0) {
+            return;
+        }
+        const axleConfigIndex = vehicleIndex + 1;
+        if (axleConfigIndex >= axleConfiguration.length) {
+            return;
+        }
+        if (vehicleSubType === enum_1.AccessoryVehicleType.Booster) {
+            if (trailerAxleConfigIndex === undefined) {
+                return;
+            }
+            const boosterAxleUnit = axleConfigIndex + 1;
+            const trailerAxleUnit = trailerAxleConfigIndex + 1;
+            const result = axleConfiguration[axleConfigIndex].numberOfAxles <=
+                axleConfiguration[trailerAxleConfigIndex].numberOfAxles;
+            policyCheckResults.push({
+                id: policyId,
+                result: result
+                    ? enum_1.PolicyCheckResultType.Pass
+                    : enum_1.PolicyCheckResultType.Fail,
+                message: result
+                    ? ''
+                    : `No. of Axles for Axle Unit ${boosterAxleUnit} must be less than or equal to No. of Axles for Axle Unit ${trailerAxleUnit}`,
+                startAxleUnit: trailerAxleUnit,
+                endAxleUnit: boosterAxleUnit,
+            });
+            return;
+        }
+        const vehicleDefinition = _policy.getTrailerDefinition(vehicleSubType);
+        // Trailer definitions mark additionalAxleSubType entries as category "pseudo"
+        // (for example PFMAXLE), so keep comparing boosters to the last real trailer.
+        // Basically, skip pseudo axle units when deciding which trailer the booster follows.
+        if (vehicleSubType !== enum_1.AccessoryVehicleType.Jeep &&
+            (vehicleDefinition === null || vehicleDefinition === void 0 ? void 0 : vehicleDefinition.category) !== enum_1.VehicleCategory.Pseudo) {
+            trailerAxleConfigIndex = axleConfigIndex;
+        }
+    });
+    return policyCheckResults;
+}
 /**
  * Map of policy check functions keyed by their corresponding PolicyCheckId.
  *
@@ -509,6 +566,7 @@ function CheckMaxTireLoad(_policy, _vehicleConfiguration, axleConfiguration) {
  * - MinSteerAxleWeight: Validates minimum weight requirements for steer axles
  * - NumberOfAxles: Validates axle count per axle unit
  * - NumberOfWheelsPerAxle: Validates tire count per axle unit
+ * - BoosterAxleLimit: Validates booster axle count against the preceding trailer
  *
  * @see PolicyCheck
  * @see PolicyCheckId
@@ -522,4 +580,5 @@ exports.policyCheckMap = new Map([
     [enum_1.PolicyCheckId.MinDriveAxleWeight, CheckMinDriveAxleWeight],
     [enum_1.PolicyCheckId.MinSteerAxleWeight, CheckMinSteerAxleWeight],
     [enum_1.PolicyCheckId.NumberOfWheelsPerAxle, CheckNumTiresPerAxle],
+    [enum_1.PolicyCheckId.BoosterAxleLimit, CheckBoosterAxleLimit],
 ]);

package/dist/helper/vehicles.helper.d.ts

@@ -1,4 +1,4 @@
-import { PermitVehicleDetails, VehicleConfiguration, VehicleTypes } from 'onroute-policy-engine/types';
+import { AxleConfiguration, IndexedAxleConfiguration, PermitVehicleDetails, VehicleConfiguration, VehicleInConfiguration, VehicleTypes } from 'onroute-policy-engine/types';
 /**
  * Filters out all LCV vehicles from a supplied list of vehicle IDs.
  * @param vehicleList List of vehicle IDs to filter
@@ -58,3 +58,20 @@ export declare function filterVehiclesByType(vehicleList: Array<string>, vehicle
  * // Returns: ['TRKTRAC', 'SEMITRL', 'BOOSTER']
  */
 export declare function getSimplifiedVehicleConfigurationHelper(vehicleDetails: PermitVehicleDetails, vehicleConfiguration: VehicleConfiguration): string[];
+/**
+ * Combines axle configurations from a power unit and its trailers into a single
+ * array, adding the vehicle index to each axle configuration.
+ *
+ * @param powerUnitAxleConfiguration - Axle configuration for the power unit
+ * @param trailers - Trailer configurations that may include axle configuration
+ * @returns Combined axle configurations in vehicle order, where vehicleIndex 0
+ *          represents the power unit and trailer indexes start at 1.
+ */
+export declare function combineAxleConfigurationsHelper(powerUnitAxleConfiguration: Array<AxleConfiguration>, trailers: Array<VehicleInConfiguration>): Array<IndexedAxleConfiguration>;
+/**
+ * Calculates the Gross Combined Vehicle Weight (GCVW) from axle unit weights.
+ *
+ * @param axleConfiguration - Axle configuration to total
+ * @returns Sum of axle unit weights, treating missing weights as 0.
+ */
+export declare function calculateGCVWHelper(axleConfiguration: Array<AxleConfiguration>): number;

package/dist/helper/vehicles.helper.js

@@ -3,6 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.filterOutLcv = filterOutLcv;
 exports.filterVehiclesByType = filterVehiclesByType;
 exports.getSimplifiedVehicleConfigurationHelper = getSimplifiedVehicleConfigurationHelper;
+exports.combineAxleConfigurationsHelper = combineAxleConfigurationsHelper;
+exports.calculateGCVWHelper = calculateGCVWHelper;
 const enum_1 = require("onroute-policy-engine/enum");
 /**
  * Filters out all LCV vehicles from a supplied list of vehicle IDs.
@@ -117,3 +119,33 @@ function getSimplifiedVehicleConfigurationHelper(vehicleDetails, vehicleConfigur
     }
     return fullVehicleConfiguration;
 }
+/**
+ * Combines axle configurations from a power unit and its trailers into a single
+ * array, adding the vehicle index to each axle configuration.
+ *
+ * @param powerUnitAxleConfiguration - Axle configuration for the power unit
+ * @param trailers - Trailer configurations that may include axle configuration
+ * @returns Combined axle configurations in vehicle order, where vehicleIndex 0
+ *          represents the power unit and trailer indexes start at 1.
+ */
+function combineAxleConfigurationsHelper(powerUnitAxleConfiguration, trailers) {
+    const powerUnitAxles = powerUnitAxleConfiguration.map((axle) => (Object.assign(Object.assign({}, axle), { vehicleIndex: 0 })));
+    const trailerAxles = trailers.flatMap((trailer, trailerIndex) => {
+        var _a;
+        return ((_a = trailer.axleConfiguration) !== null && _a !== void 0 ? _a : []).map((axle) => (Object.assign(Object.assign({}, axle), { vehicleIndex: trailerIndex + 1 })));
+    });
+    return [...powerUnitAxles, ...trailerAxles];
+}
+/**
+ * Calculates the Gross Combined Vehicle Weight (GCVW) from axle unit weights.
+ *
+ * @param axleConfiguration - Axle configuration to total
+ * @returns Sum of axle unit weights, treating missing weights as 0.
+ */
+function calculateGCVWHelper(axleConfiguration) {
+    return axleConfiguration.reduce((totalWeight, axleUnit) => {
+        var _a;
+        const axleUnitWeight = (_a = axleUnit.axleUnitWeight) !== null && _a !== void 0 ? _a : 0;
+        return totalWeight + axleUnitWeight;
+    }, 0);
+}

package/dist/policy-engine.d.ts

@@ -1,4 +1,4 @@
-import { PolicyDefinition, PermitType, Commodity, VehicleType, SizeDimension, AxleConfiguration, BridgeCalculationResult, ConditionForPermit, TrailerType, PowerUnitType, TrailerWeightDimension, PowerUnitWeightDimension, WeightDimension, SingleAxleDimension, StandardTireSize, TrailerDimensions, AxleCalcResults, PermitVehicleDetails, VehicleConfiguration } from 'onroute-policy-engine/types';
+import { PolicyDefinition, PermitType, Commodity, VehicleType, SizeDimension, AxleConfiguration, IndexedAxleConfiguration, BridgeCalculationResult, ConditionForPermit, TrailerType, PowerUnitType, TrailerWeightDimension, PowerUnitWeightDimension, WeightDimension, SingleAxleDimension, StandardTireSize, TrailerDimensions, AxleCalcResults, PermitVehicleDetails, VehicleConfiguration, VehicleInConfiguration } from 'onroute-policy-engine/types';
 import { Engine } from 'json-rules-engine';
 import { ValidationResults } from './validation-results';
 import { SpecialAuthorizations } from './types/special-authorizations';
@@ -341,6 +341,23 @@ export declare class Policy {
      * // Returns: ['TRKTRAC']
      */
     getSimplifiedVehicleConfiguration(vehicleDetails: PermitVehicleDetails, vehicleConfiguration: VehicleConfiguration): string[];
+    /**
+     * Combines axle configurations from a power unit and its trailers into a
+     * single axle configuration array, adding a vehicle index to each axle unit.
+     *
+     * @param powerUnitAxleConfiguration - Axle configuration for the power unit
+     * @param trailers - Trailer configurations that may include axle configuration
+     * @returns Combined axle configurations in vehicle order, where vehicleIndex 0
+     *          represents the power unit and trailer indexes start at 1.
+     */
+    combineAxleConfigurations(powerUnitAxleConfiguration: Array<AxleConfiguration>, trailers: Array<VehicleInConfiguration>): Array<IndexedAxleConfiguration>;
+    /**
+     * Calculates the Gross Combined Vehicle Weight (GCVW) from axle unit weights.
+     *
+     * @param axleConfiguration - Axle configuration to total
+     * @returns Sum of axle unit weights, treating missing weights as 0.
+     */
+    calculateGCVW(axleConfiguration: Array<AxleConfiguration>): number;
     /**
      * Given a commodity and selected power unit subtype for a permit type,
      * return whether or not axle units can be added to the power unit.

package/dist/policy-engine.js

@@ -877,6 +877,27 @@ class Policy {
     getSimplifiedVehicleConfiguration(vehicleDetails, vehicleConfiguration) {
         return (0, vehicles_helper_1.getSimplifiedVehicleConfigurationHelper)(vehicleDetails, vehicleConfiguration);
     }
+    /**
+     * Combines axle configurations from a power unit and its trailers into a
+     * single axle configuration array, adding a vehicle index to each axle unit.
+     *
+     * @param powerUnitAxleConfiguration - Axle configuration for the power unit
+     * @param trailers - Trailer configurations that may include axle configuration
+     * @returns Combined axle configurations in vehicle order, where vehicleIndex 0
+     *          represents the power unit and trailer indexes start at 1.
+     */
+    combineAxleConfigurations(powerUnitAxleConfiguration, trailers) {
+        return (0, vehicles_helper_1.combineAxleConfigurationsHelper)(powerUnitAxleConfiguration, trailers);
+    }
+    /**
+     * Calculates the Gross Combined Vehicle Weight (GCVW) from axle unit weights.
+     *
+     * @param axleConfiguration - Axle configuration to total
+     * @returns Sum of axle unit weights, treating missing weights as 0.
+     */
+    calculateGCVW(axleConfiguration) {
+        return (0, vehicles_helper_1.calculateGCVWHelper)(axleConfiguration);
+    }
     /**
      * Given a commodity and selected power unit subtype for a permit type,
      * return whether or not axle units can be added to the power unit.

package/dist/types/axle-configuration.d.ts

@@ -18,3 +18,7 @@ export type AxleConfiguration = {
     /** Tire size in centimetres */
     tireSize?: number;
 };
+export type IndexedAxleConfiguration = AxleConfiguration & {
+    /** Index of the vehicle carrying this axle unit, where 0 is the power unit */
+    vehicleIndex: number;
+};

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 export { AxleCalcResults, PolicyCheckResult, AxleUnitPolicyCheckResult, AxleGroupPolicyCheckResult, } from './axle-calculation-results';
-export { AxleConfiguration } from './axle-configuration';
+export { AxleConfiguration, IndexedAxleConfiguration, } from './axle-configuration';
 export { BridgeCalculationConstants } from './bridge-calculation-constants';
 export { BridgeCalculationResult } from './bridge-calculation-result';
 export { Commodity } from './commodity';

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

@@ -143,6 +143,8 @@ export type PermittedCommodity = {
 export type VehicleInConfiguration = {
     /** Subtype of the vehicle */
     vehicleSubType: string;
+    /** Axle configuration details for this vehicle (optional) */
+    axleConfiguration?: Array<AxleConfiguration> | null;
 };
 /**
  * Complete vehicle configuration including dimensions and axles

package/dist/version.d.ts

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

package/package.json

@@ -91,5 +91,5 @@
     ],
     "testEnvironment": "node"
   },
-  "version": "v2.5.2"
+  "version": "v2.7.0"
 }