@uppy/core state and store types are outdated

[a-kriya]

Initial checklist

• I understand this is a bug report and questions should be posted in the Community Forum
• I searched issues and couldn’t find anything (or linked relevant results below)

Link to runnable example

No response

Steps to reproduce

• Access the added files with uppy.state.files, validated by TS
• Error: cannot read property "files" of undefined

Expected behavior

TS to error out when accessing uppy.state and instead support uppy.store.state.

Actual behavior

state is nested under store:

[Murderlon]

AFAIK this is intended and you should never access the state like that. Instead, use uppy.getState (or more specific ones, like getFiles).

[a-kriya]

@Murderlon The methods cannot be made reactive while the object can (as seen in the screenshot).

To replace it with methods will involve events instead, which is currently not ideal as you have noted in another ticket.

And regardless of this being intended for external usage, the typings still seem incorrect.

The documentation is also in need of an update, I think: https://uppy.io/docs/uppy/#store-defaultStore

[Murderlon]

The methods cannot be made reactive while the object can (as seen in the screenshot).

What do you mean with this? What are you trying to do?

To replace it with methods will involve events instead, which is currently not ideal as you have noted in another ticket.

I'm not sure I know which ticket, what is the downside here?

And regardless of this being intended for external usage, the typings still seem incorrect.

TS to error out when accessing uppy.state and instead support uppy.store.state.

I think uppy.state is not typed currently, which means it should already error?

[a-kriya]

What do you mean with this? What are you trying to do?

I use Uppy inside a Vuex module. The Uppy instance is added to the state, which causes Vue to observe changes within it. This allows me to write simple getters that automatically update on Uppy's state changes:

{
  numberFiles(): number {
    return Object.values(uppy.state.files).length
  },
  totalSize(): number {
    return Object.values(uppy.state.files).reduce((size, file) => size + file.size, 0)
  }
}

The above was possible before, but since the update, the typings say that uppy.state exists, but that's wrong. It's uppy.store.state now, and TS errors out when I write that.

I'm not sure I know which ticket, what is the downside here?

Some issues that are described in #3248 and #3938.

[Murderlon]

Thanks for explaining. I think the readonly state type was forgotten to be removed in the latest major version, in which the deprecated state property was removed from the class.

[a-kriya]

@aduh95 #4477 just removes the typing for the older state property, but store still isn't typed for the Uppy instance when it does exist:

[Murderlon]

Uppy has been rewritten in TypeScript and the 4.0 release contains all type improvements.