@portabletext/editor 3.1.2 → 3.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "3.1.2",
+  "version": "3.2.0",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",
@@ -75,12 +75,13 @@
     "xstate": "^5.24.0",
     "@portabletext/block-tools": "^4.1.4",
     "@portabletext/keyboard-shortcuts": "^2.1.0",
+    "@portabletext/markdown": "^1.0.1",
     "@portabletext/patches": "^2.0.0",
     "@portabletext/schema": "^2.0.0"
   },
   "devDependencies": {
     "@sanity/diff-match-patch": "^3.2.0",
-    "@sanity/pkg-utils": "^9.0.3",
+    "@sanity/pkg-utils": "^10.0.0",
     "@sanity/schema": "^4.20.0",
     "@sanity/types": "^4.20.0",
     "@types/debug": "^4.1.12",

package/src/behaviors/behavior.abstract.deserialize.ts

@@ -35,6 +35,18 @@ export const abstractDeserializeBehaviors = [
         } as const
       }
 
+      const markdown =
+        event.originEvent.originEvent.dataTransfer.getData('text/markdown')
+
+      if (markdown) {
+        return {
+          type: 'deserialize.data',
+          mimeType: 'text/markdown',
+          data: markdown,
+          originEvent: event.originEvent,
+        } as const
+      }
+
       const html =
         event.originEvent.originEvent.dataTransfer.getData('text/html')
 
@@ -199,6 +211,20 @@ export const abstractDeserializeBehaviors = [
       }
 
       if (event.mimeType === 'application/json') {
+        const markdown =
+          event.originEvent.originEvent.dataTransfer.getData('text/markdown')
+
+        if (markdown) {
+          return {
+            type: 'deserialize.data',
+            mimeType: 'text/markdown',
+            data: markdown,
+            originEvent: event.originEvent,
+          } as const
+        }
+      }
+
+      if (event.mimeType === 'text/markdown') {
         const html =
           event.originEvent.originEvent.dataTransfer.getData('text/html')
 

package/src/behaviors/behavior.abstract.serialize.ts

@@ -16,6 +16,11 @@ export const abstractSerializeBehaviors = [
           mimeType: 'application/json',
           originEvent: event.originEvent,
         }),
+        raise({
+          type: 'serialize.data',
+          mimeType: 'text/markdown',
+          originEvent: event.originEvent,
+        }),
         raise({
           type: 'serialize.data',
           mimeType: 'text/html',

package/src/behaviors/behavior.types.behavior.ts

@@ -19,8 +19,8 @@ export type Behavior<
     | `${BehaviorEventTypeNamespace}.*`
     | BehaviorEvent['type'],
   TGuardResponse = true,
-  TBehaviorEvent extends
-    ResolveBehaviorEvent<TBehaviorEventType> = ResolveBehaviorEvent<TBehaviorEventType>,
+  TBehaviorEvent extends ResolveBehaviorEvent<TBehaviorEventType> =
+    ResolveBehaviorEvent<TBehaviorEventType>,
 > = {
   /**
    * Editor Event that triggers this Behavior.
@@ -74,10 +74,8 @@ export function defineBehavior<
     | `${BehaviorEventTypeNamespace}.*`
     | BehaviorEvent['type'] = BehaviorEvent['type'],
   TGuardResponse = true,
-  TBehaviorEvent extends ResolveBehaviorEvent<
-    TBehaviorEventType,
-    TPayload
-  > = ResolveBehaviorEvent<TBehaviorEventType, TPayload>,
+  TBehaviorEvent extends ResolveBehaviorEvent<TBehaviorEventType, TPayload> =
+    ResolveBehaviorEvent<TBehaviorEventType, TPayload>,
 >(
   behavior: Behavior<TBehaviorEventType, TGuardResponse, TBehaviorEvent>,
 ): Behavior {

package/src/behaviors/behavior.types.event.ts

@@ -625,10 +625,8 @@ type CustomBehaviorEventType<
 export type CustomBehaviorEvent<
   TPayload extends Record<string, unknown> = Record<string, unknown>,
   TType extends string = string,
-  TInternalType extends CustomBehaviorEventType<
-    'custom',
-    TType
-  > = CustomBehaviorEventType<'custom', TType>,
+  TInternalType extends CustomBehaviorEventType<'custom', TType> =
+    CustomBehaviorEventType<'custom', TType>,
 > = {
   type: TInternalType
 } & TPayload

package/src/converters/converter.text-markdown.ts

@@ -0,0 +1,67 @@
+import {
+  markdownToPortableText,
+  portableTextToMarkdown,
+} from '@portabletext/markdown'
+import {getSelectedValue} from '../selectors/selector.get-selected-value'
+import {parseBlock} from '../utils/parse-blocks'
+import {defineConverter} from './converter.types'
+
+export const converterTextMarkdown = defineConverter({
+  mimeType: 'text/markdown',
+  serialize: ({snapshot, event}) => {
+    const selection = snapshot.context.selection
+
+    if (!selection) {
+      return {
+        type: 'serialization.failure',
+        mimeType: 'text/markdown',
+        reason: 'No selection',
+        originEvent: event.originEvent,
+      }
+    }
+
+    const blocks = getSelectedValue(snapshot)
+
+    const markdown = portableTextToMarkdown(blocks)
+
+    return {
+      type: 'serialization.success',
+      data: markdown,
+      mimeType: 'text/markdown',
+      originEvent: event.originEvent,
+    }
+  },
+  deserialize: ({snapshot, event}) => {
+    const blocks = markdownToPortableText(event.data, {
+      keyGenerator: snapshot.context.keyGenerator,
+      schema: snapshot.context.schema,
+    })
+
+    const parsedBlocks = blocks.flatMap((block) => {
+      const parsedBlock = parseBlock({
+        context: snapshot.context,
+        block,
+        options: {
+          normalize: false,
+          removeUnusedMarkDefs: true,
+          validateFields: false,
+        },
+      })
+      return parsedBlock ? [parsedBlock] : []
+    })
+
+    if (parsedBlocks.length === 0) {
+      return {
+        type: 'deserialization.failure',
+        mimeType: 'text/markdown',
+        reason: 'No blocks deserialized',
+      }
+    }
+
+    return {
+      type: 'deserialization.success',
+      data: parsedBlocks,
+      mimeType: 'text/markdown',
+    }
+  },
+})

package/src/converters/converters.core.ts

@@ -2,6 +2,7 @@ import type {PortableTextMemberSchemaTypes} from '../types/editor'
 import {converterJson} from './converter.json'
 import {converterPortableText} from './converter.portable-text'
 import {createConverterTextHtml} from './converter.text-html'
+import {converterTextMarkdown} from './converter.text-markdown'
 import {createConverterTextPlain} from './converter.text-plain'
 
 export function createCoreConverters(
@@ -10,6 +11,7 @@ export function createCoreConverters(
   return [
     converterJson,
     converterPortableText,
+    converterTextMarkdown,
     createConverterTextHtml(legacySchema),
     createConverterTextPlain(legacySchema),
   ]

package/src/types/slate.ts

@@ -11,8 +11,10 @@ export interface VoidElement {
   value: Record<string, unknown>
 }
 
-export interface SlateTextBlock
-  extends Omit<PortableTextTextBlock, 'children'> {
+export interface SlateTextBlock extends Omit<
+  PortableTextTextBlock,
+  'children'
+> {
   children: Descendant[]
 }
 

package/src/utils/util.get-selection-end-point.ts

@@ -5,10 +5,10 @@ import type {EditorSelection, EditorSelectionPoint} from '../types/editor'
  */
 export function getSelectionEndPoint<
   TEditorSelection extends NonNullable<EditorSelection> | null,
-  TEditorSelectionPoint extends
-    EditorSelectionPoint | null = TEditorSelection extends NonNullable<EditorSelection>
-    ? EditorSelectionPoint
-    : null,
+  TEditorSelectionPoint extends EditorSelectionPoint | null =
+    TEditorSelection extends NonNullable<EditorSelection>
+      ? EditorSelectionPoint
+      : null,
 >(selection: TEditorSelection): TEditorSelectionPoint {
   if (!selection) {
     return null as TEditorSelectionPoint

package/src/utils/util.get-selection-start-point.ts

@@ -5,10 +5,10 @@ import type {EditorSelection, EditorSelectionPoint} from '../types/editor'
  */
 export function getSelectionStartPoint<
   TEditorSelection extends NonNullable<EditorSelection> | null,
-  TEditorSelectionPoint extends
-    EditorSelectionPoint | null = TEditorSelection extends NonNullable<EditorSelection>
-    ? EditorSelectionPoint
-    : null,
+  TEditorSelectionPoint extends EditorSelectionPoint | null =
+    TEditorSelection extends NonNullable<EditorSelection>
+      ? EditorSelectionPoint
+      : null,
 >(selection: TEditorSelection): TEditorSelectionPoint {
   if (!selection) {
     return null as TEditorSelectionPoint