@portabletext/editor 1.15.1 → 1.15.2

package/src/{editor/behavior → behaviors}/behavior.types.ts

@@ -1,8 +1,9 @@
 import type {KeyedSegment, PortableTextTextBlock} from '@sanity/types'
 import type {TextUnit} from 'slate'
 import type {TextInsertTextOptions} from 'slate/dist/interfaces/transforms/text'
-import type {EditorSelection, PortableTextSlateEditor} from '../../types/editor'
-import type {EditorContext} from '../editor-snapshot'
+import type {EditorContext} from '../editor/editor-snapshot'
+import type {PickFromUnion} from '../type-utils'
+import type {EditorSelection, PortableTextSlateEditor} from '../types/editor'
 
 /**
  * @alpha
@@ -116,20 +117,6 @@ export type NativeBehaviorEvent =
       data: DataTransfer
     }
 
-/**
- * @alpha
- */
-export type BehaviorGuard<
-  TAnyBehaviorEvent extends BehaviorEvent,
-  TGuardResponse,
-> = ({
-  context,
-  event,
-}: {
-  context: EditorContext
-  event: TAnyBehaviorEvent
-}) => TGuardResponse | false
-
 /**
  * @alpha
  */
@@ -238,32 +225,56 @@ export type BehaviorEvent = SyntheticBehaviorEvent | NativeBehaviorEvent
  * @alpha
  */
 export type Behavior<
-  TAnyBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
+  TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
   TGuardResponse = true,
 > = {
   /**
    * The internal editor event that triggers this behavior.
    */
-  on: TAnyBehaviorEventType
+  on: TBehaviorEventType
   /**
    * Predicate function that determines if the behavior should be executed.
    * Returning a non-nullable value from the guard will pass the value to the
    * actions and execute them.
    */
   guard?: BehaviorGuard<
-    PickFromUnion<BehaviorEvent, 'type', TAnyBehaviorEventType>,
+    PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>,
     TGuardResponse
   >
   /**
    * Array of behavior action sets.
    */
-  actions: Array<BehaviorActionIntendSet<TGuardResponse>>
+  actions: Array<BehaviorActionIntendSet<TBehaviorEventType, TGuardResponse>>
 }
 
 /**
  * @alpha
  */
-export type BehaviorActionIntendSet<TGuardResponse = true> = (
+export type BehaviorGuard<
+  TBehaviorEvent extends BehaviorEvent,
+  TGuardResponse,
+> = ({
+  context,
+  event,
+}: {
+  context: EditorContext
+  event: TBehaviorEvent
+}) => TGuardResponse | false
+
+/**
+ * @alpha
+ */
+export type BehaviorActionIntendSet<
+  TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
+  TGuardResponse = true,
+> = (
+  {
+    context,
+    event,
+  }: {
+    context: EditorContext
+    event: PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>
+  },
   guardResponse: TGuardResponse,
 ) => Array<BehaviorActionIntend>
 
@@ -284,21 +295,3 @@ export type BlockOffset = {
   path: [KeyedSegment]
   offset: number
 }
-
-/**
- * @alpha
- */
-export type PickFromUnion<
-  TUnion,
-  TTagKey extends keyof TUnion,
-  TPickedTags extends TUnion[TTagKey],
-> = TUnion extends Record<TTagKey, TPickedTags> ? TUnion : never
-
-/**
- * @alpha
- */
-export type OmitFromUnion<
-  TUnion,
-  TTagKey extends keyof TUnion,
-  TOmittedTags extends TUnion[TTagKey],
-> = TUnion extends Record<TTagKey, TOmittedTags> ? never : TUnion

package/src/behaviors/index.ts

@@ -0,0 +1,28 @@
+export type {EditorContext} from '../editor/editor-snapshot'
+export type {PickFromUnion} from '../type-utils'
+export type {
+  EditorSelection,
+  EditorSelectionPoint,
+  PortableTextMemberSchemaTypes,
+} from '../types/editor'
+export {
+  createCodeEditorBehaviors,
+  type CodeEditorBehaviorsConfig,
+} from './behavior.code-editor'
+export {coreBehavior, coreBehaviors} from './behavior.core'
+export {createLinkBehaviors, type LinkBehaviorsConfig} from './behavior.links'
+export {
+  createMarkdownBehaviors,
+  type MarkdownBehaviorsConfig,
+} from './behavior.markdown'
+export {
+  defineBehavior,
+  type Behavior,
+  type BehaviorActionIntend,
+  type BehaviorActionIntendSet,
+  type BehaviorEvent,
+  type BehaviorGuard,
+  type BlockOffset,
+  type NativeBehaviorEvent,
+  type SyntheticBehaviorEvent,
+} from './behavior.types'

package/src/editor/create-editor.ts

@@ -11,10 +11,11 @@ import {
   type EventObject,
   type Snapshot,
 } from 'xstate'
+import type {Behavior} from '../behaviors/behavior.types'
+import type {PickFromUnion} from '../type-utils'
 import type {EditableAPI} from '../types/editor'
 import {getPortableTextMemberSchemaTypes} from '../utils/getPortableTextMemberSchemaTypes'
 import {compileType} from '../utils/schema'
-import type {Behavior, PickFromUnion} from './behavior/behavior.types'
 import {createSlateEditor, type SlateEditor} from './create-slate-editor'
 import {compileSchemaDefinition, type SchemaDefinition} from './define-schema'
 import {
@@ -81,64 +82,21 @@ export type Editor = {
   }
 }
 
-/**
- * @internal
- */
 export function createEditor(config: EditorConfig): Editor {
   const editorActor = createActor(editorMachine, {
     input: editorConfigToMachineInput(config),
   })
-
   editorActor.start()
 
-  const slateEditor = createSlateEditor({editorActor})
-  const editable = createEditableAPI(slateEditor.instance, editorActor)
-
-  return {
-    send: (event) => {
-      editorActor.send(event)
-    },
-    on: (event, listener) =>
-      editorActor.on(
-        event,
-        // @ts-expect-error
-        listener,
-      ),
-    _internal: {
-      editable,
-      editorActor,
-      slateEditor,
-    },
-  }
+  return createEditorFromActor(editorActor)
 }
 
 export function useCreateEditor(config: EditorConfig): Editor {
   const editorActor = useActorRef(editorMachine, {
     input: editorConfigToMachineInput(config),
   })
-  const editor: Editor = useMemo(() => {
-    const slateEditor = createSlateEditor({editorActor})
-    const editable = createEditableAPI(slateEditor.instance, editorActor)
-
-    return {
-      send: (event: EditorEvent) => {
-        editorActor.send(event)
-      },
-      on: (event, listener) =>
-        editorActor.on(
-          event,
-          // @ts-expect-error
-          listener,
-        ),
-      _internal: {
-        editable,
-        editorActor,
-        slateEditor,
-      },
-    }
-  }, [editorActor])
 
-  return editor
+  return useMemo(() => createEditorFromActor(editorActor), [editorActor])
 }
 
 function editorConfigToMachineInput(config: EditorConfig) {
@@ -157,3 +115,25 @@ function editorConfigToMachineInput(config: EditorConfig) {
     value: config.initialValue,
   } as const
 }
+
+function createEditorFromActor(editorActor: EditorActor): Editor {
+  const slateEditor = createSlateEditor({editorActor})
+  const editable = createEditableAPI(slateEditor.instance, editorActor)
+
+  return {
+    send: (event) => {
+      editorActor.send(event)
+    },
+    on: (event, listener) =>
+      editorActor.on(
+        event,
+        // @ts-expect-error
+        listener,
+      ),
+    _internal: {
+      editable,
+      editorActor,
+      slateEditor,
+    },
+  }
+}

package/src/editor/editor-machine.ts

@@ -10,6 +10,16 @@ import {
   setup,
   type ActorRefFrom,
 } from 'xstate'
+import {performAction} from '../behavior-actions/behavior.actions'
+import {coreBehaviors} from '../behaviors/behavior.core'
+import type {
+  Behavior,
+  BehaviorAction,
+  BehaviorActionIntend,
+  NativeBehaviorEvent,
+  SyntheticBehaviorEvent,
+} from '../behaviors/behavior.types'
+import type {OmitFromUnion, PickFromUnion} from '../type-utils'
 import type {
   EditorSelection,
   InvalidValueResolution,
@@ -20,17 +30,6 @@ import debug from '../utils/debug'
 import {toPortableTextRange} from '../utils/ranges'
 import {fromSlateValue} from '../utils/values'
 import {KEY_TO_VALUE_ELEMENT} from '../utils/weakMaps'
-import {performAction} from './behavior/behavior.actions'
-import {coreBehaviors} from './behavior/behavior.core'
-import type {
-  Behavior,
-  BehaviorAction,
-  BehaviorActionIntend,
-  NativeBehaviorEvent,
-  OmitFromUnion,
-  PickFromUnion,
-  SyntheticBehaviorEvent,
-} from './behavior/behavior.types'
 import type {EditorContext} from './editor-snapshot'
 
 export * from 'xstate/guards'
@@ -315,7 +314,10 @@ export const editorMachine = setup({
         }
 
         const actionIntendSets = eventBehavior.actions.map((actionSet) =>
-          actionSet(shouldRun),
+          actionSet(
+            {context: editorContext, event: event.behaviorEvent},
+            shouldRun,
+          ),
         )
 
         for (const actionIntends of actionIntendSets) {

package/src/editor/plugins/createWithEditableAPI.ts

@@ -18,6 +18,9 @@ import {
 } from 'slate'
 import type {DOMNode} from 'slate-dom'
 import {ReactEditor} from 'slate-react'
+import {isListItemActive} from '../../behavior-actions/behavior.action.list-item'
+import {isStyleActive} from '../../behavior-actions/behavior.action.style'
+import type {BehaviorActionImplementation} from '../../behavior-actions/behavior.actions'
 import type {
   EditableAPI,
   EditableAPIDeleteOptions,
@@ -31,9 +34,6 @@ import {
   KEY_TO_VALUE_ELEMENT,
   SLATE_TO_PORTABLE_TEXT_RANGE,
 } from '../../utils/weakMaps'
-import {isListItemActive} from '../behavior/behavior.action.list-item'
-import {isStyleActive} from '../behavior/behavior.action.style'
-import type {BehaviorActionImplementation} from '../behavior/behavior.actions'
 import type {EditorActor} from '../editor-machine'
 import {isDecoratorActive} from './createWithPortableTextMarkModel'
 

package/src/editor/plugins/createWithPortableTextMarkModel.ts

@@ -8,6 +8,7 @@ import {isPortableTextBlock, isPortableTextSpan} from '@portabletext/toolkit'
 import type {PortableTextObject, PortableTextSpan} from '@sanity/types'
 import {isEqual, uniq} from 'lodash'
 import {Editor, Element, Node, Path, Range, Text, Transforms} from 'slate'
+import type {BehaviorActionImplementation} from '../../behavior-actions/behavior.actions'
 import type {
   PortableTextMemberSchemaTypes,
   PortableTextSlateEditor,
@@ -16,7 +17,6 @@ import {debugWithName} from '../../utils/debug'
 import {getNextSpan, getPreviousSpan} from '../../utils/sibling-utils'
 import {isChangingRemotely} from '../../utils/withChanges'
 import {isRedoing, isUndoing} from '../../utils/withUndoRedo'
-import type {BehaviorActionImplementation} from '../behavior/behavior.actions'
 import type {EditorActor} from '../editor-machine'
 
 const debug = debugWithName('plugin:withPortableTextMarkModel')

package/src/editor/utils/utils.block-offset.ts

@@ -4,7 +4,7 @@ import {
   type KeyedSegment,
   type PortableTextBlock,
 } from '@sanity/types'
-import type {BlockOffset} from '../behavior/behavior.types'
+import type {BlockOffset} from '../../behaviors/behavior.types'
 
 export function blockOffsetToSpanSelectionPoint({
   value,

package/src/index.ts

@@ -1,31 +1,15 @@
 export type {Patch} from '@portabletext/patches'
 export type {PortableTextBlock, PortableTextChild} from '@sanity/types'
-export {
-  createCodeEditorBehaviors,
-  type CodeEditorBehaviorsConfig,
-} from './editor/behavior/behavior.code-editor'
-export {coreBehavior, coreBehaviors} from './editor/behavior/behavior.core'
-export {
-  createLinkBehaviors,
-  type LinkBehaviorsConfig,
-} from './editor/behavior/behavior.links'
-export {
-  createMarkdownBehaviors,
-  type MarkdownBehaviorsConfig,
-} from './editor/behavior/behavior.markdown'
-export {
-  defineBehavior,
-  type BehaviorEvent,
-  type Behavior,
-  type BehaviorActionIntend,
-  type BehaviorActionIntendSet,
-  type SyntheticBehaviorEvent,
-  type BehaviorGuard,
-  type BlockOffset,
-  type NativeBehaviorEvent,
-  type OmitFromUnion,
-  type PickFromUnion,
-} from './editor/behavior/behavior.types'
+export type {
+  Behavior,
+  BehaviorActionIntend,
+  BehaviorActionIntendSet,
+  BehaviorEvent,
+  BehaviorGuard,
+  BlockOffset,
+  NativeBehaviorEvent,
+  SyntheticBehaviorEvent,
+} from './behaviors/index'
 export type {Editor, EditorConfig, EditorEvent} from './editor/create-editor'
 export type {SlateEditor} from './editor/create-slate-editor'
 export {
@@ -63,5 +47,6 @@ 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 type {OmitFromUnion, PickFromUnion} from './type-utils'
 export * from './types/editor'
 export type {HotkeyOptions} from './types/options'

package/src/selectors/selector.get-active-list-item.ts

@@ -1,5 +1,5 @@
 import type {PortableTextListBlock} from '@sanity/types'
-import {createGuards} from '../editor/behavior/behavior.guards'
+import {createGuards} from '../behavior-actions/behavior.guards'
 import type {EditorSelector} from '../editor/editor-selector'
 import {getSelectedBlocks} from './selectors'
 

package/src/selectors/selectors.ts

@@ -9,7 +9,7 @@ import {
   type PortableTextSpan,
   type PortableTextTextBlock,
 } from '@sanity/types'
-import {createGuards} from '../editor/behavior/behavior.guards'
+import {createGuards} from '../behavior-actions/behavior.guards'
 import type {EditorSelector} from '../editor/editor-selector'
 
 /**

package/src/type-utils.ts

@@ -0,0 +1,17 @@
+/**
+ * @alpha
+ */
+export type PickFromUnion<
+  TUnion,
+  TTagKey extends keyof TUnion,
+  TPickedTags extends TUnion[TTagKey],
+> = TUnion extends Record<TTagKey, TPickedTags> ? TUnion : never
+
+/**
+ * @alpha
+ */
+export type OmitFromUnion<
+  TUnion,
+  TTagKey extends keyof TUnion,
+  TOmittedTags extends TUnion[TTagKey],
+> = TUnion extends Record<TTagKey, TOmittedTags> ? never : TUnion

package/src/utils/__tests__/operationToPatches.test.ts

@@ -2,8 +2,8 @@ import type {PortableTextTextBlock} from '@sanity/types'
 import {createEditor, type Descendant} from 'slate'
 import {beforeEach, describe, expect, it} from 'vitest'
 import {createActor} from 'xstate'
+import {coreBehaviors} from '../../behaviors/behavior.core'
 import {schemaType} from '../../editor/__tests__/PortableTextEditorTester'
-import {coreBehaviors} from '../../editor/behavior/behavior.core'
 import {editorMachine} from '../../editor/editor-machine'
 import {defaultKeyGenerator} from '../../editor/key-generator'
 import {withPlugins} from '../../editor/plugins/with-plugins'

package/src/utils/__tests__/patchToOperations.test.ts

@@ -2,8 +2,8 @@ import type {Patch} from '@portabletext/patches'
 import {createEditor, type Descendant} from 'slate'
 import {beforeEach, describe, expect, it} from 'vitest'
 import {createActor} from 'xstate'
+import {coreBehaviors} from '../../behaviors/behavior.core'
 import {schemaType} from '../../editor/__tests__/PortableTextEditorTester'
-import {coreBehaviors} from '../../editor/behavior/behavior.core'
 import {editorMachine} from '../../editor/editor-machine'
 import {defaultKeyGenerator} from '../../editor/key-generator'
 import {withPlugins} from '../../editor/plugins/with-plugins'