@ditojs/utils 2.69.0 → 2.70.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ditojs/utils",
-  "version": "2.69.0",
+  "version": "2.70.0",
   "type": "module",
   "description": "Dito.js Utility Functions – Dito.js is a declarative and modern web framework, based on Objection.js, Koa.js and Vue.js",
   "repository": "https://github.com/ditojs/dito/tree/master/packages/utils",
@@ -39,5 +39,5 @@
   "devDependencies": {
     "typescript": "^5.9.3"
   },
-  "gitHead": "a2b28ad175cd3280ceadd394c74ba67e12da03af"
+  "gitHead": "2010c0695b5a7296e10c2b6bf2539d552c576fd9"
 }

package/src/__snapshots__/index.test.js.snap

@@ -78,6 +78,7 @@ exports[`index > exports all symbols 1`] = `
   "setDataPathEntries": [Function],
   "setValueAtDataPath": [Function],
   "shuffle": [Function],
+  "stripHtml": [Function],
   "stripTags": [Function],
   "toAsync": [Function],
   "toCallback": [Function],

package/src/html/index.js

@@ -1,2 +1,2 @@
 export * from './escapeHtml.js'
-export * from './stripTags.js'
+export * from './stripHtml.js'

package/src/html/stripHtml.js

@@ -0,0 +1,21 @@
+import { deprecate } from '../function/deprecate.js'
+
+export function stripHtml(html) {
+  return html != null
+    ? html
+        .toString()
+        .replace(/<br\/?>/gi, '\n')
+        .replace(/<[^>]+>/g, '')
+    : ''
+}
+
+/**
+ * @deprecated Use stripHtml() instead
+ */
+export function stripTags(html) {
+  deprecate(
+    'The `stripTags` function is deprecated in favour of `stripHtml`. ' +
+    'Update your code to use `stripHtml` instead.'
+  )
+  return stripHtml(html)
+}

package/src/html/stripHtml.test.js

@@ -0,0 +1,24 @@
+import { stripHtml } from './stripHtml.js'
+
+describe('stripHtml()', () => {
+  it('should remove html tags from strings', () => {
+    expect(stripHtml('<p><b>this</b> is a marked-up string</p>'))
+      .toBe('this is a marked-up string')
+  })
+
+  it('should return an empty string if nothing can be processed', () => {
+    expect(stripHtml()).toBe('')
+    expect(stripHtml(null)).toBe('')
+    expect(stripHtml('')).toBe('')
+  })
+
+  it('should handle falsy values correctly', () => {
+    expect(stripHtml(0)).toBe('0')
+    expect(stripHtml(false)).toBe('false')
+  })
+
+  it('should convert <br> tags to line-breaks', () => {
+    expect(stripHtml('hello<br>world')).toBe('hello\nworld')
+    expect(stripHtml('hello<br/>world')).toBe('hello\nworld')
+  })
+})

package/types/index.d.ts

@@ -702,6 +702,14 @@ export function escapeHtml(html: string): string
  * @param html The string to strip.
  * @returns The newly stripped string.
  */
+export function stripHtml(html: string): string
+
+/**
+ * Strips HTML tags from the string.
+ * @param html The string to strip.
+ * @returns The newly stripped string.
+ * @deprecated Use stripHtml() instead
+ */
 export function stripTags(html: string): string
 
 /* -------------------------- typescript utilities -------------------------- */

package/src/html/stripTags.js

@@ -1,10 +0,0 @@
-// TODO: Rename to stripHtml()
-
-export function stripTags(html) {
-  return html != null
-    ? html
-        .toString()
-        .replace(/<br\/?>/gi, '\n')
-        .replace(/<[^>]+>/g, '')
-    : ''
-}

package/src/html/stripTags.test.js

@@ -1,24 +0,0 @@
-import { stripTags } from './stripTags.js'
-
-describe('stripTags()', () => {
-  it('should remove html tags from strings', () => {
-    expect(stripTags('<p><b>this</b> is a marked-up string</p>'))
-      .toBe('this is a marked-up string')
-  })
-
-  it('should return an empty string if nothing can be processed', () => {
-    expect(stripTags()).toBe('')
-    expect(stripTags(null)).toBe('')
-    expect(stripTags('')).toBe('')
-  })
-
-  it('should handle falsy values correctly', () => {
-    expect(stripTags(0)).toBe('0')
-    expect(stripTags(false)).toBe('false')
-  })
-
-  it('should convert <br> tags to line-breaks', () => {
-    expect(stripTags('hello<br>world')).toBe('hello\nworld')
-    expect(stripTags('hello<br/>world')).toBe('hello\nworld')
-  })
-})