ffc-pay-schemes 1.0.14 → 1.0.15

package/README.md

@@ -19,6 +19,8 @@ const {
   getAccountCodeMap,
   getBatchSequenceFromFileName,
   getJournalSourceFromPillar,
+  getPillarFromSchemeId,
+  getPillars,
   getReportingDataFilter,
   getSchemeBatchProperties,
   getSchemeFromBatchFileName,
@@ -44,6 +46,8 @@ const {
 - `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`.

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

@@ -3,6 +3,8 @@ 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')
@@ -27,6 +29,8 @@ module.exports = {
   getAccountCodeMap,
   getBatchSequenceFromFileName,
   getJournalSourceFromPillar,
+  getPillarFromSchemeId,
+  getPillars,
   getReportingDataFilter,
   getSchemeBatchProperties,
   getSchemeFromBatchFileName,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ffc-pay-schemes",
-  "version": "1.0.14",
+  "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/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="314" lines-covered="290" line-rate="0.9235" branches-valid="65" branches-covered="65" branch-rate="1" timestamp="1789380885826" 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>
@@ -33,7 +33,9 @@
             <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>
@@ -88,7 +90,7 @@
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="3" 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">
@@ -168,7 +170,7 @@
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="2" branch="false"/>
+            <line number="1" hits="3" branch="false"/>
           </lines>
         </class>
       </classes>
@@ -671,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">