tango-app-api-analysis-zone 3.0.0-alpha.10 → 3.0.0-alpha.12

package/index.js

@@ -1,6 +1,7 @@
 
 
 import { analysisZoneRouter } from './src/routes/analysisZone.js';
+import { analysisZoneV2Router } from './src/routes/analysisZoneV2.js';
 
-export { analysisZoneRouter };
+export { analysisZoneRouter, analysisZoneV2Router };
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "tango-app-api-analysis-zone",
-    "version": "3.0.0-alpha.10",
+    "version": "3.0.0-alpha.12",
     "description": "zone Analysis",
     "main": "index.js",
     "type": "module",

package/src/controllers/analysisZoneSampleDataV2.controllers.js

@@ -0,0 +1,416 @@
+import { logger } from 'tango-app-api-middleware';
+
+
+export const zonecards = async ( req, res ) => {
+  try {
+    let reqestData = req.body;
+    let checkNoData = await returnNoData( reqestData.storeId );
+    if ( checkNoData ) {
+      return res.sendError( { error: 'No Data Found' }, 204 );
+    }
+
+    let checkInvalidRequest = await returnInvalidRequest( reqestData.storeId );
+    if ( checkInvalidRequest ) {
+      return res.sendError( { error: 'Invalid Date' }, 400 );
+    }
+
+    let checkServerError = await returnServerError( reqestData.storeId );
+    if ( checkServerError ) {
+      return res.sendError( { error: 'Server Error' }, 500 );
+    }
+
+    let result = {
+      'card': {
+        'footfall': {
+          'count': 100, // Store Footfall Count
+          'zoneName': 'Entry', // highest Zone Footfall
+          'zoneFootfallCount': 40,
+        },
+        'impression': {
+          'rate': 89.5, // Store impression rate
+          'zoneName': 'EXit', // highest Impression(Concentration)
+          'zoneImpressionRate': 40.0,
+        },
+        'bounced': {
+          'rate': 89.5, // Store bounced rate
+          'zoneName': 'EXit', // highest Bounced
+        },
+        'engagers': {
+          'rate': 89.5, // Store engagers rate
+          'zoneName': 'EXit', // highest Engagers
+        },
+        'avgDwellTime': {
+          'rate': 89.5, // Store avgDwellTime rate
+          'zoneName': 'EXit', // highest Average Dwell Time
+        },
+      },
+    };
+    return res.sendSuccess( result );
+  } catch ( error ) {
+    logger.error( { error: error, message: req.query, function: 'zonecards' } );
+    return res.sendError( { error: error }, 500 );
+  }
+};
+export const topPerformingZones = async ( req, res ) => {
+  try {
+    let reqestData = req.body;
+    let checkNoData = await returnNoData( reqestData.storeId );
+    if ( checkNoData ) {
+      return res.sendError( { error: 'No Data Found' }, 204 );
+    }
+
+    let checkInvalidRequest = await returnInvalidRequest( reqestData.storeId );
+    if ( checkInvalidRequest ) {
+      return res.sendError( { error: 'Invalid Date' }, 400 );
+    }
+
+    let checkServerError = await returnServerError( reqestData.storeId );
+    if ( checkServerError ) {
+      return res.sendError( { error: 'Server Error' }, 500 );
+    }
+
+    let result = {
+      'topPerformingZones': [
+        { 'zoneName': 'zone-0', 'footfallCount': 100, 'bouncedCount': 40, 'engagersCount': 30, 'impressionRate': 50.0 },
+        { 'zoneName': 'zone-0', 'footfallCount': 98, 'bouncedCount': 38, 'engagersCount': 28, 'impressionRate': 48.5 },
+        { 'zoneName': 'zone-0', 'footfallCount': 96, 'bouncedCount': 36, 'engagersCount': 26, 'impressionRate': 46.5 },
+        { 'zoneName': 'zone-0', 'footfallCount': 94, 'bouncedCount': 34, 'engagersCount': 24, 'impressionRate': 44.5 },
+        { 'zoneName': 'zone-0', 'footfallCount': 92, 'bouncedCount': 32, 'engagersCount': 22, 'impressionRate': 42.5 },
+      ],
+    };
+    return res.sendSuccess( result );
+  } catch ( error ) {
+    logger.error( { error: error, message: req.query, function: 'topPerformingZones' } );
+    return res.sendError( { error: error }, 500 );
+  }
+};
+export const topPerformingStores = async ( req, res ) => {
+  try {
+    let reqestData = req.body;
+    let checkNoData = await returnNoData( reqestData.storeId );
+    if ( checkNoData ) {
+      return res.sendError( { error: 'No Data Found' }, 204 );
+    }
+
+    let checkInvalidRequest = await returnInvalidRequest( reqestData.storeId );
+    if ( checkInvalidRequest ) {
+      return res.sendError( { error: 'Invalid Date' }, 400 );
+    }
+
+    let checkServerError = await returnServerError( reqestData.storeId );
+    if ( checkServerError ) {
+      return res.sendError( { error: 'Server Error' }, 500 );
+    }
+
+    let result = {
+      'topPerformingStores': [
+        { 'storeName': 'LKST11-300', 'storeId': '11-300', 'zoneName': 'zone-0', 'zoneFootfallCount': 90, 'impressionRate': 40.4, 'avgDwellTime': 39.9 },
+        { 'storeName': 'LKST11-301', 'storeId': '11-301', 'zoneName': 'zone-1', 'zoneFootfallCount': 90, 'impressionRate': 40.4, 'avgDwellTime': 39.9 },
+        { 'storeName': 'LKST11-302', 'storeId': '11-302', 'zoneName': 'zone-2', 'zoneFootfallCount': 90, 'impressionRate': 40.4, 'avgDwellTime': 39.9 },
+        { 'storeName': 'LKST11-303', 'storeId': '11-303', 'zoneName': 'zone-3', 'zoneFootfallCount': 90, 'impressionRate': 40.4, 'avgDwellTime': 39.9 },
+        { 'storeName': 'LKST11-304', 'storeId': '11-304', 'zoneName': 'zone-4', 'zoneFootfallCount': 90, 'impressionRate': 40.4, 'avgDwellTime': 39.9 },
+      ],
+    };
+    return res.sendSuccess( result );
+  } catch ( error ) {
+    logger.error( { error: error, message: req.query, function: 'topPerformingStores' } );
+    return res.sendError( { error: error }, 500 );
+  }
+};
+export const zoneSummaryTable = async ( req, res ) => {
+  try {
+    let reqestData = req.body;
+    let checkNoData = await returnNoData( reqestData.storeId );
+    if ( checkNoData ) {
+      return res.sendError( { error: 'No Data Found' }, 204 );
+    }
+
+    let checkInvalidRequest = await returnInvalidRequest( reqestData.storeId );
+    if ( checkInvalidRequest ) {
+      return res.sendError( { error: 'Invalid Date' }, 400 );
+    }
+
+    let checkServerError = await returnServerError( reqestData.storeId );
+    if ( checkServerError ) {
+      return res.sendError( { error: 'Server Error' }, 500 );
+    }
+
+    let result = [
+      {
+        'storeName': 'LKST400',
+        'date': '2024-01-01',
+        'storeId': '11-10',
+        'zoneName': 'zone-1',
+        'footfallCount': 400,
+        'bouncedCount': 40,
+        'engagersCount': 60,
+        'impressionRate': 70.5,
+        'avgDwellTime': 50,
+        'bellow12': 30,
+        '13-19': 50,
+        '20-30': 40,
+        '31-45': 20,
+        '46-59': 30,
+        '60 above': 60,
+        'maleCount': 40,
+        'femaleCount': 50,
+      },
+    ];
+    return res.sendSuccess( result );
+  } catch ( error ) {
+    logger.error( { error: error, message: req.query, function: 'zoneSummaryTable' } );
+    return res.sendError( { error: error }, 500 );
+  }
+};
+export const availableZoneNames = async ( req, res ) => {
+  try {
+    let reqestData = req.body;
+    let checkNoData = await returnNoData( reqestData.storeId );
+    if ( checkNoData ) {
+      return res.sendError( { error: 'No Data Found' }, 204 );
+    }
+
+    let checkInvalidRequest = await returnInvalidRequest( reqestData.storeId );
+    if ( checkInvalidRequest ) {
+      return res.sendError( { error: 'Invalid Date' }, 400 );
+    }
+
+    let checkServerError = await returnServerError( reqestData.storeId );
+    if ( checkServerError ) {
+      return res.sendError( { error: 'Server Error' }, 500 );
+    }
+
+    let result = {
+      'availableZoneData': [
+        { 'zoneName': 'zone-1' },
+        { 'zoneName': 'zone-2' },
+        { 'zoneName': 'zone-3' },
+      ],
+    };
+    return res.sendSuccess( result );
+  } catch ( error ) {
+    logger.error( { error: error, message: req.query, function: 'availableZoneNames' } );
+    return res.sendError( { error: error }, 500 );
+  }
+};
+export const zoneConcentrationSummary = async ( req, res ) => {
+  try {
+    let reqestData = req.body;
+    let checkNoData = await returnNoData( reqestData.storeId );
+    if ( checkNoData ) {
+      return res.sendError( { error: 'No Data Found' }, 204 );
+    }
+
+    let checkInvalidRequest = await returnInvalidRequest( reqestData.storeId );
+    if ( checkInvalidRequest ) {
+      return res.sendError( { error: 'Invalid Date' }, 400 );
+    }
+
+    let checkServerError = await returnServerError( reqestData.storeId );
+    if ( checkServerError ) {
+      return res.sendError( { error: 'Server Error' }, 500 );
+    }
+
+    let result = [
+      {
+        'zoneName': 'zone-1',
+        'footfall': {
+          'zoneCount': 10,
+          'storeRate': 65.0,
+        },
+        'impression': {
+          'zoneRate': 10.0,
+          'storeRate': 65.0,
+        },
+        'bounced': {
+          'zoneCount': 10,
+          'storeRate': 65.0,
+        },
+        'engagers': {
+          'zoneCount': 10,
+          'storeRate': 65.0,
+        },
+        'avgDwellTime': {
+          'zoneAvgDwellTime': 10,
+          'storeAvgDwellTime': 65,
+        },
+        'bellow-12': 30.0, // Rate
+        '13-19': 50.0,
+        '20-30': 40.0,
+        '31-45': 20.0,
+        '46-59': 30.0,
+        '60-above': 60.0,
+        'maleRate': 40.0,
+        'femaleRate': 50.0,
+      },
+    ];
+    return res.sendSuccess( result );
+  } catch ( error ) {
+    logger.error( { error: error, message: req.query, function: 'zoneConcentrationSummary' } );
+    return res.sendError( { error: error }, 500 );
+  }
+};
+export const overallStoreConcentrationDates = async ( req, res ) => {
+  try {
+    let reqestData = req.body;
+    let checkNoData = await returnNoData( reqestData.storeId );
+    if ( checkNoData ) {
+      return res.sendError( { error: 'No Data Found' }, 204 );
+    }
+
+    let checkInvalidRequest = await returnInvalidRequest( reqestData.storeId );
+    if ( checkInvalidRequest ) {
+      return res.sendError( { error: 'Invalid Date' }, 400 );
+    }
+
+    let checkServerError = await returnServerError( reqestData.storeId );
+    if ( checkServerError ) {
+      return res.sendError( { error: 'Server Error' }, 500 );
+    }
+
+    let result = {
+      'overallStoreConcentrationDates': [
+        { 'zoneDate': 'Jan 01-30' },
+        { 'zoneDate': 'Feb 01-07' },
+        { 'zoneDate': 'Feb 08' },
+      ],
+    };
+    return res.sendSuccess( result );
+  } catch ( error ) {
+    logger.error( { error: error, message: req.query, function: 'overallStoreConcentrationDates' } );
+    return res.sendError( { error: error }, 500 );
+  }
+};
+export const overallStoreConcentrationHeatmap = async ( req, res ) => {
+  try {
+    let reqestData = req.body;
+    let checkNoData = await returnNoData( reqestData.storeId );
+    if ( checkNoData ) {
+      return res.sendError( { error: 'No Data Found' }, 204 );
+    }
+
+    let checkInvalidRequest = await returnInvalidRequest( reqestData.storeId );
+    if ( checkInvalidRequest ) {
+      return res.sendError( { error: 'Invalid Date' }, 400 );
+    }
+
+    let checkServerError = await returnServerError( reqestData.storeId );
+    if ( checkServerError ) {
+      return res.sendError( { error: 'Server Error' }, 500 );
+    }
+
+    let result = {
+      'overallStoreConcentrationData': {
+        'ImageURLs': [
+          {
+            'streamName': 'ABC',
+            'URL': 'DEFGHI',
+          },
+          {
+            'streamName': 'ABC-1',
+            'URL': 'DEFGHI-1',
+          },
+        ],
+      },
+    };
+    return res.sendSuccess( result );
+  } catch ( error ) {
+    logger.error( { error: error, message: req.query, function: 'overallStoreConcentrationHeatmap' } );
+    return res.sendError( { error: error }, 500 );
+  }
+};
+export const trajectoryAnalysis = async ( req, res ) => {
+  try {
+    let reqestData = req.body;
+    let checkNoData = await returnNoData( reqestData.storeId );
+    if ( checkNoData ) {
+      return res.sendError( { error: 'No Data Found' }, 204 );
+    }
+
+    let checkInvalidRequest = await returnInvalidRequest( reqestData.storeId );
+    if ( checkInvalidRequest ) {
+      return res.sendError( { error: 'Invalid Date' }, 400 );
+    }
+
+    let checkServerError = await returnServerError( reqestData.storeId );
+    if ( checkServerError ) {
+      return res.sendError( { error: 'Server Error' }, 500 );
+    }
+
+    let result = {
+      'trajectoryAnalysisData': {
+        'zoneList': [ 'zone-1', 'zone-2', 'zone-3' ],
+        'otherZone': {
+          'impressionRate': 40.0,
+          'gender': 'Male', // ["Male","Female"]
+          'ageGroup': '20-30',
+        },
+        'currentZone': {
+          'impressionRate': 40.0,
+          'gender': 'Female', // ["Male","Female"]
+          'ageGroup': '20-30',
+        },
+      },
+    };
+    return res.sendSuccess( result );
+  } catch ( error ) {
+    logger.error( { error: error, message: req.query, function: 'trajectoryAnalysis' } );
+    return res.sendError( { error: error }, 500 );
+  }
+};
+export const customerJourney = async ( req, res ) => {
+  try {
+    let reqestData = req.body;
+    let checkNoData = await returnNoData( reqestData.storeId );
+    if ( checkNoData ) {
+      return res.sendError( { error: 'No Data Found' }, 204 );
+    }
+
+    let checkInvalidRequest = await returnInvalidRequest( reqestData.storeId );
+    if ( checkInvalidRequest ) {
+      return res.sendError( { error: 'Invalid Date' }, 400 );
+    }
+
+    let checkServerError = await returnServerError( reqestData.storeId );
+    if ( checkServerError ) {
+      return res.sendError( { error: 'Server Error' }, 500 );
+    }
+
+    let result = {
+      'customerJourneyData': { },
+    };
+    return res.sendSuccess( result );
+  } catch ( error ) {
+    logger.error( { error: error, message: req.query, function: 'customerJourney' } );
+    return res.sendError( { error: error }, 500 );
+  }
+};
+async function returnNoData( requestData ) {
+  try {
+    if ( requestData && requestData.includes( '204' ) ) {
+      return true;
+    }
+  } catch ( error ) {
+    logger.error( { error: error, message: data, function: 'returnNoData' } );
+  }
+}
+
+async function returnInvalidRequest( requestData ) {
+  try {
+    if ( requestData && requestData.includes( '400' ) ) {
+      return true;
+    }
+  } catch ( error ) {
+    logger.error( { error: error, message: data, function: 'returnInvalidRequest' } );
+  }
+}
+
+async function returnServerError( requestData ) {
+  try {
+    if ( requestData && requestData.includes( '500' ) ) {
+      return true;
+    }
+  } catch ( error ) {
+    logger.error( { error: error, message: data, function: 'returnServerError' } );
+  }
+}

package/src/dtos/validation.dtos.js

@@ -30,6 +30,8 @@ export const validateTopPerformingStoresSchema = joi.object( {
   ...baseSchema,
   search: joi.string().optional().allow( '' ),
   export: joi.boolean().required(),
+  sortBy: joi.number().optional().allow( '' ),
+  sort: joi.string().optional().allow( '' ),
 } );
 
 export const validateTopPerformingStoresParams = {

package/src/routes/analysisZoneV2.js

@@ -0,0 +1,30 @@
+import express from 'express';
+// import { validate, isAllowedSessionHandler, authorize } from 'tango-app-api-middleware';
+// import * as validationDtos from '../dtos/validation.dtos.js';
+
+export const analysisZoneV2Router = express.Router();
+import {
+  zonecards,
+  topPerformingZones,
+  topPerformingStores,
+  zoneSummaryTable,
+  availableZoneNames,
+  zoneConcentrationSummary,
+  overallStoreConcentrationDates,
+  overallStoreConcentrationHeatmap,
+  trajectoryAnalysis,
+  customerJourney,
+} from '../controllers/analysisZoneSampleDataV2.controllers.js';
+
+analysisZoneV2Router
+    .post( '/zonecards', zonecards )
+    .post( '/topPerformingZones', topPerformingZones )
+    .post( '/topPerformingStores', topPerformingStores )
+    .post( '/zoneSummaryTable', zoneSummaryTable )
+    .post( '/availableZoneNames', availableZoneNames )
+    .post( '/zoneConcentrationSummary', zoneConcentrationSummary )
+    .post( '/overallStoreConcentrationDates', overallStoreConcentrationDates )
+    .post( '/overallStoreConcentrationHeatmap', overallStoreConcentrationHeatmap )
+    .post( '/trajectoryAnalysis', trajectoryAnalysis )
+    .post( '/customerJourney', customerJourney );
+export default analysisZoneV2Router;