Strongly typed extension storage

.changeset/happy-squids-glow.md

@@ -0,0 +1,8 @@
+---
+"@tiptap/core": minor
+"@tiptap/extension-character-count": minor
+"@tiptap/extension-collaboration": minor
+"@tiptap/extension-collaboration-cursor": minor
+---
+
+Allow the type of the extensionStorage field of the Editor class to be customizable

demos/src/Experiments/ExtensionStorage/React/CustomExtension.ts

@@ -4,6 +4,12 @@ type CustomStorage = {
   foo: number,
 }
 
+declare module '@tiptap/core' {
+  interface ExtensionStorage {
+    custom: CustomStorage;
+  }
+}
+
 export const CustomExtension = Extension.create<any, CustomStorage>({
   name: 'custom',
 

packages/core/src/Editor.ts

@@ -25,6 +25,7 @@ import { getTextSerializersFromSchema } from './helpers/getTextSerializersFromSc
 import { isActive } from './helpers/isActive.js'
 import { isNodeEmpty } from './helpers/isNodeEmpty.js'
 import { resolveFocusPosition } from './helpers/resolveFocusPosition.js'
+import { ExtensionStorage } from './index.js'
 import { NodePos } from './NodePos.js'
 import { style } from './style.js'
 import {
@@ -64,7 +65,7 @@ export class Editor extends EventEmitter<EditorEvents> {
    */
   public isInitialized = false
 
-  public extensionStorage: Record<string, any> = {}
+  public extensionStorage: ExtensionStorage | Record<string, any> = {}
 
   public options: EditorOptions = {
     element: document.createElement('div'),
@@ -129,7 +130,7 @@ export class Editor extends EventEmitter<EditorEvents> {
   /**
    * Returns the editor storage.
    */
-  public get storage(): Record<string, any> {
+  public get storage(): ExtensionStorage | Record<string, any> {
     return this.extensionStorage
   }
 

packages/core/src/index.ts

@@ -18,6 +18,9 @@ export * from './utilities/index.js'
 // eslint-disable-next-line
 export interface Commands<ReturnType = any> {}
 
+// eslint-disable-next-line
+export interface ExtensionStorage {}
+
 // eslint-disable-next-line
 export interface ExtensionConfig<Options = any, Storage = any> {}
 

packages/extension-character-count/src/character-count.ts

@@ -47,6 +47,12 @@ export interface CharacterCountStorage {
   words: (options?: { node?: ProseMirrorNode }) => number
 }
 
+declare module '@tiptap/core' {
+  interface ExtensionStorage {
+    characterCount: CharacterCountStorage;
+  }
+}
+
 /**
  * This extension allows you to count the characters and words of your document.
  * @see https://tiptap.dev/api/extensions/character-count

packages/extension-collaboration-cursor/src/collaboration-cursor.ts

@@ -76,6 +76,10 @@ declare module '@tiptap/core' {
       user: (attributes: Record<string, any>) => ReturnType,
     }
   }
+
+  interface ExtensionStorage {
+    collaborationCursor: CollaborationCursorStorage
+  }
 }
 
 const awarenessStatesToArray = (states: Map<number, Record<string, any>>) => {

packages/extension-collaboration/src/collaboration.ts

@@ -29,6 +29,10 @@ declare module '@tiptap/core' {
       redo: () => ReturnType;
     };
   }
+
+  interface ExtensionStorage {
+    collaboration: CollaborationStorage;
+  }
 }
 
 export interface CollaborationStorage {