tango-app-api-audit 1.0.53 → 1.0.55

package/src/docs/audit.docs.js

@@ -1,4 +1,4 @@
-import { auditStoreSchema, clientMetricsSchema, clientSchema, getDraftedDataSchema, getFileSchema, saveDraftSchema, saveSchema, userAuditHistorySchema, userSchema, workSpaceSchema } from '../dtos/audit.dtos.js';
+import { auditStoreSchema, clientMetricsSchema, clientSchema, getDraftedDataSchema, getFileSchema, overAllAuditSummarySchema, overViewCardSchema, overViewTableSchema, saveDraftSchema, saveSchema, storeMetricsSchema, summarySplitSchema, userAuditHistorySchema, userMetricsSchema, userSchema, workSpaceSchema } from '../dtos/audit.dtos.js';
 import j2s from 'joi-to-swagger';
 
 export const auditDocs = {
@@ -268,7 +268,7 @@ export const auditDocs = {
     post: {
       tags: [ 'Audit Metrics' ],
       description: `Get list of user wise audit user details with date range`,
-      operationId: 'user-audit-history',
+      operationId: 'metrics/user-audit-history',
       parameters: {},
       requestBody: {
         content: {
@@ -290,7 +290,7 @@ export const auditDocs = {
     post: {
       tags: [ 'Audit Metrics' ],
       description: `Get list of client wise details with date range`,
-      operationId: 'client-metrics',
+      operationId: 'metrics/client-metrics',
       parameters: {},
       requestBody: {
         content: {
@@ -308,5 +308,139 @@ export const auditDocs = {
       },
     },
   },
+  '/v3/audit/metrics/store-metrics': {
+    post: {
+      tags: [ 'Audit Metrics' ],
+      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/audit/metrics/user-metrics': {
+    post: {
+      tags: [ 'Audit Metrics' ],
+      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' },
+      },
+    },
+  },
+  '/v3/audit/metrics/overview-table': {
+    post: {
+      tags: [ 'Audit Metrics' ],
+      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' },
+      },
+    },
+  },
+  '/v3/audit/metrics/overall-audit-summary': {
+    post: {
+      tags: [ 'Audit Metrics' ],
+      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/audit/metrics/overview-card': {
+    post: {
+      tags: [ 'Audit Metrics' ],
+      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/audit/metrics/summary-split-up': {
+    post: {
+      tags: [ 'Audit Metrics' ],
+      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' },
+      },
+    },
+  },
 };

package/src/docs/auditMetrics.docs.js

@@ -1,5 +1,5 @@
 import j2s from 'joi-to-swagger';
-import { auditImageValidSchema, getAuditImagesSchema, overAllAuditSummarySchema, overViewCardSchema, overViewTableSchema, reTriggerValidSchema, storeMetricsSchema, summarySplitSchema, userMetricsSchema } from '../dtos/auditMetrics.dtos.js';
+import { auditImageValidSchema, getAuditImagesSchema, reTriggerValidSchema } from '../dtos/auditMetrics.dtos.js';
 
 export const auditMetricsDocs = {
 
@@ -27,138 +27,6 @@ export const auditMetricsDocs = {
   },
 
 
-  '/v3/audit-metrics/store-metrics': {
-    post: {
-      tags: [ 'Audit Metrics' ],
-      description: `Get list of store wise details with date range and client Id`,
-      operationId: '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/audit-metrics/user-metrics': {
-    post: {
-      tags: [ 'Audit Metrics' ],
-      description: `Get list of file wise details with date range and users`,
-      operationId: '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' },
-      },
-    },
-  },
-  '/v3/audit-metrics/overview-card': {
-    post: {
-      tags: [ 'Audit Metrics' ],
-      description: `Get overall high level audited files count`,
-      operationId: '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/audit-metrics/summary-split-up': {
-    post: {
-      tags: [ 'Audit Metrics' ],
-      description: `Get overall high level audited files count splitup`,
-      operationId: '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/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' },
-      },
-    },
-  },
-  '/v3/audit-metrics/overall-audit-summary': {
-    post: {
-      tags: [ 'Audit Metrics' ],
-      description: `Get overall user taken data with some filters `,
-      operationId: '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/audit-metrics/re-trigger': {
     post: {
       tags: [ 'Audit Metrics' ],

package/src/dtos/audit.dtos.js

@@ -182,3 +182,105 @@ export const clientMetricsSchema = joi.object(
 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(),
+      filterByModuleType: 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 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(),
+      filterByModuleType: joi.array().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,
+};
+
+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().required(),
+      filterByModuleType: joi.array().optional(),
+      filterByAuditType: joi.array().optional(),
+      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(),
+      moduleType: joi.array().required(),
+    },
+);
+
+export const overAllAuditSummaryValid = {
+  body: overAllAuditSummarySchema,
+};
+
+export const overViewCardSchema = joi.object(
+    {
+      fromDate: joi.string().required(),
+      toDate: joi.string().required(),
+      clientId: joi.array().optional(),
+    },
+);
+
+export const overViewCardValid = {
+  body: overViewCardSchema,
+};
+
+export const summarySplitSchema = joi.object(
+    {
+      fromDate: joi.string().required(),
+      toDate: joi.string().required(),
+      clientId: joi.array().optional(),
+    },
+);
+
+export const summarySplitValid = {
+  body: summarySplitSchema,
+};

package/src/dtos/auditMetrics.dtos.js

@@ -14,107 +14,6 @@ export const getAuditImagesValid = {
 };
 
 
-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(),
-      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 storeMetricsValid = {
-  body: storeMetricsSchema,
-};
-
-
-export const userMetricsSchema = joi.object(
-    {
-      fromDate: joi.string().required(),
-      toDate: joi.string().required(),
-      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(),
-      limit: joi.number().optional(),
-      offset: joi.number().optional(),
-      isExport: joi.boolean().optional(),
-    },
-);
-
-export const userMetricsValid = {
-  body: userMetricsSchema,
-};
-
-export const overViewCardSchema = joi.object(
-    {
-      fromDate: joi.string().required(),
-      toDate: joi.string().required(),
-      clientId: joi.array().optional(),
-    },
-);
-
-export const overViewCardValid = {
-  body: overViewCardSchema,
-};
-
-export const summarySplitSchema = joi.object(
-    {
-      fromDate: joi.string().required(),
-      toDate: joi.string().required(),
-      clientId: joi.array().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().required(),
-      filterByType: joi.array().optional(),
-      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(),
-      moduleType: joi.string().required(),
-    },
-);
-
-export const overAllAuditSummaryValid = {
-  body: overAllAuditSummarySchema,
-};
-
 export const reTriggerValidSchema = joi.object(
     {
       fileDate: joi.string().required(),

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, 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';
+import { auditStoreList, auditUserList, clientMetrics, clients, getAuditFile, getDraftedData, overAllAuditSummary, overViewCard, overViewTable, save, saveDraft, storeMetrics, summarySplit, userAuditHistory, userMetrics, workSpace } from '../controllers/audit.controllers.js';
+import { auditStoreValid, clientMetricsValid, clientValid, getDraftedDataValid, getFileValid, overAllAuditSummaryValid, overViewCardValid, overViewTableValid, saveDraftValid, saveValid, storeMetricsValid, summarySplitValid, userAuditHistoryValid, userMetricsValid, workSpaceValid } from '../dtos/audit.dtos.js';
 
 export const auditRouter = express.Router();
 
@@ -22,6 +22,14 @@ 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 );
+auditRouter.post( '/metrics/store-metrics', isAllowedSessionHandler, validate( storeMetricsValid ), storeMetrics );
+auditRouter.post( '/metrics/user-metrics', isAllowedSessionHandler, validate( userMetricsValid ), userMetrics );
+auditRouter.post( '/metrics/overview-table', isAllowedSessionHandler, validate( overViewTableValid ), overViewTable );
+auditRouter.post( '/metrics/overall-audit-summary', isAllowedSessionHandler, validate( overAllAuditSummaryValid ), overAllAuditSummary );
 
 
+// hold
+auditRouter.post( '/metrics/overview-card', isAllowedSessionHandler, validate( overViewCardValid ), overViewCard );
+auditRouter.post( '/metrics/summary-split-up', isAllowedSessionHandler, validate( summarySplitValid ), summarySplit );
+
 export default auditRouter;

package/src/routes/auditMetrics.routes.js

@@ -1,20 +1,13 @@
 
 import express from 'express';
 import { isAllowedSessionHandler, validate } from 'tango-app-api-middleware';
-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 { auditImages, reTrigger } from '../controllers/auditMetrics.controllers.js';
+import { auditImageValid, reTriggerValid, 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( '/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 );
 auditMetricsRouter.post( '/re-trigger', isAllowedSessionHandler, validate( reTriggerValid ), isAuditDocumentExist, isAuditInputFolderExist, reTrigger );
 auditMetricsRouter.get( '/audit-images', isAllowedSessionHandler, validate( auditImageValid ), isAuditInputFolderExist, auditImages );
 auditMetricsRouter.post( '/view-log', isAllowedSessionHandler, validate( viewLogValid ), isAuditInputFolderExist, auditImages );