@beignet/react-hook-form 0.0.1 → 0.0.2

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @beignet/react-hook-form
 
+## 0.0.2
+
+### Patch Changes
+
+- Updated dependencies [90b29ad]
+- Updated dependencies [07fa19c]
+- Updated dependencies [08bae67]
+- Updated dependencies [730a818]
+- Updated dependencies [a79f60c]
+  - @beignet/core@0.0.2
+
 ## 0.0.1
 
 - Initial Beignet release under the `@beignet` npm scope.

package/dist/index.d.ts

@@ -1,12 +1,12 @@
 import { type ContractLike, type HttpContractConfig, type InferOutput, type ResolveContract, type StandardSchemaV1 } from "@beignet/core/contracts";
 import { type FieldValues, type UseFormProps, type UseFormReturn } from "react-hook-form";
 /**
- * Infer form values from contract body
+ * Infer React Hook Form values from a contract body schema.
  */
 type InferBody<TContract extends HttpContractConfig> = TContract["body"] extends StandardSchemaV1 ? InferOutput<TContract["body"]> & FieldValues : FieldValues;
 type FormValues<TContract extends HttpContractConfig> = InferBody<TContract>;
 /**
- * Options for React Hook Form with contract support
+ * React Hook Form options accepted by the Beignet adapter.
  */
 type RhfFormOptions<TContract extends HttpContractConfig> = Omit<UseFormProps<FormValues<TContract>>, "resolver"> & {
     /**
@@ -21,15 +21,15 @@ type RhfFormOptions<TContract extends HttpContractConfig> = Omit<UseFormProps<Fo
     resolverEnabled?: boolean;
 };
 /**
- * React Hook Form adapter for a contract
+ * React Hook Form adapter for one contract.
  */
 export type ReactHookFormContractAdapter<TContract extends HttpContractConfig> = {
     /**
-     * Generate UseFormProps<FormValues<TContract>> for any RHF usage.
+     * Generate `UseFormProps` for any React Hook Form usage.
      */
     formOptions: (props?: RhfFormOptions<TContract>) => UseFormProps<FormValues<TContract>>;
     /**
-     * Convenience wrapper around useForm(formOptions(props)).
+     * Convenience wrapper around `useForm(formOptions(props))`.
      */
     useForm: (props?: RhfFormOptions<TContract>) => UseFormReturn<FormValues<TContract>>;
 };
@@ -38,6 +38,8 @@ export type ReactHookFormContractAdapter<TContract extends HttpContractConfig> =
  *
  * Mirrors the React integration pattern used by `createReactQuery()` and `createNuqs()`:
  * create the adapter once, then bind individual contracts with `rhf(contract)`.
+ * Contracts must declare a body schema. After binding, callers may override or
+ * disable the generated resolver through `formOptions(...)` or `useForm(...)`.
  */
 export declare function createReactHookForm(): <TContractLike extends ContractLike>(contract: TContractLike) => ReactHookFormContractAdapter<ResolveContract<TContractLike>>;
 export {};

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAChB,KAAK,eAAe,EAEpB,KAAK,gBAAgB,EACtB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EACL,KAAK,WAAW,EAEhB,KAAK,YAAY,EACjB,KAAK,aAAa,EACnB,MAAM,iBAAiB,CAAC;AAEzB;;GAEG;AACH,KAAK,SAAS,CAAC,SAAS,SAAS,kBAAkB,IACjD,SAAS,CAAC,MAAM,CAAC,SAAS,gBAAgB,GACtC,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,WAAW,GAC5C,WAAW,CAAC;AAElB,KAAK,UAAU,CAAC,SAAS,SAAS,kBAAkB,IAAI,SAAS,CAAC,SAAS,CAAC,CAAC;AAE7E;;GAEG;AACH,KAAK,cAAc,CAAC,SAAS,SAAS,kBAAkB,IAAI,IAAI,CAC9D,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,EACnC,UAAU,CACX,GAAG;IACF;;;OAGG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAE3D;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,CAAC,SAAS,SAAS,kBAAkB,IAC3E;IACE;;OAEG;IACH,WAAW,EAAE,CACX,KAAK,CAAC,EAAE,cAAc,CAAC,SAAS,CAAC,KAC9B,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IAEzC;;OAEG;IACH,OAAO,EAAE,CACP,KAAK,CAAC,EAAE,cAAc,CAAC,SAAS,CAAC,KAC9B,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;CAC3C,CAAC;AAqDJ;;;;;GAKG;AACH,wBAAgB,mBAAmB,KACb,aAAa,SAAS,YAAY,EACpD,UAAU,aAAa,KACtB,4BAA4B,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAGhE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAChB,KAAK,eAAe,EAEpB,KAAK,gBAAgB,EACtB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EACL,KAAK,WAAW,EAEhB,KAAK,YAAY,EACjB,KAAK,aAAa,EACnB,MAAM,iBAAiB,CAAC;AAEzB;;GAEG;AACH,KAAK,SAAS,CAAC,SAAS,SAAS,kBAAkB,IACjD,SAAS,CAAC,MAAM,CAAC,SAAS,gBAAgB,GACtC,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,WAAW,GAC5C,WAAW,CAAC;AAElB,KAAK,UAAU,CAAC,SAAS,SAAS,kBAAkB,IAAI,SAAS,CAAC,SAAS,CAAC,CAAC;AAE7E;;GAEG;AACH,KAAK,cAAc,CAAC,SAAS,SAAS,kBAAkB,IAAI,IAAI,CAC9D,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,EACnC,UAAU,CACX,GAAG;IACF;;;OAGG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAE3D;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,CAAC,SAAS,SAAS,kBAAkB,IAC3E;IACE;;OAEG;IACH,WAAW,EAAE,CACX,KAAK,CAAC,EAAE,cAAc,CAAC,SAAS,CAAC,KAC9B,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IAEzC;;OAEG;IACH,OAAO,EAAE,CACP,KAAK,CAAC,EAAE,cAAc,CAAC,SAAS,CAAC,KAC9B,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;CAC3C,CAAC;AAqDJ;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,KACb,aAAa,SAAS,YAAY,EACpD,UAAU,aAAa,KACtB,4BAA4B,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAGhE"}

package/dist/index.js

@@ -31,6 +31,8 @@ function createReactHookFormAdapter(contract) {
  *
  * Mirrors the React integration pattern used by `createReactQuery()` and `createNuqs()`:
  * create the adapter once, then bind individual contracts with `rhf(contract)`.
+ * Contracts must declare a body schema. After binding, callers may override or
+ * disable the generated resolver through `formOptions(...)` or `useForm(...)`.
  */
 export function createReactHookForm() {
     return function rhf(contract) {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,eAAe,GAEhB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAEL,OAAO,IAAI,UAAU,GAGtB,MAAM,iBAAiB,CAAC;AAoDzB,SAAS,0BAA0B,CACjC,QAAuB;IAEvB,MAAM,gBAAgB,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;IAEnD,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CACb,OAAO,gBAAgB,CAAC,IAAI,kCAAkC;YAC5D,iFAAiF;YACjF,6EAA6E,CAChF,CAAC;IACJ,CAAC;IAID,SAAS,WAAW,CAClB,KAAsD;QAEtD,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAGvB,CAAC;QAEd,MAAM,EACJ,eAAe,GAAG,IAAI,EACtB,QAAQ,EAAE,gBAAgB,EAC1B,GAAG,IAAI,EACR,GAAG,KAAK,IAAI,EAAE,CAAC;QAEhB,MAAM,QAAQ,GACZ,gBAAgB;YAChB,CAAC,UAAU,IAAI,eAAe;gBAC5B,CAAC,CAAC,sBAAsB,CAAC,UAAU,CAAC;gBACpC,CAAC,CAAC,SAAS,CAAC,CAAC;QAEjB,OAAO;YACL,GAAI,IAA6B;YACjC,QAAQ;SACT,CAAC;IACJ,CAAC;IAED,SAAS,OAAO,CACd,KAAsD;QAEtD,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;QACnC,OAAO,UAAU,CAAS,OAAO,CAAC,CAAC;IACrC,CAAC;IAED,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC;AAClC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB;IACjC,OAAO,SAAS,GAAG,CACjB,QAAuB;QAEvB,OAAO,0BAA0B,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,eAAe,GAEhB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAEL,OAAO,IAAI,UAAU,GAGtB,MAAM,iBAAiB,CAAC;AAoDzB,SAAS,0BAA0B,CACjC,QAAuB;IAEvB,MAAM,gBAAgB,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;IAEnD,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CACb,OAAO,gBAAgB,CAAC,IAAI,kCAAkC;YAC5D,iFAAiF;YACjF,6EAA6E,CAChF,CAAC;IACJ,CAAC;IAID,SAAS,WAAW,CAClB,KAAsD;QAEtD,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAGvB,CAAC;QAEd,MAAM,EACJ,eAAe,GAAG,IAAI,EACtB,QAAQ,EAAE,gBAAgB,EAC1B,GAAG,IAAI,EACR,GAAG,KAAK,IAAI,EAAE,CAAC;QAEhB,MAAM,QAAQ,GACZ,gBAAgB;YAChB,CAAC,UAAU,IAAI,eAAe;gBAC5B,CAAC,CAAC,sBAAsB,CAAC,UAAU,CAAC;gBACpC,CAAC,CAAC,SAAS,CAAC,CAAC;QAEjB,OAAO;YACL,GAAI,IAA6B;YACjC,QAAQ;SACT,CAAC;IACJ,CAAC;IAED,SAAS,OAAO,CACd,KAAsD;QAEtD,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;QACnC,OAAO,UAAU,CAAS,OAAO,CAAC,CAAC;IACrC,CAAC;IAED,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC;AAClC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB;IACjC,OAAO,SAAS,GAAG,CACjB,QAAuB;QAEvB,OAAO,0BAA0B,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beignet/react-hook-form",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "type": "module",
   "description": "React Hook Form integration for Beignet with Standard Schema support",
   "main": "./dist/index.js",

package/src/index.ts

@@ -15,7 +15,7 @@ import {
 } from "react-hook-form";
 
 /**
- * Infer form values from contract body
+ * Infer React Hook Form values from a contract body schema.
  */
 type InferBody<TContract extends HttpContractConfig> =
   TContract["body"] extends StandardSchemaV1
@@ -25,7 +25,7 @@ type InferBody<TContract extends HttpContractConfig> =
 type FormValues<TContract extends HttpContractConfig> = InferBody<TContract>;
 
 /**
- * Options for React Hook Form with contract support
+ * React Hook Form options accepted by the Beignet adapter.
  */
 type RhfFormOptions<TContract extends HttpContractConfig> = Omit<
   UseFormProps<FormValues<TContract>>,
@@ -45,19 +45,19 @@ type RhfFormOptions<TContract extends HttpContractConfig> = Omit<
 };
 
 /**
- * React Hook Form adapter for a contract
+ * React Hook Form adapter for one contract.
  */
 export type ReactHookFormContractAdapter<TContract extends HttpContractConfig> =
   {
     /**
-     * Generate UseFormProps<FormValues<TContract>> for any RHF usage.
+     * Generate `UseFormProps` for any React Hook Form usage.
      */
     formOptions: (
       props?: RhfFormOptions<TContract>,
     ) => UseFormProps<FormValues<TContract>>;
 
     /**
-     * Convenience wrapper around useForm(formOptions(props)).
+     * Convenience wrapper around `useForm(formOptions(props))`.
      */
     useForm: (
       props?: RhfFormOptions<TContract>,
@@ -120,6 +120,8 @@ function createReactHookFormAdapter<TContractLike extends ContractLike>(
  *
  * Mirrors the React integration pattern used by `createReactQuery()` and `createNuqs()`:
  * create the adapter once, then bind individual contracts with `rhf(contract)`.
+ * Contracts must declare a body schema. After binding, callers may override or
+ * disable the generated resolver through `formOptions(...)` or `useForm(...)`.
  */
 export function createReactHookForm() {
   return function rhf<TContractLike extends ContractLike>(