@contentful/field-editor-rich-text 3.0.0-next.0 → 3.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Contentful
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -4,11 +4,33 @@
 npm install @contentful/field-editor-rich-text
 ```
 
-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.
+This package contains a React `RichTextEditor` component that is used as the default for `RichText` field type in the Contentful web application.
 
 ```js
 import 'codemirror/lib/codemirror.css';
 import { RichTextEditor } from '@contentful/field-editor-rich-text';
 ```
+
+## Migrating to v2
+
+To bring support for Rich Text Tables we rewrote most of the internals of this package to adapt the latest version of [Slate][slate]. We are releasing this change as v2.0.0.
+
+There are two ways our users typically use the rich-text field editor:
+
+### 1. By embedding `@contentful/field-editor-rich-text` npm package
+
+Since the public API exposed by the package remains the same, upgrading to v2 should be seamless as it's just a matter of installing the latest version from npm. No migration is needed.
+
+### 2. By forking the source code
+
+You will need to adapt your fork to work with v2. Here is a highlight of the major changes:
+
+1. Using Slate >= v0.80.0. If you're upgrading from < 0.50.x Please check the library [migration guide](https://docs.slatejs.org/concepts/xx-migrating)
+2. Using Plate as a plugin system. Plate is a powerful plugin system to make it easy to work with Slate. All of the existing rich text plugins were rewritten to use Plate. To learn more, please check Plate's [website][plate].
+
+## Credits
+
+This package is based on [Slate][slate] & [Plate][plate] and also borrows some of their code. Without them, this project would not have been possible.
+
+[slate]: https://www.slatejs.org/
+[plate]: https://plate.udecode.io/

package/dist/ContentfulEditorProvider.d.ts

@@ -1,8 +1,9 @@
 /// <reference types="react" />
 import { FieldExtensionSDK } from '@contentful/app-sdk';
+import { RichTextEditor } from './types';
 export declare function getContentfulEditorId(sdk: FieldExtensionSDK): string;
-interface useContentfulEditorHookProps {
-    sdk: FieldExtensionSDK;
-}
-export declare const ContentfulEditorProvider: import("react").FC<useContentfulEditorHookProps>, useContentfulEditor: any;
-export {};
+export declare const editorContext: import("react").Context<string>;
+export declare const ContentfulEditorIdProvider: import("react").Provider<string>;
+export declare function useContentfulEditorId(id?: string): string;
+export declare function useContentfulEditor(id?: string): import("@udecode/plate-core").PlateEditor<RichTextEditor>;
+export declare function useContentfulEditorRef(id?: string): import("@udecode/plate-core").PlateEditor<RichTextEditor>;

package/dist/RichTextEditor.d.ts

@@ -1,7 +1,6 @@
-/// <reference types="react" />
-import * as Contentful from '@contentful/rich-text-types';
-import { RichTextTrackingActionHandler } from './TrackingProvider';
 import { FieldExtensionSDK } from '@contentful/app-sdk';
+import * as Contentful from '@contentful/rich-text-types';
+import { RichTextTrackingActionHandler } from './plugins/Tracking';
 declare type ConnectedProps = {
     sdk: FieldExtensionSDK;
     onAction?: RichTextTrackingActionHandler;

package/dist/SdkProvider.d.ts

@@ -3,5 +3,5 @@ import { FieldExtensionSDK } from '@contentful/app-sdk';
 interface SdkProviderProps {
     sdk: FieldExtensionSDK;
 }
-export declare const SdkProvider: React.FC<SdkProviderProps>, useSdkContext: any;
+export declare const SdkProvider: React.FC<SdkProviderProps>, useSdkContext: () => FieldExtensionSDK;
 export {};

package/dist/Toolbar/{EmbedEntityWidget.d.ts → components/EmbedEntityWidget.d.ts}

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

package/dist/{plugins/EmbeddedEntity/index.d.ts → Toolbar/components/EmbeddedEntityDropdownButton.d.ts}

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

package/dist/Toolbar/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 declare type ToolbarProps = {
     isDisabled?: boolean;
 };

package/dist/dialogs/HypelinkDialog/HyperlinkDialog.d.ts

@@ -1,7 +1,7 @@
 export namespace LINK_TYPES {
-    export const URI: string;
-    export const ENTRY: string;
-    export const ASSET: string;
+    const URI: string;
+    const ENTRY: string;
+    const ASSET: string;
 }
 export class HyperlinkDialog extends React.Component<any, any, any> {
     static propTypes: {

package/dist/dialogs/renderRichTextDialog.d.ts

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