@portabletext/editor 1.4.0 → 1.5.0

package/lib/index.d.mts

@@ -2,21 +2,22 @@ import {Patch} from '@portabletext/patches'
 import type {
   ArrayDefinition,
   ArraySchemaType,
-  BlockDecoratorDefinition,
   BlockListDefinition,
-  BlockSchemaType,
   BlockStyleDefinition,
   KeyedSegment,
   ObjectSchemaType,
   Path,
-  PortableTextBlock,
   PortableTextChild,
   PortableTextListBlock,
   PortableTextObject,
-  SpanSchemaType,
   TypedObject,
 } from '@sanity/types'
-import {PortableTextSpan, PortableTextTextBlock} from '@sanity/types'
+import {
+  BlockDecoratorDefinition,
+  PortableTextBlock,
+  PortableTextSpan,
+  PortableTextTextBlock,
+} from '@sanity/types'
 import type {
   BaseSyntheticEvent,
   ClipboardEvent as ClipboardEvent_2,
@@ -36,8 +37,8 @@ import {
 } from 'react'
 import type {Observable, Subject} from 'rxjs'
 import type {Descendant, Node as Node_2, Operation, TextUnit} from 'slate'
+import type {DOMNode} from 'slate-dom'
 import type {ReactEditor} from 'slate-react'
-import type {DOMNode} from 'slate-react/dist/utils/dom'
 import type {TextInsertTextOptions} from 'slate/dist/interfaces/transforms/text'
 import {
   ActionArgs,
@@ -64,6 +65,15 @@ import {
   Values,
 } from 'xstate'
 
+/**
+ * @alpha
+ */
+export declare type BaseDefinition = {
+  name: string
+  title?: string
+  icon?: BlockDecoratorDefinition['icon']
+}
+
 /**
  * @alpha
  */
@@ -303,10 +313,10 @@ export declare type createEditorOptions = {
 export declare function createMarkdownBehaviors(
   config: MarkdownBehaviorsConfig,
 ): Behavior<
-  | 'insert break'
-  | 'insert soft break'
   | 'delete backward'
   | 'delete forward'
+  | 'insert soft break'
+  | 'insert break'
   | 'insert text',
   true
 >[]
@@ -319,12 +329,23 @@ export declare function defineBehavior<
   TGuardResponse = true,
 >(behavior: Behavior<TBehaviorEventType, TGuardResponse>): Behavior
 
+/**
+ * @alpha
+ */
+export declare function defineSchema<
+  const TSchemaDefinition extends SchemaDefinition,
+>(definition: TSchemaDefinition): TSchemaDefinition
+
 /** @beta */
 export declare interface EditableAPI {
   activeAnnotations: () => PortableTextObject[]
   isAnnotationActive: (annotationType: PortableTextObject['_type']) => boolean
-  addAnnotation: (
-    type: ObjectSchemaType,
+  addAnnotation: <
+    TSchemaType extends {
+      name: string
+    },
+  >(
+    type: TSchemaType,
     value?: {
       [prop: string]: unknown
     },
@@ -354,14 +375,22 @@ export declare interface EditableAPI {
   getValue: () => PortableTextBlock[] | undefined
   hasBlockStyle: (style: string) => boolean
   hasListStyle: (listStyle: string) => boolean
-  insertBlock: (
-    type: BlockSchemaType | ObjectSchemaType,
+  insertBlock: <
+    TSchemaType extends {
+      name: string
+    },
+  >(
+    type: TSchemaType,
     value?: {
       [prop: string]: unknown
     },
   ) => Path
-  insertChild: (
-    type: SpanSchemaType | ObjectSchemaType,
+  insertChild: <
+    TSchemaType extends {
+      name: string
+    },
+  >(
+    type: TSchemaType,
     value?: {
       [prop: string]: unknown
     },
@@ -377,7 +406,13 @@ export declare interface EditableAPI {
   isVoid: (element: PortableTextBlock | PortableTextChild) => boolean
   marks: () => string[]
   redo: () => void
-  removeAnnotation: (type: ObjectSchemaType) => void
+  removeAnnotation: <
+    TSchemaType extends {
+      name: string
+    },
+  >(
+    type: TSchemaType,
+  ) => void
   select: (selection: EditorSelection) => void
   toggleBlockStyle: (blockStyle: string) => void
   toggleList: (listStyle: string) => void
@@ -430,8 +465,16 @@ export declare type EditorChanges = Subject<EditorChange>
 export declare type EditorConfig = {
   behaviors?: Array<Behavior>
   keyGenerator?: () => string
-  schema: ArraySchemaType<PortableTextBlock> | ArrayDefinition
-}
+} & (
+  | {
+      schemaDefinition: SchemaDefinition
+      schema?: undefined
+    }
+  | {
+      schemaDefinition?: undefined
+      schema: ArraySchemaType<PortableTextBlock> | ArrayDefinition
+    }
+)
 
 /**
  * @internal
@@ -867,10 +910,10 @@ export declare const editorMachine: StateMachine<
       >
     }) => {
       behaviors: Behavior<
-        | 'insert break'
-        | 'insert soft break'
         | 'delete backward'
         | 'delete forward'
+        | 'insert soft break'
+        | 'insert break'
         | 'insert text',
         true
       >[]
@@ -3092,6 +3135,8 @@ export declare type PickFromUnion<
   TPickedTags extends TUnion[TTagKey],
 > = TUnion extends Record<TTagKey, TPickedTags> ? TUnion : never
 
+export {PortableTextBlock}
+
 /**
  * @public
  */
@@ -3156,9 +3201,13 @@ export declare class PortableTextEditor extends Component<
     editor: PortableTextEditor,
     annotationType: PortableTextObject['_type'],
   ) => boolean
-  static addAnnotation: (
+  static addAnnotation: <
+    TSchemaType extends {
+      name: string
+    },
+  >(
     editor: PortableTextEditor,
-    type: ObjectSchemaType,
+    type: TSchemaType,
     value?: {
       [prop: string]: unknown
     },
@@ -3231,16 +3280,24 @@ export declare class PortableTextEditor extends Component<
     editor: PortableTextEditor,
     mark: string,
   ) => boolean | undefined
-  static insertChild: (
+  static insertChild: <
+    TSchemaType extends {
+      name: string
+    },
+  >(
     editor: PortableTextEditor,
-    type: SpanSchemaType | ObjectSchemaType,
+    type: TSchemaType,
     value?: {
       [prop: string]: unknown
     },
   ) => Path | undefined
-  static insertBlock: (
+  static insertBlock: <
+    TSchemaType extends {
+      name: string
+    },
+  >(
     editor: PortableTextEditor,
-    type: BlockSchemaType | ObjectSchemaType,
+    type: TSchemaType,
     value?: {
       [prop: string]: unknown
     },
@@ -3256,9 +3313,13 @@ export declare class PortableTextEditor extends Component<
     editor: PortableTextEditor,
     selection: EditorSelection | null,
   ) => void
-  static removeAnnotation: (
+  static removeAnnotation: <
+    TSchemaType extends {
+      name: string
+    },
+  >(
     editor: PortableTextEditor,
-    type: ObjectSchemaType,
+    type: TSchemaType,
   ) => void | undefined
   static toggleBlockStyle: (
     editor: PortableTextEditor,
@@ -3551,6 +3612,20 @@ export declare type RenderStyleFunction = (
   props: BlockStyleRenderProps,
 ) => JSX.Element
 
+/**
+ * @alpha
+ */
+export declare type SchemaDefinition<
+  TBaseDefinition extends BaseDefinition = BaseDefinition,
+> = {
+  decorators?: ReadonlyArray<TBaseDefinition>
+  blockObjects?: ReadonlyArray<TBaseDefinition>
+  inlineObjects?: ReadonlyArray<TBaseDefinition>
+  annotations?: ReadonlyArray<TBaseDefinition>
+  lists?: ReadonlyArray<TBaseDefinition>
+  styles?: ReadonlyArray<TBaseDefinition>
+}
+
 /** @beta */
 export declare type ScrollSelectionIntoViewFunction = (
   editor: PortableTextEditor,
@@ -4015,10 +4090,10 @@ export declare function useEditor(config: EditorConfig): Actor<
         >
       }) => {
         behaviors: Behavior<
-          | 'insert break'
-          | 'insert soft break'
           | 'delete backward'
           | 'delete forward'
+          | 'insert soft break'
+          | 'insert break'
           | 'insert text',
           true
         >[]

package/lib/index.d.ts

@@ -2,21 +2,22 @@ import {Patch} from '@portabletext/patches'
 import type {
   ArrayDefinition,
   ArraySchemaType,
-  BlockDecoratorDefinition,
   BlockListDefinition,
-  BlockSchemaType,
   BlockStyleDefinition,
   KeyedSegment,
   ObjectSchemaType,
   Path,
-  PortableTextBlock,
   PortableTextChild,
   PortableTextListBlock,
   PortableTextObject,
-  SpanSchemaType,
   TypedObject,
 } from '@sanity/types'
-import {PortableTextSpan, PortableTextTextBlock} from '@sanity/types'
+import {
+  BlockDecoratorDefinition,
+  PortableTextBlock,
+  PortableTextSpan,
+  PortableTextTextBlock,
+} from '@sanity/types'
 import type {
   BaseSyntheticEvent,
   ClipboardEvent as ClipboardEvent_2,
@@ -36,8 +37,8 @@ import {
 } from 'react'
 import type {Observable, Subject} from 'rxjs'
 import type {Descendant, Node as Node_2, Operation, TextUnit} from 'slate'
+import type {DOMNode} from 'slate-dom'
 import type {ReactEditor} from 'slate-react'
-import type {DOMNode} from 'slate-react/dist/utils/dom'
 import type {TextInsertTextOptions} from 'slate/dist/interfaces/transforms/text'
 import {
   ActionArgs,
@@ -64,6 +65,15 @@ import {
   Values,
 } from 'xstate'
 
+/**
+ * @alpha
+ */
+export declare type BaseDefinition = {
+  name: string
+  title?: string
+  icon?: BlockDecoratorDefinition['icon']
+}
+
 /**
  * @alpha
  */
@@ -303,10 +313,10 @@ export declare type createEditorOptions = {
 export declare function createMarkdownBehaviors(
   config: MarkdownBehaviorsConfig,
 ): Behavior<
-  | 'insert break'
-  | 'insert soft break'
   | 'delete backward'
   | 'delete forward'
+  | 'insert soft break'
+  | 'insert break'
   | 'insert text',
   true
 >[]
@@ -319,12 +329,23 @@ export declare function defineBehavior<
   TGuardResponse = true,
 >(behavior: Behavior<TBehaviorEventType, TGuardResponse>): Behavior
 
+/**
+ * @alpha
+ */
+export declare function defineSchema<
+  const TSchemaDefinition extends SchemaDefinition,
+>(definition: TSchemaDefinition): TSchemaDefinition
+
 /** @beta */
 export declare interface EditableAPI {
   activeAnnotations: () => PortableTextObject[]
   isAnnotationActive: (annotationType: PortableTextObject['_type']) => boolean
-  addAnnotation: (
-    type: ObjectSchemaType,
+  addAnnotation: <
+    TSchemaType extends {
+      name: string
+    },
+  >(
+    type: TSchemaType,
     value?: {
       [prop: string]: unknown
     },
@@ -354,14 +375,22 @@ export declare interface EditableAPI {
   getValue: () => PortableTextBlock[] | undefined
   hasBlockStyle: (style: string) => boolean
   hasListStyle: (listStyle: string) => boolean
-  insertBlock: (
-    type: BlockSchemaType | ObjectSchemaType,
+  insertBlock: <
+    TSchemaType extends {
+      name: string
+    },
+  >(
+    type: TSchemaType,
     value?: {
       [prop: string]: unknown
     },
   ) => Path
-  insertChild: (
-    type: SpanSchemaType | ObjectSchemaType,
+  insertChild: <
+    TSchemaType extends {
+      name: string
+    },
+  >(
+    type: TSchemaType,
     value?: {
       [prop: string]: unknown
     },
@@ -377,7 +406,13 @@ export declare interface EditableAPI {
   isVoid: (element: PortableTextBlock | PortableTextChild) => boolean
   marks: () => string[]
   redo: () => void
-  removeAnnotation: (type: ObjectSchemaType) => void
+  removeAnnotation: <
+    TSchemaType extends {
+      name: string
+    },
+  >(
+    type: TSchemaType,
+  ) => void
   select: (selection: EditorSelection) => void
   toggleBlockStyle: (blockStyle: string) => void
   toggleList: (listStyle: string) => void
@@ -430,8 +465,16 @@ export declare type EditorChanges = Subject<EditorChange>
 export declare type EditorConfig = {
   behaviors?: Array<Behavior>
   keyGenerator?: () => string
-  schema: ArraySchemaType<PortableTextBlock> | ArrayDefinition
-}
+} & (
+  | {
+      schemaDefinition: SchemaDefinition
+      schema?: undefined
+    }
+  | {
+      schemaDefinition?: undefined
+      schema: ArraySchemaType<PortableTextBlock> | ArrayDefinition
+    }
+)
 
 /**
  * @internal
@@ -867,10 +910,10 @@ export declare const editorMachine: StateMachine<
       >
     }) => {
       behaviors: Behavior<
-        | 'insert break'
-        | 'insert soft break'
         | 'delete backward'
         | 'delete forward'
+        | 'insert soft break'
+        | 'insert break'
         | 'insert text',
         true
       >[]
@@ -3092,6 +3135,8 @@ export declare type PickFromUnion<
   TPickedTags extends TUnion[TTagKey],
 > = TUnion extends Record<TTagKey, TPickedTags> ? TUnion : never
 
+export {PortableTextBlock}
+
 /**
  * @public
  */
@@ -3156,9 +3201,13 @@ export declare class PortableTextEditor extends Component<
     editor: PortableTextEditor,
     annotationType: PortableTextObject['_type'],
   ) => boolean
-  static addAnnotation: (
+  static addAnnotation: <
+    TSchemaType extends {
+      name: string
+    },
+  >(
     editor: PortableTextEditor,
-    type: ObjectSchemaType,
+    type: TSchemaType,
     value?: {
       [prop: string]: unknown
     },
@@ -3231,16 +3280,24 @@ export declare class PortableTextEditor extends Component<
     editor: PortableTextEditor,
     mark: string,
   ) => boolean | undefined
-  static insertChild: (
+  static insertChild: <
+    TSchemaType extends {
+      name: string
+    },
+  >(
     editor: PortableTextEditor,
-    type: SpanSchemaType | ObjectSchemaType,
+    type: TSchemaType,
     value?: {
       [prop: string]: unknown
     },
   ) => Path | undefined
-  static insertBlock: (
+  static insertBlock: <
+    TSchemaType extends {
+      name: string
+    },
+  >(
     editor: PortableTextEditor,
-    type: BlockSchemaType | ObjectSchemaType,
+    type: TSchemaType,
     value?: {
       [prop: string]: unknown
     },
@@ -3256,9 +3313,13 @@ export declare class PortableTextEditor extends Component<
     editor: PortableTextEditor,
     selection: EditorSelection | null,
   ) => void
-  static removeAnnotation: (
+  static removeAnnotation: <
+    TSchemaType extends {
+      name: string
+    },
+  >(
     editor: PortableTextEditor,
-    type: ObjectSchemaType,
+    type: TSchemaType,
   ) => void | undefined
   static toggleBlockStyle: (
     editor: PortableTextEditor,
@@ -3551,6 +3612,20 @@ export declare type RenderStyleFunction = (
   props: BlockStyleRenderProps,
 ) => JSX.Element
 
+/**
+ * @alpha
+ */
+export declare type SchemaDefinition<
+  TBaseDefinition extends BaseDefinition = BaseDefinition,
+> = {
+  decorators?: ReadonlyArray<TBaseDefinition>
+  blockObjects?: ReadonlyArray<TBaseDefinition>
+  inlineObjects?: ReadonlyArray<TBaseDefinition>
+  annotations?: ReadonlyArray<TBaseDefinition>
+  lists?: ReadonlyArray<TBaseDefinition>
+  styles?: ReadonlyArray<TBaseDefinition>
+}
+
 /** @beta */
 export declare type ScrollSelectionIntoViewFunction = (
   editor: PortableTextEditor,
@@ -4015,10 +4090,10 @@ export declare function useEditor(config: EditorConfig): Actor<
         >
       }) => {
         behaviors: Behavior<
-          | 'insert break'
-          | 'insert soft break'
           | 'delete backward'
           | 'delete forward'
+          | 'insert soft break'
+          | 'insert break'
           | 'insert text',
           true
         >[]