@contentful/field-editor-rich-text 2.0.0-next.2 → 2.0.0-next.6

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

@@ -1,7 +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;
+    input?: any;
     sdk?: FieldExtensionSDK;
     tracking?: TrackingProvider;
-}) => import("@udecode/plate").PlateEditor<{}>;
+    plugins?: RichTextPlugin[];
+}) => {
+    editor: PlateEditor<{}>;
+    normalize: () => void;
+};

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

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

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

@@ -1,9 +1,9 @@
 /**
  * Mapping for JSX => Slate Node types
  *
- * Add items as needed.
+ * Add items as needed. Don't forget to adjust hyperscript.d.ts
  */
-export declare const jsx: <S extends "element" | "text" | "editor" | "cursor" | "focus" | "anchor" | "fragment" | "selection">(tagName: S, attributes?: Object | undefined, ...children: any[]) => ReturnType<({
+export declare const jsx: <S extends "editor" | "selection" | "text" | "element" | "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: {

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" | "options" | "inject" | "editor">;

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

@@ -1,10 +1,16 @@
-/// <reference types="react" />
-import { PlatePluginOptions } from '@udecode/plate';
-import { RenderElementProps, RenderLeafProps } from 'slate-react';
-export declare type TextElement = {
+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 | TextElement;
+export declare type TextOrCustomElement = CustomElement | CustomText;
 export declare type CustomElement<T = unknown> = {
     type: string;
     children: TextOrCustomElement[];
@@ -14,12 +20,23 @@ export declare type CustomElement<T = unknown> = {
 export declare type CustomRenderElementProps<T = any, O = any> = Omit<RenderElementProps, 'element'> & {
     element: CustomElement<T>;
 } & O;
-export interface CustomPluginOptions extends Omit<PlatePluginOptions, 'component'> {
-    component?: React.FunctionComponent<CustomRenderElementProps> | React.FunctionComponent<RenderLeafProps>;
-}
-export declare type CustomSlatePluginOptions = Record<string, CustomPluginOptions>;
 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[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/field-editor-rich-text",
-  "version": "2.0.0-next.2",
+  "version": "2.0.0-next.6",
   "publishConfig": {
     "tag": "next"
   },
@@ -27,27 +27,34 @@
     "prepublishOnly": "yarn build"
   },
   "dependencies": {
-    "@contentful/contentful-slatejs-adapter": "^15.8.0",
-    "@contentful/f36-components": "beta",
-    "@contentful/f36-icons": "beta",
-    "@contentful/f36-tokens": "beta",
-    "@contentful/field-editor-reference": "^4.0.0",
-    "@contentful/field-editor-shared": "^1.0.0",
-    "@contentful/rich-text-plain-text-renderer": "^15.6.2",
-    "@contentful/rich-text-types": "^15.7.0",
-    "@udecode/plate": "^7.0.3",
-    "@udecode/plate-test-utils": "^3.2.0",
+    "@contentful/contentful-slatejs-adapter": "^15.11.0",
+    "@contentful/f36-components": "^4.0.1-beta.2705",
+    "@contentful/f36-icons": "^4.0.1-beta.2705",
+    "@contentful/f36-tokens": "^4.0.1-beta.2705",
+    "@contentful/field-editor-reference": "^4.0.7",
+    "@contentful/field-editor-shared": "^1.0.3",
+    "@contentful/rich-text-plain-text-renderer": "^15.11.1",
+    "@contentful/rich-text-types": "^15.11.1",
+    "@udecode/plate-basic-marks": "^9.2.1",
+    "@udecode/plate-break": "^9.2.1",
+    "@udecode/plate-core": "^9.2.1",
+    "@udecode/plate-list": "^9.2.1",
+    "@udecode/plate-paragraph": "^9.2.1",
+    "@udecode/plate-select": "^9.2.1",
+    "@udecode/plate-serializer-docx": "^9.2.1",
+    "@udecode/plate-table": "^9.2.1",
+    "@udecode/plate-trailing-block": "^9.2.1",
     "fast-deep-equal": "^3.1.3",
-    "react": ">=16.14.0",
-    "slate": "^0.70.0",
+    "is-hotkey": "^0.2.0",
+    "is-plain-obj": "^3.0.0",
+    "slate": "^0.72.3",
     "slate-history": "^0.66.0",
     "slate-hyperscript": "^0.67.0",
-    "slate-react": "^0.70.2"
+    "slate-react": "^0.72.6"
   },
   "peerDependencies": {
     "react": ">=16.14.0",
-    "react-dom": ">=16.14.0",
-    "slate": "^0.66.1"
+    "react-dom": ">=16.14.0"
   },
   "devDependencies": {
     "@babel/core": "^7.9.6",
@@ -59,6 +66,9 @@
     "@babel/preset-env": "7.12.11",
     "@babel/preset-react": "7.13.13",
     "@contentful/field-editor-test-utils": "^1.0.0",
-    "@contentful/rich-text-react-renderer": "^15.6.2"
+    "@contentful/rich-text-react-renderer": "^15.11.0",
+    "@types/is-hotkey": "^0.1.6",
+    "@udecode/plate-test-utils": "^3.2.0",
+    "react": ">=16.14.0"
   }
 }

package/dist/helpers/deserializer.d.ts

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

package/dist/helpers/normalizers.d.ts

@@ -1,15 +0,0 @@
-import { NodeEntry } from 'slate';
-import { PlateEditor } from '@udecode/plate-core';
-import { CustomElement } from '../types';
-export declare type Normalizer = (editor: PlateEditor, entry: NodeEntry<CustomElement>) => true | undefined;
-/**
- * Injects a custom element normalization handler.
- *
- * Handlers must explicity return "true" to indicate a pass.
- * A pass is when a handler didn't encounter any normalization
- * paths (i.e. all nodes were valid)
- *
- * Important read:
- * https://docs.slatejs.org/concepts/11-normalizing#multi-pass-normalizing
- */
-export declare const withNormalizer: (editor: PlateEditor, handler: Normalizer) => void;

package/dist/helpers/truncate.d.ts

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

package/dist/plugins/CommandPalette/CommandPanel/InViewport/InViewport.d.ts

@@ -1,37 +0,0 @@
-export class InViewport extends React.Component<any, any, any> {
-    static defaultProps: {
-        testId: string;
-        offset: number;
-    };
-    constructor(props: any);
-    constructor(props: any, context: any);
-    tGetDomPosition: any;
-    nodeRef: any;
-    lastOverflowAt: any;
-    tOnOverflowTop: (...args: any[]) => any;
-    tOnOverflowBottom: (...args: any[]) => any;
-    tOnOverflowRight: (...args: any[]) => any;
-    tOnOverflowLeft: (...args: any[]) => any;
-    getDomPosition: () => void;
-    bindEventListeners: () => void;
-    handleOverflow: ({ top, left, bottom, right }: {
-        top: any;
-        left: any;
-        bottom: any;
-        right: any;
-    }, windowWidth: any, windowHeight: any) => void;
-}
-export namespace InViewport {
-    export namespace propTypes {
-        export const offset: PropTypes.Requireable<number>;
-        export const onOverflowTop: PropTypes.Requireable<(...args: any[]) => any>;
-        export const onOverflowRight: PropTypes.Requireable<(...args: any[]) => any>;
-        export const onOverflowBottom: PropTypes.Requireable<(...args: any[]) => any>;
-        export const onOverflowLeft: PropTypes.Requireable<(...args: any[]) => any>;
-        export const className: PropTypes.Requireable<string>;
-        export const children: PropTypes.Requireable<any>;
-        export const testId: PropTypes.Requireable<string>;
-    }
-}
-import React from "react";
-import PropTypes from "prop-types";

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

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

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

@@ -1,6 +0,0 @@
-/**
- * A copy of Plate's list plugin with a few adjustments
- * to fix pasting text inside lists.
- */
-import { PlateEditor, TDescendant } from '@udecode/plate';
-export declare const getListInsertFragment: (editor: PlateEditor) => (fragment: TDescendant[]) => void;

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

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

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

@@ -1,2 +0,0 @@
-import { PlatePlugin } from '@udecode/plate';
-export declare const createPastePlugin: () => PlatePlugin;

package/dist/plugins/Paste/sanitizers/helpers.d.ts

@@ -1,7 +0,0 @@
-import { PlateEditor } from '@udecode/plate';
-export declare type SanitizerTuple = [Document, PlateEditor];
-declare type Predicate = (node: ChildNode) => boolean;
-export declare const isHTMLElement: (node: ChildNode) => node is HTMLElement;
-export declare const removeChildNodes: (node: ChildNode, predicate?: Predicate) => void;
-export declare const removeChildNodesUsingPredicate: (predicate: Predicate) => (nodeList: NodeList) => Node[];
-export {};

package/dist/plugins/Paste/sanitizers/index.d.ts

@@ -1,3 +0,0 @@
-export { removeComments } from './removeComments';
-export { sanitizeTables } from './sanitizeTables';
-export { sanitizeEntityBlocks } from './sanitizeEntityBlocks';

package/dist/plugins/Paste/sanitizers/removeComments.d.ts

@@ -1,2 +0,0 @@
-import { SanitizerTuple } from './helpers';
-export declare const removeComments: ([doc, editor]: SanitizerTuple) => SanitizerTuple;

package/dist/plugins/Paste/sanitizers/sanitizeEntityBlocks.d.ts

@@ -1,6 +0,0 @@
-import { SanitizerTuple } from './helpers';
-/**
- * Ensures the text selection from entity block elements is
- * not included in the paste buffer.
- */
-export declare const sanitizeEntityBlocks: ([doc, editor]: SanitizerTuple) => SanitizerTuple;

package/dist/plugins/Paste/sanitizers/sanitizeTables.d.ts

@@ -1,2 +0,0 @@
-import { SanitizerTuple } from './helpers';
-export declare const sanitizeTables: ([doc, editor]: SanitizerTuple) => SanitizerTuple;

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

@@ -1,5 +0,0 @@
-/// <reference types="react" />
-export declare const styles: {
-    topRight: string;
-};
-export declare const TableActions: () => JSX.Element;

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

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