onroute-policy-engine 2.1.0 → 2.2.0

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

@@ -1,24 +1,60 @@
+/**
+ * Vehicle Type Types
+ *
+ * Defines the structure for vehicle types including power units and trailers.
+ * Extends IdentifiedObject with category, dimensions, and special configurations.
+ */
 import { ConditionRequirement, IdentifiedObject, SizeDimension, PowerUnitWeightDimension, TrailerWeightDimension } from 'onroute-policy-engine/types';
+/**
+ * Base vehicle type with identification and configuration options
+ * Extends IdentifiedObject with vehicle-specific properties
+ */
 export type VehicleType = IdentifiedObject & {
+    /** Category identifier for this vehicle type */
     category: string;
+    /** Default size dimensions for this vehicle type (optional) */
     defaultSizeDimensions?: SizeDimension;
+    /** Whether to ignore this vehicle type for size dimension calculations (optional) */
     ignoreForSizeDimensions?: boolean;
+    /** Whether to ignore this vehicle type for axle calculations (optional) */
     ignoreForAxleCalculation?: boolean;
+    /** Whether this vehicle type is an LCV (Long Combination Vehicle) (optional) */
     isLcv?: boolean;
+    /** Array of conditions required for this vehicle type (optional) */
     conditions?: Array<ConditionRequirement>;
+    /** Additional axle subtype identifier (optional) */
     additionalAxleSubType?: string;
 };
+/**
+ * Power unit type with power unit specific configurations
+ * Extends VehicleType with power unit specific properties
+ */
 export type PowerUnitType = VehicleType & {
+    /** Default weight dimensions specific to power units (optional) */
     defaultWeightDimensions?: Array<PowerUnitWeightDimension>;
+    /** Display code prefix for this power unit type (optional) */
     displayCodePrefix?: string;
+    /** Display code for steer axle (optional) */
     displayCodeSteerAxle?: string;
+    /** Display code for drive axle (optional) */
     displayCodeDriveAxle?: string;
 };
+/**
+ * Trailer type with trailer specific configurations
+ * Extends VehicleType with trailer specific properties
+ */
 export type TrailerType = VehicleType & {
+    /** Default weight dimensions specific to trailers (optional) */
     defaultWeightDimensions?: Array<TrailerWeightDimension>;
+    /** Display code for this trailer type (optional) */
     displayCode?: string;
 };
+/**
+ * Complete vehicle types configuration
+ */
 export type VehicleTypes = {
+    /** Array of power unit types */
     powerUnitTypes: Array<PowerUnitType>;
+    /** Array of trailer types */
     trailerTypes: Array<TrailerType>;
 };

package/dist/types/vehicle-type.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * Vehicle Type Types
+ *
+ * Defines the structure for vehicle types including power units and trailers.
+ * Extends IdentifiedObject with category, dimensions, and special configurations.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/vehicle.d.ts

@@ -1,16 +1,43 @@
+/**
+ * Vehicle Types
+ *
+ * Defines the structure for vehicles including power units and trailers.
+ * Extends SelfIssuable for self-issuance capability and includes dimension configurations.
+ */
 import { SelfIssuable, SizeDimension, PowerUnitWeightDimension, TrailerWeightDimension } from 'onroute-policy-engine/types';
+/**
+ * Base vehicle with type identification and self-issuance capability
+ * Extends SelfIssuable to include self-issuance capability
+ */
 export type Vehicle = SelfIssuable & {
+    /** Type identifier for this vehicle */
     type: string;
 };
+/**
+ * Power unit with trailer configuration and weight dimensions
+ * Extends Vehicle with trailer and weight dimension arrays
+ */
 export type VehicleDimensions = Vehicle & {
+    /** Array of trailers attached to this power unit */
     trailers: Array<TrailerDimensions>;
+    /** Array of weight dimensions for this power unit (optional) */
     weightDimensions?: Array<PowerUnitWeightDimension>;
 };
+/**
+ * Trailer with booster/jeep configuration and dimension capabilities
+ * Extends Vehicle with trailer-specific properties
+ */
 export type TrailerDimensions = Vehicle & {
+    /** Whether this trailer is allowed a booster */
     booster: boolean;
+    /** Whether this trailer is allowed a jeep */
     jeep: boolean;
+    /** Array of size dimensions for this trailer (optional) */
     sizeDimensions?: Array<SizeDimension>;
+    /** Whether size is permittable for this trailer (optional) */
     sizePermittable?: boolean;
+    /** Array of weight dimensions for this trailer (optional) */
     weightDimensions?: Array<TrailerWeightDimension>;
+    /** Whether weight is permittable for this trailer (optional) */
     weightPermittable?: boolean;
 };

package/dist/types/vehicle.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * Vehicle Types
+ *
+ * Defines the structure for vehicles including power units and trailers.
+ * Extends SelfIssuable for self-issuance capability and includes dimension configurations.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/weight-dimension.d.ts

@@ -1,20 +1,54 @@
+/**
+ * Weight Dimension Types
+ *
+ * Defines the structure for weight dimensions including single axles, power units,
+ * and trailers. Extends SelfIssuable for self-issuance capability.
+ */
 import { DimensionModifier, SelfIssuable } from 'onroute-policy-engine/types';
+/**
+ * Weight limits for a single axle unit
+ */
 export type SingleAxleDimension = {
+    /** Legal weight limit in kilograms (optional) */
     legal?: number;
+    /** Permittable weight limit in kilograms (optional) */
     permittable?: number;
 };
+/**
+ * Base weight dimension with axle count and modifier
+ * Extends SelfIssuable to include self-issuance capability
+ */
 export type WeightDimension = SelfIssuable & {
+    /** Number of axles applicable to this weight dimension */
     axles: number;
+    /** Dimension modifier for special configurations (optional) */
     modifier?: DimensionModifier;
 };
+/**
+ * Weight dimension specific to power units with steer and drive axle limits
+ * Extends WeightDimension with power unit specific weight limits
+ */
 export type PowerUnitWeightDimension = WeightDimension & {
+    /** Single axle legal weight limit in kilograms (optional) */
     saLegal?: number;
+    /** Single axle permittable weight limit in kilograms (optional) */
     saPermittable?: number;
+    /** Drive axle legal weight limit in kilograms (optional) */
     daLegal?: number;
+    /** Drive axle permittable weight limit in kilograms (optional) */
     daPermittable?: number;
 };
+/**
+ * Weight dimension specific to trailers
+ * Extends WeightDimension with single axle dimension limits
+ */
 export type TrailerWeightDimension = WeightDimension & SingleAxleDimension;
+/**
+ * Default weight dimensions for all vehicle types
+ */
 export type DefaultWeightDimensions = {
+    /** Array of power unit weight dimensions */
     powerUnits: Array<PowerUnitWeightDimension>;
+    /** Array of trailer weight dimensions */
     trailers: Array<TrailerWeightDimension>;
 };

package/dist/types/weight-dimension.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * Weight Dimension Types
+ *
+ * Defines the structure for weight dimensions including single axles, power units,
+ * and trailers. Extends SelfIssuable for self-issuance capability.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/validation-result.d.ts

@@ -17,4 +17,5 @@ export declare class ValidationResult {
     message: string;
     fieldReference?: string;
     cost?: number;
+    details?: Array<string>;
 }

package/dist/validation-results.js

@@ -36,13 +36,14 @@ class ValidationResults {
         this.cost = [];
         if (engineResult) {
             engineResult.events.forEach((e) => {
-                var _a, _b, _c, _d, _e, _f, _g;
+                var _a, _b, _c, _d, _e, _f, _g, _h;
                 const message = (_b = (_a = e.params) === null || _a === void 0 ? void 0 : _a.message) !== null && _b !== void 0 ? _b : `Unknown message: params=${JSON.stringify(e.params)}`;
                 const code = (_d = (_c = e.params) === null || _c === void 0 ? void 0 : _c.code) !== null && _d !== void 0 ? _d : validation_result_code_1.ValidationResultCode.GeneralResult;
                 const type = (_e = e.type) !== null && _e !== void 0 ? _e : validation_result_type_1.ValidationResultType.Violation.toString();
                 const result = new validation_result_1.ValidationResult(type, code, message);
                 result.fieldReference = (_f = e.params) === null || _f === void 0 ? void 0 : _f.fieldReference;
                 result.cost = (_g = e.params) === null || _g === void 0 ? void 0 : _g.cost;
+                result.details = (_h = e.params) === null || _h === void 0 ? void 0 : _h.details;
                 switch (type) {
                     case validation_result_type_1.ValidationResultType.Violation:
                         this.violations.push(result);

package/dist/version.d.ts

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

package/eslint.config.mjs

@@ -15,7 +15,7 @@ const compat = new FlatCompat({
 });
 
 export default [{
-    ignores: ["**/.eslintrc.cjs", "**/node_modules/", "**/dist/", "**/.eslintrc.cjs"],
+    ignores: ["**/.eslintrc.cjs", "**/node_modules/", "**/dist/", "**/.eslintrc.cjs,", "src/_examples/usage"],
 }, ...compat.extends("eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"), {
     plugins: {
         "@typescript-eslint": typescriptEslint,

package/package.json

@@ -84,11 +84,12 @@
     "coveragePathIgnorePatterns": [
       "/node_modules/",
       "/src/_test/",
+      "/src/_examples/",
       ".enum.ts",
       ".interface.ts",
       "index.ts"
     ],
     "testEnvironment": "node"
   },
-  "version": "v2.1.0"
+  "version": "v2.2.0"
 }