@assistant-ui/react-hook-form 0.10.0 → 0.10.2

package/dist/formTools.d.ts

@@ -0,0 +1,21 @@
+import { z } from "zod";
+export declare const formTools: {
+    set_form_field: {
+        description: string;
+        parameters: z.ZodObject<{
+            name: z.ZodString;
+            value: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            value: string;
+        }, {
+            name: string;
+            value: string;
+        }>;
+    };
+    submit_form: {
+        description: string;
+        parameters: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+    };
+};
+//# sourceMappingURL=formTools.d.ts.map

package/dist/formTools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"formTools.d.ts","sourceRoot":"","sources":["../src/formTools.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;CAarB,CAAC"}

package/dist/formTools.js

@@ -1,5 +1,6 @@
+// src/formTools.tsx
 import { z } from "zod";
-const formTools = {
+var formTools = {
   set_form_field: {
     description: "Sets a form field. Call this function as soon as the user provides the data for each field.",
     parameters: z.object({

package/dist/formTools.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/formTools.tsx"],"sourcesContent":["import { z } from \"zod\";\n\nexport const formTools = {\n  set_form_field: {\n    description:\n      \"Sets a form field. Call this function as soon as the user provides the data for each field.\",\n    parameters: z.object({\n      name: z.string(),\n      value: z.string(),\n    }),\n  },\n  submit_form: {\n    description: \"Submits the form. Confirm with user before submitting.\",\n    parameters: z.object({}),\n  },\n};\n"],"mappings":"AAAA,SAAS,SAAS;AAEX,MAAM,YAAY;AAAA,EACvB,gBAAgB;AAAA,IACd,aACE;AAAA,IACF,YAAY,EAAE,OAAO;AAAA,MACnB,MAAM,EAAE,OAAO;AAAA,MACf,OAAO,EAAE,OAAO;AAAA,IAClB,CAAC;AAAA,EACH;AAAA,EACA,aAAa;AAAA,IACX,aAAa;AAAA,IACb,YAAY,EAAE,OAAO,CAAC,CAAC;AAAA,EACzB;AACF;","names":[]}
+{"version":3,"sources":["../src/formTools.tsx"],"sourcesContent":["import { z } from \"zod\";\n\nexport const formTools = {\n  set_form_field: {\n    description:\n      \"Sets a form field. Call this function as soon as the user provides the data for each field.\",\n    parameters: z.object({\n      name: z.string(),\n      value: z.string(),\n    }),\n  },\n  submit_form: {\n    description: \"Submits the form. Confirm with user before submitting.\",\n    parameters: z.object({}),\n  },\n};\n"],"mappings":";AAAA,SAAS,SAAS;AAEX,IAAM,YAAY;AAAA,EACvB,gBAAgB;AAAA,IACd,aACE;AAAA,IACF,YAAY,EAAE,OAAO;AAAA,MACnB,MAAM,EAAE,OAAO;AAAA,MACf,OAAO,EAAE,OAAO;AAAA,IAClB,CAAC;AAAA,EACH;AAAA,EACA,aAAa;AAAA,IACX,aAAa;AAAA,IACb,YAAY,EAAE,OAAO,CAAC,CAAC;AAAA,EACzB;AACF;","names":[]}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { useAssistantForm, type UseAssistantFormProps, } from "./useAssistantForm";
+export { formTools } from "./formTools";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,KAAK,qBAAqB,GAC3B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -1,7 +1,8 @@
+// src/index.ts
 import {
   useAssistantForm
-} from "./useAssistantForm";
-import { formTools } from "./formTools";
+} from "./useAssistantForm.js";
+import { formTools } from "./formTools.js";
 export {
   formTools,
   useAssistantForm

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export {\n  useAssistantForm,\n  type UseAssistantFormProps,\n} from \"./useAssistantForm\";\nexport { formTools } from \"./formTools\";\n"],"mappings":"AAAA;AAAA,EACE;AAAA,OAEK;AACP,SAAS,iBAAiB;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export {\n  useAssistantForm,\n  type UseAssistantFormProps,\n} from \"./useAssistantForm\";\nexport { formTools } from \"./formTools\";\n"],"mappings":";AAAA;AAAA,EACE;AAAA,OAEK;AACP,SAAS,iBAAiB;","names":[]}

package/dist/useAssistantForm.d.ts

@@ -0,0 +1,18 @@
+import { type ToolCallContentPartComponent } from "@assistant-ui/react";
+import { type FieldValues, type UseFormProps, type UseFormReturn } from "react-hook-form";
+import type { z } from "zod";
+import { formTools } from "./formTools";
+export type UseAssistantFormProps<TFieldValues extends FieldValues, TContext, TTransformedValues> = UseFormProps<TFieldValues, TContext, TTransformedValues> & {
+    assistant?: {
+        tools?: {
+            set_form_field?: {
+                render?: ToolCallContentPartComponent<z.infer<(typeof formTools.set_form_field)["parameters"]>, unknown> | undefined;
+            } | undefined;
+            submit_form?: {
+                render?: ToolCallContentPartComponent<z.infer<(typeof formTools.submit_form)["parameters"]>, unknown> | undefined;
+            } | undefined;
+        } | undefined;
+    } | undefined;
+};
+export declare const useAssistantForm: <TFieldValues extends FieldValues = FieldValues, TContext = any, TTransformedValues = TFieldValues>(props?: UseAssistantFormProps<TFieldValues, TContext, TTransformedValues>) => UseFormReturn<TFieldValues, TContext, TTransformedValues>;
+//# sourceMappingURL=useAssistantForm.d.ts.map

package/dist/useAssistantForm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAssistantForm.d.ts","sourceRoot":"","sources":["../src/useAssistantForm.tsx"],"names":[],"mappings":"AAEA,OAAO,EAGL,KAAK,4BAA4B,EAGlC,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,KAAK,WAAW,EAGhB,KAAK,YAAY,EACjB,KAAK,aAAa,EAEnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,MAAM,qBAAqB,CAC/B,YAAY,SAAS,WAAW,EAChC,QAAQ,EACR,kBAAkB,IAChB,YAAY,CAAC,YAAY,EAAE,QAAQ,EAAE,kBAAkB,CAAC,GAAG;IAC7D,SAAS,CAAC,EACN;QACE,KAAK,CAAC,EACF;YACE,cAAc,CAAC,EACX;gBACE,MAAM,CAAC,EACH,4BAA4B,CAC1B,CAAC,CAAC,KAAK,CACL,CAAC,OAAO,SAAS,CAAC,cAAc,CAAC,CAAC,YAAY,CAAC,CAChD,EACD,OAAO,CACR,GACD,SAAS,CAAC;aACf,GACD,SAAS,CAAC;YACd,WAAW,CAAC,EACR;gBACE,MAAM,CAAC,EACH,4BAA4B,CAC1B,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,SAAS,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,EACrD,OAAO,CACR,GACD,SAAS,CAAC;aACf,GACD,SAAS,CAAC;SACf,GACD,SAAS,CAAC;KACf,GACD,SAAS,CAAC;CACf,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAC3B,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,QAAQ,GAAG,GAAG,EACd,kBAAkB,GAAG,YAAY,EAEjC,QAAQ,qBAAqB,CAAC,YAAY,EAAE,QAAQ,EAAE,kBAAkB,CAAC,KACxE,aAAa,CAAC,YAAY,EAAE,QAAQ,EAAE,kBAAkB,CA8E1D,CAAC"}

package/dist/useAssistantForm.js

@@ -1,4 +1,6 @@
 "use client";
+
+// src/useAssistantForm.tsx
 import {
   tool,
   useAssistantRuntime,
@@ -8,8 +10,8 @@ import { useEffect } from "react";
 import {
   useForm
 } from "react-hook-form";
-import { formTools } from "./formTools";
-const useAssistantForm = (props) => {
+import { formTools } from "./formTools.js";
+var useAssistantForm = (props) => {
   const form = useForm(props);
   const { control, getValues, setValue } = form;
   const assistantRuntime = useAssistantRuntime();

package/dist/useAssistantForm.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/useAssistantForm.tsx"],"sourcesContent":["\"use client\";\n\nimport {\n  type ModelContext,\n  tool,\n  type ToolCallContentPartComponent,\n  useAssistantRuntime,\n  useAssistantToolUI,\n} from \"@assistant-ui/react\";\nimport { useEffect } from \"react\";\nimport {\n  type FieldValues,\n  Path,\n  PathValue,\n  type UseFormProps,\n  type UseFormReturn,\n  useForm,\n} from \"react-hook-form\";\nimport type { z } from \"zod\";\nimport { formTools } from \"./formTools\";\n\nexport type UseAssistantFormProps<\n  TFieldValues extends FieldValues,\n  TContext,\n  TTransformedValues,\n> = UseFormProps<TFieldValues, TContext, TTransformedValues> & {\n  assistant?:\n    | {\n        tools?:\n          | {\n              set_form_field?:\n                | {\n                    render?:\n                      | ToolCallContentPartComponent<\n                          z.infer<\n                            (typeof formTools.set_form_field)[\"parameters\"]\n                          >,\n                          unknown\n                        >\n                      | undefined;\n                  }\n                | undefined;\n              submit_form?:\n                | {\n                    render?:\n                      | ToolCallContentPartComponent<\n                          z.infer<(typeof formTools.submit_form)[\"parameters\"]>,\n                          unknown\n                        >\n                      | undefined;\n                  }\n                | undefined;\n            }\n          | undefined;\n      }\n    | undefined;\n};\n\nexport const useAssistantForm = <\n  TFieldValues extends FieldValues = FieldValues,\n  TContext = any,\n  TTransformedValues = TFieldValues,\n>(\n  props?: UseAssistantFormProps<TFieldValues, TContext, TTransformedValues>,\n): UseFormReturn<TFieldValues, TContext, TTransformedValues> => {\n  const form = useForm<TFieldValues, TContext, TTransformedValues>(props);\n  const { control, getValues, setValue } = form;\n\n  const assistantRuntime = useAssistantRuntime();\n  useEffect(() => {\n    const value: ModelContext = {\n      system: `Form State:\\n${JSON.stringify(getValues())}`,\n\n      tools: {\n        set_form_field: tool({\n          ...formTools.set_form_field,\n          execute: async (args) => {\n            setValue(\n              args.name as Path<TFieldValues>,\n              args.value as PathValue<TFieldValues, Path<TFieldValues>>,\n            );\n\n            return { success: true };\n          },\n        }),\n        submit_form: tool({\n          ...formTools.submit_form,\n          execute: async () => {\n            const { _names, _fields } = control;\n            for (const name of _names.mount) {\n              const field = _fields[name];\n              if (field?._f && \"refs\" in field._f) {\n                const fieldReference = Array.isArray(field._f.refs)\n                  ? field._f.refs[0]\n                  : field._f.ref;\n\n                if (fieldReference instanceof HTMLElement) {\n                  const form = fieldReference.closest(\"form\");\n                  if (form) {\n                    form.requestSubmit();\n\n                    return { success: true };\n                  }\n                }\n              }\n            }\n\n            return {\n              success: false,\n              message:\n                \"Unable retrieve the form element. This is a coding error.\",\n            };\n          },\n        }),\n      },\n    };\n    return assistantRuntime.registerModelContextProvider({\n      getModelContext: () => value,\n    });\n  }, [control, setValue, getValues, assistantRuntime]);\n\n  const renderFormFieldTool = props?.assistant?.tools?.set_form_field?.render;\n  useAssistantToolUI(\n    renderFormFieldTool\n      ? {\n          toolName: \"set_form_field\",\n          render: renderFormFieldTool,\n        }\n      : null,\n  );\n\n  const renderSubmitFormTool = props?.assistant?.tools?.submit_form?.render;\n  useAssistantToolUI(\n    renderSubmitFormTool\n      ? {\n          toolName: \"submit_form\",\n          render: renderSubmitFormTool,\n        }\n      : null,\n  );\n\n  return form;\n};\n"],"mappings":";AAEA;AAAA,EAEE;AAAA,EAEA;AAAA,EACA;AAAA,OACK;AACP,SAAS,iBAAiB;AAC1B;AAAA,EAME;AAAA,OACK;AAEP,SAAS,iBAAiB;AAuCnB,MAAM,mBAAmB,CAK9B,UAC8D;AAC9D,QAAM,OAAO,QAAoD,KAAK;AACtE,QAAM,EAAE,SAAS,WAAW,SAAS,IAAI;AAEzC,QAAM,mBAAmB,oBAAoB;AAC7C,YAAU,MAAM;AACd,UAAM,QAAsB;AAAA,MAC1B,QAAQ;AAAA,EAAgB,KAAK,UAAU,UAAU,CAAC,CAAC;AAAA,MAEnD,OAAO;AAAA,QACL,gBAAgB,KAAK;AAAA,UACnB,GAAG,UAAU;AAAA,UACb,SAAS,OAAO,SAAS;AACvB;AAAA,cACE,KAAK;AAAA,cACL,KAAK;AAAA,YACP;AAEA,mBAAO,EAAE,SAAS,KAAK;AAAA,UACzB;AAAA,QACF,CAAC;AAAA,QACD,aAAa,KAAK;AAAA,UAChB,GAAG,UAAU;AAAA,UACb,SAAS,YAAY;AACnB,kBAAM,EAAE,QAAQ,QAAQ,IAAI;AAC5B,uBAAW,QAAQ,OAAO,OAAO;AAC/B,oBAAM,QAAQ,QAAQ,IAAI;AAC1B,kBAAI,OAAO,MAAM,UAAU,MAAM,IAAI;AACnC,sBAAM,iBAAiB,MAAM,QAAQ,MAAM,GAAG,IAAI,IAC9C,MAAM,GAAG,KAAK,CAAC,IACf,MAAM,GAAG;AAEb,oBAAI,0BAA0B,aAAa;AACzC,wBAAMA,QAAO,eAAe,QAAQ,MAAM;AAC1C,sBAAIA,OAAM;AACR,oBAAAA,MAAK,cAAc;AAEnB,2BAAO,EAAE,SAAS,KAAK;AAAA,kBACzB;AAAA,gBACF;AAAA,cACF;AAAA,YACF;AAEA,mBAAO;AAAA,cACL,SAAS;AAAA,cACT,SACE;AAAA,YACJ;AAAA,UACF;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF;AACA,WAAO,iBAAiB,6BAA6B;AAAA,MACnD,iBAAiB,MAAM;AAAA,IACzB,CAAC;AAAA,EACH,GAAG,CAAC,SAAS,UAAU,WAAW,gBAAgB,CAAC;AAEnD,QAAM,sBAAsB,OAAO,WAAW,OAAO,gBAAgB;AACrE;AAAA,IACE,sBACI;AAAA,MACE,UAAU;AAAA,MACV,QAAQ;AAAA,IACV,IACA;AAAA,EACN;AAEA,QAAM,uBAAuB,OAAO,WAAW,OAAO,aAAa;AACnE;AAAA,IACE,uBACI;AAAA,MACE,UAAU;AAAA,MACV,QAAQ;AAAA,IACV,IACA;AAAA,EACN;AAEA,SAAO;AACT;","names":["form"]}
+{"version":3,"sources":["../src/useAssistantForm.tsx"],"sourcesContent":["\"use client\";\n\nimport {\n  type ModelContext,\n  tool,\n  type ToolCallContentPartComponent,\n  useAssistantRuntime,\n  useAssistantToolUI,\n} from \"@assistant-ui/react\";\nimport { useEffect } from \"react\";\nimport {\n  type FieldValues,\n  Path,\n  PathValue,\n  type UseFormProps,\n  type UseFormReturn,\n  useForm,\n} from \"react-hook-form\";\nimport type { z } from \"zod\";\nimport { formTools } from \"./formTools\";\n\nexport type UseAssistantFormProps<\n  TFieldValues extends FieldValues,\n  TContext,\n  TTransformedValues,\n> = UseFormProps<TFieldValues, TContext, TTransformedValues> & {\n  assistant?:\n    | {\n        tools?:\n          | {\n              set_form_field?:\n                | {\n                    render?:\n                      | ToolCallContentPartComponent<\n                          z.infer<\n                            (typeof formTools.set_form_field)[\"parameters\"]\n                          >,\n                          unknown\n                        >\n                      | undefined;\n                  }\n                | undefined;\n              submit_form?:\n                | {\n                    render?:\n                      | ToolCallContentPartComponent<\n                          z.infer<(typeof formTools.submit_form)[\"parameters\"]>,\n                          unknown\n                        >\n                      | undefined;\n                  }\n                | undefined;\n            }\n          | undefined;\n      }\n    | undefined;\n};\n\nexport const useAssistantForm = <\n  TFieldValues extends FieldValues = FieldValues,\n  TContext = any,\n  TTransformedValues = TFieldValues,\n>(\n  props?: UseAssistantFormProps<TFieldValues, TContext, TTransformedValues>,\n): UseFormReturn<TFieldValues, TContext, TTransformedValues> => {\n  const form = useForm<TFieldValues, TContext, TTransformedValues>(props);\n  const { control, getValues, setValue } = form;\n\n  const assistantRuntime = useAssistantRuntime();\n  useEffect(() => {\n    const value: ModelContext = {\n      system: `Form State:\\n${JSON.stringify(getValues())}`,\n\n      tools: {\n        set_form_field: tool({\n          ...formTools.set_form_field,\n          execute: async (args) => {\n            setValue(\n              args.name as Path<TFieldValues>,\n              args.value as PathValue<TFieldValues, Path<TFieldValues>>,\n            );\n\n            return { success: true };\n          },\n        }),\n        submit_form: tool({\n          ...formTools.submit_form,\n          execute: async () => {\n            const { _names, _fields } = control;\n            for (const name of _names.mount) {\n              const field = _fields[name];\n              if (field?._f && \"refs\" in field._f) {\n                const fieldReference = Array.isArray(field._f.refs)\n                  ? field._f.refs[0]\n                  : field._f.ref;\n\n                if (fieldReference instanceof HTMLElement) {\n                  const form = fieldReference.closest(\"form\");\n                  if (form) {\n                    form.requestSubmit();\n\n                    return { success: true };\n                  }\n                }\n              }\n            }\n\n            return {\n              success: false,\n              message:\n                \"Unable retrieve the form element. This is a coding error.\",\n            };\n          },\n        }),\n      },\n    };\n    return assistantRuntime.registerModelContextProvider({\n      getModelContext: () => value,\n    });\n  }, [control, setValue, getValues, assistantRuntime]);\n\n  const renderFormFieldTool = props?.assistant?.tools?.set_form_field?.render;\n  useAssistantToolUI(\n    renderFormFieldTool\n      ? {\n          toolName: \"set_form_field\",\n          render: renderFormFieldTool,\n        }\n      : null,\n  );\n\n  const renderSubmitFormTool = props?.assistant?.tools?.submit_form?.render;\n  useAssistantToolUI(\n    renderSubmitFormTool\n      ? {\n          toolName: \"submit_form\",\n          render: renderSubmitFormTool,\n        }\n      : null,\n  );\n\n  return form;\n};\n"],"mappings":";;;AAEA;AAAA,EAEE;AAAA,EAEA;AAAA,EACA;AAAA,OACK;AACP,SAAS,iBAAiB;AAC1B;AAAA,EAME;AAAA,OACK;AAEP,SAAS,iBAAiB;AAuCnB,IAAM,mBAAmB,CAK9B,UAC8D;AAC9D,QAAM,OAAO,QAAoD,KAAK;AACtE,QAAM,EAAE,SAAS,WAAW,SAAS,IAAI;AAEzC,QAAM,mBAAmB,oBAAoB;AAC7C,YAAU,MAAM;AACd,UAAM,QAAsB;AAAA,MAC1B,QAAQ;AAAA,EAAgB,KAAK,UAAU,UAAU,CAAC,CAAC;AAAA,MAEnD,OAAO;AAAA,QACL,gBAAgB,KAAK;AAAA,UACnB,GAAG,UAAU;AAAA,UACb,SAAS,OAAO,SAAS;AACvB;AAAA,cACE,KAAK;AAAA,cACL,KAAK;AAAA,YACP;AAEA,mBAAO,EAAE,SAAS,KAAK;AAAA,UACzB;AAAA,QACF,CAAC;AAAA,QACD,aAAa,KAAK;AAAA,UAChB,GAAG,UAAU;AAAA,UACb,SAAS,YAAY;AACnB,kBAAM,EAAE,QAAQ,QAAQ,IAAI;AAC5B,uBAAW,QAAQ,OAAO,OAAO;AAC/B,oBAAM,QAAQ,QAAQ,IAAI;AAC1B,kBAAI,OAAO,MAAM,UAAU,MAAM,IAAI;AACnC,sBAAM,iBAAiB,MAAM,QAAQ,MAAM,GAAG,IAAI,IAC9C,MAAM,GAAG,KAAK,CAAC,IACf,MAAM,GAAG;AAEb,oBAAI,0BAA0B,aAAa;AACzC,wBAAMA,QAAO,eAAe,QAAQ,MAAM;AAC1C,sBAAIA,OAAM;AACR,oBAAAA,MAAK,cAAc;AAEnB,2BAAO,EAAE,SAAS,KAAK;AAAA,kBACzB;AAAA,gBACF;AAAA,cACF;AAAA,YACF;AAEA,mBAAO;AAAA,cACL,SAAS;AAAA,cACT,SACE;AAAA,YACJ;AAAA,UACF;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF;AACA,WAAO,iBAAiB,6BAA6B;AAAA,MACnD,iBAAiB,MAAM;AAAA,IACzB,CAAC;AAAA,EACH,GAAG,CAAC,SAAS,UAAU,WAAW,gBAAgB,CAAC;AAEnD,QAAM,sBAAsB,OAAO,WAAW,OAAO,gBAAgB;AACrE;AAAA,IACE,sBACI;AAAA,MACE,UAAU;AAAA,MACV,QAAQ;AAAA,IACV,IACA;AAAA,EACN;AAEA,QAAM,uBAAuB,OAAO,WAAW,OAAO,aAAa;AACnE;AAAA,IACE,uBACI;AAAA,MACE,UAAU;AAAA,MACV,QAAQ;AAAA,IACV,IACA;AAAA,EACN;AAEA,SAAO;AACT;","names":["form"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@assistant-ui/react-hook-form",
-  "version": "0.10.0",
+  "version": "0.10.2",
   "license": "MIT",
   "type": "module",
   "exports": {
@@ -13,6 +13,7 @@
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
+    "src",
     "README.md"
   ],
   "sideEffects": false,
@@ -20,7 +21,7 @@
     "zod": "^3.24.3"
   },
   "peerDependencies": {
-    "@assistant-ui/react": "^0.10.0",
+    "@assistant-ui/react": "^0.10.2",
     "@types/react": "*",
     "react": "^18 || ^19 || ^19.0.0-rc",
     "react-hook-form": "^7"
@@ -32,11 +33,11 @@
   },
   "devDependencies": {
     "@types/node": "^22.14.1",
-    "@types/react": "^19.1.0",
+    "@types/react": "^19.1.2",
     "eslint": "^9",
     "eslint-config-next": "15.3.1",
     "react": "^19.1.0",
-    "react-hook-form": "^7.51.1",
+    "react-hook-form": "^7.56.0",
     "tsx": "^4.19.3",
     "@assistant-ui/tsbuildutils": "0.0.1",
     "@assistant-ui/tsconfig": "0.0.0"

package/src/formTools.tsx

@@ -0,0 +1,16 @@
+import { z } from "zod";
+
+export const formTools = {
+  set_form_field: {
+    description:
+      "Sets a form field. Call this function as soon as the user provides the data for each field.",
+    parameters: z.object({
+      name: z.string(),
+      value: z.string(),
+    }),
+  },
+  submit_form: {
+    description: "Submits the form. Confirm with user before submitting.",
+    parameters: z.object({}),
+  },
+};

package/src/index.ts

@@ -0,0 +1,5 @@
+export {
+  useAssistantForm,
+  type UseAssistantFormProps,
+} from "./useAssistantForm";
+export { formTools } from "./formTools";

package/src/useAssistantForm.tsx

@@ -0,0 +1,143 @@
+"use client";
+
+import {
+  type ModelContext,
+  tool,
+  type ToolCallContentPartComponent,
+  useAssistantRuntime,
+  useAssistantToolUI,
+} from "@assistant-ui/react";
+import { useEffect } from "react";
+import {
+  type FieldValues,
+  Path,
+  PathValue,
+  type UseFormProps,
+  type UseFormReturn,
+  useForm,
+} from "react-hook-form";
+import type { z } from "zod";
+import { formTools } from "./formTools";
+
+export type UseAssistantFormProps<
+  TFieldValues extends FieldValues,
+  TContext,
+  TTransformedValues,
+> = UseFormProps<TFieldValues, TContext, TTransformedValues> & {
+  assistant?:
+    | {
+        tools?:
+          | {
+              set_form_field?:
+                | {
+                    render?:
+                      | ToolCallContentPartComponent<
+                          z.infer<
+                            (typeof formTools.set_form_field)["parameters"]
+                          >,
+                          unknown
+                        >
+                      | undefined;
+                  }
+                | undefined;
+              submit_form?:
+                | {
+                    render?:
+                      | ToolCallContentPartComponent<
+                          z.infer<(typeof formTools.submit_form)["parameters"]>,
+                          unknown
+                        >
+                      | undefined;
+                  }
+                | undefined;
+            }
+          | undefined;
+      }
+    | undefined;
+};
+
+export const useAssistantForm = <
+  TFieldValues extends FieldValues = FieldValues,
+  TContext = any,
+  TTransformedValues = TFieldValues,
+>(
+  props?: UseAssistantFormProps<TFieldValues, TContext, TTransformedValues>,
+): UseFormReturn<TFieldValues, TContext, TTransformedValues> => {
+  const form = useForm<TFieldValues, TContext, TTransformedValues>(props);
+  const { control, getValues, setValue } = form;
+
+  const assistantRuntime = useAssistantRuntime();
+  useEffect(() => {
+    const value: ModelContext = {
+      system: `Form State:\n${JSON.stringify(getValues())}`,
+
+      tools: {
+        set_form_field: tool({
+          ...formTools.set_form_field,
+          execute: async (args) => {
+            setValue(
+              args.name as Path<TFieldValues>,
+              args.value as PathValue<TFieldValues, Path<TFieldValues>>,
+            );
+
+            return { success: true };
+          },
+        }),
+        submit_form: tool({
+          ...formTools.submit_form,
+          execute: async () => {
+            const { _names, _fields } = control;
+            for (const name of _names.mount) {
+              const field = _fields[name];
+              if (field?._f && "refs" in field._f) {
+                const fieldReference = Array.isArray(field._f.refs)
+                  ? field._f.refs[0]
+                  : field._f.ref;
+
+                if (fieldReference instanceof HTMLElement) {
+                  const form = fieldReference.closest("form");
+                  if (form) {
+                    form.requestSubmit();
+
+                    return { success: true };
+                  }
+                }
+              }
+            }
+
+            return {
+              success: false,
+              message:
+                "Unable retrieve the form element. This is a coding error.",
+            };
+          },
+        }),
+      },
+    };
+    return assistantRuntime.registerModelContextProvider({
+      getModelContext: () => value,
+    });
+  }, [control, setValue, getValues, assistantRuntime]);
+
+  const renderFormFieldTool = props?.assistant?.tools?.set_form_field?.render;
+  useAssistantToolUI(
+    renderFormFieldTool
+      ? {
+          toolName: "set_form_field",
+          render: renderFormFieldTool,
+        }
+      : null,
+  );
+
+  const renderSubmitFormTool = props?.assistant?.tools?.submit_form?.render;
+  useAssistantToolUI(
+    renderSubmitFormTool
+      ? {
+          toolName: "submit_form",
+          render: renderSubmitFormTool,
+        }
+      : null,
+  );
+
+  return form;
+};