ffc-pay-schemes 1.0.4 → 1.0.6

package/README.md

@@ -18,13 +18,16 @@ const {
   createSplitInvoiceNumber,
   getAccountCodeMap,
   getSchemeBatchProperties,
+  getSchemeIdFromSourceSystem,
+  getSchemeIds,
   getSchemeNameFromSchemeId,
+  getSchemeNames,
   getSchemeProperties,
   getSchemes,
   getSourceSystemFromSchemeId,
+  getSourceSystems,
   schemeDoesNotRequirePPAs,
-  schemeProvidesAccountingValues,
-  schemeIds
+  schemeProvidesAccountingValues
 } = require('ffc-pay-schemes')
 ```
 
@@ -33,13 +36,15 @@ const {
 - `getAccountCodeMap(schemeId)` returns the account code mapping used for a given `schemeId`.
 - `getSchemeBatchProperties(schemeId)` returns the batch processing properties for a given `schemeId`.
 - `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`.
+- `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`.
 - `getSourceSystemFromSchemeId(schemeId)` returns the source system name for a given `schemeId`.
+- `getSourceSystems()` returns all supported source systems.
 - `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`.
-- `schemeIds` provides the constants for all supported scheme IDs.
 
 ### Examples
 

package/app/constants/unknown.js

@@ -0,0 +1,3 @@
+module.exports = {
+  UNKNOWN: 'Unknown'
+}

package/app/get-scheme-ids.js

@@ -0,0 +1,9 @@
+const schemeIds = require('./constants/scheme-ids')
+
+const getSchemeIds = () => {
+  return schemeIds
+}
+
+module.exports = {
+  getSchemeIds
+}

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

@@ -1,8 +1,9 @@
+const { UNKNOWN } = require('./constants/unknown')
 const { getSchemes } = require('./get-schemes')
 
 const getSchemeNameFromSchemeId = (schemeId) => {
   const matchingScheme = getSchemes().find((scheme) => scheme.schemeId === schemeId)
-  return matchingScheme?.schemeName
+  return matchingScheme?.schemeName ?? UNKNOWN
 }
 
 module.exports = {

package/app/get-scheme-names.js

@@ -0,0 +1,9 @@
+const schemeNames = require('./constants/scheme-names')
+
+const getSchemeNames = () => {
+  return schemeNames
+}
+
+module.exports = {
+  getSchemeNames
+}

package/app/get-source-system-from-scheme-id.js

@@ -1,8 +1,9 @@
+const { UNKNOWN } = require('./constants/unknown')
 const { getSchemes } = require('./get-schemes')
 
 const getSourceSystemFromSchemeId = (schemeId) => {
   const matchingScheme = getSchemes().find((scheme) => scheme.schemeId === schemeId)
-  return matchingScheme?.sourceSystem
+  return matchingScheme?.sourceSystem ?? UNKNOWN
 }
 
 module.exports = {

package/app/get-source-systems.js

@@ -0,0 +1,9 @@
+const sourceSystems = require('./constants/source-systems')
+
+const getSourceSystems = () => {
+  return sourceSystems
+}
+
+module.exports = {
+  getSourceSystems
+}

package/index.js

@@ -3,13 +3,15 @@ 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 { 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')
+const { getSchemeNames } = require('./app/get-scheme-names')
 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 { schemeDoesNotRequirePPAs } = require('./app/scheme-does-not-require-ppas')
 const { schemeProvidesAccountingValues } = require('./app/scheme-provides-accounting-values')
-const schemeIds = require('./app/constants/scheme-ids')
 
 module.exports = {
   createInvoiceNumber,
@@ -17,11 +19,13 @@ module.exports = {
   getAccountCodeMap,
   getSchemeBatchProperties,
   getSchemeIdFromSourceSystem,
+  getSchemeIds,
   getSchemeNameFromSchemeId,
+  getSchemeNames,
   getSchemeProperties,
   getSchemes,
   getSourceSystemFromSchemeId,
+  getSourceSystems,
   schemeDoesNotRequirePPAs,
-  schemeProvidesAccountingValues,
-  schemeIds
+  schemeProvidesAccountingValues
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ffc-pay-schemes",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "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-ids.test.js

@@ -0,0 +1,8 @@
+const { getSchemeIds } = require('../../app/get-scheme-ids')
+const schemeIds = require('../../app/constants/scheme-ids')
+
+describe('getSchemeIds', () => {
+  test('returns all scheme IDs', () => {
+    expect(getSchemeIds()).toEqual(schemeIds)
+  })
+})

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

@@ -4,6 +4,7 @@ jest.mock('../../app/get-schemes', () => ({
 
 const { getSchemes } = require('../../app/get-schemes')
 const { getSchemeNameFromSchemeId } = require('../../app/get-scheme-name-from-scheme-id')
+const { UNKNOWN } = require('../../app/constants/unknown')
 
 describe('getSchemeNameFromSchemeId', () => {
   beforeEach(() => {
@@ -22,7 +23,7 @@ describe('getSchemeNameFromSchemeId', () => {
     expect(getSchemeNameFromSchemeId(1)).toBe('Example Scheme')
   })
 
-  test('returns undefined when the scheme ID is not found', () => {
+  test('returns unknown when the scheme ID is not found', () => {
     getSchemes.mockReturnValue([
       {
         schemeId: 1,
@@ -31,13 +32,13 @@ describe('getSchemeNameFromSchemeId', () => {
       }
     ])
 
-    expect(getSchemeNameFromSchemeId(2)).toBeUndefined()
+    expect(getSchemeNameFromSchemeId(2)).toBe(UNKNOWN)
   })
 
-  test('returns undefined when no schemes are available', () => {
+  test('returns unknown when no schemes are available', () => {
     getSchemes.mockReturnValue([])
 
-    expect(getSchemeNameFromSchemeId(2)).toBeUndefined()
+    expect(getSchemeNameFromSchemeId(2)).toBe(UNKNOWN)
   })
 
   test('gets schemes before searching for the source system', () => {

package/test/unit/get-scheme-names.test.js

@@ -0,0 +1,8 @@
+const { getSchemeNames } = require('../../app/get-scheme-names')
+const schemeNames = require('../../app/constants/scheme-names')
+
+describe('getSchemeNames', () => {
+  test('returns all scheme names', () => {
+    expect(getSchemeNames()).toEqual(schemeNames)
+  })
+})

package/test/unit/get-source-system-from-scheme-id.test.js

@@ -2,6 +2,7 @@ jest.mock('../../app/get-schemes', () => ({
   getSchemes: jest.fn()
 }))
 
+const { UNKNOWN } = require('../../app/constants/unknown')
 const { getSchemes } = require('../../app/get-schemes')
 const { getSourceSystemFromSchemeId } = require('../../app/get-source-system-from-scheme-id')
 
@@ -22,7 +23,7 @@ describe('getSourceSystemFromSchemeId', () => {
     expect(getSourceSystemFromSchemeId(1)).toBe('Example Source')
   })
 
-  test('returns undefined when the scheme ID is not found', () => {
+  test('returns unknown when the scheme ID is not found', () => {
     getSchemes.mockReturnValue([
       {
         schemeId: 1,
@@ -31,13 +32,13 @@ describe('getSourceSystemFromSchemeId', () => {
       }
     ])
 
-    expect(getSourceSystemFromSchemeId(2)).toBeUndefined()
+    expect(getSourceSystemFromSchemeId(2)).toBe(UNKNOWN)
   })
 
-  test('returns undefined when no schemes are available', () => {
+  test('returns unknown when no schemes are available', () => {
     getSchemes.mockReturnValue([])
 
-    expect(getSourceSystemFromSchemeId(2)).toBeUndefined()
+    expect(getSourceSystemFromSchemeId(2)).toBe(UNKNOWN)
   })
 
   test('gets schemes before searching for the source system', () => {

package/test/unit/get-source-systems.test.js

@@ -0,0 +1,8 @@
+const { getSourceSystems } = require('../../app/get-source-systems')
+const sourceSystems = require('../../app/constants/source-systems')
+
+describe('getSourceSystems', () => {
+  test('returns all source systems', () => {
+    expect(getSourceSystems()).toEqual(sourceSystems)
+  })
+})

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="220" lines-covered="207" line-rate="0.9409000000000001" branches-valid="50" branches-covered="50" branch-rate="1" timestamp="1787762739854" complexity="0" version="0.1">
+<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">
   <sources>
     <source>/home/samplackett/ffc-pay-schemes</source>
   </sources>
@@ -23,7 +23,9 @@
             <line number="10" hits="0" branch="false"/>
             <line number="11" hits="0" branch="false"/>
             <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"/>
           </lines>
         </class>
       </classes>
@@ -71,25 +73,56 @@
             <line number="8" hits="1" branch="false"/>
           </lines>
         </class>
+        <class name="get-scheme-ids.js" filename="app/get-scheme-ids.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>
         <class name="get-scheme-name-from-scheme-id.js" filename="app/get-scheme-name-from-scheme-id.js" line-rate="1" branch-rate="1">
           <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-scheme-names.js" filename="app/get-scheme-names.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>
         <class name="get-scheme-properties.js" filename="app/get-scheme-properties.js" line-rate="1" branch-rate="1">
@@ -175,6 +208,21 @@
             <line number="8" hits="1" branch="false"/>
           </lines>
         </class>
+        <class name="get-source-systems.js" filename="app/get-source-systems.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>
         <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">
@@ -249,14 +297,14 @@
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="8" branch="false"/>
+            <line number="1" hits="9" branch="false"/>
           </lines>
         </class>
         <class name="scheme-names.js" filename="app/constants/scheme-names.js" line-rate="1" branch-rate="1">
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="1" branch="false"/>
+            <line number="1" hits="2" branch="false"/>
           </lines>
         </class>
         <class name="schemes-not-requiring-ppas.js" filename="app/constants/schemes-not-requiring-ppas.js" line-rate="1" branch-rate="1">
@@ -291,7 +339,14 @@
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="3" branch="false"/>
+            <line number="1" hits="4" branch="false"/>
+          </lines>
+        </class>
+        <class name="unknown.js" filename="app/constants/unknown.js" line-rate="1" branch-rate="1">
+          <methods>
+          </methods>
+          <lines>
+            <line number="1" hits="1" branch="false"/>
           </lines>
         </class>
       </classes>