javascript-obfuscator 2.18.1 → 3.0.1

package/src/cli/JavaScriptObfuscatorCLI.ts

@@ -1,554 +0,0 @@
-/* eslint-disable max-lines */
-import * as commander from 'commander';
-import * as path from 'path';
-
-import { TInputCLIOptions } from '../types/options/TInputCLIOptions';
-import { TInputOptions } from '../types/options/TInputOptions';
-
-import { IFileData } from '../interfaces/cli/IFileData';
-import { IInitializable } from '../interfaces/IInitializable';
-import { IObfuscationResult } from '../interfaces/source-code/IObfuscationResult';
-
-import { initializable } from '../decorators/Initializable';
-
-import { IdentifierNamesGenerator } from '../enums/generators/identifier-names-generators/IdentifierNamesGenerator';
-import { LoggingPrefix } from '../enums/logger/LoggingPrefix';
-import { ObfuscationTarget } from '../enums/ObfuscationTarget';
-import { OptionsPreset } from '../enums/options/presets/OptionsPreset';
-import { RenamePropertiesMode } from '../enums/node-transformers/rename-properties-transformers/RenamePropertiesMode';
-import { SourceMapMode } from '../enums/source-map/SourceMapMode';
-import { SourceMapSourcesMode } from '../enums/source-map/SourceMapSourcesMode';
-import { StringArrayEncoding } from '../enums/node-transformers/string-array-transformers/StringArrayEncoding';
-import { StringArrayIndexesType } from '../enums/node-transformers/string-array-transformers/StringArrayIndexesType';
-import { StringArrayWrappersType } from '../enums/node-transformers/string-array-transformers/StringArrayWrappersType';
-
-import { DEFAULT_PRESET } from '../options/presets/Default';
-
-import { ArraySanitizer } from './sanitizers/ArraySanitizer';
-import { BooleanSanitizer } from './sanitizers/BooleanSanitizer';
-
-import { CLIUtils } from './utils/CLIUtils';
-import { IdentifierNamesCacheFileUtils } from './utils/IdentifierNamesCacheFileUtils';
-import { JavaScriptObfuscator } from '../JavaScriptObfuscatorFacade';
-import { Logger } from '../logger/Logger';
-import { ObfuscatedCodeFileUtils } from './utils/ObfuscatedCodeFileUtils';
-import { SourceCodeFileUtils } from './utils/SourceCodeFileUtils';
-import { Utils } from '../utils/Utils';
-
-export class JavaScriptObfuscatorCLI implements IInitializable {
-    /**
-     * @type {string[]}
-     */
-    public static readonly availableInputExtensions: string[] = [
-        '.js'
-    ];
-
-    /**
-     * @type {BufferEncoding}
-     */
-    public static readonly encoding: BufferEncoding = 'utf8';
-
-    /**
-     * @type {string}
-     */
-    public static readonly obfuscatedFilePrefix: string = '-obfuscated';
-
-    /**
-     * @type {commander.Command}
-     */
-    @initializable()
-    private commands!: commander.Command;
-
-    /**
-     * @type {IdentifierNamesCacheFileUtils}
-     */
-    @initializable()
-    private identifierNamesCacheFileUtils!: IdentifierNamesCacheFileUtils;
-
-    /**
-     * @type {TInputCLIOptions}
-     */
-    @initializable()
-    private inputCLIOptions!: TInputCLIOptions;
-
-    /**
-     * @type {string}
-     */
-    @initializable()
-    private inputPath!: string;
-
-    /**
-     * @type {SourceCodeFileUtils}
-     */
-    @initializable()
-    private sourceCodeFileUtils!: SourceCodeFileUtils;
-
-    /**
-     * @type {ObfuscatedCodeFileUtils}
-     */
-    @initializable()
-    private obfuscatedCodeFileUtils!: ObfuscatedCodeFileUtils;
-
-    /**
-     * @type {string[]}
-     */
-    private readonly arguments: string[];
-
-    /**
-     * @type {string[]}
-     */
-    private readonly rawArguments: string[];
-
-    /**
-     * @param {string[]} argv
-     */
-    public constructor (argv: string[]) {
-        this.rawArguments = argv;
-        this.arguments = argv.slice(2);
-    }
-
-    /**
-     * @param {TInputCLIOptions} inputOptions
-     * @returns {TInputOptions}
-     */
-    private static buildOptions (inputOptions: TInputCLIOptions): TInputOptions {
-        const inputCLIOptions: TInputOptions = JavaScriptObfuscatorCLI.filterOptions(inputOptions);
-        const configFilePath: string | undefined = inputOptions.config;
-        const configFileLocation: string = configFilePath ? path.resolve(configFilePath, '.') : '';
-        const configFileOptions: TInputOptions = configFileLocation ? CLIUtils.getUserConfig(configFileLocation) : {};
-
-        return {
-            ...DEFAULT_PRESET,
-            ...configFileOptions,
-            ...inputCLIOptions
-        };
-    }
-
-    /**
-     * @param {TObject} options
-     * @returns {TInputOptions}
-     */
-    private static filterOptions (options: TInputCLIOptions): TInputOptions {
-        const filteredOptions: TInputOptions = {};
-
-        Object
-            .keys(options)
-            .forEach((option: keyof TInputCLIOptions) => {
-                if (options[option] === undefined) {
-                    return;
-                }
-
-                filteredOptions[option] = options[option];
-            });
-
-        return filteredOptions;
-    }
-
-    public initialize (): void {
-        this.commands = new commander.Command();
-
-        this.configureCommands();
-        this.configureHelp();
-
-        this.inputPath = path.normalize(this.commands.args[0] || '');
-        this.inputCLIOptions = JavaScriptObfuscatorCLI.buildOptions(this.commands.opts());
-        this.sourceCodeFileUtils = new SourceCodeFileUtils(
-            this.inputPath,
-            this.inputCLIOptions
-        );
-        this.obfuscatedCodeFileUtils = new ObfuscatedCodeFileUtils(
-            this.inputPath,
-            this.inputCLIOptions
-        );
-        this.identifierNamesCacheFileUtils = new IdentifierNamesCacheFileUtils(this.inputCLIOptions.identifierNamesCachePath);
-    }
-
-    public run (): void {
-        const canShowHelp: boolean = !this.arguments.length || this.arguments.includes('--help');
-
-        if (canShowHelp) {
-            this.commands.outputHelp();
-
-            return;
-        }
-
-        const sourceCodeData: IFileData[] = this.sourceCodeFileUtils.readSourceCode();
-
-        this.processSourceCodeData(sourceCodeData);
-    }
-
-    private configureCommands (): void {
-        this.commands
-            .usage('<inputPath> [options]')
-            .version(
-                Utils.buildVersionMessage(process.env.VERSION, process.env.BUILD_TIMESTAMP),
-                '-v, --version'
-            )
-            .option(
-                '-o, --output <path>',
-                'Output path for obfuscated code'
-            )
-            .option(
-                '--compact <boolean>',
-                'Disable one line output code compacting',
-                BooleanSanitizer
-            )
-            .option(
-                '--config <boolean>',
-                'Name of js / json config file'
-            )
-            .option(
-                '--control-flow-flattening <boolean>',
-                'Enables control flow flattening',
-                BooleanSanitizer
-            )
-            .option(
-                '--control-flow-flattening-threshold <number>',
-                'The probability that the control flow flattening transformation will be applied to the node',
-                parseFloat
-            )
-            .option(
-                '--dead-code-injection <boolean>',
-                'Enables dead code injection',
-                BooleanSanitizer
-            )
-            .option(
-                '--dead-code-injection-threshold <number>',
-                'The probability that the dead code injection transformation will be applied to the node',
-                parseFloat
-            )
-            .option(
-                '--debug-protection <boolean>',
-                'Disable browser Debug panel (can cause DevTools enabled browser freeze)',
-                BooleanSanitizer
-            )
-            .option(
-                '--debug-protection-interval <boolean>',
-                'Disable browser Debug panel even after page was loaded (can cause DevTools enabled browser freeze)',
-                BooleanSanitizer
-            )
-            .option(
-                '--disable-console-output <boolean>',
-                'Allow console.log, console.info, console.error and console.warn messages output into browser console',
-                BooleanSanitizer
-            )
-            .option(
-                '--domain-lock <list> (comma separated, without whitespaces)',
-                'Allows to run the obfuscated source code only on specific domains and/or sub-domains (comma separated)',
-                ArraySanitizer
-            )
-            .option(
-                '--domain-lock-redirect-url <string>',
-                'Allows the browser to be redirected to a passed URL if the source code isn\'t run on the domains specified by --domain-lock',
-            )
-            .option(
-                '--exclude <list> (comma separated, without whitespaces)',
-                'A filename or glob which indicates files to exclude from obfuscation',
-                ArraySanitizer
-            )
-            .option(
-                '--force-transform-strings <list> (comma separated, without whitespaces)',
-                'Enables force transformation of string literals, which being matched by passed RegExp patterns (comma separated)',
-                ArraySanitizer
-            )
-            .option(
-                '--identifier-names-cache-path <string>',
-                'Sets path for identifier names cache'
-            )
-            .option(
-                '--identifier-names-generator <string>',
-                'Sets identifier names generator. ' +
-                `Values: ${CLIUtils.stringifyOptionAvailableValues(IdentifierNamesGenerator)}. ` +
-                `Default: ${IdentifierNamesGenerator.HexadecimalIdentifierNamesGenerator}`
-            )
-            .option(
-                '--identifiers-prefix <string>',
-                'Sets prefix for all global identifiers'
-            )
-            .option(
-                '--identifiers-dictionary <list> (comma separated, without whitespaces)',
-                'Identifiers dictionary (comma separated) for `--identifier-names-generator dictionary` option',
-                ArraySanitizer
-            )
-            .option(
-                '--ignore-require-imports <boolean>', 'Prevents obfuscation of `require` imports',
-                BooleanSanitizer
-            )
-            .option(
-                '--log <boolean>', 'Enables logging of the information to the console',
-                BooleanSanitizer
-            )
-            .option(
-                '--numbers-to-expressions <boolean>', 'Enables numbers conversion to expressions',
-                BooleanSanitizer
-            )
-            .option(
-                '--options-preset <string>',
-                'Allows to set options preset. ' +
-                `Values: ${CLIUtils.stringifyOptionAvailableValues(OptionsPreset)}. ` +
-                `Default: ${OptionsPreset.Default}`
-            )
-            .option(
-                '--reserved-names <list> (comma separated, without whitespaces)',
-                'Disables obfuscation and generation of identifiers, which being matched by passed RegExp patterns (comma separated)',
-                ArraySanitizer
-            )
-            .option(
-                '--reserved-strings <list> (comma separated, without whitespaces)',
-                'Disables transformation of string literals, which being matched by passed RegExp patterns (comma separated)',
-                ArraySanitizer
-            )
-            .option(
-                '--rename-globals <boolean>', 'Allows to enable obfuscation of global variable and function names with declaration',
-                BooleanSanitizer
-            )
-            .option(
-                '--rename-properties <boolean>', 'UNSAFE: Enables renaming of property names. This probably MAY break your code',
-                BooleanSanitizer
-            )
-            .option(
-                '--rename-properties-mode <boolean>',
-                'Specify `--rename-properties` option mode. ' +
-                `Values: ${CLIUtils.stringifyOptionAvailableValues(RenamePropertiesMode)}. ` +
-                `Default: ${RenamePropertiesMode.Safe}`
-            )
-            .option(
-                '--rotate-string-array <boolean>', 'Enable rotation of string array values during obfuscation',
-                BooleanSanitizer
-            )
-            .option(
-                '--seed <string|number>',
-                'Sets seed for random generator. This is useful for creating repeatable results.',
-                parseFloat
-            )
-            .option(
-                '--self-defending <boolean>',
-                'Disables self-defending for obfuscated code',
-                BooleanSanitizer
-            )
-            .option(
-                '--shuffle-string-array <boolean>', 'Randomly shuffles string array items',
-                BooleanSanitizer
-            )
-            .option(
-                '--simplify <boolean>', 'Enables additional code obfuscation through simplification',
-                BooleanSanitizer
-            )
-            .option(
-                '--source-map <boolean>',
-                'Enables source map generation',
-                BooleanSanitizer
-            )
-            .option(
-                '--source-map-base-url <string>',
-                'Sets base url to the source map import url when `--source-map-mode=separate`'
-            )
-            .option(
-                '--source-map-file-name <string>',
-                'Sets file name for output source map when `--source-map-mode=separate`'
-            )
-            .option(
-                '--source-map-mode <string>',
-                'Specify source map output mode. ' +
-                `Values: ${CLIUtils.stringifyOptionAvailableValues(SourceMapMode)}. ` +
-                `Default: ${SourceMapMode.Separate}`
-            )
-            .option(
-                '--source-map-sources-mode <string>',
-                'Specify source map sources mode. ' +
-                `Values: ${CLIUtils.stringifyOptionAvailableValues(SourceMapSourcesMode)}. ` +
-                `Default: ${SourceMapSourcesMode.SourcesContent}`
-            )
-            .option(
-                '--split-strings <boolean>',
-                'Splits literal strings into chunks with length of `splitStringsChunkLength` option value',
-                BooleanSanitizer
-            )
-            .option(
-                '--split-strings-chunk-length <number>',
-                'Sets chunk length of `splitStrings` option',
-                parseFloat
-            )
-            .option(
-                '--string-array <boolean>',
-                'Disables gathering of all literal strings into an array and replacing every literal string with an array call',
-                BooleanSanitizer
-            )
-            .option(
-                '--string-array-encoding <list> (comma separated, without whitespaces)',
-                'Encodes each string in strings array using base64 or rc4 (this option can slow down your code speed). ' +
-                `Values: ${CLIUtils.stringifyOptionAvailableValues(StringArrayEncoding)}. ` +
-                `Default: ${StringArrayEncoding.None}`,
-                ArraySanitizer
-            )
-            .option(
-                '--string-array-indexes-type <list> (comma separated, without whitespaces)',
-                'Encodes each string in strings array using base64 or rc4 (this option can slow down your code speed). ' +
-                `Values: ${CLIUtils.stringifyOptionAvailableValues(StringArrayIndexesType)}. ` +
-                `Default: ${StringArrayIndexesType.HexadecimalNumber}`,
-                ArraySanitizer
-            )
-            .option(
-                '--string-array-index-shift <boolean>',
-                'Enables additional index shift for all string array calls',
-                BooleanSanitizer
-            )
-            .option(
-                '--string-array-wrappers-count <number>',
-                'Sets the count of wrappers for the string array inside each root or function scope',
-                parseInt
-            )
-            .option(
-                '--string-array-wrappers-chained-calls <boolean>',
-                'Enables the chained calls between string array wrappers',
-                BooleanSanitizer
-            )
-            .option(
-                '--string-array-wrappers-parameters-max-count <number>',
-                'Allows to control the maximum number of string array wrappers parameters',
-                parseInt
-            )
-            .option(
-                '--string-array-wrappers-type <string>',
-                'Allows to select a type of the wrappers that are appending by the `--string-array-wrappers-count` option. ' +
-                `Values: ${CLIUtils.stringifyOptionAvailableValues(StringArrayWrappersType)}. ` +
-                `Default: ${StringArrayWrappersType.Variable}`
-            )
-            .option(
-                '--string-array-threshold <number>',
-                'The probability that the literal string will be inserted into stringArray (Default: 0.8, Min: 0, Max: 1)',
-                parseFloat
-            )
-            .option(
-                '--target <string>',
-                'Allows to set target environment for obfuscated code. ' +
-                `Values: ${CLIUtils.stringifyOptionAvailableValues(ObfuscationTarget)}. ` +
-                `Default: ${ObfuscationTarget.Browser}`
-            )
-            .option(
-                '--transform-object-keys <boolean>',
-                'Enables transformation of object keys',
-                BooleanSanitizer
-            )
-            .option(
-                '--unicode-escape-sequence <boolean>',
-                'Allows to enable/disable string conversion to unicode escape sequence',
-                BooleanSanitizer
-            )
-            .parse(this.rawArguments);
-    }
-
-    private configureHelp (): void {
-        this.commands.on('--help', () => {
-            console.log('  Examples:\n');
-            console.log('    %> javascript-obfuscator input_file_name.js --compact true --self-defending false');
-            console.log('    %> javascript-obfuscator input_file_name.js --output output_file_name.js --compact true --self-defending false');
-            console.log('    %> javascript-obfuscator input_directory_name --compact true --self-defending false');
-            console.log('');
-        });
-    }
-
-    /**
-     * @param {IFileData[]} sourceCodeData
-     */
-    private processSourceCodeData (sourceCodeData: IFileData[]): void {
-        sourceCodeData.forEach(({ filePath, content }: IFileData, index: number) => {
-            const outputCodePath: string = this.obfuscatedCodeFileUtils.getOutputCodePath(filePath);
-
-            try {
-                Logger.log(
-                    Logger.colorInfo,
-                    LoggingPrefix.CLI,
-                    `Obfuscating file: ${filePath}...`
-                );
-
-                this.processSourceCode(content, filePath, outputCodePath, index);
-            } catch (error) {
-                Logger.log(
-                    Logger.colorInfo,
-                    LoggingPrefix.CLI,
-                    `Error in file: ${filePath}...`
-                );
-
-                throw error;
-            }
-        });
-    }
-
-    /**
-     * @param {string} sourceCode
-     * @param {string} inputCodePath
-     * @param {string} outputCodePath
-     * @param {number | null} sourceCodeIndex
-     */
-    private processSourceCode (
-        sourceCode: string,
-        inputCodePath: string,
-        outputCodePath: string,
-        sourceCodeIndex: number | null
-    ): void {
-        const options: TInputOptions = {
-            ...this.inputCLIOptions,
-            identifierNamesCache: this.identifierNamesCacheFileUtils.readFile(),
-            inputFileName: path.basename(inputCodePath),
-            ...sourceCodeIndex !== null && {
-                identifiersPrefix: Utils.getIdentifiersPrefixForMultipleSources(
-                    this.inputCLIOptions.identifiersPrefix,
-                    sourceCodeIndex
-                )
-            }
-        };
-
-        if (options.sourceMap) {
-            this.processSourceCodeWithSourceMap(sourceCode, outputCodePath, options);
-        } else {
-            this.processSourceCodeWithoutSourceMap(sourceCode, outputCodePath, options);
-        }
-    }
-
-    /**
-     * @param {string} sourceCode
-     * @param {string} outputCodePath
-     * @param {TInputOptions} options
-     */
-    private processSourceCodeWithoutSourceMap (
-        sourceCode: string,
-        outputCodePath: string,
-        options: TInputOptions
-    ): void {
-        const obfuscationResult: IObfuscationResult = JavaScriptObfuscator.obfuscate(sourceCode, options);
-
-        this.obfuscatedCodeFileUtils.writeFile(outputCodePath, obfuscationResult.getObfuscatedCode());
-        this.identifierNamesCacheFileUtils.writeFile(obfuscationResult.getIdentifierNamesCache());
-    }
-
-    /**
-     * @param {string} sourceCode
-     * @param {string} outputCodePath
-     * @param {TInputOptions} options
-     */
-    private processSourceCodeWithSourceMap (
-        sourceCode: string,
-        outputCodePath: string,
-        options: TInputOptions
-    ): void {
-        const outputSourceMapPath: string = this.obfuscatedCodeFileUtils.getOutputSourceMapPath(
-            outputCodePath,
-            options.sourceMapFileName ?? ''
-        );
-
-        options = {
-            ...options,
-            sourceMapFileName: path.basename(outputSourceMapPath)
-        };
-
-        const obfuscationResult: IObfuscationResult = JavaScriptObfuscator.obfuscate(sourceCode, options);
-
-        this.obfuscatedCodeFileUtils.writeFile(outputCodePath, obfuscationResult.getObfuscatedCode());
-        this.identifierNamesCacheFileUtils.writeFile(obfuscationResult.getIdentifierNamesCache());
-
-        if (options.sourceMapMode === SourceMapMode.Separate && obfuscationResult.getSourceMap()) {
-            this.obfuscatedCodeFileUtils.writeFile(outputSourceMapPath, obfuscationResult.getSourceMap());
-        }
-    }
-}

package/src/cli/sanitizers/ArraySanitizer.ts

@@ -1,13 +0,0 @@
-import { TCLISanitizer } from '../../types/cli/TCLISanitizer';
-
-/**
- * @param {string} value
- * @returns {string[]}
- */
-export const ArraySanitizer: TCLISanitizer <string[]> = (value: string): string[] => {
-    if (value.endsWith(',')) {
-        throw new SyntaxError('Multiple <list> values should be wrapped inside quotes: --option-name \'value1\',\'value2\'');
-    }
-
-    return value.split(',').map((string: string) => string.trim());
-};

package/src/cli/sanitizers/BooleanSanitizer.ts

@@ -1,9 +0,0 @@
-import { TCLISanitizer } from '../../types/cli/TCLISanitizer';
-
-/**
- * @param {string} value
- * @returns {boolean}
- */
-export const BooleanSanitizer: TCLISanitizer <boolean> = (value: string): boolean => {
-    return value === 'true' || value === '1';
-};

package/src/cli/utils/CLIUtils.ts

@@ -1,50 +0,0 @@
-import * as path from 'path';
-
-import { TDictionary } from '../../types/TDictionary';
-
-import { StringSeparator } from '../../enums/StringSeparator';
-
-export class CLIUtils {
-    /**
-     * @type {string[]}
-     */
-    public static readonly allowedConfigFileExtensions: string[] = [
-        '.js',
-        '.json'
-    ];
-
-    /**
-     * @param {string} configPath
-     * @returns {TDictionary}
-     */
-    public static getUserConfig (configPath: string): TDictionary {
-        let config: TDictionary;
-
-        const configFileExtension: string = path.extname(configPath);
-        const isValidExtension: boolean = CLIUtils.allowedConfigFileExtensions.includes(configFileExtension);
-
-        if (!isValidExtension) {
-            throw new ReferenceError('Given config path must be a valid `.js` or `.json` file path');
-        }
-
-        try {
-            config = require(configPath);
-        } catch {
-            try {
-                config = __non_webpack_require__(configPath);
-            } catch {
-                throw new ReferenceError(`Cannot open config file with path: ${configPath}`);
-            }
-        }
-
-        return config;
-    }
-
-    /**
-     * @param {TDictionary} optionEnum
-     * @returns {string}
-     */
-    public static stringifyOptionAvailableValues (optionEnum: TDictionary): string {
-        return Object.values(optionEnum).join(`${StringSeparator.Comma} `);
-    }
-}