@excofy/utils 2.5.0 → 2.6.0

package/dist/index.cjs

@@ -36,6 +36,7 @@ __export(index_exports, {
   cryptoUtils: () => cryptoUtils,
   generateCode: () => generateCode,
   htmlEntityDecode: () => htmlEntityDecode,
+  htmlToPlainText: () => htmlToPlainText,
   numberUtils: () => number_exports,
   slugUtils: () => slug_exports,
   stringUtils: () => stringUtils
@@ -163,6 +164,14 @@ function htmlEntityDecode(str = "") {
     (_, code) => String.fromCharCode(Number.parseInt(code, 16))
   ).replace(/&amp;/g, "&").replace(/&quot;/g, '"').replace(/&apos;/g, "'").replace(/&lt;/g, "<").replace(/&gt;/g, ">");
 }
+function htmlToPlainText(html) {
+  if (!html || typeof html !== "string" || html.length === 0) {
+    return "";
+  }
+  const decodedHtml = htmlEntityDecode(html);
+  const plainText = decodedHtml.replace(/<br\s*\/?>/gi, "\n").replace(/<\/p>/gi, "\n").replace(/<\/li>/gi, "\n").replace(/<li>/gi, "\u2022 ").replace(/<\/?[^>]+(>|$)/g, "").replace(/\n{2,}/g, "\n").trim();
+  return plainText;
+}
 
 // src/helpers/video.ts
 var video = {
@@ -973,6 +982,7 @@ var divide = (numerator, denominator) => {
   cryptoUtils,
   generateCode,
   htmlEntityDecode,
+  htmlToPlainText,
   numberUtils,
   slugUtils,
   stringUtils

package/dist/index.d.cts

@@ -7,6 +7,7 @@ type AllowedTag = Tag | {
     attributes?: Attributes[];
 };
 declare function htmlEntityDecode(str?: string): string;
+declare function htmlToPlainText(html: string): string;
 
 type TMessage = {
     message: string;
@@ -241,4 +242,4 @@ declare class ExpiredTokenError extends CryptoError {
     constructor(message?: string);
 }
 
-export { ExpiredTokenError, InvalidTokenError, createValidator, cryptoUtils, generateCode, htmlEntityDecode, number as numberUtils, slug as slugUtils, stringUtils };
+export { ExpiredTokenError, InvalidTokenError, createValidator, cryptoUtils, generateCode, htmlEntityDecode, htmlToPlainText, number as numberUtils, slug as slugUtils, stringUtils };

package/dist/index.d.ts

@@ -7,6 +7,7 @@ type AllowedTag = Tag | {
     attributes?: Attributes[];
 };
 declare function htmlEntityDecode(str?: string): string;
+declare function htmlToPlainText(html: string): string;
 
 type TMessage = {
     message: string;
@@ -241,4 +242,4 @@ declare class ExpiredTokenError extends CryptoError {
     constructor(message?: string);
 }
 
-export { ExpiredTokenError, InvalidTokenError, createValidator, cryptoUtils, generateCode, htmlEntityDecode, number as numberUtils, slug as slugUtils, stringUtils };
+export { ExpiredTokenError, InvalidTokenError, createValidator, cryptoUtils, generateCode, htmlEntityDecode, htmlToPlainText, number as numberUtils, slug as slugUtils, stringUtils };

package/dist/index.js

@@ -125,6 +125,14 @@ function htmlEntityDecode(str = "") {
     (_, code) => String.fromCharCode(Number.parseInt(code, 16))
   ).replace(/&amp;/g, "&").replace(/&quot;/g, '"').replace(/&apos;/g, "'").replace(/&lt;/g, "<").replace(/&gt;/g, ">");
 }
+function htmlToPlainText(html) {
+  if (!html || typeof html !== "string" || html.length === 0) {
+    return "";
+  }
+  const decodedHtml = htmlEntityDecode(html);
+  const plainText = decodedHtml.replace(/<br\s*\/?>/gi, "\n").replace(/<\/p>/gi, "\n").replace(/<\/li>/gi, "\n").replace(/<li>/gi, "\u2022 ").replace(/<\/?[^>]+(>|$)/g, "").replace(/\n{2,}/g, "\n").trim();
+  return plainText;
+}
 
 // src/helpers/video.ts
 var video = {
@@ -934,6 +942,7 @@ export {
   cryptoUtils,
   generateCode,
   htmlEntityDecode,
+  htmlToPlainText,
   number_exports as numberUtils,
   slug_exports as slugUtils,
   stringUtils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@excofy/utils",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "Biblioteca de utilitários para o Excofy",
   "main": "dist/index.js",
   "type": "module",
@@ -16,7 +16,7 @@
     "typecheck": "tsc --noEmit",
     "prepublishOnly": "npm run build",
     "deploy": "act",
-    "test": "tsx --test 'tests/helpers/crypto.spec.ts' --testTimeout=10000"
+    "test": "tsx --test 'tests/helpers/htmlToPlainText.spec.ts' --testTimeout=10000"
   },
   "repository": {
     "type": "git",
@@ -32,7 +32,7 @@
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
     "@types/big.js": "^6.2.2",
-    "@types/node": "^24.0.3",
+    "@types/node": "^24.10.13",
     "tsup": "^8.5.0",
     "tsx": "^4.20.4",
     "typescript": "^5.8.3"

package/src/helpers/sanitize.ts

@@ -69,7 +69,7 @@ const allAttributes: Attributes[] = [
 
 export function sanitizeValue(
   value: string,
-  allowedTags?: AllowedTag[]
+  allowedTags?: AllowedTag[],
 ): string {
   let whiteList: IWhiteList = {};
 
@@ -109,7 +109,7 @@ export function htmlEntityDecode(str = ''): string {
   return str
     .replace(/&#(\d+);/g, (_, code) => String.fromCharCode(code))
     .replace(/&#x([0-9a-f]+);/gi, (_, code) =>
-      String.fromCharCode(Number.parseInt(code, 16))
+      String.fromCharCode(Number.parseInt(code, 16)),
     )
     .replace(/&/g, '&')
     .replace(/"/g, '"')
@@ -117,3 +117,22 @@ export function htmlEntityDecode(str = ''): string {
     .replace(/&lt;/g, '<')
     .replace(/&gt;/g, '>');
 }
+
+export function htmlToPlainText(html: string): string {
+  if (!html || typeof html !== 'string' || html.length === 0) {
+    return '';
+  }
+
+  const decodedHtml = htmlEntityDecode(html);
+
+  const plainText = decodedHtml
+    .replace(/<br\s*\/?>/gi, '\n')
+    .replace(/<\/p>/gi, '\n')
+    .replace(/<\/li>/gi, '\n')
+    .replace(/<li>/gi, '• ')
+    .replace(/<\/?[^>]+(>|$)/g, '') // Remove outras tags
+    .replace(/\n{2,}/g, '\n') // Remove quebras de linha duplicadas
+    .trim();
+
+  return plainText;
+}

package/src/index.ts

@@ -1,5 +1,5 @@
 import { createValidator } from './helpers/validator';
-import { htmlEntityDecode } from './helpers/sanitize';
+import { htmlEntityDecode, htmlToPlainText } from './helpers/sanitize';
 import { generateCode } from './helpers/generateCode';
 import { stringUtils } from './helpers/string';
 import { cryptoUtils } from './helpers/crypto';
@@ -9,6 +9,7 @@ import * as numberUtils from './helpers/number';
 export {
   createValidator,
   htmlEntityDecode,
+  htmlToPlainText,
   slugUtils,
   numberUtils,
   stringUtils,

package/tests/helpers/htmlToPlainText.spec.ts

@@ -0,0 +1,33 @@
+import test from 'node:test';
+import assert from 'node:assert/strict';
+import { htmlToPlainText } from '../../src/helpers/sanitize';
+
+test('Converte <br> em quebra de linha', () => {
+  const html = 'Linha 1<br>Linha 2';
+  const expected = 'Linha 1\nLinha 2';
+  assert.equal(htmlToPlainText(html), expected);
+});
+
+test('Remove todas as tags HTML exceto marcadores de lista', () => {
+  const html = '<ul><li>Item 1</li><li>Item 2</li></ul>';
+  const expected = '• Item 1\n• Item 2';
+  assert.equal(htmlToPlainText(html), expected);
+});
+
+test('Converte <p> em quebra de linha', () => {
+  const html = '<p>Parágrafo 1</p><p>Parágrafo 2</p>';
+  const expected = 'Parágrafo 1\nParágrafo 2';
+  assert.equal(htmlToPlainText(html), expected);
+});
+
+test('Decodifica entidades HTML', () => {
+  const html = 'Tom &amp; Jerry &lt;3';
+  const expected = 'Tom & Jerry';
+  assert.equal(htmlToPlainText(html), expected);
+});
+
+test('Remove quebras de linha duplicadas', () => {
+  const html = 'Linha 1<br><br>Linha 2';
+  const expected = 'Linha 1\nLinha 2';
+  assert.equal(htmlToPlainText(html), expected);
+});

package/tests/helpers/validator.spec.ts

@@ -0,0 +1,75 @@
+import { describe, it } from 'node:test';
+import assert from 'node:assert/strict';
+import { createValidator } from '../../src/helpers/validator';
+
+describe('validator', () => {
+  describe('asNumber', () => {
+    it('deve converter uma string "10" para o número 10', () => {
+      type InputRaw = { limit: string };
+      type InputParsed = { limit: number };
+
+      const v = createValidator<InputRaw, InputParsed>();
+      v.setInputs({ limit: '10' });
+      v.validate('limit')
+        .isRequired('Limite é obrigatório')
+        .type('string', 'Limite deve ser uma string')
+        .asNumber('Limite deve ser um número válido');
+
+      const inputs = v.getSanitizedInputs();
+
+      assert.equal(inputs.limit, 10);
+      assert.equal(typeof inputs.limit, 'number');
+      assert.equal(v.hasErrors(), false);
+    });
+
+    it('deve adicionar erro quando o valor não pode ser convertido para número', () => {
+      type InputRaw = { limit: string };
+      type InputParsed = { limit: number };
+
+      const v = createValidator<InputRaw, InputParsed>();
+      v.setInputs({ limit: 'abc' });
+      v.validate('limit')
+        .isRequired('Limite é obrigatório')
+        .type('string', 'Limite deve ser uma string')
+        .asNumber('Limite deve ser um número válido');
+
+      assert.equal(v.hasErrors(), true);
+      const errors = v.getFlatErrors();
+      assert.equal(errors.limit[0].message, 'Limite deve ser um número válido');
+    });
+
+    it('deve converter um número diretamente', () => {
+      type InputRaw = { limit: number };
+      type InputParsed = { limit: number };
+
+      const v = createValidator<InputRaw, InputParsed>();
+      v.setInputs({ limit: 25 });
+      v.validate('limit')
+        .isRequired('Limite é obrigatório')
+        .type('number', 'Limite deve ser um número')
+        .asNumber('Limite deve ser um número válido');
+
+      const inputs = v.getSanitizedInputs();
+
+      assert.equal(inputs.limit, 25);
+      assert.equal(typeof inputs.limit, 'number');
+      assert.equal(v.hasErrors(), false);
+    });
+
+    it('deve lidar com valores opcionais quando não fornecidos', () => {
+      type InputRaw = { limit?: string };
+      type InputParsed = { limit?: number };
+
+      const v = createValidator<InputRaw, InputParsed>();
+      v.setInputs({});
+      v.validate('limit')
+        .isNotRequired()
+        .type('string', 'Limite deve ser uma string')
+        .asNumber('Limite deve ser um número válido');
+
+      assert.equal(v.hasErrors(), false);
+      const inputs = v.getSanitizedInputs();
+      assert.equal(inputs.limit, undefined);
+    });
+  });
+});

package/tsconfig.json

@@ -11,7 +11,8 @@
     "strict": true,
     "skipLibCheck": true,
     "resolveJsonModule": true,
-    "isolatedModules": true
+    "isolatedModules": true,
+    "types": ["node"]
   },
   "include": ["src", "tests"],
   "exclude": ["dist", "node_modules", "**/*.test.ts"]