@portabletext/editor 1.5.6 → 1.6.1

package/lib/index.d.ts

@@ -133,6 +133,9 @@ export declare type BehaviorActionIntend =
       type: 'select'
       selection: EditorSelection
     }
+  | {
+      type: 'reselect'
+    }
 
 /**
  * @alpha
@@ -164,6 +167,18 @@ export declare type BehaviorContext = {
  * @alpha
  */
 export declare type BehaviorEvent =
+  | {
+      type: 'decorator.add'
+      decorator: string
+    }
+  | {
+      type: 'decorator.remove'
+      decorator: string
+    }
+  | {
+      type: 'decorator.toggle'
+      decorator: string
+    }
   | {
       type: 'delete backward'
       unit: TextUnit
@@ -302,53 +317,106 @@ export declare type ConnectionChange = {
  */
 export declare const coreBehavior: {
   softReturn: Behavior<
-    | 'insert break'
-    | 'insert soft break'
+    | 'decorator.add'
+    | 'decorator.remove'
+    | 'decorator.toggle'
     | 'delete backward'
     | 'delete forward'
+    | 'insert soft break'
+    | 'insert break'
     | 'insert text',
     true
   >
-  blockObjects: {
-    breakingBlockObject: Behavior<
-      | 'insert break'
+  decorators: {
+    decoratorAdd: Behavior<
+      | 'decorator.add'
+      | 'decorator.remove'
+      | 'decorator.toggle'
+      | 'delete backward'
+      | 'delete forward'
       | 'insert soft break'
+      | 'insert break'
+      | 'insert text',
+      true
+    >
+    decoratorRemove: Behavior<
+      | 'decorator.add'
+      | 'decorator.remove'
+      | 'decorator.toggle'
       | 'delete backward'
       | 'delete forward'
+      | 'insert soft break'
+      | 'insert break'
       | 'insert text',
       true
     >
-    deletingEmptyTextBlockAfterBlockObject: Behavior<
+    decoratorToggle: Behavior<
+      | 'decorator.add'
+      | 'decorator.remove'
+      | 'decorator.toggle'
+      | 'delete backward'
+      | 'delete forward'
+      | 'insert soft break'
       | 'insert break'
+      | 'insert text',
+      true
+    >
+  }
+  blockObjects: {
+    breakingBlockObject: Behavior<
+      | 'decorator.add'
+      | 'decorator.remove'
+      | 'decorator.toggle'
+      | 'delete backward'
+      | 'delete forward'
       | 'insert soft break'
+      | 'insert break'
+      | 'insert text',
+      true
+    >
+    deletingEmptyTextBlockAfterBlockObject: Behavior<
+      | 'decorator.add'
+      | 'decorator.remove'
+      | 'decorator.toggle'
       | 'delete backward'
       | 'delete forward'
+      | 'insert soft break'
+      | 'insert break'
       | 'insert text',
       true
     >
     deletingEmptyTextBlockBeforeBlockObject: Behavior<
-      | 'insert break'
-      | 'insert soft break'
+      | 'decorator.add'
+      | 'decorator.remove'
+      | 'decorator.toggle'
       | 'delete backward'
       | 'delete forward'
+      | 'insert soft break'
+      | 'insert break'
       | 'insert text',
       true
     >
   }
   lists: {
     clearListOnBackspace: Behavior<
-      | 'insert break'
-      | 'insert soft break'
+      | 'decorator.add'
+      | 'decorator.remove'
+      | 'decorator.toggle'
       | 'delete backward'
       | 'delete forward'
+      | 'insert soft break'
+      | 'insert break'
       | 'insert text',
       true
     >
     unindentListOnBackspace: Behavior<
-      | 'insert break'
-      | 'insert soft break'
+      | 'decorator.add'
+      | 'decorator.remove'
+      | 'decorator.toggle'
       | 'delete backward'
       | 'delete forward'
+      | 'insert soft break'
+      | 'insert break'
       | 'insert text',
       true
     >
@@ -359,10 +427,13 @@ export declare const coreBehavior: {
  * @alpha
  */
 export declare const coreBehaviors: Behavior<
-  | 'insert break'
-  | 'insert soft break'
+  | 'decorator.add'
+  | 'decorator.remove'
+  | 'decorator.toggle'
   | 'delete backward'
   | 'delete forward'
+  | 'insert soft break'
+  | 'insert break'
   | 'insert text',
   true
 >[]
@@ -383,10 +454,13 @@ export declare type createEditorOptions = {
 export declare function createMarkdownBehaviors(
   config: MarkdownBehaviorsConfig,
 ): Behavior<
-  | 'insert break'
-  | 'insert soft break'
+  | 'decorator.add'
+  | 'decorator.remove'
+  | 'decorator.toggle'
   | 'delete backward'
   | 'delete forward'
+  | 'insert soft break'
+  | 'insert break'
   | 'insert text',
   true
 >[]
@@ -2917,6 +2991,187 @@ export declare const editorMachine: StateMachine<
                 type: 'done loading'
               }
           >) => void,
+          ActionFunction<
+            {
+              behaviors: Array<Behavior>
+              keyGenerator: () => string
+              pendingEvents: Array<PatchEvent | MutationEvent_2>
+              schema: PortableTextMemberSchemaTypes
+            },
+            {
+              type: 'behavior action intends'
+              editor: PortableTextSlateEditor
+              actionIntends: Array<BehaviorActionIntend>
+            },
+            | PatchEvent
+            | MutationEvent_2
+            | {
+                type: 'normalizing'
+              }
+            | {
+                type: 'done normalizing'
+              }
+            | {
+                type: 'behavior event'
+                behaviorEvent: BehaviorEvent
+                editor: PortableTextSlateEditor
+              }
+            | {
+                type: 'behavior action intends'
+                editor: PortableTextSlateEditor
+                actionIntends: Array<BehaviorActionIntend>
+              }
+            | {
+                type: 'update schema'
+                schema: PortableTextMemberSchemaTypes
+              }
+            | {
+                type: 'update behaviors'
+                behaviors: Array<Behavior>
+              }
+            | {
+                type: 'ready'
+              }
+            | PatchesEvent
+            | {
+                type: 'unset'
+                previousValue: Array<PortableTextBlock>
+              }
+            | {
+                type: 'value changed'
+                value: Array<PortableTextBlock> | undefined
+              }
+            | {
+                type: 'invalid value'
+                resolution: InvalidValueResolution | null
+                value: Array<PortableTextBlock> | undefined
+              }
+            | {
+                type: 'error'
+                name: string
+                description: string
+                data: unknown
+              }
+            | {
+                type: 'selection'
+                selection: EditorSelection
+              }
+            | {
+                type: 'blur'
+                event: FocusEvent_2<HTMLDivElement, Element>
+              }
+            | {
+                type: 'focus'
+                event: FocusEvent_2<HTMLDivElement, Element>
+              }
+            | {
+                type: 'online'
+              }
+            | {
+                type: 'offline'
+              }
+            | {
+                type: 'loading'
+              }
+            | {
+                type: 'done loading'
+              },
+            undefined,
+            {
+              src: 'networkLogic'
+              logic: CallbackActorLogic<
+                EventObject,
+                NonReducibleUnknown,
+                EventObject
+              >
+              id: string | undefined
+            },
+            Values<{
+              'assign behaviors': {
+                type: 'assign behaviors'
+                params: NonReducibleUnknown
+              }
+              'assign schema': {
+                type: 'assign schema'
+                params: NonReducibleUnknown
+              }
+              'emit patch event': {
+                type: 'emit patch event'
+                params: NonReducibleUnknown
+              }
+              'emit mutation event': {
+                type: 'emit mutation event'
+                params: NonReducibleUnknown
+              }
+              'defer event': {
+                type: 'defer event'
+                params: NonReducibleUnknown
+              }
+              'emit pending events': {
+                type: 'emit pending events'
+                params: NonReducibleUnknown
+              }
+              'clear pending events': {
+                type: 'clear pending events'
+                params: NonReducibleUnknown
+              }
+              'handle behavior event': {
+                type: 'handle behavior event'
+                params: NonReducibleUnknown
+              }
+            }>,
+            never,
+            never,
+            | PatchEvent
+            | MutationEvent_2
+            | {
+                type: 'ready'
+              }
+            | PatchesEvent
+            | {
+                type: 'unset'
+                previousValue: Array<PortableTextBlock>
+              }
+            | {
+                type: 'value changed'
+                value: Array<PortableTextBlock> | undefined
+              }
+            | {
+                type: 'invalid value'
+                resolution: InvalidValueResolution | null
+                value: Array<PortableTextBlock> | undefined
+              }
+            | {
+                type: 'error'
+                name: string
+                description: string
+                data: unknown
+              }
+            | {
+                type: 'selection'
+                selection: EditorSelection
+              }
+            | {
+                type: 'blur'
+                event: FocusEvent_2<HTMLDivElement, Element>
+              }
+            | {
+                type: 'focus'
+                event: FocusEvent_2<HTMLDivElement, Element>
+              }
+            | {
+                type: 'online'
+              }
+            | {
+                type: 'offline'
+              }
+            | {
+                type: 'loading'
+              }
+            | {
+                type: 'done loading'
+              }
+          >,
         ]
       }
     }
@@ -3521,18 +3776,6 @@ export declare interface PortableTextSlateEditor extends ReactEditor {
    * @returns True if a list was ended in the selection
    */
   pteEndList: () => boolean
-  /**
-   * Toggle marks in the selection
-   *
-   * @param mark - Mark to toggle on/off
-   */
-  pteToggleMark: (mark: string) => void
-  /**
-   * Test if a mark is active in the current selection
-   *
-   * @param mark - Mark to check whether or not is active
-   */
-  pteIsMarkActive: (mark: string) => boolean
   /**
    * Toggle the selected block style
    *
@@ -6092,6 +6335,187 @@ export declare function useEditor(config: EditorConfig): Actor<
                   type: 'done loading'
                 }
             >) => void,
+            ActionFunction<
+              {
+                behaviors: Array<Behavior>
+                keyGenerator: () => string
+                pendingEvents: Array<PatchEvent | MutationEvent_2>
+                schema: PortableTextMemberSchemaTypes
+              },
+              {
+                type: 'behavior action intends'
+                editor: PortableTextSlateEditor
+                actionIntends: Array<BehaviorActionIntend>
+              },
+              | PatchEvent
+              | MutationEvent_2
+              | {
+                  type: 'normalizing'
+                }
+              | {
+                  type: 'done normalizing'
+                }
+              | {
+                  type: 'behavior event'
+                  behaviorEvent: BehaviorEvent
+                  editor: PortableTextSlateEditor
+                }
+              | {
+                  type: 'behavior action intends'
+                  editor: PortableTextSlateEditor
+                  actionIntends: Array<BehaviorActionIntend>
+                }
+              | {
+                  type: 'update schema'
+                  schema: PortableTextMemberSchemaTypes
+                }
+              | {
+                  type: 'update behaviors'
+                  behaviors: Array<Behavior>
+                }
+              | {
+                  type: 'ready'
+                }
+              | PatchesEvent
+              | {
+                  type: 'unset'
+                  previousValue: Array<PortableTextBlock>
+                }
+              | {
+                  type: 'value changed'
+                  value: Array<PortableTextBlock> | undefined
+                }
+              | {
+                  type: 'invalid value'
+                  resolution: InvalidValueResolution | null
+                  value: Array<PortableTextBlock> | undefined
+                }
+              | {
+                  type: 'error'
+                  name: string
+                  description: string
+                  data: unknown
+                }
+              | {
+                  type: 'selection'
+                  selection: EditorSelection
+                }
+              | {
+                  type: 'blur'
+                  event: FocusEvent_2<HTMLDivElement, Element>
+                }
+              | {
+                  type: 'focus'
+                  event: FocusEvent_2<HTMLDivElement, Element>
+                }
+              | {
+                  type: 'online'
+                }
+              | {
+                  type: 'offline'
+                }
+              | {
+                  type: 'loading'
+                }
+              | {
+                  type: 'done loading'
+                },
+              undefined,
+              {
+                src: 'networkLogic'
+                logic: CallbackActorLogic<
+                  EventObject,
+                  NonReducibleUnknown,
+                  EventObject
+                >
+                id: string | undefined
+              },
+              Values<{
+                'assign behaviors': {
+                  type: 'assign behaviors'
+                  params: NonReducibleUnknown
+                }
+                'assign schema': {
+                  type: 'assign schema'
+                  params: NonReducibleUnknown
+                }
+                'emit patch event': {
+                  type: 'emit patch event'
+                  params: NonReducibleUnknown
+                }
+                'emit mutation event': {
+                  type: 'emit mutation event'
+                  params: NonReducibleUnknown
+                }
+                'defer event': {
+                  type: 'defer event'
+                  params: NonReducibleUnknown
+                }
+                'emit pending events': {
+                  type: 'emit pending events'
+                  params: NonReducibleUnknown
+                }
+                'clear pending events': {
+                  type: 'clear pending events'
+                  params: NonReducibleUnknown
+                }
+                'handle behavior event': {
+                  type: 'handle behavior event'
+                  params: NonReducibleUnknown
+                }
+              }>,
+              never,
+              never,
+              | PatchEvent
+              | MutationEvent_2
+              | {
+                  type: 'ready'
+                }
+              | PatchesEvent
+              | {
+                  type: 'unset'
+                  previousValue: Array<PortableTextBlock>
+                }
+              | {
+                  type: 'value changed'
+                  value: Array<PortableTextBlock> | undefined
+                }
+              | {
+                  type: 'invalid value'
+                  resolution: InvalidValueResolution | null
+                  value: Array<PortableTextBlock> | undefined
+                }
+              | {
+                  type: 'error'
+                  name: string
+                  description: string
+                  data: unknown
+                }
+              | {
+                  type: 'selection'
+                  selection: EditorSelection
+                }
+              | {
+                  type: 'blur'
+                  event: FocusEvent_2<HTMLDivElement, Element>
+                }
+              | {
+                  type: 'focus'
+                  event: FocusEvent_2<HTMLDivElement, Element>
+                }
+              | {
+                  type: 'online'
+                }
+              | {
+                  type: 'offline'
+                }
+              | {
+                  type: 'loading'
+                }
+              | {
+                  type: 'done loading'
+                }
+            >,
           ]
         }
       }