onroute-policy-engine 2.24.0 → 2.24.2

package/dist/helper/date.helper.d.ts

@@ -0,0 +1,28 @@
+import { Dayjs } from 'dayjs';
+export declare const TIMEZONE_IDS: {
+    PACIFIC: string;
+};
+export declare const DATE_FORMATS: {
+    DATE_ONLY: string;
+    DATETIME: string;
+};
+/**
+ * Convert a datetime to a specified timezone.
+ *
+ * @param datetime Datetime to be converted
+ * @param timezoneId Timezone identifier (eg. 'Canada/Pacific')
+ * @returns Dayjs object in the specified timezone
+ */
+export declare const convertToTimezone: (datetime: string | Dayjs | Date, timezoneId: string) => Dayjs;
+/**
+ * Get UTC datetime.
+ *
+ * @returns Dayjs object representing datetime in UTC
+ */
+export declare const getUtcDatetime: (datetime?: Dayjs | Date | string) => Dayjs;
+/**
+ * Get datetime representing the end of the quarter for a given datetime.
+ * @param datetime Datetime being used for reference
+ * @returns Dayjs object representing the end of the quarter for the inputted datetime
+ */
+export declare const getEndOfQuarter: (datetime: Dayjs) => Dayjs;

package/dist/helper/date.helper.js

@@ -0,0 +1,51 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEndOfQuarter = exports.getUtcDatetime = exports.convertToTimezone = exports.DATE_FORMATS = exports.TIMEZONE_IDS = void 0;
+const dayjs_1 = __importDefault(require("dayjs"));
+const utc_1 = __importDefault(require("dayjs/plugin/utc"));
+const timezone_1 = __importDefault(require("dayjs/plugin/timezone"));
+const duration_1 = __importDefault(require("dayjs/plugin/duration"));
+const quarterOfYear_1 = __importDefault(require("dayjs/plugin/quarterOfYear"));
+dayjs_1.default.extend(utc_1.default);
+dayjs_1.default.extend(timezone_1.default);
+dayjs_1.default.extend(duration_1.default);
+dayjs_1.default.extend(quarterOfYear_1.default);
+exports.TIMEZONE_IDS = {
+    PACIFIC: 'Canada/Pacific',
+};
+exports.DATE_FORMATS = {
+    DATE_ONLY: 'YYYY-MM-DD',
+    DATETIME: 'YYYY-MM-DD HH:mm:ss',
+};
+/**
+ * Convert a datetime to a specified timezone.
+ *
+ * @param datetime Datetime to be converted
+ * @param timezoneId Timezone identifier (eg. 'Canada/Pacific')
+ * @returns Dayjs object in the specified timezone
+ */
+const convertToTimezone = (datetime, timezoneId) => {
+    return dayjs_1.default.tz(datetime, timezoneId);
+};
+exports.convertToTimezone = convertToTimezone;
+/**
+ * Get UTC datetime.
+ *
+ * @returns Dayjs object representing datetime in UTC
+ */
+const getUtcDatetime = (datetime) => {
+    return dayjs_1.default.utc(datetime);
+};
+exports.getUtcDatetime = getUtcDatetime;
+/**
+ * Get datetime representing the end of the quarter for a given datetime.
+ * @param datetime Datetime being used for reference
+ * @returns Dayjs object representing the end of the quarter for the inputted datetime
+ */
+const getEndOfQuarter = (datetime) => {
+    return datetime.endOf('quarter');
+};
+exports.getEndOfQuarter = getEndOfQuarter;

package/dist/helper/date.helper.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/helper/date.helper.spec.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const date_helper_1 = require("./date.helper");
+describe('Date Helper Tests', () => {
+    it('should have correct local datetime components when converting datetime string', () => {
+        const localDtStr = '2026-08-10';
+        const localTzId = date_helper_1.TIMEZONE_IDS.PACIFIC;
+        const localDt = (0, date_helper_1.convertToTimezone)(localDtStr, localTzId);
+        expect(localDt.year()).toBe(2026);
+        expect(localDt.month()).toBe(7);
+        expect(localDt.date()).toBe(10);
+        expect(localDt.hour()).toBe(0);
+        expect(localDt.minute()).toBe(0);
+        expect(localDt.second()).toBe(0);
+    });
+    it('should have correct local datetime components when converting UTC datetime', () => {
+        const utcDtStr = '2026-08-10 22:00:00';
+        const utcDt = (0, date_helper_1.getUtcDatetime)(utcDtStr);
+        const localTzId = date_helper_1.TIMEZONE_IDS.PACIFIC;
+        const localConvertedDt = (0, date_helper_1.convertToTimezone)(utcDt, localTzId);
+        expect(utcDt.hour()).toBe(22);
+        expect(localConvertedDt.hour()).toBe(15);
+        expect(localConvertedDt.date()).toBe(utcDt.date());
+        expect(utcDt.diff(localConvertedDt)).toBe(0);
+    });
+});

package/dist/helper/facts.helper.js

@@ -1,16 +1,11 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": 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");
 const policy_check_helper_1 = require("./policy-check.helper");
 const stgvwi_1 = require("../constants/stgvwi");
 const overload_1 = require("../constants/overload");
-dayjs_1.default.extend(quarterOfYear_1.default);
+const date_helper_1 = require("./date.helper");
 const getAxleCalculationInputs = async (policy, almanac) => {
     var _a, _b;
     const vehicleDetails = await almanac.factValue(enum_1.PermitAppInfo.PermitData, {}, enum_1.PermitAppInfo.VehicleDetails);
@@ -57,7 +52,10 @@ const getOverloadCost = (overloadKg, totalDistance) => {
  * @param engine json-rules-engine Engine instance to add facts to.
  */
 function addRuntimeFacts(engine, policy) {
-    const today = (0, dayjs_1.default)().format(enum_1.PermitAppInfo.PermitDateFormat);
+    /**
+     * Add runtime fact for today's date (based on Pacific timezone)
+     */
+    const today = (0, date_helper_1.convertToTimezone)((0, date_helper_1.getUtcDatetime)(), date_helper_1.TIMEZONE_IDS.PACIFIC).format(enum_1.PermitAppInfo.PermitDateFormat);
     engine.addFact(enum_1.PolicyFacts.ValidationDate, today);
     /**
      * Add runtime fact for number of days in the permit year.
@@ -66,7 +64,7 @@ function addRuntimeFacts(engine, policy) {
      */
     engine.addFact(enum_1.PolicyFacts.DaysInPermitYear, 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 dateFrom = (0, date_helper_1.convertToTimezone)(startDate, date_helper_1.TIMEZONE_IDS.PACIFIC);
         const daysInPermitYear = dateFrom.add(1, 'year').diff(dateFrom, 'day');
         return daysInPermitYear;
     });
@@ -77,8 +75,8 @@ function addRuntimeFacts(engine, policy) {
      */
     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');
+        const dateFrom = (0, date_helper_1.convertToTimezone)(startDate, date_helper_1.TIMEZONE_IDS.PACIFIC);
+        const endOfQuarter = (0, date_helper_1.getEndOfQuarter)(dateFrom);
         return endOfQuarter.format(enum_1.PermitAppInfo.PermitDateFormat);
     });
     /**
@@ -88,7 +86,7 @@ function addRuntimeFacts(engine, policy) {
      */
     engine.addFact(enum_1.PolicyFacts.EndOfPermitYear, 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 dateFrom = (0, date_helper_1.convertToTimezone)(startDate, date_helper_1.TIMEZONE_IDS.PACIFIC);
         const endOfYear = dateFrom
             .endOf('year')
             .format(enum_1.PermitAppInfo.PermitDateFormat);
@@ -209,8 +207,8 @@ function addRuntimeFacts(engine, policy) {
     engine.addFact(enum_1.PolicyFacts.DaysBetween.toString(), async function (params, almanac) {
         const dateFromStr = await almanac.factValue(params.dateFrom.fact, {}, params.dateFrom.path);
         const dateToStr = await almanac.factValue(params.dateTo.fact, {}, params.dateTo.path);
-        const dateFrom = (0, dayjs_1.default)(dateFromStr, enum_1.PermitAppInfo.PermitDateFormat);
-        const dateTo = (0, dayjs_1.default)(dateToStr, enum_1.PermitAppInfo.PermitDateFormat);
+        const dateFrom = (0, date_helper_1.convertToTimezone)(dateFromStr, date_helper_1.TIMEZONE_IDS.PACIFIC);
+        const dateTo = (0, date_helper_1.convertToTimezone)(dateToStr, date_helper_1.TIMEZONE_IDS.PACIFIC);
         const daysBetween = dateTo.diff(dateFrom, 'day');
         return daysBetween;
     });

package/dist/rule-operator/custom-operators.js

@@ -14,6 +14,7 @@ exports.CustomOperators = void 0;
 const json_rules_engine_1 = require("json-rules-engine");
 const enum_1 = require("onroute-policy-engine/enum");
 const dayjs_1 = __importDefault(require("dayjs"));
+const date_helper_1 = require("../helper/date.helper");
 /**
  * Validates that the input is a string type
  * @param a - The value to validate
@@ -63,8 +64,8 @@ CustomOperators.push(new json_rules_engine_1.Operator(enum_1.CustomOperator.Stri
  */
 CustomOperators.push(new json_rules_engine_1.Operator(enum_1.CustomOperator.DateLessThan, (a, b) => {
     // Parse both dates using the permit application date format
-    const firstDate = (0, dayjs_1.default)(a, enum_1.PermitAppInfo.PermitDateFormat.toString());
-    const secondDate = (0, dayjs_1.default)(b, enum_1.PermitAppInfo.PermitDateFormat.toString());
+    const firstDate = (0, date_helper_1.convertToTimezone)(a, date_helper_1.TIMEZONE_IDS.PACIFIC);
+    const secondDate = (0, date_helper_1.convertToTimezone)(b, date_helper_1.TIMEZONE_IDS.PACIFIC);
     // Return true if first date is before second date (difference is negative)
     return firstDate.diff(secondDate) < 0;
 }, dateStringValidator));

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "v2.24.0";
+export declare const version = "v2.24.2";

package/dist/version.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // Generated by genversion.
-exports.version = 'v2.24.0';
+exports.version = 'v2.24.2';

package/package.json

@@ -91,5 +91,5 @@
     ],
     "testEnvironment": "node"
   },
-  "version": "v2.24.0"
+  "version": "v2.24.2"
 }