@handlewithcare/react-prosemirror 3.1.0-tiptap.48 → 3.1.0-tiptap.50

package/dist/types/components/TextNodeView.d.ts

@@ -2,7 +2,7 @@ import { Node } from "prosemirror-model";
 import { DOMEventMap, Decoration } from "prosemirror-view";
 import { Component, MutableRefObject } from "react";
 import { AbstractEditorView } from "../AbstractEditorView.js";
-import { EventHandler } from "../plugins/componentEventListeners.js";
+import { EventHandler } from "../hooks/useComponentEventListeners.js";
 import { CompositionViewDesc, TextViewDesc, ViewDesc } from "../viewdesc.js";
 type Props = {
     view: AbstractEditorView;
@@ -21,7 +21,7 @@ export declare class TextNodeView extends Component<Props> {
     containsCompositionNodeText: boolean;
     shouldProtect(props: Props): boolean;
     handleCompositionEnd: () => void;
-    create(): CompositionViewDesc | TextViewDesc | null;
+    create(): TextViewDesc | CompositionViewDesc | null;
     update(): boolean;
     destroy(): void;
     updateEffect(): void;

package/dist/types/constants.d.ts

@@ -1,4 +1,4 @@
 import { Schema } from "prosemirror-model";
 import { EditorState } from "prosemirror-state";
-export declare const EMPTY_SCHEMA: Schema<"doc" | "text", any>;
+export declare const EMPTY_SCHEMA: Schema<"text" | "doc", any>;
 export declare const EMPTY_STATE: EditorState;

package/dist/types/contexts/EditorContext.d.ts

@@ -1,7 +1,7 @@
 import type { DOMEventMap } from "prosemirror-view";
 import { MutableRefObject } from "react";
 import { AbstractEditorView } from "../AbstractEditorView.js";
-import type { EventHandler } from "../plugins/componentEventListeners.js";
+import type { EventHandler } from "../hooks/useComponentEventListeners.js";
 export interface EditorContextValue {
     view: AbstractEditorView;
     flushSyncRef: MutableRefObject<boolean>;

package/dist/types/hooks/useComponentEventListeners.d.ts

@@ -1,5 +1,6 @@
-import type { DOMEventMap } from "prosemirror-view";
-import { EventHandler } from "../plugins/componentEventListeners.js";
+import type { DOMEventMap, EditorView } from "prosemirror-view";
+export type EventHandler<EventType extends keyof DOMEventMap = keyof DOMEventMap> = (view: EditorView, event: DOMEventMap[EventType]) => boolean | void;
+export type HandleDOMEvents = Record<keyof DOMEventMap, EventHandler | undefined>;
 /**
  * Produces a plugin that can be used with ProseMirror to handle DOM
  * events at the EditorView.dom element.
@@ -14,20 +15,20 @@ import { EventHandler } from "../plugins/componentEventListeners.js";
  * @privateRemarks
  *
  * This hook uses a combination of mutable and immutable updates to give
- * us precise control over when we re-create the ProseMirror plugin.
+ * us precise control over when we re-create the event listeners.
  *
- * The plugin has a mutable reference to the set of handlers for each
+ * The hook has a mutable reference to the set of handlers for each
  * event type, but the set of event types is static. This means that we
- * need to produce a new ProseMirror plugin whenever a new event type is
- * registered. We avoid producing a new ProseMirrer plugin in any other
- * scenario to avoid the performance overhead of reconfiguring the plugins
- * in the EditorView.
+ * need to produce a new handleDOMEVents record whenever a new event type is
+ * registered. We avoid producing a new record in any other
+ * scenario to avoid the performance overhead of re-registering the event
+ * listeners in the EditorView.
  *
  * To accomplish this, we shallowly clone the registry whenever a new event
  * type is registered.
  */
-export declare function useComponentEventListeners(): {
+export declare function useComponentEventListeners(existingHandlers: HandleDOMEvents | undefined): {
     registerEventListener: (eventType: keyof DOMEventMap, handler: EventHandler) => void;
     unregisterEventListener: (eventType: keyof DOMEventMap, handler: EventHandler) => void;
-    componentEventListenersPlugin: import("prosemirror-state").Plugin<any>;
+    handleDOMEvents: HandleDOMEvents;
 };

package/dist/types/hooks/useEditor.d.ts

@@ -21,8 +21,8 @@ export declare function useEditor<T extends HTMLElement = HTMLElement>(mount: T
     editor: {
         view: AbstractEditorView;
         flushSyncRef: import("react").MutableRefObject<boolean>;
-        registerEventListener: (eventType: keyof import("prosemirror-view").DOMEventMap, handler: import("../plugins/componentEventListeners.js").EventHandler<keyof import("prosemirror-view").DOMEventMap>) => void;
-        unregisterEventListener: (eventType: keyof import("prosemirror-view").DOMEventMap, handler: import("../plugins/componentEventListeners.js").EventHandler<keyof import("prosemirror-view").DOMEventMap>) => void;
+        registerEventListener: (eventType: keyof import("prosemirror-view").DOMEventMap, handler: import("./useComponentEventListeners.js").EventHandler<keyof import("prosemirror-view").DOMEventMap>) => void;
+        unregisterEventListener: (eventType: keyof import("prosemirror-view").DOMEventMap, handler: import("./useComponentEventListeners.js").EventHandler<keyof import("prosemirror-view").DOMEventMap>) => void;
         isStatic: boolean;
     };
     cursorWrapper: Decoration | null;

package/dist/types/hooks/useEditorEventListener.d.ts

@@ -1,5 +1,5 @@
 import type { DOMEventMap } from "prosemirror-view";
-import type { EventHandler } from "../plugins/componentEventListeners.js";
+import type { EventHandler } from "./useComponentEventListeners.js";
 /**
  * Attaches an event listener at the `EditorView`'s DOM node. See
  * [the ProseMirror docs](https://prosemirror.net/docs/ref/#view.EditorProps.handleDOMEvents)

package/dist/types/props.d.ts

@@ -904,19 +904,19 @@ export declare function mergeReactProps(a: HTMLProps<HTMLElement>, b: HTMLProps<
     suppressContentEditableWarning?: boolean | undefined;
     suppressHydrationWarning?: boolean | undefined;
     accessKey?: string | undefined;
-    autoCapitalize?: "off" | "none" | "on" | "sentences" | "words" | "characters" | (string & {}) | undefined;
+    autoCapitalize?: "none" | (string & {}) | "off" | "on" | "sentences" | "words" | "characters" | undefined;
     autoFocus?: boolean | undefined;
-    contentEditable?: (boolean | "false" | "true") | "inherit" | "plaintext-only" | undefined;
+    contentEditable?: (boolean | "true" | "false") | "inherit" | "plaintext-only" | undefined;
     contextMenu?: string | undefined;
     dir?: string | undefined;
-    draggable?: (boolean | "false" | "true") | undefined;
-    enterKeyHint?: "enter" | "done" | "go" | "next" | "previous" | "search" | "send" | undefined;
+    draggable?: (boolean | "true" | "false") | undefined;
+    enterKeyHint?: "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | undefined;
     hidden?: boolean | undefined;
     id?: string | undefined;
     lang?: string | undefined;
     nonce?: string | undefined;
     slot?: string | undefined;
-    spellCheck?: (boolean | "false" | "true") | undefined;
+    spellCheck?: (boolean | "true" | "false") | undefined;
     tabIndex?: number | undefined;
     title?: string | undefined;
     translate?: "yes" | "no" | undefined;
@@ -944,57 +944,57 @@ export declare function mergeReactProps(a: HTMLProps<HTMLElement>, b: HTMLProps<
     results?: number | undefined;
     security?: string | undefined;
     unselectable?: "off" | "on" | undefined;
-    inputMode?: "text" | "none" | "search" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined;
+    inputMode?: "search" | "text" | "none" | "email" | "tel" | "url" | "numeric" | "decimal" | undefined;
     is?: string | undefined;
     exportparts?: string | undefined;
     part?: string | undefined;
     "aria-activedescendant"?: string | undefined;
-    "aria-atomic"?: (boolean | "false" | "true") | undefined;
-    "aria-autocomplete"?: "none" | "list" | "inline" | "both" | undefined;
+    "aria-atomic"?: (boolean | "true" | "false") | undefined;
+    "aria-autocomplete"?: "list" | "none" | "both" | "inline" | undefined;
     "aria-braillelabel"?: string | undefined;
     "aria-brailleroledescription"?: string | undefined;
-    "aria-busy"?: (boolean | "false" | "true") | undefined;
-    "aria-checked"?: boolean | "false" | "true" | "mixed" | undefined;
+    "aria-busy"?: (boolean | "true" | "false") | undefined;
+    "aria-checked"?: boolean | "true" | "false" | "mixed" | undefined;
     "aria-colcount"?: number | undefined;
     "aria-colindex"?: number | undefined;
     "aria-colindextext"?: string | undefined;
     "aria-colspan"?: number | undefined;
     "aria-controls"?: string | undefined;
-    "aria-current"?: boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time" | undefined;
+    "aria-current"?: boolean | "time" | "step" | "date" | "true" | "false" | "page" | "location" | undefined;
     "aria-describedby"?: string | undefined;
     "aria-description"?: string | undefined;
     "aria-details"?: string | undefined;
-    "aria-disabled"?: (boolean | "false" | "true") | undefined;
-    "aria-dropeffect"?: "none" | "link" | "copy" | "execute" | "move" | "popup" | undefined;
+    "aria-disabled"?: (boolean | "true" | "false") | undefined;
+    "aria-dropeffect"?: "copy" | "link" | "none" | "move" | "execute" | "popup" | undefined;
     "aria-errormessage"?: string | undefined;
-    "aria-expanded"?: (boolean | "false" | "true") | undefined;
+    "aria-expanded"?: (boolean | "true" | "false") | undefined;
     "aria-flowto"?: string | undefined;
-    "aria-grabbed"?: (boolean | "false" | "true") | undefined;
-    "aria-haspopup"?: boolean | "false" | "true" | "dialog" | "grid" | "listbox" | "menu" | "tree" | undefined;
-    "aria-hidden"?: (boolean | "false" | "true") | undefined;
-    "aria-invalid"?: boolean | "false" | "true" | "grammar" | "spelling" | undefined;
+    "aria-grabbed"?: (boolean | "true" | "false") | undefined;
+    "aria-haspopup"?: boolean | "dialog" | "menu" | "grid" | "listbox" | "tree" | "true" | "false" | undefined;
+    "aria-hidden"?: (boolean | "true" | "false") | undefined;
+    "aria-invalid"?: boolean | "true" | "false" | "grammar" | "spelling" | undefined;
     "aria-keyshortcuts"?: string | undefined;
     "aria-label"?: string | undefined;
     "aria-labelledby"?: string | undefined;
     "aria-level"?: number | undefined;
     "aria-live"?: "off" | "assertive" | "polite" | undefined;
-    "aria-modal"?: (boolean | "false" | "true") | undefined;
-    "aria-multiline"?: (boolean | "false" | "true") | undefined;
-    "aria-multiselectable"?: (boolean | "false" | "true") | undefined;
+    "aria-modal"?: (boolean | "true" | "false") | undefined;
+    "aria-multiline"?: (boolean | "true" | "false") | undefined;
+    "aria-multiselectable"?: (boolean | "true" | "false") | undefined;
     "aria-orientation"?: "horizontal" | "vertical" | undefined;
     "aria-owns"?: string | undefined;
     "aria-placeholder"?: string | undefined;
     "aria-posinset"?: number | undefined;
-    "aria-pressed"?: boolean | "false" | "true" | "mixed" | undefined;
-    "aria-readonly"?: (boolean | "false" | "true") | undefined;
-    "aria-relevant"?: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefined;
-    "aria-required"?: (boolean | "false" | "true") | undefined;
+    "aria-pressed"?: boolean | "true" | "false" | "mixed" | undefined;
+    "aria-readonly"?: (boolean | "true" | "false") | undefined;
+    "aria-relevant"?: "text" | "all" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefined;
+    "aria-required"?: (boolean | "true" | "false") | undefined;
     "aria-roledescription"?: string | undefined;
     "aria-rowcount"?: number | undefined;
     "aria-rowindex"?: number | undefined;
     "aria-rowindextext"?: string | undefined;
     "aria-rowspan"?: number | undefined;
-    "aria-selected"?: (boolean | "false" | "true") | undefined;
+    "aria-selected"?: (boolean | "true" | "false") | undefined;
     "aria-setsize"?: number | undefined;
     "aria-sort"?: "none" | "ascending" | "descending" | "other" | undefined;
     "aria-valuemax"?: number | undefined;

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

@@ -0,0 +1,38 @@
+import { Editor, type EditorOptions } from "@tiptap/core";
+import { DependencyList } from "react";
+/**
+ * The options for the `useEditor` hook.
+ */
+export type UseEditorOptions = Partial<EditorOptions> & {
+    /**
+     * Whether to render the editor on the first render.
+     * If client-side rendering, set this to `true`.
+     * If server-side rendering, set this to `false`.
+     * @default true
+     */
+    immediatelyRender?: boolean;
+    /**
+     * Whether to re-render the editor on each transaction.
+     * This is legacy behavior that will be removed in future versions.
+     * @default false
+     */
+    shouldRerenderOnTransaction?: boolean;
+};
+/**
+ * This hook allows you to create an editor instance.
+ * @param options The editor options
+ * @param deps The dependencies to watch for changes
+ * @returns The editor instance
+ * @example const editor = useEditor({ extensions: [...] })
+ */
+export declare function useEditor(options: UseEditorOptions & {
+    immediatelyRender: false;
+}, deps?: DependencyList): Editor | null;
+/**
+ * This hook allows you to create an editor instance.
+ * @param options The editor options
+ * @param deps The dependencies to watch for changes
+ * @returns The editor instance
+ * @example const editor = useEditor({ extensions: [...] })
+ */
+export declare function useEditor(options: UseEditorOptions, deps?: DependencyList): Editor;

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

@@ -1,4 +1,4 @@
-import { useEditor } from "@tiptap/react";
 import { DependencyList } from "react";
+import { useEditor } from "./useEditor.js";
 export type UseTiptapEditorOptions = Omit<Parameters<typeof useEditor>[0], "element">;
 export declare function useTiptapEditor(options: UseTiptapEditorOptions, deps?: DependencyList): import("@tiptap/core").Editor;

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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@handlewithcare/react-prosemirror",
-  "version": "3.1.0-tiptap.48",
+  "version": "3.1.0-tiptap.50",
   "license": "Apache-2.0",
   "type": "module",
   "main": "dist/cjs/index.js",