@mhmdhammoud/meritt-utils 1.0.1

package/.eslintignore

@@ -0,0 +1,2 @@
+*.d.ts
+dist

package/.eslintrc.js

@@ -0,0 +1,28 @@
+module.exports = {
+	plugins: ['@typescript-eslint/eslint-plugin', 'eslint-plugin-tsdoc'],
+	extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+	parser: '@typescript-eslint/parser',
+	parserOptions: {
+		project: './tsconfig.json',
+		tsconfigRootDir: __dirname,
+		ecmaVersion: 2018,
+		sourceType: 'module',
+	},
+	rules: {
+		'tsdoc/syntax': 'warn',
+		'@typescript-eslint/ban-ts-comment': 'off',
+		'@typescript-eslint/ban-types': 'off',
+		'@typescript-eslint/no-namespace': 'off',
+		'@typescript-eslint/no-unused-vars': [
+			'warn',
+			{
+				vars: 'all',
+				args: 'after-used',
+				ignoreRestSiblings: true,
+			},
+		],
+		'@typescript-eslint/no-explicit-any': 'off',
+		'no-async-promise-executor': 'off',
+	},
+	root: true,
+}

package/.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": false,
+  "singleQuote": true,
+  "useTabs": true,
+  "bracketSpacing": false
+}

package/README.md

@@ -0,0 +1,27 @@
+# Meritt Utility functions
+
+This is a collection of utility functions that are often used in Meritt projects.
+
+## Installation
+
+For npm:
+
+```bash
+npm install @mhmdhammoud/meritt-utils
+```
+
+or for yarn:
+
+```bash
+yarn add @mhmdhammoud/meritt-utils
+```
+
+## Usage
+
+```typescript
+import {Crypto} from '@mhmdhammoud/meritt-utils'
+
+// Example of getting all Crypto methods
+const encryptedMessage = Crypto.encrypt('Hello World', 7)
+const decryptedMessage = Crypto.decrypt(encryptedMessage, 7)
+```

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { Crypto } from './lib';

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Crypto = void 0;
+var lib_1 = require("./lib");
+Object.defineProperty(exports, "Crypto", { enumerable: true, get: function () { return lib_1.Crypto; } });

package/dist/lib/cypto.d.ts

@@ -0,0 +1,68 @@
+/**
+ * The Crypto class
+ * @class Crypto
+ * @example
+ * ```typescript
+ * import crypto from './lib/crypto'
+ * ```
+ * */
+declare class Crypto {
+    private _primeNumberP;
+    private _primeNumberQ;
+    private _moduloDenominator;
+    /**
+     * Set the P prime number for the RSA algorithm
+     * @param {string} primeP - The prime number P
+     * @memberof Crypto
+     * @example
+     * ```typescript
+     * crypto.setPrimeP(17)
+     * ```
+     * */
+    setPrimeP(primeP: number): void;
+    /**
+     * Set the Q prime number for the RSA algorithm
+     * @param {string} primeQ - The prime number Q
+     * @memberof Crypto
+     * @example
+     * ```typescript
+     * crypto.setPrimeQ(19)
+     * ```
+     * */
+    setPrimeQ(primeQ: number): void;
+    /**
+     *
+     * @param {string} base - The base number
+     * @param {string} exponent - The exponent number
+     * @memberof Crypto
+     * @example
+     * ```typescript
+     * this.modularExponentiation(2, 3)
+     * ```
+     * */
+    private _modularExponentiation;
+    /**
+     * Encrypt the message using the public key
+     * @param {string} message - The message to encrypt
+     * @param {string} publicKey - The public key
+     * @memberof Crypto
+     * @example
+     * ```typescript
+     * crypto.encrypt('Hello World', 7)
+     * ```
+     * */
+    encrypt: (message: string, publicKey: number) => number[];
+    /**
+     * Decrypt the message using the private key
+     * @param {string} encryptedMessage - The ciphertext to decrypt
+     * @param {string} privateKey - The private key
+     * @memberof Crypto
+     * @example
+     * ```typescript
+     * crypto.decrypt([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100], 23)
+     * ```
+     * */
+    decrypt: (encryptedMessage: number[], privateKey: number) => string;
+}
+declare const crypto: Crypto;
+export default crypto;

package/dist/lib/cypto.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * The Crypto class
+ * @class Crypto
+ * @example
+ * ```typescript
+ * import crypto from './lib/crypto'
+ * ```
+ * */
+class Crypto {
+    constructor() {
+        // Default variables
+        this._primeNumberP = 17;
+        this._primeNumberQ = 19;
+        this._moduloDenominator = this._primeNumberP * this._primeNumberQ;
+        /**
+         *
+         * @param {string} base - The base number
+         * @param {string} exponent - The exponent number
+         * @memberof Crypto
+         * @example
+         * ```typescript
+         * this.modularExponentiation(2, 3)
+         * ```
+         * */
+        this._modularExponentiation = (base, exponent) => {
+            if (this._moduloDenominator === 1) {
+                return 0;
+            }
+            let result = 1;
+            base = base % this._moduloDenominator;
+            while (exponent > 0) {
+                if (exponent % 2 === 1) {
+                    result = (result * base) % this._moduloDenominator;
+                }
+                exponent = Math.floor(exponent / 2);
+                base = (base * base) % this._moduloDenominator;
+            }
+            return result;
+        };
+        /**
+         * Encrypt the message using the public key
+         * @param {string} message - The message to encrypt
+         * @param {string} publicKey - The public key
+         * @memberof Crypto
+         * @example
+         * ```typescript
+         * crypto.encrypt('Hello World', 7)
+         * ```
+         * */
+        this.encrypt = (message, publicKey) => {
+            const b = [];
+            for (let i = 0; i < message.length; i++) {
+                const a = message.charCodeAt(i);
+                b.push(this._modularExponentiation(a, publicKey));
+            }
+            return b;
+        };
+        /**
+         * Decrypt the message using the private key
+         * @param {string} encryptedMessage - The ciphertext to decrypt
+         * @param {string} privateKey - The private key
+         * @memberof Crypto
+         * @example
+         * ```typescript
+         * crypto.decrypt([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100], 23)
+         * ```
+         * */
+        this.decrypt = (encryptedMessage, privateKey) => {
+            const decryptedAsciiMessage = [];
+            for (let i = 0; i < encryptedMessage.length; i++) {
+                const a = encryptedMessage[i];
+                decryptedAsciiMessage.push(this._modularExponentiation(a, privateKey));
+            }
+            let finalString = '';
+            for (let i = 0; i < decryptedAsciiMessage.length; i++) {
+                finalString += String.fromCharCode(decryptedAsciiMessage[i]);
+            }
+            return finalString;
+        };
+    }
+    /**
+     * Set the P prime number for the RSA algorithm
+     * @param {string} primeP - The prime number P
+     * @memberof Crypto
+     * @example
+     * ```typescript
+     * crypto.setPrimeP(17)
+     * ```
+     * */
+    setPrimeP(primeP) {
+        let isPrime = true;
+        for (let i = 2; i < primeP; i++) {
+            if (primeP % i === 0) {
+                isPrime = false;
+                break;
+            }
+        }
+        if (!isPrime) {
+            throw new Error('The number is not prime');
+        }
+        this._primeNumberP = primeP;
+    }
+    /**
+     * Set the Q prime number for the RSA algorithm
+     * @param {string} primeQ - The prime number Q
+     * @memberof Crypto
+     * @example
+     * ```typescript
+     * crypto.setPrimeQ(19)
+     * ```
+     * */
+    setPrimeQ(primeQ) {
+        let isPrime = true;
+        for (let i = 2; i < primeQ; i++) {
+            if (primeQ % i === 0) {
+                isPrime = false;
+                break;
+            }
+        }
+        if (!isPrime) {
+            throw new Error('The number is not prime');
+        }
+        this._primeNumberQ = primeQ;
+    }
+}
+const crypto = new Crypto();
+exports.default = crypto;

package/dist/lib/index.d.ts

@@ -0,0 +1 @@
+export { default as Crypto } from './cypto';

package/dist/lib/index.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Crypto = void 0;
+var cypto_1 = require("./cypto");
+Object.defineProperty(exports, "Crypto", { enumerable: true, get: function () { return __importDefault(cypto_1).default; } });

package/dist/types/Crypto.d.ts

@@ -0,0 +1,8 @@
+export declare namespace Crypto {
+    class Crypto {
+        setPrimeP(primeP: number): void;
+        setPrimeQ(primeQ: number): void;
+        encrypt: (message: string, publicKey: number) => number[];
+        decrypt: (encryptedMessage: number[], privateKey: number) => string;
+    }
+}

package/dist/types/Crypto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,40 @@
+{
+	"name": "@mhmdhammoud/meritt-utils",
+	"version": "1.0.1",
+	"description": "",
+	"main": "./dist/index.js",
+  "private":false,
+	"repository": {
+		"type": "git",
+		"url": "git@github.com:Mhmdhammoud/meritt-utils.git"
+	},
+  "publishConfig": {
+    "access": "public"
+  },  
+	"scripts": {
+		"dev-ts": "ts-node-dev --respawn --transpile-only src/index.ts",
+		"dev": "nodemon ./dist/index.js",
+		"watch": "tsc --watch",
+		"build": "tsc",
+		"types": "tsc --noemit",
+		"prepare": "husky install",
+		"lint": "eslint src --fix",
+		"prepublish": "yarn build",
+		"postinstall": "yarn prepare"
+	},
+	"dependencies": {
+		"dotenv": "^10.0.0"
+	},
+	"devDependencies": {
+		"ts-node-dev": "^1.1.8",
+		"typescript": "^4.6.3",
+		"@types/jest": "^27.5.1",
+		"@typescript-eslint/eslint-plugin": "^5.17.0",
+		"@typescript-eslint/parser": "^5.17.0",
+		"eslint": "^8.12.0",
+		"eslint-plugin-tsdoc": "^0.2.14",
+		"husky": "^8.0.0"
+	},
+	"author": "Mhmdhammoud",
+	"license": "ISC"
+}

package/src/index.ts

@@ -0,0 +1 @@
+export {Crypto} from './lib'

package/src/lib/cypto.ts

@@ -0,0 +1,130 @@
+/**
+ * The Crypto class
+ * @class Crypto
+ * @example
+ * ```typescript
+ * import crypto from './lib/crypto'
+ * ```
+ * */
+class Crypto {
+	// Default variables
+	private _primeNumberP = 17
+	private _primeNumberQ = 19
+	private _moduloDenominator = this._primeNumberP * this._primeNumberQ
+
+	/**
+	 * Set the P prime number for the RSA algorithm
+	 * @param {string} primeP - The prime number P
+	 * @memberof Crypto
+	 * @example
+	 * ```typescript
+	 * crypto.setPrimeP(17)
+	 * ```
+	 * */
+	public setPrimeP(primeP: number) {
+		let isPrime = true
+		for (let i = 2; i < primeP; i++) {
+			if (primeP % i === 0) {
+				isPrime = false
+				break
+			}
+		}
+		if (!isPrime) {
+			throw new Error('The number is not prime')
+		}
+		this._primeNumberP = primeP
+	}
+
+	/**
+	 * Set the Q prime number for the RSA algorithm
+	 * @param {string} primeQ - The prime number Q
+	 * @memberof Crypto
+	 * @example
+	 * ```typescript
+	 * crypto.setPrimeQ(19)
+	 * ```
+	 * */
+	public setPrimeQ(primeQ: number) {
+		let isPrime = true
+		for (let i = 2; i < primeQ; i++) {
+			if (primeQ % i === 0) {
+				isPrime = false
+				break
+			}
+		}
+		if (!isPrime) {
+			throw new Error('The number is not prime')
+		}
+		this._primeNumberQ = primeQ
+	}
+
+	/**
+	 *
+	 * @param {string} base - The base number
+	 * @param {string} exponent - The exponent number
+	 * @memberof Crypto
+	 * @example
+	 * ```typescript
+	 * this.modularExponentiation(2, 3)
+	 * ```
+	 * */
+	private _modularExponentiation = (base: number, exponent: number) => {
+		if (this._moduloDenominator === 1) {
+			return 0
+		}
+		let result = 1
+		base = base % this._moduloDenominator
+		while (exponent > 0) {
+			if (exponent % 2 === 1) {
+				result = (result * base) % this._moduloDenominator
+			}
+			exponent = Math.floor(exponent / 2)
+			base = (base * base) % this._moduloDenominator
+		}
+		return result
+	}
+
+	/**
+	 * Encrypt the message using the public key
+	 * @param {string} message - The message to encrypt
+	 * @param {string} publicKey - The public key
+	 * @memberof Crypto
+	 * @example
+	 * ```typescript
+	 * crypto.encrypt('Hello World', 7)
+	 * ```
+	 * */
+	public encrypt = (message: string, publicKey: number): number[] => {
+		const b: number[] = []
+		for (let i = 0; i < message.length; i++) {
+			const a = message.charCodeAt(i)
+			b.push(this._modularExponentiation(a, publicKey))
+		}
+		return b
+	}
+
+	/**
+	 * Decrypt the message using the private key
+	 * @param {string} encryptedMessage - The ciphertext to decrypt
+	 * @param {string} privateKey - The private key
+	 * @memberof Crypto
+	 * @example
+	 * ```typescript
+	 * crypto.decrypt([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100], 23)
+	 * ```
+	 * */
+	public decrypt = (encryptedMessage: number[], privateKey: number): string => {
+		const decryptedAsciiMessage: number[] = []
+		for (let i = 0; i < encryptedMessage.length; i++) {
+			const a = encryptedMessage[i]
+			decryptedAsciiMessage.push(this._modularExponentiation(a, privateKey))
+		}
+		let finalString = ''
+		for (let i = 0; i < decryptedAsciiMessage.length; i++) {
+			finalString += String.fromCharCode(decryptedAsciiMessage[i])
+		}
+		return finalString
+	}
+}
+const crypto = new Crypto()
+export default crypto

package/src/lib/index.ts

@@ -0,0 +1 @@
+export {default as Crypto} from './cypto'

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+	"compilerOptions": {
+		"target": "es2018",
+		"module": "commonjs",
+		"lib": ["es2018", "esnext.asynciterable", "DOM"],
+		"resolveJsonModule": false,
+		"declaration": true,
+		"outDir": "./dist",
+		"rootDir": "./src",
+		"strict": true,
+		"strictPropertyInitialization": false,
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"forceConsistentCasingInFileNames": true
+	}
+}