@portabletext/editor 1.34.1 → 1.35.1

package/lib/plugins/index.d.ts

@@ -101,11 +101,13 @@ declare type BehaviorActionIntend =
  * @beta
  */
 declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
-  {
-    context,
-    event,
-  }: {
+  payload: {
+    /**
+     * @deprecated
+     * Use `snapshot` instead
+     */
     context: EditorContext
+    snapshot: EditorSnapshot
     event: TBehaviorEvent
   },
   guardResponse: TGuardResponse,
@@ -122,11 +124,13 @@ declare type BehaviorEvent =
 /**
  * @beta
  */
-declare type BehaviorGuard<TBehaviorEvent, TGuardResponse> = ({
-  context,
-  event,
-}: {
+declare type BehaviorGuard<TBehaviorEvent, TGuardResponse> = (payload: {
+  /**
+   * @deprecated
+   * Use `snapshot` instead
+   */
   context: EditorContext
+  snapshot: EditorSnapshot
   event: TBehaviorEvent
 }) => TGuardResponse | false
 
@@ -195,10 +199,10 @@ declare type CustomBehaviorEvent<
 } & TPayload
 
 declare type Deserializer<TMIMEType extends MIMEType> = ({
-  context,
+  snapshot,
   event,
 }: {
-  context: EditorContext
+  snapshot: EditorSnapshot
   event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'deserialize'>
 }) => PickFromUnion<
   ConverterEvent<TMIMEType>,
@@ -742,6 +746,15 @@ declare const editorMachine: StateMachine<
   | {
       type: 'notify.unset'
       previousValue: Array<PortableTextBlock>
+    }
+  | {
+      type: 'dragstart'
+    }
+  | {
+      type: 'dragend'
+    }
+  | {
+      type: 'drop'
     },
   {},
   never,
@@ -803,7 +816,9 @@ declare const editorMachine: StateMachine<
   never,
   {
     'edit mode':
-      | 'editable'
+      | {
+          editable: 'dragging internally' | 'idle'
+        }
       | {
           'read only': 'read only' | 'determine initial edit mode'
         }
@@ -814,7 +829,7 @@ declare const editorMachine: StateMachine<
           pristine: 'normalizing' | 'idle'
         }
   },
-  string,
+  'dragging internally',
   {
     behaviors?: Array<Behavior>
     converters?: Array<Converter>
@@ -1488,6 +1503,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           Record<string, AnyActorRef | undefined>,
           StateValue,
@@ -1836,6 +1860,15 @@ declare const editorMachine: StateMachine<
         | {
             type: 'notify.unset'
             previousValue: Array<PortableTextBlock>
+          }
+        | {
+            type: 'dragstart'
+          }
+        | {
+            type: 'dragend'
+          }
+        | {
+            type: 'drop'
           },
         AnyEventObject
       >
@@ -2208,6 +2241,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -2845,6 +2887,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -3485,6 +3536,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -4124,6 +4184,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -4762,6 +4831,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -5401,6 +5479,15 @@ declare const editorMachine: StateMachine<
             | {
                 type: 'notify.unset'
                 previousValue: Array<PortableTextBlock>
+              }
+            | {
+                type: 'dragstart'
+              }
+            | {
+                type: 'dragend'
+              }
+            | {
+                type: 'drop'
               },
             undefined,
             never,
@@ -5765,6 +5852,15 @@ declare const editorMachine: StateMachine<
             | {
                 type: 'notify.unset'
                 previousValue: Array<PortableTextBlock>
+              }
+            | {
+                type: 'dragstart'
+              }
+            | {
+                type: 'dragend'
+              }
+            | {
+                type: 'drop'
               },
             undefined,
             never,
@@ -6404,6 +6500,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -7041,6 +7146,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -7679,6 +7793,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -8320,6 +8443,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -8961,6 +9093,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -9330,6 +9471,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -9696,6 +9846,15 @@ declare const editorMachine: StateMachine<
           | {
               type: 'notify.unset'
               previousValue: Array<PortableTextBlock>
+            }
+          | {
+              type: 'dragstart'
+            }
+          | {
+              type: 'dragend'
+            }
+          | {
+              type: 'drop'
             },
           undefined,
           never,
@@ -10212,6 +10371,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -10858,6 +11026,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -11497,6 +11674,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -12136,6 +12322,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -12788,6 +12983,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -13441,6 +13645,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -14080,6 +14293,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -14722,6 +14944,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -15415,6 +15646,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -16063,6 +16303,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -16712,6 +16961,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -17352,6 +17610,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -17994,6 +18261,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -18642,6 +18918,15 @@ declare const editorMachine: StateMachine<
                   | {
                       type: 'notify.unset'
                       previousValue: Array<PortableTextBlock>
+                    }
+                  | {
+                      type: 'dragstart'
+                    }
+                  | {
+                      type: 'dragend'
+                    }
+                  | {
+                      type: 'drop'
                     },
                   undefined,
                   never,
@@ -18937,6 +19222,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'
+                  }
+                }
+              }
+            }
           }
         }
       }
@@ -19040,6 +19346,13 @@ declare type EditorSelectionPoint = {
  */
 declare type EditorSnapshot = {
   context: EditorContext
+  /**
+   * @beta
+   * Do not rely on this externally
+   */
+  beta: {
+    hasTag: HasTag
+  }
 }
 
 /**
@@ -19133,6 +19446,8 @@ declare type ExternalEditorEvent =
     }
   | PatchesEvent
 
+declare type HasTag = ReturnType<EditorActor['getSnapshot']>['hasTag']
+
 /** @internal */
 declare interface History_2 {
   redos: HistoryItem[]
@@ -19190,14 +19505,6 @@ declare type MarkdownBehaviorsConfig = {
   orderedListStyle?: (context: {schema: EditorSchema}) => string | undefined
 }
 
-/**
- * @beta
- */
-declare type MarkdownEmphasisBehaviorsConfig = {
-  boldDecorator?: ({schema}: {schema: EditorSchema}) => string | undefined
-  italicDecorator?: ({schema}: {schema: EditorSchema}) => string | undefined
-}
-
 /**
  * @beta
  * Add markdown behaviors for common markdown actions such as converting ### to headings, --- to HRs, and more.
@@ -19215,8 +19522,12 @@ declare type MarkdownEmphasisBehaviorsConfig = {
  *        config={{
  *          boldDecorator: ({schema}) =>
  *            schema.decorators.find((decorator) => decorator.value === 'strong')?.value,
+ *          codeDecorator: ({schema}) =>
+ *            schema.decorators.find((decorator) => decorator.value === 'code')?.value,
  *          italicDecorator: ({schema}) =>
  *            schema.decorators.find((decorator) => decorator.value === 'em')?.value,
+ *          strikeThroughDecorator: ({schema}) =>
+ *            schema.decorators.find((decorator) => decorator.value === 'strike-through')?.value,
  *          horizontalRuleObject: ({schema}) => {
  *            const name = schema.blockObjects.find(
  *              (object) => object.name === 'break',
@@ -19243,13 +19554,21 @@ declare type MarkdownEmphasisBehaviorsConfig = {
  */
 export declare function MarkdownPlugin(props: {
   config: MarkdownPluginConfig
-}): null
+}): JSX.Element
 
 /**
  * @beta
  */
-export declare type MarkdownPluginConfig = MarkdownBehaviorsConfig &
-  MarkdownEmphasisBehaviorsConfig
+export declare type MarkdownPluginConfig = MarkdownBehaviorsConfig & {
+  boldDecorator?: ({schema}: {schema: EditorSchema}) => string | undefined
+  codeDecorator?: ({schema}: {schema: EditorSchema}) => string | undefined
+  italicDecorator?: ({schema}: {schema: EditorSchema}) => string | undefined
+  strikeThroughDecorator?: ({
+    schema,
+  }: {
+    schema: EditorSchema
+  }) => string | undefined
+}
 
 declare type MIMEType = `${string}/${string}`
 
@@ -19385,10 +19704,10 @@ declare interface PortableTextSlateEditor extends ReactEditor {
 }
 
 declare type Serializer<TMIMEType extends MIMEType> = ({
-  context,
+  snapshot,
   event,
 }: {
-  context: EditorContext
+  snapshot: EditorSnapshot
   event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'serialize'>
 }) => PickFromUnion<
   ConverterEvent<TMIMEType>,