jscrambler - npm Package Compare versions

Comparing version 5.2.16 to 5.2.17

dist/bin/jscrambler.js

@@ -36,3 +36,3 @@ #!/usr/bin/env node
 
-_commander2.default.version(require('../../package.json').version).usage('[options] <file ...>').option('-v, --version').option('-a, --access-key <accessKey>', 'Access key').option('-c, --config <config>', 'JScrambler configuration options').option('-H, --host <host>', 'Hostname').option('-i, --application-id <id>', 'Application ID').option('-o, --output-dir <dir>', 'Output directory').option('-p, --port <port>', 'Port').option('--protocol <protocol>', 'Protocol (http or https)').option('--cafile <path>', 'Internal certificate authority').option('-C, --cwd <dir>', 'Current Working Directory').option('-s, --secret-key <secretKey>', 'Secret key').option('-m, --source-maps <id>', 'Download source maps').option('-R, --randomization-seed <seed>', 'Set randomization seed').option('--recommended-order <bool>', 'Use recommended order').option('-W --werror', 'Cancel protection if any file contains errors').option('--jscramblerVersion <version>', 'Use a specific Jscrambler version').option('--debugMode', 'Protect in debug mode').parse(process.argv);
+_commander2.default.version(require('../../package.json').version).usage('[options] <file ...>').option('-v, --version').option('-a, --access-key <accessKey>', 'Access key').option('-c, --config <config>', 'JScrambler configuration options').option('-H, --host <host>', 'Hostname').option('-i, --application-id <id>', 'Application ID').option('-o, --output-dir <dir>', 'Output directory').option('-p, --port <port>', 'Port').option('--protocol <protocol>', 'Protocol (http or https)').option('--cafile <path>', 'Internal certificate authority').option('-C, --cwd <dir>', 'Current Working Directory').option('-s, --secret-key <secretKey>', 'Secret key').option('-m, --source-maps <id>', 'Download source maps').option('-R, --randomization-seed <seed>', 'Set randomization seed').option('--recommended-order <bool>', 'Use recommended order').option('-W, --werror <bool>', 'Set werror flag value (default: true)').option('--jscramblerVersion <version>', 'Use a specific Jscrambler version').option('--debugMode', 'Protect in debug mode').parse(process.argv);
 
@@ -64,3 +64,3 @@ var globSrc = void 0,
 config.useRecommendedOrder = _commander2.default.recommendedOrder ? _commander2.default.recommendedOrder !== 'false' : config.useRecommendedOrder;
-config.werror = _commander2.default.werror || config.werror;
+config.werror = _commander2.default.werror ? _commander2.default.werror !== 'false' : config.werror;
 config.jscramblerVersion = _commander2.default.jscramblerVersion || config.jscramblerVersion;
@@ -99,2 +99,7 @@ config.debugMode = _commander2.default.debugMode || config.debugMode;
 
+    if (config.werror && tmpGlob.length === 0) {
+      console.error('Pattern "' + globSrc[i] + '" doesn\'t match any files.');
+      process.exit(1);
+    }
+
     if (debug) {
@@ -112,2 +117,8 @@ if (tmpGlob.length === 0) {
   }
+  if (filesSrc.length === 0) {
+    console.error('No files matched.');
+    process.exit(1);
+  }
+} else if (debug) {
+  console.log('No filesSrc provided. Using the ones in the application (if any).');
 }
@@ -114,0 +125,0 @@

dist/config.js

@@ -18,6 +18,6 @@ 'use strict';
   host: 'api4.jscrambler.com',
-  port: 443,
-  jscramblerVersion: 'stable'
+  jscramblerVersion: 'stable',
+  werror: true
 }, []);
 
 exports.default = config;

dist/index.js

@@ -61,4 +61,5 @@ 'use strict';
 
-function _asyncToGenerator(fn) { return function () { var gen = fn.apply(this, arguments); return new Promise(function (resolve, reject) { function step(key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { return Promise.resolve(value).then(function (value) { step("next", value); }, function (err) { step("throw", err); }); } } return step("next"); }); }; }
+function _asyncToGenerator(fn) { return function () { var gen = fn.apply(this, arguments); return new Promise(function (resolve, reject) { function step(key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { return Promise.resolve(value).then(function (value) { step("next", value); }, function (err) { step("throw", err); }); } } return step("next"); }); }; } /* eslint-disable no-console */
 
+
 var intoObjectType = introspection.intoObjectType;
@@ -162,3 +163,3 @@
     var _ref = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee(configPathOrObject, destCallback) {
-      var _config, finalConfig, applicationId, host, port, protocol, cafile, keys, sources, _finalConfig$stream, stream, cwd, params, applicationTypes, languageSpecifications, sourceMaps, randomizationSeed, areSubscribersOrdered, useRecommendedOrder, bail, jscramblerVersion, debugMode, proxy, accessKey, secretKey, client, filesSrc, filesDest, source, removeSourceRes, zipped, _filesSrc, i, l, content, updateData, applicationUpdate, updateApplicationRes, createApplicationProtectionRes, protectionId, protection, url, sourcesErrors, _url, download;
+      var _config, finalConfig, applicationId, host, port, protocol, cafile, keys, sources, _finalConfig$stream, stream, cwd, params, applicationTypes, languageSpecifications, sourceMaps, randomizationSeed, areSubscribersOrdered, useRecommendedOrder, _finalConfig$bail, bail, jscramblerVersion, debugMode, proxy, accessKey, secretKey, client, filesSrc, filesDest, source, removeSourceRes, zipped, _filesSrc, i, l, content, updateData, applicationUpdate, updateApplicationRes, createApplicationProtectionRes, protectionId, protection, url, sourcesErrors, _url, download;
 
@@ -171,3 +172,3 @@ return regeneratorRuntime.wrap(function _callee$(_context) {
               finalConfig = (0, _lodash2.default)(_config, _config3.default);
-              applicationId = finalConfig.applicationId, host = finalConfig.host, port = finalConfig.port, protocol = finalConfig.protocol, cafile = finalConfig.cafile, keys = finalConfig.keys, sources = finalConfig.sources, _finalConfig$stream = finalConfig.stream, stream = _finalConfig$stream === undefined ? true : _finalConfig$stream, cwd = finalConfig.cwd, params = finalConfig.params, applicationTypes = finalConfig.applicationTypes, languageSpecifications = finalConfig.languageSpecifications, sourceMaps = finalConfig.sourceMaps, randomizationSeed = finalConfig.randomizationSeed, areSubscribersOrdered = finalConfig.areSubscribersOrdered, useRecommendedOrder = finalConfig.useRecommendedOrder, bail = finalConfig.bail, jscramblerVersion = finalConfig.jscramblerVersion, debugMode = finalConfig.debugMode, proxy = finalConfig.proxy;
+              applicationId = finalConfig.applicationId, host = finalConfig.host, port = finalConfig.port, protocol = finalConfig.protocol, cafile = finalConfig.cafile, keys = finalConfig.keys, sources = finalConfig.sources, _finalConfig$stream = finalConfig.stream, stream = _finalConfig$stream === undefined ? true : _finalConfig$stream, cwd = finalConfig.cwd, params = finalConfig.params, applicationTypes = finalConfig.applicationTypes, languageSpecifications = finalConfig.languageSpecifications, sourceMaps = finalConfig.sourceMaps, randomizationSeed = finalConfig.randomizationSeed, areSubscribersOrdered = finalConfig.areSubscribersOrdered, useRecommendedOrder = finalConfig.useRecommendedOrder, _finalConfig$bail = finalConfig.bail, bail = _finalConfig$bail === undefined ? true : _finalConfig$bail, jscramblerVersion = finalConfig.jscramblerVersion, debugMode = finalConfig.debugMode, proxy = finalConfig.proxy;
               accessKey = keys.accessKey, secretKey = keys.secretKey;
@@ -585,3 +586,3 @@ client = new this.Client({
                 var _ref4 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee3() {
-                  var applicationProtection, url, state, bail;
+                  var applicationProtection, url, state;
                   return regeneratorRuntime.wrap(function _callee3$(_context3) {
@@ -609,10 +610,9 @@ while (1) {
                           state = applicationProtection.data.applicationProtection.state;
-                          bail = applicationProtection.data.applicationProtection.bail;
 
                           if (!(state !== 'finished' && state !== 'errored' && state !== 'canceled')) {
-                            _context3.next = 17;
+                            _context3.next = 16;
                             break;
                           }
 
-                          _context3.next = 14;
+                          _context3.next = 13;
                           return new Promise(function (resolve) {
@@ -622,16 +622,8 @@ return setTimeout(resolve, 500);
 
-                        case 14:
+                        case 13:
                           return _context3.abrupt('return', poll());
 
-                        case 17:
-                          if (!(state === 'errored' && !bail)) {
-                            _context3.next = 21;
-                            break;
-                          }
-
-                          throw new Error('Protection failed. For more information visit: ' + url);
-
-                        case 21:
+                        case 16:
                           if (!(state === 'canceled')) {
-                            _context3.next = 25;
+                            _context3.next = 20;
                             break;
@@ -642,6 +634,6 @@ }
 
-                        case 25:
+                        case 20:
                           return _context3.abrupt('return', applicationProtection.data.applicationProtection);
 
-                        case 26:
+                        case 21:
                         case 'end':
@@ -648,0 +640,0 @@ return _context3.stop();

package.json

 {
   "name": "jscrambler",
   "description": "Jscrambler API client.",
-  "version": "5.2.16",
+  "version": "5.2.17",
   "homepage": "https://github.com/jscrambler/jscrambler",
@@ -6,0 +6,0 @@ "author": {

README.md

@@ -11,2 +11,3 @@ # ![jscrambler](https://rawgithub.com/jscrambler/javascript-jscrambler/master/media/jscrambler-logo.png)
   - [Using configuration file](#using-configuration-file)
+  - [Options](#options)
 - [API](#api)
@@ -38,6 +39,6 @@ - [Quick example](#quick-example)
   "keys": {
-    "accessKey": "AAAA",
-    "secretKey": "SSSS"
+    "accessKey": "_YOUR_ACCESS_KEY_",
+    "secretKey": "_YOUR_SECRET_KEY_"
   },
-  "applicationId": "XXXXX",
+  "applicationId": "_YOUR_APPLICATION_ID_",
   "filesSrc": [
@@ -50,14 +51,17 @@ "/path/to/src.html",
     {
-      "name": "stringSplitting"
+      "name": "stringSplitting",
+      "options": {
+        "freq": 1
+      }
     }
   ],
   "areSubscribersOrdered": false,
-  "jscramblerVersion": "5.1"
+  "jscramblerVersion": "5.3"
 }
 ```
 
-Please, replace the `AAAA`, `SSSS` and `XXXXX` placeholders with your API credentials and Application ID.
+Please, replace the `_YOUR_ACCESS_KEY_`, `_YOUR_SECRET_KEY_` and `_YOUR_APPLICATION_ID_` placeholders with your API credentials and Application ID. If you are having trouble finding these, please check our [Getting Started](https://docs.jscrambler.com/code-integrity/getting-started) page.
 
 You can also download this file through Jscrambler's application builder. More
-information can be found [here](https://docs.jscrambler.com/api/clients.html).
+information can be found [here](https://docs.jscrambler.com/code-integrity/documentation/api/clients).
 
@@ -68,2 +72,3 @@ ## CLI
 ```
+
 ```
@@ -74,4 +79,4 @@ Usage: jscrambler [options] <file ...>
 
-    -h, --help                       output usage information
     -V, --version                    output the version number
+    -v, --version
     -a, --access-key <accessKey>     Access key
@@ -86,9 +91,10 @@ -c, --config <config>            JScrambler configuration options
     -C, --cwd <dir>                  Current Working Directory
+    -s, --secret-key <secretKey>     Secret key
     -m, --source-maps <id>           Download source maps
     -R, --randomization-seed <seed>  Set randomization seed
-    -s, --secret-key <secretKey>     Secret key
-    -R, --randomization-seed <seed>  Set randomization seed
     --recommended-order <bool>       Use recommended order
-    -W --werror                      Cancel protection if any file contains errors
+    -W, --werror <bool>              Set werror flag value (default: true)
     --jscramblerVersion <version>    Use a specific Jscrambler version
+    --debugMode                      Protect in debug mode
+    -h, --help                       output usage information
 ```
@@ -98,41 +104,33 @@
 ### Required Fields
-When making API requests you must pass valid secret and access keys, through the command line or by having a `.jscramblerrc` file. These keys are each 40 characters long, alpha numeric strings, and uppercase. You can find them in your jscramber web dashboard under `My Profile > API Credentials`. In the examples these are shortened to `AAAA` and `SSSS` for the sake of readability.
+When making API requests you must pass valid *secret* and *access keys*, through the command line or by having a `.jscramblerrc` file. These keys are each 40 characters long, alpha numeric and uppercase strings. You can find them in your Jscrambler web dashboard under `My Profile > API Credentials`. In the examples these are shortened to `_YOUR_ACCESS_KEY_` and `_YOUR_SECRET_KEY_` for the sake of readability.
 
-### Using a proxy to make requests ###
-If your requests need to go through a proxy, there is an option where you can specify the ip address, port and authentication credentials.
+### Output to a single file
+```bash
+jscrambler -a _YOUR_ACCESS_KEY_ -s _YOUR_SECRET_KEY_ -i _YOUR_APPLICATION_ID_ -o output.js input.js
 ```
-{
-  proxy: {
-    host: '',
-    port: 1234,
-    auth: {
-      username: '',
-      password: ''
-    }
-  }
-}
 
+### Output multiple files to a directory
+```bash
+jscrambler -a _YOUR_ACCESS_KEY_ -s _YOUR_SECRET_KEY_ -i _YOUR_APPLICATION_ID_ -o output/ input1.js input2.js
 ```
 
-WARNING: currently we only support HTTP proxies. In order to make it use your proxy, you just need to add the proxy details to the Jscrambler config file as above and use the port 80 of our service (this is the HTTP port of the Jscrambler API).
+### Using minimatch
+```bash
+jscrambler -a _YOUR_ACCESS_KEY_ -s _YOUR_SECRET_KEY_ -i _YOUR_APPLICATION_ID_ -o output/ "lib/**/*.js"
+```
 
+### Using configuration file
+```bash
+jscrambler -c config.json
 ```
-{
-  port: 80,
-  proxy: {
-      host: '',
-      port: 1234,
-      auth: {
-        username: '',
-        password: ''
-      }
-  }
-}
-```
+where `config.json` is a file that optionally contains any of the Jscrambler options listed [here](#jscrambler-options), using the structure described [in the RC configuration](#rc-configiguration).
 
-### Flag -W / --werror
+## Options
 
-Jscrambler by default will protect your application even if errors occurred in some of your files. For example: if your app have 5 files and 1 of them has syntax errors, Jscrambler will protect the files with no errors and keep the original content in the other one.
+### Flag -W / --werror (default: **true**)
 
-With this flag, any error/warning will make the protection fail.
+By default, Jscrambler will not protect your application when errors occur in some or all of your files. For example: if your app have 5 files and one of them has syntax errors, Jscrambler will not protect any of your files. To override this behavior you must set the `werror` flag to `false`.
+
+Any error/warning will make the protection fail.
+
 There are two possible types of errors:
@@ -150,4 +148,17 @@ * Syntax errors
     ```
-    Error: "Unexpected token [" in test.js:1
-    Protection failed
+    Global protection errors:
+    - Errors ocurred while parsing
+
+    Application sources errors:
+    [
+      {
+        "filename": "index.js",
+        "message": "SyntaxError: 'return' outside of function (1:0)",
+        "line": 1,
+        "column": null,
+        "fatal": true
+      }
+    ]
+
+    Protection failed. For more information visit: https://app.jscrambler.com/app/_YOUR_APPLICATION_ID_/protections/_PROTECTION_ID_
     ```
@@ -176,31 +187,66 @@
     ```
-    Error: "[Annotation Error] Expected " " or [a-z]i but "_" found." in test.js:1
-    Error: "[Annotation Error] Expected " ", "define", "disable", "enable", "global", "order" or "target" but "[" found." in test.js:8
-    Error: "Parsing errors on annotations" in test.js
-    Protection failed
+    Global protection errors:
+    - Failed to protect any source file
+
+    Application sources errors:
+    [
+      {
+        "filename": "index.js",
+        "message": "[Annotation Error] Expected \" \" or [a-z]i but \"_\" found.",
+        "line": 1,
+        "column": 21,
+        "fatal": true
+      },
+      {
+        "filename": "index.js",
+        "message": "[Annotation Error] Expected \" \", \"define\", \"disable\", \"enable\", \"global\", \"order\" or \"target\" but \"[\" found.",
+        "line": 8,
+        "column": 13,
+        "fatal": true
+      },
+      {
+        "filename": "index.js",
+        "message": "Parsing errors on annotations",
+        "line": null,
+        "column": null,
+        "fatal": true
+      }
+    ]
+
+    Protection failed. For more information visit: https://app.jscrambler.com/app/_YOUR_APPLICATION_ID_/protections/_PROTECTION_ID_
     ```
 
-### Output to a single file
-```bash
-jscrambler -a AAAA -s SSSS -i APP_ID -o output.js input.js
+### Using a proxy to make requests ###
+If your requests need to go through a proxy, there is an option where you can specify the ip address, port and authentication credentials.
 ```
+{
+  proxy: {
+    host: '',
+    port: 1234,
+    auth: {
+      username: '',
+      password: ''
+    }
+  }
+}
 
-### Output multiple files to a directory
-```bash
-jscrambler -a AAAA -s SSSS -i APP_ID -o output/ input1.js input2.js
 ```
 
-### Using minimatch
-```bash
-jscrambler -a AAAA -s SSSS -i APP_ID -o output/ "lib/**/*.js"
-```
+WARNING: currently we only support HTTP proxies. In order to make it use your proxy, you just need to add the proxy details to the Jscrambler config file as above and use the port 80 of our service (this is the HTTP port of the Jscrambler API).
 
-### Using configuration file
-```bash
-jscrambler -c config.json
 ```
-where `config.json` is an object optionally containing any of the JScrambler options listed [here](#jscrambler-options), using the structure described [in the RC configuration](#rc-config).
+{
+  port: 80,
+  proxy: {
+      host: '',
+      port: 1234,
+      auth: {
+        username: '',
+        password: ''
+      }
+  }
+}
+```
 
-
-### Enabling/disabling the recommended order
+### Recommended Order (default: **false**)
 ```bash
@@ -215,3 +261,2 @@ jscrambler --recommended-order false input1.js -o output/
 
-
 ## API
@@ -228,8 +273,8 @@ ```bash
   keys: {
-    accessKey: 'YOUR_JSCRAMBLER_ACCESS_KEY',
-    secretKey: 'YOUR_JSCRAMBLER_SECRET_KEY'
+    accessKey: '_YOUR_ACCESS_KEY_',
+    secretKey: '_YOUR_SECRET_KEY_'
   },
   host: 'api4.jscrambler.com',
   port: 443,
-  applicationId: 'YOUR_APPLICATION_ID',
+  applicationId: '_YOUR_APPLICATION_ID_',
   filesSrc: [
@@ -236,0 +281,0 @@ '/path/to/src/*.html',

No alert changes

Improved metrics

Total package byte prevSize

111457

1.35%

Lines of code

2436

0.21%

Number of lines in readme file

296

17.93%

Worsened metrics

Number of package files

17

-5.56%

No dependency changes