@sanity/assist 4.3.2 → 4.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/assist",
-  "version": "4.3.2",
+  "version": "4.4.1",
   "description": "You create the instructions; Sanity AI Assist does the rest.",
   "keywords": [
     "sanity",
@@ -65,7 +65,7 @@
     "@rollup/plugin-image": "^3.0.3",
     "@sanity/pkg-utils": "^6.13.4",
     "@sanity/plugin-kit": "^3.1.10",
-    "@sanity/schema": "^3.91.0",
+    "@sanity/schema": "^3.93.0",
     "@sanity/semantic-release-preset": "^4.1.7",
     "@types/lodash": "^4.17.0",
     "@types/lodash-es": "^4.17.12",
@@ -83,7 +83,7 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "rimraf": "^5.0.5",
-    "sanity": "^3.91.0",
+    "sanity": "^3.93.0",
     "semantic-release": "^23.0.8",
     "styled-components": "^6.1.16",
     "typescript": "^5.7.2",

package/src/assistDocument/AssistDocumentContext.tsx

@@ -2,6 +2,7 @@ import {createContext, useContext} from 'react'
 import {DocumentInspector, ObjectSchemaType, PatchEvent} from 'sanity'
 
 import {InstructionTask, StudioAssistDocument} from '../types'
+import {FieldRef} from '../assistInspector/helpers'
 
 export type AssistDocumentContextValue = (
   | {assistDocument: StudioAssistDocument; loading: false}
@@ -32,6 +33,9 @@ export type AssistDocumentContextValue = (
   syntheticTasks?: InstructionTask[]
   addSyntheticTask: (syntheticTask: InstructionTask) => void
   removeSyntheticTask: (syntheticTask: InstructionTask) => void
+
+  fieldRefs: FieldRef[]
+  fieldRefsByTypePath: Record<string, FieldRef | undefined>
 }
 
 export const AssistDocumentContext = createContext<AssistDocumentContextValue | undefined>(

package/src/assistDocument/hooks/useAssistDocumentContextValue.tsx

@@ -2,7 +2,7 @@ import {useCallback, useEffect, useMemo, useState} from 'react'
 import {getDraftId, getVersionId, type ObjectSchemaType, useSchema} from 'sanity'
 import {useDocumentPane} from 'sanity/structure'
 
-import {useAiPaneRouter} from '../../assistInspector/helpers'
+import {asFieldRefsByTypePath, getFieldRefs, useAiPaneRouter} from '../../assistInspector/helpers'
 import {fieldPathParam, InstructionTask} from '../../types'
 import type {AssistDocumentContextValue} from '../AssistDocumentContext'
 import {isDocAssistable} from '../RequestRunInstructionProvider'
@@ -53,6 +53,10 @@ export function useAssistDocumentContextValue(documentId: string, documentType:
   })
   const {syntheticTasks, addSyntheticTask, removeSyntheticTask} =
     useSyntheticTasks(assistableDocumentId)
+
+  const fieldRefs = getFieldRefs(documentSchemaType)
+  const fieldRefsByTypePath = asFieldRefsByTypePath(fieldRefs)
+
   const value: AssistDocumentContextValue = useMemo(() => {
     const base = {
       assistableDocumentId,
@@ -67,6 +71,8 @@ export function useAssistDocumentContextValue(documentId: string, documentType:
       syntheticTasks,
       addSyntheticTask,
       removeSyntheticTask,
+      fieldRefs,
+      fieldRefsByTypePath,
     }
     if (!assistDocument) {
       return {...base, loading: true, assistDocument: undefined}

package/src/assistInspector/helpers.ts

@@ -57,6 +57,14 @@ export function getTypeIcon(schemaType: SchemaType) {
   return DocumentIcon
 }
 
+export function asFieldRefsByTypePath(fieldRefs: FieldRef[]): Record<string, FieldRef | undefined> {
+  const lookup: Record<string, FieldRef | undefined> = fieldRefs.reduce(
+    (acc, ref) => ({...acc, [ref.key]: ref}),
+    {},
+  )
+  return lookup
+}
+
 export function getFieldRefsWithDocument(schemaType: ObjectSchemaType): FieldRef[] {
   const fields = getFieldRefs(schemaType)
   return [

package/src/assistLayout/RunInstructionProvider.tsx

@@ -75,6 +75,7 @@ export function RunInstructionProvider(props: PropsWithChildren<{}>) {
       message: input.title,
       description: input.description,
     }))
+
     if (!userInputBlocks.length) {
       return undefined
     }

package/src/fieldActions/assistFieldActions.tsx

@@ -4,6 +4,7 @@ import {
   type DocumentFieldAction,
   type DocumentFieldActionGroup,
   type DocumentFieldActionItem,
+  pathToString,
   stringToPath,
   typed,
   useCurrentUser,
@@ -14,7 +15,7 @@ import {useAssistDocumentContext} from '../assistDocument/AssistDocumentContext'
 import {getIcon} from '../assistDocument/components/instruction/appearance/IconInput'
 import {useRequestRunInstruction} from '../assistDocument/RequestRunInstructionProvider'
 import {aiInspectorId} from '../assistInspector/constants'
-import {useSelectedField, useTypePath} from '../assistInspector/helpers'
+import {getTypePath, useSelectedField, useTypePath} from '../assistInspector/helpers'
 import {pluginTitleShort} from '../constants'
 import {isSchemaAssistEnabled} from '../helpers/assistSupported'
 import {getConditionalMembers} from '../helpers/conditionalMembers'
@@ -48,6 +49,7 @@ export const assistFieldActions: DocumentFieldAction = {
       documentSchemaType,
       selectedPath,
       assistableDocumentId,
+      fieldRefsByTypePath,
     } = useAssistDocumentContext()
 
     const {value: docValue, formState} = useDocumentPane()
@@ -204,6 +206,17 @@ export const assistFieldActions: DocumentFieldAction = {
       )
     }, [])
 
+    const parentSchemaType = useMemo(() => {
+      if (!props.path.length) {
+        return undefined
+      } else if (props.path.length === 1) {
+        return documentSchemaType
+      }
+      const parentPath = props.path.slice(0, -1)
+      const typePath = getTypePath(docValueRef.current, pathToString(parentPath))
+      return typePath ? fieldRefsByTypePath[typePath]?.schemaType : undefined
+    }, [fieldRefsByTypePath, props.path, documentSchemaType])
+
     const customActions = useCustomFieldActions({
       actionType: props.path.length ? 'field' : 'document',
       documentIdForAction: assistableDocumentId,
@@ -212,6 +225,7 @@ export const assistFieldActions: DocumentFieldAction = {
       path: props.path,
       getDocumentValue,
       getConditionalPaths,
+      parentSchemaType,
     })
 
     const manageInstructionsItem = useMemo(

package/src/fieldActions/customFieldActions.tsx

@@ -92,6 +92,8 @@ export interface AssistFieldActionProps {
    *   },
    *   //...
    * })
+   *
+   * ```
    */
   schemaId: string
 
@@ -142,6 +144,16 @@ export interface AssistFieldActionProps {
    * ```
    */
   schemaType: SchemaType
+
+  /**
+   * Schema type of the parent field or array item holding this field.
+   *
+   * This can be undefined if the action was unable to resolve the parent type is excluded from AI Assist.
+   *
+   * @see schemaType
+   * @see documentSchemaType
+   */
+  parentSchemaType?: SchemaType
 }
 
 export type AssistFieldActionNode =

package/src/helpers/assistSupported.ts

@@ -23,7 +23,11 @@ export function isAssistSupported(type: SchemaType) {
 
   if (type.jsonType === 'object') {
     const unsupportedObject = type.fields.every((field) => isDisabled(field.type))
-    return !unsupportedObject
+    return (
+      !unsupportedObject ||
+      /* to allow attaching custom actions on fieldless images */
+      isType(type, 'image')
+    )
   }
   return true
 }

package/src/schemas/serialize/serializeSchema.test.ts

@@ -123,7 +123,7 @@ describe('serializeSchema', () => {
     expect(serializedTypes).toEqual([])
   })
 
-  test('should not serialize excluded fields or types or types with every member excluded', () => {
+  test('should not serialize excluded fields or types or types with every member excluded (except images)', () => {
     const options: AssistOptions = {aiAssist: {exclude: true}}
 
     const schema = Schema.compile({
@@ -131,7 +131,7 @@ describe('serializeSchema', () => {
       types: [
         {
           type: 'document',
-          name: 'allFieldsExcluded',
+          name: 'mostFieldsExcluded',
           fields: [
             defineField({type: 'string', name: 'title', options}),
             defineField({
@@ -148,7 +148,7 @@ describe('serializeSchema', () => {
               of: [{type: 'object', name: 'remove', options}, {type: 'excluded'}],
               options: {aiAssist: {exclude: true}},
             }),
-            //image without extra fields should be excluded
+            //image without extra fields should NOT be excluded
             defineField({type: 'image', name: 'image'}),
             defineField({type: 'file', name: 'file'}),
             defineField({type: 'reference', name: 'reference', to: [{type: 'excluded'}]}),
@@ -174,7 +174,21 @@ describe('serializeSchema', () => {
     const serializedTypes = serializeSchema(schema, {leanFormat: true})
 
     //everything excluded directly or indirectly
-    expect(serializedTypes).toEqual([])
+    expect(serializedTypes).toEqual([
+      {
+        fields: [
+          {
+            fields: [],
+            name: 'image',
+            title: 'Image',
+            type: 'image',
+          },
+        ],
+        name: 'mostFieldsExcluded',
+        title: 'Most Fields Excluded',
+        type: 'document',
+      },
+    ])
   })
 
   test('should serialize opt-in inline object using custom typeName', () => {

package/src/types.ts

@@ -74,7 +74,7 @@ export interface PresetInstruction {
 
   title?: string
   /**
-   * String key from @sanity/icons IconMap
+   * String key from `@sanity/icons` IconMap
    */
   icon?: string