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

package/README.md

@@ -4,7 +4,7 @@
 npm install @contentful/field-editor-rich-text
 ```
 
-This package contains a React `RichTextEditor` component that is used as default for `RichText` field type in the Contentful web application.
+This package contains the updated rich text editor, currently in an **ALPHA** state (i.e., not suitable for production use and subject to breaking changes).
 
 This editor app is built on top of [Slate](https://github.com/ianstormtaylor/slate), a third party framework for building highly customizable rich text editing solutions.
 

package/dist/ContentfulEditorProvider.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { FieldExtensionSDK } from '@contentful/app-sdk';
+export declare function getContentfulEditorId(sdk: FieldExtensionSDK): string;
+interface useContentfulEditorHookProps {
+    sdk: FieldExtensionSDK;
+}
+export declare const ContentfulEditorProvider: import("react").FC<useContentfulEditorHookProps>, useContentfulEditor: any;
+export {};

package/dist/RichTextEditor.d.ts

@@ -1,61 +1,20 @@
-declare function RichTextEditor(props: any): JSX.Element;
-declare namespace RichTextEditor {
-    export namespace defaultProps {
-        export const isInitiallyDisabled: boolean;
-    }
-}
+/// <reference types="react" />
+import * as Contentful from '@contentful/rich-text-types';
+import { RichTextTrackingActionHandler } from './TrackingProvider';
+import { FieldExtensionSDK } from '@contentful/app-sdk';
+declare type ConnectedProps = {
+    sdk: FieldExtensionSDK;
+    onAction?: RichTextTrackingActionHandler;
+    minHeight?: string | number;
+    value?: object;
+    isDisabled?: boolean;
+    onChange?: (doc: Contentful.Document) => unknown;
+    isToolbarHidden?: boolean;
+    actionsDisabled?: boolean;
+};
+export declare const ConnectedRichTextEditor: (props: ConnectedProps) => JSX.Element;
+declare type Props = ConnectedProps & {
+    isInitiallyDisabled: boolean;
+};
+declare const RichTextEditor: (props: Props) => JSX.Element;
 export default RichTextEditor;
-export class ConnectedRichTextEditor extends React.Component<any, any, any> {
-    static propTypes: {
-        minHeight: PropTypes.Requireable<string | number>;
-        sdk: PropTypes.Validator<PropTypes.InferProps<{
-            field: PropTypes.Validator<PropTypes.InferProps<{
-                id: PropTypes.Validator<string>;
-                locale: PropTypes.Validator<string>;
-            }>>;
-            access: PropTypes.Validator<PropTypes.InferProps<{
-                can: PropTypes.Validator<(...args: any[]) => any>;
-            }>>;
-            parameters: PropTypes.Requireable<PropTypes.InferProps<{
-                instance: PropTypes.Validator<PropTypes.InferProps<{
-                    getEntryUrl: PropTypes.Requireable<(...args: any[]) => any>;
-                    getAssetUrl: PropTypes.Requireable<(...args: any[]) => any>;
-                }>>;
-            }>>;
-        }>>;
-        value: PropTypes.Requireable<object>;
-        isDisabled: PropTypes.Requireable<boolean>;
-        onChange: PropTypes.Requireable<(...args: any[]) => any>;
-        onAction: PropTypes.Requireable<(...args: any[]) => any>;
-        isToolbarHidden: PropTypes.Requireable<boolean>;
-        actionsDisabled: PropTypes.Requireable<boolean>;
-    };
-    static defaultProps: {
-        value: import("@contentful/rich-text-types").Document;
-        onChange: (...args: any[]) => void;
-        onAction: (...args: any[]) => void;
-        isDisabled: boolean;
-        isToolbarHidden: boolean;
-        actionsDisabled: boolean;
-    };
-    constructor(props: any);
-    constructor(props: any, context: any);
-    editor: React.RefObject<any>;
-    richTextAPI: {
-        sdk: {
-            object: any;
-        };
-        logViewportAction: {
-            function: any;
-        };
-        createActionLogger: {
-            function: any;
-        };
-    };
-    slatePlugins: any[];
-    onChange: (editor: any) => void;
-    callOnChange: import("lodash").DebouncedFunc<() => void>;
-    handleKeyDown: (event: any, editor: any, next: any) => any;
-}
-import React from "react";
-import PropTypes from "prop-types";

package/dist/RichTextEditor.styles.d.ts

@@ -0,0 +1,7 @@
+export declare const styles: {
+    root: string;
+    editor: string;
+    hiddenToolbar: string;
+    enabled: string;
+    disabled: string;
+};

package/dist/SdkProvider.d.ts

@@ -0,0 +1,7 @@
+import * as React from 'react';
+import { FieldExtensionSDK } from '@contentful/app-sdk';
+interface SdkProviderProps {
+    sdk: FieldExtensionSDK;
+}
+export declare const SdkProvider: React.FC<SdkProviderProps>, useSdkContext: any;
+export {};

package/dist/Toolbar/EmbedEntityWidget.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+export interface EmbedEntityWidgetProps {
+    isDisabled?: boolean;
+    canInsertBlocks?: boolean;
+}
+export declare const EmbedEntityWidget: ({ isDisabled, canInsertBlocks }: EmbedEntityWidgetProps) => JSX.Element;

package/dist/Toolbar/StickyToolbarWrapper.d.ts

@@ -1,12 +1,7 @@
+import { ReactNode } from 'react';
+declare type StickyToolbarProps = {
+    isDisabled?: boolean;
+    children: ReactNode;
+};
+declare const StickyToolbarWrapper: ({ isDisabled, children }: StickyToolbarProps) => JSX.Element;
 export default StickyToolbarWrapper;
-declare function StickyToolbarWrapper({ isDisabled, children }: {
-    isDisabled: any;
-    children: any;
-}): JSX.Element;
-declare namespace StickyToolbarWrapper {
-    export namespace propTypes {
-        export const isDisabled: PropTypes.Requireable<boolean>;
-        export const children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-    }
-}
-import PropTypes from "prop-types";

package/dist/Toolbar/index.d.ts

@@ -1,20 +1,6 @@
-export default class Toolbar extends React.Component<any, any, any> {
-    static propTypes: {
-        richTextAPI: PropTypes.Validator<object>;
-        isDisabled: PropTypes.Validator<boolean>;
-        editor: PropTypes.Validator<object>;
-        onChange: PropTypes.Validator<(...args: any[]) => any>;
-    };
-    constructor(props: any);
-    constructor(props: any, context: any);
-    hasMounted: boolean;
-    isReadyToSetFocusProgrammatically: boolean;
-    onChange: (...args: any[]) => void;
-    handleEmbedDropdownOpen: () => void;
-    handleEmbedDropdownClose: () => void;
-    renderEmbeds: (props: any) => JSX.Element;
-    openHeadingMenu: () => void;
-    closeHeadingMenu: () => void;
-}
-import React from "react";
-import PropTypes from "prop-types";
+/// <reference types="react" />
+declare type ToolbarProps = {
+    isDisabled?: boolean;
+};
+declare const Toolbar: ({ isDisabled }: ToolbarProps) => JSX.Element;
+export default Toolbar;

package/dist/TrackingProvider.d.ts

@@ -0,0 +1,11 @@
+import * as React from 'react';
+export declare type RichTextTrackingActionName = 'insertTable' | 'insertTableRow' | 'insertTableColumn' | 'removeTable' | 'removeTableRow' | 'removeTableColumn' | 'paste';
+export declare type RichTextTrackingActionHandler = (name: RichTextTrackingActionName, data: Record<string, unknown>) => unknown;
+interface TrackingProviderProps {
+    onAction: RichTextTrackingActionHandler;
+}
+export interface TrackingProvider {
+    onViewportAction: (actionName: RichTextTrackingActionName, data?: Record<string, unknown>) => ReturnType<TrackingProviderProps['onAction']>;
+}
+export declare const TrackingProvider: React.FC<TrackingProviderProps>, useTrackingContext: any;
+export {};

package/dist/constants/Schema.d.ts

@@ -1,29 +1,111 @@
-declare namespace _default {
-    export namespace document {
-        export const nodes: {
-            types: import("@contentful/rich-text-types").TopLevelBlockEnum[];
+import { BLOCKS, INLINES } from '@contentful/rich-text-types';
+declare const _default: {
+    document: {
+        nodes: {
+            types: {
+                type: import("@contentful/rich-text-types").TopLevelBlockEnum;
+            }[];
         }[];
-    }
-    export const blocks: any;
-    export const inlines: {
+    };
+    blocks: {
+        blockquote: {
+            nodes: {
+                match: {
+                    type: BLOCKS;
+                }[][];
+                min: number;
+            }[];
+            normalize: (editor: any, error: any) => any;
+        };
+        paragraph: {
+            nodes: {
+                match: ({
+                    type: INLINES;
+                } | {
+                    object: string;
+                })[];
+            }[];
+        };
+        "heading-1": {
+            nodes: {
+                match: ({
+                    type: INLINES;
+                } | {
+                    object: string;
+                })[];
+            }[];
+        };
+        "heading-2": {
+            nodes: {
+                match: ({
+                    type: INLINES;
+                } | {
+                    object: string;
+                })[];
+            }[];
+        };
+        "heading-3": {
+            nodes: {
+                match: ({
+                    type: INLINES;
+                } | {
+                    object: string;
+                })[];
+            }[];
+        };
+        "heading-4": {
+            nodes: {
+                match: ({
+                    type: INLINES;
+                } | {
+                    object: string;
+                })[];
+            }[];
+        };
+        "heading-5": {
+            nodes: {
+                match: ({
+                    type: INLINES;
+                } | {
+                    object: string;
+                })[];
+            }[];
+        };
+        "heading-6": {
+            nodes: {
+                match: ({
+                    type: INLINES;
+                } | {
+                    object: string;
+                })[];
+            }[];
+        };
+    };
+    inlines: {
         hyperlink: {
             nodes: {
-                objects: string[];
+                match: {
+                    object: string;
+                }[];
             }[];
         };
         "entry-hyperlink": {
             nodes: {
-                objects: string[];
+                match: {
+                    object: string;
+                }[];
             }[];
         };
         "asset-hyperlink": {
             nodes: {
-                objects: string[];
+                match: {
+                    object: string;
+                }[];
             }[];
         };
         "embedded-entry-inline": {
             isVoid: boolean;
         };
     };
-}
+};
 export default _default;

package/dist/dialogs/openRichTextDialog.d.ts

@@ -1 +1,2 @@
-export function openRichTextDialog(sdk: any): (options: any) => Promise<unknown>;
+import { DialogExtensionSDK } from '@contentful/app-sdk';
+export declare const openRichTextDialog: (sdk: DialogExtensionSDK) => (options: any) => Promise<unknown>;

package/dist/dialogs/renderRichTextDialog.d.ts

@@ -1 +1,3 @@
-export function renderRichTextDialog(sdk: any): JSX.Element;
+/// <reference types="react" />
+import { DialogExtensionSDK } from '@contentful/app-sdk';
+export declare const renderRichTextDialog: (sdk: DialogExtensionSDK) => JSX.Element;