@portabletext/editor 1.34.1 → 1.35.1

package/lib/index.d.ts

@@ -146,11 +146,13 @@ export declare type BehaviorActionIntend =
  * @beta
  */
 export declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
-  {
-    context,
-    event,
-  }: {
+  payload: {
+    /**
+     * @deprecated
+     * Use `snapshot` instead
+     */
     context: EditorContext
+    snapshot: EditorSnapshot
     event: TBehaviorEvent
   },
   guardResponse: TGuardResponse,
@@ -167,11 +169,13 @@ export declare type BehaviorEvent =
 /**
  * @beta
  */
-export declare type BehaviorGuard<TBehaviorEvent, TGuardResponse> = ({
-  context,
-  event,
-}: {
+export declare type BehaviorGuard<TBehaviorEvent, TGuardResponse> = (payload: {
+  /**
+   * @deprecated
+   * Use `snapshot` instead
+   */
   context: EditorContext
+  snapshot: EditorSnapshot
   event: TBehaviorEvent
 }) => TGuardResponse | false
 
@@ -359,10 +363,10 @@ export declare function defineSchema<
 >(definition: TSchemaDefinition): TSchemaDefinition
 
 declare type Deserializer<TMIMEType extends MIMEType> = ({
-  context,
+  snapshot,
   event,
 }: {
-  context: EditorContext
+  snapshot: EditorSnapshot
   event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'deserialize'>
 }) => PickFromUnion<
   ConverterEvent<TMIMEType>,
@@ -603,52 +607,12 @@ export declare type EditorEvent =
 
 /**
  * @public
- * Listen for events emitted by the editor. Must be used inside `EditorProvider`. Events available include:
- *  - 'blurred'
- *  - 'done loading'
- *  - 'editable'
- *  - 'error'
- *  - 'focused'
- *  - 'invalid value'
- *  - 'loading'
- *  - 'mutation'
- *  - 'patch'
- *  - 'read only'
- *  - 'ready'
- *  - 'selection'
- *  - 'value changed'
+ * @deprecated
+ * This component has been renamed. Use `EventListenerPlugin` instead.
  *
- * @example
- * Listen and log events.
- * ```tsx
- * import {EditorProvider} from '@portabletext/editor'
- * import {EventListenerPlugin} from '@portabletext/editor/plugins'
- *
- * function MyComponent() {
- *  return (
- *  <EditorProvider>
- *   <EventListenerPlugin
- *    on={(event) => {
- *     console.log(event)
- *    }
- *   } />
- *   { ... }
- * </EditorProvider>
- *  )
- * }
  * ```
- * @example
- * Handle events when there is a mutation.
- * ```tsx
- * <EventListenerPlugin
- *  on={(event) => {
- *    if (event.type === 'mutation') {
- *      console.log('Value changed:', event.snapshot)
- *    }
- *  }}
- * />
+ * import {EventListenerPlugin} from '@portabletext/editor/plugins'
  * ```
- * @group Components
  */
 export declare function EditorEventListener(props: {
   on: (event: EditorEmittedEvent) => void
@@ -1009,6 +973,15 @@ declare const editorMachine: StateMachine<
   | {
       type: 'notify.unset'
       previousValue: Array<PortableTextBlock>
+    }
+  | {
+      type: 'dragstart'
+    }
+  | {
+      type: 'dragend'
+    }
+  | {
+      type: 'drop'
     },
   {},
   never,
@@ -1070,7 +1043,9 @@ declare const editorMachine: StateMachine<
   never,
   {
     'edit mode':
-      | 'editable'
+      | {
+          editable: 'dragging internally' | 'idle'
+        }
       | {
           'read only': 'read only' | 'determine initial edit mode'
         }
@@ -1081,7 +1056,7 @@ declare const editorMachine: StateMachine<
           pristine: 'normalizing' | 'idle'
         }
   },
-  string,
+  'dragging internally',
   {
     behaviors?: Array<Behavior>
     converters?: Array<Converter>
@@ -1755,6 +1730,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           Record<string, AnyActorRef | undefined>,
           StateValue,
@@ -2103,6 +2087,15 @@ declare const editorMachine: StateMachine<
         | {
             type: 'notify.unset'
             previousValue: Array<PortableTextBlock>
+          }
+        | {
+            type: 'dragstart'
+          }
+        | {
+            type: 'dragend'
+          }
+        | {
+            type: 'drop'
           },
         AnyEventObject
       >
@@ -2475,6 +2468,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -3112,6 +3114,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -3752,6 +3763,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -4391,6 +4411,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -5029,6 +5058,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -5668,6 +5706,15 @@ declare const editorMachine: StateMachine<
             | {
                 type: 'notify.unset'
                 previousValue: Array<PortableTextBlock>
+              }
+            | {
+                type: 'dragstart'
+              }
+            | {
+                type: 'dragend'
+              }
+            | {
+                type: 'drop'
               },
             undefined,
             never,
@@ -6032,6 +6079,15 @@ declare const editorMachine: StateMachine<
             | {
                 type: 'notify.unset'
                 previousValue: Array<PortableTextBlock>
+              }
+            | {
+                type: 'dragstart'
+              }
+            | {
+                type: 'dragend'
+              }
+            | {
+                type: 'drop'
               },
             undefined,
             never,
@@ -6671,6 +6727,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -7308,6 +7373,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -7946,6 +8020,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -8587,6 +8670,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -9228,6 +9320,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -9597,6 +9698,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -9963,6 +10073,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -10479,6 +10598,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -11125,6 +11253,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -11764,6 +11901,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -12403,6 +12549,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -13055,6 +13210,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -13708,6 +13872,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -14347,6 +14520,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -14989,6 +15171,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -15682,6 +15873,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -16330,6 +16530,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -16979,6 +17188,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -17619,6 +17837,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -18261,6 +18488,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -18909,6 +19145,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -19204,6 +19449,27 @@ declare const editorMachine: StateMachine<
                 >
               }
             }
+            readonly initial: 'idle'
+            readonly states: {
+              readonly 'idle': {
+                readonly on: {
+                  readonly dragstart: {
+                    readonly target: 'dragging internally'
+                  }
+                }
+              }
+              readonly 'dragging internally': {
+                readonly tags: readonly ['dragging internally']
+                readonly on: {
+                  readonly dragend: {
+                    readonly target: 'idle'
+                  }
+                  readonly drop: {
+                    readonly target: 'idle'
+                  }
+                }
+              }
+            }
           }
         }
       }
@@ -19343,6 +19609,13 @@ export declare type EditorSelector<TSelected> = (
  */
 export declare type EditorSnapshot = {
   context: EditorContext
+  /**
+   * @beta
+   * Do not rely on this externally
+   */
+  beta: {
+    hasTag: HasTag
+  }
 }
 
 /**
@@ -19402,6 +19675,8 @@ export declare type FocusChange = {
   event: FocusEvent_2<HTMLDivElement, Element>
 }
 
+declare type HasTag = ReturnType<EditorActor['getSnapshot']>['hasTag']
+
 /** @internal */
 declare interface History_2 {
   redos: HistoryItem[]
@@ -19767,9 +20042,9 @@ export declare class PortableTextEditor extends Component<
     path: Path,
   ) => [
     (
-      | PortableTextSpan
+      | PortableTextTextBlock<PortableTextObject | PortableTextSpan>
       | PortableTextObject
-      | PortableTextTextBlock<PortableTextSpan | PortableTextObject>
+      | PortableTextSpan
       | undefined
     ),
     Path | undefined,
@@ -20320,10 +20595,10 @@ export declare type SelectionChange = {
 }
 
 declare type Serializer<TMIMEType extends MIMEType> = ({
-  context,
+  snapshot,
   event,
 }: {
-  context: EditorContext
+  snapshot: EditorSnapshot
   event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'serialize'>
 }) => PickFromUnion<
   ConverterEvent<TMIMEType>,