Merge pull request #296 from uktrade/feature/trading-names

feat: Add D&B trading names to D&B company search results
uktrade · Apr 28, 2020 · 38e2f8c · 38e2f8c
2 parents e82da5b + 527f43d
commit 38e2f8c
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 52 deletions.
diff --git a/src/entity-search/EntityList.jsx b/src/entity-search/EntityList.jsx
@@ -29,7 +29,7 @@ EntityList.propTypes = {
     PropTypes.shape({
       id: PropTypes.oneOfType([PropTypes.string, PropTypes.number]).isRequired,
       heading: PropTypes.string.isRequired,
-      meta: PropTypes.object.isRequired,
+      meta: PropTypes.array.isRequired,
       data: PropTypes.object.isRequired,
     })
   ).isRequired,

diff --git a/src/entity-search/EntityListItem.jsx b/src/entity-search/EntityListItem.jsx
@@ -26,15 +26,15 @@ const StyledEntity = styled('div')`
     isClickable &&
     `
     cursor: pointer;
-    
+
     h3 {
       color: ${LINK_COLOUR};
     }
 
     &:hover {
       border: 1px solid ${LINK_HOVER_COLOUR};
       background-color: ${GREY_4};
-      
+
       & > h3 {
         color: ${LINK_HOVER_COLOUR};
       }
@@ -57,12 +57,6 @@ const StyledInsetText = styled(InsetText)`
 `
 
 const EntityListItem = ({ id, onEntityClick, data, text, heading, meta }) => {
-  const metaAsArray = isEmpty(meta)
-    ? null
-    : Object.keys(meta).map((key) => ({
-        label: key,
-        value: meta[key],
-      }))
   return (
     <StyledEntity
       key={`entity_${id}`}
@@ -75,7 +69,7 @@ const EntityListItem = ({ id, onEntityClick, data, text, heading, meta }) => {
     >
       {heading && <StyledHeading>{heading}</StyledHeading>}
 
-      {!isEmpty(meta) && <Metadata rows={metaAsArray} />}
+      {!isEmpty(meta) && <Metadata rows={meta} />}
 
       {text && <StyledInsetText>{text}</StyledInsetText>}
     </StyledEntity>
@@ -88,15 +82,15 @@ EntityListItem.propTypes = {
   data: PropTypes.shape({}),
   text: PropTypes.node,
   heading: PropTypes.string,
-  meta: PropTypes.shape({}),
+  meta: PropTypes.array,
 }
 
 EntityListItem.defaultProps = {
   text: null,
   onEntityClick: null,
   data: {},
   heading: null,
-  meta: null,
+  meta: [],
 }
 
 export default EntityListItem
diff --git a/src/entity-search/__tests__/EntityList.test.jsx b/src/entity-search/__tests__/EntityList.test.jsx
@@ -10,15 +10,15 @@ const entitiesFixture = [
     id: '1',
     name: 'Non-clickable entity',
     heading: 'some heading',
-    meta: {},
+    meta: [],
     data: {},
     canHandleClick: false,
   },
   {
     id: '2',
     name: 'Clickable entity',
     heading: 'some heading',
-    meta: {},
+    meta: [],
     data: { some: 'data' },
     canHandleClick: true,
   },

diff --git a/src/entity-search/__tests__/EntityListItem.test.jsx b/src/entity-search/__tests__/EntityListItem.test.jsx
@@ -147,12 +147,7 @@ describe('EntityListItem', () => {
   })
 
   describe('when the "meta" prop was passed', () => {
-    const meta = {
-      some: 'meta',
-      and: 'more meta',
-    }
-
-    const expectedMeta = [
+    const meta = [
       {
         label: 'some',
         value: 'meta',
@@ -169,7 +164,7 @@ describe('EntityListItem', () => {
 
     test('should render "Metadata" component', () => {
       const metaList = wrapper.find(Metadata)
-      expect(metaList.prop('rows')).toEqual(expectedMeta)
+      expect(metaList.prop('rows')).toEqual(meta)
     })
   })
 })
diff --git a/src/entity-search/__tests__/__snapshots__/useDnbSearch.test.jsx.snap b/src/entity-search/__tests__/__snapshots__/useDnbSearch.test.jsx.snap
@@ -47,9 +47,12 @@ Array [
     },
     "heading": "Some other company",
     "id": "219999999",
-    "meta": Object {
-      "Address": "123 ABC Road, Brighton, BN2 9QB",
-    },
+    "meta": Array [
+      Object {
+        "label": "Location at",
+        "value": "123 ABC Road, Brighton, BN2 9QB",
+      },
+    ],
   },
 ]
 `;
@@ -111,9 +114,16 @@ Array [
     },
     "heading": "Some company name",
     "id": "12345678",
-    "meta": Object {
-      "Address": "123 Fake Street, Brighton, BN1 4SE",
-    },
+    "meta": Array [
+      Object {
+        "label": "Trading name(s)",
+        "value": "Some trading name",
+      },
+      Object {
+        "label": "Location at",
+        "value": "123 Fake Street, Brighton, BN1 4SE",
+      },
+    ],
   },
   Object {
     "data": Object {
@@ -160,9 +170,12 @@ Array [
     },
     "heading": "Some other company",
     "id": "219999999",
-    "meta": Object {
-      "Address": "123 ABC Road, Brighton, BN2 9QB",
-    },
+    "meta": Array [
+      Object {
+        "label": "Location at",
+        "value": "123 ABC Road, Brighton, BN2 9QB",
+      },
+    ],
   },
   Object {
     "data": Object {
@@ -197,9 +210,12 @@ Array [
     },
     "heading": "Dissolvex",
     "id": "219999996",
-    "meta": Object {
-      "Address": "20 New Fake Road, Bristol, B11 9QC",
-    },
+    "meta": Array [
+      Object {
+        "label": "Location at",
+        "value": "20 New Fake Road, Bristol, B11 9QC",
+      },
+    ],
   },
 ]
 `;
@@ -260,9 +276,16 @@ Object {
   },
   "heading": "Some company name",
   "id": "12345678",
-  "meta": Object {
-    "Address": "123 Fake Street, Brighton, BN1 4SE",
-  },
+  "meta": Array [
+    Object {
+      "label": "Trading name(s)",
+      "value": "Some trading name",
+    },
+    Object {
+      "label": "Location at",
+      "value": "123 Fake Street, Brighton, BN1 4SE",
+    },
+  ],
 }
 `;
 
@@ -312,9 +335,12 @@ Object {
   },
   "heading": "Some other company",
   "id": "219999999",
-  "meta": Object {
-    "Address": "123 ABC Road, Brighton, BN2 9QB",
-  },
+  "meta": Array [
+    Object {
+      "label": "Location at",
+      "value": "123 ABC Road, Brighton, BN2 9QB",
+    },
+  ],
 }
 `;
 
@@ -352,8 +378,11 @@ Object {
   },
   "heading": "Dissolvex",
   "id": "219999996",
-  "meta": Object {
-    "Address": "20 New Fake Road, Bristol, B11 9QC",
-  },
+  "meta": Array [
+    Object {
+      "label": "Location at",
+      "value": "20 New Fake Road, Bristol, B11 9QC",
+    },
+  ],
 }
 `;
diff --git a/src/entity-search/useDnbSearch.jsx b/src/entity-search/useDnbSearch.jsx
@@ -1,7 +1,29 @@
 /* eslint-disable camelcase */
 
 import axios from 'axios'
-import { compact } from 'lodash'
+import { compact, isEmpty } from 'lodash'
+
+function getTradingNames(dnb_company) {
+  return isEmpty(dnb_company.trading_names)
+    ? null
+    : {
+        label: 'Trading name(s)',
+        value: dnb_company.trading_names.join(', '),
+      }
+}
+
+function getAddress(dnb_company) {
+  return {
+    label: 'Location at',
+    value: compact([
+      dnb_company.address_line_1,
+      dnb_company.address_line_2,
+      dnb_company.address_town,
+      dnb_company.address_county,
+      dnb_company.address_postcode,
+    ]).join(', '),
+  }
+}
 
 function useDnbSearch(apiEndpoint) {
   function transformCompanyRecord(record) {
@@ -10,15 +32,7 @@ function useDnbSearch(apiEndpoint) {
     return {
       id: dnb_company.duns_number,
       heading: dnb_company.primary_name,
-      meta: {
-        Address: compact([
-          dnb_company.address_line_1,
-          dnb_company.address_line_2,
-          dnb_company.address_town,
-          dnb_company.address_county,
-          dnb_company.address_postcode,
-        ]).join(', '),
-      },
+      meta: compact([getTradingNames(dnb_company), getAddress(dnb_company)]),
       data: record,
     }
   }