@sanity/assist 4.1.0 → 4.2.0

package/README.md

@@ -407,6 +407,16 @@ The **Generate image description** action will automatically run whenever the im
 `imageDescriptionField` can be a nested field, if the image has an object field, i.e. `imageDescriptionField: 'wrapper.altText'`.
 Fields within array items are not supported.
 
+By default, the caption field will regenerate whenever the image asset changes. To disable this behavior use the following configuration:
+```ts
+{
+  imageDescriptionField: {
+    path: 'wrapper.altText',
+      updateOnImageChange: false
+  }
+}
+```
+
 ## Image generation
 
 <img width="600" alt="image" src="https://github.com/sanity-io/assist/assets/835514/c4de6791-f530-4cd1-b0c2-96ef988bc256">

package/dist/index.d.mts

@@ -474,7 +474,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 {}

package/dist/index.d.ts

@@ -474,7 +474,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 {}

package/dist/index.esm.js

@@ -221,7 +221,16 @@ function isImage(schemaType) {
   return isType(schemaType, "image");
 }
 function getDescriptionFieldOption(schemaType) {
-  return schemaType ? schemaType.options?.aiAssist?.imageDescriptionField || getDescriptionFieldOption(schemaType.type) : void 0;
+  if (!schemaType)
+    return;
+  const descriptionField = schemaType.options?.aiAssist?.imageDescriptionField;
+  return typeof descriptionField == "string" ? {
+    path: descriptionField,
+    updateOnImageChange: !0
+  } : descriptionField ? {
+    path: descriptionField.path,
+    updateOnImageChange: descriptionField.updateOnImageChange ?? !0
+  } : getDescriptionFieldOption(schemaType.type);
 }
 function getImageInstructionFieldOption(schemaType) {
   return schemaType ? schemaType.options?.aiAssist?.imageInstructionField || getImageInstructionFieldOption(schemaType.type) : void 0;
@@ -2574,8 +2583,8 @@ function ImageContextProvider(props) {
   ), isShowingOlderRevision = !!usePaneRouter().params?.rev;
   useEffect(() => {
     const descriptionField = getDescriptionFieldOption(schemaType);
-    assetRef && assistableDocumentId && descriptionField && assetRef !== assetRefState && !isSyncing && !isShowingOlderRevision && !readOnly && (setAssetRefState(assetRef), canUseAssist(status) && generateCaption({
-      path: pathToString([...path, descriptionField]),
+    assetRef && assistableDocumentId && descriptionField?.updateOnImageChange && assetRef !== assetRefState && !isSyncing && !isShowingOlderRevision && !readOnly && (setAssetRefState(assetRef), canUseAssist(status) && generateCaption({
+      path: pathToString([...path, descriptionField.path]),
       documentId: assistableDocumentId
     }));
   }, [
@@ -2593,7 +2602,7 @@ function ImageContextProvider(props) {
   const context = useMemo(() => {
     const descriptionField = getDescriptionFieldOption(schemaType), imageInstructionField = getImageInstructionFieldOption(schemaType);
     return {
-      imageDescriptionPath: descriptionField ? pathToString([...path, descriptionField]) : void 0,
+      imageDescriptionPath: descriptionField?.path ? pathToString([...path, descriptionField.path]) : void 0,
       imageInstructionPath: imageInstructionField ? pathToString([...path, imageInstructionField]) : void 0,
       assetRef
     };