@hebcal/rest-api 5.1.0 → 5.1.1

package/dist/index.mjs

@@ -1,4 +1,4 @@
-/*! @hebcal/rest-api v5.1.0 */
+/*! @hebcal/rest-api v5.1.1 */
 import { flags, HDate, HebrewCalendar, Zmanim, Locale as Locale$1, gematriya } from '@hebcal/core';
 import { getLeyningForParshaHaShavua, getLeyningForHoliday, formatAliyahWithBook } from '@hebcal/leyning';
 import { getTriennialForParshaHaShavua } from '@hebcal/triennial';
@@ -41,107 +41,106 @@ function yearFromFixed(abs) {
 const ABS_14SEP1752 = 639797;
 const ABS_2SEP1752 = 639785;
 */
+/*
+ * Formerly in namespace, now top-level
+ */
+/**
+ * Returns true if the Gregorian year is a leap year
+ * @param year Gregorian year
+ */
+function isGregLeapYear(year) {
+    return !(year % 4) && (!!(year % 100) || !(year % 400));
+}
+/**
+ * Number of days in the Gregorian month for given year
+ * @param month Gregorian month (1=January, 12=December)
+ * @param year Gregorian year
+ */
+function daysInGregMonth(month, year) {
+    // 1 based months
+    return monthLengths[+isGregLeapYear(year)][month];
+}
+/**
+ * Returns true if the object is a Javascript Date
+ */
+function isDate(obj) {
+    // eslint-disable-next-line no-prototype-builtins
+    return typeof obj === 'object' && Date.prototype.isPrototypeOf(obj);
+}
+/**
+ * @private
+ * @param year
+ * @param month (1-12)
+ * @param day (1-31)
+ */
+function toFixed(year, month, day) {
+    const py = year - 1;
+    return (365 * py +
+        quotient(py, 4) -
+        quotient(py, 100) +
+        quotient(py, 400) +
+        quotient(367 * month - 362, 12) +
+        (month <= 2 ? 0 : isGregLeapYear(year) ? -1 : -2) +
+        day);
+}
 /**
- * Gregorian date helper functions.
+ * Converts Gregorian date to absolute R.D. (Rata Die) days
+ * @param date Gregorian date
+ */
+function greg2abs(date) {
+    if (!isDate(date)) {
+        throw new TypeError(`Argument not a Date: ${date}`);
+    }
+    const abs = toFixed(date.getFullYear(), date.getMonth() + 1, date.getDate());
+    /*
+      if (abs < ABS_14SEP1752 && abs > ABS_2SEP1752) {
+        throw new RangeError(`Invalid Date: ${date}`);
+      }
+      */
+    return abs;
+}
+/**
+ * Converts from Rata Die (R.D. number) to Gregorian date.
+ * See the footnote on page 384 of ``Calendrical Calculations, Part II:
+ * Three Historical Calendars'' by E. M. Reingold,  N. Dershowitz, and S. M.
+ * Clamen, Software--Practice and Experience, Volume 23, Number 4
+ * (April, 1993), pages 383-404 for an explanation.
+ * @param abs - R.D. number of days
+ */
+function abs2greg(abs) {
+    if (typeof abs !== 'number') {
+        throw new TypeError(`Argument not a Number: ${abs}`);
+    }
+    abs = Math.trunc(abs);
+    /*
+      if (abs < ABS_14SEP1752 && abs > ABS_2SEP1752) {
+        throw new RangeError(`Invalid Date: ${abs}`);
+      }
+      */
+    const year = yearFromFixed(abs);
+    const priorDays = abs - toFixed(year, 1, 1);
+    const correction = abs < toFixed(year, 3, 1) ? 0 : isGregLeapYear(year) ? 1 : 2;
+    const month = quotient(12 * (priorDays + correction) + 373, 367);
+    const day = abs - toFixed(year, month, 1) + 1;
+    const dt = new Date(year, month - 1, day);
+    if (year < 100 && year >= 0) {
+        dt.setFullYear(year);
+    }
+    return dt;
+}
+
+/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-namespace */
+/**
+ * Gregorian date helper functions
  */
 var greg;
 (function (greg) {
-    /**
-     * Returns true if the Gregorian year is a leap year
-     * @param {number} year Gregorian year
-     * @return {boolean}
-     */
-    function isLeapYear(year) {
-        return !(year % 4) && (!!(year % 100) || !(year % 400));
-    }
-    greg.isLeapYear = isLeapYear;
-    /**
-     * Number of days in the Gregorian month for given year
-     * @param {number} month Gregorian month (1=January, 12=December)
-     * @param {number} year Gregorian year
-     * @return {number}
-     */
-    function daysInMonth(month, year) {
-        // 1 based months
-        return monthLengths[+isLeapYear(year)][month];
-    }
-    greg.daysInMonth = daysInMonth;
-    /**
-     * Returns true if the object is a Javascript Date
-     * @param {Object} obj
-     * @return {boolean}
-     */
-    function isDate(obj) {
-        // eslint-disable-next-line no-prototype-builtins
-        return typeof obj === 'object' && Date.prototype.isPrototypeOf(obj);
-    }
-    greg.isDate = isDate;
-    /**
-     * @private
-     * @param year
-     * @param month (1-12)
-     * @param day (1-31)
-     */
-    function toFixed(year, month, day) {
-        const py = year - 1;
-        return (365 * py +
-            quotient(py, 4) -
-            quotient(py, 100) +
-            quotient(py, 400) +
-            quotient(367 * month - 362, 12) +
-            (month <= 2 ? 0 : isLeapYear(year) ? -1 : -2) +
-            day);
-    }
-    /**
-     * Converts Gregorian date to absolute R.D. (Rata Die) days
-     * @param {Date} date Gregorian date
-     * @return {number}
-     */
-    function greg2abs(date) {
-        if (!isDate(date)) {
-            throw new TypeError(`Argument not a Date: ${date}`);
-        }
-        const abs = toFixed(date.getFullYear(), date.getMonth() + 1, date.getDate());
-        /*
-        if (abs < ABS_14SEP1752 && abs > ABS_2SEP1752) {
-          throw new RangeError(`Invalid Date: ${date}`);
-        }
-        */
-        return abs;
-    }
-    greg.greg2abs = greg2abs;
-    /**
-     * Converts from Rata Die (R.D. number) to Gregorian date.
-     * See the footnote on page 384 of ``Calendrical Calculations, Part II:
-     * Three Historical Calendars'' by E. M. Reingold,  N. Dershowitz, and S. M.
-     * Clamen, Software--Practice and Experience, Volume 23, Number 4
-     * (April, 1993), pages 383-404 for an explanation.
-     * @param {number} abs - R.D. number of days
-     * @return {Date}
-     */
-    function abs2greg(abs) {
-        if (typeof abs !== 'number') {
-            throw new TypeError(`Argument not a Number: ${abs}`);
-        }
-        abs = Math.trunc(abs);
-        /*
-        if (abs < ABS_14SEP1752 && abs > ABS_2SEP1752) {
-          throw new RangeError(`Invalid Date: ${abs}`);
-        }
-        */
-        const year = yearFromFixed(abs);
-        const priorDays = abs - toFixed(year, 1, 1);
-        const correction = abs < toFixed(year, 3, 1) ? 0 : isLeapYear(year) ? 1 : 2;
-        const month = quotient(12 * (priorDays + correction) + 373, 367);
-        const day = abs - toFixed(year, month, 1) + 1;
-        const dt = new Date(year, month - 1, day);
-        if (year < 100 && year >= 0) {
-            dt.setFullYear(year);
-        }
-        return dt;
-    }
-    greg.abs2greg = abs2greg;
 })(greg || (greg = {}));
+greg.abs2greg = abs2greg;
+greg.daysInMonth = daysInGregMonth;
+greg.greg2abs = greg2abs;
+greg.isDate = isDate;
+greg.isLeapYear = isGregLeapYear;
 
 const alefbet = {
     א: 1,
@@ -179,8 +178,6 @@ for (const [key, val] of Object.entries(alefbet)) {
  * Similar to `string.padStart(4, '0')` but will also format
  * negative numbers similar to how the JavaScript date formats
  * negative year numbers (e.g. `-37` is formatted as `-000037`).
- * @param {number} number
- * @return {string}
  */
 function pad4(number) {
     if (number < 0) {
@@ -200,8 +197,6 @@ function pad4(number) {
 /**
  * Formats a number with leading zeros so the resulting string is 2 digits long.
  * Similar to `string.padStart(2, '0')`.
- * @param {number} number
- * @return {string}
  */
 function pad2(number) {
     if (number < 10) {
@@ -211,9 +206,6 @@ function pad2(number) {
 }
 /**
  * Returns YYYY-MM-DD in the local timezone
- * @private
- * @param {Date} dt
- * @return {string}
  */
 function isoDateString(dt) {
     return (pad4(dt.getFullYear()) +
@@ -232,9 +224,9 @@ const noopLocale = {
     contexts: { '': {} },
 };
 const alias = {
-    'h': 'he',
-    'a': 'ashkenazi',
-    's': 'en',
+    h: 'he',
+    a: 'ashkenazi',
+    s: 'en',
     '': 'en',
 };
 /** @private */
@@ -255,12 +247,12 @@ class Locale {
     /**
      * Returns translation only if `locale` offers a non-empty translation for `id`.
      * Otherwise, returns `undefined`.
-     * @param {string} id Message ID to translate
-     * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
-     * @return {string}
+     * @param id Message ID to translate
+     * @param [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
      */
     static lookupTranslation(id, locale) {
-        const loc = (typeof locale === 'string' && locales.get(locale.toLowerCase())) || activeLocale;
+        const loc = (typeof locale === 'string' && locales.get(locale.toLowerCase())) ||
+            activeLocale;
         const array = loc[id];
         if ((array === null || array === void 0 ? void 0 : array.length) && array[0].length) {
             return array[0];
@@ -269,9 +261,8 @@ class Locale {
     }
     /**
      * By default, if no translation was found, returns `id`.
-     * @param {string} id Message ID to translate
-     * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
-     * @return {string}
+     * @param id Message ID to translate
+     * @param [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
      */
     static gettext(id, locale) {
         const text = this.lookupTranslation(id, locale);
@@ -282,23 +273,24 @@ class Locale {
     }
     /**
      * Register locale translations.
-     * @param {string} locale Locale name (i.e.: `'he'`, `'fr'`)
-     * @param {LocaleData} data parsed data from a `.po` file.
+     * @param locale Locale name (i.e.: `'he'`, `'fr'`)
+     * @param data parsed data from a `.po` file.
      */
     static addLocale(locale, data) {
         if (typeof locale !== 'string') {
             throw new TypeError(`Invalid locale name: ${locale}`);
         }
-        if (typeof data.contexts !== 'object' || typeof data.contexts[''] !== 'object') {
+        if (typeof data.contexts !== 'object' ||
+            typeof data.contexts[''] !== 'object') {
             throw new TypeError(`Locale '${locale}' invalid compact format`);
         }
         locales.set(locale.toLowerCase(), data.contexts['']);
     }
     /**
      * Adds a translation to `locale`, replacing any previous translation.
-     * @param {string} locale Locale name (i.e: `'he'`, `'fr'`).
-     * @param {string} id Message ID to translate
-     * @param {string | string[]} translation Translation text
+     * @param locale Locale name (i.e: `'he'`, `'fr'`).
+     * @param id Message ID to translate
+     * @param translation Translation text
      */
     static addTranslation(locale, id, translation) {
         if (typeof locale !== 'string') {
@@ -325,8 +317,8 @@ class Locale {
     }
     /**
      * Adds multiple translations to `locale`, replacing any previous translations.
-     * @param {string} locale Locale name (i.e: `'he'`, `'fr'`).
-     * @param {LocaleData} data parsed data from a `.po` file.
+     * @param locale Locale name (i.e: `'he'`, `'fr'`).
+     * @param data parsed data from a `.po` file.
      */
     static addTranslations(locale, data) {
         if (typeof locale !== 'string') {
@@ -336,7 +328,8 @@ class Locale {
         if (!loc) {
             throw new TypeError(`Unknown locale: ${locale}`);
         }
-        if (typeof data.contexts !== 'object' || typeof data.contexts[''] !== 'object') {
+        if (typeof data.contexts !== 'object' ||
+            typeof data.contexts[''] !== 'object') {
             throw new TypeError(`Locale '${locale}' invalid compact format`);
         }
         const ctx = data.contexts[''];
@@ -346,7 +339,7 @@ class Locale {
      * Activates a locale. Throws an error if the locale has not been previously added.
      * After setting the locale to be used, all strings marked for translations
      * will be represented by the corresponding translation in the specified locale.
-     * @param {string} locale Locale name (i.e: `'he'`, `'fr'`)
+     * @param locale Locale name (i.e: `'he'`, `'fr'`)
      */
     static useLocale(locale) {
         const locale0 = locale.toLowerCase();
@@ -360,23 +353,20 @@ class Locale {
     }
     /**
      * Returns the name of the active locale (i.e. 'he', 'ashkenazi', 'fr')
-     * @return {string}
      */
     static getLocaleName() {
         return activeName;
     }
     /**
      * Returns the names of registered locales
-     * @return {string[]}
      */
     static getLocaleNames() {
         const keys = Array.from(locales.keys());
         return keys.sort((a, b) => a.localeCompare(b));
     }
     /**
-     * @param {number} n
-     * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
-     * @return {string}
+     * Renders a number in ordinal, such as 1st, 2nd or 3rd
+     * @param [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
      */
     static ordinal(n, locale) {
         const locale1 = locale === null || locale === void 0 ? void 0 : locale.toLowerCase();
@@ -403,11 +393,6 @@ class Locale {
                 return n + '.';
         }
     }
-    /**
-     * @private
-     * @param {number} n
-     * @return {string}
-     */
     static getEnOrdinal(n) {
         const s = ['th', 'st', 'nd', 'rd'];
         const v = n % 100;
@@ -415,8 +400,6 @@ class Locale {
     }
     /**
      * Removes nekudot from Hebrew string
-     * @param {string} str
-     * @return {string}
      */
     static hebrewStripNikkud(str) {
         return str.replace(/[\u0590-\u05bd]/g, '').replace(/[\u05bf-\u05c7]/g, '');
@@ -1142,9 +1125,9 @@ function eventToClassicApiObject(ev, options, leyning = true) {
             if (reading) {
                 result.leyning = formatLeyningResult(reading);
                 const hyear = hd.getFullYear();
-                if (isParsha && !il && hyear >= 5745) {
-                    const triReading = getTriennialForParshaHaShavua(ev);
-                    if (triReading) {
+                if (isParsha && hyear >= 5745) {
+                    const triReading = getTriennialForParshaHaShavua(ev, il);
+                    if (triReading === null || triReading === void 0 ? void 0 : triReading.aliyot) {
                         result.leyning.triennial = formatAliyot({}, triReading.aliyot);
                     }
                 }
@@ -1217,6 +1200,18 @@ function formatAliyot(result, aliyot) {
     }
     return result;
 }
+function formatReasons(result, reason) {
+    for (const num of ['7', '8', 'M']) {
+        if (reason[num]) {
+            const k = num == 'M' ? 'maftir' : num;
+            result[k] += ' | ' + reason[num];
+        }
+    }
+    if (reason.haftara) {
+        result.haftarah += ' | ' + reason.haftara;
+    }
+    return result;
+}
 function formatLeyningResult(reading) {
     const result = {};
     if (reading.summary) {
@@ -1232,15 +1227,7 @@ function formatLeyningResult(reading) {
         formatAliyot(result, reading.fullkriyah);
     }
     if (reading.reason) {
-        for (const num of ['7', '8', 'M']) {
-            if (reading.reason[num]) {
-                const k = num == 'M' ? 'maftir' : num;
-                result[k] += ' | ' + reading.reason[num];
-            }
-        }
-        if (reading.reason.haftara) {
-            result.haftarah += ' | ' + reading.reason.haftara;
-        }
+        formatReasons(result, reading.reason);
     }
     return result;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/rest-api",
-  "version": "5.1.0",
+  "version": "5.1.1",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal"
@@ -29,9 +29,9 @@
     "url": "https://github.com/hebcal/hebcal-rest-api/issues"
   },
   "dependencies": {
-    "@hebcal/core": "^5.4.5",
-    "@hebcal/leyning": "^8.1.9",
-    "@hebcal/triennial": "^5.0.5"
+    "@hebcal/core": "^5.4.9",
+    "@hebcal/leyning": "^8.2.2",
+    "@hebcal/triennial": "^5.1.1"
   },
   "scripts": {
     "build:rollup": "rollup -c",
@@ -39,14 +39,14 @@
     "build": "npm run build:json2js && npm run build:rollup",
     "prepublish": "npm run build",
     "pretest": "npm run build",
-    "readme": "npx jsdoc2md dist/index.js",
+    "docs": "typedoc",
     "test": "jest"
   },
   "license": "BSD-2-Clause",
   "devDependencies": {
     "@babel/preset-env": "^7.24.7",
     "@babel/preset-typescript": "^7.24.7",
-    "@hebcal/learning": "^5.0.8",
+    "@hebcal/learning": "^5.1.1",
     "@rollup/plugin-commonjs": "^26.0.1",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
@@ -55,10 +55,9 @@
     "@types/jest": "^29.5.12",
     "gts": "^5.3.1",
     "jest": "^29.7.0",
-    "jsdoc": "^4.0.3",
-    "jsdoc-to-markdown": "^8.0.1",
-    "rollup": "^4.18.0",
-    "ts-jest": "^29.1.5",
+    "rollup": "^4.18.1",
+    "ts-jest": "^29.2.0",
+    "typedoc": "^0.26.3",
     "typescript": "^5.5.3"
   }
 }