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

package/README.md

@@ -0,0 +1,55 @@
+# cast-util-to-plaintext
+
+This library is part of the [CAST]() abstract syntax tree utilities.
+It provides a utility to convert a [CAST]() abstract syntax tree directly to plaintext.
+
+## Usage
+
+Using the utility `cast` to plaintext looks as follows:
+```ts
+/**
+ * @import {Root} from 'cast'
+ */
+
+import {toPlaintext} from '@platecms/delta-cast-util-to-plaintext'
+
+/** @type {Root} */
+const tree = [
+    {
+        type: 'paragraph',
+        children: [
+            { text: 'Hello' }
+        ]
+    },
+    {
+        type: 'heading',
+        level: 1,
+        children: [
+            {
+                type: 'bold',
+                children: [
+                    { 
+                        type: 'text', 
+                        text: 'world' 
+                    }
+                ]
+            }
+        ]
+    }
+]
+
+console.info(toPlaintext(tree))
+```
+
+yields:
+```
+'Hello world'
+```
+
+## Building
+
+Run `nx build cast-util-to-plaintext` to build the library.
+
+## Running unit tests
+
+Run `nx test cast-util-to-plaintext` to execute the unit tests via [Vitest](https://vitest.dev/).

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@platecms/delta-cast-util-to-plaintext",
+  "version": "0.1.0",
+  "description": "Utility to convert CAST trees to plaintext.",
+  "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-plaintext",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "files": [
+    "src/**/*"
+  ],
+  "dependencies": {
+    "@platecms/delta-cast": "0.4.8",
+    "@platecms/delta-plate-resource-notation": "1.4.1",
+    "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/index.d.ts

@@ -0,0 +1 @@
+export * from "./lib/index";

package/src/index.js

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

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

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

package/src/lib/index.js

@@ -0,0 +1,74 @@
+"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,
+    },
+    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 defaultHandler(node) {
+    return `Unknown node type (${node.type})`;
+}
+//# sourceMappingURL=index.js.map

package/src/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/cast-util-to-plaintext/src/lib/index.ts"],"names":[],"mappings":";;AAqBA,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;KACL;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,cAAc,CAAC,IAAa;IACnC,OAAO,sBAAsB,IAAI,CAAC,IAAI,GAAG,CAAC;AAC5C,CAAC"}