@remirror/react-ssr - npm Package Compare versions

Comparing version 0.0.0-pr2166.1 to 0.0.0-pr2166.2

dist/_tsup-dts-rollup.d.ts

@@ -0,1 +1,188 @@
+import { AnyExtension } from '@remirror/core';
+import { DirectEditorProps } from '@remirror/pm/view';
+import { DOMOutputSpec } from '@remirror/core';
+import { EditorState } from '@remirror/core';
+import type { EditorStateProps } from '@remirror/core';
+import { EditorView } from '@remirror/pm/view';
+import { Fragment } from '@remirror/core';
+import { Mark } from '@remirror/core';
+import { MarkExtensionSpec } from '@remirror/core';
+import { NodeExtensionSpec } from '@remirror/core';
+import { ProsemirrorNode } from '@remirror/core';
+import { ReactNode } from 'react';
+import { RemirrorManager } from '@remirror/core';
+import { Shape } from '@remirror/core';
+import { Transaction } from '@remirror/core';
+
+/**
+ * Creates a new editor view
+ *
+ * @param place
+ * @param props
+ */
+declare function createEditorView(place: Node | ((p: HTMLElement) => void) | null, props: DirectEditorProps): EditorView;
+export { createEditorView }
+export { createEditorView as createEditorView_alias_1 }
+
+/**
+ * A mock editor view used only when prosemirror is running on the server
+ */
+declare class EditorViewSSR {
+    state: EditorState;
+    dom: Element;
+    dragging: null;
+    root: Document | DocumentFragment;
+    constructor(_place: Node | ((p: Node) => void) | {
+        mount: Node;
+    } | undefined, props: DirectEditorProps);
+    update(_props: DirectEditorProps): void;
+    setProps(_props: DirectEditorProps): void;
+    updateState(_state: EditorState): void;
+    someProps(_propName: string, f?: (prop: any) => any): any;
+    hasFocus(): boolean;
+    focus(): void;
+    posAtCoords(_coords: {
+        left: number;
+        top: number;
+    }): {
+        pos: number;
+        inside: number;
+    } | null | undefined;
+    coordsAtPos(_pos: number): {
+        left: number;
+        right: number;
+        top: number;
+        bottom: number;
+    };
+    domAtPos(_pos: number): {
+        node: Node;
+        offset: number;
+    };
+    nodeDOM(_pos: number): Node | null | undefined;
+    posAtDOM(_node: Node, _offset: number, _bias?: number | null): number;
+    endOfTextblock(_dir: 'up' | 'down' | 'left' | 'right' | 'forward' | 'backward', _state?: EditorState): boolean;
+    /**
+     * Removes the editor from the DOM and destroys all [node
+     * views](#view.NodeView).
+     */
+    destroy(): void;
+    dispatch(_tr: Transaction): void;
+}
+export { EditorViewSSR }
+export { EditorViewSSR as EditorViewSSR_alias_1 }
+
+/**
+ * Gather up all the toDOM methods from the provided spec object
+ *
+ * @param specs - the prosemirror schema specs for each node / mark
+ */
+export declare function gatherDomMethods<Spec extends SharedSpec>(specs: Record<string, Spec>): GatheredDomMethods<Spec>;
+
+declare type GatheredDomMethods<Spec extends SharedSpec> = Record<string, Spec['toDOM']>;
+
+/**
+ * Map standard html attribute names to their react equivalents.
+ *
+ * TODO is there a better way of doing this.
+ */
+export declare function mapProps(props: Shape): Shape;
+
+declare type MarkToDOM = MarkExtensionSpec['toDOM'];
+
+declare type NodeToDOM = NodeExtensionSpec['toDOM'];
+
+/**
+ * Used to map html attributes to their supported react names
+ * Taken from https://github.com/facebook/react/blob/b87aabdfe1b7461e7331abb3601d9e6bb27544bc/packages/react-dom/src/shared/possibleStandardNames.js#L42
+ */
+export declare const possibleStandardNames: Record<string, string>;
+
+/**
+ * Serialize the extension provided schema into a JSX element that can be displayed node and non-dom environments.
+ */
+declare class ReactSerializer<Extension extends AnyExtension> {
+    #private;
+    /**
+     * Receives the return value from toDOM defined in the node schema and transforms it
+     * into JSX
+     *
+     * @param structure - The DOMOutput spec for the current node
+     * @param wraps - passed through any elements that this component should be parent of
+     */
+    static renderSpec(structure: DOMOutputSpec, wraps?: ReactNode): ReactNode;
+    /**
+     * Create a serializer from the extension manager
+     *
+     * @param manager
+     */
+    static fromManager<Extension extends AnyExtension>(manager: RemirrorManager<Extension>): ReactSerializer<Extension>;
+    /**
+     * Pluck nodes from the extension manager
+     *
+     * @param manager
+     */
+    private static nodesFromManager;
+    /**
+     * Pluck marks from the extension manager
+     *
+     * @param manager
+     */
+    private static marksFromManager;
+    nodes: Record<string, NodeToDOM>;
+    marks: Record<string, MarkToDOM>;
+    constructor(nodes: Record<string, NodeToDOM>, marks: Record<string, MarkToDOM>, manager: RemirrorManager<Extension>);
+    /**
+     * The main entry method on this class for traversing through a schema tree and creating JSx.
+     *
+     * ```ts
+     * reactSerializer.serializeFragment(fragment)
+     * ```
+     *
+     * @param fragment
+     */
+    serializeFragment(fragment: Fragment): JSX.Element;
+    /**
+     * Transform the passed in node into a JSX Element
+     *
+     * @param node
+     */
+    serializeNode(node: ProsemirrorNode): ReactNode;
+    /**
+     * Transform the provided mark into a JSX Element that wraps the current node
+     *
+     * @param mark
+     * @param inline
+     * @param wrappedElement
+     */
+    serializeMark(mark: Mark, inline: boolean, wrappedElement: ReactNode): ReactNode;
+}
+export { ReactSerializer }
+export { ReactSerializer as ReactSerializer_alias_1 }
+
+/**
+ * Remirror SSR component used for rendering in non dom environments.
+ */
+declare const RemirrorSSR: <Extension extends AnyExtension>(props: RemirrorSSRProps<Extension>) => JSX.Element;
+export { RemirrorSSR }
+export { RemirrorSSR as RemirrorSSR_alias_1 }
+
+declare interface RemirrorSSRProps<Extension extends AnyExtension> extends EditorStateProps {
+    /**
+     * The attributes to pass into the root div element.
+     */
+    attributes: Shape;
+    /**
+     * Whether or not the editor is in an editable state
+     */
+    editable: boolean;
+    /**
+     * The manager.
+     */
+    manager: RemirrorManager<Extension>;
+}
+export { RemirrorSSRProps }
+export { RemirrorSSRProps as RemirrorSSRProps_alias_1 }
+
+declare type SharedSpec = MarkExtensionSpec | NodeExtensionSpec;
+
 export { }

dist/remirror-react-ssr.d.ts

@@ -1,1 +0,8 @@
-export {};
+export { ReactSerializer } from './_tsup-dts-rollup';
+export { RemirrorSSRProps } from './_tsup-dts-rollup';
+export { RemirrorSSR } from './_tsup-dts-rollup';
+export { createEditorView } from './_tsup-dts-rollup';
+export { EditorViewSSR } from './_tsup-dts-rollup';
+export { possibleStandardNames } from './_tsup-dts-rollup';
+export { mapProps } from './_tsup-dts-rollup';
+export { gatherDomMethods } from './_tsup-dts-rollup';

dist/remirror-react-ssr.js

@@ -1,9 +0,9 @@
-// packages/remirror__react-ssr/src/react-serializer.tsx
+// src/react-serializer.tsx
 import React, { createElement, Fragment } from "react";
 import { ErrorConstant, invariant, isArray, isPlainObject, isString, object as object2 } from "@remirror/core";
 
-// packages/remirror__react-ssr/src/ssr-utils.ts
+// src/ssr-utils.ts
 import { hasOwnProperty, keys, object } from "@remirror/core";
 
-// packages/remirror__react-ssr/src/ssr-constants.ts
+// src/ssr-constants.ts
 var possibleStandardNames = {
@@ -494,3 +494,3 @@ // HTML
 
-// packages/remirror__react-ssr/src/ssr-utils.ts
+// src/ssr-utils.ts
 function getPossibleStandardName(key) {
@@ -527,3 +527,3 @@ if (!hasOwnProperty(possibleStandardNames, key)) {
 
-// packages/remirror__react-ssr/src/react-serializer.tsx
+// src/react-serializer.tsx
 var ReactSerializer = class _ReactSerializer {
@@ -664,3 +664,3 @@ /**
 
-// packages/remirror__react-ssr/src/ssr-component.tsx
+// src/ssr-component.tsx
 import React2 from "react";
@@ -684,3 +684,3 @@ var RemirrorSSR = props => {
 
-// packages/remirror__react-ssr/src/ssr-prosemirror-view.ts
+// src/ssr-prosemirror-view.ts
 import { Cast, getDocument, shouldUseDomEnvironment } from "@remirror/core";
@@ -687,0 +687,0 @@ import { EditorView as EditorView2 } from "@remirror/pm/view";

package.json

 {
   "name": "@remirror/react-ssr",
-  "version": "0.0.0-pr2166.1",
+  "version": "0.0.0-pr2166.2",
   "description": "Render the editor in an SSR environment",
@@ -37,8 +37,9 @@ "keywords": [
     "@babel/runtime": "^7.22.3",
-    "@remirror/core": "0.0.0-pr2166.1",
-    "@remirror/extension-react-ssr": "0.0.0-pr2166.1"
+    "@remirror/core": "0.0.0-pr2166.2",
+    "@remirror/extension-react-ssr": "0.0.0-pr2166.2"
   },
   "devDependencies": {
-    "@remirror/pm": "0.0.0-pr2166.1",
-    "@remirror/react": "0.0.0-pr2166.1",
+    "@remirror/cli": "0.0.0-pr2166.2",
+    "@remirror/pm": "0.0.0-pr2166.2",
+    "@remirror/react": "0.0.0-pr2166.2",
     "@types/react": "^18.2.0",
@@ -50,3 +51,3 @@ "@types/react-dom": "^18.2.0",
   "peerDependencies": {
-    "@remirror/pm": "0.0.0-pr2166.1",
+    "@remirror/pm": "0.0.0-pr2166.2",
     "@types/react": "^16.14.0 || ^17 || ^18",
@@ -67,3 +68,6 @@ "@types/react-dom": "^16.9.0 || ^17 || ^18",
     "sizeLimit": "10 KB"
+  },
+  "scripts": {
+    "build": "remirror-cli build"
   }
 }

No alert changes

Improved metrics

Total package byte prevSize

139559

increased by10.23%

Lines of code

2646

increased by7.43%

Worsened metrics

Dev dependency count

7

increased by16.67%

Dependency changes

• + Added@remirror/core@0.0.0-pr2166.2(transitive)

• + Added@remirror/core-constants@0.0.0-pr2166.2(transitive)

• + Added@remirror/core-helpers@0.0.0-pr2166.2(transitive)

• + Added@remirror/core-types@0.0.0-pr2166.2(transitive)

• + Added@remirror/core-utils@0.0.0-pr2166.2(transitive)

• + Added@remirror/extension-react-component@0.0.0-pr2166.2(transitive)

• + Added@remirror/extension-react-ssr@0.0.0-pr2166.2(transitive)

• + Added@remirror/icons@0.0.0-pr2166.2(transitive)

• + Added@remirror/messages@0.0.0-pr2166.2(transitive)

• + Added@remirror/pm@0.0.0-pr2166.2(transitive)

• + Added@remirror/react-utils@0.0.0-pr2166.2(transitive)

• + Added@remirror/types@0.0.0-pr2166.2(transitive)

• + Addedprosemirror-paste-rules@0.0.0-pr2166.2(transitive)

• + Addedprosemirror-suggest@0.0.0-pr2166.2(transitive)

• + Addedprosemirror-trailing-node@0.0.0-pr2166.2(transitive)

• - Removed@remirror/core@0.0.0-pr2166.1(transitive)

• - Removed@remirror/core-constants@0.0.0-pr2166.1(transitive)

• - Removed@remirror/core-helpers@0.0.0-pr2166.1(transitive)

• - Removed@remirror/core-types@0.0.0-pr2166.1(transitive)

• - Removed@remirror/core-utils@0.0.0-pr2166.1(transitive)

• - Removed@remirror/extension-react-component@0.0.0-pr2166.1(transitive)

• - Removed@remirror/extension-react-ssr@0.0.0-pr2166.1(transitive)

• - Removed@remirror/icons@0.0.0-pr2166.1(transitive)

• - Removed@remirror/messages@0.0.0-pr2166.1(transitive)

• - Removed@remirror/pm@0.0.0-pr2166.1(transitive)

• - Removed@remirror/react-utils@0.0.0-pr2166.1(transitive)

• - Removed@remirror/types@0.0.0-pr2166.1(transitive)

• - Removedprosemirror-paste-rules@0.0.0-pr2166.1(transitive)

• - Removedprosemirror-suggest@0.0.0-pr2166.1(transitive)

• - Removedprosemirror-trailing-node@0.0.0-pr2166.1(transitive)

• Updated@remirror/core@0.0.0-pr2166.2

• Updated@remirror/extension-react-ssr@0.0.0-pr2166.2