@portabletext/editor 3.3.3 → 3.3.4

package/src/internal-utils/values.test.ts

@@ -1,282 +0,0 @@
-import {compileSchema, defineSchema} from '@portabletext/schema'
-import {createTestKeyGenerator} from '@portabletext/test'
-import {describe, expect, test} from 'vitest'
-import {toSlateBlock, VOID_CHILD_KEY} from './values'
-
-describe(toSlateBlock.name, () => {
-  describe('text block', () => {
-    describe('with span', () => {
-      test('with _type', () => {
-        const keyGenerator = createTestKeyGenerator()
-        const blockKey = keyGenerator()
-        const spanKey = keyGenerator()
-
-        expect(
-          toSlateBlock(
-            {
-              _type: 'block',
-              _key: blockKey,
-              children: [{_key: spanKey, _type: 'span', text: 'foo'}],
-            },
-            {
-              schemaTypes: compileSchema(defineSchema({})),
-            },
-          ),
-        ).toEqual({
-          _type: 'block',
-          _key: blockKey,
-          children: [
-            {
-              _key: spanKey,
-              _type: 'span',
-              text: 'foo',
-            },
-          ],
-        })
-      })
-
-      test('without _type', () => {
-        const keyGenerator = createTestKeyGenerator()
-        const blockKey = keyGenerator()
-        const spanKey = keyGenerator()
-
-        expect(
-          toSlateBlock(
-            {
-              _type: 'block',
-              _key: blockKey,
-              children: [{_key: spanKey, text: 'foo'}],
-            },
-            {
-              schemaTypes: compileSchema(defineSchema({})),
-            },
-          ),
-        ).toEqual({
-          _type: 'block',
-          _key: blockKey,
-          children: [
-            {
-              _key: spanKey,
-              _type: 'span',
-              text: 'foo',
-            },
-          ],
-        })
-      })
-
-      test('wrong _type', () => {
-        const keyGenerator = createTestKeyGenerator()
-        const blockKey = keyGenerator()
-        const spanKey = keyGenerator()
-
-        expect(
-          toSlateBlock(
-            {
-              _type: 'block',
-              _key: blockKey,
-              children: [{_key: spanKey, _type: 'stock-ticker', text: 'foo'}],
-            },
-            {
-              schemaTypes: compileSchema(defineSchema({})),
-            },
-          ),
-        ).toEqual({
-          _type: 'block',
-          _key: blockKey,
-          children: [
-            {
-              _key: spanKey,
-              _type: 'stock-ticker',
-              children: [
-                {
-                  _key: VOID_CHILD_KEY,
-                  _type: 'span',
-                  text: '',
-                  marks: [],
-                },
-              ],
-              value: {text: 'foo'},
-              __inline: true,
-            },
-          ],
-        })
-      })
-    })
-
-    describe('with inline object', () => {
-      test('known inline object _type', () => {
-        const keyGenerator = createTestKeyGenerator()
-        const blockKey = keyGenerator()
-        const stockTickerKey = keyGenerator()
-
-        expect(
-          toSlateBlock(
-            {
-              _type: 'block',
-              _key: blockKey,
-              children: [
-                {_type: 'stock-ticker', _key: stockTickerKey, symbol: 'AAPL'},
-              ],
-            },
-            {
-              schemaTypes: compileSchema(
-                defineSchema({inlineObjects: [{name: 'stock-ticker'}]}),
-              ),
-            },
-          ),
-        ).toEqual({
-          _type: 'block',
-          _key: blockKey,
-          children: [
-            {
-              __inline: true,
-              _key: stockTickerKey,
-              _type: 'stock-ticker',
-              children: [
-                {
-                  _key: VOID_CHILD_KEY,
-                  _type: 'span',
-                  text: '',
-                  marks: [],
-                },
-              ],
-              value: {
-                symbol: 'AAPL',
-              },
-            },
-          ],
-        })
-      })
-
-      test('unknown inline object _type', () => {
-        const keyGenerator = createTestKeyGenerator()
-        const blockKey = keyGenerator()
-        const stockTickerKey = keyGenerator()
-
-        expect(
-          toSlateBlock(
-            {
-              _type: 'block',
-              _key: blockKey,
-              children: [
-                {_type: 'stock-ticker', _key: stockTickerKey, symbol: 'AAPL'},
-              ],
-            },
-            {
-              schemaTypes: compileSchema(defineSchema({})),
-            },
-          ),
-        ).toEqual({
-          _type: 'block',
-          _key: blockKey,
-          children: [
-            {
-              __inline: true,
-              _key: stockTickerKey,
-              _type: 'stock-ticker',
-              children: [
-                {
-                  _key: VOID_CHILD_KEY,
-                  _type: 'span',
-                  text: '',
-                  marks: [],
-                },
-              ],
-              value: {
-                symbol: 'AAPL',
-              },
-            },
-          ],
-        })
-      })
-    })
-
-    describe('with inline object with text prop', () => {
-      test('known inline object _type', () => {
-        const keyGenerator = createTestKeyGenerator()
-        const blockKey = keyGenerator()
-        const stockTickerKey = keyGenerator()
-
-        expect(
-          toSlateBlock(
-            {
-              _type: 'block',
-              _key: blockKey,
-              children: [
-                {_type: 'stock-ticker', _key: stockTickerKey, text: 'foo'},
-              ],
-            },
-            {
-              schemaTypes: compileSchema(
-                defineSchema({inlineObjects: [{name: 'stock-ticker'}]}),
-              ),
-            },
-          ),
-        ).toEqual({
-          _type: 'block',
-          _key: blockKey,
-          children: [
-            {
-              __inline: true,
-              _key: stockTickerKey,
-              _type: 'stock-ticker',
-              children: [
-                {
-                  _key: VOID_CHILD_KEY,
-                  _type: 'span',
-                  text: '',
-                  marks: [],
-                },
-              ],
-              value: {
-                text: 'foo',
-              },
-            },
-          ],
-        })
-      })
-
-      test('unknown inline object _type', () => {
-        const keyGenerator = createTestKeyGenerator()
-        const blockKey = keyGenerator()
-        const stockTickerKey = keyGenerator()
-
-        expect(
-          toSlateBlock(
-            {
-              _type: 'block',
-              _key: blockKey,
-              children: [
-                {_type: 'stock-ticker', _key: stockTickerKey, text: 'foo'},
-              ],
-            },
-            {
-              schemaTypes: compileSchema(defineSchema({})),
-            },
-          ),
-        ).toEqual({
-          _type: 'block',
-          _key: blockKey,
-          children: [
-            {
-              __inline: true,
-              _key: stockTickerKey,
-              _type: 'stock-ticker',
-              children: [
-                {
-                  _key: VOID_CHILD_KEY,
-                  _type: 'span',
-                  text: '',
-                  marks: [],
-                },
-              ],
-              value: {
-                text: 'foo',
-              },
-            },
-          ],
-        })
-      })
-    })
-  })
-})

package/src/internal-utils/values.ts

@@ -1,266 +0,0 @@
-import type {
-  PortableTextBlock,
-  PortableTextChild,
-  PortableTextObject,
-  PortableTextTextBlock,
-} from '@sanity/types'
-import {isEqual} from 'lodash'
-import {Element, Text, type Descendant} from 'slate'
-import type {EditorSchema} from '../editor/editor-schema'
-
-export const EMPTY_MARKDEFS: PortableTextObject[] = []
-
-export const VOID_CHILD_KEY = 'void-child'
-
-function keepObjectEquality(
-  object: PortableTextBlock | PortableTextChild,
-  keyMap: Record<string, PortableTextBlock | PortableTextChild>,
-) {
-  const value = keyMap[object._key]
-  if (value && isEqual(object, value)) {
-    return value
-  }
-  keyMap[object._key] = object
-  return object
-}
-
-export function toSlateBlock(
-  block: PortableTextBlock,
-  {schemaTypes}: {schemaTypes: EditorSchema},
-  keyMap: Record<string, any> = {},
-): Descendant {
-  const {_type, _key, ...rest} = block
-  const isPortableText = block && block._type === schemaTypes.block.name
-
-  if (isPortableText) {
-    const textBlock = block as PortableTextTextBlock
-    let hasInlines = false
-    const hasMissingMarkDefs = typeof textBlock.markDefs === 'undefined'
-    const hasMissingChildren = typeof textBlock.children === 'undefined'
-
-    const children = (textBlock.children || []).map((child) => {
-      const {_type: childType, _key: childKey, ...childProps} = child
-      const propKeys = Object.keys(childProps)
-
-      if (childType === undefined) {
-        if (propKeys.length === 1 && propKeys.at(0) === 'text') {
-          return {
-            _key: childKey,
-            _type: schemaTypes.span.name,
-            text: childProps.text,
-          }
-        }
-      }
-
-      if (childType !== schemaTypes.span.name) {
-        // Return 'slate' version of inline object where the actual
-        // value is stored in the `value` property.
-        // In slate, inline objects are represented as regular
-        // children with actual text node in order to be able to
-        // be selected the same way as the rest of the (text) content.
-        hasInlines = true
-
-        return keepObjectEquality(
-          {
-            _type: childType,
-            _key: childKey,
-            children: [
-              {
-                _key: VOID_CHILD_KEY,
-                _type: schemaTypes.span.name,
-                text: '',
-                marks: [],
-              },
-            ],
-            value: childProps,
-            __inline: true,
-          },
-          keyMap,
-        )
-      }
-
-      // Original child object (span)
-      return child
-    })
-
-    // Return original block
-    if (
-      !hasMissingMarkDefs &&
-      !hasMissingChildren &&
-      !hasInlines &&
-      Element.isElement(block)
-    ) {
-      // Original object
-      return block
-    }
-
-    return keepObjectEquality(
-      {_type, _key, ...rest, children},
-      keyMap,
-    ) as Descendant
-  }
-
-  return keepObjectEquality(
-    {
-      _type,
-      _key,
-      children: [
-        {
-          _key: VOID_CHILD_KEY,
-          _type: 'span',
-          text: '',
-          marks: [],
-        },
-      ],
-      value: rest,
-    },
-    keyMap,
-  ) as Descendant
-}
-
-export function fromSlateBlock(
-  block: Descendant,
-  textBlockType: string,
-  keyMap: Record<string, PortableTextBlock | PortableTextChild> = {},
-) {
-  const {_key, _type} = block
-  if (!_key || !_type) {
-    throw new Error('Not a valid block')
-  }
-  if (
-    _type === textBlockType &&
-    'children' in block &&
-    Array.isArray(block.children) &&
-    _key
-  ) {
-    let hasInlines = false
-    const children = block.children.map((child) => {
-      const {_type: _cType} = child
-      if ('value' in child && _cType !== 'span') {
-        hasInlines = true
-        const {
-          value: v,
-          _key: k,
-          _type: t,
-          __inline: _i,
-          children: _c,
-          ...rest
-        } = child
-        return keepObjectEquality(
-          {...rest, ...v, _key: k as string, _type: t as string},
-          keyMap,
-        )
-      }
-      return child
-    })
-    if (!hasInlines) {
-      return block as PortableTextBlock // Original object
-    }
-    return keepObjectEquality(
-      {...block, children, _key, _type},
-      keyMap,
-    ) as PortableTextBlock
-  }
-  const blockValue = 'value' in block && block.value
-  return keepObjectEquality(
-    {_key, _type, ...(typeof blockValue === 'object' ? blockValue : {})},
-    keyMap,
-  ) as PortableTextBlock
-}
-
-export function isEqualToEmptyEditor(
-  initialValue: Array<PortableTextBlock> | undefined,
-  blocks: Array<Descendant> | Array<PortableTextBlock>,
-  schemaTypes: EditorSchema,
-): boolean {
-  if (!blocks) {
-    return false
-  }
-
-  // Must have exactly one block
-  if (blocks.length !== 1) {
-    return false
-  }
-
-  const firstBlock = blocks.at(0)
-
-  if (!firstBlock) {
-    return true
-  }
-
-  if (!Element.isElement(firstBlock)) {
-    return false
-  }
-
-  // Must be a text block
-  if (firstBlock._type !== schemaTypes.block.name) {
-    return false
-  }
-
-  // Must not be a list item
-  if ('listItem' in firstBlock) {
-    return false
-  }
-
-  // Style must exist and be the default style
-  if (
-    !('style' in firstBlock) ||
-    firstBlock.style !== schemaTypes.styles.at(0)?.name
-  ) {
-    return false
-  }
-
-  // Must have children array
-  if (!Array.isArray(firstBlock.children)) {
-    return false
-  }
-
-  // Must have exactly one child
-  if (firstBlock.children.length !== 1) {
-    return false
-  }
-
-  const firstChild = firstBlock.children.at(0)
-
-  if (!firstChild) {
-    return false
-  }
-
-  if (!Text.isText(firstChild)) {
-    return false
-  }
-
-  // Must be a span type
-  if (!('_type' in firstChild) || firstChild._type !== schemaTypes.span.name) {
-    return false
-  }
-
-  // Must have empty text
-  if (firstChild.text !== '') {
-    return false
-  }
-
-  // Must have no marks (marks can be undefined or empty array)
-  if (firstChild.marks?.join('')) {
-    return false
-  }
-
-  if (
-    Object.keys(firstBlock).some(
-      (key) =>
-        key !== '_type' &&
-        key !== '_key' &&
-        key !== 'children' &&
-        key !== 'markDefs' &&
-        key !== 'style',
-    )
-  ) {
-    return false
-  }
-
-  if (isEqual(initialValue, [firstBlock])) {
-    return false
-  }
-
-  return true
-}

package/src/keyboard-shortcuts/default-keyboard-shortcuts.ts

@@ -1,146 +0,0 @@
-import {
-  bold,
-  code,
-  createKeyboardShortcut,
-  italic,
-  redo,
-  underline,
-  undo,
-} from '@portabletext/keyboard-shortcuts'
-
-export const defaultKeyboardShortcuts = {
-  arrowDown: createKeyboardShortcut({
-    default: [
-      {
-        key: 'ArrowDown',
-        alt: false,
-        ctrl: false,
-        meta: false,
-        shift: false,
-      },
-    ],
-  }),
-  arrowUp: createKeyboardShortcut({
-    default: [
-      {
-        key: 'ArrowUp',
-        alt: false,
-        ctrl: false,
-        meta: false,
-        shift: false,
-      },
-    ],
-  }),
-  backspace: createKeyboardShortcut({
-    default: [
-      {
-        key: 'Backspace',
-        alt: false,
-        ctrl: false,
-        meta: false,
-        shift: false,
-      },
-    ],
-  }),
-  break: createKeyboardShortcut({
-    default: [
-      {
-        key: 'Enter',
-        shift: false,
-      },
-    ],
-  }),
-  lineBreak: createKeyboardShortcut({
-    default: [
-      {
-        key: 'Enter',
-        shift: true,
-      },
-    ],
-  }),
-  decorators: {
-    strong: bold,
-    em: italic,
-    underline: underline,
-    code: code,
-  },
-  delete: createKeyboardShortcut({
-    default: [
-      {
-        key: 'Delete',
-        alt: false,
-        ctrl: false,
-        meta: false,
-        shift: false,
-      },
-    ],
-  }),
-  deleteWord: {
-    backward: createKeyboardShortcut({
-      default: [
-        {
-          key: 'Backspace',
-          alt: false,
-          ctrl: true,
-          meta: false,
-          // shift is optional
-        },
-      ],
-      apple: [
-        {
-          key: 'Backspace',
-          alt: true,
-          ctrl: false,
-          meta: false,
-          // shift is optional
-        },
-      ],
-    }),
-    forward: createKeyboardShortcut({
-      default: [
-        {
-          key: 'Delete',
-          alt: false,
-          ctrl: true,
-          meta: false,
-          // shift is optional
-        },
-      ],
-      apple: [
-        {
-          key: 'Delete',
-          alt: true,
-          ctrl: false,
-          meta: false,
-          // shift is optional
-        },
-      ],
-    }),
-  },
-  history: {
-    undo,
-    redo,
-  },
-  tab: createKeyboardShortcut({
-    default: [
-      {
-        key: 'Tab',
-        alt: false,
-        ctrl: false,
-        meta: false,
-        shift: false,
-      },
-    ],
-  }),
-  shiftTab: createKeyboardShortcut({
-    default: [
-      {
-        key: 'Tab',
-        alt: false,
-        ctrl: false,
-        meta: false,
-        shift: true,
-      },
-    ],
-  }),
-}