fix(utils): improve devtools typing to avoid depending on @redux-devtools/extension

[fukumasuya]

Related Issues or Discussions

Fixes #776

Summary

I found the same issue in zustand(pmndrs/zustand#1205 (comment)), so I added the same workaround(copied the type defs from @redux-devtools/extension)
I'm not sure if this way is a desired way, but I did it anyway..

Check List

• yarn run prettier for formatting code and docs

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
valtio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 12, 2023 10:29am

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 3dc8f03:

Sandbox	Source
React	Configuration
React Typescript	Configuration
React Browserify	Configuration
React Snowpack	Configuration
React Parcel	Configuration

[fukumasuya]

It might be a better solution to move @redux-devtools/extension from devDependencies to dependencies and import Config type from @redux-devtools/extension .. But it might seem a little odd that it's in dependencies and redux is a peerDependencies of @redux-devtools/extension and devtools imports redux, so valtio users need to install redux manually...

[dai-shi]

So, it's basically doing the same as pmndrs/zustand#1207 ?
It looks okay then.

[dai-shi]

Though, this looks better. Curious how this is failing?

[dai-shi]

Oh, I see. We still need to install the package.
I wonder if we can type check on it.

[dai-shi]

Curious why L124 doesn't cause a type error.

[dai-shi]

because it disappears, okay.

[dai-shi]

208d3c9 fixes #776 reproduction.

[fukumasuya]

So, it's basically doing the same as pmndrs/zustand#1207 ?

Yes. that's right.

I also confirmed 208d3c9 fixes #776. thanks for updating my fix!

But it looks #713 feature does not work with TypeScript.. (tsc fails when we add some parameters that is coming from @redux-devtools/extensions.. is that ok for us?

const state = proxy({ count: 0, text: 'hello' });
devtools(state, { name: 'state name', enabled: true, latency: 1000 }); // 'latency' is coming from `@redux-devtools/extensions`

  Overload 1 of 2, '(proxyObject: { count: number; text: string; }, options?: { enabled?: boolean | undefined; name?: string | undefined; } | undefined): (() => void) | undefined', gave the following error.
    Argument of type '{ name: string; enabled: true; latency: number; }' is not assignable to parameter of type '{ enabled?: boolean | undefined; name?: string | undefined; }'.
      Object literal may only specify known properties, and 'latency' does not exist in type '{ enabled?: boolean | undefined; name?: string | undefined; }'.
  Overload 2 of 2, '(proxyObject: { count: number; text: string; }, name?: string | undefined): (() => void) | undefined', gave the following error.
    Argument of type '{ name: string; enabled: boolean; latency: number; }' is not assignable to parameter of type 'string'.

15 devtools(state, { name: 'state name', enabled: true, latency: 1000 });

[fukumasuya]

It seems if we install @redux-devtools/extension and import some function in this or load the type def file, then __REDUX_DEVTOOLS_EXTENSION__ is declared and following code works without type errors.., In that case, we need to install redux additionally because redux is in peerDependencies of @redux-devtools/extension..

const state = proxy({ count: 0, text: 'hello' });
devtools(state, { name: 'state name', enabled: true, latency: 1000 }); // 'latency' is coming from `@redux-devtools/extensions`

tsconfig.json

{
  "include": [
    "./node_modules/@redux-devtools/extension/lib/types/index.d.ts",
  ]
}

[dai-shi]

Hmm, isn't it just enough to install @redux-devtools/extension?
In that case, we should update the docs to explicitly import it (both in valtio and zustand.)

import type {} from '@redux-devtools/extension'
import { devtools } from 'valtio/utlis'

[fukumasuya]

Hmm, isn't it just enough to install @redux-devtools/extension?

It seems If we set skipLibCheck to true, we don't need to install redux.
Anyway, 208d3c9 fixes #776 and is fine for me 👍 thanks!