ffc-pay-schemes 1.1.0 → 1.1.2

package/README.md

@@ -31,6 +31,8 @@ const {
   getSchemeNames,
   getSchemeProperties,
   getSchemes,
+  getSitiAgriSchemeIds,
+  getSitiAgriSchemes,
   getSourceSystemFromSchemeId,
   getSourceSystems,
   isFRPS,
@@ -58,10 +60,13 @@ const {
 - `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`, `sourceSystem` and `pillar`.
+- `getSitiAgriSchemeIds()` returns all scheme IDs where the scheme is delivered via Siti Agri.
+- `getSitiAgriSchemes()` returns all Siti Agri delivered 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.
 - `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.
+- `getSitiAgriSchemeIds()` returns all Siti Agri scheme IDs.
 - `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/scheme-id/get-siti-agri-scheme-ids.js

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

package/app/scheme-properties/get-siti-agri-schemes.js

@@ -0,0 +1,16 @@
+const pillars = require('../constants/pillars')
+const sitiAgriSchemeIds = require('../constants/siti-agri-schemes')
+const schemeNames = require('../constants/scheme-names')
+const sourceSystems = require('../constants/source-systems')
+
+const getSitiAgriSchemes = () =>
+  Object.keys(sitiAgriSchemeIds).map((schemeKey) => ({
+    schemeId: sitiAgriSchemeIds[schemeKey],
+    schemeName: schemeNames[schemeKey],
+    sourceSystem: sourceSystems[schemeKey],
+    pillar: pillars[schemeKey]
+  }))
+
+module.exports = {
+  getSitiAgriSchemes
+}

package/index.js

@@ -15,11 +15,13 @@ const { getSchemeNameFromSchemeId } = require('./app/scheme-name/get-scheme-name
 const { getSchemeNames } = require('./app/scheme-name/get-scheme-names')
 const { getSchemeProperties } = require('./app/scheme-properties/get-scheme-properties')
 const { getSchemes } = require('./app/scheme-properties/get-schemes')
+const { getSitiAgriSchemeIds } = require('./app/scheme-id/get-siti-agri-scheme-ids')
+const { getSitiAgriSchemes } = require('./app/scheme-properties/get-siti-agri-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 { isValidSchemeId } = require('./app/scheme-id/is-valid-scheme-id')
 const { schemeDoesNotRequirePPAs } = require('./app/helpers/scheme-does-not-require-ppas')
 const { schemeProvidesAccountingValues } = require('./app/helpers/scheme-provides-accounting-values')
 
@@ -41,6 +43,8 @@ module.exports = {
   getSchemeNames,
   getSchemeProperties,
   getSchemes,
+  getSitiAgriSchemeIds,
+  getSitiAgriSchemes,
   getSourceSystemFromSchemeId,
   getSourceSystems,
   isFRPS,

package/jest.config.js

@@ -2,7 +2,8 @@ module.exports = {
   collectCoverage: true,
   collectCoverageFrom: [
     '**/*.js',
-    '!**/*.test.js'
+    '!**/*.test.js',
+    '!index.js'
   ],
   coverageDirectory: 'test-output',
   coverageReporters: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ffc-pay-schemes",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Module for defining and providing details for the payment schemes supported by the Payment Hub.",
   "main": "index.js",
   "scripts": {
@@ -17,7 +17,8 @@
   },
   "author": "Defra DDTS",
   "contributors": [
-    "Sam Plackett samuel.plackett@atos.ai"
+    "Sam Plackett samuel.plackett@atos.ai",
+    "Leigh Godson leigh.godson@atos.ai"
   ],
   "license": "OGL-UK-3.0",
   "bugs": {

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,index.js
+sonar.exclusions=**/test/**,**/test-output/**,**/*.test.js,*snyk_report.html,*snyk_report.css,README.md,**/jest.config.js,**/jest.setup.js,**/eslint.config.js
+sonar.coverage.exclusions=index.js
 sonar.javascript.lcov.reportPaths=test-output/lcov.info
-sonar.exclusions=/test/**,**/*.test.js,*snyk_report.html,*snyk_report.css,README.md

package/test/unit/helpers/get-batch-sequence-from-file-name.test.js

@@ -4,10 +4,6 @@ jest.mock('../../../app/constants/scheme-ids', () => ({
   FPTT: 18
 }))
 
-jest.mock('../../../app/constants/sequence-positions', () => ({
-  SFI: 6
-}))
-
 const {
   getBatchSequenceFromFileName
 } = require('../../../app/helpers/get-batch-sequence-from-file-name')
@@ -16,7 +12,7 @@ const schemeIds = require('../../../app/constants/scheme-ids')
 
 describe('getBatchSequenceFromFileName', () => {
   test('returns the sequence using the scheme sequence position', () => {
-    const fileName = 'prefix12345678.csv'
+    const fileName = 'prefix012345678.csv'
 
     expect(
       getBatchSequenceFromFileName(schemeIds.SFI, fileName)

package/test/unit/scheme-id/get-siti-agri-scheme-ids.test.js

@@ -0,0 +1,8 @@
+const sitiAgriSchemes = require('../../../app/constants/siti-agri-schemes')
+const { getSitiAgriSchemeIds } = require('../../../app/scheme-id/get-siti-agri-scheme-ids')
+
+describe('getSitiAgriSchemeIds', () => {
+  test('returns the Siti Agri scheme IDs', () => {
+    expect(getSitiAgriSchemeIds()).toEqual(sitiAgriSchemes)
+  })
+})

package/test/unit/{helpers → scheme-id}/is-valid-scheme-id.test.js

@@ -1,5 +1,5 @@
 const schemeIds = require('../../../app/constants/scheme-ids')
-const { isValidSchemeId } = require('../../../app/helpers/is-valid-scheme-id')
+const { isValidSchemeId } = require('../../../app/scheme-id/is-valid-scheme-id')
 
 describe('isValidSchemeId', () => {
   test.each(Object.values(schemeIds))(

package/test/unit/scheme-properties/get-siti-agri-schemes.test.js

@@ -0,0 +1,18 @@
+const sitiAgriSchemeIds = require('../../../app/constants/siti-agri-schemes')
+const schemeNames = require('../../../app/constants/scheme-names')
+const sourceSystems = require('../../../app/constants/source-systems')
+const pillars = require('../../../app/constants/pillars')
+const { getSitiAgriSchemes } = require('../../../app/scheme-properties/get-siti-agri-schemes')
+
+describe('getSitiAgriSchemes', () => {
+  test('returns one scheme object for each SITI Agri scheme id', () => {
+    const expected = Object.keys(sitiAgriSchemeIds).map((schemeKey) => ({
+      schemeId: sitiAgriSchemeIds[schemeKey],
+      schemeName: schemeNames[schemeKey],
+      sourceSystem: sourceSystems[schemeKey],
+      pillar: pillars[schemeKey]
+    }))
+
+    expect(getSitiAgriSchemes()).toEqual(expected)
+  })
+})

package/test-output/cobertura-coverage.xml

@@ -1,47 +1,20 @@
 <?xml version="1.0" ?>
 <!DOCTYPE coverage SYSTEM "http://cobertura.sourceforge.net/xml/coverage-04.dtd">
-<coverage lines-valid="326" lines-covered="300" line-rate="0.9201999999999999" branches-valid="67" branches-covered="67" branch-rate="1" timestamp="1789476417452" complexity="0" version="0.1">
+<coverage lines-valid="314" lines-covered="312" line-rate="0.9936" branches-valid="67" branches-covered="67" branch-rate="1" timestamp="1791818472377" complexity="0" version="0.1">
   <sources>
     <source>/home/samplackett/ffc-pay-schemes</source>
   </sources>
   <packages>
-    <package name="ffc-pay-schemes" line-rate="0" branch-rate="1">
+    <package name="constants" line-rate="0.9354" branch-rate="1">
       <classes>
-        <class name="index.js" filename="index.js" line-rate="0" branch-rate="1">
+        <class name="batch-schemes.js" filename="app/constants/batch-schemes.js" line-rate="0" branch-rate="1">
           <methods>
           </methods>
           <lines>
             <line number="1" hits="0" branch="false"/>
-            <line number="2" hits="0" branch="false"/>
             <line number="3" hits="0" branch="false"/>
-            <line number="4" hits="0" branch="false"/>
-            <line number="5" hits="0" branch="false"/>
-            <line number="6" hits="0" branch="false"/>
-            <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="13" hits="0" branch="false"/>
-            <line number="14" hits="0" branch="false"/>
-            <line number="15" hits="0" branch="false"/>
-            <line number="16" hits="0" branch="false"/>
-            <line number="17" hits="0" branch="false"/>
-            <line number="18" hits="0" branch="false"/>
-            <line number="19" hits="0" branch="false"/>
-            <line number="20" hits="0" branch="false"/>
-            <line number="21" hits="0" branch="false"/>
-            <line number="22" hits="0" branch="false"/>
-            <line number="23" hits="0" branch="false"/>
-            <line number="24" hits="0" branch="false"/>
-            <line number="26" hits="0" branch="false"/>
           </lines>
         </class>
-      </classes>
-    </package>
-    <package name="ffc-pay-schemes.app.constants" line-rate="0.9655" branch-rate="1">
-      <classes>
         <class name="delivery-bodies.js" filename="app/constants/delivery-bodies.js" line-rate="1" branch-rate="1">
           <methods>
           </methods>
@@ -90,7 +63,7 @@
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="4" branch="false"/>
+            <line number="1" hits="5" branch="false"/>
           </lines>
         </class>
         <class name="scheme-batch-properties.js" filename="app/constants/scheme-batch-properties.js" line-rate="1" branch-rate="1">
@@ -105,14 +78,14 @@
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="13" branch="false"/>
+            <line number="1" hits="15" 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="2" branch="false"/>
+            <line number="1" hits="3" 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">
@@ -144,26 +117,26 @@
             <line number="8" hits="1" branch="false"/>
           </lines>
         </class>
-        <class name="sequence-positions.js" filename="app/constants/sequence-positions.js" line-rate="0" branch-rate="1">
+        <class name="sequence-positions.js" filename="app/constants/sequence-positions.js" line-rate="1" branch-rate="1">
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="0" branch="false"/>
+            <line number="1" hits="1" branch="false"/>
           </lines>
         </class>
         <class name="siti-agri-schemes.js" filename="app/constants/siti-agri-schemes.js" line-rate="1" branch-rate="1">
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="1" branch="false"/>
-            <line number="3" hits="1" branch="false"/>
+            <line number="1" hits="3" branch="false"/>
+            <line number="3" hits="3" branch="false"/>
           </lines>
         </class>
         <class name="source-systems.js" filename="app/constants/source-systems.js" line-rate="1" branch-rate="1">
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="4" branch="false"/>
+            <line number="1" hits="5" branch="false"/>
           </lines>
         </class>
         <class name="unknown.js" filename="app/constants/unknown.js" line-rate="1" branch-rate="1">
@@ -175,7 +148,7 @@
         </class>
       </classes>
     </package>
-    <package name="ffc-pay-schemes.app.constants.account-codes" line-rate="1" branch-rate="1">
+    <package name="constants.account-codes" line-rate="1" branch-rate="1">
       <classes>
         <class name="ap.js" filename="app/constants/account-codes/ap.js" line-rate="1" branch-rate="1">
           <methods>
@@ -200,7 +173,7 @@
         </class>
       </classes>
     </package>
-    <package name="ffc-pay-schemes.app.create-invoice-number" line-rate="1" branch-rate="1">
+    <package name="create-invoice-number" line-rate="1" branch-rate="1">
       <classes>
         <class name="create-default-invoice-number.js" filename="app/create-invoice-number/create-default-invoice-number.js" line-rate="1" branch-rate="1">
           <methods>
@@ -339,7 +312,7 @@
         </class>
       </classes>
     </package>
-    <package name="ffc-pay-schemes.app.create-split-invoice-number" line-rate="1" branch-rate="1">
+    <package name="create-split-invoice-number" line-rate="1" branch-rate="1">
       <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>
@@ -396,7 +369,7 @@
         </class>
       </classes>
     </package>
-    <package name="ffc-pay-schemes.app.get-account-code-map" line-rate="1" branch-rate="1">
+    <package name="get-account-code-map" line-rate="1" branch-rate="1">
       <classes>
         <class name="bps-map.js" filename="app/get-account-code-map/bps-map.js" line-rate="1" branch-rate="1">
           <methods>
@@ -519,7 +492,7 @@
         </class>
       </classes>
     </package>
-    <package name="ffc-pay-schemes.app.helpers" line-rate="1" branch-rate="1">
+    <package name="helpers" line-rate="1" branch-rate="1">
       <classes>
         <class name="get-batch-sequence-from-file-name.js" filename="app/helpers/get-batch-sequence-from-file-name.js" line-rate="1" branch-rate="1">
           <methods>
@@ -625,22 +598,6 @@
             <line number="7" hits="1" branch="false"/>
           </lines>
         </class>
-        <class name="is-valid-scheme-id.js" filename="app/helpers/is-valid-scheme-id.js" line-rate="1" branch-rate="1">
-          <methods>
-            <method name="(anonymous_0)" hits="20" signature="()V">
-              <lines>
-                <line number="3" hits="20"/>
-              </lines>
-            </method>
-          </methods>
-          <lines>
-            <line number="1" hits="1" branch="false"/>
-            <line number="3" hits="1" branch="false"/>
-            <line number="4" hits="20" branch="false"/>
-            <line number="5" hits="20" branch="false"/>
-            <line number="8" hits="1" branch="false"/>
-          </lines>
-        </class>
         <class name="scheme-does-not-require-ppas.js" filename="app/helpers/scheme-does-not-require-ppas.js" line-rate="1" branch-rate="1">
           <methods>
             <method name="(anonymous_0)" hits="19" signature="()V">
@@ -673,7 +630,7 @@
         </class>
       </classes>
     </package>
-    <package name="ffc-pay-schemes.app.pillar" line-rate="1" branch-rate="1">
+    <package name="pillar" line-rate="1" branch-rate="1">
       <classes>
         <class name="get-pillar-from-scheme-id.js" filename="app/pillar/get-pillar-from-scheme-id.js" line-rate="1" branch-rate="1">
           <methods>
@@ -714,7 +671,7 @@
         </class>
       </classes>
     </package>
-    <package name="ffc-pay-schemes.app.scheme-id" line-rate="1" branch-rate="1">
+    <package name="scheme-id" line-rate="1" branch-rate="1">
       <classes>
         <class name="get-scheme-id-from-pillar.js" filename="app/scheme-id/get-scheme-id-from-pillar.js" line-rate="1" branch-rate="1">
           <methods>
@@ -773,9 +730,40 @@
             <line number="7" hits="1" branch="false"/>
           </lines>
         </class>
+        <class name="get-siti-agri-scheme-ids.js" filename="app/scheme-id/get-siti-agri-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="is-valid-scheme-id.js" filename="app/scheme-id/is-valid-scheme-id.js" line-rate="1" branch-rate="1">
+          <methods>
+            <method name="(anonymous_0)" hits="20" signature="()V">
+              <lines>
+                <line number="3" hits="20"/>
+              </lines>
+            </method>
+          </methods>
+          <lines>
+            <line number="1" hits="1" branch="false"/>
+            <line number="3" hits="1" branch="false"/>
+            <line number="4" hits="20" branch="false"/>
+            <line number="5" hits="20" branch="false"/>
+            <line number="8" hits="1" branch="false"/>
+          </lines>
+        </class>
       </classes>
     </package>
-    <package name="ffc-pay-schemes.app.scheme-name" line-rate="1" branch-rate="1">
+    <package name="scheme-name" line-rate="1" branch-rate="1">
       <classes>
         <class name="get-scheme-name-from-scheme-id.js" filename="app/scheme-name/get-scheme-name-from-scheme-id.js" line-rate="1" branch-rate="1">
           <methods>
@@ -816,7 +804,7 @@
         </class>
       </classes>
     </package>
-    <package name="ffc-pay-schemes.app.scheme-properties" line-rate="1" branch-rate="1">
+    <package name="scheme-properties" line-rate="1" branch-rate="1">
       <classes>
         <class name="get-scheme-batch-properties.js" filename="app/scheme-properties/get-scheme-batch-properties.js" line-rate="1" branch-rate="1">
           <methods>
@@ -922,9 +910,32 @@
             <line number="14" hits="1" branch="false"/>
           </lines>
         </class>
+        <class name="get-siti-agri-schemes.js" filename="app/scheme-properties/get-siti-agri-schemes.js" line-rate="1" branch-rate="1">
+          <methods>
+            <method name="(anonymous_0)" hits="1" signature="()V">
+              <lines>
+                <line number="6" hits="1"/>
+              </lines>
+            </method>
+            <method name="(anonymous_1)" hits="11" signature="()V">
+              <lines>
+                <line number="7" hits="11"/>
+              </lines>
+            </method>
+          </methods>
+          <lines>
+            <line number="1" hits="1" branch="false"/>
+            <line number="2" hits="1" branch="false"/>
+            <line number="3" hits="1" branch="false"/>
+            <line number="4" hits="1" branch="false"/>
+            <line number="6" hits="1" branch="false"/>
+            <line number="7" hits="11" branch="false"/>
+            <line number="14" hits="1" branch="false"/>
+          </lines>
+        </class>
       </classes>
     </package>
-    <package name="ffc-pay-schemes.app.source-system" line-rate="1" branch-rate="1">
+    <package name="source-system" line-rate="1" branch-rate="1">
       <classes>
         <class name="get-source-system-from-scheme-id.js" filename="app/source-system/get-source-system-from-scheme-id.js" line-rate="1" branch-rate="1">
           <methods>