@portabletext/editor 1.0.1 → 1.0.3

package/README.md

@@ -1,3 +1,10 @@
-# @sanity/portable-text-editor
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/portabletext/portabletext/master/logo-white.svg?sanitize=true">
+  <img alt="Portable Text Logo" src="https://raw.githubusercontent.com/portabletext/portabletext/master/logo.svg?sanitize=true">
+</picture>
 
-More info to come!
+<div align="center">
+<h1>Portable Text Editor</h1>
+</div>
+
+> The official editor for editing [Portable Text](https://github.com/portabletext/portabletext) – the JSON based rich text specification for modern content editing platforms.

package/lib/index.d.mts

@@ -1,5 +1,3 @@
-/// <reference types="react" />
-
 import {ArrayDefinition} from '@sanity/types'
 import {ArraySchemaType} from '@sanity/types'
 import {BaseSyntheticEvent} from 'react'
@@ -21,6 +19,7 @@ import {Node as Node_2} from 'slate'
 import {ObjectSchemaType} from '@sanity/types'
 import {Observable} from 'rxjs'
 import {Operation} from 'slate'
+import {Patch} from '@portabletext/patches/types'
 import {Path} from '@sanity/types'
 import {PortableTextBlock} from '@sanity/types'
 import {PortableTextChild} from '@sanity/types'
@@ -31,7 +30,6 @@ import {PortableTextTextBlock} from '@sanity/types'
 import {PropsWithChildren} from 'react'
 import {ReactEditor} from 'slate-react'
 import {ReactElement} from 'react'
-import {ReactNode} from 'react'
 import {RefAttributes} from 'react'
 import {RefObject} from 'react'
 import {SpanSchemaType} from '@sanity/types'
@@ -129,12 +127,6 @@ export declare type BlurChange = {
   event: FocusEvent_2<HTMLDivElement, Element>
 }
 
-/**
- * Try to compact a set of patches
- *
- */
-export declare function compactPatches(patches: Patch[]): Patch[]
-
 /**
  * The editor was either connected or disconnected to the network
  * To show out of sync warnings etc when in collaborative mode.
@@ -152,20 +144,6 @@ export declare type createEditorOptions = {
   maxBlocks?: number
 }
 
-export declare type DecPatch = {
-  path: Path
-  origin?: Origin
-  type: 'dec'
-  value: JSONValue
-}
-
-export declare type DiffMatchPatch = {
-  path: Path
-  type: 'diffMatchPatch'
-  origin?: Origin
-  value: string
-}
-
 /** @beta */
 export declare interface EditableAPI {
   activeAnnotations: () => PortableTextObject[]
@@ -303,24 +281,6 @@ export declare type HotkeyOptions = {
   custom?: Record<string, (event: BaseSyntheticEvent, editor: PortableTextEditor) => void>
 }
 
-export declare type IncPatch = {
-  path: Path
-  origin?: Origin
-  type: 'inc'
-  value: JSONValue
-}
-
-export declare type InsertPatch = {
-  path: Path
-  origin?: Origin
-  type: 'insert'
-  position: InsertPosition_2
-  items: JSONValue[]
-}
-
-declare type InsertPosition_2 = 'before' | 'after' | 'replace'
-export {InsertPosition_2 as InsertPosition}
-
 /**
  * The editor has an invalid value
  * @beta */
@@ -353,15 +313,6 @@ export declare type InvalidValueResolution = {
   }
 }
 
-export declare type JSONValue =
-  | number
-  | string
-  | boolean
-  | {
-      [key: string]: JSONValue
-    }
-  | JSONValue[]
-
 export declare const keyGenerator: () => string
 
 /**
@@ -403,8 +354,6 @@ export declare type OnPasteResult =
 
 export declare type OnPasteResultOrPromise = OnPasteResult | Promise<OnPasteResult>
 
-export declare type Origin = 'remote' | 'local' | 'internal'
-
 /** @beta */
 export declare interface PasteData {
   event: ClipboardEvent_2
@@ -413,15 +362,6 @@ export declare interface PasteData {
   value: PortableTextBlock[] | undefined
 }
 
-export declare type Patch =
-  | SetPatch
-  | SetIfMissingPatch
-  | UnsetPatch
-  | InsertPatch
-  | DiffMatchPatch
-  | IncPatch
-  | DecPatch
-
 /**
  * The editor has produced a patch
  * @beta */
@@ -442,22 +382,22 @@ export declare type PatchObservable = Observable<{
 export declare const PortableTextEditable: ForwardRefExoticComponent<
   Omit<
     Omit<TextareaHTMLAttributes<HTMLDivElement>, 'onPaste' | 'onCopy' | 'onBeforeInput'> & {
-      hotkeys?: HotkeyOptions | undefined
-      onBeforeInput?: ((event: InputEvent) => void) | undefined
-      onPaste?: OnPasteFn | undefined
-      onCopy?: OnCopyFn | undefined
+      hotkeys?: HotkeyOptions
+      onBeforeInput?: (event: InputEvent) => void
+      onPaste?: OnPasteFn
+      onCopy?: OnCopyFn
       ref: MutableRefObject<HTMLDivElement | null>
-      rangeDecorations?: RangeDecoration[] | undefined
-      renderAnnotation?: RenderAnnotationFunction | undefined
-      renderBlock?: RenderBlockFunction | undefined
-      renderChild?: RenderChildFunction | undefined
-      renderDecorator?: RenderDecoratorFunction | undefined
-      renderListItem?: RenderListItemFunction | undefined
-      renderPlaceholder?: (() => ReactNode) | undefined
-      renderStyle?: RenderStyleFunction | undefined
-      scrollSelectionIntoView?: ScrollSelectionIntoViewFunction | undefined
-      selection?: EditorSelection | undefined
-      spellCheck?: boolean | undefined
+      rangeDecorations?: RangeDecoration[]
+      renderAnnotation?: RenderAnnotationFunction
+      renderBlock?: RenderBlockFunction
+      renderChild?: RenderChildFunction
+      renderDecorator?: RenderDecoratorFunction
+      renderListItem?: RenderListItemFunction
+      renderPlaceholder?: RenderPlaceholderFunction
+      renderStyle?: RenderStyleFunction
+      scrollSelectionIntoView?: ScrollSelectionIntoViewFunction
+      selection?: EditorSelection
+      spellCheck?: boolean
     } & Omit<HTMLProps<HTMLDivElement>, 'onPaste' | 'onBeforeInput' | 'as'>,
     'ref'
   > &
@@ -482,7 +422,7 @@ export declare type PortableTextEditableProps = Omit<
   renderChild?: RenderChildFunction
   renderDecorator?: RenderDecoratorFunction
   renderListItem?: RenderListItemFunction
-  renderPlaceholder?: () => ReactNode
+  renderPlaceholder?: RenderPlaceholderFunction
   renderStyle?: RenderStyleFunction
   scrollSelectionIntoView?: ScrollSelectionIntoViewFunction
   selection?: EditorSelection
@@ -838,6 +778,9 @@ export declare type RenderEditableFunction = (props: PortableTextEditableProps)
 /** @beta */
 export declare type RenderListItemFunction = (props: BlockListItemRenderProps) => JSX.Element
 
+/** @beta */
+export declare type RenderPlaceholderFunction = () => React.ReactNode
+
 /** @beta */
 export declare type RenderStyleFunction = (props: BlockStyleRenderProps) => JSX.Element
 
@@ -855,20 +798,6 @@ export declare type SelectionChange = {
   selection: EditorSelection
 }
 
-export declare type SetIfMissingPatch = {
-  path: Path
-  origin?: Origin
-  type: 'setIfMissing'
-  value: JSONValue
-}
-
-export declare type SetPatch = {
-  path: Path
-  type: 'set'
-  origin?: Origin
-  value: JSONValue
-}
-
 /**
  * The editor performed a undo history step
  * @beta */
@@ -884,12 +813,6 @@ export declare type UnsetChange = {
   previousValue: PortableTextBlock[]
 }
 
-export declare type UnsetPatch = {
-  path: Path
-  origin?: Origin
-  type: 'unset'
-}
-
 /**
  * Get the current editor object from the React context.
  */
@@ -908,4 +831,6 @@ export declare type ValueChange = {
   value: PortableTextBlock[] | undefined
 }
 
+export * from '@portabletext/patches/types'
+
 export {}

package/lib/index.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="react" />
-
 import {ArrayDefinition} from '@sanity/types'
 import {ArraySchemaType} from '@sanity/types'
 import {BaseSyntheticEvent} from 'react'
@@ -21,6 +19,7 @@ import {Node as Node_2} from 'slate'
 import {ObjectSchemaType} from '@sanity/types'
 import {Observable} from 'rxjs'
 import {Operation} from 'slate'
+import {Patch} from '@portabletext/patches/types'
 import {Path} from '@sanity/types'
 import {PortableTextBlock} from '@sanity/types'
 import {PortableTextChild} from '@sanity/types'
@@ -31,7 +30,6 @@ import {PortableTextTextBlock} from '@sanity/types'
 import {PropsWithChildren} from 'react'
 import {ReactEditor} from 'slate-react'
 import {ReactElement} from 'react'
-import {ReactNode} from 'react'
 import {RefAttributes} from 'react'
 import {RefObject} from 'react'
 import {SpanSchemaType} from '@sanity/types'
@@ -129,12 +127,6 @@ export declare type BlurChange = {
   event: FocusEvent_2<HTMLDivElement, Element>
 }
 
-/**
- * Try to compact a set of patches
- *
- */
-export declare function compactPatches(patches: Patch[]): Patch[]
-
 /**
  * The editor was either connected or disconnected to the network
  * To show out of sync warnings etc when in collaborative mode.
@@ -152,20 +144,6 @@ export declare type createEditorOptions = {
   maxBlocks?: number
 }
 
-export declare type DecPatch = {
-  path: Path
-  origin?: Origin
-  type: 'dec'
-  value: JSONValue
-}
-
-export declare type DiffMatchPatch = {
-  path: Path
-  type: 'diffMatchPatch'
-  origin?: Origin
-  value: string
-}
-
 /** @beta */
 export declare interface EditableAPI {
   activeAnnotations: () => PortableTextObject[]
@@ -303,24 +281,6 @@ export declare type HotkeyOptions = {
   custom?: Record<string, (event: BaseSyntheticEvent, editor: PortableTextEditor) => void>
 }
 
-export declare type IncPatch = {
-  path: Path
-  origin?: Origin
-  type: 'inc'
-  value: JSONValue
-}
-
-export declare type InsertPatch = {
-  path: Path
-  origin?: Origin
-  type: 'insert'
-  position: InsertPosition_2
-  items: JSONValue[]
-}
-
-declare type InsertPosition_2 = 'before' | 'after' | 'replace'
-export {InsertPosition_2 as InsertPosition}
-
 /**
  * The editor has an invalid value
  * @beta */
@@ -353,15 +313,6 @@ export declare type InvalidValueResolution = {
   }
 }
 
-export declare type JSONValue =
-  | number
-  | string
-  | boolean
-  | {
-      [key: string]: JSONValue
-    }
-  | JSONValue[]
-
 export declare const keyGenerator: () => string
 
 /**
@@ -403,8 +354,6 @@ export declare type OnPasteResult =
 
 export declare type OnPasteResultOrPromise = OnPasteResult | Promise<OnPasteResult>
 
-export declare type Origin = 'remote' | 'local' | 'internal'
-
 /** @beta */
 export declare interface PasteData {
   event: ClipboardEvent_2
@@ -413,15 +362,6 @@ export declare interface PasteData {
   value: PortableTextBlock[] | undefined
 }
 
-export declare type Patch =
-  | SetPatch
-  | SetIfMissingPatch
-  | UnsetPatch
-  | InsertPatch
-  | DiffMatchPatch
-  | IncPatch
-  | DecPatch
-
 /**
  * The editor has produced a patch
  * @beta */
@@ -442,22 +382,22 @@ export declare type PatchObservable = Observable<{
 export declare const PortableTextEditable: ForwardRefExoticComponent<
   Omit<
     Omit<TextareaHTMLAttributes<HTMLDivElement>, 'onPaste' | 'onCopy' | 'onBeforeInput'> & {
-      hotkeys?: HotkeyOptions | undefined
-      onBeforeInput?: ((event: InputEvent) => void) | undefined
-      onPaste?: OnPasteFn | undefined
-      onCopy?: OnCopyFn | undefined
+      hotkeys?: HotkeyOptions
+      onBeforeInput?: (event: InputEvent) => void
+      onPaste?: OnPasteFn
+      onCopy?: OnCopyFn
       ref: MutableRefObject<HTMLDivElement | null>
-      rangeDecorations?: RangeDecoration[] | undefined
-      renderAnnotation?: RenderAnnotationFunction | undefined
-      renderBlock?: RenderBlockFunction | undefined
-      renderChild?: RenderChildFunction | undefined
-      renderDecorator?: RenderDecoratorFunction | undefined
-      renderListItem?: RenderListItemFunction | undefined
-      renderPlaceholder?: (() => ReactNode) | undefined
-      renderStyle?: RenderStyleFunction | undefined
-      scrollSelectionIntoView?: ScrollSelectionIntoViewFunction | undefined
-      selection?: EditorSelection | undefined
-      spellCheck?: boolean | undefined
+      rangeDecorations?: RangeDecoration[]
+      renderAnnotation?: RenderAnnotationFunction
+      renderBlock?: RenderBlockFunction
+      renderChild?: RenderChildFunction
+      renderDecorator?: RenderDecoratorFunction
+      renderListItem?: RenderListItemFunction
+      renderPlaceholder?: RenderPlaceholderFunction
+      renderStyle?: RenderStyleFunction
+      scrollSelectionIntoView?: ScrollSelectionIntoViewFunction
+      selection?: EditorSelection
+      spellCheck?: boolean
     } & Omit<HTMLProps<HTMLDivElement>, 'onPaste' | 'onBeforeInput' | 'as'>,
     'ref'
   > &
@@ -482,7 +422,7 @@ export declare type PortableTextEditableProps = Omit<
   renderChild?: RenderChildFunction
   renderDecorator?: RenderDecoratorFunction
   renderListItem?: RenderListItemFunction
-  renderPlaceholder?: () => ReactNode
+  renderPlaceholder?: RenderPlaceholderFunction
   renderStyle?: RenderStyleFunction
   scrollSelectionIntoView?: ScrollSelectionIntoViewFunction
   selection?: EditorSelection
@@ -838,6 +778,9 @@ export declare type RenderEditableFunction = (props: PortableTextEditableProps)
 /** @beta */
 export declare type RenderListItemFunction = (props: BlockListItemRenderProps) => JSX.Element
 
+/** @beta */
+export declare type RenderPlaceholderFunction = () => React.ReactNode
+
 /** @beta */
 export declare type RenderStyleFunction = (props: BlockStyleRenderProps) => JSX.Element
 
@@ -855,20 +798,6 @@ export declare type SelectionChange = {
   selection: EditorSelection
 }
 
-export declare type SetIfMissingPatch = {
-  path: Path
-  origin?: Origin
-  type: 'setIfMissing'
-  value: JSONValue
-}
-
-export declare type SetPatch = {
-  path: Path
-  type: 'set'
-  origin?: Origin
-  value: JSONValue
-}
-
 /**
  * The editor performed a undo history step
  * @beta */
@@ -884,12 +813,6 @@ export declare type UnsetChange = {
   previousValue: PortableTextBlock[]
 }
 
-export declare type UnsetPatch = {
-  path: Path
-  origin?: Origin
-  type: 'unset'
-}
-
 /**
  * Get the current editor object from the React context.
  */
@@ -908,4 +831,6 @@ export declare type ValueChange = {
   value: PortableTextBlock[] | undefined
 }
 
+export * from '@portabletext/patches/types'
+
 export {}