@handlewithcare/react-prosemirror 3.1.0-tiptap.53 → 3.1.1

package/dist/types/tiptap/ReactProseMirrorNodeView.d.ts

@@ -2,7 +2,7 @@ import { Editor, NodeView, NodeViewRendererOptions, NodeViewRendererProps } from
 /**
  * Subclass of Tiptap's NodeView to be used in tiptapNodeView.
  *
- * Allows us to pass in an existing dom and contentODM from React ProseMirror's
+ * Allows us to pass in an existing dom and contentDOM from React ProseMirror's
  * ViewDesc, so that we can call Tiptap's default stopEvent and ignoreMutation
  * methods
  */

package/dist/types/tiptap/TiptapEditorContent.d.ts

@@ -1,6 +1,6 @@
 import { Editor } from "@tiptap/core";
 import { ReactRenderer } from "@tiptap/react";
-import React, { ForwardedRef, HTMLProps, ReactPortal } from "react";
+import React, { ElementType, ForwardedRef, HTMLProps, ReactPortal } from "react";
 export type ContentComponent = {
     setRenderer(id: string, renderer: ReactRenderer): void;
     removeRenderer(id: string): void;
@@ -14,6 +14,15 @@ export interface EditorContentProps extends HTMLProps<HTMLDivElement> {
 }
 interface Props extends Omit<HTMLProps<HTMLElement>, "as"> {
     editor: Editor;
+    as?: ElementType;
 }
+/**
+ * Renders the actual editable ProseMirror document.
+ *
+ * This **must** be passed as a child to the `TiptapEditorView`
+ * component. It may be wrapped in other components, and other
+ * childern may be passed before or after. It must be passed the
+ * same `editor` as is passed to the `TiptapEditorView`.
+ */
 export declare function TiptapEditorContent({ editor: editorProp, ...props }: Props): React.JSX.Element;
 export {};

package/dist/types/tiptap/hooks/useIsInReactProseMirror.d.ts

@@ -1 +1,6 @@
+/**
+ * Returns true if the hook is called in a
+ * component that's a descendant of the
+ * ProseMirror component
+ */
 export declare function useIsInReactProseMirror(): boolean;

package/dist/types/tiptap/tiptapNodeView.d.ts

@@ -20,6 +20,7 @@ export interface TiptapNodeViewProps {
     }) => boolean) | null;
     ignoreMutation?: ((props: {
         mutation: ViewMutationRecord;
+        defaultIgnoreMutation: (mutation: ViewMutationRecord) => boolean;
     }) => boolean) | null;
     contentDOMElementTag?: ElementType | undefined;
 }
@@ -36,11 +37,9 @@ export interface TiptapNodeViewProps {
  *   codeBlock: nodeView({
  *     component: function CodeBlock(nodeViewProps) {
  *       return (
- *         <AnnotatableNodeViewWrapper {...nodeViewProps}>
- *           <pre>
- *             <NodeViewContent as="code" />
- *           </pre>
- *         </AnnotatableNodeViewWrapper>
+ *         <pre>
+ *           <NodeViewContent as="code" />
+ *         </pre>
  *       )
  *     },
  *     extension: CodeBlockExtension,
@@ -48,4 +47,4 @@ export interface TiptapNodeViewProps {
  * }
  * ```
  */
-export declare function tiptapNodeView({ component: WrappedComponent, extension, as, className, attrs, contentDOMElementTag: InnerTag, stopEvent, ignoreMutation, }: TiptapNodeViewProps): React.MemoExoticComponent<React.ForwardRefExoticComponent<Omit<NodeViewComponentProps<React.AllHTMLAttributes<HTMLElement>>, "ref"> & React.RefAttributes<HTMLElement | null>>>;
+export declare function tiptapNodeView({ component: WrappedComponent, extension, as, className, attrs, contentDOMElementTag: InnerTag, stopEvent, ignoreMutation, }: TiptapNodeViewProps): React.MemoExoticComponent<React.ForwardRefExoticComponent<Omit<NodeViewComponentProps, "ref"> & React.RefAttributes<HTMLElement | null>>>;

package/dist/types/viewdesc.d.ts

@@ -119,7 +119,7 @@ export declare class NodeViewDesc extends ViewDesc {
     parseRule(): Omit<TagParseRule, "tag"> | null;
     matchesNode(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource): boolean;
     get size(): number;
-    get border(): 1 | 0;
+    get border(): 0 | 1;
     updateChildren(_view: EditorView, _pos: number): void;
     update(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, view: EditorView): boolean;
     updateInner(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, view: EditorView): void;
@@ -143,6 +143,7 @@ export declare class TextViewDesc extends NodeViewDesc {
     markDirty(from: number, to: number): void;
     get domAtom(): boolean;
     isText(text: string): boolean;
+    ignoreMutation(mutation: ViewMutationRecord): boolean;
 }
 export declare class TrailingHackViewDesc extends ViewDesc {
     parseRule(): {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@handlewithcare/react-prosemirror",
-  "version": "3.1.0-tiptap.53",
+  "version": "3.1.1",
   "license": "Apache-2.0",
   "type": "module",
   "main": "dist/cjs/index.js",
@@ -63,6 +63,9 @@
     "@testing-library/dom": "^10.4.0",
     "@testing-library/react": "^16.3.0",
     "@testing-library/user-event": "^14.6.1",
+    "@tiptap/core": "^3.15.3",
+    "@tiptap/pm": "^3.15.3",
+    "@tiptap/react": "^3.15.3",
     "@types/css-tree": "^2.3.10",
     "@types/jest": "^27.0.0",
     "@types/react": "^18.2.0",
@@ -105,7 +108,7 @@
     "prosemirror-history": "^1.5.0",
     "prosemirror-inputrules": "^1.5.1",
     "prosemirror-keymap": "^1.2.3",
-    "prosemirror-model": "^1.25.4",
+    "prosemirror-model": "^1.25.7",
     "prosemirror-schema-list": "^1.5.1",
     "prosemirror-state": "^1.4.4",
     "prosemirror-tables": "^1.8.5",
@@ -119,7 +122,7 @@
     "remark-parse": "^11.0.0",
     "rimraf": "^3.0.2",
     "tsx": "^4.20.3",
-    "typescript": "^4.9.5",
+    "typescript": "^6.0.3",
     "unified": "^11.0.5",
     "vite": "^5.4.5",
     "webdriver": "^9.18.0",
@@ -129,6 +132,9 @@
     "prosemirror-view": "1.41.7"
   },
   "peerDependencies": {
+    "@tiptap/core": "^3.15.3",
+    "@tiptap/pm": "^3.15.3",
+    "@tiptap/react": "^3.15.3",
     "prosemirror-model": "^1.0.0",
     "prosemirror-state": "^1.0.0",
     "prosemirror-view": "1.41.7",
@@ -140,10 +146,18 @@
   "engines": {
     "node": ">=16.9"
   },
+  "peerDependenciesMeta": {
+    "@tiptap/core": {
+      "optional": true
+    },
+    "@tiptap/pm": {
+      "optional": true
+    },
+    "@tiptap/react": {
+      "optional": true
+    }
+  },
   "dependencies": {
-    "@tiptap/core": "^3.15.3",
-    "@tiptap/pm": "^3.15.3",
-    "@tiptap/react": "^3.15.3",
     "classnames": "^2.5.1"
   },
   "publishConfig": {

package/dist/cjs/plugins/componentEventListeners.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "componentEventListeners", {
-    enumerable: true,
-    get: function() {
-        return componentEventListeners;
-    }
-});
-const _reactdom = require("react-dom");
-function componentEventListeners(eventHandlerRegistry) {
-    const domEventHandlers = {};
-    for (const [eventType, handlers] of eventHandlerRegistry.entries()){
-        function handleEvent(view, event) {
-            for (const handler of handlers){
-                let handled = false;
-                (0, _reactdom.unstable_batchedUpdates)(()=>{
-                    handled = !!handler(view, event);
-                });
-                if (handled || event.defaultPrevented) return true;
-            }
-            return false;
-        }
-        domEventHandlers[eventType] = handleEvent;
-    }
-    return domEventHandlers;
-}

package/dist/cjs/plugins/componentEventListenersPlugin.js

@@ -1,35 +0,0 @@
-/* Copyright (c) The New York Times Company */ "use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "createComponentEventListenersPlugin", {
-    enumerable: true,
-    get: function() {
-        return createComponentEventListenersPlugin;
-    }
-});
-const _prosemirrorstate = require("prosemirror-state");
-const _reactdom = require("react-dom");
-function createComponentEventListenersPlugin(eventHandlerRegistry) {
-    const domEventHandlers = {};
-    for (const [eventType, handlers] of eventHandlerRegistry.entries()){
-        function handleEvent(view, event) {
-            for (const handler of handlers){
-                let handled = false;
-                (0, _reactdom.unstable_batchedUpdates)(()=>{
-                    handled = !!handler.call(this, view, event);
-                });
-                if (handled || event.defaultPrevented) return true;
-            }
-            return false;
-        }
-        domEventHandlers[eventType] = handleEvent;
-    }
-    const plugin = new _prosemirrorstate.Plugin({
-        key: new _prosemirrorstate.PluginKey("componentEventListeners"),
-        props: {
-            handleDOMEvents: domEventHandlers
-        }
-    });
-    return plugin;
-}

package/dist/cjs/tiptap/utils/ssrJSDOMPatch.js

@@ -1,59 +0,0 @@
-/**
- * This file is used to patch global DOM variables in a NodeJS environment.
- * This is needed for ProseMirror to work in a NodeJS environment.
- */ "use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-if (typeof window === "undefined") {
-    // Make sure to import JSDOM only in a NodeJS environment.
-    // The magic comments prevent bundlers from statically analyzing this require:
-    // - webpackIgnore: true  → webpack / Next.js
-    // - @vite-ignore         → Vite
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    const jsdom = require(/* webpackIgnore: true */ /* @vite-ignore */ "jsdom");
-    const html = `
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>Testing</title>
-  </head>
-  <body></body>
-</html>
-`;
-    const { window: window1 } = new jsdom.JSDOM(html);
-    global.window = window1;
-    global.document = window1.document;
-    // Use Object.defineProperty for navigator since it's read-only in Node.js 22+
-    Object.defineProperty(global, "navigator", {
-        value: window1.navigator,
-        writable: true,
-        configurable: true
-    });
-    global.innerHeight = 0;
-    global.SVGElement = window1.SVGElement;
-    // @ts-expect-error stub getSelection for SSR
-    document.getSelection = ()=>({});
-    document.createRange = ()=>({
-            setStart () {},
-            setEnd () {},
-            // @ts-expect-error stub getBoundingClientRect for SSR
-            getClientRects () {
-                return {
-                    left: 0,
-                    top: 0,
-                    right: 0,
-                    bottom: 0
-                };
-            },
-            // @ts-expect-error stub getBoundingClientRect for SSR
-            getBoundingClientRect () {
-                return {
-                    left: 0,
-                    top: 0,
-                    right: 0,
-                    bottom: 0
-                };
-            }
-        });
-}

package/dist/esm/plugins/componentEventListeners.js

@@ -1,18 +0,0 @@
-import { unstable_batchedUpdates as batch } from "react-dom";
-export function componentEventListeners(eventHandlerRegistry) {
-    const domEventHandlers = {};
-    for (const [eventType, handlers] of eventHandlerRegistry.entries()){
-        function handleEvent(view, event) {
-            for (const handler of handlers){
-                let handled = false;
-                batch(()=>{
-                    handled = !!handler(view, event);
-                });
-                if (handled || event.defaultPrevented) return true;
-            }
-            return false;
-        }
-        domEventHandlers[eventType] = handleEvent;
-    }
-    return domEventHandlers;
-}

package/dist/esm/plugins/componentEventListenersPlugin.js

@@ -1,25 +0,0 @@
-/* Copyright (c) The New York Times Company */ import { Plugin, PluginKey } from "prosemirror-state";
-import { unstable_batchedUpdates as batch } from "react-dom";
-export function createComponentEventListenersPlugin(eventHandlerRegistry) {
-    const domEventHandlers = {};
-    for (const [eventType, handlers] of eventHandlerRegistry.entries()){
-        function handleEvent(view, event) {
-            for (const handler of handlers){
-                let handled = false;
-                batch(()=>{
-                    handled = !!handler.call(this, view, event);
-                });
-                if (handled || event.defaultPrevented) return true;
-            }
-            return false;
-        }
-        domEventHandlers[eventType] = handleEvent;
-    }
-    const plugin = new Plugin({
-        key: new PluginKey("componentEventListeners"),
-        props: {
-            handleDOMEvents: domEventHandlers
-        }
-    });
-    return plugin;
-}

package/dist/esm/tiptap/utils/ssrJSDOMPatch.js

@@ -1,56 +0,0 @@
-/**
- * This file is used to patch global DOM variables in a NodeJS environment.
- * This is needed for ProseMirror to work in a NodeJS environment.
- */ if (typeof window === "undefined") {
-    // Make sure to import JSDOM only in a NodeJS environment.
-    // The magic comments prevent bundlers from statically analyzing this require:
-    // - webpackIgnore: true  → webpack / Next.js
-    // - @vite-ignore         → Vite
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    const jsdom = require(/* webpackIgnore: true */ /* @vite-ignore */ "jsdom");
-    const html = `
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>Testing</title>
-  </head>
-  <body></body>
-</html>
-`;
-    const { window: window1 } = new jsdom.JSDOM(html);
-    global.window = window1;
-    global.document = window1.document;
-    // Use Object.defineProperty for navigator since it's read-only in Node.js 22+
-    Object.defineProperty(global, "navigator", {
-        value: window1.navigator,
-        writable: true,
-        configurable: true
-    });
-    global.innerHeight = 0;
-    global.SVGElement = window1.SVGElement;
-    // @ts-expect-error stub getSelection for SSR
-    document.getSelection = ()=>({});
-    document.createRange = ()=>({
-            setStart () {},
-            setEnd () {},
-            // @ts-expect-error stub getBoundingClientRect for SSR
-            getClientRects () {
-                return {
-                    left: 0,
-                    top: 0,
-                    right: 0,
-                    bottom: 0
-                };
-            },
-            // @ts-expect-error stub getBoundingClientRect for SSR
-            getBoundingClientRect () {
-                return {
-                    left: 0,
-                    top: 0,
-                    right: 0,
-                    bottom: 0
-                };
-            }
-        });
-}
-export { };

package/dist/types/plugins/componentEventListeners.d.ts

@@ -1,3 +0,0 @@
-import { DOMEventMap, EditorView } from "prosemirror-view";
-export type EventHandler<EventType extends keyof DOMEventMap = keyof DOMEventMap> = (view: EditorView, event: DOMEventMap[EventType]) => boolean | void;
-export declare function componentEventListeners(eventHandlerRegistry: Map<keyof DOMEventMap, Iterable<EventHandler>>): Record<keyof DOMEventMap, EventHandler<keyof DOMEventMap>>;

package/dist/types/plugins/componentEventListenersPlugin.d.ts

@@ -1,4 +0,0 @@
-import { Plugin } from "prosemirror-state";
-import { DOMEventMap, EditorView } from "prosemirror-view";
-export type EventHandler<EventType extends keyof DOMEventMap = keyof DOMEventMap> = (this: Plugin, view: EditorView, event: DOMEventMap[EventType]) => boolean | void;
-export declare function createComponentEventListenersPlugin(eventHandlerRegistry: Map<keyof DOMEventMap, Set<EventHandler>>): Plugin<any>;

package/dist/types/tiptap/utils/ssrJSDOMPatch.d.ts

@@ -1 +0,0 @@
-export {};