@aigne/doc-smith 0.8.11-beta.3 → 0.8.11-beta.5

package/tests/utils/deploy.test.mjs

@@ -91,15 +91,8 @@ describe("deploy", () => {
 
     // Verify BrokerClient was constructed with correct config
     expect(mockBrokerClientConstructor).toHaveBeenCalledWith({
-      baseUrl: "",
       authToken: "mock-auth-token",
-      paymentLinkKey: "PAYMENT_LINK_ID",
-      timeout: 300000,
-      polling: {
-        interval: 3000,
-        maxAttempts: 100,
-        backoffStrategy: "linear",
-      },
+      baseUrl: "https://docsmith.aigne.io",
     });
 
     // Verify deploy was called with correct parameters
@@ -120,7 +113,6 @@ describe("deploy", () => {
           ACCESS_PREPARING: expect.any(Function),
           ACCESS_READY: expect.any(Function),
         }),
-        onError: expect.any(Function),
       }),
     );
 
@@ -348,7 +340,8 @@ describe("deploy", () => {
     // Verify BrokerClient was constructed with empty baseUrl
     expect(mockBrokerClientConstructor).toHaveBeenCalledWith(
       expect.objectContaining({
-        baseUrl: "",
+        authToken: "mock-auth-token",
+        baseUrl: "https://docsmith.aigne.io",
       }),
     );
   });

package/tests/utils/docs-finder-utils.test.mjs

@@ -15,6 +15,7 @@ import {
 describe("docs-finder-utils", () => {
   let readdirSpy;
   let readFileSpy;
+  let accessSpy;
   let joinSpy;
   let consoleWarnSpy;
 
@@ -22,6 +23,7 @@ describe("docs-finder-utils", () => {
     // Mock file system operations
     readdirSpy = spyOn(fs, "readdir").mockResolvedValue([]);
     readFileSpy = spyOn(fs, "readFile").mockResolvedValue("test content");
+    accessSpy = spyOn(fs, "access").mockResolvedValue(undefined);
     joinSpy = spyOn(path, "join").mockImplementation((...paths) => paths.join("/"));
 
     // Mock console methods
@@ -31,6 +33,7 @@ describe("docs-finder-utils", () => {
   afterEach(() => {
     readdirSpy?.mockRestore();
     readFileSpy?.mockRestore();
+    accessSpy?.mockRestore();
     joinSpy?.mockRestore();
     consoleWarnSpy?.mockRestore();
   });
@@ -606,11 +609,20 @@ describe("docs-finder-utils", () => {
     });
 
     test("getMainLanguageFiles should handle readdir errors", async () => {
+      accessSpy.mockResolvedValue(undefined); // Directory exists
       readdirSpy.mockRejectedValue(new Error("Permission denied"));
 
       await expect(getMainLanguageFiles("/denied", "en")).rejects.toThrow("Permission denied");
     });
 
+    test("getMainLanguageFiles should throw non-ENOENT access errors", async () => {
+      const permissionError = new Error("Permission denied");
+      permissionError.code = "EACCES";
+      accessSpy.mockRejectedValue(permissionError);
+
+      await expect(getMainLanguageFiles("/denied", "en")).rejects.toThrow("Permission denied");
+    });
+
     test("processSelectedFiles should handle empty document structure", async () => {
       readFileSpy.mockResolvedValue("content");
 

package/tests/utils/kroki-utils.test.mjs

@@ -6,7 +6,7 @@ import path from "node:path";
 
 import Debug from "debug";
 
-import { TMP_ASSETS_DIR } from "../../utils/constants/index.mjs";
+import { DOC_SMITH_DIR, TMP_ASSETS_DIR, TMP_DIR } from "../../utils/constants/index.mjs";
 import {
   beforePublishHook,
   checkD2Content,
@@ -451,7 +451,7 @@ E -> F
       try {
         await checkD2Content({ content });
 
-        const assetDir = path.join(process.cwd(), ".aigne", "doc-smith", ".tmp", "assets", "d2");
+        const assetDir = path.join(process.cwd(), DOC_SMITH_DIR, TMP_DIR, TMP_ASSETS_DIR, "d2");
         const files = await readdir(assetDir);
         const d2File = files.find((file) => file.endsWith(".d2"));
         expect(d2File).toBeDefined();
@@ -470,7 +470,7 @@ E -> F
       try {
         await ensureTmpDir();
 
-        const tmpDir = path.join(tempDir, ".aigne", "doc-smith", ".tmp");
+        const tmpDir = path.join(tempDir, DOC_SMITH_DIR, TMP_DIR);
         const gitignorePath = path.join(tmpDir, ".gitignore");
 
         expect(existsSync(tmpDir)).toBe(true);
@@ -491,7 +491,7 @@ E -> F
         // First call
         await ensureTmpDir();
 
-        const tmpDir = path.join(tempDir, ".aigne", "doc-smith", ".tmp");
+        const tmpDir = path.join(tempDir, DOC_SMITH_DIR, TMP_DIR);
         const gitignorePath = path.join(tmpDir, ".gitignore");
 
         // Modify .gitignore to test if it gets overwritten
@@ -632,7 +632,7 @@ E -> F
         await Promise.all(promises);
 
         // Should only create directory once
-        const tmpDir = path.join(tempDir, ".aigne", "doc-smith", ".tmp");
+        const tmpDir = path.join(tempDir, DOC_SMITH_DIR, TMP_DIR);
         expect(existsSync(tmpDir)).toBe(true);
 
         // .gitignore should be created properly

package/tests/utils/preferences-utils.test.mjs

@@ -3,6 +3,8 @@ import { existsSync } from "node:fs";
 import { mkdir, rm, writeFile } from "node:fs/promises";
 import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
+
+import { DOC_SMITH_DIR } from "../../utils/constants/index.mjs";
 import {
   addPreferenceRule,
   deactivateRule,
@@ -44,7 +46,7 @@ describe("preferences-utils", () => {
 
     test("should read existing preferences file", async () => {
       // Create preferences directory and file
-      const prefsDir = join(testDir, ".aigne", "doc-smith");
+      const prefsDir = join(testDir, DOC_SMITH_DIR);
       await mkdir(prefsDir, { recursive: true });
 
       await writeFile(
@@ -69,7 +71,7 @@ describe("preferences-utils", () => {
 
     test("should handle malformed YAML gracefully", async () => {
       // Create preferences directory and invalid file
-      const prefsDir = join(testDir, ".aigne", "doc-smith");
+      const prefsDir = join(testDir, DOC_SMITH_DIR);
       await mkdir(prefsDir, { recursive: true });
 
       await writeFile(join(prefsDir, "preferences.yml"), "invalid: yaml: content: [", "utf8");
@@ -85,7 +87,7 @@ describe("preferences-utils", () => {
 
       writePreferences(testPreferences);
 
-      const prefsDir = join(testDir, ".aigne", "doc-smith");
+      const prefsDir = join(testDir, DOC_SMITH_DIR);
       expect(existsSync(prefsDir)).toBe(true);
       expect(existsSync(join(prefsDir, "preferences.yml"))).toBe(true);
     });

package/tests/utils/save-value-to-config.test.mjs

@@ -5,6 +5,8 @@ import fsPromisesDefault, * as fsPromises from "node:fs/promises";
 import { mkdir, readFile, rm, writeFile } from "node:fs/promises";
 import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
+
+import { DOC_SMITH_DIR } from "../../utils/constants/index.mjs";
 import { saveValueToConfig } from "../../utils/utils.mjs";
 
 const __filename = fileURLToPath(import.meta.url);
@@ -12,7 +14,7 @@ const __dirname = dirname(__filename);
 
 // Test directory for isolated testing
 const TEST_DIR = join(__dirname, "temp-config-test");
-const TEST_CONFIG_DIR = join(TEST_DIR, ".aigne", "doc-smith");
+const TEST_CONFIG_DIR = join(TEST_DIR, DOC_SMITH_DIR);
 const TEST_CONFIG_PATH = join(TEST_CONFIG_DIR, "config.yaml");
 
 // Store original working directory

package/utils/auth-utils.mjs

@@ -15,6 +15,7 @@ import {
 } from "./blocklet.mjs";
 import {
   BLOCKLET_ADD_COMPONENT_DOCS,
+  DEFAULT_APP_URL,
   DISCUSS_KIT_DID,
   DISCUSS_KIT_STORE_URL,
   DOC_OFFICIAL_ACCESS_TOKEN,
@@ -97,6 +98,9 @@ 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) {
+          url.searchParams.set("required_roles", "owner,admin");
+        }
         if (ltToken) {
           url.searchParams.set("__lt", ltToken);
         }

package/utils/constants/index.mjs

@@ -334,6 +334,9 @@ 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";
+
 // Discuss Kit related URLs
 export const DISCUSS_KIT_STORE_URL =
   "https://store.blocklet.dev/blocklets/z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu";

package/utils/d2-utils.mjs

@@ -17,6 +17,8 @@ import { debug } from "./debug.mjs";
 import { iconMap } from "./icon-map.mjs";
 import { getContentHash } from "./utils.mjs";
 
+const codeBlockRegex = /```d2.*\n([\s\S]*?)```/g;
+
 export async function getChart({ content, strict }) {
   const d2 = new D2();
   const iconUrlList = Object.keys(iconMap);
@@ -60,7 +62,7 @@ export async function getChart({ content, strict }) {
   } catch (err) {
     if (strict) throw err;
 
-    console.error("Failed to generate D2 chart. Content:", content, "Error:", err);
+    console.error("Failed to generate D2 diagram. Content:", content, "Error:", err);
     return null;
   } finally {
     d2.worker.terminate();
@@ -73,8 +75,6 @@ export async function saveAssets({ markdown, docsDir }) {
     return markdown;
   }
 
-  const codeBlockRegex = /```d2.*\n([\s\S]*?)```/g;
-
   const { replaced } = await runIterator({
     input: markdown,
     regexp: codeBlockRegex,
@@ -90,7 +90,7 @@ export async function saveAssets({ markdown, docsDir }) {
         debug("Found assets cache, skipping generation", svgPath);
       } else {
         try {
-          debug("start generate d2 chart", svgPath);
+          debug("start generate d2 diagram", svgPath);
           if (debug.enabled) {
             const d2FileName = `${getContentHash(d2Content)}.d2`;
             const d2Path = path.join(assetDir, d2FileName);
@@ -102,7 +102,7 @@ export async function saveAssets({ markdown, docsDir }) {
             await fs.writeFile(svgPath, svg, { encoding: "utf8" });
           }
         } catch (error) {
-          debug("Failed to generate D2 chart. Content:", d2Content, "Error:", error);
+          debug("Failed to generate D2 diagram. Content:", d2Content, "Error:", error);
           return _code;
         }
       }
@@ -156,7 +156,12 @@ async function runIterator({ input, regexp, fn = () => {}, options, replace = fa
   };
 }
 
-export async function checkContent({ content }) {
+export async function checkContent({ content: _content }) {
+  const matches = Array.from(_content.matchAll(codeBlockRegex));
+  let content = _content;
+  if (matches.length > 0) {
+    content = matches[0][1];
+  }
   await ensureTmpDir();
   const assetDir = path.join(DOC_SMITH_DIR, TMP_DIR, TMP_ASSETS_DIR, "d2");
   await fs.ensureDir(assetDir);

package/utils/deploy.mjs

@@ -2,10 +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 { saveValueToConfig } from "./utils.mjs";
 
 // ==================== Configuration ====================
-const BASE_URL = process.env.DOC_SMITH_BASE_URL || "";
+const BASE_URL = process.env.DOC_SMITH_BASE_URL || DEFAULT_APP_URL;
 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: "恭喜您，你的网站已安装成功！可以返回命令行工具继续后续操作！",
@@ -24,26 +25,14 @@ export async function deploy(id, cachedUrl) {
     throw new Error("Failed to get official access token");
   }
 
-  const client = new BrokerClient({
-    baseUrl: BASE_URL,
-    authToken,
-    paymentLinkKey: "PAYMENT_LINK_ID",
-    timeout: 300000,
-    polling: {
-      interval: 3000,
-      maxAttempts: 100,
-      backoffStrategy: "linear",
-    },
-  });
+  const client = new BrokerClient({ baseUrl: BASE_URL, authToken });
 
   console.log(`🚀 Starting deployment...`);
 
   const result = await client.deploy({
     cachedCheckoutId: id,
     cachedPaymentUrl: cachedUrl,
-    pageInfo: {
-      successMessage: SUCCESS_MESSAGE,
-    },
+    pageInfo: { successMessage: SUCCESS_MESSAGE },
     hooks: {
       [STEPS.PAYMENT_PENDING]: async ({ sessionId, paymentUrl, isResuming }) => {
         console.log(`⏳ Step 1/4: Waiting for payment...`);
@@ -86,11 +75,6 @@ export async function deploy(id, cachedUrl) {
         }
       },
     },
-
-    onError: (error, step) => {
-      console.error(`${chalk.red("❌")} Deployment failed at ${step || "unknown step"}:`);
-      console.error(`   ${error.message}`);
-    },
   });
 
   const { appUrl, homeUrl, subscriptionUrl, dashboardUrl, vendors } = result;

package/utils/docs-finder-utils.mjs

@@ -1,4 +1,4 @@
-import { readdir, readFile } from "node:fs/promises";
+import { access, readdir, readFile } from "node:fs/promises";
 import { join } from "node:path";
 
 /**
@@ -120,6 +120,17 @@ export async function readFileContent(docsDir, fileName) {
  * @returns {Promise<string[]>} Array of main language .md files ordered by documentExecutionStructure
  */
 export async function getMainLanguageFiles(docsDir, locale, documentExecutionStructure = null) {
+  // Check if docsDir exists
+  try {
+    await access(docsDir);
+  } catch (error) {
+    if (error.code === "ENOENT") {
+      return [];
+    }
+
+    throw error;
+  }
+
   const files = await readdir(docsDir);
 
   // Filter for main language .md files (exclude _sidebar.md)

package/utils/kroki-utils.mjs

@@ -8,6 +8,7 @@ import { joinURL } from "ufo";
 
 import {
   D2_CONFIG,
+  DOC_SMITH_DIR,
   FILE_CONCURRENCY,
   KROKI_CONCURRENCY,
   TMP_ASSETS_DIR,
@@ -76,7 +77,7 @@ export async function saveD2Assets({ markdown, docsDir }) {
         debug("Found assets cache, skipping generation", svgPath);
       } else {
         try {
-          debug("start generate d2 chart", svgPath);
+          debug("Start generate d2 diagram", svgPath);
           if (debug.enabled) {
             const d2FileName = `${getContentHash(d2Content)}.d2`;
             const d2Path = path.join(assetDir, d2FileName);
@@ -88,7 +89,7 @@ export async function saveD2Assets({ markdown, docsDir }) {
             await fs.writeFile(svgPath, svg, { encoding: "utf8" });
           }
         } catch (error) {
-          debug("Failed to generate D2 chart:", error);
+          debug("Failed to generate D2 diagram:", error);
           return _code;
         }
       }
@@ -144,7 +145,7 @@ async function runIterator({ input, regexp, fn = () => {}, options, replace = fa
 
 export async function checkD2Content({ content }) {
   await ensureTmpDir();
-  const assetDir = path.join(".aigne", "doc-smith", TMP_DIR, TMP_ASSETS_DIR, "d2");
+  const assetDir = path.join(DOC_SMITH_DIR, TMP_DIR, TMP_ASSETS_DIR, "d2");
   await fs.ensureDir(assetDir);
   const d2Content = [D2_CONFIG, content].join("\n");
   const fileName = `${getContentHash(d2Content)}.svg`;
@@ -166,7 +167,7 @@ export async function checkD2Content({ content }) {
 }
 
 export async function ensureTmpDir() {
-  const tmpDir = path.join(".aigne", "doc-smith", TMP_DIR);
+  const tmpDir = path.join(DOC_SMITH_DIR, TMP_DIR);
   if (!(await fs.pathExists(path.join(tmpDir, ".gitignore")))) {
     await fs.ensureDir(tmpDir);
     await fs.writeFile(path.join(tmpDir, ".gitignore"), "**/*", { encoding: "utf8" });

package/utils/markdown-checker.mjs

@@ -1,14 +1,11 @@
 import fs from "node:fs";
 import path from "node:path";
-import pMap from "p-map";
 import remarkGfm from "remark-gfm";
 import remarkLint from "remark-lint";
 import remarkParse from "remark-parse";
 import { unified } from "unified";
 import { visit } from "unist-util-visit";
 import { VFile } from "vfile";
-import { KROKI_CONCURRENCY } from "./constants/index.mjs";
-import { checkContent, isValidCode } from "./d2-utils.mjs";
 import { validateMermaidSyntax } from "./mermaid-validator.mjs";
 
 /**
@@ -378,7 +375,6 @@ export async function checkMarkdown(markdown, source = "content", options = {})
 
     // Check mermaid code blocks and other custom validations
     const mermaidChecks = [];
-    const d2ChecksList = [];
     visit(ast, "code", (node) => {
       if (node.lang) {
         const line = node.position?.start?.line || "unknown";
@@ -467,13 +463,6 @@ export async function checkMarkdown(markdown, source = "content", options = {})
             specialCharMatch = nodeWithSpecialCharsRegex.exec(mermaidContent);
           }
         }
-        if (isValidCode(node.lang)) {
-          d2ChecksList.push({
-            content: node.value,
-            line,
-          });
-        }
-        // TODO: @zhanghan need to check correctness of every code language
       }
     });
 
@@ -524,15 +513,6 @@ export async function checkMarkdown(markdown, source = "content", options = {})
 
     // Wait for all mermaid checks to complete
     await Promise.all(mermaidChecks);
-    await pMap(
-      d2ChecksList,
-      async ({ content, line }) =>
-        checkContent({ content }).catch((err) => {
-          const errorMessage = err?.message || String(err) || "Unknown d2 syntax error";
-          errorMessages.push(`Found D2 syntax error in ${source} at line ${line}: ${errorMessage}`);
-        }),
-      { concurrency: KROKI_CONCURRENCY },
-    );
 
     // Run markdown linting rules
     await processor.run(ast, file);