feat: Add support noImplicitOverride config option (#4687)

* add support for method overrides * added changelog * update test-services --------- Co-authored-by: Tom Frenken <[email protected]>
SAP · May 22, 2024 · 022adae · 022adae
1 parent 0326eb8
commit 022adae
Show file tree

Hide file tree

Showing 89 changed files with 150 additions and 139 deletions.
diff --git a/.changeset/curvy-carpets-talk.md b/.changeset/curvy-carpets-talk.md
@@ -0,0 +1,5 @@
+---
+"@sap-cloud-sdk/generator": minor
+---
+
+Generated clients support `noImplicitOverride` config option in `tsconfig.json`.
diff --git a/packages/generator/src/entity/class.spec.ts b/packages/generator/src/entity/class.spec.ts
@@ -24,13 +24,17 @@ describe('entity class generator generates a class', () => {
     const staticProperties = classDeclaration.properties!.filter(
       prop => prop.isStatic
     );
-    expect(staticProperties.map(prop => [prop.name, prop.initializer])).toEqual(
-      [
-        ['_entityName', `'${breakfastEntity.entitySetName}'`],
-        ['_defaultBasePath', `'${foodService.serviceOptions.basePath}'`],
-        ['_keys', "['EntityName','BreakfastTime']"]
-      ]
-    );
+    expect(
+      staticProperties.map(prop => [
+        prop.name,
+        prop.initializer,
+        prop.hasOverrideKeyword
+      ])
+    ).toEqual([
+      ['_entityName', `'${breakfastEntity.entitySetName}'`, true],
+      ['_defaultBasePath', `'${foodService.serviceOptions.basePath}'`, true],
+      ['_keys', "['EntityName','BreakfastTime']"]
+    ]);
   });
 
   it('has expected instance properties', () => {

diff --git a/packages/generator/src/entity/class.ts b/packages/generator/src/entity/class.ts
@@ -66,6 +66,7 @@ function entityName(entity: VdmEntity): PropertyDeclarationStructure {
     kind: StructureKind.Property,
     name: prependPrefix('entityName'),
     isStatic: true,
+    hasOverrideKeyword: true,
     initializer: `'${entity.entitySetName}'`,
     docs: [addLeadingNewline(`Technical entity name for ${entity.className}.`)]
   };
@@ -78,6 +79,7 @@ function defaultBasePath(
     kind: StructureKind.Property,
     name: prependPrefix('defaultBasePath'),
     isStatic: true,
+    hasOverrideKeyword: true,
     initializer: `'${service.serviceOptions.basePath}'`,
     docs: [addLeadingNewline('Default url path for the according service.')]
   };

diff --git a/.../TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/Airlines.js.map b/.../TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/Airlines.js.map
diff --git a/...-e2e/TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/Airlines.ts b/...-e2e/TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/Airlines.ts
@@ -21,11 +21,11 @@ export class Airlines<T extends DeSerializers = DefaultDeSerializers>
   /**
    * Technical entity name for Airlines.
    */
-  static _entityName = 'Airlines';
+  static override _entityName = 'Airlines';
   /**
    * Default url path for the according service.
    */
-  static _defaultBasePath =
+  static override _defaultBasePath =
     'V4/(S(duh2c3dgb1c5lzc0bqwgyekc))/TripPinServiceRW/';
   /**
    * All key fields of the Airlines entity

diff --git a/.../TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/Airports.js.map b/.../TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/Airports.js.map
diff --git a/...-e2e/TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/Airports.ts b/...-e2e/TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/Airports.ts
@@ -22,11 +22,11 @@ export class Airports<T extends DeSerializers = DefaultDeSerializers>
   /**
    * Technical entity name for Airports.
    */
-  static _entityName = 'Airports';
+  static override _entityName = 'Airports';
   /**
    * Default url path for the according service.
    */
-  static _defaultBasePath =
+  static override _defaultBasePath =
     'V4/(S(duh2c3dgb1c5lzc0bqwgyekc))/TripPinServiceRW/';
   /**
    * All key fields of the Airports entity

diff --git a/...2e/TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/People.js.map b/...2e/TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/People.js.map
diff --git a/...es-e2e/TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/People.ts b/...es-e2e/TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/People.ts
@@ -24,11 +24,11 @@ export class People<T extends DeSerializers = DefaultDeSerializers>
   /**
    * Technical entity name for People.
    */
-  static _entityName = 'People';
+  static override _entityName = 'People';
   /**
    * Default url path for the according service.
    */
-  static _defaultBasePath =
+  static override _defaultBasePath =
     'V4/(S(duh2c3dgb1c5lzc0bqwgyekc))/TripPinServiceRW/';
   /**
    * All key fields of the People entity

diff --git a/...2e/TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/Photos.js.map b/...2e/TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/Photos.js.map
diff --git a/...es-e2e/TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/Photos.ts b/...es-e2e/TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/Photos.ts
@@ -21,11 +21,11 @@ export class Photos<T extends DeSerializers = DefaultDeSerializers>
   /**
    * Technical entity name for Photos.
    */
-  static _entityName = 'Photos';
+  static override _entityName = 'Photos';
   /**
    * Default url path for the according service.
    */
-  static _defaultBasePath =
+  static override _defaultBasePath =
     'V4/(S(duh2c3dgb1c5lzc0bqwgyekc))/TripPinServiceRW/';
   /**
    * All key fields of the Photos entity

diff --git a/test-packages/test-services-e2e/v4/test-service/TestEntity.js.map b/test-packages/test-services-e2e/v4/test-service/TestEntity.js.map
diff --git a/test-packages/test-services-e2e/v4/test-service/TestEntity.ts b/test-packages/test-services-e2e/v4/test-service/TestEntity.ts
@@ -30,11 +30,11 @@ export class TestEntity<T extends DeSerializers = DefaultDeSerializers>
   /**
    * Technical entity name for TestEntity.
    */
-  static _entityName = 'TestEntity';
+  static override _entityName = 'TestEntity';
   /**
    * Default url path for the according service.
    */
-  static _defaultBasePath = '/odata/test-service';
+  static override _defaultBasePath = '/odata/test-service';
   /**
    * All key fields of the TestEntity entity
    */

diff --git a/test-packages/test-services-e2e/v4/test-service/TestEntity50Prop.js.map b/test-packages/test-services-e2e/v4/test-service/TestEntity50Prop.js.map
diff --git a/test-packages/test-services-e2e/v4/test-service/TestEntity50Prop.ts b/test-packages/test-services-e2e/v4/test-service/TestEntity50Prop.ts
@@ -21,11 +21,11 @@ export class TestEntity50Prop<T extends DeSerializers = DefaultDeSerializers>
   /**
    * Technical entity name for TestEntity50Prop.
    */
-  static _entityName = 'TestEntity50Prop';
+  static override _entityName = 'TestEntity50Prop';
   /**
    * Default url path for the according service.
    */
-  static _defaultBasePath = '/odata/test-service';
+  static override _defaultBasePath = '/odata/test-service';
   /**
    * All key fields of the TestEntity50Prop entity
    */

diff --git a/test-packages/test-services-e2e/v4/test-service/TestEntityLink.js.map b/test-packages/test-services-e2e/v4/test-service/TestEntityLink.js.map
diff --git a/test-packages/test-services-e2e/v4/test-service/TestEntityLink.ts b/test-packages/test-services-e2e/v4/test-service/TestEntityLink.ts
@@ -21,11 +21,11 @@ export class TestEntityLink<T extends DeSerializers = DefaultDeSerializers>
   /**
    * Technical entity name for TestEntityLink.
    */
-  static _entityName = 'TestEntityLink';
+  static override _entityName = 'TestEntityLink';
   /**
    * Default url path for the according service.
    */
-  static _defaultBasePath = '/odata/test-service';
+  static override _defaultBasePath = '/odata/test-service';
   /**
    * All key fields of the TestEntityLink entity
    */

diff --git a/test-packages/test-services-e2e/v4/test-service/TestEntityWithMultipleKeys.js.map b/test-packages/test-services-e2e/v4/test-service/TestEntityWithMultipleKeys.js.map
diff --git a/test-packages/test-services-e2e/v4/test-service/TestEntityWithMultipleKeys.ts b/test-packages/test-services-e2e/v4/test-service/TestEntityWithMultipleKeys.ts
@@ -28,11 +28,11 @@ export class TestEntityWithMultipleKeys<
   /**
    * Technical entity name for TestEntityWithMultipleKeys.
    */
-  static _entityName = 'TestEntityWithMultipleKeys';
+  static override _entityName = 'TestEntityWithMultipleKeys';
   /**
    * Default url path for the according service.
    */
-  static _defaultBasePath = '/odata/test-service';
+  static override _defaultBasePath = '/odata/test-service';
   /**
    * All key fields of the TestEntityWithMultipleKeys entity
    */

diff --git a/test-packages/test-services-odata-common/common-entity.ts b/test-packages/test-services-odata-common/common-entity.ts
@@ -210,9 +210,9 @@ export class CommonEntitySingleLink<
   extends Entity
   implements CommonEntitySingleLinkType<T>
 {
-  static _entityName = 'A_CommonEntitySingleLink';
+  static override _entityName = 'A_CommonEntitySingleLink';
   readonly _oDataVersion: any;
-  static _defaultBasePath = '/sap/opu/odata/sap/API_COMMON_SRV';
+  static override _defaultBasePath = '/sap/opu/odata/sap/API_COMMON_SRV';
   static _keys = ['KeyProperty'];
   declare keyProperty: DeserializedType<T, 'Edm.String'>;
   declare stringProperty?: DeserializedType<T, 'Edm.String'> | null;
@@ -361,9 +361,9 @@ export class CommonEntity<T extends DeSerializers = DefaultDeSerializers>
   extends Entity
   implements CommonEntityType<T>
 {
-  static _entityName = 'A_CommonEntity';
+  static override _entityName = 'A_CommonEntity';
   readonly _oDataVersion: any;
-  static _defaultBasePath = '/sap/opu/odata/sap/API_COMMON_SRV';
+  static override _defaultBasePath = '/sap/opu/odata/sap/API_COMMON_SRV';
   static _keys = ['KeyPropertyGuid', 'KeyPropertyString'];
   declare keyPropertyGuid: DeserializedType<T, 'Edm.Guid'>;
   declare keyPropertyString: DeserializedType<T, 'Edm.String'>;

diff --git a/test-packages/test-services-odata-common/generate-common-entity.ts b/test-packages/test-services-odata-common/generate-common-entity.ts
@@ -78,8 +78,8 @@ function adjustCustomField(str: string): string {
 }
 
 function addODataVersion(str: string): string {
-  if (str.match(/static _entityName =.*/)) {
-    const nameString = str.match(/static _entityName =.*/)![0];
+  if (str.match(/static override _entityName =.*/)) {
+    const nameString = str.match(/static override _entityName =.*/)![0];
     return str.replace(
       nameString,
       [nameString, 'readonly _oDataVersion: any;'].join(unixEOL)

diff --git a/test-packages/test-services-odata-v2/multiple-schemas-service/MultiSchemaTestEntity.js.map b/test-packages/test-services-odata-v2/multiple-schemas-service/MultiSchemaTestEntity.js.map