@odata-effect/odata-effect-generator 0.4.1 → 0.6.0

package/src/generator/ModelsGenerator.ts

@@ -85,6 +85,48 @@ const sortTypesByDependency = <T extends ComplexTypeModel | EntityTypeModel>(
   return sorted
 }
 
+/**
+ * Check if any property uses ODataSchema types.
+ */
+const needsODataSchemaImport = (dataModel: DataModel): boolean => {
+  const checkProperties = (properties: ReadonlyArray<PropertyModel>): boolean =>
+    properties.some((p) => p.typeMapping.effectSchema.startsWith("ODataSchema."))
+
+  for (const type of dataModel.entityTypes.values()) {
+    if (checkProperties(type.properties)) return true
+  }
+  for (const type of dataModel.complexTypes.values()) {
+    if (checkProperties(type.properties)) return true
+  }
+  return false
+}
+
+/**
+ * Check which Effect type imports are needed based on tsType usage.
+ */
+const getNeededEffectTypeImports = (dataModel: DataModel): Set<string> => {
+  const needed = new Set<string>()
+
+  const checkTsType = (tsType: string): void => {
+    if (tsType.startsWith("DateTime.")) needed.add("DateTime")
+    if (tsType.startsWith("BigDecimal.")) needed.add("BigDecimal")
+    if (tsType.startsWith("Duration.")) needed.add("Duration")
+  }
+
+  for (const type of dataModel.entityTypes.values()) {
+    for (const prop of type.properties) {
+      checkTsType(prop.typeMapping.tsType)
+    }
+  }
+  for (const type of dataModel.complexTypes.values()) {
+    for (const prop of type.properties) {
+      checkTsType(prop.typeMapping.tsType)
+    }
+  }
+
+  return needed
+}
+
 /**
  * Generate the Models.ts file content.
  *
@@ -106,6 +148,18 @@ export const generateModels = (dataModel: DataModel): string => {
   lines.push(` * @since 1.0.0`)
   lines.push(` */`)
   lines.push(`import * as Schema from "effect/Schema"`)
+
+  // Add Effect type imports if needed (for DateTime, BigDecimal, Duration)
+  const effectTypeImports = getNeededEffectTypeImports(dataModel)
+  for (const effectType of effectTypeImports) {
+    lines.push(`import type * as ${effectType} from "effect/${effectType}"`)
+  }
+
+  // Add ODataSchema import if needed
+  if (needsODataSchemaImport(dataModel)) {
+    lines.push(`import { ODataSchema } from "@odata-effect/odata-effect"`)
+  }
+
   lines.push(``)
 
   // Generate enum types (no dependencies, always first)

package/src/generator/NamingHelper.ts

@@ -279,3 +279,29 @@ export const getOperationParameterNameWithOverrides = (
   // Fall back to default camelCase conversion
   return getPropertyName(odataParamName)
 }
+
+// ============================================================================
+// Import path utilities
+// ============================================================================
+
+/**
+ * Format a relative import path, optionally adding .js extension for ESM compatibility.
+ *
+ * @param moduleName - The module name (e.g., "Models", "Services")
+ * @param esmExtensions - Whether to add .js extension (default: true)
+ * @returns The formatted import path (e.g., "./Models.js" or "./Models")
+ *
+ * @example
+ * formatRelativeImport("Models", true)   // "./Models.js"
+ * formatRelativeImport("Models", false)  // "./Models"
+ *
+ * @since 1.0.0
+ * @category imports
+ */
+export const formatRelativeImport = (
+  moduleName: string,
+  esmExtensions: boolean = true
+): string => {
+  const ext = esmExtensions ? ".js" : ""
+  return `./${moduleName}${ext}`
+}

package/src/generator/NavigationGenerator.ts

@@ -23,7 +23,7 @@
  */
 import type { DataModel, EntityTypeModel } from "../model/DataModel.js"
 import type { ODataVersion } from "../parser/EdmxSchema.js"
-import { getClassName, toCamelCase } from "./NamingHelper.js"
+import { formatRelativeImport, getClassName, toCamelCase } from "./NamingHelper.js"
 
 /**
  * Version-specific configuration.
@@ -166,15 +166,33 @@ const getDerivedTypes = (
   return derived
 }
 
+/**
+ * Options for navigation generation.
+ *
+ * @since 1.0.0
+ * @category types
+ */
+export interface NavigationGeneratorOptions {
+  /**
+   * Add .js extensions to relative imports for ESM compatibility.
+   * @default true
+   */
+  readonly esmExtensions?: boolean
+}
+
 /**
  * Generate navigation builders.
  *
  * @since 1.0.0
  * @category generation
  */
-export const generateNavigations = (dataModel: DataModel): NavigationGenerationResult => {
+export const generateNavigations = (
+  dataModel: DataModel,
+  options?: NavigationGeneratorOptions
+): NavigationGenerationResult => {
+  const esmExtensions = options?.esmExtensions ?? true
   const moduleName = getPathBuildersModuleName()
-  const content = generatePathBuildersFile(dataModel)
+  const content = generatePathBuildersFile(dataModel, esmExtensions)
 
   return {
     navigationFiles: [{
@@ -187,7 +205,7 @@ export const generateNavigations = (dataModel: DataModel): NavigationGenerationR
 /**
  * Generate the PathBuilders.ts file.
  */
-const generatePathBuildersFile = (dataModel: DataModel): string => {
+const generatePathBuildersFile = (dataModel: DataModel, esmExtensions: boolean): string => {
   const lines: Array<string> = []
   const versionConfig = getVersionConfig(dataModel.version)
 
@@ -235,7 +253,7 @@ const generatePathBuildersFile = (dataModel: DataModel): string => {
       const isLast = i === typesList.length - 1
       lines.push(`  ${typesList[i]} as ${typesList[i]}Model${isLast ? "" : ","}`)
     }
-    lines.push(`} from "./Models"`)
+    lines.push(`} from "${formatRelativeImport("Models", esmExtensions)}"`)
     lines.push(``)
   }
 

package/src/generator/OperationsGenerator.ts

@@ -8,7 +8,7 @@
  */
 import type { DataModel, OperationModel, OperationParameterModel } from "../model/DataModel.js"
 import type { ODataVersion } from "../parser/EdmxSchema.js"
-import { toPascalCase } from "./NamingHelper.js"
+import { formatRelativeImport, toPascalCase } from "./NamingHelper.js"
 
 /**
  * Version-specific imports and identifiers.
@@ -73,13 +73,32 @@ export interface OperationsGenerationResult {
   readonly operationsFile: GeneratedOperationsFile | null
 }
 
+/**
+ * Options for operations generation.
+ *
+ * @since 1.0.0
+ * @category types
+ */
+export interface OperationsGeneratorOptions {
+  /**
+   * Add .js extensions to relative imports for ESM compatibility.
+   * @default true
+   */
+  readonly esmExtensions?: boolean
+}
+
 /**
  * Generate the operations file.
  *
  * @since 1.0.0
  * @category generation
  */
-export const generateOperations = (dataModel: DataModel): OperationsGenerationResult => {
+export const generateOperations = (
+  dataModel: DataModel,
+  options?: OperationsGeneratorOptions
+): OperationsGenerationResult => {
+  const esmExtensions = options?.esmExtensions ?? true
+
   // Get unbound operations only (bound operations are attached to entity services)
   const unboundOperations = Array.from(dataModel.operations.values()).filter((op) => !op.isBound)
 
@@ -87,7 +106,7 @@ export const generateOperations = (dataModel: DataModel): OperationsGenerationRe
     return { operationsFile: null }
   }
 
-  const content = generateOperationsFile(unboundOperations, dataModel)
+  const content = generateOperationsFile(unboundOperations, dataModel, esmExtensions)
 
   return {
     operationsFile: {
@@ -174,7 +193,8 @@ const collectModelImports = (operations: ReadonlyArray<OperationModel>, dataMode
  */
 const generateOperationsFile = (
   operations: ReadonlyArray<OperationModel>,
-  dataModel: DataModel
+  dataModel: DataModel,
+  esmExtensions: boolean
 ): string => {
   const lines: Array<string> = []
   const versionConfig = getVersionConfig(dataModel.version)
@@ -215,7 +235,7 @@ const generateOperationsFile = (
       const isLast = i === importsList.length - 1
       lines.push(`  ${importsList[i]}${isLast ? "" : ","}`)
     }
-    lines.push(`} from "./Models"`)
+    lines.push(`} from "${formatRelativeImport("Models", esmExtensions)}"`)
     lines.push(``)
   }
 

package/src/generator/QueryModelsGenerator.ts

@@ -10,7 +10,27 @@ import type {
   NavigationPropertyModel,
   PropertyModel
 } from "../model/DataModel.js"
-import { getClassName, getQueryFactoryName, getQueryInstanceName, getQueryInterfaceName } from "./NamingHelper.js"
+import {
+  formatRelativeImport,
+  getClassName,
+  getQueryFactoryName,
+  getQueryInstanceName,
+  getQueryInterfaceName
+} from "./NamingHelper.js"
+
+/**
+ * Options for query models generation.
+ *
+ * @since 1.0.0
+ * @category types
+ */
+export interface QueryModelsGeneratorOptions {
+  /**
+   * Add .js extensions to relative imports for ESM compatibility.
+   * @default true
+   */
+  readonly esmExtensions?: boolean
+}
 
 /**
  * Generate the QueryModels.ts file content.
@@ -18,7 +38,11 @@ import { getClassName, getQueryFactoryName, getQueryInstanceName, getQueryInterf
  * @since 1.0.0
  * @category generation
  */
-export const generateQueryModels = (dataModel: DataModel): string => {
+export const generateQueryModels = (
+  dataModel: DataModel,
+  options?: QueryModelsGeneratorOptions
+): string => {
+  const esmExtensions = options?.esmExtensions ?? true
   const lines: Array<string> = []
 
   // Collect all query path types needed
@@ -48,7 +72,7 @@ export const generateQueryModels = (dataModel: DataModel): string => {
   if (usedEntityNames.length > 0) {
     lines.push(`import type {`)
     lines.push(`  ${usedEntityNames.join(",\n  ")}`)
-    lines.push(`} from "./Models"`)
+    lines.push(`} from "${formatRelativeImport("Models", esmExtensions)}"`)
   }
   lines.push(``)
 

package/src/generator/ServiceFnGenerator.ts

@@ -8,7 +8,7 @@
  */
 import type { DataModel, EntitySetModel, EntityTypeModel } from "../model/DataModel.js"
 import type { ODataVersion } from "../parser/EdmxSchema.js"
-import { getEditableTypeName, getIdTypeName, getServiceClassName } from "./NamingHelper.js"
+import { formatRelativeImport, getEditableTypeName, getIdTypeName, getServiceClassName } from "./NamingHelper.js"
 
 /**
  * Generated service file.
@@ -31,14 +31,32 @@ export interface ServiceGenerationResult {
   readonly servicesFile: GeneratedServiceFile
 }
 
+/**
+ * Options for service generation.
+ *
+ * @since 1.0.0
+ * @category types
+ */
+export interface ServiceGeneratorOptions {
+  /**
+   * Add .js extensions to relative imports for ESM compatibility.
+   * @default true
+   */
+  readonly esmExtensions?: boolean
+}
+
 /**
  * Generate the Services.ts file using crud factory.
  *
  * @since 1.0.0
  * @category generation
  */
-export const generateServiceFns = (dataModel: DataModel): ServiceGenerationResult => {
-  const content = generateServicesFile(dataModel)
+export const generateServiceFns = (
+  dataModel: DataModel,
+  options?: ServiceGeneratorOptions
+): ServiceGenerationResult => {
+  const esmExtensions = options?.esmExtensions ?? true
+  const content = generateServicesFile(dataModel, esmExtensions)
   return {
     servicesFile: {
       fileName: "Services.ts",
@@ -50,7 +68,7 @@ export const generateServiceFns = (dataModel: DataModel): ServiceGenerationResul
 /**
  * Generate the Services.ts file content.
  */
-const generateServicesFile = (dataModel: DataModel): string => {
+const generateServicesFile = (dataModel: DataModel, esmExtensions: boolean): string => {
   const lines: Array<string> = []
   const isV4 = dataModel.version === "V4"
   const crudImportPath = isV4
@@ -97,7 +115,7 @@ const generateServicesFile = (dataModel: DataModel): string => {
     const isLast = i === modelImports.length - 1
     lines.push(`  ${modelImports[i]}${isLast ? "" : ","}`)
   }
-  lines.push(`} from "./Models"`)
+  lines.push(`} from "${formatRelativeImport("Models", esmExtensions)}"`)
   lines.push(``)
 
   // Re-export types from the crud module

package/src/model/GeneratorConfig.ts

@@ -4,6 +4,28 @@
  * @since 1.0.0
  */
 
+/**
+ * Generator options for code generation.
+ *
+ * @since 1.0.0
+ * @category config
+ */
+export interface GeneratorOptions {
+  /**
+   * Add .js extensions to relative imports for ESM compatibility.
+   * Required for moduleResolution: node16/nodenext.
+   * Default: true (recommended for ESM projects)
+   *
+   * @default true
+   */
+  readonly esmExtensions?: boolean
+
+  /**
+   * Naming overrides for customizing generated type and property names.
+   */
+  readonly overrides?: NamingOverrides
+}
+
 /**
  * Override configuration for property names.
  * Maps OData property names to TypeScript property names.