@portabletext/editor 2.3.2 → 2.3.4

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

@@ -1,9 +1,8 @@
+import {compileSchema, defineSchema} from '@portabletext/schema'
 import {describe, expect, it} from 'vitest'
-import {compileSchemaDefinition} from '../../editor/editor-schema'
-import {defineSchema} from '../../editor/editor-schema-definition'
 import {fromSlateValue, toSlateValue} from '../values'
 
-const schemaTypes = compileSchemaDefinition(defineSchema({}))
+const schemaTypes = compileSchema(defineSchema({}))
 
 describe('toSlateValue', () => {
   it('checks undefined', () => {

package/src/internal-utils/apply-operation-to-portable-text.test.ts

@@ -1,12 +1,11 @@
+import {compileSchema, defineSchema} from '@portabletext/schema'
 import {describe, expect, test} from 'vitest'
-import {compileSchemaDefinition} from '../editor/editor-schema'
-import {defineSchema} from '../editor/editor-schema-definition'
 import {applyOperationToPortableText} from './apply-operation-to-portable-text'
 import {createTestKeyGenerator} from './test-key-generator'
 
 function createContext() {
   const keyGenerator = createTestKeyGenerator()
-  const schema = compileSchemaDefinition(defineSchema({}))
+  const schema = compileSchema(defineSchema({}))
 
   return {
     keyGenerator,

package/src/internal-utils/build-index-maps.test.ts

@@ -1,7 +1,6 @@
+import {compileSchema, defineSchema} from '@portabletext/schema'
 import type {PortableTextBlock} from '@sanity/types'
 import {describe, expect, test} from 'vitest'
-import {compileSchemaDefinition} from '../editor/editor-schema'
-import {defineSchema} from '../editor/editor-schema-definition'
 import {defaultKeyGenerator} from '../editor/key-generator'
 import {buildIndexMaps} from './build-index-maps'
 
@@ -38,7 +37,7 @@ function textBlock(
   }
 }
 
-const schema = compileSchemaDefinition(
+const schema = compileSchema(
   defineSchema({
     blockObjects: [{name: 'image'}],
   }),

package/src/internal-utils/create-test-snapshot.ts

@@ -1,6 +1,5 @@
+import {compileSchema, defineSchema} from '@portabletext/schema'
 import type {EditorSnapshot} from '..'
-import {compileSchemaDefinition} from '../editor/editor-schema'
-import {defineSchema} from '../editor/editor-schema-definition'
 import {createTestKeyGenerator} from './test-key-generator'
 
 export function createTestSnapshot(snapshot: {
@@ -9,8 +8,7 @@ export function createTestSnapshot(snapshot: {
 }): EditorSnapshot {
   const context = {
     converters: snapshot.context?.converters ?? [],
-    schema:
-      snapshot.context?.schema ?? compileSchemaDefinition(defineSchema({})),
+    schema: snapshot.context?.schema ?? compileSchema(defineSchema({})),
     keyGenerator: snapshot.context?.keyGenerator ?? createTestKeyGenerator(),
     readOnly: snapshot.context?.readOnly ?? false,
     value: snapshot.context?.value ?? [],

package/src/internal-utils/drag-selection.test.ts

@@ -1,6 +1,5 @@
+import {compileSchema, defineSchema} from '@portabletext/schema'
 import {describe, expect, test} from 'vitest'
-import {compileSchemaDefinition} from '../editor/editor-schema'
-import {defineSchema} from '../editor/editor-schema-definition'
 import type {EditorSelection} from '../types/editor'
 import {createTestSnapshot} from './create-test-snapshot'
 import {getDragSelection} from './drag-selection'
@@ -57,9 +56,7 @@ describe(getDragSelection.name, () => {
     return createTestSnapshot({
       context: {
         keyGenerator,
-        schema: compileSchemaDefinition(
-          defineSchema({blockObjects: [{name: 'image'}]}),
-        ),
+        schema: compileSchema(defineSchema({blockObjects: [{name: 'image'}]})),
         selection,
         value: [foo, baz, image],
       },

package/src/internal-utils/operation-to-patches.test.ts

@@ -1,13 +1,10 @@
+import {compileSchemaDefinitionToPortableTextMemberSchemaTypes} from '@portabletext/sanity-bridge'
+import {compileSchema, defineSchema} from '@portabletext/schema'
 import type {PortableTextTextBlock} from '@sanity/types'
 import {createEditor, type Descendant} from 'slate'
 import {beforeEach, describe, expect, it} from 'vitest'
 import {createActor} from 'xstate'
 import {editorMachine} from '../editor/editor-machine'
-import {
-  compileSchemaDefinition,
-  compileSchemaDefinitionToLegacySchema,
-} from '../editor/editor-schema'
-import {defineSchema} from '../editor/editor-schema-definition'
 import {defaultKeyGenerator} from '../editor/key-generator'
 import {withPlugins} from '../editor/plugins/with-plugins'
 import {relayMachine} from '../editor/relay-machine'
@@ -23,8 +20,9 @@ import {
 const schemaDefinition = defineSchema({
   inlineObjects: [{name: 'someObject'}],
 })
-const schema = compileSchemaDefinition(schemaDefinition)
-const legacySchema = compileSchemaDefinitionToLegacySchema(schemaDefinition)
+const schema = compileSchema(schemaDefinition)
+const legacySchema =
+  compileSchemaDefinitionToPortableTextMemberSchemaTypes(schemaDefinition)
 const editorActor = createActor(editorMachine, {
   input: {
     schema,

package/src/internal-utils/parse-blocks.test.ts

@@ -1,6 +1,5 @@
+import {compileSchema, defineSchema} from '@portabletext/schema'
 import {describe, expect, test} from 'vitest'
-import {compileSchemaDefinition} from '../editor/editor-schema'
-import {defineSchema} from '../editor/editor-schema-definition'
 import {parseBlock, parseSpan} from './parse-blocks'
 import {createTestKeyGenerator} from './test-key-generator'
 
@@ -11,7 +10,7 @@ describe(parseBlock.name, () => {
         block: null,
         context: {
           keyGenerator: createTestKeyGenerator(),
-          schema: compileSchemaDefinition(defineSchema({})),
+          schema: compileSchema(defineSchema({})),
         },
         options: {refreshKeys: false, validateFields: true},
       }),
@@ -24,7 +23,7 @@ describe(parseBlock.name, () => {
         block: undefined,
         context: {
           keyGenerator: createTestKeyGenerator(),
-          schema: compileSchemaDefinition(defineSchema({})),
+          schema: compileSchema(defineSchema({})),
         },
         options: {refreshKeys: false, validateFields: true},
       }),
@@ -38,7 +37,7 @@ describe(parseBlock.name, () => {
           block: {},
           context: {
             keyGenerator: createTestKeyGenerator(),
-            schema: compileSchemaDefinition(defineSchema({})),
+            schema: compileSchema(defineSchema({})),
           },
           options: {refreshKeys: false, validateFields: true},
         }),
@@ -51,7 +50,7 @@ describe(parseBlock.name, () => {
           block: {_key: 'k0'},
           context: {
             keyGenerator: createTestKeyGenerator(),
-            schema: compileSchemaDefinition(
+            schema: compileSchema(
               defineSchema({blockObjects: [{name: 'image'}]}),
             ),
           },
@@ -66,7 +65,7 @@ describe(parseBlock.name, () => {
           block: {_type: 'image'},
           context: {
             keyGenerator: createTestKeyGenerator(),
-            schema: compileSchemaDefinition(
+            schema: compileSchema(
               defineSchema({blockObjects: [{name: 'image'}]}),
             ),
           },
@@ -86,7 +85,7 @@ describe(parseBlock.name, () => {
           block: {_type: 'block'},
           context: {
             keyGenerator: createTestKeyGenerator(),
-            schema: compileSchemaDefinition(defineSchema({})),
+            schema: compileSchema(defineSchema({})),
           },
           options: {refreshKeys: false, validateFields: true},
         }),
@@ -107,7 +106,7 @@ describe(parseBlock.name, () => {
     })
 
     test('custom _type', () => {
-      const schema = compileSchemaDefinition(defineSchema({}))
+      const schema = compileSchema(defineSchema({}))
       expect(
         parseBlock({
           block: {_type: 'text'},
@@ -148,7 +147,7 @@ describe(parseBlock.name, () => {
           },
           context: {
             keyGenerator: createTestKeyGenerator(),
-            schema: compileSchemaDefinition(defineSchema({})),
+            schema: compileSchema(defineSchema({})),
           },
           options: {refreshKeys: false, validateFields: true},
         }),
@@ -182,7 +181,7 @@ describe(parseBlock.name, () => {
           },
           context: {
             keyGenerator: createTestKeyGenerator(),
-            schema: compileSchemaDefinition(
+            schema: compileSchema(
               defineSchema({
                 inlineObjects: [{name: 'stock-ticker'}],
                 decorators: [{name: 'em'}],
@@ -235,9 +234,7 @@ describe(parseBlock.name, () => {
           block: {_type: 'block', listItem: 'bullet'},
           context: {
             keyGenerator: createTestKeyGenerator(),
-            schema: compileSchemaDefinition(
-              defineSchema({lists: [{name: 'bullet'}]}),
-            ),
+            schema: compileSchema(defineSchema({lists: [{name: 'bullet'}]})),
           },
           options: {refreshKeys: false, validateFields: true},
         }),
@@ -264,9 +261,7 @@ describe(parseBlock.name, () => {
           block: {_type: 'block', listItem: 'number'},
           context: {
             keyGenerator: createTestKeyGenerator(),
-            schema: compileSchemaDefinition(
-              defineSchema({lists: [{name: 'bullet'}]}),
-            ),
+            schema: compileSchema(defineSchema({lists: [{name: 'bullet'}]})),
           },
           options: {refreshKeys: false, validateFields: true},
         }),
@@ -295,7 +290,7 @@ describe(parseSpan.name, () => {
         span: undefined,
         context: {
           keyGenerator: createTestKeyGenerator(),
-          schema: compileSchemaDefinition(defineSchema({})),
+          schema: compileSchema(defineSchema({})),
         },
         markDefKeyMap: new Map(),
         options: {refreshKeys: false, validateFields: true},
@@ -309,7 +304,7 @@ describe(parseSpan.name, () => {
         span: null,
         context: {
           keyGenerator: createTestKeyGenerator(),
-          schema: compileSchemaDefinition(defineSchema({})),
+          schema: compileSchema(defineSchema({})),
         },
         markDefKeyMap: new Map(),
         options: {refreshKeys: false, validateFields: true},
@@ -323,7 +318,7 @@ describe(parseSpan.name, () => {
         span: {},
         context: {
           keyGenerator: createTestKeyGenerator(),
-          schema: compileSchemaDefinition(defineSchema({})),
+          schema: compileSchema(defineSchema({})),
         },
         markDefKeyMap: new Map(),
         options: {refreshKeys: false, validateFields: true},
@@ -337,7 +332,7 @@ describe(parseSpan.name, () => {
         span: {_type: 'stock-ticker'},
         context: {
           keyGenerator: createTestKeyGenerator(),
-          schema: compileSchemaDefinition(defineSchema({})),
+          schema: compileSchema(defineSchema({})),
         },
         markDefKeyMap: new Map(),
         options: {refreshKeys: false, validateFields: true},
@@ -351,7 +346,7 @@ describe(parseSpan.name, () => {
         span: {_type: 'span'},
         context: {
           keyGenerator: createTestKeyGenerator(),
-          schema: compileSchemaDefinition(defineSchema({})),
+          schema: compileSchema(defineSchema({})),
         },
         markDefKeyMap: new Map(),
         options: {refreshKeys: false, validateFields: true},
@@ -370,7 +365,7 @@ describe(parseSpan.name, () => {
         span: {_type: 'span', foo: 'bar'},
         context: {
           keyGenerator: createTestKeyGenerator(),
-          schema: compileSchemaDefinition(defineSchema({})),
+          schema: compileSchema(defineSchema({})),
         },
         markDefKeyMap: new Map(),
         options: {refreshKeys: false, validateFields: true},
@@ -392,7 +387,7 @@ describe(parseSpan.name, () => {
         },
         context: {
           keyGenerator: createTestKeyGenerator(),
-          schema: compileSchemaDefinition(defineSchema({})),
+          schema: compileSchema(defineSchema({})),
         },
         markDefKeyMap: new Map(),
         options: {refreshKeys: false, validateFields: true},
@@ -414,9 +409,7 @@ describe(parseSpan.name, () => {
         },
         context: {
           keyGenerator: createTestKeyGenerator(),
-          schema: compileSchemaDefinition(
-            defineSchema({decorators: [{name: 'strong'}]}),
-          ),
+          schema: compileSchema(defineSchema({decorators: [{name: 'strong'}]})),
         },
         markDefKeyMap: new Map(),
         options: {refreshKeys: false, validateFields: true},
@@ -438,9 +431,7 @@ describe(parseSpan.name, () => {
         },
         context: {
           keyGenerator: createTestKeyGenerator(),
-          schema: compileSchemaDefinition(
-            defineSchema({decorators: [{name: 'strong'}]}),
-          ),
+          schema: compileSchema(defineSchema({decorators: [{name: 'strong'}]})),
         },
         markDefKeyMap: new Map(),
         options: {refreshKeys: false, validateFields: true},

package/src/internal-utils/selection-text.ts

@@ -1,6 +1,5 @@
+import {compileSchema, defineSchema} from '@portabletext/schema'
 import type {PortableTextBlock} from '@sanity/types'
-import {compileSchemaDefinition} from '../editor/editor-schema'
-import {defineSchema} from '../editor/editor-schema-definition'
 import type {EditorSelection} from '../types/editor'
 import {sliceBlocks} from '../utils/util.slice-blocks'
 import {getTersePt} from './terse-pt'
@@ -14,7 +13,7 @@ export function getSelectionText(
   }
 
   const slice = sliceBlocks({
-    context: {schema: compileSchemaDefinition(defineSchema({})), selection},
+    context: {schema: compileSchema(defineSchema({})), selection},
     blocks: value,
   })
 

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

@@ -1,6 +1,5 @@
+import {compileSchema, defineSchema} from '@portabletext/schema'
 import {expect, test} from 'vitest'
-import {compileSchemaDefinition} from '../editor/editor-schema'
-import {defineSchema} from '../editor/editor-schema-definition'
 import {createTestKeyGenerator} from '../internal-utils/test-key-generator'
 import {getTersePt, parseTersePt, parseTersePtString} from './terse-pt'
 
@@ -108,7 +107,7 @@ test(parseTersePt.name, () => {
   expect(
     parseTersePt(
       {
-        schema: compileSchemaDefinition(defineSchema({})),
+        schema: compileSchema(defineSchema({})),
         keyGenerator: createTestKeyGenerator(),
       },
       parseTersePtString('{image}|foo|>>#h4:bar|-:baz,fizz|,{stock-ticker},'),

package/src/internal-utils/test-editor.tsx

@@ -1,3 +1,4 @@
+import {defineSchema, type SchemaDefinition} from '@portabletext/schema'
 import type {PortableTextBlock} from '@sanity/types'
 import {page} from '@vitest/browser/context'
 import React from 'react'
@@ -7,10 +8,6 @@ import type {Editor} from '../editor'
 import {PortableTextEditable} from '../editor/Editable'
 import type {EditorActor} from '../editor/editor-machine'
 import {EditorProvider} from '../editor/editor-provider'
-import {
-  defineSchema,
-  type SchemaDefinition,
-} from '../editor/editor-schema-definition'
 import type {EditorEmittedEvent} from '../editor/relay-machine'
 import {EditorRefPlugin} from '../plugins/plugin.editor-ref'
 import {EventListenerPlugin} from '../plugins/plugin.event-listener'

package/src/internal-utils/to-slate-range.test.ts

@@ -1,11 +1,10 @@
+import {compileSchema, defineSchema} from '@portabletext/schema'
 import {describe, expect, test} from 'vitest'
-import {compileSchemaDefinition} from '../editor/editor-schema'
-import {defineSchema} from '../editor/editor-schema-definition'
 import {createTestKeyGenerator} from './test-key-generator'
 import {toSlateRange} from './to-slate-range'
 
 describe(toSlateRange.name, () => {
-  const schema = compileSchemaDefinition(
+  const schema = compileSchema(
     defineSchema({
       blockObjects: [{name: 'image'}],
       inlineObjects: [

package/src/plugins/plugin.internal.auto-close-brackets.test.tsx

@@ -1,9 +1,9 @@
+import {defineSchema} from '@portabletext/schema'
 import {page, userEvent} from '@vitest/browser/context'
 import React from 'react'
 import {describe, expect, test, vi} from 'vitest'
 import {render} from 'vitest-browser-react'
 import {EditorProvider, PortableTextEditable, type Editor} from '..'
-import {defineSchema} from '../editor/editor-schema-definition'
 import {getTersePt} from '../internal-utils/terse-pt'
 import {createTestKeyGenerator} from '../internal-utils/test-key-generator'
 import {EditorRefPlugin} from './plugin.editor-ref'

package/src/plugins/plugin.markdown.test.tsx

@@ -1,10 +1,10 @@
+import {defineSchema} from '@portabletext/schema'
 import {page, userEvent} from '@vitest/browser/context'
 import React from 'react'
 import {describe, expect, test, vi} from 'vitest'
 import {render} from 'vitest-browser-react'
 import {PortableTextEditable, type Editor} from '..'
 import {EditorProvider} from '../editor/editor-provider'
-import {defineSchema} from '../editor/editor-schema-definition'
 import {getTersePt} from '../internal-utils/terse-pt'
 import {createTestKeyGenerator} from '../internal-utils/test-key-generator'
 import {getTextMarks} from '../internal-utils/text-marks'

package/src/selectors/selector.get-selection-text.test.ts

@@ -1,8 +1,7 @@
+import {compileSchema, defineSchema} from '@portabletext/schema'
 import type {PortableTextBlock} from '@sanity/types'
 import {expect, test} from 'vitest'
 import type {EditorSelection} from '..'
-import {compileSchemaDefinition} from '../editor/editor-schema'
-import {defineSchema} from '../editor/editor-schema-definition'
 import {createTestSnapshot} from '../internal-utils/create-test-snapshot'
 import {getSelectionText} from './selector.get-selection-text'
 
@@ -72,7 +71,7 @@ test(getSelectionText.name, () => {
   ) {
     return createTestSnapshot({
       context: {
-        schema: compileSchemaDefinition(
+        schema: compileSchema(
           defineSchema({
             inlineObjects: [{name: 'stock-ticker'}],
           }),

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

@@ -1,7 +1,6 @@
+import {compileSchema, defineSchema} from '@portabletext/schema'
 import type {PortableTextBlock} from '@sanity/types'
 import {describe, expect, test} from 'vitest'
-import {compileSchemaDefinition} from '../editor/editor-schema'
-import {defineSchema} from '../editor/editor-schema-definition'
 import {createTestSnapshot} from '../internal-utils/create-test-snapshot'
 import {parseBlock} from '../internal-utils/parse-blocks'
 import {createTestKeyGenerator} from '../internal-utils/test-key-generator'
@@ -14,7 +13,7 @@ function snapshot(
   value: Array<Partial<PortableTextBlock>>,
   selection: EditorSelection,
 ) {
-  const schema = compileSchemaDefinition(
+  const schema = compileSchema(
     defineSchema({
       blockObjects: [{name: 'image'}],
       inlineObjects: [{name: 'stock-ticker'}],

package/src/utils/util.block-offset.test.ts

@@ -1,10 +1,9 @@
+import {compileSchema, defineSchema} from '@portabletext/schema'
 import type {PortableTextBlock} from '@sanity/types'
 import {expect, test} from 'vitest'
-import {compileSchemaDefinition} from '../editor/editor-schema'
-import {defineSchema} from '../editor/editor-schema-definition'
 import {blockOffsetToSpanSelectionPoint} from './util.block-offset'
 
-const schema = compileSchemaDefinition(defineSchema({}))
+const schema = compileSchema(defineSchema({}))
 
 test(blockOffsetToSpanSelectionPoint.name, () => {
   const value: Array<PortableTextBlock> = [

package/src/utils/util.slice-blocks.test.ts

@@ -1,7 +1,6 @@
+import {compileSchema, defineSchema} from '@portabletext/schema'
 import type {PortableTextBlock, PortableTextTextBlock} from '@sanity/types'
 import {describe, expect, test} from 'vitest'
-import {compileSchemaDefinition} from '../editor/editor-schema'
-import {defineSchema} from '../editor/editor-schema-definition'
 import {sliceBlocks} from './util.slice-blocks'
 
 const b1: PortableTextTextBlock = {
@@ -59,7 +58,7 @@ const b4: PortableTextTextBlock = {
   ],
 }
 
-const schema = compileSchemaDefinition(defineSchema({}))
+const schema = compileSchema(defineSchema({}))
 const blocks: Array<PortableTextBlock> = [b1, b2, b3, b4]
 
 describe(sliceBlocks.name, () => {

package/src/utils/util.slice-text-block.test.ts

@@ -1,3 +1,4 @@
+import {compileSchema, defineSchema} from '@portabletext/schema'
 import type {
   PortableTextObject,
   PortableTextSpan,
@@ -5,11 +6,9 @@ import type {
 } from '@sanity/types'
 import {describe, expect, test} from 'vitest'
 import {keyGenerator} from '..'
-import {compileSchemaDefinition} from '../editor/editor-schema'
-import {defineSchema} from '../editor/editor-schema-definition'
 import {sliceTextBlock} from './util.slice-text-block'
 
-const schema = compileSchemaDefinition(
+const schema = compileSchema(
   defineSchema({
     inlineObjects: [{name: 'stock-ticker'}],
   }),

package/src/editor/editor-schema-definition.ts

@@ -1,105 +0,0 @@
-/**
- * @public
- */
-export type BaseDefinition = {
-  name: string
-  title?: string
-}
-
-/**
- * @public
- */
-export type FieldDefinition = BaseDefinition & {
-  type: 'string' | 'number' | 'boolean' | 'array' | 'object'
-}
-
-/**
- * @public
- */
-export type DecoratorDefinition<
-  TBaseDefinition extends BaseDefinition = BaseDefinition,
-> = TBaseDefinition
-
-/**
- * @public
- */
-export type AnnotationDefinition<
-  TBaseDefinition extends BaseDefinition = BaseDefinition,
-> = TBaseDefinition & {
-  fields?: ReadonlyArray<FieldDefinition>
-}
-
-/**
- * @public
- */
-export type BlockObjectDefinition<
-  TBaseDefinition extends BaseDefinition = BaseDefinition,
-> = TBaseDefinition & {
-  fields?: ReadonlyArray<FieldDefinition>
-}
-
-/**
- * @public
- */
-export type InlineObjectDefinition<
-  TBaseDefinition extends BaseDefinition = BaseDefinition,
-> = TBaseDefinition & {
-  fields?: ReadonlyArray<FieldDefinition>
-}
-
-/**
- * @public
- */
-export type ListDefinition<
-  TBaseDefinition extends BaseDefinition = BaseDefinition,
-> = TBaseDefinition
-
-/**
- * @public
- */
-export type StyleDefinition<
-  TBaseDefinition extends BaseDefinition = BaseDefinition,
-> = TBaseDefinition
-
-/**
- * @public
- */
-export type SchemaDefinition<
-  TBaseDefinition extends BaseDefinition = BaseDefinition,
-> = {
-  decorators?: ReadonlyArray<DecoratorDefinition<TBaseDefinition>>
-  blockObjects?: ReadonlyArray<BlockObjectDefinition<TBaseDefinition>>
-  inlineObjects?: ReadonlyArray<InlineObjectDefinition<TBaseDefinition>>
-  annotations?: ReadonlyArray<AnnotationDefinition<TBaseDefinition>>
-  lists?: ReadonlyArray<ListDefinition<TBaseDefinition>>
-  styles?: ReadonlyArray<StyleDefinition<TBaseDefinition>>
-}
-
-/**
- * @public
- * A helper wrapper that adds editor support, such as autocomplete and type checking, for a schema definition.
- * @example
- * ```ts
- * import { defineSchema } from '@portabletext/editor'
- *
- * const schemaDefinition = defineSchema({
- *  decorators: [{name: 'strong'}, {name: 'em'}, {name: 'underline'}],
- *  annotations: [{name: 'link'}],
- *  styles: [
- *    {name: 'normal'},
- *    {name: 'h1'},
- *    {name: 'h2'},
- *    {name: 'h3'},
- *    {name: 'blockquote'},
- *  ],
- *  lists: [],
- *  inlineObjects: [],
- *  blockObjects: [],
- * }
- * ```
- */
-export function defineSchema<const TSchemaDefinition extends SchemaDefinition>(
-  definition: TSchemaDefinition,
-): TSchemaDefinition {
-  return definition
-}