tango-app-api-report 3.0.0-dev

package/.eslintrc.cjs

@@ -0,0 +1,41 @@
+
+module.exports = {
+  'env': {
+    'es2021': true,
+    'node': true,
+  },
+  'extends': 'google',
+  'overrides': [
+    {
+      'env': {
+        'node': true,
+      },
+      'files': [
+        '.eslintrc.{js,cjs}',
+      ],
+      'parserOptions': {
+        'sourceType': 'script',
+      },
+    },
+  ],
+  'parserOptions': {
+    'ecmaVersion': 'latest',
+    'sourceType': 'module',
+  },
+  'rules': {
+    'linebreak-style': [ 'error', 'windows' ],
+    'require-jsdoc': 'off',
+    'arrow-spacing': 'error',
+    'key-spacing': [ 'error', { 'beforeColon': false, 'afterColon': true } ],
+    'object-curly-spacing': [ 'error', 'always' ],
+    'space-in-parens': [ 'error', 'always' ],
+    'keyword-spacing': 'error',
+    'array-bracket-spacing': [ 'error', 'always' ],
+    'spaced-comment': [ 'error', 'always' ],
+    'max-len': [ 'error', { 'code': 700 } ],
+    'no-unused-vars': 'error',
+    'new-cap': [ 'error', { 'newIsCap': true, 'capIsNew': false } ],
+    'prefer-const': 'off',
+  },
+};
+

package/README.md

@@ -0,0 +1,29 @@
+# README #
+
+This README would normally document whatever steps are necessary to get your application up and running.
+
+### What is this repository for? ###
+
+* Quick summary
+* Version
+* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
+
+### How do I get set up? ###
+
+* Summary of set up
+* Configuration
+* Dependencies
+* Database configuration
+* How to run tests
+* Deployment instructions
+
+### Contribution guidelines ###
+
+* Writing tests
+* Code review
+* Other guidelines
+
+### Who do I talk to? ###
+
+* Repo owner or admin
+* Other community or team contact

package/index.js

@@ -0,0 +1,7 @@
+
+
+import { reportRouter } from './src/routes/report.routes.js';
+
+export { reportRouter };
+
+

package/package.json

@@ -0,0 +1,37 @@
+{
+    "name": "tango-app-api-report",
+    "version": "3.0.0-dev",
+    "description": "report",
+    "main": "index.js",
+    "type": "module",
+    "scripts": {
+        "start": "nodemon --exec \"eslint --fix . && node index.js\""
+    },
+    "engines": {
+        "node": ">=18.10.0"
+    },
+    "author": "praveenraj",
+    "license": "ISC",
+    "dependencies": {
+        "aws-sdk": "^2.1578.0",
+        "cors": "^2.8.5",
+        "dotenv": "^16.4.5",
+        "express": "^4.18.3",
+        "express-fileupload": "^1.5.0",
+        "handlebars": "^4.7.8",
+        "mongodb": "^6.5.0",
+        "nodemon": "^3.1.0",
+        "tango-api-schema": "^2.0.22",
+        "tango-app-api-middleware": "^1.0.29",
+        "winston": "^3.12.0",
+        "winston-daily-rotate-file": "^5.0.0"
+    },
+    "devDependencies": {
+        "eslint": "^8.57.0",
+        "eslint-config-google": "^0.14.0",
+        "eslint-config-semistandard": "^17.0.0",
+        "eslint-config-standard": "^17.1.0",
+        "eslint-plugin-import": "^2.29.1",
+        "eslint-plugin-promise": "^6.1.1"
+    }
+}

package/src/controllers/report.controllers.js

@@ -0,0 +1,90 @@
+import { reportCreate, reportGet, reportGetSingle, reportUpdate } from '../service/report.service.js';
+import { insertOpenSearchData, logger } from 'tango-app-api-middleware';
+import { getUserNameEmailById } from '../service/user.service.js';
+
+
+export async function createReport( req, res ) {
+  try {
+    const createReport = await reportCreate( {
+      clientId: req.params?.id, fileName: req.body?.fileName, fileType: req.body?.fileType, email: req.body?.email,
+    } );
+
+    const user = await getUserNameEmailById( req.userId );
+
+    const logObj = {
+      clientId: req.params?.id,
+      userName: user?.userName,
+      email: user?.email,
+      date: new Date(),
+      logType: 'configuration',
+      logSubType: 'reportConfig',
+      changes: [ `${req.body?.fileName}` ],
+      eventType: 'create',
+    };
+
+    await insertOpenSearchData( 'tango-retail-activity-logs', logObj );
+    if ( createReport ) {
+      res.sendSuccess( { result: 'Created Successfully' } );
+    }
+  } catch ( error ) {
+    logger.error( { error: error, message: req.params, function: 'createReport' } );
+    return res.sendError( error, 500 );
+  }
+}
+
+export async function getReport( req, res ) {
+  try {
+    const reports = await reportGet( {
+      clientId: req.params?.id,
+    } );
+    if ( reports ) {
+      res.sendSuccess( reports );
+    }
+  } catch ( error ) {
+    logger.error( { error: error, message: req.params, function: 'getReport' } );
+    return res.sendError( error, 500 );
+  }
+}
+
+export async function getSingleReport( req, res ) {
+  try {
+    const report = await reportGetSingle( {
+      _id: req.params?.id,
+    } );
+    if ( report ) {
+      res.sendSuccess( report );
+    }
+  } catch ( error ) {
+    logger.error( { error: error, message: req.params, function: 'getSingleReport' } );
+    return res.sendError( error, 500 );
+  }
+}
+
+export async function updateReport( req, res ) {
+  try {
+    const updateAck = await reportUpdate( {
+      _id: req.params?.id, fileType: req.body?.fileType, email: req.body?.email, clientId: req.body?.clientId,
+    } );
+
+    const user = await getUserNameEmailById( req.userId );
+
+    const logObj = {
+      clientId: req.body?.clientId,
+      userName: user?.userName,
+      email: user?.email,
+      date: new Date(),
+      logType: 'configuration',
+      logSubType: 'reportConfig',
+      changes: [ `Report id ${req.params?.id}` ],
+      eventType: 'update',
+    };
+
+    await insertOpenSearchData( 'tango-retail-activity-logs', logObj );
+    if ( updateAck ) {
+      res.sendSuccess( { result: 'Updated Successfully' } );
+    }
+  } catch ( error ) {
+    logger.error( { error: error, message: req.params, function: 'updateReport' } );
+    return res.sendError( error, 500 );
+  }
+}

package/src/dtos/report.dtos.js

@@ -0,0 +1,57 @@
+import joi from 'joi';
+
+
+export const addReportSchemaBody = joi.object(
+    {
+      fileName: joi.string().required(),
+      fileType: joi.string().required(),
+      email: joi.array().items( joi.string().email().required() ).required(),
+    },
+);
+
+export const addReportSchemaParam = joi.object( {
+  id: joi.string().required(),
+} );
+
+export const addReportValid = {
+  body: addReportSchemaBody,
+  params: addReportSchemaParam,
+
+};
+
+
+export const getReportSchemaParam = joi.object( {
+  id: joi.string().required(),
+} );
+
+export const getReportValid = {
+  params: getReportSchemaParam,
+
+};
+
+export const getSingleReportSchemaParam = joi.object( {
+  id: joi.string().required(),
+} );
+
+export const getSingleReportValid = {
+  params: getSingleReportSchemaParam,
+
+};
+
+export const updateReportSchemaBody = joi.object(
+    {
+      fileType: joi.string().required(),
+      email: joi.array().items( joi.string().email().required() ).required(),
+      clientId: joi.string().required(),
+    },
+);
+
+export const updateReportSchemaParam = joi.object( {
+  id: joi.string().required(),
+} );
+
+export const updateReportValid = {
+  body: updateReportSchemaBody,
+  params: updateReportSchemaParam,
+
+};

package/src/routes/report.routes.js

@@ -0,0 +1,14 @@
+
+import express from 'express';
+import { isAllowedSessionHandler, validate } from 'tango-app-api-middleware';
+import { addReportValid, getReportValid, getSingleReportValid, updateReportValid } from '../dtos/report.dtos.js';
+import { createReport, getReport, getSingleReport, updateReport } from '../controllers/report.controllers.js';
+
+export const reportRouter = express.Router();
+
+reportRouter.post( '/create-report/:id', isAllowedSessionHandler, validate( addReportValid ), createReport );
+reportRouter.get( '/get-client-reports/:id', isAllowedSessionHandler, validate( getReportValid ), getReport );
+reportRouter.get( '/get-report/:id', isAllowedSessionHandler, validate( getSingleReportValid ), getSingleReport );
+reportRouter.put( '/update-report/:id', isAllowedSessionHandler, validate( updateReportValid ), updateReport );
+
+

package/src/service/report.service.js

@@ -0,0 +1,39 @@
+import reportModel from 'tango-api-schema/schema/report.model.js';
+import mongoose from 'mongoose';
+
+
+export function reportCreate( { clientId, fileName, fileType, email } ) {
+  return reportModel.create( {
+    clientId: clientId,
+    fileName: fileName,
+    fileType: fileType,
+    email: email,
+  } );
+}
+
+export function reportGet( { clientId } ) {
+  return reportModel.find( {
+    clientId: clientId,
+  },
+  {
+    'fileName': 1,
+    '_id': 1,
+  } );
+}
+
+export function reportGetSingle( { _id } ) {
+  return reportModel.findOne( {
+    _id: new mongoose.Types.ObjectId( _id ),
+  },
+  );
+}
+
+export function reportUpdate( { _id, fileType, email, clientId } ) {
+  return reportModel.updateOne( { _id: new mongoose.Types.ObjectId( _id ), clientId: clientId },
+      {
+        $set: {
+          'fileType': fileType,
+          'email': email,
+        },
+      } );
+}

package/src/service/user.service.js

@@ -0,0 +1,5 @@
+import userModel from 'tango-api-schema/schema/user.model.js';
+
+export function getUserNameEmailById( objectId ) {
+  return userModel.findOne( { _id: objectId }, { userName: 1, email: 1, _id: 0 } );
+}