@contentful/field-editor-rich-text 1.1.0 → 2.0.0-next.10

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

@@ -0,0 +1,5 @@
+import { PlateEditor } from '@udecode/plate-core';
+/**
+ * Insert list item if selection is in li>p.
+ */
+export declare const insertListItem: (editor: PlateEditor) => boolean;

package/dist/plugins/List/utils.d.ts

@@ -0,0 +1,14 @@
+import { PlateEditor } from '@udecode/plate-core';
+import { NodeEntry, Node } from 'slate';
+import { CustomElement } from '../../types';
+export declare const hasListAsDirectParent: (editor: PlateEditor, [, path]: NodeEntry<Node>) => boolean;
+/**
+ * Places orphaned list items in a list. If there's a list somewhere
+ * in the node's ancestors, defaults to that list type, else places
+ * the list item in an unordered list.
+ */
+export declare const normalizeOrphanedListItem: (editor: PlateEditor, [, path]: NodeEntry<Node>) => void;
+export declare const isNonEmptyListItem: (editor: PlateEditor, [, path]: NodeEntry<Node>) => boolean;
+export declare const firstNodeIsNotList: (_editor: PlateEditor, [node]: NodeEntry<CustomElement<unknown>>) => boolean;
+export declare const insertParagraphAsChild: (editor: PlateEditor, [, path]: NodeEntry<Node>) => void;
+export declare const replaceNodeWithListItems: (editor: any, entry: any) => void;

package/dist/plugins/List/withList.d.ts

@@ -0,0 +1,3 @@
+import { WithOverride } from '@udecode/plate-core';
+import { ListPlugin } from '@udecode/plate-list';
+export declare const withList: WithOverride<{}, ListPlugin>;

package/dist/plugins/Marks/Bold.d.ts

@@ -0,0 +1,9 @@
+import * as Slate from 'slate-react';
+import { RichTextPlugin } from '../../types';
+interface ToolbarBoldButtonProps {
+    isDisabled?: boolean;
+}
+export declare function ToolbarBoldButton(props: ToolbarBoldButtonProps): JSX.Element | null;
+export declare function Bold(props: Slate.RenderLeafProps): JSX.Element;
+export declare const createBoldPlugin: () => RichTextPlugin;
+export {};

package/dist/plugins/Marks/Code.d.ts

@@ -0,0 +1,9 @@
+import * as Slate from 'slate-react';
+import { RichTextPlugin } from '../../types';
+interface ToolbarCodeButtonProps {
+    isDisabled?: boolean;
+}
+export declare function ToolbarCodeButton(props: ToolbarCodeButtonProps): JSX.Element | null;
+export declare function Code(props: Slate.RenderLeafProps): JSX.Element;
+export declare const createCodePlugin: () => RichTextPlugin;
+export {};

package/dist/plugins/Marks/Italic.d.ts

@@ -0,0 +1,9 @@
+import * as Slate from 'slate-react';
+import { RichTextPlugin } from '../../types';
+interface ToolbarItalicButtonProps {
+    isDisabled?: boolean;
+}
+export declare function ToolbarItalicButton(props: ToolbarItalicButtonProps): JSX.Element | null;
+export declare function Italic(props: Slate.RenderLeafProps): JSX.Element;
+export declare const createItalicPlugin: () => RichTextPlugin;
+export {};

package/dist/plugins/Marks/Underline.d.ts

@@ -0,0 +1,9 @@
+import * as Slate from 'slate-react';
+import { RichTextPlugin } from '../../types';
+interface ToolbarUnderlineButtonProps {
+    isDisabled?: boolean;
+}
+export declare function ToolbarUnderlineButton(props: ToolbarUnderlineButtonProps): JSX.Element | null;
+export declare function Underline(props: Slate.RenderLeafProps): JSX.Element;
+export declare const createUnderlinePlugin: () => RichTextPlugin;
+export {};

package/dist/plugins/Marks/index.d.ts

@@ -0,0 +1,2 @@
+import { RichTextPlugin } from '../../types';
+export declare const createMarksPlugin: () => RichTextPlugin;

package/dist/plugins/Normalizer/baseRules.d.ts

@@ -0,0 +1,2 @@
+import { NormalizerRule } from './types';
+export declare const baseRules: Required<NormalizerRule>[];

package/dist/plugins/Normalizer/createNormalizerPlugin.d.ts

@@ -0,0 +1,2 @@
+import { RichTextPlugin } from '../../types';
+export declare const createNormalizerPlugin: () => RichTextPlugin;

package/dist/plugins/Normalizer/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export * from './createNormalizerPlugin';

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

@@ -0,0 +1,39 @@
+import { PlateEditor, NodeMatch } from '@udecode/plate-core';
+import { NodeEntry } from 'slate';
+export declare type NodeTransformer = (editor: PlateEditor, entry: NodeEntry) => void;
+export declare type NodeValidator = (editor: PlateEditor, entry: NodeEntry) => boolean;
+declare type BaseRule = {
+    /**
+     * A helper to return a Node to which valid* rules are applied
+     * against.
+     *
+     * By default it returns only Elements of type `plugin.type`.
+     */
+    match?: NodeMatch;
+    /**
+     * A helper to normalize invalid Node(s). By default it removes
+     * invalid nodes.
+     *
+     * Transformations are automatically wrapped in a
+     * `Editor.withoutNormalization()` call to avoid unnecessary
+     * normalization cycles.
+     */
+    transform?: NodeTransformer | Record<string | 'default', NodeTransformer>;
+};
+export declare type ValidNodeRule = BaseRule & {
+    /**
+     * Checks if matching Node(s) are valid.
+     */
+    validNode: NodeValidator;
+};
+export declare type ValidChildrenRule = BaseRule & {
+    /**
+     * Checks if matching Node's children are valid.
+     *
+     * The value can be an array of strings as a shorthand to indicate
+     * valid children types.
+     */
+    validChildren: NodeValidator | string[];
+};
+export declare type NormalizerRule = ValidNodeRule | ValidChildrenRule;
+export {};

package/dist/plugins/Normalizer/utils.d.ts

@@ -0,0 +1,8 @@
+import { PlateEditor } from '@udecode/plate-core';
+import { NodeEntry, Node } from 'slate';
+import { NodeValidator, NodeTransformer } from './types';
+export declare class NormalizerError extends Error {
+}
+export declare const createValidatorFromTypes: (types: string[]) => NodeValidator;
+export declare const getChildren: (editor: PlateEditor, [node, path]: NodeEntry<Node>) => NodeEntry[];
+export declare const createTransformerFromObject: (transforms: Record<string, NodeTransformer>) => NodeTransformer;

package/dist/plugins/Normalizer/withNormalizer.d.ts

@@ -0,0 +1,2 @@
+import { WithOverride } from '@udecode/plate-core';
+export declare const withNormalizer: WithOverride;

package/dist/plugins/Paragraph/Paragraph.d.ts

@@ -0,0 +1,2 @@
+import { RenderElementProps } from 'slate-react';
+export declare function Paragraph(props: RenderElementProps): JSX.Element;

package/dist/plugins/Paragraph/createParagraphPlugin.d.ts

@@ -0,0 +1,2 @@
+import { RichTextPlugin } from '../../types';
+export declare const createParagraphPlugin: () => RichTextPlugin;

package/dist/plugins/Paragraph/index.d.ts

@@ -1,5 +1 @@
-export function ParagraphPlugin(type?: BLOCKS): {
-    renderNode: (props: any, _editor: any, next: any) => any;
-    onKeyDown: (e: any, editor: any, next: any) => any;
-};
-import { BLOCKS } from "@contentful/rich-text-types";
+export * from './createParagraphPlugin';

package/dist/plugins/Paragraph/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function isEmbedElement(element: HTMLElement): boolean;
+export declare function isEmptyElement(element: HTMLElement): boolean;

package/dist/plugins/PasteHTML/createPasteHTMLPlugin.d.ts

@@ -0,0 +1,2 @@
+import { RichTextPlugin } from '../../types';
+export declare const createPasteHTMLPlugin: () => RichTextPlugin;

package/dist/plugins/PasteHTML/index.d.ts

@@ -0,0 +1 @@
+export * from './createPasteHTMLPlugin';

package/dist/plugins/PasteHTML/utils/sanitizeHTML.d.ts

@@ -0,0 +1 @@
+export declare const sanitizeHTML: (html: string) => string;

package/dist/plugins/PasteHTML/utils/sanitizeSheets.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Remove empty spreadsheets columns/rows for performance reasons.
+ */
+export declare const sanitizeSheets: (doc: Document) => Document;

package/dist/plugins/Quote/components/Quote.d.ts

@@ -0,0 +1,2 @@
+import { RenderElementProps } from 'slate-react';
+export declare function Quote(props: RenderElementProps): JSX.Element;

package/dist/plugins/Quote/components/ToolbarQuoteButton.d.ts

@@ -0,0 +1,4 @@
+export interface ToolbarQuoteButtonProps {
+    isDisabled?: boolean;
+}
+export declare function ToolbarQuoteButton(props: ToolbarQuoteButtonProps): JSX.Element | null;

package/dist/plugins/Quote/createQuotePlugin.d.ts

@@ -0,0 +1,2 @@
+import { RichTextPlugin } from '../../types';
+export declare function createQuotePlugin(): RichTextPlugin;

package/dist/plugins/Quote/index.d.ts

@@ -1,59 +1,2 @@
-declare var _default: {
-    new (props: any): {
-        handleToggle: (event: any) => any;
-        render(): JSX.Element;
-        context: any;
-        setState<K extends string | number | symbol>(state: any, callback?: (() => void) | undefined): void;
-        forceUpdate(callback?: (() => void) | undefined): void;
-        readonly props: Readonly<any> & Readonly<{
-            children?: React.ReactNode;
-        }>;
-        state: Readonly<any>;
-        refs: {
-            [key: string]: React.ReactInstance;
-        };
-        componentDidMount?(): void;
-        shouldComponentUpdate?(nextProps: Readonly<any>, nextState: Readonly<any>, nextContext: any): boolean;
-        componentWillUnmount?(): void;
-        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
-        getSnapshotBeforeUpdate?(prevProps: Readonly<any>, prevState: Readonly<any>): any;
-        componentDidUpdate?(prevProps: Readonly<any>, prevState: Readonly<any>, snapshot?: any): void;
-        componentWillMount?(): void;
-        UNSAFE_componentWillMount?(): void;
-        componentWillReceiveProps?(nextProps: Readonly<any>, nextContext: any): void;
-        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<any>, nextContext: any): void;
-        componentWillUpdate?(nextProps: Readonly<any>, nextState: Readonly<any>, nextContext: any): void;
-        UNSAFE_componentWillUpdate?(nextProps: Readonly<any>, nextState: Readonly<any>, nextContext: any): void;
-    };
-    new (props: any, context: any): {
-        handleToggle: (event: any) => any;
-        render(): JSX.Element;
-        context: any;
-        setState<K extends string | number | symbol>(state: any, callback?: (() => void) | undefined): void;
-        forceUpdate(callback?: (() => void) | undefined): void;
-        readonly props: Readonly<any> & Readonly<{
-            children?: React.ReactNode;
-        }>;
-        state: Readonly<any>;
-        refs: {
-            [key: string]: React.ReactInstance;
-        };
-        componentDidMount?(): void;
-        shouldComponentUpdate?(nextProps: Readonly<any>, nextState: Readonly<any>, nextContext: any): boolean;
-        componentWillUnmount?(): void;
-        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
-        getSnapshotBeforeUpdate?(prevProps: Readonly<any>, prevState: Readonly<any>): any;
-        componentDidUpdate?(prevProps: Readonly<any>, prevState: Readonly<any>, snapshot?: any): void;
-        componentWillMount?(): void;
-        UNSAFE_componentWillMount?(): void;
-        componentWillReceiveProps?(nextProps: Readonly<any>, nextContext: any): void;
-        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<any>, nextContext: any): void;
-        componentWillUpdate?(nextProps: Readonly<any>, nextState: Readonly<any>, nextContext: any): void;
-        UNSAFE_componentWillUpdate?(nextProps: Readonly<any>, nextState: Readonly<any>, nextContext: any): void;
-    };
-    propTypes: any;
-    contextType?: React.Context<any> | undefined;
-};
-export default _default;
-export { default as QuotePlugin } from "./QuotePlugin";
-import React from "react";
+export * from './createQuotePlugin';
+export * from './components/ToolbarQuoteButton';

package/dist/plugins/Quote/toggleQuote.d.ts

@@ -0,0 +1,3 @@
+import { HotkeyPlugin, KeyboardHandler, PlateEditor } from '@udecode/plate-core';
+export declare function toggleQuote(editor: PlateEditor): void;
+export declare const onKeyDownToggleQuote: KeyboardHandler<{}, HotkeyPlugin>;

package/dist/plugins/SelectOnBackspace/createSelectOnBackspacePlugin.d.ts

@@ -0,0 +1,2 @@
+import { RichTextPlugin } from '../../types';
+export declare const createSelectOnBackspacePlugin: () => RichTextPlugin;

package/dist/plugins/SelectOnBackspace/index.d.ts

@@ -0,0 +1 @@
+export * from './createSelectOnBackspacePlugin';

package/dist/plugins/Table/actions/addColumn.d.ts

@@ -0,0 +1,4 @@
+import { PlateEditor } from '@udecode/plate-core';
+import { TablePluginOptions } from '@udecode/plate-table';
+export declare const addColumnRight: (editor: PlateEditor, options: TablePluginOptions) => void;
+export declare const addColumnLeft: (editor: PlateEditor, options: TablePluginOptions) => void;

package/dist/plugins/Table/actions/addRow.d.ts

@@ -0,0 +1,3 @@
+import { PlateEditor } from '@udecode/plate-core';
+export declare const addRowBelow: (editor: PlateEditor) => void;
+export declare const addRowAbove: (editor: PlateEditor) => void;

package/dist/plugins/Table/actions/index.d.ts

@@ -0,0 +1,3 @@
+export * from './addRow';
+export * from './addColumn';
+export * from './setHeader';

package/dist/plugins/Table/actions/setHeader.d.ts

@@ -0,0 +1,2 @@
+import { PlateEditor } from '@udecode/plate-core';
+export declare const setHeader: (editor: PlateEditor, enable?: boolean | undefined) => void;

package/dist/plugins/Table/addTableTrackingEvents.d.ts

@@ -0,0 +1,3 @@
+import { PlateEditor } from '@udecode/plate-core';
+import { TrackingProvider } from '../../TrackingProvider';
+export declare function addTableTrackingEvents(editor: PlateEditor, { onViewportAction }: TrackingProvider): void;

package/dist/plugins/Table/components/Cell.d.ts

@@ -0,0 +1,2 @@
+import * as Slate from 'slate-react';
+export declare const Cell: (props: Slate.RenderElementProps) => JSX.Element;

package/dist/plugins/Table/components/HeaderCell.d.ts

@@ -0,0 +1,2 @@
+import * as Slate from 'slate-react';
+export declare const HeaderCell: (props: Slate.RenderElementProps) => JSX.Element;

package/dist/plugins/Table/components/Row.d.ts

@@ -0,0 +1,2 @@
+import * as Slate from 'slate-react';
+export declare const Row: (props: Slate.RenderElementProps) => JSX.Element;

package/dist/plugins/Table/components/Table.d.ts

@@ -0,0 +1,2 @@
+import * as Slate from 'slate-react';
+export declare const Table: (props: Slate.RenderElementProps) => JSX.Element;

package/dist/plugins/Table/components/TableActions.d.ts

@@ -0,0 +1,4 @@
+export declare const styles: {
+    topRight: string;
+};
+export declare const TableActions: () => JSX.Element | null;

package/dist/plugins/Table/components/ToolbarButton.d.ts

@@ -0,0 +1,4 @@
+export interface ToolbarTableButtonProps {
+    isDisabled: boolean | undefined;
+}
+export declare function ToolbarTableButton(props: ToolbarTableButtonProps): JSX.Element | null;

package/dist/plugins/Table/createTablePlugin.d.ts

@@ -0,0 +1,3 @@
+import { TrackingProvider } from '../../TrackingProvider';
+import { RichTextPlugin } from '../../types';
+export declare const createTablePlugin: (tracking: TrackingProvider) => RichTextPlugin;

package/dist/plugins/Table/helpers.d.ts

@@ -0,0 +1,15 @@
+import { PlateEditor } from '@udecode/plate-core';
+import { Node, NodeEntry } from 'slate';
+export declare function insertTableAndFocusFirstCell(editor: PlateEditor): void;
+export declare function isTableActive(editor: PlateEditor): boolean;
+export declare function isTableHeaderEnabled(editor: PlateEditor): boolean;
+export declare function replaceEmptyParagraphWithTable(editor: PlateEditor): void;
+/**
+ * Returns the number of cells in a given row vs the table width
+ *
+ * Note: We should only get different table rows cell counts in between
+ * normalization cycles.
+ */
+export declare const getNoOfMissingTableCellsInRow: (editor: PlateEditor, [, rowPath]: NodeEntry<Node>) => number;
+export declare const createEmptyTableCells: (count: number) => Node[];
+export declare const isNotEmpty: (editor: PlateEditor, [, path]: NodeEntry<Node>) => boolean;

package/dist/plugins/Table/index.d.ts

@@ -0,0 +1,2 @@
+export * from './createTablePlugin';
+export * from './components/ToolbarButton';

package/dist/plugins/Text/createTextPlugin.d.ts

@@ -0,0 +1,2 @@
+import { RichTextPlugin } from '../../types';
+export declare function createTextPlugin(): RichTextPlugin;

package/dist/plugins/Text/index.d.ts

@@ -0,0 +1 @@
+export * from './createTextPlugin';

package/dist/plugins/TrailingParagraph/index.d.ts

@@ -0,0 +1 @@
+export declare const createTrailingParagraphPlugin: () => import("@udecode/plate-core").PlatePlugin<{}, import("@udecode/plate-trailing-block").TrailingBlockPlugin>;

package/dist/plugins/Voids/createVoidsPlugin.d.ts

@@ -0,0 +1,2 @@
+import { RichTextPlugin } from '../../types';
+export declare const createVoidsPlugin: () => RichTextPlugin;

package/dist/plugins/Voids/index.d.ts

@@ -0,0 +1 @@
+export * from './createVoidsPlugin';

package/dist/plugins/Voids/transformVoid.d.ts

@@ -0,0 +1,6 @@
+import { PlateEditor } from '@udecode/plate-core';
+import { NodeEntry } from 'slate';
+/**
+ * Re-creates a void node with valid children.
+ */
+export declare const transformVoid: (editor: PlateEditor, [node, path]: NodeEntry<import("slate").Node>) => void;

package/dist/plugins/index.d.ts

@@ -1 +1,6 @@
-export function buildPlugins(richTextAPI: any): any[];
+import { FieldExtensionSDK } from '@contentful/app-sdk';
+import { PlateProps } from '@udecode/plate-core';
+import { TrackingProvider } from '../TrackingProvider';
+import { RichTextPlugin } from '../types';
+export declare const getPlugins: (sdk: FieldExtensionSDK, tracking: TrackingProvider) => RichTextPlugin[];
+export declare const disableCorePlugins: PlateProps['disableCorePlugins'];

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

@@ -0,0 +1,7 @@
+import React, { ComponentProps } from 'react';
+import { TrackingProvider } from '../TrackingProvider';
+declare type WithEntityFetchProps = {
+    onEntityFetchComplete: VoidFunction;
+} & JSX.IntrinsicAttributes;
+export declare function withLinkTracking(tracking: TrackingProvider, Component: React.ComponentType<WithEntityFetchProps>): (props: ComponentProps<typeof Component>) => JSX.Element;
+export {};

package/dist/plugins/shared/EntityStatusIcon.d.ts

@@ -0,0 +1,7 @@
+import { Entry, Asset } from '@contentful/field-editor-shared';
+interface EntityStatusIconProps {
+    entity: Entry | Asset;
+    entityType: 'Entry' | 'Asset';
+}
+export declare function EntityStatusIcon({ entity, entityType }: EntityStatusIconProps): JSX.Element;
+export {};

package/dist/plugins/shared/FetchingWrappedAssetCard.d.ts

@@ -0,0 +1,23 @@
+import { FieldExtensionSDK } from '@contentful/app-sdk';
+import { File } from '@contentful/field-editor-shared';
+interface FetchingWrappedAssetCardProps {
+    assetId: string;
+    isDisabled: boolean;
+    isSelected: boolean;
+    locale: string;
+    onEdit?: () => void;
+    onRemove?: () => unknown;
+    sdk: FieldExtensionSDK;
+    onEntityFetchComplete?: VoidFunction;
+}
+export declare function renderAssetInfo(props: {
+    entityFile: File;
+}): ("" | JSX.Element)[];
+export declare function renderActions(props: {
+    onEdit?: () => void;
+    onRemove?: () => void;
+    isDisabled: boolean;
+    entityFile?: File;
+}): (JSX.Element | null)[];
+export declare function FetchingWrappedAssetCard(props: FetchingWrappedAssetCardProps): JSX.Element;
+export {};

package/dist/plugins/shared/FetchingWrappedEntryCard.d.ts

@@ -0,0 +1,13 @@
+import { FieldExtensionSDK } from '@contentful/app-sdk';
+interface FetchingWrappedEntryCardProps {
+    entryId: string;
+    isDisabled: boolean;
+    isSelected: boolean;
+    locale: string;
+    sdk: FieldExtensionSDK;
+    onEntityFetchComplete?: VoidFunction;
+    onEdit?: VoidFunction;
+    onRemove?: VoidFunction;
+}
+export declare function FetchingWrappedEntryCard(props: FetchingWrappedEntryCardProps): JSX.Element;
+export {};

package/dist/plugins/shared/ToolbarButton.d.ts

@@ -0,0 +1,11 @@
+interface ToolbarButtonProps {
+    onClick: () => void;
+    isActive?: boolean;
+    isDisabled?: boolean;
+    children: any;
+    title: string;
+    className?: string;
+    testId?: string;
+}
+export declare function ToolbarButton(props: ToolbarButtonProps): JSX.Element;
+export {};

package/dist/test-utils/assertOutput.d.ts

@@ -0,0 +1,8 @@
+import { PlateEditor } from '@udecode/plate-core';
+export declare const assertOutput: (options: {
+    input?: any;
+    expected: any;
+    editor?: PlateEditor;
+    log?: boolean;
+    skipCursor?: boolean;
+}) => void;

package/dist/test-utils/createEditor.d.ts

@@ -0,0 +1,14 @@
+import { FieldExtensionSDK } from '@contentful/app-sdk';
+import { PlateEditor } from '@udecode/plate-core';
+import { TrackingProvider } from '../TrackingProvider';
+import { RichTextPlugin } from '../types';
+export declare const normalize: (editor: PlateEditor) => void;
+export declare const createTestEditor: (options: {
+    input?: any;
+    sdk?: FieldExtensionSDK;
+    tracking?: TrackingProvider;
+    plugins?: RichTextPlugin[];
+}) => {
+    editor: PlateEditor<{}>;
+    normalize: () => void;
+};

package/dist/test-utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from './jsx';
+export * from './createEditor';
+export * from './mockPlugin';
+export * from './assertOutput';

package/dist/test-utils/jsx.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Mapping for JSX => Slate Node types
+ *
+ * Add items as needed. Don't forget to adjust hyperscript.d.ts
+ */
+export declare const jsx: <S extends "selection" | "text" | "element" | "editor" | "focus" | "anchor" | "cursor" | "fragment">(tagName: S, attributes?: Object | undefined, ...children: any[]) => ReturnType<({
+    anchor: typeof import("slate-hyperscript/dist/creators").createAnchor;
+    cursor: typeof import("slate-hyperscript/dist/creators").createCursor;
+    editor: (tagName: string, attributes: {
+        [key: string]: any;
+    }, children: any[]) => import("slate").BaseEditor;
+    element: typeof import("slate-hyperscript/dist/creators").createElement;
+    focus: typeof import("slate-hyperscript/dist/creators").createFocus;
+    fragment: typeof import("slate-hyperscript/dist/creators").createFragment;
+    selection: typeof import("slate-hyperscript/dist/creators").createSelection;
+    text: typeof import("slate-hyperscript/dist/creators").createText;
+} | {
+    anchor: typeof import("slate-hyperscript/dist/creators").createAnchor;
+    cursor: typeof import("slate-hyperscript/dist/creators").createCursor;
+    editor: (tagName: string, attributes: {
+        [key: string]: any;
+    }, children: any[]) => import("slate").BaseEditor;
+    element: typeof import("slate-hyperscript/dist/creators").createElement;
+    focus: typeof import("slate-hyperscript/dist/creators").createFocus;
+    fragment: typeof import("slate-hyperscript/dist/creators").createFragment;
+    selection: typeof import("slate-hyperscript/dist/creators").createSelection;
+    text: typeof import("slate-hyperscript/dist/creators").createText;
+})[S]>;

package/dist/test-utils/mockPlugin.d.ts

@@ -0,0 +1,2 @@
+import { RichTextPlugin } from '../types';
+export declare const mockPlugin: (p: Partial<RichTextPlugin>) => import("@udecode/plate-core").WithRequired<import("@udecode/plate-core").PlatePlugin<{}, {}>, "type" | "editor" | "options" | "inject">;

package/dist/test-utils/randomId.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Used to guarantee a unique editor and plugin keys for tests.
+ */
+export declare const randomId: (prefix?: string) => string;

package/dist/test-utils/setEmptyDataAttribute.d.ts

@@ -0,0 +1,6 @@
+import { PlateEditor } from '@udecode/plate-core';
+/**
+ * Sets empty node.data attributes. Helpful when testing against
+ * output generated by a 3rd-party library e.g. Plate.
+ */
+export declare const setEmptyDataAttribute: (root: PlateEditor) => void;

package/dist/test-utils/validation.d.ts

@@ -0,0 +1 @@
+export declare function validateRichTextDocument(document: any): never[];

package/dist/types.d.ts

@@ -0,0 +1,42 @@
+import { MARKS } from '@contentful/rich-text-types';
+import { PlatePlugin } from '@udecode/plate-core';
+import { RenderElementProps } from 'slate-react';
+import type { SoftBreakRule, ExitBreakRule } from './plugins/Break';
+import type { NormalizerRule } from './plugins/Normalizer';
+export declare type CustomText = {
+    text: string;
+    [MARKS.BOLD]?: boolean;
+    [MARKS.CODE]?: boolean;
+    [MARKS.ITALIC]?: boolean;
+    [MARKS.UNDERLINE]?: 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;
+declare module 'slate' {
+    interface CustomTypes {
+        Element: CustomElement;
+        Text: CustomText;
+    }
+}
+export interface RichTextPlugin extends PlatePlugin {
+    /**
+     * @see createSoftBreakPlugin
+     */
+    softBreak?: SoftBreakRule[];
+    /**
+     * @see createExitBreakPlugin
+     */
+    exitBreak?: ExitBreakRule[];
+    /**
+     * @see createNormalizerPlugin
+     */
+    normalizer?: NormalizerRule[];
+}