onroute-policy-engine 2.1.0 → 2.2.0

package/dist/types/geographic-region.d.ts

@@ -1,4 +1,14 @@
+/**
+ * Geographic Region Type
+ *
+ * Defines the structure for geographic regions used in permit routing and validation.
+ * Extends IdentifiedObject with optional description for enhanced identification.
+ */
 import { IdentifiedObject } from 'onroute-policy-engine/types';
+/**
+ * A geographic region with identification and optional description
+ */
 export type GeographicRegion = IdentifiedObject & {
+    /** Optional description of the geographic region */
     description?: string;
 };

package/dist/types/geographic-region.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * Geographic Region Type
+ *
+ * Defines the structure for geographic regions used in permit routing and validation.
+ * Extends IdentifiedObject with optional description for enhanced identification.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/identified-object.d.ts

@@ -1,4 +1,12 @@
+/**
+ * Identified Object Type
+ *
+ * Base type for objects that require unique identification and naming.
+ * Used as a foundation for many other types in the system.
+ */
 export type IdentifiedObject = {
+    /** Unique identifier for the object */
     id: string;
+    /** Human-readable name for the object */
     name: string;
 };

package/dist/types/identified-object.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * Identified Object Type
+ *
+ * Base type for objects that require unique identification and naming.
+ * Used as a foundation for many other types in the system.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+export { AxleCalcResults, PolicyCheckResult, AxleUnitPolicyCheckResult, AxleGroupPolicyCheckResult, } from './axle-calculation-results';
 export { AxleConfiguration } from './axle-configuration';
 export { BridgeCalculationConstants } from './bridge-calculation-constants';
 export { BridgeCalculationResult } from './bridge-calculation-result';

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

@@ -1,93 +1,202 @@
+/**
+ * Permit Application Types
+ *
+ * Defines the complete structure for permit applications including contact details,
+ * vehicle information, routing, and configuration data.
+ */
 import { AxleConfiguration } from 'onroute-policy-engine/types';
+/**
+ * Mailing address for permit correspondence
+ */
 export type PermitMailingAddress = {
+    /** Primary address line */
     addressLine1: string;
+    /** Secondary address line (optional) */
     addressLine2?: string | null;
+    /** City name */
     city: string;
+    /** Province/state code (e.g., 'BC', 'AB') */
     provinceCode: string;
+    /** Country code (e.g., 'CA', 'US') */
     countryCode: string;
+    /** Postal/zip code */
     postalCode: string;
 };
+/**
+ * Contact information for the permit applicant
+ */
 export type PermitContactDetails = {
+    /** Contact's first name */
     firstName: string;
+    /** Contact's last name */
     lastName: string;
+    /** Primary phone number */
     phone1: string;
+    /** Primary phone extension (optional) */
     phone1Extension?: string | null;
+    /** Secondary phone number (optional) */
     phone2?: string | null;
+    /** Secondary phone extension (optional) */
     phone2Extension?: string | null;
+    /** Primary email address */
     email: string;
+    /** Additional email address (optional) */
     additionalEmail?: string | null;
+    /** Fax number (optional) */
     fax?: string | null;
 };
+/**
+ * Detailed information about the vehicle in the permit application
+ */
 export type PermitVehicleDetails = {
+    /** Internal vehicle identifier (optional) */
     vehicleId?: string | null;
+    /** Unit number for fleet vehicles (optional) */
     unitNumber?: string | null;
+    /** Vehicle Identification Number */
     vin: string;
+    /** License plate number */
     plate: string;
+    /** Vehicle make (optional) */
     make?: string | null;
+    /** Vehicle model year (optional) */
     year?: number | null;
+    /** Country code where vehicle is registered */
     countryCode: string;
+    /** Province/state code where vehicle is registered */
     provinceCode: string;
+    /** Type of vehicle (e.g., 'powerUnit', 'trailer') */
     vehicleType: string;
+    /** Subtype of vehicle (e.g., 'TRKTRAC', 'SEMITRL') */
     vehicleSubType: string;
+    /** Licensed Gross Vehicle Weight in kilograms (optional) */
     licensedGVW?: number | null;
+    /** Whether to save this vehicle to the inventory (optional) */
     saveVehicle?: boolean | null;
 };
+/**
+ * Commodity information for the permit application
+ */
 export type PermitCommodity = {
+    /** Description of the commodity being transported */
     description: string;
+    /** Special conditions for the commodity */
     condition: string;
+    /** Link to detailed commodity conditions */
     conditionLink: string;
+    /** Whether this commodity is selected */
     checked: boolean;
+    /** Whether this commodity option is disabled */
     disabled: boolean;
 };
+/**
+ * Complete permit data including all application details
+ */
 export type PermitData = {
+    /** Company name applying for the permit */
     companyName: string;
+    /** Doing Business As name (optional) */
     doingBusinessAs?: string;
+    /** Client number for the company */
     clientNumber: string;
+    /** Duration of the permit in days */
     permitDuration: number;
+    /** Array of commodities being transported */
     commodities: Array<PermitCommodity>;
+    /** Contact details for the applicant */
     contactDetails: PermitContactDetails;
+    /** Mailing address for correspondence */
     mailingAddress: PermitMailingAddress;
+    /** Detailed vehicle information */
     vehicleDetails: PermitVehicleDetails;
+    /** Fee summary information (optional) */
     feeSummary?: string | null;
+    /** Permit start date (YYYY-MM-DD format) */
     startDate: string;
+    /** Permit expiry date (YYYY-MM-DD format, optional) */
     expiryDate?: string | null;
+    /** Selected permitted commodity (optional) */
     permittedCommodity?: PermittedCommodity | null;
+    /** Vehicle configuration details (optional) */
     vehicleConfiguration?: VehicleConfiguration | null;
+    /** Permitted route information (optional) */
     permittedRoute?: PermittedRoute | null;
+    /** Additional application notes (optional) */
     applicationNotes?: string | null;
+    /** Third party liability information (optional) */
     thirdPartyLiability?: string | null;
+    /** Conditional licensing fee information (optional) */
     conditionalLicensingFee?: string | null;
 };
+/**
+ * Selected commodity for the permit with load description
+ */
 export type PermittedCommodity = {
+    /** Type of commodity being transported */
     commodityType: string;
+    /** Description of the load being transported */
     loadDescription: string;
 };
+/**
+ * Vehicle configuration within the permit application
+ */
 export type VehicleInConfiguration = {
+    /** Subtype of the vehicle */
     vehicleSubType: string;
 };
+/**
+ * Complete vehicle configuration including dimensions and axles
+ */
 export type VehicleConfiguration = {
+    /** Overall length in meters (optional) */
     overallLength?: number;
+    /** Overall width in meters (optional) */
     overallWidth?: number;
+    /** Overall height in meters (optional) */
     overallHeight?: number;
+    /** Front projection in meters (optional) */
     frontProjection?: number;
+    /** Rear projection in meters (optional) */
     rearProjection?: number;
+    /** Array of trailers in the configuration (optional) */
     trailers?: Array<VehicleInConfiguration> | null;
+    /** Loaded Gross Vehicle Weight in kilograms (optional) */
     loadedGVW?: number;
+    /** Net weight in kilograms (optional) */
     netWeight?: number;
+    /** Axle configuration details (optional) */
     axleConfiguration?: Array<AxleConfiguration>;
 };
+/**
+ * Route information for the permit
+ */
 export type PermittedRoute = {
+    /** Manual route details (optional) */
     manualRoute?: ManualRoute | null;
+    /** Additional route details (optional) */
     routeDetails?: string | null;
 };
+/**
+ * Manual route configuration with highway sequence
+ */
 export type ManualRoute = {
+    /** Sequence of highways for the route */
     highwaySequence: Array<string>;
+    /** Origin point of the route */
     origin: string;
+    /** Destination point of the route */
     destination: string;
+    /** Exit point from the route (optional) */
     exitPoint?: string;
+    /** Total distance in kilometers (optional) */
     totalDistance?: number;
 };
+/**
+ * Complete permit application structure
+ */
 export type PermitApplication = {
+    /** All permit data and details */
     permitData: PermitData;
+    /** Type of permit being applied for */
     permitType: string;
 };

package/dist/types/permit-application.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * Permit Application Types
+ *
+ * Defines the complete structure for permit applications including contact details,
+ * vehicle information, routing, and configuration data.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,10 +1,28 @@
+/**
+ * Permit Condition Types
+ *
+ * Defines the structure for permit conditions and requirements that must be met
+ * for permit approval and compliance.
+ */
 export type PermitConditionDefinition = {
+    /** Human-readable description of the condition */
     description: string;
+    /** Specific condition text that must be met */
     condition: string;
+    /** Link to detailed condition information */
     conditionLink: string;
 };
+/**
+ * Requirement for a permit condition including mandatory status
+ */
 export type ConditionRequirement = {
+    /** The condition text that must be satisfied */
     condition: string;
+    /** Whether this condition is mandatory for permit approval */
     mandatory?: boolean;
 };
+/**
+ * Complete permit condition combining definition and requirement
+ * Extends PermitConditionDefinition with requirement details
+ */
 export type ConditionForPermit = PermitConditionDefinition & ConditionRequirement;

package/dist/types/permit-condition.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * Permit Condition Types
+ *
+ * Defines the structure for permit conditions and requirements that must be met
+ * for permit approval and compliance.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,13 +1,31 @@
+/**
+ * Permit Type
+ *
+ * Defines the structure for permit types including requirements, allowed vehicles,
+ * commodities, rules, and conditions. Extends IdentifiedObject with permit-specific properties.
+ */
 import { RuleProperties } from 'json-rules-engine';
 import { CostRule, IdentifiedObject, ConditionRequirement } from 'onroute-policy-engine/types';
+/**
+ * Complete definition of a permit type with all requirements and configurations
+ */
 export type PermitType = IdentifiedObject & {
+    /** Whether routing information is required for this permit type */
     routingRequired: boolean;
+    /** Whether weight dimension information is required for this permit type */
     weightDimensionRequired: boolean;
+    /** Whether size dimension information is required for this permit type */
     sizeDimensionRequired: boolean;
+    /** Whether commodity information is required for this permit type */
     commodityRequired: boolean;
+    /** Array of allowed vehicle types for this permit (optional) */
     allowedVehicles?: Array<string>;
+    /** Array of allowed commodities for this permit (optional) */
     allowedCommodities?: Array<string>;
+    /** Array of validation rules for this permit type (optional) */
     rules?: Array<RuleProperties>;
+    /** Array of cost calculation rules for this permit type (optional) */
     costRules?: Array<CostRule>;
+    /** Array of conditions that must be met for this permit type (optional) */
     conditions?: Array<ConditionRequirement>;
 };

package/dist/types/permit-type.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * Permit Type
+ *
+ * Defines the structure for permit types including requirements, allowed vehicles,
+ * commodities, rules, and conditions. Extends IdentifiedObject with permit-specific properties.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,18 +1,42 @@
+/**
+ * Policy Definition Type
+ *
+ * Defines the complete structure for policy definitions including geographic regions,
+ * permit types, rules, defaults, and configurations. This is the main configuration
+ * type for the policy engine.
+ */
 import { GeographicRegion, PermitType, DefaultWeightDimensions, VehicleTypes, Commodity, SizeDimension, VehicleCategories, RangeMatrix, BridgeCalculationConstants, PermitConditionDefinition, StandardTireSize, VehicleDisplayCodeDefaults } from 'onroute-policy-engine/types';
 import { RuleProperties } from 'json-rules-engine';
+/**
+ * Complete policy definition containing all configuration data for the policy engine
+ */
 export type PolicyDefinition = {
+    /** Minimum required policy engine version for compatibility */
     minPEVersion: string;
+    /** Array of geographic regions having specific policy rules */
     geographicRegions: Array<GeographicRegion>;
+    /** Array of permit types available in this policy */
     permitTypes: Array<PermitType>;
+    /** Array of common rules that apply to all permits */
     commonRules: Array<RuleProperties>;
+    /** Global default weight dimensions for vehicles */
     globalWeightDefaults: DefaultWeightDimensions;
+    /** Global default size dimensions for vehicles */
     globalSizeDefaults: SizeDimension;
+    /** Vehicle categories configuration */
     vehicleCategories: VehicleCategories;
+    /** Vehicle types configuration */
     vehicleTypes: VehicleTypes;
+    /** Array of commodities that can be transported */
     commodities: Array<Commodity>;
+    /** Array of range matrices for cost calculations (optional) */
     rangeMatrices?: Array<RangeMatrix>;
+    /** Constants for bridge formula calculations */
     bridgeCalculationConstants: BridgeCalculationConstants;
+    /** Array of permit conditions (optional) */
     conditions?: Array<PermitConditionDefinition>;
+    /** Array of standard tire sizes (optional) */
     standardTireSizes?: Array<StandardTireSize>;
+    /** Default configuration for vehicle display codes (optional) */
     vehicleDisplayCodeDefaults?: VehicleDisplayCodeDefaults;
 };

package/dist/types/policy-definition.js

@@ -1,2 +1,9 @@
 "use strict";
+/**
+ * Policy Definition Type
+ *
+ * Defines the complete structure for policy definitions including geographic regions,
+ * permit types, rules, defaults, and configurations. This is the main configuration
+ * type for the policy engine.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/range-matrix.d.ts

@@ -1,9 +1,26 @@
+/**
+ * Range Matrix Types
+ *
+ * Defines structures for range-based calculations and lookups used in cost
+ * calculations and other policy determinations.
+ */
 import { IdentifiedObject } from 'onroute-policy-engine/types';
+/**
+ * A range matrix containing multiple matrix entries for lookups
+ * Extends IdentifiedObject with matrix data
+ */
 export type RangeMatrix = IdentifiedObject & {
+    /** Array of matrix entries for range-based lookups */
     matrix: Matrix[];
 };
+/**
+ * Individual matrix entry with range and value
+ */
 export type Matrix = {
+    /** Minimum value for the range (optional) */
     min?: number;
+    /** Maximum value for the range (optional) */
     max?: number;
+    /** Value associated with this range */
     value: number;
 };

package/dist/types/range-matrix.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * Range Matrix Types
+ *
+ * Defines structures for range-based calculations and lookups used in cost
+ * calculations and other policy determinations.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/region-size-override.d.ts

@@ -1,6 +1,16 @@
+/**
+ * Region Size Override Type
+ *
+ * Defines size dimension overrides for specific geographic regions.
+ * Used to apply region-specific size limits and requirements.
+ */
 export type RegionSizeOverride = {
+    /** Geographic region identifier */
     region: string;
+    /** Width override in meters (optional) */
     w?: number;
+    /** Height override in meters (optional) */
     h?: number;
+    /** Length override in meters (optional) */
     l?: number;
 };

package/dist/types/region-size-override.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * Region Size Override Type
+ *
+ * Defines size dimension overrides for specific geographic regions.
+ * Used to apply region-specific size limits and requirements.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/self-issuable.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Self Issuable Type
+ *
+ * Defines the capability for self-issuance of permits or other documents.
+ * Used as a base type for objects that can be self-issued.
+ */
 export type SelfIssuable = {
+    /** Whether this object can be self-issued */
     selfIssue?: boolean;
 };

package/dist/types/self-issuable.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * Self Issuable Type
+ *
+ * Defines the capability for self-issuance of permits or other documents.
+ * Used as a base type for objects that can be self-issued.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,10 +1,27 @@
+/**
+ * Size Dimension Type
+ *
+ * Defines the structure for vehicle size dimensions including length, width, height,
+ * projections, and regional overrides. Extends SelfIssuable for self-issuance capability.
+ */
 import { DimensionModifier, RegionSizeOverride, SelfIssuable } from 'onroute-policy-engine/types';
+/**
+ * Complete size dimension configuration for vehicles
+ * Extends SelfIssuable to include self-issuance capability
+ */
 export type SizeDimension = SelfIssuable & {
+    /** Front projection in meters (optional) */
     fp?: number;
+    /** Rear projection in meters (optional) */
     rp?: number;
+    /** Width in meters (optional) */
     w?: number;
+    /** Height in meters (optional) */
     h?: number;
+    /** Length in meters (optional) */
     l?: number;
+    /** Array of dimension modifiers for special configurations (optional) */
     modifiers?: Array<DimensionModifier>;
+    /** Array of regional size overrides (optional) */
     regions?: Array<RegionSizeOverride>;
 };

package/dist/types/size-dimension.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * Size Dimension Type
+ *
+ * Defines the structure for vehicle size dimensions including length, width, height,
+ * projections, and regional overrides. Extends SelfIssuable for self-issuance capability.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,5 +1,14 @@
+/**
+ * Special Authorizations Type
+ *
+ * Defines special authorizations and exemptions for companies including
+ * LCV (Long Combination Vehicle) allowances and fee exemptions.
+ */
 export type SpecialAuthorizations = {
+    /** Company identifier */
     companyId: number;
+    /** Whether LCV (Long Combination Vehicle) operations are allowed */
     isLcvAllowed: boolean;
+    /** Type of fee exemption if applicable, null if no exemption */
     noFeeType: string | null;
 };

package/dist/types/special-authorizations.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * Special Authorizations Type
+ *
+ * Defines special authorizations and exemptions for companies including
+ * LCV (Long Combination Vehicle) allowances and fee exemptions.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/standard-tire-size.d.ts

@@ -1,4 +1,12 @@
+/**
+ * Standard Tire Size Type
+ *
+ * Defines the structure for standard tire sizes used in vehicle configurations
+ * and axle calculations.
+ */
 export type StandardTireSize = {
+    /** Name of the tire size (e.g., '11R22.5') */
     name: string;
+    /** Tire size in inches (e.g., 22.5 for 11R22.5) */
     size: number;
 };

package/dist/types/standard-tire-size.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * Standard Tire Size Type
+ *
+ * Defines the structure for standard tire sizes used in vehicle configurations
+ * and axle calculations.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,15 +1,42 @@
+/**
+ * Vehicle Category Types
+ *
+ * Defines the structure for vehicle categories including power units and trailers.
+ * Extends IdentifiedObject with size and weight dimension defaults.
+ */
 import { IdentifiedObject, SizeDimension, PowerUnitWeightDimension, TrailerWeightDimension, WeightDimension } from 'onroute-policy-engine/types';
+/**
+ * Base vehicle category with identification and default dimensions
+ * Extends IdentifiedObject with dimension defaults
+ */
 export type VehicleCategory = IdentifiedObject & {
+    /** Default size dimensions for this vehicle category (optional) */
     defaultSizeDimensions?: SizeDimension;
+    /** Default weight dimensions for this vehicle category (optional) */
     defaultWeightDimensions?: Array<WeightDimension>;
 };
+/**
+ * Power unit category with power unit specific weight dimensions
+ * Extends VehicleCategory with power unit weight defaults
+ */
 export type PowerUnitCategory = VehicleCategory & {
+    /** Default weight dimensions specific to power units (optional) */
     defaultWeightDimensions?: Array<PowerUnitWeightDimension>;
 };
+/**
+ * Trailer category with trailer specific weight dimensions
+ * Extends VehicleCategory with trailer weight defaults
+ */
 export type TrailerCategory = VehicleCategory & {
+    /** Default weight dimensions specific to trailers (optional) */
     defaultWeightDimensions?: Array<TrailerWeightDimension>;
 };
+/**
+ * Complete vehicle categories configuration
+ */
 export type VehicleCategories = {
+    /** Array of power unit categories */
     powerUnitCategories: Array<PowerUnitCategory>;
+    /** Array of trailer categories */
     trailerCategories: Array<TrailerCategory>;
 };

package/dist/types/vehicle-category.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * Vehicle Category Types
+ *
+ * Defines the structure for vehicle categories including power units and trailers.
+ * Extends IdentifiedObject with size and weight dimension defaults.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });