node-plantuml-2 1.1.3 → 1.1.5

package/lib/dot-resolver.js

@@ -24,18 +24,59 @@ function resolveBundledGraphviz () {
     // Try to resolve the package
     var pkgPath
     try {
-      // Try to require.resolve the package
+      // Method 1: Try require.resolve (works in most cases, including external projects)
       var pkgJsonPath = require.resolve(pkgName + '/package.json')
       pkgPath = path.dirname(pkgJsonPath)
     } catch (e) {
-      // Package might not be installed (optional dependency)
-      // Try to find it in node_modules relative to this package
-      var thisPkgPath = path.join(__dirname, '..')
-      var possiblePath = path.join(thisPkgPath, 'node_modules', pkgName)
-      if (fs.existsSync(path.join(possiblePath, 'package.json'))) {
-        pkgPath = possiblePath
-      } else {
-        return null
+      // Method 2: Package might not be installed (optional dependency)
+      // Try to find it by locating node-plantuml-2 package first, then look in its parent node_modules
+      try {
+        // Find where node-plantuml-2 is installed
+        var nodePlantumlPath = require.resolve('node-plantuml-2')
+        // Get the node_modules directory that contains node-plantuml-2
+        // node-plantuml-2 is at: .../node_modules/node-plantuml-2/lib/...
+        // So node_modules is at: .../node_modules/
+        var nodeModulesDir = path.dirname(path.dirname(nodePlantumlPath))
+        
+        // For scoped packages like @node-plantuml-2/graphviz-win32-x64,
+        // the path structure is: node_modules/@node-plantuml-2/graphviz-win32-x64/
+        // So we need to handle the @scope/package format
+        var possiblePath = path.join(nodeModulesDir, pkgName)
+        if (fs.existsSync(path.join(possiblePath, 'package.json'))) {
+          pkgPath = possiblePath
+        } else {
+          // Method 3: Try in current package's node_modules (for development)
+          var thisPkgPath = path.join(__dirname, '..')
+          var devPath = path.join(thisPkgPath, 'node_modules', pkgName)
+          if (fs.existsSync(path.join(devPath, 'package.json'))) {
+            pkgPath = devPath
+          } else {
+            // Method 4: Recursive search up the directory tree
+            var currentDir = thisPkgPath
+            var found = false
+            while (currentDir !== path.dirname(currentDir)) {
+              var searchPath = path.join(currentDir, 'node_modules', pkgName)
+              if (fs.existsSync(path.join(searchPath, 'package.json'))) {
+                pkgPath = searchPath
+                found = true
+                break
+              }
+              currentDir = path.dirname(currentDir)
+            }
+            if (!found) {
+              return null
+            }
+          }
+        }
+      } catch (resolveErr) {
+        // If we can't even resolve node-plantuml-2, try local fallback
+        var thisPkgPath = path.join(__dirname, '..')
+        var possiblePath = path.join(thisPkgPath, 'node_modules', pkgName)
+        if (fs.existsSync(path.join(possiblePath, 'package.json'))) {
+          pkgPath = possiblePath
+        } else {
+          return null
+        }
       }
     }
 
@@ -82,14 +123,18 @@ function getBundledGraphvizLibPath (dotPath) {
   }
 
   try {
+    // Normalize path separators for checking
+    var normalizedPath = dotPath.replace(/\\/g, '/')
+    
     // Check if this is a bundled Graphviz path
     // Bundled path format: .../node_modules/@node-plantuml-2/graphviz-*/graphviz/bin/dot
     // Handle both / and \ path separators (Windows uses \)
-    var isBundled = dotPath.includes('@node-plantuml-2/graphviz-') &&
-                    (dotPath.includes('/graphviz/bin/') || dotPath.includes('\\graphviz\\bin\\'))
+    var isBundled = normalizedPath.includes('@node-plantuml-2/graphviz-') &&
+                    normalizedPath.includes('/graphviz/bin/')
     if (isBundled) {
       // Extract the graphviz directory
-      var graphvizDir = path.dirname(path.dirname(dotPath)) // Go up from bin/ to graphviz/
+      // Go up from bin/ to graphviz/
+      var graphvizDir = path.dirname(path.dirname(dotPath))
       var libDir = path.join(graphvizDir, 'lib')
 
       if (fs.existsSync(libDir)) {
@@ -126,20 +171,24 @@ function getGraphvizPackageName (platform, arch) {
 }
 
 /**
- * Resolve Graphviz dot executable path with fallback strategy
+ * Resolve Graphviz dot executable path
  *
  * Priority order:
  * 1. options.dotPath (user-specified)
- * 2. Bundled Graphviz (from optional dependencies)
- * 3. Common installation paths (platform-specific)
- * 4. System 'dot' in PATH (which dot)
+ * 2. Bundled Graphviz (from optional dependencies) - REQUIRED
+ *
+ * NOTE: We ONLY use bundled Graphviz packages. System Graphviz is NOT used.
+ * This ensures consistent behavior across all environments.
  *
  * @param {Object} options - Options object
  * @param {string} options.dotPath - User-specified dot path (highest priority)
+ * @param {boolean} options.allowSystemFallback - If true, allow system Graphviz as fallback (for install scripts only)
  * @returns {string|null} - Path to dot executable, or null if not found
+ * @throws {Error} - If bundled Graphviz is not found and allowSystemFallback is false
  */
 function resolveDotExecutable (options) {
   options = options || {}
+  var allowSystemFallback = options.allowSystemFallback === true
 
   // Priority 1: User-specified dot path
   if (options.dotPath) {
@@ -149,12 +198,42 @@ function resolveDotExecutable (options) {
     }
   }
 
-  // Priority 2: Bundled Graphviz from optional dependencies
+  // Priority 2: Bundled Graphviz from optional dependencies (REQUIRED)
   var bundledGraphviz = resolveBundledGraphviz()
   if (bundledGraphviz) {
     return bundledGraphviz
   }
 
+  // If bundled Graphviz is not found, we should NOT fallback to system
+  // This ensures all users use the same Graphviz version
+  if (!allowSystemFallback) {
+    var platform = os.platform()
+    var arch = os.arch()
+    var pkgName = getGraphvizPackageName(platform, arch)
+    
+    if (pkgName) {
+      throw new Error(
+        'Bundled Graphviz not found. Please install the Graphviz runtime package:\n' +
+        '  npm install ' + pkgName + '\n\n' +
+        'This package should be automatically installed via optionalDependencies.\n' +
+        'If it failed to install, please check:\n' +
+        '  1. Your platform is supported: ' + platform + ' ' + arch + '\n' +
+        '  2. Network connection during npm install\n' +
+        '  3. npm install logs for errors\n\n' +
+        'Alternatively, you can specify a custom Graphviz path:\n' +
+        '  plantuml.generate(code, { dotPath: "/path/to/dot" })'
+      )
+    } else {
+      throw new Error(
+        'Graphviz is required but not available.\n' +
+        'Your platform (' + platform + ' ' + arch + ') is not supported.\n' +
+        'Please install Graphviz manually and specify the path:\n' +
+        '  plantuml.generate(code, { dotPath: "/path/to/dot" })'
+      )
+    }
+  }
+
+  // System fallback (ONLY for install scripts, NOT for runtime)
   // Priority 3: Common installation paths (platform-specific)
   var commonPaths = getCommonDotPaths()
   for (var i = 0; i < commonPaths.length; i++) {

package/lib/node-plantuml.js

@@ -215,11 +215,20 @@ function joinOptions (argv, options) {
     argv.push(file)
   }
 
-  // Auto-detect dot path if not specified
+  // Auto-detect dot path if not specified (ONLY from bundled Graphviz)
   if (!options.dot) {
-    var detectedDot = dotResolver.resolveDotExecutable({ dotPath: null })
-    if (detectedDot) {
-      options.dot = detectedDot
+    try {
+      var detectedDot = dotResolver.resolveDotExecutable({ dotPath: null })
+      if (detectedDot) {
+        options.dot = detectedDot
+      }
+    } catch (err) {
+      // Graphviz is optional for most diagram types
+      // Only required for certain diagram types (e.g., some activity diagrams)
+      // If not found, PlantUML will handle it gracefully
+      if (process.env.DEBUG_PLANTUML) {
+        console.warn('[DEBUG] Graphviz not found, some diagram types may not work:', err.message)
+      }
     }
   }
 
@@ -384,15 +393,34 @@ module.exports.decode = function (encoded, callback) {
 }
 
 module.exports.testdot = function (callback) {
-  // Auto-detect dot path and pass it to PlantUML
-  var detectedDot = dotResolver.resolveDotExecutable({ dotPath: null })
+  // Auto-detect dot path and pass it to PlantUML (ONLY from bundled Graphviz)
+  var detectedDot = null
+  try {
+    detectedDot = dotResolver.resolveDotExecutable({ dotPath: null })
+  } catch (err) {
+    // If bundled Graphviz is not found, return error
+    if (typeof callback === 'function') {
+      return callback(new Error('Graphviz not found: ' + err.message))
+    }
+    throw err
+  }
+  
   var argv = [TESTDOT]
   if (detectedDot) {
+    // Ensure dot path is absolute - PlantUML Java process needs absolute path
+    var absoluteDotPath = path.resolve(detectedDot)
+    // Normalize path separators for the platform
+    if (process.platform === 'win32') {
+      absoluteDotPath = absoluteDotPath.replace(/\//g, '\\')
+    } else {
+      absoluteDotPath = absoluteDotPath.replace(/\\/g, '/')
+    }
     argv.push(DOT)
-    argv.push(detectedDot)
+    argv.push(absoluteDotPath)
   }
 
   // Don't pass callback to exec - we need to handle output ourselves
+  // Pass empty options object to ensure environment variables are set correctly
   var child = plantumlExecutor.exec(argv, undefined, {}, undefined)
 
   var stdoutChunks = []

package/lib/plantuml-executor.js

@@ -102,9 +102,18 @@ function execWithSpawn (argv, cwd, options, cb) {
     }
   }
 
-  // If no dot path in argv, try to detect it
+  // If no dot path in argv, try to detect it (ONLY from bundled Graphviz)
   if (!dotPath) {
-    dotPath = dotResolver.resolveDotExecutable({ dotPath: null })
+    try {
+      dotPath = dotResolver.resolveDotExecutable({ dotPath: null })
+    } catch (err) {
+      // If bundled Graphviz is not found, log error but continue
+      // PlantUML will work without Graphviz for most diagram types
+      if (process.env.DEBUG_PLANTUML) {
+        console.warn('[DEBUG] Graphviz not found:', err.message)
+      }
+      // dotPath remains null, PlantUML will handle it
+    }
   }
 
   // CRITICAL FIX: Ensure dot path is absolute and properly formatted

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-plantuml-2",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "plantumlVersion": "1.2026.1",
   "description": "Node.js PlantUML renderer with Java backend. Multiple output formats (PNG, SVG, EPS, ASCII, Unicode) with full UTF-8 support",
   "main": "index.js",
@@ -26,13 +26,13 @@
     "plantuml-encoder": "^1.2.5"
   },
   "optionalDependencies": {
-    "@node-plantuml-2/jre-win32-x64": "^1.1.3",
-    "@node-plantuml-2/jre-darwin-arm64": "^1.1.3",
-    "@node-plantuml-2/jre-linux-x64": "^1.1.3",
-    "@node-plantuml-2/graphviz-win32-x64": "^1.1.3",
-    "@node-plantuml-2/graphviz-darwin-arm64": "^1.1.3",
-    "@node-plantuml-2/graphviz-darwin-x64": "^1.1.3",
-    "@node-plantuml-2/graphviz-linux-x64": "^1.1.3"
+    "@node-plantuml-2/jre-win32-x64": "^1.1.5",
+    "@node-plantuml-2/jre-darwin-arm64": "^1.1.5",
+    "@node-plantuml-2/jre-linux-x64": "^1.1.5",
+    "@node-plantuml-2/graphviz-win32-x64": "^1.1.5",
+    "@node-plantuml-2/graphviz-darwin-arm64": "^1.1.5",
+    "@node-plantuml-2/graphviz-darwin-x64": "^1.1.5",
+    "@node-plantuml-2/graphviz-linux-x64": "^1.1.5"
   },
   "devDependencies": {
     "chai": "^4.x",
@@ -62,9 +62,7 @@
     "test:integration": "node test/test-integration-full.js",
     "build": "node nail/build.js",
     "build:all": "node scripts/build-all.js",
-    "build:all:jar-only": "node scripts/get-plantuml-jar.js --latest",
-    "test:graphviz": "node scripts/test-graphviz-build.js",
-    "test:graphviz:build": "node scripts/test-graphviz-build.js"
+    "build:all:jar-only": "node scripts/get-plantuml-jar.js --latest"
   },
   "bin": {
     "puml": "index.js"

package/scripts/install-graphviz.js

@@ -254,8 +254,8 @@ async function installGraphviz () {
   console.log('🔍 Checking if Graphviz is already installed...')
   console.log('')
 
-  // First check if Graphviz is already installed
-  var detected = dotResolver.resolveDotExecutable({ dotPath: null })
+  // First check if Graphviz is already installed (allow system fallback for install script)
+  var detected = dotResolver.resolveDotExecutable({ dotPath: null, allowSystemFallback: true })
   if (detected) {
     console.log('✅ Graphviz is already installed at: ' + detected)
     console.log('')
@@ -290,10 +290,10 @@ async function installGraphviz () {
   }
 
   if (installed) {
-    // Verify installation
+    // Verify installation (allow system fallback for install script)
     console.log('')
     console.log('🔍 Verifying installation...')
-    var newDetected = dotResolver.resolveDotExecutable({ dotPath: null })
+    var newDetected = dotResolver.resolveDotExecutable({ dotPath: null, allowSystemFallback: true })
     if (newDetected) {
       console.log('✅ Graphviz is now available at: ' + newDetected)
       return true