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

package/agents/create/user-add-document/add-documents-to-structure.mjs

@@ -1,90 +0,0 @@
-import { getActiveRulesForScope } from "../../../utils/preferences-utils.mjs";
-import { printDocumentStructure } from "../../../utils/docs-finder-utils.mjs";
-
-export default async function addDocumentsToStructure(input = {}, options = {}) {
-  const { originalDocumentStructure = [] } = input;
-  const analyzeIntent = options.context?.agents?.["analyzeStructureFeedbackIntent"];
-  const updateDocumentStructure = options.context?.agents?.["updateDocumentStructure"];
-  const allFeedback = [];
-  let currentStructure = [...originalDocumentStructure];
-  let isFirstAdd = true;
-
-  printDocumentStructure(originalDocumentStructure);
-
-  // update website structure
-  if (!options.context.userContext) {
-    options.context.userContext = {};
-  }
-
-  // Add document
-  while (true) {
-    let feedback = await options.prompts.input({
-      message: isFirstAdd
-        ? "You can add a new document.\n" +
-          "  • e.g. Add a new document 'Troubleshooting'\n\n" +
-          "Press Enter to finish:"
-        : "You can continue adding documents, or press Enter to finish:",
-    });
-
-    feedback = feedback.trim();
-
-    // end the loop
-    if (!feedback) {
-      break;
-    }
-
-    try {
-      // validate feedback
-      const { intentType } = await options.context.invoke(analyzeIntent, {
-        feedback,
-      });
-
-      if (intentType !== "add") {
-        console.log(`⚠️  You can only add documents at this stage.`);
-        continue;
-      }
-      options.context.userContext.currentStructure = currentStructure;
-
-      const structureRules = getActiveRulesForScope("structure", []);
-      const globalRules = getActiveRulesForScope("global", []);
-      const allApplicableRules = [...structureRules, ...globalRules];
-      const userPreferences = allApplicableRules.map((rule) => rule.rule).join("\n\n");
-
-      await options.context.invoke(updateDocumentStructure, {
-        ...input,
-        dataSourceChunk: input.dataSources[0].dataSourceChunk,
-        feedback,
-        documentStructure: currentStructure,
-        needDataSources: true,
-        userPreferences,
-      });
-
-      allFeedback.push(feedback);
-
-      currentStructure = options.context.userContext.currentStructure;
-      printDocumentStructure(currentStructure);
-      isFirstAdd = false;
-    } catch (error) {
-      console.error("Error processing feedback:", {
-        type: error.name,
-        message: error.message,
-      });
-      process.exit(0);
-    }
-  }
-
-  if (currentStructure.length > originalDocumentStructure.length) {
-    const originalPaths = new Set(originalDocumentStructure.map((doc) => doc.path));
-    const newDocuments = currentStructure.filter((doc) => !originalPaths.has(doc.path));
-
-    return {
-      originalDocumentStructure: currentStructure,
-      documentStructure: JSON.parse(JSON.stringify(currentStructure)),
-      newDocuments,
-      allFeedback,
-    };
-  } else {
-    console.log("No documents were added");
-    process.exit(0);
-  }
-}

package/agents/create/user-add-document/find-documents-to-add-links.yaml

@@ -1,47 +0,0 @@
-name: findDocumentsToAddLinks
-description: Use AI to analyze document structure and determine which documents should reference newly added documents
-task_render_mode: hide
-instructions:
-  - role: system
-    url: ../../../prompts/structure/find-documents-to-add-links.md
-input_schema:
-  type: object
-  properties:
-    originalDocumentStructure:
-      type: array
-      description: Original document structure before adding documents
-    documentStructure:
-      type: array
-      description: Updated document structure after adding documents
-    newDocuments:
-      type: array
-      description: Array of newly added documents
-  required:
-    - originalDocumentStructure
-    - documentStructure
-    - newDocuments
-output_schema:
-  type: object
-  properties:
-    documentsWithNewLinks:
-      type: array
-      description: Array of existing documents that should add links to new documents
-      items:
-        type: object
-        properties:
-          path:
-            type: string
-            description: The path of the existing document that should be updated
-          newLinks:
-            type: array
-            description: Array of new document paths that should be added as links to this document
-            items:
-              type: string
-        required:
-          - path
-          - newLinks
-  required:
-    - documentsWithNewLinks
-
-
-

package/agents/create/user-add-document/index.yaml

@@ -1,46 +0,0 @@
-type: team
-name: userAddDocument
-description: Add documents to the documentation structure
-skills:
-  - url: ../../init/index.mjs
-    default_input:
-      skipIfExists: true
-  - ../../utils/load-sources.mjs
-  - ./add-documents-to-structure.mjs
-  - url: ../../utils/save-output.mjs
-    default_input:
-      saveKey: documentStructure
-      savePath:
-        $get: outputDir
-      fileName: structure-plan.json
-  - ../../utils/save-sidebar.mjs
-  - ../../utils/ensure-document-icons.mjs
-  - ../../utils/format-document-structure.mjs
-  - ../../media/load-media-description.mjs
-  - type: team
-    skills:
-      - ../../update/check-document.mjs
-    iterate_on: newDocuments
-    concurrency: 5
-  - ./find-documents-to-add-links.yaml
-  - ./review-documents-with-new-links.mjs
-  - type: team
-    name: batchAddNewLinks
-    description: Batch add new links to documents
-    skills:
-      - ../utils/init-current-content.mjs
-      - ../../utils/transform-detail-data-sources.mjs
-      - ../../update/update-single/update-single-document-detail.mjs
-    iterate_on: documentsToUpdate
-    concurrency: 5
-  - ./prepare-documents-to-translate.mjs
-  - type: team
-    name: batchTranslateDocuments
-    description: Batch translate documents to multiple languages
-    skills:
-      - ../../localize/translate-multilingual.yaml
-    iterate_on: documentsToTranslate
-    concurrency: 5
-  - ../../utils/post-generate.mjs
-  - ./print-add-document-summary.mjs
-mode: sequential

package/agents/create/user-add-document/prepare-documents-to-translate.mjs

@@ -1,22 +0,0 @@
-export default async function prepareDocumentsToTranslate(input, options) {
-  const { documentsWithNewLinks = [] } = input;
-  const documentsToTranslate = [];
-
-  documentsWithNewLinks.forEach((doc) => {
-    const content = options.context.userContext.currentContents[doc.path];
-
-    if (content) {
-      documentsToTranslate.push({
-        ...doc,
-        content,
-      });
-    } else {
-      console.warn(`⚠️  Could not find content from userContext at path: ${doc.path}`);
-    }
-  });
-
-  return {
-    documentsToUpdate: [], // clear, reduce token consumption
-    documentsToTranslate,
-  };
-}

package/agents/create/user-add-document/print-add-document-summary.mjs

@@ -1,63 +0,0 @@
-import chalk from "chalk";
-
-import { recordUpdate } from "../../../utils/history-utils.mjs";
-/**
- * Print summary of added documents and documents with new links
- */
-export default async function printAddDocumentSummary({
-  newDocuments = [],
-  documentsWithNewLinks = [],
-  allFeedback = [],
-}) {
-  let message = `\n---\n`;
-  message += `${chalk.bold.cyan("📊 Summary")}\n\n`;
-
-  // Record the update
-  if (allFeedback.length > 0) {
-    recordUpdate({
-      operation: "structure_update",
-      feedback: allFeedback.join("\n"),
-    });
-  }
-
-  // Display added documents
-  if (newDocuments && newDocuments.length > 0) {
-    message += `✨ Added Documents:\n`;
-    message += `   Total: ${newDocuments.length} document(s)\n\n`;
-    newDocuments.forEach((doc, index) => {
-      message += `   ${chalk.cyan(`${index + 1}. ${doc.path}`)}`;
-      if (doc.title && doc.title !== doc.path) {
-        message += ` - ${chalk.yellow(doc.title)}`;
-      }
-      message += `\n\n`;
-    });
-  } else {
-    message += `✨ Added Documents:\n`;
-    message += `${chalk.gray("   No documents were added.\n\n")}`;
-  }
-
-  // Display documents with new links
-  if (documentsWithNewLinks && documentsWithNewLinks.length > 0) {
-    message += `✅ Documents updated (Added new links):\n`;
-    message += `   Total: ${documentsWithNewLinks.length} document(s)\n\n`;
-    documentsWithNewLinks.forEach((doc, index) => {
-      message += `   ${chalk.cyan(`${index + 1}. ${doc.path}`)}`;
-      if (doc.title && doc.title !== doc.path) {
-        message += ` - ${chalk.yellow(doc.title)}`;
-      }
-      message += `\n`;
-      if (doc.newLinks && doc.newLinks.length > 0) {
-        message += `      New links added: ${chalk.gray(doc.newLinks.join(", "))}\n`;
-      }
-      message += `\n`;
-    });
-  } else {
-    message += `✅ Documents updated (Added new links):\n`;
-    message += `${chalk.gray("   No documents needed to be updated.\n\n")}`;
-  }
-
-  return { message };
-}
-
-printAddDocumentSummary.taskTitle = "Print add document summary";
-printAddDocumentSummary.description = "Display summary of added documents";

package/agents/create/user-add-document/review-documents-with-new-links.mjs

@@ -1,110 +0,0 @@
-import { join } from "node:path";
-import chalk from "chalk";
-import pLimit from "p-limit";
-import { generateFileName, pathToFlatName } from "../../../utils/docs-finder-utils.mjs";
-import { pathExists } from "../../../utils/file-utils.mjs";
-
-/**
- * Review documentsWithNewLinks and let user select which documents should be updated
- */
-export default async function reviewDocumentsWithNewLinks(
-  { documentsWithNewLinks = [], documentStructure = [], locale = "en", docsDir },
-  options,
-) {
-  // If no documents to review, return empty array
-  if (!documentsWithNewLinks || documentsWithNewLinks.length === 0) {
-    return { documentsWithNewLinks: [], documentsToUpdate: [] };
-  }
-
-  // Build choices with file existence check
-  const limit = pLimit(50);
-  const choices = await Promise.all(
-    documentsWithNewLinks.map((document, index) =>
-      limit(async () => {
-        // Find corresponding document in documentStructure to get title
-        const structureDoc = documentStructure.find((item) => item.path === document.path);
-        const title = structureDoc?.title || document.path;
-
-        // Generate filename from document path
-        const flatName = pathToFlatName(document.path);
-        const filename = generateFileName(flatName, locale);
-
-        // Check file existence if docsDir is provided
-        let fileExists = true;
-        let missingFileText = "";
-        if (docsDir) {
-          const filePath = join(docsDir, filename);
-          fileExists = await pathExists(filePath);
-          if (!fileExists) {
-            missingFileText = chalk.red(" - file not found");
-          }
-        }
-
-        return {
-          name: `${title} (${filename})${missingFileText}`,
-          value: index,
-          checked: fileExists, // Only check if file exists
-          disabled: !fileExists, // Disable if file doesn't exist
-          description: `New Links: ${document.newLinks.join(", ")}`,
-        };
-      }),
-    ),
-  );
-
-  // Let user select which documents to update (default: all selected)
-  const selectedDocs = await options.prompts.checkbox({
-    message:
-      "Select documents that need new links added (all selected by default, press Enter to confirm, or unselect all to skip):",
-    choices,
-  });
-
-  // Filter documentsWithNewLinks based on user selection
-  const filteredDocs = selectedDocs.map((index) => documentsWithNewLinks[index]).filter(Boolean);
-
-  if (filteredDocs.length === 0) {
-    console.log(`\n⚠️  No documents selected. Skipping link updates.\n`);
-  } else {
-    console.log(
-      `\n✅ Selected ${filteredDocs.length} out of ${documentsWithNewLinks.length} documents to update.\n`,
-    );
-  }
-
-  // save original documentsWithNewLinks to user context
-  options.context.userContext.originalDocumentsWithNewLinks = filteredDocs;
-
-  if (filteredDocs.length === 0) {
-    return {
-      documentsWithNewLinks: [],
-      documentsToUpdate: [],
-    };
-  }
-
-  // Prepare documents: add necessary fields for update (e.g. feedback)
-  const preparedDocs = [];
-
-  for (const doc of filteredDocs) {
-    if (!doc.path) continue;
-
-    // Find corresponding document in documentStructure to get additional fields
-    const structureDoc = documentStructure.find((item) => item.path === doc.path);
-
-    // Generate feedback message for adding new links
-    const newLinksList = doc.newLinks.join(", ");
-    const feedback = `Add the following links to this document: ${newLinksList}. Identify suitable places within the existing content — such as relevant sections, navigation items — and insert the links naturally to maintain context and readability.`;
-
-    preparedDocs.push({
-      ...structureDoc,
-      feedback,
-      newLinks: doc.newLinks,
-    });
-  }
-
-  return {
-    documentsWithNewLinks: preparedDocs, // for print summary
-    documentsToUpdate: JSON.parse(JSON.stringify(preparedDocs)), // for batch update
-  };
-}
-
-reviewDocumentsWithNewLinks.taskTitle = "Review documents to update";
-reviewDocumentsWithNewLinks.description =
-  "Let the user review and select which documents should be updated with new links";

package/agents/create/user-remove-document/find-documents-with-invalid-links.mjs

@@ -1,78 +0,0 @@
-import { join } from "node:path";
-import {
-  buildAllowedLinksFromStructure,
-  generateFileName,
-  pathToFlatName,
-  readFileContent,
-} from "../../../utils/docs-finder-utils.mjs";
-import { pathExists } from "../../../utils/file-utils.mjs";
-import { checkMarkdown, getLinkFromError } from "../../../utils/markdown-checker.mjs";
-
-export default async function findDocumentsWithInvalidLinks({
-  documentStructure = [],
-  docsDir,
-  locale = "en",
-}) {
-  if (!Array.isArray(documentStructure) || documentStructure.length === 0) {
-    return {
-      documentsWithInvalidLinks: [],
-    };
-  }
-
-  if (!docsDir) {
-    return {
-      documentsWithInvalidLinks: [],
-      error: "docsDir is required to check document links",
-    };
-  }
-
-  // Check each document for invalid links
-  const allowedLinks = buildAllowedLinksFromStructure(documentStructure);
-  const documentsWithInvalidLinks = [];
-
-  for (const doc of documentStructure) {
-    if (!doc.path) continue;
-
-    // Generate filename from document path
-    const flatName = pathToFlatName(doc.path);
-    const fileName = generateFileName(flatName, locale);
-
-    // Check if file exists before reading
-    const filePath = join(docsDir, fileName);
-    const fileExists = await pathExists(filePath);
-
-    if (!fileExists) {
-      // Skip if file doesn't exist
-      continue;
-    }
-
-    // Read document content
-    const content = await readFileContent(docsDir, fileName);
-
-    if (!content) {
-      // Skip if content cannot be read
-      continue;
-    }
-
-    // Use checkMarkdown to check for dead links
-    const allErrors = await checkMarkdown(content, doc.path, {
-      allowedLinks,
-      baseDir: docsDir,
-    });
-
-    // Filter only dead link errors and extract invalid links
-    const invalidLinks = allErrors.map(getLinkFromError).filter(Boolean);
-
-    if (invalidLinks.length > 0) {
-      documentsWithInvalidLinks.push({
-        path: doc.path,
-        title: doc.title || doc.path,
-        invalidLinks,
-      });
-    }
-  }
-
-  return {
-    documentsWithInvalidLinks,
-  };
-}

package/agents/create/user-remove-document/index.yaml

@@ -1,40 +0,0 @@
-type: team
-name: userRemoveDocument
-description: Remove documents from the documentation structure
-skills:
-  - url: ../../init/index.mjs
-    default_input:
-      skipIfExists: true
-  - ../../utils/load-sources.mjs
-  - ./remove-documents-from-structure.mjs
-  - url: ../../utils/save-output.mjs
-    default_input:
-      saveKey: documentStructure
-      savePath:
-        $get: outputDir
-      fileName: structure-plan.json
-  - ../../utils/save-sidebar.mjs
-  - ./find-documents-with-invalid-links.mjs
-  - ./review-documents-with-invalid-links.mjs
-  - ../../utils/format-document-structure.mjs
-  - ../../media/load-media-description.mjs
-  - type: team
-    name: batchRemoveInvalidLinks
-    description: Batch remove invalid links from documents
-    skills:
-      - ../utils/init-current-content.mjs
-      - ../../utils/transform-detail-data-sources.mjs
-      - ../../update/update-single/update-single-document-detail.mjs
-    iterate_on: documentsToUpdate
-    concurrency: 5
-  - ./prepare-documents-to-translate.mjs
-  - type: team
-    name: batchTranslateDocuments
-    description: Batch translate documents to multiple languages
-    skills:
-      - ../../localize/translate-multilingual.yaml
-    iterate_on: documentsToTranslate
-    concurrency: 5
-  - ../../utils/post-generate.mjs
-  - ./print-remove-document-summary.mjs
-mode: sequential

package/agents/create/user-remove-document/prepare-documents-to-translate.mjs

@@ -1,22 +0,0 @@
-export default async function prepareDocumentsToTranslate(input, options) {
-  const { documentsWithInvalidLinks = [] } = input;
-  const documentsToTranslate = [];
-
-  documentsWithInvalidLinks.forEach((doc) => {
-    const content = options.context.userContext.currentContents[doc.path];
-
-    if (content) {
-      documentsToTranslate.push({
-        ...doc,
-        content,
-      });
-    } else {
-      console.warn(`⚠️  Could not find content from userContext at path: ${doc.path}`);
-    }
-  });
-
-  return {
-    documentsToUpdate: [], // clear, reduce token consumption
-    documentsToTranslate,
-  };
-}

package/agents/create/user-remove-document/print-remove-document-summary.mjs

@@ -1,53 +0,0 @@
-import chalk from "chalk";
-
-/**
- * Print summary of removed documents and documents with invalid links
- */
-export default async function printRemoveDocumentSummary({
-  deletedDocuments = [],
-  documentsWithInvalidLinks = [],
-}) {
-  let message = `\n---\n`;
-  message += `${chalk.bold.cyan("📊 Summary")}\n\n`;
-
-  // Display removed documents
-  if (deletedDocuments && deletedDocuments.length > 0) {
-    message += `🗑️  Removed Documents:\n`;
-    message += `   Total: ${deletedDocuments.length} document(s)\n\n`;
-    deletedDocuments.forEach((doc, index) => {
-      message += `   ${chalk.cyan(`${index + 1}. ${doc.path}`)}`;
-      if (doc.title && doc.title !== doc.path) {
-        message += ` - ${chalk.yellow(doc.title)}`;
-      }
-      message += `\n\n`;
-    });
-  } else {
-    message += `🗑️  Removed Documents:\n`;
-    message += `${chalk.gray("   No documents were removed.\n\n")}`;
-  }
-
-  // Display documents with invalid links
-  if (documentsWithInvalidLinks && documentsWithInvalidLinks.length > 0) {
-    message += `✅ Documents fixed (Removed invalid links):\n`;
-    message += `   Total: ${documentsWithInvalidLinks.length} document(s)\n\n`;
-    documentsWithInvalidLinks.forEach((doc, index) => {
-      message += `   ${chalk.cyan(`${index + 1}. ${doc.path}`)}`;
-      if (doc.title && doc.title !== doc.path) {
-        message += ` - ${chalk.yellow(doc.title)}`;
-      }
-      message += `\n`;
-      if (doc.invalidLinks && doc.invalidLinks.length > 0) {
-        message += `      Invalid links fixed: ${chalk.gray(doc.invalidLinks.join(", "))}\n`;
-      }
-      message += `\n`;
-    });
-  } else {
-    message += `✅ Documents fixed (Removed invalid links):\n`;
-    message += `${chalk.gray("   No documents needed to be fixed.\n\n")}`;
-  }
-
-  return { message };
-}
-
-printRemoveDocumentSummary.taskTitle = "Print remove document summary";
-printRemoveDocumentSummary.description = "Display summary of removed documents";

package/agents/create/user-remove-document/remove-documents-from-structure.mjs

@@ -1,99 +0,0 @@
-import deleteDocument from "../document-structure-tools/delete-document.mjs";
-import { buildDocumentTree, buildChoicesFromTree } from "../../../utils/docs-finder-utils.mjs";
-
-export default async function removeDocumentsFromStructure(input = {}, options = {}) {
-  const { originalDocumentStructure, locale = "en", docsDir } = input;
-
-  if (!Array.isArray(originalDocumentStructure) || originalDocumentStructure.length === 0) {
-    console.warn(
-      "🗑️ Remove Documents\n  • No document structure found. Please generate documents first.",
-    );
-    process.exit(0);
-  }
-
-  // Initialize currentStructure in userContext
-  options.context.userContext.currentStructure = [...originalDocumentStructure];
-
-  // Build tree structure
-  const { rootNodes } = buildDocumentTree(originalDocumentStructure);
-
-  // Build choices with tree structure visualization
-  const choices = await buildChoicesFromTree(rootNodes, "", 0, { locale, docsDir });
-
-  // Let user select documents to delete
-  let selectedPaths = [];
-  try {
-    selectedPaths = await options.prompts.checkbox({
-      message: "Select documents to remove (Press Enter with no selection to finish):",
-      choices,
-    });
-  } catch {
-    // User cancelled or no selection made
-    console.log("No documents were removed.");
-    process.exit(0);
-  }
-
-  // If no documents selected, exit
-  if (!selectedPaths || selectedPaths.length === 0) {
-    console.log("No documents were removed.");
-    process.exit(0);
-  }
-
-  // Delete each selected document with cascade deletion
-  const deletedDocuments = [];
-  const errors = [];
-
-  for (const path of selectedPaths) {
-    try {
-      const deleteResult = await deleteDocument(
-        {
-          path,
-          recursive: true,
-        },
-        options,
-      );
-
-      if (deleteResult.error) {
-        errors.push({
-          path,
-          error: deleteResult.error.message,
-        });
-      } else {
-        deletedDocuments.push(...deleteResult.deletedDocuments);
-      }
-    } catch (error) {
-      errors.push({
-        path,
-        error: error.message,
-      });
-    }
-  }
-
-  // Check if there are errors
-  if (errors.length > 0) {
-    console.warn(
-      `🗑️ Remove Documents\n  • Failed to remove documents:\n${errors
-        .map((e) => `    - ${e.path}: ${e.error}`)
-        .join("\n")}`,
-    );
-    process.exit(0);
-  }
-
-  if (deletedDocuments.length === 0) {
-    console.log("No documents were removed.");
-    process.exit(0);
-  }
-
-  // Get final updated document structure
-  const updatedStructure = options.context.userContext.currentStructure;
-
-  return {
-    documentStructure: updatedStructure,
-    originalDocumentStructure: JSON.parse(JSON.stringify(updatedStructure)),
-    deletedDocuments,
-  };
-}
-
-removeDocumentsFromStructure.taskTitle = "Remove documents from structure";
-removeDocumentsFromStructure.description =
-  "Select and remove documents from the documentation structure";