zod-openapi 2.12.0 → 2.14.0

package/README.md

@@ -17,19 +17,21 @@ A Typescript library to use <a href="https://github.com/colinhacks/zod">Zod</a>
 
 ## Install
 
-Install via `npm` or `yarn`:
+Install via `npm`, `yarn` or `pnpm`:
 
 ```bash
 npm install zod zod-openapi
 ## or
 yarn add zod zod-openapi
+## or
+pnpm install zod zod-openapi
 ```
 
 ## Usage
 
 ### `extendZodWithOpenApi`
 
-This mutates Zod to add an extra `.openapi()` method. Make a side-effectful import at the top of your entry point(s).
+This mutates Zod to add an extra `.openapi()` method. Call this at the top of your entry point(s).
 
 ```typescript
 import { z } from 'zod';
@@ -48,8 +50,8 @@ Use the `.openapi()` method to add metadata to a specific Zod type. The `.openap
 | :-------------: | :-------------------------------------------------------------------------------------------------------------------------: |
 | OpenAPI Options | This will take any option you would put on a [SchemaObject](https://swagger.io/docs/specification/data-models/data-types/). |
 |  `effectType`   |                             Use to override the creation type for a [Zod Effect](#zod-effects)                              |
-|     `param`     |                                Use to provide metadata for [request parameters](#parameters)                                |
 |    `header`     |                              Use to provide metadata for [response headers](#response-headers)                              |
+|     `param`     |                                Use to provide metadata for [request parameters](#parameters)                                |
 |      `ref`      |                                 Use this to [auto register a schema](#creating-components)                                  |
 |    `refType`    |                 Use this to set the creation type for a component which is not referenced in the document.                  |
 |     `type`      |                 Use this to override the generated type. If this is provided no metadata will be generated.                 |
@@ -328,13 +330,13 @@ createDocument({
 
 ##### Zod Effects
 
-`.transform()` and `.pipe()` are complicated because they technically comprise of two types (input & output). This means that we need to understand which type you are creating. In particular with transform it is very difficult to infer the output type. This library will automatically select which _type_ to use by checking how the schema is used based on the following rules:
+`.transform()`, `.default()` and `.pipe()` are complicated because they technically comprise of two types (input & output). This means that we need to understand which type you are creating. In particular with transform it is very difficult to infer the output type. This library will automatically select which _type_ to use by checking how the schema is used based on the following rules:
 
 _Input_: Request Bodies, Request Parameters, Headers
 
 _Output_: Responses, Response Headers
 
-If a registered schema with a transform or pipeline is used in both a request and response schema you will receive an error because the created schema for each will be different. To override the creation type for a specific ZodEffect, add an `.openapi()` field on it and set the `effectType` field to `input` or `output`. This will force this library to always generate the input/output type even if we are creating a response (output) or request (input) type. You typically want to use this when you know your transform has not changed the type.
+If a registered schema with a transform or pipeline is used in both a request and response schema you will receive an error because the created schema for each will be different. To override the creation type for a specific ZodEffect, add an `.openapi()` field on it and set the `effectType` field to `input`, `output` or `same`. This will force this library to always generate the input/output type even if we are creating a response (output) or request (input) type. You typically want to set this when you know the type has not changed in the transform. `same` is the recommended choice as it will generate a TypeScript compiler error if the input and output types in the transform drift.
 
 `.preprocess()` will always return the `output` type even if we are creating an input schema. If a different input type is required you can achieve this with a `.transform()` combined with a `.pipe()` or simply declare a manual `type` in `.openapi()`.
 
@@ -578,27 +580,27 @@ See the library in use in the [examples](./examples/) folder.
 ### Prerequisites
 
 - Node.js LTS
-- Yarn 1.x
+- pnpm
 
 ```shell
-yarn
-yarn build
+pnpm
+pnpm build
 ```
 
 ### Test
 
 ```shell
-yarn test
+pnpm test
 ```
 
 ### Lint
 
 ```shell
 # Fix issues
-yarn format
+pnpm format
 
 # Check for issues
-yarn lint
+pnpm lint
 ```
 
 ### Release