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

package/agents/utils/analyze-feedback-intent.mjs

@@ -1,136 +0,0 @@
-import { AIAgent } from "@aigne/core";
-import z from "zod";
-
-/**
- * Analyze user feedback to determine the intent type for document updates
- * Returns one of: "addDiagram", "deleteDiagram", "updateDiagram", "updateDocument"
- * Returns null if feedback is empty or invalid
- */
-export default async function analyzeFeedbackIntent({ feedback, shouldUpdateDiagrams }, options) {
-  // Check if feedback exists and is not empty
-  // If feedback is empty and --diagram flag is set, default to updateDiagram
-  // Otherwise return null
-  if (!feedback || typeof feedback !== "string" || !feedback.trim()) {
-    // If --diagram flag is set, default to updateDiagram (user wants to update diagrams)
-    if (shouldUpdateDiagrams) {
-      return { intentType: "updateDiagram" };
-    }
-    return { intentType: null };
-  }
-
-  // Always analyze user feedback first, even if --diagram flag is set
-  // This ensures user's explicit intent (e.g., "remove image", "delete diagram") is respected
-  // The --diagram flag should only be a hint, not override explicit user commands
-
-  const instructions = `<role>
-You are a feedback intent analyzer. Your task is to determine which type of content modifications are needed based on the user's feedback.
-
-You must analyze the user's feedback and classify it into one of the following intent types:
-- addDiagram: User wants to add a new diagram/image/chart
-- deleteDiagram: User wants to remove/delete a diagram/image/chart
-- updateDiagram: User wants to modify/update an existing diagram/image/chart
-- updateDocument: User wants to update document content (text, sections, etc.) without diagram operations
-</role>
-
-<intent_classification_rules>
-**deleteDiagram** - Use this when user explicitly wants to remove or delete a diagram/image/chart:
-- Keywords: remove, delete, 删除, 移除, 去掉, 清除
-- Combined with: diagram, image, picture, chart, graph, 图表, 图片, 图, 架构图
-- Examples:
-  - "Remove the diagram"
-  - "Delete the image"
-  - "删除这张图片"
-  - "Remove the second diagram"
-  - "去掉架构图"
-  - "Remove image from page 3"
-  - "Delete the chart showing the flow"
-
-**addDiagram** - Use this when user wants to add a new diagram:
-- Keywords: add, create, insert, 添加, 创建, 插入
-- Combined with: diagram, image, picture, chart, graph, 图表, 图片, 图
-- Examples:
-  - "Add a diagram showing the architecture"
-  - "Create a flow chart"
-  - "添加一个架构图"
-
-**updateDiagram** - Use this when user wants to modify an existing diagram:
-- Keywords: update, modify, change, improve, 更新, 修改, 改进
-- Combined with: diagram, image, picture, chart, graph, 图表, 图片, 图
-- Examples:
-  - "Update the diagram to show the new process"
-  - "Modify the chart to include more details"
-  - "更新架构图"
-
-**updateDocument** - Use this for all other content modifications:
-- Text changes, section updates, content improvements
-- No mention of diagrams/images/charts
-- Examples:
-  - "Update the introduction section"
-  - "Fix the typo in paragraph 2"
-  - "Improve the explanation"
-</intent_classification_rules>
-
-<user_feedback>
-{{feedback}}
-</user_feedback>
-
-<analysis_guidelines>
-1. Pay close attention to action verbs (remove, delete, add, update, etc.)
-2. Identify the target object (diagram, image, chart, or general content)
-3. If feedback mentions removing/deleting a diagram/image/chart → deleteDiagram
-4. If feedback mentions adding a diagram/image/chart → addDiagram
-5. If feedback mentions updating a diagram/image/chart → updateDiagram
-6. If feedback is about general content without diagram references → updateDocument
-7. When in doubt, prioritize the most explicit action mentioned in the feedback
-</analysis_guidelines>`;
-
-  try {
-    const analyzeUpdateFeedbackIntentAgent = AIAgent.from({
-      name: "analyzeUpdateFeedbackIntent",
-      description:
-        "Analyze user feedback to determine if document are needed for content modifications",
-      task_render_mode: "hide",
-      instructions,
-      inputSchema: z.object({
-        feedback: z.string().describe("User feedback for content modifications"),
-      }),
-      outputSchema: z.object({
-        intentType: z
-          .enum(["addDiagram", "deleteDiagram", "updateDiagram", "updateDocument"])
-          .describe(
-            "The primary type of user intention: one of addDiagram, deleteDiagram, updateDiagram, updateDocument",
-          ),
-      }),
-    });
-
-    const { intentType } = await options.context.invoke(analyzeUpdateFeedbackIntentAgent, {
-      feedback: feedback.trim(),
-    });
-
-    // If --diagram flag is set and user didn't explicitly request delete/add,
-    // default to updateDiagram (for backward compatibility)
-    // But if user explicitly requested delete/add, respect that intent
-    if (
-      shouldUpdateDiagrams &&
-      intentType &&
-      !["deleteDiagram", "addDiagram"].includes(intentType)
-    ) {
-      return { intentType: "updateDiagram" };
-    }
-
-    return { intentType };
-  } catch (error) {
-    // If analysis fails and --diagram flag is set, default to updateDiagram
-    // Otherwise return null to fall back to default document update flow
-    if (shouldUpdateDiagrams) {
-      console.warn(
-        `Failed to analyze feedback intent, defaulting to updateDiagram due to --diagram flag: ${error.message}`,
-      );
-      return { intentType: "updateDiagram" };
-    }
-    console.warn(`Failed to analyze feedback intent: ${error.message}`);
-    return { intentType: null };
-  }
-}
-
-analyzeFeedbackIntent.task_render_mode = "hide";

package/agents/utils/analyze-structure-feedback-intent.yaml

@@ -1,29 +0,0 @@
-name: analyzeStructureFeedbackIntent
-description: Analyze user feedback to determine if data sources are needed for structure modifications
-task_render_mode: hide
-instructions:
-  url: ../../prompts/utils/analyze-structure-feedback-intent.md
-input_schema:
-  type: object
-  properties:
-    feedback:
-      type: string
-      description: User feedback for structure modifications
-  required:
-    - feedback
-output_schema:
-  type: object
-  properties:
-    needDataSources:
-      type: boolean
-      description: Whether data sources are needed - true for add/edit operations that need context, false for delete/move/reorder operations
-    intentType:
-      type: string
-      description: The primary type of user intention
-    reason:
-      type: string
-      description: Explanation of why data sources are or aren't needed
-  required:
-    - needDataSources
-    - intentType
-    - reason

package/agents/utils/check-detail-result.mjs

@@ -1,38 +0,0 @@
-import { buildAllowedLinksFromStructure } from "../../utils/docs-finder-utils.mjs";
-import { checkMarkdown } from "../../utils/markdown-checker.mjs";
-
-export default async function checkDetailResult({ documentStructure, reviewContent, docsDir }) {
-  if (!reviewContent || reviewContent.trim() === "") {
-    return {
-      isApproved: false,
-      detailFeedback: "Review content is empty",
-    };
-  }
-
-  let isApproved = true;
-  const detailFeedback = [];
-
-  // Create a set of allowed links, including both original paths and processed .md paths
-  const allowedLinks = buildAllowedLinksFromStructure(documentStructure);
-
-  // Run comprehensive markdown validation with all checks
-  try {
-    const markdownErrors = await checkMarkdown(reviewContent, "result", {
-      allowedLinks,
-      baseDir: docsDir,
-    });
-
-    if (markdownErrors.length > 0) {
-      isApproved = false;
-      detailFeedback.push(...markdownErrors);
-    }
-  } catch (error) {
-    isApproved = false;
-    detailFeedback.push(`Found markdown validation error in result: ${error.message}`);
-  }
-
-  return {
-    isApproved,
-    detailFeedback: detailFeedback.join("\n"),
-  };
-}

package/agents/utils/check-feedback-refiner.mjs

@@ -1,81 +0,0 @@
-import { stringify } from "yaml";
-import { addPreferenceRule, readPreferences } from "../../utils/preferences-utils.mjs";
-
-export default async function checkFeedbackRefiner(
-  { feedback, stage, selectedPaths, documentStructureFeedback },
-  options,
-) {
-  // If feedback is empty, no need to save user preferences
-  if (!feedback && !documentStructureFeedback) {
-    return {};
-  }
-
-  // Read existing preferences as context for deduplication
-  const existingPreferences = readPreferences();
-  const activePreferences = existingPreferences.rules?.filter((rule) => rule.active) || [];
-
-  // Convert active preferences to YAML string format for passing
-  const activePreferencesYaml =
-    activePreferences.length > 0 ? stringify({ rules: activePreferences }, { indent: 2 }) : "";
-
-  const feedbackToUse = feedback || documentStructureFeedback;
-  const result = await options.context.invoke(options.context.agents["feedbackRefiner"], {
-    feedback: feedbackToUse,
-    stage,
-    paths: selectedPaths,
-    existingPreferences: activePreferencesYaml,
-  });
-
-  // If preferences need to be saved, save them to the preference file
-  if (result?.save) {
-    try {
-      const savedRule = addPreferenceRule(result, feedbackToUse, selectedPaths);
-
-      // Add saved preference information to the return result
-      result.savedPreference = {
-        id: savedRule.id,
-        saved: true,
-      };
-    } catch (error) {
-      console.error(
-        "Failed to save user preference rule:",
-        error.message,
-        "\nFeedback:",
-        feedbackToUse,
-      );
-      result.savedPreference = {
-        saved: false,
-        error: error.message,
-      };
-    }
-  }
-
-  return result;
-}
-
-checkFeedbackRefiner.input_schema = {
-  type: "object",
-  properties: {
-    feedback: {
-      type: "string",
-      description: "User feedback to refine",
-    },
-    documentStructureFeedback: {
-      type: "string",
-      description: "Feedback from documentation structure stage",
-    },
-    stage: {
-      type: "string",
-      description: "Stage of the feedback",
-    },
-    selectedPaths: {
-      type: "array",
-      items: {
-        type: "string",
-      },
-      description: "Selected paths of documents",
-    },
-  },
-};
-
-checkFeedbackRefiner.taskRenderMode = "collapse";

package/agents/utils/choose-docs.mjs

@@ -1,293 +0,0 @@
-import chalk from "chalk";
-import {
-  addFeedbackToItems,
-  findItemByPath,
-  getActionText,
-  getMainLanguageFiles,
-  processSelectedFiles,
-  readFileContent,
-} from "../../utils/docs-finder-utils.mjs";
-import {
-  hasDiagramContent,
-  hasBananaImages,
-  getDiagramTypeLabels,
-  formatDiagramTypeSuffix,
-} from "../../utils/check-document-has-diagram.mjs";
-import { debug } from "../../utils/debug.mjs";
-import { DOC_ACTION } from "../../utils/constants/index.mjs";
-
-function getFeedbackMessage(action) {
-  if (action === DOC_ACTION.translate) {
-    return "Any specific translation preferences or instructions? (Press Enter to skip):";
-  }
-  return "How would you like to improve this document? (Press Enter to skip)";
-}
-
-export default async function chooseDocs(
-  {
-    docs,
-    documentStructure,
-    boardId,
-    docsDir,
-    isTranslate,
-    feedback,
-    locale,
-    reset = false,
-    requiredFeedback = true,
-    action,
-    shouldUpdateDiagrams = false,
-    shouldAutoSelectDiagrams = false,
-    shouldSyncImages = false,
-    ...rest
-  },
-  options,
-) {
-  let foundItems = [];
-  let selectedFiles = [];
-  const docAction = action || (isTranslate ? DOC_ACTION.translate : DOC_ACTION.update);
-
-  // If docs is empty or not provided, let user select multiple documents
-  if (!docs || docs.length === 0) {
-    try {
-      // Get all main language .md files in docsDir
-      const mainLanguageFiles = await getMainLanguageFiles(docsDir, locale, documentStructure);
-
-      if (mainLanguageFiles.length === 0) {
-        throw new Error(
-          `No documents found in the docs directory. You can generate them with ${chalk.yellow(
-            "`aigne doc create`",
-          )}`,
-        );
-      }
-
-      // If --diagram-sync flag is set, filter documents by banana images only
-      if (shouldSyncImages) {
-        debug("🔄 Filtering documents with banana images...");
-
-        // Read content for all files and filter by banana images only
-        const filesWithImages = [];
-        for (const fileName of mainLanguageFiles) {
-          const content = await readFileContent(docsDir, fileName);
-          if (content && hasBananaImages(content)) {
-            filesWithImages.push(fileName);
-          }
-        }
-
-        if (filesWithImages.length === 0) {
-          debug("ℹ️  No documents found with banana images (DIAGRAM_IMAGE_START markers).");
-          return {
-            selectedDocs: [],
-            feedback: "",
-            selectedPaths: [],
-          };
-        }
-
-        debug(`✅ Found ${filesWithImages.length} document(s) with banana images.`);
-        debug("📋 Auto-selecting all documents with banana images...");
-        // Show diagram types for each document
-        for (const file of filesWithImages) {
-          const content = await readFileContent(docsDir, file);
-          const diagramLabels = content ? getDiagramTypeLabels(content) : [];
-          const diagramSuffix = formatDiagramTypeSuffix(diagramLabels);
-          debug(`   • ${file}${diagramSuffix}`);
-        }
-        selectedFiles = filesWithImages;
-      }
-      // If --diagram flag is set, filter documents by diagram content
-      else if (shouldUpdateDiagrams) {
-        debug("🔄 Filtering documents with diagram content...");
-
-        // Read content for all files and filter by diagram content
-        const filesWithDiagrams = [];
-        for (const fileName of mainLanguageFiles) {
-          const content = await readFileContent(docsDir, fileName);
-          if (content && hasDiagramContent(content)) {
-            filesWithDiagrams.push(fileName);
-          }
-        }
-
-        if (filesWithDiagrams.length === 0) {
-          debug(
-            "ℹ️  No documents found with diagram content (d2 code blocks, placeholders, or diagram images).",
-          );
-          return {
-            selectedDocs: [],
-            feedback: "",
-            selectedPaths: [],
-          };
-        }
-
-        debug(`✅ Found ${filesWithDiagrams.length} document(s) with diagram content.`);
-
-        // If --diagram-all, auto-select all; otherwise let user choose
-        if (shouldAutoSelectDiagrams) {
-          debug("📋 Auto-selecting all documents with diagrams...");
-          // Show diagram types for each document in auto-select mode
-          for (const file of filesWithDiagrams) {
-            const content = await readFileContent(docsDir, file);
-            const diagramLabels = content ? getDiagramTypeLabels(content) : [];
-            const diagramSuffix = formatDiagramTypeSuffix(diagramLabels);
-            debug(`   • ${file}${diagramSuffix}`);
-          }
-          selectedFiles = filesWithDiagrams;
-        } else {
-          // --diagram mode: show only documents with diagrams, let user select
-          const choices = await Promise.all(
-            filesWithDiagrams.map(async (file) => {
-              // Convert filename to flat path to find corresponding documentation structure item
-              const flatName = file.replace(/\.md$/, "").replace(/\.\w+(-\w+)?$/, "");
-              const docItem = documentStructure.find((item) => {
-                const itemFlattenedPath = item.path.replace(/^\//, "").replace(/\//g, "-");
-                return itemFlattenedPath === flatName;
-              });
-
-              // Read content to detect diagram types
-              const content = await readFileContent(docsDir, file);
-              const diagramLabels = content ? getDiagramTypeLabels(content) : [];
-              const diagramSuffix = formatDiagramTypeSuffix(diagramLabels);
-
-              // Use title if available, otherwise fall back to filename
-              let displayName = docItem?.title;
-              if (displayName) {
-                displayName = `${displayName} (${file})${diagramSuffix}`;
-              } else {
-                displayName = `${file}${diagramSuffix}`;
-              }
-
-              return {
-                name: displayName,
-                value: file,
-              };
-            }),
-          );
-
-          // Let user select multiple files from filtered list
-          selectedFiles = await options.prompts.checkbox({
-            message: getActionText("Select documents with diagrams to {action}:", docAction),
-            source: (term) => {
-              if (!term) return choices;
-
-              return choices.filter((choice) =>
-                choice.name.toLowerCase().includes(term.toLowerCase()),
-              );
-            },
-            validate: (answer) => {
-              if (answer.length === 0) {
-                return "Please select at least one document";
-              }
-              return true;
-            },
-          });
-
-          if (!selectedFiles || selectedFiles.length === 0) {
-            throw new Error("No documents selected");
-          }
-        }
-      } else {
-        // Normal flow: let user select documents from all files
-        // Convert files to choices with titles
-        const choices = mainLanguageFiles.map((file) => {
-          // Convert filename to flat path to find corresponding documentation structure item
-          const flatName = file.replace(/\.md$/, "").replace(/\.\w+(-\w+)?$/, "");
-          const docItem = documentStructure.find((item) => {
-            const itemFlattenedPath = item.path.replace(/^\//, "").replace(/\//g, "-");
-            return itemFlattenedPath === flatName;
-          });
-
-          // Use title if available, otherwise fall back to filename
-          let displayName = docItem?.title;
-          if (displayName) {
-            displayName = `${displayName} (${file})`;
-          } else {
-            displayName = file;
-          }
-
-          return {
-            name: displayName,
-            value: file,
-          };
-        });
-
-        // Let user select multiple files
-        selectedFiles = await options.prompts.checkbox({
-          message: getActionText("Select documents to {action}:", docAction),
-          source: (term) => {
-            if (!term) return choices;
-
-            return choices.filter((choice) =>
-              choice.name.toLowerCase().includes(term.toLowerCase()),
-            );
-          },
-          validate: (answer) => {
-            if (answer.length === 0) {
-              return "Please select at least one document";
-            }
-            return true;
-          },
-        });
-
-        if (!selectedFiles || selectedFiles.length === 0) {
-          throw new Error("No documents selected");
-        }
-      }
-
-      // Process selected files and convert to found items
-      foundItems = await processSelectedFiles(selectedFiles, documentStructure, docsDir);
-    } catch (error) {
-      debug(getActionText(`\nFailed to select documents to {action}: ${error.message}`, docAction));
-      process.exit(0);
-    }
-  } else {
-    // Process the provided docs array
-    for (const docPath of docs) {
-      const foundItem = await findItemByPath(documentStructure, docPath, boardId, docsDir, locale);
-
-      if (!foundItem) {
-        debug(`⚠️  Item with path "${docPath}" not found in documentStructure`);
-        continue;
-      }
-
-      foundItems.push({
-        ...foundItem,
-      });
-    }
-
-    if (foundItems.length === 0) {
-      throw new Error("None of the specified document paths were found in documentStructure");
-    }
-  }
-
-  // Prompt for feedback if not provided
-  // Skip feedback prompt if --diagram, --diagram-all, or --diagram-sync flag is set
-  let userFeedback = feedback;
-  if (
-    !userFeedback &&
-    (requiredFeedback || foundItems?.length > 1) &&
-    !shouldUpdateDiagrams &&
-    !shouldSyncImages &&
-    !rest.isChat
-  ) {
-    const feedbackMessage = getFeedbackMessage(docAction);
-
-    userFeedback = await options.prompts.input({
-      message: feedbackMessage,
-    });
-  }
-
-  // Add feedback to all results if provided
-  foundItems = addFeedbackToItems(foundItems, userFeedback);
-
-  // if reset is true, set content to null for all items
-  if (reset) {
-    foundItems = foundItems.map((item) => ({
-      ...item,
-      content: null,
-    }));
-  }
-
-  return {
-    selectedDocs: foundItems,
-    feedback: userFeedback,
-    selectedPaths: foundItems.map((item) => item.path),
-  };
-}

package/agents/utils/document-icon-generate.yaml

@@ -1,52 +0,0 @@
-name: documentIconGenerate
-description: Generate appropriate Iconify icon names for document structure root nodes based on their title and description
-model:
-  reasoning_effort: low
-task_render_mode: hide
-instructions:
-  url: ../../prompts/common/document-structure/document-icon-generate.md
-input_schema:
-  type: object
-  properties:
-    documentList:
-      type: array
-      items:
-        type: object
-        properties:
-          path:
-            type: string
-            description: Document path for mapping purposes
-          title:
-            type: string
-            description: Document title to analyze for icon selection
-          description:
-            type: string
-            description: Document description to analyze for icon selection
-        required:
-          - path
-          - title
-          - description
-      description: List of root-level document items (parentId is null) that need icons generated
-  required:
-    - documentList
-output_schema:
-  type: object
-  properties:
-    documentList:
-      type: array
-      items:
-        type: object
-        properties:
-          path:
-            type: string
-            description: Document path (same as input for mapping)
-          icon:
-            type: string
-            description: Iconify icon name in the format collection:icon-name (e.g., lucide:book)
-        required:
-          - path
-          - icon
-      description: List of document items with generated Iconify icon names
-  required:
-    - documentList
-

package/agents/utils/document-title-streamline.yaml

@@ -1,48 +0,0 @@
-name: documentTitleStreamline
-description: Streamline document titles by shortening them while preserving meaning for better sidebar navigation
-model:
-  reasoning_effort: low
-task_render_mode: hide
-instructions:
-  url: ../../prompts/common/document-structure/document-title-streamline.md
-input_schema:
-  type: object
-  properties:
-    documentList:
-      type: array
-      items:
-        type: object
-        properties:
-          path:
-            type: string
-            description: Document path for mapping purposes
-          title:
-            type: string
-            description: Document title to streamline
-        required:
-          - path
-          - title
-      description: List of document items with titles to streamline
-  required:
-    - documentList
-output_schema:
-  type: object
-  properties:
-    documentList:
-      type: array
-      items:
-        type: object
-        properties:
-          path:
-            type: string
-            description: Document path (same as input for mapping)
-          title:
-            type: string
-            description: Streamlined document title (max 24 characters for English, 12 characters for character-based languages)
-        required:
-          - path
-          - title
-      description: List of streamlined document items with shortened titles
-  required:
-    - documentList
-