@ministryofjustice/hmpps-digital-prison-reporting-frontend 3.31.2 → 3.31.3

package/dpr/components/report-actions/utils.js

@@ -122,6 +122,7 @@ const getActions = ({ refresh, print, share, copy, download, }) => {
                 reportName: download.reportName,
                 name: download.name,
                 columns: download.columns,
+                definitionPath: download.definitionPath,
             },
             ariaLabelText: !download.enabled
                 ? `${BUTTON_TEMPLATES.downloadable.ariaLabelText}, disabled`

package/dpr/components/report-actions/utils.ts

@@ -128,6 +128,7 @@ const getActions = ({
     tableId: string
     columns: string[]
     type: ReportType
+    definitionPath: string
   }
 }): ReportAction[] => {
   const actions: ReportAction[] = []
@@ -181,6 +182,7 @@ const getActions = ({
         reportName: download.reportName,
         name: download.name,
         columns: download.columns,
+        definitionPath: download.definitionPath,
       },
       ariaLabelText: !download.enabled
         ? `${BUTTON_TEMPLATES.downloadable.ariaLabelText}, disabled`
@@ -222,5 +224,6 @@ interface ReportAction {
     reportName?: string
     name?: string
     columns: string[]
+    definitionPath: string
   }
 }

package/dpr/components/report-actions/view.njk

@@ -27,7 +27,7 @@
         <input type="hidden" name="type" value="{{ button.attributes.type }}">
         <input type="hidden" name="tableId" value="{{ button.attributes.tableId }}">
         <input type="hidden" name="reportName" value="{{ button.attributes.reportName }}">
-        <input type="hidden" name="variantName" value="{{ button.attributes.variantName }}">
+        <input type="hidden" name="name" value="{{ button.attributes.name }}">
         <input type="hidden" name="cols" value="{{ button.attributes.columns | json }}">
       </form>
     {% endif %}

package/dpr/services/requestedReportService.js

@@ -92,7 +92,7 @@ class RequestedReportService extends userStoreService_1.default {
             case UserReports_1.RequestStatus.FINISHED:
                 report.timestamp.completed = ts;
                 report.url.report.pathname = `${report.url.request.pathname}/${tableId}/report${(0, urlHelper_1.getDpdPathSuffix)(report.dataProductDefinitionsPath)}`;
-                report.url.report.fullUrl = `${report.url.origin}${report.url.report.pathname}${(0, urlHelper_1.getDpdPathSuffix)(report.dataProductDefinitionsPath)}`;
+                report.url.report.fullUrl = `${report.url.origin}${report.url.report.pathname}`;
                 break;
             case UserReports_1.RequestStatus.SUBMITTED:
                 report.timestamp.requested = ts;

package/dpr/services/requestedReportService.ts

@@ -101,9 +101,7 @@ export default class RequestedReportService extends UserStoreService {
         report.url.report.pathname = `${report.url.request.pathname}/${tableId}/report${getDpdPathSuffix(
           report.dataProductDefinitionsPath,
         )}`
-        report.url.report.fullUrl = `${report.url.origin}${report.url.report.pathname}${getDpdPathSuffix(
-          report.dataProductDefinitionsPath,
-        )}`
+        report.url.report.fullUrl = `${report.url.origin}${report.url.report.pathname}`
         break
       case RequestStatus.SUBMITTED:
         report.timestamp.requested = ts
@@ -115,6 +113,7 @@ export default class RequestedReportService extends UserStoreService {
         report.timestamp.lastViewed = ts
         break
     }
+
     return report
   }
 }

package/dpr/utils/UserStoreItemBuilder.ts

@@ -90,6 +90,7 @@ export default class UserStoreItemBuilder {
         },
       },
     }
+
     return this
   }
 

package/dpr/utils/downloadUtils.js

@@ -1,21 +1,21 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 const json_2_csv_1 = require("json-2-csv");
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const logger_1 = __importDefault(require("./logger"));
-const convertToCsv = (reportData) => {
-    const csvData = (0, json_2_csv_1.json2csv)(reportData);
+const convertToCsv = (reportData, options) => {
+    const csvData = (0, json_2_csv_1.json2csv)(reportData, options);
     return csvData;
 };
-const saveToFile = async (csvData, reportName, variantName) => {
-    const filepath = `./download/${reportName}-${variantName}-${new Date().toISOString()}.csv`;
-    await fs_extra_1.default.outputFile(filepath, csvData);
-    return {
-        filepath,
-    };
+const getKeys = (reportData, reportDefinition) => {
+    const { fields } = reportDefinition.variant.specification;
+    const keys = [];
+    Object.keys(reportData[0]).forEach((key) => {
+        const field = fields.find((f) => f.name === key);
+        keys.push({
+            field: key,
+            title: field.display,
+        });
+    });
+    return keys;
 };
 const applyColumnsAndSort = (data, columns) => {
     return data.map((row) => {
@@ -33,7 +33,7 @@ exports.default = {
         var _a, _b;
         const userId = ((_a = res.locals.user) === null || _a === void 0 ? void 0 : _a.uuid) ? res.locals.user.uuid : 'userId';
         const token = ((_b = res.locals.user) === null || _b === void 0 ? void 0 : _b.token) ? res.locals.user.token : 'token';
-        const { reportId, id, tableId, dataProductDefinitionsPath, reportName, variantName, cols: columns } = req.body;
+        const { reportId, id, tableId, dataProductDefinitionsPath, reportName, name, cols: columns } = req.body;
         const canDownload = await services.downloadPermissionService.downloadEnabled(userId, reportId, id);
         if (!canDownload) {
             res.redirect(`/async/report/${reportId}/${id}/request/${tableId}/report/download-disabled`);
@@ -42,20 +42,15 @@ exports.default = {
             let reportData = await services.reportingService.getAsyncReport(token, reportId, id, tableId, {
                 dataProductDefinitionsPath,
             });
+            const reportDefinition = await services.reportingService.getDefinition(token, reportId, id, dataProductDefinitionsPath);
             if (columns) {
                 reportData = applyColumnsAndSort(reportData, JSON.parse(columns));
             }
-            const csvData = convertToCsv(reportData);
-            const fileData = await saveToFile(csvData, reportName, variantName);
-            res.download(fileData.filepath, (err) => {
-                if (err) {
-                    logger_1.default.error(err);
-                }
-                else {
-                    logger_1.default.info(`Download completed: ${userId}: ${reportName} - ${variantName}`);
-                    fs_extra_1.default.unlinkSync(fileData.filepath);
-                }
-            });
+            const keys = getKeys(reportData, reportDefinition);
+            const csvData = convertToCsv(reportData, { keys });
+            res.setHeader('Content-Type', 'application/json');
+            res.setHeader('Content-disposition', `attachment; filename=${reportName}-${name}-${new Date().toISOString()}.csv`);
+            res.end(csvData);
         }
     },
 };

package/dpr/utils/downloadUtils.ts

@@ -1,21 +1,30 @@
 import { Response, Request } from 'express'
-import { json2csv } from 'json-2-csv'
-import fs from 'fs-extra'
+import { json2csv, Json2CsvOptions } from 'json-2-csv'
+import { KeysList } from 'json-2-csv/lib/types'
 import { Services } from '../types/Services'
 import Dict = NodeJS.Dict
-import logger from './logger'
+import { components } from '../types/api'
 
-const convertToCsv = (reportData: Dict<string>[]) => {
-  const csvData = json2csv(reportData)
+const convertToCsv = (reportData: Dict<string>[], options: Json2CsvOptions) => {
+  const csvData = json2csv(reportData, options)
   return csvData
 }
 
-const saveToFile = async (csvData: string, reportName: string, variantName: string) => {
-  const filepath = `./download/${reportName}-${variantName}-${new Date().toISOString()}.csv`
-  await fs.outputFile(filepath, csvData)
-  return {
-    filepath,
-  }
+const getKeys = (
+  reportData: Dict<string>[],
+  reportDefinition: components['schemas']['SingleVariantReportDefinition'],
+): KeysList => {
+  const { fields } = reportDefinition.variant.specification
+  const keys: KeysList = []
+  Object.keys(reportData[0]).forEach((key) => {
+    const field = fields.find((f) => f.name === key)
+    keys.push({
+      field: key,
+      title: field.display,
+    })
+  })
+
+  return keys
 }
 
 const applyColumnsAndSort = (data: Dict<string>[], columns: string[]) => {
@@ -35,7 +44,7 @@ export default {
     const userId = res.locals.user?.uuid ? res.locals.user.uuid : 'userId'
     const token = res.locals.user?.token ? res.locals.user.token : 'token'
 
-    const { reportId, id, tableId, dataProductDefinitionsPath, reportName, variantName, cols: columns } = req.body
+    const { reportId, id, tableId, dataProductDefinitionsPath, reportName, name, cols: columns } = req.body
 
     const canDownload = await services.downloadPermissionService.downloadEnabled(userId, reportId, id)
     if (!canDownload) {
@@ -44,21 +53,22 @@ export default {
       let reportData = await services.reportingService.getAsyncReport(token, reportId, id, tableId, {
         dataProductDefinitionsPath,
       })
+      const reportDefinition = await services.reportingService.getDefinition(
+        token,
+        reportId,
+        id,
+        dataProductDefinitionsPath,
+      )
 
       if (columns) {
         reportData = applyColumnsAndSort(reportData, JSON.parse(columns))
       }
-      const csvData = convertToCsv(reportData)
-      const fileData = await saveToFile(csvData, reportName, variantName)
+      const keys: KeysList = getKeys(reportData, reportDefinition)
+      const csvData = convertToCsv(reportData, { keys })
 
-      res.download(fileData.filepath, (err) => {
-        if (err) {
-          logger.error(err)
-        } else {
-          logger.info(`Download completed: ${userId}: ${reportName} - ${variantName}`)
-          fs.unlinkSync(fileData.filepath)
-        }
-      })
+      res.setHeader('Content-Type', 'application/json')
+      res.setHeader('Content-disposition', `attachment; filename=${reportName}-${name}-${new Date().toISOString()}.csv`)
+      res.end(csvData)
     }
   },
 }

package/dpr/utils/renderAsyncReport.js

@@ -126,7 +126,7 @@ const getReport = async ({ req, res, services }) => {
 };
 exports.getReport = getReport;
 const setActions = (csrfToken, variant, requestData, columns) => {
-    const { reportName, name, id, variantId, reportId, executionId, tableId, type } = requestData;
+    const { reportName, name, id, variantId, reportId, executionId, tableId, type, dataProductDefinitionsPath } = requestData;
     const url = requestData.url.request.fullUrl;
     const { printable } = variant;
     const ID = variantId || id;
@@ -141,6 +141,7 @@ const setActions = (csrfToken, variant, requestData, columns) => {
             tableId,
             type: type || UserReports_1.ReportType.REPORT,
             columns: columns.value,
+            definitionPath: dataProductDefinitionsPath,
         },
         print: {
             enabled: printable,

package/dpr/utils/renderAsyncReport.ts

@@ -174,7 +174,8 @@ const setActions = (
   requestData: RequestedReport,
   columns: Columns,
 ) => {
-  const { reportName, name, id, variantId, reportId, executionId, tableId, type } = requestData
+  const { reportName, name, id, variantId, reportId, executionId, tableId, type, dataProductDefinitionsPath } =
+    requestData
   const url = requestData.url.request.fullUrl
   const { printable } = variant
 
@@ -191,6 +192,7 @@ const setActions = (
       tableId,
       type: type || ReportType.REPORT,
       columns: columns.value,
+      definitionPath: dataProductDefinitionsPath,
     },
     print: {
       enabled: printable,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ministryofjustice/hmpps-digital-prison-reporting-frontend",
   "description": "The Digital Prison Reporting Frontend contains templates and code to help display data effectively in UI applications.",
-  "version": "3.31.2",
+  "version": "3.31.3",
   "main": "dpr/assets/js/all.mjs",
   "sass": "dpr/all.scss",
   "engines": {