fix(ts-interface-generator): fix return type of removeAggregation (#471)

fixes #470
SAP · Sep 10, 2024 · 8164fb6 · 8164fb6
1 parent aa36d21
commit 8164fb6
Show file tree

Hide file tree

Showing 8 changed files with 742 additions and 759 deletions.
diff --git a/packages/ts-interface-generator/package.json b/packages/ts-interface-generator/package.json
@@ -38,7 +38,7 @@
     "@types/hjson": "2.4.6",
     "@types/jest": "29.5.12",
     "@types/node": "20.14.9",
-    "@types/openui5": "1.117.0",
+    "@types/openui5": "1.127.0",
     "@types/yargs": "17.0.32",
     "@typescript-eslint/eslint-plugin": "7.14.1",
     "@typescript-eslint/parser": "7.14.1",

diff --git a/packages/ts-interface-generator/src/astGenerationHelper.ts b/packages/ts-interface-generator/src/astGenerationHelper.ts
@@ -579,7 +579,16 @@ function generateMethods(
             ]),
           ),
         ],
-        factory.createThisTypeNode(),
+        factory.createUnionTypeNode([
+          // the removed child or null if not found
+          createTSTypeNode(
+            aggregation.type,
+            requiredImports,
+            knownGlobals,
+            currentClassName,
+          ),
+          factory.createLiteralTypeNode(ts.factory.createNull()),
+        ]),
       );
       addJSDocCommentToNode(
         remove,

diff --git a/packages/ts-interface-generator/src/test/generateMethods.test.ts b/packages/ts-interface-generator/src/test/generateMethods.test.ts
@@ -40,7 +40,7 @@ test("Generate methods for aggregation", () => {
 getContent(): Control[];
 addContent(content: Control): this;
 insertContent(content: Control, index: number): this;
-removeContent(content: number | string | Control): this;
+removeContent(content: number | string | Control): Control | null;
 removeAllContent(): Control[];
 indexOfContent(content: Control): number;
 destroyContent(): this;

diff --git a/packages/ts-interface-generator/src/test/interfaceGenerationHelper.test.ts b/packages/ts-interface-generator/src/test/interfaceGenerationHelper.test.ts
@@ -188,7 +188,7 @@ declare module "./SampleControl" {
          * @param content The content to remove or its index or id
          * @returns The removed content or "null"
          */
-        removeContent(content: number | string | Control): this;
+        removeContent(content: number | string | Control): Control | null;
 
         /**
          * Removes all the controls from the aggregation "content".
@@ -511,7 +511,7 @@ declare module "./SampleControl" {
          * @param content The content to remove or its index or id
          * @returns The removed content or "null"
          */
-        removeContent(content: number | string | Control): this;
+        removeContent(content: number | string | Control): Control | null;
 
         /**
          * Removes all the controls from the aggregation "content".

diff --git a/packages/ts-interface-generator/src/test/testdata/sampleControl/SampleControl.gen.d.ts b/packages/ts-interface-generator/src/test/testdata/sampleControl/SampleControl.gen.d.ts
@@ -142,7 +142,7 @@ declare module "./SampleControl" {
          * @param content The content to remove or its index or id
          * @returns The removed content or "null"
          */
-        removeContent(content: number | string | Control): this;
+        removeContent(content: number | string | Control): Control | null;
 
         /**
          * Removes all the controls from the aggregation "content".
@@ -465,7 +465,7 @@ declare module "./SampleControl" {
          * @param content The content to remove or its index or id
          * @returns The removed content or "null"
          */
-        removeContent(content: number | string | Control): this;
+        removeContent(content: number | string | Control): Control | null;
 
         /**
          * Removes all the controls from the aggregation "content".