Location type discriminators (ianstormtaylor#6000)

* implement `Location.isX` functions

* added unit tests

* changeset

* fix Path.isPath to check whole array and add regression test

Author: nabbydude

.changeset/orange-phones-wave.md

@@ -0,0 +1,8 @@
+---
+'slate': minor
+'slate-react': patch
+'slate-dom': patch
+---
+
+Added `Location.isPath`, `Location.isPoint`, `Location.isRange`, and `Location.isSpan` functions, as efficient type discriminators.
+Use these instead of `Path.isPath`, `Point.isPoint`, `Range.isRange`, and `Span.isSpan` whenever possible.

packages/slate-dom/src/plugin/with-dom.ts

@@ -1,11 +1,11 @@
 import {
   BaseEditor,
   Editor,
+  Location,
   Node,
   Operation,
   Path,
   PathRef,
-  Point,
   Range,
   Transforms,
 } from 'slate'
@@ -142,7 +142,7 @@ export const withDOM = <T extends BaseEditor>(
 
     const pendingAction = EDITOR_TO_PENDING_ACTION.get(e)
     if (pendingAction?.at) {
-      const at = Point.isPoint(pendingAction?.at)
+      const at = Location.isPoint(pendingAction?.at)
         ? transformPendingPoint(e, pendingAction.at, op)
         : transformPendingRange(e, pendingAction.at, op)
 

packages/slate-react/src/hooks/android-input-manager/android-input-manager.ts

@@ -1,5 +1,5 @@
 import { DebouncedFunc } from 'lodash'
-import { Editor, Node, Path, Point, Range, Transforms } from 'slate'
+import { Editor, Location, Node, Path, Point, Range, Transforms } from 'slate'
 import { ReactEditor } from '../../plugin/react-editor'
 import {
   applyStringDiff,
@@ -106,7 +106,7 @@ export function createAndroidInputManager({
     }
 
     if (action.at) {
-      const target = Point.isPoint(action.at)
+      const target = Location.isPoint(action.at)
         ? normalizePoint(editor, action.at)
         : normalizeRange(editor, action.at)
 

packages/slate/src/editor/above.ts

@@ -1,5 +1,5 @@
 import { Editor, EditorInterface } from '../interfaces/editor'
-import { Range } from '../interfaces'
+import { Location } from '../interfaces'
 import { Path } from '../interfaces/path'
 
 export const above: EditorInterface['above'] = (editor, options = {}) => {
@@ -18,7 +18,7 @@ export const above: EditorInterface['above'] = (editor, options = {}) => {
 
   // If `at` is a Range that spans mulitple nodes, `path` will be their common ancestor.
   // Otherwise `path` will be a text node and/or the same as `at`, in which cases we want to start with its parent.
-  if (!Range.isRange(at) || Path.equals(at.focus.path, at.anchor.path)) {
+  if (!Location.isRange(at) || Path.equals(at.focus.path, at.anchor.path)) {
     if (path.length === 0) return
     path = Path.parent(path)
   }

packages/slate/src/editor/next.ts

@@ -1,6 +1,5 @@
 import { Editor, EditorInterface } from '../interfaces/editor'
-import { Span } from '../interfaces/location'
-import { Path } from '../interfaces/path'
+import { Location, Span } from '../interfaces/location'
 
 export const next: EditorInterface['next'] = (editor, options = {}) => {
   const { mode = 'lowest', voids = false } = options
@@ -18,12 +17,12 @@ export const next: EditorInterface['next'] = (editor, options = {}) => {
 
   const span: Span = [pointAfterLocation.path, to]
 
-  if (Path.isPath(at) && at.length === 0) {
+  if (Location.isPath(at) && at.length === 0) {
     throw new Error(`Cannot get the next node from the root node!`)
   }
 
   if (match == null) {
-    if (Path.isPath(at)) {
+    if (Location.isPath(at)) {
       const [parent] = Editor.parent(editor, at)
       match = n => parent.children.includes(n)
     } else {

packages/slate/src/editor/nodes.ts

@@ -1,6 +1,6 @@
 import { Node, NodeEntry } from '../interfaces/node'
 import { Editor, EditorNodesOptions } from '../interfaces/editor'
-import { Span } from '../interfaces/location'
+import { Location } from '../interfaces/location'
 import { Path } from '../interfaces/path'
 
 export function* nodes<T extends Node>(
@@ -28,7 +28,7 @@ export function* nodes<T extends Node>(
   let from
   let to
 
-  if (Span.isSpan(at)) {
+  if (Location.isSpan(at)) {
     from = at[0]
     to = at[1]
   } else {

packages/slate/src/editor/path.ts

@@ -1,9 +1,9 @@
-import { EditorInterface, Node, Path, Point, Range } from '../interfaces'
+import { EditorInterface, Location, Node, Path, Range } from '../interfaces'
 
 export const path: EditorInterface['path'] = (editor, at, options = {}) => {
   const { depth, edge } = options
 
-  if (Path.isPath(at)) {
+  if (Location.isPath(at)) {
     if (edge === 'start') {
       const [, firstPath] = Node.first(editor, at)
       at = firstPath
@@ -13,7 +13,7 @@ export const path: EditorInterface['path'] = (editor, at, options = {}) => {
     }
   }
 
-  if (Range.isRange(at)) {
+  if (Location.isRange(at)) {
     if (edge === 'start') {
       at = Range.start(at)
     } else if (edge === 'end') {
@@ -23,7 +23,7 @@ export const path: EditorInterface['path'] = (editor, at, options = {}) => {
     }
   }
 
-  if (Point.isPoint(at)) {
+  if (Location.isPoint(at)) {
     at = at.path
   }
 

packages/slate/src/editor/point.ts

@@ -1,12 +1,12 @@
 import { EditorInterface } from '../interfaces/editor'
-import { Path } from '../interfaces/path'
 import { Node } from '../interfaces/node'
 import { Range } from '../interfaces/range'
+import { Location } from '../interfaces'
 
 export const point: EditorInterface['point'] = (editor, at, options = {}) => {
   const { edge = 'start' } = options
 
-  if (Path.isPath(at)) {
+  if (Location.isPath(at)) {
     let path
 
     if (edge === 'end') {
@@ -28,7 +28,7 @@ export const point: EditorInterface['point'] = (editor, at, options = {}) => {
     return { path, offset: edge === 'end' ? node.text.length : 0 }
   }
 
-  if (Range.isRange(at)) {
+  if (Location.isRange(at)) {
     const [start, end] = Range.edges(at)
     return edge === 'start' ? start : end
   }

packages/slate/src/editor/previous.ts

@@ -1,6 +1,5 @@
 import { Editor, EditorInterface } from '../interfaces/editor'
-import { Span } from '../interfaces/location'
-import { Path } from '../interfaces/path'
+import { Location, Span } from '../interfaces/location'
 
 export const previous: EditorInterface['previous'] = (editor, options = {}) => {
   const { mode = 'lowest', voids = false } = options
@@ -22,12 +21,12 @@ export const previous: EditorInterface['previous'] = (editor, options = {}) => {
   // the point before the location passed in
   const span: Span = [pointBeforeLocation.path, to]
 
-  if (Path.isPath(at) && at.length === 0) {
+  if (Location.isPath(at) && at.length === 0) {
     throw new Error(`Cannot get the previous node from the root node!`)
   }
 
   if (match == null) {
-    if (Path.isPath(at)) {
+    if (Location.isPath(at)) {
       const [parent] = Editor.parent(editor, at)
       match = n => parent.children.includes(n)
     } else {

packages/slate/src/editor/range.ts

@@ -1,8 +1,8 @@
+import { Location } from '../interfaces'
 import { Editor, EditorInterface } from '../interfaces/editor'
-import { Range } from '../interfaces/range'
 
 export const range: EditorInterface['range'] = (editor, at, to) => {
-  if (Range.isRange(at) && !to) {
+  if (Location.isRange(at) && !to) {
     return at
   }