[BUG]: dist-types/index.d.ts is not present in the published NPM package #405

maxnachlinger · 2023-02-20T17:35:13Z

What happened?

Hey awesome maintainers! After upgrading from 4.1.1 to 4.1.2 I noticed the following tsc error:

 error TS7016: Could not find a declaration file for module '@octokit/plugin-retry'. '/some-path-here/node_modules/.pnpm/@octokit+plugin-retry@4.1.2_@octokit+core@4.2.0/node_modules/@octokit/plugin-retry/dist-node/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/octokit__plugin-retry` if it exists or add a new declaration (.d.ts) file containing `declare module '@octokit/plugin-retry';`

2 import { retry } from '@octokit/plugin-retry';

Having a look in the tgz on npm I only see a dist-node directory, but the package.json exports the types in dist-types/index.d.ts

Versions

"@octokit/core": "4.2.0"
"@octokit/plugin-retry": "4.1.2",
"@octokit/rest": "19.0.7",
node 16.19.1

Relevant log output

No response

Code of Conduct

I agree to follow this project's Code of Conduct

The text was updated successfully, but these errors were encountered:

oscard0m · 2023-02-20T17:53:45Z

I started checking this:

Here are two logs comparing a release with types and without types:

Release `4.1.1`

@pika/pack build v0.3.7
[1/6] Validating source...
[2/6] Preparing pipeline...
      ❇️  pkg/
      » tsconfig.json [compilerOptions.target] should be "ES2020", but found "ES2018". You may encounter problems building.
[3/6] Running @pika/plugin-ts-standard-pkg...
      📝  pkg/dist-src/index.js [esnext]
      📝  pkg/dist-types/index.d.ts [types]
      » Linting with standard-pkg...
[4/6] Running @pika/plugin-build-node...
      📝  pkg/dist-node/index.js [main]
[5/6] Running @pika/plugin-build-web...
      📝  pkg/dist-web/index.js [module]
[6/6] Finalizing package...
      » copying LICENSE...
      » copying README.md...
      📝  pkg/package.json
      📦  pkg/

npm notice 📦  @octokit/plugin-retry@4.1.1
npm notice === Tarball Contents === 
npm notice 1.1kB LICENSE                      
npm notice 2.5kB README.md                    
npm notice 2.9kB dist-node/index.js           
npm notice 6.2kB dist-node/index.js.map       
npm notice 677B  dist-src/error-request.js    
npm notice 921B  dist-src/index.js            
npm notice 32B   dist-src/version.js          
npm notice 1.4kB dist-src/wrap-request.js     
npm notice 105B  dist-types/error-request.d.ts
npm notice 401B  dist-types/index.d.ts        
npm notice 40B   dist-types/version.d.ts      
npm notice 91B   dist-types/wrap-request.d.ts 
npm notice 2.9kB dist-web/index.js            
npm notice 6.0kB dist-web/index.js.map        
npm notice 1.2kB package.json

Release `4.1.2`

@pika/pack build v0.3.7
[1/6] Validating source...
[2/6] Preparing pipeline...
      ❇️  pkg/
      » tsconfig.json [compilerOptions.target] should be "ES2020", but found "ES2018". You may encounter problems building.
[3/6] Running @pika/plugin-ts-standard-pkg...
      📝  pkg/dist-src/index.js [esnext]
      📝  pkg/dist-types/index.d.ts [types]
      » Linting with standard-pkg...
[4/6] Running @pika/plugin-build-node...
      📝  pkg/dist-node/index.js [main]
[5/6] Running @pika/plugin-build-web...
      📝  pkg/dist-web/index.js [module]
[6/6] Finalizing package...
      » copying LICENSE...
      » copying README.md...
      📝  pkg/package.json
      📦  pkg/

npm notice 📦  @octokit/plugin-retry@4.1.2
npm notice === Tarball Contents === 
npm notice 1.1kB LICENSE           
npm notice 2.5kB README.md         
npm notice 2.9kB dist-node/index.js
npm notice 1.2kB package.json

Tagging @octokit/js-community @octokit/js just in case somebody knows where the issue could be while I check it.

oscard0m · 2023-02-20T19:14:02Z

Ok, so... the root cause of this issue is the following one, I think:

Apparently, since npm 9 the file pattern matching for npm publish has changed, but nothing was reported in their Changelog (I'm assuming it's an unintended change).

The generated package.json under pkg/ folder after running pika-pack build contains the following:

"files": [
    "dist-*/",
    "bin/"
  ],

The fix would be as easy as adding ** to the file patterns until npm gives a solution to this:

"files": [
    "dist-*/**",
    "bin/**"
  ],

Since these lines are auto-generated and pika-pack is unmaintained, I guess we need to decide what to do here.

I guess the quick solution is to use npm@8 for semantic-release until we find a proper solution for everything.

What do you think @octokit/extensibility-sdks @octokit/js-community?

kfcampbell · 2023-02-27T18:47:34Z

@oscard0m thank you for the investigation here! That's fascinating. I know npm 9 was released in October; I wonder why this is just happening now. Perhaps it's related to a shift in the LTS version in our node setup?

Pinning down a date would help with the solution I think: if we started using npm 9 to release immediately before the issue was reported, a rollback seems appropriate. If we've been using npm 9 since October, rolling back a major version may have additional complications to think about.

wolfy1339 · 2023-02-28T02:43:24Z

We used to explicitly define a requirement on semantic-release in our devDependencies, until a new version of semantic-release broke compatibility with a version of node we were supporting at the time, and I believe that version introduced npm@9

Would we be able to patch the files afterwards pika has built the package before semantic-release publishes a release?

… in "files" You can read more here: #405

oscard0m · 2023-03-02T17:03:39Z

@kfcampbell opened a PR with @wolfy1339 's proposal as a hot fix (with some question marks) and opened a discussion to talk about a strategy for a long-term solution: octokit/octokit.js#2403

… in "files" You can read more here: #405

Ddupasquier · 2023-03-03T22:20:32Z

Thanks for showing me to this issue @wolfy1339. I patiently await updates.

* fix(ci): add hotfix in built package.json to use proper file patterns in "files" You can read more here: #405 * ci(release): run 'scripts/fix-package-json.js' before release

github-actions · 2023-03-03T23:00:25Z

🎉 This issue has been resolved in version 4.1.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

oscard0m · 2023-03-05T09:51:08Z

Here's a comparison of exported files from 4.1.2 and 4.1.3:

Published files in `4.1.2`:

Published files in `4.1.3`:

Ddupasquier · 2023-03-05T11:46:48Z

Omg, if this is actually done I will buy everyone involved a beer.

oscard0m · 2023-04-07T15:59:46Z

@maxnachlinger @Ddupasquier did you have a chance to try this? Did your problems get solved?

maxnachlinger · 2023-04-07T16:06:21Z

@oscard0m forgive me for not circling back. Your dazzling fix solved the issue! :)

oscard0m · 2023-04-07T16:08:19Z

@oscard0m forgive me for not circling back. Your dazzling fix solved the issue! :)

No problem! I was just going through my old notifications and I just wanted to double-check everything was working again.

I'm happy we unblocked you @maxnachlinger :)

Ddupasquier · 2023-04-07T17:21:40Z

@oscard0m In order to give you an accurate answer I will have to revisit the component and remember what I was even doing haha. On first view of the code... No. But this could be a syntax issue on my part or maybe my token expired.
I'll get back to you when I know more.

Ddupasquier · 2023-04-07T17:29:57Z

@oscard0m AH! So if you check the 'unrelated comments' a little ways up between @wolfy1339 and I, it seems that the issue from the octokit side is solved.

#405 (comment)

But success in my project is still blocked haha.
Wolfy tipped me off to where octokit is tracking this issue as well:
octokit/core.js#547

oscard0m · 2023-04-07T17:34:26Z

Yep, the @octokit-next is blocking quite a few things right now... I'm sorry to hear that. But I assume this issue can remain closed.

Ddupasquier · 2023-04-07T17:37:59Z

Absolutely. I appreciate everyone's dillogence!

maxnachlinger added Status: Triage This is being looked at and prioritized Type: Bug Something isn't working as documented labels Feb 20, 2023

octokitbot added this to 🧰 Octokit Active Feb 20, 2023

github-project-automation bot moved this to 🆕 Triage in 🧰 Octokit Active Feb 20, 2023

oscard0m mentioned this issue Feb 20, 2023

build(deps): lock file maintenance octokit/octokit.js#2399

Merged

1 task

oscard0m self-assigned this Feb 20, 2023

febuiles mentioned this issue Feb 27, 2023

Bump @octokit/plugin-retry from 4.1.1 to 4.1.2 actions/dependency-review-action#406

Closed

kfcampbell mentioned this issue Feb 27, 2023

[BUG]: After upgrading from 4.1.1 to 4.1.2, only the dist-node folder exists in the package. #409

Closed

1 task

wolfy1339 mentioned this issue Mar 1, 2023

[BUG]: CDN contain an invalid 4.1.2 release #407

Closed

1 task

oscard0m added a commit that referenced this issue Mar 2, 2023

fix(ci): add hotfix in built package.json to use proper file patterns…

c29fe31

… in "files" You can read more here: #405

oscard0m mentioned this issue Mar 2, 2023

Add script to fix package json from build step #410

Merged

3 tasks

oscard0m added a commit that referenced this issue Mar 2, 2023

fix(ci): add hotfix in built package.json to use proper file patterns…

d783daa

… in "files" You can read more here: #405

oscard0m added a commit that referenced this issue Mar 2, 2023

fix(ci): add hotfix in built package.json to use proper file patterns…

9a4fde8

… in "files" You can read more here: #405

wolfy1339 added Priority: High and removed Status: Triage This is being looked at and prioritized labels Mar 3, 2023

wolfy1339 moved this from 🆕 Triage to 🏗 In progress in 🧰 Octokit Active Mar 3, 2023

wolfy1339 mentioned this issue Mar 3, 2023

[BUG]: Breaks on Vite dep prebuild octokit/octokit.js#2404

Closed

1 task

wolfy1339 closed this as completed in #410 Mar 3, 2023

github-project-automation bot moved this from 🏗 In progress to ✅ Done in 🧰 Octokit Active Mar 3, 2023

github-actions bot added the released label Mar 3, 2023

This comment was marked as off-topic.

Sign in to view

oscard0m closed this as not planned Won't fix, can't repro, duplicate, stale Mar 5, 2023

oscard0m closed this as completed Mar 5, 2023

KittyChiu mentioned this issue Mar 27, 2023

fix: updated octokit dependency NickLiffen/ghas-enablement#110

Merged

wolfy1339 mentioned this issue May 8, 2023

[BUG]: package files not published to npm octokit/auth-app.js#474

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BUG]: dist-types/index.d.ts is not present in the published NPM package #405

[BUG]: dist-types/index.d.ts is not present in the published NPM package #405

maxnachlinger commented Feb 20, 2023

oscard0m commented Feb 20, 2023

oscard0m commented Feb 20, 2023 •

edited

Loading

kfcampbell commented Feb 27, 2023

wolfy1339 commented Feb 28, 2023

oscard0m commented Mar 2, 2023

Ddupasquier commented Mar 3, 2023

github-actions bot commented Mar 3, 2023

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

oscard0m commented Mar 5, 2023 •

edited

Loading

Ddupasquier commented Mar 5, 2023

oscard0m commented Apr 7, 2023

maxnachlinger commented Apr 7, 2023

oscard0m commented Apr 7, 2023

Ddupasquier commented Apr 7, 2023

Ddupasquier commented Apr 7, 2023 •

edited

Loading

oscard0m commented Apr 7, 2023

Ddupasquier commented Apr 7, 2023

[BUG]: dist-types/index.d.ts is not present in the published NPM package #405

[BUG]: dist-types/index.d.ts is not present in the published NPM package #405

Comments

maxnachlinger commented Feb 20, 2023

What happened?

Versions

Relevant log output

Code of Conduct

oscard0m commented Feb 20, 2023

Release 4.1.1

Release 4.1.2

oscard0m commented Feb 20, 2023 • edited Loading

kfcampbell commented Feb 27, 2023

wolfy1339 commented Feb 28, 2023

oscard0m commented Mar 2, 2023

Ddupasquier commented Mar 3, 2023

github-actions bot commented Mar 3, 2023

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

oscard0m commented Mar 5, 2023 • edited Loading

Published files in 4.1.2:

Published files in 4.1.3:

Ddupasquier commented Mar 5, 2023

oscard0m commented Apr 7, 2023

maxnachlinger commented Apr 7, 2023

oscard0m commented Apr 7, 2023

Ddupasquier commented Apr 7, 2023

Ddupasquier commented Apr 7, 2023 • edited Loading

oscard0m commented Apr 7, 2023

Ddupasquier commented Apr 7, 2023

Release `4.1.1`

Release `4.1.2`

oscard0m commented Feb 20, 2023 •

edited

Loading

oscard0m commented Mar 5, 2023 •

edited

Loading

Published files in `4.1.2`:

Published files in `4.1.3`:

Ddupasquier commented Apr 7, 2023 •

edited

Loading