JavaFacade to TypeScript API Generator

[delchev]

Feature Request: JavaFacade to TypeScript API Generator

Description

Overview

The proposal suggests the implementation of a JavaFacade to TypeScript API Generator in Eclipse Dirigible. This feature aims to accelerate the creation of a type-safe API based on Java classes by automating the generation process.

Motivation

Developers often encounter the need to interact with Java classes from TypeScript applications in Eclipse Dirigible. However, manually creating TypeScript APIs to mirror Java classes can be time-consuming and error-prone. By introducing a generator tool, we can streamline this process, reducing development effort and improving productivity.

Desired Features

The JavaFacade to TypeScript API Generator should offer the following functionalities:

1. Automatic Conversion: Automatically generate TypeScript definitions (interfaces, classes, methods) based on Java classes, including fields, methods, and their signatures.
2. Type Safety: Ensure that the generated TypeScript API maintains type safety by accurately reflecting the structure and types of Java classes.
3. Customization Options: Provide options to customize the generated TypeScript API, such as excluding certain fields or methods, specifying naming conventions, or adding custom annotations.
4. Integration with Eclipse Dirigible: Seamlessly integrate the generator tool into Eclipse Dirigible's development environment for easy access and usage.

Use Cases

1. Frontend Development: Enable frontend developers working with TypeScript to easily consume Java backend services by generating type-safe APIs directly from Java classes.
2. Cross-Platform Development: Facilitate the development of cross-platform applications where TypeScript and Java components need to interact seamlessly.

Implementation Considerations

Technology Stack

Consider leveraging existing libraries or frameworks for parsing Java classes and generating TypeScript definitions. Additionally, ensure compatibility with the Eclipse Dirigible platform.

Documentation

Provide comprehensive documentation covering the usage, configuration options, and integration steps of the JavaFacade to TypeScript API Generator.

[delchev]

JSweet: JSweet is a transpiler that converts Java code to TypeScript/JavaScript. While it's not specifically designed for generating TypeScript APIs from Java facades, it might be adaptable to our needs. It's worth exploring its capabilities and whether it could be configured to suit our requirements.

https://www.jsweet.org/jsweet-live-sandbox/