@portabletext/editor 1.20.0 → 1.21.1

package/lib/behaviors/index.d.cts

@@ -11,6 +11,10 @@ import type {
 } from '@sanity/types'
 import type {TextUnit} from 'slate'
 import type {TextInsertTextOptions} from 'slate/dist/interfaces/transforms/text'
+import {
+  Behavior as Behavior_2,
+  BehaviorEvent as BehaviorEvent_2,
+} from './behavior.types'
 
 /**
  * @beta
@@ -18,6 +22,7 @@ import type {TextInsertTextOptions} from 'slate/dist/interfaces/transforms/text'
 export declare type Behavior<
   TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
   TGuardResponse = true,
+  TBehaviorEvent extends BehaviorEvent = BehaviorEvent,
 > = {
   /**
    * The internal editor event that triggers this behavior.
@@ -28,14 +33,11 @@ export declare type Behavior<
    * Returning a non-nullable value from the guard will pass the value to the
    * actions and execute them.
    */
-  guard?: BehaviorGuard<
-    PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>,
-    TGuardResponse
-  >
+  guard?: BehaviorGuard<TBehaviorEvent, TGuardResponse>
   /**
    * Array of behavior action sets.
    */
-  actions: Array<BehaviorActionIntendSet<TBehaviorEventType, TGuardResponse>>
+  actions: Array<BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse>>
 }
 
 /**
@@ -45,7 +47,7 @@ export declare type BehaviorActionIntend =
   | SyntheticBehaviorEvent
   | {
       type: 'raise'
-      event: SyntheticBehaviorEvent
+      event: SyntheticBehaviorEvent | CustomBehaviorEvent
     }
   | {
       type: 'annotation.toggle'
@@ -149,16 +151,13 @@ export declare type BehaviorActionIntend =
 /**
  * @beta
  */
-export declare type BehaviorActionIntendSet<
-  TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
-  TGuardResponse = true,
-> = (
+export declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
   {
     context,
     event,
   }: {
     context: EditorContext
-    event: PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>
+    event: TBehaviorEvent
   },
   guardResponse: TGuardResponse,
 ) => Array<BehaviorActionIntend>
@@ -166,15 +165,15 @@ export declare type BehaviorActionIntendSet<
 /**
  * @beta
  */
-export declare type BehaviorEvent = SyntheticBehaviorEvent | NativeBehaviorEvent
+export declare type BehaviorEvent =
+  | SyntheticBehaviorEvent
+  | NativeBehaviorEvent
+  | CustomBehaviorEvent
 
 /**
  * @beta
  */
-export declare type BehaviorGuard<
-  TBehaviorEvent extends BehaviorEvent,
-  TGuardResponse,
-> = ({
+export declare type BehaviorGuard<TBehaviorEvent, TGuardResponse> = ({
   context,
   event,
 }: {
@@ -202,340 +201,370 @@ export declare type CodeEditorBehaviorsConfig = {
  * @beta
  */
 export declare const coreBehavior: {
-  softReturn: Behavior<
+  softReturn: Behavior_2<
+    | 'focus'
+    | 'select'
     | '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
+    | 'paste'
+    | `custom.${string}`,
+    true,
+    BehaviorEvent_2
   >
   decorators: {
-    strongShortcut: Behavior<
+    strongShortcut: Behavior_2<
+      | 'focus'
+      | 'select'
       | '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
+      | 'paste'
+      | `custom.${string}`,
+      true,
+      BehaviorEvent_2
     >
-    emShortcut: Behavior<
+    emShortcut: Behavior_2<
+      | 'focus'
+      | 'select'
       | '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
+      | 'paste'
+      | `custom.${string}`,
+      true,
+      BehaviorEvent_2
     >
-    underlineShortcut: Behavior<
+    underlineShortcut: Behavior_2<
+      | 'focus'
+      | 'select'
       | '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
+      | 'paste'
+      | `custom.${string}`,
+      true,
+      BehaviorEvent_2
     >
-    codeShortcut: Behavior<
+    codeShortcut: Behavior_2<
+      | 'focus'
+      | 'select'
       | '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
+      | 'paste'
+      | `custom.${string}`,
+      true,
+      BehaviorEvent_2
     >
   }
   blockObjects: {
-    arrowDownOnLonelyBlockObject: Behavior<
+    arrowDownOnLonelyBlockObject: Behavior_2<
+      | 'focus'
+      | 'select'
       | '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
+      | 'paste'
+      | `custom.${string}`,
+      true,
+      BehaviorEvent_2
     >
-    arrowUpOnLonelyBlockObject: Behavior<
+    arrowUpOnLonelyBlockObject: Behavior_2<
+      | 'focus'
+      | 'select'
       | '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
+      | 'paste'
+      | `custom.${string}`,
+      true,
+      BehaviorEvent_2
     >
-    breakingBlockObject: Behavior<
+    breakingBlockObject: Behavior_2<
+      | 'focus'
+      | 'select'
       | '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
+      | 'paste'
+      | `custom.${string}`,
+      true,
+      BehaviorEvent_2
     >
-    deletingEmptyTextBlockAfterBlockObject: Behavior<
+    deletingEmptyTextBlockAfterBlockObject: Behavior_2<
+      | 'focus'
+      | 'select'
       | '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
+      | 'paste'
+      | `custom.${string}`,
+      true,
+      BehaviorEvent_2
     >
-    deletingEmptyTextBlockBeforeBlockObject: Behavior<
+    deletingEmptyTextBlockBeforeBlockObject: Behavior_2<
+      | 'focus'
+      | 'select'
       | '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
+      | 'paste'
+      | `custom.${string}`,
+      true,
+      BehaviorEvent_2
     >
   }
   lists: {
-    clearListOnBackspace: Behavior<
+    clearListOnBackspace: Behavior_2<
+      | 'focus'
+      | 'select'
       | '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
+      | 'paste'
+      | `custom.${string}`,
+      true,
+      BehaviorEvent_2
     >
-    unindentListOnBackspace: Behavior<
+    unindentListOnBackspace: Behavior_2<
+      | 'focus'
+      | 'select'
       | '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
+      | 'paste'
+      | `custom.${string}`,
+      true,
+      BehaviorEvent_2
     >
-    clearListOnEnter: Behavior<
+    clearListOnEnter: Behavior_2<
+      | 'focus'
+      | 'select'
       | '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
+      | 'paste'
+      | `custom.${string}`,
+      true,
+      BehaviorEvent_2
     >
-    indentListOnTab: Behavior<
+    indentListOnTab: Behavior_2<
+      | 'focus'
+      | 'select'
       | '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
+      | 'paste'
+      | `custom.${string}`,
+      true,
+      BehaviorEvent_2
     >
-    unindentListOnShiftTab: Behavior<
+    unindentListOnShiftTab: Behavior_2<
+      | 'focus'
+      | 'select'
       | '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
+      | 'paste'
+      | `custom.${string}`,
+      true,
+      BehaviorEvent_2
     >
   }
 }
@@ -543,27 +572,29 @@ export declare const coreBehavior: {
 /**
  * @beta
  */
-export declare const coreBehaviors: Behavior<
+export declare const coreBehaviors: Behavior_2<
+  | 'focus'
+  | 'select'
   | '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
+  | 'paste'
+  | `custom.${string}`,
+  true,
+  BehaviorEvent_2
 >[]
 
 /**
@@ -571,27 +602,29 @@ export declare const coreBehaviors: Behavior<
  */
 export declare function createCodeEditorBehaviors(
   config: CodeEditorBehaviorsConfig,
-): Behavior<
+): Behavior_2<
+  | 'focus'
+  | 'select'
   | '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
+  | 'paste'
+  | `custom.${string}`,
+  true,
+  BehaviorEvent_2
 >[]
 
 /**
@@ -599,27 +632,29 @@ export declare function createCodeEditorBehaviors(
  */
 export declare function createEmojiPickerBehaviors<TEmojiMatch>(
   config: EmojiPickerBehaviorsConfig<TEmojiMatch>,
-): Behavior<
+): Behavior_2<
+  | 'focus'
+  | 'select'
   | '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
+  | 'paste'
+  | `custom.${string}`,
+  true,
+  BehaviorEvent_2
 >[]
 
 /**
@@ -627,27 +662,29 @@ export declare function createEmojiPickerBehaviors<TEmojiMatch>(
  */
 export declare function createLinkBehaviors(
   config: LinkBehaviorsConfig,
-): Behavior<
+): Behavior_2<
+  | 'focus'
+  | 'select'
   | '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
+  | 'paste'
+  | `custom.${string}`,
+  true,
+  BehaviorEvent_2
 >[]
 
 /**
@@ -655,36 +692,59 @@ export declare function createLinkBehaviors(
  */
 export declare function createMarkdownBehaviors(
   config: MarkdownBehaviorsConfig,
-): Behavior<
+): Behavior_2<
+  | 'focus'
+  | 'select'
   | '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
+  | 'paste'
+  | `custom.${string}`,
+  true,
+  BehaviorEvent_2
 >[]
 
+/**
+ * @beta
+ */
+export declare type CustomBehaviorEvent<
+  TPayload extends Record<string, unknown> = Record<string, unknown>,
+  TType extends string = string,
+  TInternalType extends `custom.${TType}` = `custom.${TType}`,
+> = {
+  type: TInternalType
+} & TPayload
+
 /**
  * @beta
  */
 export declare function defineBehavior<
-  TBehaviorEventType extends BehaviorEvent['type'],
+  TPayload extends Record<string, unknown>,
+  TBehaviorEventType extends
+    BehaviorEvent['type'] = CustomBehaviorEvent['type'],
   TGuardResponse = true,
->(behavior: Behavior<TBehaviorEventType, TGuardResponse>): Behavior
+>(
+  behavior: Behavior<
+    TBehaviorEventType,
+    TGuardResponse,
+    TBehaviorEventType extends `custom.${infer TType}`
+      ? CustomBehaviorEvent<TPayload, TType>
+      : PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>
+  >,
+): Behavior
 
 /**
  * @public
@@ -822,7 +882,7 @@ export declare type PortableTextMemberSchemaTypes = {
  * @beta
  */
 export declare function raise(
-  event: SyntheticBehaviorEvent,
+  event: SyntheticBehaviorEvent | CustomBehaviorEvent,
 ): PickFromUnion<BehaviorActionIntend, 'type', 'raise'>
 
 /**