@aigne/doc-smith 0.9.10 → 0.9.11-beta

package/agents/utils/save-output.mjs

@@ -1,26 +0,0 @@
-import { promises as fs } from "node:fs";
-import { join } from "node:path";
-
-export default async function saveOutput({ savePath, fileName, saveKey, ...rest }) {
-  if (!(saveKey in rest)) {
-    console.warn(`saveKey "${saveKey}" not found in input, skip saving.`);
-    return {
-      saveOutputStatus: false,
-      saveOutputPath: null,
-    };
-  }
-
-  const value = rest[saveKey];
-  const content =
-    typeof value === "object" && value !== null ? JSON.stringify(value, null, 2) : String(value);
-  await fs.mkdir(savePath, { recursive: true });
-  const filePath = join(savePath, fileName);
-  await fs.writeFile(filePath, content, "utf8");
-
-  return {
-    saveOutputStatus: true,
-    saveOutputPath: filePath,
-  };
-}
-
-saveOutput.task_render_mode = "hide";

package/agents/utils/save-sidebar.mjs

@@ -1,38 +0,0 @@
-import { join } from "node:path";
-import fs from "fs-extra";
-import { buildDocumentTree } from "../../utils/docs-finder-utils.mjs";
-
-export default async function saveSidebar({ documentStructure, docsDir }) {
-  // Generate _sidebar.md
-  try {
-    const sidebar = generateSidebar(documentStructure);
-    const sidebarPath = join(docsDir, "_sidebar.md");
-
-    await fs.ensureDir(docsDir);
-    await fs.writeFile(sidebarPath, sidebar, "utf8");
-  } catch (err) {
-    console.error("Failed to save _sidebar.md:", err.message);
-  }
-  return {};
-}
-
-// Recursively generate sidebar text, the link path is the flattened file name
-function walk(nodes, indent = "") {
-  let out = "";
-  for (const node of nodes) {
-    const relPath = node.path.replace(/^\//, "");
-    const flatFile = `${relPath.split("/").join("-")}.md`;
-    const realIndent = node.parentId === null ? "" : indent;
-    out += `${realIndent}* [${node.title}](/${flatFile})\n`;
-
-    if (node.children && node.children.length > 0) {
-      out += walk(node.children, `${indent}  `);
-    }
-  }
-  return out;
-}
-
-function generateSidebar(documentStructure) {
-  const { rootNodes } = buildDocumentTree(documentStructure);
-  return walk(rootNodes).replace(/\n+$/, "");
-}

package/agents/utils/skip-if-content-exists.mjs

@@ -1,27 +0,0 @@
-/**
- * Determine whether to skip document generation when the document already exists.
- * If intentType is diagram-related *and* content is already present, mark that
- * generation should be skipped so downstream agents can short-circuit.
- */
-export default async function skipIfContentExists(input) {
-  const { intentType, content } = input;
-
-  const isDiagramIntent =
-    intentType && ["addDiagram", "updateDiagram", "deleteDiagram"].includes(intentType);
-  const shouldSkipGeneration = Boolean(isDiagramIntent && content);
-
-  return {
-    ...input,
-    skipGenerateDocument: shouldSkipGeneration,
-    // Ensure downstream steps have content available when skipping
-    ...(shouldSkipGeneration
-      ? {
-          content,
-          documentContent: content,
-          originalContent: content,
-        }
-      : {}),
-  };
-}
-
-skipIfContentExists.task_render_mode = "hide";

package/agents/utils/streamline-document-titles-if-needed.mjs

@@ -1,88 +0,0 @@
-/**
- * Check if a string contains character-based language characters (Chinese, Japanese, Korean, etc.)
- * @param {string} str - String to check
- * @returns {boolean} - True if string contains character-based language characters
- */
-function isCharacterBasedLanguage(str) {
-  if (!str) return false;
-  // Check for Chinese, Japanese, Korean, and other character-based languages
-  // Chinese: \u4e00-\u9fff (CJK Unified Ideographs)
-  // Japanese: \u3040-\u309f (Hiragana), \u30a0-\u30ff (Katakana)
-  // Korean: \uac00-\ud7a3 (Hangul Syllables)
-  // Thai: \u0e00-\u0e7f
-  // Arabic: \u0600-\u06ff
-  const characterBasedPattern =
-    /[\u4e00-\u9fff\u3040-\u309f\u30a0-\u30ff\uac00-\ud7a3\u0e00-\u0e7f\u0600-\u06ff]/;
-  return characterBasedPattern.test(str);
-}
-
-/**
- * Get character limit based on language type
- * @param {string} title - Title to check
- * @returns {number} - Character limit (24 for English, 12 for character-based languages)
- */
-function getCharacterLimit(title) {
-  return isCharacterBasedLanguage(title) ? 12 : 24;
-}
-
-/**
- * Streamline document titles if they exceed length limits
- * Reusable function for streamlining document titles in various contexts
- * @param {Object} params
- * @param {Array<{title: string, path: string}>} params.documentStructure - Document structure array
- * @param {Object} options - Agent options with context
- * @returns {Promise<void>} - Modifies documentStructure in place
- */
-export default async function streamlineDocumentTitlesIfNeeded({ documentStructure }, options) {
-  if (!documentStructure || !Array.isArray(documentStructure)) {
-    return;
-  }
-
-  // Filter items that need streamlining based on character count and language type
-  // English: > 24 characters, Character-based languages (Chinese, Japanese, etc.): > 12 characters
-  const itemsNeedingStreamline = documentStructure.filter((item) => {
-    if (!item.title) return false;
-    const limit = getCharacterLimit(item.title);
-    return item.title.length > limit;
-  });
-
-  if (itemsNeedingStreamline.length === 0) {
-    return;
-  }
-
-  const documentList = itemsNeedingStreamline.map((item) => ({
-    path: item.path,
-    title: item.title,
-  }));
-
-  const streamlineAgent = options?.context?.agents?.["documentTitleStreamline"];
-  if (!streamlineAgent) {
-    console.warn("⚠️  documentTitleStreamline agent not found. Skipping title streamlining.");
-    return;
-  }
-
-  try {
-    const streamlineResult = await options.context.invoke(streamlineAgent, {
-      documentList,
-    });
-
-    // Update the document items with streamlined titles using path as the key
-    if (streamlineResult.documentList && Array.isArray(streamlineResult.documentList)) {
-      const streamlineMap = new Map(streamlineResult.documentList.map((item) => [item.path, item]));
-
-      for (const item of documentStructure) {
-        const streamlined = streamlineMap.get(item.path);
-        if (streamlined) {
-          item.title = streamlined.title;
-        }
-      }
-    }
-  } catch (error) {
-    console.warn("⚠️  Failed to streamline document titles:", error.message);
-    console.warn("Continuing with original titles.");
-  }
-}
-
-streamlineDocumentTitlesIfNeeded.taskTitle = "Streamline document titles if needed";
-streamlineDocumentTitlesIfNeeded.description =
-  "Shorten document titles that exceed length limits to make sidebar navigation less crowded";

package/agents/utils/transform-detail-data-sources.mjs

@@ -1,45 +0,0 @@
-import fs from "node:fs";
-import { isRemoteFile } from "../../utils/file-utils.mjs";
-import { normalizePath, toRelativePath } from "../../utils/utils.mjs";
-
-export default function transformDetailDataSource({ sourceIds }, options = {}) {
-  // Read file content for each sourceId, ignoring failures
-  let openAPISpec;
-  const remoteFileList = options?.context?.userContext?.remoteFileList || [];
-  const contents = (sourceIds || [])
-    .filter((id) => {
-      const openApiSourceId = options?.context?.userContext?.openAPISpec?.sourceId;
-      if (openApiSourceId !== undefined && openApiSourceId === id) {
-        openAPISpec = options.context.userContext.openAPISpec;
-        return false;
-      }
-      return true;
-    })
-    .map((id) => {
-      try {
-        if (isRemoteFile(id)) {
-          const findFile = remoteFileList.find((f) => f.sourceId === id);
-          if (findFile) {
-            return `// sourceId: ${id}\n${findFile.content}\n`;
-          }
-          return null;
-        }
-
-        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 {
-    detailDataSource: contents.join(""),
-    openAPISpec,
-  };
-}
-
-transformDetailDataSource.task_render_mode = "hide";