@aigne/doc-smith 0.9.10 → 0.9.11-beta

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,251 +0,0 @@
-import chalk from "chalk";
-import {
-  addFeedbackToItems,
-  findItemByPath,
-  getActionText,
-  getMainLanguageFiles,
-  processSelectedFiles,
-  readFileContent,
-} from "../../utils/docs-finder-utils.mjs";
-import {
-  hasDiagramContent,
-  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,
-  },
-  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 flag is set, filter documents by diagram content
-      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 or --diagram-all flag is set
-  let userFeedback = feedback;
-  if (!userFeedback && (requiredFeedback || foundItems?.length > 1) && !shouldUpdateDiagrams) {
-    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
-

package/agents/utils/ensure-document-icons.mjs

@@ -1,129 +0,0 @@
-import { promises as fs } from "node:fs";
-import { join } from "node:path";
-import { loadConfigFromFile, processConfigFields } from "../../utils/utils.mjs";
-
-/**
- * Ensure all root-level document entries have icons
- * Batch processing: Collects all entries without icons and generates them in a single call
- * Conditionally saves the updated structure if icons were generated
- * This is a reusable agent that can be used in structure planning and before publishing
- */
-export default async function ensureDocumentIcons(inputOrParams, options) {
-  // Handle multiple calling patterns:
-  // 1. As function skill: (input, options) where input.documentStructure exists
-  // 2. As function skill: (input, options) where input.originalDocumentStructure exists
-  // 3. As standalone function: ({ documentStructure }, options)
-  const documentStructure =
-    inputOrParams?.documentStructure ||
-    inputOrParams?.originalDocumentStructure ||
-    (Array.isArray(inputOrParams) ? inputOrParams : null);
-
-  if (!documentStructure || !Array.isArray(documentStructure)) {
-    // Return input unchanged if no documentStructure to process
-    return inputOrParams || {};
-  }
-
-  // Batch collect all root-level items that need icon generation
-  // Only process root-level items (parentId is null, undefined, or empty string)
-  // Only generate icons for items that don't have one
-  const itemsNeedingIcon = documentStructure.filter((item) => {
-    // Only process root-level items
-    const isRootLevel = !item.parentId || item.parentId === "null" || item.parentId === "";
-    if (!isRootLevel) return false;
-
-    // Must have title and description for icon generation
-    if (!item.title || !item.description) return false;
-
-    // Only generate if icon is missing
-    const hasNoIcon = !item.icon || !item.icon.trim();
-    return hasNoIcon;
-  });
-
-  // If all items already have icons, skip
-  if (itemsNeedingIcon.length === 0) {
-    return inputOrParams || {};
-  }
-
-  // Prepare batch list for icon generation
-  const documentList = itemsNeedingIcon.map((item) => ({
-    path: item.path,
-    title: item.title,
-    description: item.description,
-  }));
-
-  const iconAgent = options?.context?.agents?.["documentIconGenerate"];
-  if (!iconAgent) {
-    console.warn("⚠️  documentIconGenerate agent not found. Skipping icon generation.");
-    return inputOrParams || {};
-  }
-
-  let iconsGenerated = false;
-
-  try {
-    // Batch generate all missing icons in a single call
-    const iconResult = await options.context.invoke(iconAgent, {
-      documentList,
-    });
-
-    // Batch update all document items with generated icons using path as the key
-    if (iconResult.documentList && Array.isArray(iconResult.documentList)) {
-      const iconMap = new Map(iconResult.documentList.map((item) => [item.path, item.icon]));
-
-      for (const item of documentStructure) {
-        const generatedIcon = iconMap.get(item.path);
-        if (generatedIcon) {
-          item.icon = generatedIcon;
-          iconsGenerated = true;
-        }
-      }
-    }
-
-    // Conditionally save the updated structure if icons were generated
-    // Use the same save pattern as save-output.mjs for consistency
-    if (iconsGenerated) {
-      // Try to get outputDir from multiple sources (same as create flow)
-      let outputDir =
-        inputOrParams?.outputDir ||
-        options?.context?.userContext?.outputDir ||
-        options?.context?.config?.outputDir;
-
-      // If still not found, load from config file and process defaults
-      if (!outputDir) {
-        try {
-          const config = await loadConfigFromFile();
-          const processedConfig = await processConfigFields(config || {});
-          outputDir = processedConfig?.outputDir;
-        } catch {
-          // Ignore config load errors
-        }
-      }
-
-      if (outputDir) {
-        try {
-          // Use the same save pattern as save-output.mjs
-          const savePath = outputDir;
-          const fileName = "structure-plan.json";
-          const content = JSON.stringify(documentStructure, null, 2);
-
-          await fs.mkdir(savePath, { recursive: true });
-          const filePath = join(savePath, fileName);
-          await fs.writeFile(filePath, content, "utf8");
-        } catch (saveError) {
-          console.warn("⚠️  Failed to save updated structure:", saveError.message);
-          // Continue even if save fails
-        }
-      }
-    }
-  } catch (error) {
-    console.warn("⚠️  Failed to generate document icons:", error.message);
-    console.warn("Continuing without icons.");
-  }
-
-  // Return input unchanged (documentStructure is modified in place)
-  return inputOrParams || {};
-}
-
-ensureDocumentIcons.taskTitle = "Ensure document icons";
-ensureDocumentIcons.description =
-  "Check each root-level document entry for icons - if missing, generate one; if present, skip";
-ensureDocumentIcons.task_render_mode = "hide";

package/agents/utils/exit.mjs

@@ -1,6 +0,0 @@
-export default async function exit() {
-  process.exit(0);
-}
-
-exit.description =
-  "Exit the chat session. Equivalent to saying goodbye, quit, exit, close, or see you. Must print a bye message before calling this tool, as it will exit the process immediately.";

package/agents/utils/feedback-refiner.yaml

@@ -1,50 +0,0 @@
-name: feedbackRefiner
-description: Learn from your feedback to improve future documentation
-instructions:
-  url: ../../prompts/utils/feedback-refiner.md
-
-input_schema:
-  type: object
-  properties:
-    feedback:
-      type: string
-      description: Tell us what you think about the documentation
-    stage:
-      type: string
-      description: Which part of the process this feedback is about (document_structure, document_refine, translation_refine)
-    paths:
-      type: array
-      items:
-        type: string
-      description: Specific documents this feedback applies to (optional)
-    existingPreferences:
-      type: string
-      description: Your existing preferences to avoid duplicates (optional)
-  required: 
-    - feedback
-    - stage
-
-output_schema:
-  type: object
-  properties:
-    rule:
-      type: string
-      description: General rule created from your feedback
-    scope:
-      type: string
-      description: Where this rule applies (global, structure, document, translation)
-    save:
-      type: boolean
-      description: Should we remember this preference for next time?
-    limitToInputPaths:
-      type: boolean
-      description: Apply only to the specific documents mentioned?
-    reason:
-      type: string
-      description: Why we made this decision and how the rule was created
-  required:
-    - rule
-    - scope
-    - save
-    - limitToInputPaths
-    - reason