zod-openapi 0.5.1 → 0.5.2

package/README.md

@@ -346,11 +346,40 @@ const header = z.string().openapi({
 
 ## Supported OpenAPI Versions
 
-- '3.0.0'
-- '3.0.1'
-- '3.0.2'
-- '3.0.3'
-- '3.1.0'
+Currently the following versions of OpenAPI are supported
+
+- `3.0.0`
+- `3.0.1`
+- `3.0.2`
+- `3.0.3`
+- `3.1.0`
+
+Setting the `openapi` field will change how the some of the components are rendered.
+
+```ts
+createDocument({
+  openapi: '3.1.0',
+});
+```
+
+For example in `z.string().nullable()` will be rendered differently
+
+`3.0.0`
+
+```json
+{
+  "type": "string",
+  "nullable": true
+}
+```
+
+`3.1.0`
+
+```json
+{
+  "type": ["string", "null"]
+}
+```
 
 ## Supported Zod Schema
 
@@ -386,6 +415,7 @@ const header = z.string().openapi({
   - `pattern` mapping for `.regex()`
 - ZodTuple
   - `items` mapping for `.rest()`
+  - `prefixItems` mapping for OpenAPI 3.1.0+
 - ZodUnion
 
 If this library cannot determine a type for a Zod Schema, it will throw an error. To avoid this, declare a manual `type` in the `.openapi()` section of that schema.
@@ -447,4 +477,85 @@ To release a new beta version
 
 ## Credits
 
-- [@asteasolutions/zod-to-openapi](https://github.com/asteasolutions/zod-to-openapi) - zod-openapi was created while trying to re-write the wonderful library to support auto registering schemas. However, the underlying structure of the library which consists of tightly coupled classes would not allow for this be done easily. As a result zod-openapi was born with the goal of keeping the Zod Schemas independent from the generation of the documentation.
+### [@asteasolutions/zod-to-openapi](https://github.com/asteasolutions/zod-to-openapi)
+
+zod-openapi was created while trying to re-write the wonderful library to support auto registering schemas. However, the underlying structure of the library which consists of tightly coupled classes would not allow for this be done easily. As a result zod-openapi was born with the goal of keeping the Zod Schemas independent from the generation of the documentation.
+
+#### Migration
+
+1. Delete the OpenAPIRegistry and OpenAPIGenerator classes
+2. Replace any `.register()` call made and replace them with `ref` in `.openapi()`.
+
+```ts
+const registry = new OpenAPIRegistry();
+
+const foo = registry.register(
+  'foo',
+  z.string().openapi({ description: 'foo' }),
+);
+const bar = z.object({ foo });
+
+// Replace with:
+const foo = z.string().openapi({ ref: 'foo', description: 'foo' });
+const bar = z.object({ foo });
+```
+
+3. Replace `registry.registerComponent()` with a regular OpenAPI component in the document.
+
+```ts
+const registry = new OpenAPIRegistry();
+
+registry.registerComponent('securitySchemes', 'auth', {
+  type: 'http',
+  scheme: 'bearer',
+  bearerFormat: 'JWT',
+  description: 'An auth token issued by oauth",
+});
+// Replace with regular component declaration
+
+const document = createDocument({
+  components: {
+    securitySchemes: { // declare directly in components
+      auth: {
+        type: 'http',
+        scheme: 'bearer',
+        bearerFormat: 'JWT',
+        description: 'An auth token issued by oauth",
+      }
+    }
+  }
+});
+```
+
+4. Replace `registry.registerPath()` with a regular OpenAPI paths in the document.
+
+```ts
+const registry = new OpenAPIRegistry();
+
+registry.registerPath({
+  method: 'get',
+  path: '/foo',
+  request: {
+    query: z.object({ a: z.string() }),
+    params: z.object({ b: z.string() }),
+  },
+  responses: {},
+});
+// Replace with regular path declaration
+
+const getFoo: ZodOpenApiPathItemObject = {
+  get: {
+    requestParams: {
+      query: z.object({ a: z.string() }),
+      path: z.object({ b: z.string() }), // renamed params -> path
+    }, // renamed from request -> requestParams
+    responses: {},
+  },
+};
+
+const document = createDocument({
+  paths: {
+    '/foo': getFoo,
+  },
+});
+```

package/lib-commonjs/create/content.js.map

@@ -1 +1 @@
-{"version":3,"file":"content.js","sourceRoot":"","sources":["../../src/create/content.ts"],"names":[],"mappings":";;;AACA,6BAA4C;AAI5C,qCAA6C;AAE7C,MAAM,qBAAqB,GAAG,CAC5B,YAIa,EACb,UAA4B,EAC5B,IAAkB,EACsC,EAAE;IAC1D,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,CAAC,CAAC,YAAY,YAAY,aAAO,CAAC,EAAE;QACtC,OAAO,YAAY,CAAC;KACrB;IAED,OAAO,IAAA,0BAAiB,EAAC,YAAY,EAAE;QACrC,UAAU;QACV,IAAI;KACL,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAC5B,eAAsD,EACtD,UAA4B,EAC5B,IAAkB,EACiB,EAAE;IACrC,IAAI,CAAC,eAAe,EAAE;QACpB,OAAO,SAAS,CAAC;KAClB;IAED,OAAO;QACL,GAAG,eAAe;QAClB,MAAM,EAAE,qBAAqB,CAAC,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC;KACxE,CAAC;AACJ,CAAC,CAAC;AAEK,MAAM,aAAa,GAAG,CAC3B,aAAsC,EACtC,UAA4B,EAC5B,IAAkB,EACG,EAAE,CACvB,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,MAAM,CAClC,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,yBAAyB,CAAC,EAAuB,EAAE;IAC9D,MAAM,eAAe,GAAG,qBAAqB,CAC3C,yBAAyB,EACzB,UAAU,EACV,IAAI,CACL,CAAC;IAEF,IAAI,eAAe,EAAE;QACnB,GAAG,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC;KAC7B;IACD,OAAO,GAAG,CAAC;AACb,CAAC,EACD,EAAE,CACH,CAAC;AAnBS,QAAA,aAAa,iBAmBtB"}
+{"version":3,"file":"content.js","sourceRoot":"","sources":["../../src/create/content.ts"],"names":[],"mappings":";;;AACA,6BAA8B;AAI9B,qCAA6C;AAE7C,MAAM,qBAAqB,GAAG,CAC5B,YAIa,EACb,UAA4B,EAC5B,IAAkB,EACsC,EAAE;IAC1D,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,CAAC,CAAC,YAAY,YAAY,aAAO,CAAC,EAAE;QACtC,OAAO,YAAY,CAAC;KACrB;IAED,OAAO,IAAA,0BAAiB,EAAC,YAAY,EAAE;QACrC,UAAU;QACV,IAAI;KACL,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAC5B,eAAsD,EACtD,UAA4B,EAC5B,IAAkB,EACiB,EAAE;IACrC,IAAI,CAAC,eAAe,EAAE;QACpB,OAAO,SAAS,CAAC;KAClB;IAED,OAAO;QACL,GAAG,eAAe;QAClB,MAAM,EAAE,qBAAqB,CAAC,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC;KACxE,CAAC;AACJ,CAAC,CAAC;AAEK,MAAM,aAAa,GAAG,CAC3B,aAAsC,EACtC,UAA4B,EAC5B,IAAkB,EACG,EAAE,CACvB,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,MAAM,CAClC,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,yBAAyB,CAAC,EAAuB,EAAE;IAC9D,MAAM,eAAe,GAAG,qBAAqB,CAC3C,yBAAyB,EACzB,UAAU,EACV,IAAI,CACL,CAAC;IAEF,IAAI,eAAe,EAAE;QACnB,GAAG,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC;KAC7B;IACD,OAAO,GAAG,CAAC;AACb,CAAC,EACD,EAAE,CACH,CAAC;AAnBS,QAAA,aAAa,iBAmBtB"}

package/lib-es2015/create/content.js.map

@@ -1 +1 @@
-{"version":3,"file":"content.js","sourceRoot":"","sources":["../../src/create/content.ts"],"names":[],"mappings":"AACA,OAAO,EAAgB,OAAO,EAAE,MAAM,KAAK,CAAC;AAI5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,MAAM,qBAAqB,GAAG,CAC5B,YAIa,EACb,UAA4B,EAC5B,IAAkB,EACsC,EAAE;IAC1D,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,CAAC,CAAC,YAAY,YAAY,OAAO,CAAC,EAAE;QACtC,OAAO,YAAY,CAAC;KACrB;IAED,OAAO,iBAAiB,CAAC,YAAY,EAAE;QACrC,UAAU;QACV,IAAI;KACL,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAC5B,eAAsD,EACtD,UAA4B,EAC5B,IAAkB,EACiB,EAAE;IACrC,IAAI,CAAC,eAAe,EAAE;QACpB,OAAO,SAAS,CAAC;KAClB;IAED,OAAO;QACL,GAAG,eAAe;QAClB,MAAM,EAAE,qBAAqB,CAAC,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC;KACxE,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,aAAsC,EACtC,UAA4B,EAC5B,IAAkB,EACG,EAAE,CACvB,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,MAAM,CAClC,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,yBAAyB,CAAC,EAAuB,EAAE;IAC9D,MAAM,eAAe,GAAG,qBAAqB,CAC3C,yBAAyB,EACzB,UAAU,EACV,IAAI,CACL,CAAC;IAEF,IAAI,eAAe,EAAE;QACnB,GAAG,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC;KAC7B;IACD,OAAO,GAAG,CAAC;AACb,CAAC,EACD,EAAE,CACH,CAAC"}
+{"version":3,"file":"content.js","sourceRoot":"","sources":["../../src/create/content.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AAI9B,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,MAAM,qBAAqB,GAAG,CAC5B,YAIa,EACb,UAA4B,EAC5B,IAAkB,EACsC,EAAE;IAC1D,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,CAAC,CAAC,YAAY,YAAY,OAAO,CAAC,EAAE;QACtC,OAAO,YAAY,CAAC;KACrB;IAED,OAAO,iBAAiB,CAAC,YAAY,EAAE;QACrC,UAAU;QACV,IAAI;KACL,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAC5B,eAAsD,EACtD,UAA4B,EAC5B,IAAkB,EACiB,EAAE;IACrC,IAAI,CAAC,eAAe,EAAE;QACpB,OAAO,SAAS,CAAC;KAClB;IAED,OAAO;QACL,GAAG,eAAe;QAClB,MAAM,EAAE,qBAAqB,CAAC,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC;KACxE,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,aAAsC,EACtC,UAA4B,EAC5B,IAAkB,EACG,EAAE,CACvB,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,MAAM,CAClC,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,yBAAyB,CAAC,EAAuB,EAAE;IAC9D,MAAM,eAAe,GAAG,qBAAqB,CAC3C,yBAAyB,EACzB,UAAU,EACV,IAAI,CACL,CAAC;IAEF,IAAI,eAAe,EAAE;QACnB,GAAG,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC;KAC7B;IACD,OAAO,GAAG,CAAC;AACb,CAAC,EACD,EAAE,CACH,CAAC"}

package/lib-types/create/document.d.ts

@@ -3,7 +3,7 @@ import { stringify } from 'yaml';
 import { AnyZodObject, ZodType } from 'zod';
 import { OpenApiVersion } from '../openapi';
 export interface ZodOpenApiMediaTypeObject extends Omit<oas31.MediaTypeObject & oas30.MediaTypeObject, 'schema'> {
-    schema?: AnyZodObject | oas31.SchemaObject | oas31.ReferenceObject;
+    schema?: ZodType | oas31.SchemaObject | oas31.ReferenceObject;
 }
 export interface ZodOpenApiContentObject {
     'application/json'?: ZodOpenApiMediaTypeObject;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod-openapi",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "A library to create full OpenAPI documents from your Zod types",
   "homepage": "https://github.com/samchungy/zod-openapi#readme",
   "bugs": {