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 OData generator 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,11 @@ export function packageJsonBase(
       url: ''
     }
   };
+
+  if (options.moduleType === 'esm') {
+    basePackageJson.type = 'module';
+    basePackageJson.main = './index.mjs';
+  }
+
+  return basePackageJson;
 }

packages/generator-common/src/options.ts

@@ -193,4 +193,8 @@ export interface CommonGeneratorOptions {
    * Generate default `README.md` files in the client directories.
    */
   readme?: boolean;
+  /**
+   * Generate ECMAScript modules instead of CommonJS modules.
+   */
+  generateESM?: boolean;
 }

packages/openapi-generator/src/options/tsconfig-json.spec.ts → packages/generator-common/src/ts-config.spec.ts

@@ -1,24 +1,18 @@
-import { defaultTsConfig } from '@sap-cloud-sdk/generator-common/internal';
 import mock from 'mock-fs';
-import { tsconfigJson } from './tsconfig-json';
-import type { ParsedGeneratorOptions } from './options';
+import { defaultTsConfig, tsconfigJson } from './ts-config';
 
 describe('tsconfigJson', () => {
   afterEach(() => {
     mock.restore();
   });
 
   it('returns the default tsconfig if transpilation is enabled', async () => {
-    const tsConfig = await tsconfigJson({
-      transpile: true
-    } as ParsedGeneratorOptions);
+    const tsConfig = await tsconfigJson(true, undefined);
     expect(JSON.parse(tsConfig!)).toEqual(defaultTsConfig);
   });
 
   it('returns undefined if transpilation is disabled', async () => {
-    const tsConfig = await tsconfigJson({
-      transpile: false
-    } as ParsedGeneratorOptions);
+    const tsConfig = await tsconfigJson(false, undefined);
     expect(tsConfig).toBeUndefined();
   });
 
@@ -29,9 +23,7 @@ describe('tsconfigJson', () => {
         'customConfig.json': JSON.stringify(customConfig)
       }
     });
-    const tsConfig = await tsconfigJson({
-      tsconfig: './path/customConfig.json'
-    } as ParsedGeneratorOptions);
+    const tsConfig = await tsconfigJson(false, './path/customConfig.json');
     expect(JSON.parse(tsConfig!)).toEqual(customConfig);
   });
 
@@ -42,18 +34,14 @@ describe('tsconfigJson', () => {
         'tsconfig.json': JSON.stringify(customConfig)
       }
     });
-    const tsConfig = await tsconfigJson({
-      tsconfig: './path'
-    } as ParsedGeneratorOptions);
+    const tsConfig = await tsconfigJson(false, './path');
     expect(JSON.parse(tsConfig!)).toEqual(customConfig);
   });
 
   it('returns custom config content if custom file or directory does not exist', async () => {
     mock({});
-    await expect(() =>
-      tsconfigJson({
-        tsconfig: './path'
-      } as ParsedGeneratorOptions)
-    ).rejects.toThrow('Could not read tsconfig.json at ./path.');
+    await expect(() => tsconfigJson(false, './path')).rejects.toThrow(
+      'Could not read tsconfig.json at ./path.'
+    );
   });
 });

packages/generator-common/src/ts-config.ts

@@ -2,7 +2,6 @@ import { promises } from 'fs';
 import { resolve } from 'path';
 import { unixEOL, ErrorWithCause } from '@sap-cloud-sdk/util';
 const { readFile, lstat } = promises;
-
 /**
  * @internal
  */
@@ -46,3 +45,20 @@ export async function readCustomTsConfig(configPath: string): Promise<string> {
     );
   }
 }
+
+/**
+ * Build a tsconfig.json file as string.
+ * If transpile is true or tsconfig is provided, return the appropriate config.
+ * @param transpile - Whether to transpile.
+ * @param tsconfig - Path to custom tsconfig file.
+ * @returns The serialized tsconfig.json contents.
+ * @internal
+ */
+export async function tsconfigJson(
+  transpile: boolean,
+  tsconfig: string | undefined
+): Promise<string | undefined> {
+  if (transpile || tsconfig) {
+    return tsconfig ? readCustomTsConfig(tsconfig) : formatTsConfig();
+  }
+}

packages/generator/.nycrc

@@ -1,18 +1,7 @@
-
 {
-  "extension": [
-    ".ts"
-  ],
-  "include": [
-    "src/**/*"
-  ],
-  "exclude": [
-    "**/*.d.ts"
-  ],
-  "reporter": [
-    "cobertura",
-    "html",
-    "text-summary"
-  ],
+  "extension": [".ts"],
+  "include": ["src/**/*"],
+  "exclude": ["**/*.d.ts"],
+  "reporter": ["cobertura", "html", "text-summary"],
   "all": true
 }

packages/generator/README.md

@@ -1,6 +1,8 @@
 <!-- sap-cloud-sdk-logo -->
 <!-- This block is inserted by scripts/replace-common-readme.ts. Do not adjust it manually. -->
+
 <a href="https://sap.github.io/cloud-sdk/docs/js/overview"><img src="https://help.sap.com/doc/2324e9c3b28748a4ae2ad08166d77675/1.0/en-US/logo-with-js.svg" alt="SAP Cloud SDK for JavaScript Logo" height="122.92" width="226.773"/></a>
+
 <!-- sap-cloud-sdk-logo-stop -->
 
 # @sap-cloud-sdk/generator
@@ -41,6 +43,7 @@ For more detailed overview visit our [generator documentation](https://sap.githu
 
 <!-- sap-cloud-sdk-common-readme -->
 <!-- This block is inserted by scripts/replace-common-readme.ts. Do not adjust it manually. -->
+
 ## Support
 
 The recommended way to get in touch with us is to create an issue on [GitHub](https://github.com/SAP/cloud-sdk-js/issues).
@@ -68,4 +71,5 @@ If you would like to contribute to the SAP Cloud SDK, please make yourself famil
 ## License
 
 The SAP Cloud SDK is released under the [Apache License Version 2.0.](http://www.apache.org/licenses/)
+
 <!-- sap-cloud-sdk-common-readme-stop -->

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',