urdu-text-utils 0.1.6 → 0.1.7

package/dist/index.d.cts

@@ -302,4 +302,100 @@ interface SlugOptions {
  */
 declare function urduSlug(input: string, options?: SlugOptions): string;
 
-export { type DigitStyle, type IsUrduOptions, type NormalizeOptions, type SearchOptions, type SearchResult, type SlugOptions, type SortOptions, type SplitSentenceOptions, URDU_STOP_WORDS, type UrduStats, analyzeUrdu, compareUrdu, convertNumbers, countSentences, countWords, editDistance, filterStopWords, foldUrdu, hasUrduSpecificLetters, highlightUrdu, isStopWord, isUrdu, normalizeUrdu, numberToUrduWords, parseUrduNumber, removeDiacritics, removeStopWords, romanToUrdu, romanize, searchUrdu, searchUrduRanked, sortUrdu, splitSentences, splitWords, toArabicIndicDigits, toEnglishDigits, toUrduDigits, urduRatio, urduSlug };
+/**
+ * Gregorian month names in Urdu (standard literary transliterations).
+ * Index 0 corresponds to January (جنوری).
+ */
+declare const URDU_MONTHS_GREGORIAN: readonly ["جنوری", "فروری", "مارچ", "اپریل", "مئی", "جون", "جولائی", "اگست", "ستمبر", "اکتوبر", "نومبر", "دسمبر"];
+/**
+ * Islamic (Hijri) month names in Urdu.
+ * Index 0 corresponds to Muharram (محرم).
+ */
+declare const URDU_MONTHS_HIJRI: readonly ["محرم", "صفر", "ربیع الاول", "ربیع الثانی", "جمادی الاول", "جمادی الثانی", "رجب", "شعبان", "رمضان المبارک", "شوال", "ذی القعدہ", "ذی الحجہ"];
+/**
+ * Days of the week in Urdu.
+ * Index 0 corresponds to Sunday (اتوار).
+ */
+declare const URDU_WEEKDAYS: readonly ["اتوار", "پیر", "منگل", "بدھ", "جمعرات", "جمعہ", "ہفتہ"];
+interface FormatUrduDateOptions {
+    /**
+     * Digit style to use for numeric tokens (e.g. YYYY, MM, DD, HH, mm, ss).
+     * @default "urdu"
+     */
+    digits?: "urdu" | "english";
+    /**
+     * Calendar month naming scheme to use for `MMMM` and `MMM`.
+     * @default "gregorian"
+     */
+    calendar?: "gregorian" | "hijri";
+}
+interface TimeAgoOptions {
+    /**
+     * Digit style to use for counts (e.g. "۵ منٹ پہلے" vs "5 منٹ پہلے").
+     * @default "urdu"
+     */
+    digits?: "urdu" | "english";
+    /**
+     * Whether to include the relative suffix/prefix ("پہلے" or "بعد").
+     * When `false`, returns only the duration string (e.g. "۵ منٹ", "ایک گھنٹہ").
+     * @default true
+     */
+    addSuffix?: boolean;
+}
+/**
+ * Returns the Urdu name for a given month index (0 to 11).
+ *
+ * @param monthIndex - 0 for January / Muharram, 11 for December / Dhul Hijjah.
+ * @param calendar - "gregorian" or "hijri". Default is "gregorian".
+ */
+declare function getUrduMonthName(monthIndex: number, calendar?: "gregorian" | "hijri"): string;
+/**
+ * Returns the Urdu name for a day of the week (0 = Sunday, 6 = Saturday).
+ */
+declare function getUrduWeekdayName(dayIndex: number): string;
+/**
+ * Formats a Date object or timestamp into an Urdu formatted date string.
+ *
+ * Supported formatting tokens:
+ * - `YYYY`: Full year (e.g. "۲۰۲۶")
+ * - `YY`: Two-digit year (e.g. "۲۶")
+ * - `MMMM`: Full Urdu month name (e.g. "اگست")
+ * - `MMM`: Full Urdu month name (e.g. "اگست")
+ * - `MM`: 2-digit month with leading zero (e.g. "۰۸")
+ * - `M`: 1-digit month (e.g. "۸")
+ * - `DD`: 2-digit day of month with leading zero (e.g. "۰۵")
+ * - `D`: 1-digit day of month (e.g. "۵")
+ * - `dddd`: Full day of the week (e.g. "ہفتہ", "جمعہ")
+ * - `ddd`: Short day of the week (same in Urdu)
+ * - `HH`: 24-hour hour with leading zero (00-23)
+ * - `H`: 24-hour hour (0-23)
+ * - `hh`: 12-hour hour with leading zero (01-12)
+ * - `h`: 12-hour hour (1-12)
+ * - `mm`: Minute with leading zero (00-59)
+ * - `m`: Minute (0-59)
+ * - `ss`: Second with leading zero (00-59)
+ * - `s`: Second (0-59)
+ * - `A`: Day period indicator in Urdu ("صبح", "دوپہر", "شام", "رات")
+ * - `a`: Concise period indicator ("صبح", "شام")
+ *
+ * @example
+ * formatUrduDate(new Date(2026, 7, 22), "DD MMMM YYYY")
+ * // "۲۲ اگست ۲۰۲۶"
+ *
+ * formatUrduDate(new Date(2026, 7, 22, 14, 30), "dddd، D MMMM YYYY، hh:mm A")
+ * // "ہفتہ، ۲۲ اگست ۲۰۲۶، ۰۲:۳۰ دوپہر"
+ */
+declare function formatUrduDate(date: Date | string | number, pattern?: string, options?: FormatUrduDateOptions): string;
+/**
+ * Returns a human-friendly relative time string in Urdu.
+ *
+ * @example
+ * timeAgoUrdu(Date.now() - 30 * 1000)       // "ابھی"
+ * timeAgoUrdu(Date.now() - 5 * 60 * 1000)   // "۵ منٹ پہلے"
+ * timeAgoUrdu(Date.now() - 3 * 3600 * 1000) // "۳ گھنٹے پہلے"
+ * timeAgoUrdu(Date.now() - 86400 * 1000)    // "کل"
+ * timeAgoUrdu(Date.now() + 5 * 60 * 1000)   // "۵ منٹ بعد"
+ */
+declare function timeAgoUrdu(date: Date | string | number, relativeTo?: Date | string | number, options?: TimeAgoOptions): string;
+
+export { type DigitStyle, type FormatUrduDateOptions, type IsUrduOptions, type NormalizeOptions, type SearchOptions, type SearchResult, type SlugOptions, type SortOptions, type SplitSentenceOptions, type TimeAgoOptions, URDU_MONTHS_GREGORIAN, URDU_MONTHS_HIJRI, URDU_STOP_WORDS, URDU_WEEKDAYS, type UrduStats, analyzeUrdu, compareUrdu, convertNumbers, countSentences, countWords, editDistance, filterStopWords, foldUrdu, formatUrduDate, getUrduMonthName, getUrduWeekdayName, hasUrduSpecificLetters, highlightUrdu, isStopWord, isUrdu, normalizeUrdu, numberToUrduWords, parseUrduNumber, removeDiacritics, removeStopWords, romanToUrdu, romanize, searchUrdu, searchUrduRanked, sortUrdu, splitSentences, splitWords, timeAgoUrdu, toArabicIndicDigits, toEnglishDigits, toUrduDigits, urduRatio, urduSlug };

package/dist/index.d.ts

@@ -302,4 +302,100 @@ interface SlugOptions {
  */
 declare function urduSlug(input: string, options?: SlugOptions): string;
 
-export { type DigitStyle, type IsUrduOptions, type NormalizeOptions, type SearchOptions, type SearchResult, type SlugOptions, type SortOptions, type SplitSentenceOptions, URDU_STOP_WORDS, type UrduStats, analyzeUrdu, compareUrdu, convertNumbers, countSentences, countWords, editDistance, filterStopWords, foldUrdu, hasUrduSpecificLetters, highlightUrdu, isStopWord, isUrdu, normalizeUrdu, numberToUrduWords, parseUrduNumber, removeDiacritics, removeStopWords, romanToUrdu, romanize, searchUrdu, searchUrduRanked, sortUrdu, splitSentences, splitWords, toArabicIndicDigits, toEnglishDigits, toUrduDigits, urduRatio, urduSlug };
+/**
+ * Gregorian month names in Urdu (standard literary transliterations).
+ * Index 0 corresponds to January (جنوری).
+ */
+declare const URDU_MONTHS_GREGORIAN: readonly ["جنوری", "فروری", "مارچ", "اپریل", "مئی", "جون", "جولائی", "اگست", "ستمبر", "اکتوبر", "نومبر", "دسمبر"];
+/**
+ * Islamic (Hijri) month names in Urdu.
+ * Index 0 corresponds to Muharram (محرم).
+ */
+declare const URDU_MONTHS_HIJRI: readonly ["محرم", "صفر", "ربیع الاول", "ربیع الثانی", "جمادی الاول", "جمادی الثانی", "رجب", "شعبان", "رمضان المبارک", "شوال", "ذی القعدہ", "ذی الحجہ"];
+/**
+ * Days of the week in Urdu.
+ * Index 0 corresponds to Sunday (اتوار).
+ */
+declare const URDU_WEEKDAYS: readonly ["اتوار", "پیر", "منگل", "بدھ", "جمعرات", "جمعہ", "ہفتہ"];
+interface FormatUrduDateOptions {
+    /**
+     * Digit style to use for numeric tokens (e.g. YYYY, MM, DD, HH, mm, ss).
+     * @default "urdu"
+     */
+    digits?: "urdu" | "english";
+    /**
+     * Calendar month naming scheme to use for `MMMM` and `MMM`.
+     * @default "gregorian"
+     */
+    calendar?: "gregorian" | "hijri";
+}
+interface TimeAgoOptions {
+    /**
+     * Digit style to use for counts (e.g. "۵ منٹ پہلے" vs "5 منٹ پہلے").
+     * @default "urdu"
+     */
+    digits?: "urdu" | "english";
+    /**
+     * Whether to include the relative suffix/prefix ("پہلے" or "بعد").
+     * When `false`, returns only the duration string (e.g. "۵ منٹ", "ایک گھنٹہ").
+     * @default true
+     */
+    addSuffix?: boolean;
+}
+/**
+ * Returns the Urdu name for a given month index (0 to 11).
+ *
+ * @param monthIndex - 0 for January / Muharram, 11 for December / Dhul Hijjah.
+ * @param calendar - "gregorian" or "hijri". Default is "gregorian".
+ */
+declare function getUrduMonthName(monthIndex: number, calendar?: "gregorian" | "hijri"): string;
+/**
+ * Returns the Urdu name for a day of the week (0 = Sunday, 6 = Saturday).
+ */
+declare function getUrduWeekdayName(dayIndex: number): string;
+/**
+ * Formats a Date object or timestamp into an Urdu formatted date string.
+ *
+ * Supported formatting tokens:
+ * - `YYYY`: Full year (e.g. "۲۰۲۶")
+ * - `YY`: Two-digit year (e.g. "۲۶")
+ * - `MMMM`: Full Urdu month name (e.g. "اگست")
+ * - `MMM`: Full Urdu month name (e.g. "اگست")
+ * - `MM`: 2-digit month with leading zero (e.g. "۰۸")
+ * - `M`: 1-digit month (e.g. "۸")
+ * - `DD`: 2-digit day of month with leading zero (e.g. "۰۵")
+ * - `D`: 1-digit day of month (e.g. "۵")
+ * - `dddd`: Full day of the week (e.g. "ہفتہ", "جمعہ")
+ * - `ddd`: Short day of the week (same in Urdu)
+ * - `HH`: 24-hour hour with leading zero (00-23)
+ * - `H`: 24-hour hour (0-23)
+ * - `hh`: 12-hour hour with leading zero (01-12)
+ * - `h`: 12-hour hour (1-12)
+ * - `mm`: Minute with leading zero (00-59)
+ * - `m`: Minute (0-59)
+ * - `ss`: Second with leading zero (00-59)
+ * - `s`: Second (0-59)
+ * - `A`: Day period indicator in Urdu ("صبح", "دوپہر", "شام", "رات")
+ * - `a`: Concise period indicator ("صبح", "شام")
+ *
+ * @example
+ * formatUrduDate(new Date(2026, 7, 22), "DD MMMM YYYY")
+ * // "۲۲ اگست ۲۰۲۶"
+ *
+ * formatUrduDate(new Date(2026, 7, 22, 14, 30), "dddd، D MMMM YYYY، hh:mm A")
+ * // "ہفتہ، ۲۲ اگست ۲۰۲۶، ۰۲:۳۰ دوپہر"
+ */
+declare function formatUrduDate(date: Date | string | number, pattern?: string, options?: FormatUrduDateOptions): string;
+/**
+ * Returns a human-friendly relative time string in Urdu.
+ *
+ * @example
+ * timeAgoUrdu(Date.now() - 30 * 1000)       // "ابھی"
+ * timeAgoUrdu(Date.now() - 5 * 60 * 1000)   // "۵ منٹ پہلے"
+ * timeAgoUrdu(Date.now() - 3 * 3600 * 1000) // "۳ گھنٹے پہلے"
+ * timeAgoUrdu(Date.now() - 86400 * 1000)    // "کل"
+ * timeAgoUrdu(Date.now() + 5 * 60 * 1000)   // "۵ منٹ بعد"
+ */
+declare function timeAgoUrdu(date: Date | string | number, relativeTo?: Date | string | number, options?: TimeAgoOptions): string;
+
+export { type DigitStyle, type FormatUrduDateOptions, type IsUrduOptions, type NormalizeOptions, type SearchOptions, type SearchResult, type SlugOptions, type SortOptions, type SplitSentenceOptions, type TimeAgoOptions, URDU_MONTHS_GREGORIAN, URDU_MONTHS_HIJRI, URDU_STOP_WORDS, URDU_WEEKDAYS, type UrduStats, analyzeUrdu, compareUrdu, convertNumbers, countSentences, countWords, editDistance, filterStopWords, foldUrdu, formatUrduDate, getUrduMonthName, getUrduWeekdayName, hasUrduSpecificLetters, highlightUrdu, isStopWord, isUrdu, normalizeUrdu, numberToUrduWords, parseUrduNumber, removeDiacritics, removeStopWords, romanToUrdu, romanize, searchUrdu, searchUrduRanked, sortUrdu, splitSentences, splitWords, timeAgoUrdu, toArabicIndicDigits, toEnglishDigits, toUrduDigits, urduRatio, urduSlug };