feat(esm): move to ESM for compatibility and get latest openapi-typescript

Author: djMax

.gitignore

@@ -31,3 +31,5 @@ jest.config.js
 .eslintrc.js
 .commitlintrc.json
 vitest.config.ts
+.eslintrc.cjs
+.prettierrc.cjs

__tests__/__snapshots__/index.spec.ts.snap

@@ -247,6 +247,8 @@ export interface components {
   pathItems: never;
 }
 
+export type $defs = Record<string, never>;
+
 export type external = Record<string, never>;
 
 export interface operations {
@@ -273,11 +275,17 @@ export interface operations {
         };
       };
       /** @description Invalid ID supplied */
-      400: never;
+      400: {
+        content: never;
+      };
       /** @description Pet not found */
-      404: never;
+      404: {
+        content: never;
+      };
       /** @description Validation exception */
-      405: never;
+      405: {
+        content: never;
+      };
     };
   };
   /**
@@ -302,7 +310,9 @@ export interface operations {
         };
       };
       /** @description Invalid input */
-      405: never;
+      405: {
+        content: never;
+      };
     };
   };
   /**
@@ -325,7 +335,9 @@ export interface operations {
         };
       };
       /** @description Invalid status value */
-      400: never;
+      400: {
+        content: never;
+      };
     };
   };
   /**
@@ -348,7 +360,9 @@ export interface operations {
         };
       };
       /** @description Invalid tag value */
-      400: never;
+      400: {
+        content: never;
+      };
     };
   };
   /**
@@ -371,9 +385,13 @@ export interface operations {
         };
       };
       /** @description Invalid ID supplied */
-      400: never;
+      400: {
+        content: never;
+      };
       /** @description Pet not found */
-      404: never;
+      404: {
+        content: never;
+      };
     };
   };
   /** Updates a pet in the store with form data */
@@ -392,7 +410,9 @@ export interface operations {
     };
     responses: {
       /** @description Invalid input */
-      405: never;
+      405: {
+        content: never;
+      };
     };
   };
   /** Deletes a pet */
@@ -408,7 +428,9 @@ export interface operations {
     };
     responses: {
       /** @description Invalid pet value */
-      400: never;
+      400: {
+        content: never;
+      };
     };
   };
   /** uploads an image */
@@ -447,7 +469,7 @@ export interface operations {
       200: {
         content: {
           \\"application/json\\": {
-            [key: string]: number | undefined;
+            [key: string]: number;
           };
         };
       };
@@ -473,7 +495,9 @@ export interface operations {
         };
       };
       /** @description Invalid input */
-      405: never;
+      405: {
+        content: never;
+      };
     };
   };
   /**
@@ -496,9 +520,13 @@ export interface operations {
         };
       };
       /** @description Invalid ID supplied */
-      400: never;
+      400: {
+        content: never;
+      };
       /** @description Order not found */
-      404: never;
+      404: {
+        content: never;
+      };
     };
   };
   /**
@@ -514,9 +542,13 @@ export interface operations {
     };
     responses: {
       /** @description Invalid ID supplied */
-      400: never;
+      400: {
+        content: never;
+      };
       /** @description Order not found */
-      404: never;
+      404: {
+        content: never;
+      };
     };
   };
   /**
@@ -561,7 +593,9 @@ export interface operations {
         };
       };
       /** @description successful operation */
-      default: never;
+      default: {
+        content: never;
+      };
     };
   };
   /** Logs user into the system */
@@ -589,14 +623,18 @@ export interface operations {
         };
       };
       /** @description Invalid username/password supplied */
-      400: never;
+      400: {
+        content: never;
+      };
     };
   };
   /** Logs out current logged in user session */
   logoutUser: {
     responses: {
       /** @description successful operation */
-      default: never;
+      default: {
+        content: never;
+      };
     };
   };
   /** Get user by user name */
@@ -616,9 +654,13 @@ export interface operations {
         };
       };
       /** @description Invalid username supplied */
-      400: never;
+      400: {
+        content: never;
+      };
       /** @description User not found */
-      404: never;
+      404: {
+        content: never;
+      };
     };
   };
   /**
@@ -642,7 +684,9 @@ export interface operations {
     };
     responses: {
       /** @description successful operation */
-      default: never;
+      default: {
+        content: never;
+      };
     };
   };
   /**
@@ -658,9 +702,13 @@ export interface operations {
     };
     responses: {
       /** @description Invalid username supplied */
-      400: never;
+      400: {
+        content: never;
+      };
       /** @description User not found */
-      404: never;
+      404: {
+        content: never;
+      };
     };
   };
 }

__tests__/index.spec.ts

@@ -2,7 +2,7 @@ import path from 'path';
 
 import { expect, test } from 'vitest';
 
-import { generate } from '../src/index';
+import { generate } from '../src/index.js';
 
 test('should generate a matching document', async () => {
   const types = await generate(path.resolve(__dirname, 'petstore.json'), {});

package.json

@@ -4,6 +4,7 @@
   "description": "A version of openapi-typescript that also generates enumerations",
   "main": "build/index.js",
   "types": "build/index.d.ts",
+  "type": "module",
   "bin": "build/bin/index.js",
   "author": "Max Metral <[email protected]>",
   "license": "MIT",
@@ -41,23 +42,23 @@
     "access": "public"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.6.7",
-    "@commitlint/config-conventional": "^17.6.7",
-    "@openapi-typescript-infra/coconfig": "^3.3.6",
+    "@commitlint/cli": "^17.7.1",
+    "@commitlint/config-conventional": "^17.7.0",
+    "@openapi-typescript-infra/coconfig": "^4.2.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@types/yargs-parser": "^21.0.0",
-    "@typescript-eslint/eslint-plugin": "^6.2.1",
-    "@typescript-eslint/parser": "^6.2.1",
+    "@typescript-eslint/eslint-plugin": "^6.7.2",
+    "@typescript-eslint/parser": "^6.7.2",
     "coconfig": "^0.13.3",
-    "eslint": "^8.46.0",
-    "eslint-config-prettier": "^8.10.0",
-    "eslint-plugin-import": "^2.28.0",
-    "prettier": "^3.0.1",
+    "eslint": "^8.49.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.28.1",
+    "prettier": "^3.0.3",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.6",
-    "vitest": "^0.34.1"
+    "typescript": "^5.2.2",
+    "vitest": "^0.34.4"
   },
   "scripts": {
     "test": "tsc -p tsconfig.test.json --noEmit && vitest",
@@ -71,7 +72,7 @@
   },
   "dependencies": {
     "ansi-colors": "^4.1.3",
-    "openapi-typescript": "6.3.9",
+    "openapi-typescript": "6.6.1",
     "yargs-parser": "^21.1.1"
   }
 }

src/bin/index.ts

@@ -7,10 +7,9 @@ import glob from 'fast-glob';
 // eslint-disable-next-line import/order -- what the actual heck, this rule bounces
 import parser from 'yargs-parser';
 
-// @ts-expect-error ESM is a threat to humanity
 import type { OpenAPITSOptions } from 'openapi-typescript';
 
-import { generate } from '../index';
+import { generate } from '../index.js';
 
 /** print error message */
 export function error(msg: string) {

src/index.ts

@@ -1,4 +1,3 @@
-// @ts-expect-error ESM is a threat to humanity. Once OATS exposes a working CJS, use it
 import type { OpenAPITSOptions } from 'openapi-typescript';
 
 function getEnumTitle(path: string) {