@ministryofjustice/hmpps-digital-prison-reporting-frontend 2.1.1 → 2.2.1

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

@@ -1,17 +1,27 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const querystringify_1 = __importDefault(require("querystringify"));
+const addAdditionalQueryParams = (path, additionalQueryParams) => {
+    if (additionalQueryParams && Object.keys(additionalQueryParams).length > 0) {
+        return `${path}${querystringify_1.default.stringify(additionalQueryParams, true)}`;
+    }
+    return path;
+};
 exports.default = {
-    reportDefinitionsToCards: (reportDefinitions, pathPrefix) => {
+    reportDefinitionsToCards: (reportDefinitions, pathPrefix, additionalQueryParams) => {
         return reportDefinitions.map((d) => ({
             text: d.name,
-            href: `${pathPrefix}/${d.id}`,
+            href: addAdditionalQueryParams(`${pathPrefix}/${d.id}`, additionalQueryParams),
             description: d.description,
         }));
     },
-    variantDefinitionsToCards: (reportDefinition, pathPrefix) => {
+    variantDefinitionsToCards: (reportDefinition, pathPrefix, additionalQueryParams) => {
         return reportDefinition.variants.map((v) => ({
             text: v.name,
-            href: `${pathPrefix}/${reportDefinition.id}/${v.id}`,
+            href: addAdditionalQueryParams(`${pathPrefix}/${reportDefinition.id}/${v.id}`, additionalQueryParams),
             description: v.description,
         }));
     },

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

@@ -1,13 +1,23 @@
+import qs from 'querystringify'
 import { components } from '../../types/api'
 
+const addAdditionalQueryParams = (path: string, additionalQueryParams?: NodeJS.Dict<string>) => {
+  if (additionalQueryParams && Object.keys(additionalQueryParams).length > 0) {
+    return `${path}${qs.stringify(additionalQueryParams, true)}`
+  }
+
+  return path
+}
+
 export default {
   reportDefinitionsToCards: (
     reportDefinitions: Array<components['schemas']['ReportDefinitionSummary']>,
     pathPrefix: string,
+    additionalQueryParams?: NodeJS.Dict<string>,
   ) => {
     return reportDefinitions.map((d: components['schemas']['ReportDefinitionSummary']) => ({
       text: d.name,
-      href: `${pathPrefix}/${d.id}`,
+      href: addAdditionalQueryParams(`${pathPrefix}/${d.id}`, additionalQueryParams),
       description: d.description,
     }))
   },
@@ -15,10 +25,11 @@ export default {
   variantDefinitionsToCards: (
     reportDefinition: components['schemas']['ReportDefinitionSummary'],
     pathPrefix: string,
+    additionalQueryParams?: NodeJS.Dict<string>,
   ) => {
     return reportDefinition.variants.map((v: components['schemas']['VariantDefinitionSummary']) => ({
       text: v.name,
-      href: `${pathPrefix}/${reportDefinition.id}/${v.id}`,
+      href: addAdditionalQueryParams(`${pathPrefix}/${reportDefinition.id}/${v.id}`, additionalQueryParams),
       description: v.description,
     }))
   },

package/dpr/data/reportingClient.js

@@ -37,11 +37,12 @@ class ReportingClient {
             },
         }));
     }
-    getDefinitions(token) {
+    getDefinitions(token, definitionsPath) {
         logger_1.default.info(`Reporting client: Get definitions`);
         const params = {
             query: {
                 renderMethod: 'HTML',
+                dataProductDefinitionsPath: definitionsPath,
             },
         };
         return this.restClient
@@ -52,23 +53,29 @@ class ReportingClient {
         })
             .then((response) => response);
     }
-    getDefinition(token, reportId, variantId) {
+    getDefinition(token, reportId, variantId, definitionsPath) {
         logger_1.default.info(`Reporting client: Get single variant definition`);
+        const query = {
+            dataProductDefinitionsPath: definitionsPath,
+        };
         return this.restClient
             .get({
             path: `/definitions/${reportId}/${variantId}`,
+            query,
             token,
         })
             .then((response) => response);
     }
-    getFieldValues({ token, definitionName, variantName, fieldName, prefix, }) {
+    getFieldValues({ token, definitionName, variantName, fieldName, prefix, definitionsPath, }) {
+        const query = {
+            dataProductDefinitionsPath: definitionsPath,
+            prefix,
+        };
         return this.restClient
             .get({
             path: `/reports/${definitionName}/${variantName}/${fieldName}`,
             token,
-            query: {
-                prefix,
-            },
+            query,
         })
             .then((response) => response);
     }

package/dpr/data/reportingClient.ts

@@ -46,12 +46,16 @@ export default class ReportingClient {
       }))
   }
 
-  getDefinitions(token: string): Promise<Array<components['schemas']['ReportDefinitionSummary']>> {
+  getDefinitions(
+    token: string,
+    definitionsPath?: string,
+  ): Promise<Array<components['schemas']['ReportDefinitionSummary']>> {
     logger.info(`Reporting client: Get definitions`)
 
     const params: operations['definitions']['parameters'] = {
       query: {
         renderMethod: 'HTML',
+        dataProductDefinitionsPath: definitionsPath,
       },
     }
 
@@ -68,12 +72,18 @@ export default class ReportingClient {
     token: string,
     reportId: string,
     variantId: string,
+    definitionsPath?: string,
   ): Promise<components['schemas']['SingleVariantReportDefinition']> {
     logger.info(`Reporting client: Get single variant definition`)
 
+    const query = {
+      dataProductDefinitionsPath: definitionsPath,
+    }
+
     return this.restClient
       .get({
         path: `/definitions/${reportId}/${variantId}`,
+        query,
         token,
       })
       .then((response) => <components['schemas']['SingleVariantReportDefinition']>response)
@@ -85,14 +95,17 @@ export default class ReportingClient {
     variantName,
     fieldName,
     prefix,
+    definitionsPath,
   }: FieldValuesRequest): Promise<Array<string>> {
+    const query = {
+      dataProductDefinitionsPath: definitionsPath,
+      prefix,
+    }
     return this.restClient
       .get({
         path: `/reports/${definitionName}/${variantName}/${fieldName}`,
         token,
-        query: {
-          prefix,
-        },
+        query,
       })
       .then((response) => <Array<string>>response)
   }

package/dpr/data/types.d.ts

@@ -33,4 +33,5 @@ export interface FieldValuesRequest {
   variantName: string
   fieldName: string
   prefix: string
+  definitionsPath?: string
 }

package/dpr/types/ReportQuery.js

@@ -7,6 +7,9 @@ class ReportQuery {
         this.pageSize = queryParams.pageSize ? Number(queryParams.pageSize) : 20;
         this.sortColumn = queryParams.sortColumn ? queryParams.sortColumn.toString() : defaultSortColumn;
         this.sortedAsc = queryParams.sortedAsc !== 'false';
+        this.dataProductDefinitionsPath = queryParams.dataProductDefinitionsPath
+            ? queryParams.dataProductDefinitionsPath.toString()
+            : null;
         this.filtersPrefix = filtersPrefix;
         this.filters = {};
         Object.keys(queryParams)
@@ -23,6 +26,9 @@ class ReportQuery {
             sortColumn: this.sortColumn,
             sortedAsc: this.sortedAsc.toString(),
         };
+        if (this.dataProductDefinitionsPath) {
+            record.dataProductDefinitionsPath = this.dataProductDefinitionsPath;
+        }
         Object.keys(this.filters).forEach((filterName) => {
             const value = this.filters[filterName];
             if (!removeClearedFilters || value !== urlHelper_1.clearFilterValue) {

package/dpr/types/ReportQuery.ts

@@ -17,6 +17,8 @@ export default class ReportQuery implements FilteredListRequest {
 
   filtersPrefix: string
 
+  dataProductDefinitionsPath?: string
+
   constructor(
     fields: Array<components['schemas']['FieldDefinition']>,
     queryParams: ParsedQs,
@@ -27,6 +29,9 @@ export default class ReportQuery implements FilteredListRequest {
     this.pageSize = queryParams.pageSize ? Number(queryParams.pageSize) : 20
     this.sortColumn = queryParams.sortColumn ? queryParams.sortColumn.toString() : defaultSortColumn
     this.sortedAsc = queryParams.sortedAsc !== 'false'
+    this.dataProductDefinitionsPath = queryParams.dataProductDefinitionsPath
+      ? queryParams.dataProductDefinitionsPath.toString()
+      : null
     this.filtersPrefix = filtersPrefix
 
     this.filters = {}
@@ -46,6 +51,10 @@ export default class ReportQuery implements FilteredListRequest {
       sortedAsc: this.sortedAsc.toString(),
     }
 
+    if (this.dataProductDefinitionsPath) {
+      record.dataProductDefinitionsPath = this.dataProductDefinitionsPath
+    }
+
     Object.keys(this.filters).forEach((filterName) => {
       const value = this.filters[filterName]
       if (!removeClearedFilters || value !== clearFilterValue) {

package/dpr/utils/urlHelper.js

@@ -27,6 +27,7 @@ const createUrlForParameters = (currentQueryParams, updateQueryParams) => {
             pageSize: currentQueryParams.pageSize,
             sortColumn: currentQueryParams.sortColumn,
             sortedAsc: currentQueryParams.sortedAsc,
+            dataProductDefinitionsPath: currentQueryParams.dataProductDefinitionsPath,
         };
     }
     const nonEmptyQueryParams = {};

package/dpr/utils/urlHelper.ts

@@ -25,6 +25,7 @@ const createUrlForParameters = (currentQueryParams: NodeJS.Dict<string>, updateQ
       pageSize: currentQueryParams.pageSize,
       sortColumn: currentQueryParams.sortColumn,
       sortedAsc: currentQueryParams.sortedAsc,
+      dataProductDefinitionsPath: currentQueryParams.dataProductDefinitionsPath,
     }
   }
 

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": "2.1.1",
+  "version": "2.2.1",
   "main": "dpr/assets/js/client.js",
   "sass": "dpr/all.scss",
   "engines": {
@@ -28,6 +28,7 @@
     "govuk-frontend": "^4.7",
     "jquery": "^3.6.4",
     "nunjucks": "^3.2.4",
+    "querystringify": "^2.2.0",
     "superagent": "^8.1.2"
   },
   "author": "HMPPS Digital Prison Reporting Team",