Fix and Type Tests (and some type errors I found along the way)

.changeset/friendly-kings-tickle.md

@@ -0,0 +1,5 @@
+---
+'slate': patch
+---
+
+Changed type signature of `Editor#setSelection` to allow non-Range properties of Selections (functionality unchanged)

config/typescript/tsconfig.json

@@ -11,6 +11,7 @@
     "resolveJsonModule": true,
     "sourceMap": true,
     "strict": true,
-    "target": "esnext"
+    "target": "esnext",
+    "skipLibCheck": true
   }
 }

config/typescript/tsconfig.test.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noImplicitAny": false,
+    "rootDir": "../..",
+    "jsxFactory": "jsx",
+    "noEmit": true
+  }
+}

packages/slate-history/package.json

@@ -15,6 +15,8 @@
   ],
   "devDependencies": {
     "@babel/runtime": "^7.23.2",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^25.0.9",
     "lodash": "^4.17.21",
     "slate": "^0.123.0",
     "slate-hyperscript": "^0.115.0",

packages/slate-history/test/index.js → packages/slate-history/test/index.ts

@@ -1,52 +1,71 @@
 import assert from 'assert'
 import { fixtures } from '../../../support/fixtures'
-import { createHyperscript } from 'slate-hyperscript'
-import { History, withHistory } from '..'
+import {
+  createHyperscript,
+  createEditor as createEditorCreator,
+} from 'slate-hyperscript'
+import { History, HistoryEditor, withHistory } from '..'
+import { BaseEditor, Editor, createEditor as createBaseEditor } from 'slate'
 
-describe('slate-history', () => {
-  fixtures(__dirname, 'undo', ({ module }) => {
-    const { input, run, output } = module
-    const editor = withTest(withHistory(input))
-    run(editor)
-    editor.undo()
-    assert.deepEqual(editor.children, output.children)
-    assert.deepEqual(editor.selection, output.selection)
-  })
-
-  fixtures(__dirname, 'isHistory', ({ module }) => {
-    const { input, run, output } = module
-    const editor = withTest(withHistory(input))
-    run(editor)
-    const result = History.isHistory(editor.history)
-    assert.strictEqual(result, output)
-  })
-})
-
-export const jsx = createHyperscript({
-  elements: {
-    block: {},
-    inline: { inline: true },
-  },
-})
+declare module 'slate' {
+  interface CustomTypes {
+    // Editor is already defined in /support/types, but it will include this type
+    PackageSpecificEditorForTests: HistoryEditor
+  }
+}
 
-const withTest = editor => {
+const withTest = (editor: Editor) => {
   const { isInline, isVoid, isElementReadOnly, isSelectable } = editor
-
   editor.isInline = element => {
     return element.inline === true ? true : isInline(element)
   }
-
   editor.isVoid = element => {
     return element.void === true ? true : isVoid(element)
   }
-
   editor.isElementReadOnly = element => {
     return element.readOnly === true ? true : isElementReadOnly(element)
   }
-
   editor.isSelectable = element => {
     return element.nonSelectable === true ? false : isSelectable(element)
   }
-
   return editor
 }
+
+export const jsx = createHyperscript({
+  elements: {
+    block: {},
+    inline: { inline: true },
+  },
+  creators: {
+    editor: createEditorCreator(() =>
+      withTest(withHistory(createBaseEditor()))
+    ),
+  },
+})
+
+describe('slate-history', () => {
+  fixtures<{
+    input: BaseEditor
+    run: (input: Editor) => void
+    output: Pick<Editor, 'children' | 'selection'>
+  }>(__dirname, 'undo', ({ module }) => {
+    const { input, run, output } = module
+    const editor = input as Editor
+    run(editor)
+    editor.undo()
+    assert.deepEqual(editor.children, output.children)
+    assert.deepEqual(editor.selection, output.selection)
+  })
+
+  fixtures<{
+    input: BaseEditor
+    run: (input: Editor) => void
+    output: boolean
+  }>(__dirname, 'isHistory', ({ module }) => {
+    const { input, run, output } = module
+    const editor = input as Editor
+    run(editor)
+    const result = History.isHistory(editor.history)
+    assert.strictEqual(result, output)
+  })
+})

packages/slate-history/test/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "extends": "../../../config/typescript/tsconfig.test.json",
+  "include": ["./**/*", "../../../support/*"],
+  "references": [{ "path": "../" }]
+}

packages/slate-hyperscript/package.json

@@ -15,6 +15,8 @@
   ],
   "devDependencies": {
     "@babel/runtime": "^7.23.2",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^25.0.9",
     "slate": "^0.123.0",
     "source-map-loader": "^4.0.1"
   },

packages/slate-hyperscript/test/fixtures/element-custom.tsx

@@ -1,6 +1,12 @@
 /** @jsx jsx */
 import { createHyperscript } from 'slate-hyperscript'
 
+declare namespace jsx.JSX {
+  interface IntrinsicElements {
+    paragraph: {}
+  }
+}
+
 const jsx = createHyperscript({
   elements: {
     paragraph: { type: 'paragraph' },

packages/slate-hyperscript/test/index.js → packages/slate-hyperscript/test/index.ts

@@ -3,11 +3,20 @@ import { resolve } from 'path'
 import { fixtures } from '../../../support/fixtures'
 
 describe('slate-hyperscript', () => {
-  fixtures(resolve(__dirname, 'fixtures'), ({ module }) => {
+  fixtures<
+    | {
+        input: unknown[]
+        output: unknown[]
+      }
+    | {
+        input: Record<string, unknown>
+        output: Record<string, unknown>
+      }
+  >(resolve(__dirname, 'fixtures'), ({ module }) => {
     const { input, output } = module
-    let actual = {}
+    let actual: unknown[] | Record<string, unknown> = {}
 
-    if (Array.isArray(output)) {
+    if (Array.isArray(input)) {
       actual = input
     } else {
       for (const key in output) {

packages/slate-hyperscript/test/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "extends": "../../../config/typescript/tsconfig.test.json",
+  "include": ["./**/*", "../../../support/*"],
+  "references": [{ "path": "../" }]
+}

packages/slate-hyperscript/tsconfig.json

@@ -6,5 +6,5 @@
     "outDir": "./lib",
     "composite": true
   },
-  "references": []
+  "references": [{ "path": "../slate" }]
 }

packages/slate-react/test/tsconfig.json

@@ -1,7 +1,8 @@
 {
-  "extends": "../../../config/typescript/tsconfig.json",
+  "extends": "../../../config/typescript/tsconfig.test.json",
   "compilerOptions": {
-    "types": ["@testing-library/jest-dom"]
+    "jsxFactory": "React.createElement",
+    "jsxFragmentFactory": "React.Fragment"
   },
   "references": [{ "path": "../" }]
 }

packages/slate/package.json

@@ -15,6 +15,9 @@
   ],
   "devDependencies": {
     "@babel/runtime": "^7.23.2",
+    "@types/lodash": "^4.17.23",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^25.0.9",
     "lodash": "^4.17.21",
     "slate-hyperscript": "^0.115.0",
     "source-map-loader": "^4.0.1"

packages/slate/src/interfaces/transforms/selection.ts

@@ -1,4 +1,4 @@
-import { Editor, Location, Point, Range } from '../../index'
+import { Editor, Location, Point, Selection } from '../../index'
 import { MoveUnit, SelectionEdge } from '../../types/types'
 
 export interface SelectionCollapseOptions {
@@ -49,7 +49,7 @@ export interface SelectionTransforms {
   /**
    * Set new properties on the selection.
    */
-  setSelection: (editor: Editor, props: Partial<Range>) => void
+  setSelection: (editor: Editor, props: Partial<Selection>) => void
 }
 
 // eslint-disable-next-line no-redeclare

packages/slate/src/transforms-selection/set-selection.ts

@@ -1,14 +1,14 @@
 import { SelectionTransforms } from '../interfaces/transforms/selection'
-import { Range } from '../interfaces/range'
 import { Point } from '../interfaces/point'
+import { Selection } from '../interfaces'
 
 export const setSelection: SelectionTransforms['setSelection'] = (
   editor,
   props
 ) => {
   const { selection } = editor
-  const oldProps: Partial<Range> | null = {}
-  const newProps: Partial<Range> = {}
+  const oldProps: Partial<Selection> = {}
+  const newProps: Partial<Selection> = {}
 
   if (!selection) {
     return
@@ -24,10 +24,10 @@ export const setSelection: SelectionTransforms['setSelection'] = (
         !Point.equals(props.focus, selection.focus)) ||
       (k !== 'anchor' &&
         k !== 'focus' &&
-        props[<keyof Range>k] !== selection[<keyof Range>k])
+        props[k as keyof Selection] !== selection[k as keyof Selection])
     ) {
-      oldProps[<keyof Range>k] = selection[<keyof Range>k]
-      newProps[<keyof Range>k] = props[<keyof Range>k]
+      oldProps[k as keyof Selection] = selection[k as keyof Selection]
+      newProps[k as keyof Selection] = props[k as keyof Selection]
     }
   }