@portabletext/editor 1.46.0 → 1.47.1

package/lib/utils/index.d.cts

@@ -1,21 +1,16 @@
 import type {Patch} from '@portabletext/patches'
-import type {
-  ArraySchemaType,
-  BlockDecoratorDefinition,
-  BlockListDefinition,
-  BlockStyleDefinition,
-  ObjectSchemaType,
-  Path,
-  PortableTextChild,
-  PortableTextListBlock,
-  PortableTextTextBlock,
-} from '@sanity/types'
 import {
   KeyedSegment,
   PortableTextBlock,
   PortableTextObject,
   PortableTextSpan,
 } from '@sanity/types'
+import type {
+  Path,
+  PortableTextChild,
+  PortableTextListBlock,
+  PortableTextTextBlock,
+} from '@sanity/types'
 import type {
   FocusEvent as FocusEvent_2,
   KeyboardEvent as KeyboardEvent_2,
@@ -44,7 +39,6 @@ import {
   Values,
 } from 'xstate'
 import {GuardArgs} from 'xstate/guards'
-import {PortableTextMemberSchemaTypes as PortableTextMemberSchemaTypes_2} from '..'
 
 declare type AbstractBehaviorEvent =
   | {
@@ -219,6 +213,14 @@ declare const abstractBehaviorEventTypes: readonly [
   'style.toggle',
 ]
 
+/**
+ * @public
+ */
+declare type BaseDefinition = {
+  name: string
+  title?: string
+}
+
 /**
  * @beta
  */
@@ -1222,7 +1224,7 @@ declare const editorMachine: StateMachine<
       converters: Set<Converter>
       keyGenerator: () => string
       pendingEvents: never[]
-      schema: PortableTextMemberSchemaTypes_2
+      schema: EditorSchema
       selection: null
       initialReadOnly: boolean
       maxBlocks: number | undefined
@@ -4702,7 +4704,65 @@ declare const editorMachine: StateMachine<
 /**
  * @public
  */
-declare type EditorSchema = PortableTextMemberSchemaTypes
+declare type EditorSchema = {
+  annotations: ReadonlyArray<
+    BaseDefinition & {
+      fields: ReadonlyArray<{
+        name: string
+        type: string
+      }>
+    }
+  >
+  block: {
+    name: string
+  }
+  blockObjects: ReadonlyArray<
+    BaseDefinition & {
+      fields: ReadonlyArray<{
+        name: string
+        type: string
+      }>
+    }
+  >
+  decorators: ReadonlyArray<
+    BaseDefinition & {
+      /**
+       * @deprecated
+       * Use `name` instead
+       */
+      value: string
+    }
+  >
+  inlineObjects: ReadonlyArray<
+    BaseDefinition & {
+      fields: ReadonlyArray<{
+        name: string
+        type: string
+      }>
+    }
+  >
+  span: {
+    name: string
+  }
+  styles: ReadonlyArray<
+    BaseDefinition & {
+      /**
+       * @deprecated
+       * Use `name` instead
+       */
+      value: string
+    }
+  >
+  lists: ReadonlyArray<
+    BaseDefinition & {
+      /**
+       * @deprecated
+       * Use `name` instead
+       */
+      value: string
+    }
+  >
+}
 
 /** @public */
 declare type EditorSelection = {
@@ -5038,21 +5098,6 @@ declare type PickFromUnion<
   TPickedTags extends TUnion[TTagKey],
 > = TUnion extends Record<TTagKey, TPickedTags> ? TUnion : never
 
-/** @beta */
-declare type PortableTextMemberSchemaTypes = {
-  annotations: (ObjectSchemaType & {
-    i18nTitleKey?: string
-  })[]
-  block: ObjectSchemaType
-  blockObjects: ObjectSchemaType[]
-  decorators: BlockDecoratorDefinition[]
-  inlineObjects: ObjectSchemaType[]
-  portableText: ArraySchemaType<PortableTextBlock>
-  span: ObjectSchemaType
-  styles: BlockStyleDefinition[]
-  lists: BlockListDefinition[]
-}
-
 declare interface PortableTextSlateEditor extends ReactEditor {
   _key: 'editor'
   _type: 'editor'
@@ -5282,11 +5327,19 @@ declare type SyntheticBehaviorEvent =
       type: StrictExtract<SyntheticBehaviorEventType, 'insert.text'>
       text: string
     }
+  | {
+      type: StrictExtract<SyntheticBehaviorEventType, 'move.backward'>
+      distance: number
+    }
   | {
       type: StrictExtract<SyntheticBehaviorEventType, 'move.block'>
       at: [KeyedSegment]
       to: [KeyedSegment]
     }
+  | {
+      type: StrictExtract<SyntheticBehaviorEventType, 'move.forward'>
+      distance: number
+    }
   | {
       type: StrictExtract<SyntheticBehaviorEventType, 'select'>
       at: EditorSelection
@@ -5323,7 +5376,9 @@ declare const syntheticBehaviorEventTypes: readonly [
   'insert.block',
   'insert.span',
   'insert.text',
+  'move.backward',
   'move.block',
+  'move.forward',
   'select',
   'split.block',
 ]

package/lib/utils/index.d.ts

@@ -1,21 +1,16 @@
 import type {Patch} from '@portabletext/patches'
-import type {
-  ArraySchemaType,
-  BlockDecoratorDefinition,
-  BlockListDefinition,
-  BlockStyleDefinition,
-  ObjectSchemaType,
-  Path,
-  PortableTextChild,
-  PortableTextListBlock,
-  PortableTextTextBlock,
-} from '@sanity/types'
 import {
   KeyedSegment,
   PortableTextBlock,
   PortableTextObject,
   PortableTextSpan,
 } from '@sanity/types'
+import type {
+  Path,
+  PortableTextChild,
+  PortableTextListBlock,
+  PortableTextTextBlock,
+} from '@sanity/types'
 import type {
   FocusEvent as FocusEvent_2,
   KeyboardEvent as KeyboardEvent_2,
@@ -44,7 +39,6 @@ import {
   Values,
 } from 'xstate'
 import {GuardArgs} from 'xstate/guards'
-import {PortableTextMemberSchemaTypes as PortableTextMemberSchemaTypes_2} from '..'
 
 declare type AbstractBehaviorEvent =
   | {
@@ -219,6 +213,14 @@ declare const abstractBehaviorEventTypes: readonly [
   'style.toggle',
 ]
 
+/**
+ * @public
+ */
+declare type BaseDefinition = {
+  name: string
+  title?: string
+}
+
 /**
  * @beta
  */
@@ -1222,7 +1224,7 @@ declare const editorMachine: StateMachine<
       converters: Set<Converter>
       keyGenerator: () => string
       pendingEvents: never[]
-      schema: PortableTextMemberSchemaTypes_2
+      schema: EditorSchema
       selection: null
       initialReadOnly: boolean
       maxBlocks: number | undefined
@@ -4702,7 +4704,65 @@ declare const editorMachine: StateMachine<
 /**
  * @public
  */
-declare type EditorSchema = PortableTextMemberSchemaTypes
+declare type EditorSchema = {
+  annotations: ReadonlyArray<
+    BaseDefinition & {
+      fields: ReadonlyArray<{
+        name: string
+        type: string
+      }>
+    }
+  >
+  block: {
+    name: string
+  }
+  blockObjects: ReadonlyArray<
+    BaseDefinition & {
+      fields: ReadonlyArray<{
+        name: string
+        type: string
+      }>
+    }
+  >
+  decorators: ReadonlyArray<
+    BaseDefinition & {
+      /**
+       * @deprecated
+       * Use `name` instead
+       */
+      value: string
+    }
+  >
+  inlineObjects: ReadonlyArray<
+    BaseDefinition & {
+      fields: ReadonlyArray<{
+        name: string
+        type: string
+      }>
+    }
+  >
+  span: {
+    name: string
+  }
+  styles: ReadonlyArray<
+    BaseDefinition & {
+      /**
+       * @deprecated
+       * Use `name` instead
+       */
+      value: string
+    }
+  >
+  lists: ReadonlyArray<
+    BaseDefinition & {
+      /**
+       * @deprecated
+       * Use `name` instead
+       */
+      value: string
+    }
+  >
+}
 
 /** @public */
 declare type EditorSelection = {
@@ -5038,21 +5098,6 @@ declare type PickFromUnion<
   TPickedTags extends TUnion[TTagKey],
 > = TUnion extends Record<TTagKey, TPickedTags> ? TUnion : never
 
-/** @beta */
-declare type PortableTextMemberSchemaTypes = {
-  annotations: (ObjectSchemaType & {
-    i18nTitleKey?: string
-  })[]
-  block: ObjectSchemaType
-  blockObjects: ObjectSchemaType[]
-  decorators: BlockDecoratorDefinition[]
-  inlineObjects: ObjectSchemaType[]
-  portableText: ArraySchemaType<PortableTextBlock>
-  span: ObjectSchemaType
-  styles: BlockStyleDefinition[]
-  lists: BlockListDefinition[]
-}
-
 declare interface PortableTextSlateEditor extends ReactEditor {
   _key: 'editor'
   _type: 'editor'
@@ -5282,11 +5327,19 @@ declare type SyntheticBehaviorEvent =
       type: StrictExtract<SyntheticBehaviorEventType, 'insert.text'>
       text: string
     }
+  | {
+      type: StrictExtract<SyntheticBehaviorEventType, 'move.backward'>
+      distance: number
+    }
   | {
       type: StrictExtract<SyntheticBehaviorEventType, 'move.block'>
       at: [KeyedSegment]
       to: [KeyedSegment]
     }
+  | {
+      type: StrictExtract<SyntheticBehaviorEventType, 'move.forward'>
+      distance: number
+    }
   | {
       type: StrictExtract<SyntheticBehaviorEventType, 'select'>
       at: EditorSelection
@@ -5323,7 +5376,9 @@ declare const syntheticBehaviorEventTypes: readonly [
   'insert.block',
   'insert.span',
   'insert.text',
+  'move.backward',
   'move.block',
+  'move.forward',
   'select',
   'split.block',
 ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "1.46.0",
+  "version": "1.47.1",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",
@@ -79,15 +79,15 @@
     "slate-react": "0.112.1",
     "use-effect-event": "^1.0.2",
     "xstate": "^5.19.2",
-    "@portabletext/block-tools": "1.1.17",
+    "@portabletext/block-tools": "1.1.18",
     "@portabletext/patches": "1.1.3"
   },
   "devDependencies": {
     "@portabletext/toolkit": "^2.0.17",
     "@sanity/diff-match-patch": "^3.2.0",
     "@sanity/pkg-utils": "^7.2.2",
-    "@sanity/schema": "^3.83.0",
-    "@sanity/types": "^3.83.0",
+    "@sanity/schema": "^3.84.0",
+    "@sanity/types": "^3.84.0",
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.3.0",
     "@types/debug": "^4.1.12",
@@ -115,8 +115,8 @@
     "racejar": "1.2.3"
   },
   "peerDependencies": {
-    "@sanity/schema": "^3.83.0",
-    "@sanity/types": "^3.83.0",
+    "@sanity/schema": "^3.84.0",
+    "@sanity/types": "^3.84.0",
     "react": "^16.9 || ^17 || ^18 || ^19",
     "rxjs": "^7.8.2"
   },

package/src/behavior-actions/behavior.action.insert.block.ts

@@ -1,6 +1,6 @@
 import {Editor, Path, Point, Range, Transforms, type Descendant} from 'slate'
 import {DOMEditor} from 'slate-dom'
-import type {EditorSchema} from '../editor/define-schema'
+import type {EditorSchema} from '../editor/editor-schema'
 import {parseBlock} from '../internal-utils/parse-blocks'
 import {
   getFocusBlock,

package/src/behavior-actions/behavior.action.move.backward.ts

@@ -0,0 +1,12 @@
+import {Transforms} from 'slate'
+import type {BehaviorActionImplementation} from './behavior.actions'
+
+export const moveBackwardActionImplementation: BehaviorActionImplementation<
+  'move.backward'
+> = ({action}) => {
+  Transforms.move(action.editor, {
+    unit: 'character',
+    distance: action.distance,
+    reverse: true,
+  })
+}

package/src/behavior-actions/behavior.action.move.forward.ts

@@ -0,0 +1,11 @@
+import {Transforms} from 'slate'
+import type {BehaviorActionImplementation} from './behavior.actions'
+
+export const moveForwardActionImplementation: BehaviorActionImplementation<
+  'move.forward'
+> = ({action}) => {
+  Transforms.move(action.editor, {
+    unit: 'character',
+    distance: action.distance,
+  })
+}

package/src/behavior-actions/behavior.action.split.block.ts

@@ -88,7 +88,7 @@ export const splitBlockActionImplementation: BehaviorActionImplementation<
           // previous block
           for (const mark of marks) {
             if (
-              schema.decorators.some((decorator) => decorator.value === mark)
+              schema.decorators.some((decorator) => decorator.name === mark)
             ) {
               continue
             }

package/src/behavior-actions/behavior.actions.ts

@@ -24,7 +24,9 @@ import {insertInlineObjectActionImplementation} from './behavior.action.insert-i
 import {insertSpanActionImplementation} from './behavior.action.insert-span'
 import {insertBlockActionImplementation} from './behavior.action.insert.block'
 import {insertTextActionImplementation} from './behavior.action.insert.text'
+import {moveBackwardActionImplementation} from './behavior.action.move.backward'
 import {moveBlockActionImplementation} from './behavior.action.move.block'
+import {moveForwardActionImplementation} from './behavior.action.move.forward'
 import {noopActionImplementation} from './behavior.action.noop'
 import {selectActionImplementation} from './behavior.action.select'
 import {splitBlockActionImplementation} from './behavior.action.split.block'
@@ -71,7 +73,9 @@ const behaviorActionImplementations: BehaviorActionImplementations = {
   'insert.span': insertSpanActionImplementation,
   'insert.text': insertTextActionImplementation,
   'effect': effectActionImplementation,
+  'move.backward': moveBackwardActionImplementation,
   'move.block': moveBlockActionImplementation,
+  'move.forward': moveForwardActionImplementation,
   'noop': noopActionImplementation,
   'select': selectActionImplementation,
   'split.block': splitBlockActionImplementation,
@@ -220,6 +224,13 @@ export function performAction({
       })
       break
     }
+    case 'move.backward': {
+      behaviorActionImplementations['move.backward']({
+        context,
+        action,
+      })
+      break
+    }
     case 'move.block': {
       behaviorActionImplementations['move.block']({
         context,
@@ -227,6 +238,13 @@ export function performAction({
       })
       break
     }
+    case 'move.forward': {
+      behaviorActionImplementations['move.forward']({
+        context,
+        action,
+      })
+      break
+    }
     case 'noop': {
       behaviorActionImplementations.noop({
         context,

package/src/behavior-actions/behavior.guards.ts

@@ -4,7 +4,7 @@ import {
   type PortableTextListBlock,
   type PortableTextTextBlock,
 } from '@sanity/types'
-import type {EditorSchema} from '../editor/define-schema'
+import type {EditorSchema} from '../editor/editor-schema'
 
 /**
  * @alpha

package/src/behaviors/behavior.core.decorators.ts

@@ -8,7 +8,7 @@ export const coreDecoratorBehaviors = {
     guard: ({snapshot, event}) =>
       isHotkey('mod+b', event.originEvent) &&
       snapshot.context.schema.decorators.some(
-        (decorator) => decorator.value === 'strong',
+        (decorator) => decorator.name === 'strong',
       ),
     actions: [() => [raise({type: 'decorator.toggle', decorator: 'strong'})]],
   }),
@@ -17,7 +17,7 @@ export const coreDecoratorBehaviors = {
     guard: ({snapshot, event}) =>
       isHotkey('mod+i', event.originEvent) &&
       snapshot.context.schema.decorators.some(
-        (decorator) => decorator.value === 'em',
+        (decorator) => decorator.name === 'em',
       ),
     actions: [() => [raise({type: 'decorator.toggle', decorator: 'em'})]],
   }),
@@ -26,7 +26,7 @@ export const coreDecoratorBehaviors = {
     guard: ({snapshot, event}) =>
       isHotkey('mod+u', event.originEvent) &&
       snapshot.context.schema.decorators.some(
-        (decorator) => decorator.value === 'underline',
+        (decorator) => decorator.name === 'underline',
       ),
     actions: [
       () => [raise({type: 'decorator.toggle', decorator: 'underline'})],
@@ -37,7 +37,7 @@ export const coreDecoratorBehaviors = {
     guard: ({snapshot, event}) =>
       isHotkey("mod+'", event.originEvent) &&
       snapshot.context.schema.decorators.some(
-        (decorator) => decorator.value === 'code',
+        (decorator) => decorator.name === 'code',
       ),
     actions: [() => [raise({type: 'decorator.toggle', decorator: 'code'})]],
   }),

package/src/behaviors/behavior.core.insert-break.ts

@@ -40,7 +40,7 @@ const breakingAtTheEndOfTextBlock = defineBehavior({
           markDefs: [],
           listItem: focusListItem,
           level: focusLevel,
-          style: snapshot.context.schema.styles[0]?.value,
+          style: snapshot.context.schema.styles[0]?.name,
         },
         placement: 'after',
       }),
@@ -63,14 +63,14 @@ const breakingAtTheStartOfTextBlock = defineBehavior({
     const focusDecorators = focusSpan?.node.marks?.filter(
       (mark) =>
         snapshot.context.schema.decorators.some(
-          (decorator) => decorator.value === mark,
+          (decorator) => decorator.name === mark,
         ) ?? [],
     )
     const focusAnnotations =
       focusSpan?.node.marks?.filter(
         (mark) =>
           !snapshot.context.schema.decorators.some(
-            (decorator) => decorator.value === mark,
+            (decorator) => decorator.name === mark,
           ),
       ) ?? []
     const focusListItem = focusTextBlock.node.listItem
@@ -103,7 +103,7 @@ const breakingAtTheStartOfTextBlock = defineBehavior({
           ],
           listItem: focusListItem,
           level: focusLevel,
-          style: snapshot.context.schema.styles[0]?.value,
+          style: snapshot.context.schema.styles[0]?.name,
         },
         placement: 'before',
         select: 'none',

package/src/behaviors/behavior.decorator-pair.ts

@@ -1,4 +1,4 @@
-import type {EditorSchema} from '../editor/define-schema'
+import type {EditorSchema} from '../editor/editor-schema'
 import {createPairRegex} from '../internal-utils/get-text-to-emphasize'
 import * as selectors from '../selectors'
 import type {BlockOffset} from '../types/block-offset'

package/src/behaviors/behavior.links.ts

@@ -1,4 +1,4 @@
-import type {EditorSchema} from '../editor/define-schema'
+import type {EditorSchema} from '../editor/editor-schema'
 import {looksLikeUrl} from '../internal-utils/looks-like-url'
 import * as selectors from '../selectors'
 import {execute} from './behavior.types.action'

package/src/behaviors/behavior.markdown.ts

@@ -1,5 +1,5 @@
 import {isPortableTextTextBlock} from '@sanity/types'
-import type {EditorSchema} from '../editor/define-schema'
+import type {EditorSchema} from '../editor/editor-schema'
 import * as selectors from '../selectors'
 import {spanSelectionPointToBlockOffset} from '../utils/util.block-offset'
 import {getTextBlockText} from '../utils/util.get-text-block-text'

package/src/behaviors/behavior.perform-event.ts

@@ -1,6 +1,6 @@
 import type {Behavior, BehaviorEvent} from '.'
 import {performAction} from '../behavior-actions/behavior.actions'
-import type {EditorSchema} from '../editor/define-schema'
+import type {EditorSchema} from '../editor/editor-schema'
 import type {EditorSnapshot} from '../editor/editor-snapshot'
 import {
   withApplyingBehaviorActions,

package/src/behaviors/behavior.types.event.ts

@@ -75,7 +75,9 @@ const syntheticBehaviorEventTypes = [
   'insert.block',
   'insert.span',
   'insert.text',
+  'move.backward',
   'move.block',
+  'move.forward',
   'select',
   'split.block',
 ] as const
@@ -178,11 +180,19 @@ export type SyntheticBehaviorEvent =
       type: StrictExtract<SyntheticBehaviorEventType, 'insert.text'>
       text: string
     }
+  | {
+      type: StrictExtract<SyntheticBehaviorEventType, 'move.backward'>
+      distance: number
+    }
   | {
       type: StrictExtract<SyntheticBehaviorEventType, 'move.block'>
       at: [KeyedSegment]
       to: [KeyedSegment]
     }
+  | {
+      type: StrictExtract<SyntheticBehaviorEventType, 'move.forward'>
+      distance: number
+    }
   | {
       type: StrictExtract<SyntheticBehaviorEventType, 'select'>
       at: EditorSelection

package/src/converters/converter.portable-text.deserialize.test.ts

@@ -3,15 +3,14 @@ import {
   compileSchemaDefinition,
   defineSchema,
   type SchemaDefinition,
-} from '../editor/define-schema'
+} from '../editor/editor-schema'
 import {createTestSnapshot} from '../internal-utils/create-test-snapshot'
 import {converterPortableText} from './converter.portable-text'
-import {coreConverters} from './converters.core'
 
 function createSnapshot(schema: SchemaDefinition) {
   return createTestSnapshot({
     context: {
-      converters: coreConverters,
+      converters: [],
       schema: compileSchemaDefinition(schema),
     },
   })