@defra-fish/pocl-job/src/transform/bindings/pocl/transaction/transaction.bindings.js

Post Office Counter Licence sales processor

import { Binding } from '../../binding.js'
import * as contactBindings from '../contact/contact.bindings.js'
import * as licenceBindings from '../licence/licence.bindings.js'
import * as concessionBindings from '../licence/concession.bindings.js'
import { POST_OFFICE_DATASOURCE, DIRECT_DEBIT_DATASOURCE, DIRECT_DEBIT_PAYMENTSOURCE } from '../../../../staging/constants.js'
import { SERVICE_LOCAL_TIME } from '@defra-fish/business-rules-lib'
import moment from 'moment-timezone'

/**
 * Sequential serial number
 * @type {Binding}
 */
export const SerialNumber = new Binding({ element: 'SERIAL_NO', transform: Binding.TransformTextOnly })

/**
 * Date of transaction
 *
 * @type {Binding}
 */
export const TransactionDate = new Binding({ element: 'SYSTEM_DATE', transform: Binding.TransformTextOnly })

/**
 * Time of transaction
 *
 * @type {Binding}
 */
export const TransactionTime = new Binding({ element: 'SYSTEM_TIME', transform: Binding.TransformTextOnly })

/**
 * Sales Channel – FAD Code
 * @type {Binding}
 */
export const ChannelId = new Binding({ element: 'CHANNEL_ID', transform: Binding.TransformTextOnly })

/**
 * Amount paid
 * @type {Binding}
 */
export const AmountPaid = new Binding({ element: 'AMOUNT', transform: Binding.TransformNumeric })
const paymentMethods = {
  1: 'Cash',
  2: 'Cheque',
  3: 'Stamps',
  4: 'Debit card',
  5: 'Credit card',
  6: 'Direct debit'
}

/**
 * Mopex - method of payment
 * @type {Binding}
 */
export const MethodOfPayment = new Binding({
  element: 'MOPEX',
  transform: context => paymentMethods[Binding.TransformTextOnly(context)] || 'Other'
})

export const DataSourceBinding = new Binding({ element: 'DATA_SOURCE', transform: Binding.TransformTextOnly })
export const DDIDBinding = new Binding({ element: 'DD_ID', transform: Binding.TransformTextOnly })

const getDataSource = children => {
  if (children[DataSourceBinding.element] && children[DataSourceBinding.element] === DIRECT_DEBIT_DATASOURCE) {
    return DIRECT_DEBIT_DATASOURCE
  }
  return POST_OFFICE_DATASOURCE
}

export const convertDateTime = (dateTime, formats) => {
  for (const format of formats) {
    const result = moment.tz(dateTime, format, true, SERVICE_LOCAL_TIME).utc().toISOString()
    if (result) {
      return result
    }
  }
  return null
}

/**
 * Transaction record (the <REC> element)
 * @type {Binding}
 */
export const Transaction = new Binding({
  children: [
    ...Object.values(contactBindings),
    ...Object.values(licenceBindings),
    ...Object.values(concessionBindings),
    SerialNumber,
    ChannelId,
    MethodOfPayment,
    AmountPaid,
    TransactionDate,
    TransactionTime,
    DataSourceBinding,
    DDIDBinding
  ],
  element: 'REC',
  transform: ({ children }) => {
    const transactionDate = moment
      .tz(children[TransactionDate.element] + children[TransactionTime.element], 'DD/MM/YYYYHH:mm:ss', true, SERVICE_LOCAL_TIME)
      .utc()
      .toISOString()
    const email = children[contactBindings.NotifyEmail.element] || children[contactBindings.CommsEmail.element]
    const mobilePhone = children[contactBindings.NotifyMobilePhone.element] || children[contactBindings.CommsMobilePhone.element]
    const preferredNotifyMethod = getPreferredContactMethod(
      children,
      contactBindings.NotifyByEmail.element,
      contactBindings.NotifyBySms.element,
      contactBindings.NotifyByPost.element
    )
    const preferredCommsMethod = getPreferredContactMethod(
      children,
      contactBindings.CommsByEmail.element,
      contactBindings.CommsBySms.element,
      contactBindings.CommsByPost.element
    )
    const dataSource = getDataSource(children)
    const paymentSource = dataSource === DIRECT_DEBIT_DATASOURCE ? DIRECT_DEBIT_PAYMENTSOURCE : POST_OFFICE_DATASOURCE
    const serialNumber = children[SerialNumber.element]
    const permit = children[licenceBindings.Permit.element]
    const journalId = children[DDIDBinding.element]

    return {
      id: serialNumber,
      createTransactionPayload: {
        dataSource,
        ...(journalId && { journalId }),
        serialNumber,
        permissions: [
          {
            licensee: {
              firstName: children[contactBindings.Forename.element],
              lastName: children[contactBindings.Surname.element],
              birthDate: children[contactBindings.BirthDate.element],
              ...(email && { email }),
              ...(mobilePhone && { mobilePhone }),
              ...children[contactBindings.Address.element],
              preferredMethodOfConfirmation: preferredNotifyMethod,
              preferredMethodOfNewsletter: preferredCommsMethod,
              preferredMethodOfReminder: preferredNotifyMethod,
              postalFulfilment: permit?.isForFulfilment
            },
            issueDate: transactionDate,
            startDate: convertDateTime(children[licenceBindings.StartDate.element] + children[licenceBindings.StartTime.element], [
              'DD/MM/YYYYHH:mm',
              'DD/MM/YYYYHH:mm:ss'
            ]),
            permitId: permit?.id,
            ...children[concessionBindings.SeniorConcession.element],
            ...children[concessionBindings.PipConcession.element],
            ...children[concessionBindings.BlueBadgeConcession.element]
          }
        ]
      },
      finaliseTransactionPayload: {
        payment: {
          timestamp: transactionDate,
          amount: children[AmountPaid.element],
          source: paymentSource,
          channelId: children[ChannelId.element],
          method: children[MethodOfPayment.element]
        }
      }
    }
  }
})

const getPreferredContactMethod = (data, emailElement, smsElement, postElement) =>
  data[emailElement] || data[smsElement] || data[postElement] || 'Prefer not to be contacted'