@portabletext/block-tools 2.0.8 → 3.0.0

package/src/util/{blockContentTypeFeatures.ts → portable-text-schema.ts}

@@ -3,23 +3,42 @@ import {
   isBlockListObjectField,
   isBlockSchemaType,
   isBlockStyleObjectField,
-  isObjectSchemaType,
   isTitledListValue,
   type ArraySchemaType,
   type BlockSchemaType,
   type EnumListProps,
-  type I18nTitledListValue,
-  type ObjectSchemaType,
   type SpanSchemaType,
-  type TitledListValue,
 } from '@sanity/types'
-import type {BlockContentFeatures, ResolvedAnnotationType} from '../types'
 import {findBlockType} from './findBlockType'
 
-// Helper method for describing a blockContentType's feature set
-export default function blockContentFeatures(
+export type PortableTextSchema = {
+  block: {
+    name: string
+  }
+  span: {
+    name: string
+  }
+  styles: ReadonlyArray<{
+    name: string
+    title?: string
+  }>
+  lists: ReadonlyArray<{
+    name: string
+    title?: string
+  }>
+  decorators: ReadonlyArray<{
+    name: string
+    title?: string
+  }>
+  annotations: ReadonlyArray<{
+    name: string
+    title?: string
+  }>
+}
+
+export function getPortableTextSchema(
   blockContentType: ArraySchemaType,
-): BlockContentFeatures {
+): PortableTextSchema {
   if (!blockContentType) {
     throw new Error("Parameter 'blockContentType' required")
   }
@@ -43,33 +62,30 @@ export default function blockContentFeatures(
     )
   }
 
-  const inlineObjectTypes = ofType.filter(
-    (inlineType): inlineType is ObjectSchemaType =>
-      inlineType.name !== 'span' && isObjectSchemaType(inlineType),
-  )
+  const blockName = blockContentType.of.find(findBlockType)?.name
 
-  const blockObjectTypes = blockContentType.of.filter(
-    (memberType): memberType is ObjectSchemaType =>
-      memberType.name !== blockType.name && isObjectSchemaType(memberType),
-  )
+  if (!blockName) {
+    throw new Error('No `block` type found in schema type')
+  }
 
   return {
     styles: resolveEnabledStyles(blockType),
     decorators: resolveEnabledDecorators(spanType),
     annotations: resolveEnabledAnnotationTypes(spanType),
     lists: resolveEnabledListItems(blockType),
-    types: {
-      block: blockContentType,
-      span: spanType,
-      inlineObjects: inlineObjectTypes,
-      blockObjects: blockObjectTypes,
+    block: {
+      name: blockName,
+    },
+    span: {
+      name: spanType.name,
     },
   }
 }
 
-function resolveEnabledStyles(
-  blockType: BlockSchemaType,
-): TitledListValue<string>[] {
+function resolveEnabledStyles(blockType: BlockSchemaType): ReadonlyArray<{
+  name: string
+  title?: string
+}> {
   const styleField = blockType.fields.find(isBlockStyleObjectField)
   if (!styleField) {
     throw new Error(
@@ -92,24 +108,30 @@ function resolveEnabledStyles(
 
 function resolveEnabledAnnotationTypes(
   spanType: SpanSchemaType,
-): ResolvedAnnotationType[] {
+): ReadonlyArray<{
+  name: string
+  title?: string
+}> {
   return spanType.annotations.map((annotation) => ({
+    name: annotation.name,
     title: annotation.title,
-    type: annotation,
-    value: annotation.name,
-    icon: annotation.icon,
   }))
 }
 
-function resolveEnabledDecorators(
-  spanType: SpanSchemaType,
-): TitledListValue<string>[] {
-  return spanType.decorators
+function resolveEnabledDecorators(spanType: SpanSchemaType): ReadonlyArray<{
+  name: string
+  title?: string
+}> {
+  return spanType.decorators.map((decorator) => ({
+    name: decorator.value,
+    title: decorator.title,
+  }))
 }
 
-function resolveEnabledListItems(
-  blockType: BlockSchemaType,
-): I18nTitledListValue<string>[] {
+function resolveEnabledListItems(blockType: BlockSchemaType): ReadonlyArray<{
+  name: string
+  title?: string
+}> {
   const listField = blockType.fields.find(isBlockListObjectField)
   if (!listField) {
     throw new Error(
@@ -129,13 +151,24 @@ function resolveEnabledListItems(
 
 function getTitledListValuesFromEnumListOptions(
   options: EnumListProps<string> | undefined,
-): I18nTitledListValue<string>[] {
+): ReadonlyArray<{
+  name: string
+  title?: string
+}> {
   const list = options ? options.list : undefined
   if (!Array.isArray(list)) {
     return []
   }
 
-  return list.map((item) =>
-    isTitledListValue(item) ? item : {title: item, value: item},
-  )
+  return list.map((item) => {
+    if (isTitledListValue(item)) {
+      return {
+        name: item.value ?? item.title,
+        title: item.title,
+      }
+    }
+    return {
+      name: item,
+    }
+  })
 }