@odata-effect/odata-effect-generator 0.2.0 → 0.3.1

package/src/generator/NavigationGenerator.ts

@@ -21,15 +21,9 @@
  *
  * @since 1.0.0
  */
-import type {
-  DataModel,
-  EntityTypeModel
-} from "../model/DataModel.js"
+import type { DataModel, EntityTypeModel } from "../model/DataModel.js"
 import type { ODataVersion } from "../parser/EdmxSchema.js"
-import {
-  getClassName,
-  toCamelCase
-} from "./NamingHelper.js"
+import { getClassName, toCamelCase } from "./NamingHelper.js"
 
 /**
  * Version-specific configuration.
@@ -42,18 +36,17 @@ interface VersionConfig {
 
 const V2_CONFIG: VersionConfig = {
   odataNamespace: "OData",
-  clientModule: "ODataClient",
+  clientModule: "OData",
   queryOptionsType: "ODataQueryOptions"
 }
 
 const V4_CONFIG: VersionConfig = {
   odataNamespace: "ODataV4",
-  clientModule: "ODataV4Client",
+  clientModule: "ODataV4",
   queryOptionsType: "ODataV4QueryOptions"
 }
 
-const getVersionConfig = (version: ODataVersion): VersionConfig =>
-  version === "V4" ? V4_CONFIG : V2_CONFIG
+const getVersionConfig = (version: ODataVersion): VersionConfig => version === "V4" ? V4_CONFIG : V2_CONFIG
 
 /**
  * Get the path builders module name.
@@ -163,7 +156,10 @@ const getDerivedTypes = (
     if (entityType.baseType === baseTypeFqName) {
       derived.push(entityType)
       // Recursively get further derived types
-      derived.push(...getDerivedTypes(entityType.fqName, dataModel))
+      const furtherDerived = getDerivedTypes(entityType.fqName, dataModel)
+      for (const d of furtherDerived) {
+        derived.push(d)
+      }
     }
   }
 
@@ -226,9 +222,9 @@ const generatePathBuildersFile = (dataModel: DataModel): string => {
   lines.push(``)
 
   // Imports
-  lines.push(`import * as ${versionConfig.odataNamespace} from "@odata-effect/odata-effect/${versionConfig.odataNamespace}"`)
-  lines.push(`import type { ${versionConfig.queryOptionsType} } from "@odata-effect/odata-effect/${versionConfig.clientModule}"`)
-  lines.push(`import type * as Schema from "effect/Schema"`)
+  lines.push(`import { ${versionConfig.odataNamespace} } from "@odata-effect/odata-effect"`)
+  lines.push(`import { toPromise } from "@odata-effect/odata-effect-promise"`)
+  lines.push(`import type { Effect, Schema } from "effect"`)
   lines.push(``)
 
   // Import model types with Model suffix to avoid collision with entity set names
@@ -276,7 +272,9 @@ const generatePathBuildersFile = (dataModel: DataModel): string => {
       lines.push(` * @since 1.0.0`)
       lines.push(` * @category entity-sets`)
       lines.push(` */`)
-      lines.push(`export const ${entitySet.name}: Path<${entityType.name}Model, true> = "${entitySet.name}" as Path<${entityType.name}Model, true>`)
+      lines.push(
+        `export const ${entitySet.name}: Path<${entityType.name}Model, true> = "${entitySet.name}" as Path<${entityType.name}Model, true>`
+      )
       lines.push(``)
     }
   }
@@ -331,7 +329,9 @@ const generatePathBuildersFile = (dataModel: DataModel): string => {
       lines.push(` * @since 1.0.0`)
       lines.push(` * @category navigation`)
       lines.push(` */`)
-      lines.push(`export const ${fnName} = (base: Path<${sourceEntity}Model, false>): Path<${targetType}Model, ${prop.isCollection}> =>`)
+      lines.push(
+        `export const ${fnName} = (base: Path<${sourceEntity}Model, false>): Path<${targetType}Model, ${prop.isCollection}> =>`
+      )
       lines.push(`  \`\${base}/${prop.odataName}\` as Path<${targetType}Model, ${prop.isCollection}>`)
       lines.push(``)
     }
@@ -344,16 +344,18 @@ const generatePathBuildersFile = (dataModel: DataModel): string => {
     lines.push(`// Type Casting (for entity inheritance)`)
     lines.push(`// ============================================================================`)
     lines.push(``)
-    lines.push(...castFunctions)
+    for (const castFunction of castFunctions) {
+      lines.push(castFunction)
+    }
   }
 
-  // Terminal operations
+  // Terminal operations (Effect-based)
   lines.push(`// ============================================================================`)
-  lines.push(`// Terminal Operations`)
+  lines.push(`// Terminal Operations (Effect-based)`)
   lines.push(`// ============================================================================`)
   lines.push(``)
   lines.push(`/**`)
-  lines.push(` * Fetch a collection of entities at the given path.`)
+  lines.push(` * Fetch a collection of entities at the given path (Effect-based).`)
   lines.push(` *`)
   lines.push(` * @example`)
   lines.push(` * \`\`\`typescript`)
@@ -364,11 +366,11 @@ const generatePathBuildersFile = (dataModel: DataModel): string => {
   lines.push(` * @category operations`)
   lines.push(` */`)
   lines.push(`export const fetchCollection = <T, I>(schema: Schema.Schema<T, I>) =>`)
-  lines.push(`  (path: Path<T, true>, options?: ${versionConfig.queryOptionsType}) =>`)
+  lines.push(`  (path: Path<T, true>, options?: ${versionConfig.clientModule}.${versionConfig.queryOptionsType}) =>`)
   lines.push(`    ${versionConfig.odataNamespace}.getCollection(path, schema, options)`)
   lines.push(``)
   lines.push(`/**`)
-  lines.push(` * Fetch a single entity at the given path.`)
+  lines.push(` * Fetch a single entity at the given path (Effect-based).`)
   lines.push(` *`)
   lines.push(` * @example`)
   lines.push(` * \`\`\`typescript`)
@@ -379,10 +381,35 @@ const generatePathBuildersFile = (dataModel: DataModel): string => {
   lines.push(` * @category operations`)
   lines.push(` */`)
   lines.push(`export const fetchOne = <T, I>(schema: Schema.Schema<T, I>) =>`)
-  lines.push(`  (path: Path<T, false>, options?: ${versionConfig.queryOptionsType}) =>`)
+  lines.push(`  (path: Path<T, false>, options?: ${versionConfig.clientModule}.${versionConfig.queryOptionsType}) =>`)
   lines.push(`    ${versionConfig.odataNamespace}.get(path, schema, options)`)
   lines.push(``)
 
+  // Promise conversion (re-export from odata-effect-promise)
+  lines.push(`// ============================================================================`)
+  lines.push(`// Promise Conversion`)
+  lines.push(`// ============================================================================`)
+  lines.push(``)
+  lines.push(`/**`)
+  lines.push(` * Convert an Effect to a Promise. Use at the end of a pipe chain.`)
+  lines.push(` *`)
+  lines.push(` * @example`)
+  lines.push(` * \`\`\`typescript`)
+  lines.push(` * const myTrips = await pipe(`)
+  lines.push(` *   People,`)
+  lines.push(` *   byKey("russell"),`)
+  lines.push(` *   trips,`)
+  lines.push(` *   fetchCollection(Trip),`)
+  lines.push(` *   toPromise(runtime)`)
+  lines.push(` * )`)
+  lines.push(` * \`\`\``)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` * @category operations`)
+  lines.push(` */`)
+  lines.push(`export { toPromise }`)
+  lines.push(``)
+
   return lines.join("\n")
 }
 
@@ -409,7 +436,9 @@ const generateTypeCastFunctions = (dataModel: DataModel): Array<string> => {
       lines.push(` * @since 1.0.0`)
       lines.push(` * @category casting`)
       lines.push(` */`)
-      lines.push(`export const ${fnName} = (base: Path<${entityType.name}Model, true>): Path<${derived.name}Model, true> =>`)
+      lines.push(
+        `export const ${fnName} = (base: Path<${entityType.name}Model, true>): Path<${derived.name}Model, true> =>`
+      )
       lines.push(`  \`\${base}/${castPath}\` as Path<${derived.name}Model, true>`)
       lines.push(``)
     }

package/src/generator/OperationsGenerator.ts

@@ -125,7 +125,7 @@ const returnsModelType = (operation: OperationModel, dataModel: DataModel): bool
 const getReturnTypeName = (operation: OperationModel): string => {
   if (!operation.returnType) return "void"
 
-  const { typeMapping, isCollection } = operation.returnType
+  const { isCollection, typeMapping } = operation.returnType
   const baseType = typeMapping.tsType
 
   return isCollection ? `ReadonlyArray<${baseType}>` : baseType
@@ -364,19 +364,29 @@ const generateV2FunctionImport = (
 
   // Determine the execute function to use
   if (!operation.returnType) {
-    lines.push(`    return yield* ODataOps.executeFunctionImportVoid(client, config, "${operation.odataName}", ${paramsArg})`)
+    lines.push(
+      `    return yield* ODataOps.executeFunctionImportVoid(client, config, "${operation.odataName}", ${paramsArg})`
+    )
   } else if (operation.returnType.isCollection) {
     if (returnsModel) {
-      lines.push(`    return yield* ODataOps.executeFunctionImportCollection(client, config, "${operation.odataName}", ${operation.returnType.typeMapping.tsType}, ${paramsArg})`)
+      lines.push(
+        `    return yield* ODataOps.executeFunctionImportCollection(client, config, "${operation.odataName}", ${operation.returnType.typeMapping.tsType}, ${paramsArg})`
+      )
     } else {
-      lines.push(`    return yield* ODataOps.executeFunctionImportCollection(client, config, "${operation.odataName}", ${operation.returnType.typeMapping.effectSchema}, ${paramsArg})`)
+      lines.push(
+        `    return yield* ODataOps.executeFunctionImportCollection(client, config, "${operation.odataName}", ${operation.returnType.typeMapping.effectSchema}, ${paramsArg})`
+      )
     }
   } else if (returnsModel) {
-    lines.push(`    return yield* ODataOps.executeFunctionImportEntity(client, config, "${operation.odataName}", ${operation.returnType.typeMapping.tsType}, ${paramsArg})`)
+    lines.push(
+      `    return yield* ODataOps.executeFunctionImportEntity(client, config, "${operation.odataName}", ${operation.returnType.typeMapping.tsType}, ${paramsArg})`
+    )
   } else {
     // Primitive return
     const propertyName = operation.odataName
-    lines.push(`    return yield* ODataOps.executeFunctionImportPrimitive(client, config, "${operation.odataName}", "${propertyName}", ${operation.returnType.typeMapping.effectSchema}, ${paramsArg})`)
+    lines.push(
+      `    return yield* ODataOps.executeFunctionImportPrimitive(client, config, "${operation.odataName}", "${propertyName}", ${operation.returnType.typeMapping.effectSchema}, ${paramsArg})`
+    )
   }
 
   lines.push(`  })`)
@@ -444,15 +454,23 @@ const generateV4Operation = (
       lines.push(`    return yield* ODataOps.executeV4FunctionVoid(client, config, url)`)
     } else if (operation.returnType.isCollection) {
       if (returnsModel) {
-        lines.push(`    return yield* ODataOps.executeV4FunctionCollection(client, config, url, ${operation.returnType.typeMapping.tsType})`)
+        lines.push(
+          `    return yield* ODataOps.executeV4FunctionCollection(client, config, url, ${operation.returnType.typeMapping.tsType})`
+        )
       } else {
-        lines.push(`    return yield* ODataOps.executeV4FunctionCollection(client, config, url, ${operation.returnType.typeMapping.effectSchema})`)
+        lines.push(
+          `    return yield* ODataOps.executeV4FunctionCollection(client, config, url, ${operation.returnType.typeMapping.effectSchema})`
+        )
       }
     } else if (returnsModel) {
-      lines.push(`    return yield* ODataOps.executeV4FunctionEntity(client, config, url, ${operation.returnType.typeMapping.tsType})`)
+      lines.push(
+        `    return yield* ODataOps.executeV4FunctionEntity(client, config, url, ${operation.returnType.typeMapping.tsType})`
+      )
     } else {
       // Primitive return
-      lines.push(`    return yield* ODataOps.executeV4FunctionPrimitive(client, config, url, ${operation.returnType.typeMapping.effectSchema})`)
+      lines.push(
+        `    return yield* ODataOps.executeV4FunctionPrimitive(client, config, url, ${operation.returnType.typeMapping.effectSchema})`
+      )
     }
   } else {
     // V4 Actions use POST with body
@@ -465,15 +483,23 @@ const generateV4Operation = (
       lines.push(`    return yield* ODataOps.executeV4ActionVoid(client, config, url, ${bodyArg})`)
     } else if (operation.returnType.isCollection) {
       if (returnsModel) {
-        lines.push(`    return yield* ODataOps.executeV4ActionCollection(client, config, url, ${operation.returnType.typeMapping.tsType}, ${bodyArg})`)
+        lines.push(
+          `    return yield* ODataOps.executeV4ActionCollection(client, config, url, ${operation.returnType.typeMapping.tsType}, ${bodyArg})`
+        )
       } else {
-        lines.push(`    return yield* ODataOps.executeV4ActionCollection(client, config, url, ${operation.returnType.typeMapping.effectSchema}, ${bodyArg})`)
+        lines.push(
+          `    return yield* ODataOps.executeV4ActionCollection(client, config, url, ${operation.returnType.typeMapping.effectSchema}, ${bodyArg})`
+        )
       }
     } else if (returnsModel) {
-      lines.push(`    return yield* ODataOps.executeV4ActionEntity(client, config, url, ${operation.returnType.typeMapping.tsType}, ${bodyArg})`)
+      lines.push(
+        `    return yield* ODataOps.executeV4ActionEntity(client, config, url, ${operation.returnType.typeMapping.tsType}, ${bodyArg})`
+      )
     } else {
       // Primitive return - use entity with schema
-      lines.push(`    return yield* ODataOps.executeV4FunctionPrimitive(client, config, url, ${operation.returnType.typeMapping.effectSchema})`)
+      lines.push(
+        `    return yield* ODataOps.executeV4FunctionPrimitive(client, config, url, ${operation.returnType.typeMapping.effectSchema})`
+      )
     }
   }