onroute-policy-engine 2.1.0 → 2.1.1

package/dist/helper/display-code-helper.d.ts

@@ -1,4 +1,46 @@
 import { Policy } from 'onroute-policy-engine';
 import { AxleConfiguration } from 'onroute-policy-engine/types';
+/**
+ * Helper function to generate a vehicle display code based on the vehicle configuration and axle configuration.
+ *
+ * This function determines whether to generate a standard display code (for known vehicle types with
+ * configured display codes) or a universal display code (for complex or unknown configurations).
+ *
+ * @param policy The Policy instance containing vehicle definitions and display code defaults.
+ * @param configuration Array of vehicle type identifiers representing the vehicle configuration.
+ *                      The first element should be a power unit type, followed by trailer types.
+ * @param axleConfiguration Array of axle configurations corresponding to each vehicle in the configuration.
+ *                          Each axle configuration contains details like number of axles, spacing, etc.
+ * @returns A string representing the vehicle display code, or an empty string if the configuration is empty.
+ *
+ * @throws {Error} If vehicleDisplayCodeDefaults is not configured in the policy definition.
+ */
 export declare function getVehicleDisplayCodeHelper(policy: Policy, configuration: Array<string>, axleConfiguration: Array<AxleConfiguration>): string;
+/**
+ * Generates a universal display code for vehicle configurations that cannot use the standard display code format.
+ *
+ * Universal display codes are used when:
+ * - Vehicle types are unknown or don't have configured display codes
+ * - Axle configurations exceed the maximum standard axle count
+ * - Vehicle configuration doesn't match the expected pattern
+ *
+ * The universal format uses generic symbols and spacing indicators to represent the axle configuration
+ * in a standardized way that can handle complex or unusual vehicle setups.
+ *
+ * @param policy The Policy instance containing display code defaults configuration.
+ * @param axleConfiguration Array of axle configurations representing the vehicle's axle setup.
+ *                          Each configuration contains details like number of axles, spacing, etc.
+ * @returns A string representing the universal vehicle display code, or an empty string if the axle configuration is empty.
+ *
+ * @throws {Error} If vehicleDisplayCodeDefaults is not configured in the policy definition.
+ *
+ * @example
+ * // For a complex axle configuration
+ * const code = getUniversalDisplayCode(policy, [
+ *   { numberOfAxles: 2, interaxleSpacing: 1.8, ... },
+ *   { numberOfAxles: 3, interaxleSpacing: 4.2, ... },
+ *   { numberOfAxles: 5, interaxleSpacing: 3.0, ... } // Exceeds standard threshold
+ * ]);
+ * // Returns something like "U2U1MU3U2MU5+U3" where U represents universal axle codes
+ */
 export declare function getUniversalDisplayCode(policy: Policy, axleConfiguration: Array<AxleConfiguration>): string;

package/dist/helper/display-code-helper.js

@@ -2,6 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getVehicleDisplayCodeHelper = getVehicleDisplayCodeHelper;
 exports.getUniversalDisplayCode = getUniversalDisplayCode;
+/**
+ * Helper function to generate a vehicle display code based on the vehicle configuration and axle configuration.
+ *
+ * This function determines whether to generate a standard display code (for known vehicle types with
+ * configured display codes) or a universal display code (for complex or unknown configurations).
+ *
+ * @param policy The Policy instance containing vehicle definitions and display code defaults.
+ * @param configuration Array of vehicle type identifiers representing the vehicle configuration.
+ *                      The first element should be a power unit type, followed by trailer types.
+ * @param axleConfiguration Array of axle configurations corresponding to each vehicle in the configuration.
+ *                          Each axle configuration contains details like number of axles, spacing, etc.
+ * @returns A string representing the vehicle display code, or an empty string if the configuration is empty.
+ *
+ * @throws {Error} If vehicleDisplayCodeDefaults is not configured in the policy definition.
+ */
 function getVehicleDisplayCodeHelper(policy, configuration, axleConfiguration) {
     if (!policy.policyDefinition.vehicleDisplayCodeDefaults) {
         throw new Error('Unable to construct vehicle display code; missing vehicleDisplayCodeDefaults in policy configuration');
@@ -65,6 +80,33 @@ function getVehicleDisplayCodeHelper(policy, configuration, axleConfiguration) {
         return getUniversalDisplayCode(policy, axleConfiguration);
     }
 }
+/**
+ * Generates a universal display code for vehicle configurations that cannot use the standard display code format.
+ *
+ * Universal display codes are used when:
+ * - Vehicle types are unknown or don't have configured display codes
+ * - Axle configurations exceed the maximum standard axle count
+ * - Vehicle configuration doesn't match the expected pattern
+ *
+ * The universal format uses generic symbols and spacing indicators to represent the axle configuration
+ * in a standardized way that can handle complex or unusual vehicle setups.
+ *
+ * @param policy The Policy instance containing display code defaults configuration.
+ * @param axleConfiguration Array of axle configurations representing the vehicle's axle setup.
+ *                          Each configuration contains details like number of axles, spacing, etc.
+ * @returns A string representing the universal vehicle display code, or an empty string if the axle configuration is empty.
+ *
+ * @throws {Error} If vehicleDisplayCodeDefaults is not configured in the policy definition.
+ *
+ * @example
+ * // For a complex axle configuration
+ * const code = getUniversalDisplayCode(policy, [
+ *   { numberOfAxles: 2, interaxleSpacing: 1.8, ... },
+ *   { numberOfAxles: 3, interaxleSpacing: 4.2, ... },
+ *   { numberOfAxles: 5, interaxleSpacing: 3.0, ... } // Exceeds standard threshold
+ * ]);
+ * // Returns something like "U2U1MU3U2MU5+U3" where U represents universal axle codes
+ */
 function getUniversalDisplayCode(policy, axleConfiguration) {
     const defs = policy.policyDefinition.vehicleDisplayCodeDefaults;
     if (!defs) {
@@ -93,7 +135,7 @@ function getUniversalDisplayCode(policy, axleConfiguration) {
                 displayCodeTokens.push(defs.spacingUniversalDefault);
             }
         }
-        if (a.numberOfAxles >= defs.thresholdAxlesUniversal) {
+        if (a.numberOfAxles > defs.thresholdAxlesUniversal) {
             // The number of axles in this axle unit is above the threshold
             // for the number of axles that can be represented by the simple
             // universal formula
@@ -140,6 +182,36 @@ function getUniversalDisplayCode(policy, axleConfiguration) {
     });
     return displayCodeTokens.join('');
 }
+/**
+ * Determines whether a standard display code can be generated for the given vehicle configuration.
+ *
+ * A standard display code can be created when:
+ * - All vehicle types are known and have configured display codes
+ * - The power unit has all required display code properties (prefix, steer axle, drive axle)
+ * - All trailers have display codes (unless they're marked to ignore for axle calculation)
+ * - No axle configuration exceeds the maximum standard axle count
+ * - The number of axle configurations matches the number of non-ignorable vehicles plus one
+ *
+ * @param policy The Policy instance containing vehicle definitions and display code defaults.
+ * @param configuration Array of vehicle type identifiers representing the vehicle configuration.
+ *                      The first element should be a power unit type, followed by trailer types.
+ * @param axleConfiguration Array of axle configurations corresponding to each vehicle in the configuration.
+ *                          Each axle configuration contains details like number of axles, spacing, etc.
+ * @returns True if a standard display code can be generated, false if a universal display code is required.
+ *
+ * @example
+ * // Returns true for a standard truck-tractor with semi-trailer
+ * canCreateStandardCode(policy, ['TRKTRAC', 'SEMI'], [
+ *   { numberOfAxles: 2, ... }, // Steer axle
+ *   { numberOfAxles: 3, ... }, // Drive axle
+ *   { numberOfAxles: 3, ... }  // Trailer axle
+ * ]);
+ *
+ * // Returns false for unknown vehicle types or complex configurations
+ * canCreateStandardCode(policy, ['UNKNOWN'], [
+ *   { numberOfAxles: 10, ... } // Exceeds standard threshold
+ * ]);
+ */
 function canCreateStandardCode(policy, configuration, axleConfiguration) {
     var _a;
     // Check that all of the vehicle types are known,

package/dist/policy-engine.d.ts

@@ -245,5 +245,30 @@ export declare class Policy {
      * none are configured
      */
     getStandardTireSizes(): Array<StandardTireSize>;
+    /**
+     * Generates a vehicle display code based on the vehicle configuration and axle configuration.
+     *
+     * The display code is a string representation that describes the vehicle configuration
+     * in a standardized format. It can generate either a standard display code (for known
+     * vehicle types with configured display codes) or a universal display code (for complex
+     * or unknown configurations).
+     *
+     * @param configuration Array of vehicle type identifiers representing the vehicle configuration.
+     *                      The first element should be a power unit type, followed by trailer types.
+     * @param axleConfiguration Array of axle configurations corresponding to each vehicle in the configuration.
+     *                          Each axle configuration contains details like number of axles, spacing, etc.
+     * @returns A string representing the vehicle display code, or an empty string if the configuration is empty.
+     *
+     * @example
+     * // For a truck-tractor with 2-axle steer, 3-axle drive, and a 3-axle semi-trailer
+     * const code = policy.getVehicleDisplayCode(['TRKTRAC'], [
+     *   { numberOfAxles: 2, axleSpread: 1.8, ... },
+     *   { numberOfAxles: 3, axleSpread: 4.2, ... },
+     *   { numberOfAxles: 3, axleSpread: 3.0, ... }
+     * ]);
+     * // Returns something like "TT2S13D23T3"
+     *
+     * @throws {Error} If vehicleDisplayCodeDefaults is not configured in the policy definition.
+     */
     getVehicleDisplayCode(configuration: Array<string>, axleConfiguration: Array<AxleConfiguration>): string;
 }

package/dist/policy-engine.js

@@ -749,6 +749,31 @@ class Policy {
             return new Array();
         }
     }
+    /**
+     * Generates a vehicle display code based on the vehicle configuration and axle configuration.
+     *
+     * The display code is a string representation that describes the vehicle configuration
+     * in a standardized format. It can generate either a standard display code (for known
+     * vehicle types with configured display codes) or a universal display code (for complex
+     * or unknown configurations).
+     *
+     * @param configuration Array of vehicle type identifiers representing the vehicle configuration.
+     *                      The first element should be a power unit type, followed by trailer types.
+     * @param axleConfiguration Array of axle configurations corresponding to each vehicle in the configuration.
+     *                          Each axle configuration contains details like number of axles, spacing, etc.
+     * @returns A string representing the vehicle display code, or an empty string if the configuration is empty.
+     *
+     * @example
+     * // For a truck-tractor with 2-axle steer, 3-axle drive, and a 3-axle semi-trailer
+     * const code = policy.getVehicleDisplayCode(['TRKTRAC'], [
+     *   { numberOfAxles: 2, axleSpread: 1.8, ... },
+     *   { numberOfAxles: 3, axleSpread: 4.2, ... },
+     *   { numberOfAxles: 3, axleSpread: 3.0, ... }
+     * ]);
+     * // Returns something like "TT2S13D23T3"
+     *
+     * @throws {Error} If vehicleDisplayCodeDefaults is not configured in the policy definition.
+     */
     getVehicleDisplayCode(configuration, axleConfiguration) {
         return (0, display_code_helper_1.getVehicleDisplayCodeHelper)(this, configuration, axleConfiguration);
     }

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "v2.1.0";
+export declare const version = "v2.1.1";

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.1.1';

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

@@ -90,5 +90,5 @@
     ],
     "testEnvironment": "node"
   },
-  "version": "v2.1.0"
+  "version": "v2.1.1"
 }