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

package/agents/localize/translate-multilingual.yaml

@@ -1,51 +0,0 @@
-type: team
-name: translateMultilingual
-description: Batch translate documents to multiple languages
-skills:
-  - type: team
-    task_render_mode: collapse
-    name: translate
-    skills:
-      - url: ../utils/find-user-preferences-by-path.mjs
-        default_input:
-          scope: translation
-      - ../localize/translate-document.yaml
-      - type: transform
-        jsonata: |
-          $merge([
-            $,
-            { "reviewContent": translation }
-          ])
-    reflection:
-      reviewer: ../utils/check-detail-result.mjs
-      is_approved: isApproved
-      max_iterations: 5
-      return_last_on_max_iterations: true
-    task_title: Translate '{{ title }}' to '{{ language }}'
-  - ../utils/save-doc-translation.mjs
-input_schema:
-  type: object
-  properties:
-    translates:
-      type: array
-      items:
-        type: object
-        properties:
-          language:
-            type: string
-    content:
-      type: string
-output_schema:
-  type: object
-  properties:
-    translates:
-      type: array
-      items:
-        type: object
-        properties:
-          language:
-            type: string
-          translation:
-            type: string
-iterate_on: translates
-concurrency: 3

package/agents/media/batch-generate-media-description.yaml

@@ -1,46 +0,0 @@
-type: team
-name: batchGenerateMediaDescription
-description: Batch generate media (image/video) descriptions with concurrency
-skills:
-  - url: ./generate-media-description.yaml
-task_render_mode: collapse
-task_title: Generate Media Description
-input_schema:
-  type: object
-  properties:
-    mediaToDescribe:
-      type: array
-      items:
-        type: object
-        properties:
-          name:
-            type: string
-          width:
-            type: number
-          height:
-            type: number
-          hash:
-            type: string
-          path:
-            type: string
-          type:
-            type: string
-          svgContent:
-            type: string
-          mediaFile:
-            type: array
-            items:
-              type: object
-              properties:
-                type:
-                  type: string
-                path:
-                  type: string
-                filename:
-                  type: string
-                mimeType:
-                  type: string
-      description: Array of media files (images/videos) that need descriptions
-iterate_on: mediaToDescribe
-concurrency: 5
-mode: sequential

package/agents/media/generate-media-description.yaml

@@ -1,50 +0,0 @@
-name: generateMediaDescription
-description: Generate description for a single media file (image/video)
-model: gemini-2.5-flash
-modalities: ["text", "image"]
-instructions:
-  - role: system
-    url: ../../prompts/media/media-description/system-prompt.md
-  - role: user
-    url: ../../prompts/media/media-description/user-prompt.md
-input_file_key: mediaFile
-include_input_in_output: true
-input_schema:
-  type: object
-  properties:
-    name:
-      type: string
-      description: Media file name
-    width:
-      type: number
-      description: Media width in pixels
-    height:
-      type: number
-      description: Media height in pixels
-    hash:
-      type: string
-    path:
-      type: string
-      description: Media path
-    type:
-      type: string
-      description: Media type (image/video)
-    svgContent:
-      type: string
-      description: SVG content
-    mediaFile:
-      type: array
-      items:
-        type: object
-        properties:
-          type:
-            type: string
-          path:
-            type: string
-          filename:
-            type: string
-          mimeType:
-            type: string
-  required:
-    - name
-output_key: description

package/agents/media/load-media-description.mjs

@@ -1,256 +0,0 @@
-import { createHash } from "node:crypto";
-import { existsSync } from "node:fs";
-import { mkdir, readFile, stat, writeFile } from "node:fs/promises";
-import path from "node:path";
-import { parse, stringify } from "yaml";
-import { getMediaDescriptionCachePath } from "../../utils/file-utils.mjs";
-
-const SIZE_THRESHOLD = 10 * 1024 * 1024; // 10MB
-const SVG_SIZE_THRESHOLD = 50 * 1024; // 50KB for SVG files
-
-// Supported MIME types for Gemini AI
-const SUPPORTED_IMAGE_TYPES = new Set([
-  "image/png",
-  "image/jpeg",
-  "image/webp",
-  "image/heic",
-  "image/heif",
-]);
-
-const SUPPORTED_SVG_TYPES = new Set(["image/svg+xml"]);
-
-const SUPPORTED_VIDEO_TYPES = new Set([
-  "video/mp4",
-  "video/mpeg",
-  "video/mov",
-  "video/avi",
-  "video/x-flv",
-  "video/mpg",
-  "video/webm",
-  "video/wmv",
-  "video/3gpp",
-]);
-
-/**
- * Calculate hash for a media file
- * For files < 10MB: use file content
- * For files >= 10MB: use path + size + mtime to avoid memory issues
- * @param {string} absolutePath - The absolute path to the media file
- * @returns {Promise<string>} - The hash of the file
- */
-async function calculateMediaHash(absolutePath) {
-  const stats = await stat(absolutePath);
-
-  if (stats.size < SIZE_THRESHOLD) {
-    // Small file: use full content
-    const content = await readFile(absolutePath);
-    return createHash("sha256").update(content).digest("hex");
-  }
-
-  // Large file: use path + size + mtime
-  const hashInput = `${absolutePath}:${stats.size}:${stats.mtimeMs}`;
-  return createHash("sha256").update(hashInput).digest("hex");
-}
-
-/**
- * Load media descriptions from cache and generate new ones if needed
- * @param {Object} input - Input parameters
- * @param {Array} input.mediaFiles - Array of media file objects from load-sources
- * @param {string} input.docsDir - Base directory for documentation
- * @param {Object} options - Agent options
- * @returns {Promise<Object>} - Updated assetsContent with media descriptions
- */
-export default async function loadMediaDescription(input, options) {
-  const { mediaFiles = [], docsDir } = input;
-
-  // Filter to get image, video and svg files with supported MIME types
-  const mediaFilesToProcess = mediaFiles.filter((file) => {
-    if (file.type === "image") {
-      return SUPPORTED_IMAGE_TYPES.has(file.mimeType) || SUPPORTED_SVG_TYPES.has(file.mimeType);
-    }
-    if (file.type === "video") {
-      return SUPPORTED_VIDEO_TYPES.has(file.mimeType);
-    }
-    return false;
-  });
-
-  // Path to media description cache file
-  const cacheFilePath = getMediaDescriptionCachePath();
-
-  // Load existing cache
-  let cache = {};
-  if (existsSync(cacheFilePath)) {
-    try {
-      const cacheContent = await readFile(cacheFilePath, "utf8");
-      const parsedCache = parse(cacheContent);
-      cache = parsedCache?.descriptions || {};
-    } catch (error) {
-      console.warn("Failed to read media description cache:", error.message);
-    }
-  }
-
-  // Find media files without descriptions
-  const mediaToDescribe = [];
-  const mediaHashMap = new Map();
-
-  const absoluteDocsDir = path.resolve(process.cwd(), docsDir);
-
-  // Only process media files that need AI description
-  for (const mediaFile of mediaFilesToProcess) {
-    // Convert relative path to absolute path for consistent hashing
-    // mediaFiles.path is relative to docsDir
-    const absolutePath = path.join(absoluteDocsDir, mediaFile.path);
-    const mediaHash = await calculateMediaHash(absolutePath);
-    mediaHashMap.set(mediaFile.path, mediaHash);
-
-    if (!cache[mediaHash]) {
-      const isSvg = SUPPORTED_SVG_TYPES.has(mediaFile.mimeType);
-
-      if (isSvg) {
-        // For SVG files, check size and read content
-        try {
-          const stats = await stat(absolutePath);
-          if (stats.size > SVG_SIZE_THRESHOLD) {
-            console.warn(
-              `SVG file ${mediaFile.path} exceeds ${SVG_SIZE_THRESHOLD / 1024}KB limit, skipping`,
-            );
-            continue;
-          }
-
-          const svgContent = await readFile(absolutePath, "utf8");
-          mediaToDescribe.push({
-            ...mediaFile,
-            hash: mediaHash,
-            path: mediaFile.path,
-            svgContent,
-          });
-        } catch (error) {
-          console.warn(`Failed to read SVG file ${mediaFile.path}:`, error.message);
-        }
-      } else {
-        // For non-SVG media files, use mediaFile field
-        mediaToDescribe.push({
-          ...mediaFile,
-          hash: mediaHash,
-          path: mediaFile.path,
-          mediaFile: [
-            {
-              type: "local",
-              path: absolutePath,
-              filename: mediaFile.name,
-              mimeType: mediaFile.mimeType,
-            },
-          ],
-        });
-      }
-    }
-  }
-
-  // Generate descriptions for media files without cache - use team agent for concurrent processing
-  const newDescriptions = {};
-  if (mediaToDescribe.length > 0) {
-    try {
-      // Use batch team agent for concurrent processing
-      const results = await options.context.invoke(
-        options.context.agents["batchGenerateMediaDescription"],
-        {
-          mediaToDescribe,
-        },
-      );
-
-      // Process results - results is an array of individual results
-      if (Array.isArray(results?.mediaToDescribe)) {
-        for (const result of results.mediaToDescribe) {
-          if (result?.hash && result?.description) {
-            newDescriptions[result.hash] = {
-              path: result.path,
-              description: result.description,
-              generatedAt: new Date().toISOString(),
-            };
-          }
-        }
-      }
-
-      // Merge new descriptions into cache
-      Object.assign(cache, newDescriptions);
-
-      // Save updated cache
-      await mkdir(path.dirname(cacheFilePath), { recursive: true });
-      const cacheYaml = stringify({
-        descriptions: cache,
-        lastUpdated: new Date().toISOString(),
-      });
-      await writeFile(cacheFilePath, cacheYaml, "utf8");
-
-      console.log(`Generated descriptions for ${Object.keys(newDescriptions).length} media files`);
-    } catch (error) {
-      console.error("Failed to generate media descriptions:", error.message);
-    }
-  }
-
-  // Build enhanced assetsContent with descriptions
-  let enhancedAssetsContent;
-
-  if (mediaFiles.length > 0) {
-    enhancedAssetsContent = "# Available Media Assets for Documentation\n\n";
-    const assets = mediaFiles.map((x) => {
-      const mediaHash = mediaHashMap.get(x.path);
-      const description = cache[mediaHash]?.description;
-      const result = {
-        name: x.name,
-        path: x.path,
-      };
-      if (description) {
-        result.description = description;
-      }
-      return result;
-    });
-    enhancedAssetsContent += stringify(assets);
-  }
-
-  return {
-    ...input,
-    assetsContent: enhancedAssetsContent,
-    mediaFiles,
-  };
-}
-
-loadMediaDescription.input_schema = {
-  type: "object",
-  properties: {
-    mediaFiles: {
-      type: "array",
-      items: {
-        type: "object",
-        properties: {
-          name: { type: "string" },
-          path: { type: "string" },
-          type: { type: "string" },
-          width: { type: "number" },
-          height: { type: "number" },
-          mimeType: { type: "string" },
-        },
-      },
-      description: "Array of media file objects (images/videos)",
-    },
-    docsDir: {
-      type: "string",
-      description: "Base directory for documentation",
-    },
-  },
-  required: ["mediaFiles", "docsDir"],
-};
-
-loadMediaDescription.output_schema = {
-  type: "object",
-  properties: {
-    assetsContent: {
-      type: "string",
-      description: "Enhanced assets content with media descriptions",
-    },
-    mediaFiles: {
-      type: "array",
-      description: "Array of media file objects",
-    },
-  },
-};

package/agents/prefs/index.mjs

@@ -1,203 +0,0 @@
-import { readPreferences, removeRule, writePreferences } from "../../utils/preferences-utils.mjs";
-
-/**
- * List all user preferences with formatted display
- * @returns {Object} Result with formatted message
- */
-function listPreferences() {
-  const preferences = readPreferences();
-
-  if (preferences.rules.length === 0) {
-    return { message: "No saved preferences found." };
-  }
-
-  let message = "# User Preferences\n\n";
-
-  // Add format explanation
-  message += "**Format explanation:**\n";
-  message += "- 🟢 = Active preference, ⚪ = Inactive preference\n";
-  message += "- [scope] = Preference scope (global, structure, document, translation)\n";
-  message += "- ID = Unique preference identifier\n";
-  message += "- Paths = Specific file paths (if applicable)\n\n";
-
-  preferences.rules.forEach((rule) => {
-    const status = rule.active ? "🟢" : "⚪";
-    const pathsInfo = rule.paths ? ` | Paths: ${rule.paths.join(", ")}` : "";
-
-    // First line: status, scope, ID and paths info
-    message += `${status} [${rule.scope}] ${rule.id}${pathsInfo}\n`;
-
-    // Second line: rule content (truncated if too long)
-    const maxRuleLength = 120;
-    const ruleText =
-      rule.rule.length > maxRuleLength ? `${rule.rule.substring(0, maxRuleLength)}...` : rule.rule;
-    message += `   ${ruleText}\n `;
-
-    // Add blank line after each record
-    message += `\n`;
-  });
-
-  return { message };
-}
-
-/**
- * Remove preferences by IDs or interactive selection
- * @param {string[]} id - Array of preference IDs to remove
- * @param {Object} options - Options with prompts interface
- * @returns {Object} Result with success message
- */
-async function removePreferences(id, options) {
-  const preferences = readPreferences();
-  let targetIds = id;
-
-  if (!targetIds || targetIds.length === 0) {
-    // Interactive selection
-    if (preferences.rules.length === 0) {
-      return { message: "No preferences available to remove." };
-    }
-
-    const choices = preferences.rules.map((rule) => ({
-      name: `${rule.active ? "🟢" : "⚪"} [${rule.scope}] ${rule.rule.substring(0, 60)}${rule.rule.length > 60 ? "..." : ""}`,
-      value: rule.id,
-      description: `ID: ${rule.id}`,
-    }));
-
-    targetIds = await options.prompts.checkbox({
-      message: "Choose preferences to delete:",
-      choices,
-      validate: (answer) => {
-        if (answer.length === 0) {
-          return "Please choose at least one preference to delete";
-        }
-        return true;
-      },
-    });
-
-    if (!targetIds || targetIds.length === 0) {
-      return { message: "No preferences selected for deletion." };
-    }
-  }
-
-  // Process the target IDs
-  const results = [];
-  for (const ruleId of targetIds) {
-    const success = removeRule(ruleId);
-    results.push({ id: ruleId, success });
-  }
-
-  const successCount = results.filter((r) => r.success).length;
-  const failedCount = targetIds.length - successCount;
-  const message =
-    failedCount > 0
-      ? `Successfully removed ${successCount} preferences, ${failedCount} failed.`
-      : `Successfully removed ${successCount} preferences.`;
-
-  return { message };
-}
-
-/**
- * Toggle preferences active status by IDs or interactive selection
- * @param {string[]} id - Array of preference IDs to toggle
- * @param {Object} options - Options with prompts interface
- * @returns {Object} Result with success message
- */
-async function togglePreferences(id, options) {
-  const preferences = readPreferences();
-  let targetIds = id;
-
-  if (!targetIds || targetIds.length === 0) {
-    // Interactive selection
-    if (preferences.rules.length === 0) {
-      return { message: "No preferences available to toggle." };
-    }
-
-    const choices = preferences.rules.map((rule) => ({
-      name: `${rule.active ? "🟢" : "⚪"} [${rule.scope}] ${rule.rule.substring(0, 60)}${rule.rule.length > 60 ? "..." : ""}`,
-      value: rule.id,
-      description: `ID: ${rule.id}`,
-    }));
-
-    targetIds = await options.prompts.checkbox({
-      message: "Choose preferences to enable/disable:",
-      choices,
-      validate: (answer) => {
-        if (answer.length === 0) {
-          return "Please choose at least one preference to toggle";
-        }
-        return true;
-      },
-    });
-
-    if (!targetIds || targetIds.length === 0) {
-      return { message: "No preferences selected to toggle." };
-    }
-  }
-
-  // Process the target IDs
-  const results = [];
-  const prefs = readPreferences();
-
-  for (const ruleId of targetIds) {
-    const rule = prefs.rules.find((r) => r.id === ruleId);
-    if (rule) {
-      rule.active = !rule.active;
-      results.push({ id: ruleId, success: true, newStatus: rule.active });
-    } else {
-      results.push({ id: ruleId, success: false, error: "Rule not found" });
-    }
-  }
-
-  writePreferences(prefs);
-
-  const successCount = results.filter((r) => r.success).length;
-  const failedCount = targetIds.length - successCount;
-  const message =
-    failedCount > 0
-      ? `Successfully toggled ${successCount} preferences, ${failedCount} failed.`
-      : `Successfully toggled ${successCount} preferences.`;
-
-  return { message };
-}
-
-export default async function prefs({ list, remove, toggle, id }, options) {
-  if (list) {
-    return listPreferences();
-  }
-
-  if (remove) {
-    return await removePreferences(id, options);
-  }
-
-  if (toggle) {
-    return await togglePreferences(id, options);
-  }
-
-  return { message: "Please choose an action: --list, --remove, or --toggle." };
-}
-
-prefs.input_schema = {
-  type: "object",
-  properties: {
-    list: {
-      type: "boolean",
-      description: "Show all saved preferences",
-    },
-    remove: {
-      type: "boolean",
-      description: "Delete saved preferences",
-    },
-    toggle: {
-      type: "boolean",
-      description: "Enable/disable preferences",
-    },
-    id: {
-      type: "array",
-      items: {
-        type: "string",
-      },
-      description: "Specific preference IDs to work with",
-    },
-  },
-};
-
-prefs.description = "Manage your saved documentation preferences";

package/agents/publish/index.yaml

@@ -1,26 +0,0 @@
-type: team
-name: publish
-alias:
-  - pub
-  - p
-description: Publish your documentation online
-skills:
-  - url: ../init/index.mjs
-    default_input:
-      skipIfExists: true
-      checkOnly: true
-  - url: ../init/check.mjs
-  - url: ../utils/load-sources.mjs
-  - ../utils/save-sidebar.mjs
-  - ../utils/ensure-document-icons.mjs
-  - translate-meta.mjs
-  - publish-docs.mjs
-input_schema:
-  type: object
-  properties:
-    appUrl:
-      type: string
-      description: Website URL where docs will be published (optional - leave empty for interactive setup)
-    with-branding:
-      type: boolean
-      description: Update your website branding (title, description, logo)