@portabletext/editor 1.27.0 → 1.30.0

package/lib/index.d.ts

@@ -722,6 +722,10 @@ declare const editorMachine: StateMachine<
       type: 'decorator.toggle'
       decorator: string
     }
+  | {
+      type: 'delete'
+      selection: NonNullable<EditorSelection>
+    }
   | {
       type: 'delete.backward'
       unit: TextUnit
@@ -1142,6 +1146,10 @@ declare const editorMachine: StateMachine<
       type: 'decorator.toggle'
       decorator: string
     }
+  | {
+      type: 'delete'
+      selection: NonNullable<EditorSelection>
+    }
   | {
       type: 'delete.backward'
       unit: TextUnit
@@ -1462,6 +1470,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -1807,6 +1819,10 @@ declare const editorMachine: StateMachine<
             type: 'decorator.toggle'
             decorator: string
           }
+        | {
+            type: 'delete'
+            selection: NonNullable<EditorSelection>
+          }
         | {
             type: 'delete.backward'
             unit: TextUnit
@@ -2176,6 +2192,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -2519,6 +2539,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -2807,6 +2831,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -3150,6 +3178,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -3441,6 +3473,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -3784,6 +3820,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -4074,6 +4114,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -4417,6 +4461,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -4706,6 +4754,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -5049,6 +5101,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -5339,6 +5395,10 @@ declare const editorMachine: StateMachine<
                 type: 'decorator.toggle'
                 decorator: string
               }
+            | {
+                type: 'delete'
+                selection: NonNullable<EditorSelection>
+              }
             | {
                 type: 'delete.backward'
                 unit: TextUnit
@@ -5700,6 +5760,10 @@ declare const editorMachine: StateMachine<
                 type: 'decorator.toggle'
                 decorator: string
               }
+            | {
+                type: 'delete'
+                selection: NonNullable<EditorSelection>
+              }
             | {
                 type: 'delete.backward'
                 unit: TextUnit
@@ -6043,6 +6107,10 @@ declare const editorMachine: StateMachine<
                 type: 'decorator.toggle'
                 decorator: string
               }
+            | {
+                type: 'delete'
+                selection: NonNullable<EditorSelection>
+              }
             | {
                 type: 'delete.backward'
                 unit: TextUnit
@@ -6333,6 +6401,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -6676,6 +6748,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -6964,6 +7040,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -7307,6 +7387,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -7596,6 +7680,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -7939,6 +8027,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -8231,6 +8323,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -8574,6 +8670,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -8866,6 +8966,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -9232,6 +9336,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -9595,6 +9703,10 @@ declare const editorMachine: StateMachine<
               type: 'decorator.toggle'
               decorator: string
             }
+          | {
+              type: 'delete'
+              selection: NonNullable<EditorSelection>
+            }
           | {
               type: 'delete.backward'
               unit: TextUnit
@@ -10106,6 +10218,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -10451,6 +10567,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -10746,6 +10866,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -11091,6 +11215,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -11379,6 +11507,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -11724,6 +11856,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -12012,6 +12148,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -12357,6 +12497,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -12654,6 +12798,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -12999,6 +13147,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -13301,6 +13453,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -13646,6 +13802,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -13934,6 +14094,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -14279,6 +14443,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -14621,6 +14789,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -14966,6 +15138,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -15263,6 +15439,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -15608,6 +15788,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -15906,6 +16090,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -16251,6 +16439,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -16540,6 +16732,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -16885,6 +17081,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -17176,6 +17376,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -17521,6 +17725,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -17818,6 +18026,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -18163,6 +18375,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -18460,6 +18676,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -18805,6 +19025,10 @@ declare const editorMachine: StateMachine<
                       type: 'decorator.toggle'
                       decorator: string
                     }
+                  | {
+                      type: 'delete'
+                      selection: NonNullable<EditorSelection>
+                    }
                   | {
                       type: 'delete.backward'
                       unit: TextUnit
@@ -19509,11 +19733,46 @@ export declare class PortableTextEditor extends Component<
   componentDidUpdate(prevProps: PortableTextEditorProps): void
   setEditable: (editable: EditableAPI) => void
   render(): JSX.Element
+  /**
+   * @deprecated
+   * Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/
+   *
+   * ```
+   * import * as selectors from '@portabletext/editor/selectors'
+   * const editor = useEditor()
+   * const isActive = useEditorSelector(editor, selectors.getActiveAnnotations)
+   * ```
+   */
   static activeAnnotations: (editor: PortableTextEditor) => PortableTextObject[]
+  /**
+   * @deprecated
+   * Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/
+   *
+   * ```
+   * import * as selectors from '@portabletext/editor/selectors'
+   * const editor = useEditor()
+   * const isActive = useEditorSelector(editor, selectors.isActiveAnnotation(...))
+   * ```
+   */
   static isAnnotationActive: (
     editor: PortableTextEditor,
     annotationType: PortableTextObject['_type'],
   ) => boolean
+  /**
+   * @deprecated
+   * Use `editor.send(...)` instead
+   *
+   * ```
+   * const editor = useEditor()
+   * editor.send({
+   *  type: 'annotation.add',
+   *  annotation: {
+   *    name: '...',
+   *    value: {...},
+   *  }
+   * })
+   * ```
+   */
   static addAnnotation: <
     TSchemaType extends {
       name: string
@@ -19525,6 +19784,17 @@ export declare class PortableTextEditor extends Component<
       [prop: string]: unknown
     },
   ) => AddedAnnotationPaths | undefined
+  /**
+   * @deprecated
+   * Use `editor.send(...)` instead
+   *
+   * ```
+   * const editor = useEditor()
+   * editor.send({
+   *  type: 'blur',
+   * })
+   * ```
+   */
   static blur: (editor: PortableTextEditor) => void
   static delete: (
     editor: PortableTextEditor,
@@ -19547,28 +19817,150 @@ export declare class PortableTextEditor extends Component<
     ),
     Path | undefined,
   ]
+  /**
+   * @deprecated
+   * Use `editor.send(...)` instead
+   *
+   * ```
+   * const editor = useEditor()
+   * editor.send({
+   *  type: 'focus',
+   * })
+   * ```
+   */
   static focus: (editor: PortableTextEditor) => void
+  /**
+   * @deprecated
+   * Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/
+   *
+   * ```
+   * import * as selectors from '@portabletext/editor/selectors'
+   * const editor = useEditor()
+   * const focusBlock = useEditorSelector(editor, selectors.getFocusBlock)
+   * ```
+   */
   static focusBlock: (
     editor: PortableTextEditor,
   ) => PortableTextBlock | undefined
+  /**
+   * @deprecated
+   * Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/
+   *
+   * ```
+   * import * as selectors from '@portabletext/editor/selectors'
+   * const editor = useEditor()
+   * const focusChild = useEditorSelector(editor, selectors.getFocusChild)
+   * ```
+   */
   static focusChild: (
     editor: PortableTextEditor,
   ) => PortableTextChild | undefined
+  /**
+   * @deprecated
+   * Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/
+   *
+   * ```
+   * import * as selectors from '@portabletext/editor/selectors'
+   * const editor = useEditor()
+   * const selection = useEditorSelector(editor, selectors.getSelection)
+   * ```
+   */
   static getSelection: (editor: PortableTextEditor) => EditorSelection
+  /**
+   * @deprecated
+   * Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/
+   *
+   * ```
+   * import * as selectors from '@portabletext/editor/selectors'
+   * const editor = useEditor()
+   * const value = useEditorSelector(editor, selectors.getValue)
+   * ```
+   */
   static getValue: (
     editor: PortableTextEditor,
   ) => PortableTextBlock[] | undefined
+  /**
+   * @deprecated
+   * Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/
+   *
+   * ```
+   * import * as selectors from '@portabletext/editor/selectors'
+   * const editor = useEditor()
+   * const isActive = useEditorSelector(editor, selectors.isActiveStyle(...))
+   * ```
+   */
   static hasBlockStyle: (
     editor: PortableTextEditor,
     blockStyle: string,
   ) => boolean
+  /**
+   * @deprecated
+   * Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/
+   *
+   * ```
+   * import * as selectors from '@portabletext/editor/selectors'
+   * const editor = useEditor()
+   * const isActive = useEditorSelector(editor, selectors.isActiveListItem(...))
+   * ```
+   */
   static hasListStyle: (
     editor: PortableTextEditor,
     listStyle: string,
   ) => boolean
+  /**
+   * @deprecated
+   * Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/
+   *
+   * ```
+   * import * as selectors from '@portabletext/editor/selectors'
+   * const editor = useEditor()
+   * const isSelectionCollapsed = useEditorSelector(editor, selectors.isSelectionCollapsed)
+   * ```
+   */
   static isCollapsedSelection: (editor: PortableTextEditor) => boolean
+  /**
+   * @deprecated
+   * Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/
+   *
+   * ```
+   * import * as selectors from '@portabletext/editor/selectors'
+   * const editor = useEditor()
+   * const isSelectionExpanded = useEditorSelector(editor, selectors.isSelectionExpanded)
+   * ```
+   */
   static isExpandedSelection: (editor: PortableTextEditor) => boolean
+  /**
+   * @deprecated
+   * Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/
+   *
+   * ```
+   * import * as selectors from '@portabletext/editor/selectors'
+   * const editor = useEditor()
+   * const isActive = useEditorSelector(editor, selectors.isActiveDecorator(...))
+   * ```
+   */
   static isMarkActive: (editor: PortableTextEditor, mark: string) => boolean
+  /**
+   * @deprecated
+   * Use `editor.send(...)` instead
+   *
+   * ```
+   * const editor = useEditor()
+   * editor.send({
+   *  type: 'insert.span',
+   *  text: '...',
+   *  annotations: [{name: '...', value: {...}}],
+   *  decorators: ['...'],
+   * })
+   * editor.send({
+   *  type: 'insert.inline object',
+   *  inlineObject: {
+   *    name: '...',
+   *    value: {...},
+   *  },
+   * })
+   * ```
+   */
   static insertChild: <
     TSchemaType extends {
       name: string
@@ -19580,6 +19972,22 @@ export declare class PortableTextEditor extends Component<
       [prop: string]: unknown
     },
   ) => Path | undefined
+  /**
+   * @deprecated
+   * Use `editor.send(...)` instead
+   *
+   * ```
+   * const editor = useEditor()
+   * editor.send({
+   *  type: 'insert.block object',
+   *  blockObject: {
+   *    name: '...',
+   *    value: {...},
+   *  },
+   *  placement: 'auto' | 'after' | 'before',
+   * })
+   * ```
+   */
   static insertBlock: <
     TSchemaType extends {
       name: string
@@ -19591,6 +19999,17 @@ export declare class PortableTextEditor extends Component<
       [prop: string]: unknown
     },
   ) => Path | undefined
+  /**
+   * @deprecated
+   * Use `editor.send(...)` instead
+   *
+   * ```
+   * const editor = useEditor()
+   * editor.send({
+   *  type: 'insert.break',
+   * })
+   * ```
+   */
   static insertBreak: (editor: PortableTextEditor) => void
   static isVoid: (
     editor: PortableTextEditor,
@@ -19598,10 +20017,36 @@ export declare class PortableTextEditor extends Component<
   ) => boolean
   static isObjectPath: (_editor: PortableTextEditor, path: Path) => boolean
   static marks: (editor: PortableTextEditor) => string[]
+  /**
+   * @deprecated
+   * Use `editor.send(...)` instead
+   *
+   * ```
+   * const editor = useEditor()
+   * editor.send({
+   *  type: 'select',
+   *  selection: {...},
+   * })
+   * ```
+   */
   static select: (
     editor: PortableTextEditor,
     selection: EditorSelection | null,
   ) => void
+  /**
+   * @deprecated
+   * Use `editor.send(...)` instead
+   *
+   * ```
+   * const editor = useEditor()
+   * editor.send({
+   *  type: 'annotation.remove',
+   *  annotation: {
+   *    name: '...',
+   *  },
+   * })
+   * ```
+   */
   static removeAnnotation: <
     TSchemaType extends {
       name: string
@@ -19610,17 +20055,73 @@ export declare class PortableTextEditor extends Component<
     editor: PortableTextEditor,
     type: TSchemaType,
   ) => void
+  /**
+   * @deprecated
+   * Use `editor.send(...)` instead
+   *
+   * ```
+   * const editor = useEditor()
+   * editor.send({
+   *  type: 'style.toggle',
+   *  style: '...',
+   * })
+   * ```
+   */
   static toggleBlockStyle: (
     editor: PortableTextEditor,
     blockStyle: string,
   ) => void
+  /**
+   * @deprecated
+   * Use `editor.send(...)` instead
+   *
+   * ```
+   * const editor = useEditor()
+   * editor.send({
+   *  type: 'list item.toggle',
+   *  listItem: '...',
+   * })
+   * ```
+   */
   static toggleList: (editor: PortableTextEditor, listStyle: string) => void
+  /**
+   * @deprecated
+   * Use `editor.send(...)` instead
+   *
+   * ```
+   * const editor = useEditor()
+   * editor.send({
+   *  type: 'decorator.toggle',
+   *  decorator: '...',
+   * })
+   * ```
+   */
   static toggleMark: (editor: PortableTextEditor, mark: string) => void
+  /**
+   * @deprecated
+   * Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/
+   *
+   * ```
+   * import * as selectors from '@portabletext/editor/selectors'
+   * const editor = useEditor()
+   * const selectedSlice = useEditorSelector(editor, selectors.getSelectedSlice)
+   * ```
+   */
   static getFragment: (
     editor: PortableTextEditor,
   ) => PortableTextBlock[] | undefined
   static undo: (editor: PortableTextEditor) => void
   static redo: (editor: PortableTextEditor) => void
+  /**
+   * @deprecated
+   * Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/
+   *
+   * ```
+   * import * as selectors from '@portabletext/editor/selectors'
+   * const editor = useEditor()
+   * const isOverlapping = useEditorSelector(editor, selectors.isOverlappingSelection(selectionB))
+   * ```
+   */
   static isSelectionsOverlapping: (
     editor: PortableTextEditor,
     selectionA: EditorSelection,
@@ -19944,6 +20445,10 @@ export declare type SyntheticBehaviorEvent =
       type: 'decorator.toggle'
       decorator: string
     }
+  | {
+      type: 'delete'
+      selection: NonNullable<EditorSelection>
+    }
   | {
       type: 'delete.backward'
       unit: TextUnit