feat: selections based on locations

Author: nperez0111

packages/core/src/api/blockManipulation/__snapshots__/insertContentAt.test.ts.snap

@@ -4,7 +4,6 @@ import { TableMap } from "prosemirror-tables";
 import { Block } from "../../../blocks/defaultBlocks.js";
 import { Selection } from "../../../editor/selectionTypes.js";
 import {
-  BlockIdentifier,
   BlockSchema,
   InlineContentSchema,
   StyleSchema,
@@ -16,15 +15,18 @@ import {
 } from "../../nodeConversions/nodeToBlock.js";
 import { getNodeById } from "../../nodeUtil.js";
 import { getBlockNoteSchema, getPmSchema } from "../../pmUtil.js";
+import { getBlockId, normalizeToRange } from "../../../locations/utils.js";
+import { Location } from "../../../locations/types.js";
+import { resolvePMToLocation } from "../../../locations/location.js";
 
 export function getSelection<
   BSchema extends BlockSchema,
   I extends InlineContentSchema,
   S extends StyleSchema,
 >(tr: Transaction): Selection<BSchema, I, S> | undefined {
-  const pmSchema = getPmSchema(tr);
   // Return undefined if the selection is collapsed or a node is selected.
   if (tr.selection.empty || "node" in tr.selection) {
+    // TODO do we really want this?
     return undefined;
   }
 
@@ -51,7 +53,7 @@ export function getSelection<
       );
     }
 
-    return nodeToBlock(node, pmSchema);
+    return nodeToBlock(node);
   };
 
   const blocks: Block<BSchema, I, S>[] = [];
@@ -92,7 +94,7 @@ export function getSelection<
   // [ id-2, id-3, id-4, id-6, id-7, id-8, id-9 ]
   if ($startBlockBeforePos.depth > sharedDepth) {
     // Adds the block that the selection starts in.
-    blocks.push(nodeToBlock($startBlockBeforePos.nodeAfter!, pmSchema));
+    blocks.push(nodeToBlock($startBlockBeforePos.nodeAfter!));
 
     // Traverses all depths from the depth of the block in which the selection
     // starts, up to the shared depth.
@@ -127,19 +129,25 @@ export function getSelection<
     );
   }
 
+  const location = resolvePMToLocation(tr.doc, {
+    anchor: tr.selection.anchor,
+    head: tr.selection.head,
+  });
+
   return {
+    meta: { location },
+    range: normalizeToRange(location),
     blocks,
   };
 }
 
 export function setSelection(
   tr: Transaction,
-  startBlock: BlockIdentifier,
-  endBlock: BlockIdentifier,
+  startBlock: Location,
+  endBlock: Location,
 ) {
-  const startBlockId =
-    typeof startBlock === "string" ? startBlock : startBlock.id;
-  const endBlockId = typeof endBlock === "string" ? endBlock : endBlock.id;
+  const startBlockId = getBlockId(startBlock, "start");
+  const endBlockId = getBlockId(endBlock, "end");
   const pmSchema = getPmSchema(tr);
   const schema = getBlockNoteSchema(pmSchema);
 

packages/core/src/api/blockManipulation/insertContentAt.test.ts

@@ -73,6 +73,7 @@ import { updateBlockTr } from "../api/blockManipulation/commands/updateBlock/upd
 import { getBlockInfoFromTransaction } from "../api/getBlockInfoFromPos.js";
 import { blockToNode } from "../api/nodeConversions/blockToNode.js";
 import "../style.css";
+import { Location } from "../locations/types.js";
 
 /**
  * A factory function that returns a BlockNoteExtension
@@ -1248,7 +1249,7 @@ export class BlockNoteEditor<
    * @param startBlock The identifier of the block that should be the start of the selection.
    * @param endBlock The identifier of the block that should be the end of the selection.
    */
-  public setSelection(startBlock: BlockIdentifier, endBlock: BlockIdentifier) {
+  public setSelection(startBlock: Location, endBlock: Location) {
     return this._selectionManager.setSelection(startBlock, endBlock);
   }
 
@@ -1345,9 +1346,15 @@ export class BlockNoteEditor<
    */
   public insertInlineContent(
     content: PartialInlineContent<ISchema, SSchema>,
-    { updateSelection = false }: { updateSelection?: boolean } = {},
+    {
+      updateSelection = false,
+      location,
+    }: { updateSelection?: boolean; location?: Location } = {},
   ) {
-    this._styleManager.insertInlineContent(content, { updateSelection });
+    this._styleManager.insertInlineContent(content, {
+      updateSelection,
+      location,
+    });
   }
 
   /**

packages/core/src/api/blockManipulation/selections/selection.ts

@@ -1,3 +1,4 @@
+import { isNodeSelection, posToDOMRect } from "@tiptap/core";
 import {
   getSelection,
   getSelectionCutBlocks,
@@ -7,22 +8,22 @@ import {
   getTextCursorPosition,
   setTextCursorPosition,
 } from "../../api/blockManipulation/selections/textCursorPosition.js";
-import { isNodeSelection, posToDOMRect } from "@tiptap/core";
+import {
+  DefaultBlockSchema,
+  DefaultInlineContentSchema,
+  DefaultStyleSchema,
+} from "../../blocks/defaultBlocks.js";
+import { getSelectionLocation } from "../../locations/location.js";
+import { Location } from "../../locations/types.js";
 import {
   BlockIdentifier,
   BlockSchema,
   InlineContentSchema,
   StyleSchema,
 } from "../../schema/index.js";
-import {
-  DefaultBlockSchema,
-  DefaultInlineContentSchema,
-  DefaultStyleSchema,
-} from "../../blocks/defaultBlocks.js";
-import { Selection } from "../selectionTypes.js";
-import { TextCursorPosition } from "../cursorPositionTypes.js";
 import { BlockNoteEditor } from "../BlockNoteEditor.js";
-import { getSelectionLocation } from "../../locations/location.js";
+import { TextCursorPosition } from "../cursorPositionTypes.js";
+import { Selection } from "../selectionTypes.js";
 
 export class SelectionManager<
   BSchema extends BlockSchema = DefaultBlockSchema,
@@ -61,7 +62,7 @@ export class SelectionManager<
    * @param startBlock The identifier of the block that should be the start of the selection.
    * @param endBlock The identifier of the block that should be the end of the selection.
    */
-  public setSelection(startBlock: BlockIdentifier, endBlock: BlockIdentifier) {
+  public setSelection(startBlock: Location, endBlock: Location) {
     return this.editor.transact((tr) => setSelection(tr, startBlock, endBlock));
   }
 

packages/core/src/editor/BlockNoteEditor.ts

@@ -1,18 +1,20 @@
+import { TextSelection } from "@tiptap/pm/state";
 import { insertContentAt } from "../../api/blockManipulation/insertContentAt.js";
 import { inlineContentToNodes } from "../../api/nodeConversions/blockToNode.js";
+import {
+  DefaultBlockSchema,
+  DefaultInlineContentSchema,
+  DefaultStyleSchema,
+} from "../../blocks/defaultBlocks.js";
+import { resolveLocation } from "../../locations/location.js";
+import { Location } from "../../locations/types.js";
 import {
   BlockSchema,
   InlineContentSchema,
   PartialInlineContent,
   StyleSchema,
   Styles,
 } from "../../schema/index.js";
-import {
-  DefaultBlockSchema,
-  DefaultInlineContentSchema,
-  DefaultStyleSchema,
-} from "../../blocks/defaultBlocks.js";
-import { TextSelection } from "@tiptap/pm/state";
 import { UnreachableCaseError } from "../../util/typescript.js";
 import { BlockNoteEditor } from "../BlockNoteEditor.js";
 
@@ -30,16 +32,26 @@ export class StyleManager<
    */
   public insertInlineContent(
     content: PartialInlineContent<ISchema, SSchema>,
-    { updateSelection = false }: { updateSelection?: boolean } = {},
+    {
+      updateSelection = false,
+      location,
+    }: { updateSelection?: boolean; location?: Location } = {},
   ) {
     const nodes = inlineContentToNodes(content, this.editor.pmSchema);
 
     this.editor.transact((tr) => {
+      const range = location
+        ? resolveLocation(tr.doc, location)
+        : {
+            anchor: tr.selection.from,
+            head: tr.selection.to,
+          };
+
       insertContentAt(
         tr,
         {
-          from: tr.selection.from,
-          to: tr.selection.to,
+          from: range.anchor,
+          to: range.head,
         },
         nodes,
         {

packages/core/src/editor/managers/SelectionManager.ts

@@ -1,4 +1,5 @@
 import { Block } from "../blocks/defaultBlocks.js";
+import { Point, Range } from "../locations/types.js";
 import {
   BlockSchema,
   InlineContentSchema,
@@ -10,5 +11,25 @@ export type Selection<
   I extends InlineContentSchema,
   S extends StyleSchema,
 > = {
+  /**
+   * Meta information about the current selection.
+   */
+  meta: {
+    /**
+     * The underlying location of the current selection.
+     *
+     * If the selection is a single cursor, this will be a {@link Point}.
+     * If the selection is a selection range, this will be a {@link Range}.
+     */
+    location: Point | Range;
+  };
+  /**
+   * The range of the current selection.
+   * @note This is the same as the {@link meta.location} but normalized to a {@link Range}.
+   */
+  range: Range;
+  /**
+   * The blocks that the current selection spans across.
+   */
   blocks: Block<BSchema, I, S>[];
 };