@ministryofjustice/hmpps-digital-prison-reporting-frontend/dpr/utils/CollatedSummaryBuilder/CollatedSummaryBuilder.test.ts

The Digital Prison Reporting Frontend contains templates and code to help display data effectively in UI applications.

import { components } from '../../types/api'
import CollatedSummaryBuilder from './CollatedSummaryBuilder'
import { AsyncSummary } from '../../types/UserReports'
import { DataTable } from '../DataTableBuilder/types'

const activityField: components['schemas']['FieldDefinition'] = {
  name: 'activity',
  display: 'Activity',
  sortable: true,
  defaultsort: false,
  type: 'string',
  mandatory: false,
  visible: true,
  calculated: false,
}
const firstNameField: components['schemas']['FieldDefinition'] = {
  ...activityField,
  name: 'firstName',
  display: 'First name',
}
const surNameField: components['schemas']['FieldDefinition'] = {
  ...activityField,
  name: 'surName',
  display: 'Surname',
}
const defaultFields = [activityField, firstNameField, surNameField]
const defaultSpec: components['schemas']['Specification'] = {
  fields: defaultFields,
  template: 'list',
  sections: ['firstName', 'surName'],
}
const defaultData = [
  {
    firstName: 'Bob',
    surName: 'Robertson',
    activity: 'Painting',
  },
  {
    firstName: 'Jim',
    surName: 'Jameson',
    activity: 'Painting',
  },
  {
    firstName: 'Bob',
    surName: 'Robertson',
    activity: 'Cleaning',
  },
  {
    firstName: 'Jim',
    surName: 'Jameson',
    activity: 'Cooking',
  },
]

const expectedAllActivitiesDataTable: DataTable = {
  colCount: 1,
  head: [
    {
      text: 'Activity',
      classes: null,
    },
  ],
  rowCount: 4,
  rows: [
    [
      {
        classes: '',
        fieldName: 'activity',
        format: 'string',
        text: 'Cleaning',
      },
    ],
    [
      {
        classes: '',
        fieldName: 'activity',
        format: 'string',
        text: 'Cooking',
      },
    ],
    [
      {
        classes: '',
        fieldName: 'activity',
        format: 'string',
        text: 'Painting',
      },
    ],
    [
      {
        classes: '',
        fieldName: 'activity',
        format: 'string',
        text: 'Painting',
      },
    ],
  ],
}

describe('collate', () => {
  it('Summaries with the same template are grouped together', () => {
    const pageHeaderSummary1: AsyncSummary = {
      id: 'one',
      template: 'page-header',
      fields: defaultFields,
      data: defaultData,
    }
    const pageHeaderSummary2: AsyncSummary = {
      id: 'two',
      template: 'page-header',
      fields: defaultFields,
      data: defaultData,
    }
    const pageFooterSummary: AsyncSummary = {
      id: 'three',
      template: 'page-footer',
      fields: defaultFields,
      data: defaultData,
    }

    const summaries: Array<AsyncSummary> = [pageHeaderSummary1, pageHeaderSummary2, pageFooterSummary]

    const collated = new CollatedSummaryBuilder(defaultSpec, summaries).collate()

    expect(collated).toEqual({
      'page-header': [pageHeaderSummary1, pageHeaderSummary2],
      'page-footer': [pageFooterSummary],
    })
  })
})

describe('collatePageSummaries', () => {
  it('Summaries with the same template are grouped together', () => {
    const pageHeaderSummary1: AsyncSummary = {
      id: 'one',
      template: 'page-header',
      fields: defaultFields,
      data: defaultData,
    }
    const pageHeaderSummary2: AsyncSummary = {
      id: 'two',
      template: 'page-header',
      fields: defaultFields,
      data: defaultData,
    }
    const pageFooterSummary: AsyncSummary = {
      id: 'three',
      template: 'page-footer',
      fields: defaultFields,
      data: defaultData,
    }

    const summaries: Array<AsyncSummary> = [pageHeaderSummary1, pageHeaderSummary2, pageFooterSummary]

    const collated = new CollatedSummaryBuilder(defaultSpec, summaries).collatePageSummaries()

    expect(collated).toEqual({
      'page-footer': [expectedAllActivitiesDataTable],
      'page-header': [expectedAllActivitiesDataTable, expectedAllActivitiesDataTable],
    })
  })
})