@sanity/assist 4.2.0 → 4.3.0

package/src/fieldActions/useUserInput.ts

@@ -0,0 +1,107 @@
+import {useRunInstruction} from '../assistLayout/RunInstructionProvider'
+
+export type GetUserInput = (args: {
+  /**
+   * Dialog title
+   */
+  title: string
+  /**
+   * One titled input per array item
+   */
+  inputs: CustomInput[]
+}) => Promise<CustomInputResult[] | undefined>
+
+/**
+ *
+ */
+export interface CustomInput {
+  /**
+   * Id for the input
+   */
+  id: string
+  /**
+   * Title of the input field
+   */
+  title: string
+  /**
+   * Additional info that will be displayed over the input
+   */
+  description?: string
+}
+
+export type CustomInputResult = {
+  /**
+   * Identifies which custom input the `result`belongs to
+   */
+  input: CustomInput
+
+  /**
+   * The text provided by the user in the input
+   */
+  result: string
+}
+
+/**
+ * `useUserInput` returns a function that can be used to await user input.
+ *
+ * Useful for custom `fieldActions` to get user input for populating Agent Action requests,.
+ *
+ * ```ts
+ *  fieldActions: {
+ *   useFieldActions: (props) => {
+ *     const {
+ *       documentSchemaType,
+ *       schemaId,
+ *       getDocumentValue,
+ *       getConditionalPaths,
+ *       documentIdForAction,
+ *     } = props
+ *     const client = useClient({apiVersion: 'vX'})
+ *     const getUserInput = useUserInput()
+ *     return useMemo(() => {
+ *       return [
+ *         defineAssistFieldAction({
+ *           title: 'Log user input',
+ *           icon: UserIcon,
+ *           onAction: async () => {
+ *             const input = await getUserInput({
+ *               title: 'Topic',
+ *               inputs: [{id: 'about', title: 'What should the article be about?'}],
+ *             })
+ *             if (!input) return // user canceled input
+ *             await client.agent.action.generate({
+ *               schemaId,
+ *               targetDocument: {
+ *                 operation: 'createIfNotExists',
+ *                 _id: documentIdForAction,
+ *                 _type: documentSchemaType.name,
+ *                 initialValues: getDocumentValue(),
+ *               },
+ *               instruction: `
+ *                   Create a document about the following topic:
+ *                   $about
+ *                   ---
+ *                `,
+ *               instructionParams: {about: input[0].result},
+ *               conditionalPaths: {paths: getConditionalPaths()},
+ *             })
+ *           },
+ *         }),
+ *       ]
+ *     }, [
+ *       client,
+ *       documentSchemaType,
+ *       schemaId,
+ *       getDocumentValue,
+ *       getConditionalPaths,
+ *       documentIdForAction,
+ *       getUserInput,
+ *     ])
+ *   },
+ * }
+ * ```
+ */
+export function useUserInput(): GetUserInput {
+  const {getUserInput} = useRunInstruction()
+  return getUserInput
+}

package/src/index.ts

@@ -5,3 +5,20 @@ export {defaultLanguageOutputs} from './translate/paths'
 export * from './translate/types'
 export {contextDocumentTypeName} from './types'
 export * from './assistTypes'
+
+export {
+  type AssistFieldActionProps,
+  type AssistFieldActionGroup,
+  type AssistFieldActionItem,
+  type AssistFieldActionNode,
+  defineAssistFieldAction,
+  defineFieldActionDivider,
+  defineAssistFieldActionGroup,
+} from './fieldActions/customFieldActions'
+
+export {
+  type GetUserInput,
+  type CustomInput,
+  type CustomInputResult,
+  useUserInput,
+} from './fieldActions/useUserInput'

package/src/plugin.tsx

@@ -21,6 +21,7 @@ import {createAssistDocumentPresence} from './presence/AssistDocumentPresence'
 import {schemaTypes} from './schemas'
 import {TranslationConfig} from './translate/types'
 import {assistDocumentTypeName, AssistPreset} from './types'
+import {AssistFieldActionNode, AssistFieldActionProps} from './fieldActions/customFieldActions'
 
 export interface AssistPluginConfig {
   translate?: TranslationConfig
@@ -30,6 +31,11 @@ export interface AssistPluginConfig {
    */
   assist?: AssistConfig
 
+  fieldActions?: {
+    title?: string
+    useFieldActions?: (props: AssistFieldActionProps) => AssistFieldActionNode[]
+  }
+
   /**
    * @internal
    */

package/src/presence/AssistDocumentPresence.tsx

@@ -13,9 +13,9 @@ export function createAssistDocumentPresence(documentId: string | undefined) {
 }
 
 function AssistDocumentPresence() {
-  const {assistDocument} = useAssistDocumentContext()
+  const {assistDocument, syntheticTasks} = useAssistDocumentContext()
   const anyPresence = useMemo(() => {
-    const anyPresence = assistDocument?.tasks
+    const anyPresence = [...(assistDocument?.tasks ?? []), ...(syntheticTasks ?? [])]
       ?.filter((run) => !run.ended && !run.reason)
       ?.flatMap((run) => run.presence ?? [])
       .find((f) => f.started && new Date().getTime() - new Date(f.started).getTime() < 30000)
@@ -36,7 +36,7 @@ function AssistDocumentPresence() {
           [],
         )
       : undefined
-  }, [assistDocument?.tasks])
+  }, [assistDocument?.tasks, syntheticTasks])
 
   return (
     <Card>