@aigne/doc-smith 0.8.3 → 0.8.5

package/prompts/document/detail-generator.md

@@ -15,9 +15,6 @@
 - 说明要尽可能的详细，如果存在配置项或参数，需要解释每个配置项或参数的含义，如果参数有多个可选值，每种可选值需要解释其含义，并尽可能配上代码示例
 - 参数优先使用 markdown 中的 table 来展示，让内容看上去更整齐，容易阅读
 - 接口/方法调用的说明必须包含 **响应数据示例**
-- 尽可能少的使用 d2 图表，图表中错误的逻辑会导致文档效果更差，绘制 d2 的图表一定要确保可读性和正确性
-- 概览部分，建议包含 d2 图表展示产品架构图
-{% include "d2-chart/rules.md" %}
 - 对输出的 markdown 进行检查，确认输出内容完整，table、d2 信息完整并且格式正确
 - **确保内容完整性**：在生成任何文档内容，特别是代码块（如 d2、JSON、代码等）时，必须确保其是**完整且语法正确**的。在输出完成后，必须进行一次**自我检查**，确认所有的代码块、列表、表格等都已完全闭合且没有中途截断。
 - **代码块原子性**：将每个代码块（例如 ```d2 ... ```）视为一个**不可分割的原子单元**。必须一次性完整生成，从开始标记（```d2）到结束标记（```）之间的所有内容都不能省略或截断。
@@ -29,6 +26,13 @@
 
 </document_rules>
 
+<document_rules>
+
+D2 Diagram Generation Expert Guide:
+{% include "d2-chart/rules.md" %}
+
+</document_rules>
+
 <TONE_STYLE>
 - Documentation should be plain, rigorous and accurate, avoiding grandiose or empty vocabulary
 - You are writing for humans, not algorithms
@@ -42,54 +46,4 @@
   - Use contractions and idioms sparingly to maintain an informal, yet credible tone
   - Blend technical precision with relatable language
   - Be direct: say what happened, why it matters, and how it helps
-
-Example Tone Transformations
-❌ "We’re thrilled to announce our most powerful update yet…"
-✅ "You can now include location and timestamp metadata for each claim, enabling audit-ready transparency."
-
-❌ "Unlock the future of verification."
-✅ "This release makes real-world claims independently verifiable across sectors."
 </TONE_STYLE>
-
-<WORDS_PHRASES_TO_AVOID>
-
-Do not use promotional fluff or filler emotion. Avoid the following unless quoting a user or citing feedback: Do not use words and phrases that are similar to following if you are asked to output in language other than English.
-
-<emotion-words>
-  excited
-  thrilled
-  delighted
-  proud to announce
-  happy to share
-  Overused Adjectives:
-  powerful
-  seamless
-  revolutionary
-  robust
-  amazing
-  significant
-  transformative
-  innovative
-  disruptive
-  groundbreaking
-</emotion-words>
-
-<generic-hype-verbs>
-  unlock
-  unleash
-  empower
-  elevate
-  reimagine
-  transform
-  Empty Marketing Phrases:
-  in today's world
-  at the end of the day
-  best practices
-  end-to-end
-  game changer
-  cutting edge
-</generic-hype-verbs>
-
-➡️ Instead, focus on concrete outcomes and observable benefits.
-Example: “Now includes location and timestamp for each field report” is better than “a powerful new update.”
-</WORDS_PHRASES_TO_AVOID>

package/tests/input-generator.test.mjs

@@ -913,7 +913,7 @@ describe("generateYAML", () => {
         // Should always include these sections
         expect(result).toContain("# Project information for documentation publishing");
         expect(result).toContain("# Documentation Configuration");
-        expect(result).toContain("projectName:");
+        expect(result).toContain('"projectName":');
         expect(result).toContain("documentPurpose:");
         expect(result).toContain("targetAudienceTypes:");
         expect(result).toContain("locale:");
@@ -1287,7 +1287,7 @@ describe("init", () => {
 
         // Config should be generated since original was empty
         const configContent = await fs.readFile(configPath, "utf8");
-        expect(configContent).toContain("projectName:");
+        expect(configContent).toContain('"projectName":');
         expect(configContent).toContain("locale: en");
       } finally {
         await cleanupTempDir(tempDir);

package/tests/kroki-utils.test.mjs

@@ -1,9 +1,12 @@
 import { afterEach, beforeEach, describe, expect, test } from "bun:test";
 import { existsSync, mkdtemp, rmdir } from "node:fs";
-import { mkdir, readFile, writeFile } from "node:fs/promises";
+import { mkdir, readdir, readFile, writeFile } from "node:fs/promises";
 import { tmpdir } from "node:os";
 import path from "node:path";
 
+import Debug from "debug";
+
+import { TMP_ASSETS_DIR } from "../utils/constants.mjs";
 import {
   beforePublishHook,
   checkD2Content,
@@ -238,20 +241,33 @@ E -> F
 
     test("should skip generation if SVG file already exists", async () => {
       const docsDir = path.join(tempDir, "docs");
-      const assetsDir = path.join(docsDir, "../assets/d2");
-      await mkdir(assetsDir, { recursive: true });
-
+      await mkdir(docsDir, { recursive: true });
       const markdown = `\`\`\`d2\nA -> B\n\`\`\``;
 
-      // Pre-create a cached SVG file
-      const testSvgContent = "<svg>test</svg>";
-      await writeFile(path.join(assetsDir, "test.svg"), testSvgContent);
+      // 1. First run to generate the file
+      await saveD2Assets({ markdown, docsDir });
 
-      // This would normally generate the same filename for the same content
-      const result = await saveD2Assets({ markdown, docsDir });
+      // 2. Second run to check if cache is used
+      const debugLogs = [];
+      const originalWrite = process.stderr.write;
+      process.stderr.write = (chunk) => {
+        debugLogs.push(chunk.toString());
+        return true;
+      };
+      Debug.enable("doc-smith");
 
-      expect(typeof result).toBe("string");
-      expect(result).toContain("![](../assets/d2/");
+      try {
+        const result = await saveD2Assets({ markdown, docsDir });
+
+        expect(typeof result).toBe("string");
+        expect(result).toContain(`![](${path.posix.join("..", TMP_ASSETS_DIR, "d2")}`);
+        expect(
+          debugLogs.some((log) => log.includes("Found assets cache, skipping generation")),
+        ).toBe(true);
+      } finally {
+        process.stderr.write = originalWrite;
+        Debug.disable();
+      }
     });
 
     test("should handle D2 generation errors gracefully", async () => {
@@ -273,6 +289,28 @@ E -> F
         global.fetch = originalFetch;
       }
     });
+
+    test("should write .d2 file when debug is enabled", async () => {
+      const docsDir = path.join(tempDir, "docs");
+      await mkdir(docsDir, { recursive: true });
+
+      const markdown = `\`\`\`d2\nA -> B\n\`\`\``;
+
+      // Enable debug mode
+      Debug.enable("doc-smith");
+
+      try {
+        await saveD2Assets({ markdown, docsDir });
+
+        const assetDir = path.join(docsDir, "../", TMP_ASSETS_DIR, "d2");
+        const files = await readdir(assetDir);
+        const d2File = files.find((file) => file.endsWith(".d2"));
+        expect(d2File).toBeDefined();
+      } finally {
+        // Restore debug mode
+        Debug.disable();
+      }
+    });
   });
 
   describe("beforePublishHook", () => {
@@ -350,13 +388,29 @@ E -> F
       // First call should generate
       await checkD2Content({ content });
 
-      // Second call should use cache (should be faster)
-      const startTime = Date.now();
-      await checkD2Content({ content });
-      const endTime = Date.now();
+      // Second call should use cache
+      const debugLogs = [];
+      const originalWrite = process.stderr.write;
+      process.stderr.write = (chunk) => {
+        debugLogs.push(chunk.toString());
+        return true;
+      };
+      Debug.enable("doc-smith");
 
-      // Cache hit should be very fast (< 100ms)
-      expect(endTime - startTime).toBeLessThan(100);
+      try {
+        const startTime = Date.now();
+        await checkD2Content({ content });
+        const endTime = Date.now();
+
+        // Cache hit should be very fast (< 100ms)
+        expect(endTime - startTime).toBeLessThan(100);
+        expect(
+          debugLogs.some((log) => log.includes("Found assets cache, skipping generation")),
+        ).toBe(true);
+      } finally {
+        process.stderr.write = originalWrite;
+        Debug.disable();
+      }
     });
 
     test("should handle generation errors in strict mode", async () => {
@@ -391,6 +445,23 @@ E -> F
         expect(error).toBeDefined();
       }
     });
+
+    test("should write .d2 file when debug is enabled", async () => {
+      const content = "A -> B: debug test";
+
+      Debug.enable("doc-smith");
+
+      try {
+        await checkD2Content({ content });
+
+        const assetDir = path.join(process.cwd(), ".aigne", "doc-smith", ".tmp", "assets", "d2");
+        const files = await readdir(assetDir);
+        const d2File = files.find((file) => file.endsWith(".d2"));
+        expect(d2File).toBeDefined();
+      } finally {
+        Debug.disable();
+      }
+    });
   });
 
   describe("ensureTmpDir", () => {

package/utils/auth-utils.mjs

@@ -25,7 +25,7 @@ const WELLKNOWN_SERVICE_PATH_PREFIX = "/.well-known/service";
  * @param {string} appUrl - The application URL
  * @returns {Promise<string>} - The access token
  */
-export async function getAccessToken(appUrl) {
+export async function getAccessToken(appUrl, ltToken = "") {
   const DOC_SMITH_ENV_FILE = join(homedir(), ".aigne", "doc-smith-connected.yaml");
   const { hostname } = new URL(appUrl);
 
@@ -92,7 +92,14 @@ export async function getAccessToken(appUrl) {
       closeOnSuccess: true,
       appName: "AIGNE DocSmith",
       appLogo: "https://docsmith.aigne.io/image-bin/uploads/a7910a71364ee15a27e86f869ad59009.svg",
-      openPage: (pageUrl) => open(pageUrl),
+      openPage: (pageUrl) => {
+        const url = new URL(pageUrl);
+        if (ltToken) {
+          url.searchParams.set("__lt", ltToken);
+        }
+
+        open(url.toString());
+      },
     });
 
     accessToken = result.accessKeySecret;

package/utils/blocklet.mjs

@@ -1,3 +1,5 @@
+import { joinURL } from "ufo";
+
 /**
  * Custom error class for invalid blocklet application URLs
  */
@@ -23,17 +25,14 @@ export class ComponentNotFoundError extends Error {
   }
 }
 
-export async function getComponentMountPoint(appUrl, did) {
-  const url = new URL(appUrl);
-  const blockletJsUrl = `${url.origin}/__blocklet__.js?type=json`;
+export async function getComponentInfo(appUrl) {
+  const blockletJsUrl = joinURL(appUrl, "__blocklet__.js?type=json");
 
   let blockletJs;
   try {
     blockletJs = await fetch(blockletJsUrl, {
       method: "GET",
-      headers: {
-        Accept: "application/json",
-      },
+      headers: { Accept: "application/json" },
     });
   } catch (error) {
     throw new InvalidBlockletError(appUrl, null, error.message);
@@ -50,6 +49,12 @@ export async function getComponentMountPoint(appUrl, did) {
     throw new InvalidBlockletError(appUrl, null, "Invalid JSON response");
   }
 
+  return config;
+}
+
+export async function getComponentMountPoint(appUrl, did) {
+  const config = await getComponentInfo(appUrl);
+
   const component = config.componentMountPoints?.find((component) => component.did === did);
   if (!component) {
     throw new ComponentNotFoundError(did, appUrl);
@@ -57,3 +62,17 @@ export async function getComponentMountPoint(appUrl, did) {
 
   return component.mountPoint;
 }
+
+export async function getComponentInfoWithMountPoint(appUrl, did) {
+  const config = await getComponentInfo(appUrl);
+
+  const component = config.componentMountPoints?.find((component) => component.did === did);
+  if (!component) {
+    throw new ComponentNotFoundError(did, appUrl);
+  }
+
+  return {
+    ...config,
+    mountPoint: component.mountPoint,
+  };
+}

package/utils/constants.mjs

@@ -330,6 +330,8 @@ export const DEPTH_RECOMMENDATION_LOGIC = {
 // Component mount point ID for Discuss Kit
 export const DISCUSS_KIT_DID = "z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu";
 
+export const PAYMENT_KIT_DID = "z2qaCNvKMv5GjouKdcDWexv6WqtHbpNPQDnAk";
+
 // Discuss Kit related URLs
 export const DISCUSS_KIT_STORE_URL =
   "https://store.blocklet.dev/blocklets/z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu";
@@ -513,7 +515,21 @@ export const RESOLUTION_STRATEGIES = {
 export const D2_CONFIG = `vars: {
   d2-config: {
     layout-engine: elk
-    theme-id: 8
+    theme-id: 105
+    theme-overrides: {
+      N1: "#18181B"
+      N2: "#421E0B"
+      N4: "#E6E8EC"
+      N5: "#E6E8EC"
+
+      B3: "#FFE9D1"
+      B4: "transparent"
+
+      AA2: "#421E0B"
+      AA4: "#FFE9D1"
+
+      AB4: "#FBF4E4"
+    }
   }
 }`;