tango-app-api-audit 3.4.0-alpha.1 → 3.4.0-alpha.3

package/src/docs/traxAudit.docs.js

@@ -1,5 +1,5 @@
 import j2s from 'joi-to-swagger';
-import { getFileSchema } from '../dtos/traxAudit.dtos.js';
+import { getFileSchema, userAuditHistorySchema, workSpaceSchema, saveSchema, clientMetricsSchema, storeMetricsSchema, userMetricsSchema } from '../dtos/traxAudit.dtos.js';
 
 export const traxAuditDocs = {
 
@@ -43,4 +43,139 @@ export const traxAuditDocs = {
       },
     },
   },
+
+  '/v3/trax-audit/work-space': {
+    post: {
+      tags: [ 'Trax Audit' ],
+      description: 'queue wise info of audit files ',
+      operationId: 'work-space',
+      requestBody: {
+        content: {
+          'application/json': {
+            schema: j2s( workSpaceSchema ).swagger,
+          },
+        },
+      },
+      responses: {
+        200: { description: 'Successful' },
+        401: { description: 'Unauthorized User' },
+        422: { description: 'Field Error' },
+        500: { description: 'Server Error' },
+        204: { description: 'Not Found' },
+      },
+    },
+  },
+
+  '/v3/trax-audit/save-binary-audit': {
+    post: {
+      tags: [ 'Trax Audit' ],
+      description: 'Save binay data type',
+      operationId: 'save-binary-audit',
+      parameters: {},
+      requestBody: {
+        content: {
+          'application/json': {
+            schema: j2s( saveSchema ).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/user-audit-history': {
+    post: {
+      tags: [ 'Trax Audit' ],
+      description: `Get list of user wise audit user details with date range`,
+      operationId: 'metrics/user-audit-history',
+      parameters: {},
+      requestBody: {
+        content: {
+          'application/json': {
+            schema: j2s( userAuditHistorySchema ).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/client-metrics': {
+    post: {
+      tags: [ 'Trax Audit' ],
+      description: `Get list of client wise details with date range`,
+      operationId: 'metrics/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/trax-audit/metrics/store-metrics': {
+    post: {
+      tags: [ 'Trax Audit' ],
+      description: `Get list of store wise details with date range and client Id`,
+      operationId: 'metrics/store-metrics',
+      parameters: {},
+      requestBody: {
+        content: {
+          'application/json': {
+            schema: j2s( storeMetricsSchema ).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/user-metrics': {
+    post: {
+      tags: [ 'Trax Audit' ],
+      description: `Get list of file wise details with date range and users`,
+      operationId: 'metrics/user-metrics',
+      parameters: {},
+      requestBody: {
+        content: {
+          'application/json': {
+            schema: j2s( userMetricsSchema ).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

@@ -68,18 +68,12 @@ export const saveSchema = joi.object(
       auditId: joi.string().required(),
       storeId: joi.string().required(),
       fileDate: joi.string().required(),
-      auditType: joi.string().required(),
-      moduleType: joi.string().required(),
-      zoneName: joi.string().required(),
-      beforeCount: joi.number().required(),
-      junkCount: joi.number().required(),
-      junk: joi.array().required(),
-      employeeCount: joi.number().required(),
-      employee: joi.array().required(),
-      customerCount: joi.number().required(),
-      customer: joi.array().required(),
+      tempId: joi.number().optional(),
       moduleType: joi.string().required(),
-      zoneName: joi.string().required(),
+      question: joi.string().optional(),
+      streamName: joi.string().optional(),
+      answer: joi.string().required(),
+      userComments: joi.string().required(),
     },
 );
 
@@ -103,3 +97,90 @@ export const workSpaceSchema = joi.object(
 export const workSpaceValid = {
   body: workSpaceSchema,
 };
+
+export const userAuditHistorySchema = joi.object(
+    {
+      userId: joi.string().optional(),
+      fromDate: joi.string().required(),
+      toDate: joi.string().required(),
+      dateType: joi.string().required(),
+      clientId: joi.array().optional(),
+      filterByStoreId: joi.array().required(),
+      moduleType: joi.string().required(),
+      filterByAuditType: joi.array().optional(),
+      filterByStatus: joi.array().optional(),
+      searchValue: joi.string().optional().allow( '' ),
+      limit: joi.number().optional(),
+      offset: joi.number().optional(),
+      sortColumnName: joi.string().optional(),
+      sortBy: joi.number().optional(),
+      isExport: joi.boolean().optional(),
+
+    },
+);
+
+export const userAuditHistoryValid = {
+  body: userAuditHistorySchema,
+};
+
+export const clientMetricsSchema = joi.object(
+    {
+      fromDate: joi.string().required(),
+      toDate: joi.string().required(),
+      searchValue: joi.string().optional().allow( '' ),
+      moduleType: joi.string().required(),
+      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 storeMetricsSchema = joi.object(
+    {
+      fromDate: joi.string().required(),
+      toDate: joi.string().required(),
+      searchValue: joi.string().optional().allow( '' ),
+      filterByClientId: joi.array().required(),
+      filterByStoreId: joi.array().optional(),
+      filterByStatus: joi.array().optional(),
+      filterByAuditType: joi.array().optional(),
+      moduleType: joi.string().required(),
+      sortColumnName: joi.string().optional(),
+      sortBy: joi.number().optional(),
+      limit: joi.number().optional(),
+      offset: joi.number().optional(),
+      isExport: joi.boolean().optional(),
+    },
+);
+
+export const storeMetricsValid = {
+  body: storeMetricsSchema,
+};
+export const userMetricsSchema = joi.object(
+    {
+      fromDate: joi.string().required(),
+      toDate: joi.string().required(),
+      dateType: joi.string().required(),
+      searchValue: joi.string().optional().allow( '' ),
+      filterByUser: joi.array().optional(),
+      moduleType: joi.string().optional(),
+      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 userMetricsValid = {
+  body: userMetricsSchema,
+};

package/src/routes/traxAudit.routes.js

@@ -1,17 +1,29 @@
 import { Router } from 'express';
 import { isAllowedSessionHandler, validate } from 'tango-app-api-middleware';
-import { getDetectionFileValid, getFileValid } from '../dtos/traxAudit.dtos.js';
+import { getDetectionFileValid, getFileValid, userAuditHistoryValid, workSpaceValid, saveValid, clientMetricsValid, storeMetricsValid, userMetricsValid } from '../dtos/traxAudit.dtos.js';
 import { isExistsQueue } from '../validation/audit.validation.js';
-import { getAuditFile, getDetectionAuditFile } from '../controllers/traxAudit.controllers.js';
+import { clientMetrics, getAuditFile, getDetectionAuditFile, saveBinary, storeMetrics, userAuditHistory, userMetrics, workSpace } from '../controllers/traxAudit.controllers.js';
+import { validateBinaryAudit } from '../validation/traxAuditValidation.js';
 
 export const traxAuditRouter = Router();
 
 // Audit Mapping
-traxAuditRouter.get( '/get-file', isAllowedSessionHandler, validate( getFileValid ), isExistsQueue, getAuditFile );
-traxAuditRouter.get( '/get-file', isAllowedSessionHandler, validate( getDetectionFileValid ), isExistsQueue, getDetectionAuditFile );
+
+traxAuditRouter.get( '/get-file-detection', isAllowedSessionHandler, validate( getDetectionFileValid ), isExistsQueue, getDetectionAuditFile );
 // traxAuditRouter.post( '/save-draft', isAllowedSessionHandler, validate( saveDraftValid ), saveDraft );
 // traxAuditRouter.get( '/get-drafted-data', isAllowedSessionHandler, validate( getDraftedDataValid ), getDraftedData );
-// traxAuditRouter.post( '/save', isAllowedSessionHandler, validate( saveValid ), validateUserAudit, save );
-// traxAuditRouter.post( '/work-space', isAllowedSessionHandler, validate( workSpaceValid ), workSpace );
+// traxAuditRouter.post( '/save', isAllowedSessionHandler, validate( saveValid ), validateUserEmpDetection, save );        use this validateuserEMpDetection
+traxAuditRouter.post( '/work-space', isAllowedSessionHandler, validate( workSpaceValid ), workSpace );
+
+
+// Y/n
+traxAuditRouter.get( '/get-file', isAllowedSessionHandler, validate( getFileValid ), isExistsQueue, getAuditFile );
+traxAuditRouter.post( '/save-binary-audit', isAllowedSessionHandler, validate( saveValid ), validateBinaryAudit, saveBinary );
+
+// metrcis
+traxAuditRouter.post( '/metrics/user-audit-history', isAllowedSessionHandler, validate( userAuditHistoryValid ), userAuditHistory );
+traxAuditRouter.post( '/metrics/client-metrics', isAllowedSessionHandler, validate( clientMetricsValid ), clientMetrics );
+traxAuditRouter.post( '/metrics/store-metrics', isAllowedSessionHandler, validate( storeMetricsValid ), storeMetrics );
+traxAuditRouter.post( '/metrics/user-metrics', isAllowedSessionHandler, validate( userMetricsValid ), userMetrics );
 
 export default traxAuditRouter;

package/src/service/binaryAudit.service.js

@@ -5,6 +5,14 @@ export function createBinaryAudit( record ) {
   return binaryAuditModel.create( record );
 }
 
-export function aggregateBinaryAuditModel( query ) {
+export function aggregateBinaryAudit( query ) {
   return binaryAuditModel.aggregate( query, { collation: { locale: 'en', strength: 2 } } );
 }
+
+export function findOneBinaryAudit( query ) {
+  return binaryAuditModel.findOne( query );
+}
+
+export function updateOneBinaryAuditModel( query, record ) {
+  return binaryAuditModel.updateOne( query, { $set: record } );
+}

package/src/service/storeEmpDetection.service.js

@@ -0,0 +1,6 @@
+import storeEmpDetectionModel from 'tango-api-schema/schema/storeEmpDetection.model.js';
+
+
+export function aggregateStoreEmpDetection( query ) {
+  return storeEmpDetectionModel.aggregate( query, { collation: { locale: 'en', strength: 2 } } );
+}

package/src/service/traxAuditData.service.js

@@ -0,0 +1,10 @@
+
+import traxAuditDataModel from 'tango-api-schema/schema/traxAuditData.model.js';
+
+export function findOneTraxAuditData( query, fields, sort ) {
+  return traxAuditDataModel.findOne( query, fields ).sort( sort );
+}
+
+export function aggregateTraxAuditData( query ) {
+  return traxAuditDataModel.aggregate( query, { collation: { locale: 'en', strength: 2 } } );
+}

package/src/service/userEmpDetection.service.js

@@ -1,6 +1,14 @@
 import userEmpDetectionModel from 'tango-api-schema/schema/userEmpDetection.model.js';
 
 
-export function aggregateUserAudit( query ) {
+export function aggregateUserEmpDetection( query ) {
   return userEmpDetectionModel.aggregate( query, { collation: { locale: 'en', strength: 2 } } );
 }
+
+export function createUserEmpDetection( record ) {
+  return userEmpDetectionModel.create( record );
+}
+
+export function findOneUserEmpDetection( query, fields ) {
+  return userEmpDetectionModel.findOne( query, fields );
+}

package/src/validation/traxAuditValidation.js

@@ -0,0 +1,39 @@
+import { findOneBinaryAudit } from '../service/binaryAudit.service.js';
+import { findOneUserEmpDetection } from '../service/userEmpDetection.service.js';
+
+
+export async function validateUserEmpDetection( req, res, next ) {
+  try {
+    const inputData = req.body;
+    const userAuditDetails =await findOneUserEmpDetection( { _id: inputData.auditId } );
+    if ( !userAuditDetails ) {
+      return res.sendError( 'No Data Available' );
+    } else if ( userAuditDetails && userAuditDetails.auditStatus == 'skipped' ) {
+      return res.sendError( 'The Audit file Assigned to some one else', 203 );
+    }
+    req.userAudit = userAuditDetails;
+    next();
+  } catch ( error ) {
+    const err = error.message || 'Internal Server Error';
+    logger.error( { error: error, message: req.query, function: 'validateUserEmpDetection' } );
+    return res.sendError( err, 500 );
+  }
+}
+
+export async function validateBinaryAudit( req, res, next ) {
+  try {
+    const inputData = req.body;
+    const userAuditDetails =await findOneBinaryAudit( { _id: inputData.auditId } );
+    if ( !userAuditDetails ) {
+      return res.sendError( 'No Data Available' );
+    } else if ( userAuditDetails && userAuditDetails.auditStatus == 'completed' ) {
+      return res.sendError( 'Forbidden to this action', 203 );
+    }
+    req.userAudit = userAuditDetails;
+    next();
+  } catch ( error ) {
+    const err = error.message || 'Internal Server Error';
+    logger.error( { error: error, message: req.query, function: 'validateBinaryAudit' } );
+    return res.sendError( err, 500 );
+  }
+}