@sanity/assist 4.1.0 → 4.2.0

package/package.json

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

package/src/components/ImageContext.tsx

@@ -40,7 +40,7 @@ export function ImageContextProvider(props: InputProps) {
     if (
       assetRef &&
       assistableDocumentId &&
-      descriptionField &&
+      descriptionField?.updateOnImageChange &&
       assetRef !== assetRefState &&
       !isSyncing &&
       !isShowingOlderRevision &&
@@ -49,7 +49,7 @@ export function ImageContextProvider(props: InputProps) {
       setAssetRefState(assetRef)
       if (canUseAssist(status)) {
         generateCaption({
-          path: pathToString([...path, descriptionField]),
+          path: pathToString([...path, descriptionField.path]),
           documentId: assistableDocumentId,
         })
       }
@@ -71,8 +71,8 @@ export function ImageContextProvider(props: InputProps) {
     const descriptionField = getDescriptionFieldOption(schemaType)
     const imageInstructionField = getImageInstructionFieldOption(schemaType)
     return {
-      imageDescriptionPath: descriptionField
-        ? pathToString([...path, descriptionField])
+      imageDescriptionPath: descriptionField?.path
+        ? pathToString([...path, descriptionField.path])
         : undefined,
       imageInstructionPath: imageInstructionField
         ? pathToString([...path, imageInstructionField])

package/src/helpers/typeUtils.ts

@@ -18,13 +18,23 @@ export function isImage(schemaType: SchemaType) {
   return isType(schemaType, 'image')
 }
 
-export function getDescriptionFieldOption(schemaType: SchemaType | undefined): string | undefined {
+export function getDescriptionFieldOption(
+  schemaType: SchemaType | undefined,
+): {path: string; updateOnImageChange: boolean} | undefined {
   if (!schemaType) {
     return undefined
   }
   const descriptionField = (schemaType.options as ImageOptions)?.aiAssist?.imageDescriptionField
-  if (descriptionField) {
-    return descriptionField
+  if (typeof descriptionField === 'string') {
+    return {
+      path: descriptionField,
+      updateOnImageChange: true,
+    }
+  } else if (descriptionField) {
+    return {
+      path: descriptionField.path,
+      updateOnImageChange: descriptionField.updateOnImageChange ?? true,
+    }
   }
   return getDescriptionFieldOption(schemaType.type)
 }

package/src/schemas/typeDefExtensions.ts

@@ -90,7 +90,18 @@ declare module 'sanity' {
        * })
        * ```
        */
-      imageDescriptionField?: string
+      imageDescriptionField?:
+        | string
+        | {
+            path: string
+            /**
+             * When updateOnImageChange is true (or undefined), whenever the
+             * image asset changes, imageDescriptionField will be regenerated.
+             *
+             * default:  true
+             * */
+            updateOnImageChange?: boolean
+          }
     }
   }
   interface NumberOptions extends AssistOptions {}