@affanhamid/markdown-renderer 2.3.6 → 2.4.0

package/dist/index.cjs

@@ -33,7 +33,8 @@ __export(index_exports, {
   MATH_MARKDOWN_RULES_APPENDIX: () => MATH_MARKDOWN_RULES_APPENDIX,
   MarkdownRenderer: () => markdown_renderer_default,
   normalizeMathMarkdownDelimiters: () => normalizeMathMarkdownDelimiters,
-  renderMarkdownToHtml: () => renderMarkdownToHtml
+  renderMarkdownToHtml: () => renderMarkdownToHtml,
+  tiptapJsonToMarkdown: () => tiptapJsonToMarkdown
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -1140,10 +1141,133 @@ var MarkdownRenderer = ({
   return /* @__PURE__ */ (0, import_jsx_runtime.jsx)("div", { ref: containerRef, className, dangerouslySetInnerHTML: { __html: html } });
 };
 var markdown_renderer_default = MarkdownRenderer;
+
+// src/tiptap-to-markdown.ts
+function renderMarks(text, marks) {
+  if (!marks || marks.length === 0) return text;
+  let result = text;
+  for (const mark of marks) {
+    switch (mark.type) {
+      case "bold":
+        result = `**${result}**`;
+        break;
+      case "italic":
+        result = `*${result}*`;
+        break;
+      case "strike":
+        result = `~~${result}~~`;
+        break;
+      case "code":
+        result = `\`${result}\``;
+        break;
+      case "link": {
+        const href = mark.attrs?.href ?? "";
+        result = `[${result}](${href})`;
+        break;
+      }
+    }
+  }
+  return result;
+}
+function renderInlineContent(nodes) {
+  if (!nodes) return "";
+  return nodes.map((node) => {
+    if (node.type === "text") {
+      return renderMarks(node.text ?? "", node.marks);
+    }
+    if (node.type === "hardBreak") {
+      return "  \n";
+    }
+    if (node.type === "image") {
+      const src = node.attrs?.src ?? "";
+      const alt = node.attrs?.alt ?? "";
+      return `![${alt}](${src})`;
+    }
+    return "";
+  }).join("");
+}
+function renderNode(node, indent = "", listCounter) {
+  switch (node.type) {
+    case "doc":
+      return renderChildren(node.content, indent);
+    case "paragraph":
+      return `${indent}${renderInlineContent(node.content)}`;
+    case "heading": {
+      const level = node.attrs?.level ?? 1;
+      const prefix = "#".repeat(level);
+      return `${prefix} ${renderInlineContent(node.content)}`;
+    }
+    case "bulletList":
+      return (node.content ?? []).map((item) => renderNode(item, indent, void 0)).join("\n");
+    case "orderedList": {
+      const counter = { n: node.attrs?.start ?? 1 };
+      return (node.content ?? []).map((item) => {
+        const result = renderNode(item, indent, counter);
+        counter.n++;
+        return result;
+      }).join("\n");
+    }
+    case "listItem": {
+      const prefix = listCounter ? `${indent}${listCounter.n}. ` : `${indent}- `;
+      const children = node.content ?? [];
+      const parts = [];
+      for (let i = 0; i < children.length; i++) {
+        const child = children[i];
+        if (i === 0 && child.type === "paragraph") {
+          parts.push(`${prefix}${renderInlineContent(child.content)}`);
+        } else if (child.type === "bulletList" || child.type === "orderedList") {
+          parts.push(renderNode(child, indent + "  "));
+        } else if (child.type === "paragraph") {
+          parts.push(`${indent}  ${renderInlineContent(child.content)}`);
+        } else {
+          parts.push(renderNode(child, indent + "  "));
+        }
+      }
+      return parts.join("\n");
+    }
+    case "blockquote":
+      return (node.content ?? []).map((child) => {
+        const line = renderNode(child, indent);
+        return `${indent}> ${line.replace(new RegExp(`^${indent}`), "")}`;
+      }).join("\n");
+    case "codeBlock": {
+      const lang = node.attrs?.language ?? "";
+      const code = (node.content ?? []).map((c) => c.text ?? "").join("");
+      return `${indent}\`\`\`${lang}
+${code}
+${indent}\`\`\``;
+    }
+    case "horizontalRule":
+      return `${indent}---`;
+    case "image": {
+      const src = node.attrs?.src ?? "";
+      const alt = node.attrs?.alt ?? "";
+      return `${indent}![${alt}](${src})`;
+    }
+    case "youtube": {
+      const src = node.attrs?.src ?? "";
+      return `${indent}[YouTube](${src})`;
+    }
+    default:
+      if (node.content) {
+        return renderChildren(node.content, indent);
+      }
+      return "";
+  }
+}
+function renderChildren(nodes, indent = "") {
+  if (!nodes) return "";
+  return nodes.map((node) => renderNode(node, indent)).join("\n\n");
+}
+function tiptapJsonToMarkdown(json) {
+  const doc = typeof json === "string" ? JSON.parse(json) : json;
+  return renderNode(doc).trim();
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   MATH_MARKDOWN_RULES_APPENDIX,
   MarkdownRenderer,
   normalizeMathMarkdownDelimiters,
-  renderMarkdownToHtml
+  renderMarkdownToHtml,
+  tiptapJsonToMarkdown
 });

package/dist/index.d.cts

@@ -19,4 +19,30 @@ declare const MarkdownRenderer: ({ markdown, className, onRunCode, executableLan
 declare function normalizeMathMarkdownDelimiters(markdown: string): string;
 declare const MATH_MARKDOWN_RULES_APPENDIX = "Math formatting rules (must follow):\n- Inline math: use single-dollar delimiters like $...$.\n- Display math: use $$ delimiters on their own lines with nothing else on those lines.\n- Do not use \\(...\\) or \\[...\\] delimiters.\n- Do not place display-math $$...$$ inside bullets or table cells; use inline $...$ there.\n- Escape non-math currency dollars as \\$.";
 
-export { type CodeExecutionResult, MATH_MARKDOWN_RULES_APPENDIX, MarkdownRenderer, type MarkdownRendererProps, normalizeMathMarkdownDelimiters, renderMarkdownToHtml };
+/**
+ * Converts TipTap JSON (ProseMirror document model) to markdown string.
+ *
+ * Supports: paragraphs, headings (1-6), bold, italic, code, strike,
+ * links, images, bullet lists, ordered lists, blockquotes, code blocks,
+ * horizontal rules, hard breaks, and YouTube embeds.
+ */
+interface TipTapMark {
+    type: string;
+    attrs?: Record<string, unknown>;
+}
+interface TipTapNode {
+    type: string;
+    content?: TipTapNode[];
+    text?: string;
+    marks?: TipTapMark[];
+    attrs?: Record<string, unknown>;
+}
+/**
+ * Convert a TipTap JSON document to a markdown string.
+ *
+ * @param json - Either a TipTapNode object or a JSON string of one.
+ * @returns The markdown string representation.
+ */
+declare function tiptapJsonToMarkdown(json: TipTapNode | string): string;
+
+export { type CodeExecutionResult, MATH_MARKDOWN_RULES_APPENDIX, MarkdownRenderer, type MarkdownRendererProps, type TipTapMark, type TipTapNode, normalizeMathMarkdownDelimiters, renderMarkdownToHtml, tiptapJsonToMarkdown };

package/dist/index.d.ts

@@ -19,4 +19,30 @@ declare const MarkdownRenderer: ({ markdown, className, onRunCode, executableLan
 declare function normalizeMathMarkdownDelimiters(markdown: string): string;
 declare const MATH_MARKDOWN_RULES_APPENDIX = "Math formatting rules (must follow):\n- Inline math: use single-dollar delimiters like $...$.\n- Display math: use $$ delimiters on their own lines with nothing else on those lines.\n- Do not use \\(...\\) or \\[...\\] delimiters.\n- Do not place display-math $$...$$ inside bullets or table cells; use inline $...$ there.\n- Escape non-math currency dollars as \\$.";
 
-export { type CodeExecutionResult, MATH_MARKDOWN_RULES_APPENDIX, MarkdownRenderer, type MarkdownRendererProps, normalizeMathMarkdownDelimiters, renderMarkdownToHtml };
+/**
+ * Converts TipTap JSON (ProseMirror document model) to markdown string.
+ *
+ * Supports: paragraphs, headings (1-6), bold, italic, code, strike,
+ * links, images, bullet lists, ordered lists, blockquotes, code blocks,
+ * horizontal rules, hard breaks, and YouTube embeds.
+ */
+interface TipTapMark {
+    type: string;
+    attrs?: Record<string, unknown>;
+}
+interface TipTapNode {
+    type: string;
+    content?: TipTapNode[];
+    text?: string;
+    marks?: TipTapMark[];
+    attrs?: Record<string, unknown>;
+}
+/**
+ * Convert a TipTap JSON document to a markdown string.
+ *
+ * @param json - Either a TipTapNode object or a JSON string of one.
+ * @returns The markdown string representation.
+ */
+declare function tiptapJsonToMarkdown(json: TipTapNode | string): string;
+
+export { type CodeExecutionResult, MATH_MARKDOWN_RULES_APPENDIX, MarkdownRenderer, type MarkdownRendererProps, type TipTapMark, type TipTapNode, normalizeMathMarkdownDelimiters, renderMarkdownToHtml, tiptapJsonToMarkdown };

package/dist/index.js

@@ -1101,9 +1101,132 @@ var MarkdownRenderer = ({
   return /* @__PURE__ */ jsx("div", { ref: containerRef, className, dangerouslySetInnerHTML: { __html: html } });
 };
 var markdown_renderer_default = MarkdownRenderer;
+
+// src/tiptap-to-markdown.ts
+function renderMarks(text, marks) {
+  if (!marks || marks.length === 0) return text;
+  let result = text;
+  for (const mark of marks) {
+    switch (mark.type) {
+      case "bold":
+        result = `**${result}**`;
+        break;
+      case "italic":
+        result = `*${result}*`;
+        break;
+      case "strike":
+        result = `~~${result}~~`;
+        break;
+      case "code":
+        result = `\`${result}\``;
+        break;
+      case "link": {
+        const href = mark.attrs?.href ?? "";
+        result = `[${result}](${href})`;
+        break;
+      }
+    }
+  }
+  return result;
+}
+function renderInlineContent(nodes) {
+  if (!nodes) return "";
+  return nodes.map((node) => {
+    if (node.type === "text") {
+      return renderMarks(node.text ?? "", node.marks);
+    }
+    if (node.type === "hardBreak") {
+      return "  \n";
+    }
+    if (node.type === "image") {
+      const src = node.attrs?.src ?? "";
+      const alt = node.attrs?.alt ?? "";
+      return `![${alt}](${src})`;
+    }
+    return "";
+  }).join("");
+}
+function renderNode(node, indent = "", listCounter) {
+  switch (node.type) {
+    case "doc":
+      return renderChildren(node.content, indent);
+    case "paragraph":
+      return `${indent}${renderInlineContent(node.content)}`;
+    case "heading": {
+      const level = node.attrs?.level ?? 1;
+      const prefix = "#".repeat(level);
+      return `${prefix} ${renderInlineContent(node.content)}`;
+    }
+    case "bulletList":
+      return (node.content ?? []).map((item) => renderNode(item, indent, void 0)).join("\n");
+    case "orderedList": {
+      const counter = { n: node.attrs?.start ?? 1 };
+      return (node.content ?? []).map((item) => {
+        const result = renderNode(item, indent, counter);
+        counter.n++;
+        return result;
+      }).join("\n");
+    }
+    case "listItem": {
+      const prefix = listCounter ? `${indent}${listCounter.n}. ` : `${indent}- `;
+      const children = node.content ?? [];
+      const parts = [];
+      for (let i = 0; i < children.length; i++) {
+        const child = children[i];
+        if (i === 0 && child.type === "paragraph") {
+          parts.push(`${prefix}${renderInlineContent(child.content)}`);
+        } else if (child.type === "bulletList" || child.type === "orderedList") {
+          parts.push(renderNode(child, indent + "  "));
+        } else if (child.type === "paragraph") {
+          parts.push(`${indent}  ${renderInlineContent(child.content)}`);
+        } else {
+          parts.push(renderNode(child, indent + "  "));
+        }
+      }
+      return parts.join("\n");
+    }
+    case "blockquote":
+      return (node.content ?? []).map((child) => {
+        const line = renderNode(child, indent);
+        return `${indent}> ${line.replace(new RegExp(`^${indent}`), "")}`;
+      }).join("\n");
+    case "codeBlock": {
+      const lang = node.attrs?.language ?? "";
+      const code = (node.content ?? []).map((c) => c.text ?? "").join("");
+      return `${indent}\`\`\`${lang}
+${code}
+${indent}\`\`\``;
+    }
+    case "horizontalRule":
+      return `${indent}---`;
+    case "image": {
+      const src = node.attrs?.src ?? "";
+      const alt = node.attrs?.alt ?? "";
+      return `${indent}![${alt}](${src})`;
+    }
+    case "youtube": {
+      const src = node.attrs?.src ?? "";
+      return `${indent}[YouTube](${src})`;
+    }
+    default:
+      if (node.content) {
+        return renderChildren(node.content, indent);
+      }
+      return "";
+  }
+}
+function renderChildren(nodes, indent = "") {
+  if (!nodes) return "";
+  return nodes.map((node) => renderNode(node, indent)).join("\n\n");
+}
+function tiptapJsonToMarkdown(json) {
+  const doc = typeof json === "string" ? JSON.parse(json) : json;
+  return renderNode(doc).trim();
+}
 export {
   MATH_MARKDOWN_RULES_APPENDIX,
   markdown_renderer_default as MarkdownRenderer,
   normalizeMathMarkdownDelimiters,
-  renderMarkdownToHtml
+  renderMarkdownToHtml,
+  tiptapJsonToMarkdown
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@affanhamid/markdown-renderer",
-  "version": "2.3.6",
+  "version": "2.4.0",
   "description": "Custom markdown renderer with KaTeX support",
   "type": "module",
   "main": "dist/index.cjs",