esbuild-javascript-obfuscator 1.0.1 → 1.0.3

package/README.md

@@ -1,7 +1,16 @@
 # esbuild-javascript-obfuscator
 
-This project obfuscates your code using the javascript-obfuscator NPM package.
+This project obfuscates your code using the [javascript-obfuscator](https://github.com/javascript-obfuscator/javascript-obfuscator) NPM package.
 
-This completely serves a plugin for esbuild.
+## Highlights
 
-Licensed with MIT.
+- Currently the **only maintained** esbuild plugin for the **javascript-obfuscator** package.
+- **The only** esbuild plugin that supports **VM Obfuscation** _(API key required)._
+
+## Acknowledgments
+
+Thanks to [sanex3339](https://github.com/javascript-obfuscator/javascript-obfuscator/commits?author=sanex3339), the creator of **javascript-obfuscator**.
+
+## Important
+
+Licensed under the MIT License.

package/dist/plugin/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/plugin/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAMnC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAwDxE,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,mBAAmB,GA+DzD,OAAO,CAAC,MAAM,CACnB"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/plugin/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAMnC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAkDxE,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,mBAAmB,GAwEtD,OAAO,CAAC,MAAM,CACtB"}

package/dist/plugin/plugin.js

@@ -4,13 +4,14 @@ import fs from 'fs';
 import path from 'path';
 import { ValidateOptions } from './optionValidator';
 import { CreateLogger } from '../logging';
-async function ObfuscateFile(pluginOptions, finalized, file) {
+async function ObfuscateFile(pluginOptions, file) {
     const logger = CreateLogger(pluginOptions);
+    const originalCode = new TextDecoder().decode(file.contents);
     if (!file.path.endsWith('.js')) {
         logger('file does not end with .js, skipping obfuscation: ', file.path);
-        return false;
+        return originalCode;
     }
-    if (pluginOptions.VMProtection.Enabled) {
+    if (pluginOptions.VMProtection?.Enabled) {
         const { ApiKey, Version } = pluginOptions.VMProtection;
         logger('obfuscating with VM Protection ... ');
         const proApiOptions = {
@@ -19,21 +20,17 @@ async function ObfuscateFile(pluginOptions, finalized, file) {
         if (Version) {
             Reflect.set(proApiOptions, 'version', Version);
         }
-        const obfuscateResult = await JsObf.obfuscatePro(new TextDecoder().decode(file.contents), pluginOptions.ObfuscatorOptions, proApiOptions, logger);
-        finalized.push({ fileName: file.path, outputCode: obfuscateResult.getObfuscatedCode().toString() });
+        const obfuscateResult = await JsObf.obfuscatePro(originalCode, pluginOptions.ObfuscatorOptions, proApiOptions, logger);
         logger('obfuscation with VM Protection completed for file: ', file.path);
-        return true;
+        return obfuscateResult.getObfuscatedCode().toString();
     }
-    logger('obfusacting with no VM protection...');
-    const obfuscateResult = JsObf.obfuscate(new TextDecoder().decode(file.contents), pluginOptions.ObfuscatorOptions);
-    finalized.push({ fileName: file.path, outputCode: obfuscateResult.getObfuscatedCode().toString() });
-    console.log(finalized);
+    logger('obfuscating with no VM protection...');
+    const obfuscateResult = JsObf.obfuscate(originalCode, pluginOptions.ObfuscatorOptions);
     logger('obfuscation completed for file: ', file.path);
-    return true;
+    return obfuscateResult.getObfuscatedCode().toString();
 }
 export function JSObfuscatorPlugin(options) {
     const log = CreateLogger(options);
-    const finalized = [];
     log('JSObfuscatorPlugin initialized with options:', options);
     const [isValid, errorMsg] = ValidateOptions(options);
     log('isValid: ', isValid, ' errorMsg: ', errorMsg);
@@ -41,11 +38,10 @@ export function JSObfuscatorPlugin(options) {
         throw new Error(`Invalid JSObfuscatorPlugin options: ${errorMsg || 'no error message provided'}`);
     }
     log('creating plugin');
-    const obfuscateFile = ObfuscateFile.bind(null, options, finalized);
     return {
         name: 'esbuild-javascript-obfuscator',
         setup(build) {
-            if (build.initialOptions.write) {
+            if (build.initialOptions.write || build.initialOptions.write === undefined) {
                 throw new Error('esbuild-javascript-obfuscator plugin requires write: false in build options');
             }
             build.onEnd(async ({ errors, outputFiles }) => {
@@ -57,22 +53,32 @@ export function JSObfuscatorPlugin(options) {
                     log('No output files found, skipping obfuscation');
                     return;
                 }
-                if (outputFiles.length > 1 && !options.ObfuscateAllFiles) {
-                    throw new Error('outputFiles.length > 1 but ObfuscateAllFiles not explicitly set');
-                }
-                if (outputFiles.length > 1 && options.ObfuscateAllFiles) {
-                    for (const file of outputFiles) {
-                        const success = await obfuscateFile(file);
-                        if (!success) {
-                            log('failed to obfuscate file: ', file.path);
+                /* keep this here: on `watch` modes, this can cause a memory leak if not placed in this certain way.*/
+                const finalized = [];
+                for (const file of outputFiles) {
+                    const fileName = path.basename(file.path);
+                    const shouldObfuscate = options.ObfuscateAllFiles || (options.ObfuscateFilesWhitelist?.includes(fileName) ?? false);
+                    if (shouldObfuscate && file.path.endsWith('.js')) {
+                        try {
+                            const outputCode = await ObfuscateFile(options, file);
+                            /* write obfuscated output */
+                            finalized.push({ fileName: file.path, outputCode });
+                        }
+                        catch (err) {
+                            log('failed to obfuscate file: ', file.path, err);
+                            /* it failed, so just write the original file to the output */
+                            finalized.push({
+                                fileName: file.path,
+                                outputCode: new TextDecoder().decode(file.contents),
+                            });
                         }
                     }
-                }
-                else {
-                    const file = outputFiles[0];
-                    const success = await obfuscateFile(file);
-                    if (!success) {
-                        log('failed to obfuscate file: ', file.path);
+                    else {
+                        /* should not obfuscate, write orig file. */
+                        finalized.push({
+                            fileName: file.path,
+                            outputCode: new TextDecoder().decode(file.contents),
+                        });
                     }
                 }
                 /* write pass */

package/dist/tests/plugin.test.js

@@ -15,13 +15,15 @@ const ObfuscationOptions = {
     ObfuscateAllFiles: false,
 };
 function CreateDummyFiles() {
+    function cleanup() {
+        fs.rmSync(path.join(__dirname, 'temp'), { recursive: true, force: true });
+    }
+    cleanup(); /* needs to be called incase other tests failed and left the temp folder behind */
     fs.mkdirSync(path.join(__dirname, 'temp'));
     fs.writeFileSync(path.join(__dirname, 'temp', 'index.ts'), `
         console.log("Hello World")
         `);
-    return function cleanup() {
-        fs.rmSync(path.join(__dirname, 'temp'), { recursive: true, force: true });
-    };
+    return cleanup;
 }
 test('plugin should throw error when write: true', async () => {
     const cleanup = CreateDummyFiles();
@@ -34,6 +36,16 @@ test('plugin should throw error when write: true', async () => {
     })).rejects.toThrow(`esbuild-javascript-obfuscator plugin requires write: false in build options`);
     cleanup();
 });
+test('plugin should throw error when write option is not provided', async () => {
+    const cleanup = CreateDummyFiles();
+    expect(esbuild.build({
+        entryPoints: [path.join(__dirname, 'temp', 'index.ts')],
+        bundle: true,
+        minify: true,
+        plugins: [JSObfuscatorPlugin(ObfuscationOptions)],
+    })).rejects.toThrow(`esbuild-javascript-obfuscator plugin requires write: false in build options`);
+    cleanup();
+});
 test('plugin should successfully obfuscate a single file', async () => {
     const cleanup = CreateDummyFiles();
     await esbuild.build({

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "esbuild-javascript-obfuscator",
-	"version": "1.0.1",
+	"version": "1.0.3",
 	"description": "An esbuild plugin to obfuscate JavaScript code.",
 	
 	"author": {