fix: add override for mileston.closed event

wolfy1339 · wolfy1339 · commit e94f7bf1e7c6 · 2023-11-19T15:46:15.000-05:00
diff --git a/package.json b/package.json
@@ -12,8 +12,8 @@
     "test": "node scripts/test.js",
     "generate-types": "node scripts/generate-types",
     "update-package": "node scripts/update-package",
-    "lint": "prettier --check '*.{md,json}' 'scripts/*.js' 'packages/**/*.{ts,md,json,d.ts}'",
-    "lint:fix": "prettier --write '*.{md,json}' 'scripts/*.js' 'packages/**/*.{ts,md,json,d.ts}'"
+    "lint": "prettier --check '*.{md,json}' 'scripts/**/*.{js,json}' 'packages/**/*.{ts,md,json,d.ts}'",
+    "lint:fix": "prettier --write '*.{md,json}' 'scripts/**/*.{js,json}' 'packages/**/*.{ts,md,json,d.ts}'"
   },
   "repository": "github:wolfy1339/openapi-webhooks",
   "keywords": [
diff --git a/packages/openapi-webhooks-types-ghec/types.d.ts b/packages/openapi-webhooks-types-ghec/types.d.ts
@@ -24216,7 +24216,7 @@ export interface components {
        */
       milestone: {
         /** Format: date-time */
-        closed_at: string | null;
+        closed_at: string;
         closed_issues: number;
         /** Format: date-time */
         created_at: string;
@@ -24273,7 +24273,7 @@ export interface components {
          * @description The state of the milestone.
          * @enum {string}
          */
-        state: "open" | "closed";
+        state: "closed";
         /** @description The title of the milestone. */
         title: string;
         /** Format: date-time */
diff --git a/packages/openapi-webhooks-types-ghes-3.10/types.d.ts b/packages/openapi-webhooks-types-ghes-3.10/types.d.ts
@@ -23402,7 +23402,7 @@ export interface components {
        */
       milestone: {
         /** Format: date-time */
-        closed_at: string | null;
+        closed_at: string;
         closed_issues: number;
         /** Format: date-time */
         created_at: string;
@@ -23459,7 +23459,7 @@ export interface components {
          * @description The state of the milestone.
          * @enum {string}
          */
-        state: "open" | "closed";
+        state: "closed";
         /** @description The title of the milestone. */
         title: string;
         /** Format: date-time */
diff --git a/packages/openapi-webhooks-types-ghes-3.11/types.d.ts b/packages/openapi-webhooks-types-ghes-3.11/types.d.ts
@@ -23478,7 +23478,7 @@ export interface components {
        */
       milestone: {
         /** Format: date-time */
-        closed_at: string | null;
+        closed_at: string;
         closed_issues: number;
         /** Format: date-time */
         created_at: string;
@@ -23535,7 +23535,7 @@ export interface components {
          * @description The state of the milestone.
          * @enum {string}
          */
-        state: "open" | "closed";
+        state: "closed";
         /** @description The title of the milestone. */
         title: string;
         /** Format: date-time */
diff --git a/packages/openapi-webhooks-types-ghes-3.8/types.d.ts b/packages/openapi-webhooks-types-ghes-3.8/types.d.ts
@@ -22565,7 +22565,7 @@ export interface components {
        */
       milestone: {
         /** Format: date-time */
-        closed_at: string | null;
+        closed_at: string;
         closed_issues: number;
         /** Format: date-time */
         created_at: string;
@@ -22622,7 +22622,7 @@ export interface components {
          * @description The state of the milestone.
          * @enum {string}
          */
-        state: "open" | "closed";
+        state: "closed";
         /** @description The title of the milestone. */
         title: string;
         /** Format: date-time */
diff --git a/packages/openapi-webhooks-types-ghes-3.9/types.d.ts b/packages/openapi-webhooks-types-ghes-3.9/types.d.ts
@@ -22698,7 +22698,7 @@ export interface components {
        */
       milestone: {
         /** Format: date-time */
-        closed_at: string | null;
+        closed_at: string;
         closed_issues: number;
         /** Format: date-time */
         created_at: string;
@@ -22755,7 +22755,7 @@ export interface components {
          * @description The state of the milestone.
          * @enum {string}
          */
-        state: "open" | "closed";
+        state: "closed";
         /** @description The title of the milestone. */
         title: string;
         /** Format: date-time */
diff --git a/packages/openapi-webhooks-types-github.ae/types.d.ts b/packages/openapi-webhooks-types-github.ae/types.d.ts
@@ -23065,7 +23065,7 @@ export interface components {
        */
       milestone: {
         /** Format: date-time */
-        closed_at: string | null;
+        closed_at: string;
         closed_issues: number;
         /** Format: date-time */
         created_at: string;
@@ -23122,7 +23122,7 @@ export interface components {
          * @description The state of the milestone.
          * @enum {string}
          */
-        state: "open" | "closed";
+        state: "closed";
         /** @description The title of the milestone. */
         title: string;
         /** Format: date-time */
diff --git a/packages/openapi-webhooks-types/types.d.ts b/packages/openapi-webhooks-types/types.d.ts
@@ -24075,7 +24075,7 @@ export interface components {
        */
       milestone: {
         /** Format: date-time */
-        closed_at: string | null;
+        closed_at: string;
         closed_issues: number;
         /** Format: date-time */
         created_at: string;
@@ -24132,7 +24132,7 @@ export interface components {
          * @description The state of the milestone.
          * @enum {string}
          */
-        state: "open" | "closed";
+        state: "closed";
         /** @description The title of the milestone. */
         title: string;
         /** Format: date-time */
diff --git a/packages/openapi-webhooks/generated/api.github.com.json b/packages/openapi-webhooks/generated/api.github.com.json
@@ -53389,10 +53389,7 @@
             "description": "A collection of related issues and pull requests.",
             "type": "object",
             "properties": {
-              "closed_at": {
-                "type": ["string", "null"],
-                "format": "date-time"
-              },
+              "closed_at": { "type": ["string"], "format": "date-time" },
               "closed_issues": { "type": "integer" },
               "created_at": { "type": "string", "format": "date-time" },
               "creator": {
@@ -53443,7 +53440,7 @@
               "state": {
                 "description": "The state of the milestone.",
                 "type": "string",
-                "enum": ["open", "closed"]
+                "enum": ["closed"]
               },
               "title": {
                 "description": "The title of the milestone.",
diff --git a/packages/openapi-webhooks/generated/ghec.json b/packages/openapi-webhooks/generated/ghec.json
@@ -53713,10 +53713,7 @@
             "description": "A collection of related issues and pull requests.",
             "type": "object",
             "properties": {
-              "closed_at": {
-                "type": ["string", "null"],
-                "format": "date-time"
-              },
+              "closed_at": { "type": ["string"], "format": "date-time" },
               "closed_issues": { "type": "integer" },
               "created_at": { "type": "string", "format": "date-time" },
               "creator": {
@@ -53767,7 +53764,7 @@
               "state": {
                 "description": "The state of the milestone.",
                 "type": "string",
-                "enum": ["open", "closed"]
+                "enum": ["closed"]
               },
               "title": {
                 "description": "The title of the milestone.",
diff --git a/packages/openapi-webhooks/generated/ghes-3.10.json b/packages/openapi-webhooks/generated/ghes-3.10.json
@@ -53868,10 +53868,7 @@
             "description": "A collection of related issues and pull requests.",
             "type": "object",
             "properties": {
-              "closed_at": {
-                "type": ["string", "null"],
-                "format": "date-time"
-              },
+              "closed_at": { "type": ["string"], "format": "date-time" },
               "closed_issues": { "type": "integer" },
               "created_at": { "type": "string", "format": "date-time" },
               "creator": {
@@ -53922,7 +53919,7 @@
               "state": {
                 "description": "The state of the milestone.",
                 "type": "string",
-                "enum": ["open", "closed"]
+                "enum": ["closed"]
               },
               "title": {
                 "description": "The title of the milestone.",
diff --git a/packages/openapi-webhooks/generated/ghes-3.11.json b/packages/openapi-webhooks/generated/ghes-3.11.json
@@ -54313,10 +54313,7 @@
             "description": "A collection of related issues and pull requests.",
             "type": "object",
             "properties": {
-              "closed_at": {
-                "type": ["string", "null"],
-                "format": "date-time"
-              },
+              "closed_at": { "type": ["string"], "format": "date-time" },
               "closed_issues": { "type": "integer" },
               "created_at": { "type": "string", "format": "date-time" },
               "creator": {
@@ -54367,7 +54364,7 @@
               "state": {
                 "description": "The state of the milestone.",
                 "type": "string",
-                "enum": ["open", "closed"]
+                "enum": ["closed"]
               },
               "title": {
                 "description": "The title of the milestone.",
diff --git a/packages/openapi-webhooks/generated/ghes-3.8.json b/packages/openapi-webhooks/generated/ghes-3.8.json
@@ -51433,10 +51433,7 @@
             "description": "A collection of related issues and pull requests.",
             "type": "object",
             "properties": {
-              "closed_at": {
-                "type": ["string", "null"],
-                "format": "date-time"
-              },
+              "closed_at": { "type": ["string"], "format": "date-time" },
               "closed_issues": { "type": "integer" },
               "created_at": { "type": "string", "format": "date-time" },
               "creator": {
@@ -51487,7 +51484,7 @@
               "state": {
                 "description": "The state of the milestone.",
                 "type": "string",
-                "enum": ["open", "closed"]
+                "enum": ["closed"]
               },
               "title": {
                 "description": "The title of the milestone.",
diff --git a/packages/openapi-webhooks/generated/ghes-3.9.json b/packages/openapi-webhooks/generated/ghes-3.9.json
@@ -52181,10 +52181,7 @@
             "description": "A collection of related issues and pull requests.",
             "type": "object",
             "properties": {
-              "closed_at": {
-                "type": ["string", "null"],
-                "format": "date-time"
-              },
+              "closed_at": { "type": ["string"], "format": "date-time" },
               "closed_issues": { "type": "integer" },
               "created_at": { "type": "string", "format": "date-time" },
               "creator": {
@@ -52235,7 +52232,7 @@
               "state": {
                 "description": "The state of the milestone.",
                 "type": "string",
-                "enum": ["open", "closed"]
+                "enum": ["closed"]
               },
               "title": {
                 "description": "The title of the milestone.",
diff --git a/packages/openapi-webhooks/generated/github.ae.json b/packages/openapi-webhooks/generated/github.ae.json
@@ -48855,10 +48855,7 @@
             "description": "A collection of related issues and pull requests.",
             "type": "object",
             "properties": {
-              "closed_at": {
-                "type": ["string", "null"],
-                "format": "date-time"
-              },
+              "closed_at": { "type": ["string"], "format": "date-time" },
               "closed_issues": { "type": "integer" },
               "created_at": { "type": "string", "format": "date-time" },
               "creator": {
@@ -48909,7 +48906,7 @@
               "state": {
                 "description": "The state of the milestone.",
                 "type": "string",
-                "enum": ["open", "closed"]
+                "enum": ["closed"]
               },
               "title": {
                 "description": "The title of the milestone.",
diff --git a/packages/openapi-webhooks/package.json b/packages/openapi-webhooks/package.json
@@ -10,7 +10,7 @@
   "type": "commonjs",
   "repository": {
     "type": "git",
-    "url": "https://github.com/wolfy1330/openapi-webhooks.git",
+    "url": "https://github.com/wolfy1339/openapi-webhooks.git",
     "directory": "packages/openapi-webhooks"
   },
   "keywords": [
diff --git a/scripts/build.js b/scripts/build.js
@@ -6,6 +6,7 @@ import {
   copyFileSync,
 } from "node:fs";
 import * as prettier from "prettier";
+import overrides from "./overrides/index.js";
 
 /* if (!process.env.GITHUB_ACTIONS && !process.env.ANICCA_REPOSITORY_PATH) {
   throw new Error("Please set ANICCA_REPOSITORY_PATH");
@@ -41,6 +42,7 @@ async function run() {
       examples: {},
     };
 
+    overrides(file, schema);
     /**
      *  Function to handle special cases:
      * Check all instances of `$ref` in the OpenAPI spec, and add them to the definitions
@@ -149,7 +151,7 @@ They are all generated, your changes would be overwritten with the next update.
         type: "commonjs",
         repository: {
           type: "git",
-          url: "https://github.com/wolfy1330/openapi-webhooks.git",
+          url: "https://github.com/wolfy1339/openapi-webhooks.git",
           directory: `packages/openapi-webhooks`,
         },
         keywords: ["github", "openapi", "octokit", "webhooks"],
diff --git a/scripts/overrides/index.js b/scripts/overrides/index.js
@@ -5,10 +5,6 @@ import { fileURLToPath } from "url";
 const SUPPORTED_GHES_OPERATIONS = ["3.8", "3.9", "3.10", "3.11"];
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
-function isDeferenced(filename) {
-  return /deref/.test(filename);
-}
-
 // Updates the operation ID for a specific operation. Useful if you want to maintain
 // the function name in `plugin-rest-endpoint-methods.js` when the operation ID has
 // been changed in the OpenAPI specification.
@@ -46,23 +42,38 @@ function addOperation(schema, path, httpMethod, overridePath) {
 // Replaces a given operation using JSON data stored in a file.
 //
 // Throws an error if an operation is not found for the specified path and HTTP method.
-function replaceOperation(schema, path, httpMethod, overridePath) {
-  if (!schema.paths[path]) {
+function replaceOperation(
+  schema,
+  path,
+  httpMethod,
+  overridePath,
+  isWebhook = false,
+) {
+  const type = isWebhook ? "webhook" : "paths";
+
+  if (!schema[type][path]) {
     throw `Path ${path} not found in schema`;
   }
 
-  if (!schema.paths[path][httpMethod]) {
+  if (!schema[type][path][httpMethod]) {
     throw `HTTP method ${httpMethod} not found for path ${path} in schema`;
   }
 
-  schema.paths[path][httpMethod] = JSON.parse(
+  schema[type][path][httpMethod] = JSON.parse(
+    readFileSync(resolve(join(__dirname, overridePath)), "utf8"),
+  );
+}
+
+function replaceSchema(schema, schemaName, overridePath) {
+  schema.components.schemas[schemaName] = JSON.parse(
     readFileSync(resolve(join(__dirname, overridePath)), "utf8"),
   );
 }
 
 export default function overrides(file, schema) {
   const isGHES = file.startsWith("ghes-");
   const isAE = file.startsWith("github.ae");
+  const isGHEC = file.startsWith("ghec");
   const isDotcom = file.startsWith("api.github.com");
   const ghesVersion = isGHES ? file.match(/(?<=^ghes-)\d+\.\d+/)[0] : null;
 
@@ -74,5 +85,17 @@ export default function overrides(file, schema) {
     );
   }
 
-
+  if (isDotcom) {
+    replaceSchema(
+      schema,
+      "webhook-milestone-closed",
+      "./milestone-closed.json",
+    );
+  } else {
+    replaceSchema(
+      schema,
+      "webhook-milestone-closed",
+      "./milestone-closed-ghes.json",
+    );
+  }
 }
diff --git a/scripts/overrides/milestone-closed-ghes.json b/scripts/overrides/milestone-closed-ghes.json
diff --git a/scripts/overrides/milestone-closed.json b/scripts/overrides/milestone-closed.json
