@portabletext/editor 1.35.4 → 1.36.0

package/lib/behaviors/index.d.ts

@@ -44,7 +44,6 @@ import {
   Values,
 } from 'xstate'
 import {GuardArgs} from 'xstate/guards'
-import {PickFromUnion as PickFromUnion_2} from '.'
 import {
   BlockOffset as BlockOffset_2,
   PortableTextMemberSchemaTypes as PortableTextMemberSchemaTypes_2,
@@ -61,11 +60,9 @@ import {
 export declare type Behavior<
   TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
   TGuardResponse = true,
-  TBehaviorEvent extends BehaviorEvent = PickFromUnion<
-    BehaviorEvent,
-    'type',
-    TBehaviorEventType
-  >,
+  TBehaviorEvent extends BehaviorEvent = TBehaviorEventType extends '*'
+    ? BehaviorEvent
+    : PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>,
 > = {
   /**
    * The internal editor event that triggers this behavior.
@@ -123,6 +120,9 @@ export declare type BehaviorEvent =
   | SyntheticBehaviorEvent
   | NativeBehaviorEvent
   | CustomBehaviorEvent
+  | {
+      type: '*'
+    }
 
 /**
  * @beta
@@ -244,62 +244,10 @@ export declare const coreBehaviors: Behavior_2<
   | 'style.toggle'
   | 'key.down'
   | 'key.up'
-  | 'paste',
+  | 'paste'
+  | '*',
   true,
-  PickFromUnion_2<
-    BehaviorEvent_2,
-    'type',
-    | 'focus'
-    | 'delete'
-    | 'select'
-    | 'serialize'
-    | 'deserialize'
-    | 'serialization.failure'
-    | 'serialization.success'
-    | 'deserialization.failure'
-    | 'deserialization.success'
-    | 'copy'
-    | `custom.${string}`
-    | 'annotation.add'
-    | 'annotation.remove'
-    | 'annotation.toggle'
-    | 'block.set'
-    | 'block.unset'
-    | 'blur'
-    | 'data transfer.set'
-    | 'decorator.add'
-    | 'decorator.remove'
-    | 'decorator.toggle'
-    | 'delete.backward'
-    | 'delete.block'
-    | 'delete.forward'
-    | 'delete.text'
-    | 'history.redo'
-    | 'history.undo'
-    | 'insert.blocks'
-    | 'insert.block object'
-    | 'insert.inline object'
-    | 'insert.break'
-    | 'insert.soft break'
-    | 'insert.block'
-    | 'insert.span'
-    | 'insert.text'
-    | 'insert.text block'
-    | 'list item.add'
-    | 'list item.remove'
-    | 'list item.toggle'
-    | 'move.block'
-    | 'move.block down'
-    | 'move.block up'
-    | 'select.previous block'
-    | 'select.next block'
-    | 'style.add'
-    | 'style.remove'
-    | 'style.toggle'
-    | 'key.down'
-    | 'key.up'
-    | 'paste'
-  >
+  BehaviorEvent_2
 >[]
 
 /**
@@ -357,62 +305,10 @@ export declare function createCodeEditorBehaviors(
   | 'style.toggle'
   | 'key.down'
   | 'key.up'
-  | 'paste',
+  | 'paste'
+  | '*',
   true,
-  PickFromUnion_2<
-    BehaviorEvent_2,
-    'type',
-    | 'focus'
-    | 'delete'
-    | 'select'
-    | 'serialize'
-    | 'deserialize'
-    | 'serialization.failure'
-    | 'serialization.success'
-    | 'deserialization.failure'
-    | 'deserialization.success'
-    | 'copy'
-    | `custom.${string}`
-    | 'annotation.add'
-    | 'annotation.remove'
-    | 'annotation.toggle'
-    | 'block.set'
-    | 'block.unset'
-    | 'blur'
-    | 'data transfer.set'
-    | 'decorator.add'
-    | 'decorator.remove'
-    | 'decorator.toggle'
-    | 'delete.backward'
-    | 'delete.block'
-    | 'delete.forward'
-    | 'delete.text'
-    | 'history.redo'
-    | 'history.undo'
-    | 'insert.blocks'
-    | 'insert.block object'
-    | 'insert.inline object'
-    | 'insert.break'
-    | 'insert.soft break'
-    | 'insert.block'
-    | 'insert.span'
-    | 'insert.text'
-    | 'insert.text block'
-    | 'list item.add'
-    | 'list item.remove'
-    | 'list item.toggle'
-    | 'move.block'
-    | 'move.block down'
-    | 'move.block up'
-    | 'select.previous block'
-    | 'select.next block'
-    | 'style.add'
-    | 'style.remove'
-    | 'style.toggle'
-    | 'key.down'
-    | 'key.up'
-    | 'paste'
-  >
+  BehaviorEvent_2
 >[]
 
 /**
@@ -470,62 +366,10 @@ export declare function createEmojiPickerBehaviors<TEmojiMatch>(
   | 'style.toggle'
   | 'key.down'
   | 'key.up'
-  | 'paste',
+  | 'paste'
+  | '*',
   true,
-  PickFromUnion_2<
-    BehaviorEvent_2,
-    'type',
-    | 'focus'
-    | 'delete'
-    | 'select'
-    | 'serialize'
-    | 'deserialize'
-    | 'serialization.failure'
-    | 'serialization.success'
-    | 'deserialization.failure'
-    | 'deserialization.success'
-    | 'copy'
-    | `custom.${string}`
-    | 'annotation.add'
-    | 'annotation.remove'
-    | 'annotation.toggle'
-    | 'block.set'
-    | 'block.unset'
-    | 'blur'
-    | 'data transfer.set'
-    | 'decorator.add'
-    | 'decorator.remove'
-    | 'decorator.toggle'
-    | 'delete.backward'
-    | 'delete.block'
-    | 'delete.forward'
-    | 'delete.text'
-    | 'history.redo'
-    | 'history.undo'
-    | 'insert.blocks'
-    | 'insert.block object'
-    | 'insert.inline object'
-    | 'insert.break'
-    | 'insert.soft break'
-    | 'insert.block'
-    | 'insert.span'
-    | 'insert.text'
-    | 'insert.text block'
-    | 'list item.add'
-    | 'list item.remove'
-    | 'list item.toggle'
-    | 'move.block'
-    | 'move.block down'
-    | 'move.block up'
-    | 'select.previous block'
-    | 'select.next block'
-    | 'style.add'
-    | 'style.remove'
-    | 'style.toggle'
-    | 'key.down'
-    | 'key.up'
-    | 'paste'
-  >
+  BehaviorEvent_2
 >[]
 
 /**
@@ -583,62 +427,10 @@ export declare function createLinkBehaviors(
   | 'style.toggle'
   | 'key.down'
   | 'key.up'
-  | 'paste',
+  | 'paste'
+  | '*',
   true,
-  PickFromUnion_2<
-    BehaviorEvent_2,
-    'type',
-    | 'focus'
-    | 'delete'
-    | 'select'
-    | 'serialize'
-    | 'deserialize'
-    | 'serialization.failure'
-    | 'serialization.success'
-    | 'deserialization.failure'
-    | 'deserialization.success'
-    | 'copy'
-    | `custom.${string}`
-    | 'annotation.add'
-    | 'annotation.remove'
-    | 'annotation.toggle'
-    | 'block.set'
-    | 'block.unset'
-    | 'blur'
-    | 'data transfer.set'
-    | 'decorator.add'
-    | 'decorator.remove'
-    | 'decorator.toggle'
-    | 'delete.backward'
-    | 'delete.block'
-    | 'delete.forward'
-    | 'delete.text'
-    | 'history.redo'
-    | 'history.undo'
-    | 'insert.blocks'
-    | 'insert.block object'
-    | 'insert.inline object'
-    | 'insert.break'
-    | 'insert.soft break'
-    | 'insert.block'
-    | 'insert.span'
-    | 'insert.text'
-    | 'insert.text block'
-    | 'list item.add'
-    | 'list item.remove'
-    | 'list item.toggle'
-    | 'move.block'
-    | 'move.block down'
-    | 'move.block up'
-    | 'select.previous block'
-    | 'select.next block'
-    | 'style.add'
-    | 'style.remove'
-    | 'style.toggle'
-    | 'key.down'
-    | 'key.up'
-    | 'paste'
-  >
+  BehaviorEvent_2
 >[]
 
 /**
@@ -738,62 +530,10 @@ export declare function createMarkdownBehaviors(
   | 'style.toggle'
   | 'key.down'
   | 'key.up'
-  | 'paste',
+  | 'paste'
+  | '*',
   true,
-  PickFromUnion_2<
-    BehaviorEvent_2,
-    'type',
-    | 'focus'
-    | 'delete'
-    | 'select'
-    | 'serialize'
-    | 'deserialize'
-    | 'serialization.failure'
-    | 'serialization.success'
-    | 'deserialization.failure'
-    | 'deserialization.success'
-    | 'copy'
-    | `custom.${string}`
-    | 'annotation.add'
-    | 'annotation.remove'
-    | 'annotation.toggle'
-    | 'block.set'
-    | 'block.unset'
-    | 'blur'
-    | 'data transfer.set'
-    | 'decorator.add'
-    | 'decorator.remove'
-    | 'decorator.toggle'
-    | 'delete.backward'
-    | 'delete.block'
-    | 'delete.forward'
-    | 'delete.text'
-    | 'history.redo'
-    | 'history.undo'
-    | 'insert.blocks'
-    | 'insert.block object'
-    | 'insert.inline object'
-    | 'insert.break'
-    | 'insert.soft break'
-    | 'insert.block'
-    | 'insert.span'
-    | 'insert.text'
-    | 'insert.text block'
-    | 'list item.add'
-    | 'list item.remove'
-    | 'list item.toggle'
-    | 'move.block'
-    | 'move.block down'
-    | 'move.block up'
-    | 'select.previous block'
-    | 'select.next block'
-    | 'style.add'
-    | 'style.remove'
-    | 'style.toggle'
-    | 'key.down'
-    | 'key.up'
-    | 'paste'
-  >
+  BehaviorEvent_2
 >[]
 
 /**
@@ -836,7 +576,9 @@ export declare function defineBehavior<
     TGuardResponse,
     TBehaviorEventType extends `custom.${infer TType}`
       ? CustomBehaviorEvent<TPayload, TType>
-      : PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>
+      : TBehaviorEventType extends '*'
+        ? OmitFromUnion<BehaviorEvent, 'type', '*'>
+        : PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>
   >,
 ): Behavior
 
@@ -20100,6 +19842,15 @@ export declare type NativeBehaviorEvent =
       dataTransfer: DataTransfer
     }
 
+/**
+ * @internal
+ */
+declare type OmitFromUnion<
+  TUnion,
+  TTagKey extends keyof TUnion,
+  TOmittedTags extends TUnion[TTagKey],
+> = TUnion extends Record<TTagKey, TOmittedTags> ? never : TUnion
+
 /**
  * @public
  */

package/lib/index.d.cts

@@ -103,11 +103,9 @@ export declare type BaseDefinition = {
 export declare type Behavior<
   TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
   TGuardResponse = true,
-  TBehaviorEvent extends BehaviorEvent = PickFromUnion<
-    BehaviorEvent,
-    'type',
-    TBehaviorEventType
-  >,
+  TBehaviorEvent extends BehaviorEvent = TBehaviorEventType extends '*'
+    ? BehaviorEvent
+    : PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>,
 > = {
   /**
    * The internal editor event that triggers this behavior.
@@ -165,6 +163,9 @@ export declare type BehaviorEvent =
   | SyntheticBehaviorEvent
   | NativeBehaviorEvent
   | CustomBehaviorEvent
+  | {
+      type: '*'
+    }
 
 /**
  * @beta
@@ -20387,7 +20388,29 @@ export declare class PortableTextEditor extends Component<
   static getFragment: (
     editor: PortableTextEditor,
   ) => PortableTextBlock[] | undefined
+  /**
+   * @deprecated
+   * Use `editor.send(...)` instead
+   *
+   * ```
+   * const editor = useEditor()
+   * editor.send({
+   *   type: 'history.undo',
+   * })
+   * ```
+   */
   static undo: (editor: PortableTextEditor) => void
+  /**
+   * @deprecated
+   * Use `editor.send(...)` instead
+   *
+   * ```
+   * const editor = useEditor()
+   * editor.send({
+   *   type: 'history.redo',
+   * })
+   * ```
+   */
   static redo: (editor: PortableTextEditor) => void
   /**
    * @deprecated

package/lib/index.d.ts

@@ -103,11 +103,9 @@ export declare type BaseDefinition = {
 export declare type Behavior<
   TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
   TGuardResponse = true,
-  TBehaviorEvent extends BehaviorEvent = PickFromUnion<
-    BehaviorEvent,
-    'type',
-    TBehaviorEventType
-  >,
+  TBehaviorEvent extends BehaviorEvent = TBehaviorEventType extends '*'
+    ? BehaviorEvent
+    : PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>,
 > = {
   /**
    * The internal editor event that triggers this behavior.
@@ -165,6 +163,9 @@ export declare type BehaviorEvent =
   | SyntheticBehaviorEvent
   | NativeBehaviorEvent
   | CustomBehaviorEvent
+  | {
+      type: '*'
+    }
 
 /**
  * @beta
@@ -20387,7 +20388,29 @@ export declare class PortableTextEditor extends Component<
   static getFragment: (
     editor: PortableTextEditor,
   ) => PortableTextBlock[] | undefined
+  /**
+   * @deprecated
+   * Use `editor.send(...)` instead
+   *
+   * ```
+   * const editor = useEditor()
+   * editor.send({
+   *   type: 'history.undo',
+   * })
+   * ```
+   */
   static undo: (editor: PortableTextEditor) => void
+  /**
+   * @deprecated
+   * Use `editor.send(...)` instead
+   *
+   * ```
+   * const editor = useEditor()
+   * editor.send({
+   *   type: 'history.redo',
+   * })
+   * ```
+   */
   static redo: (editor: PortableTextEditor) => void
   /**
    * @deprecated

package/lib/plugins/index.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: !0 });
-var reactCompilerRuntime = require("react-compiler-runtime"), React = require("react"), editorProvider = require("../_chunks-cjs/editor-provider.cjs"), useEffectEvent = require("use-effect-event"), jsxRuntime = require("react/jsx-runtime"), behavior_markdown = require("../_chunks-cjs/behavior.markdown.cjs"), react = require("@xstate/react"), isEqual = require("lodash/isEqual.js"), xstate = require("xstate"), selector_isAtTheStartOfBlock = require("../_chunks-cjs/selector.is-at-the-start-of-block.cjs"), util_sliceBlocks = require("../_chunks-cjs/util.slice-blocks.cjs"), util_blockOffsetsToSelection = require("../_chunks-cjs/util.block-offsets-to-selection.cjs"), utils_index = require("../utils/index.cjs"), selector_getTextBefore = require("../_chunks-cjs/selector.get-text-before.cjs"), behavior_core = require("../_chunks-cjs/behavior.core.cjs");
+var reactCompilerRuntime = require("react-compiler-runtime"), React = require("react"), editorProvider = require("../_chunks-cjs/editor-provider.cjs"), react = require("@xstate/react"), isEqual = require("lodash/isEqual.js"), xstate = require("xstate"), selector_isAtTheStartOfBlock = require("../_chunks-cjs/selector.is-at-the-start-of-block.cjs"), util_sliceBlocks = require("../_chunks-cjs/util.slice-blocks.cjs"), util_blockOffsetsToSelection = require("../_chunks-cjs/util.block-offsets-to-selection.cjs"), utils_index = require("../utils/index.cjs"), selector_getTextBefore = require("../_chunks-cjs/selector.get-text-before.cjs"), behavior_core = require("../_chunks-cjs/behavior.core.cjs"), useEffectEvent = require("use-effect-event"), jsxRuntime = require("react/jsx-runtime"), behavior_markdown = require("../_chunks-cjs/behavior.markdown.cjs");
 function _interopDefaultCompat(e) {
   return e && typeof e == "object" && "default" in e ? e : { default: e };
 }
@@ -20,24 +20,6 @@ function BehaviorPlugin(props) {
 function _temp(unregister) {
   return unregister();
 }
-function EventListenerPlugin(props) {
-  const $ = reactCompilerRuntime.c(5), editor = editorProvider.useEditor(), on = useEffectEvent.useEffectEvent(props.on);
-  let t0;
-  $[0] !== editor || $[1] !== on ? (t0 = () => {
-    const subscription = editor.on("*", on);
-    return () => {
-      subscription.unsubscribe();
-    };
-  }, $[0] = editor, $[1] = on, $[2] = t0) : t0 = $[2];
-  let t1;
-  return $[3] !== editor ? (t1 = [editor], $[3] = editor, $[4] = t1) : t1 = $[4], React.useEffect(t0, t1), null;
-}
-const EditorRefPlugin = React__default.default.forwardRef((_, ref) => {
-  const $ = reactCompilerRuntime.c(2), editor = editorProvider.useEditor(), portableTextEditorRef = React__default.default.useRef(editor);
-  let t0, t1;
-  return $[0] === Symbol.for("react.memo_cache_sentinel") ? (t0 = () => portableTextEditorRef.current, t1 = [], $[0] = t0, $[1] = t1) : (t0 = $[0], t1 = $[1]), React__default.default.useImperativeHandle(ref, t0, t1), null;
-});
-EditorRefPlugin.displayName = "EditorRefPlugin";
 function createPairRegex(char, amount) {
   const prePrefix = `(?<!\\${char})`, prefix = `\\${char}`.repeat(Math.max(amount, 1)), postPrefix = "(?!\\s)", content = `([^${char}\\n]+?)`, preSuffix = "(?<!\\s)", suffix = `\\${char}`.repeat(Math.max(amount, 1)), postSuffix = `(?!\\${char})`;
   return `${prePrefix}${prefix}${postPrefix}${content}${preSuffix}${suffix}${postSuffix}`;
@@ -341,7 +323,24 @@ const emphasisListener = ({
       }
     }
   }
+}), EditorRefPlugin = React__default.default.forwardRef((_, ref) => {
+  const $ = reactCompilerRuntime.c(2), editor = editorProvider.useEditor(), portableTextEditorRef = React__default.default.useRef(editor);
+  let t0, t1;
+  return $[0] === Symbol.for("react.memo_cache_sentinel") ? (t0 = () => portableTextEditorRef.current, t1 = [], $[0] = t0, $[1] = t1) : (t0 = $[0], t1 = $[1]), React__default.default.useImperativeHandle(ref, t0, t1), null;
 });
+EditorRefPlugin.displayName = "EditorRefPlugin";
+function EventListenerPlugin(props) {
+  const $ = reactCompilerRuntime.c(5), editor = editorProvider.useEditor(), on = useEffectEvent.useEffectEvent(props.on);
+  let t0;
+  $[0] !== editor || $[1] !== on ? (t0 = () => {
+    const subscription = editor.on("*", on);
+    return () => {
+      subscription.unsubscribe();
+    };
+  }, $[0] = editor, $[1] = on, $[2] = t0) : t0 = $[2];
+  let t1;
+  return $[3] !== editor ? (t1 = [editor], $[3] = editor, $[4] = t1) : t1 = $[4], React.useEffect(t0, t1), null;
+}
 function MarkdownPlugin(props) {
   const $ = reactCompilerRuntime.c(17), editor = editorProvider.useEditor();
   let t0, t1;
@@ -612,6 +611,7 @@ function OneLinePlugin() {
   return $[0] === Symbol.for("react.memo_cache_sentinel") ? (t0 = /* @__PURE__ */ jsxRuntime.jsx(BehaviorPlugin, { behaviors: oneLineBehaviors }), $[0] = t0) : t0 = $[0], t0;
 }
 exports.BehaviorPlugin = BehaviorPlugin;
+exports.DecoratorShortcutPlugin = DecoratorShortcutPlugin;
 exports.EditorRefPlugin = EditorRefPlugin;
 exports.EventListenerPlugin = EventListenerPlugin;
 exports.MarkdownPlugin = MarkdownPlugin;