chore: switch to openapi3-ts which requires no patches

maxholman · maxholman · commit e42b47b2ab8a · 2024-10-13T14:01:40.000+08:00
diff --git a/lib/api.ts b/lib/api.ts
@@ -1,6 +1,5 @@
-import { Construct, type IConstruct } from 'constructs';
 import type { JSONSchema7 } from 'json-schema';
-import type { OpenAPIV3_1 } from 'openapi-types';
+import type { oas31 } from 'openapi3-ts';
 import { ApiLowLevel } from './ApiLowLevel.js';
 import { Parameter } from './parameter.js';
 import { Path } from './path.js';
@@ -17,7 +16,7 @@ export enum OpenApiVersion {
 
 export interface ApiOptions {
   openapi: OpenApiVersion; //  | `${OpenApiVersion}`;
-  info: OpenAPIV3_1.InfoObject;
+  info: oas31.InfoObject;
 }
 
 export class Api extends ApiLowLevel {
@@ -68,7 +67,7 @@ export class Api extends ApiLowLevel {
             child instanceof SecurityRequirement,
         )
         .map((child) => child.synth()),
-    } satisfies OpenAPIV3_1.Document;
+    } satisfies oas31.OpenAPIObject;
   }
 
   public synthJsonSchema() {
diff --git a/lib/media-type.ts b/lib/media-type.ts
@@ -1,5 +1,5 @@
 import { Construct } from 'constructs';
-import type { OpenAPIV3_1 } from 'openapi-types';
+import type { oas31 } from 'openapi3-ts';
 import { Reference } from './reference.js';
 import type { Schema } from './schema.js';
 
@@ -24,7 +24,7 @@ export class MediaType extends Construct {
     this.options = options;
   }
 
-  public synth(): OpenAPIV3_1.MediaTypeObject {
+  public synth(): oas31.MediaTypeObject {
     return {
       schema:
         this.options.schema instanceof Reference
diff --git a/lib/operation.ts b/lib/operation.ts
@@ -1,5 +1,5 @@
 import { Construct } from 'constructs';
-import type { OpenAPIV3_1 } from 'openapi-types';
+import type { oas31 } from 'openapi3-ts';
 import type { HttpMethods } from './http-methods.js';
 import type { Parameter } from './parameter.js';
 import { RequestBody, type RequestBodyOptions } from './request-body.js';
@@ -92,6 +92,6 @@ export class Operation<TPath extends string = '/'> extends Construct {
           ]),
         ),
       }),
-    } satisfies OpenAPIV3_1.OperationObject;
+    } satisfies oas31.OperationObject;
   }
 }
diff --git a/lib/parameter.ts b/lib/parameter.ts
@@ -1,5 +1,5 @@
 import { Construct } from 'constructs';
-import type { OpenAPIV3_1 } from 'openapi-types';
+import type { oas31 } from 'openapi3-ts';
 import type { Api } from './api.js';
 import type { Schema } from './schema.js';
 
@@ -34,7 +34,7 @@ export class Parameter<
     this.options = options;
   }
 
-  public referenceObject(): OpenAPIV3_1.ReferenceObject {
+  public referenceObject(): oas31.ReferenceObject {
     return {
       $ref: this.jsonPointer(),
     };
@@ -66,6 +66,6 @@ export class Parameter<
       ...(this.options.schema && {
         schema: this.options.schema.referenceObject(),
       }),
-    } satisfies OpenAPIV3_1.ParameterObject | OpenAPIV3_1.ReferenceObject;
+    } satisfies oas31.ParameterObject | oas31.ReferenceObject;
   }
 }
diff --git a/lib/path.ts b/lib/path.ts
@@ -1,6 +1,6 @@
 import { strict } from 'node:assert';
 import { Construct } from 'constructs';
-import type { OpenAPIV3_1 } from 'openapi-types';
+import type { oas31 } from 'openapi3-ts';
 import type { Api } from './api.js';
 import { HttpMethods } from './http-methods.js';
 import { Operation, type OperationOptions } from './operation.js';
@@ -63,6 +63,6 @@ export class Path<TPath extends string = '/'> extends Construct {
         ),
       }),
       ...(this.options.summary && { summary: this.options.summary }),
-    } satisfies OpenAPIV3_1.PathItemObject;
+    } satisfies oas31.PathItemObject;
   }
 }
diff --git a/lib/reference.ts b/lib/reference.ts
@@ -1,5 +1,5 @@
 import { Construct } from 'constructs';
-import type { OpenAPIV3_1 } from 'openapi-types';
+import type { oas31 } from 'openapi3-ts';
 import { ApiLowLevel } from './ApiLowLevel.js';
 import { Schema } from './schema.js';
 
@@ -22,7 +22,7 @@ export class Reference<T extends Target> extends Construct {
     return this.schema.schemaKey;
   }
 
-  public synth(): OpenAPIV3_1.ReferenceObject {
+  public synth(): oas31.ReferenceObject {
     return this.schema.referenceObject();
   }
 }
diff --git a/lib/request-body.ts b/lib/request-body.ts
@@ -1,5 +1,5 @@
 import { Construct } from 'constructs';
-import type { OpenAPIV3_1 } from 'openapi-types';
+import type { oas31 } from 'openapi3-ts';
 import { MediaType, type MediaTypeOptions } from './media-type.js';
 
 export interface RequestBodyOptions {
@@ -23,7 +23,7 @@ export class RequestBody extends Construct {
         : new MediaType(this, id, options.content);
   }
 
-  public synth(): OpenAPIV3_1.RequestBodyObject {
+  public synth(): oas31.RequestBodyObject {
     return {
       description: this.options.description || '',
       content: {
diff --git a/lib/response.ts b/lib/response.ts
@@ -1,5 +1,5 @@
 import { Construct } from 'constructs';
-import type { OpenAPIV3_1 } from 'openapi-types';
+import type { oas31 } from 'openapi3-ts';
 import type { Header } from './header.js';
 import { MediaType, type MediaTypeOptions } from './media-type.js';
 
@@ -34,6 +34,6 @@ export class Response extends Construct {
           [this.content.contentType]: this.content.synth(),
         }),
       },
-    } satisfies OpenAPIV3_1.ResponseObject;
+    } satisfies oas31.ResponseObject;
   }
 }
diff --git a/lib/schema.ts b/lib/schema.ts
@@ -1,12 +1,12 @@
 import { Construct } from 'constructs';
-import type { OpenAPIV3_1 } from 'openapi-types';
+import type { oas31 } from 'openapi3-ts';
 
-interface SchemaOptions<T extends OpenAPIV3_1.SchemaObject> {
+interface SchemaOptions<T extends oas31.SchemaObject> {
   schema: T;
 }
 
 export class Schema<
-  T extends OpenAPIV3_1.SchemaObject = OpenAPIV3_1.SchemaObject,
+  T extends oas31.SchemaObject = oas31.SchemaObject,
 > extends Construct {
   private options: SchemaOptions<T>;
 
@@ -28,10 +28,10 @@ export class Schema<
     return `#/components/schemas/${this.schemaKey}`;
   }
 
-  public referenceObject() {
+  public referenceObject(): oas31.ReferenceObject {
     return {
       $ref: this.jsonPointer(),
-    } satisfies OpenAPIV3_1.ReferenceObject;
+    };
   }
 
   // eslint-disable-next-line class-methods-use-this
diff --git a/lib/security-requirement.ts b/lib/security-requirement.ts
@@ -1,5 +1,5 @@
 import { Construct } from 'constructs';
-import type { OpenAPIV3_1 } from 'openapi-types';
+import type { oas31 } from 'openapi3-ts';
 import type { Api } from './api.js';
 import type { SecurityScheme } from './security-scheme.js';
 
@@ -20,7 +20,7 @@ export class SecurityRequirement extends Construct {
     this.options = options;
   }
 
-  public synth(): OpenAPIV3_1.SecurityRequirementObject {
+  public synth(): oas31.SecurityRequirementObject {
     return this.options.securityScheme
       ? {
           [this.options.securityScheme.node.id]: this.options.scopes || [],
diff --git a/lib/security-scheme.ts b/lib/security-scheme.ts
@@ -1,13 +1,13 @@
 import { Construct } from 'constructs';
-import type { OpenAPIV3_1 } from 'openapi-types';
+import type { oas31 } from 'openapi3-ts';
 
 export class SecurityScheme extends Construct {
-  private options: OpenAPIV3_1.SecuritySchemeObject;
+  private options: oas31.SecuritySchemeObject;
 
   constructor(
     scope: Construct,
     id: string,
-    options: OpenAPIV3_1.SecuritySchemeObject,
+    options: oas31.SecuritySchemeObject,
   ) {
     super(scope, id);
     this.options = options;
@@ -17,7 +17,7 @@ export class SecurityScheme extends Construct {
     return this.node.id;
   }
 
-  public synth(): OpenAPIV3_1.SecuritySchemeObject {
+  public synth(): oas31.SecuritySchemeObject {
     return this.options;
   }
 }
diff --git a/lib/server.ts b/lib/server.ts
@@ -1,5 +1,5 @@
 import { Construct } from 'constructs';
-import type { OpenAPIV3_1 } from 'openapi-types';
+import type { oas31 } from 'openapi3-ts';
 import type { Api } from './api.js';
 
 interface ServerOptions {
@@ -15,7 +15,7 @@ export class Server extends Construct {
     this.options = options;
   }
 
-  public synth(): OpenAPIV3_1.ServerObject {
+  public synth(): oas31.ServerObject {
     return {
       url: this.options.url.toString(),
       ...(this.options.description && {
diff --git a/lib/tag.ts b/lib/tag.ts
@@ -1,10 +1,10 @@
 import { Construct } from 'constructs';
-import type { OpenAPIV3_1 } from 'openapi-types';
+import type { oas31 } from 'openapi3-ts';
 
 interface TagOptions {
   name: string;
   description?: string;
-  externalDocs?: OpenAPIV3_1.ExternalDocumentationObject;
+  externalDocs?: oas31.ExternalDocumentationObject;
 }
 
 export class Tag extends Construct {
@@ -19,7 +19,7 @@ export class Tag extends Construct {
     this.options = options;
   }
 
-  public synth(): OpenAPIV3_1.TagObject {
+  public synth(): oas31.TagObject {
     return this.options;
   }
 }
diff --git a/package.json b/package.json
@@ -20,7 +20,6 @@
     "preversion": "make test"
   },
   "dependencies": {
-    "openapi-types": "^12.1.3",
     "yaml": "^2.5.1"
   },
   "devDependencies": {
@@ -43,15 +42,11 @@
     "vitest": "^2.1.2"
   },
   "peerDependencies": {
-    "constructs": "^10.4.1"
+    "constructs": "^10.4.1",
+    "openapi3-ts": "^4.4.0"
   },
   "engines": {
     "node": ">=20.0.0"
   },
-  "pnpm": {
-    "patchedDependencies": {
-      "openapi-types": "patches/openapi-types.patch"
-    }
-  },
   "packageManager": "pnpm@9.12.1+sha512.e5a7e52a4183a02d5931057f7a0dbff9d5e9ce3161e33fa68ae392125b79282a8a8a470a51dfc8a0ed86221442eb2fb57019b0990ed24fab519bf0e1bc5ccfc4"
 }
diff --git a/patches/openapi-types.patch b/patches/openapi-types.patch
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`import { Construct } from 'constructs';`
`2`		`-import type { OpenAPIV3_1 } from 'openapi-types';`
	`2`	`+import type { oas31 } from 'openapi3-ts';`
`3`	`3`	`import type { HttpMethods } from './http-methods.js';`
`4`	`4`	`import type { Parameter } from './parameter.js';`
`5`	`5`	`import { RequestBody, type RequestBodyOptions } from './request-body.js';`
`@@ -92,6 +92,6 @@ export class Operation<TPath extends string = '/'> extends Construct {`
`92`	`92`	`]),`
`93`	`93`	`),`
`94`	`94`	`}),`
`95`		`- } satisfies OpenAPIV3_1.OperationObject;`
	`95`	`+ } satisfies oas31.OperationObject;`
`96`	`96`	`}`
`97`	`97`	`}`