Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions eslint.config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import skuba from 'eslint-config-skuba';
import importZod from 'eslint-plugin-import-zod';
import zodOpenapi from 'eslint-plugin-zod-openapi';

export default [
Expand All @@ -14,7 +13,6 @@ export default [
],
},
...skuba,
...importZod.configs.recommended,
{
plugins: {
'zod-openapi': zodOpenapi,
Expand Down
5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,8 @@
"@vitest/coverage-v8": "3.2.4",
"@zod-openapi/openapi3-ts": "workspace:1.0.0",
"ajv": "8.17.1",
"eslint-plugin-import-zod": "1.2.0",
"eslint-plugin-zod-openapi": "2.0.0",
"skuba": "12.4.1",
"skuba": "13.1.1",
"tsdown": "0.18.4",
"vitest": "3.2.4",
"yaml": "2.8.1",
Expand All @@ -86,6 +85,6 @@
"entryPoint": "src/index.ts",
"template": "oss-npm-package",
"type": "package",
"version": "12.4.1"
"version": "13.1.1"
}
}
4 changes: 2 additions & 2 deletions packages/openapi3-ts/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
"private": true,
"exports": {
".": {
"zod-openapi/source": "./src/dist/index.ts",
"types": "./lib-types/dist/index.d.ts",
"zod-openapi/source": "./src/dist/index.ts",
"default": "./src/dist/index.ts"
}
},
Expand All @@ -14,6 +14,6 @@
},
"devDependencies": {
"openapi3-ts": "4.5.0",
"skuba": "12.4.1"
"skuba": "13.1.1"
}
}
2,036 changes: 1,319 additions & 717 deletions pnpm-lock.yaml

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions pnpm-workspace.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ minimumReleaseAgeExclude:
- eslint-config-skuba
- eslint-plugin-skuba
- skuba
- skuba-dive
- tsconfig-seek
packageManagerStrictVersion: true
publicHoistPattern:
- '@eslint/*'
- '@types*'
- eslint
- eslint-config-skuba
Expand Down
70 changes: 36 additions & 34 deletions src/create/document.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ import { createPaths } from './paths.js';

import type { oas31 } from '@zod-openapi/openapi3-ts';

export interface ZodOpenApiMediaTypeObject
extends Omit<oas31.MediaTypeObject, 'schema'> {
export interface ZodOpenApiMediaTypeObject extends Omit<
oas31.MediaTypeObject,
'schema'
> {
schema?: $ZodType | oas31.SchemaObject | oas31.ReferenceObject;
}

Expand All @@ -18,17 +20,21 @@ export interface ZodOpenApiContentObject {
[mediatype: string]: ZodOpenApiMediaTypeObject | undefined;
}

export interface ZodOpenApiRequestBodyObject
extends Omit<oas31.RequestBodyObject, 'content'> {
export interface ZodOpenApiRequestBodyObject extends Omit<
oas31.RequestBodyObject,
'content'
> {
content: ZodOpenApiContentObject;
/** Use this field to auto register this request body as a component */
id?: string;
}

export type ZodOpenApiHeadersObject = ZodObjectInput | oas31.HeadersObject;

export interface ZodOpenApiResponseObject
extends Omit<oas31.ResponseObject, 'content' | 'headers' | 'links'> {
export interface ZodOpenApiResponseObject extends Omit<
oas31.ResponseObject,
'content' | 'headers' | 'links'
> {
content?: ZodOpenApiContentObject;
headers?: ZodOpenApiHeadersObject;
links?: ZodOpenApiLinksObject;
Expand Down Expand Up @@ -61,23 +67,21 @@ export interface ZodOpenApiCallbackObject
[name: string]: ZodOpenApiPathItemObject | string | undefined;
}

export interface ZodOpenApiOperationObject
extends Omit<
oas31.OperationObject,
'requestBody' | 'responses' | 'parameters' | 'callbacks'
> {
export interface ZodOpenApiOperationObject extends Omit<
oas31.OperationObject,
'requestBody' | 'responses' | 'parameters' | 'callbacks'
> {
parameters?: Array<$ZodType | oas31.ParameterObject | oas31.ReferenceObject>;
requestBody?: ZodOpenApiRequestBodyObject;
requestParams?: ZodOpenApiParameters;
responses: ZodOpenApiResponsesObject;
callbacks?: ZodOpenApiCallbacksObject;
}

export interface ZodOpenApiPathItemObject
extends Omit<
oas31.PathItemObject,
'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace'
> {
export interface ZodOpenApiPathItemObject extends Omit<
oas31.PathItemObject,
'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace'
> {
get?: ZodOpenApiOperationObject;
put?: ZodOpenApiOperationObject;
post?: ZodOpenApiOperationObject;
Expand Down Expand Up @@ -140,19 +144,18 @@ export type ZodOpenApiExamplesObject = Record<
ZodOpenApiExampleObject | oas31.ReferenceObject
>;

export interface ZodOpenApiComponentsObject
extends Omit<
oas31.ComponentsObject,
| 'schemas'
| 'responses'
| 'requestBodies'
| 'headers'
| 'parameters'
| 'pathItems'
| 'callbacks'
| 'securitySchemes'
| 'examples'
> {
export interface ZodOpenApiComponentsObject extends Omit<
oas31.ComponentsObject,
| 'schemas'
| 'responses'
| 'requestBodies'
| 'headers'
| 'parameters'
| 'pathItems'
| 'callbacks'
| 'securitySchemes'
| 'examples'
> {
parameters?: Record<string, ZodOpenApiParameterObject>;
schemas?: Record<string, ZodOpenApiSchemaObject>;
requestBodies?: Record<string, ZodOpenApiRequestBodyObject>;
Expand All @@ -167,11 +170,10 @@ export interface ZodOpenApiComponentsObject

export type ZodOpenApiVersion = OpenApiVersion;

export interface ZodOpenApiObject
extends Omit<
oas31.OpenAPIObject,
'openapi' | 'paths' | 'webhooks' | 'components'
> {
export interface ZodOpenApiObject extends Omit<
oas31.OpenAPIObject,
'openapi' | 'paths' | 'webhooks' | 'components'
> {
openapi: ZodOpenApiVersion;
paths?: ZodOpenApiPathsObject;
webhooks?: ZodOpenApiPathsObject;
Expand Down
3 changes: 1 addition & 2 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,7 @@ export interface ZodOpenApiBaseMetadata {
}

export interface ZodOpenApiMetadata
extends ZodOpenApiBaseMetadata,
JSONSchemaMeta {
extends ZodOpenApiBaseMetadata, JSONSchemaMeta {
examples?: unknown[];
/**
* @deprecated - Use `examples` instead.
Expand Down