@portabletext/editor 1.15.2 → 1.15.3

package/lib/selectors/index.d.cts

@@ -20,11 +20,16 @@ import {
  */
 export declare type EditorContext = {
   keyGenerator: () => string
-  schema: PortableTextMemberSchemaTypes
-  selection: NonNullable<EditorSelection>
+  schema: EditorSchema
+  selection: EditorSelection
   value: Array<PortableTextBlock>
 }
 
+/**
+ * @alpha
+ */
+export declare type EditorSchema = PortableTextMemberSchemaTypes
+
 /** @beta */
 export declare type EditorSelection = {
   anchor: EditorSelectionPoint
@@ -42,18 +47,9 @@ export declare type EditorSelectionPoint = {
  * @alpha
  */
 export declare type EditorSelector<TSelected> = (
-  snapshot: EditorSelectorSnapshot,
+  snapshot: EditorSnapshot,
 ) => TSelected
 
-/**
- * @alpha
- */
-export declare type EditorSelectorSnapshot = {
-  context: Omit<EditorSnapshot['context'], 'selection'> & {
-    selection?: NonNullable<EditorSelection>
-  }
-}
-
 /**
  * @alpha
  */

package/lib/selectors/index.d.ts

@@ -20,11 +20,16 @@ import {
  */
 export declare type EditorContext = {
   keyGenerator: () => string
-  schema: PortableTextMemberSchemaTypes
-  selection: NonNullable<EditorSelection>
+  schema: EditorSchema
+  selection: EditorSelection
   value: Array<PortableTextBlock>
 }
 
+/**
+ * @alpha
+ */
+export declare type EditorSchema = PortableTextMemberSchemaTypes
+
 /** @beta */
 export declare type EditorSelection = {
   anchor: EditorSelectionPoint
@@ -42,18 +47,9 @@ export declare type EditorSelectionPoint = {
  * @alpha
  */
 export declare type EditorSelector<TSelected> = (
-  snapshot: EditorSelectorSnapshot,
+  snapshot: EditorSnapshot,
 ) => TSelected
 
-/**
- * @alpha
- */
-export declare type EditorSelectorSnapshot = {
-  context: Omit<EditorSnapshot['context'], 'selection'> & {
-    selection?: NonNullable<EditorSelection>
-  }
-}
-
 /**
  * @alpha
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "1.15.2",
+  "version": "1.15.3",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",
@@ -72,7 +72,7 @@
     "@portabletext/toolkit": "^2.0.16",
     "@sanity/block-tools": "^3.66.1",
     "@sanity/diff-match-patch": "^3.1.1",
-    "@sanity/pkg-utils": "^6.11.14",
+    "@sanity/pkg-utils": "^6.11.15",
     "@sanity/schema": "^3.66.1",
     "@sanity/types": "^3.66.1",
     "@testing-library/jest-dom": "^6.6.3",

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

@@ -1,8 +1,6 @@
 import {Editor, Transforms, type Descendant} from 'slate'
-import type {
-  PortableTextMemberSchemaTypes,
-  PortableTextSlateEditor,
-} from '../types/editor'
+import type {EditorSchema} from '../editor/define-schema'
+import type {PortableTextSlateEditor} from '../types/editor'
 import {isEqualToEmptyEditor} from '../utils/values'
 
 export function insertBlock({
@@ -14,7 +12,7 @@ export function insertBlock({
   block: Descendant
   placement: 'auto' | 'after' | 'before'
   editor: PortableTextSlateEditor
-  schema: PortableTextMemberSchemaTypes
+  schema: EditorSchema
 }) {
   if (!editor.selection) {
     const lastBlock = Array.from(

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

@@ -233,7 +233,7 @@ const behaviorActionImplementations: BehaviorActionImplementations = {
       Transforms.deselect(action.editor)
     }
   },
-  'select previous block': ({action}) => {
+  'select.previous block': ({action}) => {
     if (!action.editor.selection) {
       console.error('Unable to select previous block without a selection')
       return
@@ -250,7 +250,7 @@ const behaviorActionImplementations: BehaviorActionImplementations = {
 
     Transforms.select(action.editor, previousBlockPath)
   },
-  'select next block': ({action}) => {
+  'select.next block': ({action}) => {
     if (!action.editor.selection) {
       console.error('Unable to select next block without a selection')
       return
@@ -370,15 +370,15 @@ export function performAction({
       })
       break
     }
-    case 'select previous block': {
-      behaviorActionImplementations['select previous block']({
+    case 'select.previous block': {
+      behaviorActionImplementations['select.previous block']({
         context,
         action,
       })
       break
     }
-    case 'select next block': {
-      behaviorActionImplementations['select next block']({
+    case 'select.next block': {
+      behaviorActionImplementations['select.next block']({
         context,
         action,
       })

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

@@ -4,18 +4,14 @@ import {
   type PortableTextListBlock,
   type PortableTextTextBlock,
 } from '@sanity/types'
-import type {PortableTextMemberSchemaTypes} from '../types/editor'
+import type {EditorSchema} from '../editor/define-schema'
 
 /**
  * @alpha
  */
 export type BehaviorGuards = ReturnType<typeof createGuards>
 
-export function createGuards({
-  schema,
-}: {
-  schema: PortableTextMemberSchemaTypes
-}) {
+export function createGuards({schema}: {schema: EditorSchema}) {
   function isListBlock(block: unknown): block is PortableTextListBlock {
     return isPortableTextListBlock(block) && block._type === schema.block.name
   }

package/src/behaviors/behavior.core.block-objects.ts

@@ -34,7 +34,7 @@ const arrowUpOnLonelyBlockObject = defineBehavior({
   actions: [
     () => [
       {type: 'insert.text block', placement: 'before'},
-      {type: 'select previous block'},
+      {type: 'select.previous block'},
     ],
   ],
 })

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

@@ -25,7 +25,7 @@ const clearListOnBackspace = defineBehavior({
 
     const atTheBeginningOfBLock =
       focusTextBlock.node.children[0]._key === focusSpan.node._key &&
-      context.selection.focus.offset === 0
+      context.selection?.focus.offset === 0
 
     if (atTheBeginningOfBLock && focusTextBlock.node.level === 1) {
       return {focusTextBlock}
@@ -57,7 +57,7 @@ const unindentListOnBackspace = defineBehavior({
 
     const atTheBeginningOfBLock =
       focusTextBlock.node.children[0]._key === focusSpan.node._key &&
-      context.selection.focus.offset === 0
+      context.selection?.focus.offset === 0
 
     if (
       atTheBeginningOfBLock &&

package/src/behaviors/behavior.links.ts

@@ -1,5 +1,5 @@
+import type {EditorSchema} from '../editor/define-schema'
 import {getFocusSpan, selectionIsCollapsed} from '../selectors/selectors'
-import type {PortableTextMemberSchemaTypes} from '../types/editor'
 import {defineBehavior} from './behavior.types'
 
 /**
@@ -7,7 +7,7 @@ import {defineBehavior} from './behavior.types'
  */
 export type LinkBehaviorsConfig = {
   linkAnnotation?: (context: {
-    schema: PortableTextMemberSchemaTypes
+    schema: EditorSchema
     url: string
   }) => {name: string; value: {[prop: string]: unknown}} | undefined
 }

package/src/behaviors/behavior.markdown.ts

@@ -1,4 +1,5 @@
 import {isPortableTextTextBlock} from '@sanity/types'
+import type {EditorSchema} from '../editor/define-schema'
 import {getTextBlockText} from '../editor/utils/utils'
 import {spanSelectionPointToBlockOffset} from '../editor/utils/utils.block-offset'
 import {getBlockTextBefore} from '../selectors/selector.get-text-before'
@@ -8,7 +9,6 @@ import {
   getFocusTextBlock,
   selectionIsCollapsed,
 } from '../selectors/selectors'
-import type {PortableTextMemberSchemaTypes} from '../types/editor'
 import {defineBehavior} from './behavior.types'
 
 /**
@@ -16,24 +16,16 @@ import {defineBehavior} from './behavior.types'
  */
 export type MarkdownBehaviorsConfig = {
   horizontalRuleObject?: (context: {
-    schema: PortableTextMemberSchemaTypes
+    schema: EditorSchema
   }) => {name: string; value?: {[prop: string]: unknown}} | undefined
-  defaultStyle?: (context: {
-    schema: PortableTextMemberSchemaTypes
-  }) => string | undefined
+  defaultStyle?: (context: {schema: EditorSchema}) => string | undefined
   headingStyle?: (context: {
-    schema: PortableTextMemberSchemaTypes
+    schema: EditorSchema
     level: number
   }) => string | undefined
-  blockquoteStyle?: (context: {
-    schema: PortableTextMemberSchemaTypes
-  }) => string | undefined
-  unorderedListStyle?: (context: {
-    schema: PortableTextMemberSchemaTypes
-  }) => string | undefined
-  orderedListStyle?: (context: {
-    schema: PortableTextMemberSchemaTypes
-  }) => string | undefined
+  blockquoteStyle?: (context: {schema: EditorSchema}) => string | undefined
+  unorderedListStyle?: (context: {schema: EditorSchema}) => string | undefined
+  orderedListStyle?: (context: {schema: EditorSchema}) => string | undefined
 }
 
 /**
@@ -65,7 +57,7 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
             'children',
             {_key: focusSpan.node._key},
           ],
-          offset: context.selection.focus.offset,
+          offset: context.selection?.focus.offset ?? 0,
         },
       })
 
@@ -253,7 +245,7 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
             'children',
             {_key: focusSpan.node._key},
           ],
-          offset: context.selection.focus.offset,
+          offset: context.selection?.focus.offset ?? 0,
         },
       })
 
@@ -327,7 +319,7 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
 
       const atTheBeginningOfBLock =
         focusTextBlock.node.children[0]._key === focusSpan.node._key &&
-        context.selection.focus.offset === 0
+        context.selection?.focus.offset === 0
 
       const defaultStyle = config.defaultStyle?.(context)
 
@@ -376,7 +368,7 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
             'children',
             {_key: focusSpan.node._key},
           ],
-          offset: context.selection.focus.offset,
+          offset: context.selection?.focus.offset ?? 0,
         },
       })
 

package/src/behaviors/behavior.types.ts

@@ -71,10 +71,10 @@ export type SyntheticBehaviorEvent =
       }
     }
   | {
-      type: 'insert.soft break'
+      type: 'insert.break'
     }
   | {
-      type: 'insert.break'
+      type: 'insert.soft break'
     }
   | {
       type: 'insert.text'
@@ -176,17 +176,17 @@ export type BehaviorActionIntend =
       effect: () => void
     }
   | {
-      type: 'select'
-      selection: EditorSelection
+      type: 'reselect'
     }
   | {
-      type: 'select previous block'
+      type: 'select'
+      selection: EditorSelection
     }
   | {
-      type: 'select next block'
+      type: 'select.previous block'
     }
   | {
-      type: 'reselect'
+      type: 'select.next block'
     }
   | {
       type: 'style.add'

package/src/behaviors/index.ts

@@ -1,3 +1,4 @@
+export type {EditorSchema} from '../editor/define-schema'
 export type {EditorContext} from '../editor/editor-snapshot'
 export type {PickFromUnion} from '../type-utils'
 export type {

package/src/editor/PortableTextEditor.tsx

@@ -25,10 +25,10 @@ import type {
   PortableTextMemberSchemaTypes,
 } from '../types/editor'
 import {debugWithName} from '../utils/debug'
-import {getPortableTextMemberSchemaTypes} from '../utils/getPortableTextMemberSchemaTypes'
 import {compileType} from '../utils/schema'
 import {Synchronizer} from './components/Synchronizer'
 import {createEditor, type Editor} from './create-editor'
+import {createEditorSchema} from './create-editor-schema'
 import {EditorActorContext} from './editor-actor-context'
 import type {EditorActor} from './editor-machine'
 import {PortableTextEditorContext} from './hooks/usePortableTextEditor'
@@ -158,7 +158,7 @@ export class PortableTextEditor extends Component<
       !prevProps.editor &&
       this.props.schemaType !== prevProps.schemaType
     ) {
-      this.schemaTypes = getPortableTextMemberSchemaTypes(
+      this.schemaTypes = createEditorSchema(
         this.props.schemaType.hasOwnProperty('jsonType')
           ? this.props.schemaType
           : compileType(this.props.schemaType),

package/src/{utils/getPortableTextMemberSchemaTypes.ts → editor/create-editor-schema.ts}

@@ -6,11 +6,11 @@ import type {
   SchemaType,
   SpanSchemaType,
 } from '@sanity/types'
-import type {PortableTextMemberSchemaTypes} from '../types/editor'
+import type {EditorSchema} from './define-schema'
 
-export function getPortableTextMemberSchemaTypes(
+export function createEditorSchema(
   portableTextType: ArraySchemaType<PortableTextBlock>,
-): PortableTextMemberSchemaTypes {
+): EditorSchema {
   if (!portableTextType) {
     throw new Error("Parameter 'portabletextType' missing (required)")
   }

package/src/editor/create-editor.ts

@@ -14,8 +14,8 @@ import {
 import type {Behavior} from '../behaviors/behavior.types'
 import type {PickFromUnion} from '../type-utils'
 import type {EditableAPI} from '../types/editor'
-import {getPortableTextMemberSchemaTypes} from '../utils/getPortableTextMemberSchemaTypes'
 import {compileType} from '../utils/schema'
+import {createEditorSchema} from './create-editor-schema'
 import {createSlateEditor, type SlateEditor} from './create-slate-editor'
 import {compileSchemaDefinition, type SchemaDefinition} from './define-schema'
 import {
@@ -107,7 +107,7 @@ function editorConfigToMachineInput(config: EditorConfig) {
     readOnly: config.readOnly,
     schema: config.schemaDefinition
       ? compileSchemaDefinition(config.schemaDefinition)
-      : getPortableTextMemberSchemaTypes(
+      : createEditorSchema(
           config.schema.hasOwnProperty('jsonType')
             ? config.schema
             : compileType(config.schema),

package/src/editor/define-schema.ts

@@ -7,7 +7,7 @@ import {
 } from '@sanity/types'
 import startCase from 'lodash.startcase'
 import type {PortableTextMemberSchemaTypes} from '../types/editor'
-import {getPortableTextMemberSchemaTypes} from '../utils/getPortableTextMemberSchemaTypes'
+import {createEditorSchema} from './create-editor-schema'
 
 /**
  * @alpha
@@ -41,6 +41,11 @@ export function defineSchema<const TSchemaDefinition extends SchemaDefinition>(
   return definition
 }
 
+/**
+ * @alpha
+ */
+export type EditorSchema = PortableTextMemberSchemaTypes
+
 export function compileSchemaDefinition<
   TSchemaDefinition extends SchemaDefinition,
 >(definition?: TSchemaDefinition) {
@@ -111,7 +116,7 @@ export function compileSchemaDefinition<
     types: [portableTextSchema, ...blockObjects, ...inlineObjects],
   }).get('portable-text')
 
-  const pteSchema = getPortableTextMemberSchemaTypes(schema)
+  const pteSchema = createEditorSchema(schema)
 
   return {
     ...pteSchema,
@@ -127,5 +132,5 @@ export function compileSchemaDefinition<
           } as ObjectSchemaType)
         : blockObject,
     ),
-  } satisfies PortableTextMemberSchemaTypes
+  } satisfies EditorSchema
 }

package/src/editor/editor-machine.ts

@@ -23,13 +23,13 @@ import type {OmitFromUnion, PickFromUnion} from '../type-utils'
 import type {
   EditorSelection,
   InvalidValueResolution,
-  PortableTextMemberSchemaTypes,
   PortableTextSlateEditor,
 } from '../types/editor'
 import debug from '../utils/debug'
 import {toPortableTextRange} from '../utils/ranges'
 import {fromSlateValue} from '../utils/values'
 import {KEY_TO_VALUE_ELEMENT} from '../utils/weakMaps'
+import type {EditorSchema} from './define-schema'
 import type {EditorContext} from './editor-snapshot'
 
 export * from 'xstate/guards'
@@ -81,7 +81,7 @@ export type InternalEditorEvent =
     }
   | {
       type: 'update schema'
-      schema: PortableTextMemberSchemaTypes
+      schema: EditorSchema
     }
   | {
       type: 'update behaviors'
@@ -179,10 +179,10 @@ export const editorMachine = setup({
       behaviors: Array<Behavior>
       keyGenerator: () => string
       pendingEvents: Array<PatchEvent | MutationEvent>
-      schema: PortableTextMemberSchemaTypes
+      schema: EditorSchema
       readOnly: boolean
       maxBlocks: number | undefined
-      selection: NonNullable<EditorSelection> | undefined
+      selection: EditorSelection
       value: Array<PortableTextBlock> | undefined
     },
     events: {} as InternalEditorEvent,
@@ -192,7 +192,7 @@ export const editorMachine = setup({
       keyGenerator: () => string
       maxBlocks?: number
       readOnly?: boolean
-      schema: PortableTextMemberSchemaTypes
+      schema: EditorSchema
       value?: Array<PortableTextBlock>
     },
   },
@@ -275,23 +275,6 @@ export const editorMachine = setup({
         context.schema,
       )
 
-      if (!selection) {
-        console.warn(
-          `Unable to handle event ${event.type} due to missing selection`,
-        )
-
-        if (!defaultAction) {
-          return
-        }
-
-        enqueue.raise({
-          type: 'behavior action intends',
-          editor: event.editor,
-          actionIntends: [defaultAction],
-        })
-        return
-      }
-
       const editorContext = {
         keyGenerator: context.keyGenerator,
         schema: context.schema,
@@ -361,7 +344,7 @@ export const editorMachine = setup({
     keyGenerator: input.keyGenerator,
     pendingEvents: [],
     schema: input.schema,
-    selection: undefined,
+    selection: null,
     readOnly: input.readOnly ?? false,
     maxBlocks: input.maxBlocks,
     value: input.value,
@@ -410,7 +393,7 @@ export const editorMachine = setup({
     'error': {actions: emit(({event}) => event)},
     'selection': {
       actions: [
-        assign({selection: ({event}) => event.selection ?? undefined}),
+        assign({selection: ({event}) => event.selection}),
         emit(({event}) => event),
       ],
     },

package/src/editor/editor-selector.ts

@@ -1,5 +1,4 @@
 import {useSelector} from '@xstate/react'
-import type {EditorSelection} from '../types/editor'
 import type {Editor} from './create-editor'
 import type {EditorSnapshot} from './editor-snapshot'
 import {getValue} from './get-value'
@@ -11,18 +10,7 @@ function defaultCompare<T>(a: T, b: T) {
 /**
  * @alpha
  */
-export type EditorSelectorSnapshot = {
-  context: Omit<EditorSnapshot['context'], 'selection'> & {
-    selection?: NonNullable<EditorSelection>
-  }
-}
-
-/**
- * @alpha
- */
-export type EditorSelector<TSelected> = (
-  snapshot: EditorSelectorSnapshot,
-) => TSelected
+export type EditorSelector<TSelected> = (snapshot: EditorSnapshot) => TSelected
 
 /**
  * @alpha

package/src/editor/editor-snapshot.ts

@@ -1,16 +1,14 @@
 import type {PortableTextBlock} from '@sanity/types'
-import type {
-  EditorSelection,
-  PortableTextMemberSchemaTypes,
-} from '../types/editor'
+import type {EditorSelection} from '../types/editor'
+import type {EditorSchema} from './define-schema'
 
 /**
  * @alpha
  */
 export type EditorContext = {
   keyGenerator: () => string
-  schema: PortableTextMemberSchemaTypes
-  selection: NonNullable<EditorSelection>
+  schema: EditorSchema
+  selection: EditorSelection
   value: Array<PortableTextBlock>
 }
 

package/src/index.ts

@@ -17,6 +17,8 @@ export {
   type BaseDefinition,
   type SchemaDefinition,
 } from './editor/define-schema'
+export type {PortableTextMemberSchemaTypes} from './types/editor'
+export type {EditorSchema} from './editor/define-schema'
 export {PortableTextEditable} from './editor/Editable'
 export type {PortableTextEditableProps} from './editor/Editable'
 export {EditorEventListener} from './editor/editor-event-listener'
@@ -35,11 +37,7 @@ export {
   useEditor,
   type EditorProviderProps,
 } from './editor/editor-provider'
-export {
-  useEditorSelector,
-  type EditorSelector,
-  type EditorSelectorSnapshot,
-} from './editor/editor-selector'
+export {useEditorSelector, type EditorSelector} from './editor/editor-selector'
 export type {EditorContext, EditorSnapshot} from './editor/editor-snapshot'
 export {usePortableTextEditor} from './editor/hooks/usePortableTextEditor'
 export {usePortableTextEditorSelection} from './editor/hooks/usePortableTextEditorSelection'

package/src/selectors/index.ts

@@ -1,7 +1,4 @@
-export type {
-  EditorSelector,
-  EditorSelectorSnapshot,
-} from '../editor/editor-selector'
+export type {EditorSelector} from '../editor/editor-selector'
 export type {EditorContext, EditorSnapshot} from '../editor/editor-snapshot'
 export type {
   EditorSelection,
@@ -13,3 +10,4 @@ export {getActiveListItem} from './selector.get-active-list-item'
 export {getSelectionText} from './selector.get-selection-text'
 export {getBlockTextBefore} from './selector.get-text-before'
 export * from './selectors'
+export type {EditorSchema} from '../editor/define-schema'

package/src/utils/__tests__/operationToPatches.test.ts

@@ -4,13 +4,13 @@ import {beforeEach, describe, expect, it} from 'vitest'
 import {createActor} from 'xstate'
 import {coreBehaviors} from '../../behaviors/behavior.core'
 import {schemaType} from '../../editor/__tests__/PortableTextEditorTester'
+import {createEditorSchema} from '../../editor/create-editor-schema'
 import {editorMachine} from '../../editor/editor-machine'
 import {defaultKeyGenerator} from '../../editor/key-generator'
 import {withPlugins} from '../../editor/plugins/with-plugins'
-import {getPortableTextMemberSchemaTypes} from '../getPortableTextMemberSchemaTypes'
 import {createOperationToPatches} from '../operationToPatches'
 
-const schemaTypes = getPortableTextMemberSchemaTypes(schemaType)
+const schemaTypes = createEditorSchema(schemaType)
 
 const operationToPatches = createOperationToPatches(schemaTypes)
 

package/src/utils/__tests__/patchToOperations.test.ts

@@ -4,14 +4,14 @@ import {beforeEach, describe, expect, it} from 'vitest'
 import {createActor} from 'xstate'
 import {coreBehaviors} from '../../behaviors/behavior.core'
 import {schemaType} from '../../editor/__tests__/PortableTextEditorTester'
+import {createEditorSchema} from '../../editor/create-editor-schema'
 import {editorMachine} from '../../editor/editor-machine'
 import {defaultKeyGenerator} from '../../editor/key-generator'
 import {withPlugins} from '../../editor/plugins/with-plugins'
 import {createApplyPatch} from '../applyPatch'
-import {getPortableTextMemberSchemaTypes} from '../getPortableTextMemberSchemaTypes'
 import {VOID_CHILD_KEY} from '../values'
 
-const schemaTypes = getPortableTextMemberSchemaTypes(schemaType)
+const schemaTypes = createEditorSchema(schemaType)
 
 const patchToOperations = createApplyPatch(schemaTypes)
 

package/src/utils/__tests__/values.test.ts

@@ -1,9 +1,9 @@
 import {describe, expect, it} from 'vitest'
 import {schemaType} from '../../editor/__tests__/PortableTextEditorTester'
-import {getPortableTextMemberSchemaTypes} from '../getPortableTextMemberSchemaTypes'
+import {createEditorSchema} from '../../editor/create-editor-schema'
 import {fromSlateValue, toSlateValue} from '../values'
 
-const schemaTypes = getPortableTextMemberSchemaTypes(schemaType)
+const schemaTypes = createEditorSchema(schemaType)
 
 describe('toSlateValue', () => {
   it('checks undefined', () => {