[TypeScript] Typing Support

[huan]

I had spent around two full days to study the document and write the typings for matrix-js-sdk.

With the typing system, it helped me a lot to learn the API and prevent lots of potential bugs. I think it's worth to publish them, the best will be integrated into our npm module.

The typing definition is still working in progress and heavy developing, you can watch it at https://github.com/huan/matrix-appservice-wechaty/blob/master/src/typings/matrix-js-sdk.d.ts.

I'll create a pull request to add the typing to this repository after I get my project done, and any suggestion will be welcome by leaving comments under this issue.

Link to wechaty/matrix-appservice#13

@Half-Shot

Thanks!

[Jack-Works]

any progress on TypeScript declaration file?

I try to use TypeScript 3.7 new feature --declaration with --allowJs to automatically generate the typings from the code base.

I failed with tons of any.

The reason of failure of generating the typing is the matrix code base

• is mixing the commonjs and ES Modules
• is using prototype to create a class instead of the class syntax in ES6

[huan]

This new feature from TS 3.7 is really cool.

I'd like to suggest that you try to use my declaration file which is written by me handly from scratch at here: https://github.com/huan/matrix-appservice-wechaty/tree/master/src/typings

And if you think it is useable, I'd like to publish it to the @types/matrix-js-sdk so that we can use it easily, and attract more TS developers to improve it for a better TS integration.

[Jack-Works]

I have tried your declaration file before, but it might be missing some functions(like createClient in the screenshot above) so not working well on our project. I think it is better to generate the types from the project since the project is typed by JSDoc. It will be easier to maintain the types for this huge project.

[huan]

Yes, It would be great if we can get the declaration from the source code automatically.

I hope you can figure it out, looking forward to the better version of the declaration files! 👍

[Jack-Works]

It need do have some codemods on the current code base like transform all commonjs style import/exports to ESModule, and transform all ES5 class to ES6 class.

[Jack-Works]

And there are lots of JSDoc style type refer like @extends {module:crypto/algorithms/base.EncryptionAlgorithm}, it is needed to parse the JSDoc style to TS style like typeof import("../../crypto/algorithms/base").EncryptionAlgorithm

[turt2live]

The TypeScript update is that our tests are a disaster and don't work with typescript. We're transitioning to TypeScript proper rather than supplying declarations.

[Jack-Works]

The Babel supports typescript doesn't means it will be typed by TS. I'm going to working on the .d.ts generation from the current codebase and release it as a separate package until the official codebase can provide a high quality typescript definition

Problems when generating dts

• ES5 style classes
• mixed module system
• jsdoc style type refer
• global type refer

[turt2live]

@Jack-Works there's a plan to rewrite/port to typescript, and a stage 1 PR is not a final representation of all the work required. I would recommend holding off until we fix our tests so we can get TypeScript properly landed, which will have a stage 2 PR for typings of the stuff we don't port (assuming it doesn't break everything).

[Jack-Works]

https://github.com/Jack-Works/matrix-js-sdk-type

[Jack-Works]

Here is my auto generated type definitions. I will improve the generated files these days.

[Jack-Works]

Ok. https://github.com/Jack-Works/matrix-js-sdk-type

Finally my work ends. But the type is very, very incomplete and I have no patience to continue working on the typescript declaration generation. Wish matrix to offer their own declaration some day!