supabase-js icon indicating copy to clipboard operation
supabase-js copied to clipboard

Using this package is incompatible with TS flag exactOptionalPropertyTypes

Open JeongJuhyeon opened this issue 7 months ago • 0 comments

Bug report

  • [x] I confirm this is a bug with Supabase, not with my own application.
  • [x] I confirm I have searched the Docs, GitHub Discussions, and Discord.

Describe the bug

The StorageFileApi.bucketId field type is bucketId?: string, which breaks when exactOptionalPropertyTypes is on. This causes headaches for folks trying to use the library with the flag on.

To Reproduce

  1. Create project, add @supabase/supabase-js
  2. turn on flag "exactOptionalPropertyTypes" in tsconfig
  3. tsc

Expected behavior

Compiles without errors

Additional context

  • TypeScript itself recommends using this flag. The reason it is not in strict is just to avoid breaking too much existing user code.

  • Right now, anyone with this flag on can't use the library without it failing to compile. Using skipLibCheck isn't great because it skips all .d.ts files, including user-made ones (see this issue).

  • Except for the one field I fixed, the package already follows this rule.

  • In my current project with 58 libraries, this is the only one that breaks with the flag on, indicating it's already a standard in the ecosystem.

These tweaks should make the library more robust and play better with strict TS setups, without causing issues for current users. Let me know if you need any more info!

PR Here

https://github.com/supabase/storage-js/pull/205

JeongJuhyeon avatar Jul 04 '24 09:07 JeongJuhyeon