kcommons 18.26.4 → 18.26.6

package/build/typings/system/reportsPluginConfigCompany.typings.d.ts

@@ -19,6 +19,7 @@ export interface IReportsPluginConfigCompany {
     to_emails: string[];
     cc_emails: string[];
     bcc_emails: string[];
+    version: string;
     last_run_at: string | null;
     next_run_at: string | null;
     created_at: string;

package/build/utils/calculateNextRunAt.util.d.ts

@@ -5,4 +5,4 @@ export type IScheduleShape = Pick<IReportsPluginConfigCompany, "frequency_type"
  * `send_time` ("HH:mm"), `day_of_week` (0-6) and `date_of_month` (1-31) are in IST.
  * MONTHLY clamps `date_of_month` to the last day of shorter months.
  */
-export declare const calculateNextRunAt: (scheduleConfig: IScheduleShape, after: Date) => Date | null;
+export declare const calculateNextRunAt: (scheduleConfig: IScheduleShape, after: Date) => Date;

package/build/utils/calculateNextRunAt.util.js

@@ -45,7 +45,7 @@ const calculateNextRunAt = (scheduleConfig, after) => {
                 : getMonthlyRunAt(istYear, istMonth + 1);
         }
         default:
-            return null;
+            throw new Error(`Invalid value for frequency_type: ${scheduleConfig.frequency_type}`);
     }
 };
 exports.calculateNextRunAt = calculateNextRunAt;

package/build/utils/calculateTimeDifferenceInSecs.util.d.ts

@@ -0,0 +1,55 @@
+/**
+ * A point in time accepted by {@link calculateTimeDifferenceInSeconds}.
+ *
+ * - `Date` — any valid `Date` object.
+ * - `string` — a 24-hour time of day in strict `HH:MM` format
+ *   (e.g. `"09:05"`, `"23:59"`). Leading zeros are required and seconds
+ *   are not supported.
+ */
+type TimeInput = Date | string;
+/**
+ * Calculates the absolute difference in seconds between two times. The
+ * result is never negative, so the order of `start` and `end` does not
+ * matter.
+ *
+ * The behaviour depends on the input types:
+ *
+ * - **Both `Date` objects** — the full date-time difference is used (via
+ *   `date-fns` `differenceInSeconds`), so differences across days are
+ *   included. Fractional seconds are truncated.
+ * - **Any `string` input (or a mix of `Date` and `string`)** — only the time
+ *   of day is compared. The calendar date of any `Date` is ignored, and its
+ *   local hours/minutes/seconds are used.
+ *
+ * The time-of-day result is **not** wrapped around midnight: `"22:00"` →
+ * `"02:00"` gives `72000` (the gap between the two times of day), not the
+ * overnight duration `14400`. Handle overnight ranges at the call site if
+ * needed.
+ *
+ * @param start - The start time: a `Date` or an `HH:MM` (24-hour) string.
+ * @param end - The end time: a `Date` or an `HH:MM` (24-hour) string.
+ * @returns The absolute number of seconds between `start` and `end`
+ *   (never negative).
+ * @throws {Error} If a string input is not in `HH:MM` format, or a `Date`
+ *   input is invalid (in the time-of-day comparison path).
+ *
+ * @example
+ * calculateTimeDifferenceInSeconds("09:00", "17:30"); // 30600
+ *
+ * @example
+ * // Order does not matter
+ * calculateTimeDifferenceInSeconds("18:00", "09:00"); // 32400
+ *
+ * @example
+ * // Both Dates: full date-time difference, across days
+ * calculateTimeDifferenceInSeconds(
+ *   new Date("2024-01-01T23:00:00"),
+ *   new Date("2024-01-02T01:00:00"),
+ * ); // 7200
+ *
+ * @example
+ * // Mixed: only the Date's time of day (10:15:30) is used
+ * calculateTimeDifferenceInSeconds(new Date("2024-01-01T10:15:30"), "11:00"); // 2670
+ */
+export declare function calculateTimeDifferenceInSeconds(start: TimeInput, end: TimeInput): number;
+export {};

package/build/utils/calculateTimeDifferenceInSecs.util.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculateTimeDifferenceInSeconds = calculateTimeDifferenceInSeconds;
+const date_fns_1 = require("date-fns");
+/**
+ * Converts a time input into the number of seconds elapsed since midnight.
+ *
+ * For a `Date`, only its local time of day (hours, minutes, seconds) is used;
+ * the calendar date and milliseconds are ignored. For a string, the `HH:MM`
+ * value is parsed and seconds are taken as `0`.
+ *
+ * @param input - A valid `Date` or an `HH:MM` time string.
+ * @returns Seconds since midnight, in the range `0`–`86399`.
+ * @throws {Error} If `input` is an invalid `Date` (e.g. `new Date("foo")`).
+ * @throws {Error} If `input` is a string not matching `HH:MM` (24-hour).
+ */
+function toSeconds(input) {
+    if (input instanceof Date) {
+        if (!(0, date_fns_1.isValid)(input)) {
+            throw new Error("Invalid Date object");
+        }
+        return (input.getHours() * 3600 + input.getMinutes() * 60 + input.getSeconds());
+    }
+    const match = /^([01]\d|2[0-3]):([0-5]\d)$/.exec(input);
+    if (!match) {
+        throw new Error(`Invalid time format: ${input}. Expected HH:MM`);
+    }
+    const hours = Number(match[1]);
+    const minutes = Number(match[2]);
+    return hours * 3600 + minutes * 60;
+}
+/**
+ * Calculates the absolute difference in seconds between two times. The
+ * result is never negative, so the order of `start` and `end` does not
+ * matter.
+ *
+ * The behaviour depends on the input types:
+ *
+ * - **Both `Date` objects** — the full date-time difference is used (via
+ *   `date-fns` `differenceInSeconds`), so differences across days are
+ *   included. Fractional seconds are truncated.
+ * - **Any `string` input (or a mix of `Date` and `string`)** — only the time
+ *   of day is compared. The calendar date of any `Date` is ignored, and its
+ *   local hours/minutes/seconds are used.
+ *
+ * The time-of-day result is **not** wrapped around midnight: `"22:00"` →
+ * `"02:00"` gives `72000` (the gap between the two times of day), not the
+ * overnight duration `14400`. Handle overnight ranges at the call site if
+ * needed.
+ *
+ * @param start - The start time: a `Date` or an `HH:MM` (24-hour) string.
+ * @param end - The end time: a `Date` or an `HH:MM` (24-hour) string.
+ * @returns The absolute number of seconds between `start` and `end`
+ *   (never negative).
+ * @throws {Error} If a string input is not in `HH:MM` format, or a `Date`
+ *   input is invalid (in the time-of-day comparison path).
+ *
+ * @example
+ * calculateTimeDifferenceInSeconds("09:00", "17:30"); // 30600
+ *
+ * @example
+ * // Order does not matter
+ * calculateTimeDifferenceInSeconds("18:00", "09:00"); // 32400
+ *
+ * @example
+ * // Both Dates: full date-time difference, across days
+ * calculateTimeDifferenceInSeconds(
+ *   new Date("2024-01-01T23:00:00"),
+ *   new Date("2024-01-02T01:00:00"),
+ * ); // 7200
+ *
+ * @example
+ * // Mixed: only the Date's time of day (10:15:30) is used
+ * calculateTimeDifferenceInSeconds(new Date("2024-01-01T10:15:30"), "11:00"); // 2670
+ */
+function calculateTimeDifferenceInSeconds(start, end) {
+    if (start instanceof Date && end instanceof Date) {
+        return Math.abs((0, date_fns_1.differenceInSeconds)(end, start));
+    }
+    return Math.abs(toSeconds(end) - toSeconds(start));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kcommons",
-  "version": "18.26.4",
+  "version": "18.26.6",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",