@sanity/assist 4.3.0 → 4.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/assist",
-  "version": "4.3.0",
+  "version": "4.3.2",
   "description": "You create the instructions; Sanity AI Assist does the rest.",
   "keywords": [
     "sanity",

package/src/fieldActions/customFieldActions.tsx

@@ -20,6 +20,7 @@ import {
   instructionTaskTypeName,
 } from '../types'
 import {randomKey} from '../_lib/randomKey'
+import {isDefined} from '../helpers/misc'
 
 export interface AgentActionConditionalPath {
   path: AgentActionPath
@@ -159,7 +160,11 @@ export type AssistFieldActionGroup = Omit<
   DocumentFieldActionGroup,
   'renderAsButton' | 'expanded' | 'children'
 > & {
-  children: AssistFieldActionNode[]
+  /**
+   * `children` can include undefined entries in the action array. These will be filtered out.
+   * If the group has no defined children, the group will also be filtered out.
+   */
+  children: (AssistFieldActionNode | undefined)[]
 }
 
 type PushToast = (params: ToastParams) => string
@@ -206,14 +211,17 @@ export function useCustomFieldActions(
 
   return useMemo(() => {
     const title = fieldActions?.title
-    const customActions = configActions?.map((node) => {
-      return createSafeNode({
-        node,
-        pushToast,
-        addSyntheticTask,
-        removeSyntheticTask,
+    const customActions = configActions
+      ?.filter(isDefined)
+      .map((node) => {
+        return createSafeNode({
+          node,
+          pushToast,
+          addSyntheticTask,
+          removeSyntheticTask,
+        })
       })
-    })
+      .filter(isDefined)
     const onlyGroups =
       customActions?.length && customActions?.every((node) => node.type === 'group')
     const groups = customActions?.length
@@ -237,17 +245,25 @@ function createSafeNode(args: {
   pushToast: PushToast
   addSyntheticTask: (task: InstructionTask) => void
   removeSyntheticTask: (task: InstructionTask) => void
-}): DocumentFieldActionNode {
+}): DocumentFieldActionNode | undefined {
   const {node} = args
   switch (node.type) {
     case 'action':
       return createSafeAction({...args, action: node})
     case 'group':
+      // eslint-disable-next-line no-case-declarations
+      const children = node.children
+        ?.filter(isDefined)
+        .map((child) => createSafeNode({...args, node: child}))
+        .filter(isDefined)
+      if (!children?.length) {
+        return undefined
+      }
       return {
         ...node,
         renderAsButton: false,
         expanded: true,
-        children: node.children?.map((child) => createSafeNode({...args, node: child})),
+        children,
       }
     case 'divider':
     default:

package/src/helpers/misc.ts

@@ -19,3 +19,7 @@ export function getPathKey(path: Path | string) {
 export function getInstructionTitle(instruction?: StudioInstruction) {
   return instruction?.title ?? 'Untitled'
 }
+
+export function isDefined<T>(t: T | undefined | null): t is T {
+  return t !== undefined && t !== null
+}

package/src/helpers/typeUtils.ts

@@ -4,6 +4,12 @@ export function isPortableTextArray(type: ArraySchemaType) {
   return type.of.find((t) => isType(t, 'block'))
 }
 
+/**
+ * Returns true if the `schemaType` or any of its parent types (`schemaType.type`)` has `name` equal
+ * to `typeName`.
+ *
+ * Useful for checking if `schemaType` is a type alias of `ìmage`, `code` or similar.
+ */
 export function isType(schemaType: SchemaType, typeName: string): boolean {
   if (schemaType.name === typeName) {
     return true

package/src/index.ts

@@ -22,3 +22,5 @@ export {
   type CustomInputResult,
   useUserInput,
 } from './fieldActions/useUserInput'
+
+export {isType} from './helpers/typeUtils'

package/src/plugin.tsx

@@ -33,7 +33,10 @@ export interface AssistPluginConfig {
 
   fieldActions?: {
     title?: string
-    useFieldActions?: (props: AssistFieldActionProps) => AssistFieldActionNode[]
+    /**
+     * The returned array can include `undefined` entries in the action array. These will be filtered out.
+     */
+    useFieldActions?: (props: AssistFieldActionProps) => (AssistFieldActionNode | undefined)[]
   }
 
   /**