tango-app-api-audit 1.0.39 → 1.0.41

package/package.json

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

package/src/controllers/auditMetrics.controllers.js

@@ -22,7 +22,6 @@ export async function userAuditHistory( req, res ) {
     let filter = [
 
       { userId: { $eq: userId } },
-      { moduleType: 'traffic' },
 
     ];
     if ( inputData.fileType == 'fileDate' ) {
@@ -37,6 +36,12 @@ export async function userAuditHistory( req, res ) {
       );
     }
 
+    if ( inputData.filterByAuditType?.length > 0 ) {
+      filter.push( {
+        moduleType: { $in: inputData.filterByAuditType },
+      } );
+    }
+
     if ( inputData.filterByStoreId?.length > 0 ) {
       filter.push( {
         storeId: { $in: inputData.filterByStoreId },
@@ -57,17 +62,7 @@ export async function userAuditHistory( req, res ) {
       },
     ];
 
-    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( {
@@ -110,6 +105,8 @@ export async function userAuditHistory( req, res ) {
         userId: 1,
         storeName: '$store.storeName',
         auditType: 1,
+        zoneName: 1,
+        moduleType: 1,
         beforeCount: 1,
         afterCount: 1,
         accuracy: { $round: [
@@ -128,6 +125,21 @@ export async function userAuditHistory( req, res ) {
       },
     } );
 
+    if ( inputData.searchValue && inputData.searchValue!== '' ) {
+      query.push( {
+        $match: {
+          $or: [
+            { zoneName: { $regex: inputData.searchValue, $options: 'i' } },
+            { storeId: { $regex: inputData.storeId, $options: 'i' } },
+            { storeName: { $regex: inputData.storeName, $options: 'i' } },
+            { moduleType: { $regex: inputData.moduleType, $options: 'i' } },
+            { auditStatus: { $regex: inputData.auditStatus, $options: 'i' } },
+          ],
+
+        },
+      } );
+    }
+
     const count = await aggregateUserAudit( query );
     if ( count.length == 0 ) {
       return res.sendError( 'No Data Found', 204 );
@@ -139,17 +151,19 @@ export async function userAuditHistory( req, res ) {
         const exportData = [];
         chunk.forEach( ( element ) => {
           exportData.push( {
-            'storeId': element.storeId,
-            'storeName': element.storeName,
-            'auditType': element.auditType,
-            'beforeCount': element.beforeCount,
-            'afterCount': element.afterCount,
-            'accuracy': element.accuracy,
-            'startTime': element.startTime,
-            'endTime': element.endTime,
-            'timeSpent': element.timeSpent,
-            'auditStatus': element.auditStatus,
-            'createdAt': element.createdAt,
+            'Store Id': element.storeId,
+            'Store Name': element.storeName,
+            'Type': element.auditType,
+            'Before Count': element.beforeCount,
+            'After Count': element.afterCount,
+            'Accuracy': element.accuracy,
+            'Zone Name': element.zoneName,
+            'Audit Type': element.moduleType,
+            'Start Time': element.startTime,
+            'End Time': element.endTime,
+            'Time Spent': element.timeSpent,
+            'Audit Status': element.auditStatus,
+            'CreatedAt': element.createdAt,
 
           } );
         } );
@@ -382,6 +396,11 @@ export async function clientMetrics( req, res ) {
           { clientId: { $in: inputData.filterByClient } },
       );
     }
+    if ( inputData?.filterByAuditType?.length> 0 ) {
+      filter.push(
+          { clientId: { $in: inputData.filterByAuditType } },
+      );
+    }
     const query = [
       {
         $match: {
@@ -559,6 +578,11 @@ export async function userMetrics( req, res ) {
 
       );
     }
+    if ( inputData?.filterByAuditType?.length> 0 ) {
+      filter.push(
+          { clientId: { $in: inputData.filterByAuditType } },
+      );
+    }
     if ( inputData?.filterByStatus?.length> 0 ) {
       filter.push(
           { auditStatus: { $in: inputData.filterByStatus } },
@@ -587,6 +611,7 @@ export async function userMetrics( req, res ) {
           totalCompletedFiles: { $cond: [ { $eq: [ '$auditStatus', 'completed' ] }, 1, 0 ] },
           beforeCount: { $cond: [ { $eq: [ '$auditStatus', 'completed' ] }, '$beforeCount', 0 ] },
           afterCount: { $cond: [ { $eq: [ '$auditStatus', 'completed' ] }, '$afterCount', 0 ] },
+          zoneName: 1,
         },
       },
       {
@@ -599,6 +624,7 @@ export async function userMetrics( req, res ) {
           afterCount: { $sum: '$afterCount' },
           checkIntime: { $first: '$startTime' },
           checkOutTime: { $last: '$endTime' },
+          zoneName: { $last: '$zoneNmae' },
 
         },
       },
@@ -610,6 +636,7 @@ export async function userMetrics( req, res ) {
           totalCompletedFiles: 1,
           beforeCount: 1,
           afterCount: 1,
+          zoneName: 1,
           mappingPerc: { $round: [
             { $multiply: [
               { $divide: [ '$afterCount', '$beforeCount' ] }, 100,
@@ -631,6 +658,7 @@ export async function userMetrics( req, res ) {
           afterCount: 1,
           checkIntime: 1,
           checkOutTime: 1,
+          zoneName: 1,
           mappingPerc: 1,
           hours: { $floor: { $divide: [ '$differenceInSeconds', 3600 ] } },
           minutes: { $floor: { $divide: [ { $mod: [ '$differenceInSeconds', 3600 ] }, 60 ] } },
@@ -647,6 +675,7 @@ export async function userMetrics( req, res ) {
           afterCount: 1,
           checkIntime: 1,
           checkOutTime: 1,
+          zoneName: 1,
           hours: {
             $cond: {
               if: { $lt: [ '$hours', 10 ] },
@@ -680,6 +709,7 @@ export async function userMetrics( req, res ) {
           beforeCount: 1,
           afterCount: 1,
           checkIntime: 1,
+          zoneName: 1,
           checkOutTime: 1,
           workingHours: {
             $concat: [ '$hours', ':', '$minutes', ':', '$seconds' ],
@@ -718,6 +748,7 @@ export async function userMetrics( req, res ) {
           userName: '$userInfo.userName',
           userId: 1,
           fileDate: 1,
+          zoneName: 1,
           totalCompletedFiles: 1,
           beforeCount: 1,
           afterCount: 1,
@@ -761,8 +792,9 @@ export async function userMetrics( req, res ) {
             $project: {
               '_id': 0,
               'File Date': '$fileDate',
-              'zuser Name': '$userName',
+              'User Name': '$userName',
               'User Id': '$userId',
+              'Zone Name': '$zoneName',
               'Total Completed Files Count': '$totalCompletedFiles',
               'Total efore Count': '$beforeCount',
               'Total After Count': '$afterCount',
@@ -1138,7 +1170,8 @@ export async function overAllAuditSummary( req, res ) {
     let filters =[
       { fileDateISO: { $gte: dateRange.start } },
       { fileDateISO: { $lte: dateRange.end } },
-
+      { moduleType: { $eq: inputData.moduleType },
+      },
     ];
     if ( inputData.clientId.length > 0 ) {
       filters.push( { clientId: { $in: inputData.clientId } } );

package/src/controllers/zoneAudit.controller.js

@@ -1,4 +1,4 @@
-import { chunkArray, download, fileUpload, getJsonFileData, getUTC, insertOpenSearchData, listFileByPath, sendMessageToQueue, signedUrl, sqsReceive } from 'tango-app-api-middleware';
+import { download, fileUpload, getJsonFileData, getUTC, insertOpenSearchData, listFileByPath, sendMessageToQueue, signedUrl, sqsReceive } from 'tango-app-api-middleware';
 import { aggregateZoneUserAudit, createZoneUserAudit, findOneZoneUserAudit } from '../service/zoneUserAudit.service.js';
 import { logger } from 'tango-app-api-middleware';
 import { aggregateAssignZoneAudit } from '../service/assignZoneAudit.service.js';
@@ -899,40 +899,26 @@ export async function workSpace( req, res ) {
   }
 }
 
-export async function userZoneAuditHistory( req, res ) {
+export async function storeMetrics( req, res ) {
   try {
     const inputData = req.body;
-    const userId = inputData.userId || req.user._id;
     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 = [
-
-      { userId: { $eq: userId } },
-      { moduleType: 'zone' },
-
+      { fileDateISO: { $gte: dateRange.start } },
+      { fileDateISO: { $lte: dateRange.end } },
     ];
-    if ( inputData.fileType == 'fileDate' ) {
-      filter.push(
-          { fileDateISO: { $gte: dateRange.start } },
-          { fileDateISO: { $lte: dateRange.end } },
-      );
-    } else {
-      filter.push(
-          { createdAt: { $gte: dateRange.start } },
-          { createdAt: { $lte: dateRange.end } },
-      );
+    if ( inputData.filterByClientId && inputData.filterByClientId?.length > 0 ) {
+      filter.push( { clientId: { $in: inputData.filterByClientId } } );
     }
-    if ( inputData.filterByStoreId?.length > 0 ) {
-      filter.push( {
-        storeId: { $in: inputData.filterByStoreId },
-      } );
+
+    if ( inputData.filterByStoreId && inputData.filterByStoreId?.length > 0 ) {
+      filter.push( { storeId: { $in: inputData.filterByStoreId } } );
     }
 
-    if ( inputData.filterByStatus?.length > 0 ) {
-      filter.push( {
-        auditStatus: { $in: inputData.filterByStatus },
-      } );
+    if ( inputData.filterByStatus && inputData.filterByStatus?.length > 0 ) {
+      filter.push( { status: { $in: inputData.filterByStatus } } );
     }
 
     const query = [
@@ -941,129 +927,186 @@ export async function userZoneAuditHistory( req, res ) {
           $and: filter,
         },
       },
-    ];
-
-    if ( inputData.searchValue && inputData.searchValue!== '' ) {
-      query.push( {
-        $match: {
-          $or: [
-            { clientId: { $regex: inputData.searchValue, $options: 'i' } },
-            { clientName: { $regex: inputData.searchValue, $options: 'i' } },
+      {
+        $lookup: {
+          from: 'stores',
+          let: { storeId: '$storeId' },
+          pipeline: [
+            {
+              $match: {
+                $expr: {
+                  $eq: [ '$storeId', '$$storeId' ],
+                },
+              },
+            },
+            {
+              $project: {
+                storeName: 1,
+              },
+            },
+          ], as: 'store',
+        },
+      },
+      {
+        $unwind: {
+          path: '$store', preserveNullAndEmptyArrays: true,
+        },
+      },
+      {
+        $project: {
+          _id: 0,
+          fileDate: 1,
+          storeId: 1,
+          storeName: '$store.storeName',
+          userId: {
+            $arrayElemAt: [ '$userId', { $subtract: [ { $size: '$userId' }, 1 ] } ],
+          },
+          clientId: 1,
+          auditType: 1,
+          beforeCount: 1,
+          afterCount: { $ifNull: [ '$afterCount', null ] },
+          accuracy: { $round: [
+            { $divide: [
+              { $multiply: [ { $ifNull: [ '$afterCount', 0 ] }, '$beforeCount' ] }, 100,
+            ] }, 2,
           ],
 
+          },
+          timeSpent: 1,
+          status: 1,
         },
-      } );
-    }
-    if ( inputData.sortColumnName ) {
-      const sortBy = inputData.sortBy || -1;
-      query.push( {
-        $sort: { [inputData.sortColumName]: sortBy },
       },
-      );
-    }
-
-    query.push( {
-      $lookup: {
-        from: 'stores',
-        let: { storeId: '$storeId' },
-        pipeline: [
-          {
-            $match: {
-              $expr: {
-                $eq: [ '$storeId', '$$storeId' ],
+      {
+        $lookup: {
+          from: 'stores',
+          let: { storeId: '$storeId' },
+          pipeline: [
+            {
+              $match: {
+                $expr: {
+                  $eq: [ '$storeId', '$$storeId' ],
+                },
               },
             },
-          },
-          {
-            $project: {
-              storeName: 1,
+            {
+              $project: {
+                _id: 0,
+                storeName: 1,
+              },
             },
-          },
-        ], as: 'store',
+          ], as: 'stores',
+        },
       },
-
-    } );
-
-    query.push( {
-      $unwind: {
-        path: '$store', preserveNullAndEmptyArrays: true,
+      {
+        $unwind: {
+          path: '$stores',
+          preserveNullAndEmptyArrays: true,
+        },
       },
-    } );
-
+      {
+        $lookup: {
+          from: 'users',
+          let: { userId: '$userId' },
+          pipeline: [
+            {
+              $match: {
+                $expr: {
+                  $eq: [ '$_id', '$$userId' ],
+                },
+              },
+            },
+            {
+              $project: {
+                _id: 0,
+                userName: 1,
+                userEmail: '$email',
+              },
+            },
+          ], as: 'users',
+        },
+      },
+      {
+        $unwind: {
+          path: '$users',
+          preserveNullAndEmptyArrays: true,
+        },
+      },
+      {
+        $project: {
+          _id: 0,
+          fileDate: 1,
+          storeId: 1,
+          storeName: '$stores.storeName',
+          userName: '$users.userName',
+          userEmail: '$users.userEmail',
 
-    query.push( {
+          clientId: 1,
+          auditType: 1,
+          beforeCount: 1,
+          afterCount: { $ifNull: [ '$afterCount', null ] },
+          accuracy: { $round: [
+            { $divide: [
+              { $multiply: [ { $ifNull: [ '$afterCount', 0 ] }, '$beforeCount' ] }, 100,
+            ] }, 2,
+          ],
 
-      $project: {
-        storeId: 1,
-        userId: 1,
-        storeName: '$store.storeName',
-        zoneName: 1,
-        auditType: 1,
-        beforeCount: 1,
-        afterCount: 1,
-        accuracy: { $round: [
-          {
-            $divide: [ { $multiply: [ '$beforeCount', { $ifNull: [ '$afterCount', 0 ] } ] }, 100 ],
-          }, 2,
-        ],
+          },
+          timeSpent: 1,
+          status: 1,
         },
-        startTime: 1,
-        endTime: 1,
-        timeSpent: { $round: [
-          { $divide: [ '$timeSpent', 60 ] }, 2,
-        ] },
-        auditStatus: 1,
-        createdAt: 1,
       },
 
-    } );
+    ];
 
-    const count = await aggregateUserAudit( query );
-    if ( count.length == 0 ) {
-      return res.sendError( 'No Data Found', 204 );
+    if ( inputData.searchValue && inputData.searchValue !== '' ) {
+      query.push( {
+        $match: {
+          $or: [
+            { clientId: { $regex: inputData.searchValue, $options: 'i' } },
+            { clientName: { $regex: inputData.searchValue, $options: 'i' } },
+          ],
+        },
+      } );
     }
+    const count = await aggregateStoreZoneAudit( 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 aggregateStoreZoneAudit( query );
     if ( inputData.isExport ) {
-      const chunkedMappingData = await chunkArray( count, 10 );
-      const promises = chunkedMappingData.map( async ( chunk ) => {
-        const exportData = [];
-        chunk.forEach( ( element ) => {
-          exportData.push( {
-            'storeId': element.storeId,
-            'storeName': element.storeName,
-            'auditType': element.auditType,
-            'beforeCount': element.beforeCount,
-            'afterCount': element.afterCount,
-            'accuracy': element.accuracy,
-            'startTime': element.startTime,
-            'endTime': element.endTime,
-            'timeSpent': element.timeSpent,
-            'auditStatus': element.auditStatus,
-            'createdAt': element.createdAt,
-
-          } );
+      const exportdata = [];
+      result.forEach( ( element ) => {
+        exportdata.push( {
+          'File Date': element.fileDate,
+          'Store Id': element.storeId,
+          'Store Name': element.storeName,
+          'Client Id': element.clientId,
+          'User Name': element.userName,
+          'User Email': element.userEmail,
+          'Audit Type': element.auditType,
+          'Accuracy': element.accuracy,
+          'Time Spent': element.timeSpent,
+          'Status': element.status,
         } );
-        return exportData;
       } );
-      const mappedArrays = await Promise.all( promises );
-      mappedArrays.flat();
-
-      await download( mappedArrays, res );
+      await download( exportdata, res );
       return;
     }
-
-    query.push( {
-      $skip: offset,
-    },
-    {
-      $limit: limit,
-    } );
-    const result = await aggregateUserAudit( query );
-
-    return res.sendSuccess( { result: result } );
+    return res.sendSuccess( { result: result, count: count.length } );
   } catch ( error ) {
     const err = error.message || 'Internal Server Error';
-    logger.info( { error: error, message: req.body, function: 'userZoneAuditHistory' } );
+    logger.error( { error: error, data: req.body, function: 'storeMetrics' } );
     return res.sendError( err, 500 );
   }
 }

package/src/docs/zoneAudit.docs.js

@@ -1,5 +1,5 @@
 import j2s from 'joi-to-swagger';
-import { getDraftedDataSchema, getFileSchema, saveDraftSchema, saveSchema, userZoneAuditHistorySchema, workSpaceSchema } from '../dtos/zoneAudit.dtos.js';
+import { getDraftedDataSchema, getFileSchema, saveDraftSchema, saveSchema, storeMetricsSchema, workSpaceSchema } from '../dtos/zoneAudit.dtos.js';
 
 export const zoneAuditDocs = {
   '/v3/zone-audit/get-file': {
@@ -156,21 +156,21 @@ export const zoneAuditDocs = {
   },
 
   // metrics
-  '/v3/zone-audit/metrics/user-zone-audit-history': {
+  '/v3/zone-audit/metrics/store-metrics': {
     post: {
       tags: [ 'Zone Audit Metrics' ],
-      description: `get zone audit work history of a user`,
-      operationId: '/metrics/user-zone-audit-history',
+      description: `Get store level zone metrics`,
+      operationId: 'save',
       parameters: {},
       requestBody: {
         content: {
           'application/json': {
-            schema: j2s( userZoneAuditHistorySchema ).swagger,
+            schema: j2s( storeMetricsSchema ).swagger,
           },
         },
       },
       responses: {
-        200: { description: 'The Audited file has been submited successfully ' },
+        200: { description: 'Successful' },
         401: { description: 'Unauthorized User' },
         422: { description: 'Field Error' },
         500: { description: 'Server Error' },
@@ -178,4 +178,5 @@ export const zoneAuditDocs = {
       },
     },
   },
+
 };

package/src/dtos/auditMetrics.dtos.js

@@ -21,6 +21,7 @@ export const userAuditHistorySchema = joi.object(
       fileType: joi.string().required(),
       filterByStoreId: joi.array().required(),
       filterByType: joi.array().optional(),
+      filterByAuditType: joi.array().optional(),
       filterByStatus: joi.array().optional(),
       searchValue: joi.string().optional().allow( '' ),
       limit: joi.number().optional(),
@@ -44,6 +45,7 @@ export const storeMetricsSchema = joi.object(
       filterByClientId: joi.array().required(),
       filterByStoreId: joi.array().optional(),
       filterByStatus: joi.array().optional(),
+      filterByAuditType: joi.array().optional(),
       sortColumnName: joi.string().optional(),
       sortBy: joi.number().optional(),
       limit: joi.number().optional(),
@@ -60,6 +62,7 @@ export const clientMetricsSchema = joi.object(
     {
       fromDate: joi.string().required(),
       toDate: joi.string().required(),
+      filterByAuditType: joi.array().optional(),
       searchValue: joi.string().optional().allow( '' ),
       filterByClient: joi.array().required(),
       filterByStatus: joi.array().optional(),
@@ -82,6 +85,7 @@ export const userMetricsSchema = joi.object(
       fileType: joi.string().required(),
       searchValue: joi.string().optional().allow( '' ),
       filterByUser: joi.array().optional(),
+      filterByAuditType: joi.array().optional(),
       filterByStatus: joi.array().optional(),
       sortColumnName: joi.string().optional(),
       sortBy: joi.number().optional(),
@@ -144,6 +148,7 @@ export const overAllAuditSummarySchema = joi.object(
       fromDate: joi.string().required(),
       toDate: joi.string().required(),
       clientId: joi.array().optional(),
+      moduleType: joi.string().required(),
     },
 );
 

package/src/dtos/zoneAudit.dtos.js

@@ -87,26 +87,24 @@ export const workSpaceValid = {
   query: workSpaceSchema,
 };
 
-export const userZoneAuditHistorySchema = joi.object(
+export const storeMetricsSchema = joi.object(
     {
-      userId: joi.string().optional(),
       fromDate: joi.string().required(),
       toDate: joi.string().required(),
-      fileType: joi.string().required(),
-      filterByStoreId: joi.array().required(),
-      filterByType: joi.array().optional(),
-      filterByAuditType: joi.array().optional(),
-      filterByStatus: joi.array().optional(),
       searchValue: joi.string().optional().allow( '' ),
-      limit: joi.number().optional(),
-      offset: joi.number().optional(),
+      filterByClientId: joi.array().required(),
+      filterByStoreId: joi.array().optional(),
+      filterByStatus: joi.array().optional(),
+      filterByType: joi.array().optional(),
       sortColumnName: joi.string().optional(),
       sortBy: joi.number().optional(),
+      limit: joi.number().optional(),
+      offset: joi.number().optional(),
       isExport: joi.boolean().optional(),
-
     },
 );
 
-export const userZoneAuditHistoryValid = {
-  body: userZoneAuditHistorySchema,
+export const storeMetricsValid = {
+  body: storeMetricsSchema,
 };
+

package/src/routes/zone.routes.js

@@ -1,8 +1,9 @@
 import { Router } from 'express';
-import { getDraftedDataValid, getFileValid, saveDraftValid, saveValid, userZoneAuditHistoryValid, workSpaceValid } from '../dtos/zoneAudit.dtos.js';
+import { getDraftedDataValid, getFileValid, saveDraftValid, saveValid, workSpaceValid } from '../dtos/zoneAudit.dtos.js';
 import { isExistsQueue, validateUserAudit } from '../validation/audit.validation.js';
 import { isAllowedSessionHandler, validate } from 'tango-app-api-middleware';
-import { getDraftedData, getZoneAuditFile, save, saveDraft, userZoneAuditHistory, workSpace } from '../controllers/zoneAudit.controller.js';
+import { getDraftedData, getZoneAuditFile, save, saveDraft, storeMetrics, workSpace } from '../controllers/zoneAudit.controller.js';
+import { storeMetricsValid } from '../dtos/auditMetrics.dtos.js';
 
 export const zoneAuditRouter=Router();
 
@@ -14,4 +15,5 @@ zoneAuditRouter.post( '/save', isAllowedSessionHandler, validate( saveValid ), v
 zoneAuditRouter.get( '/work-space', isAllowedSessionHandler, validate( workSpaceValid ), workSpace );
 
 // metrics
-zoneAuditRouter.post( '/metrics/user-zone-audit-history', isAllowedSessionHandler, validate( userZoneAuditHistoryValid ), userZoneAuditHistory );
+
+zoneAuditRouter.post( '/metrics/store-metrics', isAllowedSessionHandler, validate( storeMetricsValid ), storeMetrics );