@defra-fish/connectors-lib 1.76.0 → 1.77.0-rc.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/connectors-lib",
-  "version": "1.76.0",
+  "version": "1.77.0-rc.10",
   "description": "Shared connectors",
   "type": "module",
   "engines": {
@@ -47,5 +47,5 @@
     "node-fetch": "2.7.0",
     "redlock": "4.2.0"
   },
-  "gitHead": "2287ca0defd4b61d66cbea6f0df84568265b036f"
+  "gitHead": "b41c703037390290c9403cafc2e0252ef63e149e"
 }

package/src/__tests__/sales-api-connector.spec.js

@@ -869,3 +869,48 @@ describe('rcp authentication', () => {
     expect(response).toBeNull()
   })
 })
+
+describe('getLicenceDetails', () => {
+  it.each([
+    { firstName: 'Gandalf', lastName: 'Grey', birthDate: '2000-10-03', premises: '59', postcode: 'AB123CD' },
+    { firstName: 'Bilbo', lastName: 'Baggins', birthDate: '1995-04-15', premises: 'Bag End', postcode: 'BS9 4PT' }
+  ])('retrieves the licence details payload returned by the Sales API for %p', async licensee => {
+    const expectedResponse = { licences: [{ some: 'data' }] }
+    fetch.mockReturnValueOnce({ ok: true, status: 200, statusText: 'OK', text: async () => JSON.stringify(expectedResponse) })
+    await expect(salesApi.getLicenceDetails(licensee)).resolves.toEqual(expectedResponse)
+  })
+
+  it.each([
+    {
+      input: { firstName: 'Gandalf', lastName: 'Grey', birthDate: '2000-10-03', premises: '59', postcode: 'AB123CD' },
+      expectedUrl:
+        'http://0.0.0.0:4000/licenceDetails?licenseeFirstName=Gandalf&licenseeLastName=Grey&licenseePremises=59&licenseePostcode=AB123CD&licenseeBirthDate=2000-10-03'
+    },
+    {
+      input: { firstName: 'Bilbo', lastName: 'Baggins', birthDate: '1995-04-15', premises: 'Bag End', postcode: 'BS9 4PT' },
+      expectedUrl:
+        'http://0.0.0.0:4000/licenceDetails?licenseeFirstName=Bilbo&licenseeLastName=Baggins&licenseePremises=Bag%20End&licenseePostcode=BS9%204PT&licenseeBirthDate=1995-04-15'
+    }
+  ])('calls fetch with the name, postcode and date of birth as query parameters for %p', async ({ input, expectedUrl }) => {
+    fetch.mockReturnValueOnce({
+      ok: true,
+      status: 200,
+      statusText: 'OK',
+      text: async () => JSON.stringify({ licences: [] })
+    })
+    await salesApi.getLicenceDetails(input)
+    expect(fetch).toHaveBeenCalledWith(expectedUrl, expect.objectContaining({ method: 'get' }))
+  })
+
+  it('returns null if none found', async () => {
+    fetch.mockReturnValueOnce({
+      ok: false,
+      status: 404,
+      statusText: 'Not Found',
+      text: async () => JSON.stringify({ error: 'Description' })
+    })
+    await expect(
+      salesApi.getLicenceDetails({ firstName: 'Gandalf', lastName: 'Grey', birthDate: '2000-10-03', premises: '59', postcode: 'AB123CD' })
+    ).resolves.toBeNull()
+  })
+})

package/src/sales-api-connector.js

@@ -351,3 +351,30 @@ export const cancelRecurringPayment = async (id, reason = 'Payment Failure') =>
 export const retrieveStagedTransaction = async id => {
   return exec2xxOrThrow(call(new URL(`/retrieveStagedTransaction/${id}`, urlBase), 'get'))
 }
+
+/**
+ * Retrieve licence (or licences) details using name, post code and date of birth
+ *
+ * @param {string} firstName
+ * @param {string} lastName
+ * @param {string} birthDate
+ * @param {string} premises
+ * @param {string} postcode
+ * @returns {Promise<*>}
+ */
+export const getLicenceDetails = async ({ firstName, lastName, birthDate, premises, postcode }) =>
+  exec2xxOrNull(
+    call(
+      new URL(
+        `/licenceDetails?${querystring.stringify({
+          licenseeFirstName: firstName,
+          licenseeLastName: lastName,
+          licenseePremises: premises,
+          licenseePostcode: postcode,
+          licenseeBirthDate: birthDate
+        })}`,
+        urlBase
+      ),
+      'get'
+    )
+  )