@ministryofjustice/hmpps-digital-prison-reporting-frontend 3.3.1 → 3.3.3

package/dpr/components/columns/utils.js

@@ -11,6 +11,6 @@ exports.default = {
         });
     },
     getSelectedColumns: (columns, queryCols) => {
-        return columns.filter((column) => column.disabled || queryCols.includes(column.value)).map((field) => field.value);
+        return columns.filter((column) => column.mandatory || queryCols.includes(column.name)).map((field) => field.name);
     },
 };

package/dpr/components/columns/utils.ts

@@ -1,5 +1,4 @@
 import { components } from '../../types/api'
-import { Column } from './types'
 
 export default {
   getColumns: (fields: Array<components['schemas']['FieldDefinition']>) => {
@@ -12,7 +11,7 @@ export default {
     })
   },
 
-  getSelectedColumns: (columns: Column[], queryCols: string[]) => {
-    return columns.filter((column) => column.disabled || queryCols.includes(column.value)).map((field) => field.value)
+  getSelectedColumns: (columns: Array<components['schemas']['FieldDefinition']>, queryCols: string[]) => {
+    return columns.filter((column) => column.mandatory || queryCols.includes(column.name)).map((field) => field.name)
   },
 }

package/dpr/components/data-table/types.d.ts

@@ -16,7 +16,7 @@ export interface DataTableOptions {
   head: Array<Header>
   rows: Array<Array<Cell>>
   count: number
-  currentQueryParams: Dict<string>
+  currentQueryParams: Dict<string | Array<string>>
   classification: string
   printable?: boolean
   url: string

package/dpr/components/data-table/utils.js

@@ -15,11 +15,11 @@ const mapDate = (isoDate) => {
     return `${day}/${month}/${year} ${hours}:${minutes}`;
 };
 exports.default = {
-    mapHeader: (format, reportQuery, createUrlForParameters, selectedColumns) => {
+    mapHeader: (format, reportQuery, createUrlForParameters) => {
         const currentQueryParams = reportQuery.toRecordWithFilterPrefix();
         return format
             .filter((f) => {
-            return selectedColumns.includes(f.name);
+            return reportQuery.columns.includes(f.name);
         })
             .map((f) => {
             let header;

package/dpr/components/data-table/utils.ts

@@ -22,14 +22,16 @@ export default {
   mapHeader: (
     format: Array<components['schemas']['FieldDefinition']>,
     reportQuery: ReportQuery,
-    createUrlForParameters: (currentQueryParams: Dict<string>, updateQueryParams: Dict<string>) => string,
-    selectedColumns: Array<string>,
+    createUrlForParameters: (
+      currentQueryParams: Dict<string | Array<string>>,
+      updateQueryParams: Dict<string>,
+    ) => string,
   ) => {
     const currentQueryParams = reportQuery.toRecordWithFilterPrefix()
 
     return format
       .filter((f) => {
-        return selectedColumns.includes(f.name)
+        return reportQuery.columns.includes(f.name)
       })
       .map((f) => {
         let header: Header

package/dpr/components/filters/types.d.ts

@@ -1,11 +1,5 @@
 import { FilterType } from './enum'
 
-export interface FilterDefinition {
-  type: FilterType
-  options?: Array<FilterOption>
-  value?: string
-}
-
 export interface FilterOption {
   value: string
   text: string
@@ -23,7 +17,7 @@ export interface GenericFilterValue {
   dynamicResourceEndpoint?: string
 }
 
-export interface DateFilterValue extends FilterValue {
+export interface DateFilterValue extends GenericFilterValue {
   type: FilterType.dateRange
   value?: DateRange
   min?: string

package/dpr/components/filters/utils.ts

@@ -60,7 +60,10 @@ export default {
   getSelectedFilters: (
     format: Array<components['schemas']['FieldDefinition']>,
     reportQuery: ReportQuery,
-    createUrlForParameters: (currentQueryParams: Dict<string>, updateQueryParams: Dict<string>) => string,
+    createUrlForParameters: (
+      currentQueryParams: Dict<string | Array<string>>,
+      updateQueryParams: Dict<string>,
+    ) => string,
   ) =>
     format
       .filter((f) => f.filter)

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

@@ -10,7 +10,6 @@ const utils_2 = __importDefault(require("../filters/utils"));
 const utils_3 = __importDefault(require("../columns/utils"));
 const reportingClient_1 = __importDefault(require("../../data/reportingClient"));
 const filtersQueryParameterPrefix = 'filters.';
-const columnsQueryParameterPrefix = 'columns';
 function getDefaultSortColumn(fields) {
     var _a;
     const defaultSortColumn = fields.find((f) => f.defaultsort);
@@ -42,7 +41,7 @@ function redirectWithDefaultFilters(reportQuery, variantDefinition, response, re
         });
     }
     if (Object.keys(defaultFilters).length > 0) {
-        const querystring = (0, urlHelper_1.default)(reportQuery.toRecordWithFilterPrefix(), defaultFilters, reportQuery.columns);
+        const querystring = (0, urlHelper_1.default)(reportQuery.toRecordWithFilterPrefix(), defaultFilters);
         response.redirect(`${request.baseUrl}${request.path}${querystring}`);
         return true;
     }
@@ -65,15 +64,13 @@ function renderList(listData, variantDefinition, reportQuery, request, response,
                 // eslint-disable-next-line prefer-destructuring
                 data = resolvedData[0];
             }
-            const columns = utils_3.default.getColumns(fields);
-            const selectedColumns = utils_3.default.getSelectedColumns(columns, reportQuery.columns);
             const columnOptions = {
-                columns,
-                selectedColumns,
+                columns: utils_3.default.getColumns(fields),
+                selectedColumns: reportQuery.columns,
             };
             const dataTableOptions = {
-                head: utils_1.default.mapHeader(fields, reportQuery, urlHelper_1.default, selectedColumns),
-                rows: utils_1.default.mapData(data, fields, selectedColumns),
+                head: utils_1.default.mapHeader(fields, reportQuery, urlHelper_1.default),
+                rows: utils_1.default.mapData(data, fields, reportQuery.columns),
                 count: resolvedData[1],
                 currentQueryParams: reportQuery.toRecordWithFilterPrefix(),
                 classification,
@@ -109,7 +106,7 @@ const renderListWithDefinition = ({ title, definitionName, variantName, request,
         .then((reportDefinition) => {
         const reportName = reportDefinition.name;
         const variantDefinition = reportDefinition.variant;
-        const reportQuery = new ReportQuery_1.default(variantDefinition.specification.fields, request.query, getDefaultSortColumn(variantDefinition.specification.fields), filtersQueryParameterPrefix, columnsQueryParameterPrefix);
+        const reportQuery = new ReportQuery_1.default(variantDefinition.specification.fields, request.query, getDefaultSortColumn(variantDefinition.specification.fields), filtersQueryParameterPrefix);
         const getListData = {
             data: reportingClient.getListWithWarnings(variantDefinition.resourceName, token, reportQuery),
             count: reportingClient.getCount(variantDefinition.resourceName, token, reportQuery),
@@ -124,7 +121,7 @@ exports.default = {
     filtersQueryParameterPrefix,
     renderListWithData: ({ title, variantDefinition, request, response, next, getListDataSources, otherOptions, layoutTemplate, dynamicAutocompleteEndpoint, }) => {
         const { fields } = variantDefinition.specification;
-        const reportQuery = new ReportQuery_1.default(fields, request.query, getDefaultSortColumn(fields), filtersQueryParameterPrefix, columnsQueryParameterPrefix);
+        const reportQuery = new ReportQuery_1.default(fields, request.query, getDefaultSortColumn(fields), filtersQueryParameterPrefix);
         const listData = getListDataSources(reportQuery);
         renderList(listData, variantDefinition, reportQuery, request, response, next, title, layoutTemplate, dynamicAutocompleteEndpoint, otherOptions);
     },

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

@@ -14,7 +14,6 @@ import RenderListWithDefinitionInput from './RenderListWithDefinitionInput'
 import CreateRequestHandlerInput from './CreateRequestHandlerInput'
 
 const filtersQueryParameterPrefix = 'filters.'
-const columnsQueryParameterPrefix = 'columns'
 
 function getDefaultSortColumn(fields: components['schemas']['FieldDefinition'][]) {
   const defaultSortColumn = fields.find((f) => f.defaultsort)
@@ -62,11 +61,7 @@ function redirectWithDefaultFilters(
   }
 
   if (Object.keys(defaultFilters).length > 0) {
-    const querystring = createUrlForParameters(
-      reportQuery.toRecordWithFilterPrefix(),
-      defaultFilters,
-      reportQuery.columns,
-    )
+    const querystring = createUrlForParameters(reportQuery.toRecordWithFilterPrefix(), defaultFilters)
     response.redirect(`${request.baseUrl}${request.path}${querystring}`)
     return true
   }
@@ -103,16 +98,14 @@ function renderList(
           data = resolvedData[0]
         }
 
-        const columns = ColumnUtils.getColumns(fields)
-        const selectedColumns = ColumnUtils.getSelectedColumns(columns, reportQuery.columns)
         const columnOptions = {
-          columns,
-          selectedColumns,
+          columns: ColumnUtils.getColumns(fields),
+          selectedColumns: reportQuery.columns,
         }
 
         const dataTableOptions: DataTableOptions = {
-          head: DataTableUtils.mapHeader(fields, reportQuery, createUrlForParameters, selectedColumns),
-          rows: DataTableUtils.mapData(data, fields, selectedColumns),
+          head: DataTableUtils.mapHeader(fields, reportQuery, createUrlForParameters),
+          rows: DataTableUtils.mapData(data, fields, reportQuery.columns),
           count: resolvedData[1],
           currentQueryParams: reportQuery.toRecordWithFilterPrefix(),
           classification,
@@ -171,7 +164,6 @@ const renderListWithDefinition = ({
         request.query,
         getDefaultSortColumn(variantDefinition.specification.fields),
         filtersQueryParameterPrefix,
-        columnsQueryParameterPrefix,
       )
 
       const getListData: ListDataSources = {
@@ -216,7 +208,6 @@ export default {
       request.query,
       getDefaultSortColumn(fields),
       filtersQueryParameterPrefix,
-      columnsQueryParameterPrefix,
     )
     const listData = getListDataSources(reportQuery)
 

package/dpr/types/ReportQuery.js

@@ -1,8 +1,12 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const urlHelper_1 = require("../utils/urlHelper");
+const utils_1 = __importDefault(require("../components/columns/utils"));
 class ReportQuery {
-    constructor(fields, queryParams, defaultSortColumn, filtersPrefix, columnsPrefix) {
+    constructor(fields, queryParams, defaultSortColumn, filtersPrefix) {
         this.selectedPage = queryParams.selectedPage ? Number(queryParams.selectedPage) : 1;
         this.pageSize = queryParams.pageSize ? Number(queryParams.pageSize) : 20;
         this.sortColumn = queryParams.sortColumn ? queryParams.sortColumn.toString() : defaultSortColumn;
@@ -11,9 +15,9 @@ class ReportQuery {
             ? queryParams.dataProductDefinitionsPath.toString()
             : null;
         this.filtersPrefix = filtersPrefix;
-        this.columnsPrefix = columnsPrefix;
         if (queryParams.columns) {
-            this.columns = typeof queryParams.columns === 'string' ? [queryParams.columns] : queryParams.columns;
+            const columns = typeof queryParams.columns === 'string' ? queryParams.columns.split(',') : queryParams.columns;
+            this.columns = utils_1.default.getSelectedColumns(fields, columns);
         }
         else {
             this.columns = fields.map((f) => f.name);
@@ -32,6 +36,7 @@ class ReportQuery {
             pageSize: this.pageSize.toString(),
             sortColumn: this.sortColumn,
             sortedAsc: this.sortedAsc.toString(),
+            columns: this.columns,
         };
         if (this.dataProductDefinitionsPath) {
             record.dataProductDefinitionsPath = this.dataProductDefinitionsPath;

package/dpr/types/ReportQuery.ts

@@ -3,6 +3,7 @@ import { FilteredListRequest } from './index'
 import Dict = NodeJS.Dict
 import { components } from './api'
 import { clearFilterValue } from '../utils/urlHelper'
+import ColumnUtils from '../components/columns/utils'
 
 export default class ReportQuery implements FilteredListRequest {
   selectedPage: number
@@ -19,8 +20,6 @@ export default class ReportQuery implements FilteredListRequest {
 
   filtersPrefix: string
 
-  columnsPrefix: string
-
   dataProductDefinitionsPath?: string
 
   constructor(
@@ -28,7 +27,6 @@ export default class ReportQuery implements FilteredListRequest {
     queryParams: ParsedQs,
     defaultSortColumn: string,
     filtersPrefix: string,
-    columnsPrefix: string,
   ) {
     this.selectedPage = queryParams.selectedPage ? Number(queryParams.selectedPage) : 1
     this.pageSize = queryParams.pageSize ? Number(queryParams.pageSize) : 20
@@ -38,10 +36,11 @@ export default class ReportQuery implements FilteredListRequest {
       ? queryParams.dataProductDefinitionsPath.toString()
       : null
     this.filtersPrefix = filtersPrefix
-    this.columnsPrefix = columnsPrefix
 
     if (queryParams.columns) {
-      this.columns = typeof queryParams.columns === 'string' ? [queryParams.columns] : (queryParams.columns as string[])
+      const columns =
+        typeof queryParams.columns === 'string' ? queryParams.columns.split(',') : (queryParams.columns as string[])
+      this.columns = ColumnUtils.getSelectedColumns(fields, columns)
     } else {
       this.columns = fields.map((f) => f.name)
     }
@@ -56,12 +55,13 @@ export default class ReportQuery implements FilteredListRequest {
       })
   }
 
-  toRecordWithFilterPrefix(removeClearedFilters = false): Record<string, string> {
-    const record: Record<string, string> = {
+  toRecordWithFilterPrefix(removeClearedFilters = false): Record<string, string | Array<string>> {
+    const record: Record<string, string | Array<string>> = {
       selectedPage: this.selectedPage.toString(),
       pageSize: this.pageSize.toString(),
       sortColumn: this.sortColumn,
       sortedAsc: this.sortedAsc.toString(),
+      columns: this.columns,
     }
 
     if (this.dataProductDefinitionsPath) {

package/dpr/utils/urlHelper.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createQuerystringFromObject = exports.clearFilterValue = void 0;
 exports.clearFilterValue = '~clear~';
-const createUrlForParameters = (currentQueryParams, updateQueryParams, columns = []) => {
+const createUrlForParameters = (currentQueryParams, updateQueryParams) => {
     let queryParams;
     if (updateQueryParams) {
         queryParams = {
@@ -20,11 +20,6 @@ const createUrlForParameters = (currentQueryParams, updateQueryParams, columns =
                 });
             }
         });
-        if (columns.length) {
-            columns.forEach((col) => {
-                queryParams[`columns.${col}`] = col;
-            });
-        }
     }
     else {
         queryParams = {
@@ -45,13 +40,7 @@ const createUrlForParameters = (currentQueryParams, updateQueryParams, columns =
 };
 const createQuerystringFromObject = (source) => {
     const querystring = Object.keys(source)
-        .map((key) => {
-        let k = key;
-        // eslint-disable-next-line prefer-destructuring
-        if (key.includes('columns.'))
-            k = key.split('.')[0];
-        return `${encodeURI(k)}=${encodeURI(source[key])}`;
-    })
+        .map((key) => `${encodeURI(key)}=${encodeURI(source[key])}`)
         .join('&');
     return `?${querystring}`;
 };

package/dpr/utils/urlHelper.ts

@@ -1,11 +1,10 @@
 export const clearFilterValue = '~clear~'
 
 const createUrlForParameters = (
-  currentQueryParams: NodeJS.Dict<string>,
+  currentQueryParams: NodeJS.Dict<string | Array<string>>,
   updateQueryParams: NodeJS.Dict<string>,
-  columns: Array<string> = [],
 ) => {
-  let queryParams: NodeJS.Dict<string>
+  let queryParams: NodeJS.Dict<string | Array<string>>
 
   if (updateQueryParams) {
     queryParams = {
@@ -23,12 +22,6 @@ const createUrlForParameters = (
           })
       }
     })
-
-    if (columns.length) {
-      columns.forEach((col) => {
-        queryParams[`columns.${col}`] = col
-      })
-    }
   } else {
     queryParams = {
       selectedPage: '1',
@@ -39,7 +32,7 @@ const createUrlForParameters = (
     }
   }
 
-  const nonEmptyQueryParams: NodeJS.Dict<string> = {}
+  const nonEmptyQueryParams: NodeJS.Dict<string | Array<string>> = {}
 
   Object.keys(queryParams)
     .filter((key) => queryParams[key])
@@ -52,12 +45,7 @@ const createUrlForParameters = (
 
 export const createQuerystringFromObject = (source: object) => {
   const querystring = Object.keys(source)
-    .map((key) => {
-      let k = key
-      // eslint-disable-next-line prefer-destructuring
-      if (key.includes('columns.')) k = key.split('.')[0]
-      return `${encodeURI(k)}=${encodeURI(source[key as keyof typeof source])}`
-    })
+    .map((key) => `${encodeURI(key)}=${encodeURI(source[key])}`)
     .join('&')
 
   return `?${querystring}`

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