onroute-policy-engine 1.5.0 → 1.6.0

package/.github/workflows/analysis.yml

@@ -16,8 +16,8 @@ jobs:
 
   lint:
     name: lint
-    if: ${{ ! github.event.pull_request.draft }}
-    runs-on: ubuntu-latest  # Runs on the latest version of Ubuntu
+    if: (! github.event.pull_request.draft)
+    runs-on: ubuntu-24.04  # Runs on the latest version of Ubuntu
     steps:
       - name: Checkout code
         uses: actions/checkout@v4  # Checks out the code from the repository
@@ -37,7 +37,7 @@ jobs:
   # https://github.com/marketplace/actions/aqua-security-trivy
   trivy:
     name: Trivy Security Scan
-    if: ${{ ! github.event.pull_request.draft }}
+    if: (! github.event.pull_request.draft)
     runs-on: ubuntu-22.04
     timeout-minutes: 1
     steps:

package/.github/workflows/pipeline.yml

@@ -6,14 +6,14 @@ on:
   workflow_dispatch:
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     permissions:
       contents: write
       packages: write
     steps:
       - uses: actions/checkout@v4
   deploy:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     permissions:
       id-token: write # needed for provenance data generation
       contents: write

package/dist/helper/conditions.helper.d.ts

@@ -0,0 +1,11 @@
+import { Policy } from '../policy-engine';
+import { ConditionForPermit } from '../types';
+/**
+ * Gets a list of conditions that are applicable for the supplied permit
+ * application. The conditions may be driven by those applicable for the
+ * permit type, or the vehicle type, or other aspects of the permit application.
+ * @param permitApp The in-progress permit application
+ * @param policy Policy object
+ * @returns Array of conditions that apply to the specific permit application
+ */
+export declare function getConditionsForPermitHelper(permitApp: any, policy: Policy): Array<ConditionForPermit>;

package/dist/helper/conditions.helper.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConditionsForPermitHelper = getConditionsForPermitHelper;
+/**
+ * Gets a list of conditions that are applicable for the supplied permit
+ * application. The conditions may be driven by those applicable for the
+ * permit type, or the vehicle type, or other aspects of the permit application.
+ * @param permitApp The in-progress permit application
+ * @param policy Policy object
+ * @returns Array of conditions that apply to the specific permit application
+ */
+function getConditionsForPermitHelper(permitApp, policy) {
+    var _a, _b;
+    let conditionsForPermit = [];
+    if (permitApp.permitType) {
+        // Get all conditions applicable to the permit type
+        const permitType = policy.getPermitTypeDefinition(permitApp.permitType);
+        if (permitType) {
+            conditionsForPermit = conditionsForPermit.concat(expandConditions(policy, permitType.conditions));
+        }
+        // Get any conditions specific to the permitted vehicle
+        if ((_b = (_a = permitApp.permitData) === null || _a === void 0 ? void 0 : _a.vehicleDetails) === null || _b === void 0 ? void 0 : _b.vehicleSubType) {
+            const vehicle = policy.getVehicleDefinition(permitApp.permitData.vehicleDetails.vehicleSubType);
+            if (vehicle) {
+                conditionsForPermit = conditionsForPermit.concat(expandConditions(policy, vehicle.conditions));
+            }
+        }
+    }
+    return conditionsForPermit;
+}
+/**
+ * Expand a list of ConditionRequirement to include the full
+ * properties of the configured condition in the policy definition
+ * @param conditions Array of condition requirements
+ * @param policy Policy to use for condition definitions
+ * @returns Array of full ConditionForPermit object, or empty array if
+ * none found matching.
+ */
+function expandConditions(policy, conditions) {
+    const expandedConditions = [];
+    conditions === null || conditions === void 0 ? void 0 : conditions.forEach((c) => {
+        var _a;
+        const condition = (_a = policy.policyDefinition.conditions) === null || _a === void 0 ? void 0 : _a.find((cond) => cond.condition == c.condition);
+        if (condition) {
+            expandedConditions.push(Object.assign(Object.assign({}, condition), c));
+        }
+    });
+    return expandedConditions;
+}

package/dist/policy-engine.d.ts

@@ -1,4 +1,4 @@
-import { PolicyDefinition, PermitType, Commodity, SizeDimension, AxleConfiguration, BridgeCalculationResult } from 'onroute-policy-engine/types';
+import { PolicyDefinition, PermitType, Commodity, VehicleType, SizeDimension, AxleConfiguration, BridgeCalculationResult, ConditionForPermit } from 'onroute-policy-engine/types';
 import { Engine } from 'json-rules-engine';
 import { ValidationResults } from './validation-results';
 import { SpecialAuthorizations } from './types/special-authorizations';
@@ -34,6 +34,14 @@ export declare class Policy {
      * @returns Results of the validation of the permit application
      */
     validate(permit: any): Promise<ValidationResults>;
+    /**
+     * Gets a list of conditions that are applicable for the supplied permit
+     * application. The conditions may be driven by those applicable for the
+     * permit type, or the vehicle type, or other aspects of the permit application.
+     * @param permit The in-progress permit application
+     * @returns Array of conditions that apply to the specific permit application
+     */
+    getConditionsForPermit(permit: any): Array<ConditionForPermit>;
     /**
      * Gets a list of all configured permit types in the policy definition.
      * @returns Map of permit type IDs to permit type names.
@@ -149,6 +157,13 @@ export declare class Policy {
      * @returns PermitType definition for the supplied ID.
      */
     getPermitTypeDefinition(type?: string): PermitType | null;
+    /**
+     * Gets a full VehicleType definition by ID (subType)
+     * @param subType String id (subType) of the vehicle. Can be either
+     * a trailer subtype or a power unit subtype.
+     * @returns Vehicle Type (trailer or power unit), or null if none found
+     */
+    getVehicleDefinition(subType?: string): VehicleType | null;
     /**
      * Gets a full Commodity definition by ID
      * @param type Type ID of the commodity to return.

package/dist/policy-engine.js

@@ -16,6 +16,7 @@ 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");
+const conditions_helper_1 = require("./helper/conditions.helper");
 /** Class representing commercial vehicle policy. */
 class Policy {
     /**
@@ -79,6 +80,16 @@ class Policy {
             return validationResults;
         }
     }
+    /**
+     * Gets a list of conditions that are applicable for the supplied permit
+     * application. The conditions may be driven by those applicable for the
+     * permit type, or the vehicle type, or other aspects of the permit application.
+     * @param permit The in-progress permit application
+     * @returns Array of conditions that apply to the specific permit application
+     */
+    getConditionsForPermit(permit) {
+        return (0, conditions_helper_1.getConditionsForPermitHelper)(permit, this);
+    }
     /**
      * Gets a list of all configured permit types in the policy definition.
      * @returns Map of permit type IDs to permit type names.
@@ -677,6 +688,26 @@ class Policy {
             return null;
         }
     }
+    /**
+     * Gets a full VehicleType definition by ID (subType)
+     * @param subType String id (subType) of the vehicle. Can be either
+     * a trailer subtype or a power unit subtype.
+     * @returns Vehicle Type (trailer or power unit), or null if none found
+     */
+    getVehicleDefinition(subType) {
+        var _a, _b;
+        if (this.policyDefinition.vehicleTypes) {
+            const puType = (_a = this.policyDefinition.vehicleTypes.powerUnitTypes) === null || _a === void 0 ? void 0 : _a.find((pu) => pu.id == subType);
+            if (puType) {
+                return puType;
+            }
+            const trType = (_b = this.policyDefinition.vehicleTypes.trailerTypes) === null || _b === void 0 ? void 0 : _b.find((tr) => tr.id == subType);
+            if (trType) {
+                return trType;
+            }
+        }
+        return null;
+    }
     /**
      * Gets a full Commodity definition by ID
      * @param type Type ID of the commodity to return.

package/dist/types/index.d.ts

@@ -7,6 +7,7 @@ export { DimensionModifier } from './dimension-modifier';
 export { PermitFacts } from './facts';
 export { GeographicRegion } from './geographic-region';
 export { IdentifiedObject } from './identified-object';
+export { PermitConditionDefinition, ConditionRequirement, ConditionForPermit, } from './permit-condition';
 export { PermitType } from './permit-type';
 export { PolicyDefinition } from './policy-definition';
 export { Matrix, RangeMatrix } from './range-matrix';

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

@@ -0,0 +1,10 @@
+export type PermitConditionDefinition = {
+    description: string;
+    condition: string;
+    conditionLink: string;
+};
+export type ConditionRequirement = {
+    condition: string;
+    mandatory?: boolean;
+};
+export type ConditionForPermit = PermitConditionDefinition & ConditionRequirement;

package/dist/types/permit-condition.js

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

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

@@ -1,5 +1,6 @@
 import { RuleProperties } from 'json-rules-engine';
 import { CostRule, IdentifiedObject } from 'onroute-policy-engine/types';
+import { ConditionRequirement } from './permit-condition';
 export type PermitType = IdentifiedObject & {
     routingRequired: boolean;
     weightDimensionRequired: boolean;
@@ -9,4 +10,5 @@ export type PermitType = IdentifiedObject & {
     allowedCommodities?: Array<string>;
     rules?: Array<RuleProperties>;
     costRules?: Array<CostRule>;
+    conditions?: Array<ConditionRequirement>;
 };

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

@@ -1,4 +1,4 @@
-import { GeographicRegion, PermitType, DefaultWeightDimensions, VehicleTypes, Commodity, SizeDimension, VehicleCategories, RangeMatrix, BridgeCalculationConstants } from 'onroute-policy-engine/types';
+import { GeographicRegion, PermitType, DefaultWeightDimensions, VehicleTypes, Commodity, SizeDimension, VehicleCategories, RangeMatrix, BridgeCalculationConstants, PermitConditionDefinition } from 'onroute-policy-engine/types';
 import { RuleProperties } from 'json-rules-engine';
 export type PolicyDefinition = {
     minPEVersion: string;
@@ -12,4 +12,5 @@ export type PolicyDefinition = {
     commodities: Array<Commodity>;
     rangeMatrices?: Array<RangeMatrix>;
     bridgeCalculationConstants: BridgeCalculationConstants;
+    conditions?: Array<PermitConditionDefinition>;
 };

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

@@ -1,9 +1,11 @@
 import { IdentifiedObject, SizeDimension, PowerUnitWeightDimension, TrailerWeightDimension } from 'onroute-policy-engine/types';
+import { ConditionRequirement } from './permit-condition';
 export type VehicleType = IdentifiedObject & {
     category: string;
     defaultSizeDimensions?: SizeDimension;
     ignoreForSizeDimensions?: boolean;
     isLcv?: boolean;
+    conditions?: Array<ConditionRequirement>;
 };
 export type PowerUnitType = VehicleType & {
     defaultWeightDimensions?: Array<PowerUnitWeightDimension>;

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "v1.5.0";
+export declare const version = "v1.6.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.5.0';
+exports.version = 'v1.6.0';

package/package.json

@@ -89,5 +89,5 @@
     ],
     "testEnvironment": "node"
   },
-  "version": "v1.5.0"
+  "version": "v1.6.0"
 }