[BUG]: Typerror in app.webhooks.on

[corsin-ragettli]

What happened?

This code will produce an error in typescript:

import { App } from "octokit";
import type {
  PullRequestClosedEvent,
} from "@octokit/webhooks-types";

const app = new App({
  appId: GH_APP_ID,
  privateKey: GH_PRIVATE_KEY
})

function handlePullRequestClosed(payload: PullRequestClosedEvent) {}

app.webhooks.on("pull_request.closed", ({ payload }) =>
  handleClosedPullRequest(payload)
);

The following error will be thrown:

Argument of type '{ action: "closed"; installation?: { id: number; node_id: string; } | undefined; number: number; organization?: { login: string; id: number; node_id: string; url: string; repos_url: string; events_url: string; ... 5 more ...; description: string | null; } | undefined; pull_request: { ...; } & { ...; }; repository: {...' is not assignable to parameter of type 'PullRequestClosedEvent'.
  Types of property 'pull_request' are incompatible.
    Type '{ url: string; id: number; node_id: string; html_url: string; diff_url: string; patch_url: string; issue_url: string; commits_url: string; review_comments_url: string; review_comment_url: string; ... 37 more ...; changed_files: number; } & { ...; }' is not assignable to type 'PullRequest & { state: "closed"; closed_at: string; merged: boolean; }'.
      Type '{ url: string; id: number; node_id: string; html_url: string; diff_url: string; patch_url: string; issue_url: string; commits_url: string; review_comments_url: string; review_comment_url: string; ... 37 more ...; changed_files: number; } & { ...; }' is not assignable to type 'PullRequest'.
        The types of 'user.name' are incompatible between these types.
          Type 'string | null | undefined' is not assignable to type 'string | undefined'.
            Type 'null' is not assignable to type 'string | undefined'.ts(2345)

Please remove the null type from the user.name union, or make the types otherwise compatible

Versions

Oktokit.js 4.0.2, Node v20.18.0, Typescript 5.6.3, @octokit/webhook-types 7.6.1

Relevant log output

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[github-actions]

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

[wolfy1339]

Hi, this is an error with your code.

You are using the wrong types. The types you are using is not compatible with the version of Octokit you are running.

You need to use the @octokit/openapi-webhooks-types package.