@zod-to-form/vite 0.2.0 → 0.2.2

package/README.md

@@ -4,12 +4,24 @@ Vite plugin for [zod-to-form](https://github.com/pradeepmouli/zod-to-form). Tran
 
 > **Status**: In active development. See [`specs/007-vite-codegen-plugin/`](../../specs/007-vite-codegen-plugin/) for the full specification, plan, and implementation tasks.
 
+## Install
+
+The plugin emits standard React + react-hook-form code, so the consumer
+app needs the form runtime even when nothing else imports from
+`@zod-to-form/react`:
+
+```bash
+pnpm add -D @zod-to-form/vite
+pnpm add zod react react-dom react-hook-form @hookform/resolvers
+```
+
+`@zod-to-form/vite` is the only build-time dep. The other packages are
+runtime peers that the generated form components import.
+
 ## Quickstart
 
 See the full walkthrough in [quickstart.md](../../specs/007-vite-codegen-plugin/quickstart.md).
 
-Minimal usage:
-
 ```ts
 // vite.config.ts
 import { defineConfig } from 'vite';
@@ -17,10 +29,22 @@ import react from '@vitejs/plugin-react';
 import z2fVite from '@zod-to-form/vite';
 
 export default defineConfig({
+  // Plugin order matters: z2fVite BEFORE react() so the generated TSX
+  // flows through React's JSX transform normally.
   plugins: [z2fVite(), react()]
 });
 ```
 
+Add the ambient declarations for `?z2f` imports to your `tsconfig.json`:
+
+```jsonc
+{
+  "compilerOptions": {
+    "types": ["@zod-to-form/vite/client"]
+  }
+}
+```
+
 ```tsx
 // src/App.tsx
 import SignupForm from './schemas/signup.ts?z2f';

package/dist/virtual-types.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Ambient declarations for `?z2f`-suffixed imports.
+ *
+ * Users add `"types": ["@zod-to-form/vite/client"]` to their `tsconfig.json`
+ * and immediately get type resolution + autocomplete on `import { Form }
+ * from './schemas/foo.ts?z2f'` without authoring any `.d.ts` files
+ * themselves (FR-015, SC-005).
+ *
+ * Precision note (research R5): the `onSubmit` payload type is `unknown`
+ * in v1. Tighter inference via `typeof import('...')` requires TypeScript
+ * features not yet stable enough to rely on. Users who want a strongly
+ * typed payload can annotate the parameter at the call site, where the
+ * narrower type-checker context will prefer their annotation.
+ */
+
+declare module '*?z2f' {
+  import type { ComponentType, FormHTMLAttributes, ReactNode } from 'react';
+
+  /**
+   * Props common to every generated form component.
+   *
+   * `onSubmit` receives the parsed schema output and is the primary surface
+   * developers interact with. `defaultValues` and `values` accept partial
+   * input data (matching React Hook Form's `useForm` semantics).
+   */
+  export interface Z2FFormProps<TData = unknown> extends FormHTMLAttributes<HTMLFormElement> {
+    onSubmit: (data: TData) => void | Promise<void>;
+    defaultValues?: Partial<TData>;
+    values?: TData;
+    children?: ReactNode;
+  }
+
+  /**
+   * The default export of every `?z2f` virtual module is a typed React
+   * component. Each generated form re-exports the same component under
+   * a named export matching the schema's component name (e.g. `SignupForm`).
+   */
+  const form: ComponentType<Z2FFormProps>;
+  export default form;
+}
+
+/**
+ * Variant-specific re-declaration. The grammar admits `?z2f=<variant>`
+ * specifiers; we declare them with the same shape so `import { F } from
+ * './schemas/x.ts?z2f=edit'` resolves the same way.
+ */
+declare module '*?z2f=*' {
+  import type { ComponentType, FormHTMLAttributes, ReactNode } from 'react';
+
+  export interface Z2FFormProps<TData = unknown> extends FormHTMLAttributes<HTMLFormElement> {
+    onSubmit: (data: TData) => void | Promise<void>;
+    defaultValues?: Partial<TData>;
+    values?: TData;
+    children?: ReactNode;
+  }
+
+  const form: ComponentType<Z2FFormProps>;
+  export default form;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zod-to-form/vite",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Vite plugin for zod-to-form — transforms ?z2f imports into generated form components and optionally replaces <ZodForm> JSX call sites with generated components at build time",
   "license": "MIT",
   "homepage": "https://github.com/pradeepmouli/zod-to-form#readme",
@@ -38,7 +38,11 @@
     "dist"
   ],
   "peerDependencies": {
-    "vite": "^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0"
+    "@hookform/resolvers": "^5.0.0",
+    "react": "^18.0.0 || ^19.0.0",
+    "react-hook-form": "^7.0.0",
+    "vite": "^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0",
+    "zod": "^4.0.0"
   },
   "dependencies": {
     "@babel/parser": "^7.29.2",
@@ -46,8 +50,8 @@
     "@babel/types": "^7.29.0",
     "magic-string": "^0.30.21",
     "pathe": "^2.0.3",
-    "@zod-to-form/codegen": "0.7.0",
-    "@zod-to-form/core": "0.7.0"
+    "@zod-to-form/codegen": "0.7.1",
+    "@zod-to-form/core": "0.7.1"
   },
   "devDependencies": {
     "@types/babel__traverse": "^7.28.0",
@@ -59,7 +63,7 @@
   },
   "author": "Pradeep Mouli <pmouli@mac.com> (https://github.com/pradeepmouli)",
   "scripts": {
-    "build": "tsgo -p tsconfig.build.json",
+    "build": "tsgo -p tsconfig.build.json && cp src/virtual-types.d.ts dist/virtual-types.d.ts",
     "clean": "rm -rf dist tsconfig.build.tsbuildinfo tsconfig.tsbuildinfo",
     "dev": "tsgo -p tsconfig.build.json --watch",
     "test": "vitest run",