onroute-policy-engine 0.8.0 → 1.0.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/.github/workflows/pipeline.yml

@@ -40,7 +40,7 @@ jobs:
           registry-url: 'https://registry.npmjs.org'
 
       - run: npm ci
-      - run: npm install genversion
+      - run: npm install genversion --save-dev
       - run: npx genversion -e src/version.ts
       - run: tsc
       - run: npm test

package/dist/helper/facts.helper.js

@@ -56,7 +56,7 @@ 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;

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,6 +11,10 @@ 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"));
 /** Class representing commercial vehicle policy. */
 class Policy {
     /**
@@ -15,6 +22,19 @@ class Policy {
      * @param definition Policy definition to validate permits against
      */
     constructor(definition) {
+        // 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.rulesEngines = (0, rules_engine_helper_1.getRulesEngines)(this);
     }

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/version.d.ts

@@ -1 +1 @@
-export declare const version = "v0.8.0";
+export declare const version = "v1.0.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.0';
+exports.version = 'v1.0.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",
-    "genversion": "^3.2.0",
-    "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.0"
+  "version": "v1.0.0"
 }