onroute-policy-engine 0.4.6 → 0.6.0

package/dist/enum/facts.d.ts

@@ -1,9 +1,14 @@
 export declare enum PolicyFacts {
     AllowedVehicles = "allowedVehicles",
     DaysInPermitYear = "daysInPermitYear",
+    EndOfPermitQuarter = "endOfPermitQuarter",
     ValidationDate = "validationDate",
+    ConfigurationIsValid = "configurationIsValid"
+}
+export declare enum CostFacts {
+    ConditionalFixedCost = "conditionalFixedCost",
     FixedCost = "fixedCost",
     CostPerMonth = "costPerMonth",
-    RangeMatrixCostLookup = "rangeMatrixCostLookup",
-    ConfigurationIsValid = "configurationIsValid"
+    CostPerKilometre = "costPerKilometre",
+    RangeMatrixCostLookup = "rangeMatrixCostLookup"
 }

package/dist/enum/facts.js

@@ -1,13 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PolicyFacts = void 0;
+exports.CostFacts = exports.PolicyFacts = void 0;
 var PolicyFacts;
 (function (PolicyFacts) {
     PolicyFacts["AllowedVehicles"] = "allowedVehicles";
     PolicyFacts["DaysInPermitYear"] = "daysInPermitYear";
+    PolicyFacts["EndOfPermitQuarter"] = "endOfPermitQuarter";
     PolicyFacts["ValidationDate"] = "validationDate";
-    PolicyFacts["FixedCost"] = "fixedCost";
-    PolicyFacts["CostPerMonth"] = "costPerMonth";
-    PolicyFacts["RangeMatrixCostLookup"] = "rangeMatrixCostLookup";
     PolicyFacts["ConfigurationIsValid"] = "configurationIsValid";
 })(PolicyFacts || (exports.PolicyFacts = PolicyFacts = {}));
+var CostFacts;
+(function (CostFacts) {
+    CostFacts["ConditionalFixedCost"] = "conditionalFixedCost";
+    CostFacts["FixedCost"] = "fixedCost";
+    CostFacts["CostPerMonth"] = "costPerMonth";
+    CostFacts["CostPerKilometre"] = "costPerKilometre";
+    CostFacts["RangeMatrixCostLookup"] = "rangeMatrixCostLookup";
+})(CostFacts || (exports.CostFacts = CostFacts = {}));

package/dist/enum/index.d.ts

@@ -1,5 +1,5 @@
 export { AccessoryVehicleType } from './accessory-vehicle-type';
-export { PolicyFacts } from './facts';
+export { PolicyFacts, CostFacts } from './facts';
 export { PermitAppInfo } from './permit-app-info';
 export { RelativePosition } from './relative-position';
 export { ValidationResultCode } from './validation-result-code';

package/dist/enum/index.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VehicleTypes = exports.ValidationResultType = exports.ValidationResultCode = exports.RelativePosition = exports.PermitAppInfo = exports.PolicyFacts = exports.AccessoryVehicleType = void 0;
+exports.VehicleTypes = exports.ValidationResultType = exports.ValidationResultCode = exports.RelativePosition = exports.PermitAppInfo = exports.CostFacts = exports.PolicyFacts = exports.AccessoryVehicleType = void 0;
 var accessory_vehicle_type_1 = require("./accessory-vehicle-type");
 Object.defineProperty(exports, "AccessoryVehicleType", { enumerable: true, get: function () { return accessory_vehicle_type_1.AccessoryVehicleType; } });
 var facts_1 = require("./facts");
 Object.defineProperty(exports, "PolicyFacts", { enumerable: true, get: function () { return facts_1.PolicyFacts; } });
+Object.defineProperty(exports, "CostFacts", { enumerable: true, get: function () { return facts_1.CostFacts; } });
 var permit_app_info_1 = require("./permit-app-info");
 Object.defineProperty(exports, "PermitAppInfo", { enumerable: true, get: function () { return permit_app_info_1.PermitAppInfo; } });
 var relative_position_1 = require("./relative-position");

package/dist/enum/permit-app-info.d.ts

@@ -12,5 +12,6 @@ export declare enum PermitAppInfo {
     PermitDuration = "$.permitDuration",
     PowerUnitType = "$.vehicleDetails.vehicleSubType",
     TrailerList = "$.vehicleConfiguration.trailers",
-    Commodity = "$.permittedCommodity.commodityType"
+    Commodity = "$.permittedCommodity.commodityType",
+    TotalDistance = "$.permittedRoute.manualRoute.totalDistance"
 }

package/dist/enum/permit-app-info.js

@@ -17,4 +17,5 @@ var PermitAppInfo;
     PermitAppInfo["PowerUnitType"] = "$.vehicleDetails.vehicleSubType";
     PermitAppInfo["TrailerList"] = "$.vehicleConfiguration.trailers";
     PermitAppInfo["Commodity"] = "$.permittedCommodity.commodityType";
+    PermitAppInfo["TotalDistance"] = "$.permittedRoute.manualRoute.totalDistance";
 })(PermitAppInfo || (exports.PermitAppInfo = PermitAppInfo = {}));

package/dist/helper/facts.helper.js

@@ -5,7 +5,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addRuntimeFacts = addRuntimeFacts;
 const dayjs_1 = __importDefault(require("dayjs"));
+const quarterOfYear_1 = __importDefault(require("dayjs/plugin/quarterOfYear"));
 const enum_1 = require("onroute-policy-engine/enum");
+dayjs_1.default.extend(quarterOfYear_1.default);
 /**
  * Adds runtime facts for the validation. For example, adds the
  * validation date for comparison against startDate of the permit.
@@ -25,6 +27,17 @@ function addRuntimeFacts(engine, policy) {
         const daysInPermitYear = dateFrom.add(1, 'year').diff(dateFrom, 'day');
         return daysInPermitYear;
     });
+    /**
+     * Add runtime fact to get the last day of the quarter
+     * that the permit start date falls in. Returns the date
+     * formatted as a string in the standard permit date format.
+     */
+    engine.addFact(enum_1.PolicyFacts.EndOfPermitQuarter, async function (params, almanac) {
+        const startDate = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, enum_1.PermitAppInfo.PermitStartDate);
+        const dateFrom = (0, dayjs_1.default)(startDate, enum_1.PermitAppInfo.PermitDateFormat);
+        const endOfQuarter = dateFrom.endOf('quarter');
+        return endOfQuarter.format(enum_1.PermitAppInfo.PermitDateFormat);
+    });
     /**
      * Adds a runtime fact specifying whether the vehicle configuration
      * in the permit application is valid for the permit type and
@@ -52,15 +65,29 @@ function addRuntimeFacts(engine, policy) {
      * Add runtime fact for a fixed permit cost, the cost supplied
      * as a parameter.
      */
-    engine.addFact(enum_1.PolicyFacts.FixedCost.toString(), async function (params) {
+    engine.addFact(enum_1.CostFacts.FixedCost.toString(), async function (params) {
         return params.cost;
     });
+    /**
+     * Add runtime fact for a conditional fixed permit cost, where the
+     * cost rule applied only when the fact and value supplied as parameters
+     * match.
+     */
+    engine.addFact(enum_1.CostFacts.ConditionalFixedCost.toString(), async function (params, almanac) {
+        const conditionValue = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, params.fact);
+        if (conditionValue && conditionValue === params.value) {
+            return params.cost;
+        }
+        else {
+            return 0;
+        }
+    });
     /**
      * Add runtime fact for cost per month, where month is defined by
      * policy as a 30 day period or portion thereof, except in the
      * case of a full year in which case it is 12 months.
      */
-    engine.addFact(enum_1.PolicyFacts.CostPerMonth.toString(), async function (params, almanac) {
+    engine.addFact(enum_1.CostFacts.CostPerMonth.toString(), async function (params, almanac) {
         const duration = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, enum_1.PermitAppInfo.PermitDuration);
         const daysInPermitYear = await almanac.factValue(enum_1.PolicyFacts.DaysInPermitYear.toString());
         let months = Math.floor(duration / 30);
@@ -74,4 +101,18 @@ function addRuntimeFacts(engine, policy) {
         }
         return months * params.cost;
     });
+    /**
+     * Add runtime fact for cost per kilometre driven in the applicant's
+     * permitted route. Accepts an optional parameter minValue which
+     * specifies the minimum value for the permit if the kilometre cost
+     * is less than that value.
+     */
+    engine.addFact(enum_1.CostFacts.CostPerKilometre.toString(), async function (params, almanac) {
+        const distance = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, enum_1.PermitAppInfo.TotalDistance);
+        let cost = distance * params.cost;
+        if (typeof params.minValue === 'number') {
+            cost = Math.max(cost, params.minValue);
+        }
+        return cost;
+    });
 }

package/package.json

@@ -86,5 +86,5 @@
     ],
     "testEnvironment": "node"
   },
-  "version": "v0.4.6"
+  "version": "v0.6.0"
 }