@hebcal/leyning 8.0.0 → 8.1.0

package/dist/index.mjs

@@ -1,4 +1,4 @@
-/*! @hebcal/leyning v8.0.0 */
+/*! @hebcal/leyning v8.1.0 */
 import { flags, months, HDate, HebrewCalendar, Locale, ParshaEvent, Event } from '@hebcal/core';
 
 const Genesis=[0,31,25,24,26,32,22,24,22,29,32,32,20,18,24,21,16,27,33,38,18,34,24,20,67,34,35,46,22,35,43,54,33,20,31,29,43,36,30,23,23,57,38,34,34,28,34,31,22,33,26];const Exodus=[0,22,25,22,31,23,30,29,28,35,29,10,51,22,31,27,36,16,27,25,26,37,30,33,18,40,37,21,43,46,38,18,35,23,35,35,38,29,31,43,38];const Leviticus=[0,17,16,17,35,26,23,38,36,24,20,47,8,59,57,33,34,16,30,37,27,24,33,44,23,55,46,34];const Numbers=[0,54,34,51,49,31,27,89,26,23,36,35,16,33,45,41,35,28,32,22,29,35,41,30,25,19,65,23,31,39,17,54,42,56,29,34,13];const Deuteronomy=[0,46,37,29,49,30,25,26,20,29,22,32,31,19,29,23,22,20,22,21,20,23,29,26,22,19,19,26,69,28,20,30,52,29,12];const Joshua=[0,18,24,17,24,15,27,26,35,27,43,23,24,33,15,63,10,18,28,51,9,45,34,16,33];const Judges=[0,36,23,31,24,31,40,25,35,57,18,40,15,25,20,20,31,13,31,30,48,25];const Ruth=[0,22,23,18,22];const Isaiah=[0,31,22,26,6,30,13,25,23,20,34,16,6,22,32,9,14,14,7,25,6,17,25,18,23,12,21,13,29,24,33,9,20,24,17,10,22,38,22,8,31,29,25,28,28,25,13,15,22,26,11,23,15,12,17,13,12,21,14,21,22,11,12,19,11,25,24];const Jeremiah=[0,19,37,25,31,31,30,34,23,25,25,23,17,27,22,21,21,27,23,15,18,14,30,40,10,38,24,22,17,32,24,40,44,26,22,19,32,21,28,18,16,18,22,13,30,5,28,7,47,39,46,64,34];const Lamentations=[0,22,22,66,22,22];const Baruch=[0,22,35,38,37,9,72];const Esther=[0,22,23,15,17,14,14,10,17,32,3];const Ecclesiastes=[0,18,26,22,17,19,12,29,17,18,20,10,14];const Ezekiel=[0,28,10,27,17,17,14,27,18,11,22,25,28,23,23,8,63,24,32,14,44,37,31,49,27,17,21,36,26,21,26,18,32,33,31,15,38,28,23,29,49,26,20,27,31,25,24,23,35];const Daniel=[0,21,49,100,34,30,29,28,27,27,21,45,13,64,42];const Hosea=[0,9,25,5,19,15,11,16,14,17,15,11,15,15,10];const Joel=[0,20,27,5,21];const Amos=[0,15,16,15,13,27,14,17,14,15];const Obadiah=[0,21];const Jonah=[0,16,11,10,11];const Micah=[0,16,13,12,14,14,16,20];const Nachum=[0,14,14,19];const Habakkuk=[0,17,20,19];const Zephaniah=[0,18,15,20];const Haggai=[0,15,23];const Zechariah=[0,17,17,10,14,11,15,14,23,17,12,17,14,9,21];const Malachi=[0,14,17,24];var numverses = {Genesis:Genesis,Exodus:Exodus,Leviticus:Leviticus,Numbers:Numbers,Deuteronomy:Deuteronomy,Joshua:Joshua,Judges:Judges,Ruth:Ruth,"I Samuel":[0,28,36,21,22,12,21,17,22,27,27,15,25,23,52,35,23,58,30,24,42,16,23,28,23,43,25,12,25,11,31,13],"II Samuel":[0,27,32,39,12,25,23,29,18,13,19,27,31,39,33,37,23,29,32,44,26,22,51,39,25],"I Kings":[0,53,46,28,20,32,38,51,66,28,29,43,33,34,31,34,34,24,46,21,43,29,54],"II Kings":[0,18,25,27,44,27,33,20,29,37,36,20,22,25,29,38,20,41,37,37,21,26,20,37,20,30],Isaiah:Isaiah,Jeremiah:Jeremiah,Lamentations:Lamentations,Baruch:Baruch,Esther:Esther,Ecclesiastes:Ecclesiastes,"Song of Songs":[0,17,17,11,16,16,12,14,14],Ezekiel:Ezekiel,Daniel:Daniel,Hosea:Hosea,Joel:Joel,Amos:Amos,Obadiah:Obadiah,Jonah:Jonah,Micah:Micah,Nachum:Nachum,Habakkuk:Habakkuk,Zephaniah:Zephaniah,Haggai:Haggai,Zechariah:Zechariah,Malachi:Malachi};
@@ -261,11 +261,11 @@ function lookupFestival(holiday) {
   }
   const result = src.fullkriyah ? clone(src) : src;
   if (result.fullkriyah) {
-    Object.values(result.fullkriyah).forEach(aliyah => {
+    for (const aliyah of Object.values(result.fullkriyah)) {
       if (typeof aliyah.k === 'number') {
         aliyah.k = BOOK[aliyah.k];
       }
-    });
+    }
   }
   if (src.note) {
     result.note = src.note;
@@ -308,32 +308,23 @@ function getLeyningKeyForEvent(ev, il = false) {
     }
     return desc;
   }
+  const cholHaMoedDay = ev.cholHaMoedDay;
   if (day == 1 && month === months.TISHREI) {
     return isShabbat ? 'Rosh Hashana I (on Shabbat)' : 'Rosh Hashana I';
-  } else if (ev.cholHaMoedDay) {
+  } else if (cholHaMoedDay) {
     // Sukkot or Pesach
     if (isShabbat) {
       return holiday + ' Shabbat Chol ha-Moed';
     } else if (desc == 'Sukkot VII (Hoshana Raba)') {
       return 'Sukkot Final Day (Hoshana Raba)';
     }
-    if (isPesach && ev.cholHaMoedDay) {
+    if (isPesach && cholHaMoedDay) {
       if (dow === 0 && desc === 'Pesach IV (CH\'\'M)') {
         return 'Pesach Chol ha-Moed Day 2 on Sunday';
       } else if (dow === 1 && desc === 'Pesach V (CH\'\'M)') {
         return 'Pesach Chol ha-Moed Day 3 on Monday';
       }
     }
-    // If Shabbat falls on the third day of Chol ha-Moed Pesach,
-    // the readings for the third, fourth, and fifth days are moved ahead
-    let cholHaMoedDay = ev.cholHaMoedDay;
-    if (isPesach && cholHaMoedDay >= 3) {
-      if (dow == 0 && cholHaMoedDay == 4) {
-        cholHaMoedDay = 3;
-      } else if (dow == 1 && cholHaMoedDay == 5) {
-        cholHaMoedDay = 4;
-      }
-    }
     return `${holiday} Chol ha-Moed Day ${cholHaMoedDay}`;
   } else if (ev.chanukahDay) {
     if (isShabbat && isRoshChodesh) {
@@ -389,7 +380,6 @@ function getLeyningKeyForEvent(ev, il = false) {
       return 'Chanukah Day 7 (on Rosh Chodesh)'; // 1st of Tevet
     }
   }
-
   if (isRoshChodesh) {
     return desc;
   }
@@ -491,14 +481,16 @@ function specialReadings2(parsha, hd, il, aliyot) {
     if (special.fullkriyah) {
       const aliyotMap = clone(aliyot);
       mergeAliyotWithSpecial(aliyotMap, special.fullkriyah);
-      Object.keys(special.fullkriyah).map(k => reason[k] = key);
+      for (const num of Object.keys(special.fullkriyah)) {
+        reason[num] = key;
+      }
       aliyot = aliyotMap;
     }
   }
   const parshaName = parshaToString(parsha);
   const events0 = HebrewCalendar.getHolidaysOnDate(hd, il) || [];
   const events = events0.filter(ev => !(ev.getFlags() & flags.ROSH_CHODESH));
-  events.forEach(ev => {
+  for (const ev of events) {
     if (ev.getDesc() === 'Shabbat Shuva') {
       handleSpecial(`Shabbat Shuva (with ${parshaName})`);
     } else {
@@ -507,7 +499,7 @@ function specialReadings2(parsha, hd, il, aliyot) {
         handleSpecial(key);
       }
     }
-  });
+  }
   if (!haft) {
     const day = hd.getDate();
     if (parshaName === 'Pinchas' && day > 17) {
@@ -665,7 +657,7 @@ const Bereshit={num:1,hebrew:"בְּרֵאשִׁית",book:1,haft:{k:"Isaiah",b:
  * @property {LeyningNames} name
  * @property {string[]} [parsha] - An array of either 1 (regular) or 2 (doubled parsha).
  *    `undefined` for holiday readings
- * @property {number} [parshaNum] - 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings
+ * @property {number|number[]} [parshaNum] - 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings
  * @property {string} summary - Such as `Genesis 1:1 - 6:8`
  * @property {Aliyah|Aliyah[]} haft - Haftarah object(s)
  * @property {string} haftara - Haftarah, such as `Isaiah 42:5 – 43:11`
@@ -699,6 +691,19 @@ function getHaftaraKey(parsha) {
   }
 }
 
+/**
+ * Transliterated English and Hebrew names of this parsha
+ * @param {string|string[]} parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
+ * @return {LeyningNames}
+ */
+function makeLeyningNames(parsha) {
+  const name = parshaToString(parsha);
+  return {
+    en: name,
+    he: parsha.map(s => Locale.lookupTranslation(s, 'he')).join('־')
+  };
+}
+
 /**
  * Looks up regular leyning for a weekly parsha with no special readings
  * @private
@@ -709,26 +714,22 @@ function getLeyningForParshaShabbatOnly(parsha) {
   const raw = lookupParsha(parsha);
   const fullkriyah = {};
   const book = BOOK[raw.book];
-  Object.keys(raw.fullkriyah).forEach(num => {
-    const src = raw.fullkriyah[num];
-    const reading = {
+  for (const [num, src] of Object.entries(raw.fullkriyah)) {
+    const aliyah = {
       k: book,
       b: src[0],
       e: src[1]
     };
-    fullkriyah[num] = reading;
-  });
-  Object.values(fullkriyah).map(aliyah => calculateNumVerses(aliyah));
+    calculateNumVerses(aliyah);
+    fullkriyah[num] = aliyah;
+  }
   const name = parshaToString(parsha);
   const parshaNameArray = raw.combined ? [raw.p1, raw.p2] : [name];
   const parts = makeLeyningParts(fullkriyah);
   const summary = makeSummaryFromParts(parts);
   /** @type {Leyning} */
   const result = {
-    name: {
-      en: name,
-      he: parshaNameArray.map(s => Locale.lookupTranslation(s, 'he')).join('־')
-    },
+    name: makeLeyningNames(parshaNameArray),
     parsha: parshaNameArray,
     parshaNum: raw.num,
     summary,
@@ -830,18 +831,20 @@ function getLeyningForParshaHaShavua(ev, il = false) {
   const reasons = Object.keys(reason);
   if (reasons.length !== 0) {
     result.reason = reason;
-    reasons.forEach(num => {
+    for (const num of reasons) {
       if (num === 'haftara' || num === 'sephardic') {
         const haftObj = result[num === 'haftara' ? 'haft' : 'seph'];
         const hafts = Array.isArray(haftObj) ? haftObj : [haftObj];
-        hafts.forEach(haft => haft.reason = reason[num]);
+        for (const haft of hafts) {
+          haft.reason = reason[num];
+        }
       } else {
         const aliyah = result.fullkriyah[num];
         if (typeof aliyah === 'object') {
           aliyah.reason = reason[num];
         }
       }
-    });
+    }
   }
   return result;
 }
@@ -886,6 +889,18 @@ function findParshaHaShavua(saturday, il) {
   if (!parsha.chag) {
     return parsha;
   }
+  // Special case between YK and Simchat Torah
+  if (saturday.getMonth() === months.TISHREI) {
+    const dd = saturday.getDate();
+    const simchatTorah = il ? 22 : 23;
+    if (dd > 10 && dd <= simchatTorah) {
+      return {
+        parsha: ['Vezot Haberakhah'],
+        chag: false,
+        num: 54
+      };
+    }
+  }
   // Search for next regular parsha, which could even spill into next year
   const endOfYear = new HDate(1, months.TISHREI, hyear + 1).abs() - 1;
   const endAbs = endOfYear + 30;
@@ -920,48 +935,44 @@ function findParshaHaShavua(saturday, il) {
  */
 function getLeyningOnDate(hdate, il, wantarray = false) {
   const dow = hdate.getDay();
-  const hyear = hdate.getFullYear();
-  const sedra = HebrewCalendar.getSedra(hyear, il);
-  const parsha = sedra.lookup(hdate);
-  if (dow === 6 && !parsha.chag) {
-    const parshaEvent = new ParshaEvent(hdate, parsha.parsha, il);
-    const reading = getLeyningForParshaHaShavua(parshaEvent, il);
-    return wantarray ? [reading] : reading;
+  if (dow === 6) {
+    const hyear = hdate.getFullYear();
+    const sedra = HebrewCalendar.getSedra(hyear, il);
+    const parsha = sedra.lookup(hdate);
+    if (!parsha.chag) {
+      const parshaEvent = new ParshaEvent(hdate, parsha.parsha, il);
+      const reading = getLeyningForParshaHaShavua(parshaEvent, il);
+      return wantarray ? [reading] : reading;
+    }
   }
   const events = HebrewCalendar.getHolidaysOnDate(hdate, il) || [];
   const arr = [];
-  for (let i = 0; i < events.length; i++) {
-    const ev = events[i];
+  let hasFullKriyah = false;
+  for (const ev of events) {
     const reading = getLeyningForHoliday(ev, il);
     if (reading) {
-      if (wantarray) {
-        arr.push(reading);
-        const mincha = getMincha(ev, il);
-        if (mincha) {
-          arr.push(mincha);
-        }
-      } else {
-        return reading;
+      arr.push(reading);
+      if (reading.fullkriyah) {
+        hasFullKriyah = true;
+      }
+      const mincha = getMincha(ev, il);
+      if (mincha) {
+        arr.push(mincha);
       }
     }
   }
-  if (wantarray && arr.length !== 0) {
-    return arr;
-  }
-  if (dow === 1 || dow === 4) {
+  if (!hasFullKriyah && (dow === 1 || dow === 4)) {
     const saturday = hdate.onOrAfter(6);
-    const parsha2 = findParshaHaShavua(saturday);
-    const reading = getLeyningForParsha(parsha2.parsha);
-    const result = {
-      name: reading.name,
-      parsha: reading.parsha,
-      parshaNum: reading.parshaNum,
-      weekday: reading.weekday
+    const parsha = findParshaHaShavua(saturday);
+    const reading = {
+      name: makeLeyningNames(parsha.parsha),
+      parsha: parsha.parsha,
+      parshaNum: parsha.num,
+      weekday: getWeekdayReading(parsha.parsha)
     };
-    return wantarray ? [result] : result;
+    arr.unshift(reading);
   }
-  // no reading today: it's not Shabbat, Mon/Thu, or a Torah-reading holiday
-  return wantarray ? [] : undefined;
+  return wantarray ? arr : arr[0];
 }
 const minchaSuffix = ' (Mincha)';
 
@@ -1033,11 +1044,11 @@ function writeFullKriyahCsv(stream, hyear, il) {
   const events = events0.filter(ev => ev.getDesc() !== 'Rosh Chodesh Tevet');
   const parshaDates = getParshaDates(events);
   stream.write('"Date","Parashah","Aliyah","Reading","Verses"\r\n');
-  events.forEach(ev => {
+  for (const ev of events) {
     if (ev.getFlags() === flags.PARSHA_HASHAVUA || !parshaDates[ev.getDate().toString()]) {
       writeFullKriyahEvent(stream, ev, il);
     }
-  });
+  }
 }
 
 /**
@@ -1106,13 +1117,13 @@ function writeCsvLines(stream, ev, reading, il, isParsha) {
   const parsha = isParsha ? ev.basename() : getLeyningKeyForEvent(ev, il) || ev.render();
   const date = fmtDate(ev.getDate().greg());
   const lines = getFullKriyahLines(reading);
-  lines.forEach(s => {
+  for (const s of lines) {
     const code = s[0].charCodeAt(0);
     if (code < 48 || code > 57) {
       s[0] = `"${s[0]}"`;
     }
     stream.write(`${date},"${parsha}",${s[0]},"${s[1]}",${s[2]}\r\n`);
-  });
+  }
   stream.write('\r\n');
 }
 
@@ -1124,8 +1135,7 @@ function writeCsvLines(stream, ev, reading, il, isParsha) {
 function getFullKriyahLines(reading) {
   const lines = [];
   if (reading.fullkriyah) {
-    Object.keys(reading.fullkriyah).forEach(num => {
-      const a = reading.fullkriyah[num];
+    for (const [num, a] of Object.entries(reading.fullkriyah)) {
       if (typeof a !== 'undefined') {
         var _reading$reason;
         const k = num == 'M' ? 'maf' : num;
@@ -1135,7 +1145,7 @@ function getFullKriyahLines(reading) {
         }
         lines.push([k, aliyah, a.v || '']);
       }
-    });
+    }
   }
   let specialHaftara = false;
   if (reading.haftara) {
@@ -1156,15 +1166,14 @@ function getFullKriyahLines(reading) {
     lines.push(['Alternate Haftara', haftara, reading.triHaftaraNumV || '']);
   }
   if (reading.megillah) {
-    Object.keys(reading.megillah).forEach(num => {
-      const a = reading.megillah[num];
+    for (const [num, a] of Object.entries(reading.megillah)) {
       if (typeof a !== 'undefined') {
         const aliyah = formatAliyahWithBook(a);
         lines.push([`Megillah Ch. ${num}`, aliyah, a.v || '']);
       }
-    });
+    }
   }
   return lines;
 }
 
-export { BOOK, calculateNumVerses, clone, cloneHaftara, formatAliyahShort, formatAliyahWithBook, getLeyningForHoliday, getLeyningForHolidayKey, getLeyningForParsha, getLeyningForParshaHaShavua, getLeyningKeyForEvent, getLeyningOnDate, getParshaDates, getWeekdayReading, hasFestival, lookupFestival, lookupParsha, makeLeyningParts, makeLeyningSummary, makeSummaryFromParts, parshaToString, specialReadings2, sumVerses, writeCsvLines, writeFullKriyahCsv, writeHolidayMincha };
+export { BOOK, calculateNumVerses, clone, cloneHaftara, formatAliyahShort, formatAliyahWithBook, getLeyningForHoliday, getLeyningForHolidayKey, getLeyningForParsha, getLeyningForParshaHaShavua, getLeyningKeyForEvent, getLeyningOnDate, getParshaDates, getWeekdayReading, hasFestival, lookupFestival, lookupParsha, makeLeyningNames, makeLeyningParts, makeLeyningSummary, makeSummaryFromParts, parshaToString, specialReadings2, sumVerses, writeCsvLines, writeFullKriyahCsv, writeHolidayMincha };

package/leyning.d.ts

@@ -28,17 +28,26 @@ declare module '@hebcal/leyning' {
         [key: string]: Aliyah;
     }
 
+    /** Name of the parsha hashavua or holiday */
+    export type LeyningNames = {
+        /** English */
+        en: string;
+        /** Hebrew (with nikud) */
+        he: string;
+    }
+
+    /**
+     * Transliterated English and Hebrew names of this parsha
+     * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
+     */
+    export function makeLeyningNames(parsha: string | string[]): LeyningNames;
+
     /**
      * Leyning for a parsha hashavua or holiday
      */
     export type Leyning = {
         /** Name of the parsha hashavua or holiday */
-        name: {
-            /** English */
-            en: string;
-            /** Hebrew (with nikud) */
-            he: string;
-        };
+        name: LeyningNames;
         /** An array of either 1 (regular) or 2 (doubled parsha). `undefined` for holiday readings */
         parsha?: string[];
         /** 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/leyning",
-  "version": "8.0.0",
+  "version": "8.1.0",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal",
@@ -31,7 +31,7 @@
     "leyning-csv": "bin/leyning-csv"
   },
   "dependencies": {
-    "@hebcal/core": "^5.0.0-rc2"
+    "@hebcal/core": "^5.0.1"
   },
   "scripts": {
     "build": "rollup -c",
@@ -47,20 +47,20 @@
     ]
   },
   "devDependencies": {
-    "@babel/core": "^7.23.3",
-    "@babel/preset-env": "^7.23.3",
+    "@babel/core": "^7.23.5",
+    "@babel/preset-env": "^7.23.5",
     "@babel/register": "^7.22.15",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-json": "^6.0.1",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
-    "ava": "^5.3.1",
-    "core-js": "^3.33.3",
-    "eslint": "^8.54.0",
+    "ava": "^6.0.1",
+    "core-js": "^3.34.0",
+    "eslint": "^8.55.0",
     "eslint-config-google": "^0.14.0",
     "jsdoc": "^4.0.2",
     "jsdoc-to-markdown": "^8.0.0",
-    "rollup": "^4.5.1"
+    "rollup": "^4.7.0"
   }
 }