@aigne/doc-smith 0.9.10 → 0.9.11-beta

package/agents/update-image/load-existing-image.mjs

@@ -0,0 +1,211 @@
+import { readFile, access, constants } from "node:fs/promises";
+import { join } from "node:path";
+import { parse as yamlParse } from "yaml";
+import { PATHS } from "../../utils/agent-constants.mjs";
+import { parseSlots } from "../../utils/image-slots.mjs";
+import { findImageFile, getImageMimeType, calculateContentHash } from "../../utils/image-utils.mjs";
+import { loadLocale } from "../../utils/config.mjs";
+
+/**
+ * Load existing image
+ * @param {Object} input - Input parameters
+ * @param {string} input.doc - Document path (e.g., "overview" or "/overview")
+ * @param {string} input.slotId - slot id
+ * @returns {Promise<Object>} - Load result
+ */
+export default async function loadExistingImage(input) {
+  try {
+    const { doc, slotId } = input;
+
+    // Validate parameters
+    if (!doc || !slotId) {
+      throw new Error("Missing required parameters: doc and slotId");
+    }
+
+    // 1. Read main language
+    const locale = await loadLocale();
+
+    // 2. Build document file path
+    const normalizedPath = doc.startsWith("/") ? doc.slice(1) : doc;
+    const filePath = join(PATHS.DOCS_DIR, normalizedPath, `${locale}.md`);
+
+    // Check if file exists
+    try {
+      await access(filePath, constants.F_OK | constants.R_OK);
+    } catch (_error) {
+      throw new Error(
+        `Document does not exist or cannot be read: ${filePath}, please check if document path is in document-structure.yaml and document has been generated.`,
+      );
+    }
+
+    // 3. Read document content
+    const content = await readFile(filePath, "utf8");
+
+    // 4. Calculate document content hash
+    const hash = calculateContentHash(content);
+
+    // 5. Parse slots, find specified slotId
+    const slots = parseSlots(content, doc);
+    const targetSlot = slots.find((s) => s.id === slotId);
+
+    if (!targetSlot) {
+      throw new Error(`Image slot with slotId="${slotId}" not found in document ${doc}`);
+    }
+
+    const { key, desc } = targetSlot;
+
+    // 6. Load image file
+    const imagesDir = join(PATHS.ASSETS_DIR, key, "images");
+    const imagePath = await findImageFile(imagesDir, locale);
+
+    if (!imagePath) {
+      throw new Error(
+        `Image file for slot "${slotId}" not found (key: ${key}), please confirm with user whether to use generateImages Tool to generate image first.`,
+      );
+    }
+
+    // 7. Read .meta.yaml
+    const metaPath = join(PATHS.ASSETS_DIR, key, ".meta.yaml");
+    let meta = null;
+    try {
+      const metaContent = await readFile(metaPath, "utf8");
+      meta = yamlParse(metaContent);
+    } catch (_error) {
+      // meta file does not exist or cannot be read, continue execution
+    }
+
+    // 8. Build image info (for existingImage parameter)
+    const mimeType = getImageMimeType(imagePath);
+    const filename = imagePath.split("/").pop();
+
+    const existingImage = [
+      {
+        type: "local",
+        path: imagePath,
+        filename,
+        mimeType,
+      },
+    ];
+
+    // 9. Get current aspectRatio (from meta or use default)
+    const currentAspectRatio = meta?.generation?.aspectRatio || "4:3";
+
+    return {
+      success: true,
+      slotId,
+      key,
+      desc,
+      doc,
+      locale,
+      content,
+      hash,
+      existingImage,
+      currentAspectRatio,
+      imagePath,
+      meta,
+      message: `Successfully loaded image: ${imagePath}`,
+    };
+  } catch (error) {
+    throw new Error(
+      `Failed to load existing image: ${error.message}, please check document path and slotId are correct`,
+    );
+  }
+}
+
+// Add description
+loadExistingImage.description =
+  "Load existing image based on document path and slotId, return image path and related metadata.";
+
+// Define input schema
+loadExistingImage.input_schema = {
+  type: "object",
+  properties: {
+    doc: {
+      type: "string",
+      description: "Document path (e.g., 'overview' or '/overview')",
+    },
+    slotId: {
+      type: "string",
+      description: "Image slot id",
+    },
+  },
+  required: ["doc", "slotId"],
+};
+
+// Define output schema
+loadExistingImage.output_schema = {
+  type: "object",
+  required: ["success"],
+  properties: {
+    success: {
+      type: "boolean",
+      description: "Whether operation succeeded",
+    },
+    slotId: {
+      type: "string",
+      description: "slot id",
+    },
+    key: {
+      type: "string",
+      description: "Image key (directory name)",
+    },
+    desc: {
+      type: "string",
+      description: "slot description",
+    },
+    doc: {
+      type: "string",
+      description: "Document path",
+    },
+    locale: {
+      type: "string",
+      description: "Main language code",
+    },
+    content: {
+      type: "string",
+      description: "Document content",
+    },
+    hash: {
+      type: "string",
+      description: "SHA256 hash of document content",
+    },
+    existingImage: {
+      type: "array",
+      description: "Existing image info (for image-to-image generation)",
+      items: {
+        type: "object",
+        properties: {
+          type: { type: "string" },
+          path: { type: "string" },
+          filename: { type: "string" },
+          mimeType: { type: "string" },
+        },
+      },
+    },
+    currentAspectRatio: {
+      type: "string",
+      description: "Current image aspect ratio",
+    },
+    imagePath: {
+      type: "string",
+      description: "Image file path",
+    },
+    meta: {
+      type: "object",
+      nullable: true,
+      description: "Image metadata (.meta.yaml content)",
+    },
+    message: {
+      type: "string",
+      description: "Operation result description",
+    },
+    error: {
+      type: "string",
+      description: "Error code (present on failure)",
+    },
+    suggestion: {
+      type: "string",
+      description: "Suggested action (present on failure)",
+    },
+  },
+};

package/agents/update-image/prompts/analyze-feedback-system.md

@@ -0,0 +1,43 @@
+你是一个专门分析用户对图片编辑反馈的 AI 助手。
+
+# 你的任务
+
+分析用户提供的反馈文本，提取以下信息：
+
+1. **宽高比修改意图**：用户是否想要修改图片的宽高比
+2. **目标宽高比**：如果用户想修改，新的宽高比是什么
+
+# 支持的宽高比
+
+图片生成系统支持以下宽高比：
+- `1:1` - 正方形
+- `5:4` - 接近正方形
+- `4:3` - 标准横向
+- `3:2` - 宽屏横向
+- `16:9` - 超宽屏
+- `21:9` - 电影宽屏
+
+# 分析规则
+
+1. **识别宽高比修改意图**
+   - 用户明确提到比例、宽高比、ratio、aspect ratio 等关键词
+   - 用户提到具体的比例数字（如 "16:9"、"16比9"、"16 9"）
+   - 用户描述比例特征（如 "更宽"、"更方"、"正方形"、"宽屏"）
+
+2. **提取目标宽高比**
+   - 如果用户明确给出数字（如 "改为 16:9"），直接使用该值
+   - 如果用户描述特征（如 "改为正方形"），映射到对应的宽高比：
+     - "正方形" → `1:1`
+     - "标准" → `4:3`
+     - "宽屏" → `16:9`
+     - "超宽" → `21:9`
+   - 只能返回支持的宽高比之一，不支持的比例使用最接近的
+
+3. **处理模糊情况**
+   - 如果用户只说"更宽一点"但没有给出具体比例，设置 `hasRatioChange: false`
+   - 如果用户给出的比例不在支持列表中，选择最接近的支持比例
+
+# 重要规则
+
+1. 如果不确定用户是否要修改宽高比，设置 `hasRatioChange: false`
+2. 不要添加任何解释或额外文本，只返回 JSON 对象

package/agents/update-image/prompts/analyze-feedback-user.md

@@ -0,0 +1,15 @@
+# 用户反馈分析任务
+
+请分析以下用户对图片编辑的反馈，提取宽高比修改意图。
+
+**当前图片宽高比：** {{ currentAspectRatio }}
+
+**用户反馈：**
+```
+{{ feedback }}
+```
+
+**你的任务：**
+1. 分析用户反馈中是否包含宽高比修改意图
+2. 如果有修改意图，提取目标宽高比（必须是支持的值之一）
+3. 如果没有修改意图，使用当前宽高比

package/aigne.yaml

@@ -1,145 +1,32 @@
 #!/usr/bin/env aigne
 
-model:
-  # model: gemini-3-pro-preview
-  model: gemini-2.5-pro
-  temperature: 0.8
-  # https://github.com/AIGNE-io/aigne-framework/blob/main/models/gemini/src/gemini-chat-model.ts#L115
-  reasoning_effort:
-    $get: reasoningEffort
+model: anthropic/claude-sonnet-4-5
+image_model:
+  model: google/gemini-3-pro-image-preview
 agents:
-  # Initialization
-  - ./agents/init/index.mjs
+  - skills-entry/doc-smith/index.mjs
+  - agents/publish/index.yaml
+  # - agents/preload-i18n.mjs
+  - agents/structure-checker/index.mjs
+  - agents/content-checker/index.mjs
+  - agents/localize/index.yaml
+  - agents/generate-images/index.yaml
+  - agents/update-image/index.yaml
+  - agents/localize/translate-documents/translate-document.yaml
+  - skills-entry/doc-smith-docs-detail/index.mjs
+  - agents/clear/index.yaml
+  - agents/clear/choose-contents.mjs
+  - agents/clear/clear-auth-tokens.mjs
+  - agents/clear/clear-deployment-config.mjs
 
-  # Documentation Structure Generation
-  - ./agents/create/generate-structure.yaml
-  - ./agents/create/update-document-structure.yaml
-  - ./agents/create/check-need-generate-structure.mjs
-  - ./agents/create/refine-document-structure.yaml
-  - ./agents/create/check-document-structure.yaml
-  - ./agents/create/user-review-document-structure.mjs
-  - ./agents/create/index.yaml
-
-  # Documentation Structure Tools
-  - ./agents/create/document-structure-tools/add-document.mjs
-  - ./agents/create/document-structure-tools/delete-document.mjs
-  - ./agents/create/document-structure-tools/update-document.mjs
-  - ./agents/create/document-structure-tools/move-document.mjs
-
-  # Document Content Generation & Updates
-  - ./agents/update/batch-generate-document.yaml
-  - ./agents/update/generate-document.yaml
-  - ./agents/update/handle-document-update.yaml
-  - ./agents/update/check-document.mjs
-  - ./agents/update/update-document-detail.yaml
-  - ./agents/update/user-review-document.mjs
-  - ./agents/update/batch-update-document.yaml
-  - ./agents/update/update-single-document.yaml
-  - ./agents/update/check-update-is-single.mjs
-  - ./agents/update/save-and-translate-document.mjs
-  - ./agents/update/index.yaml
-  - ./agents/update/update-single/update-single-document-detail.mjs
-
-
-  # Translation
-  - ./agents/localize/translate-document.yaml
-  - ./agents/localize/translate-multilingual.yaml
-  - ./agents/localize/choose-language.mjs
-  - ./agents/localize/index.yaml
-
-  # Publishing
-  - ./agents/publish/publish-docs.mjs
-  - ./agents/publish/translate-meta.mjs
-  - ./agents/publish/index.yaml
-
-  # Media
-  - ./agents/media/load-media-description.mjs
-  - ./agents/media/batch-generate-media-description.yaml
-  - ./agents/media/generate-media-description.yaml
-
-  # Clear/Cleanup
-  - ./agents/clear/choose-contents.mjs
-  - ./agents/clear/clear-document-structure.mjs
-  - ./agents/clear/clear-generated-docs.mjs
-  - ./agents/clear/clear-document-config.mjs
-  - ./agents/clear/clear-auth-tokens.mjs
-  - ./agents/clear/clear-deployment-config.mjs
-  - ./agents/clear/clear-media-description.mjs
-
-  # Utilities
-  - ./agents/utils/load-sources.mjs
-  - ./agents/utils/post-generate.mjs
-  - ./agents/utils/save-sidebar.mjs
-  - ./agents/utils/transform-detail-data-sources.mjs
-  - ./agents/utils/save-doc.mjs
-  - ./agents/utils/save-doc-translation.mjs
-  - ./agents/utils/save-output.mjs
-  - ./agents/utils/format-document-structure.mjs
-  - ./agents/utils/find-item-by-path.mjs
-  - ./agents/utils/check-feedback-refiner.mjs
-  - ./agents/utils/feedback-refiner.yaml
-  - ./agents/utils/analyze-structure-feedback-intent.yaml
-  - ./agents/utils/analyze-document-feedback-intent.yaml
-  - ./agents/utils/analyze-feedback-intent.mjs
-
-  - ./agents/utils/document-title-streamline.yaml
-  - ./agents/utils/streamline-document-titles-if-needed.mjs
-  - ./agents/utils/document-icon-generate.yaml
-
-  # User Preferences & Chat
-  - ./agents/prefs/index.mjs
-  - ./agents/chat/index.mjs
-
-  # Documentation MCP Server
-  - ./docs-mcp/get-docs-structure.mjs
-  - ./docs-mcp/get-docs-detail.mjs
-  - ./docs-mcp/docs-search.yaml
-  - ./docs-mcp/analyze-docs-relevance.yaml
-  - ./docs-mcp/read-doc-content.mjs
-  - ./docs-mcp/analyze-content-relevance.yaml
-
-  # Evaluation
-  - ./agents/evaluate/index.yaml
-  - ./agents/evaluate/generate-report.mjs
-  - ./agents/evaluate/document-structure.yaml
-  - ./agents/evaluate/document.yaml
-  - ./agents/evaluate/code-snippet.mjs
-
-  # Diagram
-  - ./agents/create/analyze-diagram-type.mjs
-  - ./agents/create/analyze-diagram-type-llm.yaml
-  - ./agents/create/generate-diagram-image.yaml
-  - ./agents/create/replace-d2-with-image.mjs
-  - ./agents/update/generate-diagram.yaml
-  - ./agents/update/check-generate-diagram.mjs
-  - ./agents/update/pre-check-generate-diagram.yaml
-  - ./agents/localize/translate-diagram.yaml
 cli:
-  chat: ./agents/chat/index.mjs
-  agents:
-    - ./agents/init/index.mjs
-    - ./agents/create/index.yaml
-    - ./agents/update/index.yaml
-    - ./agents/publish/index.yaml
-    - ./agents/localize/index.yaml
-    - ./agents/clear/index.yaml
-    - ./agents/prefs/index.mjs
-    - ./agents/evaluate/index.yaml
-    - name: history
-      description: View update history
-      agents:
-        - url: ./agents/history/view.mjs
-          name: view
-          alias: ["log", "list"]
-    - name: add-document
-      alias: ["add"]
-      url: ./agents/create/user-add-document/index.yaml
-    - name: remove-document
-      alias: ["remove", "rm"]
-      url: ./agents/create/user-remove-document/index.yaml
-    - ./agents/clear/index.yaml
-mcp_server:
+  chat: skills-entry/doc-smith/index.mjs
   agents:
-    - ./docs-mcp/get-docs-structure.mjs
-    - ./docs-mcp/get-docs-detail.mjs
-    # - ./docs-mcp/docs-search.yaml
+    - name: doc-smith
+      alias: ["create", "gen", "g"]
+      url: skills-entry/doc-smith/index.mjs
+    - name: publish
+      alias: ["pub", "p"]
+      url: agents/publish/index.yaml
+    - name: clear
+      url: agents/clear/index.yaml

package/package.json

@@ -1,81 +1,49 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.9.10",
+  "version": "0.9.11-beta",
   "description": "AI-driven documentation generation tool built on the AIGNE Framework",
   "publishConfig": {
     "access": "public"
   },
   "files": [
     "agents",
-    "assets/report-template",
-    "docs-mcp",
-    "prompts",
-    "types",
     "utils",
+    "skills",
+    "skills-entry",
+    "scripts",
     "aigne.yaml",
     "LICENSE",
     "README.md",
     "CHANGELOG.md"
   ],
-  "main": "index.js",
+  "main": "aigne.yaml",
   "type": "module",
   "bin": "aigne.yaml",
   "keywords": [],
   "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
   "license": "Elastic-2.0",
   "dependencies": {
-    "@aigne/cli": "^1.56.0",
-    "@aigne/core": "^1.69.0",
-    "@aigne/publish-docs": "^0.14.2",
-    "@aigne/secrets": "^0.1.1-beta.3",
-    "@blocklet/payment-broker-client": "^1.22.27",
+    "@aigne/cli": "^1.59.0-beta.27",
+    "@aigne/publish-docs": "^0.15.0",
+    "@aigne/secrets": "^0.1.5",
+    "@blocklet/payment-broker-client": "^1.24.1",
     "chalk": "^5.5.0",
-    "debug": "^4.4.1",
-    "diff": "^8.0.2",
-    "dompurify": "^3.2.6",
-    "fast-deep-equal": "^3.1.3",
-    "file-type": "^21.0.0",
     "fs-extra": "^11.3.1",
-    "glob": "^11.0.3",
-    "gpt-tokenizer": "^3.2.0",
-    "image-size": "^2.0.2",
-    "sharp": "^0.33.0",
-    "is-in-ci": "^2.0.0",
-    "isbinaryfile": "^5.0.6",
-    "jsdom": "^26.1.0",
-    "marked": "^15.0.12",
-    "marked-terminal": "^7.3.0",
-    "mermaid": "^11.9.0",
-    "minimatch": "^10.1.1",
     "open": "^10.2.0",
-    "p-limit": "^7.1.1",
-    "p-map": "^7.0.3",
-    "p-retry": "^7.0.0",
-    "remark-gfm": "^4.0.1",
-    "remark-lint": "^10.0.1",
-    "remark-parse": "^11.0.0",
-    "typescript": "^5.9.3",
+    "p-limit": "^7.2.0",
     "ufo": "^1.6.1",
-    "unified": "^11.0.5",
-    "unist-util-visit": "^5.0.0",
-    "vfile": "^6.0.3",
-    "yaml": "^2.8.0",
-    "zod": "^3.25.76",
-    "zod-to-json-schema": "^3.24.6"
+    "yaml": "^2.8.0"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.2.4"
   },
+  "overrides": {
+    "jaison": "2.0.2"
+  },
   "scripts": {
-    "test": "bun test --preload ./tests/setup/mock-process-exit.mjs",
-    "test:coverage2": "bun test --preload ./tests/setup/mock-process-exit.mjs --coverage",
-    "test:coverage": "bun test --preload ./tests/setup/mock-process-exit.mjs --coverage --coverage-reporter=lcov --coverage-reporter=text",
-    "test:deploy": "bun test --preload ./tests/setup/mock-process-exit.mjs tests/utils/deploy.test.mjs --coverage --coverage-reporter=text",
-    "test:user-review": "bun test --preload ./tests/setup/mock-process-exit.mjs tests/agents/update/user-review-document.test.mjs --coverage --coverage-reporter=lcov --coverage-reporter=text",
-    "test:watch": "bun test --preload ./tests/setup/mock-process-exit.mjs --watch",
     "lint": "biome lint && biome format",
+    "lint:fix": "biome lint --write && biome format --write",
     "update:deps": "npx -y taze major -r -w -f -n '/@abtnode|@aigne|@arcblock|@blocklet|@did-connect|@did-pay|@did-space|@nft-store|@nft-studio|@ocap/' && pnpm install && pnpm run deduplicate",
-    "deduplicate": "pnpm dedupe",
-    "lint:fix": "biome lint --write && biome format --write"
+    "deduplicate": "pnpm dedupe"
   }
 }

package/scripts/README.md

@@ -0,0 +1,90 @@
+# DocSmith Skill 安装脚本
+
+这个目录包含用于安装和卸载 doc-smith skill 的脚本。
+
+## 脚本说明
+
+### install.sh
+将 doc-smith skill 安装到 Claude 的全局 skills 目录（`~/.claude/skills`），使其可以在任何项目中使用。
+
+**功能：**
+- 自动创建 `~/.claude/skills` 目录（如果不存在）
+- 复制 doc-smith 文件夹到全局 skills 目录
+- 检测并提示是否覆盖已存在的安装
+- 验证安装是否成功
+
+### uninstall.sh
+从 Claude 的全局 skills 目录移除 doc-smith skill。
+
+**功能：**
+- 检查 skill 是否已安装
+- 确认后删除 doc-smith skill
+- 验证卸载是否成功
+
+## 使用方法
+
+### 安装
+
+在项目根目录执行：
+
+```bash
+./scripts/install.sh
+```
+
+或者从 scripts 目录执行：
+
+```bash
+cd scripts
+./install.sh
+```
+
+**自动确认安装（跳过提示）：**
+
+```bash
+./scripts/install.sh -y
+# 或
+./scripts/install.sh --yes
+```
+
+安装成功后，你可以在任何地方的 Claude Code 中使用：
+
+```
+/doc-smith
+```
+
+### 卸载
+
+```bash
+./scripts/uninstall.sh
+```
+
+## 安装位置
+
+- **源文件：** `doc-smith-skill/doc-smith/`
+- **安装位置：** `~/.claude/skills/doc-smith/`
+
+## 注意事项
+
+1. 脚本会提示是否覆盖已存在的安装
+2. 卸载前会要求确认
+3. 所有操作都有彩色输出提示，便于识别状态
+4. 脚本执行失败时会返回非零退出码
+
+## 故障排查
+
+**权限问题：**
+```bash
+chmod +x scripts/install.sh
+chmod +x scripts/uninstall.sh
+```
+
+**手动安装：**
+```bash
+mkdir -p ~/.claude/skills
+cp -r doc-smith ~/.claude/skills/
+```
+
+**手动卸载：**
+```bash
+rm -rf ~/.claude/skills/doc-smith
+```