npm - @portabletext/editor - Versions diffs - 2.21.2 → 3.0.0 - Mend

@portabletext/editor 2.21.2 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (79) hide show

package/lib/_chunks-dts/index.d.ts +50 -210
package/lib/_chunks-es/selector.is-at-the-start-of-block.js +103 -20
package/lib/_chunks-es/selector.is-at-the-start-of-block.js.map +1 -1
package/lib/_chunks-es/{util.get-text-block-text.js → util.slice-blocks.js} +29 -5
package/lib/_chunks-es/util.slice-blocks.js.map +1 -0
package/lib/_chunks-es/util.slice-text-block.js +13 -2
package/lib/_chunks-es/util.slice-text-block.js.map +1 -1
package/lib/behaviors/index.d.ts +1 -1
package/lib/index.d.ts +2 -2
package/lib/index.js +323 -320
package/lib/index.js.map +1 -1
package/lib/plugins/index.d.ts +2 -133
package/lib/plugins/index.js +2 -796
package/lib/plugins/index.js.map +1 -1
package/lib/selectors/index.d.ts +2 -24
package/lib/selectors/index.js +28 -130
package/lib/selectors/index.js.map +1 -1
package/lib/utils/index.d.ts +3 -3
package/lib/utils/index.js +97 -9
package/lib/utils/index.js.map +1 -1
package/package.json +7 -9
package/src/behaviors/behavior.perform-event.ts +7 -7
package/src/editor/PortableTextEditor.tsx +0 -19
package/src/editor/create-editor.ts +0 -3
package/src/editor/editor-machine.ts +0 -10
package/src/editor/event-to-change.tsx +5 -1
package/src/editor/plugins/create-with-event-listeners.ts +0 -4
package/src/editor/plugins/createWithObjectKeys.ts +2 -1
package/src/editor/plugins/createWithPatches.ts +3 -3
package/src/editor/plugins/createWithPlaceholderBlock.ts +2 -1
package/src/editor/plugins/createWithPortableTextMarkModel.ts +2 -1
package/src/editor/plugins/with-plugins.ts +10 -14
package/src/editor/relay-machine.ts +0 -4
package/src/editor/sync-machine.ts +2 -2
package/src/editor.ts +0 -4
package/src/history/behavior.operation.history.redo.ts +67 -0
package/src/history/behavior.operation.history.undo.ts +71 -0
package/src/history/event.history.undo.test.tsx +672 -0
package/src/history/history.preserving-keys.test.tsx +112 -0
package/src/history/remote-patches.ts +20 -0
package/src/history/slate-plugin.history.ts +146 -0
package/src/history/slate-plugin.redoing.ts +21 -0
package/src/history/slate-plugin.undoing.ts +21 -0
package/src/history/slate-plugin.without-history.ts +23 -0
package/src/history/transform-operation.ts +245 -0
package/src/history/undo-redo-collaboration.test.tsx +541 -0
package/src/history/undo-redo.feature +125 -0
package/src/history/undo-redo.test.tsx +195 -0
package/src/history/undo-step.ts +148 -0
package/src/index.ts +0 -1
package/src/internal-utils/applyPatch.ts +46 -1
package/src/operations/behavior.operations.ts +2 -4
package/src/plugins/index.ts +0 -3
package/src/selectors/index.ts +0 -3
package/src/test/vitest/step-definitions.tsx +88 -8
package/src/test/vitest/test-editor.tsx +1 -1
package/lib/_chunks-es/selector.get-selection-text.js +0 -92
package/lib/_chunks-es/selector.get-selection-text.js.map +0 -1
package/lib/_chunks-es/selector.get-text-before.js +0 -36
package/lib/_chunks-es/selector.get-text-before.js.map +0 -1
package/lib/_chunks-es/util.get-text-block-text.js.map +0 -1
package/lib/_chunks-es/util.is-empty-text-block.js +0 -40
package/lib/_chunks-es/util.is-empty-text-block.js.map +0 -1
package/lib/_chunks-es/util.merge-text-blocks.js +0 -101
package/lib/_chunks-es/util.merge-text-blocks.js.map +0 -1
package/src/editor/plugins/createWithMaxBlocks.ts +0 -53
package/src/editor/plugins/createWithUndoRedo.ts +0 -628
package/src/editor/with-undo-step.ts +0 -37
package/src/editor/withUndoRedo.ts +0 -34
package/src/editor-event-listener.tsx +0 -28
package/src/plugins/plugin.decorator-shortcut.ts +0 -238
package/src/plugins/plugin.markdown.test.tsx +0 -42
package/src/plugins/plugin.markdown.tsx +0 -131
package/src/plugins/plugin.one-line.tsx +0 -123
package/src/selectors/selector.get-list-state.test.ts +0 -189
package/src/selectors/selector.get-list-state.ts +0 -96
package/src/selectors/selector.get-selected-slice.ts +0 -13
package/src/selectors/selector.get-trimmed-selection.test.ts +0 -657
package/src/selectors/selector.get-trimmed-selection.ts +0 -189

package/src/selectors/selector.get-trimmed-selection.test.ts DELETED Viewed

@@ -1,657 +0,0 @@
-import {compileSchema, defineSchema} from '@portabletext/schema'
-import {createTestKeyGenerator} from '@portabletext/test'
-import type {PortableTextBlock} from '@sanity/types'
-import {describe, expect, test} from 'vitest'
-import {createTestSnapshot} from '../internal-utils/create-test-snapshot'
-import type {EditorSelection} from '../types/editor'
-import {parseBlock} from '../utils/parse-blocks'
-import {getTrimmedSelection} from './selector.get-trimmed-selection'
-const keyGenerator = createTestKeyGenerator()
-function snapshot(
-  value: Array<Partial<PortableTextBlock>>,
-  selection: EditorSelection,
-) {
-  const schema = compileSchema(
-    defineSchema({
-      blockObjects: [{name: 'image'}],
-      inlineObjects: [{name: 'stock-ticker'}],
-    }),
-  )
-  return createTestSnapshot({
-    context: {
-      keyGenerator,
-      schema,
-      selection,
-      value: value.flatMap((block) => {
-        const parsedBlock = parseBlock({
-          context: {
-            keyGenerator,
-            schema,
-          },
-          block,
-          options: {
-            removeUnusedMarkDefs: true,
-            validateFields: false,
-          },
-        })
-        return parsedBlock ? [parsedBlock] : []
-      }),
-    },
-  })
-}
-function createSpan(text: string, marks: Array<string> = []) {
-  return {
-    _key: keyGenerator(),
-    _type: 'span',
-    text,
-    marks,
-  }
-}
-function createBlock(children: PortableTextBlock['children']) {
-  return {
-    _key: keyGenerator(),
-    _type: 'block',
-    children,
-  }
-}
-function createStockTicker(symbol: string) {
-  return {
-    _key: keyGenerator(),
-    _type: 'stock-ticker',
-    symbol,
-  }
-}
-function createImage(src: string) {
-  return {
-    _key: keyGenerator(),
-    _type: 'image',
-    src,
-  }
-}
-describe(getTrimmedSelection.name, () => {
-  test('Sensible defaults', () => {
-    expect(getTrimmedSelection(snapshot([], null))).toBe(null)
-    expect(
-      getTrimmedSelection(snapshot([createBlock([createSpan('foo')])], null)),
-    ).toBe(null)
-  })
-  test('does not trim spans that have selected text', () => {
-    const foo = createSpan('foo')
-    const bar = createSpan('bar', ['strong'])
-    const baz = createSpan('baz')
-    const block = createBlock([foo, bar, baz])
-    expect(
-      getTrimmedSelection(
-        snapshot([block], {
-          anchor: {
-            path: [{_key: block._key}, 'children', {_key: bar._key}],
-            offset: 0,
-          },
-          focus: {
-            path: [{_key: block._key}, 'children', {_key: bar._key}],
-            offset: 3,
-          },
-        }),
-      ),
-    ).toEqual({
-      anchor: {
-        path: [{_key: block._key}, 'children', {_key: bar._key}],
-        offset: 0,
-      },
-      focus: {
-        path: [{_key: block._key}, 'children', {_key: bar._key}],
-        offset: 3,
-      },
-    })
-    expect(
-      getTrimmedSelection(
-        snapshot([block], {
-          anchor: {
-            path: [{_key: block._key}, 'children', {_key: foo._key}],
-            offset: 2,
-          },
-          focus: {
-            path: [{_key: block._key}, 'children', {_key: baz._key}],
-            offset: 2,
-          },
-        }),
-      ),
-    ).toEqual({
-      anchor: {
-        path: [{_key: block._key}, 'children', {_key: foo._key}],
-        offset: 2,
-      },
-      focus: {
-        path: [{_key: block._key}, 'children', {_key: baz._key}],
-        offset: 2,
-      },
-    })
-  })
-  test('trims spans that have no selected text', () => {
-    const foo = createSpan('foo')
-    const bar = createSpan('bar', ['strong'])
-    const baz = createSpan('baz')
-    const block = createBlock([foo, bar, baz])
-    expect(
-      getTrimmedSelection(
-        snapshot([block], {
-          anchor: {
-            path: [{_key: block._key}, 'children', {_key: foo._key}],
-            offset: 3,
-          },
-          focus: {
-            path: [{_key: block._key}, 'children', {_key: baz._key}],
-            offset: 0,
-          },
-        }),
-      ),
-    ).toEqual({
-      anchor: {
-        path: [{_key: block._key}, 'children', {_key: bar._key}],
-        offset: 0,
-      },
-      focus: {
-        path: [{_key: block._key}, 'children', {_key: bar._key}],
-        offset: 3,
-      },
-    })
-  })
-  test('trims inline objects at the start edge', () => {
-    const aapl = createStockTicker('AAPL')
-    const foo = createSpan('foo')
-    const block = createBlock([aapl, foo])
-    expect(
-      getTrimmedSelection(
-        snapshot([block], {
-          anchor: {
-            path: [{_key: block._key}, 'children', {_key: aapl._key}],
-            offset: 0,
-          },
-          focus: {
-            path: [{_key: block._key}, 'children', {_key: foo._key}],
-            offset: 3,
-          },
-        }),
-      ),
-    ).toEqual({
-      anchor: {
-        path: [{_key: block._key}, 'children', {_key: foo._key}],
-        offset: 0,
-      },
-      focus: {
-        path: [{_key: block._key}, 'children', {_key: foo._key}],
-        offset: 3,
-      },
-    })
-  })
-  test('trims inline objects at the end edge', () => {
-    const foo = createSpan('foo')
-    const aapl = createStockTicker('AAPL')
-    const block = createBlock([foo, aapl])
-    expect(
-      getTrimmedSelection(
-        snapshot([block], {
-          anchor: {
-            path: [{_key: block._key}, 'children', {_key: foo._key}],
-            offset: 0,
-          },
-          focus: {
-            path: [{_key: block._key}, 'children', {_key: aapl._key}],
-            offset: 0,
-          },
-        }),
-      ),
-    ).toEqual({
-      anchor: {
-        path: [{_key: block._key}, 'children', {_key: foo._key}],
-        offset: 0,
-      },
-      focus: {
-        path: [{_key: block._key}, 'children', {_key: foo._key}],
-        offset: 3,
-      },
-    })
-  })
-  test('trims empty spans', () => {
-    const empty1 = createSpan('')
-    const aapl = createStockTicker('AAPL')
-    const foo = createSpan('foo')
-    const nvda = createStockTicker('NVDA')
-    const empty2 = createSpan('')
-    const block = createBlock([empty1, aapl, foo, nvda, empty2])
-    expect(
-      getTrimmedSelection(
-        snapshot([block], {
-          anchor: {
-            path: [{_key: block._key}, 'children', {_key: empty1._key}],
-            offset: 0,
-          },
-          focus: {
-            path: [{_key: block._key}, 'children', {_key: empty2._key}],
-            offset: 0,
-          },
-        }),
-      ),
-    ).toEqual({
-      anchor: {
-        path: [{_key: block._key}, 'children', {_key: foo._key}],
-        offset: 0,
-      },
-      focus: {
-        path: [{_key: block._key}, 'children', {_key: foo._key}],
-        offset: 3,
-      },
-    })
-  })
-  test('trims off block at the start edge', () => {
-    const empty1 = createSpan('')
-    const aapl = createStockTicker('AAPL')
-    const foo = createSpan('foo')
-    const empty2 = createSpan('')
-    const nvda = createStockTicker('NVDA')
-    const bar = createSpan('bar')
-    const block1 = createBlock([foo, aapl, empty1])
-    const block2 = createBlock([empty2, nvda, bar])
-    expect(
-      getTrimmedSelection(
-        snapshot([block1, block2], {
-          anchor: {
-            path: [{_key: block1._key}, 'children', {_key: foo._key}],
-            offset: 3,
-          },
-          focus: {
-            path: [{_key: block2._key}, 'children', {_key: bar._key}],
-            offset: 3,
-          },
-        }),
-      ),
-    ).toEqual({
-      anchor: {
-        path: [{_key: block2._key}, 'children', {_key: bar._key}],
-        offset: 0,
-      },
-      focus: {
-        path: [{_key: block2._key}, 'children', {_key: bar._key}],
-        offset: 3,
-      },
-    })
-  })
-  test('trims off block at the end edge', () => {
-    const empty1 = createSpan('')
-    const aapl = createStockTicker('AAPL')
-    const foo = createSpan('foo')
-    const empty2 = createSpan('')
-    const nvda = createStockTicker('NVDA')
-    const bar = createSpan('bar')
-    const block1 = createBlock([foo, aapl, empty1])
-    const block2 = createBlock([empty2, nvda, bar])
-    expect(
-      getTrimmedSelection(
-        snapshot([block1, block2], {
-          anchor: {
-            path: [{_key: block1._key}, 'children', {_key: foo._key}],
-            offset: 0,
-          },
-          focus: {
-            path: [{_key: block2._key}, 'children', {_key: bar._key}],
-            offset: 0,
-          },
-        }),
-      ),
-    ).toEqual({
-      anchor: {
-        path: [{_key: block1._key}, 'children', {_key: foo._key}],
-        offset: 0,
-      },
-      focus: {
-        path: [{_key: block1._key}, 'children', {_key: foo._key}],
-        offset: 3,
-      },
-    })
-  })
-  test('ignores empty text block on start edge', () => {
-    const empty = createSpan('')
-    const block1 = createBlock([empty])
-    const foo = createSpan('foo')
-    const block2 = createBlock([foo])
-    expect(
-      getTrimmedSelection(
-        snapshot([block1, block2], {
-          anchor: {
-            path: [{_key: block1._key}, 'children', {_key: empty._key}],
-            offset: 0,
-          },
-          focus: {
-            path: [{_key: block2._key}, 'children', {_key: foo._key}],
-            offset: 3,
-          },
-        }),
-      ),
-    ).toEqual({
-      anchor: {
-        path: [{_key: block1._key}, 'children', {_key: empty._key}],
-        offset: 0,
-      },
-      focus: {
-        path: [{_key: block2._key}, 'children', {_key: foo._key}],
-        offset: 3,
-      },
-    })
-  })
-  test('ignores empty text block on end edge', () => {
-    const foo = createSpan('foo')
-    const block1 = createBlock([foo])
-    const empty = createSpan('')
-    const block2 = createBlock([empty])
-    expect(
-      getTrimmedSelection(
-        snapshot([block1, block2], {
-          anchor: {
-            path: [{_key: block1._key}, 'children', {_key: foo._key}],
-            offset: 0,
-          },
-          focus: {
-            path: [{_key: block2._key}, 'children', {_key: empty._key}],
-            offset: 0,
-          },
-        }),
-      ),
-    ).toEqual({
-      anchor: {
-        path: [{_key: block1._key}, 'children', {_key: foo._key}],
-        offset: 0,
-      },
-      focus: {
-        path: [{_key: block2._key}, 'children', {_key: empty._key}],
-        offset: 0,
-      },
-    })
-  })
-  test('ignores block object on start edge', () => {
-    const image1 = createImage('image1')
-    const empty1 = createSpan('')
-    const aapl = createStockTicker('AAPL')
-    const foo = createSpan('foo')
-    const nvda = createStockTicker('NVDA')
-    const empty2 = createSpan('')
-    const block = createBlock([empty1, aapl, foo, nvda, empty2])
-    const image2 = createImage('image2')
-    expect(
-      getTrimmedSelection(
-        snapshot([image1, block, image2], {
-          anchor: {
-            path: [{_key: image1._key}],
-            offset: 0,
-          },
-          focus: {
-            path: [{_key: block._key}, 'children', {_key: empty2._key}],
-            offset: 0,
-          },
-        }),
-      ),
-    ).toEqual({
-      anchor: {
-        path: [{_key: image1._key}],
-        offset: 0,
-      },
-      focus: {
-        path: [{_key: block._key}, 'children', {_key: foo._key}],
-        offset: 3,
-      },
-    })
-  })
-  test('ignores block object on end edge', () => {
-    const image1 = createImage('image1')
-    const empty1 = createSpan('')
-    const aapl = createStockTicker('AAPL')
-    const foo = createSpan('foo')
-    const nvda = createStockTicker('NVDA')
-    const empty2 = createSpan('')
-    const block = createBlock([empty1, aapl, foo, nvda, empty2])
-    const image2 = createImage('image2')
-    expect(
-      getTrimmedSelection(
-        snapshot([image1, block, image2], {
-          anchor: {
-            path: [{_key: block._key}, 'children', {_key: empty1._key}],
-            offset: 0,
-          },
-          focus: {
-            path: [{_key: image2._key}],
-            offset: 0,
-          },
-        }),
-      ),
-    ).toEqual({
-      anchor: {
-        path: [{_key: block._key}, 'children', {_key: foo._key}],
-        offset: 0,
-      },
-      focus: {
-        path: [{_key: image2._key}],
-        offset: 0,
-      },
-    })
-  })
-  test('ignores block objects on start and end edge', () => {
-    const image1 = createImage('image1')
-    const empty1 = createSpan('')
-    const aapl = createStockTicker('AAPL')
-    const foo = createSpan('foo')
-    const nvda = createStockTicker('NVDA')
-    const empty2 = createSpan('')
-    const block = createBlock([empty1, aapl, foo, nvda, empty2])
-    const image2 = createImage('image2')
-    expect(
-      getTrimmedSelection(
-        snapshot([image1, block, image2], {
-          anchor: {
-            path: [{_key: image1._key}],
-            offset: 0,
-          },
-          focus: {
-            path: [{_key: image2._key}],
-            offset: 0,
-          },
-        }),
-      ),
-    ).toEqual({
-      anchor: {
-        path: [{_key: image1._key}],
-        offset: 0,
-      },
-      focus: {
-        path: [{_key: image2._key}],
-        offset: 0,
-      },
-    })
-  })
-  test('edge case', () => {
-    expect(
-      getTrimmedSelection(
-        snapshot(
-          [
-            {
-              _key: 'b0',
-              _type: 'block',
-              children: [
-                {
-                  _key: 's0',
-                  _type: 'span',
-                  text: 'foo',
-                },
-                {
-                  _key: 's1',
-                  _type: 'span',
-                  text: '',
-                },
-              ],
-            },
-            {
-              _key: 'b1',
-              _type: 'block',
-              children: [
-                {
-                  _key: 's2',
-                  _type: 'span',
-                  text: '',
-                },
-                {
-                  _key: 's3',
-                  _type: 'span',
-                  text: 'bar',
-                },
-              ],
-            },
-          ],
-          {
-            anchor: {
-              path: [{_key: 'b0'}, 'children', {_key: 's0'}],
-              offset: 3,
-            },
-            focus: {
-              path: [{_key: 'b1'}, 'children', {_key: 's2'}],
-              offset: 0,
-            },
-          },
-        ),
-      ),
-    ).toEqual(null)
-  })
-  test('edge case #2', () => {
-    const foo = createSpan('foo')
-    const block1 = createBlock([foo])
-    const empty = createSpan('')
-    const block2 = createBlock([empty])
-    const bar = createSpan('bar')
-    const block3 = createBlock([bar])
-    expect(
-      getTrimmedSelection(
-        snapshot([block1, block2, block3], {
-          anchor: {
-            path: [{_key: block1._key}, 'children', {_key: foo._key}],
-            offset: 3,
-          },
-          focus: {
-            path: [{_key: block3._key}, 'children', {_key: bar._key}],
-            offset: 0,
-          },
-        }),
-      ),
-    ).toEqual({
-      anchor: {
-        path: [{_key: block2._key}, 'children', {_key: empty._key}],
-        offset: 0,
-      },
-      focus: {
-        path: [{_key: block2._key}, 'children', {_key: empty._key}],
-        offset: 0,
-      },
-    })
-  })
-  test('edge case #3', () => {
-    const foo = createSpan('foo')
-    const block1 = createBlock([foo])
-    const empty = createSpan('')
-    const block2 = createBlock([empty])
-    const bar = createSpan('bar')
-    const block3 = createBlock([bar])
-    expect(
-      getTrimmedSelection(
-        snapshot([block1, block2, block3], {
-          anchor: {
-            path: [{_key: block3._key}, 'children', {_key: bar._key}],
-            offset: 0,
-          },
-          focus: {
-            path: [{_key: block1._key}, 'children', {_key: foo._key}],
-            offset: 3,
-          },
-          backward: true,
-        }),
-      ),
-    ).toEqual({
-      anchor: {
-        path: [{_key: block2._key}, 'children', {_key: empty._key}],
-        offset: 0,
-      },
-      focus: {
-        path: [{_key: block2._key}, 'children', {_key: empty._key}],
-        offset: 0,
-      },
-      backward: true,
-    })
-  })
-  test('backwards selection', () => {
-    const foo = createSpan('foo')
-    const block1 = createBlock([foo])
-    const bar = createSpan('bar')
-    const block2 = createBlock([bar])
-    expect(
-      getTrimmedSelection(
-        snapshot([block1, block2], {
-          anchor: {
-            path: [{_key: block2._key}, 'children', {_key: bar._key}],
-            offset: 3,
-          },
-          focus: {
-            path: [{_key: block1._key}, 'children', {_key: foo._key}],
-            offset: 3,
-          },
-          backward: true,
-        }),
-      ),
-    ).toEqual({
-      anchor: {
-        path: [{_key: block2._key}, 'children', {_key: bar._key}],
-        offset: 3,
-      },
-      focus: {
-        path: [{_key: block2._key}, 'children', {_key: bar._key}],
-        offset: 0,
-      },
-      backward: true,
-    })
-  })
-})