@portabletext/editor 2.7.2 → 2.8.1

package/src/internal-utils/parse-blocks.ts

@@ -19,7 +19,6 @@ export function parseBlocks({
   context: Pick<EditorContext, 'keyGenerator' | 'schema'>
   blocks: unknown
   options: {
-    refreshKeys: boolean
     validateFields: boolean
   }
 }): Array<PortableTextBlock> {
@@ -42,7 +41,6 @@ export function parseBlock({
   context: Pick<EditorContext, 'keyGenerator' | 'schema'>
   block: unknown
   options: {
-    refreshKeys: boolean
     validateFields: boolean
   }
 }): PortableTextBlock | undefined {
@@ -59,7 +57,7 @@ export function parseBlockObject({
 }: {
   blockObject: unknown
   context: Pick<EditorContext, 'keyGenerator' | 'schema'>
-  options: {refreshKeys: boolean; validateFields: boolean}
+  options: {validateFields: boolean}
 }): PortableTextObject | undefined {
   if (!isTypedObject(blockObject)) {
     return undefined
@@ -101,7 +99,7 @@ export function parseTextBlock({
 }: {
   block: unknown
   context: Pick<EditorContext, 'keyGenerator' | 'schema'>
-  options: {refreshKeys: boolean; validateFields: boolean}
+  options: {validateFields: boolean}
 }): PortableTextTextBlock | undefined {
   if (!isTypedObject(block)) {
     return undefined
@@ -135,11 +133,8 @@ export function parseTextBlock({
     return undefined
   }
 
-  const _key = options.refreshKeys
-    ? context.keyGenerator()
-    : typeof block._key === 'string'
-      ? block._key
-      : context.keyGenerator()
+  const _key =
+    typeof block._key === 'string' ? block._key : context.keyGenerator()
 
   const unparsedMarkDefs: Array<unknown> = Array.isArray(block.markDefs)
     ? block.markDefs
@@ -193,6 +188,7 @@ export function parseTextBlock({
         parseInlineObject({inlineObject: child, context, options}),
     )
     .filter((child) => child !== undefined)
+  const marks = children.flatMap((child) => child.marks ?? [])
 
   const parsedBlock: PortableTextTextBlock = {
     _type: context.schema.block.name,
@@ -208,7 +204,7 @@ export function parseTextBlock({
               marks: [],
             },
           ],
-    markDefs,
+    markDefs: markDefs.filter((markDef) => marks.includes(markDef._key)),
     ...customFields,
   }
 
@@ -250,7 +246,7 @@ export function parseSpan({
   span: unknown
   context: Pick<EditorContext, 'keyGenerator' | 'schema'>
   markDefKeyMap: Map<string, string>
-  options: {refreshKeys: boolean; validateFields: boolean}
+  options: {validateFields: boolean}
 }): PortableTextSpan | undefined {
   if (!isTypedObject(span)) {
     return undefined
@@ -299,11 +295,7 @@ export function parseSpan({
 
   return {
     _type: 'span',
-    _key: options.refreshKeys
-      ? context.keyGenerator()
-      : typeof span._key === 'string'
-        ? span._key
-        : context.keyGenerator(),
+    _key: typeof span._key === 'string' ? span._key : context.keyGenerator(),
     text: typeof span.text === 'string' ? span.text : '',
     marks,
     ...(options.validateFields ? {} : customFields),
@@ -317,7 +309,7 @@ export function parseInlineObject({
 }: {
   inlineObject: unknown
   context: Pick<EditorContext, 'keyGenerator' | 'schema'>
-  options: {refreshKeys: boolean; validateFields: boolean}
+  options: {validateFields: boolean}
 }): PortableTextObject | undefined {
   if (!isTypedObject(inlineObject)) {
     return undefined
@@ -348,7 +340,7 @@ export function parseAnnotation({
 }: {
   annotation: TypedObject
   context: Pick<EditorContext, 'keyGenerator' | 'schema'>
-  options: {refreshKeys: boolean; validateFields: boolean}
+  options: {validateFields: boolean}
 }): PortableTextObject | undefined {
   if (!isTypedObject(annotation)) {
     return undefined
@@ -381,7 +373,7 @@ function parseObject({
   context: Pick<EditorContext, 'keyGenerator'> & {
     schemaType: EditorSchema['blockObjects'][0]
   }
-  options: {refreshKeys: boolean; validateFields: boolean}
+  options: {validateFields: boolean}
 }): PortableTextObject {
   const {_type, _key, ...customFields} = object
 
@@ -404,11 +396,8 @@ function parseObject({
 
   return {
     _type: context.schemaType.name,
-    _key: options.refreshKeys
-      ? context.keyGenerator()
-      : typeof object._key === 'string'
-        ? object._key
-        : context.keyGenerator(),
+    _key:
+      typeof object._key === 'string' ? object._key : context.keyGenerator(),
     ...values,
   }
 }

package/src/internal-utils/test-editor.tsx

@@ -5,13 +5,16 @@ import {page} from '@vitest/browser/context'
 import React from 'react'
 import {expect, vi} from 'vitest'
 import {render} from 'vitest-browser-react'
+import type {Context} from '../../gherkin-tests-v2/step-context'
+import type {NativeBehaviorEvent} from '../behaviors'
 import type {Editor} from '../editor'
-import {PortableTextEditable} from '../editor/Editable'
+import {
+  PortableTextEditable,
+  type PortableTextEditableProps,
+} from '../editor/Editable'
 import type {EditorActor} from '../editor/editor-machine'
 import {EditorProvider} from '../editor/editor-provider'
-import type {EditorEmittedEvent} from '../editor/relay-machine'
 import {EditorRefPlugin} from '../plugins/plugin.editor-ref'
-import {EventListenerPlugin} from '../plugins/plugin.event-listener'
 import {InternalEditorAfterRefPlugin} from '../plugins/plugin.internal.editor-actor-ref'
 import {InternalSlateEditorRefPlugin} from '../plugins/plugin.internal.slate-editor-ref'
 import type {PortableTextSlateEditor} from '../types/editor'
@@ -22,12 +25,12 @@ export async function createTestEditor(
     keyGenerator?: () => string
     schemaDefinition?: SchemaDefinition
     children?: React.ReactNode
+    editableProps?: PortableTextEditableProps
   } = {},
-) {
+): Promise<Pick<Context, 'editor' | 'locator'>> {
   const editorRef = React.createRef<Editor>()
   const editorActorRef = React.createRef<EditorActor>()
   const slateRef = React.createRef<PortableTextSlateEditor>()
-  const onEvent = vi.fn<() => EditorEmittedEvent>()
   const keyGenerator = options.keyGenerator ?? createTestKeyGenerator()
 
   render(
@@ -41,8 +44,7 @@ export async function createTestEditor(
       <EditorRefPlugin ref={editorRef} />
       <InternalEditorAfterRefPlugin ref={editorActorRef} />
       <InternalSlateEditorRefPlugin ref={slateRef} />
-      <EventListenerPlugin on={onEvent} />
-      <PortableTextEditable />
+      <PortableTextEditable {...options.editableProps} />
       {options.children}
     </EditorProvider>,
   )
@@ -51,27 +53,19 @@ export async function createTestEditor(
 
   await vi.waitFor(() => expect.element(locator).toBeInTheDocument())
 
-  function paste(dataTransfer: DataTransfer) {
+  function sendNativeEvent(event: NativeBehaviorEvent) {
     editorActorRef.current?.send({
       type: 'behavior event',
-      behaviorEvent: {
-        type: 'clipboard.paste',
-        originEvent: {dataTransfer},
-        position: {
-          selection: editorRef.current?.getSnapshot().context.selection!,
-        },
-      },
+      behaviorEvent: event,
       editor: slateRef.current!,
     })
   }
 
   return {
-    editorActorRef,
-    editorRef,
-    keyGenerator,
+    editor: {
+      ...editorRef.current!,
+      sendNativeEvent,
+    },
     locator,
-    onEvent,
-    slateRef,
-    paste,
   }
 }

package/src/operations/behavior.operation.annotation.add.ts

@@ -31,7 +31,7 @@ export const addAnnotationOperationImplementation: BehaviorOperationImplementati
       ...operation.annotation.value,
     },
     context,
-    options: {refreshKeys: false, validateFields: true},
+    options: {validateFields: true},
   })
 
   if (!parsedAnnotation) {
@@ -116,22 +116,11 @@ export const addAnnotationOperationImplementation: BehaviorOperationImplementati
       }
 
       const marks = span.marks ?? []
-      const existingSameTypeAnnotations = marks.filter((mark) =>
-        markDefs.some(
-          (markDef) =>
-            markDef._key === mark && markDef._type === parsedAnnotation._type,
-        ),
-      )
 
       Transforms.setNodes(
         editor,
         {
-          marks: [
-            ...marks.filter(
-              (mark) => !existingSameTypeAnnotations.includes(mark),
-            ),
-            annotationKey,
-          ],
+          marks: [...marks, annotationKey],
         },
         {at: path},
       )

package/src/operations/behavior.operation.block.set.ts

@@ -51,7 +51,7 @@ export const blockSetOperationImplementation: BehaviorOperationImplementation<
       ...parsedBlock,
       ...filteredProps,
     },
-    options: {refreshKeys: false, validateFields: true},
+    options: {validateFields: true},
   })
 
   if (!updatedBlock) {

package/src/operations/behavior.operation.block.unset.ts

@@ -51,7 +51,7 @@ export const blockUnsetOperationImplementation: BehaviorOperationImplementation<
     const updatedTextBlock = parseBlock({
       context,
       block: omit(parsedBlock, propsToRemove),
-      options: {refreshKeys: false, validateFields: true},
+      options: {validateFields: true},
     })
 
     if (!updatedTextBlock) {
@@ -81,7 +81,7 @@ export const blockUnsetOperationImplementation: BehaviorOperationImplementation<
       parsedBlock,
       operation.props.filter((prop) => prop !== '_type'),
     ),
-    options: {refreshKeys: false, validateFields: true},
+    options: {validateFields: true},
   })
 
   if (!updatedBlockObject) {

package/src/operations/behavior.operation.insert.block.ts

@@ -24,7 +24,7 @@ export const insertBlockOperationImplementation: BehaviorOperationImplementation
   const parsedBlock = parseBlock({
     block: operation.block,
     context,
-    options: {refreshKeys: false, validateFields: true},
+    options: {validateFields: true},
   })
 
   if (!parsedBlock) {

package/src/operations/behavior.operations.ts

@@ -18,8 +18,6 @@ import {childSetOperationImplementation} from './behavior.operation.child.set'
 import {childUnsetOperationImplementation} from './behavior.operation.child.unset'
 import {decoratorAddOperationImplementation} from './behavior.operation.decorator.add'
 import {deleteOperationImplementation} from './behavior.operation.delete'
-import {insertInlineObjectOperationImplementation} from './behavior.operation.insert-inline-object'
-import {insertSpanOperationImplementation} from './behavior.operation.insert-span'
 import {insertBlockOperationImplementation} from './behavior.operation.insert.block'
 import {insertTextOperationImplementation} from './behavior.operation.insert.text'
 import {moveBackwardOperationImplementation} from './behavior.operation.move.backward'
@@ -68,8 +66,6 @@ const behaviorOperationImplementations: BehaviorOperationImplementations = {
   'history.redo': historyRedoOperationImplementation,
   'history.undo': historyUndoOperationImplementation,
   'insert.block': insertBlockOperationImplementation,
-  'insert.inline object': insertInlineObjectOperationImplementation,
-  'insert.span': insertSpanOperationImplementation,
   'insert.text': insertTextOperationImplementation,
   'move.backward': moveBackwardOperationImplementation,
   'move.block': moveBlockOperationImplementation,
@@ -170,20 +166,6 @@ export function performOperation({
         })
         break
       }
-      case 'insert.inline object': {
-        behaviorOperationImplementations['insert.inline object']({
-          context,
-          operation: operation,
-        })
-        break
-      }
-      case 'insert.span': {
-        behaviorOperationImplementations['insert.span']({
-          context,
-          operation: operation,
-        })
-        break
-      }
       case 'insert.text': {
         behaviorOperationImplementations['insert.text']({
           context,

package/src/plugins/plugin.internal.auto-close-brackets.test.tsx

@@ -1,117 +1,71 @@
-import {defineSchema} from '@portabletext/schema'
-import {createTestKeyGenerator, getTersePt} from '@portabletext/test'
-import {page, userEvent} from '@vitest/browser/context'
-import React from 'react'
+import {getTersePt} from '@portabletext/test'
+import {userEvent} from '@vitest/browser/context'
 import {describe, expect, test, vi} from 'vitest'
-import {render} from 'vitest-browser-react'
-import {EditorProvider, PortableTextEditable, type Editor} from '..'
-import {EditorRefPlugin} from './plugin.editor-ref'
+import {createTestEditor} from '../internal-utils/test-editor'
 import {AutoCloseBracketsPlugin} from './plugin.internal.auto-close-brackets'
 
 describe(AutoCloseBracketsPlugin.name, () => {
   test('One-character text insertion', async () => {
-    const editorRef = React.createRef<Editor>()
-
-    render(
-      <EditorProvider
-        initialConfig={{
-          keyGenerator: createTestKeyGenerator(),
-          schemaDefinition: defineSchema({}),
-        }}
-      >
-        <EditorRefPlugin ref={editorRef} />
-        <PortableTextEditable />
-        <AutoCloseBracketsPlugin />
-      </EditorProvider>,
-    )
-
-    const locator = page.getByRole('textbox')
-    await vi.waitFor(() => expect.element(locator).toBeInTheDocument())
+    const {editor, locator} = await createTestEditor({
+      children: <AutoCloseBracketsPlugin />,
+    })
+
     await userEvent.click(locator)
 
-    editorRef.current?.send({type: 'insert.text', text: '('})
+    editor.send({type: 'insert.text', text: '('})
 
     await vi.waitFor(() => {
-      expect(getTersePt(editorRef.current!.getSnapshot().context)).toEqual([
-        '()',
-      ])
+      expect(getTersePt(editor.getSnapshot().context)).toEqual(['()'])
     })
 
     await userEvent.type(locator, 'foo')
 
     await vi.waitFor(() => {
-      expect(getTersePt(editorRef.current!.getSnapshot().context)).toEqual([
-        '(foo)',
-      ])
+      expect(getTersePt(editor.getSnapshot().context)).toEqual(['(foo)'])
     })
 
-    editorRef.current?.send({type: 'history.undo'})
+    editor.send({type: 'history.undo'})
 
     await vi.waitFor(() => {
-      expect(getTersePt(editorRef.current!.getSnapshot().context)).toEqual([
-        '()',
-      ])
+      expect(getTersePt(editor.getSnapshot().context)).toEqual(['()'])
     })
 
-    editorRef.current?.send({type: 'history.undo'})
+    editor.send({type: 'history.undo'})
 
     await vi.waitFor(() => {
-      expect(getTersePt(editorRef.current!.getSnapshot().context)).toEqual([
-        '(',
-      ])
+      expect(getTersePt(editor.getSnapshot().context)).toEqual(['('])
     })
   })
 
   test('Two-character text insertion', async () => {
-    const editorRef = React.createRef<Editor>()
-
-    render(
-      <EditorProvider
-        initialConfig={{
-          keyGenerator: createTestKeyGenerator(),
-          schemaDefinition: defineSchema({}),
-        }}
-      >
-        <EditorRefPlugin ref={editorRef} />
-        <PortableTextEditable />
-        <AutoCloseBracketsPlugin />
-      </EditorProvider>,
-    )
-
-    const locator = page.getByRole('textbox')
-    await vi.waitFor(() => expect.element(locator).toBeInTheDocument())
+    const {editor, locator} = await createTestEditor({
+      children: <AutoCloseBracketsPlugin />,
+    })
+
     await userEvent.click(locator)
 
-    editorRef.current?.send({type: 'insert.text', text: '(f'})
+    editor.send({type: 'insert.text', text: '(f'})
 
     await vi.waitFor(() => {
-      expect(getTersePt(editorRef.current!.getSnapshot().context)).toEqual([
-        '(f)',
-      ])
+      expect(getTersePt(editor.getSnapshot().context)).toEqual(['(f)'])
     })
 
     await userEvent.type(locator, 'oo')
 
     await vi.waitFor(() => {
-      expect(getTersePt(editorRef.current!.getSnapshot().context)).toEqual([
-        '(foo)',
-      ])
+      expect(getTersePt(editor.getSnapshot().context)).toEqual(['(foo)'])
     })
 
-    editorRef.current?.send({type: 'history.undo'})
+    editor.send({type: 'history.undo'})
 
     await vi.waitFor(() => {
-      expect(getTersePt(editorRef.current!.getSnapshot().context)).toEqual([
-        '(f)',
-      ])
+      expect(getTersePt(editor.getSnapshot().context)).toEqual(['(f)'])
     })
 
-    editorRef.current?.send({type: 'history.undo'})
+    editor.send({type: 'history.undo'})
 
     await vi.waitFor(() => {
-      expect(getTersePt(editorRef.current!.getSnapshot().context)).toEqual([
-        '(f',
-      ])
+      expect(getTersePt(editor.getSnapshot().context)).toEqual(['(f'])
     })
   })
 })

package/src/plugins/plugin.markdown.test.tsx

@@ -1,58 +1,40 @@
 import {defineSchema} from '@portabletext/schema'
-import {createTestKeyGenerator, getTersePt} from '@portabletext/test'
-import {page, userEvent} from '@vitest/browser/context'
-import React from 'react'
+import {getTersePt} from '@portabletext/test'
+import {userEvent} from '@vitest/browser/context'
 import {describe, expect, test, vi} from 'vitest'
-import {render} from 'vitest-browser-react'
-import {PortableTextEditable, type Editor} from '..'
-import {EditorProvider} from '../editor/editor-provider'
+import {createTestEditor} from '../internal-utils/test-editor'
 import {getTextMarks} from '../internal-utils/text-marks'
-import {EditorRefPlugin} from './plugin.editor-ref'
 import {MarkdownPlugin} from './plugin.markdown'
 
 describe(MarkdownPlugin.name, () => {
   test('Scenario: Undoing bold shortcut', async () => {
-    const editorRef = React.createRef<Editor>()
-
-    render(
-      <EditorProvider
-        initialConfig={{
-          keyGenerator: createTestKeyGenerator(),
-          schemaDefinition: defineSchema({decorators: [{name: 'strong'}]}),
-        }}
-      >
-        <EditorRefPlugin ref={editorRef} />
-        <PortableTextEditable />
+    const {editor, locator} = await createTestEditor({
+      children: (
         <MarkdownPlugin
           config={{
             boldDecorator: () => 'strong',
           }}
         />
-      </EditorProvider>,
-    )
-
-    const locator = page.getByRole('textbox')
-
-    await vi.waitFor(() => expect.element(locator).toBeInTheDocument())
+      ),
+      schemaDefinition: defineSchema({decorators: [{name: 'strong'}]}),
+    })
 
     await userEvent.type(locator, '**Hello world!**')
 
     await vi.waitFor(() => {
-      expect(getTersePt(editorRef.current!.getSnapshot().context)).toEqual([
-        'Hello world!',
-      ])
+      expect(getTersePt(editor.getSnapshot().context)).toEqual(['Hello world!'])
     })
 
     await vi.waitFor(() => {
       expect(
-        getTextMarks(editorRef.current!.getSnapshot().context, 'Hello world!'),
+        getTextMarks(editor.getSnapshot().context, 'Hello world!'),
       ).toEqual(['strong'])
     })
 
-    editorRef.current?.send({type: 'history.undo'})
+    editor.send({type: 'history.undo'})
 
     await vi.waitFor(() => {
-      expect(getTersePt(editorRef.current!.getSnapshot().context)).toEqual([
+      expect(getTersePt(editor.getSnapshot().context)).toEqual([
         '**Hello world!**',
       ])
     })