@odata-effect/odata-effect-generator 0.1.0

package/src/generator/ModelsGenerator.ts

@@ -0,0 +1,344 @@
+/**
+ * Generator for Models.ts - Effect Schema definitions.
+ *
+ * @since 1.0.0
+ */
+import type {
+  ComplexTypeModel,
+  DataModel,
+  EntityTypeModel,
+  EnumTypeModel,
+  NavigationPropertyModel,
+  PropertyModel
+} from "../model/DataModel.js"
+import { getClassName, getEditableTypeName, getIdTypeName } from "./NamingHelper.js"
+
+/**
+ * Get dependencies for a type (complex types it references via properties or baseType).
+ */
+const getTypeDependencies = (
+  type: ComplexTypeModel | EntityTypeModel,
+  allComplexTypes: Set<string>,
+  allEntityTypes: Set<string>
+): Set<string> => {
+  const deps = new Set<string>()
+
+  // Add base type dependency if it exists
+  if (type.baseType) {
+    const baseTypeName = getClassName(type.baseType.split(".").pop() ?? type.baseType)
+    if (allComplexTypes.has(baseTypeName) || allEntityTypes.has(baseTypeName)) {
+      deps.add(baseTypeName)
+    }
+  }
+
+  // Add property type dependencies (for complex types referenced in properties)
+  for (const prop of type.properties) {
+    const propTypeName = prop.typeMapping.effectSchema
+    if (allComplexTypes.has(propTypeName)) {
+      deps.add(propTypeName)
+    }
+  }
+
+  return deps
+}
+
+/**
+ * Topologically sort types based on their dependencies.
+ */
+const sortTypesByDependency = <T extends ComplexTypeModel | EntityTypeModel>(
+  types: Array<T>,
+  allComplexTypes: Set<string>,
+  allEntityTypes: Set<string>
+): Array<T> => {
+  const sorted: Array<T> = []
+  const visited = new Set<string>()
+  const visiting = new Set<string>()
+
+  const visit = (type: T) => {
+    if (visited.has(type.name)) return
+    if (visiting.has(type.name)) {
+      // Circular dependency - just add it
+      visited.add(type.name)
+      sorted.push(type)
+      return
+    }
+
+    visiting.add(type.name)
+
+    const deps = getTypeDependencies(type, allComplexTypes, allEntityTypes)
+    for (const depName of deps) {
+      const depType = types.find((t) => t.name === depName)
+      if (depType && !visited.has(depName)) {
+        visit(depType)
+      }
+    }
+
+    visiting.delete(type.name)
+    visited.add(type.name)
+    sorted.push(type)
+  }
+
+  for (const type of types) {
+    visit(type)
+  }
+
+  return sorted
+}
+
+/**
+ * Generate the Models.ts file content.
+ *
+ * @since 1.0.0
+ * @category generation
+ */
+export const generateModels = (dataModel: DataModel): string => {
+  const lines: Array<string> = []
+
+  // Collect all type names for dependency resolution
+  const allComplexTypes = new Set(Array.from(dataModel.complexTypes.values()).map((t) => t.name))
+  const allEntityTypes = new Set(Array.from(dataModel.entityTypes.values()).map((t) => t.name))
+
+  // Header
+  lines.push(`/**`)
+  lines.push(` * Effect Schema models for ${dataModel.serviceName} OData service.`)
+  lines.push(` * Generated by odata-effect-gen.`)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` */`)
+  lines.push(`import * as Schema from "effect/Schema"`)
+  lines.push(``)
+
+  // Generate enum types (no dependencies, always first)
+  for (const enumType of dataModel.enumTypes.values()) {
+    for (const line of generateEnumType(enumType)) lines.push(line)
+    lines.push(``)
+  }
+
+  // Generate complex types in dependency order
+  const sortedComplexTypes = sortTypesByDependency(
+    Array.from(dataModel.complexTypes.values()),
+    allComplexTypes,
+    allEntityTypes
+  )
+  for (const complexType of sortedComplexTypes) {
+    for (const line of generateComplexType(complexType, dataModel)) lines.push(line)
+    lines.push(``)
+  }
+
+  // Generate entity types in dependency order
+  const sortedEntityTypes = sortTypesByDependency(
+    Array.from(dataModel.entityTypes.values()),
+    allComplexTypes,
+    allEntityTypes
+  )
+  for (const entityType of sortedEntityTypes) {
+    for (const line of generateEntityType(entityType, dataModel)) lines.push(line)
+    lines.push(``)
+  }
+
+  return lines.join("\n")
+}
+
+/**
+ * Generate an enum type.
+ */
+const generateEnumType = (enumType: EnumTypeModel): Array<string> => {
+  const lines: Array<string> = []
+  const members = enumType.members.map((m) => `"${m.name}"`).join(", ")
+
+  lines.push(`/**`)
+  lines.push(` * ${enumType.odataName} enum type.`)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` * @category enums`)
+  lines.push(` */`)
+  lines.push(`export const ${enumType.name} = Schema.Literal(${members})`)
+  lines.push(`export type ${enumType.name} = Schema.Schema.Type<typeof ${enumType.name}>`)
+
+  return lines
+}
+
+/**
+ * Generate a complex type.
+ */
+const generateComplexType = (
+  complexType: ComplexTypeModel,
+  dataModel: DataModel
+): Array<string> => {
+  const lines: Array<string> = []
+
+  lines.push(`/**`)
+  lines.push(` * ${complexType.odataName} complex type.`)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` * @category models`)
+  lines.push(` */`)
+
+  const fields = generateSchemaFields(complexType.properties, complexType.navigationProperties, dataModel)
+
+  lines.push(`export class ${complexType.name} extends Schema.Class<${complexType.name}>("${complexType.name}")({`)
+  for (const f of fields) lines.push(`  ${f}`)
+  lines.push(`}) {}`)
+
+  // Generate editable type
+  lines.push(``)
+  lines.push(`/**`)
+  lines.push(` * Editable ${complexType.odataName} for creating/updating operations.`)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` * @category models`)
+  lines.push(` */`)
+
+  const editableFields = generateEditableSchemaFields(complexType.properties)
+  const editableName = getEditableTypeName(complexType.name)
+
+  lines.push(`export const ${editableName} = Schema.Struct({`)
+  for (const f of editableFields) lines.push(`  ${f}`)
+  lines.push(`})`)
+  lines.push(`export type ${editableName} = Schema.Schema.Type<typeof ${editableName}>`)
+
+  return lines
+}
+
+/**
+ * Generate an entity type with ID and editable variants.
+ */
+const generateEntityType = (
+  entityType: EntityTypeModel,
+  dataModel: DataModel
+): Array<string> => {
+  const lines: Array<string> = []
+
+  // Main entity class
+  lines.push(`/**`)
+  lines.push(` * ${entityType.odataName} entity type.`)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` * @category models`)
+  lines.push(` */`)
+
+  const fields = generateSchemaFields(entityType.properties, entityType.navigationProperties, dataModel)
+
+  lines.push(`export class ${entityType.name} extends Schema.Class<${entityType.name}>("${entityType.name}")({`)
+  for (const f of fields) lines.push(`  ${f}`)
+  lines.push(`}) {}`)
+
+  // ID type
+  if (entityType.keys.length > 0) {
+    lines.push(``)
+    lines.push(`/**`)
+    lines.push(` * ${entityType.odataName} ID type.`)
+    lines.push(` *`)
+    lines.push(` * @since 1.0.0`)
+    lines.push(` * @category models`)
+    lines.push(` */`)
+
+    const idTypeName = getIdTypeName(entityType.name)
+
+    if (entityType.keys.length === 1) {
+      const key = entityType.keys[0]
+      const keySchema = getPropertySchemaType(key, false)
+      lines.push(`export const ${idTypeName} = Schema.Union(`)
+      lines.push(`  ${keySchema},`)
+      lines.push(`  Schema.Struct({ ${key.name}: ${keySchema} })`)
+      lines.push(`)`)
+    } else {
+      // Composite key
+      const keyFields = entityType.keys.map((k) => {
+        const schema = getPropertySchemaType(k, false)
+        return `${k.name}: ${schema}`
+      })
+      lines.push(`export const ${idTypeName} = Schema.Union(`)
+      lines.push(`  Schema.String,`)
+      lines.push(`  Schema.Struct({ ${keyFields.join(", ")} })`)
+      lines.push(`)`)
+    }
+    lines.push(`export type ${idTypeName} = Schema.Schema.Type<typeof ${idTypeName}>`)
+  }
+
+  // Editable type
+  lines.push(``)
+  lines.push(`/**`)
+  lines.push(` * Editable ${entityType.odataName} for creating/updating operations.`)
+  lines.push(` *`)
+  lines.push(` * @since 1.0.0`)
+  lines.push(` * @category models`)
+  lines.push(` */`)
+
+  const editableFields = generateEditableSchemaFields(
+    entityType.properties.filter((p) => !p.isKey)
+  )
+  const editableName = getEditableTypeName(entityType.name)
+
+  lines.push(`export const ${editableName} = Schema.Struct({`)
+  for (const f of editableFields) lines.push(`  ${f}`)
+  lines.push(`})`)
+  lines.push(`export type ${editableName} = Schema.Schema.Type<typeof ${editableName}>`)
+
+  return lines
+}
+
+/**
+ * Generate schema field definitions for a class.
+ * Note: Navigation properties are excluded to avoid circular reference issues.
+ * They can be loaded via $expand queries.
+ */
+const generateSchemaFields = (
+  properties: ReadonlyArray<PropertyModel>,
+  _navigationProperties: ReadonlyArray<NavigationPropertyModel>,
+  _dataModel: DataModel
+): Array<string> => {
+  const fields: Array<string> = []
+
+  for (let i = 0; i < properties.length; i++) {
+    const prop = properties[i]
+    const schemaType = getPropertySchemaType(prop, prop.isNullable && !prop.isKey)
+    const isLast = i === properties.length - 1
+    fields.push(`${prop.name}: ${schemaType}${isLast ? "" : ","}`)
+  }
+
+  // Navigation properties are intentionally excluded from Schema.Class
+  // to avoid circular reference issues. They can be loaded via $expand.
+
+  return fields
+}
+
+/**
+ * Generate schema field definitions for an editable struct.
+ */
+const generateEditableSchemaFields = (
+  properties: ReadonlyArray<PropertyModel>
+): Array<string> => {
+  const fields: Array<string> = []
+
+  for (let i = 0; i < properties.length; i++) {
+    const prop = properties[i]
+    const schemaType = getPropertySchemaType(prop, prop.isNullable)
+    const isLast = i === properties.length - 1
+    fields.push(`${prop.name}: ${schemaType}${isLast ? "" : ","}`)
+  }
+
+  return fields
+}
+
+/**
+ * Get the Schema type for a property.
+ */
+const getPropertySchemaType = (
+  prop: PropertyModel,
+  makeOptional: boolean
+): string => {
+  let baseType = prop.typeMapping.effectSchema
+
+  // Handle collection
+  if (prop.isCollection) {
+    baseType = `Schema.Array(${baseType})`
+  }
+
+  // Handle nullable/optional
+  if (makeOptional) {
+    return `Schema.optionalWith(${baseType}, { nullable: true })`
+  }
+
+  return baseType
+}

package/src/generator/NamingHelper.ts

@@ -0,0 +1,159 @@
+/**
+ * Naming utilities for code generation.
+ *
+ * @since 1.0.0
+ */
+
+/**
+ * Convert a string to PascalCase.
+ *
+ * @example
+ * toPascalCase("hello_world") // "HelloWorld"
+ * toPascalCase("helloWorld") // "HelloWorld"
+ *
+ * @since 1.0.0
+ * @category naming
+ */
+export const toPascalCase = (str: string): string => {
+  return str
+    .replace(/[-_](.)/g, (_, char) => char.toUpperCase())
+    .replace(/^(.)/, (char) => char.toUpperCase())
+}
+
+/**
+ * Convert a string to camelCase.
+ *
+ * @example
+ * toCamelCase("HelloWorld") // "helloWorld"
+ * toCamelCase("hello_world") // "helloWorld"
+ *
+ * @since 1.0.0
+ * @category naming
+ */
+export const toCamelCase = (str: string): string => {
+  const pascal = toPascalCase(str)
+  return pascal.charAt(0).toLowerCase() + pascal.slice(1)
+}
+
+/**
+ * Ensure a string is a valid TypeScript identifier.
+ * Prefixes with underscore if it starts with a number.
+ *
+ * @since 1.0.0
+ * @category naming
+ */
+export const toValidIdentifier = (str: string): string => {
+  // If starts with a number, prefix with underscore
+  if (/^[0-9]/.test(str)) {
+    return `_${str}`
+  }
+  // Replace invalid characters with underscores
+  return str.replace(/[^a-zA-Z0-9_$]/g, "_")
+}
+
+/**
+ * Get the TypeScript property name for an OData property.
+ *
+ * @since 1.0.0
+ * @category naming
+ */
+export const getPropertyName = (odataName: string): string => {
+  return toCamelCase(toValidIdentifier(odataName))
+}
+
+/**
+ * Get the TypeScript class name for an OData entity or complex type.
+ *
+ * @since 1.0.0
+ * @category naming
+ */
+export const getClassName = (odataName: string): string => {
+  return toPascalCase(toValidIdentifier(odataName))
+}
+
+/**
+ * Get the service class name for an entity set.
+ *
+ * @example
+ * getServiceClassName("Products") // "ProductService"
+ *
+ * @since 1.0.0
+ * @category naming
+ */
+export const getServiceClassName = (entitySetName: string): string => {
+  // Remove trailing 's' if present to singularize
+  let singular = entitySetName
+  if (singular.endsWith("ies")) {
+    singular = singular.slice(0, -3) + "y"
+  } else if (singular.endsWith("es") && !singular.endsWith("ses")) {
+    singular = singular.slice(0, -2)
+  } else if (singular.endsWith("s") && !singular.endsWith("ss")) {
+    singular = singular.slice(0, -1)
+  }
+  return `${toPascalCase(singular)}Service`
+}
+
+/**
+ * Get the query paths interface name for a type.
+ *
+ * @example
+ * getQueryInterfaceName("Product") // "QProduct"
+ *
+ * @since 1.0.0
+ * @category naming
+ */
+export const getQueryInterfaceName = (typeName: string): string => {
+  return `Q${toPascalCase(typeName)}`
+}
+
+/**
+ * Get the query paths instance name for a type.
+ *
+ * @example
+ * getQueryInstanceName("Product") // "qProduct"
+ *
+ * @since 1.0.0
+ * @category naming
+ */
+export const getQueryInstanceName = (typeName: string): string => {
+  return `q${toPascalCase(typeName)}`
+}
+
+/**
+ * Get the query builder factory function name for a type.
+ *
+ * @example
+ * getQueryFactoryName("Product") // "productQuery"
+ *
+ * @since 1.0.0
+ * @category naming
+ */
+export const getQueryFactoryName = (typeName: string): string => {
+  return `${toCamelCase(typeName)}Query`
+}
+
+/**
+ * Get the editable type name for an entity type.
+ *
+ * @example
+ * getEditableTypeName("Product") // "EditableProduct"
+ *
+ * @since 1.0.0
+ * @category naming
+ */
+export const getEditableTypeName = (typeName: string): string => {
+  return `Editable${toPascalCase(typeName)}`
+}
+
+/**
+ * Get the ID type name for an entity type.
+ *
+ * @example
+ * getIdTypeName("Product") // "ProductId"
+ *
+ * @since 1.0.0
+ * @category naming
+ */
+export const getIdTypeName = (typeName: string): string => {
+  return `${toPascalCase(typeName)}Id`
+}

package/src/generator/PackageGenerator.ts

@@ -0,0 +1,176 @@
+/**
+ * Generator for package configuration files.
+ *
+ * @since 1.0.0
+ */
+import type { DataModel } from "../model/DataModel.js"
+
+export interface PackageConfig {
+  readonly packageName: string
+  readonly serviceName: string
+}
+
+/**
+ * Generate package.json content.
+ *
+ * @since 1.0.0
+ * @category generation
+ */
+export const generatePackageJson = (
+  dataModel: DataModel,
+  config: PackageConfig
+): string => {
+  const packageJson = {
+    name: config.packageName,
+    version: "0.0.0",
+    type: "module",
+    license: "MIT",
+    description: `Effect-based OData client for ${dataModel.serviceName} service`,
+    publishConfig: {
+      access: "public",
+      directory: "dist"
+    },
+    scripts: {
+      codegen: "build-utils prepare-v2",
+      build: "pnpm build-esm && pnpm build-annotate && pnpm build-cjs && build-utils pack-v2",
+      "build-esm": "tsc -b tsconfig.build.json",
+      "build-cjs":
+        "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
+      "build-annotate": "babel build/esm --plugins annotate-pure-calls --out-dir build/esm --source-maps",
+      check: "tsc -b tsconfig.json",
+      test: "vitest",
+      coverage: "vitest --coverage"
+    },
+    dependencies: {
+      "@effect/platform": "^0.94.0",
+      "@odata-effect/odata-effect": "workspace:*",
+      "@odata-effect/odata-effect-promise": "workspace:*",
+      effect: "^3.10.7"
+    },
+    devDependencies: {
+      "@odata-effect/odata-effect": "workspace:*",
+      "@odata-effect/odata-effect-promise": "workspace:*"
+    },
+    effect: {
+      generateExports: {
+        include: ["**/*.ts"]
+      },
+      generateIndex: {
+        include: ["**/*.ts"]
+      }
+    }
+  }
+
+  return JSON.stringify(packageJson, null, 2)
+}
+
+/**
+ * Generate tsconfig.json content.
+ *
+ * @since 1.0.0
+ * @category generation
+ */
+export const generateTsconfig = (): string => {
+  const tsconfig = {
+    extends: "../../tsconfig.base.json",
+    include: [],
+    references: [
+      { path: "tsconfig.src.json" },
+      { path: "tsconfig.test.json" }
+    ]
+  }
+
+  return JSON.stringify(tsconfig, null, 2)
+}
+
+/**
+ * Generate tsconfig.src.json content.
+ *
+ * @since 1.0.0
+ * @category generation
+ */
+export const generateTsconfigSrc = (): string => {
+  const tsconfig = {
+    extends: "../../tsconfig.base.json",
+    include: ["src"],
+    references: [
+      { path: "../ODataEffect/tsconfig.src.json" },
+      { path: "../ODataEffectPromise/tsconfig.src.json" }
+    ],
+    compilerOptions: {
+      types: ["node"],
+      outDir: "build/src",
+      tsBuildInfoFile: ".tsbuildinfo/src.tsbuildinfo",
+      rootDir: "src"
+    }
+  }
+
+  return JSON.stringify(tsconfig, null, 2)
+}
+
+/**
+ * Generate tsconfig.test.json content.
+ *
+ * @since 1.0.0
+ * @category generation
+ */
+export const generateTsconfigTest = (): string => {
+  const tsconfig = {
+    extends: "../../tsconfig.base.json",
+    include: ["test"],
+    references: [
+      { path: "tsconfig.src.json" },
+      { path: "../ODataEffect/tsconfig.src.json" },
+      { path: "../ODataEffectPromise/tsconfig.src.json" }
+    ],
+    compilerOptions: {
+      types: ["node"],
+      tsBuildInfoFile: ".tsbuildinfo/test.tsbuildinfo",
+      rootDir: "test",
+      noEmit: true
+    }
+  }
+
+  return JSON.stringify(tsconfig, null, 2)
+}
+
+/**
+ * Generate tsconfig.build.json content.
+ *
+ * @since 1.0.0
+ * @category generation
+ */
+export const generateTsconfigBuild = (): string => {
+  const tsconfig = {
+    extends: "./tsconfig.src.json",
+    references: [
+      { path: "../ODataEffect/tsconfig.build.json" },
+      { path: "../ODataEffectPromise/tsconfig.build.json" }
+    ],
+    compilerOptions: {
+      types: ["node"],
+      tsBuildInfoFile: ".tsbuildinfo/build.tsbuildinfo",
+      outDir: "build/esm",
+      declarationDir: "build/dts",
+      stripInternal: true
+    }
+  }
+
+  return JSON.stringify(tsconfig, null, 2)
+}
+
+/**
+ * Generate vitest.config.ts content.
+ *
+ * @since 1.0.0
+ * @category generation
+ */
+export const generateVitestConfig = (): string => {
+  return `import { mergeConfig, type UserConfigExport } from "vitest/config"
+import shared from "../../vitest.shared.js"
+
+const config: UserConfigExport = {}
+
+export default mergeConfig(shared, config)
+`
+}