[typescript-rxjs] add support for raw response and progressSubscriber

bin/configs/typescript-rxjs-with-interfaces.yaml → bin/configs/typescript-rxjs-with-progress-subscriber.yaml

@@ -1,5 +1,5 @@
 generatorName: typescript-rxjs
-outputDir: samples/client/petstore/typescript-rxjs/builds/with-interfaces
+outputDir: samples/client/petstore/typescript-rxjs/builds/with-progress-subscriber
 inputSpec: modules/openapi-generator/src/test/resources/2_0/petstore.yaml
 additionalProperties:
-  withInterfaces: "true"
+  withProgressSubscriber: "true"

docs/generators/typescript-rxjs.md

@@ -21,7 +21,7 @@ sidebar_label: typescript-rxjs
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
 |supportsES6|Generate code that conforms to ES6.| |false|
-|withInterfaces|Setting this property to true will generate interfaces next to the default class implementations.| |false|
+|withProgressSubscriber|Setting this property to true will generate API controller methods with support for subscribing to request progress.| |false|
 
 ## IMPORT MAPPING
 

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptRxjsClientCodegen.java

@@ -37,7 +37,7 @@ public class TypeScriptRxjsClientCodegen extends AbstractTypeScriptClientCodegen
     private static final Logger LOGGER = LoggerFactory.getLogger(AbstractTypeScriptClientCodegen.class);
 
     public static final String NPM_REPOSITORY = "npmRepository";
-    public static final String WITH_INTERFACES = "withInterfaces";
+    public static final String WITH_PROGRESS_SUBSCRIBER = "withProgressSubscriber";
 
     protected String npmRepository = null;
     protected Set<String> reservedParamNames = new HashSet<>();
@@ -60,7 +60,7 @@ public TypeScriptRxjsClientCodegen() {
         typeMapping.put("file", "Blob");
 
         this.cliOptions.add(new CliOption(NPM_REPOSITORY, "Use this property to set an url your private npmRepo in the package.json"));
-        this.cliOptions.add(new CliOption(WITH_INTERFACES, "Setting this property to true will generate interfaces next to the default class implementations.", SchemaTypeUtil.BOOLEAN_TYPE).defaultValue(Boolean.FALSE.toString()));
+        this.cliOptions.add(new CliOption(WITH_PROGRESS_SUBSCRIBER, "Setting this property to true will generate API controller methods with support for subscribing to request progress.", SchemaTypeUtil.BOOLEAN_TYPE).defaultValue(Boolean.FALSE.toString()));
 
         // these are used in the api template for more efficient destructuring
         this.reservedParamNames.add("headers");

modules/openapi-generator/src/main/resources/typescript-rxjs/apis.mustache

@@ -1,7 +1,7 @@
 // tslint:disable
 {{>licenseInfo}}
 import { Observable } from 'rxjs';
-import { BaseAPI{{#hasHttpHeaders}}, HttpHeaders{{/hasHttpHeaders}}{{#hasQueryParams}}, HttpQuery{{/hasQueryParams}}{{#hasRequiredParams}}, throwIfNullOrUndefined{{/hasRequiredParams}}{{#hasPathParams}}, encodeURI{{/hasPathParams}}{{#hasListContainers}}, COLLECTION_FORMATS{{/hasListContainers}} } from '../runtime';
+import { BaseAPI{{#hasHttpHeaders}}, HttpHeaders{{/hasHttpHeaders}}{{#hasQueryParams}}, HttpQuery{{/hasQueryParams}}{{#hasRequiredParams}}, throwIfNullOrUndefined{{/hasRequiredParams}}{{#hasPathParams}}, encodeURI{{/hasPathParams}}{{#hasListContainers}}, COLLECTION_FORMATS{{/hasListContainers}}, OperationOpts, RawAjaxResponse } from '../runtime';
 {{#imports.0}}
 import {
     {{#imports}}
@@ -37,7 +37,12 @@ export class {{classname}} extends BaseAPI {
      * {{&summary}}
      {{/summary}}
      */
-    {{nickname}} = ({{#allParams.0}}{ {{#allParams}}{{paramName}}{{#vendorExtensions.x-param-name-alternative}}: {{vendorExtensions.x-param-name-alternative}}{{/vendorExtensions.x-param-name-alternative}}{{^-last}}, {{/-last}}{{/allParams}} }: {{operationIdCamelCase}}Request{{/allParams.0}}): Observable<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}> => {
+    {{nickname}}({{#allParams.0}}{ {{#allParams}}{{paramName}}{{#vendorExtensions.x-param-name-alternative}}: {{vendorExtensions.x-param-name-alternative}}{{/vendorExtensions.x-param-name-alternative}}{{^-last}}, {{/-last}}{{/allParams}} }: {{operationIdCamelCase}}Request{{/allParams.0}}): Observable<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}>
+{{#withProgressSubscriber}}
+    {{nickname}}({{#allParams.0}}{ {{#allParams}}{{paramName}}{{#vendorExtensions.x-param-name-alternative}}: {{vendorExtensions.x-param-name-alternative}}{{/vendorExtensions.x-param-name-alternative}}{{^-last}}, {{/-last}}{{/allParams}} }: {{operationIdCamelCase}}Request, {{/allParams.0}}opts?: Pick<OperationOpts, 'progressSubscriber'>): Observable<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}>
+{{/withProgressSubscriber}}
+    {{nickname}}({{#allParams.0}}{ {{#allParams}}{{paramName}}{{#vendorExtensions.x-param-name-alternative}}: {{vendorExtensions.x-param-name-alternative}}{{/vendorExtensions.x-param-name-alternative}}{{^-last}}, {{/-last}}{{/allParams}} }: {{operationIdCamelCase}}Request, {{/allParams.0}}opts?: OperationOpts): Observable<{{#returnType}}RawAjaxResponse<{{{returnType}}}>{{/returnType}}{{^returnType}}void | RawAjaxResponse<void>{{/returnType}}>
+    {{nickname}}({{#allParams.0}}{ {{#allParams}}{{paramName}}{{#vendorExtensions.x-param-name-alternative}}: {{vendorExtensions.x-param-name-alternative}}{{/vendorExtensions.x-param-name-alternative}}{{^-last}}, {{/-last}}{{/allParams}} }: {{operationIdCamelCase}}Request, {{/allParams.0}}opts?: OperationOpts): Observable<{{#returnType}}{{{returnType}}} | RawAjaxResponse<{{{returnType}}}>{{/returnType}}{{^returnType}}void | RawAjaxResponse<void>{{/returnType}}> {
         {{#hasParams}}
         {{#allParams}}
         {{#required}}
@@ -177,7 +182,7 @@ export class {{classname}} extends BaseAPI {
 
         {{/hasFormParams}}
         return this.request<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}>({
-            path: '{{{path}}}'{{#pathParams}}.replace({{=<% %>=}}'{<%baseName%>}'<%={{ }}=%>, encodeURI({{> paramNamePartial}})){{/pathParams}},
+            url: '{{{path}}}'{{#pathParams}}.replace({{=<% %>=}}'{<%baseName%>}'<%={{ }}=%>, encodeURI({{> paramNamePartial}})){{/pathParams}},
             method: '{{httpMethod}}',
             {{#hasHttpHeaders}}
             headers,
@@ -204,9 +209,12 @@ export class {{classname}} extends BaseAPI {
             body: formData,
             {{/hasFormParams}}
 {{#isResponseFile}}
-            responseType: 'blob'
+            responseType: 'blob',
 {{/isResponseFile}}
-        });
+{{#withProgressSubscriber}}
+            progressSubscriber: opts?.progressSubscriber,
+{{/withProgressSubscriber}}
+        }, opts?.responseOpts);
     };
 
     {{/operation}}

modules/openapi-generator/src/main/resources/typescript-rxjs/package.mustache

@@ -6,14 +6,14 @@
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
   "scripts" : {
-    "build": "tsc --outDir dist/",
+    "build": "node_modules/.bin/tsc --outDir dist/",
     "prepare": "npm run build"
   },
   "dependencies": {
     "rxjs": "^6.3.3"
   },
   "devDependencies": {
-    "typescript": "^3.0.1"
+    "typescript": "^3.7"
   }{{#npmRepository}},{{/npmRepository}}
 {{#npmRepository}}
   "publishConfig": {

modules/openapi-generator/src/main/resources/typescript-rxjs/runtime.mustache

@@ -1,6 +1,6 @@
 // tslint:disable
 {{>licenseInfo}}
-import { Observable, of } from 'rxjs';
+import { Observable, of, Subscriber } from 'rxjs';
 import { ajax, AjaxRequest, AjaxResponse } from 'rxjs/ajax';
 import { map, concatMap } from 'rxjs/operators';
 
@@ -19,11 +19,11 @@ export class Configuration {
     constructor(private configuration: ConfigurationParameters = {}) {}
 
     get basePath(): string {
-        return this.configuration.basePath || BASE_PATH;
+        return this.configuration.basePath ?? BASE_PATH;
     }
 
     get middleware(): Middleware[] {
-        return this.configuration.middleware || [];
+        return this.configuration.middleware ?? [];
     }
 
     get username(): string | undefined {
@@ -36,18 +36,12 @@ export class Configuration {
 
     get apiKey(): ((name: string) => string) | undefined {
         const { apiKey } = this.configuration;
-        if (!apiKey) {
-            return undefined;
-        }
-        return typeof apiKey === 'string' ? () => apiKey : apiKey;
+        return apiKey ? (typeof apiKey === 'string' ? () => apiKey : apiKey) : undefined;
     }
 
     get accessToken(): ((name: string, scopes?: string[]) => string) | undefined {
         const { accessToken } = this.configuration;
-        if (!accessToken) {
-            return undefined;
-        }
-        return typeof accessToken === 'string' ? () => accessToken : accessToken;
+        return accessToken ? (typeof accessToken === 'string' ? () => accessToken : accessToken) : undefined;
     }
 }
 
@@ -73,31 +67,35 @@ export class BaseAPI {
     withPostMiddleware = (postMiddlewares: Array<Middleware['post']>) =>
         this.withMiddleware(postMiddlewares.map((post) => ({ post })));
 
-    protected request = <T>(requestOpts: RequestOpts): Observable<T> =>
-        this.rxjsRequest(this.createRequestArgs(requestOpts)).pipe(
+    protected request<T>(requestOpts: RequestOpts): Observable<T>
+    protected request<T>(requestOpts: RequestOpts, responseOpts?: ResponseOpts): Observable<RawAjaxResponse<T>>
+    protected request<T>(requestOpts: RequestOpts, responseOpts?: ResponseOpts): Observable<T | RawAjaxResponse<T>> {
+        return this.rxjsRequest(this.createRequestArgs(requestOpts)).pipe(
             map((res) => {
-                if (res.status >= 200 && res.status < 300) {
-                    return res.response as T;
+                const { status, response } = res;
+                if (status >= 200 && status < 300) {
+                    return responseOpts?.respone === 'raw' ? res : response;
                 }
                 throw res;
             })
         );
+    }
 
-    private createRequestArgs = (requestOpts: RequestOpts): RequestArgs => {
-        let url = this.configuration.basePath + requestOpts.path;
-        if (requestOpts.query !== undefined && Object.keys(requestOpts.query).length !== 0) {
-            // only add the queryString to the URL if there are query parameters.
-            // this is done to avoid urls ending with a '?' character which buggy webservers
-            // do not handle correctly sometimes.
-            url += '?' + queryString(requestOpts.query);
-        }
+    private createRequestArgs = ({ url: baseUrl, query, method, headers, body, responseType{{#withProgressSubscriber}}, progressSubscriber{{/withProgressSubscriber}} }: RequestOpts): RequestArgs => {
+        // only add the queryString to the URL if there are query parameters.
+        // this is done to avoid urls ending with a '?' character which buggy webservers
+        // do not handle correctly sometimes.
+        const url = `${this.configuration.basePath}${baseUrl}${query && Object.keys(query).length ? `?${queryString(query)}`: ''}`;
 
         return {
             url,
-            method: requestOpts.method,
-            headers: requestOpts.headers,
-            body: requestOpts.body instanceof FormData ? requestOpts.body : JSON.stringify(requestOpts.body),
-            responseType: requestOpts.responseType || 'json',
+            method,
+            headers,
+            body: body instanceof FormData ? body : JSON.stringify(body),
+            responseType: responseType ?? 'json',
+            {{#withProgressSubscriber}}
+            progressSubscriber,
+            {{/withProgressSubscriber}}
         };
     }
 
@@ -146,24 +144,41 @@ export type HttpHeaders = { [key: string]: string };
 export type HttpQuery = Partial<{ [key: string]: string | number | null | boolean | Array<string | number | null | boolean> }>; // partial is needed for strict mode
 export type HttpBody = Json | FormData;
 
-export interface RequestOpts {
-    path: string;
+export interface RequestOpts extends AjaxRequest {
+    query?: HttpQuery; // additional prop
+    // the following props have improved types over AjaxRequest 
     method: HttpMethod;
     headers?: HttpHeaders;
-    query?: HttpQuery;
     body?: HttpBody;
     responseType?: 'json' | 'blob' | 'arraybuffer' | 'text';
+    {{#withProgressSubscriber}}
+    progressSubscriber?: Subscriber<ProgressEvent>;
+    {{/withProgressSubscriber}}
+}
+
+export interface ResponseOpts {
+    respone?: 'raw';
+}
+
+export interface OperationOpts {
+    {{#withProgressSubscriber}}
+    progressSubscriber?: Subscriber<ProgressEvent>;
+    {{/withProgressSubscriber}}
+    responseOpts?: ResponseOpts;
+}
+
+// AjaxResponse with typed response 
+export interface RawAjaxResponse<T> extends AjaxResponse {
+    response: T;
 }
 
-export const encodeURI = (value: any) => encodeURIComponent(String(value));
+export const encodeURI = (value: any) => encodeURIComponent(`${value}`);
 
-const queryString = (params: HttpQuery): string => Object.keys(params)
-    .map((key) => {
-        const value = params[key];
-        return (value instanceof Array)
-            ? value.map((val) => `${encodeURI(key)}=${encodeURI(val)}`).join('&')
-            : `${encodeURI(key)}=${encodeURI(value)}`;
-    })
+const queryString = (params: HttpQuery): string => Object.entries(params)
+    .map(([key, value]) => value instanceof Array
+        ? value.map((val) => `${encodeURI(key)}=${encodeURI(val)}`).join('&')
+        : `${encodeURI(key)}=${encodeURI(value)}`
+    )
     .join('&');
 
 // alias fallback for not being a breaking change

modules/openapi-generator/src/main/resources/typescript-rxjs/tsconfig.mustache

@@ -6,12 +6,13 @@
     "moduleResolution": "node",
     "outDir": "dist",
     "rootDir": ".",
-    {{^supportsES6}}
     "lib": [
+      {{^supportsES6}}
       "es6",
-      "dom"
+      {{/supportsES6}}
+      "dom",
+      "es2017"
     ],
-    {{/supportsES6}}
     "typeRoots": [
       "node_modules/@types"
     ]