onroute-policy-engine 1.1.0 → 1.3.0

package/dist/enum/index.d.ts

@@ -4,4 +4,5 @@ export { PermitAppInfo } from './permit-app-info';
 export { RelativePosition } from './relative-position';
 export { ValidationResultCode } from './validation-result-code';
 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.ValidationResultType = exports.ValidationResultCode = exports.RelativePosition = exports.PermitAppInfo = exports.CostFacts = exports.PolicyFacts = exports.AccessoryVehicleType = void 0;
+exports.VehicleTypes = exports.VehicleCategory = 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");
@@ -14,5 +14,7 @@ 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_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");
+Object.defineProperty(exports, "VehicleCategory", { enumerable: true, get: function () { return vehicle_category_1.VehicleCategory; } });
 var vehicle_types_1 = require("./vehicle-types");
 Object.defineProperty(exports, "VehicleTypes", { enumerable: true, get: function () { return vehicle_types_1.VehicleTypes; } });

package/dist/enum/vehicle-category.d.ts

@@ -0,0 +1,4 @@
+export declare enum VehicleCategory {
+    PowerUnit = "powerUnit",
+    Trailer = "trailer"
+}

package/dist/enum/vehicle-category.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VehicleCategory = void 0;
+var VehicleCategory;
+(function (VehicleCategory) {
+    VehicleCategory["PowerUnit"] = "powerUnit";
+    VehicleCategory["Trailer"] = "trailer";
+})(VehicleCategory || (exports.VehicleCategory = VehicleCategory = {}));

package/dist/helper/facts.helper.js

@@ -75,7 +75,7 @@ function addRuntimeFacts(engine, policy) {
                 allowedVehicles = permitType.allowedVehicles;
                 // Filter out long combination vehcles if necessary
                 if (!policy.specialAuthorizations ||
-                    !policy.specialAuthorizations.lcv) {
+                    !policy.specialAuthorizations.isLcvAllowed) {
                     allowedVehicles =
                         policy.filterOutLongCombinationVehicles(allowedVehicles);
                 }

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

@@ -6,3 +6,11 @@ import { VehicleTypes } from '../types';
  * @returns
  */
 export declare function filterOutLcv(vehicleList: Array<string>, vehicleTypes: VehicleTypes): Array<string>;
+/**
+ * Filters a list of vehicles to include only those matching the supplied
+ * vehicle type - either powerUnit or trailer.
+ * @param vehicleList List of vehicle IDs to filter
+ * @param vehicleTypes Configured vehicle types from policy configuration
+ * @param type Type of vehicle to filter, either powerUnit or trailer
+ */
+export declare function filterVehiclesByType(vehicleList: Array<string>, vehicleTypes: VehicleTypes, type: string): Array<string>;

package/dist/helper/vehicles.helper.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.filterOutLcv = filterOutLcv;
+exports.filterVehiclesByType = filterVehiclesByType;
+const enum_1 = require("../enum");
 /**
  * Filters out all LCV vehicles from a supplied list of vehicle IDs.
  * @param vehicleList List of vehicle IDs to filter
@@ -26,3 +28,31 @@ function filterOutLcv(vehicleList, vehicleTypes) {
     });
     return filteredList;
 }
+/**
+ * Filters a list of vehicles to include only those matching the supplied
+ * vehicle type - either powerUnit or trailer.
+ * @param vehicleList List of vehicle IDs to filter
+ * @param vehicleTypes Configured vehicle types from policy configuration
+ * @param type Type of vehicle to filter, either powerUnit or trailer
+ */
+function filterVehiclesByType(vehicleList, vehicleTypes, type) {
+    if (type !== enum_1.VehicleCategory.PowerUnit.toString() &&
+        type !== enum_1.VehicleCategory.Trailer.toString()) {
+        throw new Error(`Cannot filter based on invalid type '${type}'`);
+    }
+    let targetVehicleTypes;
+    if (type === enum_1.VehicleCategory.PowerUnit) {
+        targetVehicleTypes = vehicleTypes.powerUnitTypes;
+    }
+    else {
+        targetVehicleTypes = vehicleTypes.trailerTypes;
+    }
+    if (!targetVehicleTypes) {
+        return new Array();
+    }
+    const filteredVehicles = vehicleList.filter((vid) => {
+        const vehicleDef = targetVehicleTypes.find((vt) => vt.id === vid);
+        return vehicleDef;
+    });
+    return filteredVehicles;
+}

package/dist/policy-engine.d.ts

@@ -68,7 +68,7 @@ export declare class Policy {
      * other keyed on 'trailers'. Each map consists of a string id for the
      * vehicle, and a string common name for the vehicle.
      */
-    getPermittableVehicleTypes(permitTypeId: string, commodityId: string): Map<string, Map<string, string>>;
+    getPermittableVehicleTypes(permitTypeId: string, commodityId?: string): Map<string, Map<string, string>>;
     /**
      * Gets a list of all allowable power unit types for the given permit type
      * and commodity.
@@ -163,4 +163,11 @@ export declare class Policy {
      * axle group in the vehicle configuration
      */
     calculateBridge(axleConfig: Array<AxleConfiguration>): Array<BridgeCalculationResult>;
+    /**
+     * Gets the list of allowed vehicles separated into two maps, one
+     * for trailers and one for power units. This will filter out LCV
+     * vehicles unless authorized in special authorizations.
+     * @param permitType Permit type definition
+     */
+    getAllowedVehicles(permitType: PermitType): Map<string, Map<string, string>>;
 }

package/dist/policy-engine.js

@@ -73,8 +73,8 @@ class Policy {
             // Wrap the json-rules-engine result in a ValidationResult object
             const validationResults = new validation_results_1.ValidationResults(engineResult);
             // Include an informational message if the client is an LCV carrier
-            if ((_a = this.specialAuthorizations) === null || _a === void 0 ? void 0 : _a.lcv) {
-                validationResults.information.push(new validation_result_1.ValidationResult(enum_1.ValidationResultType.Information, enum_1.ValidationResultCode.IsLcvCarrier, `Policy validation allowing long combination vahicle permitting for client '${this.specialAuthorizations.clientNumber}'`));
+            if ((_a = this.specialAuthorizations) === null || _a === void 0 ? void 0 : _a.isLcvAllowed) {
+                validationResults.information.push(new validation_result_1.ValidationResult(enum_1.ValidationResultType.Information, enum_1.ValidationResultCode.IsLcvCarrier, `Policy validation allowing long combination vahicle permitting for client '${this.specialAuthorizations.companyId}'`));
             }
             return validationResults;
         }
@@ -169,21 +169,24 @@ class Policy {
      */
     getPermittableVehicleTypes(permitTypeId, commodityId) {
         var _a, _b, _c, _d, _e;
-        if (!permitTypeId || !commodityId) {
-            throw new Error('Missing permitTypeId and/or commodityId');
+        if (!permitTypeId) {
+            throw new Error('Missing permitTypeId');
         }
         const permitType = this.getPermitTypeDefinition(permitTypeId);
         if (!permitType) {
             throw new Error(`Invalid permit type: '${permitTypeId}'`);
         }
         if (!permitType.commodityRequired) {
-            // If commodity is not required, this method cannot calculate the
-            // permittable vehicle types since they will not be configured.
-            throw new Error(`Permit type '${permitTypeId}' does not require a commodity`);
+            // If commodity is not required, get the permittable vehicle types
+            // from the permit allowedVehicles list.
+            return this.getAllowedVehicles(permitType);
         }
         let puTypes;
         let trTypes;
         const allowableCommodities = this.getCommodities(permitTypeId);
+        if (!commodityId) {
+            throw new Error('Missing commodityId, permit type requires it');
+        }
         if (!allowableCommodities.has(commodityId)) {
             // If the commodity is not allowed for the permit type, no power
             // units or trailers are allowed.
@@ -206,7 +209,7 @@ class Policy {
             let puTypeIdsOW = [];
             let trTypeIdsOW = [];
             // Remove long combination vehicles if needed
-            if (!((_e = this.specialAuthorizations) === null || _e === void 0 ? void 0 : _e.lcv)) {
+            if (!((_e = this.specialAuthorizations) === null || _e === void 0 ? void 0 : _e.isLcvAllowed)) {
                 if (puTypeIdsOS) {
                     puTypeIdsOS = this.filterOutLongCombinationVehicles(puTypeIdsOS);
                 }
@@ -346,7 +349,7 @@ class Policy {
             }
         }
         // Remove long combination vehicles if required
-        if (!((_e = this.specialAuthorizations) === null || _e === void 0 ? void 0 : _e.lcv)) {
+        if (!((_e = this.specialAuthorizations) === null || _e === void 0 ? void 0 : _e.isLcvAllowed)) {
             if (vehicleTypeIds) {
                 vehicleTypeIds = this.filterOutLongCombinationVehicles(vehicleTypeIds);
             }
@@ -393,7 +396,8 @@ class Policy {
             // invalid as a complete configuration.
             return validatePartial;
         }
-        if (!this.specialAuthorizations || !this.specialAuthorizations.lcv) {
+        if (!this.specialAuthorizations ||
+            !this.specialAuthorizations.isLcvAllowed) {
             // No provision for allowing long combination vehicles
             const filteredConfiguration = this.filterOutLongCombinationVehicles(currentConfiguration);
             if (filteredConfiguration.length !== currentConfiguration.length) {
@@ -708,5 +712,32 @@ class Policy {
         }
         return bridgeResults;
     }
+    /**
+     * Gets the list of allowed vehicles separated into two maps, one
+     * for trailers and one for power units. This will filter out LCV
+     * vehicles unless authorized in special authorizations.
+     * @param permitType Permit type definition
+     */
+    getAllowedVehicles(permitType) {
+        if (permitType.commodityRequired) {
+            // If commodity is required, this method cannot be used since it
+            // requires a fixed set of allowed vehicle types, not commodity-based
+            throw new Error(`Allowed vehicles not configured for permit type requiring commodity: '${permitType.id}'`);
+        }
+        let allowedVehicles = permitType.allowedVehicles;
+        if (!allowedVehicles) {
+            return new Map();
+        }
+        if (!this.specialAuthorizations ||
+            !this.specialAuthorizations.isLcvAllowed) {
+            allowedVehicles = this.filterOutLongCombinationVehicles(allowedVehicles);
+        }
+        const allowedVehicleMap = new Map();
+        const powerUnitIds = (0, vehicles_helper_1.filterVehiclesByType)(allowedVehicles, this.policyDefinition.vehicleTypes, enum_1.VehicleCategory.PowerUnit);
+        const trailerIds = (0, vehicles_helper_1.filterVehiclesByType)(allowedVehicles, this.policyDefinition.vehicleTypes, enum_1.VehicleCategory.Trailer);
+        allowedVehicleMap.set(enum_1.VehicleTypes.PowerUnits, (0, lists_helper_1.extractIdentifiedObjects)(this.policyDefinition.vehicleTypes.powerUnitTypes, powerUnitIds));
+        allowedVehicleMap.set(enum_1.VehicleTypes.Trailers, (0, lists_helper_1.extractIdentifiedObjects)(this.policyDefinition.vehicleTypes.trailerTypes, trailerIds));
+        return allowedVehicleMap;
+    }
 }
 exports.Policy = Policy;

package/dist/types/special-authorizations.d.ts

@@ -1,5 +1,5 @@
 export type SpecialAuthorizations = {
-    clientNumber: string;
-    lcv?: boolean;
-    noFee?: boolean;
+    companyId: number;
+    isLcvAllowed?: boolean;
+    noFeeType?: string;
 };

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "v1.1.0";
+export declare const version = "v1.3.0";

package/dist/version.js

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

package/package.json

@@ -89,5 +89,5 @@
     ],
     "testEnvironment": "node"
   },
-  "version": "v1.1.0"
+  "version": "v1.3.0"
 }