@pixerate/editor 0.18.0 → 0.20.0

package/dist/serializers/index.d.ts

@@ -1,9 +1,19 @@
 import { Schema, Slice } from '@tiptap/pm/model';
-import { a as MentionEntity } from '../mention-Dcevh3ff.js';
+import { r as TrackedChangesView, h as MentionEntity } from '../track-changes-G8JcWB8b.js';
 import '@tiptap/core';
 import '@tiptap/extension-mention';
 import '@tiptap/suggestion';
+import '@tiptap/pm/state';
 
+interface PlainTextOptions {
+    /**
+     * How tracked changes (`TrackChanges` extension) appear in the text.
+     * Defaults to `"accepted"`: deleted text is dropped and inserted text kept,
+     * so suggested deletions never leak into exported text. `"original"` drops
+     * insertions and keeps deletions; `"all"` keeps both.
+     */
+    trackedChanges?: TrackedChangesView;
+}
 /**
  * Escapes characters that have syntactic meaning in HTML text.
  */
@@ -23,12 +33,13 @@ declare function plainTextToSlice(text: string, schema: Schema): Slice;
 /**
  * Extracts plain text from an HTML string or TipTap HTML, preserving newlines between block tags.
  */
-declare function htmlToPlainText(html: string): string;
+declare function htmlToPlainText(html: string, options?: PlainTextOptions): string;
 /**
  * Extracts plain text from a TipTap editor instance, preserving newline separators
- * between block nodes and converting mention nodes to @label.
+ * between block nodes and converting mention nodes to @label. Tracked changes
+ * are rendered as accepted unless `options.trackedChanges` says otherwise.
  */
-declare function getEditorText(editor: any): string;
+declare function getEditorText(editor: any, options?: PlainTextOptions): string;
 interface ExtractedMention {
     id: string;
     label: string;
@@ -101,6 +112,21 @@ declare function parseMentionSegments(content: string): MentionSegment[];
  */
 declare function preprocessMarkdownMentions(content: string, optionsOrMentionables?: MentionEntity[] | PreprocessMarkdownMentionsOptions): string;
 
+interface SanitizeHtmlOptions {
+    /**
+     * What to do with tags outside the allowlist: `escape` (default) renders
+     * them as literal text, `strip` removes the tag but keeps its text content.
+     */
+    disallowedTags?: "escape" | "strip";
+}
+/**
+ * Sanitizes raw HTML with the same allowlist the markdown renderer applies to
+ * embedded HTML: event handlers, `style` and unsafe URL schemes are dropped,
+ * and disallowed tags are escaped (or removed with `disallowedTags: "strip"`).
+ * It is string-based, so it works without a DOM and never runs handlers.
+ */
+declare function sanitizeHtml(html: string, options?: SanitizeHtmlOptions): string;
+
 /**
  * Preprocesses file-protocol and editor-protocol links in markdown content:
  * converts [label](file://...), vscode://, and cursor:// links into anchor tags
@@ -141,7 +167,94 @@ declare function markdownToTipTapHtml(markdown: string, options?: MarkdownToHtml
  * Extracts clean markdown from a TipTap editor instance.
  * If the editor has the Markdown extension configured, it uses editor.storage.markdown.getMarkdown().
  * Otherwise, it falls back to getEditorText(editor).
+ * Tracked changes are exported as accepted unless `options.trackedChanges`
+ * says otherwise (`"all"` renders deletions as `~~strikethrough~~`).
+ */
+declare function getEditorMarkdown(editor: any, options?: PlainTextOptions): string;
+
+/**
+ * Sanitizes a full HTML document or fragment for insertion into the editor,
+ * e.g. an imported `.html` file or HTML from another application.
+ *
+ * - Keeps only the `<body>` content when the input is a full document.
+ * - Removes comments, doctype/XML declarations, CDATA, scripts, styles and
+ *   other non-text elements together with their content.
+ * - Applies the same tag/attribute/URL allowlist as embedded HTML in markdown
+ *   (see `sanitizeHtml`), but strips disallowed tags instead of escaping them,
+ *   so wrappers such as `<section>` or `<font>` keep their text.
+ *
+ * It is string-based (no live DOM), so handlers such as `<img onerror>` never run.
+ */
+declare function sanitizeImportedHtml(html: string): string;
+/**
+ * Converts untrusted plain text to TipTap paragraph HTML, always escaping it.
+ *
+ * Unlike `plainTextToTipTapHtml`, text that already looks like `<p>…</p>` is
+ * not passed through as HTML, which matters for imported files.
+ */
+declare function plainTextToParagraphHtml(text: string): string;
+
+/**
+ * Best-effort plain-text extraction from an RTF document.
+ *
+ * Handles paragraphs/line breaks/tabs, escaped braces and backslashes,
+ * `\'hh` hex escapes (decoded as Windows-1252), `\uN` Unicode escapes with
+ * their `\ucN` fallback characters, common typographic control words, and
+ * skips metadata destinations (font/colour tables, `\info`, pictures, field
+ * instructions, `\*` destinations). Formatting (bold, lists, tables) is not
+ * preserved. Input that does not start with `{\rtf` is returned unchanged.
+ */
+declare function rtfToPlainText(rtf: string): string;
+
+/**
+ * Custom clipboard MIME type for content copied from a @pixerate/editor
+ * rich-text editor. It carries the ProseMirror slice as JSON so pasting back
+ * into a compatible editor is lossless (no HTML round trip).
+ */
+declare const PIXERATE_DOCUMENT_MIME = "application/x.pixerate.document+json";
+/** Payload written under {@link PIXERATE_DOCUMENT_MIME}. */
+interface RichClipboardPayload {
+    version: 1;
+    /** {@link getSchemaSignature} of the source editor's schema. */
+    schema: string;
+    /** `Slice.toJSON()` of the copied selection. */
+    slice: {
+        content?: unknown[];
+        openStart?: number;
+        openEnd?: number;
+    } | null;
+}
+/**
+ * Returns a stable signature for a ProseMirror schema: node names, content
+ * expressions, groups, attribute names and mark names. Two editors with the
+ * same extensions produce the same signature, so a slice copied from one can
+ * be deserialized in the other without losing or rejecting nodes.
+ */
+declare function getSchemaSignature(schema: Schema): string;
+/** Serializes a slice into the {@link PIXERATE_DOCUMENT_MIME} payload string. */
+declare function serializeRichClipboardPayload(slice: Slice, schema: Schema): string;
+/**
+ * Parses a {@link PIXERATE_DOCUMENT_MIME} payload into a slice for `schema`.
+ * Returns `null` (so callers fall back to HTML / plain text) when the payload
+ * is malformed, from another payload version, or from an editor whose schema
+ * signature differs.
+ */
+declare function parseRichClipboardPayload(data: string | null | undefined, schema: Schema): Slice | null;
+/** Minimal clipboard data surface (`DataTransfer`). */
+interface ClipboardDataLike {
+    getData(format: string): string;
+    setData(format: string, data: string): void;
+    clearData?(format?: string): void;
+}
+/**
+ * Returns the `clipboardData` of a native `ClipboardEvent` or of a React
+ * synthetic clipboard event (which wraps the native event in `nativeEvent`).
+ */
+declare function getClipboardData(event: unknown): ClipboardDataLike | null;
+/**
+ * Reads a slice from a paste event's {@link PIXERATE_DOCUMENT_MIME} data.
+ * Returns `null` when the data is missing or its schema does not match.
  */
-declare function getEditorMarkdown(editor: any): string;
+declare function readRichClipboard(event: unknown, schema: Schema, mimeType?: string): Slice | null;
 
-export { type ExtractedMention, MARKDOWN_MENTION_SPLIT_REGEX, MENTION_REGEX, type MarkdownToHtmlOptions, type MentionSegment, type PreprocessMarkdownMentionsOptions, escapeHtml, extractMentions, extractMentionsFromDoc, getEditorMarkdown, getEditorText, htmlToPlainText, markdownToTipTapHtml, parseMentionSegments, plainTextToSlice, plainTextToTipTapHtml, preprocessMarkdownFileLinks, preprocessMarkdownMentions, stripMarkdownCode };
+export { type ClipboardDataLike, type ExtractedMention, MARKDOWN_MENTION_SPLIT_REGEX, MENTION_REGEX, type MarkdownToHtmlOptions, type MentionSegment, PIXERATE_DOCUMENT_MIME, type PlainTextOptions, type PreprocessMarkdownMentionsOptions, type RichClipboardPayload, type SanitizeHtmlOptions, escapeHtml, extractMentions, extractMentionsFromDoc, getClipboardData, getEditorMarkdown, getEditorText, getSchemaSignature, htmlToPlainText, markdownToTipTapHtml, parseMentionSegments, parseRichClipboardPayload, plainTextToParagraphHtml, plainTextToSlice, plainTextToTipTapHtml, preprocessMarkdownFileLinks, preprocessMarkdownMentions, readRichClipboard, rtfToPlainText, sanitizeHtml, sanitizeImportedHtml, serializeRichClipboardPayload, stripMarkdownCode };

package/dist/serializers/index.js

@@ -1,3 +1,15 @@
+import "../chunk-N7FG6CBO.js";
+import {
+  PIXERATE_DOCUMENT_MIME,
+  getClipboardData,
+  getSchemaSignature,
+  parseRichClipboardPayload,
+  plainTextToParagraphHtml,
+  readRichClipboard,
+  rtfToPlainText,
+  sanitizeImportedHtml,
+  serializeRichClipboardPayload
+} from "../chunk-KYRZDWM4.js";
 import {
   MARKDOWN_MENTION_SPLIT_REGEX,
   MENTION_REGEX,
@@ -13,23 +25,34 @@ import {
   plainTextToTipTapHtml,
   preprocessMarkdownFileLinks,
   preprocessMarkdownMentions,
+  sanitizeHtml,
   stripMarkdownCode
-} from "../chunk-QGVMBCT5.js";
+} from "../chunk-3TYMNULT.js";
 export {
   MARKDOWN_MENTION_SPLIT_REGEX,
   MENTION_REGEX,
+  PIXERATE_DOCUMENT_MIME,
   escapeHtml,
   extractMentions,
   extractMentionsFromDoc,
+  getClipboardData,
   getEditorMarkdown,
   getEditorText,
+  getSchemaSignature,
   htmlToPlainText,
   markdownToTipTapHtml,
   parseMentionSegments,
+  parseRichClipboardPayload,
+  plainTextToParagraphHtml,
   plainTextToSlice,
   plainTextToTipTapHtml,
   preprocessMarkdownFileLinks,
   preprocessMarkdownMentions,
+  readRichClipboard,
+  rtfToPlainText,
+  sanitizeHtml,
+  sanitizeImportedHtml,
+  serializeRichClipboardPayload,
   stripMarkdownCode
 };
 //# sourceMappingURL=index.js.map

package/dist/spreadsheet/index.cjs

@@ -16,7 +16,6 @@
 
 
 
-var _chunkYQCI4CCNcjs = require('../chunk-YQCI4CCN.cjs');
 
 
 
@@ -35,5 +34,126 @@ var _chunkYQCI4CCNcjs = require('../chunk-YQCI4CCN.cjs');
 
 
 
-exports.DataSourceBinder = _chunkYQCI4CCNcjs.DataSourceBinder; exports.DependencyGraph = _chunkYQCI4CCNcjs.DependencyGraph; exports.FORMULA_ERRORS = _chunkYQCI4CCNcjs.FORMULA_ERRORS; exports.FormulaEvaluator = _chunkYQCI4CCNcjs.FormulaEvaluator; exports.FormulaParser = _chunkYQCI4CCNcjs.FormulaParser; exports.SpreadsheetController = _chunkYQCI4CCNcjs.SpreadsheetController; exports.WHOLE_COLUMN_END_ROW = _chunkYQCI4CCNcjs.WHOLE_COLUMN_END_ROW; exports.colNameToIndex = _chunkYQCI4CCNcjs.colNameToIndex; exports.columnDependencyKey = _chunkYQCI4CCNcjs.columnDependencyKey; exports.extractCellDependencies = _chunkYQCI4CCNcjs.extractCellDependencies; exports.indexToColName = _chunkYQCI4CCNcjs.indexToColName; exports.isFormulaError = _chunkYQCI4CCNcjs.isFormulaError; exports.parseCellReference = _chunkYQCI4CCNcjs.parseCellReference; exports.parseFormula = _chunkYQCI4CCNcjs.parseFormula; exports.parseRange = _chunkYQCI4CCNcjs.parseRange; exports.shiftFormulaReferences = _chunkYQCI4CCNcjs.shiftFormulaReferences; exports.tokenizeFormula = _chunkYQCI4CCNcjs.tokenizeFormula;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+var _chunkU6NDQFOKcjs = require('../chunk-U6NDQFOK.cjs');
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+var _chunkJYRIOFENcjs = require('../chunk-JYRIOFEN.cjs');
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+exports.DEFAULT_COLUMN_WIDTH = _chunkU6NDQFOKcjs.DEFAULT_COLUMN_WIDTH; exports.DEFAULT_ROW_HEIGHT = _chunkU6NDQFOKcjs.DEFAULT_ROW_HEIGHT; exports.DataSourceBinder = _chunkU6NDQFOKcjs.DataSourceBinder; exports.DependencyGraph = _chunkU6NDQFOKcjs.DependencyGraph; exports.FORMULA_ERRORS = _chunkJYRIOFENcjs.FORMULA_ERRORS; exports.FormulaEvaluator = _chunkJYRIOFENcjs.FormulaEvaluator; exports.FormulaParser = _chunkJYRIOFENcjs.FormulaParser; exports.SPREADSHEET_CLIPBOARD_MIME = _chunkU6NDQFOKcjs.SPREADSHEET_CLIPBOARD_MIME; exports.SPREADSHEET_IMPORT_ADAPTERS = _chunkU6NDQFOKcjs.SPREADSHEET_IMPORT_ADAPTERS; exports.SPREADSHEET_TABLE_ACTIONS = _chunkU6NDQFOKcjs.SPREADSHEET_TABLE_ACTIONS; exports.SpreadsheetController = _chunkU6NDQFOKcjs.SpreadsheetController; exports.WHOLE_COLUMN_END_ROW = _chunkJYRIOFENcjs.WHOLE_COLUMN_END_ROW; exports.aggregateValues = _chunkU6NDQFOKcjs.aggregateValues; exports.applyFormulaSuggestion = _chunkU6NDQFOKcjs.applyFormulaSuggestion; exports.bindSpreadsheetTableActions = _chunkU6NDQFOKcjs.bindSpreadsheetTableActions; exports.buildSpreadsheetView = _chunkU6NDQFOKcjs.buildSpreadsheetView; exports.checkFormulaArgumentCount = _chunkJYRIOFENcjs.checkFormulaArgumentCount; exports.colNameToIndex = _chunkJYRIOFENcjs.colNameToIndex; exports.columnDependencyKey = _chunkU6NDQFOKcjs.columnDependencyKey; exports.compareCellValues = _chunkU6NDQFOKcjs.compareCellValues; exports.computeFillTarget = _chunkU6NDQFOKcjs.computeFillTarget; exports.computeRowGroups = _chunkU6NDQFOKcjs.computeRowGroups; exports.createSpreadsheetClipboardData = _chunkU6NDQFOKcjs.createSpreadsheetClipboardData; exports.csvImportAdapter = _chunkU6NDQFOKcjs.csvImportAdapter; exports.describeFormulaError = _chunkJYRIOFENcjs.describeFormulaError; exports.escapeCsvField = _chunkU6NDQFOKcjs.escapeCsvField; exports.extractCellDependencies = _chunkU6NDQFOKcjs.extractCellDependencies; exports.fillSeries = _chunkU6NDQFOKcjs.fillSeries; exports.formatValueWithCode = _chunkJYRIOFENcjs.formatValueWithCode; exports.getFillDirection = _chunkU6NDQFOKcjs.getFillDirection; exports.getFormulaArgumentSpecIndex = _chunkJYRIOFENcjs.getFormulaArgumentSpecIndex; exports.getFormulaCaretContext = _chunkU6NDQFOKcjs.getFormulaCaretContext; exports.getFormulaFunction = _chunkJYRIOFENcjs.getFormulaFunction; exports.getFormulaHints = _chunkU6NDQFOKcjs.getFormulaHints; exports.getFormulaSignature = _chunkJYRIOFENcjs.getFormulaSignature; exports.getFormulaSignatureParts = _chunkJYRIOFENcjs.getFormulaSignatureParts; exports.getRowSection = _chunkU6NDQFOKcjs.getRowSection; exports.getSpreadsheetMenuItems = _chunkU6NDQFOKcjs.getSpreadsheetMenuItems; exports.getTableSections = _chunkU6NDQFOKcjs.getTableSections; exports.importFileIntoSpreadsheet = _chunkU6NDQFOKcjs.importFileIntoSpreadsheet; exports.indexToColName = _chunkJYRIOFENcjs.indexToColName; exports.isBlankValue = _chunkU6NDQFOKcjs.isBlankValue; exports.isFormulaError = _chunkJYRIOFENcjs.isFormulaError; exports.isSingleCellRange = _chunkU6NDQFOKcjs.isSingleCellRange; exports.listFormulaFunctions = _chunkJYRIOFENcjs.listFormulaFunctions; exports.mapFormulaReferences = _chunkU6NDQFOKcjs.mapFormulaReferences; exports.matchesFilterRule = _chunkU6NDQFOKcjs.matchesFilterRule; exports.normalizeRange = _chunkU6NDQFOKcjs.normalizeRange; exports.offsetFormulaReferences = _chunkU6NDQFOKcjs.offsetFormulaReferences; exports.parseCellReference = _chunkJYRIOFENcjs.parseCellReference; exports.parseCriteria = _chunkJYRIOFENcjs.parseCriteria; exports.parseCsv = _chunkU6NDQFOKcjs.parseCsv; exports.parseFormula = _chunkJYRIOFENcjs.parseFormula; exports.parseHtmlTable = _chunkU6NDQFOKcjs.parseHtmlTable; exports.parseRange = _chunkJYRIOFENcjs.parseRange; exports.parseTsv = _chunkU6NDQFOKcjs.parseTsv; exports.rangeContains = _chunkU6NDQFOKcjs.rangeContains; exports.rangeContainsRange = _chunkU6NDQFOKcjs.rangeContainsRange; exports.rangesIntersect = _chunkU6NDQFOKcjs.rangesIntersect; exports.readSpreadsheetClipboard = _chunkU6NDQFOKcjs.readSpreadsheetClipboard; exports.rebaseClipboardRows = _chunkU6NDQFOKcjs.rebaseClipboardRows; exports.registerFormulaFunction = _chunkJYRIOFENcjs.registerFormulaFunction; exports.registerSpreadsheetImportAdapters = _chunkU6NDQFOKcjs.registerSpreadsheetImportAdapters; exports.remapFormulaReferences = _chunkU6NDQFOKcjs.remapFormulaReferences; exports.roundFloat = _chunkU6NDQFOKcjs.roundFloat; exports.rowPassesFilters = _chunkU6NDQFOKcjs.rowPassesFilters; exports.searchFormulaFunctions = _chunkJYRIOFENcjs.searchFormulaFunctions; exports.serializeCsv = _chunkU6NDQFOKcjs.serializeCsv; exports.serializeHtmlTable = _chunkU6NDQFOKcjs.serializeHtmlTable; exports.serializeTsv = _chunkU6NDQFOKcjs.serializeTsv; exports.shiftFormulaReferences = _chunkU6NDQFOKcjs.shiftFormulaReferences; exports.toNumber = _chunkU6NDQFOKcjs.toNumber; exports.tokenizeFormula = _chunkJYRIOFENcjs.tokenizeFormula; exports.tsvImportAdapter = _chunkU6NDQFOKcjs.tsvImportAdapter; exports.unregisterFormulaFunction = _chunkJYRIOFENcjs.unregisterFormulaFunction; exports.wildcardToRegExp = _chunkJYRIOFENcjs.wildcardToRegExp;
 //# sourceMappingURL=index.cjs.map

package/dist/spreadsheet/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["/home/runner/work/editor/editor/packages/core/dist/spreadsheet/index.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,yDAA8B;AAC9B;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,sjCAAC","file":"/home/runner/work/editor/editor/packages/core/dist/spreadsheet/index.cjs"}
+{"version":3,"sources":["/home/runner/work/editor/editor/packages/core/dist/spreadsheet/index.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,yDAA8B;AAC9B;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,yDAA8B;AAC9B;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,+9JAAC","file":"/home/runner/work/editor/editor/packages/core/dist/spreadsheet/index.cjs"}