@platecms/delta-cast-util-to-html 0.1.0

package/README.md

@@ -0,0 +1,86 @@
+# cast-util-to-html
+
+This library is part of the [CAST]() abstract syntax tree utilities.
+It provides a utility to convert a [CAST]() abstract syntax tree directly to html.
+
+The converter uses cast to hast and hast to html to convert the tree.
+It also sanitizes the html using [rehype-sanitize]() on the Hast syntax tree.
+
+
+## Usage
+
+Using the utility `cast` to html looks as follows:
+```ts
+/**
+ * @import {Root} from 'cast'
+ */
+
+import {toHtml} from '@platecms/delta-cast-util-to-html'
+
+/** @type {Root} */
+const tree = [
+    {
+        type: 'paragraph',
+        children: [
+            { text: 'Hello, world!' }
+        ]
+    },
+    {
+        type: 'heading',
+        level: 1,
+        children: [
+            {
+                type: 'bold',
+                children: [
+                    { 
+                        type: 'text', 
+                        text: 'Hello, world!' 
+                    }
+                ]
+            }
+        ]
+    }
+]
+
+console.info(toHtml(tree))
+```
+
+yields:
+```ts
+const result = {
+    type: 'root',
+    children: [
+        {
+            type: 'element',
+            tagName: 'p',
+            properties: {},
+            children: [
+                { type: 'text', value: 'Hello, world!' }
+            ]
+        },
+        {
+            type: 'element',
+            tagName: 'h1',
+            properties: {},
+            children: [
+                {
+                    type: 'element',
+                    tagName: 'strong',
+                    properties: {},
+                    children: [
+                        { type: 'text', value: 'Hello, world!' }
+                    ]
+                }
+            ]
+        }
+    ]
+}
+```
+
+## Building
+
+Run `nx build cast-util-to-html` to build the library.
+
+## Running unit tests
+
+Run `nx test cast-util-to-html` to execute the unit tests via [Vitest](https://vitest.dev/).

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@platecms/delta-cast-util-to-html",
+  "version": "0.1.0",
+  "description": "Utility to convert CAST directly to HTML using HAST and HAST sanitizing.",
+  "license": "UNLICENSED",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://bitbucket.org/startmetplate/delta.git"
+  },
+  "homepage": "https://bitbucket.org/startmetplate/delta/src/dev/packages/cast-util-to-html",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "files": [
+    "src/**/*"
+  ],
+  "dependencies": {
+    "@platecms/delta-cast": "0.4.8",
+    "@platecms/delta-cast-util-to-hast": "1.1.1",
+    "@platecms/delta-plate-resource-notation": "1.4.1",
+    "class-transformer": "0.5.1",
+    "hast": "1.0.0",
+    "hast-util-sanitize": "5.0.2",
+    "hast-util-to-html": "9.0.4",
+    "lodash": "4.17.21",
+    "reflect-metadata": "0.2.2",
+    "tslib": "2.8.1",
+    "zwitch": "2.0.4"
+  },
+  "type": "commonjs"
+}

package/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Root } from "@platecms/delta-cast";
+import { NodeTransformers } from "@platecms/delta-cast-util-to-hast";
+export declare function toHtml(value: Root, transform?: NodeTransformers): string;

package/src/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toHtml = toHtml;
+const delta_cast_util_to_hast_1 = require("@platecms/delta-cast-util-to-hast");
+const hast_util_sanitize_1 = require("hast-util-sanitize");
+const hast_util_to_html_1 = require("hast-util-to-html");
+function toHtml(value, transform = {
+    contentValue: delta_cast_util_to_hast_1.flattenTextOnlyContentValueNode,
+}) {
+    return (0, hast_util_to_html_1.toHtml)((0, hast_util_sanitize_1.sanitize)((0, delta_cast_util_to_hast_1.toHast)(value, transform)));
+}
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/cast-util-to-html/src/index.ts"],"names":[],"mappings":";;AAYA,wBAOC;AAlBD,+EAA8G;AAC9G,2DAA8C;AAC9C,yDAAyD;AASzD,SAAgB,MAAM,CACpB,KAAW,EACX,YAA8B;IAC5B,YAAY,EAAE,yDAA+B;CAC9C;IAED,OAAO,IAAA,0BAAU,EAAC,IAAA,6BAAQ,EAAC,IAAA,gCAAM,EAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;AACxD,CAAC"}