@konplit-services/common 1.26.0 → 1.26.1

package/build/helper/date-processing.d.ts

@@ -1,4 +1,10 @@
+import dayjs from "dayjs";
 import { PLAN_INTERVAL } from "./plan-types";
+type Period = "day" | "week" | "month" | "year";
+interface DateRange {
+    startOfPeriod: Date;
+    endOfPeriod: Date;
+}
 export declare const formatDate: (dateInput: string | Date | number, // support more input types
 format?: string, tz?: string) => string;
 export declare const interswitchRefundDateFormat: (dataString: string) => string;
@@ -12,10 +18,15 @@ export declare const getCurrentDayRange: () => {
     startOfCurrentDay: Date;
     endOfCurrentDay: Date;
 };
-export declare const getStartAndEndDate: (date: string | Date) => {
-    startOfDate: Date;
-    endOfDate: Date;
-};
+/**
+ * Returns the start and end of a given period for the provided date
+ *
+ * @param date - Input date (string, Date, or dayjs object)
+ * @param period - The time period to calculate range for ("day" | "week" | "month" | "year")
+ * @param timezone - Optional timezone (defaults to Africa/Lagos)
+ * @returns Object containing startOfPeriod and endOfPeriod as native Date objects (in UTC)
+ */
+export declare const getStartAndEndOfPeriod: (date: string | Date | dayjs.Dayjs, period?: Period, tz?: string) => DateRange;
 export declare const isTodayOrFuture: (dateInput: string | Date) => boolean;
 export declare const convertDateToUTCRangeString: (startDateTime: string, endDateTime: string) => {
     startUTC: string;

package/build/helper/date-processing.js

@@ -3,18 +3,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculateDelay = exports.getFutureDateFromPlan = exports.getDuration = exports.convertDateToUTC = exports.convertDateToUTCString = exports.convertDateToUTCRange = exports.convertDateToUTCRangeString = exports.isTodayOrFuture = exports.getStartAndEndDate = exports.getCurrentDayRange = exports.getPreviousDayRange = exports.convertToDate = exports.formatDateTime = exports.interswitchRefundDateFormat = exports.formatDate = void 0;
+exports.calculateDelay = exports.getFutureDateFromPlan = exports.getDuration = exports.convertDateToUTC = exports.convertDateToUTCString = exports.convertDateToUTCRange = exports.convertDateToUTCRangeString = exports.isTodayOrFuture = exports.getStartAndEndOfPeriod = exports.getCurrentDayRange = exports.getPreviousDayRange = exports.convertToDate = exports.formatDateTime = exports.interswitchRefundDateFormat = exports.formatDate = void 0;
 exports.canRefundFromSettlementLedgerByDay = canRefundFromSettlementLedgerByDay;
 exports.getSettlementDate = getSettlementDate;
 const dayjs_1 = __importDefault(require("dayjs"));
 const utc_1 = __importDefault(require("dayjs/plugin/utc"));
 const timezone_1 = __importDefault(require("dayjs/plugin/timezone"));
+const plan_types_1 = require("./plan-types");
 // Extend dayjs with the UTC plugin
 dayjs_1.default.extend(utc_1.default);
 dayjs_1.default.extend(timezone_1.default);
 const DEFAULT_TZ = "Africa/Lagos";
 const DEFAULT_FORMAT = "YYYY-MM-DD";
-const plan_types_1 = require("./plan-types");
 const formatDate = (dateInput, // support more input types
 format = DEFAULT_FORMAT, tz = DEFAULT_TZ) => {
     if (!dateInput) {
@@ -59,15 +59,49 @@ const getCurrentDayRange = () => {
     return { startOfCurrentDay, endOfCurrentDay };
 };
 exports.getCurrentDayRange = getCurrentDayRange;
-const getStartAndEndDate = (date) => {
-    const startTime = (0, dayjs_1.default)(`${date}`, "YYYY-MM-DD HH:mm");
-    // Get the start of day
-    const startOfDate = startTime.utc().startOf("day").toDate();
-    // Get the end of the previous day in UTC (23:59:59.999)
-    const endOfDate = startTime.utc().endOf("day").toDate();
-    return { startOfDate, endOfDate };
+/**
+ * Returns the start and end of a given period for the provided date
+ *
+ * @param date - Input date (string, Date, or dayjs object)
+ * @param period - The time period to calculate range for ("day" | "week" | "month" | "year")
+ * @param timezone - Optional timezone (defaults to Africa/Lagos)
+ * @returns Object containing startOfPeriod and endOfPeriod as native Date objects (in UTC)
+ */
+const getStartAndEndOfPeriod = (date, period = "day", tz = DEFAULT_TZ) => {
+    // Normalize input to dayjs object in the target timezone
+    const inputDate = (0, dayjs_1.default)(date).tz(tz);
+    let start;
+    let end;
+    switch (period) {
+        case "day":
+            start = inputDate.startOf("day");
+            end = inputDate.endOf("day");
+            break;
+        case "week":
+            // Most common: week starts on Monday in many African/business contexts
+            // but we are using Sunday start → but can be changed to isoWeek
+            start = inputDate.startOf("week");
+            end = inputDate.endOf("week");
+            break;
+        case "month":
+            start = inputDate.startOf("month");
+            end = inputDate.endOf("month");
+            break;
+        case "year":
+            start = inputDate.startOf("year");
+            end = inputDate.endOf("year");
+            break;
+        default:
+            // This should never happen with TypeScript + union type, but good safety net
+            throw new Error(`Unsupported period: ${period}`);
+    }
+    // Return as UTC Dates (most backend systems & databases expect UTC)
+    return {
+        startOfPeriod: start.utc().toDate(),
+        endOfPeriod: end.utc().toDate(),
+    };
 };
-exports.getStartAndEndDate = getStartAndEndDate;
+exports.getStartAndEndOfPeriod = getStartAndEndOfPeriod;
 const isTodayOrFuture = (dateInput) => {
     const input = dayjs_1.default.utc(dateInput);
     if (!input.isValid())

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@konplit-services/common",
-  "version": "1.26.0",
+  "version": "1.26.1",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",