ffc-pay-schemes 1.1.1 → 1.1.3

package/README.md

@@ -31,6 +31,8 @@ const {
   getSchemeNames,
   getSchemeProperties,
   getSchemes,
+  getSitiAgriSchemeIds,
+  getSitiAgriSchemes,
   getSourceSystemFromSchemeId,
   getSourceSystems,
   isFRPS,
@@ -58,6 +60,8 @@ 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.

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

@@ -0,0 +1,30 @@
+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 schemeIds = require('../constants/scheme-ids')
+
+const schemeKeyById = Object.entries(schemeIds).reduce((acc, [key, value]) => {
+  acc[value] = key
+  return acc
+}, {})
+
+const getSitiAgriSchemes = () =>
+  sitiAgriSchemeIds.map((schemeId) => {
+    const schemeKey = schemeKeyById[schemeId]
+
+    if (!schemeKey) {
+      throw new Error(`No scheme metadata found for schemeId: ${schemeId}`)
+    }
+
+    return {
+      schemeId,
+      schemeName: schemeNames[schemeKey],
+      sourceSystem: sourceSystems[schemeKey],
+      pillar: pillars[schemeKey]
+    }
+  })
+
+module.exports = {
+  getSitiAgriSchemes
+}

package/index.js

@@ -15,12 +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/helpers/get-siti-agri-scheme-ids')
+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')
 
@@ -43,6 +44,7 @@ module.exports = {
   getSchemeProperties,
   getSchemes,
   getSitiAgriSchemeIds,
+  getSitiAgriSchemes,
   getSourceSystemFromSchemeId,
   getSourceSystems,
   isFRPS,

package/package.json

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

package/test/unit/{helpers → scheme-id}/get-siti-agri-scheme-ids.test.js

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

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,42 @@
+const sitiAgriSchemeIds = require('../../../app/constants/siti-agri-schemes')
+const schemeIds = require('../../../app/constants/scheme-ids')
+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')
+
+const schemeKeyById = Object.entries(schemeIds).reduce((acc, [key, value]) => {
+  acc[value] = key
+  return acc
+}, {})
+
+describe('getSitiAgriSchemes', () => {
+  test('returns one scheme object for each SITI Agri scheme id', () => {
+    const expected = sitiAgriSchemeIds.map((schemeId) => {
+      const schemeKey = schemeKeyById[schemeId]
+
+      expect(schemeKey).toBeDefined()
+
+      return {
+        schemeId,
+        schemeName: schemeNames[schemeKey],
+        sourceSystem: sourceSystems[schemeKey],
+        pillar: pillars[schemeKey]
+      }
+    })
+
+    expect(getSitiAgriSchemes()).toEqual(expected)
+  })
+
+  test('returns the correct metadata for specific scheme (SFI23)', () => {
+    const schemes = getSitiAgriSchemes()
+    const sfi23 = schemes.find((scheme) => scheme.schemeId === schemeIds.SFI23)
+
+    expect(sfi23).toEqual({
+      schemeId: schemeIds.SFI23,
+      schemeName: schemeNames.SFI23,
+      sourceSystem: sourceSystems.SFI23,
+      pillar: pillars.SFI23
+    })
+  })
+})

package/test-output/cobertura-coverage.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0" ?>
 <!DOCTYPE coverage SYSTEM "http://cobertura.sourceforge.net/xml/coverage-04.dtd">
-<coverage lines-valid="305" lines-covered="305" line-rate="1" branches-valid="67" branches-covered="67" branch-rate="1" timestamp="1791217984854" complexity="0" version="0.1">
+<coverage lines-valid="312" lines-covered="312" line-rate="1" branches-valid="67" branches-covered="67" branch-rate="1" timestamp="1791821370454" complexity="0" version="0.1">
   <sources>
-    <source>/home/bunglehaze/defra/ffc-pay-schemes</source>
+    <source>/home/samplackett/ffc-pay-schemes</source>
   </sources>
   <packages>
     <package name="constants" line-rate="1" branch-rate="1">
@@ -55,7 +55,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">
@@ -70,14 +70,14 @@
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="14" 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">
@@ -120,15 +120,15 @@
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="2" branch="false"/>
-            <line number="3" hits="2" 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">
@@ -560,21 +560,6 @@
             <line number="21" hits="1" branch="false"/>
           </lines>
         </class>
-        <class name="get-siti-agri-scheme-ids.js" filename="app/helpers/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-frps.js" filename="app/helpers/is-frps.js" line-rate="1" branch-rate="1">
           <methods>
             <method name="(anonymous_0)" hits="6" signature="()V">
@@ -605,22 +590,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">
@@ -753,6 +722,37 @@
             <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="scheme-name" line-rate="1" branch-rate="1">
@@ -902,6 +902,29 @@
             <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="source-system" line-rate="1" branch-rate="1">