@ctzhian/tiptap 2.3.2-beta.6 → 2.3.2-beta.7

package/dist/extension/index.js

@@ -44,8 +44,7 @@ export var getExtensions = function getExtensions(_ref) {
     dropcursor: {
       color: 'var(--mui-palette-primary-main)',
       width: 2
-    },
-    trailingNode: false
+    }
   }), TextStyleKit, CodeExtension, ListExtension, EmojiExtension, AlertExtension, CustomSubscript, DetailsExtension, CustomSuperscript, DetailsContentExtension, DetailsSummaryExtension, CodeBlockLowlightExtension, InlineUploadProgressExtension, YamlFormat, InlineLinkExtension, BlockLinkExtension, CustomHorizontalRule, IframeExtension({
     onError: onError,
     onValidateUrl: onValidateUrl

package/dist/extension/node/TableOfContents/index.js

@@ -6,13 +6,17 @@ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol"
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 import { getHierarchicalIndexes, TableOfContents } from '@tiptap/extension-table-of-contents';
 import { Plugin, PluginKey } from '@tiptap/pm/state';
+import { TableOfContentsPlugin } from "./plugin";
 export var TableOfContentsExtension = function TableOfContentsExtension(_ref) {
   var onTocUpdate = _ref.onTocUpdate,
     tableOfContentsOptions = _ref.tableOfContentsOptions;
   return TableOfContents.extend({
     addProseMirrorPlugins: function addProseMirrorPlugins() {
       var imeCompositionPluginKey = new PluginKey('imeComposition');
-      return [new Plugin({
+      return [TableOfContentsPlugin({
+        getId: this.options.getId,
+        anchorTypes: this.options.anchorTypes
+      }), new Plugin({
         key: new PluginKey('tableOfContentImeFix'),
         appendTransaction: function appendTransaction(transactions, _oldState, newState) {
           if (transactions.some(function (tr) {

package/dist/extension/node/TableOfContents/plugin.d.ts

@@ -0,0 +1,6 @@
+import type { NodeType } from '@tiptap/pm/model';
+import { Plugin } from '@tiptap/pm/state';
+export declare const TableOfContentsPlugin: ({ getId, anchorTypes, }: {
+    getId?: ((textContent: string) => string) | undefined;
+    anchorTypes?: (string | NodeType)[] | undefined;
+}) => Plugin<any>;

package/dist/extension/node/TableOfContents/plugin.js

@@ -0,0 +1,58 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+import { Plugin, PluginKey } from '@tiptap/pm/state';
+import { v4 as uuidv4 } from 'uuid';
+export var TableOfContentsPlugin = function TableOfContentsPlugin(_ref) {
+  var getId = _ref.getId,
+    _ref$anchorTypes = _ref.anchorTypes,
+    anchorTypes = _ref$anchorTypes === void 0 ? ['heading'] : _ref$anchorTypes;
+  return new Plugin({
+    key: new PluginKey('tableOfContent'),
+    appendTransaction: function appendTransaction(transactions, oldState, newState) {
+      var _view;
+      // 若处于组合输入，完全避免在此事务中写入 id，交由扩展层异步生成
+      if ((_view = newState.view) !== null && _view !== void 0 && _view.composing || typeof document !== 'undefined' && document.composing || typeof window !== 'undefined' && window.compositionState) {
+        return null;
+      }
+
+      // 检查是否有任何事务包含组合相关的变化
+      var hasCompositionChanges = transactions.some(function (tr) {
+        return tr.getMeta('composition') || tr.getMeta('compositionend') || tr.getMeta('compositionstart');
+      });
+      if (hasCompositionChanges) {
+        return null;
+      }
+      var tr = newState.tr;
+      var modified = false;
+      if (transactions.some(function (transaction) {
+        return transaction.docChanged;
+      }) && !oldState.doc.eq(newState.doc)) {
+        var existingIds = [];
+        newState.doc.descendants(function (node, pos) {
+          var nodeId = node.attrs.id;
+          if (!anchorTypes.includes(node.type.name) || node.textContent.length === 0) {
+            return;
+          }
+          if (nodeId === null || nodeId === undefined || existingIds.includes(nodeId)) {
+            var id = '';
+            if (getId) {
+              id = getId(node.textContent);
+            } else {
+              id = uuidv4();
+            }
+            tr.setNodeMarkup(pos, undefined, _objectSpread(_objectSpread({}, node.attrs), {}, {
+              id: id
+            }));
+            modified = true;
+          }
+          existingIds.push(nodeId);
+        });
+      }
+      return modified ? tr : null;
+    }
+  });
+};

package/dist/extension/node/TableOfContents/tableOfContents.d.ts

@@ -0,0 +1,8 @@
+import { TocList } from "../../../type";
+import { Extension } from '@tiptap/core';
+import { TableOfContentsOptions, TableOfContentsStorage } from '@tiptap/extension-table-of-contents';
+export declare const TableOfContentsExtension: Extension<TableOfContentsOptions, TableOfContentsStorage>;
+export declare const TableOfContents: ({ onTocUpdate }: {
+    onTocUpdate?: ((toc: TocList) => void) | undefined;
+}) => Extension<TableOfContentsOptions, TableOfContentsStorage>;
+export default TableOfContents;

package/dist/extension/node/TableOfContents/tableOfContents.js

@@ -0,0 +1,313 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
+import { Extension } from '@tiptap/core';
+import { getHeadlineLevel, getHierarchicalIndexes, getLinearIndexes } from '@tiptap/extension-table-of-contents';
+import { v4 as uuidv4 } from 'uuid';
+import { TableOfContentsPlugin } from "./plugin";
+var addTocActiveStatesAndGetItems = function addTocActiveStatesAndGetItems(content, options) {
+  var editor = options.editor;
+  var headlines = [];
+  var scrolledOverIds = [];
+  var activeId = null;
+  if (editor.isDestroyed) {
+    return content;
+  }
+  editor.state.doc.descendants(function (node, pos) {
+    var _options$anchorTypes;
+    var isValidType = (_options$anchorTypes = options.anchorTypes) === null || _options$anchorTypes === void 0 ? void 0 : _options$anchorTypes.includes(node.type.name);
+    if (!isValidType) {
+      return;
+    }
+    headlines.push({
+      node: node,
+      pos: pos
+    });
+  });
+  headlines.forEach(function (headline) {
+    var domElement = editor.view.domAtPos(headline.pos + 1).node;
+    var scrolledOver = options.storage.scrollPosition >= domElement.offsetTop;
+    if (scrolledOver) {
+      activeId = headline.node.attrs.id;
+      scrolledOverIds.push(headline.node.attrs.id);
+    }
+  });
+  return content.map(function (heading) {
+    return _objectSpread(_objectSpread({}, heading), {}, {
+      isActive: heading.id === activeId,
+      isScrolledOver: scrolledOverIds.includes(heading.id)
+    });
+  });
+};
+var setTocData = function setTocData(options) {
+  var editor = options.editor,
+    onUpdate = options.onUpdate;
+  if (editor.isDestroyed) {
+    return;
+  }
+  var headlines = [];
+  var anchors = [];
+  var anchorEls = [];
+  editor.state.doc.descendants(function (node, pos) {
+    var _options$anchorTypes2;
+    var isValidType = (_options$anchorTypes2 = options.anchorTypes) === null || _options$anchorTypes2 === void 0 ? void 0 : _options$anchorTypes2.includes(node.type.name);
+    if (!isValidType) {
+      return;
+    }
+    headlines.push({
+      node: node,
+      pos: pos
+    });
+  });
+  headlines.forEach(function (headline) {
+    if (headline.node.textContent.length === 0) {
+      return;
+    }
+    var domElement = editor.view.domAtPos(headline.pos + 1).node;
+    var scrolledOver = options.storage.scrollPosition >= domElement.offsetTop;
+    anchorEls.push(domElement);
+    var originalLevel = headline.node.attrs.level;
+    var level = options.getLevelFn(headline, anchors);
+    var itemIndex = options.getIndexFn(headline, anchors, level);
+    anchors.push({
+      itemIndex: itemIndex,
+      id: headline.node.attrs.id || options.getId(headline.node.textContent),
+      originalLevel: originalLevel,
+      level: level,
+      textContent: headline.node.textContent,
+      pos: headline.pos,
+      editor: editor,
+      isActive: false,
+      isScrolledOver: scrolledOver,
+      node: headline.node,
+      dom: domElement
+    });
+  });
+
+  // 计算 active 和 scrolledOver 状态
+  anchors = addTocActiveStatesAndGetItems(anchors, {
+    editor: options.editor,
+    anchorTypes: options.anchorTypes,
+    storage: options.storage
+  });
+
+  // 更新存储
+  options.storage.anchors = anchorEls;
+  options.storage.content = anchors;
+
+  // 调用回调
+  if (onUpdate) {
+    var isInitialCreation = options.storage.content.length === 0;
+    onUpdate(anchors, isInitialCreation);
+  }
+};
+export var TableOfContentsExtension = Extension.create({
+  name: 'tableOfContents',
+  addStorage: function addStorage() {
+    return {
+      content: [],
+      anchors: [],
+      scrollHandler: function scrollHandler() {
+        return null;
+      },
+      scrollPosition: 0
+    };
+  },
+  addGlobalAttributes: function addGlobalAttributes() {
+    return [{
+      types: this.options.anchorTypes || ['heading'],
+      attributes: {
+        id: {
+          default: null,
+          renderHTML: function renderHTML(attributes) {
+            return {
+              id: attributes.id
+            };
+          },
+          parseHTML: function parseHTML(element) {
+            return element.id || null;
+          }
+        }
+      }
+    }];
+  },
+  addOptions: function addOptions() {
+    var defaultScrollParent = typeof window !== 'undefined' ? function () {
+      return window;
+    } : undefined;
+    return {
+      // eslint-disable-next-line
+      onUpdate: function onUpdate() {},
+      // eslint-disable-next-line
+      getId: function getId(_textContent) {
+        return uuidv4();
+      },
+      scrollParent: defaultScrollParent,
+      anchorTypes: ['heading']
+    };
+  },
+  addCommands: function addCommands() {
+    var _this = this;
+    return {
+      updateTableOfContents: function updateTableOfContents() {
+        return function (_ref) {
+          var dispatch = _ref.dispatch;
+          if (dispatch) {
+            var _this$options$onUpdat;
+            setTocData({
+              editor: _this.editor,
+              storage: _this.storage,
+              onUpdate: (_this$options$onUpdat = _this.options.onUpdate) === null || _this$options$onUpdat === void 0 ? void 0 : _this$options$onUpdat.bind(_this),
+              getIndexFn: _this.options.getIndex || getLinearIndexes,
+              getLevelFn: _this.options.getLevel || getHeadlineLevel,
+              anchorTypes: _this.options.anchorTypes,
+              getId: _this.options.getId || function (textContent) {
+                return uuidv4();
+              }
+            });
+          }
+          return true;
+        };
+      }
+    };
+  },
+  onTransaction: function onTransaction(_ref2) {
+    var transaction = _ref2.transaction;
+    if (transaction.docChanged && !transaction.getMeta('toc')) {
+      var _this$options$onUpdat2;
+      setTocData({
+        editor: this.editor,
+        storage: this.storage,
+        onUpdate: (_this$options$onUpdat2 = this.options.onUpdate) === null || _this$options$onUpdat2 === void 0 ? void 0 : _this$options$onUpdat2.bind(this),
+        getIndexFn: this.options.getIndex || getLinearIndexes,
+        getLevelFn: this.options.getLevel || getHeadlineLevel,
+        anchorTypes: this.options.anchorTypes,
+        getId: this.options.getId || function (textContent) {
+          return uuidv4();
+        }
+      });
+    }
+  },
+  onCreate: function onCreate() {
+    var _this2 = this;
+    var tr = this.editor.state.tr;
+    var existingIds = [];
+    if (this.options.scrollParent && typeof this.options.scrollParent !== 'function') {
+      console.warn("[Tiptap Table of Contents Deprecation Notice]: The 'scrollParent' option must now be provided as a callback function that returns the 'scrollParent' element. The ability to pass this option directly will be deprecated in future releases.");
+    }
+
+    // 异步处理初始 ID 分配，避免与初始输入竞争
+    requestAnimationFrame(function () {
+      _this2.editor.state.doc.descendants(function (node, pos) {
+        var _this2$options$anchor;
+        var nodeId = node.attrs.id;
+        var isValidType = (_this2$options$anchor = _this2.options.anchorTypes) === null || _this2$options$anchor === void 0 ? void 0 : _this2$options$anchor.includes(node.type.name);
+        if (!isValidType || node.textContent.length === 0) {
+          return;
+        }
+        if (nodeId === null || nodeId === undefined || existingIds.includes(nodeId)) {
+          var id = '';
+          if (_this2.options.getId) {
+            id = _this2.options.getId(node.textContent);
+          } else {
+            id = uuidv4();
+          }
+          tr.setNodeMarkup(pos, undefined, _objectSpread(_objectSpread({}, node.attrs), {}, {
+            id: id
+          }));
+        }
+        existingIds.push(nodeId);
+      });
+      _this2.editor.view.dispatch(tr);
+
+      // 延迟初始化 TOC 数据
+      setTimeout(function () {
+        var _this2$options$onUpda;
+        setTocData({
+          editor: _this2.editor,
+          storage: _this2.storage,
+          onUpdate: (_this2$options$onUpda = _this2.options.onUpdate) === null || _this2$options$onUpda === void 0 ? void 0 : _this2$options$onUpda.bind(_this2),
+          getIndexFn: _this2.options.getIndex || getLinearIndexes,
+          getLevelFn: _this2.options.getLevel || getHeadlineLevel,
+          anchorTypes: _this2.options.anchorTypes,
+          getId: _this2.options.getId || function (textContent) {
+            return uuidv4();
+          }
+        });
+      }, 100);
+    });
+
+    // 防抖的 scroll handler，避免滚动期间频繁触发回调
+    var scrollTimer = null;
+    this.storage.scrollHandler = function () {
+      if (!_this2.options.scrollParent) {
+        return;
+      }
+      var scrollParent = typeof _this2.options.scrollParent === 'function' ? _this2.options.scrollParent() : _this2.options.scrollParent;
+      var scrollPosition = scrollParent instanceof HTMLElement ? scrollParent.scrollTop : scrollParent.scrollY;
+      _this2.storage.scrollPosition = scrollPosition || 0;
+      if (scrollTimer) clearTimeout(scrollTimer);
+      scrollTimer = setTimeout(function () {
+        var _this2$options$onUpda2, _this2$options;
+        var updatedItems = addTocActiveStatesAndGetItems(_this2.storage.content, {
+          editor: _this2.editor,
+          anchorTypes: _this2.options.anchorTypes,
+          storage: _this2.storage
+        });
+        _this2.storage.content = updatedItems;
+        // 调用 onUpdate 回调
+        (_this2$options$onUpda2 = (_this2$options = _this2.options).onUpdate) === null || _this2$options$onUpda2 === void 0 || _this2$options$onUpda2.call(_this2$options, updatedItems, false);
+      }, 100);
+    };
+
+    // 添加滚动监听
+    if (this.options.scrollParent) {
+      var scrollParent = typeof this.options.scrollParent === 'function' ? this.options.scrollParent() : this.options.scrollParent;
+      if (scrollParent) {
+        scrollParent.addEventListener('scroll', this.storage.scrollHandler);
+      }
+    }
+  },
+  onDestroy: function onDestroy() {
+    if (this.options.scrollParent) {
+      var scrollParent = typeof this.options.scrollParent === 'function' ? this.options.scrollParent() : this.options.scrollParent;
+      if (scrollParent) {
+        scrollParent.removeEventListener('scroll', this.storage.scrollHandler);
+      }
+    }
+  },
+  addProseMirrorPlugins: function addProseMirrorPlugins() {
+    return [TableOfContentsPlugin({
+      getId: this.options.getId,
+      anchorTypes: this.options.anchorTypes
+    })];
+  }
+});
+export var TableOfContents = function TableOfContents(_ref3) {
+  var onTocUpdate = _ref3.onTocUpdate;
+  return TableOfContentsExtension.configure({
+    getIndex: getHierarchicalIndexes,
+    onUpdate: function onUpdate(data) {
+      setTimeout(function () {
+        onTocUpdate === null || onTocUpdate === void 0 || onTocUpdate(data.map(function (content) {
+          return {
+            id: content.id,
+            isActive: content.isActive,
+            isScrolledOver: content.isScrolledOver,
+            itemIndex: content.itemIndex,
+            level: content.level,
+            originalLevel: content.originalLevel,
+            pos: content.pos,
+            textContent: content.textContent
+          };
+        }));
+      }, 0);
+    }
+  });
+};
+export default TableOfContents;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctzhian/tiptap",
-  "version": "2.3.2-beta.6",
+  "version": "2.3.2-beta.7",
   "description": "基于 Tiptap 二次开发的编辑器组件",
   "main": "dist/index.js",
   "module": "dist/index.js",