@tiptap/extension-character-count 2.0.0-beta.18 → 2.0.0-beta.19

package/dist/packages/extension-character-count/src/character-count.d.ts

@@ -1,7 +1,28 @@
 import { Extension } from '@tiptap/core';
-import { PluginKey } from 'prosemirror-state';
-export declare const pluginKey: PluginKey<any, any>;
+import { Node as ProseMirrorNode } from 'prosemirror-model';
 export interface CharacterCountOptions {
-    limit?: number;
+    /**
+     * The maximum number of characters that should be allowed. Defaults to `0`.
+     */
+    limit: number;
+    /**
+     * The mode by which the size is calculated. Defaults to 'textSize'.
+     */
+    mode: 'textSize' | 'nodeSize';
 }
-export declare const CharacterCount: Extension<CharacterCountOptions, any>;
+export interface CharacterCountStorage {
+    /**
+     * Get the number of characters for the current document.
+     */
+    characters?: (options: {
+        node?: ProseMirrorNode;
+        mode?: 'textSize' | 'nodeSize';
+    }) => number;
+    /**
+     * Get the number of words for the current document.
+     */
+    words?: (options: {
+        node?: ProseMirrorNode;
+    }) => number;
+}
+export declare const CharacterCount: Extension<CharacterCountOptions, CharacterCountStorage>;

package/dist/tiptap-extension-character-count.cjs.js

@@ -5286,24 +5286,86 @@ PluginKey.prototype.get = function get (state) { return state.config.pluginsByKe
 // Get the plugin's state from an editor state.
 PluginKey.prototype.getState = function getState (state) { return state[this.key] };
 
-const pluginKey = new PluginKey('characterLimit');
 const CharacterCount = core.Extension.create({
     name: 'characterCount',
     addOptions() {
         return {
             limit: 0,
+            mode: 'textSize',
+        };
+    },
+    addStorage() {
+        return {
+            characters: undefined,
+            words: undefined,
+        };
+    },
+    onBeforeCreate() {
+        this.storage.characters = options => {
+            const node = (options === null || options === void 0 ? void 0 : options.node) || this.editor.state.doc;
+            const mode = (options === null || options === void 0 ? void 0 : options.mode) || this.options.mode;
+            if (mode === 'textSize') {
+                const text = node.textBetween(0, node.content.size, undefined, ' ');
+                return text.length;
+            }
+            return node.nodeSize;
+        };
+        this.storage.words = options => {
+            const node = (options === null || options === void 0 ? void 0 : options.node) || this.editor.state.doc;
+            const text = node.textBetween(0, node.content.size, undefined, ' ');
+            const words = text
+                .split(' ')
+                .filter(word => word !== '');
+            return words.length;
         };
     },
     addProseMirrorPlugins() {
-        const { options } = this;
         return [
             new Plugin({
-                key: pluginKey,
-                appendTransaction: (transactions, oldState, newState) => {
-                    const length = newState.doc.content.size;
-                    if (options.limit && length > options.limit) {
-                        return newState.tr.insertText('', options.limit + 1, length);
+                key: new PluginKey('characterCount'),
+                filterTransaction: (transaction, state) => {
+                    var _a, _b, _c, _d, _e, _f;
+                    const limit = this.options.limit;
+                    // Nothing has changed or no limit is defined. Ignore it.
+                    if (!transaction.docChanged || limit === 0) {
+                        return true;
+                    }
+                    const oldSize = ((_b = (_a = this.storage).characters) === null || _b === void 0 ? void 0 : _b.call(_a, { node: state.doc })) || 0;
+                    const newSize = ((_d = (_c = this.storage).characters) === null || _d === void 0 ? void 0 : _d.call(_c, { node: transaction.doc })) || 0;
+                    // Everything is in the limit. Good.
+                    if (newSize <= limit) {
+                        return true;
+                    }
+                    // The limit has already been exceeded but will be reduced.
+                    if (oldSize > limit && newSize > limit && newSize <= oldSize) {
+                        return true;
+                    }
+                    // The limit has already been exceeded and will be increased further.
+                    if (oldSize > limit && newSize > limit && newSize > oldSize) {
+                        return false;
+                    }
+                    const isPaste = transaction.getMeta('paste');
+                    // Block all exceeding transactions that were not pasted.
+                    if (!isPaste) {
+                        return false;
+                    }
+                    // For pasted content, we try to remove the exceeding content.
+                    const pos = transaction.selection.$head.pos;
+                    const over = newSize - limit;
+                    const from = pos - over;
+                    const to = pos;
+                    // It’s probably a bad idea to mutate transactions within `filterTransaction`
+                    // but for now this is working fine.
+                    transaction.deleteRange(from, to);
+                    // In some situations, the limit will continue to be exceeded after trimming.
+                    // This happens e.g. when truncating within a complex node (e.g. table)
+                    // and ProseMirror has to close this node again.
+                    // If this is the case, we prevent the transaction completely.
+                    const updatedSize = ((_f = (_e = this.storage).characters) === null || _f === void 0 ? void 0 : _f.call(_e, { node: transaction.doc })) || 0;
+                    if (updatedSize > limit) {
+                        return false;
                     }
+                    return true;
                 },
             }),
         ];
@@ -5312,5 +5374,4 @@ const CharacterCount = core.Extension.create({
 
 exports.CharacterCount = CharacterCount;
 exports["default"] = CharacterCount;
-exports.pluginKey = pluginKey;
 //# sourceMappingURL=tiptap-extension-character-count.cjs.js.map