bitaboom 1.3.0 → 1.4.0

package/dist/index.d.ts

@@ -5,14 +5,21 @@
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with extreme underscores removed.
  */
-export const cleanExtremeArabicUnderscores: (text: string) => string;
+declare const cleanExtremeArabicUnderscores: (text: string) => string;
 /**
  * Converts Urdu symbols to their Arabic equivalents.
  * Example: 'ھذا' will be changed to 'هذا', 'ی' to 'ي'.
  * @param {string} text - The input text containing Urdu symbols.
  * @returns {string} - The modified text with Urdu symbols converted to Arabic symbols.
  */
-export const convertUrduSymbolsToArabic: (text: string) => string;
+declare const convertUrduSymbolsToArabic: (text: string) => string;
+/**
+ * Calculates the proportion of Arabic characters in text relative to total non-whitespace, non-digit characters.
+ * Digits (ASCII and Arabic-Indic variants) are excluded from both numerator and denominator.
+ * @param text - The input text to analyze
+ * @returns A decimal between 0-1 representing the Arabic character ratio (0 = no Arabic, 1 = all Arabic)
+ */
+declare const getArabicScore: (text: string) => number;
 /**
  * Fixes the trailing "و" (wow) in phrases such as "عليكم و رحمة" to "عليكم ورحمة".
  * This function attempts to correct phrases where "و" appears unnecessarily, particularly in greetings.
@@ -20,105 +27,106 @@ export const convertUrduSymbolsToArabic: (text: string) => string;
  * @param {string} text - The input text containing the "و" character.
  * @returns {string} - The modified text with unnecessary trailing "و" characters corrected.
  */
-export const fixTrailingWow: (text: string) => string;
+declare const fixTrailingWow: (text: string) => string;
 /**
  * Inserts a space between Arabic text and numbers.
  * Example: 'الآية37' will be changed to 'الآية 37'.
  * @param {string} text - The input text containing Arabic text followed by numbers.
  * @returns {string} - The modified text with spaces inserted between Arabic text and numbers.
  */
-export const addSpaceBetweenArabicTextAndNumbers: (text: string) => string;
+declare const addSpaceBetweenArabicTextAndNumbers: (text: string) => string;
 /**
  * Removes English letters and symbols from the text, including ampersands, slashes, and other symbols.
  * Example: 'أحب & لنفسي' will be changed to 'أحب   لنفسي'.
  * @param {string} text - The input text containing English letters and symbols.
  * @returns {string} - The modified text with English letters and symbols removed.
  */
-export const stripEnglishCharactersAndSymbols: (text: string) => string;
+declare const stripEnglishCharactersAndSymbols: (text: string) => string;
 /**
  * Removes single-digit numbers surrounded by Arabic text. Also removes dashes (-) not followed by a number.
  * For example, removes '3' from 'وهب 3 وقال' but does not remove '121' from 'لوحه 121 الجرح'.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with non-index numbers and dashes removed.
  */
-export const removeNonIndexSignatures: (text: string) => string;
+declare const removeNonIndexSignatures: (text: string) => string;
 /**
  * Removes characters enclosed in square brackets [] or parentheses () if they are Arabic letters or Arabic-Indic numerals.
  * Example: '[س]' or '(س)' will be removed.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with singular codes removed.
  */
-export const removeSingularCodes: (text: string) => string;
+declare const removeSingularCodes: (text: string) => string;
 /**
  * Removes solitary Arabic letters unless they are the 'ha' letter, which is used in Hijri years.
  * Example: "ب ا الكلمات ت" will be changed to "ا الكلمات".
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with solitary Arabic letters removed.
  */
-export const removeSolitaryArabicLetters: (text: string) => string;
+declare const removeSolitaryArabicLetters: (text: string) => string;
 /**
  * Removes tatweel characters while preserving dates references and numbered list items.
  * Example: "1435/3/29 هـ" remains as "1435/3/29 هـ" but "أبـــتِـــكَةُ" becomes "أبتِكَةُ"
  * @param text The text to format.
  * @returns The modified text with the tatweel characters removed.
  */
-export const removeTatwil: (text: string) => string;
+declare const removeTatwil: (text: string) => string;
 /**
  * Replaces the 'tah marbutah' (ة) character with 'ha' (ه).
  * Example: 'مدرسة' will be changed to 'مدرسه'.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with 'ta marbutah' replaced by 'ha'.
  */
-export const replaceTaMarbutahWithHa: (text: string) => string;
+declare const replaceTaMarbutahWithHa: (text: string) => string;
 /**
  * Removes Arabic diacritics (tashkeel) and the tatweel (elongation) character.
  * Example: 'مُحَمَّدٌ' will be changed to 'محمد'.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with diacritics and tatweel removed.
  */
-export const stripDiacritics: (text: string) => string;
+declare const stripDiacritics: (text: string) => string;
 /**
  * Removes zero-width joiners (ZWJ) and other zero-width characters from the input text.
  * Zero-width characters include U+200B to U+200F, U+202A to U+202E, U+2060 to U+2064, and U+FEFF.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with zero-width characters removed.
  */
-export const stripZeroWidthCharacters: (text: string) => string;
+declare const stripZeroWidthCharacters: (text: string) => string;
 /**
  * Replaces the 'alif maqsurah' (ى) character with the regular 'ya' (ي).
  * Example: 'رؤيى' will be changed to 'رؤيي'.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with 'alif maqsurah' replaced by 'ya'.
  */
-export const replaceAlifMaqsurah: (text: string) => string;
+declare const replaceAlifMaqsurah: (text: string) => string;
 /**
  * Replaces English punctuation (question mark and semicolon) with their Arabic equivalents.
  * Example: '?' will be replaced with '؟', and ';' with '؛'.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with English punctuation replaced by Arabic punctuation.
  */
-export const replaceEnglishPunctuationWithArabic: (text: string) => string;
+declare const replaceEnglishPunctuationWithArabic: (text: string) => string;
 /**
  * Simplifies all forms of 'alif' (أ, إ, and آ) to the basic 'ا'.
  * Example: 'أنا إلى الآفاق' will be changed to 'انا الى الافاق'.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with simplified 'alif' characters.
  */
-export const normalizeAlifVariants: (text: string) => string;
+declare const normalizeAlifVariants: (text: string) => string;
+
 /**
  * Adds line breaks after punctuation marks such as periods, exclamation points, and question marks.
  * Example: 'Text.' becomes 'Text.\n'.
  * @param {string} text - The input text containing punctuation.
  * @returns {string} - The modified text with line breaks added after punctuation.
  */
-export const insertLineBreaksAfterPunctuation: (text: string) => string;
+declare const insertLineBreaksAfterPunctuation: (text: string) => string;
 /**
  * Adds spaces before and after punctuation, except for certain cases like quoted text or ayah references.
  * Example: 'Text,word' becomes 'Text, word'.
  * @param {string} text - The input text containing punctuation.
  * @returns {string} - The modified text with spaces added before and after punctuation.
  */
-export const addSpaceBeforeAndAfterPunctuation: (text: string) => string;
+declare const addSpaceBeforeAndAfterPunctuation: (text: string) => string;
 /**
  * Turns regular double quotes surrounding a body of text into smart quotes.
  * Also fixes incorrect starting quotes by ensuring the string starts with an opening quote if needed.
@@ -126,111 +134,139 @@ export const addSpaceBeforeAndAfterPunctuation: (text: string) => string;
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with smart quotes applied.
  */
-export const applySmartQuotes: (text: string) => string;
+declare const applySmartQuotes: (text: string) => string;
 /**
  * Replaces literal new line characters (\n) and carriage returns (\r) with actual line breaks.
  * Example: 'A\\nB' becomes 'A\nB'.
  * @param {string} text - The input text containing literal new lines.
  * @returns {string} - The modified text with actual line breaks.
  */
-export const cleanLiteralNewLines: (text: string) => string;
+declare const cleanLiteralNewLines: (text: string) => string;
 /**
  * Removes trailing spaces from each line in a multiline string.
  * Example: " This is a line   \nAnother line   " becomes "This is a line\nAnother line".
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with trailing spaces removed.
  */
-export const cleanMultilines: (text: string) => string;
+declare const cleanMultilines: (text: string) => string;
 /**
  * Detects if a word is by itself in a line.
  * @param text The text to check.
  * @returns true if there exists a word in any of the lines in the text that is by itself.
  */
-export const hasWordInSingleLine: (text: string) => boolean;
+declare const hasWordInSingleLine: (text: string) => boolean;
 /**
  * Checks if the input string consists of only punctuation characters.
  * @param {string} text - The input text to check.
  * @returns {boolean} - Returns true if the string contains only punctuation, false otherwise.
  */
-export const isOnlyPunctuation: (text: string) => boolean;
-export const cleanJunkFromText: (text: string) => string;
+declare const isOnlyPunctuation: (text: string) => boolean;
+declare const cleanJunkFromText: (text: string) => string;
 /**
  * Cleans unnecessary spaces before punctuation marks such as periods, commas, and question marks.
  * Example: 'This is a sentence , with extra space .' becomes 'This is a sentence, with extra space.'.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with cleaned spaces before punctuation.
  */
-export const cleanSpacesBeforePeriod: (text: string) => string;
+declare const cleanSpacesBeforePeriod: (text: string) => string;
 /**
  * Condenses multiple asterisks (*) into a single one.
  * Example: '***' becomes '*'.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with condensed asterisks.
  */
-export const condenseAsterisks: (text: string) => string;
+declare const condenseAsterisks: (text: string) => string;
 /**
  * Replaces occurrences of colons surrounded by periods (e.g., '.:.' or ':') with a single colon.
  * Example: 'This.:. is a test' becomes 'This: is a test'.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with condensed colons.
  */
-export const condenseColons: (text: string) => string;
+declare const condenseColons: (text: string) => string;
 /**
  * Condenses two or more dashes (--) into a single dash (-).
  * Example: 'This is some ---- text' becomes 'This is some - text'.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with condensed dashes.
  */
-export const condenseDashes: (text: string) => string;
+declare const condenseDashes: (text: string) => string;
 /**
  * Replaces sequences of two or more periods (e.g., '...') with an ellipsis character (…).
  * Example: 'This is a test...' becomes 'This is a test…'.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with ellipses condensed.
  */
-export const condenseEllipsis: (text: string) => string;
+declare const condenseEllipsis: (text: string) => string;
 /**
  * Reduces multiple consecutive line breaks (3 or more) to exactly 2 line breaks.
  * Example: 'This is line 1\n\n\n\nThis is line 2' becomes 'This is line 1\n\nThis is line 2'.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with condensed line breaks.
  */
-export const reduceMultilineBreaksToDouble: (text: string) => string;
+declare const reduceMultilineBreaksToDouble: (text: string) => string;
 /**
  * Reduces multiple consecutive line breaks (2 or more) to exactly 1 line break.
  * Example: 'This is line 1\n\nThis is line 2' becomes 'This is line 1\nThis is line 2'.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with condensed line breaks.
  */
-export const reduceMultilineBreaksToSingle: (text: string) => string;
+declare const reduceMultilineBreaksToSingle: (text: string) => string;
 /**
  * Condenses multiple periods separated by spaces (e.g., '. . .') into a single period.
  * Example: 'This . . . is a test' becomes 'This. is a test'.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with condensed periods.
  */
-export const condensePeriods: (text: string) => string;
+declare const condensePeriods: (text: string) => string;
 /**
  * Condenses multiple underscores (__) or Arabic Tatweel characters (ـــــ) into a single underscore or Tatweel.
  * Example: 'This is ـــ some text __' becomes 'This is ـ some text _'.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with condensed underscores.
  */
-export const condenseUnderscores: (text: string) => string;
+declare const condenseUnderscores: (text: string) => string;
 /**
  * Replaces double parentheses or brackets with single ones.
  * Example: '((text))' becomes '(text)'.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with condensed brackets.
  */
-export const doubleToSingleBrackets: (text: string) => string;
+declare const doubleToSingleBrackets: (text: string) => string;
 /**
- * Replaces double parentheses single a single arrow variation.
- * Example: '((text))' becomes '«text»'.
- * @param {string} text - The input text to apply the rule to.
- * @returns {string} - The modified text with condensed brackets.
+ * Ensures at most 1 space exists before any word before brackets.
+ * Adds a space if there isn't one, or reduces multiple spaces to one.
+ * @param {string} text - The input text to modify
+ * @returns {string} - The modified text with proper spacing before brackets
  */
-export const replaceDoubleBracketsWithArrows: (text: string) => string;
+declare const ensureSpaceBeforeBrackets: (text: string) => string;
+/**
+ * Ensures at most 1 space exists before any word before Arabic quotation marks.
+ * Adds a space if there isn't one, or reduces multiple spaces to one.
+ * @param {string} text - The input text to modify
+ * @returns {string} - The modified text with proper spacing before Arabic quotes
+ */
+declare const ensureSpaceBeforeQuotes: (text: string) => string;
+/**
+ * Fixes common bracket and quotation mark typos in text
+ * Corrects malformed patterns like "(«", "»)", and misplaced digits in brackets
+ * @param text - Input text that may contain bracket typos
+ * @returns Text with corrected bracket and quotation mark combinations
+ */
+declare const fixBracketTypos: (text: string) => string;
+/**
+ * Fixes mismatched curly braces by converting incorrect bracket/brace combinations
+ * to proper curly braces { }
+ * @param text - Input text that may contain mismatched curly braces
+ * @returns Text with corrected curly brace pairs
+ */
+declare const fixCurlyBraces: (text: string) => string;
+/**
+ * Fixes mismatched quotation marks in Arabic text by converting various
+ * incorrect bracket/quote combinations to proper Arabic quotation marks (« »)
+ * @param text - Input text that may contain mismatched quotation marks
+ * @returns Text with corrected Arabic quotation marks
+ */
+declare const fixMismatchedQuotationMarks: (text: string) => string;
 /**
  * Formats a multiline string by joining sentences and maintaining footnotes on their own lines.
  * Footnotes are identified by Arabic and English numerals.
@@ -238,28 +274,27 @@ export const replaceDoubleBracketsWithArrows: (text: string) => string;
  * @param {string} input - The input text containing sentences and footnotes.
  * @returns {string} - The formatted text.
  */
-export const formatStringBySentence: (input: string) => string;
+declare const formatStringBySentence: (input: string) => string;
+/**
+ * Detects if text is entirely in uppercase letters
+ * @param text - The text to check
+ * @returns true if all alphabetic characters are uppercase, false otherwise
+ */
+declare const isAllUppercase: (text: string) => boolean;
 /**
  * Removes unnecessary spaces around slashes in references.
  * Example: '127 / 11' becomes '127/11'.
  * @param {string} text - The input text containing references.
  * @returns {string} - The modified text with spaces removed around slashes.
  */
-export const normalizeSlashInReferences: (text: string) => string;
+declare const normalizeSlashInReferences: (text: string) => string;
 /**
  * Reduces multiple spaces or tabs to a single space.
  * Example: 'This   is a   text' becomes 'This is a text'.
  * @param {string} text - The input text containing extra spaces.
  * @returns {string} - The modified text with reduced spaces.
  */
-export const normalizeSpaces: (text: string) => string;
-/**
- * Ensures at most 1 space exists before any word before brackets.
- * Adds a space if there isn't one, or reduces multiple spaces to one.
- * @param {string} text - The input text to modify
- * @returns {string} - The modified text with proper spacing before brackets
- */
-export const ensureSpaceBeforeBrackets: (text: string) => string;
+declare const normalizeSpaces: (text: string) => string;
 /**
  * Removes redundant punctuation marks that follow Arabic question marks or exclamation marks.
  * This function cleans up text by removing periods (.) or Arabic commas (،) that immediately
@@ -276,40 +311,54 @@ export const ensureSpaceBeforeBrackets: (text: string) => string;
  * removeRedundantPunctuation('هذا جيد.') // Returns: 'هذا جيد.' (unchanged)
  * ```
  */
-export const removeRedundantPunctuation: (text: string) => string;
+declare const removeRedundantPunctuation: (text: string) => string;
 /**
  * Removes spaces inside brackets, parentheses, or square brackets.
  * Example: '( a b )' becomes '(a b)'.
  * @param {string} text - The input text with spaces inside brackets.
  * @returns {string} - The modified text with spaces removed inside brackets.
  */
-export const removeSpaceInsideBrackets: (text: string) => string;
+declare const removeSpaceInsideBrackets: (text: string) => string;
+/**
+ * Replaces double parentheses single a single arrow variation.
+ * Example: '((text))' becomes '«text»'.
+ * @param {string} text - The input text to apply the rule to.
+ * @returns {string} - The modified text with condensed brackets.
+ */
+declare const replaceDoubleBracketsWithArrows: (text: string) => string;
 /**
  * Removes bold styling from text by normalizing the string and removing stylistic characters.
  * @param {string} text - The input text containing bold characters.
  * @returns {string} - The modified text with bold styling removed.
  */
-export const stripBoldStyling: (text: string) => string;
+declare const stripBoldStyling: (text: string) => string;
 /**
  * Removes italicized characters by replacing italic Unicode characters with their normal counterparts.
  * Example: '𝘼𝘽𝘾' becomes 'ABC'.
  * @param {string} text - The input text containing italicized characters.
  * @returns {string} - The modified text with italics removed.
  */
-export const stripItalicsStyling: (text: string) => string;
+declare const stripItalicsStyling: (text: string) => string;
 /**
  * Removes all bold and italic styling from the input text.
  * @param {string} text - The input text to remove styling from.
  * @returns {string} - The modified text with all styling removed.
  */
-export const stripStyling: (text: string) => string;
+declare const stripStyling: (text: string) => string;
+/**
+ * Converts a string to title case (first letter of each word capitalized)
+ * @param str - The input string to convert
+ * @returns String with each word's first letter capitalized
+ */
+declare const toTitleCase: (str: string) => string;
 /**
  * Removes unnecessary spaces inside quotes.
  * Example: '“ Text ”' becomes '“Text”'.
  * @param {string} text - The input text with spaces inside quotes.
  * @returns {string} - The modified text with spaces removed inside quotes.
  */
-export const trimSpaceInsideQuotes: (text: string) => string;
+declare const trimSpaceInsideQuotes: (text: string) => string;
+
 /**
  * Converts a string that resembles JSON but with numeric keys and single-quoted values
  * into valid JSON format. This function replaces numeric keys with quoted numeric keys
@@ -322,7 +371,7 @@ export const trimSpaceInsideQuotes: (text: string) => string;
  * const result = normalizeJsonSyntax("{10: 'abc', 20: 'def'}");
  * console.log(result); // '{"10": "abc", "20": "def"}'
  */
-export const normalizeJsonSyntax: (str: string) => string;
+declare const normalizeJsonSyntax: (str: string) => string;
 /**
  * Checks if a given string resembles a JSON object with numeric or quoted keys and values
  * that are single or double quoted. This is useful for detecting malformed JSON-like
@@ -335,7 +384,7 @@ export const normalizeJsonSyntax: (str: string) => string;
  * const result = isJsonStructureValid("{10: 'abc', 'key': 'value'}");
  * console.log(result); // true
  */
-export const isJsonStructureValid: (str: string) => boolean;
+declare const isJsonStructureValid: (str: string) => boolean;
 /**
  * Splits a string by spaces and quoted substrings.
  *
@@ -350,7 +399,7 @@ export const isJsonStructureValid: (str: string) => boolean;
  * const result = splitByQuotes('"This is" "a part of the" "string and"');
  * console.log(result); // ["This is", "a part of the", "string and"]
  */
-export const splitByQuotes: (query: string) => string[];
+declare const splitByQuotes: (query: string) => string[];
 /**
  * Checks if both quotes and brackets are balanced in a string.
  * This function combines quote balance checking and bracket balance checking
@@ -371,63 +420,77 @@ export const splitByQuotes: (query: string) => string[];
  * isBalanced('Hello (world) [test]') // Returns: true
  * ```
  */
-export const isBalanced: (str: string) => boolean;
+declare const isBalanced: (str: string) => boolean;
+/**
+ * Parses page input string into array of page numbers, supporting ranges and lists
+ * @param pageInput - Page specification string (e.g., "1-5" or "1,3,5")
+ * @returns Array of page numbers
+ * @throws Error when start page exceeds end page in range
+ */
+declare const parsePageRanges: (pageInput: string) => number[];
+
 /**
  * Removes various symbols, part references, and numerical markers from the text.
  * Example: '(1) (2/3)' becomes ''.
  * @param {string} text - The input text to apply the rule to.
  * @returns {string} - The modified text with symbols and part references removed.
  */
-export const cleanSymbolsAndPartReferences: (text: string) => string;
+declare const cleanSymbolsAndPartReferences: (text: string) => string;
 /**
  * Removes trailing page numbers formatted as '-[46]-' from the text.
  * Example: 'This is some -[46]- text' becomes 'This is some text'.
  * @param {string} text - The input text with trailing page numbers.
  * @returns {string} - The modified text with page numbers removed.
  */
-export const cleanTrailingPageNumbers: (text: string) => string;
+declare const cleanTrailingPageNumbers: (text: string) => string;
 /**
  * Replaces consecutive line breaks and whitespace characters with a single space.
  * Example: 'a\nb' becomes 'a b'.
  * @param {string} text - The input text containing line breaks or multiple spaces.
  * @returns {string} - The modified text with spaces.
  */
-export const replaceLineBreaksWithSpaces: (text: string) => string;
+declare const replaceLineBreaksWithSpaces: (text: string) => string;
 /**
  * Removes all numeric digits from the text.
  * Example: 'abc123' becomes 'abc'.
  * @param {string} text - The input text containing digits.
  * @returns {string} - The modified text with digits removed.
  */
-export const stripAllDigits: (text: string) => string;
+declare const stripAllDigits: (text: string) => string;
 /**
  * Removes death year references like "(d. 390H)" and "[d. 100h]" from the text.
  * Example: 'Sufyān ibn ‘Uyaynah (d. 198h)' becomes 'Sufyān ibn ‘Uyaynah'.
  * @param {string} text - The input text containing death year references.
  * @returns {string} - The modified text with death years removed.
  */
-export const removeDeathYear: (text: string) => string;
+declare const removeDeathYear: (text: string) => string;
 /**
  * Removes numeric digits and dashes from the text.
  * Example: 'ABC 123-Xyz' becomes 'ABC Xyz'.
  * @param {string} text - The input text containing digits and dashes.
  * @returns {string} - The modified text with numbers and dashes removed.
  */
-export const removeNumbersAndDashes: (text: string) => string;
+declare const removeNumbersAndDashes: (text: string) => string;
 /**
  * Removes single digit references like (1), «2», [3] from the text.
  * Example: 'Ref (1), Ref «2», Ref [3]' becomes 'Ref , Ref , Ref '.
  * @param {string} text - The input text containing single digit references.
  * @returns {string} - The modified text with single digit references removed.
  */
-export const removeSingleDigitReferences: (text: string) => string;
+declare const removeSingleDigitReferences: (text: string) => string;
 /**
  * Removes URLs from the text.
  * Example: 'Visit https://example.com' becomes 'Visit '.
  * @param {string} text - The input text containing URLs.
  * @returns {string} - The modified text with URLs removed.
  */
-export const removeUrls: (text: string) => string;
+declare const removeUrls: (text: string) => string;
+/**
+ * Removes common Markdown formatting syntax from text
+ * @param text - The input text containing Markdown formatting
+ * @returns Text with Markdown formatting removed (bold, italics, headers, lists, backticks)
+ */
+declare const removeMarkdownFormatting: (text: string) => string;
 /**
  * Truncates a string to a specified length, adding an ellipsis if truncated.
  *
@@ -444,7 +507,7 @@ export const removeUrls: (text: string) => string;
  * // Output: 'Short text'
  * ```
  */
-export const truncate: (val: string, n?: number) => string;
+declare const truncate: (val: string, n?: number) => string;
 /**
  * Truncates a string from the middle, preserving both the beginning and end portions.
  *
@@ -465,7 +528,7 @@ export const truncate: (val: string, n?: number) => string;
  * // Output: 'Short text'
  * ```
  */
-export const truncateMiddle: (text: string, maxLength?: number, endLength?: number) => string;
+declare const truncateMiddle: (text: string, maxLength?: number, endLength?: number) => string;
 /**
  * Unescapes backslash-escaped spaces and trims whitespace from both ends.
  * Commonly used to clean file paths that have been escaped when pasted into terminals.
@@ -485,7 +548,16 @@ export const truncateMiddle: (text: string, maxLength?: number, endLength?: numb
  * // Output: 'regular text'
  * ```
  */
-export const unescapeSpaces: (input: string) => string;
+declare const unescapeSpaces: (input: string) => string;
+/**
+ * Creates a diacritic-insensitive regex pattern for Arabic text matching.
+ * Normalizes text, handles character equivalences (ا/آ/أ/إ, ة/ه, ى/ي),
+ * and makes each character tolerant of Arabic diacritics (Tashkeel/Harakat)
+ * @param text - Input Arabic text to make diacritic-insensitive
+ * @returns Regex pattern string that matches the text with or without diacritics and character variants
+ */
+declare const makeDiacriticInsensitive: (text: string) => string;
+
 /**
  * Replaces common Arabic prefixes (like 'Al-', 'Ar-', 'Ash-', etc.) with 'al-' in the text.
  * Handles different variations of prefixes such as Ash- and Al- but not when the second word
@@ -495,7 +567,7 @@ export const unescapeSpaces: (input: string) => string;
  * @param {string} text - The input text containing Arabic prefixes.
  * @returns {string} - The modified text with standardized 'al-' prefixes.
  */
-export const normalizeArabicPrefixesToAl: (text: string) => string;
+declare const normalizeArabicPrefixesToAl: (text: string) => string;
 /**
  * Removes double occurrences of Arabic apostrophes such as ʿʿ or ʾʾ in the text.
  * Example: 'ʿulamāʾʾ' becomes 'ʿulamāʾ'.
@@ -503,7 +575,7 @@ export const normalizeArabicPrefixesToAl: (text: string) => string;
  * @param {string} text - The input text containing double apostrophes.
  * @returns {string} - The modified text with condensed apostrophes.
  */
-export const normalizeDoubleApostrophes: (text: string) => string;
+declare const normalizeDoubleApostrophes: (text: string) => string;
 /**
  * Replaces common salutations such as "sallahu alayhi wasallam" with "ﷺ" in the text.
  * It also handles variations of the salutation phrase, including 'peace and blessings be upon him'.
@@ -512,7 +584,7 @@ export const normalizeDoubleApostrophes: (text: string) => string;
  * @param {string} text - The input text containing salutations.
  * @returns {string} - The modified text with salutations replaced.
  */
-export const replaceSalutationsWithSymbol: (text: string) => string;
+declare const replaceSalutationsWithSymbol: (text: string) => string;
 /**
  * Normalizes the text by removing diacritics, apostrophes, and dashes.
  * Example: 'Al-Jadwal' becomes 'AlJadwal'.
@@ -520,7 +592,7 @@ export const replaceSalutationsWithSymbol: (text: string) => string;
  * @param {string} input - The input text to normalize.
  * @returns {string} - The normalized text.
  */
-export const normalize: (input: string) => string;
+declare const normalize: (input: string) => string;
 /**
  * Replaces various apostrophe characters (‛, ’, ‘) with the standard apostrophe (').
  * Example: '‛ulama’ al-su‘' becomes ''ulama' al-su''.
@@ -528,7 +600,7 @@ export const normalize: (input: string) => string;
  * @param {string} text - The input text containing different apostrophe characters.
  * @returns {string} - The modified text with normalized apostrophes.
  */
-export const normalizeApostrophes: (text: string) => string;
+declare const normalizeApostrophes: (text: string) => string;
 /**
  * Strips common Arabic prefixes like 'al-', 'bi-', 'fī', 'wa-', etc. from the beginning of words.
  * Example: 'al-Bukhari' becomes 'Bukhari'.
@@ -536,7 +608,7 @@ export const normalizeApostrophes: (text: string) => string;
  * @param {string} text - The input text containing Arabic prefixes.
  * @returns {string} - The modified text with prefixes stripped.
  */
-export const removeArabicPrefixes: (text: string) => string;
+declare const removeArabicPrefixes: (text: string) => string;
 /**
  * Simplifies English transliterations by removing diacritics, apostrophes, and common prefixes.
  * Example: 'Al-Jadwal' becomes 'Jadwal', and 'āḍġḥīṣṭū' becomes 'adghistu'.
@@ -544,7 +616,7 @@ export const removeArabicPrefixes: (text: string) => string;
  * @param {string} text - The input text to simplify.
  * @returns {string} - The simplified text.
  */
-export const normalizeTransliteratedEnglish: (text: string) => string;
+declare const normalizeTransliteratedEnglish: (text: string) => string;
 /**
  * Extracts the initials from the input string, typically used for names or titles.
  * Example: 'Nayl al-Awtar' becomes 'NA'.
@@ -552,6 +624,6 @@ export const normalizeTransliteratedEnglish: (text: string) => string;
  * @param {string} text - The input text to extract initials from.
  * @returns {string} - The extracted initials.
  */
-export const extractInitials: (fullName: string) => string;
+declare const extractInitials: (fullName: string) => string;
 
-//# sourceMappingURL=index.d.ts.map
+export { addSpaceBeforeAndAfterPunctuation, addSpaceBetweenArabicTextAndNumbers, applySmartQuotes, cleanExtremeArabicUnderscores, cleanJunkFromText, cleanLiteralNewLines, cleanMultilines, cleanSpacesBeforePeriod, cleanSymbolsAndPartReferences, cleanTrailingPageNumbers, condenseAsterisks, condenseColons, condenseDashes, condenseEllipsis, condensePeriods, condenseUnderscores, convertUrduSymbolsToArabic, doubleToSingleBrackets, ensureSpaceBeforeBrackets, ensureSpaceBeforeQuotes, extractInitials, fixBracketTypos, fixCurlyBraces, fixMismatchedQuotationMarks, fixTrailingWow, formatStringBySentence, getArabicScore, hasWordInSingleLine, insertLineBreaksAfterPunctuation, isAllUppercase, isBalanced, isJsonStructureValid, isOnlyPunctuation, makeDiacriticInsensitive, normalize, normalizeAlifVariants, normalizeApostrophes, normalizeArabicPrefixesToAl, normalizeDoubleApostrophes, normalizeJsonSyntax, normalizeSlashInReferences, normalizeSpaces, normalizeTransliteratedEnglish, parsePageRanges, reduceMultilineBreaksToDouble, reduceMultilineBreaksToSingle, removeArabicPrefixes, removeDeathYear, removeMarkdownFormatting, removeNonIndexSignatures, removeNumbersAndDashes, removeRedundantPunctuation, removeSingleDigitReferences, removeSingularCodes, removeSolitaryArabicLetters, removeSpaceInsideBrackets, removeTatwil, removeUrls, replaceAlifMaqsurah, replaceDoubleBracketsWithArrows, replaceEnglishPunctuationWithArabic, replaceLineBreaksWithSpaces, replaceSalutationsWithSymbol, replaceTaMarbutahWithHa, splitByQuotes, stripAllDigits, stripBoldStyling, stripDiacritics, stripEnglishCharactersAndSymbols, stripItalicsStyling, stripStyling, stripZeroWidthCharacters, toTitleCase, trimSpaceInsideQuotes, truncate, truncateMiddle, unescapeSpaces };