@portabletext/editor 1.1.5 → 1.1.6

package/lib/index.d.mts

@@ -60,6 +60,66 @@ import {
   Values,
 } from 'xstate'
 
+/**
+ * @alpha
+ */
+export declare type Behavior<
+  TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
+  TGuardResponse = true,
+> = {
+  on: TBehaviorEventType
+  guard?: BehaviorGuard<
+    PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>,
+    TGuardResponse
+  >
+  actions: Array<RaiseBehaviorActionIntend<TBehaviorEventType, TGuardResponse>>
+}
+
+/**
+ * @alpha
+ */
+export declare type BehaviorActionIntend =
+  | {
+      type: 'insert text'
+      text: string
+    }
+  | {
+      type: 'insert text block'
+      decorators: Array<string>
+    }
+
+/**
+ * @alpha
+ */
+export declare type BehaviorContext = {
+  schema: PortableTextMemberSchemaTypes
+  value: Array<PortableTextBlock>
+  selection: NonNullable<EditorSelection>
+}
+
+/**
+ * @alpha
+ */
+export declare type BehaviorEvent = {
+  type: 'key down'
+  nativeEvent: KeyboardEvent
+  editor: PortableTextSlateEditor
+}
+
+/**
+ * @alpha
+ */
+export declare type BehaviorGuard<
+  TBehaviorEvent extends BehaviorEvent,
+  TGuardResponse,
+> = ({
+  context,
+  event,
+}: {
+  event: TBehaviorEvent
+  context: BehaviorContext
+}) => TGuardResponse | false
+
 /** @beta */
 export declare interface BlockAnnotationRenderProps {
   block: PortableTextBlock
@@ -274,9 +334,24 @@ export declare type EditorChanges = Subject<EditorChange>
  */
 export declare const editorMachine: StateMachine<
   {
+    behaviors: Array<Behavior>
     keyGenerator: () => string
     pendingEvents: Array<PatchEvent | MutationEvent_2>
+    schema: PortableTextMemberSchemaTypes
   },
+  | BehaviorEvent
+  | ({
+      type: 'insert text'
+      text: string
+    } & {
+      editor: PortableTextSlateEditor
+    })
+  | ({
+      type: 'insert text block'
+      decorators: Array<string>
+    } & {
+      editor: PortableTextSlateEditor
+    })
   | PatchEvent
   | MutationEvent_2
   | {
@@ -285,6 +360,10 @@ export declare const editorMachine: StateMachine<
   | {
       type: 'done normalizing'
     }
+  | {
+      type: 'update schema'
+      schema: PortableTextMemberSchemaTypes
+    }
   | {
       type: 'ready'
     }
@@ -344,6 +423,18 @@ export declare const editorMachine: StateMachine<
     id: string | undefined
   },
   Values<{
+    'apply:insert text': {
+      type: 'apply:insert text'
+      params: unknown
+    }
+    'apply:insert text block': {
+      type: 'apply:insert text block'
+      params: unknown
+    }
+    'assign schema': {
+      type: 'assign schema'
+      params: NonReducibleUnknown
+    }
     'emit patch event': {
       type: 'emit patch event'
       params: NonReducibleUnknown
@@ -364,6 +455,10 @@ export declare const editorMachine: StateMachine<
       type: 'clear pending events'
       params: NonReducibleUnknown
     }
+    'handle behavior event': {
+      type: 'handle behavior event'
+      params: NonReducibleUnknown
+    }
   }>,
   never,
   never,
@@ -373,7 +468,9 @@ export declare const editorMachine: StateMachine<
     },
   string,
   {
+    behaviors: Array<Behavior>
     keyGenerator: () => string
+    schema: PortableTextMemberSchemaTypes
   },
   NonReducibleUnknown,
   | PatchEvent
@@ -498,14 +595,31 @@ export declare const editorMachine: StateMachine<
         ): ActorRefFromLogic<TLogic>
       }
       input: {
+        behaviors: Array<Behavior>
         keyGenerator: () => string
+        schema: PortableTextMemberSchemaTypes
       }
       self: ActorRef<
         MachineSnapshot<
           {
+            behaviors: Array<Behavior>
             keyGenerator: () => string
             pendingEvents: Array<PatchEvent | MutationEvent_2>
+            schema: PortableTextMemberSchemaTypes
           },
+          | BehaviorEvent
+          | ({
+              type: 'insert text'
+              text: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'insert text block'
+              decorators: Array<string>
+            } & {
+              editor: PortableTextSlateEditor
+            })
           | PatchEvent
           | MutationEvent_2
           | {
@@ -514,6 +628,10 @@ export declare const editorMachine: StateMachine<
           | {
               type: 'done normalizing'
             }
+          | {
+              type: 'update schema'
+              schema: PortableTextMemberSchemaTypes
+            }
           | {
               type: 'ready'
             }
@@ -567,6 +685,19 @@ export declare const editorMachine: StateMachine<
           any,
           any
         >,
+        | BehaviorEvent
+        | ({
+            type: 'insert text'
+            text: string
+          } & {
+            editor: PortableTextSlateEditor
+          })
+        | ({
+            type: 'insert text block'
+            decorators: Array<string>
+          } & {
+            editor: PortableTextSlateEditor
+          })
         | PatchEvent
         | MutationEvent_2
         | {
@@ -575,6 +706,10 @@ export declare const editorMachine: StateMachine<
         | {
             type: 'done normalizing'
           }
+        | {
+            type: 'update schema'
+            schema: PortableTextMemberSchemaTypes
+          }
         | {
             type: 'ready'
           }
@@ -624,8 +759,10 @@ export declare const editorMachine: StateMachine<
         AnyEventObject
       >
     }) => {
+      behaviors: Behavior[]
       keyGenerator: () => string
       pendingEvents: never[]
+      schema: PortableTextMemberSchemaTypes
     }
     readonly invoke: {
       readonly id: 'networkLogic'
@@ -635,12 +772,27 @@ export declare const editorMachine: StateMachine<
       readonly 'ready': {
         readonly actions: ActionFunction<
           {
+            behaviors: Array<Behavior>
             keyGenerator: () => string
             pendingEvents: Array<PatchEvent | MutationEvent_2>
+            schema: PortableTextMemberSchemaTypes
           },
           {
             type: 'ready'
           },
+          | BehaviorEvent
+          | ({
+              type: 'insert text'
+              text: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'insert text block'
+              decorators: Array<string>
+            } & {
+              editor: PortableTextSlateEditor
+            })
           | PatchEvent
           | MutationEvent_2
           | {
@@ -649,6 +801,10 @@ export declare const editorMachine: StateMachine<
           | {
               type: 'done normalizing'
             }
+          | {
+              type: 'update schema'
+              schema: PortableTextMemberSchemaTypes
+            }
           | {
               type: 'ready'
             }
@@ -753,13 +909,28 @@ export declare const editorMachine: StateMachine<
       readonly 'unset': {
         readonly actions: ActionFunction<
           {
+            behaviors: Array<Behavior>
             keyGenerator: () => string
             pendingEvents: Array<PatchEvent | MutationEvent_2>
+            schema: PortableTextMemberSchemaTypes
           },
           {
             type: 'unset'
             previousValue: Array<PortableTextBlock>
           },
+          | BehaviorEvent
+          | ({
+              type: 'insert text'
+              text: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'insert text block'
+              decorators: Array<string>
+            } & {
+              editor: PortableTextSlateEditor
+            })
           | PatchEvent
           | MutationEvent_2
           | {
@@ -768,6 +939,10 @@ export declare const editorMachine: StateMachine<
           | {
               type: 'done normalizing'
             }
+          | {
+              type: 'update schema'
+              schema: PortableTextMemberSchemaTypes
+            }
           | {
               type: 'ready'
             }
@@ -872,13 +1047,28 @@ export declare const editorMachine: StateMachine<
       readonly 'value changed': {
         readonly actions: ActionFunction<
           {
+            behaviors: Array<Behavior>
             keyGenerator: () => string
             pendingEvents: Array<PatchEvent | MutationEvent_2>
+            schema: PortableTextMemberSchemaTypes
           },
           {
             type: 'value changed'
             value: Array<PortableTextBlock> | undefined
           },
+          | BehaviorEvent
+          | ({
+              type: 'insert text'
+              text: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'insert text block'
+              decorators: Array<string>
+            } & {
+              editor: PortableTextSlateEditor
+            })
           | PatchEvent
           | MutationEvent_2
           | {
@@ -887,6 +1077,10 @@ export declare const editorMachine: StateMachine<
           | {
               type: 'done normalizing'
             }
+          | {
+              type: 'update schema'
+              schema: PortableTextMemberSchemaTypes
+            }
           | {
               type: 'ready'
             }
@@ -991,14 +1185,29 @@ export declare const editorMachine: StateMachine<
       readonly 'invalid value': {
         readonly actions: ActionFunction<
           {
+            behaviors: Array<Behavior>
             keyGenerator: () => string
             pendingEvents: Array<PatchEvent | MutationEvent_2>
+            schema: PortableTextMemberSchemaTypes
           },
           {
             type: 'invalid value'
             resolution: InvalidValueResolution | null
             value: Array<PortableTextBlock> | undefined
           },
+          | BehaviorEvent
+          | ({
+              type: 'insert text'
+              text: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'insert text block'
+              decorators: Array<string>
+            } & {
+              editor: PortableTextSlateEditor
+            })
           | PatchEvent
           | MutationEvent_2
           | {
@@ -1007,6 +1216,10 @@ export declare const editorMachine: StateMachine<
           | {
               type: 'done normalizing'
             }
+          | {
+              type: 'update schema'
+              schema: PortableTextMemberSchemaTypes
+            }
           | {
               type: 'ready'
             }
@@ -1111,8 +1324,10 @@ export declare const editorMachine: StateMachine<
       readonly 'error': {
         readonly actions: ActionFunction<
           {
+            behaviors: Array<Behavior>
             keyGenerator: () => string
             pendingEvents: Array<PatchEvent | MutationEvent_2>
+            schema: PortableTextMemberSchemaTypes
           },
           {
             type: 'error'
@@ -1120,6 +1335,19 @@ export declare const editorMachine: StateMachine<
             description: string
             data: unknown
           },
+          | BehaviorEvent
+          | ({
+              type: 'insert text'
+              text: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'insert text block'
+              decorators: Array<string>
+            } & {
+              editor: PortableTextSlateEditor
+            })
           | PatchEvent
           | MutationEvent_2
           | {
@@ -1128,6 +1356,10 @@ export declare const editorMachine: StateMachine<
           | {
               type: 'done normalizing'
             }
+          | {
+              type: 'update schema'
+              schema: PortableTextMemberSchemaTypes
+            }
           | {
               type: 'ready'
             }
@@ -1232,13 +1464,28 @@ export declare const editorMachine: StateMachine<
       readonly 'selection': {
         readonly actions: ActionFunction<
           {
+            behaviors: Array<Behavior>
             keyGenerator: () => string
             pendingEvents: Array<PatchEvent | MutationEvent_2>
+            schema: PortableTextMemberSchemaTypes
           },
           {
             type: 'selection'
             selection: EditorSelection
           },
+          | BehaviorEvent
+          | ({
+              type: 'insert text'
+              text: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'insert text block'
+              decorators: Array<string>
+            } & {
+              editor: PortableTextSlateEditor
+            })
           | PatchEvent
           | MutationEvent_2
           | {
@@ -1247,6 +1494,10 @@ export declare const editorMachine: StateMachine<
           | {
               type: 'done normalizing'
             }
+          | {
+              type: 'update schema'
+              schema: PortableTextMemberSchemaTypes
+            }
           | {
               type: 'ready'
             }
@@ -1351,13 +1602,28 @@ export declare const editorMachine: StateMachine<
       readonly 'blur': {
         readonly actions: ActionFunction<
           {
+            behaviors: Array<Behavior>
             keyGenerator: () => string
             pendingEvents: Array<PatchEvent | MutationEvent_2>
+            schema: PortableTextMemberSchemaTypes
           },
           {
             type: 'blur'
             event: FocusEvent_2<HTMLDivElement, Element>
           },
+          | BehaviorEvent
+          | ({
+              type: 'insert text'
+              text: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'insert text block'
+              decorators: Array<string>
+            } & {
+              editor: PortableTextSlateEditor
+            })
           | PatchEvent
           | MutationEvent_2
           | {
@@ -1366,6 +1632,10 @@ export declare const editorMachine: StateMachine<
           | {
               type: 'done normalizing'
             }
+          | {
+              type: 'update schema'
+              schema: PortableTextMemberSchemaTypes
+            }
           | {
               type: 'ready'
             }
@@ -1470,13 +1740,28 @@ export declare const editorMachine: StateMachine<
       readonly 'focus': {
         readonly actions: ActionFunction<
           {
+            behaviors: Array<Behavior>
             keyGenerator: () => string
             pendingEvents: Array<PatchEvent | MutationEvent_2>
+            schema: PortableTextMemberSchemaTypes
           },
           {
             type: 'focus'
             event: FocusEvent_2<HTMLDivElement, Element>
           },
+          | BehaviorEvent
+          | ({
+              type: 'insert text'
+              text: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'insert text block'
+              decorators: Array<string>
+            } & {
+              editor: PortableTextSlateEditor
+            })
           | PatchEvent
           | MutationEvent_2
           | {
@@ -1485,6 +1770,10 @@ export declare const editorMachine: StateMachine<
           | {
               type: 'done normalizing'
             }
+          | {
+              type: 'update schema'
+              schema: PortableTextMemberSchemaTypes
+            }
           | {
               type: 'ready'
             }
@@ -1589,12 +1878,27 @@ export declare const editorMachine: StateMachine<
       readonly 'online': {
         readonly actions: ActionFunction<
           {
+            behaviors: Array<Behavior>
             keyGenerator: () => string
             pendingEvents: Array<PatchEvent | MutationEvent_2>
+            schema: PortableTextMemberSchemaTypes
           },
           {
             type: 'online'
           },
+          | BehaviorEvent
+          | ({
+              type: 'insert text'
+              text: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'insert text block'
+              decorators: Array<string>
+            } & {
+              editor: PortableTextSlateEditor
+            })
           | PatchEvent
           | MutationEvent_2
           | {
@@ -1603,6 +1907,10 @@ export declare const editorMachine: StateMachine<
           | {
               type: 'done normalizing'
             }
+          | {
+              type: 'update schema'
+              schema: PortableTextMemberSchemaTypes
+            }
           | {
               type: 'ready'
             }
@@ -1707,12 +2015,27 @@ export declare const editorMachine: StateMachine<
       readonly 'offline': {
         readonly actions: ActionFunction<
           {
+            behaviors: Array<Behavior>
             keyGenerator: () => string
             pendingEvents: Array<PatchEvent | MutationEvent_2>
+            schema: PortableTextMemberSchemaTypes
           },
           {
             type: 'offline'
           },
+          | BehaviorEvent
+          | ({
+              type: 'insert text'
+              text: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'insert text block'
+              decorators: Array<string>
+            } & {
+              editor: PortableTextSlateEditor
+            })
           | PatchEvent
           | MutationEvent_2
           | {
@@ -1721,6 +2044,10 @@ export declare const editorMachine: StateMachine<
           | {
               type: 'done normalizing'
             }
+          | {
+              type: 'update schema'
+              schema: PortableTextMemberSchemaTypes
+            }
           | {
               type: 'ready'
             }
@@ -1825,12 +2152,27 @@ export declare const editorMachine: StateMachine<
       readonly 'loading': {
         readonly actions: ActionFunction<
           {
+            behaviors: Array<Behavior>
             keyGenerator: () => string
             pendingEvents: Array<PatchEvent | MutationEvent_2>
+            schema: PortableTextMemberSchemaTypes
           },
           {
             type: 'loading'
           },
+          | BehaviorEvent
+          | ({
+              type: 'insert text'
+              text: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'insert text block'
+              decorators: Array<string>
+            } & {
+              editor: PortableTextSlateEditor
+            })
           | PatchEvent
           | MutationEvent_2
           | {
@@ -1839,6 +2181,10 @@ export declare const editorMachine: StateMachine<
           | {
               type: 'done normalizing'
             }
+          | {
+              type: 'update schema'
+              schema: PortableTextMemberSchemaTypes
+            }
           | {
               type: 'ready'
             }
@@ -1943,12 +2289,27 @@ export declare const editorMachine: StateMachine<
       readonly 'done loading': {
         readonly actions: ActionFunction<
           {
+            behaviors: Array<Behavior>
             keyGenerator: () => string
             pendingEvents: Array<PatchEvent | MutationEvent_2>
+            schema: PortableTextMemberSchemaTypes
           },
           {
             type: 'done loading'
           },
+          | BehaviorEvent
+          | ({
+              type: 'insert text'
+              text: string
+            } & {
+              editor: PortableTextSlateEditor
+            })
+          | ({
+              type: 'insert text block'
+              decorators: Array<string>
+            } & {
+              editor: PortableTextSlateEditor
+            })
           | PatchEvent
           | MutationEvent_2
           | {
@@ -1957,6 +2318,10 @@ export declare const editorMachine: StateMachine<
           | {
               type: 'done normalizing'
             }
+          | {
+              type: 'update schema'
+              schema: PortableTextMemberSchemaTypes
+            }
           | {
               type: 'ready'
             }
@@ -2058,6 +2423,18 @@ export declare const editorMachine: StateMachine<
             }
         >
       }
+      readonly 'update schema': {
+        readonly actions: 'assign schema'
+      }
+      readonly 'key down': {
+        readonly actions: readonly ['handle behavior event']
+      }
+      readonly 'insert text': {
+        readonly actions: readonly ['apply:insert text']
+      }
+      readonly 'insert text block': {
+        readonly actions: readonly ['apply:insert text block']
+      }
     }
     readonly initial: 'pristine'
     readonly states: {
@@ -2299,6 +2676,15 @@ export declare type PatchObservable = Observable<{
   snapshot: PortableTextBlock[] | undefined
 }>
 
+/**
+ * @alpha
+ */
+export declare type PickFromUnion<
+  TUnion,
+  TTagKey extends keyof TUnion,
+  TPickedTags extends TUnion[TTagKey],
+> = TUnion extends Record<TTagKey, TPickedTags> ? TUnion : never
+
 /**
  * @public
  */
@@ -2645,6 +3031,23 @@ export declare interface PortableTextSlateEditor extends ReactEditor {
   redo: () => void
 }
 
+/**
+ * @alpha
+ */
+export declare type RaiseBehaviorActionIntend<
+  TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
+  TGuardResponse = true,
+> = (
+  {
+    context,
+    event,
+  }: {
+    context: BehaviorContext
+    event: PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>
+  },
+  guardResponse: TGuardResponse,
+) => BehaviorActionIntend | void
+
 /**
  * A range decoration is a UI affordance that wraps a given selection range in the editor
  * with a custom component. This can be used to highlight search results,