feat: v13 (#967)

BREAKING CHANGE: use GitHub's OpenAPI spec
BREAKING CHANGE: Output ESM instead of CJS

Author: wolfy1339

README.md

@@ -10,11 +10,13 @@ const config: Config.InitialOptions = {
       lines: 100,
     },
   },
+  extensionsToTreatAsEsm: ['.ts'],
   transform: {
     "^.+\\.tsx?$": [
       "ts-jest",
       {
         tsconfig: "test/tsconfig.json",
+        useESM: true,
       },
     ],
   },
@@ -27,5 +29,4 @@ const config: Config.InitialOptions = {
   testRegex: /test\/.*\/.*.test.ts/u.source,
 };
 
-// We have to use a CommonJS export here due to `verbatimModuleSyntax`
-module.exports = config;
+export default config;

jest.config.ts

@@ -1,6 +1,7 @@
 {
   "name": "@octokit/webhooks",
   "version": "0.0.0-development",
+  "type": "module",
   "description": "GitHub webhook events toolset for Node.js",
   "keywords": [],
   "repository": "github:octokit/webhooks.js",
@@ -9,11 +10,11 @@
   "scripts": {
     "build": "node scripts/build.mjs && tsc -p tsconfig.json",
     "coverage": "jest --coverage && open coverage/lcov-report/index.html",
-    "generate-types": "ts-node --transpile-only scripts/generate-types.ts",
+    "generate-types": "node --loader=ts-node/esm scripts/generate-types.ts",
     "lint": "prettier --check 'src/**/*.{ts,json}' 'scripts/**/*' 'test/**/*.ts' README.md package.json",
     "lint:fix": "prettier --write 'src/**/*.{ts,json}' 'scripts/**/*' 'test/**/*.ts' README.md package.json",
     "pretest": "npm run -s lint",
-    "test": "jest --coverage",
+    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest --coverage",
     "validate:ts": "tsc --noEmit --noImplicitAny --target es2020 --esModuleInterop --moduleResolution node16 --module node16 --allowImportingTsExtensions test/typescript-validate.ts"
   },
   "prettier": {},
@@ -40,19 +41,17 @@
     ]
   },
   "dependencies": {
-    "@octokit/request-error": "^5.0.0",
-    "@octokit/webhooks-methods": "^4.1.0",
-    "@octokit/webhooks-types": "7.3.2",
-    "aggregate-error": "^3.1.0"
+    "@octokit/openapi-webhooks-types": "5.3.2",
+    "@octokit/request-error": "^6.0.1",
+    "@octokit/webhooks-methods": "^5.0.0",
+    "aggregate-error": "^5.0.0"
   },
   "devDependencies": {
     "@jest/types": "^29.0.0",
-    "@octokit/tsconfig": "^2.0.0",
-    "@octokit/webhooks-schemas": "7.3.2",
+    "@octokit/openapi-webhooks": "5.3.2",
+    "@octokit/tsconfig": "^3.0.0",
     "@types/jest": "^29.0.0",
-    "@types/json-schema": "^7.0.7",
     "@types/node": "^20.0.0",
-    "@types/prettier": "^2.0.0",
     "axios": "^1.0.0",
     "esbuild": "^0.20.0",
     "express": "^4.17.1",

package-lock.json

@@ -43,7 +43,7 @@ async function main() {
       bundle: true,
       platform: "node",
       target: "node18",
-      format: "cjs",
+      format: "esm",
       ...sharedOptions,
     }),
     // Build an ESM browser bundle