zod-openapi 4.0.0 → 4.1.1

package/README.md

@@ -68,7 +68,7 @@ Use the `.openapi()` method to add metadata to a specific Zod type. The `.openap
 |      `ref`      |                                  Use this to [auto register a schema as a re-usable component](#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.                               |
-|  `unionOneOf`   | Set to `true` to force a single ZodUnion to output `oneOf` instead of `allOf`. See [CreateDocumentOptions](#CreateDocumentOptions) for a global option |
+|  `unionOneOf`   | Set to `true` to force a single ZodUnion to output `oneOf` instead of `anyOf`. See [CreateDocumentOptions](#CreateDocumentOptions) for a global option |
 
 ### `createDocument`
 
@@ -205,7 +205,8 @@ const document = createDocument({
 ```typescript
 const document = createDocument(details, {
   defaultDateSchema: { type: 'string', format: 'date-time' }, // defaults to { type: 'string' }
-  unionOneOf: true, // defaults to false. Forces all ZodUnions to output oneOf instead of allOf. An `.openapi()` `unionOneOf` value takes precedence over this one.
+  unionOneOf: true, // defaults to false. Forces all ZodUnions to output oneOf instead of anyOf. An `.openapi()` `unionOneOf` value takes precedence over this one.
+  enforceDiscriminatedUnionComponents: true, // defaults to false. Throws an error if a Discriminated Union member is not registered as a component.
 });
 ```
 
@@ -449,7 +450,7 @@ Wherever `title` is used in schemas across the document, it will instead be crea
 }
 ```
 
-This can be an extremely powerful way to create less repetitive Open API documentation. There are some Open API features like [discriminator mapping](https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/) which require all schemas in the union to contain a ref.
+This is a great way to create less repetitive Open API documentation. There are some Open API features like [discriminator mapping](https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/) which require all schemas in the union to contain a ref.
 
 ##### Manually Registering Schema
 
@@ -467,7 +468,7 @@ createDocument({
 });
 ```
 
-Unfortunately, as a limitation of this library, you will need to attach an `.openapi()` field or `.describe()` to the schema that you are passing into the components or else you may not get the full power of the component generation. As a result, I recommend utilising the auto registering components over manual egistration.
+Unfortunately, as a limitation of this library, you will need to attach an `.openapi()` field or `.describe()` to the schema that you are passing into the components or you will not reap the full benefits of component generation. As a result, I recommend utilising the auto registering components over manual registration.
 
 #### Parameters
 
@@ -763,6 +764,8 @@ As an example `z.string().nullable()` will be rendered differently
 - ZodAny
 - ZodArray
   - `minItems`/`maxItems` mapping for `.length()`, `.min()`, `.max()`
+- ZodBigInt
+  - `integer` `type` and `int64` `format` mapping
 - ZodBoolean
 - ZodBranded
 - ZodCatch
@@ -811,7 +814,7 @@ As an example `z.string().nullable()` will be rendered differently
   - `prefixItems` mapping for OpenAPI 3.1.0+
 - ZodUndefined
 - ZodUnion
-  - By default it outputs an `allOf` schema. Use `unionOneOf` to change this to output `oneOf` instead.
+  - By default it outputs an `anyOf` schema. Use `unionOneOf` to change this to output `oneOf` instead.
 - ZodUnknown
 
 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.

package/dist/components.chunk.cjs

@@ -154,6 +154,13 @@ const createArraySchema = (zodArray, state) => {
     effects: items.effects
   };
 };
+const createBigIntSchema = (_zodBigInt) => ({
+  type: "schema",
+  schema: {
+    type: "integer",
+    format: "int64"
+  }
+});
 const createBooleanSchema = (_zodBoolean) => ({
   type: "schema",
   schema: {
@@ -452,6 +459,7 @@ const unwrapLiterals = (zodType, state) => {
   return void 0;
 };
 const mapDiscriminator = (schemas, zodObjects, discriminator, state) => {
+  var _a;
   if (typeof discriminator !== "string") {
     return void 0;
   }
@@ -460,6 +468,11 @@ const mapDiscriminator = (schemas, zodObjects, discriminator, state) => {
     const schema = schemas[index];
     const componentSchemaRef = "$ref" in schema ? schema == null ? void 0 : schema.$ref : void 0;
     if (!componentSchemaRef) {
+      if ((_a = state.documentOptions) == null ? void 0 : _a.enforceDiscriminatedUnionComponents) {
+        throw new Error(
+          `Discriminated Union member ${index} at ${state.path.join(" > ")} is not registered as a component`
+        );
+      }
       return void 0;
     }
     const value = zodObject.shape[discriminator];
@@ -1379,6 +1392,9 @@ const createSchemaSwitch = (zodSchema, previous, state) => {
   if (isZodType(zodSchema, "ZodSet")) {
     return createSetSchema(zodSchema, state);
   }
+  if (isZodType(zodSchema, "ZodBigInt")) {
+    return createBigIntSchema();
+  }
   return createManualTypeSchema(zodSchema, state);
 };
 const createNewSchema = ({

package/dist/components.chunk.mjs

@@ -153,6 +153,13 @@ const createArraySchema = (zodArray, state) => {
     effects: items.effects
   };
 };
+const createBigIntSchema = (_zodBigInt) => ({
+  type: "schema",
+  schema: {
+    type: "integer",
+    format: "int64"
+  }
+});
 const createBooleanSchema = (_zodBoolean) => ({
   type: "schema",
   schema: {
@@ -451,6 +458,7 @@ const unwrapLiterals = (zodType, state) => {
   return void 0;
 };
 const mapDiscriminator = (schemas, zodObjects, discriminator, state) => {
+  var _a;
   if (typeof discriminator !== "string") {
     return void 0;
   }
@@ -459,6 +467,11 @@ const mapDiscriminator = (schemas, zodObjects, discriminator, state) => {
     const schema = schemas[index];
     const componentSchemaRef = "$ref" in schema ? schema == null ? void 0 : schema.$ref : void 0;
     if (!componentSchemaRef) {
+      if ((_a = state.documentOptions) == null ? void 0 : _a.enforceDiscriminatedUnionComponents) {
+        throw new Error(
+          `Discriminated Union member ${index} at ${state.path.join(" > ")} is not registered as a component`
+        );
+      }
       return void 0;
     }
     const value = zodObject.shape[discriminator];
@@ -1378,6 +1391,9 @@ const createSchemaSwitch = (zodSchema, previous, state) => {
   if (isZodType(zodSchema, "ZodSet")) {
     return createSetSchema(zodSchema, state);
   }
+  if (isZodType(zodSchema, "ZodBigInt")) {
+    return createBigIntSchema();
+  }
   return createManualTypeSchema(zodSchema, state);
 };
 const createNewSchema = ({

package/dist/create/document.d.ts

@@ -74,12 +74,16 @@ interface ZodOpenApiObject extends Omit<OpenAPIObject, 'openapi' | 'paths' | 'we
 }
 type ZodObjectInputType<Output = unknown, Def extends ZodTypeDef = ZodTypeDef, Input = Record<string, unknown>> = ZodType<Output, Def, Input>;
 interface CreateDocumentOptions {
+    /**
+     * Used to throw an error if a Discriminated Union member is not registered as a component
+     */
+    enforceDiscriminatedUnionComponents?: boolean;
     /**
      * Used to change the default Zod Date schema
      */
     defaultDateSchema?: Pick<SchemaObject, 'type' | 'format'>;
     /**
-     * Used to set the output of a ZodUnion to be `oneOf` instead of `allOf`
+     * Used to set the output of a ZodUnion to be `oneOf` instead of `anyOf`
      */
     unionOneOf?: boolean;
 }

package/dist/extendZodTypes.d.ts

@@ -1,16 +1,17 @@
-import { ZodTypeAny, z, ZodDate, ZodObject } from 'zod';
+import { ZodTypeAny, z, ZodObject } from 'zod';
 import { CreationType } from './create/components.js';
 import { HeaderObject as HeaderObject$1, SchemaObject as SchemaObject$1 } from './openapi3-ts/dist/model/openapi30.js';
 import { ParameterObject, ExampleObject, ReferenceObject, HeaderObject, SchemaObject as SchemaObject$2 } from './openapi3-ts/dist/model/openapi31.js';
 
 type SchemaObject = SchemaObject$1 & SchemaObject$2;
+type ReplaceDate<T> = T extends Date ? Date | string : T;
 /**
  * zod-openapi metadata
  */
-interface ZodOpenApiMetadata<T extends ZodTypeAny, TInferred = z.input<T> | z.output<T>> extends SchemaObject {
+interface ZodOpenApiMetadata<T extends ZodTypeAny, TInferred = Exclude<ReplaceDate<z.input<T> | z.output<T>>, undefined>> extends SchemaObject {
     example?: TInferred;
     examples?: [TInferred, ...TInferred[]];
-    default?: T extends ZodDate ? string : TInferred;
+    default?: TInferred;
     /**
      * Used to set the output of a ZodUnion to be `oneOf` instead of `allOf`
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod-openapi",
-  "version": "4.0.0",
+  "version": "4.1.1",
   "description": "Convert Zod Schemas to OpenAPI v3.x documentation",
   "keywords": [
     "typescript",
@@ -72,14 +72,14 @@
     "test:watch": "skuba test --watch"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "0.16.4",
+    "@arethetypeswrong/cli": "0.17.0",
     "@crackle/cli": "0.15.5",
-    "@redocly/cli": "1.25.9",
+    "@redocly/cli": "1.25.13",
     "@types/node": "^20.3.0",
     "eslint-plugin-zod-openapi": "^1.0.0-beta.0",
     "openapi3-ts": "4.4.0",
     "skuba": "9.1.0",
-    "yaml": "2.6.0",
+    "yaml": "2.6.1",
     "zod": "3.23.8"
   },
   "peerDependencies": {