@aigne/doc-smith 0.8.12-beta.1 → 0.8.12-beta.3

package/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.8.12-beta.1"
+  ".": "0.8.12-beta.3"
 }

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [0.8.12-beta.3](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.12-beta.2...v0.8.12-beta.3) (2025-10-09)
+
+
+### Bug Fixes
+
+* should not require admin when publish to cloud ([0a74dd1](https://github.com/AIGNE-io/aigne-doc-smith/commit/0a74dd19a2c2390ca223d0cc393661bf3f408a6f))
+
+## [0.8.12-beta.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.12-beta.1...v0.8.12-beta.2) (2025-10-09)
+
+
+### Bug Fixes
+
+* fix update document include path ([#166](https://github.com/AIGNE-io/aigne-doc-smith/issues/166)) ([40c3aa2](https://github.com/AIGNE-io/aigne-doc-smith/commit/40c3aa2739cb35d36fb1daed87a0e23c81285328))
+* resolve failure in document update and generate ([#168](https://github.com/AIGNE-io/aigne-doc-smith/issues/168)) ([c00c759](https://github.com/AIGNE-io/aigne-doc-smith/commit/c00c759473a01ce3d16b89f2bfa974f43420b82a))
+
 ## [0.8.12-beta.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.12-beta...v0.8.12-beta.1) (2025-10-08)
 
 

package/agents/publish/publish-docs.mjs

@@ -6,7 +6,7 @@ import fs from "fs-extra";
 
 import { getAccessToken } from "../../utils/auth-utils.mjs";
 import {
-  DEFAULT_APP_URL,
+  CLOUD_SERVICE_URL_PROD,
   DISCUSS_KIT_STORE_URL,
   DOC_SMITH_DIR,
   TMP_DIR,
@@ -45,7 +45,7 @@ export default async function publishDocs(
 
   // Check if appUrl is default and not saved in config (only when not using env variable)
   const config = await loadConfigFromFile();
-  const isDefaultAppUrl = appUrl === DEFAULT_APP_URL;
+  const isDefaultAppUrl = appUrl === CLOUD_SERVICE_URL_PROD;
   const hasAppUrlInConfig = config?.appUrl;
 
   let token = "";
@@ -207,7 +207,7 @@ publishDocs.input_schema = {
     appUrl: {
       type: "string",
       description: "The url of the app",
-      default: DEFAULT_APP_URL,
+      default: CLOUD_SERVICE_URL_PROD,
     },
     boardId: {
       type: "string",

package/agents/update/check-document.mjs

@@ -112,7 +112,11 @@ export default async function checkDocument(
 
   const teamAgent = TeamAgent.from({
     name: "generateDocument",
-    skills: [options.context.agents["handleDocumentUpdate"]],
+    skills: [
+      options.context.agents["handleDocumentUpdate"],
+      options.context.agents["translateMultilingual"],
+      options.context.agents["saveSingleDoc"],
+    ],
   });
 
   const result = await options.context.invoke(teamAgent, {

package/agents/update/save-and-translate-document.mjs

@@ -3,6 +3,10 @@ import { recordUpdate } from "../../utils/history-utils.mjs";
 export default async function saveAndTranslateDocument(input, options) {
   const { selectedDocs, docsDir, translateLanguages, locale } = input;
 
+  if (!Array.isArray(selectedDocs) || selectedDocs.length === 0) {
+    return {};
+  }
+
   // Saves a document with optional translation data
   const saveDocument = async (doc, translates = null, isTranslate = false) => {
     const saveAgent = options.context.agents["saveSingleDoc"];
@@ -40,7 +44,7 @@ export default async function saveAndTranslateDocument(input, options) {
     shouldTranslate = choice === "yes";
   }
 
-  // Process documents in batches for better performance
+  // Save documents in batches
   const batchSize = 3;
   for (let i = 0; i < selectedDocs.length; i += batchSize) {
     const batch = selectedDocs.slice(i, i + batchSize);
@@ -56,8 +60,6 @@ export default async function saveAndTranslateDocument(input, options) {
             feedback: doc.feedback.trim(),
             documentPath: doc.path,
           });
-          // clear feedback
-          doc.feedback = "";
         }
       } catch (error) {
         console.error(`❌ Failed to save document ${doc.path}:`, error.message);
@@ -80,8 +82,11 @@ export default async function saveAndTranslateDocument(input, options) {
 
     const translatePromises = batch.map(async (doc) => {
       try {
+        // Clear feedback to ensure translation is not affected by update feedback
+        doc.feedback = "";
+
         const result = await options.context.invoke(translateAgent, {
-          ...input, // Pass context for translation
+          ...input, // context is required
           content: doc.content,
           translates: doc.translates,
           title: doc.title,

package/agents/update/user-review-document.mjs

@@ -245,7 +245,13 @@ export default async function userReviewDocument(
     }
   }
 
-  return { content: options.context.userContext.currentContent, feedback: feedbacks.join(". ") };
+  return {
+    title,
+    description,
+    ...rest,
+    content: options.context.userContext.currentContent,
+    feedback: feedbacks.join(". "),
+  };
 }
 
 userReviewDocument.taskTitle = "User review and modify document content";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.8.12-beta.1",
+  "version": "0.8.12-beta.3",
   "description": "AI-driven documentation generation tool built on the AIGNE Framework",
   "publishConfig": {
     "access": "public"

package/prompts/detail/update/user-prompt.md

@@ -9,7 +9,7 @@
 </user_rules>
 
 {% set operation_type = "optimizing" %}
-{% include "../common/document/user-preferences.md" %}
+{% include "../../common/document/user-preferences.md" %}
 
 <original_page_content>
 {{originalContent}}
@@ -25,7 +25,7 @@
 {{ assetsContent }}
 </media_list>
 
-{% include "../common/document/media-handling-rules.md" %}
+{% include "../../common/document/media-handling-rules.md" %}
 </datasources>
 
 <user_feedback>

package/tests/agents/update/save-and-translate-document.test.mjs

@@ -0,0 +1,369 @@
+import { afterEach, beforeEach, describe, expect, mock, spyOn, test } from "bun:test";
+import saveAndTranslateDocument from "../../../agents/update/save-and-translate-document.mjs";
+import * as historyUtils from "../../../utils/history-utils.mjs";
+
+describe("save-and-translate-document", () => {
+  let mockOptions;
+  let consoleErrorSpy;
+  let recordUpdateSpy;
+
+  beforeEach(() => {
+    // Reset all mocks
+    mock.restore();
+
+    mockOptions = {
+      prompts: {
+        select: mock(async () => "no"),
+      },
+      context: {
+        agents: {
+          saveSingleDoc: { mockSaveAgent: true },
+          translateMultilingual: { mockTranslateAgent: true },
+        },
+        invoke: mock(async () => ({ mockResult: true })),
+      },
+    };
+
+    consoleErrorSpy = spyOn(console, "error").mockImplementation(() => {});
+    recordUpdateSpy = spyOn(historyUtils, "recordUpdate").mockImplementation(() => {});
+
+    // Clear context mock call history
+    mockOptions.prompts.select.mockClear();
+    mockOptions.context.invoke.mockClear();
+  });
+
+  afterEach(() => {
+    consoleErrorSpy?.mockRestore();
+    recordUpdateSpy?.mockRestore();
+  });
+
+  // INPUT VALIDATION TESTS
+  test("should handle empty or invalid selectedDocs", async () => {
+    const testCases = [
+      { selectedDocs: [], description: "empty array" },
+      { selectedDocs: null, description: "null" },
+      { selectedDocs: undefined, description: "undefined" },
+      { selectedDocs: "not-array", description: "non-array" },
+    ];
+
+    for (const testCase of testCases) {
+      const input = {
+        selectedDocs: testCase.selectedDocs,
+        docsDir: "./docs",
+        translateLanguages: ["en", "zh"],
+        locale: "en",
+      };
+
+      const result = await saveAndTranslateDocument(input, mockOptions);
+
+      expect(result).toEqual({});
+      expect(mockOptions.context.invoke).not.toHaveBeenCalled();
+      expect(mockOptions.prompts.select).not.toHaveBeenCalled();
+    }
+  });
+
+  // SCENARIO 1: NO TRANSLATION CONFIGURATION
+  test("should skip translation when no translation languages configured", async () => {
+    const testCases = [
+      { translateLanguages: null, description: "null" },
+      { translateLanguages: undefined, description: "undefined" },
+      { translateLanguages: [], description: "empty array" },
+      { translateLanguages: ["en"], description: "only current locale" },
+    ];
+
+    for (const testCase of testCases) {
+      const input = {
+        selectedDocs: [
+          {
+            path: "/docs/test.md",
+            content: "# Test Document",
+            translates: {},
+            labels: {},
+            feedback: "Good content",
+          },
+        ],
+        docsDir: "./docs",
+        translateLanguages: testCase.translateLanguages,
+        locale: "en",
+      };
+
+      const result = await saveAndTranslateDocument(input, mockOptions);
+
+      expect(result).toEqual({});
+      expect(mockOptions.prompts.select).not.toHaveBeenCalled();
+      expect(mockOptions.context.invoke).toHaveBeenCalledTimes(1);
+      expect(recordUpdateSpy).toHaveBeenCalledWith({
+        operation: "document_update",
+        feedback: "Good content",
+        documentPath: "/docs/test.md",
+      });
+
+      // Reset mocks for next iteration
+      mockOptions.prompts.select.mockClear();
+      mockOptions.context.invoke.mockClear();
+      recordUpdateSpy.mockClear();
+    }
+  });
+
+  // SCENARIO 2: USER CHOOSES NOT TO TRANSLATE
+  test("should save documents and skip translation when user chooses no", async () => {
+    const input = {
+      selectedDocs: [
+        {
+          path: "/docs/test1.md",
+          content: "# Test Document 1",
+          translates: {},
+          labels: {},
+          feedback: "Update needed",
+        },
+        {
+          path: "/docs/test2.md",
+          content: "# Test Document 2",
+          translates: {},
+          labels: {},
+          feedback: "Second feedback",
+        },
+        {
+          path: "/docs/test3.md",
+          content: "# Test Document 3",
+          translates: {},
+          labels: {},
+          feedback: "   ", // Whitespace only
+        },
+      ],
+      docsDir: "./docs",
+      translateLanguages: ["en", "zh", "ja"],
+      locale: "en",
+    };
+
+    mockOptions.prompts.select.mockResolvedValue("no");
+
+    const result = await saveAndTranslateDocument(input, mockOptions);
+
+    expect(result).toEqual({});
+    expect(mockOptions.prompts.select).toHaveBeenCalledWith({
+      message: "Document update completed. Would you like to translate these documents now?",
+      choices: [
+        {
+          name: "Review documents first, translate later",
+          value: "no",
+        },
+        {
+          name: "Translate now",
+          value: "yes",
+        },
+      ],
+    });
+    expect(mockOptions.context.invoke).toHaveBeenCalledTimes(3); // Only saveDocument calls
+    expect(recordUpdateSpy).toHaveBeenCalledTimes(2); // Only documents with non-empty feedback
+    expect(recordUpdateSpy).toHaveBeenCalledWith({
+      operation: "document_update",
+      feedback: "Update needed",
+      documentPath: "/docs/test1.md",
+    });
+    expect(recordUpdateSpy).toHaveBeenCalledWith({
+      operation: "document_update",
+      feedback: "Second feedback",
+      documentPath: "/docs/test2.md",
+    });
+  });
+
+  // SCENARIO 3: USER CHOOSES TO TRANSLATE
+  test("should save and translate documents when user chooses yes", async () => {
+    const input = {
+      selectedDocs: [
+        {
+          path: "/docs/test1.md",
+          content: "# Test Document 1",
+          translates: {},
+          labels: {},
+          feedback: "Translation needed",
+          title: "Test Document 1",
+        },
+        {
+          path: "/docs/test2.md",
+          content: "# Test Document 2",
+          translates: {},
+          labels: {},
+          title: "Test Document 2",
+        },
+      ],
+      docsDir: "./docs",
+      translateLanguages: ["en", "zh"],
+      locale: "en",
+    };
+
+    mockOptions.prompts.select.mockResolvedValue("yes");
+    mockOptions.context.invoke
+      .mockResolvedValueOnce({ mockSaveResult: true }) // saveDocument 1
+      .mockResolvedValueOnce({ mockSaveResult: true }) // saveDocument 2
+      .mockResolvedValueOnce({ translates: { zh: "# 测试文档 1" } }) // translateMultilingual 1
+      .mockResolvedValueOnce({ translates: { zh: "# 测试文档 2" } }) // translateMultilingual 2
+      .mockResolvedValueOnce({ mockSaveResult: true }) // saveDocument with translation 1
+      .mockResolvedValueOnce({ mockSaveResult: true }); // saveDocument with translation 2
+
+    const result = await saveAndTranslateDocument(input, mockOptions);
+
+    expect(result).toEqual({});
+    expect(mockOptions.prompts.select).toHaveBeenCalledWith({
+      message: "Document update completed. Would you like to translate these documents now?",
+      choices: [
+        {
+          name: "Review documents first, translate later",
+          value: "no",
+        },
+        {
+          name: "Translate now",
+          value: "yes",
+        },
+      ],
+    });
+    expect(mockOptions.context.invoke).toHaveBeenCalledTimes(6);
+
+    // Verify feedback is cleared before translation
+    expect(input.selectedDocs[0].feedback).toBe("");
+    expect(input.selectedDocs[1].feedback).toBe("");
+
+    expect(recordUpdateSpy).toHaveBeenCalledWith({
+      operation: "document_update",
+      feedback: "Translation needed",
+      documentPath: "/docs/test1.md",
+    });
+  });
+
+  // ERROR HANDLING TESTS
+  test("should handle errors gracefully", async () => {
+    // Test saveDocument error
+    const saveErrorInput = {
+      selectedDocs: [
+        {
+          path: "/docs/test1.md",
+          content: "# Test Document 1",
+          translates: {},
+          labels: {},
+          feedback: "Error test",
+        },
+      ],
+      docsDir: "./docs",
+      translateLanguages: ["en", "zh"],
+      locale: "en",
+    };
+
+    mockOptions.prompts.select.mockResolvedValue("no");
+    mockOptions.context.invoke.mockRejectedValue(new Error("Save failed"));
+
+    const saveErrorResult = await saveAndTranslateDocument(saveErrorInput, mockOptions);
+
+    expect(saveErrorResult).toEqual({});
+    expect(consoleErrorSpy).toHaveBeenCalledWith(
+      "❌ Failed to save document /docs/test1.md:",
+      "Save failed",
+    );
+    expect(recordUpdateSpy).not.toHaveBeenCalled(); // Should not record if save failed
+
+    // Reset mocks
+    mockOptions.prompts.select.mockClear();
+    mockOptions.context.invoke.mockClear();
+    consoleErrorSpy.mockClear();
+    recordUpdateSpy.mockClear();
+
+    // Test translateMultilingual error
+    const translateErrorInput = {
+      selectedDocs: [
+        {
+          path: "/docs/test2.md",
+          content: "# Test Document 2",
+          translates: {},
+          labels: {},
+          title: "Test Document 2",
+        },
+      ],
+      docsDir: "./docs",
+      translateLanguages: ["en", "zh"],
+      locale: "en",
+    };
+
+    mockOptions.prompts.select.mockResolvedValue("yes");
+    mockOptions.context.invoke
+      .mockResolvedValueOnce({ mockSaveResult: true }) // saveDocument succeeds
+      .mockRejectedValueOnce(new Error("Translation failed")); // translateMultilingual fails
+
+    const translateErrorResult = await saveAndTranslateDocument(translateErrorInput, mockOptions);
+
+    expect(translateErrorResult).toEqual({});
+    expect(consoleErrorSpy).toHaveBeenCalledWith(
+      "❌ Failed to translate document /docs/test2.md:",
+      "Translation failed",
+    );
+    expect(mockOptions.context.invoke).toHaveBeenCalledTimes(2);
+  });
+
+  // EDGE CASES AND INTEGRATION
+  test("should handle edge cases and complex scenarios", async () => {
+    // Test edge cases with different document properties
+    const edgeCaseInput = {
+      selectedDocs: [
+        {
+          path: "/docs/test1.md",
+          content: "# Test Document 1",
+          translates: null, // null translates
+          labels: {},
+          feedback: "", // empty feedback
+        },
+        {
+          path: "/docs/test2.md",
+          content: "# Test Document 2",
+          translates: undefined, // undefined translates
+          labels: {},
+          feedback: "   ", // whitespace feedback
+        },
+        {
+          path: "/docs/test3.md",
+          content: "# Test Document 3",
+          translates: {},
+          labels: {},
+          // no title
+        },
+      ],
+      docsDir: "./docs",
+      translateLanguages: ["en", "zh"],
+      locale: "en",
+    };
+
+    mockOptions.prompts.select.mockResolvedValue("no");
+
+    const edgeCaseResult = await saveAndTranslateDocument(edgeCaseInput, mockOptions);
+
+    expect(edgeCaseResult).toEqual({});
+    expect(mockOptions.context.invoke).toHaveBeenCalledTimes(3);
+    expect(recordUpdateSpy).not.toHaveBeenCalled(); // No valid feedback
+
+    // Reset mocks
+    mockOptions.prompts.select.mockClear();
+    mockOptions.context.invoke.mockClear();
+    recordUpdateSpy.mockClear();
+
+    // Test batch processing with multiple documents
+    const batchInput = {
+      selectedDocs: Array.from({ length: 5 }, (_, i) => ({
+        path: `/docs/batch${i + 1}.md`,
+        content: `# Batch Document ${i + 1}`,
+        translates: {},
+        labels: {},
+        title: `Batch Document ${i + 1}`,
+      })),
+      docsDir: "./docs",
+      translateLanguages: ["en", "zh"],
+      locale: "en",
+    };
+
+    mockOptions.prompts.select.mockResolvedValue("yes");
+    mockOptions.context.invoke.mockResolvedValue({ mockResult: true });
+
+    const batchResult = await saveAndTranslateDocument(batchInput, mockOptions);
+
+    expect(batchResult).toEqual({});
+    // 5 documents * 3 calls each (save, translate, save) = 15 calls
+    expect(mockOptions.context.invoke).toHaveBeenCalledTimes(15);
+  });
+});

package/utils/auth-utils.mjs

@@ -15,7 +15,8 @@ import {
 } from "./blocklet.mjs";
 import {
   BLOCKLET_ADD_COMPONENT_DOCS,
-  DEFAULT_APP_URL,
+  CLOUD_SERVICE_URL_PROD,
+  CLOUD_SERVICE_URL_STAGING,
   DISCUSS_KIT_DID,
   DISCUSS_KIT_STORE_URL,
   DOC_OFFICIAL_ACCESS_TOKEN,
@@ -98,7 +99,7 @@ export async function getAccessToken(appUrl, ltToken = "") {
       appLogo: "https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg",
       openPage: (pageUrl) => {
         const url = new URL(pageUrl);
-        if (url.hostname !== DEFAULT_APP_URL) {
+        if ([CLOUD_SERVICE_URL_PROD, CLOUD_SERVICE_URL_STAGING].includes(url.origin) === false) {
           url.searchParams.set("required_roles", "owner,admin");
         }
         if (ltToken) {

package/utils/constants/index.mjs

@@ -335,7 +335,8 @@ export const PAYMENT_KIT_DID = "z2qaCNvKMv5GjouKdcDWexv6WqtHbpNPQDnAk";
 export const DOC_OFFICIAL_ACCESS_TOKEN = "DOC_OFFICIAL_ACCESS_TOKEN";
 
 // Default application URL for the document deployment website.
-export const DEFAULT_APP_URL = "https://docsmith.aigne.io";
+export const CLOUD_SERVICE_URL_PROD = "https://docsmith.aigne.io";
+export const CLOUD_SERVICE_URL_STAGING = "https://staging.docsmith.aigne.io";
 
 // Discuss Kit related URLs
 export const DISCUSS_KIT_STORE_URL =

package/utils/deploy.mjs

@@ -2,11 +2,11 @@ import { BrokerClient, STEPS } from "@blocklet/payment-broker-client/node";
 import chalk from "chalk";
 import open from "open";
 import { getOfficialAccessToken } from "./auth-utils.mjs";
-import { DEFAULT_APP_URL } from "./constants/index.mjs";
+import { CLOUD_SERVICE_URL_PROD } from "./constants/index.mjs";
 import { saveValueToConfig } from "./utils.mjs";
 
 // ==================== Configuration ====================
-const BASE_URL = process.env.DOC_SMITH_BASE_URL || DEFAULT_APP_URL;
+const BASE_URL = process.env.DOC_SMITH_BASE_URL || CLOUD_SERVICE_URL_PROD;
 const SUCCESS_MESSAGE = {
   en: "Congratulations! Your website has been successfully installed. You can return to the command-line tool to continue the next steps.",
   zh: "恭喜您，你的网站已安装成功！可以返回命令行工具继续后续操作！",