@nxgt/graphql-codegen-zod 0.2.0 → 0.2.2

package/README.md

@@ -34,7 +34,8 @@ Write the SDL files codegen reads: `@constraint` from
 `@nxgt/graphql-validation` and the custom scalars from `@nxgt/graphql-scalars`.
 Install both, so their bins are yours, whatever the package manager links:
 `bun add @nxgt/graphql-validation @nxgt/graphql-scalars` (the generated file
-imports `@nxgt/graphql-scalars` at run time anyway). Without the directive
+imports `@nxgt/graphql-scalars` at run time, unless it takes `@nxgt/zod`; see
+below). Without the directive
 nothing is constrained; plain types are still generated.
 
 ```sh
@@ -72,6 +73,10 @@ const config: CodegenConfig = {
 export default config;
 ```
 
+A client that only runs the generated file can set
+`scalarSchemas: '@nxgt/zod'` instead: the same record, without `graphql`. See
+[On a client](docs/guide/output.md#on-a-client-nxgtzod).
+
 The plugin writes types named as `@graphql-codegen/typescript` names them
 (`SignUpInput`, `MutationSignUpArgs`), which would collide with that plugin's
 in one file. Its `*Args` and `*Variables` types can replace the typescript

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { type GraphQLSchema } from 'graphql';
-import type { CodegenZodConfig, DocumentFile } from './config';
-export type { CodegenZodConfig, DocumentFile } from './config';
+import type { CodegenZodConfig, DocumentFile } from './config.js';
+export type { CodegenZodConfig, DocumentFile } from './config.js';
 /**
  * The graphql-codegen plugin: Zod schemas, and their types, for the
  * schema's enums, input types, field arguments, object types, interfaces and

package/dist/naming.d.ts

@@ -1,5 +1,5 @@
 import type { OperationTypeNode } from 'graphql';
-import type { CodegenZodConfig } from './config';
+import type { CodegenZodConfig } from './config.js';
 /**
  * The names of what the plugin writes: each type as
  * `@graphql-codegen/typescript` and `typescript-operations` name it, each

package/dist/objects-output.d.ts

@@ -1,6 +1,6 @@
 import { type GraphQLSchema } from 'graphql';
-import type { Naming } from './naming';
-import type { Writer } from './writer';
+import type { Naming } from './naming.js';
+import type { Writer } from './writer.js';
 /** The built-in scalars' schemas on the way out. */
 export declare const builtIns: Readonly<Record<string, string>>;
 /**

package/dist/output-types.d.ts

@@ -1,6 +1,6 @@
 import { type GraphQLObjectType } from 'graphql';
-import type { Naming } from './naming';
-import type { Writer } from './writer';
+import type { Naming } from './naming.js';
+import type { Writer } from './writer.js';
 /**
  * An object type in a cycle, declared with its types written out, as an
  * input type in a cycle is: `User` (what a resolver returns, scalars

package/dist/results-output.d.ts

@@ -1,7 +1,7 @@
 import { type GraphQLSchema } from 'graphql';
-import type { DocumentFile } from './config';
-import type { Naming } from './naming';
-import type { Writer } from './writer';
+import type { DocumentFile } from './config.js';
+import type { Naming } from './naming.js';
+import type { Writer } from './writer.js';
 /**
  * One schema per fragment and per named operation in `documents`, for the
  * response as it arrives: what was selected, under its alias, custom

package/dist/results-selections.d.ts

@@ -1,6 +1,6 @@
 import { type FragmentDefinitionNode, type GraphQLCompositeType, type GraphQLSchema } from 'graphql';
-import { type Selected } from './collect-fields';
-import type { Writer } from './writer';
+import { type Selected } from './collect-fields.js';
+import type { Writer } from './writer.js';
 /**
  * The schema of a selection, for a response: what was selected, under its
  * alias. Deep selections are declared apart, as `<schema>$<n>`, which the

package/dist/scalars.d.ts

@@ -1,6 +1,6 @@
 import type { GraphQLScalarType } from 'graphql';
-import type { CodegenZodConfig } from './config';
-import type { Imports } from './imports';
+import type { CodegenZodConfig } from './config.js';
+import type { Imports } from './imports.js';
 /**
  * Where each custom scalar's schema comes from: `zodScalars` first, then the
  * `scalarSchemas` record. A scalar in neither fails generation, naming it:

package/dist/schema-output.d.ts

@@ -1,6 +1,6 @@
 import { type GraphQLSchema } from 'graphql';
-import type { Naming } from './naming';
-import type { Writer } from './writer';
+import type { Naming } from './naming.js';
+import type { Writer } from './writer.js';
 /**
  * The SDL's part of the file: every enum, then every input type, then the
  * arguments of every object and interface field that takes any. Types are

package/dist/source.d.ts

@@ -1,5 +1,5 @@
-import type { Naming } from './naming';
-import type { ValueCode } from './writer';
+import type { Naming } from './naming.js';
+import type { ValueCode } from './writer.js';
 /** A GraphQL description as a doc comment, or nothing. */
 export declare function docComment(description: string | null | undefined, indent?: string): string;
 /** The members of a `z.object({...})`, a getter for each lazy one. */

package/dist/type-code.d.ts

@@ -1,6 +1,6 @@
 import { type GraphQLInputObjectType } from 'graphql';
-import type { Naming } from './naming';
-import type { Writer } from './writer';
+import type { Naming } from './naming.js';
+import type { Writer } from './writer.js';
 /**
  * An input type in a cycle, declared with its types written out, since
  * TypeScript cannot infer them: `Filter` (what the resolver receives),

package/dist/variables-output.d.ts

@@ -1,7 +1,7 @@
 import { type GraphQLSchema } from 'graphql';
-import type { DocumentFile } from './config';
-import type { Naming } from './naming';
-import type { Writer } from './writer';
+import type { DocumentFile } from './config.js';
+import type { Naming } from './naming.js';
+import type { Writer } from './writer.js';
 /**
  * One schema per named operation in `documents`, for its variables as a
  * client sends them (`z.input`). A variable gets the constraints of every

package/dist/writer.d.ts

@@ -1,7 +1,7 @@
 import { type Constraint } from '@nxgt/graphql-validation/codegen';
 import { type ConstValueNode, type GraphQLDirective, type GraphQLInputType, type GraphQLNamedInputType, type GraphQLScalarType } from 'graphql';
-import type { Naming } from './naming';
-import type { ScalarSources } from './scalars';
+import type { Naming } from './naming.js';
+import type { ScalarSources } from './scalars.js';
 /** One value's schema as source, and whether it names an input object. */
 export interface ValueCode {
     readonly code: string;

package/docs/guide/output.md

@@ -413,7 +413,7 @@ A custom scalar needs a Zod schema from you, mapped in one of two ways:
 
 | Option | Type | Effect |
 | --- | --- | --- |
-| `scalarSchemas` | `string` | a module exporting a `scalarSchemas` record keyed by GraphQL name; `@nxgt/graphql-scalars` exports one from 0.4.0 |
+| `scalarSchemas` | `string` | a module exporting a `scalarSchemas` record keyed by GraphQL name; `@nxgt/graphql-scalars` exports one from 0.4.0, `@nxgt/zod` from 0.1.0 |
 | `zodScalars` | `Record<string, string>` | `'<module>#<export>'` for one scalar; wins over the record |
 
 ```ts
@@ -435,6 +435,39 @@ birth: scalarSchemas.DateTime.nullish(),
 price: moneySchema,
 ```
 
+### On a client: `@nxgt/zod`
+
+`@nxgt/zod` exports the same `scalarSchemas` record, with the rules of
+`@nxgt/graphql-scalars`, and does not depend on `graphql`. A client that only
+runs the generated file imports it instead, and keeps `graphql` out of its
+bundle:
+
+```ts
+config: { scalarSchemas: '@nxgt/zod' },
+```
+
+```ts
+// what the generated file imports
+import { z } from "zod";
+import { scalarSchemas } from "@nxgt/zod";
+```
+
+The generated schemas are the same either way; only the import changes. The
+SDL codegen reads still comes from `@nxgt/graphql-scalars`
+(`bunx nxgt-graphql-scalars typedefs --out`), so a client installs it as a
+devDependency and `@nxgt/zod` as a dependency. Everything codegen needs is a
+devDependency too, so `graphql` never reaches the bundle: the generated file
+imports only `zod` and `@nxgt/zod`.
+
+```sh
+bun add @nxgt/zod zod
+bun add -d @nxgt/graphql-codegen-zod @nxgt/graphql-validation @nxgt/graphql-scalars
+bun add -d graphql @graphql-codegen/cli typescript
+```
+
+Under `moduleResolution` `nodenext` or `node16`, use `@nxgt/zod` 0.1.2 or
+later.
+
 - Two exports with the same name from different modules are aliased:
   `import { schema } from "./money"; import { schema as schema2 } from "./cost";`.
 - Module paths are written as they are in the generated file, so a relative

package/docs/roadmap.md

@@ -4,10 +4,7 @@ What `@nxgt/graphql-codegen-zod` is heading for, phrased as what you get.
 
 ## Now
 
-- **Output types.** Zod schemas and types for the SDL's object types,
-  interfaces and unions, and for each named operation's result and each
-  fragment, with `__typename` discriminating abstract types. Both parts are
-  written; they ship with the next release.
+Nothing in progress.
 
 ## Next
 
@@ -32,6 +29,13 @@ Nothing yet.
 
 ## Shipped
 
+- **Declarations that resolve under `nodenext`, 0.2.1.** The generated
+  file's `scalarSchemas` import typechecks with `moduleResolution`
+  `nodenext` or `node16`, with `@nxgt/graphql-scalars` 0.4.1 or later.
+- **Output types, 0.2.0.** Zod schemas and types for the SDL's object types,
+  interfaces and unions, and for each named operation's result and each
+  fragment, with `__typename` discriminating abstract types; `objects: false`
+  or `operations: false` turns either part off.
 - **The first release, 0.1.0.** Zod 4 schemas and types for enums, input
   types, field arguments and operation variables, carrying every
   `@constraint` of `@nxgt/graphql-validation`, so the client refuses what the

package/docs/troubleshooting.md

@@ -147,6 +147,30 @@ query Both($e: String, $u: String) { e(v: $e) u(v: $u) }
 
 ## The generated file
 
+### `TS2305: Module '"@nxgt/graphql-scalars"' has no exported member 'scalarSchemas'`
+
+**When:** type-checking the generated file under `moduleResolution`
+`nodenext` or `node16`, with `scalarSchemas: '@nxgt/graphql-scalars'`.
+**Why:** `@nxgt/graphql-scalars` before 0.4.1 ships declarations that
+`nodenext` does not resolve.
+**Fix:** upgrade it to 0.4.1 or later.
+
+```bash
+bun add @nxgt/graphql-scalars@latest
+```
+
+### `TS2305: Module '"@nxgt/zod"' has no exported member 'scalarSchemas'`
+
+**When:** type-checking the generated file under `moduleResolution`
+`nodenext` or `node16`, with `scalarSchemas: '@nxgt/zod'`.
+**Why:** `@nxgt/zod` before 0.1.2 ships declarations that `nodenext` does not
+resolve.
+**Fix:** upgrade it to 0.1.2 or later.
+
+```bash
+bun add @nxgt/zod@latest
+```
+
 ### `Property 'Money' does not exist on type '{ DateTime: ... }'` (or `TS2339`)
 
 **When:** type-checking the generated file, with `scalarSchemas` set.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nxgt/graphql-codegen-zod",
-	"version": "0.2.0",
+	"version": "0.2.2",
 	"description": "A graphql-codegen plugin that writes Zod schemas from your SDL — inputs, enums, field arguments, operation variables, operation results and output types — with the @constraint rules of @nxgt/graphql-validation",
 	"license": "MIT",
 	"type": "module",
@@ -46,11 +46,12 @@
 		"generated:write": "bun run test/write-generated.ts"
 	},
 	"dependencies": {
-		"@nxgt/graphql-validation": "^0.2.0",
+		"@nxgt/graphql-validation": "^0.2.1",
 		"change-case": "^5.4.4"
 	},
 	"devDependencies": {
-		"@nxgt/graphql-scalars": "^0.4.0",
+		"@nxgt/graphql-scalars": "^0.4.1",
+		"@nxgt/zod": "^0.1.2",
 		"@types/bun": "^1.4.0",
 		"graphql": "16.11.0",
 		"zod": "4.6.5"