onroute-policy-engine 0.8.1 → 1.1.0

package/.github/workflows/analysis.yml

@@ -31,7 +31,7 @@ jobs:
         run: npm install  # Installs project dependencies
 
       - name: Lint code
-        run: npx eslint . --config .eslintrc.cjs  # Run ESLint with the specified config
+        run: npx eslint "{src,apps,libs,test}/**/*.ts"  # Run ESLint with the specified config
       
 
   # https://github.com/marketplace/actions/aqua-security-trivy

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

@@ -3,5 +3,6 @@ export declare enum ValidationResultCode {
     FieldValidationError = "field-validation-error",
     ConfigurationInvalid = "configuration-invalid",
     GeneralResult = "general-result",
-    CostValue = "cost-value"
+    CostValue = "cost-value",
+    IsLcvCarrier = "lcv-carrier"
 }

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

@@ -8,4 +8,5 @@ var ValidationResultCode;
     ValidationResultCode["ConfigurationInvalid"] = "configuration-invalid";
     ValidationResultCode["GeneralResult"] = "general-result";
     ValidationResultCode["CostValue"] = "cost-value";
+    ValidationResultCode["IsLcvCarrier"] = "lcv-carrier";
 })(ValidationResultCode || (exports.ValidationResultCode = ValidationResultCode = {}));

package/dist/helper/facts.helper.js

@@ -56,11 +56,33 @@ function addRuntimeFacts(engine, policy) {
             isValid = policy.isConfigurationValid(permitType, commodity, fullVehicleConfiguration);
         }
         catch (e) {
-            console.log(`Error validating vehicle configuration: '{e.message}'`);
+            console.log(`Error validating vehicle configuration: '${e.message}'`);
             isValid = false;
         }
         return isValid;
     });
+    /**
+     * Add runtime fact to get the list of allowed vehicles taking into
+     * consideration a client special authorization lcv flag.
+     */
+    engine.addFact(enum_1.PolicyFacts.AllowedVehicles.toString(), async function (params, almanac) {
+        let allowedVehicles = [];
+        const permitTypeId = (await almanac.factValue(enum_1.PermitAppInfo.PermitType));
+        const permitType = policy.getPermitTypeDefinition(permitTypeId);
+        if (permitType) {
+            if (permitType.allowedVehicles &&
+                permitType.allowedVehicles.length > 0) {
+                allowedVehicles = permitType.allowedVehicles;
+                // Filter out long combination vehcles if necessary
+                if (!policy.specialAuthorizations ||
+                    !policy.specialAuthorizations.lcv) {
+                    allowedVehicles =
+                        policy.filterOutLongCombinationVehicles(allowedVehicles);
+                }
+            }
+        }
+        return allowedVehicles;
+    });
     /**
      * Add runtime fact for a fixed permit cost, the cost supplied
      * as a parameter.

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

@@ -3,7 +3,6 @@ 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 enum_1 = require("onroute-policy-engine/enum");
 /**
  * Gets a json-rules-engine with all onRouteBC custom operators added,
  * and all policy rules that apply to all permit types added.
@@ -60,16 +59,6 @@ function getRulesEngines(policy) {
             };
             engine.addRule(costRule);
         });
-        let allowedVehicles;
-        if (permitType.allowedVehicles && permitType.allowedVehicles.length > 0) {
-            allowedVehicles = permitType.allowedVehicles;
-        }
-        else {
-            // If no allowed vehicles are specified, none are permitted
-            allowedVehicles = [];
-        }
-        // Each permit type should have a list of allowed vehicles configured.
-        engine.addFact(enum_1.PolicyFacts.AllowedVehicles.toString(), allowedVehicles);
         engineMap.set(permitType.id, engine);
     });
     return engineMap;

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

@@ -0,0 +1,8 @@
+import { VehicleTypes } from '../types';
+/**
+ * Filters out all LCV vehicles from a supplied list of vehicle IDs.
+ * @param vehicleList List of vehicle IDs to filter
+ * @param vehicleTypes Configured vehicle types from policy configuration
+ * @returns
+ */
+export declare function filterOutLcv(vehicleList: Array<string>, vehicleTypes: VehicleTypes): Array<string>;

package/dist/helper/vehicles.helper.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterOutLcv = filterOutLcv;
+/**
+ * Filters out all LCV vehicles from a supplied list of vehicle IDs.
+ * @param vehicleList List of vehicle IDs to filter
+ * @param vehicleTypes Configured vehicle types from policy configuration
+ * @returns
+ */
+function filterOutLcv(vehicleList, vehicleTypes) {
+    const allVehicleTypes = vehicleTypes.powerUnitTypes.concat(vehicleTypes.trailerTypes);
+    const filteredList = vehicleList.filter((v) => {
+        const vType = allVehicleTypes.find((vt) => vt.id === v);
+        if (vType) {
+            if (vType.isLcv) {
+                return false;
+            }
+            else {
+                return true;
+            }
+        }
+        else {
+            console.log(`No configured vehicle type matching '${v}'`);
+            return false;
+        }
+    });
+    return filteredList;
+}

package/dist/policy-engine.d.ts

@@ -1,10 +1,16 @@
 import { PolicyDefinition, PermitType, Commodity, SizeDimension, AxleConfiguration, BridgeCalculationResult } from 'onroute-policy-engine/types';
 import { Engine } from 'json-rules-engine';
 import { ValidationResults } from './validation-results';
+import { SpecialAuthorizations } from './types/special-authorizations';
 /** Class representing commercial vehicle policy. */
 export declare class Policy {
     /** Object representation of policy definition and rules. */
     policyDefinition: PolicyDefinition;
+    /**
+     * Special authorizations granted to a client, used
+     * to adjust validations and allowed vehicles for permit types.
+     */
+    specialAuthorizations?: SpecialAuthorizations | null;
     /**
      * Map of json-rules-engine instances, one for each
      * permit type defined in the permit definition. Keyed
@@ -15,7 +21,13 @@ export declare class Policy {
      * Creates a new Policy object.
      * @param definition Policy definition to validate permits against
      */
-    constructor(definition: PolicyDefinition);
+    constructor(definition: PolicyDefinition, authorizations?: SpecialAuthorizations);
+    /**
+     * Sets a client's special authorizations to modify the policy validations
+     * and permittable vehicles for permit types.
+     * @param authorizations Special authorizations for a client
+     */
+    setSpecialAuthorizations(authorizations: SpecialAuthorizations | null): void;
     /**
      * Validates a permit application against the policy definition.
      * @param permit The permit application to validate against policy
@@ -32,6 +44,13 @@ export declare class Policy {
      * @returns Map of geographic region IDs to region names.
      */
     getGeographicRegions(): Map<string, string>;
+    /**
+     * Filters out all long combination vehicles from the list of supplied
+     * vehicle IDs, based on policy configuration.
+     * @param vehicleList List of vehicles to filter
+     * @returns Filtered list of vehicles without LCVs
+     */
+    filterOutLongCombinationVehicles(vehicleList: Array<string>): Array<string>;
     /**
      * Gets a list of all configured commodities in the policy definition.
      * @param permitTypeId Return only commodities valid for this permit type.

package/dist/policy-engine.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Policy = void 0;
 const lists_helper_1 = require("./helper/lists.helper");
@@ -8,22 +11,50 @@ const validation_result_1 = require("./validation-result");
 const facts_helper_1 = require("./helper/facts.helper");
 const enum_1 = require("onroute-policy-engine/enum");
 const bridge_calculation_helper_1 = require("./helper/bridge-calculation.helper");
+const version_1 = require("./version");
+const valid_1 = __importDefault(require("semver/functions/valid"));
+const lt_1 = __importDefault(require("semver/functions/lt"));
+const major_1 = __importDefault(require("semver/functions/major"));
+const vehicles_helper_1 = require("./helper/vehicles.helper");
 /** Class representing commercial vehicle policy. */
 class Policy {
     /**
      * Creates a new Policy object.
      * @param definition Policy definition to validate permits against
      */
-    constructor(definition) {
+    constructor(definition, authorizations) {
+        // Check compatibility of the policy engine with the policy config
+        if (!(0, valid_1.default)(version_1.version)) {
+            throw new Error(`Cannot determine the version of the policy engine for compatibility: invalid semver: ${version_1.version}`);
+        }
+        else if (!(0, valid_1.default)(definition.minPEVersion)) {
+            throw new Error(`Cannot determine the minimum PE version for the configuration: invalid semver: ${definition.minPEVersion}`);
+        }
+        else if ((0, lt_1.default)(version_1.version, definition.minPEVersion)) {
+            throw new Error(`Current policy engine version is less than minimum version required for policy config: ${version_1.version} > ${definition.minPEVersion}`);
+        }
+        else if ((0, major_1.default)(version_1.version) > (0, major_1.default)(definition.minPEVersion)) {
+            throw new Error(`Current policy config minimum version is at least one major version behind policy engine: major(${definition.minPEVersion}) < major(${version_1.version}))`);
+        }
         this.policyDefinition = definition;
+        this.specialAuthorizations = authorizations;
         this.rulesEngines = (0, rules_engine_helper_1.getRulesEngines)(this);
     }
+    /**
+     * Sets a client's special authorizations to modify the policy validations
+     * and permittable vehicles for permit types.
+     * @param authorizations Special authorizations for a client
+     */
+    setSpecialAuthorizations(authorizations) {
+        this.specialAuthorizations = authorizations;
+    }
     /**
      * Validates a permit application against the policy definition.
      * @param permit The permit application to validate against policy
      * @returns Results of the validation of the permit application
      */
     async validate(permit) {
+        var _a;
         const engine = this.rulesEngines.get(permit.permitType);
         if (!engine) {
             // If the permit type being validated has no configuration in the
@@ -40,7 +71,12 @@ class Policy {
             // Run the json-rules-engine against the permit facts
             const engineResult = await engine.run(permit);
             // Wrap the json-rules-engine result in a ValidationResult object
-            return new validation_results_1.ValidationResults(engineResult);
+            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}'`));
+            }
+            return validationResults;
         }
     }
     /**
@@ -59,6 +95,15 @@ class Policy {
         const geographicRegions = (0, lists_helper_1.extractIdentifiedObjects)(this.policyDefinition.geographicRegions);
         return geographicRegions;
     }
+    /**
+     * Filters out all long combination vehicles from the list of supplied
+     * vehicle IDs, based on policy configuration.
+     * @param vehicleList List of vehicles to filter
+     * @returns Filtered list of vehicles without LCVs
+     */
+    filterOutLongCombinationVehicles(vehicleList) {
+        return (0, vehicles_helper_1.filterOutLcv)(vehicleList, this.policyDefinition.vehicleTypes);
+    }
     /**
      * Gets a list of all configured commodities in the policy definition.
      * @param permitTypeId Return only commodities valid for this permit type.
@@ -123,7 +168,7 @@ class Policy {
      * vehicle, and a string common name for the vehicle.
      */
     getPermittableVehicleTypes(permitTypeId, commodityId) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         if (!permitTypeId || !commodityId) {
             throw new Error('Missing permitTypeId and/or commodityId');
         }
@@ -150,16 +195,31 @@ class Policy {
             if (!commodity) {
                 throw new Error(`Commodity id '${commodityId}' is not correctly configured in the policy definition`);
             }
-            const puTypeIdsOS = (_b = (_a = commodity.size) === null || _a === void 0 ? void 0 : _a.powerUnits) === null || _b === void 0 ? void 0 : _b.map((p) => p.type);
-            const trTypeIdsOS = [];
+            let puTypeIdsOS = (_b = (_a = commodity.size) === null || _a === void 0 ? void 0 : _a.powerUnits) === null || _b === void 0 ? void 0 : _b.map((p) => p.type);
+            let trTypeIdsOS = [];
             (_d = (_c = commodity.size) === null || _c === void 0 ? void 0 : _c.powerUnits) === null || _d === void 0 ? void 0 : _d.forEach((pu) => {
                 const trForPu = pu.trailers.map((t) => t.type);
                 if (trForPu)
-                    trTypeIdsOS.concat(trForPu);
+                    trTypeIdsOS === null || trTypeIdsOS === void 0 ? void 0 : trTypeIdsOS.concat(trForPu);
             });
             // TODO: implement along with overweight permits. Stub for now.
-            const puTypeIdsOW = [];
-            const trTypeIdsOW = [];
+            let puTypeIdsOW = [];
+            let trTypeIdsOW = [];
+            // Remove long combination vehicles if needed
+            if (!((_e = this.specialAuthorizations) === null || _e === void 0 ? void 0 : _e.lcv)) {
+                if (puTypeIdsOS) {
+                    puTypeIdsOS = this.filterOutLongCombinationVehicles(puTypeIdsOS);
+                }
+                if (trTypeIdsOS) {
+                    trTypeIdsOS = this.filterOutLongCombinationVehicles(trTypeIdsOS);
+                }
+                if (puTypeIdsOW) {
+                    puTypeIdsOW = this.filterOutLongCombinationVehicles(puTypeIdsOW);
+                }
+                if (trTypeIdsOW) {
+                    trTypeIdsOW = this.filterOutLongCombinationVehicles(trTypeIdsOW);
+                }
+            }
             const puTypesOS = (0, lists_helper_1.extractIdentifiedObjects)(this.policyDefinition.vehicleTypes.powerUnitTypes, puTypeIdsOS);
             const trTypesOS = (0, lists_helper_1.extractIdentifiedObjects)(this.policyDefinition.vehicleTypes.trailerTypes, trTypeIdsOS);
             const puTypesOW = (0, lists_helper_1.extractIdentifiedObjects)(this.policyDefinition.vehicleTypes.powerUnitTypes, puTypeIdsOW);
@@ -217,7 +277,7 @@ class Policy {
      * trailers in a single return value (if applicable).
      */
     getNextPermittableVehicles(permitTypeId, commodityId, currentConfiguration) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         if (!permitTypeId || !commodityId || !currentConfiguration) {
             throw new Error('Missing permitTypeId and/or commodityId and/or currentConfiguration');
         }
@@ -285,6 +345,12 @@ class Policy {
                 }
             }
         }
+        // Remove long combination vehicles if required
+        if (!((_e = this.specialAuthorizations) === null || _e === void 0 ? void 0 : _e.lcv)) {
+            if (vehicleTypeIds) {
+                vehicleTypeIds = this.filterOutLongCombinationVehicles(vehicleTypeIds);
+            }
+        }
         vehicleTypes = (0, lists_helper_1.extractIdentifiedObjects)(allVehicles, vehicleTypeIds);
         return vehicleTypes;
     }
@@ -327,6 +393,15 @@ class Policy {
             // invalid as a complete configuration.
             return validatePartial;
         }
+        if (!this.specialAuthorizations || !this.specialAuthorizations.lcv) {
+            // No provision for allowing long combination vehicles
+            const filteredConfiguration = this.filterOutLongCombinationVehicles(currentConfiguration);
+            if (filteredConfiguration.length !== currentConfiguration.length) {
+                // There is an LCV in the configuration, but we are not allowing
+                // LCV permitting. Return false.
+                return false;
+            }
+        }
         const powerUnit = (_b = (_a = commodity.size) === null || _a === void 0 ? void 0 : _a.powerUnits) === null || _b === void 0 ? void 0 : _b.find((p) => p.type == currentConfiguration[0]);
         if (!powerUnit) {
             // The power unit is not allowed for the commodity

package/dist/types/index.d.ts

@@ -13,6 +13,7 @@ export { Matrix, RangeMatrix } from './range-matrix';
 export { RegionSizeOverride } from './region-size-override';
 export { SelfIssuable } from './self-issuable';
 export { SizeDimension } from './size-dimension';
+export { SpecialAuthorizations } from './special-authorizations';
 export { VehicleCategory, PowerUnitCategory, TrailerCategory, VehicleCategories, } from './vehicle-category';
 export { VehicleType, PowerUnitType, TrailerType, VehicleTypes, } from './vehicle-type';
 export { Vehicle, VehicleSizeConfiguration, TrailerSize, PowerUnitWeight, TrailerWeight, } from './vehicle';

package/dist/types/policy-definition.d.ts

@@ -1,7 +1,7 @@
 import { GeographicRegion, PermitType, DefaultWeightDimensions, VehicleTypes, Commodity, SizeDimension, VehicleCategories, RangeMatrix, BridgeCalculationConstants } from 'onroute-policy-engine/types';
 import { RuleProperties } from 'json-rules-engine';
 export type PolicyDefinition = {
-    version: string;
+    minPEVersion: string;
     geographicRegions: Array<GeographicRegion>;
     permitTypes: Array<PermitType>;
     commonRules: Array<RuleProperties>;

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

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

package/dist/types/special-authorizations.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/vehicle-type.d.ts

@@ -3,6 +3,7 @@ export type VehicleType = IdentifiedObject & {
     category: string;
     defaultSizeDimensions?: SizeDimension;
     ignoreForSizeDimensions?: boolean;
+    isLcv?: boolean;
 };
 export type PowerUnitType = VehicleType & {
     defaultWeightDimensions?: Array<PowerUnitWeightDimension>;

package/dist/version.d.ts

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

package/dist/version.js

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

package/eslint.config.mjs

@@ -0,0 +1,46 @@
+import typescriptEslint from "@typescript-eslint/eslint-plugin";
+import globals from "globals";
+import tsParser from "@typescript-eslint/parser";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+    baseDirectory: __dirname,
+    recommendedConfig: js.configs.recommended,
+    allConfig: js.configs.all
+});
+
+export default [{
+    ignores: ["**/.eslintrc.cjs", "**/node_modules/", "**/dist/", "**/.eslintrc.cjs"],
+}, ...compat.extends("eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"), {
+    plugins: {
+        "@typescript-eslint": typescriptEslint,
+    },
+
+    languageOptions: {
+        globals: {
+            ...globals.node,
+            ...globals.jest,
+        },
+
+        parser: tsParser,
+        ecmaVersion: 5,
+        sourceType: "module",
+
+        parserOptions: {
+            project: ["./tsconfig.json"],
+            tsconfigRootDir: __dirname,
+        },
+    },
+
+    rules: {
+        "@typescript-eslint/no-explicit-any": "off",
+    },
+    },
+    {
+    ignores: ["node_modules/*", "dist/*"]
+}];

package/package.json

@@ -38,22 +38,24 @@
   "license": "Apache-2.0",
   "homepage": "https://github.com/bcgov/onroutebc-policy-engine#readme",
   "devDependencies": {
-    "@iwsio/json-csv-core": "^1.1.7",
-    "@types/jest": "^29.5.12",
-    "@typescript-eslint/eslint-plugin": "^7.5.0",
-    "csv": "^6.3.10",
-    "eslint": "^8.57.0",
+    "@iwsio/json-csv-core": "^1.2.0",
+    "@types/jest": "^29.5.14",
+    "@types/semver": "^7.5.8",
+    "@typescript-eslint/eslint-plugin": "^8.17.0",
+    "csv": "^6.3.11",
+    "eslint": "^9.16.0",
     "eslint-config-prettier": "^9.1.0",
     "genversion": "^3.2.0",
     "jest": "^29.7.0",
-    "prettier": "^3.2.5",
-    "rimraf": "^5.0.7",
-    "ts-jest": "^29.1.2",
-    "typescript": "^5.4.3"
+    "prettier": "^3.4.2",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.7.2"
   },
   "dependencies": {
-    "dayjs": "^1.11.10",
-    "json-rules-engine": "^6.5.0"
+    "dayjs": "^1.11.13",
+    "json-rules-engine": "^7.2.1",
+    "semver": "^7.6.3"
   },
   "jest": {
     "moduleFileExtensions": [
@@ -87,5 +89,5 @@
     ],
     "testEnvironment": "node"
   },
-  "version": "v0.8.1"
+  "version": "v1.1.0"
 }