feat: esm support on Odata

.changeset/honest-candles-kick.md

@@ -0,0 +1,6 @@
+---
+'@sap-cloud-sdk/generator': minor
+'@sap-cloud-sdk/generator-common': minor
+---
+
+[New Functionality] Introduce option `generateESM` in generator package to generate ESM compatible code.

packages/generator-common/src/file-writer/package-json.ts

@@ -14,6 +14,10 @@ export interface PackageJsonOptions {
    * @internal
    */
   description: string;
+  /**
+   * @internal
+   */
+  moduleType?: 'commonjs' | 'esm';
 }
 
 /* eslint-disable valid-jsdoc */
@@ -23,7 +27,7 @@ export interface PackageJsonOptions {
 export function packageJsonBase(
   options: PackageJsonOptions
 ): Record<string, any> {
-  return {
+  const basePackageJson: Record<string, any> = {
     name: options.npmPackageName,
     version: '1.0.0',
     description: options.description,
@@ -39,4 +43,17 @@ export function packageJsonBase(
       url: ''
     }
   };
+
+  if (options.moduleType === 'esm') {
+    basePackageJson.type = 'module';
+    basePackageJson.main = './index.mjs';
+    basePackageJson.exports = {
+      '.': {
+        import: './index.mjs',
+        require: './index.js'
+      }
+    };
+  }
+
+  return basePackageJson;
 }

packages/generator-common/src/options.ts

@@ -6,6 +6,8 @@ import {
   resolveRequiredPath
 } from './options-parser';
 import type { ServiceType } from './options-parser';
+import type { ParsedOptions } from './options-parser';
+import { formatTsConfig, readCustomTsConfig } from './ts-config';
 
 function getReadmeText(serviceType: ServiceType): string {
   return serviceType === 'OData'
@@ -193,4 +195,24 @@ export interface CommonGeneratorOptions {
    * Generate default `README.md` files in the client directories.
    */
   readme?: boolean;
+  /**
+   * Generate ECMAScript modules instead of CommonJS modules.
+   */
+  generateESM?: boolean;
+}
+
+/**
+ * Build a tsconfig.json file as string.
+ * If the given options include a tsConfig setting, this config is read and returned.
+ * @param options - Options passed to the generator.
+ * @returns The serialized tsconfig.json contents.
+ * @internal
+ */
+export async function tsconfigJson({
+  transpile,
+  tsconfig: tsConfig
+}: { transpile?: boolean; tsconfig?: string }): Promise<string | undefined> {
+  if (transpile || tsConfig) {
+    return tsConfig ? readCustomTsConfig(tsConfig) : formatTsConfig();
+  }
 }

packages/generator/src/batch/file.ts

@@ -4,17 +4,19 @@ import { importBatchDeclarations } from './imports';
 import { readRequestType, writeRequestType } from './type';
 import type { VdmServiceMetadata } from '../vdm-types';
 import type { SourceFileStructure } from 'ts-morph';
+import type { CreateFileOptions } from '@sap-cloud-sdk/generator-common/internal';
 
 /**
  * @internal
  */
 export function batchSourceFile(
-  service: VdmServiceMetadata
+  service: VdmServiceMetadata,
+  options?: CreateFileOptions
 ): SourceFileStructure {
   return {
     kind: StructureKind.SourceFile,
     statements: [
-      ...importBatchDeclarations(service),
+      ...importBatchDeclarations(service, options),
       batchFunction(service),
       changesetFunction(service),
       `export const default${service.className}Path = '${service.serviceOptions.basePath}';`,

packages/generator/src/batch/imports.ts

@@ -3,12 +3,14 @@ import { unique } from '@sap-cloud-sdk/util';
 import { odataImportDeclarationTsMorph } from '../imports';
 import type { ImportDeclarationStructure } from 'ts-morph';
 import type { VdmServiceMetadata } from '../vdm-types';
+import type { CreateFileOptions } from '@sap-cloud-sdk/generator-common/internal';
 
 /**
  * @internal
  */
 export function importBatchDeclarations(
-  service: VdmServiceMetadata
+  service: VdmServiceMetadata,
+  options?: CreateFileOptions
 ): ImportDeclarationStructure[] {
   return [
     odataImportDeclarationTsMorph(
@@ -32,7 +34,7 @@ export function importBatchDeclarations(
     },
     {
       kind: StructureKind.ImportDeclaration,
-      moduleSpecifier: './index',
+      moduleSpecifier: options?.generateESM ? './index.js' : './index',
       namedImports: getNamedImports(service)
     }
   ];

packages/generator/src/complex-type/file.ts

@@ -6,18 +6,20 @@ import { complexTypeNamespace } from './namespace';
 import type { VdmComplexType } from '../vdm-types';
 import type { ODataVersion } from '@sap-cloud-sdk/util';
 import type { SourceFileStructure } from 'ts-morph';
+import type { CreateFileOptions } from '@sap-cloud-sdk/generator-common/internal';
 
 /**
  * @internal
  */
 export function complexTypeSourceFile(
   complexType: VdmComplexType,
-  oDataVersion: ODataVersion
+  oDataVersion: ODataVersion,
+  options?: CreateFileOptions
 ): SourceFileStructure {
   return {
     kind: StructureKind.SourceFile,
     statements: [
-      ...importDeclarations(complexType, oDataVersion),
+      ...importDeclarations(complexType, oDataVersion, options),
       complexTypeInterface(complexType),
       fieldTypeClass(complexType),
       complexTypeNamespace(complexType)

packages/generator/src/complex-type/imports.spec.ts

@@ -5,6 +5,7 @@ import {
 } from '../../test/test-util/data-model';
 import { importDeclarations } from './imports';
 import type { VdmComplexType } from '../vdm-types';
+import type { CreateFileOptions } from '@sap-cloud-sdk/generator-common/internal';
 
 describe('complex type imports', () => {
   it('importDeclarations', () => {
@@ -94,4 +95,49 @@ describe('complex type imports', () => {
       }
     ]);
   });
+
+  describe('ESM support', () => {
+    const commonjsOptions = {
+      generateESM: false
+    } as CreateFileOptions;
+
+    const esmOptions = {
+      generateESM: true
+    } as CreateFileOptions;
+
+    it('importDeclarations with CommonJS', () => {
+      const actual = importDeclarations(
+        complexMealWithDesert,
+        'v2',
+        commonjsOptions
+      );
+
+      expect(
+        actual.find(imp => imp.moduleSpecifier === './ComplexDesert')
+          ?.moduleSpecifier
+      ).toBe('./ComplexDesert');
+    });
+
+    it('importDeclarations with ESM', () => {
+      const actual = importDeclarations(
+        complexMealWithDesert,
+        'v2',
+        esmOptions
+      );
+
+      expect(
+        actual.find(imp => imp.moduleSpecifier === './ComplexDesert.js')
+          ?.moduleSpecifier
+      ).toBe('./ComplexDesert.js');
+    });
+
+    it('maintains backward compatibility when options is undefined', () => {
+      const actual = importDeclarations(complexMealWithDesert, 'v2');
+
+      expect(
+        actual.find(imp => imp.moduleSpecifier === './ComplexDesert')
+          ?.moduleSpecifier
+      ).toBe('./ComplexDesert');
+    });
+  });
 });

packages/generator/src/complex-type/imports.ts

@@ -6,17 +6,19 @@ import {
 import type { ImportDeclarationStructure } from 'ts-morph';
 import type { ODataVersion } from '@sap-cloud-sdk/util';
 import type { VdmComplexType } from '../vdm-types';
+import type { CreateFileOptions } from '@sap-cloud-sdk/generator-common/internal';
 
 /**
  * @internal
  */
 export function importDeclarations(
   complexType: VdmComplexType,
-  oDataVersion: ODataVersion
+  oDataVersion: ODataVersion,
+  options?: CreateFileOptions
 ): ImportDeclarationStructure[] {
   return [
-    ...complexTypeImportDeclarations(complexType.properties),
-    ...enumTypeImportDeclarations(complexType.properties),
+    ...complexTypeImportDeclarations(complexType.properties, options),
+    ...enumTypeImportDeclarations(complexType.properties, options),
     odataImportDeclarationTsMorph(
       [
         'DefaultDeSerializers',

packages/generator/src/entity/file.ts

@@ -5,19 +5,26 @@ import { entityImportDeclarations, otherEntityImports } from './imports';
 import { entityTypeInterface } from './interface';
 import type { VdmEntity, VdmServiceMetadata } from '../vdm-types';
 import type { SourceFileStructure } from 'ts-morph';
+import type { CreateFileOptions } from '@sap-cloud-sdk/generator-common/internal';
 
 /**
  * @internal
  */
 export function entitySourceFile(
   entity: VdmEntity,
-  service: VdmServiceMetadata
+  service: VdmServiceMetadata,
+  options?: CreateFileOptions
 ): SourceFileStructure {
   return {
     kind: StructureKind.SourceFile,
     statements: [
-      ...entityImportDeclarations(entity, service, service.oDataVersion),
-      ...otherEntityImports(entity, service),
+      ...entityImportDeclarations(
+        entity,
+        service,
+        service.oDataVersion,
+        options
+      ),
+      ...otherEntityImports(entity, service, options),
       entityClass(entity, service),
       entityTypeInterface(entity, service),
       ...entity.operations.map(operation => parametersInterface(operation))

packages/generator/src/entity/imports.spec.ts

@@ -1,5 +1,6 @@
 import { breakfastEntity, foodService } from '../../test/test-util/data-model';
 import { entityImportDeclarations, otherEntityImports } from './imports';
+import type { CreateFileOptions } from '@sap-cloud-sdk/generator-common/internal';
 
 describe('imports', () => {
   it('importDeclarations', () => {
@@ -31,6 +32,85 @@ describe('imports', () => {
       }))
     ).toEqual(expectedOtherEntityImports);
   });
+
+  describe('ESM support', () => {
+    const commonjsOptions = {
+      generateESM: false
+    } as CreateFileOptions;
+
+    const esmOptions = {
+      generateESM: true
+    } as CreateFileOptions;
+
+    it('importDeclarations with CommonJS', () => {
+      const actual = entityImportDeclarations(
+        breakfastEntity,
+        foodService,
+        'v2',
+        commonjsOptions
+      );
+
+      expect(
+        actual.find(imp => imp.moduleSpecifier === './BreakfastApi')
+          ?.moduleSpecifier
+      ).toBe('./BreakfastApi');
+    });
+
+    it('importDeclarations with ESM', () => {
+      const actual = entityImportDeclarations(
+        breakfastEntity,
+        foodService,
+        'v2',
+        esmOptions
+      );
+
+      const breakfastApiImport = actual.find(
+        imp =>
+          Array.isArray(imp.namedImports) &&
+          imp.namedImports.includes('BreakfastApi')
+      );
+      expect(breakfastApiImport?.moduleSpecifier).toBe('./BreakfastApi.js');
+    });
+
+    it('otherEntityImports with CommonJS', () => {
+      const actual = otherEntityImports(
+        breakfastEntity,
+        foodService,
+        commonjsOptions
+      );
+
+      expect(actual.map(imports => imports.moduleSpecifier)).toEqual([
+        './Brunch'
+      ]);
+    });
+
+    it('otherEntityImports with ESM', () => {
+      const actual = otherEntityImports(
+        breakfastEntity,
+        foodService,
+        esmOptions
+      );
+
+      expect(actual.map(imports => imports.moduleSpecifier)).toEqual([
+        './Brunch.js'
+      ]);
+    });
+
+    it('maintains backward compatibility when options is undefined', () => {
+      const actual = entityImportDeclarations(
+        breakfastEntity,
+        foodService,
+        'v2'
+      );
+
+      const breakfastApiImport = actual.find(
+        imp =>
+          Array.isArray(imp.namedImports) &&
+          imp.namedImports.includes('BreakfastApi')
+      );
+      expect(breakfastApiImport?.moduleSpecifier).toBe('./BreakfastApi');
+    });
+  });
 });
 
 const expectedEntityImports = [