@platecms/delta-cast-util-to-hast 1.18.0 → 1.20.0

package/README.md

@@ -114,7 +114,9 @@ yields (hast):
         {
           "type": "element",
           "tagName": "span",
-          "properties": {},
+          "properties": {
+            "dataPrn": "prn:plate-dev:a7734468-b894-4191-83b1-7d218f8c9922:cms:content-value:b2119c94-24e6-4358-b557-c705dcd19d1d"
+          },
           "children": [
             {
               "type": "text",
@@ -130,5 +132,10 @@ yields (hast):
 
 or yields (html):
 ```html
-<p>My first <span>content</span></p>
+<p>My first <span data-prn="prn:plate-dev:a7734468-b894-4191-83b1-7d218f8c9922:cms:content-value:b2119c94-24e6-4358-b557-c705dcd19d1d">content</span></p>
 ```
+
+The `data-prn` attribute marks the span as an interpolated content value, so
+[cast-util-from-hast](../cast-util-from-hast/README.md) can turn it back into a content value reference.
+[cast-util-to-html](../cast-util-to-html/README.md) sanitizes its output, which removes the attribute, so published
+HTML does not expose PRNs: it yields `<p>My first <span>content</span></p>`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platecms/delta-cast-util-to-hast",
-  "version": "1.18.0",
+  "version": "1.20.0",
   "description": "Utility to convert CAST to HAST syntax tree.",
   "license": "UNLICENSED",
   "publishConfig": {
@@ -17,8 +17,8 @@
     "src/**/*"
   ],
   "dependencies": {
-    "@platecms/delta-cast": "1.18.0",
-    "@platecms/delta-plate-resource-notation": "1.18.0",
+    "@platecms/delta-cast": "1.20.0",
+    "@platecms/delta-plate-resource-notation": "1.20.0",
     "class-transformer": "0.5.1",
     "hast": "1.0.0",
     "reflect-metadata": "0.2.2",

package/src/lib/elements/contentValue.ts

@@ -9,7 +9,8 @@ export function contentValue(node: InterpolatedContentValue, state: object, tran
   return {
     type: "element",
     tagName: "span",
-    properties: {},
+    // Marks the span as an interpolated content value, so cast-util-from-hast can turn it back into one
+    properties: { dataPrn: node.prn },
     children: transformedNode.value ? all(transformedNode.value.children, state, transform) : [],
   };
 }

package/src/lib/elements/highlight.ts

@@ -0,0 +1,13 @@
+import { Highlight } from "@platecms/delta-cast";
+import { Element as HastElement } from "hast";
+import { all } from "..";
+import { NodeTransformers } from "../transformers";
+
+export function highlight(node: Highlight, state: object = {}, transform: NodeTransformers = {}): HastElement {
+  return {
+    type: "element",
+    tagName: "mark",
+    properties: {},
+    children: all(node.children, state, transform),
+  };
+}

package/src/lib/elements/index.ts

@@ -6,7 +6,9 @@ import { paragraph } from "./paragraph";
 import { bold } from "./bold";
 import { italic } from "./italic";
 import { underline } from "./underline";
-import { strikehrough } from "./strikehrough";
+import { strikethrough } from "./strikethrough";
+import { highlight } from "./highlight";
+import { inlineCode } from "./inlineCode";
 import { text } from "./text";
 import { blockquote } from "./blockquote";
 import { link } from "./link";
@@ -22,7 +24,9 @@ export {
   bold,
   italic,
   underline,
-  strikehrough,
+  strikethrough,
+  highlight,
+  inlineCode,
   text,
   blockquote,
 };

package/src/lib/elements/inlineCode.ts

@@ -0,0 +1,14 @@
+import { InlineCode } from "@platecms/delta-cast";
+import { Element as HastElement } from "hast";
+
+/**
+ * Inline code keeps its value as one text node: unlike running text, its newlines are not turned into <br>.
+ */
+export function inlineCode(node: InlineCode): HastElement {
+  return {
+    type: "element",
+    tagName: "code",
+    properties: {},
+    children: [{ type: "text", value: node.value }],
+  };
+}

package/src/lib/elements/{strikehrough.ts → strikethrough.ts}

@@ -3,7 +3,7 @@ import { Element as HastElement } from "hast";
 import { all } from "..";
 import { NodeTransformers } from "../transformers";
 
-export function strikehrough(node: Strikethrough, state: object = {}, transform: NodeTransformers = {}): HastElement {
+export function strikethrough(node: Strikethrough, state: object = {}, transform: NodeTransformers = {}): HastElement {
   return {
     type: "element",
     tagName: "s",

package/src/lib/index.spec.ts

@@ -249,7 +249,7 @@ describe("single nodes", () => {
       children: [
         {
           type: "element",
-          properties: {},
+          properties: { dataPrn: "prn:content-value" },
           tagName: "span",
           children: [
             {
@@ -262,6 +262,65 @@ describe("single nodes", () => {
     });
   });
 
+  it.each([
+    ["strikethrough", "s"],
+    ["highlight", "mark"],
+  ] as const)("should convert %s from cast to hast as %s", (type, tagName) => {
+    // Arrange
+    const cast: Root = c("root", [c("paragraph", [c(type, "Hello, world!")])]);
+
+    // Act
+    const result = toHast(cast);
+
+    // Assert
+    expect(result).toEqual({
+      type: "root",
+      children: [
+        {
+          type: "element",
+          tagName: "p",
+          properties: {},
+          children: [
+            {
+              type: "element",
+              tagName,
+              properties: {},
+              children: [{ type: "text", value: "Hello, world!" }],
+            },
+          ],
+        },
+      ],
+    });
+  });
+
+  it("should convert inline code from cast to hast, keeping newlines as text", () => {
+    // Arrange
+    const cast: Root = c("root", [c("paragraph", [c("inlineCode", { value: "a\nb" })])]);
+
+    // Act
+    const result = toHast(cast);
+
+    // Assert
+    expect(result).toEqual({
+      type: "root",
+      children: [
+        {
+          type: "element",
+          tagName: "p",
+          properties: {},
+          children: [
+            {
+              type: "element",
+              tagName: "code",
+              properties: {},
+              children: [{ type: "text", value: "a\nb" }],
+            },
+          ],
+        },
+      ],
+    });
+  });
+
   describe("links", () => {
     it("should convert an external link from cast to hast", () => {
       // Arrange
@@ -423,7 +482,7 @@ describe("nested nodes", () => {
             },
             {
               type: "element",
-              properties: {},
+              properties: { dataPrn: "prn:content-value:content-value" },
               tagName: "span",
               children: [
                 {
@@ -459,7 +518,7 @@ describe("wihtout transformations", () => {
         children: [
           {
             type: "element",
-            properties: {},
+            properties: { dataPrn: "prn:content-value" },
             tagName: "span",
             children: [
               {

package/src/lib/index.ts

@@ -7,12 +7,14 @@ import {
   code,
   contentValue,
   heading,
+  highlight,
+  inlineCode,
   italic,
   link,
   list,
   listItem,
   paragraph,
-  strikehrough,
+  strikethrough,
   text,
   underline,
 } from "./elements";
@@ -44,7 +46,9 @@ const one = zwitch("type", {
     bold,
     italic,
     underline,
-    strikehrough,
+    strikethrough,
+    highlight,
+    inlineCode,
     text,
     externalLink: link,
     internalLink: link,