urdu-text-utils 0.1.6 → 0.1.7

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.1.7
+
+- Add Urdu date & time formatting module (`formatUrduDate`, `timeAgoUrdu`, `getUrduMonthName`, `getUrduWeekdayName`).
+- Add pattern token replacement (`YYYY`, `MMMM`, `DD`, `dddd`, `hh:mm A`) with automatic Urdu numerals and day period indicators (`صبح`, `دوپہر`, `شام`, `رات`).
+- Add localized natural relative time formatting for past and future dates (*"ابھی"*, *"۵ منٹ پہلے"*, *"۳ گھنٹے پہلے"*, *"کل"*, *"پرسوں"*, *"۲ ہفتے بعد"*).
+- Add canonical constants `URDU_MONTHS_GREGORIAN`, `URDU_MONTHS_HIJRI`, and `URDU_WEEKDAYS`.
+
 ## 0.1.6
 
 - Add dedicated minified IIFE browser bundle (`dist/index.iife.js`) exposing `window.UrduTextUtils` for seamless jsDelivr and unpkg CDN usage without a bundler.

package/README.md

@@ -1,6 +1,8 @@
 # urdu-text-utils — Urdu Text Processing Toolkit for JavaScript & TypeScript
 
 [![npm version](https://img.shields.io/npm/v/urdu-text-utils?style=flat-square&color=157f52&label=npm)](https://www.npmjs.com/package/urdu-text-utils)
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/urdu-text-utils/badge?style=flat-square)](https://www.jsdelivr.com/package/npm/urdu-text-utils)
+[![unpkg](https://img.shields.io/badge/unpkg-urdu--text--utils-blue?style=flat-square)](https://unpkg.com/urdu-text-utils/)
 [![CI](https://img.shields.io/github/actions/workflow/status/Zaid-maker/urdu-text-utils/ci.yml?branch=main&style=flat-square&label=CI)](https://github.com/Zaid-maker/urdu-text-utils/actions/workflows/ci.yml)
 [![minzipped size](https://img.shields.io/bundlejs/size/urdu-text-utils?style=flat-square&label=min%2Bgzip)](https://bundlejs.com/?q=urdu-text-utils)
 [![dependencies](https://img.shields.io/badge/dependencies-0-157f52?style=flat-square)](https://www.npmjs.com/package/urdu-text-utils?activeTab=dependencies)
@@ -49,6 +51,8 @@ import {
   urduSlug,
   isStopWord,
   removeStopWords,
+  formatUrduDate,
+  timeAgoUrdu,
   isUrdu,
   countWords,
   splitSentences,
@@ -147,6 +151,27 @@ parseUrduNumber("۳٫۱۴"); // 3.14
 numberToUrduWords(100000); // "ایک لاکھ" — South Asian scale, @experimental
 ```
 
+## Urdu dates & relative time
+
+```ts
+import { formatUrduDate, timeAgoUrdu } from "urdu-text-utils";
+
+// Format date with Urdu month and numerals
+formatUrduDate(new Date(), "DD MMMM YYYY");
+// "۲۲ اگست ۲۰۲۶"
+
+// Date with weekday and 12-hour period
+formatUrduDate(new Date(), "dddd، D MMMM YYYY، hh:mm A");
+// "ہفتہ، ۲۲ اگست ۲۰۲۶، ۰۲:۳۰ دوپہر"
+
+// Natural relative time (time ago)
+timeAgoUrdu(Date.now() - 5 * 60 * 1000);   // "۵ منٹ پہلے"
+timeAgoUrdu(Date.now() - 3 * 3600 * 1000); // "۳ گھنٹے پہلے"
+timeAgoUrdu(Date.now() - 86400 * 1000);    // "کل"
+timeAgoUrdu(Date.now() - 2 * 86400 * 1000);// "پرسوں"
+timeAgoUrdu(Date.now() + 10 * 60 * 1000);  // "۱۰ منٹ بعد"
+```
+
 ## Diacritics
 
 ```ts

package/dist/index.cjs

@@ -3508,7 +3508,205 @@ function urduSlug(input, options = {}) {
   return slug;
 }
 
+// src/date.ts
+var URDU_MONTHS_GREGORIAN = [
+  "\u062C\u0646\u0648\u0631\u06CC",
+  "\u0641\u0631\u0648\u0631\u06CC",
+  "\u0645\u0627\u0631\u0686",
+  "\u0627\u067E\u0631\u06CC\u0644",
+  "\u0645\u0626\u06CC",
+  "\u062C\u0648\u0646",
+  "\u062C\u0648\u0644\u0627\u0626\u06CC",
+  "\u0627\u06AF\u0633\u062A",
+  "\u0633\u062A\u0645\u0628\u0631",
+  "\u0627\u06A9\u062A\u0648\u0628\u0631",
+  "\u0646\u0648\u0645\u0628\u0631",
+  "\u062F\u0633\u0645\u0628\u0631"
+];
+var URDU_MONTHS_HIJRI = [
+  "\u0645\u062D\u0631\u0645",
+  "\u0635\u0641\u0631",
+  "\u0631\u0628\u06CC\u0639 \u0627\u0644\u0627\u0648\u0644",
+  "\u0631\u0628\u06CC\u0639 \u0627\u0644\u062B\u0627\u0646\u06CC",
+  "\u062C\u0645\u0627\u062F\u06CC \u0627\u0644\u0627\u0648\u0644",
+  "\u062C\u0645\u0627\u062F\u06CC \u0627\u0644\u062B\u0627\u0646\u06CC",
+  "\u0631\u062C\u0628",
+  "\u0634\u0639\u0628\u0627\u0646",
+  "\u0631\u0645\u0636\u0627\u0646 \u0627\u0644\u0645\u0628\u0627\u0631\u06A9",
+  "\u0634\u0648\u0627\u0644",
+  "\u0630\u06CC \u0627\u0644\u0642\u0639\u062F\u06C1",
+  "\u0630\u06CC \u0627\u0644\u062D\u062C\u06C1"
+];
+var URDU_WEEKDAYS = [
+  "\u0627\u062A\u0648\u0627\u0631",
+  "\u067E\u06CC\u0631",
+  "\u0645\u0646\u06AF\u0644",
+  "\u0628\u062F\u06BE",
+  "\u062C\u0645\u0639\u0631\u0627\u062A",
+  "\u062C\u0645\u0639\u06C1",
+  "\u06C1\u0641\u062A\u06C1"
+];
+function parseDateInput(input) {
+  if (input instanceof Date) {
+    return isNaN(input.getTime()) ? null : input;
+  }
+  const date = new Date(input);
+  return isNaN(date.getTime()) ? null : date;
+}
+function getUrduMonthName(monthIndex, calendar = "gregorian") {
+  const normalizedIndex = Math.floor(monthIndex) % 12;
+  const idx = normalizedIndex < 0 ? normalizedIndex + 12 : normalizedIndex;
+  return calendar === "hijri" ? URDU_MONTHS_HIJRI[idx] : URDU_MONTHS_GREGORIAN[idx];
+}
+function getUrduWeekdayName(dayIndex) {
+  const normalizedIndex = Math.floor(dayIndex) % 7;
+  const idx = normalizedIndex < 0 ? normalizedIndex + 7 : normalizedIndex;
+  return URDU_WEEKDAYS[idx];
+}
+function formatUrduDate(date, pattern = "DD MMMM YYYY", options = {}) {
+  const d = parseDateInput(date);
+  if (!d) return "";
+  const digits = options.digits ?? "urdu";
+  const calendar = options.calendar ?? "gregorian";
+  const year = d.getFullYear();
+  const month = d.getMonth();
+  const dayOfMonth = d.getDate();
+  const dayOfWeek = d.getDay();
+  const hours24 = d.getHours();
+  const hours12 = hours24 % 12 || 12;
+  const minutes = d.getMinutes();
+  const seconds = d.getSeconds();
+  const pad = (n) => n < 10 ? `0${n}` : `${n}`;
+  let periodDetailed;
+  let periodSimple;
+  if (hours24 >= 4 && hours24 < 12) {
+    periodDetailed = "\u0635\u0628\u062D";
+    periodSimple = "\u0635\u0628\u062D";
+  } else if (hours24 >= 12 && hours24 < 16) {
+    periodDetailed = "\u062F\u0648\u067E\u06C1\u0631";
+    periodSimple = "\u0634\u0627\u0645";
+  } else if (hours24 >= 16 && hours24 < 20) {
+    periodDetailed = "\u0634\u0627\u0645";
+    periodSimple = "\u0634\u0627\u0645";
+  } else {
+    periodDetailed = "\u0631\u0627\u062A";
+    periodSimple = "\u0631\u0627\u062A";
+  }
+  const tokenValues = {
+    YYYY: `${year}`,
+    YY: `${year}`.slice(-2),
+    MMMM: getUrduMonthName(month, calendar),
+    MMM: getUrduMonthName(month, calendar),
+    MM: pad(month + 1),
+    M: `${month + 1}`,
+    DD: pad(dayOfMonth),
+    D: `${dayOfMonth}`,
+    dddd: getUrduWeekdayName(dayOfWeek),
+    ddd: getUrduWeekdayName(dayOfWeek),
+    HH: pad(hours24),
+    H: `${hours24}`,
+    hh: pad(hours12),
+    h: `${hours12}`,
+    mm: pad(minutes),
+    m: `${minutes}`,
+    ss: pad(seconds),
+    s: `${seconds}`,
+    A: periodDetailed,
+    a: periodSimple
+  };
+  const regex = /YYYY|YY|MMMM|MMM|MM|M|DD|D|dddd|ddd|HH|H|hh|h|mm|m|ss|s|A|a/g;
+  const result = pattern.replace(regex, (match) => {
+    const val = tokenValues[match];
+    if (val === void 0) return match;
+    if (digits === "urdu" && /^\d+$/.test(val)) {
+      return toUrduDigits(val);
+    }
+    return val;
+  });
+  return result;
+}
+function timeAgoUrdu(date, relativeTo = /* @__PURE__ */ new Date(), options = {}) {
+  const d = parseDateInput(date);
+  const now = parseDateInput(relativeTo);
+  if (!d || !now) return "";
+  const digits = options.digits ?? "urdu";
+  const addSuffix = options.addSuffix ?? true;
+  const formatNum = (num) => {
+    const s = `${num}`;
+    return digits === "urdu" ? toUrduDigits(s) : s;
+  };
+  const diffMs = now.getTime() - d.getTime();
+  const isPast = diffMs >= 0;
+  const absDiffSeconds = Math.round(Math.abs(diffMs) / 1e3);
+  if (absDiffSeconds < 45) {
+    return isPast ? "\u0627\u0628\u06BE\u06CC" : "\u0686\u0646\u062F \u0644\u0645\u062D\u06D2 \u0628\u0639\u062F";
+  }
+  const minutes = Math.round(absDiffSeconds / 60);
+  if (minutes <= 45) {
+    if (minutes === 1) {
+      if (!addSuffix) return "\u0627\u06CC\u06A9 \u0645\u0646\u0679";
+      return isPast ? "\u0627\u06CC\u06A9 \u0645\u0646\u0679 \u067E\u06C1\u0644\u06D2" : "\u0627\u06CC\u06A9 \u0645\u0646\u0679 \u0628\u0639\u062F";
+    }
+    const count2 = formatNum(minutes);
+    if (!addSuffix) return `${count2} \u0645\u0646\u0679`;
+    return isPast ? `${count2} \u0645\u0646\u0679 \u067E\u06C1\u0644\u06D2` : `${count2} \u0645\u0646\u0679 \u0628\u0639\u062F`;
+  }
+  const hours = Math.round(minutes / 60);
+  if (hours <= 22) {
+    if (hours === 1) {
+      if (!addSuffix) return "\u0627\u06CC\u06A9 \u06AF\u06BE\u0646\u0679\u06C1";
+      return isPast ? "\u0627\u06CC\u06A9 \u06AF\u06BE\u0646\u0679\u06C1 \u067E\u06C1\u0644\u06D2" : "\u0627\u06CC\u06A9 \u06AF\u06BE\u0646\u0679\u06C1 \u0628\u0639\u062F";
+    }
+    const count2 = formatNum(hours);
+    if (!addSuffix) return `${count2} \u06AF\u06BE\u0646\u0679\u06D2`;
+    return isPast ? `${count2} \u06AF\u06BE\u0646\u0679\u06D2 \u067E\u06C1\u0644\u06D2` : `${count2} \u06AF\u06BE\u0646\u0679\u06D2 \u0628\u0639\u062F`;
+  }
+  const days = Math.round(hours / 24);
+  if (days === 1) {
+    return isPast ? "\u06A9\u0644" : "\u06A9\u0644";
+  }
+  if (days === 2) {
+    return isPast ? "\u067E\u0631\u0633\u0648\u06BA" : "\u067E\u0631\u0633\u0648\u06BA";
+  }
+  if (days <= 6) {
+    const count2 = formatNum(days);
+    if (!addSuffix) return `${count2} \u062F\u0646`;
+    return isPast ? `${count2} \u062F\u0646 \u067E\u06C1\u0644\u06D2` : `${count2} \u062F\u0646 \u0628\u0639\u062F`;
+  }
+  const weeks = Math.round(days / 7);
+  if (days <= 28) {
+    if (weeks === 1) {
+      if (!addSuffix) return "\u0627\u06CC\u06A9 \u06C1\u0641\u062A\u06C1";
+      return isPast ? "\u0627\u06CC\u06A9 \u06C1\u0641\u062A\u06C1 \u067E\u06C1\u0644\u06D2" : "\u0627\u06CC\u06A9 \u06C1\u0641\u062A\u06C1 \u0628\u0639\u062F";
+    }
+    const count2 = formatNum(weeks);
+    if (!addSuffix) return `${count2} \u06C1\u0641\u062A\u06D2`;
+    return isPast ? `${count2} \u06C1\u0641\u062A\u06D2 \u067E\u06C1\u0644\u06D2` : `${count2} \u06C1\u0641\u062A\u06D2 \u0628\u0639\u062F`;
+  }
+  const months = Math.round(days / 30.44);
+  if (days <= 320) {
+    if (months <= 1) {
+      if (!addSuffix) return "\u0627\u06CC\u06A9 \u0645\u0627\u06C1";
+      return isPast ? "\u0627\u06CC\u06A9 \u0645\u0627\u06C1 \u067E\u06C1\u0644\u06D2" : "\u0627\u06CC\u06A9 \u0645\u0627\u06C1 \u0628\u0639\u062F";
+    }
+    const count2 = formatNum(months);
+    if (!addSuffix) return `${count2} \u0645\u0627\u06C1`;
+    return isPast ? `${count2} \u0645\u0627\u06C1 \u067E\u06C1\u0644\u06D2` : `${count2} \u0645\u0627\u06C1 \u0628\u0639\u062F`;
+  }
+  const years = Math.round(days / 365.25);
+  if (years <= 1) {
+    if (!addSuffix) return "\u0627\u06CC\u06A9 \u0633\u0627\u0644";
+    return isPast ? "\u0627\u06CC\u06A9 \u0633\u0627\u0644 \u067E\u06C1\u0644\u06D2" : "\u0627\u06CC\u06A9 \u0633\u0627\u0644 \u0628\u0639\u062F";
+  }
+  const count = formatNum(years);
+  if (!addSuffix) return `${count} \u0633\u0627\u0644`;
+  return isPast ? `${count} \u0633\u0627\u0644 \u067E\u06C1\u0644\u06D2` : `${count} \u0633\u0627\u0644 \u0628\u0639\u062F`;
+}
+
+exports.URDU_MONTHS_GREGORIAN = URDU_MONTHS_GREGORIAN;
+exports.URDU_MONTHS_HIJRI = URDU_MONTHS_HIJRI;
 exports.URDU_STOP_WORDS = URDU_STOP_WORDS;
+exports.URDU_WEEKDAYS = URDU_WEEKDAYS;
 exports.analyzeUrdu = analyzeUrdu;
 exports.compareUrdu = compareUrdu;
 exports.convertNumbers = convertNumbers;
@@ -3517,6 +3715,9 @@ exports.countWords = countWords;
 exports.editDistance = editDistance;
 exports.filterStopWords = filterStopWords;
 exports.foldUrdu = foldUrdu;
+exports.formatUrduDate = formatUrduDate;
+exports.getUrduMonthName = getUrduMonthName;
+exports.getUrduWeekdayName = getUrduWeekdayName;
 exports.hasUrduSpecificLetters = hasUrduSpecificLetters;
 exports.highlightUrdu = highlightUrdu;
 exports.isStopWord = isStopWord;
@@ -3533,6 +3734,7 @@ exports.searchUrduRanked = searchUrduRanked;
 exports.sortUrdu = sortUrdu;
 exports.splitSentences = splitSentences;
 exports.splitWords = splitWords;
+exports.timeAgoUrdu = timeAgoUrdu;
 exports.toArabicIndicDigits = toArabicIndicDigits;
 exports.toEnglishDigits = toEnglishDigits;
 exports.toUrduDigits = toUrduDigits;