@handlewithcare/react-prosemirror 2.0.0

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

@@ -0,0 +1,34 @@
+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;
+    selectionChanged(sel: DOMSelectionRange): boolean;
+    forceFlush(): void;
+    onSelectionChange(): void;
+}
+export {};

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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,19 @@
+/**
+ * @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;

package/dist/types/testing/editorViewTestHelpers.d.ts

@@ -0,0 +1,23 @@
+import { Node } from "prosemirror-model";
+import { doc } from "prosemirror-test-builder";
+import { EditorView as EditorViewT } from "prosemirror-view";
+import { Props } from "../components/ProseMirror.js";
+import { DOMNode } from "../dom.js";
+declare module "expect" {
+    interface AsymmetricMatchers {
+        toEqualNode(actual: Node): void;
+    }
+    interface Matchers<R> {
+        toEqualNode(actual: Node): R;
+    }
+}
+export declare function tempEditor({ doc: startDoc, selection, controlled, plugins, ...props }: {
+    doc?: ReturnType<typeof doc>;
+    selection?: Selection;
+    controlled?: boolean;
+} & Omit<Props, "state">): {
+    view: EditorViewT;
+    rerender: (props?: Omit<Props, "state" | "plugins">) => void;
+    unmount: () => void;
+};
+export declare function findTextNode(node: DOMNode, text: string): Text;

package/dist/types/testing/setupProseMirrorView.d.ts

@@ -0,0 +1,2 @@
+export declare function setupProseMirrorView(): void;
+export declare function teardownProseMirrorView(): void;

package/dist/types/viewdesc.d.ts

@@ -0,0 +1,131 @@
+import { Mark, Node, TagParseRule } from "prosemirror-model";
+import { Decoration, DecorationSource, EditorView } from "prosemirror-view";
+import { DOMNode } from "./dom.js";
+export declare function sortViewDescs(a: ViewDesc, b: ViewDesc): number;
+export declare class ViewDesc {
+    parent: ViewDesc | undefined;
+    children: ViewDesc[];
+    getPos: () => number;
+    dom: DOMNode;
+    contentDOM: HTMLElement | null;
+    dirty: number;
+    node: Node | null;
+    constructor(parent: ViewDesc | undefined, children: ViewDesc[], getPos: () => number, dom: DOMNode, contentDOM: HTMLElement | null);
+    matchesWidget(_widget: Decoration): boolean;
+    matchesMark(_mark: Mark): boolean;
+    matchesNode(_node: Node, _outerDeco: readonly Decoration[], _innerDeco: DecorationSource): boolean;
+    matchesHack(nodeName: string): boolean;
+    parseRule(): Omit<TagParseRule, "tag"> | null;
+    stopEvent(event: Event): boolean;
+    get size(): number;
+    get border(): number;
+    destroy(): void;
+    posBeforeChild(child: ViewDesc): number;
+    get posBefore(): number;
+    get posAtStart(): number;
+    get posAfter(): number;
+    get posAtEnd(): number;
+    localPosFromDOM(dom: DOMNode, offset: number, bias: number): number;
+    nearestDesc(dom: DOMNode): ViewDesc | undefined;
+    nearestDesc(dom: DOMNode, onlyNodes: true): NodeViewDesc | undefined;
+    getDesc(dom: DOMNode): ViewDesc | undefined;
+    posFromDOM(dom: DOMNode, offset: number, bias: number): number;
+    descAt(pos: number): ViewDesc | undefined;
+    domFromPos(pos: number, side: number): {
+        node: DOMNode;
+        offset: number;
+        atom?: number;
+    };
+    parseRange(from: number, to: number, base?: number): {
+        node: DOMNode;
+        from: number;
+        to: number;
+        fromOffset: number;
+        toOffset: number;
+    };
+    emptyChildAt(side: number): boolean;
+    domAfterPos(pos: number): DOMNode;
+    setSelection(anchor: number, head: number, root: Document | ShadowRoot, force?: boolean): void;
+    ignoreMutation(mutation: MutationRecord): boolean;
+    get contentLost(): boolean | null;
+    markDirty(from: number, to: number): void;
+    markParentsDirty(): void;
+    get domAtom(): boolean;
+    get ignoreForCoords(): boolean;
+}
+export declare class WidgetViewDesc extends ViewDesc {
+    widget: Decoration;
+    constructor(parent: ViewDesc | undefined, getPos: () => number, widget: Decoration, dom: DOMNode);
+    matchesWidget(widget: Decoration): any;
+    parseRule(): {
+        ignore: boolean;
+    };
+    stopEvent(event: Event): any;
+    ignoreMutation(mutation: MutationRecord): any;
+    get domAtom(): boolean;
+    get side(): number;
+}
+export declare class CompositionViewDesc extends ViewDesc {
+    textDOM: Text;
+    text: string;
+    constructor(parent: ViewDesc | undefined, getPos: () => number, dom: DOMNode, textDOM: Text, text: string);
+    get size(): number;
+    localPosFromDOM(dom: DOMNode, offset: number): number;
+    domFromPos(pos: number): {
+        node: Text;
+        offset: number;
+    };
+    ignoreMutation(mut: MutationRecord): boolean;
+}
+export declare class MarkViewDesc extends ViewDesc {
+    mark: Mark;
+    constructor(parent: ViewDesc | undefined, children: ViewDesc[], getPos: () => number, mark: Mark, dom: DOMNode, contentDOM: HTMLElement);
+    parseRule(): {
+        mark: string;
+        attrs: import("prosemirror-model").Attrs;
+        contentElement: HTMLElement;
+    } | null;
+    matchesMark(mark: Mark): boolean;
+    markDirty(from: number, to: number): void;
+}
+export declare class NodeViewDesc extends ViewDesc {
+    node: Node;
+    outerDeco: readonly Decoration[];
+    innerDeco: DecorationSource;
+    nodeDOM: DOMNode;
+    stopEvent: (event: Event) => boolean;
+    selectNode: () => void;
+    deselectNode: () => void;
+    constructor(parent: ViewDesc | undefined, children: ViewDesc[], getPos: () => number, node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, dom: DOMNode, contentDOM: HTMLElement | null, nodeDOM: DOMNode, stopEvent: (event: Event) => boolean, selectNode: () => void, deselectNode: () => void);
+    updateOuterDeco(): void;
+    parseRule(): Omit<TagParseRule, "tag"> | null;
+    matchesNode(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource): boolean;
+    get size(): number;
+    get border(): 1 | 0;
+    update(_node: Node, _outerDeco: readonly Decoration[], _innerDeco: DecorationSource, _view: EditorView): boolean;
+    get domAtom(): boolean;
+}
+export declare class TextViewDesc extends NodeViewDesc {
+    constructor(parent: ViewDesc | undefined, children: ViewDesc[], getPos: () => number, node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, dom: DOMNode, nodeDOM: DOMNode);
+    parseRule(): {
+        skip: any;
+    };
+    update(_node: Node, _outerDeco: readonly Decoration[], _innerDeco: DecorationSource, _view: EditorView): boolean;
+    inParent(): boolean;
+    domFromPos(pos: number): {
+        node: globalThis.Node;
+        offset: number;
+    };
+    localPosFromDOM(dom: DOMNode, offset: number, bias: number): number;
+    ignoreMutation(mutation: MutationRecord): boolean;
+    markDirty(from: number, to: number): void;
+    get domAtom(): boolean;
+}
+export declare class TrailingHackViewDesc extends ViewDesc {
+    parseRule(): {
+        ignore: boolean;
+    };
+    matchesHack(nodeName: string): boolean;
+    get domAtom(): boolean;
+    get ignoreForCoords(): boolean;
+}

package/package.json

@@ -0,0 +1,113 @@
+{
+  "name": "@handlewithcare/react-prosemirror",
+  "version": "2.0.0",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./src": "./src/index.ts"
+  },
+  "files": [
+    "README.md",
+    "LICENSE.txt",
+    "dist"
+  ],
+  "scripts": {
+    "build:cjs": "swc ./src --ignore **/__tests__/** -d ./dist/cjs/ --no-swcrc --config-file .swcrc-cjs",
+    "build:esm": "swc ./src --ignore **/__tests__/** -d ./dist/esm/",
+    "build:types": "tsc --noEmit false --emitDeclarationOnly",
+    "build": "concurrently -P 'npm:build:* {@}' --",
+    "check:format": "prettier --check .",
+    "check:lint": "eslint --cache .",
+    "check:types": "tsc",
+    "check": "concurrently -P 'npm:check:* {@}' --",
+    "clean": "rimraf \"./dist/!(cjs/package.json)\"",
+    "demo": "yarn vite",
+    "demo:build": "yarn vite build --outDir docs --base=/react-prosemirror/",
+    "dev": "yarn build -- --watch",
+    "fix:format": "prettier --write .",
+    "fix:lint": "eslint --cache --fix .",
+    "fix:toc": "markdown-toc --bullets='-' -i README.md",
+    "fix": "concurrently -P 'npm:fix:* {@}' --",
+    "prepack": "yarn build",
+    "test:wdio": "wdio run ./wdio.conf.ts",
+    "test:unit": "jest",
+    "test": "yarn test:unit && yarn test:wdio"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.6.2",
+    "@swc/cli": "^0.1.61",
+    "@swc/core": "^1.3.32",
+    "@swc/jest": "^0.2.24",
+    "@testing-library/dom": "^10.4.0",
+    "@testing-library/react": "^16.0.1",
+    "@testing-library/user-event": "^14.4.3",
+    "@types/jest": "^27.0.0",
+    "@types/react": "^18.0.0",
+    "@types/react-dom": "^18.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.51.0",
+    "@typescript-eslint/parser": "^5.51.0",
+    "@vitejs/plugin-react": "^4.3.1",
+    "@wdio/browser-runner": "^9.0.9",
+    "@wdio/cli": "^9.0.9",
+    "@wdio/dot-reporter": "^9.1.0",
+    "@wdio/mocha-framework": "^9.0.8",
+    "@wdio/spec-reporter": "^9.1.0",
+    "@wdio/types": "^9.0.8",
+    "@yarnpkg/sdks": "^3.0.0-rc.38",
+    "concurrently": "^7.6.0",
+    "eslint": "^8.33.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-import-resolver-typescript": "^3.5.3",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-react": "^7.32.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "expect": "^29.7.0",
+    "husky": "^8.0.3",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "lint-staged": "^13.1.0",
+    "markdown-toc": "^1.2.0",
+    "prettier": "^2.8.3",
+    "prosemirror-commands": "^1.5.0",
+    "prosemirror-gapcursor": "^1.3.2",
+    "prosemirror-inputrules": "^1.4.0",
+    "prosemirror-keymap": "^1.2.1",
+    "prosemirror-model": "^1.22.3",
+    "prosemirror-schema-list": "^1.2.2",
+    "prosemirror-state": "^1.4.3",
+    "prosemirror-tables": "^1.3.7",
+    "prosemirror-test-builder": "^1.1.1",
+    "prosemirror-transform": "^1.8.0",
+    "prosemirror-view": "^1.34.2",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "rimraf": "^3.0.2",
+    "tsx": "^4.19.1",
+    "typescript": "^4.9.5",
+    "vite": "^5.4.5",
+    "webdriverio": "^9.0.9"
+  },
+  "peerDependencies": {
+    "prosemirror-model": "^1.0.0",
+    "prosemirror-state": "^1.0.0",
+    "prosemirror-view": "1.34.2",
+    "react": "17 - 19",
+    "react-dom": "17 - 19"
+  },
+  "packageManager": "yarn@4.5.3",
+  "engines": {
+    "node": ">=16.9"
+  },
+  "dependencies": {
+    "classnames": "^2.3.2"
+  }
+}