Inconsistencies between API Documentation and Implementation

[ageofalgo]

Hi! Great work, I am spending some time on this hoping to use it as a preferred option. Encountered some issues when trying to launch Agent studio. Maybe it's just me but I thought I'd leave it here.

Description

While implementing an AI agent using the Eternal AI framework, I encountered some inconsistencies between the documentation and the actual implementation.

1. API Documentation vs testing

// What documentation suggests:
import { BaseDagent, IAgentCharacter, InitAgent } from "@eternal-dagent/core";

// What actually works:
import { 
  AgentClient as BaseDagent,
  IAgentCharacter,
  IAgent as InitAgent 
} from "@eternal-dagent/core";

2. Method Availability

The createAgent() method is referenced but It can't be found on AgentClient:

// What documentation suggests:
const res: IAgent = (await baseAgent.createAgent()) as IAgent;

// What actually works:
const res: IAgent = await AgentClient.create(baseAgent) as IAgent;

3. Type System Issues

• TypeScript version conflicts, TypeScript defined in both dependencies and devDependencies. (requires TS 4.9.5)
• Missing type definitions for core components
• Inconsistent naming between types and implementations

Steps to Reproduce

1. Create new project using Agent Studio
2. Install dependencies
3. Try to create an agent following the documentation
4. Encounter missing exports and methods

Environment

• Node.js: [v 22.12.0]
• TypeScript: 4.9.5
• @eternal-dagent/core:
• Operating System: [Mac OS X]

Current Workarounds

1. Use correct imports:

import { 
  AgentClient as BaseDagent,
  IAgentCharacter,
  IAgent as InitAgent 
} from "@eternal-dagent/core";

2. Use correct method calls:

const res: IAgent = await AgentClient.create(baseAgent) as IAgent;

3. Pin TypeScript version to 4.9.5

Suggested Improvements

1. Update documentation to reflect actual exports and methods
2. Provide comprehensive type definitions
3. Maintain consistency between docs and implementation
4. Add version compatibility guide
5. Consider adding migration documentation

[6789tc]

hey @ageofalgo, thanks for creating the issue, we are looking into it and will get back to you here soon.