@portabletext/editor 1.23.0 → 1.25.0

package/src/behaviors/behavior.types.ts

@@ -1,7 +1,13 @@
-import type {KeyedSegment, PortableTextTextBlock} from '@sanity/types'
+import type {
+  KeyedSegment,
+  PortableTextBlock,
+  PortableTextTextBlock,
+} from '@sanity/types'
 import type {TextUnit} from 'slate'
 import type {TextInsertTextOptions} from 'slate/dist/interfaces/transforms/text'
+import type {ConverterEvent} from '../converters/converter'
 import type {EditorContext} from '../editor/editor-snapshot'
+import type {MIMEType} from '../internal-utils/mime-type'
 import type {OmitFromUnion, PickFromUnion} from '../type-utils'
 import type {EditorSelection, PortableTextSlateEditor} from '../types/editor'
 
@@ -22,9 +28,30 @@ export type SyntheticBehaviorEvent =
         name: string
       }
     }
+  | {
+      type: 'annotation.toggle'
+      annotation: {
+        name: string
+        value: {[prop: string]: unknown}
+      }
+    }
   | {
       type: 'blur'
     }
+  | {
+      type: 'data transfer.set'
+      data: string
+      dataTransfer: DataTransfer
+      mimeType: MIMEType
+    }
+  | {
+      type: 'decorator.add'
+      decorator: string
+    }
+  | {
+      type: 'decorator.remove'
+      decorator: string
+    }
   | {
       type: 'decorator.toggle'
       decorator: string
@@ -33,13 +60,26 @@ export type SyntheticBehaviorEvent =
       type: 'delete.backward'
       unit: TextUnit
     }
+  | {
+      type: 'delete.block'
+      blockPath: [KeyedSegment]
+    }
   | {
       type: 'delete.forward'
       unit: TextUnit
     }
+  | {
+      type: 'delete.text'
+      anchor: BlockOffset
+      focus: BlockOffset
+    }
   | {
       type: 'focus'
     }
+  | {
+      type: 'insert.blocks'
+      blocks: Array<PortableTextBlock>
+    }
   | {
       type: 'insert.block object'
       placement: 'auto' | 'after' | 'before'
@@ -61,23 +101,94 @@ export type SyntheticBehaviorEvent =
   | {
       type: 'insert.soft break'
     }
+  | {
+      type: 'insert.span'
+      text: string
+      annotations?: Array<{
+        name: string
+        value: {[prop: string]: unknown}
+      }>
+      decorators?: Array<string>
+    }
   | {
       type: 'insert.text'
       text: string
       options?: TextInsertTextOptions
     }
+  | {
+      type: 'insert.text block'
+      placement: 'auto' | 'after' | 'before'
+      textBlock?: {
+        children?: PortableTextTextBlock['children']
+      }
+    }
+  | {
+      type: 'list item.add'
+      listItem: string
+    }
+  | {
+      type: 'list item.remove'
+      listItem: string
+    }
   | {
       type: 'list item.toggle'
       listItem: string
     }
+  | {
+      type: 'move.block'
+      at: [KeyedSegment]
+      to: [KeyedSegment]
+    }
+  | {
+      type: 'move.block down'
+      at: [KeyedSegment]
+    }
+  | {
+      type: 'move.block up'
+      at: [KeyedSegment]
+    }
   | {
       type: 'select'
       selection: EditorSelection
     }
+  | {
+      type: 'select.previous block'
+    }
+  | {
+      type: 'select.next block'
+    }
+  | {
+      type: 'style.add'
+      style: string
+    }
+  | {
+      type: 'style.remove'
+      style: string
+    }
   | {
       type: 'style.toggle'
       style: string
     }
+  | {
+      type: 'text block.set'
+      at: [KeyedSegment]
+      level?: number
+      listItem?: string
+      style?: string
+    }
+  | {
+      type: 'text block.unset'
+      at: [KeyedSegment]
+      props: Array<'level' | 'listItem' | 'style'>
+    }
+  | (PickFromUnion<
+      ConverterEvent,
+      'type',
+      | 'deserialization.failure'
+      | 'deserialization.success'
+      | 'serialization.failure'
+      | 'serialization.success'
+    > & {dataTransfer: DataTransfer})
 
 /**
  * @beta
@@ -87,6 +198,10 @@ export type NativeBehaviorEvent =
       type: 'copy'
       data: DataTransfer
     }
+  | {
+      type: 'deserialize'
+      dataTransfer: DataTransfer
+    }
   | {
       type: 'key.down'
       keyboardEvent: Pick<
@@ -105,6 +220,11 @@ export type NativeBehaviorEvent =
       type: 'paste'
       data: DataTransfer
     }
+  | {
+      type: 'serialize'
+      originEvent: 'copy' | 'cut' | 'unknown'
+      dataTransfer: DataTransfer
+    }
 
 /**
  * @beta
@@ -132,100 +252,13 @@ export type BehaviorActionIntend =
       type: 'raise'
       event: SyntheticBehaviorEvent | CustomBehaviorEvent
     }
-  | {
-      type: 'annotation.toggle'
-      annotation: {
-        name: string
-        value: {[prop: string]: unknown}
-      }
-    }
-  | {
-      type: 'decorator.add'
-      decorator: string
-    }
-  | {
-      type: 'decorator.remove'
-      decorator: string
-    }
-  | {
-      type: 'insert.span'
-      text: string
-      annotations?: Array<{
-        name: string
-        value: {[prop: string]: unknown}
-      }>
-      decorators?: Array<string>
-    }
-  | {
-      type: 'insert.text block'
-      placement: 'auto' | 'after' | 'before'
-      textBlock?: {
-        children?: PortableTextTextBlock['children']
-      }
-    }
-  | {
-      type: 'list item.add'
-      listItem: string
-    }
-  | {
-      type: 'list item.remove'
-      listItem: string
-    }
-  | {
-      type: 'move.block'
-      at: [KeyedSegment]
-      to: [KeyedSegment]
-    }
-  | {
-      type: 'move.block down'
-      at: [KeyedSegment]
-    }
-  | {
-      type: 'move.block up'
-      at: [KeyedSegment]
-    }
   | {
       type: 'noop'
     }
-  | {
-      type: 'delete.block'
-      blockPath: [KeyedSegment]
-    }
-  | {
-      type: 'delete.text'
-      anchor: BlockOffset
-      focus: BlockOffset
-    }
   | {
       type: 'effect'
       effect: () => void
     }
-  | {
-      type: 'select.previous block'
-    }
-  | {
-      type: 'select.next block'
-    }
-  | {
-      type: 'style.add'
-      style: string
-    }
-  | {
-      type: 'style.remove'
-      style: string
-    }
-  | {
-      type: 'text block.set'
-      at: [KeyedSegment]
-      level?: number
-      listItem?: string
-      style?: string
-    }
-  | {
-      type: 'text block.unset'
-      at: [KeyedSegment]
-      props: Array<'level' | 'listItem' | 'style'>
-    }
 
 /**
  * @beta
@@ -261,7 +294,11 @@ export type BehaviorEvent =
 export type Behavior<
   TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
   TGuardResponse = true,
-  TBehaviorEvent extends BehaviorEvent = BehaviorEvent,
+  TBehaviorEvent extends BehaviorEvent = PickFromUnion<
+    BehaviorEvent,
+    'type',
+    TBehaviorEventType
+  >,
 > = {
   /**
    * The internal editor event that triggers this behavior.

package/src/converters/converter.json.ts

@@ -0,0 +1,53 @@
+import type {Converter} from './converter'
+
+export const converterJson: Converter<'application/json'> = {
+  serialize: ({context, event}) => {
+    const portableTextConverter = context.converters.find(
+      (converter) => converter.mimeType === 'application/x-portable-text',
+    )
+
+    if (!portableTextConverter) {
+      return {
+        type: 'serialization.failure',
+        mimeType: 'application/json',
+        originEvent: event.originEvent,
+        reason: 'No application/x-portable-text Converter found',
+      }
+    }
+
+    const serializationEvent = portableTextConverter.serialize({
+      context,
+      event,
+    })
+
+    return {
+      ...serializationEvent,
+      mimeType: 'application/json',
+      originEvent: event.originEvent,
+    }
+  },
+  deserialize: ({context, event}) => {
+    const portableTextConverter = context.converters.find(
+      (converter) => converter.mimeType === 'application/x-portable-text',
+    )
+
+    if (!portableTextConverter) {
+      return {
+        type: 'deserialization.failure',
+        mimeType: 'application/json',
+        reason: 'No application/x-portable-text Converter found',
+      }
+    }
+
+    const deserializationEvent = portableTextConverter.deserialize({
+      context,
+      event,
+    })
+
+    return {
+      ...deserializationEvent,
+      mimeType: 'application/json',
+    }
+  },
+  mimeType: 'application/json',
+}