feat: support comparison operators for missing edm types (#2519)

* feat: use OrderableEdmTypeField for all primitive odata types * feat: change string filter function to be orderable * fix: add missing orderable edm types * fix: adjust generator test to OrderableEdmTypeField * fix: add missing orderable for Edm.String * chore: re-generate test services * fix: linter and prettier * docs: update changeset * fix: add missing OrderableEdmTypeField and remove redundant EdmTypeField * fix: type test * chore: add type tests for additional comparison operators and edm types
SAP · Jun 7, 2022 · c3166ff · c3166ff
1 parent c927634
commit c3166ff
Show file tree

Hide file tree

Showing 225 changed files with 546 additions and 473 deletions.
diff --git a/.changeset/empty-lobsters-explain.md b/.changeset/empty-lobsters-explain.md
@@ -0,0 +1,6 @@
+---
+'@sap-cloud-sdk/generator': minor
+'@sap-cloud-sdk/odata-common': minor
+---
+
+[Compatibility Note] Change `Edm.String`, `Edm.Boolean` and `Edm.Guid` to be orderable to support `lt`/`lessThan()`, `le`/`lessOrEqual()`, `gt`/`greaterThan()`, and `ge`/`greaterOrEqual` operators. Re-generate odata services to adopt the changes.
diff --git a/packages/generator-common/CHANGELOG.md b/packages/generator-common/CHANGELOG.md
diff --git a/packages/generator/src/complex-type/field-type-class.spec.ts b/packages/generator/src/complex-type/field-type-class.spec.ts
@@ -27,7 +27,7 @@ describe('field-type-class', () => {
         {
           kind: StructureKind.Property,
           name: 'complexity',
-          type: "EdmTypeField<EntityT, DeSerializersT, 'Edm.String', false, false>",
+          type: "OrderableEdmTypeField<EntityT, DeSerializersT, 'Edm.String', false, false>",
           initializer:
             "this._fieldBuilder.buildEdmTypeField('Complexity', 'Edm.String', false)",
           docs: [

diff --git a/packages/generator/src/generator-utils.ts b/packages/generator/src/generator-utils.ts
@@ -122,9 +122,9 @@ const edmToTsTypeMapping: EdmTypeMappingWithoutEnum = {
 };
 
 const edmToFieldTypeMapping: EdmTypeMapping = {
-  'Edm.String': 'EdmTypeField',
-  'Edm.Boolean': 'EdmTypeField',
-  'Edm.Guid': 'EdmTypeField',
+  'Edm.String': 'OrderableEdmTypeField',
+  'Edm.Boolean': 'OrderableEdmTypeField',
+  'Edm.Guid': 'OrderableEdmTypeField',
   'Edm.Decimal': 'OrderableEdmTypeField',
   'Edm.Int16': 'OrderableEdmTypeField',
   'Edm.Int32': 'OrderableEdmTypeField',

diff --git a/...ages/generator/src/generator-without-ts-morph/entity-api/__snapshots__/class.spec.ts.snap b/...ages/generator/src/generator-without-ts-morph/entity-api/__snapshots__/class.spec.ts.snap
@@ -84,7 +84,7 @@ exports[`entity api class gets proper class content 1`] = `
   }
 
   private _schema?: {
-    ENTITY_NAME: EdmTypeField<Breakfast<DeSerializers>, DeSerializersT, 'Edm.String', false, true>,
+    ENTITY_NAME: OrderableEdmTypeField<Breakfast<DeSerializers>, DeSerializersT, 'Edm.String', false, true>,
 NUMBER_OF_EGGS: OrderableEdmTypeField<Breakfast<DeSerializers>, DeSerializersT, 'Edm.Decimal', true, true>,
 BREAKFAST_TIME: OrderableEdmTypeField<Breakfast<DeSerializers>, DeSerializersT, 'Edm.DateTime', false, true>,
 /**

diff --git a/packages/generator/src/generator-without-ts-morph/entity-api/__snapshots__/file.spec.ts.snap b/packages/generator/src/generator-without-ts-morph/entity-api/__snapshots__/file.spec.ts.snap
@@ -4,7 +4,7 @@ exports[`entity api file gets proper file 1`] = `
 "import { Breakfast } from './Breakfast';
 import { BreakfastRequestBuilder } from './BreakfastRequestBuilder';
 import { BrunchApi } from './BrunchApi';
-import { CustomField, defaultDeSerializers, DefaultDeSerializers, DeSerializers, AllFields, entityBuilder, EntityBuilderType, EntityApi, FieldBuilder, Time, EdmTypeField, OrderableEdmTypeField, OneToOneLink } from '@sap-cloud-sdk/odata-v2';
+import { CustomField, defaultDeSerializers, DefaultDeSerializers, DeSerializers, AllFields, entityBuilder, EntityBuilderType, EntityApi, FieldBuilder, Time, OrderableEdmTypeField, OneToOneLink } from '@sap-cloud-sdk/odata-v2';
 export class BreakfastApi<DeSerializersT extends DeSerializers = DefaultDeSerializers> implements 
     EntityApi<
       Breakfast<
@@ -88,7 +88,7 @@ export class BreakfastApi<DeSerializersT extends DeSerializers = DefaultDeSerial
   }
 
   private _schema?: {
-    ENTITY_NAME: EdmTypeField<Breakfast<DeSerializers>, DeSerializersT, 'Edm.String', false, true>,
+    ENTITY_NAME: OrderableEdmTypeField<Breakfast<DeSerializers>, DeSerializersT, 'Edm.String', false, true>,
 NUMBER_OF_EGGS: OrderableEdmTypeField<Breakfast<DeSerializers>, DeSerializersT, 'Edm.Decimal', true, true>,
 BREAKFAST_TIME: OrderableEdmTypeField<Breakfast<DeSerializers>, DeSerializersT, 'Edm.DateTime', false, true>,
 /**

diff --git a/packages/generator/src/imports.spec.ts b/packages/generator/src/imports.spec.ts
@@ -28,7 +28,7 @@ const bigNumberProperty = {
 const stringProperty = {
   jsType: 'string',
   edmType: 'Edm.String',
-  fieldType: 'EdmTypeField'
+  fieldType: 'OrderableEdmTypeField'
 } as VdmProperty;
 
 const numberProperty = {
@@ -113,7 +113,7 @@ describe('imports', () => {
           momentProperty,
           timeProperty
         ])
-      ).toEqual(['EdmTypeField', 'OrderableEdmTypeField']);
+      ).toEqual(['OrderableEdmTypeField']);
     });
 
     it('contains unique one-to-many link import', () => {

diff --git a/packages/generator/src/request-builder/class.spec.ts b/packages/generator/src/request-builder/class.spec.ts
@@ -58,7 +58,7 @@ describe('request builder class', () => {
       staticPropertyName: 'BREAKFAST_TIME',
       propertyNameAsParam: 'pWith',
       jsType: 'string',
-      fieldType: 'EdmTypeField',
+      fieldType: 'OrderableEdmTypeField',
       originalName: 'With',
       edmType: 'Edm.String',
       description: 'Breakfast accompaniment.',

diff --git a/packages/generator/src/service-generator.spec.ts b/packages/generator/src/service-generator.spec.ts
@@ -111,7 +111,7 @@ describe('service-generator', () => {
           propertyNameAsParam: 'stringProperty',
           edmType: 'Edm.String',
           jsType: 'string',
-          fieldType: 'EdmTypeField',
+          fieldType: 'OrderableEdmTypeField',
           description: '',
           nullable: true,
           maxLength: '10',

diff --git a/packages/generator/test/test-util/data-model.ts b/packages/generator/test/test-util/data-model.ts
@@ -15,7 +15,7 @@ export const entityName: VdmProperty = {
   staticPropertyName: 'ENTITY_NAME',
   propertyNameAsParam: 'entityName',
   jsType: 'string',
-  fieldType: 'EdmTypeField',
+  fieldType: 'OrderableEdmTypeField',
   originalName: 'EntityName',
   edmType: 'Edm.String',
   description: 'The name of the entity.',
@@ -123,7 +123,7 @@ export const complexMeal: VdmComplexType = {
       originalName: 'Complexity',
       description: 'something something very good',
       edmType: 'Edm.String',
-      fieldType: 'EdmTypeField',
+      fieldType: 'OrderableEdmTypeField',
       nullable: false,
       instancePropertyName: 'complexity',
       propertyNameAsParam: 'complexity',
@@ -168,7 +168,7 @@ export const complexDesert: VdmComplexType = {
       originalName: 'Name',
       description: 'name of the desert',
       edmType: 'Edm.String',
-      fieldType: 'EdmTypeField',
+      fieldType: 'OrderableEdmTypeField',
       nullable: false,
       instancePropertyName: 'name',
       propertyNameAsParam: 'name',
@@ -227,7 +227,7 @@ const orderBreakfastBuilder = (isNullable: boolean): VdmFunctionImport => ({
       description: 'Breakfast includes a honey toast',
       edmType: 'Edm.Boolean',
       jsType: 'boolean',
-      fieldType: 'EdmTypeField'
+      fieldType: 'OrderableEdmTypeField'
     }
   ],
   parametersTypeName: 'Params',

diff --git a/packages/odata-common/src/edm-types.ts b/packages/odata-common/src/edm-types.ts
@@ -89,7 +89,10 @@ export type OrderableEdmType =
   | 'Edm.Time'
   | 'Edm.Date'
   | 'Edm.Duration'
-  | 'Edm.TimeOfDay';
+  | 'Edm.TimeOfDay'
+  | 'Edm.String'
+  | 'Edm.Boolean'
+  | 'Edm.Guid';
 
 /**
  * Convenience function to check whether a given EDM type is of type [[OrderableEdmType]].
@@ -112,6 +115,9 @@ export function isOrderableEdmType(edmType: EdmTypeShared<'any'>): boolean {
     'Edm.Time',
     'Edm.Date',
     'Edm.Duration',
-    'Edm.TimeOfDay'
+    'Edm.TimeOfDay',
+    'Edm.String',
+    'Edm.Boolean',
+    'Edm.Guid'
   ].includes(edmType);
 }
diff --git a/packages/odata-common/src/filter/filter.ts b/packages/odata-common/src/filter/filter.ts
@@ -4,7 +4,7 @@ import { EntityBase, EntityIdentifiable, ODataVersionOf } from '../entity-base';
 import type { FilterFunction } from './filter-function-base';
 import type { Filterable } from './filterable';
 
-type FilterOperatorString = 'eq' | 'ne';
+type FilterOperatorString = 'eq' | 'ne' | 'lt' | 'le' | 'gt' | 'ge';
 type FilterOperatorBoolean = 'eq' | 'ne';
 type FilterOperatorNumber = 'eq' | 'ne' | 'lt' | 'le' | 'gt' | 'ge';
 /**

diff --git a/packages/odata-common/src/filter/string-filter-function.ts b/packages/odata-common/src/filter/string-filter-function.ts
@@ -1,16 +1,14 @@
 import { EntityBase } from '../entity-base';
-import {
-  FilterFunction,
-  FilterFunctionParameterType
-} from './filter-function-base';
+import { FilterFunctionParameterType } from './filter-function-base';
+import { OrderableFilterFunction } from './orderable-filter-function';
 
 /**
  * Representation of a filter function, that returns a value of type string.
  * @internal
  */
 export class StringFilterFunction<
   EntityT extends EntityBase
-> extends FilterFunction<EntityT, string> {
+> extends OrderableFilterFunction<EntityT, string> {
   /**
    * Creates an instance of StringFilterFunction.
    * @param functionName - Name of the function that returns a string value.

diff --git a/packages/odata-common/src/selectable/orderable-edm-type-field.spec.ts b/packages/odata-common/src/selectable/orderable-edm-type-field.spec.ts
@@ -43,7 +43,7 @@ describe('Number Field', () => {
       checkFilter(filter, fieldName, 'ne', filterValue);
     });
 
-    it('should create filter for "lessThen"', () => {
+    it('should create filter for "lessThan"', () => {
       const filter = field.lessThan(filterValue);
       checkFilter(filter, fieldName, 'lt', filterValue);
     });
@@ -90,7 +90,7 @@ describe('Number Field', () => {
       checkFilter(filter, `${parentFieldName}/${fieldName}`, 'ne', filterValue);
     });
 
-    it('should create filter for "lessThen"', () => {
+    it('should create filter for "lessThan"', () => {
       const filter = field.lessThan(filterValue);
       expect(field._fieldName).toBe(fieldName);
       checkFilter(filter, `${parentFieldName}/${fieldName}`, 'lt', filterValue);

diff --git a/...TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/AirlinesApi.d.ts b/...TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/AirlinesApi.d.ts
@@ -8,7 +8,7 @@ import {
   EntityBuilderType,
   EntityApi,
   FieldBuilder,
-  EdmTypeField
+  OrderableEdmTypeField
 } from '@sap-cloud-sdk/odata-v4';
 export declare class AirlinesApi<
   DeSerializersT extends DeSerializers = DefaultDeSerializers
@@ -29,7 +29,7 @@ export declare class AirlinesApi<
   get fieldBuilder(): FieldBuilder<typeof Airlines, DeSerializersT>;
   private _schema?;
   get schema(): {
-    AIRLINE_CODE: EdmTypeField<
+    AIRLINE_CODE: OrderableEdmTypeField<
       Airlines<
         DeSerializers<
           any,
@@ -58,7 +58,7 @@ export declare class AirlinesApi<
       false,
       true
     >;
-    NAME: EdmTypeField<
+    NAME: OrderableEdmTypeField<
       Airlines<
         DeSerializers<
           any,

diff --git a/...Pin/microsoft-o-data-service-sample-trippin-in-memory-models-service/AirlinesApi.d.ts.map b/...Pin/microsoft-o-data-service-sample-trippin-in-memory-models-service/AirlinesApi.d.ts.map
diff --git a/...ipPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/AirlinesApi.js.map b/...ipPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/AirlinesApi.js.map
diff --git a/...e/TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/AirlinesApi.ts b/...e/TripPin/microsoft-o-data-service-sample-trippin-in-memory-models-service/AirlinesApi.ts
@@ -15,7 +15,7 @@ import {
   EntityBuilderType,
   EntityApi,
   FieldBuilder,
-  EdmTypeField
+  OrderableEdmTypeField
 } from '@sap-cloud-sdk/odata-v4';
 export class AirlinesApi<
   DeSerializersT extends DeSerializers = DefaultDeSerializers
@@ -65,14 +65,14 @@ export class AirlinesApi<
   }
 
   private _schema?: {
-    AIRLINE_CODE: EdmTypeField<
+    AIRLINE_CODE: OrderableEdmTypeField<
       Airlines<DeSerializers>,
       DeSerializersT,
       'Edm.String',
       false,
       true
     >;
-    NAME: EdmTypeField<
+    NAME: OrderableEdmTypeField<
       Airlines<DeSerializers>,
       DeSerializersT,
       'Edm.String',

diff --git a/...Pin/microsoft-o-data-service-sample-trippin-in-memory-models-service/AirportLocation.d.ts b/...Pin/microsoft-o-data-service-sample-trippin-in-memory-models-service/AirportLocation.d.ts
@@ -8,6 +8,7 @@ import {
   EdmTypeField,
   Entity,
   FieldOptions,
+  OrderableEdmTypeField,
   PropertyMetadata
 } from '@sap-cloud-sdk/odata-v4';
 /**
@@ -58,7 +59,13 @@ export declare class AirportLocationField<
    * Representation of the [[AirportLocation.address]] property for query construction.
    * Use to reference this property in query operations such as 'filter' in the fluent request API.
    */
-  address: EdmTypeField<EntityT, DeSerializersT, 'Edm.String', false, false>;
+  address: OrderableEdmTypeField<
+    EntityT,
+    DeSerializersT,
+    'Edm.String',
+    false,
+    false
+  >;
   /**
    * Representation of the [[AirportLocation.city]] property for query construction.
    * Use to reference this property in query operations such as 'filter' in the fluent request API.

diff --git a/...microsoft-o-data-service-sample-trippin-in-memory-models-service/AirportLocation.d.ts.map b/...microsoft-o-data-service-sample-trippin-in-memory-models-service/AirportLocation.d.ts.map
diff --git a/...n/microsoft-o-data-service-sample-trippin-in-memory-models-service/AirportLocation.js.map b/...n/microsoft-o-data-service-sample-trippin-in-memory-models-service/AirportLocation.js.map