tango-app-api-audit 1.0.22 → 1.0.23

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "tango-app-api-audit",
-    "version": "1.0.22",
+    "version": "1.0.23",
     "description": "audit & audit metrics apis",
     "main": "index.js",
     "type": "module",

package/src/controllers/auditMetrics.controllers.js

@@ -922,3 +922,142 @@ export async function summarySplit( req, res ) {
     return res.sendError( err, 500 );
   }
 }
+
+export async function overViewTable( req, res ) {
+  try {
+    const inputData = req.body;
+    const limit = inputData.limit || 10;
+    const offset = inputData.offset ? ( inputData.offset - 1 ) * limit : 0;
+    const dateRange = await getUTC( new Date( inputData.fromDate ), new Date( inputData.toDate ) );
+    let filters =[
+      { fileDateISO: { $gte: dateRange.start } },
+      { fileDateISO: { $lte: dateRange.end } },
+      { auditStatus: { $in: inputData.filterByStatus } },
+      { auditType: { $in: inputData.filterByAuditType } },
+
+    ];
+    if ( inputData.clientId.length > 0 ) {
+      filters.push( { clientId: { $in: inputData.clientId } } );
+    }
+
+    const query =[
+      {
+        $match: {
+          $and: filters,
+        },
+
+      },
+      {
+        $project: {
+          _id: 0,
+          storeId: 1,
+          fileDate: 1,
+          beforeCount: 1,
+          startTime: 1,
+          auditType: 1,
+          auditStatus: 1,
+          userId: 1,
+
+
+        },
+      },
+      {
+        $lookup: {
+          from: 'users',
+          let: { userId: '$userId' },
+          pipeline: [
+            {
+              $match: {
+                $expr: {
+                  $eq: [ '$_id', '$$userId' ],
+                },
+              },
+            },
+            {
+              $project: {
+                userName: 1,
+                userEmail: '$email',
+              },
+            },
+          ], as: 'user',
+        },
+      },
+      {
+        $unwind: {
+          path: '$user',
+          preserveNullAndEmptyArrays: true,
+        },
+      },
+      {
+        $project: {
+          storeId: 1,
+          fileDate: 1,
+          beforeCount: 1,
+          startTime: 1,
+          auditType: 1,
+          auditStatus: 1,
+          userName: '$users.userName',
+          userEmail: '$users.userEmail',
+
+        },
+      },
+    ];
+    if ( inputData.searchValue && inputData.searchValue!== '' ) {
+      query.push( {
+        $match: {
+          $or: [
+            { clientId: { $regex: inputData.searchValue, $options: 'i' } },
+            { clientName: { $regex: inputData.searchValue, $options: 'i' } },
+          ],
+
+        },
+      } );
+    }
+    if ( inputData.sortColumnName ) {
+      const sortBy = inputData.sortBy || -1;
+      query.push( {
+        $sort: { [inputData.sortColumName]: sortBy },
+      },
+      );
+    }
+    const count = await aggregateUserAudit( query );
+    if ( count.length == 0 ) {
+      return res.sendError( 'No Data Found', 204 );
+    }
+
+    if ( inputData.isExport ) {
+      query.push( { limit: 10000 } );
+    } else {
+      query.push( {
+        $skip: offset,
+      },
+      {
+        $limit: limit,
+      } );
+    }
+
+    const result = await aggregateUserAudit( query );
+    if ( inputData.isExport ) {
+      const exportdata = [];
+      result.forEach( ( element ) => {
+        exportdata.push( {
+          'Store Id': element.storeId,
+          'File Date': element.fileDtae,
+          'Audit Type': element.audittype,
+          'Before Count': element.beforeCount,
+          'Start Time': element.startTime,
+          'User Name': element.userName,
+          'User Email': element.userEmail,
+          'Status': element.auditStatus,
+        } );
+      } );
+      await download( exportdata, res );
+      return;
+    }
+    return res.sendSuccess( { result: result, count: count.length } );
+  } catch ( error ) {
+    const err = error.message || 'Internal Server Error';
+    logger.error( { error: error, message: req.body, function: 'summarySplit' } );
+    return res.sendError( err, 500 );
+  }
+}

package/src/docs/auditMetrics.docs.js

@@ -1,5 +1,5 @@
 import j2s from 'joi-to-swagger';
-import { clientMetricsSchema, getAuditImagesSchema, overViewCardSchema, storeMetricsSchema, summarySplitSchema, userAuditHistorySchema, userMetricsSchema } from '../dtos/auditMetrics.dtos.js';
+import { clientMetricsSchema, getAuditImagesSchema, overViewCardSchema, overViewTableSchema, storeMetricsSchema, summarySplitSchema, userAuditHistorySchema, userMetricsSchema } from '../dtos/auditMetrics.dtos.js';
 
 export const auditMetricsDocs = {
 
@@ -157,4 +157,26 @@ export const auditMetricsDocs = {
       },
     },
   },
+  '/v3/audit-metrics/overview-table': {
+    post: {
+      tags: [ 'Audit Metrics' ],
+      description: `Get overall user taken data with some filters `,
+      operationId: 'overview-table',
+      parameters: {},
+      requestBody: {
+        content: {
+          'application/json': {
+            schema: j2s( overViewTableSchema ).swagger,
+          },
+        },
+      },
+      responses: {
+        200: { description: 'Successful' },
+        401: { description: 'Unauthorized User' },
+        422: { description: 'Field Error' },
+        500: { description: 'Server Error' },
+        204: { description: 'Not Found' },
+      },
+    },
+  },
 };

package/src/dtos/auditMetrics.dtos.js

@@ -118,3 +118,23 @@ export const summarySplitSchema = joi.object(
 export const summarySplitValid = {
   body: summarySplitSchema,
 };
+
+export const overViewTableSchema = joi.object(
+    {
+      fromDate: joi.string().required(),
+      toDate: joi.string().required(),
+      clientId: joi.array().optional(),
+      limit: joi.number().optional(),
+      offset: joi.number().optional(),
+      searchValue: joi.number().optional().allow( '' ),
+      filterByStatus: joi.array().required(),
+      filterByAuditType: joi.array().required(),
+      sortColumnName: joi.string().optional(),
+      sortBy: joi.number().optional(),
+      isExport: joi.boolean().optional(),
+    },
+);
+
+export const overViewTableValid = {
+  body: overViewTableSchema,
+};

package/src/routes/auditMetrics.routes.js

@@ -1,8 +1,8 @@
 
 import express from 'express';
 import { isAllowedSessionHandler, validate } from 'tango-app-api-middleware';
-import { clientMetrics, overViewCard, storeMetrics, summarySplit, userAuditHistory, userMetrics } from '../controllers/auditMetrics.controllers.js';
-import { clientMetricsValid, overViewCardValid, storeMetricsValid, summarySplitValid, userAuditHistoryValid, userMetricsValid } from '../dtos/auditMetrics.dtos.js';
+import { clientMetrics, overViewCard, overViewTable, storeMetrics, summarySplit, userAuditHistory, userMetrics } from '../controllers/auditMetrics.controllers.js';
+import { clientMetricsValid, overViewCardValid, overViewTableValid, storeMetricsValid, summarySplitValid, userAuditHistoryValid, userMetricsValid } from '../dtos/auditMetrics.dtos.js';
 
 export const auditMetricsRouter = express.Router();
 
@@ -12,5 +12,6 @@ auditMetricsRouter.post( '/client-metrics', isAllowedSessionHandler, validate( c
 auditMetricsRouter.post( '/user-metrics', isAllowedSessionHandler, validate( userMetricsValid ), userMetrics );
 auditMetricsRouter.post( '/overview-card', isAllowedSessionHandler, validate( overViewCardValid ), overViewCard );
 auditMetricsRouter.post( '/summary-split-up', isAllowedSessionHandler, validate( summarySplitValid ), summarySplit );
+auditMetricsRouter.post( '/overview-table', isAllowedSessionHandler, validate( overViewTableValid ), overViewTable );
 
 export default auditMetricsRouter;