ncrypt-js 2.1.0 → 2.1.2

package/README.md

@@ -1,8 +1,8 @@
 # NcryptJs
 
-[![Build Status](https://travis-ci.com/ajimae/ncrypt-js.svg?branch=master)](https://travis-ci.com/ajimae/ncrypt-js) [![Coverage Status](https://coveralls.io/repos/github/ajimae/ncrypt-js/badge.svg)](https://coveralls.io/github/ajimae/ncrypt-js) [![NPM](https://img.shields.io/npm/l/ncrypt-js)](https://www.npmjs.com/package/ncrypt-js/v/2.0.0#license)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ajimae/ncrypt-js/release.yml) [![Coverage Status](https://coveralls.io/repos/github/ajimae/ncrypt-js/badge.svg)](https://coveralls.io/github/ajimae/ncrypt-js) ![NPM Downloads](https://img.shields.io/npm/dw/ncrypt-js)
 
-[![GitHub release (latest by date)](https://img.shields.io/github/v/release/ajimae/ncrypt-js)](https://github.com/ajimae/ncrypt-js/releases) [![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/ajimae/ncrypt-js)](https://github/languages/code-size/ajimae/ncrypt-js) [![GitHub issues](https://img.shields.io/github/issues/ajimae/ncrypt-js)](https://github.com/ajimae/ncrypt-js/issues)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/ajimae/ncrypt-js)](https://github.com/ajimae/ncrypt-js/releases) [![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/ajimae/ncrypt-js)](https://github/languages/code-size/ajimae/ncrypt-js) [![GitHub issues](https://img.shields.io/github/issues/ajimae/ncrypt-js)](https://github.com/ajimae/ncrypt-js/issues) [![NPM](https://img.shields.io/npm/l/ncrypt-js)](https://www.npmjs.com/package/ncrypt-js/v/2.0.0#license)
 
 **_NcryptJs_** is a light weight javascript data encryption and decryption library. This library implements the nodejs default crypto functionality as a mid-channel cipher in addition to a simple and elegant custom data encoding and encryption algorithm.
 
@@ -16,7 +16,8 @@
     * [NcryptJs Methods](#ncryptjs-methods)
     * [Using the `randomString()` methods](#using-randomstring-method)
     * [Using `encrypt()` and `decrypt()` methods](#using-encrypt-and-decrypt-methods)
-    * [Using default imports](#using-default-imports)
+    * [Stirng Encryption](#string-encryption)
+    * [Object Encryption](#object-encryption)
   * [Built With](#built-with)
   * [Contribution](#contribution)
   * [Version Management](#version-management)
@@ -51,23 +52,17 @@ yarn add ncrypt-js
 
 To include **_ncrypt-js_** in your project. use one of these:
 
-```diff
+```js
 // ES6 and later
-+ import ncrypt from "ncrypt-js";
-- import * as ncrypt from "ncrypt-js";
-
-// or
-- import { encrypt, decrypt } from "ncrypt-js";
+import ncrypt from "ncrypt-js";
+// or import { ncrypt } from "ncrypt-js"
 ```
 
 However, if you are using ECMAScript 5 and older, use the require statement:
 
-```diff
+```js
 // ES5 and older
-+ var ncrypt = require("ncrypt-js");
-
-// or
-- var { encrypt, decrypt } = require("ncrypt-js");
+var { ncrypt } = require("ncrypt-js");
 ```
 
 ## Documentation
@@ -90,10 +85,10 @@ However, if you are using ECMAScript 5 and older, use the require statement:
 
 ### Using randomString method
 
-The `randomString()` static method can generate [random bytes](https://nodejs.org/api/crypto.html#cryptorandombytessize-callback) encoded into a `hexadecimal` or `base64` strings. This string can be useful in a variety of use cases e.g to generate database ids, to generate a unique string for a list, a unique serial strings etc.
+The `randomString()` static method can generate [random bytes](https://nodejs.org/api/crypto.html#cryptorandombytessize-callback) encoded into a `hexadecimal` or `base64` strings. This string can be useful in a variety of use cases e.g to generate database ids, to generate a unique string for a list, a unique serial strings, api keys etc.
 
 ```ts
-var ncrypt = require('ncrypt-js');
+var { ncrypt } = require('ncrypt-js'); // or import ncrypt from 'ncrypt-js'
 
 var randomStr = ncrypt.randomString(8, 'base64');
 console.log(randomStr) // t78WcmYAFOY=
@@ -103,13 +98,13 @@ ncrypt.randomString(size?: number, enc?: 'base64' | 'hex');
 ```
 
 ### Using encrypt() and decrypt() methods
-The `encrypt()` and `decrypt()` methods as of version 2.0.0 directly importing or invoking these methods is deprecated, an object must be created with a secret first, before the methods can now be invoked on the created object.
+The `encrypt()` and `decrypt()` methods as of version 2.0.0 directly importing or invoking these methods is `deprecated`, an object must first be created with a secret, before the methods can then be invoked on the created object.
 
 To `encrypt` and `decrypt` data, simply use `encrypt()` and `decrypt()` methods respectively. This will use `AES-256-CBC` encryption algorithm as the mid-channel cipher.
 
 ```diff
 - var { encrypt, decrypt } = require("ncrypt-js");
-+ var ncrypt = require("ncrypt-js");
++ var { ncrypt } = require("ncrypt-js");
 
 
 var data = "Hello World!";
@@ -125,17 +120,17 @@ console.log("Encryption process...");
 console.log("Plain Text    : " + data);
 console.log("Cipher Text   : " + encryptedData);
 
-// decrypted super encrypted string here
+// decrypting the encrypted super sensitive data here
 var decryptedData = decrypt(encryptedData);
 console.log("... and then decryption...");
 console.log("Decipher Text : " + decryptedData);
 console.log("...done.");
 ```
 
-### Using default imports
+### String Encryption
 
 ```javascript
-var ncrypt = require("ncrypt-js");
+var { ncrypt } = require("ncrypt-js");
 
 var data = "Hello World!";
 var _secretKey = "some-super-secret-key";
@@ -148,7 +143,7 @@ console.log("Encryption process...");
 console.log("Plain Text    : " + data);
 console.log("Cipher Text   : " + encryptedData);
 
-// decrypted super encrypted string here
+// decrypted super encrypted data here
 var decryptedData = ncryptObject.decrypt(encryptedData);
 console.log("... and then decryption...");
 console.log("Decipher Text : " + decryptedData);
@@ -163,7 +158,7 @@ To encrypt and decrypt JavaScript object literal, simply use `encrypt()` and `de
 
 
 ```javascript
-var ncrypt = require("ncrypt-js");
+var { ncrypt } = require("ncrypt-js");
 
 var _secretKey = "some-super-secret-key";
 var object = {
@@ -176,13 +171,13 @@ var ncryptObject = new ncrypt('ncrypt-js');
 // encrypting super sensitive data here
 var encryptedObject = ncryptObject.encrypt(object);
 console.log("Encryption process...");
-console.log("Plain Object     : " + object);
+console.log("Plain Object     : ", object);
 console.log("Encrypted Object : " + encryptedObject);
 
-// decrypted super encrypted string here
+// decrypted super sensitive data here
 var decryptedObject = ncryptObject.decrypt(encryptedObject);
 console.log("... and then decryption...");
-console.log("Decipher Text : " + decryptedObject);
+console.log("Decipher Text : ", decryptedObject);
 console.log("...done.");
 ````
 If you are using any sort of environmental key-value store, e.g `.env` and for additional security, you can add the following to your environment.
@@ -194,17 +189,20 @@ If you are using any sort of environmental key-value store, e.g `.env` and for a
 KEY='sshhhh this is a super secret key'
 
 # used internally to set the `encoding` - ['base64' | 'binary' | 'hex' | 'ucs-2' | 'ucs2' | 'utf16le']
-NCRPT_ENC='hex'
+NCRYPT_ENC='hex'
 
 SECRET='this is our hashing secret'
 ```
-Then when creating your object, you can use the SECRET from your environment e.g:
-```
-...
-var ncrypt = require('ncrypt-js');
+When creating your object, you can use the `SECRET` from your environment e.g:
+
+```js
+var { ncrypt } = require('ncrypt-js');
 var { encrypt, decrypt } = new ncrypt(process.env.SECRET);
 ...
 ```
+_**NOTE:** The secret is required to decrypt the encrypted data, if the secret used to encrypt a specific data is lost, then that data cannot be decrypted._
+
+_Same goes for encoding, if data was encrypted using `hex` encoding format, decrypting with a `base64` encoding or other encoding format and vise versa will not work_
 
 ## Built With 
 
@@ -214,7 +212,7 @@ Written in [TypeScript](https://typscriptlang.org/), built into ECMAScript 5 usi
 
 To contribute, simply fork this project, and issue a pull request.
 
-## Version Management
+## Versioning
 
 We use [SemVer](http://semver.org/) for version management. For the versions available, see the [tags on this repository](https://github.com/ajimae/ncrypt-js/tags).
 

package/dist/index.js

@@ -6,4 +6,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ncrypt_1 = __importDefault(require("./src/ncrypt"));
 exports.ncrypt = ncrypt_1.default;
 module.exports = ncrypt_1.default;
+module.exports.ncrypt = ncrypt_1.default;
 exports.default = ncrypt_1.default;

package/dist/src/ncrypt.js

@@ -91,7 +91,7 @@ class Ncrypt {
             return decrypted.toString();
         };
         this.secret = secret;
-        // bind public instnace methods
+        // bind public instance methods
         this.encrypt = this.encrypt.bind(this);
         this.decrypt = this.decrypt.bind(this);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ncrypt-js",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "description": "a light weight javascript data encryption and decryption library",
   "main": "dist/index.js",
   "scripts": {
@@ -51,10 +51,6 @@
   "files": [
     "dist",
     "package.json",
-    "LICENSE",
-    "tsconfig.json"
-  ],
-  "dependencies": {
-    "crypto": "^1.0.1"
-  }
+    "LICENSE"
+  ]
 }

package/tsconfig.json

@@ -1,23 +0,0 @@
-{
-  "compilerOptions": {
-      "target": "es2015",
-      "module": "commonjs",
-      "lib": ["es2015", "es2016", "dom", "es2017", "es6", "es5"],
-      "esModuleInterop": true,
-      "noImplicitAny": true,
-      "moduleResolution": "node",
-      "declaration": true,
-      "sourceMap": false,
-      "outDir": "dist",
-      "baseUrl": ".",
-      "paths": {
-          "*": ["node_modules/*","src/types/*"]
-      }
-  },
-  "include": [
-    "src/**/*", "index.ts",
-  ],
-  "exclude": [
-    "test/**/*"
-  ]
-}