tango-app-api-audit 1.0.22 → 1.0.24

package/package.json

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

package/src/controllers/auditMetrics.controllers.js

@@ -2,7 +2,6 @@ import { download, getUTC, logger } from 'tango-app-api-middleware';
 import { aggregateAuditClientData } from '../service/auditClientData.service.js';
 import { aggregateUserAudit } from '../service/userAudit.service.js';
 import mongoose from 'mongoose';
-import dayjs from 'dayjs';
 import { aggregateStoreAudit } from '../service/storeAudit.service.js';
 // import { listQueue } from 'tango-app-api-middleware/src/utils/aws/sqs.js';
 
@@ -103,16 +102,27 @@ export async function userAuditHistory( req, res ) {
 
 export async function storeMetrics( req, res ) {
   try {
-    const yesterday = dayjs().subtract( 1, 'days' ).format( 'YYYY-MM-DD' );
     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 filter = [
       { fileDateISO: { $gte: dateRange.start } },
       { fileDateISO: { $lte: dateRange.end } },
     ];
-    if ( inputData.filterByClient && inputData.filterByClient?.length > 0 ) {
-      filter.push( { clientId: { $in: inputData.filterByClient } } );
+    if ( inputData.filterByClientId && inputData.filterByClientId?.length > 0 ) {
+      filter.push( { clientId: { $in: inputData.filterByClientId } } );
+    }
+
+    if ( inputData.filterByStoreId && inputData.filterByStoreId?.length > 0 ) {
+      filter.push( { storeId: { $in: inputData.filterByStoreId } } );
+    }
+
+    if ( inputData.filterByStatus && inputData.filterByStatus?.length > 0 ) {
+      filter.push( { status: { $in: inputData.filterByStatus } } );
     }
+
+
     const query = [
       {
         $match: {
@@ -121,99 +131,109 @@ export async function storeMetrics( req, res ) {
       },
       {
         $project: {
+          _id: 0,
           fileDate: 1,
-          fileDateISO: 1,
-          clientName: 1,
+          storeId: 1,
+          storeName: '$storeId',
+          userId: {
+            $arrayElemAt: [ '$userId', { $subtract: [ { $size: '$userId' }, 1 ] } ],
+          },
           clientId: 1,
-          installedStore: 1,
-          totalFilesCount: 1,
-          queueName: 1,
+          auditType: 1,
+          beforeCount: 1,
+          afterCount: { $ifNull: [ '$afterCount', null ] },
+          accuracy: { $round: [
+            { $divide: [
+              { $multiply: [ { $ifNull: [ '$afterCount', 0 ] }, '$beforeCount' ] }, 100,
+            ] }, 2,
+          ],
+
+          },
+          timeSpent: 1,
+          status: 1,
         },
       },
       {
         $lookup: {
-          'from': 'storeAudit',
-          'let': { 'clientId': '$clientId', 'fileDate': '$fileDate', 'totalFilesCount': '$totalFilesCount' },
-          'pipeline': [
-
+          from: 'stores',
+          let: { storeId: '$storeId' },
+          pipeline: [
             {
               $match: {
                 $expr: {
-                  $and: [
-                    { $eq: [ '$clientId', '$$clientId' ] },
-                    { $eq: [ '$fileDate', '$$fileDate' ] },
-                  ],
+                  $eq: [ '$storeId', '$$storeId' ],
                 },
               },
             },
             {
               $project: {
-                completedStores: { $cond: [ { $eq: [ '$status', 'completed' ] }, 1, 0 ] },
-                assignedStores: { $cond: [ { $ne: [ '$status', [ 'completed' ] ] }, 1, 0 ] },
+                _id: 0,
+                storeName: 1,
               },
             },
+          ], as: 'stores',
+        },
+      },
+      {
+        $unwind: {
+          path: '$stores',
+          preserveNullAndEmptyArrays: true,
+        },
+      },
+      {
+        $lookup: {
+          from: 'users',
+          let: { userId: '$userId' },
+          pipeline: [
             {
-              $group: {
-                _id: { clientId: '$clientId', fileDate: '$fileDate' },
-                completedStores: { $sum: '$completedStores' },
-                assignedStores: { $sum: '$assignedStores' },
-                fileCount: { $sum: 1 },
-
+              $match: {
+                $expr: {
+                  $eq: [ '$_id', '$$userId' ],
+                },
               },
             },
             {
               $project: {
                 _id: 0,
-                fileDateISO: 1,
-                completedStores: 1,
-                assignedStores: 1,
-                completePercentage: {
-                  $round: [ {
-                    $multiply: [
-                      100, {
-                        $divide: [
-                          '$completedStores', '$$totalFilesCount',
-                        ],
-                      },
-                    ],
-                  }, 1 ],
-
-                },
-                fileCount: 1,
+                userName: 1,
+                userEmail: '$email',
               },
-
             },
-          ], 'as': 'audit',
+          ], as: 'users',
         },
       },
       {
-        $unwind: { path: '$audit', preserveNullAndEmptyArrays: true },
+        $unwind: {
+          path: '$users',
+          preserveNullAndEmptyArrays: true,
+        },
       },
       {
         $project: {
           _id: 0,
-          clientId: 1,
-          clientName: 1,
           fileDate: 1,
-          fileDateISO: 1,
-          installedStore: 1,
-          totalFilesCount: 1,
-          queueName: 1,
-          completedStores: { $ifNull: [ '$audit.completedStores', 0 ] },
-          assignedStores: { $ifNull: [ '$audit.assignedStores', 0 ] },
-          completePercentage: { $ifNull: [ '$audit.completePercentage', 0 ] },
-          notAssigned: '',
-          status: '',
-          fileCount: { $ifNull: [ '$audit.fileCount', 0 ] },
+          storeId: 1,
+          storeName: '$stores.storeName',
+          userName: '$users.userName',
+          userEmail: '$users.userEmail',
+
+          clientId: 1,
+          auditType: 1,
+          beforeCount: 1,
+          afterCount: { $ifNull: [ '$afterCount', null ] },
+          accuracy: { $round: [
+            { $divide: [
+              { $multiply: [ { $ifNull: [ '$afterCount', 0 ] }, '$beforeCount' ] }, 100,
+            ] }, 2,
+          ],
+
+          },
+          timeSpent: 1,
+          status: 1,
         },
       },
 
     ];
-    query.push( {
-      $sort: {
-        fileDateISO: -1,
-      },
-    } );
 
     if ( inputData.searchValue && inputData.searchValue !== '' ) {
       query.push( {
@@ -225,85 +245,42 @@ export async function storeMetrics( req, res ) {
         },
       } );
     }
-    const result = await aggregateAuditClientData( query );
+    const count = await aggregateStoreAudit( query );
 
-    if ( result.length == 0 ) {
+    if ( count.length == 0 ) {
       return res.sendError( 'No data Found', 204 );
     }
-    let count;
-    if ( inputData.filterByStatus && inputData.filterByStatus.length > 0 ) {
-      let testCount;
-      for ( let i = 0; i < result.length; i++ ) {
-        const item = result[i];
-        if ( inputData.fromDate === inputData.toDate && inputData.fromDate === yesterday ) {
-          const temp = await listQueue( item.queueName );
-          item.notAssigned = Number( temp );
-        } else {
-          item.notAssigned = 'No Data';
-        }
-        item.status = ( item.totalFilesCount === item.completedStores && item.assignedStores === 0 && ( item.notAssigned == 0 || item.notAssigned === 'No Data' ) ) ? 'completed' :
-        item.fileCount > 0 ? 'pending' : 'not_taken';
-        delete item.fileCount;
-        testCount = result.filter( ( i ) => inputData.filterByStatus.includes( i.status ) );
-        count = testCount.length;
-      }
-      if ( !inputData.isExport ) {
-        const skip = ( inputData.offset - 1 ) * inputData.limit;
-        testCount = testCount.slice( skip, skip + inputData.limit );
-      }
-      if ( inputData.isExport ) {
-        const exportdata = [];
-        testCount.forEach( ( element ) => {
-          exportdata.push( {
-            'File Date': element.fileDate,
-            'Client Name': element.clientName,
-            'Client Id': element.clientId,
-            'Completed Percentage': element.completePercentage + ' %',
-            'Installed Stores': element.installedStore,
-            'Audit Stores': element.totalFilesCount,
-            'Inprogress Stores': element.assignedStores,
-            'Not Assigned': element.notAssigned && element.notAssigned == 'No Data' ? 0 : element.notAssigned,
-            'Completed': element.completedStores,
-            'Status': element.status,
-          } );
-        } );
-        await download( exportdata, res );
-        return;
-      }
-      return res.sendSuccess( { result: testCount, count: count } );
-    }
-    for ( let i = 0; i < result.length; i++ ) {
-      const item = result[i];
-      if ( inputData.fromDate === inputData.toDate && inputData.fromDate === yesterday ) {
-        const temp = await listQueue( item.queueName );
-        item.notAssigned = Number( temp );
-      } else {
-        item.notAssigned = 'No Data';
-      }
-      item.status = ( item.totalFilesCount === item.completedStores && item.assignedStores === 0 && ( item.notAssigned == 0 || item.notAssigned === 'No Data' ) ) ? 'completed' :
-        item.fileCount > 0 ? 'pending' : 'not_taken';
-      delete item.fileCount;
+    if ( !inputData.isExport ) {
+      query.push( {
+        $skip: offset,
+      },
+      {
+        $limit: limit,
+      } );
+    } else {
+      query.push( { $limit: 10000 } );
     }
+    const result = await aggregateStoreAudit( query );
     if ( inputData.isExport ) {
       const exportdata = [];
       result.forEach( ( element ) => {
         exportdata.push( {
           'File Date': element.fileDate,
-          'Client Name': element.clientName,
+          'Store Id': element.storeId,
+          'Store Name': element.storeName,
           'Client Id': element.clientId,
-          'Completed Percentage': element.completePercentage + ' %',
-          'Installed Stores': element.installedStore,
-          'Audit Stores': element.totalFilesCount,
-          'Assigned Stores': element.assignedStores,
-          'Not Assigned': element.notAssigned && element.notAssigned == 'No Data' ? 0 : element.notAssigned,
-          'Completed': element.completedStores,
+          'User Name': element.userName,
+          'User Email': element.userEmail,
+          'Audit Type': element.auditType,
+          'Accuracy': element.accuracy,
+          'Time Spent': element.timeSpent,
           'Status': element.status,
         } );
       } );
       await download( exportdata, res );
       return;
     }
-    return res.sendSuccess( { result: result, count: count } );
+    return res.sendSuccess( { result: result, count: count.length } );
   } catch ( error ) {
     const err = error.message || 'Internal Server Error';
     logger.error( { error: error, data: req.body, function: 'storeMetrics' } );
@@ -922,3 +899,274 @@ 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 );
+  }
+}
+
+export async function overAllAuditSummary( req, res ) {
+  try {
+    const inputData = req.body;
+    let temp = {
+
+    };
+    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 } },
+
+    ];
+    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.sortColumnName ) {
+      const sortBy = inputData.sortBy || -1;
+      query.push( {
+        $sort: { [inputData.sortColumName]: sortBy },
+      },
+      );
+    }
+
+    const count = await aggregateAuditClientData( query );
+    if ( count.length == 0 ) {
+      return res.sendError( 'No Data Found', 204 );
+    }
+    if ( !inputData.isExport ) {
+      query.push( {
+        $skip: offset,
+      },
+      {
+        $limit: limit,
+      } );
+    } else {
+      query.push( { $limit: 10000 } );
+    }
+
+    const result = await aggregateStoreAudit( query );
+    if ( inputData.isExport ) {
+      const exportdata = [];
+      result.forEach( ( element ) => {
+        exportdata.push( {
+          'File Date': element.storeId,
+          'Store Id': element.fileDtae,
+          'Store Name': element.audittype,
+          'User Name': element.beforeCount,
+          'user Email': element.startTime,
+          'Audit Type': element.userName,
+          'Before Count': element.userEmail,
+          'After Count': element.auditStatus,
+          'Accuracy': element.Accuracy,
+          'Status': element.status,
+        } );
+      } );
+      await download( exportdata, res );
+      return;
+    }
+    return res.sendSuccess( { result: result.length> 0? result[0]: temp } );
+  } 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,35 @@ 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,
+};
+
+export const overAllAuditSummarySchema = joi.object(
+    {
+      fromDate: joi.string().required(),
+      toDate: joi.string().required(),
+      clientId: joi.array().optional(),
+    },
+);
+
+export const overAllAuditSummaryValid = {
+  body: overAllAuditSummarySchema,
+};

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, overAllAuditSummary, overViewCard, overViewTable, storeMetrics, summarySplit, userAuditHistory, userMetrics } from '../controllers/auditMetrics.controllers.js';
+import { clientMetricsValid, overAllAuditSummaryValid, overViewCardValid, overViewTableValid, storeMetricsValid, summarySplitValid, userAuditHistoryValid, userMetricsValid } from '../dtos/auditMetrics.dtos.js';
 
 export const auditMetricsRouter = express.Router();
 
@@ -12,5 +12,7 @@ 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 );
+auditMetricsRouter.post( '/overall-audit-summary', isAllowedSessionHandler, validate( overAllAuditSummaryValid, overAllAuditSummary ) );
 
 export default auditMetricsRouter;