@tiptap/extension-character-count 3.0.0-next.0 → 3.0.0-next.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (172) hide show
  1. package/dist/index.cjs +127 -93
  2. package/dist/index.cjs.map +1 -1
  3. package/dist/{packages/extension-character-count/src/character-count.d.ts → index.d.cts} +21 -6
  4. package/dist/index.d.ts +57 -0
  5. package/dist/index.js +102 -90
  6. package/dist/index.js.map +1 -1
  7. package/package.json +8 -10
  8. package/src/character-count.ts +46 -3
  9. package/dist/index.umd.js +0 -100
  10. package/dist/index.umd.js.map +0 -1
  11. package/dist/packages/core/src/CommandManager.d.ts +0 -20
  12. package/dist/packages/core/src/Editor.d.ts +0 -159
  13. package/dist/packages/core/src/EventEmitter.d.ts +0 -11
  14. package/dist/packages/core/src/Extension.d.ts +0 -343
  15. package/dist/packages/core/src/ExtensionManager.d.ts +0 -55
  16. package/dist/packages/core/src/InputRule.d.ts +0 -42
  17. package/dist/packages/core/src/Mark.d.ts +0 -451
  18. package/dist/packages/core/src/Node.d.ts +0 -611
  19. package/dist/packages/core/src/NodePos.d.ts +0 -44
  20. package/dist/packages/core/src/NodeView.d.ts +0 -31
  21. package/dist/packages/core/src/PasteRule.d.ts +0 -50
  22. package/dist/packages/core/src/Tracker.d.ts +0 -11
  23. package/dist/packages/core/src/commands/blur.d.ts +0 -13
  24. package/dist/packages/core/src/commands/clearContent.d.ts +0 -14
  25. package/dist/packages/core/src/commands/clearNodes.d.ts +0 -13
  26. package/dist/packages/core/src/commands/command.d.ts +0 -18
  27. package/dist/packages/core/src/commands/createParagraphNear.d.ts +0 -13
  28. package/dist/packages/core/src/commands/cut.d.ts +0 -20
  29. package/dist/packages/core/src/commands/deleteCurrentNode.d.ts +0 -13
  30. package/dist/packages/core/src/commands/deleteNode.d.ts +0 -15
  31. package/dist/packages/core/src/commands/deleteRange.d.ts +0 -14
  32. package/dist/packages/core/src/commands/deleteSelection.d.ts +0 -13
  33. package/dist/packages/core/src/commands/enter.d.ts +0 -13
  34. package/dist/packages/core/src/commands/exitCode.d.ts +0 -13
  35. package/dist/packages/core/src/commands/extendMarkRange.d.ts +0 -25
  36. package/dist/packages/core/src/commands/first.d.ts +0 -14
  37. package/dist/packages/core/src/commands/focus.d.ts +0 -27
  38. package/dist/packages/core/src/commands/forEach.d.ts +0 -14
  39. package/dist/packages/core/src/commands/index.d.ts +0 -55
  40. package/dist/packages/core/src/commands/insertContent.d.ts +0 -34
  41. package/dist/packages/core/src/commands/insertContentAt.d.ts +0 -47
  42. package/dist/packages/core/src/commands/join.d.ts +0 -41
  43. package/dist/packages/core/src/commands/joinItemBackward.d.ts +0 -13
  44. package/dist/packages/core/src/commands/joinItemForward.d.ts +0 -13
  45. package/dist/packages/core/src/commands/joinTextblockBackward.d.ts +0 -12
  46. package/dist/packages/core/src/commands/joinTextblockForward.d.ts +0 -12
  47. package/dist/packages/core/src/commands/keyboardShortcut.d.ts +0 -14
  48. package/dist/packages/core/src/commands/lift.d.ts +0 -17
  49. package/dist/packages/core/src/commands/liftEmptyBlock.d.ts +0 -13
  50. package/dist/packages/core/src/commands/liftListItem.d.ts +0 -15
  51. package/dist/packages/core/src/commands/newlineInCode.d.ts +0 -13
  52. package/dist/packages/core/src/commands/resetAttributes.d.ts +0 -16
  53. package/dist/packages/core/src/commands/scrollIntoView.d.ts +0 -13
  54. package/dist/packages/core/src/commands/selectAll.d.ts +0 -13
  55. package/dist/packages/core/src/commands/selectNodeBackward.d.ts +0 -13
  56. package/dist/packages/core/src/commands/selectNodeForward.d.ts +0 -13
  57. package/dist/packages/core/src/commands/selectParentNode.d.ts +0 -13
  58. package/dist/packages/core/src/commands/selectTextblockEnd.d.ts +0 -13
  59. package/dist/packages/core/src/commands/selectTextblockStart.d.ts +0 -13
  60. package/dist/packages/core/src/commands/setContent.d.ts +0 -40
  61. package/dist/packages/core/src/commands/setMark.d.ts +0 -15
  62. package/dist/packages/core/src/commands/setMeta.d.ts +0 -15
  63. package/dist/packages/core/src/commands/setNode.d.ts +0 -16
  64. package/dist/packages/core/src/commands/setNodeSelection.d.ts +0 -14
  65. package/dist/packages/core/src/commands/setTextSelection.d.ts +0 -14
  66. package/dist/packages/core/src/commands/sinkListItem.d.ts +0 -15
  67. package/dist/packages/core/src/commands/splitBlock.d.ts +0 -17
  68. package/dist/packages/core/src/commands/splitListItem.d.ts +0 -15
  69. package/dist/packages/core/src/commands/toggleList.d.ts +0 -18
  70. package/dist/packages/core/src/commands/toggleMark.d.ts +0 -30
  71. package/dist/packages/core/src/commands/toggleNode.d.ts +0 -17
  72. package/dist/packages/core/src/commands/toggleWrap.d.ts +0 -16
  73. package/dist/packages/core/src/commands/undoInputRule.d.ts +0 -13
  74. package/dist/packages/core/src/commands/unsetAllMarks.d.ts +0 -13
  75. package/dist/packages/core/src/commands/unsetMark.d.ts +0 -25
  76. package/dist/packages/core/src/commands/updateAttributes.d.ts +0 -24
  77. package/dist/packages/core/src/commands/wrapIn.d.ts +0 -16
  78. package/dist/packages/core/src/commands/wrapInList.d.ts +0 -16
  79. package/dist/packages/core/src/extensions/clipboardTextSerializer.d.ts +0 -5
  80. package/dist/packages/core/src/extensions/commands.d.ts +0 -3
  81. package/dist/packages/core/src/extensions/editable.d.ts +0 -2
  82. package/dist/packages/core/src/extensions/focusEvents.d.ts +0 -2
  83. package/dist/packages/core/src/extensions/index.d.ts +0 -6
  84. package/dist/packages/core/src/extensions/keymap.d.ts +0 -2
  85. package/dist/packages/core/src/extensions/tabindex.d.ts +0 -2
  86. package/dist/packages/core/src/helpers/combineTransactionSteps.d.ts +0 -10
  87. package/dist/packages/core/src/helpers/createChainableState.d.ts +0 -10
  88. package/dist/packages/core/src/helpers/createDocument.d.ts +0 -12
  89. package/dist/packages/core/src/helpers/createNodeFromContent.d.ts +0 -15
  90. package/dist/packages/core/src/helpers/defaultBlockAt.d.ts +0 -7
  91. package/dist/packages/core/src/helpers/findChildren.d.ts +0 -9
  92. package/dist/packages/core/src/helpers/findChildrenInRange.d.ts +0 -10
  93. package/dist/packages/core/src/helpers/findParentNode.d.ts +0 -16
  94. package/dist/packages/core/src/helpers/findParentNodeClosestToPos.d.ts +0 -17
  95. package/dist/packages/core/src/helpers/generateHTML.d.ts +0 -8
  96. package/dist/packages/core/src/helpers/generateJSON.d.ts +0 -8
  97. package/dist/packages/core/src/helpers/generateText.d.ts +0 -12
  98. package/dist/packages/core/src/helpers/getAttributes.d.ts +0 -9
  99. package/dist/packages/core/src/helpers/getAttributesFromExtensions.d.ts +0 -6
  100. package/dist/packages/core/src/helpers/getChangedRanges.d.ts +0 -11
  101. package/dist/packages/core/src/helpers/getDebugJSON.d.ts +0 -8
  102. package/dist/packages/core/src/helpers/getExtensionField.d.ts +0 -9
  103. package/dist/packages/core/src/helpers/getHTMLFromFragment.d.ts +0 -2
  104. package/dist/packages/core/src/helpers/getMarkAttributes.d.ts +0 -3
  105. package/dist/packages/core/src/helpers/getMarkRange.d.ts +0 -3
  106. package/dist/packages/core/src/helpers/getMarkType.d.ts +0 -2
  107. package/dist/packages/core/src/helpers/getMarksBetween.d.ts +0 -3
  108. package/dist/packages/core/src/helpers/getNodeAtPosition.d.ts +0 -11
  109. package/dist/packages/core/src/helpers/getNodeAttributes.d.ts +0 -3
  110. package/dist/packages/core/src/helpers/getNodeType.d.ts +0 -2
  111. package/dist/packages/core/src/helpers/getRenderedAttributes.d.ts +0 -3
  112. package/dist/packages/core/src/helpers/getSchema.d.ts +0 -4
  113. package/dist/packages/core/src/helpers/getSchemaByResolvedExtensions.d.ts +0 -10
  114. package/dist/packages/core/src/helpers/getSchemaTypeByName.d.ts +0 -8
  115. package/dist/packages/core/src/helpers/getSchemaTypeNameByName.d.ts +0 -8
  116. package/dist/packages/core/src/helpers/getSplittedAttributes.d.ts +0 -9
  117. package/dist/packages/core/src/helpers/getText.d.ts +0 -15
  118. package/dist/packages/core/src/helpers/getTextBetween.d.ts +0 -14
  119. package/dist/packages/core/src/helpers/getTextContentFromNodes.d.ts +0 -8
  120. package/dist/packages/core/src/helpers/getTextSerializersFromSchema.d.ts +0 -8
  121. package/dist/packages/core/src/helpers/index.d.ts +0 -50
  122. package/dist/packages/core/src/helpers/injectExtensionAttributesToParseRule.d.ts +0 -9
  123. package/dist/packages/core/src/helpers/isActive.d.ts +0 -2
  124. package/dist/packages/core/src/helpers/isAtEndOfNode.d.ts +0 -2
  125. package/dist/packages/core/src/helpers/isAtStartOfNode.d.ts +0 -2
  126. package/dist/packages/core/src/helpers/isExtensionRulesEnabled.d.ts +0 -2
  127. package/dist/packages/core/src/helpers/isList.d.ts +0 -2
  128. package/dist/packages/core/src/helpers/isMarkActive.d.ts +0 -3
  129. package/dist/packages/core/src/helpers/isNodeActive.d.ts +0 -3
  130. package/dist/packages/core/src/helpers/isNodeEmpty.d.ts +0 -8
  131. package/dist/packages/core/src/helpers/isNodeSelection.d.ts +0 -2
  132. package/dist/packages/core/src/helpers/isTextSelection.d.ts +0 -2
  133. package/dist/packages/core/src/helpers/posToDOMRect.d.ts +0 -2
  134. package/dist/packages/core/src/helpers/resolveFocusPosition.d.ts +0 -4
  135. package/dist/packages/core/src/helpers/selectionToInsertionEnd.d.ts +0 -2
  136. package/dist/packages/core/src/helpers/splitExtensions.d.ts +0 -9
  137. package/dist/packages/core/src/index.d.ts +0 -24
  138. package/dist/packages/core/src/inputRules/index.d.ts +0 -5
  139. package/dist/packages/core/src/inputRules/markInputRule.d.ts +0 -13
  140. package/dist/packages/core/src/inputRules/nodeInputRule.d.ts +0 -23
  141. package/dist/packages/core/src/inputRules/textInputRule.d.ts +0 -10
  142. package/dist/packages/core/src/inputRules/textblockTypeInputRule.d.ts +0 -15
  143. package/dist/packages/core/src/inputRules/wrappingInputRule.d.ts +0 -28
  144. package/dist/packages/core/src/pasteRules/index.d.ts +0 -3
  145. package/dist/packages/core/src/pasteRules/markPasteRule.d.ts +0 -13
  146. package/dist/packages/core/src/pasteRules/nodePasteRule.d.ts +0 -13
  147. package/dist/packages/core/src/pasteRules/textPasteRule.d.ts +0 -10
  148. package/dist/packages/core/src/style.d.ts +0 -1
  149. package/dist/packages/core/src/types.d.ts +0 -253
  150. package/dist/packages/core/src/utilities/callOrReturn.d.ts +0 -9
  151. package/dist/packages/core/src/utilities/createStyleTag.d.ts +0 -1
  152. package/dist/packages/core/src/utilities/deleteProps.d.ts +0 -6
  153. package/dist/packages/core/src/utilities/elementFromString.d.ts +0 -1
  154. package/dist/packages/core/src/utilities/escapeForRegEx.d.ts +0 -1
  155. package/dist/packages/core/src/utilities/findDuplicates.d.ts +0 -1
  156. package/dist/packages/core/src/utilities/fromString.d.ts +0 -1
  157. package/dist/packages/core/src/utilities/index.d.ts +0 -20
  158. package/dist/packages/core/src/utilities/isAndroid.d.ts +0 -1
  159. package/dist/packages/core/src/utilities/isEmptyObject.d.ts +0 -1
  160. package/dist/packages/core/src/utilities/isFunction.d.ts +0 -1
  161. package/dist/packages/core/src/utilities/isMacOS.d.ts +0 -1
  162. package/dist/packages/core/src/utilities/isNumber.d.ts +0 -1
  163. package/dist/packages/core/src/utilities/isPlainObject.d.ts +0 -1
  164. package/dist/packages/core/src/utilities/isRegExp.d.ts +0 -1
  165. package/dist/packages/core/src/utilities/isString.d.ts +0 -1
  166. package/dist/packages/core/src/utilities/isiOS.d.ts +0 -1
  167. package/dist/packages/core/src/utilities/mergeAttributes.d.ts +0 -1
  168. package/dist/packages/core/src/utilities/mergeDeep.d.ts +0 -1
  169. package/dist/packages/core/src/utilities/minMax.d.ts +0 -1
  170. package/dist/packages/core/src/utilities/objectIncludes.d.ts +0 -8
  171. package/dist/packages/core/src/utilities/removeDuplicates.d.ts +0 -8
  172. package/dist/packages/extension-character-count/src/index.d.ts +0 -3
package/dist/index.cjs CHANGED
@@ -1,97 +1,131 @@
1
- 'use strict';
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __export = (target, all) => {
7
+ for (var name in all)
8
+ __defProp(target, name, { get: all[name], enumerable: true });
9
+ };
10
+ var __copyProps = (to, from, except, desc) => {
11
+ if (from && typeof from === "object" || typeof from === "function") {
12
+ for (let key of __getOwnPropNames(from))
13
+ if (!__hasOwnProp.call(to, key) && key !== except)
14
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
15
+ }
16
+ return to;
17
+ };
18
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
2
19
 
3
- Object.defineProperty(exports, '__esModule', { value: true });
4
-
5
- var core = require('@tiptap/core');
6
- var state = require('@tiptap/pm/state');
20
+ // src/index.ts
21
+ var src_exports = {};
22
+ __export(src_exports, {
23
+ CharacterCount: () => CharacterCount,
24
+ default: () => src_default
25
+ });
26
+ module.exports = __toCommonJS(src_exports);
7
27
 
8
- /**
9
- * This extension allows you to count the characters and words of your document.
10
- * @see https://tiptap.dev/api/extensions/character-count
11
- */
12
- const CharacterCount = core.Extension.create({
13
- name: 'characterCount',
14
- addOptions() {
15
- return {
16
- limit: null,
17
- mode: 'textSize',
18
- };
19
- },
20
- addStorage() {
21
- return {
22
- characters: () => 0,
23
- words: () => 0,
24
- };
25
- },
26
- onBeforeCreate() {
27
- this.storage.characters = options => {
28
- const node = (options === null || options === void 0 ? void 0 : options.node) || this.editor.state.doc;
29
- const mode = (options === null || options === void 0 ? void 0 : options.mode) || this.options.mode;
30
- if (mode === 'textSize') {
31
- const text = node.textBetween(0, node.content.size, undefined, ' ');
32
- return text.length;
33
- }
34
- return node.nodeSize;
35
- };
36
- this.storage.words = options => {
37
- const node = (options === null || options === void 0 ? void 0 : options.node) || this.editor.state.doc;
38
- const text = node.textBetween(0, node.content.size, ' ', ' ');
39
- const words = text.split(' ').filter(word => word !== '');
40
- return words.length;
41
- };
42
- },
43
- addProseMirrorPlugins() {
44
- return [
45
- new state.Plugin({
46
- key: new state.PluginKey('characterCount'),
47
- filterTransaction: (transaction, state) => {
48
- const limit = this.options.limit;
49
- // Nothing has changed or no limit is defined. Ignore it.
50
- if (!transaction.docChanged || limit === 0 || limit === null || limit === undefined) {
51
- return true;
52
- }
53
- const oldSize = this.storage.characters({ node: state.doc });
54
- const newSize = this.storage.characters({ node: transaction.doc });
55
- // Everything is in the limit. Good.
56
- if (newSize <= limit) {
57
- return true;
58
- }
59
- // The limit has already been exceeded but will be reduced.
60
- if (oldSize > limit && newSize > limit && newSize <= oldSize) {
61
- return true;
62
- }
63
- // The limit has already been exceeded and will be increased further.
64
- if (oldSize > limit && newSize > limit && newSize > oldSize) {
65
- return false;
66
- }
67
- const isPaste = transaction.getMeta('paste');
68
- // Block all exceeding transactions that were not pasted.
69
- if (!isPaste) {
70
- return false;
71
- }
72
- // For pasted content, we try to remove the exceeding content.
73
- const pos = transaction.selection.$head.pos;
74
- const over = newSize - limit;
75
- const from = pos - over;
76
- const to = pos;
77
- // It’s probably a bad idea to mutate transactions within `filterTransaction`
78
- // but for now this is working fine.
79
- transaction.deleteRange(from, to);
80
- // In some situations, the limit will continue to be exceeded after trimming.
81
- // This happens e.g. when truncating within a complex node (e.g. table)
82
- // and ProseMirror has to close this node again.
83
- // If this is the case, we prevent the transaction completely.
84
- const updatedSize = this.storage.characters({ node: transaction.doc });
85
- if (updatedSize > limit) {
86
- return false;
87
- }
88
- return true;
89
- },
90
- }),
91
- ];
92
- },
28
+ // src/character-count.ts
29
+ var import_core = require("@tiptap/core");
30
+ var import_state = require("@tiptap/pm/state");
31
+ var CharacterCount = import_core.Extension.create({
32
+ name: "characterCount",
33
+ addOptions() {
34
+ return {
35
+ limit: null,
36
+ mode: "textSize",
37
+ textCounter: (text) => text.length,
38
+ wordCounter: (text) => text.split(" ").filter((word) => word !== "").length
39
+ };
40
+ },
41
+ addStorage() {
42
+ return {
43
+ characters: () => 0,
44
+ words: () => 0
45
+ };
46
+ },
47
+ onBeforeCreate() {
48
+ this.storage.characters = (options) => {
49
+ const node = (options == null ? void 0 : options.node) || this.editor.state.doc;
50
+ const mode = (options == null ? void 0 : options.mode) || this.options.mode;
51
+ if (mode === "textSize") {
52
+ const text = node.textBetween(0, node.content.size, void 0, " ");
53
+ return this.options.textCounter(text);
54
+ }
55
+ return node.nodeSize;
56
+ };
57
+ this.storage.words = (options) => {
58
+ const node = (options == null ? void 0 : options.node) || this.editor.state.doc;
59
+ const text = node.textBetween(0, node.content.size, " ", " ");
60
+ return this.options.wordCounter(text);
61
+ };
62
+ },
63
+ addProseMirrorPlugins() {
64
+ let initialEvaluationDone = false;
65
+ return [
66
+ new import_state.Plugin({
67
+ key: new import_state.PluginKey("characterCount"),
68
+ appendTransaction: (transactions, oldState, newState) => {
69
+ if (initialEvaluationDone) {
70
+ return;
71
+ }
72
+ const limit = this.options.limit;
73
+ if (limit === null || limit === void 0 || limit === 0) {
74
+ initialEvaluationDone = true;
75
+ return;
76
+ }
77
+ const initialContentSize = this.storage.characters({ node: newState.doc });
78
+ if (initialContentSize > limit) {
79
+ const over = initialContentSize - limit;
80
+ const from = 0;
81
+ const to = over;
82
+ console.warn(`[CharacterCount] Initial content exceeded limit of ${limit} characters. Content was automatically trimmed.`);
83
+ const tr = newState.tr.deleteRange(from, to);
84
+ initialEvaluationDone = true;
85
+ return tr;
86
+ }
87
+ initialEvaluationDone = true;
88
+ },
89
+ filterTransaction: (transaction, state) => {
90
+ const limit = this.options.limit;
91
+ if (!transaction.docChanged || limit === 0 || limit === null || limit === void 0) {
92
+ return true;
93
+ }
94
+ const oldSize = this.storage.characters({ node: state.doc });
95
+ const newSize = this.storage.characters({ node: transaction.doc });
96
+ if (newSize <= limit) {
97
+ return true;
98
+ }
99
+ if (oldSize > limit && newSize > limit && newSize <= oldSize) {
100
+ return true;
101
+ }
102
+ if (oldSize > limit && newSize > limit && newSize > oldSize) {
103
+ return false;
104
+ }
105
+ const isPaste = transaction.getMeta("paste");
106
+ if (!isPaste) {
107
+ return false;
108
+ }
109
+ const pos = transaction.selection.$head.pos;
110
+ const over = newSize - limit;
111
+ const from = pos - over;
112
+ const to = pos;
113
+ transaction.deleteRange(from, to);
114
+ const updatedSize = this.storage.characters({ node: transaction.doc });
115
+ if (updatedSize > limit) {
116
+ return false;
117
+ }
118
+ return true;
119
+ }
120
+ })
121
+ ];
122
+ }
93
123
  });
94
124
 
95
- exports.CharacterCount = CharacterCount;
96
- exports.default = CharacterCount;
97
- //# sourceMappingURL=index.cjs.map
125
+ // src/index.ts
126
+ var src_default = CharacterCount;
127
+ // Annotate the CommonJS export names for ESM import in node:
128
+ 0 && (module.exports = {
129
+ CharacterCount
130
+ });
131
+ //# sourceMappingURL=index.cjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs","sources":["../src/character-count.ts"],"sourcesContent":["import { Extension } from '@tiptap/core'\nimport { Node as ProseMirrorNode } from '@tiptap/pm/model'\nimport { Plugin, PluginKey } from '@tiptap/pm/state'\n\nexport interface CharacterCountOptions {\n /**\n * The maximum number of characters that should be allowed. Defaults to `0`.\n * @default null\n * @example 180\n */\n limit: number | null | undefined\n /**\n * The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.\n * If set to `nodeSize`, the nodeSize of the document is used.\n * @default 'textSize'\n * @example 'textSize'\n */\n mode: 'textSize' | 'nodeSize'\n}\n\nexport interface CharacterCountStorage {\n /**\n * Get the number of characters for the current document.\n * @param options The options for the character count. (optional)\n * @param options.node The node to get the characters from. Defaults to the current document.\n * @param options.mode The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.\n */\n characters: (options?: { node?: ProseMirrorNode; mode?: 'textSize' | 'nodeSize' }) => number\n\n /**\n * Get the number of words for the current document.\n * @param options The options for the character count. (optional)\n * @param options.node The node to get the words from. Defaults to the current document.\n */\n words: (options?: { node?: ProseMirrorNode }) => number\n}\n\n/**\n * This extension allows you to count the characters and words of your document.\n * @see https://tiptap.dev/api/extensions/character-count\n */\nexport const CharacterCount = Extension.create<CharacterCountOptions, CharacterCountStorage>({\n name: 'characterCount',\n\n addOptions() {\n return {\n limit: null,\n mode: 'textSize',\n }\n },\n\n addStorage() {\n return {\n characters: () => 0,\n words: () => 0,\n }\n },\n\n onBeforeCreate() {\n this.storage.characters = options => {\n const node = options?.node || this.editor.state.doc\n const mode = options?.mode || this.options.mode\n\n if (mode === 'textSize') {\n const text = node.textBetween(0, node.content.size, undefined, ' ')\n\n return text.length\n }\n\n return node.nodeSize\n }\n\n this.storage.words = options => {\n const node = options?.node || this.editor.state.doc\n const text = node.textBetween(0, node.content.size, ' ', ' ')\n const words = text.split(' ').filter(word => word !== '')\n\n return words.length\n }\n },\n\n addProseMirrorPlugins() {\n return [\n new Plugin({\n key: new PluginKey('characterCount'),\n filterTransaction: (transaction, state) => {\n const limit = this.options.limit\n\n // Nothing has changed or no limit is defined. Ignore it.\n if (!transaction.docChanged || limit === 0 || limit === null || limit === undefined) {\n return true\n }\n\n const oldSize = this.storage.characters({ node: state.doc })\n const newSize = this.storage.characters({ node: transaction.doc })\n\n // Everything is in the limit. Good.\n if (newSize <= limit) {\n return true\n }\n\n // The limit has already been exceeded but will be reduced.\n if (oldSize > limit && newSize > limit && newSize <= oldSize) {\n return true\n }\n\n // The limit has already been exceeded and will be increased further.\n if (oldSize > limit && newSize > limit && newSize > oldSize) {\n return false\n }\n\n const isPaste = transaction.getMeta('paste')\n\n // Block all exceeding transactions that were not pasted.\n if (!isPaste) {\n return false\n }\n\n // For pasted content, we try to remove the exceeding content.\n const pos = transaction.selection.$head.pos\n const over = newSize - limit\n const from = pos - over\n const to = pos\n\n // It’s probably a bad idea to mutate transactions within `filterTransaction`\n // but for now this is working fine.\n transaction.deleteRange(from, to)\n\n // In some situations, the limit will continue to be exceeded after trimming.\n // This happens e.g. when truncating within a complex node (e.g. table)\n // and ProseMirror has to close this node again.\n // If this is the case, we prevent the transaction completely.\n const updatedSize = this.storage.characters({ node: transaction.doc })\n\n if (updatedSize > limit) {\n return false\n }\n\n return true\n },\n }),\n ]\n },\n})\n"],"names":["Extension","Plugin","PluginKey"],"mappings":";;;;;;;AAqCA;;;AAGG;AACU,MAAA,cAAc,GAAGA,cAAS,CAAC,MAAM,CAA+C;AAC3F,IAAA,IAAI,EAAE,gBAAgB;IAEtB,UAAU,GAAA;QACR,OAAO;AACL,YAAA,KAAK,EAAE,IAAI;AACX,YAAA,IAAI,EAAE,UAAU;SACjB,CAAA;KACF;IAED,UAAU,GAAA;QACR,OAAO;AACL,YAAA,UAAU,EAAE,MAAM,CAAC;AACnB,YAAA,KAAK,EAAE,MAAM,CAAC;SACf,CAAA;KACF;IAED,cAAc,GAAA;AACZ,QAAA,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,OAAO,IAAG;AAClC,YAAA,MAAM,IAAI,GAAG,CAAA,OAAO,KAAP,IAAA,IAAA,OAAO,uBAAP,OAAO,CAAE,IAAI,KAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAA;AACnD,YAAA,MAAM,IAAI,GAAG,CAAA,OAAO,KAAA,IAAA,IAAP,OAAO,KAAP,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,OAAO,CAAE,IAAI,KAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;AAE/C,YAAA,IAAI,IAAI,KAAK,UAAU,EAAE;AACvB,gBAAA,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,CAAC,CAAA;gBAEnE,OAAO,IAAI,CAAC,MAAM,CAAA;aACnB;YAED,OAAO,IAAI,CAAC,QAAQ,CAAA;AACtB,SAAC,CAAA;AAED,QAAA,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,OAAO,IAAG;AAC7B,YAAA,MAAM,IAAI,GAAG,CAAA,OAAO,KAAP,IAAA,IAAA,OAAO,uBAAP,OAAO,CAAE,IAAI,KAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAA;AACnD,YAAA,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;AAC7D,YAAA,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC,CAAA;YAEzD,OAAO,KAAK,CAAC,MAAM,CAAA;AACrB,SAAC,CAAA;KACF;IAED,qBAAqB,GAAA;QACnB,OAAO;AACL,YAAA,IAAIC,YAAM,CAAC;AACT,gBAAA,GAAG,EAAE,IAAIC,eAAS,CAAC,gBAAgB,CAAC;AACpC,gBAAA,iBAAiB,EAAE,CAAC,WAAW,EAAE,KAAK,KAAI;AACxC,oBAAA,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAA;;AAGhC,oBAAA,IAAI,CAAC,WAAW,CAAC,UAAU,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE;AACnF,wBAAA,OAAO,IAAI,CAAA;qBACZ;AAED,oBAAA,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAA;AAC5D,oBAAA,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,GAAG,EAAE,CAAC,CAAA;;AAGlE,oBAAA,IAAI,OAAO,IAAI,KAAK,EAAE;AACpB,wBAAA,OAAO,IAAI,CAAA;qBACZ;;AAGD,oBAAA,IAAI,OAAO,GAAG,KAAK,IAAI,OAAO,GAAG,KAAK,IAAI,OAAO,IAAI,OAAO,EAAE;AAC5D,wBAAA,OAAO,IAAI,CAAA;qBACZ;;AAGD,oBAAA,IAAI,OAAO,GAAG,KAAK,IAAI,OAAO,GAAG,KAAK,IAAI,OAAO,GAAG,OAAO,EAAE;AAC3D,wBAAA,OAAO,KAAK,CAAA;qBACb;oBAED,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;;oBAG5C,IAAI,CAAC,OAAO,EAAE;AACZ,wBAAA,OAAO,KAAK,CAAA;qBACb;;oBAGD,MAAM,GAAG,GAAG,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAA;AAC3C,oBAAA,MAAM,IAAI,GAAG,OAAO,GAAG,KAAK,CAAA;AAC5B,oBAAA,MAAM,IAAI,GAAG,GAAG,GAAG,IAAI,CAAA;oBACvB,MAAM,EAAE,GAAG,GAAG,CAAA;;;AAId,oBAAA,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;;;;;AAMjC,oBAAA,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,GAAG,EAAE,CAAC,CAAA;AAEtE,oBAAA,IAAI,WAAW,GAAG,KAAK,EAAE;AACvB,wBAAA,OAAO,KAAK,CAAA;qBACb;AAED,oBAAA,OAAO,IAAI,CAAA;iBACZ;aACF,CAAC;SACH,CAAA;KACF;AACF,CAAA;;;;;"}
1
+ {"version":3,"sources":["../src/index.ts","../src/character-count.ts"],"sourcesContent":["import { CharacterCount } from './character-count.js'\n\nexport * from './character-count.js'\n\nexport default CharacterCount\n","import { Extension } from '@tiptap/core'\nimport { Node as ProseMirrorNode } from '@tiptap/pm/model'\nimport { Plugin, PluginKey } from '@tiptap/pm/state'\n\nexport interface CharacterCountOptions {\n /**\n * The maximum number of characters that should be allowed. Defaults to `0`.\n * @default null\n * @example 180\n */\n limit: number | null | undefined\n /**\n * The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.\n * If set to `nodeSize`, the nodeSize of the document is used.\n * @default 'textSize'\n * @example 'textSize'\n */\n mode: 'textSize' | 'nodeSize'\n /**\n * The text counter function to use. Defaults to a simple character count.\n * @default (text) => text.length\n * @example (text) => [...new Intl.Segmenter().segment(text)].length\n */\n textCounter: (text: string) => number\n /**\n * The word counter function to use. Defaults to a simple word count.\n * @default (text) => text.split(' ').filter(word => word !== '').length\n * @example (text) => text.split(/\\s+/).filter(word => word !== '').length\n */\n wordCounter: (text: string) => number\n}\n\nexport interface CharacterCountStorage {\n /**\n * Get the number of characters for the current document.\n * @param options The options for the character count. (optional)\n * @param options.node The node to get the characters from. Defaults to the current document.\n * @param options.mode The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.\n */\n characters: (options?: { node?: ProseMirrorNode; mode?: 'textSize' | 'nodeSize' }) => number\n\n /**\n * Get the number of words for the current document.\n * @param options The options for the character count. (optional)\n * @param options.node The node to get the words from. Defaults to the current document.\n */\n words: (options?: { node?: ProseMirrorNode }) => number\n}\n\n/**\n * This extension allows you to count the characters and words of your document.\n * @see https://tiptap.dev/api/extensions/character-count\n */\nexport const CharacterCount = Extension.create<CharacterCountOptions, CharacterCountStorage>({\n name: 'characterCount',\n\n addOptions() {\n return {\n limit: null,\n mode: 'textSize',\n textCounter: text => text.length,\n wordCounter: text => text.split(' ').filter(word => word !== '').length,\n }\n },\n\n addStorage() {\n return {\n characters: () => 0,\n words: () => 0,\n }\n },\n\n onBeforeCreate() {\n this.storage.characters = options => {\n const node = options?.node || this.editor.state.doc\n const mode = options?.mode || this.options.mode\n\n if (mode === 'textSize') {\n const text = node.textBetween(0, node.content.size, undefined, ' ')\n\n return this.options.textCounter(text)\n }\n\n return node.nodeSize\n }\n\n this.storage.words = options => {\n const node = options?.node || this.editor.state.doc\n const text = node.textBetween(0, node.content.size, ' ', ' ')\n\n return this.options.wordCounter(text)\n }\n },\n\n addProseMirrorPlugins() {\n let initialEvaluationDone = false\n\n return [\n new Plugin({\n key: new PluginKey('characterCount'),\n appendTransaction: (transactions, oldState, newState) => {\n if (initialEvaluationDone) {\n return\n }\n\n const limit = this.options.limit\n\n if (limit === null || limit === undefined || limit === 0) {\n initialEvaluationDone = true\n return\n }\n\n const initialContentSize = this.storage.characters({ node: newState.doc })\n\n if (initialContentSize > limit) {\n const over = initialContentSize - limit\n const from = 0\n const to = over\n\n console.warn(`[CharacterCount] Initial content exceeded limit of ${limit} characters. Content was automatically trimmed.`)\n const tr = newState.tr.deleteRange(from, to)\n\n initialEvaluationDone = true\n return tr\n }\n\n initialEvaluationDone = true\n },\n filterTransaction: (transaction, state) => {\n const limit = this.options.limit\n\n // Nothing has changed or no limit is defined. Ignore it.\n if (!transaction.docChanged || limit === 0 || limit === null || limit === undefined) {\n return true\n }\n\n const oldSize = this.storage.characters({ node: state.doc })\n const newSize = this.storage.characters({ node: transaction.doc })\n\n // Everything is in the limit. Good.\n if (newSize <= limit) {\n return true\n }\n\n // The limit has already been exceeded but will be reduced.\n if (oldSize > limit && newSize > limit && newSize <= oldSize) {\n return true\n }\n\n // The limit has already been exceeded and will be increased further.\n if (oldSize > limit && newSize > limit && newSize > oldSize) {\n return false\n }\n\n const isPaste = transaction.getMeta('paste')\n\n // Block all exceeding transactions that were not pasted.\n if (!isPaste) {\n return false\n }\n\n // For pasted content, we try to remove the exceeding content.\n const pos = transaction.selection.$head.pos\n const over = newSize - limit\n const from = pos - over\n const to = pos\n\n // It’s probably a bad idea to mutate transactions within `filterTransaction`\n // but for now this is working fine.\n transaction.deleteRange(from, to)\n\n // In some situations, the limit will continue to be exceeded after trimming.\n // This happens e.g. when truncating within a complex node (e.g. table)\n // and ProseMirror has to close this node again.\n // If this is the case, we prevent the transaction completely.\n const updatedSize = this.storage.characters({ node: transaction.doc })\n\n if (updatedSize > limit) {\n return false\n }\n\n return true\n },\n }),\n ]\n },\n})\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,kBAA0B;AAE1B,mBAAkC;AAmD3B,IAAM,iBAAiB,sBAAU,OAAqD;AAAA,EAC3F,MAAM;AAAA,EAEN,aAAa;AACX,WAAO;AAAA,MACL,OAAO;AAAA,MACP,MAAM;AAAA,MACN,aAAa,UAAQ,KAAK;AAAA,MAC1B,aAAa,UAAQ,KAAK,MAAM,GAAG,EAAE,OAAO,UAAQ,SAAS,EAAE,EAAE;AAAA,IACnE;AAAA,EACF;AAAA,EAEA,aAAa;AACX,WAAO;AAAA,MACL,YAAY,MAAM;AAAA,MAClB,OAAO,MAAM;AAAA,IACf;AAAA,EACF;AAAA,EAEA,iBAAiB;AACf,SAAK,QAAQ,aAAa,aAAW;AACnC,YAAM,QAAO,mCAAS,SAAQ,KAAK,OAAO,MAAM;AAChD,YAAM,QAAO,mCAAS,SAAQ,KAAK,QAAQ;AAE3C,UAAI,SAAS,YAAY;AACvB,cAAM,OAAO,KAAK,YAAY,GAAG,KAAK,QAAQ,MAAM,QAAW,GAAG;AAElE,eAAO,KAAK,QAAQ,YAAY,IAAI;AAAA,MACtC;AAEA,aAAO,KAAK;AAAA,IACd;AAEA,SAAK,QAAQ,QAAQ,aAAW;AAC9B,YAAM,QAAO,mCAAS,SAAQ,KAAK,OAAO,MAAM;AAChD,YAAM,OAAO,KAAK,YAAY,GAAG,KAAK,QAAQ,MAAM,KAAK,GAAG;AAE5D,aAAO,KAAK,QAAQ,YAAY,IAAI;AAAA,IACtC;AAAA,EACF;AAAA,EAEA,wBAAwB;AACtB,QAAI,wBAAwB;AAE5B,WAAO;AAAA,MACL,IAAI,oBAAO;AAAA,QACT,KAAK,IAAI,uBAAU,gBAAgB;AAAA,QACnC,mBAAmB,CAAC,cAAc,UAAU,aAAa;AACvD,cAAI,uBAAuB;AACzB;AAAA,UACF;AAEA,gBAAM,QAAQ,KAAK,QAAQ;AAE3B,cAAI,UAAU,QAAQ,UAAU,UAAa,UAAU,GAAG;AACxD,oCAAwB;AACxB;AAAA,UACF;AAEA,gBAAM,qBAAqB,KAAK,QAAQ,WAAW,EAAE,MAAM,SAAS,IAAI,CAAC;AAEzE,cAAI,qBAAqB,OAAO;AAC9B,kBAAM,OAAO,qBAAqB;AAClC,kBAAM,OAAO;AACb,kBAAM,KAAK;AAEX,oBAAQ,KAAK,sDAAsD,KAAK,iDAAiD;AACzH,kBAAM,KAAK,SAAS,GAAG,YAAY,MAAM,EAAE;AAE3C,oCAAwB;AACxB,mBAAO;AAAA,UACT;AAEA,kCAAwB;AAAA,QAC1B;AAAA,QACA,mBAAmB,CAAC,aAAa,UAAU;AACzC,gBAAM,QAAQ,KAAK,QAAQ;AAG3B,cAAI,CAAC,YAAY,cAAc,UAAU,KAAK,UAAU,QAAQ,UAAU,QAAW;AACnF,mBAAO;AAAA,UACT;AAEA,gBAAM,UAAU,KAAK,QAAQ,WAAW,EAAE,MAAM,MAAM,IAAI,CAAC;AAC3D,gBAAM,UAAU,KAAK,QAAQ,WAAW,EAAE,MAAM,YAAY,IAAI,CAAC;AAGjE,cAAI,WAAW,OAAO;AACpB,mBAAO;AAAA,UACT;AAGA,cAAI,UAAU,SAAS,UAAU,SAAS,WAAW,SAAS;AAC5D,mBAAO;AAAA,UACT;AAGA,cAAI,UAAU,SAAS,UAAU,SAAS,UAAU,SAAS;AAC3D,mBAAO;AAAA,UACT;AAEA,gBAAM,UAAU,YAAY,QAAQ,OAAO;AAG3C,cAAI,CAAC,SAAS;AACZ,mBAAO;AAAA,UACT;AAGA,gBAAM,MAAM,YAAY,UAAU,MAAM;AACxC,gBAAM,OAAO,UAAU;AACvB,gBAAM,OAAO,MAAM;AACnB,gBAAM,KAAK;AAIX,sBAAY,YAAY,MAAM,EAAE;AAMhC,gBAAM,cAAc,KAAK,QAAQ,WAAW,EAAE,MAAM,YAAY,IAAI,CAAC;AAErE,cAAI,cAAc,OAAO;AACvB,mBAAO;AAAA,UACT;AAEA,iBAAO;AAAA,QACT;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AACF,CAAC;;;ADtLD,IAAO,cAAQ;","names":[]}
@@ -1,6 +1,7 @@
1
1
  import { Extension } from '@tiptap/core';
2
- import { Node as ProseMirrorNode } from '@tiptap/pm/model';
3
- export interface CharacterCountOptions {
2
+ import { Node } from '@tiptap/pm/model';
3
+
4
+ interface CharacterCountOptions {
4
5
  /**
5
6
  * The maximum number of characters that should be allowed. Defaults to `0`.
6
7
  * @default null
@@ -14,8 +15,20 @@ export interface CharacterCountOptions {
14
15
  * @example 'textSize'
15
16
  */
16
17
  mode: 'textSize' | 'nodeSize';
18
+ /**
19
+ * The text counter function to use. Defaults to a simple character count.
20
+ * @default (text) => text.length
21
+ * @example (text) => [...new Intl.Segmenter().segment(text)].length
22
+ */
23
+ textCounter: (text: string) => number;
24
+ /**
25
+ * The word counter function to use. Defaults to a simple word count.
26
+ * @default (text) => text.split(' ').filter(word => word !== '').length
27
+ * @example (text) => text.split(/\s+/).filter(word => word !== '').length
28
+ */
29
+ wordCounter: (text: string) => number;
17
30
  }
18
- export interface CharacterCountStorage {
31
+ interface CharacterCountStorage {
19
32
  /**
20
33
  * Get the number of characters for the current document.
21
34
  * @param options The options for the character count. (optional)
@@ -23,7 +36,7 @@ export interface CharacterCountStorage {
23
36
  * @param options.mode The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.
24
37
  */
25
38
  characters: (options?: {
26
- node?: ProseMirrorNode;
39
+ node?: Node;
27
40
  mode?: 'textSize' | 'nodeSize';
28
41
  }) => number;
29
42
  /**
@@ -32,11 +45,13 @@ export interface CharacterCountStorage {
32
45
  * @param options.node The node to get the words from. Defaults to the current document.
33
46
  */
34
47
  words: (options?: {
35
- node?: ProseMirrorNode;
48
+ node?: Node;
36
49
  }) => number;
37
50
  }
38
51
  /**
39
52
  * This extension allows you to count the characters and words of your document.
40
53
  * @see https://tiptap.dev/api/extensions/character-count
41
54
  */
42
- export declare const CharacterCount: Extension<CharacterCountOptions, CharacterCountStorage>;
55
+ declare const CharacterCount: Extension<CharacterCountOptions, CharacterCountStorage>;
56
+
57
+ export { CharacterCount, type CharacterCountOptions, type CharacterCountStorage, CharacterCount as default };
@@ -0,0 +1,57 @@
1
+ import { Extension } from '@tiptap/core';
2
+ import { Node } from '@tiptap/pm/model';
3
+
4
+ interface CharacterCountOptions {
5
+ /**
6
+ * The maximum number of characters that should be allowed. Defaults to `0`.
7
+ * @default null
8
+ * @example 180
9
+ */
10
+ limit: number | null | undefined;
11
+ /**
12
+ * The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.
13
+ * If set to `nodeSize`, the nodeSize of the document is used.
14
+ * @default 'textSize'
15
+ * @example 'textSize'
16
+ */
17
+ mode: 'textSize' | 'nodeSize';
18
+ /**
19
+ * The text counter function to use. Defaults to a simple character count.
20
+ * @default (text) => text.length
21
+ * @example (text) => [...new Intl.Segmenter().segment(text)].length
22
+ */
23
+ textCounter: (text: string) => number;
24
+ /**
25
+ * The word counter function to use. Defaults to a simple word count.
26
+ * @default (text) => text.split(' ').filter(word => word !== '').length
27
+ * @example (text) => text.split(/\s+/).filter(word => word !== '').length
28
+ */
29
+ wordCounter: (text: string) => number;
30
+ }
31
+ interface CharacterCountStorage {
32
+ /**
33
+ * Get the number of characters for the current document.
34
+ * @param options The options for the character count. (optional)
35
+ * @param options.node The node to get the characters from. Defaults to the current document.
36
+ * @param options.mode The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.
37
+ */
38
+ characters: (options?: {
39
+ node?: Node;
40
+ mode?: 'textSize' | 'nodeSize';
41
+ }) => number;
42
+ /**
43
+ * Get the number of words for the current document.
44
+ * @param options The options for the character count. (optional)
45
+ * @param options.node The node to get the words from. Defaults to the current document.
46
+ */
47
+ words: (options?: {
48
+ node?: Node;
49
+ }) => number;
50
+ }
51
+ /**
52
+ * This extension allows you to count the characters and words of your document.
53
+ * @see https://tiptap.dev/api/extensions/character-count
54
+ */
55
+ declare const CharacterCount: Extension<CharacterCountOptions, CharacterCountStorage>;
56
+
57
+ export { CharacterCount, type CharacterCountOptions, type CharacterCountStorage, CharacterCount as default };
package/dist/index.js CHANGED
@@ -1,92 +1,104 @@
1
- import { Extension } from '@tiptap/core';
2
- import { Plugin, PluginKey } from '@tiptap/pm/state';
3
-
4
- /**
5
- * This extension allows you to count the characters and words of your document.
6
- * @see https://tiptap.dev/api/extensions/character-count
7
- */
8
- const CharacterCount = Extension.create({
9
- name: 'characterCount',
10
- addOptions() {
11
- return {
12
- limit: null,
13
- mode: 'textSize',
14
- };
15
- },
16
- addStorage() {
17
- return {
18
- characters: () => 0,
19
- words: () => 0,
20
- };
21
- },
22
- onBeforeCreate() {
23
- this.storage.characters = options => {
24
- const node = (options === null || options === void 0 ? void 0 : options.node) || this.editor.state.doc;
25
- const mode = (options === null || options === void 0 ? void 0 : options.mode) || this.options.mode;
26
- if (mode === 'textSize') {
27
- const text = node.textBetween(0, node.content.size, undefined, ' ');
28
- return text.length;
29
- }
30
- return node.nodeSize;
31
- };
32
- this.storage.words = options => {
33
- const node = (options === null || options === void 0 ? void 0 : options.node) || this.editor.state.doc;
34
- const text = node.textBetween(0, node.content.size, ' ', ' ');
35
- const words = text.split(' ').filter(word => word !== '');
36
- return words.length;
37
- };
38
- },
39
- addProseMirrorPlugins() {
40
- return [
41
- new Plugin({
42
- key: new PluginKey('characterCount'),
43
- filterTransaction: (transaction, state) => {
44
- const limit = this.options.limit;
45
- // Nothing has changed or no limit is defined. Ignore it.
46
- if (!transaction.docChanged || limit === 0 || limit === null || limit === undefined) {
47
- return true;
48
- }
49
- const oldSize = this.storage.characters({ node: state.doc });
50
- const newSize = this.storage.characters({ node: transaction.doc });
51
- // Everything is in the limit. Good.
52
- if (newSize <= limit) {
53
- return true;
54
- }
55
- // The limit has already been exceeded but will be reduced.
56
- if (oldSize > limit && newSize > limit && newSize <= oldSize) {
57
- return true;
58
- }
59
- // The limit has already been exceeded and will be increased further.
60
- if (oldSize > limit && newSize > limit && newSize > oldSize) {
61
- return false;
62
- }
63
- const isPaste = transaction.getMeta('paste');
64
- // Block all exceeding transactions that were not pasted.
65
- if (!isPaste) {
66
- return false;
67
- }
68
- // For pasted content, we try to remove the exceeding content.
69
- const pos = transaction.selection.$head.pos;
70
- const over = newSize - limit;
71
- const from = pos - over;
72
- const to = pos;
73
- // It’s probably a bad idea to mutate transactions within `filterTransaction`
74
- // but for now this is working fine.
75
- transaction.deleteRange(from, to);
76
- // In some situations, the limit will continue to be exceeded after trimming.
77
- // This happens e.g. when truncating within a complex node (e.g. table)
78
- // and ProseMirror has to close this node again.
79
- // If this is the case, we prevent the transaction completely.
80
- const updatedSize = this.storage.characters({ node: transaction.doc });
81
- if (updatedSize > limit) {
82
- return false;
83
- }
84
- return true;
85
- },
86
- }),
87
- ];
88
- },
1
+ // src/character-count.ts
2
+ import { Extension } from "@tiptap/core";
3
+ import { Plugin, PluginKey } from "@tiptap/pm/state";
4
+ var CharacterCount = Extension.create({
5
+ name: "characterCount",
6
+ addOptions() {
7
+ return {
8
+ limit: null,
9
+ mode: "textSize",
10
+ textCounter: (text) => text.length,
11
+ wordCounter: (text) => text.split(" ").filter((word) => word !== "").length
12
+ };
13
+ },
14
+ addStorage() {
15
+ return {
16
+ characters: () => 0,
17
+ words: () => 0
18
+ };
19
+ },
20
+ onBeforeCreate() {
21
+ this.storage.characters = (options) => {
22
+ const node = (options == null ? void 0 : options.node) || this.editor.state.doc;
23
+ const mode = (options == null ? void 0 : options.mode) || this.options.mode;
24
+ if (mode === "textSize") {
25
+ const text = node.textBetween(0, node.content.size, void 0, " ");
26
+ return this.options.textCounter(text);
27
+ }
28
+ return node.nodeSize;
29
+ };
30
+ this.storage.words = (options) => {
31
+ const node = (options == null ? void 0 : options.node) || this.editor.state.doc;
32
+ const text = node.textBetween(0, node.content.size, " ", " ");
33
+ return this.options.wordCounter(text);
34
+ };
35
+ },
36
+ addProseMirrorPlugins() {
37
+ let initialEvaluationDone = false;
38
+ return [
39
+ new Plugin({
40
+ key: new PluginKey("characterCount"),
41
+ appendTransaction: (transactions, oldState, newState) => {
42
+ if (initialEvaluationDone) {
43
+ return;
44
+ }
45
+ const limit = this.options.limit;
46
+ if (limit === null || limit === void 0 || limit === 0) {
47
+ initialEvaluationDone = true;
48
+ return;
49
+ }
50
+ const initialContentSize = this.storage.characters({ node: newState.doc });
51
+ if (initialContentSize > limit) {
52
+ const over = initialContentSize - limit;
53
+ const from = 0;
54
+ const to = over;
55
+ console.warn(`[CharacterCount] Initial content exceeded limit of ${limit} characters. Content was automatically trimmed.`);
56
+ const tr = newState.tr.deleteRange(from, to);
57
+ initialEvaluationDone = true;
58
+ return tr;
59
+ }
60
+ initialEvaluationDone = true;
61
+ },
62
+ filterTransaction: (transaction, state) => {
63
+ const limit = this.options.limit;
64
+ if (!transaction.docChanged || limit === 0 || limit === null || limit === void 0) {
65
+ return true;
66
+ }
67
+ const oldSize = this.storage.characters({ node: state.doc });
68
+ const newSize = this.storage.characters({ node: transaction.doc });
69
+ if (newSize <= limit) {
70
+ return true;
71
+ }
72
+ if (oldSize > limit && newSize > limit && newSize <= oldSize) {
73
+ return true;
74
+ }
75
+ if (oldSize > limit && newSize > limit && newSize > oldSize) {
76
+ return false;
77
+ }
78
+ const isPaste = transaction.getMeta("paste");
79
+ if (!isPaste) {
80
+ return false;
81
+ }
82
+ const pos = transaction.selection.$head.pos;
83
+ const over = newSize - limit;
84
+ const from = pos - over;
85
+ const to = pos;
86
+ transaction.deleteRange(from, to);
87
+ const updatedSize = this.storage.characters({ node: transaction.doc });
88
+ if (updatedSize > limit) {
89
+ return false;
90
+ }
91
+ return true;
92
+ }
93
+ })
94
+ ];
95
+ }
89
96
  });
90
97
 
91
- export { CharacterCount, CharacterCount as default };
92
- //# sourceMappingURL=index.js.map
98
+ // src/index.ts
99
+ var src_default = CharacterCount;
100
+ export {
101
+ CharacterCount,
102
+ src_default as default
103
+ };
104
+ //# sourceMappingURL=index.js.map