@portabletext/editor 1.17.0 → 1.18.0

package/src/editor/editor-selector.ts

@@ -1,5 +1,7 @@
 import {useSelector} from '@xstate/react'
+import type {PortableTextSlateEditor} from '../types/editor'
 import type {Editor} from './create-editor'
+import type {EditorActor} from './editor-machine'
 import type {EditorSnapshot} from './editor-snapshot'
 import {getActiveDecorators} from './get-active-decorators'
 import {getValue} from './get-value'
@@ -9,12 +11,12 @@ function defaultCompare<T>(a: T, b: T) {
 }
 
 /**
- * @alpha
+ * @public
  */
 export type EditorSelector<TSelected> = (snapshot: EditorSnapshot) => TSelected
 
 /**
- * @alpha
+ * @public
  */
 export function useEditorSelector<TSelected>(
   editor: Editor,
@@ -23,20 +25,35 @@ export function useEditorSelector<TSelected>(
 ) {
   return useSelector(
     editor._internal.editorActor,
-    (snapshot) => {
-      const context = {
-        activeDecorators: getActiveDecorators({
-          schema: snapshot.context.schema,
-          slateEditorInstance: editor._internal.slateEditor.instance,
-        }),
-        keyGenerator: snapshot.context.keyGenerator,
-        schema: snapshot.context.schema,
-        selection: snapshot.context.selection,
-        value: getValue(editor),
-      }
+    (editorActorSnapshot) => {
+      const snapshot = getEditorSnapshot({
+        editorActorSnapshot,
+        slateEditorInstance: editor._internal.slateEditor.instance,
+      })
 
-      return selector({context})
+      return selector(snapshot)
     },
     compare,
   )
 }
+
+export function getEditorSnapshot({
+  editorActorSnapshot,
+  slateEditorInstance,
+}: {
+  editorActorSnapshot: ReturnType<EditorActor['getSnapshot']>
+  slateEditorInstance: PortableTextSlateEditor
+}): EditorSnapshot {
+  return {
+    context: {
+      activeDecorators: getActiveDecorators({
+        schema: editorActorSnapshot.context.schema,
+        slateEditorInstance,
+      }),
+      keyGenerator: editorActorSnapshot.context.keyGenerator,
+      schema: editorActorSnapshot.context.schema,
+      selection: editorActorSnapshot.context.selection,
+      value: getValue({editorActorSnapshot, slateEditorInstance}),
+    },
+  }
+}

package/src/editor/editor-snapshot.ts

@@ -3,7 +3,7 @@ import type {EditorSelection} from '../types/editor'
 import type {EditorSchema} from './define-schema'
 
 /**
- * @alpha
+ * @public
  */
 export type EditorContext = {
   activeDecorators: Array<string>
@@ -14,7 +14,7 @@ export type EditorContext = {
 }
 
 /**
- * @alpha
+ * @public
  */
 export type EditorSnapshot = {
   context: EditorContext

package/src/editor/get-value.ts

@@ -1,11 +1,18 @@
+import type {PortableTextSlateEditor} from '../types/editor'
 import {fromSlateValue} from '../utils/values'
 import {KEY_TO_VALUE_ELEMENT} from '../utils/weakMaps'
-import type {Editor} from './create-editor'
+import type {EditorActor} from './editor-machine'
 
-export function getValue(editor: Editor) {
+export function getValue({
+  editorActorSnapshot,
+  slateEditorInstance,
+}: {
+  editorActorSnapshot: ReturnType<EditorActor['getSnapshot']>
+  slateEditorInstance: PortableTextSlateEditor
+}) {
   return fromSlateValue(
-    editor._internal.slateEditor.instance.children,
-    editor._internal.editorActor.getSnapshot().context.schema.block.name,
-    KEY_TO_VALUE_ELEMENT.get(editor._internal.slateEditor.instance),
+    slateEditorInstance.children,
+    editorActorSnapshot.context.schema.block.name,
+    KEY_TO_VALUE_ELEMENT.get(slateEditorInstance),
   )
 }

package/src/editor/hooks/usePortableTextEditor.ts

@@ -8,6 +8,7 @@ export const PortableTextEditorContext =
   createContext<PortableTextEditor | null>(null)
 
 /**
+ * @deprecated Use `useEditor` to get the current editor instance.
  * @public
  * Get the current editor object from the React context.
  */

package/src/editor/hooks/usePortableTextEditorSelection.tsx

@@ -16,6 +16,7 @@ const PortableTextEditorSelectionContext =
   createContext<EditorSelection | null>(null)
 
 /**
+ * @deprecated Use `useEditorSelector` to get the current editor selection.
  * @public
  * Get the current editor selection from the React context.
  */

package/src/selectors/selector.get-active-list-item.ts

@@ -4,7 +4,7 @@ import type {EditorSelector} from '../editor/editor-selector'
 import {getSelectedBlocks} from './selectors'
 
 /**
- * @alpha
+ * @public
  */
 export const getActiveListItem: EditorSelector<
   PortableTextListBlock['listItem'] | undefined

package/src/selectors/selector.get-active-style.ts

@@ -4,7 +4,7 @@ import type {EditorSelector} from '../editor/editor-selector'
 import {getSelectedBlocks} from './selectors'
 
 /**
- * @alpha
+ * @public
  */
 export const getActiveStyle: EditorSelector<PortableTextTextBlock['style']> = ({
   context,

package/src/selectors/selector.get-selected-spans.ts

@@ -8,7 +8,7 @@ import {
 import type {EditorSelector} from '../editor/editor-selector'
 
 /**
- * @alpha
+ * @public
  */
 export const getSelectedSpans: EditorSelector<
   Array<{

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

@@ -4,7 +4,7 @@ import {isKeyedSegment} from '../editor/utils/utils.is-keyed-segment'
 import {reverseSelection} from '../editor/utils/utils.reverse-selection'
 
 /**
- * @alpha
+ * @public
  */
 export const getSelectionText: EditorSelector<string> = ({context}) => {
   let text = ''

package/src/selectors/selector.get-text-before.ts

@@ -5,7 +5,7 @@ import {reverseSelection} from '../editor/utils/utils.reverse-selection'
 import {getSelectionText} from './selector.get-selection-text'
 
 /**
- * @alpha
+ * @public
  */
 export const getBlockTextBefore: EditorSelector<string> = ({context}) => {
   if (!context.selection) {

package/src/selectors/selector.is-active-annotation.ts

@@ -4,7 +4,7 @@ import {getSelectedSpans} from './selector.get-selected-spans'
 import {getSelectedBlocks} from './selectors'
 
 /**
- * @alpha
+ * @public
  */
 export function isActiveAnnotation(
   annotation: string,

package/src/selectors/selector.is-active-decorator.ts

@@ -3,7 +3,7 @@ import {getSelectedSpans} from './selector.get-selected-spans'
 import {isSelectionExpanded} from './selector.is-selection-expanded'
 
 /**
- * @alpha
+ * @public
  */
 export function isActiveDecorator(decorator: string): EditorSelector<boolean> {
   return (snapshot) => {

package/src/selectors/selector.is-active-list-item.ts

@@ -2,7 +2,7 @@ import type {EditorSelector} from '../editor/editor-selector'
 import {getActiveListItem} from './selector.get-active-list-item'
 
 /**
- * @alpha
+ * @public
  */
 export function isActiveListItem(listItem: string): EditorSelector<boolean> {
   return (snapshot) => {

package/src/selectors/selector.is-active-style.ts

@@ -2,7 +2,7 @@ import type {EditorSelector} from '../editor/editor-selector'
 import {getActiveStyle} from './selector.get-active-style'
 
 /**
- * @alpha
+ * @public
  */
 export function isActiveStyle(style: string): EditorSelector<boolean> {
   return (snapshot) => {

package/src/selectors/selector.is-selection-collapsed.ts

@@ -1,7 +1,7 @@
 import type {EditorSelector} from '../editor/editor-selector'
 
 /**
- * @alpha
+ * @public
  */
 export const isSelectionCollapsed: EditorSelector<boolean> = ({context}) => {
   return (

package/src/selectors/selector.is-selection-expanded.ts

@@ -2,7 +2,7 @@ import type {EditorSelector} from '../editor/editor-selector'
 import {isSelectionCollapsed} from './selector.is-selection-collapsed'
 
 /**
- * @alpha
+ * @public
  */
 export const isSelectionExpanded: EditorSelector<boolean> = ({context}) => {
   return !isSelectionCollapsed({context})

package/src/selectors/selectors.ts

@@ -13,7 +13,7 @@ import {createGuards} from '../behavior-actions/behavior.guards'
 import type {EditorSelector} from '../editor/editor-selector'
 
 /**
- * @alpha
+ * @public
  */
 export const getFocusBlock: EditorSelector<
   {node: PortableTextBlock; path: [KeyedSegment]} | undefined
@@ -32,7 +32,7 @@ export const getFocusBlock: EditorSelector<
 }
 
 /**
- * @alpha
+ * @public
  */
 export const getFocusListBlock: EditorSelector<
   {node: PortableTextListBlock; path: [KeyedSegment]} | undefined
@@ -46,7 +46,7 @@ export const getFocusListBlock: EditorSelector<
 }
 
 /**
- * @alpha
+ * @public
  */
 export const getFocusTextBlock: EditorSelector<
   {node: PortableTextTextBlock; path: [KeyedSegment]} | undefined
@@ -59,7 +59,7 @@ export const getFocusTextBlock: EditorSelector<
 }
 
 /**
- * @alpha
+ * @public
  */
 export const getFocusBlockObject: EditorSelector<
   {node: PortableTextObject; path: [KeyedSegment]} | undefined
@@ -72,7 +72,7 @@ export const getFocusBlockObject: EditorSelector<
 }
 
 /**
- * @alpha
+ * @public
  */
 export const getFocusChild: EditorSelector<
   | {
@@ -103,7 +103,7 @@ export const getFocusChild: EditorSelector<
 }
 
 /**
- * @alpha
+ * @public
  */
 export const getFocusSpan: EditorSelector<
   | {node: PortableTextSpan; path: [KeyedSegment, 'children', KeyedSegment]}
@@ -117,7 +117,7 @@ export const getFocusSpan: EditorSelector<
 }
 
 /**
- * @alpha
+ * @public
  */
 export const getFirstBlock: EditorSelector<
   {node: PortableTextBlock; path: [KeyedSegment]} | undefined
@@ -128,7 +128,7 @@ export const getFirstBlock: EditorSelector<
 }
 
 /**
- * @alpha
+ * @public
  */
 export const getLastBlock: EditorSelector<
   {node: PortableTextBlock; path: [KeyedSegment]} | undefined
@@ -141,7 +141,7 @@ export const getLastBlock: EditorSelector<
 }
 
 /**
- * @alpha
+ * @public
  */
 export const getSelectedBlocks: EditorSelector<
   Array<{node: PortableTextBlock; path: [KeyedSegment]}>
@@ -195,7 +195,7 @@ export const getSelectedBlocks: EditorSelector<
 }
 
 /**
- * @alpha
+ * @public
  */
 export const getSelectionStartBlock: EditorSelector<
   | {
@@ -224,7 +224,7 @@ export const getSelectionStartBlock: EditorSelector<
 }
 
 /**
- * @alpha
+ * @public
  */
 export const getSelectionEndBlock: EditorSelector<
   | {
@@ -253,7 +253,7 @@ export const getSelectionEndBlock: EditorSelector<
 }
 
 /**
- * @alpha
+ * @public
  */
 export const getPreviousBlock: EditorSelector<
   {node: PortableTextBlock; path: [KeyedSegment]} | undefined
@@ -284,7 +284,7 @@ export const getPreviousBlock: EditorSelector<
 }
 
 /**
- * @alpha
+ * @public
  */
 export const getNextBlock: EditorSelector<
   {node: PortableTextBlock; path: [KeyedSegment]} | undefined

package/src/types/editor.ts

@@ -113,9 +113,9 @@ export interface History {
   undos: HistoryItem[]
 }
 
-/** @beta */
+/** @public */
 export type EditorSelectionPoint = {path: Path; offset: number}
-/** @beta */
+/** @public */
 export type EditorSelection = {
   anchor: EditorSelectionPoint
   focus: EditorSelectionPoint