rename JSON transformer to HTML, get rid of JSON references

Author: pokornyd

README.md

@@ -25,9 +25,9 @@ Install the package via npm
 
 ![Module API](media/resolver-api-overview.png)
 
-### Parsing rich text HTML to a JSON tree
+### Parsing rich text HTML to an array of simplified nodes
 
-The tool provides environment-aware (browser or Node.js) `parseHtml` function to transform HTML into an array of simplified JSON trees. Any valid HTML is parsed, including all attributes. Together with built-in transformation methods, this tool is a suitable option for processing HTML and rich text from external sources, to make it compatible with Kontent.ai rich text format. See dedicated [JSON transformer docs](docs/index.md) for further information.
+The tool provides environment-aware (browser or Node.js) `parseHtml` function to transform HTML into an array of `DomNode` trees. Any valid HTML is parsed, including all attributes. Together with built-in transformation methods, this tool is a suitable option for processing HTML and rich text from external sources, to make it compatible with Kontent.ai rich text format. See dedicated [HTML transformer docs](docs/index.md) for further information.
 
 ### Portable text resolution
 
@@ -291,8 +291,7 @@ Package exports a `traversePortableText` method, which accepts an array of `Port
   const richTextContent =
     `<p>Here is an <a data-item-id="12345"><strong>internal link</strong></a> in some text.</p>`;
 
-  const tree = parseHtml(richTextContent);
-  const portableText = transformToPortableText(tree);
+  const portableText = transformToPortableText(richTextContent);
 
   // your logic to modify the portable text
 
@@ -302,7 +301,7 @@ Package exports a `traversePortableText` method, which accepts an array of `Port
 > [!IMPORTANT]  
 > MAPI transformation logic expects Portable Text that had been previously created from management API rich text and performs only minimal validation. It doesn't provide implicit transformation capabilities from other formats (such as delivery API).
 >
-> If you're interested in transforming external HTML or rich text to a MAPI compatible format, see [JSON transformer docs](docs/index.md) instead.
+> If you're interested in transforming external HTML or rich text to a MAPI compatible format, see [HTML transformer docs](docs/index.md) instead.
 
 [last-commit]: https://img.shields.io/github/last-commit/kontent-ai/rich-text-resolver-js?style=for-the-badge
 [contributors-shield]: https://img.shields.io/github/contributors/kontent-ai/rich-text-resolver-js?style=for-the-badge

docs/index.md

@@ -1,4 +1,4 @@
-# JSON Transformers
+# HTML Transformers
 
 This module provides an environment-aware (browser or Node.js) `parseHtml` function to convert an HTML string into an array of nodes. The resulting array can subsequently be modified by one of the provided functions and transformed back to HTML.
 

package.json

@@ -23,9 +23,9 @@
       "import": "./dist/esnext/src/parser/index.js",
       "require": "./dist/cjs/src/parser/index.js"
     },
-    "./transformers/json": {
-      "import": "./dist/esnext/src/transformers/json-transformer/json-transformer.js",
-      "require": "./dist/cjs/src/transformers/json-transformer/json-transformer.js"
+    "./transformers/html": {
+      "import": "./dist/esnext/src/transformers/html-transformer/html-transformer.js",
+      "require": "./dist/cjs/src/transformers/html-transformer/html-transformer.js"
     },
     "./transformers/portable-text": {
       "import": "./dist/esnext/src/transformers/portable-text-transformer/portable-text-transformer.js",

src/transformers/json-transformer/json-transformer.ts renamed to src/transformers/html-transformer/html-transformer.ts

@@ -0,0 +1 @@
+export * from "./html-transformer.js";

src/transformers/html-transformer/index.ts

@@ -1,3 +1,3 @@
-export * from "./json-transformer/index.js";
+export * from "./html-transformer/index.js";
 export * from "./portable-text-transformer/index.js";
 export * from "./transformer-models.js";