@portabletext/editor 1.1.6 → 1.1.8

package/lib/index.d.mts

@@ -15,7 +15,11 @@ import type {
   SpanSchemaType,
   TypedObject,
 } from '@sanity/types'
-import {PortableTextSpan, PortableTextTextBlock} from '@sanity/types'
+import {
+  KeyedSegment,
+  PortableTextSpan,
+  PortableTextTextBlock,
+} from '@sanity/types'
 import type {
   BaseSyntheticEvent,
   ClipboardEvent as ClipboardEvent_2,
@@ -87,6 +91,15 @@ export declare type BehaviorActionIntend =
       type: 'insert text block'
       decorators: Array<string>
     }
+  | {
+      type: 'apply block style'
+      paths: Array<[KeyedSegment]>
+      style: string
+    }
+  | {
+      type: 'delete text'
+      selection: NonNullable<EditorSelection>
+    }
 
 /**
  * @alpha
@@ -100,11 +113,17 @@ export declare type BehaviorContext = {
 /**
  * @alpha
  */
-export declare type BehaviorEvent = {
-  type: 'key down'
-  nativeEvent: KeyboardEvent
-  editor: PortableTextSlateEditor
-}
+export declare type BehaviorEvent =
+  | {
+      type: 'key down'
+      nativeEvent: KeyboardEvent
+      editor: PortableTextSlateEditor
+    }
+  | {
+      type: 'before insert text'
+      nativeEvent: InputEvent
+      editor: PortableTextSlateEditor
+    }
 
 /**
  * @alpha
@@ -223,6 +242,7 @@ export declare type ConnectionChange = {
  * @internal
  */
 export declare type createEditorOptions = {
+  editorActor: EditorActor
   patches$?: PatchObservable
   portableTextEditor: PortableTextEditor
   readOnly: boolean
@@ -339,7 +359,6 @@ export declare const editorMachine: StateMachine<
     pendingEvents: Array<PatchEvent | MutationEvent_2>
     schema: PortableTextMemberSchemaTypes
   },
-  | BehaviorEvent
   | ({
       type: 'insert text'
       text: string
@@ -352,6 +371,29 @@ export declare const editorMachine: StateMachine<
     } & {
       editor: PortableTextSlateEditor
     })
+  | ({
+      type: 'apply block style'
+      paths: Array<[KeyedSegment]>
+      style: string
+    } & {
+      editor: PortableTextSlateEditor
+    })
+  | ({
+      type: 'delete text'
+      selection: NonNullable<EditorSelection>
+    } & {
+      editor: PortableTextSlateEditor
+    })
+  | {
+      type: 'key down'
+      nativeEvent: KeyboardEvent
+      editor: PortableTextSlateEditor
+    }
+  | {
+      type: 'before insert text'
+      nativeEvent: InputEvent
+      editor: PortableTextSlateEditor
+    }
   | PatchEvent
   | MutationEvent_2
   | {
@@ -423,14 +465,6 @@ export declare const editorMachine: StateMachine<
     id: string | undefined
   },
   Values<{
-    'apply:insert text': {
-      type: 'apply:insert text'
-      params: unknown
-    }
-    'apply:insert text block': {
-      type: 'apply:insert text block'
-      params: unknown
-    }
     'assign schema': {
       type: 'assign schema'
       params: NonReducibleUnknown
@@ -607,7 +641,6 @@ export declare const editorMachine: StateMachine<
             pendingEvents: Array<PatchEvent | MutationEvent_2>
             schema: PortableTextMemberSchemaTypes
           },
-          | BehaviorEvent
           | ({
               type: 'insert text'
               text: string
@@ -620,6 +653,29 @@ export declare const editorMachine: StateMachine<
             } & {
               editor: PortableTextSlateEditor
             })
+          | ({
+              type: 'apply block style'
+              paths: Array<[KeyedSegment]>
+              style: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'delete text'
+              selection: NonNullable<EditorSelection>
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | {
+              type: 'key down'
+              nativeEvent: KeyboardEvent
+              editor: PortableTextSlateEditor
+            }
+          | {
+              type: 'before insert text'
+              nativeEvent: InputEvent
+              editor: PortableTextSlateEditor
+            }
           | PatchEvent
           | MutationEvent_2
           | {
@@ -685,7 +741,6 @@ export declare const editorMachine: StateMachine<
           any,
           any
         >,
-        | BehaviorEvent
         | ({
             type: 'insert text'
             text: string
@@ -698,6 +753,29 @@ export declare const editorMachine: StateMachine<
           } & {
             editor: PortableTextSlateEditor
           })
+        | ({
+            type: 'apply block style'
+            paths: Array<[KeyedSegment]>
+            style: string
+          } & {
+            editor: PortableTextSlateEditor
+          })
+        | ({
+            type: 'delete text'
+            selection: NonNullable<EditorSelection>
+          } & {
+            editor: PortableTextSlateEditor
+          })
+        | {
+            type: 'key down'
+            nativeEvent: KeyboardEvent
+            editor: PortableTextSlateEditor
+          }
+        | {
+            type: 'before insert text'
+            nativeEvent: InputEvent
+            editor: PortableTextSlateEditor
+          }
         | PatchEvent
         | MutationEvent_2
         | {
@@ -780,7 +858,6 @@ export declare const editorMachine: StateMachine<
           {
             type: 'ready'
           },
-          | BehaviorEvent
           | ({
               type: 'insert text'
               text: string
@@ -793,6 +870,29 @@ export declare const editorMachine: StateMachine<
             } & {
               editor: PortableTextSlateEditor
             })
+          | ({
+              type: 'apply block style'
+              paths: Array<[KeyedSegment]>
+              style: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'delete text'
+              selection: NonNullable<EditorSelection>
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | {
+              type: 'key down'
+              nativeEvent: KeyboardEvent
+              editor: PortableTextSlateEditor
+            }
+          | {
+              type: 'before insert text'
+              nativeEvent: InputEvent
+              editor: PortableTextSlateEditor
+            }
           | PatchEvent
           | MutationEvent_2
           | {
@@ -918,7 +1018,6 @@ export declare const editorMachine: StateMachine<
             type: 'unset'
             previousValue: Array<PortableTextBlock>
           },
-          | BehaviorEvent
           | ({
               type: 'insert text'
               text: string
@@ -931,6 +1030,29 @@ export declare const editorMachine: StateMachine<
             } & {
               editor: PortableTextSlateEditor
             })
+          | ({
+              type: 'apply block style'
+              paths: Array<[KeyedSegment]>
+              style: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'delete text'
+              selection: NonNullable<EditorSelection>
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | {
+              type: 'key down'
+              nativeEvent: KeyboardEvent
+              editor: PortableTextSlateEditor
+            }
+          | {
+              type: 'before insert text'
+              nativeEvent: InputEvent
+              editor: PortableTextSlateEditor
+            }
           | PatchEvent
           | MutationEvent_2
           | {
@@ -1056,7 +1178,6 @@ export declare const editorMachine: StateMachine<
             type: 'value changed'
             value: Array<PortableTextBlock> | undefined
           },
-          | BehaviorEvent
           | ({
               type: 'insert text'
               text: string
@@ -1069,6 +1190,29 @@ export declare const editorMachine: StateMachine<
             } & {
               editor: PortableTextSlateEditor
             })
+          | ({
+              type: 'apply block style'
+              paths: Array<[KeyedSegment]>
+              style: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'delete text'
+              selection: NonNullable<EditorSelection>
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | {
+              type: 'key down'
+              nativeEvent: KeyboardEvent
+              editor: PortableTextSlateEditor
+            }
+          | {
+              type: 'before insert text'
+              nativeEvent: InputEvent
+              editor: PortableTextSlateEditor
+            }
           | PatchEvent
           | MutationEvent_2
           | {
@@ -1195,7 +1339,6 @@ export declare const editorMachine: StateMachine<
             resolution: InvalidValueResolution | null
             value: Array<PortableTextBlock> | undefined
           },
-          | BehaviorEvent
           | ({
               type: 'insert text'
               text: string
@@ -1208,6 +1351,29 @@ export declare const editorMachine: StateMachine<
             } & {
               editor: PortableTextSlateEditor
             })
+          | ({
+              type: 'apply block style'
+              paths: Array<[KeyedSegment]>
+              style: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'delete text'
+              selection: NonNullable<EditorSelection>
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | {
+              type: 'key down'
+              nativeEvent: KeyboardEvent
+              editor: PortableTextSlateEditor
+            }
+          | {
+              type: 'before insert text'
+              nativeEvent: InputEvent
+              editor: PortableTextSlateEditor
+            }
           | PatchEvent
           | MutationEvent_2
           | {
@@ -1335,7 +1501,6 @@ export declare const editorMachine: StateMachine<
             description: string
             data: unknown
           },
-          | BehaviorEvent
           | ({
               type: 'insert text'
               text: string
@@ -1348,6 +1513,29 @@ export declare const editorMachine: StateMachine<
             } & {
               editor: PortableTextSlateEditor
             })
+          | ({
+              type: 'apply block style'
+              paths: Array<[KeyedSegment]>
+              style: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'delete text'
+              selection: NonNullable<EditorSelection>
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | {
+              type: 'key down'
+              nativeEvent: KeyboardEvent
+              editor: PortableTextSlateEditor
+            }
+          | {
+              type: 'before insert text'
+              nativeEvent: InputEvent
+              editor: PortableTextSlateEditor
+            }
           | PatchEvent
           | MutationEvent_2
           | {
@@ -1473,7 +1661,6 @@ export declare const editorMachine: StateMachine<
             type: 'selection'
             selection: EditorSelection
           },
-          | BehaviorEvent
           | ({
               type: 'insert text'
               text: string
@@ -1486,6 +1673,29 @@ export declare const editorMachine: StateMachine<
             } & {
               editor: PortableTextSlateEditor
             })
+          | ({
+              type: 'apply block style'
+              paths: Array<[KeyedSegment]>
+              style: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'delete text'
+              selection: NonNullable<EditorSelection>
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | {
+              type: 'key down'
+              nativeEvent: KeyboardEvent
+              editor: PortableTextSlateEditor
+            }
+          | {
+              type: 'before insert text'
+              nativeEvent: InputEvent
+              editor: PortableTextSlateEditor
+            }
           | PatchEvent
           | MutationEvent_2
           | {
@@ -1611,7 +1821,6 @@ export declare const editorMachine: StateMachine<
             type: 'blur'
             event: FocusEvent_2<HTMLDivElement, Element>
           },
-          | BehaviorEvent
           | ({
               type: 'insert text'
               text: string
@@ -1624,6 +1833,29 @@ export declare const editorMachine: StateMachine<
             } & {
               editor: PortableTextSlateEditor
             })
+          | ({
+              type: 'apply block style'
+              paths: Array<[KeyedSegment]>
+              style: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'delete text'
+              selection: NonNullable<EditorSelection>
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | {
+              type: 'key down'
+              nativeEvent: KeyboardEvent
+              editor: PortableTextSlateEditor
+            }
+          | {
+              type: 'before insert text'
+              nativeEvent: InputEvent
+              editor: PortableTextSlateEditor
+            }
           | PatchEvent
           | MutationEvent_2
           | {
@@ -1749,7 +1981,6 @@ export declare const editorMachine: StateMachine<
             type: 'focus'
             event: FocusEvent_2<HTMLDivElement, Element>
           },
-          | BehaviorEvent
           | ({
               type: 'insert text'
               text: string
@@ -1762,6 +1993,29 @@ export declare const editorMachine: StateMachine<
             } & {
               editor: PortableTextSlateEditor
             })
+          | ({
+              type: 'apply block style'
+              paths: Array<[KeyedSegment]>
+              style: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'delete text'
+              selection: NonNullable<EditorSelection>
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | {
+              type: 'key down'
+              nativeEvent: KeyboardEvent
+              editor: PortableTextSlateEditor
+            }
+          | {
+              type: 'before insert text'
+              nativeEvent: InputEvent
+              editor: PortableTextSlateEditor
+            }
           | PatchEvent
           | MutationEvent_2
           | {
@@ -1886,7 +2140,6 @@ export declare const editorMachine: StateMachine<
           {
             type: 'online'
           },
-          | BehaviorEvent
           | ({
               type: 'insert text'
               text: string
@@ -1899,6 +2152,29 @@ export declare const editorMachine: StateMachine<
             } & {
               editor: PortableTextSlateEditor
             })
+          | ({
+              type: 'apply block style'
+              paths: Array<[KeyedSegment]>
+              style: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'delete text'
+              selection: NonNullable<EditorSelection>
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | {
+              type: 'key down'
+              nativeEvent: KeyboardEvent
+              editor: PortableTextSlateEditor
+            }
+          | {
+              type: 'before insert text'
+              nativeEvent: InputEvent
+              editor: PortableTextSlateEditor
+            }
           | PatchEvent
           | MutationEvent_2
           | {
@@ -2023,7 +2299,6 @@ export declare const editorMachine: StateMachine<
           {
             type: 'offline'
           },
-          | BehaviorEvent
           | ({
               type: 'insert text'
               text: string
@@ -2036,6 +2311,29 @@ export declare const editorMachine: StateMachine<
             } & {
               editor: PortableTextSlateEditor
             })
+          | ({
+              type: 'apply block style'
+              paths: Array<[KeyedSegment]>
+              style: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'delete text'
+              selection: NonNullable<EditorSelection>
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | {
+              type: 'key down'
+              nativeEvent: KeyboardEvent
+              editor: PortableTextSlateEditor
+            }
+          | {
+              type: 'before insert text'
+              nativeEvent: InputEvent
+              editor: PortableTextSlateEditor
+            }
           | PatchEvent
           | MutationEvent_2
           | {
@@ -2160,7 +2458,6 @@ export declare const editorMachine: StateMachine<
           {
             type: 'loading'
           },
-          | BehaviorEvent
           | ({
               type: 'insert text'
               text: string
@@ -2173,6 +2470,29 @@ export declare const editorMachine: StateMachine<
             } & {
               editor: PortableTextSlateEditor
             })
+          | ({
+              type: 'apply block style'
+              paths: Array<[KeyedSegment]>
+              style: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'delete text'
+              selection: NonNullable<EditorSelection>
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | {
+              type: 'key down'
+              nativeEvent: KeyboardEvent
+              editor: PortableTextSlateEditor
+            }
+          | {
+              type: 'before insert text'
+              nativeEvent: InputEvent
+              editor: PortableTextSlateEditor
+            }
           | PatchEvent
           | MutationEvent_2
           | {
@@ -2297,7 +2617,6 @@ export declare const editorMachine: StateMachine<
           {
             type: 'done loading'
           },
-          | BehaviorEvent
           | ({
               type: 'insert text'
               text: string
@@ -2310,6 +2629,29 @@ export declare const editorMachine: StateMachine<
             } & {
               editor: PortableTextSlateEditor
             })
+          | ({
+              type: 'apply block style'
+              paths: Array<[KeyedSegment]>
+              style: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'delete text'
+              selection: NonNullable<EditorSelection>
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | {
+              type: 'key down'
+              nativeEvent: KeyboardEvent
+              editor: PortableTextSlateEditor
+            }
+          | {
+              type: 'before insert text'
+              nativeEvent: InputEvent
+              editor: PortableTextSlateEditor
+            }
           | PatchEvent
           | MutationEvent_2
           | {
@@ -2429,11 +2771,85 @@ export declare const editorMachine: StateMachine<
       readonly 'key down': {
         readonly actions: readonly ['handle behavior event']
       }
+      readonly 'before insert text': {
+        readonly actions: readonly ['handle behavior event']
+      }
+      readonly 'apply block style': {
+        readonly actions: readonly [
+          ({
+            context,
+            event,
+          }: {
+            context: {
+              keyGenerator: () => string
+              schema: PortableTextMemberSchemaTypes
+            }
+            event: {
+              type: 'apply block style'
+              paths: Array<[KeyedSegment]>
+              style: string
+            } & {
+              editor: PortableTextSlateEditor
+            }
+          }) => void,
+        ]
+      }
+      readonly 'delete text': {
+        readonly actions: readonly [
+          ({
+            context,
+            event,
+          }: {
+            context: {
+              keyGenerator: () => string
+              schema: PortableTextMemberSchemaTypes
+            }
+            event: {
+              type: 'delete text'
+              selection: NonNullable<EditorSelection>
+            } & {
+              editor: PortableTextSlateEditor
+            }
+          }) => void,
+        ]
+      }
       readonly 'insert text': {
-        readonly actions: readonly ['apply:insert text']
+        readonly actions: readonly [
+          ({
+            context,
+            event,
+          }: {
+            context: {
+              keyGenerator: () => string
+              schema: PortableTextMemberSchemaTypes
+            }
+            event: {
+              type: 'insert text'
+              text: string
+            } & {
+              editor: PortableTextSlateEditor
+            }
+          }) => void,
+        ]
       }
       readonly 'insert text block': {
-        readonly actions: readonly ['apply:insert text block']
+        readonly actions: readonly [
+          ({
+            context,
+            event,
+          }: {
+            context: {
+              keyGenerator: () => string
+              schema: PortableTextMemberSchemaTypes
+            }
+            event: {
+              type: 'insert text block'
+              decorators: Array<string>
+            } & {
+              editor: PortableTextSlateEditor
+            }
+          }) => void,
+        ]
       }
     }
     readonly initial: 'pristine'
@@ -2723,11 +3139,6 @@ export declare type PortableTextEditableProps = Omit<
  * @public
  */
 export declare class PortableTextEditor extends Component<PortableTextEditorProps> {
-  /**
-   * @internal
-   * Don't use this API directly. It's subject to change.
-   */
-  editorActor: EditorActor
   /**
    * An observable of all the editor changes.
    */
@@ -2740,6 +3151,7 @@ export declare class PortableTextEditor extends Component<PortableTextEditorProp
    * The editor API (currently implemented with Slate).
    */
   private editable?
+  private editorActor
   constructor(props: PortableTextEditorProps)
   componentDidUpdate(prevProps: PortableTextEditorProps): void
   setEditable: (editable: EditableAPI) => void
@@ -2789,9 +3201,9 @@ export declare class PortableTextEditor extends Component<PortableTextEditorProp
     | []
     | [
         (
-          | PortableTextTextBlock<PortableTextObject | PortableTextSpan>
-          | PortableTextObject
           | PortableTextSpan
+          | PortableTextObject
+          | PortableTextTextBlock<PortableTextSpan | PortableTextObject>
           | undefined
         ),
         Path | undefined,