zod-openapi 5.3.1 → 5.4.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.
- package/README.md +1 -1
- package/dist/api.cjs +1 -1
- package/dist/api.d.cts +1 -1
- package/dist/api.d.ts +1 -1
- package/dist/api.js +1 -1
- package/dist/{components-Bgg6LgwE.cjs → components-C8ab2kZS.cjs} +20 -4
- package/dist/{components-BYHzS0hV.d.ts → components-CXzxKPFp.d.ts} +3 -3
- package/dist/{components-B6MpvUFu.js → components-D0GND9iu.js} +20 -4
- package/dist/{components-CJtL_UCT.d.cts → components-JnL0iOr_.d.cts} +3 -3
- package/dist/index.cjs +2 -2
- package/dist/index.d.cts +2 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -2
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<h1 align="center">zod-openapi</h1>
|
|
4
4
|
</p>
|
|
5
5
|
<p align="center">
|
|
6
|
-
A TypeScript library which uses <a href="https://github.com/colinhacks/zod">Zod</a> schemas to generate OpenAPI v3.
|
|
6
|
+
A TypeScript library which uses <a href="https://github.com/colinhacks/zod">Zod</a> schemas to generate OpenAPI v3.x documentation.
|
|
7
7
|
</p>
|
|
8
8
|
<div align="center">
|
|
9
9
|
<a href="https://www.npmjs.com/package/zod-openapi"><img src="https://img.shields.io/npm/v/zod-openapi"/></a>
|
package/dist/api.cjs
CHANGED
package/dist/api.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ComponentRegistry, ZodOpenApiBaseMetadata, ZodOpenApiMetadata, ZodOpenApiOverride, ZodOpenApiOverrideContext, ZodOpenApiOverrideMeta, ZodOpenApiOverrideMetaContext, createComponents, createRegistry } from "./components-
|
|
1
|
+
import { ComponentRegistry, ZodOpenApiBaseMetadata, ZodOpenApiMetadata, ZodOpenApiOverride, ZodOpenApiOverrideContext, ZodOpenApiOverrideMeta, ZodOpenApiOverrideMetaContext, createComponents, createRegistry } from "./components-JnL0iOr_.cjs";
|
|
2
2
|
import * as core from "zod/v4/core";
|
|
3
3
|
import { $ZodObject, $ZodType, $ZodTypes } from "zod/v4/core";
|
|
4
4
|
|
package/dist/api.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ComponentRegistry, ZodOpenApiBaseMetadata, ZodOpenApiMetadata, ZodOpenApiOverride, ZodOpenApiOverrideContext, ZodOpenApiOverrideMeta, ZodOpenApiOverrideMetaContext, createComponents, createRegistry } from "./components-
|
|
1
|
+
import { ComponentRegistry, ZodOpenApiBaseMetadata, ZodOpenApiMetadata, ZodOpenApiOverride, ZodOpenApiOverrideContext, ZodOpenApiOverrideMeta, ZodOpenApiOverrideMetaContext, createComponents, createRegistry } from "./components-CXzxKPFp.js";
|
|
2
2
|
import * as core from "zod/v4/core";
|
|
3
3
|
import { $ZodObject, $ZodType, $ZodTypes } from "zod/v4/core";
|
|
4
4
|
|
package/dist/api.js
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import { createComponents, createRegistry, isAnyZodType, unwrapZodObject } from "./components-
|
|
1
|
+
import { createComponents, createRegistry, isAnyZodType, unwrapZodObject } from "./components-D0GND9iu.js";
|
|
2
2
|
|
|
3
3
|
export { createComponents, createRegistry, isAnyZodType, unwrapZodObject };
|
|
@@ -210,6 +210,18 @@ const createPaths = (paths, registry$1, path) => {
|
|
|
210
210
|
return pathsObject;
|
|
211
211
|
};
|
|
212
212
|
|
|
213
|
+
//#endregion
|
|
214
|
+
//#region src/openapi.ts
|
|
215
|
+
const openApiVersions = [
|
|
216
|
+
"3.0.0",
|
|
217
|
+
"3.0.1",
|
|
218
|
+
"3.0.2",
|
|
219
|
+
"3.0.3",
|
|
220
|
+
"3.1.0",
|
|
221
|
+
"3.1.1"
|
|
222
|
+
];
|
|
223
|
+
const satisfiesVersion = (test, against) => openApiVersions.indexOf(test) >= openApiVersions.indexOf(against);
|
|
224
|
+
|
|
213
225
|
//#endregion
|
|
214
226
|
//#region src/create/schema/override.ts
|
|
215
227
|
const override = (ctx) => {
|
|
@@ -355,7 +367,8 @@ const createSchema = (schema, ctx = {
|
|
|
355
367
|
opts: {
|
|
356
368
|
...ctx.opts,
|
|
357
369
|
schemaRefPath: ctx.schemaRefPath
|
|
358
|
-
}
|
|
370
|
+
},
|
|
371
|
+
openapiVersion: ctx.openapiVersion
|
|
359
372
|
});
|
|
360
373
|
return {
|
|
361
374
|
schema: jsonSchemas.schemas.zodOpenApiCreateSchema,
|
|
@@ -414,6 +427,7 @@ const createSchemas = (schemas, ctx) => {
|
|
|
414
427
|
unrepresentable: "any",
|
|
415
428
|
reused: ctx.opts.reused,
|
|
416
429
|
cycles: ctx.opts.cycles,
|
|
430
|
+
target: satisfiesVersion(ctx.openapiVersion ?? "3.1.0", "3.1.0") ? void 0 : "openapi-3.0",
|
|
417
431
|
uri: (id) => id === "__shared" ? `#ZOD_OPENAPI/${id}` : `#ZOD_OPENAPI/__shared#/$defs/${id}`
|
|
418
432
|
});
|
|
419
433
|
const components = jsonSchema.schemas.__shared?.$defs ?? {};
|
|
@@ -912,16 +926,18 @@ const createManualSchemas = (registry$1) => {
|
|
|
912
926
|
registry$1.components.schemas.ids.set(key, schema);
|
|
913
927
|
}
|
|
914
928
|
};
|
|
915
|
-
const createComponents = (registry$1, opts) => {
|
|
929
|
+
const createComponents = (registry$1, opts, openapiVersion) => {
|
|
916
930
|
createIOSchemas({
|
|
917
931
|
registry: registry$1,
|
|
918
932
|
io: "input",
|
|
919
|
-
opts
|
|
933
|
+
opts,
|
|
934
|
+
openapiVersion
|
|
920
935
|
});
|
|
921
936
|
createIOSchemas({
|
|
922
937
|
registry: registry$1,
|
|
923
938
|
io: "output",
|
|
924
|
-
opts
|
|
939
|
+
opts,
|
|
940
|
+
openapiVersion
|
|
925
941
|
});
|
|
926
942
|
createManualSchemas(registry$1);
|
|
927
943
|
const components = {};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { $ZodType, $ZodTypes, JSONSchemaMeta, toJSONSchema } from "zod/v4/core";
|
|
2
2
|
|
|
3
3
|
//#region src/openapi.d.ts
|
|
4
|
-
declare const openApiVersions: readonly ["3.1.0", "3.1.1"];
|
|
4
|
+
declare const openApiVersions: readonly ["3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.1.0", "3.1.1"];
|
|
5
5
|
type OpenApiVersion = (typeof openApiVersions)[number];
|
|
6
6
|
//#endregion
|
|
7
7
|
//#region packages/openapi3-ts/lib-types/dist/model/specification-extension.d.ts
|
|
@@ -630,6 +630,6 @@ interface ComponentRegistry {
|
|
|
630
630
|
}) => ExampleObject | ReferenceObject;
|
|
631
631
|
}
|
|
632
632
|
declare const createRegistry: (components?: ZodOpenApiComponentsObject) => ComponentRegistry;
|
|
633
|
-
declare const createComponents: (registry: ComponentRegistry, opts: CreateDocumentOptions) => ComponentsObject;
|
|
633
|
+
declare const createComponents: (registry: ComponentRegistry, opts: CreateDocumentOptions, openapiVersion?: OpenApiVersion) => ComponentsObject;
|
|
634
634
|
//#endregion
|
|
635
|
-
export { BaseParameterObject, CallbackObject, CallbacksObject, ComponentRegistry, ComponentsObject, ContactObject, ContentObject, CreateDocumentOptions, DiscriminatorObject, EncodingObject, EncodingPropertyObject, ExampleObject, ExamplesObject, ExternalDocumentationObject, HeaderObject, HeadersObject, IExtensionName, IExtensionType, type ISpecificationExtension, InfoObject, LicenseObject, LinkObject, LinkParametersObject, LinksObject, MediaTypeObject, OAuthFlowObject, OAuthFlowsObject, OpenAPIObject, OperationObject, ParameterLocation, ParameterObject, ParameterStyle, PathItemObject, PathObject, PathsObject, ReferenceObject, RequestBodyObject, ResponseObject, ResponsesObject, SchemaObject, SchemaObjectType, SchemasObject, ScopesObject, SecurityRequirementObject, SecuritySchemeObject, SecuritySchemeType, ServerObject, ServerVariableObject, TagObject, XmlObject, ZodObjectInput, ZodOpenApiBaseMetadata, ZodOpenApiCallbackObject, ZodOpenApiCallbacksObject, ZodOpenApiComponentsObject, ZodOpenApiContentObject, ZodOpenApiExampleObject, ZodOpenApiExamplesObject, ZodOpenApiHeaderObject, ZodOpenApiHeadersObject, ZodOpenApiLinkObject, ZodOpenApiLinksObject, ZodOpenApiMediaTypeObject, ZodOpenApiMetadata, ZodOpenApiObject, ZodOpenApiOperationObject, ZodOpenApiOverride, ZodOpenApiOverrideContext, ZodOpenApiOverrideMeta, ZodOpenApiOverrideMetaContext, ZodOpenApiParameterObject, ZodOpenApiParameters, ZodOpenApiPathItemObject, ZodOpenApiPathsObject, ZodOpenApiRequestBodyObject, ZodOpenApiResponseObject, ZodOpenApiResponsesObject, ZodOpenApiSchemaObject, ZodOpenApiSecuritySchemeObject, ZodOpenApiVersion, createComponents, createDocument, createRegistry };
|
|
635
|
+
export { BaseParameterObject, CallbackObject, CallbacksObject, ComponentRegistry, ComponentsObject, ContactObject, ContentObject, CreateDocumentOptions, DiscriminatorObject, EncodingObject, EncodingPropertyObject, ExampleObject, ExamplesObject, ExternalDocumentationObject, HeaderObject, HeadersObject, IExtensionName, IExtensionType, type ISpecificationExtension, InfoObject, LicenseObject, LinkObject, LinkParametersObject, LinksObject, MediaTypeObject, OAuthFlowObject, OAuthFlowsObject, OpenAPIObject, OpenApiVersion, OperationObject, ParameterLocation, ParameterObject, ParameterStyle, PathItemObject, PathObject, PathsObject, ReferenceObject, RequestBodyObject, ResponseObject, ResponsesObject, SchemaObject, SchemaObjectType, SchemasObject, ScopesObject, SecurityRequirementObject, SecuritySchemeObject, SecuritySchemeType, ServerObject, ServerVariableObject, TagObject, XmlObject, ZodObjectInput, ZodOpenApiBaseMetadata, ZodOpenApiCallbackObject, ZodOpenApiCallbacksObject, ZodOpenApiComponentsObject, ZodOpenApiContentObject, ZodOpenApiExampleObject, ZodOpenApiExamplesObject, ZodOpenApiHeaderObject, ZodOpenApiHeadersObject, ZodOpenApiLinkObject, ZodOpenApiLinksObject, ZodOpenApiMediaTypeObject, ZodOpenApiMetadata, ZodOpenApiObject, ZodOpenApiOperationObject, ZodOpenApiOverride, ZodOpenApiOverrideContext, ZodOpenApiOverrideMeta, ZodOpenApiOverrideMetaContext, ZodOpenApiParameterObject, ZodOpenApiParameters, ZodOpenApiPathItemObject, ZodOpenApiPathsObject, ZodOpenApiRequestBodyObject, ZodOpenApiResponseObject, ZodOpenApiResponsesObject, ZodOpenApiSchemaObject, ZodOpenApiSecuritySchemeObject, ZodOpenApiVersion, createComponents, createDocument, createRegistry };
|
|
@@ -187,6 +187,18 @@ const createPaths = (paths, registry$1, path) => {
|
|
|
187
187
|
return pathsObject;
|
|
188
188
|
};
|
|
189
189
|
|
|
190
|
+
//#endregion
|
|
191
|
+
//#region src/openapi.ts
|
|
192
|
+
const openApiVersions = [
|
|
193
|
+
"3.0.0",
|
|
194
|
+
"3.0.1",
|
|
195
|
+
"3.0.2",
|
|
196
|
+
"3.0.3",
|
|
197
|
+
"3.1.0",
|
|
198
|
+
"3.1.1"
|
|
199
|
+
];
|
|
200
|
+
const satisfiesVersion = (test, against) => openApiVersions.indexOf(test) >= openApiVersions.indexOf(against);
|
|
201
|
+
|
|
190
202
|
//#endregion
|
|
191
203
|
//#region src/create/schema/override.ts
|
|
192
204
|
const override = (ctx) => {
|
|
@@ -332,7 +344,8 @@ const createSchema = (schema, ctx = {
|
|
|
332
344
|
opts: {
|
|
333
345
|
...ctx.opts,
|
|
334
346
|
schemaRefPath: ctx.schemaRefPath
|
|
335
|
-
}
|
|
347
|
+
},
|
|
348
|
+
openapiVersion: ctx.openapiVersion
|
|
336
349
|
});
|
|
337
350
|
return {
|
|
338
351
|
schema: jsonSchemas.schemas.zodOpenApiCreateSchema,
|
|
@@ -391,6 +404,7 @@ const createSchemas = (schemas, ctx) => {
|
|
|
391
404
|
unrepresentable: "any",
|
|
392
405
|
reused: ctx.opts.reused,
|
|
393
406
|
cycles: ctx.opts.cycles,
|
|
407
|
+
target: satisfiesVersion(ctx.openapiVersion ?? "3.1.0", "3.1.0") ? void 0 : "openapi-3.0",
|
|
394
408
|
uri: (id) => id === "__shared" ? `#ZOD_OPENAPI/${id}` : `#ZOD_OPENAPI/__shared#/$defs/${id}`
|
|
395
409
|
});
|
|
396
410
|
const components = jsonSchema.schemas.__shared?.$defs ?? {};
|
|
@@ -889,16 +903,18 @@ const createManualSchemas = (registry$1) => {
|
|
|
889
903
|
registry$1.components.schemas.ids.set(key, schema);
|
|
890
904
|
}
|
|
891
905
|
};
|
|
892
|
-
const createComponents = (registry$1, opts) => {
|
|
906
|
+
const createComponents = (registry$1, opts, openapiVersion) => {
|
|
893
907
|
createIOSchemas({
|
|
894
908
|
registry: registry$1,
|
|
895
909
|
io: "input",
|
|
896
|
-
opts
|
|
910
|
+
opts,
|
|
911
|
+
openapiVersion
|
|
897
912
|
});
|
|
898
913
|
createIOSchemas({
|
|
899
914
|
registry: registry$1,
|
|
900
915
|
io: "output",
|
|
901
|
-
opts
|
|
916
|
+
opts,
|
|
917
|
+
openapiVersion
|
|
902
918
|
});
|
|
903
919
|
createManualSchemas(registry$1);
|
|
904
920
|
const components = {};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { $ZodType, $ZodTypes, JSONSchemaMeta, toJSONSchema } from "zod/v4/core";
|
|
2
2
|
|
|
3
3
|
//#region src/openapi.d.ts
|
|
4
|
-
declare const openApiVersions: readonly ["3.1.0", "3.1.1"];
|
|
4
|
+
declare const openApiVersions: readonly ["3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.1.0", "3.1.1"];
|
|
5
5
|
type OpenApiVersion = (typeof openApiVersions)[number];
|
|
6
6
|
//#endregion
|
|
7
7
|
//#region packages/openapi3-ts/lib-types/dist/model/specification-extension.d.ts
|
|
@@ -630,6 +630,6 @@ interface ComponentRegistry {
|
|
|
630
630
|
}) => ExampleObject | ReferenceObject;
|
|
631
631
|
}
|
|
632
632
|
declare const createRegistry: (components?: ZodOpenApiComponentsObject) => ComponentRegistry;
|
|
633
|
-
declare const createComponents: (registry: ComponentRegistry, opts: CreateDocumentOptions) => ComponentsObject;
|
|
633
|
+
declare const createComponents: (registry: ComponentRegistry, opts: CreateDocumentOptions, openapiVersion?: OpenApiVersion) => ComponentsObject;
|
|
634
634
|
//#endregion
|
|
635
|
-
export { BaseParameterObject, CallbackObject, CallbacksObject, ComponentRegistry, ComponentsObject, ContactObject, ContentObject, CreateDocumentOptions, DiscriminatorObject, EncodingObject, EncodingPropertyObject, ExampleObject, ExamplesObject, ExternalDocumentationObject, HeaderObject, HeadersObject, IExtensionName, IExtensionType, type ISpecificationExtension, InfoObject, LicenseObject, LinkObject, LinkParametersObject, LinksObject, MediaTypeObject, OAuthFlowObject, OAuthFlowsObject, OpenAPIObject, OperationObject, ParameterLocation, ParameterObject, ParameterStyle, PathItemObject, PathObject, PathsObject, ReferenceObject, RequestBodyObject, ResponseObject, ResponsesObject, SchemaObject, SchemaObjectType, SchemasObject, ScopesObject, SecurityRequirementObject, SecuritySchemeObject, SecuritySchemeType, ServerObject, ServerVariableObject, TagObject, XmlObject, ZodObjectInput, ZodOpenApiBaseMetadata, ZodOpenApiCallbackObject, ZodOpenApiCallbacksObject, ZodOpenApiComponentsObject, ZodOpenApiContentObject, ZodOpenApiExampleObject, ZodOpenApiExamplesObject, ZodOpenApiHeaderObject, ZodOpenApiHeadersObject, ZodOpenApiLinkObject, ZodOpenApiLinksObject, ZodOpenApiMediaTypeObject, ZodOpenApiMetadata, ZodOpenApiObject, ZodOpenApiOperationObject, ZodOpenApiOverride, ZodOpenApiOverrideContext, ZodOpenApiOverrideMeta, ZodOpenApiOverrideMetaContext, ZodOpenApiParameterObject, ZodOpenApiParameters, ZodOpenApiPathItemObject, ZodOpenApiPathsObject, ZodOpenApiRequestBodyObject, ZodOpenApiResponseObject, ZodOpenApiResponsesObject, ZodOpenApiSchemaObject, ZodOpenApiSecuritySchemeObject, ZodOpenApiVersion, createComponents, createDocument, createRegistry };
|
|
635
|
+
export { BaseParameterObject, CallbackObject, CallbacksObject, ComponentRegistry, ComponentsObject, ContactObject, ContentObject, CreateDocumentOptions, DiscriminatorObject, EncodingObject, EncodingPropertyObject, ExampleObject, ExamplesObject, ExternalDocumentationObject, HeaderObject, HeadersObject, IExtensionName, IExtensionType, type ISpecificationExtension, InfoObject, LicenseObject, LinkObject, LinkParametersObject, LinksObject, MediaTypeObject, OAuthFlowObject, OAuthFlowsObject, OpenAPIObject, OpenApiVersion, OperationObject, ParameterLocation, ParameterObject, ParameterStyle, PathItemObject, PathObject, PathsObject, ReferenceObject, RequestBodyObject, ResponseObject, ResponsesObject, SchemaObject, SchemaObjectType, SchemasObject, ScopesObject, SecurityRequirementObject, SecuritySchemeObject, SecuritySchemeType, ServerObject, ServerVariableObject, TagObject, XmlObject, ZodObjectInput, ZodOpenApiBaseMetadata, ZodOpenApiCallbackObject, ZodOpenApiCallbacksObject, ZodOpenApiComponentsObject, ZodOpenApiContentObject, ZodOpenApiExampleObject, ZodOpenApiExamplesObject, ZodOpenApiHeaderObject, ZodOpenApiHeadersObject, ZodOpenApiLinkObject, ZodOpenApiLinksObject, ZodOpenApiMediaTypeObject, ZodOpenApiMetadata, ZodOpenApiObject, ZodOpenApiOperationObject, ZodOpenApiOverride, ZodOpenApiOverrideContext, ZodOpenApiOverrideMeta, ZodOpenApiOverrideMetaContext, ZodOpenApiParameterObject, ZodOpenApiParameters, ZodOpenApiPathItemObject, ZodOpenApiPathsObject, ZodOpenApiRequestBodyObject, ZodOpenApiResponseObject, ZodOpenApiResponsesObject, ZodOpenApiSchemaObject, ZodOpenApiSecuritySchemeObject, ZodOpenApiVersion, createComponents, createDocument, createRegistry };
|
package/dist/index.cjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const require_components = require('./components-
|
|
1
|
+
const require_components = require('./components-C8ab2kZS.cjs');
|
|
2
2
|
|
|
3
3
|
//#region src/create/document.ts
|
|
4
4
|
const createDocument = (zodOpenApiObject, opts = {}) => {
|
|
@@ -9,7 +9,7 @@ const createDocument = (zodOpenApiObject, opts = {}) => {
|
|
|
9
9
|
if (createdPaths) document.paths = createdPaths;
|
|
10
10
|
const createdWebhooks = require_components.createPaths(webhooks, registry, ["webhooks"]);
|
|
11
11
|
if (createdWebhooks) document.webhooks = createdWebhooks;
|
|
12
|
-
const createdComponents = require_components.createComponents(registry, opts);
|
|
12
|
+
const createdComponents = require_components.createComponents(registry, opts, zodOpenApiObject.openapi);
|
|
13
13
|
if (Object.keys(createdComponents).length > 0) document.components = createdComponents;
|
|
14
14
|
return document;
|
|
15
15
|
};
|
package/dist/index.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { BaseParameterObject, CallbackObject, CallbacksObject, ComponentRegistry, ComponentsObject, ContactObject, ContentObject, CreateDocumentOptions, DiscriminatorObject, EncodingObject, EncodingPropertyObject, ExampleObject, ExamplesObject, ExternalDocumentationObject, HeaderObject, HeadersObject, IExtensionName, IExtensionType, ISpecificationExtension, InfoObject, LicenseObject, LinkObject, LinkParametersObject, LinksObject, MediaTypeObject, OAuthFlowObject, OAuthFlowsObject, OpenAPIObject, OperationObject, ParameterLocation, ParameterObject, ParameterStyle, PathItemObject, PathObject, PathsObject, ReferenceObject, RequestBodyObject, ResponseObject, ResponsesObject, SchemaObject, SchemaObjectType, SchemasObject, ScopesObject, SecurityRequirementObject, SecuritySchemeObject, SecuritySchemeType, ServerObject, ServerVariableObject, TagObject, XmlObject, ZodObjectInput, ZodOpenApiBaseMetadata, ZodOpenApiCallbackObject, ZodOpenApiCallbacksObject, ZodOpenApiComponentsObject, ZodOpenApiContentObject, ZodOpenApiExampleObject, ZodOpenApiExamplesObject, ZodOpenApiHeaderObject, ZodOpenApiHeadersObject, ZodOpenApiLinkObject, ZodOpenApiLinksObject, ZodOpenApiMediaTypeObject, ZodOpenApiMetadata, ZodOpenApiObject, ZodOpenApiOperationObject, ZodOpenApiOverride, ZodOpenApiOverrideContext, ZodOpenApiOverrideMeta, ZodOpenApiOverrideMetaContext, ZodOpenApiParameterObject, ZodOpenApiParameters, ZodOpenApiPathItemObject, ZodOpenApiPathsObject, ZodOpenApiRequestBodyObject, ZodOpenApiResponseObject, ZodOpenApiResponsesObject, ZodOpenApiSchemaObject, ZodOpenApiSecuritySchemeObject, ZodOpenApiVersion, createDocument } from "./components-
|
|
1
|
+
import { BaseParameterObject, CallbackObject, CallbacksObject, ComponentRegistry, ComponentsObject, ContactObject, ContentObject, CreateDocumentOptions, DiscriminatorObject, EncodingObject, EncodingPropertyObject, ExampleObject, ExamplesObject, ExternalDocumentationObject, HeaderObject, HeadersObject, IExtensionName, IExtensionType, ISpecificationExtension, InfoObject, LicenseObject, LinkObject, LinkParametersObject, LinksObject, MediaTypeObject, OAuthFlowObject, OAuthFlowsObject, OpenAPIObject, OpenApiVersion, OperationObject, ParameterLocation, ParameterObject, ParameterStyle, PathItemObject, PathObject, PathsObject, ReferenceObject, RequestBodyObject, ResponseObject, ResponsesObject, SchemaObject, SchemaObjectType, SchemasObject, ScopesObject, SecurityRequirementObject, SecuritySchemeObject, SecuritySchemeType, ServerObject, ServerVariableObject, TagObject, XmlObject, ZodObjectInput, ZodOpenApiBaseMetadata, ZodOpenApiCallbackObject, ZodOpenApiCallbacksObject, ZodOpenApiComponentsObject, ZodOpenApiContentObject, ZodOpenApiExampleObject, ZodOpenApiExamplesObject, ZodOpenApiHeaderObject, ZodOpenApiHeadersObject, ZodOpenApiLinkObject, ZodOpenApiLinksObject, ZodOpenApiMediaTypeObject, ZodOpenApiMetadata, ZodOpenApiObject, ZodOpenApiOperationObject, ZodOpenApiOverride, ZodOpenApiOverrideContext, ZodOpenApiOverrideMeta, ZodOpenApiOverrideMetaContext, ZodOpenApiParameterObject, ZodOpenApiParameters, ZodOpenApiPathItemObject, ZodOpenApiPathsObject, ZodOpenApiRequestBodyObject, ZodOpenApiResponseObject, ZodOpenApiResponsesObject, ZodOpenApiSchemaObject, ZodOpenApiSecuritySchemeObject, ZodOpenApiVersion, createDocument } from "./components-JnL0iOr_.cjs";
|
|
2
2
|
import * as core from "zod/v4/core";
|
|
3
3
|
|
|
4
4
|
//#region rolldown:runtime
|
|
@@ -23,6 +23,7 @@ declare const createSchema: (schema: core.$ZodType, ctx?: {
|
|
|
23
23
|
* The $ref path to use for a schema component. Defaults to `#/components/schemas/`
|
|
24
24
|
*/
|
|
25
25
|
schemaRefPath?: string;
|
|
26
|
+
openapiVersion?: OpenApiVersion;
|
|
26
27
|
}) => {
|
|
27
28
|
schema: SchemaObject | ReferenceObject;
|
|
28
29
|
components: Record<string, SchemaObject>;
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { BaseParameterObject, CallbackObject, CallbacksObject, ComponentRegistry, ComponentsObject, ContactObject, ContentObject, CreateDocumentOptions, DiscriminatorObject, EncodingObject, EncodingPropertyObject, ExampleObject, ExamplesObject, ExternalDocumentationObject, HeaderObject, HeadersObject, IExtensionName, IExtensionType, ISpecificationExtension, InfoObject, LicenseObject, LinkObject, LinkParametersObject, LinksObject, MediaTypeObject, OAuthFlowObject, OAuthFlowsObject, OpenAPIObject, OperationObject, ParameterLocation, ParameterObject, ParameterStyle, PathItemObject, PathObject, PathsObject, ReferenceObject, RequestBodyObject, ResponseObject, ResponsesObject, SchemaObject, SchemaObjectType, SchemasObject, ScopesObject, SecurityRequirementObject, SecuritySchemeObject, SecuritySchemeType, ServerObject, ServerVariableObject, TagObject, XmlObject, ZodObjectInput, ZodOpenApiBaseMetadata, ZodOpenApiCallbackObject, ZodOpenApiCallbacksObject, ZodOpenApiComponentsObject, ZodOpenApiContentObject, ZodOpenApiExampleObject, ZodOpenApiExamplesObject, ZodOpenApiHeaderObject, ZodOpenApiHeadersObject, ZodOpenApiLinkObject, ZodOpenApiLinksObject, ZodOpenApiMediaTypeObject, ZodOpenApiMetadata, ZodOpenApiObject, ZodOpenApiOperationObject, ZodOpenApiOverride, ZodOpenApiOverrideContext, ZodOpenApiOverrideMeta, ZodOpenApiOverrideMetaContext, ZodOpenApiParameterObject, ZodOpenApiParameters, ZodOpenApiPathItemObject, ZodOpenApiPathsObject, ZodOpenApiRequestBodyObject, ZodOpenApiResponseObject, ZodOpenApiResponsesObject, ZodOpenApiSchemaObject, ZodOpenApiSecuritySchemeObject, ZodOpenApiVersion, createDocument } from "./components-
|
|
1
|
+
import { BaseParameterObject, CallbackObject, CallbacksObject, ComponentRegistry, ComponentsObject, ContactObject, ContentObject, CreateDocumentOptions, DiscriminatorObject, EncodingObject, EncodingPropertyObject, ExampleObject, ExamplesObject, ExternalDocumentationObject, HeaderObject, HeadersObject, IExtensionName, IExtensionType, ISpecificationExtension, InfoObject, LicenseObject, LinkObject, LinkParametersObject, LinksObject, MediaTypeObject, OAuthFlowObject, OAuthFlowsObject, OpenAPIObject, OpenApiVersion, OperationObject, ParameterLocation, ParameterObject, ParameterStyle, PathItemObject, PathObject, PathsObject, ReferenceObject, RequestBodyObject, ResponseObject, ResponsesObject, SchemaObject, SchemaObjectType, SchemasObject, ScopesObject, SecurityRequirementObject, SecuritySchemeObject, SecuritySchemeType, ServerObject, ServerVariableObject, TagObject, XmlObject, ZodObjectInput, ZodOpenApiBaseMetadata, ZodOpenApiCallbackObject, ZodOpenApiCallbacksObject, ZodOpenApiComponentsObject, ZodOpenApiContentObject, ZodOpenApiExampleObject, ZodOpenApiExamplesObject, ZodOpenApiHeaderObject, ZodOpenApiHeadersObject, ZodOpenApiLinkObject, ZodOpenApiLinksObject, ZodOpenApiMediaTypeObject, ZodOpenApiMetadata, ZodOpenApiObject, ZodOpenApiOperationObject, ZodOpenApiOverride, ZodOpenApiOverrideContext, ZodOpenApiOverrideMeta, ZodOpenApiOverrideMetaContext, ZodOpenApiParameterObject, ZodOpenApiParameters, ZodOpenApiPathItemObject, ZodOpenApiPathsObject, ZodOpenApiRequestBodyObject, ZodOpenApiResponseObject, ZodOpenApiResponsesObject, ZodOpenApiSchemaObject, ZodOpenApiSecuritySchemeObject, ZodOpenApiVersion, createDocument } from "./components-CXzxKPFp.js";
|
|
2
2
|
import * as core from "zod/v4/core";
|
|
3
3
|
|
|
4
4
|
//#region rolldown:runtime
|
|
@@ -23,6 +23,7 @@ declare const createSchema: (schema: core.$ZodType, ctx?: {
|
|
|
23
23
|
* The $ref path to use for a schema component. Defaults to `#/components/schemas/`
|
|
24
24
|
*/
|
|
25
25
|
schemaRefPath?: string;
|
|
26
|
+
openapiVersion?: OpenApiVersion;
|
|
26
27
|
}) => {
|
|
27
28
|
schema: SchemaObject | ReferenceObject;
|
|
28
29
|
components: Record<string, SchemaObject>;
|
package/dist/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { createComponents, createPaths, createRegistry, createSchema } from "./components-
|
|
1
|
+
import { createComponents, createPaths, createRegistry, createSchema } from "./components-D0GND9iu.js";
|
|
2
2
|
|
|
3
3
|
//#region src/create/document.ts
|
|
4
4
|
const createDocument = (zodOpenApiObject, opts = {}) => {
|
|
@@ -9,7 +9,7 @@ const createDocument = (zodOpenApiObject, opts = {}) => {
|
|
|
9
9
|
if (createdPaths) document.paths = createdPaths;
|
|
10
10
|
const createdWebhooks = createPaths(webhooks, registry, ["webhooks"]);
|
|
11
11
|
if (createdWebhooks) document.webhooks = createdWebhooks;
|
|
12
|
-
const createdComponents = createComponents(registry, opts);
|
|
12
|
+
const createdComponents = createComponents(registry, opts, zodOpenApiObject.openapi);
|
|
13
13
|
if (Object.keys(createdComponents).length > 0) document.components = createdComponents;
|
|
14
14
|
return document;
|
|
15
15
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "zod-openapi",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.4.0",
|
|
4
4
|
"description": "Convert Zod Schemas to OpenAPI v3.x documentation",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"typescript",
|
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
"devDependencies": {
|
|
45
45
|
"@arethetypeswrong/cli": "0.18.2",
|
|
46
46
|
"@changesets/changelog-github": "0.5.1",
|
|
47
|
-
"@changesets/cli": "2.29.
|
|
47
|
+
"@changesets/cli": "2.29.6",
|
|
48
48
|
"@redocly/cli": "2.0.2",
|
|
49
49
|
"@types/node": "22.15.21",
|
|
50
50
|
"@vitest/coverage-v8": "3.2.4",
|
|
@@ -52,11 +52,11 @@
|
|
|
52
52
|
"ajv": "8.17.1",
|
|
53
53
|
"eslint-plugin-import-zod": "1.2.0",
|
|
54
54
|
"eslint-plugin-zod-openapi": "2.0.0",
|
|
55
|
-
"skuba": "12.
|
|
56
|
-
"tsdown": "0.
|
|
55
|
+
"skuba": "12.1.1",
|
|
56
|
+
"tsdown": "0.14.0",
|
|
57
57
|
"vitest": "3.2.4",
|
|
58
|
-
"yaml": "2.8.
|
|
59
|
-
"zod": "4.
|
|
58
|
+
"yaml": "2.8.1",
|
|
59
|
+
"zod": "4.1.1"
|
|
60
60
|
},
|
|
61
61
|
"peerDependencies": {
|
|
62
62
|
"zod": "^3.25.74 || ^4.0.0"
|
|
@@ -72,7 +72,7 @@
|
|
|
72
72
|
"entryPoint": "src/index.ts",
|
|
73
73
|
"template": "oss-npm-package",
|
|
74
74
|
"type": "package",
|
|
75
|
-
"version": "
|
|
75
|
+
"version": "12.1.1"
|
|
76
76
|
},
|
|
77
77
|
"scripts": {
|
|
78
78
|
"build": "pnpm -r build && tsdown",
|