@hebcal/leyning 5.0.0 → 6.0.0

package/leyning.d.ts

@@ -20,6 +20,10 @@ declare module '@hebcal/leyning' {
         p?: number;
     };
 
+    export type StringMap = {
+        [key: string]: string;
+    }
+
     export type AliyotMap = {
         [key: string]: Aliyah;
     }
@@ -58,11 +62,52 @@ declare module '@hebcal/leyning' {
         /** Optional map of weekday Torah Readings aliyot `1` through `3` for Monday and Thursday */
         weekday?: AliyotMap;
         /** Explanations for special readings, keyed by aliyah number, `M` for maftir or `haftara` for Haftarah */
-        reason?: {
-            [key: string]: string;
-        };
+        reason?: StringMap;
     };
 
+    /**
+     * Formats parsha as a string
+     */
+    export function parshaToString(parsha: string[]): string;
+    /**
+     * Makes a deep copy of the src object using JSON stringify and parse
+     */
+    export function clone(src: any): any;
+    /**
+     * Calculates the number of verses in an aliyah or haftara based on
+     * the `b` (begin verse), `e` (end verse) and `k` (book).
+     * Modifies `aliyah` by setting the `v` field.
+     */
+    export function calculateNumVerses(aliyah: Aliyah): number;
+    /**
+     * Returns the total number of verses in an array of Aliyah (or haftarah) objects
+     */
+    export function sumVerses(aliyot: Aliyah | Aliyah[]): number;
+    /**
+     * Summarizes an `AliyotMap` by collapsing all adjacent aliyot.
+     * Finds any non-overlapping parts (e.g. special 7th aliyah or maftir)
+     */
+    export 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 function makeSummaryFromParts(parts: Aliyah | Aliyah[]): string;
+    /**
+     * 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.).
+     *
+     * If a special maftir occurs, modifies `aliyot` to replace `M` and sets `reason.M`
+     * (and in some cases modifies the 6th and 7th aliyah, setting `reason['7']`).
+     *
+     * If a special Haftarah applies, returns the Haftarah object and sets `reason.haftara`.
+     * If no special Haftarah, returns `undefined`
+     */
+    export function specialReadings(hd: HDate, il: boolean, aliyot: AliyotMap, reason: StringMap): Aliyah | Aliyah[];
     /**
      * Looks up leyning for a regular Shabbat, Monday/Thursday weekday or holiday.
      *
@@ -139,63 +184,52 @@ declare module '@hebcal/leyning' {
     export function formatAliyahShort(aliyah: Aliyah, showBook: boolean): string;
 
     /**
-     * Represents triennial aliyot for a given date
+     * Names of the books of the Torah. BOOK[1] === 'Genesis'
      */
-    export type TriennialAliyot = {
-        /** Map of aliyot `1` through `7` plus `M` for maftir */
-        aliyot: AliyotMap;
-        /** year number, 0-2 */
-        yearNum: number;
-        /** Shabbat date for when this parsha is read in this 3-year cycle */
-        date: Date;
-        /** true if a double parsha is read separately in year `yearNum` */
-        readSeparately?: boolean;
-        /** Shabbat date of the first part of a read-separately aliyah pair */
-        date1?: Date;
-        /** Shabbat date of the second part of a read-separately aliyah pair */
-        date2?: Date;
-    };
+    export const BOOK: string[];
 
+    export function writeFullKriyahCsv(stream: WriteStream, hyear: number, il: boolean): void;
     /**
-     * Triennial Torah readings
-     */
-    export class Triennial {
-        constructor(hebrewYear: number);
-        getReading(parsha: string, yearNum: number): TriennialAliyot;
-        getStartYear(): number;
-        debug(): string;
-        /**
-         * Returns triennial year 1, 2 or 3 based on this Hebrew year
-         * @param year Hebrew year
-         */
-        static getYearNumber(year: number): number;
-        /**
-         * Returns Hebrew year that this 3-year triennial cycle began
-         * @param year Hebrew year
-         */
-        static getCycleStartYear(year: number): number;
-    }
+     * Formats reading for CSV
+     */
+    export function writeCsvLines(stream: WriteStream, ev: Event, reading: Leyning, il: boolean, isParsha: boolean): void;
 
     /**
-     * Calculates the 3-year readings for a given year
-     * @param year - Hebrew year
+     * Parsha metadata (underlying JSON object)
      */
-    export function getTriennial(year: number): Triennial;
+    export type ParshaMeta = {
+        /** 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings */
+        num: 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[];
+        /** Raw map of Shabbat aliyot `1` through `7` plus `M` for maftir */
+        fullkriyah: {
+            [key: string]: string[];
+        };
+        /** weekday - raw map of weekday Torah Readings aliyot `1` through `3` for Mon & Thu */
+        weekday: {
+            [key: string]: string[];
+        };
+    };
 
     /**
-     * Looks up triennial leyning for a regular Shabbat parsha.
-     * @param ev - the Hebcal event associated with this parsha
-     * @returns a map of aliyot 1-7 plus "M"
+     * Returns raw parsha metadata
      */
-    export function getTriennialForParshaHaShavua(ev: Event): TriennialAliyot;
-
-    export function getTriennialHaftaraForHoliday(holiday: string, yearNum: number): any;
+    export function lookupParsha(parsha: string | string[]): ParshaMeta;
 
     /**
-     * Names of the books of the Torah. BOOK[1] === 'Genesis'
+     * Is there a special festival Torah Reading for `holiday`?
      */
-    export const BOOK: string[];
-
-    export function writeTriennialCsv(stream: WriteStream, hyear: number): void;
-    export function writeFullKriyahCsv(stream: WriteStream, hyear: number, il: boolean): void;
+    export function hasFestival(holiday: string): boolean;
+  
+    /**
+     * Returns the raw metadata for festival reading for `holiday`
+     */
+    export function lookupFestival(holiday: string): any;  
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/leyning",
-  "version": "5.0.0",
+  "version": "6.0.0",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal",
@@ -52,7 +52,7 @@
     "verbose": true
   },
   "devDependencies": {
-    "@babel/core": "^7.18.10",
+    "@babel/core": "^7.18.13",
     "@babel/preset-env": "^7.18.10",
     "@babel/register": "^7.18.9",
     "@rollup/plugin-babel": "^5.3.1",