ffc-pay-schemes 1.0.12 → 1.0.14

package/README.md

@@ -17,8 +17,11 @@ const {
   createInvoiceNumber,
   createSplitInvoiceNumber,
   getAccountCodeMap,
+  getBatchSequenceFromFileName,
+  getJournalSourceFromPillar,
   getReportingDataFilter,
   getSchemeBatchProperties,
+  getSchemeFromBatchFileName,
   getSchemeIdFromPillar,
   getSchemeIdFromSourceSystem,
   getSchemeIds,
@@ -39,8 +42,11 @@ 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`.
+- `getBatchSequenceFromFileName(schemeId, fileName)` returns the sequence as identified in the supplied `fileName`, checking the correct position using the `schemeId`.
+- `getJournalSourceFromPillar(schemeId, source, pillar)` returns the appropriate manual source used in Payment journals for manual schemes, based on the supplied `pillar`. If `schemeId` is not the MANUAL scheme, or a match is not found, the supplied `source` will be returned.
 - `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`.
+- `getSchemeFromBatchFileName(fileName)` returns the supported scheme details based on the expected file mask matching the supplied `fileName`.
 - `getSchemeIdFromPillar(pillar)` returns the scheme ID for a given `pillar`.
 - `getSchemeIdFromSourceSystem(sourceSystem)` returns the scheme ID for a given `sourceSystem`.
 - `getSchemeIds()` returns all supported scheme IDs.
@@ -61,18 +67,20 @@ const {
 ```js
 const {
   getSchemes,
+  getSchemeIds,
   getSchemeProperties,
   schemeDoesNotRequirePPAs,
-  schemeProvidesAccountingValues,
-  schemeIds
+  schemeProvidesAccountingValues
 } = require('ffc-pay-schemes')
 
 const schemes = getSchemes()
 
-const scheme = getSchemeProperties(schemeIds.BPS)
+const { BPS } = getSchemeIds()
+
+const scheme = getSchemeProperties(BPS)
 
-const doesNotRequirePPAs = schemeDoesNotRequirePPAs(schemeIds.BPS)
-const providesAccountingValues = schemeProvidesAccountingValues(schemeIds.BPS)
+const doesNotRequirePPAs = schemeDoesNotRequirePPAs(BPS)
+const providesAccountingValues = schemeProvidesAccountingValues(BPS)
 ```
 
 ## Payment Hub usage
@@ -81,7 +89,6 @@ The following services are intended to be used with the ffc-pay-schemes package:
 
 - ffc-pay-alerting
 - ffc-pay-batch-processor
-- ffc-pay-dps
 - ffc-pay-enrichment
 - ffc-pay-event-hub
 - ffc-pay-gateway
@@ -91,7 +98,6 @@ The following services are intended to be used with the ffc-pay-schemes package:
 - ffc-pay-submission
 - ffc-pay-tracking
 - ffc-pay-web
-- ffc-pay-xb
 
 In the event a new payment scheme is added to the package, all of the above services must be bumped to the latest package version to ensure that Payment Hub can process associated payments.
 

package/app/constants/file-masks.js

@@ -0,0 +1,14 @@
+module.exports = {
+  SFI: /^SITISFI\d{4}_AP_\d*.dat$/,
+  SFI_PILOT: /^SITIELM\d{4}_AP_\d*.dat$/,
+  LUMP_SUMS: /^SITILSES\d{4}_AP_\d*.dat$/,
+  CS: /^SITICS\d{4}_AP_\d*.dat$/,
+  BPS: /^SITI_\d{4}_AP_\d*.dat$/,
+  ES: /^GENESISPayReq_\d{8}_\d{4}.gne$/,
+  FC: /^FCAP_\d{4}_\d*\.dat$/,
+  IMPS: /^FIN_IMPS_A[P|R]_\d*.INT$/,
+  SFI23: /^SITISFIA\d{4}_AP_\d*.dat$/,
+  DELINKED: /^SITIDP\d{4}_AP_\d*.dat$/,
+  SFI_EXPANDED: /^ESFIO\d{4}_AP_\d*.dat$/,
+  COHT_CAPITAL: /^SITICOHTC\d{4}_AP_\d*.dat$/
+}

package/app/constants/manual-sources.js

@@ -0,0 +1,79 @@
+const {
+  DA,
+  IP,
+  SPS,
+  DF,
+  FCCS,
+  XG,
+  TR,
+  RDPECS,
+  RDPELS,
+  BK,
+  INT,
+  OPA,
+  NELS,
+  FCLS,
+  RDTLS,
+  NECS,
+  RDTCP,
+  P1,
+  EA,
+  RDTEXQ,
+  EXNRDPE,
+  SFI,
+  SFI_PILOT,
+  LUMP_SUMS,
+  VET_VISITS,
+  CS,
+  BPS,
+  ES,
+  FC,
+  IMPS,
+  SFI23,
+  DELINKED,
+  SFI_EXPANDED,
+  COHT_CAPITAL,
+  COHT_REVENUE,
+  FPTT,
+  WMP
+} = require('./pillars')
+
+module.exports = {
+  [DA]: 'NMAN_DA',
+  [IP]: 'NMAN_IP',
+  [SPS]: 'NMAN_SPS',
+  [DF]: 'NMAN_DF',
+  [FCCS]: 'NMAN_FC',
+  [XG]: 'NMAN_XG',
+  [TR]: 'NMAN_TR',
+  [RDPECS]: 'NMAN_RDPE',
+  [RDPELS]: 'NMAN_RDPE',
+  [BK]: 'NMAN_BK',
+  [INT]: 'NMAN_INT',
+  [OPA]: 'NMAN_OPA',
+  [NELS]: 'NMAN_NELS',
+  [FCLS]: 'NMAN_FCLS',
+  [RDTLS]: 'NMAN_RDT',
+  [NECS]: 'NMAN_NE',
+  [RDTCP]: 'NMAN_RDT',
+  [P1]: 'NMAN_NE',
+  [EA]: 'NMAN_EA',
+  [RDTEXQ]: 'NMAN_RDT',
+  [EXNRDPE]: 'NMAN_RDT',
+  [SFI]: 'PMAN_SFI',
+  [SFI_PILOT]: 'PMAN_SFIP',
+  [LUMP_SUMS]: 'NMAN_DA',
+  [VET_VISITS]: 'NMAN_DA',
+  [CS]: 'PMAN_CS',
+  [BPS]: 'NMAN_DA',
+  [ES]: 'NMAN_DA',
+  [FC]: 'NMAN_DA',
+  [IMPS]: 'NMAN_DA',
+  [SFI23]: 'PMAN_SFIA',
+  [DELINKED]: 'PMAN_DP',
+  [SFI_EXPANDED]: 'PMAN_ESFIO',
+  [COHT_CAPITAL]: 'PMAN_COHTC',
+  [COHT_REVENUE]: 'PMAN_COHTR',
+  [FPTT]: 'PMAN_FPTT',
+  [WMP]: 'PMAN_WMP'
+}

package/app/constants/pillars.js

@@ -1,4 +1,25 @@
 module.exports = {
+  DA: 'DA',
+  IP: 'IP',
+  SPS: 'SPS',
+  DF: 'DF',
+  FCCS: 'FCCS',
+  XG: 'XG',
+  TR: 'TR',
+  RDPECS: 'RDPECS',
+  RDPELS: 'RDPELS',
+  BK: 'BK',
+  INT: 'INT',
+  OPA: 'OPA',
+  NELS: 'NELS',
+  FCLS: 'FCLS',
+  RDTLS: 'RDTLS',
+  NECS: 'NECS',
+  RDTCP: 'RDTCP',
+  P1: 'P1',
+  EA: 'EA',
+  RDTEXQ: 'RDTEXQ',
+  EXNRDPE: 'ExNRDPE',
   SFI: 'SFI',
   SFI_PILOT: 'SFIP',
   LUMP_SUMS: 'LSES',

package/app/constants/schemes.js

@@ -1,6 +1,7 @@
+const fileMasks = require('./file-masks')
+const pillars = require('./pillars')
 const schemeIds = require('./scheme-ids')
 const sourceSystems = require('./source-systems')
-const pillars = require('./pillars')
 const { RP00, NE00, FC00, RP10 } = require('./delivery-bodies')
 const { DRD10, DOM10, ERD14, EGF00, EXQ00, DOM00 } = require('./fund-codes')
 
@@ -10,21 +11,24 @@ module.exports = Object.freeze([
     sourceSystem: sourceSystems.SFI,
     pillar: pillars.SFI,
     deliveryBody: RP00,
-    fundCode: DRD10
+    fundCode: DRD10,
+    fileMask: fileMasks.SFI
   },
   {
     schemeId: schemeIds.SFI_PILOT,
     sourceSystem: sourceSystems.SFI_PILOT,
     pillar: pillars.SFI_PILOT,
     deliveryBody: RP00,
-    fundCode: DRD10
+    fundCode: DRD10,
+    fileMask: fileMasks.SFI_PILOT
   },
   {
     schemeId: schemeIds.LUMP_SUMS,
     sourceSystem: sourceSystems.LUMP_SUMS,
     pillar: pillars.LUMP_SUMS,
     deliveryBody: RP00,
-    fundCode: DOM10
+    fundCode: DOM10,
+    fileMask: fileMasks.LUMP_SUMS
   },
   {
     schemeId: schemeIds.VET_VISITS,
@@ -38,14 +42,16 @@ module.exports = Object.freeze([
     sourceSystem: sourceSystems.CS,
     pillar: pillars.CS,
     deliveryBody: NE00,
-    fundCode: ERD14
+    fundCode: ERD14,
+    fileMask: fileMasks.CS
   },
   {
     schemeId: schemeIds.BPS,
     sourceSystem: sourceSystems.BPS,
     pillar: pillars.BPS,
     deliveryBody: RP00,
-    fundCode: EGF00
+    fundCode: EGF00,
+    fileMask: fileMasks.BPS
   },
   {
     schemeId: schemeIds.MANUAL,
@@ -59,42 +65,48 @@ module.exports = Object.freeze([
     sourceSystem: sourceSystems.ES,
     pillar: pillars.ES,
     deliveryBody: NE00,
-    fundCode: EXQ00
+    fundCode: EXQ00,
+    fileMask: fileMasks.ES
   },
   {
     schemeId: schemeIds.FC,
     sourceSystem: sourceSystems.FC,
     pillar: pillars.FC,
     deliveryBody: FC00,
-    fundCode: DOM00
+    fundCode: DOM00,
+    fileMask: fileMasks.FC
   },
   {
     schemeId: schemeIds.IMPS,
     sourceSystem: sourceSystems.IMPS,
     pillar: pillars.IMPS,
     deliveryBody: RP00,
-    fundCode: DOM00
+    fundCode: DOM00,
+    fileMask: fileMasks.IMPS
   },
   {
     schemeId: schemeIds.SFI23,
     sourceSystem: sourceSystems.SFI23,
     pillar: pillars.SFI23,
     deliveryBody: RP00,
-    fundCode: DRD10
+    fundCode: DRD10,
+    fileMask: fileMasks.SFI23
   },
   {
     schemeId: schemeIds.DELINKED,
     sourceSystem: sourceSystems.DELINKED,
     pillar: pillars.DELINKED,
     deliveryBody: RP00,
-    fundCode: DOM10
+    fundCode: DOM10,
+    fileMask: fileMasks.DELINKED
   },
   {
     schemeId: schemeIds.SFI_EXPANDED,
     sourceSystem: sourceSystems.SFI_EXPANDED,
     pillar: pillars.SFI_EXPANDED,
     deliveryBody: RP00,
-    fundCode: DRD10
+    fundCode: DRD10,
+    fileMask: fileMasks.SFI_EXPANDED
   },
   {
     schemeId: schemeIds.COHT_REVENUE,
@@ -108,7 +120,8 @@ module.exports = Object.freeze([
     sourceSystem: sourceSystems.COHT_CAPITAL,
     pillar: pillars.COHT_CAPITAL,
     deliveryBody: RP00,
-    fundCode: DRD10
+    fundCode: DRD10,
+    fileMask: fileMasks.COHT_CAPITAL
   },
   {
     schemeId: schemeIds.FPTT,

package/app/constants/sequence-positions.js

@@ -0,0 +1,13 @@
+module.exports = {
+  SFI: 7,
+  SFI_PILOT: 7,
+  LUMP_SUMS: 8,
+  CS: 6,
+  BPS: 5,
+  ES: 23,
+  FC: 5,
+  SFI23: 8,
+  DELINKED: 6,
+  SFI_EXPANDED: 5,
+  COHT_CAPITAL: 9
+}

package/app/helpers/get-batch-sequence-from-file-name.js

@@ -0,0 +1,34 @@
+const schemeIds = require('../constants/scheme-ids')
+const sequencePositions = require('../constants/sequence-positions')
+
+const SEQUENCE_LENGTH = 4
+const IMPS_OFFSET = 1
+
+const getBatchSequenceFromFileName = (schemeId, fileName) => {
+  if (schemeId === schemeIds.IMPS) {
+    return Number(fileName.substring(
+      fileName.lastIndexOf('_') + IMPS_OFFSET,
+      fileName.lastIndexOf('.')
+    ))
+  }
+
+  const schemeEntry = Object.entries(schemeIds)
+    .find(([, id]) => id === schemeId)
+
+  if (!schemeEntry) {
+    throw new Error(`Unknown schemeId: ${schemeId}`)
+  }
+
+  const [schemeName] = schemeEntry
+  const sequenceStart = sequencePositions[schemeName]
+
+  if (sequenceStart === undefined) {
+    throw new Error(`No sequence position found for schemeId: ${schemeId}`)
+  }
+
+  return Number(fileName.substr(sequenceStart, SEQUENCE_LENGTH))
+}
+
+module.exports = {
+  getBatchSequenceFromFileName
+}

package/app/helpers/get-journal-source-from-pillar.js

@@ -0,0 +1,15 @@
+const { MANUAL } = require('../constants/scheme-ids')
+const manualSources = require('../constants/manual-sources')
+
+const getJournalSourceFromPillar = (schemeId, source, pillar) => {
+  if (schemeId !== MANUAL) {
+    return source
+  }
+
+  const manualSource = manualSources[pillar]
+  return manualSource ?? source
+}
+
+module.exports = {
+  getJournalSourceFromPillar
+}

package/app/scheme-properties/get-scheme-from-batch-file-name.js

@@ -0,0 +1,11 @@
+const schemes = require('../constants/schemes')
+
+const getSchemeFromBatchFileName = (fileName) => {
+  return schemes.find(scheme =>
+    scheme.fileMask?.test(fileName)
+  )
+}
+
+module.exports = {
+  getSchemeFromBatchFileName
+}

package/index.js

@@ -1,8 +1,11 @@
 const { createInvoiceNumber } = require('./app/create-invoice-number')
 const { createSplitInvoiceNumber } = require('./app/create-split-invoice-number')
 const { getAccountCodeMap } = require('./app/get-account-code-map')
+const { getBatchSequenceFromFileName } = require('./app/helpers/get-batch-sequence-from-file-name')
+const { getJournalSourceFromPillar } = require('./app/helpers/get-journal-source-from-pillar')
 const { getReportingDataFilter } = require('./app/helpers/get-reporting-data-filter')
 const { getSchemeBatchProperties } = require('./app/scheme-properties/get-scheme-batch-properties')
+const { getSchemeFromBatchFileName } = require('./app/scheme-properties/get-scheme-from-batch-file-name')
 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')
@@ -22,8 +25,11 @@ module.exports = {
   createInvoiceNumber,
   createSplitInvoiceNumber,
   getAccountCodeMap,
+  getBatchSequenceFromFileName,
+  getJournalSourceFromPillar,
   getReportingDataFilter,
   getSchemeBatchProperties,
+  getSchemeFromBatchFileName,
   getSchemeIdFromPillar,
   getSchemeIdFromSourceSystem,
   getSchemeIds,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ffc-pay-schemes",
-  "version": "1.0.12",
+  "version": "1.0.14",
   "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-batch-sequence-from-file-name.test.js

@@ -0,0 +1,55 @@
+jest.mock('../../../app/constants/scheme-ids', () => ({
+  SFI: 1,
+  IMPS: 11,
+  FPTT: 18
+}))
+
+jest.mock('../../../app/constants/sequence-positions', () => ({
+  SFI: 6
+}))
+
+const {
+  getBatchSequenceFromFileName
+} = require('../../../app/helpers/get-batch-sequence-from-file-name')
+
+const schemeIds = require('../../../app/constants/scheme-ids')
+
+describe('getBatchSequenceFromFileName', () => {
+  test('returns the sequence using the scheme sequence position', () => {
+    const fileName = 'prefix12345678.csv'
+
+    expect(
+      getBatchSequenceFromFileName(schemeIds.SFI, fileName)
+    ).toBe(1234)
+  })
+
+  test('returns the IMPS sequence between the final underscore and dot', () => {
+    expect(
+      getBatchSequenceFromFileName(schemeIds.IMPS, 'IMPS_batch_5678.csv')
+    ).toBe(5678)
+  })
+
+  test('uses the final underscore for IMPS filenames', () => {
+    expect(
+      getBatchSequenceFromFileName(
+        schemeIds.IMPS,
+        'IMPS_batch_previous_4321.csv'
+      )
+    ).toBe(4321)
+  })
+
+  test('throws when the scheme ID is unknown', () => {
+    expect(() =>
+      getBatchSequenceFromFileName(1000, 'filename.csv')
+    ).toThrow('Unknown schemeId: 1000')
+  })
+
+  test('throws when the scheme has no sequence position', () => {
+    expect(() =>
+      getBatchSequenceFromFileName(
+        schemeIds.FPTT,
+        'filename.csv'
+      )
+    ).toThrow(`No sequence position found for schemeId: ${schemeIds.FPTT}`)
+  })
+})

package/test/unit/helpers/get-journal-source-from-pillar.test.js

@@ -0,0 +1,25 @@
+const { MANUAL, SFI } = require('../../../app/constants/scheme-ids')
+const { DA, SFI: SFI_PILLAR } = require('../../../app/constants/pillars')
+const manualSources = require('../../../app/constants/manual-sources')
+const { getJournalSourceFromPillar } = require('../../../app/helpers/get-journal-source-from-pillar')
+
+describe('getJournalSourceFromPillar', () => {
+  test('returns the source for non-manual schemes', () => {
+    expect(getJournalSourceFromPillar(SFI, 'SOURCE', DA)).toBe('SOURCE')
+  })
+
+  test('returns the manual source for a matching pillar', () => {
+    expect(getJournalSourceFromPillar(MANUAL, 'SOURCE', DA))
+      .toBe(manualSources[DA])
+  })
+
+  test('returns the manual source for the SFI pillar', () => {
+    expect(getJournalSourceFromPillar(MANUAL, 'SOURCE', SFI_PILLAR))
+      .toBe(manualSources[SFI_PILLAR])
+  })
+
+  test('returns the original source when the pillar has no manual source', () => {
+    expect(getJournalSourceFromPillar(MANUAL, 'SOURCE', 'UNKNOWN'))
+      .toBe('SOURCE')
+  })
+})

package/test/unit/scheme-properties/get-scheme-from-batch-file-name.test.js

@@ -0,0 +1,51 @@
+jest.mock('../../../app/constants/schemes', () => [
+  {
+    schemeId: 1,
+    fileMask: {
+      test: jest.fn((fileName) => fileName === 'sfi-batch.csv')
+    }
+  },
+  {
+    schemeId: 2,
+    fileMask: {
+      test: jest.fn((fileName) => fileName === 'pilot-batch.csv')
+    }
+  },
+  {
+    schemeId: 3
+  }
+])
+
+const schemes = require('../../../app/constants/schemes')
+const {
+  getSchemeFromBatchFileName
+} = require('../../../app/scheme-properties/get-scheme-from-batch-file-name')
+
+describe('getSchemeFromBatchFileName', () => {
+  test('returns the first matching scheme', () => {
+    expect(
+      getSchemeFromBatchFileName('pilot-batch.csv')
+    ).toBe(schemes[1])
+  })
+
+  test('skips schemes without a file mask', () => {
+    expect(
+      getSchemeFromBatchFileName('unknown-batch.csv')
+    ).toBeUndefined()
+
+    expect(schemes[0].fileMask.test).toHaveBeenCalledWith('unknown-batch.csv')
+    expect(schemes[1].fileMask.test).toHaveBeenCalledWith('unknown-batch.csv')
+  })
+
+  test('returns undefined when no file mask matches', () => {
+    expect(
+      getSchemeFromBatchFileName('unknown-batch.csv')
+    ).toBeUndefined()
+  })
+
+  test('stops checking after finding a match', () => {
+    getSchemeFromBatchFileName('sfi-batch.csv')
+
+    expect(schemes[1].fileMask.test).not.toHaveBeenCalledWith('sfi-batch.csv')
+  })
+})