tango-app-api-audit 1.0.52 → 1.0.53

package/package.json

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

package/src/controllers/audit.controllers.js

@@ -1022,7 +1022,7 @@ export async function workSpace( req, res ) {
     );
     let totalStores = 0;
     for ( let i = 0; i < merge.length; i++ ) {
-      totalStores = merge[i]?.totalFilesCount || 0;
+      totalStores = merge[i]?.totalCount || 0;
 
       const pending = await listQueue( merge[i].queueName );
 
@@ -1041,7 +1041,7 @@ export async function workSpace( req, res ) {
                   Number( merge[i].clientAsignedCount ) :
                   0 ) :
               0,
-          totalCount: merge[i].totalFilesCount,
+          totalCount: merge[i].totalCount,
           queueName: merge[i].queueName,
           isDraft: merge[i]?.isDrafted || false,
           isEnable:
@@ -1051,11 +1051,11 @@ export async function workSpace( req, res ) {
             ( merge[i].userInprogressCount && merge[i].userInprogressCount > 0 ) ?
               1 :
               0,
-          completedRatio: merge[i].totalFilesCount ?
+          completedRatio: merge[i].totalCount ?
             merge[i].completedStoresCount ?
               Math.round(
                   ( Number( merge[i].completedStoresCount ) /
-                    Number( merge[i].totalFilesCount ) ) *
+                    Number( merge[i].totalCount ) ) *
                     100,
               ) :
               0 :
@@ -1660,3 +1660,227 @@ export async function userAuditHistory( req, res ) {
     return res.sendError( err, 500 );
   }
 }
+
+export async function clientMetrics( 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 filter = [
+      { fileDateISO: { $gte: dateRange.start } },
+      { fileDateISO: { $lte: dateRange.end } },
+    ];
+
+    let storeAuditFilter = [
+      { $eq: [ '$clientId', '$$clientId' ] },
+      { $eq: [ '$fileDate', '$$fileDate' ] },
+
+    ];
+
+    if ( inputData?.filterByModuleType?.length> 0 ) {
+      filter.push(
+          { moduleType: { $in: inputData.filterByModuleType } },
+      );
+      storeAuditFilter.push( {
+        $in: [ '$moduleType', inputData.filterByModuleType ],
+      } );
+    }
+
+    if ( inputData?.filterByClient?.length> 0 ) {
+      filter.push(
+          { clientId: { $in: inputData.filterByClient } },
+      );
+    }
+    const query = [
+      {
+        $match: {
+          $and: filter,
+        },
+      },
+      {
+        $group: {
+          _id: { clientId: '$clientId', fileDate: '$fileDate', moduleType: '$moduleType' },
+          fileDate: { $last: '$fileDate' },
+          clientId: { $last: '$clientId' },
+          clientName: { $last: '$clientName' },
+          moduleType: { $last: '$moduleType' },
+          installedStore: { $last: '$installedStore' },
+          queueName: { $last: '$queueName' },
+          totalFilesCount: { $sum: 1 },
+        },
+      },
+      {
+        $project: {
+          fileDate: 1,
+          clientId: 1,
+          clientName: 1,
+          queueName: 1,
+          installedStore: 1,
+          totalFilesCount: 1,
+          moduleType: 1,
+          notAssignedCount: { $ifNull: [ 0, 0 ] },
+          clientStatus: { $ifNull: [ '', '' ] },
+        },
+      },
+      {
+        $lookup: {
+          'from': 'storeAudit',
+          'let': { clientId: '$clientId', fileDate: '$fileDate', totalAuditFiles: '$totalFilesCount' },
+          'pipeline': [
+
+            {
+              $match: {
+                $expr: {
+                  $and: storeAuditFilter,
+                },
+              },
+            },
+            {
+              $project: {
+                completedStores: { $cond: [ { $eq: [ '$status', 'completed' ] }, 1, 0 ] },
+                notAssignedStores: { $cond: [ { $eq: [ '$status', 'not_assign' ] }, 1, 0 ] },
+                inprogressStores: { $cond: [ { $in: [ '$status', [ 'inprogress', 'drafted', 'assigned' ] ] }, 1, 0 ] },
+              },
+            },
+            {
+              $group: {
+                _id: { clientId: '$clientId', fileDate: '$fileDate' },
+                completedStores: { $sum: '$completedStores' },
+                inprogressStores: { $sum: '$inprogressStores' },
+                notAssignedStores: { $sum: '$notAssignedStores' },
+                fileCount: { $sum: 1 },
+              },
+            },
+            {
+              $project: {
+                _id: 0,
+                completedStores: 1,
+                inprogressStores: 1,
+                notAssignedStores: 1,
+                fileCount: 1,
+                completionPercentage: { $ifNull: [
+                  {
+                    $round: [ {
+                      $multiply: [
+                        100, {
+                          $divide: [
+                            '$completedStores', '$$totalAuditFiles',
+                          ],
+                        },
+                      ],
+                    }, 1 ],
+
+                  },
+                  0,
+                ],
+                },
+              },
+            },
+          ], 'as': 'storeAudit',
+        },
+      },
+      {
+        $unwind: {
+          path: '$storeAudit',
+          preserveNullAndEmptyArrays: true,
+        },
+      },
+      {
+        $project: {
+          _id: 0,
+          fileDate: 1,
+          clientId: 1,
+          clientName: 1,
+          totalFilesCount: 1,
+          moduleType: 1,
+          installedStore: 1,
+          // notAssignedStores: '$storeAudit.notAssignedStores',
+          inprogressStoresCount: '$storeAudit.inprogressStores',
+          // fileCount: '$storeAudit.fileCount',
+          notAssignedCount: 1,
+          clientStatus: { $cond: [ { $eq: [ '$storeAudit.fileCount', 0 ] }, 'not-taken', { $cond: [ { $or: [ { $gt: [ '$notAssignedCount', 0 ] }, { $gt: [ '$storeAudit.notAssignedStores', 0 ] } ] }, 'pending', 'completed' ] } ] },
+          completedStores: '$storeAudit.completedStores',
+          completionPercentage: '$storeAudit.completionPercentage',
+
+        },
+      },
+    ];
+
+    if ( inputData?.filterByStatus?.length> 0 ) {
+      query.push(
+          {
+            $match: { clientStatus: { $in: inputData.filterByStatus } },
+          },
+
+      );
+    }
+
+    if ( inputData.searchValue && inputData.searchValue!== '' ) {
+      query.push( {
+        $match: {
+          $or: [
+            { clientId: { $regex: inputData.searchValue, $options: 'i' } },
+            { clientName: { $regex: inputData.searchValue, $options: 'i' } },
+            { moduleType: { $regex: inputData.searchValue, $options: 'i' } },
+            { clientStatus: { $regex: inputData.searchValue, $options: 'i' } },
+          ],
+
+        },
+      } );
+    }
+    if ( inputData.sortColumnName ) {
+      const sortBy = inputData.sortBy || -1;
+      query.push( {
+        $sort: { [inputData.sortColumnName]: sortBy },
+      },
+      );
+    }
+
+    const count = await aggregateAuditStoreDataSchema( query );
+    if ( count.length == 0 ) {
+      return res.sendError( 'No Data Found', 204 );
+    }
+
+    query.push(
+        { $skip: offset },
+        { $limit: limit },
+    );
+    if ( inputData.isExport ) {
+      query.push(
+          {
+            $project: {
+              '_id': 0,
+              'File Date': '$fileDate',
+              'Client Name': '$clientName',
+              'Client Id': '$clientId',
+              'Module Type': '$moduleType',
+              'Completed Percentage': '$completionPercentage',
+              'Installed Stores': '$installedStore',
+              'Audit Stores': '$totalFilesCount',
+              'Inprogress Stores': '$inprogressStoresCount',
+              'Not Assigned': '$notAssignedCount',
+              // 'Not Assigned Stores': '$notAssignedStores',
+              'Completed': '$completedStores',
+              'Status': '$clientStatus',
+            },
+          },
+      );
+    }
+
+    logger.info( { query: query } );
+    const result = await aggregateAuditStoreDataSchema( query );
+    if ( result.length == 0 ) {
+      return res.sendError( 'No Data Found', 204 );
+    }
+    if ( inputData.isExport ) {
+      await download( result, res );
+      return;
+    }
+    return res.sendSuccess( { result: result, count: count.length } );
+  } catch ( error ) {
+    const err = error.error || 'Internal Server Error';
+    logger.info( { error: error, message: req.body, function: 'clientMetrics' } );
+    return res.sendError( err, 500 );
+  }
+}

package/src/controllers/auditMetrics.controllers.js

@@ -271,188 +271,6 @@ export async function storeMetrics( req, res ) {
   }
 }
 
-export async function clientMetrics( 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 filter = [
-      { fileDateISO: { $gte: dateRange.start } },
-      { fileDateISO: { $lte: dateRange.end } },
-      { moduleType: { $eq: 'traffic' } },
-
-    ];
-    if ( inputData?.filterByClient?.length> 0 ) {
-      filter.push(
-          { clientId: { $in: inputData.filterByClient } },
-      );
-    }
-    const query = [
-      {
-        $match: {
-          $and: filter,
-        },
-      },
-      {
-        $project: {
-          fileDate: 1,
-          clientId: 1,
-          clientName: 1,
-          queueName: 1,
-          installedStore: 1,
-          totalFilesCount: 1,
-          notAssignedCount: { $ifNull: [ 0, 0 ] },
-          clientStatus: { $ifNull: [ '', '' ] },
-        },
-      },
-      {
-        $lookup: {
-          'from': 'storeAudit',
-          'let': { clientId: '$clientId', fileDate: '$fileDate', totalAuditFiles: '$totalAuditFiles' },
-          'pipeline': [
-
-            {
-              $match: {
-                $expr: {
-                  $and: [
-                    { $eq: [ '$clientId', '$$clientId' ] },
-                    { $eq: [ '$fileDate', '$$fileDate' ] },
-                  ],
-                },
-              },
-            },
-            {
-              $project: {
-                completedStores: { $cond: [ { $eq: [ '$status', 'completed' ] }, 1, 0 ] },
-                notAssignedStores: { $cond: [ { $eq: [ '$status', 'not_assign' ] }, 1, 0 ] },
-                inprogressStores: { $cond: [ { $in: [ '$status', [ 'inprogress', 'drafted', 'assigned' ] ] }, 1, 0 ] },
-              },
-            },
-            {
-              $group: {
-                _id: { clientId: '$clientId', fileDate: '$fileDate' },
-                completedStores: { $sum: '$completedStores' },
-                inprogressStores: { $sum: '$inprogressStores' },
-                notAssignedStores: { $sum: '$notAssignedStores' },
-                fileCount: { $sum: 1 },
-              },
-            },
-            {
-              $project: {
-                _id: 0,
-                completedStores: 1,
-                inprogressStores: 1,
-                notAssignedStores: 1,
-                fileCount: 1,
-                completionPercentage: { $ifNull: [
-                  {
-                    $round: [ {
-                      $multiply: [
-                        100, {
-                          $divide: [
-                            '$completedStores', '$$totalAuditFiles',
-                          ],
-                        },
-                      ],
-                    }, 1 ],
-
-                  },
-                  0,
-                ],
-                },
-              },
-            },
-          ], 'as': 'storeAudit',
-        },
-      },
-      {
-        $unwind: {
-          path: '$storeAudit',
-          preserveNullAndEmptyArrays: true,
-        },
-      },
-      {
-        $project: {
-          fileDate: 1,
-          clientId: 1,
-          clientName: 1,
-          totalFilesCount: 1,
-          installedStore: 1,
-          notAssignedStores: '$storeAudit.notAssignedStores',
-          inprogressStoresCount: '$storeAudit.inprogressStores',
-          fileCount: '$storeAudit.fileCount',
-          notAssignedCount: 1,
-          clientStatus: { $cond: [ { $eq: [ '$storeAudit.fileCount', 0 ] }, 'not-taken', { $cond: [ { $or: [ { $gt: [ '$notAssignedCount', 0 ] }, { $gt: [ '$storeAudit.notAssignedStores', 0 ] } ] }, 'pending', 'completed' ] } ] },
-          completedStores: '$storeAudit.completedStores',
-          completionPercentage: '$storeAudit.completionPercentage',
-
-        },
-      },
-    ];
-
-    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 },
-      },
-      );
-    }
-    logger.info( { query: query } );
-    const count = [];// await aggregateAuditClientData( query );
-    if ( count.length == 0 ) {
-      return res.sendError( 'No Data Found', 204 );
-    }
-
-    query.push(
-        { $skip: offset },
-        { $limit: limit },
-    );
-    if ( inputData.isExport ) {
-      query.push(
-          {
-            $project: {
-              '_id': 0,
-              'File Date': '$fileDate',
-              'Client Name': '$clientName',
-              'Client Id': '$clientId',
-              'Completed Percentage': '$completionPercentage',
-              'Installed Stores': '$installedStore',
-              'Audit Stores': '$totalFilesCount',
-              'Inprogress Stores': '$inprogressStoresCount',
-              'Not Assigned': '$notAssignedCount',
-              'Not Assigned Stores': '$notAssignedStores',
-              'Completed': '$completedStores',
-              'Status': '$clientStatus',
-            },
-          },
-      );
-    }
-
-    logger.info( { query: query } );
-    const result = [];// await aggregateAuditClientData( query );
-    if ( inputData.isExport ) {
-      await download( result, res );
-      return;
-    }
-    return res.sendSuccess( { result: result, count: count.length } );
-  } catch ( error ) {
-    const err = error.error || 'Internal Server Error';
-    logger.info( { error: error, message: req.body, function: 'clientMetrics' } );
-    return res.sendError( err, 500 );
-  }
-}
 
 export async function userMetrics( req, res ) {
   try {

package/src/docs/audit.docs.js

@@ -1,4 +1,4 @@
-import { auditStoreSchema, clientSchema, getDraftedDataSchema, getFileSchema, saveDraftSchema, saveSchema, userAuditHistorySchema, userSchema, workSpaceSchema } from '../dtos/audit.dtos.js';
+import { auditStoreSchema, clientMetricsSchema, clientSchema, getDraftedDataSchema, getFileSchema, saveDraftSchema, saveSchema, userAuditHistorySchema, userSchema, workSpaceSchema } from '../dtos/audit.dtos.js';
 import j2s from 'joi-to-swagger';
 
 export const auditDocs = {
@@ -286,5 +286,27 @@ export const auditDocs = {
       },
     },
   },
+  '/v3/audit/metrics/client-metrics': {
+    post: {
+      tags: [ 'Audit Metrics' ],
+      description: `Get list of client wise details with date range`,
+      operationId: 'client-metrics',
+      parameters: {},
+      requestBody: {
+        content: {
+          'application/json': {
+            schema: j2s( clientMetricsSchema ).swagger,
+          },
+        },
+      },
+      responses: {
+        200: { description: 'Successful' },
+        401: { description: 'Unauthorized User' },
+        422: { description: 'Field Error' },
+        500: { description: 'Server Error' },
+        204: { description: 'Not Found' },
+      },
+    },
+  },
 
 };

package/src/docs/auditMetrics.docs.js

@@ -1,5 +1,5 @@
 import j2s from 'joi-to-swagger';
-import { auditImageValidSchema, clientMetricsSchema, getAuditImagesSchema, overAllAuditSummarySchema, overViewCardSchema, overViewTableSchema, reTriggerValidSchema, storeMetricsSchema, summarySplitSchema, userMetricsSchema } from '../dtos/auditMetrics.dtos.js';
+import { auditImageValidSchema, getAuditImagesSchema, overAllAuditSummarySchema, overViewCardSchema, overViewTableSchema, reTriggerValidSchema, storeMetricsSchema, summarySplitSchema, userMetricsSchema } from '../dtos/auditMetrics.dtos.js';
 
 export const auditMetricsDocs = {
 
@@ -25,28 +25,7 @@ export const auditMetricsDocs = {
       },
     },
   },
-  '/v3/audit-metrics/client-metrics': {
-    post: {
-      tags: [ 'Audit Metrics' ],
-      description: `Get list of client wise details with date range`,
-      operationId: 'client-metrics',
-      parameters: {},
-      requestBody: {
-        content: {
-          'application/json': {
-            schema: j2s( clientMetricsSchema ).swagger,
-          },
-        },
-      },
-      responses: {
-        200: { description: 'Successful' },
-        401: { description: 'Unauthorized User' },
-        422: { description: 'Field Error' },
-        500: { description: 'Server Error' },
-        204: { description: 'Not Found' },
-      },
-    },
-  },
+
 
   '/v3/audit-metrics/store-metrics': {
     post: {

package/src/dtos/audit.dtos.js

@@ -162,3 +162,23 @@ export const userAuditHistorySchema = joi.object(
 export const userAuditHistoryValid = {
   body: userAuditHistorySchema,
 };
+
+export const clientMetricsSchema = joi.object(
+    {
+      fromDate: joi.string().required(),
+      toDate: joi.string().required(),
+      searchValue: joi.string().optional().allow( '' ),
+      filterByModuleType: joi.array().optional(),
+      filterByClient: joi.array().required(),
+      filterByStatus: 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 clientMetricsValid = {
+  body: clientMetricsSchema,
+};

package/src/dtos/auditMetrics.dtos.js

@@ -35,24 +35,6 @@ export const storeMetricsValid = {
   body: storeMetricsSchema,
 };
 
-export const clientMetricsSchema = joi.object(
-    {
-      fromDate: joi.string().required(),
-      toDate: joi.string().required(),
-      searchValue: joi.string().optional().allow( '' ),
-      filterByClient: joi.array().required(),
-      filterByStatus: 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 clientMetricsValid = {
-  body: clientMetricsSchema,
-};
 
 export const userMetricsSchema = joi.object(
     {

package/src/routes/audit.routes.js

@@ -1,8 +1,8 @@
 import express from 'express';
 import { isExistsQueue, validateUserAudit } from '../validation/audit.validation.js';
 import { isAllowedSessionHandler, validate } from 'tango-app-api-middleware';
-import { auditStoreList, auditUserList, clients, getAuditFile, getDraftedData, save, saveDraft, userAuditHistory, workSpace } from '../controllers/audit.controllers.js';
-import { auditStoreValid, clientValid, getDraftedDataValid, getFileValid, saveDraftValid, saveValid, userAuditHistoryValid, workSpaceValid } from '../dtos/audit.dtos.js';
+import { auditStoreList, auditUserList, clientMetrics, clients, getAuditFile, getDraftedData, save, saveDraft, userAuditHistory, workSpace } from '../controllers/audit.controllers.js';
+import { auditStoreValid, clientMetricsValid, clientValid, getDraftedDataValid, getFileValid, saveDraftValid, saveValid, userAuditHistoryValid, workSpaceValid } from '../dtos/audit.dtos.js';
 
 export const auditRouter = express.Router();
 
@@ -21,6 +21,7 @@ auditRouter.get( '/work-space', isAllowedSessionHandler, validate( workSpaceVali
 
 // Audit Metrics
 auditRouter.post( '/metrics/user-audit-history', isAllowedSessionHandler, validate( userAuditHistoryValid ), userAuditHistory );
+auditRouter.post( '/metrics/client-metrics', isAllowedSessionHandler, validate( clientMetricsValid ), clientMetrics );
 
 
 export default auditRouter;

package/src/routes/auditMetrics.routes.js

@@ -1,15 +1,15 @@
 
 import express from 'express';
 import { isAllowedSessionHandler, validate } from 'tango-app-api-middleware';
-import { auditImages, clientMetrics, overAllAuditSummary, overViewCard, overViewTable, reTrigger, storeMetrics, summarySplit, userMetrics } from '../controllers/auditMetrics.controllers.js';
-import { auditImageValid, clientMetricsValid, overAllAuditSummaryValid, overViewCardValid, overViewTableValid, reTriggerValid, storeMetricsValid, summarySplitValid, userMetricsValid, viewLogValid } from '../dtos/auditMetrics.dtos.js';
+import { auditImages, overAllAuditSummary, overViewCard, overViewTable, reTrigger, storeMetrics, summarySplit, userMetrics } from '../controllers/auditMetrics.controllers.js';
+import { auditImageValid, overAllAuditSummaryValid, overViewCardValid, overViewTableValid, reTriggerValid, storeMetricsValid, summarySplitValid, userMetricsValid, viewLogValid } from '../dtos/auditMetrics.dtos.js';
 import { isAuditDocumentExist, isAuditInputFolderExist } from '../validation/audit.validation.js';
 
 export const auditMetricsRouter = express.Router();
 
 
 auditMetricsRouter.post( '/store-metrics', isAllowedSessionHandler, validate( storeMetricsValid ), storeMetrics );
-auditMetricsRouter.post( '/client-metrics', isAllowedSessionHandler, validate( clientMetricsValid ), clientMetrics );
+
 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 );