ffc-pay-schemes 1.0.6 → 1.0.8

package/README.md

@@ -18,6 +18,7 @@ const {
   createSplitInvoiceNumber,
   getAccountCodeMap,
   getSchemeBatchProperties,
+  getSchemeIdFromPillar,
   getSchemeIdFromSourceSystem,
   getSchemeIds,
   getSchemeNameFromSchemeId,
@@ -26,6 +27,7 @@ const {
   getSchemes,
   getSourceSystemFromSchemeId,
   getSourceSystems,
+  isValidSchemeId,
   schemeDoesNotRequirePPAs,
   schemeProvidesAccountingValues
 } = require('ffc-pay-schemes')
@@ -35,6 +37,7 @@ const {
 - `createSplitInvoiceNumber(paymentRequest)` creates a split invoice number for a given `paymentRequest`.
 - `getAccountCodeMap(schemeId)` returns the account code mapping used 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`.
 - `getSchemeIds()` returns all supported scheme IDs.
 - `getSchemeNameFromSchemeId(schemeId)` returns the scheme name for a given `schemeId`.
@@ -43,6 +46,7 @@ const {
 - `getSchemes()` returns all supported schemes as an array of objects containing `schemeId`, `schemeName` and `sourceSystem`.
 - `getSourceSystemFromSchemeId(schemeId)` returns the source system name for a given `schemeId`.
 - `getSourceSystems()` returns all supported source systems.
+- `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/pillars.js

@@ -5,6 +5,7 @@ module.exports = {
   VET_VISITS: 'AHWR',
   CS: 'CS',
   BPS: 'BPS',
+  MANUAL: 'Manual',
   ES: 'ES',
   FC: 'FC',
   IMPS: 'IMPS',

package/app/constants/schemes.js

@@ -50,7 +50,7 @@ module.exports = Object.freeze([
   {
     schemeId: schemeIds.MANUAL,
     sourceSystem: sourceSystems.MANUAL,
-    pillar: null,
+    pillar: pillars.MANUAL,
     deliveryBody: RP00,
     fundCode: DRD10
   },

package/app/get-scheme-id-from-pillar.js

@@ -0,0 +1,10 @@
+const { getSchemes } = require('./get-schemes')
+
+const getSchemeIdFromPillar = (pillar) => {
+  const matchingScheme = getSchemes().find((scheme) => scheme.pillar === pillar)
+  return matchingScheme?.schemeId
+}
+
+module.exports = {
+  getSchemeIdFromPillar
+}

package/app/is-valid-scheme-id.js

@@ -0,0 +1,10 @@
+const schemeIds = require('./constants/scheme-ids')
+
+const isValidSchemeId = (schemeId) => {
+  const numericSchemeId = Number(schemeId)
+  return Object.values(schemeIds).includes(numericSchemeId)
+}
+
+module.exports = {
+  isValidSchemeId
+}

package/index.js

@@ -2,6 +2,7 @@ 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')
@@ -10,6 +11,7 @@ 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')
 
@@ -18,6 +20,7 @@ module.exports = {
   createSplitInvoiceNumber,
   getAccountCodeMap,
   getSchemeBatchProperties,
+  getSchemeIdFromPillar,
   getSchemeIdFromSourceSystem,
   getSchemeIds,
   getSchemeNameFromSchemeId,
@@ -26,6 +29,7 @@ module.exports = {
   getSchemes,
   getSourceSystemFromSchemeId,
   getSourceSystems,
+  isValidSchemeId,
   schemeDoesNotRequirePPAs,
   schemeProvidesAccountingValues
 }

package/package.json

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

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

@@ -0,0 +1,52 @@
+jest.mock('../../app/get-schemes', () => ({
+  getSchemes: jest.fn()
+}))
+
+const { getSchemes } = require('../../app/get-schemes')
+const { getSchemeIdFromPillar } = require('../../app/get-scheme-id-from-pillar')
+
+describe('getSchemeIdFromPillar', () => {
+  beforeEach(() => {
+    jest.clearAllMocks()
+  })
+
+  test('returns the schemeId for a matching pillar', () => {
+    getSchemes.mockReturnValue([
+      {
+        schemeId: 1,
+        schemeName: 'Example Scheme',
+        sourceSystem: 'Example Source',
+        pillar: 'Example Pillar'
+      }
+    ])
+
+    expect(getSchemeIdFromPillar('Example Pillar')).toBe(1)
+  })
+
+  test('returns undefined when the pillar is not found', () => {
+    getSchemes.mockReturnValue([
+      {
+        schemeId: 1,
+        schemeName: 'Example Scheme',
+        sourceSystem: 'Example Source',
+        pillar: 'Example Pillar'
+      }
+    ])
+
+    expect(getSchemeIdFromPillar('Not a real pillar')).toBeUndefined()
+  })
+
+  test('returns undefined when no schemes are available', () => {
+    getSchemes.mockReturnValue([])
+
+    expect(getSchemeIdFromPillar('Not a real source')).toBeUndefined()
+  })
+
+  test('gets schemes before searching for the pillar', () => {
+    getSchemes.mockReturnValue([])
+
+    getSchemeIdFromPillar('Not a real source')
+
+    expect(getSchemes).toHaveBeenCalledTimes(1)
+  })
+})

package/test/unit/is-valid-scheme-id.test.js

@@ -0,0 +1,21 @@
+const schemeIds = require('../../app/constants/scheme-ids')
+const { isValidSchemeId } = require('../../app/is-valid-scheme-id')
+
+describe('isValidSchemeId', () => {
+  test.each(Object.values(schemeIds))(
+    'returns true for valid scheme ID: %i',
+    (schemeId) => {
+      expect(isValidSchemeId(schemeId)).toBe(true)
+    }
+  )
+
+  test('returns true for a valid scheme ID with surrounding whitespace', () => {
+    expect(isValidSchemeId(` ${schemeIds.SFI} `)).toBe(true)
+  })
+
+  test('returns false for a scheme ID not included in scheme IDs', () => {
+    const invalidSchemeId = Math.max(...Object.values(schemeIds)) + 1
+
+    expect(isValidSchemeId(invalidSchemeId)).toBe(false)
+  })
+})

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="236" lines-covered="221" line-rate="0.9364" branches-valid="52" branches-covered="52" branch-rate="1" timestamp="1787846748080" complexity="0" version="0.1">
+<coverage lines-valid="248" lines-covered="232" line-rate="0.9354" branches-valid="54" branches-covered="54" branch-rate="1" timestamp="1788366461643" complexity="0" version="0.1">
   <sources>
     <source>/home/samplackett/ffc-pay-schemes</source>
   </sources>
@@ -25,7 +25,8 @@
             <line number="12" hits="0" branch="false"/>
             <line number="13" hits="0" branch="false"/>
             <line number="14" hits="0" branch="false"/>
-            <line number="16" hits="0" branch="false"/>
+            <line number="15" hits="0" branch="false"/>
+            <line number="17" hits="0" branch="false"/>
           </lines>
         </class>
       </classes>
@@ -52,6 +53,27 @@
             <line number="7" hits="1" branch="false"/>
           </lines>
         </class>
+        <class name="get-scheme-id-from-pillar.js" filename="app/get-scheme-id-from-pillar.js" line-rate="1" branch-rate="1">
+          <methods>
+            <method name="(anonymous_0)" hits="4" signature="()V">
+              <lines>
+                <line number="3" hits="4"/>
+              </lines>
+            </method>
+            <method name="(anonymous_1)" hits="2" signature="()V">
+              <lines>
+                <line number="4" hits="2"/>
+              </lines>
+            </method>
+          </methods>
+          <lines>
+            <line number="1" hits="1" branch="false"/>
+            <line number="3" hits="1" branch="false"/>
+            <line number="4" hits="4" branch="false"/>
+            <line number="5" hits="4" branch="false"/>
+            <line number="8" hits="1" branch="false"/>
+          </lines>
+        </class>
         <class name="get-scheme-id-from-source-system.js" filename="app/get-scheme-id-from-source-system.js" line-rate="1" branch-rate="1">
           <methods>
             <method name="(anonymous_0)" hits="4" signature="()V">
@@ -191,21 +213,22 @@
           <methods>
             <method name="(anonymous_0)" hits="4" signature="()V">
               <lines>
-                <line number="3" hits="4"/>
+                <line number="4" hits="4"/>
               </lines>
             </method>
             <method name="(anonymous_1)" hits="2" signature="()V">
               <lines>
-                <line number="4" hits="2"/>
+                <line number="5" hits="2"/>
               </lines>
             </method>
           </methods>
           <lines>
             <line number="1" hits="1" branch="false"/>
-            <line number="3" hits="1" branch="false"/>
-            <line number="4" hits="4" 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="8" hits="1" 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-source-systems.js" filename="app/get-source-systems.js" line-rate="1" branch-rate="1">
@@ -223,6 +246,22 @@
             <line number="7" hits="1" branch="false"/>
           </lines>
         </class>
+        <class name="is-valid-scheme-id.js" filename="app/is-valid-scheme-id.js" line-rate="1" branch-rate="1">
+          <methods>
+            <method name="(anonymous_0)" hits="19" signature="()V">
+              <lines>
+                <line number="3" hits="19"/>
+              </lines>
+            </method>
+          </methods>
+          <lines>
+            <line number="1" hits="1" branch="false"/>
+            <line number="3" hits="1" branch="false"/>
+            <line number="4" hits="19" branch="false"/>
+            <line number="5" hits="19" branch="false"/>
+            <line number="8" hits="1" branch="false"/>
+          </lines>
+        </class>
         <class name="scheme-does-not-require-ppas.js" filename="app/scheme-does-not-require-ppas.js" line-rate="1" branch-rate="1">
           <methods>
             <method name="(anonymous_0)" hits="18" signature="()V">
@@ -297,7 +336,7 @@
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="9" branch="false"/>
+            <line number="1" hits="10" branch="false"/>
           </lines>
         </class>
         <class name="scheme-names.js" filename="app/constants/scheme-names.js" line-rate="1" branch-rate="1">
@@ -346,7 +385,7 @@
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="1" branch="false"/>
+            <line number="1" hits="2" branch="false"/>
           </lines>
         </class>
       </classes>