@hebcal/core 6.0.6 → 6.0.7

package/dist/src/molad.js

@@ -0,0 +1,169 @@
+/* eslint-disable camelcase */
+import { Event, flags } from './event';
+import { HDate, Locale, molad, pad2 } from '@hebcal/hdate';
+import { reformatTimeStr } from './reformatTimeStr';
+import './locale'; // Adds Hebrew and Ashkenazic translations
+const enDoW = [
+    'Sunday',
+    'Monday',
+    'Tuesday',
+    'Wednesday',
+    'Thursday',
+    'Friday',
+    'Saturday',
+];
+const heDayNames = [
+    'רִאשׁוֹן',
+    'שֵׁנִי',
+    'שְׁלִישִׁי',
+    'רְבִיעִי',
+    'חֲמִישִׁי',
+    'שִׁישִּׁי',
+    'שַׁבָּת',
+];
+const frDoW = [
+    'Dimanche',
+    'Lundi',
+    'Mardi',
+    'Mercredi',
+    'Jeudi',
+    'Vendredi',
+    'Samedi',
+];
+const night = 'בַּלַּ֥יְלָה';
+function getDayNames(locale) {
+    if (locale === 'he' || locale === 'he-x-nonikud' || locale === 'h') {
+        return heDayNames;
+    }
+    else if (locale === 'fr') {
+        return frDoW;
+    }
+    return enDoW;
+}
+function getHebrewTimeOfDay(hour) {
+    if (hour < 5)
+        return night;
+    else if (hour < 12)
+        return 'בַּבֹּקֶר';
+    else if (hour < 17)
+        return 'בַּצׇּהֳרַיִים';
+    else if (hour < 21)
+        return 'בָּעֶרֶב';
+    return night;
+}
+/**
+ * Represents a molad, the moment when the new moon is "born"
+ */
+export class Molad {
+    /**
+     * Calculates the molad for a Hebrew month
+     * @param year
+     * @param month
+     */
+    constructor(year, month) {
+        this.m = molad(year, month);
+    }
+    /**
+     */
+    getYear() {
+        return this.m.year;
+    }
+    /**
+     */
+    getMonth() {
+        return this.m.month;
+    }
+    /**
+     */
+    getMonthName() {
+        return HDate.getMonthName(this.m.month, this.m.year);
+    }
+    /**
+     * @returns Day of Week (0=Sunday, 6=Saturday)
+     */
+    getDow() {
+        return this.m.dayOfWeek;
+    }
+    /**
+     * @returns hour of day (0-23)
+     */
+    getHour() {
+        return this.m.hour;
+    }
+    /**
+     * @returns minutes past hour (0-59)
+     */
+    getMinutes() {
+        return this.m.minutes;
+    }
+    /**
+     * @returns parts of a minute (0-17)
+     */
+    getChalakim() {
+        return this.m.chalakim;
+    }
+    /**
+     * @param [locale] Optional locale name (defaults to empty locale)
+     * @param options
+     */
+    render(locale, options) {
+        var _a;
+        locale = locale !== null && locale !== void 0 ? locale : 'en';
+        if (typeof locale === 'string') {
+            locale = locale.toLowerCase();
+        }
+        const isHebrewLocale = locale === 'he' || locale === 'he-x-nonikud' || locale === 'h';
+        const monthName = Locale.gettext(this.getMonthName(), locale);
+        const dayNames = getDayNames(locale);
+        const dow = dayNames[this.getDow()];
+        const minutes = this.getMinutes();
+        const hour = this.getHour();
+        const chalakim = this.getChalakim();
+        const moladStr = Locale.gettext('Molad', locale);
+        const minutesStr = (_a = Locale.lookupTranslation('min', locale)) !== null && _a !== void 0 ? _a : 'minutes';
+        const chalakimStr = Locale.gettext('chalakim', locale);
+        const and = Locale.gettext('and', locale);
+        if (isHebrewLocale) {
+            const ampm = getHebrewTimeOfDay(hour);
+            let result = `${moladStr} ${monthName} יִהְיֶה בַּיּוֹם ${dow} בשָׁבוּעַ, ` +
+                `בְּשָׁעָה ${hour} ${ampm}, ` +
+                `ו-${minutes} ${minutesStr}`;
+            if (chalakim !== 0) {
+                result += ` ו-${chalakim} ${chalakimStr}`;
+            }
+            if (locale === 'he-x-nonikud') {
+                return Locale.hebrewStripNikkud(result);
+            }
+            return result;
+        }
+        const fmtTime = reformatTimeStr(`${hour}:${pad2(minutes)}`, 'pm', options);
+        const month = monthName.replace(/'/g, '’');
+        const result = `${moladStr} ${month}: ${dow}, ${fmtTime}`;
+        if (chalakim === 0) {
+            return result;
+        }
+        return result + ` ${and} ${chalakim} ${chalakimStr}`;
+    }
+}
+/** Represents a Molad announcement on Shabbat Mevarchim */
+export class MoladEvent extends Event {
+    /**
+     * @param date Hebrew date event occurs
+     * @param hyear molad year
+     * @param hmonth molad month
+     * @param options
+     */
+    constructor(date, hyear, hmonth, options) {
+        const m = new Molad(hyear, hmonth);
+        const monthName = m.getMonthName();
+        super(date, `Molad ${monthName} ${hyear}`, flags.MOLAD);
+        this.molad = m;
+        this.options = options;
+    }
+    /**
+     * @param [locale] Optional locale name (defaults to empty locale)
+     */
+    render(locale) {
+        return this.molad.render(locale, this.options);
+    }
+}

package/dist/src/omer.d.ts

@@ -0,0 +1,53 @@
+import { HDate } from '@hebcal/hdate';
+import { Event } from './event';
+import './locale';
+/**
+ * Language for counting the Omer can be English or Hebrew.
+ * Lang for the Sefira can be English, Hebrew, or Hebrew in Sephardic transliteration.
+ */
+export type OmerLang = 'en' | 'he' | 'translit';
+/** Represents a day 1-49 of counting the Omer from Pesach to Shavuot */
+export declare class OmerEvent extends Event {
+    private readonly weekNumber;
+    private readonly daysWithinWeeks;
+    readonly omer: number;
+    emoji?: string;
+    /**
+     * @param date
+     * @param omerDay
+     */
+    constructor(date: HDate, omerDay: number);
+    /**
+     * Returns the sefira. For example, on day 8:
+     *  * חֶֽסֶד שֶׁבִּגְבוּרָה
+     *  * Chesed shebiGevurah
+     *  * Lovingkindness within Might
+     * @param lang `en` (English), `he` (Hebrew with nikud), or `translit` (Hebrew in Sephardic transliteration)
+     * @returns a string such as `Lovingkindness within Might` or `חֶֽסֶד שֶׁבִּגְבוּרָה`
+     */
+    sefira(lang?: OmerLang): string;
+    /**
+     * @param [locale] Optional locale name (defaults to empty locale)
+     */
+    render(locale?: string): string;
+    /**
+     * Returns translation of "Omer day 22" without ordinal numbers.
+     * @param [locale] Optional locale name (defaults to empty locale)
+     */
+    renderBrief(locale?: string): string;
+    /**
+     * Returns an emoji number symbol with a circle, for example `㊲`
+     *  from the “Enclosed CJK Letters and Months” block of the Unicode standard
+     * @returns a single Unicode character from `①` through `㊾`
+     */
+    getEmoji(): string;
+    getWeeks(): number;
+    getDaysWithinWeeks(): number;
+    /**
+     * Returns a sentence with that evening's omer count
+     * @returns a string such as `Today is 10 days, which is 1 week and 3 days of the Omer`
+     *  or `הַיוֹם עֲשָׂרָה יָמִים, שְׁהֵם שָׁבוּעַ אֶחָד וְשְׁלוֹשָׁה יָמִים לָעוֹמֶר`
+     */
+    getTodayIs(locale: string): string;
+    url(): string | undefined;
+}

package/dist/src/omer.js

@@ -0,0 +1,302 @@
+import { Locale, gematriya } from '@hebcal/hdate';
+import { Event, flags } from './event';
+import './locale'; // Adds Hebrew and Ashkenazic translations
+const sefirot = {
+    en: {
+        infix: 'within ',
+        infix26: 'within ',
+        words: [
+            '',
+            'Lovingkindness',
+            'Might',
+            'Beauty',
+            'Eternity',
+            'Splendor',
+            'Foundation',
+            'Majesty',
+        ],
+        pfxWords: null,
+    },
+    he: {
+        infix: null,
+        infix26: null,
+        words: [
+            '',
+            'חֶֽסֶד',
+            'גְּבוּרָה',
+            'תִּפְאֶֽרֶת',
+            'נֶּֽצַח',
+            'הוֹד',
+            'יְּסוֹד',
+            'מַלְכוּת',
+        ],
+        pfxWords: [
+            '',
+            'שֶׁבְּחֶֽסֶד',
+            'שֶׁבִּגְבוּרָה',
+            'שֶׁבְּתִפְאֶֽרֶת',
+            'שֶׁבְּנֶֽצַח',
+            'שֶׁבְּהוֹד',
+            'שֶׁבִּיְסוֹד',
+            'שֶׁבְּמַלְכוּת',
+        ],
+    },
+    translit: {
+        infix: "sheb'",
+        infix26: 'shebi',
+        words: [
+            '',
+            'Chesed',
+            'Gevurah',
+            'Tiferet',
+            'Netzach',
+            'Hod',
+            'Yesod',
+            'Malkhut',
+        ],
+        pfxWords: null,
+    },
+};
+function checkDay(omerDay) {
+    if (omerDay < 1 || omerDay > 49) {
+        throw new RangeError(`Invalid Omer day ${omerDay}`);
+    }
+}
+function getWeeks(omerDay) {
+    const weekNum = Math.floor((omerDay - 1) / 7) + 1;
+    const daysWithinWeeks = omerDay % 7 || 7;
+    return [weekNum, daysWithinWeeks];
+}
+function omerTodayIsEn(omerDay) {
+    const [weekNumber, daysWithinWeeks] = getWeeks(omerDay);
+    const totalDaysStr = omerDay === 1 ? 'day' : 'days';
+    let str = `Today is ${omerDay} ${totalDaysStr}`;
+    if (weekNumber > 1 || omerDay === 7) {
+        const day7 = daysWithinWeeks === 7;
+        const numWeeks = day7 ? weekNumber : weekNumber - 1;
+        const weeksStr = numWeeks === 1 ? 'week' : 'weeks';
+        str += `, which is ${numWeeks} ${weeksStr}`;
+        if (!day7) {
+            const daysStr = daysWithinWeeks === 1 ? 'day' : 'days';
+            str += ` and ${daysWithinWeeks} ${daysStr}`;
+        }
+    }
+    return str + ' of the Omer';
+}
+// adapted from pip hdate package (GPL)
+// https://github.com/py-libhdate/py-libhdate/blob/master/hdate/date.py
+const tens = ['', 'עֲשָׂרָה', 'עֶשְׂרִים', 'שְׁלוֹשִׁים', 'אַרְבָּעִים'];
+const ones = [
+    '',
+    'אֶחָד',
+    'שְׁנַיִם',
+    'שְׁלוֹשָׁה',
+    'אַרְבָּעָה',
+    'חֲמִשָּׁה',
+    'שִׁשָּׁה',
+    'שִׁבְעָה',
+    'שְׁמוֹנָה',
+    'תִּשְׁעָה',
+];
+const shnei = 'שְׁנֵי';
+const yamim = 'יָמִים';
+const shneiYamim = shnei + ' ' + yamim;
+const shavuot = 'שָׁבוּעוֹת';
+const yom = 'יוֹם';
+const yomEchad = yom + ' ' + ones[1];
+const asar = 'עָשָׂר';
+function omerTodayIsHe(omerDay) {
+    const ten = Math.floor(omerDay / 10);
+    const one = omerDay % 10;
+    let str = 'הַיּוֹם ';
+    if (omerDay === 11) {
+        str += 'אַחַד ' + asar;
+    }
+    else if (omerDay === 12) {
+        str += 'שְׁנֵים ' + asar;
+    }
+    else if (12 < omerDay && omerDay < 20) {
+        str += ones[one] + ' ' + asar;
+    }
+    else if (omerDay > 9) {
+        str += ones[one];
+        if (one) {
+            str += ' ';
+            str += ten === 3 ? 'וּ' : 'וְ';
+        }
+    }
+    if (omerDay > 2) {
+        if (omerDay > 20 || omerDay === 10 || omerDay === 20) {
+            str += tens[ten];
+        }
+        if (omerDay < 11) {
+            str += ones[one] + ' ' + yamim + ' ';
+        }
+        else {
+            str += ' ' + yom + ' ';
+        }
+    }
+    else if (omerDay === 1) {
+        str += yomEchad + ' ';
+    }
+    else {
+        // omer == 2
+        str += shneiYamim + ' ';
+    }
+    if (omerDay > 6) {
+        str = str.trim(); // remove trailing space before comma
+        str += ', שֶׁהֵם ';
+        const weeks = Math.floor(omerDay / 7);
+        const days = omerDay % 7;
+        if (weeks > 2) {
+            str += ones[weeks] + ' ' + shavuot + ' ';
+        }
+        else if (weeks === 1) {
+            str += 'שָׁבֽוּעַ' + ' ' + ones[1] + ' ';
+        }
+        else {
+            // weeks == 2
+            str += shnei + ' ' + shavuot + ' ';
+        }
+        if (days) {
+            if (days === 2 || days === 3) {
+                str += 'וּ';
+            }
+            else if (days === 5) {
+                str += 'וַ';
+            }
+            else {
+                str += 'וְ';
+            }
+            if (days > 2) {
+                str += ones[days] + ' ' + yamim + ' ';
+            }
+            else if (days === 1) {
+                str += yomEchad + ' ';
+            }
+            else {
+                // days == 2
+                str += shneiYamim + ' ';
+            }
+        }
+    }
+    str += 'לָעֽוֹמֶר';
+    return str.normalize();
+}
+/** Represents a day 1-49 of counting the Omer from Pesach to Shavuot */
+export class OmerEvent extends Event {
+    /**
+     * @param date
+     * @param omerDay
+     */
+    constructor(date, omerDay) {
+        super(date, `Omer ${omerDay}`, flags.OMER_COUNT);
+        checkDay(omerDay);
+        this.weekNumber = Math.floor((omerDay - 1) / 7) + 1;
+        this.daysWithinWeeks = omerDay % 7 || 7;
+        this.omer = omerDay;
+    }
+    /**
+     * Returns the sefira. For example, on day 8:
+     *  * חֶֽסֶד שֶׁבִּגְבוּרָה
+     *  * Chesed shebiGevurah
+     *  * Lovingkindness within Might
+     * @param lang `en` (English), `he` (Hebrew with nikud), or `translit` (Hebrew in Sephardic transliteration)
+     * @returns a string such as `Lovingkindness within Might` or `חֶֽסֶד שֶׁבִּגְבוּרָה`
+     */
+    sefira(lang = 'en') {
+        if (lang !== 'he' && lang !== 'translit') {
+            lang = 'en';
+        }
+        const [weekNum, daysWithinWeeks] = getWeeks(this.omer);
+        const config = sefirot[lang];
+        const pfxWords = config.pfxWords;
+        const words = config.words;
+        const week = pfxWords ? pfxWords[weekNum] : words[weekNum];
+        const dayWithinWeek = words[daysWithinWeeks];
+        const infix = pfxWords
+            ? ''
+            : weekNum === 2 || weekNum === 6
+                ? config.infix26
+                : config.infix;
+        return (dayWithinWeek + ' ' + infix + week).normalize();
+    }
+    /**
+     * @param [locale] Optional locale name (defaults to empty locale)
+     */
+    render(locale) {
+        locale = locale !== null && locale !== void 0 ? locale : 'en';
+        if (typeof locale === 'string') {
+            locale = locale.toLowerCase();
+        }
+        const isHebrewLocale = locale === 'he' || locale === 'he-x-nonikud' || locale === 'h';
+        const omer = this.omer;
+        const nth = isHebrewLocale ? gematriya(omer) : Locale.ordinal(omer, locale);
+        return nth + ' ' + Locale.gettext('day of the Omer', locale);
+    }
+    /**
+     * Returns translation of "Omer day 22" without ordinal numbers.
+     * @param [locale] Optional locale name (defaults to empty locale)
+     */
+    renderBrief(locale) {
+        return (Locale.gettext('Omer', locale) +
+            ' ' +
+            Locale.gettext('day', locale) +
+            ' ' +
+            this.omer);
+    }
+    /**
+     * Returns an emoji number symbol with a circle, for example `㊲`
+     *  from the “Enclosed CJK Letters and Months” block of the Unicode standard
+     * @returns a single Unicode character from `①` through `㊾`
+     */
+    getEmoji() {
+        if (typeof this.emoji === 'string')
+            return this.emoji;
+        let codePoint;
+        const omerDay = this.omer;
+        if (omerDay <= 20) {
+            codePoint = 9312 + omerDay - 1;
+        }
+        else if (omerDay <= 35) {
+            // between 21 and 35 inclusive
+            codePoint = 12881 + omerDay - 21;
+        }
+        else {
+            // between 36 and 49 inclusive
+            codePoint = 12977 + omerDay - 36;
+        }
+        return String.fromCodePoint(codePoint);
+    }
+    getWeeks() {
+        const day7 = this.daysWithinWeeks === 7;
+        return day7 ? this.weekNumber : this.weekNumber - 1;
+    }
+    getDaysWithinWeeks() {
+        return this.daysWithinWeeks;
+    }
+    /**
+     * Returns a sentence with that evening's omer count
+     * @returns a string such as `Today is 10 days, which is 1 week and 3 days of the Omer`
+     *  or `הַיוֹם עֲשָׂרָה יָמִים, שְׁהֵם שָׁבוּעַ אֶחָד וְשְׁלוֹשָׁה יָמִים לָעוֹמֶר`
+     */
+    getTodayIs(locale) {
+        locale = locale !== null && locale !== void 0 ? locale : 'en';
+        if (typeof locale === 'string') {
+            locale = locale.toLowerCase();
+        }
+        const isHebrew = locale === 'he' || locale === 'he-x-nonikud';
+        const str = isHebrew ? omerTodayIsHe(this.omer) : omerTodayIsEn(this.omer);
+        if (locale === 'he-x-nonikud') {
+            return Locale.hebrewStripNikkud(str);
+        }
+        return str;
+    }
+    url() {
+        const year = this.getDate().getFullYear();
+        if (year < 3860 || year > 6759) {
+            return undefined;
+        }
+        return `https://www.hebcal.com/omer/${year}/${this.omer}`;
+    }
+}

package/dist/src/parshaName.d.ts

@@ -0,0 +1,2 @@
+/** @private */
+export declare function renderParshaName(parsha: string[], locale?: string): string;

package/dist/src/parshaName.js

@@ -0,0 +1,13 @@
+import { Locale } from './locale';
+/** @private */
+export function renderParshaName(parsha, locale) {
+    const locale0 = locale !== null && locale !== void 0 ? locale : 'en';
+    let name = Locale.gettext(parsha[0], locale0);
+    if (parsha.length === 2) {
+        const hyphen = locale0 === 'he' ? '־' : '-';
+        name += hyphen + Locale.gettext(parsha[1], locale0);
+    }
+    name = name.replace(/'/g, '’');
+    const str = Locale.gettext('Parashat', locale) + ' ' + name;
+    return str.normalize();
+}

package/dist/src/parshaYear.d.ts

@@ -0,0 +1,9 @@
+import { ParshaEvent } from './ParshaEvent';
+/**
+ * Calculates weekly Torah Reading on Saturdays for entire year
+ * @param year Hebrew year
+ * @param il Israel (false for Diaspora)
+ * @returns an array of `ParshaEvent` occurring on Saturdays that contain a regular
+ *  (non-holiday) Parashat HaShavua
+ */
+export declare function parshaYear(year: number, il: boolean): ParshaEvent[];

package/dist/src/parshaYear.js

@@ -0,0 +1,24 @@
+import { HDate, months } from '@hebcal/hdate';
+import { ParshaEvent } from './ParshaEvent';
+import { getSedra } from './sedra';
+/**
+ * Calculates weekly Torah Reading on Saturdays for entire year
+ * @param year Hebrew year
+ * @param il Israel (false for Diaspora)
+ * @returns an array of `ParshaEvent` occurring on Saturdays that contain a regular
+ *  (non-holiday) Parashat HaShavua
+ */
+export function parshaYear(year, il) {
+    const sedra = getSedra(year, il);
+    const startAbs = sedra.getFirstSaturday();
+    const endAbs = HDate.hebrew2abs(year, months.ELUL, 29);
+    const events = [];
+    for (let absDt = startAbs; absDt <= endAbs; absDt += 7) {
+        const parsha = sedra.lookup(absDt);
+        if (!parsha.chag) {
+            const ev = new ParshaEvent(parsha);
+            events.push(ev);
+        }
+    }
+    return events;
+}

package/dist/src/pkgVersion.d.ts

@@ -0,0 +1,2 @@
+/** DO NOT EDIT THIS AUTO-GENERATED FILE! */
+export declare const version = "6.0.7";

package/dist/src/pkgVersion.js

@@ -0,0 +1,2 @@
+/** DO NOT EDIT THIS AUTO-GENERATED FILE! */
+export const version = '6.0.7';

package/dist/src/reformatTimeStr.d.ts

@@ -0,0 +1,8 @@
+import { CalOptions } from './CalOptions';
+/**
+ * @private
+ * @param timeStr - original time like "20:30"
+ * @param suffix - "p" or "pm" or " P.M.". Add leading space if you want it
+ * @param options
+ */
+export declare function reformatTimeStr(timeStr: string, suffix: string, options?: CalOptions): string;

package/dist/src/reformatTimeStr.js

@@ -0,0 +1,48 @@
+const hour12cc = {
+    US: 1,
+    CA: 1,
+    BR: 1,
+    AU: 1,
+    NZ: 1,
+    DO: 1,
+    PR: 1,
+    GR: 1,
+    IN: 1,
+    KR: 1,
+    NP: 1,
+    ZA: 1,
+};
+/**
+ * @private
+ * @param timeStr - original time like "20:30"
+ * @param suffix - "p" or "pm" or " P.M.". Add leading space if you want it
+ * @param options
+ */
+export function reformatTimeStr(timeStr, suffix, options) {
+    var _a;
+    if (typeof timeStr !== 'string')
+        throw new TypeError(`Bad timeStr: ${timeStr}`);
+    const cc = ((_a = options === null || options === void 0 ? void 0 : options.location) === null || _a === void 0 ? void 0 : _a.getCountryCode()) || ((options === null || options === void 0 ? void 0 : options.il) ? 'IL' : 'US');
+    const hour12 = options === null || options === void 0 ? void 0 : options.hour12;
+    if (typeof hour12 !== 'undefined' && !hour12) {
+        return timeStr;
+    }
+    if (!hour12 && typeof hour12cc[cc] === 'undefined') {
+        return timeStr;
+    }
+    const hm = timeStr.split(':');
+    let hour = parseInt(hm[0], 10);
+    if (hour < 12 && suffix) {
+        suffix = suffix.replace('p', 'a').replace('P', 'A');
+        if (hour === 0) {
+            hour = 12;
+        }
+    }
+    else if (hour > 12) {
+        hour = hour % 12;
+    }
+    else if (hour === 0) {
+        hour = '00';
+    }
+    return `${hour}:${hm[1]}${suffix}`;
+}