@portabletext/editor 1.47.0 → 1.47.2

package/lib/utils/index.d.ts

@@ -1,21 +1,16 @@
 import type {Patch} from '@portabletext/patches'
-import type {
-  ArraySchemaType,
-  BlockDecoratorDefinition,
-  BlockListDefinition,
-  BlockStyleDefinition,
-  ObjectSchemaType,
-  Path,
-  PortableTextChild,
-  PortableTextListBlock,
-  PortableTextTextBlock,
-} from '@sanity/types'
 import {
   KeyedSegment,
   PortableTextBlock,
   PortableTextObject,
   PortableTextSpan,
 } from '@sanity/types'
+import type {
+  Path,
+  PortableTextChild,
+  PortableTextListBlock,
+  PortableTextTextBlock,
+} from '@sanity/types'
 import type {
   FocusEvent as FocusEvent_2,
   KeyboardEvent as KeyboardEvent_2,
@@ -44,7 +39,6 @@ import {
   Values,
 } from 'xstate'
 import {GuardArgs} from 'xstate/guards'
-import {PortableTextMemberSchemaTypes as PortableTextMemberSchemaTypes_2} from '..'
 
 declare type AbstractBehaviorEvent =
   | {
@@ -219,6 +213,14 @@ declare const abstractBehaviorEventTypes: readonly [
   'style.toggle',
 ]
 
+/**
+ * @public
+ */
+declare type BaseDefinition = {
+  name: string
+  title?: string
+}
+
 /**
  * @beta
  */
@@ -1222,7 +1224,7 @@ declare const editorMachine: StateMachine<
       converters: Set<Converter>
       keyGenerator: () => string
       pendingEvents: never[]
-      schema: PortableTextMemberSchemaTypes_2
+      schema: EditorSchema
       selection: null
       initialReadOnly: boolean
       maxBlocks: number | undefined
@@ -4702,7 +4704,65 @@ declare const editorMachine: StateMachine<
 /**
  * @public
  */
-declare type EditorSchema = PortableTextMemberSchemaTypes
+declare type EditorSchema = {
+  annotations: ReadonlyArray<
+    BaseDefinition & {
+      fields: ReadonlyArray<{
+        name: string
+        type: string
+      }>
+    }
+  >
+  block: {
+    name: string
+  }
+  blockObjects: ReadonlyArray<
+    BaseDefinition & {
+      fields: ReadonlyArray<{
+        name: string
+        type: string
+      }>
+    }
+  >
+  decorators: ReadonlyArray<
+    BaseDefinition & {
+      /**
+       * @deprecated
+       * Use `name` instead
+       */
+      value: string
+    }
+  >
+  inlineObjects: ReadonlyArray<
+    BaseDefinition & {
+      fields: ReadonlyArray<{
+        name: string
+        type: string
+      }>
+    }
+  >
+  span: {
+    name: string
+  }
+  styles: ReadonlyArray<
+    BaseDefinition & {
+      /**
+       * @deprecated
+       * Use `name` instead
+       */
+      value: string
+    }
+  >
+  lists: ReadonlyArray<
+    BaseDefinition & {
+      /**
+       * @deprecated
+       * Use `name` instead
+       */
+      value: string
+    }
+  >
+}
 
 /** @public */
 declare type EditorSelection = {
@@ -5038,21 +5098,6 @@ declare type PickFromUnion<
   TPickedTags extends TUnion[TTagKey],
 > = TUnion extends Record<TTagKey, TPickedTags> ? TUnion : never
 
-/** @beta */
-declare type PortableTextMemberSchemaTypes = {
-  annotations: (ObjectSchemaType & {
-    i18nTitleKey?: string
-  })[]
-  block: ObjectSchemaType
-  blockObjects: ObjectSchemaType[]
-  decorators: BlockDecoratorDefinition[]
-  inlineObjects: ObjectSchemaType[]
-  portableText: ArraySchemaType<PortableTextBlock>
-  span: ObjectSchemaType
-  styles: BlockStyleDefinition[]
-  lists: BlockListDefinition[]
-}
-
 declare interface PortableTextSlateEditor extends ReactEditor {
   _key: 'editor'
   _type: 'editor'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "1.47.0",
+  "version": "1.47.2",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",
@@ -80,14 +80,14 @@
     "use-effect-event": "^1.0.2",
     "xstate": "^5.19.2",
     "@portabletext/patches": "1.1.3",
-    "@portabletext/block-tools": "1.1.17"
+    "@portabletext/block-tools": "1.1.18"
   },
   "devDependencies": {
     "@portabletext/toolkit": "^2.0.17",
     "@sanity/diff-match-patch": "^3.2.0",
     "@sanity/pkg-utils": "^7.2.2",
-    "@sanity/schema": "^3.83.0",
-    "@sanity/types": "^3.83.0",
+    "@sanity/schema": "^3.84.0",
+    "@sanity/types": "^3.84.0",
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.3.0",
     "@types/debug": "^4.1.12",
@@ -115,8 +115,8 @@
     "racejar": "1.2.3"
   },
   "peerDependencies": {
-    "@sanity/schema": "^3.83.0",
-    "@sanity/types": "^3.83.0",
+    "@sanity/schema": "^3.84.0",
+    "@sanity/types": "^3.84.0",
     "react": "^16.9 || ^17 || ^18 || ^19",
     "rxjs": "^7.8.2"
   },

package/src/behavior-actions/behavior.action.insert.block.ts

@@ -1,6 +1,6 @@
 import {Editor, Path, Point, Range, Transforms, type Descendant} from 'slate'
 import {DOMEditor} from 'slate-dom'
-import type {EditorSchema} from '../editor/define-schema'
+import type {EditorSchema} from '../editor/editor-schema'
 import {parseBlock} from '../internal-utils/parse-blocks'
 import {
   getFocusBlock,

package/src/behavior-actions/behavior.action.split.block.ts

@@ -88,7 +88,7 @@ export const splitBlockActionImplementation: BehaviorActionImplementation<
           // previous block
           for (const mark of marks) {
             if (
-              schema.decorators.some((decorator) => decorator.value === mark)
+              schema.decorators.some((decorator) => decorator.name === mark)
             ) {
               continue
             }

package/src/behavior-actions/behavior.guards.ts

@@ -4,7 +4,7 @@ import {
   type PortableTextListBlock,
   type PortableTextTextBlock,
 } from '@sanity/types'
-import type {EditorSchema} from '../editor/define-schema'
+import type {EditorSchema} from '../editor/editor-schema'
 
 /**
  * @alpha

package/src/behaviors/behavior.core.decorators.ts

@@ -8,7 +8,7 @@ export const coreDecoratorBehaviors = {
     guard: ({snapshot, event}) =>
       isHotkey('mod+b', event.originEvent) &&
       snapshot.context.schema.decorators.some(
-        (decorator) => decorator.value === 'strong',
+        (decorator) => decorator.name === 'strong',
       ),
     actions: [() => [raise({type: 'decorator.toggle', decorator: 'strong'})]],
   }),
@@ -17,7 +17,7 @@ export const coreDecoratorBehaviors = {
     guard: ({snapshot, event}) =>
       isHotkey('mod+i', event.originEvent) &&
       snapshot.context.schema.decorators.some(
-        (decorator) => decorator.value === 'em',
+        (decorator) => decorator.name === 'em',
       ),
     actions: [() => [raise({type: 'decorator.toggle', decorator: 'em'})]],
   }),
@@ -26,7 +26,7 @@ export const coreDecoratorBehaviors = {
     guard: ({snapshot, event}) =>
       isHotkey('mod+u', event.originEvent) &&
       snapshot.context.schema.decorators.some(
-        (decorator) => decorator.value === 'underline',
+        (decorator) => decorator.name === 'underline',
       ),
     actions: [
       () => [raise({type: 'decorator.toggle', decorator: 'underline'})],
@@ -37,7 +37,7 @@ export const coreDecoratorBehaviors = {
     guard: ({snapshot, event}) =>
       isHotkey("mod+'", event.originEvent) &&
       snapshot.context.schema.decorators.some(
-        (decorator) => decorator.value === 'code',
+        (decorator) => decorator.name === 'code',
       ),
     actions: [() => [raise({type: 'decorator.toggle', decorator: 'code'})]],
   }),

package/src/behaviors/behavior.core.insert-break.ts

@@ -40,7 +40,7 @@ const breakingAtTheEndOfTextBlock = defineBehavior({
           markDefs: [],
           listItem: focusListItem,
           level: focusLevel,
-          style: snapshot.context.schema.styles[0]?.value,
+          style: snapshot.context.schema.styles[0]?.name,
         },
         placement: 'after',
       }),
@@ -63,14 +63,14 @@ const breakingAtTheStartOfTextBlock = defineBehavior({
     const focusDecorators = focusSpan?.node.marks?.filter(
       (mark) =>
         snapshot.context.schema.decorators.some(
-          (decorator) => decorator.value === mark,
+          (decorator) => decorator.name === mark,
         ) ?? [],
     )
     const focusAnnotations =
       focusSpan?.node.marks?.filter(
         (mark) =>
           !snapshot.context.schema.decorators.some(
-            (decorator) => decorator.value === mark,
+            (decorator) => decorator.name === mark,
           ),
       ) ?? []
     const focusListItem = focusTextBlock.node.listItem
@@ -103,7 +103,7 @@ const breakingAtTheStartOfTextBlock = defineBehavior({
           ],
           listItem: focusListItem,
           level: focusLevel,
-          style: snapshot.context.schema.styles[0]?.value,
+          style: snapshot.context.schema.styles[0]?.name,
         },
         placement: 'before',
         select: 'none',

package/src/behaviors/behavior.decorator-pair.ts

@@ -1,4 +1,4 @@
-import type {EditorSchema} from '../editor/define-schema'
+import type {EditorSchema} from '../editor/editor-schema'
 import {createPairRegex} from '../internal-utils/get-text-to-emphasize'
 import * as selectors from '../selectors'
 import type {BlockOffset} from '../types/block-offset'

package/src/behaviors/behavior.links.ts

@@ -1,4 +1,4 @@
-import type {EditorSchema} from '../editor/define-schema'
+import type {EditorSchema} from '../editor/editor-schema'
 import {looksLikeUrl} from '../internal-utils/looks-like-url'
 import * as selectors from '../selectors'
 import {execute} from './behavior.types.action'

package/src/behaviors/behavior.markdown.ts

@@ -1,5 +1,5 @@
 import {isPortableTextTextBlock} from '@sanity/types'
-import type {EditorSchema} from '../editor/define-schema'
+import type {EditorSchema} from '../editor/editor-schema'
 import * as selectors from '../selectors'
 import {spanSelectionPointToBlockOffset} from '../utils/util.block-offset'
 import {getTextBlockText} from '../utils/util.get-text-block-text'

package/src/behaviors/behavior.perform-event.ts

@@ -1,6 +1,6 @@
 import type {Behavior, BehaviorEvent} from '.'
 import {performAction} from '../behavior-actions/behavior.actions'
-import type {EditorSchema} from '../editor/define-schema'
+import type {EditorSchema} from '../editor/editor-schema'
 import type {EditorSnapshot} from '../editor/editor-snapshot'
 import {
   withApplyingBehaviorActions,

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

@@ -3,15 +3,14 @@ import {
   compileSchemaDefinition,
   defineSchema,
   type SchemaDefinition,
-} from '../editor/define-schema'
+} from '../editor/editor-schema'
 import {createTestSnapshot} from '../internal-utils/create-test-snapshot'
 import {converterPortableText} from './converter.portable-text'
-import {coreConverters} from './converters.core'
 
 function createSnapshot(schema: SchemaDefinition) {
   return createTestSnapshot({
     context: {
-      converters: coreConverters,
+      converters: [],
       schema: compileSchemaDefinition(schema),
     },
   })

package/src/converters/converter.text-html.deserialize.test.ts

@@ -1,17 +1,17 @@
 import {describe, expect, test} from 'vitest'
 import {
   compileSchemaDefinition,
+  compileSchemaDefinitionToLegacySchema,
   defineSchema,
   type SchemaDefinition,
-} from '../editor/define-schema'
+} from '../editor/editor-schema'
 import {createTestSnapshot} from '../internal-utils/create-test-snapshot'
-import {converterTextHtml} from './converter.text-html'
-import {coreConverters} from './converters.core'
+import {createConverterTextHtml} from './converter.text-html'
 
 function createSnapshot(schema: SchemaDefinition) {
   return createTestSnapshot({
     context: {
-      converters: coreConverters,
+      converters: [],
       schema: compileSchemaDefinition(schema),
     },
   })
@@ -25,8 +25,12 @@ const unorderedList = '<ul><li>foo</li><li>bar</li></ul>'
 const orderedList = '<ol><li>foo</li><li>bar</li></ol>'
 const nestedList = '<ol><li>foo<ul><li>bar</li></ul></li></ol>'
 
-describe(converterTextHtml.deserialize.name, () => {
+describe(createConverterTextHtml.name, () => {
   test('paragraph with unknown decorators', () => {
+    const converterTextHtml = createConverterTextHtml(
+      compileSchemaDefinitionToLegacySchema(defineSchema({})),
+    )
+
     expect(
       converterTextHtml.deserialize({
         snapshot: createSnapshot(defineSchema({})),
@@ -56,6 +60,14 @@ describe(converterTextHtml.deserialize.name, () => {
   })
 
   test('paragraph with known decorators', () => {
+    const converterTextHtml = createConverterTextHtml(
+      compileSchemaDefinitionToLegacySchema(
+        defineSchema({
+          decorators: [{name: 'strong'}, {name: 'em'}, {name: 'code'}],
+        }),
+      ),
+    )
+
     expect(
       converterTextHtml.deserialize({
         snapshot: createSnapshot(
@@ -101,6 +113,13 @@ describe(converterTextHtml.deserialize.name, () => {
   })
 
   test('image', () => {
+    const converterTextHtml = createConverterTextHtml(
+      compileSchemaDefinitionToLegacySchema(
+        defineSchema({
+          blockObjects: [{name: 'image'}],
+        }),
+      ),
+    )
     expect(
       converterTextHtml.deserialize({
         snapshot: createSnapshot(
@@ -119,6 +138,10 @@ describe(converterTextHtml.deserialize.name, () => {
   })
 
   test('paragraph with unknown link', () => {
+    const converterTextHtml = createConverterTextHtml(
+      compileSchemaDefinitionToLegacySchema(defineSchema({})),
+    )
+
     expect(
       converterTextHtml.deserialize({
         snapshot: createSnapshot(defineSchema({})),
@@ -148,6 +171,16 @@ describe(converterTextHtml.deserialize.name, () => {
   })
 
   test('paragraph with known link', () => {
+    const converterTextHtml = createConverterTextHtml(
+      compileSchemaDefinitionToLegacySchema(
+        defineSchema({
+          annotations: [
+            {name: 'link', fields: [{name: 'href', type: 'string'}]},
+          ],
+        }),
+      ),
+    )
+
     expect(
       converterTextHtml.deserialize({
         snapshot: createSnapshot(
@@ -195,6 +228,14 @@ describe(converterTextHtml.deserialize.name, () => {
   })
 
   test('unordered list', () => {
+    const converterTextHtml = createConverterTextHtml(
+      compileSchemaDefinitionToLegacySchema(
+        defineSchema({
+          lists: [{name: 'bullet'}],
+        }),
+      ),
+    )
+
     expect(
       converterTextHtml.deserialize({
         snapshot: createSnapshot(
@@ -246,6 +287,14 @@ describe(converterTextHtml.deserialize.name, () => {
   })
 
   test('ordered list', () => {
+    const converterTextHtml = createConverterTextHtml(
+      compileSchemaDefinitionToLegacySchema(
+        defineSchema({
+          lists: [{name: 'number'}],
+        }),
+      ),
+    )
+
     expect(
       converterTextHtml.deserialize({
         snapshot: createSnapshot(
@@ -297,6 +346,14 @@ describe(converterTextHtml.deserialize.name, () => {
   })
 
   test('nested list', () => {
+    const converterTextHtml = createConverterTextHtml(
+      compileSchemaDefinitionToLegacySchema(
+        defineSchema({
+          lists: [{name: 'bullet'}, {name: 'number'}],
+        }),
+      ),
+    )
+
     expect(
       converterTextHtml.deserialize({
         snapshot: createSnapshot(

package/src/converters/converter.text-html.serialize.test.ts

@@ -3,12 +3,12 @@ import {describe, expect, test} from 'vitest'
 import type {EditorSelection} from '..'
 import {
   compileSchemaDefinition,
+  compileSchemaDefinitionToLegacySchema,
   defineSchema,
   type SchemaDefinition,
-} from '../editor/define-schema'
+} from '../editor/editor-schema'
 import {createTestSnapshot} from '../internal-utils/create-test-snapshot'
-import {converterTextHtml} from './converter.text-html'
-import {coreConverters} from './converters.core'
+import {createConverterTextHtml} from './converter.text-html'
 
 const decoratedParagraph: PortableTextTextBlock = {
   _key: 'k0',
@@ -78,7 +78,7 @@ const paragraphWithInlineBlock: PortableTextTextBlock = {
 function createSnapshot(schema: SchemaDefinition, selection: EditorSelection) {
   return createTestSnapshot({
     context: {
-      converters: coreConverters,
+      converters: [],
       schema: compileSchemaDefinition(schema),
       selection,
       value: [decoratedParagraph, image, b2, paragraphWithInlineBlock],
@@ -86,6 +86,10 @@ function createSnapshot(schema: SchemaDefinition, selection: EditorSelection) {
   })
 }
 
+const converterTextHtml = createConverterTextHtml(
+  compileSchemaDefinitionToLegacySchema(defineSchema({})),
+)
+
 describe(converterTextHtml.serialize.name, () => {
   test('paragraph with decorators', () => {
     expect(
@@ -177,7 +181,7 @@ describe(converterTextHtml.serialize.name, () => {
       converterTextHtml.serialize({
         snapshot: createTestSnapshot({
           context: {
-            converters: coreConverters,
+            converters: [],
             value: [
               {
                 _key: 'k0',

package/src/converters/converter.text-html.ts

@@ -2,87 +2,89 @@ import {htmlToBlocks} from '@portabletext/block-tools'
 import {toHTML} from '@portabletext/to-html'
 import type {PortableTextBlock} from '@sanity/types'
 import {parseBlock} from '../internal-utils/parse-blocks'
+import type {PortableTextMemberSchemaTypes} from '../types/editor'
 import {sliceBlocks} from '../utils'
 import {defineConverter} from './converter.types'
 
-export const converterTextHtml = defineConverter({
-  mimeType: 'text/html',
-  serialize: ({snapshot, event}) => {
-    const selection =
-      snapshot.beta.internalDrag?.origin.selection ?? snapshot.context.selection
+export function createConverterTextHtml(
+  legacySchema: PortableTextMemberSchemaTypes,
+) {
+  return defineConverter({
+    mimeType: 'text/html',
+    serialize: ({snapshot, event}) => {
+      const selection =
+        snapshot.beta.internalDrag?.origin.selection ??
+        snapshot.context.selection
 
-    if (!selection) {
-      return {
-        type: 'serialization.failure',
-        mimeType: 'text/html',
-        originEvent: event.originEvent,
-        reason: 'No selection',
+      if (!selection) {
+        return {
+          type: 'serialization.failure',
+          mimeType: 'text/html',
+          originEvent: event.originEvent,
+          reason: 'No selection',
+        }
       }
-    }
 
-    const blocks = sliceBlocks({
-      blocks: snapshot.context.value,
-      selection,
-    })
+      const blocks = sliceBlocks({
+        blocks: snapshot.context.value,
+        selection,
+      })
 
-    const html = toHTML(blocks, {
-      onMissingComponent: false,
-      components: {
-        unknownType: ({children}) =>
-          children !== undefined ? `${children}` : '',
-      },
-    })
+      const html = toHTML(blocks, {
+        onMissingComponent: false,
+        components: {
+          unknownType: ({children}) =>
+            children !== undefined ? `${children}` : '',
+        },
+      })
+
+      if (html === '') {
+        return {
+          type: 'serialization.failure',
+          mimeType: 'text/html',
+          originEvent: event.originEvent,
+          reason: 'Serialized HTML is empty',
+        }
+      }
 
-    if (html === '') {
       return {
-        type: 'serialization.failure',
+        type: 'serialization.success',
+        data: html,
         mimeType: 'text/html',
         originEvent: event.originEvent,
-        reason: 'Serialized HTML is empty',
       }
-    }
-
-    return {
-      type: 'serialization.success',
-      data: html,
-      mimeType: 'text/html',
-      originEvent: event.originEvent,
-    }
-  },
-  deserialize: ({snapshot, event}) => {
-    const blocks = htmlToBlocks(
-      event.data,
-      snapshot.context.schema.portableText,
-      {
+    },
+    deserialize: ({snapshot, event}) => {
+      const blocks = htmlToBlocks(event.data, legacySchema.portableText, {
         keyGenerator: snapshot.context.keyGenerator,
         unstable_whitespaceOnPasteMode:
-          snapshot.context.schema.block.options.unstable_whitespaceOnPasteMode,
-      },
-    ) as Array<PortableTextBlock>
+          legacySchema.block.options.unstable_whitespaceOnPasteMode,
+      }) as Array<PortableTextBlock>
 
-    const parsedBlocks = blocks.flatMap((block) => {
-      const parsedBlock = parseBlock({
-        context: snapshot.context,
-        block,
-        options: {
-          refreshKeys: false,
-        },
+      const parsedBlocks = blocks.flatMap((block) => {
+        const parsedBlock = parseBlock({
+          context: snapshot.context,
+          block,
+          options: {
+            refreshKeys: false,
+          },
+        })
+        return parsedBlock ? [parsedBlock] : []
       })
-      return parsedBlock ? [parsedBlock] : []
-    })
 
-    if (parsedBlocks.length === 0) {
+      if (parsedBlocks.length === 0) {
+        return {
+          type: 'deserialization.failure',
+          mimeType: 'text/html',
+          reason: 'No blocks deserialized',
+        }
+      }
+
       return {
-        type: 'deserialization.failure',
+        type: 'deserialization.success',
+        data: parsedBlocks,
         mimeType: 'text/html',
-        reason: 'No blocks deserialized',
       }
-    }
-
-    return {
-      type: 'deserialization.success',
-      data: parsedBlocks,
-      mimeType: 'text/html',
-    }
-  },
-})
+    },
+  })
+}