feat: introduce decodeHtmlEntitites function

.changeset/two-cats-vanish.md

@@ -0,0 +1,5 @@
+---
+"@headstartwp/core": minor
+---
+
+Introduces the `decodeHtmlSpecialChars` function.

docs/documentation/03- Utilities/sanitization.md

@@ -55,3 +55,12 @@ import { SafeHtml } from '@headstartwp/core/react';
 <SafeHtml html="<div><p>hello world</p> div content</div>">
 ```
 
+## decodeHtmlSpeciaChars
+
+This function will decode a pre-defined set of html special chars.
+
+```js
+import { decodeHtmlSpeciaChars } from '@headstartwp/core';
+
+decodeHtmlSpeciaChars('Hello world! &#8211; foo bar &#8211');
+```

packages/core/src/utils/__tests__/decodeHtmlSpeciaChars.ts

@@ -0,0 +1,18 @@
+import { decodeHtmlSpeciaChars } from '../decodeHtmlSpeciaChars';
+
+describe('decodeHtmlSpeciaChars', () => {
+	it('decodes html entities', () => {
+		expect(decodeHtmlSpeciaChars('’Hello’')).toBe('’Hello’');
+		expect(decodeHtmlSpeciaChars('’Hi & Hello’')).toBe('’Hi & Hello’');
+		expect(decodeHtmlSpeciaChars('“Hi & Hello”–Bye')).toBe(
+			'“Hi & Hello”–Bye',
+		);
+		expect(decodeHtmlSpeciaChars('"Hi & Hello"…Bye')).toBe(
+			'"Hi & Hello"…Bye',
+		);
+
+		expect(decodeHtmlSpeciaChars('"<Hi & Hello>"…Bye')).toBe(
+			'"<Hi & Hello>"…Bye',
+		);
+	});
+});

packages/core/src/utils/decodeHtmlSpeciaChars.ts

@@ -0,0 +1,24 @@
+/**
+ * Decodes HTML special chars entities
+ *
+ * @param text The text we want to decode
+ *
+ * @returns text with decoded html entities
+ */
+export function decodeHtmlSpeciaChars(text: string) {
+	if (!text) {
+		return '';
+	}
+
+	return text
+		.replace(/’/g, '’')
+		.replace(/&/g, '&')
+		.replace(/“/g, '“')
+		.replace(/”/g, '”')
+		.replace(/–/g, '–')
+		.replace(/…/g, '…')
+		.replace(/"/g, '"')
+		.replace(/&/g, '&')
+		.replace(/&lt;/g, '<')
+		.replace(/&gt;/g, '>');
+}

packages/core/src/utils/index.ts

@@ -7,3 +7,4 @@ export * from './errors';
 export * from './isInternalLink';
 export * from './url';
 export * from './log';
+export * from './decodeHtmlSpeciaChars';