@portabletext/editor 1.26.3 → 1.28.0

package/src/selectors/selector.get-active-annotations.test.ts

@@ -0,0 +1,122 @@
+import type {PortableTextBlock} from '@sanity/types'
+import {expect, test} from 'vitest'
+import type {EditorSchema} from '../editor/define-schema'
+import type {EditorSnapshot} from '../editor/editor-snapshot'
+import {createTestKeyGenerator} from '../internal-utils/test-key-generator'
+import type {EditorSelection} from '../utils'
+import {getActiveAnnotations} from './selector.get-active-annotations'
+
+function snapshot(
+  value: Array<PortableTextBlock>,
+  selection: EditorSelection,
+): EditorSnapshot {
+  return {
+    context: {
+      converters: [],
+      schema: {} as EditorSchema,
+      keyGenerator: createTestKeyGenerator(),
+      activeDecorators: [],
+      value,
+      selection,
+    },
+  }
+}
+
+const link = {
+  _key: 'k4',
+  _type: 'link',
+  href: 'https://example.com',
+}
+
+const comment = {
+  _key: 'k5',
+  _type: 'comment',
+  comment: 'Consider rewriting this',
+}
+
+const block = {
+  _type: 'block',
+  _key: 'k0',
+  children: [
+    {
+      _key: 'k1',
+      _type: 'span',
+      text: 'foo',
+      marks: ['strong'],
+    },
+    {
+      _type: 'span',
+      _key: 'k2',
+      text: 'bar',
+      marks: [link._key, comment._key, 'strong'],
+    },
+    {
+      _key: 'k3',
+      _type: 'span',
+      text: 'baz',
+      marks: [comment._key, 'strong'],
+    },
+  ],
+  markDefs: [link, comment],
+}
+
+test(getActiveAnnotations.name, () => {
+  expect(getActiveAnnotations(snapshot([], null))).toEqual([])
+  expect(getActiveAnnotations(snapshot([block], null))).toEqual([])
+  expect(
+    getActiveAnnotations(
+      snapshot([block], {
+        anchor: {
+          path: [{_key: 'k0'}, 'children', {_key: 'k1'}],
+          offset: 0,
+        },
+        focus: {
+          path: [{_key: 'k0'}, 'children', {_key: 'k1'}],
+          offset: 3,
+        },
+      }),
+    ),
+  ).toEqual([])
+  expect(
+    getActiveAnnotations(
+      snapshot([block], {
+        anchor: {
+          path: [{_key: 'k0'}, 'children', {_key: 'k1'}],
+          offset: 0,
+        },
+        focus: {
+          path: [{_key: 'k0'}, 'children', {_key: 'k2'}],
+          offset: 3,
+        },
+      }),
+    ),
+  ).toEqual([link, comment])
+  expect(
+    getActiveAnnotations(
+      snapshot([block], {
+        anchor: {
+          path: [{_key: 'k0'}, 'children', {_key: 'k1'}],
+          offset: 0,
+        },
+        focus: {
+          path: [{_key: 'k0'}, 'children', {_key: 'k3'}],
+          offset: 3,
+        },
+      }),
+    ),
+  ).toEqual([link, comment])
+  expect(
+    getActiveAnnotations(
+      snapshot([block], {
+        anchor: {
+          path: [{_key: 'k0'}, 'children', {_key: 'k3'}],
+          offset: 0,
+        },
+        focus: {
+          path: [{_key: 'k0'}, 'children', {_key: 'k3'}],
+          offset: 3,
+        },
+      }),
+    ),
+  ).toEqual([comment])
+})

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

@@ -0,0 +1,30 @@
+import {isPortableTextTextBlock, type PortableTextObject} from '@sanity/types'
+import type {EditorSelector} from '../editor/editor-selector'
+import {getSelectedSpans} from './selector.get-selected-spans'
+import {getSelectedBlocks} from './selectors'
+
+/**
+ * @public
+ */
+export const getActiveAnnotations: EditorSelector<Array<PortableTextObject>> = (
+  snapshot,
+) => {
+  if (!snapshot.context.selection) {
+    return []
+  }
+
+  const selectedBlocks = getSelectedBlocks(snapshot)
+  const selectedSpans = getSelectedSpans(snapshot)
+
+  if (selectedSpans.length === 0) {
+    return []
+  }
+
+  const selectionMarkDefs = selectedBlocks.flatMap((block) =>
+    isPortableTextTextBlock(block.node) ? (block.node.markDefs ?? []) : [],
+  )
+
+  return selectionMarkDefs.filter((markDef) =>
+    selectedSpans.some((span) => span.node.marks?.includes(markDef._key)),
+  )
+}

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

@@ -0,0 +1,8 @@
+import type {EditorSelection, EditorSelector} from './_exports'
+
+/**
+ * @public
+ */
+export const getSelection: EditorSelector<EditorSelection> = ({context}) => {
+  return context.selection
+}

package/src/selectors/selector.get-value.ts

@@ -0,0 +1,11 @@
+import type {PortableTextBlock} from '@sanity/types'
+import type {EditorSelector} from './_exports'
+
+/**
+ * @public
+ */
+export const getValue: EditorSelector<Array<PortableTextBlock>> = ({
+  context,
+}) => {
+  return context.value
+}

package/src/type-utils.ts

@@ -1,5 +1,5 @@
 /**
- * @alpha
+ * @internal
  */
 export type PickFromUnion<
   TUnion,
@@ -8,10 +8,20 @@ export type PickFromUnion<
 > = TUnion extends Record<TTagKey, TPickedTags> ? TUnion : never
 
 /**
- * @alpha
+ * @internal
  */
 export type OmitFromUnion<
   TUnion,
   TTagKey extends keyof TUnion,
   TOmittedTags extends TUnion[TTagKey],
 > = TUnion extends Record<TTagKey, TOmittedTags> ? never : TUnion
+
+export type NamespaceEvent<TEvent, TNamespace extends string> = TEvent extends {
+  type: infer TEventType
+}
+  ? {
+      [K in keyof TEvent]: K extends 'type'
+        ? `${TNamespace}.${TEventType & string}`
+        : TEvent[K]
+    }
+  : never

package/src/editor/nodes/DefaultAnnotation.tsx

@@ -1,20 +0,0 @@
-import type {PortableTextObject} from '@sanity/types'
-import {useCallback, type ReactNode} from 'react'
-
-type Props = {
-  annotation: PortableTextObject
-  children: ReactNode
-}
-export function DefaultAnnotation(props: Props) {
-  const handleClick = useCallback(
-    () => alert(JSON.stringify(props.annotation)),
-    [props.annotation],
-  )
-  return (
-    <span style={{color: 'blue'}} onClick={handleClick}>
-      {props.children}
-    </span>
-  )
-}
-
-DefaultAnnotation.displayName = 'DefaultAnnotation'

package/src/editor/nodes/DefaultObject.tsx

@@ -1,18 +0,0 @@
-import type {PortableTextBlock, PortableTextChild} from '@sanity/types'
-import type {JSX} from 'react'
-
-type Props = {
-  value: PortableTextBlock | PortableTextChild
-}
-
-const DefaultObject = (props: Props): JSX.Element => {
-  return (
-    <div style={{userSelect: 'none'}}>
-      [{props.value._type}: {props.value._key}]
-    </div>
-  )
-}
-
-DefaultObject.displayName = 'DefaultObject'
-
-export default DefaultObject