@contentful/field-editor-rich-text 2.0.0-next.9 → 2.0.1

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

@@ -1,15 +1,16 @@
-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;
+import { RichTextEditor, TextOrCustomElement } from '../../types';
+export declare function insertTableAndFocusFirstCell(editor: RichTextEditor): void;
+export declare function isTableActive(editor: RichTextEditor): boolean;
+export declare function isTableHeaderEnabled(editor: RichTextEditor): boolean;
+export declare function replaceEmptyParagraphWithTable(editor: RichTextEditor): 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 getNoOfMissingTableCellsInRow: (editor: RichTextEditor, [, rowPath]: NodeEntry<Node>) => number;
 export declare const createEmptyTableCells: (count: number) => Node[];
-export declare const isNotEmpty: (editor: PlateEditor, [, path]: NodeEntry<Node>) => boolean;
+export declare const isNotEmpty: (editor: RichTextEditor, [, path]: NodeEntry<Node>) => boolean;
+export declare const isTable: (node: TextOrCustomElement) => boolean;

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

@@ -0,0 +1,3 @@
+import { Node } from 'slate';
+import { RichTextEditor } from '../../types';
+export declare const insertTableFragment: (editor: RichTextEditor) => (fragments: Node[]) => void;

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

@@ -0,0 +1,3 @@
+import { HotkeyPlugin, KeyboardHandler } from '@udecode/plate-core';
+import { RichTextEditor } from '../../types';
+export declare const onKeyDownTable: KeyboardHandler<RichTextEditor, HotkeyPlugin>;

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

@@ -0,0 +1,4 @@
+import { RichTextEditor } from '../../types';
+import type { NodeTransformer } from '../Normalizer';
+export declare function addTableTrackingEvents(editor: RichTextEditor): void;
+export declare const withInvalidCellChildrenTracking: (transformer: NodeTransformer) => NodeTransformer;

package/dist/plugins/Tracking/createTrackingPlugin.d.ts

@@ -0,0 +1,11 @@
+import { RichTextPlugin } from '../../types';
+export declare type RichTextTrackingActionName = 'edit' | 'insert' | 'remove' | 'mark' | 'unmark' | 'insertTable' | 'insertTableRow' | 'insertTableColumn' | 'removeTable' | 'removeTableRow' | 'removeTableColumn' | 'paste' | 'invalidTablePaste' | 'cancelCreateHyperlinkDialog' | 'cancelEditHyperlinkDialog' | 'linkRendered' | 'openCreateHyperlinkDialog' | 'openEditHyperlinkDialog' | 'unlinkHyperlinks' | 'openCreateEmbedDialog' | 'cancelCreateEmbedDialog';
+export declare type RichTextTrackingActionHandler = (name: RichTextTrackingActionName, data: Record<string, unknown>) => unknown;
+export interface TrackingPluginActions {
+    onViewportAction: (actionName: RichTextTrackingActionName, data?: Record<string, unknown>) => ReturnType<RichTextTrackingActionHandler>;
+    onShortcutAction: (actionName: RichTextTrackingActionName, data?: Record<string, unknown>) => ReturnType<RichTextTrackingActionHandler>;
+    onToolbarAction: (actionName: RichTextTrackingActionName, data?: Record<string, unknown>) => ReturnType<RichTextTrackingActionHandler>;
+    onCommandPaletteAction: (actionName: RichTextTrackingActionName, data?: Record<string, unknown>) => ReturnType<RichTextTrackingActionHandler>;
+}
+export declare function getPastingSource(data: DataTransfer): "Google Docs" | "Google Spreadsheets" | "Microsoft Excel" | "Microsoft Word" | "Microsoft Word Online" | "Apple Notes" | "Slack" | "Unknown";
+export declare const createTrackingPlugin: (onAction: RichTextTrackingActionHandler) => RichTextPlugin;

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

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

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

@@ -0,0 +1,2 @@
+import { RichTextEditor } from '../../types';
+export declare function getCharacterCount(editor: RichTextEditor): number;

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

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

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

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

package/dist/plugins/index.d.ts

@@ -1,6 +1,6 @@
 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[];
+import { RichTextTrackingActionHandler } from './Tracking';
+export declare const getPlugins: (sdk: FieldExtensionSDK, onAction: RichTextTrackingActionHandler) => RichTextPlugin[];
 export declare const disableCorePlugins: PlateProps['disableCorePlugins'];

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

@@ -1,7 +1,6 @@
 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 declare function withLinkTracking(Component: React.ComponentType<WithEntityFetchProps>): (props: ComponentProps<typeof Component>) => JSX.Element;
 export {};

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

@@ -1,5 +1,4 @@
 import { FieldExtensionSDK } from '@contentful/app-sdk';
-import { File } from '@contentful/field-editor-shared';
 interface FetchingWrappedAssetCardProps {
     assetId: string;
     isDisabled: boolean;
@@ -10,14 +9,5 @@ interface FetchingWrappedAssetCardProps {
     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

@@ -9,5 +9,5 @@ interface FetchingWrappedEntryCardProps {
     onEdit?: VoidFunction;
     onRemove?: VoidFunction;
 }
-export declare function FetchingWrappedEntryCard(props: FetchingWrappedEntryCardProps): JSX.Element;
+export declare const FetchingWrappedEntryCard: (props: FetchingWrappedEntryCardProps) => JSX.Element;
 export {};

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

@@ -0,0 +1,8 @@
+import { Entry, Asset } from '@contentful/app-sdk';
+interface FetchedEntityProps {
+    type: 'Entry' | 'Asset';
+    id: string;
+    onEntityFetchComplete?: VoidFunction;
+}
+export declare function useFetchedEntity({ type, id, onEntityFetchComplete }: FetchedEntityProps): Entry<Record<string, any>> | Asset | "failed" | undefined;
+export {};

package/dist/prepareDocument.d.ts

@@ -0,0 +1,20 @@
+import { Document } from '@contentful/rich-text-types';
+import { CreatePlateEditorOptions } from '@udecode/plate-core';
+import { Descendant, Editor, Node } from 'slate';
+import { RichTextEditor } from 'types';
+/**
+ * For legacy reasons, a document may not have any content at all
+ * e.g:
+ *
+ * {nodeType: document, data: {}, content: []}
+ *
+ * Rendering such document will break the Slate editor
+ */
+export declare const hasContent: (doc?: Document | undefined) => boolean;
+export declare const setEditorContent: (editor: Editor, nodes?: Node[] | undefined) => void;
+/**
+ * Converts a Contentful rich text document to the corresponding slate editor
+ * value
+ */
+export declare const documentToEditorValue: (doc: any) => Descendant[];
+export declare const normalizeEditorValue: (value: Descendant[], options?: Pick<CreatePlateEditorOptions<RichTextEditor>, "plugins" | "disableCorePlugins" | "components" | "overrideByKey" | "normalizeInitialValue"> | undefined) => Descendant[] & any[];

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

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

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

@@ -1,14 +1,13 @@
 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;
+import { RichTextTrackingActionHandler } from '../plugins/Tracking';
+import { RichTextEditor, RichTextPlugin } from '../types';
+export declare const normalize: (editor: RichTextEditor) => void;
 export declare const createTestEditor: (options: {
     input?: any;
     sdk?: FieldExtensionSDK;
-    tracking?: TrackingProvider;
+    trackingHandler?: RichTextTrackingActionHandler;
     plugins?: RichTextPlugin[];
 }) => {
-    editor: PlateEditor<{}>;
+    editor: import("@udecode/plate-core").PlateEditor<RichTextEditor>;
     normalize: () => void;
 };

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

@@ -3,7 +3,7 @@
  *
  * 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<({
+export declare const jsx: <S extends "element" | "editor" | "text" | "focus" | "anchor" | "cursor" | "fragment" | "selection">(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

@@ -1,2 +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">;
+export declare const mockPlugin: (p: Partial<RichTextPlugin>) => any;

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

@@ -1,6 +1,6 @@
-import { PlateEditor } from '@udecode/plate-core';
+import { RichTextEditor } from '../types';
 /**
  * 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;
+export declare const setEmptyDataAttribute: (root: RichTextEditor) => void;

package/dist/types.d.ts

@@ -1,8 +1,9 @@
 import { MARKS } from '@contentful/rich-text-types';
-import { PlatePlugin } from '@udecode/plate-core';
+import { PlateEditor, PlatePlugin } from '@udecode/plate-core';
 import { RenderElementProps } from 'slate-react';
-import type { SoftBreakRule, ExitBreakRule } from './plugins/Break';
+import type { SoftBreakRule, ExitBreakRule, ResetNodePluginRule } from './plugins/Break';
 import type { NormalizerRule } from './plugins/Normalizer';
+import { TrackingPluginActions } from './plugins/Tracking';
 export declare type CustomText = {
     text: string;
     [MARKS.BOLD]?: boolean;
@@ -26,7 +27,7 @@ declare module 'slate' {
         Text: CustomText;
     }
 }
-export interface RichTextPlugin extends PlatePlugin {
+export interface RichTextPlugin extends PlatePlugin<RichTextEditor> {
     /**
      * @see createSoftBreakPlugin
      */
@@ -35,8 +36,15 @@ export interface RichTextPlugin extends PlatePlugin {
      * @see createExitBreakPlugin
      */
     exitBreak?: ExitBreakRule[];
+    /**
+     * @see createResetNodePlugin
+     */
+    resetNode?: ResetNodePluginRule[];
     /**
      * @see createNormalizerPlugin
      */
     normalizer?: NormalizerRule[];
 }
+export interface RichTextEditor extends PlateEditor {
+    tracking: TrackingPluginActions;
+}

package/dist/useOnValueChanged.d.ts

@@ -0,0 +1,8 @@
+import { Document } from '@contentful/rich-text-types';
+export declare type OnValueChangedProps = {
+    editorId: string;
+    handler?: (value: Document) => unknown;
+    skip?: boolean;
+    onSkip?: VoidFunction;
+};
+export declare const useOnValueChanged: ({ editorId, handler, skip, onSkip }: OnValueChangedProps) => (value: unknown) => void;

package/package.json

@@ -1,9 +1,6 @@
 {
   "name": "@contentful/field-editor-rich-text",
-  "version": "2.0.0-next.9",
-  "publishConfig": {
-    "tag": "next"
-  },
+  "version": "2.0.1",
   "source": "./src/index.tsx",
   "main": "./dist/index.js",
   "module": "dist/field-editor-rich-text.esm.js",
@@ -27,30 +24,32 @@
     "prepublishOnly": "yarn build"
   },
   "dependencies": {
-    "@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/app-sdk": "^4.6.0",
+    "@contentful/contentful-slatejs-adapter": "^15.13.1",
+    "@contentful/f36-components": "^4.0.33",
+    "@contentful/f36-icons": "^4.1.1",
+    "@contentful/f36-tokens": "^4.0.0",
+    "@contentful/field-editor-reference": "^4.3.9",
     "@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",
+    "@contentful/rich-text-plain-text-renderer": "^15.12.1",
+    "@contentful/rich-text-types": "^15.12.1",
+    "@udecode/plate-basic-marks": "^10.4.0",
+    "@udecode/plate-break": "^10.4.0",
+    "@udecode/plate-core": "^10.4.0",
+    "@udecode/plate-list": "^10.4.0",
+    "@udecode/plate-paragraph": "^10.4.0",
+    "@udecode/plate-reset-node": "^10.4.0",
+    "@udecode/plate-select": "^10.4.0",
+    "@udecode/plate-serializer-docx": "^10.4.0",
+    "@udecode/plate-table": "^10.4.0",
+    "@udecode/plate-trailing-block": "^10.4.0",
     "fast-deep-equal": "^3.1.3",
     "is-hotkey": "^0.2.0",
     "is-plain-obj": "^3.0.0",
-    "slate": "^0.72.3",
+    "slate": "^0.80.0",
     "slate-history": "^0.66.0",
     "slate-hyperscript": "^0.67.0",
-    "slate-react": "^0.72.6"
+    "slate-react": "^0.80.0"
   },
   "peerDependencies": {
     "react": ">=16.14.0",
@@ -70,5 +69,6 @@
     "@types/is-hotkey": "^0.1.6",
     "@udecode/plate-test-utils": "^3.2.0",
     "react": ">=16.14.0"
-  }
+  },
+  "gitHead": "6a5af47ae1e39639805ec56251dc20ed376d5983"
 }

package/dist/TrackingProvider.d.ts

@@ -1,11 +0,0 @@
-import * as React from 'react';
-export declare type RichTextTrackingActionName = 'insertTable' | 'insertTableRow' | 'insertTableColumn' | 'removeTable' | 'removeTableRow' | 'removeTableColumn' | 'paste' | 'linkRendered';
-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/plugins/Hyperlink/EntryAssetTooltip.d.ts

@@ -1,9 +0,0 @@
-import { ContentEntityType as EntityType } from '@contentful/field-editor-reference/dist/types';
-import { FieldExtensionSDK } from '@contentful/field-editor-shared';
-interface EntryAssetTooltipProps {
-    id: string;
-    type: EntityType;
-    sdk: FieldExtensionSDK;
-}
-export declare function EntryAssetTooltip({ id, type, sdk }: EntryAssetTooltipProps): JSX.Element;
-export {};

package/dist/plugins/Hyperlink/truncate.d.ts

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

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

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

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

@@ -1,7 +0,0 @@
-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 {};