@aigne/doc-smith 0.9.8-alpha.3 → 0.9.8-alpha.5

package/agents/clear/clear-generated-docs.mjs

@@ -1,142 +0,0 @@
-import { rm } from "node:fs/promises";
-import { join } from "node:path";
-import { pathExists, resolveToAbsolute, toDisplayPath } from "../../utils/file-utils.mjs";
-import {
-  pathToFlatName,
-  generateFileName,
-  loadDocumentStructure,
-} from "../../utils/docs-finder-utils.mjs";
-import chooseDocs from "../utils/choose-docs.mjs";
-
-export default async function clearGeneratedDocs(input = {}, options = {}) {
-  const { docsDir, outputDir, locale, translateLanguages } = input;
-
-  if (!docsDir) {
-    return {
-      message: "📁 No generated documents directory specified",
-    };
-  }
-
-  const generatedDocsPath = resolveToAbsolute(docsDir);
-  const displayPath = toDisplayPath(generatedDocsPath);
-
-  try {
-    const dirExists = await pathExists(generatedDocsPath);
-    if (!dirExists) {
-      return {
-        message: `📁 Generated documents directory does not exist (${displayPath})`,
-        cleared: false,
-      };
-    }
-
-    const documentStructure = (await loadDocumentStructure(outputDir)) || [];
-    // select documents interactively
-    const chooseResult = await chooseDocs(
-      {
-        docs: [], // Empty to trigger interactive selection
-        documentStructure,
-        docsDir: generatedDocsPath,
-        locale: locale || "en",
-        isTranslate: false,
-        title: "Select documents to delete:",
-        feedback: "Skip feedback",
-        requiredFeedback: false,
-      },
-      options,
-    );
-
-    if (!chooseResult?.selectedDocs || chooseResult.selectedDocs.length === 0) {
-      return {
-        message: "📁 No documents selected for deletion",
-        cleared: false,
-        path: displayPath,
-      };
-    }
-
-    // Extract file names
-    const filesToDelete = new Set();
-    const allLanguages = [locale || "en", ...(translateLanguages || [])];
-
-    for (const selectedDoc of chooseResult.selectedDocs) {
-      // Convert path to flat filename format using utility function
-      const flatName = pathToFlatName(selectedDoc.path);
-
-      // Generate file names for all languages
-      for (const lang of allLanguages) {
-        const fileName = generateFileName(flatName, lang);
-        filesToDelete.add(fileName);
-      }
-    }
-
-    if (filesToDelete.size === 0) {
-      return {
-        message: "📁 No documents were deleted.",
-        cleared: false,
-      };
-    }
-
-    // Delete selected files (including all language versions)
-    const deletedFiles = [];
-    const failedFiles = [];
-    let hasError = false;
-
-    for (const file of filesToDelete) {
-      try {
-        const filePath = join(generatedDocsPath, file);
-        await rm(filePath);
-        deletedFiles.push(file);
-      } catch (error) {
-        // ignore if file not found
-        if (!["ENOENT"].includes(error.code)) {
-          hasError = true;
-          failedFiles.push({ file, error: error.message });
-        }
-      }
-    }
-
-    // Build result message
-    const deletedCount = deletedFiles.length;
-    const failedCount = failedFiles.length;
-
-    let message = "";
-    if (deletedCount > 0) {
-      const lastIndex = deletedFiles.length - 1;
-      message = `📁 Deleted ${deletedCount} document(s) in "${displayPath}":\n${deletedFiles
-        .map((f, i) => `  ${i === lastIndex ? "└─" : "├─"} ${f}`)
-        .join("\n")}`;
-    }
-
-    if (failedCount > 0) {
-      const lastIndex = failedFiles.length - 1;
-      message = `⚠️ Failed to delete ${failedCount} document(s) in "${displayPath}":\n${failedFiles
-        .map((f, i) => `  ${i === lastIndex ? "└─" : "├─"} ${f.file}: ${f.error}`)
-        .join("\n")}`;
-    }
-
-    return {
-      message,
-      cleared: deletedCount > 0,
-      error: hasError,
-    };
-  } catch (error) {
-    return {
-      message: `⚠️ Failed to clear generated documents: ${error.message}`,
-      error: true,
-    };
-  }
-}
-
-clearGeneratedDocs.input_schema = {
-  type: "object",
-  properties: {
-    docsDir: {
-      type: "string",
-      description: "The generated documents directory to clear",
-    },
-  },
-  required: ["docsDir"],
-};
-
-clearGeneratedDocs.taskTitle = "Clear generated documents";
-clearGeneratedDocs.description =
-  "Select and delete specific generated documents from the docs directory";

package/agents/clear/clear-media-description.mjs

@@ -1,129 +0,0 @@
-import { existsSync } from "node:fs";
-import { readFile, writeFile } from "node:fs/promises";
-import path from "node:path";
-import chalk from "chalk";
-import { parse, stringify } from "yaml";
-import { getMediaDescriptionCachePath } from "../../utils/file-utils.mjs";
-
-export default async function clearMediaDescription(_input = {}, options = {}) {
-  const cacheFilePath = getMediaDescriptionCachePath();
-
-  // Check if the cache file exists
-  if (!existsSync(cacheFilePath)) {
-    return {
-      message: "🖼️ No media descriptions found to clear",
-    };
-  }
-
-  try {
-    // Read existing cache
-    const cacheContent = await readFile(cacheFilePath, "utf8");
-    const parsedCache = parse(cacheContent);
-    const cache = parsedCache?.descriptions || {};
-
-    // Get all media files from cache
-    const mediaHashes = Object.keys(cache);
-
-    if (mediaHashes.length === 0) {
-      return {
-        message: "🖼️ No media descriptions found to clear",
-      };
-    }
-
-    // Build choices from cache - extract filename from path
-    const choices = mediaHashes.map((hash) => {
-      const mediaPath = cache[hash]?.path || "unknown";
-      const filename = path.basename(mediaPath);
-      const description = cache[hash]?.description || "";
-      const truncatedDesc =
-        description.length > 80 ? `${description.slice(0, 80)}...` : description;
-
-      return {
-        name: filename,
-        description: truncatedDesc,
-        value: hash,
-        checked: false,
-      };
-    });
-
-    // Add an option to clear all media descriptions
-    choices.push({
-      name: chalk.red("🗑️  Clear ALL media descriptions"),
-      value: "__ALL__",
-      checked: false,
-    });
-
-    let selectedHashes = [];
-
-    if (options?.prompts?.checkbox) {
-      selectedHashes = await options.prompts.checkbox({
-        message: "Select media files to clear descriptions:",
-        choices,
-        validate: (answer) => (answer.length > 0 ? true : "Please select at least one item."),
-      });
-    } else {
-      // If no prompts available, clear all
-      selectedHashes = ["__ALL__"];
-    }
-
-    if (selectedHashes.length === 0) {
-      return {
-        message: "🖼️ No media files selected for clearing descriptions",
-      };
-    }
-
-    const results = [];
-    let clearedCount = 0;
-
-    if (selectedHashes.includes("__ALL__")) {
-      // Clear all media descriptions
-      await writeFile(
-        cacheFilePath,
-        stringify({
-          descriptions: {},
-          lastUpdated: new Date().toISOString(),
-        }),
-      );
-      results.push(`✔ Cleared descriptions for all media files (${mediaHashes.length} files)`);
-      clearedCount = mediaHashes.length;
-    } else {
-      // Clear descriptions for selected files
-      const updatedCache = { ...cache };
-
-      for (const hash of selectedHashes) {
-        if (updatedCache[hash]) {
-          const filename = path.basename(updatedCache[hash].path);
-          delete updatedCache[hash];
-          results.push(`✔ Cleared description for ${chalk.cyan(filename)}`);
-          clearedCount++;
-        }
-      }
-
-      await writeFile(
-        cacheFilePath,
-        stringify({
-          descriptions: updatedCache,
-          lastUpdated: new Date().toISOString(),
-        }),
-      );
-    }
-
-    const header = `🖼️ Successfully cleared media descriptions`;
-    const detailLines = results.map((item) => `  ${item}`).join("\n");
-
-    const message = [header, "", detailLines, ""].filter(Boolean).join("\n");
-
-    return {
-      message,
-      clearedCount,
-    };
-  } catch (error) {
-    return {
-      message: `Error clearing media descriptions: ${error.message}`,
-      error: true,
-    };
-  }
-}
-
-clearMediaDescription.taskTitle = "Clear media file descriptions";
-clearMediaDescription.description = "Clear AI-generated descriptions for media files";

package/agents/clear/index.yaml

@@ -1,26 +0,0 @@
-type: team
-name: clear
-alias:
-  - clear
-description: Clear various types of data including documentation structure, generated documents, configuration, and authorization tokens
-skills:
-  - url: ../init/index.mjs
-    default_input:
-      skipIfExists: true
-      checkOnly: true
-  - ./choose-contents.mjs
-input_schema:
-  type: object
-  properties:
-    targets:
-      type: array
-      description: Items to clear without confirmation
-      items:
-        type: string
-        enum:
-          - documentStructure
-          - generatedDocs
-          - documentConfig
-          - authTokens
-          - deploymentConfig
-          - mediaDescription

package/agents/create/analyze-diagram-type-llm.yaml

@@ -1,160 +0,0 @@
-name: analyzeDiagramTypeLLM
-description: Analyze document content using LLM to determine diagram type and select appropriate style
-model:
-  reasoning_effort: 1
-instructions: |
-  You are an AI assistant specialized in technical documentation visualization. Your task is to analyze a document segment and generate a structured visual plan for an image generator.
-
-  {% if feedback %}
-  **CRITICAL: User Feedback (HIGHEST PRIORITY)**
-  <feedback>
-  {{ feedback }}
-  </feedback>
-  
-  **IMPORTANT**: User feedback has the **HIGHEST PRIORITY** in all decision-making. Any explicit requests in the feedback (e.g., diagram type, style, colors, aspect ratio, size, layout preferences) must be respected and applied. Additionally, extract and note any other feedback information (such as color preferences, size requirements, layout specifications, etc.) that should be passed to subsequent image generation steps.
-  {% endif %}
-
-  Your responsibilities:
-
-  1. **Analyze Context**: Understand the document’s content, structure, and its purpose, especially around where the diagram will be inserted.
-
-  2. **Generate Document Summary**:
-    **CRITICAL**: The documentSummary will be the **only input** passed to the image generation model. Preserve as much information as possible, only removing content that is truly useless for diagram generation.
-
-    **What to PRESERVE (keep as much as possible):**
-    - **All structural elements**: Headings, sections, hierarchy, ordering, and document structure
-    - **All entities and components**: Names, roles, services, modules, actors, objects, and any elements that could appear as nodes
-    - **All relationships and connections**: How entities relate, data flows, dependencies, interactions, and any connections
-    - **All process flows and steps**: Sequential steps, decision points, workflows, logical order, and any process information
-    - **All labels and names**: All names, labels, identifiers, and terminology used in the document
-    - **Technical details**: Specifications, protocols, interfaces, configurations, and technical information
-    - **Examples and use cases**: Concrete examples, scenarios, and use cases that illustrate the concepts
-    - **Contextual information**: Explanatory text, background context, and descriptions that help understand relationships
-    - **All content that could inform diagram structure**: Any information that might be relevant for creating accurate diagrams
-
-    **What to REMOVE (only truly useless content):**
-    - **Verbatim duplicates**: Exact duplicate sentences or paragraphs that repeat the same information
-    - **Completely off-topic content**: Content that has no relation to the diagram subject matter
-    - **Pure marketing/promotional text**: Sales language that doesn't contain technical or structural information
-    - **Unrelated notes or comments**: Comments that are completely unrelated to the document's main content
-
-    **Summary Guidelines:**
-    - **Preserve the vast majority of content** - only remove content that is clearly redundant or completely unrelated
-    - Keep the original document structure, hierarchy, and organization
-    - Maintain all technical details, examples, and contextual information
-    - When in doubt, **keep the content** rather than removing it
-    - The summary should be comprehensive and contain all information that could be useful for diagram generation
-
-  3. **Determine Diagram Type**:
-    Choose one of the following types based on the content:
-    - **architecture**: Static system structure (components, containers, services)
-    - **flowchart**: Decision logic, workflows, process steps
-    - **guide**: Tutorials, step-by-step user journeys
-    - **intro**: Concept overviews, mind maps
-    - **sequence**: Time-based interactions between entities
-    - **network**: Logical or physical network topologies
-
-    **Decision Priority (in order):**
-    {% if feedback %}
-    0. **HIGHEST PRIORITY**: Analyze the user feedback carefully. If the feedback explicitly or implicitly specifies a diagram type (e.g., "architecture diagram", "flowchart", "sequence diagram", "流程图", "架构图") → **MUST use that type and override any other considerations**. Use your understanding of natural language to identify the user's intent. The feedback type takes absolute precedence.
-    {% endif %}
-    1. **Content Analysis**: If no type preference is found in feedback, analyze the document content structure and characteristics:
-       - If the document is an **overview** (e.g. titled `# Overview`, describes whole system/project) → use `"architecture"`.
-       - Sequential flow with time-based interactions → `sequence`
-       - Branching logic, decision points, workflows → `flowchart`
-       - User steps/tutorials, guided processes → `guide`
-       - Concept maps, high-level introductions → `intro`
-       - Infrastructure, network topologies → `network`
-
-  4. **Select Diagram Style**:
-    **Decision Priority (in order):**
-    {% if feedback %}
-    0. **HIGHEST PRIORITY**: Analyze the user feedback carefully. If the feedback explicitly or implicitly specifies a diagram style (e.g., "modern style", "hand-drawn", "anthropomorphic", "3d", "flat design", "现代风格", "手绘风格") → **MUST use that style and override any default style**. Use your understanding of natural language to identify the user's style preference. The feedback style takes absolute precedence.
-    {% endif %}
-    {% if defaultStyle %}
-    1. **Default Style**: If no style preference is found in feedback, use the configured default style: `{{ defaultStyle }}`. This is the user's preferred default style from configuration.
-    {% endif %}
-    2. **Content-Based Selection**: If no feedback style and no default style, choose a style appropriate for technical documentation tone based on the content characteristics. You can use any style name that best fits the content, including but not limited to:
-       - Common styles: `modern`, `standard`, `hand-drawn`, `anthropomorphic`, `flat`, `minimalist`, `3d`
-       - Other creative styles: `watercolor`, `sketch`, `vintage`, `cyberpunk`, `minimal`, `realistic`, `cartoon`, `isometric`, `neon`, `pastel`, etc.
-       - You are not limited to predefined styles - use your knowledge of visual styles to select the most appropriate one
-    3. **Available Styles Reference**: If `availableStyles` is provided and not empty, prefer styles from that list. However, if a better style is needed and not in the list, you can still use it. The `styleDescriptions` object provides descriptions of common styles for reference, but you are not restricted to only those styles.
-
-  5. **Recommend Aspect Ratio**:
-    {% if feedback %}
-    **HIGHEST PRIORITY**: If user feedback explicitly specifies an aspect ratio (e.g., "16:9", "4:3", "use landscape", "make it square") → **MUST use that aspect ratio**.
-    {% endif %}
-    
-    Otherwise, select the most suitable aspect ratio based on layout direction:
-    - `"1:1"`: Radial layouts, mind maps, central concepts
-    - `"5:4"` or `"4:3"`: Vertical flows (step-by-step, guides)
-    - `"3:2"`, `"16:9"`, `"21:9"`: Horizontal flows (timelines, architecture)
-
-    **Decision Logic:**
-    - Vertical flows → use `"4:3"` (default), or `"5:4"` for taller needs
-    - Horizontal flows → `"16:9"` (default), `"21:9"` for very wide, `"3:2"` for moderate width
-    - Central hub structures → use `"1:1"`
-
-    **Never** mismatch direction and ratio:
-    - Don't use portrait for horizontal content or vice versa
-    - Don't use `"1:1"` unless layout is truly radial
-
-  Document Content:
-  <document_content>
-  {{ documentContent }}
-  </document_content>
-  
-
-input_schema:
-  type: object
-  properties:
-    documentContent:
-      type: string
-      description: The document content to analyze
-    availableStyles:
-      type: array
-      description: List of available diagram styles
-      items:
-        type: string
-    styleDescriptions:
-      type: object
-      description: Style descriptions
-      additionalProperties:
-        type: string
-    locale:
-      type: string
-      description: Language for labels
-      default: en
-    feedback:
-      type: string
-      description: User feedback that may contain style, type, or other preferences. You should analyze this feedback carefully to extract any explicit or implicit preferences. If feedback specifies a style or type, it MUST override the defaultStyle.
-      default: ""
-    defaultStyle:
-      type: string
-      description: Default diagram style from configuration. Use this only if no style preference is found in feedback. If feedback specifies a style, it takes precedence over this default.
-      nullable: true
-  required:
-    - documentContent
-    - availableStyles
-output_schema:
-  type: object
-  properties:
-    documentSummary:
-      type: string
-      description: A comprehensive summary that preserves the vast majority of the original document content. Only remove verbatim duplicates, completely off-topic content, or pure marketing text. Keep all structural elements, entities, relationships, processes, technical details, examples, and contextual information. This summary will be the only content passed to the image generation model.
-    diagramType:
-      type: string
-      description: The selected diagram type
-    diagramStyle:
-      type: string
-      description: The selected diagram style. Can be any style name (e.g., 'modern', 'hand-drawn', 'watercolor', 'cyberpunk', 'isometric', etc.). Not limited to predefined styles - use your knowledge of visual styles to select the most appropriate one.
-    aspectRatio:
-      type: string
-      description: Recommended aspect ratio for the image based on content structure analysis. MUST match the primary flow direction (vertical→portrait, horizontal→landscape, radial→square)
-      enum: ["1:1", "5:4", "4:3", "3:2", "16:9", "21:9"]
-  required:
-    - documentSummary
-    - diagramType
-    - diagramStyle
-    - aspectRatio
-