@portabletext/editor 1.18.7 → 1.19.0

package/lib/behaviors/index.d.cts

@@ -43,6 +43,27 @@ export declare type Behavior<
  */
 export declare type BehaviorActionIntend =
   | SyntheticBehaviorEvent
+  | {
+      type: 'raise'
+      event: SyntheticBehaviorEvent
+    }
+  | {
+      type: 'annotation.toggle'
+      annotation: {
+        name: string
+        value: {
+          [prop: string]: unknown
+        }
+      }
+    }
+  | {
+      type: 'decorator.add'
+      decorator: string
+    }
+  | {
+      type: 'decorator.remove'
+      decorator: string
+    }
   | {
       type: 'insert.span'
       text: string
@@ -98,13 +119,6 @@ export declare type BehaviorActionIntend =
       type: 'effect'
       effect: () => void
     }
-  | {
-      type: 'reselect'
-    }
-  | {
-      type: 'select'
-      selection: EditorSelection
-    }
   | {
       type: 'select.previous block'
     }
@@ -191,10 +205,7 @@ export declare const coreBehavior: {
   softReturn: Behavior<
     | 'annotation.add'
     | 'annotation.remove'
-    | 'annotation.toggle'
     | 'blur'
-    | 'decorator.add'
-    | 'decorator.remove'
     | 'decorator.toggle'
     | 'delete.backward'
     | 'delete.forward'
@@ -205,6 +216,7 @@ export declare const coreBehavior: {
     | 'insert.soft break'
     | 'insert.text'
     | 'list item.toggle'
+    | 'select'
     | 'style.toggle'
     | 'copy'
     | 'key.down'
@@ -213,13 +225,32 @@ export declare const coreBehavior: {
     true
   >
   decorators: {
-    decoratorAdd: Behavior<
+    strongShortcut: Behavior<
+      | 'annotation.add'
+      | 'annotation.remove'
+      | 'blur'
+      | 'decorator.toggle'
+      | 'delete.backward'
+      | 'delete.forward'
+      | 'focus'
+      | 'insert.block object'
+      | 'insert.inline object'
+      | 'insert.break'
+      | 'insert.soft break'
+      | 'insert.text'
+      | 'list item.toggle'
+      | 'select'
+      | 'style.toggle'
+      | 'copy'
+      | 'key.down'
+      | 'key.up'
+      | 'paste',
+      true
+    >
+    emShortcut: Behavior<
       | 'annotation.add'
       | 'annotation.remove'
-      | 'annotation.toggle'
       | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
       | 'decorator.toggle'
       | 'delete.backward'
       | 'delete.forward'
@@ -230,6 +261,7 @@ export declare const coreBehavior: {
       | 'insert.soft break'
       | 'insert.text'
       | 'list item.toggle'
+      | 'select'
       | 'style.toggle'
       | 'copy'
       | 'key.down'
@@ -237,13 +269,10 @@ export declare const coreBehavior: {
       | 'paste',
       true
     >
-    decoratorRemove: Behavior<
+    underlineShortcut: Behavior<
       | 'annotation.add'
       | 'annotation.remove'
-      | 'annotation.toggle'
       | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
       | 'decorator.toggle'
       | 'delete.backward'
       | 'delete.forward'
@@ -254,6 +283,7 @@ export declare const coreBehavior: {
       | 'insert.soft break'
       | 'insert.text'
       | 'list item.toggle'
+      | 'select'
       | 'style.toggle'
       | 'copy'
       | 'key.down'
@@ -261,13 +291,10 @@ export declare const coreBehavior: {
       | 'paste',
       true
     >
-    decoratorToggle: Behavior<
+    codeShortcut: Behavior<
       | 'annotation.add'
       | 'annotation.remove'
-      | 'annotation.toggle'
       | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
       | 'decorator.toggle'
       | 'delete.backward'
       | 'delete.forward'
@@ -278,6 +305,7 @@ export declare const coreBehavior: {
       | 'insert.soft break'
       | 'insert.text'
       | 'list item.toggle'
+      | 'select'
       | 'style.toggle'
       | 'copy'
       | 'key.down'
@@ -290,10 +318,7 @@ export declare const coreBehavior: {
     arrowDownOnLonelyBlockObject: Behavior<
       | 'annotation.add'
       | 'annotation.remove'
-      | 'annotation.toggle'
       | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
       | 'decorator.toggle'
       | 'delete.backward'
       | 'delete.forward'
@@ -304,6 +329,7 @@ export declare const coreBehavior: {
       | 'insert.soft break'
       | 'insert.text'
       | 'list item.toggle'
+      | 'select'
       | 'style.toggle'
       | 'copy'
       | 'key.down'
@@ -314,10 +340,7 @@ export declare const coreBehavior: {
     arrowUpOnLonelyBlockObject: Behavior<
       | 'annotation.add'
       | 'annotation.remove'
-      | 'annotation.toggle'
       | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
       | 'decorator.toggle'
       | 'delete.backward'
       | 'delete.forward'
@@ -328,6 +351,7 @@ export declare const coreBehavior: {
       | 'insert.soft break'
       | 'insert.text'
       | 'list item.toggle'
+      | 'select'
       | 'style.toggle'
       | 'copy'
       | 'key.down'
@@ -338,10 +362,7 @@ export declare const coreBehavior: {
     breakingBlockObject: Behavior<
       | 'annotation.add'
       | 'annotation.remove'
-      | 'annotation.toggle'
       | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
       | 'decorator.toggle'
       | 'delete.backward'
       | 'delete.forward'
@@ -352,6 +373,7 @@ export declare const coreBehavior: {
       | 'insert.soft break'
       | 'insert.text'
       | 'list item.toggle'
+      | 'select'
       | 'style.toggle'
       | 'copy'
       | 'key.down'
@@ -362,10 +384,7 @@ export declare const coreBehavior: {
     deletingEmptyTextBlockAfterBlockObject: Behavior<
       | 'annotation.add'
       | 'annotation.remove'
-      | 'annotation.toggle'
       | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
       | 'decorator.toggle'
       | 'delete.backward'
       | 'delete.forward'
@@ -376,6 +395,7 @@ export declare const coreBehavior: {
       | 'insert.soft break'
       | 'insert.text'
       | 'list item.toggle'
+      | 'select'
       | 'style.toggle'
       | 'copy'
       | 'key.down'
@@ -386,10 +406,7 @@ export declare const coreBehavior: {
     deletingEmptyTextBlockBeforeBlockObject: Behavior<
       | 'annotation.add'
       | 'annotation.remove'
-      | 'annotation.toggle'
       | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
       | 'decorator.toggle'
       | 'delete.backward'
       | 'delete.forward'
@@ -400,6 +417,7 @@ export declare const coreBehavior: {
       | 'insert.soft break'
       | 'insert.text'
       | 'list item.toggle'
+      | 'select'
       | 'style.toggle'
       | 'copy'
       | 'key.down'
@@ -412,10 +430,7 @@ export declare const coreBehavior: {
     clearListOnBackspace: Behavior<
       | 'annotation.add'
       | 'annotation.remove'
-      | 'annotation.toggle'
       | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
       | 'decorator.toggle'
       | 'delete.backward'
       | 'delete.forward'
@@ -426,6 +441,7 @@ export declare const coreBehavior: {
       | 'insert.soft break'
       | 'insert.text'
       | 'list item.toggle'
+      | 'select'
       | 'style.toggle'
       | 'copy'
       | 'key.down'
@@ -436,10 +452,7 @@ export declare const coreBehavior: {
     unindentListOnBackspace: Behavior<
       | 'annotation.add'
       | 'annotation.remove'
-      | 'annotation.toggle'
       | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
       | 'decorator.toggle'
       | 'delete.backward'
       | 'delete.forward'
@@ -450,6 +463,7 @@ export declare const coreBehavior: {
       | 'insert.soft break'
       | 'insert.text'
       | 'list item.toggle'
+      | 'select'
       | 'style.toggle'
       | 'copy'
       | 'key.down'
@@ -460,10 +474,7 @@ export declare const coreBehavior: {
     clearListOnEnter: Behavior<
       | 'annotation.add'
       | 'annotation.remove'
-      | 'annotation.toggle'
       | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
       | 'decorator.toggle'
       | 'delete.backward'
       | 'delete.forward'
@@ -474,6 +485,7 @@ export declare const coreBehavior: {
       | 'insert.soft break'
       | 'insert.text'
       | 'list item.toggle'
+      | 'select'
       | 'style.toggle'
       | 'copy'
       | 'key.down'
@@ -484,10 +496,7 @@ export declare const coreBehavior: {
     indentListOnTab: Behavior<
       | 'annotation.add'
       | 'annotation.remove'
-      | 'annotation.toggle'
       | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
       | 'decorator.toggle'
       | 'delete.backward'
       | 'delete.forward'
@@ -498,6 +507,7 @@ export declare const coreBehavior: {
       | 'insert.soft break'
       | 'insert.text'
       | 'list item.toggle'
+      | 'select'
       | 'style.toggle'
       | 'copy'
       | 'key.down'
@@ -508,10 +518,7 @@ export declare const coreBehavior: {
     unindentListOnShiftTab: Behavior<
       | 'annotation.add'
       | 'annotation.remove'
-      | 'annotation.toggle'
       | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
       | 'decorator.toggle'
       | 'delete.backward'
       | 'delete.forward'
@@ -522,6 +529,7 @@ export declare const coreBehavior: {
       | 'insert.soft break'
       | 'insert.text'
       | 'list item.toggle'
+      | 'select'
       | 'style.toggle'
       | 'copy'
       | 'key.down'
@@ -538,10 +546,7 @@ export declare const coreBehavior: {
 export declare const coreBehaviors: Behavior<
   | 'annotation.add'
   | 'annotation.remove'
-  | 'annotation.toggle'
   | 'blur'
-  | 'decorator.add'
-  | 'decorator.remove'
   | 'decorator.toggle'
   | 'delete.backward'
   | 'delete.forward'
@@ -552,6 +557,7 @@ export declare const coreBehaviors: Behavior<
   | 'insert.soft break'
   | 'insert.text'
   | 'list item.toggle'
+  | 'select'
   | 'style.toggle'
   | 'copy'
   | 'key.down'
@@ -568,10 +574,7 @@ export declare function createCodeEditorBehaviors(
 ): Behavior<
   | 'annotation.add'
   | 'annotation.remove'
-  | 'annotation.toggle'
   | 'blur'
-  | 'decorator.add'
-  | 'decorator.remove'
   | 'decorator.toggle'
   | 'delete.backward'
   | 'delete.forward'
@@ -582,6 +585,7 @@ export declare function createCodeEditorBehaviors(
   | 'insert.soft break'
   | 'insert.text'
   | 'list item.toggle'
+  | 'select'
   | 'style.toggle'
   | 'copy'
   | 'key.down'
@@ -598,10 +602,7 @@ export declare function createEmojiPickerBehaviors<TEmojiMatch>(
 ): Behavior<
   | 'annotation.add'
   | 'annotation.remove'
-  | 'annotation.toggle'
   | 'blur'
-  | 'decorator.add'
-  | 'decorator.remove'
   | 'decorator.toggle'
   | 'delete.backward'
   | 'delete.forward'
@@ -612,6 +613,7 @@ export declare function createEmojiPickerBehaviors<TEmojiMatch>(
   | 'insert.soft break'
   | 'insert.text'
   | 'list item.toggle'
+  | 'select'
   | 'style.toggle'
   | 'copy'
   | 'key.down'
@@ -628,10 +630,7 @@ export declare function createLinkBehaviors(
 ): Behavior<
   | 'annotation.add'
   | 'annotation.remove'
-  | 'annotation.toggle'
   | 'blur'
-  | 'decorator.add'
-  | 'decorator.remove'
   | 'decorator.toggle'
   | 'delete.backward'
   | 'delete.forward'
@@ -642,6 +641,7 @@ export declare function createLinkBehaviors(
   | 'insert.soft break'
   | 'insert.text'
   | 'list item.toggle'
+  | 'select'
   | 'style.toggle'
   | 'copy'
   | 'key.down'
@@ -658,10 +658,7 @@ export declare function createMarkdownBehaviors(
 ): Behavior<
   | 'annotation.add'
   | 'annotation.remove'
-  | 'annotation.toggle'
   | 'blur'
-  | 'decorator.add'
-  | 'decorator.remove'
   | 'decorator.toggle'
   | 'delete.backward'
   | 'delete.forward'
@@ -672,6 +669,7 @@ export declare function createMarkdownBehaviors(
   | 'insert.soft break'
   | 'insert.text'
   | 'list item.toggle'
+  | 'select'
   | 'style.toggle'
   | 'copy'
   | 'key.down'
@@ -820,6 +818,13 @@ export declare type PortableTextMemberSchemaTypes = {
   lists: BlockListDefinition[]
 }
 
+/**
+ * @beta
+ */
+export declare function raise(
+  event: SyntheticBehaviorEvent,
+): PickFromUnion<BehaviorActionIntend, 'type', 'raise'>
+
 /**
  * @beta
  */
@@ -839,26 +844,9 @@ export declare type SyntheticBehaviorEvent =
         name: string
       }
     }
-  | {
-      type: 'annotation.toggle'
-      annotation: {
-        name: string
-        value: {
-          [prop: string]: unknown
-        }
-      }
-    }
   | {
       type: 'blur'
     }
-  | {
-      type: 'decorator.add'
-      decorator: string
-    }
-  | {
-      type: 'decorator.remove'
-      decorator: string
-    }
   | {
       type: 'decorator.toggle'
       decorator: string
@@ -908,6 +896,10 @@ export declare type SyntheticBehaviorEvent =
       type: 'list item.toggle'
       listItem: string
     }
+  | {
+      type: 'select'
+      selection: EditorSelection
+    }
   | {
       type: 'style.toggle'
       style: string