feat(v4)!: Respect precision for Odata V4 type Edm.DateTimeOffset (#5361)

Author: KavithaSiva

.changeset/funny-shrimps-visit.md

@@ -0,0 +1,7 @@
+---
+'@sap-cloud-sdk/generator': major
+'@sap-cloud-sdk/odata-v4': major
+'@sap-cloud-sdk/odata-common': major
+---
+
+[Improvement] Support precision handling during serialization of `Edm.DateTimeOffset` fields in OData v4.

packages/generator/src/edmx-parser/common/edmx-types.ts

@@ -61,6 +61,10 @@ export interface EdmxProperty extends EdmxDocumented, EdmxNamed {
    * @internal
    */
   Type: string;
+  /**
+   * @internal
+   */
+  Precision?: string;
 }
 /**
  * @internal

packages/generator/src/edmx-to-vdm/common/entity.ts

@@ -119,6 +119,7 @@ function properties(
       description: propertyDescription(p, swaggerProp),
       nullable: isNullableProperty(p),
       maxLength: p.MaxLength,
+      precision: p.Precision === undefined ? undefined : parseInt(p.Precision),
       isComplex,
       isEnum,
       isCollection

packages/generator/src/entity/namespace.ts

@@ -79,7 +79,8 @@ function getFieldInitializer(
  */
 export function createPropertyFieldInitializerForEntity(
   prop: VdmProperty,
-  fieldBuilderName = '_fieldBuilder'
+  fieldBuilderName = '_fieldBuilder',
+  service?: VdmServiceMetadata
 ): string {
   if (prop.isCollection) {
     if (prop.isComplex) {
@@ -99,9 +100,20 @@ export function createPropertyFieldInitializerForEntity(
     return `${fieldBuilderName}.buildEnumField('${prop.originalName}', ${prop.jsType}, ${prop.nullable})`;
   }
 
-  return `${fieldBuilderName}.buildEdmTypeField('${prop.originalName}', '${prop.edmType}', ${prop.nullable})`;
+  return `${fieldBuilderName}.buildEdmTypeField('${prop.originalName}', '${
+    prop.edmType
+  }', ${prop.nullable}${
+    prop.precision !== undefined &&
+    isPrecisionAwareEdmType(prop.edmType) &&
+    service?.oDataVersion === 'v4'
+      ? `, ${prop.precision}`
+      : ''
+  })`;
 }
 
+function isPrecisionAwareEdmType(value: string): boolean {
+  return value === 'Edm.DateTimeOffset';
+}
 /**
  * @internal
  */

packages/generator/src/generator-without-ts-morph/entity-api/class.ts

@@ -95,7 +95,7 @@ Use the service function as described in the documentation to get an API instanc
   get schema() {
     if (!this._schema) {
       const fieldBuilder = this.fieldBuilder;
-      this._schema = ${getSchema(entity)};
+      this._schema = ${getSchema(entity, service)};
     }
   
     return this._schema;

packages/generator/src/generator-without-ts-morph/entity-api/schema.ts

@@ -1,32 +1,40 @@
 import { documentationBlock } from '@sap-cloud-sdk/util';
 import { addLeadingNewline, getStaticPropertyDescription } from '../../typedoc';
 import { createPropertyFieldInitializerForEntity } from '../../entity';
-import type { VdmEntity, VdmProperty } from '../../vdm-types';
+import type {
+  VdmEntity,
+  VdmProperty,
+  VdmServiceMetadata
+} from '../../vdm-types';
 
 /**
  * @internal
  */
-export function getSchema(entity: VdmEntity): string {
+export function getSchema(
+  entity: VdmEntity,
+  service?: VdmServiceMetadata
+): string {
   return `{ 
     ${[
-      ...properties(entity),
+      ...properties(entity, service),
       '...this.navigationPropertyFields',
       // ...navigationProperties(entity, service),
       allFieldsSelector(entity)
     ].join(',\n')} 
   }`;
 }
 
-function properties(entity: VdmEntity): string[] {
-  return entity.properties.map(prop => property(prop));
+function properties(entity: VdmEntity, service?: VdmServiceMetadata): string[] {
+  return entity.properties.map(prop => property(prop, service));
 }
 
-function property(prop: VdmProperty): string {
+function property(prop: VdmProperty, service?: VdmServiceMetadata): string {
   return [
     documentationBlock`${getStaticPropertyDescription(prop)}`,
     `${prop.staticPropertyName}: ${createPropertyFieldInitializerForEntity(
       prop,
-      'fieldBuilder'
+      'fieldBuilder',
+      service
     )}`
   ].join('\n');
 }

packages/generator/src/typedoc.ts

@@ -173,6 +173,9 @@ function addConstraints(
   if (constraints.nullable) {
     description += `${unixEOL}@nullable`;
   }
+  if (constraints.precision !== undefined) {
+    description += `${unixEOL}Precision: ${constraints.precision}.`;
+  }
 
   return description;
 }

packages/generator/src/vdm-types.ts

@@ -176,6 +176,10 @@ export interface VdmPropertyValueConstraints {
    * @internal
    */
   nullable: boolean;
+  /**
+   * @internal
+   */
+  precision?: number;
 }
 /**
  * @internal

packages/odata-common/src/de-serializers/de-serializers.ts

@@ -98,7 +98,7 @@ export interface DeSerializer<DeserializedT> {
    * @param value - Deserialized value to serialize.
    * @returns Serialized value.
    */
-  serialize: (value: DeserializedT) => any;
+  serialize: (value: DeserializedT, precision?: number) => any;
 
   /**
    * Function to serialize a value for use in a URI.
@@ -152,9 +152,9 @@ export function createValueDeserializer<DeSerializersT extends DeSerializers>(
  */
 export function createValueSerializer<DeSerializersT extends DeSerializers>(
   deSerializers: DeSerializersT
-): <EdmT>(value: any, edmType: EdmT) => any {
-  return (value, edmType) => {
+): <EdmT>(value: any, edmType: EdmT, precision?: number) => any {
+  return (value, edmType, precision) => {
     const serialize = deSerializers[edmType as any]?.serialize;
-    return serialize ? serialize(value) : value;
+    return serialize ? serialize(value, precision) : value;
   };
 }

packages/odata-common/src/de-serializers/default-de-serializers.ts

@@ -124,12 +124,12 @@ export const defaultDeSerializersRaw: DefaultDeSerializers = {
 function wrapDefaultSerializer<T>(
   serialize: DeSerializer<T>['serialize']
 ): DeSerializer<T>['serialize'] {
-  return function (value) {
+  return function (value, precision?) {
     if (value === null) {
       return 'null';
     }
     if (serialize) {
-      return serialize(value);
+      return serialize(value, precision);
     }
     return value;
   };