feat: make @octokit/openapi-webhooks ESM (#109)

* feat: make `@octokit/openapi-webhooks` ESM

BREAKING CHANGE: The schema package is now ESM only
BREAKING CHANGE: Require Node v18.20+ or >= 20.10 due to import attributes

* fix: return `.default` and not the whole import

Author: wolfy1339

packages/openapi-webhooks/index.js

@@ -1,12 +1,25 @@
-module.exports = {
-  schemas: {
-    ["api.github.com"]: require("./generated/api.github.com.json"),
-    ["ghec"]: require("./generated/ghec.json"),
-    ["ghes-3.10"]: require("./generated/ghes-3.10.json"),
-    ["ghes-3.11"]: require("./generated/ghes-3.11.json"),
-    ["ghes-3.12"]: require("./generated/ghes-3.12.json"),
-    ["ghes-3.13"]: require("./generated/ghes-3.13.json"),
-    ["ghes-3.14"]: require("./generated/ghes-3.14.json"),
-    ["ghes-3.15"]: require("./generated/ghes-3.15.json"),
-  },
+export const schemas = {
+  ["api.github.com"]: (
+    await import("./generated/api.github.com.json", { with: { type: "json" } })
+  ).default,
+  ["ghec"]: (await import("./generated/ghec.json", { with: { type: "json" } }))
+    .default,
+  ["ghes-3.10"]: (
+    await import("./generated/ghes-3.10.json", { with: { type: "json" } })
+  ).default,
+  ["ghes-3.11"]: (
+    await import("./generated/ghes-3.11.json", { with: { type: "json" } })
+  ).default,
+  ["ghes-3.12"]: (
+    await import("./generated/ghes-3.12.json", { with: { type: "json" } })
+  ).default,
+  ["ghes-3.13"]: (
+    await import("./generated/ghes-3.13.json", { with: { type: "json" } })
+  ).default,
+  ["ghes-3.14"]: (
+    await import("./generated/ghes-3.14.json", { with: { type: "json" } })
+  ).default,
+  ["ghes-3.15"]: (
+    await import("./generated/ghes-3.15.json", { with: { type: "json" } })
+  ).default,
 };

packages/openapi-webhooks/package.json

@@ -7,7 +7,7 @@
     "generated/*",
     "index.js"
   ],
-  "type": "commonjs",
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/octokit/openapi-webhooks.git",
@@ -24,5 +24,8 @@
   "publishConfig": {
     "access": "public",
     "provenance": true
+  },
+  "engines": {
+    "node": "^18.20.0 || >= 20.10.0"
   }
 }

packages/openapi-webhooks/types.d.ts

@@ -0,0 +1,10 @@
+export declare const schemas: {
+  "api.github.com": Record<string, unknown>;
+  ghec: Record<string, unknown>;
+  "ghes-3.10": Record<string, unknown>;
+  "ghes-3.11": Record<string, unknown>;
+  "ghes-3.12": Record<string, unknown>;
+  "ghes-3.13": Record<string, unknown>;
+  "ghes-3.14": Record<string, unknown>;
+  "ghes-3.15": Record<string, unknown>;
+};

scripts/build.js

@@ -128,12 +128,17 @@ async function run() {
   }
 
   let schemasCode = "";
+  let schemasTypes = "";
 
   for (const name of schemaFileNames) {
     schemasCode += `["${name.replace(
       ".json",
       "",
-    )}"]: require("./generated/${name}"),`;
+    )}"]: (await import("./generated/${name}", { with: { type: "json" } })).default,`;
+    schemasTypes += `"${name.replace(
+      ".json",
+      "",
+    )}": Record<string, unknown>;`;
   }
 
   writeFileSync(
@@ -149,17 +154,26 @@ They are all generated, your changes would be overwritten with the next update.
     "packages/openapi-webhooks/index.js",
     await prettier.format(
       `
-      module.exports = {
-        schemas: {
-          ${schemasCode}
-        }
+      export const schemas = {
+        ${schemasCode}
       }
     `,
       {
         parser: "babel",
       },
     ),
   );
+  writeFileSync(`packages/openapi-webhooks/types.d.ts`, await prettier.format(
+    `
+    export declare const schemas: {
+      ${schemasTypes}
+    }
+    `,
+    {
+      parser: "typescript",
+    },
+  )
+  );
   writeFileSync(
     `packages/openapi-webhooks/package.json`,
     await prettier.format(
@@ -170,7 +184,7 @@ They are all generated, your changes would be overwritten with the next update.
           "GitHub's official Webhooks OpenAPI spec with Octokit extensions",
         main: "index.js",
         files: ["generated/*", "index.js"],
-        type: "commonjs",
+        type: "module",
         repository: {
           type: "git",
           url: "git+https://github.com/octokit/openapi-webhooks.git",
@@ -183,6 +197,9 @@ They are all generated, your changes would be overwritten with the next update.
           access: "public",
           provenance: true,
         },
+        engines: {
+          node: "^18.20.0 || >= 20.10.0",
+        }
       }),
       { parser: "json-stringify" },
     ),

scripts/download.js

@@ -1,5 +1,5 @@
-import { get } from "https";
-import fs from "fs";
+import { get } from "node:https";
+import fs from "node:fs";
 
 import { Octokit } from "@octokit/core";
 import { getCurrentVersions } from "github-enterprise-server-versions";

scripts/overrides/index.js

@@ -1,6 +1,6 @@
-import { readFileSync } from "fs";
-import { resolve, join, dirname } from "path";
-import { fileURLToPath } from "url";
+import { readFileSync } from "node:fs";
+import { resolve, join, dirname } from "node:path";
+import { fileURLToPath } from "node:url";
 
 const SUPPORTED_GHES_OPERATIONS = [
   "3.10",