feat: enable Typescript Input

[ron-debajyoti]

Description

• Added TypescriptInputProcessor along with options to allow processing and generation of json schemas based on options like uniqueNames, compilerOptions
• Added tests for TypescriptInputProcessor
• Added 2 usage examples java-from-typescript-type and java-from-typescript-type-with-options.

Related issue(s)

Fixes #187

[ron-debajyoti]

Hey @jonaslagoni !

I made this draft PR for issue #187 . Please check it out and provide your feedback on whether I'm heading in the right direction. There's still a lot of work left like writing proper tests and adding more implementation features based on the library I'm using.

[jonaslagoni]

Nice progress! 🎉

I made this draft PR for issue #187 . Please check it out and provide your feedback on whether I'm heading in the right direction. There's still a lot of work left like writing proper tests and adding more implementation features based on the library I'm using.

I just realized that we run into a bit of a problem here 😄

Currently, the input type has always been one file, or rather one JSON object which of course wont fit here. So we need to adapt the input processing to accommodate these new input types.

Would you like to start the issue? 🙂

[ron-debajyoti]

Sorry @jonaslagoni for the late reply, I was kinda busy with my university coursework. I'm also going to reply to the comments above here.

Currently, the input type has always been one file, or rather one JSON object which of course wont fit here. So we need to adapt the input processing to accommodate these new input types.

Yeah so is this the case for handling the whole Typescript project? For that, we need to use the tsconfig.json of the project and then pass the required TYPE, as described here. Currently, to just start working I tested it using a type declaration example.

Additionally, I'm trying to understand what more input types are we going to accept here? Since we either have to get the individual type.ts files or the tsconfig.json file, it was easier to just consider a base path as a string. If I misunderstood something please do mention.

[jonaslagoni]

Yeah so is this the case for handling the whole Typescript project? For that, we need to use the tsconfig.json of the project and then pass the required TYPE, as described here. Currently, to just start working I tested it using a type declaration example.

Additionally, I'm trying to understand what more input types are we going to accept here? Since we either have to get the individual type.ts files or the tsconfig.json file, it was easier to just consider a base path as a string. If I misunderstood something please do mention.

My recommendation is to start small, what is the absolute minimum we need to support in order to say we have this feature. So for now don't worry about projects, but a single file 🙂 (unless the library supports providing the content of a file that would be better 😄)

I would suggest you took a look at how you can change the current processor line to follow this format:

process(input: any): CommonInputModel {
   if(typeof input !== 'string') throw error;
   const pathToFile = input;

As I dont know the library in and out, try to see what is possible and feel free to ping me with what worked and didnt 🙂

[coveralls]

Pull Request Test Coverage Report for Build 1929157128

• 37 of 42 (88.1%) changed or added relevant lines in 3 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage decreased (-0.1%) to 92.946%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/processors/TypeScriptInputProcessor.ts	34	39	87.18%

Totals
Change from base Build 1928274956:	-0.1%
Covered Lines:	2567
Relevant Lines:	2633

---

💛 - Coveralls

[ron-debajyoti]

@jonaslagoni So I guess this is the absolute base case of the implementation where I pass a .ts file as { baseFile : ourFile } as input Record, and it generates and adds all the types present in the file to our common model.

There's a lot more features to add to this, like :

• generate selected types
• generate types from a whole project using tsconfig.json.....
  and many more to explore. Let me know your views and if possible we can have a discussion.

Also let me know if I need to improve on the documentation of the current implementation.

[jonaslagoni]

Looking good @ron-debajyoti 💪

A couple of things are missing until we can merge:

• We need to add it as a input to the input processor:

  modelina/src/processors/InputProcessor.ts

  Line 19 in 8a79fc0

  this.setProcessor('default', new JsonSchemaInputProcessor());

• We need an example showing that it works similar to how we do for AsyncAPI inputs: https://github.com/asyncapi/modelina/tree/master/examples/asyncapi-from-object
  • Check out https://github.com/asyncapi/modelina/blob/master/docs/contributing.md#adding-examples how to add examples 🙂
• We need to adapt the following documentation files:
• https://github.com/asyncapi/modelina#features where we add TypeScript files as supported input
• Add a new usage section that we can link the example to 🙂

[ron-debajyoti]

Hey @jonaslagoni . Here's the summary of the latest commits :

• added the options: ProcessorOptions support in TypeScriptInputProcessor to allow users to generate schemas based on options like uniqueNames, compilerOptions as defined in typescript-json-schema here. Added an additional test for that as well.
• added an example of generating Java models from a TypeScript input. I figured that since AbstractGenerator calls InputProcessor.process during model generation, generating a language model (for eg. Java ) from a TypeScript file would be a good example.
• updated docs in examples and the main README.md.

Please review and let me know if I had missed something.
Edit: looks like black-box testing in ubuntu is failing

[jonaslagoni]

Got a few comments, but overall it looks great 👍

@magicmatatjahu think it's time you take a look if you want to, as we have reached the final state before merging.

[ron-debajyoti]

@magicmatatjahu this has been pending for review for many days 😅

[jonaslagoni]

@magicmatatjahu this has been pending for review for many days

Life of OpenSource unfortunately 😄

@magicmatatjahu do you want to review it, or can we go ahead?

[magicmatatjahu]

Only one suggestion :) Rest lgtm. Awesome work!

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[jonaslagoni]

LGTM 👍

[jonaslagoni]

/rtm

[asyncapi-bot]

🎉 This PR is included in version 0.51.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[asyncapi-bot]

🎉 This PR is included in version 1.0.0-next.23 🎉

The release is available on:

• npm package (@next dist-tag)
• GitHub release

Your semantic-release bot 📦🚀