ffc-pay-schemes 1.0.13 → 1.0.15

package/README.md

@@ -18,6 +18,9 @@ const {
   createSplitInvoiceNumber,
   getAccountCodeMap,
   getBatchSequenceFromFileName,
+  getJournalSourceFromPillar,
+  getPillarFromSchemeId,
+  getPillars,
   getReportingDataFilter,
   getSchemeBatchProperties,
   getSchemeFromBatchFileName,
@@ -42,6 +45,9 @@ const {
 - `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.
+- `getPillarFromSchemeId(schemeId)` returns the pillar name for a given `schemeId`.
+- `getPillars()` returns all supported pillars.
 - `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`.
@@ -65,18 +71,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
@@ -85,7 +93,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
@@ -95,7 +102,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/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/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/pillar/get-pillar-from-scheme-id.js

@@ -0,0 +1,11 @@
+const { UNKNOWN } = require('../constants/unknown')
+const { getSchemes } = require('../scheme-properties/get-schemes')
+
+const getPillarFromSchemeId = (schemeId) => {
+  const matchingScheme = getSchemes().find((scheme) => scheme.schemeId === schemeId)
+  return matchingScheme?.pillar ?? UNKNOWN
+}
+
+module.exports = {
+  getPillarFromSchemeId
+}

package/app/pillar/get-pillars.js

@@ -0,0 +1,9 @@
+const pillars = require('../constants/pillars')
+
+const getPillars = () => {
+  return pillars
+}
+
+module.exports = {
+  getPillars
+}

package/index.js

@@ -2,6 +2,9 @@ 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 { getPillarFromSchemeId } = require('./app/pillar/get-pillar-from-scheme-id')
+const { getPillars } = require('./app/pillar/get-pillars')
 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')
@@ -25,6 +28,9 @@ module.exports = {
   createSplitInvoiceNumber,
   getAccountCodeMap,
   getBatchSequenceFromFileName,
+  getJournalSourceFromPillar,
+  getPillarFromSchemeId,
+  getPillars,
   getReportingDataFilter,
   getSchemeBatchProperties,
   getSchemeFromBatchFileName,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ffc-pay-schemes",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "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-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/pillar/get-pillar-from-scheme-id.test.js

@@ -0,0 +1,51 @@
+jest.mock('../../../app/scheme-properties/get-schemes', () => ({
+  getSchemes: jest.fn()
+}))
+
+const { UNKNOWN } = require('../../../app/constants/unknown')
+const { getSchemes } = require('../../../app/scheme-properties/get-schemes')
+const { getPillarFromSchemeId } = require('../../../app/pillar/get-pillar-from-scheme-id')
+
+describe('getPillarFromSchemeId', () => {
+  beforeEach(() => {
+    jest.clearAllMocks()
+  })
+
+  test('returns the pillar for a matching scheme ID', () => {
+    getSchemes.mockReturnValue([
+      {
+        schemeId: 1,
+        schemeName: 'Example Scheme',
+        pillar: 'Example Pillar'
+      }
+    ])
+
+    expect(getPillarFromSchemeId(1)).toBe('Example Pillar')
+  })
+
+  test('returns unknown when the scheme ID is not found', () => {
+    getSchemes.mockReturnValue([
+      {
+        schemeId: 1,
+        schemeName: 'Example Scheme',
+        pillar: 'Example Pillar'
+      }
+    ])
+
+    expect(getPillarFromSchemeId(2)).toBe(UNKNOWN)
+  })
+
+  test('returns unknown when no schemes are available', () => {
+    getSchemes.mockReturnValue([])
+
+    expect(getPillarFromSchemeId(2)).toBe(UNKNOWN)
+  })
+
+  test('gets schemes before searching for the pillar', () => {
+    getSchemes.mockReturnValue([])
+
+    getPillarFromSchemeId(2)
+
+    expect(getSchemes).toHaveBeenCalledTimes(1)
+  })
+})

package/test/unit/pillar/get-pillars.test.js

@@ -0,0 +1,8 @@
+const { getPillars } = require('../../../app/pillar/get-pillars')
+const pillars = require('../../../app/constants/pillars')
+
+describe('getPillars', () => {
+  test('returns all pillars', () => {
+    expect(getPillars()).toEqual(pillars)
+  })
+})

package/test-output/cobertura-coverage.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" ?>
 <!DOCTYPE coverage SYSTEM "http://cobertura.sourceforge.net/xml/coverage-04.dtd">
-<coverage lines-valid="303" lines-covered="280" line-rate="0.924" branches-valid="61" branches-covered="61" branch-rate="1" timestamp="1788866911565" complexity="0" version="0.1">
+<coverage lines-valid="326" lines-covered="300" line-rate="0.9201999999999999" branches-valid="67" branches-covered="67" branch-rate="1" timestamp="1789392577997" complexity="0" version="0.1">
   <sources>
     <source>/home/samplackett/ffc-pay-schemes</source>
   </sources>
@@ -32,12 +32,15 @@
             <line number="19" hits="0" branch="false"/>
             <line number="20" hits="0" branch="false"/>
             <line number="21" hits="0" branch="false"/>
+            <line number="22" hits="0" branch="false"/>
             <line number="23" hits="0" branch="false"/>
+            <line number="24" hits="0" branch="false"/>
+            <line number="26" hits="0" branch="false"/>
           </lines>
         </class>
       </classes>
     </package>
-    <package name="ffc-pay-schemes.app.constants" line-rate="0.9629000000000001" branch-rate="1">
+    <package name="ffc-pay-schemes.app.constants" line-rate="0.9655" branch-rate="1">
       <classes>
         <class name="delivery-bodies.js" filename="app/constants/delivery-bodies.js" line-rate="1" branch-rate="1">
           <methods>
@@ -75,11 +78,19 @@
             <line number="1" hits="1" branch="false"/>
           </lines>
         </class>
+        <class name="manual-sources.js" filename="app/constants/manual-sources.js" line-rate="1" branch-rate="1">
+          <methods>
+          </methods>
+          <lines>
+            <line number="39" hits="1" branch="false"/>
+            <line number="41" hits="1" branch="false"/>
+          </lines>
+        </class>
         <class name="pillars.js" filename="app/constants/pillars.js" line-rate="1" branch-rate="1">
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="2" branch="false"/>
+            <line number="1" hits="4" branch="false"/>
           </lines>
         </class>
         <class name="scheme-batch-properties.js" filename="app/constants/scheme-batch-properties.js" line-rate="1" branch-rate="1">
@@ -94,7 +105,7 @@
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="12" branch="false"/>
+            <line number="1" hits="13" branch="false"/>
           </lines>
         </class>
         <class name="scheme-names.js" filename="app/constants/scheme-names.js" line-rate="1" branch-rate="1">
@@ -159,7 +170,7 @@
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="2" branch="false"/>
+            <line number="1" hits="3" branch="false"/>
           </lines>
         </class>
       </classes>
@@ -543,6 +554,25 @@
             <line number="32" hits="1" branch="false"/>
           </lines>
         </class>
+        <class name="get-journal-source-from-pillar.js" filename="app/helpers/get-journal-source-from-pillar.js" line-rate="1" branch-rate="1">
+          <methods>
+            <method name="(anonymous_0)" hits="4" signature="()V">
+              <lines>
+                <line number="4" hits="4"/>
+              </lines>
+            </method>
+          </methods>
+          <lines>
+            <line number="1" hits="1" branch="false"/>
+            <line number="2" hits="1" branch="false"/>
+            <line number="4" hits="1" branch="false"/>
+            <line number="5" hits="4" branch="true" condition-coverage="100% (2/2)"/>
+            <line number="6" hits="1" branch="false"/>
+            <line number="9" hits="3" branch="false"/>
+            <line number="10" hits="3" branch="true" condition-coverage="100% (2/2)"/>
+            <line number="13" hits="1" branch="false"/>
+          </lines>
+        </class>
         <class name="get-reporting-data-filter.js" filename="app/helpers/get-reporting-data-filter.js" line-rate="1" branch-rate="1">
           <methods>
             <method name="(anonymous_0)" hits="5" signature="()V">
@@ -643,6 +673,47 @@
         </class>
       </classes>
     </package>
+    <package name="ffc-pay-schemes.app.pillar" line-rate="1" branch-rate="1">
+      <classes>
+        <class name="get-pillar-from-scheme-id.js" filename="app/pillar/get-pillar-from-scheme-id.js" line-rate="1" branch-rate="1">
+          <methods>
+            <method name="(anonymous_0)" hits="4" signature="()V">
+              <lines>
+                <line number="4" hits="4"/>
+              </lines>
+            </method>
+            <method name="(anonymous_1)" hits="2" signature="()V">
+              <lines>
+                <line number="5" hits="2"/>
+              </lines>
+            </method>
+          </methods>
+          <lines>
+            <line number="1" hits="1" branch="false"/>
+            <line number="2" hits="1" branch="false"/>
+            <line number="4" hits="1" branch="false"/>
+            <line number="5" hits="4" branch="false"/>
+            <line number="6" hits="4" branch="true" condition-coverage="100% (2/2)"/>
+            <line number="9" hits="1" branch="false"/>
+          </lines>
+        </class>
+        <class name="get-pillars.js" filename="app/pillar/get-pillars.js" line-rate="1" branch-rate="1">
+          <methods>
+            <method name="(anonymous_0)" hits="1" signature="()V">
+              <lines>
+                <line number="3" hits="1"/>
+              </lines>
+            </method>
+          </methods>
+          <lines>
+            <line number="1" hits="1" branch="false"/>
+            <line number="3" hits="1" branch="false"/>
+            <line number="4" hits="1" branch="false"/>
+            <line number="7" hits="1" branch="false"/>
+          </lines>
+        </class>
+      </classes>
+    </package>
     <package name="ffc-pay-schemes.app.scheme-id" line-rate="1" branch-rate="1">
       <classes>
         <class name="get-scheme-id-from-pillar.js" filename="app/scheme-id/get-scheme-id-from-pillar.js" line-rate="1" branch-rate="1">