@portabletext/editor 1.1.0 → 1.1.2

package/src/utils/__tests__/valueNormalization.test.tsx

@@ -1,6 +1,7 @@
-import {describe, expect, it, jest} from '@jest/globals'
 import {render, waitFor} from '@testing-library/react'
 import {createRef, type RefObject} from 'react'
+import * as React from 'react'
+import {describe, expect, it, vi} from 'vitest'
 import {
   PortableTextEditorTester,
   schemaType,
@@ -25,7 +26,7 @@ describe('values: normalization', () => {
         markDefs: [],
       },
     ]
-    const onChange = jest.fn()
+    const onChange = vi.fn()
     render(
       <PortableTextEditorTester
         onChange={onChange}
@@ -34,6 +35,17 @@ describe('values: normalization', () => {
         value={initialValue}
       />,
     )
+
+    await waitFor(() => {
+      if (editorRef.current) {
+        expect(onChange).toHaveBeenCalledWith({
+          type: 'value',
+          value: initialValue,
+        })
+        expect(onChange).toHaveBeenCalledWith({type: 'ready'})
+      }
+    })
+
     await waitFor(() => {
       if (editorRef.current) {
         PortableTextEditor.focus(editorRef.current)

package/src/utils/__tests__/values.test.ts

@@ -1,4 +1,4 @@
-import {describe, expect, it} from '@jest/globals'
+import {describe, expect, it} from 'vitest'
 import {schemaType} from '../../editor/__tests__/PortableTextEditorTester'
 import {getPortableTextMemberSchemaTypes} from '../getPortableTextMemberSchemaTypes'
 import {fromSlateValue, toSlateValue} from '../values'
@@ -59,12 +59,12 @@ describe('toSlateValue', () => {
       {schemaTypes},
     )
     expect(result).toMatchInlineSnapshot(`
-Array [
-  Object {
+[
+  {
     "_key": "123",
     "_type": "myTestBlockType",
-    "children": Array [
-      Object {
+    "children": [
+      {
         "_key": "1231",
         "_type": "span",
         "text": "123",
@@ -76,7 +76,7 @@ Array [
 `)
   })
 
-  it('given type is block and has custom object in children', () => {
+  it('given type is block and has custom in children', () => {
     const result = toSlateValue(
       [
         {
@@ -102,30 +102,30 @@ Array [
     )
 
     expect(result).toMatchInlineSnapshot(`
-Array [
-  Object {
+[
+  {
     "_key": "123",
     "_type": "myTestBlockType",
-    "children": Array [
-      Object {
+    "children": [
+      {
         "_key": "1231",
         "_type": "span",
         "text": "123",
       },
-      Object {
+      {
         "__inline": true,
         "_key": "1232",
         "_type": "image",
-        "children": Array [
-          Object {
+        "children": [
+          {
             "_key": "void-child",
             "_type": "span",
-            "marks": Array [],
+            "marks": [],
             "text": "",
           },
         ],
-        "value": Object {
-          "asset": Object {
+        "value": {
+          "asset": {
             "_ref": "ref-123",
           },
         },
@@ -213,7 +213,7 @@ describe('fromSlateValue', () => {
     ])
   })
 
-  it('has object equality', () => {
+  it('has equality', () => {
     const keyMap = {}
     const value = [
       {

package/src/utils/applyPatch.ts

@@ -1,4 +1,3 @@
-/* eslint-disable max-statements */
 import {
   applyAll,
   type DiffMatchPatch,
@@ -16,12 +15,12 @@ import {
   makeDiff,
   parsePatch,
 } from '@sanity/diff-match-patch'
-import {
-  type KeyedSegment,
-  type Path,
-  type PathSegment,
-  type PortableTextBlock,
-  type PortableTextChild,
+import type {
+  KeyedSegment,
+  Path,
+  PathSegment,
+  PortableTextBlock,
+  PortableTextChild,
 } from '@sanity/types'
 import {
   Element,
@@ -31,9 +30,9 @@ import {
   type Node,
   type Path as SlatePath,
 } from 'slate'
-import {
-  type PortableTextMemberSchemaTypes,
-  type PortableTextSlateEditor,
+import type {
+  PortableTextMemberSchemaTypes,
+  PortableTextSlateEditor,
 } from '../types/editor'
 import {debugWithName} from './debug'
 import {toSlateValue} from './values'
@@ -50,7 +49,7 @@ export function createApplyPatch(
 ): (editor: PortableTextSlateEditor, patch: Patch) => boolean {
   let previousPatch: Patch | undefined
 
-  return function (editor: PortableTextSlateEditor, patch: Patch): boolean {
+  return (editor: PortableTextSlateEditor, patch: Patch): boolean => {
     let changed = false
 
     // Save some CPU cycles by not stringifying unless enabled
@@ -273,7 +272,6 @@ function setPatch(editor: PortableTextSlateEditor, patch: SetPatch) {
   } else if (Element.isElement(block) && patch.path.length === 1 && blockPath) {
     debug('Setting block property')
     const {children, ...nextRest} = value as unknown as PortableTextBlock
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-vars
     const {children: prevChildren, ...prevRest} = block || {children: undefined}
     // Set any block properties
     editor.apply({

package/src/utils/getPortableTextMemberSchemaTypes.ts

@@ -1,12 +1,12 @@
-import {
-  type ArraySchemaType,
-  type BlockSchemaType,
-  type ObjectSchemaType,
-  type PortableTextBlock,
-  type SchemaType,
-  type SpanSchemaType,
+import type {
+  ArraySchemaType,
+  BlockSchemaType,
+  ObjectSchemaType,
+  PortableTextBlock,
+  SchemaType,
+  SpanSchemaType,
 } from '@sanity/types'
-import {type PortableTextMemberSchemaTypes} from '../types/editor'
+import type {PortableTextMemberSchemaTypes} from '../types/editor'
 
 export function getPortableTextMemberSchemaTypes(
   portableTextType: ArraySchemaType<PortableTextBlock>,

package/src/utils/operationToPatches.ts

@@ -7,11 +7,7 @@ import {
   type InsertPosition,
   type Patch,
 } from '@portabletext/patches'
-import {
-  type Path,
-  type PortableTextSpan,
-  type PortableTextTextBlock,
-} from '@sanity/types'
+import type {Path, PortableTextSpan, PortableTextTextBlock} from '@sanity/types'
 import {get, isUndefined, omitBy} from 'lodash'
 import {
   Text,
@@ -25,10 +21,10 @@ import {
   type SetNodeOperation,
   type SplitNodeOperation,
 } from 'slate'
-import {type PatchFunctions} from '../editor/plugins/createWithPatches'
-import {
-  type PortableTextMemberSchemaTypes,
-  type PortableTextSlateEditor,
+import type {PatchFunctions} from '../editor/plugins/createWithPatches'
+import type {
+  PortableTextMemberSchemaTypes,
+  PortableTextSlateEditor,
 } from '../types/editor'
 import {debugWithName} from './debug'
 import {fromSlateValue} from './values'

package/src/utils/paths.ts

@@ -7,11 +7,11 @@ import {
   type Point,
   type Path as SlatePath,
 } from 'slate'
-import {
-  type EditorSelectionPoint,
-  type PortableTextMemberSchemaTypes,
+import type {
+  EditorSelectionPoint,
+  PortableTextMemberSchemaTypes,
 } from '../types/editor'
-import {type ObjectWithKeyAndType} from './ranges'
+import type {ObjectWithKeyAndType} from './ranges'
 
 export function createKeyedPath(
   point: Point,
@@ -30,7 +30,7 @@ export function createKeyedPath(
   if (block._type !== types.block.name) {
     return keyedBlockPath as Path
   }
-  let keyedChildPath
+  let keyedChildPath: Path | undefined
   const childPath = point.path.slice(0, 2)
   const child = Array.isArray(block.children) && block.children[childPath[1]]
   if (child) {

package/src/utils/ranges.ts

@@ -1,9 +1,8 @@
-/* eslint-disable complexity */
 import {Point, Range, type BaseRange, type Editor, type Operation} from 'slate'
-import {
-  type EditorSelection,
-  type EditorSelectionPoint,
-  type PortableTextMemberSchemaTypes,
+import type {
+  EditorSelection,
+  EditorSelectionPoint,
+  PortableTextMemberSchemaTypes,
 } from '../types/editor'
 import {createArrayedPath, createKeyedPath} from './paths'
 

package/src/utils/selection.ts

@@ -1,6 +1,6 @@
-import {type Path, type PortableTextBlock} from '@sanity/types'
+import type {Path, PortableTextBlock} from '@sanity/types'
 import {isEqual} from 'lodash'
-import {type EditorSelection, type EditorSelectionPoint} from '../types/editor'
+import type {EditorSelection, EditorSelectionPoint} from '../types/editor'
 
 export function normalizePoint(
   point: EditorSelectionPoint,

package/src/utils/ucs2Indices.ts

@@ -1,4 +1,4 @@
-import {type Patch} from '@sanity/diff-match-patch'
+import type {Patch} from '@sanity/diff-match-patch'
 
 /**
  * Takes a `patches` array as produced by diff-match-patch and adjusts the
@@ -15,7 +15,7 @@ export function adjustIndiciesToUcs2(patches: Patch[], base: string): Patch[] {
   let idx = 0 // index into the input.
 
   function advanceTo(target: number) {
-    for (; byteOffset < target; ) {
+    while (byteOffset < target) {
       const codePoint = base.codePointAt(idx)
       if (typeof codePoint === 'undefined') {
         // Reached the end of the base string - the indicies won't be correct,

package/src/utils/validateValue.ts

@@ -6,11 +6,10 @@ import {
   type PortableTextTextBlock,
 } from '@sanity/types'
 import {flatten, isPlainObject, uniq} from 'lodash'
-import {
-  type InvalidValueResolution,
-  type PortableTextMemberSchemaTypes,
+import type {
+  InvalidValueResolution,
+  PortableTextMemberSchemaTypes,
 } from '../types/editor'
-import {EMPTY_MARKDEFS} from './values'
 
 export interface Validation {
   valid: boolean
@@ -227,28 +226,7 @@ export function validateValue(
           }
           return true
         }
-        // Test that markDefs are valid if they exists
-        if (blk.markDefs && !Array.isArray(blk.markDefs)) {
-          resolution = {
-            patches: [
-              set({...textBlock, markDefs: EMPTY_MARKDEFS}, [
-                {_key: textBlock._key},
-              ]),
-            ],
-            description: `Block has invalid required property 'markDefs'.`,
-            action: 'Add empty markDefs array',
-            item: textBlock,
 
-            i18n: {
-              description:
-                'inputs.portable-text.invalid-value.missing-or-invalid-markdefs.description',
-              action:
-                'inputs.portable-text.invalid-value.missing-or-invalid-markdefs.action',
-              values: {key: textBlock._key},
-            },
-          }
-          return true
-        }
         const allUsedMarks = uniq(
           flatten(
             textBlock.children

package/src/utils/values.ts

@@ -1,13 +1,13 @@
-import {
-  type PathSegment,
-  type PortableTextBlock,
-  type PortableTextChild,
-  type PortableTextObject,
-  type PortableTextTextBlock,
+import type {
+  PathSegment,
+  PortableTextBlock,
+  PortableTextChild,
+  PortableTextObject,
+  PortableTextTextBlock,
 } from '@sanity/types'
 import {isEqual} from 'lodash'
 import {Element, Text, type Descendant, type Node} from 'slate'
-import {type PortableTextMemberSchemaTypes} from '../types/editor'
+import type {PortableTextMemberSchemaTypes} from '../types/editor'
 
 export const EMPTY_MARKDEFS: PortableTextObject[] = []
 
@@ -123,7 +123,6 @@ export function fromSlateValue(
         const {_type: _cType} = child
         if ('value' in child && _cType !== 'span') {
           hasInlines = true
-          // eslint-disable-next-line @typescript-eslint/no-unused-vars
           const {
             value: v,
             _key: k,

package/src/utils/weakMaps.ts

@@ -1,5 +1,5 @@
-import {type Editor, type Element, type Range} from 'slate'
-import {type EditorSelection} from '..'
+import type {Editor, Element, Range} from 'slate'
+import type {EditorSelection} from '..'
 
 // Is the editor currently receiving remote changes that are being applied to the content?
 export const IS_PROCESSING_REMOTE_CHANGES: WeakMap<Editor, boolean> =

package/src/utils/withChanges.ts

@@ -1,4 +1,4 @@
-import {type Editor} from 'slate'
+import type {Editor} from 'slate'
 import {
   IS_PROCESSING_LOCAL_CHANGES,
   IS_PROCESSING_REMOTE_CHANGES,

package/src/utils/withUndoRedo.ts

@@ -1,4 +1,4 @@
-import {type Editor} from 'slate'
+import type {Editor} from 'slate'
 
 const IS_UDOING: WeakMap<Editor, boolean | undefined> = new WeakMap()
 const IS_REDOING: WeakMap<Editor, boolean | undefined> = new WeakMap()

package/src/utils/withoutPatching.ts

@@ -1,4 +1,4 @@
-import {type Editor} from 'slate'
+import type {Editor} from 'slate'
 
 export const PATCHING: WeakMap<Editor, boolean | undefined> = new WeakMap()
 

package/src/editor/__tests__/utils.ts

@@ -1,45 +0,0 @@
-// This utils are inspired from https://github.dev/mwood23/slate-test-utils/blob/master/src/buildTestHarness.tsx
-import {fireEvent, type render} from '@testing-library/react'
-import {parseHotkey} from 'is-hotkey-esm'
-import {act} from 'react'
-
-export async function triggerKeyboardEvent(
-  hotkey: string,
-  element: Element,
-): Promise<void> {
-  const eventProps = parseHotkey(hotkey)
-  const values = hotkey.split('+')
-
-  fireEvent(
-    element,
-    new window.KeyboardEvent('keydown', {
-      key: values[values.length - 1],
-      code: `${eventProps.which}`,
-      keyCode: eventProps.which,
-      bubbles: true,
-      ...eventProps,
-    }),
-  )
-}
-
-export async function getEditableElement(
-  component: ReturnType<typeof render>,
-): Promise<Element> {
-  await act(async () => component)
-  const element = component.container.querySelector(
-    '[data-slate-editor="true"]',
-  )
-  if (!element) {
-    throw new Error('Could not find element')
-  }
-  /**
-   * Manually add this because JSDom doesn't implement this and Slate checks for it
-   * internally before doing stuff.
-   *
-   * https://github.com/jsdom/jsdom/issues/1670
-   */
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore
-  element.isContentEditable = true
-  return element
-}