@platecms/delta-cast-util-to-html 0.6.0 → 0.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platecms/delta-cast-util-to-html",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Utility to convert CAST directly to HTML using HAST and HAST sanitizing.",
   "license": "UNLICENSED",
   "publishConfig": {
@@ -17,9 +17,9 @@
     "src/**/*"
   ],
   "dependencies": {
-    "@platecms/delta-cast": "0.6.0",
-    "@platecms/delta-cast-util-to-hast": "0.6.0",
-    "@platecms/delta-plate-resource-notation": "0.6.0",
+    "@platecms/delta-cast": "0.8.0",
+    "@platecms/delta-cast-util-to-hast": "0.8.0",
+    "@platecms/delta-plate-resource-notation": "0.8.0",
     "class-transformer": "0.5.1",
     "hast": "1.0.0",
     "hast-util-sanitize": "5.0.2",
@@ -28,6 +28,5 @@
     "reflect-metadata": "0.2.2",
     "tslib": "2.8.1",
     "zwitch": "2.0.4"
-  },
-  "type": "commonjs"
+  }
 }

package/src/index.spec.ts

@@ -0,0 +1,15 @@
+import { c } from "@platecms/delta-castscript";
+import { toHtml } from "./index";
+
+describe("cast-util-to-html", () => {
+  it("should convert a Cast Tree to HTML", () => {
+    // Arrange
+    const cast = c("root", [c("paragraph", "Hello, world!")]);
+
+    // Act
+    const html = toHtml(cast);
+
+    // Assert
+    expect(html).toBe("<p>Hello, world!</p>");
+  });
+});

package/src/index.ts

@@ -0,0 +1,20 @@
+import { Root } from "@platecms/delta-cast";
+import { NodeTransformers, flattenTextOnlyContentValueNode, toHast } from "@platecms/delta-cast-util-to-hast";
+import { sanitize } from "hast-util-sanitize";
+import { toHtml as hastToHtml } from "hast-util-to-html";
+
+/*
+ * Convert a Cast Tree to HTML by first converting it to a Hast Tree and then to HTML.
+ * Sanitizes the Hast Tree to prevent XSS attacks.
+ *
+ * @param value - Cast Tree
+ * @returns HTML string
+ */
+export function toHtml(
+  value: Root,
+  transform: NodeTransformers = {
+    contentValue: flattenTextOnlyContentValueNode,
+  },
+): string {
+  return hastToHtml(sanitize(toHast(value, transform)));
+}

package/src/index.d.ts

@@ -1,3 +0,0 @@
-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

@@ -1,12 +0,0 @@
-"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

@@ -1 +0,0 @@
-{"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"}