@autobe/agent 0.30.0-dev.20260315 → 0.30.1

package/README.md

@@ -1,261 +0,0 @@
-# AutoBE - AI backend builder for prototype to production
-
-[![GitHub License](https://img.shields.io/badge/license-AGPL--3.0-blue.svg)](https://github.com/wrtnlabs/autobe/blob/master/LICENSE)
-[![NPM Version](https://img.shields.io/npm/v/@autobe/agent.svg)](https://www.npmjs.com/package/@autobe/agent)
-[![NPM Downloads](https://img.shields.io/npm/dm/@autobe/agent.svg)](https://www.npmjs.com/package/@autobe/agent)
-[![Build Status](https://github.com/wrtnlabs/autobe/workflows/build/badge.svg?branch=main)](https://github.com/wrtnlabs/autobe/actions?query=workflow%3Abuild)
-[![Guide Documents](https://img.shields.io/badge/Guide-Documents-forestgreen)](https://autobe.dev/docs/)
-[![Discord Badge](https://dcbadge.limes.pink/api/server/https://discord.gg/aMhRmzkqCx?style=flat)](https://discord.gg/aMhRmzkqCx)
-
-Describe your backend requirements in natural language through AutoBE's chat interface. 
-
-AutoBE will analyze your requirements and build the backend application for you. The generated backend application is designed to be 100% buildable by AI-friendly compilers and ensures stability through powerful e2e test functions.
-
-With such AutoBE, build your first backend application quickly, then maintain and extend it with AI code assistants like Claude Code for enhanced productivity and stability.
-
-AutoBE will generate complete specifications, detailed database and API documentation, comprehensive test coverage for stability, and clean implementation logic that serves as a learning foundation for juniors while significantly improving senior developer productivity.
-
-Check out these complete backend application examples generated by AutoBE:
-
-https://github.com/user-attachments/assets/b995dd2a-23bd-43c9-96cb-96d5c805f19f
-
-1. **To Do List**: [`todo`](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/todo)
-2. **Discussion Board**: [`bbs`](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/bbs)
-3. **Reddit Community**: [`reddit](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/reddit)
-4. **E-Commerce**: [`shopping`](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/shopping)
-   - Requirements Analysis: [Report](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/shopping/docs/analysis)
-   - Database Design: [Entity Relationship Diagram](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/shopping/docs/ERD.md) / [Prisma Schema](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/shopping/prisma/schema)
-   - API Design: [API Controllers](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/shopping/src/controllers) / [DTO Structures](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/shopping/src/api/structures)
-   - E2E Test Functions: [`test/features/api`](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/shopping/test/features/api)
-   - API Implementations: [`src/providers`](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/shopping/src/providers)
-
-## Getting Started
-
-```bash
-git clone https://github.com/wrtnlabs/autobe --depth=1
-cd autobe
-pnpm install
-pnpm run playground
-```
-
-To use AutoBE, clone the repository and run the playground application locally. This allows you to chat with AutoBE's AI agents, manage multiple sessions, and use various LLM providers including local models like `qwen3-next-80b-a3b-instruct`.
-
-After installation, the playground will be available at http://localhost:5713. You can interact with AutoBE through a chat interface - simply describe what you want to build, and AutoBE will generate the backend application for you.
-
-Here's an example conversation script that guides AutoBE to create an "Economic/Political Discussion Board":
-
-1. **Requirements Analysis**: "I want to create an economic/political discussion board. Since I'm not familiar with programming, please write a requirements analysis report as you see fit."
-2. **Database Design**: "Design the database schema."
-3. **API Specification**: "Create the API interface specification."
-4. **Testing**: "Make the e2e test functions."
-5. **Implementation**: "Implement API functions."
-
-![Compilation Success Dashboard](https://autobe.dev/images/demonstrate/replay-z-ai-glm-5.png)
-
-> The playground includes a replay feature at http://localhost:5713/replay/index.html where you can view chat sessions from the AutoBE development team's testing and benchmarks.
-
-## Documentation Resources
-
-Find comprehensive resources at our [official website](https://autobe.dev).
-
-### 🏠 Home
-
-- 🙋🏻‍♂️ [Introduction](https://autobe.dev/docs)
-- 📦 [Setup](https://autobe.dev/docs/setup)
-- 🔍 Concepts
-  - [Waterfall Model](https://autobe.dev/docs/concepts/waterfall)
-  - [Compiler Strategy](https://autobe.dev/docs/concepts/compiler)
-  - [AI Function Calling](https://autobe.dev/docs/concepts/function-calling)
-
-### 📖 Features
-
-- 🤖 Agent Library
-  - [Facade Controller](https://autobe.dev/docs/agent/facade)
-  - [Configuration](https://autobe.dev/docs/agent/config)
-  - [Event Handling](https://autobe.dev/docs/agent/event)
-  - [Prompt Histories](https://autobe.dev/docs/agent/history)
-- 📡 WebSocket Protocol
-  - [Remote Procedure Call](https://autobe.dev/docs/websocket/rpc)
-  - [NestJS Server](https://autobe.dev/docs/websocket/nestjs)
-  - [NodeJS Server](https://autobe.dev/docs/websocket/nodejs)
-  - [Client Application](https://autobe.dev/docs/websocket/client)
-- 🛠️ Backend Stack
-  - [TypeScript](https://autobe.dev/docs/stack/typescript)
-  - [Prisma ORM](https://autobe.dev/docs/stack/prisma)
-  - [NestJS Framework](https://autobe.dev/docs/stack/nestjs)
-
-### 🔗 Appendix
-
-- 🌐 [No-Code Ecosystem](https://autobe.dev/docs/ecosystem)
-- 📅 Roadmap
-  - [Alpha Release (done)](https://autobe.dev/docs/roadmap/alpha)
-  - [Beta Release (done)](https://autobe.dev/docs/roadmap/beta)
-  - [Gamma Release (done)](https://autobe.dev/docs/roadmap/gamma)
-  - [Delta Release (active)](https://autobe.dev/docs/roadmap/delta)
-- 🔧 [API Documentation](https://autobe.dev/api)
-
-## How AutoBE Works
-
-```mermaid
-flowchart
-subgraph "Backend Coding Agent"
-  coder("Facade Controller")
-end
-subgraph "Functional Agents"
-  coder --"Requirements Analysis"--> analyze("Analyze")
-  coder --"ERD"--> database("Database")
-  coder --"API Design"--> interface("Interface")
-  coder --"Test Codes" --> test("Test")
-  coder --"Main Program" --> realize("Realize")
-end
-subgraph "Compiler Feedback"
-  database --"validates" --> prismaCompiler("<a href="https://github.com/wrtnlabs/autobe/blob/main/packages/interface/src/database/AutoBeDatabase.ts" target="_blank">Prisma Compiler</a>")
-  interface --"generates" --> openapiCompiler("<a href="https://github.com/wrtnlabs/autobe/blob/main/packages/interface/src/openapi/AutoBeOpenApi.ts" target="_blank">OpenAPI Compiler</a>")
-  test --"analyzes" --> testCompiler("<a href="https://github.com/wrtnlabs/autobe/blob/main/packages/interface/src/test/AutoBeTest.ts" target="_blank">Test Compiler</a>")
-  realize --"compiles" --> realizeCompiler("TypeScript Compiler")
-end
-```
-
-AutoBE follows a waterfall methodology to generate backend applications, with 40+ specialized agents handling each phase. The agents work in coordinated teams throughout the development process.
-
-Each waterfall stage includes AI-friendly compilers that guarantee type safety of the generated code. Rather than generating code directly, AutoBE's agents first construct language-neutral Abstract Syntax Trees using predefined schemas. Each AST node undergoes validation against type rules before any code generation occurs, catching structural errors at the conceptual level rather than during compilation.
-
-This approach is designed to ensure that the final generated TypeScript and Prisma code is 100% buildable. Based on our testing with multiple example projects including e-commerce platforms, discussion boards, and task management systems, AutoBE maintains this compilation guarantee across diverse application types.
-
-To illustrate this process, here are the phase outputs from our "Economic/Political Discussion Board" example:
-
-1. **Requirements Analysis**: [Report](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/bbs/docs/analysis)
-2. **Database Design**: [Entity Relationship Diagram](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/bbs/docs/ERD.md) / [Prisma Schema](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/bbs/prisma/schema)
-3. **API Specification**: [API Controllers](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/bbs/src/controllers) / [DTO Structures](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/bbs/src/api/structures)
-4. **E2E Test Functions**: [`test/features/api`](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/bbs/test/features/api)
-5. **API Implementations**: [`src/providers`](https://github.com/wrtnlabs/autobe-examples/tree/main/openai/gpt-4.1/bbs/src/providers)
-
-Also, you don't need to use all phases - stop at any stage that fits your needs. Whether you want just requirements analysis, database design, API specification, or e2e testing, AutoBE adapts to your workflow.
-
-Additionally, if you're skipping the full pipeline because of language preference rather than workflow needs, this capability is in development - AutoBE's language-neutral AST structure will soon support additional programming languages beyond TypeScript.
-
-## Type-Safe Client SDK
-
-Every AutoBE-generated backend automatically includes a type-safe client SDK, making frontend integration seamless and error-free. This SDK provides:
-
-- **Zero Configuration**: SDK is auto-generated alongside your backend - no manual setup required
-- **100% Type Safety**: Full TypeScript support with autocomplete and compile-time validation
-- **Framework Agnostic**: Works with React, Vue, Angular, or any TypeScript/JavaScript project
-- **E2E Test Integration**: Powers AI-generated test suites for comprehensive backend testing
-
-```typescript
-import api, { IPost } from "autobe-generated-sdk";
-
-// Type-safe API calls with full autocomplete
-const connection: api.IConnection = {
-  host: "http://localhost:1234",
-};
-await api.functional.users.login(connection, {
-  body: {
-    email: "user@example.com",
-    password: "secure-password",
-  },
-});
-
-// TypeScript catches errors at compile time
-const post: IPost = await api.functional.posts.create(connection, {
-  body: {
-    title: "Hello World",
-    content: "My first post",
-    // authorId: "123" <- TypeScript error if this field is missing!
-  },
-});
-```
-
-This SDK eliminates the traditional pain points of API integration - no more manual type definitions, no more runtime surprises, and no more API documentation lookups. Your frontend developers can focus on building features, not wrestling with API contracts.
-
-**Beyond Frontend Integration**: The SDK powers both frontend development and E2E test generation. AutoBE uses the same type-safe SDK internally to generate comprehensive test suites, ensuring every API endpoint is thoroughly tested. This creates a robust feedback loop that enhances backend stability - AI writes tests using the SDK, the SDK ensures type safety, and your backend becomes more reliable with every generated test.
-
-## Roadmap Schedule
-
-```mermaid
-gantt
-  dateFormat YYYY-MM-DD
-  title AutoBE Delta Roadmap Timeline (2026 Q1)
-
-  section Local LLM Benchmark
-  Qwen3 Database Phase             : done, 2026-01-01, 31d
-  Qwen3 Interface Phase            : done, 2026-01-16, 31d
-  Qwen3 Test Phase                 : done, 2026-02-01, 21d
-  Qwen3 Realize Phase              : done, 2026-02-01, 59d
-
-  section Validation Logic Enhancement
-  Dynamic Function Calling Schema  : done, 2026-01-01, 7d
-  Validation Feedback Stringify    : done, 2026-01-08, 12d
-  JSON Schema Validator            : done, 2026-01-08, 12d
-  Schema Review Validation Logic   : done, 2026-01-20, 35d
-  Test Mapping Plan Enhancement    : done, 2026-02-05, 24d
-  Realize Mapping Plan Enhancement : done, 2026-02-15, 45d
-
-  section RAG Optimization
-  Hybrid Search (Vector + BM25)    : done, 2026-01-01, 14d
-  Dynamic K Retrieval              : done, 2026-01-15, 14d
-  RAG Preliminary Prompting        : done, 2026-01-15, 28d
-  RAG Benchmark & Tuning           : done, 2026-02-01, 28d
-  Analyze Agent Restructuring      : done, 2026-02-01, 28d
-
-  section Design Integrity
-  DB Coverage Agent                : done, 2026-01-15, 28d
-  API Endpoint Coverage Agent      : done, 2026-01-22, 28d
-  Schema Relation Agent            : done, 2026-02-01, 28d
-  Schema Structure Agent           : done, 2026-02-01, 28d
-  Schema Content Agent             : done, 2026-03-01, 28d
-
-  section Multi-lingual Support
-  Java Compiler PoC                : done,   2026-01-01, 30d
-  Java Database                    : done,   2026-01-01, 14d
-  Java Interface                   : done,   2026-01-15, 21d
-  Java Test                        : active, 2026-02-05, 28d
-  Java Realize                     : active, 2026-03-01, 31d
-
-  section Human Modification Support
-  Database Schema Parser           : active,  2026-02-15, 28d
-  Interface Schema Parser          : active,  2026-02-22, 28d
-  Requirements Sync Agent          : planned, 2026-03-08, 24d
-
-  section Miscellaneous
-  System Prompt Simplification     : done,   2026-02-01, 28d
-  Estimation Agent                 : done,   2026-02-01, 28d
-  Playground Service Enhancement   : active, 2026-02-15, 28d
-  PR Articles Writing              : active, 2026-02-15, 30d
-```
-
-AutoBE has successfully completed Alpha, Beta, and Gamma development phases, establishing a solid foundation with **100% compilation success rate**. The current **Delta Release** focuses on transitioning from horizontal expansion to vertical deepening.
-
-**Strategic Shift**: In Gamma, we rapidly implemented features like RAG, Modularization, and Complementation under a "just ship it" philosophy. Delta fills the stability gaps that remained by systematically discovering and fixing hidden defects through Local LLM benchmarks.
-
-**Key Focus Areas**:
-
-- **Local LLM Benchmark**: Using open-source models like Qwen3 as a touchstone to discover hidden defects that commercial models mask, ensuring more robust operation across all model types
-- **Validation Logic Enhancement**: Strengthening schemas and validation logic through dynamic function calling schemas, JSON Schema validators, and progressive validation pipelines
-- **RAG Optimization**: Completing the Hybrid Search system (Vector + BM25) with dynamic K retrieval and comprehensive benchmark tuning
-- **Design Integrity**: Building mechanisms to verify and ensure design consistency between Database and Interface phases through coverage and schema review agents
-- **Multi-lingual Support**: Launching Java/Spring code generation alongside TypeScript/NestJS, with language-neutral AST structures enabling future language additions
-- **Human Modification Support**: Enabling maintenance continuity by parsing user-modified code back into AutoBE's internal AST representation, ensuring AutoBE remains useful beyond initial generation
-
-This roadmap prioritizes stability and depth over feature breadth, informed by real-world production experience from Gamma.
-
-## Current Limitations
-
-While AutoBE achieves 100% compilation success, please note these current limitations:
-
-**Runtime Behavior**: Generated applications compile successfully, but runtime behavior may require testing and refinement. Unexpected runtime errors can occur during server execution, such as database connection issues, API endpoint failures, or business logic exceptions that weren't caught during compilation. We strongly recommend thorough testing in development environments before deploying to production. Our v1.0 release targets 100% runtime success to address these issues.
-
-**Design Interpretation**: AutoBE's database and API designs may differ from your expectations. We recommend thoroughly reviewing generated specifications before proceeding with implementation, especially before production deployment.
-
-**Token Consumption**: AutoBE requires significant AI token usage for complex projects. Based on our testing, projects typically consume 30M-250M+ tokens depending on complexity (simple todo apps use ~4M tokens, while complex e-commerce platforms may require 250M+ tokens). We are working on RAG optimization to reduce this overhead in future releases.
-
-**Maintenance**: AutoBE focuses on initial generation and does not provide ongoing maintenance capabilities. Once your backend is generated, you'll need to handle bug fixes, feature additions, performance optimizations, and security updates manually. We recommend establishing a development workflow that combines the generated codebase with AI coding assistants like Claude Code for efficient ongoing development and maintenance tasks.
-
-![Entity Relationship Diagram Sample](https://autobe.dev/images/demonstrate/erd.png)
-
-## License
-
-AutoBE is licensed under the [GNU Affero General Public License v3.0 (AGPL-3.0)](LICENSE). If you modify AutoBE itself or offer it as a network service, you must make your source code available under the same license.
-
-However, backend applications generated by AutoBE can be relicensed under any license you choose, such as MIT. This means you can freely use AutoBE-generated code in commercial projects without open source obligations, similar to how other code generation tools work.