Typescript Declaration

[farskid]

Adds Typescript declaration file.

fixes: #131

It covers all the exported entities.

[rgommezz]

@farskid, thanks for the PR, looking good so far!

Regarding the store not found error, that's probably because you are not using react-redux v6.x.x.

networkSaga is a generator function, so I think in essence it's a function taht receives almost the same params as NetworkProvider and returns an iterator. Probably TS already provides something in order to express an iterator type.

[farskid]

@rgommezz I'd try to upgrade my test react native typescript project to use react-redux v6 so I could test the integration as well.
About networkSaga, there is actually a standard way to type iterators in TS.
I'd push latest changes.

[piotrwitek]

Thanks for your contribution. So far looks good, but still got a few improvements to incorporate.

1. Please double-check you're following best practices and update file header to follow a definitely-typed format (correct lib and TS version are especially important for consumers):

• http://definitelytyped.org/guides/contributing.html
• http://definitelytyped.org/guides/best-practices.html

2. Please add types property to the package.json referencing index.d.ts
   https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html

3. Also it would be good idea to incorporate at least few type-tests cases. Perhaps you could use this one as a reference and copy over some files: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react-redux/react-redux-tests.tsx
   (Note: you would need to create a new folder with type-tests and put test examples inside with package.json, tsconfig and tslint copied from definitely typed reference, then we could run test script on CI or on push (whatever) to see if the types are not generating type-errors)
   These type-tests would also be very useful for TS users as a reference of how to use this library with TypeScript.

All of that will make maintainers of types and the new contributors life easier.

[piotrwitek]

Redux should be included as a peer dependency with the appropriate version range, I don't see it right now

[farskid]

Could you elaborate more on this? Redux is currently defined as devDependency of the project. Redux and React can be moved into peerDependencies of project as they're not truly a dependency but more a requirement. There would be no point of using this library without them already installed, right?

[piotrwitek]

Yes, that is what I have written, there is a missing peerDependency of redux and consumers need to know which redux version to use so types are working correctly.

[rgommezz]

I think that's a bit tricky, since this library can be consumed with or without redux, for example if you just wanna use the React components utilities.

I don't see currently any option within npm to specify optional peerDependencies.

Still, if npm only warns, we should go for the latest redux version, which is 4.x.x

[piotrwitek]

@rgommezz what about this one, I think it should be fine:

I am putting the same package in both optionalDependencies and peerDependencies, and it seems to work. Not sure if this is the proper way or not.

[farskid]

@piotrwitek Thanks for the comments. I'll push the changes soon.

[farskid]

@piotrwitek Do we need to have test file for definitions if we keep the declaration file inside the library? point is, if we don't publish types to DefinitelyTyped and instead keep it inside the library itself, would we still need to have tests? (considering that we don't have Typescript workflow in the repo yet).

[piotrwitek]

Yes, otherwise how would I know types are really working? (supported TS version, tsconfig options etc.)
I would like to test it but I don't want to set up a separate project just to do it. I just want to pull the repo, open in IDE and see if there are any errors.
This will also make it easier to solve any future TS workflow issues because we can point users to check test folder setup if they have correct configuration etc.

[farskid]

@piotrwitek I agree and see the point. I've checked a couple of famous libraries on npm around React and Redux. some of them use a simple setup of tsconfig.json and a simple test file that uses the types and some of the use a tool developed and maintained by Microsoft called dtslint https://github.com/Microsoft/dtslint . I', fine with whichever.

[piotrwitek]

I know dtslint and I think we don't need it here. A simple setup with tsconfig and test file with some common use-case usage example should be good enough.

[rgommezz]

Hey @farskid, any updates on this? As far as I understand, only some test cases are missing. I think the important ones are checking the interfaces for NetworkProvider, NetworkConsumer, ReduxNetworkProvider and createNetworkMiddleware.

If you don't have much time at the moment, I can go ahead and take it from there if you want, since I acquired a bit of TS experience lately. Lemme know!

[farskid]

@rgommezz I'll finish it up in a day or two :)

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

Closing this issue after a prolonged period of inactivity. If this is still present in the latest release, please feel free to create a new issue with up-to-date information.