@contentful/field-editor-rich-text 6.6.6 → 6.6.7-canary.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. package/dist/cjs/__tests__/performance.test.js +190 -0
  2. package/dist/cjs/internal/pluginAdapter.js +2 -0
  3. package/dist/cjs/plugins/EmbeddedEntityBlock/LinkedEntityBlock.js +1 -1
  4. package/dist/cjs/plugins/EmbeddedEntityInline/LinkedEntityInline.js +1 -1
  5. package/dist/cjs/plugins/EmbeddedResourceBlock/LinkedResourceBlock.js +1 -1
  6. package/dist/cjs/plugins/EmbeddedResourceInline/LinkedResourceInline.js +1 -1
  7. package/dist/cjs/plugins/Hyperlink/components/EntityHyperlink.js +2 -2
  8. package/dist/cjs/plugins/Hyperlink/components/ResourceHyperlink.js +2 -2
  9. package/dist/cjs/plugins/Hyperlink/components/UrlHyperlink.js +2 -2
  10. package/dist/cjs/plugins/Hyperlink/components/linkHandlers.js +4 -2
  11. package/dist/cjs/plugins/Hyperlink/components/useHyperlinkCommon.js +9 -5
  12. package/dist/esm/__tests__/performance.test.js +145 -0
  13. package/dist/esm/internal/pluginAdapter.js +2 -0
  14. package/dist/esm/plugins/EmbeddedEntityBlock/LinkedEntityBlock.js +2 -2
  15. package/dist/esm/plugins/EmbeddedEntityInline/LinkedEntityInline.js +2 -2
  16. package/dist/esm/plugins/EmbeddedResourceBlock/LinkedResourceBlock.js +2 -2
  17. package/dist/esm/plugins/EmbeddedResourceInline/LinkedResourceInline.js +2 -2
  18. package/dist/esm/plugins/Hyperlink/components/EntityHyperlink.js +2 -2
  19. package/dist/esm/plugins/Hyperlink/components/ResourceHyperlink.js +2 -2
  20. package/dist/esm/plugins/Hyperlink/components/UrlHyperlink.js +2 -2
  21. package/dist/esm/plugins/Hyperlink/components/linkHandlers.js +4 -2
  22. package/dist/esm/plugins/Hyperlink/components/useHyperlinkCommon.js +10 -6
  23. package/dist/types/__tests__/performance.test.d.ts +1 -0
  24. package/dist/types/plugins/Hyperlink/components/linkHandlers.d.ts +2 -2
  25. package/dist/types/plugins/Hyperlink/components/useHyperlinkCommon.d.ts +18 -3
  26. package/package.json +2 -2
@@ -0,0 +1,190 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", {
3
+ value: true
4
+ });
5
+ const _react = /*#__PURE__*/ _interop_require_wildcard(require("react"));
6
+ const _richtexttypes = require("@contentful/rich-text-types");
7
+ const _react1 = require("@testing-library/react");
8
+ const _vitest = require("vitest");
9
+ const _FakeSdk = require("../__fixtures__/FakeSdk");
10
+ const _fixtures = require("../__fixtures__/fixtures");
11
+ const _toSlateDoc = require("../helpers/toSlateDoc");
12
+ const _testutils = require("../test-utils");
13
+ function _getRequireWildcardCache(nodeInterop) {
14
+ if (typeof WeakMap !== "function") return null;
15
+ var cacheBabelInterop = new WeakMap();
16
+ var cacheNodeInterop = new WeakMap();
17
+ return (_getRequireWildcardCache = function(nodeInterop) {
18
+ return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
19
+ })(nodeInterop);
20
+ }
21
+ function _interop_require_wildcard(obj, nodeInterop) {
22
+ if (!nodeInterop && obj && obj.__esModule) {
23
+ return obj;
24
+ }
25
+ if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
26
+ return {
27
+ default: obj
28
+ };
29
+ }
30
+ var cache = _getRequireWildcardCache(nodeInterop);
31
+ if (cache && cache.has(obj)) {
32
+ return cache.get(obj);
33
+ }
34
+ var newObj = {
35
+ __proto__: null
36
+ };
37
+ var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
38
+ for(var key in obj){
39
+ if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
40
+ var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
41
+ if (desc && (desc.get || desc.set)) {
42
+ Object.defineProperty(newObj, key, desc);
43
+ } else {
44
+ newObj[key] = obj[key];
45
+ }
46
+ }
47
+ }
48
+ newObj.default = obj;
49
+ if (cache) {
50
+ cache.set(obj, newObj);
51
+ }
52
+ return newObj;
53
+ }
54
+ let editor;
55
+ _vitest.vi.mock('../internal/pluginAdapter', async (importOriginal)=>{
56
+ const mod = await importOriginal();
57
+ return {
58
+ ...mod,
59
+ createPlateEditor: (options)=>editor = mod.createPlateEditor(options)
60
+ };
61
+ });
62
+ const { ConnectedRichTextEditor } = await Promise.resolve().then(()=>/*#__PURE__*/ _interop_require_wildcard(require("../RichTextEditor")));
63
+ const PERF = !!process.env.PERF;
64
+ const BLOCK_COUNT = PERF ? 300 : 50;
65
+ const KEYSTROKES = PERF ? 100 : 10;
66
+ const text = (value)=>({
67
+ nodeType: 'text',
68
+ value,
69
+ marks: [],
70
+ data: {}
71
+ });
72
+ const node = (nodeType, data, content = [])=>({
73
+ nodeType,
74
+ data,
75
+ content
76
+ });
77
+ const entry = {
78
+ target: {
79
+ sys: {
80
+ id: _fixtures.entries.published.sys.id,
81
+ type: 'Link',
82
+ linkType: 'Entry'
83
+ }
84
+ }
85
+ };
86
+ const resource = {
87
+ target: {
88
+ sys: {
89
+ urn: _fixtures.resources.published.sys.urn,
90
+ type: 'ResourceLink',
91
+ linkType: 'Contentful:Entry'
92
+ }
93
+ }
94
+ };
95
+ const makeDoc = (n)=>node(_richtexttypes.BLOCKS.DOCUMENT, {}, Array.from({
96
+ length: n
97
+ }, (_, i)=>{
98
+ if (i % 10 === 3) return node(_richtexttypes.BLOCKS.EMBEDDED_ENTRY, entry);
99
+ if (i % 10 === 7) return node(_richtexttypes.BLOCKS.EMBEDDED_RESOURCE, resource);
100
+ const inline = i % 4 === 1 ? [
101
+ node(_richtexttypes.INLINES.EMBEDDED_ENTRY, entry),
102
+ text('')
103
+ ] : i % 4 === 3 ? [
104
+ node(_richtexttypes.INLINES.EMBEDDED_RESOURCE, resource),
105
+ text('')
106
+ ] : [];
107
+ return node(_richtexttypes.BLOCKS.PARAGRAPH, {}, [
108
+ text(`Paragraph ${i} `),
109
+ node(_richtexttypes.INLINES.HYPERLINK, {
110
+ uri: 'https://example.com'
111
+ }, [
112
+ text('a link')
113
+ ]),
114
+ text(' trailing text.'),
115
+ ...inline
116
+ ]);
117
+ }));
118
+ const report = (msg)=>{
119
+ if (PERF) console.log(`[perf] ${msg}`);
120
+ };
121
+ (0, _vitest.describe)('rich text performance', ()=>{
122
+ (0, _vitest.it)('typing only re-renders what changed', async ()=>{
123
+ const [baseSdk] = (0, _FakeSdk.newReferenceEditorFakeSdk)();
124
+ const sdk = {
125
+ ...baseSdk,
126
+ entry: {
127
+ getSys: ()=>({
128
+ id: 'perf-entry'
129
+ })
130
+ },
131
+ locales: {
132
+ ...baseSdk.locales,
133
+ direction: {}
134
+ },
135
+ access: {
136
+ can: async ()=>true
137
+ },
138
+ parameters: {
139
+ instance: {}
140
+ }
141
+ };
142
+ let commits = 0;
143
+ const { container } = (0, _react1.render)(/*#__PURE__*/ _react.createElement(_react.Profiler, {
144
+ id: "rte",
145
+ onRender: ()=>commits++
146
+ }, /*#__PURE__*/ _react.createElement(ConnectedRichTextEditor, {
147
+ sdk: sdk,
148
+ value: makeDoc(BLOCK_COUNT)
149
+ })));
150
+ await (0, _react1.act)(async ()=>{
151
+ await new Promise((resolve)=>setTimeout(resolve, 50));
152
+ });
153
+ commits = 0;
154
+ const start = performance.now();
155
+ for(let i = 0; i < KEYSTROKES; i++){
156
+ await (0, _react1.act)(async ()=>{
157
+ editor.tf.insertText('x', {
158
+ at: {
159
+ path: [
160
+ 0,
161
+ 0
162
+ ],
163
+ offset: 3
164
+ }
165
+ });
166
+ });
167
+ }
168
+ report(`${((performance.now() - start) / KEYSTROKES).toFixed(2)}ms/keystroke, ` + `${commits / KEYSTROKES} commits/keystroke`);
169
+ (0, _vitest.expect)(container.textContent).toContain(`Par${'x'.repeat(KEYSTROKES)}agraph 0`);
170
+ (0, _vitest.expect)(commits / KEYSTROKES).toBeLessThanOrEqual(18);
171
+ }, 120000);
172
+ (0, _vitest.it)('normalizing does not resolve unregistered plugins', ()=>{
173
+ const { editor } = (0, _testutils.createTestEditor)({});
174
+ editor.children = (0, _toSlateDoc.toSlateDoc)(makeDoc(BLOCK_COUNT));
175
+ const { getPlugin } = editor;
176
+ const unregistered = new Set();
177
+ editor.getPlugin = (plugin)=>{
178
+ if (!editor.plugins[plugin.key]) unregistered.add(plugin.key);
179
+ return getPlugin(plugin);
180
+ };
181
+ const start = performance.now();
182
+ editor.tf.normalize({
183
+ force: true
184
+ });
185
+ report(`normalize: ${(performance.now() - start).toFixed(0)}ms`);
186
+ (0, _vitest.expect)([
187
+ ...unregistered
188
+ ]).toEqual([]);
189
+ });
190
+ });
@@ -146,6 +146,8 @@ const createPlateEditor = (options = {})=>{
146
146
  priority: 10000,
147
147
  extendEditor: ({ editor })=>{
148
148
  editor.contentfulPlugins = descriptors;
149
+ const { getType } = editor;
150
+ editor.getType = (key)=>editor.plugins[key] ? getType(key) : key;
149
151
  return editor;
150
152
  }
151
153
  });
@@ -63,7 +63,7 @@ function LinkedEntityBlock(props) {
63
63
  const { attributes, children, element } = props;
64
64
  const { onEntityFetchComplete } = (0, _linkstracking.useLinkTracking)();
65
65
  const isSelected = (0, _react1.useSelected)();
66
- const editor = (0, _ContentfulEditorProvider.useContentfulEditor)();
66
+ const editor = (0, _ContentfulEditorProvider.useContentfulEditorRef)();
67
67
  const sdk = (0, _SdkProvider.useSdkContext)();
68
68
  const isDisabled = (0, _react1.useReadOnly)();
69
69
  const { id: entityId, linkType: entityType } = element.data.target.sys;
@@ -63,7 +63,7 @@ function LinkedEntityInline(props) {
63
63
  const { attributes, children, element } = props;
64
64
  const { onEntityFetchComplete } = (0, _linkstracking.useLinkTracking)();
65
65
  const isSelected = (0, _react1.useSelected)();
66
- const editor = (0, _ContentfulEditorProvider.useContentfulEditor)();
66
+ const editor = (0, _ContentfulEditorProvider.useContentfulEditorRef)();
67
67
  const sdk = (0, _SdkProvider.useSdkContext)();
68
68
  const isDisabled = (0, _react1.useReadOnly)();
69
69
  const { id: entryId } = element.data.target.sys;
@@ -25,7 +25,7 @@ function LinkedResourceBlock(props) {
25
25
  const { attributes, children, element } = props;
26
26
  const { onEntityFetchComplete } = (0, _linkstracking.useLinkTracking)();
27
27
  const isSelected = (0, _react1.useSelected)();
28
- const editor = (0, _ContentfulEditorProvider.useContentfulEditor)();
28
+ const editor = (0, _ContentfulEditorProvider.useContentfulEditorRef)();
29
29
  const sdk = (0, _SdkProvider.useSdkContext)();
30
30
  const isDisabled = (0, _react1.useReadOnly)();
31
31
  const link = element.data.target.sys;
@@ -25,7 +25,7 @@ function LinkedResourceInline(props) {
25
25
  const { attributes, children, element } = props;
26
26
  const { onEntityFetchComplete } = (0, _linkstracking.useLinkTracking)();
27
27
  const isSelected = (0, _react1.useSelected)();
28
- const editor = (0, _ContentfulEditorProvider.useContentfulEditor)();
28
+ const editor = (0, _ContentfulEditorProvider.useContentfulEditorRef)();
29
29
  const sdk = (0, _SdkProvider.useSdkContext)();
30
30
  const isDisabled = (0, _react1.useReadOnly)();
31
31
  const link = element.data.target.sys;
@@ -58,7 +58,7 @@ function _interop_require_wildcard(obj, nodeInterop) {
58
58
  return newObj;
59
59
  }
60
60
  function EntityHyperlink(props) {
61
- const { editor, sdk, isLinkFocused, pathToElement, isEditorFocused } = (0, _useHyperlinkCommon.useHyperlinkCommon)(props.element);
61
+ const { editor, sdk, isLinkFocused, isEditorFocused } = (0, _useHyperlinkCommon.useHyperlinkCommon)(props.element);
62
62
  const { onEntityFetchComplete } = (0, _linkstracking.useLinkTracking)();
63
63
  const { target } = props.element.data;
64
64
  const tooltipContent = (0, _useEntityInfo.useEntityInfo)({
@@ -86,7 +86,7 @@ function EntityHyperlink(props) {
86
86
  }, tooltipContent);
87
87
  return /*#__PURE__*/ _react.createElement(_LinkPopover.LinkPopover, {
88
88
  isLinkFocused: isLinkFocused,
89
- handleEditLink: ()=>(0, _linkHandlers.handleEditLink)(editor, sdk, pathToElement),
89
+ handleEditLink: ()=>(0, _linkHandlers.handleEditLink)(editor, sdk, props.element),
90
90
  handleRemoveLink: ()=>(0, _linkHandlers.handleRemoveLink)(editor),
91
91
  popoverText: popoverText,
92
92
  isEditorFocused: isEditorFocused
@@ -58,7 +58,7 @@ function _interop_require_wildcard(obj, nodeInterop) {
58
58
  return newObj;
59
59
  }
60
60
  function ResourceHyperlink(props) {
61
- const { editor, sdk, isLinkFocused, pathToElement, isEditorFocused } = (0, _useHyperlinkCommon.useHyperlinkCommon)(props.element);
61
+ const { editor, sdk, isLinkFocused, isEditorFocused } = (0, _useHyperlinkCommon.useHyperlinkCommon)(props.element);
62
62
  const { onEntityFetchComplete } = (0, _linkstracking.useLinkTracking)();
63
63
  const { target } = props.element.data;
64
64
  const tooltipContent = (0, _useResourceEntityInfo.useResourceEntityInfo)({
@@ -75,7 +75,7 @@ function ResourceHyperlink(props) {
75
75
  }, tooltipContent);
76
76
  return /*#__PURE__*/ _react.createElement(_LinkPopover.LinkPopover, {
77
77
  isLinkFocused: isLinkFocused,
78
- handleEditLink: ()=>(0, _linkHandlers.handleEditLink)(editor, sdk, pathToElement),
78
+ handleEditLink: ()=>(0, _linkHandlers.handleEditLink)(editor, sdk, props.element),
79
79
  handleRemoveLink: ()=>(0, _linkHandlers.handleRemoveLink)(editor),
80
80
  popoverText: popoverText,
81
81
  isEditorFocused: isEditorFocused
@@ -56,7 +56,7 @@ function _interop_require_wildcard(obj, nodeInterop) {
56
56
  return newObj;
57
57
  }
58
58
  function UrlHyperlink(props) {
59
- const { editor, sdk, isLinkFocused, pathToElement, isEditorFocused } = (0, _useHyperlinkCommon.useHyperlinkCommon)(props.element);
59
+ const { editor, sdk, isLinkFocused, isEditorFocused } = (0, _useHyperlinkCommon.useHyperlinkCommon)(props.element);
60
60
  const uri = props.element.data?.uri;
61
61
  const popoverText = /*#__PURE__*/ _react.createElement(_f36components.TextLink, {
62
62
  className: _styles.styles.openLink,
@@ -66,7 +66,7 @@ function UrlHyperlink(props) {
66
66
  }, uri);
67
67
  return /*#__PURE__*/ _react.createElement(_LinkPopover.LinkPopover, {
68
68
  isLinkFocused: isLinkFocused,
69
- handleEditLink: ()=>(0, _linkHandlers.handleEditLink)(editor, sdk, pathToElement),
69
+ handleEditLink: ()=>(0, _linkHandlers.handleEditLink)(editor, sdk, props.element),
70
70
  handleRemoveLink: ()=>(0, _linkHandlers.handleRemoveLink)(editor),
71
71
  handleCopyLink: ()=>(0, _linkHandlers.handleCopyLink)(uri),
72
72
  popoverText: popoverText,
@@ -21,9 +21,11 @@ _export(exports, {
21
21
  });
22
22
  const _f36components = require("@contentful/f36-components");
23
23
  const _editor = require("../../../helpers/editor");
24
+ const _queries = require("../../../internal/queries");
24
25
  const _HyperlinkModal = require("../HyperlinkModal");
25
- const handleEditLink = (editor, sdk, pathToElement)=>{
26
- if (!editor || !pathToElement) return;
26
+ const handleEditLink = (editor, sdk, element)=>{
27
+ const pathToElement = editor && (0, _queries.findNodePath)(editor, element);
28
+ if (!pathToElement) return;
27
29
  (0, _HyperlinkModal.addOrEditLink)(editor, sdk, editor.tracking.onViewportAction, pathToElement);
28
30
  };
29
31
  const handleRemoveLink = (editor)=>{
@@ -9,15 +9,20 @@ Object.defineProperty(exports, "useHyperlinkCommon", {
9
9
  }
10
10
  });
11
11
  const _react = require("react");
12
+ const _react1 = require("platejs/react");
12
13
  const _ContentfulEditorProvider = require("../../../ContentfulEditorProvider");
13
14
  const _queries = require("../../../internal/queries");
14
15
  const _SdkProvider = require("../../../SdkProvider");
15
16
  function useHyperlinkCommon(element) {
16
- const editor = (0, _ContentfulEditorProvider.useContentfulEditor)();
17
+ const editor = (0, _ContentfulEditorProvider.useContentfulEditorRef)();
17
18
  const sdk = (0, _SdkProvider.useSdkContext)();
18
- const focus = editor.selection?.focus;
19
- const pathToElement = (0, _queries.findNodePath)(editor, element);
20
- const isLinkFocused = pathToElement && focus && (0, _queries.isChildPath)(focus.path, pathToElement);
19
+ const isLinkFocused = (0, _react1.useEditorSelector)((editor)=>{
20
+ const focus = editor.selection?.focus;
21
+ const pathToElement = focus && (0, _queries.findNodePath)(editor, element);
22
+ return !!pathToElement && (0, _queries.isChildPath)(focus.path, pathToElement);
23
+ }, [
24
+ element
25
+ ]);
21
26
  const [isEditorFocused, setIsEditorFocused] = (0, _react.useState)(false);
22
27
  (0, _react.useEffect)(()=>{
23
28
  const handleFocus = ()=>setIsEditorFocused(true);
@@ -41,7 +46,6 @@ function useHyperlinkCommon(element) {
41
46
  editor,
42
47
  sdk,
43
48
  isLinkFocused,
44
- pathToElement,
45
49
  isEditorFocused
46
50
  };
47
51
  }
@@ -0,0 +1,145 @@
1
+ import * as React from 'react';
2
+ import { BLOCKS, INLINES } from '@contentful/rich-text-types';
3
+ import { act, render } from '@testing-library/react';
4
+ import { describe, expect, it, vi } from 'vitest';
5
+ import { newReferenceEditorFakeSdk } from '../__fixtures__/FakeSdk';
6
+ import { entries, resources } from '../__fixtures__/fixtures';
7
+ import { toSlateDoc } from '../helpers/toSlateDoc';
8
+ import { createTestEditor } from '../test-utils';
9
+ let editor;
10
+ vi.mock('../internal/pluginAdapter', async (importOriginal)=>{
11
+ const mod = await importOriginal();
12
+ return {
13
+ ...mod,
14
+ createPlateEditor: (options)=>editor = mod.createPlateEditor(options)
15
+ };
16
+ });
17
+ const { ConnectedRichTextEditor } = await import('../RichTextEditor');
18
+ const PERF = !!process.env.PERF;
19
+ const BLOCK_COUNT = PERF ? 300 : 50;
20
+ const KEYSTROKES = PERF ? 100 : 10;
21
+ const text = (value)=>({
22
+ nodeType: 'text',
23
+ value,
24
+ marks: [],
25
+ data: {}
26
+ });
27
+ const node = (nodeType, data, content = [])=>({
28
+ nodeType,
29
+ data,
30
+ content
31
+ });
32
+ const entry = {
33
+ target: {
34
+ sys: {
35
+ id: entries.published.sys.id,
36
+ type: 'Link',
37
+ linkType: 'Entry'
38
+ }
39
+ }
40
+ };
41
+ const resource = {
42
+ target: {
43
+ sys: {
44
+ urn: resources.published.sys.urn,
45
+ type: 'ResourceLink',
46
+ linkType: 'Contentful:Entry'
47
+ }
48
+ }
49
+ };
50
+ const makeDoc = (n)=>node(BLOCKS.DOCUMENT, {}, Array.from({
51
+ length: n
52
+ }, (_, i)=>{
53
+ if (i % 10 === 3) return node(BLOCKS.EMBEDDED_ENTRY, entry);
54
+ if (i % 10 === 7) return node(BLOCKS.EMBEDDED_RESOURCE, resource);
55
+ const inline = i % 4 === 1 ? [
56
+ node(INLINES.EMBEDDED_ENTRY, entry),
57
+ text('')
58
+ ] : i % 4 === 3 ? [
59
+ node(INLINES.EMBEDDED_RESOURCE, resource),
60
+ text('')
61
+ ] : [];
62
+ return node(BLOCKS.PARAGRAPH, {}, [
63
+ text(`Paragraph ${i} `),
64
+ node(INLINES.HYPERLINK, {
65
+ uri: 'https://example.com'
66
+ }, [
67
+ text('a link')
68
+ ]),
69
+ text(' trailing text.'),
70
+ ...inline
71
+ ]);
72
+ }));
73
+ const report = (msg)=>{
74
+ if (PERF) console.log(`[perf] ${msg}`);
75
+ };
76
+ describe('rich text performance', ()=>{
77
+ it('typing only re-renders what changed', async ()=>{
78
+ const [baseSdk] = newReferenceEditorFakeSdk();
79
+ const sdk = {
80
+ ...baseSdk,
81
+ entry: {
82
+ getSys: ()=>({
83
+ id: 'perf-entry'
84
+ })
85
+ },
86
+ locales: {
87
+ ...baseSdk.locales,
88
+ direction: {}
89
+ },
90
+ access: {
91
+ can: async ()=>true
92
+ },
93
+ parameters: {
94
+ instance: {}
95
+ }
96
+ };
97
+ let commits = 0;
98
+ const { container } = render(/*#__PURE__*/ React.createElement(React.Profiler, {
99
+ id: "rte",
100
+ onRender: ()=>commits++
101
+ }, /*#__PURE__*/ React.createElement(ConnectedRichTextEditor, {
102
+ sdk: sdk,
103
+ value: makeDoc(BLOCK_COUNT)
104
+ })));
105
+ await act(async ()=>{
106
+ await new Promise((resolve)=>setTimeout(resolve, 50));
107
+ });
108
+ commits = 0;
109
+ const start = performance.now();
110
+ for(let i = 0; i < KEYSTROKES; i++){
111
+ await act(async ()=>{
112
+ editor.tf.insertText('x', {
113
+ at: {
114
+ path: [
115
+ 0,
116
+ 0
117
+ ],
118
+ offset: 3
119
+ }
120
+ });
121
+ });
122
+ }
123
+ report(`${((performance.now() - start) / KEYSTROKES).toFixed(2)}ms/keystroke, ` + `${commits / KEYSTROKES} commits/keystroke`);
124
+ expect(container.textContent).toContain(`Par${'x'.repeat(KEYSTROKES)}agraph 0`);
125
+ expect(commits / KEYSTROKES).toBeLessThanOrEqual(18);
126
+ }, 120000);
127
+ it('normalizing does not resolve unregistered plugins', ()=>{
128
+ const { editor } = createTestEditor({});
129
+ editor.children = toSlateDoc(makeDoc(BLOCK_COUNT));
130
+ const { getPlugin } = editor;
131
+ const unregistered = new Set();
132
+ editor.getPlugin = (plugin)=>{
133
+ if (!editor.plugins[plugin.key]) unregistered.add(plugin.key);
134
+ return getPlugin(plugin);
135
+ };
136
+ const start = performance.now();
137
+ editor.tf.normalize({
138
+ force: true
139
+ });
140
+ report(`normalize: ${(performance.now() - start).toFixed(0)}ms`);
141
+ expect([
142
+ ...unregistered
143
+ ]).toEqual([]);
144
+ });
145
+ });
@@ -122,6 +122,8 @@ export const createPlateEditor = (options = {})=>{
122
122
  priority: 10000,
123
123
  extendEditor: ({ editor })=>{
124
124
  editor.contentfulPlugins = descriptors;
125
+ const { getType } = editor;
126
+ editor.getType = (key)=>editor.plugins[key] ? getType(key) : key;
125
127
  return editor;
126
128
  }
127
129
  });
@@ -1,6 +1,6 @@
1
1
  import * as React from 'react';
2
2
  import { useReadOnly, useSelected } from 'platejs/react';
3
- import { useContentfulEditor } from '../../ContentfulEditorProvider';
3
+ import { useContentfulEditorRef } from '../../ContentfulEditorProvider';
4
4
  import { findNodePath } from '../../internal/queries';
5
5
  import { removeNodes } from '../../internal/transforms';
6
6
  import { useSdkContext } from '../../SdkProvider';
@@ -12,7 +12,7 @@ export function LinkedEntityBlock(props) {
12
12
  const { attributes, children, element } = props;
13
13
  const { onEntityFetchComplete } = useLinkTracking();
14
14
  const isSelected = useSelected();
15
- const editor = useContentfulEditor();
15
+ const editor = useContentfulEditorRef();
16
16
  const sdk = useSdkContext();
17
17
  const isDisabled = useReadOnly();
18
18
  const { id: entityId, linkType: entityType } = element.data.target.sys;
@@ -1,6 +1,6 @@
1
1
  import * as React from 'react';
2
2
  import { useReadOnly, useSelected } from 'platejs/react';
3
- import { useContentfulEditor } from '../../ContentfulEditorProvider';
3
+ import { useContentfulEditorRef } from '../../ContentfulEditorProvider';
4
4
  import { focus } from '../../helpers/editor';
5
5
  import { findNodePath } from '../../internal/queries';
6
6
  import { removeNodes } from '../../internal/transforms';
@@ -12,7 +12,7 @@ export function LinkedEntityInline(props) {
12
12
  const { attributes, children, element } = props;
13
13
  const { onEntityFetchComplete } = useLinkTracking();
14
14
  const isSelected = useSelected();
15
- const editor = useContentfulEditor();
15
+ const editor = useContentfulEditorRef();
16
16
  const sdk = useSdkContext();
17
17
  const isDisabled = useReadOnly();
18
18
  const { id: entryId } = element.data.target.sys;
@@ -1,6 +1,6 @@
1
1
  import React from 'react';
2
2
  import { useSelected, useReadOnly } from 'platejs/react';
3
- import { useContentfulEditor } from '../../ContentfulEditorProvider';
3
+ import { useContentfulEditorRef } from '../../ContentfulEditorProvider';
4
4
  import { findNodePath, removeNodes } from '../../internal';
5
5
  import { useSdkContext } from '../../SdkProvider';
6
6
  import { useLinkTracking } from '../links-tracking';
@@ -10,7 +10,7 @@ export function LinkedResourceBlock(props) {
10
10
  const { attributes, children, element } = props;
11
11
  const { onEntityFetchComplete } = useLinkTracking();
12
12
  const isSelected = useSelected();
13
- const editor = useContentfulEditor();
13
+ const editor = useContentfulEditorRef();
14
14
  const sdk = useSdkContext();
15
15
  const isDisabled = useReadOnly();
16
16
  const link = element.data.target.sys;
@@ -1,6 +1,6 @@
1
1
  import React from 'react';
2
2
  import { useSelected, useReadOnly } from 'platejs/react';
3
- import { useContentfulEditor } from '../../ContentfulEditorProvider';
3
+ import { useContentfulEditorRef } from '../../ContentfulEditorProvider';
4
4
  import { findNodePath, removeNodes } from '../../internal';
5
5
  import { useSdkContext } from '../../SdkProvider';
6
6
  import { useLinkTracking } from '../links-tracking';
@@ -10,7 +10,7 @@ export function LinkedResourceInline(props) {
10
10
  const { attributes, children, element } = props;
11
11
  const { onEntityFetchComplete } = useLinkTracking();
12
12
  const isSelected = useSelected();
13
- const editor = useContentfulEditor();
13
+ const editor = useContentfulEditorRef();
14
14
  const sdk = useSdkContext();
15
15
  const isDisabled = useReadOnly();
16
16
  const link = element.data.target.sys;
@@ -7,7 +7,7 @@ import { LinkPopover } from './LinkPopover';
7
7
  import { styles } from './styles';
8
8
  import { useHyperlinkCommon } from './useHyperlinkCommon';
9
9
  export function EntityHyperlink(props) {
10
- const { editor, sdk, isLinkFocused, pathToElement, isEditorFocused } = useHyperlinkCommon(props.element);
10
+ const { editor, sdk, isLinkFocused, isEditorFocused } = useHyperlinkCommon(props.element);
11
11
  const { onEntityFetchComplete } = useLinkTracking();
12
12
  const { target } = props.element.data;
13
13
  const tooltipContent = useEntityInfo({
@@ -35,7 +35,7 @@ export function EntityHyperlink(props) {
35
35
  }, tooltipContent);
36
36
  return /*#__PURE__*/ React.createElement(LinkPopover, {
37
37
  isLinkFocused: isLinkFocused,
38
- handleEditLink: ()=>handleEditLink(editor, sdk, pathToElement),
38
+ handleEditLink: ()=>handleEditLink(editor, sdk, props.element),
39
39
  handleRemoveLink: ()=>handleRemoveLink(editor),
40
40
  popoverText: popoverText,
41
41
  isEditorFocused: isEditorFocused
@@ -7,7 +7,7 @@ import { LinkPopover } from './LinkPopover';
7
7
  import { styles } from './styles';
8
8
  import { useHyperlinkCommon } from './useHyperlinkCommon';
9
9
  export function ResourceHyperlink(props) {
10
- const { editor, sdk, isLinkFocused, pathToElement, isEditorFocused } = useHyperlinkCommon(props.element);
10
+ const { editor, sdk, isLinkFocused, isEditorFocused } = useHyperlinkCommon(props.element);
11
11
  const { onEntityFetchComplete } = useLinkTracking();
12
12
  const { target } = props.element.data;
13
13
  const tooltipContent = useResourceEntityInfo({
@@ -24,7 +24,7 @@ export function ResourceHyperlink(props) {
24
24
  }, tooltipContent);
25
25
  return /*#__PURE__*/ React.createElement(LinkPopover, {
26
26
  isLinkFocused: isLinkFocused,
27
- handleEditLink: ()=>handleEditLink(editor, sdk, pathToElement),
27
+ handleEditLink: ()=>handleEditLink(editor, sdk, props.element),
28
28
  handleRemoveLink: ()=>handleRemoveLink(editor),
29
29
  popoverText: popoverText,
30
30
  isEditorFocused: isEditorFocused
@@ -5,7 +5,7 @@ import { LinkPopover } from './LinkPopover';
5
5
  import { styles } from './styles';
6
6
  import { useHyperlinkCommon } from './useHyperlinkCommon';
7
7
  export function UrlHyperlink(props) {
8
- const { editor, sdk, isLinkFocused, pathToElement, isEditorFocused } = useHyperlinkCommon(props.element);
8
+ const { editor, sdk, isLinkFocused, isEditorFocused } = useHyperlinkCommon(props.element);
9
9
  const uri = props.element.data?.uri;
10
10
  const popoverText = /*#__PURE__*/ React.createElement(TextLink, {
11
11
  className: styles.openLink,
@@ -15,7 +15,7 @@ export function UrlHyperlink(props) {
15
15
  }, uri);
16
16
  return /*#__PURE__*/ React.createElement(LinkPopover, {
17
17
  isLinkFocused: isLinkFocused,
18
- handleEditLink: ()=>handleEditLink(editor, sdk, pathToElement),
18
+ handleEditLink: ()=>handleEditLink(editor, sdk, props.element),
19
19
  handleRemoveLink: ()=>handleRemoveLink(editor),
20
20
  handleCopyLink: ()=>handleCopyLink(uri),
21
21
  popoverText: popoverText,
@@ -1,8 +1,10 @@
1
1
  import { Notification } from '@contentful/f36-components';
2
2
  import { unwrapLink } from '../../../helpers/editor';
3
+ import { findNodePath } from '../../../internal/queries';
3
4
  import { addOrEditLink } from '../HyperlinkModal';
4
- export const handleEditLink = (editor, sdk, pathToElement)=>{
5
- if (!editor || !pathToElement) return;
5
+ export const handleEditLink = (editor, sdk, element)=>{
6
+ const pathToElement = editor && findNodePath(editor, element);
7
+ if (!pathToElement) return;
6
8
  addOrEditLink(editor, sdk, editor.tracking.onViewportAction, pathToElement);
7
9
  };
8
10
  export const handleRemoveLink = (editor)=>{
@@ -1,13 +1,18 @@
1
1
  import { useEffect, useState } from 'react';
2
- import { useContentfulEditor } from '../../../ContentfulEditorProvider';
2
+ import { useEditorSelector } from 'platejs/react';
3
+ import { useContentfulEditorRef } from '../../../ContentfulEditorProvider';
3
4
  import { findNodePath, isChildPath } from '../../../internal/queries';
4
5
  import { useSdkContext } from '../../../SdkProvider';
5
6
  export function useHyperlinkCommon(element) {
6
- const editor = useContentfulEditor();
7
+ const editor = useContentfulEditorRef();
7
8
  const sdk = useSdkContext();
8
- const focus = editor.selection?.focus;
9
- const pathToElement = findNodePath(editor, element);
10
- const isLinkFocused = pathToElement && focus && isChildPath(focus.path, pathToElement);
9
+ const isLinkFocused = useEditorSelector((editor)=>{
10
+ const focus = editor.selection?.focus;
11
+ const pathToElement = focus && findNodePath(editor, element);
12
+ return !!pathToElement && isChildPath(focus.path, pathToElement);
13
+ }, [
14
+ element
15
+ ]);
11
16
  const [isEditorFocused, setIsEditorFocused] = useState(false);
12
17
  useEffect(()=>{
13
18
  const handleFocus = ()=>setIsEditorFocused(true);
@@ -31,7 +36,6 @@ export function useHyperlinkCommon(element) {
31
36
  editor,
32
37
  sdk,
33
38
  isLinkFocused,
34
- pathToElement,
35
39
  isEditorFocused
36
40
  };
37
41
  }
@@ -0,0 +1 @@
1
+ export {};
@@ -1,5 +1,5 @@
1
1
  import { FieldAppSDK } from '@contentful/app-sdk';
2
- import { Path, PlateEditor } from '../../../internal/types';
3
- export declare const handleEditLink: (editor: PlateEditor, sdk: FieldAppSDK, pathToElement: Path | undefined) => void;
2
+ import { Element, PlateEditor } from '../../../internal/types';
3
+ export declare const handleEditLink: (editor: PlateEditor, sdk: FieldAppSDK, element: Element) => void;
4
4
  export declare const handleRemoveLink: (editor: PlateEditor) => void;
5
5
  export declare const handleCopyLink: (uri: string | undefined) => Promise<void>;
@@ -1,8 +1,23 @@
1
1
  import { FieldAppSDK } from '@contentful/app-sdk';
2
+ import { PlateEditor } from '../../../internal/types';
2
3
  export declare function useHyperlinkCommon(element: any): {
3
- editor: import("../../../internal").PlateEditor;
4
+ editor: PlateEditor & {
5
+ store: import("jotai-x").ReturnOfUseStoreApi<import("@platejs/core/react").PlateStoreState<import("@platejs/core/react").PlateEditor>, {
6
+ trackedEditor: import("jotai").Atom<{
7
+ editor: any;
8
+ version: number | null;
9
+ }>;
10
+ trackedSelection: import("jotai").Atom<{
11
+ selection: any;
12
+ version: number | null;
13
+ }>;
14
+ trackedValue: import("jotai").Atom<{
15
+ value: any;
16
+ version: number | null;
17
+ }>;
18
+ }>;
19
+ };
4
20
  sdk: FieldAppSDK;
5
- isLinkFocused: boolean | undefined;
6
- pathToElement: import("@platejs/slate").Path | undefined;
21
+ isLinkFocused: boolean;
7
22
  isEditorFocused: boolean;
8
23
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@contentful/field-editor-rich-text",
3
- "version": "6.6.6",
3
+ "version": "6.6.7-canary.3+70435de2",
4
4
  "source": "./src/index.tsx",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",
@@ -96,5 +96,5 @@
96
96
  "prettier --write"
97
97
  ]
98
98
  },
99
- "gitHead": "a28f831af9ca67fe657b523ccae5e827f5ccc820"
99
+ "gitHead": "70435de23371bddccf773724d269a2315eff8757"
100
100
  }