tango-app-api-audit 3.3.0-alpha.2 → 3.3.0-alpha.21

package/src/docs/auditMetrics.docs.js

@@ -1,70 +0,0 @@
-import j2s from 'joi-to-swagger';
-import { auditImageValidSchema, getAuditImagesSchema } from '../dtos/auditMetrics.dtos.js';
-
-export const auditMetricsDocs = {
-
-  '/v3/audit-metrics/get-audit-images': {
-    post: {
-      tags: [ 'Audit Metrics' ],
-      description: `Get list of client with date range`,
-      operationId: 'client-list-table',
-      parameters: {},
-      requestBody: {
-        content: {
-          'application/json': {
-            schema: j2s( getAuditImagesSchema ).swagger,
-          },
-        },
-      },
-      responses: {
-        200: { description: 'Get user permission successfully' },
-        401: { description: 'Unauthorized User' },
-        422: { description: 'Field Error' },
-        500: { description: 'Server Error' },
-        204: { description: 'Not Found' },
-      },
-    },
-  },
-
-
-  '/v3/audit-metrics/audit-images': {
-    get: {
-      tags: [ 'Audit Metrics' ],
-      description: `View and Download audit images`,
-      operationId: 'audit-images',
-      parameters: [
-        {
-          in: 'query',
-          name: 'fileDate',
-          scema: j2s( auditImageValidSchema ).swagger,
-          require: true,
-        },
-        {
-          in: 'query',
-          name: 'storeId',
-          scema: j2s( auditImageValidSchema ).swagger,
-          require: true,
-        },
-        {
-          in: 'query',
-          name: 'imageType',
-          scema: j2s( auditImageValidSchema ).swagger,
-          require: true,
-        },
-        {
-          in: 'query',
-          name: 'export',
-          scema: j2s( auditImageValidSchema ).swagger,
-          require: true,
-        },
-      ],
-      responses: {
-        200: { description: 'Successful' },
-        401: { description: 'Unauthorized User' },
-        422: { description: 'Field Error' },
-        500: { description: 'Server Error' },
-        204: { description: 'Not Found' },
-      },
-    },
-  },
-};

package/src/docs/zoneAudit.docs.js

@@ -1,268 +0,0 @@
-import j2s from 'joi-to-swagger';
-import { clientMetricsSchema, getDraftedDataSchema, getFileSchema, saveDraftSchema, saveSchema, storeMetricsSchema, workSpaceSchema, zoneAuditImageValidSchema, reTriggerValidSchema } from '../dtos/zoneAudit.dtos.js';
-
-export const zoneAuditDocs = {
-  '/v3/zone-audit/get-file': {
-    get: {
-      tags: [ 'Zone Audit' ],
-      description: 'Get a file via queue message',
-      operationId: 'get-file',
-      parameters: [
-        {
-          in: 'query',
-          name: 'queueName',
-          scema: j2s( getFileSchema ).swagger,
-          require: true,
-        },
-        {
-          in: 'query',
-          name: 'nextId',
-          scema: j2s( getFileSchema ).swagger,
-          require: false,
-        },
-        {
-          in: 'query',
-          name: 'limit',
-          scema: j2s( getFileSchema ).swagger,
-          require: false,
-        },
-      ],
-      responses: {
-        200: { description: 'Successful' },
-        401: { description: 'Unauthorized User' },
-        422: { description: 'Field Error' },
-        500: { description: 'Server Error' },
-        204: { description: 'Not Found' },
-      },
-    },
-  },
-  '/v3/zone-audit/save-draft': {
-    post: {
-      tags: [ 'Zone Audit' ],
-      description: `saved zone audited file. which is save in the mongo db`,
-      operationId: 'save-draft',
-      parameters: {},
-      requestBody: {
-        content: {
-          'application/json': {
-            schema: j2s( saveDraftSchema ).swagger,
-          },
-        },
-      },
-      responses: {
-        200: { description: 'Successful' },
-        401: { description: 'Unauthorized User' },
-        422: { description: 'Field Error' },
-        500: { description: 'Server Error' },
-        204: { description: 'Not Found' },
-      },
-    },
-  },
-  '/v3/zone-audit/get-drafted-data': {
-    get: {
-      tags: [ 'Zone Audit' ],
-      description: 'Get a saved file via DB',
-      operationId: 'get-drafted-data',
-      parameters: [
-        {
-          in: 'query',
-          name: 'fileDate',
-          scema: j2s( getDraftedDataSchema ).swagger,
-          require: true,
-        },
-        {
-          in: 'query',
-          name: 'storeId',
-          scema: j2s( getDraftedDataSchema ).swagger,
-          require: true,
-        },
-        {
-          in: 'query',
-          name: 'zoneName',
-          scema: j2s( getDraftedDataSchema ).swagger,
-          require: true,
-        },
-      ],
-      responses: {
-        200: { description: 'Successful' },
-        401: { description: 'Unauthorized User' },
-        422: { description: 'Field Error' },
-        500: { description: 'Server Error' },
-        204: { description: 'Not Found' },
-      },
-    },
-  },
-  '/v3/zone-audit/save': {
-    post: {
-      tags: [ 'Zone Audit' ],
-      description: `submit the audit file. which is store in the bucket in the json format`,
-      operationId: 'save',
-      parameters: {},
-      requestBody: {
-        content: {
-          'application/json': {
-            schema: j2s( saveSchema ).swagger,
-          },
-        },
-      },
-      responses: {
-        200: { description: 'The Audited file has been submited successfully ' },
-        401: { description: 'Unauthorized User' },
-        422: { description: 'Field Error' },
-        500: { description: 'Server Error' },
-        204: { description: 'Not Found' },
-      },
-    },
-  },
-  '/v3/zone-audit/work-space': {
-    get: {
-      tags: [ 'Zone Audit' ],
-      description: 'queue wise info of audit files ',
-      operationId: 'work-space',
-      parameters: [
-        {
-          in: 'query',
-          name: 'searchValue',
-          scema: j2s( workSpaceSchema ).swagger,
-          require: false,
-        },
-        {
-          in: 'query',
-          name: 'offset',
-          scema: j2s( workSpaceSchema ).swagger,
-          require: false,
-        },
-        {
-          in: 'query',
-          name: 'limit',
-          scema: j2s( workSpaceSchema ).swagger,
-          require: false,
-        },
-        {
-          in: 'query',
-          name: 'isExport',
-          scema: j2s( workSpaceSchema ).swagger,
-          require: false,
-        },
-      ],
-      responses: {
-        200: { description: 'Successful' },
-        401: { description: 'Unauthorized User' },
-        422: { description: 'Field Error' },
-        500: { description: 'Server Error' },
-        204: { description: 'Not Found' },
-      },
-    },
-  },
-
-  // metrics
-  '/v3/zone-audit/metrics/store-metrics': {
-    post: {
-      tags: [ 'Zone Audit Metrics' ],
-      description: `Get store level zone metrics`,
-      operationId: 'save',
-      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/zone-audit/metrics/audit-images': {
-    get: {
-      'tags': [ 'Zone Audit Metrics' ],
-      'description': `View and Download audit images`,
-      'operationId': 'zone audit-images',
-      'parameters': [
-        {
-          in: 'query',
-          name: 'fileDate',
-          scema: j2s( zoneAuditImageValidSchema ).swagger,
-          require: true,
-        },
-        {
-          in: 'query',
-          name: 'storeId',
-          scema: j2s( zoneAuditImageValidSchema ).swagger,
-          require: true,
-        },
-        {
-          in: 'query',
-          name: 'imageType',
-          scema: j2s( zoneAuditImageValidSchema ).swagger,
-          require: true,
-        },
-        {
-          in: 'query',
-          name: 'export',
-          scema: j2s( zoneAuditImageValidSchema ).swagger,
-          require: true,
-        },
-        {
-          in: 'query',
-          name: 'zoneName',
-          scema: j2s( zoneAuditImageValidSchema ).swagger,
-          require: true,
-        },
-      ],
-
-      '/v3/zone-audit/metrics/client-metrics': {
-        post: {
-          tags: [ 'Zone Audit Metrics' ],
-          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/zone-audit/metrics/re-trigger': {
-    post: {
-      tags: [ 'Zone Audit Metrics' ],
-      description: `Manual re trigger a file`,
-      operationId: 'metrics/re-trigger',
-      parameters: {},
-      requestBody: {
-        content: {
-          'application/json': {
-            schema: j2s( reTriggerValidSchema ).swagger,
-          },
-        },
-      },
-      responses: {
-        200: { description: 'Successful' },
-        401: { description: 'Unauthorized User' },
-        422: { description: 'Field Error' },
-        500: { description: 'Server Error' },
-        204: { description: 'Not Found' },
-      },
-    },
-  },
-
-};

package/src/dtos/auditMetrics.dtos.js

@@ -1,39 +0,0 @@
-import joi from 'joi';
-
-
-export const getAuditImagesSchema = joi.object(
-    {
-      fileDate: joi.string().required(),
-      fileType: joi.string().required(),
-      storeId: joi.string().required(),
-    },
-);
-
-export const getAuditImagesValid = {
-  body: getAuditImagesSchema,
-};
-
-
-export const auditImageValidSchema = joi.object(
-    {
-      fileDate: joi.string().required(),
-      storeId: joi.string().required(),
-      imageType: joi.string().required(),
-      export: joi.boolean().required(),
-    },
-);
-
-export const auditImageValid = {
-  query: auditImageValidSchema,
-};
-
-export const viewLogSchema = joi.object(
-    {
-      fileDate: joi.string().required(),
-      storeId: joi.string().required(),
-    },
-);
-
-export const viewLogValid = {
-  query: viewLogSchema,
-};

package/src/dtos/zoneAudit.dtos.js

@@ -1,171 +0,0 @@
-import joi from 'joi';
-
-
-export const getFileSchema = joi.object(
-    {
-      queueName: joi.string().required(),
-      nextId: joi.string().optional().allow( '' ),
-      limit: joi.number().optional(),
-    },
-);
-
-
-export const getFileValid = {
-  query: getFileSchema,
-};
-
-export const saveDraftSchema = joi.object(
-    {
-      userCommands: joi.string().optional().allow( '' ),
-      storeId: joi.string().required(),
-      auditId: joi.string().required(),
-      zoneName: joi.string().required(),
-      auditType: joi.string().required(),
-      fileDate: joi.string().required(),
-      queueName: joi.string().required(),
-      totalCount: joi.number().required(),
-      junkCount: joi.number().optional(),
-      junk: joi.array().optional(),
-      employeeCount: joi.number().optional(),
-      employee: joi.array().optional(),
-      customerCount: joi.number().optional(),
-      customer: joi.array().optional(),
-      retagCount: joi.number().optional(),
-      retagImage: joi.array().optional(),
-    },
-);
-
-export const saveDraftValid = {
-  body: saveDraftSchema,
-};
-
-
-export const saveSchema = joi.object(
-    {
-      auditId: joi.string().required(),
-      storeId: joi.string().required(),
-      zoneName: joi.string().required(),
-      fileDate: joi.string().required(),
-      auditType: 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(),
-    },
-);
-
-export const saveValid = {
-  body: saveSchema,
-};
-
-export const getDraftedDataSchema = joi.object(
-    {
-      storeId: joi.string().required(),
-      zoneName: joi.string().required(),
-      fileDate: joi.string().required(),
-      userId: joi.string().optional(),
-    },
-);
-
-export const getDraftedDataValid = {
-  query: getDraftedDataSchema,
-};
-
-export const workSpaceSchema = joi.object(
-    {
-      searchValue: joi.string().optional().allow( '' ),
-      offset: joi.string().optional(),
-      limit: joi.number().optional(),
-      isExport: joi.boolean().optional(),
-    },
-);
-
-export const workSpaceValid = {
-  query: workSpaceSchema,
-};
-
-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 zoneAuditImageValidSchema = joi.object(
-    {
-      fileDate: joi.string().required(),
-      storeId: joi.string().required(),
-      imageType: joi.string().required(),
-      export: joi.boolean().required(),
-      zoneName: joi.string().required(),
-    },
-);
-
-export const zoneAuditImageValid = {
-  query: zoneAuditImageValidSchema,
-};
-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 reTriggerValidSchema = joi.object(
-    {
-      fileDate: joi.string().required(),
-      storeId: joi.string().required(),
-      zoneName: joi.string().required(),
-      type: joi.string().optional(),
-      triggerType: joi.string().optional(),
-      totalCount: joi.number().required(),
-      userId: joi.string().optional(),
-      comments: joi.string().optional().allow( '' ),
-    },
-);
-
-export const reTriggerValid = {
-  body: reTriggerValidSchema,
-};
-
-export const viewLogSchema = joi.object(
-    {
-      fileDate: joi.string().required(),
-      storeId: joi.string().required(),
-      zoneName: joi.string().required(),
-    },
-);
-
-export const viewLogValid = {
-  body: viewLogSchema,
-};
-

package/src/routes/auditMetrics.routes.js

@@ -1,14 +0,0 @@
-
-import express from 'express';
-import { isAllowedSessionHandler, validate } from 'tango-app-api-middleware';
-import { auditImages } from '../controllers/auditMetrics.controllers.js';
-import { auditImageValid, viewLogValid } from '../dtos/auditMetrics.dtos.js';
-import { isAuditInputFolderExist } from '../validation/audit.validation.js';
-
-export const auditMetricsRouter = express.Router();
-
-
-auditMetricsRouter.get( '/audit-images', isAllowedSessionHandler, validate( auditImageValid ), isAuditInputFolderExist, auditImages );
-auditMetricsRouter.post( '/view-log', isAllowedSessionHandler, validate( viewLogValid ), isAuditInputFolderExist, auditImages );
-
-export default auditMetricsRouter;

package/src/routes/zone.routes.js

@@ -1,24 +0,0 @@
-import { Router } from 'express';
-import { clientMetricsValid, getDraftedDataValid, getFileValid, reTriggerValid, saveDraftValid, saveValid, viewLogValid, workSpaceValid, zoneAuditImageValid } from '../dtos/zoneAudit.dtos.js';
-import { isExistsQueue, validateUserAudit } from '../validation/audit.validation.js';
-import { isAllowedSessionHandler, validate } from 'tango-app-api-middleware';
-import { clientMetrics, getDraftedData, getZoneAuditFile, reTrigger, save, saveDraft, storeMetrics, viewLog, workSpace, zoneAuditImages } from '../controllers/zoneAudit.controller.js';
-import { storeMetricsValid } from '../dtos/auditMetrics.dtos.js';
-import { isZoneAuditInputFolderExist, isAuditInputFolderExist, isAuditDocumentExist } from '../validation/zoneAudit.validation.js';
-
-export const zoneAuditRouter=Router();
-
-// zone Audit
-zoneAuditRouter.get( '/get-file', isAllowedSessionHandler, validate( getFileValid ), isExistsQueue, getZoneAuditFile );
-zoneAuditRouter.post( '/save-draft', isAllowedSessionHandler, validate( saveDraftValid ), saveDraft );
-zoneAuditRouter.get( '/get-drafted-data', isAllowedSessionHandler, validate( getDraftedDataValid ), getDraftedData );
-zoneAuditRouter.post( '/save', isAllowedSessionHandler, validate( saveValid ), validateUserAudit, save );
-zoneAuditRouter.get( '/work-space', isAllowedSessionHandler, validate( workSpaceValid ), workSpace );
-
-// metrics
-
-zoneAuditRouter.post( '/metrics/store-metrics', isAllowedSessionHandler, validate( storeMetricsValid ), storeMetrics );
-zoneAuditRouter.get( '/metrics/audit-images', isAllowedSessionHandler, validate( zoneAuditImageValid ), isZoneAuditInputFolderExist, zoneAuditImages );
-zoneAuditRouter.post( '/metrics/client-metrics', isAllowedSessionHandler, validate( clientMetricsValid ), clientMetrics );
-zoneAuditRouter.post( '/metrics/re-trigger', isAllowedSessionHandler, validate( reTriggerValid ), isAuditDocumentExist, isAuditInputFolderExist, reTrigger );
-zoneAuditRouter.post( '/view-log', isAllowedSessionHandler, validate( viewLogValid ), viewLog );