@portabletext/editor 1.15.1 → 1.15.3

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

@@ -1,14 +1,14 @@
 import {isPortableTextTextBlock} from '@sanity/types'
-import {getBlockTextBefore} from '../../selectors/selector.get-text-before'
+import type {EditorSchema} from '../editor/define-schema'
+import {getTextBlockText} from '../editor/utils/utils'
+import {spanSelectionPointToBlockOffset} from '../editor/utils/utils.block-offset'
+import {getBlockTextBefore} from '../selectors/selector.get-text-before'
 import {
   getFocusBlock,
   getFocusSpan,
   getFocusTextBlock,
   selectionIsCollapsed,
-} from '../../selectors/selectors'
-import type {PortableTextMemberSchemaTypes} from '../../types/editor'
-import {getTextBlockText} from '../utils/utils'
-import {spanSelectionPointToBlockOffset} from '../utils/utils.block-offset'
+} from '../selectors/selectors'
 import {defineBehavior} from './behavior.types'
 
 /**
@@ -16,24 +16,16 @@ import {defineBehavior} from './behavior.types'
  */
 export type MarkdownBehaviorsConfig = {
   horizontalRuleObject?: (context: {
-    schema: PortableTextMemberSchemaTypes
+    schema: EditorSchema
   }) => {name: string; value?: {[prop: string]: unknown}} | undefined
-  defaultStyle?: (context: {
-    schema: PortableTextMemberSchemaTypes
-  }) => string | undefined
+  defaultStyle?: (context: {schema: EditorSchema}) => string | undefined
   headingStyle?: (context: {
-    schema: PortableTextMemberSchemaTypes
+    schema: EditorSchema
     level: number
   }) => string | undefined
-  blockquoteStyle?: (context: {
-    schema: PortableTextMemberSchemaTypes
-  }) => string | undefined
-  unorderedListStyle?: (context: {
-    schema: PortableTextMemberSchemaTypes
-  }) => string | undefined
-  orderedListStyle?: (context: {
-    schema: PortableTextMemberSchemaTypes
-  }) => string | undefined
+  blockquoteStyle?: (context: {schema: EditorSchema}) => string | undefined
+  unorderedListStyle?: (context: {schema: EditorSchema}) => string | undefined
+  orderedListStyle?: (context: {schema: EditorSchema}) => string | undefined
 }
 
 /**
@@ -65,7 +57,7 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
             'children',
             {_key: focusSpan.node._key},
           ],
-          offset: context.selection.focus.offset,
+          offset: context.selection?.focus.offset ?? 0,
         },
       })
 
@@ -95,7 +87,7 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
           text: ' ',
         },
       ],
-      ({focusTextBlock, style}) => [
+      (_, {focusTextBlock, style}) => [
         {
           type: 'text block.unset',
           props: ['listItem', 'level'],
@@ -163,13 +155,13 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
       return false
     },
     actions: [
-      ({hrCharacter}) => [
+      (_, {hrCharacter}) => [
         {
           type: 'insert.text',
           text: hrCharacter,
         },
       ],
-      ({hrObject, hrBlockOffsets}) => [
+      (_, {hrObject, hrBlockOffsets}) => [
         {
           type: 'insert.block object',
           placement: 'before',
@@ -198,13 +190,13 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
       return {hrCharacters, hrObject, focusBlock}
     },
     actions: [
-      ({hrCharacters}) => [
+      (_, {hrCharacters}) => [
         {
           type: 'insert.text',
           text: hrCharacters,
         },
       ],
-      ({hrObject, focusBlock}) =>
+      (_, {hrObject, focusBlock}) =>
         isPortableTextTextBlock(focusBlock.node)
           ? [
               {
@@ -253,7 +245,7 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
             'children',
             {_key: focusSpan.node._key},
           ],
-          offset: context.selection.focus.offset,
+          offset: context.selection?.focus.offset ?? 0,
         },
       })
 
@@ -288,13 +280,8 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
       return false
     },
     actions: [
-      () => [
-        {
-          type: 'insert.text',
-          text: ' ',
-        },
-      ],
-      ({focusTextBlock, style, level}) => [
+      ({event}) => [event],
+      (_, {focusTextBlock, style, level}) => [
         {
           type: 'text block.unset',
           props: ['listItem', 'level'],
@@ -332,7 +319,7 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
 
       const atTheBeginningOfBLock =
         focusTextBlock.node.children[0]._key === focusSpan.node._key &&
-        context.selection.focus.offset === 0
+        context.selection?.focus.offset === 0
 
       const defaultStyle = config.defaultStyle?.(context)
 
@@ -347,7 +334,7 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
       return false
     },
     actions: [
-      ({defaultStyle, focusTextBlock}) => [
+      (_, {defaultStyle, focusTextBlock}) => [
         {
           type: 'text block.set',
           style: defaultStyle,
@@ -381,7 +368,7 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
             'children',
             {_key: focusSpan.node._key},
           ],
-          offset: context.selection.focus.offset,
+          offset: context.selection?.focus.offset ?? 0,
         },
       })
 
@@ -430,13 +417,8 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
       return false
     },
     actions: [
-      () => [
-        {
-          type: 'insert.text',
-          text: ' ',
-        },
-      ],
-      ({focusTextBlock, style, listItem, listItemLength}) => [
+      ({event}) => [event],
+      (_, {focusTextBlock, style, listItem, listItemLength}) => [
         {
           type: 'text block.set',
           listItem,

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
@@ -70,10 +71,10 @@ export type SyntheticBehaviorEvent =
       }
     }
   | {
-      type: 'insert.soft break'
+      type: 'insert.break'
     }
   | {
-      type: 'insert.break'
+      type: 'insert.soft break'
     }
   | {
       type: 'insert.text'
@@ -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
  */
@@ -189,17 +176,17 @@ export type BehaviorActionIntend =
       effect: () => void
     }
   | {
-      type: 'select'
-      selection: EditorSelection
+      type: 'reselect'
     }
   | {
-      type: 'select previous block'
+      type: 'select'
+      selection: EditorSelection
     }
   | {
-      type: 'select next block'
+      type: 'select.previous block'
     }
   | {
-      type: 'reselect'
+      type: 'select.next block'
     }
   | {
       type: 'style.add'
@@ -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,29 @@
+export type {EditorSchema} from '../editor/define-schema'
+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/PortableTextEditor.tsx

@@ -25,10 +25,10 @@ import type {
   PortableTextMemberSchemaTypes,
 } from '../types/editor'
 import {debugWithName} from '../utils/debug'
-import {getPortableTextMemberSchemaTypes} from '../utils/getPortableTextMemberSchemaTypes'
 import {compileType} from '../utils/schema'
 import {Synchronizer} from './components/Synchronizer'
 import {createEditor, type Editor} from './create-editor'
+import {createEditorSchema} from './create-editor-schema'
 import {EditorActorContext} from './editor-actor-context'
 import type {EditorActor} from './editor-machine'
 import {PortableTextEditorContext} from './hooks/usePortableTextEditor'
@@ -158,7 +158,7 @@ export class PortableTextEditor extends Component<
       !prevProps.editor &&
       this.props.schemaType !== prevProps.schemaType
     ) {
-      this.schemaTypes = getPortableTextMemberSchemaTypes(
+      this.schemaTypes = createEditorSchema(
         this.props.schemaType.hasOwnProperty('jsonType')
           ? this.props.schemaType
           : compileType(this.props.schemaType),

package/src/{utils/getPortableTextMemberSchemaTypes.ts → editor/create-editor-schema.ts}

@@ -6,11 +6,11 @@ import type {
   SchemaType,
   SpanSchemaType,
 } from '@sanity/types'
-import type {PortableTextMemberSchemaTypes} from '../types/editor'
+import type {EditorSchema} from './define-schema'
 
-export function getPortableTextMemberSchemaTypes(
+export function createEditorSchema(
   portableTextType: ArraySchemaType<PortableTextBlock>,
-): PortableTextMemberSchemaTypes {
+): EditorSchema {
   if (!portableTextType) {
     throw new Error("Parameter 'portabletextType' missing (required)")
   }

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 {createEditorSchema} from './create-editor-schema'
 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) {
@@ -149,7 +107,7 @@ function editorConfigToMachineInput(config: EditorConfig) {
     readOnly: config.readOnly,
     schema: config.schemaDefinition
       ? compileSchemaDefinition(config.schemaDefinition)
-      : getPortableTextMemberSchemaTypes(
+      : createEditorSchema(
           config.schema.hasOwnProperty('jsonType')
             ? config.schema
             : compileType(config.schema),
@@ -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/define-schema.ts

@@ -7,7 +7,7 @@ import {
 } from '@sanity/types'
 import startCase from 'lodash.startcase'
 import type {PortableTextMemberSchemaTypes} from '../types/editor'
-import {getPortableTextMemberSchemaTypes} from '../utils/getPortableTextMemberSchemaTypes'
+import {createEditorSchema} from './create-editor-schema'
 
 /**
  * @alpha
@@ -41,6 +41,11 @@ export function defineSchema<const TSchemaDefinition extends SchemaDefinition>(
   return definition
 }
 
+/**
+ * @alpha
+ */
+export type EditorSchema = PortableTextMemberSchemaTypes
+
 export function compileSchemaDefinition<
   TSchemaDefinition extends SchemaDefinition,
 >(definition?: TSchemaDefinition) {
@@ -111,7 +116,7 @@ export function compileSchemaDefinition<
     types: [portableTextSchema, ...blockObjects, ...inlineObjects],
   }).get('portable-text')
 
-  const pteSchema = getPortableTextMemberSchemaTypes(schema)
+  const pteSchema = createEditorSchema(schema)
 
   return {
     ...pteSchema,
@@ -127,5 +132,5 @@ export function compileSchemaDefinition<
           } as ObjectSchemaType)
         : blockObject,
     ),
-  } satisfies PortableTextMemberSchemaTypes
+  } satisfies EditorSchema
 }

package/src/editor/editor-machine.ts

@@ -10,27 +10,26 @@ 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,
-  PortableTextMemberSchemaTypes,
   PortableTextSlateEditor,
 } from '../types/editor'
 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 {EditorSchema} from './define-schema'
 import type {EditorContext} from './editor-snapshot'
 
 export * from 'xstate/guards'
@@ -82,7 +81,7 @@ export type InternalEditorEvent =
     }
   | {
       type: 'update schema'
-      schema: PortableTextMemberSchemaTypes
+      schema: EditorSchema
     }
   | {
       type: 'update behaviors'
@@ -180,10 +179,10 @@ export const editorMachine = setup({
       behaviors: Array<Behavior>
       keyGenerator: () => string
       pendingEvents: Array<PatchEvent | MutationEvent>
-      schema: PortableTextMemberSchemaTypes
+      schema: EditorSchema
       readOnly: boolean
       maxBlocks: number | undefined
-      selection: NonNullable<EditorSelection> | undefined
+      selection: EditorSelection
       value: Array<PortableTextBlock> | undefined
     },
     events: {} as InternalEditorEvent,
@@ -193,7 +192,7 @@ export const editorMachine = setup({
       keyGenerator: () => string
       maxBlocks?: number
       readOnly?: boolean
-      schema: PortableTextMemberSchemaTypes
+      schema: EditorSchema
       value?: Array<PortableTextBlock>
     },
   },
@@ -276,23 +275,6 @@ export const editorMachine = setup({
         context.schema,
       )
 
-      if (!selection) {
-        console.warn(
-          `Unable to handle event ${event.type} due to missing selection`,
-        )
-
-        if (!defaultAction) {
-          return
-        }
-
-        enqueue.raise({
-          type: 'behavior action intends',
-          editor: event.editor,
-          actionIntends: [defaultAction],
-        })
-        return
-      }
-
       const editorContext = {
         keyGenerator: context.keyGenerator,
         schema: context.schema,
@@ -315,7 +297,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) {
@@ -359,7 +344,7 @@ export const editorMachine = setup({
     keyGenerator: input.keyGenerator,
     pendingEvents: [],
     schema: input.schema,
-    selection: undefined,
+    selection: null,
     readOnly: input.readOnly ?? false,
     maxBlocks: input.maxBlocks,
     value: input.value,
@@ -408,7 +393,7 @@ export const editorMachine = setup({
     'error': {actions: emit(({event}) => event)},
     'selection': {
       actions: [
-        assign({selection: ({event}) => event.selection ?? undefined}),
+        assign({selection: ({event}) => event.selection}),
         emit(({event}) => event),
       ],
     },

package/src/editor/editor-selector.ts

@@ -1,5 +1,4 @@
 import {useSelector} from '@xstate/react'
-import type {EditorSelection} from '../types/editor'
 import type {Editor} from './create-editor'
 import type {EditorSnapshot} from './editor-snapshot'
 import {getValue} from './get-value'
@@ -11,18 +10,7 @@ function defaultCompare<T>(a: T, b: T) {
 /**
  * @alpha
  */
-export type EditorSelectorSnapshot = {
-  context: Omit<EditorSnapshot['context'], 'selection'> & {
-    selection?: NonNullable<EditorSelection>
-  }
-}
-
-/**
- * @alpha
- */
-export type EditorSelector<TSelected> = (
-  snapshot: EditorSelectorSnapshot,
-) => TSelected
+export type EditorSelector<TSelected> = (snapshot: EditorSnapshot) => TSelected
 
 /**
  * @alpha