@autobe/agent 0.18.0 → 0.20.0

package/src/orchestrate/interface/structures/IAutoBeInterfaceSchemaApplication.ts

@@ -14,10 +14,9 @@ export interface IAutoBeInterfaceSchemaApplication {
    * creation. This ensures that the final OpenAPI document has complete type
    * coverage for all operations.
    *
-   * CRITICAL: All schema definitions must follow the established naming
-   * conventions (IEntityName, IEntityName.ICreate, etc.) and must be thoroughly
-   * documented with descriptions that reference the original Prisma schema
-   * comments.
+   * DO: Follow established naming conventions (IEntityName,
+   * IEntityName.ICreate, etc.) DO: Document thoroughly with descriptions that
+   * reference the original Prisma schema comments.
    *
    * @param props Properties containing components to generate.
    */
@@ -25,6 +24,40 @@ export interface IAutoBeInterfaceSchemaApplication {
 }
 export namespace IAutoBeInterfaceSchemaApplication {
   export interface IProps {
+    /**
+     * TypeScript draft code for schema definitions.
+     *
+     * This property contains TypeScript interface definitions that serve as a
+     * preliminary draft before generating the final JSON schema components.
+     * The draft allows for initial design and validation of the schema structure
+     * using TypeScript's type system before converting to OpenAPI/JSON Schema format.
+     *
+     * The draft typically includes:
+     * - Entity interfaces matching the Prisma models
+     * - Operation-specific variants (ICreate, IUpdate, etc.)
+     * - Utility types and enumerations
+     * - Type relationships and constraints
+     *
+     * This TypeScript draft serves as the foundation for the subsequent schema
+     * generation, ensuring type safety and consistency. The final schemas in the
+     * `schemas` property should be derived from and validated against this draft.
+     *
+     * Example draft structure:
+     * ```typescript
+     * interface IUser {
+     *   id: string;
+     *   email: string;
+     *   profile: IUserProfile;
+     * }
+     * 
+     * namespace IUser {
+     *   interface ICreate extends Omit<IUser, "id"> {}
+     *   interface IUpdate extends Partial<ICreate> {}
+     * }
+     * ```
+     */
+    draft: string;
+
     /**
      * Complete set of schema components for the OpenAPI specification.
      *
@@ -32,23 +65,23 @@ export namespace IAutoBeInterfaceSchemaApplication {
      * the system. It is the central repository of all named schema types that
      * will be used throughout the API specification.
      *
-     * CRITICAL REQUIREMENT: All object types MUST be defined as named types in
-     * the components.schemas section. Inline anonymous object definitions are
-     * strictly prohibited.
+     * DO: Define all object types as named types in the components.schemas
+     * section. DO NOT: Use inline anonymous object definitions.
      *
-     * This components object should include:
+     * This components object includes:
      *
      * - Main entity types (IEntityName)
      * - Operation-specific variants (.ICreate, .IUpdate, .ISummary, etc.)
      * - Container types (IPage<T> for pagination)
      * - Enumeration types
      *
-     * All schema definitions must include detailed descriptions that reference
-     * the original Prisma schema comments and thoroughly document each
-     * property. Every property that references an object must use a $ref to a
-     * named type in the components.schemas section. This applies to all objects
-     * in request bodies, response bodies, and properties that are objects or
-     * arrays of objects.
+     * DO: Include detailed descriptions that reference the original Prisma
+     * schema comments and thoroughly document each property. DO: Use a $ref to
+     * a named type in the components.schemas section for every property that
+     * references an object.
+     *
+     * This applies to all objects in request bodies, response bodies, and
+     * properties that are objects or arrays of objects.
      *
      * Example structure:
      *

package/src/orchestrate/interface/structures/IAutobeInterfaceSchemasReviewApplication.ts

@@ -32,19 +32,16 @@ export namespace IAutoBeInterfaceSchemasReviewApplication {
     /**
      * Issues and problems found during schema analysis.
      *
-     * IMPORTANT: Only document problems that need fixing. Do NOT include:
-     *
-     * - Positive feedback about what's already correct
-     * - Compliments about well-structured schemas
-     * - Confirmation that certain aspects meet standards
+     * DO: Document only problems that need fixing.
+     * DO NOT: Include positive feedback, compliments, or confirmations
      *
      * Focus exclusively on issues organized by severity:
      *
-     * - CRITICAL: Security vulnerabilities (exposed passwords, missing auth
-     *   boundaries)
-     * - HIGH: Missing required variants, incorrect type mappings
-     * - MEDIUM: Missing format specifications, incomplete relationships
-     * - LOW: Documentation improvements, style consistency
+     * Severity levels:
+     * - Security vulnerabilities (exposed passwords, missing auth boundaries)
+     * - Missing required variants, incorrect type mappings
+     * - Missing format specifications, incomplete relationships
+     * - Documentation improvements, style consistency
      *
      * Each issue must include the specific schema name and what needs to be
      * fixed. If there are no issues at all, simply state: "No issues found."
@@ -70,21 +67,18 @@ export namespace IAutoBeInterfaceSchemasReviewApplication {
     /**
      * Final validated and enhanced schemas ready for production use.
      *
-     * CRITICAL REQUIREMENTS:
-     *
-     * - MUST NEVER be an empty object {}
-     * - MUST contain valid OpenAPI schema definitions
-     * - MUST include all entities that were in the original input
-     * - If original schemas have critical issues, MUST contain fixed versions
-     * - If entity names are wrong, MUST contain renamed correct versions
-     * - If schemas are missing variants, MUST include the created variants
-     *
-     * FORBIDDEN:
+     * DO:
+     * - Include valid OpenAPI schema definitions
+     * - Include all entities that were in the original input
+     * - Provide fixed versions if original schemas have issues
+     * - Rename entities correctly if names are wrong
+     * - Include created variants if schemas are missing them
      *
-     * - Empty object {} will cause all schemas to be deleted
-     * - Returning undefined or null
-     * - Including explanations or excuses in schema descriptions
-     * - Leaving broken schemas unfixed
+     * DO NOT:
+     * - Return an empty object {} (this will delete all schemas)
+     * - Return undefined or null
+     * - Include explanations or excuses in schema descriptions
+     * - Leave broken schemas unfixed
      *
      * When original schemas are beyond repair, recreate them properly based on
      * entity names and context. This field becomes the final schemas used by

package/src/orchestrate/interface/utils/validateAuthorizationSchema.ts

@@ -0,0 +1,41 @@
+import { AutoBeOpenApi } from "@autobe/interface";
+import { IValidation } from "typia";
+
+export const validateAuthorizationSchema = (props: {
+  errors: IValidation.IError[];
+  schemas: Record<string, AutoBeOpenApi.IJsonSchemaDescriptive>;
+  path: string;
+}): void => {
+  for (const [key, value] of Object.entries(props.schemas)) {
+    if (!key.endsWith(".IAuthorized")) continue;
+
+    // Check if it's an object type
+    if (!isObjectSchema(value)) {
+      props.errors.push({
+        path: `${props.path}.${key}`,
+        expected: `AutoBeOpenApi.IJsonSchemaDescriptive<AutoBeOpenApi.IJsonSchema.IObject>`,
+        value: value,
+        description: `${key} must be an object type for authorization responses`,
+      });
+      continue;
+    }
+
+    // Check if token property exists
+    value.properties ??= {};
+    value.properties["token"] = {
+      $ref: "#/components/schemas/IAuthorizationToken",
+      description: "JWT token information for authentication",
+    } as AutoBeOpenApi.IJsonSchemaDescriptive<AutoBeOpenApi.IJsonSchema.IReference>;
+
+    value.required ??= [];
+    if (value.required.includes("token") === false) {
+      value.required.push("token");
+    }
+  }
+};
+
+const isObjectSchema = (
+  schema: AutoBeOpenApi.IJsonSchemaDescriptive,
+): schema is AutoBeOpenApi.IJsonSchemaDescriptive<AutoBeOpenApi.IJsonSchema.IObject> => {
+  return "type" in schema && schema.type === "object";
+};

package/src/orchestrate/prisma/histories/transformPrismaComponentsHistories.ts

@@ -1,5 +1,7 @@
 import { IAgenticaHistoryJson } from "@agentica/core";
-import { v4 } from "uuid";
+import { StringUtil } from "@autobe/utils";
+import { NamingConvention } from "typia/lib/utils/NamingConvention";
+import { v7 } from "uuid";
 
 import { AutoBeSystemPromptConstant } from "../../../constants/AutoBeSystemPromptConstant";
 import { AutoBeState } from "../../../context/AutoBeState";
@@ -11,80 +13,73 @@ export const transformPrismaComponentsHistories = (
   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.",
-          "Don't call any tool function,",
-          "but say to process the requirement analysis.",
-        ].join(" "),
-      },
-    ];
+    // unreachable
+    throw new Error("Analyze state is not set.");
+  if (prefix) prefix = NamingConvention.snake(prefix);
   return [
     {
-      id: v4(),
+      id: v7(),
       created_at: new Date().toISOString(),
       type: "systemMessage",
       text: AutoBeSystemPromptConstant.PRISMA_COMPONENT,
     },
     {
-      id: v4(),
+      id: v7(),
       created_at: new Date().toISOString(),
       type: "assistantMessage",
-      text: [
-        "Here is the requirement analysis report.",
-        "",
-        "Call the provided tool function to generate Prisma DB schema",
-        "referencing below requirement analysis report.",
-        "",
-        `## Requirement Analysis Report`,
-        "",
-        "```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`",
-        "",
-        "",
-        state.analyze.roles.length > 0
-          ? [
-              "## User Role Handling",
-              "",
-              `The Requirement Analysis Report contains the following user roles: ${state.analyze.roles.join(", ")}.`,
-              "",
-              "**Do not normalize** user roles into a single table.",
-              "Instead, create separate tables for each distinct role mentioned in the requirements.",
-              "",
-              "Create separate tables for each role:",
-              "",
-              state.analyze.roles
-                .map((role) => `* ${prefix}_${role.name.toLowerCase()}`)
-                .join("\n"),
-              "",
-            ].join("\n")
-          : "",
-      ].join("\n"),
+      text: StringUtil.trim`
+        Here is the requirement analysis report.
+        
+        Call the provided tool function to generate Prisma DB schema
+        referencing below requirement analysis report.
+        
+        ## Requirement Analysis Report
+        
+        \`\`\`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.
+        
+        - DO: Use the provided prefix for all table names
+        - DO: Place special-purpose prefixes like \`mv\` (for materialized views) before the given prefix
+        - DO NOT: Apply prefix if it is \`null\`
+        
+        ## Prefix Example
+        
+        If the prefix is \`shopping\`, then table names are 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\`
+        
+        ${
+          state.analyze.roles.length > 0
+            ? StringUtil.trim`
+                ## User Role Handling
+                
+                The Requirement Analysis Report contains the following user roles: ${state.analyze.roles.join(", ")}
+                
+                **Do not normalize** user roles into a single table.
+                Instead, create separate tables for each distinct role mentioned in the requirements.
+                
+                Create separate tables for each role:
+                
+                ${state.analyze.roles
+                  .map((role) => `- ${prefix}_${role.name.toLowerCase()}`)
+                  .join("\n")}
+              `
+            : ""
+        }
+      `,
     },
   ];
 };

package/src/orchestrate/prisma/histories/transformPrismaCorrectHistories.ts

@@ -1,6 +1,7 @@
 import { IAgenticaHistoryJson } from "@agentica/core";
 import { IAutoBePrismaValidation } from "@autobe/interface";
-import { v4 } from "uuid";
+import { StringUtil } from "@autobe/utils";
+import { v7 } from "uuid";
 
 import { AutoBeSystemPromptConstant } from "../../../constants/AutoBeSystemPromptConstant";
 
@@ -11,46 +12,34 @@ export const transformPrismaCorrectHistories = (
 > => {
   return [
     {
-      id: v4(),
+      id: v7(),
       created_at: new Date().toISOString(),
       type: "systemMessage",
       text: AutoBeSystemPromptConstant.PRISMA_CORRECT,
     },
     {
-      id: v4(),
+      id: v7(),
       created_at: new Date().toISOString(),
       type: "assistantMessage",
-      text: [
-        "Here is the Prisma application data what you made:",
-        "",
-        "```json",
-        JSON.stringify(result.data),
-        "```",
-      ].join("\n"),
+      text: StringUtil.trim`
+        Here is the Prisma application data what you made:
+        
+        \`\`\`json
+        ${JSON.stringify(result.data)}
+        \`\`\`
+      `,
     },
     {
-      id: v4(),
+      id: v7(),
       created_at: new Date().toISOString(),
       type: "assistantMessage",
-      text: [
-        "Below are the list of errors what you have to fix:",
-        "",
-        "```json",
-        JSON.stringify(result.errors),
-        "```",
-      ].join("\n"),
-    },
-    {
-      id: v4(),
-      created_at: new Date().toISOString(),
-      type: "systemMessage",
-      text: [
-        "Before fixing the schema files,",
-        "study about Prisma schema language",
-        "from the best practices and examples",
-        "",
-        AutoBeSystemPromptConstant.PRISMA_EXAMPLE,
-      ].join("\n"),
+      text: StringUtil.trim`
+        Below are the list of errors what you have to fix:
+        
+        \`\`\`json
+        ${JSON.stringify(result.errors)}
+        \`\`\`
+      `,
     },
   ];
 };

package/src/orchestrate/prisma/histories/transformPrismaReviewHistories.ts

@@ -1,6 +1,7 @@
 import { IAgenticaHistoryJson } from "@agentica/core";
 import { AutoBePrisma } from "@autobe/interface";
-import { v4 } from "uuid";
+import { StringUtil } from "@autobe/utils";
+import { v7 } from "uuid";
 
 import { AutoBeSystemPromptConstant } from "../../../constants/AutoBeSystemPromptConstant";
 
@@ -14,53 +15,55 @@ export const transformPrismaReviewHistories = (props: {
 > => {
   return [
     {
-      id: v4(),
+      id: v7(),
       created_at: new Date().toISOString(),
       type: "systemMessage",
       text: AutoBeSystemPromptConstant.PRISMA_SCHEMA,
     },
     {
-      id: v4(),
+      id: v7(),
       created_at: new Date().toISOString(),
-      type: "assistantMessage",
-      text: [
-        "Here is the requirement analysis report given by the user:",
-        "",
-        "```json",
-        JSON.stringify(props.analysis),
-        "```",
-        "",
-        "Reading the requirement analysis report, you AI made below AST definition for the database design:",
-        "",
-        "```json",
-        JSON.stringify(props.application),
-        "```",
-        "",
-        "And here are the Prisma schema files generated (compiled) from the above AST:",
-        "",
-        "```prisma",
-        JSON.stringify(props.schemas),
-        "```",
-      ].join("\n"),
+      type: "systemMessage",
+      text: AutoBeSystemPromptConstant.PRISMA_REVIEW,
     },
     {
-      id: v4(),
+      id: v7(),
       created_at: new Date().toISOString(),
-      type: "systemMessage",
-      text: AutoBeSystemPromptConstant.PRISMA_REVIEW,
+      type: "assistantMessage",
+      text: StringUtil.trim`
+        Here is the requirement analysis report given by the user:
+        
+        \`\`\`json
+        ${JSON.stringify(props.analysis)}
+        \`\`\`
+        
+        Reading the requirement analysis report, you AI made 
+        below AST definition for the database design:
+        
+        \`\`\`json
+        ${JSON.stringify(props.application)}
+        \`\`\`
+        
+        And here are the Prisma schema files generated (compiled) 
+        from the above AST:
+        
+        \`\`\`json
+        ${JSON.stringify(props.schemas)}
+        \`\`\`
+      `,
     },
     {
-      id: v4(),
+      id: v7(),
       created_at: new Date().toISOString(),
       type: "assistantMessage",
-      text: [
-        `Now, please review the tables in the "${props.component.namespace}" namespace.`,
-        "",
-        "Focus your review exclusively on these tables.",
-        "",
-        "**Tables in this namespace:**",
-        ...props.component.tables.map((table) => `- ${table}`),
-      ].join("\n"),
+      text: StringUtil.trim`
+        Now, please review the tables in the "${props.component.namespace}" namespace.
+        
+        Focus your review exclusively on these tables.
+        
+        **Tables in this namespace:**
+        ${props.component.tables.map((table) => `- ${table}`).join("\n")}
+      `,
     },
   ];
 };

package/src/orchestrate/prisma/histories/transformPrismaSchemaHistories.ts

@@ -1,6 +1,7 @@
 import { IAgenticaHistoryJson } from "@agentica/core";
 import { AutoBePrisma } from "@autobe/interface";
-import { v4 } from "uuid";
+import { StringUtil } from "@autobe/utils";
+import { v7 } from "uuid";
 
 import { AutoBeSystemPromptConstant } from "../../../constants/AutoBeSystemPromptConstant";
 
@@ -13,42 +14,54 @@ export const transformPrismaSchemaHistories = (
 > => {
   return [
     {
-      id: v4(),
+      id: v7(),
       created_at: new Date().toISOString(),
       type: "systemMessage",
       text: AutoBeSystemPromptConstant.PRISMA_SCHEMA,
     },
     {
-      id: v4(),
+      id: v7(),
       created_at: new Date().toISOString(),
       type: "assistantMessage",
-      text: [
-        "Here is the input data for generating Prisma DB schema.",
-        "",
-        "```",
-        JSON.stringify({
-          requirementAnalysisReport,
+      text: StringUtil.trim`
+        Here is the requirement analysis report:
+
+        \`\`\`json
+        ${JSON.stringify(requirementAnalysisReport)}
+        \`\`\`
+      `,
+    },
+    {
+      id: v7(),
+      created_at: new Date().toISOString(),
+      type: "assistantMessage",
+      text: StringUtil.trim`
+        Here is the input data for generating Prisma DB schema.
+        
+        \`\`\`json
+        ${JSON.stringify({
           targetComponent,
           otherTables,
-        }),
-        "```",
-      ].join("\n"),
+        })}
+        \`\`\`
+      `,
     },
     {
-      id: v4(),
+      id: v7(),
       created_at: new Date().toISOString(),
       type: "systemMessage",
-      text: [
-        "You've already taken a mistake that creating models from the other components.",
-        "Note that, you have to make models from the target component only. Never make",
-        "models from the other components. The other components' models are already made.",
-        "",
-        "```json",
-        JSON.stringify({
+      text: StringUtil.trim`
+        You've already taken a mistake that creating models from the other components.
+
+        Note that, you have to make models from the target component only. Never make
+        models from the other components. The other components' models are already made.
+        
+        \`\`\`json
+        ${JSON.stringify({
           targetComponent,
-        }),
-        "```",
-      ].join("\n"),
+        })}
+        \`\`\`
+      `,
     },
   ];
 };

package/src/orchestrate/prisma/orchestratePrisma.ts

@@ -10,9 +10,11 @@ import {
 } from "@autobe/interface";
 import { AutoBePrismaSchemasEvent } from "@autobe/interface/src/events/AutoBePrismaSchemasEvent";
 import { ILlmSchema } from "@samchon/openapi";
+import { v7 } from "uuid";
 
 import { AutoBeContext } from "../../context/AutoBeContext";
 import { IAutoBeApplicationProps } from "../../context/IAutoBeApplicationProps";
+import { predicateStateMessage } from "../../utils/predicateStateMessage";
 import { orchestratePrismaComponents } from "./orchestratePrismaComponent";
 import { orchestratePrismaCorrect } from "./orchestratePrismaCorrect";
 import { orchestratePrismaReview } from "./orchestratePrismaReview";
@@ -22,21 +24,29 @@ export const orchestratePrisma = async <Model extends ILlmSchema.Model>(
   ctx: AutoBeContext<Model>,
   props: IAutoBeApplicationProps,
 ): Promise<AutoBePrismaHistory | AutoBeAssistantMessageHistory> => {
+  // PREDICATION
   const start: Date = new Date();
+  const predicate: string | null = predicateStateMessage(ctx.state(), "prisma");
+  if (predicate !== null)
+    return ctx.assistantMessage({
+      type: "assistantMessage",
+      id: v7(),
+      created_at: start.toISOString(),
+      text: predicate,
+      completed_at: new Date().toISOString(),
+    });
   ctx.dispatch({
     type: "prismaStart",
+    id: v7(),
     created_at: start.toISOString(),
     reason: props.reason,
     step: ctx.state().analyze?.step ?? 0,
   });
 
   // COMPONENTS
-  const componentEvent:
-    | AutoBeAssistantMessageHistory
-    | AutoBePrismaComponentsEvent = await orchestratePrismaComponents(ctx);
-  if (componentEvent.type === "assistantMessage")
-    return ctx.assistantMessage(componentEvent);
-  else ctx.dispatch(componentEvent);
+  const componentEvent: AutoBePrismaComponentsEvent =
+    await orchestratePrismaComponents(ctx);
+  ctx.dispatch(componentEvent);
 
   // CONSTRUCT AST DATA
   const schemaEvents: AutoBePrismaSchemasEvent[] =
@@ -84,6 +94,7 @@ export const orchestratePrisma = async <Model extends ILlmSchema.Model>(
   // PROPAGATE
   return ctx.dispatch({
     type: "prismaComplete",
+    id: v7(),
     result,
     schemas: finalSchemas,
     compiled: await compiler.prisma.compile({