Skip to content

[typescript-fetch] Fix uploading files #2900

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
wing328 merged 21 commits into from
May 31, 2019
Merged

[typescript-fetch] Fix uploading files #2900

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
e6b745c
[typescript-fetch] Fix uploading files
janbuchar May 15, 2019
8bdc162
Check for Blob instead of File
janbuchar May 16, 2019
4a6b00e
Merge remote-tracking branch 'upstream/master' into typescript-fetch-…
janbuchar May 20, 2019
f621eaa
Update samples
janbuchar May 20, 2019
412217b
Merge branch 'master' into typescript-fetch-file-upload
janbuchar May 20, 2019
04003ee
Update samples
janbuchar May 20, 2019
73ac448
Update samples
janbuchar May 20, 2019
0d1cfc8
Update samples
janbuchar May 20, 2019
d73aff5
Merge remote-tracking branch 'upstream/master' into typescript-fetch-…
janbuchar May 22, 2019
df125e6
Regenerate samples
janbuchar May 22, 2019
bf7ee5e
Bug
janbuchar May 22, 2019
d8514aa
Manually fix samples
janbuchar May 22, 2019
b8f470e
Merge remote-tracking branch 'upstream/master' into typescript-fetch-…
janbuchar May 23, 2019
68cd6dc
Implement support for Buffer and Blob in a backwards-compatible way
janbuchar May 23, 2019
915868a
Rework how blob and buffer instance checking works
janbuchar May 24, 2019
a1a3a6d
Check for Blob/Buffer existence properly
janbuchar May 24, 2019
f61c1c2
Avoid using Buffer and Blob in type declarations
janbuchar May 24, 2019
016170d
Merge remote-tracking branch 'upstream/master' into typescript-fetch-…
janbuchar May 29, 2019
8adcb8e
Remove Buffer support
janbuchar May 29, 2019
f5c1ed2
Update samples/client/petstore/typescript-fetch/tests/default/test/Pe…
janbuchar May 29, 2019
2ea96f7
Update samples/client/petstore/typescript-fetch/tests/default/test/Pe…
janbuchar May 29, 2019
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
Prev Previous commit
Next Next commit
Check for Blob/Buffer existence properly
  • Loading branch information
@janbuchar
janbuchar committed May 24, 2019
commit a1a3a6da3b9476318f1315586dd19866bb08fded
4 changes: 2 additions & 2 deletions modules/openapi-generator/src/main/resources/typescript-fetch/runtime.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

export const BASE_PATH = "{{{basePath}}}".replace(/\/+$/, "");

const isBlob = (value: any) => Blob !== undefined && value instanceof Blob;
const isBuffer = (value: any) => Buffer !== undefined && value instanceof Buffer;
const isBlob = (value: any) => typeof Blob !== 'undefined' && value instanceof Blob;
const isBuffer = (value: any) => typeof Buffer !== 'undefined' && value instanceof Buffer;
Copy link
Member

@macjohnny macjohnny May 24, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe it is easier to only support Blob, since Buffer does not exist in the dom typings https://github.com/Microsoft/TypeScript/blob/master/lib/lib.dom.d.ts
or we need to add typings which include Buffer

Copy link
Contributor Author

@janbuchar janbuchar May 27, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be enough to install @types/node, which seems pretty sensible.

Copy link
Member

@macjohnny macjohnny May 27, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but I imagine a user wouldn't want to install @types/node for a web project, since the node API won't be available in the web...

Copy link
Contributor Author

@janbuchar janbuchar May 27, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think a user would care much... create-react-app for typescript installs @types/node too.


/**
* This is the base class for all generated API classes.
Expand Down
25 changes: 10 additions & 15 deletions samples/client/petstore/typescript-fetch/builds/default/apis/PetApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import {
} from '../models';

export interface AddPetRequest {
pet: Pet;
body: Pet;
}

export interface DeletePetRequest {
Expand All @@ -37,15 +37,14 @@ export interface FindPetsByStatusRequest {

export interface FindPetsByTagsRequest {
tags: Array<string>;
maxCount?: number;
}

export interface GetPetByIdRequest {
petId: number;
}

export interface UpdatePetRequest {
pet: Pet;
body: Pet;
}

export interface UpdatePetWithFormRequest {
Expand All @@ -69,8 +68,8 @@ export class PetApi extends runtime.BaseAPI {
* Add a new pet to the store
*/
async addPetRaw(requestParameters: AddPetRequest): Promise<runtime.ApiResponse<void>> {
if (requestParameters.pet === null || requestParameters.pet === undefined) {
throw new runtime.RequiredError('pet','Required parameter requestParameters.pet was null or undefined when calling addPet.');
if (requestParameters.body === null || requestParameters.body === undefined) {
throw new runtime.RequiredError('body','Required parameter requestParameters.body was null or undefined when calling addPet.');
}

const queryParameters: runtime.HTTPQuery = {};
Expand All @@ -93,7 +92,7 @@ export class PetApi extends runtime.BaseAPI {
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: PetToJSON(requestParameters.pet),
body: PetToJSON(requestParameters.body),
});

return new runtime.VoidApiResponse(response);
Expand Down Expand Up @@ -168,7 +167,7 @@ export class PetApi extends runtime.BaseAPI {
if (this.configuration && this.configuration.accessToken) {
// oauth required
if (typeof this.configuration.accessToken === 'function') {
headerParameters["Authorization"] = this.configuration.accessToken("petstore_auth", ["read:pets"]);
headerParameters["Authorization"] = this.configuration.accessToken("petstore_auth", ["write:pets", "read:pets"]);
} else {
headerParameters["Authorization"] = this.configuration.accessToken;
}
Expand Down Expand Up @@ -208,16 +207,12 @@ export class PetApi extends runtime.BaseAPI {
queryParameters['tags'] = requestParameters.tags.join(runtime.COLLECTION_FORMATS["csv"]);
}

if (requestParameters.maxCount !== undefined) {
queryParameters['maxCount'] = requestParameters.maxCount;
}

const headerParameters: runtime.HTTPHeaders = {};

if (this.configuration && this.configuration.accessToken) {
// oauth required
if (typeof this.configuration.accessToken === 'function') {
headerParameters["Authorization"] = this.configuration.accessToken("petstore_auth", ["read:pets"]);
headerParameters["Authorization"] = this.configuration.accessToken("petstore_auth", ["write:pets", "read:pets"]);
} else {
headerParameters["Authorization"] = this.configuration.accessToken;
}
Expand Down Expand Up @@ -282,8 +277,8 @@ export class PetApi extends runtime.BaseAPI {
* Update an existing pet
*/
async updatePetRaw(requestParameters: UpdatePetRequest): Promise<runtime.ApiResponse<void>> {
if (requestParameters.pet === null || requestParameters.pet === undefined) {
throw new runtime.RequiredError('pet','Required parameter requestParameters.pet was null or undefined when calling updatePet.');
if (requestParameters.body === null || requestParameters.body === undefined) {
throw new runtime.RequiredError('body','Required parameter requestParameters.body was null or undefined when calling updatePet.');
}

const queryParameters: runtime.HTTPQuery = {};
Expand All @@ -306,7 +301,7 @@ export class PetApi extends runtime.BaseAPI {
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: PetToJSON(requestParameters.pet),
body: PetToJSON(requestParameters.body),
});

return new runtime.VoidApiResponse(response);
Expand Down
8 changes: 4 additions & 4 deletions samples/client/petstore/typescript-fetch/builds/default/apis/StoreApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface GetOrderByIdRequest {
}

export interface PlaceOrderRequest {
order: Order;
body: Order;
}

/**
Expand Down Expand Up @@ -135,8 +135,8 @@ export class StoreApi extends runtime.BaseAPI {
* Place an order for a pet
*/
async placeOrderRaw(requestParameters: PlaceOrderRequest): Promise<runtime.ApiResponse<Order>> {
if (requestParameters.order === null || requestParameters.order === undefined) {
throw new runtime.RequiredError('order','Required parameter requestParameters.order was null or undefined when calling placeOrder.');
if (requestParameters.body === null || requestParameters.body === undefined) {
throw new runtime.RequiredError('body','Required parameter requestParameters.body was null or undefined when calling placeOrder.');
}

const queryParameters: runtime.HTTPQuery = {};
Expand All @@ -150,7 +150,7 @@ export class StoreApi extends runtime.BaseAPI {
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: OrderToJSON(requestParameters.order),
body: OrderToJSON(requestParameters.body),
});

return new runtime.JSONApiResponse(response, (jsonValue) => OrderFromJSON(jsonValue));
Expand Down
32 changes: 16 additions & 16 deletions samples/client/petstore/typescript-fetch/builds/default/apis/UserApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ import {
} from '../models';

export interface CreateUserRequest {
user: User;
body: User;
}

export interface CreateUsersWithArrayInputRequest {
user: Array<User>;
body: Array<User>;
}

export interface CreateUsersWithListInputRequest {
user: Array<User>;
body: Array<User>;
}

export interface DeleteUserRequest {
Expand All @@ -46,7 +46,7 @@ export interface LoginUserRequest {

export interface UpdateUserRequest {
username: string;
user: User;
body: User;
}

/**
Expand All @@ -59,8 +59,8 @@ export class UserApi extends runtime.BaseAPI {
* Create user
*/
async createUserRaw(requestParameters: CreateUserRequest): Promise<runtime.ApiResponse<void>> {
if (requestParameters.user === null || requestParameters.user === undefined) {
throw new runtime.RequiredError('user','Required parameter requestParameters.user was null or undefined when calling createUser.');
if (requestParameters.body === null || requestParameters.body === undefined) {
throw new runtime.RequiredError('body','Required parameter requestParameters.body was null or undefined when calling createUser.');
}

const queryParameters: runtime.HTTPQuery = {};
Expand All @@ -74,7 +74,7 @@ export class UserApi extends runtime.BaseAPI {
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: UserToJSON(requestParameters.user),
body: UserToJSON(requestParameters.body),
});

return new runtime.VoidApiResponse(response);
Expand All @@ -92,8 +92,8 @@ export class UserApi extends runtime.BaseAPI {
* Creates list of users with given input array
*/
async createUsersWithArrayInputRaw(requestParameters: CreateUsersWithArrayInputRequest): Promise<runtime.ApiResponse<void>> {
if (requestParameters.user === null || requestParameters.user === undefined) {
throw new runtime.RequiredError('user','Required parameter requestParameters.user was null or undefined when calling createUsersWithArrayInput.');
if (requestParameters.body === null || requestParameters.body === undefined) {
throw new runtime.RequiredError('body','Required parameter requestParameters.body was null or undefined when calling createUsersWithArrayInput.');
}

const queryParameters: runtime.HTTPQuery = {};
Expand All @@ -107,7 +107,7 @@ export class UserApi extends runtime.BaseAPI {
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: requestParameters.user.map(UserToJSON),
body: requestParameters.body.map(UserToJSON),
});

return new runtime.VoidApiResponse(response);
Expand All @@ -124,8 +124,8 @@ export class UserApi extends runtime.BaseAPI {
* Creates list of users with given input array
*/
async createUsersWithListInputRaw(requestParameters: CreateUsersWithListInputRequest): Promise<runtime.ApiResponse<void>> {
if (requestParameters.user === null || requestParameters.user === undefined) {
throw new runtime.RequiredError('user','Required parameter requestParameters.user was null or undefined when calling createUsersWithListInput.');
if (requestParameters.body === null || requestParameters.body === undefined) {
throw new runtime.RequiredError('body','Required parameter requestParameters.body was null or undefined when calling createUsersWithListInput.');
}

const queryParameters: runtime.HTTPQuery = {};
Expand All @@ -139,7 +139,7 @@ export class UserApi extends runtime.BaseAPI {
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: requestParameters.user.map(UserToJSON),
body: requestParameters.body.map(UserToJSON),
});

return new runtime.VoidApiResponse(response);
Expand Down Expand Up @@ -289,8 +289,8 @@ export class UserApi extends runtime.BaseAPI {
throw new runtime.RequiredError('username','Required parameter requestParameters.username was null or undefined when calling updateUser.');
}

if (requestParameters.user === null || requestParameters.user === undefined) {
throw new runtime.RequiredError('user','Required parameter requestParameters.user was null or undefined when calling updateUser.');
if (requestParameters.body === null || requestParameters.body === undefined) {
throw new runtime.RequiredError('body','Required parameter requestParameters.body was null or undefined when calling updateUser.');
}

const queryParameters: runtime.HTTPQuery = {};
Expand All @@ -304,7 +304,7 @@ export class UserApi extends runtime.BaseAPI {
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: UserToJSON(requestParameters.user),
body: UserToJSON(requestParameters.body),
});

return new runtime.VoidApiResponse(response);
Expand Down
2 changes: 0 additions & 2 deletions samples/client/petstore/typescript-fetch/builds/default/models/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
export * from './Category';
export * from './InlineObject';
export * from './InlineObject1';
export * from './ModelApiResponse';
export * from './Order';
export * from './Pet';
Expand Down
4 changes: 2 additions & 2 deletions samples/client/petstore/typescript-fetch/builds/default/runtime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@

export const BASE_PATH = "http://petstore.swagger.io/v2".replace(/\/+$/, "");

const isBlob = (value: any) => Blob !== undefined && value instanceof Blob;
const isBuffer = (value: any) => Buffer !== undefined && value instanceof Buffer;
const isBlob = (value: any) => typeof Blob !== 'undefined' && value instanceof Blob;
const isBuffer = (value: any) => typeof Buffer !== 'undefined' && value instanceof Buffer;

/**
* This is the base class for all generated API classes.
Expand Down
25 changes: 10 additions & 15 deletions samples/client/petstore/typescript-fetch/builds/es6-target/apis/PetApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import {
} from '../models';

export interface AddPetRequest {
pet: Pet;
body: Pet;
}

export interface DeletePetRequest {
Expand All @@ -37,15 +37,14 @@ export interface FindPetsByStatusRequest {

export interface FindPetsByTagsRequest {
tags: Array<string>;
maxCount?: number;
}

export interface GetPetByIdRequest {
petId: number;
}

export interface UpdatePetRequest {
pet: Pet;
body: Pet;
}

export interface UpdatePetWithFormRequest {
Expand All @@ -69,8 +68,8 @@ export class PetApi extends runtime.BaseAPI {
* Add a new pet to the store
*/
async addPetRaw(requestParameters: AddPetRequest): Promise<runtime.ApiResponse<void>> {
if (requestParameters.pet === null || requestParameters.pet === undefined) {
throw new runtime.RequiredError('pet','Required parameter requestParameters.pet was null or undefined when calling addPet.');
if (requestParameters.body === null || requestParameters.body === undefined) {
throw new runtime.RequiredError('body','Required parameter requestParameters.body was null or undefined when calling addPet.');
}

const queryParameters: runtime.HTTPQuery = {};
Expand All @@ -93,7 +92,7 @@ export class PetApi extends runtime.BaseAPI {
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: PetToJSON(requestParameters.pet),
body: PetToJSON(requestParameters.body),
});

return new runtime.VoidApiResponse(response);
Expand Down Expand Up @@ -168,7 +167,7 @@ export class PetApi extends runtime.BaseAPI {
if (this.configuration && this.configuration.accessToken) {
// oauth required
if (typeof this.configuration.accessToken === 'function') {
headerParameters["Authorization"] = this.configuration.accessToken("petstore_auth", ["read:pets"]);
headerParameters["Authorization"] = this.configuration.accessToken("petstore_auth", ["write:pets", "read:pets"]);
} else {
headerParameters["Authorization"] = this.configuration.accessToken;
}
Expand Down Expand Up @@ -208,16 +207,12 @@ export class PetApi extends runtime.BaseAPI {
queryParameters['tags'] = requestParameters.tags.join(runtime.COLLECTION_FORMATS["csv"]);
}

if (requestParameters.maxCount !== undefined) {
queryParameters['maxCount'] = requestParameters.maxCount;
}

const headerParameters: runtime.HTTPHeaders = {};

if (this.configuration && this.configuration.accessToken) {
// oauth required
if (typeof this.configuration.accessToken === 'function') {
headerParameters["Authorization"] = this.configuration.accessToken("petstore_auth", ["read:pets"]);
headerParameters["Authorization"] = this.configuration.accessToken("petstore_auth", ["write:pets", "read:pets"]);
Copy link
Member

@macjohnny macjohnny May 23, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why does this change?

Copy link
Member

@wing328 wing328 May 23, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be due to a fix in oauth scope to propagate these values probably.

} else {
headerParameters["Authorization"] = this.configuration.accessToken;
}
Expand Down Expand Up @@ -282,8 +277,8 @@ export class PetApi extends runtime.BaseAPI {
* Update an existing pet
*/
async updatePetRaw(requestParameters: UpdatePetRequest): Promise<runtime.ApiResponse<void>> {
if (requestParameters.pet === null || requestParameters.pet === undefined) {
throw new runtime.RequiredError('pet','Required parameter requestParameters.pet was null or undefined when calling updatePet.');
if (requestParameters.body === null || requestParameters.body === undefined) {
throw new runtime.RequiredError('body','Required parameter requestParameters.body was null or undefined when calling updatePet.');
}

const queryParameters: runtime.HTTPQuery = {};
Expand All @@ -306,7 +301,7 @@ export class PetApi extends runtime.BaseAPI {
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: PetToJSON(requestParameters.pet),
body: PetToJSON(requestParameters.body),
});

return new runtime.VoidApiResponse(response);
Expand Down
8 changes: 4 additions & 4 deletions samples/client/petstore/typescript-fetch/builds/es6-target/apis/StoreApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface GetOrderByIdRequest {
}

export interface PlaceOrderRequest {
order: Order;
body: Order;
}

/**
Expand Down Expand Up @@ -135,8 +135,8 @@ export class StoreApi extends runtime.BaseAPI {
* Place an order for a pet
*/
async placeOrderRaw(requestParameters: PlaceOrderRequest): Promise<runtime.ApiResponse<Order>> {
if (requestParameters.order === null || requestParameters.order === undefined) {
throw new runtime.RequiredError('order','Required parameter requestParameters.order was null or undefined when calling placeOrder.');
if (requestParameters.body === null || requestParameters.body === undefined) {
throw new runtime.RequiredError('body','Required parameter requestParameters.body was null or undefined when calling placeOrder.');
}

const queryParameters: runtime.HTTPQuery = {};
Expand All @@ -150,7 +150,7 @@ export class StoreApi extends runtime.BaseAPI {
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: OrderToJSON(requestParameters.order),
body: OrderToJSON(requestParameters.body),
});

return new runtime.JSONApiResponse(response, (jsonValue) => OrderFromJSON(jsonValue));
Expand Down
Loading