@portabletext/editor 1.58.0 → 2.0.0-canary.0

package/lib/utils/index.d.ts

@@ -1,487 +1,193 @@
-import type {
-  KeyedSegment,
-  Path,
-  PortableTextBlock,
-  PortableTextChild,
-  PortableTextTextBlock,
-} from '@sanity/types'
-import {PortableTextObject, PortableTextSpan} from '@sanity/types'
-
+import { BlockOffset, BlockPath, ChildPath, EditorContext, EditorSelection, EditorSelectionPoint } from "../_chunks-dts/behavior.types.action.js";
+import * as _sanity_types8 from "@sanity/types";
+import { KeyedSegment, PortableTextBlock, PortableTextChild, PortableTextSpan, PortableTextTextBlock } from "@sanity/types";
 /**
  * @public
  */
-declare type AnnotationSchemaType = BaseDefinition & {
-  fields: ReadonlyArray<FieldDefinition>
-}
-
-/**
- * @public
- */
-declare type BaseDefinition = {
-  name: string
-  title?: string
-}
-
-/**
- * @public
- */
-declare type BlockObjectSchemaType = BaseDefinition & {
-  fields: ReadonlyArray<FieldDefinition>
-}
-
-/**
- * @beta
- */
-declare type BlockOffset = {
-  path: BlockPath
-  offset: number
-}
-
-/**
- * @public
- */
-export declare function blockOffsetsToSelection({
+declare function blockOffsetToSpanSelectionPoint({
   context,
-  offsets,
-  backward,
+  blockOffset,
+  direction
 }: {
-  context: Pick<EditorContext, 'schema' | 'value'>
-  offsets: {
-    anchor: BlockOffset
-    focus: BlockOffset
-  }
-  backward?: boolean
-}): EditorSelection
-
+  context: Pick<EditorContext, 'schema' | 'value'>;
+  blockOffset: BlockOffset;
+  direction: 'forward' | 'backward';
+}): {
+  path: ChildPath;
+  offset: number;
+} | undefined;
 /**
  * @public
  */
-export declare function blockOffsetToBlockSelectionPoint({
+declare function spanSelectionPointToBlockOffset({
   context,
-  blockOffset,
+  selectionPoint
 }: {
-  context: Pick<EditorContext, 'value'>
-  blockOffset: BlockOffset
-}): EditorSelectionPoint | undefined
-
+  context: Pick<EditorContext, 'schema' | 'value'>;
+  selectionPoint: EditorSelectionPoint;
+}): BlockOffset | undefined;
 /**
  * @public
  */
-export declare function blockOffsetToSelectionPoint({
+declare function blockOffsetToBlockSelectionPoint({
   context,
-  blockOffset,
-  direction,
+  blockOffset
 }: {
-  context: Pick<EditorContext, 'schema' | 'value'>
-  blockOffset: BlockOffset
-  direction: 'forward' | 'backward'
-}): EditorSelectionPoint | undefined
-
+  context: Pick<EditorContext, 'value'>;
+  blockOffset: BlockOffset;
+}): EditorSelectionPoint | undefined;
 /**
  * @public
  */
-export declare function blockOffsetToSpanSelectionPoint({
+declare function blockOffsetToSelectionPoint({
   context,
   blockOffset,
-  direction,
+  direction
 }: {
-  context: Pick<EditorContext, 'schema' | 'value'>
-  blockOffset: BlockOffset
-  direction: 'forward' | 'backward'
-}):
-  | {
-      path: ChildPath
-      offset: number
-    }
-  | undefined
-
-/**
- * @public
- */
-declare type BlockPath = [
-  {
-    _key: string
-  },
-]
-
-/**
- * @public
- */
-declare type ChildPath = [
-  {
-    _key: string
-  },
-  'children',
-  {
-    _key: string
-  },
-]
-
+  context: Pick<EditorContext, 'schema' | 'value'>;
+  blockOffset: BlockOffset;
+  direction: 'forward' | 'backward';
+}): EditorSelectionPoint | undefined;
 /**
  * @public
  */
-export declare function childSelectionPointToBlockOffset({
+declare function blockOffsetsToSelection({
   context,
-  selectionPoint,
+  offsets,
+  backward
 }: {
-  context: Pick<EditorContext, 'schema' | 'value'>
-  selectionPoint: EditorSelectionPoint
-}): BlockOffset | undefined
-
-declare type Converter<TMIMEType extends MIMEType = MIMEType> = {
-  mimeType: TMIMEType
-  serialize: Serializer<TMIMEType>
-  deserialize: Deserializer<TMIMEType>
-}
-
-declare type ConverterEvent<TMIMEType extends MIMEType = MIMEType> =
-  | {
-      type: 'serialize'
-      originEvent: 'clipboard.copy' | 'clipboard.cut' | 'drag.dragstart'
-    }
-  | {
-      type: 'serialization.failure'
-      mimeType: TMIMEType
-      originEvent: 'clipboard.copy' | 'clipboard.cut' | 'drag.dragstart'
-      reason: string
-    }
-  | {
-      type: 'serialization.success'
-      data: string
-      mimeType: TMIMEType
-      originEvent: 'clipboard.copy' | 'clipboard.cut' | 'drag.dragstart'
-    }
-  | {
-      type: 'deserialize'
-      data: string
-    }
-  | {
-      type: 'deserialization.failure'
-      mimeType: TMIMEType
-      reason: string
-    }
-  | {
-      type: 'deserialization.success'
-      data: Array<PortableTextBlock>
-      mimeType: TMIMEType
-    }
-
+  context: Pick<EditorContext, 'schema' | 'value'>;
+  offsets: {
+    anchor: BlockOffset;
+    focus: BlockOffset;
+  };
+  backward?: boolean;
+}): EditorSelection;
 /**
  * @public
  */
-declare type DecoratorSchemaType = BaseDefinition & {
-  /**
-   * @deprecated
-   * Use `name` instead
-   */
-  value: string
-}
-
-declare type Deserializer<TMIMEType extends MIMEType> = ({
-  snapshot,
-  event,
+declare function childSelectionPointToBlockOffset({
+  context,
+  selectionPoint
 }: {
-  snapshot: EditorSnapshot
-  event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'deserialize'>
-}) => PickFromUnion<
-  ConverterEvent<TMIMEType>,
-  'type',
-  'deserialization.success' | 'deserialization.failure'
->
-
-/**
- * @public
- */
-declare type EditorContext = {
-  converters: Array<Converter>
-  keyGenerator: () => string
-  readOnly: boolean
-  schema: EditorSchema
-  selection: EditorSelection
-  value: Array<PortableTextBlock>
-}
-
+  context: Pick<EditorContext, 'schema' | 'value'>;
+  selectionPoint: EditorSelectionPoint;
+}): BlockOffset | undefined;
 /**
  * @public
  */
-declare type EditorSchema = {
-  annotations: ReadonlyArray<AnnotationSchemaType>
-  block: {
-    name: string
-  }
-  blockObjects: ReadonlyArray<BlockObjectSchemaType>
-  decorators: ReadonlyArray<DecoratorSchemaType>
-  inlineObjects: ReadonlyArray<InlineObjectSchemaType>
-  span: {
-    name: string
-  }
-  styles: ReadonlyArray<StyleSchemaType>
-  lists: ReadonlyArray<ListSchemaType>
-}
-
-/** @public */
-declare type EditorSelection = {
-  anchor: EditorSelectionPoint
-  focus: EditorSelectionPoint
-  backward?: boolean
-} | null
-
-/** @public */
-declare type EditorSelectionPoint = {
-  path: Path
-  offset: number
-}
-
-/**
- * @public
- */
-declare type EditorSnapshot = {
-  context: EditorContext
-  blockIndexMap: Map<string, number>
-  /**
-   * @beta
-   * Subject to change
-   */
-  decoratorState: Record<string, boolean | undefined>
-}
-
-/**
- * @public
- */
-declare type FieldDefinition = BaseDefinition & {
-  type: 'string' | 'number' | 'boolean' | 'array' | 'object'
-}
-
-/**
- * @public
- */
-export declare function getBlockEndPoint({
+declare function getBlockEndPoint({
   context,
-  block,
+  block
 }: {
-  context: Pick<EditorContext, 'schema'>
+  context: Pick<EditorContext, 'schema'>;
   block: {
-    node: PortableTextBlock
-    path: BlockPath
-  }
-}): EditorSelectionPoint
-
+    node: PortableTextBlock;
+    path: BlockPath;
+  };
+}): EditorSelectionPoint;
 /**
  * @public
  */
-export declare function getBlockStartPoint({
+declare function getBlockStartPoint({
   context,
-  block,
+  block
 }: {
-  context: Pick<EditorContext, 'schema'>
+  context: Pick<EditorContext, 'schema'>;
   block: {
-    node: PortableTextBlock
-    path: BlockPath
-  }
-}): EditorSelectionPoint
-
-/**
- * @public
- */
-export declare function getSelectionEndPoint<
-  TEditorSelection extends NonNullable<EditorSelection> | null,
-  TEditorSelectionPoint extends
-    EditorSelectionPoint | null = TEditorSelection extends NonNullable<EditorSelection>
-    ? EditorSelectionPoint
-    : null,
->(selection: TEditorSelection): TEditorSelectionPoint
-
+    node: PortableTextBlock;
+    path: BlockPath;
+  };
+}): EditorSelectionPoint;
 /**
  * @public
  */
-export declare function getSelectionStartPoint<
-  TEditorSelection extends NonNullable<EditorSelection> | null,
-  TEditorSelectionPoint extends
-    EditorSelectionPoint | null = TEditorSelection extends NonNullable<EditorSelection>
-    ? EditorSelectionPoint
-    : null,
->(selection: TEditorSelection): TEditorSelectionPoint
-
+declare function getSelectionEndPoint<TEditorSelection extends NonNullable<EditorSelection> | null, TEditorSelectionPoint extends EditorSelectionPoint | null = (TEditorSelection extends NonNullable<EditorSelection> ? EditorSelectionPoint : null)>(selection: TEditorSelection): TEditorSelectionPoint;
 /**
  * @public
  */
-export declare function getTextBlockText(block: PortableTextTextBlock): string
-
+declare function getSelectionStartPoint<TEditorSelection extends NonNullable<EditorSelection> | null, TEditorSelectionPoint extends EditorSelectionPoint | null = (TEditorSelection extends NonNullable<EditorSelection> ? EditorSelectionPoint : null)>(selection: TEditorSelection): TEditorSelectionPoint;
 /**
  * @public
  */
-declare type InlineObjectSchemaType = BaseDefinition & {
-  fields: ReadonlyArray<FieldDefinition>
-}
-
+declare function getTextBlockText(block: PortableTextTextBlock): string;
 /**
  * @public
  */
-export declare function isEmptyTextBlock(
-  context: Pick<EditorContext, 'schema'>,
-  block: PortableTextBlock,
-): boolean
-
+declare function isEmptyTextBlock(context: Pick<EditorContext, 'schema'>, block: PortableTextBlock): boolean;
 /**
  * @public
  */
-export declare function isEqualSelectionPoints(
-  a: EditorSelectionPoint,
-  b: EditorSelectionPoint,
-): boolean
-
+declare function isEqualSelectionPoints(a: EditorSelectionPoint, b: EditorSelectionPoint): boolean;
 /**
  * @public
  */
-export declare function isEqualSelections(
-  a: EditorSelection,
-  b: EditorSelection,
-): boolean
-
+declare function isEqualSelections(a: EditorSelection, b: EditorSelection): boolean;
 /**
  * @public
  */
-export declare function isKeyedSegment(
-  segment: unknown,
-): segment is KeyedSegment
-
+declare function isKeyedSegment(segment: unknown): segment is KeyedSegment;
 /**
  * @public
  */
-export declare function isSelectionCollapsed(
-  selection: EditorSelection,
-): boolean
-
+declare function isSelectionCollapsed(selection: EditorSelection): boolean;
 /**
  * @public
  */
-export declare function isSpan(
-  context: Pick<EditorContext, 'schema'>,
-  child: PortableTextChild,
-): child is PortableTextSpan
-
+declare function isSpan(context: Pick<EditorContext, 'schema'>, child: PortableTextChild): child is PortableTextSpan;
 /**
  * @public
  */
-export declare function isTextBlock(
-  context: Pick<EditorContext, 'schema'>,
-  block: unknown,
-): block is PortableTextTextBlock
-
-/**
- * @public
- */
-declare type ListSchemaType = BaseDefinition & {
-  /**
-   * @deprecated
-   * Use `name` instead
-   */
-  value: string
-}
-
+declare function isTextBlock(context: Pick<EditorContext, 'schema'>, block: unknown): block is PortableTextTextBlock;
 /**
  * @beta
  */
-export declare function mergeTextBlocks({
+declare function mergeTextBlocks({
   context,
   targetBlock,
-  incomingBlock,
+  incomingBlock
 }: {
-  context: Pick<EditorContext, 'keyGenerator' | 'schema'>
-  targetBlock: PortableTextTextBlock
-  incomingBlock: PortableTextTextBlock
-}): PortableTextTextBlock<PortableTextObject | PortableTextSpan>
-
-declare type MIMEType = `${string}/${string}`
-
-/**
- * @internal
- */
-declare type PickFromUnion<
-  TUnion,
-  TTagKey extends keyof TUnion,
-  TPickedTags extends TUnion[TTagKey],
-> = TUnion extends Record<TTagKey, TPickedTags> ? TUnion : never
-
-/**
- * @public
- */
-export declare function reverseSelection<
-  TEditorSelection extends NonNullable<EditorSelection> | null,
->(selection: TEditorSelection): TEditorSelection
-
+  context: Pick<EditorContext, 'keyGenerator' | 'schema'>;
+  targetBlock: PortableTextTextBlock;
+  incomingBlock: PortableTextTextBlock;
+}): PortableTextTextBlock<_sanity_types8.PortableTextObject | _sanity_types8.PortableTextSpan>;
 /**
  * @public
  */
-export declare function selectionPointToBlockOffset({
-  context,
-  selectionPoint,
-}: {
-  context: Pick<EditorContext, 'schema' | 'value'>
-  selectionPoint: EditorSelectionPoint
-}): BlockOffset | undefined
-
-declare type Serializer<TMIMEType extends MIMEType> = ({
-  snapshot,
-  event,
-}: {
-  snapshot: EditorSnapshot
-  event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'serialize'>
-}) => PickFromUnion<
-  ConverterEvent<TMIMEType>,
-  'type',
-  'serialization.success' | 'serialization.failure'
->
-
+declare function reverseSelection<TEditorSelection extends NonNullable<EditorSelection> | null>(selection: TEditorSelection): TEditorSelection;
 /**
  * @public
  */
-export declare function sliceBlocks({
+declare function selectionPointToBlockOffset({
   context,
-  blocks,
+  selectionPoint
 }: {
-  context: Pick<EditorContext, 'schema' | 'selection'>
-  blocks: Array<PortableTextBlock>
-}): Array<PortableTextBlock>
-
+  context: Pick<EditorContext, 'schema' | 'value'>;
+  selectionPoint: EditorSelectionPoint;
+}): BlockOffset | undefined;
 /**
  * @public
  */
-export declare function spanSelectionPointToBlockOffset({
+declare function sliceBlocks({
   context,
-  selectionPoint,
+  blocks
 }: {
-  context: Pick<EditorContext, 'schema' | 'value'>
-  selectionPoint: EditorSelectionPoint
-}): BlockOffset | undefined
-
+  context: Pick<EditorContext, 'schema' | 'selection'>;
+  blocks: Array<PortableTextBlock>;
+}): Array<PortableTextBlock>;
 /**
  * @beta
  */
-export declare function splitTextBlock({
+declare function splitTextBlock({
   context,
   block,
-  point,
+  point
 }: {
-  context: Pick<EditorContext, 'schema'>
-  block: PortableTextTextBlock
-  point: EditorSelectionPoint
-}):
-  | {
-      before: PortableTextTextBlock
-      after: PortableTextTextBlock
-    }
-  | undefined
-
-/**
- * @public
- */
-declare type StyleSchemaType = BaseDefinition & {
-  /**
-   * @deprecated
-   * Use `name` instead
-   */
-  value: string
-}
-
-export {}
+  context: Pick<EditorContext, 'schema'>;
+  block: PortableTextTextBlock;
+  point: EditorSelectionPoint;
+}): {
+  before: PortableTextTextBlock;
+  after: PortableTextTextBlock;
+} | undefined;
+export { blockOffsetToBlockSelectionPoint, blockOffsetToSelectionPoint, blockOffsetToSpanSelectionPoint, blockOffsetsToSelection, childSelectionPointToBlockOffset, getBlockEndPoint, getBlockStartPoint, getSelectionEndPoint, getSelectionStartPoint, getTextBlockText, isEmptyTextBlock, isEqualSelectionPoints, isEqualSelections, isKeyedSegment, isSelectionCollapsed, isSpan, isTextBlock, mergeTextBlocks, reverseSelection, selectionPointToBlockOffset, sliceBlocks, spanSelectionPointToBlockOffset, splitTextBlock };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "1.58.0",
+  "version": "2.0.0-canary.0",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",
@@ -80,16 +80,16 @@
     "slate-react": "0.117.3",
     "use-effect-event": "^1.0.2",
     "xstate": "^5.20.1",
-    "@portabletext/block-tools": "1.1.38",
-    "@portabletext/keyboard-shortcuts": "1.1.0",
-    "@portabletext/patches": "1.1.5"
+    "@portabletext/block-tools": "2.0.0-canary.0",
+    "@portabletext/keyboard-shortcuts": "2.0.0-canary.0",
+    "@portabletext/patches": "2.0.0-canary.0"
   },
   "devDependencies": {
     "@portabletext/toolkit": "^2.0.17",
     "@sanity/diff-match-patch": "^3.2.0",
-    "@sanity/pkg-utils": "^7.9.3",
-    "@sanity/schema": "^3.98.1",
-    "@sanity/types": "^3.98.1",
+    "@sanity/pkg-utils": "^7.9.6",
+    "@sanity/schema": "^4.0.1",
+    "@sanity/types": "^4.0.1",
     "@testing-library/react": "^16.3.0",
     "@types/debug": "^4.1.12",
     "@types/lodash": "^4.17.16",
@@ -103,7 +103,7 @@
     "@vitest/coverage-istanbul": "^3.2.4",
     "babel-plugin-react-compiler": "19.1.0-rc.2",
     "eslint": "8.57.1",
-    "eslint-plugin-react-hooks": "0.0.0-experimental-cee7939b-20250625",
+    "eslint-plugin-react-hooks": "0.0.0-experimental-97cdd5d3-20250710",
     "jsdom": "^26.0.0",
     "react": "^19.1.0",
     "react-dom": "^19.1.0",
@@ -115,13 +115,13 @@
     "racejar": "1.2.10"
   },
   "peerDependencies": {
-    "@sanity/schema": "^3.98.0 || ^4.0.0-0",
-    "@sanity/types": "^3.98.0 || ^4.0.0-0",
-    "react": "^16.9 || ^17 || ^18 || ^19",
+    "@sanity/schema": "^4.0.1",
+    "@sanity/types": "^4.0.1",
+    "react": "^18.3 || ^19",
     "rxjs": "^7.8.2"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20.19"
   },
   "publishConfig": {
     "access": "public"