zod-openapi 2.4.0-beta.1 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (145) hide show
  1. package/README.md +4 -5
  2. package/lib-commonjs/create/components.js +14 -10
  3. package/lib-commonjs/create/components.js.map +1 -1
  4. package/lib-commonjs/create/content.js +13 -8
  5. package/lib-commonjs/create/content.js.map +1 -1
  6. package/lib-commonjs/create/parameters.js +26 -18
  7. package/lib-commonjs/create/parameters.js.map +1 -1
  8. package/lib-commonjs/create/paths.js +29 -32
  9. package/lib-commonjs/create/paths.js.map +1 -1
  10. package/lib-commonjs/create/responses.js +19 -9
  11. package/lib-commonjs/create/responses.js.map +1 -1
  12. package/lib-commonjs/create/schema/array.js +1 -1
  13. package/lib-commonjs/create/schema/array.js.map +1 -1
  14. package/lib-commonjs/create/schema/brand.js +1 -1
  15. package/lib-commonjs/create/schema/brand.js.map +1 -1
  16. package/lib-commonjs/create/schema/catch.js +1 -1
  17. package/lib-commonjs/create/schema/catch.js.map +1 -1
  18. package/lib-commonjs/create/schema/default.js +1 -1
  19. package/lib-commonjs/create/schema/default.js.map +1 -1
  20. package/lib-commonjs/create/schema/discriminatedUnion.js +4 -4
  21. package/lib-commonjs/create/schema/discriminatedUnion.js.map +1 -1
  22. package/lib-commonjs/create/schema/index.js +35 -14
  23. package/lib-commonjs/create/schema/index.js.map +1 -1
  24. package/lib-commonjs/create/schema/intersection.js +6 -2
  25. package/lib-commonjs/create/schema/intersection.js.map +1 -1
  26. package/lib-commonjs/create/schema/lazy.js +1 -6
  27. package/lib-commonjs/create/schema/lazy.js.map +1 -1
  28. package/lib-commonjs/create/schema/manual.js +2 -2
  29. package/lib-commonjs/create/schema/manual.js.map +1 -1
  30. package/lib-commonjs/create/schema/metadata.js +1 -12
  31. package/lib-commonjs/create/schema/metadata.js.map +1 -1
  32. package/lib-commonjs/create/schema/nullable.js +1 -1
  33. package/lib-commonjs/create/schema/nullable.js.map +1 -1
  34. package/lib-commonjs/create/schema/object.js +5 -3
  35. package/lib-commonjs/create/schema/object.js.map +1 -1
  36. package/lib-commonjs/create/schema/optional.js +2 -3
  37. package/lib-commonjs/create/schema/optional.js.map +1 -1
  38. package/lib-commonjs/create/schema/pipeline.js +15 -7
  39. package/lib-commonjs/create/schema/pipeline.js.map +1 -1
  40. package/lib-commonjs/create/schema/preprocess.js +3 -1
  41. package/lib-commonjs/create/schema/preprocess.js.map +1 -1
  42. package/lib-commonjs/create/schema/record.js +1 -1
  43. package/lib-commonjs/create/schema/record.js.map +1 -1
  44. package/lib-commonjs/create/schema/refine.js +1 -1
  45. package/lib-commonjs/create/schema/refine.js.map +1 -1
  46. package/lib-commonjs/create/schema/set.js +1 -1
  47. package/lib-commonjs/create/schema/set.js.map +1 -1
  48. package/lib-commonjs/create/schema/transform.js +14 -7
  49. package/lib-commonjs/create/schema/transform.js.map +1 -1
  50. package/lib-commonjs/create/schema/tuple.js +6 -3
  51. package/lib-commonjs/create/schema/tuple.js.map +1 -1
  52. package/lib-commonjs/create/schema/union.js +1 -1
  53. package/lib-commonjs/create/schema/union.js.map +1 -1
  54. package/lib-commonjs/extendZod.js +2 -2
  55. package/lib-commonjs/extendZod.js.map +1 -1
  56. package/lib-commonjs/index.js +1 -0
  57. package/lib-commonjs/index.js.map +1 -1
  58. package/lib-commonjs/openapi3-ts/dist/index.js +1 -4
  59. package/lib-commonjs/openapi3-ts/dist/index.js.map +1 -1
  60. package/lib-commonjs/openapi3-ts/dist/oas30.js +0 -4
  61. package/lib-commonjs/openapi3-ts/dist/oas30.js.map +1 -1
  62. package/lib-commonjs/openapi3-ts/dist/oas31.js +0 -4
  63. package/lib-commonjs/openapi3-ts/dist/oas31.js.map +1 -1
  64. package/lib-es2015/create/components.js +15 -11
  65. package/lib-es2015/create/components.js.map +1 -1
  66. package/lib-es2015/create/content.js +14 -9
  67. package/lib-es2015/create/content.js.map +1 -1
  68. package/lib-es2015/create/parameters.js +27 -19
  69. package/lib-es2015/create/parameters.js.map +1 -1
  70. package/lib-es2015/create/paths.js +29 -32
  71. package/lib-es2015/create/paths.js.map +1 -1
  72. package/lib-es2015/create/responses.js +20 -10
  73. package/lib-es2015/create/responses.js.map +1 -1
  74. package/lib-es2015/create/schema/array.js +1 -1
  75. package/lib-es2015/create/schema/array.js.map +1 -1
  76. package/lib-es2015/create/schema/brand.js +1 -1
  77. package/lib-es2015/create/schema/brand.js.map +1 -1
  78. package/lib-es2015/create/schema/catch.js +1 -1
  79. package/lib-es2015/create/schema/catch.js.map +1 -1
  80. package/lib-es2015/create/schema/default.js +1 -1
  81. package/lib-es2015/create/schema/default.js.map +1 -1
  82. package/lib-es2015/create/schema/discriminatedUnion.js +4 -4
  83. package/lib-es2015/create/schema/discriminatedUnion.js.map +1 -1
  84. package/lib-es2015/create/schema/index.js +33 -14
  85. package/lib-es2015/create/schema/index.js.map +1 -1
  86. package/lib-es2015/create/schema/intersection.js +6 -2
  87. package/lib-es2015/create/schema/intersection.js.map +1 -1
  88. package/lib-es2015/create/schema/lazy.js +1 -6
  89. package/lib-es2015/create/schema/lazy.js.map +1 -1
  90. package/lib-es2015/create/schema/manual.js +2 -2
  91. package/lib-es2015/create/schema/manual.js.map +1 -1
  92. package/lib-es2015/create/schema/metadata.js +0 -10
  93. package/lib-es2015/create/schema/metadata.js.map +1 -1
  94. package/lib-es2015/create/schema/nullable.js +1 -1
  95. package/lib-es2015/create/schema/nullable.js.map +1 -1
  96. package/lib-es2015/create/schema/object.js +5 -3
  97. package/lib-es2015/create/schema/object.js.map +1 -1
  98. package/lib-es2015/create/schema/optional.js +2 -3
  99. package/lib-es2015/create/schema/optional.js.map +1 -1
  100. package/lib-es2015/create/schema/pipeline.js +15 -7
  101. package/lib-es2015/create/schema/pipeline.js.map +1 -1
  102. package/lib-es2015/create/schema/preprocess.js +3 -1
  103. package/lib-es2015/create/schema/preprocess.js.map +1 -1
  104. package/lib-es2015/create/schema/record.js +1 -1
  105. package/lib-es2015/create/schema/record.js.map +1 -1
  106. package/lib-es2015/create/schema/refine.js +1 -1
  107. package/lib-es2015/create/schema/refine.js.map +1 -1
  108. package/lib-es2015/create/schema/set.js +1 -1
  109. package/lib-es2015/create/schema/set.js.map +1 -1
  110. package/lib-es2015/create/schema/transform.js +12 -6
  111. package/lib-es2015/create/schema/transform.js.map +1 -1
  112. package/lib-es2015/create/schema/tuple.js +6 -3
  113. package/lib-es2015/create/schema/tuple.js.map +1 -1
  114. package/lib-es2015/create/schema/union.js +1 -1
  115. package/lib-es2015/create/schema/union.js.map +1 -1
  116. package/lib-es2015/extendZod.js +2 -2
  117. package/lib-es2015/extendZod.js.map +1 -1
  118. package/lib-es2015/index.js +1 -0
  119. package/lib-es2015/index.js.map +1 -1
  120. package/lib-es2015/openapi3-ts/dist/index.js +0 -1
  121. package/lib-es2015/openapi3-ts/dist/index.js.map +1 -1
  122. package/lib-es2015/openapi3-ts/dist/oas30.js +0 -1
  123. package/lib-es2015/openapi3-ts/dist/oas30.js.map +1 -1
  124. package/lib-es2015/openapi3-ts/dist/oas31.js +0 -1
  125. package/lib-es2015/openapi3-ts/dist/oas31.js.map +1 -1
  126. package/lib-types/create/content.d.ts +1 -1
  127. package/lib-types/create/parameters.d.ts +4 -4
  128. package/lib-types/create/paths.d.ts +1 -1
  129. package/lib-types/create/responses.d.ts +2 -2
  130. package/lib-types/create/schema/discriminatedUnion.d.ts +1 -1
  131. package/lib-types/create/schema/index.d.ts +6 -3
  132. package/lib-types/create/schema/manual.d.ts +2 -1
  133. package/lib-types/create/schema/metadata.d.ts +0 -3
  134. package/lib-types/create/schema/transform.d.ts +2 -1
  135. package/lib-types/extendZod.d.ts +1 -1
  136. package/lib-types/index.d.ts +1 -1
  137. package/lib-types/openapi3-ts/dist/index.d.ts +1 -1
  138. package/lib-types/openapi3-ts/dist/oas30.d.ts +1 -1
  139. package/lib-types/openapi3-ts/dist/oas31.d.ts +1 -1
  140. package/package.json +1 -1
  141. package/lib-commonjs/create/errors.js +0 -8
  142. package/lib-commonjs/create/errors.js.map +0 -1
  143. package/lib-es2015/create/errors.js +0 -4
  144. package/lib-es2015/create/errors.js.map +0 -1
  145. package/lib-types/create/errors.d.ts +0 -2
@@ -1,5 +1,5 @@
1
1
  import type { oas31 } from '../openapi3-ts/dist';
2
2
  import { type ComponentsObject } from './components';
3
3
  import type { ZodOpenApiPathsObject, ZodOpenApiRequestBodyObject } from './document';
4
- export declare const createRequestBody: (requestBodyObject: ZodOpenApiRequestBodyObject | undefined, components: ComponentsObject) => oas31.ReferenceObject | oas31.RequestBodyObject | undefined;
4
+ export declare const createRequestBody: (requestBodyObject: ZodOpenApiRequestBodyObject | undefined, components: ComponentsObject, subpath: string[]) => oas31.ReferenceObject | oas31.RequestBodyObject | undefined;
5
5
  export declare const createPaths: (pathsObject: ZodOpenApiPathsObject | undefined, components: ComponentsObject) => oas31.PathsObject | undefined;
@@ -6,5 +6,5 @@ export declare const createResponseHeaders: (responseHeaders: oas31.HeadersObjec
6
6
  export declare const createHeaderOrRef: (schema: ZodType, components: ComponentsObject) => oas31.BaseParameterObject | oas31.ReferenceObject;
7
7
  export declare const createBaseHeader: (schema: ZodType, components: ComponentsObject) => oas31.BaseParameterObject;
8
8
  export declare const createComponentHeaderRef: (ref: string) => string;
9
- export declare const createResponse: (responseObject: ZodOpenApiResponseObject | oas31.ReferenceObject, components: ComponentsObject) => oas31.ResponseObject | oas31.ReferenceObject;
10
- export declare const createResponses: (responsesObject: ZodOpenApiResponsesObject, components: ComponentsObject) => oas31.ResponsesObject;
9
+ export declare const createResponse: (responseObject: ZodOpenApiResponseObject | oas31.ReferenceObject, components: ComponentsObject, subpath: string[]) => oas31.ResponseObject | oas31.ReferenceObject;
10
+ export declare const createResponses: (responsesObject: ZodOpenApiResponsesObject, components: ComponentsObject, subpath: string[]) => oas31.ResponsesObject;
@@ -2,4 +2,4 @@ import { type AnyZodObject, type ZodDiscriminatedUnion } from 'zod';
2
2
  import type { oas31 } from '../../openapi3-ts/dist';
3
3
  import { type SchemaState } from '.';
4
4
  export declare const createDiscriminatedUnionSchema: (zodDiscriminatedUnion: ZodDiscriminatedUnion<any, any>, state: SchemaState) => oas31.SchemaObject;
5
- export declare const mapDiscriminator: (schemas: (oas31.SchemaObject | oas31.ReferenceObject)[], zodObjects: AnyZodObject[], discriminator: unknown) => oas31.SchemaObject['discriminator'];
5
+ export declare const mapDiscriminator: (schemas: (oas31.SchemaObject | oas31.ReferenceObject)[], zodObjects: AnyZodObject[], discriminator: unknown, state: SchemaState) => oas31.SchemaObject['discriminator'];
@@ -6,7 +6,10 @@ export interface SchemaState {
6
6
  components: ComponentsObject;
7
7
  type: CreationType;
8
8
  effectType?: CreationType;
9
- lazy?: LazyMap;
9
+ path: string[];
10
+ visited: Set<ZodType>;
10
11
  }
11
- export declare const createSchema: <Output = any, Def extends ZodTypeDef = ZodTypeDef, Input = Output>(zodSchema: ZodType<Output, Def, Input>, state: SchemaState) => oas31.SchemaObject | oas31.ReferenceObject;
12
- export declare const createSchemaOrRef: <Output = any, Def extends ZodTypeDef = ZodTypeDef, Input = Output>(zodSchema: ZodType<Output, Def, Input>, state: SchemaState) => oas31.ReferenceObject | oas31.SchemaObject;
12
+ export declare const newSchemaState: (state: SchemaState) => SchemaState;
13
+ export declare const createSchema: <Output = any, Def extends ZodTypeDef = ZodTypeDef, Input = Output>(zodSchema: ZodType<Output, Def, Input>, state: SchemaState, subpath: string[]) => oas31.SchemaObject | oas31.ReferenceObject;
14
+ export declare const createSchemaWithMetadata: <Output = any, Def extends ZodTypeDef = ZodTypeDef, Input = Output>(zodSchema: ZodType<Output, Def, Input>, state: SchemaState) => oas31.SchemaObject | oas31.ReferenceObject;
15
+ export declare const createSchemaOrRef: <Output = any, Def extends ZodTypeDef = ZodTypeDef, Input = Output>(zodSchema: ZodType<Output, Def, Input>, state: SchemaState, subpath: string[]) => oas31.ReferenceObject | oas31.SchemaObject;
@@ -1,3 +1,4 @@
1
1
  import { type ZodType, type ZodTypeDef } from 'zod';
2
2
  import type { oas31 } from '../../openapi3-ts/dist';
3
- export declare const createManualTypeSchema: <Output = any, Def extends ZodTypeDef = ZodTypeDef, Input = Output>(zodSchema: ZodType<Output, Def, Input>) => oas31.SchemaObject;
3
+ import type { SchemaState } from '.';
4
+ export declare const createManualTypeSchema: <Output = any, Def extends ZodTypeDef = ZodTypeDef, Input = Output>(zodSchema: ZodType<Output, Def, Input>, state: SchemaState) => oas31.SchemaObject;
@@ -1,5 +1,2 @@
1
- import type { ZodType, ZodTypeDef } from 'zod';
2
1
  import type { oas31 } from '../../openapi3-ts/dist';
3
- import { type SchemaState } from '.';
4
- export declare const createSchemaWithMetadata: <Output = any, Def extends ZodTypeDef = ZodTypeDef, Input = Output>(zodSchema: ZodType<Output, Def, Input>, state: SchemaState) => oas31.SchemaObject | oas31.ReferenceObject;
5
2
  export declare const enhanceWithMetadata: (schemaOrRef: oas31.SchemaObject | oas31.ReferenceObject, metadata: oas31.SchemaObject | oas31.ReferenceObject) => oas31.SchemaObject | oas31.ReferenceObject;
@@ -1,4 +1,5 @@
1
- import type { ZodEffects } from 'zod';
1
+ import type { ZodEffects, ZodType } from 'zod';
2
2
  import type { oas31 } from '../../openapi3-ts/dist';
3
3
  import { type SchemaState } from '.';
4
4
  export declare const createTransformSchema: (zodTransform: ZodEffects<any, any, any>, state: SchemaState) => oas31.SchemaObject | oas31.ReferenceObject;
5
+ export declare const throwTransformError: (zodType: ZodType, state: SchemaState) => never;
@@ -41,7 +41,7 @@ interface ZodOpenApiExtendMetadata {
41
41
  extends: ZodObject<any, any, any, any, any>;
42
42
  }
43
43
  declare module 'zod' {
44
- interface ZodSchema<Output, Def extends ZodTypeDef, Input = Output> {
44
+ interface ZodType<Output, Def extends ZodTypeDef, Input = Output> {
45
45
  openapi<T extends ZodTypeAny>(this: T, metadata: ZodOpenApiMetadata<T>): T;
46
46
  }
47
47
  interface ZodTypeDef {
@@ -1,3 +1,3 @@
1
1
  export * from './create/document';
2
2
  export * from './extendZod';
3
- export type * from './openapi3-ts/dist';
3
+ export * from './openapi3-ts/dist';
@@ -1,3 +1,3 @@
1
1
  export * as oas30 from "./oas30";
2
2
  export * as oas31 from "./oas31";
3
- export { Server, ServerVariable } from "./model/server";
3
+ export type { Server, ServerVariable } from "./model/server";
@@ -1,4 +1,4 @@
1
1
  export * from './dsl/openapi-builder30';
2
2
  export * from './model/openapi30';
3
- export { Server, ServerVariable } from './model/server';
3
+ export type { Server, ServerVariable } from './model/server';
4
4
  export type { IExtensionName, IExtensionType, ISpecificationExtension } from './model/specification-extension';
@@ -1,4 +1,4 @@
1
1
  export * from './dsl/openapi-builder31';
2
2
  export * from './model/openapi31';
3
- export { Server, ServerVariable } from './model/server';
3
+ export type { Server, ServerVariable } from './model/server';
4
4
  export type { IExtensionName, IExtensionType, ISpecificationExtension } from './model/specification-extension';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "zod-openapi",
3
- "version": "2.4.0-beta.1",
3
+ "version": "2.5.0",
4
4
  "description": "A library to create full OpenAPI documents from your Zod types",
5
5
  "homepage": "https://github.com/samchungy/zod-openapi#readme",
6
6
  "bugs": {
@@ -1,8 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.throwTransformError = void 0;
4
- const throwTransformError = (zodType) => {
5
- throw new Error(`${JSON.stringify(zodType)} contains a transform but is used in both an input and an output. This is likely a mistake. Set an \`effectType\` to resolve`);
6
- };
7
- exports.throwTransformError = throwTransformError;
8
- //# sourceMappingURL=errors.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/create/errors.ts"],"names":[],"mappings":";;;AAEO,MAAM,mBAAmB,GAAG,CAAC,OAAgB,EAAE,EAAE;IACtD,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,SAAS,CACf,OAAO,CACR,8HAA8H,CAChI,CAAC;AACJ,CAAC,CAAC;AANW,QAAA,mBAAmB,uBAM9B"}
@@ -1,4 +0,0 @@
1
- export const throwTransformError = (zodType) => {
2
- throw new Error(`${JSON.stringify(zodType)} contains a transform but is used in both an input and an output. This is likely a mistake. Set an \`effectType\` to resolve`);
3
- };
4
- //# sourceMappingURL=errors.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/create/errors.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAgB,EAAE,EAAE;IACtD,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,SAAS,CACf,OAAO,CACR,8HAA8H,CAChI,CAAC;AACJ,CAAC,CAAC"}
@@ -1,2 +0,0 @@
1
- import type { ZodType } from 'zod';
2
- export declare const throwTransformError: (zodType: ZodType) => never;