@ctzhian/tiptap 0.4.0

package/dist/util/migrateMathStrings.js

@@ -0,0 +1,192 @@
+/**
+ * Regular expression to match LaTeX math strings wrapped in single dollar signs.
+ * This should not catch dollar signs which are not part of a math expression,
+ * like those used for currency or other purposes.
+ * It ensures that the dollar signs are not preceded or followed by digits,
+ * allowing for proper identification of inline math expressions.
+ *
+ * - `$x^2 + y^2 = z^2$` will match
+ * - `This is $inline math$ in text.` will match
+ * - `This is $100$ dollars.` will not match (as it is not a math expression)
+ * - `This is $x^2 + y^2 = z^2$ and $100$ dollars.` will match both math expressions
+ * - `$$\frac{a}{b}$$` will NOT match (block math should be handled separately)
+ */
+export var mathMigrationRegex = /\$(?!\d+\$)(?!\$)(.+?)(?<!\$)\$(?!\d)(?!\$)/g;
+
+/**
+ * Regular expression to match LaTeX math strings wrapped in double dollar signs.
+ * This matches block-level math expressions that should be displayed on their own line.
+ *
+ * - `$$\frac{a}{b}$$` will match
+ * - `$$\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}$$` will match
+ * - `$$100$$ dollars` will not match (as it is not a math expression)
+ */
+export var blockMathMigrationRegex = /\$\$([^$]+)\$\$/g;
+
+/**
+ * Alternative approach: First find all math patterns, then classify them
+ * This is more reliable than trying to use complex regex patterns
+ */
+export var allMathPatternsRegex = /\$\$?[^$]*\$\$?/g;
+
+/**
+ * Creates a transaction that migrates existing math strings in the document to new math nodes.
+ * This function traverses the document and replaces LaTeX math syntax with proper math nodes,
+ * preserving the mathematical content. It handles both inline and block math expressions.
+ * 
+ * Note: Math formulas inside <pre> and <code> tags are ignored to preserve code formatting.
+ *
+ * @param editor - The editor instance containing the schema and configuration
+ * @param tr - The transaction to modify with the migration operations
+ * @returns The modified transaction with math string replacements
+ *
+ * @example
+ * ```typescript
+ * const editor = new Editor({ ... })
+ * const tr = editor.state.tr
+ * const updatedTr = createMathMigrateTransaction(editor, tr)
+ * editor.view.dispatch(updatedTr)
+ * ```
+ */
+export function createMathMigrateTransaction(editor, tr) {
+  var inlineMathNode = editor.schema.nodes.inlineMath;
+  var blockMathNode = editor.schema.nodes.blockMath;
+
+  // 收集所有需要处理的数学公式，按位置排序
+  var allMathReplacements = [];
+
+  // 第一遍：收集所有数学公式信息
+  tr.doc.descendants(function (node, pos) {
+    // 跳过代码块和预格式化文本
+    if (node.marks.some(function (mark) {
+      return mark.type.name === 'codeBlock' || mark.type.name === 'code';
+    })) {
+      return;
+    }
+    if (!node.isText || !node.text || !node.text.includes('$')) {
+      return;
+    }
+    var text = node.text;
+
+    // 使用更可靠的方法：先找到所有可能的数学模式，然后分类
+    var allMatches = text.match(allMathPatternsRegex);
+    if (!allMatches) {
+      return;
+    }
+
+    // 按位置排序，从后往前处理，避免位置偏移问题
+    var sortedMatches = allMatches.map(function (match) {
+      var isBlock = match.startsWith('$$') && match.endsWith('$$');
+      var type = isBlock ? 'block' : 'inline';
+      return {
+        match: match,
+        start: text.indexOf(match),
+        end: text.indexOf(match) + match.length,
+        type: type
+      };
+    }).sort(function (a, b) {
+      return b.start - a.start;
+    }); // 从后往前排序
+
+    sortedMatches.forEach(function (_ref) {
+      var match = _ref.match,
+        start = _ref.start,
+        end = _ref.end,
+        type = _ref.type;
+      var from = tr.mapping.map(pos + start);
+      var to = tr.mapping.map(pos + end);
+      var $from = tr.doc.resolve(from);
+      var parent = $from.parent;
+      var index = $from.index();
+      var latex;
+      if (type === 'block') {
+        latex = match.slice(2, -2); // 移除 $$ 符号
+      } else {
+        latex = match.slice(1, -1); // 移除 $ 符号
+      }
+      allMathReplacements.push({
+        pos: from,
+        match: match,
+        type: type,
+        latex: latex,
+        parent: parent,
+        index: index
+      });
+    });
+  });
+
+  // 按位置从后往前排序，避免位置偏移问题
+  allMathReplacements.sort(function (a, b) {
+    return b.pos - a.pos;
+  });
+
+  // 第二遍：执行替换
+  allMathReplacements.forEach(function (_ref2) {
+    var pos = _ref2.pos,
+      match = _ref2.match,
+      type = _ref2.type,
+      latex = _ref2.latex,
+      parent = _ref2.parent,
+      index = _ref2.index;
+    var mathNode;
+    if (type === 'block') {
+      // 块级数学公式
+      mathNode = blockMathNode;
+    } else {
+      // 行内数学公式
+      mathNode = inlineMathNode;
+    }
+    if (type === 'block') {
+      // 对于块级数学公式，需要特殊处理
+      // 1. 先删除原始文本
+      var endPos = pos + match.length;
+      tr.delete(pos, endPos);
+
+      // 2. 在删除位置插入块级数学节点
+      tr.insert(pos, mathNode.create({
+        latex: latex
+      }));
+    } else {
+      // 对于行内数学公式，在段落内部替换
+      if (!parent.canReplaceWith(index, index + 1, mathNode)) {
+        console.warn("\u65E0\u6CD5\u66FF\u6362\u884C\u5185\u6570\u5B66\u516C\u5F0F:", match);
+        return;
+      }
+      var _endPos = pos + match.length;
+      tr.replaceWith(pos, _endPos, mathNode.create({
+        latex: latex
+      }));
+    }
+  });
+
+  // don't add to history
+  tr.setMeta('addToHistory', false);
+  return tr;
+}
+
+/**
+ * Migrates existing math strings in the editor document to math nodes.
+ * This function creates and dispatches a transaction that converts LaTeX math syntax
+ * into proper math nodes. It handles both inline math (single dollar signs) and
+ * block math (double dollar signs). The migration happens immediately and is not
+ * added to the editor's history.
+ * 
+ * Note: Math formulas inside <pre> and <code> tags are ignored to preserve code formatting.
+ *
+ * @param editor - The editor instance to perform the migration on
+ *
+ * @example
+ * ```typescript
+ * const editor = new Editor({
+ *   extensions: [Mathematics],
+ *   content: 'This is inline math: $x^2 + y^2 = z^2$ and block math: $$\frac{a}{b}$$'
+ * })
+ *
+ * // Math strings will be automatically migrated to math nodes
+ * migrateMathStrings(editor)
+ * ```
+ */
+export function migrateMathStrings(editor) {
+  var tr = createMathMigrateTransaction(editor, editor.state.tr);
+  editor.view.dispatch(tr);
+}

package/dist/util/resourceExtractor.d.ts

@@ -0,0 +1,15 @@
+import { Node } from '@tiptap/pm/model';
+import { NodeTypeEnum } from "../contants/enums";
+/**
+ * 从编辑器内容中递归获取所有文件资源
+ * @param content - 编辑器内容节点
+ * @returns 所有文件资源数组
+ */
+export declare function getAllResources(content: Node): Node[];
+/**
+ * 根据资源类型筛选资源
+ * @param resources - 文件资源数组
+ * @param types - 要筛选的资源类型
+ * @returns 筛选后的资源数组
+ */
+export declare function filterResourcesByType(resources: Node[], types: NodeTypeEnum[]): Node[];

package/dist/util/resourceExtractor.js

@@ -0,0 +1,62 @@
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+import { NodeTypeEnum } from "../contants/enums";
+
+/**
+ * 文件资源类型映射
+ */
+var FILE_RESOURCE_TYPES = new Set([NodeTypeEnum.Video, NodeTypeEnum.Audio, NodeTypeEnum.Image, NodeTypeEnum.InlineAttachment, NodeTypeEnum.BlockAttachment]);
+
+/**
+ * 递归遍历节点，获取所有文件资源
+ * @param node - 要遍历的节点
+ * @param path - 当前节点路径
+ * @returns 文件资源数组
+ */
+function extractResourcesFromNode(node) {
+  var path = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  var resources = [];
+
+  // 检查当前节点是否为文件资源
+  if (FILE_RESOURCE_TYPES.has(node.type.name)) {
+    var _node$attrs, _node$attrs2;
+    var src = ((_node$attrs = node.attrs) === null || _node$attrs === void 0 ? void 0 : _node$attrs.src) || ((_node$attrs2 = node.attrs) === null || _node$attrs2 === void 0 ? void 0 : _node$attrs2.url);
+    if (src) {
+      resources.push(node);
+    }
+  }
+
+  // 递归遍历子节点
+  if (node.content) {
+    node.content.forEach(function (childNode, index) {
+      var childPath = [].concat(_toConsumableArray(path), [index]);
+      resources.push.apply(resources, _toConsumableArray(extractResourcesFromNode(childNode, childPath)));
+    });
+  }
+  return resources;
+}
+
+/**
+ * 从编辑器内容中递归获取所有文件资源
+ * @param content - 编辑器内容节点
+ * @returns 所有文件资源数组
+ */
+export function getAllResources(content) {
+  return extractResourcesFromNode(content);
+}
+
+/**
+ * 根据资源类型筛选资源
+ * @param resources - 文件资源数组
+ * @param types - 要筛选的资源类型
+ * @returns 筛选后的资源数组
+ */
+export function filterResourcesByType(resources, types) {
+  return resources.filter(function (resource) {
+    return types.includes(resource.type.name);
+  });
+}

package/dist/util/shortcutKey.d.ts

@@ -0,0 +1,2 @@
+export declare const isMac: () => boolean;
+export declare const getShortcutKeyText: (shortcutKey: string[]) => string;

package/dist/util/shortcutKey.js

@@ -0,0 +1,9 @@
+import { MAC_SYMBOLS } from "../contants/shortcut-key";
+export var isMac = function isMac() {
+  return typeof navigator !== "undefined" && navigator.platform.toLowerCase().includes("mac");
+};
+export var getShortcutKeyText = function getShortcutKeyText(shortcutKey) {
+  return shortcutKey === null || shortcutKey === void 0 ? void 0 : shortcutKey.map(function (it) {
+    return isMac() ? MAC_SYMBOLS[it] || it : it;
+  }).join(' + ');
+};

package/package.json

@@ -0,0 +1,135 @@
+{
+  "name": "@ctzhian/tiptap",
+  "version": "0.4.0",
+  "description": "基于 Tiptap 二次开发的编辑器组件",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "authors": [
+    "ky.kyy@qq.com"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/KuaiYu95/tiptap-v3.git"
+  },
+  "bugs": {
+    "url": "https://github.com/KuaiYu95/tiptap-v3/issues"
+  },
+  "keywords": [
+    "react",
+    "tiptap",
+    "editor"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "homepage": "https://github.com/KuaiYu95/tiptap-v3#readme",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "lint-staged": {
+    "*.{md,json}": [
+      "prettier --write --no-error-on-unmatched-pattern"
+    ],
+    "*.{css,less}": [
+      "stylelint --fix",
+      "prettier --write"
+    ],
+    "*.{js,jsx}": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "*.{ts,tsx}": [
+      "eslint --fix",
+      "prettier --parser=typescript --write"
+    ]
+  },
+  "peerDependencies": {
+    "@emotion/react": "^11",
+    "@emotion/styled": "^11",
+    "@mui/icons-material": "^7",
+    "@mui/material": "^7",
+    "@mui/utils": "^7",
+    "react": ">=16.9.0",
+    "react-dom": ">=16.9.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.1.2",
+    "@commitlint/config-conventional": "^17.1.0",
+    "@types/react": "^18.0.0",
+    "@types/react-dom": "^18.0.0",
+    "@umijs/lint": "^4.0.0",
+    "dumi": "^2.4.13",
+    "eslint": "^8.23.0",
+    "father": "^4.1.0",
+    "husky": "^8.0.1",
+    "lint-staged": "^13.0.3",
+    "prettier": "^2.7.1",
+    "prettier-plugin-organize-imports": "^3.0.0",
+    "prettier-plugin-packagejson": "^2.2.18",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "stylelint": "^14.9.1"
+  },
+  "dependencies": {
+    "@floating-ui/dom": "^1.7.2",
+    "@tiptap/core": "^3.3.0",
+    "@tiptap/extension-bubble-menu": "^3.3.0",
+    "@tiptap/extension-code-block-lowlight": "^3.3.0",
+    "@tiptap/extension-details": "^3.3.0",
+    "@tiptap/extension-drag-handle-react": "^3.3.0",
+    "@tiptap/extension-emoji": "^3.3.0",
+    "@tiptap/extension-file-handler": "^3.3.0",
+    "@tiptap/extension-highlight": "^3.3.0",
+    "@tiptap/extension-image": "^3.3.0",
+    "@tiptap/extension-invisible-characters": "^3.3.0",
+    "@tiptap/extension-link": "^3.3.0",
+    "@tiptap/extension-list": "^3.3.0",
+    "@tiptap/extension-mathematics": "^3.3.0",
+    "@tiptap/extension-mention": "^3.3.0",
+    "@tiptap/extension-subscript": "^3.3.0",
+    "@tiptap/extension-superscript": "^3.3.0",
+    "@tiptap/extension-table": "^3.3.0",
+    "@tiptap/extension-table-of-contents": "^3.3.0",
+    "@tiptap/extension-text-align": "^3.3.0",
+    "@tiptap/extension-text-style": "^3.3.0",
+    "@tiptap/extension-unique-id": "^3.3.0",
+    "@tiptap/extension-youtube": "^3.3.0",
+    "@tiptap/extensions": "^3.3.0",
+    "@tiptap/html": "^3.3.0",
+    "@tiptap/pm": "^3.3.0",
+    "@tiptap/react": "^3.3.0",
+    "@tiptap/starter-kit": "^3.3.0",
+    "@tiptap/static-renderer": "^3.3.0",
+    "@tiptap/suggestion": "^3.3.0",
+    "highlight.js": "^11.11.1",
+    "jszip": "^3.10.1",
+    "katex": "^0.16.22",
+    "linkifyjs": "^4.3.2",
+    "lowlight": "^3.3.0",
+    "react-colorful": "^5.6.1",
+    "react-image-crop": "^11.0.10",
+    "react-photo-view": "^1.2.7",
+    "uuid": "^11.1.0"
+  },
+  "scripts": {
+    "start": "npm run dev",
+    "dev": "dumi dev",
+    "build": "rm -rf dist && father build",
+    "build:watch": "father dev",
+    "docs:build": "dumi build",
+    "docs:preview": "dumi preview",
+    "doctor": "father doctor",
+    "lint": "npm run lint:es && npm run lint:css",
+    "lint:css": "stylelint \"{src,test}/**/*.{css,less}\"",
+    "lint:es": "eslint \"{src,test}/**/*.{js,jsx,ts,tsx}\"",
+    "pre": "pnpm build && pnpm link --global"
+  }
+}