@mhmdhammoud/meritt-utils 1.0.4 → 1.0.6

package/ReleaseNotes.md

@@ -1,5 +1,22 @@
 # Changes
 
+## Version 1.0.5
+
+### Added
+
+- Added toUpperTitle method that accepts a string and removes all non alphanumeric characters and capitalizes each letter of every first word
+
+```typescript
+import {Formatter} from '@mhmdhammoud/meritt-utils'
+
+// Usage Example
+const sentence:string = "hello__world$$99"
+console.log(Formatter.toUpperTitle(sentence))
+
+console : Hello World 99
+
+```
+
 ## Version 1.0.4
 
 ### Added
@@ -41,9 +58,7 @@ const slug = Formatter.slugify('My Product Name') // my-product-name
 ### Fixes and Improvements
 
 - Fixed bug in Crypto class where encrypting a string with a key that is not a number would throw an error
-
 - Improved Crypto class to allow encrypting and decrypting numbers and objects
-
 - Documented Crypto class
 
 ## Version 1.0.2

package/dist/lib/cypto.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 /*
-     Author : Omar Sawwas
+     Author : Omar Sawwas https://github.com/omarsawwas
      Date : 2023-06-17
      Description : RSA algorithm
      Version : 1.0

package/dist/lib/formatter.d.ts

@@ -28,6 +28,18 @@ declare class Formatter {
      * ```
      * */
     obfuscate: (email: string) => string;
+    /**
+     * Capitalizes the first letter of each word in a sentence and removes non-alphanumeric characters.
+     * @param sentence - The input sentence to be processed.
+     * @returns A new sentence with the first letter of each word capitalized and non-alphanumeric characters removed.
+     * @example
+     * ```typescript
+     * const sentence = 'this is34354345a---sentence'
+     * const newSentence = ToUpperTitle(sentence)
+     * console.log(newSentence) // 'This Is A Sentence'
+     * ```
+     */
+    toUpperTitle: (sentence: string) => string;
     /**
      * @remarks Generates a slug from a given string
      * @param title - string to be converted to slug

package/dist/lib/formatter.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 /*
-     Author : Mhmd Hammoud
+     Author : Mhmd Hammoud https://github.com/mhmdhammoud
      Date : 2023-06-17
      Description : String manipulation
      Version : 1.0
@@ -23,7 +23,8 @@ class Formatter {
             if (typeof _ !== 'string')
                 throw new Error('Provide a valid string');
             if (withSpacing) {
-                return _.split(' ')
+                return _.toLowerCase()
+                    .split(' ')
                     .map((val) => val.charAt(0).toUpperCase() + val.slice(1))
                     .join(' ')
                     .replace(/ /g, '-')
@@ -31,7 +32,8 @@ class Formatter {
                     .replace(/\./g, '');
             }
             else {
-                return _.split(' ')
+                return _.toLowerCase()
+                    .split(' ')
                     .map((val) => val.charAt(0).toUpperCase() + val.slice(1))
                     .join(' ')
                     .replace(/\//g, '-')
@@ -78,6 +80,32 @@ class Formatter {
                 email.slice(2, separatorIndex).replace(/./g, '*') +
                 email.slice(separatorIndex));
         };
+        /**
+         * Capitalizes the first letter of each word in a sentence and removes non-alphanumeric characters.
+         * @param sentence - The input sentence to be processed.
+         * @returns A new sentence with the first letter of each word capitalized and non-alphanumeric characters removed.
+         * @example
+         * ```typescript
+         * const sentence = 'this is34354345a---sentence'
+         * const newSentence = ToUpperTitle(sentence)
+         * console.log(newSentence) // 'This Is A Sentence'
+         * ```
+         */
+        this.toUpperTitle = (sentence) => {
+            if (typeof sentence !== 'string')
+                throw new Error('Provide a valid string');
+            if (!sentence)
+                throw new Error('Provide a valid string');
+            const sanitizedSentence = sentence.replace(/[^a-zA-Z0-9]+/g, ' ');
+            const words = sanitizedSentence.split(' ');
+            const capitalizedWords = [];
+            for (let i = 0; i < words.length; i++) {
+                const word = words[i];
+                const capitalizedWord = word.charAt(0).toUpperCase() + word.slice(1);
+                capitalizedWords.push(capitalizedWord);
+            }
+            return capitalizedWords.join(' ');
+        };
         /**
          * @remarks Generates a slug from a given string
          * @param title - string to be converted to slug

package/dist/lib/index.d.ts

@@ -1,2 +1,3 @@
 export { default as Crypto } from './cypto';
 export { default as Formatter } from './formatter';
+export { default as Pdf } from './formatter';

package/dist/lib/index.js

@@ -3,8 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Formatter = exports.Crypto = void 0;
+exports.Pdf = exports.Formatter = exports.Crypto = void 0;
 var cypto_1 = require("./cypto");
 Object.defineProperty(exports, "Crypto", { enumerable: true, get: function () { return __importDefault(cypto_1).default; } });
 var formatter_1 = require("./formatter");
 Object.defineProperty(exports, "Formatter", { enumerable: true, get: function () { return __importDefault(formatter_1).default; } });
+var formatter_2 = require("./formatter");
+Object.defineProperty(exports, "Pdf", { enumerable: true, get: function () { return __importDefault(formatter_2).default; } });

package/dist/lib/pdf.d.ts

@@ -0,0 +1,15 @@
+declare class Pdf {
+    /**
+     * @remarks Convert image links into base64 format
+     * @param url - The image url
+     * @returns string
+     * @example
+     * ```typescript
+     * pdf.getBase64Images('https://fastly.picsum.photos/id/15/200/300.jpg?hmac=lozQletmrLG9PGBV1hTM1PnmvHxKEU0lAZWu8F2oL30')
+     * // => 'Hello-World'
+     * ```
+     * */
+    getBase64Images: (url: string) => string;
+}
+declare const pdf: Pdf;
+export default pdf;

package/dist/lib/pdf.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+     Author : Mustafa Halabi https://github.com/mustafahalabi
+     Date : 2023-06-24
+     Description : Image to PDF converter
+     Version : 1.0
+*/
+class Pdf {
+    constructor() {
+        /**
+         * @remarks Convert image links into base64 format
+         * @param url - The image url
+         * @returns string
+         * @example
+         * ```typescript
+         * pdf.getBase64Images('https://fastly.picsum.photos/id/15/200/300.jpg?hmac=lozQletmrLG9PGBV1hTM1PnmvHxKEU0lAZWu8F2oL30')
+         * // => 'Hello-World'
+         * ```
+         * */
+        this.getBase64Images = (url) => {
+            return '';
+        };
+    }
+}
+const pdf = new Pdf();
+exports.default = pdf;

package/dist/utilities/axios.d.ts

@@ -0,0 +1,2 @@
+declare const axiosInstance: import("axios").AxiosInstance;
+export default axiosInstance;

package/dist/utilities/axios.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 });
+const axios_1 = __importDefault(require("axios"));
+const axiosInstance = axios_1.default.create({});
+exports.default = axiosInstance;

package/dist/utilities/index.d.ts

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

package/dist/utilities/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.AxiosInstance = void 0;
+var axios_1 = require("./axios");
+Object.defineProperty(exports, "AxiosInstance", { enumerable: true, get: function () { return __importDefault(axios_1).default; } });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@mhmdhammoud/meritt-utils",
-	"version": "1.0.4",
+	"version": "1.0.6",
 	"description": "",
 	"main": "./dist/index.js",
 	"private": false,
@@ -21,19 +21,19 @@
 		"lint": "eslint src --fix",
 		"prepublish": "npm run build"
 	},
-	"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"
+		"husky": "^8.0.0",
+		"ts-node-dev": "^1.1.8",
+		"typescript": "^4.6.3"
 	},
 	"author": "Mhmdhammoud",
-	"license": "ISC"
+	"license": "ISC",
+	"dependencies": {
+		"axios": "^1.4.0"
+	}
 }

package/src/lib/cypto.ts

@@ -1,5 +1,5 @@
 /*
-	 Author : Omar Sawwas
+	 Author : Omar Sawwas https://github.com/omarsawwas
 	 Date : 2023-06-17
 	 Description : RSA algorithm
 	 Version : 1.0

package/src/lib/formatter.ts

@@ -1,5 +1,5 @@
 /*
-	 Author : Mhmd Hammoud
+	 Author : Mhmd Hammoud https://github.com/mhmdhammoud
 	 Date : 2023-06-17
 	 Description : String manipulation
 	 Version : 1.0
@@ -16,17 +16,19 @@ class Formatter {
 	 * // => 'Hello-World'
 	 * ```
 	 * */
-	toUpperFirst = (_: string | number, withSpacing = true) => {
+	toUpperFirst = (_: string | number, withSpacing = true): string => {
 		if (typeof _ !== 'string') throw new Error('Provide a valid string')
 		if (withSpacing) {
-			return _.split(' ')
+			return _.toLowerCase()
+				.split(' ')
 				.map((val: string) => val.charAt(0).toUpperCase() + val.slice(1))
 				.join(' ')
 				.replace(/ /g, '-')
 				.replace(/\//g, '-')
 				.replace(/\./g, '')
 		} else {
-			return _.split(' ')
+			return _.toLowerCase()
+				.split(' ')
 				.map((val: string) => val.charAt(0).toUpperCase() + val.slice(1))
 				.join(' ')
 				.replace(/\//g, '-')
@@ -79,6 +81,34 @@ class Formatter {
 		)
 	}
 
+	/**
+	 * Capitalizes the first letter of each word in a sentence and removes non-alphanumeric characters.
+	 * @param sentence - The input sentence to be processed.
+	 * @returns A new sentence with the first letter of each word capitalized and non-alphanumeric characters removed.
+	 * @example
+	 * ```typescript
+	 * const sentence = 'this is34354345a---sentence'
+	 * const newSentence = ToUpperTitle(sentence)
+	 * console.log(newSentence) // 'This Is A Sentence'
+	 * ```
+	 */
+	toUpperTitle = (sentence: string): string => {
+		if (typeof sentence !== 'string') throw new Error('Provide a valid string')
+		if (!sentence) throw new Error('Provide a valid string')
+
+		const sanitizedSentence = sentence.replace(/[^a-zA-Z0-9]+/g, ' ')
+		const words = sanitizedSentence.split(' ')
+		const capitalizedWords = []
+
+		for (let i = 0; i < words.length; i++) {
+			const word = words[i]
+			const capitalizedWord = word.charAt(0).toUpperCase() + word.slice(1)
+			capitalizedWords.push(capitalizedWord)
+		}
+
+		return capitalizedWords.join(' ')
+	}
+
 	/**
 	 * @remarks Generates a slug from a given string
 	 * @param title - string to be converted to slug

package/src/lib/index.ts

@@ -1,2 +1,3 @@
 export {default as Crypto} from './cypto'
 export {default as Formatter} from './formatter'
+export {default as Pdf} from './formatter'

package/src/lib/pdf.ts

@@ -0,0 +1,25 @@
+import {AxiosInstance} from '../utilities'
+/*
+	 Author : Mustafa Halabi https://github.com/mustafahalabi
+	 Date : 2023-06-24
+	 Description : Image to PDF converter
+	 Version : 1.0
+*/
+class Pdf {
+	/**
+	 * @remarks Convert image links into base64 format
+	 * @param url - The image url
+	 * @returns string
+	 * @example
+	 * ```typescript
+	 * pdf.getBase64Images('https://fastly.picsum.photos/id/15/200/300.jpg?hmac=lozQletmrLG9PGBV1hTM1PnmvHxKEU0lAZWu8F2oL30')
+	 * // => 'Hello-World'
+	 * ```
+	 * */
+	getBase64Images = (url: string): string => {
+		return ''
+	}
+}
+
+const pdf = new Pdf()
+export default pdf

package/src/utilities/axios.ts

@@ -0,0 +1,4 @@
+import axios from 'axios'
+
+const axiosInstance = axios.create({})
+export default axiosInstance

package/src/utilities/index.ts

@@ -0,0 +1 @@
+export {default as AxiosInstance} from './axios'