last build version

rojcode · rojcode · commit 380c08cf944c · 2025-03-14T17:53:41.000+03:30
diff --git a/dist/harfizer.d.ts b/dist/harfizer.d.ts
@@ -15,6 +15,7 @@ export type Lexicon = string[][];
  * @property {string[]} [customDecimalSuffixes] - Custom array of suffixes for the fractional part.
  * @property {string} [customNegativeWord] - Custom word to denote negative numbers.
  * @property {string} [customZeroWord] - Custom word to represent zero.
+ * @property {string} [customTimePrefix] - Custom prefix for time conversion (e.g. "ساعت" or any other text).
  */
 export interface ConversionOptions {
     useNegativeWord?: boolean;
@@ -23,6 +24,7 @@ export interface ConversionOptions {
     customDecimalSuffixes?: string[];
     customNegativeWord?: string;
     customZeroWord?: string;
+    customTimePrefix?: string;
 }
 /**
  * Interface defining the conversion methods.
@@ -98,6 +100,23 @@ export declare class HarfizerConverter implements IConverter {
      * @throws {Error} Throws an error if the input format is invalid, the number is too large, or out of range.
      */
     convert(input: InputNumber, options?: ConversionOptions): string;
+    /**
+     * Converts a date string (Solar/Jalali or Gregorian) to its word representation.
+     *
+     * @param {string} dateStr - The date string in the format 'YYYY/MM/DD' or 'YYYY-MM-DD'.
+     * @param {'jalali' | 'gregorian'} [calendar='jalali'] - The calendar type, either 'jalali' or 'gregorian'.
+     * @returns {string} The word representation of the date.
+     * @throws {Error} Throws an error if the date format is invalid or the month is out of range.
+     */
+    convertDateToWords(dateStr: string, calendar?: "jalali" | "gregorian"): string;
+    /**
+     * Converts a digital time string (HH:mm) to its Persian word representation.
+     *
+     * @param {string} timeStr - The time string in "HH:mm" format.
+     * @returns {string} The word representation of the time.
+     * @throws {Error} Throws an error if the time format is invalid or if time values are out of range.
+     */
+    convertTimeToWords(timeStr: string): string;
     /**
      * Returns the default separator from the configuration or default constant.
      *
diff --git a/dist/harfizer.js b/dist/harfizer.js
@@ -191,6 +191,106 @@ class HarfizerConverter {
             : negativeWord;
         return ((isNegative ? negPrefix : "") + wordParts.join(separator) + fractionPart);
     }
+    /**
+     * Converts a date string (Solar/Jalali or Gregorian) to its word representation.
+     *
+     * @param {string} dateStr - The date string in the format 'YYYY/MM/DD' or 'YYYY-MM-DD'.
+     * @param {'jalali' | 'gregorian'} [calendar='jalali'] - The calendar type, either 'jalali' or 'gregorian'.
+     * @returns {string} The word representation of the date.
+     * @throws {Error} Throws an error if the date format is invalid or the month is out of range.
+     */
+    convertDateToWords(dateStr, calendar = "jalali") {
+        // Split the date string by '/' or '-' and validate the format.
+        const parts = dateStr.split(/[-\/]/);
+        if (parts.length !== 3) {
+            throw new Error("Invalid date format. Expected format 'YYYY/MM/DD' or 'YYYY-MM-DD'.");
+        }
+        const [yearStr, monthStr, dayStr] = parts;
+        // Parse month as a number and validate it.
+        const monthNum = parseInt(monthStr, 10);
+        if (isNaN(monthNum) || monthNum < 1 || monthNum > 12) {
+            throw new Error("Invalid month in date.");
+        }
+        // Define month names for Jalali and Gregorian calendars.
+        const jalaliMonths = [
+            "فروردین",
+            "اردیبهشت",
+            "خرداد",
+            "تیر",
+            "مرداد",
+            "شهریور",
+            "مهر",
+            "آبان",
+            "آذر",
+            "دی",
+            "بهمن",
+            "اسفند",
+        ];
+        const gregorianMonths = [
+            "ژانویه",
+            "فوریه",
+            "مارس",
+            "آوریل",
+            "مه",
+            "ژوئن",
+            "ژوئیه",
+            "اوت",
+            "سپتامبر",
+            "اکتبر",
+            "نوامبر",
+            "دسامبر",
+        ];
+        // Get the month name based on the calendar type.
+        const monthName = calendar === "gregorian"
+            ? gregorianMonths[monthNum - 1]
+            : jalaliMonths[monthNum - 1];
+        // Convert the day and year to words using the convert method.
+        const dayWords = this.convert(dayStr);
+        const yearWords = this.convert(yearStr);
+        // Construct and return the final word representation of the date.
+        return `${dayWords} ${monthName} ${yearWords}`;
+    }
+    /**
+     * Converts a digital time string (HH:mm) to its Persian word representation.
+     *
+     * @param {string} timeStr - The time string in "HH:mm" format.
+     * @returns {string} The word representation of the time.
+     * @throws {Error} Throws an error if the time format is invalid or if time values are out of range.
+     */
+    convertTimeToWords(timeStr) {
+        // Split the time string using colon (":") as the separator.
+        const parts = timeStr.split(":");
+        if (parts.length !== 2) {
+            throw new Error("Invalid time format. Expected format 'HH:mm'.");
+        }
+        const [hourStr, minuteStr] = parts;
+        // Parse hours and minutes.
+        const hour = parseInt(hourStr, 10);
+        const minute = parseInt(minuteStr, 10);
+        if (isNaN(hour) || isNaN(minute)) {
+            throw new Error("Invalid time format. Hours and minutes should be numbers.");
+        }
+        // Validate hour and minute ranges.
+        if (hour < 0 || hour > 23) {
+            throw new Error("Invalid hour value. Hour should be between 0 and 23.");
+        }
+        if (minute < 0 || minute > 59) {
+            throw new Error("Invalid minute value. Minute should be between 0 and 59.");
+        }
+        // Retrieve the custom time prefix from configuration or use the default "ساعت".
+        const timePrefix = this.config.customTimePrefix ?? "ساعت";
+        // Convert the hour and minute values to their word representations.
+        const hourWords = this.convert(hour);
+        const minuteWords = this.convert(minute);
+        // Construct the final time string in words.
+        // If minutes are zero, return only the hour part.
+        if (minute === 0) {
+            return `${timePrefix} ${hourWords}`;
+        }
+        else {
+            return `${timePrefix} ${hourWords} و ${minuteWords} دقیقه`;
+        }
+    }
     /**
      * Returns the default separator from the configuration or default constant.
      *
diff --git a/dist/harfizer.test.js b/dist/harfizer.test.js
@@ -92,4 +92,49 @@ describe("HarfizerConverter", () => {
         // Expect custom zero word "zero"
         expect(zeroResult).toBe("zero");
     });
+    describe("Date conversion", () => {
+        test("Convert Jalali date to words using slash format (1404/03/24)", () => {
+            const result = converter.convertDateToWords("1404/03/24");
+            // Expected output: "بیست و چهار خرداد یک هزار و چهارصد و چهار"
+            expect(result).toBe("بیست و چهار خرداد یک هزار و چهارصد و چهار");
+        });
+        test("Convert Jalali date to words using dash format (1404-03-24)", () => {
+            const result = converter.convertDateToWords("1404-03-24");
+            // Expected output: "بیست و چهار خرداد یک هزار و چهارصد و چهار"
+            expect(result).toBe("بیست و چهار خرداد یک هزار و چهارصد و چهار");
+        });
+        test("Convert Gregorian date to words (2023-04-05)", () => {
+            const result = converter.convertDateToWords("2023-04-05", "gregorian");
+            // For day "05" -> "پنج" and month "04" -> "آوریل", year "2023" -> "دو هزار و بیست و سه"
+            // Expected output: "پنج آوریل دو هزار و بیست و سه"
+            expect(result).toBe("پنج آوریل دو هزار و بیست و سه");
+        });
+    });
+    describe("convertTimeToWords", () => {
+        let converter;
+        beforeEach(() => {
+            converter = new harfizer_1.HarfizerConverter();
+        });
+        test("should convert time '09:05' with default prefix", () => {
+            const result = converter.convertTimeToWords("09:05");
+            // Expected conversion: "ساعت نه و پنج دقیقه"
+            expect(result).toBe("ساعت نه و پنج دقیقه");
+        });
+        test("should convert time '18:00' with default prefix", () => {
+            const result = converter.convertTimeToWords("18:00");
+            // Expected conversion: "ساعت هجده"
+            expect(result).toBe("ساعت هجده");
+        });
+        test("should convert time with custom time prefix", () => {
+            const customConverter = new harfizer_1.HarfizerConverter({
+                customTimePrefix: "زمان",
+            });
+            const result = customConverter.convertTimeToWords("09:05");
+            // Expected conversion with custom prefix: "زمان نه و پنج دقیقه"
+            expect(result).toBe("زمان نه و پنج دقیقه");
+        });
+        test("should throw error for invalid time format", () => {
+            expect(() => converter.convertTimeToWords("9-05")).toThrow("Invalid time format. Expected format 'HH:mm'.");
+        });
+    });
 });
