feat(randomStr): add random string generated

- add randomString static method - remove ncrypt.d.ts file - add ci.yml file to test on master and pr - move all functions from utils.ts to ncrypt.ts file - remove redundant travis.yml file - refactor source code
ajimae · Mar 24, 2024 · e1a9b91 · e1a9b91
1 parent ded0a51
commit e1a9b91
Show file tree

Hide file tree

Showing 11 changed files with 240 additions and 223 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,18 @@
+name: Test
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 12
+          cache: 'yarn'
+      - run: yarn install --production=false
+      - run: yarn test
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -17,7 +17,7 @@ jobs:
       - name: node setup
         uses: actions/setup-node@v4
         with:
-          node-version: 14
+          node-version: 12
           cache: 'yarn'
 
       - name: install dependencies
@@ -39,7 +39,7 @@ jobs:
       - name: node setup
         uses: actions/setup-node@v4
         with:
-          node-version: 14
+          node-version: 12
           registry-url: https://registry.npmjs.org
           cache: 'yarn'
 

diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -6,25 +6,17 @@
 
 **_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.
 
-<!-- ```diff
-- const ReduxThunk = require('redux-thunk')
-+ const ReduxThunk = require('redux-thunk').default
-``` -->
-
 ## Contents
 
 * [NcryptJs](#NcryptJs)
   * [Contents](#contents)
-  <!-- * [Changes Log (What's New)](#changes-log-whats-new) -->
   * [Getting Started](#getting-started)
     * [Installation](#installation)
   * [Documentation](#documentation)
-    * [NcryptJs Functions](#ncryptjs-functions)
-    * [Using `encrypt()` and `decrypt()`](#using-encrypt-and-decrypt)
-    * [Using default imports](#Using-default-imports)
-    <!-- * [Change the Secret Key](#change-the-secret-key)
-    * [Object Encryption](#object-encryption)
-    * [Random Key Generator](#random-key-generator) -->
+    * [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)
   * [Built With](#built-with)
   * [Contribution](#contribution)
   * [Version Management](#version-management)
@@ -82,23 +74,38 @@ However, if you are using ECMAScript 5 and older, use the require statement:
 
 **_NcryptJs_** is a simple library with only two two exposed functions. This is all intentional mainly to keep everything simple. This is a complete documentation of the library and how to use it in your project. All examples work on both ECMAScript 6 (and later) and ECMAScript 5 (and older).
 
-### NcryptJs Functions
+### NcryptJs Methods
 
 
-### List of **_NcryptJs_** functions.
+### List of **_NcryptJs_** Methods.
 
 
 
-| Functions                                                                                              | Description                                                                                            | Parameters                                                                                             | Return                                                                                                 |
+| Methods                                                                                              | Description                                                                                            | Parameters                                                                                             | Return                                                                                                 |
 | -------------------------------------------------------------                                          | --------------------------------------------------------------------------------------                 | -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------                                                                             | ----------------------------------------------------------------------------------------------------------------                                                                                                |
+| [_static_] **randomString()**                                                                                          | Random String.                                                                                     |**size**: _number_ - An optional size of the generated `randomBytes`. <br/>**enc:** _base64/hex_ - Encoding used for encoding the `randomBytes` defaults to _`base64`_ |**encoded**: _string_ - encoded string.                                                                    |
 | **encrypt()**                                                                                          | Encrypts data.                                                                                     |**data**: _object/string/number/boolean_ - The data to be encrypted. <br/>|**ciphered**: _string_ - encrypted data.                                                                    |
 | **decrypt()**                                                                                          | Decrypts the encrypted or ciphered data                                                                 | **encodedData**: string - The encrypted data: _string_ to be decrypted.                        | **data**: _string/object/number/boolean_ - The decrypted or original data (it might be string or object, depends on the initial input data type).
 
 
+### 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.
+
+```ts
+var ncrypt = require('ncrypt-js');
+
+var randomStr = ncrypt.randomString(8, 'base64');
+console.log(randomStr) // t78WcmYAFOY=
 
-#### Using `encrypt()` and `decrypt()` functons - As of version 2.0.0 directly importing or invoking these functions is deprecated, an object must be created with a secret first, before the methods can now be invoked on the created object.
+// signature
+ncrypt.randomString(size?: number, enc?: 'base64' | 'hex');
+```
 
-To encrypt and decrypt data, simply use `encrypt()` and `decrypt()` functions respectively. This will use `AES-256-CBC` encryption algorithm as the mid-channel cipher.
+### 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.
+
+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");
@@ -108,7 +115,7 @@ To encrypt and decrypt data, simply use `encrypt()` and `decrypt()` functions re
 var data = "Hello World!";
 var _secretKey = "some-super-secret-key";
 
-+ var { encodeData, decodeData } = new ncrypt(_secretKey);
++ var { encrypt, decrypt } = new ncrypt(_secretKey);
 
 // encrypting super sensitive data here
 - var encryptedData = encrypt(data, _secretKey);
@@ -180,11 +187,16 @@ 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.
 
-```diff
-// .env
+```bash
+# .env
+
+# used internally to set the `key`
+KEY='sshhhh this is a super secret key'
+
+# used internally to set the `encoding` - ['base64' | 'binary' | 'hex' | 'ucs-2' | 'ucs2' | 'utf16le']
+NCRPT_ENC='hex'
 
-KEY=sshhhh this is a super secret key
-SECRET=this is our hashing secret
+SECRET='this is our hashing secret'
 ```
 Then when creating your object, you can use the SECRET from your environment e.g:
 ```

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ncrypt-js",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "a light weight javascript data encryption and decryption library",
   "main": "dist/index.js",
   "scripts": {
@@ -28,7 +28,7 @@
     "decryption",
     "javascript-library"
   ],
-  "author": "meeky",
+  "author": "ajimae",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/ajimae/ncrypt-js/issues"
@@ -46,7 +46,7 @@
     "mocha-lcov-reporter": "^1.3.0",
     "nyc": "^14.1.1",
     "ts-node": "^8.6.2",
-    "typescript": "^3.8.3"
+    "typescript": "3.8.3"
   },
   "files": [
     "dist",

diff --git a/src/ncrypt.d.ts b/src/ncrypt.d.ts