@autobe/agent 0.0.0 → 0.3.6

package/lib/constants/AutoBeSystemPromptConstant.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+;
+//# sourceMappingURL=AutoBeSystemPromptConstant.js.map

package/lib/constants/AutoBeSystemPromptConstant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AutoBeSystemPromptConstant.js","sourceRoot":"","sources":["../../src/constants/AutoBeSystemPromptConstant.ts"],"names":[],"mappings":";;AAcC,CAAC"}

package/lib/context/AutoBeContext.d.ts

@@ -1,13 +1,17 @@
-import { AutoBeHistory, IAutoBeCompiler } from "@autobe/interface";
+import { AutoBeEvent, AutoBeHistory, IAutoBeCompiler } from "@autobe/interface";
 import { ILlmSchema } from "@samchon/openapi";
+import { IAutoBeConfig } from "../structures/IAutoBeConfig";
 import { IAutoBeVendor } from "../structures/IAutoBeVendor";
 import { AutoBeState } from "./AutoBeState";
 import { AutoBeTokenUsage } from "./AutoBeTokenUsage";
 export interface AutoBeContext<Model extends ILlmSchema.Model> {
     model: Model;
     vendor: IAutoBeVendor;
+    config: IAutoBeConfig | undefined;
     compiler: IAutoBeCompiler;
-    histories: AutoBeHistory[];
-    usage: () => AutoBeTokenUsage;
+    files: () => Record<string, string>;
+    histories: () => AutoBeHistory[];
     state: () => AutoBeState;
+    usage: () => AutoBeTokenUsage;
+    dispatch: (event: AutoBeEvent) => void;
 }

package/lib/context/IAutoBeApplication.d.ts

@@ -9,59 +9,99 @@ export interface IAutoBeApplication {
     /**
      * Run Analyze Agent.
      *
-     * Analyze agent analyzes requirements and creates specification
-     * documents.
+     * Executes the Analyze agent to process user requirements and generate a
+     * structured specification document. This agent analyzes all conversation
+     * history between users and AI, separates business logic from technical
+     * requirements, and establishes development priorities and scope.
      *
-     * The Analyze agent serves as the foundation of the entire development
-     * process. It not only captures initial requirements but also
-     * continuously refines understanding through iterative conversation
-     * with users. When requirements are ambiguous or incomplete, it
-     * proactively formulates targeted questions to elicit necessary
-     * information before proceeding with development.
+     * **IMPORTANT**: Only call this function when sufficient requirements have
+     * been discussed to generate a comprehensive specification. The context must
+     * contain enough detail about the system's purpose, core features, data
+     * models, and business rules. If requirements are unclear or incomplete,
+     * continue gathering information through conversation instead.
      *
-     * Additionally, once other agents have generated code, the Analyze
-     * agent can interpret change requests in the context of existing
-     * implementations, assessing the impact and feasibility of modifications
-     * while maintaining system integrity. This comprehensive approach
-     * ensures that all subsequent development stages work from a clear,
-     * complete, and consistent specification.
+     * The agent will automatically generate follow-up questions for any ambiguous
+     * requirements and continuously refine its understanding through iterative
+     * conversation. When executed after other agents have generated code, it can
+     * also interpret change requests in the context of existing implementations.
      */
     analyze(props: IAutoBeApplicationProps): Promise<IAutoBeApplicationResult>;
     /**
      * Run prisma agent.
      *
-     * Prisma agent analyzes requirements specifications to generate
-     * database schemas in Prisma format.
+     * Executes the Prisma agent to generate database schema files and ERD
+     * documentation. This agent reads the requirements specification created by
+     * the {@link analyze Analyze agent} and produces a complete Prisma schema with
+     * comprehensive documentation for each entity and attribute.
      *
-     * The Prisma agent references the requirements specification document
-     * created by the {@link analyze} function to craft the `prisma.schema`
-     * file. For each entity and attribute in the database schema, it
-     * provides comprehensive documentation including the rationale behind
-     * its creation, its purpose, and conceptual explanations. The agent
-     * employs normalization techniques to ensure high-quality database
-     * design.
+     * **PREREQUISITE**: Only call this function after the {@link analyze} function
+     * has been successfully executed and a requirements specification document
+     * has been generated. The Prisma agent depends on the structured requirements
+     * analysis to design the database schema properly. Without a completed
+     * requirements specification, this function should NOT be called.
      *
-     * Once the DB schema file is written, the Prisma agent compiles it using
-     * the built-in Prisma compiler. If compilation errors occur, these are
-     * fed back to the AI agent, enabling a self-correction process through
-     * compiler feedback. After successful compilation, this schema file is
-     * then subjected to a quality assurance process through an internal
-     * review agent that verifies and refines the schema.
-     *
-     * Note that, never use this function without calling the
-     * {@link analyze} function at least once.
+     * The agent will automatically validate the generated schema using the Prisma
+     * compiler, self-correct any compilation errors through feedback loops, and
+     * generate ERD documentation using prisma-markdown. An internal review
+     * process ensures schema quality and optimization.
      */
     prisma(props: IAutoBeApplicationProps): Promise<IAutoBeApplicationResult>;
     /**
      * Run interface agent.
+     *
+     * Executes the Interface agent to design and generate API interfaces. This
+     * agent creates OpenAPI schemas and TypeScript/NestJS code based on the
+     * requirements specification and ERD documentation from previous agents.
+     *
+     * The agent follows a sophisticated pipeline: first constructing formal
+     * OpenAPI Operation Schemas and JSON Schemas, then validating these schemas,
+     * and finally transforming them into NestJS controllers and DTOs. Each
+     * generated interface includes comprehensive JSDoc comments and undergoes
+     * internal review for consistency.
      */
     interface(props: IAutoBeApplicationProps): Promise<IAutoBeApplicationResult>;
     /**
      * Run test program agent.
+     *
+     * Executes the Test agent to generate comprehensive E2E test suites for all
+     * {@link interface API interfaces}. This agent synthesizes outputs from
+     * previous agents to create tests that validate both individual endpoints and
+     * their interactions.
+     *
+     * **PREREQUISITE**: Only call this function after the {@link interface}
+     * function has been successfully executed and API interfaces have been
+     * generated. The Test agent requires the completed API interface definitions,
+     * OpenAPI schemas, and TypeScript code to generate appropriate test
+     * scenarios. Without completed interface design, this function should NOT be
+     * called.
+     *
+     * The agent will analyze dependency relationships between API functions,
+     * structure integrated test scenarios with correct execution sequences, and
+     * enhance pre-generated test scaffolds with business logic validation.
+     * TypeScript compiler validation and internal review ensure test quality and
+     * optimal coverage.
      */
     test(props: IAutoBeApplicationProps): Promise<IAutoBeApplicationResult>;
     /**
      * Run realize agent.
+     *
+     * Executes the Realize agent to implement the actual business logic for each
+     * API endpoint. This agent synthesizes all outputs from previous agents to
+     * generate fully functional service provider code.
+     *
+     * **PREREQUISITE**: Only call this function after the {@link interface}
+     * function has been successfully executed and API interfaces have been
+     * generated. The Realize agent requires the completed API interface
+     * definitions to implement the corresponding service logic. It also benefits
+     * from having test code available for validation. Without completed interface
+     * design, this function should NOT be called.
+     *
+     * The agent will create service implementations with multiple validation
+     * layers: TypeScript compiler feedback, runtime validation through test
+     * execution, and quality optimization through internal review. The generated
+     * code handles database interactions through Prisma, implements security and
+     * validation checks, and processes business rules according to
+     * specifications.
      */
     realize(props: IAutoBeApplicationProps): Promise<IAutoBeApplicationResult>;
 }

package/lib/context/IAutoBeApplicationProps.d.ts

@@ -1,6 +1,26 @@
 export interface IAutoBeApplicationProps {
+    /** The reason of the function call. */
+    reason: string;
     /**
-     * The reason of the function call.
+     * This prompt defines how to convert a user's planning-oriented requirements into a structured message for an internal agent.
+     *
+     * All content the user provides must be included in the message. However, if some parts of the user's input are inappropriate or insufficient from a planning standpoint, you are allowed to add **supplementary remarks**—but only under strict rules.
+     *
+     * <Supplementary Remark Rules>
+     *
+     * 1. **Definition**
+     * A supplementary remark is additional information that may differ from the user's original intent. Because of this, **you must clearly indicate that it is *not* part of the user’s thinking**.
+     *
+     * 2. **When to Supplement**
+     * - If the user's input reveals a lack of technical understanding (e.g., suggesting "put all data into one table"), and the plan is not an MVP or PoC, it's encouraged to make reasonable additions for a more scalable or robust structure.
+     * - If there are clear gaps in the user's planning logic, you may supplement the content to ensure completeness.
+     *
+     * 3. **When Not to Supplement**
+     * - If the user's input is vague or ambiguous, **do not assume or add extra details**. Instead, it’s better to ask the user follow-up questions to clarify their intent.
+     * - If the user has made no comment on design, **do not impose design-related decisions** (e.g., colors, fonts, tone). However, you may state explicitly that no design requirements were provided.
+     * - Generic advice like "UX should be good" can be omitted unless it adds value, as such goals are assumed in all services.
+     *
+     * </Supplementary Remark Rules>
      */
-    reason: string;
+    userPlanningRequirements?: string;
 }

package/lib/context/IAutoBeApplicationResult.d.ts

@@ -1,4 +1,3 @@
 export interface IAutoBeApplicationResult {
     success: boolean;
-    description: string;
 }

package/lib/context/assertSchemaModel.d.ts

@@ -0,0 +1,2 @@
+import { ILlmSchema } from "@samchon/openapi";
+export declare function assertSchemaModel<Model extends ILlmSchema.Model>(model: Model): asserts model is Exclude<Model, "gemini" | "3.0">;

package/lib/context/assertSchemaModel.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertSchemaModel = assertSchemaModel;
+function assertSchemaModel(model) {
+    if (model === "gemini")
+        throw new Error([
+            "Error on AutoBeAgent.constructor(): gemini is not supported",
+            "because it does not follow standard JSON schema specification.",
+            "@autobe requires union type (`oneOf` or `anyOf`) for backend code generation,",
+            "but gemini has banned them. Please wait until when `@agentica`",
+            "supports prompt based function calling which can detour gemini's",
+            "restriction of JSON schema specification.",
+        ].join(" "));
+}
+//# sourceMappingURL=assertSchemaModel.js.map

package/lib/context/assertSchemaModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertSchemaModel.js","sourceRoot":"","sources":["../../src/context/assertSchemaModel.ts"],"names":[],"mappings":";;AAEA,8CAcC;AAdD,SAAgB,iBAAiB,CAC/B,KAAY;IAEZ,IAAI,KAAK,KAAK,QAAQ;QACpB,MAAM,IAAI,KAAK,CACb;YACE,6DAA6D;YAC7D,gEAAgE;YAChE,+EAA+E;YAC/E,gEAAgE;YAChE,kEAAkE;YAClE,2CAA2C;SAC5C,CAAC,IAAI,CAAC,GAAG,CAAC,CACZ,CAAC;AACN,CAAC"}

package/lib/{internal/transformAgenticaHistory.d.ts → factory/createAgenticaHistory.d.ts}

@@ -1,7 +1,7 @@
 import { AgenticaOperation, MicroAgenticaHistory } from "@agentica/core";
 import { AutoBeHistory } from "@autobe/interface";
 import { ILlmSchema } from "@samchon/openapi";
-export declare function transformAgenticaHistory<Model extends ILlmSchema.Model>(props: {
+export declare function createAgenticaHistory<Model extends ILlmSchema.Model>(props: {
     operations: readonly AgenticaOperation<Model>[];
     history: AutoBeHistory;
 }): MicroAgenticaHistory<Model> | null;

package/lib/{internal/transformAgenticaHistory.js → factory/createAgenticaHistory.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformAgenticaHistory = transformAgenticaHistory;
-function transformAgenticaHistory(props) {
+exports.createAgenticaHistory = createAgenticaHistory;
+function createAgenticaHistory(props) {
     if (props.history.type === "userMessage")
         return Object.assign(Object.assign({}, props.history), { toJSON: () => props.history });
     else if (props.history.type === "assistantMessage")
@@ -19,9 +19,8 @@ function transformAgenticaHistory(props) {
             success: props.history.type === "analyze" || props.history.type === "interface"
                 ? true
                 : props.history.result.type === "success",
-            description: props.history.description,
         },
     };
     return Object.assign(Object.assign({}, partial), { protocol: operation.protocol, operation: operation, toJSON: () => (Object.assign(Object.assign({}, partial), { protocol: operation.protocol, operation: operation.toJSON() })) });
 }
-//# sourceMappingURL=transformAgenticaHistory.js.map
+//# sourceMappingURL=createAgenticaHistory.js.map

package/lib/factory/createAgenticaHistory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createAgenticaHistory.js","sourceRoot":"","sources":["../../src/factory/createAgenticaHistory.ts"],"names":[],"mappings":";;AAQA,sDA0CC;AA1CD,SAAgB,qBAAqB,CAAiC,KAGrE;IACC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,aAAa;QACtC,uCACK,KAAK,CAAC,OAAO,KAChB,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,OAAmC,IACvD;SACC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,kBAAkB;QAChD,uCACK,KAAK,CAAC,OAAO,KAChB,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,OAAwC,IAC5D;IAEJ,MAAM,SAAS,GAAyC,KAAK,CAAC,UAAU,CAAC,IAAI,CAC3E,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,CAAC,IAAI,CAChD,CAAC;IACF,IAAI,SAAS,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACzC,MAAM,OAAO,GAAG;QACd,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE;QACpB,IAAI,EAAE,SAAkB;QACxB,SAAS,EAAE;YACT,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM;SAC7B;QACD,KAAK,EAAE;YACL,OAAO,EACL,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,WAAW;gBACpE,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,SAAS;SAC9C;KACF,CAAC;IACF,uCACK,OAAO,KACV,QAAQ,EAAE,SAAS,CAAC,QAAmB,EACvC,SAAS,EAAE,SAA2C,EACtD,MAAM,EAAE,GAAG,EAAE,CAAC,iCACT,OAAO,KACV,QAAQ,EAAE,SAAS,CAAC,QAAmB,EACvC,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,IAC7B,IACF;AACJ,CAAC"}