@odata-effect/odata-effect-generator 0.1.0

package/src/generator/ServiceFnPromiseGenerator.ts

@@ -0,0 +1,242 @@
+/**
+ * Generator for Promise-based service functions.
+ *
+ * This module generates Promise-based wrappers around the Effect-based
+ * service functions, allowing usage in non-Effect environments.
+ *
+ * @since 1.0.0
+ */
+import type { DataModel, EntitySetModel, EntityTypeModel } from "../model/DataModel.js"
+import type { ODataVersion } from "../parser/EdmxSchema.js"
+import { getEditableTypeName, getIdTypeName, getServiceClassName } from "./NamingHelper.js"
+
+/**
+ * Version-specific imports and identifiers.
+ */
+interface VersionConfig {
+  readonly runtimeType: string
+  readonly runtimeImport: string
+}
+
+const V2_CONFIG: VersionConfig = {
+  runtimeType: "ODataRuntime",
+  runtimeImport: "type ODataRuntime"
+}
+
+const V4_CONFIG: VersionConfig = {
+  runtimeType: "ODataV4Runtime",
+  runtimeImport: "type ODataV4Runtime"
+}
+
+const getVersionConfig = (version: ODataVersion): VersionConfig => version === "V4" ? V4_CONFIG : V2_CONFIG
+
+/**
+ * Get the Promise service name (e.g., "ProductsServicePromise").
+ */
+export const getPromiseServiceName = (entitySetName: string): string => `${getServiceClassName(entitySetName)}Promise`
+
+/**
+ * Generated Promise service file.
+ *
+ * @since 1.0.0
+ * @category types
+ */
+export interface GeneratedPromiseServiceFile {
+  readonly fileName: string
+  readonly content: string
+}
+
+/**
+ * Result of Promise service generation.
+ *
+ * @since 1.0.0
+ * @category types
+ */
+export interface PromiseServiceGenerationResult {
+  readonly entityServices: ReadonlyArray<GeneratedPromiseServiceFile>
+}
+
+/**
+ * Generate all Promise-based service function files.
+ *
+ * @since 1.0.0
+ * @category generation
+ */
+export const generatePromiseServiceFns = (dataModel: DataModel): PromiseServiceGenerationResult => {
+  const entityServices: Array<GeneratedPromiseServiceFile> = []
+
+  // Generate individual Promise service files
+  for (const entitySet of dataModel.entitySets.values()) {
+    const entityType = dataModel.entityTypes.get(entitySet.entityTypeFqName)
+    if (entityType) {
+      const promiseServiceName = getPromiseServiceName(entitySet.name)
+      entityServices.push({
+        fileName: `${promiseServiceName}.ts`,
+        content: generatePromiseServiceFile(entitySet, entityType, dataModel)
+      })
+    }
+  }
+
+  return { entityServices }
+}
+
+/**
+ * Generate a single Promise service file.
+ */
+const generatePromiseServiceFile = (
+  entitySet: EntitySetModel,
+  entityType: EntityTypeModel,
+  dataModel: DataModel
+): string => {
+  const lines: Array<string> = []
+  const versionConfig = getVersionConfig(dataModel.version)
+  const serviceClassName = getServiceClassName(entitySet.name)
+  const promiseServiceName = getPromiseServiceName(entitySet.name)
+  const entityName = entityType.name
+  const idTypeName = getIdTypeName(entityName)
+  const editableName = getEditableTypeName(entityName)
+  const hasKeys = entityType.keys.length > 0
+
+  // Header and imports
+  lines.push(`/**`)
+  lines.push(
+    ` * Promise-based ${entityName} service functions for ${dataModel.serviceName} OData ${dataModel.version}.`
+  )
+  lines.push(` * Generated by odata-effect-gen.`)
+  lines.push(` *`)
+  lines.push(` * These functions wrap the Effect-based service functions for use in`)
+  lines.push(` * non-Effect environments. They take a runtime as the first argument.`)
+  lines.push(` *`)
+  lines.push(` * @example`)
+  lines.push(` * \`\`\`ts`)
+  lines.push(
+    ` * import { ${
+      versionConfig.runtimeType.replace("OData", "createOData").replace("Runtime", "Runtime")
+    } } from "@odata-effect/odata-effect-promise"`
+  )
+  lines.push(` * import { ${promiseServiceName} } from "@template/${dataModel.serviceName.toLowerCase()}-effect"`)
+  lines.push(` *`)
+  lines.push(
+    ` * const runtime = ${versionConfig.runtimeType.replace("OData", "createOData").replace("Runtime", "Runtime")}({`
+  )
+  lines.push(` *   baseUrl: "https://server.com",`)
+  lines.push(` *   servicePath: "/odata/${dataModel.version.toLowerCase()}/"`)
+  lines.push(` * })`)
+  lines.push(` *`)
+  lines.push(` * const items = await ${promiseServiceName}.getAll(runtime)`)
+  lines.push(` * await runtime.dispose()`)
+  lines.push(` * \`\`\``)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` */`)
+  lines.push(`import { ${versionConfig.runtimeImport} } from "@odata-effect/odata-effect-promise"`)
+  lines.push(`import * as ${serviceClassName} from "./${serviceClassName}.js"`)
+  lines.push(``)
+
+  // Import models
+  lines.push(`import {`)
+  lines.push(`  ${entityName},`)
+  if (hasKeys) {
+    lines.push(`  type ${idTypeName},`)
+  }
+  lines.push(`  ${editableName}`)
+  lines.push(`} from "./Models.js"`)
+  lines.push(``)
+
+  // Query options import
+  const queryOptionsType = dataModel.version === "V4" ? "ODataV4QueryOptions" : "ODataQueryOptions"
+  lines.push(`import type { ${queryOptionsType} } from "@odata-effect/odata-effect"`)
+  lines.push(``)
+
+  // Re-export runtime type for convenience
+  lines.push(`// Re-export runtime type for convenience`)
+  lines.push(`export type { ${versionConfig.runtimeType} } from "@odata-effect/odata-effect-promise"`)
+  lines.push(``)
+
+  lines.push(`// ============================================================================`)
+  lines.push(`// Promise-based Functions`)
+  lines.push(`// ============================================================================`)
+  lines.push(``)
+
+  // getAll
+  lines.push(`/**`)
+  lines.push(` * Fetch all ${entityName} entities.`)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` * @category operations`)
+  lines.push(` */`)
+  lines.push(`export const getAll = (`)
+  lines.push(`  runtime: ${versionConfig.runtimeType},`)
+  lines.push(`  options?: ${queryOptionsType}`)
+  lines.push(`): Promise<ReadonlyArray<${entityName}>> =>`)
+  lines.push(`  runtime.runPromise(${serviceClassName}.getAll(options))`)
+  lines.push(``)
+
+  // getById (if entity has keys)
+  if (hasKeys) {
+    lines.push(`/**`)
+    lines.push(` * Fetch a single ${entityName} by ID.`)
+    lines.push(` *`)
+    lines.push(` * @since 1.0.0`)
+    lines.push(` * @category operations`)
+    lines.push(` */`)
+    lines.push(`export const getById = (`)
+    lines.push(`  runtime: ${versionConfig.runtimeType},`)
+    lines.push(`  id: ${idTypeName}`)
+    lines.push(`): Promise<${entityName}> =>`)
+    lines.push(`  runtime.runPromise(${serviceClassName}.getById(id))`)
+    lines.push(``)
+  }
+
+  // create
+  lines.push(`/**`)
+  lines.push(` * Create a new ${entityName} entity.`)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` * @category operations`)
+  lines.push(` */`)
+  lines.push(`export const create = (`)
+  lines.push(`  runtime: ${versionConfig.runtimeType},`)
+  lines.push(`  entity: ${editableName}`)
+  lines.push(`): Promise<${entityName}> =>`)
+  lines.push(`  runtime.runPromise(${serviceClassName}.create(entity))`)
+  lines.push(``)
+
+  // update (if entity has keys)
+  if (hasKeys) {
+    lines.push(`/**`)
+    lines.push(` * Update an existing ${entityName} entity.`)
+    lines.push(` *`)
+    lines.push(` * @since 1.0.0`)
+    lines.push(` * @category operations`)
+    lines.push(` */`)
+    lines.push(`export const update = (`)
+    lines.push(`  runtime: ${versionConfig.runtimeType},`)
+    lines.push(`  id: ${idTypeName},`)
+    lines.push(`  entity: Partial<${editableName}>`)
+    lines.push(`): Promise<void> =>`)
+    lines.push(`  runtime.runPromise(${serviceClassName}.update(id, entity))`)
+    lines.push(``)
+
+    // delete
+    lines.push(`/**`)
+    lines.push(` * Delete a ${entityName} entity.`)
+    lines.push(` *`)
+    lines.push(` * @since 1.0.0`)
+    lines.push(` * @category operations`)
+    lines.push(` */`)
+    lines.push(`export const del = (`)
+    lines.push(`  runtime: ${versionConfig.runtimeType},`)
+    lines.push(`  id: ${idTypeName}`)
+    lines.push(`): Promise<void> =>`)
+    lines.push(`  runtime.runPromise(${serviceClassName}.del(id))`)
+    lines.push(``)
+
+    // Alias for nice naming
+    lines.push(`// Alias for nice naming`)
+    lines.push(`export { del as delete }`)
+    lines.push(``)
+  }
+
+  return lines.join("\n")
+}

package/src/index.ts

@@ -0,0 +1,114 @@
+/**
+ * CLI for OData Effect Generator.
+ *
+ * @since 1.0.0
+ */
+export * as Cli from "./Cli.js"
+
+/**
+ * CLI entry point for OData Effect Generator.
+ *
+ * @since 1.0.0
+ */
+export * as bin from "./bin.js"
+
+/**
+ * Digester for converting parsed EDMX into a DataModel.
+ * Supports both OData V2 and V4.
+ *
+ * @since 1.0.0
+ */
+export * as Digester from "./digester/Digester.js"
+
+/**
+ * Type mapper for converting OData types to Effect Schema types and query paths.
+ *
+ * @since 1.0.0
+ */
+export * as TypeMapper from "./digester/TypeMapper.js"
+
+/**
+ * Main generator that orchestrates all code generation.
+ *
+ * @since 1.0.0
+ */
+export * as Generator from "./generator/Generator.js"
+
+/**
+ * Generator for index.ts - Public API exports.
+ *
+ * @since 1.0.0
+ */
+export * as IndexGenerator from "./generator/IndexGenerator.js"
+
+/**
+ * Generator for Models.ts - Effect Schema definitions.
+ *
+ * @since 1.0.0
+ */
+export * as ModelsGenerator from "./generator/ModelsGenerator.js"
+
+/**
+ * Naming utilities for code generation.
+ *
+ * @since 1.0.0
+ */
+export * as NamingHelper from "./generator/NamingHelper.js"
+
+/**
+ * Generator for package configuration files.
+ *
+ * @since 1.0.0
+ */
+export * as PackageGenerator from "./generator/PackageGenerator.js"
+
+/**
+ * Generator for QueryModels.ts - Type-safe query paths.
+ *
+ * @since 1.0.0
+ */
+export * as QueryModelsGenerator from "./generator/QueryModelsGenerator.js"
+
+/**
+ * Generator for tree-shakable service functions.
+ *
+ * This module generates standalone functions that can be tree-shaken.
+ * Each entity service is a module of standalone functions that use
+ * the tree-shakable OData functions directly.
+ *
+ * @since 1.0.0
+ */
+export * as ServiceFnGenerator from "./generator/ServiceFnGenerator.js"
+
+/**
+ * Generator for Promise-based service functions.
+ *
+ * This module generates Promise-based wrappers around the Effect-based
+ * service functions, allowing usage in non-Effect environments.
+ *
+ * @since 1.0.0
+ */
+export * as ServiceFnPromiseGenerator from "./generator/ServiceFnPromiseGenerator.js"
+
+/**
+ * Intermediate representation for OData metadata.
+ * This is the central data model that digesters create and generators consume.
+ *
+ * @since 1.0.0
+ */
+export * as DataModel from "./model/DataModel.js"
+
+/**
+ * Common EDMX schema interfaces for OData metadata parsing.
+ * These interfaces represent the parsed XML structure from xml2js.
+ *
+ * @since 1.0.0
+ */
+export * as EdmxSchema from "./parser/EdmxSchema.js"
+
+/**
+ * Effect-wrapped XML parser for OData metadata.
+ *
+ * @since 1.0.0
+ */
+export * as XmlParser from "./parser/XmlParser.js"

package/src/model/DataModel.ts

@@ -0,0 +1,254 @@
+/**
+ * Intermediate representation for OData metadata.
+ * This is the central data model that digesters create and generators consume.
+ *
+ * @since 1.0.0
+ */
+import type { ODataVersion } from "../parser/EdmxSchema.js"
+
+// ============================================================================
+// Data Model
+// ============================================================================
+
+/**
+ * Central data model representing a parsed OData service.
+ *
+ * @since 1.0.0
+ * @category model
+ */
+export interface DataModel {
+  readonly version: ODataVersion
+  readonly namespace: string
+  readonly serviceName: string
+  readonly entityTypes: Map<string, EntityTypeModel>
+  readonly complexTypes: Map<string, ComplexTypeModel>
+  readonly enumTypes: Map<string, EnumTypeModel>
+  readonly entitySets: Map<string, EntitySetModel>
+  readonly singletons: Map<string, SingletonModel>
+  readonly operations: Map<string, OperationModel>
+}
+
+// ============================================================================
+// Property Model
+// ============================================================================
+
+/**
+ * Type mapping information for a property.
+ *
+ * @since 1.0.0
+ * @category model
+ */
+export interface TypeMapping {
+  readonly effectSchema: string
+  readonly queryPath: string
+  readonly tsType: string
+}
+
+/**
+ * Represents a property of an entity or complex type.
+ *
+ * @since 1.0.0
+ * @category model
+ */
+export interface PropertyModel {
+  readonly odataName: string
+  readonly name: string
+  readonly odataType: string
+  readonly typeMapping: TypeMapping
+  readonly isCollection: boolean
+  readonly isNullable: boolean
+  readonly isKey: boolean
+  readonly maxLength?: number
+  readonly precision?: number
+  readonly scale?: number
+}
+
+// ============================================================================
+// Navigation Property Model
+// ============================================================================
+
+/**
+ * Represents a navigation property.
+ *
+ * @since 1.0.0
+ * @category model
+ */
+export interface NavigationPropertyModel {
+  readonly odataName: string
+  readonly name: string
+  readonly targetType: string
+  readonly isCollection: boolean
+  readonly isNullable: boolean
+  readonly partner?: string
+}
+
+// ============================================================================
+// Entity Type Model
+// ============================================================================
+
+/**
+ * Represents an entity type.
+ *
+ * @since 1.0.0
+ * @category model
+ */
+export interface EntityTypeModel {
+  readonly fqName: string
+  readonly odataName: string
+  readonly name: string
+  readonly keys: ReadonlyArray<PropertyModel>
+  readonly properties: ReadonlyArray<PropertyModel>
+  readonly navigationProperties: ReadonlyArray<NavigationPropertyModel>
+  readonly baseType?: string
+  readonly isAbstract: boolean
+  readonly isOpen: boolean
+}
+
+// ============================================================================
+// Complex Type Model
+// ============================================================================
+
+/**
+ * Represents a complex type.
+ *
+ * @since 1.0.0
+ * @category model
+ */
+export interface ComplexTypeModel {
+  readonly fqName: string
+  readonly odataName: string
+  readonly name: string
+  readonly properties: ReadonlyArray<PropertyModel>
+  readonly navigationProperties: ReadonlyArray<NavigationPropertyModel>
+  readonly baseType?: string
+  readonly isAbstract: boolean
+  readonly isOpen: boolean
+}
+
+// ============================================================================
+// Enum Type Model
+// ============================================================================
+
+/**
+ * Represents an enum member.
+ *
+ * @since 1.0.0
+ * @category model
+ */
+export interface EnumMemberModel {
+  readonly name: string
+  readonly value: number
+}
+
+/**
+ * Represents an enum type.
+ *
+ * @since 1.0.0
+ * @category model
+ */
+export interface EnumTypeModel {
+  readonly fqName: string
+  readonly odataName: string
+  readonly name: string
+  readonly members: ReadonlyArray<EnumMemberModel>
+  readonly isFlags: boolean
+}
+
+// ============================================================================
+// Entity Set Model
+// ============================================================================
+
+/**
+ * Represents an entity set in the entity container.
+ *
+ * @since 1.0.0
+ * @category model
+ */
+export interface EntitySetModel {
+  readonly name: string
+  readonly entityTypeFqName: string
+  readonly entityTypeName: string
+}
+
+// ============================================================================
+// Singleton Model
+// ============================================================================
+
+/**
+ * Represents a singleton in the entity container.
+ *
+ * @since 1.0.0
+ * @category model
+ */
+export interface SingletonModel {
+  readonly name: string
+  readonly typeFqName: string
+  readonly typeName: string
+}
+
+// ============================================================================
+// Operation Model
+// ============================================================================
+
+/**
+ * Represents an operation parameter.
+ *
+ * @since 1.0.0
+ * @category model
+ */
+export interface OperationParameterModel {
+  readonly name: string
+  readonly odataType: string
+  readonly typeMapping: TypeMapping
+  readonly isNullable: boolean
+  readonly isCollection: boolean
+}
+
+/**
+ * Represents a function or action.
+ *
+ * @since 1.0.0
+ * @category model
+ */
+export interface OperationModel {
+  readonly fqName: string
+  readonly odataName: string
+  readonly name: string
+  readonly type: "Function" | "Action"
+  readonly isBound: boolean
+  readonly bindingParameter?: OperationParameterModel
+  readonly parameters: ReadonlyArray<OperationParameterModel>
+  readonly returnType?: {
+    readonly odataType: string
+    readonly typeMapping: TypeMapping
+    readonly isCollection: boolean
+    readonly isNullable: boolean
+  }
+  readonly entitySetPath?: string
+}
+
+// ============================================================================
+// Factory Functions
+// ============================================================================
+
+/**
+ * Creates an empty data model.
+ *
+ * @since 1.0.0
+ * @category constructors
+ */
+export const createDataModel = (
+  version: ODataVersion,
+  namespace: string,
+  serviceName: string
+): DataModel => ({
+  version,
+  namespace,
+  serviceName,
+  entityTypes: new Map(),
+  complexTypes: new Map(),
+  enumTypes: new Map(),
+  entitySets: new Map(),
+  singletons: new Map(),
+  operations: new Map()
+})