npm - @cadcrawl/cad-browser - Versions diffs - 0.3.0 - Mend

@cadcrawl/cad-browser 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

package/LICENSE.md +5 -0
package/README.md +65 -0
package/bin/cad-browser +4 -0
package/dist/client/assets/index-C1XW2UmF.css +1 -0
package/dist/client/assets/index-HFIcPO3j.js +204 -0
package/dist/client/index.html +14 -0
package/package.json +62 -0
package/src/analyzer.js +31 -0
package/src/args.js +16 -0
package/src/cache.js +38 -0
package/src/cli.js +53 -0
package/src/file-types.js +15 -0
package/src/main.jsx +567 -0
package/src/path-safety.js +15 -0
package/src/project-store.js +127 -0
package/src/reveal-file.js +36 -0
package/src/scanner.js +75 -0
package/src/server.js +103 -0
package/src/styles.css +435 -0

package/dist/client/index.html ADDED Viewed

@@ -0,0 +1,14 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <meta name="theme-color" content="#f5f3ee" />
+    <title>CAD Browser</title>
+    <script type="module" crossorigin src="/assets/index-HFIcPO3j.js"></script>
+    <link rel="stylesheet" crossorigin href="/assets/index-C1XW2UmF.css">
+  </head>
+  <body>
+    <div id="root"></div>
+  </body>
+</html>

package/package.json ADDED Viewed

@@ -0,0 +1,62 @@
+{
+  "name": "@cadcrawl/cad-browser",
+  "version": "0.3.0",
+  "description": "Local engineering file browser with CAD and PDF previews powered by cad-toolbox.",
+  "type": "module",
+  "license": "PolyForm-Noncommercial-1.0.0",
+  "homepage": "https://github.com/art22017/cadcrawl/tree/master/cad-browser#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/art22017/cadcrawl.git",
+    "directory": "cad-browser"
+  },
+  "bugs": {
+    "url": "https://github.com/art22017/cadcrawl/issues"
+  },
+  "keywords": [
+    "cad",
+    "step",
+    "stl",
+    "3mf",
+    "pdf",
+    "engineering",
+    "file-browser",
+    "preview"
+  ],
+  "bin": {
+    "cad-browser": "bin/cad-browser"
+  },
+  "files": [
+    "bin/",
+    "dist/",
+    "src/",
+    "README.md",
+    "LICENSE.md",
+    "package.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite",
+    "start": "node bin/cad-browser",
+    "test": "node --test",
+    "prepublishOnly": "npm run test && npm run build"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@cadcrawl/cad-toolbox": "^0.3.0",
+    "express": "^5.1.0",
+    "open": "^10.2.0"
+  },
+  "devDependencies": {
+    "@vitejs/plugin-react": "^4.6.0",
+    "lucide-react": "^0.468.0",
+    "vite": "^6.1.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  }
+}

package/src/analyzer.js ADDED Viewed

@@ -0,0 +1,31 @@
+import { inspectFile } from '@cadcrawl/cad-toolbox/src/inspect.js';
+import { CAD_VIEW_DIRECTIONS } from '@cadcrawl/cad-toolbox/src/render-options.js';
+import { renderStem } from './cache.js';
+export async function analyzeFile(absolutePath, relativePath, cache, kind) {
+  const fields = new Set(['metadata', 'renders']);
+  if (kind === 'cad' && /\.(step|stp)$/i.test(relativePath)) fields.add('tree');
+  if (kind === 'pdf') fields.add('text');
+  const options = {
+    width: 1200,
+    height: 900,
+    outputDir: cache.rendersDirectory,
+    output: null,
+    outputStem: renderStem(relativePath),
+    views: [{ name: 'iso-front', direction: CAD_VIEW_DIRECTIONS['iso-front'] }],
+    page: 1,
+    pages: null,
+    background: { r: 247, g: 246, b: 242 },
+    edgeOutline: true,
+    fullText: false,
+  };
+  const result = await inspectFile(absolutePath, fields, options);
+  return {
+    metadata: result.metadata ?? null,
+    tree: result.tree ?? null,
+    text: result.text ?? null,
+    previewPath: result.renders?.[0] ?? null,
+  };
+}

package/src/args.js ADDED Viewed

@@ -0,0 +1,16 @@
+export function parseArgs(argv) {
+  const options = { port: 6767, open: true, host: '127.0.0.1', directory: '.' };
+  for (let index = 0; index < argv.length; index += 1) {
+    const value = argv[index];
+    if (value === '--help' || value === '-h') options.help = true;
+    else if (value === '--no-open') options.open = false;
+    else if (value === '--port') options.port = Number(argv[++index]);
+    else if (value === '--host') options.host = argv[++index];
+    else if (!value.startsWith('-')) options.directory = value;
+    else throw new Error(`Unknown option: ${value}`);
+  }
+  if (!Number.isInteger(options.port) || options.port < 1 || options.port > 65535) {
+    throw new Error('Port must be an integer between 1 and 65535');
+  }
+  return options;
+}

package/src/cache.js ADDED Viewed

@@ -0,0 +1,38 @@
+import crypto from 'node:crypto';
+import fs from 'node:fs/promises';
+import os from 'node:os';
+import path from 'node:path';
+export async function createProjectCache(rootPath) {
+  const projectId = crypto.createHash('sha256').update(rootPath.toLowerCase()).digest('hex').slice(0, 20);
+  const directory = path.join(os.homedir(), '.cadcrawl', 'cad-browser', 'projects', projectId);
+  const rendersDirectory = path.join(directory, 'renders');
+  await fs.mkdir(rendersDirectory, { recursive: true });
+  return {
+    directory,
+    rendersDirectory,
+    indexPath: path.join(directory, 'index.json'),
+  };
+}
+export async function readCache(cache) {
+  try {
+    return JSON.parse(await fs.readFile(cache.indexPath, 'utf8'));
+  } catch {
+    return { version: 1, files: {} };
+  }
+}
+export async function writeCache(cache, value) {
+  const temporaryPath = `${cache.indexPath}.tmp`;
+  await fs.writeFile(temporaryPath, JSON.stringify(value, null, 2));
+  await fs.rename(temporaryPath, cache.indexPath);
+}
+export function renderStem(relativePath) {
+  const hash = crypto.createHash('sha1').update(relativePath).digest('hex').slice(0, 10);
+  const base = path.basename(relativePath, path.extname(relativePath))
+    .replace(/[^\p{L}\p{N}._-]+/gu, '-')
+    .slice(0, 60);
+  return `${base || 'asset'}-${hash}`;
+}

package/src/cli.js ADDED Viewed

@@ -0,0 +1,53 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import open from 'open';
+import { parseArgs } from './args.js';
+import { ProjectStore } from './project-store.js';
+import { createServer } from './server.js';
+const HELP = `cad-browser
+Browse an engineering project with local CAD/PDF previews and metadata.
+USAGE
+  npx @cadcrawl/cad-browser [directory] [options]
+OPTIONS
+  --port <number>  Local port, default 6767
+  --host <address> Bind address, default 127.0.0.1
+  --no-open        Do not open the browser automatically
+  --help           Show this help
+EXAMPLES
+  npx @cadcrawl/cad-browser
+  npx @cadcrawl/cad-browser C:\\engineering\\project
+  npx @cadcrawl/cad-browser . --port 6767 --no-open
+`;
+export async function run(argv) {
+  try {
+    const options = parseArgs(argv);
+    if (options.help) {
+      process.stdout.write(HELP);
+      return;
+    }
+    const rootPath = path.resolve(options.directory);
+    const stat = await fs.stat(rootPath);
+    if (!stat.isDirectory()) throw new Error(`Not a directory: ${rootPath}`);
+    const store = new ProjectStore(rootPath);
+    await store.initialize();
+    const app = await createServer(store);
+    const server = app.listen(options.port, options.host, async () => {
+      const url = `http://${options.host}:${options.port}`;
+      process.stdout.write(`CAD Browser\n${rootPath}\n${url}\n`);
+      if (options.open) await open(url);
+    });
+    const close = () => server.close(() => process.exit(0));
+    process.on('SIGINT', close);
+    process.on('SIGTERM', close);
+  } catch (error) {
+    process.stderr.write(`cad-browser: ${error instanceof Error ? error.message : String(error)}\n`);
+    process.exitCode = 1;
+  }
+}

package/src/file-types.js ADDED Viewed

@@ -0,0 +1,15 @@
+export const CAD_EXTENSIONS = new Set(['.step', '.stp', '.stl', '.3mf']);
+export const PDF_EXTENSIONS = new Set(['.pdf']);
+export const IMAGE_EXTENSIONS = new Set(['.png', '.jpg', '.jpeg', '.webp', '.gif', '.bmp', '.svg']);
+export function classifyExtension(extension) {
+  const normalized = extension.toLowerCase();
+  if (CAD_EXTENSIONS.has(normalized)) return 'cad';
+  if (PDF_EXTENSIONS.has(normalized)) return 'pdf';
+  if (IMAGE_EXTENSIONS.has(normalized)) return 'image';
+  return 'file';
+}
+export function canAnalyze(extension) {
+  return CAD_EXTENSIONS.has(extension.toLowerCase()) || PDF_EXTENSIONS.has(extension.toLowerCase());
+}