tango-app-api-audit 3.4.0-alpha.4 → 3.4.0-alpha.5

package/package.json

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

package/src/controllers/traxAudit.controllers.js

@@ -1,6 +1,6 @@
 import { checkFileExist, download, getDate, getDateWithCustomizeTime, getUTC, insertOpenSearchData, listFileByPath, logger, signedUrl, sqsReceive } from 'tango-app-api-middleware';
 import { aggregateBinaryAudit, createBinaryAudit, updateOneBinaryAuditModel } from '../service/binaryAudit.service.js';
-import { findOneStore } from '../service/store.service.js';
+import { countDocumentsStore, findOneStore } from '../service/store.service.js';
 import { findOneUser } from '../service/user.service.js';
 import { aggregateUserEmpDetection, createUserEmpDetection } from '../service/userEmpDetection.service.js';
 import { aggregateTraxAuditData, findOneTraxAuditData } from '../service/traxAuditData.service.js';
@@ -1181,6 +1181,7 @@ export async function saveBinary( req, res ) {
         let leftupdate={
           auditStatus: 'completed',
           answer: inputData.answer,
+          userCommands: inputData.userComments || '',
         };
         let updatDataleft= await updateOneBinaryAuditModel( leftquery, leftupdate );
         if ( updatDataleft.modifiedCount==0 ) {
@@ -1202,6 +1203,7 @@ export async function saveBinary( req, res ) {
         let cameraupdate={
           auditStatus: 'completed',
           answer: inputData.answer,
+          userCommands: inputData.userComments || '',
         };
         let updatDatacamera= await updateOneBinaryAuditModel( cameraquery, cameraupdate );
         if ( updatDatacamera.modifiedCount==0 ) {
@@ -2541,7 +2543,7 @@ export async function overAllAuditSummary( req, res ) {
         },
       },
     ];
-    const auditClientData = await aggregateAuditStoreData( auditClientDataQuery );
+    const auditClientData = await aggregateTraxAuditData( auditClientDataQuery );
     if ( auditClientData.length >0 ) {
       temp.auditStores = auditClientData[0].totalFilesCount;
     }
@@ -2593,7 +2595,7 @@ export async function overAllAuditSummary( req, res ) {
         },
       },
     ];
-    const storeAudit = await aggregateStoreAudit( storeAuditQuery );
+    const storeAudit = inputData.moduleType.includes( [ 'uniform-detection', 'mobile-detection' ] )?await aggregateStoreEmpDetection( storeAuditQuery ) : await aggregateBinaryAudit( storeAuditQuery );
     if ( storeAudit.length > 0 ) {
       temp.inprogressStores= storeAudit[0].inprogressStores;
       temp.completedStores = storeAudit[0].completedStores;
@@ -2613,3 +2615,406 @@ export async function overAllAuditSummary( req, res ) {
     return res.sendError( err, 500 );
   }
 }
+
+export async function overViewCard( req, res ) {
+  try {
+    const inputData = req.body;
+    const temp = {
+      totalCount: 0,
+      auditFileCount: 0,
+      ReAuditFileCount: 0,
+      inprogressCount: 0,
+      completedCount: 0,
+      pendingCount: 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: {
+          auditFileCount: {
+            $cond: [
+              { $eq: [ '$auditType', 'Audit' ] }, 1, 0,
+            ],
+          },
+          ReAuditFileCount: {
+            $cond: [
+              { $eq: [ '$auditType', 'ReAudit' ] }, 1, 0,
+            ],
+          },
+          inprogressCount: {
+            $cond: [
+              { $ne: [ '$status', 'completed' ] }, 1, 0,
+            ],
+          },
+          completedCount: {
+            $cond: [
+              { $eq: [ '$status', 'completed' ] }, 1, 0,
+            ],
+          },
+        },
+      },
+      {
+        $group: {
+          _id: { fileDate: '$fileDate', clientId: '$clientId' },
+          totalCount: { $sum: 1 },
+          auditFileCount: { $sum: '$auditFileCount' },
+          ReAuditFileCount: { $sum: '$ReAuditFileCount' },
+          inprogressCount: { $sum: '$inprogressCount' },
+          completedCount: { $sum: '$completedCount' },
+
+        },
+      },
+      {
+        $project: {
+          _id: 0,
+          totalCount: 1,
+          auditFileCount: 1,
+          ReAuditFileCount: 1,
+          inprogressCount: 1,
+          completedCount: 1,
+          notAssigned: { $subtract: [ '$totalCount', { $add: [ '$inprogressCount', '$completedCount' ] } ] },
+        },
+      },
+    ];
+    const result = inputData.moduleType.includes( [ 'uniform-detection', 'mobile-detection' ] )? await aggregateStoreEmpDetection( query ) : await aggregateBinaryAudit( query );
+    logger.info( { result: result } );
+    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: 'overViewCard' } );
+    return res.sendError( err, 500 );
+  }
+}
+
+export async function summarySplit( req, res ) {
+  try {
+    const inputData = req.body;
+    const temp = {
+      total: 0,
+      auditInprogress: 0,
+      reAuditInprogress: 0,
+      draft: 0,
+      assigned: 0,
+      auditCompleted: 0,
+      reAuditCompleted: 0,
+    };
+
+    const dateRange = await getUTC( new Date( inputData.fromDate ), new Date( inputData.toDate ) );
+    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 } } );
+    }
+    const query =[
+      {
+        $match: {
+          $and: filters,
+        },
+
+      },
+      {
+        $project: {
+          auditInprogress: {
+            $cond: [
+              { $and: [ { $eq: [ '$auditType', 'Audit' ] }, { $eq: [ '$status', 'inprogress' ] } ] }, 1, 0,
+            ],
+          },
+          reAuditInprogress: {
+            $cond: [
+              { $and: [ { $eq: [ '$auditType', 'ReAudit' ] }, { $eq: [ '$status', 'inprogress' ] } ] }, 1, 0,
+            ],
+          },
+          draft: {
+            $cond: [
+              { $eq: [ '$status', 'drafted' ] }, 1, 0,
+            ],
+          },
+          assigned: {
+            $cond: [
+              { $eq: [ '$status', 'assigned' ] }, 1, 0,
+            ],
+          },
+
+          reAuditCompleted: {
+            $cond: [
+              { $and: [ { $eq: [ '$auditType', 'ReAudit' ] }, { $eq: [ '$status', 'completed' ] } ] }, 1, 0,
+            ],
+          },
+          auditCompleted: {
+            $cond: [
+              { $and: [ { $eq: [ '$auditType', 'Audit' ] }, { $eq: [ '$status', 'completed' ] } ] }, 1, 0,
+            ],
+          },
+        },
+      },
+      {
+        $group: {
+          _id: null,
+          auditInprogress: { $sum: '$auditInprogress' },
+          reAuditInprogress: { $sum: '$reAuditInprogress' },
+          draft: { $sum: '$draft' },
+          assigned: { $sum: '$assigned' },
+          reAuditCompleted: { $sum: '$reAuditCompleted' },
+          auditCompleted: { $sum: '$auditCompleted' },
+
+        },
+      },
+      {
+        $project: {
+          _id: 0,
+          totalInprogress: 1,
+          auditInprogress: 1,
+          reAuditInprogress: 1,
+          draft: 1,
+          assigned: 1,
+          reAuditCompleted: 1,
+          auditCompleted: 1,
+          totalCount: { $ifNull: [ 0, 0 ] },
+
+        },
+      },
+    ];
+    const totalQuery = [
+      {
+        $match: {
+          $and: filters,
+        },
+
+      },
+      {
+        $group: {
+          _id: null,
+          total: { $sum: 1 },
+        },
+      },
+      {
+        $project: {
+          _id: 0,
+          total: 1,
+        },
+      },
+    ];
+    const result = inputData.moduleType.includes( [ 'uniform-detection', 'mobile-detection' ] )? await aggregateUserEmpDetection( query ) : await aggregateBinaryAudit( query );
+    const totalCount = await aggregateTraxAuditData( totalQuery );
+    result[0].totalCount = totalCount[0]?.total;
+    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 );
+  }
+}
+
+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 } },
+      { moduleType: { $eq: inputData.moduleType } },
+
+    ];
+
+    if ( inputData.clientId.length > 0 ) {
+      filters.push( { clientId: { $in: inputData.clientId } } );
+    }
+
+    if ( inputData.filterByAuditType.length > 0 ) {
+      filters.push( { auditType: { $in: inputData.filterByAuditType } } );
+    }
+
+    if ( inputData.filterByStatus.length > 0 ) {
+      filters.push( { status: { $in: inputData.filterByStatus } } );
+    }
+
+    const query =[
+      {
+        $match: {
+          $and: filters,
+        },
+
+      },
+      {
+        $project: {
+          _id: 0,
+          storeId: 1,
+          clientId: 1,
+          streamName: 1,
+          tempId: 1,
+          question: 1,
+          answer: 1,
+          userCommands: 1,
+          fileDate: 1,
+          moduleType: 1,
+          beforeCount: 1,
+          afterCount: 1,
+          auditType: 1,
+          status: 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,
+          clientId: 1,
+          streamName: 1,
+          tempId: 1,
+          question: 1,
+          answer: 1,
+          userCommands: 1,
+          fileDate: 1,
+          moduleType: 1,
+          beforeCount: 1,
+          afterCount: 1,
+          auditType: 1,
+          status: 1,
+          // userName: '$user.userName',
+          // userEmail: '$user.userEmail',
+
+        },
+      },
+    ];
+    if ( inputData.searchValue && inputData.searchValue!== '' ) {
+      query.push( {
+        $match: {
+          $or: [
+            { storeId: { $regex: inputData.searchValue, $options: 'i' } },
+            { clientId: { $regex: inputData.searchValue, $options: 'i' } },
+            { fileDate: { $regex: inputData.searchValue, $options: 'i' } },
+            { auditType: { $regex: inputData.searchValue, $options: 'i' } },
+            { status: { $regex: inputData.searchValue, $options: 'i' } },
+            { moduleType: { $regex: inputData.searchValue, $options: 'i' } },
+            { streamName: { $regex: inputData.searchValue, $options: 'i' } },
+            { tempId: { $regex: inputData.searchValue, $options: 'i' } },
+            { question: { $regex: inputData.searchValue, $options: 'i' } },
+            { answer: { $regex: inputData.searchValue, $options: 'i' } },
+            { userCommands: { $regex: inputData.searchValue, $options: 'i' } },
+            // { userName: { $regex: inputData.searchValue, $options: 'i' } },
+            // { userEmail: { $regex: inputData.searchValue, $options: 'i' } },
+          ],
+
+        },
+      } );
+    }
+    if ( inputData.sortColumnName ) {
+      const sortBy = inputData.sortBy || -1;
+      const sortColumn = inputData.sortColumnName;
+      query.push( {
+        $sort: { [sortColumn]: sortBy },
+      },
+      );
+    }
+    const count = inputData.moduleType.includes( [ 'uniform-detection', 'mobile-detection' ] )? await aggregateStoreEmpDetection( query ) : await aggregateBinaryAudit( 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 = inputData.moduleType.includes( [ 'uniform-detection', 'mobile-detection' ] )? await aggregateStoreEmpDetection( query ) : await aggregateBinaryAudit( query );
+    if ( inputData.isExport ) {
+      const exportdata = [];
+      result.forEach( ( element ) => {
+        if ( element.moduleType == 'zone' ) {
+          exportdata.push( {
+            'Store ID': element.storeId,
+            'Brand ID': element.clientId,
+            'Stream Name': element.streamName,
+            'Customer ID': element.tempId,
+            'Question': element.question,
+            'Answer': element.answer,
+            'User Comments': element.userCommands,
+            'File Date': element.fileDate,
+            'Product Type': element.moduleType,
+            'Audit Type': element.auditType,
+            'Before Count': element.beforeCount,
+            'After Count': element.afterCount,
+            // 'User Name': element.userName,
+            // 'User Email': element.userEmail,
+            'Status': element.status,
+          } );
+        } else {
+          exportdata.push( {
+            'Store ID': element.storeId,
+            'Brand ID': element.clientId,
+            'File Date': element.fileDate,
+            'Stream Name': element.streamName,
+            'Customer ID': element.tempId,
+            'Question': element.question,
+            'Answer': element.answer,
+            'User Comments': element.userCommands,
+            'Product Type': element.moduleType,
+            'Audit Type': element.auditType,
+            'Before Count': element.beforeCount,
+            'After Count': element.afterCount,
+            // 'User Name': element.userName,
+            // 'User Email': element.userEmail,
+            'Status': element.status,
+          } );
+        }
+      } );
+      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: 'overviewTable' } );
+    return res.sendError( err, 500 );
+  }
+}

package/src/docs/traxAudit.docs.js

@@ -1,5 +1,5 @@
 import j2s from 'joi-to-swagger';
-import { getFileSchema, userAuditHistorySchema, workSpaceSchema, saveSchema, clientMetricsSchema, storeMetricsSchema, userMetricsSchema, pendingSummaryTableSchema } from '../dtos/traxAudit.dtos.js';
+import { getFileSchema, userAuditHistorySchema, workSpaceSchema, saveSchema, clientMetricsSchema, storeMetricsSchema, userMetricsSchema, pendingSummaryTableSchema, overAllAuditSummarySchema, overviewTableSchema, summarySplitSchema, overViewCardSchema } from '../dtos/traxAudit.dtos.js';
 
 export const traxAuditDocs = {
 
@@ -200,4 +200,94 @@ export const traxAuditDocs = {
       },
     },
   },
+  '/v3/trax-audit/metrics/overall-audit-summary': {
+    post: {
+      tags: [ 'Trax Audit' ],
+      description: `Get overall user taken data with some filters `,
+      operationId: 'metrics/overall-audit-summary',
+      parameters: {},
+      requestBody: {
+        content: {
+          'application/json': {
+            schema: j2s( overAllAuditSummarySchema ).swagger,
+          },
+        },
+      },
+      responses: {
+        200: { description: 'Successful' },
+        401: { description: 'Unauthorized User' },
+        422: { description: 'Field Error' },
+        500: { description: 'Server Error' },
+        204: { description: 'Not Found' },
+      },
+    },
+  },
+  '/v3/trax-audit/metrics/overview-card': {
+    post: {
+      tags: [ 'Trax Audit' ],
+      description: `Get overall high level audited files count`,
+      operationId: 'metrics/overview-card',
+      parameters: {},
+      requestBody: {
+        content: {
+          'application/json': {
+            schema: j2s( overViewCardSchema ).swagger,
+          },
+        },
+      },
+      responses: {
+        200: { description: 'Successful' },
+        401: { description: 'Unauthorized User' },
+        422: { description: 'Field Error' },
+        500: { description: 'Server Error' },
+        204: { description: 'Not Found' },
+      },
+    },
+  },
+
+  '/v3/trax-audit/metrics/summary-split-up': {
+    post: {
+      tags: [ 'Trax Audit' ],
+      description: `Get overall high level audited files count splitup`,
+      operationId: 'metrics/summary-split-up',
+      parameters: {},
+      requestBody: {
+        content: {
+          'application/json': {
+            schema: j2s( summarySplitSchema ).swagger,
+          },
+        },
+      },
+      responses: {
+        200: { description: 'Successful' },
+        401: { description: 'Unauthorized User' },
+        422: { description: 'Field Error' },
+        500: { description: 'Server Error' },
+        204: { description: 'Not Found' },
+      },
+    },
+  },
+
+  '/v3/trax-audit/metrics/overview-table': {
+    post: {
+      tags: [ 'Trax Audit' ],
+      description: `Get overall user taken data with some filters `,
+      operationId: 'metrics/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/traxAudit.dtos.js

@@ -218,3 +218,51 @@ export const overAllAuditSummarySchema = joi.object(
 export const overAllAuditSummaryValid = {
   body: overAllAuditSummarySchema,
 };
+
+
+export const overViewCardSchema = joi.object(
+    {
+      fromDate: joi.string().required(),
+      toDate: joi.string().required(),
+      clientId: joi.array().optional(),
+      moduleType: joi.string().required(),
+    },
+);
+
+export const overViewCardValid = {
+  body: overViewCardSchema,
+};
+
+export const summarySplitSchema = joi.object(
+    {
+      fromDate: joi.string().required(),
+      toDate: joi.string().required(),
+      clientId: joi.array().optional(),
+      moduleType: joi.string().optional(),
+    },
+);
+
+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.string().optional().allow( '' ),
+      filterByStatus: joi.array().optional(),
+      moduleType: joi.string().optional(),
+      filterByAuditType: joi.array().optional(),
+      sortColumnName: joi.string().optional(),
+      sortBy: joi.number().optional(),
+      isExport: joi.boolean().optional(),
+    },
+);
+
+export const overviewTableValid= {
+  body: overviewTableSchema,
+};

package/src/routes/traxAudit.routes.js

@@ -1,8 +1,8 @@
 import { Router } from 'express';
 import { isAllowedSessionHandler, validate } from 'tango-app-api-middleware';
-import { getDetectionFileValid, getFileValid, userAuditHistoryValid, workSpaceValid, saveValid, clientMetricsValid, storeMetricsValid, userMetricsValid, pendingSummaryTableValid, overAllAuditSummaryValid } from '../dtos/traxAudit.dtos.js';
+import { getDetectionFileValid, getFileValid, userAuditHistoryValid, workSpaceValid, saveValid, clientMetricsValid, storeMetricsValid, userMetricsValid, pendingSummaryTableValid, overAllAuditSummaryValid, summarySplitValid, overviewTableValid, overViewCardValid } from '../dtos/traxAudit.dtos.js';
 import { isExistsQueue } from '../validation/audit.validation.js';
-import { clientMetrics, getAuditFile, getDetectionAuditFile, overAllAuditSummary, pendingSummaryTable, saveBinary, storeMetrics, userAuditHistory, userMetrics, workSpace } from '../controllers/traxAudit.controllers.js';
+import { clientMetrics, getAuditFile, getDetectionAuditFile, overAllAuditSummary, overViewCard, overviewTable, pendingSummaryTable, saveBinary, storeMetrics, summarySplit, userAuditHistory, userMetrics, workSpace } from '../controllers/traxAudit.controllers.js';
 import { validateBinaryAudit } from '../validation/traxAuditValidation.js';
 
 export const traxAuditRouter = Router();
@@ -28,4 +28,10 @@ traxAuditRouter.post( '/metrics/user-metrics', isAllowedSessionHandler, validate
 traxAuditRouter.post( '/metrics/pending-summary-table', isAllowedSessionHandler, validate( pendingSummaryTableValid ), pendingSummaryTable );
 traxAuditRouter.post( '/metrics/overall-audit-summary', isAllowedSessionHandler, validate( overAllAuditSummaryValid ), overAllAuditSummary );
 
+// summary
+
+traxAuditRouter.post( '/metrics/overview-card', isAllowedSessionHandler, validate( overViewCardValid ), overViewCard );
+traxAuditRouter.post( '/metrics/summary-split-up', isAllowedSessionHandler, validate( summarySplitValid ), summarySplit );
+traxAuditRouter.post( '/metrics/overview-table', isAllowedSessionHandler, validate( overviewTableValid ), overviewTable );
+
 export default traxAuditRouter;