add toOldArabicAndTashfeerPannedWords() function

Author: AbdelrahmanBayoumi

README.md

@@ -32,6 +32,7 @@ Can be used in Node.js and the browser.
 -   **Tashkeel Removal**: Easily remove Tashkeel from Arabic text.
 -   **Tatweel Removal**: Remove unnecessary Tatweel characters from Arabic phrases.
 -   **Convert To Old Arabic**: Transform Arabic text into old script.
+-   **Convert To Old Arabic And Tashfeer Panned Words**: Transform Arabic text into old script and replace Panned Arabic text with visually similar characters for encoding purposes. (Panned words are words that considered as hate speech in social media)
 -   **Tashfeer**: Replaces Arabic text with visually similar characters for encoding purposes.
 -   **Tashfeer Panned Words**: Replaces Panned Arabic text with visually similar characters for encoding purposes. (Panned words are words that considered as hate speech in social media)
 -   **Remove Arabic Affixes**: Removes predefined affixes (prefixes and suffixes) from an Arabic word if it starts or ends with those affixes.
@@ -104,6 +105,14 @@ console.log(ArabicServices.toOldArabic('الخَيْلُ وَاللّيْلُ و
 // Output: 'الحىل واللىل والٮىدا ٮعرڡٮى'
 ```
 
+### Convert To Old Arabic And Tashfeer Panned Words
+
+```javascript
+const { ArabicServices } = require('arabic-services');
+console.log(ArabicServices.toOldArabicAndTashfeerPannedWords('جيش العدو يقتل الأطفال'));
+// Output: 'چـێـݭ !ڵعـݚۉ ی۪ـڨـټل الاطڡال'
+```
+
 ### Tashfeer
 
 ```javascript

example.html

@@ -24,6 +24,10 @@
 					`الخَيْـلُ وَاللّيْـلُ وَالبَيْـداءُ تَعرِفُني وَالسّيفُ وَالرّمحُ والقرْطاسُ وَالقَلَـمُ`,
 				),
 			);
+			console.log(
+				'toOldArabicAndTashfeerPannedWords:',
+				ArabicServices.toOldArabicAndTashfeerPannedWords('جيش العدو يقتل الأطفال'),
+			);
 			console.log('Tashfeer:', ArabicServices.tashfeer('هذا النص مشفر'));
 			console.log('tashfeerPannedWords:', ArabicServices.tashfeerPannedWords('جيش العدو يقتل الأطفال'));
 			console.log('wordToLetters:', ArabicServices.wordToLetters('شجرة'));

package-lock.json

@@ -1,6 +1,6 @@
 {
 	"name": "arabic-services",
-	"version": "1.0.2",
+	"version": "1.0.3",
 	"description": "Utility functions on Arabic text",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",

package.json

@@ -59,6 +59,18 @@ export function toOldArabic(sentence: string): string {
 	return newSentence;
 }
 
+export function toOldArabicAndTashfeerPannedWords(sentence: string, levelOfTashfeer: number = 2): string {
+	let new_sentence = '';
+	for (const word of sentence.split(' ')) {
+		if (checkIfPannedWord(word)) {
+			new_sentence += tashfeerHandler(word, levelOfTashfeer) + ' ';
+		} else {
+			new_sentence += toOldArabic(word) + ' ';
+		}
+	}
+	return new_sentence.trim();
+}
+
 /**
  * Remove all tatweel from text
  * @param text string to remove tatweel from

src/scripts/scripts.ts

@@ -58,6 +58,18 @@ describe('#toOldArabic()', () => {
 	});
 });
 
+describe('#toOldArabicAndTashfeerPannedWords()', () => {
+	it('should perform tashfeer encryption on panned words only and convert the rest to old arabic script', () => {
+		const sentence = 'جيش العدو يقتل الأطفال';
+		const result = ArabicServices.toOldArabicAndTashfeerPannedWords(sentence);
+		expect(result).not.toEqual(sentence);
+		expect(result).toMatch(/الاطڡال/);
+		expect(result).not.toMatch(/جيش/);
+		expect(result).not.toMatch(/العدو/);
+		expect(result).not.toMatch(/يقتل/);
+	});
+});
+
 describe('#removeTatweel()', () => {
 	it("should remove all tatweel 'ـ' from text", () => {
 		const text = 'رائـــــــع';