zod-openapi 2.2.1 → 2.2.2

package/README.md

@@ -317,7 +317,7 @@ createDocument({
 
 `.transform()` is complicated because it technically comprises of two types (input & output). This means that we need to understand which type you are creating.
 
-If a registered schema with a transform 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 and set the `effectType` field to `input`. This will force this library to always generate the input type even if we are creating a response 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 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 your know your transform has not changed the type.
 
 `.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()`.
 
@@ -553,7 +553,7 @@ zod-openapi was created while trying to add a feature to support auto registerin
 
 3. No transform support or safety. You can use a `type` to override the transform type but what happens when that transform logic changes?
 
-4. Eslint rules. I initially created some rules for that library, however, I had to add some awkward logic to account for the registry class. With more creative control, I can create better rules going forward. See [eslint-plugin-zod-openapi](https://github.com/samchungy/eslint-plugin-zod-openapi) for some magic.
+4. No input/output validation with components. What happens when you register a component with a transform which technically comprises of two types in a request and a response?
 
 Did I really rewrite an entire library just for this? Absolutely. I believe that creating documentation and types should be as simple and as frictionless as possible.
 

package/lib-commonjs/create/schema/pipeline.js

@@ -1,11 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createPipelineSchema = void 0;
+const errors_1 = require("../errors");
 const _1 = require(".");
 const createPipelineSchema = (zodPipeline, state) => {
+    if (zodPipeline._def.openapi?.effectType === 'input') {
+        return (0, _1.createSchemaOrRef)(zodPipeline._def.in, state);
+    }
+    if (zodPipeline._def.openapi?.effectType === 'output') {
+        return (0, _1.createSchemaOrRef)(zodPipeline._def.out, state);
+    }
     if (state.type === 'input') {
+        if (state.effectType === 'output') {
+            (0, errors_1.throwTransformError)(zodPipeline);
+        }
+        state.effectType = 'input';
         return (0, _1.createSchemaOrRef)(zodPipeline._def.in, state);
     }
+    if (state.effectType === 'input') {
+        (0, errors_1.throwTransformError)(zodPipeline);
+    }
+    state.effectType = 'output';
     return (0, _1.createSchemaOrRef)(zodPipeline._def.out, state);
 };
 exports.createPipelineSchema = createPipelineSchema;

package/lib-commonjs/create/schema/pipeline.js.map

@@ -1 +1 @@
-{"version":3,"file":"pipeline.js","sourceRoot":"","sources":["../../../src/create/schema/pipeline.ts"],"names":[],"mappings":";;;AAIA,wBAAwD;AAEjD,MAAM,oBAAoB,GAAG,CAClC,WAAkC,EAClC,KAAkB,EAC0B,EAAE;IAC9C,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE;QAC1B,OAAO,IAAA,oBAAiB,EAAC,WAAW,CAAC,IAAI,CAAC,EAAgB,EAAE,KAAK,CAAC,CAAC;KACpE;IACD,OAAO,IAAA,oBAAiB,EAAC,WAAW,CAAC,IAAI,CAAC,GAAiB,EAAE,KAAK,CAAC,CAAC;AACtE,CAAC,CAAC;AARW,QAAA,oBAAoB,wBAQ/B"}
+{"version":3,"file":"pipeline.js","sourceRoot":"","sources":["../../../src/create/schema/pipeline.ts"],"names":[],"mappings":";;;AAGA,sCAAgD;AAEhD,wBAAwD;AAEjD,MAAM,oBAAoB,GAAG,CAClC,WAAkC,EAClC,KAAkB,EAC0B,EAAE;IAC9C,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,KAAK,OAAO,EAAE;QACpD,OAAO,IAAA,oBAAiB,EAAC,WAAW,CAAC,IAAI,CAAC,EAAgB,EAAE,KAAK,CAAC,CAAC;KACpE;IAED,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,KAAK,QAAQ,EAAE;QACrD,OAAO,IAAA,oBAAiB,EAAC,WAAW,CAAC,IAAI,CAAC,GAAiB,EAAE,KAAK,CAAC,CAAC;KACrE;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE;QAC1B,IAAI,KAAK,CAAC,UAAU,KAAK,QAAQ,EAAE;YACjC,IAAA,4BAAmB,EAAC,WAAW,CAAC,CAAC;SAClC;QACD,KAAK,CAAC,UAAU,GAAG,OAAO,CAAC;QAC3B,OAAO,IAAA,oBAAiB,EAAC,WAAW,CAAC,IAAI,CAAC,EAAgB,EAAE,KAAK,CAAC,CAAC;KACpE;IAED,IAAI,KAAK,CAAC,UAAU,KAAK,OAAO,EAAE;QAChC,IAAA,4BAAmB,EAAC,WAAW,CAAC,CAAC;KAClC;IACD,KAAK,CAAC,UAAU,GAAG,QAAQ,CAAC;IAC5B,OAAO,IAAA,oBAAiB,EAAC,WAAW,CAAC,IAAI,CAAC,GAAiB,EAAE,KAAK,CAAC,CAAC;AACtE,CAAC,CAAC;AAzBW,QAAA,oBAAoB,wBAyB/B"}

package/lib-commonjs/create/schema/transform.js

@@ -5,16 +5,19 @@ const errors_1 = require("../errors");
 const manual_1 = require("./manual");
 const _1 = require(".");
 const createTransformSchema = (zodTransform, state) => {
-    const creationType = zodTransform._def.openapi?.effectType ?? state.type;
-    if (creationType === 'output') {
+    if (zodTransform._def.openapi?.effectType === 'output') {
         return (0, manual_1.createManualTypeSchema)(zodTransform);
     }
-    if (!zodTransform._def.openapi?.effectType && state.type === 'input') {
-        if (state.effectType && state.effectType !== 'input') {
-            (0, errors_1.throwTransformError)(zodTransform);
-        }
-        state.effectType = 'input';
+    if (zodTransform._def.openapi?.effectType === 'input') {
+        return (0, _1.createSchemaOrRef)(zodTransform._def.schema, state);
     }
+    if (state.type === 'output') {
+        return (0, manual_1.createManualTypeSchema)(zodTransform);
+    }
+    if (state.effectType === 'output') {
+        (0, errors_1.throwTransformError)(zodTransform);
+    }
+    state.effectType = 'input';
     return (0, _1.createSchemaOrRef)(zodTransform._def.schema, state);
 };
 exports.createTransformSchema = createTransformSchema;

package/lib-commonjs/create/schema/transform.js.map

@@ -1 +1 @@
-{"version":3,"file":"transform.js","sourceRoot":"","sources":["../../../src/create/schema/transform.ts"],"names":[],"mappings":";;;AAGA,sCAAgD;AAEhD,qCAAkD;AAElD,wBAAwD;AAEjD,MAAM,qBAAqB,GAAG,CACnC,YAAuC,EACvC,KAAkB,EAC0B,EAAE;IAC9C,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,IAAI,KAAK,CAAC,IAAI,CAAC;IACzE,IAAI,YAAY,KAAK,QAAQ,EAAE;QAC7B,OAAO,IAAA,+BAAsB,EAAC,YAAY,CAAC,CAAC;KAC7C;IAED,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE;QACpE,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,KAAK,OAAO,EAAE;YACpD,IAAA,4BAAmB,EAAC,YAAY,CAAC,CAAC;SACnC;QACD,KAAK,CAAC,UAAU,GAAG,OAAO,CAAC;KAC5B;IACD,OAAO,IAAA,oBAAiB,EAAC,YAAY,CAAC,IAAI,CAAC,MAAiB,EAAE,KAAK,CAAC,CAAC;AACvE,CAAC,CAAC;AAhBW,QAAA,qBAAqB,yBAgBhC"}
+{"version":3,"file":"transform.js","sourceRoot":"","sources":["../../../src/create/schema/transform.ts"],"names":[],"mappings":";;;AAGA,sCAAgD;AAEhD,qCAAkD;AAElD,wBAAwD;AAEjD,MAAM,qBAAqB,GAAG,CACnC,YAAuC,EACvC,KAAkB,EAC0B,EAAE;IAC9C,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,KAAK,QAAQ,EAAE;QACtD,OAAO,IAAA,+BAAsB,EAAC,YAAY,CAAC,CAAC;KAC7C;IAED,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,KAAK,OAAO,EAAE;QACrD,OAAO,IAAA,oBAAiB,EAAC,YAAY,CAAC,IAAI,CAAC,MAAiB,EAAE,KAAK,CAAC,CAAC;KACtE;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;QAC3B,OAAO,IAAA,+BAAsB,EAAC,YAAY,CAAC,CAAC;KAC7C;IAED,IAAI,KAAK,CAAC,UAAU,KAAK,QAAQ,EAAE;QACjC,IAAA,4BAAmB,EAAC,YAAY,CAAC,CAAC;KACnC;IACD,KAAK,CAAC,UAAU,GAAG,OAAO,CAAC;IAC3B,OAAO,IAAA,oBAAiB,EAAC,YAAY,CAAC,IAAI,CAAC,MAAiB,EAAE,KAAK,CAAC,CAAC;AACvE,CAAC,CAAC;AArBW,QAAA,qBAAqB,yBAqBhC"}

package/lib-es2015/create/schema/pipeline.js

@@ -1,8 +1,23 @@
+import { throwTransformError } from '../errors';
 import { createSchemaOrRef } from '.';
 export const createPipelineSchema = (zodPipeline, state) => {
+    if (zodPipeline._def.openapi?.effectType === 'input') {
+        return createSchemaOrRef(zodPipeline._def.in, state);
+    }
+    if (zodPipeline._def.openapi?.effectType === 'output') {
+        return createSchemaOrRef(zodPipeline._def.out, state);
+    }
     if (state.type === 'input') {
+        if (state.effectType === 'output') {
+            throwTransformError(zodPipeline);
+        }
+        state.effectType = 'input';
         return createSchemaOrRef(zodPipeline._def.in, state);
     }
+    if (state.effectType === 'input') {
+        throwTransformError(zodPipeline);
+    }
+    state.effectType = 'output';
     return createSchemaOrRef(zodPipeline._def.out, state);
 };
 //# sourceMappingURL=pipeline.js.map

package/lib-es2015/create/schema/pipeline.js.map

@@ -1 +1 @@
-{"version":3,"file":"pipeline.js","sourceRoot":"","sources":["../../../src/create/schema/pipeline.ts"],"names":[],"mappings":"AAIA,OAAO,EAAoB,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAExD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,WAAkC,EAClC,KAAkB,EAC0B,EAAE;IAC9C,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE;QAC1B,OAAO,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,EAAgB,EAAE,KAAK,CAAC,CAAC;KACpE;IACD,OAAO,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,GAAiB,EAAE,KAAK,CAAC,CAAC;AACtE,CAAC,CAAC"}
+{"version":3,"file":"pipeline.js","sourceRoot":"","sources":["../../../src/create/schema/pipeline.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAEhD,OAAO,EAAoB,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAExD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,WAAkC,EAClC,KAAkB,EAC0B,EAAE;IAC9C,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,KAAK,OAAO,EAAE;QACpD,OAAO,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,EAAgB,EAAE,KAAK,CAAC,CAAC;KACpE;IAED,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,KAAK,QAAQ,EAAE;QACrD,OAAO,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,GAAiB,EAAE,KAAK,CAAC,CAAC;KACrE;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE;QAC1B,IAAI,KAAK,CAAC,UAAU,KAAK,QAAQ,EAAE;YACjC,mBAAmB,CAAC,WAAW,CAAC,CAAC;SAClC;QACD,KAAK,CAAC,UAAU,GAAG,OAAO,CAAC;QAC3B,OAAO,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,EAAgB,EAAE,KAAK,CAAC,CAAC;KACpE;IAED,IAAI,KAAK,CAAC,UAAU,KAAK,OAAO,EAAE;QAChC,mBAAmB,CAAC,WAAW,CAAC,CAAC;KAClC;IACD,KAAK,CAAC,UAAU,GAAG,QAAQ,CAAC;IAC5B,OAAO,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,GAAiB,EAAE,KAAK,CAAC,CAAC;AACtE,CAAC,CAAC"}

package/lib-es2015/create/schema/transform.js

@@ -2,16 +2,19 @@ import { throwTransformError } from '../errors';
 import { createManualTypeSchema } from './manual';
 import { createSchemaOrRef } from '.';
 export const createTransformSchema = (zodTransform, state) => {
-    const creationType = zodTransform._def.openapi?.effectType ?? state.type;
-    if (creationType === 'output') {
+    if (zodTransform._def.openapi?.effectType === 'output') {
         return createManualTypeSchema(zodTransform);
     }
-    if (!zodTransform._def.openapi?.effectType && state.type === 'input') {
-        if (state.effectType && state.effectType !== 'input') {
-            throwTransformError(zodTransform);
-        }
-        state.effectType = 'input';
+    if (zodTransform._def.openapi?.effectType === 'input') {
+        return createSchemaOrRef(zodTransform._def.schema, state);
     }
+    if (state.type === 'output') {
+        return createManualTypeSchema(zodTransform);
+    }
+    if (state.effectType === 'output') {
+        throwTransformError(zodTransform);
+    }
+    state.effectType = 'input';
     return createSchemaOrRef(zodTransform._def.schema, state);
 };
 //# sourceMappingURL=transform.js.map

package/lib-es2015/create/schema/transform.js.map

@@ -1 +1 @@
-{"version":3,"file":"transform.js","sourceRoot":"","sources":["../../../src/create/schema/transform.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAEhD,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAElD,OAAO,EAAoB,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAExD,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,YAAuC,EACvC,KAAkB,EAC0B,EAAE;IAC9C,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,IAAI,KAAK,CAAC,IAAI,CAAC;IACzE,IAAI,YAAY,KAAK,QAAQ,EAAE;QAC7B,OAAO,sBAAsB,CAAC,YAAY,CAAC,CAAC;KAC7C;IAED,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE;QACpE,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,KAAK,OAAO,EAAE;YACpD,mBAAmB,CAAC,YAAY,CAAC,CAAC;SACnC;QACD,KAAK,CAAC,UAAU,GAAG,OAAO,CAAC;KAC5B;IACD,OAAO,iBAAiB,CAAC,YAAY,CAAC,IAAI,CAAC,MAAiB,EAAE,KAAK,CAAC,CAAC;AACvE,CAAC,CAAC"}
+{"version":3,"file":"transform.js","sourceRoot":"","sources":["../../../src/create/schema/transform.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAEhD,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAElD,OAAO,EAAoB,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAExD,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,YAAuC,EACvC,KAAkB,EAC0B,EAAE;IAC9C,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,KAAK,QAAQ,EAAE;QACtD,OAAO,sBAAsB,CAAC,YAAY,CAAC,CAAC;KAC7C;IAED,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,KAAK,OAAO,EAAE;QACrD,OAAO,iBAAiB,CAAC,YAAY,CAAC,IAAI,CAAC,MAAiB,EAAE,KAAK,CAAC,CAAC;KACtE;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;QAC3B,OAAO,sBAAsB,CAAC,YAAY,CAAC,CAAC;KAC7C;IAED,IAAI,KAAK,CAAC,UAAU,KAAK,QAAQ,EAAE;QACjC,mBAAmB,CAAC,YAAY,CAAC,CAAC;KACnC;IACD,KAAK,CAAC,UAAU,GAAG,OAAO,CAAC;IAC3B,OAAO,iBAAiB,CAAC,YAAY,CAAC,IAAI,CAAC,MAAiB,EAAE,KAAK,CAAC,CAAC;AACvE,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod-openapi",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "description": "A library to create full OpenAPI documents from your Zod types",
   "homepage": "https://github.com/samchungy/zod-openapi#readme",
   "bugs": {
@@ -35,7 +35,7 @@
   "dependencies": {},
   "devDependencies": {
     "@redocly/cli": "1.0.0-beta.125",
-    "@types/node": "^18.15.13",
+    "@types/node": "^20.1.0",
     "eslint-plugin-zod-openapi": "^0.1.0",
     "openapi3-ts": "^4.1.2",
     "skuba": "6.1.0",