@portabletext/editor 1.20.0 → 1.21.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "1.20.0",
+  "version": "1.21.1",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",
@@ -45,6 +45,12 @@
       "require": "./lib/selectors/index.cjs",
       "default": "./lib/selectors/index.js"
     },
+    "./utils": {
+      "source": "./src/utils/_exports/index.ts",
+      "import": "./lib/utils/index.js",
+      "require": "./lib/utils/index.cjs",
+      "default": "./lib/utils/index.js"
+    },
     "./package.json": "./package.json"
   },
   "main": "./lib/index.cjs",
@@ -70,11 +76,11 @@
   },
   "devDependencies": {
     "@portabletext/toolkit": "^2.0.16",
-    "@sanity/block-tools": "^3.68.3",
+    "@sanity/block-tools": "^3.69.0",
     "@sanity/diff-match-patch": "^3.1.2",
-    "@sanity/pkg-utils": "^6.13.1",
-    "@sanity/schema": "^3.68.3",
-    "@sanity/types": "^3.68.3",
+    "@sanity/pkg-utils": "^7.0.1",
+    "@sanity/schema": "^3.69.0",
+    "@sanity/types": "^3.69.0",
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.1.0",
     "@types/debug": "^4.1.5",
@@ -95,16 +101,16 @@
     "react": "^19.0.0",
     "react-dom": "^19.0.0",
     "rxjs": "^7.8.1",
-    "typescript": "5.7.2",
+    "typescript": "5.7.3",
     "vite": "^6.0.4",
     "vitest": "^2.1.8",
     "vitest-browser-react": "^0.0.4",
     "racejar": "1.1.1"
   },
   "peerDependencies": {
-    "@sanity/block-tools": "^3.68.3",
-    "@sanity/schema": "^3.68.3",
-    "@sanity/types": "^3.68.3",
+    "@sanity/block-tools": "^3.69.0",
+    "@sanity/schema": "^3.69.0",
+    "@sanity/types": "^3.69.0",
     "react": "^16.9 || ^17 || ^18 || ^19",
     "rxjs": "^7.8.1"
   },

package/src/behavior-actions/behavior.action-utils.insert-block.ts

@@ -1,7 +1,7 @@
 import {Editor, Transforms, type Descendant} from 'slate'
 import type {EditorSchema} from '../editor/define-schema'
+import {isEqualToEmptyEditor} from '../internal-utils/values'
 import type {PortableTextSlateEditor} from '../types/editor'
-import {isEqualToEmptyEditor} from '../utils/values'
 
 export function insertBlock({
   block,

package/src/behavior-actions/behavior.action.insert-block-object.ts

@@ -1,4 +1,4 @@
-import {toSlateValue} from '../utils/values'
+import {toSlateValue} from '../internal-utils/values'
 import {insertBlock} from './behavior.action-utils.insert-block'
 import type {BehaviorActionImplementation} from './behavior.actions'
 

package/src/behavior-actions/behavior.action.insert-inline-object.ts

@@ -1,5 +1,5 @@
 import {Editor, Transforms, type Element} from 'slate'
-import {toSlateValue} from '../utils/values'
+import {toSlateValue} from '../internal-utils/values'
 import type {BehaviorActionImplementation} from './behavior.actions'
 
 export const insertInlineObjectActionImplementation: BehaviorActionImplementation<

package/src/behavior-actions/behavior.action.text-block.set.ts

@@ -1,5 +1,5 @@
 import {Transforms} from 'slate'
-import {toSlateRange} from '../utils/ranges'
+import {toSlateRange} from '../internal-utils/ranges'
 import type {BehaviorActionImplementation} from './behavior.actions'
 
 export const textBlockSetActionImplementation: BehaviorActionImplementation<

package/src/behavior-actions/behavior.action.text-block.unset.ts

@@ -1,5 +1,5 @@
 import {Transforms} from 'slate'
-import {toSlateRange} from '../utils/ranges'
+import {toSlateRange} from '../internal-utils/ranges'
 import type {BehaviorActionImplementation} from './behavior.actions'
 
 export const textBlockUnsetActionImplementation: BehaviorActionImplementation<

package/src/behavior-actions/behavior.actions.ts

@@ -21,12 +21,12 @@ import {
   removeDecoratorActionImplementation,
   toggleDecoratorActionImplementation,
 } from '../editor/plugins/createWithPortableTextMarkModel'
-import {blockOffsetToSpanSelectionPoint} from '../editor/utils/utils.block-offset'
+import {toSlatePath} from '../internal-utils/paths'
+import {toSlateRange} from '../internal-utils/ranges'
+import {fromSlateValue, toSlateValue} from '../internal-utils/values'
+import {KEY_TO_VALUE_ELEMENT} from '../internal-utils/weakMaps'
 import type {PickFromUnion} from '../type-utils'
-import {toSlatePath} from '../utils/paths'
-import {toSlateRange} from '../utils/ranges'
-import {fromSlateValue, toSlateValue} from '../utils/values'
-import {KEY_TO_VALUE_ELEMENT} from '../utils/weakMaps'
+import {blockOffsetToSpanSelectionPoint} from '../utils/util.block-offset'
 import {insertBlock} from './behavior.action-utils.insert-block'
 import {insertBlockObjectActionImplementation} from './behavior.action.insert-block-object'
 import {

package/src/behaviors/behavior.code-editor.ts

@@ -1,5 +1,5 @@
+import {isHotkey} from '../internal-utils/is-hotkey'
 import * as selectors from '../selectors'
-import {isHotkey} from '../utils/is-hotkey'
 import {defineBehavior} from './behavior.types'
 
 /**

package/src/behaviors/behavior.core.block-objects.ts

@@ -1,7 +1,7 @@
 import {isPortableTextTextBlock} from '@sanity/types'
-import {isEmptyTextBlock} from '../editor/utils/utils'
+import {isHotkey} from '../internal-utils/is-hotkey'
 import * as selectors from '../selectors'
-import {isHotkey} from '../utils/is-hotkey'
+import {isEmptyTextBlock} from '../utils/util.is-empty-text-block'
 import {defineBehavior} from './behavior.types'
 
 const arrowDownOnLonelyBlockObject = defineBehavior({

package/src/behaviors/behavior.core.decorators.ts

@@ -1,4 +1,4 @@
-import {isHotkey} from '../utils/is-hotkey'
+import {isHotkey} from '../internal-utils/is-hotkey'
 import {defineBehavior, raise} from './behavior.types'
 
 export const coreDecoratorBehaviors = {

package/src/behaviors/behavior.core.lists.ts

@@ -1,7 +1,7 @@
 import {createGuards} from '../behavior-actions/behavior.guards'
-import {isEmptyTextBlock} from '../editor/utils/utils'
+import {isHotkey} from '../internal-utils/is-hotkey'
 import * as selectors from '../selectors'
-import {isHotkey} from '../utils/is-hotkey'
+import {isEmptyTextBlock} from '../utils/util.is-empty-text-block'
 import {defineBehavior} from './behavior.types'
 
 const MAX_LIST_LEVEL = 10

package/src/behaviors/behavior.emoji-picker.ts

@@ -1,6 +1,6 @@
 import {assertEvent, assign, createActor, setup} from 'xstate'
+import {isHotkey} from '../internal-utils/is-hotkey'
 import * as selectors from '../selectors'
-import {isHotkey} from '../utils/is-hotkey'
 import {defineBehavior} from './behavior.types'
 
 const emojiCharRegEx = /^[a-zA-Z-_0-9]{1}$/

package/src/behaviors/behavior.links.ts

@@ -1,6 +1,6 @@
 import type {EditorSchema} from '../editor/define-schema'
+import {looksLikeUrl} from '../internal-utils/looks-like-url'
 import * as selectors from '../selectors'
-import {looksLikeUrl} from '../utils/looks-like-url'
 import {defineBehavior} from './behavior.types'
 
 /**

package/src/behaviors/behavior.markdown.ts

@@ -1,9 +1,9 @@
 import {isPortableTextTextBlock} from '@sanity/types'
 import type {EditorSchema} from '../editor/define-schema'
-import {getTextBlockText} from '../editor/utils/utils'
-import {spanSelectionPointToBlockOffset} from '../editor/utils/utils.block-offset'
 import * as selectors from '../selectors'
 import {getBlockTextBefore} from '../selectors/selector.get-text-before'
+import {spanSelectionPointToBlockOffset} from '../utils/util.block-offset'
+import {getTextBlockText} from '../utils/util.get-text-block-text'
 import {defineBehavior} from './behavior.types'
 
 /**

package/src/behaviors/behavior.types.ts

@@ -106,6 +106,23 @@ export type NativeBehaviorEvent =
       data: DataTransfer
     }
 
+/**
+ * @beta
+ */
+export type CustomBehaviorEvent<
+  TPayload extends Record<string, unknown> = Record<string, unknown>,
+  TType extends string = string,
+  TInternalType extends `custom.${TType}` = `custom.${TType}`,
+> = {
+  type: TInternalType
+} & TPayload
+
+export function isCustomBehaviorEvent(
+  event: BehaviorEvent,
+): event is CustomBehaviorEvent {
+  return event.type.startsWith('custom.')
+}
+
 /**
  * @beta
  */
@@ -113,7 +130,7 @@ export type BehaviorActionIntend =
   | SyntheticBehaviorEvent
   | {
       type: 'raise'
-      event: SyntheticBehaviorEvent
+      event: SyntheticBehaviorEvent | CustomBehaviorEvent
     }
   | {
       type: 'annotation.toggle'
@@ -225,7 +242,7 @@ export type BehaviorAction = OmitFromUnion<
  * @beta
  */
 export function raise(
-  event: SyntheticBehaviorEvent,
+  event: SyntheticBehaviorEvent | CustomBehaviorEvent,
 ): PickFromUnion<BehaviorActionIntend, 'type', 'raise'> {
   return {type: 'raise', event}
 }
@@ -233,7 +250,10 @@ export function raise(
 /**
  * @beta
  */
-export type BehaviorEvent = SyntheticBehaviorEvent | NativeBehaviorEvent
+export type BehaviorEvent =
+  | SyntheticBehaviorEvent
+  | NativeBehaviorEvent
+  | CustomBehaviorEvent
 
 /**
  * @beta
@@ -241,6 +261,7 @@ export type BehaviorEvent = SyntheticBehaviorEvent | NativeBehaviorEvent
 export type Behavior<
   TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
   TGuardResponse = true,
+  TBehaviorEvent extends BehaviorEvent = BehaviorEvent,
 > = {
   /**
    * The internal editor event that triggers this behavior.
@@ -251,23 +272,17 @@ export type Behavior<
    * Returning a non-nullable value from the guard will pass the value to the
    * actions and execute them.
    */
-  guard?: BehaviorGuard<
-    PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>,
-    TGuardResponse
-  >
+  guard?: BehaviorGuard<TBehaviorEvent, TGuardResponse>
   /**
    * Array of behavior action sets.
    */
-  actions: Array<BehaviorActionIntendSet<TBehaviorEventType, TGuardResponse>>
+  actions: Array<BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse>>
 }
 
 /**
  * @beta
  */
-export type BehaviorGuard<
-  TBehaviorEvent extends BehaviorEvent,
-  TGuardResponse,
-> = ({
+export type BehaviorGuard<TBehaviorEvent, TGuardResponse> = ({
   context,
   event,
 }: {
@@ -278,16 +293,13 @@ export type BehaviorGuard<
 /**
  * @beta
  */
-export type BehaviorActionIntendSet<
-  TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
-  TGuardResponse = true,
-> = (
+export type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
   {
     context,
     event,
   }: {
     context: EditorContext
-    event: PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>
+    event: TBehaviorEvent
   },
   guardResponse: TGuardResponse,
 ) => Array<BehaviorActionIntend>
@@ -296,9 +308,30 @@ export type BehaviorActionIntendSet<
  * @beta
  */
 export function defineBehavior<
-  TBehaviorEventType extends BehaviorEvent['type'],
+  TPayload extends Record<string, unknown>,
+  TBehaviorEventType extends
+    BehaviorEvent['type'] = CustomBehaviorEvent['type'],
+  TGuardResponse = true,
+>(
+  behavior: Behavior<
+    TBehaviorEventType,
+    TGuardResponse,
+    TBehaviorEventType extends `custom.${infer TType}`
+      ? CustomBehaviorEvent<TPayload, TType>
+      : PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>
+  >,
+): Behavior
+export function defineBehavior<
+  TPayload extends never = never,
+  TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
   TGuardResponse = true,
->(behavior: Behavior<TBehaviorEventType, TGuardResponse>): Behavior {
+  TBehaviorEvent extends
+    BehaviorEvent = TBehaviorEventType extends `custom.${infer TType}`
+    ? CustomBehaviorEvent<TPayload, TType>
+    : PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>,
+>(
+  behavior: Behavior<TBehaviorEventType, TGuardResponse, TBehaviorEvent>,
+): Behavior {
   return behavior as unknown as Behavior
 }
 

package/src/behaviors/index.ts

@@ -29,6 +29,7 @@ export {
   type BehaviorEvent,
   type BehaviorGuard,
   type BlockOffset,
+  type CustomBehaviorEvent,
   type NativeBehaviorEvent,
   type SyntheticBehaviorEvent,
 } from './behavior.types'

package/src/editor/Editable.tsx

@@ -35,6 +35,18 @@ import {
   type RenderElementProps,
   type RenderLeafProps,
 } from 'slate-react'
+import {debugWithName} from '../internal-utils/debug'
+import {
+  moveRangeByOperation,
+  toPortableTextRange,
+  toSlateRange,
+} from '../internal-utils/ranges'
+import {normalizeSelection} from '../internal-utils/selection'
+import {
+  fromSlateValue,
+  isEqualToEmptyEditor,
+  toSlateValue,
+} from '../internal-utils/values'
 import type {
   EditorSelection,
   OnCopyFn,
@@ -51,18 +63,6 @@ import type {
 } from '../types/editor'
 import type {HotkeyOptions} from '../types/options'
 import type {SlateTextBlock, VoidElement} from '../types/slate'
-import {debugWithName} from '../utils/debug'
-import {
-  moveRangeByOperation,
-  toPortableTextRange,
-  toSlateRange,
-} from '../utils/ranges'
-import {normalizeSelection} from '../utils/selection'
-import {
-  fromSlateValue,
-  isEqualToEmptyEditor,
-  toSlateValue,
-} from '../utils/values'
 import {Element} from './components/Element'
 import {Leaf} from './components/Leaf'
 import {EditorActorContext} from './editor-actor-context'

package/src/editor/PortableTextEditor.tsx

@@ -15,6 +15,8 @@ import {
 import {Subject} from 'rxjs'
 import {Slate} from 'slate-react'
 import {useEffectEvent} from 'use-effect-event'
+import {debugWithName} from '../internal-utils/debug'
+import {compileType} from '../internal-utils/schema'
 import type {
   EditableAPI,
   EditableAPIDeleteOptions,
@@ -24,8 +26,6 @@ import type {
   PatchObservable,
   PortableTextMemberSchemaTypes,
 } from '../types/editor'
-import {debugWithName} from '../utils/debug'
-import {compileType} from '../utils/schema'
 import {Synchronizer} from './components/Synchronizer'
 import {createEditor, type Editor} from './create-editor'
 import {createEditorSchema} from './create-editor-schema'

package/src/editor/components/DraggableBlock.tsx

@@ -10,13 +10,13 @@ import {
 } from 'react'
 import {Editor, Path, Transforms, type Element as SlateElement} from 'slate'
 import {ReactEditor, useSlateStatic} from 'slate-react'
-import {debugWithName} from '../../utils/debug'
+import {debugWithName} from '../../internal-utils/debug'
 import {
   IS_DRAGGING,
   IS_DRAGGING_BLOCK_ELEMENT,
   IS_DRAGGING_BLOCK_TARGET_POSITION,
   IS_DRAGGING_ELEMENT_TARGET,
-} from '../../utils/weakMaps'
+} from '../../internal-utils/weakMaps'
 
 const debug = debugWithName('components:DraggableBlock')
 const debugRenders = false

package/src/editor/components/Element.tsx

@@ -18,6 +18,9 @@ import {
   useSlateStatic,
   type RenderElementProps,
 } from 'slate-react'
+import {debugWithName} from '../../internal-utils/debug'
+import {fromSlateValue} from '../../internal-utils/values'
+import {KEY_TO_VALUE_ELEMENT} from '../../internal-utils/weakMaps'
 import type {
   BlockRenderProps,
   PortableTextMemberSchemaTypes,
@@ -26,9 +29,6 @@ import type {
   RenderListItemFunction,
   RenderStyleFunction,
 } from '../../types/editor'
-import {debugWithName} from '../../utils/debug'
-import {fromSlateValue} from '../../utils/values'
-import {KEY_TO_VALUE_ELEMENT} from '../../utils/weakMaps'
 import ObjectNode from '../nodes/DefaultObject'
 import {DraggableBlock} from './DraggableBlock'
 

package/src/editor/components/Leaf.tsx

@@ -15,6 +15,7 @@ import {
 } from 'react'
 import {Text} from 'slate'
 import {useSelected, type RenderLeafProps} from 'slate-react'
+import {debugWithName} from '../../internal-utils/debug'
 import type {
   BlockAnnotationRenderProps,
   BlockChildRenderProps,
@@ -24,7 +25,6 @@ import type {
   RenderChildFunction,
   RenderDecoratorFunction,
 } from '../../types/editor'
-import {debugWithName} from '../../utils/debug'
 import type {EditorActor} from '../editor-machine'
 import {usePortableTextEditor} from '../hooks/usePortableTextEditor'
 import {DefaultAnnotation} from '../nodes/DefaultAnnotation'

package/src/editor/components/Synchronizer.tsx

@@ -1,7 +1,7 @@
 import {useActorRef, useSelector} from '@xstate/react'
 import {useEffect} from 'react'
+import {debugWithName} from '../../internal-utils/debug'
 import type {PortableTextSlateEditor} from '../../types/editor'
-import {debugWithName} from '../../utils/debug'
 import type {EditorActor} from '../editor-machine'
 import {mutationMachine} from '../mutation-machine'
 import {syncMachine} from '../sync-machine'

package/src/editor/create-editor.ts

@@ -11,10 +11,10 @@ import {
   type EventObject,
   type Snapshot,
 } from 'xstate'
-import type {Behavior} from '../behaviors/behavior.types'
+import type {Behavior, CustomBehaviorEvent} from '../behaviors/behavior.types'
+import {compileType} from '../internal-utils/schema'
 import type {PickFromUnion} from '../type-utils'
 import type {EditableAPI} from '../types/editor'
-import {compileType} from '../utils/schema'
 import {createEditorSchema} from './create-editor-schema'
 import {createSlateEditor, type SlateEditor} from './create-slate-editor'
 import {compileSchemaDefinition, type SchemaDefinition} from './define-schema'
@@ -58,24 +58,26 @@ export type EditorConfig = {
 /**
  * @public
  */
-export type EditorEvent = PickFromUnion<
-  InternalEditorEvent,
-  'type',
-  | 'annotation.add'
-  | 'annotation.remove'
-  | 'blur'
-  | 'decorator.toggle'
-  | 'focus'
-  | 'insert.block object'
-  | 'insert.inline object'
-  | 'list item.toggle'
-  | 'select'
-  | 'style.toggle'
-  | 'patches'
-  | 'update behaviors'
-  | 'update readOnly'
-  | 'update value'
->
+export type EditorEvent =
+  | PickFromUnion<
+      InternalEditorEvent,
+      'type',
+      | 'annotation.add'
+      | 'annotation.remove'
+      | 'blur'
+      | 'decorator.toggle'
+      | 'focus'
+      | 'insert.block object'
+      | 'insert.inline object'
+      | 'list item.toggle'
+      | 'select'
+      | 'style.toggle'
+      | 'patches'
+      | 'update behaviors'
+      | 'update readOnly'
+      | 'update value'
+    >
+  | CustomBehaviorEvent
 
 /**
  * @public

package/src/editor/create-slate-editor.tsx

@@ -1,8 +1,11 @@
 import {createEditor, type Descendant} from 'slate'
 import {withReact} from 'slate-react'
+import {debugWithName} from '../internal-utils/debug'
+import {
+  KEY_TO_SLATE_ELEMENT,
+  KEY_TO_VALUE_ELEMENT,
+} from '../internal-utils/weakMaps'
 import type {PortableTextSlateEditor} from '../types/editor'
-import {debugWithName} from '../utils/debug'
-import {KEY_TO_SLATE_ELEMENT, KEY_TO_VALUE_ELEMENT} from '../utils/weakMaps'
 import type {EditorActor} from './editor-machine'
 import {withPlugins} from './plugins/with-plugins'