[typescript-angular] add customized encoder to use '+' char in query …

…parameter #6306 (#6334)
swagger-api · Sep 5, 2017 · 84bb749 · 84bb749
1 parent 30fb132
commit 84bb749
Show file tree

Hide file tree

Showing 21 changed files with 190 additions and 91 deletions.
diff --git a/...er-codegen/src/main/java/io/swagger/codegen/languages/TypeScriptAngularClientCodegen.java b/...er-codegen/src/main/java/io/swagger/codegen/languages/TypeScriptAngularClientCodegen.java
@@ -84,6 +84,7 @@ public void processOpts() {
         supportingFiles.add(new SupportingFile("rxjs-operators.mustache", getIndexDirectory(), "rxjs-operators.ts"));        
         supportingFiles.add(new SupportingFile("configuration.mustache", getIndexDirectory(), "configuration.ts"));
         supportingFiles.add(new SupportingFile("variables.mustache", getIndexDirectory(), "variables.ts"));
+        supportingFiles.add(new SupportingFile("encoder.mustache", getIndexDirectory(), "encoder.ts"));
         supportingFiles.add(new SupportingFile("gitignore", "", ".gitignore"));
         supportingFiles.add(new SupportingFile("git_push.sh.mustache", "", "git_push.sh"));
 

diff --git a/modules/swagger-codegen/src/main/resources/typescript-angular/api.service.mustache b/modules/swagger-codegen/src/main/resources/typescript-angular/api.service.mustache
@@ -15,6 +15,7 @@ import { {{classname}} } from '../{{filename}}';
 
 import { BASE_PATH, COLLECTION_FORMATS }                     from '../variables';
 import { Configuration }                                     from '../configuration';
+import { CustomQueryEncoderHelper }                          from '../encoder';
 {{#withInterfaces}}
 import { {{classname}}Interface }                            from './{{classname}}Interface';
 {{/withInterfaces}}
@@ -118,7 +119,7 @@ export class {{classname}} {
         const path = this.basePath + '{{{path}}}'{{#pathParams}}
                     .replace('${' + '{{baseName}}' + '}', String({{paramName}})){{/pathParams}};
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
 {{#allParams}}

diff --git a/modules/swagger-codegen/src/main/resources/typescript-angular/encoder.mustache b/modules/swagger-codegen/src/main/resources/typescript-angular/encoder.mustache
@@ -0,0 +1,17 @@
+import { QueryEncoder } from "@angular/http";
+
+/**
+* CustomQueryEncoderHelper
+* Fix plus sign (+) not encoding, so sent as blank space
+* See: https://github.com/angular/angular/issues/11058#issuecomment-247367318
+*/
+export class CustomQueryEncoderHelper extends QueryEncoder {
+    encodeKey(k: string): string {
+        k = super.encodeKey(k);
+        return k.replace(/\+/gi, '%2B');
+    }
+    encodeValue(v: string): string {
+        v = super.encodeValue(v);
+        return v.replace(/\+/gi, '%2B');
+    }
+}
diff --git a/samples/client/petstore/typescript-angular-v2/default/api/pet.service.ts b/samples/client/petstore/typescript-angular-v2/default/api/pet.service.ts
@@ -25,6 +25,7 @@ import { Pet } from '../model/pet';
 
 import { BASE_PATH, COLLECTION_FORMATS }                     from '../variables';
 import { Configuration }                                     from '../configuration';
+import { CustomQueryEncoderHelper }                          from '../encoder';
 
 
 @Injectable()
@@ -215,7 +216,7 @@ export class PetService {
     public addPetWithHttpInfo(body: Pet, extraHttpRequestParams?: any): Observable<Response> {
         const path = this.basePath + '/pet';
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'body' is not null or undefined
@@ -266,7 +267,7 @@ export class PetService {
         const path = this.basePath + '/pet/${petId}'
                     .replace('${' + 'petId' + '}', String(petId));
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'petId' is not null or undefined
@@ -316,7 +317,7 @@ export class PetService {
     public findPetsByStatusWithHttpInfo(status: Array<string>, extraHttpRequestParams?: any): Observable<Response> {
         const path = this.basePath + '/pet/findByStatus';
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'status' is not null or undefined
@@ -366,7 +367,7 @@ export class PetService {
     public findPetsByTagsWithHttpInfo(tags: Array<string>, extraHttpRequestParams?: any): Observable<Response> {
         const path = this.basePath + '/pet/findByTags';
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'tags' is not null or undefined
@@ -417,7 +418,7 @@ export class PetService {
         const path = this.basePath + '/pet/${petId}'
                     .replace('${' + 'petId' + '}', String(petId));
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'petId' is not null or undefined
@@ -459,7 +460,7 @@ export class PetService {
     public updatePetWithHttpInfo(body: Pet, extraHttpRequestParams?: any): Observable<Response> {
         const path = this.basePath + '/pet';
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'body' is not null or undefined
@@ -511,7 +512,7 @@ export class PetService {
         const path = this.basePath + '/pet/${petId}'
                     .replace('${' + 'petId' + '}', String(petId));
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'petId' is not null or undefined
@@ -578,7 +579,7 @@ export class PetService {
         const path = this.basePath + '/pet/${petId}/uploadImage'
                     .replace('${' + 'petId' + '}', String(petId));
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'petId' is not null or undefined

diff --git a/samples/client/petstore/typescript-angular-v2/default/api/store.service.ts b/samples/client/petstore/typescript-angular-v2/default/api/store.service.ts
@@ -24,6 +24,7 @@ import { Order } from '../model/order';
 
 import { BASE_PATH, COLLECTION_FORMATS }                     from '../variables';
 import { Configuration }                                     from '../configuration';
+import { CustomQueryEncoderHelper }                          from '../encoder';
 
 
 @Injectable()
@@ -145,7 +146,7 @@ export class StoreService {
         const path = this.basePath + '/store/order/${orderId}'
                     .replace('${' + 'orderId' + '}', String(orderId));
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'orderId' is not null or undefined
@@ -181,7 +182,7 @@ export class StoreService {
     public getInventoryWithHttpInfo(extraHttpRequestParams?: any): Observable<Response> {
         const path = this.basePath + '/store/inventory';
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
 
@@ -219,7 +220,7 @@ export class StoreService {
         const path = this.basePath + '/store/order/${orderId}'
                     .replace('${' + 'orderId' + '}', String(orderId));
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'orderId' is not null or undefined
@@ -256,7 +257,7 @@ export class StoreService {
     public placeOrderWithHttpInfo(body: Order, extraHttpRequestParams?: any): Observable<Response> {
         const path = this.basePath + '/store/order';
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'body' is not null or undefined

diff --git a/samples/client/petstore/typescript-angular-v2/default/api/user.service.ts b/samples/client/petstore/typescript-angular-v2/default/api/user.service.ts
@@ -24,6 +24,7 @@ import { User } from '../model/user';
 
 import { BASE_PATH, COLLECTION_FORMATS }                     from '../variables';
 import { Configuration }                                     from '../configuration';
+import { CustomQueryEncoderHelper }                          from '../encoder';
 
 
 @Injectable()
@@ -210,7 +211,7 @@ export class UserService {
     public createUserWithHttpInfo(body: User, extraHttpRequestParams?: any): Observable<Response> {
         const path = this.basePath + '/user';
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'body' is not null or undefined
@@ -250,7 +251,7 @@ export class UserService {
     public createUsersWithArrayInputWithHttpInfo(body: Array<User>, extraHttpRequestParams?: any): Observable<Response> {
         const path = this.basePath + '/user/createWithArray';
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'body' is not null or undefined
@@ -290,7 +291,7 @@ export class UserService {
     public createUsersWithListInputWithHttpInfo(body: Array<User>, extraHttpRequestParams?: any): Observable<Response> {
         const path = this.basePath + '/user/createWithList';
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'body' is not null or undefined
@@ -331,7 +332,7 @@ export class UserService {
         const path = this.basePath + '/user/${username}'
                     .replace('${' + 'username' + '}', String(username));
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'username' is not null or undefined
@@ -369,7 +370,7 @@ export class UserService {
         const path = this.basePath + '/user/${username}'
                     .replace('${' + 'username' + '}', String(username));
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'username' is not null or undefined
@@ -407,7 +408,7 @@ export class UserService {
     public loginUserWithHttpInfo(username: string, password: string, extraHttpRequestParams?: any): Observable<Response> {
         const path = this.basePath + '/user/login';
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'username' is not null or undefined
@@ -455,7 +456,7 @@ export class UserService {
     public logoutUserWithHttpInfo(extraHttpRequestParams?: any): Observable<Response> {
         const path = this.basePath + '/user/logout';
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
 
@@ -490,7 +491,7 @@ export class UserService {
         const path = this.basePath + '/user/${username}'
                     .replace('${' + 'username' + '}', String(username));
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'username' is not null or undefined

diff --git a/samples/client/petstore/typescript-angular-v2/default/encoder.ts b/samples/client/petstore/typescript-angular-v2/default/encoder.ts
@@ -0,0 +1,17 @@
+import { QueryEncoder } from "@angular/http";
+
+/**
+* CustomQueryEncoderHelper
+* Fix plus sign (+) not encoding, so sent as blank space
+* See: https://github.com/angular/angular/issues/11058#issuecomment-247367318
+*/
+export class CustomQueryEncoderHelper extends QueryEncoder {
+    encodeKey(k: string): string {
+        k = super.encodeKey(k);
+        return k.replace(/\+/gi, '%2B');
+    }
+    encodeValue(v: string): string {
+        v = super.encodeValue(v);
+        return v.replace(/\+/gi, '%2B');
+    }
+}
diff --git a/samples/client/petstore/typescript-angular-v2/npm/api/pet.service.ts b/samples/client/petstore/typescript-angular-v2/npm/api/pet.service.ts
@@ -25,6 +25,7 @@ import { Pet } from '../model/pet';
 
 import { BASE_PATH, COLLECTION_FORMATS }                     from '../variables';
 import { Configuration }                                     from '../configuration';
+import { CustomQueryEncoderHelper }                          from '../encoder';
 
 
 @Injectable()
@@ -215,7 +216,7 @@ export class PetService {
     public addPetWithHttpInfo(body: Pet, extraHttpRequestParams?: any): Observable<Response> {
         const path = this.basePath + '/pet';
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'body' is not null or undefined
@@ -266,7 +267,7 @@ export class PetService {
         const path = this.basePath + '/pet/${petId}'
                     .replace('${' + 'petId' + '}', String(petId));
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'petId' is not null or undefined
@@ -316,7 +317,7 @@ export class PetService {
     public findPetsByStatusWithHttpInfo(status: Array<string>, extraHttpRequestParams?: any): Observable<Response> {
         const path = this.basePath + '/pet/findByStatus';
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'status' is not null or undefined
@@ -366,7 +367,7 @@ export class PetService {
     public findPetsByTagsWithHttpInfo(tags: Array<string>, extraHttpRequestParams?: any): Observable<Response> {
         const path = this.basePath + '/pet/findByTags';
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'tags' is not null or undefined
@@ -417,7 +418,7 @@ export class PetService {
         const path = this.basePath + '/pet/${petId}'
                     .replace('${' + 'petId' + '}', String(petId));
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'petId' is not null or undefined
@@ -459,7 +460,7 @@ export class PetService {
     public updatePetWithHttpInfo(body: Pet, extraHttpRequestParams?: any): Observable<Response> {
         const path = this.basePath + '/pet';
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'body' is not null or undefined
@@ -511,7 +512,7 @@ export class PetService {
         const path = this.basePath + '/pet/${petId}'
                     .replace('${' + 'petId' + '}', String(petId));
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'petId' is not null or undefined
@@ -578,7 +579,7 @@ export class PetService {
         const path = this.basePath + '/pet/${petId}/uploadImage'
                     .replace('${' + 'petId' + '}', String(petId));
 
-        let queryParameters = new URLSearchParams();
+        let queryParameters = new URLSearchParams('', new CustomQueryEncoderHelper());
         let headers = new Headers(this.defaultHeaders.toJSON()); // https://github.com/angular/angular/issues/6845
 
         // verify required parameter 'petId' is not null or undefined