@odata-effect/odata-effect-generator 0.1.0

package/src/generator/QueryModelsGenerator.ts

@@ -0,0 +1,228 @@
+/**
+ * Generator for QueryModels.ts - Type-safe query paths.
+ *
+ * @since 1.0.0
+ */
+import type {
+  ComplexTypeModel,
+  DataModel,
+  EntityTypeModel,
+  NavigationPropertyModel,
+  PropertyModel
+} from "../model/DataModel.js"
+import { getClassName, getQueryFactoryName, getQueryInstanceName, getQueryInterfaceName } from "./NamingHelper.js"
+
+/**
+ * Generate the QueryModels.ts file content.
+ *
+ * @since 1.0.0
+ * @category generation
+ */
+export const generateQueryModels = (dataModel: DataModel): string => {
+  const lines: Array<string> = []
+
+  // Collect all query path types needed
+  const queryPathTypes = collectQueryPathTypes(dataModel)
+
+  // Header
+  lines.push(`/**`)
+  lines.push(` * Type-safe query paths for ${dataModel.serviceName} entities.`)
+  lines.push(` * Generated by odata-effect-gen.`)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` */`)
+  lines.push(`import {`)
+  lines.push(`  ${Array.from(queryPathTypes).join(",\n  ")},`)
+  lines.push(`  createQueryBuilder,`)
+  lines.push(`  type QueryBuilder`)
+  lines.push(`} from "@odata-effect/odata-effect"`)
+
+  // Import entity types that have entity sets (for QueryBuilder generics)
+  const usedEntityNames: Array<string> = []
+  for (const entitySet of dataModel.entitySets.values()) {
+    const entityType = dataModel.entityTypes.get(entitySet.entityTypeFqName)
+    if (entityType) {
+      usedEntityNames.push(entityType.name)
+    }
+  }
+  if (usedEntityNames.length > 0) {
+    lines.push(`import type {`)
+    lines.push(`  ${usedEntityNames.join(",\n  ")}`)
+    lines.push(`} from "./Models.js"`)
+  }
+  lines.push(``)
+
+  // Generate complex type query paths
+  for (const complexType of dataModel.complexTypes.values()) {
+    for (const line of generateQueryInterface(complexType)) lines.push(line)
+    lines.push(``)
+    for (const line of generateQueryInstance(complexType)) lines.push(line)
+    lines.push(``)
+  }
+
+  // Generate entity type query paths
+  for (const entityType of dataModel.entityTypes.values()) {
+    for (const line of generateQueryInterface(entityType)) lines.push(line)
+    lines.push(``)
+    for (const line of generateQueryInstance(entityType)) lines.push(line)
+    lines.push(``)
+  }
+
+  // Generate query builder factories for entity sets
+  for (const entitySet of dataModel.entitySets.values()) {
+    const entityType = dataModel.entityTypes.get(entitySet.entityTypeFqName)
+    if (entityType) {
+      for (const line of generateQueryFactory(entityType)) lines.push(line)
+      lines.push(``)
+    }
+  }
+
+  return lines.join("\n")
+}
+
+/**
+ * Collect all query path types used in the model.
+ */
+const collectQueryPathTypes = (dataModel: DataModel): Set<string> => {
+  const types = new Set<string>()
+
+  const addPropertyTypes = (props: ReadonlyArray<PropertyModel>) => {
+    for (const prop of props) {
+      types.add(prop.typeMapping.queryPath.split("<")[0])
+    }
+  }
+
+  const addNavPropertyTypes = (navProps: ReadonlyArray<NavigationPropertyModel>) => {
+    for (const navProp of navProps) {
+      types.add(navProp.isCollection ? "CollectionPath" : "EntityPath")
+    }
+  }
+
+  for (const complexType of dataModel.complexTypes.values()) {
+    addPropertyTypes(complexType.properties)
+    addNavPropertyTypes(complexType.navigationProperties)
+  }
+
+  for (const entityType of dataModel.entityTypes.values()) {
+    addPropertyTypes(entityType.properties)
+    addNavPropertyTypes(entityType.navigationProperties)
+  }
+
+  return types
+}
+
+/**
+ * Generate a query interface for a type.
+ */
+const generateQueryInterface = (
+  type: EntityTypeModel | ComplexTypeModel
+): Array<string> => {
+  const lines: Array<string> = []
+  const interfaceName = getQueryInterfaceName(type.name)
+
+  lines.push(`/**`)
+  lines.push(` * Query paths for ${type.odataName}.`)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` * @category query-paths`)
+  lines.push(` */`)
+  lines.push(`export interface ${interfaceName} {`)
+
+  for (const prop of type.properties) {
+    const basePathType = prop.typeMapping.queryPath
+    // If it's a collection of complex/entity types, wrap in CollectionPath
+    const pathType = prop.isCollection && basePathType.startsWith("EntityPath<")
+      ? basePathType.replace("EntityPath<", "CollectionPath<")
+      : basePathType
+    lines.push(`  readonly ${prop.name}: ${pathType}`)
+  }
+
+  for (const navProp of type.navigationProperties) {
+    const targetQName = getQueryInterfaceName(getClassName(navProp.targetType))
+    const pathType = navProp.isCollection
+      ? `CollectionPath<${targetQName}>`
+      : `EntityPath<${targetQName}>`
+    lines.push(`  readonly ${navProp.name}: ${pathType}`)
+  }
+
+  lines.push(`}`)
+
+  return lines
+}
+
+/**
+ * Generate a query instance for a type.
+ */
+const generateQueryInstance = (
+  type: EntityTypeModel | ComplexTypeModel
+): Array<string> => {
+  const lines: Array<string> = []
+  const interfaceName = getQueryInterfaceName(type.name)
+  const instanceName = getQueryInstanceName(type.name)
+
+  lines.push(`/**`)
+  lines.push(` * Query paths instance for ${type.odataName}.`)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` * @category query-paths`)
+  lines.push(` */`)
+  lines.push(`export const ${instanceName}: ${interfaceName} = {`)
+
+  const allFields = [...type.properties, ...type.navigationProperties]
+  for (let i = 0; i < type.properties.length; i++) {
+    const prop = type.properties[i]
+    let pathClass = prop.typeMapping.queryPath.split("<")[0]
+    // If it's a collection of complex/entity types, use CollectionPath instead of EntityPath
+    if (prop.isCollection && pathClass === "EntityPath") {
+      pathClass = "CollectionPath"
+    }
+    const isLast = i === allFields.length - 1
+
+    // For EntityPath and CollectionPath, we need to provide the nested query paths
+    if (pathClass === "EntityPath" || pathClass === "CollectionPath") {
+      // Extract the target type from the queryPath generic (e.g., "EntityPath<QAddress>" -> "QAddress")
+      const targetMatch = prop.typeMapping.queryPath.match(/<Q(\w+)>/)
+      const targetInstanceName = targetMatch ? `q${targetMatch[1]}` : "undefined"
+      lines.push(
+        `  ${prop.name}: new ${pathClass}("${prop.odataName}", () => ${targetInstanceName})${isLast ? "" : ","}`
+      )
+    } else {
+      lines.push(`  ${prop.name}: new ${pathClass}("${prop.odataName}")${isLast ? "" : ","}`)
+    }
+  }
+
+  for (let i = 0; i < type.navigationProperties.length; i++) {
+    const navProp = type.navigationProperties[i]
+    const targetInstanceName = getQueryInstanceName(getClassName(navProp.targetType))
+    const pathClass = navProp.isCollection ? "CollectionPath" : "EntityPath"
+    const isLast = i === type.navigationProperties.length - 1
+    lines.push(
+      `  ${navProp.name}: new ${pathClass}("${navProp.odataName}", () => ${targetInstanceName})${isLast ? "" : ","}`
+    )
+  }
+
+  lines.push(`}`)
+
+  return lines
+}
+
+/**
+ * Generate a query builder factory for an entity type.
+ */
+const generateQueryFactory = (entityType: EntityTypeModel): Array<string> => {
+  const lines: Array<string> = []
+  const interfaceName = getQueryInterfaceName(entityType.name)
+  const instanceName = getQueryInstanceName(entityType.name)
+  const factoryName = getQueryFactoryName(entityType.name)
+
+  lines.push(`/**`)
+  lines.push(` * Creates a type-safe query builder for ${entityType.odataName} entities.`)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` * @category constructors`)
+  lines.push(` */`)
+  lines.push(`export const ${factoryName} = (): QueryBuilder<${entityType.name}, ${interfaceName}> =>`)
+  lines.push(`  createQueryBuilder<${entityType.name}, ${interfaceName}>(${instanceName})`)
+
+  return lines
+}

package/src/generator/ServiceFnGenerator.ts

@@ -0,0 +1,324 @@
+/**
+ * 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
+ */
+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 odataNamespace: string
+  readonly buildEntityPath: string
+  readonly queryOptionsType: string
+  readonly clientConfigTag: string
+}
+
+const V2_CONFIG: VersionConfig = {
+  odataNamespace: "OData",
+  buildEntityPath: "buildEntityPath",
+  queryOptionsType: "ODataQueryOptions",
+  clientConfigTag: "ODataClientConfig"
+}
+
+const V4_CONFIG: VersionConfig = {
+  odataNamespace: "ODataV4",
+  buildEntityPath: "buildEntityPathV4",
+  queryOptionsType: "ODataV4QueryOptions",
+  clientConfigTag: "ODataV4ClientConfig"
+}
+
+const getVersionConfig = (version: ODataVersion): VersionConfig => version === "V4" ? V4_CONFIG : V2_CONFIG
+
+/**
+ * Generated service function file.
+ *
+ * @since 1.0.0
+ * @category types
+ */
+export interface GeneratedServiceFnFile {
+  readonly fileName: string
+  readonly content: string
+}
+
+/**
+ * Result of service function generation.
+ *
+ * @since 1.0.0
+ * @category types
+ */
+export interface ServiceFnGenerationResult {
+  readonly entityServices: ReadonlyArray<GeneratedServiceFnFile>
+}
+
+/**
+ * Generate all tree-shakable service function files.
+ *
+ * @since 1.0.0
+ * @category generation
+ */
+export const generateServiceFns = (dataModel: DataModel): ServiceFnGenerationResult => {
+  const entityServices: Array<GeneratedServiceFnFile> = []
+
+  // Generate individual entity service files
+  for (const entitySet of dataModel.entitySets.values()) {
+    const entityType = dataModel.entityTypes.get(entitySet.entityTypeFqName)
+    if (entityType) {
+      const serviceClassName = getServiceClassName(entitySet.name)
+      entityServices.push({
+        fileName: `${serviceClassName}.ts`,
+        content: generateEntityServiceFnFile(entitySet, entityType, dataModel)
+      })
+    }
+  }
+
+  return { entityServices }
+}
+
+/**
+ * Generate a single entity service function file.
+ */
+const generateEntityServiceFnFile = (
+  entitySet: EntitySetModel,
+  entityType: EntityTypeModel,
+  dataModel: DataModel
+): string => {
+  const lines: Array<string> = []
+  const versionConfig = getVersionConfig(dataModel.version)
+  const serviceClassName = getServiceClassName(entitySet.name)
+  const entityName = entityType.name
+  const idTypeName = getIdTypeName(entityName)
+  const editableName = getEditableTypeName(entityName)
+  const hasKeys = entityType.keys.length > 0
+  const isV4 = dataModel.version === "V4"
+
+  // Header and imports
+  lines.push(`/**`)
+  lines.push(
+    ` * Tree-shakable ${entityName} service functions for ${dataModel.serviceName} OData ${dataModel.version}.`
+  )
+  lines.push(` * Generated by odata-effect-gen.`)
+  lines.push(` *`)
+  lines.push(` * @example`)
+  lines.push(` * \`\`\`ts`)
+  lines.push(` * // Namespace import - nice autocomplete, tree-shakable`)
+  lines.push(` * import { ${serviceClassName} } from "@template/${dataModel.serviceName.toLowerCase()}-effect"`)
+  lines.push(` * const items = yield* ${serviceClassName}.getAll()`)
+  lines.push(` *`)
+  lines.push(` * // Direct import - maximum tree-shaking`)
+  lines.push(` * import { getAll } from "@template/${dataModel.serviceName.toLowerCase()}-effect/${serviceClassName}"`)
+  lines.push(` * const items = yield* getAll()`)
+  lines.push(` * \`\`\``)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` */`)
+  lines.push(`import type * as Effect from "effect/Effect"`)
+  lines.push(`import * as Schema from "effect/Schema"`)
+  lines.push(`import type { HttpClient } from "@effect/platform"`)
+  lines.push(`import type * as HttpClientError from "@effect/platform/HttpClientError"`)
+  lines.push(`import type * as HttpBody from "@effect/platform/HttpBody"`)
+  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(``)
+
+  // Import OData infrastructure (version-specific)
+  lines.push(`import {`)
+  lines.push(`  ${versionConfig.odataNamespace},`)
+  lines.push(`  ${versionConfig.buildEntityPath},`)
+  lines.push(`  ${versionConfig.clientConfigTag},`)
+  lines.push(`  type ${versionConfig.queryOptionsType},`)
+  if (!isV4) {
+    lines.push(`  type SapError,`)
+  }
+  lines.push(`  type ODataError,`)
+  lines.push(`  type ParseError`)
+  lines.push(`} from "@odata-effect/odata-effect"`)
+  lines.push(``)
+
+  // Service error type
+  lines.push(`// ============================================================================`)
+  lines.push(`// Types`)
+  lines.push(`// ============================================================================`)
+  lines.push(``)
+  lines.push(`/**`)
+  lines.push(` * Error type for ${entityName} service operations.`)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` * @category errors`)
+  lines.push(` */`)
+  lines.push(`export type ${serviceClassName}Error =`)
+  lines.push(`  | HttpClientError.HttpClientError`)
+  lines.push(`  | HttpBody.HttpBodyError`)
+  lines.push(`  | ParseError`)
+  if (!isV4) {
+    lines.push(`  | SapError`)
+  }
+  lines.push(`  | ODataError`)
+  lines.push(``)
+
+  // Dependencies type
+  lines.push(`/**`)
+  lines.push(` * Dependencies required for ${entityName} service operations.`)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` * @category context`)
+  lines.push(` */`)
+  lines.push(`export type ${serviceClassName}Context = ${versionConfig.clientConfigTag} | HttpClient.HttpClient`)
+  lines.push(``)
+
+  // ID normalizer (if entity has keys)
+  if (hasKeys) {
+    lines.push(`// ============================================================================`)
+    lines.push(`// Internal Helpers`)
+    lines.push(`// ============================================================================`)
+    lines.push(``)
+    const normalizeIdFn = `normalizeId`
+    lines.push(`const ${normalizeIdFn} = (id: ${idTypeName}): string =>`)
+
+    if (entityType.keys.length === 1) {
+      const keyProp = entityType.keys[0]
+      const keyTsType = keyProp.typeMapping.tsType
+      const primitiveCheck = keyTsType === "number" ? "number" : "string"
+      lines.push(`  typeof id === "${primitiveCheck}" ? String(id) : String(id.${keyProp.name})`)
+    } else {
+      const keyParts = entityType.keys.map((k) => `${k.odataName}='\${String(id.${k.name})}'`).join(",")
+      lines.push(`  typeof id === "string" ? id : \`${keyParts}\``)
+    }
+    lines.push(``)
+  }
+
+  // Standalone functions
+  lines.push(`// ============================================================================`)
+  lines.push(`// Standalone Tree-Shakable 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(`  options?: ${versionConfig.queryOptionsType}`)
+  lines.push(`): Effect.Effect<`)
+  lines.push(`  ReadonlyArray<${entityName}>,`)
+  lines.push(`  ${serviceClassName}Error,`)
+  lines.push(`  ${serviceClassName}Context`)
+  lines.push(`> =>`)
+  lines.push(`  ${versionConfig.odataNamespace}.getCollection("${entitySet.name}", ${entityName}, options)`)
+  lines.push(``)
+
+  // getById (if entity has keys)
+  if (hasKeys) {
+    const keyObj = entityType.keys.length === 1
+      ? `{ ${entityType.keys[0].odataName}: normalizeId(id) }`
+      : `normalizeId(id)`
+
+    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(`  id: ${idTypeName}`)
+    lines.push(`): Effect.Effect<`)
+    lines.push(`  ${entityName},`)
+    lines.push(`  ${serviceClassName}Error,`)
+    lines.push(`  ${serviceClassName}Context`)
+    lines.push(`> =>`)
+    lines.push(`  ${versionConfig.odataNamespace}.get(`)
+    lines.push(`    ${versionConfig.buildEntityPath}("${entitySet.name}", ${keyObj}),`)
+    lines.push(`    ${entityName}`)
+    lines.push(`  )`)
+    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(`  entity: ${editableName}`)
+  lines.push(`): Effect.Effect<`)
+  lines.push(`  ${entityName},`)
+  lines.push(`  ${serviceClassName}Error,`)
+  lines.push(`  ${serviceClassName}Context`)
+  lines.push(`> =>`)
+  lines.push(`  ${versionConfig.odataNamespace}.post("${entitySet.name}", entity, ${editableName}, ${entityName})`)
+  lines.push(``)
+
+  // update (if entity has keys)
+  if (hasKeys) {
+    const keyObj = entityType.keys.length === 1
+      ? `{ ${entityType.keys[0].odataName}: normalizeId(id) }`
+      : `normalizeId(id)`
+
+    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(`  id: ${idTypeName},`)
+    lines.push(`  entity: Partial<${editableName}>`)
+    lines.push(`): Effect.Effect<`)
+    lines.push(`  void,`)
+    lines.push(`  ${serviceClassName}Error,`)
+    lines.push(`  ${serviceClassName}Context`)
+    lines.push(`> =>`)
+    lines.push(`  ${versionConfig.odataNamespace}.patch(`)
+    lines.push(`    ${versionConfig.buildEntityPath}("${entitySet.name}", ${keyObj}),`)
+    lines.push(`    entity,`)
+    lines.push(`    Schema.partial(${editableName})`)
+    lines.push(`  )`)
+    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(`  id: ${idTypeName}`)
+    lines.push(`): Effect.Effect<`)
+    lines.push(`  void,`)
+    lines.push(`  ${serviceClassName}Error,`)
+    lines.push(`  ${serviceClassName}Context`)
+    lines.push(`> =>`)
+    lines.push(`  ${versionConfig.odataNamespace}.del(`)
+    lines.push(`    ${versionConfig.buildEntityPath}("${entitySet.name}", ${keyObj})`)
+    lines.push(`  )`)
+    lines.push(``)
+
+    // Alias for nice naming
+    lines.push(`// Alias for nice naming`)
+    lines.push(`export { del as delete }`)
+    lines.push(``)
+  }
+
+  return lines.join("\n")
+}