npm - @portabletext/editor - Versions diffs - 1.23.0 → 1.25.0 - Mend

@portabletext/editor 1.23.0 → 1.25.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 (71) hide show

package/lib/_chunks-cjs/behavior.core.cjs +249 -62
package/lib/_chunks-cjs/behavior.core.cjs.map +1 -1
package/lib/_chunks-cjs/{selector.is-selection-collapsed.cjs → selector.is-active-style.cjs} +158 -3
package/lib/_chunks-cjs/selector.is-active-style.cjs.map +1 -0
package/lib/_chunks-cjs/util.slice-blocks.cjs +23 -9
package/lib/_chunks-cjs/util.slice-blocks.cjs.map +1 -1
package/lib/_chunks-es/behavior.core.js +225 -38
package/lib/_chunks-es/behavior.core.js.map +1 -1
package/lib/_chunks-es/{selector.is-selection-collapsed.js → selector.is-active-style.js} +159 -4
package/lib/_chunks-es/selector.is-active-style.js.map +1 -0
package/lib/_chunks-es/util.slice-blocks.js +23 -9
package/lib/_chunks-es/util.slice-blocks.js.map +1 -1
package/lib/behaviors/index.cjs +27 -27
package/lib/behaviors/index.cjs.map +1 -1
package/lib/behaviors/index.d.cts +2830 -139
package/lib/behaviors/index.d.ts +2830 -139
package/lib/behaviors/index.js +1 -1
package/lib/index.cjs +695 -526
package/lib/index.cjs.map +1 -1
package/lib/index.d.cts +8950 -246
package/lib/index.d.ts +8950 -246
package/lib/index.js +696 -525
package/lib/index.js.map +1 -1
package/lib/selectors/index.cjs +24 -171
package/lib/selectors/index.cjs.map +1 -1
package/lib/selectors/index.d.cts +73 -0
package/lib/selectors/index.d.ts +73 -0
package/lib/selectors/index.js +3 -151
package/lib/selectors/index.js.map +1 -1
package/package.json +11 -10
package/src/behavior-actions/behavior.action.data-transfer-set.ts +7 -0
package/src/behavior-actions/behavior.action.insert-blocks.ts +61 -0
package/src/behavior-actions/behavior.actions.ts +159 -83
package/src/behaviors/behavior.core.annotations.ts +29 -0
package/src/behaviors/behavior.core.block-objects.ts +13 -13
package/src/behaviors/behavior.core.decorators.ts +19 -0
package/src/behaviors/behavior.core.deserialize.ts +46 -0
package/src/behaviors/behavior.core.lists.ts +57 -23
package/src/behaviors/behavior.core.serialize.ts +44 -0
package/src/behaviors/behavior.core.style.ts +19 -0
package/src/behaviors/behavior.core.ts +19 -0
package/src/behaviors/behavior.types.ts +126 -89
package/src/converters/converter.json.ts +53 -0
package/src/converters/converter.portable-text.deserialize.test.ts +686 -0
package/src/converters/converter.portable-text.ts +59 -0
package/src/converters/converter.text-html.deserialize.test.ts +349 -0
package/src/converters/converter.text-html.serialize.test.ts +233 -0
package/src/converters/converter.text-html.ts +61 -0
package/src/converters/converter.text-plain.test.ts +241 -0
package/src/converters/converter.text-plain.ts +91 -0
package/src/converters/converter.ts +65 -0
package/src/converters/converters.ts +11 -0
package/src/editor/Editable.tsx +3 -13
package/src/editor/create-editor.ts +48 -6
package/src/editor/editor-machine.ts +56 -2
package/src/editor/editor-selector.ts +1 -0
package/src/editor/editor-snapshot.ts +5 -0
package/src/editor/plugins/create-with-event-listeners.ts +82 -106
package/src/internal-utils/asserters.ts +9 -0
package/src/internal-utils/mime-type.ts +1 -0
package/src/internal-utils/parse-blocks.ts +136 -0
package/src/internal-utils/test-key-generator.ts +9 -0
package/src/selectors/selector.get-selected-spans.test.ts +1 -0
package/src/selectors/selector.get-selection-text.test.ts +1 -0
package/src/selectors/selector.is-active-decorator.test.ts +1 -0
package/src/utils/util.slice-blocks.test.ts +87 -0
package/src/utils/util.slice-blocks.ts +27 -10
package/lib/_chunks-cjs/selector.is-selection-collapsed.cjs.map +0 -1
package/lib/_chunks-es/selector.is-selection-collapsed.js.map +0 -1
package/src/editor/plugins/__tests__/createWithInsertData.test.tsx +0 -181
package/src/editor/plugins/createWithInsertData.ts +0 -425

package/src/converters/converter.portable-text.deserialize.test.ts ADDED Viewed

@@ -0,0 +1,686 @@
+import {assert, describe, expect, test} from 'vitest'
+import {
+  compileSchemaDefinition,
+  defineSchema,
+  type SchemaDefinition,
+} from '../editor/define-schema'
+import {createTestKeyGenerator} from '../internal-utils/test-key-generator'
+import {converterPortableText} from './converter.portable-text'
+import {coreConverters} from './converters'
+function createContext(schema: SchemaDefinition) {
+  return {
+    converters: coreConverters,
+    activeDecorators: [],
+    keyGenerator: createTestKeyGenerator(),
+    schema: compileSchemaDefinition(schema),
+    value: [],
+    selection: null,
+  }
+}
+describe(converterPortableText.deserialize, () => {
+  test('non-array', () => {
+    expect(
+      converterPortableText.deserialize({
+        context: createContext(defineSchema({})),
+        event: {
+          type: 'deserialize',
+          data: JSON.stringify(''),
+        },
+      }),
+    ).toMatchObject({
+      type: 'deserialization.failure',
+    })
+  })
+  test('empty array', () => {
+    expect(
+      converterPortableText.deserialize({
+        context: createContext(defineSchema({})),
+        event: {
+          type: 'deserialize',
+          data: JSON.stringify([]),
+        },
+      }),
+    ).toMatchObject({
+      data: [],
+    })
+  })
+  test('no known array entries', () => {
+    expect(
+      converterPortableText.deserialize({
+        context: createContext(defineSchema({})),
+        event: {
+          type: 'deserialize',
+          data: JSON.stringify([{foo: 'bar'}]),
+        },
+      }),
+    ).toMatchObject({
+      type: 'deserialization.failure',
+    })
+  })
+  test('some known array entries', () => {
+    expect(
+      converterPortableText.deserialize({
+        context: createContext(defineSchema({})),
+        event: {
+          type: 'deserialize',
+          data: JSON.stringify([{_type: 'block', children: []}, {foo: 'bar'}]),
+        },
+      }),
+    ).toMatchObject({
+      data: [
+        {
+          _type: 'block',
+          _key: 'k0',
+          children: [
+            {
+              _key: 'k1',
+              _type: 'span',
+              text: '',
+              marks: [],
+            },
+          ],
+          markDefs: [],
+        },
+      ],
+    })
+  })
+  test('no marks or markDefs', () => {
+    expect(
+      converterPortableText.deserialize({
+        context: createContext(defineSchema({})),
+        event: {
+          type: 'deserialize',
+          data: JSON.stringify([
+            {
+              _type: 'block',
+              children: [
+                {
+                  _type: 'span',
+                  text: 'foo',
+                },
+              ],
+            },
+          ]),
+        },
+      }),
+    ).toMatchObject({
+      data: [
+        {
+          _type: 'block',
+          children: [
+            {
+              _type: 'span',
+              text: 'foo',
+              marks: [],
+            },
+          ],
+          markDefs: [],
+        },
+      ],
+    })
+  })
+  test('unknown block object', () => {
+    expect(
+      converterPortableText.deserialize({
+        context: createContext(defineSchema({})),
+        event: {
+          type: 'deserialize',
+          data: JSON.stringify([{_type: 'foo'}]),
+        },
+      }),
+    ).toMatchObject({
+      type: 'deserialization.failure',
+    })
+  })
+  test('known block object', () => {
+    expect(
+      converterPortableText.deserialize({
+        context: createContext(
+          defineSchema({
+            blockObjects: [{name: 'image'}],
+          }),
+        ),
+        event: {
+          type: 'deserialize',
+          data: JSON.stringify([
+            {
+              _key: 'b2',
+              _type: 'image',
+              src: 'https://example.com/image.jpg',
+            },
+          ]),
+        },
+      }),
+    ).toMatchObject({
+      data: [
+        {
+          _key: 'k0',
+          _type: 'image',
+          src: 'https://example.com/image.jpg',
+        },
+      ],
+    })
+  })
+  test('unknown inline object', () => {
+    expect(
+      converterPortableText.deserialize({
+        context: createContext(defineSchema({})),
+        event: {
+          type: 'deserialize',
+          data: JSON.stringify([
+            {
+              _type: 'block',
+              children: [{_type: 'stock-ticker', symbol: 'AAPL'}],
+            },
+          ]),
+        },
+      }),
+    ).toMatchObject({
+      data: [
+        {
+          _type: 'block',
+          children: [
+            {
+              _key: 'k1',
+              _type: 'span',
+              text: '',
+              marks: [],
+            },
+          ],
+        },
+      ],
+    })
+  })
+  test('known inline object', () => {
+    expect(
+      converterPortableText.deserialize({
+        context: createContext(
+          defineSchema({
+            inlineObjects: [{name: 'stock-ticker'}],
+          }),
+        ),
+        event: {
+          type: 'deserialize',
+          data: JSON.stringify([
+            {
+              _type: 'block',
+              children: [{_type: 'stock-ticker', symbol: 'AAPL'}],
+            },
+          ]),
+        },
+      }),
+    ).toMatchObject({
+      data: [
+        {
+          _type: 'block',
+          children: [{_type: 'stock-ticker', symbol: 'AAPL'}],
+        },
+      ],
+    })
+  })
+  test('no style', () => {
+    const deserializedEvent = converterPortableText.deserialize({
+      context: createContext(defineSchema({})),
+      event: {
+        type: 'deserialize',
+        data: JSON.stringify([
+          {
+            _type: 'block',
+            children: [],
+          },
+        ]),
+      },
+    })
+    if (deserializedEvent.type !== 'deserialization.success') {
+      assert.fail()
+    }
+    expect(deserializedEvent.data).toEqual([
+      {
+        _key: 'k0',
+        _type: 'block',
+        children: [
+          {
+            _key: 'k1',
+            _type: 'span',
+            text: '',
+            marks: [],
+          },
+        ],
+        markDefs: [],
+        style: 'normal',
+      },
+    ])
+  })
+  test('default style', () => {
+    const deserializedEvent = converterPortableText.deserialize({
+      context: createContext(defineSchema({styles: [{name: 'h1'}]})),
+      event: {
+        type: 'deserialize',
+        data: JSON.stringify([
+          {
+            _type: 'block',
+            children: [],
+          },
+        ]),
+      },
+    })
+    if (deserializedEvent.type !== 'deserialization.success') {
+      assert.fail()
+    }
+    expect(deserializedEvent.data).toEqual([
+      {
+        _key: 'k0',
+        _type: 'block',
+        children: [
+          {
+            _key: 'k1',
+            _type: 'span',
+            text: '',
+            marks: [],
+          },
+        ],
+        markDefs: [],
+        style: 'normal',
+      },
+    ])
+  })
+  test('unknown style', () => {
+    const deserializedEvent = converterPortableText.deserialize({
+      context: createContext(defineSchema({})),
+      event: {
+        type: 'deserialize',
+        data: JSON.stringify([
+          {
+            _type: 'block',
+            children: [],
+            style: 'h1',
+          },
+        ]),
+      },
+    })
+    if (deserializedEvent.type !== 'deserialization.success') {
+      assert.fail()
+    }
+    expect(deserializedEvent.data).toEqual([
+      {
+        _type: 'block',
+        _key: 'k0',
+        children: [
+          {
+            _key: 'k1',
+            _type: 'span',
+            text: '',
+            marks: [],
+          },
+        ],
+        markDefs: [],
+        style: 'normal',
+      },
+    ])
+  })
+  test('known style', () => {
+    const deserializedEvent = converterPortableText.deserialize({
+      context: createContext(
+        defineSchema({
+          styles: [{name: 'h1'}],
+        }),
+      ),
+      event: {
+        type: 'deserialize',
+        data: JSON.stringify([
+          {
+            _type: 'block',
+            children: [],
+            style: 'h1',
+          },
+        ]),
+      },
+    })
+    if (deserializedEvent.type !== 'deserialization.success') {
+      assert.fail()
+    }
+    expect(deserializedEvent.data).toEqual([
+      {
+        _type: 'block',
+        _key: 'k0',
+        children: [
+          {
+            _key: 'k1',
+            _type: 'span',
+            text: '',
+            marks: [],
+          },
+        ],
+        markDefs: [],
+        style: 'h1',
+      },
+    ])
+  })
+  test('unknown listItem', () => {
+    const deserializedEvent = converterPortableText.deserialize({
+      context: createContext(defineSchema({})),
+      event: {
+        type: 'deserialize',
+        data: JSON.stringify([
+          {
+            _type: 'block',
+            children: [],
+            listItem: 'bullet',
+            level: 1,
+          },
+        ]),
+      },
+    })
+    if (deserializedEvent.type !== 'deserialization.success') {
+      assert.fail()
+    }
+    expect(deserializedEvent.data).toEqual([
+      {
+        _type: 'block',
+        _key: 'k0',
+        children: [
+          {
+            _key: 'k1',
+            _type: 'span',
+            text: '',
+            marks: [],
+          },
+        ],
+        markDefs: [],
+        style: 'normal',
+      },
+    ])
+  })
+  test('known listItem', () => {
+    const deserializedEvent = converterPortableText.deserialize({
+      context: createContext(
+        defineSchema({
+          lists: [{name: 'bullet'}],
+        }),
+      ),
+      event: {
+        type: 'deserialize',
+        data: JSON.stringify([
+          {
+            _type: 'block',
+            children: [],
+            listItem: 'bullet',
+            level: 1,
+          },
+        ]),
+      },
+    })
+    if (deserializedEvent.type !== 'deserialization.success') {
+      assert.fail()
+    }
+    expect(deserializedEvent.data).toEqual([
+      {
+        _type: 'block',
+        _key: 'k0',
+        children: [
+          {
+            _key: 'k1',
+            _type: 'span',
+            text: '',
+            marks: [],
+          },
+        ],
+        markDefs: [],
+        listItem: 'bullet',
+        level: 1,
+        style: 'normal',
+      },
+    ])
+  })
+  test('unknown annotations', () => {
+    expect(
+      converterPortableText.deserialize({
+        context: createContext(defineSchema({})),
+        event: {
+          type: 'deserialize',
+          data: JSON.stringify([
+            {
+              _type: 'block',
+              children: [
+                {
+                  _type: 'span',
+                  marks: ['b0m0'],
+                  text: 'foo',
+                },
+                {
+                  _type: 'span',
+                  marks: ['b0m1'],
+                  text: 'bar',
+                },
+              ],
+              markDefs: [
+                {
+                  _key: 'b0m0',
+                  _type: 'link',
+                  href: 'https://example.com',
+                },
+                {
+                  _key: 'b0m1',
+                  _type: 'color',
+                  color: 'red',
+                },
+              ],
+            },
+          ]),
+        },
+      }),
+    ).toMatchObject({
+      data: [
+        {
+          _type: 'block',
+          children: [
+            {
+              _type: 'span',
+              text: 'foo',
+              marks: [],
+            },
+            {
+              _type: 'span',
+              text: 'bar',
+              marks: [],
+            },
+          ],
+        },
+      ],
+    })
+  })
+  test('known annotations', () => {
+    expect(
+      converterPortableText.deserialize({
+        context: createContext(
+          defineSchema({
+            annotations: [{name: 'link'}],
+          }),
+        ),
+        event: {
+          type: 'deserialize',
+          data: JSON.stringify([
+            {
+              _type: 'block',
+              children: [
+                {
+                  _type: 'span',
+                  marks: ['b0m0'],
+                  text: 'foo',
+                },
+                {
+                  _type: 'span',
+                  marks: ['b0m1'],
+                  text: 'bar',
+                },
+              ],
+              markDefs: [
+                {
+                  _key: 'b0m0',
+                  _type: 'link',
+                  href: 'https://example.com',
+                },
+                {
+                  _key: 'b0m1',
+                  _type: 'color',
+                  color: 'red',
+                },
+              ],
+            },
+          ]),
+        },
+      }),
+    ).toMatchObject({
+      data: [
+        {
+          _type: 'block',
+          children: [
+            {
+              _type: 'span',
+              text: 'foo',
+              marks: ['k0'],
+            },
+            {
+              _type: 'span',
+              text: 'bar',
+              marks: [],
+            },
+          ],
+          markDefs: [
+            {
+              _key: 'k0',
+              _type: 'link',
+              href: 'https://example.com',
+            },
+          ],
+        },
+      ],
+    })
+  })
+  test('unknown decorators', () => {
+    expect(
+      converterPortableText.deserialize({
+        context: createContext(defineSchema({})),
+        event: {
+          type: 'deserialize',
+          data: JSON.stringify([
+            {
+              _type: 'block',
+              children: [
+                {
+                  _type: 'span',
+                  text: 'foo',
+                  marks: ['strong'],
+                },
+                {
+                  _type: 'span',
+                  text: 'bar',
+                  marks: ['em'],
+                },
+              ],
+            },
+          ]),
+        },
+      }),
+    ).toMatchObject({
+      data: [
+        {
+          _type: 'block',
+          children: [
+            {
+              _type: 'span',
+              text: 'foo',
+              marks: [],
+            },
+            {
+              _type: 'span',
+              text: 'bar',
+              marks: [],
+            },
+          ],
+        },
+      ],
+    })
+  })
+  test('known decorators', () => {
+    expect(
+      converterPortableText.deserialize({
+        context: createContext(
+          defineSchema({
+            decorators: [{name: 'strong'}],
+          }),
+        ),
+        event: {
+          type: 'deserialize',
+          data: JSON.stringify([
+            {
+              _type: 'block',
+              children: [
+                {
+                  _type: 'span',
+                  text: 'foo',
+                  marks: ['strong'],
+                },
+                {
+                  _type: 'span',
+                  text: 'bar',
+                  marks: ['em'],
+                },
+              ],
+            },
+          ]),
+        },
+      }),
+    ).toMatchObject({
+      data: [
+        {
+          _type: 'block',
+          children: [
+            {
+              _type: 'span',
+              text: 'foo',
+              marks: ['strong'],
+            },
+            {
+              _type: 'span',
+              text: 'bar',
+              marks: [],
+            },
+          ],
+        },
+      ],
+    })
+  })
+})