@hebcal/leyning 8.2.9 → 9.0.0

package/dist/esm/summary.js

@@ -0,0 +1,83 @@
+/*! @hebcal/leyning v9.0.0 */
+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.