ffc-pay-schemes 1.0.2 → 1.0.4

package/README.md

@@ -18,25 +18,30 @@ const {
   createSplitInvoiceNumber,
   getAccountCodeMap,
   getSchemeBatchProperties,
+  getSchemeNameFromSchemeId,
   getSchemeProperties,
   getSchemes,
+  getSourceSystemFromSchemeId,
   schemeDoesNotRequirePPAs,
   schemeProvidesAccountingValues,
   schemeIds
 } = require('ffc-pay-schemes')
 ```
 
-- `getSchemes()` returns all supported schemes as an array of objects containing `schemeId` and `schemeName`.
-- `getSchemeProperties(schemeId, sourceSystem, pillar)` returns the properties for a scheme. A scheme can be identified by its ID or source system. The optional `pillar` can be used for manual payments.
-- `getSchemeBatchProperties(schemeId)` returns the batch processing properties for a given `schemeId`.
-- `getAccountCodeMap(schemeId)` returns the account code mapping used for a given `schemeId`.
 - `createInvoiceNumber(paymentRequest)` creates an invoice number for a given `paymentRequest`.
 - `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`.
+- `getSchemeIdFromSourceSystem(sourceSystem)` returns the scheme ID for a given `sourceSystem`.
+- `getSchemeNameFromSchemeId(schemeId)` returns the scheme name for a given `schemeId`.
+- `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`.
 - `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.
 
-### Example
+### Examples
 
 ```js
 const {
@@ -48,15 +53,11 @@ const {
 } = require('ffc-pay-schemes')
 
 const schemes = getSchemes()
-console.log(schemes)
 
 const scheme = getSchemeProperties(schemeIds.BPS)
-console.log(scheme)
 
 const doesNotRequirePPAs = schemeDoesNotRequirePPAs(schemeIds.BPS)
 const providesAccountingValues = schemeProvidesAccountingValues(schemeIds.BPS)
-
-console.log({ doesNotRequirePPAs, providesAccountingValues })
 ```
 
 ## Licence

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

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

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

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

package/app/get-schemes.js

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

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

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

package/index.js

@@ -2,8 +2,11 @@ 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 { getSchemeIdFromSourceSystem } = require('./app/get-scheme-id-from-source-system')
+const { getSchemeNameFromSchemeId } = require('./app/get-scheme-name-from-scheme-id')
 const { getSchemeProperties } = require('./app/get-scheme-properties')
 const { getSchemes } = require('./app/get-schemes')
+const { getSourceSystemFromSchemeId } = require('./app/get-source-system-from-scheme-id')
 const { schemeDoesNotRequirePPAs } = require('./app/scheme-does-not-require-ppas')
 const { schemeProvidesAccountingValues } = require('./app/scheme-provides-accounting-values')
 const schemeIds = require('./app/constants/scheme-ids')
@@ -13,8 +16,11 @@ module.exports = {
   createSplitInvoiceNumber,
   getAccountCodeMap,
   getSchemeBatchProperties,
+  getSchemeIdFromSourceSystem,
+  getSchemeNameFromSchemeId,
   getSchemeProperties,
   getSchemes,
+  getSourceSystemFromSchemeId,
   schemeDoesNotRequirePPAs,
   schemeProvidesAccountingValues,
   schemeIds

package/package.json

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

package/sonar-project.properties

@@ -1,3 +1,3 @@
-sonar.javascript.exclusions=**/jest.config.js,**/jest.setup.js,**/__mocks__/**,**/node_modules/**,**/test/**,**/test-output/**,**/eslint.config.js
+sonar.javascript.exclusions=**/jest.config.js,**/jest.setup.js,**/__mocks__/**,**/node_modules/**,**/test/**,**/test-output/**,**/eslint.config.js,index.js
 sonar.javascript.lcov.reportPaths=test-output/lcov.info
-sonar.exclusions=/test/**,**/*.test.js,*snyk_report.html,*snyk_report.css
+sonar.exclusions=/test/**,**/*.test.js,*snyk_report.html,*snyk_report.css,README.md

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

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

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

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

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

@@ -1,13 +1,15 @@
 const { getSchemes } = require('../../app/get-schemes')
 const schemeIds = require('../../app/constants/scheme-ids')
 const schemeNames = require('../../app/constants/scheme-names')
+const sourceSystems = require('../../app/constants/source-systems')
 
 describe('getSchemes', () => {
   test('returns all schemes with their IDs and names', () => {
     expect(getSchemes()).toEqual(
       Object.keys(schemeIds).map((schemeKey) => ({
         schemeId: schemeIds[schemeKey],
-        schemeName: schemeNames[schemeKey]
+        schemeName: schemeNames[schemeKey],
+        sourceSystem: sourceSystems[schemeKey]
       }))
     )
   })
@@ -17,7 +19,8 @@ describe('getSchemes', () => {
     (schemeKey) => {
       expect(getSchemes()).toContainEqual({
         schemeId: schemeIds[schemeKey],
-        schemeName: schemeNames[schemeKey]
+        schemeName: schemeNames[schemeKey],
+        sourceSystem: sourceSystems[schemeKey]
       })
     }
   )

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

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

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="201" lines-covered="191" line-rate="0.9501999999999999" branches-valid="50" branches-covered="50" branch-rate="1" timestamp="1787750269672" complexity="0" version="0.1">
+<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">
   <sources>
     <source>/home/samplackett/ffc-pay-schemes</source>
   </sources>
@@ -20,7 +20,10 @@
             <line number="7" hits="0" branch="false"/>
             <line number="8" hits="0" branch="false"/>
             <line number="9" hits="0" branch="false"/>
+            <line number="10" hits="0" branch="false"/>
             <line number="11" hits="0" branch="false"/>
+            <line number="12" hits="0" branch="false"/>
+            <line number="14" hits="0" branch="false"/>
           </lines>
         </class>
       </classes>
@@ -47,6 +50,48 @@
             <line number="7" 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">
+              <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-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"/>
+              </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-properties.js" filename="app/get-scheme-properties.js" line-rate="1" branch-rate="1">
           <methods>
             <method name="(anonymous_0)" hits="54" signature="()V">
@@ -91,21 +136,43 @@
           <methods>
             <method name="(anonymous_0)" hits="18" signature="()V">
               <lines>
-                <line number="4" hits="18"/>
+                <line number="5" hits="18"/>
               </lines>
             </method>
             <method name="(anonymous_1)" hits="306" signature="()V">
               <lines>
-                <line number="5" hits="306"/>
+                <line number="6" hits="306"/>
               </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="306" branch="false"/>
-            <line number="10" hits="1" branch="false"/>
+            <line number="3" hits="1" branch="false"/>
+            <line number="5" hits="1" branch="false"/>
+            <line number="6" hits="306" branch="false"/>
+            <line number="12" hits="1" branch="false"/>
+          </lines>
+        </class>
+        <class name="get-source-system-from-scheme-id.js" filename="app/get-source-system-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"/>
+              </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="scheme-does-not-require-ppas.js" filename="app/scheme-does-not-require-ppas.js" line-rate="1" branch-rate="1">
@@ -224,7 +291,7 @@
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="2" branch="false"/>
+            <line number="1" hits="3" branch="false"/>
           </lines>
         </class>
       </classes>