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

package/agents/update/update-single/update-single-document-detail.mjs

@@ -1,280 +0,0 @@
-import { AIAgent } from "@aigne/core";
-import { pick } from "@aigne/core/utils/type-utils.js";
-import z from "zod";
-import {
-  DIAGRAM_PLACEHOLDER,
-  replaceD2WithPlaceholder,
-  replaceDiagramsWithPlaceholder,
-} from "../../../utils/d2-utils.mjs";
-import { userContextAt } from "../../../utils/utils.mjs";
-
-async function getIntentType(input, options) {
-  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>`;
-  const analyzeUpdateFeedbackIntentAgent = AIAgent.from({
-    name: "analyzeUpdateFeedbackIntent",
-    description:
-      "Analyze user feedback to determine if document are needed for content modifications",
-    task_render_mode: "hide",
-    instructions,
-    // TODO: can't set reasoningEffort
-    // modelOptions: {
-    //   reasoningEffort: 1,
-    // },
-    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: input.feedback,
-  });
-  return intentType;
-}
-
-async function saveDoc(input, options, { content, intentType }) {
-  const saveAgent = options.context?.agents?.["saveDoc"];
-  await options.context.invoke(saveAgent, {
-    ...pick(input, ["path", "docsDir", "labels", "locale"]),
-    content,
-    intentType, // Pass intentType so saveDoc can handle translation sync
-  });
-}
-
-async function addDiagram(input, options) {
-  const contentContext = userContextAt(options, `currentContents.${input.path}`);
-  const currentContent = contentContext.get();
-  const generateDiagramAgent = options.context.agents["checkGenerateDiagram"];
-  const generateDiagramResult = await options.context.invoke(generateDiagramAgent, {
-    ...pick(input, ["locale", "path", "docsDir", "diagramming", "feedback"]),
-    documentContent: currentContent,
-    originalContent: currentContent,
-  });
-  const content = generateDiagramResult.content;
-  contentContext.set(content);
-  // Pass intentType to saveDoc so it can handle translation sync automatically
-  await saveDoc(input, options, { content, intentType: "addDiagram" });
-  return { content };
-}
-
-async function updateDiagram(input, options) {
-  const contentContext = userContextAt(options, `currentContents.${input.path}`);
-  const currentContent = contentContext.get();
-  let [content] = replaceD2WithPlaceholder({
-    content: currentContent,
-  });
-  const generateAgent = options.context?.agents?.["generateDiagram"];
-  const result = await options.context.invoke(generateAgent, {
-    documentContent: content,
-    locale: input.locale,
-    diagramming: input.diagramming || {},
-    feedback: input.feedback,
-    originalContent: currentContent, // Pass original content to find existing diagrams
-    path: input.path,
-    docsDir: input.docsDir,
-  });
-
-  // generateDiagram now returns { content } with image already inserted
-  // The image replaces DIAGRAM_PLACEHOLDER or D2 code blocks
-  if (result?.content) {
-    content = result.content;
-  }
-
-  contentContext.set(content);
-  // Pass intentType to saveDoc so it can handle translation sync automatically
-  await saveDoc(input, options, { content, intentType: "updateDiagram" });
-  return { content };
-}
-
-async function deleteDiagram(input, options) {
-  const contentContext = userContextAt(options, `currentContents.${input.path}`);
-  const currentContent = contentContext.get();
-
-  // Extract diagram index from feedback if provided
-  // This allows deleting a specific diagram when multiple diagrams exist
-  let diagramIndex = input.diagramIndex;
-  if (diagramIndex === undefined && input.feedback) {
-    // Import extractDiagramIndexFromFeedback from replace-d2-with-image.mjs
-    const { extractDiagramIndexFromFeedback } = await import(
-      "../../create/replace-d2-with-image.mjs"
-    );
-    const extractedIndex = extractDiagramIndexFromFeedback(input.feedback);
-    if (extractedIndex !== null) {
-      diagramIndex = extractedIndex;
-    }
-  }
-
-  // Replace all diagrams (D2 code blocks, generated images, Mermaid) with placeholder
-  // If diagramIndex is provided, only replace that specific diagram
-  // This ensures LLM can identify and remove the diagram regardless of its type
-  const documentContent = replaceDiagramsWithPlaceholder({
-    content: currentContent,
-    diagramIndex,
-  });
-  const instructions = `<role>
-Your task is to remove ${DIAGRAM_PLACEHOLDER} and adjust the document context (based on the user's feedback) to make it easier to understand.
-</role>
-
-<document_content>
-{{documentContent}}
-</document_content>
-
-<user_feedback>
-{{feedback}}
-</user_feedback>
-
-<output_constraints>
-- Do not provide any explanations; include only the document content itself
-</output_constraints>`;
-  const deleteAgent = AIAgent.from({
-    name: "deleteDiagram",
-    description: "Remove a diagram from the document content",
-    task_render_mode: "hide",
-    instructions,
-    inputSchema: z.object({
-      documentContent: z.string().describe("Source content of the document"),
-      feedback: z.string().describe("User feedback for content modifications"),
-    }),
-    outputKey: "message",
-  });
-  const { message: content } = await options.context.invoke(deleteAgent, {
-    documentContent,
-    feedback: input.feedback,
-  });
-
-  // Delete associated diagram image files
-  if (input.docsDir) {
-    try {
-      const { deleteDiagramImages } = await import("../../../utils/delete-diagram-images.mjs");
-      const { deleted } = await deleteDiagramImages(currentContent, input.path, input.docsDir);
-      if (deleted > 0) {
-        console.log(`Deleted ${deleted} diagram image file(s) for ${input.path}`);
-      }
-    } catch (error) {
-      // Don't fail the operation if image deletion fails
-      console.warn(`Failed to delete diagram images: ${error.message}`);
-    }
-  }
-
-  contentContext.set(content);
-  // Pass intentType to saveDoc so it can handle translation sync automatically
-  await saveDoc(input, options, { content, intentType: "deleteDiagram" });
-
-  return { content };
-}
-
-async function updateDocument(input, options) {
-  const contentContext = userContextAt(options, `currentContents.${input.path}`);
-  const currentContent = contentContext.get();
-  const updateAgent = options.context.agents["updateDocumentDetail"];
-  const updateResult = await options.context.invoke(updateAgent, {
-    ...input,
-    originalContent: currentContent,
-  });
-  if (updateResult.message === "success") {
-    const updatedContent = contentContext.get();
-
-    contentContext.set(updatedContent);
-    await saveDoc(input, options, { content: updatedContent });
-  }
-  return {
-    content: contentContext.get(),
-  };
-}
-
-export default async function updateSingleDocumentDetail(input, options) {
-  // Use intentType from input if available (analyzed in parent flow),
-  // otherwise fall back to analyzing it here (for backward compatibility)
-  let intentType = input.intentType;
-  if (!intentType && input.feedback) {
-    intentType = await getIntentType(input, options);
-  }
-
-  // If intentType is still null or undefined, default to updateDocument
-  // This ensures that some operation is always performed, even if intent analysis failed
-  // or no explicit intent was provided
-  if (!intentType) {
-    intentType = "updateDocument";
-  }
-
-  const fnMap = {
-    addDiagram,
-    updateDiagram,
-    deleteDiagram,
-    updateDocument,
-  };
-
-  if (fnMap[intentType]) {
-    const result = await fnMap[intentType](input, options);
-    return result;
-  }
-
-  // Fallback: if intentType is not in fnMap, default to updateDocument
-  console.warn(`Unknown intentType: ${intentType}, defaulting to updateDocument`);
-  return await updateDocument(input, options);
-}

package/agents/update/update-single-document.yaml

@@ -1,7 +0,0 @@
-type: team
-name: updateSingleDocument
-skills:
-  - ../utils/transform-detail-data-sources.mjs
-  - ../update/user-review-document.mjs
-iterate_on: selectedDocs
-concurrency: 1

package/agents/update/user-review-document.mjs

@@ -1,272 +0,0 @@
-import { marked } from "marked";
-import markedTerminal from "marked-terminal";
-import { getActiveRulesForScope } from "../../utils/preferences-utils.mjs";
-import { userContextAt } from "../../utils/utils.mjs";
-
-function extractMarkdownHeadings(content) {
-  if (!content || typeof content !== "string") {
-    return [];
-  }
-
-  const headings = [];
-
-  try {
-    // Use marked's lexer to tokenize the content
-    const tokens = marked.lexer(content);
-
-    // Extract heading tokens
-    function processTokens(tokenArray) {
-      for (const token of tokenArray) {
-        if (token.type === "heading") {
-          headings.push({
-            level: token.depth,
-            text: token.text.trim(),
-            prefix: "  ".repeat(token.depth - 1) + "📄".repeat(1),
-          });
-        }
-        // Process nested tokens if they exist (for lists, block quotes, etc.)
-        if (token.tokens) {
-          processTokens(token.tokens);
-        }
-      }
-    }
-
-    processTokens(tokens);
-  } catch (error) {
-    // If marked fails, fall back to regex but log the issue
-    console.warn(
-      "Failed to parse markdown with marked library, falling back to regex:",
-      error.message,
-    );
-    return extractMarkdownHeadingsFallback(content);
-  }
-
-  return headings;
-}
-
-// Fallback function using the original regex approach
-function extractMarkdownHeadingsFallback(content) {
-  const lines = content.split("\n");
-  const headings = [];
-
-  for (const line of lines) {
-    const match = line.match(/^(#{1,6})\s+(.+)$/);
-    if (match) {
-      const level = match[1].length;
-      const text = match[2].trim();
-      headings.push({
-        level,
-        text,
-        prefix: "  ".repeat(level - 1) + "📄".repeat(1),
-      });
-    }
-  }
-
-  return headings;
-}
-
-function printDocumentHeadings(content, title) {
-  console.log(`\n  ${"-".repeat(50)}`);
-  console.log(`  Current Document: ${title}`);
-  console.log(`  ${"-".repeat(50)}`);
-
-  const headings = extractMarkdownHeadings(content);
-
-  if (headings.length === 0) {
-    console.log("  This document has no headings.");
-  } else {
-    headings.forEach((heading) => {
-      console.log(`${heading.prefix} ${heading.text} (H${heading.level})`);
-    });
-  }
-  console.log();
-}
-
-async function showDocumentDetail(content, title) {
-  if (!content || typeof content !== "string" || content.trim().length === 0) {
-    console.log("There's no content to display.");
-    return;
-  }
-
-  try {
-    // Temporarily suppress console.error to hide language warnings
-    const originalError = console.error;
-    console.error = (message) => {
-      // Only suppress cli-highlight language warnings
-      if (
-        typeof message === "string" &&
-        message.toLowerCase().includes("Could not find the language")
-      ) {
-        return;
-      }
-      originalError(message);
-    };
-
-    marked.setOptions({
-      renderer: new markedTerminal(),
-    });
-
-    // FIXME: @zhanghan fix error "Could not find the language 'd2', did you forget to load/include a language module?"
-    const renderedMarkdown = marked(content);
-
-    // Restore original console.error
-    console.error = originalError;
-
-    console.log(`\nDocument: ${title || "Untitled Document"}`);
-    console.log("=".repeat(50));
-    console.log(renderedMarkdown);
-  } catch (_error) {
-    console.log("\nFalling back to plain text display (marked-terminal not available):\n");
-    console.log(`Document: ${title || "Untitled Document"}`);
-    console.log("=".repeat(50));
-    console.log(content);
-  }
-}
-
-export default async function userReviewDocument({ content, description, ...rest }, options) {
-  // Check if document content exists
-  if (!content || typeof content !== "string" || content.trim().length === 0) {
-    console.log("Please provide document content to review.");
-    return { content };
-  }
-
-  const title = rest.documentStructure?.find((x) => x.path === rest.path)?.title;
-
-  // Print current document headings structure
-  if (!rest.isChat) {
-    printDocumentHeadings(content, title || "Untitled Document");
-  }
-
-  // Initialize shared context with current content using path
-  const contentContext = userContextAt(options, `currentContents.${rest.path}`);
-  contentContext.set(content);
-
-  const MAX_ITERATIONS = 100;
-  const feedbacks = [];
-  let iterationCount = 0;
-
-  let feedback = "";
-
-  while (iterationCount < MAX_ITERATIONS) {
-    feedback = "";
-    iterationCount++;
-
-    if (rest.isChat && rest.feedback) {
-      feedback = rest.feedback;
-    } else {
-      // Ask user what they want to do
-      const action = await options.prompts.select({
-        message: "What would you like to do next?",
-        choices: [
-          {
-            name: "View document",
-            value: "view",
-          },
-          {
-            name: "Give feedback",
-            value: "feedback",
-          },
-          {
-            name: "Done",
-            value: "finish",
-          },
-        ],
-      });
-
-      if (action === "finish") {
-        break;
-      } else if (action === "view") {
-        await showDocumentDetail(contentContext.get(), title || "Untitled Document");
-      }
-
-      // Ask for feedback
-      feedback = await options.prompts.input({
-        message:
-          "How would you like to improve this document?\n" +
-          "Examples:\n" +
-          "  • Add troubleshooting section for common errors\n" +
-          "  • Simplify the explanation for beginners\n" +
-          "  • Remove the outdated information about version 1.0\n\n" +
-          "  Your feedback:",
-      });
-
-      // If no feedback, finish the loop
-      if (!feedback?.trim()) {
-        break;
-      }
-
-      feedbacks.push(feedback.trim());
-    }
-
-    // Get the updateDocument agent
-    const updateAgent = options.context.agents["updateSingleDocumentDetail"];
-    if (!updateAgent) {
-      console.log(
-        "We can't process your feedback right now. The document update feature is temporarily unavailable.",
-      );
-      console.log("Please try again later or contact support if this continues.");
-      break;
-    }
-
-    // Get user preferences
-    const contentRules = getActiveRulesForScope("document", [rest.path]);
-    const globalRules = getActiveRulesForScope("global");
-    const allApplicableRules = [...contentRules, ...globalRules];
-    const ruleTexts = allApplicableRules.map((rule) => rule.rule);
-    const userPreferences = ruleTexts.length > 0 ? ruleTexts.join("\n\n") : "";
-
-    try {
-      // Call updateDocument agent with feedback
-      const currentContent = contentContext.get();
-      const result = await options.context.invoke(updateAgent, {
-        ...rest,
-        originalContent: currentContent,
-        feedback: feedback.trim(),
-        userPreferences,
-        title,
-      });
-      contentContext.set(result.content);
-
-      // Check if feedback should be saved as user preference
-      const feedbackRefinerAgent = options.context.agents["checkFeedbackRefiner"];
-      if (feedbackRefinerAgent) {
-        try {
-          await options.context.invoke(feedbackRefinerAgent, {
-            documentContentFeedback: feedback.trim(),
-            stage: "document_refine",
-          });
-        } catch (refinerError) {
-          console.warn("We couldn't save your feedback as a preference:", refinerError.message);
-          console.warn("Your feedback was applied, but we couldn't save it as a preference.");
-        }
-      }
-
-      // Print updated document headings structure
-      printDocumentHeadings(contentContext.get(), title || "Untitled Document");
-
-      if (rest.isChat) {
-        break;
-      }
-    } catch (error) {
-      console.error("Error processing your feedback:");
-      console.error(`Type: ${error.name}`);
-      console.error(`Message: ${error.message}`);
-      if (error.stack) {
-        console.error(`Stack: ${error.stack}`);
-      }
-      console.log("\nPlease try rephrasing your feedback or continue with the current content.");
-
-      process.exit(0);
-    }
-  }
-
-  return {
-    title,
-    description,
-    ...rest,
-    content: contentContext.get(),
-    feedback: feedbacks.join(". "),
-  };
-}
-
-userReviewDocument.taskTitle = "User review and modify document content";

package/agents/utils/action-success.mjs

@@ -1,16 +0,0 @@
-import { shutdownMermaidWorkerPool } from "../../utils/mermaid-worker-pool.mjs";
-
-export default async function actionSuccess({ action }) {
-  // Shutdown mermaid worker pool to ensure clean exit
-  try {
-    await shutdownMermaidWorkerPool();
-  } catch (error) {
-    console.warn("Failed to shutdown mermaid worker pool:", error.message);
-  }
-
-  return {
-    message: `${action}`,
-  };
-}
-
-actionSuccess.task_render_mode = "hide";

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

@@ -1,32 +0,0 @@
-name: analyzeDocumentFeedbackIntent
-description: Analyze user feedback to determine if data sources are needed for content modifications
-task_render_mode: hide
-instructions:
-  url: ../../prompts/utils/analyze-document-feedback-intent.md
-input_schema:
-  type: object
-  properties:
-    feedback:
-      type: string
-      description: User feedback for content 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
-    error: 
-      type: boolean
-      description: If an error occurs during the analysis process
-  required:
-    - needDataSources
-    - intentType
-    - reason