jaxrs: restResponseType, restOptionsType

Author: vojtechhabarta

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/Settings.java

@@ -41,6 +41,8 @@ public class Settings {
     public ClassMapping mapClasses; // default is ClassMapping.asInterfaces
     public boolean disableTaggedUnions = false;
     public boolean generateJaxrsApplicationInterface = false;
+    public String restResponseType = null;
+    public String restOptionsType = null;
     public TypeProcessor customTypeProcessor = null;
     public boolean sortDeclarations = false;
     public boolean sortTypeDeclarations = false;

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/TsType.java

@@ -62,6 +62,20 @@ public String format(Settings settings) {
         }
     }
 
+    public static class VerbatimType extends TsType {
+
+        public final String verbatimType;
+
+        public VerbatimType(String verbatimType) {
+            this.verbatimType = verbatimType;
+        }
+
+        @Override
+        public String format(Settings settings) {
+            return verbatimType;
+        }
+    }
+
     /**
      * Identifier which references some type, for example interface or type alias.
      */

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/compiler/ModelCompiler.java

@@ -270,15 +270,22 @@ private static List<TsPropertyModel> getImplementedProperties(SymbolTable symbol
     }
 
     private TsModel createJaxrsInterface(SymbolTable symbolTable, TsModel tsModel, Model model) {
-        final Symbol responseSymbol = symbolTable.getSyntheticSymbol("RestResponse");
-        final TsType.GenericVariableType varR = new TsType.GenericVariableType("R");
-        final TsType.GenericReferenceType responseTypeDefinition = new TsType.GenericReferenceType(symbolTable.getSyntheticSymbol("Promise"), Arrays.<TsType>asList(varR));
-        final TsAliasModel responseTypeAlias = new TsAliasModel(null, responseSymbol, Arrays.asList(varR), responseTypeDefinition, null);
-        tsModel.getTypeAliases().add(responseTypeAlias);
         final JaxrsApplicationModel jaxrsApplication = model.getJaxrsApplication();
         if (jaxrsApplication == null || jaxrsApplication.getMethods().isEmpty()) {
             return tsModel;
         }
+        // response type
+        final Symbol responseSymbol = symbolTable.getSyntheticSymbol("RestResponse");
+        final TsType.GenericVariableType varR = new TsType.GenericVariableType("R");
+        final TsAliasModel responseTypeAlias;
+        if (settings.restResponseType != null) {
+            responseTypeAlias = new TsAliasModel(null, responseSymbol, Arrays.asList(varR), new TsType.VerbatimType(settings.restResponseType), null);
+        } else {
+            final TsType.GenericReferenceType responseTypeDefinition = new TsType.GenericReferenceType(symbolTable.getSyntheticSymbol("Promise"), Arrays.<TsType>asList(varR));
+            responseTypeAlias = new TsAliasModel(null, responseSymbol, Arrays.asList(varR), responseTypeDefinition, null);
+        }
+        tsModel.getTypeAliases().add(responseTypeAlias);
+        // application interface
         final String applicationPath = jaxrsApplication.getApplicationPath();
         final String pathPrefix = applicationPath != null && !applicationPath.isEmpty() ? applicationPath + "/" : "";
         final List<TsMethodModel> methods = new ArrayList<>();
@@ -314,6 +321,10 @@ private TsMethodModel processJaxrsMethod(SymbolTable symbolTable, String pathPre
         for (MethodParameterModel parameter : method.getPathParams()) {
             parameters.add(processParameter(symbolTable, method, parameter));
         }
+        // entity param
+        if (method.getEntityParam() != null) {
+            parameters.add(processParameter(symbolTable, method, method.getEntityParam()));
+        }
         // query params
         final List<MethodParameterModel> queryParams = method.getQueryParams();
         if (queryParams != null && !queryParams.isEmpty()) {
@@ -325,9 +336,9 @@ private TsMethodModel processJaxrsMethod(SymbolTable symbolTable, String pathPre
             final TsParameterModel queryParameter = new TsParameterModel("queryParams", new TsType.OptionalType(new TsType.ObjectType(properties)));
             parameters.add(queryParameter);
         }
-        // entity param
-        if (method.getEntityParam() != null) {
-            parameters.add(processParameter(symbolTable, method, method.getEntityParam()));
+        if (settings.restOptionsType != null) {
+            final TsParameterModel optionsParameter = new TsParameterModel("options", new TsType.OptionalType(new TsType.VerbatimType(settings.restOptionsType)));
+            parameters.add(optionsParameter);
         }
         // return type
         final TsType returnType = typeFromJava(symbolTable, method.getReturnType(), method.getName(), method.getOriginClass());

typescript-generator-core/src/test/java/cz/habarta/typescript/generator/JaxrsApplicationTest.java

@@ -271,6 +271,7 @@ public void complexInterfaceTest() {
         settings.generateJaxrsApplicationInterface = true;
         final String output = new TypeScriptGenerator(settings).generateTypeScript(Input.from(OrganizationApplication.class));
         final String errorMessage = "Unexpected output: " + output;
+        Assert.assertTrue(errorMessage, output.contains("type RestResponse<R> = Promise<R>;"));
         Assert.assertTrue(errorMessage, output.contains("interface Organization"));
         Assert.assertTrue(errorMessage, output.contains("interface OrganizationApplication"));
         Assert.assertTrue(errorMessage, output.contains("HTTP GET /api/organizations/{ organizationCode : [a-z]+ }/{organizationId}"));
@@ -296,6 +297,18 @@ public void methodNameConflictTest() {
         Assert.assertTrue(errorMessage, output.contains("person$GET$conflict_personId(personId: number): RestResponse<Person>;"));
     }
 
+    @Test
+    public void customizationsTest() {
+        final Settings settings = TestUtils.settings();
+        settings.generateJaxrsApplicationInterface = true;
+        settings.restResponseType = "AxiosPromise";
+        settings.restOptionsType = "AxiosRequestConfig";
+        final String output = new TypeScriptGenerator(settings).generateTypeScript(Input.from(OrganizationApplication.class));
+        final String errorMessage = "Unexpected output: " + output;
+        Assert.assertTrue(errorMessage, output.contains("type RestResponse<R> = AxiosPromise;"));
+        Assert.assertTrue(errorMessage, output.contains("searchOrganizations(queryParams?: { name?: string; \"search-limit\"?: number; }, options?: AxiosRequestConfig): RestResponse<Organization[]>;"));
+    }
+
     @ApplicationPath("api")
     private static class OrganizationApplication extends Application {
         @Override

typescript-generator-gradle-plugin/src/main/java/cz/habarta/typescript/generator/gradle/GenerateTask.java

@@ -41,6 +41,8 @@ public class GenerateTask extends DefaultTask {
     public ClassMapping mapClasses;
     public boolean disableTaggedUnions;
     public boolean experimentalJaxrsApplicationInterface;
+    public String restResponseType;
+    public String restOptionsType;
     public String customTypeProcessor;
     public boolean sortDeclarations;
     public boolean sortTypeDeclarations;
@@ -101,6 +103,8 @@ public void generate() throws Exception {
         settings.mapClasses = mapClasses;
         settings.disableTaggedUnions = disableTaggedUnions;
         settings.generateJaxrsApplicationInterface = experimentalJaxrsApplicationInterface;
+        settings.restResponseType = restResponseType;
+        settings.restOptionsType = restOptionsType;
         settings.loadCustomTypeProcessor(classLoader, customTypeProcessor);
         settings.sortDeclarations = sortDeclarations;
         settings.sortTypeDeclarations = sortTypeDeclarations;

typescript-generator-maven-plugin/src/main/java/cz/habarta/typescript/generator/maven/GenerateMojo.java

@@ -239,6 +239,23 @@ public class GenerateMojo extends AbstractMojo {
     @Parameter
     private boolean experimentalJaxrsApplicationInterface;
 
+    /**
+     * Specifies HTTP response type in JAXRS application.
+     * Default value is <code>Promise&amp;R></code> which means data object returned asynchronously.
+     * Useful for example when underlying HTTP response object (like <code>XMLHttpRequest</code> or <code>AxiosPromise</code>)
+     * is returned instead of actual response data.
+     */
+    @Parameter
+    private String restResponseType;
+
+    /**
+     * Specifies HTTP request options type in JAXRS application.
+     * By default no <code>options</code> parameter is generated.
+     * Useful when passing additional parameters to underlying HTTP request method (like jQuery ajax settings or <code>AxiosRequestConfig</code>).
+     */
+    @Parameter
+    private String restOptionsType;
+
     /**
      * Specifies custom class implementing {@link cz.habarta.typescript.generator.TypeProcessor}.
      * This allows to customize how Java types are mapped to TypeScript.
@@ -355,6 +372,8 @@ public void execute() {
             settings.mapClasses = mapClasses;
             settings.disableTaggedUnions = disableTaggedUnions;
             settings.generateJaxrsApplicationInterface = experimentalJaxrsApplicationInterface;
+            settings.restResponseType = restResponseType;
+            settings.restOptionsType = restOptionsType;
             settings.loadCustomTypeProcessor(classLoader, customTypeProcessor);
             settings.sortDeclarations = sortDeclarations;
             settings.sortTypeDeclarations = sortTypeDeclarations;