@portabletext/editor 2.12.0 → 2.12.2

package/lib/plugins/index.d.ts

@@ -1,5 +1,5 @@
 import { Behavior, Editor, EditorEmittedEvent, EditorSchema } from "../_chunks-dts/behavior.types.action.js";
-import * as react22 from "react";
+import * as react12 from "react";
 import React from "react";
 /**
  * @beta
@@ -181,7 +181,7 @@ type MarkdownPluginConfig = MarkdownBehaviorsConfig & {
  */
 declare function MarkdownPlugin(props: {
   config: MarkdownPluginConfig;
-}): react22.JSX.Element;
+}): react12.JSX.Element;
 /**
  * @beta
  * Restrict the editor to one line. The plugin takes care of blocking
@@ -192,5 +192,5 @@ declare function MarkdownPlugin(props: {
  *
  * @deprecated Install the plugin from `@portabletext/plugin-one-line`
  */
-declare function OneLinePlugin(): react22.JSX.Element;
+declare function OneLinePlugin(): react12.JSX.Element;
 export { BehaviorPlugin, DecoratorShortcutPlugin, EditorRefPlugin, EventListenerPlugin, MarkdownPlugin, type MarkdownPluginConfig, OneLinePlugin };

package/lib/utils/index.d.ts

@@ -1,5 +1,5 @@
 import { BlockOffset, BlockPath, ChildPath, EditorContext, EditorSelection, EditorSelectionPoint } from "../_chunks-dts/behavior.types.action.js";
-import * as _sanity_types9 from "@sanity/types";
+import * as _sanity_types8 from "@sanity/types";
 import { KeyedSegment, PortableTextBlock, PortableTextTextBlock } from "@sanity/types";
 import { isSpan, isTextBlock } from "@portabletext/schema";
 /**
@@ -143,7 +143,7 @@ declare function mergeTextBlocks({
   context: Pick<EditorContext, 'keyGenerator' | 'schema'>;
   targetBlock: PortableTextTextBlock;
   incomingBlock: PortableTextTextBlock;
-}): PortableTextTextBlock<_sanity_types9.PortableTextObject | _sanity_types9.PortableTextSpan>;
+}): PortableTextTextBlock<_sanity_types8.PortableTextObject | _sanity_types8.PortableTextSpan>;
 /**
  * @public
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "2.12.0",
+  "version": "2.12.2",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",
@@ -51,6 +51,12 @@
       "require": "./lib/selectors/index.cjs",
       "default": "./lib/selectors/index.js"
     },
+    "./test": {
+      "default": "./src/test/_exports/index.ts"
+    },
+    "./test/vitest": {
+      "default": "./src/test/vitest/_exports/index.ts"
+    },
     "./utils": {
       "source": "./src/utils/_exports/index.ts",
       "import": "./lib/utils/index.js",
@@ -78,11 +84,11 @@
     "slate": "0.118.1",
     "slate-dom": "^0.118.1",
     "slate-react": "0.117.4",
-    "xstate": "^5.21.0",
+    "xstate": "^5.22.0",
     "@portabletext/block-tools": "^3.5.6",
     "@portabletext/keyboard-shortcuts": "^1.1.1",
-    "@portabletext/schema": "^1.2.0",
-    "@portabletext/patches": "^1.1.8"
+    "@portabletext/patches": "^1.1.8",
+    "@portabletext/schema": "^1.2.0"
   },
   "devDependencies": {
     "@sanity/diff-match-patch": "^3.2.0",
@@ -112,7 +118,7 @@
     "vitest-browser-react": "^1.0.1",
     "@portabletext/sanity-bridge": "1.1.10",
     "@portabletext/test": "^0.0.0",
-    "racejar": "1.2.15"
+    "racejar": "1.3.0"
   },
   "peerDependencies": {
     "@portabletext/sanity-bridge": "^1.1.10",

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

@@ -1,8 +1,29 @@
+import {createKeyboardShortcut} from '@portabletext/keyboard-shortcuts'
+import {isTextBlock} from '@portabletext/schema'
 import {defaultKeyboardShortcuts} from '../keyboard-shortcuts/default-keyboard-shortcuts'
-import * as selectors from '../selectors'
+import {
+  getFocusBlock,
+  getFocusInlineObject,
+  getPreviousBlock,
+  isSelectionCollapsed,
+  isSelectionExpanded,
+} from '../selectors'
+import {getBlockEndPoint, isEmptyTextBlock} from '../utils'
 import {raise} from './behavior.types.action'
 import {defineBehavior} from './behavior.types.behavior'
 
+const shiftLeft = createKeyboardShortcut({
+  default: [
+    {
+      key: 'ArrowLeft',
+      shift: true,
+      meta: false,
+      ctrl: false,
+      alt: false,
+    },
+  ],
+})
+
 export const abstractKeyboardBehaviors = [
   /**
    * Allow raising an `insert.break` event when pressing Enter on an inline
@@ -12,8 +33,20 @@ export const abstractKeyboardBehaviors = [
     on: 'keyboard.keydown',
     guard: ({snapshot, event}) =>
       defaultKeyboardShortcuts.break.guard(event.originEvent) &&
-      selectors.isSelectionCollapsed(snapshot) &&
-      selectors.getFocusInlineObject(snapshot),
+      isSelectionCollapsed(snapshot) &&
+      getFocusInlineObject(snapshot),
+    actions: [() => [raise({type: 'insert.break'})]],
+  }),
+
+  /**
+   * On Firefox, Enter might collapse the selection. To mitigate this, we
+   * `raise` an `insert.break` event manually.
+   */
+  defineBehavior({
+    on: 'keyboard.keydown',
+    guard: ({snapshot, event}) =>
+      defaultKeyboardShortcuts.break.guard(event.originEvent) &&
+      isSelectionExpanded(snapshot),
     actions: [() => [raise({type: 'insert.break'})]],
   }),
 
@@ -48,4 +81,68 @@ export const abstractKeyboardBehaviors = [
       defaultKeyboardShortcuts.history.redo.guard(event.originEvent),
     actions: [() => [raise({type: 'history.redo'})]],
   }),
+
+  /**
+   * Fix edge case where Shift+ArrowLeft didn't reduce a selection hanging
+   * onto an empty text block.
+   */
+  defineBehavior({
+    on: 'keyboard.keydown',
+    guard: ({snapshot, event}) => {
+      if (!snapshot.context.selection || !shiftLeft.guard(event.originEvent)) {
+        return false
+      }
+
+      const focusBlock = getFocusBlock(snapshot)
+
+      if (!focusBlock) {
+        return false
+      }
+
+      const previousBlock = getPreviousBlock({
+        ...snapshot,
+        context: {
+          ...snapshot.context,
+          selection: {
+            anchor: {
+              path: focusBlock.path,
+              offset: 0,
+            },
+            focus: {
+              path: focusBlock.path,
+              offset: 0,
+            },
+          },
+        },
+      })
+
+      if (!previousBlock) {
+        return false
+      }
+
+      const hanging =
+        isTextBlock(snapshot.context, focusBlock.node) &&
+        snapshot.context.selection.focus.offset === 0
+
+      if (hanging && isEmptyTextBlock(snapshot.context, focusBlock.node)) {
+        return {previousBlock, selection: snapshot.context.selection}
+      }
+
+      return false
+    },
+    actions: [
+      ({snapshot}, {previousBlock, selection}) => [
+        raise({
+          type: 'select',
+          at: {
+            anchor: selection.anchor,
+            focus: getBlockEndPoint({
+              context: snapshot.context,
+              block: previousBlock,
+            }),
+          },
+        }),
+      ],
+    ],
+  }),
 ]

package/src/behaviors/behavior.perform-event.ts

@@ -168,7 +168,15 @@ export function performEvent({
     // action prevented
     defaultBehaviorOverwritten = true
 
+    if (eventBehavior.actions.length === 0) {
+      nativeEventPrevented = true
+    }
+
+    let actionSetIndex = -1
+
     for (const actionSet of eventBehavior.actions) {
+      actionSetIndex++
+
       const actionsSnapshot = getSnapshot()
 
       let actions: Array<BehaviorAction> = []
@@ -201,7 +209,17 @@ export function performEvent({
 
       let undoStepCreated = false
 
-      if (actions.some((action) => action.type === 'execute')) {
+      if (actionSetIndex > 0) {
+        // Since there are multiple action sets
+        createUndoStep(editor)
+
+        undoStepCreated = true
+      }
+
+      if (
+        !undoStepCreated &&
+        actions.some((action) => action.type === 'execute')
+      ) {
         // Since at least one action is about to `execute` changes in the editor,
         // we set up a new undo step.
         // All actions performed recursively from now will be squashed into this

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

@@ -3,9 +3,9 @@ import {createTestKeyGenerator} from '@portabletext/test'
 import React from 'react'
 import {describe, expect, test} from 'vitest'
 import {InternalSlateEditorRefPlugin} from '../plugins/plugin.internal.slate-editor-ref'
+import {createTestEditor} from '../test/vitest'
 import type {PortableTextSlateEditor} from '../types/editor'
 import {getFocusSpan} from './slate-utils'
-import {createTestEditor} from './test-editor'
 
 describe(getFocusSpan.name, () => {
   const keyGenerator = createTestKeyGenerator()

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

@@ -1,7 +1,7 @@
 import {getTersePt} from '@portabletext/test'
 import {userEvent} from '@vitest/browser/context'
 import {describe, expect, test, vi} from 'vitest'
-import {createTestEditor} from '../internal-utils/test-editor'
+import {createTestEditor} from '../test/vitest'
 import {AutoCloseBracketsPlugin} from './plugin.internal.auto-close-brackets'
 
 describe(AutoCloseBracketsPlugin.name, () => {

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

@@ -2,8 +2,8 @@ import {defineSchema} from '@portabletext/schema'
 import {getTersePt} from '@portabletext/test'
 import {userEvent} from '@vitest/browser/context'
 import {describe, expect, test, vi} from 'vitest'
-import {createTestEditor} from '../internal-utils/test-editor'
 import {getTextMarks} from '../internal-utils/text-marks'
+import {createTestEditor} from '../test/vitest'
 import {MarkdownPlugin} from './plugin.markdown'
 
 describe(MarkdownPlugin.name, () => {

package/src/selectors/selector.get-mark-state.test.ts

@@ -0,0 +1,76 @@
+import {compileSchema, defineSchema} from '@portabletext/schema'
+import {createTestKeyGenerator} from '@portabletext/test'
+import {describe, expect, test} from 'vitest'
+import {createTestSnapshot} from '../internal-utils/create-test-snapshot'
+import {getMarkState} from './selector.get-mark-state'
+
+describe(getMarkState.name, () => {
+  test('Scenario: Caret after annotated decorator', () => {
+    const keyGenerator = createTestKeyGenerator()
+    const blockKey = keyGenerator()
+    const fooSpanKey = keyGenerator()
+    const barSpanKey = keyGenerator()
+    const bazSpanKey = keyGenerator()
+    const linkKey = keyGenerator()
+    const snapshot = createTestSnapshot({
+      context: {
+        keyGenerator,
+        value: [
+          {
+            _type: 'block',
+            _key: blockKey,
+            children: [
+              {
+                _type: 'span',
+                _key: fooSpanKey,
+                text: 'foo ',
+              },
+              {
+                _type: 'span',
+                _key: barSpanKey,
+                text: 'bar',
+                marks: [linkKey, 'strong'],
+              },
+              {
+                _type: 'span',
+                _key: bazSpanKey,
+                text: ' baz',
+              },
+            ],
+            markDefs: [
+              {
+                _type: 'link',
+                _key: linkKey,
+                href: 'https://portabletext.org',
+              },
+            ],
+            style: 'normal',
+          },
+        ],
+        selection: {
+          anchor: {
+            path: [{_key: blockKey}, 'children', {_key: bazSpanKey}],
+            offset: 0,
+          },
+          focus: {
+            path: [{_key: blockKey}, 'children', {_key: bazSpanKey}],
+            offset: 0,
+          },
+          backward: false,
+        },
+        schema: compileSchema(
+          defineSchema({
+            annotations: [{name: 'link'}],
+            decorators: [{name: 'strong'}],
+          }),
+        ),
+      },
+    })
+
+    expect(getMarkState(snapshot)).toEqual({
+      state: 'changed',
+      marks: [],
+      previousMarks: [linkKey, 'strong'],
+    })
+  })
+})

package/src/selectors/selector.get-mark-state.ts

@@ -164,7 +164,7 @@ export const getMarkState: EditorSelector<MarkState | undefined> = (
     if (previousSpanHasAnnotations) {
       return {
         state: 'changed',
-        previousMarks: marks,
+        previousMarks: previousSpan.node.marks ?? [],
         marks: [],
       }
     } else {

package/src/test/_exports/index.ts

@@ -0,0 +1 @@
+export * from '../index'

package/src/test/gherkin-parameter-types.ts

@@ -0,0 +1,102 @@
+import {parseTersePtString} from '@portabletext/test'
+import {createParameterType, type ParameterType} from 'racejar'
+
+/**
+ * @internal
+ */
+export type Parameter = {
+  [K in keyof typeof parameterType]: (typeof parameterType)[K] extends ParameterType<
+    infer TParameterType
+  >
+    ? TParameterType
+    : never
+}
+
+const parameterType = {
+  annotation: createParameterType<'comment' | 'link'>({
+    name: 'annotation',
+    matcher: /"(comment|link)"/,
+  }),
+  blockObject: createParameterType<'image'>({
+    name: 'block-object',
+    matcher: /"(image)"/,
+  }),
+  button: createParameterType<string>({
+    name: 'button',
+    matcher: /"(([A-Z]|[a-z]|{|}|>|\/|\+)+)"/,
+    type: String,
+  }),
+  decorator: createParameterType<'em' | 'strong'>({
+    name: 'decorator',
+    matcher: /"(em|strong)"/,
+  }),
+  index: createParameterType({
+    name: 'index',
+    matcher: /"(\d)"/,
+    type: Number,
+    transform: (input) => Number.parseInt(input, 10),
+  }),
+  inlineObject: createParameterType<'stock-ticker'>({
+    name: 'inline-object',
+    matcher: /"(stock-ticker)"/,
+  }),
+  key: createParameterType<'key'>({
+    name: 'key',
+    matcher: /"([a-z]\d)"/,
+  }),
+  keyKeys: createParameterType<Array<string>>({
+    name: 'keyKeys',
+    matcher: /"(([a-z]\d)(,([a-z]\d))*)"/,
+    type: Array,
+    transform: (input) => input.split(','),
+  }),
+  marks: createParameterType<Array<string>>({
+    name: 'marks',
+    matcher: /"((strong|em|[a-z]\d)(,(strong|em|[a-z]\d))*)"/,
+    type: Array,
+    transform: (input) => input.split(','),
+  }),
+  placement: createParameterType<'auto' | 'after' | 'before'>({
+    name: 'placement',
+    matcher: /"(auto|after|before)"/,
+  }),
+  selectPosition: createParameterType<'start' | 'end' | 'none'>({
+    name: 'select-position',
+    matcher: /"(start|end|none)"/,
+  }),
+  style: createParameterType({
+    name: 'style',
+    matcher: /"(normal|blockquote|h\d)"/,
+  }),
+  tersePt: createParameterType<Array<string>>({
+    name: 'terse-pt',
+    matcher: /"([a-z-,#>:\\n \d|{}'"‘’“”?—]*)"/u,
+    type: Array,
+    transform: parseTersePtString,
+  }),
+  text: createParameterType<string>({
+    name: 'text',
+    matcher: /"([a-z]*)"/u,
+    type: String,
+  }),
+}
+
+/**
+ * @internal
+ */
+export const parameterTypes = [
+  parameterType.annotation,
+  parameterType.blockObject,
+  parameterType.button,
+  parameterType.decorator,
+  parameterType.index,
+  parameterType.inlineObject,
+  parameterType.key,
+  parameterType.keyKeys,
+  parameterType.marks,
+  parameterType.placement,
+  parameterType.selectPosition,
+  parameterType.style,
+  parameterType.tersePt,
+  parameterType.text,
+]

package/src/test/index.ts

@@ -0,0 +1 @@
+export * from './gherkin-parameter-types'

package/src/test/vitest/_exports/index.ts

@@ -0,0 +1 @@
+export * from '../index'

package/src/test/vitest/index.ts

@@ -0,0 +1,3 @@
+export * from './step-context'
+export * from './step-definitions'
+export * from './test-editor'

package/src/test/vitest/step-context.ts

@@ -0,0 +1,11 @@
+import type {Locator} from '@vitest/browser/context'
+import type {Editor} from '../../editor'
+
+/**
+ * @internal
+ */
+export type Context = {
+  editor: Editor
+  locator: Locator
+  keyMap?: Map<string, string>
+}