[Feat][Typescript Angular] Implement deepObject query params (OAS3.0)

CI/circle_parallel.sh

@@ -74,8 +74,8 @@ elif [ "$NODE_INDEX" = "3" ]; then
   [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
   #nvm install stable
   # install v16 instead of the latest stable version
-  nvm install 16
-  nvm alias default 16
+  nvm install 18
+  nvm alias default 18
   node --version
 
   # Each step uses the same `$BASH_ENV`, so need to modify it

bin/configs/typescript-angular-v19-deep-object.yaml

@@ -0,0 +1,8 @@
+generatorName: typescript-angular
+outputDir: samples/client/petstore/typescript-angular-v19/builds/deep-object
+inputSpec: modules/openapi-generator/src/test/resources/3_0/deep-object-query.yaml
+templateDir: modules/openapi-generator/src/main/resources/typescript-angular
+additionalProperties:
+  ngVersion: 19.0.0
+  npmName: sample-angular-19-0-0-deep-object
+  supportsES6: true

modules/openapi-generator/src/main/resources/typescript-angular/api.base.service.mustache

@@ -29,22 +29,27 @@ export class BaseService {
         return consumes.indexOf('multipart/form-data') !== -1;
     }
 
-    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string): HttpParams {
+    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string, isDeep: boolean = false): HttpParams {
         // If the value is an object (but not a Date), recursively add its keys.
         if (typeof value === 'object' && !(value instanceof Date)) {
-            return this.addToHttpParamsRecursive(httpParams, value);
+            return this.addToHttpParamsRecursive(httpParams, value, isDeep ? key : undefined, isDeep);
         }
         return this.addToHttpParamsRecursive(httpParams, value, key);
     }
 
-    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string): HttpParams {
+    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string, isDeep: boolean = false): HttpParams {
         if (value === null || value === undefined) {
             return httpParams;
         }
         if (typeof value === 'object') {
             // If JSON format is preferred, key must be provided.
             if (key != null) {
-                return httpParams.append(key, JSON.stringify(value));
+                return isDeep
+                    ? Object.keys(value as Record<string, any>).reduce(
+                        (hp, k) => hp.append(`${key}[${k}]`, value[k]),
+                        httpParams,
+                    )
+                    : httpParams.append(key, JSON.stringify(value));
             }
             // Otherwise, if it's an array, add each element.
             if (Array.isArray(value)) {

modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache

@@ -130,7 +130,7 @@ export class {{classname}} extends BaseService {
         {{/isArray}}
         {{^isArray}}
         localVarQueryParameters = this.addToHttpParams(localVarQueryParameters,
-          <any>{{paramName}}, '{{baseName}}');
+          <any>{{paramName}}, '{{baseName}}'{{#isDeepObject}}, true{{/isDeepObject}});
         {{/isArray}}
 {{/queryParams}}
 

modules/openapi-generator/src/test/java/org/openapitools/codegen/typescript/typescriptangular/TypeScriptAngularClientCodegenTest.java

@@ -464,4 +464,29 @@ public void testEnumAsConst() throws IOException {
         assertThat(fileContents).containsOnlyOnce("} as const;");
         assertThat(fileContents).doesNotContain(" as Type");
     }
+
+    @Test
+    public void testDeepObject() throws IOException {
+        // GIVEN
+        final String specPath = "src/test/resources/3_0/deepobject.yaml";
+
+        File output = Files.createTempDirectory("test").toFile();
+        output.deleteOnExit();
+
+        // WHEN
+        final CodegenConfigurator configurator = new CodegenConfigurator()
+            .setGeneratorName("typescript-angular")
+            .setInputSpec(specPath)
+            .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
+
+        final ClientOptInput clientOptInput = configurator.toClientOptInput();
+
+        Generator generator = new DefaultGenerator();
+        generator.opts(clientOptInput).generate();
+
+        // THEN
+        final String fileContents = Files.readString(Paths.get(output + "/api/default.service.ts"));
+        assertThat(fileContents).containsOnlyOnce("<any>options, 'options', true);");
+        assertThat(fileContents).containsOnlyOnce("<any>inputOptions, 'inputOptions', true);");
+    }
 }

modules/openapi-generator/src/test/resources/3_0/deep-object-query.yaml

@@ -0,0 +1,49 @@
+openapi: 3.0.0
+info:
+  title: deepobject-query
+  version: 1.0.0
+paths:
+  /car:
+    get:
+      operationId: getCars
+      parameters:
+        - name: filter
+          in: query
+          required: false
+          style: deepObject
+          schema:
+            $ref: '#/components/schemas/CarFilter'
+          explode: true
+      responses:
+        '200':
+          description: OK
+          content:
+            text/plain:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Car'
+components:
+  schemas:
+    Car:
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+          example: 1
+        make:
+          type: string
+          example: Toyota
+        model:
+          type: string
+          example: Camry
+    CarFilter:
+      type: object
+      properties:
+        make:
+          type: string
+          example: Toyota
+        model:
+          type: string
+          example: Camry

samples/client/others/typescript-angular/builds/composed-schemas-tagged-unions/api.base.service.ts

@@ -37,22 +37,27 @@ export class BaseService {
         return consumes.indexOf('multipart/form-data') !== -1;
     }
 
-    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string): HttpParams {
+    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string, isDeep: boolean = false): HttpParams {
         // If the value is an object (but not a Date), recursively add its keys.
         if (typeof value === 'object' && !(value instanceof Date)) {
-            return this.addToHttpParamsRecursive(httpParams, value);
+            return this.addToHttpParamsRecursive(httpParams, value, isDeep ? key : undefined, isDeep);
         }
         return this.addToHttpParamsRecursive(httpParams, value, key);
     }
 
-    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string): HttpParams {
+    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string, isDeep: boolean = false): HttpParams {
         if (value === null || value === undefined) {
             return httpParams;
         }
         if (typeof value === 'object') {
             // If JSON format is preferred, key must be provided.
             if (key != null) {
-                return httpParams.append(key, JSON.stringify(value));
+                return isDeep
+                    ? Object.keys(value as Record<string, any>).reduce(
+                        (hp, k) => hp.append(`${key}[${k}]`, value[k]),
+                        httpParams,
+                    )
+                    : httpParams.append(key, JSON.stringify(value));
             }
             // Otherwise, if it's an array, add each element.
             if (Array.isArray(value)) {

samples/client/others/typescript-angular/builds/composed-schemas/api.base.service.ts

@@ -37,22 +37,27 @@ export class BaseService {
         return consumes.indexOf('multipart/form-data') !== -1;
     }
 
-    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string): HttpParams {
+    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string, isDeep: boolean = false): HttpParams {
         // If the value is an object (but not a Date), recursively add its keys.
         if (typeof value === 'object' && !(value instanceof Date)) {
-            return this.addToHttpParamsRecursive(httpParams, value);
+            return this.addToHttpParamsRecursive(httpParams, value, isDeep ? key : undefined, isDeep);
         }
         return this.addToHttpParamsRecursive(httpParams, value, key);
     }
 
-    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string): HttpParams {
+    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string, isDeep: boolean = false): HttpParams {
         if (value === null || value === undefined) {
             return httpParams;
         }
         if (typeof value === 'object') {
             // If JSON format is preferred, key must be provided.
             if (key != null) {
-                return httpParams.append(key, JSON.stringify(value));
+                return isDeep
+                    ? Object.keys(value as Record<string, any>).reduce(
+                        (hp, k) => hp.append(`${key}[${k}]`, value[k]),
+                        httpParams,
+                    )
+                    : httpParams.append(key, JSON.stringify(value));
             }
             // Otherwise, if it's an array, add each element.
             if (Array.isArray(value)) {

samples/client/petstore/typescript-angular-v12-oneOf/builds/default/api.base.service.ts

@@ -37,22 +37,27 @@ export class BaseService {
         return consumes.indexOf('multipart/form-data') !== -1;
     }
 
-    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string): HttpParams {
+    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string, isDeep: boolean = false): HttpParams {
         // If the value is an object (but not a Date), recursively add its keys.
         if (typeof value === 'object' && !(value instanceof Date)) {
-            return this.addToHttpParamsRecursive(httpParams, value);
+            return this.addToHttpParamsRecursive(httpParams, value, isDeep ? key : undefined, isDeep);
         }
         return this.addToHttpParamsRecursive(httpParams, value, key);
     }
 
-    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string): HttpParams {
+    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string, isDeep: boolean = false): HttpParams {
         if (value === null || value === undefined) {
             return httpParams;
         }
         if (typeof value === 'object') {
             // If JSON format is preferred, key must be provided.
             if (key != null) {
-                return httpParams.append(key, JSON.stringify(value));
+                return isDeep
+                    ? Object.keys(value as Record<string, any>).reduce(
+                        (hp, k) => hp.append(`${key}[${k}]`, value[k]),
+                        httpParams,
+                    )
+                    : httpParams.append(key, JSON.stringify(value));
             }
             // Otherwise, if it's an array, add each element.
             if (Array.isArray(value)) {

samples/client/petstore/typescript-angular-v12-provided-in-any/builds/default/api.base.service.ts

@@ -37,22 +37,27 @@ export class BaseService {
         return consumes.indexOf('multipart/form-data') !== -1;
     }
 
-    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string): HttpParams {
+    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string, isDeep: boolean = false): HttpParams {
         // If the value is an object (but not a Date), recursively add its keys.
         if (typeof value === 'object' && !(value instanceof Date)) {
-            return this.addToHttpParamsRecursive(httpParams, value);
+            return this.addToHttpParamsRecursive(httpParams, value, isDeep ? key : undefined, isDeep);
         }
         return this.addToHttpParamsRecursive(httpParams, value, key);
     }
 
-    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string): HttpParams {
+    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string, isDeep: boolean = false): HttpParams {
         if (value === null || value === undefined) {
             return httpParams;
         }
         if (typeof value === 'object') {
             // If JSON format is preferred, key must be provided.
             if (key != null) {
-                return httpParams.append(key, JSON.stringify(value));
+                return isDeep
+                    ? Object.keys(value as Record<string, any>).reduce(
+                        (hp, k) => hp.append(`${key}[${k}]`, value[k]),
+                        httpParams,
+                    )
+                    : httpParams.append(key, JSON.stringify(value));
             }
             // Otherwise, if it's an array, add each element.
             if (Array.isArray(value)) {

samples/client/petstore/typescript-angular-v12-provided-in-root/builds/default/api.base.service.ts

@@ -37,22 +37,27 @@ export class BaseService {
         return consumes.indexOf('multipart/form-data') !== -1;
     }
 
-    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string): HttpParams {
+    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string, isDeep: boolean = false): HttpParams {
         // If the value is an object (but not a Date), recursively add its keys.
         if (typeof value === 'object' && !(value instanceof Date)) {
-            return this.addToHttpParamsRecursive(httpParams, value);
+            return this.addToHttpParamsRecursive(httpParams, value, isDeep ? key : undefined, isDeep);
         }
         return this.addToHttpParamsRecursive(httpParams, value, key);
     }
 
-    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string): HttpParams {
+    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string, isDeep: boolean = false): HttpParams {
         if (value === null || value === undefined) {
             return httpParams;
         }
         if (typeof value === 'object') {
             // If JSON format is preferred, key must be provided.
             if (key != null) {
-                return httpParams.append(key, JSON.stringify(value));
+                return isDeep
+                    ? Object.keys(value as Record<string, any>).reduce(
+                        (hp, k) => hp.append(`${key}[${k}]`, value[k]),
+                        httpParams,
+                    )
+                    : httpParams.append(key, JSON.stringify(value));
             }
             // Otherwise, if it's an array, add each element.
             if (Array.isArray(value)) {

samples/client/petstore/typescript-angular-v12-provided-in-root/builds/with-npm/api.base.service.ts

@@ -37,22 +37,27 @@ export class BaseService {
         return consumes.indexOf('multipart/form-data') !== -1;
     }
 
-    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string): HttpParams {
+    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string, isDeep: boolean = false): HttpParams {
         // If the value is an object (but not a Date), recursively add its keys.
         if (typeof value === 'object' && !(value instanceof Date)) {
-            return this.addToHttpParamsRecursive(httpParams, value);
+            return this.addToHttpParamsRecursive(httpParams, value, isDeep ? key : undefined, isDeep);
         }
         return this.addToHttpParamsRecursive(httpParams, value, key);
     }
 
-    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string): HttpParams {
+    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string, isDeep: boolean = false): HttpParams {
         if (value === null || value === undefined) {
             return httpParams;
         }
         if (typeof value === 'object') {
             // If JSON format is preferred, key must be provided.
             if (key != null) {
-                return httpParams.append(key, JSON.stringify(value));
+                return isDeep
+                    ? Object.keys(value as Record<string, any>).reduce(
+                        (hp, k) => hp.append(`${key}[${k}]`, value[k]),
+                        httpParams,
+                    )
+                    : httpParams.append(key, JSON.stringify(value));
             }
             // Otherwise, if it's an array, add each element.
             if (Array.isArray(value)) {

samples/client/petstore/typescript-angular-v13-oneOf/builds/default/api.base.service.ts

@@ -37,22 +37,27 @@ export class BaseService {
         return consumes.indexOf('multipart/form-data') !== -1;
     }
 
-    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string): HttpParams {
+    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string, isDeep: boolean = false): HttpParams {
         // If the value is an object (but not a Date), recursively add its keys.
         if (typeof value === 'object' && !(value instanceof Date)) {
-            return this.addToHttpParamsRecursive(httpParams, value);
+            return this.addToHttpParamsRecursive(httpParams, value, isDeep ? key : undefined, isDeep);
         }
         return this.addToHttpParamsRecursive(httpParams, value, key);
     }
 
-    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string): HttpParams {
+    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string, isDeep: boolean = false): HttpParams {
         if (value === null || value === undefined) {
             return httpParams;
         }
         if (typeof value === 'object') {
             // If JSON format is preferred, key must be provided.
             if (key != null) {
-                return httpParams.append(key, JSON.stringify(value));
+                return isDeep
+                    ? Object.keys(value as Record<string, any>).reduce(
+                        (hp, k) => hp.append(`${key}[${k}]`, value[k]),
+                        httpParams,
+                    )
+                    : httpParams.append(key, JSON.stringify(value));
             }
             // Otherwise, if it's an array, add each element.
             if (Array.isArray(value)) {

samples/client/petstore/typescript-angular-v13-provided-in-any/builds/default/api.base.service.ts

@@ -37,22 +37,27 @@ export class BaseService {
         return consumes.indexOf('multipart/form-data') !== -1;
     }
 
-    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string): HttpParams {
+    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string, isDeep: boolean = false): HttpParams {
         // If the value is an object (but not a Date), recursively add its keys.
         if (typeof value === 'object' && !(value instanceof Date)) {
-            return this.addToHttpParamsRecursive(httpParams, value);
+            return this.addToHttpParamsRecursive(httpParams, value, isDeep ? key : undefined, isDeep);
         }
         return this.addToHttpParamsRecursive(httpParams, value, key);
     }
 
-    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string): HttpParams {
+    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string, isDeep: boolean = false): HttpParams {
         if (value === null || value === undefined) {
             return httpParams;
         }
         if (typeof value === 'object') {
             // If JSON format is preferred, key must be provided.
             if (key != null) {
-                return httpParams.append(key, JSON.stringify(value));
+                return isDeep
+                    ? Object.keys(value as Record<string, any>).reduce(
+                        (hp, k) => hp.append(`${key}[${k}]`, value[k]),
+                        httpParams,
+                    )
+                    : httpParams.append(key, JSON.stringify(value));
             }
             // Otherwise, if it's an array, add each element.
             if (Array.isArray(value)) {