@portabletext/editor 1.11.3 → 1.12.0

package/README.md

@@ -378,3 +378,14 @@ The Behavior API is a new way of interfacing with the Portable Text Editor. It a
 2. Imperatively trigger **events** using `editor.send(…)` which in turn can trigger behaviors defined using `defineBehavior`.
 3. Deriving editor **state** using **pure functions**.
 4. Subscribe to **emitted** editor **events** using `editor.on(…)`.
+
+## Development
+
+### Develop Together with Sanity Studio
+
+1. Run `pnpm build:editor` to make sure it builds correctly
+2. Now run `pnpm dev:editor` to run it in dev mode
+3. In another terminal, open your local version of the [sanity](https://github.com/sanity-io/sanity) monorepo
+4. `cd` into the `sanity` package and run `pnpm link <relative path to the **editor** package in this repo>`
+
+Now, you should be able to run `pnpm dev:test-studio` in the `sanity` repo to test Studio with a locally running Portable Text Editor.

package/lib/index.d.mts

@@ -4,7 +4,6 @@ import type {
   ArraySchemaType,
   BlockListDefinition,
   BlockStyleDefinition,
-  KeyedSegment,
   ObjectSchemaType,
   PortableTextListBlock,
   PortableTextObject,
@@ -12,6 +11,7 @@ import type {
 } from '@sanity/types'
 import {
   BlockDecoratorDefinition,
+  KeyedSegment,
   Path,
   PortableTextBlock,
   PortableTextChild,
@@ -123,9 +123,12 @@ export declare type BehaviorActionIntend =
   | BehaviorEvent
   | {
       type: 'insert block object'
-      name: string
-      value?: {
-        [prop: string]: unknown
+      placement: 'auto' | 'after'
+      blockObject: {
+        name: string
+        value?: {
+          [prop: string]: unknown
+        }
       }
     }
   | {
@@ -141,7 +144,10 @@ export declare type BehaviorActionIntend =
     }
   | {
       type: 'insert text block'
-      decorators: Array<string>
+      placement: 'auto' | 'after'
+      textBlock?: {
+        children?: PortableTextTextBlock['children']
+      }
     }
   | {
       type: 'set block'
@@ -156,8 +162,13 @@ export declare type BehaviorActionIntend =
       props: Array<'style' | 'listItem' | 'level'>
     }
   | {
-      type: 'delete'
-      selection: NonNullable<EditorSelection>
+      type: 'delete block'
+      blockPath: [KeyedSegment]
+    }
+  | {
+      type: 'delete text'
+      anchor: BlockOffset
+      focus: BlockOffset
     }
   | {
       type: 'effect'
@@ -332,6 +343,14 @@ export declare interface BlockListItemRenderProps {
   value: string
 }
 
+/**
+ * @alpha
+ */
+export declare type BlockOffset = {
+  path: [KeyedSegment]
+  offset: number
+}
+
 /** @beta */
 export declare interface BlockRenderProps {
   children: ReactElement

package/lib/index.d.ts

@@ -4,7 +4,6 @@ import type {
   ArraySchemaType,
   BlockListDefinition,
   BlockStyleDefinition,
-  KeyedSegment,
   ObjectSchemaType,
   PortableTextListBlock,
   PortableTextObject,
@@ -12,6 +11,7 @@ import type {
 } from '@sanity/types'
 import {
   BlockDecoratorDefinition,
+  KeyedSegment,
   Path,
   PortableTextBlock,
   PortableTextChild,
@@ -123,9 +123,12 @@ export declare type BehaviorActionIntend =
   | BehaviorEvent
   | {
       type: 'insert block object'
-      name: string
-      value?: {
-        [prop: string]: unknown
+      placement: 'auto' | 'after'
+      blockObject: {
+        name: string
+        value?: {
+          [prop: string]: unknown
+        }
       }
     }
   | {
@@ -141,7 +144,10 @@ export declare type BehaviorActionIntend =
     }
   | {
       type: 'insert text block'
-      decorators: Array<string>
+      placement: 'auto' | 'after'
+      textBlock?: {
+        children?: PortableTextTextBlock['children']
+      }
     }
   | {
       type: 'set block'
@@ -156,8 +162,13 @@ export declare type BehaviorActionIntend =
       props: Array<'style' | 'listItem' | 'level'>
     }
   | {
-      type: 'delete'
-      selection: NonNullable<EditorSelection>
+      type: 'delete block'
+      blockPath: [KeyedSegment]
+    }
+  | {
+      type: 'delete text'
+      anchor: BlockOffset
+      focus: BlockOffset
     }
   | {
       type: 'effect'
@@ -332,6 +343,14 @@ export declare interface BlockListItemRenderProps {
   value: string
 }
 
+/**
+ * @alpha
+ */
+export declare type BlockOffset = {
+  path: [KeyedSegment]
+  offset: number
+}
+
 /** @beta */
 export declare interface BlockRenderProps {
   children: ReactElement