zod-openapi 2.4.0-beta.1 → 2.4.0

package/README.md

@@ -276,9 +276,7 @@ const title = z.string().openapi({
 Wherever `title` is used in schemas across the document, it will instead be created as a reference.
 
 ```json
-{
-  "title": { "$ref": "#/components/schemas/jobTitle" }
-}
+{ "$ref": "#/components/schemas/jobTitle" }
 ```
 
 `title` will then be outputted as a schema within the components section of the documentation.
@@ -309,7 +307,7 @@ eg.
 createDocument({
   components: {
     schemas: {
-      jobTitle, // this will register this Zod Schema as jobTitle unless `ref` in `.openapi()` is specified on the type
+      jobTitle: title, // this will register this Zod Schema as jobTitle unless `ref` in `.openapi()` is specified on the type
     },
   },
 });
@@ -323,7 +321,7 @@ If a registered schema with a transform or pipeline is used in both a request an
 
 `.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()`.
 
-If you are adding the ZodSchema directly to the `components` section which is not referenced anywhere in the document, context may required with knowing to create an input schema or an output schema. You can do this by setting the `refType` field to `input` or `output` in `.openapi()`. This defaults to `output` by default.
+If you are adding a ZodSchema directly to the `components` section which is not referenced anywhere in the document, additional context may be required to create either an input schema or an output schema. You can do this by setting the `refType` field to `input` or `output` in `.openapi()`. This defaults to `output` by default.
 
 #### Parameters
 
@@ -501,6 +499,7 @@ For example in `z.string().nullable()` will be rendered differently
   - `refine` full support
 - ZodEnum
 - ZodLazy
+  - The recursive schema within the ZodLazy or the ZodLazy _**must**_ be registered as a component. See [Creating Components](#creating-components) for more information.
 - ZodLiteral
 - ZodNativeEnum
   - supporting `string`, `number` and combined enums.

package/lib-commonjs/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./create/document"), exports);
 __exportStar(require("./extendZod"), exports);
+__exportStar(require("./openapi3-ts/dist"), exports);
 //# sourceMappingURL=index.js.map

package/lib-commonjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,8CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,8CAA4B;AAC5B,qDAAmC"}

package/lib-commonjs/openapi3-ts/dist/index.js

@@ -23,10 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServerVariable = exports.Server = exports.oas31 = exports.oas30 = void 0;
+exports.oas31 = exports.oas30 = void 0;
 exports.oas30 = __importStar(require("./oas30"));
 exports.oas31 = __importStar(require("./oas31"));
-var server_1 = require("./model/server");
-Object.defineProperty(exports, "Server", { enumerable: true, get: function () { return server_1.Server; } });
-Object.defineProperty(exports, "ServerVariable", { enumerable: true, get: function () { return server_1.ServerVariable; } });
 //# sourceMappingURL=index.js.map

package/lib-commonjs/openapi3-ts/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/openapi3-ts/dist/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iDAAiC;AACjC,iDAAiC;AACjC,yCAAwD;AAA/C,gGAAA,MAAM,OAAA;AAAE,wGAAA,cAAc,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/openapi3-ts/dist/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iDAAiC;AACjC,iDAAiC"}

package/lib-commonjs/openapi3-ts/dist/oas30.js

@@ -14,10 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServerVariable = exports.Server = void 0;
 __exportStar(require("./dsl/openapi-builder30"), exports);
 __exportStar(require("./model/openapi30"), exports);
-var server_1 = require("./model/server");
-Object.defineProperty(exports, "Server", { enumerable: true, get: function () { return server_1.Server; } });
-Object.defineProperty(exports, "ServerVariable", { enumerable: true, get: function () { return server_1.ServerVariable; } });
 //# sourceMappingURL=oas30.js.map

package/lib-commonjs/openapi3-ts/dist/oas30.js.map

@@ -1 +1 @@
-{"version":3,"file":"oas30.js","sourceRoot":"","sources":["../../../src/openapi3-ts/dist/oas30.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,oDAAkC;AAClC,yCAAwD;AAA/C,gGAAA,MAAM,OAAA;AAAE,wGAAA,cAAc,OAAA"}
+{"version":3,"file":"oas30.js","sourceRoot":"","sources":["../../../src/openapi3-ts/dist/oas30.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,oDAAkC"}

package/lib-commonjs/openapi3-ts/dist/oas31.js

@@ -14,10 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServerVariable = exports.Server = void 0;
 __exportStar(require("./dsl/openapi-builder31"), exports);
 __exportStar(require("./model/openapi31"), exports);
-var server_1 = require("./model/server");
-Object.defineProperty(exports, "Server", { enumerable: true, get: function () { return server_1.Server; } });
-Object.defineProperty(exports, "ServerVariable", { enumerable: true, get: function () { return server_1.ServerVariable; } });
 //# sourceMappingURL=oas31.js.map

package/lib-commonjs/openapi3-ts/dist/oas31.js.map

@@ -1 +1 @@
-{"version":3,"file":"oas31.js","sourceRoot":"","sources":["../../../src/openapi3-ts/dist/oas31.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,oDAAkC;AAClC,yCAAwD;AAA/C,gGAAA,MAAM,OAAA;AAAE,wGAAA,cAAc,OAAA"}
+{"version":3,"file":"oas31.js","sourceRoot":"","sources":["../../../src/openapi3-ts/dist/oas31.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,oDAAkC"}

package/lib-es2015/index.js

@@ -1,3 +1,4 @@
 export * from './create/document';
 export * from './extendZod';
+export * from './openapi3-ts/dist';
 //# sourceMappingURL=index.js.map

package/lib-es2015/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC"}

package/lib-es2015/openapi3-ts/dist/index.js

@@ -2,5 +2,4 @@ import * as oas30_1 from "./oas30";
 export { oas30_1 as oas30 };
 import * as oas31_1 from "./oas31";
 export { oas31_1 as oas31 };
-export { Server, ServerVariable } from "./model/server";
 //# sourceMappingURL=index.js.map

package/lib-es2015/openapi3-ts/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/openapi3-ts/dist/index.ts"],"names":[],"mappings":"yBAAuB,SAAS;oBAApB,KAAK;yBACM,SAAS;oBAApB,KAAK;AACjB,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/openapi3-ts/dist/index.ts"],"names":[],"mappings":"yBAAuB,SAAS;oBAApB,KAAK;yBACM,SAAS;oBAApB,KAAK"}

package/lib-es2015/openapi3-ts/dist/oas30.js

@@ -1,4 +1,3 @@
 export * from './dsl/openapi-builder30';
 export * from './model/openapi30';
-export { Server, ServerVariable } from './model/server';
 //# sourceMappingURL=oas30.js.map

package/lib-es2015/openapi3-ts/dist/oas30.js.map

@@ -1 +1 @@
-{"version":3,"file":"oas30.js","sourceRoot":"","sources":["../../../src/openapi3-ts/dist/oas30.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"oas30.js","sourceRoot":"","sources":["../../../src/openapi3-ts/dist/oas30.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC"}

package/lib-es2015/openapi3-ts/dist/oas31.js

@@ -1,4 +1,3 @@
 export * from './dsl/openapi-builder31';
 export * from './model/openapi31';
-export { Server, ServerVariable } from './model/server';
 //# sourceMappingURL=oas31.js.map

package/lib-es2015/openapi3-ts/dist/oas31.js.map

@@ -1 +1 @@
-{"version":3,"file":"oas31.js","sourceRoot":"","sources":["../../../src/openapi3-ts/dist/oas31.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"oas31.js","sourceRoot":"","sources":["../../../src/openapi3-ts/dist/oas31.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC"}

package/lib-types/index.d.ts

@@ -1,3 +1,3 @@
 export * from './create/document';
 export * from './extendZod';
-export type * from './openapi3-ts/dist';
+export * from './openapi3-ts/dist';

package/lib-types/openapi3-ts/dist/index.d.ts

@@ -1,3 +1,3 @@
 export * as oas30 from "./oas30";
 export * as oas31 from "./oas31";
-export { Server, ServerVariable } from "./model/server";
+export type { Server, ServerVariable } from "./model/server";

package/lib-types/openapi3-ts/dist/oas30.d.ts

@@ -1,4 +1,4 @@
 export * from './dsl/openapi-builder30';
 export * from './model/openapi30';
-export { Server, ServerVariable } from './model/server';
+export type { Server, ServerVariable } from './model/server';
 export type { IExtensionName, IExtensionType, ISpecificationExtension } from './model/specification-extension';

package/lib-types/openapi3-ts/dist/oas31.d.ts

@@ -1,4 +1,4 @@
 export * from './dsl/openapi-builder31';
 export * from './model/openapi31';
-export { Server, ServerVariable } from './model/server';
+export type { Server, ServerVariable } from './model/server';
 export type { IExtensionName, IExtensionType, ISpecificationExtension } from './model/specification-extension';

package/package.json

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