@portabletext/editor 1.34.0 → 1.35.0

package/src/converters/converter.text-html.serialize.test.ts

@@ -75,14 +75,16 @@ const paragraphWithInlineBlock: PortableTextTextBlock = {
   ],
 }
 
-function createContext(schema: SchemaDefinition, selection: EditorSelection) {
+function createSnapshot(schema: SchemaDefinition, selection: EditorSelection) {
   return {
-    converters: coreConverters,
-    activeDecorators: [],
-    keyGenerator: createTestKeyGenerator(),
-    schema: compileSchemaDefinition(schema),
-    selection,
-    value: [decoratedParagraph, image, b2, paragraphWithInlineBlock],
+    context: {
+      converters: coreConverters,
+      activeDecorators: [],
+      keyGenerator: createTestKeyGenerator(),
+      schema: compileSchemaDefinition(schema),
+      selection,
+      value: [decoratedParagraph, image, b2, paragraphWithInlineBlock],
+    },
   }
 }
 
@@ -90,7 +92,7 @@ describe(converterTextHtml.serialize.name, () => {
   test('paragraph with decorators', () => {
     expect(
       converterTextHtml.serialize({
-        context: createContext(defineSchema({}), {
+        snapshot: createSnapshot(defineSchema({}), {
           anchor: {
             path: [
               {_key: decoratedParagraph._key},
@@ -121,7 +123,7 @@ describe(converterTextHtml.serialize.name, () => {
   test('image', () => {
     expect(
       converterTextHtml.serialize({
-        context: createContext(defineSchema({}), {
+        snapshot: createSnapshot(defineSchema({}), {
           anchor: {
             path: [{_key: image._key}],
             offset: 0,
@@ -144,7 +146,7 @@ describe(converterTextHtml.serialize.name, () => {
   test('inline object', () => {
     expect(
       converterTextHtml.serialize({
-        context: createContext(defineSchema({}), {
+        snapshot: createSnapshot(defineSchema({}), {
           anchor: {
             path: [
               {_key: paragraphWithInlineBlock._key},
@@ -175,49 +177,51 @@ describe(converterTextHtml.serialize.name, () => {
   test('lists', () => {
     expect(
       converterTextHtml.serialize({
-        context: {
-          converters: coreConverters,
-          activeDecorators: [],
-          keyGenerator: createTestKeyGenerator(),
-          schema: compileSchemaDefinition(defineSchema({})),
-          value: [
-            {
-              _key: 'k0',
-              _type: 'block',
-              children: [
-                {
-                  _key: 'k1',
-                  _type: 'span',
-                  marks: [],
-                  text: 'foo',
-                },
-              ],
-              level: 1,
-              listItem: 'number',
-            },
-            {
-              _key: 'k2',
-              _type: 'block',
-              children: [
-                {
-                  _key: 'k3',
-                  _type: 'span',
-                  marks: [],
-                  text: 'bar',
-                },
-              ],
-              level: 2,
-              listItem: 'bullet',
-            },
-          ],
-          selection: {
-            anchor: {
-              path: [{_key: 'k0'}, 'children', {_key: 'k1'}],
-              offset: 0,
-            },
-            focus: {
-              path: [{_key: 'k2'}, 'children', {_key: 'k3'}],
-              offset: 3,
+        snapshot: {
+          context: {
+            converters: coreConverters,
+            activeDecorators: [],
+            keyGenerator: createTestKeyGenerator(),
+            schema: compileSchemaDefinition(defineSchema({})),
+            value: [
+              {
+                _key: 'k0',
+                _type: 'block',
+                children: [
+                  {
+                    _key: 'k1',
+                    _type: 'span',
+                    marks: [],
+                    text: 'foo',
+                  },
+                ],
+                level: 1,
+                listItem: 'number',
+              },
+              {
+                _key: 'k2',
+                _type: 'block',
+                children: [
+                  {
+                    _key: 'k3',
+                    _type: 'span',
+                    marks: [],
+                    text: 'bar',
+                  },
+                ],
+                level: 2,
+                listItem: 'bullet',
+              },
+            ],
+            selection: {
+              anchor: {
+                path: [{_key: 'k0'}, 'children', {_key: 'k1'}],
+                offset: 0,
+              },
+              focus: {
+                path: [{_key: 'k2'}, 'children', {_key: 'k3'}],
+                offset: 3,
+              },
             },
           },
         },

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

@@ -6,8 +6,8 @@ import {defineConverter} from './converter.types'
 
 export const converterTextHtml = defineConverter({
   mimeType: 'text/html',
-  serialize: ({context, event}) => {
-    if (!context.selection) {
+  serialize: ({snapshot, event}) => {
+    if (!snapshot.context.selection) {
       return {
         type: 'serialization.failure',
         mimeType: 'text/html',
@@ -17,8 +17,8 @@ export const converterTextHtml = defineConverter({
     }
 
     const blocks = sliceBlocks({
-      blocks: context.value,
-      selection: context.selection,
+      blocks: snapshot.context.value,
+      selection: snapshot.context.selection,
     })
 
     const html = toHTML(blocks, {
@@ -45,12 +45,16 @@ export const converterTextHtml = defineConverter({
       originEvent: event.originEvent,
     }
   },
-  deserialize: ({context, event}) => {
-    const blocks = htmlToBlocks(event.data, context.schema.portableText, {
-      keyGenerator: context.keyGenerator,
-      unstable_whitespaceOnPasteMode:
-        context.schema.block.options.unstable_whitespaceOnPasteMode,
-    }) as Array<PortableTextBlock>
+  deserialize: ({snapshot, event}) => {
+    const blocks = htmlToBlocks(
+      event.data,
+      snapshot.context.schema.portableText,
+      {
+        keyGenerator: snapshot.context.keyGenerator,
+        unstable_whitespaceOnPasteMode:
+          snapshot.context.schema.block.options.unstable_whitespaceOnPasteMode,
+      },
+    ) as Array<PortableTextBlock>
 
     return {
       type: 'deserialization.success',

package/src/converters/converter.text-plain.test.ts

@@ -5,7 +5,7 @@ import {
   defineSchema,
   type SchemaDefinition,
 } from '../editor/define-schema'
-import type {EditorContext} from '../editor/editor-snapshot'
+import type {EditorSnapshot} from '../editor/editor-snapshot'
 import type {EditorSelection} from '../utils'
 import {converterTextPlain} from './converter.text-plain'
 import {coreConverters} from './converters.core'
@@ -65,27 +65,29 @@ const b4: PortableTextTextBlock = {
   ],
 }
 
-function createContext({
+function createSnapshot({
   schema,
   selection,
 }: {
   schema: SchemaDefinition
   selection: EditorSelection
-}): EditorContext {
+}): EditorSnapshot {
   return {
-    converters: coreConverters,
-    activeDecorators: [],
-    keyGenerator: () => '',
-    schema: compileSchemaDefinition(schema),
-    selection,
-    value: [b1, b2, b3, b4],
+    context: {
+      converters: coreConverters,
+      activeDecorators: [],
+      keyGenerator: () => '',
+      schema: compileSchemaDefinition(schema),
+      selection,
+      value: [b1, b2, b3, b4],
+    },
   }
 }
 
 test(converterTextPlain.serialize.name, () => {
   expect(
     converterTextPlain.serialize({
-      context: createContext({
+      snapshot: createSnapshot({
         schema: defineSchema({}),
         selection: {
           anchor: {
@@ -109,7 +111,7 @@ test(converterTextPlain.serialize.name, () => {
 
   expect(
     converterTextPlain.serialize({
-      context: createContext({
+      snapshot: createSnapshot({
         schema: defineSchema({}),
         selection: {
           anchor: {
@@ -133,7 +135,7 @@ test(converterTextPlain.serialize.name, () => {
 
   expect(
     converterTextPlain.serialize({
-      context: createContext({
+      snapshot: createSnapshot({
         schema: defineSchema({}),
         selection: {
           anchor: {
@@ -157,7 +159,7 @@ test(converterTextPlain.serialize.name, () => {
 
   expect(
     converterTextPlain.serialize({
-      context: createContext({
+      snapshot: createSnapshot({
         schema: defineSchema({
           blockObjects: [
             {
@@ -187,7 +189,7 @@ test(converterTextPlain.serialize.name, () => {
 
   expect(
     converterTextPlain.serialize({
-      context: createContext({
+      snapshot: createSnapshot({
         schema: defineSchema({}),
         selection: {
           anchor: {
@@ -211,7 +213,7 @@ test(converterTextPlain.serialize.name, () => {
 
   expect(
     converterTextPlain.serialize({
-      context: createContext({
+      snapshot: createSnapshot({
         schema: defineSchema({
           inlineObjects: [
             {

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

@@ -5,8 +5,8 @@ import {defineConverter} from './converter.types'
 
 export const converterTextPlain = defineConverter({
   mimeType: 'text/plain',
-  serialize: ({context, event}) => {
-    if (!context.selection) {
+  serialize: ({snapshot, event}) => {
+    if (!snapshot.context.selection) {
       return {
         type: 'serialization.failure',
         mimeType: 'text/plain',
@@ -16,8 +16,8 @@ export const converterTextPlain = defineConverter({
     }
 
     const blocks = sliceBlocks({
-      blocks: context.value,
-      selection: context.selection,
+      blocks: snapshot.context.value,
+      selection: snapshot.context.selection,
     })
 
     const data = blocks
@@ -25,12 +25,12 @@ export const converterTextPlain = defineConverter({
         if (isPortableTextTextBlock(block)) {
           return block.children
             .map((child) => {
-              if (child._type === context.schema.span.name) {
+              if (child._type === snapshot.context.schema.span.name) {
                 return child.text
               }
 
               return `[${
-                context.schema.inlineObjects.find(
+                snapshot.context.schema.inlineObjects.find(
                   (inlineObjectType) => inlineObjectType.name === child._type,
                 )?.title ?? 'Object'
               }]`
@@ -39,7 +39,7 @@ export const converterTextPlain = defineConverter({
         }
 
         return `[${
-          context.schema.blockObjects.find(
+          snapshot.context.schema.blockObjects.find(
             (blockObjectType) => blockObjectType.name === block._type,
           )?.title ?? 'Object'
         }]`
@@ -53,7 +53,7 @@ export const converterTextPlain = defineConverter({
       originEvent: event.originEvent,
     }
   },
-  deserialize: ({context, event}) => {
+  deserialize: ({snapshot, event}) => {
     const html = escapeHtml(event.data)
       .split(/\n{2,}/)
       .map((line) =>
@@ -63,9 +63,13 @@ export const converterTextPlain = defineConverter({
 
     const textToHtml = `<html><body>${html}</body></html>`
 
-    const blocks = htmlToBlocks(textToHtml, context.schema.portableText, {
-      keyGenerator: context.keyGenerator,
-    }) as Array<PortableTextBlock>
+    const blocks = htmlToBlocks(
+      textToHtml,
+      snapshot.context.schema.portableText,
+      {
+        keyGenerator: snapshot.context.keyGenerator,
+      },
+    ) as Array<PortableTextBlock>
 
     return {
       type: 'deserialization.success',

package/src/converters/converter.types.ts

@@ -1,5 +1,5 @@
 import type {PortableTextBlock} from '@sanity/types'
-import type {EditorContext} from '../editor/editor-snapshot'
+import type {EditorSnapshot} from '../editor/editor-snapshot'
 import type {MIMEType} from '../internal-utils/mime-type'
 import type {PickFromUnion} from '../type-utils'
 
@@ -18,18 +18,19 @@ export function defineConverter<TMIMEType extends MIMEType>(
 export type ConverterEvent<TMIMEType extends MIMEType = MIMEType> =
   | {
       type: 'serialize'
-      originEvent: 'copy' | 'cut' | 'unknown'
+      originEvent: 'copy' | 'cut' | 'drag' | 'unknown'
     }
   | {
       type: 'serialization.failure'
       mimeType: TMIMEType
+      originEvent: 'copy' | 'cut' | 'drag' | 'unknown'
       reason: string
     }
   | {
       type: 'serialization.success'
       data: string
       mimeType: TMIMEType
-      originEvent: 'copy' | 'cut' | 'unknown'
+      originEvent: 'copy' | 'cut' | 'drag' | 'unknown'
     }
   | {
       type: 'deserialize'
@@ -47,10 +48,10 @@ export type ConverterEvent<TMIMEType extends MIMEType = MIMEType> =
     }
 
 export type Serializer<TMIMEType extends MIMEType> = ({
-  context,
+  snapshot,
   event,
 }: {
-  context: EditorContext
+  snapshot: EditorSnapshot
   event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'serialize'>
 }) => PickFromUnion<
   ConverterEvent<TMIMEType>,
@@ -59,10 +60,10 @@ export type Serializer<TMIMEType extends MIMEType> = ({
 >
 
 export type Deserializer<TMIMEType extends MIMEType> = ({
-  context,
+  snapshot,
   event,
 }: {
-  context: EditorContext
+  snapshot: EditorSnapshot
   event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'deserialize'>
 }) => PickFromUnion<
   ConverterEvent<TMIMEType>,

package/src/editor/editor-machine.ts

@@ -369,6 +369,7 @@ export const editorMachine = setup({
           eventBehavior.guard === undefined ||
           eventBehavior.guard({
             context: editorSnapshot.context,
+            snapshot: editorSnapshot,
             event: event.behaviorEvent,
           })
 
@@ -378,7 +379,11 @@ export const editorMachine = setup({
 
         const actionIntendSets = eventBehavior.actions.map((actionSet) =>
           actionSet(
-            {context: editorSnapshot.context, event: event.behaviorEvent},
+            {
+              context: editorSnapshot.context,
+              snapshot: editorSnapshot,
+              event: event.behaviorEvent,
+            },
             shouldRun,
           ),
         )

package/src/editor/plugins/create-with-event-listeners.ts

@@ -236,11 +236,6 @@ export function createWithEventListeners(
     }
 
     editor.setFragmentData = (dataTransfer, originEvent) => {
-      if (originEvent === 'drag') {
-        setFragmentData(dataTransfer)
-        return
-      }
-
       if (isApplyingBehaviorActions(editor)) {
         setFragmentData(dataTransfer)
         return

package/src/index.ts

@@ -10,7 +10,6 @@ export type {
   BehaviorActionIntendSet,
   BehaviorEvent,
   BehaviorGuard,
-  BlockOffset,
   NativeBehaviorEvent,
   SyntheticBehaviorEvent,
 } from './behaviors/index'
@@ -21,11 +20,9 @@ export {
   type BaseDefinition,
   type SchemaDefinition,
 } from './editor/define-schema'
-export type {PortableTextMemberSchemaTypes} from './types/editor'
 export type {EditorSchema} from './editor/define-schema'
 export {PortableTextEditable} from './editor/Editable'
 export type {PortableTextEditableProps} from './editor/Editable'
-export {EventListenerPlugin as EditorEventListener} from './plugins/plugin.event-listener'
 export type {
   EditorEmittedEvent,
   MutationEvent,
@@ -44,5 +41,8 @@ export {defaultKeyGenerator as keyGenerator} from './editor/key-generator'
 export type {AddedAnnotationPaths} from './editor/plugins/createWithEditableAPI'
 export {PortableTextEditor} from './editor/PortableTextEditor'
 export type {PortableTextEditorProps} from './editor/PortableTextEditor'
+export {EventListenerPlugin as EditorEventListener} from './plugins/plugin.event-listener'
+export type {BlockOffset} from './types/block-offset'
 export * from './types/editor'
+export type {PortableTextMemberSchemaTypes} from './types/editor'
 export type {HotkeyOptions} from './types/options'

package/src/internal-utils/get-text-to-emphasize.ts

@@ -1,12 +1,34 @@
-const asteriskPairRegex = '(?<!\\*)\\*(?!\\s)([^*\\n]+?)(?<!\\s)\\*(?!\\*)'
-const underscorePairRegex = '(?<!_)_(?!\\s)([^_\\n]+?)(?<!\\s)_(?!_)'
-const italicRegex = new RegExp(`(${asteriskPairRegex}|${underscorePairRegex})$`)
+export function createPairRegex(char: string, amount: number) {
+  // Negative lookbehind: Ensures that the matched sequence is not preceded by the same character
+  const prePrefix = `(?<!\\${char})`
+
+  // Repeats the character `amount` times
+  const prefix = `\\${char}`.repeat(Math.max(amount, 1))
+
+  // Negative lookahead: Ensures that the opening pair (**, *, etc.) is not followed by a space
+  const postPrefix = `(?!\\s)`
+
+  // Captures the content inside the pair
+  const content = `([^${char}\\n]+?)`
+
+  // Negative lookbehind: Ensures that the content is not followed by a space
+  const preSuffix = `(?<!\\s)`
+
+  // Repeats the character `amount` times
+  const suffix = `\\${char}`.repeat(Math.max(amount, 1))
+
+  // Negative lookahead: Ensures that the matched sequence is not followed by the same character
+  const postSuffix = `(?!\\${char})`
+
+  return `${prePrefix}${prefix}${postPrefix}${content}${preSuffix}${suffix}${postSuffix}`
+}
+
+const italicRegex = new RegExp(
+  `(${createPairRegex('*', 1)}|${createPairRegex('_', 1)})$`,
+)
 
-const doubleAsteriskPairRegex =
-  '(?<!\\*)\\*\\*(?!\\s)([^*\\n]+?)(?<!\\s)\\*\\*(?!\\*)'
-const doubleUnderscorePairRegex = '(?<!_)__(?!\\s)([^_\\n]+?)(?<!\\s)__(?!_)'
 const boldRegex = new RegExp(
-  `(${doubleAsteriskPairRegex}|${doubleUnderscorePairRegex})$`,
+  `(${createPairRegex('*', 2)}|${createPairRegex('_', 2)})$`,
 )
 
 export function getTextToItalic(text: string) {