@autobe/agent 0.5.2 → 0.7.0

package/src/{analyze → orchestrate/analyze}/AutoBeAnalyzeReviewer.ts

@@ -1,8 +1,9 @@
 import { MicroAgentica } from "@agentica/core";
 import { ILlmSchema } from "@samchon/openapi";
+import { v4 } from "uuid";
 
-import { AutoBeSystemPromptConstant } from "../constants/AutoBeSystemPromptConstant";
-import { AutoBeContext } from "../context/AutoBeContext";
+import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
+import { AutoBeContext } from "../../context/AutoBeContext";
 
 export const AutoBeAnalyzeReviewer = <Model extends ILlmSchema.Model>(
   ctx: AutoBeContext<Model>,
@@ -13,10 +14,8 @@ export const AutoBeAnalyzeReviewer = <Model extends ILlmSchema.Model>(
     vendor: ctx.vendor,
     controllers: [],
     config: {
-      systemPrompt: {
-        describe: () => {
-          return "Answer only 'completion' or 'failure'.";
-        },
+      executor: {
+        describe: null,
       },
       locale: ctx.config?.locale,
     },
@@ -27,10 +26,14 @@ export const AutoBeAnalyzeReviewer = <Model extends ILlmSchema.Model>(
           (el) => el.type === "assistantMessage" || el.type === "userMessage",
         ),
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "systemMessage",
         text: AutoBeSystemPromptConstant.ANALYZE_REVIEWER,
       },
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "systemMessage",
         text: [
           "Below are all of the files.",

package/src/orchestrate/{orchestrateAnalyze.ts → analyze/orchestrateAnalyze.ts}

@@ -4,20 +4,17 @@ import {
   AutoBeAssistantMessageHistory,
 } from "@autobe/interface";
 import { ILlmApplication, ILlmSchema } from "@samchon/openapi";
-import { IPointer } from "tstl";
 import typia from "typia";
 import { v4 } from "uuid";
 
-import { AutoBeAnalyzeAgent } from "../analyze/AutoBeAnalyzeAgent";
-import { IFile } from "../analyze/AutoBeAnalyzeFileSystem";
-import { AutoBeAnalyzeReviewer } from "../analyze/AutoBeAnalyzeReviewer";
-import { AutoBeSystemPromptConstant } from "../constants/AutoBeSystemPromptConstant";
-import { AutoBeContext } from "../context/AutoBeContext";
-import { IAutoBeApplicationProps } from "../context/IAutoBeApplicationProps";
-import { assertSchemaModel } from "../context/assertSchemaModel";
-
-type Filename = string;
-type FileContent = string;
+import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
+import { AutoBeContext } from "../../context/AutoBeContext";
+import { IAutoBeApplicationProps } from "../../context/IAutoBeApplicationProps";
+import { assertSchemaModel } from "../../context/assertSchemaModel";
+import { AutoBeAnalyzeAgent } from "./AutoBeAnalyzeAgent";
+import { IFile } from "./AutoBeAnalyzeFileSystem";
+import { AutoBeAnalyzePointer } from "./AutoBeAnalyzePointer";
+import { AutoBeAnalyzeReviewer } from "./AutoBeAnalyzeReviewer";
 
 /** @todo Kakasoo */
 export const orchestrateAnalyze =
@@ -52,6 +49,9 @@ export const orchestrateAnalyze =
       controllers: [controller],
       config: {
         locale: ctx.config?.locale,
+        executor: {
+          describe: null,
+        },
         systemPrompt: {
           common: () => AutoBeSystemPromptConstant.ANALYZE_PLANNER,
         },
@@ -98,50 +98,70 @@ export const orchestrateAnalyze =
     }
 
     const described = determined.find((el) => el.type === "describe");
-    const filenames = Array.from(
-      new Set(
-        described
-          ? described.executes
-              .flatMap((el) => {
-                if (el.protocol === "class") {
-                  return (
-                    el.arguments as { files: Array<Pick<IFile, "filename">> }
-                  ).files;
-                }
-                return null;
-              })
-              .filter((el) => el !== null)
-          : [],
-      ),
-    );
+    // const determinedOutput = Array.from(
+    //   new Set(
+    //     described
+    //       ? described.executes
+    //           .map((el) => {
+    //             if (el.protocol === "class") {
+    //               return el.arguments as unknown as IDeterminingInput;
+    //             }
+    //             return null;
+    //           })
+    //           .filter((el) => el !== null)
+    //       : [],
+    //   ),
+    // );
+
+    const determinedOutput = described?.executes.find(
+      (el) => el.protocol === "class" && typia.is<IDeterminingInput>(el.value),
+    )?.value as IDeterminingInput;
+
+    const prefix = determinedOutput.prefix;
+    const describedFiles = determinedOutput.files;
+    if (describedFiles.length === 0) {
+      const history: AutoBeAssistantMessageHistory = {
+        id: v4(),
+        type: "assistantMessage",
+        text: "The current requirements are insufficient, so file generation will be suspended. It would be better to continue the conversation.",
+        created_at,
+        completed_at: new Date().toISOString(),
+      };
+      ctx.dispatch({
+        type: "assistantMessage",
+        text: "The current requirements are insufficient, so file generation will be suspended. It would be better to continue the conversation.",
+        created_at,
+      });
+      return history;
+    }
 
     const pointers = await Promise.all(
-      filenames.map(async ({ filename }) => {
-        const pointer: IPointer<{
-          files: Record<Filename, FileContent>;
-        } | null> = {
-          value: null,
-        };
+      describedFiles.map(async ({ filename, reason }) => {
+        const pointer: AutoBeAnalyzePointer = { value: null };
 
         const agent = new AutoBeAnalyzeAgent(
           AutoBeAnalyzeReviewer,
           ctx,
           pointer,
-          filenames.map((el) => el.filename),
+          describedFiles.map((el) => el.filename),
         );
 
         await agent.conversate(
           [
-            `The names of all the files are as follows: ${filenames.join(",")}`,
+            `# Instruction`,
+            `The names of all the files are as follows: ${describedFiles.join(",")}`,
             "Assume that all files are in the same folder. Also, when pointing to the location of a file, go to the relative path.",
             "",
             `Among the various documents, the part you decided to take care of is as follows.: ${filename}`,
             `Only write this document named '${filename}'.`,
             "Never write other documents.",
             "",
+            "# User Planning Requirements",
             "```md",
             JSON.stringify(userPlanningRequirements),
             "```",
+            "The reason why this document needs to be written is as follows.",
+            `- reason: ${reason}`,
           ].join("\n"),
         );
 
@@ -160,6 +180,7 @@ export const orchestrateAnalyze =
         id: v4(),
         type: "analyze",
         reason: userPlanningRequirements,
+        prefix,
         files: files,
         step,
         created_at,
@@ -169,6 +190,7 @@ export const orchestrateAnalyze =
       ctx.histories().push(history);
       ctx.dispatch({
         type: "analyzeComplete",
+        prefix,
         files: files,
         step,
         created_at,
@@ -191,18 +213,48 @@ export const orchestrateAnalyze =
     return history;
   };
 
+export interface IDeterminingInput {
+  /**
+   * Prefix for file names and all prisma schema files, table, interface, and
+   * variable names. For example, if you were to create a bulletin board
+   * service, the prefix would be bbs. At this time, the name of the document
+   * would be, for example, 00_bbs_table_of_contents, and bbs would have to be
+   * attached to the name of all documents. This value would then be passed to
+   * other agents as well, in the form of bbs_article, bbs_article_snapshot, and
+   * bbs_comments in the table name. Interfaces will likewise be used in
+   * interfaces and tests because they originate from the name of prisma scheme.
+   * Do not use prefixes that are related to the technology stack (e.g., ts_,
+   * api_, react_) or unnatural prefixes that typically wouldn’t appear in table
+   * names or domain models (e.g., zz_, my_, dev_).
+   *
+   * @title Prefix
+   */
+  prefix: string;
+
+  /**
+   * File name must be English. and it must contains the numbering and prefix.
+   *
+   * @title file names and reason to create.
+   */
+  files: Array<Pick<IFile, "filename" | "reason">>;
+}
+
 class DeterminingFiles {
   /**
-   * Determining the Initial File List
+   * Determining the Initial File List.
    *
    * Design a list of initial documents that you need to create for that
    * requirement. The list of documents is determined only by the name of the
-   * file.
+   * file. If you determine from the conversation that the user's requirements
+   * have not been fully gathered, you must stop the analysis and continue
+   * collecting the remaining requirements. In this case, you do not need to
+   * generate any files. Simply pass an empty array to `input.files`, which is
+   * the input value for the `determine` tool.
    *
-   * @param input
+   * @param input Prefix and files
    * @returns
    */
-  determine(input: { files: Array<Pick<IFile, "filename">> }) {
+  determine(input: IDeterminingInput): IDeterminingInput {
     return input;
   }
 }

package/src/orchestrate/index.ts

@@ -1,5 +1,5 @@
-export { orchestrateAnalyze as analyze } from "./orchestrateAnalyze";
+export { orchestrateAnalyze as analyze } from "./analyze/orchestrateAnalyze";
 export { orchestrateInterface as interface } from "./interface/orchestrateInterface";
-export { orchestratePrisma as prisma } from "./prisma/orchestratePrisma";
-export { orchestrateTest as test } from "./orchestrateTest";
 export { orchestrateRealize as realize } from "./orchestrateRealize";
+export { orchestrateTest as test } from "./test/orchestrateTest";
+export { orchestratePrisma as prisma } from "./prisma/orchestratePrisma";

package/src/orchestrate/interface/orchestrateInterfaceComplement.ts

@@ -8,6 +8,7 @@ import {
 import { OpenApiV3_1Emender } from "@samchon/openapi/lib/converters/OpenApiV3_1Emender";
 import { IPointer } from "tstl";
 import typia from "typia";
+import { v4 } from "uuid";
 
 import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
 import { AutoBeContext } from "../../context/AutoBeContext";
@@ -51,6 +52,8 @@ async function step<Model extends ILlmSchema.Model>(
         AutoBeSystemPromptConstant.INTERFACE_COMPLEMENT,
       ),
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "assistantMessage",
         text: [
           "Here is the OpenAPI document what you've made:",
@@ -61,6 +64,8 @@ async function step<Model extends ILlmSchema.Model>(
         ].join("\n"),
       },
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "assistantMessage",
         text: [
           "You have missed below schema types in the document.components.schemas:",
@@ -85,7 +90,9 @@ async function step<Model extends ILlmSchema.Model>(
     ],
   });
   agentica.on("request", async (event) => {
-    event.body.tool_choice = "required";
+    if (event.body.tools) {
+      event.body.tool_choice = "required";
+    }
   });
 
   await agentica.conversate("Fill missing schema types please");

package/src/orchestrate/interface/orchestrateInterfaceComponents.ts

@@ -4,6 +4,7 @@ import { ILlmApplication, ILlmSchema } from "@samchon/openapi";
 import { OpenApiV3_1Emender } from "@samchon/openapi/lib/converters/OpenApiV3_1Emender";
 import { IPointer } from "tstl";
 import typia from "typia";
+import { v4 } from "uuid";
 
 import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
 import { AutoBeContext } from "../../context/AutoBeContext";
@@ -113,6 +114,8 @@ async function process<Model extends ILlmSchema.Model>(
         AutoBeSystemPromptConstant.INTERFACE_SCHEMA,
       ),
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "assistantMessage",
         text: [
           "Here is the OpenAPI operations generated by phase 2.",
@@ -135,7 +138,9 @@ async function process<Model extends ILlmSchema.Model>(
     ],
   });
   agentica.on("request", async (event) => {
-    event.body.tool_choice = "required";
+    if (event.body.tools) {
+      event.body.tool_choice = "required";
+    }
   });
 
   const already: string[] = Object.keys(oldbie.schemas);

package/src/orchestrate/interface/orchestrateInterfaceOperations.ts

@@ -112,7 +112,9 @@ async function process<Model extends ILlmSchema.Model>(
     ],
   });
   agentica.on("request", async (event) => {
-    event.body.tool_choice = "required";
+    if (event.body.tools) {
+      event.body.tool_choice = "required";
+    }
   });
   await agentica.conversate(
     [

package/src/orchestrate/interface/transformInterfaceHistories.ts

@@ -1,4 +1,5 @@
 import { IAgenticaHistoryJson } from "@agentica/core";
+import { v4 } from "uuid";
 
 import { AutoBeState } from "../../context/AutoBeState";
 
@@ -11,6 +12,8 @@ export const transformInterfaceHistories = (
   if (state.analyze === null)
     return [
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "systemMessage",
         text: [
           "Requirement analysis is not yet completed.",
@@ -22,6 +25,8 @@ export const transformInterfaceHistories = (
   else if (state.prisma === null)
     return [
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "systemMessage",
         text: [
           "Prisma DB schema generation is not yet completed.",
@@ -33,6 +38,8 @@ export const transformInterfaceHistories = (
   else if (state.analyze.step !== state.prisma.step)
     return [
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "systemMessage",
         text: [
           "Prisma DB schema generation has not been updated",
@@ -45,6 +52,8 @@ export const transformInterfaceHistories = (
   else if (state.prisma.compiled.type !== "success")
     return [
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "systemMessage",
         text: [
           "Prisma DB schema generation has not been updated",
@@ -56,10 +65,14 @@ export const transformInterfaceHistories = (
     ];
   return [
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "systemMessage",
       text: systemMessage,
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "assistantMessage",
       text: [
         "Requirement analysis and Prisma DB schema generation are ready.",
@@ -72,6 +85,31 @@ export const transformInterfaceHistories = (
         "",
         state.analyze.reason,
         "",
+        "## Prefix",
+        "",
+        `* Prefix provided by the user: ${state.analyze?.prefix ?? null}`,
+        `* When defining TypeScript interfaces, the interface name must be in PascalCase. The property names, however, do not need to follow this convention.`,
+        "",
+        "The user wants all TypeScript identifiers (such as interfaces, types, and functions) to start with the prefix provided below.  ",
+        "If the prefix is `null`, it should be ignored.  ",
+        "If a prefix is provided, all identifier names **must begin with it**.",
+        "",
+        "However, if there is a special-purpose prefix like `mv` (e.g., for materialized view handlers or performance-related utilities), it **must precede** the given prefix.",
+        "",
+        "## Prefix Example",
+        "",
+        "If the prefix is `shopping`, then names should be like:",
+        "",
+        "* `shoppingSales`",
+        "* `shoppingSaleOptions`",
+        "* `shoppingCreateSale()`",
+        "",
+        "In cases where an identifier is created for performance-optimized logic or special processing (e.g., materialized view handling), the `mv` prefix must come first.  ",
+        "For example:",
+        "",
+        "* `mvShoppingDailyStats`",
+        "* `mvShoppingAggregateView`",
+        "",
         // Requirement Analysis Report
         `## Requirement Analysis Report`,
         "",
@@ -81,6 +119,8 @@ export const transformInterfaceHistories = (
       ].join("\n"),
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "assistantMessage",
       text: [
         "Database schema and entity relationship diagrams are ready.",

package/src/orchestrate/prisma/orchestratePrismaComponent.ts

@@ -25,13 +25,16 @@ export async function orchestratePrismaComponents<
   const pointer: IPointer<IExtractComponentsProps | null> = {
     value: null,
   };
+
+  const prefix = ctx.state().analyze?.prefix ?? null;
+
   const agentica: MicroAgentica<Model> = new MicroAgentica({
     model: ctx.model,
     vendor: ctx.vendor,
     config: {
       ...(ctx.config ?? {}),
     },
-    histories: transformPrismaComponentsHistories(ctx.state()),
+    histories: transformPrismaComponentsHistories(ctx.state(), prefix),
     tokenUsage: ctx.usage(),
     controllers: [
       createApplication({

package/src/orchestrate/prisma/transformPrismaComponentsHistories.ts

@@ -1,16 +1,20 @@
 import { IAgenticaHistoryJson } from "@agentica/core";
+import { v4 } from "uuid";
 
 import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
 import { AutoBeState } from "../../context/AutoBeState";
 
 export const transformPrismaComponentsHistories = (
   state: AutoBeState,
+  prefix: string | null = null,
 ): Array<
   IAgenticaHistoryJson.IAssistantMessage | IAgenticaHistoryJson.ISystemMessage
 > => {
   if (state.analyze === null)
     return [
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "systemMessage",
         text: [
           "Requirement analysis is not yet completed.",
@@ -21,10 +25,14 @@ export const transformPrismaComponentsHistories = (
     ];
   return [
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "systemMessage",
       text: AutoBeSystemPromptConstant.PRISMA_COMPONENT,
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "assistantMessage",
       text: [
         "Here is the requirement analysis report.",
@@ -40,6 +48,26 @@ export const transformPrismaComponentsHistories = (
         "```json",
         JSON.stringify(state.analyze.files),
         "```",
+        "## Prefix",
+        "",
+        `* Prefix provided by the user: ${prefix}`,
+        "",
+        "The user wants all database schema (table) names to start with the prefix provided below.",
+        "If the prefix is `null`, it should be ignored.",
+        "If a prefix is provided, all table names **must begin with it**.",
+        "However, if there is a special-purpose prefix like `mv` (for materialized views), it **must precede** the given prefix.",
+        "",
+        "## Prefix Example",
+        "",
+        "If the prefix is `shopping`, then table names should be like:",
+        "",
+        "* `shopping_sales`",
+        "* `shopping_sale_options`",
+        "",
+        "In cases where a table is created for performance optimization purposes (e.g., materialized views), the `mv_` prefix must come first.",
+        "For example:",
+        "",
+        "* `mv_shopping_daily_stats`",
       ].join("\n"),
     },
   ];

package/src/orchestrate/prisma/transformPrismaCorrectHistories.ts

@@ -1,5 +1,6 @@
 import { IAgenticaHistoryJson } from "@agentica/core";
 import { IAutoBePrismaValidation } from "@autobe/interface";
+import { v4 } from "uuid";
 
 import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
 
@@ -10,10 +11,14 @@ export const transformPrismaCorrectHistories = (
 > => {
   return [
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "systemMessage",
       text: AutoBeSystemPromptConstant.PRISMA_CORRECT,
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "assistantMessage",
       text: [
         "Here is the Prisma application data what you made:",
@@ -24,6 +29,8 @@ export const transformPrismaCorrectHistories = (
       ].join("\n"),
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "assistantMessage",
       text: [
         "Below are the list of errors what you have to fix:",
@@ -34,6 +41,8 @@ export const transformPrismaCorrectHistories = (
       ].join("\n"),
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "systemMessage",
       text: [
         "Before fixing the schema files,",

package/src/orchestrate/prisma/transformPrismaHistories.ts

@@ -1,4 +1,5 @@
 import { IAgenticaHistoryJson } from "@agentica/core";
+import { v4 } from "uuid";
 
 import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
 import { AutoBeState } from "../../context/AutoBeState";
@@ -11,6 +12,8 @@ export const transformPrismaHistories = (
   if (state.analyze === null)
     return [
       {
+        id: v4(),
+        created_at: new Date().toISOString(),
         type: "systemMessage",
         text: [
           "Requirement analysis is not yet completed.",
@@ -21,14 +24,20 @@ export const transformPrismaHistories = (
     ];
   return [
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "systemMessage",
       text: AutoBeSystemPromptConstant.PRISMA,
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "assistantMessage",
       text: AutoBeSystemPromptConstant.PRISMA_EXAMPLE,
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "assistantMessage",
       text: [
         "Here is the requirement analysis report.",

package/src/orchestrate/prisma/transformPrismaSchemaHistories.ts

@@ -1,5 +1,6 @@
 import { IAgenticaHistoryJson } from "@agentica/core";
 import { AutoBeAnalyzeHistory } from "@autobe/interface";
+import { v4 } from "uuid";
 
 import { AutoBeSystemPromptConstant } from "../../constants/AutoBeSystemPromptConstant";
 
@@ -15,10 +16,14 @@ export const transformPrismaSchemaHistories = (
 > => {
   return [
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "systemMessage",
       text: AutoBeSystemPromptConstant.PRISMA_SCHEMA,
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "systemMessage",
       text: [
         "Before making prisma schema files,",
@@ -29,6 +34,8 @@ export const transformPrismaSchemaHistories = (
       ].join("\n"),
     },
     {
+      id: v4(),
+      created_at: new Date().toISOString(),
       type: "assistantMessage",
       text: [
         "Here is the requirement analysis report.",