@portabletext/editor 1.28.0 → 1.30.0

package/lib/utils/index.cjs

@@ -1,6 +1,71 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: !0 });
-var util_isEmptyTextBlock = require("../_chunks-cjs/util.is-empty-text-block.cjs"), util_isEqualSelectionPoints = require("../_chunks-cjs/util.is-equal-selection-points.cjs"), util_reverseSelection = require("../_chunks-cjs/util.reverse-selection.cjs"), util_sliceBlocks = require("../_chunks-cjs/util.slice-blocks.cjs");
+var util_isEmptyTextBlock = require("../_chunks-cjs/util.is-empty-text-block.cjs"), util_isEqualSelectionPoints = require("../_chunks-cjs/util.is-equal-selection-points.cjs"), parseBlocks = require("../_chunks-cjs/parse-blocks.cjs"), util_reverseSelection = require("../_chunks-cjs/util.reverse-selection.cjs"), util_sliceBlocks = require("../_chunks-cjs/util.slice-blocks.cjs");
+function isSpan(context, child) {
+  return child._type === context.schema.span.name;
+}
+function isTextBlock(context, block) {
+  return block._type === context.schema.block.name;
+}
+function mergeTextBlocks({
+  context,
+  targetBlock,
+  incomingBlock
+}) {
+  const parsedIncomingBlock = parseBlocks.parseBlock({
+    context,
+    block: incomingBlock,
+    options: {
+      refreshKeys: !0
+    }
+  });
+  return !parsedIncomingBlock || !isTextBlock(context, parsedIncomingBlock) ? targetBlock : {
+    ...targetBlock,
+    children: [...targetBlock.children, ...parsedIncomingBlock.children],
+    markDefs: [...targetBlock.markDefs ?? [], ...parsedIncomingBlock.markDefs ?? []]
+  };
+}
+function splitTextBlock({
+  context,
+  block,
+  point
+}) {
+  const firstChild = block.children.at(0), lastChild = block.children.at(block.children.length - 1);
+  if (!firstChild || !lastChild)
+    return;
+  const before = util_sliceBlocks.sliceBlocks({
+    blocks: [block],
+    selection: {
+      anchor: {
+        path: [{
+          _key: block._key
+        }, "children", {
+          _key: firstChild._key
+        }],
+        offset: 0
+      },
+      focus: point
+    }
+  }).at(0), after = util_sliceBlocks.sliceBlocks({
+    blocks: [block],
+    selection: {
+      anchor: point,
+      focus: {
+        path: [{
+          _key: block._key
+        }, "children", {
+          _key: lastChild._key
+        }],
+        offset: isSpan(context, lastChild) ? lastChild.text.length : 0
+      }
+    }
+  }).at(0);
+  if (!(!before || !after) && !(!isTextBlock(context, before) || !isTextBlock(context, after)))
+    return {
+      before,
+      after
+    };
+}
 exports.blockOffsetToSpanSelectionPoint = util_isEmptyTextBlock.blockOffsetToSpanSelectionPoint;
 exports.getTextBlockText = util_isEmptyTextBlock.getTextBlockText;
 exports.isEmptyTextBlock = util_isEmptyTextBlock.isEmptyTextBlock;
@@ -11,4 +76,8 @@ exports.isEqualSelectionPoints = util_isEqualSelectionPoints.isEqualSelectionPoi
 exports.isKeyedSegment = util_isEqualSelectionPoints.isKeyedSegment;
 exports.reverseSelection = util_reverseSelection.reverseSelection;
 exports.sliceBlocks = util_sliceBlocks.sliceBlocks;
+exports.isSpan = isSpan;
+exports.isTextBlock = isTextBlock;
+exports.mergeTextBlocks = mergeTextBlocks;
+exports.splitTextBlock = splitTextBlock;
 //# sourceMappingURL=index.cjs.map

package/lib/utils/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs","sources":["../../src/utils/util.is-span.ts","../../src/utils/util.is-text-block.ts","../../src/utils/util.merge-text-blocks.ts","../../src/utils/util.split-text-block.ts"],"sourcesContent":["import type {PortableTextChild, PortableTextSpan} from '@sanity/types'\nimport type {EditorContext} from '../selectors'\n\n/**\n * @public\n */\nexport function isSpan(\n  context: Pick<EditorContext, 'schema'>,\n  child: PortableTextChild,\n): child is PortableTextSpan {\n  return child._type === context.schema.span.name\n}\n","import type {PortableTextBlock, PortableTextTextBlock} from '@sanity/types'\nimport type {EditorContext} from '../selectors'\n\n/**\n * @public\n */\nexport function isTextBlock(\n  context: Pick<EditorContext, 'schema'>,\n  block: PortableTextBlock,\n): block is PortableTextTextBlock {\n  return block._type === context.schema.block.name\n}\n","import type {PortableTextTextBlock} from '@sanity/types'\nimport {parseBlock} from '../internal-utils/parse-blocks'\nimport type {EditorContext} from '../selectors'\nimport {isTextBlock} from './util.is-text-block'\n\n/**\n * @beta\n */\nexport function mergeTextBlocks({\n  context,\n  targetBlock,\n  incomingBlock,\n}: {\n  context: Pick<EditorContext, 'keyGenerator' | 'schema'>\n  targetBlock: PortableTextTextBlock\n  incomingBlock: PortableTextTextBlock\n}) {\n  const parsedIncomingBlock = parseBlock({\n    context,\n    block: incomingBlock,\n    options: {refreshKeys: true},\n  })\n\n  if (!parsedIncomingBlock || !isTextBlock(context, parsedIncomingBlock)) {\n    return targetBlock\n  }\n\n  return {\n    ...targetBlock,\n    children: [...targetBlock.children, ...parsedIncomingBlock.children],\n    markDefs: [\n      ...(targetBlock.markDefs ?? []),\n      ...(parsedIncomingBlock.markDefs ?? []),\n    ],\n  }\n}\n","import type {PortableTextTextBlock} from '@sanity/types'\nimport {isTextBlock, sliceBlocks, type EditorSelectionPoint} from '.'\nimport type {EditorContext} from '../selectors'\nimport {isSpan} from './util.is-span'\n\n/**\n * @beta\n */\nexport function splitTextBlock({\n  context,\n  block,\n  point,\n}: {\n  context: Pick<EditorContext, 'schema'>\n  block: PortableTextTextBlock\n  point: EditorSelectionPoint\n}): {before: PortableTextTextBlock; after: PortableTextTextBlock} | undefined {\n  const firstChild = block.children.at(0)\n  const lastChild = block.children.at(block.children.length - 1)\n\n  if (!firstChild || !lastChild) {\n    return undefined\n  }\n\n  const before = sliceBlocks({\n    blocks: [block],\n    selection: {\n      anchor: {\n        path: [{_key: block._key}, 'children', {_key: firstChild._key}],\n        offset: 0,\n      },\n      focus: point,\n    },\n  }).at(0)\n  const after = sliceBlocks({\n    blocks: [block],\n    selection: {\n      anchor: point,\n      focus: {\n        path: [{_key: block._key}, 'children', {_key: lastChild._key}],\n        offset: isSpan(context, lastChild) ? lastChild.text.length : 0,\n      },\n    },\n  }).at(0)\n\n  if (!before || !after) {\n    return undefined\n  }\n\n  if (!isTextBlock(context, before) || !isTextBlock(context, after)) {\n    return undefined\n  }\n\n  return {before, after}\n}\n"],"names":["isSpan","context","child","_type","schema","span","name","isTextBlock","block","mergeTextBlocks","targetBlock","incomingBlock","parsedIncomingBlock","parseBlock","options","refreshKeys","children","markDefs","splitTextBlock","point","firstChild","at","lastChild","length","before","sliceBlocks","blocks","selection","anchor","path","_key","offset","focus","after","text"],"mappings":";;;AAMgBA,SAAAA,OACdC,SACAC,OAC2B;AAC3B,SAAOA,MAAMC,UAAUF,QAAQG,OAAOC,KAAKC;AAC7C;ACLgBC,SAAAA,YACdN,SACAO,OACgC;AAChC,SAAOA,MAAML,UAAUF,QAAQG,OAAOI,MAAMF;AAC9C;ACHO,SAASG,gBAAgB;AAAA,EAC9BR;AAAAA,EACAS;AAAAA,EACAC;AAKF,GAAG;AACD,QAAMC,sBAAsBC,YAAAA,WAAW;AAAA,IACrCZ;AAAAA,IACAO,OAAOG;AAAAA,IACPG,SAAS;AAAA,MAACC,aAAa;AAAA,IAAA;AAAA,EAAI,CAC5B;AAED,SAAI,CAACH,uBAAuB,CAACL,YAAYN,SAASW,mBAAmB,IAC5DF,cAGF;AAAA,IACL,GAAGA;AAAAA,IACHM,UAAU,CAAC,GAAGN,YAAYM,UAAU,GAAGJ,oBAAoBI,QAAQ;AAAA,IACnEC,UAAU,CACR,GAAIP,YAAYO,YAAY,CAAA,GAC5B,GAAIL,oBAAoBK,YAAY,CAAG,CAAA;AAAA,EAE3C;AACF;AC3BO,SAASC,eAAe;AAAA,EAC7BjB;AAAAA,EACAO;AAAAA,EACAW;AAKF,GAA8E;AAC5E,QAAMC,aAAaZ,MAAMQ,SAASK,GAAG,CAAC,GAChCC,YAAYd,MAAMQ,SAASK,GAAGb,MAAMQ,SAASO,SAAS,CAAC;AAEzD,MAAA,CAACH,cAAc,CAACE;AAClB;AAGF,QAAME,SAASC,iBAAAA,YAAY;AAAA,IACzBC,QAAQ,CAAClB,KAAK;AAAA,IACdmB,WAAW;AAAA,MACTC,QAAQ;AAAA,QACNC,MAAM,CAAC;AAAA,UAACC,MAAMtB,MAAMsB;AAAAA,WAAO,YAAY;AAAA,UAACA,MAAMV,WAAWU;AAAAA,QAAAA,CAAK;AAAA,QAC9DC,QAAQ;AAAA,MACV;AAAA,MACAC,OAAOb;AAAAA,IAAAA;AAAAA,EAEV,CAAA,EAAEE,GAAG,CAAC,GACDY,QAAQR,iBAAAA,YAAY;AAAA,IACxBC,QAAQ,CAAClB,KAAK;AAAA,IACdmB,WAAW;AAAA,MACTC,QAAQT;AAAAA,MACRa,OAAO;AAAA,QACLH,MAAM,CAAC;AAAA,UAACC,MAAMtB,MAAMsB;AAAAA,WAAO,YAAY;AAAA,UAACA,MAAMR,UAAUQ;AAAAA,QAAAA,CAAK;AAAA,QAC7DC,QAAQ/B,OAAOC,SAASqB,SAAS,IAAIA,UAAUY,KAAKX,SAAS;AAAA,MAAA;AAAA,IAC/D;AAAA,EACF,CACD,EAAEF,GAAG,CAAC;AAEP,MAAI,EAACG,CAAAA,UAAU,CAACS,UAIZ,EAAC1B,CAAAA,YAAYN,SAASuB,MAAM,KAAK,CAACjB,YAAYN,SAASgC,KAAK;AAIzD,WAAA;AAAA,MAACT;AAAAA,MAAQS;AAAAA,IAAK;AACvB;;;;;;;;;;;;;;;"}

package/lib/utils/index.d.cts

@@ -1,5 +1,20 @@
-import {KeyedSegment, PortableTextBlock} from '@sanity/types'
-import type {Path, PathSegment, PortableTextTextBlock} from '@sanity/types'
+import type {
+  ArraySchemaType,
+  BlockDecoratorDefinition,
+  BlockListDefinition,
+  BlockStyleDefinition,
+  ObjectSchemaType,
+  Path,
+  PathSegment,
+  PortableTextChild,
+  PortableTextTextBlock,
+} from '@sanity/types'
+import {
+  KeyedSegment,
+  PortableTextBlock,
+  PortableTextObject,
+  PortableTextSpan,
+} from '@sanity/types'
 
 /**
  * @beta
@@ -25,6 +40,72 @@ export declare function blockOffsetToSpanSelectionPoint({
     }
   | 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: 'copy' | 'cut' | 'unknown'
+    }
+  | {
+      type: 'serialization.failure'
+      mimeType: TMIMEType
+      reason: string
+    }
+  | {
+      type: 'serialization.success'
+      data: string
+      mimeType: TMIMEType
+      originEvent: 'copy' | 'cut' | 'unknown'
+    }
+  | {
+      type: 'deserialize'
+      data: string
+    }
+  | {
+      type: 'deserialization.failure'
+      mimeType: TMIMEType
+      reason: string
+    }
+  | {
+      type: 'deserialization.success'
+      data: Array<PortableTextBlock>
+      mimeType: TMIMEType
+    }
+
+declare type Deserializer<TMIMEType extends MIMEType> = ({
+  context,
+  event,
+}: {
+  context: EditorContext
+  event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'deserialize'>
+}) => PickFromUnion<
+  ConverterEvent<TMIMEType>,
+  'type',
+  'deserialization.success' | 'deserialization.failure'
+>
+
+/**
+ * @public
+ */
+declare type EditorContext = {
+  activeDecorators: Array<string>
+  converters: Array<Converter>
+  keyGenerator: () => string
+  schema: EditorSchema
+  selection: EditorSelection
+  value: Array<PortableTextBlock>
+}
+
+/**
+ * @public
+ */
+declare type EditorSchema = PortableTextMemberSchemaTypes
+
 /** @public */
 export declare type EditorSelection = {
   anchor: EditorSelectionPoint
@@ -85,6 +166,61 @@ export declare function isKeyedSegment(
   segment: PathSegment,
 ): segment is KeyedSegment
 
+/**
+ * @public
+ */
+export declare function isSpan(
+  context: Pick<EditorContext, 'schema'>,
+  child: PortableTextChild,
+): child is PortableTextSpan
+
+/**
+ * @public
+ */
+export declare function isTextBlock(
+  context: Pick<EditorContext, 'schema'>,
+  block: PortableTextBlock,
+): block is PortableTextTextBlock
+
+/**
+ * @beta
+ */
+export declare function mergeTextBlocks({
+  context,
+  targetBlock,
+  incomingBlock,
+}: {
+  context: Pick<EditorContext, 'keyGenerator' | 'schema'>
+  targetBlock: PortableTextTextBlock
+  incomingBlock: PortableTextTextBlock
+}): PortableTextTextBlock<PortableTextSpan | PortableTextObject>
+
+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
+
+/** @internal */
+declare type PortableTextMemberSchemaTypes = {
+  annotations: (ObjectSchemaType & {
+    i18nTitleKey?: string
+  })[]
+  block: ObjectSchemaType
+  blockObjects: ObjectSchemaType[]
+  decorators: BlockDecoratorDefinition[]
+  inlineObjects: ObjectSchemaType[]
+  portableText: ArraySchemaType<PortableTextBlock>
+  span: ObjectSchemaType
+  styles: BlockStyleDefinition[]
+  lists: BlockListDefinition[]
+}
+
 /**
  * @public
  */
@@ -92,6 +228,18 @@ export declare function reverseSelection(
   selection: NonNullable<EditorSelection>,
 ): NonNullable<EditorSelection>
 
+declare type Serializer<TMIMEType extends MIMEType> = ({
+  context,
+  event,
+}: {
+  context: EditorContext
+  event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'serialize'>
+}) => PickFromUnion<
+  ConverterEvent<TMIMEType>,
+  'type',
+  'serialization.success' | 'serialization.failure'
+>
+
 /**
  * @public
  */
@@ -114,4 +262,22 @@ export declare function spanSelectionPointToBlockOffset({
   selectionPoint: EditorSelectionPoint
 }): BlockOffset | undefined
 
+/**
+ * @beta
+ */
+export declare function splitTextBlock({
+  context,
+  block,
+  point,
+}: {
+  context: Pick<EditorContext, 'schema'>
+  block: PortableTextTextBlock
+  point: EditorSelectionPoint
+}):
+  | {
+      before: PortableTextTextBlock
+      after: PortableTextTextBlock
+    }
+  | undefined
+
 export {}

package/lib/utils/index.d.ts

@@ -1,5 +1,20 @@
-import {KeyedSegment, PortableTextBlock} from '@sanity/types'
-import type {Path, PathSegment, PortableTextTextBlock} from '@sanity/types'
+import type {
+  ArraySchemaType,
+  BlockDecoratorDefinition,
+  BlockListDefinition,
+  BlockStyleDefinition,
+  ObjectSchemaType,
+  Path,
+  PathSegment,
+  PortableTextChild,
+  PortableTextTextBlock,
+} from '@sanity/types'
+import {
+  KeyedSegment,
+  PortableTextBlock,
+  PortableTextObject,
+  PortableTextSpan,
+} from '@sanity/types'
 
 /**
  * @beta
@@ -25,6 +40,72 @@ export declare function blockOffsetToSpanSelectionPoint({
     }
   | 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: 'copy' | 'cut' | 'unknown'
+    }
+  | {
+      type: 'serialization.failure'
+      mimeType: TMIMEType
+      reason: string
+    }
+  | {
+      type: 'serialization.success'
+      data: string
+      mimeType: TMIMEType
+      originEvent: 'copy' | 'cut' | 'unknown'
+    }
+  | {
+      type: 'deserialize'
+      data: string
+    }
+  | {
+      type: 'deserialization.failure'
+      mimeType: TMIMEType
+      reason: string
+    }
+  | {
+      type: 'deserialization.success'
+      data: Array<PortableTextBlock>
+      mimeType: TMIMEType
+    }
+
+declare type Deserializer<TMIMEType extends MIMEType> = ({
+  context,
+  event,
+}: {
+  context: EditorContext
+  event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'deserialize'>
+}) => PickFromUnion<
+  ConverterEvent<TMIMEType>,
+  'type',
+  'deserialization.success' | 'deserialization.failure'
+>
+
+/**
+ * @public
+ */
+declare type EditorContext = {
+  activeDecorators: Array<string>
+  converters: Array<Converter>
+  keyGenerator: () => string
+  schema: EditorSchema
+  selection: EditorSelection
+  value: Array<PortableTextBlock>
+}
+
+/**
+ * @public
+ */
+declare type EditorSchema = PortableTextMemberSchemaTypes
+
 /** @public */
 export declare type EditorSelection = {
   anchor: EditorSelectionPoint
@@ -85,6 +166,61 @@ export declare function isKeyedSegment(
   segment: PathSegment,
 ): segment is KeyedSegment
 
+/**
+ * @public
+ */
+export declare function isSpan(
+  context: Pick<EditorContext, 'schema'>,
+  child: PortableTextChild,
+): child is PortableTextSpan
+
+/**
+ * @public
+ */
+export declare function isTextBlock(
+  context: Pick<EditorContext, 'schema'>,
+  block: PortableTextBlock,
+): block is PortableTextTextBlock
+
+/**
+ * @beta
+ */
+export declare function mergeTextBlocks({
+  context,
+  targetBlock,
+  incomingBlock,
+}: {
+  context: Pick<EditorContext, 'keyGenerator' | 'schema'>
+  targetBlock: PortableTextTextBlock
+  incomingBlock: PortableTextTextBlock
+}): PortableTextTextBlock<PortableTextSpan | PortableTextObject>
+
+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
+
+/** @internal */
+declare type PortableTextMemberSchemaTypes = {
+  annotations: (ObjectSchemaType & {
+    i18nTitleKey?: string
+  })[]
+  block: ObjectSchemaType
+  blockObjects: ObjectSchemaType[]
+  decorators: BlockDecoratorDefinition[]
+  inlineObjects: ObjectSchemaType[]
+  portableText: ArraySchemaType<PortableTextBlock>
+  span: ObjectSchemaType
+  styles: BlockStyleDefinition[]
+  lists: BlockListDefinition[]
+}
+
 /**
  * @public
  */
@@ -92,6 +228,18 @@ export declare function reverseSelection(
   selection: NonNullable<EditorSelection>,
 ): NonNullable<EditorSelection>
 
+declare type Serializer<TMIMEType extends MIMEType> = ({
+  context,
+  event,
+}: {
+  context: EditorContext
+  event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'serialize'>
+}) => PickFromUnion<
+  ConverterEvent<TMIMEType>,
+  'type',
+  'serialization.success' | 'serialization.failure'
+>
+
 /**
  * @public
  */
@@ -114,4 +262,22 @@ export declare function spanSelectionPointToBlockOffset({
   selectionPoint: EditorSelectionPoint
 }): BlockOffset | undefined
 
+/**
+ * @beta
+ */
+export declare function splitTextBlock({
+  context,
+  block,
+  point,
+}: {
+  context: Pick<EditorContext, 'schema'>
+  block: PortableTextTextBlock
+  point: EditorSelectionPoint
+}):
+  | {
+      before: PortableTextTextBlock
+      after: PortableTextTextBlock
+    }
+  | undefined
+
 export {}

package/lib/utils/index.js

@@ -1,7 +1,73 @@
 import { blockOffsetToSpanSelectionPoint, getTextBlockText, isEmptyTextBlock, spanSelectionPointToBlockOffset } from "../_chunks-es/util.is-empty-text-block.js";
 import { getBlockEndPoint, getBlockStartPoint, isEqualSelectionPoints, isKeyedSegment } from "../_chunks-es/util.is-equal-selection-points.js";
+import { parseBlock } from "../_chunks-es/parse-blocks.js";
 import { reverseSelection } from "../_chunks-es/util.reverse-selection.js";
 import { sliceBlocks } from "../_chunks-es/util.slice-blocks.js";
+function isSpan(context, child) {
+  return child._type === context.schema.span.name;
+}
+function isTextBlock(context, block) {
+  return block._type === context.schema.block.name;
+}
+function mergeTextBlocks({
+  context,
+  targetBlock,
+  incomingBlock
+}) {
+  const parsedIncomingBlock = parseBlock({
+    context,
+    block: incomingBlock,
+    options: {
+      refreshKeys: !0
+    }
+  });
+  return !parsedIncomingBlock || !isTextBlock(context, parsedIncomingBlock) ? targetBlock : {
+    ...targetBlock,
+    children: [...targetBlock.children, ...parsedIncomingBlock.children],
+    markDefs: [...targetBlock.markDefs ?? [], ...parsedIncomingBlock.markDefs ?? []]
+  };
+}
+function splitTextBlock({
+  context,
+  block,
+  point
+}) {
+  const firstChild = block.children.at(0), lastChild = block.children.at(block.children.length - 1);
+  if (!firstChild || !lastChild)
+    return;
+  const before = sliceBlocks({
+    blocks: [block],
+    selection: {
+      anchor: {
+        path: [{
+          _key: block._key
+        }, "children", {
+          _key: firstChild._key
+        }],
+        offset: 0
+      },
+      focus: point
+    }
+  }).at(0), after = sliceBlocks({
+    blocks: [block],
+    selection: {
+      anchor: point,
+      focus: {
+        path: [{
+          _key: block._key
+        }, "children", {
+          _key: lastChild._key
+        }],
+        offset: isSpan(context, lastChild) ? lastChild.text.length : 0
+      }
+    }
+  }).at(0);
+  if (!(!before || !after) && !(!isTextBlock(context, before) || !isTextBlock(context, after)))
+    return {
+      before,
+      after
+    };
+}
 export {
   blockOffsetToSpanSelectionPoint,
   getBlockEndPoint,
@@ -10,8 +76,12 @@ export {
   isEmptyTextBlock,
   isEqualSelectionPoints,
   isKeyedSegment,
+  isSpan,
+  isTextBlock,
+  mergeTextBlocks,
   reverseSelection,
   sliceBlocks,
-  spanSelectionPointToBlockOffset
+  spanSelectionPointToBlockOffset,
+  splitTextBlock
 };
 //# sourceMappingURL=index.js.map

package/lib/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}
+{"version":3,"file":"index.js","sources":["../../src/utils/util.is-span.ts","../../src/utils/util.is-text-block.ts","../../src/utils/util.merge-text-blocks.ts","../../src/utils/util.split-text-block.ts"],"sourcesContent":["import type {PortableTextChild, PortableTextSpan} from '@sanity/types'\nimport type {EditorContext} from '../selectors'\n\n/**\n * @public\n */\nexport function isSpan(\n  context: Pick<EditorContext, 'schema'>,\n  child: PortableTextChild,\n): child is PortableTextSpan {\n  return child._type === context.schema.span.name\n}\n","import type {PortableTextBlock, PortableTextTextBlock} from '@sanity/types'\nimport type {EditorContext} from '../selectors'\n\n/**\n * @public\n */\nexport function isTextBlock(\n  context: Pick<EditorContext, 'schema'>,\n  block: PortableTextBlock,\n): block is PortableTextTextBlock {\n  return block._type === context.schema.block.name\n}\n","import type {PortableTextTextBlock} from '@sanity/types'\nimport {parseBlock} from '../internal-utils/parse-blocks'\nimport type {EditorContext} from '../selectors'\nimport {isTextBlock} from './util.is-text-block'\n\n/**\n * @beta\n */\nexport function mergeTextBlocks({\n  context,\n  targetBlock,\n  incomingBlock,\n}: {\n  context: Pick<EditorContext, 'keyGenerator' | 'schema'>\n  targetBlock: PortableTextTextBlock\n  incomingBlock: PortableTextTextBlock\n}) {\n  const parsedIncomingBlock = parseBlock({\n    context,\n    block: incomingBlock,\n    options: {refreshKeys: true},\n  })\n\n  if (!parsedIncomingBlock || !isTextBlock(context, parsedIncomingBlock)) {\n    return targetBlock\n  }\n\n  return {\n    ...targetBlock,\n    children: [...targetBlock.children, ...parsedIncomingBlock.children],\n    markDefs: [\n      ...(targetBlock.markDefs ?? []),\n      ...(parsedIncomingBlock.markDefs ?? []),\n    ],\n  }\n}\n","import type {PortableTextTextBlock} from '@sanity/types'\nimport {isTextBlock, sliceBlocks, type EditorSelectionPoint} from '.'\nimport type {EditorContext} from '../selectors'\nimport {isSpan} from './util.is-span'\n\n/**\n * @beta\n */\nexport function splitTextBlock({\n  context,\n  block,\n  point,\n}: {\n  context: Pick<EditorContext, 'schema'>\n  block: PortableTextTextBlock\n  point: EditorSelectionPoint\n}): {before: PortableTextTextBlock; after: PortableTextTextBlock} | undefined {\n  const firstChild = block.children.at(0)\n  const lastChild = block.children.at(block.children.length - 1)\n\n  if (!firstChild || !lastChild) {\n    return undefined\n  }\n\n  const before = sliceBlocks({\n    blocks: [block],\n    selection: {\n      anchor: {\n        path: [{_key: block._key}, 'children', {_key: firstChild._key}],\n        offset: 0,\n      },\n      focus: point,\n    },\n  }).at(0)\n  const after = sliceBlocks({\n    blocks: [block],\n    selection: {\n      anchor: point,\n      focus: {\n        path: [{_key: block._key}, 'children', {_key: lastChild._key}],\n        offset: isSpan(context, lastChild) ? lastChild.text.length : 0,\n      },\n    },\n  }).at(0)\n\n  if (!before || !after) {\n    return undefined\n  }\n\n  if (!isTextBlock(context, before) || !isTextBlock(context, after)) {\n    return undefined\n  }\n\n  return {before, after}\n}\n"],"names":["isSpan","context","child","_type","schema","span","name","isTextBlock","block","mergeTextBlocks","targetBlock","incomingBlock","parsedIncomingBlock","parseBlock","options","refreshKeys","children","markDefs","splitTextBlock","point","firstChild","at","lastChild","length","before","sliceBlocks","blocks","selection","anchor","path","_key","offset","focus","after","text"],"mappings":";;;;;AAMgBA,SAAAA,OACdC,SACAC,OAC2B;AAC3B,SAAOA,MAAMC,UAAUF,QAAQG,OAAOC,KAAKC;AAC7C;ACLgBC,SAAAA,YACdN,SACAO,OACgC;AAChC,SAAOA,MAAML,UAAUF,QAAQG,OAAOI,MAAMF;AAC9C;ACHO,SAASG,gBAAgB;AAAA,EAC9BR;AAAAA,EACAS;AAAAA,EACAC;AAKF,GAAG;AACD,QAAMC,sBAAsBC,WAAW;AAAA,IACrCZ;AAAAA,IACAO,OAAOG;AAAAA,IACPG,SAAS;AAAA,MAACC,aAAa;AAAA,IAAA;AAAA,EAAI,CAC5B;AAED,SAAI,CAACH,uBAAuB,CAACL,YAAYN,SAASW,mBAAmB,IAC5DF,cAGF;AAAA,IACL,GAAGA;AAAAA,IACHM,UAAU,CAAC,GAAGN,YAAYM,UAAU,GAAGJ,oBAAoBI,QAAQ;AAAA,IACnEC,UAAU,CACR,GAAIP,YAAYO,YAAY,CAAA,GAC5B,GAAIL,oBAAoBK,YAAY,CAAG,CAAA;AAAA,EAE3C;AACF;AC3BO,SAASC,eAAe;AAAA,EAC7BjB;AAAAA,EACAO;AAAAA,EACAW;AAKF,GAA8E;AAC5E,QAAMC,aAAaZ,MAAMQ,SAASK,GAAG,CAAC,GAChCC,YAAYd,MAAMQ,SAASK,GAAGb,MAAMQ,SAASO,SAAS,CAAC;AAEzD,MAAA,CAACH,cAAc,CAACE;AAClB;AAGF,QAAME,SAASC,YAAY;AAAA,IACzBC,QAAQ,CAAClB,KAAK;AAAA,IACdmB,WAAW;AAAA,MACTC,QAAQ;AAAA,QACNC,MAAM,CAAC;AAAA,UAACC,MAAMtB,MAAMsB;AAAAA,WAAO,YAAY;AAAA,UAACA,MAAMV,WAAWU;AAAAA,QAAAA,CAAK;AAAA,QAC9DC,QAAQ;AAAA,MACV;AAAA,MACAC,OAAOb;AAAAA,IAAAA;AAAAA,EAEV,CAAA,EAAEE,GAAG,CAAC,GACDY,QAAQR,YAAY;AAAA,IACxBC,QAAQ,CAAClB,KAAK;AAAA,IACdmB,WAAW;AAAA,MACTC,QAAQT;AAAAA,MACRa,OAAO;AAAA,QACLH,MAAM,CAAC;AAAA,UAACC,MAAMtB,MAAMsB;AAAAA,WAAO,YAAY;AAAA,UAACA,MAAMR,UAAUQ;AAAAA,QAAAA,CAAK;AAAA,QAC7DC,QAAQ/B,OAAOC,SAASqB,SAAS,IAAIA,UAAUY,KAAKX,SAAS;AAAA,MAAA;AAAA,IAC/D;AAAA,EACF,CACD,EAAEF,GAAG,CAAC;AAEP,MAAI,EAACG,CAAAA,UAAU,CAACS,UAIZ,EAAC1B,CAAAA,YAAYN,SAASuB,MAAM,KAAK,CAACjB,YAAYN,SAASgC,KAAK;AAIzD,WAAA;AAAA,MAACT;AAAAA,MAAQS;AAAAA,IAAK;AACvB;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "1.28.0",
+  "version": "1.30.0",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",
@@ -34,7 +34,7 @@
       "default": "./lib/index.js"
     },
     "./behaviors": {
-      "source": "./src/behaviors/index.ts",
+      "source": "./src/behaviors/_exports/index.ts",
       "import": "./lib/behaviors/index.js",
       "require": "./lib/behaviors/index.cjs",
       "default": "./lib/behaviors/index.js"

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

@@ -0,0 +1,18 @@
+import {deleteFragment, select} from 'slate'
+import {toSlateRange} from '../internal-utils/ranges'
+import type {BehaviorActionImplementation} from './behavior.actions'
+
+export const deleteActionImplementation: BehaviorActionImplementation<
+  'delete'
+> = ({action}) => {
+  const range = toSlateRange(action.selection, action.editor)
+
+  if (!range) {
+    throw new Error(
+      `Failed to get Slate Range for selection ${JSON.stringify(action.selection)}`,
+    )
+  }
+
+  select(action.editor, range)
+  deleteFragment(action.editor)
+}

package/src/behavior-actions/behavior.action.insert-break.ts

@@ -1,5 +1,5 @@
 import {isEqual} from 'lodash'
-import {Editor, Node, Path, Transforms} from 'slate'
+import {Editor, insertText, Node, Path, Transforms} from 'slate'
 import type {SlateTextBlock, VoidElement} from '../types/slate'
 import type {BehaviorActionImplementation} from './behavior.actions'
 
@@ -146,11 +146,6 @@ export const insertBreakActionImplementation: BehaviorActionImplementation<
 
 export const insertSoftBreakActionImplementation: BehaviorActionImplementation<
   'insert.soft break'
-> = ({context, action}) => {
-  // This mimics Slate's internal which also just does a regular insert break
-  // when soft-breaking
-  insertBreakActionImplementation({
-    context,
-    action: {...action, type: 'insert.break'},
-  })
+> = ({action}) => {
+  insertText(action.editor, '\n')
 }

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

@@ -31,6 +31,7 @@ import {insertBlock} from './behavior.action-utils.insert-block'
 import {blockSetBehaviorActionImplementation} from './behavior.action.block.set'
 import {blockUnsetBehaviorActionImplementation} from './behavior.action.block.unset'
 import {dataTransferSetActionImplementation} from './behavior.action.data-transfer-set'
+import {deleteActionImplementation} from './behavior.action.delete'
 import {insertBlockObjectActionImplementation} from './behavior.action.insert-block-object'
 import {insertBlocksActionImplementation} from './behavior.action.insert-blocks'
 import {
@@ -89,6 +90,7 @@ const behaviorActionImplementations: BehaviorActionImplementations = {
   'focus': ({action}) => {
     ReactEditor.focus(action.editor)
   },
+  'delete': deleteActionImplementation,
   'delete.backward': ({action}) => {
     deleteBackward(action.editor, action.unit)
   },
@@ -412,6 +414,13 @@ function performDefaultAction({
       })
       break
     }
+    case 'delete': {
+      behaviorActionImplementations.delete({
+        context,
+        action,
+      })
+      break
+    }
     case 'delete.backward': {
       behaviorActionImplementations['delete.backward']({
         context,

package/src/behaviors/_exports/index.ts

@@ -0,0 +1 @@
+export * from '../index'