@ministryofjustice/hmpps-digital-prison-reporting-frontend 2.0.0 → 2.0.1

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

@@ -2,18 +2,21 @@ import { components } from '../../types/api'
 
 export default {
   reportDefinitionsToCards: (
-    reportDefinitions: Array<components['schemas']['ReportDefinition']>,
+    reportDefinitions: Array<components['schemas']['ReportDefinitionSummary']>,
     pathPrefix: string,
   ) => {
-    return reportDefinitions.map((d: components['schemas']['ReportDefinition']) => ({
+    return reportDefinitions.map((d: components['schemas']['ReportDefinitionSummary']) => ({
       text: d.name,
       href: `${pathPrefix}/${d.id}`,
       description: d.description,
     }))
   },
 
-  variantDefinitionsToCards: (reportDefinition: components['schemas']['ReportDefinition'], pathPrefix: string) => {
-    return reportDefinition.variants.map((v: components['schemas']['VariantDefinition']) => ({
+  variantDefinitionsToCards: (
+    reportDefinition: components['schemas']['ReportDefinitionSummary'],
+    pathPrefix: string,
+  ) => {
+    return reportDefinition.variants.map((v: components['schemas']['VariantDefinitionSummary']) => ({
       text: v.name,
       href: `${pathPrefix}/${reportDefinition.id}/${v.id}`,
       description: v.description,

package/dpr/data/reportingClient.ts

@@ -46,7 +46,7 @@ export default class ReportingClient {
       }))
   }
 
-  getDefinitions(token: string): Promise<Array<components['schemas']['ReportDefinition']>> {
+  getDefinitions(token: string): Promise<Array<components['schemas']['ReportDefinitionSummary']>> {
     logger.info(`Reporting client: Get definitions`)
 
     const params: operations['definitions']['parameters'] = {
@@ -61,7 +61,7 @@ export default class ReportingClient {
         query: params.query,
         token,
       })
-      .then((response) => <Array<components['schemas']['ReportDefinition']>>response)
+      .then((response) => <Array<components['schemas']['ReportDefinitionSummary']>>response)
   }
 
   getDefinition(

package/dpr/types/api.d.ts

@@ -17,7 +17,7 @@ export interface paths {
     get: operations['configuredApiCount']
   }
   '/definitions': {
-    /** @description Gets all report definitions */
+    /** @description Gets summaries of all report definitions */
     get: operations['definitions']
   }
   '/definitions/{reportId}/{variantId}': {
@@ -47,10 +47,23 @@ export interface components {
        */
       count: number
     }
+    ReportDefinitionSummary: {
+      id: string
+      name: string
+      description?: string
+      variants: components['schemas']['VariantDefinitionSummary'][]
+    }
+    VariantDefinitionSummary: {
+      id: string
+      name: string
+      description?: string
+    }
     DynamicFilterOption: {
       /** Format: int32 */
-      minimumLength: number
+      minimumLength?: number
       returnAsStaticOptions: boolean
+      /** Format: int64 */
+      maximumOptions?: number
     }
     FieldDefinition: {
       name: string
@@ -74,11 +87,11 @@ export interface components {
       name: string
       display: string
     }
-    ReportDefinition: {
+    SingleVariantReportDefinition: {
       id: string
       name: string
       description?: string
-      variants: components['schemas']['VariantDefinition'][]
+      variant: components['schemas']['VariantDefinition']
     }
     Specification: {
       template: string
@@ -91,12 +104,6 @@ export interface components {
       description?: string
       specification?: components['schemas']['Specification']
     }
-    SingleVariantReportDefinition: {
-      id: string
-      name: string
-      description?: string
-      variant: components['schemas']['VariantDefinition']
-    }
   }
   responses: never
   parameters: never
@@ -287,7 +294,7 @@ export interface operations {
       }
     }
   }
-  /** @description Gets all report definitions */
+  /** @description Gets summaries of all report definitions */
   definitions: {
     parameters: {
       query?: {
@@ -296,11 +303,6 @@ export interface operations {
          * @example HTML
          */
         renderMethod?: 'HTML' | 'PDF' | 'SVG'
-        /**
-         * @description This optional parameter sets the maximum number of static options returned when there is a dynamic filter and returnAsStaticOptions is true.
-         * @example 30
-         */
-        maxStaticOptions?: number
         /**
          * @description This optional parameter sets the path of the directory of the data product definition files your application will use.
          *       "This query parameter is intended to be used in conjunction with the `dpr.lib.dataProductDefinitions.host` property to retrieve definition files from another application by using a web client.
@@ -313,7 +315,7 @@ export interface operations {
       /** @description OK */
       200: {
         content: {
-          'application/json': components['schemas']['ReportDefinition'][]
+          'application/json': components['schemas']['ReportDefinitionSummary'][]
         }
       }
       /** @description Bad Request */
@@ -334,11 +336,6 @@ export interface operations {
   definition: {
     parameters: {
       query?: {
-        /**
-         * @description This optional parameter sets the maximum number of static options returned when there is a dynamic filter and returnAsStaticOptions is true.
-         * @example 30
-         */
-        maxStaticOptions?: number
         /**
          * @description This optional parameter sets the path of the directory of the data product definition files your application will use.
          *       "This query parameter is intended to be used in conjunction with the `dpr.lib.dataProductDefinitions.host` property to retrieve definition files from another application by using a web client.

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