chore(@dpc-sdp/ripple-tide-api): rename function to getPlainText

dpc-sdp · Oct 21, 2024 · af6d095 · af6d095
1 parent e2e003e
commit af6d095
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/packages/nuxt-ripple/mapping/site/index.ts b/packages/nuxt-ripple/mapping/site/index.ts
@@ -5,7 +5,7 @@ import {
   getMediaPath,
   getLinkFromField,
   getSiteKeyValues,
-  stripNewLines,
+  getPlainText,
   TideSiteApi
 } from '@dpc-sdp/ripple-tide-api'
 import {
@@ -55,7 +55,7 @@ export default {
         : '<p>If you need a response, please use our <a href="/contact-us" class="rpl-text-link rpl-u-focusable-inline">contact us form</a>.</p>'
     },
     acknowledgementFooter: (src: any) => {
-      return stripNewLines(src?.field_acknowledgement_to_country)
+      return getPlainText(src?.field_acknowledgement_to_country)
     },
     copyrightHtml: (src: any) => {
       return getBody(src.field_site_footer_text?.processed)

diff --git a/packages/ripple-tide-api/src/utils/mapping-utils.test.ts b/packages/ripple-tide-api/src/utils/mapping-utils.test.ts
@@ -9,7 +9,7 @@ import {
   getSiteKeyValues,
   getSiteSection,
   humanizeFilesize,
-  stripNewLines
+  getPlainText
 } from './mapping-utils.js'
 
 const field = {
@@ -225,7 +225,7 @@ describe('ripple-tide-api/mapping utils', () => {
   })
 
   it(`returns a single line of text without line breaks`, () => {
-    expect(stripNewLines(field.field_acknowledgement_to_country)).toEqual(
+    expect(getPlainText(field.field_acknowledgement_to_country)).toEqual(
       'We acknowledge Aboriginal and Torres Strait Islander people as the First People and traditional owners and custodians of the lands, seas and waters of Australia. We pay our respect to Elders past and present.'
     )
   })

diff --git a/packages/ripple-tide-api/src/utils/mapping-utils.ts b/packages/ripple-tide-api/src/utils/mapping-utils.ts
@@ -247,7 +247,7 @@ export const getSiteSection = (sectionId: string, src: any) => {
 /**
  * @description strips line returns i.e. new line from the supplied content, returning a 'single' line
  */
-export const stripNewLines = (content: string): string => {
+export const getPlainText = (content: string): string => {
   return content?.replace(/(\r\n|\n|\r)/g, '')?.trim()
 }
 
@@ -263,5 +263,5 @@ export default {
   getDocumentFromField,
   getSiteKeyValues,
   getSiteSection,
-  stripNewLines
+  getPlainText
 }
diff --git a/packages/ripple-tide-landing-page/mapping/components/generic-card-mapping.ts b/packages/ripple-tide-landing-page/mapping/components/generic-card-mapping.ts
@@ -4,7 +4,7 @@ import {
   getCardImageFromField,
   getImageFromField,
   getLinkFromField,
-  stripNewLines
+  getPlainText
 } from '@dpc-sdp/ripple-tide-api'
 
 export interface ITideCardMeta {
@@ -59,7 +59,7 @@ const getCardSummary = (field: { [key: string]: any }) => {
 
   const summary = linkedSummary ? linkedSummary : ownSummary
 
-  return stripNewLines(summary)
+  return getPlainText(summary)
 }
 
 const getCardImage = (field: {}): TideImageField => {

diff --git a/packages/ripple-tide-landing-page/mapping/hero-header/hero-header-mapping.ts b/packages/ripple-tide-landing-page/mapping/hero-header/hero-header-mapping.ts
@@ -2,7 +2,7 @@ import {
   getField,
   getLinkFromField,
   getImageFromField,
-  stripNewLines
+  getPlainText
 } from '@dpc-sdp/ripple-tide-api'
 import type { TideUrlField } from '@dpc-sdp/ripple-tide-api/types'
 import { TideHeroHeader } from '@dpc-sdp/nuxt-ripple/types'
@@ -15,7 +15,7 @@ const getIntroText = (src) => {
     src.field_page_intro_text ||
     ''
 
-  return stripNewLines(introText)
+  return getPlainText(introText)
 }
 
 const getHeaderTheme = (src) => {