@scrider/formatter 1.3.2 → 1.3.4

package/dist/index.d.cts

@@ -1292,6 +1292,48 @@ declare function validateDelta(delta: Delta, registry: Registry): boolean;
  */
 declare function cloneDelta(delta: Delta): Delta;
 
+/**
+ * Simple Table HTML presentation options for deltaToHtml (clipboard, export).
+ * Structural data stays in Delta (table-row, table-col-align); this only affects inline styles.
+ */
+/** Column/cell horizontal alignment (GFM subset). */
+type TableCellAlign = 'left' | 'center' | 'right';
+/** Optional styling when serializing Simple Tables to HTML. */
+interface TablePresentation {
+    /** Full 1px border on all cell sides. When true, `line` is ignored. */
+    grid?: boolean;
+    /** Bottom border only (DeepSeek / ChatGPT). Used when `grid` is not true. */
+    line?: boolean;
+    /** Border color as explicit hex (e.g. `#e7e7e7`). */
+    borderColor?: string;
+    /** Background on header cells (`th`). */
+    headerShade?: boolean;
+    /** Background on even table rows in the body (see `isZebraBodyRow`). */
+    zebraRows?: boolean;
+    /** `font-weight: bold` on `th`. */
+    headerBold?: boolean;
+    /** `text-align: center` on `th` (GitHub-style header). */
+    headerCenter?: boolean;
+    /**
+     * Alignment for cells without `table-col-align` in Delta. Never overrides GFM column align.
+     * @default 'left'
+     */
+    defaultCellAlign?: TableCellAlign;
+}
+interface ResolvedTablePresentation {
+    grid: boolean;
+    line: boolean;
+    borderColor: string;
+    headerShade: boolean;
+    zebraRows: boolean;
+    headerBold: boolean;
+    headerCenter: boolean;
+    defaultCellAlign: TableCellAlign;
+}
+declare function resolveTablePresentation(presentation?: TablePresentation): ResolvedTablePresentation;
+/** Match CSS `tr:nth-child(even) td` when header rows precede body in `<table>`. */
+declare function isZebraBodyRow(headerRowCount: number, bodyRowIndex: number): boolean;
+
 /**
  * Delta → HTML Conversion
  *
@@ -1351,6 +1393,11 @@ interface DeltaToHtmlOptions {
      * This enables extensibility without modifying converter internals.
      */
     registry?: Registry;
+    /**
+     * Simple Table presentation (borders, shades, header style) as inline CSS for
+     * Office/HTML export and clipboard. Does not change Delta; omitted = legacy bare `<table>`.
+     */
+    tablePresentation?: TablePresentation;
 }
 /**
  * Convert a Delta to an HTML string
@@ -1816,4 +1863,4 @@ declare function isTableNewlineOp(op: Op | undefined): boolean;
  */
 declare function extractTableRegion(ops: readonly Op[], hintOpIdx: number): TableRegion | null;
 
-export { ALERT_TYPES, type AlertBlockData, type AlertType, type AlignType, BOX_FLOAT_VALUES, BOX_OVERFLOW_VALUES, type BlockContext, type BlockHandler, BlockHandlerRegistry, type BlockRenderOptions, type BoxBlockData, type BoxFloat, type BoxOpAttributes, type BoxOverflow, BrowserDOMAdapter, type CellAlign, type CellData, type ColumnsBlockData, type DOMAdapter, type DOMDocument, type DOMDocumentFragment, type DOMElement, type DOMNode, type DOMNodeList, type DeltaToHtmlOptions, type DeltaToMarkdownOptions, type FootnotesBlockData, type Format, type FormatDefinition, type FormatMatchResult, type FormatScope, type HtmlToDeltaOptions, type ListType, type MarkdownToDeltaOptions, NODE_TYPE, NodeDOMAdapter, Registry, type SanitizeOptions, type TableBlockData, type TableColAlignType, type TableRegion, alertBlockHandler, alignFormat, backgroundFormat, blockFormat, blockquoteFormat, boldFormat, boxBlockHandler, browserAdapter, cloneDelta, codeBlockFormat, codeFormat, colorFormat, columnsBlockHandler, createDefaultBlockHandlers, createDefaultRegistry, defaultBlockFormats, defaultEmbedFormats, defaultFormats, defaultInlineFormats, deltaToHtml, deltaToMarkdown, dividerFormat, escapeHtml, extractBoxOpAttributes, extractTableRegion, fontFormat, footnoteRefFormat, footnotesBlockHandler, formulaFormat, getAdapter, getNamedColors, headerFormat, headerIdFormat, htmlToDelta, imageFormat, indentFormat, isAdapterAvailable, isElement, isRemarkAvailable, isTableNewlineOp, isTextNode, isValidColor, isValidHexColor, italicFormat, kbdFormat, linkFormat, listFormat, markFormat, markdownToDelta, markdownToDeltaSync, nodeAdapter, normalizeDelta, preloadRemark, sanitizeDelta, sizeFormat, slugify, slugifyWithDedup, softBreakFormat, strikeFormat, subscriptFormat, superscriptFormat, tableBlockHandler, tableColAlignFormat, tableColFormat, tableHeaderFormat, tableRowFormat, toHexColor, underlineFormat, unescapeHtml, validateDelta, videoFormat };
+export { ALERT_TYPES, type AlertBlockData, type AlertType, type AlignType, BOX_FLOAT_VALUES, BOX_OVERFLOW_VALUES, type BlockContext, type BlockHandler, BlockHandlerRegistry, type BlockRenderOptions, type BoxBlockData, type BoxFloat, type BoxOpAttributes, type BoxOverflow, BrowserDOMAdapter, type CellAlign, type CellData, type ColumnsBlockData, type DOMAdapter, type DOMDocument, type DOMDocumentFragment, type DOMElement, type DOMNode, type DOMNodeList, type DeltaToHtmlOptions, type DeltaToMarkdownOptions, type FootnotesBlockData, type Format, type FormatDefinition, type FormatMatchResult, type FormatScope, type HtmlToDeltaOptions, type ListType, type MarkdownToDeltaOptions, NODE_TYPE, NodeDOMAdapter, Registry, type ResolvedTablePresentation, type SanitizeOptions, type TableBlockData, type TableCellAlign, type TableColAlignType, type TablePresentation, type TableRegion, alertBlockHandler, alignFormat, backgroundFormat, blockFormat, blockquoteFormat, boldFormat, boxBlockHandler, browserAdapter, cloneDelta, codeBlockFormat, codeFormat, colorFormat, columnsBlockHandler, createDefaultBlockHandlers, createDefaultRegistry, defaultBlockFormats, defaultEmbedFormats, defaultFormats, defaultInlineFormats, deltaToHtml, deltaToMarkdown, dividerFormat, escapeHtml, extractBoxOpAttributes, extractTableRegion, fontFormat, footnoteRefFormat, footnotesBlockHandler, formulaFormat, getAdapter, getNamedColors, headerFormat, headerIdFormat, htmlToDelta, imageFormat, indentFormat, isAdapterAvailable, isElement, isRemarkAvailable, isTableNewlineOp, isTextNode, isValidColor, isValidHexColor, isZebraBodyRow, italicFormat, kbdFormat, linkFormat, listFormat, markFormat, markdownToDelta, markdownToDeltaSync, nodeAdapter, normalizeDelta, preloadRemark, resolveTablePresentation, sanitizeDelta, sizeFormat, slugify, slugifyWithDedup, softBreakFormat, strikeFormat, subscriptFormat, superscriptFormat, tableBlockHandler, tableColAlignFormat, tableColFormat, tableHeaderFormat, tableRowFormat, toHexColor, underlineFormat, unescapeHtml, validateDelta, videoFormat };

package/dist/index.d.ts

@@ -1292,6 +1292,48 @@ declare function validateDelta(delta: Delta, registry: Registry): boolean;
  */
 declare function cloneDelta(delta: Delta): Delta;
 
+/**
+ * Simple Table HTML presentation options for deltaToHtml (clipboard, export).
+ * Structural data stays in Delta (table-row, table-col-align); this only affects inline styles.
+ */
+/** Column/cell horizontal alignment (GFM subset). */
+type TableCellAlign = 'left' | 'center' | 'right';
+/** Optional styling when serializing Simple Tables to HTML. */
+interface TablePresentation {
+    /** Full 1px border on all cell sides. When true, `line` is ignored. */
+    grid?: boolean;
+    /** Bottom border only (DeepSeek / ChatGPT). Used when `grid` is not true. */
+    line?: boolean;
+    /** Border color as explicit hex (e.g. `#e7e7e7`). */
+    borderColor?: string;
+    /** Background on header cells (`th`). */
+    headerShade?: boolean;
+    /** Background on even table rows in the body (see `isZebraBodyRow`). */
+    zebraRows?: boolean;
+    /** `font-weight: bold` on `th`. */
+    headerBold?: boolean;
+    /** `text-align: center` on `th` (GitHub-style header). */
+    headerCenter?: boolean;
+    /**
+     * Alignment for cells without `table-col-align` in Delta. Never overrides GFM column align.
+     * @default 'left'
+     */
+    defaultCellAlign?: TableCellAlign;
+}
+interface ResolvedTablePresentation {
+    grid: boolean;
+    line: boolean;
+    borderColor: string;
+    headerShade: boolean;
+    zebraRows: boolean;
+    headerBold: boolean;
+    headerCenter: boolean;
+    defaultCellAlign: TableCellAlign;
+}
+declare function resolveTablePresentation(presentation?: TablePresentation): ResolvedTablePresentation;
+/** Match CSS `tr:nth-child(even) td` when header rows precede body in `<table>`. */
+declare function isZebraBodyRow(headerRowCount: number, bodyRowIndex: number): boolean;
+
 /**
  * Delta → HTML Conversion
  *
@@ -1351,6 +1393,11 @@ interface DeltaToHtmlOptions {
      * This enables extensibility without modifying converter internals.
      */
     registry?: Registry;
+    /**
+     * Simple Table presentation (borders, shades, header style) as inline CSS for
+     * Office/HTML export and clipboard. Does not change Delta; omitted = legacy bare `<table>`.
+     */
+    tablePresentation?: TablePresentation;
 }
 /**
  * Convert a Delta to an HTML string
@@ -1816,4 +1863,4 @@ declare function isTableNewlineOp(op: Op | undefined): boolean;
  */
 declare function extractTableRegion(ops: readonly Op[], hintOpIdx: number): TableRegion | null;
 
-export { ALERT_TYPES, type AlertBlockData, type AlertType, type AlignType, BOX_FLOAT_VALUES, BOX_OVERFLOW_VALUES, type BlockContext, type BlockHandler, BlockHandlerRegistry, type BlockRenderOptions, type BoxBlockData, type BoxFloat, type BoxOpAttributes, type BoxOverflow, BrowserDOMAdapter, type CellAlign, type CellData, type ColumnsBlockData, type DOMAdapter, type DOMDocument, type DOMDocumentFragment, type DOMElement, type DOMNode, type DOMNodeList, type DeltaToHtmlOptions, type DeltaToMarkdownOptions, type FootnotesBlockData, type Format, type FormatDefinition, type FormatMatchResult, type FormatScope, type HtmlToDeltaOptions, type ListType, type MarkdownToDeltaOptions, NODE_TYPE, NodeDOMAdapter, Registry, type SanitizeOptions, type TableBlockData, type TableColAlignType, type TableRegion, alertBlockHandler, alignFormat, backgroundFormat, blockFormat, blockquoteFormat, boldFormat, boxBlockHandler, browserAdapter, cloneDelta, codeBlockFormat, codeFormat, colorFormat, columnsBlockHandler, createDefaultBlockHandlers, createDefaultRegistry, defaultBlockFormats, defaultEmbedFormats, defaultFormats, defaultInlineFormats, deltaToHtml, deltaToMarkdown, dividerFormat, escapeHtml, extractBoxOpAttributes, extractTableRegion, fontFormat, footnoteRefFormat, footnotesBlockHandler, formulaFormat, getAdapter, getNamedColors, headerFormat, headerIdFormat, htmlToDelta, imageFormat, indentFormat, isAdapterAvailable, isElement, isRemarkAvailable, isTableNewlineOp, isTextNode, isValidColor, isValidHexColor, italicFormat, kbdFormat, linkFormat, listFormat, markFormat, markdownToDelta, markdownToDeltaSync, nodeAdapter, normalizeDelta, preloadRemark, sanitizeDelta, sizeFormat, slugify, slugifyWithDedup, softBreakFormat, strikeFormat, subscriptFormat, superscriptFormat, tableBlockHandler, tableColAlignFormat, tableColFormat, tableHeaderFormat, tableRowFormat, toHexColor, underlineFormat, unescapeHtml, validateDelta, videoFormat };
+export { ALERT_TYPES, type AlertBlockData, type AlertType, type AlignType, BOX_FLOAT_VALUES, BOX_OVERFLOW_VALUES, type BlockContext, type BlockHandler, BlockHandlerRegistry, type BlockRenderOptions, type BoxBlockData, type BoxFloat, type BoxOpAttributes, type BoxOverflow, BrowserDOMAdapter, type CellAlign, type CellData, type ColumnsBlockData, type DOMAdapter, type DOMDocument, type DOMDocumentFragment, type DOMElement, type DOMNode, type DOMNodeList, type DeltaToHtmlOptions, type DeltaToMarkdownOptions, type FootnotesBlockData, type Format, type FormatDefinition, type FormatMatchResult, type FormatScope, type HtmlToDeltaOptions, type ListType, type MarkdownToDeltaOptions, NODE_TYPE, NodeDOMAdapter, Registry, type ResolvedTablePresentation, type SanitizeOptions, type TableBlockData, type TableCellAlign, type TableColAlignType, type TablePresentation, type TableRegion, alertBlockHandler, alignFormat, backgroundFormat, blockFormat, blockquoteFormat, boldFormat, boxBlockHandler, browserAdapter, cloneDelta, codeBlockFormat, codeFormat, colorFormat, columnsBlockHandler, createDefaultBlockHandlers, createDefaultRegistry, defaultBlockFormats, defaultEmbedFormats, defaultFormats, defaultInlineFormats, deltaToHtml, deltaToMarkdown, dividerFormat, escapeHtml, extractBoxOpAttributes, extractTableRegion, fontFormat, footnoteRefFormat, footnotesBlockHandler, formulaFormat, getAdapter, getNamedColors, headerFormat, headerIdFormat, htmlToDelta, imageFormat, indentFormat, isAdapterAvailable, isElement, isRemarkAvailable, isTableNewlineOp, isTextNode, isValidColor, isValidHexColor, isZebraBodyRow, italicFormat, kbdFormat, linkFormat, listFormat, markFormat, markdownToDelta, markdownToDeltaSync, nodeAdapter, normalizeDelta, preloadRemark, resolveTablePresentation, sanitizeDelta, sizeFormat, slugify, slugifyWithDedup, softBreakFormat, strikeFormat, subscriptFormat, superscriptFormat, tableBlockHandler, tableColAlignFormat, tableColFormat, tableHeaderFormat, tableRowFormat, toHexColor, underlineFormat, unescapeHtml, validateDelta, videoFormat };

package/dist/index.js

@@ -2493,6 +2493,68 @@ function slugifyWithDedup(text, usedSlugs) {
   return `${base}-${count}`;
 }
 
+// src/conversion/html/table-presentation.ts
+var DEFAULT_BORDER_COLOR = "#e7e7e7";
+var DEFAULT_HEADER_BG = "#f5f5f5";
+var DEFAULT_ZEBRA_BG = "#fafafa";
+var CELL_PADDING = "6px 13px";
+function resolveTablePresentation(presentation) {
+  return {
+    grid: presentation?.grid === true,
+    line: presentation?.line === true && presentation?.grid !== true,
+    borderColor: presentation?.borderColor ?? DEFAULT_BORDER_COLOR,
+    headerShade: presentation?.headerShade === true,
+    zebraRows: presentation?.zebraRows === true,
+    headerBold: presentation?.headerBold === true,
+    headerCenter: presentation?.headerCenter === true,
+    defaultCellAlign: presentation?.defaultCellAlign ?? "left"
+  };
+}
+function isZebraBodyRow(headerRowCount, bodyRowIndex) {
+  return (headerRowCount + bodyRowIndex + 1) % 2 === 0;
+}
+function isTableCellAlign(value) {
+  return value === "left" || value === "center" || value === "right";
+}
+function tableOpenTag(presentation) {
+  if (!presentation.grid && !presentation.line) {
+    return "<table>";
+  }
+  return `<table style="border-collapse: collapse">`;
+}
+function buildTableCellStyleAttr(params) {
+  const { presentation, cellTag, colAlign, headerRowCount, bodyRowIndex } = params;
+  const parts = [];
+  parts.push(`padding: ${CELL_PADDING}`);
+  const color = presentation.borderColor;
+  if (presentation.grid) {
+    parts.push(`border: 1px solid ${color}`);
+  } else if (presentation.line) {
+    const width = cellTag === "th" ? "1px" : "0.5px";
+    parts.push(`border-bottom: ${width} solid ${color}`);
+  }
+  let textAlign;
+  if (cellTag === "th" && presentation.headerCenter) {
+    textAlign = "center";
+  } else if (isTableCellAlign(colAlign)) {
+    textAlign = colAlign;
+  } else if (colAlign == null || colAlign === "left") {
+    textAlign = presentation.defaultCellAlign;
+  }
+  if (textAlign && textAlign !== "left") {
+    parts.push(`text-align: ${textAlign}`);
+  }
+  if (cellTag === "th" && presentation.headerBold) {
+    parts.push("font-weight: bold");
+  }
+  if (cellTag === "th" && presentation.headerShade) {
+    parts.push(`background-color: ${DEFAULT_HEADER_BG}`);
+  } else if (cellTag === "td" && presentation.zebraRows && bodyRowIndex !== void 0 && isZebraBodyRow(headerRowCount, bodyRowIndex)) {
+    parts.push(`background-color: ${DEFAULT_ZEBRA_BG}`);
+  }
+  return ` style="${parts.join("; ")}"`;
+}
+
 // src/conversion/html/delta-to-html.ts
 function deltaToHtml(delta, options = {}) {
   const lines = splitIntoLines(delta);
@@ -2676,7 +2738,10 @@ function renderTable(tableLines, embedRenderers, pretty, blockHandlers, options)
   const bodyRows = sortedRows.filter(([, r]) => !r.isHeader);
   const indent = pretty ? "  " : "";
   const nl = pretty ? "\n" : "";
-  let html = `<table>${nl}`;
+  const usePresentation = options?.tablePresentation !== void 0;
+  const presentation = usePresentation ? resolveTablePresentation(options.tablePresentation) : null;
+  const headerRowCount = headerRows.length;
+  let html = usePresentation && presentation ? `${tableOpenTag(presentation)}${nl}` : `<table>${nl}`;
   if (headerRows.length > 0) {
     html += `${indent}<thead>${nl}`;
     for (const [, row] of headerRows) {
@@ -2688,13 +2753,16 @@ function renderTable(tableLines, embedRenderers, pretty, blockHandlers, options)
         pretty,
         2,
         blockHandlers,
-        options
+        options,
+        presentation,
+        headerRowCount
       );
     }
     html += `${indent}</thead>${nl}`;
   }
   if (bodyRows.length > 0) {
     html += `${indent}<tbody>${nl}`;
+    let bodyRowIndex = 0;
     for (const [, row] of bodyRows) {
       html += renderTableRow(
         row.cells,
@@ -2704,8 +2772,12 @@ function renderTable(tableLines, embedRenderers, pretty, blockHandlers, options)
         pretty,
         2,
         blockHandlers,
-        options
+        options,
+        presentation,
+        headerRowCount,
+        bodyRowIndex
       );
+      bodyRowIndex += 1;
     }
     html += `${indent}</tbody>${nl}`;
   }
@@ -2713,7 +2785,7 @@ function renderTable(tableLines, embedRenderers, pretty, blockHandlers, options)
   if (pretty) html += "\n";
   return html;
 }
-function renderTableRow(cells, maxCol, cellTag, embedRenderers, pretty, depth, blockHandlers, options) {
+function renderTableRow(cells, maxCol, cellTag, embedRenderers, pretty, depth, blockHandlers, options, presentation, headerRowCount = 0, bodyRowIndex) {
   const indent = pretty ? "  ".repeat(depth) : "";
   const cellIndent = pretty ? "  ".repeat(depth + 1) : "";
   const nl = pretty ? "\n" : "";
@@ -2721,8 +2793,19 @@ function renderTableRow(cells, maxCol, cellTag, embedRenderers, pretty, depth, b
   for (let col = 0; col <= maxCol; col++) {
     const cell = cells.get(col);
     const content = cell ? renderLineContent(cell.ops, embedRenderers, blockHandlers, options) : "";
-    const alignStyle = cell?.colAlign && cell.colAlign !== "left" ? ` style="text-align: ${cell.colAlign}"` : "";
-    html += `${cellIndent}<${cellTag}${alignStyle}>${content}</${cellTag}>${nl}`;
+    let styleAttr = "";
+    if (presentation) {
+      styleAttr = buildTableCellStyleAttr({
+        presentation,
+        cellTag,
+        colAlign: cell?.colAlign,
+        headerRowCount,
+        bodyRowIndex: cellTag === "td" ? bodyRowIndex : void 0
+      });
+    } else {
+      styleAttr = cell?.colAlign && cell.colAlign !== "left" ? ` style="text-align: ${cell.colAlign}"` : "";
+    }
+    html += `${cellIndent}<${cellTag}${styleAttr}>${content}</${cellTag}>${nl}`;
   }
   html += `${indent}</tr>${nl}`;
   return html;
@@ -3120,7 +3203,14 @@ function htmlToDelta(html, options = {}) {
     }
     if (tagName === "br") {
       const hasMarker = node.hasAttribute("data-scrider-embed");
-      if (hasMarker || hasMeaningfulPrevSibling(node)) {
+      if (hasMarker) {
+        context.pushEmbed({ softBreak: true });
+        return;
+      }
+      if (isBrowserEmptyLineFiller(node)) {
+        return;
+      }
+      if (hasMeaningfulPrevSibling(node)) {
         context.pushEmbed({ softBreak: true });
       } else {
         context.pushNewline();
@@ -3575,6 +3665,39 @@ function hasMeaningfulPrevSibling(brNode) {
   }
   return false;
 }
+function isBrowserEmptyLineFiller(brNode) {
+  const parent = brNode.parentNode;
+  if (!parent) return false;
+  const children = parent.childNodes;
+  let prevElement = null;
+  let foundCurrent = false;
+  for (let i = 0; i < children.length; i++) {
+    const child = children[i];
+    if (!child) continue;
+    if (child === brNode) {
+      foundCurrent = true;
+      continue;
+    }
+    if (!foundCurrent) {
+      if (child.nodeType === NODE_TYPE.TEXT_NODE) {
+        const text = (child.textContent ?? "").replace(/[\s\u200B]/g, "");
+        if (text.length > 0) prevElement = null;
+      } else if (isElement(child)) {
+        prevElement = child;
+      }
+    } else {
+      if (child.nodeType === NODE_TYPE.TEXT_NODE) {
+        const text = (child.textContent ?? "").replace(/[\s\u200B]/g, "");
+        if (text.length > 0) return false;
+      } else if (isElement(child)) {
+        const tag = child.tagName?.toLowerCase();
+        if (tag !== "br") return false;
+      }
+    }
+  }
+  if (!prevElement) return false;
+  return prevElement.tagName?.toLowerCase() === "br";
+}
 function findTagHandler(handlers, element, tagName) {
   const className = element.getAttribute("class");
   if (className) {
@@ -5008,6 +5131,7 @@ export {
   isTextNode,
   isValidColor,
   isValidHexColor,
+  isZebraBodyRow,
   italicFormat,
   kbdFormat,
   linkFormat,
@@ -5018,6 +5142,7 @@ export {
   nodeAdapter,
   normalizeDelta,
   preloadRemark,
+  resolveTablePresentation,
   sanitizeDelta,
   sizeFormat,
   slugify,