@portabletext/editor 1.41.4 → 1.42.0

package/src/behaviors/behavior.markdown.ts

@@ -3,7 +3,7 @@ import type {EditorSchema} from '../editor/define-schema'
 import * as selectors from '../selectors'
 import {spanSelectionPointToBlockOffset} from '../utils/util.block-offset'
 import {getTextBlockText} from '../utils/util.get-text-block-text'
-import {defineBehavior} from './behavior.types'
+import {defineBehavior} from './behavior.types.behavior'
 
 /**
  * @beta

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

@@ -0,0 +1,61 @@
+import type {EditorContext, EditorSnapshot} from '../editor/editor-snapshot'
+import type {OmitFromUnion, PickFromUnion} from '../type-utils'
+import type {PortableTextSlateEditor} from '../types/editor'
+import type {
+  CustomBehaviorEvent,
+  InternalBehaviorEvent,
+  SyntheticBehaviorEvent,
+} from './behavior.types.event'
+
+/**
+ * @beta
+ */
+export type BehaviorAction =
+  | SyntheticBehaviorEvent
+  | {
+      type: 'raise'
+      event:
+        | InternalBehaviorEvent
+        | SyntheticBehaviorEvent
+        | CustomBehaviorEvent
+    }
+  | {
+      type: 'noop'
+    }
+  | {
+      type: 'effect'
+      effect: () => void
+    }
+
+/**
+ * @beta
+ */
+export function raise(
+  event: InternalBehaviorEvent | SyntheticBehaviorEvent | CustomBehaviorEvent,
+): PickFromUnion<BehaviorAction, 'type', 'raise'> {
+  return {type: 'raise', event}
+}
+
+/**
+ * @beta
+ */
+export type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (
+  payload: {
+    /**
+     * @deprecated
+     * Use `snapshot` instead
+     */
+    context: EditorContext
+    snapshot: EditorSnapshot
+    event: TBehaviorEvent
+  },
+  guardResponse: TGuardResponse,
+) => Array<BehaviorAction>
+
+export type InternalBehaviorAction = OmitFromUnion<
+  BehaviorAction,
+  'type',
+  'raise'
+> & {
+  editor: PortableTextSlateEditor
+}

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

@@ -0,0 +1,84 @@
+import type {BehaviorActionSet} from './behavior.types.action'
+import type {
+  BehaviorEvent,
+  BehaviorEventTypeNamespace,
+  CustomBehaviorEvent,
+  ResolveBehaviorEvent,
+} from './behavior.types.event'
+import type {BehaviorGuard} from './behavior.types.guard'
+
+/**
+ * @beta
+ */
+export type Behavior<
+  TBehaviorEventType extends
+    | '*'
+    | `${BehaviorEventTypeNamespace}.*`
+    | BehaviorEvent['type'] =
+    | '*'
+    | `${BehaviorEventTypeNamespace}.*`
+    | BehaviorEvent['type'],
+  TGuardResponse = true,
+  TBehaviorEvent extends
+    ResolveBehaviorEvent<TBehaviorEventType> = ResolveBehaviorEvent<TBehaviorEventType>,
+> = {
+  /**
+   * The internal editor event that triggers this behavior.
+   */
+  on: TBehaviorEventType
+  /**
+   * Predicate function that determines if the behavior should be executed.
+   * Returning a non-nullable value from the guard will pass the value to the
+   * actions and execute them.
+   */
+  guard?: BehaviorGuard<TBehaviorEvent, TGuardResponse>
+  /**
+   * Array of behavior action sets.
+   */
+  actions: Array<BehaviorActionSet<TBehaviorEvent, TGuardResponse>>
+}
+
+/**
+ * @beta
+ *
+ * @example
+ *
+ * ```tsx
+ * const noLowerCaseA = defineBehavior({
+ *   on: 'insert.text',
+ *   guard: ({event, snapshot}) => event.text === 'a',
+ *   actions: [({event, snapshot}) => [{type: 'insert.text', text: 'A'}]],
+ * })
+ * ```
+ *
+ */
+export function defineBehavior<
+  TPayload extends Record<string, unknown>,
+  TBehaviorEventType extends
+    | '*'
+    | `${BehaviorEventTypeNamespace}.*`
+    | BehaviorEvent['type'] = CustomBehaviorEvent['type'],
+  TGuardResponse = true,
+>(
+  behavior: Behavior<
+    TBehaviorEventType,
+    TGuardResponse,
+    ResolveBehaviorEvent<TBehaviorEventType, TPayload>
+  >,
+): Behavior
+export function defineBehavior<
+  TPayload extends never = never,
+  TBehaviorEventType extends
+    | '*'
+    | `${BehaviorEventTypeNamespace}.*`
+    | BehaviorEvent['type'] = BehaviorEvent['type'],
+  TGuardResponse = true,
+  TBehaviorEvent extends ResolveBehaviorEvent<
+    TBehaviorEventType,
+    TPayload
+  > = ResolveBehaviorEvent<TBehaviorEventType, TPayload>,
+>(
+  behavior: Behavior<TBehaviorEventType, TGuardResponse, TBehaviorEvent>,
+): Behavior {
+  return behavior as unknown as Behavior
+}

package/src/behaviors/{behavior.types.ts → behavior.types.event.ts}

@@ -1,13 +1,11 @@
 import type {KeyedSegment, PortableTextBlock} from '@sanity/types'
 import type {TextUnit} from 'slate'
-import type {TextInsertTextOptions} from 'slate/dist/interfaces/transforms/text'
-import type {EditorContext, EditorSnapshot} from '../editor/editor-snapshot'
 import type {EventPosition} from '../internal-utils/event-position'
 import type {MIMEType} from '../internal-utils/mime-type'
-import type {OmitFromUnion, PickFromUnion} from '../type-utils'
+import type {PickFromUnion} from '../type-utils'
 import type {BlockOffset} from '../types/block-offset'
 import type {BlockWithOptionalKey} from '../types/block-with-optional-key'
-import type {EditorSelection, PortableTextSlateEditor} from '../types/editor'
+import type {EditorSelection} from '../types/editor'
 
 /**
  * @beta
@@ -18,33 +16,13 @@ export type BehaviorEvent =
   | NativeBehaviorEvent
   | CustomBehaviorEvent
 
-type BehaviorEventTypeNamespace =
+export type BehaviorEventTypeNamespace =
   | SyntheticBehaviorEventNamespace
   | InternalBehaviorEventNamespace
   | NativeBehaviorEventNamespace
   | CustomBehaviorEventNamespace
 
-type SyntheticBehaviorEventType<
-  TNamespace extends SyntheticBehaviorEventNamespace,
-  TType extends string = '',
-> = TType extends '' ? `${TNamespace}` : `${TNamespace}.${TType}`
-
-type InternalBehaviorEventType<
-  TNamespace extends InternalBehaviorEventNamespace,
-  TType extends string = '',
-> = TType extends '' ? `${TNamespace}` : `${TNamespace}.${TType}`
-
-type NativeBehaviorEventType<
-  TNamespace extends NativeBehaviorEventNamespace,
-  TType extends string = '',
-> = TType extends '' ? `${TNamespace}` : `${TNamespace}.${TType}`
-
-type CustomBehaviorEventType<
-  TNamespace extends CustomBehaviorEventNamespace,
-  TType extends string = '',
-> = TType extends '' ? `${TNamespace}` : `${TNamespace}.${TType}`
-
-export type NamespacedBehaviorEventType<
+type NamespacedBehaviorEventType<
   TNamespace extends BehaviorEventTypeNamespace | '',
 > = TNamespace extends ''
   ? BehaviorEvent['type']
@@ -66,6 +44,11 @@ export type ExternalSyntheticBehaviorEvent = {
  * Synthetic events
  **************************************/
 
+type SyntheticBehaviorEventType<
+  TNamespace extends SyntheticBehaviorEventNamespace,
+  TType extends string = '',
+> = TType extends '' ? `${TNamespace}` : `${TNamespace}.${TType}`
+
 type SyntheticBehaviorEventNamespace =
   | 'annotation'
   | 'block'
@@ -206,7 +189,6 @@ export type SyntheticBehaviorEvent =
   | {
       type: SyntheticBehaviorEventType<'insert', 'text'>
       text: string
-      options?: TextInsertTextOptions
     }
   | {
       type: SyntheticBehaviorEventType<'list item', 'add'>
@@ -304,6 +286,43 @@ export type SyntheticBehaviorEvent =
 
 export type InsertPlacement = 'auto' | 'after' | 'before'
 
+export function isKeyboardBehaviorEvent(
+  event: BehaviorEvent,
+): event is KeyboardBehaviorEvent {
+  return event.type.startsWith('keyboard.')
+}
+
+/**************************************
+ * Internal events
+ **************************************/
+
+type InternalBehaviorEventNamespace = 'deserialize' | 'serialize'
+
+type InternalBehaviorEventType<
+  TNamespace extends InternalBehaviorEventNamespace,
+  TType extends string = '',
+> = TType extends '' ? `${TNamespace}` : `${TNamespace}.${TType}`
+
+export type InternalBehaviorEvent =
+  | {
+      type: InternalBehaviorEventType<'deserialize'>
+      originEvent:
+        | PickFromUnion<
+            NativeBehaviorEvent,
+            'type',
+            'drag.drop' | 'clipboard.paste'
+          >
+        | InputBehaviorEvent
+    }
+  | {
+      type: InternalBehaviorEventType<'serialize'>
+      originEvent: PickFromUnion<
+        NativeBehaviorEvent,
+        'type',
+        'clipboard.copy' | 'clipboard.cut' | 'drag.dragstart'
+      >
+    }
+
 /**************************************
  * Native events
  **************************************/
@@ -315,6 +334,11 @@ type NativeBehaviorEventNamespace =
   | 'keyboard'
   | 'mouse'
 
+type NativeBehaviorEventType<
+  TNamespace extends NativeBehaviorEventNamespace,
+  TType extends string = '',
+> = TType extends '' ? `${TNamespace}` : `${TNamespace}.${TType}`
+
 /**
  * @beta
  */
@@ -448,32 +472,6 @@ export type KeyboardBehaviorEvent =
       >
     }
 
-export function isKeyboardBehaviorEvent(
-  event: BehaviorEvent,
-): event is KeyboardBehaviorEvent {
-  return event.type.startsWith('keyboard.')
-}
-
-export type InternalBehaviorEvent =
-  | {
-      type: InternalBehaviorEventType<'deserialize'>
-      originEvent:
-        | PickFromUnion<
-            NativeBehaviorEvent,
-            'type',
-            'drag.drop' | 'clipboard.paste'
-          >
-        | InputBehaviorEvent
-    }
-  | {
-      type: InternalBehaviorEventType<'serialize'>
-      originEvent: PickFromUnion<
-        NativeBehaviorEvent,
-        'type',
-        'clipboard.copy' | 'clipboard.cut' | 'drag.dragstart'
-      >
-    }
-
 export type MouseBehaviorEvent = {
   type: NativeBehaviorEventType<'mouse', 'click'>
   position: EventPosition
@@ -491,6 +489,11 @@ export function isMouseBehaviorEvent(
 
 type CustomBehaviorEventNamespace = 'custom'
 
+type CustomBehaviorEventType<
+  TNamespace extends CustomBehaviorEventNamespace,
+  TType extends string = '',
+> = TType extends '' ? `${TNamespace}` : `${TNamespace}.${TType}`
+
 /**
  * @beta
  */
@@ -511,50 +514,11 @@ export function isCustomBehaviorEvent(
   return event.type.startsWith('custom.')
 }
 
-/**
- * @beta
- */
-export type BehaviorAction =
-  | SyntheticBehaviorEvent
-  | {
-      type: 'raise'
-      event:
-        | InternalBehaviorEvent
-        | SyntheticBehaviorEvent
-        | CustomBehaviorEvent
-    }
-  | {
-      type: 'noop'
-    }
-  | {
-      type: 'effect'
-      effect: () => void
-    }
-
 /**************************************
- * Internal events
+ * Resolve behavior event
  **************************************/
 
-type InternalBehaviorEventNamespace = 'deserialize' | 'serialize'
-
-export type InternalBehaviorAction = OmitFromUnion<
-  BehaviorAction,
-  'type',
-  'raise'
-> & {
-  editor: PortableTextSlateEditor
-}
-
-/**
- * @beta
- */
-export function raise(
-  event: InternalBehaviorEvent | SyntheticBehaviorEvent | CustomBehaviorEvent,
-): PickFromUnion<BehaviorAction, 'type', 'raise'> {
-  return {type: 'raise', event}
-}
-
-type ResolveBehaviorEvent<
+export type ResolveBehaviorEvent<
   TBehaviorEventType extends
     | '*'
     | `${BehaviorEventTypeNamespace}.*`
@@ -575,112 +539,3 @@ type ResolveBehaviorEvent<
       : TBehaviorEventType extends BehaviorEvent['type']
         ? PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>
         : never
-
-/**
- * @beta
- */
-export type Behavior<
-  TBehaviorEventType extends
-    | '*'
-    | `${BehaviorEventTypeNamespace}.*`
-    | BehaviorEvent['type'] =
-    | '*'
-    | `${BehaviorEventTypeNamespace}.*`
-    | BehaviorEvent['type'],
-  TGuardResponse = true,
-  TBehaviorEvent extends
-    ResolveBehaviorEvent<TBehaviorEventType> = ResolveBehaviorEvent<TBehaviorEventType>,
-> = {
-  /**
-   * The internal editor event that triggers this behavior.
-   */
-  on: TBehaviorEventType
-  /**
-   * Predicate function that determines if the behavior should be executed.
-   * Returning a non-nullable value from the guard will pass the value to the
-   * actions and execute them.
-   */
-  guard?: BehaviorGuard<TBehaviorEvent, TGuardResponse>
-  /**
-   * Array of behavior action sets.
-   */
-  actions: Array<BehaviorActionSet<TBehaviorEvent, TGuardResponse>>
-}
-
-/**
- * @beta
- */
-export type BehaviorGuard<TBehaviorEvent, TGuardResponse> = (payload: {
-  /**
-   * @deprecated
-   * Use `snapshot` instead
-   */
-  context: EditorContext
-  snapshot: EditorSnapshot
-  event: TBehaviorEvent
-}) => TGuardResponse | false
-
-/**
- * @beta
- */
-export type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (
-  payload: {
-    /**
-     * @deprecated
-     * Use `snapshot` instead
-     */
-    context: EditorContext
-    snapshot: EditorSnapshot
-    event: TBehaviorEvent
-  },
-  guardResponse: TGuardResponse,
-) => Array<BehaviorAction>
-
-/**
- * @beta
- *
- * @example
- *
- * ```tsx
- * const noLowerCaseA = defineBehavior({
- *   on: 'insert.text',
- *   guard: ({event, context}) => event.text === 'a',
- *   actions: [({event, context}) => [{type: 'insert.text', text: 'A'}]],
- * })
- * ```
- *
- *
- *
- *
- *
- */
-export function defineBehavior<
-  TPayload extends Record<string, unknown>,
-  TBehaviorEventType extends
-    | '*'
-    | `${BehaviorEventTypeNamespace}.*`
-    | BehaviorEvent['type'] = CustomBehaviorEvent['type'],
-  TGuardResponse = true,
->(
-  behavior: Behavior<
-    TBehaviorEventType,
-    TGuardResponse,
-    ResolveBehaviorEvent<TBehaviorEventType, TPayload>
-  >,
-): Behavior
-export function defineBehavior<
-  TPayload extends never = never,
-  TBehaviorEventType extends
-    | '*'
-    | `${BehaviorEventTypeNamespace}.*`
-    | BehaviorEvent['type'] = BehaviorEvent['type'],
-  TGuardResponse = true,
-  TBehaviorEvent extends ResolveBehaviorEvent<
-    TBehaviorEventType,
-    TPayload
-  > = ResolveBehaviorEvent<TBehaviorEventType, TPayload>,
->(
-  behavior: Behavior<TBehaviorEventType, TGuardResponse, TBehaviorEvent>,
-): Behavior {
-  return behavior as unknown as Behavior
-}

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

@@ -0,0 +1,14 @@
+import type {EditorContext, EditorSnapshot} from '../editor/editor-snapshot'
+
+/**
+ * @beta
+ */
+export type BehaviorGuard<TBehaviorEvent, TGuardResponse> = (payload: {
+  /**
+   * @deprecated
+   * Use `snapshot` instead
+   */
+  context: EditorContext
+  snapshot: EditorSnapshot
+  event: TBehaviorEvent
+}) => TGuardResponse | false

package/src/behaviors/index.ts

@@ -4,23 +4,25 @@ export {
 } from './behavior.code-editor'
 export {coreBehaviors} from './behavior.core'
 export {
-  type EmojiPickerBehaviorsConfig,
   createEmojiPickerBehaviors,
+  type EmojiPickerBehaviorsConfig,
 } from './behavior.emoji-picker'
 export {createLinkBehaviors, type LinkBehaviorsConfig} from './behavior.links'
 export {
   createMarkdownBehaviors,
   type MarkdownBehaviorsConfig,
 } from './behavior.markdown'
+
 export {
-  defineBehavior,
   raise,
-  type Behavior,
   type BehaviorAction,
   type BehaviorActionSet,
-  type BehaviorEvent,
-  type BehaviorGuard,
-  type CustomBehaviorEvent,
-  type NativeBehaviorEvent,
-  type SyntheticBehaviorEvent,
-} from './behavior.types'
+} from './behavior.types.action'
+export {defineBehavior, type Behavior} from './behavior.types.behavior'
+export type {
+  BehaviorEvent,
+  CustomBehaviorEvent,
+  NativeBehaviorEvent,
+  SyntheticBehaviorEvent,
+} from './behavior.types.event'
+export type {BehaviorGuard} from './behavior.types.guard'

package/src/editor/create-editor.ts

@@ -11,12 +11,12 @@ import {
   type EventObject,
   type Snapshot,
 } from 'xstate'
+import type {Behavior} from '../behaviors/behavior.types.behavior'
 import type {
-  Behavior,
   CustomBehaviorEvent,
   ExternalSyntheticBehaviorEvent,
   SyntheticBehaviorEvent,
-} from '../behaviors/behavior.types'
+} from '../behaviors/behavior.types.event'
 import {coreConverters} from '../converters/converters.core'
 import {compileType} from '../internal-utils/schema'
 import type {EditableAPI} from '../types/editor'

package/src/editor/editor-machine.ts

@@ -12,6 +12,8 @@ import {
 import {performAction} from '../behavior-actions/behavior.actions'
 import {coreBehaviors} from '../behaviors/behavior.core'
 import {defaultBehaviors} from '../behaviors/behavior.default'
+import type {InternalBehaviorAction} from '../behaviors/behavior.types.action'
+import type {Behavior} from '../behaviors/behavior.types.behavior'
 import {
   isClipboardBehaviorEvent,
   isCustomBehaviorEvent,
@@ -19,14 +21,12 @@ import {
   isInputBehaviorEvent,
   isKeyboardBehaviorEvent,
   isMouseBehaviorEvent,
-  type Behavior,
   type CustomBehaviorEvent,
   type ExternalSyntheticBehaviorEvent,
-  type InternalBehaviorAction,
   type InternalBehaviorEvent,
   type NativeBehaviorEvent,
   type SyntheticBehaviorEvent,
-} from '../behaviors/behavior.types'
+} from '../behaviors/behavior.types.event'
 import type {Converter} from '../converters/converter.types'
 import type {EventPosition} from '../internal-utils/event-position'
 import type {NamespaceEvent} from '../type-utils'

package/src/editor/plugins/create-with-event-listeners.ts

@@ -179,7 +179,6 @@ export function createWithEventListeners(
         behaviorEvent: {
           type: 'insert.text',
           text,
-          options,
         },
         editor,
         defaultActionCallback: () => {

package/src/plugins/index.ts

@@ -1,4 +1,5 @@
 export {BehaviorPlugin} from './plugin.behavior'
+export {CoreBehaviorsPlugin} from './plugin.core'
 export {DecoratorShortcutPlugin} from './plugin.decorator-shortcut'
 export {EditorRefPlugin} from './plugin.editor-ref'
 export {EventListenerPlugin} from './plugin.event-listener'

package/src/plugins/plugin.core.tsx

@@ -0,0 +1,9 @@
+import {coreBehaviors} from '../behaviors'
+import {BehaviorPlugin} from './plugin.behavior'
+
+/**
+ * @beta
+ */
+export function CoreBehaviorsPlugin() {
+  return <BehaviorPlugin behaviors={coreBehaviors} />
+}

package/src/plugins/plugin.decorator-shortcut.ts

@@ -8,7 +8,7 @@ import {
   type CallbackLogicFunction,
 } from 'xstate'
 import {createDecoratorPairBehavior} from '../behaviors/behavior.decorator-pair'
-import {defineBehavior} from '../behaviors/behavior.types'
+import {defineBehavior} from '../behaviors/behavior.types.behavior'
 import type {Editor} from '../editor/create-editor'
 import type {EditorSchema} from '../editor/define-schema'
 import {useEditor} from '../editor/editor-provider'