@shipworthy/openapi-zod 0.0.1 → 0.0.2

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.
Files changed (2) hide show
  1. package/README.md +4 -4
  2. package/package.json +5 -6
package/README.md CHANGED
@@ -5,7 +5,7 @@ Generate [Zod 4](https://zod.dev) validators from an OpenAPI 3.1 document. Every
5
5
  ## Installation
6
6
 
7
7
  ```sh
8
- bun add -d @shipworthy/openapi-zod @shipworthy/openapi-cli effect@^4.0.0
8
+ bun add -d @shipworthy/openapi-zod @shipworthy/openapi-cli
9
9
  ```
10
10
 
11
11
  The generator and generated file both import `zod`. It is a required peer dependency of this package, so install this exact version as your app's runtime dependency:
@@ -19,8 +19,8 @@ Requirements:
19
19
  - **Zod 4.6.5.** The generated code calls `z.fromJSONSchema` and `z.compile`. `fromJSONSchema` is experimental in Zod, so the package pins `zod@4.6.5`. Use the same version in your app.
20
20
  - **Node.js `>=22.19.0` or Bun.** The package ships compiled JavaScript and `.d.ts` declarations in `dist/`, so no TypeScript loader or bundler is needed. The `openapi` CLI runs on Node.js or Bun (`bunx --bun @shipworthy/openapi-cli ...`).
21
21
  - **ESM only.** The package sets `"type": "module"` and has a single `.` export. There is no CommonJS build.
22
- - **Peer dependencies.** `effect` `^4.0.0`, installed by you so every package shares one Effect instance, and `zod` `4.6.5`, shared by the generator and your app. npm 7+ installs peers automatically, but install both explicitly as shown above.
23
- - **Installed dependencies.** The package installs `@shipworthy/openapi-generator`, `@shipworthy/openapi-transformer`, and `@shipworthy/openapi-typescript`.
22
+ - **Peer dependency.** `zod` `4.6.5`, shared by the generator and your app. npm 7+ installs peers automatically, but install it explicitly as shown above.
23
+ - **Installed dependencies.** The package installs `effect`, `@shipworthy/openapi-generator`, `@shipworthy/openapi-transformer`, and `@shipworthy/openapi-typescript`.
24
24
 
25
25
  Install `@shipworthy/openapi-cli` only if you use the CLI. For programmatic examples, also install the packages you import directly (`@shipworthy/openapi-generator`, `@shipworthy/openapi-transformer`, and `@effect/platform-node` as needed).
26
26
 
@@ -338,7 +338,7 @@ Not generated:
338
338
  - Package exports: `zod` (generator plugin), `zodSources`, `operationRoutes`, `ZodGenerationError`, and the types `ZodSource`, `OperationRoute`, `HttpMethod`. All functions return Effect 4 values.
339
339
  - Generation is all-or-nothing for the Zod file. Unsupported keywords fail with a JSON-pointer message, but the CLI may already have written `types.ts`.
340
340
  - Every operation needs a unique `operationId`. Component names must be valid JS identifiers.
341
- - The package ships compiled ESM JavaScript with `.d.ts` declarations (no CommonJS build). Peer dependencies `effect@^4` and `zod@4.6.5`.
341
+ - The package ships compiled ESM JavaScript with `.d.ts` declarations (no CommonJS build). Peer dependency `zod@4.6.5`.
342
342
 
343
343
  ## License
344
344
 
package/package.json CHANGED
@@ -1,16 +1,16 @@
1
1
  {
2
2
  "name": "@shipworthy/openapi-zod",
3
- "version": "0.0.1",
3
+ "version": "0.0.2",
4
4
  "files": [
5
5
  "dist"
6
6
  ],
7
7
  "dependencies": {
8
- "@shipworthy/openapi-generator": "0.0.1",
9
- "@shipworthy/openapi-transformer": "0.0.1",
10
- "@shipworthy/openapi-typescript": "0.0.1"
8
+ "@shipworthy/openapi-generator": "0.0.2",
9
+ "@shipworthy/openapi-transformer": "0.0.2",
10
+ "@shipworthy/openapi-typescript": "0.0.2",
11
+ "effect": "^4.0.0"
11
12
  },
12
13
  "peerDependencies": {
13
- "effect": "^4.0.0",
14
14
  "zod": "4.6.5"
15
15
  },
16
16
  "description": "Generate Zod validators from OpenAPI 3.1 schemas.",
@@ -36,7 +36,6 @@
36
36
  "@effect/platform-node": "^4.0.0",
37
37
  "@shipworthy/typescript-config": "0.0.1",
38
38
  "@types/node": "^24.10.3",
39
- "effect": "^4.0.0",
40
39
  "typescript": "^7.0.2",
41
40
  "vitest": "5.0.3",
42
41
  "zod": "4.6.5"