@portabletext/editor 1.9.0 → 1.10.1

package/lib/index.d.mts

@@ -752,6 +752,7 @@ export declare type EditorChanges = Subject<EditorChange>
 export declare type EditorConfig = {
   behaviors?: Array<Behavior>
   keyGenerator?: () => string
+  initialValue?: Array<PortableTextBlock>
 } & (
   | {
       schemaDefinition: SchemaDefinition
@@ -774,6 +775,7 @@ export declare type EditorEvent = PickFromUnion<
   | 'patches'
   | 'toggle readOnly'
   | 'update behaviors'
+  | 'update value'
 >
 
 /**
@@ -787,6 +789,7 @@ export declare const editorMachine: StateMachine<
     schema: PortableTextMemberSchemaTypes
     readOnly: boolean
     maxBlocks: number | undefined
+    value: Array<PortableTextBlock> | undefined
   },
   | {
       type: 'annotation.add'
@@ -841,6 +844,10 @@ export declare const editorMachine: StateMachine<
       type: 'update behaviors'
       behaviors: Array<Behavior>
     }
+  | {
+      type: 'update value'
+      value: Array<PortableTextBlock> | undefined
+    }
   | {
       type: 'toggle readOnly'
     }
@@ -952,6 +959,7 @@ export declare const editorMachine: StateMachine<
     behaviors?: Array<Behavior>
     keyGenerator: () => string
     schema: PortableTextMemberSchemaTypes
+    value?: Array<PortableTextBlock>
   },
   NonReducibleUnknown,
   | {
@@ -1107,6 +1115,7 @@ export declare const editorMachine: StateMachine<
         behaviors?: Array<Behavior>
         keyGenerator: () => string
         schema: PortableTextMemberSchemaTypes
+        value?: Array<PortableTextBlock>
       }
       self: ActorRef<
         MachineSnapshot<
@@ -1117,6 +1126,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           | {
               type: 'annotation.add'
@@ -1171,6 +1181,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -1285,6 +1299,10 @@ export declare const editorMachine: StateMachine<
             type: 'update behaviors'
             behaviors: Array<Behavior>
           }
+        | {
+            type: 'update value'
+            value: Array<PortableTextBlock> | undefined
+          }
         | {
             type: 'toggle readOnly'
           }
@@ -1348,6 +1366,7 @@ export declare const editorMachine: StateMachine<
       schema: PortableTextMemberSchemaTypes
       readOnly: false
       maxBlocks: undefined
+      value: PortableTextBlock[] | undefined
     }
     readonly invoke: {
       readonly id: 'networkLogic'
@@ -1363,6 +1382,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'annotation.add'
@@ -1426,6 +1446,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -1572,6 +1596,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'annotation.add'
@@ -1593,6 +1618,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'annotation.remove'
@@ -1653,6 +1679,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -1799,6 +1829,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'annotation.remove'
@@ -1817,6 +1848,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'annotation.toggle'
@@ -1880,6 +1912,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -2026,6 +2062,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'annotation.toggle'
@@ -2047,6 +2084,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'focus'
@@ -2104,6 +2142,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -2250,6 +2292,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'focus'
@@ -2265,6 +2308,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'ready'
@@ -2322,6 +2366,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -2468,6 +2516,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'unset'
@@ -2526,6 +2575,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -2672,6 +2725,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'value changed'
@@ -2730,6 +2784,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -2876,6 +2934,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'invalid value'
@@ -2935,6 +2994,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -3081,6 +3144,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'error'
@@ -3141,6 +3205,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -3287,6 +3355,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'selection'
@@ -3345,6 +3414,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -3491,6 +3564,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'blur'
@@ -3549,6 +3623,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -3695,6 +3773,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'focused'
@@ -3753,6 +3832,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -3899,6 +3982,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'online'
@@ -3956,6 +4040,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -4102,6 +4190,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'offline'
@@ -4159,6 +4248,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -4305,6 +4398,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'loading'
@@ -4362,6 +4456,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -4508,6 +4606,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           PatchesEvent,
           | {
@@ -4563,6 +4662,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -4709,6 +4812,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'done loading'
@@ -4766,6 +4870,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -4909,6 +5017,148 @@ export declare const editorMachine: StateMachine<
       readonly 'update schema': {
         readonly actions: 'assign schema'
       }
+      readonly 'update value': {
+        readonly actions: ActionFunction<
+          {
+            behaviors: Array<Behavior>
+            keyGenerator: () => string
+            pendingEvents: Array<PatchEvent | MutationEvent_2>
+            schema: PortableTextMemberSchemaTypes
+            readOnly: boolean
+            maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
+          },
+          {
+            type: 'update value'
+            value: Array<PortableTextBlock> | undefined
+          },
+          | {
+              type: 'annotation.add'
+              annotation: {
+                name: string
+                value: {
+                  [prop: string]: unknown
+                }
+              }
+            }
+          | {
+              type: 'annotation.remove'
+              annotation: {
+                name: string
+              }
+            }
+          | {
+              type: 'annotation.toggle'
+              annotation: {
+                name: string
+                value: {
+                  [prop: string]: unknown
+                }
+              }
+            }
+          | {
+              type: 'focus'
+            }
+          | 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: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
+          | {
+              type: 'toggle readOnly'
+            }
+          | {
+              type: 'update maxBlocks'
+              maxBlocks: number | undefined
+            }
+          | {
+              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: 'focused'
+              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
+          },
+          never,
+          never,
+          never,
+          never
+        >
+      }
       readonly 'toggle readOnly': {
         readonly actions: ActionFunction<
           {
@@ -4918,6 +5168,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'toggle readOnly'
@@ -4975,6 +5226,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -5054,6 +5309,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'update maxBlocks'
@@ -5112,6 +5368,10 @@ export declare const editorMachine: StateMachine<
               type: 'update behaviors'
               behaviors: Array<Behavior>
             }
+          | {
+              type: 'update value'
+              value: Array<PortableTextBlock> | undefined
+            }
           | {
               type: 'toggle readOnly'
             }
@@ -5194,6 +5454,7 @@ export declare const editorMachine: StateMachine<
             schema: PortableTextMemberSchemaTypes
             readOnly: boolean
             maxBlocks: number | undefined
+            value: Array<PortableTextBlock> | undefined
           },
           {
             type: 'behavior event'
@@ -5215,6 +5476,7 @@ export declare const editorMachine: StateMachine<
               schema: PortableTextMemberSchemaTypes
               readOnly: boolean
               maxBlocks: number | undefined
+              value: Array<PortableTextBlock> | undefined
             },
             {
               type: 'behavior action intends'
@@ -5274,6 +5536,10 @@ export declare const editorMachine: StateMachine<
                 type: 'update behaviors'
                 behaviors: Array<Behavior>
               }
+            | {
+                type: 'update value'
+                value: Array<PortableTextBlock> | undefined
+              }
             | {
                 type: 'toggle readOnly'
               }
@@ -5337,6 +5603,7 @@ export declare const editorMachine: StateMachine<
               schema: PortableTextMemberSchemaTypes
               readOnly: boolean
               maxBlocks: number | undefined
+              value: Array<PortableTextBlock> | undefined
             },
             {
               type: 'behavior action intends'
@@ -5396,6 +5663,10 @@ export declare const editorMachine: StateMachine<
                 type: 'update behaviors'
                 behaviors: Array<Behavior>
               }
+            | {
+                type: 'update value'
+                value: Array<PortableTextBlock> | undefined
+              }
             | {
                 type: 'toggle readOnly'
               }
@@ -5775,6 +6046,10 @@ export declare type InternalEditorEvent =
       type: 'update behaviors'
       behaviors: Array<Behavior>
     }
+  | {
+      type: 'update value'
+      value: Array<PortableTextBlock> | undefined
+    }
   | {
       type: 'toggle readOnly'
     }
@@ -5825,7 +6100,7 @@ export declare const keyGenerator: () => string
  * @alpha
  */
 export declare type LinkBehaviorsConfig = {
-  mapLinkAnnotation?: (config: {
+  linkAnnotation?: (context: {
     schema: PortableTextMemberSchemaTypes
     url: string
   }) =>
@@ -5851,7 +6126,7 @@ export declare type LoadingChange = {
  * @alpha
  */
 export declare type MarkdownBehaviorsConfig = {
-  mapBreakObject?: (schema: PortableTextMemberSchemaTypes) =>
+  horizontalRuleObject?: (context: {schema: PortableTextMemberSchemaTypes}) =>
     | {
         name: string
         value?: {
@@ -5859,22 +6134,22 @@ export declare type MarkdownBehaviorsConfig = {
         }
       }
     | undefined
-  mapDefaultStyle?: (
-    schema: PortableTextMemberSchemaTypes,
-  ) => string | undefined
-  mapHeadingStyle?: (
-    schema: PortableTextMemberSchemaTypes,
-    level: number,
-  ) => string | undefined
-  mapBlockquoteStyle?: (
-    schema: PortableTextMemberSchemaTypes,
-  ) => string | undefined
-  mapUnorderedListStyle?: (
-    schema: PortableTextMemberSchemaTypes,
-  ) => string | undefined
-  mapOrderedListStyle?: (
-    schema: PortableTextMemberSchemaTypes,
-  ) => string | 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
 }
 
 /**
@@ -6214,16 +6489,15 @@ export declare type PortableTextEditorProps<
          * Whether or not the editor should be in read-only mode
          */
         readOnly?: boolean
-      }) & {
-    /**
-     * The current value of the portable text field
-     */
-    value?: PortableTextBlock[]
-    /**
-     * A ref to the editor instance
-     */
-    editorRef?: MutableRefObject<PortableTextEditor | null>
-  }
+        /**
+         * The current value of the portable text field
+         */
+        value?: PortableTextBlock[]
+        /**
+         * A ref to the editor instance
+         */
+        editorRef?: MutableRefObject<PortableTextEditor | null>
+      }) & {}
 >
 
 /** @internal */