@portabletext/editor 2.6.3 → 2.6.5

package/src/internal-utils/terse-pt.test.ts

@@ -1,175 +0,0 @@
-import {compileSchema, defineSchema} from '@portabletext/schema'
-import {expect, test} from 'vitest'
-import {createTestKeyGenerator} from '../internal-utils/test-key-generator'
-import {getTersePt, parseTersePt, parseTersePtString} from './terse-pt'
-
-const keyGenerator = createTestKeyGenerator()
-
-test(getTersePt.name, () => {
-  const schema = compileSchema(defineSchema({}))
-  const fooBlock = {
-    _key: 'b1',
-    _type: 'block',
-    children: [{_key: 's1', _type: 'span', text: 'foo'}],
-  }
-  const emptyBlock = {
-    _key: 'b2',
-    _type: 'block',
-    children: [{_key: 's2', _type: 'span', text: ''}],
-  }
-  const barBlock = {
-    _key: 'b3',
-    _type: 'block',
-    children: [{_key: 's3', _type: 'span', text: 'bar'}],
-  }
-  const softReturnBlock = {
-    _key: 'b4',
-    _type: 'block',
-    children: [{_key: 's4', _type: 'span', text: 'foo\nbar'}],
-  }
-
-  expect(getTersePt({schema, value: [fooBlock, barBlock]})).toEqual([
-    'foo',
-    'bar',
-  ])
-  expect(getTersePt({schema, value: [emptyBlock, barBlock]})).toEqual([
-    '',
-    'bar',
-  ])
-  expect(getTersePt({schema, value: [fooBlock, emptyBlock, barBlock]})).toEqual(
-    ['foo', '', 'bar'],
-  )
-  expect(getTersePt({schema, value: [fooBlock, softReturnBlock]})).toEqual([
-    'foo',
-    'foo\nbar',
-  ])
-
-  expect(
-    getTersePt({
-      schema,
-      value: [
-        {
-          _key: keyGenerator(),
-          _type: 'block',
-          children: [{_key: keyGenerator(), _type: 'span', text: 'foo'}],
-        },
-      ],
-    }),
-  ).toEqual(['foo'])
-  expect(
-    getTersePt({
-      schema,
-      value: [
-        {
-          _key: keyGenerator(),
-          _type: 'block',
-          children: [{_key: keyGenerator(), _type: 'span', text: 'foo'}],
-          listItem: 'number',
-        },
-      ],
-    }),
-  ).toEqual(['#:foo'])
-  expect(
-    getTersePt({
-      schema,
-      value: [
-        {
-          _key: keyGenerator(),
-          _type: 'block',
-          children: [{_key: keyGenerator(), _type: 'span', text: 'foo'}],
-          listItem: 'number',
-          style: 'h3',
-        },
-      ],
-    }),
-  ).toEqual(['#h3:foo'])
-  expect(
-    getTersePt({
-      schema,
-      value: [
-        {
-          _key: keyGenerator(),
-          _type: 'block',
-          children: [{_key: keyGenerator(), _type: 'span', text: 'foo'}],
-          level: 2,
-          listItem: 'number',
-          style: 'h3',
-        },
-      ],
-    }),
-  ).toEqual(['>>#h3:foo'])
-  expect(
-    getTersePt({
-      schema,
-      value: [
-        {
-          _key: keyGenerator(),
-          _type: 'block',
-          children: [{_key: keyGenerator(), _type: 'span', text: 'foo'}],
-          style: 'h3',
-        },
-      ],
-    }),
-  ).toEqual(['h3:foo'])
-})
-
-test(parseTersePtString.name, () => {
-  expect(parseTersePtString('foo')).toEqual(['foo'])
-  expect(parseTersePtString('foo,bar')).toEqual(['foo,bar'])
-  expect(parseTersePtString('foo,bar|baz')).toEqual(['foo,bar', 'baz'])
-  expect(parseTersePtString('|foo')).toEqual(['', 'foo'])
-  expect(parseTersePtString('foo|')).toEqual(['foo', ''])
-  expect(parseTersePtString('foo|bar\nbaz')).toEqual(['foo', 'bar\nbaz'])
-  expect(parseTersePtString('f,oo||ba,r')).toEqual(['f,oo', '', 'ba,r'])
-  expect(parseTersePtString('|')).toEqual(['', ''])
-  expect(parseTersePtString('||')).toEqual(['', '', ''])
-  expect(parseTersePtString('>>#h3:foo')).toEqual(['>>#h3:foo'])
-})
-
-test(parseTersePt.name, () => {
-  expect(
-    parseTersePt(
-      {
-        schema: compileSchema(defineSchema({})),
-        keyGenerator: createTestKeyGenerator(),
-      },
-      parseTersePtString('{image}|foo|>>#h4:bar|-:baz,fizz|,{stock-ticker},'),
-    ),
-  ).toEqual([
-    {
-      _key: 'k0',
-      _type: 'image',
-    },
-    {
-      _key: 'k1',
-      _type: 'block',
-      children: [{_key: 'k2', _type: 'span', text: 'foo'}],
-    },
-    {
-      _key: 'k3',
-      _type: 'block',
-      children: [{_key: 'k4', _type: 'span', text: 'bar'}],
-      level: 2,
-      listItem: 'number',
-      style: 'h4',
-    },
-    {
-      _key: 'k5',
-      _type: 'block',
-      children: [
-        {_key: 'k6', _type: 'span', text: 'baz'},
-        {_key: 'k7', _type: 'span', text: 'fizz'},
-      ],
-      listItem: 'bullet',
-    },
-    {
-      _key: 'k8',
-      _type: 'block',
-      children: [
-        {_key: 'k9', _type: 'span', text: ''},
-        {_key: 'k10', _type: 'stock-ticker'},
-        {_key: 'k11', _type: 'span', text: ''},
-      ],
-    },
-  ])
-})

package/src/internal-utils/terse-pt.ts

@@ -1,150 +0,0 @@
-import type {PortableTextBlock, PortableTextTextBlock} from '@sanity/types'
-import type {EditorContext} from '../editor/editor-snapshot'
-import {isSpan, isTextBlock} from './parse-blocks'
-
-type TersePtConfig = {
-  style: (name?: string) => string
-  listItem: (name?: string) => string
-  level: (level?: number) => string
-}
-
-const defaultConfig: TersePtConfig = {
-  style: (name) =>
-    name === undefined || name === 'normal'
-      ? ''
-      : name === 'blockquote'
-        ? 'q'
-        : `${name}`,
-  listItem: (name) => (name === undefined ? '' : name === 'number' ? '#' : '-'),
-  level: (level) => (level === undefined ? '' : '>'.repeat(level)),
-}
-
-export function getTersePt(
-  context: Pick<EditorContext, 'schema' | 'value'>,
-): Array<string> {
-  const blocks: Array<string> = []
-
-  for (const block of context.value) {
-    let terseBlock = ''
-
-    if (isTextBlock(context, block)) {
-      const blockPrefix = `${defaultConfig.level(block.level)}${defaultConfig.listItem(block.listItem)}${defaultConfig.style(block.style)}`
-
-      if (blockPrefix) {
-        terseBlock = `${blockPrefix}:`
-      }
-
-      let index = -1
-      for (const child of block.children) {
-        index++
-
-        if (isSpan(context, child)) {
-          terseBlock = `${terseBlock}${index > 0 ? ',' : ''}${child.text}`
-        } else {
-          terseBlock = `${terseBlock}${index > 0 ? ',' : ''}{${child._type}}`
-        }
-      }
-    } else {
-      terseBlock = `{${block._type}}`
-    }
-
-    blocks.push(terseBlock)
-  }
-
-  return blocks
-}
-
-export function parseTersePt(
-  context: Pick<EditorContext, 'keyGenerator' | 'schema'>,
-  tersePt: Array<string>,
-): Array<PortableTextBlock> {
-  const blocks: Array<PortableTextBlock> = []
-
-  for (const terseBlock of tersePt) {
-    if (terseBlock.startsWith('{')) {
-      blocks.push({
-        _type: terseBlock.slice(1, -1),
-        _key: context.keyGenerator(),
-      })
-
-      continue
-    }
-
-    const block: PortableTextTextBlock = {
-      _key: context.keyGenerator(),
-      _type: context.schema.block.name,
-      children: [],
-    }
-
-    if (terseBlock.includes(':')) {
-      const [prefix, content] = terseBlock.split(':')
-
-      const listItem = prefix.includes('#')
-        ? 'number'
-        : prefix.includes('-')
-          ? 'bullet'
-          : undefined
-
-      if (listItem !== undefined) {
-        block.listItem = listItem
-      }
-
-      const level = prefix.split('').filter((part) => part === '>').length
-
-      if (level > 0) {
-        block.level = level
-      }
-
-      const style = prefix
-        .split('')
-        .filter((part) => !['#', '-', '>'].includes(part))
-        .join('')
-
-      if (style) {
-        block.style = style
-      }
-
-      const textRuns = content.split(',')
-
-      for (const textRun of textRuns) {
-        if (textRun.startsWith('{')) {
-          block.children.push({
-            _key: context.keyGenerator(),
-            _type: textRun.slice(1, -1),
-          })
-        } else {
-          block.children.push({
-            _key: context.keyGenerator(),
-            _type: context.schema.span.name,
-            text: textRun,
-          })
-        }
-      }
-    } else {
-      const textRuns = terseBlock.split(',')
-
-      for (const textRun of textRuns) {
-        if (textRun.startsWith('{')) {
-          block.children.push({
-            _key: context.keyGenerator(),
-            _type: textRun.slice(1, -1),
-          })
-        } else {
-          block.children.push({
-            _key: context.keyGenerator(),
-            _type: context.schema.span.name,
-            text: textRun,
-          })
-        }
-      }
-    }
-
-    blocks.push(block)
-  }
-
-  return blocks
-}
-
-export function parseTersePtString(text: string) {
-  return text.split('|').map((span) => span.replace(/\\n/g, '\n'))
-}

package/src/internal-utils/test-key-generator.ts

@@ -1,9 +0,0 @@
-export function createTestKeyGenerator(prefix?: string) {
-  let index = 0
-
-  return function keyGenerator() {
-    const key = `${prefix ?? ''}k${index}`
-    index++
-    return key
-  }
-}

package/src/utils/util.is-span.ts

@@ -1,12 +0,0 @@
-import type {PortableTextChild, PortableTextSpan} from '@sanity/types'
-import type {EditorContext} from '..'
-
-/**
- * @public
- */
-export function isSpan(
-  context: Pick<EditorContext, 'schema'>,
-  child: PortableTextChild,
-): child is PortableTextSpan {
-  return child._type === context.schema.span.name
-}

package/src/utils/util.is-text-block.ts

@@ -1,13 +0,0 @@
-import type {PortableTextTextBlock} from '@sanity/types'
-import type {EditorContext} from '..'
-import {isTypedObject} from '../internal-utils/asserters'
-
-/**
- * @public
- */
-export function isTextBlock(
-  context: Pick<EditorContext, 'schema'>,
-  block: unknown,
-): block is PortableTextTextBlock {
-  return isTypedObject(block) && block._type === context.schema.block.name
-}