tango-app-api-audit 3.4.68 → 3.4.69-beta.0

package/src/docs/eyeTestAudit.docs.js

@@ -0,0 +1,163 @@
+import j2s from 'joi-to-swagger';
+import { getListSchema, getFileSchema, getFileHistorySchema, userAuditedDataSchema, viewFileSchema, saveSchema, cancelSchema } from '../dtos/eyeTestAudit.dtos.js';
+
+export const eyeTestAuditDocs = {
+
+  '/v3/eye-test-audit/get-list': {
+    post: {
+      tags: [ 'Eye Test Audit' ],
+      description: 'Get list of files',
+      operationId: 'get-list',
+      requestBody: {
+        content: {
+          'application/json': {
+            schema: j2s( getListSchema ).swagger,
+          },
+        },
+      },
+      responses: {
+        200: { description: 'Successful' },
+        401: { description: 'Unauthorized User' },
+        422: { description: 'Field Error' },
+        500: { description: 'Server Error' },
+        204: { description: 'Not Found' },
+      },
+    },
+  },
+
+  '/v3/eye-test-audit/view-file/{id}': {
+    get: {
+      tags: [ 'Eye Test Audit' ],
+      description: 'View a file via Open Serach',
+      operationId: 'view-file',
+      parameters: [
+        {
+          in: 'path',
+          name: 'id',
+          scema: j2s( viewFileSchema ).swagger,
+          require: true,
+        },
+      ],
+      responses: {
+        200: { description: 'Successful' },
+        401: { description: 'Unauthorized User' },
+        422: { description: 'Field Error' },
+        500: { description: 'Server Error' },
+        204: { description: 'Not Found' },
+      },
+    },
+  },
+
+  '/v3/eye-test-audit/get-file/{id}': {
+    get: {
+      tags: [ 'Eye Test Audit' ],
+      description: 'Get a file via Open Serach',
+      operationId: 'get-file',
+      parameters: [
+        {
+          in: 'path',
+          name: 'id',
+          scema: j2s( getFileSchema ).swagger,
+          require: true,
+        },
+      ],
+      responses: {
+        200: { description: 'Successful' },
+        401: { description: 'Unauthorized User' },
+        422: { description: 'Field Error' },
+        500: { description: 'Server Error' },
+        204: { description: 'Not Found' },
+      },
+    },
+  },
+
+  '/v3/eye-test-audit/save': {
+    post: {
+      tags: [ 'Eye Test Audit' ],
+      description: 'submit eytest audit',
+      operationId: 'save',
+      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/eye-test-audit/cancel': {
+    post: {
+      tags: [ 'Eye Test Audit' ],
+      description: 'cancel eytest audit',
+      operationId: 'cancel',
+      requestBody: {
+        content: {
+          'application/json': {
+            schema: j2s( cancelSchema ).swagger,
+          },
+        },
+      },
+      responses: {
+        200: { description: 'Successful' },
+        401: { description: 'Unauthorized User' },
+        422: { description: 'Field Error' },
+        500: { description: 'Server Error' },
+        204: { description: 'Not Found' },
+      },
+    },
+  },
+
+  '/v3/eye-test-audit/get-file-history/{id}': {
+    get: {
+      tags: [ 'Eye Test Audit' ],
+      description: 'Get a file history via Open Serach',
+      operationId: 'get-file-history',
+      parameters: [
+        {
+          in: 'path',
+          name: 'id',
+          scema: j2s( getFileHistorySchema ).swagger,
+          require: true,
+        },
+      ],
+      responses: {
+        200: { description: 'Successful' },
+        401: { description: 'Unauthorized User' },
+        422: { description: 'Field Error' },
+        500: { description: 'Server Error' },
+        204: { description: 'Not Found' },
+      },
+    },
+  },
+
+  '/v3/eye-test-audit/user-audited-data/{id}': {
+    get: {
+      tags: [ 'Eye Test Audit' ],
+      description: `Get a user's audited file`,
+      operationId: 'user-audited-data',
+      parameters: [
+        {
+          in: 'path',
+          name: 'id',
+          scema: j2s( userAuditedDataSchema ).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/dtos/eyeTestAudit.dtos.js

@@ -0,0 +1,97 @@
+import joi from 'joi';
+
+export const getListSchema = joi.object(
+    {
+      fromDate: joi.string().required().messages( {
+        'any.required': 'From Date is required',
+        'string.empty': 'From Date cannot be empty',
+      } ),
+      toDate: joi.string().required().messages( {
+        'any.required': 'To Date is required',
+        'string.empty': 'To Date cannot be empty',
+      } ),
+      type: joi.string().required().messages( {
+        'any.required': 'Type is required',
+        'string.empty': 'Type cannot be empty',
+      } ),
+      demographics: joi.array().optional(),
+      clientId: joi.string().required().messages( {
+        'any.required': 'Client ID is required',
+        'string.empty': 'Client ID cannot be empty',
+      } ),
+      storeId: joi.array().optional(),
+      limit: joi.number().optional(),
+      offset: joi.number().optional(),
+      searchValue: joi.string().optional().allow( '' ),
+      isExport: joi.boolean().optional(),
+      sortBy: joi.string().optional(),
+      sortOrder: joi.number().optional(),
+    },
+);
+
+export const getListValid = {
+  body: getListSchema,
+};
+
+export const viewFileSchema = joi.object( {
+  id: joi.string().required(),
+} );
+
+export const viewFileValid = {
+  params: viewFileSchema,
+};
+
+
+export const getFileSchema = joi.object( {
+  id: joi.string().required(),
+} );
+
+export const getFileValid = {
+  params: getFileSchema,
+};
+
+export const saveSchema = joi.object( {
+  type: joi.string().required(),
+  fileId: joi.string().required(),
+  id: joi.string().required(),
+  steps: joi.array().required(),
+  auditedSteps: joi.number().required(),
+  auditStatus: joi.string().required(),
+  overRides: joi.number().required(),
+  spokenLanguage: joi.string().optional(),
+} );
+
+export const saveValid = {
+  body: saveSchema,
+};
+
+
+export const cancelSchema = joi.object( {
+  type: joi.string().required(),
+  fileId: joi.string().required(),
+  id: joi.string().required(),
+} );
+
+export const cancelValid = {
+  body: cancelSchema,
+};
+
+
+export const getFileHistorySchema = joi.object( {
+  id: joi.string().required(),
+  type: joi.string().required(),
+} );
+
+export const getFileHistoryValid = {
+  params: getFileHistorySchema,
+};
+
+export const userAuditedDataSchema = joi.object( {
+  id: joi.string().required(),
+} );
+
+export const userAuditedDataValid = {
+  params: userAuditedDataSchema,
+};
+
+

package/src/routes/eyeTestAudit.routes.js

@@ -0,0 +1,18 @@
+import { Router } from 'express';
+import { isAllowedSessionHandler, validate } from 'tango-app-api-middleware';
+import { accessVerification } from 'tango-app-api-middleware';
+import { cancelValid, getFileHistoryValid, getFileValid, getListValid, saveValid, userAuditedDataValid, viewFileValid } from '../dtos/eyeTestAudit.dtos.js';
+import { cancel, getFile, getFileHistory, getList, save, userAuditedData, viewFile } from '../controllers/eyeTestAudit.controllers.js';
+
+export const eyeTestAuditRouter = Router();
+
+eyeTestAuditRouter.post( '/get-list', isAllowedSessionHandler, accessVerification( { userType: [ 'tango', 'client' ] } ), validate( getListValid ), getList );
+eyeTestAuditRouter.get( '/view-file/:id', isAllowedSessionHandler, accessVerification( { userType: [ 'tango', 'client' ] } ), validate( viewFileValid ), viewFile );
+eyeTestAuditRouter.get( '/get-file/:id', isAllowedSessionHandler, accessVerification( { userType: [ 'tango', 'client' ] } ), validate( getFileValid ), getFile );
+eyeTestAuditRouter.post( '/save', isAllowedSessionHandler, accessVerification( { userType: [ 'tango', 'client' ] } ), validate( saveValid ), save );
+eyeTestAuditRouter.post( '/cancel', isAllowedSessionHandler, accessVerification( { userType: [ 'tango', 'client' ] } ), validate( cancelValid ), cancel );
+eyeTestAuditRouter.get( '/get-file-history/:id/:type', isAllowedSessionHandler, accessVerification( { userType: [ 'tango', 'client' ] } ), validate( getFileHistoryValid ), getFileHistory );
+eyeTestAuditRouter.get( '/user-audited-data/:id', isAllowedSessionHandler, accessVerification( { userType: [ 'tango', 'client' ] } ), validate( userAuditedDataValid ), userAuditedData );
+
+
+export default eyeTestAuditRouter;