Compile error regarding rest endpoint method types

[karmann-dm]

I am trying to compile the GH integration code with the following dependencies:

"dependencies": {
    "@octokit/types": "^6.37.0",
    "@octokit/rest": "^18.12.0",
    "@octokit/plugin-paginate-rest": "^2.19.0",
    "@octokit/plugin-rest-endpoint-methods": "^5.15.0"
  },
  "devDependencies": {
    "eslint": "^7.8.1",
    "typescript": "^3.9.7",
    "@zeit/ncc": "^0.22.3"
  }

NodeJS version 14.19.1, npm version 6.14.16

What happened?
An error is thrown on the compile stage

> tsc

node_modules/@octokit/rest/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts:437:60 - error TS2339: Property 'POST /content_references/{content_reference_id}/attachments' does not exist on type 'Endpoints'.

437             parameters: RequestParameters & Omit<Endpoints["POST /content_references/{content_reference_id}/attachments"]["parameters"], "baseUrl" | "headers" | "mediaType">;
                                                               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

node_modules/@octokit/rest/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts:438:33 - error TS2339: Property 'POST /content_references/{content_reference_id}/attachments' does not exist on type 'Endpoints'.

438             response: Endpoints["POST /content_references/{content_reference_id}/attachments"]["response"];
                                    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

node_modules/@octokit/rest/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts:441:60 - error TS2339: Property 'POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments' does not exist on type 'Endpoints'.

441             parameters: RequestParameters & Omit<Endpoints["POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments"]["parameters"], "baseUrl" | "headers" | "mediaType">;
                                                               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

node_modules/@octokit/rest/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts:442:33 - error TS2339: Property 'POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments' does not exist on type 'Endpoints'.

442             response: Endpoints["POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments"]["response"];
                                    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


Found 4 errors.

What did you expect to happen?

Compilation without errors.

What the problem might be

I suspect that it is somehow related to this issue, but I have version that were issued much lated than the ones described in the fix of this issue.

[wolfy1339]

Can you please share your tsconfig.json as well? Also, can you share a snippet of code that reproduces the problem?

[timrogers]

Could you also check what version of @octokit/plugin-rest-endpoint-methods is in node_modules/@octokit/rest/node_modules/@octokit/plugin-rest-endpoint-methods by checking node_modules/@octokit/rest/node_modules/@octokit/plugin-rest-endpoint-methods/package.json? Judging by the error, I think it isn't the current version (v5.15.0).

[karmann-dm]

@timrogers

Could you also check what version of @octokit/plugin-rest-endpoint-methods

Yes, seems like, do you have an idea how to fix it?

$ cat node_modules/@octokit/rest/node_modules/@octokit/plugin-rest-endpoint-methods/package.json | grep \"version\":
  "version": "5.13.0"

[timrogers]

@timrogers

Could you also check what version of @octokit/plugin-rest-endpoint-methods

Yes, seems like, do you have an idea how to fix it?

$ cat node_modules/@octokit/rest/node_modules/@octokit/plugin-rest-endpoint-methods/package.json | grep \"version\":
  "version": "5.13.0"

Interesting! I wonder if we need to update the dependency defined on @octokit/rest. The links between all of these packages are pretty tricky to understand.

@gr2m Can you point us in the right direction?

[karmann-dm]

@wolfy1339

Can you please share your tsconfig.json as well? Also, can you share a snippet of code that reproduces the problem?

tsconfig.json

{
  "compilerOptions": {
    "target": "es2019",
    "module": "commonjs",
    "outDir": "./lib",
    "rootDir": "./src",
    "strict": true,
    "noImplicitAny": true,
    "esModuleInterop": true,
    "strictPropertyInitialization": false
  },
  "exclude": ["node_modules"]
}

About the snippet - there is nothing special, basically if I import

import { RestEndpointMethodTypes } from "@octokit/plugin-rest-endpoint-methods"

problem starts to appear.

In my case I just do this

export type CreatePullRequestParameters =
  RestEndpointMethodTypes["pulls"]["create"]["parameters"]

[gr2m]

The POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments endpoint has been removed, it no longer exists. This is an edge case, it happens very rarely. You likely have the latest version of @octokit/openapi-types, but not the latest version of @octokit/plugin-rest-endpoint-methods.

Try to delete the node_modules folder and whatever lock file you use (usually package-lock.json). Then run npm install again, that should fix it

[a-tarasyuk]

TypeScript uses the latest version of @octokit/rest., today I noticed that the CI build failed due to the following errors

Error: node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts(903,48): error TS2344: Type '"/orgs/{org_id}/codespaces"' does not satisfy the constraint 'keyof paths'.
Error: node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts(1612,70): error TS2344: Type '"/repos/{owner}/{repo}/community/code_of_conduct"' does not satisfy the constraint 'keyof paths'.
Error: node_modules/@octokit/plugin-paginate-rest/dist-types/generated/paginating-endpoints.d.ts(226,74): error TS2339: Property 'data' does not exist on type 'unknown'.

I'm not sure if this is related to this issue or should I create a new one?

[timrogers]

@a-tarasyuk Can you try updating all of the Octokit packages? I think you'll find this is fixed now.

[a-tarasyuk]

It uses the latest version. Has it been updated recently?

"@octokit/rest": "latest",

[timrogers]

Yep! I have just released updates to several Octokit packages. Can you tell me the versions of all of your Octokit-related packages in your lock file?

[a-tarasyuk]

@timrogers Thanks. The latest version seems to work fine.

[timrogers]

Great - sorry about that! The packages have complicated dependencies and some of them still needed updates.