@hebcal/leyning 8.2.1 → 8.2.3

package/dist/index.cjs

@@ -1,4 +1,4 @@
-/*! @hebcal/leyning v8.2.1 */
+/*! @hebcal/leyning v8.2.3 */
 'use strict';
 
 var core = require('@hebcal/core');
@@ -461,7 +461,10 @@ var festivals0 = { "Pesach I": {
             "M": { "p": 41, "k": 4, "b": "29:1", "e": "29:6" } }
     },
     "Rosh Hashana II": {
-        "haft": { "k": "Jeremiah", "b": "31:1", "e": "31:19" },
+        "haft": {
+            "k": "Jeremiah", "b": "31:2", "e": "31:20",
+            "note": "labeled 31:1–19 in some books"
+        },
         "fullkriyah": { "1": { "p": 4, "k": 1, "b": "22:1", "e": "22:3" },
             "2": { "p": 4, "k": 1, "b": "22:4", "e": "22:8" },
             "3": { "p": 4, "k": 1, "b": "22:9", "e": "22:14" },
@@ -884,9 +887,9 @@ const HOLIDAY_IGNORE_MASK = core.flags.DAF_YOMI | core.flags.OMER_COUNT | core.f
     core.flags.MODERN_HOLIDAY | core.flags.YERUSHALMI_YOMI;
 /**
  * Based on the event date, type and title, finds the relevant leyning key
- * @param {Event} ev event
- * @param {boolean} [il] true if Israel holiday scheme
- * @return {string} key to look up in holiday-reading.json
+ * @param ev event
+ * @param [il] true if Israel holiday scheme
+ * @returns key to look up in holiday-reading.json
  */
 function getLeyningKeyForEvent(ev, il = false) {
     if (typeof ev.eventTime !== 'undefined') {
@@ -1205,9 +1208,9 @@ function getLeyningForHolidayKey(key, cholHaMoedDay, il) {
 /**
  * Looks up leyning for a given holiday. Returns some
  * of full kriyah aliyot, special Maftir, special Haftarah
- * @param {Event} ev the Hebcal event associated with this leyning
- * @param {boolean} [il] true if Israel holiday scheme
- * @return {Leyning} map of aliyot
+ * @param ev the Hebcal event associated with this leyning
+ * @param [il] true if Israel holiday scheme
+ * @returns map of aliyot
  */
 function getLeyningForHoliday(ev, il = false) {
     if (typeof ev !== 'object' || typeof ev.getFlags !== 'function') {
@@ -2377,7 +2380,8 @@ var parshiyotObj0 = {
         }
     },
     "Vayakhel-Pekudei": {
-        "num": 101, "combined": true,
+        "num": [22, 23],
+        "combined": true,
         "p1": "Vayakhel",
         "p2": "Pekudei",
         "num1": 22,
@@ -2395,7 +2399,8 @@ var parshiyotObj0 = {
         }
     },
     "Tazria-Metzora": {
-        "num": 102, "combined": true,
+        "num": [27, 28],
+        "combined": true,
         "p1": "Tazria",
         "p2": "Metzora",
         "num1": 27,
@@ -2413,7 +2418,8 @@ var parshiyotObj0 = {
         }
     },
     "Achrei Mot-Kedoshim": {
-        "num": 103, "combined": true,
+        "num": [29, 30],
+        "combined": true,
         "p1": "Achrei Mot",
         "p2": "Kedoshim",
         "num1": 29,
@@ -2433,7 +2439,8 @@ var parshiyotObj0 = {
         }
     },
     "Behar-Bechukotai": {
-        "num": 104, "combined": true,
+        "num": [32, 33],
+        "combined": true,
         "p1": "Behar",
         "p2": "Bechukotai",
         "num1": 32,
@@ -2451,7 +2458,8 @@ var parshiyotObj0 = {
         }
     },
     "Chukat-Balak": {
-        "num": 105, "combined": true,
+        "num": [39, 40],
+        "combined": true,
         "p1": "Chukat",
         "p2": "Balak",
         "num1": 39,
@@ -2469,7 +2477,8 @@ var parshiyotObj0 = {
         }
     },
     "Matot-Masei": {
-        "num": 106, "combined": true,
+        "num": [42, 43],
+        "combined": true,
         "p1": "Matot",
         "p2": "Masei",
         "num1": 42,
@@ -2487,7 +2496,8 @@ var parshiyotObj0 = {
         }
     },
     "Nitzavim-Vayeilech": {
-        "num": 107, "combined": true,
+        "num": [51, 52],
+        "combined": true,
         "p1": "Nitzavim",
         "p2": "Vayeilech",
         "num1": 51,
@@ -2511,8 +2521,6 @@ const parshiyotObj = parshiyotObj0;
  * on doubled parshiot, read only the second Haftarah
  * except for Nitzavim-Vayelech and Achrei Mot-Kedoshim
  * @private
- * @param {string[]} parsha
- * @return {string}
  */
 function getHaftaraKey(parsha) {
     const first = parsha[0];
@@ -2540,8 +2548,8 @@ function makeLeyningNames(parsha) {
 /**
  * Looks up regular leyning for a weekly parsha with no special readings
  * @private
- * @param {string|string[]} parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
- * @return {Leyning} map of aliyot
+ * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
+ * @returns map of aliyot
  */
 function getLeyningForParshaShabbatOnly(parsha) {
     const raw = lookupParsha(parsha);
@@ -2556,7 +2564,6 @@ function getLeyningForParshaShabbatOnly(parsha) {
     const parshaNameArray = raw.combined ? [raw.p1, raw.p2] : [name];
     const parts = makeLeyningParts(fullkriyah);
     const summary = makeSummaryFromParts(parts);
-    /** @type {Leyning} */
     const result = {
         name: makeLeyningNames(parshaNameArray),
         parsha: parshaNameArray,
@@ -2618,9 +2625,9 @@ function getLeyningForParsha(parsha) {
 /**
  * Looks up leyning for a regular Shabbat parsha, including any special
  * maftir or Haftara.
- * @param {Event} ev the Hebcal event associated with this leyning
- * @param {boolean} [il] in Israel
- * @return {Leyning} map of aliyot
+ * @param ev the Hebcal event associated with this leyning
+ * @param [il] in Israel
+ * @returns map of aliyot
  */
 function getLeyningForParshaHaShavua(ev, il = false) {
     if (typeof ev !== 'object' || typeof ev.getFlags !== 'function') {
@@ -2680,8 +2687,7 @@ function getLeyningForParshaHaShavua(ev, il = false) {
 }
 /**
  * Returns the parsha metadata
- * @param {string|string[]} parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
- * @return {ParshaMeta}
+ * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
  */
 function lookupParsha(parsha) {
     const name = parshaToString(parsha);
@@ -2788,6 +2794,13 @@ function getLeyningOnDate(hdate, il, wantarray = false) {
             if (mincha) {
                 arr.push(mincha);
             }
+            // Special case for Erev Simchat Torah - the only time we read Torah at night
+            const desc = ev.getDesc();
+            if ((il && desc === 'Sukkot VII (Hoshana Raba)') ||
+                (!il && desc === 'Shmini Atzeret')) {
+                const erevST = getLeyningForHolidayKey('Erev Simchat Torah');
+                arr.push(erevST);
+            }
         }
     }
     if (!hasFullKriyah && (dow === 1 || dow === 4)) {
@@ -2876,6 +2889,12 @@ function writeFullKriyahEvent(stream, ev, il) {
         writeCsvLines(stream, ev, reading, il, isParsha);
         if (!isParsha) {
             writeHolidayMincha(stream, ev, il);
+            const desc = ev.getDesc();
+            if ((il && desc === 'Sukkot VII (Hoshana Raba)') ||
+                (!il && desc === 'Shmini Atzeret')) {
+                const ev2 = new core.HolidayEvent(ev.getDate(), 'Erev Simchat Torah', core.flags.EREV);
+                writeFullKriyahEvent(stream, ev2, il);
+            }
         }
     }
 }

package/dist/index.mjs

@@ -1,5 +1,5 @@
-/*! @hebcal/leyning v8.2.1 */
-import { flags, months, HDate, HebrewCalendar, Locale, ParshaEvent, Event } from '@hebcal/core';
+/*! @hebcal/leyning v8.2.3 */
+import { flags, months, HDate, HebrewCalendar, Locale, ParshaEvent, HolidayEvent, Event } from '@hebcal/core';
 
 var numverses = {
     "Genesis": [0,
@@ -459,7 +459,10 @@ var festivals0 = { "Pesach I": {
             "M": { "p": 41, "k": 4, "b": "29:1", "e": "29:6" } }
     },
     "Rosh Hashana II": {
-        "haft": { "k": "Jeremiah", "b": "31:1", "e": "31:19" },
+        "haft": {
+            "k": "Jeremiah", "b": "31:2", "e": "31:20",
+            "note": "labeled 31:1–19 in some books"
+        },
         "fullkriyah": { "1": { "p": 4, "k": 1, "b": "22:1", "e": "22:3" },
             "2": { "p": 4, "k": 1, "b": "22:4", "e": "22:8" },
             "3": { "p": 4, "k": 1, "b": "22:9", "e": "22:14" },
@@ -882,9 +885,9 @@ const HOLIDAY_IGNORE_MASK = flags.DAF_YOMI | flags.OMER_COUNT | flags.SHABBAT_ME
     flags.MODERN_HOLIDAY | flags.YERUSHALMI_YOMI;
 /**
  * Based on the event date, type and title, finds the relevant leyning key
- * @param {Event} ev event
- * @param {boolean} [il] true if Israel holiday scheme
- * @return {string} key to look up in holiday-reading.json
+ * @param ev event
+ * @param [il] true if Israel holiday scheme
+ * @returns key to look up in holiday-reading.json
  */
 function getLeyningKeyForEvent(ev, il = false) {
     if (typeof ev.eventTime !== 'undefined') {
@@ -1203,9 +1206,9 @@ function getLeyningForHolidayKey(key, cholHaMoedDay, il) {
 /**
  * Looks up leyning for a given holiday. Returns some
  * of full kriyah aliyot, special Maftir, special Haftarah
- * @param {Event} ev the Hebcal event associated with this leyning
- * @param {boolean} [il] true if Israel holiday scheme
- * @return {Leyning} map of aliyot
+ * @param ev the Hebcal event associated with this leyning
+ * @param [il] true if Israel holiday scheme
+ * @returns map of aliyot
  */
 function getLeyningForHoliday(ev, il = false) {
     if (typeof ev !== 'object' || typeof ev.getFlags !== 'function') {
@@ -2375,7 +2378,8 @@ var parshiyotObj0 = {
         }
     },
     "Vayakhel-Pekudei": {
-        "num": 101, "combined": true,
+        "num": [22, 23],
+        "combined": true,
         "p1": "Vayakhel",
         "p2": "Pekudei",
         "num1": 22,
@@ -2393,7 +2397,8 @@ var parshiyotObj0 = {
         }
     },
     "Tazria-Metzora": {
-        "num": 102, "combined": true,
+        "num": [27, 28],
+        "combined": true,
         "p1": "Tazria",
         "p2": "Metzora",
         "num1": 27,
@@ -2411,7 +2416,8 @@ var parshiyotObj0 = {
         }
     },
     "Achrei Mot-Kedoshim": {
-        "num": 103, "combined": true,
+        "num": [29, 30],
+        "combined": true,
         "p1": "Achrei Mot",
         "p2": "Kedoshim",
         "num1": 29,
@@ -2431,7 +2437,8 @@ var parshiyotObj0 = {
         }
     },
     "Behar-Bechukotai": {
-        "num": 104, "combined": true,
+        "num": [32, 33],
+        "combined": true,
         "p1": "Behar",
         "p2": "Bechukotai",
         "num1": 32,
@@ -2449,7 +2456,8 @@ var parshiyotObj0 = {
         }
     },
     "Chukat-Balak": {
-        "num": 105, "combined": true,
+        "num": [39, 40],
+        "combined": true,
         "p1": "Chukat",
         "p2": "Balak",
         "num1": 39,
@@ -2467,7 +2475,8 @@ var parshiyotObj0 = {
         }
     },
     "Matot-Masei": {
-        "num": 106, "combined": true,
+        "num": [42, 43],
+        "combined": true,
         "p1": "Matot",
         "p2": "Masei",
         "num1": 42,
@@ -2485,7 +2494,8 @@ var parshiyotObj0 = {
         }
     },
     "Nitzavim-Vayeilech": {
-        "num": 107, "combined": true,
+        "num": [51, 52],
+        "combined": true,
         "p1": "Nitzavim",
         "p2": "Vayeilech",
         "num1": 51,
@@ -2509,8 +2519,6 @@ const parshiyotObj = parshiyotObj0;
  * on doubled parshiot, read only the second Haftarah
  * except for Nitzavim-Vayelech and Achrei Mot-Kedoshim
  * @private
- * @param {string[]} parsha
- * @return {string}
  */
 function getHaftaraKey(parsha) {
     const first = parsha[0];
@@ -2538,8 +2546,8 @@ function makeLeyningNames(parsha) {
 /**
  * Looks up regular leyning for a weekly parsha with no special readings
  * @private
- * @param {string|string[]} parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
- * @return {Leyning} map of aliyot
+ * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
+ * @returns map of aliyot
  */
 function getLeyningForParshaShabbatOnly(parsha) {
     const raw = lookupParsha(parsha);
@@ -2554,7 +2562,6 @@ function getLeyningForParshaShabbatOnly(parsha) {
     const parshaNameArray = raw.combined ? [raw.p1, raw.p2] : [name];
     const parts = makeLeyningParts(fullkriyah);
     const summary = makeSummaryFromParts(parts);
-    /** @type {Leyning} */
     const result = {
         name: makeLeyningNames(parshaNameArray),
         parsha: parshaNameArray,
@@ -2616,9 +2623,9 @@ function getLeyningForParsha(parsha) {
 /**
  * Looks up leyning for a regular Shabbat parsha, including any special
  * maftir or Haftara.
- * @param {Event} ev the Hebcal event associated with this leyning
- * @param {boolean} [il] in Israel
- * @return {Leyning} map of aliyot
+ * @param ev the Hebcal event associated with this leyning
+ * @param [il] in Israel
+ * @returns map of aliyot
  */
 function getLeyningForParshaHaShavua(ev, il = false) {
     if (typeof ev !== 'object' || typeof ev.getFlags !== 'function') {
@@ -2678,8 +2685,7 @@ function getLeyningForParshaHaShavua(ev, il = false) {
 }
 /**
  * Returns the parsha metadata
- * @param {string|string[]} parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
- * @return {ParshaMeta}
+ * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
  */
 function lookupParsha(parsha) {
     const name = parshaToString(parsha);
@@ -2786,6 +2792,13 @@ function getLeyningOnDate(hdate, il, wantarray = false) {
             if (mincha) {
                 arr.push(mincha);
             }
+            // Special case for Erev Simchat Torah - the only time we read Torah at night
+            const desc = ev.getDesc();
+            if ((il && desc === 'Sukkot VII (Hoshana Raba)') ||
+                (!il && desc === 'Shmini Atzeret')) {
+                const erevST = getLeyningForHolidayKey('Erev Simchat Torah');
+                arr.push(erevST);
+            }
         }
     }
     if (!hasFullKriyah && (dow === 1 || dow === 4)) {
@@ -2874,6 +2887,12 @@ function writeFullKriyahEvent(stream, ev, il) {
         writeCsvLines(stream, ev, reading, il, isParsha);
         if (!isParsha) {
             writeHolidayMincha(stream, ev, il);
+            const desc = ev.getDesc();
+            if ((il && desc === 'Sukkot VII (Hoshana Raba)') ||
+                (!il && desc === 'Shmini Atzeret')) {
+                const ev2 = new HolidayEvent(ev.getDate(), 'Erev Simchat Torah', flags.EREV);
+                writeFullKriyahEvent(stream, ev2, il);
+            }
         }
     }
 }

package/dist/leyning.d.ts

@@ -18,14 +18,13 @@ export declare function getLeyningForParsha(parsha: string | string[]): Leyning;
 /**
  * Looks up leyning for a regular Shabbat parsha, including any special
  * maftir or Haftara.
- * @param {Event} ev the Hebcal event associated with this leyning
- * @param {boolean} [il] in Israel
- * @return {Leyning} map of aliyot
+ * @param ev the Hebcal event associated with this leyning
+ * @param [il] in Israel
+ * @returns map of aliyot
  */
 export declare function getLeyningForParshaHaShavua(ev: Event, il?: boolean): Leyning;
 /**
  * Returns the parsha metadata
- * @param {string|string[]} parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
- * @return {ParshaMeta}
+ * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
  */
 export declare function lookupParsha(parsha: string | string[]): ParshaMeta;

package/dist/types.d.ts

@@ -32,7 +32,7 @@ export type LeyningNames = {
  */
 export type ParshaMeta = {
     /** 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings */
-    num: number;
+    num: number | number[];
     /** parsha name in Hebrew with niqud */
     hebrew: string;
     /** 1 for Genesis, 2 for Exodus, 5 for Deuteronomy */
@@ -98,18 +98,20 @@ export type LeyningWeekday = LeyningParshaHaShavua & {
     /** Optional map of weekday Torah Readings aliyot `1` through `3` for Monday and Thursday */
     weekday?: AliyotMap;
 };
-/**
- * Shabbat and holiday leyning always has full kriyah and haftarah
- */
-export type LeyningShabbatHoliday = LeyningBase & {
-    /** Map of aliyot `1` through `7` plus `M` for maftir */
-    fullkriyah: AliyotMap;
+export type HaftarahProps = {
     /** Haftarah object */
     haft: Aliyah | Aliyah[];
     /** Haftarah, such as `Isaiah 42:5 – 43:11` */
     haftara: string;
     /** Number of verses in the Haftarah */
     haftaraNumV?: number;
+};
+/**
+ * Shabbat and holiday leyning always has full kriyah and haftarah
+ */
+export type LeyningShabbatHoliday = LeyningBase & HaftarahProps & {
+    /** Map of aliyot `1` through `7` plus `M` for maftir */
+    fullkriyah: AliyotMap;
     /** Haftarah object for Sephardim */
     seph?: Aliyah | Aliyah[];
     /** Haftarah for Sephardim, such as `Isaiah 42:5 - 42:21` */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/leyning",
-  "version": "8.2.1",
+  "version": "8.2.3",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal",
@@ -40,36 +40,38 @@
     "leyning-csv": "bin/leyning-csv"
   },
   "dependencies": {
-    "@hebcal/core": "^5.4.6",
-    "tslib": "^2.6.3"
+    "@hebcal/core": "^5.5.0",
+    "tslib": "^2.7.0"
   },
   "scripts": {
     "build:rollup": "rollup -c",
     "build:json2js": "for f in src/*.json; do echo 'export default' > $f.ts && cat $f >> $f.ts; done",
     "build": "npm run build:json2js && npm run build:rollup",
     "prepublish": "npm run build",
-    "readme": "npx jsdoc2md dist/index.js",
+    "docs": "typedoc",
     "pretest": "npm run build",
-    "test": "jest"
+    "lint": "gts lint",
+    "coverage": "jest --coverage",
+    "test": "jest",
+    "clean": "gts clean",
+    "fix": "gts fix"
   },
   "license": "BSD-2-Clause",
   "devDependencies": {
-    "@babel/preset-env": "^7.24.7",
+    "@babel/preset-env": "^7.25.4",
     "@babel/preset-typescript": "^7.24.7",
-    "@rollup/plugin-commonjs": "^26.0.1",
+    "@rollup/plugin-commonjs": "^28.0.0",
     "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-node-resolve": "^15.3.0",
     "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^11.1.6",
-    "@types/jest": "^29.5.12",
-    "eslint": "^8.57.0",
-    "eslint-config-google": "^0.14.0",
+    "@rollup/plugin-typescript": "^12.1.0",
+    "@types/jest": "^29.5.13",
+    "@types/node": "^22.7.2",
     "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",
-    "typescript": "^5.5.2"
+    "rollup": "^4.22.4",
+    "ts-jest": "^29.2.5",
+    "typedoc": "^0.26.7",
+    "typescript": "^5.6.2"
   }
 }