@sanity/assist 4.3.2 → 4.4.0

package/README.md

@@ -999,6 +999,9 @@ prop can be used to parameterize Agent Actions on sanity client.
 
 #### Agent Action examples
 
+Below are some examples of agent action integration.
+For more, see [HOW-TO_USE](../studio/examples/agentActions/HOW-TO-USE.md)
+
 ##### Fix spelling
 
 The following example adds a "Fix spelling" action to all fields and the document itself.

package/dist/index.d.mts

@@ -157,6 +157,8 @@ export declare interface AssistFieldActionProps {
    *   },
    *   //...
    * })
+   *
+   * ```
    */
   schemaId: string
   /**
@@ -205,6 +207,15 @@ export declare interface AssistFieldActionProps {
    * ```
    */
   schemaType: SchemaType_2
+  /**
+   * 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_2
 }
 
 export declare interface AssistOptions {
@@ -532,7 +543,7 @@ declare interface PresetInstruction {
   prompt?: PromptTextBlock[]
   title?: string
   /**
-   * String key from @sanity/icons IconMap
+   * String key from `@sanity/icons` IconMap
    */
   icon?: string
   /**

package/dist/index.d.ts

@@ -157,6 +157,8 @@ export declare interface AssistFieldActionProps {
    *   },
    *   //...
    * })
+   *
+   * ```
    */
   schemaId: string
   /**
@@ -205,6 +207,15 @@ export declare interface AssistFieldActionProps {
    * ```
    */
   schemaType: SchemaType_2
+  /**
+   * 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_2
 }
 
 export declare interface AssistOptions {
@@ -532,7 +543,7 @@ declare interface PresetInstruction {
   prompt?: PromptTextBlock[]
   title?: string
   /**
-   * String key from @sanity/icons IconMap
+   * String key from `@sanity/icons` IconMap
    */
   icon?: string
   /**

package/dist/index.esm.js

@@ -400,6 +400,12 @@ function getTypeIcon(schemaType) {
   }
   return isType(schemaType, "slug") ? LinkIcon : isType(schemaType, "image") ? ImageIcon : schemaType.jsonType === "array" && isPortableTextArray(schemaType) ? BlockContentIcon : schemaType.jsonType === "array" ? OlistIcon : schemaType.jsonType === "object" ? BlockquoteIcon : schemaType.jsonType === "string" ? StringIcon : DocumentIcon;
 }
+function asFieldRefsByTypePath(fieldRefs) {
+  return fieldRefs.reduce(
+    (acc, ref) => ({ ...acc, [ref.key]: ref }),
+    {}
+  );
+}
 function getFieldRefsWithDocument(schemaType) {
   const fields = getFieldRefs(schemaType);
   return [
@@ -1029,7 +1035,7 @@ function useAssistDocumentContextValue(documentId, documentType) {
   } = useDocumentPane(), { draft, published, version } = editState || {}, assistableDocumentId = selectedReleaseId ? getVersionId(documentId, selectedReleaseId) : documentSchemaType.liveEdit ? documentId : getDraftId(documentId), documentIsNew = selectedReleaseId ? !version?._id : !draft?._id && !published?._id, documentIsAssistable = selectedReleaseId ? !!version : isDocAssistable(documentSchemaType, published, draft), { params } = useAiPaneRouter(), selectedPath = params[fieldPathParam], assistDocument = useStudioAssistDocument({
     documentId: assistableDocumentId,
     schemaType: documentSchemaType
-  }), { syntheticTasks, addSyntheticTask, removeSyntheticTask } = useSyntheticTasks(assistableDocumentId);
+  }), { syntheticTasks, addSyntheticTask, removeSyntheticTask } = useSyntheticTasks(assistableDocumentId), fieldRefs = getFieldRefs(documentSchemaType), fieldRefsByTypePath = asFieldRefsByTypePath(fieldRefs);
   return useMemo(() => {
     const base = {
       assistableDocumentId,
@@ -1043,7 +1049,9 @@ function useAssistDocumentContextValue(documentId, documentType) {
       selectedPath,
       syntheticTasks,
       addSyntheticTask,
-      removeSyntheticTask
+      removeSyntheticTask,
+      fieldRefs,
+      fieldRefsByTypePath
     };
     return assistDocument ? {
       ...base,
@@ -2959,7 +2967,8 @@ const assistFieldActions = {
       documentOnChange,
       documentSchemaType,
       selectedPath,
-      assistableDocumentId
+      assistableDocumentId,
+      fieldRefsByTypePath
     } = useAssistDocumentContext(), { value: docValue, formState } = useDocumentPane(), docValueRef = useRef(docValue), formStateRef = useRef(formState);
     formStateRef.current = formState;
     const currentUser = useCurrentUser(), isHidden = !assistDocument, pathKey = usePathKey(props.path), typePath = useTypePath(docValue, pathKey), assistDocumentId2 = assistDocument?._id, { requestRunInstruction } = useRequestRunInstruction({
@@ -3047,14 +3056,22 @@ const assistFieldActions = {
           path
         };
       }
-    ), []), customActions = useCustomFieldActions({
+    ), []), parentSchemaType = useMemo(() => {
+      if (props.path.length) {
+        if (props.path.length === 1)
+          return documentSchemaType;
+      } else return;
+      const parentPath = props.path.slice(0, -1), typePath2 = getTypePath(docValueRef.current, pathToString(parentPath));
+      return typePath2 ? fieldRefsByTypePath[typePath2]?.schemaType : void 0;
+    }, [fieldRefsByTypePath, props.path, documentSchemaType]), customActions = useCustomFieldActions({
       actionType: props.path.length ? "field" : "document",
       documentIdForAction: assistableDocumentId,
       schemaType,
       documentSchemaType,
       path: props.path,
       getDocumentValue,
-      getConditionalPaths
+      getConditionalPaths,
+      parentSchemaType
     }), manageInstructionsItem = useMemo(
       () => ({
         type: "action",