@contentful/field-editor-rich-text 1.0.1 → 2.0.0-next.1

package/dist/helpers/deserializer.d.ts

@@ -0,0 +1,3 @@
+import { Deserialize, GetNodeDeserializerRule } from '@udecode/plate-core';
+export declare function deserializeLeaf(type: string, rules: GetNodeDeserializerRule[]): Deserialize;
+export declare function deserializeElement(type: string, rules: GetNodeDeserializerRule[]): Deserialize;

package/dist/helpers/editor.d.ts

@@ -0,0 +1,43 @@
+import { Path } from 'slate';
+import { BLOCKS, INLINES } from '@contentful/rich-text-types';
+import { CustomElement } from '../types';
+import { Link } from '@contentful/field-editor-reference/dist/types';
+import { PlateEditor } from '@udecode/plate-core';
+export declare const LINK_TYPES: INLINES[];
+export declare function isBlockSelected(editor: any, type: string): boolean;
+export declare function isVoid(editor: any, element: any): boolean;
+export declare function hasSelectionText(editor: any): boolean;
+declare type NodeEntry = [CustomElement, Path];
+declare type NodeType = BLOCKS | INLINES;
+export declare function getNodeEntryFromSelection(editor: any, nodeTypeOrTypes: NodeType | NodeType[]): NodeEntry | [];
+export declare function isNodeTypeSelected(editor: any, nodeType: BLOCKS | INLINES): boolean;
+export declare function moveToTheNextLine(editor: any): void;
+export declare function moveToThePreviousLine(editor: any): void;
+export declare function toggleBlock(editor: any, type: string): void;
+export declare function getElementFromCurrentSelection(editor: any): (import("slate").BaseEditor | CustomElement<unknown> | import("slate").BaseText | Path)[];
+export declare function isList(editor: any): boolean;
+export declare function getTableSize(table: CustomElement): Record<'numRows' | 'numColumns', number> | null;
+export declare function isFirstChild(path: Path): boolean;
+interface InsertLinkOptions {
+    text: string;
+    type: INLINES.HYPERLINK | INLINES.ENTRY_HYPERLINK | INLINES.ASSET_HYPERLINK;
+    url?: string;
+    target?: Link;
+    path?: Path;
+}
+export declare function insertLink(editor: any, options: InsertLinkOptions): void;
+export declare function isLinkActive(editor: any): boolean;
+export declare function unwrapLink(editor: any): void;
+export declare function wrapLink(editor: any, { text, url, target, type, path }: InsertLinkOptions): void;
+export declare function getAncestorPathFromSelection(editor: PlateEditor): Path | undefined;
+export declare function shouldUnwrapBlockquote(editor: PlateEditor, type: BLOCKS): boolean;
+export declare function unwrapFromRoot(editor: PlateEditor): void;
+export declare const isAtEndOfTextSelection: (editor: PlateEditor) => boolean;
+export declare function currentSelectionStartsTableCell(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 currentSelectionPrecedesTableCell(editor: PlateEditor): boolean;
+export {};

package/dist/helpers/environment.d.ts

@@ -0,0 +1 @@
+export declare const HAS_BEFORE_INPUT_SUPPORT: boolean;

package/dist/helpers/formatDateAndTime.d.ts

@@ -0,0 +1,15 @@
+declare type DateFormatFn = (date: Date | string, short?: boolean) => string;
+/**
+ * @param {Date|string} date A valid constructor argument for moment()
+ * @param {boolean=} short Render only Today/Tomorrow/Yesterday if valid. Defaults to false
+ */
+export declare const formatDate: DateFormatFn;
+/**
+ * Returns the time portion of a date in the local time in the format H:MM AM/PM
+ *
+ * == Examples
+ * * `T15:36:45.000Z` => 3:36 PM (if in +0:00 offset)
+ */
+export declare const formatTime: DateFormatFn;
+export declare const formatDateAndTime: DateFormatFn;
+export {};

package/dist/helpers/getLinkedContentTypeIdsForNodeType.d.ts

@@ -1,2 +1,26 @@
-declare function _default(field: object, nodeType: string): string[];
-export default _default;
+/**
+ * Given a field object and a rich text node type, return a list of valid
+ * content type IDs associated with the node type, based on that node type's
+ * `linkContentType` validation.
+ *
+ * If there is no such validation or the validation is empty, return an empty
+ * array.
+ *
+ * The navigation here is explained by the `nodes` validation having signature:
+ * { nodes: { [nodeType]: validationObject[] } }
+ *
+ * We defensively navigate through this object because
+ * 1) the field may not have a `validations` array,
+ * 2) the `validations` array may be empty,
+ * 3) the `validations` array may not have a `nodes` validation,
+ * 4) the `nodes` validation may not validate the `nodeType`, and
+ * 5) the `nodeType` validations may not have a `linkContentType` validation.
+ *
+ * Note that passing an empty array will result in all possible content types
+ * being whitelisted.
+ *
+ * @param {object} field
+ * @param {string} nodeType
+ * @returns {string[]}
+ */
+export default function getLinkedContentTypeIdsForNodeType(field: any, nodeType: any): string[];

package/dist/helpers/newEntitySelectorConfigFromRichTextField.d.ts

@@ -7,4 +7,8 @@
  * @param {string} nodeType
  * @returns {object}
  */
-export default function newEntitySelectorConfigFromRichTextField(field: object, nodeType: string): object;
+export default function newEntitySelectorConfigFromRichTextField(field: any, nodeType: any): {
+    entityType: "Entry" | "Asset";
+    locale: any;
+    contentTypes: string[];
+};

package/dist/helpers/sanitizeSlateDoc.d.ts

@@ -0,0 +1,18 @@
+import { BLOCKS, INLINES, Text } from '@contentful/rich-text-types';
+import { TextOrCustomElement } from 'types';
+declare type NodeType = BLOCKS | INLINES | Text['nodeType'];
+/**
+ * Ensures "orphaned" text node elements (those without a parent capable of
+ * validly rendering a text child node) are wrapped with a suitable parent
+ * element to prevent failures on the validation layer.
+ *
+ * It is commonplace for third party plugins (including udecode) to reconcile
+ * deletion events by inserting such nodes into their schema. This
+ * subprocedure is intended as a guard against such cases.
+ */
+export declare function sanitizeSlateDoc(nodes?: TextOrCustomElement[], parentNodeType?: NodeType): TextOrCustomElement[];
+/**
+ * Ensures incoming void nodes have a child leaf text element.
+ */
+export declare function sanitizeIncomingSlateDoc(nodes?: TextOrCustomElement[]): TextOrCustomElement[];
+export {};

package/dist/helpers/truncate.d.ts

@@ -0,0 +1 @@
+export declare function truncate(str: any, length: any): any;

package/dist/helpers/validations.d.ts

@@ -0,0 +1,10 @@
+import { BLOCKS, INLINES } from '@contentful/rich-text-types';
+import { FieldExtensionSDK } from '@contentful/app-sdk';
+export declare const VALIDATIONS: {
+    ENABLED_MARKS: string;
+    ENABLED_NODE_TYPES: string;
+};
+export declare const DEFAULT_ENABLED_NODE_TYPES: string[];
+export declare const VALIDATABLE_NODE_TYPES: (BLOCKS | INLINES)[];
+export declare const isNodeTypeEnabled: (field: FieldExtensionSDK['field'], nodeType: any) => boolean;
+export declare const isMarkEnabled: (field: FieldExtensionSDK['field'], mark: any) => boolean;

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

@@ -1,64 +1,12 @@
-export function BoldPlugin({ richTextAPI }: {
-    richTextAPI: any;
-}): {
-    renderMark: (props: any, _editor: any, next: any) => any;
-    onKeyDown(event: any, editor: any, next: any): any;
-};
-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;
-import React from "react";
+/// <reference types="react" />
+import * as Slate from 'slate-react';
+import { PlatePlugin } from '@udecode/plate-core';
+import { CustomSlatePluginOptions } 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 function createBoldPlugin(): PlatePlugin;
+export declare const withBoldOptions: CustomSlatePluginOptions;
+export {};

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

@@ -1,64 +1,12 @@
-export function CodePlugin({ richTextAPI }: {
-    richTextAPI: any;
-}): {
-    renderMark: (props: any, _editor: any, next: any) => any;
-    onKeyDown(event: any, editor: any, next: any): any;
-};
-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;
-import React from "react";
+/// <reference types="react" />
+import * as Slate from 'slate-react';
+import { PlatePlugin } from '@udecode/plate-core';
+import { CustomSlatePluginOptions } 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 function createCodePlugin(): PlatePlugin;
+export declare const withCodeOptions: CustomSlatePluginOptions;
+export {};

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

@@ -0,0 +1,2 @@
+import { PlatePlugin } from '@udecode/plate-core';
+export declare function createDragAndDropPlugin(): PlatePlugin;

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

@@ -0,0 +1,10 @@
+import * as React from 'react';
+interface EmbeddedEntityDropdownButtonProps {
+    children: React.ReactNode;
+    isDisabled: boolean | undefined;
+    isOpen: boolean;
+    onClose: () => void;
+    onToggle: () => void;
+}
+export declare function EmbeddedEntityDropdownButton({ children, isDisabled, isOpen, onClose, onToggle, }: EmbeddedEntityDropdownButtonProps): JSX.Element;
+export {};

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

@@ -0,0 +1,13 @@
+/// <reference types="react" />
+import { CustomRenderElementProps } from '../../types';
+declare type LinkedEntityBlockProps = CustomRenderElementProps<{
+    target: {
+        sys: {
+            id: string;
+            linkType: 'Entry' | 'Asset';
+            type: 'Link';
+        };
+    };
+}>;
+export declare function LinkedEntityBlock(props: LinkedEntityBlockProps): JSX.Element;
+export {};

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

@@ -1,11 +1,13 @@
-export default class EntityLinkToolbarIcon extends React.Component<any, any, any> {
-    static propTypes: any;
-    static defaultProps: {
-        isButton: boolean;
-    };
-    constructor(props: any);
-    constructor(props: any, context: any);
-    handleClick: (e: any) => void;
-    handleAction: (event: any) => any;
+/// <reference types="react" />
+export declare const styles: {
+    icon: string;
+};
+interface EmbeddedEntityBlockToolbarIconProps {
+    isButton?: boolean;
+    isDisabled: boolean;
+    logAction?: () => void;
+    nodeType: string;
+    onClose: () => void;
 }
-import React from "react";
+export declare function EmbeddedEntityBlockToolbarIcon({ isButton, isDisabled, logAction, nodeType, onClose, }: EmbeddedEntityBlockToolbarIconProps): JSX.Element;
+export {};

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

@@ -1,23 +1,2 @@
-/**
- * Invokes entity selector modal and inserts block embed.
- * @param {string} nodeType
- * @param {import('@contentful/field-editor-reference/dist/types').FieldExtensionSDK} sdk
- * @param {slate.Editor} editor
- * @param {function} logAction
- */
-export function selectEntityAndInsert(nodeType: string, sdk: import('@contentful/field-editor-reference/dist/types').FieldExtensionSDK, editor: any, logAction: Function): Promise<void>;
-export function insertBlock(editor: any, nodeType: any, entity: any, focusNextLine?: boolean): void;
-export function hasBlockOfType(editor: any, type: string): boolean;
-export function createNode(nodeType: any, entity: any): {
-    type: any;
-    object: string;
-    data: {
-        target: {
-            sys: {
-                id: any;
-                type: string;
-                linkType: any;
-            };
-        };
-    };
-};
+export declare function selectEntityAndInsert(nodeType: any, sdk: any, editor: any, logAction: any): Promise<void>;
+export declare function insertBlock(editor: any, nodeType: any, entity: any): void;

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

@@ -1,26 +1,11 @@
-export default ToolbarIcon;
-export function EmbeddedEntityBlockPlugin({ richTextAPI: { sdk, logShortcutAction, logViewportAction }, nodeType, hotkey, }: {
-    richTextAPI: {
-        sdk: any;
-        logShortcutAction: any;
-        logViewportAction: any;
-    };
-    nodeType: any;
-    hotkey: any;
-}): {
-    renderNode: (props: any, _editor: any, next: any) => any;
-    onKeyDown(e: any, editor: any, next: any): any;
-};
-export function EmbeddedEntryBlockPlugin({ richTextAPI }: {
-    richTextAPI: any;
-}): {
-    renderNode: (props: any, _editor: any, next: any) => any;
-    onKeyDown(e: any, editor: any, next: any): any;
-};
-export function EmbeddedAssetBlockPlugin({ richTextAPI }: {
-    richTextAPI: any;
-}): {
-    renderNode: (props: any, _editor: any, next: any) => any;
-    onKeyDown(e: any, editor: any, next: any): any;
-};
-import ToolbarIcon from "./ToolbarIcon";
+import { KeyboardEvent } from 'react';
+import { BLOCKS } from '@contentful/rich-text-types';
+import { PlatePlugin, PlateEditor } from '@udecode/plate-core';
+import { CustomSlatePluginOptions } from 'types';
+import { FieldExtensionSDK } from '@contentful/app-sdk';
+export { EmbeddedEntityBlockToolbarIcon as ToolbarIcon } from './ToolbarIcon';
+export declare const createEmbeddedEntryBlockPlugin: (sdk: FieldExtensionSDK) => PlatePlugin;
+export declare const createEmbeddedAssetBlockPlugin: (sdk: FieldExtensionSDK) => PlatePlugin;
+export declare const withEmbeddedEntryBlockOptions: CustomSlatePluginOptions;
+export declare const withEmbeddedAssetBlockOptions: CustomSlatePluginOptions;
+export declare function getWithEmbeddedEntityEvents(nodeType: BLOCKS.EMBEDDED_ENTRY | BLOCKS.EMBEDDED_ASSET, sdk: FieldExtensionSDK): (editor: PlateEditor) => (event: KeyboardEvent) => void;

package/dist/plugins/EmbeddedEntityInline/FetchingWrappedInlineEntryCard.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import { FieldExtensionSDK } from '@contentful/field-editor-shared';
+interface FetchingWrappedInlineEntryCardProps {
+    entryId: string;
+    sdk: FieldExtensionSDK;
+    isSelected: boolean;
+    isDisabled: boolean;
+    onEdit: (event: React.MouseEvent<Element, MouseEvent>) => void;
+    onRemove: (event: React.MouseEvent<Element, MouseEvent>) => void;
+}
+export declare function FetchingWrappedInlineEntryCard(props: FetchingWrappedInlineEntryCardProps): JSX.Element;
+export {};

package/dist/plugins/EmbeddedEntityInline/Util.d.ts

@@ -0,0 +1,16 @@
+import { INLINES } from '@contentful/rich-text-types';
+export declare function createInlineEntryNode(id: string): {
+    type: INLINES;
+    children: {
+        text: string;
+    }[];
+    data: {
+        target: {
+            sys: {
+                id: string;
+                type: string;
+                linkType: string;
+            };
+        };
+    };
+};

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

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import { PlatePlugin } from '@udecode/plate-core';
+import { CustomSlatePluginOptions } from '../../types';
+interface ToolbarEmbeddedEntityInlineButtonProps {
+    onClose: () => void;
+    isDisabled: boolean;
+    isButton?: boolean;
+}
+export declare function ToolbarEmbeddedEntityInlineButton(props: ToolbarEmbeddedEntityInlineButtonProps): JSX.Element;
+export declare function createEmbeddedEntityInlinePlugin(sdk: any): PlatePlugin;
+export declare const withEmbeddedEntityInlineOptions: CustomSlatePluginOptions;
+export {};