enhancement/optimized-options-and-logic

.env.sample

@@ -1,29 +1,52 @@
+# PUPPETEER CONFIG
+PUPPETEER_ARGS =
+
 # HIGHCHARTS CONFIG
 HIGHCHARTS_VERSION = latest
-HIGHCHARTS_CDN_URL = https://code.highcharts.com/
+HIGHCHARTS_CDN_URL = https://code.highcharts.com
+HIGHCHARTS_FORCE_FETCH = false
+HIGHCHARTS_CACHE_PATH = .cache
+HIGHCHARTS_ADMIN_TOKEN =
 HIGHCHARTS_CORE_SCRIPTS =
 HIGHCHARTS_MODULE_SCRIPTS =
 HIGHCHARTS_INDICATOR_SCRIPTS =
-HIGHCHARTS_FORCE_FETCH = false
-HIGHCHARTS_CACHE_PATH =
-HIGHCHARTS_ADMIN_TOKEN =
+HIGHCHARTS_CUSTOM_SCRIPTS =
 
 # EXPORT CONFIG
+EXPORT_INFILE =
+EXPORT_INSTR =
+EXPORT_OPTIONS =
+EXPORT_SVG =
+EXPORT_BATCH =
+EXPORT_OUTFILE =
 EXPORT_TYPE = png
 EXPORT_CONSTR = chart
+EXPORT_B64 = false
+EXPORT_NO_DOWNLOAD = false
+EXPORT_HEIGHT =
+EXPORT_WIDTH =
+EXPORT_SCALE =
 EXPORT_DEFAULT_HEIGHT = 400
 EXPORT_DEFAULT_WIDTH = 600
 EXPORT_DEFAULT_SCALE = 1
+EXPORT_GLOBAL_OPTIONS =
+EXPORT_THEME_OPTIONS =
 EXPORT_RASTERIZATION_TIMEOUT = 1500
 
 # CUSTOM LOGIC CONFIG
 CUSTOM_LOGIC_ALLOW_CODE_EXECUTION = false
 CUSTOM_LOGIC_ALLOW_FILE_RESOURCES = false
+CUSTOM_LOGIC_CUSTOM_CODE =
+CUSTOM_LOGIC_CALLBACK =
+CUSTOM_LOGIC_RESOURCES =
+CUSTOM_LOGIC_LOAD_CONFIG =
+CUSTOM_LOGIC_CREATE_CONFIG =
 
 # SERVER CONFIG
 SERVER_ENABLE = false
 SERVER_HOST = 0.0.0.0
 SERVER_PORT = 7801
+SERVER_UPLOAD_LIMIT = 3
 SERVER_BENCHMARKING = false
 
 # SERVER PROXY CONFIG
@@ -61,12 +84,12 @@ POOL_BENCHMARKING = false
 # LOGGING CONFIG
 LOGGING_LEVEL = 4
 LOGGING_FILE = highcharts-export-server.log
-LOGGING_DEST = log/
+LOGGING_DEST = log
 LOGGING_TO_CONSOLE = true
 LOGGING_TO_FILE = true
 
 # UI CONFIG
-UI_ENABLE = true
+UI_ENABLE = false
 UI_ROUTE = /
 
 # OTHER CONFIG
@@ -78,7 +101,7 @@ OTHER_BROWSER_SHELL_MODE = true
 
 # DEBUG CONFIG
 DEBUG_ENABLE = false
-DEBUG_HEADLESS = true
+DEBUG_HEADLESS = false
 DEBUG_DEVTOOLS = false
 DEBUG_LISTEN_TO_CONSOLE = false
 DEBUG_DUMPIO = false

.github/ISSUE_TEMPLATE.md

@@ -16,4 +16,4 @@
 
 <!-- Please describe how to reproduce the issue. -->
 <!-- If you can, please include a curl fetch that demonstrates the issue, e.g. -->
-<!-- curl -H "Content-Type: application/json" -X POST -d '{"infile":{ <CHART OPTIONS HERE> }' 127.0.0.1:7801 -o mychart.png -->
+<!-- curl -H "Content-Type: application/json" -X POST -d '{"options":{ <CHART OPTIONS HERE> }' 127.0.0.1:7801 -o mychart.png -->

LICENSE

@@ -1,6 +1,6 @@
 Highcharts Export Server
 
-Copyright (c) 2016-2024, Highsoft
+Copyright (c) 2016-2025, Highsoft
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

bin/cli.js

@@ -3,7 +3,7 @@
 
 Highcharts Export Server
 
-Copyright (c) 2016-2024, Highsoft
+Copyright (c) 2016-2025, Highsoft
 
 Licenced under the MIT licence.
 
@@ -13,99 +13,137 @@ See LICENSE file in root for details.
 
 *******************************************************************************/
 
-import main from '../lib/index.js';
+/**
+ * @overview This module serves as the entry point for the Highcharts Export
+ * Server. It provides functionality for starting the server, performing batch
+ * or single chart exports, managing manual configuration options through
+ * the prompts functionality, and updating options with values from the passed
+ * CLI arguments. It supports both CLI and server-based usage, enabling
+ * integration for generating Highcharts exports in various environments.
+ */
+
+import { batchExport, singleExport } from '../lib/chart.js';
+import { setCliOptions } from '../lib/config.js';
+import { initExport } from '../lib/index.js';
+import { printInfo, printUsage } from '../lib/info.js';
+import { log, logWithStack } from '../lib/logger.js';
+import { manualConfig } from '../lib/prompt.js';
+import { shutdownCleanUp } from '../lib/resourceRelease.js';
+
+import { startServer } from '../lib/server/server.js';
 
 import ExportError from '../lib/errors/ExportError.js';
 
 /**
- * The primary function to initiate the server or perform the direct export.
+ * The primary function to initiate the server or perform the direct CLI export.
+ * Logs an error if it occurs during the execution and gracefully shuts down
+ * the process.
+ *
+ * @async
+ * @function start
  *
- * @throws {ExportError} Throws an ExportError if no valid options are provided.
- * @throws {Error} Throws an Error if an unexpected error occurs during
- * execution.
+ * @returns {Promise<void>} A Promise that resolves when the function execution
+ * ends after displaying the logo with license and version information, showing
+ * the CLI usage details, or triggering manual configuration using the prompts
+ * functionality.
+ *
+ * @throws {ExportError} Throws an `ExportError` if no valid options
+ * are provided.
  */
-const start = async () => {
+async function start() {
   try {
     // Get the CLI arguments
     const args = process.argv;
 
-    // Print the usage information if no arguments supplied
+    // If no arguments are supplied
     if (args.length <= 2) {
-      main.log(
+      // Print logo with version and license information
+      printInfo();
+      log(
         2,
-        '[cli] The number of provided arguments is too small. Please refer to the section below.'
+        '[cli] The number of provided arguments is too small. Please refer to the help section (use --h or --help command).'
       );
-      return main.printUsage();
+      return;
+    }
+
+    // Display version and license information if requested
+    if (['-v', '--v'].some((a) => args.includes(a))) {
+      // Print logo with version and license information
+      printInfo();
+      return;
+    }
+
+    // Display help information if requested
+    if (['-h', '--h', '-help', '--help'].some((a) => args.includes(a))) {
+      // Print CLI usage information
+      printUsage();
+      return;
     }
 
-    // Set the options, keeping the priority order of setting values:
-    // 1. Options from the lib/schemas/config.js file
-    // 2. Options from a custom JSON file (loaded by the --loadConfig argument)
-    // 3. Options from the environment variables (the .env file)
-    // 4. Options from the CLI
-    const options = main.setOptions(null, args);
+    // Set the options from CLI, keeping the priority order of setting values
+    const options = setCliOptions(args);
 
-    // If all options correctly parsed
+    // If all options are correctly parsed
     if (options) {
-      // Print initial logo or text
-      main.printLogo(options.other.noLogo);
+      // Print initial logo or text with the version information
+      printInfo(options.other.noLogo, true);
 
       // In this case we want to prepare config manually
       if (options.customLogic.createConfig) {
-        return main.manualConfig(options.customLogic.createConfig);
+        manualConfig(
+          options.customLogic.createConfig,
+          options.customLogic.allowCodeExecution
+        );
+        return;
       }
 
       // Start server
       if (options.server.enable) {
         // Init the export mechanism for the server configuration
-        await main.initExport(options);
+        await initExport();
 
         // Run the server
-        await main.startServer(options.server);
+        await startServer();
       } else {
         // Perform batch exports
         if (options.export.batch) {
-          // If not set explicitly, use default option for batch exports
-          if (!args.includes('--minWorkers', '--maxWorkers')) {
-            options.pool = {
-              ...options.pool,
-              minWorkers: 2,
-              maxWorkers: 25
-            };
-          }
-
-          // Init a pool for the batch exports
-          await main.initExport(options);
+          // Init the export mechanism for batch exports
+          await initExport();
 
           // Start batch exports
-          await main.batchExport(options);
+          await batchExport({
+            export: options.export,
+            customLogic: options.customLogic
+          });
         } else {
           // No need for multiple workers in case of a single CLI export
-          options.pool = {
-            ...options.pool,
-            minWorkers: 1,
-            maxWorkers: 1
-          };
+          options.pool.minWorkers = 1;
+          options.pool.maxWorkers = 1;
 
-          // Init a pool for one export
-          await main.initExport(options);
+          // Init the export mechanism for a single export
+          await initExport();
 
           // Start a single export
-          await main.singleExport(options);
+          await singleExport({
+            export: options.export,
+            customLogic: options.customLogic
+          });
         }
       }
     } else {
       throw new ExportError(
-        '[cli] No valid options provided. Please check your input and try again.'
+        '[cli] No valid options found. Please check your input and try again.',
+        400
       );
     }
   } catch (error) {
     // Log the error with stack
-    main.logWithStack(1, error);
+    logWithStack(1, error);
 
     // Gracefully shut down the process
-    await main.shutdownCleanUp(1);
+    await shutdownCleanUp(1);
   }
-};
+}
 
+// Start the Export Server process
 start();