@aigne/doc-smith 0.9.7 → 0.9.8-alpha.1

package/agents/create/analyze-diagram-type.mjs

@@ -0,0 +1,297 @@
+import { DIAGRAM_STYLES } from "../../utils/constants/index.mjs";
+
+const DEFAULT_DIAGRAM_STYLE = "modern";
+const DEFAULT_DIAGRAM_TYPE = "flowchart";
+
+// Type-specific content requirements
+const TYPE_REQUIREMENTS = {
+  architecture: `- Accurately represent the system architecture, components, services, and their relationships
+  - Show clear component boundaries and service interactions
+  - Include all key architectural elements (layers, modules, services, databases, APIs)
+  - Display data flow and communication patterns between components
+  - Use clear labels for each component and connection`,
+  flowchart: `- Accurately represent the process flow, steps, decisions, and workflow
+  - Show clear step-by-step progression with decision points
+  - Use standard flowchart symbols: rectangles for processes, diamonds for decisions, arrows for flows
+  - Include all key steps and decision branches
+  - Maintain logical flow direction (top-to-bottom or left-to-right)`,
+  guide: `- Show user journey, tutorial flow, or guided process
+  - Display clear progression from start to completion
+  - Include key milestones, checkpoints, or decision points
+  - Use clear visual cues to guide the viewer through the process
+  - Make it easy to follow and understand the path`,
+  intro: `- Provide a high-level overview or conceptual explanation
+  - Show main concepts, relationships, and key ideas
+  - Use clear visual hierarchy to emphasize important elements
+  - Make it accessible and easy to understand for newcomers
+  - Focus on big picture rather than detailed implementation`,
+  sequence: `- Show interactions over time between components or actors
+  - Display clear message flow and timing
+  - Include all participating entities and their interactions
+  - Show chronological order of events
+  - Use clear labels for messages and interactions`,
+  network: `- Show network structure, nodes, and connections
+  - Display routing paths and network topology
+  - Include all network components (routers, switches, servers, clients)
+  - Show connection types and data flow directions
+  - Use clear labels for network elements`,
+};
+
+// Style-specific requirements
+const STYLE_REQUIREMENTS = {
+  modern: `- Modern, clean, professional diagram style
+  - Contemporary design elements with smooth lines
+  - Professional color scheme suitable for technical documentation
+  - Clear visual hierarchy and readable text
+  - Sleek and polished appearance`,
+  standard: `- Standard flowchart style with traditional symbols
+  - Conventional formatting and clear structure
+  - Rectangles for processes, diamonds for decisions, arrows for flows
+  - Clear, readable text labels
+  - Professional and familiar appearance`,
+  "hand-drawn": `- Hand-drawn, sketch-like style with natural, organic lines
+  - Slightly imperfect shapes for a casual, approachable appearance
+  - Natural line variations and hand-drawn aesthetics
+  - Friendly and informal visual style
+  - Avoid perfect geometric shapes`,
+  anthropomorphic: `- Anthropomorphic style with personified elements
+  - Vivid and lively imagery with characters or objects having human-like features
+  - Engaging and memorable visual elements
+  - Creative and expressive design
+  - Make abstract concepts more relatable through personification`,
+  flat: `- Flat design style with no shadows, gradients, or 3D effects
+  - Clean geometric shapes with bold colors
+  - Minimalist aesthetics with simple, flat surfaces
+  - Modern and clean appearance
+  - Avoid depth and dimensionality`,
+  minimalist: `- Minimalist style with the fewest possible elements
+  - Maximum clarity with simple shapes
+  - Ample white space and essential information only
+  - Clean and uncluttered appearance
+  - Focus on core message without distractions`,
+  "3d": `- 3D style with three-dimensional effects and perspective
+  - Depth, shadows, and realistic spatial relationships
+  - Three-dimensional appearance with volume and dimension
+  - Professional and modern 3D rendering
+  - Clear depth cues and perspective`,
+};
+
+/**
+ * Analyze document content to determine diagram type and select appropriate style
+ * Uses LLM analysis to determine diagram type and style
+ * Supports extracting style and type preferences from user feedback
+ */
+export default async function analyzeDiagramType(
+  {
+    documentContent,
+    availableStyles = [],
+    defaultStyle,
+    diagramming,
+    locale = "en",
+    feedback = "",
+  },
+  options,
+) {
+  // Extract defaultStyle from diagramming object if not provided directly
+  if (!defaultStyle && diagramming?.style) {
+    defaultStyle = diagramming.style;
+  }
+
+  // Step 1: Use LLM to analyze and make final decision (LLM will analyze feedback directly)
+  const llmAgent = options.context?.agents?.["analyzeDiagramTypeLLM"];
+  let llmResult = null;
+
+  if (llmAgent) {
+    try {
+      // Build styleDescriptions object for template
+      // Include predefined styles as reference, but allow LLM to use any style
+      const styleDescriptions = {};
+      const stylesToUse =
+        availableStyles.length > 0 ? availableStyles : Object.keys(DIAGRAM_STYLES);
+      for (const style of stylesToUse) {
+        if (DIAGRAM_STYLES[style]) {
+          styleDescriptions[style] =
+            DIAGRAM_STYLES[style].description || DIAGRAM_STYLES[style].name;
+        }
+      }
+      // Also include all predefined styles as reference even if not in availableStyles
+      // This helps LLM understand common style options but doesn't restrict it
+      for (const [style, styleInfo] of Object.entries(DIAGRAM_STYLES)) {
+        if (!styleDescriptions[style]) {
+          styleDescriptions[style] = styleInfo.description || styleInfo.name;
+        }
+      }
+
+      const llmInput = {
+        documentContent,
+        availableStyles: stylesToUse,
+        styleDescriptions,
+        locale,
+        feedback: feedback || "",
+        defaultStyle: defaultStyle || null,
+      };
+
+      llmResult = await options.context.invoke(llmAgent, llmInput);
+    } catch (error) {
+      console.warn(`⚠️  LLM analysis failed: ${error.message}`);
+    }
+  }
+
+  // Step 2: Determine diagram type
+  // Priority: LLM result (which already analyzed feedback) > default
+  const diagramType = llmResult?.diagramType || DEFAULT_DIAGRAM_TYPE;
+
+  // Step 3: Select style
+  // Trust LLM to always return a valid style (required in output_schema)
+  // LLM can return any style name, not limited to predefined styles
+  // Only use fallback if LLM completely failed
+  const diagramStyle = llmResult?.diagramStyle || defaultStyle || DEFAULT_DIAGRAM_STYLE;
+
+  // Note: We allow any style name from LLM, even if not in availableStyles
+  // This enables creative styles beyond predefined ones (e.g., 'watercolor', 'cyberpunk', 'isometric')
+  // If availableStyles is provided and not empty, it serves as a preference guide, not a strict restriction
+
+  // Step 4: Generate prompt requirements for image generation
+  const diagramTypeRequirements =
+    TYPE_REQUIREMENTS[diagramType] || TYPE_REQUIREMENTS[DEFAULT_DIAGRAM_TYPE];
+  const diagramStyleRequirements =
+    STYLE_REQUIREMENTS[diagramStyle] || STYLE_REQUIREMENTS[DEFAULT_DIAGRAM_STYLE];
+
+  // Generate negative prompt exclusions based on style
+  let negativePromptExclusions = "";
+  if (diagramStyle !== "anthropomorphic") {
+    negativePromptExclusions += ", anthropomorphic";
+  }
+  if (diagramStyle !== "hand-drawn") {
+    negativePromptExclusions += ", hand-drawn, sketch";
+  }
+
+  // Step 5: Extract document summary from LLM result
+  // The LLM creates a concise summary focusing on key elements for diagram generation
+  // This ensures both the analysis model and image generation model have consistent understanding
+  const documentSummary = llmResult?.documentSummary || documentContent;
+
+  // If LLM didn't provide a summary (fallback), use original content
+  // But prefer the LLM-generated summary as it's focused and aligned with the analysis
+
+  // Step 6: Determine aspect ratio from LLM result
+  // The LLM analyzes the content structure and recommends the best aspect ratio
+  // We trust the LLM's judgment as it has analyzed the actual content
+  // If LLM doesn't provide aspectRatio (shouldn't happen, but fallback for safety), use 4:3 as safe default
+  let aspectRatio = llmResult?.aspectRatio || "4:3";
+
+  // Validate that the aspectRatio is one of the supported values
+  const supportedRatios = ["1:1", "5:4", "4:3", "3:2", "16:9", "21:9"];
+  if (!supportedRatios.includes(aspectRatio)) {
+    console.warn(`Invalid aspectRatio "${aspectRatio}" from LLM, falling back to "4:3"`);
+    aspectRatio = "4:3";
+  }
+
+  // Step 7: Return document content and summary for image generation
+  return {
+    diagramType,
+    diagramStyle,
+    aspectRatio,
+    documentContent, // The full document content (kept for backward compatibility and additional context)
+    documentSummary, // The concise summary generated by LLM, focused on key elements for diagram generation
+    diagramTypeRequirements,
+    diagramStyleRequirements,
+    negativePromptExclusions,
+  };
+}
+
+analyzeDiagramType.input_schema = {
+  type: "object",
+  properties: {
+    documentContent: {
+      type: "string",
+      description: "The document content to analyze for diagram type and style selection",
+    },
+    availableStyles: {
+      type: "array",
+      description:
+        "List of available diagram styles configured by user (optional restriction). If empty, any style is allowed.",
+      items: {
+        type: "string",
+      },
+    },
+    defaultStyle: {
+      type: "string",
+      description:
+        "Default diagram style to use when no style is specified in feedback. Can be any style name, not limited to predefined styles.",
+    },
+    diagramming: {
+      type: "object",
+      description: "Diagramming configuration object (alternative way to pass style)",
+      properties: {
+        style: {
+          type: "string",
+          description: "Default diagram style",
+        },
+      },
+    },
+    locale: {
+      type: "string",
+      description: "Language for analysis",
+      default: "en",
+    },
+    feedback: {
+      type: "string",
+      description:
+        "User feedback that may contain style or type preferences (e.g., 'use anthropomorphic style', 'create architecture diagram')",
+      default: "",
+    },
+  },
+  required: ["documentContent"],
+};
+
+analyzeDiagramType.output_schema = {
+  type: "object",
+  properties: {
+    diagramType: {
+      type: "string",
+      description: "The detected diagram type",
+    },
+    diagramStyle: {
+      type: "string",
+      description: "The selected diagram style",
+    },
+    diagramTypeRequirements: {
+      type: "string",
+      description: "Content requirements for the diagram type",
+    },
+    diagramStyleRequirements: {
+      type: "string",
+      description: "Style requirements for the diagram style",
+    },
+    negativePromptExclusions: {
+      type: "string",
+      description: "Additional negative prompt exclusions based on style",
+    },
+    aspectRatio: {
+      type: "string",
+      description: "Aspect ratio for the diagram (must match content flow direction)",
+      enum: ["1:1", "5:4", "4:3", "3:2", "16:9", "21:9"],
+    },
+    documentContent: {
+      type: "string",
+      description:
+        "The full document content (kept for backward compatibility and additional context)",
+    },
+    documentSummary: {
+      type: "string",
+      description:
+        "A concise summary of the document content focusing on key elements needed for diagram generation. This summary is generated by the analysis LLM to ensure consistent understanding between analysis and image generation models.",
+    },
+  },
+  required: [
+    "diagramType",
+    "diagramStyle",
+    "aspectRatio",
+    "documentSummary",
+    "diagramTypeRequirements",
+    "diagramStyleRequirements",
+    "negativePromptExclusions",
+    "documentContent",
+  ],
+};

package/agents/create/check-need-generate-structure.mjs

@@ -1,4 +1,3 @@
-import chalk from "chalk";
 import { getActiveRulesForScope } from "../../utils/preferences-utils.mjs";
 import { getProjectInfo, loadConfigFromFile, saveValueToConfig } from "../../utils/utils.mjs";
 import streamlineDocumentTitlesIfNeeded from "../utils/streamline-document-titles-if-needed.mjs";
@@ -7,38 +6,6 @@ export default async function checkNeedGenerateStructure(
   { originalDocumentStructure, forceRegenerate, ...rest },
   options,
 ) {
-  // Check if originalDocumentStructure is empty and prompt user
-  if (!originalDocumentStructure) {
-    const choice = await options.prompts.select({
-      message: "Project configured. Generate documentation structure now?",
-      choices: [
-        {
-          name: "Yes, generate now",
-          value: "generate",
-        },
-        {
-          name: "No, review configuration first",
-          value: "later",
-        },
-      ],
-    });
-
-    if (choice === "later") {
-      console.log(`\nConfiguration file: ${chalk.cyan("./.aigne/doc-smith/config.yaml")}`);
-      console.log("Review and edit your configuration, then run `aigne doc create` to continue.");
-
-      // In test environment, return a special result instead of exiting
-      if (process.env.NODE_ENV === "test") {
-        return {
-          userDeferred: true,
-          documentStructure: null,
-        };
-      }
-
-      process.exit(0);
-    }
-  }
-
   let finalFeedback = "";
 
   // User requested regeneration
@@ -54,7 +21,7 @@ export default async function checkNeedGenerateStructure(
     };
   }
 
-  const generateStructureAgent = options.context.agents["generateStructure"];
+  const generateStructureAgent = options.context.agents["generateStructureExp"];
 
   const structureRules = getActiveRulesForScope("structure", []);
   const globalRules = getActiveRulesForScope("global", []);

package/agents/create/generate-diagram-image.yaml

@@ -0,0 +1,60 @@
+type: image
+name: generateDiagramImage
+image_model:
+  model: google/gemini-3-pro-image-preview
+  #  The cues that come with thought patterns are actually not obvious
+  # thinkingConfig: 
+  #   includeThoughts: true      
+  # responseModalities: 
+  #   - 'TEXT'
+  #   - 'IMAGE'
+  imageConfig:
+    imageSize:
+      $get: size
+    aspectRatio:
+      $get: ratio
+
+instructions:
+  - role: system
+    url: ../../prompts/detail/diagram/generate-image-system.md
+  - role: user
+    url: ../../prompts/detail/diagram/generate-image-user.md
+
+input_schema:
+  type: object
+  properties:
+    documentContent:
+      type: string
+      description: The full original document content
+    documentSummary:
+      type: string
+      description: A comprehensive summary of the document content for diagram generation (preferred over documentContent if available)
+    diagramType:
+      type: string
+      description: The type of diagram to generate (architecture, flowchart, guide, intro, sequence, network)
+    diagramStyle:
+      type: string
+      description: The visual style for the diagram (modern, standard, hand-drawn, anthropomorphic, flat, minimalist, 3d)
+    locale:
+      type: string
+      description: Language for diagram labels
+      default: en
+    size:
+      type: string
+      description: Size of the generated image (e.g., "1K", "2K")
+      default: "1K"
+    ratio:
+      type: string
+      description: Aspect ratio of the generated image (must match content flow direction)
+      enum: ["1:1", "5:4", "4:3", "3:2", "16:9", "21:9"]
+    aspectRatio:
+      type: string
+      description: Aspect ratio of the generated image (alias for ratio, used in prompt templates)
+      enum: ["1:1", "5:4", "4:3", "3:2", "16:9", "21:9"]
+  required:
+    - documentContent
+    - diagramType
+    - diagramStyle
+    - ratio
+include_input_in_output: true
+

package/agents/create/index.yaml

@@ -8,6 +8,7 @@ skills:
   - url: ../init/index.mjs
     default_input:
       skipIfExists: true
+  # - ../../agentic-agents/structure/index.yaml
   - ../utils/load-sources.mjs
   - ./check-need-generate-structure.mjs
   - url: ../utils/save-output.mjs
@@ -36,10 +37,13 @@ skills:
 input_schema:
   type: object
   properties:
-    glossary:
+    feedback:
       type: string
-      description: Glossary file for consistent terminology (use @filename.md)
-    forceRegenerate:
-      type: boolean
-      description: Rebuild all documentation from scratch
+      description: User feedback describing what documentation tasks to perform (natural language)
+    # glossary:
+    #   type: string
+    #   description: Glossary file for consistent terminology (use @filename.md)
+    # forceRegenerate:
+    #   type: boolean
+    #   description: Rebuild all documentation from scratch
 mode: sequential