@aigne/doc-smith 0.8.11-beta.4 → 0.8.11-beta.6

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";
@@ -347,7 +350,7 @@ export const SUPPORTED_FILE_EXTENSIONS = [".txt", ".md", ".json", ".yaml", ".yml
 export const CONFLICT_RULES = {
   // Internal conflicts within the same question (multi-select conflicts)
   internalConflicts: {
-    // Note: Most conflicts can be resolved through intelligent document structure
+    // Note: Most conflicts can be resolved through intelligent documentation structure
     // Only keeping conflicts that represent fundamental incompatibilities
   },
 
@@ -421,7 +424,7 @@ export const CONFLICT_RULES = {
 
 // Conflict resolution rules - defines how to handle conflicts when users select conflicting options
 export const CONFLICT_RESOLUTION_RULES = {
-  // Document purpose conflicts that can be resolved through document structure
+  // Document purpose conflicts that can be resolved through documentation structure
   documentPurpose: [
     {
       conflictItems: ["getStarted", "findAnswers"],
@@ -448,7 +451,7 @@ export const CONFLICT_RESOLUTION_RULES = {
     },
   ],
 
-  // Target audience conflicts that can be resolved through document structure
+  // Target audience conflicts that can be resolved through documentation structure
   targetAudienceTypes: [
     {
       conflictItems: ["endUsers", "developers"],
@@ -472,7 +475,7 @@ export const CONFLICT_RESOLUTION_RULES = {
 // Resolution strategy descriptions
 export const RESOLUTION_STRATEGIES = {
   layered_structure: (items) =>
-    `Detected "${items.join('" and "')}" purpose conflict. Resolution strategy: Create layered document structure
+    `Detected "${items.join('" and "')}" purpose conflict. Resolution strategy: Create layered documentation structure
 - Quick start section: Uses "get started" style - optimizes for speed, key steps, working examples, skips complex edge cases
 - API reference section: Uses "find answers" style - comprehensive coverage, searchability, rich examples, skips narrative flow
 - Ensure sections complement rather than conflict with each other`,

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

@@ -24,8 +24,8 @@ function generateFileName(flatName, locale) {
 }
 
 /**
- * Find a single item by path in document structure result and read its content
- * @param {Array} documentExecutionStructure - Array of document structure items
+ * Find a single item by path in documentation structure result and read its content
+ * @param {Array} documentExecutionStructure - Array of documentation structure items
  * @param {string} docPath - Document path to find (supports .md filenames)
  * @param {string} boardId - Board ID for fallback matching
  * @param {string} docsDir - Docs directory path for reading content
@@ -116,7 +116,7 @@ export async function readFileContent(docsDir, fileName) {
  * Get main language markdown files from docs directory
  * @param {string} docsDir - Docs directory path
  * @param {string} locale - Main language locale (e.g., 'en', 'zh', 'fr')
- * @param {Array} documentExecutionStructure - Array of document structure items to determine file order
+ * @param {Array} documentExecutionStructure - Array of documentation structure items to determine file order
  * @returns {Promise<string[]>} Array of main language .md files ordered by documentExecutionStructure
  */
 export async function getMainLanguageFiles(docsDir, locale, documentExecutionStructure = null) {
@@ -153,7 +153,7 @@ export async function getMainLanguageFiles(docsDir, locale, documentExecutionStr
 
   // If documentExecutionStructure is provided, sort files according to the order in documentExecutionStructure
   if (documentExecutionStructure && Array.isArray(documentExecutionStructure)) {
-    // Create a map from flat file name to document structure order
+    // Create a map from flat file name to documentation structure order
     const orderMap = new Map();
     documentExecutionStructure.forEach((item, index) => {
       const itemFlattenedPath = item.path.replace(/^\//, "").replace(/\//g, "-");
@@ -166,16 +166,16 @@ export async function getMainLanguageFiles(docsDir, locale, documentExecutionStr
       const orderA = orderMap.get(a);
       const orderB = orderMap.get(b);
 
-      // If both files are in the document structure, sort by order
+      // If both files are in the documentation structure, sort by order
       if (orderA !== undefined && orderB !== undefined) {
         return orderA - orderB;
       }
 
-      // If only one file is in the document structure, it comes first
+      // If only one file is in the documentation structure, it comes first
       if (orderA !== undefined) return -1;
       if (orderB !== undefined) return 1;
 
-      // If neither file is in the document structure, maintain alphabetical order
+      // If neither file is in the documentation structure, maintain alphabetical order
       return a.localeCompare(b);
     });
   }
@@ -200,8 +200,8 @@ export function fileNameToFlatPath(fileName) {
 }
 
 /**
- * Find document structure item by flattened file name
- * @param {Array} documentExecutionStructure - Array of document structure items
+ * Find documentation structure item by flattened file name
+ * @param {Array} documentExecutionStructure - Array of documentation structure items
  * @param {string} flatName - Flattened file name
  * @returns {Object|null} Found item or null
  */
@@ -215,7 +215,7 @@ export function findItemByFlatName(documentExecutionStructure, flatName) {
 /**
  * Process selected files and convert to found items with content
  * @param {string[]} selectedFiles - Array of selected file names
- * @param {Array} documentExecutionStructure - Array of document structure items
+ * @param {Array} documentExecutionStructure - Array of documentation structure items
  * @param {string} docsDir - Docs directory path
  * @returns {Promise<Object[]>} Array of found items with content
  */
@@ -244,7 +244,7 @@ export async function processSelectedFiles(selectedFiles, documentExecutionStruc
 
       foundItems.push(result);
     } else {
-      console.warn(`⚠️  No document structure item found for file: ${selectedFile}`);
+      console.warn(`⚠️  No documentation structure item found for file: ${selectedFile}`);
     }
   }
 

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";
 
 /**
@@ -90,7 +87,7 @@ function checkDeadLinks(markdown, source, allowedLinks, errorMessages) {
     // Check if this link is in the allowed links set
     if (!allowedLinks.has(path)) {
       errorMessages.push(
-        `Found a dead link in ${source}: [${match[1]}](${trimLink}), ensure the link exists in the document structure path`,
+        `Found a dead link in ${source}: [${match[1]}](${trimLink}), ensure the link exists in the documentation structure path`,
       );
     }
   }
@@ -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);