ffc-pay-schemes 1.0.7 → 1.0.9

package/README.md

@@ -27,6 +27,7 @@ const {
   getSchemes,
   getSourceSystemFromSchemeId,
   getSourceSystems,
+  isValidSchemeId,
   schemeDoesNotRequirePPAs,
   schemeProvidesAccountingValues
 } = require('ffc-pay-schemes')
@@ -42,9 +43,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.
+- `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/get-schemes.js

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

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

@@ -11,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')
 
@@ -28,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.7",
+  "version": "1.0.9",
   "description": "Module for defining and providing details for the payment schemes supported by the Payment Hub.",
   "main": "index.js",
   "scripts": {

package/test/unit/get-schemes.test.js

@@ -1,4 +1,5 @@
 const { getSchemes } = require('../../app/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')
@@ -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/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="243" lines-covered="227" line-rate="0.9340999999999999" branches-valid="54" branches-covered="54" branch-rate="1" timestamp="1788362739771" complexity="0" version="0.1">
+<coverage lines-valid="249" lines-covered="232" line-rate="0.9317" branches-valid="54" branches-covered="54" branch-rate="1" timestamp="1788437541242" complexity="0" version="0.1">
   <sources>
     <source>/home/samplackett/ffc-pay-schemes</source>
   </sources>
@@ -26,7 +26,8 @@
             <line number="13" hits="0" branch="false"/>
             <line number="14" hits="0" branch="false"/>
             <line number="15" hits="0" branch="false"/>
-            <line number="17" hits="0" branch="false"/>
+            <line number="16" hits="0" branch="false"/>
+            <line number="18" hits="0" branch="false"/>
           </lines>
         </class>
       </classes>
@@ -246,6 +247,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">
@@ -320,7 +337,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">