@hebcal/leyning 8.2.9 → 9.0.1

package/dist/esm/specialReadings.js

@@ -0,0 +1,142 @@
+/*! @hebcal/leyning v9.0.1 */
+import { months } from '@hebcal/hdate';
+import { flags } from '@hebcal/core/dist/esm/event';
+import { cloneHaftara, clone } from './clone.js';
+import { parshaToString, calculateNumVerses } from './common.js';
+import { lookupFestival } from './festival.js';
+import { getLeyningKeyForEvent } from './getLeyningKeyForEvent.js';
+import { getHolidaysOnDate } from '@hebcal/core/dist/esm/holidays';
+
+function aliyotCombine67(aliyot) {
+    const a6 = clone(aliyot['6']);
+    const a7 = aliyot['7'];
+    if (a6.k !== a7.k) {
+        throw new Error('Impossible to combine aliyot 6 & 7: ' + JSON.stringify(aliyot));
+    }
+    delete aliyot['7'];
+    aliyot['6'] = {
+        k: a6.k,
+        b: a6.b,
+        e: a7.e,
+    };
+    if (a6.v && a7.v) {
+        aliyot['6'].v = a6.v + a7.v;
+    }
+}
+function mergeAliyotWithSpecial(aliyot, special) {
+    if (special['7']) {
+        aliyotCombine67(aliyot);
+        aliyot['7'] = clone(special['7']);
+        calculateNumVerses(aliyot['7']);
+    }
+    if (special['M']) {
+        aliyot['M'] = clone(special['M']);
+        calculateNumVerses(aliyot['M']);
+    }
+}
+/**
+ * Determines if the regular parashat haShavua coincides with an event that requires
+ * a special maftir or Haftara (for example Shabbat HaGadol, Shabbat Chanukah, Rosh
+ * Chodesh or Machar Chodesh, etc.).
+ *
+ * This function does not modify `aliyot`. Instead, it returns a deep copy
+ * with `aliyot['M']` replaced and sets `reason.M`
+ * (and in some cases the 6th and 7th aliyah, setting `reason['7']`).
+ *
+ * If a special Haftarah applies, the result will have a `haft` property
+ * pointing to Haftarah object and sets `reason.haftara`.
+ */
+function specialReadings2(parsha, hd, il, aliyot) {
+    let haft;
+    let seph;
+    let specialHaft = false;
+    const reason = {};
+    function handleSpecial(key) {
+        const special = lookupFestival(key);
+        if (!special) {
+            return;
+        }
+        if (typeof special.il === 'boolean' && il !== special.il) {
+            return;
+        }
+        if (special.haft && !specialHaft) {
+            haft = cloneHaftara(special.haft);
+            reason.haftara = key;
+            specialHaft = true;
+            if (special.seph) {
+                seph = cloneHaftara(special.seph);
+                reason.sephardic = key;
+            }
+        }
+        if (special.fullkriyah) {
+            const aliyotMap = clone(aliyot);
+            mergeAliyotWithSpecial(aliyotMap, special.fullkriyah);
+            for (const num of Object.keys(special.fullkriyah)) {
+                reason[num] = key;
+            }
+            aliyot = aliyotMap;
+        }
+    }
+    const parshaName = parshaToString(parsha);
+    const events0 = getHolidaysOnDate(hd, il) || [];
+    const events = events0.filter(ev => !(ev.getFlags() & flags.ROSH_CHODESH));
+    for (const ev of events) {
+        if (ev.getDesc() === 'Shabbat Shuva') {
+            handleSpecial(`Shabbat Shuva (with ${parshaName})`);
+        }
+        else {
+            const key = getLeyningKeyForEvent(ev, il);
+            if (key) {
+                handleSpecial(key);
+            }
+        }
+    }
+    if (!haft) {
+        const day = hd.getDate();
+        if (parshaName === 'Pinchas' && day > 17) {
+            // Pinchas is always read in Tamuz (never another month)
+            // either on the 14, 16, 17 (in Israel), 19, 21, 23, 24
+            handleSpecial('Pinchas occurring after 17 Tammuz');
+        }
+        else if (day === 30 || day === 1) {
+            const key = parshaName === 'Masei' || parshaName === 'Matot-Masei'
+                ? `${parshaName} on Shabbat Rosh Chodesh`
+                : 'Shabbat Rosh Chodesh';
+            handleSpecial(key);
+        }
+        else if (parshaName === 'Ki Teitzei' && day === 14) {
+            // Ki Teitzei is always read in Elul on 9, 11, 13 or 14
+            // "Because Shabbat Re’eh was Rosh Ḥodesh, the usual 3rd haftarah of
+            // consolation was not read. Chant the haftarah of Ki tetse and then
+            // the haftarah of Re’eh as a single haftarah.
+            // In the book of Isaiah these two brief passages are adjacent."
+            // Source: Luaḥ Hashanah, Rabbi Miles B. Cohen and Leslie Rubin
+            handleSpecial('Ki Teitzei with 3rd Haftarah of Consolation');
+        }
+        else if (parshaName === 'Kedoshim' &&
+            (day === 26 || day === 28 || day === 6)) {
+            // Kedoshim is read separately from Achrei Mot in ~37% of years.
+            // When this happens, it is will be read on
+            // 26th or 28th of Nisan (Achrei Mot was Shabbat HaGadol, ~10%),
+            // or 1st of Iyyar (Rosh Chodesh, ~10%),
+            // or 6th of Iyyar (~10%, immediately after Shabbat Machar Chodesh)
+            // or 3rd of Iyyar (~6%, "the nominal situation — in which both parashiyyot
+            // are read separately and no overriding occasions coincide")
+            // http://www.scholar.davidesstein.name/Articles/HaftarotOfEtzHayim--Stein.pdf
+            // "The Haftarot of Etz Hayim," David E. S. Stein, Conservative Judaism 54/3 (Spring 2002)
+            handleSpecial('Kedoshim following Special Shabbat');
+        }
+        else if (hd.getMonth() !== months.AV) {
+            // Parashat Re'eh is always read in Av on 25, 27, 29 or 30.
+            // When it coincides with Erev Rosh Chodesh, the Haftarah is
+            // עניה סוערה (Isaiah 54:11-55:5) and not מחר חדש
+            const tommorow = hd.next().getDate();
+            if (tommorow === 30 || tommorow === 1) {
+                handleSpecial('Shabbat Machar Chodesh');
+            }
+        }
+    }
+    return { aliyot, reason, haft, seph };
+}
+
+export { specialReadings2 };

package/dist/esm/summary.d.ts

@@ -0,0 +1,18 @@
+import { Aliyah, AliyotMap } from './types';
+/**
+ * Summarizes an `AliyotMap` by collapsing all adjacent aliyot.
+ * Finds any non-overlapping parts (e.g. special 7th aliyah or maftir)
+ */
+export declare function makeLeyningParts(aliyot: AliyotMap): Aliyah[];
+/**
+ * Returns a string representation of the leyning parts.
+ * Separate verse ranges read from the same book are separated
+ * by commas, e.g. `Isaiah 6:1-7:6, 9:5-6`.
+ * Verse ranges from different books are separated by semicolons,
+ * e.g. `Genesis 21:1-34; Numbers 29:1-6`.
+ */
+export declare function makeSummaryFromParts(parts: Aliyah | Aliyah[]): string;
+/**
+ * Makes a summary of the leyning, like "Genesis 6:9-11:32"
+ */
+export declare function makeLeyningSummary(aliyot: AliyotMap): string;

package/dist/esm/summary.js

@@ -0,0 +1,83 @@
+/*! @hebcal/leyning v9.0.1 */
+import { formatAliyahShort } from './common.js';
+
+/**
+ * @private
+ */
+function isChapVerseBefore(a, b) {
+    const cv1 = a.split(':').map(x => +x);
+    const cv2 = b.split(':').map(x => +x);
+    return cv1[0] * 100 + cv1[1] < cv2[0] * 100 + cv2[1];
+}
+/**
+ * Summarizes an `AliyotMap` by collapsing all adjacent aliyot.
+ * Finds any non-overlapping parts (e.g. special 7th aliyah or maftir)
+ */
+function makeLeyningParts(aliyot) {
+    const nums = Object.keys(aliyot).filter(x => {
+        if (x.length === 1) {
+            return true;
+        }
+        const code = x.charCodeAt(0);
+        return code >= 48 && code <= 57;
+    });
+    let start = aliyot[nums[0]];
+    let end = start;
+    const parts = [];
+    for (let i = 0; i < nums.length; i++) {
+        const num = nums[i];
+        const aliyah = aliyot[num];
+        if (i === nums.length - 1 && aliyah.k === end.k && aliyah.e === end.e) {
+            // short-circuit when final aliyah is within the previous (e.g. M inside of 7)
+            continue;
+        }
+        const prevEndChap = +end.e.split(':')[0];
+        const curStartChap = +aliyah.b.split(':')[0];
+        const sameOrNextChap = curStartChap === prevEndChap || curStartChap === prevEndChap + 1;
+        if (i !== 0 &&
+            (aliyah.k !== start.k ||
+                isChapVerseBefore(aliyah.b, start.e) ||
+                !sameOrNextChap)) {
+            parts.push({ k: start.k, b: start.b, e: end.e });
+            start = aliyah;
+        }
+        end = aliyah;
+    }
+    parts.push({ k: start.k, b: start.b, e: end.e });
+    return parts;
+}
+/**
+ * Returns a string representation of the leyning parts.
+ * Separate verse ranges read from the same book are separated
+ * by commas, e.g. `Isaiah 6:1-7:6, 9:5-6`.
+ * Verse ranges from different books are separated by semicolons,
+ * e.g. `Genesis 21:1-34; Numbers 29:1-6`.
+ */
+function makeSummaryFromParts(parts) {
+    if (!Array.isArray(parts)) {
+        parts = [parts];
+    }
+    let prev = parts[0];
+    let summary = formatAliyahShort(prev, true);
+    for (let i = 1; i < parts.length; i++) {
+        const part = parts[i];
+        if (part.k === prev.k) {
+            summary += ', ';
+        }
+        else {
+            summary += `; ${part.k} `;
+        }
+        summary += formatAliyahShort(part, false);
+        prev = part;
+    }
+    return summary;
+}
+/**
+ * Makes a summary of the leyning, like "Genesis 6:9-11:32"
+ */
+function makeLeyningSummary(aliyot) {
+    const parts = makeLeyningParts(aliyot);
+    return makeSummaryFromParts(parts);
+}
+
+export { makeLeyningParts, makeLeyningSummary, makeSummaryFromParts };

package/dist/esm/types.d.ts

@@ -0,0 +1,130 @@
+/**
+ * Represents an aliyah
+ */
+export type Aliyah = {
+    /** Book (e.g. "Numbers") */
+    k: string;
+    /** beginning verse (e.g. "28:9") */
+    b: string;
+    /** ending verse (e.g. "28:15") */
+    e: string;
+    /** number of verses */
+    v?: number;
+    /** parsha number (1=Bereshit, 54=Vezot HaBracha) */
+    p?: number;
+    reason?: string;
+};
+export type StringMap = {
+    [key: string]: string;
+};
+export type AliyotMap = {
+    [key: string]: Aliyah;
+};
+/** Name of the parsha hashavua or holiday */
+export type LeyningNames = {
+    /** English */
+    en: string;
+    /** Hebrew (with nikud) */
+    he: string;
+};
+/**
+ * Parsha metadata (underlying JSON object)
+ */
+export type ParshaMeta = {
+    /** 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings */
+    num: number | number[];
+    /** parsha name in Hebrew with niqud */
+    hebrew: string;
+    /** 1 for Genesis, 2 for Exodus, 5 for Deuteronomy */
+    book: number;
+    /** Haftarah object(s) */
+    haft: Aliyah | Aliyah[];
+    /** Haftarah object(s) for Sephardim */
+    seph?: Aliyah | Aliyah[];
+    /** Map of Shabbat aliyot `1` through `7` plus `M` for maftir */
+    fullkriyah: {
+        [key: string]: string[];
+    };
+    /**
+     * Map of weekday Torah Readings
+     *  aliyot `1` through `3` for Monday and Thursday
+     */
+    weekday?: {
+        [key: string]: string[];
+    };
+    combined?: boolean;
+    p1?: string;
+    p2?: string;
+    num1?: number;
+    num2?: number;
+};
+export type SpecialReading = {
+    /** Map of aliyot `1` through `7` plus `M` for maftir */
+    aliyot: AliyotMap;
+    /**
+     * Explanations for special readings,
+     *  keyed by aliyah number, `M` for maftir or `haftara` for Haftarah
+     */
+    reason: StringMap;
+    /** Haftarah object(s) */
+    haft?: Aliyah | Aliyah[];
+    /** Haftarah object(s) for Sephardim */
+    seph?: Aliyah | Aliyah[];
+};
+/**
+ * Leyning base - weekday, parsha hashavua or holiday
+ */
+export type LeyningBase = {
+    /** Name of the parsha hashavua or holiday */
+    name: LeyningNames;
+    /** Such as `Genesis 1:1 - 6:8` */
+    summary: string;
+    summaryParts?: Aliyah[];
+    note?: string;
+};
+/**
+ * Parashat haShavua - weekday or Shabbat
+ */
+export type LeyningParshaHaShavua = LeyningBase & {
+    /** 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 */
+    parshaNum?: number | number[];
+};
+/**
+ * Parashat haShavua - weekday
+ */
+export type LeyningWeekday = LeyningParshaHaShavua & {
+    /** Optional map of weekday Torah Readings aliyot `1` through `3` for Monday and Thursday */
+    weekday?: 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` */
+    sephardic?: string;
+    /** Number of verses in the Haftarah for Sephardim */
+    sephardicNumV?: number;
+    /** Explanations for special readings, keyed by aliyah number, `M` for maftir or `haftara` for Haftarah */
+    reason?: StringMap;
+    /** Song of Songs is read on the sabbath of Passover week, the Book of Ruth on Shavuot, Lamentations on Tisha be-Av, Ecclesiastes on the sabbath of the week of Sukkoth, and the Book of Esther on Purim */
+    megillah?: AliyotMap;
+    /** Triennial alternate Haftara */
+    triHaftara?: string;
+    /** Triennial alternate Haftara number of verses */
+    triHaftaraNumV?: number;
+};
+export type Leyning = LeyningBase & LeyningParshaHaShavua & LeyningShabbatHoliday & LeyningWeekday;

package/dist/getLeyningForHoliday.d.ts

@@ -1,4 +1,4 @@
-import { Event } from '@hebcal/core';
+import { Event } from '@hebcal/core/dist/esm/event';
 import { Leyning } from './types';
 /**
  * Looks up leyning for a given holiday key. Key should be an

package/dist/getLeyningKeyForEvent.d.ts

@@ -1,4 +1,4 @@
-import { Event } from '@hebcal/core';
+import { Event } from '@hebcal/core/dist/esm/event';
 export declare const HOLIDAY_IGNORE_MASK: number;
 /**
  * Based on the event date, type and title, finds the relevant leyning key

package/dist/getLeyningOnDate.d.ts

@@ -1,4 +1,4 @@
-import { HDate } from '@hebcal/core';
+import { HDate } from '@hebcal/hdate';
 import { Leyning, LeyningWeekday } from './types';
 /**
  * Looks up leyning for a regular Shabbat, Monday/Thursday weekday or holiday.

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export * from './types';
-import './locale';
+export * from './locale';
 export * from './common';
 export * from './summary';
 export * from './festival';
@@ -8,5 +8,4 @@ export * from './specialReadings';
 export * from './getLeyningForHoliday';
 export * from './leyning';
 export { getLeyningOnDate } from './getLeyningOnDate';
-export { writeFullKriyahCsv, writeCsvLines, writeHolidayMincha, StringToBoolMap, getParshaDates, } from './csv';
 export * from './clone';

package/dist/leyning.d.ts

@@ -1,4 +1,4 @@
-import { Event } from '@hebcal/core';
+import { Event } from '@hebcal/core/dist/esm/event';
 import { AliyotMap, Leyning, LeyningNames, ParshaMeta } from './types';
 /**
  * Transliterated English and Hebrew names of this parsha

package/dist/locale.d.ts

@@ -1 +1,2 @@
-export {};
+import { Locale } from '@hebcal/core/dist/esm/locale';
+export { Locale };

package/dist/specialReadings.d.ts

@@ -1,4 +1,4 @@
-import { HDate } from '@hebcal/core';
+import { HDate } from '@hebcal/hdate';
 import { AliyotMap, SpecialReading } from './types';
 /**
  * Determines if the regular parashat haShavua coincides with an event that requires

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/leyning",
-  "version": "8.2.9",
+  "version": "9.0.1",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal",
@@ -16,13 +16,15 @@
     "parashah"
   ],
   "description": "Torah Reading API for Parashat HaShavua and holidays",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
+  "module": "./dist/esm/index.js",
+  "typings": "dist/esm/index.d.ts",
   "type": "module",
   "exports": {
-    "import": "./dist/index.mjs",
-    "require": "./dist/index.cjs",
-    "types": "./dist/module.d.ts"
+    ".": {
+      "import": "./dist/esm/index.js",
+      "types": "./dist/esm/index.d.ts"
+    },
+    "./dist/esm/*": "./dist/esm/*.js"
   },
   "repository": {
     "type": "git",
@@ -31,23 +33,23 @@
   "bugs": {
     "url": "https://github.com/hebcal/hebcal-leyning/issues"
   },
-  "typings": "dist/module.d.ts",
   "files": [
-    "dist",
-    "bin"
+    "dist"
   ],
-  "bin": {
-    "leyning-csv": "bin/leyning-csv"
-  },
+	"engines": {
+		"node": ">=18"
+	},
   "dependencies": {
-    "@hebcal/core": "^5.6.1",
+    "@hebcal/core": "^5.7.7",
+    "@hebcal/hdate": "^0.12.0",
     "tslib": "^2.8.1"
   },
   "scripts": {
-    "po2json": "node ./po2json.cjs po/*.po",
+    "po2json": "node ./po2json.cjs po/he.po",
+    "size-demo:rollup": "rollup -c size-demo/rollup.config.ts --configPlugin typescript",
+    "size-demo": "npm run build && npm run size-demo:rollup",
     "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 po2json && npm run build:json2js && npm run build:rollup",
+    "build": "npm run po2json && npm run build:rollup",
     "prepublish": "npm run build",
     "docs": "typedoc",
     "pretest": "npm run build",
@@ -72,11 +74,13 @@
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^12.1.1",
     "@types/jest": "^29.5.14",
-    "@types/node": "^22.8.7",
+    "@types/node": "^22.9.0",
     "gts": "^5.3.1",
     "jest": "^29.7.0",
-    "rollup": "^4.24.3",
-    "rollup-plugin-dts": "^6.1.1",
+    "pretty-bytes": "^6.1.1",
+    "rollup": "^4.24.4",
+    "rollup-plugin-bundle-size": "^1.0.3",
+    "rollup-plugin-visualizer": "^5.12.0",
     "ts-jest": "^29.2.5",
     "ttag-cli": "^1.10.12",
     "typedoc": "^0.26.11",

package/bin/leyning-csv

@@ -1,23 +0,0 @@
-#!/usr/bin/env node
-
-import fs from 'fs';
-import {HDate} from '@hebcal/core';
-import {writeFullKriyahCsv} from '../dist/index.mjs';
-
-const today = new HDate();
-const hyear = today.getFullYear();
-const numYears = 13;
-
-for (let i = hyear - 1; i < hyear + numYears; i++) {
-  let filename = `fullkriyah-${i}.csv`;
-  console.log(`Creating ${filename}`);
-  let stream = fs.createWriteStream(filename, {flags: 'w'});
-  writeFullKriyahCsv(stream, i, false);
-  stream.end();
-
-  filename = `fullkriyah-il-${i}.csv`;
-  console.log(`Creating ${filename}`);
-  stream = fs.createWriteStream(filename, {flags: 'w'});
-  writeFullKriyahCsv(stream, i, true);
-  stream.end();
-}