@vasrefil/api-toolkit 1.4.3 → 1.5.0

package/dist/utilities/index.d.ts

@@ -3,3 +3,4 @@ export * from './date.util';
 export * from './logger.util';
 export * from './log.util';
 export * from './go-mailer.util';
+export * from './report.util';

package/dist/utilities/index.js

@@ -19,3 +19,4 @@ __exportStar(require("./date.util"), exports);
 __exportStar(require("./logger.util"), exports);
 __exportStar(require("./log.util"), exports);
 __exportStar(require("./go-mailer.util"), exports);
+__exportStar(require("./report.util"), exports);

package/dist/utilities/report.util.d.ts

@@ -0,0 +1,25 @@
+interface ChartDataInput {
+    _id: {
+        date: string;
+        groupByField: string | number;
+    };
+    count: number;
+}
+export declare class ReportUtil {
+    static getDateGroupFormat(query: any): "%Y-%m" | "%Y-%m-%d";
+    static daysBetween(date1: Date, date2: Date): number;
+    /**
+     * Formats aggregated data for chart display.
+     * @param data - The aggregated data from MongoDB.
+     * Expected format: [{ _id: { date: 'YYYY-MM-DD', groupByField: 'someValue' }, count: 123 }]
+     * @returns An object with `series` and `categories` for charting libraries.
+     */
+    static formatChartData(data: ChartDataInput[]): {
+        series: {
+            name: string;
+            data: number[];
+        }[];
+        categories: string[];
+    };
+}
+export {};

package/dist/utilities/report.util.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportUtil = void 0;
+class ReportUtil {
+    static getDateGroupFormat(query) {
+        const { date_type, date_range } = query;
+        if (date_type === 'custom') {
+            const daterange = date_range ? JSON.parse(date_range) : {};
+            if (daterange.start_date && daterange.end_date) {
+                const numOfDays = this.daysBetween(new Date(daterange.start_date), new Date(daterange.end_date));
+                if (numOfDays > 30) {
+                    return '%Y-%m'; // Group by month for long ranges
+                }
+                return '%Y-%m-%d'; // Group by day for short ranges
+            }
+        }
+        const dateGroupFormat = ['this_year', 'no_date'].includes(date_type) ? '%Y-%m' : '%Y-%m-%d';
+        return dateGroupFormat;
+    }
+    static daysBetween(date1, date2) {
+        const msPerDay = 1000 * 60 * 60 * 24;
+        return Math.abs(Math.floor((date2.getTime() - date1.getTime()) / msPerDay));
+    }
+    /**
+     * Formats aggregated data for chart display.
+     * @param data - The aggregated data from MongoDB.
+     * Expected format: [{ _id: { date: 'YYYY-MM-DD', groupByField: 'someValue' }, count: 123 }]
+     * @returns An object with `series` and `categories` for charting libraries.
+     */
+    static formatChartData(data) {
+        const categoriesSet = new Set();
+        const groupedData = {};
+        data.forEach(({ _id, count }) => {
+            const groupByValue = String(_id.groupByField);
+            categoriesSet.add(_id.date);
+            if (!groupedData[groupByValue]) {
+                groupedData[groupByValue] = {};
+            }
+            groupedData[groupByValue][_id.date] = count;
+        });
+        const categories = Array.from(categoriesSet).sort();
+        const series = Object.keys(groupedData).map(key => {
+            return { name: key, data: categories.map((date) => groupedData[key][date] || 0) };
+        });
+        return { series, categories };
+    }
+}
+exports.ReportUtil = ReportUtil;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vasrefil/api-toolkit",
   "description": "This is Vasrefil API toolkit",
-  "version": "1.4.3",
+  "version": "1.5.0",
   "author": "Sodiq Alabi",
   "main": "dist/public-api.js",
   "types": "dist/public-api.d.ts",