@platecms/delta-cast-util-to-plaintext 0.4.1 → 0.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platecms/delta-cast-util-to-plaintext",
-  "version": "0.4.1",
+  "version": "0.7.0",
   "description": "Utility to convert CAST trees to plaintext.",
   "license": "UNLICENSED",
   "publishConfig": {
@@ -17,13 +17,12 @@
     "src/**/*"
   ],
   "dependencies": {
-    "@platecms/delta-cast": "0.4.1",
-    "@platecms/delta-plate-resource-notation": "0.4.1",
+    "@platecms/delta-cast": "0.7.0",
+    "@platecms/delta-plate-resource-notation": "0.7.0",
     "class-transformer": "0.5.1",
     "reflect-metadata": "0.2.2",
     "tslib": "2.8.1",
     "zwitch": "2.0.4",
     "lodash": "4.17.21"
-  },
-  "type": "commonjs"
+  }
 }

package/src/lib/index.spec.ts

@@ -0,0 +1,132 @@
+import { describe, expect, it } from "vitest";
+import { toPlaintext } from "./index";
+import { c } from "@platecms/delta-castscript";
+import { Root } from "@platecms/delta-cast";
+
+describe("single nodes", () => {
+  it("should convert a paragraph from cast to plaintext", () => {
+    // Arrange
+    const cast: Root = c("root", [c("paragraph", "Hello, world!")]);
+
+    // Act
+    const expected = toPlaintext(cast);
+
+    // Assert
+    expect(expected).toEqual("Hello, world!");
+  });
+
+  it("should convert a heading from cast to plaintext", () => {
+    // Arrange
+    const cast: Root = c("root", [c("heading", "HELLO, WORLD!", { level: 1 })]);
+
+    // Act
+    const expected = toPlaintext(cast);
+
+    // Assert
+    expect(expected).toEqual("HELLO, WORLD!");
+  });
+
+  it("should convert a list from cast to plaintext", () => {
+    // Arrange
+    const cast: Root = c("root", [
+      c("list", { ordered: true }, [c("listItem", "First item"), c("listItem", "Second item")]),
+    ]);
+
+    // Act
+    const expected = toPlaintext(cast);
+
+    // Assert
+    expect(expected).toEqual("First item Second item");
+  });
+
+  it("should convert a blockquote from from cast to plaintext", () => {
+    // Arrange
+    const cast: Root = c("root", [c("blockquote", "Block quote")]);
+
+    // Act
+    const expected = toPlaintext(cast);
+
+    // Assert
+    expect(expected).toEqual("Block quote");
+  });
+
+  it("should convert code from cast to plaintext", () => {
+    // Arrange
+    const cast: Root = c("root", [c("code", [c("text", "Code block")])]);
+
+    // Act
+    const expected = toPlaintext(cast);
+
+    // Assert
+    expect(expected).toEqual("Code block");
+  });
+
+  it("should convert a content value from cast to plaintext", () => {
+    // Arrange
+    const cast: Root = c("root", [
+      c(
+        "contentValue",
+        {
+          prn: "prn:content-value",
+          value: c("root", [c("paragraph", "Content Value")]),
+        },
+        [c("text", "")],
+      ),
+    ]);
+
+    // Act
+    const expected = toPlaintext(cast);
+
+    // Assert
+    expect(expected).toEqual("Content Value");
+  });
+
+  it("should convert a link from cast to plaintext", () => {
+    // Arrange
+    const cast: Root = c("root", [c("externalLink", { url: "https://www.google.com" }, [c("text", "Google")])]);
+
+    // Act
+    const expected = toPlaintext(cast);
+
+    // Assert
+    expect(expected).toEqual("Google");
+  });
+
+  it("should convert an internal link from cast to plaintext", () => {
+    // Arrange
+    const cast: Root = c("root", [
+      c("internalLink", { url: "https://www.google.com#anchor-name", prn: "prn:grid-placement:grid-placement" }, [
+        c("text", "Google"),
+      ]),
+    ]);
+
+    // Act
+    const expected = toPlaintext(cast);
+
+    // Assert
+    expect(expected).toEqual("Google");
+  });
+});
+
+describe("nested nodes", () => {
+  it("should convert a nested tree from cast to plaintext", () => {
+    // Arrange
+    const tree: Root = c("root", [
+      c("list", { ordered: false }, [c("listItem", [c("bold", "List item")])]),
+      c("paragraph", [
+        c("text", "Hello, world!"),
+        c("contentValue", {
+          prn: "prn:content-value:content-value",
+          value: c("root", [c("paragraph", "Content Value")]),
+        }),
+        c("externalLink", { url: "https://www.google.com" }, [c("text", "Google")]),
+      ]),
+    ]);
+
+    // Act
+    const expected = toPlaintext(tree);
+
+    // Assert
+    expect(expected).toEqual("List item Hello, world! Content Value Google");
+  });
+});

package/src/lib/index.ts

@@ -0,0 +1,132 @@
+import {
+  Blockquote,
+  Bold,
+  Root as CastRoot,
+  Code,
+  Content,
+  ExternalLink,
+  Heading,
+  InternalLink,
+  InterpolatedContentValue,
+  Italic,
+  List,
+  ListItem,
+  Paragraph,
+  Strikethrough,
+  Text,
+  Underline,
+} from "@platecms/delta-cast";
+import { zwitch } from "zwitch";
+
+// default separator for joining nested nodes, avoids the default of joining with a comma
+const separator = " ";
+
+export function toPlaintext(value: CastRoot): string {
+  // eslint-disable-next-line @typescript-eslint/no-use-before-define
+  return all(value.children, {}).join(separator);
+}
+
+const one = zwitch("type", {
+  handlers: {
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    heading,
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    list,
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    listItem,
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    blockquote,
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    code,
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    paragraph,
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    contentValue,
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    bold,
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    italic,
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    underline,
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    strikethrough,
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    text,
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    externalLink: link,
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    internalLink: link,
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    internalAnchorLink: link,
+  },
+  // eslint-disable-next-line @typescript-eslint/no-use-before-define
+  unknown: (value: unknown, _: object = {}) => defaultHandler(value as Content),
+});
+
+function all(nodes: Content[], state: object = {}): string[] {
+  let index = -1;
+  const results = [];
+
+  while (++index < nodes.length) {
+    const result = one(nodes[index], state);
+    results.push(result);
+  }
+
+  return results;
+}
+
+function heading(node: Heading, state: object = {}): string {
+  return all(node.children, state).join(separator);
+}
+
+function list(node: List, state: object = {}): string {
+  return all(node.children, state).join(separator);
+}
+
+function listItem(node: ListItem, state: object = {}): string {
+  return all(node.children, state).join(separator);
+}
+
+function code(node: Code, state: object = {}): string {
+  return all((node as Code & { children: Text[] }).children, state).join(separator);
+}
+
+function contentValue(node: InterpolatedContentValue): string {
+  return node.value ? toPlaintext(node.value) : "";
+}
+
+function paragraph(node: Paragraph, state: object = {}): string {
+  return all(node.children, state).join(separator);
+}
+
+function bold(node: Bold, state: object = {}): string {
+  return all(node.children, state).join(separator);
+}
+
+function italic(node: Italic, state: object = {}): string {
+  return all(node.children, state).join(separator);
+}
+
+function underline(node: Underline, state: object = {}): string {
+  return all(node.children, state).join(separator);
+}
+
+function strikethrough(node: Strikethrough, state: object = {}): string {
+  return all(node.children, state).join(separator);
+}
+
+function text(node: Text): string {
+  return node.value;
+}
+
+function blockquote(node: Blockquote): string {
+  return all(node.children).join(separator);
+}
+
+function link(node: ExternalLink | InternalLink): string {
+  return all(node.children).join(separator);
+}
+
+function defaultHandler(node: Content): string {
+  return `Unknown node type (${node.type})`;
+}

package/src/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./lib/index"), exports);
-//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/cast-util-to-plaintext/src/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B"}

package/src/lib/index.d.ts

@@ -1,2 +0,0 @@
-import { Root as CastRoot } from "@platecms/delta-cast";
-export declare function toPlaintext(value: CastRoot): string;

package/src/lib/index.js

@@ -1,80 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toPlaintext = toPlaintext;
-const zwitch_1 = require("zwitch");
-const separator = " ";
-function toPlaintext(value) {
-    return all(value.children, {}).join(separator);
-}
-const one = (0, zwitch_1.zwitch)("type", {
-    handlers: {
-        heading,
-        list,
-        listItem,
-        blockquote,
-        code,
-        paragraph,
-        contentValue,
-        bold,
-        italic,
-        underline,
-        strikethrough,
-        text,
-        externalLink: link,
-        internalLink: link,
-        internalAnchorLink: link,
-    },
-    unknown: (value, _ = {}) => defaultHandler(value),
-});
-function all(nodes, state = {}) {
-    let index = -1;
-    const results = [];
-    while (++index < nodes.length) {
-        const result = one(nodes[index], state);
-        results.push(result);
-    }
-    return results;
-}
-function heading(node, state = {}) {
-    return all(node.children, state).join(separator);
-}
-function list(node, state = {}) {
-    return all(node.children, state).join(separator);
-}
-function listItem(node, state = {}) {
-    return all(node.children, state).join(separator);
-}
-function code(node, state = {}) {
-    return all(node.children, state).join(separator);
-}
-function contentValue(node) {
-    return node.value ? toPlaintext(node.value) : "";
-}
-function paragraph(node, state = {}) {
-    return all(node.children, state).join(separator);
-}
-function bold(node, state = {}) {
-    return all(node.children, state).join(separator);
-}
-function italic(node, state = {}) {
-    return all(node.children, state).join(separator);
-}
-function underline(node, state = {}) {
-    return all(node.children, state).join(separator);
-}
-function strikethrough(node, state = {}) {
-    return all(node.children, state).join(separator);
-}
-function text(node) {
-    return node.value;
-}
-function blockquote(node) {
-    return all(node.children).join(separator);
-}
-function link(node) {
-    return all(node.children).join(separator);
-}
-function defaultHandler(node) {
-    return `Unknown node type (${node.type})`;
-}
-//# sourceMappingURL=index.js.map

package/src/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/cast-util-to-plaintext/src/lib/index.ts"],"names":[],"mappings":";;AAuBA,kCAGC;AARD,mCAAgC;AAGhC,MAAM,SAAS,GAAG,GAAG,CAAC;AAEtB,SAAgB,WAAW,CAAC,KAAe;IAEzC,OAAO,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACjD,CAAC;AAED,MAAM,GAAG,GAAG,IAAA,eAAM,EAAC,MAAM,EAAE;IACzB,QAAQ,EAAE;QAER,OAAO;QAEP,IAAI;QAEJ,QAAQ;QAER,UAAU;QAEV,IAAI;QAEJ,SAAS;QAET,YAAY;QAEZ,IAAI;QAEJ,MAAM;QAEN,SAAS;QAET,aAAa;QAEb,IAAI;QAEJ,YAAY,EAAE,IAAI;QAElB,YAAY,EAAE,IAAI;QAElB,kBAAkB,EAAE,IAAI;KACzB;IAED,OAAO,EAAE,CAAC,KAAc,EAAE,IAAY,EAAE,EAAE,EAAE,CAAC,cAAc,CAAC,KAAgB,CAAC;CAC9E,CAAC,CAAC;AAEH,SAAS,GAAG,CAAC,KAAgB,EAAE,QAAgB,EAAE;IAC/C,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC;IACf,MAAM,OAAO,GAAG,EAAE,CAAC;IAEnB,OAAO,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,OAAO,CAAC,IAAa,EAAE,QAAgB,EAAE;IAChD,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,IAAI,CAAC,IAAU,EAAE,QAAgB,EAAE;IAC1C,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,QAAQ,CAAC,IAAc,EAAE,QAAgB,EAAE;IAClD,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,IAAI,CAAC,IAAU,EAAE,QAAgB,EAAE;IAC1C,OAAO,GAAG,CAAE,IAAoC,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACpF,CAAC;AAED,SAAS,YAAY,CAAC,IAA8B;IAClD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACnD,CAAC;AAED,SAAS,SAAS,CAAC,IAAe,EAAE,QAAgB,EAAE;IACpD,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,IAAI,CAAC,IAAU,EAAE,QAAgB,EAAE;IAC1C,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,MAAM,CAAC,IAAY,EAAE,QAAgB,EAAE;IAC9C,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,SAAS,CAAC,IAAe,EAAE,QAAgB,EAAE;IACpD,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,aAAa,CAAC,IAAmB,EAAE,QAAgB,EAAE;IAC5D,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,IAAI,CAAC,IAAU;IACtB,OAAO,IAAI,CAAC,KAAK,CAAC;AACpB,CAAC;AAED,SAAS,UAAU,CAAC,IAAgB;IAClC,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AAC5C,CAAC;AAED,SAAS,IAAI,CAAC,IAAiC;IAC7C,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AAC5C,CAAC;AAED,SAAS,cAAc,CAAC,IAAa;IACnC,OAAO,sBAAsB,IAAI,CAAC,IAAI,GAAG,CAAC;AAC5C,CAAC"}