@hebcal/leyning 4.20.0 → 5.1.0

package/leyning.d.ts

@@ -28,8 +28,11 @@ declare module '@hebcal/leyning' {
      * 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;
         };
         /** An array of either 1 (regular) or 2 (doubled parsha). `undefined` for holiday readings */
@@ -78,24 +81,6 @@ declare module '@hebcal/leyning' {
      */
     export function getLeyningOnDate(hdate: HDate, il: boolean): Leyning;
 
-    /**
-     * Represents triennial aliyot for a given date
-     */
-    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;
-    };
-
     /**
      * Makes a summary of the leyning, like "Genesis 6:9-11:32"
      */
@@ -153,6 +138,24 @@ declare module '@hebcal/leyning' {
      */
     export function formatAliyahShort(aliyah: Aliyah, showBook: boolean): string;
 
+    /**
+     * Represents triennial aliyot for a given date
+     */
+    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;
+    };
+
     /**
      * Triennial Torah readings
      */
@@ -182,26 +185,56 @@ declare module '@hebcal/leyning' {
     /**
      * Looks up triennial leyning for a regular Shabbat parsha.
      * @param ev - the Hebcal event associated with this parsha
-     * @param [context] returns a reading wrapper object which includes `date`, `yearNum` and `aliyot`
      * @returns a map of aliyot 1-7 plus "M"
      */
-    export function getTriennialForParshaHaShavua(ev: Event, context?: boolean): AliyotMap|TriennialAliyot;
+    export function getTriennialForParshaHaShavua(ev: Event): TriennialAliyot;
 
     export function getTriennialHaftaraForHoliday(holiday: string, yearNum: number): any;
 
-    export const parshiyot: any;
-    export const holidayReadings: any;
+    /**
+     * Names of the books of the Torah. BOOK[1] === 'Genesis'
+     */
     export const BOOK: string[];
 
     export function writeTriennialCsv(stream: WriteStream, hyear: number): void;
     export function writeFullKriyahCsv(stream: WriteStream, hyear: number, il: boolean): void;
 
     /**
-     * Makes Sefaria links by adding `href`, `verses` and `num` attributes to each aliyah.
-     * CAUTION: Modifies the `aliyot` parameter instead of making a copy.
-     * @deprecated
-     * @param aliyot - aliyah map to decorate
-     * @param showBook - display the book name in the `verses` field (e.g. for special Maftir)
+     * Parsha metadata (underlying JSON object)
+     */
+    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[];
+        };
+    };
+
+    /**
+     * Returns raw parsha metadata
+     */
+    export function lookupParsha(parsha: string | string[]): ParshaMeta;
+
+    /**
+     * Is there a special festival Torah Reading for `holiday`?
+     */
+    export function hasFestival(holiday: string): boolean;
+  
+    /**
+     * Returns the raw metadata for festival reading for `holiday`
      */
-    export function addSefariaLinksToLeyning(aliyot: AliyotMap, showBook: boolean): void;
+    export function lookupFestival(holiday: string): any;  
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/leyning",
-  "version": "4.20.0",
+  "version": "5.1.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",