encrypt-rsa 2.0.0 → 2.1.2

package/README.md

@@ -4,11 +4,15 @@
 [![npm version](https://badge.fury.io/js/encrypt-rsa.svg)](https://badge.fury.io/js/encrypt-rsa) 
 ![https://img.shields.io/npm/dm/encrypt-rsa.svg](https://img.shields.io/npm/dm/encrypt-rsa.svg)
 
-> RSA is a public-key cryptosystem that is widely used for secure data transmission. It is also one of the oldest. The acronym RSA comes from the surnames of Ron Rivest, Adi Shamir and Leonard Adleman, who publicly described the algorithm in 1977. [Wikipedia](https://en.wikipedia.org/wiki/RSA_(cryptosystem))
+This package works fine with web browsers and servers
+
+> RSA is a public-key cryptoSystem that is widely used for secure data transmission. It is also one of the oldest. The acronym RSA comes from the surnames of Ron Rivest, Adi Shamir and Leonard Adleman, who publicly described the algorithm in 1977. [Wikipedia](https://en.wikipedia.org/wiki/RSA_(cryptosystem))
 
 RSA algorithm is asymmetric cryptography algorithm. Asymmetric actually means that it works on two different keys i.e. Public Key and Private Key. As the name describes that the Public Key is given to everyone and Private key is kept private.
 
-### For more explanation about RSA Algorithm visit [https://milad-ezzat.vercel.app/posts/rsa-encryption-algorithm](https://milad-ezzat.vercel.app/posts/rsa-encryption-algorithm)
+### For more explanation about RSA Algorithm visit 
+
+- [Rsa Algorithm](https://milad-ezzat.vercel.app/blog/encrypt-by-rsa-algorithm)
 
 1. [Installation](#installation)
 2. [Usage](#usage)
@@ -16,59 +20,56 @@ RSA algorithm is asymmetric cryptography algorithm. Asymmetric actually means th
 ## Installation
 
 ```bash
-  npm i encrypt-rsa
-
+  npm i encrypt-rsa --only=production
   // OR
-
-  yarn add encrypt-rsa
+  yarn add encrypt-rsa --only=production
 ```
 
-
 ## Usage
 
 ```js
-import NodeRSA from 'encrypt-rsa';
+import EncryptRsa from 'encrypt-rsa';
 
 //OR
 
-const NodeRSA = require('encrypt-rsa').default;
+const EncryptRsa = require('encrypt-rsa').default;
 
-const fs = require('fs'); // Or import * as fs from 'fs';
-
-const nodeRSA = new NodeRSA();
-
-// create public and private keys
-
-const { privateKey, publicKey } = nodeRSA.createPrivateAndPublicKeys()
+// create instance
+const encryptRsa = new EncryptRsa();
+```
 
-// to save your keys
-fs.writeFileSync('./private-key', privateKey);
-fs.writeFileSync('./public-key', publicKey);
+### Create Private and Public keys
 
+```js
+const { privateKey, publicKey } = nodeRSA.createPrivateAndPublicKeys();
+```
 
-// you must have 'public-key' file the key you want to encrypt by it
+### Encrypt Text
 
-const encryptedText = nodeRSA.encryptStringWithRsaPublicKey({ 
-  text: 'hello', 
-  keyPath: path.join(__dirname, './public-key') 
+```js
+const encryptedText = encryptRsa.encryptStringWithRsaPublicKey({ 
+  text: 'hello world',   
+  publicKey,
 });
+console.log(encryptedText);
 
-console.log({ encryptedText });
-
-//result:  {
-//   encryptedText: 'QAoJBAj7ZqYR9Qb9vFGfpjBVY7BP0MtlPywyxMSodA7WmOmOn0glOlrLxUqjJrmaKsqxdJxZadEMAM8+6gLNhwcLtbFPRLQEUTSHk2NNhehsPOESoNjwbXOj5Y+zBCSkjVuW6MRkdaTZeGXi0sii1OqvIQGmOaOR2xzEdDj2eD8='
-// }
+// QMPLJN3KzvXxkll18wax+KxqC0UqiHrwMxYGNUmJWMi98diapGOL/WzliPP3bTrHu7yWU1DnaB3f71w6JBYP+wG98fWLaz8+rwemerVja8B0FJVUphjBUmoDhX52JSoLFI0YVHtihXtoRk1pVaRFWm8FmZPZAcCKL7a0YDI1wABGvcSbLhaacmgX6zR6fzyltWVCrXn0NcVGox7WK7x4sCtywNhZx2XuUVSztr7QYcV2OQe8aDTUd7NXtaBVkj9RUYUR2QvhIpETksx14WD4ytohM68RUIJLRmU3y761mxcF+7Pjw/Utcirqu2Ohg0K18xGqlaE6fdifh0vIlfH+kA==
+```
 
-// you must have 'private-key' file the key you want to decrypt by it
+### Decrypt Encrypted Text
 
+```js
 const decryptedText = nodeRSA.decryptStringWithRsaPrivateKey({ 
   text: encryptedText, 
-  keyPath: path.join(__dirname, './private-key') 
+  privateKey
 });
+console.log(decryptedText);
+// hello world
+```
 
-console.log({ decryptedText });
-// result: { decryptedText: 'hello' }
+## Rsa Algorithm:
+- [RSA Algorithm](https://simple.wikipedia.org/wiki/RSA_algorithm)
 
-```
-for more information about RSA:
-[https://simple.wikipedia.org/wiki/RSA_algorithm](https://simple.wikipedia.org/wiki/RSA_algorithm)
+
+### Contributions
+feel free to open an [issue](https://github.com/miladezzat/encrypt-rsa/issues) and make a [pull request](https://github.com/miladezzat/encrypt-rsa/pulls)

package/build/index.js

@@ -24,9 +24,9 @@ var NodeRSA = /** @class */ (function () {
      */
     NodeRSA.prototype.encryptStringWithRsaPublicKey = function (args) {
         var text = args.text, _a = args.publicKey, publicKey = _a === void 0 ? this.publicKey : _a;
-        var publicKeyDecoded = helpers_1.decode(this.convertKetToBase64(publicKey));
+        var publicKeyDecoded = (0, helpers_1.decode)(this.convertKetToBase64(publicKey));
         var buffer = Buffer.from(text);
-        var encrypted = crypto_1.publicEncrypt(publicKeyDecoded, buffer);
+        var encrypted = (0, crypto_1.publicEncrypt)(publicKeyDecoded, buffer);
         return encrypted.toString('base64');
     };
     /**
@@ -39,14 +39,14 @@ var NodeRSA = /** @class */ (function () {
      */
     NodeRSA.prototype.decryptStringWithRsaPrivateKey = function (args) {
         var text = args.text, _a = args.privateKey, privateKey = _a === void 0 ? this.privateKey : _a;
-        var privateKeyDecoded = helpers_1.decode(this.convertKetToBase64(privateKey));
+        var privateKeyDecoded = (0, helpers_1.decode)(this.convertKetToBase64(privateKey));
         var buffer = Buffer.from(text, 'base64');
-        var decrypted = crypto_1.privateDecrypt(privateKeyDecoded, buffer);
+        var decrypted = (0, crypto_1.privateDecrypt)(privateKeyDecoded, buffer);
         return decrypted.toString('utf8');
     };
     NodeRSA.prototype.createPrivateAndPublicKeys = function (modulusLength) {
         if (modulusLength === void 0) { modulusLength = this.modulusLength; }
-        var _a = crypto_1.generateKeyPairSync('rsa', {
+        var _a = (0, crypto_1.generateKeyPairSync)('rsa', {
             modulusLength: modulusLength,
             publicKeyEncoding: {
                 type: 'spki',
@@ -60,7 +60,7 @@ var NodeRSA = /** @class */ (function () {
         return { privateKey: privateKey, publicKey: publicKey };
     };
     NodeRSA.prototype.convertKetToBase64 = function (key) {
-        return helpers_1.encode(key.replace(/^ +/gm, '') || this.keyBase64);
+        return (0, helpers_1.encode)(key.replace(/^ +/gm, '') || this.keyBase64);
     };
     return NodeRSA;
 }());

package/package.json

@@ -1,49 +1,53 @@
 {
   "name": "encrypt-rsa",
-  "version": "2.0.0",
-  "description": "this is a little module use to encrypt and decrypt strings with RSA keys (public and private keys)",
+  "version": "2.1.2",
+  "description": "This is a little module use to encrypt and decrypt strings with RSA keys (public and private keys)",
   "main": "./build/index.js",
   "module": "./build/index.js",
   "files": [
     "build/**/*"
   ],
+  "engines": {
+    "node": "16.x",
+    "npm": "8.x"
+  },
   "types": "./build/index.d.ts",
   "source": "./src/index.ts",
   "scripts": {
-    "test": "./node_modules/.bin/mocha -r ts-node/register tests/**/*.spec.ts",
-    "depcheck": "./node_modules/.bin/depcheck",
+    "test": "mocha -r ts-node/register tests/**/*.spec.ts",
+    "depcheck": "npm-check",
     "prepare": "husky install",
     "build": "tsc",
-    "commit": "./node_modules/.bin/git-cz",
+    "commit": "git-cz",
     "docs:serve": "docsify serve docs",
     "_postinstall": "husky install",
     "prepublishOnly": "pinst --disable",
     "postpublish": "pinst --enable",
-    "husky": "./node_modules/.bin/husky",
-    "lint": "./node_modules/.bin/eslint",
+    "prepublish": "npm run build",
+    "husky": "husky",
+    "lint": "eslint",
     "release:major": "changelog -M && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version major && git push origin && git push origin --tags",
     "release:minor": "changelog -m && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version minor && git push origin && git push origin --tags",
     "release:patch": "changelog -p && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version patch && git push origin && git push origin --tags"
   },
   "devDependencies": {
     "@types/chai": "^4.2.21",
-    "@types/mocha": "^8.2.3",
-    "@types/node": "^16.3.3",
-    "@typescript-eslint/eslint-plugin": "^4.28.3",
-    "@typescript-eslint/parser": "^4.28.3",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^17.0.38",
+    "@typescript-eslint/eslint-plugin": "^5.27.0",
+    "@typescript-eslint/parser": "^5.27.0",
     "chai": "^4.3.4",
     "commitizen": "^4.2.4",
-    "docsify-cli": "^4.4.3",
     "cz-conventional-changelog": "^3.3.0",
-    "depcheck": "^1.4.2",
-    "eslint": "^7.31.0",
-    "eslint-config-airbnb-base": "^14.2.1",
+    "docsify-cli": "^4.4.3",
+    "eslint": "^8.16.0",
+    "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.23.4",
     "generate-changelog": "^1.8.0",
     "git-cz": "^4.7.6",
-    "husky": "^7.0.1",
-    "mocha": "^9.0.2",
-    "pinst": "^2.1.6",
+    "husky": "^8.0.1",
+    "mocha": "^10.0.0",
+    "pinst": "^3.0.0",
     "ts-node": "^10.1.0",
     "typescript": "^4.3.5"
   },
@@ -80,5 +84,8 @@
   "bugs": {
     "url": "https://github.com/miladezzat/encrypt-rsa/issues"
   },
-  "homepage": "https://encrypt-rsa.js.org"
+  "homepage": "https://encrypt-rsa.js.org",
+  "dependencies": {
+    "npm-check": "^5.9.2"
+  }
 }

package/CHANGELOG.md

@@ -1,89 +0,0 @@
-## 2.0.0 (2022-03-23)
-
-##### Documentation Changes
-
-*  update docs ([e4e3f254](https://github.com/miladezzat/encrypt-rsa/commit/e4e3f254a4819922138f1e1763415207dc1591c6))
-*  update docs ([de0f8024](https://github.com/miladezzat/encrypt-rsa/commit/de0f8024aad85c591273f93b50952cd72e230693))
-
-##### New Features
-
-*  make methods to take public and private keys as strings ([d47af0f5](https://github.com/miladezzat/encrypt-rsa/commit/d47af0f5c39d49cfb1589b0e236cc7c995bfb395))
-*  add new helper methods to decode and encode keys to base64 ([d3cba4c0](https://github.com/miladezzat/encrypt-rsa/commit/d3cba4c0f36d42e615f22c4ed4b828ed151faecb))
-*  update the docs ([4e470c6f](https://github.com/miladezzat/encrypt-rsa/commit/4e470c6feabfc828172bc484285239a24df064a4))
-
-##### Tests
-
-*  add tests ([373d6c12](https://github.com/miladezzat/encrypt-rsa/commit/373d6c125184bd2e1394091def64280a5392413e))
-
-#### 1.2.1 (2022-02-11)
-
-##### Documentation Changes
-
-*  update docs ([846687b4](https://github.com/miladezzat/encrypt-rsa/commit/846687b4226bad946b2c0a20636ebec433c9005a))
-
-##### New Features
-
-*  add encrypt-rsa.js.org ([3f6b0b4e](https://github.com/miladezzat/encrypt-rsa/commit/3f6b0b4e1fbc8082b9416f3dadd3be277a6e5c3f))
-
-### 1.2.0 (2022-02-09)
-
-##### Documentation Changes
-
-*  set docs ([6f1fa5e3](https://github.com/miladezzat/encrypt-rsa/commit/6f1fa5e38e7d1ef0576a8e49501766f540715477))
-
-### 1.1.0 (2021-07-21)
-
-##### Documentation Changes
-
-*  ✏️ update docs for creating keys ([cebb2758](https://github.com/miladezzat/encrypt-rsa/commit/cebb2758ac55478d46f0ae6228a10f8f1f78b8c3))
-
-##### New Features
-
-*  🎸 add create public and private keys ([74c51131](https://github.com/miladezzat/encrypt-rsa/commit/74c51131a858ad28cdda605b479b6bd21297e730))
-
-#### 1.0.12 (2021-07-20)
-
-##### Chores
-
-*  🤖 update keywords ([b435e3ba](https://github.com/miladezzat/encrypt-rsa/commit/b435e3ba757a80dd66b95ed8a8a668952b66558e))
-
-#### 1.0.11 (2021-07-20)
-
-##### Bug Fixes
-
-*  🐛 solve docs ([8a08c44e](https://github.com/miladezzat/encrypt-rsa/commit/8a08c44e767d5dcd242b5a5806602468cb663ec1))
-
-#### 1.0.10 (2021-07-20)
-
-##### Documentation Changes
-
-*  ✏️ update readme ([e29f1805](https://github.com/miladezzat/encrypt-rsa/commit/e29f180513d8f79daaad9fee7e0a532e2e94f076))
-
-#### 1.0.9 (2021-07-19)
-
-#### 1.0.8 (2021-07-19)
-
-#### 1.0.8 (2021-07-19)
-
-#### 1.0.5 (2021-07-19)
-
-#### 1.0.4 (2021-07-19)
-
-#### 1.0.4 (2021-07-19)
-
-#### 1.0.3 (2021-07-19)
-
-#### 1.0.2 (2021-07-19)
-
-#### 1.0.1 (2021-07-19)
-
-##### Other Changes
-
-* miladezzat/rsa-node ([5f3c40de](https://github.com/miladezzat/encrypt-rsa/commit/5f3c40deb5cf9424bee39bfae4620866e828fcf8))
-
-## 1.0.0 (2021-07-18)
-
-##### Other Changes
-
-* miladezzat/rsa-node (5f3c40de)
-