Migrate code examples to ES Modules

Author: vladimir-litvinchik

.eslintrc.js

@@ -5,8 +5,8 @@ module.exports = {
   },
   extends: ['eslint:recommended'],
   parserOptions: {
-    ecmaVersion: 2021,
-    sourceType: 'script', // CommonJS
+    ecmaVersion: 2022,
+    sourceType: 'module', // ES modules
   },
   rules: {
     // Code style
@@ -30,7 +30,7 @@ module.exports = {
     'no-unreachable': 'error',
     'no-var': 'error',
     'prefer-const': 'error',
-    'prefer-arrow-callback': 'off', // CommonJS uses regular functions
+    'prefer-arrow-callback': 'error', // ES modules prefer arrow functions
     'arrow-parens': ['error', 'always'],
     'arrow-spacing': ['error', { before: true, after: true }],
 
@@ -62,7 +62,7 @@ module.exports = {
       ignoreGlobals: false,
     }],
 
-    // CommonJS specific
+    // Node.js specific
     'no-process-env': 'off', // process.env is used for configuration
 
     // Async/await

Examples/AdvancedUsage/Converting/common/addWatermark.js

@@ -1,4 +1,4 @@
-const path = require('path');
+import { basename } from 'path';
 
 /**
  * This example demonstrates how to add a watermark to a document during conversion.
@@ -8,7 +8,7 @@ const path = require('path');
  * @param {string} outputFolder - Path to the output folder
  * @returns {Promise} Promise that resolves when conversion is complete
  */
-async function addWatermark(groupdocs, inputFilePath, outputFolder) {
+export default async function addWatermark(groupdocs, inputFilePath, outputFolder) {
   // Set output file path
   const outputPath = `${outputFolder}/AddWatermark.pdf`;
 
@@ -28,8 +28,6 @@ async function addWatermark(groupdocs, inputFilePath, outputFolder) {
   // Apply watermark to conversion options
   convertOptions.setWatermark(watermark);
 
-  console.log(`\n✓ Add Watermark: ${path.basename(outputPath)}`);
+  console.log(`\n✓ Add Watermark: ${basename(outputPath)}`);
   return converter.convert(outputPath, convertOptions);
 }
-
-module.exports = addWatermark;

Examples/AdvancedUsage/Converting/common/convertNConsecutivePages.js

@@ -1,4 +1,4 @@
-const path = require('path');
+import { basename } from 'path';
 
 /**
  * This example demonstrates how to convert a range of consecutive pages from a document.
@@ -8,7 +8,7 @@ const path = require('path');
  * @param {string} outputFolder - Path to the output folder
  * @returns {Promise} Promise that resolves when conversion is complete
  */
-async function convertConsecutivePages(groupdocs, inputFilePath, outputFolder) {
+export default async function convertConsecutivePages(groupdocs, inputFilePath, outputFolder) {
   // Initialize converter with input file
   const converter = new groupdocs.Converter(inputFilePath);
 
@@ -22,8 +22,6 @@ async function convertConsecutivePages(groupdocs, inputFilePath, outputFolder) {
   convertOptions.setPageNumber(2);
   convertOptions.setPagesCount(2);
 
-  console.log(`\n✓ Convert N Consecutive Pages: ${path.basename(outputPath)}`);
+  console.log(`\n✓ Convert N Consecutive Pages: ${basename(outputPath)}`);
   return converter.convert(outputPath, convertOptions);
 }
-
-module.exports = convertConsecutivePages;

Examples/AdvancedUsage/Converting/common/convertSpecificPages.js

@@ -1,5 +1,7 @@
-const ArrayList = require('java').import('java.util.ArrayList');
-const path = require('path');
+import java from 'java';
+import { basename } from 'path';
+
+const ArrayList = java.import('java.util.ArrayList');
 
 /**
  * This example demonstrates how to convert specific pages from a document.
@@ -9,7 +11,7 @@ const path = require('path');
  * @param {string} outputFolder - Path to the output folder
  * @returns {Promise} Promise that resolves when conversion is complete
  */
-async function convertSpecificPages(groupdocs, inputFilePath, outputFolder) {
+export default async function convertSpecificPages(groupdocs, inputFilePath, outputFolder) {
   // Initialize converter with input file
   const converter = new groupdocs.Converter(inputFilePath);
 
@@ -25,8 +27,6 @@ async function convertSpecificPages(groupdocs, inputFilePath, outputFolder) {
   pages.add(3); // Third page
   convertOptions.setPages(pages);
 
-  console.log(`\n✓ Convert Specific Pages: ${path.basename(outputPath)}`);
+  console.log(`\n✓ Convert Specific Pages: ${basename(outputPath)}`);
   return converter.convert(outputPath, convertOptions);
 }
-
-module.exports = convertSpecificPages;

Examples/AdvancedUsage/Converting/convertToHtmlWithAdvancedOptions.js

@@ -1,4 +1,4 @@
-const path = require('path');
+import { basename } from 'path';
 
 /**
  * This example demonstrates how to convert a password-protected document to HTML with advanced options.
@@ -10,7 +10,7 @@ const path = require('path');
  * @param {string} outputFolder - Path to the output folder
  * @returns {Promise} Promise that resolves when conversion is complete
  */
-async function convertToHtmlWithAdvancedOptions(groupdocs, inputFilePath, outputFolder) {
+export default async function convertToHtmlWithAdvancedOptions(groupdocs, inputFilePath, outputFolder) {
   // Configure load options for password-protected document
   const loadOptions = new groupdocs.WordProcessingLoadOptions();
   loadOptions.setPassword('12345');
@@ -27,9 +27,7 @@ async function convertToHtmlWithAdvancedOptions(groupdocs, inputFilePath, output
   convertOptions.setFixedLayout(true); // Use fixed layout for better formatting
   convertOptions.setPagesCount(1); // Convert only 1 page
 
-  console.log(`\n✓ Convert to HTML (Advanced): ${path.basename(outputPath)}`);
+  console.log(`\n✓ Convert to HTML (Advanced): ${basename(outputPath)}`);
   return converter.convert(outputPath, convertOptions);
 }
 
-module.exports = convertToHtmlWithAdvancedOptions;
-

Examples/AdvancedUsage/Converting/convertToImageWithAdvancedOptions.js

@@ -1,4 +1,4 @@
-const path = require('path');
+import { basename } from 'path';
 
 /**
  * This example demonstrates how to convert a PDF document to PNG images with advanced options.
@@ -11,7 +11,7 @@ const path = require('path');
  * @param {string} outputFolder - Path to the output folder
  * @returns {Promise} Promise that resolves when conversion is complete
  */
-async function convertToImageWithAdvancedOptions(groupdocs, inputFilePath, outputFolder) {
+export default async function convertToImageWithAdvancedOptions(groupdocs, inputFilePath, outputFolder) {
   // Define output file template with page number placeholder
   const outputFileTemplate = 'ConvertToImageWithAdvancedOptions-page-.png';
   const outputPath = `${outputFolder}/${outputFileTemplate}`;
@@ -41,12 +41,10 @@ async function convertToImageWithAdvancedOptions(groupdocs, inputFilePath, outpu
     convertOptions.setPageNumber(1);
     convertOptions.setPagesCount(2);
 
-    console.log(`\n✓ Convert to Image (Advanced): ${path.basename(outputFileTemplate)}`);
+    console.log(`\n✓ Convert to Image (Advanced): ${basename(outputFileTemplate)}`);
     return converter.convert(outputPath, convertOptions);
   } catch (error) {
     console.error('Error during conversion:', error);
     throw error;
   }
 }
-
-module.exports = convertToImageWithAdvancedOptions;

Examples/AdvancedUsage/Converting/convertToPdfWithAdvancedOptions.js

@@ -1,4 +1,4 @@
-const path = require('path');
+import { basename } from 'path';
 
 /**
  * This example demonstrates how to convert a password-protected document to PDF with advanced options.
@@ -10,7 +10,7 @@ const path = require('path');
  * @param {string} outputFolder - Path to the output folder
  * @returns {Promise} Promise that resolves when conversion is complete
  */
-async function convertToPdfWithAdvancedOptions(groupdocs, inputFilePath, outputFolder) {
+export default async function convertToPdfWithAdvancedOptions(groupdocs, inputFilePath, outputFolder) {
   // Configure load options for password-protected document
   const loadOptions = new groupdocs.WordProcessingLoadOptions();
   loadOptions.setPassword('12345');
@@ -30,8 +30,6 @@ async function convertToPdfWithAdvancedOptions(groupdocs, inputFilePath, outputF
   convertOptions.setPageWidth(1024); // Set output width
   convertOptions.setPageHeight(768); // Set output height
 
-  console.log(`\n✓ Convert to PDF (Advanced): ${path.basename(outputPath)}`);
+  console.log(`\n✓ Convert to PDF (Advanced): ${basename(outputPath)}`);
   return converter.convert(outputPath, convertOptions);
 }
-
-module.exports = convertToPdfWithAdvancedOptions;

Examples/AdvancedUsage/Converting/convertToPresentationWithAdvancedOptions.js

@@ -1,4 +1,4 @@
-const path = require('path');
+import { basename } from 'path';
 
 /**
  * This example demonstrates how to convert a password-protected document to PPT format with advanced options.
@@ -10,7 +10,7 @@ const path = require('path');
  * @param {string} outputFolder - Path to the output folder
  * @returns {Promise} Promise that resolves when conversion is complete
  */
-async function convertToPresentationWithAdvancedOptions(groupdocs, inputFilePath, outputFolder) {
+export default async function convertToPresentationWithAdvancedOptions(groupdocs, inputFilePath, outputFolder) {
   // Configure load options for password-protected document
   const loadOptions = new groupdocs.WordProcessingLoadOptions();
   loadOptions.setPassword('12345');
@@ -27,8 +27,6 @@ async function convertToPresentationWithAdvancedOptions(groupdocs, inputFilePath
   convertOptions.setPagesCount(1); // Convert only 1 page
   convertOptions.setFormat(groupdocs.PresentationFileType.Ppt); // Specify PPT format
 
-  console.log(`\n✓ Convert to Presentation (Advanced): ${path.basename(outputPath)}`);
+  console.log(`\n✓ Convert to Presentation (Advanced): ${basename(outputPath)}`);
   return converter.convert(outputPath, convertOptions);
 }
-
-module.exports = convertToPresentationWithAdvancedOptions;

Examples/AdvancedUsage/Converting/convertToSpreadsheetWithAdvancedOptions.js

@@ -1,4 +1,4 @@
-const path = require('path');
+import { basename } from 'path';
 
 /**
  * This example demonstrates how to convert a password-protected document to XLS format with advanced options.
@@ -10,7 +10,7 @@ const path = require('path');
  * @param {string} outputFolder - Path to the output folder
  * @returns {Promise} Promise that resolves when conversion is complete
  */
-async function convertToSpreadsheetWithAdvancedOptions(groupdocs, inputFilePath, outputFolder) {
+export default async function convertToSpreadsheetWithAdvancedOptions(groupdocs, inputFilePath, outputFolder) {
   // Configure load options for password-protected document
   const loadOptions = new groupdocs.WordProcessingLoadOptions();
   loadOptions.setPassword('12345');
@@ -27,8 +27,6 @@ async function convertToSpreadsheetWithAdvancedOptions(groupdocs, inputFilePath,
   convertOptions.setPagesCount(1); // Convert only 1 page
   convertOptions.setFormat(groupdocs.SpreadsheetFileType.Xls); // Specify XLS format
 
-  console.log(`\n✓ Convert to Spreadsheet (Advanced): ${path.basename(outputPath)}`);
+  console.log(`\n✓ Convert to Spreadsheet (Advanced): ${basename(outputPath)}`);
   return converter.convert(outputPath, convertOptions);
 }
-
-module.exports = convertToSpreadsheetWithAdvancedOptions;

Examples/AdvancedUsage/Converting/convertToWordProcessingWithAdvancedOptions.js

@@ -1,4 +1,4 @@
-const path = require('path');
+import { basename } from 'path';
 
 /**
  * This example demonstrates how to convert a PDF document to DOCX with advanced options.
@@ -10,7 +10,7 @@ const path = require('path');
  * @param {string} outputFolder - Path to the output folder
  * @returns {Promise} Promise that resolves when conversion is complete
  */
-async function convertToWordProcessingWithAdvancedOptions(groupdocs, inputFilePath, outputFolder) {
+export default async function convertToWordProcessingWithAdvancedOptions(groupdocs, inputFilePath, outputFolder) {
   // Initialize converter with input file
   const converter = new groupdocs.Converter(inputFilePath);
 
@@ -23,8 +23,6 @@ async function convertToWordProcessingWithAdvancedOptions(groupdocs, inputFilePa
   convertOptions.setPagesCount(1); // Convert only 1 page
   convertOptions.setFormat(groupdocs.WordProcessingFileType.Docx); // Specify DOCX format
 
-  console.log(`\n✓ Convert to Word Processing (Advanced): ${path.basename(outputPath)}`);
+  console.log(`\n✓ Convert to Word Processing (Advanced): ${basename(outputPath)}`);
   return converter.convert(outputPath, convertOptions);
 }
-
-module.exports = convertToWordProcessingWithAdvancedOptions;