@assistant-ui/react-hook-form 0.12.25 → 0.12.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useAssistantForm.d.ts","names":[],"sources":["../src/useAssistantForm.ts"],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"useAssistantForm.d.ts","names":[],"sources":["../src/useAssistantForm.ts"],"mappings":";;;;;KAoBY,sBACV,qBAAqB,aACrB,UACA,sBACE,aAAa,cAAc,UAAU;EACvC;IAEM;MAEM;QAEM,SACI,6BACE,EAAE,cACQ,UAAU;;MAOhC;QAEM,SACI,6BACE,EAAE,cAAc,UAAU;;MAMtC;QAEM,SACI,6BACE,EAAE,cAAc,UAAU;;;;;cAYvC,mBACX,qBAAqB,cAAc,aACnC,gBACA,qBAAqB,cAErB,QAAQ,sBAAsB,cAAc,UAAU,wBACrD,cAAc,cAAc,UAAU"}
|
package/dist/useAssistantForm.js
CHANGED
|
@@ -4,7 +4,7 @@ import { tool } from "@assistant-ui/core";
|
|
|
4
4
|
import "@assistant-ui/core/react";
|
|
5
5
|
import { useAui } from "@assistant-ui/store";
|
|
6
6
|
import { useEffect } from "react";
|
|
7
|
-
import { useForm } from "react-hook-form";
|
|
7
|
+
import { get, useForm } from "react-hook-form";
|
|
8
8
|
//#region src/useAssistantForm.ts
|
|
9
9
|
const useAssistantForm = (props) => {
|
|
10
10
|
const form = useForm(props);
|
|
@@ -29,8 +29,8 @@ const useAssistantForm = (props) => {
|
|
|
29
29
|
};
|
|
30
30
|
const { _names, _fields } = control;
|
|
31
31
|
for (const name of _names.mount) {
|
|
32
|
-
const field = _fields
|
|
33
|
-
if (field?._f
|
|
32
|
+
const field = get(_fields, name);
|
|
33
|
+
if (field?._f) {
|
|
34
34
|
const fieldReference = Array.isArray(field._f.refs) ? field._f.refs[0] : field._f.ref;
|
|
35
35
|
if (fieldReference instanceof HTMLElement) {
|
|
36
36
|
const form = fieldReference.closest("form");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useAssistantForm.js","names":[],"sources":["../src/useAssistantForm.ts"],"sourcesContent":["\"use client\";\n\nimport { type ModelContext, tool } from \"@assistant-ui/core\";\nimport type {} from \"@assistant-ui/core/store\";\nimport { type ToolCallMessagePartComponent } from \"@assistant-ui/core/react\";\nimport { useAui } from \"@assistant-ui/store\";\nimport { useEffect } from \"react\";\nimport {\n type FieldValues,\n type Path,\n type 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 | ToolCallMessagePartComponent<\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 | ToolCallMessagePartComponent<\n z.infer<(typeof formTools.submit_form)[\"parameters\"]>,\n unknown\n >\n | undefined;\n }\n | undefined;\n reset_form?:\n | {\n render?:\n | ToolCallMessagePartComponent<\n z.infer<(typeof formTools.reset_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 {\n control,\n getValues,\n setValue,\n reset,\n formState: { isSubmitting },\n } = form;\n\n const aui = useAui();\n useEffect(() => {\n const value: ModelContext = {\n tools: {\n set_form_field: tool({\n ...formTools.set_form_field,\n parameters: formTools.set_form_field.parameters,\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 if (isSubmitting) {\n return {\n success: false,\n message: \"The form is already submitting.\",\n };\n }\n const { _names, _fields } = control;\n for (const name of _names.mount) {\n const field = _fields
|
|
1
|
+
{"version":3,"file":"useAssistantForm.js","names":[],"sources":["../src/useAssistantForm.ts"],"sourcesContent":["\"use client\";\n\nimport { type ModelContext, tool } from \"@assistant-ui/core\";\nimport type {} from \"@assistant-ui/core/store\";\nimport { type ToolCallMessagePartComponent } from \"@assistant-ui/core/react\";\nimport { useAui } from \"@assistant-ui/store\";\nimport { useEffect } from \"react\";\nimport {\n type Field,\n type FieldValues,\n type Path,\n type PathValue,\n type UseFormProps,\n type UseFormReturn,\n get,\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 | ToolCallMessagePartComponent<\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 | ToolCallMessagePartComponent<\n z.infer<(typeof formTools.submit_form)[\"parameters\"]>,\n unknown\n >\n | undefined;\n }\n | undefined;\n reset_form?:\n | {\n render?:\n | ToolCallMessagePartComponent<\n z.infer<(typeof formTools.reset_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 {\n control,\n getValues,\n setValue,\n reset,\n formState: { isSubmitting },\n } = form;\n\n const aui = useAui();\n useEffect(() => {\n const value: ModelContext = {\n tools: {\n set_form_field: tool({\n ...formTools.set_form_field,\n parameters: formTools.set_form_field.parameters,\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 if (isSubmitting) {\n return {\n success: false,\n message: \"The form is already submitting.\",\n };\n }\n const { _names, _fields } = control;\n for (const name of _names.mount) {\n const field: Field | undefined = get(_fields, name);\n if (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 reset_form: tool({\n ...formTools.reset_form,\n execute: async () => {\n reset();\n return { success: true };\n },\n }),\n },\n };\n\n return aui.modelContext.register({\n getModelContext: () => ({\n ...value,\n system: `Form State:\\n${JSON.stringify(getValues())}`,\n }),\n });\n }, [control, setValue, getValues, aui, reset, isSubmitting]);\n\n const renderFormFieldTool = props?.assistant?.tools?.set_form_field?.render;\n useEffect(() => {\n if (!renderFormFieldTool) return undefined;\n return aui.tools.setToolUI(\"set_form_field\", renderFormFieldTool);\n }, [aui, renderFormFieldTool]);\n\n const renderSubmitFormTool = props?.assistant?.tools?.submit_form?.render;\n useEffect(() => {\n if (!renderSubmitFormTool) return undefined;\n return aui.tools.setToolUI(\"submit_form\", renderSubmitFormTool);\n }, [aui, renderSubmitFormTool]);\n\n const renderResetFormTool = props?.assistant?.tools?.reset_form?.render;\n useEffect(() => {\n if (!renderResetFormTool) return undefined;\n return aui.tools.setToolUI(\"reset_form\", renderResetFormTool);\n }, [aui, renderResetFormTool]);\n\n return form;\n};\n"],"mappings":";;;;;;;;AAmEA,MAAa,oBAKX,UAC8D;CAC9D,MAAM,OAAO,QAAoD,KAAK;CACtE,MAAM,EACJ,SACA,WACA,UACA,OACA,WAAW,EAAE,mBACX;CAEJ,MAAM,MAAM,OAAO;CACnB,gBAAgB;EACd,MAAM,QAAsB,EAC1B,OAAO;GACL,gBAAgB,KAAK;IACnB,GAAG,UAAU;IACb,YAAY,UAAU,eAAe;IACrC,SAAS,OAAO,SAAS;KACvB,SACE,KAAK,MACL,KAAK,KACP;KAEA,OAAO,EAAE,SAAS,KAAK;IACzB;GACF,CAAC;GACD,aAAa,KAAK;IAChB,GAAG,UAAU;IACb,SAAS,YAAY;KACnB,IAAI,cACF,OAAO;MACL,SAAS;MACT,SAAS;KACX;KAEF,MAAM,EAAE,QAAQ,YAAY;KAC5B,KAAK,MAAM,QAAQ,OAAO,OAAO;MAC/B,MAAM,QAA2B,IAAI,SAAS,IAAI;MAClD,IAAI,OAAO,IAAI;OACb,MAAM,iBAAiB,MAAM,QAAQ,MAAM,GAAG,IAAI,IAC9C,MAAM,GAAG,KAAK,KACd,MAAM,GAAG;OAEb,IAAI,0BAA0B,aAAa;QACzC,MAAM,OAAO,eAAe,QAAQ,MAAM;QAC1C,IAAI,MAAM;SACR,KAAK,cAAc;SAEnB,OAAO,EAAE,SAAS,KAAK;QACzB;OACF;MACF;KACF;KAEA,OAAO;MACL,SAAS;MACT,SACE;KACJ;IACF;GACF,CAAC;GACD,YAAY,KAAK;IACf,GAAG,UAAU;IACb,SAAS,YAAY;KACnB,MAAM;KACN,OAAO,EAAE,SAAS,KAAK;IACzB;GACF,CAAC;EACH,EACF;EAEA,OAAO,IAAI,aAAa,SAAS,EAC/B,wBAAwB;GACtB,GAAG;GACH,QAAQ,gBAAgB,KAAK,UAAU,UAAU,CAAC;EACpD,GACF,CAAC;CACH,GAAG;EAAC;EAAS;EAAU;EAAW;EAAK;EAAO;CAAY,CAAC;CAE3D,MAAM,sBAAsB,OAAO,WAAW,OAAO,gBAAgB;CACrE,gBAAgB;EACd,IAAI,CAAC,qBAAqB,OAAO,KAAA;EACjC,OAAO,IAAI,MAAM,UAAU,kBAAkB,mBAAmB;CAClE,GAAG,CAAC,KAAK,mBAAmB,CAAC;CAE7B,MAAM,uBAAuB,OAAO,WAAW,OAAO,aAAa;CACnE,gBAAgB;EACd,IAAI,CAAC,sBAAsB,OAAO,KAAA;EAClC,OAAO,IAAI,MAAM,UAAU,eAAe,oBAAoB;CAChE,GAAG,CAAC,KAAK,oBAAoB,CAAC;CAE9B,MAAM,sBAAsB,OAAO,WAAW,OAAO,YAAY;CACjE,gBAAgB;EACd,IAAI,CAAC,qBAAqB,OAAO,KAAA;EACjC,OAAO,IAAI,MAAM,UAAU,cAAc,mBAAmB;CAC9D,GAAG,CAAC,KAAK,mBAAmB,CAAC;CAE7B,OAAO;AACT"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@assistant-ui/react-hook-form",
|
|
3
|
-
"version": "0.12.
|
|
3
|
+
"version": "0.12.27",
|
|
4
4
|
"description": "React Hook Form integration for assistant-ui",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"react-hook-form",
|
|
@@ -29,8 +29,8 @@
|
|
|
29
29
|
],
|
|
30
30
|
"sideEffects": false,
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@assistant-ui/core": "^0.3.
|
|
33
|
-
"@assistant-ui/store": "^0.3.
|
|
32
|
+
"@assistant-ui/core": "^0.3.10",
|
|
33
|
+
"@assistant-ui/store": "^0.3.8",
|
|
34
34
|
"zod": "^4.4.3"
|
|
35
35
|
},
|
|
36
36
|
"peerDependencies": {
|
|
@@ -45,13 +45,13 @@
|
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
47
|
"@testing-library/react": "^16.3.2",
|
|
48
|
-
"@types/react": "^19.2.
|
|
49
|
-
"@types/react-dom": "^19.2.
|
|
50
|
-
"jsdom": "^
|
|
48
|
+
"@types/react": "^19.2.18",
|
|
49
|
+
"@types/react-dom": "^19.2.4",
|
|
50
|
+
"jsdom": "^30.0.1",
|
|
51
51
|
"react": "^19.2.8",
|
|
52
|
-
"react-hook-form": "^7.
|
|
52
|
+
"react-hook-form": "^7.84.0",
|
|
53
53
|
"vitest": "^4.1.10",
|
|
54
|
-
"@assistant-ui/x-buildutils": "0.0.
|
|
54
|
+
"@assistant-ui/x-buildutils": "0.0.22"
|
|
55
55
|
},
|
|
56
56
|
"publishConfig": {
|
|
57
57
|
"access": "public",
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
/** @vitest-environment jsdom */
|
|
2
|
-
import { act, renderHook } from "@testing-library/react";
|
|
2
|
+
import { act, render, renderHook } from "@testing-library/react";
|
|
3
3
|
import type { ModelContext } from "@assistant-ui/core";
|
|
4
|
+
import type { FormEvent, ReactNode } from "react";
|
|
4
5
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
5
6
|
|
|
6
7
|
const mocks = vi.hoisted(() => {
|
|
@@ -35,6 +36,26 @@ beforeEach(() => {
|
|
|
35
36
|
});
|
|
36
37
|
});
|
|
37
38
|
|
|
39
|
+
const expectRegisteredFieldsToSubmit = async (Fields: () => ReactNode) => {
|
|
40
|
+
const onSubmit = vi.fn((event: FormEvent<HTMLFormElement>) => {
|
|
41
|
+
event.preventDefault();
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
render(
|
|
45
|
+
<form onSubmit={onSubmit}>
|
|
46
|
+
<Fields />
|
|
47
|
+
</form>,
|
|
48
|
+
);
|
|
49
|
+
|
|
50
|
+
const submitTool = provider.getModelContext().tools?.submit_form;
|
|
51
|
+
if (!submitTool?.execute) throw new Error("submit_form is not registered");
|
|
52
|
+
|
|
53
|
+
await expect(submitTool.execute({}, {} as never)).resolves.toEqual({
|
|
54
|
+
success: true,
|
|
55
|
+
});
|
|
56
|
+
expect(onSubmit).toHaveBeenCalledOnce();
|
|
57
|
+
};
|
|
58
|
+
|
|
38
59
|
describe("useAssistantForm", () => {
|
|
39
60
|
it("exposes current form values to the model context", () => {
|
|
40
61
|
const { result } = renderHook(() =>
|
|
@@ -53,4 +74,30 @@ describe("useAssistantForm", () => {
|
|
|
53
74
|
'Form State:\n{"name":"Ada"}',
|
|
54
75
|
);
|
|
55
76
|
});
|
|
77
|
+
|
|
78
|
+
it("submits forms registered with standard inputs", async () => {
|
|
79
|
+
await expectRegisteredFieldsToSubmit(() => {
|
|
80
|
+
const form = useAssistantForm<{ name: string }>();
|
|
81
|
+
return <input {...form.register("name")} />;
|
|
82
|
+
});
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
it("submits forms registered with nested inputs", async () => {
|
|
86
|
+
await expectRegisteredFieldsToSubmit(() => {
|
|
87
|
+
const form = useAssistantForm<{ profile: { name: string } }>();
|
|
88
|
+
return <input {...form.register("profile.name")} />;
|
|
89
|
+
});
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
it("continues to submit forms registered with grouped inputs", async () => {
|
|
93
|
+
await expectRegisteredFieldsToSubmit(() => {
|
|
94
|
+
const form = useAssistantForm<{ plan: string }>();
|
|
95
|
+
return (
|
|
96
|
+
<>
|
|
97
|
+
<input type="radio" value="free" {...form.register("plan")} />
|
|
98
|
+
<input type="radio" value="pro" {...form.register("plan")} />
|
|
99
|
+
</>
|
|
100
|
+
);
|
|
101
|
+
});
|
|
102
|
+
});
|
|
56
103
|
});
|
package/src/useAssistantForm.ts
CHANGED
|
@@ -6,11 +6,13 @@ import { type ToolCallMessagePartComponent } from "@assistant-ui/core/react";
|
|
|
6
6
|
import { useAui } from "@assistant-ui/store";
|
|
7
7
|
import { useEffect } from "react";
|
|
8
8
|
import {
|
|
9
|
+
type Field,
|
|
9
10
|
type FieldValues,
|
|
10
11
|
type Path,
|
|
11
12
|
type PathValue,
|
|
12
13
|
type UseFormProps,
|
|
13
14
|
type UseFormReturn,
|
|
15
|
+
get,
|
|
14
16
|
useForm,
|
|
15
17
|
} from "react-hook-form";
|
|
16
18
|
import type { z } from "zod";
|
|
@@ -106,8 +108,8 @@ export const useAssistantForm = <
|
|
|
106
108
|
}
|
|
107
109
|
const { _names, _fields } = control;
|
|
108
110
|
for (const name of _names.mount) {
|
|
109
|
-
const field = _fields
|
|
110
|
-
if (field?._f
|
|
111
|
+
const field: Field | undefined = get(_fields, name);
|
|
112
|
+
if (field?._f) {
|
|
111
113
|
const fieldReference = Array.isArray(field._f.refs)
|
|
112
114
|
? field._f.refs[0]
|
|
113
115
|
: field._f.ref;
|