Skip to content

Update the template to expose the response context #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 2, 2025
Merged

Update the template to expose the response context #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions api/oas_templates/typescript/api/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// TODO: better import syntax?
import {BaseAPIRequestFactory, RequiredError, COLLECTION_FORMATS} from './baseapi{{importFileExtension}}';
import {Configuration} from '../configuration{{importFileExtension}}';
import {RequestContext, HttpMethod, ResponseContext, HttpFile, HttpInfo} from '../http/http{{importFileExtension}}';
import {RequestContext, HttpMethod, ResponseContext, HttpFile} from '../http/http{{importFileExtension}}';
{{#platforms}}
{{#node}}
import {{^supportsES6}}* as{{/supportsES6}} FormData from "form-data";
Expand Down Expand Up @@ -210,7 +210,7 @@ export class {{classname}}ResponseProcessor {
* @params response Response returned by the server for a request to {{nickname}}
* @throws ApiException if the response code was not in [200, 299]
*/
public async {{nickname}}WithHttpInfo(response: ResponseContext): Promise<HttpInfo<{{{returnType}}} {{^returnType}}void{{/returnType}}>> {
public async {{nickname}}Response(response: ResponseContext): Promise<{{{returnType}}} {{^returnType}}void{{/returnType}}> {
const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
{{#responses}}
if (isCodeInRange("{{code}}", response.httpStatusCode)) {
Expand All @@ -225,15 +225,15 @@ export class {{classname}}ResponseProcessor {
) as {{{dataType}}};
{{/isBinary}}
{{#is2xx}}
return new HttpInfo(response.httpStatusCode, response.headers, response.body, body);
return body;
{{/is2xx}}
{{^is2xx}}
throw new ApiException<{{{dataType}}}>(response.httpStatusCode, "{{message}}", body, response.headers);
{{/is2xx}}
{{/dataType}}
{{^dataType}}
{{#is2xx}}
return new HttpInfo(response.httpStatusCode, response.headers, response.body, undefined);
return undefined;
{{/is2xx}}
{{^is2xx}}
throw new ApiException<undefined>(response.httpStatusCode, "{{message}}", undefined, response.headers);
Expand All @@ -254,10 +254,10 @@ export class {{classname}}ResponseProcessor {
"{{{returnType}}}", "{{returnFormat}}"
) as {{{returnType}}};
{{/isBinary}}
return new HttpInfo(response.httpStatusCode, response.headers, response.body, body);
return body;
{{/returnType}}
{{^returnType}}
return new HttpInfo(response.httpStatusCode, response.headers, response.body, undefined);
return undefined;
{{/returnType}}
}

Expand Down
12 changes: 1 addition & 11 deletions api/oas_templates/typescript/http/http.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,7 @@ export class SelfDecodingBody implements ResponseBody {
export class ResponseContext {
public constructor(
public httpStatusCode: number,
public httpStatusText: string,
public headers: Headers,
public body: ResponseBody
) {}
Expand Down Expand Up @@ -317,14 +318,3 @@ export function wrapHttpLibrary(promiseHttpLibrary: PromiseHttpLibrary): HttpLib
}
}
}

export class HttpInfo<T> extends ResponseContext {
public constructor(
httpStatusCode: number,
headers: Headers,
body: ResponseBody,
public data: T,
) {
super(httpStatusCode, headers, body);
}
}
2 changes: 1 addition & 1 deletion api/oas_templates/typescript/http/isomorphic-fetch.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export class IsomorphicFetchHttpLibrary implements HttpLibrary {
};
{{/node}}
{{/platforms}}
return new ResponseContext(resp.status, headers, body);
return new ResponseContext(resp.status, resp.statusText, headers, body);
});

return from<Promise<ResponseContext>>(resultPromise);
Expand Down
6 changes: 3 additions & 3 deletions api/oas_templates/typescript/types/ObjectParamAPI.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ResponseContext, RequestContext, HttpFile, HttpInfo } from '../http/http{{importFileExtension}}';
import { ResponseContext, RequestContext, HttpFile } from '../http/http{{importFileExtension}}';
import { Configuration{{^useInversify}}, ConfigurationOptions{{/useInversify}} } from '../configuration{{importFileExtension}}'
{{^useInversify}}
import type { Middleware } from '../middleware{{importFileExtension}}';
Expand Down Expand Up @@ -58,8 +58,8 @@ export class Object{{classname}} {
{{/summary}}
* @param param the request object
*/
public {{nickname}}WithHttpInfo(param: {{classname}}{{operationIdCamelCase}}Request{{^hasRequiredParams}} = {}{{/hasRequiredParams}}, options?: Configuration{{^useInversify}}Options{{/useInversify}}): {{#useRxJS}}Observable{{/useRxJS}}{{^useRxJS}}Promise{{/useRxJS}}<HttpInfo<{{{returnType}}}{{^returnType}}void{{/returnType}}>> {
return this.api.{{nickname}}WithHttpInfo({{#allParams}}param.{{paramName}}, {{/allParams}} options){{^useRxJS}}.toPromise(){{/useRxJS}};
public {{nickname}}Response(param: {{classname}}{{operationIdCamelCase}}Request{{^hasRequiredParams}} = {}{{/hasRequiredParams}}, options?: Configuration{{^useInversify}}Options{{/useInversify}}): {{#useRxJS}}Observable{{/useRxJS}}{{^useRxJS}}Promise{{/useRxJS}}<ResponseContext> {
return this.api.{{nickname}}Response({{#allParams}}param.{{paramName}}, {{/allParams}} options){{^useRxJS}}.toPromise(){{/useRxJS}};
}

/**
Expand Down
9 changes: 5 additions & 4 deletions api/oas_templates/typescript/types/ObservableAPI.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ResponseContext, RequestContext, HttpFile, HttpInfo } from '../http/http{{importFileExtension}}';
import { ResponseContext, RequestContext, HttpFile } from '../http/http{{importFileExtension}}';
import { Configuration{{^useInversify}}, ConfigurationOptions{{/useInversify}} } from '../configuration{{importFileExtension}}'
import type { Middleware } from '../middleware{{importFileExtension}}';
import { Observable, of, from } from {{#useRxJS}}'rxjs'{{/useRxJS}}{{^useRxJS}}'../rxjsStub{{importFileExtension}}'{{/useRxJS}};
Expand Down Expand Up @@ -62,7 +62,7 @@ export class Observable{{classname}} {
* @param {{#required}}{{paramName}}{{/required}}{{^required}}[{{paramName}}]{{/required}}{{#description}} {{description}}{{/description}}
{{/allParams}}
*/
public {{nickname}}WithHttpInfo({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/allParams}}_options?: Configuration{{^useInversify}}Options{{/useInversify}}): Observable<HttpInfo<{{{returnType}}}{{^returnType}}void{{/returnType}}>> {
public {{nickname}}Response({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/allParams}}_options?: Configuration{{^useInversify}}Options{{/useInversify}}): Observable<ResponseContext> {
let _config = this.configuration;
let allMiddleware: Middleware[] = [];
{{#useInversify}}
Expand Down Expand Up @@ -114,7 +114,7 @@ export class Observable{{classname}} {
for (const middleware of allMiddleware.reverse()) {
middlewarePostObservable = middlewarePostObservable.pipe(mergeMap((rsp: ResponseContext) => middleware.post(rsp)));
}
return middlewarePostObservable.pipe(map((rsp: ResponseContext) => this.responseProcessor.{{nickname}}WithHttpInfo(rsp)));
return middlewarePostObservable;
}));
}

Expand All @@ -130,7 +130,8 @@ export class Observable{{classname}} {
{{/allParams}}
*/
public {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/allParams}}_options?: Configuration{{^useInversify}}Options{{/useInversify}}): Observable<{{{returnType}}}{{^returnType}}void{{/returnType}}> {
return this.{{nickname}}WithHttpInfo({{#allParams}}{{paramName}}, {{/allParams}}_options).pipe(map((apiResponse: HttpInfo<{{{returnType}}}{{^returnType}}void{{/returnType}}>) => apiResponse.data));
return this.{{nickname}}Response({{#allParams}}{{paramName}}, {{/allParams}}_options)
.pipe(map((rsp: ResponseContext) => this.responseProcessor.{{nickname}}Response(rsp)));
}

{{/operation}}
Expand Down
6 changes: 3 additions & 3 deletions api/oas_templates/typescript/types/PromiseAPI.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ResponseContext, RequestContext, HttpFile, HttpInfo } from '../http/http{{importFileExtension}}';
import { ResponseContext, RequestContext, HttpFile } from '../http/http{{importFileExtension}}';
import { Configuration{{^useInversify}}, ConfigurationOptions, PromiseConfigurationOptions{{/useInversify}} } from '../configuration{{importFileExtension}}'
{{^useInversify}}
import { PromiseMiddleware, Middleware, PromiseMiddlewareWrapper } from '../middleware{{importFileExtension}}';
Expand Down Expand Up @@ -54,7 +54,7 @@ export class Promise{{classname}} {
* @param {{#required}}{{paramName}}{{/required}}{{^required}}[{{paramName}}]{{/required}}{{#description}} {{description}}{{/description}}
{{/allParams}}
*/
public {{nickname}}WithHttpInfo({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/allParams}}_options?: {{#useInversify}}Configuration{{/useInversify}}{{^useInversify}}PromiseConfigurationOptions{{/useInversify}}): Promise<HttpInfo<{{{returnType}}}{{^returnType}}void{{/returnType}}>> {
public {{nickname}}Response({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/allParams}}_options?: {{#useInversify}}Configuration{{/useInversify}}{{^useInversify}}PromiseConfigurationOptions{{/useInversify}}): Promise<ResponseContext> {
let observableOptions: undefined | Configuration{{^useInversify}}Options{{/useInversify}}{{#useInversify}} = _options{{/useInversify}}
{{^useInversify}}
if (_options){
Expand All @@ -69,7 +69,7 @@ export class Promise{{classname}} {
}
}
{{/useInversify}}
const result = this.api.{{nickname}}WithHttpInfo({{#allParams}}{{paramName}}, {{/allParams}}observableOptions);
const result = this.api.{{nickname}}Response({{#allParams}}{{paramName}}, {{/allParams}}observableOptions);
return result.toPromise();
}

Expand Down