occt-gltf-addon 0.1.13 → 0.1.14

package/CMakeLists.txt

@@ -127,7 +127,17 @@ add_library(${PROJECT_NAME} SHARED
 )
 
 # --- Optional: Draco (KHR_draco_mesh_compression) ---
-option(OCCT_GLTF_ADDON_ENABLE_DRACO "Enable Draco mesh compression support" ON)
+# Default to OFF to avoid linking native Draco (which may require newer glibc).
+option(OCCT_GLTF_ADDON_ENABLE_DRACO "Enable Draco mesh compression support" OFF)
+if(DEFINED ENV{OCCT_GLTF_ADDON_ENABLE_DRACO})
+  string(TOLOWER "$ENV{OCCT_GLTF_ADDON_ENABLE_DRACO}" _draco_env)
+  if(_draco_env STREQUAL "1" OR _draco_env STREQUAL "on" OR _draco_env STREQUAL "true" OR _draco_env STREQUAL "yes")
+    set(OCCT_GLTF_ADDON_ENABLE_DRACO ON CACHE BOOL "Enable Draco mesh compression support" FORCE)
+  else()
+    set(OCCT_GLTF_ADDON_ENABLE_DRACO OFF CACHE BOOL "Enable Draco mesh compression support" FORCE)
+  endif()
+endif()
+
 if(OCCT_GLTF_ADDON_ENABLE_DRACO)
   if(DEFINED ENV{DRACO_ROOT} AND NOT "$ENV{DRACO_ROOT}" STREQUAL "")
     set(DRACO_ROOT "$ENV{DRACO_ROOT}" CACHE PATH "Draco install prefix" FORCE)

package/README.md

@@ -45,6 +45,12 @@ await convertSTEPToGLTF({
 export OCCT_GLTF_ADDON_PREBUILT_BASE_URL=https://cdn2-1304552240.cos.ap-shanghai.myqcloud.com/libs/occt/
 ```
 
+运行时自检（兼容安装脚本被禁用的场景）：
+- 首次调用时若本地没有对应 `prebuilt/<platform>-<arch>/`，会尝试在运行时下载预编译包并缓存（优先写入包内 `node_modules/occt-gltf-addon/prebuilt/`，不可写时回退到 `/tmp/occt-gltf-addon/prebuilt`）。
+- 可设置 `OCCT_GLTF_ADDON_RUNTIME_DOWNLOAD=0` 关闭运行时下载。
+- 可设置 `OCCT_GLTF_ADDON_PREBUILT_CACHE_DIR=/tmp/occt-gltf-addon/prebuilt` 自定义缓存目录。
+- 可设置 `OCCT_GLTF_ADDON_PREBUILT_ROOT` 或 `OCCT_GLTF_ADDON_PREBUILT_DIR` 指定本地预编译包位置。
+
 本地编译时通过环境变量指定 OCCT 安装前缀：
 
 ```bash
@@ -70,8 +76,9 @@ OCCT_GLTF_ADDON_SKIP_BUILD=1 npm i occt-gltf-addon
 OCCT_GLTF_ADDON_SKIP_DOWNLOAD=1 npm i occt-gltf-addon
 ```
 
-Draco（仅源码编译时启用，需要开发包）：
-- `brew install draco` / `apt-get install libdraco-dev`
+Draco（Node.js 层压缩，避免原生依赖）：
+- 默认不链接原生 Draco；当设置 `output.draco` 时，会在 JS 层使用 `gltf-pipeline` + `draco3d` 压缩。
+- 如需恢复原生 Draco（可能引入 glibc 兼容问题），构建时设置：`OCCT_GLTF_ADDON_ENABLE_DRACO=1`
 
 ---
 
@@ -104,7 +111,7 @@ Draco（仅源码编译时启用，需要开发包）：
 - `bakeTransforms`：烘焙节点变换到顶点
 - `center`：`'none'|'xy'|'xz'|'yz'`（配合 bake 使用）
 - `zUp`：导出为 Z-up 坐标（非标准 glTF）
-- `draco`：`boolean | { enabled, compressionLevel, quantizationBitsPosition, quantizationBitsNormal }`
+- `draco`：`boolean | { enabled, compressionLevel, quantizationBitsPosition, quantizationBitsNormal }`（Node.js 层 Draco 压缩）
 
 ---
 

package/example.js

@@ -40,8 +40,8 @@ async function main() {
     // If your runtime uses Z-up world (e.g. three.js: THREE.Object3D.DEFAULT_UP.set(0,0,1)),
     // enable this to export Z-up coordinates (note: non-standard glTF; Y-up viewers may show it rotated).
     zUp: true,
-    // Draco (KHR_draco_mesh_compression). NOTE: some importers (e.g. Blender) may not support Draco.
-    // draco: { enabled: true, compressionLevel: 7, quantizationBitsPosition: 14, quantizationBitsNormal: 10 },
+    // Draco (KHR_draco_mesh_compression) is applied in JS after conversion to avoid native deps.
+    // NOTE: some importers (e.g. Blender) may not support Draco.
     draco: {
       enabled: true,
       compressionLevel: 7,           // 0..10 (越大越小/越慢)

package/index.js

@@ -1,6 +1,10 @@
 // CommonJS entrypoint. cmake-js outputs: build/<Config>/<target>.node
 const fs = require('fs');
+const http = require('http');
+const https = require('https');
+const os = require('os');
 const path = require('path');
+const tar = require('tar');
 
 function prependEnvPath(key, dir) {
   if (!dir) return;
@@ -41,12 +45,100 @@ function setOcctResourceEnv(resRoot) {
   setIfEmpty('CSF_MIGRATION_TYPES', path.join(R, 'StdResource', 'MigrationSheet.txt'));
 }
 
+function normalizeBaseUrl(base) {
+  if (!base) return '';
+  return base.endsWith('/') ? base : `${base}/`;
+}
+
+function getPrebuiltUrl(tag, version) {
+  const base =
+    process.env.OCCT_GLTF_ADDON_PREBUILT_BASE_URL ||
+    'https://cdn2-1304552240.cos.ap-shanghai.myqcloud.com/libs/occt/';
+  const normalized = normalizeBaseUrl(base);
+  return `${normalized}occt-gltf-addon-${version}-${tag}.tgz`;
+}
+
+function getPackageVersion() {
+  try {
+    const pkg = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'), 'utf8'));
+    return pkg.version || '0.0.0';
+  } catch (e) {
+    return '0.0.0';
+  }
+}
+
+function isWritableDir(dir) {
+  try {
+    fs.mkdirSync(dir, { recursive: true });
+    fs.accessSync(dir, fs.constants.W_OK);
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+
+function resolvePrebuiltDirCandidates(baseDir, tag) {
+  if (!baseDir) return [];
+  const candidates = [baseDir];
+  if (path.basename(baseDir) !== tag) {
+    candidates.push(path.join(baseDir, tag));
+  }
+  return candidates;
+}
+
+function getPrebuiltSearchDirs(tag) {
+  const dirs = [];
+  const fromDir = process.env.OCCT_GLTF_ADDON_PREBUILT_DIR;
+  const fromRoot = process.env.OCCT_GLTF_ADDON_PREBUILT_ROOT;
+  const cacheRoot =
+    process.env.OCCT_GLTF_ADDON_PREBUILT_CACHE_DIR ||
+    path.join(os.tmpdir(), 'occt-gltf-addon', 'prebuilt');
+
+  resolvePrebuiltDirCandidates(fromDir, tag).forEach((d) => dirs.push(d));
+  if (fromRoot) dirs.push(path.join(fromRoot, tag));
+  dirs.push(path.join(cacheRoot, tag));
+  dirs.push(path.join(__dirname, 'prebuilt', tag));
+
+  return [...new Set(dirs)];
+}
+
+function resolveDownloadPrebuiltDir(tag) {
+  const candidates = [];
+  const fromDir = process.env.OCCT_GLTF_ADDON_PREBUILT_DIR;
+  const fromRoot = process.env.OCCT_GLTF_ADDON_PREBUILT_ROOT;
+  const cacheRoot =
+    process.env.OCCT_GLTF_ADDON_PREBUILT_CACHE_DIR ||
+    path.join(os.tmpdir(), 'occt-gltf-addon', 'prebuilt');
+
+  resolvePrebuiltDirCandidates(fromDir, tag).forEach((d) => candidates.push(d));
+  if (fromRoot) candidates.push(path.join(fromRoot, tag));
+  candidates.push(path.join(__dirname, 'prebuilt', tag));
+  candidates.push(path.join(cacheRoot, tag));
+
+  for (const dir of candidates) {
+    if (isWritableDir(dir)) return dir;
+  }
+
+  return path.join(cacheRoot, tag);
+}
+
+function findPrebuiltNode(tag) {
+  const candidates = getPrebuiltSearchDirs(tag);
+  for (const prebuiltDir of candidates) {
+    const prebuiltNode = path.join(prebuiltDir, 'occt_gltf_addon.node');
+    if (fs.existsSync(prebuiltNode)) {
+      return { prebuiltDir, prebuiltNode };
+    }
+  }
+  return null;
+}
+
 function tryLoadPrebuilt() {
   if (process.env.OCCT_GLTF_ADDON_BINDING_PATH) return null;
   const tag = `${process.platform}-${process.arch}`;
-  const prebuiltDir = path.join(__dirname, 'prebuilt', tag);
-  const prebuiltNode = path.join(prebuiltDir, 'occt_gltf_addon.node');
-  if (!fs.existsSync(prebuiltNode)) return null;
+  const found = findPrebuiltNode(tag);
+  if (!found) return null;
+  const { prebuiltDir, prebuiltNode } = found;
 
   const libDir = path.join(prebuiltDir, 'lib');
   const resDir = path.join(prebuiltDir, 'resources');
@@ -76,44 +168,224 @@ function tryLoadPrebuilt() {
   return require(prebuiltNode);
 }
 
-const prebuilt = tryLoadPrebuilt();
-if (prebuilt) {
-  module.exports = prebuilt;
-  return;
+function downloadFile(url, dest) {
+  return new Promise((resolve, reject) => {
+    const client = url.startsWith('https:') ? https : http;
+    const req = client.get(url, (res) => {
+      if (res.statusCode >= 300 && res.statusCode < 400 && res.headers.location) {
+        downloadFile(res.headers.location, dest).then(resolve).catch(reject);
+        return;
+      }
+      if (res.statusCode !== 200) {
+        reject(new Error(`Download failed with status ${res.statusCode}`));
+        res.resume();
+        return;
+      }
+      const file = fs.createWriteStream(dest);
+      res.pipe(file);
+      file.on('finish', () => file.close(resolve));
+      file.on('error', reject);
+    });
+    req.on('error', reject);
+  });
 }
 
-const overridePath = process.env.OCCT_GLTF_ADDON_BINDING_PATH;
-const candidates = overridePath
-  ? [overridePath]
-  : [
-      path.join(__dirname, 'build', 'Release', 'occt_gltf_addon.node'),
-      path.join(__dirname, 'build', 'RelWithDebInfo', 'occt_gltf_addon.node'),
-      path.join(__dirname, 'build', 'Debug', 'occt_gltf_addon.node'),
-    ];
+async function ensurePrebuiltDownloaded(tag) {
+  if (process.env.OCCT_GLTF_ADDON_SKIP_DOWNLOAD === '1') return null;
+  if (process.env.OCCT_GLTF_ADDON_RUNTIME_DOWNLOAD === '0') return null;
+
+  const existing = findPrebuiltNode(tag);
+  if (existing) return existing.prebuiltDir;
 
-let lastErr = null;
-for (const p of candidates) {
+  const prebuiltDir = resolveDownloadPrebuiltDir(tag);
+  const parentDir = path.dirname(prebuiltDir);
+  const prebuiltNode = path.join(prebuiltDir, 'occt_gltf_addon.node');
+
+  if (fs.existsSync(prebuiltNode)) return prebuiltDir;
+
+  const version = getPackageVersion();
+  const url = getPrebuiltUrl(tag, version);
+  const tgzPath = path.join(parentDir, `prebuilt-${tag}.tgz`);
+
+  fs.mkdirSync(prebuiltDir, { recursive: true });
   try {
-    if (!fs.existsSync(p)) continue;
-    // eslint-disable-next-line import/no-dynamic-require, global-require
-    module.exports = require(p);
-    return;
+    await downloadFile(url, tgzPath);
+    await tar.x({ file: tgzPath, cwd: prebuiltDir });
+    fs.rmSync(tgzPath, { force: true });
+    return prebuiltDir;
   } catch (e) {
-    lastErr = e;
+    fs.rmSync(tgzPath, { force: true });
+    return null;
   }
 }
 
-const msg = [
-  '[occt-gltf-addon] Failed to load native addon (.node).',
-  `Tried: ${candidates.map((p) => JSON.stringify(p)).join(', ')}`,
-  '',
-  'If you installed from npm:',
-  '- This package bundles prebuilt binaries under `prebuilt/<platform>-<arch>/` for supported platforms.',
-  '- If prebuilt is missing for your platform, build from source with OCCT_ROOT set.',
-  '',
-  "You can try: 'npm rebuild occt-gltf-addon' (with OCCT_ROOT exported).",
-].join('\n');
+function loadNativeAddon() {
+  const prebuilt = tryLoadPrebuilt();
+  if (prebuilt) return prebuilt;
+
+  const overridePath = process.env.OCCT_GLTF_ADDON_BINDING_PATH;
+  const candidates = overridePath
+    ? [overridePath]
+    : [
+        path.join(__dirname, 'build', 'Release', 'occt_gltf_addon.node'),
+        path.join(__dirname, 'build', 'RelWithDebInfo', 'occt_gltf_addon.node'),
+        path.join(__dirname, 'build', 'Debug', 'occt_gltf_addon.node'),
+      ];
+
+  let lastErr = null;
+  for (const p of candidates) {
+    try {
+      if (!fs.existsSync(p)) continue;
+      // eslint-disable-next-line import/no-dynamic-require, global-require
+      return require(p);
+    } catch (e) {
+      lastErr = e;
+    }
+  }
+
+  const msg = [
+    '[occt-gltf-addon] Failed to load native addon (.node).',
+    `Tried: ${candidates.map((p) => JSON.stringify(p)).join(', ')}`,
+    '',
+    'If you installed from npm:',
+    '- This package bundles prebuilt binaries under `prebuilt/<platform>-<arch>/` for supported platforms.',
+    '- If prebuilt is missing for your platform, build from source with OCCT_ROOT set.',
+    '',
+    "You can try: 'npm rebuild occt-gltf-addon' (with OCCT_ROOT exported).",
+  ].join('\n');
+
+  // Preserve original error for debugging.
+  throw new Error(`${msg}\n\n${String(lastErr && (lastErr.stack || lastErr.message || lastErr))}`);
+}
+
+function normalizeDracoOptions(draco) {
+  if (draco == null) return null;
+  if (typeof draco === 'boolean') return draco ? {} : null;
+  if (typeof draco !== 'object') return null;
+  if (draco.enabled === false) return null;
+  return { ...draco, enabled: true };
+}
+
+function stripDraco(output) {
+  if (!output || typeof output !== 'object') return output;
+  const { draco, ...rest } = output;
+  return rest;
+}
+
+function splitDracoOptions(options) {
+  const dracoJobs = [];
+  if (!options || typeof options !== 'object') {
+    return { nativeOptions: options, dracoJobs };
+  }
+
+  if (Array.isArray(options.variants) && options.variants.length > 0) {
+    const variants = options.variants.map((variant) => {
+      if (!variant || typeof variant !== 'object') return variant;
+      const draco = normalizeDracoOptions(variant.output && variant.output.draco);
+      if (!draco) return variant;
+      if (!variant.outputPath) {
+        throw new Error('[occt-gltf-addon] outputPath is required for Draco compression (variant).');
+      }
+      dracoJobs.push({ outputPath: variant.outputPath, draco });
+      return { ...variant, output: stripDraco(variant.output) };
+    });
+    return { nativeOptions: { ...options, variants }, dracoJobs };
+  }
+
+  const draco = normalizeDracoOptions(options.output && options.output.draco);
+  if (!draco) {
+    return { nativeOptions: options, dracoJobs };
+  }
+  if (!options.outputPath) {
+    throw new Error('[occt-gltf-addon] outputPath is required for Draco compression.');
+  }
+  dracoJobs.push({ outputPath: options.outputPath, draco });
+  return { nativeOptions: { ...options, output: stripDraco(options.output) }, dracoJobs };
+}
+
+function toGltfPipelineDracoOptions(draco) {
+  const options = {};
+  if (!draco || typeof draco !== 'object') return options;
+  if (typeof draco.compressionLevel === 'number') {
+    options.compressionLevel = draco.compressionLevel;
+  }
+  if (typeof draco.quantizationBitsPosition === 'number') {
+    options.quantizePositionBits = draco.quantizationBitsPosition;
+  }
+  if (typeof draco.quantizationBitsNormal === 'number') {
+    options.quantizeNormalBits = draco.quantizationBitsNormal;
+  }
+  return options;
+}
+
+async function compressGlbWithDraco({ outputPath, draco }) {
+  if (!outputPath) {
+    throw new Error('[occt-gltf-addon] Draco compression requires outputPath.');
+  }
+
+  let gltfPipeline;
+  try {
+    // eslint-disable-next-line global-require
+    gltfPipeline = require('gltf-pipeline');
+  } catch (e) {
+    throw new Error(
+      `[occt-gltf-addon] Draco compression requested but "gltf-pipeline" is not installed.\n` +
+        "Install it with: npm i gltf-pipeline",
+    );
+  }
+
+  const input = await fs.promises.readFile(outputPath);
+  const result = await gltfPipeline.processGlb(input, {
+    dracoOptions: toGltfPipelineDracoOptions(draco),
+  });
+
+  if (!result || !result.glb) {
+    throw new Error('[occt-gltf-addon] Draco compression failed: empty output.');
+  }
+
+  await fs.promises.writeFile(outputPath, result.glb);
+}
+
+async function runNodeDracoCompression(jobs) {
+  for (const job of jobs) {
+    // eslint-disable-next-line no-await-in-loop
+    await compressGlbWithDraco(job);
+  }
+}
+
+function wrapNative(native) {
+  if (!native || typeof native.convertSTEPToGLTF !== 'function') return native;
+  const convert = native.convertSTEPToGLTF.bind(native);
+  return {
+    ...native,
+    convertSTEPToGLTF: async (options) => {
+      const { nativeOptions, dracoJobs } = splitDracoOptions(options || {});
+      await convert(nativeOptions);
+      if (dracoJobs.length > 0) {
+        await runNodeDracoCompression(dracoJobs);
+      }
+    },
+  };
+}
+
+let wrappedNativePromise = null;
+
+async function getWrappedNative() {
+  if (!wrappedNativePromise) {
+    wrappedNativePromise = (async () => {
+      const tag = `${process.platform}-${process.arch}`;
+      await ensurePrebuiltDownloaded(tag);
+      const native = loadNativeAddon();
+      return wrapNative(native);
+    })();
+  }
+  return wrappedNativePromise;
+}
 
-// Preserve original error for debugging.
-throw new Error(`${msg}\n\n${String(lastErr && (lastErr.stack || lastErr.message || lastErr))}`);
+module.exports = {
+  convertSTEPToGLTF: async (options) => {
+    const native = await getWrappedNative();
+    return native.convertSTEPToGLTF(options);
+  },
+};
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "occt-gltf-addon",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "description": "STEP (.step/.stp) to glTF (GLB) converter using OpenCascade (OCCT) via a Node.js N-API addon",
   "type": "commonjs",
   "main": "index.js",
@@ -70,6 +70,7 @@
   },
   "dependencies": {
     "cmake-js": "^7.3.1",
+    "gltf-pipeline": "^4.3.0",
     "node-addon-api": "^7.1.0",
     "tar": "^7.4.0"
   },