feat(types): add partial flag to mocked TypeScript helper (#1739)

[jfrs]

I'm not sure about the implementation, happy to get any feedback on this. Closes #1739.

[sheremet-va]

Maybe it's better to refactor vi.mocked to this? 🤔

vi.mocked(obj, { partial?, deep? })

[jfrs]

Something like this?

public mocked<T>(item: T, deep?: false): MaybeMocked<T>
public mocked<T>(item: T, deep: true): MaybeMockedDeep<T>
public mocked<T>(item: T, options: { partial?: false; deep?: false }): MaybeMocked<T>
public mocked<T>(item: T, options: { partial?: false; deep: true }): MaybeMockedDeep<T>
public mocked<T>(item: T, options: { partial: true; deep?: false }): MaybePartiallyMocked<T>
public mocked<T>(item: T, options: { partial: true; deep: true }): MaybePartiallyMockedDeep<T>
public mocked<T>(item: T, _options = {}): MaybeMocked<T> {
  return item as any
}

I'm not sure why _options = {} works, but it seems to accept all the different combinations:

• Will return MockedFunction

vi.mocked(mockFactory)
vi.mocked(mockFactory, false)
vi.mocked(mockFactory, {})
vi.mocked(mockFactory, { deep: false })
vi.mocked(mockFactory, { partial: false })
vi.mocked(mockFactory, { partial: false, deep: false })

• Will return MockedFunctionDeep

vi.mocked(mockFactory, true)
vi.mocked(mockFactory, { deep: true })
vi.mocked(mockFactory, { partial: false, deep: true }

• Will return PartiallyMockedFunction

vi.mocked(mockFactory, { partial: true })
vi.mocked(mockFactory, { partial: true, deep: false })

• Will return PartiallyMockedFunctionDeep

vi.mocked(mockFactory, { partial: true, deep: true })

[sheremet-va]

Something like this?

Yes, something like this 😄