@handlewithcare/react-prosemirror 2.4.12 → 2.5.0

package/dist/esm/ssr.js

@@ -1,82 +0,0 @@
-/* eslint-disable @typescript-eslint/no-empty-function */ /**
- * @fileoverview
- *
- * Stubs for ProseMirror View during SSR. These are extremely
- * barebones, because they _do not need to actually work_. They
- * just need to prevent errors from being thrown when ProseMirror
- * View attemps to access these APIs while constructing the
- * initial EditorView. None of these APIs are necessary for SSR to
- * work properly, so it's fine that they're all no-ops.
- */ let ClassList = class ClassList {
-    add() {}
-    remove() {}
-};
-let ElementStub = class ElementStub {
-    get parent() {
-        return new ElementStub();
-    }
-    get parentNode() {
-        return new ElementStub();
-    }
-    nodeName = "div";
-    appendChild() {
-        return new ElementStub();
-    }
-    setAttribute() {}
-    hasAttribute() {
-        return false;
-    }
-    insertBefore() {}
-    get classList() {
-        return new ClassList();
-    }
-    get ownerDocument() {
-        return new DocumentStub();
-    }
-    style = {};
-    addEventListener() {}
-    removeEventListener() {}
-    replaceChildren() {}
-};
-let DocumentStub = class DocumentStub {
-    createElement() {
-        return new ElementStub();
-    }
-    addEventListener() {}
-    removeEventListener() {}
-    get documentElement() {
-        return new ElementStub();
-    }
-};
-/**
- * Sets up tiny no-op stubs for the global window and document.
- * These are used to prevent errors from being thrown when ProseMirror's
- * EditorView attempts to access the DOM in its constructor during SSR.
- *
- * Returns a cleanup function that resets the window and document back
- * to their original values (undefined).
- */ export function setSsrStubs() {
-    const prevWindow = globalThis.window;
-    // @ts-expect-error HACK - EditorView checks for window.MutationObserver
-    // in its constructor, which breaks SSR. We temporarily set window
-    // to an empty object to prevent an error from being thrown, and then
-    // clean it up so that other isomorphic code doesn't get confused about
-    // whether there's a functioning global window object
-    globalThis.window ??= {
-        visualViewport: null
-    };
-    const prevDocument = globalThis.document;
-    // @ts-expect-error HACK: This is only used during SSR, and only
-    // to prevent outright errors when ProseMirror View attempts to
-    // access document properties either on import or when constructing
-    // the EditorView.
-    globalThis.document ??= new DocumentStub();
-    return function cleanupSsrStubs() {
-        if (globalThis.window !== prevWindow) {
-            globalThis.window = prevWindow;
-        }
-        if (globalThis.document !== prevDocument) {
-            globalThis.document = prevDocument;
-        }
-    };
-}

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

@@ -1,7 +0,0 @@
-import type { ReactNode } from "react";
-import type { UseEditorViewOptions } from "../hooks/useEditorView.js";
-export interface EditorProps extends UseEditorViewOptions {
-    mount: HTMLElement | null;
-    children?: ReactNode | null;
-}
-export declare function Editor({ mount, children, ...options }: EditorProps): JSX.Element;

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

@@ -1,6 +0,0 @@
-import type { NodeViewsContextValue } from "../contexts/NodeViewsContext.js";
-type NodeViewsProps = {
-    portals: NodeViewsContextValue;
-};
-export declare function NodeViews({ portals }: NodeViewsProps): JSX.Element;
-export {};

package/dist/types/components/__tests__/LayoutGroup.test.d.ts

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

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

@@ -1,19 +0,0 @@
-import type { ReactPortal } from "react";
-import type { NodeKey } from "../plugins/react";
-type NodeViewRegistration = {
-    getPos: () => number;
-    portal: ReactPortal;
-};
-export interface NodeViewsContextValue {
-    [key: NodeKey]: NodeViewRegistration[];
-}
-/**
- * A context containing a map of node view keys to portals.
- *
- * Each node view registers a portal under its parent's
- * key. Each can then retrieve the list of portals under their
- * key, allowing portals to be rendered with the appropriate
- * hierarchy.
- */
-export declare const NodeViewsContext: import("react").Context<NodeViewsContextValue>;
-export {};

package/dist/types/hooks/__tests__/useEditorViewLayoutEffect.test.d.ts

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

package/dist/types/hooks/__tests__/useNodeViews.test.d.ts

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

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

@@ -1,23 +0,0 @@
-import { EditorState } from "prosemirror-state";
-import type { Plugin, Transaction } from "prosemirror-state";
-import { EditorView } from "prosemirror-view";
-import type { EditorProps } from "prosemirror-view";
-import type { EditorContextValue } from "../contexts/EditorContext.js";
-import type { ReactNodeViewConstructor } from "../nodeViews/createReactNodeViewConstructor.js";
-export interface UseEditorViewOptions extends EditorProps {
-    nodeViews?: Record<string, ReactNodeViewConstructor>;
-    defaultState?: EditorState;
-    state?: EditorState;
-    plugins?: Plugin[];
-    view?: EditorView | null;
-    dispatchTransaction?(this: EditorView, tr: Transaction): void;
-}
-/**
- * Creates, mounts, and manages a ProseMirror `EditorView`.
- *
- * All state and props updates are executed in a layout effect.
- * To ensure that the EditorState and EditorView are never out of
- * sync, it's important that the EditorView produced by this hook
- * is only accessed through the provided hooks.
- */
-export declare function useEditorView<T extends HTMLElement = HTMLElement>(mount: T | null, options: UseEditorViewOptions): EditorContextValue;

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

@@ -1,9 +0,0 @@
-import type { ReactNode } from "react";
-import type { NodeKey } from "../plugins/react.js";
-type Props = {
-    nodeKey: NodeKey;
-    children: ReactNode;
-};
-export declare function NodePosProvider({ nodeKey, children }: Props): JSX.Element;
-export declare function useNodePos(): number;
-export {};

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

@@ -1,5 +0,0 @@
-import type { ReactNodeViewConstructor } from "../nodeViews/createReactNodeViewConstructor.js";
-export declare function useNodeViews(nodeViews?: Record<string, ReactNodeViewConstructor>): {
-    nodeViews: any;
-    nodeViewsComponent: JSX.Element;
-};

package/dist/types/nodeViews/createReactNodeViewConstructor.d.ts

@@ -1,48 +0,0 @@
-import type { Node } from "prosemirror-model";
-import type { Decoration, DecorationSource, EditorView, NodeView, NodeViewConstructor } from "prosemirror-view";
-import type { ComponentType, ReactNode, ReactPortal } from "react";
-import type { NodeKey } from "../plugins/react.js";
-export interface NodeViewComponentProps {
-    decorations: readonly Decoration[];
-    node: Node;
-    children: ReactNode;
-    isSelected: boolean;
-}
-export type UnregisterElement = () => void;
-export type RegisterPortal = (view: EditorView, getPos: () => number, portal: ReactPortal) => UnregisterElement;
-export type ReactNodeView = NodeView & {
-    component?: ComponentType<NodeViewComponentProps>;
-};
-export type ReactNodeViewConstructor = (...args: Parameters<NodeViewConstructor>) => ReactNodeView;
-/**
- * Identifies a node view constructor as having been created
- * by @nytimes/react-prosemirror
- */
-export declare const REACT_NODE_VIEW: unique symbol;
-/**
- * Searches upward for the nearest node with a node key,
- * returning the first node key it finds associated with
- * a React node view.
- *
- * Returns the root key if no ancestor nodes have node keys.
- */
-export declare function findNodeKeyUp(editorView: EditorView, pos: number): NodeKey;
-/**
- * Factory function for creating nodeViewConstructors that
- * render as React components.
- *
- * `NodeView` can be any React component that takes
- * `NodeViewComponentProps`. It will be passed all of the
- * arguments to the `nodeViewConstructor` except for
- * `editorView`. NodeView components that need access
- * directly to the EditorView should use the
- * `useEditorViewEvent` and `useEditorViewLayoutEffect`
- * hooks to ensure safe access.
- *
- * For contentful Nodes, the NodeView component will also
- * be passed a `children` prop containing an empty element.
- * ProseMirror will render content nodes into this element.
- */
-export declare function createReactNodeViewConstructor(nodeViewConstructor: ReactNodeViewConstructor, registerPortal: RegisterPortal): ((node: Node, editorView: EditorView, getPos: () => number, decorations: readonly Decoration[], innerDecorations: DecorationSource) => NodeView) & {
-    [REACT_NODE_VIEW]: boolean;
-};

package/dist/types/nodeViews/phrasingContentTags.d.ts

@@ -1 +0,0 @@
-export declare const phrasingContentTags: string[];

package/dist/types/plugins/__tests__/react.test.d.ts

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

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

@@ -1,21 +0,0 @@
-import { Plugin, PluginKey } from "prosemirror-state";
-/**
- * This is a stand-in for the doc node itself, which doesn't have a
- * unique position to map to.
- */
-export declare const ROOT_NODE_KEY: unique symbol;
-export type NodeKey = string | symbol;
-export declare function createNodeKey(): string;
-export type ReactPluginState = {
-    posToKey: Map<number, string>;
-    keyToPos: Map<NodeKey, number>;
-};
-export declare const reactPluginKey: PluginKey<ReactPluginState>;
-/**
- * Tracks a unique key for each (non-text) node in the
- * document, identified by its current position. Keys are
- * (mostly) stable across transaction applications. The
- * key for a given node can be accessed by that node's
- * current position in the document, and vice versa.
- */
-export declare function react(): Plugin<ReactPluginState>;

package/dist/types/selection/SelectionDOMObserver.d.ts

@@ -1,33 +0,0 @@
-import { EditorView } from "prosemirror-view";
-import { DOMSelectionRange } from "../dom.js";
-declare class SelectionState {
-    anchorNode: Node | null;
-    anchorOffset: number;
-    focusNode: Node | null;
-    focusOffset: number;
-    set(sel: DOMSelectionRange): void;
-    clear(): void;
-    eq(sel: DOMSelectionRange): boolean;
-}
-export declare class SelectionDOMObserver {
-    readonly view: EditorView;
-    flushingSoon: number;
-    currentSelection: SelectionState;
-    suppressingSelectionUpdates: boolean;
-    constructor(view: EditorView);
-    connectSelection(): void;
-    disconnectSelection(): void;
-    stop(): void;
-    start(): void;
-    suppressSelectionUpdates(): void;
-    setCurSelection(): void;
-    ignoreSelectionChange(sel: DOMSelectionRange): true | undefined;
-    registerMutation(): void;
-    flushSoon(): void;
-    updateSelection(): void;
-    selectionToDOM(): void;
-    flush(): void;
-    forceFlush(): void;
-    onSelectionChange(): void;
-}
-export {};

package/dist/types/selection/hasFocusAndSelection.d.ts

@@ -1,3 +0,0 @@
-import { EditorView } from "prosemirror-view";
-export declare function hasFocusAndSelection(view: EditorView): boolean;
-export declare function hasSelection(view: EditorView): boolean;

package/dist/types/selection/selectionFromDOM.d.ts

@@ -1,4 +0,0 @@
-import { ResolvedPos } from "prosemirror-model";
-import { EditorView } from "prosemirror-view";
-export declare function selectionBetween(view: EditorView, $anchor: ResolvedPos, $head: ResolvedPos, bias?: number): import("prosemirror-state").Selection;
-export declare function selectionFromDOM(view: EditorView, origin?: string | null): import("prosemirror-state").Selection | null;

package/dist/types/selection/selectionToDOM.d.ts

@@ -1,9 +0,0 @@
-import { Selection } from "prosemirror-state";
-import { EditorView } from "prosemirror-view";
-export declare const isEquivalentPosition: (node: Node, off: number, targetNode: Node, targetOff: number) => boolean;
-export declare function hasBlockDesc(dom: Node): boolean | null | undefined;
-export declare const domIndex: (node: Node) => number;
-export declare function nodeSize(node: Node): number;
-export declare function syncNodeSelection(view: EditorView, sel: Selection): void;
-export declare function hasSelection(view: EditorView): boolean;
-export declare function selectionToDOM(view: EditorView, force?: boolean): void;

package/dist/types/ssr.d.ts

@@ -1,19 +0,0 @@
-/**
- * @fileoverview
- *
- * Stubs for ProseMirror View during SSR. These are extremely
- * barebones, because they _do not need to actually work_. They
- * just need to prevent errors from being thrown when ProseMirror
- * View attemps to access these APIs while constructing the
- * initial EditorView. None of these APIs are necessary for SSR to
- * work properly, so it's fine that they're all no-ops.
- */
-/**
- * Sets up tiny no-op stubs for the global window and document.
- * These are used to prevent errors from being thrown when ProseMirror's
- * EditorView attempts to access the DOM in its constructor during SSR.
- *
- * Returns a cleanup function that resets the window and document back
- * to their original values (undefined).
- */
-export declare function setSsrStubs(): () => void;