@ministryofjustice/hmpps-digital-prison-reporting-frontend 3.9.0 → 3.9.2

package/dpr/assets/js/all.mjs

@@ -635,7 +635,7 @@ class DprQueryParamClass extends DprClientClass {
    */
   initQueryParamsFromInputs (elements) {
     Array.from(elements).forEach((input) => {
-      this.setQueryParamFromInput(input);
+      if (input.type !== 'hidden') this.setQueryParamFromInput(input);
     });
   }
 
@@ -780,6 +780,8 @@ class AsyncFilters extends DprQueryParamClass {
 
     document.getElementById('async-filters-form-pathname').value = window.location.pathname;
     document.getElementById('async-filters-form-origin').value = window.location.origin;
+    document.getElementById('async-filters-form-href').value = window.location.href;
+    document.getElementById('async-filters-form-search').value = window.location.search;
   }
 
   initResetButton () {

package/dpr/components/async-card-group/utils.js

@@ -6,7 +6,7 @@ const formatCardData = async (requestedReportsData, dataSources, token, asyncRep
     const { executionId, reportId, variantId } = reportData;
     let response;
     try {
-        response = await dataSources.getAsyncReportStatus(token, reportId, variantId, executionId);
+        response = await dataSources.getAsyncReportStatus(token, reportId, variantId, executionId, reportData.dataProductDefinitionsPath);
     }
     catch (_a) {
         response = {

package/dpr/components/async-card-group/utils.ts

@@ -15,7 +15,13 @@ const formatCardData = async (
   let response: Dict<string>
 
   try {
-    response = await dataSources.getAsyncReportStatus(token, reportId, variantId, executionId)
+    response = await dataSources.getAsyncReportStatus(
+      token,
+      reportId,
+      variantId,
+      executionId,
+      reportData.dataProductDefinitionsPath,
+    )
   } catch {
     response = {
       status: RequestStatus.FAILED,

package/dpr/components/async-filters/view.njk

@@ -25,6 +25,8 @@
       <input type="hidden" name="variantName" value="{{ variantName }}">
       <input type="hidden" name="pathname" id="async-filters-form-pathname" value="">
       <input type="hidden" name="origin" id="async-filters-form-origin" value="">
+      <input type="hidden" name="href" id="async-filters-form-href" value="">
+      <input type="hidden" name="search" id="async-filters-form-search" value="">
 
       <div class="dpr-async-controls__section">
         <h3 class="govuk-heading-s">Filters</h3>

package/dpr/components/async-polling/utils.js

@@ -8,7 +8,7 @@ exports.default = {
             const { token } = res.locals.user || 'token';
             const { reportId, variantId, executionId } = req.params;
             let reportData = await asyncReportsStore.getReport(executionId);
-            const statusResponse = await dataSources.getAsyncReportStatus(token, reportId, variantId, executionId);
+            const statusResponse = await dataSources.getAsyncReportStatus(token, reportId, variantId, executionId, reportData.dataProductDefinitionsPath);
             const { status: latestStatus } = statusResponse;
             if (currentStatus !== latestStatus) {
                 await asyncReportsStore.updateStatus(reportData.executionId, latestStatus);

package/dpr/components/async-polling/utils.ts

@@ -9,7 +9,13 @@ export default {
       const { reportId, variantId, executionId } = req.params
       let reportData = await asyncReportsStore.getReport(executionId)
 
-      const statusResponse = await dataSources.getAsyncReportStatus(token, reportId, variantId, executionId)
+      const statusResponse = await dataSources.getAsyncReportStatus(
+        token,
+        reportId,
+        variantId,
+        executionId,
+        reportData.dataProductDefinitionsPath,
+      )
       const { status: latestStatus } = statusResponse
 
       if (currentStatus !== latestStatus) {

package/dpr/components/async-report-list/utils.js

@@ -13,14 +13,15 @@ const initDataSources = ({ req, res, next, asyncReportsStore, dataSources }) =>
     try {
         const { token } = res.locals.user || 'token';
         const { reportId, reportVariantId, tableId } = req.params;
-        const { selectedPage = 1, pageSize = 10, dataProductDefinitionsPath } = req.query;
+        const { selectedPage = 1, pageSize = 10 } = req.query;
+        const dataProductDefinitionsPath = req.query.dataProductDefinitionsPath;
         const reportDefinitionPromise = dataSources.getDefinition(token, reportId, reportVariantId, dataProductDefinitionsPath);
         const reportDataPromise = dataSources.getAsyncReport(token, reportId, reportVariantId, tableId, {
             selectedPage: +selectedPage,
             pageSize: +pageSize,
-            dataProductDefinitionsPath: dataProductDefinitionsPath,
+            dataProductDefinitionsPath,
         });
-        const reportDataCountPromise = dataSources.getAsyncCount(token, tableId);
+        const reportDataCountPromise = dataSources.getAsyncCount(token, tableId, dataProductDefinitionsPath);
         const stateData = asyncReportsStore.getReportByTableId(tableId);
         return [reportDefinitionPromise, reportDataPromise, reportDataCountPromise, stateData];
     }

package/dpr/components/async-report-list/utils.ts

@@ -14,19 +14,20 @@ const initDataSources = ({ req, res, next, asyncReportsStore, dataSources }: Asy
   try {
     const { token } = res.locals.user || 'token'
     const { reportId, reportVariantId, tableId } = req.params
-    const { selectedPage = 1, pageSize = 10, dataProductDefinitionsPath } = req.query
+    const { selectedPage = 1, pageSize = 10 } = req.query
+    const dataProductDefinitionsPath = <string>req.query.dataProductDefinitionsPath
     const reportDefinitionPromise = dataSources.getDefinition(
       token,
       reportId,
       reportVariantId,
-      <string>dataProductDefinitionsPath,
+      dataProductDefinitionsPath,
     )
     const reportDataPromise = dataSources.getAsyncReport(token, reportId, reportVariantId, tableId, {
       selectedPage: +selectedPage,
       pageSize: +pageSize,
-      dataProductDefinitionsPath: <string>dataProductDefinitionsPath,
+      dataProductDefinitionsPath,
     })
-    const reportDataCountPromise = dataSources.getAsyncCount(token, tableId)
+    const reportDataCountPromise = dataSources.getAsyncCount(token, tableId, dataProductDefinitionsPath)
     const stateData = asyncReportsStore.getReportByTableId(tableId)
 
     return [reportDefinitionPromise, reportDataPromise, reportDataCountPromise, stateData]

package/dpr/components/search/view.njk

@@ -10,7 +10,10 @@
     suffix: {
       html: "🔍"
     },
-    classes: "dpr-search-box"
+    classes: "dpr-search-box",
+    attributes: {
+      placeholder: "Type to filter reports"
+    }
   }) }}
 
   {{ govukTable({

package/dpr/data/reportingClient.js

@@ -99,21 +99,27 @@ class ReportingClient {
         })
             .then((response) => response);
     }
-    getAsyncReportStatus(token, reportId, variantId, executionId) {
+    getAsyncReportStatus(token, reportId, variantId, executionId, dataProductDefinitionsPath) {
         logger_1.default.info(`Reporting client: Get statementId:${executionId} status`);
         return this.restClient
             .get({
             path: `/reports/${reportId}/${variantId}/statements/${executionId}/status`,
             token,
+            query: {
+                dataProductDefinitionsPath,
+            },
         })
             .then((response) => response);
     }
-    getAsyncCount(token, tableId) {
+    getAsyncCount(token, tableId, dataProductDefinitionsPath) {
         logger_1.default.info(`Reporting client: Get tableId:${tableId} count`);
         return this.restClient
             .get({
             path: `/report/tables/${tableId}/count`,
             token,
+            query: {
+                dataProductDefinitionsPath,
+            },
         })
             .then((response) => response.count);
     }

package/dpr/data/reportingClient.ts

@@ -144,24 +144,36 @@ export default class ReportingClient {
       .then((response) => <Array<Dict<string>>>response)
   }
 
-  getAsyncReportStatus(token: string, reportId: string, variantId: string, executionId: string): Promise<Dict<string>> {
+  getAsyncReportStatus(
+    token: string,
+    reportId: string,
+    variantId: string,
+    executionId: string,
+    dataProductDefinitionsPath?: string,
+  ): Promise<Dict<string>> {
     logger.info(`Reporting client: Get statementId:${executionId} status`)
 
     return this.restClient
       .get({
         path: `/reports/${reportId}/${variantId}/statements/${executionId}/status`,
         token,
+        query: {
+          dataProductDefinitionsPath,
+        },
       })
       .then((response) => <Dict<string>>response)
   }
 
-  getAsyncCount(token: string, tableId: string): Promise<number> {
+  getAsyncCount(token: string, tableId: string, dataProductDefinitionsPath?: string): Promise<number> {
     logger.info(`Reporting client: Get tableId:${tableId} count`)
 
     return this.restClient
       .get({
         path: `/report/tables/${tableId}/count`,
         token,
+        query: {
+          dataProductDefinitionsPath,
+        },
       })
       .then((response) => (<Count>response).count)
   }

package/dpr/services/reportingService.js

@@ -22,11 +22,11 @@ class ReportingService {
     async getAsyncReport(token, reportId, variantId, tableId, query) {
         return this.reportingClient.getAsyncReport(token, reportId, variantId, tableId, query);
     }
-    async getAsyncReportStatus(token, reportId, variantId, executionId) {
-        return this.reportingClient.getAsyncReportStatus(token, reportId, variantId, executionId);
+    async getAsyncReportStatus(token, reportId, variantId, executionId, dataProductDefinitionsPath) {
+        return this.reportingClient.getAsyncReportStatus(token, reportId, variantId, executionId, dataProductDefinitionsPath);
     }
-    async getAsyncCount(token, tableId) {
-        return this.reportingClient.getAsyncCount(token, tableId);
+    async getAsyncCount(token, tableId, dataProductDefinitionsPath) {
+        return this.reportingClient.getAsyncCount(token, tableId, dataProductDefinitionsPath);
     }
 }
 exports.default = ReportingService;

package/dpr/services/reportingService.ts

@@ -54,11 +54,18 @@ export default class ReportingService {
     reportId: string,
     variantId: string,
     executionId: string,
+    dataProductDefinitionsPath: string,
   ): Promise<Dict<string>> {
-    return this.reportingClient.getAsyncReportStatus(token, reportId, variantId, executionId)
+    return this.reportingClient.getAsyncReportStatus(
+      token,
+      reportId,
+      variantId,
+      executionId,
+      dataProductDefinitionsPath,
+    )
   }
 
-  async getAsyncCount(token: string, tableId: string): Promise<number> {
-    return this.reportingClient.getAsyncCount(token, tableId)
+  async getAsyncCount(token: string, tableId: string, dataProductDefinitionsPath?: string): Promise<number> {
+    return this.reportingClient.getAsyncCount(token, tableId, dataProductDefinitionsPath)
   }
 }

package/dpr/services/requestedReportsService.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const AsyncReport_1 = require("../types/AsyncReport");
+const urlHelper_1 = require("../utils/urlHelper");
 class AsyncReportStoreService {
     constructor(userStore) {
         this.userStore = userStore;
@@ -51,8 +52,8 @@ class AsyncReportStoreService {
                     search,
                 },
                 polling: {
-                    fullUrl: `${origin}${pathname}/${executionId}`,
-                    pathname: `${pathname}/${executionId}`,
+                    fullUrl: `${origin}${pathname}/${executionId}${(0, urlHelper_1.getDpdPathSuffix)(dataProductDefinitionsPath)}`,
+                    pathname: `${pathname}/${executionId}${(0, urlHelper_1.getDpdPathSuffix)(dataProductDefinitionsPath)}`,
                 },
                 report: {},
             },
@@ -125,11 +126,8 @@ class AsyncReportStoreService {
                 break;
             case AsyncReport_1.RequestStatus.FINISHED:
                 report.timestamp.completed = `Ready at: ${ts}`;
-                report.url.report.pathname = `${report.url.request.pathname}/${tableId}/report`;
-                report.url.report.fullUrl = `${report.url.origin}${report.url.report.pathname}`;
-                if (report.dataProductDefinitionsPath) {
-                    report.url.report.fullUrl = `${report.url.report.fullUrl}?dataProductDefinitionsPath=${report.dataProductDefinitionsPath}`;
-                }
+                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)}`;
                 break;
             case AsyncReport_1.RequestStatus.SUBMITTED:
                 report.timestamp.requested = `Requested at: ${ts}`;

package/dpr/services/requestedReportsService.ts

@@ -2,6 +2,7 @@
 import UserDataStore, { UserStoreConfig } from '../data/userDataStore'
 import Dict = NodeJS.Dict
 import { AsyncReportData, RequestStatus } from '../types/AsyncReport'
+import { getDpdPathSuffix } from '../utils/urlHelper'
 
 export default class AsyncReportStoreService {
   userConfig: UserStoreConfig
@@ -80,8 +81,8 @@ export default class AsyncReportStoreService {
           search,
         },
         polling: {
-          fullUrl: `${origin}${pathname}/${executionId}`,
-          pathname: `${pathname}/${executionId}`,
+          fullUrl: `${origin}${pathname}/${executionId}${getDpdPathSuffix(dataProductDefinitionsPath)}`,
+          pathname: `${pathname}/${executionId}${getDpdPathSuffix(dataProductDefinitionsPath)}`,
         },
         report: {},
       },
@@ -164,11 +165,12 @@ export default class AsyncReportStoreService {
         break
       case RequestStatus.FINISHED:
         report.timestamp.completed = `Ready at: ${ts}`
-        report.url.report.pathname = `${report.url.request.pathname}/${tableId}/report`
-        report.url.report.fullUrl = `${report.url.origin}${report.url.report.pathname}`
-        if (report.dataProductDefinitionsPath) {
-          report.url.report.fullUrl = `${report.url.report.fullUrl}?dataProductDefinitionsPath=${report.dataProductDefinitionsPath}`
-        }
+        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,
+        )}`
         break
       case RequestStatus.SUBMITTED:
         report.timestamp.requested = `Requested at: ${ts}`

package/dpr/utils/urlHelper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createQuerystringFromObject = exports.clearFilterValue = void 0;
+exports.getDpdPathSuffix = exports.createQuerystringFromObject = exports.clearFilterValue = void 0;
 exports.clearFilterValue = '~clear~';
 const createUrlForParameters = (currentQueryParams, updateQueryParams) => {
     let queryParams;
@@ -46,4 +46,11 @@ const createQuerystringFromObject = (source) => {
     return `?${querystring}`;
 };
 exports.createQuerystringFromObject = createQuerystringFromObject;
+const getDpdPathSuffix = (dpdsPath) => {
+    if (dpdsPath && dpdsPath !== '') {
+        return `?dataProductDefinitionsPath=${dpdsPath}`;
+    }
+    return '';
+};
+exports.getDpdPathSuffix = getDpdPathSuffix;
 exports.default = createUrlForParameters;

package/dpr/utils/urlHelper.ts

@@ -52,4 +52,12 @@ export const createQuerystringFromObject = (source: object) => {
   return `?${querystring}`
 }
 
+export const getDpdPathSuffix = (dpdsPath: string) => {
+  if (dpdsPath && dpdsPath !== '') {
+    return `?dataProductDefinitionsPath=${dpdsPath}`
+  }
+
+  return ''
+}
+
 export default createUrlForParameters

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.9.0",
+  "version": "3.9.2",
   "main": "dpr/assets/js/all.mjs",
   "sass": "dpr/all.scss",
   "engines": {