@hebcal/rest-api 5.2.0 → 6.0.0

package/dist/index.mjs

@@ -1,431 +1,12 @@
-/*! @hebcal/rest-api v5.2.0 */
-import { parshiot, HDate, flags, HebrewCalendar, version, Zmanim, Locale as Locale$1, gematriya } from '@hebcal/core';
-import { getLeyningForParshaHaShavua, getLeyningForHoliday, formatAliyahWithBook } from '@hebcal/leyning';
+/*! @hebcal/rest-api v6.0.0 */
+import { parshiot, HDate, flags, HebrewCalendar, version, Zmanim, Locale, gematriya } from '@hebcal/core';
+import { isoDateString } from '@hebcal/hdate';
+export { pad2, pad4 } from '@hebcal/hdate';
+import { getLeyningForParshaHaShavua } from '@hebcal/leyning/dist/esm/leyning';
+import { getLeyningForHoliday } from '@hebcal/leyning/dist/esm/getLeyningForHoliday';
+import { formatAliyahWithBook } from '@hebcal/leyning/dist/esm/common';
 import { getTriennialForParshaHaShavua } from '@hebcal/triennial';
 
-/* eslint-disable @typescript-eslint/no-namespace, no-inner-declarations */
-/** @private */
-const lengths = [0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31];
-/** @private */
-const monthLengths = [lengths, lengths.slice()];
-monthLengths[1][2] = 29;
-/**
- * @private
- */
-function mod(x, y) {
-    return x - y * Math.floor(x / y);
-}
-/**
- * @private
- */
-function quotient(x, y) {
-    return Math.floor(x / y);
-}
-/**
- * @private
- * @param abs - R.D. number of days
- */
-function yearFromFixed(abs) {
-    const l0 = abs - 1;
-    const n400 = quotient(l0, 146097);
-    const d1 = mod(l0, 146097);
-    const n100 = quotient(d1, 36524);
-    const d2 = mod(d1, 36524);
-    const n4 = quotient(d2, 1461);
-    const d3 = mod(d2, 1461);
-    const n1 = quotient(d3, 365);
-    const year = 400 * n400 + 100 * n100 + 4 * n4 + n1;
-    return n100 !== 4 && n1 !== 4 ? year + 1 : year;
-}
-/*
-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);
-}
-/**
- * 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) {
-})(greg || (greg = {}));
-greg.abs2greg = abs2greg;
-greg.daysInMonth = daysInGregMonth;
-greg.greg2abs = greg2abs;
-greg.isDate = isDate;
-greg.isLeapYear = isGregLeapYear;
-
-const alefbet = {
-    א: 1,
-    ב: 2,
-    ג: 3,
-    ד: 4,
-    ה: 5,
-    ו: 6,
-    ז: 7,
-    ח: 8,
-    ט: 9,
-    י: 10,
-    כ: 20,
-    ל: 30,
-    מ: 40,
-    נ: 50,
-    ס: 60,
-    ע: 70,
-    פ: 80,
-    צ: 90,
-    ק: 100,
-    ר: 200,
-    ש: 300,
-    ת: 400,
-};
-const heb2num = new Map();
-const num2heb = new Map();
-for (const [key, val] of Object.entries(alefbet)) {
-    heb2num.set(key, val);
-    num2heb.set(val, key);
-}
-
-/**
- * Formats a number with leading zeros so the resulting string is 4 digits long.
- * 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`).
- */
-function pad4(num) {
-    if (num < 0) {
-        return '-00' + pad4(-num);
-    }
-    else if (num < 10) {
-        return '000' + num;
-    }
-    else if (num < 100) {
-        return '00' + num;
-    }
-    else if (num < 1000) {
-        return '0' + num;
-    }
-    return String(num);
-}
-/**
- * Formats a number with leading zeros so the resulting string is 2 digits long.
- * Similar to `string.padStart(2, '0')`.
- */
-function pad2(num) {
-    if (num >= 0 && num < 10) {
-        return '0' + num;
-    }
-    return String(num);
-}
-
-/**
- * Returns YYYY-MM-DD in the local timezone
- */
-function isoDateString(dt) {
-    return (pad4(dt.getFullYear()) +
-        '-' +
-        pad2(dt.getMonth() + 1) +
-        '-' +
-        pad2(dt.getDate()));
-}
-
-var poAshkenazi = { "headers": { "plural-forms": "nplurals=2; plural=(n > 1);" }, "contexts": { "": { "Tevet": ["Teves"] } } };
-
-var poHe = { "headers": { "plural-forms": "nplurals=2; plural=(n > 1);" }, "contexts": { "": { "Adar": ["אַדָר"], "Adar I": ["אַדָר א׳"], "Adar II": ["אַדָר ב׳"], "Av": ["אָב"], "Cheshvan": ["חֶשְׁוָן"], "Elul": ["אֱלוּל"], "Iyyar": ["אִיָיר"], "Kislev": ["כִּסְלֵו"], "Nisan": ["נִיסָן"], "Sh'vat": ["שְׁבָט"], "Sivan": ["סִיוָן"], "Tamuz": ["תַּמּוּז"], "Tevet": ["טֵבֵת"], "Tishrei": ["תִּשְׁרֵי"] } } };
-
-const noopLocale = {
-    headers: { 'plural-forms': 'nplurals=2; plural=(n!=1);' },
-    contexts: { '': {} },
-};
-const alias = {
-    h: 'he',
-    a: 'ashkenazi',
-    s: 'en',
-    '': 'en',
-};
-/** @private */
-const locales = new Map();
-/** @private */
-let activeLocale;
-/** @private */
-let activeName;
-/** @private */
-function getEnOrdinal(n) {
-    const s = ['th', 'st', 'nd', 'rd'];
-    const v = n % 100;
-    return n + (s[(v - 20) % 10] || s[v] || s[0]);
-}
-/** @private */
-function checkLocale(locale) {
-    if (typeof locale !== 'string') {
-        throw new TypeError(`Invalid locale name: ${locale}`);
-    }
-    return locale.toLowerCase();
-}
-/** @private */
-function getExistingLocale(locale) {
-    const locale1 = checkLocale(locale);
-    const loc = locales.get(locale1);
-    if (!loc) {
-        throw new RangeError(`Locale '${locale}' not found`);
-    }
-    return loc;
-}
-/**
- * A locale in Hebcal is used for translations/transliterations of
- * holidays. `@hebcal/hdate` supports four locales by default
- * * `en` - default, Sephardic transliterations (e.g. "Shabbat")
- * * `ashkenazi` - Ashkenazi transliterations (e.g. "Shabbos")
- * * `he` - Hebrew (e.g. "שַׁבָּת")
- * * `he-x-NoNikud` - Hebrew without nikud (e.g. "שבת")
- */
-class Locale {
-    /**
-     * Returns translation only if `locale` offers a non-empty translation for `id`.
-     * Otherwise, returns `undefined`.
-     * @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 array = loc[id];
-        if ((array === null || array === void 0 ? void 0 : array.length) && array[0].length) {
-            return array[0];
-        }
-        return undefined;
-    }
-    /**
-     * By default, if no translation was found, returns `id`.
-     * @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);
-        if (typeof text === 'undefined') {
-            return id;
-        }
-        return text;
-    }
-    /**
-     * Register locale translations.
-     * @param locale Locale name (i.e.: `'he'`, `'fr'`)
-     * @param data parsed data from a `.po` file.
-     */
-    static addLocale(locale, data) {
-        locale = checkLocale(locale);
-        if (typeof data.contexts !== 'object' ||
-            typeof data.contexts[''] !== 'object') {
-            throw new TypeError(`Locale '${locale}' invalid compact format`);
-        }
-        locales.set(locale, data.contexts['']);
-    }
-    /**
-     * Adds a translation to `locale`, replacing any previous translation.
-     * @param locale Locale name (i.e: `'he'`, `'fr'`).
-     * @param id Message ID to translate
-     * @param translation Translation text
-     */
-    static addTranslation(locale, id, translation) {
-        const loc = getExistingLocale(locale);
-        if (typeof id !== 'string' || id.length === 0) {
-            throw new TypeError(`Invalid id string: ${id}`);
-        }
-        const isArray = Array.isArray(translation);
-        if (isArray) {
-            const t0 = translation[0];
-            if (typeof t0 !== 'string' || t0.length === 0) {
-                throw new TypeError(`Invalid translation array: ${translation}`);
-            }
-        }
-        else if (typeof translation !== 'string') {
-            throw new TypeError(`Invalid translation string: ${translation}`);
-        }
-        loc[id] = isArray ? translation : [translation];
-    }
-    /**
-     * Adds multiple translations to `locale`, replacing any previous translations.
-     * @param locale Locale name (i.e: `'he'`, `'fr'`).
-     * @param data parsed data from a `.po` file.
-     */
-    static addTranslations(locale, data) {
-        const loc = getExistingLocale(locale);
-        if (typeof data.contexts !== 'object' ||
-            typeof data.contexts[''] !== 'object') {
-            throw new TypeError(`Locale '${locale}' invalid compact format`);
-        }
-        const ctx = data.contexts[''];
-        Object.assign(loc, ctx);
-    }
-    /**
-     * 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 locale Locale name (i.e: `'he'`, `'fr'`)
-     */
-    static useLocale(locale) {
-        const locale0 = checkLocale(locale);
-        const obj = getExistingLocale(locale0);
-        activeName = alias[locale0] || locale0;
-        activeLocale = obj;
-        return activeLocale;
-    }
-    /**
-     * Returns the name of the active locale (i.e. 'he', 'ashkenazi', 'fr')
-     */
-    static getLocaleName() {
-        return activeName;
-    }
-    /**
-     * Returns the names of registered locales
-     */
-    static getLocaleNames() {
-        const keys = Array.from(locales.keys());
-        return keys.sort((a, b) => a.localeCompare(b));
-    }
-    /**
-     * 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();
-        const locale0 = locale1 || activeName;
-        if (!locale0) {
-            return getEnOrdinal(n);
-        }
-        switch (locale0) {
-            case 'en':
-            case 's':
-            case 'a':
-                return getEnOrdinal(n);
-            case 'es':
-                return n + 'º';
-            case 'h':
-            case 'he':
-            case 'he-x-nonikud':
-                return String(n);
-        }
-        if (locale0.startsWith('ashkenazi')) {
-            return getEnOrdinal(n);
-        }
-        return n + '.';
-    }
-    /**
-     * Removes nekudot from Hebrew string
-     */
-    static hebrewStripNikkud(str) {
-        return str.replace(/[\u0590-\u05bd]/g, '').replace(/[\u05bf-\u05c7]/g, '');
-    }
-}
-Locale.addLocale('en', noopLocale);
-Locale.addLocale('s', noopLocale);
-Locale.addLocale('', noopLocale);
-Locale.useLocale('en');
-/* Ashkenazic transliterations */
-Locale.addLocale('ashkenazi', poAshkenazi);
-Locale.addLocale('a', poAshkenazi);
-/* Hebrew with nikkud */
-Locale.addLocale('he', poHe);
-Locale.addLocale('h', poHe);
-/* Hebrew without nikkud */
-const heStrs = poHe.contexts[''];
-const heNoNikud = {};
-for (const [key, val] of Object.entries(heStrs)) {
-    heNoNikud[key] = [Locale.hebrewStripNikkud(val[0])];
-}
-const poHeNoNikud = {
-    headers: poHe.headers,
-    contexts: { '': heNoNikud },
-};
-Locale.addLocale('he-x-NoNikud', poHeNoNikud);
-
 var countryNames0 = {
     "AD": "Andorra",
     "AE": "United Arab Emirates",
@@ -1229,7 +810,7 @@ function eventToClassicApiObject(ev, options, leyning = true) {
     }
     const hebrew = ev.renderBrief('he');
     if (hebrew) {
-        result.hebrew = Locale$1.hebrewStripNikkud(hebrew);
+        result.hebrew = Locale.hebrewStripNikkud(hebrew);
     }
     if (!candles) {
         if (leyning) {
@@ -1291,7 +872,7 @@ function eventToClassicApiObject(ev, options, leyning = true) {
         const dd = hd.getDate();
         result.heDateParts = {
             y: gematriya(yy),
-            m: Locale$1.gettext(mm, 'he-x-NoNikud'),
+            m: Locale.gettext(mm, 'he-x-NoNikud'),
             d: gematriya(dd),
         };
     }
@@ -1448,7 +1029,7 @@ function eventToRssItem2(ev, options) {
     if (candles) {
         const colon = subj.indexOf(': ');
         if (colon !== -1) {
-            const options = { location, il, locale: Locale$1.getLocaleName() };
+            const options = { location, il, locale: Locale.getLocaleName() };
             const time = HebrewCalendar.reformatTimeStr(ev.eventTimeStr, 'pm', options);
             subj = subj.substring(0, colon) + ': ' + time;
         }
@@ -1497,7 +1078,7 @@ function eventToFullCalendar(ev, tzid, il) {
     };
     const hebrew = ev.renderBrief('he');
     if (hebrew) {
-        result.hebrew = Locale$1.hebrewStripNikkud(hebrew);
+        result.hebrew = Locale.hebrewStripNikkud(hebrew);
     }
     const url = ev.url();
     if (url) {
@@ -1517,4 +1098,4 @@ function eventToFullCalendar(ev, tzid, il) {
     return result;
 }
 
-export { appendIsraelAndTracking, countryNames, eventToClassicApiObject, eventToCsv, eventToFullCalendar, eventToRssItem2, eventsToClassicApi, eventsToCsv, eventsToRss2, getCalendarTitle, getDownloadFilename, getEventCategories, getHolidayDescription, holidayDescription, locationToPlainObj, makeAnchor, makeMemo, makeTorahMemoText, pad2, pad4, renderTitleWithoutTime, shouldRenderBrief, toISOString };
+export { appendIsraelAndTracking, countryNames, eventToClassicApiObject, eventToCsv, eventToFullCalendar, eventToRssItem2, eventsToClassicApi, eventsToCsv, eventsToRss2, getCalendarTitle, getDownloadFilename, getEventCategories, getHolidayDescription, holidayDescription, locationToPlainObj, makeAnchor, makeMemo, makeTorahMemoText, renderTitleWithoutTime, shouldRenderBrief, toISOString };

package/package.json

@@ -1,20 +1,18 @@
 {
   "name": "@hebcal/rest-api",
-  "version": "5.2.0",
+  "version": "6.0.0",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal"
   ],
   "description": "Jewish holidays and Hebrew calendar as plain JSON objects and CSV export",
   "engines": {
-    "node": ">= 16.0.0"
+    "node": ">= 18.0.0"
   },
-  "main": "dist/index.cjs",
   "module": "dist/index.mjs",
   "type": "module",
   "exports": {
     "import": "./dist/index.mjs",
-    "require": "./dist/index.cjs",
     "types": "./dist/module.d.ts"
   },
   "typings": "dist/module.d.ts",
@@ -29,9 +27,9 @@
     "url": "https://github.com/hebcal/hebcal-rest-api/issues"
   },
   "dependencies": {
-    "@hebcal/core": "^5.5.2",
-    "@hebcal/hdate": "^0.11.5",
-    "@hebcal/leyning": "^8.2.7",
+    "@hebcal/core": "^5.7.7",
+    "@hebcal/hdate": "^0.12.0",
+    "@hebcal/leyning": "^9.0.1",
     "@hebcal/triennial": "^5.1.3"
   },
   "scripts": {
@@ -49,21 +47,20 @@
   },
   "license": "BSD-2-Clause",
   "devDependencies": {
-    "@babel/preset-env": "^7.25.8",
-    "@babel/preset-typescript": "^7.25.7",
-    "@hebcal/learning": "^5.1.1",
+    "@babel/preset-env": "^7.26.0",
+    "@babel/preset-typescript": "^7.26.0",
+    "@hebcal/learning": "^5.1.2",
     "@rollup/plugin-commonjs": "^28.0.1",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.3.0",
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^12.1.1",
-    "@types/jest": "^29.5.13",
+    "@types/jest": "^29.5.14",
     "gts": "^5.3.1",
     "jest": "^29.7.0",
-    "rollup": "^4.24.0",
-    "rollup-plugin-dts": "^6.1.1",
+    "rollup": "^4.24.4",
     "ts-jest": "^29.2.5",
-    "typedoc": "^0.26.10",
+    "typedoc": "^0.26.11",
     "typescript": "^5.6.3"
   }
 }