@ministryofjustice/hmpps-digital-prison-reporting-frontend/dpr/components/user-reports/bookmarks/utils.ts

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

import { Response, Request } from 'express'
import { BookmarkService } from '../../../services'
import { BookmarkedReportData, BookmarkStoreData } from '../../../types/Bookmark'
import { FormattedUserReportData, LoadType, ReportType } from '../../../types/UserReports'
import { Services } from '../../../types/Services'
import ShowMoreUtils from '../../show-more/utils'
import logger from '../../../utils/logger'
import DefinitionUtils from '../../../utils/definitionUtils'
import { createListItemProduct, createListActions, setInitialHref } from '../../../utils/reportListsHelper'
import LocalsHelper from '../../../utils/localsHelper'

export const formatBookmarks = async (bookmarksData: BookmarkedReportData[]): Promise<FormattedUserReportData[]> => {
  return bookmarksData
    .map((report: BookmarkedReportData) => {
      return formatBookmark(report)
    })
    .sort((a, b) => a.text.localeCompare(b.text))
}

export const formatBookmark = (bookmarkData: BookmarkedReportData): FormattedUserReportData => {
  const reportData: BookmarkedReportData = JSON.parse(JSON.stringify(bookmarkData))
  const { id, name, description, href, reportName, type } = reportData

  return {
    id,
    reportName,
    text: name,
    description,
    href,
    type: type as ReportType,
  }
}

const formatTable = async (
  bookmarksData: BookmarkedReportData[],
  bookmarkService: BookmarkService,
  csrfToken: string,
  userId: string,
  maxRows?: number,
) => {
  const rows = await Promise.all(
    bookmarksData
      .sort((a, b) => a.name.localeCompare(b.name))
      .map(async (bookmark: BookmarkedReportData) => {
        return formatTableData(bookmark, bookmarkService, csrfToken, userId)
      }),
  )

  return {
    rows: maxRows ? rows.slice(0, maxRows) : rows,
    head: [
      { text: 'Product', classes: 'dpr-req-product-head' },
      { text: 'Description', classes: 'dpr-bm-description-head' },
      { text: 'Actions', classes: 'dpr-bm-actions-head' },
    ],
  }
}

const formatTableData = async (
  bookmarksData: BookmarkedReportData,
  bookmarkService: BookmarkService,
  csrfToken: string,
  userId: string,
) => {
  const { description, reportName, reportId, id, href, name, type, loadType } = bookmarksData
  const bookmarkHtml = await bookmarkService.createBookMarkToggleHtml({
    userId,
    reportId,
    id,
    csrfToken,
    ctxId: 'bookmark-list',
    reportType: type,
  })
  return [
    {
      html: createListItemProduct(reportName, name, type),
    },
    { html: ShowMoreUtils.createShowMoreHtml(description), classes: 'dpr-req-cell' },
    {
      html: createListActions(href, type, loadType, bookmarkHtml),
      classes: 'dpr-req-cell dpr-req-cell__status',
    },
  ]
}

const mapBookmarkIdsToDefinition = async (
  bookmarks: BookmarkStoreData[],
  req: Request,
  res: Response,
  token: string,
  services: Services,
): Promise<BookmarkedReportData[]> => {
  const bookmarkData: BookmarkedReportData[] = []
  const { definitionsPath } = LocalsHelper.getValues(res)

  await Promise.all(
    bookmarks.map(async (bookmark) => {
      let definition
      const { reportId, variantId, id, automatic, type } = bookmark
      const bookmarkId = variantId || id
      const reportType: ReportType = type ? (type as ReportType) : ReportType.REPORT

      try {
        let name
        let description
        let reportName
        let loadType = LoadType.ASYNC
        let href = `/async/${reportType}/${reportId}/${bookmarkId}/request`

        if (reportType === ReportType.REPORT) {
          definition = await services.reportingService.getDefinition(token, reportId, bookmarkId, definitionsPath)
          reportName = definition.name
          name = definition.variant.name
          description = definition.variant.description || definition.description
          loadType = definition.variant.loadType || loadType
          href = setInitialHref(loadType, reportType, reportId, bookmarkId, res)
        }

        if (reportType === ReportType.DASHBOARD) {
          const reportDefinition = await DefinitionUtils.getReportSummary(
            reportId,
            services.reportingService,
            token,
            definitionsPath,
          )

          definition = await services.dashboardService.getDefinition(token, reportId, bookmarkId, definitionsPath)
          name = definition.name
          reportName = reportDefinition.name
          description = definition.description
        }

        if (definition) {
          bookmarkData.push({
            reportId,
            id: bookmarkId,
            reportName,
            name,
            description,
            type: reportType,
            href,
            loadType,
            automatic,
          })
        }
      } catch (error) {
        // DPD has been deleted so API throws error
        logger.warn(`Failed to map bookmark for: Report ${reportId}, variant ${bookmarkId}`)
        const userId = res.locals.user?.uuid ? res.locals.user.uuid : 'userId'
        await services.bookmarkService.removeBookmark(userId, bookmarkId, reportId)
      }
    }),
  )
  return bookmarkData
}

export default {
  renderBookmarkList: async ({
    services,
    maxRows,
    res,
    req,
  }: {
    services: Services
    maxRows?: number
    res: Response
    req: Request
  }) => {
    const { token, csrfToken, userId, bookmarks } = LocalsHelper.getValues(res)
    const bookmarksData: BookmarkedReportData[] = await mapBookmarkIdsToDefinition(bookmarks, req, res, token, services)

    let formatted = await formatBookmarks(bookmarksData)
    const formattedCount = formatted.length

    if (maxRows) formatted = formatted.slice(0, maxRows)
    const tableData = await formatTable(bookmarksData, services.bookmarkService, csrfToken, userId, maxRows)

    const head = {
      ...(formatted.length && { href: '/dpr/my-reports/bookmarks/list' }),
      ...(!formatted.length && { emptyMessage: 'You have 0 bookmarked reports' }),
    }

    const total = {
      amount: formattedCount,
      shown: formattedCount > maxRows ? maxRows : formattedCount,
      max: maxRows,
    }

    const result = {
      head,
      tableData,
      total,
      csrfToken,
      type: 'bookmark',
    }

    return result
  },
}