@aigne/doc-smith 0.8.15-beta → 0.8.15-beta.10

package/agents/generate/document-structure-tools/generate-sub-structure.mjs

@@ -1,131 +0,0 @@
-import {
-  buildSourcesContent,
-  calculateFileStats,
-  loadFilesFromPaths,
-  readFileContents,
-} from "../../../utils/file-utils.mjs";
-import {
-  INTELLIGENT_SUGGESTION_TOKEN_THRESHOLD,
-  DEFAULT_EXCLUDE_PATTERNS,
-  DEFAULT_INCLUDE_PATTERNS,
-} from "../../../utils/constants/index.mjs";
-import { toRelativePath } from "../../../utils/utils.mjs";
-
-export default async function generateSubStructure(
-  {
-    parentDocument,
-    subSourcePaths,
-    includePatterns,
-    excludePatterns,
-    useDefaultPatterns = true,
-    ...rest
-  },
-  options,
-) {
-  const sourcePaths = subSourcePaths?.map((item) => item.path);
-  if (!sourcePaths || sourcePaths.length === 0) {
-    return {
-      subStructure: [],
-    };
-  }
-
-  let files = await loadFilesFromPaths(sourcePaths, {
-    includePatterns,
-    excludePatterns,
-    useDefaultPatterns,
-    defaultIncludePatterns: DEFAULT_INCLUDE_PATTERNS,
-    defaultExcludePatterns: DEFAULT_EXCLUDE_PATTERNS,
-  });
-  files = [...new Set(files)];
-
-  // all files path
-  const allFilesPaths = files.map((file) => `- ${toRelativePath(file)}`).join("\n");
-
-  // Read all source files using the utility function
-  const sourceFiles = await readFileContents(files, process.cwd());
-
-  // Count tokens and lines using utility function
-  const { totalTokens } = calculateFileStats(sourceFiles);
-
-  // check if totalTokens is too large
-  let isLargeContext = false;
-  if (totalTokens > INTELLIGENT_SUGGESTION_TOKEN_THRESHOLD) {
-    isLargeContext = true;
-  }
-
-  // Build allSources string using utility function
-  const allSources = buildSourcesContent(sourceFiles, isLargeContext);
-
-  // Performance optimization:
-  // Using both structured output and Tool with Gemini model causes redundant calls
-  // Only use Tool when context is very large
-  const generateStructureAgent = isLargeContext
-    ? options.context.agents["generateStructure"]
-    : options.context.agents["generateStructureWithoutTools"];
-  const result = await options.context.invoke(generateStructureAgent, {
-    ...rest,
-    isSubStructure: true,
-    parentDocument,
-    datasources: allSources,
-    allFilesPaths,
-    isLargeContext,
-    files,
-    totalTokens,
-  });
-
-  return {
-    subStructure: result.documentStructure || [],
-    message: `Generated a sub structure for '${parentDocument.path}' successfully. Please merge all sub-structures to output the complete document structure.`,
-  };
-}
-
-generateSubStructure.description = `
-Generates a sub-structure. 
-Handles large file sets by splitting them into smaller sub-document structures when the context size exceeds limits. This approach ensures more focused and complete documentation generation.
-`;
-
-generateSubStructure.inputSchema = {
-  type: "object",
-  properties: {
-    parentDocument: {
-      type: "object",
-      description: "The parent node to generate a sub structure for",
-      properties: {
-        title: { type: "string", description: "The title of the parent node" },
-        description: { type: "string", description: "The description of the parent node" },
-        path: {
-          type: "string",
-          description:
-            "The path of the parent node, Path in URL format, cannot be empty, cannot contain spaces or special characters, must start with /, no need to include language level, e.g., /zh/about should return /about ",
-        },
-        parentId: { type: "string", description: "The parent ID of the parent node" },
-        sourceIds: { type: "array", description: "The source IDs of the parent node" },
-      },
-    },
-    subSourcePaths: {
-      type: "array",
-      description: "The source paths of the sub structure",
-      items: {
-        type: "object",
-        properties: {
-          path: { type: "string", description: "The source path of the sub structure" },
-          reason: { type: "string", description: "The reason for selecting the source path" },
-        },
-        required: ["path", "reason"],
-      },
-    },
-  },
-};
-
-generateSubStructure.outputSchema = {
-  type: "object",
-  properties: {
-    subStructure: {
-      type: "array",
-      description:
-        "The sub structure of the parent node, need merge all sub-structures and output the complete document structure.",
-    },
-    message: { type: "string", description: "The message of the sub structure" },
-  },
-  required: ["subStructure"],
-};

package/agents/generate/generate-structure-without-tools.yaml

@@ -1,65 +0,0 @@
-name: generateStructureWithoutTools
-description: Generate the structure and organization of your documentation
-instructions:
-  - role: system
-    url: ../../prompts/structure/generate/system-prompt.md
-  - role: user
-    url: ../../prompts/structure/generate/user-prompt.md
-task_render_mode: collapse
-task_title: Generate the structure of the documentation
-input_schema:
-  type: object
-  properties:
-    rules:
-      type: string
-      description: Your specific requirements for documentation structure
-    locale:
-      type: string
-      description: Primary language for documentation (e.g., zh, en, ja)
-    datasources:
-      type: string
-      description: Project content and context to help generate documentation structure
-    targetAudience:
-      type: string
-      description: Target audience for the documentation
-    nodeName:
-      type: string
-      description: Specific section or page name to focus on
-    glossary:
-      type: string
-      description: Glossary for consistent terminology
-    feedback:
-      type: string
-      description: Tell us how to improve the documentation structure
-    userPreferences:
-      type: string
-      description: Your saved preferences for structure and documentation style
-    docsType:
-      type: string
-      description: "Documentation type (options: general, getting-started, reference, faq)"
-      default: general
-  required:
-    - rules
-    - datasources
-output_schema:
-  type: object
-  properties:
-    projectName:
-      type: string
-      description: Project name identified from your content sources
-    projectDesc:
-      type: string
-      description: Brief project description generated from content analysis (under 50 words)
-    documentStructure: ../schema/document-structure.yaml
-    documentStructureTree:
-      type: string
-      description: |
-        Visual tree structure showing documentation hierarchy with indented levels for easy review:
-        ```
-        - Home
-          - Getting Started
-            - Installation
-              - Requirements
-        ```
-  required:
-    - documentStructure

package/agents/utils/transform-detail-datasources.mjs

@@ -1,23 +0,0 @@
-import fs from "node:fs";
-import { normalizePath, toRelativePath } from "../../utils/utils.mjs";
-
-export default function transformDetailDatasources({ sourceIds }) {
-  // Read file content for each sourceId, ignoring failures
-  const contents = (sourceIds || [])
-    .map((id) => {
-      try {
-        const normalizedId = normalizePath(id);
-        const content = fs.readFileSync(normalizedId, "utf8");
-        const relativeId = toRelativePath(id);
-        return `// sourceId: ${relativeId}\n${content}\n`;
-      } catch {
-        // Ignore files that cannot be read
-        return null;
-      }
-    })
-    .filter(Boolean);
-
-  return { detailDataSources: contents.join("") };
-}
-
-transformDetailDatasources.task_render_mode = "hide";

package/prompts/common/document/media-handling-rules.md

@@ -1,9 +0,0 @@
-<media_handling_rules>
-Media resource usage rules:
-
-- When DataSources contain media resource files, incorporate them appropriately in the generated content
-- Media resources are provided in markdown format, example: ![Resource description](https://xxxx)
-- Display images in markdown format within generated results
-- Based on resource descriptions, place images strategically in contextually relevant positions to enhance the presentation
-- To ensure correct media resource paths, **only use media resources provided in media_list or remote URL media resources**
-</media_handling_rules>