zod-openapi 2.16.0 → 2.17.0-beta.2

package/README.md

@@ -29,12 +29,23 @@ pnpm install zod zod-openapi
 
 ## Usage
 
-### `extendZodWithOpenApi`
+### Extend Zod
 
 This mutates Zod to add an extra `.openapi()` method. Call this at the top of your entry point(s).
 
-```typescript
+```ts
+import 'zod-openapi/extend';
 import { z } from 'zod';
+
+z.string().openapi({ description: 'hello world!', example: 'hello world' });
+```
+
+#### Manual
+
+This is useful if you have a different instance of Zod that you would like to extend.
+
+```typescript
+import { z } from 'another-lib';
 import { extendZodWithOpenApi } from 'zod-openapi';
 
 extendZodWithOpenApi(z);
@@ -65,11 +76,10 @@ Creates an OpenAPI documentation object
 import { z } from 'zod';
 import { createDocument, extendZodWithOpenApi } from 'zod-openapi';
 
-extendZodWithOpenApi(z);
-
 const jobId = z.string().openapi({
-  description: 'Job ID',
+  description: 'A unique identifier for a job',
   example: '12345',
+  ref: 'jobId',
 });
 
 const title = z.string().openapi({
@@ -122,10 +132,9 @@ Generates the following object:
           {
             "in": "path",
             "name": "jobId",
+            "description": "A unique identifier for a job",
             "schema": {
-              "type": "string",
-              "description": "Job ID",
-              "example": "12345"
+              "$ref": "#/components/schemas/jobId"
             }
           }
         ],
@@ -155,9 +164,7 @@ Generates the following object:
                   "type": "object",
                   "properties": {
                     "jobId": {
-                      "type": "string",
-                      "description": "Job ID",
-                      "example": "12345"
+                      "$ref": "#/components/schemas/jobId"
                     },
                     "title": {
                       "type": "string",
@@ -173,6 +180,15 @@ Generates the following object:
         }
       }
     }
+  },
+  "components": {
+    "schemas": {
+      "jobId": {
+        "type": "string",
+        "description": "A unique identifier for a job",
+        "example": "12345"
+      }
+    }
   }
 }
 ```

package/lib-commonjs/extend.js

@@ -0,0 +1,59 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/extend.ts
+var extend_exports = {};
+module.exports = __toCommonJS(extend_exports);
+var import_zod = require("zod");
+
+// src/extendZod.ts
+function extendZodWithOpenApi(zod) {
+  if (typeof zod.ZodType.prototype.openapi !== "undefined") {
+    return;
+  }
+  zod.ZodType.prototype.openapi = function(openapi) {
+    const result = new this.constructor({
+      ...this._def,
+      openapi
+    });
+    return result;
+  };
+  const zodObjectExtend = zod.ZodObject.prototype.extend;
+  zod.ZodObject.prototype.extend = function(...args) {
+    const extendResult = zodObjectExtend.apply(this, args);
+    extendResult._def.extendMetadata = {
+      extends: this
+    };
+    delete extendResult._def.openapi;
+    return extendResult;
+  };
+  const zodObjectOmit = zod.ZodObject.prototype.omit;
+  zod.ZodObject.prototype.omit = function(...args) {
+    const omitResult = zodObjectOmit.apply(this, args);
+    delete omitResult._def.extendMetadata;
+    delete omitResult._def.openapi;
+    return omitResult;
+  };
+  const zodObjectPick = zod.ZodObject.prototype.pick;
+  zod.ZodObject.prototype.pick = function(...args) {
+    const pickResult = zodObjectPick.apply(this, args);
+    delete pickResult._def.extendMetadata;
+    delete pickResult._def.openapi;
+    return pickResult;
+  };
+}
+
+// src/extend.ts
+extendZodWithOpenApi(import_zod.z);

package/lib-esm/extend.mjs

@@ -0,0 +1,42 @@
+// src/extend.ts
+import { z } from "zod";
+
+// src/extendZod.ts
+function extendZodWithOpenApi(zod) {
+  if (typeof zod.ZodType.prototype.openapi !== "undefined") {
+    return;
+  }
+  zod.ZodType.prototype.openapi = function(openapi) {
+    const result = new this.constructor({
+      ...this._def,
+      openapi
+    });
+    return result;
+  };
+  const zodObjectExtend = zod.ZodObject.prototype.extend;
+  zod.ZodObject.prototype.extend = function(...args) {
+    const extendResult = zodObjectExtend.apply(this, args);
+    extendResult._def.extendMetadata = {
+      extends: this
+    };
+    delete extendResult._def.openapi;
+    return extendResult;
+  };
+  const zodObjectOmit = zod.ZodObject.prototype.omit;
+  zod.ZodObject.prototype.omit = function(...args) {
+    const omitResult = zodObjectOmit.apply(this, args);
+    delete omitResult._def.extendMetadata;
+    delete omitResult._def.openapi;
+    return omitResult;
+  };
+  const zodObjectPick = zod.ZodObject.prototype.pick;
+  zod.ZodObject.prototype.pick = function(...args) {
+    const pickResult = zodObjectPick.apply(this, args);
+    delete pickResult._def.extendMetadata;
+    delete pickResult._def.openapi;
+    return pickResult;
+  };
+}
+
+// src/extend.ts
+extendZodWithOpenApi(z);

package/lib-types/extend.d.ts

@@ -0,0 +1 @@
+export * from './extendZodTypes';

package/lib-types/extendZod.d.ts

@@ -1,76 +1,3 @@
-import type { ZodDate, ZodObject, ZodTypeAny, z } from 'zod';
-import type { CreationType } from './create/components';
-import type { oas30, oas31 } from './openapi3-ts/dist';
-type SchemaObject = oas30.SchemaObject & oas31.SchemaObject;
-/**
- * zod-openapi metadata
- */
-interface ZodOpenApiMetadata<T extends ZodTypeAny, TInferred = z.input<T> | z.output<T>> extends SchemaObject {
-    example?: TInferred;
-    examples?: [TInferred, ...TInferred[]];
-    default?: T extends ZodDate ? string : TInferred;
-    /**
-     * Used to set the output of a ZodUnion to be `oneOf` instead of `allOf`
-     */
-    unionOneOf?: boolean;
-    /**
-     * Used to output this Zod Schema in the components schemas section. Any usage of this Zod Schema will then be transformed into a $ref.
-     */
-    ref?: string;
-    /**
-     * Used when you are manually adding a Zod Schema to the components section. This controls whether this should be rendered as request (`input`) or response (`output`). Defaults to `output`
-     */
-    refType?: CreationType;
-    /**
-     * Used to set the created type of an effect.
-     */
-    effectType?: CreationType | (z.input<T> extends z.output<T> ? z.output<T> extends z.input<T> ? 'same' : never : never);
-    /**
-     * Used to set metadata for a parameter, request header or cookie
-     */
-    param?: Partial<oas31.ParameterObject> & {
-        example?: TInferred;
-        examples?: Record<string, (oas31.ExampleObject & {
-            value: TInferred;
-        }) | oas31.ReferenceObject>;
-        /**
-         * Used to output this Zod Schema in the components parameters section. Any usage of this Zod Schema will then be transformed into a $ref.
-         */
-        ref?: string;
-    };
-    /**
-     * Used to set data for a response header
-     */
-    header?: Partial<oas31.HeaderObject & oas30.HeaderObject> & {
-        /**
-         * Used to output this Zod Schema in the components headers section. Any usage of this Zod Schema will then be transformed into a $ref.
-         */
-        ref?: string;
-    };
-    /**
-     * Used to override the generated type. If this is provided no metadata will be generated.
-     */
-    type?: SchemaObject['type'];
-}
-interface ZodOpenApiExtendMetadata {
-    extends: ZodObject<any, any, any, any, any>;
-}
-declare module 'zod' {
-    interface ZodType {
-        /**
-         * Add OpenAPI metadata to a Zod Type
-         */
-        openapi<T extends ZodTypeAny>(this: T, metadata: ZodOpenApiMetadata<T>): T;
-    }
-    interface ZodTypeDef {
-        /**
-         * OpenAPI metadata
-         */
-        openapi?: ZodOpenApiMetadata<ZodTypeAny>;
-    }
-    interface ZodObjectDef {
-        extendMetadata?: ZodOpenApiExtendMetadata;
-    }
-}
+import type { z } from 'zod';
+import './extendZodTypes';
 export declare function extendZodWithOpenApi(zod: typeof z): void;
-export {};

package/lib-types/extendZodTypes.d.ts

@@ -0,0 +1,75 @@
+import type { ZodDate, ZodObject, ZodTypeAny, z } from 'zod';
+import type { CreationType } from './create/components';
+import type { oas30, oas31 } from './openapi3-ts/dist';
+type SchemaObject = oas30.SchemaObject & oas31.SchemaObject;
+/**
+ * zod-openapi metadata
+ */
+interface ZodOpenApiMetadata<T extends ZodTypeAny, TInferred = z.input<T> | z.output<T>> extends SchemaObject {
+    example?: TInferred;
+    examples?: [TInferred, ...TInferred[]];
+    default?: T extends ZodDate ? string : TInferred;
+    /**
+     * Used to set the output of a ZodUnion to be `oneOf` instead of `allOf`
+     */
+    unionOneOf?: boolean;
+    /**
+     * Used to output this Zod Schema in the components schemas section. Any usage of this Zod Schema will then be transformed into a $ref.
+     */
+    ref?: string;
+    /**
+     * Used when you are manually adding a Zod Schema to the components section. This controls whether this should be rendered as request (`input`) or response (`output`). Defaults to `output`
+     */
+    refType?: CreationType;
+    /**
+     * Used to set the created type of an effect.
+     */
+    effectType?: CreationType | (z.input<T> extends z.output<T> ? z.output<T> extends z.input<T> ? 'same' : never : never);
+    /**
+     * Used to set metadata for a parameter, request header or cookie
+     */
+    param?: Partial<oas31.ParameterObject> & {
+        example?: TInferred;
+        examples?: Record<string, (oas31.ExampleObject & {
+            value: TInferred;
+        }) | oas31.ReferenceObject>;
+        /**
+         * Used to output this Zod Schema in the components parameters section. Any usage of this Zod Schema will then be transformed into a $ref.
+         */
+        ref?: string;
+    };
+    /**
+     * Used to set data for a response header
+     */
+    header?: Partial<oas31.HeaderObject & oas30.HeaderObject> & {
+        /**
+         * Used to output this Zod Schema in the components headers section. Any usage of this Zod Schema will then be transformed into a $ref.
+         */
+        ref?: string;
+    };
+    /**
+     * Used to override the generated type. If this is provided no metadata will be generated.
+     */
+    type?: SchemaObject['type'];
+}
+interface ZodOpenApiExtendMetadata {
+    extends: ZodObject<any, any, any, any, any>;
+}
+declare module 'zod' {
+    interface ZodType {
+        /**
+         * Add OpenAPI metadata to a Zod Type
+         */
+        openapi<T extends ZodTypeAny>(this: T, metadata: ZodOpenApiMetadata<T>): T;
+    }
+    interface ZodTypeDef {
+        /**
+         * OpenAPI metadata
+         */
+        openapi?: ZodOpenApiMetadata<ZodTypeAny>;
+    }
+    interface ZodObjectDef {
+        extendMetadata?: ZodOpenApiExtendMetadata;
+    }
+}
+export {};

package/lib-types/zodType.d.ts

@@ -38,5 +38,5 @@ type ZodTypeMap = {
     ZodVoid: ZodVoid;
 };
 export declare const isZodType: <K extends keyof ZodTypeMap>(zodType: unknown, typeName: K) => zodType is ZodTypeMap[K];
-export declare const isAnyZodType: (zodType: unknown) => zodType is ZodType<unknown, ZodTypeDef, unknown>;
+export declare const isAnyZodType: (zodType: unknown) => zodType is ZodType<any, ZodTypeDef, any>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod-openapi",
-  "version": "2.16.0",
+  "version": "2.17.0-beta.2",
   "description": "Convert Zod Schemas to OpenAPI v3.x documentation",
   "keywords": [
     "typescript",
@@ -20,17 +20,34 @@
     "url": "git+ssh://git@github.com/samchungy/zod-openapi.git"
   },
   "license": "MIT",
-  "sideEffects": false,
+  "sideEffects": [
+    "./src/extend.ts",
+    "./lib-esm/extend.mjs",
+    "./lib-commonjs/extend.js"
+  ],
   "exports": {
     ".": {
       "import": "./lib-esm/index.mjs",
       "require": "./lib-commonjs/index.js",
       "types": "./lib-types/index.d.ts"
+    },
+    "./extend": {
+      "import": "./lib-esm/extend.mjs",
+      "require": "./lib-commonjs/extend.js",
+      "types": "./lib-types/extend.d.ts"
     }
   },
   "main": "./lib-commonjs/index.js",
   "module": "./lib-esm/index.mjs",
   "types": "./lib-types/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "lib-types/index.d.ts",
+        "lib-types/extend.d.ts"
+      ]
+    }
+  },
   "files": [
     "lib*/**/*.d.ts",
     "lib*/**/*.{js,mjs}{,.map}",
@@ -52,9 +69,9 @@
     "@types/node": "^20.3.0",
     "eslint-plugin-zod-openapi": "^0.1.0",
     "openapi3-ts": "4.3.1",
-    "skuba": "8.0.0",
+    "skuba": "8.0.1",
     "yaml": "2.4.1",
-    "zod": "3.23.0-beta.2"
+    "zod": "3.23.3"
   },
   "peerDependencies": {
     "zod": "^3.21.4"