@portabletext/editor 3.3.11 → 3.3.13

package/lib/_chunks-dts/index.d.ts

@@ -1,14 +1,13 @@
-import * as _sanity_types4 from "@sanity/types";
-import { ArrayDefinition, ArraySchemaType, BlockDecoratorDefinition, BlockListDefinition, BlockStyleDefinition, ObjectSchemaType, Path, PortableTextBlock, PortableTextBlock as PortableTextBlock$1, PortableTextChild, PortableTextChild as PortableTextChild$1, PortableTextListBlock, PortableTextObject, PortableTextObject as PortableTextObject$2, PortableTextSpan, PortableTextSpan as PortableTextSpan$2, PortableTextTextBlock, PortableTextTextBlock as PortableTextTextBlock$2, TypedObject } from "@sanity/types";
+import * as _portabletext_schema12 from "@portabletext/schema";
+import { AnnotationDefinition, AnnotationSchemaType, BaseDefinition, BlockObjectDefinition, BlockObjectSchemaType, DecoratorDefinition, DecoratorSchemaType, FieldDefinition, InlineObjectDefinition, InlineObjectSchemaType, ListDefinition, ListSchemaType, PortableTextBlock, PortableTextBlock as PortableTextBlock$1, PortableTextChild, PortableTextChild as PortableTextChild$1, PortableTextListBlock, PortableTextObject, PortableTextObject as PortableTextObject$1, PortableTextSpan, PortableTextSpan as PortableTextSpan$1, PortableTextTextBlock, PortableTextTextBlock as PortableTextTextBlock$1, Schema, SchemaDefinition, SchemaDefinition as SchemaDefinition$1, StyleDefinition, StyleSchemaType, TypedObject, defineSchema } from "@portabletext/schema";
 import { BaseRange, Descendant, Operation } from "slate";
 import * as xstate228 from "xstate";
 import { ActorRef, ActorRefFrom, EventObject, Snapshot } from "xstate";
 import * as react18 from "react";
 import React$1, { BaseSyntheticEvent, ClipboardEvent, Component, FocusEvent, JSX, KeyboardEvent as KeyboardEvent$1, MutableRefObject, PropsWithChildren, ReactElement, RefObject, TextareaHTMLAttributes } from "react";
 import { Patch, Patch as Patch$1 } from "@portabletext/patches";
-import * as _portabletext_schema5 from "@portabletext/schema";
-import { AnnotationDefinition, AnnotationSchemaType, BaseDefinition, BlockObjectDefinition, BlockObjectSchemaType, DecoratorDefinition, DecoratorSchemaType, FieldDefinition, InlineObjectDefinition, InlineObjectSchemaType, ListDefinition, ListSchemaType, PortableTextObject as PortableTextObject$1, PortableTextSpan as PortableTextSpan$1, PortableTextTextBlock as PortableTextTextBlock$1, Schema, SchemaDefinition, SchemaDefinition as SchemaDefinition$1, StyleDefinition, StyleSchemaType, defineSchema } from "@portabletext/schema";
 import { Observable, Subject } from "rxjs";
+import { ArrayDefinition, ArraySchemaType, BlockDecoratorDefinition, BlockListDefinition, BlockStyleDefinition, ObjectSchemaType } from "@sanity/types";
 import { ReactEditor } from "slate-react";
 import * as xstate_guards12 from "xstate/guards";
 type MIMEType = `${string}/${string}`;
@@ -64,6 +63,54 @@ type Deserializer<TMIMEType extends MIMEType> = ({
   snapshot: EditorSnapshot;
   event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'deserialize'>;
 }) => PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'deserialization.success' | 'deserialization.failure'>;
+/**
+ * A segment in a path that identifies an element by its `_key` property.
+ * @public
+ */
+interface KeyedSegment {
+  _key: string;
+}
+/**
+ * A tuple representing a range selection, e.g., `[0, 5]` or `['', 3]`.
+ * @public
+ */
+type IndexTuple = [number | '', number | ''];
+/**
+ * A single segment in a path. Can be:
+ * - A string (property name)
+ * - A number (array index)
+ * - A KeyedSegment (object with `_key`)
+ * - An IndexTuple (range selection)
+ * @public
+ */
+type PathSegment = string | number | KeyedSegment | IndexTuple;
+/**
+ * A path is an array of path segments that describes a location in a document.
+ * @public
+ */
+type Path = PathSegment[];
+/**
+ * @public
+ */
+type BlockPath = [{
+  _key: string;
+}];
+/**
+ * @public
+ */
+type AnnotationPath = [{
+  _key: string;
+}, 'markDefs', {
+  _key: string;
+}];
+/**
+ * @public
+ */
+type ChildPath = [{
+  _key: string;
+}, 'children', {
+  _key: string;
+}];
 /**
  * @public
  */
@@ -318,7 +365,7 @@ declare class PortableTextEditor extends Component<PortableTextEditorProps<Inter
    */
   static delete: (editor: PortableTextEditor, selection: EditorSelection, options?: EditableAPIDeleteOptions) => void;
   static findDOMNode: (editor: PortableTextEditor, element: PortableTextBlock | PortableTextChild) => Node | undefined;
-  static findByPath: (editor: PortableTextEditor, path: Path) => [_sanity_types4.PortableTextTextBlock<PortableTextObject | _sanity_types4.PortableTextSpan> | PortableTextObject | _sanity_types4.PortableTextSpan | undefined, Path | undefined];
+  static findByPath: (editor: PortableTextEditor, path: Path) => [_portabletext_schema12.PortableTextTextBlock<PortableTextObject | _portabletext_schema12.PortableTextSpan> | PortableTextObject | _portabletext_schema12.PortableTextSpan | undefined, Path | undefined];
   /**
    * @deprecated
    * Use `editor.send(...)` instead
@@ -657,28 +704,6 @@ type PortableTextEditableProps = Omit<TextareaHTMLAttributes<HTMLDivElement>, 'o
  * @group Components
  */
 declare const PortableTextEditable: react18.ForwardRefExoticComponent<Omit<PortableTextEditableProps, "ref"> & react18.RefAttributes<Omit<HTMLDivElement, "as" | "onPaste" | "onBeforeInput">>>;
-/**
- * @public
- */
-type BlockPath = [{
-  _key: string;
-}];
-/**
- * @public
- */
-type AnnotationPath = [{
-  _key: string;
-}, 'markDefs', {
-  _key: string;
-}];
-/**
- * @public
- */
-type ChildPath = [{
-  _key: string;
-}, 'children', {
-  _key: string;
-}];
 /** @beta */
 interface EditableAPIDeleteOptions {
   mode?: 'blocks' | 'children' | 'selected';
@@ -1286,15 +1311,15 @@ type BlockOffset = {
   path: BlockPath;
   offset: number;
 };
-type TextBlockWithOptionalKey = Omit<PortableTextTextBlock$1, '_key'> & {
-  _key?: PortableTextTextBlock$1['_key'];
+type TextBlockWithOptionalKey = Omit<PortableTextTextBlock, '_key'> & {
+  _key?: PortableTextTextBlock['_key'];
 };
-type ObjectBlockWithOptionalKey = Omit<PortableTextObject$1, '_key'> & {
-  _key?: PortableTextObject$1['_key'];
+type ObjectBlockWithOptionalKey = Omit<PortableTextObject, '_key'> & {
+  _key?: PortableTextObject['_key'];
 };
 type BlockWithOptionalKey = TextBlockWithOptionalKey | ObjectBlockWithOptionalKey;
-type SpanWithOptionalKey = Omit<PortableTextSpan$1, '_key'> & {
-  _key?: PortableTextSpan$1['_key'];
+type SpanWithOptionalKey = Omit<PortableTextSpan, '_key'> & {
+  _key?: PortableTextSpan['_key'];
 };
 type ChildWithOptionalKey = SpanWithOptionalKey | ObjectBlockWithOptionalKey;
 type EditorPriority = {
@@ -1937,7 +1962,7 @@ declare const editorMachine: xstate228.StateMachine<{
     keyGenerator: () => string;
     pendingEvents: never[];
     pendingIncomingPatchesEvents: never[];
-    schema: _portabletext_schema5.Schema;
+    schema: _portabletext_schema12.Schema;
     selection: null;
     initialReadOnly: boolean;
     initialValue: PortableTextBlock[] | undefined;
@@ -3475,4 +3500,4 @@ type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (payload: {
   event: TBehaviorEvent;
   dom: EditorDom;
 }, guardResponse: TGuardResponse) => Array<BehaviorAction>;
-export { BlockAnnotationRenderProps as $, EditorEmittedEvent as $t, PortableTextTextBlock$2 as A, ReadyChange as At, EditorSelector as B, ScrollSelectionIntoViewFunction as Bt, ListDefinition as C, OnPasteResultOrPromise as Ct, PortableTextChild$1 as D, PortableTextMemberSchemaTypes as Dt, PortableTextBlock$1 as E, PatchObservable as Et, BlockOffset as F, RenderDecoratorFunction as Ft, EditorConfig as G, AnnotationPath as Gt, EditorProvider as H, UndoChange as Ht, useEditor as I, RenderEditableFunction as It, defineBehavior as J, PortableTextEditable as Jt, EditorEvent as K, BlockPath as Kt, defaultKeyGenerator as L, RenderListItemFunction as Lt, StyleDefinition as M, RenderAnnotationFunction as Mt, StyleSchemaType as N, RenderBlockFunction as Nt, PortableTextObject$2 as O, RangeDecoration as Ot, defineSchema as P, RenderChildFunction as Pt, AddedAnnotationPaths as Q, PortableTextEditorProps as Qt, usePortableTextEditorSelection as R, RenderPlaceholderFunction as Rt, InlineObjectSchemaType as S, OnPasteResult as St, Patch$1 as T, PatchChange as Tt, EditorProviderProps as U, UnsetChange as Ut, useEditorSelector as V, SelectionChange as Vt, Editor as W, ValueChange as Wt, EditorContext as X, HotkeyOptions as Xt, BehaviorGuard as Y, PortableTextEditableProps as Yt, EditorSnapshot as Z, PortableTextEditor as Zt, BlockObjectSchemaType as _, LoadingChange as _t, forward as a, BlurChange as at, FieldDefinition as b, OnCopyFn as bt, CustomBehaviorEvent as c, EditableAPIDeleteOptions as ct, SyntheticBehaviorEvent as d, EditorSelection as dt, MutationEvent as en, BlockChildRenderProps as et, PatchesEvent as f, EditorSelectionPoint as ft, BlockObjectDefinition as g, InvalidValueResolution as gt, BaseDefinition as h, InvalidValue as ht, execute as i, BlockStyleRenderProps as it, SchemaDefinition$1 as j, RedoChange as jt, PortableTextSpan$2 as k, RangeDecorationOnMovedDetails as kt, InsertPlacement as l, EditorChange as lt, AnnotationSchemaType as m, FocusChange as mt, BehaviorActionSet as n, BlockListItemRenderProps as nt, raise as o, ConnectionChange as ot, AnnotationDefinition as p, ErrorChange as pt, Behavior as q, ChildPath as qt, effect as r, BlockRenderProps as rt, BehaviorEvent as s, EditableAPI as st, BehaviorAction as t, EditorSchema as tn, BlockDecoratorRenderProps as tt, NativeBehaviorEvent as u, EditorChanges as ut, DecoratorDefinition as v, MutationChange as vt, ListSchemaType as w, PasteData as wt, InlineObjectDefinition as x, OnPasteFn as xt, DecoratorSchemaType as y, OnBeforeInputFn as yt, usePortableTextEditor as z, RenderStyleFunction as zt };
+export { BlockAnnotationRenderProps as $, AnnotationPath as $t, PortableTextTextBlock$1 as A, ReadyChange as At, EditorSelector as B, ScrollSelectionIntoViewFunction as Bt, ListDefinition as C, OnPasteResultOrPromise as Ct, PortableTextChild$1 as D, PortableTextMemberSchemaTypes as Dt, PortableTextBlock$1 as E, PatchObservable as Et, BlockOffset as F, RenderDecoratorFunction as Ft, EditorConfig as G, PortableTextEditable as Gt, EditorProvider as H, UndoChange as Ht, useEditor as I, RenderEditableFunction as It, defineBehavior as J, PortableTextEditor as Jt, EditorEvent as K, PortableTextEditableProps as Kt, defaultKeyGenerator as L, RenderListItemFunction as Lt, StyleDefinition as M, RenderAnnotationFunction as Mt, StyleSchemaType as N, RenderBlockFunction as Nt, PortableTextObject$1 as O, RangeDecoration as Ot, defineSchema as P, RenderChildFunction as Pt, AddedAnnotationPaths as Q, EditorSchema as Qt, usePortableTextEditorSelection as R, RenderPlaceholderFunction as Rt, InlineObjectSchemaType as S, OnPasteResult as St, Patch$1 as T, PatchChange as Tt, EditorProviderProps as U, UnsetChange as Ut, useEditorSelector as V, SelectionChange as Vt, Editor as W, ValueChange as Wt, EditorContext as X, EditorEmittedEvent as Xt, BehaviorGuard as Y, PortableTextEditorProps as Yt, EditorSnapshot as Z, MutationEvent as Zt, BlockObjectSchemaType as _, LoadingChange as _t, forward as a, BlurChange as at, FieldDefinition as b, OnCopyFn as bt, CustomBehaviorEvent as c, EditableAPIDeleteOptions as ct, SyntheticBehaviorEvent as d, EditorSelection as dt, BlockPath as en, BlockChildRenderProps as et, PatchesEvent as f, EditorSelectionPoint as ft, BlockObjectDefinition as g, InvalidValueResolution as gt, BaseDefinition as h, InvalidValue as ht, execute as i, BlockStyleRenderProps as it, SchemaDefinition$1 as j, RedoChange as jt, PortableTextSpan$1 as k, RangeDecorationOnMovedDetails as kt, InsertPlacement as l, EditorChange as lt, AnnotationSchemaType as m, FocusChange as mt, BehaviorActionSet as n, KeyedSegment as nn, BlockListItemRenderProps as nt, raise as o, ConnectionChange as ot, AnnotationDefinition as p, ErrorChange as pt, Behavior as q, HotkeyOptions as qt, effect as r, BlockRenderProps as rt, BehaviorEvent as s, EditableAPI as st, BehaviorAction as t, ChildPath as tn, BlockDecoratorRenderProps as tt, NativeBehaviorEvent as u, EditorChanges as ut, DecoratorDefinition as v, MutationChange as vt, ListSchemaType as w, PasteData as wt, InlineObjectDefinition as x, OnPasteFn as xt, DecoratorSchemaType as y, OnBeforeInputFn as yt, usePortableTextEditor as z, RenderStyleFunction as zt };