simple-dynamsoft-mcp 5.0.0 → 6.3.0

package/src/resource-index/config.js

@@ -0,0 +1,226 @@
+const SAMPLE_DIRS = {
+  dbrWeb: "dynamsoft-barcode-reader",
+  dbrMobile: "dynamsoft-barcode-reader-mobile",
+  dbrPython: "dynamsoft-barcode-reader-python",
+  dbrDotnet: "dynamsoft-barcode-reader-dotnet",
+  dbrJava: "dynamsoft-barcode-reader-java",
+  dbrCpp: "dynamsoft-barcode-reader-c-cpp",
+  dbrMaui: "dynamsoft-barcode-reader-maui",
+  dbrReactNative: "dynamsoft-barcode-reader-react-native",
+  dbrFlutter: "dynamsoft-barcode-reader-flutter",
+  dbrNodejs: "dynamsoft-capture-vision-nodejs",
+  dcvWeb: "dynamsoft-capture-vision-javascript",
+  dcvMobile: "dynamsoft-capture-vision-mobile",
+  dcvPython: "dynamsoft-capture-vision-python",
+  dcvDotnet: "dynamsoft-capture-vision-dotnet",
+  dcvJava: "dynamsoft-capture-vision-java",
+  dcvCpp: "dynamsoft-capture-vision-c-cpp",
+  dcvMaui: "dynamsoft-capture-vision-maui",
+  dcvReactNative: "dynamsoft-capture-vision-react-native",
+  dcvFlutter: "dynamsoft-capture-vision-flutter",
+  dcvNodejs: "dynamsoft-capture-vision-nodejs",
+  dcvSpm: "dynamsoft-capture-vision-spm",
+  dwt: "dynamic-web-twain",
+  ddv: "dynamsoft-document-viewer"
+};
+
+const DOC_DIRS = {
+  dbrWeb: "barcode-reader-docs-js",
+  dbrMobile: "barcode-reader-docs-mobile",
+  dbrServer: "barcode-reader-docs-server",
+  dcvWeb: "capture-vision-docs-js",
+  dcvMobile: "capture-vision-docs-mobile",
+  dcvServer: "capture-vision-docs-server",
+  dcvCore: "capture-vision-docs",
+  dwt: "web-twain-docs",
+  ddv: "document-viewer-docs"
+};
+
+const DOCS_CONFIG = {
+  dbrWeb: {
+    urlBase: "https://www.dynamsoft.com/barcode-reader/docs/web/",
+    excludeDirs: [".git", ".github", ".vscode", ".vs", "_data", "_includes", "_layouts", "assets"],
+    excludeFiles: ["README.md", "search.md", "error.md"]
+  },
+  dbrMobile: {
+    urlBase: "https://www.dynamsoft.com/barcode-reader/docs/mobile/",
+    excludeDirs: [".git", ".github", ".vscode", ".vs", "_data", "_includes", "_layouts", "assets"],
+    excludeFiles: ["README.md", "search.md", "error.md"]
+  },
+  dbrServer: {
+    urlBase: "https://www.dynamsoft.com/barcode-reader/docs/server/",
+    excludeDirs: [".git", ".github", ".vscode", ".vs", "_data", "_includes", "_layouts", "assets"],
+    excludeFiles: ["README.md", "search.md", "error.md"]
+  },
+  dcvWeb: {
+    urlBase: "https://www.dynamsoft.com/capture-vision/docs/web/",
+    excludeDirs: [".git", ".github", ".vscode", ".vs", "_data", "_includes", "_layouts", "assets"],
+    excludeFiles: ["README.md", "search.md", "error.md"]
+  },
+  dcvMobile: {
+    urlBase: "https://www.dynamsoft.com/capture-vision/docs/mobile/",
+    excludeDirs: [".git", ".github", ".vscode", ".vs", "_data", "_includes", "_layouts", "assets"],
+    excludeFiles: ["README.md", "search.md", "error.md"]
+  },
+  dcvServer: {
+    urlBase: "https://www.dynamsoft.com/capture-vision/docs/server/",
+    excludeDirs: [".git", ".github", ".vscode", ".vs", "_data", "_includes", "_layouts", "assets"],
+    excludeFiles: ["README.md", "search.md", "error.md"]
+  },
+  dcvCore: {
+    urlBase: "https://www.dynamsoft.com/capture-vision/docs/core/",
+    excludeDirs: [".git", ".github", ".vscode", ".vs", "_data", "_includes", "_layouts", "assets"],
+    excludeFiles: ["README.md", "search.md", "error.md"]
+  },
+  dwt: {
+    urlBase: "https://www.dynamsoft.com/web-twain/docs/",
+    includeDirNames: ["_articles"]
+  },
+  ddv: {
+    urlBase: "https://www.dynamsoft.com/document-viewer/docs/",
+    excludeDirs: [
+      ".git",
+      ".github",
+      ".vscode",
+      ".vs",
+      "_data",
+      "_includes",
+      "_layouts",
+      "_plugins",
+      "_old",
+      "_v1.1",
+      "_v2.1",
+      "assets"
+    ],
+    excludeFiles: ["README.md", "search.md"]
+  }
+};
+
+const DBR_MOBILE_PLATFORM_CANDIDATES = ["android", "ios", "maui", "react-native", "flutter"];
+const DBR_SERVER_PLATFORM_CANDIDATES = ["python", "cpp", "java", "dotnet", "nodejs"];
+const DCV_MOBILE_PLATFORM_CANDIDATES = ["android", "ios", "maui", "react-native", "flutter", "spm"];
+const DCV_SERVER_PLATFORM_CANDIDATES = ["python", "cpp", "java", "dotnet", "nodejs"];
+
+const CODE_FILE_EXTENSIONS = [
+  ".java",
+  ".kt",
+  ".swift",
+  ".m",
+  ".h",
+  ".hpp",
+  ".hxx",
+  ".cc",
+  ".cpp",
+  ".cxx",
+  ".cs",
+  ".py",
+  ".js",
+  ".mjs",
+  ".cjs",
+  ".jsx",
+  ".ts",
+  ".tsx",
+  ".dart",
+  ".vue",
+  ".html"
+];
+
+const DDV_PREFERRED_ENTRY_FILES = [
+  "main.tsx",
+  "main.jsx",
+  "main.ts",
+  "main.js",
+  "App.tsx",
+  "App.jsx",
+  "App.vue",
+  "Viewer.tsx",
+  "Viewer.jsx",
+  "Viewer.vue"
+];
+
+const DBR_SERVER_PREFERRED_FILES = {
+  dotnet: ["Program.cs", "MainPage.xaml.cs", "MainPage.cs"],
+  java: ["Main.java", "App.java"],
+  cpp: ["main.cpp", "Main.cpp"],
+  nodejs: ["index.js", "index.mjs", "app.js", "app.mjs", "server.js", "server.mjs"]
+};
+
+const DBR_SERVER_PREFERRED_EXTS = {
+  dotnet: [".cs"],
+  java: [".java"],
+  cpp: [".cpp", ".cc", ".cxx", ".h", ".hpp"],
+  nodejs: [".js", ".mjs", ".cjs", ".ts"]
+};
+
+const DCV_SERVER_PREFERRED_FILES = {
+  dotnet: ["Program.cs", "MainPage.xaml.cs", "MainPage.cs"],
+  java: ["Main.java", "App.java"],
+  cpp: ["main.cpp", "Main.cpp"],
+  nodejs: ["index.js", "index.mjs", "app.js", "app.mjs", "server.js", "server.mjs"],
+  python: ["document_scanner.py", "mrz_scanner.py", "vin_scanner.py", "driver_license_scanner.py", "gs1_ai_scanner.py"]
+};
+
+const DCV_SERVER_PREFERRED_EXTS = {
+  dotnet: [".cs"],
+  java: [".java"],
+  cpp: [".cpp", ".cc", ".cxx", ".h", ".hpp"],
+  nodejs: [".js", ".mjs", ".cjs", ".ts"],
+  python: [".py"]
+};
+
+const LEGACY_DBR_LINKS = {
+  "10": {
+    web: { web: "https://www.dynamsoft.com/barcode-reader/docs/v10/web/programming/javascript/" },
+    cpp: { desktop: "https://www.dynamsoft.com/barcode-reader/docs/v10/server/programming/cplusplus/" },
+    java: { desktop: null },
+    dotnet: { desktop: "https://www.dynamsoft.com/barcode-reader/docs/v10/server/programming/dotnet/" },
+    python: { desktop: "http://dynamsoft.com/barcode-reader/docs/v10/server/programming/python/" },
+    mobile: {
+      android: "https://www.dynamsoft.com/barcode-reader/docs/v10/mobile/programming/android/",
+      ios: "https://www.dynamsoft.com/barcode-reader/docs/v10/mobile/programming/objectivec-swift/"
+    }
+  },
+  "9": {
+    web: { web: "https://www.dynamsoft.com/barcode-reader/docs/v9/web/programming/javascript/" },
+    cpp: { desktop: "https://www.dynamsoft.com/barcode-reader/docs/v9/server/programming/cplusplus/" },
+    java: { desktop: "https://www.dynamsoft.com/barcode-reader/docs/v9/server/programming/java/" },
+    dotnet: { desktop: "https://www.dynamsoft.com/barcode-reader/docs/v9/server/programming/dotnet/" },
+    python: { desktop: "https://www.dynamsoft.com/barcode-reader/docs/v9/server/programming/python/" },
+    mobile: {
+      android: "https://www.dynamsoft.com/barcode-reader/docs/v9/mobile/programming/android/",
+      ios: "https://www.dynamsoft.com/barcode-reader/docs/v9/mobile/programming/objectivec-swift/"
+    }
+  }
+};
+
+const LEGACY_DWT_LINKS = {
+  "18.5.1": "https://www.dynamsoft.com/web-twain/docs-archive/v18.5.1/info/api/",
+  "18.4": "https://www.dynamsoft.com/web-twain/docs-archive/v18.4/info/api/",
+  "18.3": "https://www.dynamsoft.com/web-twain/docs-archive/v18.3/info/api/",
+  "18.1": "https://www.dynamsoft.com/web-twain/docs-archive/v18.1/info/api/",
+  "18.0": "https://www.dynamsoft.com/web-twain/docs-archive/v18.0/info/api/",
+  "17.3": "https://www.dynamsoft.com/web-twain/docs-archive/v17.3/info/api/",
+  "17.2.1": "https://www.dynamsoft.com/web-twain/docs-archive/v17.2.1/info/api/",
+  "17.1.1": "https://www.dynamsoft.com/web-twain/docs-archive/v17.1.1/info/api/",
+  "17.0": "https://www.dynamsoft.com/web-twain/docs-archive/v17.0/info/api/",
+  "16.2": "https://www.dynamsoft.com/web-twain/docs-archive/v16.2/info/api/",
+  "16.1.1": "https://www.dynamsoft.com/web-twain/docs-archive/v16.1.1/info/api/"
+};
+
+export {
+  SAMPLE_DIRS,
+  DOC_DIRS,
+  DOCS_CONFIG,
+  DBR_MOBILE_PLATFORM_CANDIDATES,
+  DBR_SERVER_PLATFORM_CANDIDATES,
+  DCV_MOBILE_PLATFORM_CANDIDATES,
+  DCV_SERVER_PLATFORM_CANDIDATES,
+  CODE_FILE_EXTENSIONS,
+  DDV_PREFERRED_ENTRY_FILES,
+  DBR_SERVER_PREFERRED_FILES,
+  DBR_SERVER_PREFERRED_EXTS,
+  DCV_SERVER_PREFERRED_FILES,
+  DCV_SERVER_PREFERRED_EXTS,
+  LEGACY_DBR_LINKS,
+  LEGACY_DWT_LINKS
+};

package/src/resource-index/docs-loader.js

@@ -0,0 +1,117 @@
+import { existsSync, readFileSync, readdirSync } from "node:fs";
+import { join, relative } from "node:path";
+
+function parseFrontMatter(markdown) {
+  if (!markdown || !markdown.startsWith("---")) {
+    return { meta: {}, body: markdown || "" };
+  }
+  const match = markdown.match(/^---\r?\n([\s\S]*?)\r?\n---\r?\n?/);
+  if (!match) {
+    return { meta: {}, body: markdown };
+  }
+  const metaBlock = match[1];
+  const body = markdown.slice(match[0].length);
+  const meta = {};
+  for (const rawLine of metaBlock.split("\n")) {
+    const line = rawLine.trim();
+    if (!line || line.startsWith("#")) continue;
+    const colon = line.indexOf(":");
+    if (colon < 0) continue;
+    const key = line.slice(0, colon).trim();
+    let value = line.slice(colon + 1).trim();
+    if ((value.startsWith("\"") && value.endsWith("\"")) || (value.startsWith("'") && value.endsWith("'"))) {
+      value = value.slice(1, -1);
+    }
+    meta[key] = value;
+  }
+  return { meta, body };
+}
+
+function getHeadingTitle(markdownBody) {
+  if (!markdownBody) return "";
+  for (const line of markdownBody.split("\n")) {
+    const trimmed = line.trim();
+    if (trimmed.startsWith("# ")) {
+      return trimmed.slice(2).trim();
+    }
+  }
+  return "";
+}
+
+function formatSegmentLabel(segment) {
+  if (!segment) return "";
+  const cleaned = segment.replace(/[-_]+/g, " ").trim();
+  if (!cleaned) return "";
+  return cleaned
+    .split(/\s+/)
+    .map((part) => part.charAt(0).toUpperCase() + part.slice(1))
+    .join(" ");
+}
+
+function buildBreadcrumbFromPath(relativePath) {
+  const normalized = relativePath.replace(/\\/g, "/");
+  const directory = normalized.includes("/") ? normalized.slice(0, normalized.lastIndexOf("/")) : "";
+  if (!directory) return "";
+  const segments = directory.split("/").filter(Boolean).map(formatSegmentLabel).filter(Boolean);
+  return segments.join(" > ");
+}
+
+function collectMarkdownFiles(rootDir, options = {}) {
+  const files = [];
+  const excludeDirs = new Set(options.excludeDirs || []);
+  const excludeFiles = new Set(options.excludeFiles || []);
+  const includeDirNames = new Set(options.includeDirNames || []);
+
+  function walk(dir) {
+    if (!existsSync(dir)) return;
+    for (const entry of readdirSync(dir, { withFileTypes: true })) {
+      if (entry.name.startsWith(".") && !includeDirNames.has(entry.name)) continue;
+      if (entry.isDirectory()) {
+        if (excludeDirs.has(entry.name)) continue;
+        walk(join(dir, entry.name));
+        continue;
+      }
+      if (entry.isFile() && entry.name.toLowerCase().endsWith(".md")) {
+        if (excludeFiles.has(entry.name)) continue;
+        files.push(join(dir, entry.name));
+      }
+    }
+  }
+
+  walk(rootDir);
+  return files.sort();
+}
+
+function markdownPathToUrl(baseUrl, relativePath) {
+  const normalized = relativePath.replace(/\\/g, "/").replace(/\.md$/i, ".html");
+  return `${baseUrl}${normalized}`;
+}
+
+function loadMarkdownDocs({ rootDir, urlBase, includeDirNames = [], excludeDirs = [], excludeFiles = [] }) {
+  if (!existsSync(rootDir)) return { articles: [] };
+
+  const files = collectMarkdownFiles(rootDir, { includeDirNames, excludeDirs, excludeFiles });
+  const articles = [];
+
+  for (const filePath of files) {
+    const relativePath = relative(rootDir, filePath).replace(/\\/g, "/");
+    const raw = readFileSync(filePath, "utf8");
+    const parsed = parseFrontMatter(raw);
+    const title = parsed.meta.title || getHeadingTitle(parsed.body) || formatSegmentLabel(relativePath.replace(/\.md$/i, "").split("/").pop());
+    if (!title) continue;
+    const breadcrumb = parsed.meta.breadcrumbText || buildBreadcrumbFromPath(relativePath) || title;
+    articles.push({
+      title,
+      url: markdownPathToUrl(urlBase, relativePath),
+      content: parsed.body.trim(),
+      breadcrumb,
+      path: relativePath
+    });
+  }
+
+  return { articles };
+}
+
+export {
+  loadMarkdownDocs
+};

package/src/resource-index/paths.js

@@ -0,0 +1,98 @@
+import { existsSync, readFileSync, statSync } from "node:fs";
+import { dirname, join, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+import { DOC_DIRS, SAMPLE_DIRS } from "./config.js";
+import { getResolvedDataRoot } from "../data-root.js";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const projectRoot = join(__dirname, "..", "..");
+
+const dataRoot = getResolvedDataRoot();
+const metadataRoot = join(dataRoot, "metadata");
+const samplesRoot = join(dataRoot, "samples");
+const docsRoot = join(dataRoot, "documentation");
+
+const registryPath = join(metadataRoot, "dynamsoft_sdks.json");
+
+const SAMPLE_ROOTS = {
+  dbrWeb: join(samplesRoot, SAMPLE_DIRS.dbrWeb),
+  dbrMobile: join(samplesRoot, SAMPLE_DIRS.dbrMobile),
+  dbrPython: join(samplesRoot, SAMPLE_DIRS.dbrPython),
+  dbrDotnet: join(samplesRoot, SAMPLE_DIRS.dbrDotnet),
+  dbrJava: join(samplesRoot, SAMPLE_DIRS.dbrJava),
+  dbrCpp: join(samplesRoot, SAMPLE_DIRS.dbrCpp),
+  dbrMaui: join(samplesRoot, SAMPLE_DIRS.dbrMaui),
+  dbrReactNative: join(samplesRoot, SAMPLE_DIRS.dbrReactNative),
+  dbrFlutter: join(samplesRoot, SAMPLE_DIRS.dbrFlutter),
+  dbrNodejs: join(samplesRoot, SAMPLE_DIRS.dbrNodejs),
+  dcvWeb: join(samplesRoot, SAMPLE_DIRS.dcvWeb),
+  dcvMobile: join(samplesRoot, SAMPLE_DIRS.dcvMobile),
+  dcvPython: join(samplesRoot, SAMPLE_DIRS.dcvPython),
+  dcvDotnet: join(samplesRoot, SAMPLE_DIRS.dcvDotnet),
+  dcvJava: join(samplesRoot, SAMPLE_DIRS.dcvJava),
+  dcvCpp: join(samplesRoot, SAMPLE_DIRS.dcvCpp),
+  dcvMaui: join(samplesRoot, SAMPLE_DIRS.dcvMaui),
+  dcvReactNative: join(samplesRoot, SAMPLE_DIRS.dcvReactNative),
+  dcvFlutter: join(samplesRoot, SAMPLE_DIRS.dcvFlutter),
+  dcvNodejs: join(samplesRoot, SAMPLE_DIRS.dcvNodejs),
+  dcvSpm: join(samplesRoot, SAMPLE_DIRS.dcvSpm),
+  dwt: join(samplesRoot, SAMPLE_DIRS.dwt),
+  ddv: join(samplesRoot, SAMPLE_DIRS.ddv)
+};
+
+const DOC_ROOTS = {
+  dbrWeb: join(docsRoot, DOC_DIRS.dbrWeb),
+  dbrMobile: join(docsRoot, DOC_DIRS.dbrMobile),
+  dbrServer: join(docsRoot, DOC_DIRS.dbrServer),
+  dcvWeb: join(docsRoot, DOC_DIRS.dcvWeb),
+  dcvMobile: join(docsRoot, DOC_DIRS.dcvMobile),
+  dcvServer: join(docsRoot, DOC_DIRS.dcvServer),
+  dcvCore: join(docsRoot, DOC_DIRS.dcvCore),
+  dwt: join(docsRoot, DOC_DIRS.dwt),
+  dwtArticles: join(docsRoot, DOC_DIRS.dwt, "_articles"),
+  ddv: join(docsRoot, DOC_DIRS.ddv)
+};
+
+function getExistingPath(...candidates) {
+  for (const candidate of candidates) {
+    if (candidate && existsSync(candidate)) return candidate;
+  }
+  return null;
+}
+
+function readSubmoduleHead(repoPath) {
+  try {
+    const gitMarker = join(repoPath, ".git");
+    if (!existsSync(gitMarker)) return "";
+    let gitDir = gitMarker;
+    const markerStats = statSync(gitMarker);
+    if (!markerStats.isDirectory()) {
+      const markerText = readFileSync(gitMarker, "utf8").trim();
+      if (!markerText.toLowerCase().startsWith("gitdir:")) return "";
+      const relGitDir = markerText.slice("gitdir:".length).trim();
+      gitDir = resolve(repoPath, relGitDir);
+    }
+    const headPath = join(gitDir, "HEAD");
+    if (!existsSync(headPath)) return "";
+    const headText = readFileSync(headPath, "utf8").trim();
+    if (!headText.startsWith("ref:")) return headText;
+    const refPath = join(gitDir, headText.slice("ref:".length).trim());
+    if (!existsSync(refPath)) return "";
+    return readFileSync(refPath, "utf8").trim();
+  } catch {
+    return "";
+  }
+}
+
+export {
+  projectRoot,
+  dataRoot,
+  metadataRoot,
+  samplesRoot,
+  docsRoot,
+  registryPath,
+  SAMPLE_ROOTS,
+  DOC_ROOTS,
+  getExistingPath,
+  readSubmoduleHead
+};