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

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.9.7-beta.3](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.9.7-beta.2...v0.9.7-beta.3) (2025-11-28)
+
+
+### Bug Fixes
+
+* ensure x-card data-image is accessible ([#341](https://github.com/AIGNE-io/aigne-doc-smith/issues/341)) ([9209990](https://github.com/AIGNE-io/aigne-doc-smith/commit/92099909d9b1a0d5760a9b9977c940287af1aaec))
+
+## [0.9.7-beta.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.9.7-beta.1...v0.9.7-beta.2) (2025-11-28)
+
+
+### Features
+
+* support secret store for publish config ([#339](https://github.com/AIGNE-io/aigne-doc-smith/issues/339)) ([31bb282](https://github.com/AIGNE-io/aigne-doc-smith/commit/31bb282065707ad718d68d65722a9ced70047c91))
+
 ## [0.9.7-beta.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.9.7-beta...v0.9.7-beta.1) (2025-11-27)
 
 

package/agents/clear/choose-contents.mjs

@@ -1,4 +1,3 @@
-import { getDocSmithEnvFilePath } from "../../utils/auth-utils.mjs";
 import {
   getConfigFilePath,
   getMediaDescriptionCachePath,
@@ -32,7 +31,7 @@ const TARGET_METADATA = {
   authTokens: {
     label: "Authorizations",
     description: () =>
-      `Delete authorization information in '${getDocSmithEnvFilePath()}'. You will need to re-authorize after clearing.`,
+      "Delete authorization information. You will need to re-authorize after clearing.",
     agent: "clearAuthTokens",
   },
   deploymentConfig: {

package/agents/clear/clear-auth-tokens.mjs

@@ -1,25 +1,13 @@
-import { existsSync } from "node:fs";
-import { readFile, writeFile } from "node:fs/promises";
 import chalk from "chalk";
-import { parse, stringify } from "yaml";
-import { getDocSmithEnvFilePath } from "../../utils/auth-utils.mjs";
+import { createStore } from "../../utils/store/index.mjs";
 
 export default async function clearAuthTokens(_input = {}, options = {}) {
-  const DOC_SMITH_ENV_FILE = getDocSmithEnvFilePath();
-  // Check if the file exists
-  if (!existsSync(DOC_SMITH_ENV_FILE)) {
-    return {
-      message: "🔑 No site authorizations found to clear",
-    };
-  }
+  const store = await createStore();
 
   try {
-    // Read existing configuration
-    const data = await readFile(DOC_SMITH_ENV_FILE, "utf8");
-    const envs = parse(data) || {};
-
+    const listMap = await store.listMap();
     // Get all available sites
-    const siteHostnames = Object.keys(envs);
+    const siteHostnames = Object.keys(listMap);
 
     if (siteHostnames.length === 0) {
       return {
@@ -67,24 +55,15 @@ export default async function clearAuthTokens(_input = {}, options = {}) {
 
     if (selectedSites.includes("__ALL__")) {
       // Clear all site authorizations
-      await writeFile(DOC_SMITH_ENV_FILE, stringify({}));
+      await store.clear();
       results.push(`✔ Cleared site authorization for all sites (${siteHostnames.length} sites)`);
       clearedCount = siteHostnames.length;
     } else {
-      // Clear site authorizations for selected sites
-      const updatedEnvs = { ...envs };
-
       for (const hostname of selectedSites) {
-        if (updatedEnvs[hostname]) {
-          // Remove the entire site object
-          delete updatedEnvs[hostname];
-
-          results.push(`✔ Cleared site authorization for ${chalk.cyan(hostname)}`);
-          clearedCount++;
-        }
+        await store.deleteItem(hostname);
+        results.push(`✔ Cleared site authorization for ${chalk.cyan(hostname)}`);
+        clearedCount++;
       }
-
-      await writeFile(DOC_SMITH_ENV_FILE, stringify(updatedEnvs));
     }
 
     const header = `🔑 Successfully cleared site authorizations!`;

package/agents/evaluate/document-structure.yaml

@@ -3,9 +3,8 @@ description: Evaluates the results generated by the document-structure agent to
 instructions:
   url: ../../prompts/evaluate/document-structure.md
 model:
-  model: openai/gpt-5
+  model: gpt-5
   temperature: 1
-# model: anthropic/claude-opus-4-0
 task_render_mode: collapse
 task_title: Evaluate the structure of the documentation
 input_schema:

package/agents/evaluate/document.yaml

@@ -3,9 +3,8 @@ description: Evaluates the quality of generated document content, ensuring compl
 instructions:
   url: ../../prompts/evaluate/document.md
 model:
-  model: openai/gpt-5
+  model: gpt-5
   temperature: 1
-# model: anthropic/claude-opus-4-0
 task_render_mode: collapse
 task_title: Evaluate document for '{{ title }}'
 input_schema:

package/agents/history/view.mjs

@@ -1,5 +1,5 @@
-import chalk from "chalk";
 import { createHash } from "node:crypto";
+import chalk from "chalk";
 import { getHistory } from "../../utils/history-utils.mjs";
 
 export default function viewHistory() {

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

@@ -1,6 +1,6 @@
 name: generateMediaDescription
 description: Generate description for a single media file (image/video)
-model: "google/gemini-2.5-flash"
+model: gemini-2.5-flash
 modalities: ["text", "image"]
 instructions:
   - role: system

package/agents/update/update-single/update-single-document-detail.mjs

@@ -103,7 +103,11 @@ Your task is to remove ${DIAGRAM_PLACEHOLDER} and adjust the document context (b
 
 <user_feedback>
 {{feedback}}
-</user_feedback>`;
+</user_feedback>
+
+<output_constraints>
+- Do not provide any explanations; include only the document content itself
+</output_constraints>`;
   const deleteAgent = AIAgent.from({
     name: "deleteDiagram",
     description: "Remove a diagram from the document content",

package/agents/utils/check-detail-result.mjs

@@ -1,5 +1,5 @@
-import { checkMarkdown } from "../../utils/markdown-checker.mjs";
 import { buildAllowedLinksFromStructure } from "../../utils/docs-finder-utils.mjs";
+import { checkMarkdown } from "../../utils/markdown-checker.mjs";
 
 export default async function checkDetailResult({ documentStructure, reviewContent, docsDir }) {
   if (!reviewContent || reviewContent.trim() === "") {

package/aigne.yaml

@@ -1,13 +1,12 @@
 #!/usr/bin/env aigne
 
 model:
-  # model: aignehub/gpt-5
-  # model: aignehub/claude-sonnet-4-0
-  model: google/gemini-2.5-pro # reasoning_effort 128-32768
+  # 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
-  temperature: 0.8
 agents:
   # Initialization
   - ./agents/init/index.mjs

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.9.7-beta.1",
+  "version": "0.9.7-beta.3",
   "description": "AI-driven documentation generation tool built on the AIGNE Framework",
   "publishConfig": {
     "access": "public"
@@ -27,6 +27,7 @@
     "@aigne/cli": "^1.56.0",
     "@aigne/core": "^1.69.0",
     "@aigne/publish-docs": "^0.14.1",
+    "@aigne/secrets": "^0.1.1-beta.3",
     "@blocklet/payment-broker-client": "^1.22.24",
     "@terrastruct/d2": "^0.1.33",
     "chalk": "^5.5.0",

package/prompts/detail/custom/custom-components/x-card-usage-rules.md

@@ -9,6 +9,7 @@ XCard is individual link display card, suitable for displaying individual links
 - `data-icon` (optional): Icon identifier (e.g., lucide:icon-name or material-symbols:rocket-outline).
   - Icons should prioritize Lucide (lucide:icon-name). If not available in Lucide, use Iconify (collection:icon-name, e.g., material-symbols:rocket-outline).
 - `data-image` (optional): Image URL, can coexist with icon.
+  - Prefer to use image url from `<media_file_list>`.
   - **Requirement**: At least one of `data-icon` or `data-image` must be provided.
   - It's recommended to always provide data-icon.
 - `data-href` (optional): Navigation link for clicking the card or button.

package/utils/auth-utils.mjs

@@ -1,13 +1,10 @@
 import { existsSync, mkdirSync } from "node:fs";
-import { readFile, writeFile } from "node:fs/promises";
 import { homedir } from "node:os";
 import { join } from "node:path";
 import { createConnect } from "@aigne/cli/utils/aigne-hub/credential.js";
 import chalk from "chalk";
 import open from "open";
-import { joinURL } from "ufo";
-import { parse, stringify } from "yaml";
-
+import { joinURL, withQuery } from "ufo";
 import {
   ComponentNotFoundError,
   getComponentMountPoint,
@@ -21,7 +18,7 @@ import {
   DISCUSS_KIT_STORE_URL,
   PAYMENT_KIT_DID,
 } from "./constants/index.mjs";
-import { withQuery } from "ufo";
+import { createStore } from "./store/index.mjs";
 
 const WELLKNOWN_SERVICE_PATH_PREFIX = "/.well-known/service";
 
@@ -30,10 +27,6 @@ const FETCH_INTERVAL = 3000; // 3 seconds
 
 const RETRY_COUNT = (TIMEOUT_MINUTES * 60 * 1000) / FETCH_INTERVAL;
 
-export function getDocSmithEnvFilePath() {
-  return join(homedir(), ".aigne", "doc-smith-connected.yaml");
-}
-
 /**
  * Get access token from environment, config file, or prompt user for authorization
  * @param {string} baseUrl - The application URL
@@ -41,7 +34,7 @@ export function getDocSmithEnvFilePath() {
  */
 export async function getCachedAccessToken(baseUrl) {
   const { hostname: targetHostname } = new URL(baseUrl);
-  const DOC_SMITH_ENV_FILE = getDocSmithEnvFilePath();
+  const store = await createStore();
 
   let accessToken =
     process.env.DOC_SMITH_PUBLISH_ACCESS_TOKEN || process.env.DOC_DISCUSS_KIT_ACCESS_TOKEN;
@@ -49,16 +42,8 @@ export async function getCachedAccessToken(baseUrl) {
   // Check if access token exists in environment or config file
   if (!accessToken) {
     try {
-      if (existsSync(DOC_SMITH_ENV_FILE)) {
-        const data = await readFile(DOC_SMITH_ENV_FILE, "utf8");
-        if (data.includes("DOC_DISCUSS_KIT_ACCESS_TOKEN")) {
-          // Handle empty or invalid YAML files
-          const envs = data.trim() ? parse(data) : null;
-          if (envs?.[targetHostname]?.DOC_DISCUSS_KIT_ACCESS_TOKEN) {
-            accessToken = envs[targetHostname].DOC_DISCUSS_KIT_ACCESS_TOKEN;
-          }
-        }
-      }
+      const storeItem = await store.getItem(targetHostname);
+      accessToken = storeItem?.DOC_DISCUSS_KIT_ACCESS_TOKEN;
     } catch (error) {
       console.warn("Could not read the configuration file:", error.message);
     }
@@ -275,27 +260,14 @@ export async function getOfficialAccessToken(baseUrl, openPage = true, locale =
  */
 async function saveTokenToConfigFile(hostname, fields) {
   try {
-    const configFile = getDocSmithEnvFilePath();
+    const store = await createStore();
 
     const aigneDir = join(homedir(), ".aigne");
     if (!existsSync(aigneDir)) {
       mkdirSync(aigneDir, { recursive: true });
     }
 
-    let existingConfig = {};
-    if (existsSync(configFile)) {
-      const fileContent = await readFile(configFile, "utf8");
-      const parsedConfig = fileContent.trim() ? parse(fileContent) : null;
-      existingConfig = parsedConfig || {};
-    }
-
-    await writeFile(
-      configFile,
-      stringify({
-        ...existingConfig,
-        [hostname]: fields,
-      }),
-    );
+    await store.setItem(hostname, fields);
   } catch (error) {
     console.warn(`Could not save the token to the configuration file: ${error.message}`, error);
     // The token is already in the environment, so we don't need to throw an error here.

package/utils/history-utils.mjs

@@ -1,5 +1,5 @@
 import { execSync } from "node:child_process";
-import { existsSync, readFileSync, writeFileSync, mkdirSync } from "node:fs";
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import { join } from "node:path";
 import { parse, stringify } from "yaml";
 import { DOC_SMITH_DIR } from "./constants/index.mjs";

package/utils/markdown-checker.mjs

@@ -308,6 +308,67 @@ async function checkRemoteImages(markdown, source, errorMessages) {
   }
 }
 
+async function checkXCardImage(markdown, source, errorMessages, markdownFilePath, baseDir) {
+  const imageRegex = /data-image="([^"]*)"/g;
+  let match;
+
+  while (true) {
+    match = imageRegex.exec(markdown);
+    if (match === null) break;
+    const imagePath = match[1].trim();
+
+    // Skip data URLs
+    if (/^data:/.test(imagePath)) continue;
+
+    if (isRelative(imagePath)) {
+      try {
+        let resolvedPath;
+        if (markdownFilePath) {
+          // Resolve relative to the markdown file's directory
+          const markdownDir = path.dirname(markdownFilePath);
+          resolvedPath = path.resolve(markdownDir, imagePath);
+        } else if (baseDir) {
+          // Resolve relative to the provided base directory
+          resolvedPath = path.resolve(baseDir, imagePath);
+        } else {
+          // Fallback to current working directory
+          resolvedPath = path.resolve(imagePath);
+        }
+
+        if (!fs.existsSync(resolvedPath)) {
+          errorMessages.push(
+            `Found invalid local image in ${source}: ${imagePath} - only valid media resources can be used`,
+          );
+        }
+      } catch {
+        errorMessages.push(
+          `Found invalid local image in ${source}: ${imagePath} - only valid media resources can be used`,
+        );
+      }
+    } else if (imagePath.startsWith("/")) {
+      try {
+        if (!fs.existsSync(imagePath)) {
+          errorMessages.push(
+            `Found invalid local image in ${source}: ${imagePath} - only valid media resources can be used`,
+          );
+        }
+      } catch {
+        errorMessages.push(
+          `Found invalid local image in ${source}: ${imagePath} - only valid media resources can be used`,
+        );
+      }
+    } else if (isRemoteFile(imagePath)) {
+      const isAvailable = await isRemoteFileAvailable(imagePath);
+      if (isAvailable) continue;
+      else {
+        errorMessages.push(
+          `Found invalid remote image in ${source}: ${imagePath} - only valid media resources can be used`,
+        );
+      }
+    }
+  }
+}
+
 /**
  * Check content structure and formatting issues
  * @param {string} markdown - The markdown content
@@ -449,6 +510,8 @@ export async function checkMarkdown(markdown, source = "content", options = {})
     // 3. Check remote images existence
     await checkRemoteImages(markdown, source, errorMessages);
 
+    await checkXCardImage(markdown, source, errorMessages, filePath, baseDir);
+
     // 4. Check content structure and formatting issues
     checkContentStructure(markdown, source, errorMessages);
 

package/utils/store/index.mjs

@@ -0,0 +1,45 @@
+import { access, rm } from "node:fs/promises";
+import { homedir } from "node:os";
+import { join } from "node:path";
+import createSecretStore, { FileStore } from "@aigne/secrets";
+
+export async function createStore() {
+  const filepath = join(homedir(), ".aigne", "doc-smith-connected.yaml");
+  const secretStore = await createSecretStore({
+    filepath,
+    serviceName: "aigne-doc-smith-publish",
+  });
+
+  async function migrate() {
+    // system doesn't support keyring
+    if (secretStore instanceof FileStore) {
+      return true;
+    }
+    // already migrated
+    try {
+      await access(filepath);
+    } catch {
+      return true;
+    }
+
+    const fileStore = new FileStore({ filepath });
+    const map = await fileStore.listMap();
+    for (const [key, value] of Object.entries(map)) {
+      await secretStore.setItem(key, value);
+    }
+    await rm(filepath);
+  }
+
+  async function clear() {
+    const map = await secretStore.listMap();
+    for (const key of Object.keys(map)) {
+      await secretStore.deleteItem(key);
+    }
+  }
+
+  await migrate();
+
+  secretStore.clear = clear;
+
+  return secretStore;
+}