@contentful/field-editor-rich-text 3.4.1 → 3.4.3

package/dist/helpers/editor.d.ts

@@ -1,11 +1,11 @@
 import { Link } from '@contentful/field-editor-reference/dist/types';
 import { BLOCKS, INLINES } from '@contentful/rich-text-types';
 import { EditorNodesOptions, ToggleNodeTypeOptions, Node, Path } from '../internal/types';
-import { CustomElement, PlateEditor } from '../internal/types';
+import { Element, PlateEditor } from '../internal/types';
 export declare const LINK_TYPES: INLINES[];
 export declare function isBlockSelected(editor: PlateEditor, type: string): boolean;
 export declare function isRootLevel(path: Path): boolean;
-declare type NodeEntry = [CustomElement, Path];
+declare type NodeEntry = [Element, Path];
 declare type NodeType = BLOCKS | INLINES;
 export declare function getNodeEntryFromSelection(editor: PlateEditor, nodeTypeOrTypes: NodeType | NodeType[], path?: Path): NodeEntry | [];
 export declare function isNodeTypeSelected(editor: PlateEditor | null, nodeType: BLOCKS | INLINES): boolean;
@@ -14,7 +14,7 @@ export declare function moveToTheNextChar(editor: PlateEditor): void;
 export declare function insertEmptyParagraph(editor: PlateEditor, options?: any): void;
 export declare function getElementFromCurrentSelection(editor: PlateEditor): (import("@udecode/plate-core").ENode<import("@udecode/plate-core").Value> | import("slate").Path)[];
 export declare function isList(editor?: PlateEditor): boolean;
-export declare function getTableSize(table: CustomElement): Record<'numRows' | 'numColumns', number> | null;
+export declare function getTableSize(table: Element): Record<'numRows' | 'numColumns', number> | null;
 interface InsertLinkOptions {
     text: string;
     type: INLINES.HYPERLINK | INLINES.ENTRY_HYPERLINK | INLINES.ASSET_HYPERLINK;
@@ -32,7 +32,7 @@ export declare const isAtEndOfTextSelection: (editor: PlateEditor) => boolean;
  * This traversal strategy is unfortunately necessary because Slate doesn't
  * expose something like Node.next(editor).
  */
-export declare function getNextNode(editor: PlateEditor): CustomElement | null;
+export declare function getNextNode(editor: PlateEditor): Element | null;
 export declare const INLINE_TYPES: string[];
 export declare const isInlineOrText: (node: Node) => boolean;
 export declare const focus: (editor: PlateEditor) => void;

package/dist/helpers/sanitizeIncomingSlateDoc.d.ts

@@ -1,6 +1,6 @@
-import { TextOrCustomElement } from '../internal/types';
+import { Node } from '../internal/types';
 /**
  * Ensures all nodes have a child leaf text element. This should be handled by
  * Slate but its behavior has proven to be buggy and unpredictable.
  */
-export declare function sanitizeIncomingSlateDoc(nodes?: TextOrCustomElement[]): TextOrCustomElement[];
+export declare function sanitizeIncomingSlateDoc(nodes?: Node[]): Node[];

package/dist/internal/hooks.d.ts

@@ -1 +1,4 @@
+import * as p from '@udecode/plate-core';
 export declare const useReadOnly: () => boolean;
+export declare const usePlateEditorRef: <V extends p.Value = p.Value, E extends p.PlateEditor<V> = p.PlateEditor<V>>(id?: string | undefined) => E | null;
+export declare const usePlateEditorState: <V extends p.Value = p.Value, E extends p.PlateEditor<V> = p.PlateEditor<V>>(id?: string | undefined) => E | null;

package/dist/internal/misc.d.ts

@@ -3,7 +3,9 @@ import * as p from '@udecode/plate-core';
 import { StoreApiGet } from '@udecode/zustood';
 import * as s from 'slate';
 import type { Value, PlateEditor, PlatePlugin } from './types';
-export declare type CreatePlateEditorOptions = p.CreatePlateEditorOptions<Value, PlateEditor>;
+export declare type CreatePlateEditorOptions = Omit<p.CreatePlateEditorOptions<Value, PlateEditor>, 'plugins'> & {
+    plugins?: PlatePlugin[];
+};
 export declare const createPlateEditor: (options?: CreatePlateEditorOptions) => PlateEditor & Omit<s.BaseEditor, "children" | "operations" | "marks" | "isInline" | "isVoid" | "normalizeNode" | "apply" | "getFragment" | "insertFragment" | "insertNode"> & {
     children: Value;
     operations: p.TOperation<p.TDescendant>[];

package/dist/internal/types/editor.d.ts

@@ -27,25 +27,6 @@ export declare type ReactEditor = p.TReactEditor<Value>;
 export interface PlateEditor extends p.PlateEditor<Value> {
     tracking: TrackingPluginActions;
 }
-export declare type CustomText = {
-    text: string;
-    [MARKS.BOLD]?: boolean;
-    [MARKS.CODE]?: boolean;
-    [MARKS.ITALIC]?: boolean;
-    [MARKS.UNDERLINE]?: boolean;
-    [MARKS.SUPERSCRIPT]?: boolean;
-    [MARKS.SUBSCRIPT]?: boolean;
-};
-export declare type TextOrCustomElement = CustomElement | CustomText;
-export declare type CustomElement<T = unknown> = {
-    type: string;
-    children: TextOrCustomElement[];
-    data: T;
-    isVoid?: boolean;
-};
-export declare type CustomRenderElementProps<T = any, O = any> = Omit<RenderElementProps, 'element'> & {
-    element: CustomElement<T>;
-} & O;
 export declare type Node = p.ElementOf<PlateEditor> | p.TextOf<PlateEditor>;
 export declare type Path = p.TPath;
 export declare type NodeEntry<T extends Node = Node> = p.TNodeEntry<T>;

package/dist/plugins/EmbeddedEntityBlock/LinkedEntityBlock.d.ts

@@ -1,13 +1,18 @@
-import { CustomRenderElementProps } from '../../internal/types';
-declare type LinkedEntityBlockProps = CustomRenderElementProps<{
-    target: {
-        sys: {
-            id: string;
-            linkType: 'Entry' | 'Asset';
-            type: 'Link';
+import { Element, RenderElementProps } from '../../internal/types';
+declare type LinkedEntityBlockProps = {
+    element: Element & {
+        data: {
+            target: {
+                sys: {
+                    id: string;
+                    linkType: 'Entry' | 'Asset';
+                    type: 'Link';
+                };
+            };
         };
     };
-}> & {
+    attributes: Pick<RenderElementProps, 'attributes'>;
+    children: Pick<RenderElementProps, 'children'>;
     onEntityFetchComplete: VoidFunction;
 };
 export declare function LinkedEntityBlock(props: LinkedEntityBlockProps): JSX.Element;

package/dist/plugins/Hyperlink/components/EntityHyperlink.d.ts

@@ -1,9 +1,20 @@
 import { Link } from '@contentful/app-sdk';
-import { CustomRenderElementProps } from '../../../internal/types';
-declare type HyperlinkElementProps = CustomRenderElementProps<{
-    uri?: string;
-    target?: Link;
-    onEntityFetchComplete?: VoidFunction;
-}>;
+import { Element, RenderElementProps } from '../../../internal/types';
+export declare type HyperlinkElementProps = {
+    element: Element & {
+        data: {
+            target: {
+                sys: {
+                    id: string;
+                    linkType: 'Entry' | 'Asset';
+                    type: 'Link';
+                };
+            };
+        };
+    };
+    target: Link;
+    attributes: Pick<RenderElementProps, 'attributes'>;
+    children: Pick<RenderElementProps, 'children'>;
+    onEntityFetchComplete: VoidFunction;
+};
 export declare function EntityHyperlink(props: HyperlinkElementProps): JSX.Element | null;
-export {};

package/dist/plugins/Hyperlink/components/UrlHyperlink.d.ts

@@ -1,9 +1,21 @@
 import { Link } from '@contentful/app-sdk';
-import { CustomRenderElementProps } from '../../../internal/types';
-declare type HyperlinkElementProps = CustomRenderElementProps<{
-    uri?: string;
+import { Element, RenderElementProps } from '../../../internal/types';
+declare type HyperlinkElementProps = {
+    element: Element & {
+        data: {
+            uri?: string;
+            target: {
+                sys: {
+                    id: string;
+                    linkType: 'Entry' | 'Asset';
+                    type: 'Link';
+                };
+            };
+        };
+    };
     target?: Link;
     onEntityFetchComplete?: VoidFunction;
-}>;
+    children: Pick<RenderElementProps, 'children'>;
+};
 export declare function UrlHyperlink(props: HyperlinkElementProps): JSX.Element;
 export {};

package/dist/plugins/List/transforms/moveListItems.d.ts

@@ -1,6 +1,6 @@
-import { Span, Location, PlateEditor } from '../../../internal/types';
+import { EditorNodesOptions, PlateEditor } from '../../../internal/types';
 export declare type MoveListItemsOptions = {
     increase?: boolean;
-    at?: Location | Span | undefined;
+    at?: EditorNodesOptions['at'];
 };
 export declare const moveListItems: (editor: PlateEditor, { increase, at }?: MoveListItemsOptions) => void;

package/dist/plugins/links-tracking.d.ts

@@ -1,6 +1,3 @@
 import React, { ComponentProps } from 'react';
-declare type WithEntityFetchProps = {
-    onEntityFetchComplete: VoidFunction;
-} & JSX.IntrinsicAttributes;
-export declare function withLinkTracking(Component: React.ComponentType<WithEntityFetchProps>): (props: ComponentProps<typeof Component>) => JSX.Element;
-export {};
+import { HyperlinkElementProps } from './Hyperlink/components/EntityHyperlink';
+export declare function withLinkTracking(Component: React.ComponentType<HyperlinkElementProps>): (props: ComponentProps<typeof Component>) => JSX.Element;

package/dist/prepareDocument.d.ts

@@ -15,5 +15,5 @@ export declare const setEditorContent: (editor: PlateEditor, nodes?: Node[] | un
  * Converts a Contentful rich text document to the corresponding slate editor
  * value
  */
-export declare const documentToEditorValue: (doc?: Document | undefined) => import("./internal").TextOrCustomElement[];
+export declare const documentToEditorValue: (doc?: Document | undefined) => Node[];
 export declare const normalizeEditorValue: (value: Value, options?: Omit<CreatePlateEditorOptions, "id" | "editor"> | undefined) => Value;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/field-editor-rich-text",
-  "version": "3.4.1",
+  "version": "3.4.3",
   "source": "./src/index.tsx",
   "main": "./dist/index.js",
   "module": "dist/field-editor-rich-text.esm.js",
@@ -30,7 +30,7 @@
     "@contentful/f36-icons": "^4.1.1",
     "@contentful/f36-tokens": "^4.0.0",
     "@contentful/f36-utils": "^4.19.0",
-    "@contentful/field-editor-reference": "^5.8.1",
+    "@contentful/field-editor-reference": "^5.8.2",
     "@contentful/field-editor-shared": "^1.1.4",
     "@contentful/rich-text-plain-text-renderer": "^15.12.1",
     "@contentful/rich-text-types": "15.14.1",
@@ -74,5 +74,5 @@
     "@udecode/plate-test-utils": "^3.2.0",
     "react": ">=16.14.0"
   },
-  "gitHead": "5ae95e56c59e3cab8f3a1436827764aa17b20588"
+  "gitHead": "0295a2cc6c8b8cc60aea370ad9afb7b6142e9471"
 }