ffc-pay-schemes 1.0.10 → 1.0.12

package/README.md

@@ -29,6 +29,7 @@ const {
   getSourceSystemFromSchemeId,
   getSourceSystems,
   isFRPS,
+  isSitiAgri,
   isValidSchemeId,
   schemeDoesNotRequirePPAs,
   schemeProvidesAccountingValues
@@ -50,6 +51,7 @@ const {
 - `getSourceSystemFromSchemeId(schemeId)` returns the source system name for a given `schemeId`.
 - `getSourceSystems()` returns all supported source systems.
 - `isFRPS(schemeId)` returns `true` if the scheme ID comes from FRPS, or `false` if not.
+- `isSitiAgri(schemeId)` returns `true` if the scheme ID comes from Siti Agri, or `false` if not.
 - `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`.
@@ -73,6 +75,26 @@ const doesNotRequirePPAs = schemeDoesNotRequirePPAs(schemeIds.BPS)
 const providesAccountingValues = schemeProvidesAccountingValues(schemeIds.BPS)
 ```
 
+## Payment Hub usage
+
+The following services are intended to be used with the ffc-pay-schemes package:
+
+- ffc-pay-alerting
+- ffc-pay-batch-processor
+- ffc-pay-dps
+- ffc-pay-enrichment
+- ffc-pay-event-hub
+- ffc-pay-gateway
+- ffc-pay-injection
+- ffc-pay-processing
+- ffc-pay-request-editor
+- ffc-pay-submission
+- ffc-pay-tracking
+- ffc-pay-web
+- ffc-pay-xb
+
+In the event a new payment scheme is added to the package, all of the above services must be bumped to the latest package version to ensure that Payment Hub can process associated payments.
+
 ## Licence
 
 THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT

package/app/constants/siti-agri-schemes.js

@@ -0,0 +1,3 @@
+const { SFI, SFI_PILOT, LUMP_SUMS, CS, BPS, SFI23, DELINKED, SFI_EXPANDED, COHT_REVENUE, COHT_CAPITAL } = require('../constants/scheme-ids')
+
+module.exports = [SFI, SFI_PILOT, LUMP_SUMS, CS, BPS, SFI23, DELINKED, SFI_EXPANDED, COHT_REVENUE, COHT_CAPITAL]

package/app/create-split-invoice-number/index.js

@@ -1,19 +1,13 @@
-const { SFI, LUMP_SUMS, SFI_PILOT, SFI23, DELINKED, SFI_EXPANDED } = require('../constants/scheme-ids')
+const { isSitiAgri } = require('../helpers/is-siti-agri')
 const { createDefaultInvoiceNumber } = require('./create-default-invoice-number')
 const { createSitiAgriInvoiceNumber } = require('./create-siti-agri-invoice-number')
 
 const createSplitInvoiceNumber = (invoiceNumber, splitId, schemeId) => {
-  switch (schemeId) {
-    case SFI:
-    case SFI_PILOT:
-    case LUMP_SUMS:
-    case SFI23:
-    case DELINKED:
-    case SFI_EXPANDED:
-      return createSitiAgriInvoiceNumber(invoiceNumber, splitId)
-    default:
-      return createDefaultInvoiceNumber(invoiceNumber, splitId)
+  if (isSitiAgri(schemeId)) {
+    return createSitiAgriInvoiceNumber(invoiceNumber, splitId)
   }
+
+  return createDefaultInvoiceNumber(invoiceNumber, splitId)
 }
 
 module.exports = {

package/app/helpers/is-siti-agri.js

@@ -0,0 +1,9 @@
+const sitiAgriSchemes = require('../constants/siti-agri-schemes')
+
+const isSitiAgri = (schemeId) => {
+  return sitiAgriSchemes.includes(schemeId)
+}
+
+module.exports = {
+  isSitiAgri
+}

package/index.js

@@ -13,6 +13,7 @@ const { getSchemes } = require('./app/scheme-properties/get-schemes')
 const { getSourceSystemFromSchemeId } = require('./app/source-system/get-source-system-from-scheme-id')
 const { getSourceSystems } = require('./app/source-system/get-source-systems')
 const { isFRPS } = require('./app/helpers/is-frps')
+const { isSitiAgri } = require('./app/helpers/is-siti-agri')
 const { isValidSchemeId } = require('./app/helpers/is-valid-scheme-id')
 const { schemeDoesNotRequirePPAs } = require('./app/helpers/scheme-does-not-require-ppas')
 const { schemeProvidesAccountingValues } = require('./app/helpers/scheme-provides-accounting-values')
@@ -33,6 +34,7 @@ module.exports = {
   getSourceSystemFromSchemeId,
   getSourceSystems,
   isFRPS,
+  isSitiAgri,
   isValidSchemeId,
   schemeDoesNotRequirePPAs,
   schemeProvidesAccountingValues

package/package.json

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

package/test/unit/create-split-invoice-number/index.test.js

@@ -1,34 +1,36 @@
+jest.mock('../../../app/helpers/is-siti-agri', () => ({
+  isSitiAgri: jest.fn()
+}))
+
+const { isSitiAgri } = require('../../../app/helpers/is-siti-agri')
 const { createSplitInvoiceNumber } = require('../../../app/create-split-invoice-number')
 const { createDefaultInvoiceNumber } = require('../../../app/create-split-invoice-number/create-default-invoice-number')
 const { createSitiAgriInvoiceNumber } = require('../../../app/create-split-invoice-number/create-siti-agri-invoice-number')
-const schemeIds = require('../../../app/constants/scheme-ids')
 
 describe('createSplitInvoiceNumber', () => {
   const invoiceNumber = '1234567890123'
   const splitId = 'A'
-  const sitiAgriSchemes = [
-    'SFI',
-    'SFI_PILOT',
-    'LUMP_SUMS',
-    'SFI23',
-    'DELINKED',
-    'SFI_EXPANDED'
-  ]
-
-  test.each(Object.entries(schemeIds))(
-    'uses the correct invoice format for %s',
-    (schemeKey, schemeId) => {
-      const expectedInvoiceNumber = sitiAgriSchemes.includes(schemeKey)
-        ? createSitiAgriInvoiceNumber(invoiceNumber, splitId)
-        : createDefaultInvoiceNumber(invoiceNumber, splitId)
-
-      expect(createSplitInvoiceNumber(invoiceNumber, splitId, schemeId))
-        .toBe(expectedInvoiceNumber)
-    }
-  )
-
-  test('uses the default format for an unknown schemeId', () => {
-    expect(createSplitInvoiceNumber(invoiceNumber, splitId, 'unknown-scheme'))
+  const schemeId = 'SFI'
+
+  beforeEach(() => {
+    jest.clearAllMocks()
+  })
+
+  test('uses the Siti Agri invoice format when the scheme is Siti Agri', () => {
+    isSitiAgri.mockReturnValue(true)
+
+    expect(createSplitInvoiceNumber(invoiceNumber, splitId, schemeId))
+      .toBe(createSitiAgriInvoiceNumber(invoiceNumber, splitId))
+
+    expect(isSitiAgri).toHaveBeenCalledWith(schemeId)
+  })
+
+  test('uses the default invoice format when the scheme is not Siti Agri', () => {
+    isSitiAgri.mockReturnValue(false)
+
+    expect(createSplitInvoiceNumber(invoiceNumber, splitId, schemeId))
       .toBe(createDefaultInvoiceNumber(invoiceNumber, splitId))
+
+    expect(isSitiAgri).toHaveBeenCalledWith(schemeId)
   })
 })

package/test/unit/helpers/is-siti-agri.test.js

@@ -0,0 +1,17 @@
+const sitiAgriSchemes = require('../../../app/constants/siti-agri-schemes')
+const { isSitiAgri } = require('../../../app/helpers/is-siti-agri')
+
+describe('isSitiAgri', () => {
+  test.each(sitiAgriSchemes)('returns true for SITI scheme: %s', (schemeId) => {
+    expect(isSitiAgri(schemeId)).toBe(true)
+  })
+
+  test.each([
+    'unknown-scheme',
+    '',
+    null,
+    undefined
+  ])('returns false for non-SITI scheme: %s', (schemeId) => {
+    expect(isSitiAgri(schemeId)).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="269" lines-covered="250" line-rate="0.9293" branches-valid="60" branches-covered="60" branch-rate="1" timestamp="1788452069348" complexity="0" version="0.1">
+<coverage lines-valid="269" lines-covered="250" line-rate="0.9293" branches-valid="55" branches-covered="55" branch-rate="1" timestamp="1788777087732" complexity="0" version="0.1">
   <sources>
     <source>/home/samplackett/ffc-pay-schemes</source>
   </sources>
@@ -84,7 +84,7 @@
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="12" branch="false"/>
+            <line number="1" hits="11" branch="false"/>
           </lines>
         </class>
         <class name="scheme-names.js" filename="app/constants/scheme-names.js" line-rate="1" branch-rate="1">
@@ -306,43 +306,43 @@
       <classes>
         <class name="create-default-invoice-number.js" filename="app/create-split-invoice-number/create-default-invoice-number.js" line-rate="1" branch-rate="1">
           <methods>
-            <method name="(anonymous_0)" hits="27" signature="()V">
+            <method name="(anonymous_0)" hits="5" signature="()V">
               <lines>
-                <line number="1" hits="27"/>
+                <line number="1" hits="5"/>
               </lines>
             </method>
           </methods>
           <lines>
             <line number="1" hits="2" branch="false"/>
-            <line number="4" hits="27" branch="false"/>
-            <line number="5" hits="27" branch="false"/>
-            <line number="6" hits="27" branch="false"/>
-            <line number="7" hits="27" branch="false"/>
+            <line number="4" hits="5" branch="false"/>
+            <line number="5" hits="5" branch="false"/>
+            <line number="6" hits="5" branch="false"/>
+            <line number="7" hits="5" branch="false"/>
             <line number="10" hits="2" branch="false"/>
           </lines>
         </class>
         <class name="create-siti-agri-invoice-number.js" filename="app/create-split-invoice-number/create-siti-agri-invoice-number.js" line-rate="1" branch-rate="1">
           <methods>
-            <method name="(anonymous_0)" hits="15" signature="()V">
+            <method name="(anonymous_0)" hits="5" signature="()V">
               <lines>
-                <line number="1" hits="15"/>
+                <line number="1" hits="5"/>
               </lines>
             </method>
           </methods>
           <lines>
             <line number="1" hits="2" branch="false"/>
-            <line number="4" hits="15" branch="false"/>
-            <line number="5" hits="15" branch="false"/>
-            <line number="6" hits="15" branch="false"/>
-            <line number="7" hits="15" branch="false"/>
+            <line number="4" hits="5" branch="false"/>
+            <line number="5" hits="5" branch="false"/>
+            <line number="6" hits="5" branch="false"/>
+            <line number="7" hits="5" branch="false"/>
             <line number="10" hits="2" branch="false"/>
           </lines>
         </class>
         <class name="index.js" filename="app/create-split-invoice-number/index.js" line-rate="1" branch-rate="1">
           <methods>
-            <method name="(anonymous_0)" hits="18" signature="()V">
+            <method name="(anonymous_0)" hits="2" signature="()V">
               <lines>
-                <line number="5" hits="18"/>
+                <line number="5" hits="2"/>
               </lines>
             </method>
           </methods>
@@ -351,10 +351,10 @@
             <line number="2" hits="1" branch="false"/>
             <line number="3" hits="1" branch="false"/>
             <line number="5" hits="1" branch="false"/>
-            <line number="6" hits="18" branch="true" condition-coverage="100% (7/7)"/>
-            <line number="13" hits="6" branch="false"/>
-            <line number="15" hits="12" branch="false"/>
-            <line number="19" hits="1" branch="false"/>
+            <line number="6" hits="2" branch="true" condition-coverage="100% (2/2)"/>
+            <line number="7" hits="1" branch="false"/>
+            <line number="10" hits="1" branch="false"/>
+            <line number="13" hits="1" branch="false"/>
           </lines>
         </class>
       </classes>