@voiceflow/slate-serializer 1.4.2 → 1.5.0

package/README.md

@@ -53,3 +53,13 @@ import { serializeToJSX } from '@voiceflow/react-chat/jsx';
 
 const content = <div>{serializeToJSX(slateValue)}</div>;
 ```
+
+### Markdown Serialization
+
+If you want to render the result in a browser you can serialize to JSX.
+
+```tsx
+import { serializeToMarkdown } from '@voiceflow/react-chat/markdown';
+
+const content = <div>{serializeToMarkdown(slateValue)}</div>;
+```

package/build/cjs/serializers/markdown.cjs

@@ -0,0 +1,63 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeToMarkdown = void 0;
+const base_types_1 = require("@voiceflow/base-types");
+const Slate = __importStar(require("slate"));
+const guards_1 = require("../guards.cjs");
+const serializeTextNode = (node) => {
+    const isItalic = node[base_types_1.Text.TextProperty.ITALIC];
+    const isUnderline = node[base_types_1.Text.TextProperty.UNDERLINE];
+    const isStrikeThrough = node[base_types_1.Text.TextProperty.STRIKE_THROUGH];
+    const fontWeight = node[base_types_1.Text.TextProperty.FONT_WEIGHT];
+    let { text } = node;
+    if (isItalic)
+        text = `_${text}_`;
+    if (isUnderline)
+        text = `<u>${text}</u>`;
+    if (isStrikeThrough)
+        text = `~~${text}~~`;
+    if (fontWeight)
+        text = `**${text}**`;
+    return text;
+};
+const serializeLinkElement = (node) => {
+    const children = node.children.map(serializeNodeFactory());
+    return `[${children}](${node.url})`;
+};
+const serializeVariableElement = (node) => `{${node.name}}`;
+const serializeElementNode = (node) => {
+    if ((0, guards_1.isLinkElement)(node))
+        return serializeLinkElement(node);
+    if ((0, guards_1.isVariableElement)(node))
+        return serializeVariableElement(node);
+    return node.children.map(serializeNodeFactory()).join('');
+};
+const serializeNodeFactory = () => (node) => 
+// eslint-disable-next-line no-nested-ternary
+Slate.Text.isText(node) ? serializeTextNode(node) : Slate.Element.isElement(node) ? serializeElementNode(node) : '';
+const serializeToMarkdown = (content) => content.map(serializeNodeFactory()).join('<br/>');
+exports.serializeToMarkdown = serializeToMarkdown;
+//# sourceMappingURL=markdown.cjs.map

package/build/cjs/serializers/markdown.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.cjs","sourceRoot":"","sources":["../../../src/serializers/markdown.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sDAAuD;AACvD,6CAA+B;AAE/B,sCAA6D;AAE7D,MAAM,iBAAiB,GAAG,CAAC,IAAmB,EAAU,EAAE;IACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IACtD,MAAM,eAAe,GAAG,IAAI,CAAC,iBAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;IAC/D,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IAEvD,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IAEpB,IAAI,QAAQ;QAAE,IAAI,GAAG,IAAI,IAAI,GAAG,CAAC;IACjC,IAAI,WAAW;QAAE,IAAI,GAAG,MAAM,IAAI,MAAM,CAAC;IACzC,IAAI,eAAe;QAAE,IAAI,GAAG,KAAK,IAAI,IAAI,CAAC;IAC1C,IAAI,UAAU;QAAE,IAAI,GAAG,KAAK,IAAI,IAAI,CAAC;IAErC,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,IAA0B,EAAU,EAAE;IAClE,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAE3D,OAAO,IAAI,QAAQ,KAAK,IAAI,CAAC,GAAG,GAAG,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,IAA8B,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC;AAEtF,MAAM,oBAAoB,GAAG,CAAC,IAAyB,EAAU,EAAE;IACjE,IAAI,IAAA,sBAAa,EAAC,IAAI,CAAC;QAAE,OAAO,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAC3D,IAAI,IAAA,0BAAiB,EAAC,IAAI,CAAC;QAAE,OAAO,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAEnE,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,oBAAoB,GACxB,GAAG,EAAE,CACL,CAAC,IAAyB,EAAU,EAAE;AACpC,6CAA6C;AAC7C,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAEjH,MAAM,mBAAmB,GAAG,CAAC,OAAgC,EAAU,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAAtH,QAAA,mBAAmB,uBAAmG"}

package/build/cjs/serializers/markdown.d.ts

@@ -0,0 +1,2 @@
+import { BaseText } from '@voiceflow/base-types';
+export declare const serializeToMarkdown: (content: BaseText.SlateTextValue) => string;

package/build/esm/serializers/markdown.d.ts

@@ -0,0 +1,2 @@
+import { BaseText } from '@voiceflow/base-types';
+export declare const serializeToMarkdown: (content: BaseText.SlateTextValue) => string;

package/build/esm/serializers/markdown.mjs

@@ -0,0 +1,36 @@
+import { Text } from '@voiceflow/base-types';
+import * as Slate from 'slate';
+import { isLinkElement, isVariableElement } from '../guards.mjs';
+const serializeTextNode = (node) => {
+    const isItalic = node[Text.TextProperty.ITALIC];
+    const isUnderline = node[Text.TextProperty.UNDERLINE];
+    const isStrikeThrough = node[Text.TextProperty.STRIKE_THROUGH];
+    const fontWeight = node[Text.TextProperty.FONT_WEIGHT];
+    let { text } = node;
+    if (isItalic)
+        text = `_${text}_`;
+    if (isUnderline)
+        text = `<u>${text}</u>`;
+    if (isStrikeThrough)
+        text = `~~${text}~~`;
+    if (fontWeight)
+        text = `**${text}**`;
+    return text;
+};
+const serializeLinkElement = (node) => {
+    const children = node.children.map(serializeNodeFactory());
+    return `[${children}](${node.url})`;
+};
+const serializeVariableElement = (node) => `{${node.name}}`;
+const serializeElementNode = (node) => {
+    if (isLinkElement(node))
+        return serializeLinkElement(node);
+    if (isVariableElement(node))
+        return serializeVariableElement(node);
+    return node.children.map(serializeNodeFactory()).join('');
+};
+const serializeNodeFactory = () => (node) => 
+// eslint-disable-next-line no-nested-ternary
+Slate.Text.isText(node) ? serializeTextNode(node) : Slate.Element.isElement(node) ? serializeElementNode(node) : '';
+export const serializeToMarkdown = (content) => content.map(serializeNodeFactory()).join('<br/>');
+//# sourceMappingURL=markdown.mjs.map

package/build/esm/serializers/markdown.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.mjs","sourceRoot":"","sources":["../../../src/serializers/markdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,IAAI,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAE7D,MAAM,iBAAiB,GAAG,CAAC,IAAmB,EAAU,EAAE;IACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IACtD,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;IAC/D,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IAEvD,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IAEpB,IAAI,QAAQ;QAAE,IAAI,GAAG,IAAI,IAAI,GAAG,CAAC;IACjC,IAAI,WAAW;QAAE,IAAI,GAAG,MAAM,IAAI,MAAM,CAAC;IACzC,IAAI,eAAe;QAAE,IAAI,GAAG,KAAK,IAAI,IAAI,CAAC;IAC1C,IAAI,UAAU;QAAE,IAAI,GAAG,KAAK,IAAI,IAAI,CAAC;IAErC,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,IAA0B,EAAU,EAAE;IAClE,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAE3D,OAAO,IAAI,QAAQ,KAAK,IAAI,CAAC,GAAG,GAAG,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,IAA8B,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC;AAEtF,MAAM,oBAAoB,GAAG,CAAC,IAAyB,EAAU,EAAE;IACjE,IAAI,aAAa,CAAC,IAAI,CAAC;QAAE,OAAO,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAC3D,IAAI,iBAAiB,CAAC,IAAI,CAAC;QAAE,OAAO,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAEnE,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,oBAAoB,GACxB,GAAG,EAAE,CACL,CAAC,IAAyB,EAAU,EAAE;AACpC,6CAA6C;AAC7C,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAExH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAgC,EAAU,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@voiceflow/slate-serializer",
   "type": "module",
   "description": "Utilities for serializing slate data",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "author": "Ben Teichman",
   "bugs": {
     "url": "https://github.com/voiceflow/slate-serializer/issues"
@@ -58,6 +58,10 @@
       "import": "./build/esm/serializers/text.mjs",
       "require": "./build/cjs/serializers/text.cjs"
     },
+    "./markdown": {
+      "import": "./build/esm/serializers/markdown.mjs",
+      "require": "./build/cjs/serializers/markdown.cjs"
+    },
     "./jsx": {
       "import": "./build/esm/serializers/jsx.mjs",
       "require": "./build/cjs/serializers/jsx.cjs"
@@ -112,6 +116,9 @@
       ],
       "jsx": [
         "./build/esm/serializers/jsx.d.ts"
+      ],
+      "markdown": [
+        "./build/esm/serializers/markdown.d.ts"
       ]
     }
   }