Can't get probot/@octokit/rest/plugin-rest-endpoint-methods to compile

[bcoe]

There seems to be an incompatibility between @octokit/rest, probot, and plugin-rest-endpoint-methods, such that I cannot get the modules to compile together:

node_modules/@octokit/rest/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts:1801:60 - error TS2339: Property 'POST /repos/{owner}/{repo}/forks{?org,organization}' does not exist on type 'Endpoints'.

1801             parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/forks{?org,organization}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
                                                                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

node_modules/@octokit/rest/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts:1802:33 - error TS2339: Property 'POST /repos/{owner}/{repo}/forks{?org,organization}' does not exist on type 'Endpoints'.

1802             response: Endpoints["POST /repos/{owner}/{repo}/forks{?org,organization}"]["response"];
                                     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

node_modules/probot/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts:1801:60 - error TS2339: Property 'POST /repos/{owner}/{repo}/forks{?org,organization}' does not exist on type 'Endpoints'.

1801             parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/forks{?org,organization}"]["parameters"], "baseUrl" | "headers" | "mediaType">;
                                                                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

node_modules/probot/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts:1802:33 - error TS2339: Property 'POST /repos/{owner}/{repo}/forks{?org,organization}' does not exist on type 'Endpoints'.

1802             response: Endpoints["POST /repos/{owner}/{repo}/forks{?org,organization}"]["response"];

I can't seem to figure out an approach to make them play nice together.

Refs: googleapis/repo-automation-bots#1660

[gr2m]

make sure you have the latest version of @octokit/types (v6.13.1)

[el7cosmos]

@gr2m updating to v6.13.1 causes this problem. I believe this commit causes the problem https://github.com/octokit/types.ts/pull/297/files?file-filters%5B%5D=.ts#diff-6e34f3ccc1fd41b44cec74317606475053c89f3ffe0133356443861f5e7f1150L4361

This happened in v4.15.0

[gr2m]

The commit is correct, but it is the cause of the problem here. The {?org,organization} query parameters should have never slipped into GitHub's OpenAPI spec, they are considered legacy for years now. This has now been corrected, hence the reverting commit on this route. This should not have happened, sorry for the friction.

I am able to reproduce the error. I'm looking into it.

[gr2m]

@ocotkit/rest needs to be updated, somehow the automation failed me on this, I'm fixing it now.

[gr2m]

incoming: #46

The problem here is that strictly speaking the change @el7cosmos mentioned above is a breaking change. But it was a bug that was introduced by accident, and the friction to create a breaking version just because of this outweights the alternative by an order of magnitude.

The problem is that theversion of @octokit/types is not pinned, so you get the latest version when you do a fresh install of @octokit/rest. The version of @octokit/plugin-rest-api-endpoints on the other hand is pinned, so unless you update to the latest version of @octokit/rest (coming in a minute) you will see the above error.

Because it's a build error for typescript users only, not a problem you'd see in production, we don't consider it a breaking change.

[github-actions]

🎉 This issue has been resolved in version 18.5.3 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

[gr2m]

can you confirm that the problem is resolved for you?

[el7cosmos]

@gr2m thanks for the quick response, I can't confirm resolution as my problem lies in @actions/github that depends on @octokit/plugin-rest-endpoint-methods: ^4.0.0 so I can't update to ^5

[gr2m]

my problem lies in @actions/github

I do not maintain that package and can't help with that I'm afraid