@portabletext/editor 1.55.16 → 1.57.0

package/README.md

@@ -372,3 +372,22 @@ In order to provide a robust and consistent end-user experience, the editor is b
 4. `cd` into the `sanity` package and run `pnpm link <relative path to the **editor** package in this repo>`
 
 Now, you should be able to run `pnpm dev:test-studio` in the `sanity` repo to test Studio with a locally running Portable Text Editor.
+
+## Other Libraries
+
+This monorepo also contains additional libraries that can be used with the Portable Text Editor:
+
+### `@portabletext/keyboard-shortcuts`
+
+> A TypeScript library for creating platform-aware keyboard shortcuts with automatic detection of Apple vs non-Apple platforms.
+
+- 💻 [./packages/keyboard-shortcuts](./packages/keyboard-shortcuts/)
+- 📦 [@portabletext/keyboard-shortcuts](https://www.npmjs.com/package/@portabletext/keyboard-shortcuts)
+
+### `@portabletext/toolbar`
+
+> Powered by [Behaviors](https://www.portabletext.org/concepts/behavior/) and [State Machines](https://stately.ai/docs/xstate), `@portabletext/toolbar` is a collection of robust React hooks for building toolbars and related UI components
+> for the Portable Text editor.
+
+- 💻 [./packages/toolbar](./packages/toolbar/)
+- 📦 [@portabletext/toolbar](https://www.npmjs.com/package/@portabletext/toolbar)

package/lib/behaviors/index.d.cts

@@ -653,8 +653,7 @@ declare type ExtractNamespace<TType extends string> =
 /**
  * @public
  */
-declare type FieldDefinition = {
-  name: string
+declare type FieldDefinition = BaseDefinition & {
   type: 'string' | 'number' | 'boolean' | 'array' | 'object'
 }
 

package/lib/behaviors/index.d.ts

@@ -653,8 +653,7 @@ declare type ExtractNamespace<TType extends string> =
 /**
  * @public
  */
-declare type FieldDefinition = {
-  name: string
+declare type FieldDefinition = BaseDefinition & {
   type: 'string' | 'number' | 'boolean' | 'array' | 'object'
 }
 

package/lib/index.cjs

@@ -3524,7 +3524,11 @@ function insertBlock({
         }), select === "start" ? slate.Transforms.select(editor, selectionStartPoint) : select === "end" ? slate.Transforms.select(editor, slate.Editor.end(editor, endBlockPath)) : slate.Transforms.select(editor, currentSelection2);
         return;
       }
-      if (select === "end") {
+      if (slate.Transforms.setNodes(editor, {
+        markDefs: [...endBlock.markDefs ?? [], ...block.markDefs ?? []]
+      }, {
+        at: endBlockPath
+      }), select === "end") {
         slate.Transforms.insertFragment(editor, [block], {
           voids: !0
         });
@@ -3540,7 +3544,9 @@ function insertBlock({
         slate.Transforms.insertNodes(editor, [block], {
           at: endBlockPath,
           select: !1
-        }), (select === "start" || select === "end") && slate.Transforms.select(editor, slate.Editor.start(editor, endBlockPath)), isEqualToEmptyEditor([endBlock], schema2) && slate.Transforms.removeNodes(editor, {
+        }), (select === "start" || select === "end") && slate.Transforms.select(editor, slate.Editor.start(editor, endBlockPath)), util_isSelectionCollapsed.isEmptyTextBlock({
+          schema: schema2
+        }, endBlock) && slate.Transforms.removeNodes(editor, {
           at: slate.Path.next(endBlockPath)
         });
       else if (slate.Range.isCollapsed(currentSelection) && slate.Point.equals(selectionEndPoint, endBlockEndPoint2)) {
@@ -6247,6 +6253,63 @@ const coreDndBehaviors = [
     },
     at: focusTextBlock.path
   })]]
+}), mergeTextIntoListOnDelete = behaviors_index.defineBehavior({
+  on: "delete.forward",
+  guard: ({
+    snapshot
+  }) => {
+    const focusListBlock = selector_isSelectingEntireBlocks.getFocusListBlock(snapshot), nextBlock = selector_isSelectingEntireBlocks.getNextBlock(snapshot);
+    return !focusListBlock || !nextBlock || !util_sliceBlocks.isTextBlock(snapshot.context, nextBlock.node) || !util_isSelectionCollapsed.isEmptyTextBlock(snapshot.context, focusListBlock.node) ? !1 : {
+      focusListBlock,
+      nextBlock
+    };
+  },
+  actions: [(_, {
+    nextBlock
+  }) => [behaviors_index.raise({
+    type: "insert.block",
+    block: nextBlock.node,
+    placement: "auto",
+    select: "start"
+  }), behaviors_index.raise({
+    type: "delete.block",
+    at: nextBlock.path
+  })]]
+}), mergeTextIntoListOnBackspace = behaviors_index.defineBehavior({
+  on: "delete.backward",
+  guard: ({
+    snapshot
+  }) => {
+    const focusTextBlock = selector_getFocusSpan.getFocusTextBlock(snapshot), previousBlock = selector_isSelectingEntireBlocks.getPreviousBlock(snapshot);
+    if (!focusTextBlock || !previousBlock || !util_sliceBlocks.isListBlock(snapshot.context, previousBlock.node) || !util_isSelectionCollapsed.isEmptyTextBlock(snapshot.context, previousBlock.node))
+      return !1;
+    const previousBlockEndPoint = util_isSelectionCollapsed.getBlockEndPoint({
+      context: snapshot.context,
+      block: previousBlock
+    });
+    return {
+      focusTextBlock,
+      previousBlockEndPoint
+    };
+  },
+  actions: [(_, {
+    focusTextBlock,
+    previousBlockEndPoint
+  }) => [behaviors_index.raise({
+    type: "select",
+    at: {
+      anchor: previousBlockEndPoint,
+      focus: previousBlockEndPoint
+    }
+  }), behaviors_index.raise({
+    type: "insert.block",
+    block: focusTextBlock.node,
+    placement: "auto",
+    select: "start"
+  }), behaviors_index.raise({
+    type: "delete.block",
+    at: focusTextBlock.path
+  })]]
 }), clearListOnEnter = behaviors_index.defineBehavior({
   on: "insert.break",
   guard: ({
@@ -6314,13 +6377,110 @@ const coreDndBehaviors = [
     },
     at: selectedListBlock.path
   }))]
+}), inheritListLevel = behaviors_index.defineBehavior({
+  on: "insert.blocks",
+  guard: ({
+    snapshot,
+    event
+  }) => {
+    const focusListBlock = selector_isSelectingEntireBlocks.getFocusListBlock(snapshot);
+    if (!focusListBlock)
+      return !1;
+    const firstInsertedBlock = event.blocks.at(0), secondInsertedBlock = event.blocks.at(1), insertedListBlock = util_sliceBlocks.isListBlock(snapshot.context, firstInsertedBlock) ? firstInsertedBlock : util_sliceBlocks.isListBlock(snapshot.context, secondInsertedBlock) ? secondInsertedBlock : void 0;
+    if (!insertedListBlock)
+      return !1;
+    const levelDifference = focusListBlock.node.level - insertedListBlock.level;
+    return levelDifference === 0 ? !1 : {
+      levelDifference,
+      insertedListBlock
+    };
+  },
+  actions: [({
+    snapshot,
+    event
+  }, {
+    levelDifference,
+    insertedListBlock
+  }) => {
+    let adjustLevel = !0, listStartBlockFound = !1;
+    return [behaviors_index.raise({
+      ...event,
+      blocks: event.blocks.map((block) => (block._key === insertedListBlock._key && (listStartBlockFound = !0), adjustLevel ? listStartBlockFound && adjustLevel && util_sliceBlocks.isListBlock(snapshot.context, block) ? {
+        ...block,
+        level: Math.min(MAX_LIST_LEVEL, Math.max(1, block.level + levelDifference))
+      } : (listStartBlockFound && (adjustLevel = !1), block) : block))
+    })];
+  }]
+}), inheritListItem = behaviors_index.defineBehavior({
+  on: "insert.blocks",
+  guard: ({
+    snapshot,
+    event
+  }) => {
+    const focusListBlock = selector_isSelectingEntireBlocks.getFocusListBlock(snapshot);
+    if (!focusListBlock || util_isSelectionCollapsed.isEmptyTextBlock(snapshot.context, focusListBlock.node))
+      return !1;
+    const firstInsertedBlock = event.blocks.at(0), secondInsertedBlock = event.blocks.at(1), insertedListBlock = util_sliceBlocks.isListBlock(snapshot.context, firstInsertedBlock) ? firstInsertedBlock : util_sliceBlocks.isListBlock(snapshot.context, secondInsertedBlock) ? secondInsertedBlock : void 0;
+    return !insertedListBlock || focusListBlock.node.level !== insertedListBlock.level || focusListBlock.node.listItem === insertedListBlock.listItem ? !1 : {
+      listItem: focusListBlock.node.listItem,
+      insertedListBlock
+    };
+  },
+  actions: [({
+    snapshot,
+    event
+  }, {
+    listItem,
+    insertedListBlock
+  }) => {
+    let adjustListItem = !0, listStartBlockFound = !1;
+    return [behaviors_index.raise({
+      ...event,
+      blocks: event.blocks.map((block) => (block._key === insertedListBlock._key && (listStartBlockFound = !0), adjustListItem ? listStartBlockFound && adjustListItem && util_sliceBlocks.isListBlock(snapshot.context, block) ? {
+        ...block,
+        listItem: block.level === insertedListBlock.level ? listItem : block.listItem
+      } : (listStartBlockFound && (adjustListItem = !1), block) : block))
+    })];
+  }]
+}), inheritListProperties = behaviors_index.defineBehavior({
+  on: "insert.block",
+  guard: ({
+    snapshot,
+    event
+  }) => {
+    if (event.placement !== "auto" || event.block._type !== snapshot.context.schema.block.name || event.block.listItem !== void 0)
+      return !1;
+    const focusListBlock = selector_isSelectingEntireBlocks.getFocusListBlock(snapshot);
+    return !focusListBlock || !util_isSelectionCollapsed.isEmptyTextBlock(snapshot.context, focusListBlock.node) ? !1 : {
+      level: focusListBlock.node.level,
+      listItem: focusListBlock.node.listItem
+    };
+  },
+  actions: [({
+    event
+  }, {
+    level,
+    listItem
+  }) => [behaviors_index.raise({
+    ...event,
+    block: {
+      ...event.block,
+      level,
+      listItem
+    }
+  })]]
 }), coreListBehaviors = {
   clearListOnBackspace,
   unindentListOnBackspace,
+  mergeTextIntoListOnDelete,
+  mergeTextIntoListOnBackspace,
   clearListOnEnter,
   indentListOnTab,
-  unindentListOnShiftTab
-}, coreBehaviorsConfig = [coreAnnotationBehaviors.addAnnotationOnCollapsedSelection, coreDecoratorBehaviors.strongShortcut, coreDecoratorBehaviors.emShortcut, coreDecoratorBehaviors.underlineShortcut, coreDecoratorBehaviors.codeShortcut, ...coreDndBehaviors, coreBlockObjectBehaviors.clickingAboveLonelyBlockObject, coreBlockObjectBehaviors.clickingBelowLonelyBlockObject, coreBlockObjectBehaviors.arrowDownOnLonelyBlockObject, coreBlockObjectBehaviors.arrowUpOnLonelyBlockObject, coreBlockObjectBehaviors.breakingBlockObject, coreBlockObjectBehaviors.deletingEmptyTextBlockAfterBlockObject, coreBlockObjectBehaviors.deletingEmptyTextBlockBeforeBlockObject, coreListBehaviors.clearListOnBackspace, coreListBehaviors.unindentListOnBackspace, coreListBehaviors.clearListOnEnter, coreListBehaviors.indentListOnTab, coreListBehaviors.unindentListOnShiftTab, coreInsertBreakBehaviors.breakingAtTheEndOfTextBlock, coreInsertBreakBehaviors.breakingAtTheStartOfTextBlock, coreInsertBreakBehaviors.breakingEntireDocument, coreInsertBreakBehaviors.breakingEntireBlocks, coreInsertBreakBehaviors.breakingInlineObject].map((behavior) => ({
+  unindentListOnShiftTab,
+  inheritListLevel,
+  inheritListItem,
+  inheritListProperties
+}, coreBehaviorsConfig = [coreAnnotationBehaviors.addAnnotationOnCollapsedSelection, coreDecoratorBehaviors.strongShortcut, coreDecoratorBehaviors.emShortcut, coreDecoratorBehaviors.underlineShortcut, coreDecoratorBehaviors.codeShortcut, ...coreDndBehaviors, coreBlockObjectBehaviors.clickingAboveLonelyBlockObject, coreBlockObjectBehaviors.clickingBelowLonelyBlockObject, coreBlockObjectBehaviors.arrowDownOnLonelyBlockObject, coreBlockObjectBehaviors.arrowUpOnLonelyBlockObject, coreBlockObjectBehaviors.breakingBlockObject, coreBlockObjectBehaviors.deletingEmptyTextBlockAfterBlockObject, coreBlockObjectBehaviors.deletingEmptyTextBlockBeforeBlockObject, coreListBehaviors.clearListOnBackspace, coreListBehaviors.unindentListOnBackspace, coreListBehaviors.mergeTextIntoListOnDelete, coreListBehaviors.mergeTextIntoListOnBackspace, coreListBehaviors.clearListOnEnter, coreListBehaviors.indentListOnTab, coreListBehaviors.unindentListOnShiftTab, coreListBehaviors.inheritListLevel, coreListBehaviors.inheritListItem, coreListBehaviors.inheritListProperties, coreInsertBreakBehaviors.breakingAtTheEndOfTextBlock, coreInsertBreakBehaviors.breakingAtTheStartOfTextBlock, coreInsertBreakBehaviors.breakingEntireDocument, coreInsertBreakBehaviors.breakingEntireBlocks, coreInsertBreakBehaviors.breakingInlineObject].map((behavior) => ({
   behavior,
   priority: corePriority
 })), abstractAnnotationBehaviors = [behaviors_index.defineBehavior({
@@ -8169,7 +8329,8 @@ function legacySchemaToEditorSchema(schema2) {
       name: annotation.name,
       fields: annotation.fields.map((field) => ({
         name: field.name,
-        type: field.type.jsonType
+        type: field.type.jsonType,
+        title: field.type.title
       })),
       title: annotation.title
     })),
@@ -8180,7 +8341,8 @@ function legacySchemaToEditorSchema(schema2) {
       name: blockObject.name,
       fields: blockObject.fields.map((field) => ({
         name: field.name,
-        type: field.type.jsonType
+        type: field.type.jsonType,
+        title: field.type.title
       })),
       title: blockObject.title
     })),
@@ -8193,7 +8355,8 @@ function legacySchemaToEditorSchema(schema2) {
       name: inlineObject.name,
       fields: inlineObject.fields.map((field) => ({
         name: field.name,
-        type: field.type.jsonType
+        type: field.type.jsonType,
+        title: field.type.title
       })),
       title: inlineObject.title
     })),
@@ -8224,7 +8387,8 @@ function compileSchemaDefinitionToLegacySchema(definition) {
     ) : blockObject.title,
     fields: blockObject.fields?.map((field) => ({
       name: field.name,
-      type: field.type
+      type: field.type,
+      title: field.title ?? startCase__default.default(field.name)
     })) ?? []
   })) ?? [], inlineObjects = definition?.inlineObjects?.map((inlineObject) => types.defineType({
     type: "object",
@@ -8237,7 +8401,8 @@ function compileSchemaDefinitionToLegacySchema(definition) {
     ) : inlineObject.title,
     fields: inlineObject.fields?.map((field) => ({
       name: field.name,
-      type: field.type
+      type: field.type,
+      title: field.title ?? startCase__default.default(field.name)
     })) ?? []
   })) ?? [], portableTextSchema = types.defineField({
     type: "array",
@@ -8261,6 +8426,7 @@ function compileSchemaDefinitionToLegacySchema(definition) {
           title: annotation.title,
           fields: annotation.fields?.map((field) => ({
             name: field.name,
+            title: field.title ?? startCase__default.default(field.name),
             type: field.type
           })) ?? []
         })) ?? []