@portabletext/editor 1.15.1 → 1.15.2

package/lib/index.d.ts

@@ -94,26 +94,26 @@ export declare type BaseDefinition = {
  * @alpha
  */
 export declare 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>>
 }
 
 /**
@@ -213,7 +213,17 @@ export declare type BehaviorActionIntend =
 /**
  * @alpha
  */
-export declare type BehaviorActionIntendSet<TGuardResponse = true> = (
+export declare type BehaviorActionIntendSet<
+  TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
+  TGuardResponse = true,
+> = (
+  {
+    context,
+    event,
+  }: {
+    context: EditorContext
+    event: PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>
+  },
   guardResponse: TGuardResponse,
 ) => Array<BehaviorActionIntend>
 
@@ -226,14 +236,14 @@ export declare type BehaviorEvent = SyntheticBehaviorEvent | NativeBehaviorEvent
  * @alpha
  */
 export declare type BehaviorGuard<
-  TAnyBehaviorEvent extends BehaviorEvent,
+  TBehaviorEvent extends BehaviorEvent,
   TGuardResponse,
 > = ({
   context,
   event,
 }: {
   context: EditorContext
-  event: TAnyBehaviorEvent
+  event: TBehaviorEvent
 }) => TGuardResponse | false
 
 /** @beta */
@@ -334,14 +344,6 @@ export declare type BlurChange = {
   event: FocusEvent_2<HTMLDivElement, Element>
 }
 
-/**
- * @alpha
- */
-export declare type CodeEditorBehaviorsConfig = {
-  moveBlockUpShortcut: string
-  moveBlockDownShortcut: string
-}
-
 /**
  * The editor was either connected or disconnected to the network
  * To show out of sync warnings etc when in collaborative mode.
@@ -351,480 +353,6 @@ export declare type ConnectionChange = {
   value: 'online' | 'offline'
 }
 
-/**
- * @alpha
- */
-export declare const coreBehavior: {
-  softReturn: Behavior<
-    | 'focus'
-    | 'list item.toggle'
-    | 'annotation.add'
-    | 'annotation.remove'
-    | 'annotation.toggle'
-    | 'blur'
-    | 'decorator.add'
-    | 'decorator.remove'
-    | 'decorator.toggle'
-    | 'delete.backward'
-    | 'delete.forward'
-    | 'insert.block object'
-    | 'insert.inline object'
-    | 'insert.soft break'
-    | 'insert.break'
-    | 'insert.text'
-    | 'style.toggle'
-    | 'copy'
-    | 'key.down'
-    | 'key.up'
-    | 'paste',
-    true
-  >
-  decorators: {
-    decoratorAdd: Behavior<
-      | 'focus'
-      | 'list item.toggle'
-      | 'annotation.add'
-      | 'annotation.remove'
-      | 'annotation.toggle'
-      | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
-      | 'decorator.toggle'
-      | 'delete.backward'
-      | 'delete.forward'
-      | 'insert.block object'
-      | 'insert.inline object'
-      | 'insert.soft break'
-      | 'insert.break'
-      | 'insert.text'
-      | 'style.toggle'
-      | 'copy'
-      | 'key.down'
-      | 'key.up'
-      | 'paste',
-      true
-    >
-    decoratorRemove: Behavior<
-      | 'focus'
-      | 'list item.toggle'
-      | 'annotation.add'
-      | 'annotation.remove'
-      | 'annotation.toggle'
-      | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
-      | 'decorator.toggle'
-      | 'delete.backward'
-      | 'delete.forward'
-      | 'insert.block object'
-      | 'insert.inline object'
-      | 'insert.soft break'
-      | 'insert.break'
-      | 'insert.text'
-      | 'style.toggle'
-      | 'copy'
-      | 'key.down'
-      | 'key.up'
-      | 'paste',
-      true
-    >
-    decoratorToggle: Behavior<
-      | 'focus'
-      | 'list item.toggle'
-      | 'annotation.add'
-      | 'annotation.remove'
-      | 'annotation.toggle'
-      | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
-      | 'decorator.toggle'
-      | 'delete.backward'
-      | 'delete.forward'
-      | 'insert.block object'
-      | 'insert.inline object'
-      | 'insert.soft break'
-      | 'insert.break'
-      | 'insert.text'
-      | 'style.toggle'
-      | 'copy'
-      | 'key.down'
-      | 'key.up'
-      | 'paste',
-      true
-    >
-  }
-  blockObjects: {
-    arrowDownOnLonelyBlockObject: Behavior<
-      | 'focus'
-      | 'list item.toggle'
-      | 'annotation.add'
-      | 'annotation.remove'
-      | 'annotation.toggle'
-      | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
-      | 'decorator.toggle'
-      | 'delete.backward'
-      | 'delete.forward'
-      | 'insert.block object'
-      | 'insert.inline object'
-      | 'insert.soft break'
-      | 'insert.break'
-      | 'insert.text'
-      | 'style.toggle'
-      | 'copy'
-      | 'key.down'
-      | 'key.up'
-      | 'paste',
-      true
-    >
-    arrowUpOnLonelyBlockObject: Behavior<
-      | 'focus'
-      | 'list item.toggle'
-      | 'annotation.add'
-      | 'annotation.remove'
-      | 'annotation.toggle'
-      | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
-      | 'decorator.toggle'
-      | 'delete.backward'
-      | 'delete.forward'
-      | 'insert.block object'
-      | 'insert.inline object'
-      | 'insert.soft break'
-      | 'insert.break'
-      | 'insert.text'
-      | 'style.toggle'
-      | 'copy'
-      | 'key.down'
-      | 'key.up'
-      | 'paste',
-      true
-    >
-    breakingBlockObject: Behavior<
-      | 'focus'
-      | 'list item.toggle'
-      | 'annotation.add'
-      | 'annotation.remove'
-      | 'annotation.toggle'
-      | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
-      | 'decorator.toggle'
-      | 'delete.backward'
-      | 'delete.forward'
-      | 'insert.block object'
-      | 'insert.inline object'
-      | 'insert.soft break'
-      | 'insert.break'
-      | 'insert.text'
-      | 'style.toggle'
-      | 'copy'
-      | 'key.down'
-      | 'key.up'
-      | 'paste',
-      true
-    >
-    deletingEmptyTextBlockAfterBlockObject: Behavior<
-      | 'focus'
-      | 'list item.toggle'
-      | 'annotation.add'
-      | 'annotation.remove'
-      | 'annotation.toggle'
-      | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
-      | 'decorator.toggle'
-      | 'delete.backward'
-      | 'delete.forward'
-      | 'insert.block object'
-      | 'insert.inline object'
-      | 'insert.soft break'
-      | 'insert.break'
-      | 'insert.text'
-      | 'style.toggle'
-      | 'copy'
-      | 'key.down'
-      | 'key.up'
-      | 'paste',
-      true
-    >
-    deletingEmptyTextBlockBeforeBlockObject: Behavior<
-      | 'focus'
-      | 'list item.toggle'
-      | 'annotation.add'
-      | 'annotation.remove'
-      | 'annotation.toggle'
-      | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
-      | 'decorator.toggle'
-      | 'delete.backward'
-      | 'delete.forward'
-      | 'insert.block object'
-      | 'insert.inline object'
-      | 'insert.soft break'
-      | 'insert.break'
-      | 'insert.text'
-      | 'style.toggle'
-      | 'copy'
-      | 'key.down'
-      | 'key.up'
-      | 'paste',
-      true
-    >
-  }
-  lists: {
-    clearListOnBackspace: Behavior<
-      | 'focus'
-      | 'list item.toggle'
-      | 'annotation.add'
-      | 'annotation.remove'
-      | 'annotation.toggle'
-      | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
-      | 'decorator.toggle'
-      | 'delete.backward'
-      | 'delete.forward'
-      | 'insert.block object'
-      | 'insert.inline object'
-      | 'insert.soft break'
-      | 'insert.break'
-      | 'insert.text'
-      | 'style.toggle'
-      | 'copy'
-      | 'key.down'
-      | 'key.up'
-      | 'paste',
-      true
-    >
-    unindentListOnBackspace: Behavior<
-      | 'focus'
-      | 'list item.toggle'
-      | 'annotation.add'
-      | 'annotation.remove'
-      | 'annotation.toggle'
-      | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
-      | 'decorator.toggle'
-      | 'delete.backward'
-      | 'delete.forward'
-      | 'insert.block object'
-      | 'insert.inline object'
-      | 'insert.soft break'
-      | 'insert.break'
-      | 'insert.text'
-      | 'style.toggle'
-      | 'copy'
-      | 'key.down'
-      | 'key.up'
-      | 'paste',
-      true
-    >
-    clearListOnEnter: Behavior<
-      | 'focus'
-      | 'list item.toggle'
-      | 'annotation.add'
-      | 'annotation.remove'
-      | 'annotation.toggle'
-      | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
-      | 'decorator.toggle'
-      | 'delete.backward'
-      | 'delete.forward'
-      | 'insert.block object'
-      | 'insert.inline object'
-      | 'insert.soft break'
-      | 'insert.break'
-      | 'insert.text'
-      | 'style.toggle'
-      | 'copy'
-      | 'key.down'
-      | 'key.up'
-      | 'paste',
-      true
-    >
-    indentListOnTab: Behavior<
-      | 'focus'
-      | 'list item.toggle'
-      | 'annotation.add'
-      | 'annotation.remove'
-      | 'annotation.toggle'
-      | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
-      | 'decorator.toggle'
-      | 'delete.backward'
-      | 'delete.forward'
-      | 'insert.block object'
-      | 'insert.inline object'
-      | 'insert.soft break'
-      | 'insert.break'
-      | 'insert.text'
-      | 'style.toggle'
-      | 'copy'
-      | 'key.down'
-      | 'key.up'
-      | 'paste',
-      true
-    >
-    unindentListOnShiftTab: Behavior<
-      | 'focus'
-      | 'list item.toggle'
-      | 'annotation.add'
-      | 'annotation.remove'
-      | 'annotation.toggle'
-      | 'blur'
-      | 'decorator.add'
-      | 'decorator.remove'
-      | 'decorator.toggle'
-      | 'delete.backward'
-      | 'delete.forward'
-      | 'insert.block object'
-      | 'insert.inline object'
-      | 'insert.soft break'
-      | 'insert.break'
-      | 'insert.text'
-      | 'style.toggle'
-      | 'copy'
-      | 'key.down'
-      | 'key.up'
-      | 'paste',
-      true
-    >
-  }
-}
-
-/**
- * @alpha
- */
-export declare const coreBehaviors: Behavior<
-  | 'focus'
-  | 'list item.toggle'
-  | 'annotation.add'
-  | 'annotation.remove'
-  | 'annotation.toggle'
-  | 'blur'
-  | 'decorator.add'
-  | 'decorator.remove'
-  | 'decorator.toggle'
-  | 'delete.backward'
-  | 'delete.forward'
-  | 'insert.block object'
-  | 'insert.inline object'
-  | 'insert.soft break'
-  | 'insert.break'
-  | 'insert.text'
-  | 'style.toggle'
-  | 'copy'
-  | 'key.down'
-  | 'key.up'
-  | 'paste',
-  true
->[]
-
-/**
- * @alpha
- */
-export declare function createCodeEditorBehaviors(
-  config: CodeEditorBehaviorsConfig,
-): Behavior<
-  | 'focus'
-  | 'list item.toggle'
-  | 'annotation.add'
-  | 'annotation.remove'
-  | 'annotation.toggle'
-  | 'blur'
-  | 'decorator.add'
-  | 'decorator.remove'
-  | 'decorator.toggle'
-  | 'delete.backward'
-  | 'delete.forward'
-  | 'insert.block object'
-  | 'insert.inline object'
-  | 'insert.soft break'
-  | 'insert.break'
-  | 'insert.text'
-  | 'style.toggle'
-  | 'copy'
-  | 'key.down'
-  | 'key.up'
-  | 'paste',
-  true
->[]
-
-/**
- * @alpha
- */
-export declare function createLinkBehaviors(
-  config: LinkBehaviorsConfig,
-): Behavior<
-  | 'focus'
-  | 'list item.toggle'
-  | 'annotation.add'
-  | 'annotation.remove'
-  | 'annotation.toggle'
-  | 'blur'
-  | 'decorator.add'
-  | 'decorator.remove'
-  | 'decorator.toggle'
-  | 'delete.backward'
-  | 'delete.forward'
-  | 'insert.block object'
-  | 'insert.inline object'
-  | 'insert.soft break'
-  | 'insert.break'
-  | 'insert.text'
-  | 'style.toggle'
-  | 'copy'
-  | 'key.down'
-  | 'key.up'
-  | 'paste',
-  true
->[]
-
-/**
- * @alpha
- */
-export declare function createMarkdownBehaviors(
-  config: MarkdownBehaviorsConfig,
-): Behavior<
-  | 'focus'
-  | 'list item.toggle'
-  | 'annotation.add'
-  | 'annotation.remove'
-  | 'annotation.toggle'
-  | 'blur'
-  | 'decorator.add'
-  | 'decorator.remove'
-  | 'decorator.toggle'
-  | 'delete.backward'
-  | 'delete.forward'
-  | 'insert.block object'
-  | 'insert.inline object'
-  | 'insert.soft break'
-  | 'insert.break'
-  | 'insert.text'
-  | 'style.toggle'
-  | 'copy'
-  | 'key.down'
-  | 'key.up'
-  | 'paste',
-  true
->[]
-
-/**
- * @alpha
- */
-export declare function defineBehavior<
-  TAnyBehaviorEventType extends BehaviorEvent['type'],
-  TGuardResponse = true,
->(behavior: Behavior<TAnyBehaviorEventType, TGuardResponse>): Behavior
-
 /**
  * @alpha
  */
@@ -9551,23 +9079,6 @@ export declare type InvalidValueResolution = {
  */
 export declare const keyGenerator: () => string
 
-/**
- * @alpha
- */
-export declare type LinkBehaviorsConfig = {
-  linkAnnotation?: (context: {
-    schema: PortableTextMemberSchemaTypes
-    url: string
-  }) =>
-    | {
-        name: string
-        value: {
-          [prop: string]: unknown
-        }
-      }
-    | undefined
-}
-
 /**
  * The editor is currently loading something
  * Could be used to show a spinner etc.
@@ -9577,36 +9088,6 @@ export declare type LoadingChange = {
   isLoading: boolean
 }
 
-/**
- * @alpha
- */
-export declare type MarkdownBehaviorsConfig = {
-  horizontalRuleObject?: (context: {schema: PortableTextMemberSchemaTypes}) =>
-    | {
-        name: string
-        value?: {
-          [prop: string]: unknown
-        }
-      }
-    | undefined
-  defaultStyle?: (context: {
-    schema: PortableTextMemberSchemaTypes
-  }) => string | undefined
-  headingStyle?: (context: {
-    schema: PortableTextMemberSchemaTypes
-    level: number
-  }) => string | undefined
-  blockquoteStyle?: (context: {
-    schema: PortableTextMemberSchemaTypes
-  }) => string | undefined
-  unorderedListStyle?: (context: {
-    schema: PortableTextMemberSchemaTypes
-  }) => string | undefined
-  orderedListStyle?: (context: {
-    schema: PortableTextMemberSchemaTypes
-  }) => string | undefined
-}
-
 /**
  * The editor has mutated it's content.
  * @beta */