@sanity/assist 4.3.0 → 4.3.1

package/README.md

@@ -953,18 +953,20 @@ or other custom actions into the AI Assist document and field action menus, use
 
 ```ts
 assist({
-  title: 'Custom actions',
-  useFieldActions: (props: AssistFieldActionProps) => {
-    return useMemo(() => [
-      defineAssistFieldAction({
-        title: 'Do something',
-        icon: ActionIcon,
-        onAction: async () => {
-          // perform an (async) action
-          // errors will be caught and displayed in a toast
-          // until the action completes or fails, AI Assist "presence" will show up on the top of the document
-        },  
-    })], [])
+  fieldActions: {
+    title: 'Custom actions',
+    useFieldActions: (props: AssistFieldActionProps) => {
+      return useMemo(() => [
+        defineAssistFieldAction({
+          title: 'Do something',
+          icon: ActionIcon,
+          onAction: async () => {
+            // perform an (async) action
+            // errors will be caught and displayed in a toast
+            // until the action completes or fails, AI Assist "presence" will show up on the top of the document
+          },
+        })], [])
+    }
   }
 })
 ```
@@ -989,46 +991,49 @@ It will fix spelling mistakes for the field it is invoked for (and all child fie
 by calling `client.agent.action.transform`.
 
 ```ts
-assist({
-  title: 'Custom actions',
-  useFieldActions: (props) => {
-    const {
-      documentSchemaType,
-      schemaId,
-      getDocumentValue,
-      getConditionalPaths,
-      documentIdForAction,
-      path,
-    } = props
-    const client = useClient({apiVersion: 'vX'})
-    return useMemo(() => {
-      return [
-        defineAssistFieldAction({
-          title: 'Fix spelling',
-          icon: TranslateIcon,
-          onAction: async () => {
-            await client.agent.action.transform({
-              schemaId,
-              documentId: documentIdForAction,
-              instruction: 'Fix any spelling mistakes',
-              instructionParams: {field: {type: 'field', path}},
-              // no need to send path for document actions
-              target: path.length ? {path} : undefined,
-              conditionalPaths: {paths: getConditionalPaths()},
-            })
-          },
-        }),
-      ]
-    }, [
-      client,
-      documentSchemaType,
-      schemaId,
-      getDocumentValue,
-      getConditionalPaths,
-      documentIdForAction,
-      path,
-    ])
-  }})
+ assist({
+  fieldActions: {
+    title: 'Custom actions',
+    useFieldActions: (props) => {
+      const {
+        documentSchemaType,
+        schemaId,
+        getDocumentValue,
+        getConditionalPaths,
+        documentIdForAction,
+        path,
+      } = props
+      const client = useClient({apiVersion: 'vX'})
+      return useMemo(() => {
+        return [
+          defineAssistFieldAction({
+            title: 'Fix spelling',
+            icon: TranslateIcon,
+            onAction: async () => {
+              await client.agent.action.transform({
+                schemaId,
+                documentId: documentIdForAction,
+                instruction: 'Fix any spelling mistakes',
+                instructionParams: {field: {type: 'field', path}},
+                // no need to send path for document actions
+                target: path.length ? {path} : undefined,
+                conditionalPaths: {paths: getConditionalPaths()},
+              })
+            },
+          }),
+        ]
+      }, [
+        client,
+        documentSchemaType,
+        schemaId,
+        getDocumentValue,
+        getConditionalPaths,
+        documentIdForAction,
+        path,
+      ])
+    },
+  },
+})
 ```
 
 ##### Fill field (contextually aware)
@@ -1042,43 +1047,44 @@ The action will:
 - output to the field the action started from (`target.path`)
 
 ```ts
-assist({
-  title: 'Custom actions',
-  useFieldActions: (props: AssistFieldActionProps) => {
-    const {
-      documentSchemaType,
-      actionType,
-      schemaId,
-      getDocumentValue,
-      getConditionalPaths,
-      documentIdForAction,
-      path,
-      schemaType,
-    } = props
-
-    // hook usage has to happen outside onAction, so preassemble state in useFieldActions and pass to useMemo
-    const client = useClient({apiVersion: 'vX'})
-    
-    return useMemo(() => {
-      if (actionType === 'document') {
-        // in this case we dont want a document action
-        return []
-      }
-      
-      return [
-        defineAssistFieldAction({
-          title: 'Fill field',
-          icon: EditIcon,
-          onAction: async () => {
-            await client.agent.action.generate({
-              schemaId,
-              targetDocument: {
-                operation: 'createIfNotExists',
-                _id: documentIdForAction,
-                _type: documentSchemaType.name,
-                initialValues: getDocumentValue(),
-              },
-              instruction: `
+ assist({
+  fieldActions: {
+    title: 'Custom actions',
+    useFieldActions: (props) => {
+      const {
+        documentSchemaType,
+        actionType,
+        schemaId,
+        getDocumentValue,
+        getConditionalPaths,
+        documentIdForAction,
+        path,
+        schemaType,
+      } = props
+
+      // hook usage has to happen outside onAction, so preassemble state in useFieldActions and pass to useMemo
+      const client = useClient({apiVersion: 'vX'})
+
+      return useMemo(() => {
+        if (actionType === 'document') {
+          // in this case we dont want a document action
+          return []
+        }
+
+        return [
+          defineAssistFieldAction({
+            title: 'Fill field',
+            icon: EditIcon,
+            onAction: async () => {
+              await client.agent.action.generate({
+                schemaId,
+                targetDocument: {
+                  operation: 'createIfNotExists',
+                  _id: documentIdForAction,
+                  _type: documentSchemaType.name,
+                  initialValues: getDocumentValue(),
+                },
+                instruction: `
                         We are generating a new value for a document field.
                         The document type is ${documentSchemaType.name}, and the document type title is ${documentSchemaType.title}
                         The document language is: "$lang" (use en-US if unspecified)
@@ -1093,33 +1099,34 @@ assist({
                         Generate a new field value. The new value should be relevant to the document type and context.
                         Keep it interesting. Generate using the document language.
                      `,
-              instructionParams: {
-                doc: {type: 'document'},
-                field: {type: 'field', path},
-                lang: {type: 'field', path: ['language']},
-              },
-              target: {
-                path,
-              },
-              conditionalPaths: {
-                paths: getConditionalPaths(),
-              },
-            })
-          },
-        })
+                instructionParams: {
+                  doc: {type: 'document'},
+                  field: {type: 'field', path},
+                  lang: {type: 'field', path: ['language']},
+                },
+                target: {
+                  path,
+                },
+                conditionalPaths: {
+                  paths: getConditionalPaths(),
+                },
+              })
+            },
+          }),
         ]
-    }, [
-      client,
-      documentSchemaType,
-      schemaId,
-      getDocumentValue,
-      getConditionalPaths,
-      documentIdForAction,
-      actionType,
-      path,
-      schemaType,
-    ])
-  }
+      }, [
+        client,
+        documentSchemaType,
+        schemaId,
+        getDocumentValue,
+        getConditionalPaths,
+        documentIdForAction,
+        actionType,
+        path,
+        schemaType,
+      ])
+    },
+  },
 })
 ```
 
@@ -1147,20 +1154,17 @@ Adds a group to hold one or more actions (or nested groups).
 
 By default, any actions returned by `useFieldActions` will be grouped under `title`.
 ```ts
-assist({
-  title: 'Default group',
-  useFieldActions: (props) => {
-    return [
-      defineAssistFieldAction({/* ... */}), 
-      defineAssistFieldActionGroup({
-        title: 'More actions',
-        children: [
-          defineAssistFieldAction({/* ... */}),
-        ],
-      })
-    ]
-  }
-})
+useFieldActions: (props) => {
+  return [
+    defineAssistFieldAction({/* ... */}), 
+    defineAssistFieldActionGroup({
+      title: 'More actions',
+      children: [
+        defineAssistFieldAction({/* ... */}),
+      ],
+    })
+  ]
+}
 ```
 
 #### Only groups in `useFieldActions`
@@ -1170,16 +1174,14 @@ If `useFieldActions` _only_ returns groups, the default wrapper group will be om
 Adds a divider between actions or groups. Takes no arguments:
 
 ```ts
-assist({
-  title: 'Custom actions',
-  useFieldActions: (props) => {
-    return useMemo(() => [
-      defineAssistFieldAction({/* ... */}),
-      defineFieldActionDivider(),
-      defineAssistFieldAction({/* ... */}),
-    ], [])
-  }
-})
+
+useFieldActions: (props) => {
+  return useMemo(() => [
+    defineAssistFieldAction({/* ... */}),
+    defineFieldActionDivider(),
+    defineAssistFieldAction({/* ... */}),
+  ], [])
+}
 ```
 
 ### `useUserInput`
@@ -1196,39 +1198,44 @@ When the user completes the dialog, the user inputted text will be available (or
 
 
 ```ts
-assist({
-  title: 'Custom actions',
-  useFieldActions: (props: AssistFieldActionProps) => {
-    const getUserInput = useUserInput()
-    
-    return useMemo(() => [
-      defineAssistFieldAction({
-        title: 'Do something with user input',
-        icon: ActionIcon,
-        onAction: async () => {
-          const inputResult = await getUserInput({
-            title: 'What do you want to do?', // dialog title
-            inputs: [
-              {
-                id: 'topic',
-                title: 'Topic',
-              },
-              {
-                id: 'facts',
-                title: 'Facts',
-                description: 'Provide additional facts that will be used by the action'
-              },
-            ],
-          })
-          if(!inputResult) {
-            return // user closed the dialog
-          }
-
-          //use the result from each input
-          //const [{result: topic}, {result: facts}] = inputResult
-        },
-    })], [getUserInput])
-  }
+({
+  fieldActions: {
+    title: 'Custom actions',
+    useFieldActions: (props) => {
+      const getUserInput = useUserInput()
+
+      return useMemo(
+        () => [
+          defineAssistFieldAction({
+            title: 'Do something with user input',
+            onAction: async () => {
+              const inputResult = await getUserInput({
+                title: 'What do you want to do?', // dialog title
+                inputs: [
+                  {
+                    id: 'topic',
+                    title: 'Topic',
+                  },
+                  {
+                    id: 'facts',
+                    title: 'Facts',
+                    description: 'Provide additional facts that will be used by the action',
+                  },
+                ],
+              })
+              if (!inputResult) {
+                return // user closed the dialog
+              }
+
+              //use the result from each input
+              //const [{result: topic}, {result: facts}] = inputResult
+            },
+          }),
+        ],
+        [getUserInput],
+      )
+    },
+  },
 })
 ```
 

package/dist/index.d.mts

@@ -451,6 +451,14 @@ declare type InlinePromptBlock = PortableTextSpan | FieldRef | UserInputBlock |
 
 declare const instructionContextTypeName: 'sanity.assist.instruction.context'
 
+/**
+ * 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 declare function isType(schemaType: SchemaType, typeName: string): boolean
+
 export declare interface Language {
   id: string
   title?: string

package/dist/index.d.ts

@@ -451,6 +451,14 @@ declare type InlinePromptBlock = PortableTextSpan | FieldRef | UserInputBlock |
 
 declare const instructionContextTypeName: 'sanity.assist.instruction.context'
 
+/**
+ * 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 declare function isType(schemaType: SchemaType, typeName: string): boolean
+
 export declare interface Language {
   id: string
   title?: string

package/dist/index.esm.js

@@ -4236,6 +4236,7 @@ export {
   defineAssistFieldAction,
   defineAssistFieldActionGroup,
   defineFieldActionDivider,
+  isType,
   useUserInput
 };
 //# sourceMappingURL=index.esm.js.map