ffc-pay-schemes 1.0.8 → 1.0.10

package/README.md

@@ -17,6 +17,7 @@ const {
   createInvoiceNumber,
   createSplitInvoiceNumber,
   getAccountCodeMap,
+  getReportingDataFilter,
   getSchemeBatchProperties,
   getSchemeIdFromPillar,
   getSchemeIdFromSourceSystem,
@@ -27,6 +28,7 @@ const {
   getSchemes,
   getSourceSystemFromSchemeId,
   getSourceSystems,
+  isFRPS,
   isValidSchemeId,
   schemeDoesNotRequirePPAs,
   schemeProvidesAccountingValues
@@ -36,6 +38,7 @@ const {
 - `createInvoiceNumber(paymentRequest)` creates an invoice number for a given `paymentRequest`.
 - `createSplitInvoiceNumber(paymentRequest)` creates a split invoice number for a given `paymentRequest`.
 - `getAccountCodeMap(schemeId)` returns the account code mapping used for a given `schemeId`.
+- `getReportingDataFilter(schemeId)` returns the fields which should be added to any data filters applied in reporting checks, for a given `schemeId`.
 - `getSchemeBatchProperties(schemeId)` returns the batch processing properties for a given `schemeId`.
 - `getSchemeIdFromPillar(pillar)` returns the scheme ID for a given `pillar`.
 - `getSchemeIdFromSourceSystem(sourceSystem)` returns the scheme ID for a given `sourceSystem`.
@@ -43,9 +46,10 @@ const {
 - `getSchemeNameFromSchemeId(schemeId)` returns the scheme name for a given `schemeId`.
 - `getSchemeNames()` returns all supported scheme names.
 - `getSchemeProperties(schemeId, sourceSystem, pillar)` returns the default payment properties for a scheme. A scheme can be identified by its ID or source system. The optional `pillar` can be used for manual payments.
-- `getSchemes()` returns all supported schemes as an array of objects containing `schemeId`, `schemeName` and `sourceSystem`.
+- `getSchemes()` returns all supported schemes as an array of objects containing `schemeId`, `schemeName`, `sourceSystem` and `pillar`.
 - `getSourceSystemFromSchemeId(schemeId)` returns the source system name for a given `schemeId`.
 - `getSourceSystems()` returns all supported source systems.
+- `isFRPS(schemeId)` returns `true` if the scheme ID comes from FRPS, or `false` if not.
 - `isValidSchemeId(schemeId)` returns `true` if the scheme ID is recognised, or `false` if not, including converting the scheme ID to a numeric value first if required.
 - `schemeDoesNotRequirePPAs(schemeId)` returns `true` if Payment Hub does not support Post Payment Adjustments (PPAs) for a given `schemeId`; otherwise, it returns `false`.
 - `schemeProvidesAccountingValues(schemeId)` returns `true` if a given `schemeId` provides accounting values within its payment requests; otherwise, it returns `false`.

package/app/constants/frps-schemes.js

@@ -0,0 +1,3 @@
+const { FPTT, WMP } = require('./scheme-ids')
+
+module.exports = [FPTT, WMP]

package/app/helpers/get-reporting-data-filter.js

@@ -0,0 +1,23 @@
+const { BPS, DELINKED, CS } = require('../constants/scheme-ids')
+const { isFRPS } = require('./is-frps')
+
+const getReportingDataFilter = (schemeId) => {
+  const defaultFilter = ['marketingYear', 'agreementNumber']
+  switch (schemeId) {
+    case BPS:
+    case DELINKED:
+      return ['marketingYear']
+    case CS:
+      return ['contractNumber']
+    default:
+      if (isFRPS(schemeId)) {
+        return [...defaultFilter, 'correlationId']
+      } else {
+        return defaultFilter
+      }
+  }
+}
+
+module.exports = {
+  getReportingDataFilter
+}

package/app/helpers/is-frps.js

@@ -0,0 +1,9 @@
+const frpsSchemes = require('../constants/frps-schemes')
+
+const isFRPS = (schemeId) => {
+  return frpsSchemes.includes(schemeId)
+}
+
+module.exports = {
+  isFRPS
+}

package/app/{is-valid-scheme-id.js → helpers/is-valid-scheme-id.js}

@@ -1,4 +1,4 @@
-const schemeIds = require('./constants/scheme-ids')
+const schemeIds = require('../constants/scheme-ids')
 
 const isValidSchemeId = (schemeId) => {
   const numericSchemeId = Number(schemeId)

package/app/{scheme-does-not-require-ppas.js → helpers/scheme-does-not-require-ppas.js}

@@ -1,4 +1,4 @@
-const schemesNotRequiringPPAs = require('./constants/schemes-not-requiring-ppas')
+const schemesNotRequiringPPAs = require('../constants/schemes-not-requiring-ppas')
 
 const schemeDoesNotRequirePPAs = (schemeId) => {
   return schemesNotRequiringPPAs.includes(schemeId)

package/app/{scheme-provides-accounting-values.js → helpers/scheme-provides-accounting-values.js}

@@ -1,4 +1,4 @@
-const schemesProvidingAccountingValues = require('./constants/schemes-providing-account-values')
+const schemesProvidingAccountingValues = require('../constants/schemes-providing-account-values')
 
 const schemeProvidesAccountingValues = (schemeId) => {
   return schemesProvidingAccountingValues.includes(schemeId)

package/app/{get-scheme-id-from-pillar.js → scheme-id/get-scheme-id-from-pillar.js}

@@ -1,4 +1,4 @@
-const { getSchemes } = require('./get-schemes')
+const { getSchemes } = require('../scheme-properties/get-schemes')
 
 const getSchemeIdFromPillar = (pillar) => {
   const matchingScheme = getSchemes().find((scheme) => scheme.pillar === pillar)

package/app/{get-scheme-id-from-source-system.js → scheme-id/get-scheme-id-from-source-system.js}

@@ -1,4 +1,4 @@
-const { getSchemes } = require('./get-schemes')
+const { getSchemes } = require('../scheme-properties/get-schemes')
 
 const getSchemeIdFromSourceSystem = (sourceSystem) => {
   const matchingScheme = getSchemes().find((scheme) => scheme.sourceSystem === sourceSystem)

package/app/{get-scheme-ids.js → scheme-id/get-scheme-ids.js}

@@ -1,4 +1,4 @@
-const schemeIds = require('./constants/scheme-ids')
+const schemeIds = require('../constants/scheme-ids')
 
 const getSchemeIds = () => {
   return schemeIds

package/app/{get-scheme-name-from-scheme-id.js → scheme-name/get-scheme-name-from-scheme-id.js}

@@ -1,5 +1,5 @@
-const { UNKNOWN } = require('./constants/unknown')
-const { getSchemes } = require('./get-schemes')
+const { UNKNOWN } = require('../constants/unknown')
+const { getSchemes } = require('../scheme-properties/get-schemes')
 
 const getSchemeNameFromSchemeId = (schemeId) => {
   const matchingScheme = getSchemes().find((scheme) => scheme.schemeId === schemeId)

package/app/{get-scheme-names.js → scheme-name/get-scheme-names.js}

@@ -1,4 +1,4 @@
-const schemeNames = require('./constants/scheme-names')
+const schemeNames = require('../constants/scheme-names')
 
 const getSchemeNames = () => {
   return schemeNames

package/app/{get-scheme-batch-properties.js → scheme-properties/get-scheme-batch-properties.js}

@@ -1,4 +1,4 @@
-const schemeBatchProperties = require('./constants/scheme-batch-properties')
+const schemeBatchProperties = require('../constants/scheme-batch-properties')
 
 const getSchemeBatchProperties = (schemeId) => {
   return schemeBatchProperties.find(scheme => scheme.schemeId === schemeId)

package/app/{get-scheme-properties.js → scheme-properties/get-scheme-properties.js}

@@ -1,5 +1,5 @@
-const schemes = require('./constants/schemes')
-const { MANUAL } = require('./constants/scheme-ids')
+const schemes = require('../constants/schemes')
+const { MANUAL } = require('../constants/scheme-ids')
 
 const getSchemeProperties = (schemeId, sourceSystem, pillar) => {
   let scheme = schemeId

package/app/scheme-properties/get-schemes.js

@@ -0,0 +1,16 @@
+const pillars = require('../constants/pillars')
+const schemeIds = require('../constants/scheme-ids')
+const schemeNames = require('../constants/scheme-names')
+const sourceSystems = require('../constants/source-systems')
+
+const getSchemes = () =>
+  Object.keys(schemeIds).map((schemeKey) => ({
+    schemeId: schemeIds[schemeKey],
+    schemeName: schemeNames[schemeKey],
+    sourceSystem: sourceSystems[schemeKey],
+    pillar: pillars[schemeKey]
+  }))
+
+module.exports = {
+  getSchemes
+}

package/app/{get-source-system-from-scheme-id.js → source-system/get-source-system-from-scheme-id.js}

@@ -1,5 +1,5 @@
-const { UNKNOWN } = require('./constants/unknown')
-const { getSchemes } = require('./get-schemes')
+const { UNKNOWN } = require('../constants/unknown')
+const { getSchemes } = require('../scheme-properties/get-schemes')
 
 const getSourceSystemFromSchemeId = (schemeId) => {
   const matchingScheme = getSchemes().find((scheme) => scheme.schemeId === schemeId)

package/app/{get-source-systems.js → source-system/get-source-systems.js}

@@ -1,4 +1,4 @@
-const sourceSystems = require('./constants/source-systems')
+const sourceSystems = require('../constants/source-systems')
 
 const getSourceSystems = () => {
   return sourceSystems

package/index.js

@@ -1,24 +1,27 @@
 const { createInvoiceNumber } = require('./app/create-invoice-number')
 const { createSplitInvoiceNumber } = require('./app/create-split-invoice-number')
 const { getAccountCodeMap } = require('./app/get-account-code-map')
-const { getSchemeBatchProperties } = require('./app/get-scheme-batch-properties')
-const { getSchemeIdFromPillar } = require('./app/get-scheme-id-from-pillar')
-const { getSchemeIdFromSourceSystem } = require('./app/get-scheme-id-from-source-system')
-const { getSchemeIds } = require('./app/get-scheme-ids')
-const { getSchemeNameFromSchemeId } = require('./app/get-scheme-name-from-scheme-id')
-const { getSchemeNames } = require('./app/get-scheme-names')
-const { getSchemeProperties } = require('./app/get-scheme-properties')
-const { getSchemes } = require('./app/get-schemes')
-const { getSourceSystemFromSchemeId } = require('./app/get-source-system-from-scheme-id')
-const { getSourceSystems } = require('./app/get-source-systems')
-const { isValidSchemeId } = require('./app/is-valid-scheme-id')
-const { schemeDoesNotRequirePPAs } = require('./app/scheme-does-not-require-ppas')
-const { schemeProvidesAccountingValues } = require('./app/scheme-provides-accounting-values')
+const { getReportingDataFilter } = require('./app/helpers/get-reporting-data-filter')
+const { getSchemeBatchProperties } = require('./app/scheme-properties/get-scheme-batch-properties')
+const { getSchemeIdFromPillar } = require('./app/scheme-id/get-scheme-id-from-pillar')
+const { getSchemeIdFromSourceSystem } = require('./app/scheme-id/get-scheme-id-from-source-system')
+const { getSchemeIds } = require('./app/scheme-id/get-scheme-ids')
+const { getSchemeNameFromSchemeId } = require('./app/scheme-name/get-scheme-name-from-scheme-id')
+const { getSchemeNames } = require('./app/scheme-name/get-scheme-names')
+const { getSchemeProperties } = require('./app/scheme-properties/get-scheme-properties')
+const { getSchemes } = require('./app/scheme-properties/get-schemes')
+const { getSourceSystemFromSchemeId } = require('./app/source-system/get-source-system-from-scheme-id')
+const { getSourceSystems } = require('./app/source-system/get-source-systems')
+const { isFRPS } = require('./app/helpers/is-frps')
+const { isValidSchemeId } = require('./app/helpers/is-valid-scheme-id')
+const { schemeDoesNotRequirePPAs } = require('./app/helpers/scheme-does-not-require-ppas')
+const { schemeProvidesAccountingValues } = require('./app/helpers/scheme-provides-accounting-values')
 
 module.exports = {
   createInvoiceNumber,
   createSplitInvoiceNumber,
   getAccountCodeMap,
+  getReportingDataFilter,
   getSchemeBatchProperties,
   getSchemeIdFromPillar,
   getSchemeIdFromSourceSystem,
@@ -29,6 +32,7 @@ module.exports = {
   getSchemes,
   getSourceSystemFromSchemeId,
   getSourceSystems,
+  isFRPS,
   isValidSchemeId,
   schemeDoesNotRequirePPAs,
   schemeProvidesAccountingValues

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ffc-pay-schemes",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "Module for defining and providing details for the payment schemes supported by the Payment Hub.",
   "main": "index.js",
   "scripts": {

package/test/unit/helpers/get-reporting-data-filter.test.js

@@ -0,0 +1,44 @@
+jest.mock('../../../app/helpers/is-frps', () => ({
+  isFRPS: jest.fn()
+}))
+
+const { BPS, DELINKED, CS } = require('../../../app/constants/scheme-ids')
+const { isFRPS } = require('../../../app/helpers/is-frps')
+const { getReportingDataFilter } = require('../../../app/helpers/get-reporting-data-filter')
+
+describe('getReportingDataFilter', () => {
+  beforeEach(() => {
+    jest.clearAllMocks()
+  })
+
+  test('returns marketing year for BPS', () => {
+    expect(getReportingDataFilter(BPS)).toEqual(['marketingYear'])
+  })
+
+  test('returns marketing year for DELINKED', () => {
+    expect(getReportingDataFilter(DELINKED)).toEqual(['marketingYear'])
+  })
+
+  test('returns contract number for CS', () => {
+    expect(getReportingDataFilter(CS)).toEqual(['contractNumber'])
+  })
+
+  test('returns the FRPS filter including correlation ID', () => {
+    isFRPS.mockReturnValue(true)
+
+    expect(getReportingDataFilter('frps-scheme')).toEqual([
+      'marketingYear',
+      'agreementNumber',
+      'correlationId'
+    ])
+  })
+
+  test('returns the default filter for non-FRPS schemes', () => {
+    isFRPS.mockReturnValue(false)
+
+    expect(getReportingDataFilter('unknown-scheme')).toEqual([
+      'marketingYear',
+      'agreementNumber'
+    ])
+  })
+})

package/test/unit/helpers/is-frps.test.js

@@ -0,0 +1,17 @@
+const frpsSchemes = require('../../../app/constants/frps-schemes')
+const { isFRPS } = require('../../../app/helpers/is-frps')
+
+describe('isFRPS', () => {
+  test.each(frpsSchemes)('returns true for FRPS scheme: %s', (schemeId) => {
+    expect(isFRPS(schemeId)).toBe(true)
+  })
+
+  test.each([
+    'unknown-scheme',
+    '',
+    null,
+    undefined
+  ])('returns false for non-FRPS scheme: %s', (schemeId) => {
+    expect(isFRPS(schemeId)).toBe(false)
+  })
+})

package/test/unit/{is-valid-scheme-id.test.js → helpers/is-valid-scheme-id.test.js}

@@ -1,5 +1,5 @@
-const schemeIds = require('../../app/constants/scheme-ids')
-const { isValidSchemeId } = require('../../app/is-valid-scheme-id')
+const schemeIds = require('../../../app/constants/scheme-ids')
+const { isValidSchemeId } = require('../../../app/helpers/is-valid-scheme-id')
 
 describe('isValidSchemeId', () => {
   test.each(Object.values(schemeIds))(

package/test/unit/{scheme-does-not-require-ppas.test.js → helpers/scheme-does-not-require-ppas.test.js}

@@ -1,6 +1,6 @@
-const { schemeDoesNotRequirePPAs } = require('../../app/scheme-does-not-require-ppas')
-const schemeIds = require('../../app/constants/scheme-ids')
-const schemesNotRequiringPPAs = require('../../app/constants/schemes-not-requiring-ppas')
+const { schemeDoesNotRequirePPAs } = require('../../../app/helpers/scheme-does-not-require-ppas')
+const schemeIds = require('../../../app/constants/scheme-ids')
+const schemesNotRequiringPPAs = require('../../../app/constants/schemes-not-requiring-ppas')
 
 describe('schemeDoesNotRequirePPAs', () => {
   test.each(Object.entries(schemeIds))(

package/test/unit/{scheme-provides-accounting-values.test.js → helpers/scheme-provides-accounting-values.test.js}

@@ -1,6 +1,6 @@
-const { schemeProvidesAccountingValues } = require('../../app/scheme-provides-accounting-values')
-const schemeIds = require('../../app/constants/scheme-ids')
-const schemesProvidingAccountingValues = require('../../app/constants/schemes-providing-account-values')
+const { schemeProvidesAccountingValues } = require('../../../app/helpers/scheme-provides-accounting-values')
+const schemeIds = require('../../../app/constants/scheme-ids')
+const schemesProvidingAccountingValues = require('../../../app/constants/schemes-providing-account-values')
 
 describe('schemeProvidesAccountingValues', () => {
   test.each(Object.entries(schemeIds))(

package/test/unit/{get-scheme-id-from-pillar.test.js → scheme-id/get-scheme-id-from-pillar.test.js}

@@ -1,9 +1,9 @@
-jest.mock('../../app/get-schemes', () => ({
+jest.mock('../../../app/scheme-properties/get-schemes', () => ({
   getSchemes: jest.fn()
 }))
 
-const { getSchemes } = require('../../app/get-schemes')
-const { getSchemeIdFromPillar } = require('../../app/get-scheme-id-from-pillar')
+const { getSchemes } = require('../../../app/scheme-properties/get-schemes')
+const { getSchemeIdFromPillar } = require('../../../app/scheme-id/get-scheme-id-from-pillar')
 
 describe('getSchemeIdFromPillar', () => {
   beforeEach(() => {

package/test/unit/{get-scheme-id-from-source-system.test.js → scheme-id/get-scheme-id-from-source-system.test.js}

@@ -1,9 +1,9 @@
-jest.mock('../../app/get-schemes', () => ({
+jest.mock('../../../app/scheme-properties/get-schemes', () => ({
   getSchemes: jest.fn()
 }))
 
-const { getSchemes } = require('../../app/get-schemes')
-const { getSchemeIdFromSourceSystem } = require('../../app/get-scheme-id-from-source-system')
+const { getSchemes } = require('../../../app/scheme-properties/get-schemes')
+const { getSchemeIdFromSourceSystem } = require('../../../app/scheme-id/get-scheme-id-from-source-system')
 
 describe('getSchemeIdFromSourceSystem', () => {
   beforeEach(() => {

package/test/unit/scheme-id/get-scheme-ids.test.js

@@ -0,0 +1,8 @@
+const { getSchemeIds } = require('../../../app/scheme-id/get-scheme-ids')
+const schemeIds = require('../../../app/constants/scheme-ids')
+
+describe('getSchemeIds', () => {
+  test('returns all scheme IDs', () => {
+    expect(getSchemeIds()).toEqual(schemeIds)
+  })
+})

package/test/unit/{get-scheme-name-from-scheme-id.test.js → scheme-name/get-scheme-name-from-scheme-id.test.js}

@@ -1,10 +1,10 @@
-jest.mock('../../app/get-schemes', () => ({
+jest.mock('../../../app/scheme-properties/get-schemes', () => ({
   getSchemes: jest.fn()
 }))
 
-const { getSchemes } = require('../../app/get-schemes')
-const { getSchemeNameFromSchemeId } = require('../../app/get-scheme-name-from-scheme-id')
-const { UNKNOWN } = require('../../app/constants/unknown')
+const { getSchemes } = require('../../../app/scheme-properties/get-schemes')
+const { getSchemeNameFromSchemeId } = require('../../../app/scheme-name/get-scheme-name-from-scheme-id')
+const { UNKNOWN } = require('../../../app/constants/unknown')
 
 describe('getSchemeNameFromSchemeId', () => {
   beforeEach(() => {

package/test/unit/scheme-name/get-scheme-names.test.js

@@ -0,0 +1,8 @@
+const { getSchemeNames } = require('../../../app/scheme-name/get-scheme-names')
+const schemeNames = require('../../../app/constants/scheme-names')
+
+describe('getSchemeNames', () => {
+  test('returns all scheme names', () => {
+    expect(getSchemeNames()).toEqual(schemeNames)
+  })
+})

package/test/unit/{get-scheme-batch-properties.test.js → scheme-properties/get-scheme-batch-properties.test.js}

@@ -1,5 +1,5 @@
-const { getSchemeBatchProperties } = require('../../app/get-scheme-batch-properties')
-const schemeBatchProperties = require('../../app/constants/scheme-batch-properties')
+const { getSchemeBatchProperties } = require('../../../app/scheme-properties/get-scheme-batch-properties')
+const schemeBatchProperties = require('../../../app/constants/scheme-batch-properties')
 
 describe('get scheme batch properties', () => {
   test.each(schemeBatchProperties)(

package/test/unit/{get-scheme-properties.test.js → scheme-properties/get-scheme-properties.test.js}

@@ -1,6 +1,6 @@
-const { getSchemeProperties } = require('../../app/get-scheme-properties')
-const schemes = require('../../app/constants/schemes')
-const { MANUAL } = require('../../app/constants/scheme-ids')
+const { getSchemeProperties } = require('../../../app/scheme-properties/get-scheme-properties')
+const schemes = require('../../../app/constants/schemes')
+const { MANUAL } = require('../../../app/constants/scheme-ids')
 
 describe('getSchemeProperties', () => {
   test.each(schemes)(

package/test/unit/{get-schemes.test.js → scheme-properties/get-schemes.test.js}

@@ -1,7 +1,8 @@
-const { getSchemes } = require('../../app/get-schemes')
-const schemeIds = require('../../app/constants/scheme-ids')
-const schemeNames = require('../../app/constants/scheme-names')
-const sourceSystems = require('../../app/constants/source-systems')
+const { getSchemes } = require('../../../app/scheme-properties/get-schemes')
+const pillars = require('../../../app/constants/pillars')
+const schemeIds = require('../../../app/constants/scheme-ids')
+const schemeNames = require('../../../app/constants/scheme-names')
+const sourceSystems = require('../../../app/constants/source-systems')
 
 describe('getSchemes', () => {
   test('returns all schemes with their IDs and names', () => {
@@ -9,7 +10,8 @@ describe('getSchemes', () => {
       Object.keys(schemeIds).map((schemeKey) => ({
         schemeId: schemeIds[schemeKey],
         schemeName: schemeNames[schemeKey],
-        sourceSystem: sourceSystems[schemeKey]
+        sourceSystem: sourceSystems[schemeKey],
+        pillar: pillars[schemeKey]
       }))
     )
   })
@@ -20,7 +22,8 @@ describe('getSchemes', () => {
       expect(getSchemes()).toContainEqual({
         schemeId: schemeIds[schemeKey],
         schemeName: schemeNames[schemeKey],
-        sourceSystem: sourceSystems[schemeKey]
+        sourceSystem: sourceSystems[schemeKey],
+        pillar: pillars[schemeKey]
       })
     }
   )

package/test/unit/{get-source-system-from-scheme-id.test.js → source-system/get-source-system-from-scheme-id.test.js}

@@ -1,10 +1,10 @@
-jest.mock('../../app/get-schemes', () => ({
+jest.mock('../../../app/scheme-properties/get-schemes', () => ({
   getSchemes: jest.fn()
 }))
 
-const { UNKNOWN } = require('../../app/constants/unknown')
-const { getSchemes } = require('../../app/get-schemes')
-const { getSourceSystemFromSchemeId } = require('../../app/get-source-system-from-scheme-id')
+const { UNKNOWN } = require('../../../app/constants/unknown')
+const { getSchemes } = require('../../../app/scheme-properties/get-schemes')
+const { getSourceSystemFromSchemeId } = require('../../../app/source-system/get-source-system-from-scheme-id')
 
 describe('getSourceSystemFromSchemeId', () => {
   beforeEach(() => {

package/test/unit/source-system/get-source-systems.test.js

@@ -0,0 +1,8 @@
+const { getSourceSystems } = require('../../../app/source-system/get-source-systems')
+const sourceSystems = require('../../../app/constants/source-systems')
+
+describe('getSourceSystems', () => {
+  test('returns all source systems', () => {
+    expect(getSourceSystems()).toEqual(sourceSystems)
+  })
+})