@contentful/field-editor-rich-text 3.6.0 → 3.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/field-editor-rich-text",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "source": "./src/index.tsx",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -44,22 +44,22 @@
     "@contentful/f36-icons": "^4.1.1",
     "@contentful/f36-tokens": "^4.0.0",
     "@contentful/f36-utils": "^4.19.0",
-    "@contentful/field-editor-reference": "^5.11.0",
+    "@contentful/field-editor-reference": "^5.12.0",
     "@contentful/field-editor-shared": "^1.3.0",
     "@contentful/rich-text-plain-text-renderer": "^16.0.4",
     "@contentful/rich-text-types": "16.1.0",
     "@popperjs/core": "^2.11.5",
-    "@udecode/plate-basic-marks": "16.8.0",
-    "@udecode/plate-break": "16.8.0",
-    "@udecode/plate-core": "16.8.0",
-    "@udecode/plate-list": "16.8.0",
-    "@udecode/plate-paragraph": "16.8.0",
-    "@udecode/plate-reset-node": "16.8.0",
-    "@udecode/plate-select": "16.8.0",
-    "@udecode/plate-serializer-docx": "16.8.0",
-    "@udecode/plate-serializer-html": "16.8.0",
-    "@udecode/plate-table": "16.8.0",
-    "@udecode/plate-trailing-block": "16.8.0",
+    "@udecode/plate-basic-marks": "18.15.0",
+    "@udecode/plate-break": "18.15.0",
+    "@udecode/plate-core": "18.15.0",
+    "@udecode/plate-list": "18.15.0",
+    "@udecode/plate-paragraph": "18.15.0",
+    "@udecode/plate-reset-node": "18.15.0",
+    "@udecode/plate-select": "18.15.0",
+    "@udecode/plate-serializer-docx": "18.15.0",
+    "@udecode/plate-serializer-html": "18.15.0",
+    "@udecode/plate-table": "18.15.0",
+    "@udecode/plate-trailing-block": "18.15.0",
     "fast-deep-equal": "^3.1.3",
     "is-hotkey": "^0.2.0",
     "is-plain-obj": "^3.0.0",
@@ -80,5 +80,5 @@
     "@udecode/plate-test-utils": "^3.2.0",
     "react": ">=16.14.0"
   },
-  "gitHead": "8d9a4c6609496a27db64f964bdc388a552eae59b"
+  "gitHead": "667723f7f4c7fa168ad233f26e353108851fa4e0"
 }

package/dist/cjs/prepareDocument.js

@@ -1,86 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    hasContent: function() {
-        return hasContent;
-    },
-    setEditorContent: function() {
-        return setEditorContent;
-    },
-    documentToEditorValue: function() {
-        return documentToEditorValue;
-    },
-    normalizeEditorValue: function() {
-        return normalizeEditorValue;
-    }
-});
-const _contentfulslatejsadapter = require("@contentful/contentful-slatejs-adapter");
-const _richtexttypes = require("@contentful/rich-text-types");
-const _Schema = _interop_require_default(require("./constants/Schema"));
-const _sanitizeIncomingSlateDoc = require("./helpers/sanitizeIncomingSlateDoc");
-const _internal = require("./internal");
-const _queries = require("./internal/queries");
-const _transforms = require("./internal/transforms");
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-const hasContent = (doc)=>{
-    return (doc?.content || []).length > 0;
-};
-const setEditorContent = (editor, nodes)=>{
-    (0, _internal.withoutNormalizing)(editor, ()=>{
-        const children = [
-            ...editor.children
-        ];
-        children.forEach((node)=>editor.apply({
-                type: 'remove_node',
-                path: [
-                    0
-                ],
-                node
-            }));
-        if (nodes) {
-            const nodesArray = (0, _queries.isNode)(nodes) ? [
-                nodes
-            ] : nodes;
-            nodesArray.forEach((node, i)=>{
-                editor.apply({
-                    type: 'insert_node',
-                    path: [
-                        i
-                    ],
-                    node
-                });
-            });
-        }
-        const point = (0, _queries.getEndPoint)(editor, []);
-        if (point) {
-            (0, _transforms.select)(editor, point);
-        }
-    });
-};
-const documentToEditorValue = (doc)=>{
-    const slateDoc = (0, _contentfulslatejsadapter.toSlatejsDocument)({
-        document: hasContent(doc) ? doc : _richtexttypes.EMPTY_DOCUMENT,
-        schema: _Schema.default
-    });
-    return (0, _sanitizeIncomingSlateDoc.sanitizeIncomingSlateDoc)(slateDoc);
-};
-const normalizeEditorValue = (value, options)=>{
-    const editor = (0, _internal.createPlateEditor)(options);
-    editor.children = value;
-    (0, _transforms.normalize)(editor, {
-        force: true
-    });
-    return editor.children;
-};

package/dist/cjs/useOnValueChanged.js

@@ -1,58 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "useOnValueChanged", {
-    enumerable: true,
-    get: function() {
-        return useOnValueChanged;
-    }
-});
-const _react = require("react");
-const _contentfulslatejsadapter = require("@contentful/contentful-slatejs-adapter");
-const _platecore = require("@udecode/plate-core");
-const _debounce = _interop_require_default(require("lodash/debounce"));
-const _Schema = _interop_require_default(require("./constants/Schema"));
-const _removeInternalMarks = require("./helpers/removeInternalMarks");
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-const isRelevantOperation = (op)=>{
-    if (op.type === 'set_selection') {
-        return false;
-    }
-    return true;
-};
-const useOnValueChanged = ({ editorId , handler , skip , onSkip  })=>{
-    const onChange = (0, _react.useMemo)(()=>(0, _debounce.default)((document)=>{
-            const contentfulDocument = (0, _contentfulslatejsadapter.toContentfulDocument)({
-                document: document,
-                schema: _Schema.default
-            });
-            const cleanedDocument = (0, _removeInternalMarks.removeInternalMarks)(contentfulDocument);
-            handler?.(cleanedDocument);
-        }, 500), [
-        handler
-    ]);
-    return (0, _react.useCallback)((value)=>{
-        const editor = (0, _platecore.getPlateSelectors)(editorId).editor();
-        if (!editor) {
-            throw new Error('Editor change callback called but editor not defined. Editor id: ' + editorId);
-        }
-        const operations = editor?.operations.filter(isRelevantOperation);
-        if (operations.length > 0) {
-            if (skip) {
-                onSkip?.();
-                return;
-            }
-            onChange(value);
-        }
-    }, [
-        editorId,
-        onChange,
-        skip,
-        onSkip
-    ]);
-};

package/dist/esm/helpers/sanitizeIncomingSlateDoc.js

@@ -1,23 +0,0 @@
-const isTextElement = (node)=>'text' in node;
-export function sanitizeIncomingSlateDoc(nodes = []) {
-    return nodes.map((node)=>{
-        if (isTextElement(node)) {
-            return node;
-        }
-        if (node.children?.length === 0) {
-            return {
-                ...node,
-                children: [
-                    {
-                        text: '',
-                        data: {}
-                    }
-                ]
-            };
-        }
-        return {
-            ...node,
-            children: sanitizeIncomingSlateDoc(node?.children)
-        };
-    });
-}

package/dist/esm/prepareDocument.js

@@ -1,57 +0,0 @@
-import { toSlatejsDocument } from '@contentful/contentful-slatejs-adapter';
-import { EMPTY_DOCUMENT } from '@contentful/rich-text-types';
-import schema from './constants/Schema';
-import { sanitizeIncomingSlateDoc } from './helpers/sanitizeIncomingSlateDoc';
-import { createPlateEditor, withoutNormalizing } from './internal';
-import { getEndPoint, isNode } from './internal/queries';
-import { normalize, select } from './internal/transforms';
-export const hasContent = (doc)=>{
-    return (doc?.content || []).length > 0;
-};
-export const setEditorContent = (editor, nodes)=>{
-    withoutNormalizing(editor, ()=>{
-        const children = [
-            ...editor.children
-        ];
-        children.forEach((node)=>editor.apply({
-                type: 'remove_node',
-                path: [
-                    0
-                ],
-                node
-            }));
-        if (nodes) {
-            const nodesArray = isNode(nodes) ? [
-                nodes
-            ] : nodes;
-            nodesArray.forEach((node, i)=>{
-                editor.apply({
-                    type: 'insert_node',
-                    path: [
-                        i
-                    ],
-                    node
-                });
-            });
-        }
-        const point = getEndPoint(editor, []);
-        if (point) {
-            select(editor, point);
-        }
-    });
-};
-export const documentToEditorValue = (doc)=>{
-    const slateDoc = toSlatejsDocument({
-        document: hasContent(doc) ? doc : EMPTY_DOCUMENT,
-        schema
-    });
-    return sanitizeIncomingSlateDoc(slateDoc);
-};
-export const normalizeEditorValue = (value, options)=>{
-    const editor = createPlateEditor(options);
-    editor.children = value;
-    normalize(editor, {
-        force: true
-    });
-    return editor.children;
-};

package/dist/esm/useOnValueChanged.js

@@ -1,43 +0,0 @@
-import { useCallback, useMemo } from 'react';
-import { toContentfulDocument } from '@contentful/contentful-slatejs-adapter';
-import { getPlateSelectors } from '@udecode/plate-core';
-import debounce from 'lodash/debounce';
-import schema from './constants/Schema';
-import { removeInternalMarks } from './helpers/removeInternalMarks';
-const isRelevantOperation = (op)=>{
-    if (op.type === 'set_selection') {
-        return false;
-    }
-    return true;
-};
-export const useOnValueChanged = ({ editorId , handler , skip , onSkip  })=>{
-    const onChange = useMemo(()=>debounce((document)=>{
-            const contentfulDocument = toContentfulDocument({
-                document: document,
-                schema
-            });
-            const cleanedDocument = removeInternalMarks(contentfulDocument);
-            handler?.(cleanedDocument);
-        }, 500), [
-        handler
-    ]);
-    return useCallback((value)=>{
-        const editor = getPlateSelectors(editorId).editor();
-        if (!editor) {
-            throw new Error('Editor change callback called but editor not defined. Editor id: ' + editorId);
-        }
-        const operations = editor?.operations.filter(isRelevantOperation);
-        if (operations.length > 0) {
-            if (skip) {
-                onSkip?.();
-                return;
-            }
-            onChange(value);
-        }
-    }, [
-        editorId,
-        onChange,
-        skip,
-        onSkip
-    ]);
-};

package/dist/types/helpers/sanitizeIncomingSlateDoc.d.ts

@@ -1,6 +0,0 @@
-import { Node } from '../internal/types';
-/**
- * Ensures all nodes have a child leaf text element. This should be handled by
- * Slate but its behavior has proven to be buggy and unpredictable.
- */
-export declare function sanitizeIncomingSlateDoc(nodes?: Node[]): Node[];

package/dist/types/prepareDocument.d.ts

@@ -1,19 +0,0 @@
-import { Document } from '@contentful/rich-text-types';
-import { CreatePlateEditorOptions } from './internal';
-import { Node, PlateEditor, Value } from './internal/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) => boolean;
-export declare const setEditorContent: (editor: PlateEditor, nodes?: Node[]) => void;
-/**
- * Converts a Contentful rich text document to the corresponding slate editor
- * value
- */
-export declare const documentToEditorValue: (doc?: Document) => Node[];
-export declare const normalizeEditorValue: (value: Value, options?: Omit<CreatePlateEditorOptions, 'id' | 'editor'>) => Value;

package/dist/types/useOnValueChanged.d.ts

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